@opusdns/api 0.238.0 → 0.240.0

package/package.json

@@ -3,7 +3,7 @@
     "@opusdns/api-spec-ts-generator": "^0.19.0"
   },
   "name": "@opusdns/api",
-  "version": "0.238.0",
+  "version": "0.240.0",
   "description": "TypeScript types for the OpusDNS OpenAPI specification",
   "main": "./src/index.ts",
   "module": "./src/index.ts",

package/src/helpers/keys.ts

@@ -253,6 +253,8 @@ import { Period } from './schemas';
 import { PermissionSet } from './schemas';
 import { PlatformStatsBucket } from './schemas';
 import { PremiumDomainsBase } from './schemas';
+import { PremiumPricingAction } from './schemas';
+import { PremiumPricing } from './schemas';
 import { PriceInfo } from './schemas';
 import { PricingPeriod } from './schemas';
 import { Problem } from './schemas';
@@ -15021,6 +15023,32 @@ export const KEY_DOMAIN_EXPIRES_ON: keyof Domain = 'expires_on';
  * @see {@link KEYS_DOMAIN} - Array of all keys for this type
  */
 export const KEY_DOMAIN_HOSTS: keyof Domain = 'hosts';
+/**
+ * Is Premium
+ *
+ * Whether this is a premium domain
+ *
+ * @type {boolean}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `is_premium` property of Domain objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = domain[KEY_DOMAIN_IS_PREMIUM];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_DOMAIN_IS_PREMIUM;
+ * const value = domain[propertyName];
+ * ```
+ *
+ * @see {@link Domain} - The TypeScript type definition
+ * @see {@link KEYS_DOMAIN} - Array of all keys for this type
+ */
+export const KEY_DOMAIN_IS_PREMIUM: keyof Domain = 'is_premium';
 /**
  * Name
  *
@@ -15361,6 +15389,7 @@ export const KEYS_DOMAIN = [
   KEY_DOMAIN_DOMAIN_ID,
   KEY_DOMAIN_EXPIRES_ON,
   KEY_DOMAIN_HOSTS,
+  KEY_DOMAIN_IS_PREMIUM,
   KEY_DOMAIN_NAME,
   KEY_DOMAIN_NAMESERVERS,
   KEY_DOMAIN_OWNER_ID,
@@ -31673,6 +31702,162 @@ export const KEYS_PREMIUM_DOMAINS_BASE = [
   KEY_PREMIUM_DOMAINS_BASE_SUPPORTED,
 ] as const satisfies (keyof PremiumDomainsBase)[];
 
+/**
+ * Action
+ *
+ * The action (e.g., create, renew, transfer)
+ *
+ * @type {string}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `action` property of PremiumPricingAction objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = premiumpricingaction[KEY_PREMIUM_PRICING_ACTION_ACTION];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_PREMIUM_PRICING_ACTION_ACTION;
+ * const value = premiumpricingaction[propertyName];
+ * ```
+ *
+ * @see {@link PremiumPricingAction} - The TypeScript type definition
+ * @see {@link KEYS_PREMIUM_PRICING_ACTION} - Array of all keys for this type
+ */
+export const KEY_PREMIUM_PRICING_ACTION_ACTION: keyof PremiumPricingAction = 'action';
+/**
+ * Currency
+ *
+ * Currency of the price
+ *
+ * @type {string}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `currency` property of PremiumPricingAction objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = premiumpricingaction[KEY_PREMIUM_PRICING_ACTION_CURRENCY];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_PREMIUM_PRICING_ACTION_CURRENCY;
+ * const value = premiumpricingaction[propertyName];
+ * ```
+ *
+ * @see {@link PremiumPricingAction} - The TypeScript type definition
+ * @see {@link KEYS_PREMIUM_PRICING_ACTION} - Array of all keys for this type
+ */
+export const KEY_PREMIUM_PRICING_ACTION_CURRENCY: keyof PremiumPricingAction = 'currency';
+/**
+ * Price
+ *
+ * Customer-facing price after markup
+ *
+ * @type {string}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `price` property of PremiumPricingAction objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = premiumpricingaction[KEY_PREMIUM_PRICING_ACTION_PRICE];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_PREMIUM_PRICING_ACTION_PRICE;
+ * const value = premiumpricingaction[propertyName];
+ * ```
+ *
+ * @see {@link PremiumPricingAction} - The TypeScript type definition
+ * @see {@link KEYS_PREMIUM_PRICING_ACTION} - Array of all keys for this type
+ */
+export const KEY_PREMIUM_PRICING_ACTION_PRICE: keyof PremiumPricingAction = 'price';
+
+/**
+ * Array of all PremiumPricingAction property keys
+ *
+ * @remarks
+ * This constant provides a readonly array containing all valid property keys for PremiumPricingAction objects.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all keys
+ * for (const key of KEYS_PREMIUM_PRICING_ACTION) {
+ *   console.log(`Property: ${key}, Value: ${premiumpricingaction[key]}`);
+ * }
+ * 
+ * // Validation
+ * const isValidKey = KEYS_PREMIUM_PRICING_ACTION.includes(someKey);
+ * ```
+ *
+ * @see {@link PremiumPricingAction} - The TypeScript type definition
+ */
+export const KEYS_PREMIUM_PRICING_ACTION = [
+  KEY_PREMIUM_PRICING_ACTION_ACTION,
+  KEY_PREMIUM_PRICING_ACTION_CURRENCY,
+  KEY_PREMIUM_PRICING_ACTION_PRICE,
+] as const satisfies (keyof PremiumPricingAction)[];
+
+/**
+ * Prices
+ *
+ * Premium prices per action
+ *
+ * @type {array}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `prices` property of PremiumPricing objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = premiumpricing[KEY_PREMIUM_PRICING_PRICES];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_PREMIUM_PRICING_PRICES;
+ * const value = premiumpricing[propertyName];
+ * ```
+ *
+ * @see {@link PremiumPricing} - The TypeScript type definition
+ * @see {@link KEYS_PREMIUM_PRICING} - Array of all keys for this type
+ */
+export const KEY_PREMIUM_PRICING_PRICES: keyof PremiumPricing = 'prices';
+
+/**
+ * Array of all PremiumPricing property keys
+ *
+ * @remarks
+ * This constant provides a readonly array containing all valid property keys for PremiumPricing objects.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all keys
+ * for (const key of KEYS_PREMIUM_PRICING) {
+ *   console.log(`Property: ${key}, Value: ${premiumpricing[key]}`);
+ * }
+ * 
+ * // Validation
+ * const isValidKey = KEYS_PREMIUM_PRICING.includes(someKey);
+ * ```
+ *
+ * @see {@link PremiumPricing} - The TypeScript type definition
+ */
+export const KEYS_PREMIUM_PRICING = [
+  KEY_PREMIUM_PRICING_PRICES,
+] as const satisfies (keyof PremiumPricing)[];
+
 /**
  * Currency
  *
@@ -38266,6 +38451,57 @@ export const KEY_DOMAIN_AVAILABILITY_CHECK_AVAILABLE: keyof DomainAvailabilityCh
  * @see {@link KEYS_DOMAIN_AVAILABILITY_CHECK} - Array of all keys for this type
  */
 export const KEY_DOMAIN_AVAILABILITY_CHECK_DOMAIN: keyof DomainAvailabilityCheck = 'domain';
