@opusdns/api 0.290.0 → 0.292.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/constants.ts +153 -1
- package/src/helpers/keys.ts +565 -291
- package/src/helpers/responses.d.ts +3 -3
- package/src/helpers/schemas-arrays.d.ts +43 -1
- package/src/helpers/schemas.d.ts +144 -16
- package/src/openapi.yaml +147 -102
- package/src/schema.d.ts +85 -65
package/src/helpers/keys.ts
CHANGED
|
@@ -153,6 +153,7 @@ import { DomainNameParts } from './schemas';
|
|
|
153
153
|
import { DomainPeriod } from './schemas';
|
|
154
154
|
import { DomainRenewRequest } from './schemas';
|
|
155
155
|
import { DomainRenew } from './schemas';
|
|
156
|
+
import { DomainRenewalDetails } from './schemas';
|
|
156
157
|
import { Domain } from './schemas';
|
|
157
158
|
import { DomainRestoreRequest } from './schemas';
|
|
158
159
|
import { DomainRestore } from './schemas';
|
|
@@ -182,6 +183,7 @@ import { DomainUpdateBulkTemplate } from './schemas';
|
|
|
182
183
|
import { DomainUpdateCommand } from './schemas';
|
|
183
184
|
import { DomainUpdatePayloadData } from './schemas';
|
|
184
185
|
import { DomainUpdateWorkerPayload } from './schemas';
|
|
186
|
+
import { DomainVerificationDetails } from './schemas';
|
|
185
187
|
import { DomainWithdrawRequest } from './schemas';
|
|
186
188
|
import { DomainWithdraw } from './schemas';
|
|
187
189
|
import { DomainsExpiringSoon } from './schemas';
|
|
@@ -198,8 +200,9 @@ import { EmailForwardMetricsFilters } from './schemas';
|
|
|
198
200
|
import { EmailForwardMetricsRates } from './schemas';
|
|
199
201
|
import { EmailForward } from './schemas';
|
|
200
202
|
import { EmailForwardZone } from './schemas';
|
|
203
|
+
import { EventData } from './schemas';
|
|
204
|
+
import { EventError } from './schemas';
|
|
201
205
|
import { EventResponse } from './schemas';
|
|
202
|
-
import { EventSchema } from './schemas';
|
|
203
206
|
import { GeneralAvailabilityBase } from './schemas';
|
|
204
207
|
import { GeoStatsBucket } from './schemas';
|
|
205
208
|
import { GetPrices } from './schemas';
|
|
@@ -328,6 +331,8 @@ import { UserToken } from './schemas';
|
|
|
328
331
|
import { UserUpdate } from './schemas';
|
|
329
332
|
import { UserWithRelationPermissions } from './schemas';
|
|
330
333
|
import { ValidationError } from './schemas';
|
|
334
|
+
import { VerificationDeadline } from './schemas';
|
|
335
|
+
import { VerificationRegistrantDetails } from './schemas';
|
|
331
336
|
import { VisitsByKeyBucket } from './schemas';
|
|
332
337
|
import { WhoisBase } from './schemas';
|
|
333
338
|
import { RequestAuthcode } from './schemas';
|
|
@@ -16947,6 +16952,82 @@ export const KEYS_DOMAIN_RENEW = [
|
|
|
16947
16952
|
KEY_DOMAIN_RENEW_PERIOD_EXTENDED,
|
|
16948
16953
|
] as const satisfies (keyof DomainRenew)[];
|
|
16949
16954
|
|
|
16955
|
+
/**
|
|
16956
|
+
* Detail Type
|
|
16957
|
+
*
|
|
16958
|
+
*
|
|
16959
|
+
* @type {string}
|
|
16960
|
+
*
|
|
16961
|
+
*
|
|
16962
|
+
* @remarks
|
|
16963
|
+
* This key constant provides type-safe access to the `detail_type` property of DomainRenewalDetails objects.
|
|
16964
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
16965
|
+
*
|
|
16966
|
+
* @example
|
|
16967
|
+
* ```typescript
|
|
16968
|
+
* // Direct property access
|
|
16969
|
+
* const value = domainrenewaldetails[KEY_DOMAIN_RENEWAL_DETAILS_DETAIL_TYPE];
|
|
16970
|
+
*
|
|
16971
|
+
* // Dynamic property access
|
|
16972
|
+
* const propertyName = KEY_DOMAIN_RENEWAL_DETAILS_DETAIL_TYPE;
|
|
16973
|
+
* const value = domainrenewaldetails[propertyName];
|
|
16974
|
+
* ```
|
|
16975
|
+
*
|
|
16976
|
+
* @see {@link DomainRenewalDetails} - The TypeScript type definition
|
|
16977
|
+
* @see {@link KEYS_DOMAIN_RENEWAL_DETAILS} - Array of all keys for this type
|
|
16978
|
+
*/
|
|
16979
|
+
export const KEY_DOMAIN_RENEWAL_DETAILS_DETAIL_TYPE: keyof DomainRenewalDetails = 'detail_type';
|
|
16980
|
+
/**
|
|
16981
|
+
* Expires On
|
|
16982
|
+
*
|
|
16983
|
+
*
|
|
16984
|
+
* @type {string}
|
|
16985
|
+
*
|
|
16986
|
+
*
|
|
16987
|
+
* @remarks
|
|
16988
|
+
* This key constant provides type-safe access to the `expires_on` property of DomainRenewalDetails objects.
|
|
16989
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
16990
|
+
*
|
|
16991
|
+
* @example
|
|
16992
|
+
* ```typescript
|
|
16993
|
+
* // Direct property access
|
|
16994
|
+
* const value = domainrenewaldetails[KEY_DOMAIN_RENEWAL_DETAILS_EXPIRES_ON];
|
|
16995
|
+
*
|
|
16996
|
+
* // Dynamic property access
|
|
16997
|
+
* const propertyName = KEY_DOMAIN_RENEWAL_DETAILS_EXPIRES_ON;
|
|
16998
|
+
* const value = domainrenewaldetails[propertyName];
|
|
16999
|
+
* ```
|
|
17000
|
+
*
|
|
17001
|
+
* @see {@link DomainRenewalDetails} - The TypeScript type definition
|
|
17002
|
+
* @see {@link KEYS_DOMAIN_RENEWAL_DETAILS} - Array of all keys for this type
|
|
17003
|
+
*/
|
|
17004
|
+
export const KEY_DOMAIN_RENEWAL_DETAILS_EXPIRES_ON: keyof DomainRenewalDetails = 'expires_on';
|
|
17005
|
+
|
|
17006
|
+
/**
|
|
17007
|
+
* Array of all DomainRenewalDetails property keys
|
|
17008
|
+
*
|
|
17009
|
+
* @remarks
|
|
17010
|
+
* This constant provides a readonly array containing all valid property keys for DomainRenewalDetails objects.
|
|
17011
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
17012
|
+
*
|
|
17013
|
+
* @example
|
|
17014
|
+
* ```typescript
|
|
17015
|
+
* // Iterating through all keys
|
|
17016
|
+
* for (const key of KEYS_DOMAIN_RENEWAL_DETAILS) {
|
|
17017
|
+
* console.log(`Property: ${key}, Value: ${domainrenewaldetails[key]}`);
|
|
17018
|
+
* }
|
|
17019
|
+
*
|
|
17020
|
+
* // Validation
|
|
17021
|
+
* const isValidKey = KEYS_DOMAIN_RENEWAL_DETAILS.includes(someKey);
|
|
17022
|
+
* ```
|
|
17023
|
+
*
|
|
17024
|
+
* @see {@link DomainRenewalDetails} - The TypeScript type definition
|
|
17025
|
+
*/
|
|
17026
|
+
export const KEYS_DOMAIN_RENEWAL_DETAILS = [
|
|
17027
|
+
KEY_DOMAIN_RENEWAL_DETAILS_DETAIL_TYPE,
|
|
17028
|
+
KEY_DOMAIN_RENEWAL_DETAILS_EXPIRES_ON,
|
|
17029
|
+
] as const satisfies (keyof DomainRenewalDetails)[];
|
|
17030
|
+
|
|
16950
17031
|
/**
|
|
16951
17032
|
* Auth Code
|
|
16952
17033
|
*
|
|
@@ -21266,6 +21347,160 @@ export const KEYS_DOMAIN_UPDATE_WORKER_PAYLOAD = [
|
|
|
21266
21347
|
KEY_DOMAIN_UPDATE_WORKER_PAYLOAD_TYPE,
|
|
21267
21348
|
] as const satisfies (keyof DomainUpdateWorkerPayload)[];
|
|
21268
21349
|
|
|
21350
|
+
/**
|
|
21351
|
+
* Detail Type
|
|
21352
|
+
*
|
|
21353
|
+
*
|
|
21354
|
+
* @type {string}
|
|
21355
|
+
*
|
|
21356
|
+
*
|
|
21357
|
+
* @remarks
|
|
21358
|
+
* This key constant provides type-safe access to the `detail_type` property of DomainVerificationDetails objects.
|
|
21359
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
21360
|
+
*
|
|
21361
|
+
* @example
|
|
21362
|
+
* ```typescript
|
|
21363
|
+
* // Direct property access
|
|
21364
|
+
* const value = domainverificationdetails[KEY_DOMAIN_VERIFICATION_DETAILS_DETAIL_TYPE];
|
|
21365
|
+
*
|
|
21366
|
+
* // Dynamic property access
|
|
21367
|
+
* const propertyName = KEY_DOMAIN_VERIFICATION_DETAILS_DETAIL_TYPE;
|
|
21368
|
+
* const value = domainverificationdetails[propertyName];
|
|
21369
|
+
* ```
|
|
21370
|
+
*
|
|
21371
|
+
* @see {@link DomainVerificationDetails} - The TypeScript type definition
|
|
21372
|
+
* @see {@link KEYS_DOMAIN_VERIFICATION_DETAILS} - Array of all keys for this type
|
|
21373
|
+
*/
|
|
21374
|
+
export const KEY_DOMAIN_VERIFICATION_DETAILS_DETAIL_TYPE: keyof DomainVerificationDetails = 'detail_type';
|
|
21375
|
+
/**
|
|
21376
|
+
* Domain Id
|
|
21377
|
+
*
|
|
21378
|
+
*
|
|
21379
|
+
* @type {string}
|
|
21380
|
+
*
|
|
21381
|
+
*
|
|
21382
|
+
* @remarks
|
|
21383
|
+
* This key constant provides type-safe access to the `domain_id` property of DomainVerificationDetails objects.
|
|
21384
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
21385
|
+
*
|
|
21386
|
+
* @example
|
|
21387
|
+
* ```typescript
|
|
21388
|
+
* // Direct property access
|
|
21389
|
+
* const value = domainverificationdetails[KEY_DOMAIN_VERIFICATION_DETAILS_DOMAIN_ID];
|
|
21390
|
+
*
|
|
21391
|
+
* // Dynamic property access
|
|
21392
|
+
* const propertyName = KEY_DOMAIN_VERIFICATION_DETAILS_DOMAIN_ID;
|
|
21393
|
+
* const value = domainverificationdetails[propertyName];
|
|
21394
|
+
* ```
|
|
21395
|
+
*
|
|
21396
|
+
* @see {@link DomainVerificationDetails} - The TypeScript type definition
|
|
21397
|
+
* @see {@link KEYS_DOMAIN_VERIFICATION_DETAILS} - Array of all keys for this type
|
|
21398
|
+
*/
|
|
21399
|
+
export const KEY_DOMAIN_VERIFICATION_DETAILS_DOMAIN_ID: keyof DomainVerificationDetails = 'domain_id';
|
|
21400
|
+
/**
|
|
21401
|
+
* Registrants
|
|
21402
|
+
*
|
|
21403
|
+
*
|
|
21404
|
+
* @type {array}
|
|
21405
|
+
*
|
|
21406
|
+
*
|
|
21407
|
+
* @remarks
|
|
21408
|
+
* This key constant provides type-safe access to the `registrants` property of DomainVerificationDetails objects.
|
|
21409
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
21410
|
+
*
|
|
21411
|
+
* @example
|
|
21412
|
+
* ```typescript
|
|
21413
|
+
* // Direct property access
|
|
21414
|
+
* const value = domainverificationdetails[KEY_DOMAIN_VERIFICATION_DETAILS_REGISTRANTS];
|
|
21415
|
+
*
|
|
21416
|
+
* // Dynamic property access
|
|
21417
|
+
* const propertyName = KEY_DOMAIN_VERIFICATION_DETAILS_REGISTRANTS;
|
|
21418
|
+
* const value = domainverificationdetails[propertyName];
|
|
21419
|
+
* ```
|
|
21420
|
+
*
|
|
21421
|
+
* @see {@link DomainVerificationDetails} - The TypeScript type definition
|
|
21422
|
+
* @see {@link KEYS_DOMAIN_VERIFICATION_DETAILS} - Array of all keys for this type
|
|
21423
|
+
*/
|
|
21424
|
+
export const KEY_DOMAIN_VERIFICATION_DETAILS_REGISTRANTS: keyof DomainVerificationDetails = 'registrants';
|
|
21425
|
+
/**
|
|
21426
|
+
* Verification Claims
|
|
21427
|
+
*
|
|
21428
|
+
*
|
|
21429
|
+
* @type {array}
|
|
21430
|
+
*
|
|
21431
|
+
*
|
|
21432
|
+
* @remarks
|
|
21433
|
+
* This key constant provides type-safe access to the `verification_claims` property of DomainVerificationDetails objects.
|
|
21434
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
21435
|
+
*
|
|
21436
|
+
* @example
|
|
21437
|
+
* ```typescript
|
|
21438
|
+
* // Direct property access
|
|
21439
|
+
* const value = domainverificationdetails[KEY_DOMAIN_VERIFICATION_DETAILS_VERIFICATION_CLAIMS];
|
|
21440
|
+
*
|
|
21441
|
+
* // Dynamic property access
|
|
21442
|
+
* const propertyName = KEY_DOMAIN_VERIFICATION_DETAILS_VERIFICATION_CLAIMS;
|
|
21443
|
+
* const value = domainverificationdetails[propertyName];
|
|
21444
|
+
* ```
|
|
21445
|
+
*
|
|
21446
|
+
* @see {@link DomainVerificationDetails} - The TypeScript type definition
|
|
21447
|
+
* @see {@link KEYS_DOMAIN_VERIFICATION_DETAILS} - Array of all keys for this type
|
|
21448
|
+
*/
|
|
21449
|
+
export const KEY_DOMAIN_VERIFICATION_DETAILS_VERIFICATION_CLAIMS: keyof DomainVerificationDetails = 'verification_claims';
|
|
21450
|
+
/**
|
|
21451
|
+
* Verification Deadlines
|
|
21452
|
+
*
|
|
21453
|
+
*
|
|
21454
|
+
* @type {array}
|
|
21455
|
+
*
|
|
21456
|
+
*
|
|
21457
|
+
* @remarks
|
|
21458
|
+
* This key constant provides type-safe access to the `verification_deadlines` property of DomainVerificationDetails objects.
|
|
21459
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
21460
|
+
*
|
|
21461
|
+
* @example
|
|
21462
|
+
* ```typescript
|
|
21463
|
+
* // Direct property access
|
|
21464
|
+
* const value = domainverificationdetails[KEY_DOMAIN_VERIFICATION_DETAILS_VERIFICATION_DEADLINES];
|
|
21465
|
+
*
|
|
21466
|
+
* // Dynamic property access
|
|
21467
|
+
* const propertyName = KEY_DOMAIN_VERIFICATION_DETAILS_VERIFICATION_DEADLINES;
|
|
21468
|
+
* const value = domainverificationdetails[propertyName];
|
|
21469
|
+
* ```
|
|
21470
|
+
*
|
|
21471
|
+
* @see {@link DomainVerificationDetails} - The TypeScript type definition
|
|
21472
|
+
* @see {@link KEYS_DOMAIN_VERIFICATION_DETAILS} - Array of all keys for this type
|
|
21473
|
+
*/
|
|
21474
|
+
export const KEY_DOMAIN_VERIFICATION_DETAILS_VERIFICATION_DEADLINES: keyof DomainVerificationDetails = 'verification_deadlines';
|
|
21475
|
+
|
|
21476
|
+
/**
|
|
21477
|
+
* Array of all DomainVerificationDetails property keys
|
|
21478
|
+
*
|
|
21479
|
+
* @remarks
|
|
21480
|
+
* This constant provides a readonly array containing all valid property keys for DomainVerificationDetails objects.
|
|
21481
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
21482
|
+
*
|
|
21483
|
+
* @example
|
|
21484
|
+
* ```typescript
|
|
21485
|
+
* // Iterating through all keys
|
|
21486
|
+
* for (const key of KEYS_DOMAIN_VERIFICATION_DETAILS) {
|
|
21487
|
+
* console.log(`Property: ${key}, Value: ${domainverificationdetails[key]}`);
|
|
21488
|
+
* }
|
|
21489
|
+
*
|
|
21490
|
+
* // Validation
|
|
21491
|
+
* const isValidKey = KEYS_DOMAIN_VERIFICATION_DETAILS.includes(someKey);
|
|
21492
|
+
* ```
|
|
21493
|
+
*
|
|
21494
|
+
* @see {@link DomainVerificationDetails} - The TypeScript type definition
|
|
21495
|
+
*/
|
|
21496
|
+
export const KEYS_DOMAIN_VERIFICATION_DETAILS = [
|
|
21497
|
+
KEY_DOMAIN_VERIFICATION_DETAILS_DETAIL_TYPE,
|
|
21498
|
+
KEY_DOMAIN_VERIFICATION_DETAILS_DOMAIN_ID,
|
|
21499
|
+
KEY_DOMAIN_VERIFICATION_DETAILS_REGISTRANTS,
|
|
21500
|
+
KEY_DOMAIN_VERIFICATION_DETAILS_VERIFICATION_CLAIMS,
|
|
21501
|
+
KEY_DOMAIN_VERIFICATION_DETAILS_VERIFICATION_DEADLINES,
|
|
21502
|
+
] as const satisfies (keyof DomainVerificationDetails)[];
|
|
21503
|
+
|
|
21269
21504
|
/**
|
|
21270
21505
|
* Zone Delete
|
|
21271
21506
|
*
|
|
@@ -23482,314 +23717,281 @@ export const KEYS_EMAIL_FORWARD_ZONE = [
|
|
|
23482
23717
|
] as const satisfies (keyof EmailForwardZone)[];
|
|
23483
23718
|
|
|
23484
23719
|
/**
|
|
23485
|
-
*
|
|
23486
|
-
*
|
|
23487
|
-
* When the event was acknowledged
|
|
23488
|
-
*
|
|
23489
|
-
*
|
|
23490
|
-
*
|
|
23491
|
-
* @remarks
|
|
23492
|
-
* This key constant provides type-safe access to the `acknowledged_on` property of EventResponse objects.
|
|
23493
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
23494
|
-
*
|
|
23495
|
-
* @example
|
|
23496
|
-
* ```typescript
|
|
23497
|
-
* // Direct property access
|
|
23498
|
-
* const value = eventresponse[KEY_EVENT_RESPONSE_ACKNOWLEDGED_ON];
|
|
23499
|
-
*
|
|
23500
|
-
* // Dynamic property access
|
|
23501
|
-
* const propertyName = KEY_EVENT_RESPONSE_ACKNOWLEDGED_ON;
|
|
23502
|
-
* const value = eventresponse[propertyName];
|
|
23503
|
-
* ```
|
|
23504
|
-
*
|
|
23505
|
-
* @see {@link EventResponse} - The TypeScript type definition
|
|
23506
|
-
* @see {@link KEYS_EVENT_RESPONSE} - Array of all keys for this type
|
|
23507
|
-
*/
|
|
23508
|
-
export const KEY_EVENT_RESPONSE_ACKNOWLEDGED_ON: keyof EventResponse = 'acknowledged_on';
|
|
23509
|
-
/**
|
|
23510
|
-
* Created On
|
|
23720
|
+
* Details
|
|
23511
23721
|
*
|
|
23512
|
-
* When the event was created
|
|
23513
23722
|
*
|
|
23514
|
-
* @type {string}
|
|
23515
23723
|
*
|
|
23516
23724
|
*
|
|
23517
23725
|
* @remarks
|
|
23518
|
-
* This key constant provides type-safe access to the `
|
|
23726
|
+
* This key constant provides type-safe access to the `details` property of EventData objects.
|
|
23519
23727
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
23520
23728
|
*
|
|
23521
23729
|
* @example
|
|
23522
23730
|
* ```typescript
|
|
23523
23731
|
* // Direct property access
|
|
23524
|
-
* const value =
|
|
23732
|
+
* const value = eventdata[KEY_EVENT_DATA_DETAILS];
|
|
23525
23733
|
*
|
|
23526
23734
|
* // Dynamic property access
|
|
23527
|
-
* const propertyName =
|
|
23528
|
-
* const value =
|
|
23735
|
+
* const propertyName = KEY_EVENT_DATA_DETAILS;
|
|
23736
|
+
* const value = eventdata[propertyName];
|
|
23529
23737
|
* ```
|
|
23530
23738
|
*
|
|
23531
|
-
* @see {@link
|
|
23532
|
-
* @see {@link
|
|
23739
|
+
* @see {@link EventData} - The TypeScript type definition
|
|
23740
|
+
* @see {@link KEYS_EVENT_DATA} - Array of all keys for this type
|
|
23533
23741
|
*/
|
|
23534
|
-
export const
|
|
23742
|
+
export const KEY_EVENT_DATA_DETAILS: keyof EventData = 'details';
|
|
23535
23743
|
/**
|
|
23536
|
-
*
|
|
23744
|
+
* error property
|
|
23537
23745
|
*
|
|
23538
23746
|
*
|
|
23539
|
-
* @type {object}
|
|
23540
23747
|
*
|
|
23541
23748
|
*
|
|
23542
23749
|
* @remarks
|
|
23543
|
-
* This key constant provides type-safe access to the `
|
|
23750
|
+
* This key constant provides type-safe access to the `error` property of EventData objects.
|
|
23544
23751
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
23545
23752
|
*
|
|
23546
23753
|
* @example
|
|
23547
23754
|
* ```typescript
|
|
23548
23755
|
* // Direct property access
|
|
23549
|
-
* const value =
|
|
23756
|
+
* const value = eventdata[KEY_EVENT_DATA_ERROR];
|
|
23550
23757
|
*
|
|
23551
23758
|
* // Dynamic property access
|
|
23552
|
-
* const propertyName =
|
|
23553
|
-
* const value =
|
|
23759
|
+
* const propertyName = KEY_EVENT_DATA_ERROR;
|
|
23760
|
+
* const value = eventdata[propertyName];
|
|
23554
23761
|
* ```
|
|
23555
23762
|
*
|
|
23556
|
-
* @see {@link
|
|
23557
|
-
* @see {@link
|
|
23763
|
+
* @see {@link EventData} - The TypeScript type definition
|
|
23764
|
+
* @see {@link KEYS_EVENT_DATA} - Array of all keys for this type
|
|
23558
23765
|
*/
|
|
23559
|
-
export const
|
|
23766
|
+
export const KEY_EVENT_DATA_ERROR: keyof EventData = 'error';
|
|
23560
23767
|
/**
|
|
23561
|
-
*
|
|
23768
|
+
* Message
|
|
23562
23769
|
*
|
|
23563
23770
|
*
|
|
23564
23771
|
* @type {string}
|
|
23565
23772
|
*
|
|
23566
23773
|
*
|
|
23567
23774
|
* @remarks
|
|
23568
|
-
* This key constant provides type-safe access to the `
|
|
23775
|
+
* This key constant provides type-safe access to the `message` property of EventData objects.
|
|
23569
23776
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
23570
23777
|
*
|
|
23571
23778
|
* @example
|
|
23572
23779
|
* ```typescript
|
|
23573
23780
|
* // Direct property access
|
|
23574
|
-
* const value =
|
|
23781
|
+
* const value = eventdata[KEY_EVENT_DATA_MESSAGE];
|
|
23575
23782
|
*
|
|
23576
23783
|
* // Dynamic property access
|
|
23577
|
-
* const propertyName =
|
|
23578
|
-
* const value =
|
|
23784
|
+
* const propertyName = KEY_EVENT_DATA_MESSAGE;
|
|
23785
|
+
* const value = eventdata[propertyName];
|
|
23579
23786
|
* ```
|
|
23580
23787
|
*
|
|
23581
|
-
* @see {@link
|
|
23582
|
-
* @see {@link
|
|
23788
|
+
* @see {@link EventData} - The TypeScript type definition
|
|
23789
|
+
* @see {@link KEYS_EVENT_DATA} - Array of all keys for this type
|
|
23583
23790
|
*/
|
|
23584
|
-
export const
|
|
23791
|
+
export const KEY_EVENT_DATA_MESSAGE: keyof EventData = 'message';
|
|
23585
23792
|
/**
|
|
23586
|
-
*
|
|
23793
|
+
* version property
|
|
23587
23794
|
*
|
|
23588
|
-
* The id of the object that the event is about
|
|
23589
23795
|
*
|
|
23590
23796
|
*
|
|
23591
23797
|
*
|
|
23592
23798
|
* @remarks
|
|
23593
|
-
* This key constant provides type-safe access to the `
|
|
23799
|
+
* This key constant provides type-safe access to the `version` property of EventData objects.
|
|
23594
23800
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
23595
23801
|
*
|
|
23596
23802
|
* @example
|
|
23597
23803
|
* ```typescript
|
|
23598
23804
|
* // Direct property access
|
|
23599
|
-
* const value =
|
|
23805
|
+
* const value = eventdata[KEY_EVENT_DATA_VERSION];
|
|
23600
23806
|
*
|
|
23601
23807
|
* // Dynamic property access
|
|
23602
|
-
* const propertyName =
|
|
23603
|
-
* const value =
|
|
23808
|
+
* const propertyName = KEY_EVENT_DATA_VERSION;
|
|
23809
|
+
* const value = eventdata[propertyName];
|
|
23604
23810
|
* ```
|
|
23605
23811
|
*
|
|
23606
|
-
* @see {@link
|
|
23607
|
-
* @see {@link
|
|
23812
|
+
* @see {@link EventData} - The TypeScript type definition
|
|
23813
|
+
* @see {@link KEYS_EVENT_DATA} - Array of all keys for this type
|
|
23608
23814
|
*/
|
|
23609
|
-
export const
|
|
23815
|
+
export const KEY_EVENT_DATA_VERSION: keyof EventData = 'version';
|
|
23816
|
+
|
|
23610
23817
|
/**
|
|
23611
|
-
*
|
|
23612
|
-
*
|
|
23613
|
-
* The type of object that the event is about
|
|
23614
|
-
*
|
|
23615
|
-
*
|
|
23818
|
+
* Array of all EventData property keys
|
|
23616
23819
|
*
|
|
23617
23820
|
* @remarks
|
|
23618
|
-
* This
|
|
23619
|
-
*
|
|
23821
|
+
* This constant provides a readonly array containing all valid property keys for EventData objects.
|
|
23822
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
23620
23823
|
*
|
|
23621
23824
|
* @example
|
|
23622
23825
|
* ```typescript
|
|
23623
|
-
* //
|
|
23624
|
-
* const
|
|
23826
|
+
* // Iterating through all keys
|
|
23827
|
+
* for (const key of KEYS_EVENT_DATA) {
|
|
23828
|
+
* console.log(`Property: ${key}, Value: ${eventdata[key]}`);
|
|
23829
|
+
* }
|
|
23625
23830
|
*
|
|
23626
|
-
* //
|
|
23627
|
-
* const
|
|
23628
|
-
* const value = eventresponse[propertyName];
|
|
23831
|
+
* // Validation
|
|
23832
|
+
* const isValidKey = KEYS_EVENT_DATA.includes(someKey);
|
|
23629
23833
|
* ```
|
|
23630
23834
|
*
|
|
23631
|
-
* @see {@link
|
|
23632
|
-
* @see {@link KEYS_EVENT_RESPONSE} - Array of all keys for this type
|
|
23835
|
+
* @see {@link EventData} - The TypeScript type definition
|
|
23633
23836
|
*/
|
|
23634
|
-
export const
|
|
23837
|
+
export const KEYS_EVENT_DATA = [
|
|
23838
|
+
KEY_EVENT_DATA_DETAILS,
|
|
23839
|
+
KEY_EVENT_DATA_ERROR,
|
|
23840
|
+
KEY_EVENT_DATA_MESSAGE,
|
|
23841
|
+
KEY_EVENT_DATA_VERSION,
|
|
23842
|
+
] as const satisfies (keyof EventData)[];
|
|
23843
|
+
|
|
23635
23844
|
/**
|
|
23636
|
-
*
|
|
23845
|
+
* Code
|
|
23637
23846
|
*
|
|
23638
|
-
* The specific type/result of operation (considering the type property), more detailed (e.g., 'NOTIFICATION' with the 'DOMAIN_MODIFICATION' class)
|
|
23639
23847
|
*
|
|
23848
|
+
* @type {string}
|
|
23640
23849
|
*
|
|
23641
23850
|
*
|
|
23642
23851
|
* @remarks
|
|
23643
|
-
* This key constant provides type-safe access to the `
|
|
23852
|
+
* This key constant provides type-safe access to the `code` property of EventError objects.
|
|
23644
23853
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
23645
23854
|
*
|
|
23646
23855
|
* @example
|
|
23647
23856
|
* ```typescript
|
|
23648
23857
|
* // Direct property access
|
|
23649
|
-
* const value =
|
|
23858
|
+
* const value = eventerror[KEY_EVENT_ERROR_CODE];
|
|
23650
23859
|
*
|
|
23651
23860
|
* // Dynamic property access
|
|
23652
|
-
* const propertyName =
|
|
23653
|
-
* const value =
|
|
23861
|
+
* const propertyName = KEY_EVENT_ERROR_CODE;
|
|
23862
|
+
* const value = eventerror[propertyName];
|
|
23654
23863
|
* ```
|
|
23655
23864
|
*
|
|
23656
|
-
* @see {@link
|
|
23657
|
-
* @see {@link
|
|
23865
|
+
* @see {@link EventError} - The TypeScript type definition
|
|
23866
|
+
* @see {@link KEYS_EVENT_ERROR} - Array of all keys for this type
|
|
23658
23867
|
*/
|
|
23659
|
-
export const
|
|
23868
|
+
export const KEY_EVENT_ERROR_CODE: keyof EventError = 'code';
|
|
23660
23869
|
/**
|
|
23661
|
-
*
|
|
23870
|
+
* Detail
|
|
23662
23871
|
*
|
|
23663
|
-
* The type of the event - indicates the kind of operation occurring (e.g., 'ACCOUNT_CREATE', 'DOMAIN_MODIFICATION')
|
|
23664
23872
|
*
|
|
23873
|
+
* @type {string}
|
|
23665
23874
|
*
|
|
23666
23875
|
*
|
|
23667
23876
|
* @remarks
|
|
23668
|
-
* This key constant provides type-safe access to the `
|
|
23877
|
+
* This key constant provides type-safe access to the `detail` property of EventError objects.
|
|
23669
23878
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
23670
23879
|
*
|
|
23671
23880
|
* @example
|
|
23672
23881
|
* ```typescript
|
|
23673
23882
|
* // Direct property access
|
|
23674
|
-
* const value =
|
|
23883
|
+
* const value = eventerror[KEY_EVENT_ERROR_DETAIL];
|
|
23675
23884
|
*
|
|
23676
23885
|
* // Dynamic property access
|
|
23677
|
-
* const propertyName =
|
|
23678
|
-
* const value =
|
|
23886
|
+
* const propertyName = KEY_EVENT_ERROR_DETAIL;
|
|
23887
|
+
* const value = eventerror[propertyName];
|
|
23679
23888
|
* ```
|
|
23680
23889
|
*
|
|
23681
|
-
* @see {@link
|
|
23682
|
-
* @see {@link
|
|
23890
|
+
* @see {@link EventError} - The TypeScript type definition
|
|
23891
|
+
* @see {@link KEYS_EVENT_ERROR} - Array of all keys for this type
|
|
23683
23892
|
*/
|
|
23684
|
-
export const
|
|
23893
|
+
export const KEY_EVENT_ERROR_DETAIL: keyof EventError = 'detail';
|
|
23685
23894
|
|
|
23686
23895
|
/**
|
|
23687
|
-
* Array of all
|
|
23896
|
+
* Array of all EventError property keys
|
|
23688
23897
|
*
|
|
23689
23898
|
* @remarks
|
|
23690
|
-
* This constant provides a readonly array containing all valid property keys for
|
|
23899
|
+
* This constant provides a readonly array containing all valid property keys for EventError objects.
|
|
23691
23900
|
* Useful for iteration, validation, and generating dynamic UI components.
|
|
23692
23901
|
*
|
|
23693
23902
|
* @example
|
|
23694
23903
|
* ```typescript
|
|
23695
23904
|
* // Iterating through all keys
|
|
23696
|
-
* for (const key of
|
|
23697
|
-
* console.log(`Property: ${key}, Value: ${
|
|
23905
|
+
* for (const key of KEYS_EVENT_ERROR) {
|
|
23906
|
+
* console.log(`Property: ${key}, Value: ${eventerror[key]}`);
|
|
23698
23907
|
* }
|
|
23699
23908
|
*
|
|
23700
23909
|
* // Validation
|
|
23701
|
-
* const isValidKey =
|
|
23910
|
+
* const isValidKey = KEYS_EVENT_ERROR.includes(someKey);
|
|
23702
23911
|
* ```
|
|
23703
23912
|
*
|
|
23704
|
-
* @see {@link
|
|
23913
|
+
* @see {@link EventError} - The TypeScript type definition
|
|
23705
23914
|
*/
|
|
23706
|
-
export const
|
|
23707
|
-
|
|
23708
|
-
|
|
23709
|
-
|
|
23710
|
-
KEY_EVENT_RESPONSE_EVENT_ID,
|
|
23711
|
-
KEY_EVENT_RESPONSE_OBJECT_ID,
|
|
23712
|
-
KEY_EVENT_RESPONSE_OBJECT_TYPE,
|
|
23713
|
-
KEY_EVENT_RESPONSE_SUBTYPE,
|
|
23714
|
-
KEY_EVENT_RESPONSE_TYPE,
|
|
23715
|
-
] as const satisfies (keyof EventResponse)[];
|
|
23915
|
+
export const KEYS_EVENT_ERROR = [
|
|
23916
|
+
KEY_EVENT_ERROR_CODE,
|
|
23917
|
+
KEY_EVENT_ERROR_DETAIL,
|
|
23918
|
+
] as const satisfies (keyof EventError)[];
|
|
23716
23919
|
|
|
23717
23920
|
/**
|
|
23718
23921
|
* Acknowledged On
|
|
23719
23922
|
*
|
|
23720
|
-
*
|
|
23923
|
+
* When the event was acknowledged
|
|
23721
23924
|
*
|
|
23722
23925
|
*
|
|
23723
23926
|
*
|
|
23724
23927
|
* @remarks
|
|
23725
|
-
* This key constant provides type-safe access to the `acknowledged_on` property of
|
|
23928
|
+
* This key constant provides type-safe access to the `acknowledged_on` property of EventResponse objects.
|
|
23726
23929
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
23727
23930
|
*
|
|
23728
23931
|
* @example
|
|
23729
23932
|
* ```typescript
|
|
23730
23933
|
* // Direct property access
|
|
23731
|
-
* const value =
|
|
23934
|
+
* const value = eventresponse[KEY_EVENT_RESPONSE_ACKNOWLEDGED_ON];
|
|
23732
23935
|
*
|
|
23733
23936
|
* // Dynamic property access
|
|
23734
|
-
* const propertyName =
|
|
23735
|
-
* const value =
|
|
23937
|
+
* const propertyName = KEY_EVENT_RESPONSE_ACKNOWLEDGED_ON;
|
|
23938
|
+
* const value = eventresponse[propertyName];
|
|
23736
23939
|
* ```
|
|
23737
23940
|
*
|
|
23738
|
-
* @see {@link
|
|
23739
|
-
* @see {@link
|
|
23941
|
+
* @see {@link EventResponse} - The TypeScript type definition
|
|
23942
|
+
* @see {@link KEYS_EVENT_RESPONSE} - Array of all keys for this type
|
|
23740
23943
|
*/
|
|
23741
|
-
export const
|
|
23944
|
+
export const KEY_EVENT_RESPONSE_ACKNOWLEDGED_ON: keyof EventResponse = 'acknowledged_on';
|
|
23742
23945
|
/**
|
|
23743
23946
|
* Created On
|
|
23744
23947
|
*
|
|
23745
|
-
*
|
|
23948
|
+
* When the event was created
|
|
23746
23949
|
*
|
|
23747
23950
|
* @type {string}
|
|
23748
23951
|
*
|
|
23749
23952
|
*
|
|
23750
23953
|
* @remarks
|
|
23751
|
-
* This key constant provides type-safe access to the `created_on` property of
|
|
23954
|
+
* This key constant provides type-safe access to the `created_on` property of EventResponse objects.
|
|
23752
23955
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
23753
23956
|
*
|
|
23754
23957
|
* @example
|
|
23755
23958
|
* ```typescript
|
|
23756
23959
|
* // Direct property access
|
|
23757
|
-
* const value =
|
|
23960
|
+
* const value = eventresponse[KEY_EVENT_RESPONSE_CREATED_ON];
|
|
23758
23961
|
*
|
|
23759
23962
|
* // Dynamic property access
|
|
23760
|
-
* const propertyName =
|
|
23761
|
-
* const value =
|
|
23963
|
+
* const propertyName = KEY_EVENT_RESPONSE_CREATED_ON;
|
|
23964
|
+
* const value = eventresponse[propertyName];
|
|
23762
23965
|
* ```
|
|
23763
23966
|
*
|
|
23764
|
-
* @see {@link
|
|
23765
|
-
* @see {@link
|
|
23967
|
+
* @see {@link EventResponse} - The TypeScript type definition
|
|
23968
|
+
* @see {@link KEYS_EVENT_RESPONSE} - Array of all keys for this type
|
|
23766
23969
|
*/
|
|
23767
|
-
export const
|
|
23970
|
+
export const KEY_EVENT_RESPONSE_CREATED_ON: keyof EventResponse = 'created_on';
|
|
23768
23971
|
/**
|
|
23769
23972
|
* event_data property
|
|
23770
23973
|
*
|
|
23771
|
-
* Additional details about the action
|
|
23772
23974
|
*
|
|
23773
23975
|
*
|
|
23774
23976
|
*
|
|
23775
23977
|
* @remarks
|
|
23776
|
-
* This key constant provides type-safe access to the `event_data` property of
|
|
23978
|
+
* This key constant provides type-safe access to the `event_data` property of EventResponse objects.
|
|
23777
23979
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
23778
23980
|
*
|
|
23779
23981
|
* @example
|
|
23780
23982
|
* ```typescript
|
|
23781
23983
|
* // Direct property access
|
|
23782
|
-
* const value =
|
|
23984
|
+
* const value = eventresponse[KEY_EVENT_RESPONSE_EVENT_DATA];
|
|
23783
23985
|
*
|
|
23784
23986
|
* // Dynamic property access
|
|
23785
|
-
* const propertyName =
|
|
23786
|
-
* const value =
|
|
23987
|
+
* const propertyName = KEY_EVENT_RESPONSE_EVENT_DATA;
|
|
23988
|
+
* const value = eventresponse[propertyName];
|
|
23787
23989
|
* ```
|
|
23788
23990
|
*
|
|
23789
|
-
* @see {@link
|
|
23790
|
-
* @see {@link
|
|
23991
|
+
* @see {@link EventResponse} - The TypeScript type definition
|
|
23992
|
+
* @see {@link KEYS_EVENT_RESPONSE} - Array of all keys for this type
|
|
23791
23993
|
*/
|
|
23792
|
-
export const
|
|
23994
|
+
export const KEY_EVENT_RESPONSE_EVENT_DATA: keyof EventResponse = 'event_data';
|
|
23793
23995
|
/**
|
|
23794
23996
|
* Event Id
|
|
23795
23997
|
*
|
|
@@ -23798,48 +24000,23 @@ export const KEY_EVENT_SCHEMA_EVENT_DATA: keyof EventSchema = 'event_data';
|
|
|
23798
24000
|
*
|
|
23799
24001
|
*
|
|
23800
24002
|
* @remarks
|
|
23801
|
-
* This key constant provides type-safe access to the `event_id` property of
|
|
23802
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
23803
|
-
*
|
|
23804
|
-
* @example
|
|
23805
|
-
* ```typescript
|
|
23806
|
-
* // Direct property access
|
|
23807
|
-
* const value = eventschema[KEY_EVENT_SCHEMA_EVENT_ID];
|
|
23808
|
-
*
|
|
23809
|
-
* // Dynamic property access
|
|
23810
|
-
* const propertyName = KEY_EVENT_SCHEMA_EVENT_ID;
|
|
23811
|
-
* const value = eventschema[propertyName];
|
|
23812
|
-
* ```
|
|
23813
|
-
*
|
|
23814
|
-
* @see {@link EventSchema} - The TypeScript type definition
|
|
23815
|
-
* @see {@link KEYS_EVENT_SCHEMA} - Array of all keys for this type
|
|
23816
|
-
*/
|
|
23817
|
-
export const KEY_EVENT_SCHEMA_EVENT_ID: keyof EventSchema = 'event_id';
|
|
23818
|
-
/**
|
|
23819
|
-
* Message Queue Id
|
|
23820
|
-
*
|
|
23821
|
-
* A composite key with the registry account + message queue ID from the poll operation.
|
|
23822
|
-
*
|
|
23823
|
-
*
|
|
23824
|
-
*
|
|
23825
|
-
* @remarks
|
|
23826
|
-
* This key constant provides type-safe access to the `message_queue_id` property of EventSchema objects.
|
|
24003
|
+
* This key constant provides type-safe access to the `event_id` property of EventResponse objects.
|
|
23827
24004
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
23828
24005
|
*
|
|
23829
24006
|
* @example
|
|
23830
24007
|
* ```typescript
|
|
23831
24008
|
* // Direct property access
|
|
23832
|
-
* const value =
|
|
24009
|
+
* const value = eventresponse[KEY_EVENT_RESPONSE_EVENT_ID];
|
|
23833
24010
|
*
|
|
23834
24011
|
* // Dynamic property access
|
|
23835
|
-
* const propertyName =
|
|
23836
|
-
* const value =
|
|
24012
|
+
* const propertyName = KEY_EVENT_RESPONSE_EVENT_ID;
|
|
24013
|
+
* const value = eventresponse[propertyName];
|
|
23837
24014
|
* ```
|
|
23838
24015
|
*
|
|
23839
|
-
* @see {@link
|
|
23840
|
-
* @see {@link
|
|
24016
|
+
* @see {@link EventResponse} - The TypeScript type definition
|
|
24017
|
+
* @see {@link KEYS_EVENT_RESPONSE} - Array of all keys for this type
|
|
23841
24018
|
*/
|
|
23842
|
-
export const
|
|
24019
|
+
export const KEY_EVENT_RESPONSE_EVENT_ID: keyof EventResponse = 'event_id';
|
|
23843
24020
|
/**
|
|
23844
24021
|
* Object Id
|
|
23845
24022
|
*
|
|
@@ -23848,23 +24025,23 @@ export const KEY_EVENT_SCHEMA_MESSAGE_QUEUE_ID: keyof EventSchema = 'message_que
|
|
|
23848
24025
|
*
|
|
23849
24026
|
*
|
|
23850
24027
|
* @remarks
|
|
23851
|
-
* This key constant provides type-safe access to the `object_id` property of
|
|
24028
|
+
* This key constant provides type-safe access to the `object_id` property of EventResponse objects.
|
|
23852
24029
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
23853
24030
|
*
|
|
23854
24031
|
* @example
|
|
23855
24032
|
* ```typescript
|
|
23856
24033
|
* // Direct property access
|
|
23857
|
-
* const value =
|
|
24034
|
+
* const value = eventresponse[KEY_EVENT_RESPONSE_OBJECT_ID];
|
|
23858
24035
|
*
|
|
23859
24036
|
* // Dynamic property access
|
|
23860
|
-
* const propertyName =
|
|
23861
|
-
* const value =
|
|
24037
|
+
* const propertyName = KEY_EVENT_RESPONSE_OBJECT_ID;
|
|
24038
|
+
* const value = eventresponse[propertyName];
|
|
23862
24039
|
* ```
|
|
23863
24040
|
*
|
|
23864
|
-
* @see {@link
|
|
23865
|
-
* @see {@link
|
|
24041
|
+
* @see {@link EventResponse} - The TypeScript type definition
|
|
24042
|
+
* @see {@link KEYS_EVENT_RESPONSE} - Array of all keys for this type
|
|
23866
24043
|
*/
|
|
23867
|
-
export const
|
|
24044
|
+
export const KEY_EVENT_RESPONSE_OBJECT_ID: keyof EventResponse = 'object_id';
|
|
23868
24045
|
/**
|
|
23869
24046
|
* object_type property
|
|
23870
24047
|
*
|
|
@@ -23873,74 +24050,23 @@ export const KEY_EVENT_SCHEMA_OBJECT_ID: keyof EventSchema = 'object_id';
|
|
|
23873
24050
|
*
|
|
23874
24051
|
*
|
|
23875
24052
|
* @remarks
|
|
23876
|
-
* This key constant provides type-safe access to the `object_type` property of
|
|
23877
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
23878
|
-
*
|
|
23879
|
-
* @example
|
|
23880
|
-
* ```typescript
|
|
23881
|
-
* // Direct property access
|
|
23882
|
-
* const value = eventschema[KEY_EVENT_SCHEMA_OBJECT_TYPE];
|
|
23883
|
-
*
|
|
23884
|
-
* // Dynamic property access
|
|
23885
|
-
* const propertyName = KEY_EVENT_SCHEMA_OBJECT_TYPE;
|
|
23886
|
-
* const value = eventschema[propertyName];
|
|
23887
|
-
* ```
|
|
23888
|
-
*
|
|
23889
|
-
* @see {@link EventSchema} - The TypeScript type definition
|
|
23890
|
-
* @see {@link KEYS_EVENT_SCHEMA} - Array of all keys for this type
|
|
23891
|
-
*/
|
|
23892
|
-
export const KEY_EVENT_SCHEMA_OBJECT_TYPE: keyof EventSchema = 'object_type';
|
|
23893
|
-
/**
|
|
23894
|
-
* Source
|
|
23895
|
-
*
|
|
23896
|
-
* The source of the event
|
|
23897
|
-
*
|
|
23898
|
-
* @type {string}
|
|
23899
|
-
*
|
|
23900
|
-
*
|
|
23901
|
-
* @remarks
|
|
23902
|
-
* This key constant provides type-safe access to the `source` property of EventSchema objects.
|
|
23903
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
23904
|
-
*
|
|
23905
|
-
* @example
|
|
23906
|
-
* ```typescript
|
|
23907
|
-
* // Direct property access
|
|
23908
|
-
* const value = eventschema[KEY_EVENT_SCHEMA_SOURCE];
|
|
23909
|
-
*
|
|
23910
|
-
* // Dynamic property access
|
|
23911
|
-
* const propertyName = KEY_EVENT_SCHEMA_SOURCE;
|
|
23912
|
-
* const value = eventschema[propertyName];
|
|
23913
|
-
* ```
|
|
23914
|
-
*
|
|
23915
|
-
* @see {@link EventSchema} - The TypeScript type definition
|
|
23916
|
-
* @see {@link KEYS_EVENT_SCHEMA} - Array of all keys for this type
|
|
23917
|
-
*/
|
|
23918
|
-
export const KEY_EVENT_SCHEMA_SOURCE: keyof EventSchema = 'source';
|
|
23919
|
-
/**
|
|
23920
|
-
* Source Event Id
|
|
23921
|
-
*
|
|
23922
|
-
* The reference of the original registry event (if any) that triggered this customer-facing event
|
|
23923
|
-
*
|
|
23924
|
-
*
|
|
23925
|
-
*
|
|
23926
|
-
* @remarks
|
|
23927
|
-
* This key constant provides type-safe access to the `source_event_id` property of EventSchema objects.
|
|
24053
|
+
* This key constant provides type-safe access to the `object_type` property of EventResponse objects.
|
|
23928
24054
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
23929
24055
|
*
|
|
23930
24056
|
* @example
|
|
23931
24057
|
* ```typescript
|
|
23932
24058
|
* // Direct property access
|
|
23933
|
-
* const value =
|
|
24059
|
+
* const value = eventresponse[KEY_EVENT_RESPONSE_OBJECT_TYPE];
|
|
23934
24060
|
*
|
|
23935
24061
|
* // Dynamic property access
|
|
23936
|
-
* const propertyName =
|
|
23937
|
-
* const value =
|
|
24062
|
+
* const propertyName = KEY_EVENT_RESPONSE_OBJECT_TYPE;
|
|
24063
|
+
* const value = eventresponse[propertyName];
|
|
23938
24064
|
* ```
|
|
23939
24065
|
*
|
|
23940
|
-
* @see {@link
|
|
23941
|
-
* @see {@link
|
|
24066
|
+
* @see {@link EventResponse} - The TypeScript type definition
|
|
24067
|
+
* @see {@link KEYS_EVENT_RESPONSE} - Array of all keys for this type
|
|
23942
24068
|
*/
|
|
23943
|
-
export const
|
|
24069
|
+
export const KEY_EVENT_RESPONSE_OBJECT_TYPE: keyof EventResponse = 'object_type';
|
|
23944
24070
|
/**
|
|
23945
24071
|
* subtype property
|
|
23946
24072
|
*
|
|
@@ -23949,48 +24075,23 @@ export const KEY_EVENT_SCHEMA_SOURCE_EVENT_ID: keyof EventSchema = 'source_event
|
|
|
23949
24075
|
*
|
|
23950
24076
|
*
|
|
23951
24077
|
* @remarks
|
|
23952
|
-
* This key constant provides type-safe access to the `subtype` property of
|
|
23953
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
23954
|
-
*
|
|
23955
|
-
* @example
|
|
23956
|
-
* ```typescript
|
|
23957
|
-
* // Direct property access
|
|
23958
|
-
* const value = eventschema[KEY_EVENT_SCHEMA_SUBTYPE];
|
|
23959
|
-
*
|
|
23960
|
-
* // Dynamic property access
|
|
23961
|
-
* const propertyName = KEY_EVENT_SCHEMA_SUBTYPE;
|
|
23962
|
-
* const value = eventschema[propertyName];
|
|
23963
|
-
* ```
|
|
23964
|
-
*
|
|
23965
|
-
* @see {@link EventSchema} - The TypeScript type definition
|
|
23966
|
-
* @see {@link KEYS_EVENT_SCHEMA} - Array of all keys for this type
|
|
23967
|
-
*/
|
|
23968
|
-
export const KEY_EVENT_SCHEMA_SUBTYPE: keyof EventSchema = 'subtype';
|
|
23969
|
-
/**
|
|
23970
|
-
* Target
|
|
23971
|
-
*
|
|
23972
|
-
* The target of the event
|
|
23973
|
-
*
|
|
23974
|
-
*
|
|
23975
|
-
*
|
|
23976
|
-
* @remarks
|
|
23977
|
-
* This key constant provides type-safe access to the `target` property of EventSchema objects.
|
|
24078
|
+
* This key constant provides type-safe access to the `subtype` property of EventResponse objects.
|
|
23978
24079
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
23979
24080
|
*
|
|
23980
24081
|
* @example
|
|
23981
24082
|
* ```typescript
|
|
23982
24083
|
* // Direct property access
|
|
23983
|
-
* const value =
|
|
24084
|
+
* const value = eventresponse[KEY_EVENT_RESPONSE_SUBTYPE];
|
|
23984
24085
|
*
|
|
23985
24086
|
* // Dynamic property access
|
|
23986
|
-
* const propertyName =
|
|
23987
|
-
* const value =
|
|
24087
|
+
* const propertyName = KEY_EVENT_RESPONSE_SUBTYPE;
|
|
24088
|
+
* const value = eventresponse[propertyName];
|
|
23988
24089
|
* ```
|
|
23989
24090
|
*
|
|
23990
|
-
* @see {@link
|
|
23991
|
-
* @see {@link
|
|
24091
|
+
* @see {@link EventResponse} - The TypeScript type definition
|
|
24092
|
+
* @see {@link KEYS_EVENT_RESPONSE} - Array of all keys for this type
|
|
23992
24093
|
*/
|
|
23993
|
-
export const
|
|
24094
|
+
export const KEY_EVENT_RESPONSE_SUBTYPE: keyof EventResponse = 'subtype';
|
|
23994
24095
|
/**
|
|
23995
24096
|
* type property
|
|
23996
24097
|
*
|
|
@@ -23999,58 +24100,54 @@ export const KEY_EVENT_SCHEMA_TARGET: keyof EventSchema = 'target';
|
|
|
23999
24100
|
*
|
|
24000
24101
|
*
|
|
24001
24102
|
* @remarks
|
|
24002
|
-
* This key constant provides type-safe access to the `type` property of
|
|
24103
|
+
* This key constant provides type-safe access to the `type` property of EventResponse objects.
|
|
24003
24104
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
24004
24105
|
*
|
|
24005
24106
|
* @example
|
|
24006
24107
|
* ```typescript
|
|
24007
24108
|
* // Direct property access
|
|
24008
|
-
* const value =
|
|
24109
|
+
* const value = eventresponse[KEY_EVENT_RESPONSE_TYPE];
|
|
24009
24110
|
*
|
|
24010
24111
|
* // Dynamic property access
|
|
24011
|
-
* const propertyName =
|
|
24012
|
-
* const value =
|
|
24112
|
+
* const propertyName = KEY_EVENT_RESPONSE_TYPE;
|
|
24113
|
+
* const value = eventresponse[propertyName];
|
|
24013
24114
|
* ```
|
|
24014
24115
|
*
|
|
24015
|
-
* @see {@link
|
|
24016
|
-
* @see {@link
|
|
24116
|
+
* @see {@link EventResponse} - The TypeScript type definition
|
|
24117
|
+
* @see {@link KEYS_EVENT_RESPONSE} - Array of all keys for this type
|
|
24017
24118
|
*/
|
|
24018
|
-
export const
|
|
24119
|
+
export const KEY_EVENT_RESPONSE_TYPE: keyof EventResponse = 'type';
|
|
24019
24120
|
|
|
24020
24121
|
/**
|
|
24021
|
-
* Array of all
|
|
24122
|
+
* Array of all EventResponse property keys
|
|
24022
24123
|
*
|
|
24023
24124
|
* @remarks
|
|
24024
|
-
* This constant provides a readonly array containing all valid property keys for
|
|
24125
|
+
* This constant provides a readonly array containing all valid property keys for EventResponse objects.
|
|
24025
24126
|
* Useful for iteration, validation, and generating dynamic UI components.
|
|
24026
24127
|
*
|
|
24027
24128
|
* @example
|
|
24028
24129
|
* ```typescript
|
|
24029
24130
|
* // Iterating through all keys
|
|
24030
|
-
* for (const key of
|
|
24031
|
-
* console.log(`Property: ${key}, Value: ${
|
|
24131
|
+
* for (const key of KEYS_EVENT_RESPONSE) {
|
|
24132
|
+
* console.log(`Property: ${key}, Value: ${eventresponse[key]}`);
|
|
24032
24133
|
* }
|
|
24033
24134
|
*
|
|
24034
24135
|
* // Validation
|
|
24035
|
-
* const isValidKey =
|
|
24136
|
+
* const isValidKey = KEYS_EVENT_RESPONSE.includes(someKey);
|
|
24036
24137
|
* ```
|
|
24037
24138
|
*
|
|
24038
|
-
* @see {@link
|
|
24139
|
+
* @see {@link EventResponse} - The TypeScript type definition
|
|
24039
24140
|
*/
|
|
24040
|
-
export const
|
|
24041
|
-
|
|
24042
|
-
|
|
24043
|
-
|
|
24044
|
-
|
|
24045
|
-
|
|
24046
|
-
|
|
24047
|
-
|
|
24048
|
-
|
|
24049
|
-
|
|
24050
|
-
KEY_EVENT_SCHEMA_SUBTYPE,
|
|
24051
|
-
KEY_EVENT_SCHEMA_TARGET,
|
|
24052
|
-
KEY_EVENT_SCHEMA_TYPE,
|
|
24053
|
-
] as const satisfies (keyof EventSchema)[];
|
|
24141
|
+
export const KEYS_EVENT_RESPONSE = [
|
|
24142
|
+
KEY_EVENT_RESPONSE_ACKNOWLEDGED_ON,
|
|
24143
|
+
KEY_EVENT_RESPONSE_CREATED_ON,
|
|
24144
|
+
KEY_EVENT_RESPONSE_EVENT_DATA,
|
|
24145
|
+
KEY_EVENT_RESPONSE_EVENT_ID,
|
|
24146
|
+
KEY_EVENT_RESPONSE_OBJECT_ID,
|
|
24147
|
+
KEY_EVENT_RESPONSE_OBJECT_TYPE,
|
|
24148
|
+
KEY_EVENT_RESPONSE_SUBTYPE,
|
|
24149
|
+
KEY_EVENT_RESPONSE_TYPE,
|
|
24150
|
+
] as const satisfies (keyof EventResponse)[];
|
|
24054
24151
|
|
|
24055
24152
|
/**
|
|
24056
24153
|
* Start Date
|
|
@@ -43229,6 +43326,183 @@ export const KEYS_VALIDATION_ERROR = [
|
|
|
43229
43326
|
KEY_VALIDATION_ERROR_TYPE,
|
|
43230
43327
|
] as const satisfies (keyof ValidationError)[];
|
|
43231
43328
|
|
|
43329
|
+
/**
|
|
43330
|
+
* Date
|
|
43331
|
+
*
|
|
43332
|
+
*
|
|
43333
|
+
* @type {string}
|
|
43334
|
+
*
|
|
43335
|
+
*
|
|
43336
|
+
* @remarks
|
|
43337
|
+
* This key constant provides type-safe access to the `date` property of VerificationDeadline objects.
|
|
43338
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
43339
|
+
*
|
|
43340
|
+
* @example
|
|
43341
|
+
* ```typescript
|
|
43342
|
+
* // Direct property access
|
|
43343
|
+
* const value = verificationdeadline[KEY_VERIFICATION_DEADLINE_DATE];
|
|
43344
|
+
*
|
|
43345
|
+
* // Dynamic property access
|
|
43346
|
+
* const propertyName = KEY_VERIFICATION_DEADLINE_DATE;
|
|
43347
|
+
* const value = verificationdeadline[propertyName];
|
|
43348
|
+
* ```
|
|
43349
|
+
*
|
|
43350
|
+
* @see {@link VerificationDeadline} - The TypeScript type definition
|
|
43351
|
+
* @see {@link KEYS_VERIFICATION_DEADLINE} - Array of all keys for this type
|
|
43352
|
+
*/
|
|
43353
|
+
export const KEY_VERIFICATION_DEADLINE_DATE: keyof VerificationDeadline = 'date';
|
|
43354
|
+
/**
|
|
43355
|
+
* type property
|
|
43356
|
+
*
|
|
43357
|
+
*
|
|
43358
|
+
*
|
|
43359
|
+
*
|
|
43360
|
+
* @remarks
|
|
43361
|
+
* This key constant provides type-safe access to the `type` property of VerificationDeadline objects.
|
|
43362
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
43363
|
+
*
|
|
43364
|
+
* @example
|
|
43365
|
+
* ```typescript
|
|
43366
|
+
* // Direct property access
|
|
43367
|
+
* const value = verificationdeadline[KEY_VERIFICATION_DEADLINE_TYPE];
|
|
43368
|
+
*
|
|
43369
|
+
* // Dynamic property access
|
|
43370
|
+
* const propertyName = KEY_VERIFICATION_DEADLINE_TYPE;
|
|
43371
|
+
* const value = verificationdeadline[propertyName];
|
|
43372
|
+
* ```
|
|
43373
|
+
*
|
|
43374
|
+
* @see {@link VerificationDeadline} - The TypeScript type definition
|
|
43375
|
+
* @see {@link KEYS_VERIFICATION_DEADLINE} - Array of all keys for this type
|
|
43376
|
+
*/
|
|
43377
|
+
export const KEY_VERIFICATION_DEADLINE_TYPE: keyof VerificationDeadline = 'type';
|
|
43378
|
+
|
|
43379
|
+
/**
|
|
43380
|
+
* Array of all VerificationDeadline property keys
|
|
43381
|
+
*
|
|
43382
|
+
* @remarks
|
|
43383
|
+
* This constant provides a readonly array containing all valid property keys for VerificationDeadline objects.
|
|
43384
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
43385
|
+
*
|
|
43386
|
+
* @example
|
|
43387
|
+
* ```typescript
|
|
43388
|
+
* // Iterating through all keys
|
|
43389
|
+
* for (const key of KEYS_VERIFICATION_DEADLINE) {
|
|
43390
|
+
* console.log(`Property: ${key}, Value: ${verificationdeadline[key]}`);
|
|
43391
|
+
* }
|
|
43392
|
+
*
|
|
43393
|
+
* // Validation
|
|
43394
|
+
* const isValidKey = KEYS_VERIFICATION_DEADLINE.includes(someKey);
|
|
43395
|
+
* ```
|
|
43396
|
+
*
|
|
43397
|
+
* @see {@link VerificationDeadline} - The TypeScript type definition
|
|
43398
|
+
*/
|
|
43399
|
+
export const KEYS_VERIFICATION_DEADLINE = [
|
|
43400
|
+
KEY_VERIFICATION_DEADLINE_DATE,
|
|
43401
|
+
KEY_VERIFICATION_DEADLINE_TYPE,
|
|
43402
|
+
] as const satisfies (keyof VerificationDeadline)[];
|
|
43403
|
+
|
|
43404
|
+
/**
|
|
43405
|
+
* Contact Id
|
|
43406
|
+
*
|
|
43407
|
+
*
|
|
43408
|
+
* @type {string}
|
|
43409
|
+
*
|
|
43410
|
+
*
|
|
43411
|
+
* @remarks
|
|
43412
|
+
* This key constant provides type-safe access to the `contact_id` property of VerificationRegistrantDetails objects.
|
|
43413
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
43414
|
+
*
|
|
43415
|
+
* @example
|
|
43416
|
+
* ```typescript
|
|
43417
|
+
* // Direct property access
|
|
43418
|
+
* const value = verificationregistrantdetails[KEY_VERIFICATION_REGISTRANT_DETAILS_CONTACT_ID];
|
|
43419
|
+
*
|
|
43420
|
+
* // Dynamic property access
|
|
43421
|
+
* const propertyName = KEY_VERIFICATION_REGISTRANT_DETAILS_CONTACT_ID;
|
|
43422
|
+
* const value = verificationregistrantdetails[propertyName];
|
|
43423
|
+
* ```
|
|
43424
|
+
*
|
|
43425
|
+
* @see {@link VerificationRegistrantDetails} - The TypeScript type definition
|
|
43426
|
+
* @see {@link KEYS_VERIFICATION_REGISTRANT_DETAILS} - Array of all keys for this type
|
|
43427
|
+
*/
|
|
43428
|
+
export const KEY_VERIFICATION_REGISTRANT_DETAILS_CONTACT_ID: keyof VerificationRegistrantDetails = 'contact_id';
|
|
43429
|
+
/**
|
|
43430
|
+
* Email
|
|
43431
|
+
*
|
|
43432
|
+
*
|
|
43433
|
+
* @type {string}
|
|
43434
|
+
*
|
|
43435
|
+
*
|
|
43436
|
+
* @remarks
|
|
43437
|
+
* This key constant provides type-safe access to the `email` property of VerificationRegistrantDetails objects.
|
|
43438
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
43439
|
+
*
|
|
43440
|
+
* @example
|
|
43441
|
+
* ```typescript
|
|
43442
|
+
* // Direct property access
|
|
43443
|
+
* const value = verificationregistrantdetails[KEY_VERIFICATION_REGISTRANT_DETAILS_EMAIL];
|
|
43444
|
+
*
|
|
43445
|
+
* // Dynamic property access
|
|
43446
|
+
* const propertyName = KEY_VERIFICATION_REGISTRANT_DETAILS_EMAIL;
|
|
43447
|
+
* const value = verificationregistrantdetails[propertyName];
|
|
43448
|
+
* ```
|
|
43449
|
+
*
|
|
43450
|
+
* @see {@link VerificationRegistrantDetails} - The TypeScript type definition
|
|
43451
|
+
* @see {@link KEYS_VERIFICATION_REGISTRANT_DETAILS} - Array of all keys for this type
|
|
43452
|
+
*/
|
|
43453
|
+
export const KEY_VERIFICATION_REGISTRANT_DETAILS_EMAIL: keyof VerificationRegistrantDetails = 'email';
|
|
43454
|
+
/**
|
|
43455
|
+
* Name
|
|
43456
|
+
*
|
|
43457
|
+
*
|
|
43458
|
+
* @type {string}
|
|
43459
|
+
*
|
|
43460
|
+
*
|
|
43461
|
+
* @remarks
|
|
43462
|
+
* This key constant provides type-safe access to the `name` property of VerificationRegistrantDetails objects.
|
|
43463
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
43464
|
+
*
|
|
43465
|
+
* @example
|
|
43466
|
+
* ```typescript
|
|
43467
|
+
* // Direct property access
|
|
43468
|
+
* const value = verificationregistrantdetails[KEY_VERIFICATION_REGISTRANT_DETAILS_NAME];
|
|
43469
|
+
*
|
|
43470
|
+
* // Dynamic property access
|
|
43471
|
+
* const propertyName = KEY_VERIFICATION_REGISTRANT_DETAILS_NAME;
|
|
43472
|
+
* const value = verificationregistrantdetails[propertyName];
|
|
43473
|
+
* ```
|
|
43474
|
+
*
|
|
43475
|
+
* @see {@link VerificationRegistrantDetails} - The TypeScript type definition
|
|
43476
|
+
* @see {@link KEYS_VERIFICATION_REGISTRANT_DETAILS} - Array of all keys for this type
|
|
43477
|
+
*/
|
|
43478
|
+
export const KEY_VERIFICATION_REGISTRANT_DETAILS_NAME: keyof VerificationRegistrantDetails = 'name';
|
|
43479
|
+
|
|
43480
|
+
/**
|
|
43481
|
+
* Array of all VerificationRegistrantDetails property keys
|
|
43482
|
+
*
|
|
43483
|
+
* @remarks
|
|
43484
|
+
* This constant provides a readonly array containing all valid property keys for VerificationRegistrantDetails objects.
|
|
43485
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
43486
|
+
*
|
|
43487
|
+
* @example
|
|
43488
|
+
* ```typescript
|
|
43489
|
+
* // Iterating through all keys
|
|
43490
|
+
* for (const key of KEYS_VERIFICATION_REGISTRANT_DETAILS) {
|
|
43491
|
+
* console.log(`Property: ${key}, Value: ${verificationregistrantdetails[key]}`);
|
|
43492
|
+
* }
|
|
43493
|
+
*
|
|
43494
|
+
* // Validation
|
|
43495
|
+
* const isValidKey = KEYS_VERIFICATION_REGISTRANT_DETAILS.includes(someKey);
|
|
43496
|
+
* ```
|
|
43497
|
+
*
|
|
43498
|
+
* @see {@link VerificationRegistrantDetails} - The TypeScript type definition
|
|
43499
|
+
*/
|
|
43500
|
+
export const KEYS_VERIFICATION_REGISTRANT_DETAILS = [
|
|
43501
|
+
KEY_VERIFICATION_REGISTRANT_DETAILS_CONTACT_ID,
|
|
43502
|
+
KEY_VERIFICATION_REGISTRANT_DETAILS_EMAIL,
|
|
43503
|
+
KEY_VERIFICATION_REGISTRANT_DETAILS_NAME,
|
|
43504
|
+
] as const satisfies (keyof VerificationRegistrantDetails)[];
|
|
43505
|
+
|
|
43232
43506
|
/**
|
|
43233
43507
|
* Key
|
|
43234
43508
|
*
|