@opusdns/api 0.31.0 → 0.32.0

package/package.json

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

package/src/helpers/keys.ts

@@ -71,7 +71,8 @@ import { DomainRenew } from './schemas';
 import { Domain } from './schemas';
 import { DomainSearchMeta } from './schemas';
 import { DomainSearch } from './schemas';
-import { DomainSearchSuggestion } from './schemas';
+import { DomainSearchSuggestionPriceData } from './schemas';
+import { DomainSearchSuggestionWithPrice } from './schemas';
 import { DomainStatusesBase } from './schemas';
 import { DomainSummaryData } from './schemas';
 import { DomainSummary } from './schemas';
@@ -6894,6 +6895,106 @@ export const KEYS_DOMAIN_SEARCH = [
   KEY_DOMAIN_SEARCH_RESULTS,
 ] as const satisfies (keyof DomainSearch)[];
 
+/**
+ * Amount
+ *
+ *
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `amount` property of DomainSearchSuggestionPriceData objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = domainsearchsuggestionpricedata[KEY_DOMAIN_SEARCH_SUGGESTION_PRICE_DATA_AMOUNT];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_DOMAIN_SEARCH_SUGGESTION_PRICE_DATA_AMOUNT;
+ * const value = domainsearchsuggestionpricedata[propertyName];
+ * ```
+ *
+ * @see {@link DomainSearchSuggestionPriceData} - The TypeScript type definition
+ * @see {@link KEYS_DOMAIN_SEARCH_SUGGESTION_PRICE_DATA} - Array of all keys for this type
+ */
+export const KEY_DOMAIN_SEARCH_SUGGESTION_PRICE_DATA_AMOUNT = 'amount' as keyof DomainSearchSuggestionPriceData;
+/**
+ * Currency
+ *
+ *
+ * @type {string}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `currency` property of DomainSearchSuggestionPriceData objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = domainsearchsuggestionpricedata[KEY_DOMAIN_SEARCH_SUGGESTION_PRICE_DATA_CURRENCY];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_DOMAIN_SEARCH_SUGGESTION_PRICE_DATA_CURRENCY;
+ * const value = domainsearchsuggestionpricedata[propertyName];
+ * ```
+ *
+ * @see {@link DomainSearchSuggestionPriceData} - The TypeScript type definition
+ * @see {@link KEYS_DOMAIN_SEARCH_SUGGESTION_PRICE_DATA} - Array of all keys for this type
+ */
+export const KEY_DOMAIN_SEARCH_SUGGESTION_PRICE_DATA_CURRENCY = 'currency' as keyof DomainSearchSuggestionPriceData;
+/**
+ * period property
+ *
+ *
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `period` property of DomainSearchSuggestionPriceData objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = domainsearchsuggestionpricedata[KEY_DOMAIN_SEARCH_SUGGESTION_PRICE_DATA_PERIOD];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_DOMAIN_SEARCH_SUGGESTION_PRICE_DATA_PERIOD;
+ * const value = domainsearchsuggestionpricedata[propertyName];
+ * ```
+ *
+ * @see {@link DomainSearchSuggestionPriceData} - The TypeScript type definition
+ * @see {@link KEYS_DOMAIN_SEARCH_SUGGESTION_PRICE_DATA} - Array of all keys for this type
+ */
+export const KEY_DOMAIN_SEARCH_SUGGESTION_PRICE_DATA_PERIOD = 'period' as keyof DomainSearchSuggestionPriceData;
+
+/**
+ * Array of all DomainSearchSuggestionPriceData property keys
+ *
+ * @remarks
+ * This constant provides a readonly array containing all valid property keys for DomainSearchSuggestionPriceData objects.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all keys
+ * for (const key of KEYS_DOMAIN_SEARCH_SUGGESTION_PRICE_DATA) {
+ *   console.log(`Property: ${key}, Value: ${domainsearchsuggestionpricedata[key]}`);
+ * }
+ * 
+ * // Validation
+ * const isValidKey = KEYS_DOMAIN_SEARCH_SUGGESTION_PRICE_DATA.includes(someKey);
+ * ```
+ *
+ * @see {@link DomainSearchSuggestionPriceData} - The TypeScript type definition
+ */
+export const KEYS_DOMAIN_SEARCH_SUGGESTION_PRICE_DATA = [
+  KEY_DOMAIN_SEARCH_SUGGESTION_PRICE_DATA_AMOUNT,
+  KEY_DOMAIN_SEARCH_SUGGESTION_PRICE_DATA_CURRENCY,
+  KEY_DOMAIN_SEARCH_SUGGESTION_PRICE_DATA_PERIOD,
+] as const satisfies (keyof DomainSearchSuggestionPriceData)[];
+
 /**
  * Available
  *
@@ -6902,23 +7003,23 @@ export const KEYS_DOMAIN_SEARCH = [
  *
  *
  * @remarks
- * This key constant provides type-safe access to the `available` property of DomainSearchSuggestion objects.
+ * This key constant provides type-safe access to the `available` property of DomainSearchSuggestionWithPrice objects.
  * Use this constant when you need to access properties dynamically or ensure type safety.
  *
  * @example
  * ```typescript
  * // Direct property access
- * const value = domainsearchsuggestion[KEY_DOMAIN_SEARCH_SUGGESTION_AVAILABLE];
+ * const value = domainsearchsuggestionwithprice[KEY_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE_AVAILABLE];
  * 
  * // Dynamic property access
- * const propertyName = KEY_DOMAIN_SEARCH_SUGGESTION_AVAILABLE;
- * const value = domainsearchsuggestion[propertyName];
+ * const propertyName = KEY_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE_AVAILABLE;
+ * const value = domainsearchsuggestionwithprice[propertyName];
  * ```
  *
- * @see {@link DomainSearchSuggestion} - The TypeScript type definition
- * @see {@link KEYS_DOMAIN_SEARCH_SUGGESTION} - Array of all keys for this type
+ * @see {@link DomainSearchSuggestionWithPrice} - The TypeScript type definition
+ * @see {@link KEYS_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE} - Array of all keys for this type
  */
