@opusdns/api 0.209.0 → 0.211.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.
@@ -43,7 +43,6 @@ import { ContactAttributeSet } from './schemas';
43
43
  import { ContactAttributeSetUpdate } from './schemas';
44
44
  import { ContactConfigBase } from './schemas';
45
45
  import { ContactCreate } from './schemas';
46
- import { ContactDetail } from './schemas';
47
46
  import { ContactHandle } from './schemas';
48
47
  import { Contact } from './schemas';
49
48
  import { ContactSchema } from './schemas';
@@ -1830,6 +1829,32 @@ export const KEY_CONTACT_ATTRIBUTE_SET_CREATED_ON: keyof ContactAttributeSet = '
1830
1829
  * @see {@link KEYS_CONTACT_ATTRIBUTE_SET} - Array of all keys for this type
1831
1830
  */
1832
1831
  export const KEY_CONTACT_ATTRIBUTE_SET_LABEL: keyof ContactAttributeSet = 'label';
1832
+ /**
1833
+ * Linked Contacts
1834
+ *
1835
+ * Number of contacts linked to this attribute set
1836
+ *
1837
+ * @type {integer}
1838
+ *
1839
+ *
1840
+ * @remarks
1841
+ * This key constant provides type-safe access to the `linked_contacts` property of ContactAttributeSet objects.
1842
+ * Use this constant when you need to access properties dynamically or ensure type safety.
1843
+ *
1844
+ * @example
1845
+ * ```typescript
1846
+ * // Direct property access
1847
+ * const value = contactattributeset[KEY_CONTACT_ATTRIBUTE_SET_LINKED_CONTACTS];
1848
+ *
1849
+ * // Dynamic property access
1850
+ * const propertyName = KEY_CONTACT_ATTRIBUTE_SET_LINKED_CONTACTS;
1851
+ * const value = contactattributeset[propertyName];
1852
+ * ```
1853
+ *
1854
+ * @see {@link ContactAttributeSet} - The TypeScript type definition
1855
+ * @see {@link KEYS_CONTACT_ATTRIBUTE_SET} - Array of all keys for this type
1856
+ */
1857
+ export const KEY_CONTACT_ATTRIBUTE_SET_LINKED_CONTACTS: keyof ContactAttributeSet = 'linked_contacts';
1833
1858
  /**
1834
1859
  * Organization Id
1835
1860
  *
@@ -1934,6 +1959,7 @@ export const KEYS_CONTACT_ATTRIBUTE_SET = [
1934
1959
  KEY_CONTACT_ATTRIBUTE_SET_CONTACT_ATTRIBUTE_SET_ID,
1935
1960
  KEY_CONTACT_ATTRIBUTE_SET_CREATED_ON,
1936
1961
  KEY_CONTACT_ATTRIBUTE_SET_LABEL,
1962
+ KEY_CONTACT_ATTRIBUTE_SET_LINKED_CONTACTS,
1937
1963
  KEY_CONTACT_ATTRIBUTE_SET_ORGANIZATION_ID,
1938
1964
  KEY_CONTACT_ATTRIBUTE_SET_TLD,
1939
1965
  KEY_CONTACT_ATTRIBUTE_SET_UPDATED_ON,
@@ -2465,638 +2491,211 @@ export const KEYS_CONTACT_CREATE = [
2465
2491
  ] as const satisfies (keyof ContactCreate)[];
2466
2492
 
2467
2493
  /**
2468
- * Attribute Sets
2469
- *
2470
- * Linked attribute sets for this contact
2471
- *
2472
- * @type {array}
2473
- *
2474
- *
2475
- * @remarks
2476
- * This key constant provides type-safe access to the `attribute_sets` property of ContactDetail objects.
2477
- * Use this constant when you need to access properties dynamically or ensure type safety.
2478
- *
2479
- * @example
2480
- * ```typescript
2481
- * // Direct property access
2482
- * const value = contactdetail[KEY_CONTACT_DETAIL_ATTRIBUTE_SETS];
2483
- *
2484
- * // Dynamic property access
2485
- * const propertyName = KEY_CONTACT_DETAIL_ATTRIBUTE_SETS;
2486
- * const value = contactdetail[propertyName];
2487
- * ```
2488
- *
2489
- * @see {@link ContactDetail} - The TypeScript type definition
2490
- * @see {@link KEYS_CONTACT_DETAIL} - Array of all keys for this type
2491
- */
2492
- export const KEY_CONTACT_DETAIL_ATTRIBUTE_SETS: keyof ContactDetail = 'attribute_sets';
2493
- /**
2494
- * City
2494
+ * Attributes
2495
2495
  *
2496
- * The city of the contact
2496
+ * Additional attributes related to the contact
2497
2497
  *
2498
- * @type {string}
2499
2498
  *
2500
2499
  *
2501
2500
  * @remarks
2502
- * This key constant provides type-safe access to the `city` property of ContactDetail objects.
2501
+ * This key constant provides type-safe access to the `attributes` property of ContactHandle objects.
2503
2502
  * Use this constant when you need to access properties dynamically or ensure type safety.
2504
2503
  *
2505
2504
  * @example
2506
2505
  * ```typescript
2507
2506
  * // Direct property access
2508
- * const value = contactdetail[KEY_CONTACT_DETAIL_CITY];
2507
+ * const value = contacthandle[KEY_CONTACT_HANDLE_ATTRIBUTES];
2509
2508
  *
2510
2509
  * // Dynamic property access
2511
- * const propertyName = KEY_CONTACT_DETAIL_CITY;
2512
- * const value = contactdetail[propertyName];
2510
+ * const propertyName = KEY_CONTACT_HANDLE_ATTRIBUTES;
2511
+ * const value = contacthandle[propertyName];
2513
2512
  * ```
2514
2513
  *
2515
- * @see {@link ContactDetail} - The TypeScript type definition
2516
- * @see {@link KEYS_CONTACT_DETAIL} - Array of all keys for this type
2514
+ * @see {@link ContactHandle} - The TypeScript type definition
2515
+ * @see {@link KEYS_CONTACT_HANDLE} - Array of all keys for this type
2517
2516
  */
