@faable/auth-sdk 2.6.14 → 2.6.15

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.
Files changed (7) hide show
  1. package/dist/FaableAuthApi.d.ts +25 -0
  2. package/dist/api/generated-client.d.ts +108 -0
  3. package/dist/api/generated-client.js +8 -0
  4. package/dist/api/types.d.ts +211 -0
  5. package/dist/version.js +2 -2
  6. package/package.json +1 -1
  7. package/spec/openapi.json +2226 -288
package/dist/FaableAuthApi.d.ts CHANGED
@@ -74,6 +74,11 @@ export declare class FaableAuthApi extends GeneratedFaableAuthApi {
74
74
  allowed_factors?: ("webauthn" | "totp")[] | undefined;
75
75
  remember_device_days?: number | undefined;
76
76
  } | undefined;
77
+ recovery_channels?: {
78
+ enabled?: ("email" | "sms" | "whatsapp" | "factor")[] | undefined;
79
+ default?: "email" | "sms" | "whatsapp" | "factor" | undefined;
80
+ visible?: ("email" | "sms" | "whatsapp" | "factor")[] | undefined;
81
+ } | undefined;
77
82
  webauthn_rp_id?: string | null | undefined;
78
83
  createdAt: string;
79
84
  updatedAt?: string | undefined;
@@ -776,6 +781,11 @@ export declare class FaableAuthApi extends GeneratedFaableAuthApi {
776
781
  allowed_factors?: ("webauthn" | "totp")[] | undefined;
777
782
  remember_device_days?: number | undefined;
778
783
  } | undefined;
784
+ recovery_channels?: {
785
+ enabled?: ("email" | "sms" | "whatsapp" | "factor")[] | undefined;
786
+ default?: "email" | "sms" | "whatsapp" | "factor" | undefined;
787
+ visible?: ("email" | "sms" | "whatsapp" | "factor")[] | undefined;
788
+ } | undefined;
779
789
  login_flow?: string | null | undefined;
780
790
  account: string;