-export const KEY_DOMAIN_SEARCH_SUGGESTION_AVAILABLE = 'available' as keyof DomainSearchSuggestion;
+export const KEY_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE_AVAILABLE = 'available' as keyof DomainSearchSuggestionWithPrice;
 /**
  * Domain
  *
@@ -6927,23 +7028,23 @@ export const KEY_DOMAIN_SEARCH_SUGGESTION_AVAILABLE = 'available' as keyof Domai
  *
  *
  * @remarks
- * This key constant provides type-safe access to the `domain` property of DomainSearchSuggestion objects.
+ * This key constant provides type-safe access to the `domain` property of DomainSearchSuggestionWithPrice objects.
  * Use this constant when you need to access properties dynamically or ensure type safety.
  *
  * @example
  * ```typescript
  * // Direct property access
- * const value = domainsearchsuggestion[KEY_DOMAIN_SEARCH_SUGGESTION_DOMAIN];
+ * const value = domainsearchsuggestionwithprice[KEY_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE_DOMAIN];
  * 
  * // Dynamic property access
- * const propertyName = KEY_DOMAIN_SEARCH_SUGGESTION_DOMAIN;
- * const value = domainsearchsuggestion[propertyName];
+ * const propertyName = KEY_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE_DOMAIN;
+ * const value = domainsearchsuggestionwithprice[propertyName];
  * ```
  *
- * @see {@link DomainSearchSuggestion} - The TypeScript type definition
- * @see {@link KEYS_DOMAIN_SEARCH_SUGGESTION} - Array of all keys for this type
+ * @see {@link DomainSearchSuggestionWithPrice} - The TypeScript type definition
+ * @see {@link KEYS_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE} - Array of all keys for this type
  */
