@opusdns/api 0.209.0 → 0.210.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 CHANGED
@@ -3,7 +3,7 @@
3
3
  "@opusdns/api-spec-ts-generator": "^0.19.0"
4
4
  },
5
5
  "name": "@opusdns/api",
6
- "version": "0.209.0",
6
+ "version": "0.210.0",
7
7
  "description": "TypeScript types for the OpusDNS OpenAPI specification",
8
8
  "main": "./src/index.ts",
9
9
  "module": "./src/index.ts",
@@ -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';
@@ -2465,638 +2464,211 @@ export const KEYS_CONTACT_CREATE = [
2465
2464
  ] as const satisfies (keyof ContactCreate)[];
2466
2465
 
2467
2466
  /**
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
2467
+ * Attributes
2495
2468
  *
2496
- * The city of the contact
2469
+ * Additional attributes related to the contact
2497
2470
  *
2498
- * @type {string}
2499
2471
  *
2500
2472
  *
2501
2473
  * @remarks
2502
- * This key constant provides type-safe access to the `city` property of ContactDetail objects.
2474
+ * This key constant provides type-safe access to the `attributes` property of ContactHandle objects.
2503
2475
  * Use this constant when you need to access properties dynamically or ensure type safety.
2504
2476
  *
2505
2477
  * @example
2506
2478
  * ```typescript
2507
2479
  * // Direct property access
2508
- * const value = contactdetail[KEY_CONTACT_DETAIL_CITY];
2480
+ * const value = contacthandle[KEY_CONTACT_HANDLE_ATTRIBUTES];
2509
2481
  *
2510
2482
  * // Dynamic property access
2511
- * const propertyName = KEY_CONTACT_DETAIL_CITY;
2512
- * const value = contactdetail[propertyName];
2483
+ * const propertyName = KEY_CONTACT_HANDLE_ATTRIBUTES;
2484
+ * const value = contacthandle[propertyName];
2513
2485
  * ```
2514
2486
  *
2515
- * @see {@link ContactDetail} - The TypeScript type definition
2516
- * @see {@link KEYS_CONTACT_DETAIL} - Array of all keys for this type
2487
+ * @see {@link ContactHandle} - The TypeScript type definition
2488
+ * @see {@link KEYS_CONTACT_HANDLE} - Array of all keys for this type
2517
2489
  */
2518
- export const KEY_CONTACT_DETAIL_CITY: keyof ContactDetail = 'city';
2490
+ export const KEY_CONTACT_HANDLE_ATTRIBUTES: keyof ContactHandle = 'attributes';
2519
2491
  /**
2520
2492
  * Contact Id
2521
2493
  *
2494
+ * The contact id of the contact
2522
2495
  *
2523
2496
  * @type {string}
2524
2497
  *
2525
2498
  *
2526
2499
  * @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.
2500
+ * This key constant provides type-safe access to the `contact_id` property of ContactHandle objects.
2811
2501
  * Use this constant when you need to access properties dynamically or ensure type safety.
2812
2502
  *
2813
2503
  * @example
2814
2504
  * ```typescript
2815
2505
  * // Direct property access
2816
- * const value = contactdetail[KEY_CONTACT_DETAIL_PHONE];
2506
+ * const value = contacthandle[KEY_CONTACT_HANDLE_CONTACT_ID];
2817
2507
  *
2818
2508
  * // Dynamic property access
2819
- * const propertyName = KEY_CONTACT_DETAIL_PHONE;
2820
- * const value = contactdetail[propertyName];
2509
+ * const propertyName = KEY_CONTACT_HANDLE_CONTACT_ID;
2510
+ * const value = contacthandle[propertyName];
2821
2511
  * ```
2822
2512
  *
2823
- * @see {@link ContactDetail} - The TypeScript type definition
2824
- * @see {@link KEYS_CONTACT_DETAIL} - Array of all keys for this type
2513
+ * @see {@link ContactHandle} - The TypeScript type definition
2514
+ * @see {@link KEYS_CONTACT_HANDLE} - Array of all keys for this type
2825
2515
  */
2826
- export const KEY_CONTACT_DETAIL_PHONE: keyof ContactDetail = 'phone';
2516
+ export const KEY_CONTACT_HANDLE_CONTACT_ID: keyof ContactHandle = 'contact_id';
2517
+
2827
2518
  /**
2828
- * Postal Code
2829
- *
2830
- * The postal code of the contact
2831
- *
2832
- * @type {string}
2833
- *
2519
+ * Array of all ContactHandle property keys
2834
2520
  *
2835
2521
  * @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.
2522
+ * This constant provides a readonly array containing all valid property keys for ContactHandle objects.
2523
+ * Useful for iteration, validation, and generating dynamic UI components.
2838
2524
  *
2839
2525
  * @example
2840
2526
  * ```typescript
2841
- * // Direct property access
2842
- * const value = contactdetail[KEY_CONTACT_DETAIL_POSTAL_CODE];
2527
+ * // Iterating through all keys
2528
+ * for (const key of KEYS_CONTACT_HANDLE) {
2529
+ * console.log(`Property: ${key}, Value: ${contacthandle[key]}`);
2530
+ * }
2843
2531
  *
2844
- * // Dynamic property access
2845
- * const propertyName = KEY_CONTACT_DETAIL_POSTAL_CODE;
2846
- * const value = contactdetail[propertyName];
2532
+ * // Validation
2533
+ * const isValidKey = KEYS_CONTACT_HANDLE.includes(someKey);
2847
2534
  * ```
2848
2535
  *
2849
- * @see {@link ContactDetail} - The TypeScript type definition
2850
- * @see {@link KEYS_CONTACT_DETAIL} - Array of all keys for this type
2536
+ * @see {@link ContactHandle} - The TypeScript type definition
2851
2537
  */
