@opusdns/api 0.35.0 → 0.36.0

package/package.json

@@ -8,7 +8,7 @@
     "typescript": "^5.8.2"
   },
   "name": "@opusdns/api",
-  "version": "0.35.0",
+  "version": "0.36.0",
   "description": "TypeScript types for the OpusDNS OpenAPI specification",
   "main": "./src/index.ts",
   "module": "./src/index.ts",

package/src/helpers/constants.ts

@@ -21,7 +21,7 @@
  * ```
  */
 
-import { AllocationMethodType, BillingTransactionAction, BillingTransactionProductType, ContactRoleType, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainSortField, DomainStatus, EmailVerificationStatus, EventObjectType, EventSubtype, EventType, GrantType, LaunchPhaseType, LocalPresenceRequirementType, OrganizationCredentialStatus, OrganizationStatus, PatchOp, PeriodUnit, Permission, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, RegistrantChangeType, Relation, RenewalMode, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TransferAckType, UserNotificationStatus, UserStatus, VerificationType, ZoneSortField } from './schemas';
+import { AllocationMethodType, BillingTransactionAction, BillingTransactionProductType, ContactRoleType, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainSortField, DomainStatus, EmailVerificationStatus, EventObjectType, EventSubtype, EventType, GrantType, LaunchPhaseType, LocalPresenceRequirementType, OrganizationCredentialStatus, OrganizationStatus, PatchOp, PeriodUnit, Permission, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TransferAckType, UserNotificationStatus, UserStatus, VerificationType, ZoneSortField } from './schemas';
 
 /**
  * AllocationMethodType. Auto-generated enum for AllocationMethodType
@@ -2001,6 +2001,54 @@ export const REGISTRANT_CHANGE_TYPE_VALUES = [
   'trade'
 ] as const satisfies [string, ...string[]] | RegistrantChangeType[];
 
+/**
+ * RegistryHandleAttributeType. Registry handle attribute types for type-safe attribute key access.
+ *
+ * @remarks
+ * This constant provides both object and array forms for the RegistryHandleAttributeType enum.
+ * The object form allows key-value access, while the array form enables iteration and validation.
+ *
+ * @example
+ * ```typescript
+ * // Using the object form for key-value access
+ * const status = REGISTRY_HANDLE_ATTRIBUTE_TYPE.SUCCESS;
+ * 
+ * // Using the array form for iteration
+ * const allStatuses = REGISTRY_HANDLE_ATTRIBUTE_TYPE_VALUES;
+ * console.log(`Available statuses: ${allStatuses.join(', ')}`);
+ * ```
+ *
+ * @see {@link RegistryHandleAttributeType} - The TypeScript type definition
+ */
+export const REGISTRY_HANDLE_ATTRIBUTE_TYPE = {
+  AT-EXT-CONTACT:TYPE: "at-ext-contact:type",
+} as const satisfies Record<string, RegistryHandleAttributeType>;
+
+/**
+ * Array of all RegistryHandleAttributeType enum values
+ *
+ * @remarks
+ * This constant provides a array containing all valid RegistryHandleAttributeType enum values.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all values
+ * for (const value of REGISTRY_HANDLE_ATTRIBUTE_TYPE_VALUES) {
+ *   console.log(`Processing: ${value}`);
+ * }
+ * 
+ * // Validation
+ * const isValid = REGISTRY_HANDLE_ATTRIBUTE_TYPE_VALUES.includes(someValue);
+ * ```
+ *
+ * @see {@link RegistryHandleAttributeType} - The TypeScript type definition
+ * @see {@link REGISTRY_HANDLE_ATTRIBUTE_TYPE} - The object form of this enum
+ */
+export const REGISTRY_HANDLE_ATTRIBUTE_TYPE_VALUES = [
+  'at-ext-contact:type'
+] as const satisfies [string, ...string[]] | RegistryHandleAttributeType[];
+
 /**
  * Relation. Auto-generated enum for Relation
  *

package/src/helpers/keys.ts

@@ -35,6 +35,7 @@ import { BillingPlan } from './schemas';
 import { Body_issue_organization_token_v1_auth_token_post } from './schemas';
 import { ContactConfigBase } from './schemas';
 import { ContactCreate } from './schemas';
+import { ContactHandle } from './schemas';
 import { Contact } from './schemas';
 import { ContactSchema } from './schemas';
 import { ContactVerificationApi } from './schemas';
@@ -1092,6 +1093,83 @@ export const KEYS_CONTACT_CREATE = [
   KEY_CONTACT_CREATE_TITLE,
 ] as const satisfies (keyof ContactCreate)[];
 
+/**
+ * Attributes
+ *
+ * Additional attributes related to the contact
+ *
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `attributes` property of ContactHandle objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = contacthandle[KEY_CONTACT_HANDLE_ATTRIBUTES];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_CONTACT_HANDLE_ATTRIBUTES;
+ * const value = contacthandle[propertyName];
+ * ```
+ *
+ * @see {@link ContactHandle} - The TypeScript type definition
+ * @see {@link KEYS_CONTACT_HANDLE} - Array of all keys for this type
+ */
+export const KEY_CONTACT_HANDLE_ATTRIBUTES = 'attributes' as keyof ContactHandle;
+/**
+ * Contact Id
+ *
+ * The contact id of the contact
+ *
+ * @type {string}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `contact_id` property of ContactHandle objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = contacthandle[KEY_CONTACT_HANDLE_CONTACT_ID];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_CONTACT_HANDLE_CONTACT_ID;
+ * const value = contacthandle[propertyName];
+ * ```
+ *
+ * @see {@link ContactHandle} - The TypeScript type definition
+ * @see {@link KEYS_CONTACT_HANDLE} - Array of all keys for this type
+ */
+export const KEY_CONTACT_HANDLE_CONTACT_ID = 'contact_id' as keyof ContactHandle;
+
+/**
+ * Array of all ContactHandle property keys
+ *
+ * @remarks
+ * This constant provides a readonly array containing all valid property keys for ContactHandle objects.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all keys
+ * for (const key of KEYS_CONTACT_HANDLE) {
+ *   console.log(`Property: ${key}, Value: ${contacthandle[key]}`);
+ * }
+ * 
+ * // Validation
+ * const isValidKey = KEYS_CONTACT_HANDLE.includes(someKey);
+ * ```
+ *
+ * @see {@link ContactHandle} - The TypeScript type definition
+ */
+export const KEYS_CONTACT_HANDLE = [
+  KEY_CONTACT_HANDLE_ATTRIBUTES,
+  KEY_CONTACT_HANDLE_CONTACT_ID,
+] as const satisfies (keyof ContactHandle)[];
+
 /**
  * City
  *
@@ -4982,7 +5060,7 @@ export const KEYS_DOMAIN_CONTACT = [
  */
 export const KEY_DOMAIN_CREATE_AUTH_CODE = 'auth_code' as keyof DomainCreate;
 /**
- * contacts property
+ * Contacts
  *
  * The contacts of the domain
  *
@@ -7699,7 +7777,7 @@ export const KEYS_DOMAIN_SUMMARY = [
  */
 export const KEY_DOMAIN_TRANSFER_IN_AUTH_CODE = 'auth_code' as keyof DomainTransferIn;
 /**
- * contacts property
+ * Contacts
  *
  * The contacts of the domain
  *

package/src/helpers/schemas-arrays.d.ts

@@ -21,7 +21,7 @@
  * This file is auto-generated from the OpenAPI specification.
  * Do not edit manually.
  */