2518
- export const KEY_CONTACT_DETAIL_CITY: keyof ContactDetail = 'city';
2517
+ export const KEY_CONTACT_HANDLE_ATTRIBUTES: keyof ContactHandle = 'attributes';
2519
2518
  /**
2520
2519
  * Contact Id
2521
2520
  *
2521
+ * The contact id of the contact
2522
2522
  *
2523
2523
  * @type {string}
2524
2524
  *
2525
2525
  *
2526
2526
  * @remarks
2527
- * This key constant provides type-safe access to the `contact_id` property of ContactDetail objects.
2528
- * Use this constant when you need to access properties dynamically or ensure type safety.
2529
- *
2530
- * @example
2531
- * ```typescript
2532
- * // Direct property access
2533
- * const value = contactdetail[KEY_CONTACT_DETAIL_CONTACT_ID];
2534
- *
2535
- * // Dynamic property access
2536
- * const propertyName = KEY_CONTACT_DETAIL_CONTACT_ID;
2537
- * const value = contactdetail[propertyName];
2538
- * ```
2539
- *
2540
- * @see {@link ContactDetail} - The TypeScript type definition
2541
- * @see {@link KEYS_CONTACT_DETAIL} - Array of all keys for this type
2542
- */
2543
- export const KEY_CONTACT_DETAIL_CONTACT_ID: keyof ContactDetail = 'contact_id';
2544
- /**
2545
- * Country
2546
- *
2547
- * The country of the contact
2548
- *
2549
- * @type {string}
2550
- *
2551
- *
2552
- * @remarks
2553
- * This key constant provides type-safe access to the `country` property of ContactDetail objects.
2554
- * Use this constant when you need to access properties dynamically or ensure type safety.
2555
- *
2556
- * @example
2557
- * ```typescript
2558
- * // Direct property access
2559
- * const value = contactdetail[KEY_CONTACT_DETAIL_COUNTRY];
2560
- *
2561
- * // Dynamic property access
2562
- * const propertyName = KEY_CONTACT_DETAIL_COUNTRY;
2563
- * const value = contactdetail[propertyName];
2564
- * ```
2565
- *
2566
- * @see {@link ContactDetail} - The TypeScript type definition
2567
- * @see {@link KEYS_CONTACT_DETAIL} - Array of all keys for this type
2568
- */
2569
- export const KEY_CONTACT_DETAIL_COUNTRY: keyof ContactDetail = 'country';
2570
- /**
2571
- * Created On
2572
- *
2573
- * The date/time the entry was created on
2574
- *
2575
- * @type {string}
2576
- *
2577
- *
2578
- * @remarks
2579
- * This key constant provides type-safe access to the `created_on` property of ContactDetail objects.
2580
- * Use this constant when you need to access properties dynamically or ensure type safety.
2581
- *
2582
- * @example
2583
- * ```typescript
2584
- * // Direct property access
2585
- * const value = contactdetail[KEY_CONTACT_DETAIL_CREATED_ON];
2586
- *
2587
- * // Dynamic property access
2588
- * const propertyName = KEY_CONTACT_DETAIL_CREATED_ON;
2589
- * const value = contactdetail[propertyName];
2590
- * ```
2591
- *
2592
- * @see {@link ContactDetail} - The TypeScript type definition
2593
- * @see {@link KEYS_CONTACT_DETAIL} - Array of all keys for this type
2594
- */
2595
- export const KEY_CONTACT_DETAIL_CREATED_ON: keyof ContactDetail = 'created_on';
2596
- /**
2597
- * Deleted On
2598
- *
2599
- * The date/time the entry was deleted on
2600
- *
2601
- *
2602
- *
2603
- * @remarks
2604
- * This key constant provides type-safe access to the `deleted_on` property of ContactDetail objects.
2605
- * Use this constant when you need to access properties dynamically or ensure type safety.
2606
- *
2607
- * @example
2608
- * ```typescript
2609
- * // Direct property access
2610
- * const value = contactdetail[KEY_CONTACT_DETAIL_DELETED_ON];
2611
- *
2612
- * // Dynamic property access
2613
- * const propertyName = KEY_CONTACT_DETAIL_DELETED_ON;
2614
- * const value = contactdetail[propertyName];
2615
- * ```
2616
- *
2617
- * @see {@link ContactDetail} - The TypeScript type definition
2618
- * @see {@link KEYS_CONTACT_DETAIL} - Array of all keys for this type
2619
- */
2620
- export const KEY_CONTACT_DETAIL_DELETED_ON: keyof ContactDetail = 'deleted_on';
2621
- /**
2622
- * Disclose
2623
- *
2624
- * 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.
2625
- *
2626
- * @type {boolean}
2627
- *
2628
- *
2629
- * @remarks
2630
- * This key constant provides type-safe access to the `disclose` property of ContactDetail objects.
2631
- * Use this constant when you need to access properties dynamically or ensure type safety.
2632
- *
2633
- * @example
2634
- * ```typescript
2635
- * // Direct property access
2636
- * const value = contactdetail[KEY_CONTACT_DETAIL_DISCLOSE];
2637
- *
2638
- * // Dynamic property access
2639
- * const propertyName = KEY_CONTACT_DETAIL_DISCLOSE;
2640
- * const value = contactdetail[propertyName];
2641
- * ```
2642
- *
2643
- * @see {@link ContactDetail} - The TypeScript type definition
2644
- * @see {@link KEYS_CONTACT_DETAIL} - Array of all keys for this type
2645
- */
2646
- export const KEY_CONTACT_DETAIL_DISCLOSE: keyof ContactDetail = 'disclose';
2647
- /**
2648
- * Email
2649
- *
2650
- * The email of the contact
2651
- *
2652
- * @type {string}
2653
- *
2654
- *
2655
- * @remarks
2656
- * This key constant provides type-safe access to the `email` property of ContactDetail objects.
2657
- * Use this constant when you need to access properties dynamically or ensure type safety.
2658
- *
2659
- * @example
2660
- * ```typescript
2661
- * // Direct property access
2662
- * const value = contactdetail[KEY_CONTACT_DETAIL_EMAIL];
2663
- *
2664
- * // Dynamic property access
2665
- * const propertyName = KEY_CONTACT_DETAIL_EMAIL;
2666
- * const value = contactdetail[propertyName];
2667
- * ```
2668
- *
2669
- * @see {@link ContactDetail} - The TypeScript type definition
2670
- * @see {@link KEYS_CONTACT_DETAIL} - Array of all keys for this type
2671
- */
2672
- export const KEY_CONTACT_DETAIL_EMAIL: keyof ContactDetail = 'email';
2673
- /**
2674
- * Fax
2675
- *
2676
- * The contacts's fax number
2677
- *
2678
- *
2679
- *
2680
- * @remarks
2681
- * This key constant provides type-safe access to the `fax` property of ContactDetail objects.
2682
- * Use this constant when you need to access properties dynamically or ensure type safety.
2683
- *
2684
- * @example
2685
- * ```typescript
2686
- * // Direct property access
2687
- * const value = contactdetail[KEY_CONTACT_DETAIL_FAX];
2688
- *
2689
- * // Dynamic property access
2690
- * const propertyName = KEY_CONTACT_DETAIL_FAX;
2691
- * const value = contactdetail[propertyName];
2692
- * ```
2693
- *
2694
- * @see {@link ContactDetail} - The TypeScript type definition
2695
- * @see {@link KEYS_CONTACT_DETAIL} - Array of all keys for this type
2696
- */
2697
- export const KEY_CONTACT_DETAIL_FAX: keyof ContactDetail = 'fax';
2698
- /**
2699
- * First Name
2700
- *
2701
- * The first name of the contact
2702
- *
2703
- * @type {string}
2704
- *
2705
- *
2706
- * @remarks
2707
- * This key constant provides type-safe access to the `first_name` property of ContactDetail objects.
2708
- * Use this constant when you need to access properties dynamically or ensure type safety.
2709
- *
2710
- * @example
2711
- * ```typescript
2712
- * // Direct property access
2713
- * const value = contactdetail[KEY_CONTACT_DETAIL_FIRST_NAME];
2714
- *
2715
- * // Dynamic property access
2716
- * const propertyName = KEY_CONTACT_DETAIL_FIRST_NAME;
2717
- * const value = contactdetail[propertyName];
2718
- * ```
2719
- *
2720
- * @see {@link ContactDetail} - The TypeScript type definition
2721
- * @see {@link KEYS_CONTACT_DETAIL} - Array of all keys for this type
2722
- */
2723
- export const KEY_CONTACT_DETAIL_FIRST_NAME: keyof ContactDetail = 'first_name';
2724
- /**
2725
- * Last Name
2726
- *
2727
- * The last name of the contact
2728
- *
2729
- * @type {string}
2730
- *
2731
- *
2732
- * @remarks
2733
- * This key constant provides type-safe access to the `last_name` property of ContactDetail objects.
2734
- * Use this constant when you need to access properties dynamically or ensure type safety.
2735
- *
2736
- * @example
2737
- * ```typescript
2738
- * // Direct property access
2739
- * const value = contactdetail[KEY_CONTACT_DETAIL_LAST_NAME];
2740
- *
2741
- * // Dynamic property access
2742
- * const propertyName = KEY_CONTACT_DETAIL_LAST_NAME;
2743
- * const value = contactdetail[propertyName];
2744
- * ```
2745
- *
2746
- * @see {@link ContactDetail} - The TypeScript type definition
2747
- * @see {@link KEYS_CONTACT_DETAIL} - Array of all keys for this type
2748
- */
2749
- export const KEY_CONTACT_DETAIL_LAST_NAME: keyof ContactDetail = 'last_name';
2750
- /**
2751
- * Org
2752
- *
2753
- * The organization of the contact
2754
- *
2755
- *
2756
- *
2757
- * @remarks
2758
- * This key constant provides type-safe access to the `org` property of ContactDetail objects.
2759
- * Use this constant when you need to access properties dynamically or ensure type safety.
2760
- *
2761
- * @example
2762
- * ```typescript
2763
- * // Direct property access
2764
- * const value = contactdetail[KEY_CONTACT_DETAIL_ORG];
2765
- *
2766
- * // Dynamic property access
2767
- * const propertyName = KEY_CONTACT_DETAIL_ORG;
2768
- * const value = contactdetail[propertyName];
2769
- * ```
2770
- *
2771
- * @see {@link ContactDetail} - The TypeScript type definition
2772
- * @see {@link KEYS_CONTACT_DETAIL} - Array of all keys for this type
2773
- */
2774
- export const KEY_CONTACT_DETAIL_ORG: keyof ContactDetail = 'org';
2775
- /**
2776
- * Organization Id
2777
- *
2778
- * The organization that owns the domain
2779
- *
2780
- * @type {string}
2781
- *
2782
- *
2783
- * @remarks
2784
- * This key constant provides type-safe access to the `organization_id` property of ContactDetail objects.
2785
- * Use this constant when you need to access properties dynamically or ensure type safety.
2786
- *
2787
- * @example
2788
- * ```typescript
2789
- * // Direct property access
2790
- * const value = contactdetail[KEY_CONTACT_DETAIL_ORGANIZATION_ID];
2791
- *
2792
- * // Dynamic property access
2793
- * const propertyName = KEY_CONTACT_DETAIL_ORGANIZATION_ID;
2794
- * const value = contactdetail[propertyName];
2795
- * ```
2796
- *
2797
- * @see {@link ContactDetail} - The TypeScript type definition
2798
- * @see {@link KEYS_CONTACT_DETAIL} - Array of all keys for this type
2799
- */
2800
- export const KEY_CONTACT_DETAIL_ORGANIZATION_ID: keyof ContactDetail = 'organization_id';
2801
- /**
2802
- * Phone
2803
- *
2804
- * The contact's phone number
2805
- *
2806
- * @type {string}
2807
- *
2808
- *
2809
- * @remarks
2810
- * This key constant provides type-safe access to the `phone` property of ContactDetail objects.
2527
+ * This key constant provides type-safe access to the `contact_id` property of ContactHandle objects.
2811
2528
  * Use this constant when you need to access properties dynamically or ensure type safety.
2812
2529
  *
2813
2530
  * @example
2814
2531
  * ```typescript
2815
2532
  * // Direct property access
2816
- * const value = contactdetail[KEY_CONTACT_DETAIL_PHONE];
2533
+ * const value = contacthandle[KEY_CONTACT_HANDLE_CONTACT_ID];
2817
2534
  *
2818
2535
  * // Dynamic property access
2819
- * const propertyName = KEY_CONTACT_DETAIL_PHONE;
2820
- * const value = contactdetail[propertyName];
2536
+ * const propertyName = KEY_CONTACT_HANDLE_CONTACT_ID;
2537
+ * const value = contacthandle[propertyName];
2821
2538
  * ```
2822
2539
  *
2823
- * @see {@link ContactDetail} - The TypeScript type definition
2824
- * @see {@link KEYS_CONTACT_DETAIL} - Array of all keys for this type
2540
+ * @see {@link ContactHandle} - The TypeScript type definition
2541
+ * @see {@link KEYS_CONTACT_HANDLE} - Array of all keys for this type
2825
2542
  */