2852
- export const KEY_CONTACT_DETAIL_POSTAL_CODE: keyof ContactDetail = 'postal_code';
2538
+ export const KEYS_CONTACT_HANDLE = [
2539
+ KEY_CONTACT_HANDLE_ATTRIBUTES,
2540
+ KEY_CONTACT_HANDLE_CONTACT_ID,
2541
+ ] as const satisfies (keyof ContactHandle)[];
2542
+
2853
2543
  /**
2854
- * State
2544
+ * Attribute Sets
2855
2545
  *
2856
- * The state of the contact
2546
+ * Linked attribute sets for this contact
2857
2547
  *
2548
+ * @type {array}
2858
2549
  *
2859
2550
  *
2860
2551
  * @remarks
2861
- * This key constant provides type-safe access to the `state` property of ContactDetail objects.
2552
+ * This key constant provides type-safe access to the `attribute_sets` property of Contact objects.
2862
2553
  * Use this constant when you need to access properties dynamically or ensure type safety.
2863
2554
  *
2864
2555
  * @example
2865
2556
  * ```typescript
2866
2557
  * // Direct property access
2867
- * const value = contactdetail[KEY_CONTACT_DETAIL_STATE];
2558
+ * const value = contact[KEY_CONTACT_ATTRIBUTE_SETS];
2868
2559
  *
2869
2560
  * // Dynamic property access
2870
- * const propertyName = KEY_CONTACT_DETAIL_STATE;
2871
- * const value = contactdetail[propertyName];
2561
+ * const propertyName = KEY_CONTACT_ATTRIBUTE_SETS;
2562
+ * const value = contact[propertyName];
2872
2563
  * ```
2873
2564
  *
2874
- * @see {@link ContactDetail} - The TypeScript type definition
2875
- * @see {@link KEYS_CONTACT_DETAIL} - Array of all keys for this type
2565
+ * @see {@link Contact} - The TypeScript type definition
2566
+ * @see {@link KEYS_CONTACT} - Array of all keys for this type
2876
2567
  */
2877
- export const KEY_CONTACT_DETAIL_STATE: keyof ContactDetail = 'state';
2568
+ export const KEY_CONTACT_ATTRIBUTE_SETS: keyof Contact = 'attribute_sets';
2878
2569
  /**
2879
- * Street
2570
+ * City
2880
2571
  *
2881
- * The address of the contact
2572
+ * The city of the contact
2882
2573
  *
2883
2574
  * @type {string}
2884
2575
  *
2885
2576
  *
2886
2577
  * @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.
2578
+ * This key constant provides type-safe access to the `city` property of Contact objects.
2980
2579
  * Use this constant when you need to access properties dynamically or ensure type safety.
2981
2580
  *
2982
2581
  * @example
2983
2582
  * ```typescript
2984
2583
  * // Direct property access
2985
- * const value = contacthandle[KEY_CONTACT_HANDLE_ATTRIBUTES];
2584
+ * const value = contact[KEY_CONTACT_CITY];
2986
2585
  *
2987
2586
  * // Dynamic property access
2988
- * const propertyName = KEY_CONTACT_HANDLE_ATTRIBUTES;
2989
- * const value = contacthandle[propertyName];
2587
+ * const propertyName = KEY_CONTACT_CITY;
2588
+ * const value = contact[propertyName];
2990
2589
  * ```
2991
2590
  *
2992
- * @see {@link ContactHandle} - The TypeScript type definition
2993
- * @see {@link KEYS_CONTACT_HANDLE} - Array of all keys for this type
2591
+ * @see {@link Contact} - The TypeScript type definition
2592
+ * @see {@link KEYS_CONTACT} - Array of all keys for this type
2994
2593
  */
2995
- export const KEY_CONTACT_HANDLE_ATTRIBUTES: keyof ContactHandle = 'attributes';
2594
+ export const KEY_CONTACT_CITY: keyof Contact = 'city';
2996
2595
  /**
2997
2596
  * Contact Id
2998
2597
  *
2999
- * The contact id of the contact
3000
2598
  *
3001
2599
  * @type {string}
3002
2600
  *
3003
2601
  *
3004
2602
  * @remarks
3005
- * This key constant provides type-safe access to the `contact_id` property of ContactHandle objects.
2603
+ * This key constant provides type-safe access to the `contact_id` property of Contact objects.
3006
2604
  * Use this constant when you need to access properties dynamically or ensure type safety.
3007
2605
  *
3008
2606
  * @example
3009
2607
  * ```typescript
3010
2608
  * // Direct property access
3011
- * const value = contacthandle[KEY_CONTACT_HANDLE_CONTACT_ID];
2609
+ * const value = contact[KEY_CONTACT_CONTACT_ID];
3012
2610
  *
3013
2611
  * // 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);
2612
+ * const propertyName = KEY_CONTACT_CONTACT_ID;
2613
+ * const value = contact[propertyName];
3039
2614
  * ```
3040
2615
  *
3041
- * @see {@link ContactHandle} - The TypeScript type definition
2616
+ * @see {@link Contact} - The TypeScript type definition
2617
+ * @see {@link KEYS_CONTACT} - Array of all keys for this type
3042
2618
  */
