@opusdns/api 0.36.0 → 0.38.0

package/package.json

@@ -8,7 +8,7 @@
     "typescript": "^5.8.2"
   },
   "name": "@opusdns/api",
-  "version": "0.36.0",
+  "version": "0.38.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, RegistryHandleAttributeType, 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
@@ -2021,7 +2073,7 @@ export const REGISTRANT_CHANGE_TYPE_VALUES = [
  * @see {@link RegistryHandleAttributeType} - The TypeScript type definition
  */
 export const REGISTRY_HANDLE_ATTRIBUTE_TYPE = {
-  AT-EXT-CONTACT:TYPE: "at-ext-contact:type",
+  AT_EXT_CONTACT_TYPE: "at-ext-contact:type",
 } as const satisfies Record<string, RegistryHandleAttributeType>;
 
 /**

package/src/helpers/keys.ts

@@ -138,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';
@@ -15580,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
  *
@@ -15608,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).
  *
  *
  *
@@ -15677,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,
@@ -17389,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, 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';
+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
@@ -667,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
  *
@@ -2698,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
@@ -4024,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:
@@ -4453,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:
@@ -5214,7 +5259,7 @@ info:
     '
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2025-09-11-090517
+  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}
@@ -3853,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"];
         };
@@ -4124,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: {
             /**