+/**
+ * Is Premium
+ *
+ * Whether this is a premium domain
+ *
+ * @type {boolean}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `is_premium` property of DomainAvailabilityCheck objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = domainavailabilitycheck[KEY_DOMAIN_AVAILABILITY_CHECK_IS_PREMIUM];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_DOMAIN_AVAILABILITY_CHECK_IS_PREMIUM;
+ * const value = domainavailabilitycheck[propertyName];
+ * ```
+ *
+ * @see {@link DomainAvailabilityCheck} - The TypeScript type definition
+ * @see {@link KEYS_DOMAIN_AVAILABILITY_CHECK} - Array of all keys for this type
+ */
+export const KEY_DOMAIN_AVAILABILITY_CHECK_IS_PREMIUM: keyof DomainAvailabilityCheck = 'is_premium';
+/**
+ * premium_pricing property
+ *
+ * Premium pricing details, present when domain is premium and pricing is available
+ *
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `premium_pricing` property of DomainAvailabilityCheck objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = domainavailabilitycheck[KEY_DOMAIN_AVAILABILITY_CHECK_PREMIUM_PRICING];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_DOMAIN_AVAILABILITY_CHECK_PREMIUM_PRICING;
+ * const value = domainavailabilitycheck[propertyName];
+ * ```
+ *
+ * @see {@link DomainAvailabilityCheck} - The TypeScript type definition
+ * @see {@link KEYS_DOMAIN_AVAILABILITY_CHECK} - Array of all keys for this type
+ */
+export const KEY_DOMAIN_AVAILABILITY_CHECK_PREMIUM_PRICING: keyof DomainAvailabilityCheck = 'premium_pricing';
 /**
  * Reason
  *
@@ -38314,5 +38550,7 @@ export const KEY_DOMAIN_AVAILABILITY_CHECK_REASON: keyof DomainAvailabilityCheck
 export const KEYS_DOMAIN_AVAILABILITY_CHECK = [
   KEY_DOMAIN_AVAILABILITY_CHECK_AVAILABLE,
   KEY_DOMAIN_AVAILABILITY_CHECK_DOMAIN,
+  KEY_DOMAIN_AVAILABILITY_CHECK_IS_PREMIUM,
+  KEY_DOMAIN_AVAILABILITY_CHECK_PREMIUM_PRICING,
   KEY_DOMAIN_AVAILABILITY_CHECK_REASON,
 ] as const satisfies (keyof DomainAvailabilityCheck)[];

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, JobStatus, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, ReportType, ReportStatus, TldResponseShort, AttributeCondition, DomainContactType, ContactCreateBulkInstance, ContactAttributeLinkDetail, ContactAttributeDefinition, PostalAddressType, ContactConfigBase, CommandError, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsZoneCreateBulkInstance, DnsRecordPatchOp, DnsZonePatchRecordsBulkInstance, DnsRrsetPatchOp, DnsZonePatchRrsetsBulkInstance, DnsRrset, DnsZoneUpdateBulkInstance, DomainAvailabilityCheck, ContactHandle, Nameserver, DomainCreateBulkInstance, BrowserStatsBucket, GeoStatsBucket, TimeSeriesBucket, DomainForwardPatchOp, PlatformStatsBucket, HttpRedirectRequest, HttpRedirectList, ReferrerStatsBucket, StatusCodeStatsBucket, UserAgentStatsBucket, VisitsByKeyBucket, DomainForward, DeletePolicyType, SyncOperationType, DomainContact, DomainHost, DomainSearchSuggestionWithPrice, DomainStatus, DomainTransferBulkInstance, DomainClientStatus, DomainUpdateBulkInstance, EmailForwardAliasCreate, EmailForwardLogEvent, EmailForwardAliasMetrics, EmailForwardAlias, EmailForward, PriceInfo, ValidationError, LaunchPhaseBase, LegalRequirementOperationType, LocalPresenceRequirementType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactAttributeSet, Contact, DnsZone, DomainForwardZone, Domain, EmailForwardLog, EmailForwardZone, EventResponse, Invoice, JobBatchMetadata, Job, ObjectLog, Organization, Parking, RequestHistory, UserPublic, ParkingCreateBulkInstance, ParkingDeleteBulkInstance, ParkingDisableBulkInstance, ParkingEnableBulkInstance, Period, Permission, PremiumAffectsType, PublicReportRes, Relation, LegalRequirementBase, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
+import { DomainDnssecData, DomainDnssecDataCreate, JobStatus, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, ReportType, ReportStatus, TldResponseShort, AttributeCondition, DomainContactType, ContactCreateBulkInstance, ContactAttributeLinkDetail, ContactAttributeDefinition, PostalAddressType, ContactConfigBase, CommandError, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsZoneCreateBulkInstance, DnsRecordPatchOp, DnsZonePatchRecordsBulkInstance, DnsRrsetPatchOp, DnsZonePatchRrsetsBulkInstance, DnsRrset, DnsZoneUpdateBulkInstance, DomainAvailabilityCheck, ContactHandle, Nameserver, DomainCreateBulkInstance, BrowserStatsBucket, GeoStatsBucket, TimeSeriesBucket, DomainForwardPatchOp, PlatformStatsBucket, HttpRedirectRequest, HttpRedirectList, ReferrerStatsBucket, StatusCodeStatsBucket, UserAgentStatsBucket, VisitsByKeyBucket, DomainForward, DeletePolicyType, SyncOperationType, DomainContact, DomainHost, DomainSearchSuggestionWithPrice, DomainStatus, DomainTransferBulkInstance, DomainClientStatus, DomainUpdateBulkInstance, EmailForwardAliasCreate, EmailForwardLogEvent, EmailForwardAliasMetrics, EmailForwardAlias, EmailForward, PriceInfo, ValidationError, LaunchPhaseBase, LegalRequirementOperationType, LocalPresenceRequirementType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactAttributeSet, Contact, DnsZone, DomainForwardZone, Domain, EmailForwardLog, EmailForwardZone, EventResponse, Invoice, JobBatchMetadata, Job, ObjectLog, Organization, Parking, RequestHistory, UserPublic, ParkingCreateBulkInstance, ParkingDeleteBulkInstance, ParkingDisableBulkInstance, ParkingEnableBulkInstance, Period, Permission, PremiumAffectsType, PremiumPricingAction, PublicReportRes, Relation, LegalRequirementBase, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
 
 /**
  * DomainDnssecDataResponse
@@ -1297,6 +1297,20 @@ export type PermissionArray = Permission[];
  * @see {@link PremiumAffectsType} - The individual PremiumAffectsType type definition
  */
 export type PremiumAffectsTypeArray = PremiumAffectsType[];