2826
- export const KEY_CONTACT_DETAIL_PHONE: keyof ContactDetail = 'phone';
2543
+ export const KEY_CONTACT_HANDLE_CONTACT_ID: keyof ContactHandle = 'contact_id';
2544
+
2827
2545
  /**
2828
- * Postal Code
2829
- *
2830
- * The postal code of the contact
2831
- *
2832
- * @type {string}
2833
- *
2546
+ * Array of all ContactHandle property keys
2834
2547
  *
2835
2548
  * @remarks
2836
- * This key constant provides type-safe access to the `postal_code` property of ContactDetail objects.
2837
- * Use this constant when you need to access properties dynamically or ensure type safety.
2549
+ * This constant provides a readonly array containing all valid property keys for ContactHandle objects.
2550
+ * Useful for iteration, validation, and generating dynamic UI components.
2838
2551
  *
2839
2552
  * @example
2840
2553
  * ```typescript
2841
- * // Direct property access
2842
- * const value = contactdetail[KEY_CONTACT_DETAIL_POSTAL_CODE];
2554
+ * // Iterating through all keys
2555
+ * for (const key of KEYS_CONTACT_HANDLE) {
2556
+ * console.log(`Property: ${key}, Value: ${contacthandle[key]}`);
2557
+ * }
2843
2558
  *
2844
- * // Dynamic property access
2845
- * const propertyName = KEY_CONTACT_DETAIL_POSTAL_CODE;
2846
- * const value = contactdetail[propertyName];
2559
+ * // Validation
2560
+ * const isValidKey = KEYS_CONTACT_HANDLE.includes(someKey);
2847
2561
  * ```
2848
2562
  *
2849
- * @see {@link ContactDetail} - The TypeScript type definition
2850
- * @see {@link KEYS_CONTACT_DETAIL} - Array of all keys for this type
2563
+ * @see {@link ContactHandle} - The TypeScript type definition
2851
2564
  */
