@opusdns/api 0.199.0 → 0.201.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 +1334 -165
- package/src/helpers/requests.d.ts +243 -2
- package/src/helpers/responses.d.ts +446 -6
- package/src/helpers/schemas-arrays.d.ts +34 -6
- package/src/helpers/schemas.d.ts +118 -6
- package/src/openapi.yaml +654 -7
- package/src/schema.d.ts +609 -9
package/src/helpers/keys.ts
CHANGED
|
@@ -36,8 +36,14 @@ import { BillingPlan } from './schemas';
|
|
|
36
36
|
import { BillingTransaction } from './schemas';
|
|
37
37
|
import { BrowserStatsBucket } from './schemas';
|
|
38
38
|
import { ContactAttributeDefinition } from './schemas';
|
|
39
|
+
import { ContactAttributeLinkDetail } from './schemas';
|
|
40
|
+
import { ContactAttributeLink } from './schemas';
|
|
41
|
+
import { ContactAttributeSetCreate } from './schemas';
|
|
42
|
+
import { ContactAttributeSet } from './schemas';
|
|
43
|
+
import { ContactAttributeSetUpdate } from './schemas';
|
|
39
44
|
import { ContactConfigBase } from './schemas';
|
|
40
45
|
import { ContactCreate } from './schemas';
|
|
46
|
+
import { ContactDetail } from './schemas';
|
|
41
47
|
import { ContactHandle } from './schemas';
|
|
42
48
|
import { Contact } from './schemas';
|
|
43
49
|
import { ContactSchema } from './schemas';
|
|
@@ -1325,162 +1331,1294 @@ export const KEYS_CONTACT_ATTRIBUTE_DEFINITION = [
|
|
|
1325
1331
|
KEY_CONTACT_ATTRIBUTE_DEFINITION_VALUES,
|
|
1326
1332
|
] as const satisfies (keyof ContactAttributeDefinition)[];
|
|
1327
1333
|
|
|
1334
|
+
/**
|
|
1335
|
+
* Attributes
|
|
1336
|
+
*
|
|
1337
|
+
* The attributes from the linked set
|
|
1338
|
+
*
|
|
1339
|
+
* @type {object}
|
|
1340
|
+
*
|
|
1341
|
+
*
|
|
1342
|
+
* @remarks
|
|
1343
|
+
* This key constant provides type-safe access to the `attributes` property of ContactAttributeLinkDetail objects.
|
|
1344
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1345
|
+
*
|
|
1346
|
+
* @example
|
|
1347
|
+
* ```typescript
|
|
1348
|
+
* // Direct property access
|
|
1349
|
+
* const value = contactattributelinkdetail[KEY_CONTACT_ATTRIBUTE_LINK_DETAIL_ATTRIBUTES];
|
|
1350
|
+
*
|
|
1351
|
+
* // Dynamic property access
|
|
1352
|
+
* const propertyName = KEY_CONTACT_ATTRIBUTE_LINK_DETAIL_ATTRIBUTES;
|
|
1353
|
+
* const value = contactattributelinkdetail[propertyName];
|
|
1354
|
+
* ```
|
|
1355
|
+
*
|
|
1356
|
+
* @see {@link ContactAttributeLinkDetail} - The TypeScript type definition
|
|
1357
|
+
* @see {@link KEYS_CONTACT_ATTRIBUTE_LINK_DETAIL} - Array of all keys for this type
|
|
1358
|
+
*/
|
|
1359
|
+
export const KEY_CONTACT_ATTRIBUTE_LINK_DETAIL_ATTRIBUTES: keyof ContactAttributeLinkDetail = 'attributes';
|
|
1360
|
+
/**
|
|
1361
|
+
* Contact Attribute Set Id
|
|
1362
|
+
*
|
|
1363
|
+
* The attribute set linked to the contact
|
|
1364
|
+
*
|
|
1365
|
+
* @type {string}
|
|
1366
|
+
*
|
|
1367
|
+
*
|
|
1368
|
+
* @remarks
|
|
1369
|
+
* This key constant provides type-safe access to the `contact_attribute_set_id` property of ContactAttributeLinkDetail objects.
|
|
1370
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1371
|
+
*
|
|
1372
|
+
* @example
|
|
1373
|
+
* ```typescript
|
|
1374
|
+
* // Direct property access
|
|
1375
|
+
* const value = contactattributelinkdetail[KEY_CONTACT_ATTRIBUTE_LINK_DETAIL_CONTACT_ATTRIBUTE_SET_ID];
|
|
1376
|
+
*
|
|
1377
|
+
* // Dynamic property access
|
|
1378
|
+
* const propertyName = KEY_CONTACT_ATTRIBUTE_LINK_DETAIL_CONTACT_ATTRIBUTE_SET_ID;
|
|
1379
|
+
* const value = contactattributelinkdetail[propertyName];
|
|
1380
|
+
* ```
|
|
1381
|
+
*
|
|
1382
|
+
* @see {@link ContactAttributeLinkDetail} - The TypeScript type definition
|
|
1383
|
+
* @see {@link KEYS_CONTACT_ATTRIBUTE_LINK_DETAIL} - Array of all keys for this type
|
|
1384
|
+
*/
|
|
1385
|
+
export const KEY_CONTACT_ATTRIBUTE_LINK_DETAIL_CONTACT_ATTRIBUTE_SET_ID: keyof ContactAttributeLinkDetail = 'contact_attribute_set_id';
|
|
1386
|
+
/**
|
|
1387
|
+
* Label
|
|
1388
|
+
*
|
|
1389
|
+
* The label of the linked attribute set
|
|
1390
|
+
*
|
|
1391
|
+
* @type {string}
|
|
1392
|
+
*
|
|
1393
|
+
*
|
|
1394
|
+
* @remarks
|
|
1395
|
+
* This key constant provides type-safe access to the `label` property of ContactAttributeLinkDetail objects.
|
|
1396
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1397
|
+
*
|
|
1398
|
+
* @example
|
|
1399
|
+
* ```typescript
|
|
1400
|
+
* // Direct property access
|
|
1401
|
+
* const value = contactattributelinkdetail[KEY_CONTACT_ATTRIBUTE_LINK_DETAIL_LABEL];
|
|
1402
|
+
*
|
|
1403
|
+
* // Dynamic property access
|
|
1404
|
+
* const propertyName = KEY_CONTACT_ATTRIBUTE_LINK_DETAIL_LABEL;
|
|
1405
|
+
* const value = contactattributelinkdetail[propertyName];
|
|
1406
|
+
* ```
|
|
1407
|
+
*
|
|
1408
|
+
* @see {@link ContactAttributeLinkDetail} - The TypeScript type definition
|
|
1409
|
+
* @see {@link KEYS_CONTACT_ATTRIBUTE_LINK_DETAIL} - Array of all keys for this type
|
|
1410
|
+
*/
|
|
1411
|
+
export const KEY_CONTACT_ATTRIBUTE_LINK_DETAIL_LABEL: keyof ContactAttributeLinkDetail = 'label';
|
|
1412
|
+
/**
|
|
1413
|
+
* Tld
|
|
1414
|
+
*
|
|
1415
|
+
* The TLD this link applies to
|
|
1416
|
+
*
|
|
1417
|
+
* @type {string}
|
|
1418
|
+
*
|
|
1419
|
+
*
|
|
1420
|
+
* @remarks
|
|
1421
|
+
* This key constant provides type-safe access to the `tld` property of ContactAttributeLinkDetail objects.
|
|
1422
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1423
|
+
*
|
|
1424
|
+
* @example
|
|
1425
|
+
* ```typescript
|
|
1426
|
+
* // Direct property access
|
|
1427
|
+
* const value = contactattributelinkdetail[KEY_CONTACT_ATTRIBUTE_LINK_DETAIL_TLD];
|
|
1428
|
+
*
|
|
1429
|
+
* // Dynamic property access
|
|
1430
|
+
* const propertyName = KEY_CONTACT_ATTRIBUTE_LINK_DETAIL_TLD;
|
|
1431
|
+
* const value = contactattributelinkdetail[propertyName];
|
|
1432
|
+
* ```
|
|
1433
|
+
*
|
|
1434
|
+
* @see {@link ContactAttributeLinkDetail} - The TypeScript type definition
|
|
1435
|
+
* @see {@link KEYS_CONTACT_ATTRIBUTE_LINK_DETAIL} - Array of all keys for this type
|
|
1436
|
+
*/
|
|
1437
|
+
export const KEY_CONTACT_ATTRIBUTE_LINK_DETAIL_TLD: keyof ContactAttributeLinkDetail = 'tld';
|
|
1438
|
+
|
|
1439
|
+
/**
|
|
1440
|
+
* Array of all ContactAttributeLinkDetail property keys
|
|
1441
|
+
*
|
|
1442
|
+
* @remarks
|
|
1443
|
+
* This constant provides a readonly array containing all valid property keys for ContactAttributeLinkDetail objects.
|
|
1444
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
1445
|
+
*
|
|
1446
|
+
* @example
|
|
1447
|
+
* ```typescript
|
|
1448
|
+
* // Iterating through all keys
|
|
1449
|
+
* for (const key of KEYS_CONTACT_ATTRIBUTE_LINK_DETAIL) {
|
|
1450
|
+
* console.log(`Property: ${key}, Value: ${contactattributelinkdetail[key]}`);
|
|
1451
|
+
* }
|
|
1452
|
+
*
|
|
1453
|
+
* // Validation
|
|
1454
|
+
* const isValidKey = KEYS_CONTACT_ATTRIBUTE_LINK_DETAIL.includes(someKey);
|
|
1455
|
+
* ```
|
|
1456
|
+
*
|
|
1457
|
+
* @see {@link ContactAttributeLinkDetail} - The TypeScript type definition
|
|
1458
|
+
*/
|
|
1459
|
+
export const KEYS_CONTACT_ATTRIBUTE_LINK_DETAIL = [
|
|
1460
|
+
KEY_CONTACT_ATTRIBUTE_LINK_DETAIL_ATTRIBUTES,
|
|
1461
|
+
KEY_CONTACT_ATTRIBUTE_LINK_DETAIL_CONTACT_ATTRIBUTE_SET_ID,
|
|
1462
|
+
KEY_CONTACT_ATTRIBUTE_LINK_DETAIL_LABEL,
|
|
1463
|
+
KEY_CONTACT_ATTRIBUTE_LINK_DETAIL_TLD,
|
|
1464
|
+
] as const satisfies (keyof ContactAttributeLinkDetail)[];
|
|
1465
|
+
|
|
1466
|
+
/**
|
|
1467
|
+
* Contact Attribute Link Id
|
|
1468
|
+
*
|
|
1469
|
+
* The unique identifier of the link
|
|
1470
|
+
*
|
|
1471
|
+
* @type {string}
|
|
1472
|
+
*
|
|
1473
|
+
*
|
|
1474
|
+
* @remarks
|
|
1475
|
+
* This key constant provides type-safe access to the `contact_attribute_link_id` property of ContactAttributeLink objects.
|
|
1476
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1477
|
+
*
|
|
1478
|
+
* @example
|
|
1479
|
+
* ```typescript
|
|
1480
|
+
* // Direct property access
|
|
1481
|
+
* const value = contactattributelink[KEY_CONTACT_ATTRIBUTE_LINK_CONTACT_ATTRIBUTE_LINK_ID];
|
|
1482
|
+
*
|
|
1483
|
+
* // Dynamic property access
|
|
1484
|
+
* const propertyName = KEY_CONTACT_ATTRIBUTE_LINK_CONTACT_ATTRIBUTE_LINK_ID;
|
|
1485
|
+
* const value = contactattributelink[propertyName];
|
|
1486
|
+
* ```
|
|
1487
|
+
*
|
|
1488
|
+
* @see {@link ContactAttributeLink} - The TypeScript type definition
|
|
1489
|
+
* @see {@link KEYS_CONTACT_ATTRIBUTE_LINK} - Array of all keys for this type
|
|
1490
|
+
*/
|
|
1491
|
+
export const KEY_CONTACT_ATTRIBUTE_LINK_CONTACT_ATTRIBUTE_LINK_ID: keyof ContactAttributeLink = 'contact_attribute_link_id';
|
|
1492
|
+
/**
|
|
1493
|
+
* Contact Attribute Set Id
|
|
1494
|
+
*
|
|
1495
|
+
* The attribute set linked to the contact
|
|
1496
|
+
*
|
|
1497
|
+
* @type {string}
|
|
1498
|
+
*
|
|
1499
|
+
*
|
|
1500
|
+
* @remarks
|
|
1501
|
+
* This key constant provides type-safe access to the `contact_attribute_set_id` property of ContactAttributeLink objects.
|
|
1502
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1503
|
+
*
|
|
1504
|
+
* @example
|
|
1505
|
+
* ```typescript
|
|
1506
|
+
* // Direct property access
|
|
1507
|
+
* const value = contactattributelink[KEY_CONTACT_ATTRIBUTE_LINK_CONTACT_ATTRIBUTE_SET_ID];
|
|
1508
|
+
*
|
|
1509
|
+
* // Dynamic property access
|
|
1510
|
+
* const propertyName = KEY_CONTACT_ATTRIBUTE_LINK_CONTACT_ATTRIBUTE_SET_ID;
|
|
1511
|
+
* const value = contactattributelink[propertyName];
|
|
1512
|
+
* ```
|
|
1513
|
+
*
|
|
1514
|
+
* @see {@link ContactAttributeLink} - The TypeScript type definition
|
|
1515
|
+
* @see {@link KEYS_CONTACT_ATTRIBUTE_LINK} - Array of all keys for this type
|
|
1516
|
+
*/
|
|
1517
|
+
export const KEY_CONTACT_ATTRIBUTE_LINK_CONTACT_ATTRIBUTE_SET_ID: keyof ContactAttributeLink = 'contact_attribute_set_id';
|
|
1518
|
+
/**
|
|
1519
|
+
* Contact Id
|
|
1520
|
+
*
|
|
1521
|
+
* The contact this link belongs to
|
|
1522
|
+
*
|
|
1523
|
+
* @type {string}
|
|
1524
|
+
*
|
|
1525
|
+
*
|
|
1526
|
+
* @remarks
|
|
1527
|
+
* This key constant provides type-safe access to the `contact_id` property of ContactAttributeLink objects.
|
|
1528
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1529
|
+
*
|
|
1530
|
+
* @example
|
|
1531
|
+
* ```typescript
|
|
1532
|
+
* // Direct property access
|
|
1533
|
+
* const value = contactattributelink[KEY_CONTACT_ATTRIBUTE_LINK_CONTACT_ID];
|
|
1534
|
+
*
|
|
1535
|
+
* // Dynamic property access
|
|
1536
|
+
* const propertyName = KEY_CONTACT_ATTRIBUTE_LINK_CONTACT_ID;
|
|
1537
|
+
* const value = contactattributelink[propertyName];
|
|
1538
|
+
* ```
|
|
1539
|
+
*
|
|
1540
|
+
* @see {@link ContactAttributeLink} - The TypeScript type definition
|
|
1541
|
+
* @see {@link KEYS_CONTACT_ATTRIBUTE_LINK} - Array of all keys for this type
|
|
1542
|
+
*/
|
|
1543
|
+
export const KEY_CONTACT_ATTRIBUTE_LINK_CONTACT_ID: keyof ContactAttributeLink = 'contact_id';
|
|
1544
|
+
/**
|
|
1545
|
+
* Created On
|
|
1546
|
+
*
|
|
1547
|
+
* The date/time the entry was created on
|
|
1548
|
+
*
|
|
1549
|
+
* @type {string}
|
|
1550
|
+
*
|
|
1551
|
+
*
|
|
1552
|
+
* @remarks
|
|
1553
|
+
* This key constant provides type-safe access to the `created_on` property of ContactAttributeLink objects.
|
|
1554
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1555
|
+
*
|
|
1556
|
+
* @example
|
|
1557
|
+
* ```typescript
|
|
1558
|
+
* // Direct property access
|
|
1559
|
+
* const value = contactattributelink[KEY_CONTACT_ATTRIBUTE_LINK_CREATED_ON];
|
|
1560
|
+
*
|
|
1561
|
+
* // Dynamic property access
|
|
1562
|
+
* const propertyName = KEY_CONTACT_ATTRIBUTE_LINK_CREATED_ON;
|
|
1563
|
+
* const value = contactattributelink[propertyName];
|
|
1564
|
+
* ```
|
|
1565
|
+
*
|
|
1566
|
+
* @see {@link ContactAttributeLink} - The TypeScript type definition
|
|
1567
|
+
* @see {@link KEYS_CONTACT_ATTRIBUTE_LINK} - Array of all keys for this type
|
|
1568
|
+
*/
|
|
1569
|
+
export const KEY_CONTACT_ATTRIBUTE_LINK_CREATED_ON: keyof ContactAttributeLink = 'created_on';
|
|
1570
|
+
/**
|
|
1571
|
+
* Tld
|
|
1572
|
+
*
|
|
1573
|
+
* The TLD this link applies to
|
|
1574
|
+
*
|
|
1575
|
+
* @type {string}
|
|
1576
|
+
*
|
|
1577
|
+
*
|
|
1578
|
+
* @remarks
|
|
1579
|
+
* This key constant provides type-safe access to the `tld` property of ContactAttributeLink objects.
|
|
1580
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1581
|
+
*
|
|
1582
|
+
* @example
|
|
1583
|
+
* ```typescript
|
|
1584
|
+
* // Direct property access
|
|
1585
|
+
* const value = contactattributelink[KEY_CONTACT_ATTRIBUTE_LINK_TLD];
|
|
1586
|
+
*
|
|
1587
|
+
* // Dynamic property access
|
|
1588
|
+
* const propertyName = KEY_CONTACT_ATTRIBUTE_LINK_TLD;
|
|
1589
|
+
* const value = contactattributelink[propertyName];
|
|
1590
|
+
* ```
|
|
1591
|
+
*
|
|
1592
|
+
* @see {@link ContactAttributeLink} - The TypeScript type definition
|
|
1593
|
+
* @see {@link KEYS_CONTACT_ATTRIBUTE_LINK} - Array of all keys for this type
|
|
1594
|
+
*/
|
|
1595
|
+
export const KEY_CONTACT_ATTRIBUTE_LINK_TLD: keyof ContactAttributeLink = 'tld';
|
|
1596
|
+
|
|
1597
|
+
/**
|
|
1598
|
+
* Array of all ContactAttributeLink property keys
|
|
1599
|
+
*
|
|
1600
|
+
* @remarks
|
|
1601
|
+
* This constant provides a readonly array containing all valid property keys for ContactAttributeLink objects.
|
|
1602
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
1603
|
+
*
|
|
1604
|
+
* @example
|
|
1605
|
+
* ```typescript
|
|
1606
|
+
* // Iterating through all keys
|
|
1607
|
+
* for (const key of KEYS_CONTACT_ATTRIBUTE_LINK) {
|
|
1608
|
+
* console.log(`Property: ${key}, Value: ${contactattributelink[key]}`);
|
|
1609
|
+
* }
|
|
1610
|
+
*
|
|
1611
|
+
* // Validation
|
|
1612
|
+
* const isValidKey = KEYS_CONTACT_ATTRIBUTE_LINK.includes(someKey);
|
|
1613
|
+
* ```
|
|
1614
|
+
*
|
|
1615
|
+
* @see {@link ContactAttributeLink} - The TypeScript type definition
|
|
1616
|
+
*/
|
|
1617
|
+
export const KEYS_CONTACT_ATTRIBUTE_LINK = [
|
|
1618
|
+
KEY_CONTACT_ATTRIBUTE_LINK_CONTACT_ATTRIBUTE_LINK_ID,
|
|
1619
|
+
KEY_CONTACT_ATTRIBUTE_LINK_CONTACT_ATTRIBUTE_SET_ID,
|
|
1620
|
+
KEY_CONTACT_ATTRIBUTE_LINK_CONTACT_ID,
|
|
1621
|
+
KEY_CONTACT_ATTRIBUTE_LINK_CREATED_ON,
|
|
1622
|
+
KEY_CONTACT_ATTRIBUTE_LINK_TLD,
|
|
1623
|
+
] as const satisfies (keyof ContactAttributeLink)[];
|
|
1624
|
+
|
|
1625
|
+
/**
|
|
1626
|
+
* Attributes
|
|
1627
|
+
*
|
|
1628
|
+
* Key-value map of contact attributes for this set
|
|
1629
|
+
*
|
|
1630
|
+
* @type {object}
|
|
1631
|
+
*
|
|
1632
|
+
*
|
|
1633
|
+
* @remarks
|
|
1634
|
+
* This key constant provides type-safe access to the `attributes` property of ContactAttributeSetCreate objects.
|
|
1635
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1636
|
+
*
|
|
1637
|
+
* @example
|
|
1638
|
+
* ```typescript
|
|
1639
|
+
* // Direct property access
|
|
1640
|
+
* const value = contactattributesetcreate[KEY_CONTACT_ATTRIBUTE_SET_CREATE_ATTRIBUTES];
|
|
1641
|
+
*
|
|
1642
|
+
* // Dynamic property access
|
|
1643
|
+
* const propertyName = KEY_CONTACT_ATTRIBUTE_SET_CREATE_ATTRIBUTES;
|
|
1644
|
+
* const value = contactattributesetcreate[propertyName];
|
|
1645
|
+
* ```
|
|
1646
|
+
*
|
|
1647
|
+
* @see {@link ContactAttributeSetCreate} - The TypeScript type definition
|
|
1648
|
+
* @see {@link KEYS_CONTACT_ATTRIBUTE_SET_CREATE} - Array of all keys for this type
|
|
1649
|
+
*/
|
|
1650
|
+
export const KEY_CONTACT_ATTRIBUTE_SET_CREATE_ATTRIBUTES: keyof ContactAttributeSetCreate = 'attributes';
|
|
1651
|
+
/**
|
|
1652
|
+
* Label
|
|
1653
|
+
*
|
|
1654
|
+
* A human-readable label explaining the purpose of this attribute set
|
|
1655
|
+
*
|
|
1656
|
+
* @type {string}
|
|
1657
|
+
*
|
|
1658
|
+
*
|
|
1659
|
+
* @remarks
|
|
1660
|
+
* This key constant provides type-safe access to the `label` property of ContactAttributeSetCreate objects.
|
|
1661
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1662
|
+
*
|
|
1663
|
+
* @example
|
|
1664
|
+
* ```typescript
|
|
1665
|
+
* // Direct property access
|
|
1666
|
+
* const value = contactattributesetcreate[KEY_CONTACT_ATTRIBUTE_SET_CREATE_LABEL];
|
|
1667
|
+
*
|
|
1668
|
+
* // Dynamic property access
|
|
1669
|
+
* const propertyName = KEY_CONTACT_ATTRIBUTE_SET_CREATE_LABEL;
|
|
1670
|
+
* const value = contactattributesetcreate[propertyName];
|
|
1671
|
+
* ```
|
|
1672
|
+
*
|
|
1673
|
+
* @see {@link ContactAttributeSetCreate} - The TypeScript type definition
|
|
1674
|
+
* @see {@link KEYS_CONTACT_ATTRIBUTE_SET_CREATE} - Array of all keys for this type
|
|
1675
|
+
*/
|
|
1676
|
+
export const KEY_CONTACT_ATTRIBUTE_SET_CREATE_LABEL: keyof ContactAttributeSetCreate = 'label';
|
|
1677
|
+
/**
|
|
1678
|
+
* Tld
|
|
1679
|
+
*
|
|
1680
|
+
* The TLD this attribute set applies to (e.g. 'de', '.de', 'DE')
|
|
1681
|
+
*
|
|
1682
|
+
* @type {string}
|
|
1683
|
+
*
|
|
1684
|
+
*
|
|
1685
|
+
* @remarks
|
|
1686
|
+
* This key constant provides type-safe access to the `tld` property of ContactAttributeSetCreate objects.
|
|
1687
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1688
|
+
*
|
|
1689
|
+
* @example
|
|
1690
|
+
* ```typescript
|
|
1691
|
+
* // Direct property access
|
|
1692
|
+
* const value = contactattributesetcreate[KEY_CONTACT_ATTRIBUTE_SET_CREATE_TLD];
|
|
1693
|
+
*
|
|
1694
|
+
* // Dynamic property access
|
|
1695
|
+
* const propertyName = KEY_CONTACT_ATTRIBUTE_SET_CREATE_TLD;
|
|
1696
|
+
* const value = contactattributesetcreate[propertyName];
|
|
1697
|
+
* ```
|
|
1698
|
+
*
|
|
1699
|
+
* @see {@link ContactAttributeSetCreate} - The TypeScript type definition
|
|
1700
|
+
* @see {@link KEYS_CONTACT_ATTRIBUTE_SET_CREATE} - Array of all keys for this type
|
|
1701
|
+
*/
|
|
1702
|
+
export const KEY_CONTACT_ATTRIBUTE_SET_CREATE_TLD: keyof ContactAttributeSetCreate = 'tld';
|
|
1703
|
+
|
|
1704
|
+
/**
|
|
1705
|
+
* Array of all ContactAttributeSetCreate property keys
|
|
1706
|
+
*
|
|
1707
|
+
* @remarks
|
|
1708
|
+
* This constant provides a readonly array containing all valid property keys for ContactAttributeSetCreate objects.
|
|
1709
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
1710
|
+
*
|
|
1711
|
+
* @example
|
|
1712
|
+
* ```typescript
|
|
1713
|
+
* // Iterating through all keys
|
|
1714
|
+
* for (const key of KEYS_CONTACT_ATTRIBUTE_SET_CREATE) {
|
|
1715
|
+
* console.log(`Property: ${key}, Value: ${contactattributesetcreate[key]}`);
|
|
1716
|
+
* }
|
|
1717
|
+
*
|
|
1718
|
+
* // Validation
|
|
1719
|
+
* const isValidKey = KEYS_CONTACT_ATTRIBUTE_SET_CREATE.includes(someKey);
|
|
1720
|
+
* ```
|
|
1721
|
+
*
|
|
1722
|
+
* @see {@link ContactAttributeSetCreate} - The TypeScript type definition
|
|
1723
|
+
*/
|
|
1724
|
+
export const KEYS_CONTACT_ATTRIBUTE_SET_CREATE = [
|
|
1725
|
+
KEY_CONTACT_ATTRIBUTE_SET_CREATE_ATTRIBUTES,
|
|
1726
|
+
KEY_CONTACT_ATTRIBUTE_SET_CREATE_LABEL,
|
|
1727
|
+
KEY_CONTACT_ATTRIBUTE_SET_CREATE_TLD,
|
|
1728
|
+
] as const satisfies (keyof ContactAttributeSetCreate)[];
|
|
1729
|
+
|
|
1730
|
+
/**
|
|
1731
|
+
* Attributes
|
|
1732
|
+
*
|
|
1733
|
+
* Key-value map of contact attributes for this set
|
|
1734
|
+
*
|
|
1735
|
+
* @type {object}
|
|
1736
|
+
*
|
|
1737
|
+
*
|
|
1738
|
+
* @remarks
|
|
1739
|
+
* This key constant provides type-safe access to the `attributes` property of ContactAttributeSet objects.
|
|
1740
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1741
|
+
*
|
|
1742
|
+
* @example
|
|
1743
|
+
* ```typescript
|
|
1744
|
+
* // Direct property access
|
|
1745
|
+
* const value = contactattributeset[KEY_CONTACT_ATTRIBUTE_SET_ATTRIBUTES];
|
|
1746
|
+
*
|
|
1747
|
+
* // Dynamic property access
|
|
1748
|
+
* const propertyName = KEY_CONTACT_ATTRIBUTE_SET_ATTRIBUTES;
|
|
1749
|
+
* const value = contactattributeset[propertyName];
|
|
1750
|
+
* ```
|
|
1751
|
+
*
|
|
1752
|
+
* @see {@link ContactAttributeSet} - The TypeScript type definition
|
|
1753
|
+
* @see {@link KEYS_CONTACT_ATTRIBUTE_SET} - Array of all keys for this type
|
|
1754
|
+
*/
|
|
1755
|
+
export const KEY_CONTACT_ATTRIBUTE_SET_ATTRIBUTES: keyof ContactAttributeSet = 'attributes';
|
|
1756
|
+
/**
|
|
1757
|
+
* Contact Attribute Set Id
|
|
1758
|
+
*
|
|
1759
|
+
* The unique identifier of the attribute set
|
|
1760
|
+
*
|
|
1761
|
+
* @type {string}
|
|
1762
|
+
*
|
|
1763
|
+
*
|
|
1764
|
+
* @remarks
|
|
1765
|
+
* This key constant provides type-safe access to the `contact_attribute_set_id` property of ContactAttributeSet objects.
|
|
1766
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1767
|
+
*
|
|
1768
|
+
* @example
|
|
1769
|
+
* ```typescript
|
|
1770
|
+
* // Direct property access
|
|
1771
|
+
* const value = contactattributeset[KEY_CONTACT_ATTRIBUTE_SET_CONTACT_ATTRIBUTE_SET_ID];
|
|
1772
|
+
*
|
|
1773
|
+
* // Dynamic property access
|
|
1774
|
+
* const propertyName = KEY_CONTACT_ATTRIBUTE_SET_CONTACT_ATTRIBUTE_SET_ID;
|
|
1775
|
+
* const value = contactattributeset[propertyName];
|
|
1776
|
+
* ```
|
|
1777
|
+
*
|
|
1778
|
+
* @see {@link ContactAttributeSet} - The TypeScript type definition
|
|
1779
|
+
* @see {@link KEYS_CONTACT_ATTRIBUTE_SET} - Array of all keys for this type
|
|
1780
|
+
*/
|
|
1781
|
+
export const KEY_CONTACT_ATTRIBUTE_SET_CONTACT_ATTRIBUTE_SET_ID: keyof ContactAttributeSet = 'contact_attribute_set_id';
|
|
1782
|
+
/**
|
|
1783
|
+
* Created On
|
|
1784
|
+
*
|
|
1785
|
+
* The date/time the entry was created on
|
|
1786
|
+
*
|
|
1787
|
+
* @type {string}
|
|
1788
|
+
*
|
|
1789
|
+
*
|
|
1790
|
+
* @remarks
|
|
1791
|
+
* This key constant provides type-safe access to the `created_on` property of ContactAttributeSet objects.
|
|
1792
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1793
|
+
*
|
|
1794
|
+
* @example
|
|
1795
|
+
* ```typescript
|
|
1796
|
+
* // Direct property access
|
|
1797
|
+
* const value = contactattributeset[KEY_CONTACT_ATTRIBUTE_SET_CREATED_ON];
|
|
1798
|
+
*
|
|
1799
|
+
* // Dynamic property access
|
|
1800
|
+
* const propertyName = KEY_CONTACT_ATTRIBUTE_SET_CREATED_ON;
|
|
1801
|
+
* const value = contactattributeset[propertyName];
|
|
1802
|
+
* ```
|
|
1803
|
+
*
|
|
1804
|
+
* @see {@link ContactAttributeSet} - The TypeScript type definition
|
|
1805
|
+
* @see {@link KEYS_CONTACT_ATTRIBUTE_SET} - Array of all keys for this type
|
|
1806
|
+
*/
|
|
1807
|
+
export const KEY_CONTACT_ATTRIBUTE_SET_CREATED_ON: keyof ContactAttributeSet = 'created_on';
|
|
1808
|
+
/**
|
|
1809
|
+
* Label
|
|
1810
|
+
*
|
|
1811
|
+
* A human-readable label explaining the purpose of this attribute set
|
|
1812
|
+
*
|
|
1813
|
+
* @type {string}
|
|
1814
|
+
*
|
|
1815
|
+
*
|
|
1816
|
+
* @remarks
|
|
1817
|
+
* This key constant provides type-safe access to the `label` property of ContactAttributeSet objects.
|
|
1818
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1819
|
+
*
|
|
1820
|
+
* @example
|
|
1821
|
+
* ```typescript
|
|
1822
|
+
* // Direct property access
|
|
1823
|
+
* const value = contactattributeset[KEY_CONTACT_ATTRIBUTE_SET_LABEL];
|
|
1824
|
+
*
|
|
1825
|
+
* // Dynamic property access
|
|
1826
|
+
* const propertyName = KEY_CONTACT_ATTRIBUTE_SET_LABEL;
|
|
1827
|
+
* const value = contactattributeset[propertyName];
|
|
1828
|
+
* ```
|
|
1829
|
+
*
|
|
1830
|
+
* @see {@link ContactAttributeSet} - The TypeScript type definition
|
|
1831
|
+
* @see {@link KEYS_CONTACT_ATTRIBUTE_SET} - Array of all keys for this type
|
|
1832
|
+
*/
|
|
1833
|
+
export const KEY_CONTACT_ATTRIBUTE_SET_LABEL: keyof ContactAttributeSet = 'label';
|
|
1834
|
+
/**
|
|
1835
|
+
* Organization Id
|
|
1836
|
+
*
|
|
1837
|
+
* The organization that owns this attribute set
|
|
1838
|
+
*
|
|
1839
|
+
* @type {string}
|
|
1840
|
+
*
|
|
1841
|
+
*
|
|
1842
|
+
* @remarks
|
|
1843
|
+
* This key constant provides type-safe access to the `organization_id` property of ContactAttributeSet objects.
|
|
1844
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1845
|
+
*
|
|
1846
|
+
* @example
|
|
1847
|
+
* ```typescript
|
|
1848
|
+
* // Direct property access
|
|
1849
|
+
* const value = contactattributeset[KEY_CONTACT_ATTRIBUTE_SET_ORGANIZATION_ID];
|
|
1850
|
+
*
|
|
1851
|
+
* // Dynamic property access
|
|
1852
|
+
* const propertyName = KEY_CONTACT_ATTRIBUTE_SET_ORGANIZATION_ID;
|
|
1853
|
+
* const value = contactattributeset[propertyName];
|
|
1854
|
+
* ```
|
|
1855
|
+
*
|
|
1856
|
+
* @see {@link ContactAttributeSet} - The TypeScript type definition
|
|
1857
|
+
* @see {@link KEYS_CONTACT_ATTRIBUTE_SET} - Array of all keys for this type
|
|
1858
|
+
*/
|
|
1859
|
+
export const KEY_CONTACT_ATTRIBUTE_SET_ORGANIZATION_ID: keyof ContactAttributeSet = 'organization_id';
|
|
1860
|
+
/**
|
|
1861
|
+
* Tld
|
|
1862
|
+
*
|
|
1863
|
+
* The TLD this attribute set applies to
|
|
1864
|
+
*
|
|
1865
|
+
* @type {string}
|
|
1866
|
+
*
|
|
1867
|
+
*
|
|
1868
|
+
* @remarks
|
|
1869
|
+
* This key constant provides type-safe access to the `tld` property of ContactAttributeSet objects.
|
|
1870
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1871
|
+
*
|
|
1872
|
+
* @example
|
|
1873
|
+
* ```typescript
|
|
1874
|
+
* // Direct property access
|
|
1875
|
+
* const value = contactattributeset[KEY_CONTACT_ATTRIBUTE_SET_TLD];
|
|
1876
|
+
*
|
|
1877
|
+
* // Dynamic property access
|
|
1878
|
+
* const propertyName = KEY_CONTACT_ATTRIBUTE_SET_TLD;
|
|
1879
|
+
* const value = contactattributeset[propertyName];
|
|
1880
|
+
* ```
|
|
1881
|
+
*
|
|
1882
|
+
* @see {@link ContactAttributeSet} - The TypeScript type definition
|
|
1883
|
+
* @see {@link KEYS_CONTACT_ATTRIBUTE_SET} - Array of all keys for this type
|
|
1884
|
+
*/
|
|
1885
|
+
export const KEY_CONTACT_ATTRIBUTE_SET_TLD: keyof ContactAttributeSet = 'tld';
|
|
1886
|
+
/**
|
|
1887
|
+
* Updated On
|
|
1888
|
+
*
|
|
1889
|
+
* The date/time the entry was last updated on
|
|
1890
|
+
*
|
|
1891
|
+
* @type {string}
|
|
1892
|
+
*
|
|
1893
|
+
*
|
|
1894
|
+
* @remarks
|
|
1895
|
+
* This key constant provides type-safe access to the `updated_on` property of ContactAttributeSet objects.
|
|
1896
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1897
|
+
*
|
|
1898
|
+
* @example
|
|
1899
|
+
* ```typescript
|
|
1900
|
+
* // Direct property access
|
|
1901
|
+
* const value = contactattributeset[KEY_CONTACT_ATTRIBUTE_SET_UPDATED_ON];
|
|
1902
|
+
*
|
|
1903
|
+
* // Dynamic property access
|
|
1904
|
+
* const propertyName = KEY_CONTACT_ATTRIBUTE_SET_UPDATED_ON;
|
|
1905
|
+
* const value = contactattributeset[propertyName];
|
|
1906
|
+
* ```
|
|
1907
|
+
*
|
|
1908
|
+
* @see {@link ContactAttributeSet} - The TypeScript type definition
|
|
1909
|
+
* @see {@link KEYS_CONTACT_ATTRIBUTE_SET} - Array of all keys for this type
|
|
1910
|
+
*/
|
|
1911
|
+
export const KEY_CONTACT_ATTRIBUTE_SET_UPDATED_ON: keyof ContactAttributeSet = 'updated_on';
|
|
1912
|
+
|
|
1913
|
+
/**
|
|
1914
|
+
* Array of all ContactAttributeSet property keys
|
|
1915
|
+
*
|
|
1916
|
+
* @remarks
|
|
1917
|
+
* This constant provides a readonly array containing all valid property keys for ContactAttributeSet objects.
|
|
1918
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
1919
|
+
*
|
|
1920
|
+
* @example
|
|
1921
|
+
* ```typescript
|
|
1922
|
+
* // Iterating through all keys
|
|
1923
|
+
* for (const key of KEYS_CONTACT_ATTRIBUTE_SET) {
|
|
1924
|
+
* console.log(`Property: ${key}, Value: ${contactattributeset[key]}`);
|
|
1925
|
+
* }
|
|
1926
|
+
*
|
|
1927
|
+
* // Validation
|
|
1928
|
+
* const isValidKey = KEYS_CONTACT_ATTRIBUTE_SET.includes(someKey);
|
|
1929
|
+
* ```
|
|
1930
|
+
*
|
|
1931
|
+
* @see {@link ContactAttributeSet} - The TypeScript type definition
|
|
1932
|
+
*/
|
|
1933
|
+
export const KEYS_CONTACT_ATTRIBUTE_SET = [
|
|
1934
|
+
KEY_CONTACT_ATTRIBUTE_SET_ATTRIBUTES,
|
|
1935
|
+
KEY_CONTACT_ATTRIBUTE_SET_CONTACT_ATTRIBUTE_SET_ID,
|
|
1936
|
+
KEY_CONTACT_ATTRIBUTE_SET_CREATED_ON,
|
|
1937
|
+
KEY_CONTACT_ATTRIBUTE_SET_LABEL,
|
|
1938
|
+
KEY_CONTACT_ATTRIBUTE_SET_ORGANIZATION_ID,
|
|
1939
|
+
KEY_CONTACT_ATTRIBUTE_SET_TLD,
|
|
1940
|
+
KEY_CONTACT_ATTRIBUTE_SET_UPDATED_ON,
|
|
1941
|
+
] as const satisfies (keyof ContactAttributeSet)[];
|
|
1942
|
+
|
|
1943
|
+
/**
|
|
1944
|
+
* Label
|
|
1945
|
+
*
|
|
1946
|
+
* A human-readable label explaining the purpose of this attribute set
|
|
1947
|
+
*
|
|
1948
|
+
*
|
|
1949
|
+
*
|
|
1950
|
+
* @remarks
|
|
1951
|
+
* This key constant provides type-safe access to the `label` property of ContactAttributeSetUpdate objects.
|
|
1952
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1953
|
+
*
|
|
1954
|
+
* @example
|
|
1955
|
+
* ```typescript
|
|
1956
|
+
* // Direct property access
|
|
1957
|
+
* const value = contactattributesetupdate[KEY_CONTACT_ATTRIBUTE_SET_UPDATE_LABEL];
|
|
1958
|
+
*
|
|
1959
|
+
* // Dynamic property access
|
|
1960
|
+
* const propertyName = KEY_CONTACT_ATTRIBUTE_SET_UPDATE_LABEL;
|
|
1961
|
+
* const value = contactattributesetupdate[propertyName];
|
|
1962
|
+
* ```
|
|
1963
|
+
*
|
|
1964
|
+
* @see {@link ContactAttributeSetUpdate} - The TypeScript type definition
|
|
1965
|
+
* @see {@link KEYS_CONTACT_ATTRIBUTE_SET_UPDATE} - Array of all keys for this type
|
|
1966
|
+
*/
|
|
1967
|
+
export const KEY_CONTACT_ATTRIBUTE_SET_UPDATE_LABEL: keyof ContactAttributeSetUpdate = 'label';
|
|
1968
|
+
|
|
1969
|
+
/**
|
|
1970
|
+
* Array of all ContactAttributeSetUpdate property keys
|
|
1971
|
+
*
|
|
1972
|
+
* @remarks
|
|
1973
|
+
* This constant provides a readonly array containing all valid property keys for ContactAttributeSetUpdate objects.
|
|
1974
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
1975
|
+
*
|
|
1976
|
+
* @example
|
|
1977
|
+
* ```typescript
|
|
1978
|
+
* // Iterating through all keys
|
|
1979
|
+
* for (const key of KEYS_CONTACT_ATTRIBUTE_SET_UPDATE) {
|
|
1980
|
+
* console.log(`Property: ${key}, Value: ${contactattributesetupdate[key]}`);
|
|
1981
|
+
* }
|
|
1982
|
+
*
|
|
1983
|
+
* // Validation
|
|
1984
|
+
* const isValidKey = KEYS_CONTACT_ATTRIBUTE_SET_UPDATE.includes(someKey);
|
|
1985
|
+
* ```
|
|
1986
|
+
*
|
|
1987
|
+
* @see {@link ContactAttributeSetUpdate} - The TypeScript type definition
|
|
1988
|
+
*/
|
|
1989
|
+
export const KEYS_CONTACT_ATTRIBUTE_SET_UPDATE = [
|
|
1990
|
+
KEY_CONTACT_ATTRIBUTE_SET_UPDATE_LABEL,
|
|
1991
|
+
] as const satisfies (keyof ContactAttributeSetUpdate)[];
|
|
1992
|
+
|
|
1328
1993
|
/**
|
|
1329
1994
|
* Max
|
|
1330
1995
|
*
|
|
1331
|
-
* Maximum contacts per domain name
|
|
1996
|
+
* Maximum contacts per domain name
|
|
1997
|
+
*
|
|
1998
|
+
* @type {integer}
|
|
1999
|
+
*
|
|
2000
|
+
*
|
|
2001
|
+
* @remarks
|
|
2002
|
+
* This key constant provides type-safe access to the `max` property of ContactConfigBase objects.
|
|
2003
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
2004
|
+
*
|
|
2005
|
+
* @example
|
|
2006
|
+
* ```typescript
|
|
2007
|
+
* // Direct property access
|
|
2008
|
+
* const value = contactconfigbase[KEY_CONTACT_CONFIG_BASE_MAX];
|
|
2009
|
+
*
|
|
2010
|
+
* // Dynamic property access
|
|
2011
|
+
* const propertyName = KEY_CONTACT_CONFIG_BASE_MAX;
|
|
2012
|
+
* const value = contactconfigbase[propertyName];
|
|
2013
|
+
* ```
|
|
2014
|
+
*
|
|
2015
|
+
* @see {@link ContactConfigBase} - The TypeScript type definition
|
|
2016
|
+
* @see {@link KEYS_CONTACT_CONFIG_BASE} - Array of all keys for this type
|
|
2017
|
+
*/
|
|
2018
|
+
export const KEY_CONTACT_CONFIG_BASE_MAX: keyof ContactConfigBase = 'max';
|
|
2019
|
+
/**
|
|
2020
|
+
* Min
|
|
2021
|
+
*
|
|
2022
|
+
* Minimum contacts per domain name
|
|
2023
|
+
*
|
|
2024
|
+
* @type {integer}
|
|
2025
|
+
*
|
|
2026
|
+
*
|
|
2027
|
+
* @remarks
|
|
2028
|
+
* This key constant provides type-safe access to the `min` property of ContactConfigBase objects.
|
|
2029
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
2030
|
+
*
|
|
2031
|
+
* @example
|
|
2032
|
+
* ```typescript
|
|
2033
|
+
* // Direct property access
|
|
2034
|
+
* const value = contactconfigbase[KEY_CONTACT_CONFIG_BASE_MIN];
|
|
2035
|
+
*
|
|
2036
|
+
* // Dynamic property access
|
|
2037
|
+
* const propertyName = KEY_CONTACT_CONFIG_BASE_MIN;
|
|
2038
|
+
* const value = contactconfigbase[propertyName];
|
|
2039
|
+
* ```
|
|
2040
|
+
*
|
|
2041
|
+
* @see {@link ContactConfigBase} - The TypeScript type definition
|
|
2042
|
+
* @see {@link KEYS_CONTACT_CONFIG_BASE} - Array of all keys for this type
|
|
2043
|
+
*/
|
|
2044
|
+
export const KEY_CONTACT_CONFIG_BASE_MIN: keyof ContactConfigBase = 'min';
|
|
2045
|
+
/**
|
|
2046
|
+
* type property
|
|
2047
|
+
*
|
|
2048
|
+
* The type of contact
|
|
2049
|
+
*
|
|
2050
|
+
*
|
|
2051
|
+
*
|
|
2052
|
+
* @remarks
|
|
2053
|
+
* This key constant provides type-safe access to the `type` property of ContactConfigBase objects.
|
|
2054
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
2055
|
+
*
|
|
2056
|
+
* @example
|
|
2057
|
+
* ```typescript
|
|
2058
|
+
* // Direct property access
|
|
2059
|
+
* const value = contactconfigbase[KEY_CONTACT_CONFIG_BASE_TYPE];
|
|
2060
|
+
*
|
|
2061
|
+
* // Dynamic property access
|
|
2062
|
+
* const propertyName = KEY_CONTACT_CONFIG_BASE_TYPE;
|
|
2063
|
+
* const value = contactconfigbase[propertyName];
|
|
2064
|
+
* ```
|
|
2065
|
+
*
|
|
2066
|
+
* @see {@link ContactConfigBase} - The TypeScript type definition
|
|
2067
|
+
* @see {@link KEYS_CONTACT_CONFIG_BASE} - Array of all keys for this type
|
|
2068
|
+
*/
|
|
2069
|
+
export const KEY_CONTACT_CONFIG_BASE_TYPE: keyof ContactConfigBase = 'type';
|
|
2070
|
+
|
|
2071
|
+
/**
|
|
2072
|
+
* Array of all ContactConfigBase property keys
|
|
2073
|
+
*
|
|
2074
|
+
* @remarks
|
|
2075
|
+
* This constant provides a readonly array containing all valid property keys for ContactConfigBase objects.
|
|
2076
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
2077
|
+
*
|
|
2078
|
+
* @example
|
|
2079
|
+
* ```typescript
|
|
2080
|
+
* // Iterating through all keys
|
|
2081
|
+
* for (const key of KEYS_CONTACT_CONFIG_BASE) {
|
|
2082
|
+
* console.log(`Property: ${key}, Value: ${contactconfigbase[key]}`);
|
|
2083
|
+
* }
|
|
2084
|
+
*
|
|
2085
|
+
* // Validation
|
|
2086
|
+
* const isValidKey = KEYS_CONTACT_CONFIG_BASE.includes(someKey);
|
|
2087
|
+
* ```
|
|
2088
|
+
*
|
|
2089
|
+
* @see {@link ContactConfigBase} - The TypeScript type definition
|
|
2090
|
+
*/
|
|
2091
|
+
export const KEYS_CONTACT_CONFIG_BASE = [
|
|
2092
|
+
KEY_CONTACT_CONFIG_BASE_MAX,
|
|
2093
|
+
KEY_CONTACT_CONFIG_BASE_MIN,
|
|
2094
|
+
KEY_CONTACT_CONFIG_BASE_TYPE,
|
|
2095
|
+
] as const satisfies (keyof ContactConfigBase)[];
|
|
2096
|
+
|
|
2097
|
+
/**
|
|
2098
|
+
* City
|
|
2099
|
+
*
|
|
2100
|
+
* The city of the contact
|
|
2101
|
+
*
|
|
2102
|
+
* @type {string}
|
|
2103
|
+
*
|
|
2104
|
+
*
|
|
2105
|
+
* @remarks
|
|
2106
|
+
* This key constant provides type-safe access to the `city` property of ContactCreate objects.
|
|
2107
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
2108
|
+
*
|
|
2109
|
+
* @example
|
|
2110
|
+
* ```typescript
|
|
2111
|
+
* // Direct property access
|
|
2112
|
+
* const value = contactcreate[KEY_CONTACT_CREATE_CITY];
|
|
2113
|
+
*
|
|
2114
|
+
* // Dynamic property access
|
|
2115
|
+
* const propertyName = KEY_CONTACT_CREATE_CITY;
|
|
2116
|
+
* const value = contactcreate[propertyName];
|
|
2117
|
+
* ```
|
|
2118
|
+
*
|
|
2119
|
+
* @see {@link ContactCreate} - The TypeScript type definition
|
|
2120
|
+
* @see {@link KEYS_CONTACT_CREATE} - Array of all keys for this type
|
|
2121
|
+
*/
|
|
2122
|
+
export const KEY_CONTACT_CREATE_CITY: keyof ContactCreate = 'city';
|
|
2123
|
+
/**
|
|
2124
|
+
* Country
|
|
2125
|
+
*
|
|
2126
|
+
* The country of the contact
|
|
2127
|
+
*
|
|
2128
|
+
* @type {string}
|
|
2129
|
+
*
|
|
2130
|
+
*
|
|
2131
|
+
* @remarks
|
|
2132
|
+
* This key constant provides type-safe access to the `country` property of ContactCreate objects.
|
|
2133
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
2134
|
+
*
|
|
2135
|
+
* @example
|
|
2136
|
+
* ```typescript
|
|
2137
|
+
* // Direct property access
|
|
2138
|
+
* const value = contactcreate[KEY_CONTACT_CREATE_COUNTRY];
|
|
2139
|
+
*
|
|
2140
|
+
* // Dynamic property access
|
|
2141
|
+
* const propertyName = KEY_CONTACT_CREATE_COUNTRY;
|
|
2142
|
+
* const value = contactcreate[propertyName];
|
|
2143
|
+
* ```
|
|
2144
|
+
*
|
|
2145
|
+
* @see {@link ContactCreate} - The TypeScript type definition
|
|
2146
|
+
* @see {@link KEYS_CONTACT_CREATE} - Array of all keys for this type
|
|
2147
|
+
*/
|
|
2148
|
+
export const KEY_CONTACT_CREATE_COUNTRY: keyof ContactCreate = 'country';
|
|
2149
|
+
/**
|
|
2150
|
+
* Disclose
|
|
2151
|
+
*
|
|
2152
|
+
* Whether the contact details should be disclosed. The Disclose function may not work with all TLDs. Some registries still display the data in Whois if, for example, the organization field is filled in.
|
|
2153
|
+
*
|
|
2154
|
+
* @type {boolean}
|
|
2155
|
+
*
|
|
2156
|
+
*
|
|
2157
|
+
* @remarks
|
|
2158
|
+
* This key constant provides type-safe access to the `disclose` property of ContactCreate objects.
|
|
2159
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
2160
|
+
*
|
|
2161
|
+
* @example
|
|
2162
|
+
* ```typescript
|
|
2163
|
+
* // Direct property access
|
|
2164
|
+
* const value = contactcreate[KEY_CONTACT_CREATE_DISCLOSE];
|
|
2165
|
+
*
|
|
2166
|
+
* // Dynamic property access
|
|
2167
|
+
* const propertyName = KEY_CONTACT_CREATE_DISCLOSE;
|
|
2168
|
+
* const value = contactcreate[propertyName];
|
|
2169
|
+
* ```
|
|
2170
|
+
*
|
|
2171
|
+
* @see {@link ContactCreate} - The TypeScript type definition
|
|
2172
|
+
* @see {@link KEYS_CONTACT_CREATE} - Array of all keys for this type
|
|
2173
|
+
*/
|
|
2174
|
+
export const KEY_CONTACT_CREATE_DISCLOSE: keyof ContactCreate = 'disclose';
|
|
2175
|
+
/**
|
|
2176
|
+
* Email
|
|
2177
|
+
*
|
|
2178
|
+
* The email of the contact
|
|
2179
|
+
*
|
|
2180
|
+
* @type {string}
|
|
2181
|
+
*
|
|
2182
|
+
*
|
|
2183
|
+
* @remarks
|
|
2184
|
+
* This key constant provides type-safe access to the `email` property of ContactCreate objects.
|
|
2185
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
2186
|
+
*
|
|
2187
|
+
* @example
|
|
2188
|
+
* ```typescript
|
|
2189
|
+
* // Direct property access
|
|
2190
|
+
* const value = contactcreate[KEY_CONTACT_CREATE_EMAIL];
|
|
2191
|
+
*
|
|
2192
|
+
* // Dynamic property access
|
|
2193
|
+
* const propertyName = KEY_CONTACT_CREATE_EMAIL;
|
|
2194
|
+
* const value = contactcreate[propertyName];
|
|
2195
|
+
* ```
|
|
2196
|
+
*
|
|
2197
|
+
* @see {@link ContactCreate} - The TypeScript type definition
|
|
2198
|
+
* @see {@link KEYS_CONTACT_CREATE} - Array of all keys for this type
|
|
2199
|
+
*/
|
|
2200
|
+
export const KEY_CONTACT_CREATE_EMAIL: keyof ContactCreate = 'email';
|
|
2201
|
+
/**
|
|
2202
|
+
* Fax
|
|
2203
|
+
*
|
|
2204
|
+
* The contacts's fax number
|
|
2205
|
+
*
|
|
2206
|
+
*
|
|
2207
|
+
*
|
|
2208
|
+
* @remarks
|
|
2209
|
+
* This key constant provides type-safe access to the `fax` property of ContactCreate objects.
|
|
2210
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
2211
|
+
*
|
|
2212
|
+
* @example
|
|
2213
|
+
* ```typescript
|
|
2214
|
+
* // Direct property access
|
|
2215
|
+
* const value = contactcreate[KEY_CONTACT_CREATE_FAX];
|
|
2216
|
+
*
|
|
2217
|
+
* // Dynamic property access
|
|
2218
|
+
* const propertyName = KEY_CONTACT_CREATE_FAX;
|
|
2219
|
+
* const value = contactcreate[propertyName];
|
|
2220
|
+
* ```
|
|
2221
|
+
*
|
|
2222
|
+
* @see {@link ContactCreate} - The TypeScript type definition
|
|
2223
|
+
* @see {@link KEYS_CONTACT_CREATE} - Array of all keys for this type
|
|
2224
|
+
*/
|
|
2225
|
+
export const KEY_CONTACT_CREATE_FAX: keyof ContactCreate = 'fax';
|
|
2226
|
+
/**
|
|
2227
|
+
* First Name
|
|
2228
|
+
*
|
|
2229
|
+
* The first name of the contact
|
|
2230
|
+
*
|
|
2231
|
+
* @type {string}
|
|
2232
|
+
*
|
|
2233
|
+
*
|
|
2234
|
+
* @remarks
|
|
2235
|
+
* This key constant provides type-safe access to the `first_name` property of ContactCreate objects.
|
|
2236
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
2237
|
+
*
|
|
2238
|
+
* @example
|
|
2239
|
+
* ```typescript
|
|
2240
|
+
* // Direct property access
|
|
2241
|
+
* const value = contactcreate[KEY_CONTACT_CREATE_FIRST_NAME];
|
|
2242
|
+
*
|
|
2243
|
+
* // Dynamic property access
|
|
2244
|
+
* const propertyName = KEY_CONTACT_CREATE_FIRST_NAME;
|
|
2245
|
+
* const value = contactcreate[propertyName];
|
|
2246
|
+
* ```
|
|
2247
|
+
*
|
|
2248
|
+
* @see {@link ContactCreate} - The TypeScript type definition
|
|
2249
|
+
* @see {@link KEYS_CONTACT_CREATE} - Array of all keys for this type
|
|
2250
|
+
*/
|
|
2251
|
+
export const KEY_CONTACT_CREATE_FIRST_NAME: keyof ContactCreate = 'first_name';
|
|
2252
|
+
/**
|
|
2253
|
+
* Last Name
|
|
2254
|
+
*
|
|
2255
|
+
* The last name of the contact
|
|
2256
|
+
*
|
|
2257
|
+
* @type {string}
|
|
2258
|
+
*
|
|
2259
|
+
*
|
|
2260
|
+
* @remarks
|
|
2261
|
+
* This key constant provides type-safe access to the `last_name` property of ContactCreate objects.
|
|
2262
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
2263
|
+
*
|
|
2264
|
+
* @example
|
|
2265
|
+
* ```typescript
|
|
2266
|
+
* // Direct property access
|
|
2267
|
+
* const value = contactcreate[KEY_CONTACT_CREATE_LAST_NAME];
|
|
2268
|
+
*
|
|
2269
|
+
* // Dynamic property access
|
|
2270
|
+
* const propertyName = KEY_CONTACT_CREATE_LAST_NAME;
|
|
2271
|
+
* const value = contactcreate[propertyName];
|
|
2272
|
+
* ```
|
|
2273
|
+
*
|
|
2274
|
+
* @see {@link ContactCreate} - The TypeScript type definition
|
|
2275
|
+
* @see {@link KEYS_CONTACT_CREATE} - Array of all keys for this type
|
|
2276
|
+
*/
|
|
2277
|
+
export const KEY_CONTACT_CREATE_LAST_NAME: keyof ContactCreate = 'last_name';
|
|
2278
|
+
/**
|
|
2279
|
+
* Org
|
|
2280
|
+
*
|
|
2281
|
+
* The organization of the contact
|
|
2282
|
+
*
|
|
2283
|
+
*
|
|
2284
|
+
*
|
|
2285
|
+
* @remarks
|
|
2286
|
+
* This key constant provides type-safe access to the `org` property of ContactCreate objects.
|
|
2287
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
2288
|
+
*
|
|
2289
|
+
* @example
|
|
2290
|
+
* ```typescript
|
|
2291
|
+
* // Direct property access
|
|
2292
|
+
* const value = contactcreate[KEY_CONTACT_CREATE_ORG];
|
|
2293
|
+
*
|
|
2294
|
+
* // Dynamic property access
|
|
2295
|
+
* const propertyName = KEY_CONTACT_CREATE_ORG;
|
|
2296
|
+
* const value = contactcreate[propertyName];
|
|
2297
|
+
* ```
|
|
2298
|
+
*
|
|
2299
|
+
* @see {@link ContactCreate} - The TypeScript type definition
|
|
2300
|
+
* @see {@link KEYS_CONTACT_CREATE} - Array of all keys for this type
|
|
2301
|
+
*/
|
|
2302
|
+
export const KEY_CONTACT_CREATE_ORG: keyof ContactCreate = 'org';
|
|
2303
|
+
/**
|
|
2304
|
+
* Phone
|
|
2305
|
+
*
|
|
2306
|
+
* The contact's phone number
|
|
2307
|
+
*
|
|
2308
|
+
* @type {string}
|
|
2309
|
+
*
|
|
2310
|
+
*
|
|
2311
|
+
* @remarks
|
|
2312
|
+
* This key constant provides type-safe access to the `phone` property of ContactCreate objects.
|
|
2313
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
2314
|
+
*
|
|
2315
|
+
* @example
|
|
2316
|
+
* ```typescript
|
|
2317
|
+
* // Direct property access
|
|
2318
|
+
* const value = contactcreate[KEY_CONTACT_CREATE_PHONE];
|
|
2319
|
+
*
|
|
2320
|
+
* // Dynamic property access
|
|
2321
|
+
* const propertyName = KEY_CONTACT_CREATE_PHONE;
|
|
2322
|
+
* const value = contactcreate[propertyName];
|
|
2323
|
+
* ```
|
|
2324
|
+
*
|
|
2325
|
+
* @see {@link ContactCreate} - The TypeScript type definition
|
|
2326
|
+
* @see {@link KEYS_CONTACT_CREATE} - Array of all keys for this type
|
|
2327
|
+
*/
|
|
2328
|
+
export const KEY_CONTACT_CREATE_PHONE: keyof ContactCreate = 'phone';
|
|
2329
|
+
/**
|
|
2330
|
+
* Postal Code
|
|
2331
|
+
*
|
|
2332
|
+
* The postal code of the contact
|
|
2333
|
+
*
|
|
2334
|
+
* @type {string}
|
|
2335
|
+
*
|
|
2336
|
+
*
|
|
2337
|
+
* @remarks
|
|
2338
|
+
* This key constant provides type-safe access to the `postal_code` property of ContactCreate objects.
|
|
2339
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
2340
|
+
*
|
|
2341
|
+
* @example
|
|
2342
|
+
* ```typescript
|
|
2343
|
+
* // Direct property access
|
|
2344
|
+
* const value = contactcreate[KEY_CONTACT_CREATE_POSTAL_CODE];
|
|
2345
|
+
*
|
|
2346
|
+
* // Dynamic property access
|
|
2347
|
+
* const propertyName = KEY_CONTACT_CREATE_POSTAL_CODE;
|
|
2348
|
+
* const value = contactcreate[propertyName];
|
|
2349
|
+
* ```
|
|
2350
|
+
*
|
|
2351
|
+
* @see {@link ContactCreate} - The TypeScript type definition
|
|
2352
|
+
* @see {@link KEYS_CONTACT_CREATE} - Array of all keys for this type
|
|
2353
|
+
*/
|
|
2354
|
+
export const KEY_CONTACT_CREATE_POSTAL_CODE: keyof ContactCreate = 'postal_code';
|
|
2355
|
+
/**
|
|
2356
|
+
* State
|
|
2357
|
+
*
|
|
2358
|
+
* The state of the contact
|
|
2359
|
+
*
|
|
2360
|
+
*
|
|
2361
|
+
*
|
|
2362
|
+
* @remarks
|
|
2363
|
+
* This key constant provides type-safe access to the `state` property of ContactCreate objects.
|
|
2364
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
2365
|
+
*
|
|
2366
|
+
* @example
|
|
2367
|
+
* ```typescript
|
|
2368
|
+
* // Direct property access
|
|
2369
|
+
* const value = contactcreate[KEY_CONTACT_CREATE_STATE];
|
|
2370
|
+
*
|
|
2371
|
+
* // Dynamic property access
|
|
2372
|
+
* const propertyName = KEY_CONTACT_CREATE_STATE;
|
|
2373
|
+
* const value = contactcreate[propertyName];
|
|
2374
|
+
* ```
|
|
2375
|
+
*
|
|
2376
|
+
* @see {@link ContactCreate} - The TypeScript type definition
|
|
2377
|
+
* @see {@link KEYS_CONTACT_CREATE} - Array of all keys for this type
|
|
2378
|
+
*/
|
|
2379
|
+
export const KEY_CONTACT_CREATE_STATE: keyof ContactCreate = 'state';
|
|
2380
|
+
/**
|
|
2381
|
+
* Street
|
|
2382
|
+
*
|
|
2383
|
+
* The address of the contact
|
|
2384
|
+
*
|
|
2385
|
+
* @type {string}
|
|
2386
|
+
*
|
|
2387
|
+
*
|
|
2388
|
+
* @remarks
|
|
2389
|
+
* This key constant provides type-safe access to the `street` property of ContactCreate objects.
|
|
2390
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
2391
|
+
*
|
|
2392
|
+
* @example
|
|
2393
|
+
* ```typescript
|
|
2394
|
+
* // Direct property access
|
|
2395
|
+
* const value = contactcreate[KEY_CONTACT_CREATE_STREET];
|
|
2396
|
+
*
|
|
2397
|
+
* // Dynamic property access
|
|
2398
|
+
* const propertyName = KEY_CONTACT_CREATE_STREET;
|
|
2399
|
+
* const value = contactcreate[propertyName];
|
|
2400
|
+
* ```
|
|
2401
|
+
*
|
|
2402
|
+
* @see {@link ContactCreate} - The TypeScript type definition
|
|
2403
|
+
* @see {@link KEYS_CONTACT_CREATE} - Array of all keys for this type
|
|
2404
|
+
*/
|
|
2405
|
+
export const KEY_CONTACT_CREATE_STREET: keyof ContactCreate = 'street';
|
|
2406
|
+
/**
|
|
2407
|
+
* Title
|
|
2408
|
+
*
|
|
2409
|
+
* The title of the contact
|
|
2410
|
+
*
|
|
2411
|
+
*
|
|
2412
|
+
*
|
|
2413
|
+
* @remarks
|
|
2414
|
+
* This key constant provides type-safe access to the `title` property of ContactCreate objects.
|
|
2415
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
2416
|
+
*
|
|
2417
|
+
* @example
|
|
2418
|
+
* ```typescript
|
|
2419
|
+
* // Direct property access
|
|
2420
|
+
* const value = contactcreate[KEY_CONTACT_CREATE_TITLE];
|
|
2421
|
+
*
|
|
2422
|
+
* // Dynamic property access
|
|
2423
|
+
* const propertyName = KEY_CONTACT_CREATE_TITLE;
|
|
2424
|
+
* const value = contactcreate[propertyName];
|
|
2425
|
+
* ```
|
|
1332
2426
|
*
|
|
1333
|
-
* @
|
|
2427
|
+
* @see {@link ContactCreate} - The TypeScript type definition
|
|
2428
|
+
* @see {@link KEYS_CONTACT_CREATE} - Array of all keys for this type
|
|
2429
|
+
*/
|
|
2430
|
+
export const KEY_CONTACT_CREATE_TITLE: keyof ContactCreate = 'title';
|
|
2431
|
+
|
|
2432
|
+
/**
|
|
2433
|
+
* Array of all ContactCreate property keys
|
|
2434
|
+
*
|
|
2435
|
+
* @remarks
|
|
2436
|
+
* This constant provides a readonly array containing all valid property keys for ContactCreate objects.
|
|
2437
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
2438
|
+
*
|
|
2439
|
+
* @example
|
|
2440
|
+
* ```typescript
|
|
2441
|
+
* // Iterating through all keys
|
|
2442
|
+
* for (const key of KEYS_CONTACT_CREATE) {
|
|
2443
|
+
* console.log(`Property: ${key}, Value: ${contactcreate[key]}`);
|
|
2444
|
+
* }
|
|
2445
|
+
*
|
|
2446
|
+
* // Validation
|
|
2447
|
+
* const isValidKey = KEYS_CONTACT_CREATE.includes(someKey);
|
|
2448
|
+
* ```
|
|
2449
|
+
*
|
|
2450
|
+
* @see {@link ContactCreate} - The TypeScript type definition
|
|
2451
|
+
*/
|
|
2452
|
+
export const KEYS_CONTACT_CREATE = [
|
|
2453
|
+
KEY_CONTACT_CREATE_CITY,
|
|
2454
|
+
KEY_CONTACT_CREATE_COUNTRY,
|
|
2455
|
+
KEY_CONTACT_CREATE_DISCLOSE,
|
|
2456
|
+
KEY_CONTACT_CREATE_EMAIL,
|
|
2457
|
+
KEY_CONTACT_CREATE_FAX,
|
|
2458
|
+
KEY_CONTACT_CREATE_FIRST_NAME,
|
|
2459
|
+
KEY_CONTACT_CREATE_LAST_NAME,
|
|
2460
|
+
KEY_CONTACT_CREATE_ORG,
|
|
2461
|
+
KEY_CONTACT_CREATE_PHONE,
|
|
2462
|
+
KEY_CONTACT_CREATE_POSTAL_CODE,
|
|
2463
|
+
KEY_CONTACT_CREATE_STATE,
|
|
2464
|
+
KEY_CONTACT_CREATE_STREET,
|
|
2465
|
+
KEY_CONTACT_CREATE_TITLE,
|
|
2466
|
+
] as const satisfies (keyof ContactCreate)[];
|
|
2467
|
+
|
|
2468
|
+
/**
|
|
2469
|
+
* Attribute Sets
|
|
2470
|
+
*
|
|
2471
|
+
* Linked attribute sets for this contact
|
|
2472
|
+
*
|
|
2473
|
+
* @type {array}
|
|
1334
2474
|
*
|
|
1335
2475
|
*
|
|
1336
2476
|
* @remarks
|
|
1337
|
-
* This key constant provides type-safe access to the `
|
|
2477
|
+
* This key constant provides type-safe access to the `attribute_sets` property of ContactDetail objects.
|
|
1338
2478
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1339
2479
|
*
|
|
1340
2480
|
* @example
|
|
1341
2481
|
* ```typescript
|
|
1342
2482
|
* // Direct property access
|
|
1343
|
-
* const value =
|
|
2483
|
+
* const value = contactdetail[KEY_CONTACT_DETAIL_ATTRIBUTE_SETS];
|
|
1344
2484
|
*
|
|
1345
2485
|
* // Dynamic property access
|
|
1346
|
-
* const propertyName =
|
|
1347
|
-
* const value =
|
|
2486
|
+
* const propertyName = KEY_CONTACT_DETAIL_ATTRIBUTE_SETS;
|
|
2487
|
+
* const value = contactdetail[propertyName];
|
|
1348
2488
|
* ```
|
|
1349
2489
|
*
|
|
1350
|
-
* @see {@link
|
|
1351
|
-
* @see {@link
|
|
2490
|
+
* @see {@link ContactDetail} - The TypeScript type definition
|
|
2491
|
+
* @see {@link KEYS_CONTACT_DETAIL} - Array of all keys for this type
|
|
1352
2492
|
*/
|
|
1353
|
-
export const
|
|
2493
|
+
export const KEY_CONTACT_DETAIL_ATTRIBUTE_SETS: keyof ContactDetail = 'attribute_sets';
|
|
1354
2494
|
/**
|
|
1355
|
-
*
|
|
2495
|
+
* City
|
|
1356
2496
|
*
|
|
1357
|
-
*
|
|
2497
|
+
* The city of the contact
|
|
1358
2498
|
*
|
|
1359
|
-
* @type {
|
|
2499
|
+
* @type {string}
|
|
1360
2500
|
*
|
|
1361
2501
|
*
|
|
1362
2502
|
* @remarks
|
|
1363
|
-
* This key constant provides type-safe access to the `
|
|
2503
|
+
* This key constant provides type-safe access to the `city` property of ContactDetail objects.
|
|
1364
2504
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1365
2505
|
*
|
|
1366
2506
|
* @example
|
|
1367
2507
|
* ```typescript
|
|
1368
2508
|
* // Direct property access
|
|
1369
|
-
* const value =
|
|
2509
|
+
* const value = contactdetail[KEY_CONTACT_DETAIL_CITY];
|
|
1370
2510
|
*
|
|
1371
2511
|
* // Dynamic property access
|
|
1372
|
-
* const propertyName =
|
|
1373
|
-
* const value =
|
|
2512
|
+
* const propertyName = KEY_CONTACT_DETAIL_CITY;
|
|
2513
|
+
* const value = contactdetail[propertyName];
|
|
1374
2514
|
* ```
|
|
1375
2515
|
*
|
|
1376
|
-
* @see {@link
|
|
1377
|
-
* @see {@link
|
|
2516
|
+
* @see {@link ContactDetail} - The TypeScript type definition
|
|
2517
|
+
* @see {@link KEYS_CONTACT_DETAIL} - Array of all keys for this type
|
|
1378
2518
|
*/
|
|
1379
|
-
export const
|
|
2519
|
+
export const KEY_CONTACT_DETAIL_CITY: keyof ContactDetail = 'city';
|
|
1380
2520
|
/**
|
|
1381
|
-
*
|
|
2521
|
+
* Contact Id
|
|
1382
2522
|
*
|
|
1383
|
-
* The type of contact
|
|
1384
2523
|
*
|
|
2524
|
+
* @type {string}
|
|
1385
2525
|
*
|
|
1386
2526
|
*
|
|
1387
2527
|
* @remarks
|
|
1388
|
-
* This key constant provides type-safe access to the `
|
|
2528
|
+
* This key constant provides type-safe access to the `contact_id` property of ContactDetail objects.
|
|
1389
2529
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1390
2530
|
*
|
|
1391
2531
|
* @example
|
|
1392
2532
|
* ```typescript
|
|
1393
2533
|
* // Direct property access
|
|
1394
|
-
* const value =
|
|
2534
|
+
* const value = contactdetail[KEY_CONTACT_DETAIL_CONTACT_ID];
|
|
1395
2535
|
*
|
|
1396
2536
|
* // Dynamic property access
|
|
1397
|
-
* const propertyName =
|
|
1398
|
-
* const value =
|
|
2537
|
+
* const propertyName = KEY_CONTACT_DETAIL_CONTACT_ID;
|
|
2538
|
+
* const value = contactdetail[propertyName];
|
|
1399
2539
|
* ```
|
|
1400
2540
|
*
|
|
1401
|
-
* @see {@link
|
|
1402
|
-
* @see {@link
|
|
2541
|
+
* @see {@link ContactDetail} - The TypeScript type definition
|
|
2542
|
+
* @see {@link KEYS_CONTACT_DETAIL} - Array of all keys for this type
|
|
1403
2543
|
*/
|
|
1404
|
-
export const
|
|
1405
|
-
|
|
2544
|
+
export const KEY_CONTACT_DETAIL_CONTACT_ID: keyof ContactDetail = 'contact_id';
|
|
1406
2545
|
/**
|
|
1407
|
-
*
|
|
2546
|
+
* Country
|
|
2547
|
+
*
|
|
2548
|
+
* The country of the contact
|
|
2549
|
+
*
|
|
2550
|
+
* @type {string}
|
|
2551
|
+
*
|
|
1408
2552
|
*
|
|
1409
2553
|
* @remarks
|
|
1410
|
-
* This constant provides
|
|
1411
|
-
*
|
|
2554
|
+
* This key constant provides type-safe access to the `country` property of ContactDetail objects.
|
|
2555
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1412
2556
|
*
|
|
1413
2557
|
* @example
|
|
1414
2558
|
* ```typescript
|
|
1415
|
-
* //
|
|
1416
|
-
*
|
|
1417
|
-
* console.log(`Property: ${key}, Value: ${contactconfigbase[key]}`);
|
|
1418
|
-
* }
|
|
2559
|
+
* // Direct property access
|
|
2560
|
+
* const value = contactdetail[KEY_CONTACT_DETAIL_COUNTRY];
|
|
1419
2561
|
*
|
|
1420
|
-
* //
|
|
1421
|
-
* const
|
|
2562
|
+
* // Dynamic property access
|
|
2563
|
+
* const propertyName = KEY_CONTACT_DETAIL_COUNTRY;
|
|
2564
|
+
* const value = contactdetail[propertyName];
|
|
1422
2565
|
* ```
|
|
1423
2566
|
*
|
|
1424
|
-
* @see {@link
|
|
2567
|
+
* @see {@link ContactDetail} - The TypeScript type definition
|
|
2568
|
+
* @see {@link KEYS_CONTACT_DETAIL} - Array of all keys for this type
|
|
1425
2569
|
*/
|
|
1426
|
-
export const
|
|
1427
|
-
KEY_CONTACT_CONFIG_BASE_MAX,
|
|
1428
|
-
KEY_CONTACT_CONFIG_BASE_MIN,
|
|
1429
|
-
KEY_CONTACT_CONFIG_BASE_TYPE,
|
|
1430
|
-
] as const satisfies (keyof ContactConfigBase)[];
|
|
1431
|
-
|
|
2570
|
+
export const KEY_CONTACT_DETAIL_COUNTRY: keyof ContactDetail = 'country';
|
|
1432
2571
|
/**
|
|
1433
|
-
*
|
|
2572
|
+
* Created On
|
|
1434
2573
|
*
|
|
1435
|
-
* The
|
|
2574
|
+
* The date/time the entry was created on
|
|
1436
2575
|
*
|
|
1437
2576
|
* @type {string}
|
|
1438
2577
|
*
|
|
1439
2578
|
*
|
|
1440
2579
|
* @remarks
|
|
1441
|
-
* This key constant provides type-safe access to the `
|
|
2580
|
+
* This key constant provides type-safe access to the `created_on` property of ContactDetail objects.
|
|
1442
2581
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1443
2582
|
*
|
|
1444
2583
|
* @example
|
|
1445
2584
|
* ```typescript
|
|
1446
2585
|
* // Direct property access
|
|
1447
|
-
* const value =
|
|
2586
|
+
* const value = contactdetail[KEY_CONTACT_DETAIL_CREATED_ON];
|
|
1448
2587
|
*
|
|
1449
2588
|
* // Dynamic property access
|
|
1450
|
-
* const propertyName =
|
|
1451
|
-
* const value =
|
|
2589
|
+
* const propertyName = KEY_CONTACT_DETAIL_CREATED_ON;
|
|
2590
|
+
* const value = contactdetail[propertyName];
|
|
1452
2591
|
* ```
|
|
1453
2592
|
*
|
|
1454
|
-
* @see {@link
|
|
1455
|
-
* @see {@link
|
|
2593
|
+
* @see {@link ContactDetail} - The TypeScript type definition
|
|
2594
|
+
* @see {@link KEYS_CONTACT_DETAIL} - Array of all keys for this type
|
|
1456
2595
|
*/
|
|
1457
|
-
export const
|
|
2596
|
+
export const KEY_CONTACT_DETAIL_CREATED_ON: keyof ContactDetail = 'created_on';
|
|
1458
2597
|
/**
|
|
1459
|
-
*
|
|
2598
|
+
* Deleted On
|
|
1460
2599
|
*
|
|
1461
|
-
* The
|
|
2600
|
+
* The date/time the entry was deleted on
|
|
1462
2601
|
*
|
|
1463
|
-
* @type {string}
|
|
1464
2602
|
*
|
|
1465
2603
|
*
|
|
1466
2604
|
* @remarks
|
|
1467
|
-
* This key constant provides type-safe access to the `
|
|
2605
|
+
* This key constant provides type-safe access to the `deleted_on` property of ContactDetail objects.
|
|
1468
2606
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1469
2607
|
*
|
|
1470
2608
|
* @example
|
|
1471
2609
|
* ```typescript
|
|
1472
2610
|
* // Direct property access
|
|
1473
|
-
* const value =
|
|
2611
|
+
* const value = contactdetail[KEY_CONTACT_DETAIL_DELETED_ON];
|
|
1474
2612
|
*
|
|
1475
2613
|
* // Dynamic property access
|
|
1476
|
-
* const propertyName =
|
|
1477
|
-
* const value =
|
|
2614
|
+
* const propertyName = KEY_CONTACT_DETAIL_DELETED_ON;
|
|
2615
|
+
* const value = contactdetail[propertyName];
|
|
1478
2616
|
* ```
|
|
1479
2617
|
*
|
|
1480
|
-
* @see {@link
|
|
1481
|
-
* @see {@link
|
|
2618
|
+
* @see {@link ContactDetail} - The TypeScript type definition
|
|
2619
|
+
* @see {@link KEYS_CONTACT_DETAIL} - Array of all keys for this type
|
|
1482
2620
|
*/
|
|
1483
|
-
export const
|
|
2621
|
+
export const KEY_CONTACT_DETAIL_DELETED_ON: keyof ContactDetail = 'deleted_on';
|
|
1484
2622
|
/**
|
|
1485
2623
|
* Disclose
|
|
1486
2624
|
*
|
|
@@ -1490,23 +2628,23 @@ export const KEY_CONTACT_CREATE_COUNTRY: keyof ContactCreate = 'country';
|
|
|
1490
2628
|
*
|
|
1491
2629
|
*
|
|
1492
2630
|
* @remarks
|
|
1493
|
-
* This key constant provides type-safe access to the `disclose` property of
|
|
2631
|
+
* This key constant provides type-safe access to the `disclose` property of ContactDetail objects.
|
|
1494
2632
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1495
2633
|
*
|
|
1496
2634
|
* @example
|
|
1497
2635
|
* ```typescript
|
|
1498
2636
|
* // Direct property access
|
|
1499
|
-
* const value =
|
|
2637
|
+
* const value = contactdetail[KEY_CONTACT_DETAIL_DISCLOSE];
|
|
1500
2638
|
*
|
|
1501
2639
|
* // Dynamic property access
|
|
1502
|
-
* const propertyName =
|
|
1503
|
-
* const value =
|
|
2640
|
+
* const propertyName = KEY_CONTACT_DETAIL_DISCLOSE;
|
|
2641
|
+
* const value = contactdetail[propertyName];
|
|
1504
2642
|
* ```
|
|
1505
2643
|
*
|
|
1506
|
-
* @see {@link
|
|
1507
|
-
* @see {@link
|
|
2644
|
+
* @see {@link ContactDetail} - The TypeScript type definition
|
|
2645
|
+
* @see {@link KEYS_CONTACT_DETAIL} - Array of all keys for this type
|
|
1508
2646
|
*/
|
|
1509
|
-
export const
|
|
2647
|
+
export const KEY_CONTACT_DETAIL_DISCLOSE: keyof ContactDetail = 'disclose';
|
|
1510
2648
|
/**
|
|
1511
2649
|
* Email
|
|
1512
2650
|
*
|
|
@@ -1516,23 +2654,23 @@ export const KEY_CONTACT_CREATE_DISCLOSE: keyof ContactCreate = 'disclose';
|
|
|
1516
2654
|
*
|
|
1517
2655
|
*
|
|
1518
2656
|
* @remarks
|
|
1519
|
-
* This key constant provides type-safe access to the `email` property of
|
|
2657
|
+
* This key constant provides type-safe access to the `email` property of ContactDetail objects.
|
|
1520
2658
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1521
2659
|
*
|
|
1522
2660
|
* @example
|
|
1523
2661
|
* ```typescript
|
|
1524
2662
|
* // Direct property access
|
|
1525
|
-
* const value =
|
|
2663
|
+
* const value = contactdetail[KEY_CONTACT_DETAIL_EMAIL];
|
|
1526
2664
|
*
|
|
1527
2665
|
* // Dynamic property access
|
|
1528
|
-
* const propertyName =
|
|
1529
|
-
* const value =
|
|
2666
|
+
* const propertyName = KEY_CONTACT_DETAIL_EMAIL;
|
|
2667
|
+
* const value = contactdetail[propertyName];
|
|
1530
2668
|
* ```
|
|
1531
2669
|
*
|
|
1532
|
-
* @see {@link
|
|
1533
|
-
* @see {@link
|
|
2670
|
+
* @see {@link ContactDetail} - The TypeScript type definition
|
|
2671
|
+
* @see {@link KEYS_CONTACT_DETAIL} - Array of all keys for this type
|
|
1534
2672
|
*/
|
|
1535
|
-
export const
|
|
2673
|
+
export const KEY_CONTACT_DETAIL_EMAIL: keyof ContactDetail = 'email';
|
|
1536
2674
|
/**
|
|
1537
2675
|
* Fax
|
|
1538
2676
|
*
|
|
@@ -1541,23 +2679,23 @@ export const KEY_CONTACT_CREATE_EMAIL: keyof ContactCreate = 'email';
|
|
|
1541
2679
|
*
|
|
1542
2680
|
*
|
|
1543
2681
|
* @remarks
|
|
1544
|
-
* This key constant provides type-safe access to the `fax` property of
|
|
2682
|
+
* This key constant provides type-safe access to the `fax` property of ContactDetail objects.
|
|
1545
2683
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1546
2684
|
*
|
|
1547
2685
|
* @example
|
|
1548
2686
|
* ```typescript
|
|
1549
2687
|
* // Direct property access
|
|
1550
|
-
* const value =
|
|
2688
|
+
* const value = contactdetail[KEY_CONTACT_DETAIL_FAX];
|
|
1551
2689
|
*
|
|
1552
2690
|
* // Dynamic property access
|
|
1553
|
-
* const propertyName =
|
|
1554
|
-
* const value =
|
|
2691
|
+
* const propertyName = KEY_CONTACT_DETAIL_FAX;
|
|
2692
|
+
* const value = contactdetail[propertyName];
|
|
1555
2693
|
* ```
|
|
1556
2694
|
*
|
|
1557
|
-
* @see {@link
|
|
1558
|
-
* @see {@link
|
|
2695
|
+
* @see {@link ContactDetail} - The TypeScript type definition
|
|
2696
|
+
* @see {@link KEYS_CONTACT_DETAIL} - Array of all keys for this type
|
|
1559
2697
|
*/
|
|
1560
|
-
export const
|
|
2698
|
+
export const KEY_CONTACT_DETAIL_FAX: keyof ContactDetail = 'fax';
|
|
1561
2699
|
/**
|
|
1562
2700
|
* First Name
|
|
1563
2701
|
*
|
|
@@ -1567,23 +2705,23 @@ export const KEY_CONTACT_CREATE_FAX: keyof ContactCreate = 'fax';
|
|
|
1567
2705
|
*
|
|
1568
2706
|
*
|
|
1569
2707
|
* @remarks
|
|
1570
|
-
* This key constant provides type-safe access to the `first_name` property of
|
|
2708
|
+
* This key constant provides type-safe access to the `first_name` property of ContactDetail objects.
|
|
1571
2709
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1572
2710
|
*
|
|
1573
2711
|
* @example
|
|
1574
2712
|
* ```typescript
|
|
1575
2713
|
* // Direct property access
|
|
1576
|
-
* const value =
|
|
2714
|
+
* const value = contactdetail[KEY_CONTACT_DETAIL_FIRST_NAME];
|
|
1577
2715
|
*
|
|
1578
2716
|
* // Dynamic property access
|
|
1579
|
-
* const propertyName =
|
|
1580
|
-
* const value =
|
|
2717
|
+
* const propertyName = KEY_CONTACT_DETAIL_FIRST_NAME;
|
|
2718
|
+
* const value = contactdetail[propertyName];
|
|
1581
2719
|
* ```
|
|
1582
2720
|
*
|
|
1583
|
-
* @see {@link
|
|
1584
|
-
* @see {@link
|
|
2721
|
+
* @see {@link ContactDetail} - The TypeScript type definition
|
|
2722
|
+
* @see {@link KEYS_CONTACT_DETAIL} - Array of all keys for this type
|
|
1585
2723
|
*/
|
|
1586
|
-
export const
|
|
2724
|
+
export const KEY_CONTACT_DETAIL_FIRST_NAME: keyof ContactDetail = 'first_name';
|
|
1587
2725
|
/**
|
|
1588
2726
|
* Last Name
|
|
1589
2727
|
*
|
|
@@ -1593,23 +2731,23 @@ export const KEY_CONTACT_CREATE_FIRST_NAME: keyof ContactCreate = 'first_name';
|
|
|
1593
2731
|
*
|
|
1594
2732
|
*
|
|
1595
2733
|
* @remarks
|
|
1596
|
-
* This key constant provides type-safe access to the `last_name` property of
|
|
2734
|
+
* This key constant provides type-safe access to the `last_name` property of ContactDetail objects.
|
|
1597
2735
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1598
2736
|
*
|
|
1599
2737
|
* @example
|
|
1600
2738
|
* ```typescript
|
|
1601
2739
|
* // Direct property access
|
|
1602
|
-
* const value =
|
|
2740
|
+
* const value = contactdetail[KEY_CONTACT_DETAIL_LAST_NAME];
|
|
1603
2741
|
*
|
|
1604
2742
|
* // Dynamic property access
|
|
1605
|
-
* const propertyName =
|
|
1606
|
-
* const value =
|
|
2743
|
+
* const propertyName = KEY_CONTACT_DETAIL_LAST_NAME;
|
|
2744
|
+
* const value = contactdetail[propertyName];
|
|
1607
2745
|
* ```
|
|
1608
2746
|
*
|
|
1609
|
-
* @see {@link
|
|
1610
|
-
* @see {@link
|
|
2747
|
+
* @see {@link ContactDetail} - The TypeScript type definition
|
|
2748
|
+
* @see {@link KEYS_CONTACT_DETAIL} - Array of all keys for this type
|
|
1611
2749
|
*/
|
|
1612
|
-
export const
|
|
2750
|
+
export const KEY_CONTACT_DETAIL_LAST_NAME: keyof ContactDetail = 'last_name';
|
|
1613
2751
|
/**
|
|
1614
2752
|
* Org
|
|
1615
2753
|
*
|
|
@@ -1618,23 +2756,49 @@ export const KEY_CONTACT_CREATE_LAST_NAME: keyof ContactCreate = 'last_name';
|
|
|
1618
2756
|
*
|
|
1619
2757
|
*
|
|
1620
2758
|
* @remarks
|
|
1621
|
-
* This key constant provides type-safe access to the `org` property of
|
|
2759
|
+
* This key constant provides type-safe access to the `org` property of ContactDetail objects.
|
|
1622
2760
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1623
2761
|
*
|
|
1624
2762
|
* @example
|
|
1625
2763
|
* ```typescript
|
|
1626
2764
|
* // Direct property access
|
|
1627
|
-
* const value =
|
|
2765
|
+
* const value = contactdetail[KEY_CONTACT_DETAIL_ORG];
|
|
1628
2766
|
*
|
|
1629
2767
|
* // Dynamic property access
|
|
1630
|
-
* const propertyName =
|
|
1631
|
-
* const value =
|
|
2768
|
+
* const propertyName = KEY_CONTACT_DETAIL_ORG;
|
|
2769
|
+
* const value = contactdetail[propertyName];
|
|
1632
2770
|
* ```
|
|
1633
2771
|
*
|
|
1634
|
-
* @see {@link
|
|
1635
|
-
* @see {@link
|
|
2772
|
+
* @see {@link ContactDetail} - The TypeScript type definition
|
|
2773
|
+
* @see {@link KEYS_CONTACT_DETAIL} - Array of all keys for this type
|
|
1636
2774
|
*/
|
|
1637
|
-
export const
|
|
2775
|
+
export const KEY_CONTACT_DETAIL_ORG: keyof ContactDetail = 'org';
|
|
2776
|
+
/**
|
|
2777
|
+
* Organization Id
|
|
2778
|
+
*
|
|
2779
|
+
* The organization that owns the domain
|
|
2780
|
+
*
|
|
2781
|
+
* @type {string}
|
|
2782
|
+
*
|
|
2783
|
+
*
|
|
2784
|
+
* @remarks
|
|
2785
|
+
* This key constant provides type-safe access to the `organization_id` property of ContactDetail objects.
|
|
2786
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
2787
|
+
*
|
|
2788
|
+
* @example
|
|
2789
|
+
* ```typescript
|
|
2790
|
+
* // Direct property access
|
|
2791
|
+
* const value = contactdetail[KEY_CONTACT_DETAIL_ORGANIZATION_ID];
|
|
2792
|
+
*
|
|
2793
|
+
* // Dynamic property access
|
|
2794
|
+
* const propertyName = KEY_CONTACT_DETAIL_ORGANIZATION_ID;
|
|
2795
|
+
* const value = contactdetail[propertyName];
|
|
2796
|
+
* ```
|
|
2797
|
+
*
|
|
2798
|
+
* @see {@link ContactDetail} - The TypeScript type definition
|
|
2799
|
+
* @see {@link KEYS_CONTACT_DETAIL} - Array of all keys for this type
|
|
2800
|
+
*/
|
|
2801
|
+
export const KEY_CONTACT_DETAIL_ORGANIZATION_ID: keyof ContactDetail = 'organization_id';
|
|
1638
2802
|
/**
|
|
1639
2803
|
* Phone
|
|
1640
2804
|
*
|
|
@@ -1644,23 +2808,23 @@ export const KEY_CONTACT_CREATE_ORG: keyof ContactCreate = 'org';
|
|
|
1644
2808
|
*
|
|
1645
2809
|
*
|
|
1646
2810
|
* @remarks
|
|
1647
|
-
* This key constant provides type-safe access to the `phone` property of
|
|
2811
|
+
* This key constant provides type-safe access to the `phone` property of ContactDetail objects.
|
|
1648
2812
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1649
2813
|
*
|
|
1650
2814
|
* @example
|
|
1651
2815
|
* ```typescript
|
|
1652
2816
|
* // Direct property access
|
|
1653
|
-
* const value =
|
|
2817
|
+
* const value = contactdetail[KEY_CONTACT_DETAIL_PHONE];
|
|
1654
2818
|
*
|
|
1655
2819
|
* // Dynamic property access
|
|
1656
|
-
* const propertyName =
|
|
1657
|
-
* const value =
|
|
2820
|
+
* const propertyName = KEY_CONTACT_DETAIL_PHONE;
|
|
2821
|
+
* const value = contactdetail[propertyName];
|
|
1658
2822
|
* ```
|
|
1659
2823
|
*
|
|
1660
|
-
* @see {@link
|
|
1661
|
-
* @see {@link
|
|
2824
|
+
* @see {@link ContactDetail} - The TypeScript type definition
|
|
2825
|
+
* @see {@link KEYS_CONTACT_DETAIL} - Array of all keys for this type
|
|
1662
2826
|
*/
|
|
1663
|
-
export const
|
|
2827
|
+
export const KEY_CONTACT_DETAIL_PHONE: keyof ContactDetail = 'phone';
|
|
1664
2828
|
/**
|
|
1665
2829
|
* Postal Code
|
|
1666
2830
|
*
|
|
@@ -1670,23 +2834,23 @@ export const KEY_CONTACT_CREATE_PHONE: keyof ContactCreate = 'phone';
|
|
|
1670
2834
|
*
|
|
1671
2835
|
*
|
|
1672
2836
|
* @remarks
|
|
1673
|
-
* This key constant provides type-safe access to the `postal_code` property of
|
|
2837
|
+
* This key constant provides type-safe access to the `postal_code` property of ContactDetail objects.
|
|
1674
2838
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1675
2839
|
*
|
|
1676
2840
|
* @example
|
|
1677
2841
|
* ```typescript
|
|
1678
2842
|
* // Direct property access
|
|
1679
|
-
* const value =
|
|
2843
|
+
* const value = contactdetail[KEY_CONTACT_DETAIL_POSTAL_CODE];
|
|
1680
2844
|
*
|
|
1681
2845
|
* // Dynamic property access
|
|
1682
|
-
* const propertyName =
|
|
1683
|
-
* const value =
|
|
2846
|
+
* const propertyName = KEY_CONTACT_DETAIL_POSTAL_CODE;
|
|
2847
|
+
* const value = contactdetail[propertyName];
|
|
1684
2848
|
* ```
|
|
1685
2849
|
*
|
|
1686
|
-
* @see {@link
|
|
1687
|
-
* @see {@link
|
|
2850
|
+
* @see {@link ContactDetail} - The TypeScript type definition
|
|
2851
|
+
* @see {@link KEYS_CONTACT_DETAIL} - Array of all keys for this type
|
|
1688
2852
|
*/
|
|
1689
|
-
export const
|
|
2853
|
+
export const KEY_CONTACT_DETAIL_POSTAL_CODE: keyof ContactDetail = 'postal_code';
|
|
1690
2854
|
/**
|
|
1691
2855
|
* State
|
|
1692
2856
|
*
|
|
@@ -1695,23 +2859,23 @@ export const KEY_CONTACT_CREATE_POSTAL_CODE: keyof ContactCreate = 'postal_code'
|
|
|
1695
2859
|
*
|
|
1696
2860
|
*
|
|
1697
2861
|
* @remarks
|
|
1698
|
-
* This key constant provides type-safe access to the `state` property of
|
|
2862
|
+
* This key constant provides type-safe access to the `state` property of ContactDetail objects.
|
|
1699
2863
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1700
2864
|
*
|
|
1701
2865
|
* @example
|
|
1702
2866
|
* ```typescript
|
|
1703
2867
|
* // Direct property access
|
|
1704
|
-
* const value =
|
|
2868
|
+
* const value = contactdetail[KEY_CONTACT_DETAIL_STATE];
|
|
1705
2869
|
*
|
|
1706
2870
|
* // Dynamic property access
|
|
1707
|
-
* const propertyName =
|
|
1708
|
-
* const value =
|
|
2871
|
+
* const propertyName = KEY_CONTACT_DETAIL_STATE;
|
|
2872
|
+
* const value = contactdetail[propertyName];
|
|
1709
2873
|
* ```
|
|
1710
2874
|
*
|
|
1711
|
-
* @see {@link
|
|
1712
|
-
* @see {@link
|
|
2875
|
+
* @see {@link ContactDetail} - The TypeScript type definition
|
|
2876
|
+
* @see {@link KEYS_CONTACT_DETAIL} - Array of all keys for this type
|
|
1713
2877
|
*/
|
|
1714
|
-
export const
|
|
2878
|
+
export const KEY_CONTACT_DETAIL_STATE: keyof ContactDetail = 'state';
|
|
1715
2879
|
/**
|
|
1716
2880
|
* Street
|
|
1717
2881
|
*
|
|
@@ -1721,23 +2885,23 @@ export const KEY_CONTACT_CREATE_STATE: keyof ContactCreate = 'state';
|
|
|
1721
2885
|
*
|
|
1722
2886
|
*
|
|
1723
2887
|
* @remarks
|
|
1724
|
-
* This key constant provides type-safe access to the `street` property of
|
|
2888
|
+
* This key constant provides type-safe access to the `street` property of ContactDetail objects.
|
|
1725
2889
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1726
2890
|
*
|
|
1727
2891
|
* @example
|
|
1728
2892
|
* ```typescript
|
|
1729
2893
|
* // Direct property access
|
|
1730
|
-
* const value =
|
|
2894
|
+
* const value = contactdetail[KEY_CONTACT_DETAIL_STREET];
|
|
1731
2895
|
*
|
|
1732
2896
|
* // Dynamic property access
|
|
1733
|
-
* const propertyName =
|
|
1734
|
-
* const value =
|
|
2897
|
+
* const propertyName = KEY_CONTACT_DETAIL_STREET;
|
|
2898
|
+
* const value = contactdetail[propertyName];
|
|
1735
2899
|
* ```
|
|
1736
2900
|
*
|
|
1737
|
-
* @see {@link
|
|
1738
|
-
* @see {@link
|
|
2901
|
+
* @see {@link ContactDetail} - The TypeScript type definition
|
|
2902
|
+
* @see {@link KEYS_CONTACT_DETAIL} - Array of all keys for this type
|
|
1739
2903
|
*/
|
|
1740
|
-
export const
|
|
2904
|
+
export const KEY_CONTACT_DETAIL_STREET: keyof ContactDetail = 'street';
|
|
1741
2905
|
/**
|
|
1742
2906
|
* Title
|
|
1743
2907
|
*
|
|
@@ -1746,59 +2910,64 @@ export const KEY_CONTACT_CREATE_STREET: keyof ContactCreate = 'street';
|
|
|
1746
2910
|
*
|
|
1747
2911
|
*
|
|
1748
2912
|
* @remarks
|
|
1749
|
-
* This key constant provides type-safe access to the `title` property of
|
|
2913
|
+
* This key constant provides type-safe access to the `title` property of ContactDetail objects.
|
|
1750
2914
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1751
2915
|
*
|
|
1752
2916
|
* @example
|
|
1753
2917
|
* ```typescript
|
|
1754
2918
|
* // Direct property access
|
|
1755
|
-
* const value =
|
|
2919
|
+
* const value = contactdetail[KEY_CONTACT_DETAIL_TITLE];
|
|
1756
2920
|
*
|
|
1757
2921
|
* // Dynamic property access
|
|
1758
|
-
* const propertyName =
|
|
1759
|
-
* const value =
|
|
2922
|
+
* const propertyName = KEY_CONTACT_DETAIL_TITLE;
|
|
2923
|
+
* const value = contactdetail[propertyName];
|
|
1760
2924
|
* ```
|
|
1761
2925
|
*
|
|
1762
|
-
* @see {@link
|
|
1763
|
-
* @see {@link
|
|
2926
|
+
* @see {@link ContactDetail} - The TypeScript type definition
|
|
2927
|
+
* @see {@link KEYS_CONTACT_DETAIL} - Array of all keys for this type
|
|
1764
2928
|
*/
|
|
1765
|
-
export const
|
|
2929
|
+
export const KEY_CONTACT_DETAIL_TITLE: keyof ContactDetail = 'title';
|
|
1766
2930
|
|
|
1767
2931
|
/**
|
|
1768
|
-
* Array of all
|
|
2932
|
+
* Array of all ContactDetail property keys
|
|
1769
2933
|
*
|
|
1770
2934
|
* @remarks
|
|
1771
|
-
* This constant provides a readonly array containing all valid property keys for
|
|
2935
|
+
* This constant provides a readonly array containing all valid property keys for ContactDetail objects.
|
|
1772
2936
|
* Useful for iteration, validation, and generating dynamic UI components.
|
|
1773
2937
|
*
|
|
1774
2938
|
* @example
|
|
1775
2939
|
* ```typescript
|
|
1776
2940
|
* // Iterating through all keys
|
|
1777
|
-
* for (const key of
|
|
1778
|
-
* console.log(`Property: ${key}, Value: ${
|
|
2941
|
+
* for (const key of KEYS_CONTACT_DETAIL) {
|
|
2942
|
+
* console.log(`Property: ${key}, Value: ${contactdetail[key]}`);
|
|
1779
2943
|
* }
|
|
1780
2944
|
*
|
|
1781
2945
|
* // Validation
|
|
1782
|
-
* const isValidKey =
|
|
1783
|
-
* ```
|
|
1784
|
-
*
|
|
1785
|
-
* @see {@link
|
|
1786
|
-
*/
|
|
1787
|
-
export const
|
|
1788
|
-
|
|
1789
|
-
|
|
1790
|
-
|
|
1791
|
-
|
|
1792
|
-
|
|
1793
|
-
|
|
1794
|
-
|
|
1795
|
-
|
|
1796
|
-
|
|
1797
|
-
|
|
1798
|
-
|
|
1799
|
-
|
|
1800
|
-
|
|
1801
|
-
|
|
2946
|
+
* const isValidKey = KEYS_CONTACT_DETAIL.includes(someKey);
|
|
2947
|
+
* ```
|
|
2948
|
+
*
|
|
2949
|
+
* @see {@link ContactDetail} - The TypeScript type definition
|
|
2950
|
+
*/
|
|
2951
|
+
export const KEYS_CONTACT_DETAIL = [
|
|
2952
|
+
KEY_CONTACT_DETAIL_ATTRIBUTE_SETS,
|
|
2953
|
+
KEY_CONTACT_DETAIL_CITY,
|
|
2954
|
+
KEY_CONTACT_DETAIL_CONTACT_ID,
|
|
2955
|
+
KEY_CONTACT_DETAIL_COUNTRY,
|
|
2956
|
+
KEY_CONTACT_DETAIL_CREATED_ON,
|
|
2957
|
+
KEY_CONTACT_DETAIL_DELETED_ON,
|
|
2958
|
+
KEY_CONTACT_DETAIL_DISCLOSE,
|
|
2959
|
+
KEY_CONTACT_DETAIL_EMAIL,
|
|
2960
|
+
KEY_CONTACT_DETAIL_FAX,
|
|
2961
|
+
KEY_CONTACT_DETAIL_FIRST_NAME,
|
|
2962
|
+
KEY_CONTACT_DETAIL_LAST_NAME,
|
|
2963
|
+
KEY_CONTACT_DETAIL_ORG,
|
|
2964
|
+
KEY_CONTACT_DETAIL_ORGANIZATION_ID,
|
|
2965
|
+
KEY_CONTACT_DETAIL_PHONE,
|
|
2966
|
+
KEY_CONTACT_DETAIL_POSTAL_CODE,
|
|
2967
|
+
KEY_CONTACT_DETAIL_STATE,
|
|
2968
|
+
KEY_CONTACT_DETAIL_STREET,
|
|
2969
|
+
KEY_CONTACT_DETAIL_TITLE,
|
|
2970
|
+
] as const satisfies (keyof ContactDetail)[];
|
|
1802
2971
|
|
|
1803
2972
|
/**
|
|
1804
2973
|
* Attributes
|