@opusdns/api 1.223.0 → 1.225.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 +2 -0
- package/src/helpers/keys.ts +29 -0
- package/src/helpers/schemas.d.ts +1 -0
- package/src/openapi.yaml +103 -6
- package/src/schema.d.ts +523 -231
package/package.json
CHANGED
package/src/helpers/constants.ts
CHANGED
|
@@ -838,12 +838,14 @@ export const DOMAIN_INCLUDE_FIELD = {
|
|
|
838
838
|
TAGS: "tags",
|
|
839
839
|
RENEWAL_PRICE: "renewal_price",
|
|
840
840
|
CONNECTED_ACCOUNT: "connected_account",
|
|
841
|
+
REGISTRANT_CHANGE: "registrant_change",
|
|
841
842
|
} as const satisfies Record<string, DomainIncludeField>;
|
|
842
843
|
|
|
843
844
|
export const DOMAIN_INCLUDE_FIELD_VALUES = [
|
|
844
845
|
'tags',
|
|
845
846
|
'renewal_price',
|
|
846
847
|
'connected_account',
|
|
848
|
+
'registrant_change',
|
|
847
849
|
] as const satisfies ReadonlyArray<DomainIncludeField>;
|
|
848
850
|
|
|
849
851
|
export const DOMAIN_LIST_INCLUDE_FIELD = {
|
package/src/helpers/keys.ts
CHANGED
|
@@ -193,6 +193,7 @@ import type {
|
|
|
193
193
|
DomainPeriod,
|
|
194
194
|
DomainRecommendationsContext,
|
|
195
195
|
DomainRecommendationsContextCreate,
|
|
196
|
+
DomainRegistrantChange,
|
|
196
197
|
DomainRegistrarCredential,
|
|
197
198
|
DomainRenewRequest,
|
|
198
199
|
DomainRenew,
|
|
@@ -2787,6 +2788,32 @@ export const KEYS_DOMAIN_RECOMMENDATIONS_CONTEXT_CREATE = [
|
|
|
2787
2788
|
KEY_DOMAIN_RECOMMENDATIONS_CONTEXT_CREATE_PAYLOAD,
|
|
2788
2789
|
] as const satisfies (keyof DomainRecommendationsContextCreate)[];
|
|
2789
2790
|
|
|
2791
|
+
export const KEY_DOMAIN_REGISTRANT_CHANGE_CONFIRMATION_DEADLINE = 'confirmation_deadline' satisfies keyof DomainRegistrantChange;
|
|
2792
|
+
export const KEY_DOMAIN_REGISTRANT_CHANGE_CONFIRMATION_METHOD = 'confirmation_method' satisfies keyof DomainRegistrantChange;
|
|
2793
|
+
export const KEY_DOMAIN_REGISTRANT_CHANGE_CREATED_ON = 'created_on' satisfies keyof DomainRegistrantChange;
|
|
2794
|
+
export const KEY_DOMAIN_REGISTRANT_CHANGE_DOMAIN_ID = 'domain_id' satisfies keyof DomainRegistrantChange;
|
|
2795
|
+
export const KEY_DOMAIN_REGISTRANT_CHANGE_FAILURE_REASON = 'failure_reason' satisfies keyof DomainRegistrantChange;
|
|
2796
|
+
export const KEY_DOMAIN_REGISTRANT_CHANGE_MATERIAL = 'material' satisfies keyof DomainRegistrantChange;
|
|
2797
|
+
export const KEY_DOMAIN_REGISTRANT_CHANGE_NEW_REGISTRANT = 'new_registrant' satisfies keyof DomainRegistrantChange;
|
|
2798
|
+
export const KEY_DOMAIN_REGISTRANT_CHANGE_PREVIOUS_REGISTRANT = 'previous_registrant' satisfies keyof DomainRegistrantChange;
|
|
2799
|
+
export const KEY_DOMAIN_REGISTRANT_CHANGE_REGISTRANT_CHANGE_ID = 'registrant_change_id' satisfies keyof DomainRegistrantChange;
|
|
2800
|
+
export const KEY_DOMAIN_REGISTRANT_CHANGE_STATUS = 'status' satisfies keyof DomainRegistrantChange;
|
|
2801
|
+
export const KEY_DOMAIN_REGISTRANT_CHANGE_TRANSFER_LOCK_OPT_OUT = 'transfer_lock_opt_out' satisfies keyof DomainRegistrantChange;
|
|
2802
|
+
|
|
2803
|
+
export const KEYS_DOMAIN_REGISTRANT_CHANGE = [
|
|
2804
|
+
KEY_DOMAIN_REGISTRANT_CHANGE_CONFIRMATION_DEADLINE,
|
|
2805
|
+
KEY_DOMAIN_REGISTRANT_CHANGE_CONFIRMATION_METHOD,
|
|
2806
|
+
KEY_DOMAIN_REGISTRANT_CHANGE_CREATED_ON,
|
|
2807
|
+
KEY_DOMAIN_REGISTRANT_CHANGE_DOMAIN_ID,
|
|
2808
|
+
KEY_DOMAIN_REGISTRANT_CHANGE_FAILURE_REASON,
|
|
2809
|
+
KEY_DOMAIN_REGISTRANT_CHANGE_MATERIAL,
|
|
2810
|
+
KEY_DOMAIN_REGISTRANT_CHANGE_NEW_REGISTRANT,
|
|
2811
|
+
KEY_DOMAIN_REGISTRANT_CHANGE_PREVIOUS_REGISTRANT,
|
|
2812
|
+
KEY_DOMAIN_REGISTRANT_CHANGE_REGISTRANT_CHANGE_ID,
|
|
2813
|
+
KEY_DOMAIN_REGISTRANT_CHANGE_STATUS,
|
|
2814
|
+
KEY_DOMAIN_REGISTRANT_CHANGE_TRANSFER_LOCK_OPT_OUT,
|
|
2815
|
+
] as const satisfies (keyof DomainRegistrantChange)[];
|
|
2816
|
+
|
|
2790
2817
|
export const KEY_DOMAIN_REGISTRAR_CREDENTIAL_NAME = 'name' satisfies keyof DomainRegistrarCredential;
|
|
2791
2818
|
export const KEY_DOMAIN_REGISTRAR_CREDENTIAL_REGISTRAR = 'registrar' satisfies keyof DomainRegistrarCredential;
|
|
2792
2819
|
export const KEY_DOMAIN_REGISTRAR_CREDENTIAL_REGISTRAR_CREDENTIAL_ID = 'registrar_credential_id' satisfies keyof DomainRegistrarCredential;
|
|
@@ -2865,6 +2892,7 @@ export const KEY_DOMAIN_NAMESERVERS = 'nameservers' satisfies keyof Domain;
|
|
|
2865
2892
|
export const KEY_DOMAIN_OWNER_ID = 'owner_id' satisfies keyof Domain;
|
|
2866
2893
|
export const KEY_DOMAIN_READ_ONLY = 'read_only' satisfies keyof Domain;
|
|
2867
2894
|
export const KEY_DOMAIN_REGISTERED_ON = 'registered_on' satisfies keyof Domain;
|
|
2895
|
+
export const KEY_DOMAIN_REGISTRANT_CHANGE = 'registrant_change' satisfies keyof Domain;
|
|
2868
2896
|
export const KEY_DOMAIN_REGISTRY_ACCOUNT_ID = 'registry_account_id' satisfies keyof Domain;
|
|
2869
2897
|
export const KEY_DOMAIN_REGISTRY_STATUSES = 'registry_statuses' satisfies keyof Domain;
|
|
2870
2898
|
export const KEY_DOMAIN_RENEWAL_MODE = 'renewal_mode' satisfies keyof Domain;
|
|
@@ -2897,6 +2925,7 @@ export const KEYS_DOMAIN = [
|
|
|
2897
2925
|
KEY_DOMAIN_OWNER_ID,
|
|
2898
2926
|
KEY_DOMAIN_READ_ONLY,
|
|
2899
2927
|
KEY_DOMAIN_REGISTERED_ON,
|
|
2928
|
+
KEY_DOMAIN_REGISTRANT_CHANGE,
|
|
2900
2929
|
KEY_DOMAIN_REGISTRY_ACCOUNT_ID,
|
|
2901
2930
|
KEY_DOMAIN_REGISTRY_STATUSES,
|
|
2902
2931
|
KEY_DOMAIN_RENEWAL_MODE,
|
package/src/helpers/schemas.d.ts
CHANGED
|
@@ -243,6 +243,7 @@ export type DomainNameParts = components['schemas']['DomainNameParts'];
|
|
|
243
243
|
export type DomainPeriod = components['schemas']['DomainPeriod'];
|
|
244
244
|
export type DomainRecommendationsContext = components['schemas']['DomainRecommendationsContext'];
|
|
245
245
|
export type DomainRecommendationsContextCreate = components['schemas']['DomainRecommendationsContextCreate'];
|
|
246
|
+
export type DomainRegistrantChange = components['schemas']['DomainRegistrantChangeResponse'];
|
|
246
247
|
export type DomainRegistrarCredential = components['schemas']['DomainRegistrarCredentialResponse'];
|
|
247
248
|
export type DomainRenewRequest = components['schemas']['DomainRenewRequest'];
|
|
248
249
|
export type DomainRenew = components['schemas']['DomainRenewResponse'];
|
package/src/openapi.yaml
CHANGED
|
@@ -1,9 +1,10 @@
|
|
|
1
1
|
components:
|
|
2
2
|
parameters:
|
|
3
3
|
DatetimeFormatHeader:
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
4
|
+
deprecated: true
|
|
5
|
+
description: 'Deprecated: has no effect and will be removed from this specification
|
|
6
|
+
on 2026-11-12; the API keeps ignoring it if sent. Response datetimes are always
|
|
7
|
+
normalized to UTC and serialized as RFC 3339 with a `Z` suffix.'
|
|
7
8
|
example: rfc3339
|
|
8
9
|
in: header
|
|
9
10
|
name: X-Datetime-Format
|
|
@@ -12980,6 +12981,7 @@ components:
|
|
|
12980
12981
|
- tags
|
|
12981
12982
|
- renewal_price
|
|
12982
12983
|
- connected_account
|
|
12984
|
+
- registrant_change
|
|
12983
12985
|
title: DomainIncludeField
|
|
12984
12986
|
type: string
|
|
12985
12987
|
DomainLifecycleBase:
|
|
@@ -13246,6 +13248,92 @@ components:
|
|
|
13246
13248
|
- payload
|
|
13247
13249
|
title: DomainRecommendationsContextCreate
|
|
13248
13250
|
type: object
|
|
13251
|
+
DomainRegistrantChangeResponse:
|
|
13252
|
+
properties:
|
|
13253
|
+
confirmation_deadline:
|
|
13254
|
+
anyOf:
|
|
13255
|
+
- format: date-time
|
|
13256
|
+
type: string
|
|
13257
|
+
- type: 'null'
|
|
13258
|
+
description: When the request expires if not confirmed
|
|
13259
|
+
title: Confirmation Deadline
|
|
13260
|
+
confirmation_method:
|
|
13261
|
+
anyOf:
|
|
13262
|
+
- $ref: '#/components/schemas/RegistrantChangeConfirmationMethod'
|
|
13263
|
+
- type: 'null'
|
|
13264
|
+
description: How the change was confirmed, null when no confirmation applies
|
|
13265
|
+
created_on:
|
|
13266
|
+
description: When the request was created
|
|
13267
|
+
format: date-time
|
|
13268
|
+
title: Created On
|
|
13269
|
+
type: string
|
|
13270
|
+
domain_id:
|
|
13271
|
+
description: The ID of the domain
|
|
13272
|
+
examples:
|
|
13273
|
+
- domain_01h45ytscbebyvny4gc8cr8ma2
|
|
13274
|
+
format: typeid
|
|
13275
|
+
pattern: ^domain_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
13276
|
+
title: Domain Id
|
|
13277
|
+
type: string
|
|
13278
|
+
x-typeid-prefix: domain
|
|
13279
|
+
failure_reason:
|
|
13280
|
+
anyOf:
|
|
13281
|
+
- type: string
|
|
13282
|
+
- type: 'null'
|
|
13283
|
+
description: Why the registrant change failed
|
|
13284
|
+
title: Failure Reason
|
|
13285
|
+
material:
|
|
13286
|
+
description: Whether the name, organization or email of the registrant changes
|
|
13287
|
+
title: Material
|
|
13288
|
+
type: boolean
|
|
13289
|
+
new_registrant:
|
|
13290
|
+
description: The registrant after the change
|
|
13291
|
+
examples:
|
|
13292
|
+
- contact_01h45ytscbebyvny4gc8cr8ma2
|
|
13293
|
+
format: typeid
|
|
13294
|
+
pattern: ^contact_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
13295
|
+
title: New Registrant
|
|
13296
|
+
type: string
|
|
13297
|
+
x-typeid-prefix: contact
|
|
13298
|
+
previous_registrant:
|
|
13299
|
+
description: The registrant before the change
|
|
13300
|
+
examples:
|
|
13301
|
+
- contact_01h45ytscbebyvny4gc8cr8ma2
|
|
13302
|
+
format: typeid
|
|
13303
|
+
pattern: ^contact_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
13304
|
+
title: Previous Registrant
|
|
13305
|
+
type: string
|
|
13306
|
+
x-typeid-prefix: contact
|
|
13307
|
+
registrant_change_id:
|
|
13308
|
+
description: The ID of the registrant change
|
|
13309
|
+
examples:
|
|
13310
|
+
- registrant_change_01h45ytscbebyvny4gc8cr8ma2
|
|
13311
|
+
format: typeid
|
|
13312
|
+
pattern: ^registrant_change_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
13313
|
+
title: Registrant Change Id
|
|
13314
|
+
type: string
|
|
13315
|
+
x-typeid-prefix: registrant_change
|
|
13316
|
+
status:
|
|
13317
|
+
$ref: '#/components/schemas/RegistrantChangeStatus'
|
|
13318
|
+
description: The status of the registrant change
|
|
13319
|
+
transfer_lock_opt_out:
|
|
13320
|
+
description: Whether the transfer lock after the change was opted out of
|
|
13321
|
+
title: Transfer Lock Opt Out
|
|
13322
|
+
type: boolean
|
|
13323
|
+
required:
|
|
13324
|
+
- registrant_change_id
|
|
13325
|
+
- domain_id
|
|
13326
|
+
- status
|
|
13327
|
+
- material
|
|
13328
|
+
- previous_registrant
|
|
13329
|
+
- new_registrant
|
|
13330
|
+
- confirmation_method
|
|
13331
|
+
- transfer_lock_opt_out
|
|
13332
|
+
- confirmation_deadline
|
|
13333
|
+
- failure_reason
|
|
13334
|
+
- created_on
|
|
13335
|
+
title: DomainRegistrantChangeResponse
|
|
13336
|
+
type: object
|
|
13249
13337
|
DomainRegistrarCredentialResponse:
|
|
13250
13338
|
properties:
|
|
13251
13339
|
name:
|
|
@@ -13511,6 +13599,12 @@ components:
|
|
|
13511
13599
|
- type: 'null'
|
|
13512
13600
|
description: When the domain was registered
|
|
13513
13601
|
title: Registered On
|
|
13602
|
+
registrant_change:
|
|
13603
|
+
anyOf:
|
|
13604
|
+
- $ref: '#/components/schemas/DomainRegistrantChangeResponse'
|
|
13605
|
+
- type: 'null'
|
|
13606
|
+
description: The change of registrant in progress. Null unless `include=registrant_change`
|
|
13607
|
+
is requested, and null even then when no change of registrant is in progress.
|
|
13514
13608
|
registry_account_id:
|
|
13515
13609
|
default: None
|
|
13516
13610
|
examples:
|
|
@@ -24978,7 +25072,7 @@ info:
|
|
|
24978
25072
|
\n\n"
|
|
24979
25073
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
24980
25074
|
title: OpusDNS API
|
|
24981
|
-
version: 2026-10-13-
|
|
25075
|
+
version: 2026-10-13-190828
|
|
24982
25076
|
x-logo:
|
|
24983
25077
|
altText: OpusDNS API Reference
|
|
24984
25078
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -35447,7 +35541,8 @@ paths:
|
|
|
35447
35541
|
- description: Extra data to include in the response. `tags` populates the `tags`
|
|
35448
35542
|
and `status_tags` fields, which are otherwise null. `renewal_price` resolves
|
|
35449
35543
|
the domain's renewal price. `connected_account` populates the `connected_account`
|
|
35450
|
-
field for domains held at an external registrar.
|
|
35544
|
+
field for domains held at an external registrar. `registrant_change` populates
|
|
35545
|
+
the `registrant_change` field with the change of registrant in progress.
|
|
35451
35546
|
in: query
|
|
35452
35547
|
name: include
|
|
35453
35548
|
required: false
|
|
@@ -35460,7 +35555,9 @@ paths:
|
|
|
35460
35555
|
description: Extra data to include in the response. `tags` populates the
|
|
35461
35556
|
`tags` and `status_tags` fields, which are otherwise null. `renewal_price`
|
|
35462
35557
|
resolves the domain's renewal price. `connected_account` populates the
|
|
35463
|
-
`connected_account` field for domains held at an external registrar.
|
|
35558
|
+
`connected_account` field for domains held at an external registrar. `registrant_change`
|
|
35559
|
+
populates the `registrant_change` field with the change of registrant
|
|
35560
|
+
in progress.
|
|
35464
35561
|
title: Include
|
|
35465
35562
|
- $ref: '#/components/parameters/DatetimeFormatHeader'
|
|
35466
35563
|
responses:
|