2852
- export const KEY_CONTACT_DETAIL_POSTAL_CODE: keyof ContactDetail = 'postal_code';
2565
+ export const KEYS_CONTACT_HANDLE = [
2566
+ KEY_CONTACT_HANDLE_ATTRIBUTES,
2567
+ KEY_CONTACT_HANDLE_CONTACT_ID,
2568
+ ] as const satisfies (keyof ContactHandle)[];
2569
+
2853
2570
  /**
2854
- * State
2571
+ * Attribute Sets
2855
2572
  *
2856
- * The state of the contact
2573
+ * Linked attribute sets for this contact
2857
2574
  *
2575
+ * @type {array}
2858
2576
  *
2859
2577
  *
2860
2578
  * @remarks
2861
- * This key constant provides type-safe access to the `state` property of ContactDetail objects.
2579
+ * This key constant provides type-safe access to the `attribute_sets` property of Contact objects.
2862
2580
  * Use this constant when you need to access properties dynamically or ensure type safety.
2863
2581
  *
2864
2582
  * @example
2865
2583
  * ```typescript
2866
2584
  * // Direct property access
2867
- * const value = contactdetail[KEY_CONTACT_DETAIL_STATE];
2585
+ * const value = contact[KEY_CONTACT_ATTRIBUTE_SETS];
2868
2586
  *
2869
2587
  * // Dynamic property access
2870
- * const propertyName = KEY_CONTACT_DETAIL_STATE;
2871
- * const value = contactdetail[propertyName];
2588
+ * const propertyName = KEY_CONTACT_ATTRIBUTE_SETS;
2589
+ * const value = contact[propertyName];
2872
2590
  * ```
2873
2591
  *
2874
- * @see {@link ContactDetail} - The TypeScript type definition
2875
- * @see {@link KEYS_CONTACT_DETAIL} - Array of all keys for this type
2592
+ * @see {@link Contact} - The TypeScript type definition
2593
+ * @see {@link KEYS_CONTACT} - Array of all keys for this type
2876
2594
  */