-export const KEY_DOMAIN_SEARCH_SUGGESTION_DOMAIN = 'domain' as keyof DomainSearchSuggestion;
+export const KEY_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE_DOMAIN = 'domain' as keyof DomainSearchSuggestionWithPrice;
 /**
  * Premium
  *
@@ -6952,49 +7053,74 @@ export const KEY_DOMAIN_SEARCH_SUGGESTION_DOMAIN = 'domain' as keyof DomainSearc
  *
  *
  * @remarks
- * This key constant provides type-safe access to the `premium` property of DomainSearchSuggestion objects.
+ * This key constant provides type-safe access to the `premium` property of DomainSearchSuggestionWithPrice objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = domainsearchsuggestionwithprice[KEY_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE_PREMIUM];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE_PREMIUM;
+ * const value = domainsearchsuggestionwithprice[propertyName];
+ * ```
+ *
+ * @see {@link DomainSearchSuggestionWithPrice} - The TypeScript type definition
+ * @see {@link KEYS_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE} - Array of all keys for this type
+ */
+export const KEY_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE_PREMIUM = 'premium' as keyof DomainSearchSuggestionWithPrice;
+/**
+ * price property
+ *
+ *
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `price` property of DomainSearchSuggestionWithPrice objects.
  * Use this constant when you need to access properties dynamically or ensure type safety.
  *
  * @example
  * ```typescript
  * // Direct property access
- * const value = domainsearchsuggestion[KEY_DOMAIN_SEARCH_SUGGESTION_PREMIUM];
+ * const value = domainsearchsuggestionwithprice[KEY_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE_PRICE];
  * 
  * // Dynamic property access
- * const propertyName = KEY_DOMAIN_SEARCH_SUGGESTION_PREMIUM;
- * const value = domainsearchsuggestion[propertyName];
+ * const propertyName = KEY_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE_PRICE;
+ * const value = domainsearchsuggestionwithprice[propertyName];
  * ```
  *
- * @see {@link DomainSearchSuggestion} - The TypeScript type definition
- * @see {@link KEYS_DOMAIN_SEARCH_SUGGESTION} - Array of all keys for this type
+ * @see {@link DomainSearchSuggestionWithPrice} - The TypeScript type definition
+ * @see {@link KEYS_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE} - Array of all keys for this type
  */
-export const KEY_DOMAIN_SEARCH_SUGGESTION_PREMIUM = 'premium' as keyof DomainSearchSuggestion;
+export const KEY_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE_PRICE = 'price' as keyof DomainSearchSuggestionWithPrice;
 
 /**
- * Array of all DomainSearchSuggestion property keys
+ * Array of all DomainSearchSuggestionWithPrice property keys
  *
  * @remarks
- * This constant provides a readonly array containing all valid property keys for DomainSearchSuggestion objects.
+ * This constant provides a readonly array containing all valid property keys for DomainSearchSuggestionWithPrice objects.
  * Useful for iteration, validation, and generating dynamic UI components.
  *
  * @example
  * ```typescript
  * // Iterating through all keys
- * for (const key of KEYS_DOMAIN_SEARCH_SUGGESTION) {
- *   console.log(`Property: ${key}, Value: ${domainsearchsuggestion[key]}`);
+ * for (const key of KEYS_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE) {
+ *   console.log(`Property: ${key}, Value: ${domainsearchsuggestionwithprice[key]}`);
  * }
  * 
  * // Validation
- * const isValidKey = KEYS_DOMAIN_SEARCH_SUGGESTION.includes(someKey);
+ * const isValidKey = KEYS_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE.includes(someKey);
  * ```
  *
- * @see {@link DomainSearchSuggestion} - The TypeScript type definition
+ * @see {@link DomainSearchSuggestionWithPrice} - The TypeScript type definition
  */
-export const KEYS_DOMAIN_SEARCH_SUGGESTION = [
-  KEY_DOMAIN_SEARCH_SUGGESTION_AVAILABLE,
-  KEY_DOMAIN_SEARCH_SUGGESTION_DOMAIN,
-  KEY_DOMAIN_SEARCH_SUGGESTION_PREMIUM,
-] as const satisfies (keyof DomainSearchSuggestion)[];
+export const KEYS_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE = [
+  KEY_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE_AVAILABLE,
+  KEY_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE_DOMAIN,
+  KEY_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE_PREMIUM,
+  KEY_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE_PRICE,
+] as const satisfies (keyof DomainSearchSuggestionWithPrice)[];
 
 /**
  * Default

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, DomainSearchSuggestion, 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, 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
@@ -304,19 +304,19 @@ export type SyncOperationTypeArray = SyncOperationType[];
  */
 export type DomainContactArray = DomainContact[];
 /**
- * DomainSearchSuggestion
+ * DomainSearchSuggestionWithPrice
  *
  * @remarks
- * Array type for DomainSearchSuggestion objects. Used when the API returns a collection of DomainSearchSuggestion instances.
+ * Array type for DomainSearchSuggestionWithPrice objects. Used when the API returns a collection of DomainSearchSuggestionWithPrice instances.
  *
  * @example
  * ```typescript
- * const items: DomainSearchSuggestionArray = await api.getDomainSearchSuggestions();
+ * const items: DomainSearchSuggestionWithPriceArray = await api.getDomainSearchSuggestionWithPrices();
  * ```
  *
- * @see {@link DomainSearchSuggestion} - The individual DomainSearchSuggestion type definition
+ * @see {@link DomainSearchSuggestionWithPrice} - The individual DomainSearchSuggestionWithPrice type definition
  */
