@opusdns/api 1.104.0 → 1.105.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 +1 -1
- package/src/helpers/constants.ts +11 -0
- package/src/helpers/keys.ts +15 -0
- package/src/helpers/schemas.d.ts +2 -0
- package/src/openapi.yaml +59 -3
- package/src/schema.d.ts +37 -3
package/package.json
CHANGED
package/src/helpers/constants.ts
CHANGED
|
@@ -36,6 +36,7 @@ import type {
|
|
|
36
36
|
DomainForwardSortField,
|
|
37
37
|
DomainForwardZoneSortField,
|
|
38
38
|
DomainIncludeField,
|
|
39
|
+
DomainListIncludeField,
|
|
39
40
|
DomainSortField,
|
|
40
41
|
DomainStatus,
|
|
41
42
|
EmailForwardLogSortField,
|
|
@@ -722,12 +723,22 @@ export const DOMAIN_FORWARD_ZONE_SORT_FIELD_VALUES = [
|
|
|
722
723
|
|
|
723
724
|
export const DOMAIN_INCLUDE_FIELD = {
|
|
724
725
|
TAGS: "tags",
|
|
726
|
+
RENEWAL_PRICE: "renewal_price",
|
|
725
727
|
} as const satisfies Record<string, DomainIncludeField>;
|
|
726
728
|
|
|
727
729
|
export const DOMAIN_INCLUDE_FIELD_VALUES = [
|
|
728
730
|
'tags',
|
|
731
|
+
'renewal_price',
|
|
729
732
|
] as const satisfies ReadonlyArray<DomainIncludeField>;
|
|
730
733
|
|
|
734
|
+
export const DOMAIN_LIST_INCLUDE_FIELD = {
|
|
735
|
+
TAGS: "tags",
|
|
736
|
+
} as const satisfies Record<string, DomainListIncludeField>;
|
|
737
|
+
|
|
738
|
+
export const DOMAIN_LIST_INCLUDE_FIELD_VALUES = [
|
|
739
|
+
'tags',
|
|
740
|
+
] as const satisfies ReadonlyArray<DomainListIncludeField>;
|
|
741
|
+
|
|
731
742
|
export const DOMAIN_SORT_FIELD = {
|
|
732
743
|
NAME: "name",
|
|
733
744
|
CREATED_ON: "created_on",
|
package/src/helpers/keys.ts
CHANGED
|
@@ -175,6 +175,7 @@ import type {
|
|
|
175
175
|
DomainRenewRequest,
|
|
176
176
|
DomainRenew,
|
|
177
177
|
DomainRenewalDetails,
|
|
178
|
+
DomainRenewalPrice,
|
|
178
179
|
Domain,
|
|
179
180
|
DomainRestoreRequest,
|
|
180
181
|
DomainRestore,
|
|
@@ -2495,6 +2496,18 @@ export const KEYS_DOMAIN_RENEWAL_DETAILS = [
|
|
|
2495
2496
|
KEY_DOMAIN_RENEWAL_DETAILS_EXPIRES_ON,
|
|
2496
2497
|
] as const satisfies (keyof DomainRenewalDetails)[];
|
|
2497
2498
|
|
|
2499
|
+
export const KEY_DOMAIN_RENEWAL_PRICE_CURRENCY = 'currency' satisfies keyof DomainRenewalPrice;
|
|
2500
|
+
export const KEY_DOMAIN_RENEWAL_PRICE_IS_PREMIUM = 'is_premium' satisfies keyof DomainRenewalPrice;
|
|
2501
|
+
export const KEY_DOMAIN_RENEWAL_PRICE_PERIOD = 'period' satisfies keyof DomainRenewalPrice;
|
|
2502
|
+
export const KEY_DOMAIN_RENEWAL_PRICE_PRICE = 'price' satisfies keyof DomainRenewalPrice;
|
|
2503
|
+
|
|
2504
|
+
export const KEYS_DOMAIN_RENEWAL_PRICE = [
|
|
2505
|
+
KEY_DOMAIN_RENEWAL_PRICE_CURRENCY,
|
|
2506
|
+
KEY_DOMAIN_RENEWAL_PRICE_IS_PREMIUM,
|
|
2507
|
+
KEY_DOMAIN_RENEWAL_PRICE_PERIOD,
|
|
2508
|
+
KEY_DOMAIN_RENEWAL_PRICE_PRICE,
|
|
2509
|
+
] as const satisfies (keyof DomainRenewalPrice)[];
|
|
2510
|
+
|
|
2498
2511
|
export const KEY_DOMAIN_AUTH_CODE = 'auth_code' satisfies keyof Domain;
|
|
2499
2512
|
export const KEY_DOMAIN_AUTH_CODE_EXPIRES_ON = 'auth_code_expires_on' satisfies keyof Domain;
|
|
2500
2513
|
export const KEY_DOMAIN_CANCELED_ON = 'canceled_on' satisfies keyof Domain;
|
|
@@ -2513,6 +2526,7 @@ export const KEY_DOMAIN_REGISTRY_ACCOUNT_ID = 'registry_account_id' satisfies ke
|
|
|
2513
2526
|
export const KEY_DOMAIN_REGISTRY_STATUSES = 'registry_statuses' satisfies keyof Domain;
|
|
2514
2527
|
export const KEY_DOMAIN_RENEWAL_MODE = 'renewal_mode' satisfies keyof Domain;
|
|
2515
2528
|
export const KEY_DOMAIN_RENEWAL_PERIOD = 'renewal_period' satisfies keyof Domain;
|
|
2529
|
+
export const KEY_DOMAIN_RENEWAL_PRICE = 'renewal_price' satisfies keyof Domain;
|
|
2516
2530
|
export const KEY_DOMAIN_ROID = 'roid' satisfies keyof Domain;
|
|
2517
2531
|
export const KEY_DOMAIN_SLD = 'sld' satisfies keyof Domain;
|
|
2518
2532
|
export const KEY_DOMAIN_STATUS_TAGS = 'status_tags' satisfies keyof Domain;
|
|
@@ -2542,6 +2556,7 @@ export const KEYS_DOMAIN = [
|
|
|
2542
2556
|
KEY_DOMAIN_REGISTRY_STATUSES,
|
|
2543
2557
|
KEY_DOMAIN_RENEWAL_MODE,
|
|
2544
2558
|
KEY_DOMAIN_RENEWAL_PERIOD,
|
|
2559
|
+
KEY_DOMAIN_RENEWAL_PRICE,
|
|
2545
2560
|
KEY_DOMAIN_ROID,
|
|
2546
2561
|
KEY_DOMAIN_SLD,
|
|
2547
2562
|
KEY_DOMAIN_STATUS_TAGS,
|
package/src/helpers/schemas.d.ts
CHANGED
|
@@ -209,6 +209,7 @@ export type DomainForwardsContextCreate = components['schemas']['DomainForwardsC
|
|
|
209
209
|
export type DomainHost = components['schemas']['DomainHostResponse'];
|
|
210
210
|
export type DomainIncludeField = components['schemas']['DomainIncludeField'];
|
|
211
211
|
export type DomainLifecycleBase = components['schemas']['DomainLifecycleBase'];
|
|
212
|
+
export type DomainListIncludeField = components['schemas']['DomainListIncludeField'];
|
|
212
213
|
export type DomainNameParts = components['schemas']['DomainNameParts'];
|
|
213
214
|
export type DomainPeriod = components['schemas']['DomainPeriod'];
|
|
214
215
|
export type DomainRecommendationsContext = components['schemas']['DomainRecommendationsContext'];
|
|
@@ -216,6 +217,7 @@ export type DomainRecommendationsContextCreate = components['schemas']['DomainRe
|
|
|
216
217
|
export type DomainRenewRequest = components['schemas']['DomainRenewRequest'];
|
|
217
218
|
export type DomainRenew = components['schemas']['DomainRenewResponse'];
|
|
218
219
|
export type DomainRenewalDetails = components['schemas']['DomainRenewalDetails'];
|
|
220
|
+
export type DomainRenewalPrice = components['schemas']['DomainRenewalPriceResponse'];
|
|
219
221
|
export type Domain = components['schemas']['DomainResponse'];
|
|
220
222
|
export type DomainRestoreRequest = components['schemas']['DomainRestoreRequest'];
|
|
221
223
|
export type DomainRestore = components['schemas']['DomainRestoreResponse'];
|
package/src/openapi.yaml
CHANGED
|
@@ -4990,6 +4990,7 @@ components:
|
|
|
4990
4990
|
DomainIncludeField:
|
|
4991
4991
|
enum:
|
|
4992
4992
|
- tags
|
|
4993
|
+
- renewal_price
|
|
4993
4994
|
title: DomainIncludeField
|
|
4994
4995
|
type: string
|
|
4995
4996
|
DomainLifecycleBase:
|
|
@@ -5126,6 +5127,19 @@ components:
|
|
|
5126
5127
|
- default_transfer_renewal_period
|
|
5127
5128
|
title: DomainLifecycleBase
|
|
5128
5129
|
type: object
|
|
5130
|
+
DomainListIncludeField:
|
|
5131
|
+
description: 'Includes a list endpoint offers.
|
|
5132
|
+
|
|
5133
|
+
|
|
5134
|
+
Deliberately narrower than `DomainIncludeField`: resolving a renewal price
|
|
5135
|
+
|
|
5136
|
+
costs a registry check plus a billing call per premium domain, which a page
|
|
5137
|
+
|
|
5138
|
+
of results would multiply into a registry rate-limit problem.'
|
|
5139
|
+
enum:
|
|
5140
|
+
- tags
|
|
5141
|
+
title: DomainListIncludeField
|
|
5142
|
+
type: string
|
|
5129
5143
|
DomainNameParts:
|
|
5130
5144
|
properties:
|
|
5131
5145
|
domain:
|
|
@@ -5284,6 +5298,37 @@ components:
|
|
|
5284
5298
|
- expires_on
|
|
5285
5299
|
title: DomainRenewalDetails
|
|
5286
5300
|
type: object
|
|
5301
|
+
DomainRenewalPriceResponse:
|
|
5302
|
+
properties:
|
|
5303
|
+
currency:
|
|
5304
|
+
description: ISO 4217 currency code
|
|
5305
|
+
examples:
|
|
5306
|
+
- EUR
|
|
5307
|
+
title: Currency
|
|
5308
|
+
type: string
|
|
5309
|
+
is_premium:
|
|
5310
|
+
description: True when the price came from the registry's premium classification
|
|
5311
|
+
for renew rather than from the organization's standard TLD pricing
|
|
5312
|
+
title: Is Premium
|
|
5313
|
+
type: boolean
|
|
5314
|
+
period:
|
|
5315
|
+
$ref: '#/components/schemas/DomainPeriod'
|
|
5316
|
+
description: Period the price covers
|
|
5317
|
+
price:
|
|
5318
|
+
description: Renewal price for the period below, in the organization's billing
|
|
5319
|
+
currency, taxes excluded
|
|
5320
|
+
examples:
|
|
5321
|
+
- '43.50'
|
|
5322
|
+
pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
|
|
5323
|
+
title: Price
|
|
5324
|
+
type: string
|
|
5325
|
+
required:
|
|
5326
|
+
- price
|
|
5327
|
+
- currency
|
|
5328
|
+
- period
|
|
5329
|
+
- is_premium
|
|
5330
|
+
title: DomainRenewalPriceResponse
|
|
5331
|
+
type: object
|
|
5287
5332
|
DomainResponse:
|
|
5288
5333
|
properties:
|
|
5289
5334
|
auth_code:
|
|
@@ -5349,7 +5394,12 @@ components:
|
|
|
5349
5394
|
type: array
|
|
5350
5395
|
is_premium:
|
|
5351
5396
|
default: false
|
|
5352
|
-
description: Whether this
|
|
5397
|
+
description: 'Whether the registry prices this domain at a premium class
|
|
5398
|
+
for the action it was bought under. Not purchase provenance: a renewal-time
|
|
5399
|
+
check that affirmatively quotes renew as standard corrects the flag, so
|
|
5400
|
+
it tracks the registry''s current classification. Registries classify
|
|
5401
|
+
each action separately, so a domain premium only to restore is not premium
|
|
5402
|
+
here.'
|
|
5353
5403
|
title: Is Premium
|
|
5354
5404
|
type: boolean
|
|
5355
5405
|
name:
|
|
@@ -5407,6 +5457,12 @@ components:
|
|
|
5407
5457
|
'P1M', 'P1Y'). Null when the domain is not set to renew (renewal mode
|
|
5408
5458
|
'expire') or has no active subscription.
|
|
5409
5459
|
title: Renewal Period
|
|
5460
|
+
renewal_price:
|
|
5461
|
+
anyOf:
|
|
5462
|
+
- $ref: '#/components/schemas/DomainRenewalPriceResponse'
|
|
5463
|
+
- type: 'null'
|
|
5464
|
+
description: Price this organization pays to renew this domain for one year.
|
|
5465
|
+
Only included when ?include=renewal_price is specified.
|
|
5410
5466
|
roid:
|
|
5411
5467
|
description: The registry object id of the domain
|
|
5412
5468
|
examples:
|
|
@@ -15050,7 +15106,7 @@ info:
|
|
|
15050
15106
|
\n\n"
|
|
15051
15107
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
15052
15108
|
title: OpusDNS API
|
|
15053
|
-
version: 2026-08-07-
|
|
15109
|
+
version: 2026-08-07-221736
|
|
15054
15110
|
x-logo:
|
|
15055
15111
|
altText: OpusDNS API Reference
|
|
15056
15112
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -22977,7 +23033,7 @@ paths:
|
|
|
22977
23033
|
schema:
|
|
22978
23034
|
anyOf:
|
|
22979
23035
|
- items:
|
|
22980
|
-
$ref: '#/components/schemas/
|
|
23036
|
+
$ref: '#/components/schemas/DomainListIncludeField'
|
|
22981
23037
|
type: array
|
|
22982
23038
|
- type: 'null'
|
|
22983
23039
|
description: Include additional data in the response. Can be specified multiple
|
package/src/schema.d.ts
CHANGED
|
@@ -6160,7 +6160,7 @@ export interface components {
|
|
|
6160
6160
|
* DomainIncludeField
|
|
6161
6161
|
* @enum {string}
|
|
6162
6162
|
*/
|
|
6163
|
-
DomainIncludeField: "tags";
|
|
6163
|
+
DomainIncludeField: "tags" | "renewal_price";
|
|
6164
6164
|
/** DomainLifecycleBase */
|
|
6165
6165
|
DomainLifecycleBase: {
|
|
6166
6166
|
/**
|
|
@@ -6231,6 +6231,16 @@ export interface components {
|
|
|
6231
6231
|
/** @description List of allowed transfer renewal periods (eg. '1y') */
|
|
6232
6232
|
transfer_renewal_periods?: components["schemas"]["PeriodList"];
|
|
6233
6233
|
};
|
|
6234
|
+
/**
|
|
6235
|
+
* DomainListIncludeField
|
|
6236
|
+
* @description Includes a list endpoint offers.
|
|
6237
|
+
*
|
|
6238
|
+
* Deliberately narrower than `DomainIncludeField`: resolving a renewal price
|
|
6239
|
+
* costs a registry check plus a billing call per premium domain, which a page
|
|
6240
|
+
* of results would multiply into a registry rate-limit problem.
|
|
6241
|
+
* @enum {string}
|
|
6242
|
+
*/
|
|
6243
|
+
DomainListIncludeField: "tags";
|
|
6234
6244
|
/** DomainNameParts */
|
|
6235
6245
|
DomainNameParts: {
|
|
6236
6246
|
/**
|
|
@@ -6347,6 +6357,28 @@ export interface components {
|
|
|
6347
6357
|
*/
|
|
6348
6358
|
expires_on: Date;
|
|
6349
6359
|
};
|
|
6360
|
+
/** DomainRenewalPriceResponse */
|
|
6361
|
+
DomainRenewalPriceResponse: {
|
|
6362
|
+
/**
|
|
6363
|
+
* Currency
|
|
6364
|
+
* @description ISO 4217 currency code
|
|
6365
|
+
* @example EUR
|
|
6366
|
+
*/
|
|
6367
|
+
currency: string;
|
|
6368
|
+
/**
|
|
6369
|
+
* Is Premium
|
|
6370
|
+
* @description True when the price came from the registry's premium classification for renew rather than from the organization's standard TLD pricing
|
|
6371
|
+
*/
|
|
6372
|
+
is_premium: boolean;
|
|
6373
|
+
/** @description Period the price covers */
|
|
6374
|
+
period: components["schemas"]["DomainPeriod"];
|
|
6375
|
+
/**
|
|
6376
|
+
* Price
|
|
6377
|
+
* @description Renewal price for the period below, in the organization's billing currency, taxes excluded
|
|
6378
|
+
* @example 43.50
|
|
6379
|
+
*/
|
|
6380
|
+
price: string;
|
|
6381
|
+
};
|
|
6350
6382
|
/** DomainResponse */
|
|
6351
6383
|
DomainResponse: {
|
|
6352
6384
|
/**
|
|
@@ -6398,7 +6430,7 @@ export interface components {
|
|
|
6398
6430
|
hosts?: components["schemas"]["DomainHostResponse"][];
|
|
6399
6431
|
/**
|
|
6400
6432
|
* Is Premium
|
|
6401
|
-
* @description Whether this
|
|
6433
|
+
* @description Whether the registry prices this domain at a premium class for the action it was bought under. Not purchase provenance: a renewal-time check that affirmatively quotes renew as standard corrects the flag, so it tracks the registry's current classification. Registries classify each action separately, so a domain premium only to restore is not premium here.
|
|
6402
6434
|
* @default false
|
|
6403
6435
|
*/
|
|
6404
6436
|
is_premium: boolean;
|
|
@@ -6445,6 +6477,8 @@ export interface components {
|
|
|
6445
6477
|
* @description Renewal period of the domain as an ISO 8601 duration (e.g. 'P1M', 'P1Y'). Null when the domain is not set to renew (renewal mode 'expire') or has no active subscription.
|
|
6446
6478
|
*/
|
|
6447
6479
|
renewal_period?: string | null;
|
|
6480
|
+
/** @description Price this organization pays to renew this domain for one year. Only included when ?include=renewal_price is specified. */
|
|
6481
|
+
renewal_price?: components["schemas"]["DomainRenewalPriceResponse"] | null;
|
|
6448
6482
|
/**
|
|
6449
6483
|
* Roid
|
|
6450
6484
|
* @description The registry object id of the domain
|
|
@@ -18778,7 +18812,7 @@ export interface operations {
|
|
|
18778
18812
|
/** @description Filter domains by registry status. Can be specified multiple times (union of all provided values). */
|
|
18779
18813
|
registry_statuses?: string[] | null;
|
|
18780
18814
|
/** @description Include additional data in the response. Can be specified multiple times. */
|
|
18781
|
-
include?: components["schemas"]["
|
|
18815
|
+
include?: components["schemas"]["DomainListIncludeField"][] | null;
|
|
18782
18816
|
};
|
|
18783
18817
|
header?: {
|
|
18784
18818
|
/**
|