2877
- export const KEY_CONTACT_DETAIL_STATE: keyof ContactDetail = 'state';
2595
+ export const KEY_CONTACT_ATTRIBUTE_SETS: keyof Contact = 'attribute_sets';
2878
2596
  /**
2879
- * Street
2597
+ * City
2880
2598
  *
2881
- * The address of the contact
2599
+ * The city of the contact
2882
2600
  *
2883
2601
  * @type {string}
2884
2602
  *
2885
2603
  *
2886
2604
  * @remarks
2887
- * This key constant provides type-safe access to the `street` property of ContactDetail objects.
2888
- * Use this constant when you need to access properties dynamically or ensure type safety.
2889
- *
2890
- * @example
2891
- * ```typescript
2892
- * // Direct property access
2893
- * const value = contactdetail[KEY_CONTACT_DETAIL_STREET];
2894
- *
2895
- * // Dynamic property access
2896
- * const propertyName = KEY_CONTACT_DETAIL_STREET;
2897
- * const value = contactdetail[propertyName];
2898
- * ```
2899
- *
2900
- * @see {@link ContactDetail} - The TypeScript type definition
2901
- * @see {@link KEYS_CONTACT_DETAIL} - Array of all keys for this type
2902
- */
2903
- export const KEY_CONTACT_DETAIL_STREET: keyof ContactDetail = 'street';
2904
- /**
2905
- * Title
2906
- *
2907
- * The title of the contact
2908
- *
2909
- *
2910
- *
2911
- * @remarks
2912
- * This key constant provides type-safe access to the `title` property of ContactDetail objects.
2913
- * Use this constant when you need to access properties dynamically or ensure type safety.
2914
- *
2915
- * @example
2916
- * ```typescript
2917
- * // Direct property access
2918
- * const value = contactdetail[KEY_CONTACT_DETAIL_TITLE];
2919
- *
2920
- * // Dynamic property access
2921
- * const propertyName = KEY_CONTACT_DETAIL_TITLE;
2922
- * const value = contactdetail[propertyName];
2923
- * ```
2924
- *
2925
- * @see {@link ContactDetail} - The TypeScript type definition
2926
- * @see {@link KEYS_CONTACT_DETAIL} - Array of all keys for this type
2927
- */
2928
- export const KEY_CONTACT_DETAIL_TITLE: keyof ContactDetail = 'title';
2929
-
2930
- /**
2931
- * Array of all ContactDetail property keys
2932
- *
2933
- * @remarks
2934
- * This constant provides a readonly array containing all valid property keys for ContactDetail objects.
2935
- * Useful for iteration, validation, and generating dynamic UI components.
2936
- *
2937
- * @example
2938
- * ```typescript
2939
- * // Iterating through all keys
2940
- * for (const key of KEYS_CONTACT_DETAIL) {
2941
- * console.log(`Property: ${key}, Value: ${contactdetail[key]}`);
2942
- * }
2943
- *
2944
- * // Validation
2945
- * const isValidKey = KEYS_CONTACT_DETAIL.includes(someKey);
2946
- * ```
2947
- *
2948
- * @see {@link ContactDetail} - The TypeScript type definition
2949
- */
2950
- export const KEYS_CONTACT_DETAIL = [
2951
- KEY_CONTACT_DETAIL_ATTRIBUTE_SETS,
2952
- KEY_CONTACT_DETAIL_CITY,
2953
- KEY_CONTACT_DETAIL_CONTACT_ID,
2954
- KEY_CONTACT_DETAIL_COUNTRY,
2955
- KEY_CONTACT_DETAIL_CREATED_ON,
2956
- KEY_CONTACT_DETAIL_DELETED_ON,
2957
- KEY_CONTACT_DETAIL_DISCLOSE,
2958
- KEY_CONTACT_DETAIL_EMAIL,
2959
- KEY_CONTACT_DETAIL_FAX,
2960
- KEY_CONTACT_DETAIL_FIRST_NAME,
2961
- KEY_CONTACT_DETAIL_LAST_NAME,
2962
- KEY_CONTACT_DETAIL_ORG,
2963
- KEY_CONTACT_DETAIL_ORGANIZATION_ID,
2964
- KEY_CONTACT_DETAIL_PHONE,
2965
- KEY_CONTACT_DETAIL_POSTAL_CODE,
2966
- KEY_CONTACT_DETAIL_STATE,
2967
- KEY_CONTACT_DETAIL_STREET,
2968
- KEY_CONTACT_DETAIL_TITLE,
2969
- ] as const satisfies (keyof ContactDetail)[];
2970
-
2971
- /**
2972
- * Attributes
2973
- *
2974
- * Additional attributes related to the contact
2975
- *
2976
- *
2977
- *
2978
- * @remarks
2979
- * This key constant provides type-safe access to the `attributes` property of ContactHandle objects.
2605
+ * This key constant provides type-safe access to the `city` property of Contact objects.
2980
2606
  * Use this constant when you need to access properties dynamically or ensure type safety.
2981
2607
  *
2982
2608
  * @example
2983
2609
  * ```typescript
2984
2610
  * // Direct property access
2985
- * const value = contacthandle[KEY_CONTACT_HANDLE_ATTRIBUTES];
2611
+ * const value = contact[KEY_CONTACT_CITY];
2986
2612
  *
2987
2613
  * // Dynamic property access
2988
- * const propertyName = KEY_CONTACT_HANDLE_ATTRIBUTES;
2989
- * const value = contacthandle[propertyName];
2614
+ * const propertyName = KEY_CONTACT_CITY;
2615
+ * const value = contact[propertyName];
2990
2616
  * ```
2991
2617
  *
2992
- * @see {@link ContactHandle} - The TypeScript type definition
2993
- * @see {@link KEYS_CONTACT_HANDLE} - Array of all keys for this type
2618
+ * @see {@link Contact} - The TypeScript type definition
2619
+ * @see {@link KEYS_CONTACT} - Array of all keys for this type
2994
2620
  */
