@opusdns/api 0.76.0 → 0.77.0

package/package.json

@@ -8,7 +8,7 @@
     "typescript": "^5.8.2"
   },
   "name": "@opusdns/api",
-  "version": "0.76.0",
+  "version": "0.77.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 { AgreementType, AllocationMethodType, AttributeType, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, 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, UserStatus, VerificationType, WalletCreditResponseStatus, ZoneSortField } from './schemas';
+import { AgreementType, AllocationMethodType, AttributeType, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ContactRoleType, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAttributeKey, 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, UserStatus, VerificationType, WalletCreditResponseStatus, ZoneSortField } from './schemas';
 
 /**
  * AgreementType. Auto-generated enum for AgreementType
@@ -957,6 +957,54 @@ export const DNSSEC_STATUS_VALUES = [
   'disabled'
 ] as const satisfies [string, ...string[]] | DnssecStatus[];
 
+/**
+ * DomainAttributeKey. Auto-generated enum for DomainAttributeKey
+ *
+ * @remarks
+ * This constant provides both object and array forms for the DomainAttributeKey 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 = DOMAIN_ATTRIBUTE_KEY.SUCCESS;
+ * 
+ * // Using the array form for iteration
+ * const allStatuses = DOMAIN_ATTRIBUTE_KEY_VALUES;
+ * console.log(`Available statuses: ${allStatuses.join(', ')}`);
+ * ```
+ *
+ * @see {@link DomainAttributeKey} - The TypeScript type definition
+ */
+export const DOMAIN_ATTRIBUTE_KEY = {
+  AUTO_RENEW_PERIOD: "auto_renew_period",
+} as const satisfies Record<string, DomainAttributeKey>;
+
+/**
+ * Array of all DomainAttributeKey enum values
+ *
+ * @remarks
+ * This constant provides a array containing all valid DomainAttributeKey enum values.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all values
+ * for (const value of DOMAIN_ATTRIBUTE_KEY_VALUES) {
+ *   console.log(`Processing: ${value}`);
+ * }
+ * 
+ * // Validation
+ * const isValid = DOMAIN_ATTRIBUTE_KEY_VALUES.includes(someValue);
+ * ```
+ *
+ * @see {@link DomainAttributeKey} - The TypeScript type definition
+ * @see {@link DOMAIN_ATTRIBUTE_KEY} - The object form of this enum
+ */
+export const DOMAIN_ATTRIBUTE_KEY_VALUES = [
+  'auto_renew_period'
+] as const satisfies [string, ...string[]] | DomainAttributeKey[];
+
 /**
  * DomainAvailabilityStatus. Auto-generated enum for DomainAvailabilityStatus
  *

package/src/helpers/keys.ts

@@ -6110,7 +6110,7 @@ export const KEY_DOMAIN_CREATE_NAMESERVERS = 'nameservers' as keyof DomainCreate
 /**
  * period property
  *
- * How long the domain should be registered for
+ * The registration period of the domain
  *
  *
  *
@@ -8959,6 +8959,31 @@ export const KEYS_DOMAIN_SUMMARY = [
   KEY_DOMAIN_SUMMARY_ORGANIZATION_ID,
 ] as const satisfies (keyof DomainSummary)[];
 
+/**
+ * Attributes
+ *
+ * Additional attributes of the domain
+ *
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `attributes` property of DomainTransferIn objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = domaintransferin[KEY_DOMAIN_TRANSFER_IN_ATTRIBUTES];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_DOMAIN_TRANSFER_IN_ATTRIBUTES;
+ * const value = domaintransferin[propertyName];
+ * ```
+ *
+ * @see {@link DomainTransferIn} - The TypeScript type definition
+ * @see {@link KEYS_DOMAIN_TRANSFER_IN} - Array of all keys for this type
+ */
+export const KEY_DOMAIN_TRANSFER_IN_ATTRIBUTES = 'attributes' as keyof DomainTransferIn;
 /**
  * Auth Code
  *
@@ -9134,6 +9159,7 @@ export const KEY_DOMAIN_TRANSFER_IN_RENEWAL_MODE = 'renewal_mode' as keyof Domai
  * @see {@link DomainTransferIn} - The TypeScript type definition
  */
 export const KEYS_DOMAIN_TRANSFER_IN = [
+  KEY_DOMAIN_TRANSFER_IN_ATTRIBUTES,
   KEY_DOMAIN_TRANSFER_IN_AUTH_CODE,
   KEY_DOMAIN_TRANSFER_IN_CONTACTS,
   KEY_DOMAIN_TRANSFER_IN_CREATE_ZONE,

package/src/helpers/schemas.d.ts

@@ -906,6 +906,22 @@ export type DnssecRecordType = components['schemas']['DnssecRecordType'];
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type DnssecStatus = components['schemas']['DnssecStatus'];
+/**
+ * DomainAttributeKey
+ *
+ * @remarks
+ * Type alias for the `DomainAttributeKey` OpenAPI schema.
+ * This type represents domainattributekey data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getDomainAttributeKey();
+ * const item: DomainAttributeKey = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type DomainAttributeKey = components['schemas']['DomainAttributeKey'];
 /**
  * DomainAvailability
  *

package/src/openapi.yaml

@@ -1366,6 +1366,11 @@ components:
       - disabled
       title: DnssecStatus
       type: string
+    DomainAttributeKey:
+      enum:
+      - auto_renew_period
+      title: DomainAttributeKey
+      type: string
     DomainAvailability:
       properties:
         domain:
@@ -1490,7 +1495,7 @@ components:
           title: Nameservers
         period:
           $ref: '#/components/schemas/DomainPeriod'
-          description: How long the domain should be registered for
+          description: The registration period of the domain
         renewal_mode:
           $ref: '#/components/schemas/RenewalMode'
           description: The renewal mode of the domain
@@ -2193,6 +2198,16 @@ components:
       type: object
     DomainTransferIn:
       properties:
+        attributes:
+          anyOf:
+          - additionalProperties:
+              type: string
+            propertyNames:
+              $ref: '#/components/schemas/DomainAttributeKey'
+            type: object
+          - type: 'null'
+          description: Additional attributes of the domain
+          title: Attributes
         auth_code:
           description: The auth code for the domain
           title: Auth Code
@@ -5221,7 +5236,7 @@ info:
     '
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2025-09-30-110200
+  version: 2025-09-30-180117
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg

package/src/schema.d.ts

@@ -2251,6 +2251,11 @@ export interface components {
          * @enum {string}
          */
         DnssecStatus: "enabled" | "disabled";
+        /**
+         * DomainAttributeKey
+         * @enum {string}
+         */
+        DomainAttributeKey: "auto_renew_period";
         /** DomainAvailability */
         DomainAvailability: {
             /** Domain */
@@ -2326,7 +2331,7 @@ export interface components {
              * @description The name servers for the domain
              */
             nameservers?: components["schemas"]["Nameserver"][] | null;
-            /** @description How long the domain should be registered for */
+            /** @description The registration period of the domain */
             period: components["schemas"]["DomainPeriod"];
             /** @description The renewal mode of the domain */
             renewal_mode: components["schemas"]["RenewalMode"];
@@ -2777,6 +2782,13 @@ export interface components {
         };
         /** DomainTransferIn */
         DomainTransferIn: {
+            /**
+             * Attributes
+             * @description Additional attributes of the domain
+             */
+            attributes?: {
+                [key: string]: string;
+            } | null;
             /**
              * Auth Code
              * @description The auth code for the domain