781
791
  metadata: {
@@ -831,6 +841,11 @@ export declare class FaableAuthApi extends GeneratedFaableAuthApi {
831
841
  allowed_factors?: ("webauthn" | "totp")[] | undefined;
832
842
  remember_device_days?: number | undefined;
833
843
  } | undefined;
844
+ recovery_channels?: {
845
+ enabled?: ("email" | "sms" | "whatsapp" | "factor")[] | undefined;
846
+ default?: "email" | "sms" | "whatsapp" | "factor" | undefined;
847
+ visible?: ("email" | "sms" | "whatsapp" | "factor")[] | undefined;
848
+ } | undefined;
834
849
  login_flow?: string | null | undefined;
835
850
  account: string;
836
851
  metadata: {
@@ -889,6 +904,11 @@ export declare class FaableAuthApi extends GeneratedFaableAuthApi {
889
904
  allowed_factors?: ("webauthn" | "totp")[] | undefined;
890
905
  remember_device_days?: number | undefined;
891
906
  } | undefined;
907
+ recovery_channels?: {
908
+ enabled?: ("email" | "sms" | "whatsapp" | "factor")[] | undefined;
909
+ default?: "email" | "sms" | "whatsapp" | "factor" | undefined;
910
+ visible?: ("email" | "sms" | "whatsapp" | "factor")[] | undefined;
911
+ } | undefined;
892
912
  login_flow?: string | null | undefined;
893
913
  account: string;
894
914
  metadata: {
@@ -946,6 +966,11 @@ export declare class FaableAuthApi extends GeneratedFaableAuthApi {
946
966
  allowed_factors?: ("webauthn" | "totp")[] | undefined;
947
967
  remember_device_days?: number | undefined;
948
968
  } | undefined;
969
+ recovery_channels?: {
970
+ enabled?: ("email" | "sms" | "whatsapp" | "factor")[] | undefined;
971
+ default?: "email" | "sms" | "whatsapp" | "factor" | undefined;
972
+ visible?: ("email" | "sms" | "whatsapp" | "factor")[] | undefined;
973
+ } | undefined;
949
974
  login_flow?: string | null | undefined;
950
975
  account: string;
951
976
  metadata: {
package/dist/api/generated-client.d.ts CHANGED
@@ -70,6 +70,11 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
70
70
  allowed_factors?: ("webauthn" | "totp")[] | undefined;
71
71
  remember_device_days?: number | undefined;
72
72
  } | undefined;
73
+ recovery_channels?: {
74
+ enabled?: ("email" | "sms" | "whatsapp" | "factor")[] | undefined;
75
+ default?: "email" | "sms" | "whatsapp" | "factor" | undefined;
76
+ visible?: ("email" | "sms" | "whatsapp" | "factor")[] | undefined;
77
+ } | undefined;
73
78
  webauthn_rp_id?: string | null | undefined;
74
79
  createdAt: string;
75
80
  updatedAt?: string | undefined;
@@ -126,6 +131,11 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
126
131
  allowed_factors?: ("webauthn" | "totp")[] | undefined;
127
132
  remember_device_days?: number | undefined;
128
133
  } | undefined;
134
+ recovery_channels?: {
135
+ enabled?: ("email" | "sms" | "whatsapp" | "factor")[] | undefined;
136
+ default?: "email" | "sms" | "whatsapp" | "factor" | undefined;
137
+ visible?: ("email" | "sms" | "whatsapp" | "factor")[] | undefined;
138
+ } | undefined;
129
139
  webauthn_rp_id?: string | null | undefined;
130
140
  createdAt: string;
131
141
  updatedAt?: string | undefined;
@@ -188,6 +198,11 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
188
198
  allowed_factors?: ("webauthn" | "totp")[] | undefined;
189
199
  remember_device_days?: number | undefined;
190
200
  } | undefined;
201
+ recovery_channels?: {
202
+ enabled?: ("email" | "sms" | "whatsapp" | "factor")[] | undefined;
203
+ default?: "email" | "sms" | "whatsapp" | "factor" | undefined;
204
+ visible?: ("email" | "sms" | "whatsapp" | "factor")[] | undefined;
205
+ } | undefined;
191
206
  webauthn_rp_id?: string | null | undefined;
192
207
  createdAt: string;
193
208
  updatedAt?: string | undefined;
@@ -255,6 +270,11 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
255
270
  allowed_factors?: ("webauthn" | "totp")[] | undefined;
256
271
  remember_device_days?: number | undefined;
257
272
  } | undefined;
273
+ recovery_channels?: {
274
+ enabled?: ("email" | "sms" | "whatsapp" | "factor")[] | undefined;
275
+ default?: "email" | "sms" | "whatsapp" | "factor" | undefined;
276
+ visible?: ("email" | "sms" | "whatsapp" | "factor")[] | undefined;
277
+ } | undefined;
258
278
  webauthn_rp_id?: string | null | undefined;
259
279
  createdAt: string;
260
280
  updatedAt?: string | undefined;
@@ -306,6 +326,11 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
306
326
  allowed_factors?: ("webauthn" | "totp")[] | undefined;
307
327
  remember_device_days?: number | undefined;
308
328
  } | undefined;
329
+ recovery_channels?: {
330
+ enabled?: ("email" | "sms" | "whatsapp" | "factor")[] | undefined;
331
+ default?: "email" | "sms" | "whatsapp" | "factor" | undefined;
332
+ visible?: ("email" | "sms" | "whatsapp" | "factor")[] | undefined;
333
+ } | undefined;
309
334
  webauthn_rp_id?: string | null | undefined;
310
335
  createdAt: string;
311
336
  updatedAt?: string | undefined;
@@ -360,11 +385,49 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
360
385
  allowed_factors?: ("webauthn" | "totp")[] | undefined;
361
386
  remember_device_days?: number | undefined;
362
387
  } | undefined;
388
+ recovery_channels?: {
389
+ enabled?: ("email" | "sms" | "whatsapp" | "factor")[] | undefined;
390
+ default?: "email" | "sms" | "whatsapp" | "factor" | undefined;
391
+ visible?: ("email" | "sms" | "whatsapp" | "factor")[] | undefined;
392
+ } | undefined;
363
393
  webauthn_rp_id?: string | null | undefined;
364
394
  createdAt: string;