2995
- export const KEY_CONTACT_HANDLE_ATTRIBUTES: keyof ContactHandle = 'attributes';
2621
+ export const KEY_CONTACT_CITY: keyof Contact = 'city';
2996
2622
  /**
2997
2623
  * Contact Id
2998
2624
  *
2999
- * The contact id of the contact
3000
2625
  *
3001
2626
  * @type {string}
3002
2627
  *
3003
2628
  *
3004
2629
  * @remarks
3005
- * This key constant provides type-safe access to the `contact_id` property of ContactHandle objects.
2630
+ * This key constant provides type-safe access to the `contact_id` property of Contact objects.
3006
2631
  * Use this constant when you need to access properties dynamically or ensure type safety.
3007
2632
  *
3008
2633
  * @example
3009
2634
  * ```typescript
3010
2635
  * // Direct property access
3011
- * const value = contacthandle[KEY_CONTACT_HANDLE_CONTACT_ID];
2636
+ * const value = contact[KEY_CONTACT_CONTACT_ID];
3012
2637
  *
3013
2638
  * // Dynamic property access
3014
- * const propertyName = KEY_CONTACT_HANDLE_CONTACT_ID;
3015
- * const value = contacthandle[propertyName];
3016
- * ```
3017
- *
3018
- * @see {@link ContactHandle} - The TypeScript type definition
3019
- * @see {@link KEYS_CONTACT_HANDLE} - Array of all keys for this type
3020
- */
3021
- export const KEY_CONTACT_HANDLE_CONTACT_ID: keyof ContactHandle = 'contact_id';
3022
-
3023
- /**
3024
- * Array of all ContactHandle property keys
3025
- *
3026
- * @remarks
3027
- * This constant provides a readonly array containing all valid property keys for ContactHandle objects.
3028
- * Useful for iteration, validation, and generating dynamic UI components.
3029
- *
3030
- * @example
3031
- * ```typescript
3032
- * // Iterating through all keys
3033
- * for (const key of KEYS_CONTACT_HANDLE) {
3034
- * console.log(`Property: ${key}, Value: ${contacthandle[key]}`);
3035
- * }
3036
- *
3037
- * // Validation
3038
- * const isValidKey = KEYS_CONTACT_HANDLE.includes(someKey);
2639
+ * const propertyName = KEY_CONTACT_CONTACT_ID;
2640
+ * const value = contact[propertyName];
3039
2641
  * ```
3040
2642
  *
3041
- * @see {@link ContactHandle} - The TypeScript type definition
2643
+ * @see {@link Contact} - The TypeScript type definition
2644
+ * @see {@link KEYS_CONTACT} - Array of all keys for this type
3042
2645
  */
