@opusdns/api 0.55.0 → 0.57.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/package.json +1 -1
- package/src/helpers/keys.ts +26 -838
- package/src/helpers/requests.d.ts +1 -315
- package/src/helpers/responses.d.ts +1 -585
- package/src/helpers/schemas.d.ts +0 -80
- package/src/openapi.yaml +39 -628
- package/src/schema.d.ts +47 -717
package/src/helpers/keys.ts
CHANGED
|
@@ -129,7 +129,6 @@ import { RgpOperations } from './schemas';
|
|
|
129
129
|
import { SignupCreate } from './schemas';
|
|
130
130
|
import { SldLength } from './schemas';
|
|
131
131
|
import { SpiceDbRelationshipUpdate } from './schemas';
|
|
132
|
-
import { StartPasswordReset } from './schemas';
|
|
133
132
|
import { TermsOfServiceAccept } from './schemas';
|
|
134
133
|
import { TldBase } from './schemas';
|
|
135
134
|
import { TldResponseShort } from './schemas';
|
|
@@ -140,12 +139,8 @@ import { User } from './schemas';
|
|
|
140
139
|
import { UserAgreementAcceptance } from './schemas';
|
|
141
140
|
import { UserAttributeBase } from './schemas';
|
|
142
141
|
import { UserCreate } from './schemas';
|
|
143
|
-
import { UserPasswordResetEmail } from './schemas';
|
|
144
142
|
import { UserToken } from './schemas';
|
|
145
143
|
import { UserUpdate } from './schemas';
|
|
146
|
-
import { UserVerificationApi } from './schemas';
|
|
147
|
-
import { UserVerificationEmail } from './schemas';
|
|
148
|
-
import { UserVerification } from './schemas';
|
|
149
144
|
import { UserWithAttributes } from './schemas';
|
|
150
145
|
import { UserWithRelationPermissions } from './schemas';
|
|
151
146
|
import { ValidationError } from './schemas';
|
|
@@ -408,6 +403,31 @@ export const KEY_BILLING_PLAN_NAME = 'name' as keyof BillingPlan;
|
|
|
408
403
|
* @see {@link KEYS_BILLING_PLAN} - Array of all keys for this type
|
|
409
404
|
*/
|
|
410
405
|
export const KEY_BILLING_PLAN_PLAN_ID = 'plan_id' as keyof BillingPlan;
|
|
406
|
+
/**
|
|
407
|
+
* Plan Level
|
|
408
|
+
*
|
|
409
|
+
* Plan level such as 'basic', 'premium' or 'enterprise'.
|
|
410
|
+
*
|
|
411
|
+
*
|
|
412
|
+
*
|
|
413
|
+
* @remarks
|
|
414
|
+
* This key constant provides type-safe access to the `plan_level` property of BillingPlan objects.
|
|
415
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
416
|
+
*
|
|
417
|
+
* @example
|
|
418
|
+
* ```typescript
|
|
419
|
+
* // Direct property access
|
|
420
|
+
* const value = billingplan[KEY_BILLING_PLAN_PLAN_LEVEL];
|
|
421
|
+
*
|
|
422
|
+
* // Dynamic property access
|
|
423
|
+
* const propertyName = KEY_BILLING_PLAN_PLAN_LEVEL;
|
|
424
|
+
* const value = billingplan[propertyName];
|
|
425
|
+
* ```
|
|
426
|
+
*
|
|
427
|
+
* @see {@link BillingPlan} - The TypeScript type definition
|
|
428
|
+
* @see {@link KEYS_BILLING_PLAN} - Array of all keys for this type
|
|
429
|
+
*/
|
|
430
|
+
export const KEY_BILLING_PLAN_PLAN_LEVEL = 'plan_level' as keyof BillingPlan;
|
|
411
431
|
/**
|
|
412
432
|
* Type
|
|
413
433
|
*
|
|
@@ -459,6 +479,7 @@ export const KEYS_BILLING_PLAN = [
|
|
|
459
479
|
KEY_BILLING_PLAN_CURRENCY,
|
|
460
480
|
KEY_BILLING_PLAN_NAME,
|
|
461
481
|
KEY_BILLING_PLAN_PLAN_ID,
|
|
482
|
+
KEY_BILLING_PLAN_PLAN_LEVEL,
|
|
462
483
|
KEY_BILLING_PLAN_TYPE,
|
|
463
484
|
] as const satisfies (keyof BillingPlan)[];
|
|
464
485
|
|
|
@@ -15239,56 +15260,6 @@ export const KEYS_SPICE_DB_RELATIONSHIP_UPDATE = [
|
|
|
15239
15260
|
KEY_SPICE_DB_RELATIONSHIP_UPDATE_REMOVE,
|
|
15240
15261
|
] as const satisfies (keyof SpiceDbRelationshipUpdate)[];
|
|
15241
15262
|
|
|
15242
|
-
/**
|
|
15243
|
-
* Email
|
|
15244
|
-
*
|
|
15245
|
-
*
|
|
15246
|
-
* @type {string}
|
|
15247
|
-
*
|
|
15248
|
-
*
|
|
15249
|
-
* @remarks
|
|
15250
|
-
* This key constant provides type-safe access to the `email` property of StartPasswordReset objects.
|
|
15251
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
15252
|
-
*
|
|
15253
|
-
* @example
|
|
15254
|
-
* ```typescript
|
|
15255
|
-
* // Direct property access
|
|
15256
|
-
* const value = startpasswordreset[KEY_START_PASSWORD_RESET_EMAIL];
|
|
15257
|
-
*
|
|
15258
|
-
* // Dynamic property access
|
|
15259
|
-
* const propertyName = KEY_START_PASSWORD_RESET_EMAIL;
|
|
15260
|
-
* const value = startpasswordreset[propertyName];
|
|
15261
|
-
* ```
|
|
15262
|
-
*
|
|
15263
|
-
* @see {@link StartPasswordReset} - The TypeScript type definition
|
|
15264
|
-
* @see {@link KEYS_START_PASSWORD_RESET} - Array of all keys for this type
|
|
15265
|
-
*/
|
|
15266
|
-
export const KEY_START_PASSWORD_RESET_EMAIL = 'email' as keyof StartPasswordReset;
|
|
15267
|
-
|
|
15268
|
-
/**
|
|
15269
|
-
* Array of all StartPasswordReset property keys
|
|
15270
|
-
*
|
|
15271
|
-
* @remarks
|
|
15272
|
-
* This constant provides a readonly array containing all valid property keys for StartPasswordReset objects.
|
|
15273
|
-
* Useful for iteration, validation, and generating dynamic UI components.
|
|
15274
|
-
*
|
|
15275
|
-
* @example
|
|
15276
|
-
* ```typescript
|
|
15277
|
-
* // Iterating through all keys
|
|
15278
|
-
* for (const key of KEYS_START_PASSWORD_RESET) {
|
|
15279
|
-
* console.log(`Property: ${key}, Value: ${startpasswordreset[key]}`);
|
|
15280
|
-
* }
|
|
15281
|
-
*
|
|
15282
|
-
* // Validation
|
|
15283
|
-
* const isValidKey = KEYS_START_PASSWORD_RESET.includes(someKey);
|
|
15284
|
-
* ```
|
|
15285
|
-
*
|
|
15286
|
-
* @see {@link StartPasswordReset} - The TypeScript type definition
|
|
15287
|
-
*/
|
|
15288
|
-
export const KEYS_START_PASSWORD_RESET = [
|
|
15289
|
-
KEY_START_PASSWORD_RESET_EMAIL,
|
|
15290
|
-
] as const satisfies (keyof StartPasswordReset)[];
|
|
15291
|
-
|
|
15292
15263
|
/**
|
|
15293
15264
|
* Accepted
|
|
15294
15265
|
*
|
|
@@ -17264,57 +17235,6 @@ export const KEYS_USER_CREATE = [
|
|
|
17264
17235
|
KEY_USER_CREATE_USERNAME,
|
|
17265
17236
|
] as const satisfies (keyof UserCreate)[];
|
|
17266
17237
|
|
|
17267
|
-
/**
|
|
17268
|
-
* Message
|
|
17269
|
-
*
|
|
17270
|
-
* Message to the user. This message is always displayed regarding the password reset process to prevent leaking information.
|
|
17271
|
-
*
|
|
17272
|
-
* @type {string}
|
|
17273
|
-
*
|
|
17274
|
-
*
|
|
17275
|
-
* @remarks
|
|
17276
|
-
* This key constant provides type-safe access to the `message` property of UserPasswordResetEmail objects.
|
|
17277
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
17278
|
-
*
|
|
17279
|
-
* @example
|
|
17280
|
-
* ```typescript
|
|
17281
|
-
* // Direct property access
|
|
17282
|
-
* const value = userpasswordresetemail[KEY_USER_PASSWORD_RESET_EMAIL_MESSAGE];
|
|
17283
|
-
*
|
|
17284
|
-
* // Dynamic property access
|
|
17285
|
-
* const propertyName = KEY_USER_PASSWORD_RESET_EMAIL_MESSAGE;
|
|
17286
|
-
* const value = userpasswordresetemail[propertyName];
|
|
17287
|
-
* ```
|
|
17288
|
-
*
|
|
17289
|
-
* @see {@link UserPasswordResetEmail} - The TypeScript type definition
|
|
17290
|
-
* @see {@link KEYS_USER_PASSWORD_RESET_EMAIL} - Array of all keys for this type
|
|
17291
|
-
*/
|
|
17292
|
-
export const KEY_USER_PASSWORD_RESET_EMAIL_MESSAGE = 'message' as keyof UserPasswordResetEmail;
|
|
17293
|
-
|
|
17294
|
-
/**
|
|
17295
|
-
* Array of all UserPasswordResetEmail property keys
|
|
17296
|
-
*
|
|
17297
|
-
* @remarks
|
|
17298
|
-
* This constant provides a readonly array containing all valid property keys for UserPasswordResetEmail objects.
|
|
17299
|
-
* Useful for iteration, validation, and generating dynamic UI components.
|
|
17300
|
-
*
|
|
17301
|
-
* @example
|
|
17302
|
-
* ```typescript
|
|
17303
|
-
* // Iterating through all keys
|
|
17304
|
-
* for (const key of KEYS_USER_PASSWORD_RESET_EMAIL) {
|
|
17305
|
-
* console.log(`Property: ${key}, Value: ${userpasswordresetemail[key]}`);
|
|
17306
|
-
* }
|
|
17307
|
-
*
|
|
17308
|
-
* // Validation
|
|
17309
|
-
* const isValidKey = KEYS_USER_PASSWORD_RESET_EMAIL.includes(someKey);
|
|
17310
|
-
* ```
|
|
17311
|
-
*
|
|
17312
|
-
* @see {@link UserPasswordResetEmail} - The TypeScript type definition
|
|
17313
|
-
*/
|
|
17314
|
-
export const KEYS_USER_PASSWORD_RESET_EMAIL = [
|
|
17315
|
-
KEY_USER_PASSWORD_RESET_EMAIL_MESSAGE,
|
|
17316
|
-
] as const satisfies (keyof UserPasswordResetEmail)[];
|
|
17317
|
-
|
|
17318
17238
|
/**
|
|
17319
17239
|
* Access Token
|
|
17320
17240
|
*
|
|
@@ -17675,738 +17595,6 @@ export const KEYS_USER_UPDATE = [
|
|
|
17675
17595
|
KEY_USER_UPDATE_USERNAME,
|
|
17676
17596
|
] as const satisfies (keyof UserUpdate)[];
|
|
17677
17597
|
|
|
17678
|
-
/**
|
|
17679
|
-
* Canceled On
|
|
17680
|
-
*
|
|
17681
|
-
* The date the verification was cancelled
|
|
17682
|
-
*
|
|
17683
|
-
*
|
|
17684
|
-
*
|
|
17685
|
-
* @remarks
|
|
17686
|
-
* This key constant provides type-safe access to the `canceled_on` property of UserVerificationApi objects.
|
|
17687
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
17688
|
-
*
|
|
17689
|
-
* @example
|
|
17690
|
-
* ```typescript
|
|
17691
|
-
* // Direct property access
|
|
17692
|
-
* const value = userverificationapi[KEY_USER_VERIFICATION_API_CANCELED_ON];
|
|
17693
|
-
*
|
|
17694
|
-
* // Dynamic property access
|
|
17695
|
-
* const propertyName = KEY_USER_VERIFICATION_API_CANCELED_ON;
|
|
17696
|
-
* const value = userverificationapi[propertyName];
|
|
17697
|
-
* ```
|
|
17698
|
-
*
|
|
17699
|
-
* @see {@link UserVerificationApi} - The TypeScript type definition
|
|
17700
|
-
* @see {@link KEYS_USER_VERIFICATION_API} - Array of all keys for this type
|
|
17701
|
-
*/
|
|
17702
|
-
export const KEY_USER_VERIFICATION_API_CANCELED_ON = 'canceled_on' as keyof UserVerificationApi;
|
|
17703
|
-
/**
|
|
17704
|
-
* Created On
|
|
17705
|
-
*
|
|
17706
|
-
* The date/time the entry was created on
|
|
17707
|
-
*
|
|
17708
|
-
* @type {string}
|
|
17709
|
-
*
|
|
17710
|
-
*
|
|
17711
|
-
* @remarks
|
|
17712
|
-
* This key constant provides type-safe access to the `created_on` property of UserVerificationApi objects.
|
|
17713
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
17714
|
-
*
|
|
17715
|
-
* @example
|
|
17716
|
-
* ```typescript
|
|
17717
|
-
* // Direct property access
|
|
17718
|
-
* const value = userverificationapi[KEY_USER_VERIFICATION_API_CREATED_ON];
|
|
17719
|
-
*
|
|
17720
|
-
* // Dynamic property access
|
|
17721
|
-
* const propertyName = KEY_USER_VERIFICATION_API_CREATED_ON;
|
|
17722
|
-
* const value = userverificationapi[propertyName];
|
|
17723
|
-
* ```
|
|
17724
|
-
*
|
|
17725
|
-
* @see {@link UserVerificationApi} - The TypeScript type definition
|
|
17726
|
-
* @see {@link KEYS_USER_VERIFICATION_API} - Array of all keys for this type
|
|
17727
|
-
*/
|
|
17728
|
-
export const KEY_USER_VERIFICATION_API_CREATED_ON = 'created_on' as keyof UserVerificationApi;
|
|
17729
|
-
/**
|
|
17730
|
-
* status property
|
|
17731
|
-
*
|
|
17732
|
-
* Current status of the email verification
|
|
17733
|
-
*
|
|
17734
|
-
*
|
|
17735
|
-
*
|
|
17736
|
-
* @remarks
|
|
17737
|
-
* This key constant provides type-safe access to the `status` property of UserVerificationApi objects.
|
|
17738
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
17739
|
-
*
|
|
17740
|
-
* @example
|
|
17741
|
-
* ```typescript
|
|
17742
|
-
* // Direct property access
|
|
17743
|
-
* const value = userverificationapi[KEY_USER_VERIFICATION_API_STATUS];
|
|
17744
|
-
*
|
|
17745
|
-
* // Dynamic property access
|
|
17746
|
-
* const propertyName = KEY_USER_VERIFICATION_API_STATUS;
|
|
17747
|
-
* const value = userverificationapi[propertyName];
|
|
17748
|
-
* ```
|
|
17749
|
-
*
|
|
17750
|
-
* @see {@link UserVerificationApi} - The TypeScript type definition
|
|
17751
|
-
* @see {@link KEYS_USER_VERIFICATION_API} - Array of all keys for this type
|
|
17752
|
-
*/
|
|
17753
|
-
export const KEY_USER_VERIFICATION_API_STATUS = 'status' as keyof UserVerificationApi;
|
|
17754
|
-
/**
|
|
17755
|
-
* Token
|
|
17756
|
-
*
|
|
17757
|
-
* The token to verify the email address
|
|
17758
|
-
*
|
|
17759
|
-
* @type {string}
|
|
17760
|
-
*
|
|
17761
|
-
*
|
|
17762
|
-
* @remarks
|
|
17763
|
-
* This key constant provides type-safe access to the `token` property of UserVerificationApi objects.
|
|
17764
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
17765
|
-
*
|
|
17766
|
-
* @example
|
|
17767
|
-
* ```typescript
|
|
17768
|
-
* // Direct property access
|
|
17769
|
-
* const value = userverificationapi[KEY_USER_VERIFICATION_API_TOKEN];
|
|
17770
|
-
*
|
|
17771
|
-
* // Dynamic property access
|
|
17772
|
-
* const propertyName = KEY_USER_VERIFICATION_API_TOKEN;
|
|
17773
|
-
* const value = userverificationapi[propertyName];
|
|
17774
|
-
* ```
|
|
17775
|
-
*
|
|
17776
|
-
* @see {@link UserVerificationApi} - The TypeScript type definition
|
|
17777
|
-
* @see {@link KEYS_USER_VERIFICATION_API} - Array of all keys for this type
|
|
17778
|
-
*/
|
|
17779
|
-
export const KEY_USER_VERIFICATION_API_TOKEN = 'token' as keyof UserVerificationApi;
|
|
17780
|
-
/**
|
|
17781
|
-
* type property
|
|
17782
|
-
*
|
|
17783
|
-
* The type of verification: 'api' for retrieving token via API, 'email' for retrieving via email
|
|
17784
|
-
*
|
|
17785
|
-
*
|
|
17786
|
-
*
|
|
17787
|
-
* @remarks
|
|
17788
|
-
* This key constant provides type-safe access to the `type` property of UserVerificationApi objects.
|
|
17789
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
17790
|
-
*
|
|
17791
|
-
* @example
|
|
17792
|
-
* ```typescript
|
|
17793
|
-
* // Direct property access
|
|
17794
|
-
* const value = userverificationapi[KEY_USER_VERIFICATION_API_TYPE];
|
|
17795
|
-
*
|
|
17796
|
-
* // Dynamic property access
|
|
17797
|
-
* const propertyName = KEY_USER_VERIFICATION_API_TYPE;
|
|
17798
|
-
* const value = userverificationapi[propertyName];
|
|
17799
|
-
* ```
|
|
17800
|
-
*
|
|
17801
|
-
* @see {@link UserVerificationApi} - The TypeScript type definition
|
|
17802
|
-
* @see {@link KEYS_USER_VERIFICATION_API} - Array of all keys for this type
|
|
17803
|
-
*/
|
|
17804
|
-
export const KEY_USER_VERIFICATION_API_TYPE = 'type' as keyof UserVerificationApi;
|
|
17805
|
-
/**
|
|
17806
|
-
* Updated On
|
|
17807
|
-
*
|
|
17808
|
-
* The date/time the entry was last updated on
|
|
17809
|
-
*
|
|
17810
|
-
* @type {string}
|
|
17811
|
-
*
|
|
17812
|
-
*
|
|
17813
|
-
* @remarks
|
|
17814
|
-
* This key constant provides type-safe access to the `updated_on` property of UserVerificationApi objects.
|
|
17815
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
17816
|
-
*
|
|
17817
|
-
* @example
|
|
17818
|
-
* ```typescript
|
|
17819
|
-
* // Direct property access
|
|
17820
|
-
* const value = userverificationapi[KEY_USER_VERIFICATION_API_UPDATED_ON];
|
|
17821
|
-
*
|
|
17822
|
-
* // Dynamic property access
|
|
17823
|
-
* const propertyName = KEY_USER_VERIFICATION_API_UPDATED_ON;
|
|
17824
|
-
* const value = userverificationapi[propertyName];
|
|
17825
|
-
* ```
|
|
17826
|
-
*
|
|
17827
|
-
* @see {@link UserVerificationApi} - The TypeScript type definition
|
|
17828
|
-
* @see {@link KEYS_USER_VERIFICATION_API} - Array of all keys for this type
|
|
17829
|
-
*/
|
|
17830
|
-
export const KEY_USER_VERIFICATION_API_UPDATED_ON = 'updated_on' as keyof UserVerificationApi;
|
|
17831
|
-
/**
|
|
17832
|
-
* User Id
|
|
17833
|
-
*
|
|
17834
|
-
* The user's id
|
|
17835
|
-
*
|
|
17836
|
-
* @type {string}
|
|
17837
|
-
*
|
|
17838
|
-
*
|
|
17839
|
-
* @remarks
|
|
17840
|
-
* This key constant provides type-safe access to the `user_id` property of UserVerificationApi objects.
|
|
17841
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
17842
|
-
*
|
|
17843
|
-
* @example
|
|
17844
|
-
* ```typescript
|
|
17845
|
-
* // Direct property access
|
|
17846
|
-
* const value = userverificationapi[KEY_USER_VERIFICATION_API_USER_ID];
|
|
17847
|
-
*
|
|
17848
|
-
* // Dynamic property access
|
|
17849
|
-
* const propertyName = KEY_USER_VERIFICATION_API_USER_ID;
|
|
17850
|
-
* const value = userverificationapi[propertyName];
|
|
17851
|
-
* ```
|
|
17852
|
-
*
|
|
17853
|
-
* @see {@link UserVerificationApi} - The TypeScript type definition
|
|
17854
|
-
* @see {@link KEYS_USER_VERIFICATION_API} - Array of all keys for this type
|
|
17855
|
-
*/
|
|
17856
|
-
export const KEY_USER_VERIFICATION_API_USER_ID = 'user_id' as keyof UserVerificationApi;
|
|
17857
|
-
/**
|
|
17858
|
-
* User Verification Id
|
|
17859
|
-
*
|
|
17860
|
-
*
|
|
17861
|
-
* @type {string}
|
|
17862
|
-
*
|
|
17863
|
-
*
|
|
17864
|
-
* @remarks
|
|
17865
|
-
* This key constant provides type-safe access to the `user_verification_id` property of UserVerificationApi objects.
|
|
17866
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
17867
|
-
*
|
|
17868
|
-
* @example
|
|
17869
|
-
* ```typescript
|
|
17870
|
-
* // Direct property access
|
|
17871
|
-
* const value = userverificationapi[KEY_USER_VERIFICATION_API_USER_VERIFICATION_ID];
|
|
17872
|
-
*
|
|
17873
|
-
* // Dynamic property access
|
|
17874
|
-
* const propertyName = KEY_USER_VERIFICATION_API_USER_VERIFICATION_ID;
|
|
17875
|
-
* const value = userverificationapi[propertyName];
|
|
17876
|
-
* ```
|
|
17877
|
-
*
|
|
17878
|
-
* @see {@link UserVerificationApi} - The TypeScript type definition
|
|
17879
|
-
* @see {@link KEYS_USER_VERIFICATION_API} - Array of all keys for this type
|
|
17880
|
-
*/
|
|
17881
|
-
export const KEY_USER_VERIFICATION_API_USER_VERIFICATION_ID = 'user_verification_id' as keyof UserVerificationApi;
|
|
17882
|
-
/**
|
|
17883
|
-
* Verified On
|
|
17884
|
-
*
|
|
17885
|
-
* The date the verification was verified
|
|
17886
|
-
*
|
|
17887
|
-
*
|
|
17888
|
-
*
|
|
17889
|
-
* @remarks
|
|
17890
|
-
* This key constant provides type-safe access to the `verified_on` property of UserVerificationApi objects.
|
|
17891
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
17892
|
-
*
|
|
17893
|
-
* @example
|
|
17894
|
-
* ```typescript
|
|
17895
|
-
* // Direct property access
|
|
17896
|
-
* const value = userverificationapi[KEY_USER_VERIFICATION_API_VERIFIED_ON];
|
|
17897
|
-
*
|
|
17898
|
-
* // Dynamic property access
|
|
17899
|
-
* const propertyName = KEY_USER_VERIFICATION_API_VERIFIED_ON;
|
|
17900
|
-
* const value = userverificationapi[propertyName];
|
|
17901
|
-
* ```
|
|
17902
|
-
*
|
|
17903
|
-
* @see {@link UserVerificationApi} - The TypeScript type definition
|
|
17904
|
-
* @see {@link KEYS_USER_VERIFICATION_API} - Array of all keys for this type
|
|
17905
|
-
*/
|
|
17906
|
-
export const KEY_USER_VERIFICATION_API_VERIFIED_ON = 'verified_on' as keyof UserVerificationApi;
|
|
17907
|
-
|
|
17908
|
-
/**
|
|
17909
|
-
* Array of all UserVerificationApi property keys
|
|
17910
|
-
*
|
|
17911
|
-
* @remarks
|
|
17912
|
-
* This constant provides a readonly array containing all valid property keys for UserVerificationApi objects.
|
|
17913
|
-
* Useful for iteration, validation, and generating dynamic UI components.
|
|
17914
|
-
*
|
|
17915
|
-
* @example
|
|
17916
|
-
* ```typescript
|
|
17917
|
-
* // Iterating through all keys
|
|
17918
|
-
* for (const key of KEYS_USER_VERIFICATION_API) {
|
|
17919
|
-
* console.log(`Property: ${key}, Value: ${userverificationapi[key]}`);
|
|
17920
|
-
* }
|
|
17921
|
-
*
|
|
17922
|
-
* // Validation
|
|
17923
|
-
* const isValidKey = KEYS_USER_VERIFICATION_API.includes(someKey);
|
|
17924
|
-
* ```
|
|
17925
|
-
*
|
|
17926
|
-
* @see {@link UserVerificationApi} - The TypeScript type definition
|
|
17927
|
-
*/
|
|
17928
|
-
export const KEYS_USER_VERIFICATION_API = [
|
|
17929
|
-
KEY_USER_VERIFICATION_API_CANCELED_ON,
|
|
17930
|
-
KEY_USER_VERIFICATION_API_CREATED_ON,
|
|
17931
|
-
KEY_USER_VERIFICATION_API_STATUS,
|
|
17932
|
-
KEY_USER_VERIFICATION_API_TOKEN,
|
|
17933
|
-
KEY_USER_VERIFICATION_API_TYPE,
|
|
17934
|
-
KEY_USER_VERIFICATION_API_UPDATED_ON,
|
|
17935
|
-
KEY_USER_VERIFICATION_API_USER_ID,
|
|
17936
|
-
KEY_USER_VERIFICATION_API_USER_VERIFICATION_ID,
|
|
17937
|
-
KEY_USER_VERIFICATION_API_VERIFIED_ON,
|
|
17938
|
-
] as const satisfies (keyof UserVerificationApi)[];
|
|
17939
|
-
|
|
17940
|
-
/**
|
|
17941
|
-
* Canceled On
|
|
17942
|
-
*
|
|
17943
|
-
* The date the verification was cancelled
|
|
17944
|
-
*
|
|
17945
|
-
*
|
|
17946
|
-
*
|
|
17947
|
-
* @remarks
|
|
17948
|
-
* This key constant provides type-safe access to the `canceled_on` property of UserVerificationEmail objects.
|
|
17949
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
17950
|
-
*
|
|
17951
|
-
* @example
|
|
17952
|
-
* ```typescript
|
|
17953
|
-
* // Direct property access
|
|
17954
|
-
* const value = userverificationemail[KEY_USER_VERIFICATION_EMAIL_CANCELED_ON];
|
|
17955
|
-
*
|
|
17956
|
-
* // Dynamic property access
|
|
17957
|
-
* const propertyName = KEY_USER_VERIFICATION_EMAIL_CANCELED_ON;
|
|
17958
|
-
* const value = userverificationemail[propertyName];
|
|
17959
|
-
* ```
|
|
17960
|
-
*
|
|
17961
|
-
* @see {@link UserVerificationEmail} - The TypeScript type definition
|
|
17962
|
-
* @see {@link KEYS_USER_VERIFICATION_EMAIL} - Array of all keys for this type
|
|
17963
|
-
*/
|
|
17964
|
-
export const KEY_USER_VERIFICATION_EMAIL_CANCELED_ON = 'canceled_on' as keyof UserVerificationEmail;
|
|
17965
|
-
/**
|
|
17966
|
-
* Created On
|
|
17967
|
-
*
|
|
17968
|
-
* The date/time the entry was created on
|
|
17969
|
-
*
|
|
17970
|
-
* @type {string}
|
|
17971
|
-
*
|
|
17972
|
-
*
|
|
17973
|
-
* @remarks
|
|
17974
|
-
* This key constant provides type-safe access to the `created_on` property of UserVerificationEmail objects.
|
|
17975
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
17976
|
-
*
|
|
17977
|
-
* @example
|
|
17978
|
-
* ```typescript
|
|
17979
|
-
* // Direct property access
|
|
17980
|
-
* const value = userverificationemail[KEY_USER_VERIFICATION_EMAIL_CREATED_ON];
|
|
17981
|
-
*
|
|
17982
|
-
* // Dynamic property access
|
|
17983
|
-
* const propertyName = KEY_USER_VERIFICATION_EMAIL_CREATED_ON;
|
|
17984
|
-
* const value = userverificationemail[propertyName];
|
|
17985
|
-
* ```
|
|
17986
|
-
*
|
|
17987
|
-
* @see {@link UserVerificationEmail} - The TypeScript type definition
|
|
17988
|
-
* @see {@link KEYS_USER_VERIFICATION_EMAIL} - Array of all keys for this type
|
|
17989
|
-
*/
|
|
17990
|
-
export const KEY_USER_VERIFICATION_EMAIL_CREATED_ON = 'created_on' as keyof UserVerificationEmail;
|
|
17991
|
-
/**
|
|
17992
|
-
* status property
|
|
17993
|
-
*
|
|
17994
|
-
* Current status of the email verification
|
|
17995
|
-
*
|
|
17996
|
-
*
|
|
17997
|
-
*
|
|
17998
|
-
* @remarks
|
|
17999
|
-
* This key constant provides type-safe access to the `status` property of UserVerificationEmail objects.
|
|
18000
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
18001
|
-
*
|
|
18002
|
-
* @example
|
|
18003
|
-
* ```typescript
|
|
18004
|
-
* // Direct property access
|
|
18005
|
-
* const value = userverificationemail[KEY_USER_VERIFICATION_EMAIL_STATUS];
|
|
18006
|
-
*
|
|
18007
|
-
* // Dynamic property access
|
|
18008
|
-
* const propertyName = KEY_USER_VERIFICATION_EMAIL_STATUS;
|
|
18009
|
-
* const value = userverificationemail[propertyName];
|
|
18010
|
-
* ```
|
|
18011
|
-
*
|
|
18012
|
-
* @see {@link UserVerificationEmail} - The TypeScript type definition
|
|
18013
|
-
* @see {@link KEYS_USER_VERIFICATION_EMAIL} - Array of all keys for this type
|
|
18014
|
-
*/
|
|
18015
|
-
export const KEY_USER_VERIFICATION_EMAIL_STATUS = 'status' as keyof UserVerificationEmail;
|
|
18016
|
-
/**
|
|
18017
|
-
* type property
|
|
18018
|
-
*
|
|
18019
|
-
* The type of verification: 'api' for retrieving token via API, 'email' for retrieving via email
|
|
18020
|
-
*
|
|
18021
|
-
*
|
|
18022
|
-
*
|
|
18023
|
-
* @remarks
|
|
18024
|
-
* This key constant provides type-safe access to the `type` property of UserVerificationEmail objects.
|
|
18025
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
18026
|
-
*
|
|
18027
|
-
* @example
|
|
18028
|
-
* ```typescript
|
|
18029
|
-
* // Direct property access
|
|
18030
|
-
* const value = userverificationemail[KEY_USER_VERIFICATION_EMAIL_TYPE];
|
|
18031
|
-
*
|
|
18032
|
-
* // Dynamic property access
|
|
18033
|
-
* const propertyName = KEY_USER_VERIFICATION_EMAIL_TYPE;
|
|
18034
|
-
* const value = userverificationemail[propertyName];
|
|
18035
|
-
* ```
|
|
18036
|
-
*
|
|
18037
|
-
* @see {@link UserVerificationEmail} - The TypeScript type definition
|
|
18038
|
-
* @see {@link KEYS_USER_VERIFICATION_EMAIL} - Array of all keys for this type
|
|
18039
|
-
*/
|
|
18040
|
-
export const KEY_USER_VERIFICATION_EMAIL_TYPE = 'type' as keyof UserVerificationEmail;
|
|
18041
|
-
/**
|
|
18042
|
-
* Updated On
|
|
18043
|
-
*
|
|
18044
|
-
* The date/time the entry was last updated on
|
|
18045
|
-
*
|
|
18046
|
-
* @type {string}
|
|
18047
|
-
*
|
|
18048
|
-
*
|
|
18049
|
-
* @remarks
|
|
18050
|
-
* This key constant provides type-safe access to the `updated_on` property of UserVerificationEmail objects.
|
|
18051
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
18052
|
-
*
|
|
18053
|
-
* @example
|
|
18054
|
-
* ```typescript
|
|
18055
|
-
* // Direct property access
|
|
18056
|
-
* const value = userverificationemail[KEY_USER_VERIFICATION_EMAIL_UPDATED_ON];
|
|
18057
|
-
*
|
|
18058
|
-
* // Dynamic property access
|
|
18059
|
-
* const propertyName = KEY_USER_VERIFICATION_EMAIL_UPDATED_ON;
|
|
18060
|
-
* const value = userverificationemail[propertyName];
|
|
18061
|
-
* ```
|
|
18062
|
-
*
|
|
18063
|
-
* @see {@link UserVerificationEmail} - The TypeScript type definition
|
|
18064
|
-
* @see {@link KEYS_USER_VERIFICATION_EMAIL} - Array of all keys for this type
|
|
18065
|
-
*/
|
|
18066
|
-
export const KEY_USER_VERIFICATION_EMAIL_UPDATED_ON = 'updated_on' as keyof UserVerificationEmail;
|
|
18067
|
-
/**
|
|
18068
|
-
* User Id
|
|
18069
|
-
*
|
|
18070
|
-
* The user's id
|
|
18071
|
-
*
|
|
18072
|
-
* @type {string}
|
|
18073
|
-
*
|
|
18074
|
-
*
|
|
18075
|
-
* @remarks
|
|
18076
|
-
* This key constant provides type-safe access to the `user_id` property of UserVerificationEmail objects.
|
|
18077
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
18078
|
-
*
|
|
18079
|
-
* @example
|
|
18080
|
-
* ```typescript
|
|
18081
|
-
* // Direct property access
|
|
18082
|
-
* const value = userverificationemail[KEY_USER_VERIFICATION_EMAIL_USER_ID];
|
|
18083
|
-
*
|
|
18084
|
-
* // Dynamic property access
|
|
18085
|
-
* const propertyName = KEY_USER_VERIFICATION_EMAIL_USER_ID;
|
|
18086
|
-
* const value = userverificationemail[propertyName];
|
|
18087
|
-
* ```
|
|
18088
|
-
*
|
|
18089
|
-
* @see {@link UserVerificationEmail} - The TypeScript type definition
|
|
18090
|
-
* @see {@link KEYS_USER_VERIFICATION_EMAIL} - Array of all keys for this type
|
|
18091
|
-
*/
|
|
18092
|
-
export const KEY_USER_VERIFICATION_EMAIL_USER_ID = 'user_id' as keyof UserVerificationEmail;
|
|
18093
|
-
/**
|
|
18094
|
-
* User Verification Id
|
|
18095
|
-
*
|
|
18096
|
-
*
|
|
18097
|
-
* @type {string}
|
|
18098
|
-
*
|
|
18099
|
-
*
|
|
18100
|
-
* @remarks
|
|
18101
|
-
* This key constant provides type-safe access to the `user_verification_id` property of UserVerificationEmail objects.
|
|
18102
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
18103
|
-
*
|
|
18104
|
-
* @example
|
|
18105
|
-
* ```typescript
|
|
18106
|
-
* // Direct property access
|
|
18107
|
-
* const value = userverificationemail[KEY_USER_VERIFICATION_EMAIL_USER_VERIFICATION_ID];
|
|
18108
|
-
*
|
|
18109
|
-
* // Dynamic property access
|
|
18110
|
-
* const propertyName = KEY_USER_VERIFICATION_EMAIL_USER_VERIFICATION_ID;
|
|
18111
|
-
* const value = userverificationemail[propertyName];
|
|
18112
|
-
* ```
|
|
18113
|
-
*
|
|
18114
|
-
* @see {@link UserVerificationEmail} - The TypeScript type definition
|
|
18115
|
-
* @see {@link KEYS_USER_VERIFICATION_EMAIL} - Array of all keys for this type
|
|
18116
|
-
*/
|
|
18117
|
-
export const KEY_USER_VERIFICATION_EMAIL_USER_VERIFICATION_ID = 'user_verification_id' as keyof UserVerificationEmail;
|
|
18118
|
-
/**
|
|
18119
|
-
* Verified On
|
|
18120
|
-
*
|
|
18121
|
-
* The date the verification was verified
|
|
18122
|
-
*
|
|
18123
|
-
*
|
|
18124
|
-
*
|
|
18125
|
-
* @remarks
|
|
18126
|
-
* This key constant provides type-safe access to the `verified_on` property of UserVerificationEmail objects.
|
|
18127
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
18128
|
-
*
|
|
18129
|
-
* @example
|
|
18130
|
-
* ```typescript
|
|
18131
|
-
* // Direct property access
|
|
18132
|
-
* const value = userverificationemail[KEY_USER_VERIFICATION_EMAIL_VERIFIED_ON];
|
|
18133
|
-
*
|
|
18134
|
-
* // Dynamic property access
|
|
18135
|
-
* const propertyName = KEY_USER_VERIFICATION_EMAIL_VERIFIED_ON;
|
|
18136
|
-
* const value = userverificationemail[propertyName];
|
|
18137
|
-
* ```
|
|
18138
|
-
*
|
|
18139
|
-
* @see {@link UserVerificationEmail} - The TypeScript type definition
|
|
18140
|
-
* @see {@link KEYS_USER_VERIFICATION_EMAIL} - Array of all keys for this type
|
|
18141
|
-
*/
|
|
18142
|
-
export const KEY_USER_VERIFICATION_EMAIL_VERIFIED_ON = 'verified_on' as keyof UserVerificationEmail;
|
|
18143
|
-
|
|
18144
|
-
/**
|
|
18145
|
-
* Array of all UserVerificationEmail property keys
|
|
18146
|
-
*
|
|
18147
|
-
* @remarks
|
|
18148
|
-
* This constant provides a readonly array containing all valid property keys for UserVerificationEmail objects.
|
|
18149
|
-
* Useful for iteration, validation, and generating dynamic UI components.
|
|
18150
|
-
*
|
|
18151
|
-
* @example
|
|
18152
|
-
* ```typescript
|
|
18153
|
-
* // Iterating through all keys
|
|
18154
|
-
* for (const key of KEYS_USER_VERIFICATION_EMAIL) {
|
|
18155
|
-
* console.log(`Property: ${key}, Value: ${userverificationemail[key]}`);
|
|
18156
|
-
* }
|
|
18157
|
-
*
|
|
18158
|
-
* // Validation
|
|
18159
|
-
* const isValidKey = KEYS_USER_VERIFICATION_EMAIL.includes(someKey);
|
|
18160
|
-
* ```
|
|
18161
|
-
*
|
|
18162
|
-
* @see {@link UserVerificationEmail} - The TypeScript type definition
|
|
18163
|
-
*/
|
|
18164
|
-
export const KEYS_USER_VERIFICATION_EMAIL = [
|
|
18165
|
-
KEY_USER_VERIFICATION_EMAIL_CANCELED_ON,
|
|
18166
|
-
KEY_USER_VERIFICATION_EMAIL_CREATED_ON,
|
|
18167
|
-
KEY_USER_VERIFICATION_EMAIL_STATUS,
|
|
18168
|
-
KEY_USER_VERIFICATION_EMAIL_TYPE,
|
|
18169
|
-
KEY_USER_VERIFICATION_EMAIL_UPDATED_ON,
|
|
18170
|
-
KEY_USER_VERIFICATION_EMAIL_USER_ID,
|
|
18171
|
-
KEY_USER_VERIFICATION_EMAIL_USER_VERIFICATION_ID,
|
|
18172
|
-
KEY_USER_VERIFICATION_EMAIL_VERIFIED_ON,
|
|
18173
|
-
] as const satisfies (keyof UserVerificationEmail)[];
|
|
18174
|
-
|
|
18175
|
-
/**
|
|
18176
|
-
* Canceled On
|
|
18177
|
-
*
|
|
18178
|
-
* The date the verification was cancelled
|
|
18179
|
-
*
|
|
18180
|
-
*
|
|
18181
|
-
*
|
|
18182
|
-
* @remarks
|
|
18183
|
-
* This key constant provides type-safe access to the `canceled_on` property of UserVerification objects.
|
|
18184
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
18185
|
-
*
|
|
18186
|
-
* @example
|
|
18187
|
-
* ```typescript
|
|
18188
|
-
* // Direct property access
|
|
18189
|
-
* const value = userverification[KEY_USER_VERIFICATION_CANCELED_ON];
|
|
18190
|
-
*
|
|
18191
|
-
* // Dynamic property access
|
|
18192
|
-
* const propertyName = KEY_USER_VERIFICATION_CANCELED_ON;
|
|
18193
|
-
* const value = userverification[propertyName];
|
|
18194
|
-
* ```
|
|
18195
|
-
*
|
|
18196
|
-
* @see {@link UserVerification} - The TypeScript type definition
|
|
18197
|
-
* @see {@link KEYS_USER_VERIFICATION} - Array of all keys for this type
|
|
18198
|
-
*/
|
|
18199
|
-
export const KEY_USER_VERIFICATION_CANCELED_ON = 'canceled_on' as keyof UserVerification;
|
|
18200
|
-
/**
|
|
18201
|
-
* Created On
|
|
18202
|
-
*
|
|
18203
|
-
* The date/time the entry was created on
|
|
18204
|
-
*
|
|
18205
|
-
* @type {string}
|
|
18206
|
-
*
|
|
18207
|
-
*
|
|
18208
|
-
* @remarks
|
|
18209
|
-
* This key constant provides type-safe access to the `created_on` property of UserVerification objects.
|
|
18210
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
18211
|
-
*
|
|
18212
|
-
* @example
|
|
18213
|
-
* ```typescript
|
|
18214
|
-
* // Direct property access
|
|
18215
|
-
* const value = userverification[KEY_USER_VERIFICATION_CREATED_ON];
|
|
18216
|
-
*
|
|
18217
|
-
* // Dynamic property access
|
|
18218
|
-
* const propertyName = KEY_USER_VERIFICATION_CREATED_ON;
|
|
18219
|
-
* const value = userverification[propertyName];
|
|
18220
|
-
* ```
|
|
18221
|
-
*
|
|
18222
|
-
* @see {@link UserVerification} - The TypeScript type definition
|
|
18223
|
-
* @see {@link KEYS_USER_VERIFICATION} - Array of all keys for this type
|
|
18224
|
-
*/
|
|
18225
|
-
export const KEY_USER_VERIFICATION_CREATED_ON = 'created_on' as keyof UserVerification;
|
|
18226
|
-
/**
|
|
18227
|
-
* status property
|
|
18228
|
-
*
|
|
18229
|
-
* Current status of the email verification
|
|
18230
|
-
*
|
|
18231
|
-
*
|
|
18232
|
-
*
|
|
18233
|
-
* @remarks
|
|
18234
|
-
* This key constant provides type-safe access to the `status` property of UserVerification objects.
|
|
18235
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
18236
|
-
*
|
|
18237
|
-
* @example
|
|
18238
|
-
* ```typescript
|
|
18239
|
-
* // Direct property access
|
|
18240
|
-
* const value = userverification[KEY_USER_VERIFICATION_STATUS];
|
|
18241
|
-
*
|
|
18242
|
-
* // Dynamic property access
|
|
18243
|
-
* const propertyName = KEY_USER_VERIFICATION_STATUS;
|
|
18244
|
-
* const value = userverification[propertyName];
|
|
18245
|
-
* ```
|
|
18246
|
-
*
|
|
18247
|
-
* @see {@link UserVerification} - The TypeScript type definition
|
|
18248
|
-
* @see {@link KEYS_USER_VERIFICATION} - Array of all keys for this type
|
|
18249
|
-
*/
|
|
18250
|
-
export const KEY_USER_VERIFICATION_STATUS = 'status' as keyof UserVerification;
|
|
18251
|
-
/**
|
|
18252
|
-
* type property
|
|
18253
|
-
*
|
|
18254
|
-
* The type of verification: 'api' for retrieving token via API, 'email' for retrieving via email
|
|
18255
|
-
*
|
|
18256
|
-
*
|
|
18257
|
-
*
|
|
18258
|
-
* @remarks
|
|
18259
|
-
* This key constant provides type-safe access to the `type` property of UserVerification objects.
|
|
18260
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
18261
|
-
*
|
|
18262
|
-
* @example
|
|
18263
|
-
* ```typescript
|
|
18264
|
-
* // Direct property access
|
|
18265
|
-
* const value = userverification[KEY_USER_VERIFICATION_TYPE];
|
|
18266
|
-
*
|
|
18267
|
-
* // Dynamic property access
|
|
18268
|
-
* const propertyName = KEY_USER_VERIFICATION_TYPE;
|
|
18269
|
-
* const value = userverification[propertyName];
|
|
18270
|
-
* ```
|
|
18271
|
-
*
|
|
18272
|
-
* @see {@link UserVerification} - The TypeScript type definition
|
|
18273
|
-
* @see {@link KEYS_USER_VERIFICATION} - Array of all keys for this type
|
|
18274
|
-
*/
|
|
18275
|
-
export const KEY_USER_VERIFICATION_TYPE = 'type' as keyof UserVerification;
|
|
18276
|
-
/**
|
|
18277
|
-
* Updated On
|
|
18278
|
-
*
|
|
18279
|
-
* The date/time the entry was last updated on
|
|
18280
|
-
*
|
|
18281
|
-
* @type {string}
|
|
18282
|
-
*
|
|
18283
|
-
*
|
|
18284
|
-
* @remarks
|
|
18285
|
-
* This key constant provides type-safe access to the `updated_on` property of UserVerification objects.
|
|
18286
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
18287
|
-
*
|
|
18288
|
-
* @example
|
|
18289
|
-
* ```typescript
|
|
18290
|
-
* // Direct property access
|
|
18291
|
-
* const value = userverification[KEY_USER_VERIFICATION_UPDATED_ON];
|
|
18292
|
-
*
|
|
18293
|
-
* // Dynamic property access
|
|
18294
|
-
* const propertyName = KEY_USER_VERIFICATION_UPDATED_ON;
|
|
18295
|
-
* const value = userverification[propertyName];
|
|
18296
|
-
* ```
|
|
18297
|
-
*
|
|
18298
|
-
* @see {@link UserVerification} - The TypeScript type definition
|
|
18299
|
-
* @see {@link KEYS_USER_VERIFICATION} - Array of all keys for this type
|
|
18300
|
-
*/
|
|
18301
|
-
export const KEY_USER_VERIFICATION_UPDATED_ON = 'updated_on' as keyof UserVerification;
|
|
18302
|
-
/**
|
|
18303
|
-
* User Id
|
|
18304
|
-
*
|
|
18305
|
-
* The user's id
|
|
18306
|
-
*
|
|
18307
|
-
* @type {string}
|
|
18308
|
-
*
|
|
18309
|
-
*
|
|
18310
|
-
* @remarks
|
|
18311
|
-
* This key constant provides type-safe access to the `user_id` property of UserVerification objects.
|
|
18312
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
18313
|
-
*
|
|
18314
|
-
* @example
|
|
18315
|
-
* ```typescript
|
|
18316
|
-
* // Direct property access
|
|
18317
|
-
* const value = userverification[KEY_USER_VERIFICATION_USER_ID];
|
|
18318
|
-
*
|
|
18319
|
-
* // Dynamic property access
|
|
18320
|
-
* const propertyName = KEY_USER_VERIFICATION_USER_ID;
|
|
18321
|
-
* const value = userverification[propertyName];
|
|
18322
|
-
* ```
|
|
18323
|
-
*
|
|
18324
|
-
* @see {@link UserVerification} - The TypeScript type definition
|
|
18325
|
-
* @see {@link KEYS_USER_VERIFICATION} - Array of all keys for this type
|
|
18326
|
-
*/
|
|
18327
|
-
export const KEY_USER_VERIFICATION_USER_ID = 'user_id' as keyof UserVerification;
|
|
18328
|
-
/**
|
|
18329
|
-
* User Verification Id
|
|
18330
|
-
*
|
|
18331
|
-
*
|
|
18332
|
-
* @type {string}
|
|
18333
|
-
*
|
|
18334
|
-
*
|
|
18335
|
-
* @remarks
|
|
18336
|
-
* This key constant provides type-safe access to the `user_verification_id` property of UserVerification objects.
|
|
18337
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
18338
|
-
*
|
|
18339
|
-
* @example
|
|
18340
|
-
* ```typescript
|
|
18341
|
-
* // Direct property access
|
|
18342
|
-
* const value = userverification[KEY_USER_VERIFICATION_USER_VERIFICATION_ID];
|
|
18343
|
-
*
|
|
18344
|
-
* // Dynamic property access
|
|
18345
|
-
* const propertyName = KEY_USER_VERIFICATION_USER_VERIFICATION_ID;
|
|
18346
|
-
* const value = userverification[propertyName];
|
|
18347
|
-
* ```
|
|
18348
|
-
*
|
|
18349
|
-
* @see {@link UserVerification} - The TypeScript type definition
|
|
18350
|
-
* @see {@link KEYS_USER_VERIFICATION} - Array of all keys for this type
|
|
18351
|
-
*/
|
|
18352
|
-
export const KEY_USER_VERIFICATION_USER_VERIFICATION_ID = 'user_verification_id' as keyof UserVerification;
|
|
18353
|
-
/**
|
|
18354
|
-
* Verified On
|
|
18355
|
-
*
|
|
18356
|
-
* The date the verification was verified
|
|
18357
|
-
*
|
|
18358
|
-
*
|
|
18359
|
-
*
|
|
18360
|
-
* @remarks
|
|
18361
|
-
* This key constant provides type-safe access to the `verified_on` property of UserVerification objects.
|
|
18362
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
18363
|
-
*
|
|
18364
|
-
* @example
|
|
18365
|
-
* ```typescript
|
|
18366
|
-
* // Direct property access
|
|
18367
|
-
* const value = userverification[KEY_USER_VERIFICATION_VERIFIED_ON];
|
|
18368
|
-
*
|
|
18369
|
-
* // Dynamic property access
|
|
18370
|
-
* const propertyName = KEY_USER_VERIFICATION_VERIFIED_ON;
|
|
18371
|
-
* const value = userverification[propertyName];
|
|
18372
|
-
* ```
|
|
18373
|
-
*
|
|
18374
|
-
* @see {@link UserVerification} - The TypeScript type definition
|
|
18375
|
-
* @see {@link KEYS_USER_VERIFICATION} - Array of all keys for this type
|
|
18376
|
-
*/
|
|
18377
|
-
export const KEY_USER_VERIFICATION_VERIFIED_ON = 'verified_on' as keyof UserVerification;
|
|
18378
|
-
|
|
18379
|
-
/**
|
|
18380
|
-
* Array of all UserVerification property keys
|
|
18381
|
-
*
|
|
18382
|
-
* @remarks
|
|
18383
|
-
* This constant provides a readonly array containing all valid property keys for UserVerification objects.
|
|
18384
|
-
* Useful for iteration, validation, and generating dynamic UI components.
|
|
18385
|
-
*
|
|
18386
|
-
* @example
|
|
18387
|
-
* ```typescript
|
|
18388
|
-
* // Iterating through all keys
|
|
18389
|
-
* for (const key of KEYS_USER_VERIFICATION) {
|
|
18390
|
-
* console.log(`Property: ${key}, Value: ${userverification[key]}`);
|
|
18391
|
-
* }
|
|
18392
|
-
*
|
|
18393
|
-
* // Validation
|
|
18394
|
-
* const isValidKey = KEYS_USER_VERIFICATION.includes(someKey);
|
|
18395
|
-
* ```
|
|
18396
|
-
*
|
|
18397
|
-
* @see {@link UserVerification} - The TypeScript type definition
|
|
18398
|
-
*/
|
|
18399
|
-
export const KEYS_USER_VERIFICATION = [
|
|
18400
|
-
KEY_USER_VERIFICATION_CANCELED_ON,
|
|
18401
|
-
KEY_USER_VERIFICATION_CREATED_ON,
|
|
18402
|
-
KEY_USER_VERIFICATION_STATUS,
|
|
18403
|
-
KEY_USER_VERIFICATION_TYPE,
|
|
18404
|
-
KEY_USER_VERIFICATION_UPDATED_ON,
|
|
18405
|
-
KEY_USER_VERIFICATION_USER_ID,
|
|
18406
|
-
KEY_USER_VERIFICATION_USER_VERIFICATION_ID,
|
|
18407
|
-
KEY_USER_VERIFICATION_VERIFIED_ON,
|
|
18408
|
-
] as const satisfies (keyof UserVerification)[];
|
|
18409
|
-
|
|
18410
17598
|
/**
|
|
18411
17599
|
* Created On
|
|
18412
17600
|
*
|