365
395
  updatedAt?: string | undefined;
366
396
  }>>;
367
397
  };
398
+ /**
399
+ * `GET /recovery-channels/capabilities` — operationId: `account/recoveryChannelsCapabilities`
400
+ *
401
+ * Recovery channel capabilities for this tenant
402
+ */
403
+ accountRecoveryChannelsCapabilities(): Promise<{
404
+ provider: {
405
+ sms: boolean;
406
+ whatsapp: boolean;
407
+ };
408
+ plan: {
409
+ known: boolean;
410
+ tier?: string | undefined;
411
+ allows_messaging: boolean;
412
+ };
413
+ usage: {
414
+ month: string;
415
+ sent: number;
416
+ included: number;
417
+ metered: boolean;
418
+ hard_ceiling: number;
419
+ };
420
+ resolved: {
421
+ enabled: ("email" | "sms" | "whatsapp" | "factor")[];
422
+ default: "email" | "sms" | "whatsapp" | "factor";
423
+ visible: ("email" | "sms" | "whatsapp" | "factor")[];
424
+ };
425
+ channels: {
426
+ channel: "email" | "sms" | "whatsapp" | "factor";
427
+ available: boolean;
428
+ reason?: string | undefined;
429
+ }[];
430
+ }>;
368
431
  /**
369
432
  * `POST /account/keys/rotate` — operationId: `account/rotateKeys`
370
433
  *
@@ -463,6 +526,11 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
463
526
  allowed_factors?: ("webauthn" | "totp")[] | undefined;
464
527
  remember_device_days?: number | undefined;
465
528
  } | undefined;
529
+ recovery_channels?: {
530
+ enabled?: ("email" | "sms" | "whatsapp" | "factor")[] | undefined;
531
+ default?: "email" | "sms" | "whatsapp" | "factor" | undefined;
532
+ visible?: ("email" | "sms" | "whatsapp" | "factor")[] | undefined;
533
+ } | undefined;
466
534
  webauthn_rp_id?: string | null | undefined;
467
535
  createdAt: string;
468
536
  updatedAt?: string | undefined;
@@ -873,6 +941,11 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
873
941
  allowed_factors?: ("webauthn" | "totp")[] | undefined;
874
942
  remember_device_days?: number | undefined;
875
943
  } | undefined;
944
+ recovery_channels?: {
945
+ enabled?: ("email" | "sms" | "whatsapp" | "factor")[] | undefined;
946
+ default?: "email" | "sms" | "whatsapp" | "factor" | undefined;
947
+ visible?: ("email" | "sms" | "whatsapp" | "factor")[] | undefined;
948
+ } | undefined;
876
949
  login_flow?: string | null | undefined;
877
950
  account: string;
878
951
  metadata: {
@@ -933,6 +1006,11 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
933
1006
  allowed_factors?: ("webauthn" | "totp")[] | undefined;
934
1007
  remember_device_days?: number | undefined;
935
1008
  } | undefined;
1009
+ recovery_channels?: {
1010
+ enabled?: ("email" | "sms" | "whatsapp" | "factor")[] | undefined;
1011
+ default?: "email" | "sms" | "whatsapp" | "factor" | undefined;
1012
+ visible?: ("email" | "sms" | "whatsapp" | "factor")[] | undefined;
1013
+ } | undefined;
936
1014
  login_flow?: string | null | undefined;
937
1015
  account: string;
938
1016
  metadata: {
@@ -993,6 +1071,11 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
993
1071
  allowed_factors?: ("webauthn" | "totp")[] | undefined;
994
1072
  remember_device_days?: number | undefined;
995
1073
  } | undefined;
1074
+ recovery_channels?: {
1075
+ enabled?: ("email" | "sms" | "whatsapp" | "factor")[] | undefined;
1076
+ default?: "email" | "sms" | "whatsapp" | "factor" | undefined;
1077
+ visible?: ("email" | "sms" | "whatsapp" | "factor")[] | undefined;
1078
+ } | undefined;
996
1079
  login_flow?: string | null | undefined;
997
1080
  account: string;
998
1081
  metadata: {
@@ -1054,6 +1137,11 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
1054
1137
  allowed_factors?: ("webauthn" | "totp")[] | undefined;
1055
1138
  remember_device_days?: number | undefined;
1056
1139
  } | undefined;
1140
+ recovery_channels?: {
1141
+ enabled?: ("email" | "sms" | "whatsapp" | "factor")[] | undefined;
1142
+ default?: "email" | "sms" | "whatsapp" | "factor" | undefined;
1143
+ visible?: ("email" | "sms" | "whatsapp" | "factor")[] | undefined;
1144
+ } | undefined;
1057
1145
  login_flow?: string | null | undefined;
1058
1146
  account: string;
1059
1147
  metadata: {
@@ -1109,6 +1197,11 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
1109
1197
  allowed_factors?: ("webauthn" | "totp")[] | undefined;
1110
1198
  remember_device_days?: number | undefined;
1111
1199
  } | undefined;
1200
+ recovery_channels?: {
1201
+ enabled?: ("email" | "sms" | "whatsapp" | "factor")[] | undefined;
1202
+ default?: "email" | "sms" | "whatsapp" | "factor" | undefined;
1203
+ visible?: ("email" | "sms" | "whatsapp" | "factor")[] | undefined;
1204
+ } | undefined;
1112
1205
  login_flow?: string | null | undefined;
1113
1206
  account: string;
1114
1207
  metadata: {
@@ -1167,6 +1260,11 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
1167
1260
  allowed_factors?: ("webauthn" | "totp")[] | undefined;
1168
1261
  remember_device_days?: number | undefined;
1169
1262
  } | undefined;
1263
+ recovery_channels?: {
1264
+ enabled?: ("email" | "sms" | "whatsapp" | "factor")[] | undefined;
1265
+ default?: "email" | "sms" | "whatsapp" | "factor" | undefined;
1266
+ visible?: ("email" | "sms" | "whatsapp" | "factor")[] | undefined;
1267
+ } | undefined;
1170
1268
  login_flow?: string | null | undefined;
1171
1269
  account: string;
1172
1270
  metadata: {
@@ -1228,6 +1326,11 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
1228
1326
  allowed_factors?: ("webauthn" | "totp")[] | undefined;
1229
1327
  remember_device_days?: number | undefined;
1230
1328
  } | undefined;
1329
+ recovery_channels?: {
1330
+ enabled?: ("email" | "sms" | "whatsapp" | "factor")[] | undefined;
1331
+ default?: "email" | "sms" | "whatsapp" | "factor" | undefined;
1332
+ visible?: ("email" | "sms" | "whatsapp" | "factor")[] | undefined;
1333
+ } | undefined;
1231
1334
  login_flow?: string | null | undefined;
1232
1335
  account: string;
1233
1336
  metadata: {
@@ -1288,6 +1391,11 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
1288
1391
  allowed_factors?: ("webauthn" | "totp")[] | undefined;
1289
1392
  remember_device_days?: number | undefined;
1290
1393
  } | undefined;
1394
+ recovery_channels?: {
1395
+ enabled?: ("email" | "sms" | "whatsapp" | "factor")[] | undefined;
1396
+ default?: "email" | "sms" | "whatsapp" | "factor" | undefined;
1397
+ visible?: ("email" | "sms" | "whatsapp" | "factor")[] | undefined;
1398
+ } | undefined;
1291
1399
  login_flow?: string | null | undefined;
1292
1400
  account: string;
1293
1401
  metadata: {
package/dist/api/generated-client.js CHANGED
@@ -59,6 +59,14 @@ export class GeneratedFaableAuthApi extends FaableApi {
59
59
  accountList(params) {
60
60
  return this.paginator({ url: `/account`, params });
61
61
  }
62
+ /**
63
+ * `GET /recovery-channels/capabilities` — operationId: `account/recoveryChannelsCapabilities`
64
+ *
65
+ * Recovery channel capabilities for this tenant
66
+ */
67
+ accountRecoveryChannelsCapabilities() {
68
+ return this.fetcher.get(`/recovery-channels/capabilities`);
69
+ }
62
70
  /**
63
71
  * `POST /account/keys/rotate` — operationId: `account/rotateKeys`
64
72
  *