+/**
+ * PremiumPricingAction
+ *
+ * @remarks
+ * Array type for PremiumPricingAction objects. Used when the API returns a collection of PremiumPricingAction instances.
+ *
+ * @example
+ * ```typescript
+ * const items: PremiumPricingActionArray = await api.getPremiumPricingActions();
+ * ```
+ *
+ * @see {@link PremiumPricingAction} - The individual PremiumPricingAction type definition
+ */
+export type PremiumPricingActionArray = PremiumPricingAction[];
 /**
  * PublicReportRes
  *

package/src/helpers/schemas.d.ts

@@ -5044,6 +5044,38 @@ export type PremiumAffectsType = components['schemas']['PremiumAffectsType'];
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type PremiumDomainsBase = components['schemas']['PremiumDomainsBase'];
+/**
+ * PremiumPricingAction
+ *
+ * @remarks
+ * Type alias for the `PremiumPricingAction` OpenAPI schema.
+ * This type represents premiumpricingaction data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getPremiumPricingAction();
+ * const item: PremiumPricingAction = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type PremiumPricingAction = components['schemas']['PremiumPricingAction'];
+/**
+ * PremiumPricingResponse
+ *
+ * @remarks
+ * Type alias for the `PremiumPricingResponse` OpenAPI schema.
+ * This type represents premiumpricingresponse data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getPremiumPricing();
+ * const item: PremiumPricing = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type PremiumPricing = components['schemas']['PremiumPricingResponse'];
 /**
  * PremiumSourceType
  *

package/src/openapi.yaml

@@ -3499,6 +3499,11 @@ components:
             $ref: '#/components/schemas/DomainHostResponse'
           title: Hosts
           type: array
+        is_premium:
+          default: false
+          description: Whether this is a premium domain
+          title: Is Premium
+          type: boolean
         name:
           description: The domain name
           examples:
@@ -7906,6 +7911,39 @@ components:
       - supported
       title: PremiumDomainsBase
       type: object
+    PremiumPricingAction:
+      properties:
+        action:
+          description: The action (e.g., create, renew, transfer)
+          title: Action
+          type: string
+        currency:
+          description: Currency of the price
+          title: Currency
+          type: string
+        price:
+          description: Customer-facing price after markup
+          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
+          title: Price
+          type: string
+      required:
+      - action
+      - price
+      - currency
+      title: PremiumPricingAction
+      type: object
+    PremiumPricingResponse:
+      properties:
+        prices:
+          description: Premium prices per action
+          items:
+            $ref: '#/components/schemas/PremiumPricingAction'
+          title: Prices
+          type: array
+      required:
+      - prices
+      title: PremiumPricingResponse
+      type: object
     PremiumSourceType:
       enum:
       - EPP
@@ -9572,6 +9610,17 @@ components:
           - example.com
           title: Domain
           type: string
+        is_premium:
+          default: false
+          description: Whether this is a premium domain
+          title: Is Premium
+          type: boolean
+        premium_pricing:
+          anyOf:
+          - $ref: '#/components/schemas/PremiumPricingResponse'
+          - type: 'null'
+          description: Premium pricing details, present when domain is premium and
+            pricing is available
         reason:
           anyOf:
           - type: string
@@ -9653,7 +9702,7 @@ info:
     \n\n"
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2026-04-08-115618
+  version: 2026-04-09-170030
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg

package/src/schema.d.ts

@@ -4497,6 +4497,12 @@ export interface components {
              * @description The subordinate hosts of the domain
              */
             hosts?: components["schemas"]["DomainHostResponse"][];