3043
- export const KEYS_CONTACT_HANDLE = [
3044
- KEY_CONTACT_HANDLE_ATTRIBUTES,
3045
- KEY_CONTACT_HANDLE_CONTACT_ID,
3046
- ] as const satisfies (keyof ContactHandle)[];
3047
-
2646
+ export const KEY_CONTACT_CONTACT_ID: keyof Contact = 'contact_id';
3048
2647
  /**
3049
- * City
2648
+ * Country
3050
2649
  *
3051
- * The city of the contact
2650
+ * The country of the contact
3052
2651
  *
3053
2652
  * @type {string}
3054
2653
  *
3055
2654
  *
3056
2655
  * @remarks
3057
- * This key constant provides type-safe access to the `city` property of Contact objects.
2656
+ * This key constant provides type-safe access to the `country` property of Contact objects.
3058
2657
  * Use this constant when you need to access properties dynamically or ensure type safety.
3059
2658
  *
3060
2659
  * @example
3061
2660
  * ```typescript
3062
2661
  * // Direct property access
3063
- * const value = contact[KEY_CONTACT_CITY];
2662
+ * const value = contact[KEY_CONTACT_COUNTRY];
3064
2663
  *
3065
2664
  * // Dynamic property access
3066
- * const propertyName = KEY_CONTACT_CITY;
2665
+ * const propertyName = KEY_CONTACT_COUNTRY;
3067
2666
  * const value = contact[propertyName];
3068
2667
  * ```
3069
2668
  *
3070
2669
  * @see {@link Contact} - The TypeScript type definition
3071
2670
  * @see {@link KEYS_CONTACT} - Array of all keys for this type
3072
2671
  */
3073
- export const KEY_CONTACT_CITY: keyof Contact = 'city';
2672
+ export const KEY_CONTACT_COUNTRY: keyof Contact = 'country';
3074
2673
  /**
3075
- * Country
2674
+ * Created On
3076
2675
  *
3077
- * The country of the contact
2676
+ * The date/time the entry was created on
3078
2677
  *
3079
2678
  * @type {string}
3080
2679
  *
3081
2680
  *
3082
2681
  * @remarks
3083
- * This key constant provides type-safe access to the `country` property of Contact objects.
2682
+ * This key constant provides type-safe access to the `created_on` property of Contact objects.
3084
2683
  * Use this constant when you need to access properties dynamically or ensure type safety.
3085
2684
  *
3086
2685
  * @example
3087
2686
  * ```typescript
3088
2687
  * // Direct property access
3089
- * const value = contact[KEY_CONTACT_COUNTRY];
2688
+ * const value = contact[KEY_CONTACT_CREATED_ON];
3090
2689
  *
3091
2690
  * // Dynamic property access
3092
- * const propertyName = KEY_CONTACT_COUNTRY;
2691
+ * const propertyName = KEY_CONTACT_CREATED_ON;
3093
2692
  * const value = contact[propertyName];
3094
2693
  * ```
3095
2694
  *
3096
2695
  * @see {@link Contact} - The TypeScript type definition
3097
2696
  * @see {@link KEYS_CONTACT} - Array of all keys for this type
3098
2697
  */
