@opusdns/api 0.264.0 → 0.265.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "@opusdns/api-spec-ts-generator": "^0.19.0"
4
4
  },
5
5
  "name": "@opusdns/api",
6
- "version": "0.264.0",
6
+ "version": "0.265.0",
7
7
  "description": "TypeScript types for the OpusDNS OpenAPI specification",
8
8
  "main": "./src/index.ts",
9
9
  "module": "./src/index.ts",
@@ -257,7 +257,9 @@ import { Period } from './schemas';
257
257
  import { PermissionSet } from './schemas';
258
258
  import { PlatformStatsBucket } from './schemas';
259
259
  import { PremiumDomainsBase } from './schemas';
260
+ import { PremiumPriceEntryRes } from './schemas';
260
261
  import { PremiumPricingAction } from './schemas';
262
+ import { PremiumPricingRes } from './schemas';
261
263
  import { PremiumPricing } from './schemas';
262
264
  import { PriceInfo } from './schemas';
263
265
  import { PricingPeriod } from './schemas';
@@ -32465,6 +32467,111 @@ export const KEYS_PREMIUM_DOMAINS_BASE = [
32465
32467
  KEY_PREMIUM_DOMAINS_BASE_SUPPORTED,
32466
32468
  ] as const satisfies (keyof PremiumDomainsBase)[];
32467
32469
 
