@opusdns/api 0.35.0 → 0.37.0

package/package.json

@@ -8,7 +8,7 @@
     "typescript": "^5.8.2"
   },
   "name": "@opusdns/api",
-  "version": "0.35.0",
+  "version": "0.37.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,59 @@
  * ```
  */
 
-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 { AgreementType, 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';
+
+/**
+ * AgreementType. Auto-generated enum for AgreementType
+ *
+ * @remarks
+ * This constant provides both object and array forms for the AgreementType 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 = AGREEMENT_TYPE.SUCCESS;
+ * 
+ * // Using the array form for iteration
+ * const allStatuses = AGREEMENT_TYPE_VALUES;
+ * console.log(`Available statuses: ${allStatuses.join(', ')}`);
+ * ```
+ *
+ * @see {@link AgreementType} - The TypeScript type definition
+ */
+export const AGREEMENT_TYPE = {
+  TERMS_AND_CONDITIONS: "terms_and_conditions",
+  MASTER_SERVICE_AGREEMENT: "master_service_agreement",
+  ACTING_AS_TRADER: "acting_as_trader",
+} as const satisfies Record<string, AgreementType>;
+
+/**
+ * Array of all AgreementType enum values
+ *
+ * @remarks
+ * This constant provides a array containing all valid AgreementType enum values.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all values
+ * for (const value of AGREEMENT_TYPE_VALUES) {
+ *   console.log(`Processing: ${value}`);
+ * }
+ * 
+ * // Validation
+ * const isValid = AGREEMENT_TYPE_VALUES.includes(someValue);
+ * ```
+ *
+ * @see {@link AgreementType} - The TypeScript type definition
+ * @see {@link AGREEMENT_TYPE} - The object form of this enum
+ */
+export const AGREEMENT_TYPE_VALUES = [
+  'terms_and_conditions',
+  'master_service_agreement',
+  'acting_as_trader'
+] as const satisfies [string, ...string[]] | AgreementType[];
 
 /**
  * AllocationMethodType. Auto-generated enum for AllocationMethodType
@@ -2001,6 +2053,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';
@@ -137,6 +138,7 @@ import { TldSpecification } from './schemas';
 import { TrademarkClaimsBase } from './schemas';
 import { TransferPoliciesBase } from './schemas';
 import { User } from './schemas';
+import { UserAgreementAcceptance } from './schemas';
 import { UserAttributeBase } from './schemas';
 import { UserCreate } from './schemas';
 import { UserNotification } from './schemas';
@@ -1092,6 +1094,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 +5061,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 +7778,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
  *
@@ -15502,6 +15581,31 @@ export const KEYS_RGP_OPERATIONS = [
   KEY_RGP_OPERATIONS_REQUEST,
 ] as const satisfies (keyof RgpOperations)[];
 
+/**
+ * Agreements
+ *
+ * User agreement acceptances.
+ *
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `agreements` property of SignupCreate objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = signupcreate[KEY_SIGNUP_CREATE_AGREEMENTS];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_SIGNUP_CREATE_AGREEMENTS;
+ * const value = signupcreate[propertyName];
+ * ```
+ *
+ * @see {@link SignupCreate} - The TypeScript type definition
+ * @see {@link KEYS_SIGNUP_CREATE} - Array of all keys for this type
+ */
+export const KEY_SIGNUP_CREATE_AGREEMENTS = 'agreements' as keyof SignupCreate;
 /**
  * organization property
  *
@@ -15530,7 +15634,7 @@ export const KEY_SIGNUP_CREATE_ORGANIZATION = 'organization' as keyof SignupCrea
 /**
  * terms_of_service property
  *
- * Terms of service acceptance.
+ * Terms of service acceptance (legacy).
  *
  *
  *
@@ -15599,6 +15703,7 @@ export const KEY_SIGNUP_CREATE_USER = 'user' as keyof SignupCreate;
  * @see {@link SignupCreate} - The TypeScript type definition
  */
 export const KEYS_SIGNUP_CREATE = [
+  KEY_SIGNUP_CREATE_AGREEMENTS,
   KEY_SIGNUP_CREATE_ORGANIZATION,
   KEY_SIGNUP_CREATE_TERMS_OF_SERVICE,
   KEY_SIGNUP_CREATE_USER,
@@ -17311,6 +17416,135 @@ export const KEYS_USER = [
   KEY_USER_USERNAME,
 ] as const satisfies (keyof User)[];
 
+/**
+ * Accepted
+ *
+ * Whether the agreement has been accepted.
+ *
+ * @type {boolean}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `accepted` property of UserAgreementAcceptance objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = useragreementacceptance[KEY_USER_AGREEMENT_ACCEPTANCE_ACCEPTED];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_USER_AGREEMENT_ACCEPTANCE_ACCEPTED;
+ * const value = useragreementacceptance[propertyName];
+ * ```
+ *
+ * @see {@link UserAgreementAcceptance} - The TypeScript type definition
+ * @see {@link KEYS_USER_AGREEMENT_ACCEPTANCE} - Array of all keys for this type
+ */
+export const KEY_USER_AGREEMENT_ACCEPTANCE_ACCEPTED = 'accepted' as keyof UserAgreementAcceptance;
+/**
+ * type property
+ *
+ * Type of agreement being accepted.
+ *
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `type` property of UserAgreementAcceptance objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = useragreementacceptance[KEY_USER_AGREEMENT_ACCEPTANCE_TYPE];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_USER_AGREEMENT_ACCEPTANCE_TYPE;
+ * const value = useragreementacceptance[propertyName];
+ * ```
+ *
+ * @see {@link UserAgreementAcceptance} - The TypeScript type definition
+ * @see {@link KEYS_USER_AGREEMENT_ACCEPTANCE} - Array of all keys for this type
+ */
+export const KEY_USER_AGREEMENT_ACCEPTANCE_TYPE = 'type' as keyof UserAgreementAcceptance;
+/**
+ * Url
+ *
+ * URL where the agreement can be found.
+ *
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `url` property of UserAgreementAcceptance objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = useragreementacceptance[KEY_USER_AGREEMENT_ACCEPTANCE_URL];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_USER_AGREEMENT_ACCEPTANCE_URL;
+ * const value = useragreementacceptance[propertyName];
+ * ```
+ *
+ * @see {@link UserAgreementAcceptance} - The TypeScript type definition
+ * @see {@link KEYS_USER_AGREEMENT_ACCEPTANCE} - Array of all keys for this type
+ */
+export const KEY_USER_AGREEMENT_ACCEPTANCE_URL = 'url' as keyof UserAgreementAcceptance;
+/**
+ * Version
+ *
+ * Version of the agreement being accepted.
+ *
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `version` property of UserAgreementAcceptance objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = useragreementacceptance[KEY_USER_AGREEMENT_ACCEPTANCE_VERSION];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_USER_AGREEMENT_ACCEPTANCE_VERSION;
+ * const value = useragreementacceptance[propertyName];
+ * ```
+ *
+ * @see {@link UserAgreementAcceptance} - The TypeScript type definition
+ * @see {@link KEYS_USER_AGREEMENT_ACCEPTANCE} - Array of all keys for this type
+ */
+export const KEY_USER_AGREEMENT_ACCEPTANCE_VERSION = 'version' as keyof UserAgreementAcceptance;
+
+/**
+ * Array of all UserAgreementAcceptance property keys
+ *
+ * @remarks
+ * This constant provides a readonly array containing all valid property keys for UserAgreementAcceptance objects.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all keys
+ * for (const key of KEYS_USER_AGREEMENT_ACCEPTANCE) {
+ *   console.log(`Property: ${key}, Value: ${useragreementacceptance[key]}`);
+ * }
+ * 
+ * // Validation
+ * const isValidKey = KEYS_USER_AGREEMENT_ACCEPTANCE.includes(someKey);
+ * ```
+ *
+ * @see {@link UserAgreementAcceptance} - The TypeScript type definition
+ */
+export const KEYS_USER_AGREEMENT_ACCEPTANCE = [
+  KEY_USER_AGREEMENT_ACCEPTANCE_ACCEPTED,
+  KEY_USER_AGREEMENT_ACCEPTANCE_TYPE,
+  KEY_USER_AGREEMENT_ACCEPTANCE_URL,
+  KEY_USER_AGREEMENT_ACCEPTANCE_VERSION,
+] as const satisfies (keyof UserAgreementAcceptance)[];
+
 /**
  * Key
  *

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, UserAgreementAcceptance, 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
  *
@@ -653,6 +667,20 @@ export type PremiumAffectsTypeArray = PremiumAffectsType[];
  * @see {@link Relation} - The individual Relation type definition
  */
 export type RelationArray = Relation[];
+/**
+ * UserAgreementAcceptance
+ *
+ * @remarks
+ * Array type for UserAgreementAcceptance objects. Used when the API returns a collection of UserAgreementAcceptance instances.
+ *
+ * @example
+ * ```typescript
+ * const items: UserAgreementAcceptanceArray = await api.getUserAgreementAcceptances();
+ * ```
+ *
+ * @see {@link UserAgreementAcceptance} - The individual UserAgreementAcceptance type definition
+ */
+export type UserAgreementAcceptanceArray = UserAgreementAcceptance[];
 /**
  * TldBase
  *

package/src/helpers/schemas.d.ts

@@ -26,6 +26,22 @@
  */
 import { components } from '../schema';
 
+/**
+ * AgreementType
+ *
+ * @remarks
+ * Type alias for the `AgreementType` OpenAPI schema.
+ * This type represents agreementtype data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getAgreementType();
+ * const item: AgreementType = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type AgreementType = components['schemas']['AgreementType'];
 /**
  * AllocationMethodType
  *
@@ -170,6 +186,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 +842,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 +2346,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
  *
@@ -2650,6 +2714,22 @@ export type TransferPoliciesBase = components['schemas']['TransferPoliciesBase']
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type User = components['schemas']['User'];
+/**
+ * UserAgreementAcceptance
+ *
+ * @remarks
+ * Type alias for the `UserAgreementAcceptance` OpenAPI schema.
+ * This type represents useragreementacceptance data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getUserAgreementAcceptance();
+ * const item: UserAgreementAcceptance = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type UserAgreementAcceptance = components['schemas']['UserAgreementAcceptance'];
 /**
  * UserAttributeBase
  *

package/src/openapi.yaml

@@ -1,5 +1,12 @@
 components:
   schemas:
+    AgreementType:
+      enum:
+      - terms_and_conditions
+      - master_service_agreement
+      - acting_as_trader
+      title: AgreementType
+      type: string
     AllocationMethodType:
       enum:
       - fcfs
@@ -234,6 +241,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 +1197,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 +1243,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 +1917,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 +1955,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 +3909,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:
@@ -3987,19 +4031,28 @@ components:
       type: object
     SignupCreate:
       properties:
+        agreements:
+          anyOf:
+          - items:
+              $ref: '#/components/schemas/UserAgreementAcceptance'
+            type: array
+          - type: 'null'
+          description: User agreement acceptances.
+          title: Agreements
         organization:
           $ref: '#/components/schemas/OrganizationCreate'
           description: Organization signup.
         terms_of_service:
-          $ref: '#/components/schemas/TermsOfServiceAccept'
-          description: Terms of service acceptance.
+          anyOf:
+          - $ref: '#/components/schemas/TermsOfServiceAccept'
+          - type: 'null'
+          description: Terms of service acceptance (legacy).
         user:
           $ref: '#/components/schemas/UserCreate'
           description: User signup to platform.
       required:
       - user
       - organization
-      - terms_of_service
       title: SignupCreate
       type: object
     SldLength:
@@ -4416,6 +4469,35 @@ components:
       - status
       title: User
       type: object
+    UserAgreementAcceptance:
+      properties:
+        accepted:
+          description: Whether the agreement has been accepted.
+          title: Accepted
+          type: boolean
+        type:
+          $ref: '#/components/schemas/AgreementType'
+          description: Type of agreement being accepted.
+        url:
+          anyOf:
+          - format: uri
+            maxLength: 2083
+            minLength: 1
+            type: string
+          - type: 'null'
+          description: URL where the agreement can be found.
+          title: Url
+        version:
+          anyOf:
+          - type: string
+          - type: 'null'
+          description: Version of the agreement being accepted.
+          title: Version
+      required:
+      - type
+      - accepted
+      title: UserAgreementAcceptance
+      type: object
     UserAttributeBase:
       properties:
         key:
@@ -5177,7 +5259,7 @@ info:
     '
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2025-09-10-232127
+  version: 2025-09-11-192549
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg

package/src/schema.d.ts

@@ -1191,6 +1191,11 @@ export interface paths {
 export type webhooks = Record<string, never>;
 export interface components {
     schemas: {
+        /**
+         * AgreementType
+         * @enum {string}
+         */
+        AgreementType: "terms_and_conditions" | "master_service_agreement" | "acting_as_trader";
         /**
          * AllocationMethodType
          * @enum {string}
@@ -1368,6 +1373,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 +1992,9 @@ export interface components {
          * @enum {string}
          */
         DomainClientStatus: "clientTransferProhibited" | "clientUpdateProhibited" | "clientDeleteProhibited" | "clientRenewProhibited" | "clientHold";
+        DomainContactHandles: {
+            [key: string]: components["schemas"]["ContactHandle"][];
+        };
         /** DomainContactResponse */
         DomainContactResponse: {
             /**
@@ -1994,8 +2018,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 +2444,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 +2473,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 +3777,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: {
             /**
@@ -3824,10 +3858,15 @@ export interface components {
         };
         /** SignupCreate */
         SignupCreate: {
+            /**
+             * Agreements
+             * @description User agreement acceptances.
+             */
+            agreements?: components["schemas"]["UserAgreementAcceptance"][] | null;
             /** @description Organization signup. */
             organization: components["schemas"]["OrganizationCreate"];
-            /** @description Terms of service acceptance. */
-            terms_of_service: components["schemas"]["TermsOfServiceAccept"];
+            /** @description Terms of service acceptance (legacy). */
+            terms_of_service?: components["schemas"]["TermsOfServiceAccept"] | null;
             /** @description User signup to platform. */
             user: components["schemas"]["UserCreate"];
         };
@@ -4095,6 +4134,26 @@ export interface components {
              */
             username: string;
         };
+        /** UserAgreementAcceptance */
+        UserAgreementAcceptance: {
+            /**
+             * Accepted
+             * @description Whether the agreement has been accepted.
+             */
+            accepted: boolean;
+            /** @description Type of agreement being accepted. */
+            type: components["schemas"]["AgreementType"];
+            /**
+             * Url
+             * @description URL where the agreement can be found.
+             */
+            url?: string | null;
+            /**
+             * Version
+             * @description Version of the agreement being accepted.
+             */
+            version?: string | null;
+        };
         /** UserAttributeBase */
         UserAttributeBase: {
             /**