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