32470
+ /**
32471
+ * Action
32472
+ *
32473
+ * The action (e.g., create, renew, transfer)
32474
+ *
32475
+ * @type {string}
32476
+ *
32477
+ *
32478
+ * @remarks
32479
+ * This key constant provides type-safe access to the `action` property of PremiumPriceEntryRes objects.
32480
+ * Use this constant when you need to access properties dynamically or ensure type safety.
32481
+ *
32482
+ * @example
32483
+ * ```typescript
32484
+ * // Direct property access
32485
+ * const value = premiumpriceentryres[KEY_PREMIUM_PRICE_ENTRY_RES_ACTION];
32486
+ *
32487
+ * // Dynamic property access
32488
+ * const propertyName = KEY_PREMIUM_PRICE_ENTRY_RES_ACTION;
32489
+ * const value = premiumpriceentryres[propertyName];
32490
+ * ```
32491
+ *
32492
+ * @see {@link PremiumPriceEntryRes} - The TypeScript type definition
32493
+ * @see {@link KEYS_PREMIUM_PRICE_ENTRY_RES} - Array of all keys for this type
32494
+ */
32495
+ export const KEY_PREMIUM_PRICE_ENTRY_RES_ACTION: keyof PremiumPriceEntryRes = 'action';
32496
+ /**
32497
+ * Currency
32498
+ *
32499
+ * Currency of the price
32500
+ *
32501
+ * @type {string}
32502
+ *
32503
+ *
32504
+ * @remarks
32505
+ * This key constant provides type-safe access to the `currency` property of PremiumPriceEntryRes objects.
32506
+ * Use this constant when you need to access properties dynamically or ensure type safety.
32507
+ *
32508
+ * @example
32509
+ * ```typescript
32510
+ * // Direct property access
32511
+ * const value = premiumpriceentryres[KEY_PREMIUM_PRICE_ENTRY_RES_CURRENCY];
32512
+ *
32513
+ * // Dynamic property access
32514
+ * const propertyName = KEY_PREMIUM_PRICE_ENTRY_RES_CURRENCY;
32515
+ * const value = premiumpriceentryres[propertyName];
32516
+ * ```
32517
+ *
32518
+ * @see {@link PremiumPriceEntryRes} - The TypeScript type definition
32519
+ * @see {@link KEYS_PREMIUM_PRICE_ENTRY_RES} - Array of all keys for this type
32520
+ */
32521
+ export const KEY_PREMIUM_PRICE_ENTRY_RES_CURRENCY: keyof PremiumPriceEntryRes = 'currency';
32522
+ /**
32523
+ * Price
32524
+ *
32525
+ * Customer-facing price after markup
32526
+ *
32527
+ * @type {string}
32528
+ *
32529
+ *
32530
+ * @remarks
32531
+ * This key constant provides type-safe access to the `price` property of PremiumPriceEntryRes objects.
32532
+ * Use this constant when you need to access properties dynamically or ensure type safety.
32533
+ *
32534
+ * @example
32535
+ * ```typescript
32536
+ * // Direct property access
32537
+ * const value = premiumpriceentryres[KEY_PREMIUM_PRICE_ENTRY_RES_PRICE];
32538
+ *
32539
+ * // Dynamic property access
32540
+ * const propertyName = KEY_PREMIUM_PRICE_ENTRY_RES_PRICE;
32541
+ * const value = premiumpriceentryres[propertyName];
32542
+ * ```
32543
+ *
32544
+ * @see {@link PremiumPriceEntryRes} - The TypeScript type definition
32545
+ * @see {@link KEYS_PREMIUM_PRICE_ENTRY_RES} - Array of all keys for this type
32546
+ */
32547
+ export const KEY_PREMIUM_PRICE_ENTRY_RES_PRICE: keyof PremiumPriceEntryRes = 'price';
32548
+
32549
+ /**
32550
+ * Array of all PremiumPriceEntryRes property keys
32551
+ *
32552
+ * @remarks
32553
+ * This constant provides a readonly array containing all valid property keys for PremiumPriceEntryRes objects.
32554
+ * Useful for iteration, validation, and generating dynamic UI components.
32555
+ *
32556
+ * @example
32557
+ * ```typescript
32558
+ * // Iterating through all keys
32559
+ * for (const key of KEYS_PREMIUM_PRICE_ENTRY_RES) {
32560
+ * console.log(`Property: ${key}, Value: ${premiumpriceentryres[key]}`);
32561
+ * }
32562
+ *
32563
+ * // Validation
32564
+ * const isValidKey = KEYS_PREMIUM_PRICE_ENTRY_RES.includes(someKey);
32565
+ * ```
32566
+ *
32567
+ * @see {@link PremiumPriceEntryRes} - The TypeScript type definition
32568
+ */
32569
+ export const KEYS_PREMIUM_PRICE_ENTRY_RES = [
32570
+ KEY_PREMIUM_PRICE_ENTRY_RES_ACTION,
32571
+ KEY_PREMIUM_PRICE_ENTRY_RES_CURRENCY,
32572
+ KEY_PREMIUM_PRICE_ENTRY_RES_PRICE,
32573
+ ] as const satisfies (keyof PremiumPriceEntryRes)[];
32574
+
32468
32575
  /**
32469
32576
  * Action
32470
32577
  *
@@ -32570,6 +32677,57 @@ export const KEYS_PREMIUM_PRICING_ACTION = [
32570
32677
  KEY_PREMIUM_PRICING_ACTION_PRICE,
32571
32678
  ] as const satisfies (keyof PremiumPricingAction)[];
32572
32679
 
32680
+ /**
32681
+ * Prices
32682
+ *
32683
+ * Premium prices per action
32684
+ *
32685
+ * @type {array}
32686
+ *
32687
+ *
32688
+ * @remarks
32689
+ * This key constant provides type-safe access to the `prices` property of PremiumPricingRes objects.
32690
+ * Use this constant when you need to access properties dynamically or ensure type safety.
32691
+ *
32692
+ * @example
32693
+ * ```typescript
32694
+ * // Direct property access
32695
+ * const value = premiumpricingres[KEY_PREMIUM_PRICING_RES_PRICES];
32696
+ *
32697
+ * // Dynamic property access
32698
+ * const propertyName = KEY_PREMIUM_PRICING_RES_PRICES;
32699
+ * const value = premiumpricingres[propertyName];
32700
+ * ```
32701
+ *
32702
+ * @see {@link PremiumPricingRes} - The TypeScript type definition
32703
+ * @see {@link KEYS_PREMIUM_PRICING_RES} - Array of all keys for this type
32704
+ */
32705
+ export const KEY_PREMIUM_PRICING_RES_PRICES: keyof PremiumPricingRes = 'prices';
32706
+
32707
+ /**
32708
+ * Array of all PremiumPricingRes property keys
32709
+ *
32710
+ * @remarks
32711
+ * This constant provides a readonly array containing all valid property keys for PremiumPricingRes objects.
32712
+ * Useful for iteration, validation, and generating dynamic UI components.
32713
+ *
32714
+ * @example
32715
+ * ```typescript
32716
+ * // Iterating through all keys
32717
+ * for (const key of KEYS_PREMIUM_PRICING_RES) {
32718
+ * console.log(`Property: ${key}, Value: ${premiumpricingres[key]}`);
32719
+ * }
32720
+ *
32721
+ * // Validation
32722
+ * const isValidKey = KEYS_PREMIUM_PRICING_RES.includes(someKey);
32723
+ * ```
32724
+ *
32725
+ * @see {@link PremiumPricingRes} - The TypeScript type definition
32726
+ */
32727
+ export const KEYS_PREMIUM_PRICING_RES = [
32728
+ KEY_PREMIUM_PRICING_RES_PRICES,
32729
+ ] as const satisfies (keyof PremiumPricingRes)[];
32730
+
32573
32731
  /**
32574
32732
  * Prices
32575
32733
  *
@@ -21,7 +21,7 @@
21
21
  * This file is auto-generated from the OpenAPI specification.
22
22
  * Do not edit manually.
23
23
  */
