@opusdns/api 0.32.0 → 0.33.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.
@@ -112,6 +112,7 @@ import { OrganizationToken } from './schemas';
112
112
  import { OrganizationUpdate } from './schemas';
113
113
  import { OrganizationWithPlan } from './schemas';
114
114
  import { PaginationMetadata } from './schemas';
115
+ import { PasswordUpdate } from './schemas';
115
116
  import { Period } from './schemas';
116
117
  import { PermissionSet } from './schemas';
117
118
  import { PlanInfo } from './schemas';
@@ -127,6 +128,7 @@ import { RgpOperations } from './schemas';
127
128
  import { SignupCreate } from './schemas';
128
129
  import { SldLength } from './schemas';
129
130
  import { SpiceDbRelationshipUpdate } from './schemas';
131
+ import { StartPasswordReset } from './schemas';
130
132
  import { TermsOfServiceAccept } from './schemas';
131
133
  import { TldBase } from './schemas';
132
134
  import { TldResponseShort } from './schemas';
@@ -138,8 +140,12 @@ import { UserAttributeBase } from './schemas';
138
140
  import { UserCreate } from './schemas';
139
141
  import { UserNotification } from './schemas';
140
142
  import { UserNotificationSummary } from './schemas';
143
+ import { UserPasswordResetEmail } from './schemas';
141
144
  import { UserToken } from './schemas';
142
145
  import { UserUpdate } from './schemas';
146
+ import { UserVerificationApi } from './schemas';
147
+ import { UserVerificationEmail } from './schemas';
148
+ import { UserVerification } from './schemas';
143
149
  import { UserWithAttributes } from './schemas';
144
150
  import { UserWithRelationPermissions } from './schemas';
145
151
  import { ValidationError } from './schemas';
@@ -14062,6 +14068,56 @@ export const KEYS_PAGINATION_METADATA = [
14062
14068
  KEY_PAGINATION_METADATA_TOTAL_PAGES,
14063
14069
  ] as const satisfies (keyof PaginationMetadata)[];
14064
14070
 