-export type DomainSearchSuggestionArray = DomainSearchSuggestion[];
+export type DomainSearchSuggestionWithPriceArray = DomainSearchSuggestionWithPrice[];
 /**
  * DomainStatus
  *

package/src/helpers/schemas.d.ts

@@ -987,21 +987,37 @@ export type DomainSearchMeta = components['schemas']['DomainSearchMeta'];
  */
 export type DomainSearch = components['schemas']['DomainSearchResponse'];
 /**
- * DomainSearchSuggestion
+ * DomainSearchSuggestionPriceData
  *
  * @remarks
- * Type alias for the `DomainSearchSuggestion` OpenAPI schema.
- * This type represents domainsearchsuggestion data structures used in API requests and responses.
+ * Type alias for the `DomainSearchSuggestionPriceData` OpenAPI schema.
+ * This type represents domainsearchsuggestionpricedata data structures used in API requests and responses.
  *
  * @example
  * ```typescript
- * const response = await api.getDomainSearchSuggestion();
- * const item: DomainSearchSuggestion = response.results;
+ * const response = await api.getDomainSearchSuggestionPriceData();
+ * const item: DomainSearchSuggestionPriceData = response.results;
  * ```
  *
  * @see {@link components} - The OpenAPI components schema definition
  */
-export type DomainSearchSuggestion = components['schemas']['DomainSearchSuggestion'];
+export type DomainSearchSuggestionPriceData = components['schemas']['DomainSearchSuggestionPriceData'];
+/**
+ * DomainSearchSuggestionWithPrice
+ *
+ * @remarks
+ * Type alias for the `DomainSearchSuggestionWithPrice` OpenAPI schema.
+ * This type represents domainsearchsuggestionwithprice data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getDomainSearchSuggestionWithPrice();
+ * const item: DomainSearchSuggestionWithPrice = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type DomainSearchSuggestionWithPrice = components['schemas']['DomainSearchSuggestionWithPrice'];
 /**
  * DomainSortField
  *

package/src/openapi.yaml

@@ -1654,7 +1654,7 @@ components:
           $ref: '#/components/schemas/DomainSearchMeta'
         results:
           items:
-            $ref: '#/components/schemas/DomainSearchSuggestion'
+            $ref: '#/components/schemas/DomainSearchSuggestionWithPrice'
           title: Results
           type: array
       required:
@@ -1662,7 +1662,25 @@ components:
       - results
       title: DomainSearchResponse
       type: object
-    DomainSearchSuggestion:
+    DomainSearchSuggestionPriceData:
+      properties:
+        amount:
+          anyOf:
+          - type: string
+          - type: 'null'
+          title: Amount
+        currency:
+          title: Currency
+          type: string
+        period:
+          $ref: '#/components/schemas/DomainPeriod'
+      required:
+      - amount
+      - currency
+      - period
+      title: DomainSearchSuggestionPriceData
+      type: object
+    DomainSearchSuggestionWithPrice:
       properties:
         available:
           title: Available
@@ -1673,11 +1691,14 @@ components:
         premium:
           title: Premium
           type: boolean
+        price:
+          $ref: '#/components/schemas/DomainSearchSuggestionPriceData'
       required:
       - domain
       - available
       - premium
-      title: DomainSearchSuggestion
+      - price
+      title: DomainSearchSuggestionWithPrice
       type: object
     DomainSortField:
       enum:
@@ -4910,7 +4931,7 @@ info:
     '
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2025-09-05-075426
+  version: 2025-09-05-210401
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg

package/src/schema.d.ts

@@ -2212,16 +2212,25 @@ export interface components {
         DomainSearchResponse: {
             meta: components["schemas"]["DomainSearchMeta"];
             /** Results */
-            results: components["schemas"]["DomainSearchSuggestion"][];
+            results: components["schemas"]["DomainSearchSuggestionWithPrice"][];
         };
-        /** DomainSearchSuggestion */
-        DomainSearchSuggestion: {
+        /** DomainSearchSuggestionPriceData */
+        DomainSearchSuggestionPriceData: {
+            /** Amount */
+            amount: string | null;
+            /** Currency */
+            currency: string;
+            period: components["schemas"]["DomainPeriod"];
+        };
+        /** DomainSearchSuggestionWithPrice */
+        DomainSearchSuggestionWithPrice: {
             /** Available */
             available: boolean;
             /** Domain */
             domain: string;
             /** Premium */
             premium: boolean;
+            price: components["schemas"]["DomainSearchSuggestionPriceData"];
         };
         /**
          * DomainSortField