24
- import { DomainIncludeField, DomainDnssecData, DomainDnssecDataCreate, JobStatus, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, ReportType, ReportStatus, TagType, 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, DomainTagEnriched, 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, Tag, UserPublic, ParkingCreateBulkInstance, ParkingDeleteBulkInstance, ParkingDisableBulkInstance, ParkingEnableBulkInstance, Period, Permission, PremiumAffectsType, PremiumPricingAction, PublicReportRes, Relation, LegalRequirementBase, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
24
+ import { DomainIncludeField, DomainDnssecData, DomainDnssecDataCreate, JobStatus, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, ReportType, ReportStatus, TagType, 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, DomainTagEnriched, 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, Tag, UserPublic, ParkingCreateBulkInstance, ParkingDeleteBulkInstance, ParkingDisableBulkInstance, ParkingEnableBulkInstance, Period, Permission, PremiumAffectsType, PremiumPriceEntryRes, PremiumPricingAction, PublicReportRes, Relation, LegalRequirementBase, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
25
25
 
26
26
  /**
27
27
  * DomainIncludeField
@@ -1353,6 +1353,20 @@ export type PermissionArray = Permission[];
1353
1353
  * @see {@link PremiumAffectsType} - The individual PremiumAffectsType type definition
1354
1354
  */
1355
1355
  export type PremiumAffectsTypeArray = PremiumAffectsType[];
1356
+ /**
1357
+ * PremiumPriceEntryRes. A single premium price entry for a specific action
1358
+ *
1359
+ * @remarks
1360
+ * Array type for PremiumPriceEntryRes objects. Used when the API returns a collection of PremiumPriceEntryRes instances.
1361
+ *
1362
+ * @example
1363
+ * ```typescript
1364
+ * const items: PremiumPriceEntryResArray = await api.getPremiumPriceEntryRess();
1365
+ * ```
1366
+ *
1367
+ * @see {@link PremiumPriceEntryRes} - The individual PremiumPriceEntryRes type definition
1368
+ */
1369
+ export type PremiumPriceEntryResArray = PremiumPriceEntryRes[];
1356
1370
  /**
1357
1371
  * PremiumPricingAction
1358
1372
  *
@@ -5140,6 +5140,22 @@ export type PremiumAffectsType = components['schemas']['PremiumAffectsType'];
5140
5140
  * @see {@link components} - The OpenAPI components schema definition
5141
5141
  */
5142
5142
  export type PremiumDomainsBase = components['schemas']['PremiumDomainsBase'];
5143
+ /**
5144
+ * PremiumPriceEntryRes. A single premium price entry for a specific action
5145
+ *
5146
+ * @remarks
5147
+ * Type alias for the `PremiumPriceEntryRes` OpenAPI schema.
5148
+ * This type represents premiumpriceentryres data structures used in API requests and responses.
5149
+ *
5150
+ * @example
5151
+ * ```typescript
5152
+ * const response = await api.getPremiumPriceEntryRes();
5153
+ * const item: PremiumPriceEntryRes = response.results;
5154
+ * ```
5155
+ *
5156
+ * @see {@link components} - The OpenAPI components schema definition
5157
+ */
5158
+ export type PremiumPriceEntryRes = components['schemas']['PremiumPriceEntryRes'];
5143
5159
  /**
5144
5160
  * PremiumPricingAction
5145
5161
  *
@@ -5156,6 +5172,22 @@ export type PremiumDomainsBase = components['schemas']['PremiumDomainsBase'];
5156
5172
  * @see {@link components} - The OpenAPI components schema definition
5157
5173
  */
5158
5174
  export type PremiumPricingAction = components['schemas']['PremiumPricingAction'];
5175
+ /**
5176
+ * PremiumPricingRes. Premium pricing details for a domain
5177
+ *
5178
+ * @remarks
5179
+ * Type alias for the `PremiumPricingRes` OpenAPI schema.
5180
+ * This type represents premiumpricingres data structures used in API requests and responses.
5181
+ *
5182
+ * @example
5183
+ * ```typescript
5184
+ * const response = await api.getPremiumPricingRes();
5185
+ * const item: PremiumPricingRes = response.results;
5186
+ * ```
5187
+ *
5188
+ * @see {@link components} - The OpenAPI components schema definition
5189
+ */
5190
+ export type PremiumPricingRes = components['schemas']['PremiumPricingRes'];
5159
5191
  /**
5160
5192
  * PremiumPricingResponse
5161
5193
  *
package/src/openapi.yaml CHANGED
@@ -8159,6 +8159,28 @@ components:
8159
8159
  - supported
8160
8160
  title: PremiumDomainsBase
8161
8161
  type: object
8162
+ PremiumPriceEntryRes:
8163
+ description: A single premium price entry for a specific action
8164
+ properties:
8165
+ action:
8166
+ description: The action (e.g., create, renew, transfer)
8167
+ title: Action
8168
+ type: string
8169
+ currency:
8170
+ description: Currency of the price
8171
+ title: Currency
8172
+ type: string
8173
+ price:
8174
+ description: Customer-facing price after markup
8175
+ pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
8176
+ title: Price
8177
+ type: string
8178
+ required:
8179
+ - action
8180
+ - price
8181
+ - currency
8182
+ title: PremiumPriceEntryRes
8183
+ type: object
8162
8184
  PremiumPricingAction:
8163
8185
  properties:
8164
8186
  action:
@@ -8180,6 +8202,19 @@ components:
8180
8202
  - currency
8181
8203
  title: PremiumPricingAction
8182
8204
  type: object
8205
+ PremiumPricingRes:
8206
+ description: Premium pricing details for a domain
8207
+ properties:
8208
+ prices:
8209
+ description: Premium prices per action
8210
+ items:
8211
+ $ref: '#/components/schemas/PremiumPriceEntryRes'
8212
+ title: Prices
8213
+ type: array
8214
+ required:
8215
+ - prices
8216
+ title: PremiumPricingRes
8217
+ type: object
8183
8218
  PremiumPricingResponse:
8184
8219
  properties:
8185
8220
  prices:
@@ -10121,7 +10156,7 @@ info:
10121
10156
  \n\n"
10122
10157
  summary: OpusDNS - your gateway to a seamless domain management experience.
10123
10158
  title: OpusDNS API
10124
- version: 2026-04-23-182347
10159
+ version: 2026-04-23-230452
10125
10160
  x-logo:
10126
10161
  altText: OpusDNS API Reference
10127
10162
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
package/src/schema.d.ts CHANGED
@@ -7695,6 +7695,27 @@ export interface components {
7695
7695
  */
7696
7696
  supported: boolean;
7697
7697
  };
7698
+ /**
7699
+ * PremiumPriceEntryRes
7700
+ * @description A single premium price entry for a specific action
7701
+ */
7702
+ PremiumPriceEntryRes: {
7703
+ /**
7704
+ * Action
7705
+ * @description The action (e.g., create, renew, transfer)
7706
+ */
7707
+ action: string;
7708
+ /**
7709
+ * Currency
7710
+ * @description Currency of the price
7711
+ */
7712
+ currency: string;
7713
+ /**
7714
+ * Price
7715
+ * @description Customer-facing price after markup
7716
+ */
7717
+ price: string;
7718
+ };
7698
7719
  /** PremiumPricingAction */
7699
7720
  PremiumPricingAction: {
7700
7721
  /**
@@ -7713,6 +7734,17 @@ export interface components {
7713
7734
  */
7714
7735
  price: string;
7715
7736
  };
7737
+ /**
7738
+ * PremiumPricingRes
7739
+ * @description Premium pricing details for a domain
7740
+ */
7741
+ PremiumPricingRes: {
7742
+ /**
7743
+ * Prices
7744
+ * @description Premium prices per action
7745
+ */
7746
+ prices: components["schemas"]["PremiumPriceEntryRes"][];
7747
+ };
7716
7748
  /** PremiumPricingResponse */
7717
7749
  PremiumPricingResponse: {
7718
7750
  /**