14071
+ /**
14072
+ * New Password
14073
+ *
14074
+ *
14075
+ * @type {string}
14076
+ *
14077
+ *
14078
+ * @remarks
14079
+ * This key constant provides type-safe access to the `new_password` property of PasswordUpdate objects.
14080
+ * Use this constant when you need to access properties dynamically or ensure type safety.
14081
+ *
14082
+ * @example
14083
+ * ```typescript
14084
+ * // Direct property access
14085
+ * const value = passwordupdate[KEY_PASSWORD_UPDATE_NEW_PASSWORD];
14086
+ *
14087
+ * // Dynamic property access
14088
+ * const propertyName = KEY_PASSWORD_UPDATE_NEW_PASSWORD;
14089
+ * const value = passwordupdate[propertyName];
14090
+ * ```
14091
+ *
14092
+ * @see {@link PasswordUpdate} - The TypeScript type definition
14093
+ * @see {@link KEYS_PASSWORD_UPDATE} - Array of all keys for this type
14094
+ */
14095
+ export const KEY_PASSWORD_UPDATE_NEW_PASSWORD = 'new_password' as keyof PasswordUpdate;
14096
+
14097
+ /**
14098
+ * Array of all PasswordUpdate property keys
14099
+ *
14100
+ * @remarks
14101
+ * This constant provides a readonly array containing all valid property keys for PasswordUpdate objects.
14102
+ * Useful for iteration, validation, and generating dynamic UI components.
14103
+ *
14104
+ * @example
14105
+ * ```typescript
14106
+ * // Iterating through all keys
14107
+ * for (const key of KEYS_PASSWORD_UPDATE) {
14108
+ * console.log(`Property: ${key}, Value: ${passwordupdate[key]}`);
14109
+ * }
14110
+ *
14111
+ * // Validation
14112
+ * const isValidKey = KEYS_PASSWORD_UPDATE.includes(someKey);
14113
+ * ```
14114
+ *
14115
+ * @see {@link PasswordUpdate} - The TypeScript type definition
14116
+ */
14117
+ export const KEYS_PASSWORD_UPDATE = [
14118
+ KEY_PASSWORD_UPDATE_NEW_PASSWORD,
14119
+ ] as const satisfies (keyof PasswordUpdate)[];
14120
+
14065
14121
  /**
14066
14122
  * unit property
14067
14123
  *
@@ -15467,6 +15523,56 @@ export const KEYS_SPICE_DB_RELATIONSHIP_UPDATE = [
15467
15523
  KEY_SPICE_DB_RELATIONSHIP_UPDATE_REMOVE,
15468
15524
  ] as const satisfies (keyof SpiceDbRelationshipUpdate)[];
15469
15525
 
15526
+ /**
15527
+ * Email
15528
+ *
15529
+ *
15530
+ * @type {string}
15531
+ *
15532
+ *
15533
+ * @remarks
15534
+ * This key constant provides type-safe access to the `email` property of StartPasswordReset objects.
15535
+ * Use this constant when you need to access properties dynamically or ensure type safety.
15536
+ *
15537
+ * @example
15538
+ * ```typescript
15539
+ * // Direct property access
15540
+ * const value = startpasswordreset[KEY_START_PASSWORD_RESET_EMAIL];
15541
+ *
15542
+ * // Dynamic property access
15543
+ * const propertyName = KEY_START_PASSWORD_RESET_EMAIL;
15544
+ * const value = startpasswordreset[propertyName];
15545
+ * ```
15546
+ *
15547
+ * @see {@link StartPasswordReset} - The TypeScript type definition
15548
+ * @see {@link KEYS_START_PASSWORD_RESET} - Array of all keys for this type
15549
+ */
15550
+ export const KEY_START_PASSWORD_RESET_EMAIL = 'email' as keyof StartPasswordReset;
15551
+
15552
+ /**
15553
+ * Array of all StartPasswordReset property keys
15554
+ *
15555
+ * @remarks
15556
+ * This constant provides a readonly array containing all valid property keys for StartPasswordReset objects.
15557
+ * Useful for iteration, validation, and generating dynamic UI components.
15558
+ *
15559
+ * @example
15560
+ * ```typescript
15561
+ * // Iterating through all keys
15562
+ * for (const key of KEYS_START_PASSWORD_RESET) {
15563
+ * console.log(`Property: ${key}, Value: ${startpasswordreset[key]}`);
15564
+ * }
15565
+ *
15566
+ * // Validation
15567
+ * const isValidKey = KEYS_START_PASSWORD_RESET.includes(someKey);
15568
+ * ```
15569
+ *
15570
+ * @see {@link StartPasswordReset} - The TypeScript type definition
15571
+ */
15572
+ export const KEYS_START_PASSWORD_RESET = [
15573
+ KEY_START_PASSWORD_RESET_EMAIL,
15574
+ ] as const satisfies (keyof StartPasswordReset)[];
15575
+
15470
15576
  /**
15471
15577
  * Accepted
15472
15578
  *
@@ -17595,6 +17701,57 @@ export const KEYS_USER_NOTIFICATION_SUMMARY = [
17595
17701
  KEY_USER_NOTIFICATION_SUMMARY_USER_NOTIFICATION_ID,
17596
17702
  ] as const satisfies (keyof UserNotificationSummary)[];
17597
17703
 
17704
+ /**
17705
+ * Message
17706
+ *
17707
+ * Message to the user. This message is always displayed regarding the password reset process to prevent leaking information.
17708
+ *
17709
+ * @type {string}
17710
+ *
17711
+ *
17712
+ * @remarks
17713
+ * This key constant provides type-safe access to the `message` property of UserPasswordResetEmail objects.
17714
+ * Use this constant when you need to access properties dynamically or ensure type safety.
17715
+ *
17716
+ * @example
17717
+ * ```typescript
17718
+ * // Direct property access
17719
+ * const value = userpasswordresetemail[KEY_USER_PASSWORD_RESET_EMAIL_MESSAGE];
17720
+ *
17721
+ * // Dynamic property access
17722
+ * const propertyName = KEY_USER_PASSWORD_RESET_EMAIL_MESSAGE;
17723
+ * const value = userpasswordresetemail[propertyName];
17724
+ * ```
17725
+ *
17726
+ * @see {@link UserPasswordResetEmail} - The TypeScript type definition
17727
+ * @see {@link KEYS_USER_PASSWORD_RESET_EMAIL} - Array of all keys for this type
17728
+ */
17729
+ export const KEY_USER_PASSWORD_RESET_EMAIL_MESSAGE = 'message' as keyof UserPasswordResetEmail;
17730
+
17731
+ /**
17732
+ * Array of all UserPasswordResetEmail property keys
17733
+ *
17734
+ * @remarks
17735
+ * This constant provides a readonly array containing all valid property keys for UserPasswordResetEmail objects.
17736
+ * Useful for iteration, validation, and generating dynamic UI components.
17737
+ *
17738
+ * @example
17739
+ * ```typescript
17740
+ * // Iterating through all keys
17741
+ * for (const key of KEYS_USER_PASSWORD_RESET_EMAIL) {
17742
+ * console.log(`Property: ${key}, Value: ${userpasswordresetemail[key]}`);
17743
+ * }
17744
+ *
17745
+ * // Validation
17746
+ * const isValidKey = KEYS_USER_PASSWORD_RESET_EMAIL.includes(someKey);
17747
+ * ```
17748
+ *
17749
+ * @see {@link UserPasswordResetEmail} - The TypeScript type definition
17750
+ */
17751
+ export const KEYS_USER_PASSWORD_RESET_EMAIL = [
17752
+ KEY_USER_PASSWORD_RESET_EMAIL_MESSAGE,
17753
+ ] as const satisfies (keyof UserPasswordResetEmail)[];
17754
+
17598
17755
  /**
17599
17756
  * Access Token
17600
17757
  *
@@ -17955,6 +18112,738 @@ export const KEYS_USER_UPDATE = [
17955
18112
  KEY_USER_UPDATE_USERNAME,
17956
18113
  ] as const satisfies (keyof UserUpdate)[];
17957
18114
 
18115
+ /**
18116
+ * Canceled On
18117
+ *
18118
+ * The date the verification was cancelled
18119
+ *
18120
+ *
18121
+ *
18122
+ * @remarks
18123
+ * This key constant provides type-safe access to the `canceled_on` property of UserVerificationApi objects.
18124
+ * Use this constant when you need to access properties dynamically or ensure type safety.
18125
+ *
18126
+ * @example
18127
+ * ```typescript
18128
+ * // Direct property access
18129
+ * const value = userverificationapi[KEY_USER_VERIFICATION_API_CANCELED_ON];
18130
+ *
18131
+ * // Dynamic property access
18132
+ * const propertyName = KEY_USER_VERIFICATION_API_CANCELED_ON;
18133
+ * const value = userverificationapi[propertyName];
18134
+ * ```
18135
+ *
18136
+ * @see {@link UserVerificationApi} - The TypeScript type definition
18137
+ * @see {@link KEYS_USER_VERIFICATION_API} - Array of all keys for this type
18138
+ */
18139
+ export const KEY_USER_VERIFICATION_API_CANCELED_ON = 'canceled_on' as keyof UserVerificationApi;
18140
+ /**
18141
+ * Created On
18142
+ *
18143
+ * The date/time the entry was created on
18144
+ *
18145
+ * @type {string}
18146
+ *
18147
+ *
18148
+ * @remarks
18149
+ * This key constant provides type-safe access to the `created_on` property of UserVerificationApi objects.
18150
+ * Use this constant when you need to access properties dynamically or ensure type safety.
18151
+ *
18152
+ * @example
18153
+ * ```typescript
18154
+ * // Direct property access
18155
+ * const value = userverificationapi[KEY_USER_VERIFICATION_API_CREATED_ON];
18156
+ *
18157
+ * // Dynamic property access
18158
+ * const propertyName = KEY_USER_VERIFICATION_API_CREATED_ON;
18159
+ * const value = userverificationapi[propertyName];
18160
+ * ```
18161
+ *
18162
+ * @see {@link UserVerificationApi} - The TypeScript type definition
18163
+ * @see {@link KEYS_USER_VERIFICATION_API} - Array of all keys for this type
18164
+ */
18165
+ export const KEY_USER_VERIFICATION_API_CREATED_ON = 'created_on' as keyof UserVerificationApi;
18166
+ /**
18167
+ * status property
18168
+ *
18169
+ * Current status of the email verification
18170
+ *
18171
+ *
18172
+ *
18173
+ * @remarks
18174
+ * This key constant provides type-safe access to the `status` property of UserVerificationApi objects.
18175
+ * Use this constant when you need to access properties dynamically or ensure type safety.
18176
+ *
18177
+ * @example
18178
+ * ```typescript
18179
+ * // Direct property access
18180
+ * const value = userverificationapi[KEY_USER_VERIFICATION_API_STATUS];
18181
+ *
18182
+ * // Dynamic property access
18183
+ * const propertyName = KEY_USER_VERIFICATION_API_STATUS;
18184
+ * const value = userverificationapi[propertyName];
18185
+ * ```
18186
+ *
18187
+ * @see {@link UserVerificationApi} - The TypeScript type definition
18188
+ * @see {@link KEYS_USER_VERIFICATION_API} - Array of all keys for this type
18189
+ */
18190
+ export const KEY_USER_VERIFICATION_API_STATUS = 'status' as keyof UserVerificationApi;
18191
+ /**
18192
+ * Token
18193
+ *
18194
+ * The token to verify the email address
18195
+ *
18196
+ * @type {string}
18197
+ *
18198
+ *
18199
+ * @remarks
18200
+ * This key constant provides type-safe access to the `token` property of UserVerificationApi objects.
18201
+ * Use this constant when you need to access properties dynamically or ensure type safety.
18202
+ *
18203
+ * @example
18204
+ * ```typescript
18205
+ * // Direct property access
18206
+ * const value = userverificationapi[KEY_USER_VERIFICATION_API_TOKEN];
18207
+ *
18208
+ * // Dynamic property access
18209
+ * const propertyName = KEY_USER_VERIFICATION_API_TOKEN;
18210
+ * const value = userverificationapi[propertyName];
18211
+ * ```
18212
+ *
18213
+ * @see {@link UserVerificationApi} - The TypeScript type definition
18214
+ * @see {@link KEYS_USER_VERIFICATION_API} - Array of all keys for this type
18215
+ */
18216
+ export const KEY_USER_VERIFICATION_API_TOKEN = 'token' as keyof UserVerificationApi;
18217
+ /**
18218
+ * type property
18219
+ *
18220
+ * The type of verification: 'api' for retrieving token via API, 'email' for retrieving via email
18221
+ *
18222
+ *
18223
+ *
18224
+ * @remarks
18225
+ * This key constant provides type-safe access to the `type` property of UserVerificationApi objects.
18226
+ * Use this constant when you need to access properties dynamically or ensure type safety.
18227
+ *
18228
+ * @example
18229
+ * ```typescript
18230
+ * // Direct property access
18231
+ * const value = userverificationapi[KEY_USER_VERIFICATION_API_TYPE];
18232
+ *
18233
+ * // Dynamic property access
18234
+ * const propertyName = KEY_USER_VERIFICATION_API_TYPE;
18235
+ * const value = userverificationapi[propertyName];
18236
+ * ```
18237
+ *
18238
+ * @see {@link UserVerificationApi} - The TypeScript type definition
18239
+ * @see {@link KEYS_USER_VERIFICATION_API} - Array of all keys for this type
18240
+ */
18241
+ export const KEY_USER_VERIFICATION_API_TYPE = 'type' as keyof UserVerificationApi;
18242
+ /**
18243
+ * Updated On
18244
+ *
18245
+ * The date/time the entry was last updated on
18246
+ *
18247
+ * @type {string}
18248
+ *
18249
+ *
18250
+ * @remarks
18251
+ * This key constant provides type-safe access to the `updated_on` property of UserVerificationApi objects.
18252
+ * Use this constant when you need to access properties dynamically or ensure type safety.
18253
+ *
18254
+ * @example
18255
+ * ```typescript
18256
+ * // Direct property access
18257
+ * const value = userverificationapi[KEY_USER_VERIFICATION_API_UPDATED_ON];
18258
+ *
18259
+ * // Dynamic property access
18260
+ * const propertyName = KEY_USER_VERIFICATION_API_UPDATED_ON;
18261
+ * const value = userverificationapi[propertyName];
18262
+ * ```
18263
+ *
18264
+ * @see {@link UserVerificationApi} - The TypeScript type definition
18265
+ * @see {@link KEYS_USER_VERIFICATION_API} - Array of all keys for this type
18266
+ */
18267
+ export const KEY_USER_VERIFICATION_API_UPDATED_ON = 'updated_on' as keyof UserVerificationApi;
18268
+ /**
18269
+ * User Id
18270
+ *
18271
+ * The user's id
18272
+ *
18273
+ * @type {string}
18274
+ *
18275
+ *
18276
+ * @remarks
18277
+ * This key constant provides type-safe access to the `user_id` property of UserVerificationApi objects.
18278
+ * Use this constant when you need to access properties dynamically or ensure type safety.
18279
+ *
18280
+ * @example
18281
+ * ```typescript
18282
+ * // Direct property access
18283
+ * const value = userverificationapi[KEY_USER_VERIFICATION_API_USER_ID];
18284
+ *
18285
+ * // Dynamic property access
18286
+ * const propertyName = KEY_USER_VERIFICATION_API_USER_ID;
18287
+ * const value = userverificationapi[propertyName];
18288
+ * ```
18289
+ *
18290
+ * @see {@link UserVerificationApi} - The TypeScript type definition
18291
+ * @see {@link KEYS_USER_VERIFICATION_API} - Array of all keys for this type
18292
+ */
18293
+ export const KEY_USER_VERIFICATION_API_USER_ID = 'user_id' as keyof UserVerificationApi;
18294
+ /**
18295
+ * User Verification Id
18296
+ *
18297
+ *
18298
+ * @type {string}
18299
+ *
18300
+ *
18301
+ * @remarks
18302
+ * This key constant provides type-safe access to the `user_verification_id` property of UserVerificationApi objects.
18303
+ * Use this constant when you need to access properties dynamically or ensure type safety.
18304
+ *
18305
+ * @example
18306
+ * ```typescript
18307
+ * // Direct property access
18308
+ * const value = userverificationapi[KEY_USER_VERIFICATION_API_USER_VERIFICATION_ID];
18309
+ *
18310
+ * // Dynamic property access
18311
+ * const propertyName = KEY_USER_VERIFICATION_API_USER_VERIFICATION_ID;
18312
+ * const value = userverificationapi[propertyName];
18313
+ * ```
18314
+ *
18315
+ * @see {@link UserVerificationApi} - The TypeScript type definition
18316
+ * @see {@link KEYS_USER_VERIFICATION_API} - Array of all keys for this type
18317
+ */
18318
+ export const KEY_USER_VERIFICATION_API_USER_VERIFICATION_ID = 'user_verification_id' as keyof UserVerificationApi;
18319
+ /**
18320
+ * Verified On
18321
+ *
18322
+ * The date the verification was verified
18323
+ *
18324
+ *
18325
+ *
18326
+ * @remarks
18327
+ * This key constant provides type-safe access to the `verified_on` property of UserVerificationApi objects.
18328
+ * Use this constant when you need to access properties dynamically or ensure type safety.
18329
+ *
18330
+ * @example
18331
+ * ```typescript
18332
+ * // Direct property access
18333
+ * const value = userverificationapi[KEY_USER_VERIFICATION_API_VERIFIED_ON];
18334
+ *
18335
+ * // Dynamic property access
18336
+ * const propertyName = KEY_USER_VERIFICATION_API_VERIFIED_ON;
18337
+ * const value = userverificationapi[propertyName];
18338
+ * ```
18339
+ *
18340
+ * @see {@link UserVerificationApi} - The TypeScript type definition
18341
+ * @see {@link KEYS_USER_VERIFICATION_API} - Array of all keys for this type
18342
+ */
18343
+ export const KEY_USER_VERIFICATION_API_VERIFIED_ON = 'verified_on' as keyof UserVerificationApi;
18344
+
18345
+ /**
18346
+ * Array of all UserVerificationApi property keys
18347
+ *
18348
+ * @remarks
18349
+ * This constant provides a readonly array containing all valid property keys for UserVerificationApi objects.
18350
+ * Useful for iteration, validation, and generating dynamic UI components.
18351
+ *
18352
+ * @example
18353
+ * ```typescript
18354
+ * // Iterating through all keys
18355
+ * for (const key of KEYS_USER_VERIFICATION_API) {
18356
+ * console.log(`Property: ${key}, Value: ${userverificationapi[key]}`);
18357
+ * }
18358
+ *
18359
+ * // Validation
18360
+ * const isValidKey = KEYS_USER_VERIFICATION_API.includes(someKey);
18361
+ * ```
18362
+ *
18363
+ * @see {@link UserVerificationApi} - The TypeScript type definition
18364
+ */
18365
+ export const KEYS_USER_VERIFICATION_API = [
18366
+ KEY_USER_VERIFICATION_API_CANCELED_ON,
18367
+ KEY_USER_VERIFICATION_API_CREATED_ON,
18368
+ KEY_USER_VERIFICATION_API_STATUS,
18369
+ KEY_USER_VERIFICATION_API_TOKEN,
18370
+ KEY_USER_VERIFICATION_API_TYPE,
18371
+ KEY_USER_VERIFICATION_API_UPDATED_ON,
18372
+ KEY_USER_VERIFICATION_API_USER_ID,
18373
+ KEY_USER_VERIFICATION_API_USER_VERIFICATION_ID,
18374
+ KEY_USER_VERIFICATION_API_VERIFIED_ON,
18375
+ ] as const satisfies (keyof UserVerificationApi)[];
18376
+
18377
+ /**
18378
+ * Canceled On
18379
+ *
18380
+ * The date the verification was cancelled
18381
+ *
18382
+ *
18383
+ *
18384
+ * @remarks
18385
+ * This key constant provides type-safe access to the `canceled_on` property of UserVerificationEmail objects.
18386
+ * Use this constant when you need to access properties dynamically or ensure type safety.
18387
+ *
18388
+ * @example
18389
+ * ```typescript
18390
+ * // Direct property access
18391
+ * const value = userverificationemail[KEY_USER_VERIFICATION_EMAIL_CANCELED_ON];
18392
+ *
18393
+ * // Dynamic property access
18394
+ * const propertyName = KEY_USER_VERIFICATION_EMAIL_CANCELED_ON;
18395
+ * const value = userverificationemail[propertyName];
18396
+ * ```
18397
+ *
18398
+ * @see {@link UserVerificationEmail} - The TypeScript type definition
18399
+ * @see {@link KEYS_USER_VERIFICATION_EMAIL} - Array of all keys for this type
18400
+ */
18401
+ export const KEY_USER_VERIFICATION_EMAIL_CANCELED_ON = 'canceled_on' as keyof UserVerificationEmail;
18402
+ /**
18403
+ * Created On
18404
+ *
18405
+ * The date/time the entry was created on
18406
+ *
18407
+ * @type {string}
18408
+ *
18409
+ *
18410
+ * @remarks
18411
+ * This key constant provides type-safe access to the `created_on` property of UserVerificationEmail objects.
18412
+ * Use this constant when you need to access properties dynamically or ensure type safety.
18413
+ *
18414
+ * @example
18415
+ * ```typescript
18416
+ * // Direct property access
18417
+ * const value = userverificationemail[KEY_USER_VERIFICATION_EMAIL_CREATED_ON];
18418
+ *
18419
+ * // Dynamic property access
18420
+ * const propertyName = KEY_USER_VERIFICATION_EMAIL_CREATED_ON;
18421
+ * const value = userverificationemail[propertyName];
18422
+ * ```
18423
+ *
18424
+ * @see {@link UserVerificationEmail} - The TypeScript type definition
18425
+ * @see {@link KEYS_USER_VERIFICATION_EMAIL} - Array of all keys for this type
18426
+ */
18427
+ export const KEY_USER_VERIFICATION_EMAIL_CREATED_ON = 'created_on' as keyof UserVerificationEmail;
18428
+ /**
18429
+ * status property
18430
+ *
18431
+ * Current status of the email verification
18432
+ *
18433
+ *
18434
+ *
18435
+ * @remarks
18436
+ * This key constant provides type-safe access to the `status` property of UserVerificationEmail objects.
18437
+ * Use this constant when you need to access properties dynamically or ensure type safety.
18438
+ *
18439
+ * @example
18440
+ * ```typescript
18441
+ * // Direct property access
18442
+ * const value = userverificationemail[KEY_USER_VERIFICATION_EMAIL_STATUS];
18443
+ *
18444
+ * // Dynamic property access
18445
+ * const propertyName = KEY_USER_VERIFICATION_EMAIL_STATUS;
18446
+ * const value = userverificationemail[propertyName];
18447
+ * ```
18448
+ *
18449
+ * @see {@link UserVerificationEmail} - The TypeScript type definition
18450
+ * @see {@link KEYS_USER_VERIFICATION_EMAIL} - Array of all keys for this type
18451
+ */
18452
+ export const KEY_USER_VERIFICATION_EMAIL_STATUS = 'status' as keyof UserVerificationEmail;
18453
+ /**
18454
+ * type property
18455
+ *
18456
+ * The type of verification: 'api' for retrieving token via API, 'email' for retrieving via email
18457
+ *
18458
+ *
18459
+ *
18460
+ * @remarks
18461
+ * This key constant provides type-safe access to the `type` property of UserVerificationEmail objects.
18462
+ * Use this constant when you need to access properties dynamically or ensure type safety.
18463
+ *
18464
+ * @example
18465
+ * ```typescript
18466
+ * // Direct property access
18467
+ * const value = userverificationemail[KEY_USER_VERIFICATION_EMAIL_TYPE];
18468
+ *
18469
+ * // Dynamic property access
18470
+ * const propertyName = KEY_USER_VERIFICATION_EMAIL_TYPE;
18471
+ * const value = userverificationemail[propertyName];
18472
+ * ```
18473
+ *
18474
+ * @see {@link UserVerificationEmail} - The TypeScript type definition
18475
+ * @see {@link KEYS_USER_VERIFICATION_EMAIL} - Array of all keys for this type
18476
+ */
18477
+ export const KEY_USER_VERIFICATION_EMAIL_TYPE = 'type' as keyof UserVerificationEmail;
18478
+ /**
18479
+ * Updated On
18480
+ *
18481
+ * The date/time the entry was last updated on
18482
+ *
18483
+ * @type {string}
18484
+ *
18485
+ *
18486
+ * @remarks
18487
+ * This key constant provides type-safe access to the `updated_on` property of UserVerificationEmail objects.
18488
+ * Use this constant when you need to access properties dynamically or ensure type safety.
18489
+ *
18490
+ * @example
18491
+ * ```typescript
18492
+ * // Direct property access
18493
+ * const value = userverificationemail[KEY_USER_VERIFICATION_EMAIL_UPDATED_ON];
18494
+ *
18495
+ * // Dynamic property access
18496
+ * const propertyName = KEY_USER_VERIFICATION_EMAIL_UPDATED_ON;
18497
+ * const value = userverificationemail[propertyName];
18498
+ * ```
18499
+ *
18500
+ * @see {@link UserVerificationEmail} - The TypeScript type definition
18501
+ * @see {@link KEYS_USER_VERIFICATION_EMAIL} - Array of all keys for this type
18502
+ */
18503
+ export const KEY_USER_VERIFICATION_EMAIL_UPDATED_ON = 'updated_on' as keyof UserVerificationEmail;
18504
+ /**
18505
+ * User Id
18506
+ *
18507
+ * The user's id
18508
+ *
18509
+ * @type {string}
18510
+ *
18511
+ *
18512
+ * @remarks
18513
+ * This key constant provides type-safe access to the `user_id` property of UserVerificationEmail objects.
18514
+ * Use this constant when you need to access properties dynamically or ensure type safety.
18515
+ *
18516
+ * @example
18517
+ * ```typescript
18518
+ * // Direct property access
18519
+ * const value = userverificationemail[KEY_USER_VERIFICATION_EMAIL_USER_ID];
18520
+ *
18521
+ * // Dynamic property access
18522
+ * const propertyName = KEY_USER_VERIFICATION_EMAIL_USER_ID;
18523
+ * const value = userverificationemail[propertyName];
18524
+ * ```
18525
+ *
18526
+ * @see {@link UserVerificationEmail} - The TypeScript type definition
18527
+ * @see {@link KEYS_USER_VERIFICATION_EMAIL} - Array of all keys for this type
18528
+ */
18529
+ export const KEY_USER_VERIFICATION_EMAIL_USER_ID = 'user_id' as keyof UserVerificationEmail;
18530
+ /**
18531
+ * User Verification Id
18532
+ *
18533
+ *
18534
+ * @type {string}
18535
+ *
18536
+ *
18537
+ * @remarks
18538
+ * This key constant provides type-safe access to the `user_verification_id` property of UserVerificationEmail objects.
18539
+ * Use this constant when you need to access properties dynamically or ensure type safety.
18540
+ *
18541
+ * @example
18542
+ * ```typescript
18543
+ * // Direct property access
18544
+ * const value = userverificationemail[KEY_USER_VERIFICATION_EMAIL_USER_VERIFICATION_ID];
18545
+ *
18546
+ * // Dynamic property access
18547
+ * const propertyName = KEY_USER_VERIFICATION_EMAIL_USER_VERIFICATION_ID;
18548
+ * const value = userverificationemail[propertyName];
18549
+ * ```
18550
+ *
18551
+ * @see {@link UserVerificationEmail} - The TypeScript type definition
18552
+ * @see {@link KEYS_USER_VERIFICATION_EMAIL} - Array of all keys for this type
18553
+ */
18554
+ export const KEY_USER_VERIFICATION_EMAIL_USER_VERIFICATION_ID = 'user_verification_id' as keyof UserVerificationEmail;
18555
+ /**
18556
+ * Verified On
18557
+ *
18558
+ * The date the verification was verified
18559
+ *
18560
+ *
18561
+ *
18562
+ * @remarks
18563
+ * This key constant provides type-safe access to the `verified_on` property of UserVerificationEmail objects.
18564
+ * Use this constant when you need to access properties dynamically or ensure type safety.
18565
+ *
18566
+ * @example
18567
+ * ```typescript
18568
+ * // Direct property access
18569
+ * const value = userverificationemail[KEY_USER_VERIFICATION_EMAIL_VERIFIED_ON];
18570
+ *
18571
+ * // Dynamic property access
18572
+ * const propertyName = KEY_USER_VERIFICATION_EMAIL_VERIFIED_ON;
18573
+ * const value = userverificationemail[propertyName];
18574
+ * ```
18575
+ *
18576
+ * @see {@link UserVerificationEmail} - The TypeScript type definition
18577
+ * @see {@link KEYS_USER_VERIFICATION_EMAIL} - Array of all keys for this type
18578
+ */
18579
+ export const KEY_USER_VERIFICATION_EMAIL_VERIFIED_ON = 'verified_on' as keyof UserVerificationEmail;
18580
+
18581
+ /**
18582
+ * Array of all UserVerificationEmail property keys
18583
+ *
18584
+ * @remarks
18585
+ * This constant provides a readonly array containing all valid property keys for UserVerificationEmail objects.
18586
+ * Useful for iteration, validation, and generating dynamic UI components.
18587
+ *
18588
+ * @example
18589
+ * ```typescript
18590
+ * // Iterating through all keys
18591
+ * for (const key of KEYS_USER_VERIFICATION_EMAIL) {
18592
+ * console.log(`Property: ${key}, Value: ${userverificationemail[key]}`);
18593
+ * }
18594
+ *
18595
+ * // Validation
18596
+ * const isValidKey = KEYS_USER_VERIFICATION_EMAIL.includes(someKey);
18597
+ * ```
18598
+ *
18599
+ * @see {@link UserVerificationEmail} - The TypeScript type definition
18600
+ */
18601
+ export const KEYS_USER_VERIFICATION_EMAIL = [
18602
+ KEY_USER_VERIFICATION_EMAIL_CANCELED_ON,
18603
+ KEY_USER_VERIFICATION_EMAIL_CREATED_ON,
18604
+ KEY_USER_VERIFICATION_EMAIL_STATUS,
18605
+ KEY_USER_VERIFICATION_EMAIL_TYPE,
18606
+ KEY_USER_VERIFICATION_EMAIL_UPDATED_ON,
18607
+ KEY_USER_VERIFICATION_EMAIL_USER_ID,
18608
+ KEY_USER_VERIFICATION_EMAIL_USER_VERIFICATION_ID,
18609
+ KEY_USER_VERIFICATION_EMAIL_VERIFIED_ON,
18610
+ ] as const satisfies (keyof UserVerificationEmail)[];
18611
+
18612
+ /**
18613
+ * Canceled On
18614
+ *
18615
+ * The date the verification was cancelled
18616
+ *
18617
+ *
18618
+ *
18619
+ * @remarks
18620
+ * This key constant provides type-safe access to the `canceled_on` property of UserVerification objects.
18621
+ * Use this constant when you need to access properties dynamically or ensure type safety.
18622
+ *
18623
+ * @example
18624
+ * ```typescript
18625
+ * // Direct property access
18626
+ * const value = userverification[KEY_USER_VERIFICATION_CANCELED_ON];
18627
+ *
18628
+ * // Dynamic property access
18629
+ * const propertyName = KEY_USER_VERIFICATION_CANCELED_ON;
18630
+ * const value = userverification[propertyName];
18631
+ * ```
18632
+ *
18633
+ * @see {@link UserVerification} - The TypeScript type definition
18634
+ * @see {@link KEYS_USER_VERIFICATION} - Array of all keys for this type
18635
+ */
18636
+ export const KEY_USER_VERIFICATION_CANCELED_ON = 'canceled_on' as keyof UserVerification;
18637
+ /**
18638
+ * Created On
18639
+ *
18640
+ * The date/time the entry was created on
18641
+ *
18642
+ * @type {string}
18643
+ *
18644
+ *
18645
+ * @remarks
18646
+ * This key constant provides type-safe access to the `created_on` property of UserVerification objects.
18647
+ * Use this constant when you need to access properties dynamically or ensure type safety.
18648
+ *
18649
+ * @example
18650
+ * ```typescript
18651
+ * // Direct property access
18652
+ * const value = userverification[KEY_USER_VERIFICATION_CREATED_ON];
18653
+ *
18654
+ * // Dynamic property access
18655
+ * const propertyName = KEY_USER_VERIFICATION_CREATED_ON;
18656
+ * const value = userverification[propertyName];
18657
+ * ```
18658
+ *
18659
+ * @see {@link UserVerification} - The TypeScript type definition
18660
+ * @see {@link KEYS_USER_VERIFICATION} - Array of all keys for this type
18661
+ */
18662
+ export const KEY_USER_VERIFICATION_CREATED_ON = 'created_on' as keyof UserVerification;
18663
+ /**
18664
+ * status property
18665
+ *
18666
+ * Current status of the email verification
18667
+ *
18668
+ *
18669
+ *
18670
+ * @remarks
18671
+ * This key constant provides type-safe access to the `status` property of UserVerification objects.
18672
+ * Use this constant when you need to access properties dynamically or ensure type safety.
18673
+ *
18674
+ * @example
18675
+ * ```typescript
18676
+ * // Direct property access
18677
+ * const value = userverification[KEY_USER_VERIFICATION_STATUS];
18678
+ *
18679
+ * // Dynamic property access
18680
+ * const propertyName = KEY_USER_VERIFICATION_STATUS;
18681
+ * const value = userverification[propertyName];
18682
+ * ```
18683
+ *
18684
+ * @see {@link UserVerification} - The TypeScript type definition
18685
+ * @see {@link KEYS_USER_VERIFICATION} - Array of all keys for this type
18686
+ */
18687
+ export const KEY_USER_VERIFICATION_STATUS = 'status' as keyof UserVerification;
18688
+ /**
18689
+ * type property
18690
+ *
18691
+ * The type of verification: 'api' for retrieving token via API, 'email' for retrieving via email
18692
+ *
18693
+ *
18694
+ *
18695
+ * @remarks
18696
+ * This key constant provides type-safe access to the `type` property of UserVerification objects.
18697
+ * Use this constant when you need to access properties dynamically or ensure type safety.
18698
+ *
18699
+ * @example
18700
+ * ```typescript
18701
+ * // Direct property access
18702
+ * const value = userverification[KEY_USER_VERIFICATION_TYPE];
18703
+ *
18704
+ * // Dynamic property access
18705
+ * const propertyName = KEY_USER_VERIFICATION_TYPE;
18706
+ * const value = userverification[propertyName];
18707
+ * ```
18708
+ *
18709
+ * @see {@link UserVerification} - The TypeScript type definition
18710
+ * @see {@link KEYS_USER_VERIFICATION} - Array of all keys for this type
18711
+ */
18712
+ export const KEY_USER_VERIFICATION_TYPE = 'type' as keyof UserVerification;
18713
+ /**
18714
+ * Updated On
18715
+ *
18716
+ * The date/time the entry was last updated on
18717
+ *
18718
+ * @type {string}
18719
+ *
18720
+ *
18721
+ * @remarks
18722
+ * This key constant provides type-safe access to the `updated_on` property of UserVerification objects.
18723
+ * Use this constant when you need to access properties dynamically or ensure type safety.
18724
+ *
18725
+ * @example
18726
+ * ```typescript
18727
+ * // Direct property access
18728
+ * const value = userverification[KEY_USER_VERIFICATION_UPDATED_ON];
18729
+ *
18730
+ * // Dynamic property access
18731
+ * const propertyName = KEY_USER_VERIFICATION_UPDATED_ON;
18732
+ * const value = userverification[propertyName];
18733
+ * ```
18734
+ *
18735
+ * @see {@link UserVerification} - The TypeScript type definition
18736
+ * @see {@link KEYS_USER_VERIFICATION} - Array of all keys for this type
18737
+ */
18738
+ export const KEY_USER_VERIFICATION_UPDATED_ON = 'updated_on' as keyof UserVerification;
18739
+ /**
18740
+ * User Id
18741
+ *
18742
+ * The user's id
18743
+ *
18744
+ * @type {string}
18745
+ *
18746
+ *
18747
+ * @remarks
18748
+ * This key constant provides type-safe access to the `user_id` property of UserVerification objects.
18749
+ * Use this constant when you need to access properties dynamically or ensure type safety.
18750
+ *
18751
+ * @example
18752
+ * ```typescript
18753
+ * // Direct property access
18754
+ * const value = userverification[KEY_USER_VERIFICATION_USER_ID];
18755
+ *
18756
+ * // Dynamic property access
18757
+ * const propertyName = KEY_USER_VERIFICATION_USER_ID;
18758
+ * const value = userverification[propertyName];
18759
+ * ```
18760
+ *
18761
+ * @see {@link UserVerification} - The TypeScript type definition
18762
+ * @see {@link KEYS_USER_VERIFICATION} - Array of all keys for this type
18763
+ */
18764
+ export const KEY_USER_VERIFICATION_USER_ID = 'user_id' as keyof UserVerification;
18765
+ /**
18766
+ * User Verification Id
18767
+ *
18768
+ *
18769
+ * @type {string}
18770
+ *
18771
+ *
18772
+ * @remarks
18773
+ * This key constant provides type-safe access to the `user_verification_id` property of UserVerification objects.
18774
+ * Use this constant when you need to access properties dynamically or ensure type safety.
18775
+ *
18776
+ * @example
18777
+ * ```typescript
18778
+ * // Direct property access
18779
+ * const value = userverification[KEY_USER_VERIFICATION_USER_VERIFICATION_ID];
18780
+ *
18781
+ * // Dynamic property access
18782
+ * const propertyName = KEY_USER_VERIFICATION_USER_VERIFICATION_ID;
18783
+ * const value = userverification[propertyName];
18784
+ * ```
18785
+ *
18786
+ * @see {@link UserVerification} - The TypeScript type definition
18787
+ * @see {@link KEYS_USER_VERIFICATION} - Array of all keys for this type
18788
+ */
18789
+ export const KEY_USER_VERIFICATION_USER_VERIFICATION_ID = 'user_verification_id' as keyof UserVerification;
18790
+ /**
18791
+ * Verified On
18792
+ *
18793
+ * The date the verification was verified
18794
+ *
18795
+ *
18796
+ *
18797
+ * @remarks
18798
+ * This key constant provides type-safe access to the `verified_on` property of UserVerification objects.
18799
+ * Use this constant when you need to access properties dynamically or ensure type safety.
18800
+ *
18801
+ * @example
18802
+ * ```typescript
18803
+ * // Direct property access
18804
+ * const value = userverification[KEY_USER_VERIFICATION_VERIFIED_ON];
18805
+ *
18806
+ * // Dynamic property access
18807
+ * const propertyName = KEY_USER_VERIFICATION_VERIFIED_ON;
18808
+ * const value = userverification[propertyName];
18809
+ * ```
18810
+ *
18811
+ * @see {@link UserVerification} - The TypeScript type definition
18812
+ * @see {@link KEYS_USER_VERIFICATION} - Array of all keys for this type
18813
+ */
18814
+ export const KEY_USER_VERIFICATION_VERIFIED_ON = 'verified_on' as keyof UserVerification;
18815
+
18816
+ /**
18817
+ * Array of all UserVerification property keys
18818
+ *
18819
+ * @remarks
18820
+ * This constant provides a readonly array containing all valid property keys for UserVerification objects.
18821
+ * Useful for iteration, validation, and generating dynamic UI components.
18822
+ *
18823
+ * @example
18824
+ * ```typescript
18825
+ * // Iterating through all keys
18826
+ * for (const key of KEYS_USER_VERIFICATION) {
18827
+ * console.log(`Property: ${key}, Value: ${userverification[key]}`);
18828
+ * }
18829
+ *
18830
+ * // Validation
18831
+ * const isValidKey = KEYS_USER_VERIFICATION.includes(someKey);
18832
+ * ```
18833
+ *
18834
+ * @see {@link UserVerification} - The TypeScript type definition
18835
+ */
18836
+ export const KEYS_USER_VERIFICATION = [
18837
+ KEY_USER_VERIFICATION_CANCELED_ON,
18838
+ KEY_USER_VERIFICATION_CREATED_ON,
18839
+ KEY_USER_VERIFICATION_STATUS,
18840
+ KEY_USER_VERIFICATION_TYPE,
18841
+ KEY_USER_VERIFICATION_UPDATED_ON,
18842
+ KEY_USER_VERIFICATION_USER_ID,
18843
+ KEY_USER_VERIFICATION_USER_VERIFICATION_ID,
18844
+ KEY_USER_VERIFICATION_VERIFIED_ON,
18845
+ ] as const satisfies (keyof UserVerification)[];
18846
+
17958
18847
  /**
17959
18848
  * Created On
17960
18849
  *