@opusdns/api 1.227.0 → 1.229.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/keys.ts +13 -0
- package/src/helpers/schemas.d.ts +1 -0
- package/src/openapi.yaml +50 -10
- package/src/schema.d.ts +23 -4
package/package.json
CHANGED
package/src/helpers/keys.ts
CHANGED
|
@@ -131,6 +131,7 @@ import type {
|
|
|
131
131
|
DnsZoneUpdatePayloadData,
|
|
132
132
|
DnsZoneUpdateWorkerPayload,
|
|
133
133
|
DnsZoneVanitySetUpdateRes,
|
|
134
|
+
DomainAmsAccount,
|
|
134
135
|
DomainAuthCode,
|
|
135
136
|
DomainAvailability,
|
|
136
137
|
DomainAvailabilityError,
|
|
@@ -2109,6 +2110,16 @@ export const KEYS_DNS_ZONE_VANITY_SET_UPDATE_RES = [
|
|
|
2109
2110
|
KEY_DNS_ZONE_VANITY_SET_UPDATE_RES_ZONE,
|
|
2110
2111
|
] as const satisfies (keyof DnsZoneVanitySetUpdateRes)[];
|
|
2111
2112
|
|
|
2113
|
+
export const KEY_DOMAIN_AMS_ACCOUNT_REGISTRY = 'registry' satisfies keyof DomainAmsAccount;
|
|
2114
|
+
export const KEY_DOMAIN_AMS_ACCOUNT_REGISTRY_ACCOUNT_ID = 'registry_account_id' satisfies keyof DomainAmsAccount;
|
|
2115
|
+
export const KEY_DOMAIN_AMS_ACCOUNT_TYPE = 'type' satisfies keyof DomainAmsAccount;
|
|
2116
|
+
|
|
2117
|
+
export const KEYS_DOMAIN_AMS_ACCOUNT = [
|
|
2118
|
+
KEY_DOMAIN_AMS_ACCOUNT_REGISTRY,
|
|
2119
|
+
KEY_DOMAIN_AMS_ACCOUNT_REGISTRY_ACCOUNT_ID,
|
|
2120
|
+
KEY_DOMAIN_AMS_ACCOUNT_TYPE,
|
|
2121
|
+
] as const satisfies (keyof DomainAmsAccount)[];
|
|
2122
|
+
|
|
2112
2123
|
export const KEY_DOMAIN_AUTH_CODE_AUTH_CODE = 'auth_code' satisfies keyof DomainAuthCode;
|
|
2113
2124
|
export const KEY_DOMAIN_AUTH_CODE_AUTH_CODE_EXPIRES_ON = 'auth_code_expires_on' satisfies keyof DomainAuthCode;
|
|
2114
2125
|
export const KEY_DOMAIN_AUTH_CODE_DELIVERY = 'delivery' satisfies keyof DomainAuthCode;
|
|
@@ -2990,6 +3001,7 @@ export const KEYS_DOMAIN_SEARCH_SUGGESTION_PRICE_DATA = [
|
|
|
2990
3001
|
] as const satisfies (keyof DomainSearchSuggestionPriceData)[];
|
|
2991
3002
|
|
|
2992
3003
|
export const KEY_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE_AVAILABLE = 'available' satisfies keyof DomainSearchSuggestionWithPrice;
|
|
3004
|
+
export const KEY_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE_CONNECTED_ACCOUNT = 'connected_account' satisfies keyof DomainSearchSuggestionWithPrice;
|
|
2993
3005
|
export const KEY_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE_DOMAIN = 'domain' satisfies keyof DomainSearchSuggestionWithPrice;
|
|
2994
3006
|
export const KEY_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE_PREMIUM = 'premium' satisfies keyof DomainSearchSuggestionWithPrice;
|
|
2995
3007
|
export const KEY_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE_PRICE = 'price' satisfies keyof DomainSearchSuggestionWithPrice;
|
|
@@ -2997,6 +3009,7 @@ export const KEY_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE_RENEWAL_PRICE = 'renewal_pr
|
|
|
2997
3009
|
|
|
2998
3010
|
export const KEYS_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE = [
|
|
2999
3011
|
KEY_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE_AVAILABLE,
|
|
3012
|
+
KEY_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE_CONNECTED_ACCOUNT,
|
|
3000
3013
|
KEY_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE_DOMAIN,
|
|
3001
3014
|
KEY_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE_PREMIUM,
|
|
3002
3015
|
KEY_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE_PRICE,
|
package/src/helpers/schemas.d.ts
CHANGED
|
@@ -172,6 +172,7 @@ export type DnssecModeType = components['schemas']['DnssecModeType'];
|
|
|
172
172
|
export type DnssecRecordType = components['schemas']['DnssecRecordType'];
|
|
173
173
|
export type DnssecRegistryPublishOutcome = components['schemas']['DnssecRegistryPublishOutcome'];
|
|
174
174
|
export type DnssecStatus = components['schemas']['DnssecStatus'];
|
|
175
|
+
export type DomainAmsAccount = components['schemas']['DomainAmsAccountResponse'];
|
|
175
176
|
export type DomainAttributeKey = components['schemas']['DomainAttributeKey'];
|
|
176
177
|
export type DomainAuthCode = components['schemas']['DomainAuthCodeResponse'];
|
|
177
178
|
export type DomainAvailability = components['schemas']['DomainAvailability'];
|
package/src/openapi.yaml
CHANGED
|
@@ -11410,6 +11410,32 @@ components:
|
|
|
11410
11410
|
- disabled
|
|
11411
11411
|
title: DnssecStatus
|
|
11412
11412
|
type: string
|
|
11413
|
+
DomainAmsAccountResponse:
|
|
11414
|
+
properties:
|
|
11415
|
+
registry:
|
|
11416
|
+
$ref: '#/components/schemas/RegistryServiceBackend'
|
|
11417
|
+
description: The registry the account is accredited at
|
|
11418
|
+
registry_account_id:
|
|
11419
|
+
description: The registry account the domain is held on
|
|
11420
|
+
examples:
|
|
11421
|
+
- registry_account_01h45ytscbebyvny4gc8cr8ma2
|
|
11422
|
+
format: typeid
|
|
11423
|
+
pattern: ^registry_account_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
11424
|
+
title: Registry Account Id
|
|
11425
|
+
type: string
|
|
11426
|
+
x-typeid-prefix: registry_account
|
|
11427
|
+
type:
|
|
11428
|
+
const: ams
|
|
11429
|
+
description: 'Kind of connected account. `ams`: the organization''s own
|
|
11430
|
+
registry accreditation, on which OpusDNS manages the domain.'
|
|
11431
|
+
title: Type
|
|
11432
|
+
type: string
|
|
11433
|
+
required:
|
|
11434
|
+
- type
|
|
11435
|
+
- registry_account_id
|
|
11436
|
+
- registry
|
|
11437
|
+
title: DomainAmsAccountResponse
|
|
11438
|
+
type: object
|
|
11413
11439
|
DomainAttributeKey:
|
|
11414
11440
|
enum:
|
|
11415
11441
|
- auto_renew_period
|
|
@@ -13502,15 +13528,18 @@ components:
|
|
|
13502
13528
|
anyOf:
|
|
13503
13529
|
- discriminator:
|
|
13504
13530
|
mapping:
|
|
13531
|
+
ams: '#/components/schemas/DomainAmsAccountResponse'
|
|
13505
13532
|
ras: '#/components/schemas/DomainRegistrarCredentialResponse'
|
|
13506
13533
|
propertyName: type
|
|
13507
13534
|
oneOf:
|
|
13508
13535
|
- $ref: '#/components/schemas/DomainRegistrarCredentialResponse'
|
|
13536
|
+
- $ref: '#/components/schemas/DomainAmsAccountResponse'
|
|
13509
13537
|
- type: 'null'
|
|
13510
|
-
description: The connected account this domain is synced from
|
|
13511
|
-
|
|
13512
|
-
|
|
13513
|
-
and
|
|
13538
|
+
description: 'The connected account this domain is synced from or managed
|
|
13539
|
+
on: a registrar credential (`ras`) or the organization''s own registry
|
|
13540
|
+
accreditation (`ams`). Null unless `include=connected_account` is requested,
|
|
13541
|
+
and null even then for natively registered domains, for domains on operator-managed
|
|
13542
|
+
registry accounts, and when the connected account was deleted.'
|
|
13514
13543
|
title: Connected Account
|
|
13515
13544
|
contacts:
|
|
13516
13545
|
description: The contacts of the domain
|
|
@@ -13806,6 +13835,14 @@ components:
|
|
|
13806
13835
|
available:
|
|
13807
13836
|
title: Available
|
|
13808
13837
|
type: boolean
|
|
13838
|
+
connected_account:
|
|
13839
|
+
anyOf:
|
|
13840
|
+
- $ref: '#/components/schemas/DomainAmsAccountResponse'
|
|
13841
|
+
- type: 'null'
|
|
13842
|
+
description: Set when the organization registers this TLD on its own registry
|
|
13843
|
+
accreditation (`ams`). The registry bills the domain to that accreditation,
|
|
13844
|
+
so `price` and `renewal_price` are the OpusDNS service fee alone, premium
|
|
13845
|
+
or not. Null for TLDs registered on OpusDNS registry accounts.
|
|
13809
13846
|
domain:
|
|
13810
13847
|
title: Domain
|
|
13811
13848
|
type: string
|
|
@@ -25106,7 +25143,7 @@ info:
|
|
|
25106
25143
|
\n\n"
|
|
25107
25144
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
25108
25145
|
title: OpusDNS API
|
|
25109
|
-
version: 2026-10-15-
|
|
25146
|
+
version: 2026-10-15-190237
|
|
25110
25147
|
x-logo:
|
|
25111
25148
|
altText: OpusDNS API Reference
|
|
25112
25149
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -33800,7 +33837,7 @@ paths:
|
|
|
33800
33837
|
(user tags) and `status_tags` fields, which are otherwise null; filtering
|
|
33801
33838
|
by `tag_ids` or `status_tags` alone does not populate them. `connected_account`
|
|
33802
33839
|
populates the `connected_account` field for domains held at an external
|
|
33803
|
-
registrar.
|
|
33840
|
+
registrar or on the organization's own registry accreditation (AMS).
|
|
33804
33841
|
in: query
|
|
33805
33842
|
name: include
|
|
33806
33843
|
required: false
|
|
@@ -33814,7 +33851,8 @@ paths:
|
|
|
33814
33851
|
`tags` (user tags) and `status_tags` fields, which are otherwise null;
|
|
33815
33852
|
filtering by `tag_ids` or `status_tags` alone does not populate them.
|
|
33816
33853
|
`connected_account` populates the `connected_account` field for domains
|
|
33817
|
-
held at an external registrar
|
|
33854
|
+
held at an external registrar or on the organization's own registry accreditation
|
|
33855
|
+
(AMS).
|
|
33818
33856
|
title: Include
|
|
33819
33857
|
- $ref: '#/components/parameters/DatetimeFormatHeader'
|
|
33820
33858
|
responses:
|
|
@@ -35575,8 +35613,9 @@ paths:
|
|
|
35575
35613
|
- description: Extra data to include in the response. `tags` populates the `tags`
|
|
35576
35614
|
and `status_tags` fields, which are otherwise null. `renewal_price` resolves
|
|
35577
35615
|
the domain's renewal price. `connected_account` populates the `connected_account`
|
|
35578
|
-
field for domains held at an external registrar
|
|
35579
|
-
|
|
35616
|
+
field for domains held at an external registrar or on the organization's
|
|
35617
|
+
own registry accreditation (AMS). `registrant_change` populates the `registrant_change`
|
|
35618
|
+
field with the change of registrant in progress.
|
|
35580
35619
|
in: query
|
|
35581
35620
|
name: include
|
|
35582
35621
|
required: false
|
|
@@ -35589,7 +35628,8 @@ paths:
|
|
|
35589
35628
|
description: Extra data to include in the response. `tags` populates the
|
|
35590
35629
|
`tags` and `status_tags` fields, which are otherwise null. `renewal_price`
|
|
35591
35630
|
resolves the domain's renewal price. `connected_account` populates the
|
|
35592
|
-
`connected_account` field for domains held at an external registrar
|
|
35631
|
+
`connected_account` field for domains held at an external registrar or
|
|
35632
|
+
on the organization's own registry accreditation (AMS). `registrant_change`
|
|
35593
35633
|
populates the `registrant_change` field with the change of registrant
|
|
35594
35634
|
in progress.
|
|
35595
35635
|
title: Include
|
package/src/schema.d.ts
CHANGED
|
@@ -11473,6 +11473,23 @@ export interface components {
|
|
|
11473
11473
|
* @enum {string}
|
|
11474
11474
|
*/
|
|
11475
11475
|
DnssecStatus: "enabled" | "disabled";
|
|
11476
|
+
/** DomainAmsAccountResponse */
|
|
11477
|
+
DomainAmsAccountResponse: {
|
|
11478
|
+
/** @description The registry the account is accredited at */
|
|
11479
|
+
registry: components["schemas"]["RegistryServiceBackend"];
|
|
11480
|
+
/**
|
|
11481
|
+
* Registry Account Id
|
|
11482
|
+
* Format: typeid
|
|
11483
|
+
* @description The registry account the domain is held on
|
|
11484
|
+
* @example registry_account_01h45ytscbebyvny4gc8cr8ma2
|
|
11485
|
+
*/
|
|
11486
|
+
registry_account_id: TypeId<"registry_account">;
|
|
11487
|
+
/**
|
|
11488
|
+
* @description Kind of connected account. `ams`: the organization's own registry accreditation, on which OpusDNS manages the domain. (enum property replaced by openapi-typescript)
|
|
11489
|
+
* @enum {string}
|
|
11490
|
+
*/
|
|
11491
|
+
type: "ams";
|
|
11492
|
+
};
|
|
11476
11493
|
/**
|
|
11477
11494
|
* DomainAttributeKey
|
|
11478
11495
|
* @enum {string}
|
|
@@ -12885,9 +12902,9 @@ export interface components {
|
|
|
12885
12902
|
canceled_on?: Date | null;
|
|
12886
12903
|
/**
|
|
12887
12904
|
* Connected Account
|
|
12888
|
-
* @description The connected account this domain is synced from. Null unless `include=connected_account` is requested, and null even then for natively registered domains, for domains on operator-managed registry accounts, and when the connected account was deleted.
|
|
12905
|
+
* @description The connected account this domain is synced from or managed on: a registrar credential (`ras`) or the organization's own registry accreditation (`ams`). Null unless `include=connected_account` is requested, and null even then for natively registered domains, for domains on operator-managed registry accounts, and when the connected account was deleted.
|
|
12889
12906
|
*/
|
|
12890
|
-
connected_account?: components["schemas"]["DomainRegistrarCredentialResponse"] | null;
|
|
12907
|
+
connected_account?: (components["schemas"]["DomainRegistrarCredentialResponse"] | components["schemas"]["DomainAmsAccountResponse"]) | null;
|
|
12891
12908
|
/**
|
|
12892
12909
|
* Contacts
|
|
12893
12910
|
* @description The contacts of the domain
|
|
@@ -13091,6 +13108,8 @@ export interface components {
|
|
|
13091
13108
|
DomainSearchSuggestionWithPrice: {
|
|
13092
13109
|
/** Available */
|
|
13093
13110
|
available: boolean;
|
|
13111
|
+
/** @description Set when the organization registers this TLD on its own registry accreditation (`ams`). The registry bills the domain to that accreditation, so `price` and `renewal_price` are the OpusDNS service fee alone, premium or not. Null for TLDs registered on OpusDNS registry accounts. */
|
|
13112
|
+
connected_account?: components["schemas"]["DomainAmsAccountResponse"] | null;
|
|
13094
13113
|
/** Domain */
|
|
13095
13114
|
domain: string;
|
|
13096
13115
|
/** Premium */
|
|
@@ -27014,7 +27033,7 @@ export interface operations {
|
|
|
27014
27033
|
account_type?: components["schemas"]["ConnectedAccountType"][] | null;
|
|
27015
27034
|
/** @description How to apply `account_type`: `match_any` keeps the domains on any of the listed types, `match_none` the domains on none of them (so `account_type=ras&account_type_mode=match_none` keeps every domain not on a RAS account, and naming every type keeps none). Has no effect without `account_type`. */
|
|
27016
27035
|
account_type_mode?: components["schemas"]["AccountTypeFilterMode"];
|
|
27017
|
-
/** @description Extra data to include in each result. `tags` populates the `tags` (user tags) and `status_tags` fields, which are otherwise null; filtering by `tag_ids` or `status_tags` alone does not populate them. `connected_account` populates the `connected_account` field for domains held at an external registrar. */
|
|
27036
|
+
/** @description Extra data to include in each result. `tags` populates the `tags` (user tags) and `status_tags` fields, which are otherwise null; filtering by `tag_ids` or `status_tags` alone does not populate them. `connected_account` populates the `connected_account` field for domains held at an external registrar or on the organization's own registry accreditation (AMS). */
|
|
27018
27037
|
include?: components["schemas"]["DomainListIncludeField"][] | null;
|
|
27019
27038
|
};
|
|
27020
27039
|
header?: {
|
|
@@ -28519,7 +28538,7 @@ export interface operations {
|
|
|
28519
28538
|
get_domain_v1_domains__domain_reference__get: {
|
|
28520
28539
|
parameters: {
|
|
28521
28540
|
query?: {
|
|
28522
|
-
/** @description Extra data to include in the response. `tags` populates the `tags` and `status_tags` fields, which are otherwise null. `renewal_price` resolves the domain's renewal price. `connected_account` populates the `connected_account` field for domains held at an external registrar. `registrant_change` populates the `registrant_change` field with the change of registrant in progress. */
|
|
28541
|
+
/** @description Extra data to include in the response. `tags` populates the `tags` and `status_tags` fields, which are otherwise null. `renewal_price` resolves the domain's renewal price. `connected_account` populates the `connected_account` field for domains held at an external registrar or on the organization's own registry accreditation (AMS). `registrant_change` populates the `registrant_change` field with the change of registrant in progress. */
|
|
28523
28542
|
include?: components["schemas"]["DomainIncludeField"][] | null;
|
|
28524
28543
|
};
|
|
28525
28544
|
header?: {
|