3043
- export const KEYS_CONTACT_HANDLE = [
3044
- KEY_CONTACT_HANDLE_ATTRIBUTES,
3045
- KEY_CONTACT_HANDLE_CONTACT_ID,
3046
- ] as const satisfies (keyof ContactHandle)[];
3047
-
2619
+ export const KEY_CONTACT_CONTACT_ID: keyof Contact = 'contact_id';
3048
2620
  /**
3049
- * City
2621
+ * Country
3050
2622
  *
3051
- * The city of the contact
2623
+ * The country of the contact
3052
2624
  *
3053
2625
  * @type {string}
3054
2626
  *
3055
2627
  *
3056
2628
  * @remarks
3057
- * This key constant provides type-safe access to the `city` property of Contact objects.
2629
+ * This key constant provides type-safe access to the `country` property of Contact objects.
3058
2630
  * Use this constant when you need to access properties dynamically or ensure type safety.
3059
2631
  *
3060
2632
  * @example
3061
2633
  * ```typescript
3062
2634
  * // Direct property access
3063
- * const value = contact[KEY_CONTACT_CITY];
2635
+ * const value = contact[KEY_CONTACT_COUNTRY];
3064
2636
  *
3065
2637
  * // Dynamic property access
3066
- * const propertyName = KEY_CONTACT_CITY;
2638
+ * const propertyName = KEY_CONTACT_COUNTRY;
3067
2639
  * const value = contact[propertyName];
3068
2640
  * ```
3069
2641
  *
3070
2642
  * @see {@link Contact} - The TypeScript type definition
3071
2643
  * @see {@link KEYS_CONTACT} - Array of all keys for this type
3072
2644
  */
3073
- export const KEY_CONTACT_CITY: keyof Contact = 'city';
2645
+ export const KEY_CONTACT_COUNTRY: keyof Contact = 'country';
3074
2646
  /**
3075
- * Country
2647
+ * Created On
3076
2648
  *
3077
- * The country of the contact
2649
+ * The date/time the entry was created on
3078
2650
  *
3079
2651
  * @type {string}
3080
2652
  *
3081
2653
  *
3082
2654
  * @remarks
3083
- * This key constant provides type-safe access to the `country` property of Contact objects.
2655
+ * This key constant provides type-safe access to the `created_on` property of Contact objects.
3084
2656
  * Use this constant when you need to access properties dynamically or ensure type safety.
3085
2657
  *
3086
2658
  * @example
3087
2659
  * ```typescript
3088
2660
  * // Direct property access
3089
- * const value = contact[KEY_CONTACT_COUNTRY];
2661
+ * const value = contact[KEY_CONTACT_CREATED_ON];
3090
2662
  *
3091
2663
  * // Dynamic property access
3092
- * const propertyName = KEY_CONTACT_COUNTRY;
2664
+ * const propertyName = KEY_CONTACT_CREATED_ON;
3093
2665
  * const value = contact[propertyName];
3094
2666
  * ```
3095
2667
  *
3096
2668
  * @see {@link Contact} - The TypeScript type definition
3097
2669
  * @see {@link KEYS_CONTACT} - Array of all keys for this type
3098
2670
  */
3099
- export const KEY_CONTACT_COUNTRY: keyof Contact = 'country';
2671
+ export const KEY_CONTACT_CREATED_ON: keyof Contact = 'created_on';
3100
2672
  /**
3101
2673
  * Disclose
3102
2674
  *
@@ -3251,6 +2823,32 @@ export const KEY_CONTACT_LAST_NAME: keyof Contact = 'last_name';
3251
2823
  * @see {@link KEYS_CONTACT} - Array of all keys for this type
3252
2824
  */
3253
2825
  export const KEY_CONTACT_ORG: keyof Contact = 'org';
2826
+ /**
2827
+ * Organization Id
2828
+ *
2829
+ * The organization that owns the domain
2830
+ *
2831
+ * @type {string}
2832
+ *
2833
+ *
2834
+ * @remarks
2835
+ * This key constant provides type-safe access to the `organization_id` property of Contact objects.
2836
+ * Use this constant when you need to access properties dynamically or ensure type safety.
2837
+ *
2838
+ * @example
2839
+ * ```typescript
2840
+ * // Direct property access
2841
+ * const value = contact[KEY_CONTACT_ORGANIZATION_ID];
2842
+ *
2843
+ * // Dynamic property access
2844
+ * const propertyName = KEY_CONTACT_ORGANIZATION_ID;
2845
+ * const value = contact[propertyName];
2846
+ * ```
2847
+ *
2848
+ * @see {@link Contact} - The TypeScript type definition
2849
+ * @see {@link KEYS_CONTACT} - Array of all keys for this type
2850
+ */
2851
+ export const KEY_CONTACT_ORGANIZATION_ID: keyof Contact = 'organization_id';
3254
2852
  /**
3255
2853
  * Phone
3256
2854
  *
@@ -3401,14 +2999,18 @@ export const KEY_CONTACT_TITLE: keyof Contact = 'title';
3401
2999
  * @see {@link Contact} - The TypeScript type definition
3402
3000
  */