3099
- export const KEY_CONTACT_COUNTRY: keyof Contact = 'country';
2698
+ export const KEY_CONTACT_CREATED_ON: keyof Contact = 'created_on';
3100
2699
  /**
3101
2700
  * Disclose
3102
2701
  *
@@ -3251,6 +2850,32 @@ export const KEY_CONTACT_LAST_NAME: keyof Contact = 'last_name';
3251
2850
  * @see {@link KEYS_CONTACT} - Array of all keys for this type
3252
2851
  */
3253
2852
  export const KEY_CONTACT_ORG: keyof Contact = 'org';
2853
+ /**
2854
+ * Organization Id
2855
+ *
2856
+ * The organization that owns the domain
2857
+ *
2858
+ * @type {string}
2859
+ *
2860
+ *
2861
+ * @remarks
2862
+ * This key constant provides type-safe access to the `organization_id` property of Contact objects.
2863
+ * Use this constant when you need to access properties dynamically or ensure type safety.
2864
+ *
2865
+ * @example
2866
+ * ```typescript
2867
+ * // Direct property access
2868
+ * const value = contact[KEY_CONTACT_ORGANIZATION_ID];
2869
+ *
2870
+ * // Dynamic property access
2871
+ * const propertyName = KEY_CONTACT_ORGANIZATION_ID;
2872
+ * const value = contact[propertyName];
2873
+ * ```
2874
+ *
2875
+ * @see {@link Contact} - The TypeScript type definition
2876
+ * @see {@link KEYS_CONTACT} - Array of all keys for this type
2877
+ */
2878
+ export const KEY_CONTACT_ORGANIZATION_ID: keyof Contact = 'organization_id';
3254
2879
  /**
3255
2880
  * Phone
3256
2881
  *
@@ -3401,14 +3026,18 @@ export const KEY_CONTACT_TITLE: keyof Contact = 'title';
3401
3026
  * @see {@link Contact} - The TypeScript type definition
3402
3027
  */
3403
3028
  export const KEYS_CONTACT = [
3029
+ KEY_CONTACT_ATTRIBUTE_SETS,
3404
3030
  KEY_CONTACT_CITY,
3031
+ KEY_CONTACT_CONTACT_ID,
3405
3032
  KEY_CONTACT_COUNTRY,
3033
+ KEY_CONTACT_CREATED_ON,
3406
3034
  KEY_CONTACT_DISCLOSE,
3407
3035
  KEY_CONTACT_EMAIL,
3408
3036
  KEY_CONTACT_FAX,
3409
3037
  KEY_CONTACT_FIRST_NAME,
3410
3038
  KEY_CONTACT_LAST_NAME,
3411
3039
  KEY_CONTACT_ORG,
3040
+ KEY_CONTACT_ORGANIZATION_ID,
3412
3041
  KEY_CONTACT_PHONE,
3413
3042
  KEY_CONTACT_POSTAL_CODE,
3414
3043
  KEY_CONTACT_STATE,
@@ -3519,31 +3148,6 @@ export const KEY_CONTACT_SCHEMA_COUNTRY: keyof ContactSchema = 'country';
3519
3148
  * @see {@link KEYS_CONTACT_SCHEMA} - Array of all keys for this type
3520
3149
  */
3521
3150
  export const KEY_CONTACT_SCHEMA_CREATED_ON: keyof ContactSchema = 'created_on';
3522
- /**
3523
- * Deleted On
3524
- *
3525
- * The date/time the entry was deleted on
3526
- *
3527
- *
3528
- *
3529
- * @remarks
3530
- * This key constant provides type-safe access to the `deleted_on` property of ContactSchema objects.
3531
- * Use this constant when you need to access properties dynamically or ensure type safety.
3532
- *
3533
- * @example
3534
- * ```typescript
3535
- * // Direct property access
3536
- * const value = contactschema[KEY_CONTACT_SCHEMA_DELETED_ON];
3537
- *
3538
- * // Dynamic property access
3539
- * const propertyName = KEY_CONTACT_SCHEMA_DELETED_ON;
3540
- * const value = contactschema[propertyName];
3541
- * ```
3542
- *
3543
- * @see {@link ContactSchema} - The TypeScript type definition
3544
- * @see {@link KEYS_CONTACT_SCHEMA} - Array of all keys for this type
3545
- */
3546
- export const KEY_CONTACT_SCHEMA_DELETED_ON: keyof ContactSchema = 'deleted_on';
3547
3151
  /**
3548
3152
  * Disclose
3549
3153
  *
@@ -3878,7 +3482,6 @@ export const KEYS_CONTACT_SCHEMA = [
3878
3482
  KEY_CONTACT_SCHEMA_CONTACT_ID,
3879
3483
  KEY_CONTACT_SCHEMA_COUNTRY,
3880
3484
  KEY_CONTACT_SCHEMA_CREATED_ON,
3881
- KEY_CONTACT_SCHEMA_DELETED_ON,
3882
3485
  KEY_CONTACT_SCHEMA_DISCLOSE,
3883
3486
  KEY_CONTACT_SCHEMA_EMAIL,
3884
3487
  KEY_CONTACT_SCHEMA_FAX,