-import { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, TldResponseShort, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, Nameserver, DeletePolicyType, SyncOperationType, DomainContact, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, PlanInfo, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, ContactRoleType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, ContactSchema, DnsZone, Domain, EmailForwardAlias, EventResponse, OrganizationCredential, Organization, UserNotificationSummary, Period, Permission, PremiumAffectsType, Relation, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
+import { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, TldResponseShort, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, ContactHandle, Nameserver, DeletePolicyType, SyncOperationType, DomainContact, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, PlanInfo, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, ContactRoleType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, ContactSchema, DnsZone, Domain, EmailForwardAlias, EventResponse, OrganizationCredential, Organization, UserNotificationSummary, Period, Permission, PremiumAffectsType, Relation, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
 
 /**
  * DomainDnssecDataResponse
@@ -247,6 +247,20 @@ export type DnsRrsetPatchOpArray = DnsRrsetPatchOp[];
  * @see {@link DomainAvailabilityCheck} - The individual DomainAvailabilityResponse type definition
  */
 export type DomainAvailabilityCheckArray = DomainAvailabilityCheck[];
+/**
+ * ContactHandle
+ *
+ * @remarks
+ * Array type for ContactHandle objects. Used when the API returns a collection of ContactHandle instances.
+ *
+ * @example
+ * ```typescript
+ * const items: ContactHandleArray = await api.getContactHandles();
+ * ```
+ *
+ * @see {@link ContactHandle} - The individual ContactHandle type definition
+ */
+export type ContactHandleArray = ContactHandle[];
 /**
  * Nameserver
  *

package/src/helpers/schemas.d.ts

@@ -170,6 +170,22 @@ export type ContactConfigBase = components['schemas']['ContactConfigBase'];
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type ContactCreate = components['schemas']['ContactCreate'];
+/**
+ * ContactHandle
+ *
+ * @remarks
+ * Type alias for the `ContactHandle` OpenAPI schema.
+ * This type represents contacthandle data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getContactHandle();
+ * const item: ContactHandle = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type ContactHandle = components['schemas']['ContactHandle'];
 /**
  * ContactIdList
  *
@@ -810,6 +826,22 @@ export type DomainCheck = components['schemas']['DomainCheckResponse'];
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type DomainClientStatus = components['schemas']['DomainClientStatus'];
+/**
+ * DomainContactHandles
+ *
+ * @remarks
+ * Type alias for the `DomainContactHandles` OpenAPI schema.
+ * This type represents domaincontacthandles data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getDomainContactHandles();
+ * const item: DomainContactHandles = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type DomainContactHandles = components['schemas']['DomainContactHandles'];
 /**
  * DomainContactResponse
  *
@@ -2298,6 +2330,22 @@ export type RdapBase = components['schemas']['RdapBase'];
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type RegistrantChangeType = components['schemas']['RegistrantChangeType'];
+/**
+ * RegistryHandleAttributeType. Registry handle attribute types for type-safe attribute key access.
+ *
+ * @remarks
+ * Type alias for the `RegistryHandleAttributeType` OpenAPI schema.
+ * This type represents registryhandleattributetype data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getRegistryHandleAttributeType();
+ * const item: RegistryHandleAttributeType = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type RegistryHandleAttributeType = components['schemas']['RegistryHandleAttributeType'];
 /**
  * RegistryLockBase
  *

package/src/openapi.yaml

@@ -234,6 +234,31 @@ components:
       - disclose
       title: ContactCreate
       type: object
+    ContactHandle:
+      properties:
+        attributes:
+          anyOf:
+          - additionalProperties:
+              $ref: '#/components/schemas/JsonValue'
+            propertyNames:
+              $ref: '#/components/schemas/RegistryHandleAttributeType'
+            type: object
+          - type: 'null'
+          description: Additional attributes related to the contact
+          title: Attributes
+        contact_id:
+          description: The contact id of the contact
+          examples:
+          - contact_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^contact_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: Contact Id
+          type: string
+          x-typeid-prefix: contact
+      required:
+      - contact_id
+      title: ContactHandle
+      type: object
     ContactIdList:
       additionalProperties:
         examples:
@@ -1165,6 +1190,14 @@ components:
       - clientHold
       title: DomainClientStatus
       type: string
+    DomainContactHandles:
+      additionalProperties:
+        items:
+          $ref: '#/components/schemas/ContactHandle'
+        type: array
+      propertyNames:
+        $ref: '#/components/schemas/DomainContactType'
+      type: object
     DomainContactResponse:
       properties:
         contact_id:
@@ -1203,8 +1236,11 @@ components:
           description: The auth code used for the domain
           title: Auth Code
         contacts:
-          $ref: '#/components/schemas/ContactIdList'
+          anyOf:
+          - $ref: '#/components/schemas/DomainContactHandles'
+          - $ref: '#/components/schemas/ContactIdList'
           description: The contacts of the domain
+          title: Contacts
         name:
           description: The domain to be created
           title: Name
@@ -1874,8 +1910,11 @@ components:
           title: Auth Code
           type: string
         contacts:
-          $ref: '#/components/schemas/ContactIdList'
+          anyOf:
+          - $ref: '#/components/schemas/DomainContactHandles'
+          - $ref: '#/components/schemas/ContactIdList'
           description: The contacts of the domain
+          title: Contacts
         name:
           description: The domain to be created
           title: Name
@@ -1909,16 +1948,8 @@ components:
           title: Auth Code
         contacts:
           anyOf:
-          - additionalProperties:
-              examples:
-              - contact_01h45ytscbebyvny4gc8cr8ma2
-              format: typeid
-              pattern: ^contact_[0-7][0-9a-hjkmnpq-tv-z]{25}$
-              type: string
-              x-typeid-prefix: contact
-            propertyNames:
-              $ref: '#/components/schemas/DomainContactType'
-            type: object
+          - $ref: '#/components/schemas/DomainContactHandles'
+          - $ref: '#/components/schemas/ContactIdList'
           - type: 'null'
           description: The new contacts of the domain
           examples:
@@ -3871,6 +3902,12 @@ components:
       - trade
       title: RegistrantChangeType
       type: string
+    RegistryHandleAttributeType:
+      description: Registry handle attribute types for type-safe attribute key access.
+      enum:
+      - at-ext-contact:type
+      title: RegistryHandleAttributeType
+      type: string
     RegistryLockBase:
       properties:
         prevents:
@@ -5177,7 +5214,7 @@ info:
     '
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2025-09-10-232127
+  version: 2025-09-11-090517
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg

package/src/schema.d.ts

@@ -1368,6 +1368,22 @@ export interface components {
              */
             title?: string | null;
         };
+        /** ContactHandle */
+        ContactHandle: {
+            /**
+             * Attributes
+             * @description Additional attributes related to the contact
+             */
+            attributes?: {
+                [key: string]: components["schemas"]["JsonValue"];
+            } | null;
+            /**
+             * Contact Id
+             * Format: typeid
+             * @description The contact id of the contact
+             */
+            contact_id: TypeID<"contact">;
+        };
         ContactIdList: {
             [key: string]: TypeID<"contact">;
         };
@@ -1971,6 +1987,9 @@ export interface components {
          * @enum {string}
          */
         DomainClientStatus: "clientTransferProhibited" | "clientUpdateProhibited" | "clientDeleteProhibited" | "clientRenewProhibited" | "clientHold";
+        DomainContactHandles: {
+            [key: string]: components["schemas"]["ContactHandle"][];
+        };
         /** DomainContactResponse */
         DomainContactResponse: {
             /**
@@ -1994,8 +2013,11 @@ export interface components {
              * @description The auth code used for the domain
              */
             auth_code?: string | null;
-            /** @description The contacts of the domain */
-            contacts: components["schemas"]["ContactIdList"];
+            /**
+             * Contacts
+             * @description The contacts of the domain
+             */
+            contacts: components["schemas"]["DomainContactHandles"] | components["schemas"]["ContactIdList"];
             /**
              * Name
              * @description The domain to be created
@@ -2417,8 +2439,11 @@ export interface components {
              * @description The auth code for the domain
              */
             auth_code: string;
-            /** @description The contacts of the domain */
-            contacts: components["schemas"]["ContactIdList"];
+            /**
+             * Contacts
+             * @description The contacts of the domain
+             */
+            contacts: components["schemas"]["DomainContactHandles"] | components["schemas"]["ContactIdList"];
             /**
              * Name
              * @description The domain to be created
@@ -2443,9 +2468,7 @@ export interface components {
              * Contacts
              * @description The new contacts of the domain
              */
-            contacts?: {
-                [key: string]: TypeID<"contact">;
-            } | null;
+            contacts?: components["schemas"]["DomainContactHandles"] | components["schemas"]["ContactIdList"] | null;
             /**
              * Nameservers
              * @description The new name servers for the domain
@@ -3749,6 +3772,12 @@ export interface components {
          * @enum {string}
          */
         RegistrantChangeType: "update" | "trade";
+        /**
+         * RegistryHandleAttributeType
+         * @description Registry handle attribute types for type-safe attribute key access.
+         * @enum {string}
+         */
+        RegistryHandleAttributeType: "at-ext-contact:type";
         /** RegistryLockBase */
         RegistryLockBase: {
             /**