+            /**
+             * Is Premium
+             * @description Whether this is a premium domain
+             * @default false
+             */
+            is_premium: boolean;
             /**
              * Name
              * @description The domain name
@@ -7456,6 +7462,32 @@ export interface components {
              */
             supported: boolean;
         };
+        /** PremiumPricingAction */
+        PremiumPricingAction: {
+            /**
+             * Action
+             * @description The action (e.g., create, renew, transfer)
+             */
+            action: string;
+            /**
+             * Currency
+             * @description Currency of the price
+             */
+            currency: string;
+            /**
+             * Price
+             * @description Customer-facing price after markup
+             */
+            price: string;
+        };
+        /** PremiumPricingResponse */
+        PremiumPricingResponse: {
+            /**
+             * Prices
+             * @description Premium prices per action
+             */
+            prices: components["schemas"]["PremiumPricingAction"][];
+        };
         /**
          * PremiumSourceType
          * @enum {string}
@@ -8588,6 +8620,14 @@ export interface components {
              * @example example.com
              */
             domain: string;
+            /**
+             * Is Premium
+             * @description Whether this is a premium domain
+             * @default false
+             */
+            is_premium: boolean;
+            /** @description Premium pricing details, present when domain is premium and pricing is available */
+            premium_pricing?: components["schemas"]["PremiumPricingResponse"] | null;
             /** Reason */
             reason: string | null;
         };