3403
3001
  export const KEYS_CONTACT = [
3002
+ KEY_CONTACT_ATTRIBUTE_SETS,
3404
3003
  KEY_CONTACT_CITY,
3004
+ KEY_CONTACT_CONTACT_ID,
3405
3005
  KEY_CONTACT_COUNTRY,
3006
+ KEY_CONTACT_CREATED_ON,
3406
3007
  KEY_CONTACT_DISCLOSE,
3407
3008
  KEY_CONTACT_EMAIL,
3408
3009
  KEY_CONTACT_FAX,
3409
3010
  KEY_CONTACT_FIRST_NAME,
3410
3011
  KEY_CONTACT_LAST_NAME,
3411
3012
  KEY_CONTACT_ORG,
3013
+ KEY_CONTACT_ORGANIZATION_ID,
3412
3014
  KEY_CONTACT_PHONE,
3413
3015
  KEY_CONTACT_POSTAL_CODE,
3414
3016
  KEY_CONTACT_STATE,
@@ -3519,31 +3121,6 @@ export const KEY_CONTACT_SCHEMA_COUNTRY: keyof ContactSchema = 'country';
3519
3121
  * @see {@link KEYS_CONTACT_SCHEMA} - Array of all keys for this type
3520
3122
  */
3521
3123
  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
3124
  /**
3548
3125
  * Disclose
3549
3126
  *
@@ -3878,7 +3455,6 @@ export const KEYS_CONTACT_SCHEMA = [
3878
3455
  KEY_CONTACT_SCHEMA_CONTACT_ID,
3879
3456
  KEY_CONTACT_SCHEMA_COUNTRY,
3880
3457
  KEY_CONTACT_SCHEMA_CREATED_ON,
3881
- KEY_CONTACT_SCHEMA_DELETED_ON,
3882
3458
  KEY_CONTACT_SCHEMA_DISCLOSE,
3883
3459
  KEY_CONTACT_SCHEMA_EMAIL,
3884
3460
  KEY_CONTACT_SCHEMA_FAX,
@@ -34,7 +34,7 @@
34
34
 
35
35
  import { DomainDnssecDataArray, OrganizationAttribute2Array, IpRestrictionArray, TldResponseShortArray } from './schemas-arrays.d';
36
36
 
37
- import { Pagination_EmailForwardLog, HTTPValidationError, Pagination_ObjectLog, Pagination_RequestHistory, Problem, DomainAvailabilityList, Pagination_ContactDetail, ContactSchema, Pagination_ContactAttributeSet, ContactAttributeSet, ContactDetail, ContactAttributeLink, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DomainForwardZone, EmailForwardZone, Pagination_DomainForwardZone, Pagination_EmailForwardZone, DnsZoneSummary, Pagination_DomainForward, DomainForward, DomainForwardSet, DomainForwardMetrics, DomainForwardBrowserStats, DomainForwardGeoStats, DomainForwardPlatformStats, DomainForwardReferrerStats, DomainForwardStatusCodeStats, DomainForwardMetricsTimeSeries, DomainForwardUserAgentStats, DomainForwardVisitsByKey, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, DomainWithdraw, RequestAuthcode, DomainTransit, RequestAuthcode2, Pagination_EmailForward, EmailForward, EmailForwardAlias, EmailForwardMetrics, Pagination_Event, EventSchema, Pagination_Organization, Organization, OrganizationWithBillingData, Pagination_Invoice, GetPrices, Pagination_BillingTransaction, BillingTransaction, IpRestriction, Pagination_UserPublic, Pagination_Parking, ParkingMetrics, ParkingTotalMetrics, ParkingSignup, ParkingSignupStatus, TldSpecification, UserPublic, UserPublicWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
37
+ import { Pagination_EmailForwardLog, HTTPValidationError, Pagination_ObjectLog, Pagination_RequestHistory, Problem, DomainAvailabilityList, Pagination_Contact, ContactSchema, Pagination_ContactAttributeSet, ContactAttributeSet, Contact, ContactAttributeLink, ContactVerification, Pagination_DnsZone, DnsZone, DnsChanges, DomainForwardZone, EmailForwardZone, Pagination_DomainForwardZone, Pagination_EmailForwardZone, DnsZoneSummary, Pagination_DomainForward, DomainForward, DomainForwardSet, DomainForwardMetrics, DomainForwardBrowserStats, DomainForwardGeoStats, DomainForwardPlatformStats, DomainForwardReferrerStats, DomainForwardStatusCodeStats, DomainForwardMetricsTimeSeries, DomainForwardUserAgentStats, DomainForwardVisitsByKey, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, DomainWithdraw, RequestAuthcode, DomainTransit, RequestAuthcode2, Pagination_EmailForward, EmailForward, EmailForwardAlias, EmailForwardMetrics, Pagination_Event, EventSchema, Pagination_Organization, Organization, OrganizationWithBillingData, Pagination_Invoice, GetPrices, Pagination_BillingTransaction, BillingTransaction, IpRestriction, Pagination_UserPublic, Pagination_Parking, ParkingMetrics, ParkingTotalMetrics, ParkingSignup, ParkingSignupStatus, TldSpecification, UserPublic, UserPublicWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
38
38
 
39
39
  /**
40
40
  * Response types for GET ArchiveEmailForwardLogsAliasesByEmailForwardAliasId endpoint
@@ -599,9 +599,9 @@ export type GET_Contacts_Response = GET_Contacts_Response_200 | GET_Contacts_Res
599
599
  * @path /v1/contacts
600
600
  *
601
601
  * @see {@link GET_Contacts_Response} - The main response type definition
602
- * @see {@link Pagination_ContactDetail} - The actual schema type definition
602
+ * @see {@link Pagination_Contact} - The actual schema type definition
603
603
  */
604
- export type GET_Contacts_Response_200 = Pagination_ContactDetail
604
+ export type GET_Contacts_Response_200 = Pagination_Contact
605
605
 
606
606
  /**
607
607
  * 422 response for GET Contacts endpoint
@@ -1135,9 +1135,9 @@ export type GET_ContactsByContactId_Response = GET_ContactsByContactId_Response_
1135
1135
  * @path /v1/contacts/{contact_id}
1136
1136
  *
1137
1137
  * @see {@link GET_ContactsByContactId_Response} - The main response type definition
1138
- * @see {@link ContactDetail} - The actual schema type definition
1138
+ * @see {@link Contact} - The actual schema type definition
1139
1139
  */
1140
- export type GET_ContactsByContactId_Response_200 = ContactDetail
1140
+ export type GET_ContactsByContactId_Response_200 = Contact
1141
1141
 
1142
1142
  /**
1143
1143
  * 404 response for GET ContactsByContactId endpoint
@@ -21,7 +21,7 @@
21
21
  * This file is auto-generated from the OpenAPI specification.
22
22
  * Do not edit manually.
23
23
  */
24
- import { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, TldResponseShort, AttributeCondition, DomainContactType, ContactAttributeLinkDetail, ContactAttributeDefinition, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, ContactHandle, Nameserver, BrowserStatsBucket, GeoStatsBucket, TimeSeriesBucket, DomainForwardPatchOp, PlatformStatsBucket, HttpRedirectRequest, HttpRedirectList, ReferrerStatsBucket, StatusCodeStatsBucket, UserAgentStatsBucket, VisitsByKeyBucket, DomainForward, DeletePolicyType, SyncOperationType, DomainContact, DomainHost, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, EmailForwardAliasCreate, EmailForwardLogEvent, EmailForwardAliasMetrics, EmailForwardAlias, EmailForward, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactAttributeSet, ContactDetail, DnsZone, DomainForwardZone, Domain, EmailForwardLog, EmailForwardZone, EventResponse, Invoice, ObjectLog, Organization, Parking, RequestHistory, UserPublic, Period, Permission, PremiumAffectsType, Relation, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
24
+ import { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, TldResponseShort, AttributeCondition, DomainContactType, ContactAttributeLinkDetail, ContactAttributeDefinition, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, ContactHandle, Nameserver, BrowserStatsBucket, GeoStatsBucket, TimeSeriesBucket, DomainForwardPatchOp, PlatformStatsBucket, HttpRedirectRequest, HttpRedirectList, ReferrerStatsBucket, StatusCodeStatsBucket, UserAgentStatsBucket, VisitsByKeyBucket, DomainForward, DeletePolicyType, SyncOperationType, DomainContact, DomainHost, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, EmailForwardAliasCreate, EmailForwardLogEvent, EmailForwardAliasMetrics, EmailForwardAlias, EmailForward, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactAttributeSet, Contact, DnsZone, DomainForwardZone, Domain, EmailForwardLog, EmailForwardZone, EventResponse, Invoice, ObjectLog, Organization, Parking, RequestHistory, UserPublic, Period, Permission, PremiumAffectsType, Relation, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
25
25
 
26
26
  /**
27
27
  * DomainDnssecDataResponse
@@ -808,19 +808,19 @@ export type BillingTransactionArray = BillingTransaction[];
808
808
  */
809
809
  export type ContactAttributeSetArray = ContactAttributeSet[];
810
810
  /**
811
- * ContactDetailResponse
811
+ * ContactResponse
812
812
  *
813
813
  * @remarks
814
- * Array type for ContactDetailResponse objects. Used when the API returns a collection of ContactDetailResponse instances.
814
+ * Array type for ContactResponse objects. Used when the API returns a collection of ContactResponse instances.
815
815
  *
816
816
  * @example
817
817
  * ```typescript
818
- * const items: ContactDetailArray = await api.getContactDetails();
818
+ * const items: ContactArray = await api.getContacts();
819
819
  * ```
820
820
  *
821
- * @see {@link ContactDetail} - The individual ContactDetailResponse type definition
821
+ * @see {@link Contact} - The individual ContactResponse type definition
822
822
  */
823
- export type ContactDetailArray = ContactDetail[];
823
+ export type ContactArray = Contact[];
824
824
  /**
825
825
  * DnsZoneResponse
826
826
  *
@@ -378,22 +378,6 @@ export type ContactConfigBase = components['schemas']['ContactConfigBase'];
378
378
  * @see {@link components} - The OpenAPI components schema definition
379
379
  */
380
380
  export type ContactCreate = components['schemas']['ContactCreate'];
381
- /**
382
- * ContactDetailResponse
383
- *
384
- * @remarks
385
- * Type alias for the `ContactDetailResponse` OpenAPI schema.
386
- * This type represents contactdetailresponse data structures used in API requests and responses.
387
- *
388
- * @example
389
- * ```typescript
390
- * const response = await api.getContactDetail();
391
- * const item: ContactDetail = response.results;
392
- * ```
393
- *
394
- * @see {@link components} - The OpenAPI components schema definition
395
- */
396
- export type ContactDetail = components['schemas']['ContactDetailResponse'];
397
381
  /**
398
382
  * ContactHandle
399
383
  *
@@ -3061,21 +3045,21 @@ export type Pagination_BillingTransaction = components['schemas']['Pagination_Bi
3061
3045
  */
3062
3046
  export type Pagination_ContactAttributeSet = components['schemas']['Pagination_ContactAttributeSetResponse_'];
3063
3047
  /**
3064
- * Pagination[ContactDetailResponse]
3048
+ * Pagination[ContactResponse]
3065
3049
  *
3066
3050
  * @remarks
3067
- * Type alias for the `Pagination_ContactDetailResponse_` OpenAPI schema.
3068
- * This type represents pagination[contactdetailresponse] data structures used in API requests and responses.
3051
+ * Type alias for the `Pagination_ContactResponse_` OpenAPI schema.
3052
+ * This type represents pagination[contactresponse] data structures used in API requests and responses.
3069
3053
  *
3070
3054
  * @example
3071
3055
  * ```typescript
3072
- * const response = await api.getPagination_ContactDetail();
3073
- * const item: Pagination_ContactDetail = response.results;
3056
+ * const response = await api.getPagination_Contact();
3057
+ * const item: Pagination_Contact = response.results;
3074
3058
  * ```
3075
3059
  *
3076
3060
  * @see {@link components} - The OpenAPI components schema definition
3077
3061
  */
3078
- export type Pagination_ContactDetail = components['schemas']['Pagination_ContactDetailResponse_'];
3062
+ export type Pagination_Contact = components['schemas']['Pagination_ContactResponse_'];
3079
3063
  /**
3080
3064
  * Pagination[DnsZoneResponse]
3081
3065
  *
package/src/openapi.yaml CHANGED
@@ -596,132 +596,6 @@ components:
596
596
  - disclose
597
597
  title: ContactCreate
598
598
  type: object
599
- ContactDetailResponse:
600
- properties:
601
- attribute_sets:
602
- description: Linked attribute sets for this contact
603
- items:
604
- $ref: '#/components/schemas/ContactAttributeLinkDetail'
605
- title: Attribute Sets
606
- type: array
607
- city:
608
- description: The city of the contact
609
- minLength: 1
610
- title: City
611
- type: string
612
- contact_id:
613
- examples:
614
- - contact_01h45ytscbebyvny4gc8cr8ma2
615
- format: typeid
616
- pattern: ^contact_[0-7][0-9a-hjkmnpq-tv-z]{25}$
617
- title: Contact Id
618
- type: string
619
- x-typeid-prefix: contact
620
- country:
621
- description: The country of the contact
622
- pattern: ^\w{2}$
623
- title: Country
624
- type: string
625
- created_on:
626
- description: The date/time the entry was created on
627
- format: date-time
628
- title: Created On
629
- type: string
630
- deleted_on:
631
- anyOf:
632
- - format: date-time
633
- type: string
634
- - type: 'null'
635
- description: The date/time the entry was deleted on
636
- title: Deleted On
637
- disclose:
638
- description: Whether the contact details should be disclosed. The Disclose
639
- function may not work with all TLDs. Some registries still display the
640
- data in Whois if, for example, the organization field is filled in.
641
- title: Disclose
642
- type: boolean
643
- email:
644
- description: The email of the contact
645
- format: email
646
- title: Email
647
- type: string
648
- fax:
649
- anyOf:
650
- - format: phone
651
- type: string
652
- - type: 'null'
653
- description: The contacts's fax number
654
- title: Fax
655
- first_name:
656
- description: The first name of the contact
657
- minLength: 1
658
- title: First Name
659
- type: string
660
- last_name:
661
- description: The last name of the contact
662
- minLength: 1
663
- title: Last Name
664
- type: string
665
- org:
666
- anyOf:
667
- - minLength: 1
668
- type: string
669
- - type: 'null'
670
- description: The organization of the contact
671
- title: Org
672
- organization_id:
673
- default: None
674
- description: The organization that owns the domain
675
- examples:
676
- - organization_01h45ytscbebyvny4gc8cr8ma2
677
- format: typeid
678
- pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
679
- title: Organization Id
680
- type: string
681
- x-typeid-prefix: organization
682
- phone:
683
- description: The contact's phone number
684
- examples:
685
- - '+1.2125552368'
686
- format: phone
687
- title: Phone
688
- type: string
689
- postal_code:
690
- description: The postal code of the contact
691
- minLength: 1
692
- title: Postal Code
693
- type: string
694
- state:
695
- anyOf:
696
- - minLength: 1
697
- type: string
698
- - type: 'null'
699
- description: The state of the contact
700
- title: State
701
- street:
702
- description: The address of the contact
703
- minLength: 1
704
- title: Street
705
- type: string
706
- title:
707
- anyOf:
708
- - minLength: 1
709
- type: string
710
- - type: 'null'
711
- description: The title of the contact
712
- title: Title
713
- required:
714
- - first_name
715
- - last_name
716
- - email
717
- - phone
718
- - street
719
- - city
720
- - postal_code
721
- - country
722
- - disclose
723
- title: ContactDetailResponse
724
- type: object
725
599
  ContactHandle:
726
600
  properties:
727
601
  attributes:
@@ -761,16 +635,35 @@ components:
761
635
  type: object
762
636
  ContactResponse:
763
637
  properties:
638
+ attribute_sets:
639
+ description: Linked attribute sets for this contact
640
+ items:
641
+ $ref: '#/components/schemas/ContactAttributeLinkDetail'
642
+ title: Attribute Sets
643
+ type: array
764
644
  city:
765
645
  description: The city of the contact
766
646
  minLength: 1
767
647
  title: City
768
648
  type: string
649
+ contact_id:
650
+ examples:
651
+ - contact_01h45ytscbebyvny4gc8cr8ma2
652
+ format: typeid
653
+ pattern: ^contact_[0-7][0-9a-hjkmnpq-tv-z]{25}$
654
+ title: Contact Id
655
+ type: string
656
+ x-typeid-prefix: contact
769
657
  country:
770
658
  description: The country of the contact
771
659
  pattern: ^\w{2}$
772
660
  title: Country
773
661
  type: string
662
+ created_on:
663
+ description: The date/time the entry was created on
664
+ format: date-time
665
+ title: Created On
666
+ type: string
774
667
  disclose:
775
668
  description: Whether the contact details should be disclosed. The Disclose
776
669
  function may not work with all TLDs. Some registries still display the
@@ -806,6 +699,16 @@ components:
806
699
  - type: 'null'
807
700
  description: The organization of the contact
808
701
  title: Org
702
+ organization_id:
703
+ default: None
704
+ description: The organization that owns the domain
705
+ examples:
706
+ - organization_01h45ytscbebyvny4gc8cr8ma2
707
+ format: typeid
708
+ pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
709
+ title: Organization Id
710
+ type: string
711
+ x-typeid-prefix: organization
809
712
  phone:
810
713
  description: The contact's phone number
811
714
  examples:
@@ -874,13 +777,6 @@ components:
874
777
  format: date-time
875
778
  title: Created On
876
779
  type: string
877
- deleted_on:
878
- anyOf:
879
- - format: date-time
880
- type: string
881
- - type: 'null'
882
- description: The date/time the entry was deleted on
883
- title: Deleted On
884
780
  disclose:
885
781
  description: Whether the contact details should be disclosed. The Disclose
886
782
  function may not work with all TLDs. Some registries still display the
@@ -5101,19 +4997,19 @@ components:
5101
4997
  - pagination
5102
4998
  title: Pagination[ContactAttributeSetResponse]
5103
4999
  type: object
5104
- Pagination_ContactDetailResponse_:
5000
+ Pagination_ContactResponse_:
5105
5001
  properties:
5106
5002
  pagination:
5107
5003
  $ref: '#/components/schemas/PaginationMetadata'
5108
5004
  results:
5109
5005
  items:
5110
- $ref: '#/components/schemas/ContactDetailResponse'
5006
+ $ref: '#/components/schemas/ContactResponse'
5111
5007
  title: Results
5112
5008
  type: array
5113
5009
  required:
5114
5010
  - results
5115
5011
  - pagination
5116
- title: Pagination[ContactDetailResponse]
5012
+ title: Pagination[ContactResponse]
5117
5013
  type: object
5118
5014
  Pagination_DnsZoneResponse_:
5119
5015
  properties:
@@ -7317,7 +7213,7 @@ info:
7317
7213
  '
7318
7214
  summary: OpusDNS - your gateway to a seamless domain management experience.
7319
7215
  title: OpusDNS API
7320
- version: 2026-02-26-134941
7216
+ version: 2026-03-02-094357
7321
7217
  x-logo:
7322
7218
  altText: OpusDNS API Reference
7323
7219
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -8223,7 +8119,7 @@ paths:
8223
8119
  content:
8224
8120
  application/json:
8225
8121
  schema:
8226
- $ref: '#/components/schemas/Pagination_ContactDetailResponse_'
8122
+ $ref: '#/components/schemas/Pagination_ContactResponse_'
8227
8123
  description: Successful Response
8228
8124
  '422':
8229
8125
  content:
@@ -8724,7 +8620,7 @@ paths:
8724
8620
  content:
8725
8621
  application/json:
8726
8622
  schema:
8727
- $ref: '#/components/schemas/ContactDetailResponse'
8623
+ $ref: '#/components/schemas/ContactResponse'
8728
8624
  description: Successful Response
8729
8625
  '404':
8730
8626
  content:
package/src/schema.d.ts CHANGED
@@ -2351,8 +2351,29 @@ export interface components {
2351
2351
  */
2352
2352
  title?: string | null;
2353
2353
  };
2354
- /** ContactDetailResponse */
2355
- ContactDetailResponse: {
2354
+ /** ContactHandle */
2355
+ ContactHandle: {
2356
+ /**
2357
+ * Attributes
2358
+ * @description Additional attributes related to the contact
2359
+ */
2360
+ attributes?: {
2361
+ [key: string]: string;
2362
+ } | null;
2363
+ /**
2364
+ * Contact Id
2365
+ * Format: typeid
2366
+ * @description The contact id of the contact
2367
+ * @example contact_01h45ytscbebyvny4gc8cr8ma2
2368
+ */
2369
+ contact_id: TypeId<"contact">;
2370
+ };
2371
+ /** @description The contacts of the domain */
2372
+ ContactIdList: {
2373
+ [key: string]: TypeId<"contact">;
2374
+ };
2375
+ /** ContactResponse */
2376
+ ContactResponse: {
2356
2377
  /**
2357
2378
  * Attribute Sets
2358
2379
  * @description Linked attribute sets for this contact
@@ -2380,11 +2401,6 @@ export interface components {
2380
2401
  * @description The date/time the entry was created on
2381
2402
  */
2382
2403
  created_on?: Date;
2383
- /**
2384
- * Deleted On
2385
- * @description The date/time the entry was deleted on
2386
- */
2387
- deleted_on?: Date | null;
2388
2404
  /**
2389
2405
  * Disclose
2390
2406
  * @description 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.
@@ -2452,98 +2468,6 @@ export interface components {
2452
2468
  */
2453
2469
  title?: string | null;
2454
2470
  };
2455
- /** ContactHandle */
2456
- ContactHandle: {
2457
- /**
2458
- * Attributes
2459
- * @description Additional attributes related to the contact
2460
- */
2461
- attributes?: {
2462
- [key: string]: string;
2463
- } | null;
2464
- /**
2465
- * Contact Id
2466
- * Format: typeid
2467
- * @description The contact id of the contact
2468
- * @example contact_01h45ytscbebyvny4gc8cr8ma2
2469
- */
2470
- contact_id: TypeId<"contact">;
2471
- };
2472
- /** @description The contacts of the domain */
2473
- ContactIdList: {
2474
- [key: string]: TypeId<"contact">;
2475
- };
2476
- /** ContactResponse */
2477
- ContactResponse: {
2478
- /**
2479
- * City
2480
- * @description The city of the contact
2481
- */
2482
- city: string;
2483
- /**
2484
- * Country
2485
- * @description The country of the contact
2486
- */
2487
- country: string;
2488
- /**
2489
- * Disclose
2490
- * @description 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.
2491
- */
2492
- disclose: boolean;
2493
- /**
2494
- * Email
2495
- * Format: email
2496
- * @description The email of the contact
2497
- */
2498
- email: string;
2499
- /**
2500
- * Fax
2501
- * @description The contacts's fax number
2502
- */
2503
- fax?: string | null;
2504
- /**
2505
- * First Name
2506
- * @description The first name of the contact
2507
- */
2508
- first_name: string;
2509
- /**
2510
- * Last Name
2511
- * @description The last name of the contact
2512
- */
2513
- last_name: string;
2514
- /**
2515
- * Org
2516
- * @description The organization of the contact
2517
- */
2518
- org?: string | null;
2519
- /**
2520
- * Phone
2521
- * Format: phone
2522
- * @description The contact's phone number
2523
- * @example +1.2125552368
2524
- */
2525
- phone: string;
2526
- /**
2527
- * Postal Code
2528
- * @description The postal code of the contact
2529
- */
2530
- postal_code: string;
2531
- /**
2532
- * State
2533
- * @description The state of the contact
2534
- */
2535
- state?: string | null;
2536
- /**
2537
- * Street
2538
- * @description The address of the contact
2539
- */
2540
- street: string;
2541
- /**
2542
- * Title
2543
- * @description The title of the contact
2544
- */
2545
- title?: string | null;
2546
- };
2547
2471
  /** ContactSchema */
2548
2472
  ContactSchema: {
2549
2473
  /**
@@ -2568,11 +2492,6 @@ export interface components {
2568
2492
  * @description The date/time the entry was created on
2569
2493
  */
2570
2494
  created_on?: Date;
2571
- /**
2572
- * Deleted On
2573
- * @description The date/time the entry was deleted on
2574
- */
2575
- deleted_on?: Date | null;
2576
2495
  /**
2577
2496
  * Disclose
2578
2497
  * @description 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.
@@ -5374,11 +5293,11 @@ export interface components {
5374
5293
  /** Results */
5375
5294
  results: components["schemas"]["ContactAttributeSetResponse"][];
5376
5295
  };
5377
- /** Pagination[ContactDetailResponse] */
5378
- Pagination_ContactDetailResponse_: {
5296
+ /** Pagination[ContactResponse] */
5297
+ Pagination_ContactResponse_: {
5379
5298
  pagination: components["schemas"]["PaginationMetadata"];
5380
5299
  /** Results */
5381
- results: components["schemas"]["ContactDetailResponse"][];
5300
+ results: components["schemas"]["ContactResponse"][];
5382
5301
  };
5383
5302
  /** Pagination[DnsZoneResponse] */
5384
5303
  Pagination_DnsZoneResponse_: {
@@ -7203,7 +7122,7 @@ export interface operations {
7203
7122
  [name: string]: unknown;
7204
7123
  };
7205
7124
  content: {
7206
- "application/json": components["schemas"]["Pagination_ContactDetailResponse_"];
7125
+ "application/json": components["schemas"]["Pagination_ContactResponse_"];
7207
7126
  };
7208
7127
  };
7209
7128
  /** @description Validation Error */
@@ -7680,7 +7599,7 @@ export interface operations {
7680
7599
  [name: string]: unknown;
7681
7600
  };
7682
7601
  content: {
7683
- "application/json": components["schemas"]["ContactDetailResponse"];
7602
+ "application/json": components["schemas"]["ContactResponse"];
7684
7603
  };
7685
7604
  };
7686
7605
  /** @description Not Found */