@opusdns/api 1.227.0 → 1.228.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 +11 -0
- package/src/helpers/schemas.d.ts +1 -0
- package/src/openapi.yaml +42 -10
- package/src/schema.d.ts +21 -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;
|
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
|
|
@@ -25106,7 +25135,7 @@ info:
|
|
|
25106
25135
|
\n\n"
|
|
25107
25136
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
25108
25137
|
title: OpusDNS API
|
|
25109
|
-
version: 2026-10-15-
|
|
25138
|
+
version: 2026-10-15-162027
|
|
25110
25139
|
x-logo:
|
|
25111
25140
|
altText: OpusDNS API Reference
|
|
25112
25141
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -33800,7 +33829,7 @@ paths:
|
|
|
33800
33829
|
(user tags) and `status_tags` fields, which are otherwise null; filtering
|
|
33801
33830
|
by `tag_ids` or `status_tags` alone does not populate them. `connected_account`
|
|
33802
33831
|
populates the `connected_account` field for domains held at an external
|
|
33803
|
-
registrar.
|
|
33832
|
+
registrar or on the organization's own registry accreditation (AMS).
|
|
33804
33833
|
in: query
|
|
33805
33834
|
name: include
|
|
33806
33835
|
required: false
|
|
@@ -33814,7 +33843,8 @@ paths:
|
|
|
33814
33843
|
`tags` (user tags) and `status_tags` fields, which are otherwise null;
|
|
33815
33844
|
filtering by `tag_ids` or `status_tags` alone does not populate them.
|
|
33816
33845
|
`connected_account` populates the `connected_account` field for domains
|
|
33817
|
-
held at an external registrar
|
|
33846
|
+
held at an external registrar or on the organization's own registry accreditation
|
|
33847
|
+
(AMS).
|
|
33818
33848
|
title: Include
|
|
33819
33849
|
- $ref: '#/components/parameters/DatetimeFormatHeader'
|
|
33820
33850
|
responses:
|
|
@@ -35575,8 +35605,9 @@ paths:
|
|
|
35575
35605
|
- description: Extra data to include in the response. `tags` populates the `tags`
|
|
35576
35606
|
and `status_tags` fields, which are otherwise null. `renewal_price` resolves
|
|
35577
35607
|
the domain's renewal price. `connected_account` populates the `connected_account`
|
|
35578
|
-
field for domains held at an external registrar
|
|
35579
|
-
|
|
35608
|
+
field for domains held at an external registrar or on the organization's
|
|
35609
|
+
own registry accreditation (AMS). `registrant_change` populates the `registrant_change`
|
|
35610
|
+
field with the change of registrant in progress.
|
|
35580
35611
|
in: query
|
|
35581
35612
|
name: include
|
|
35582
35613
|
required: false
|
|
@@ -35589,7 +35620,8 @@ paths:
|
|
|
35589
35620
|
description: Extra data to include in the response. `tags` populates the
|
|
35590
35621
|
`tags` and `status_tags` fields, which are otherwise null. `renewal_price`
|
|
35591
35622
|
resolves the domain's renewal price. `connected_account` populates the
|
|
35592
|
-
`connected_account` field for domains held at an external registrar
|
|
35623
|
+
`connected_account` field for domains held at an external registrar or
|
|
35624
|
+
on the organization's own registry accreditation (AMS). `registrant_change`
|
|
35593
35625
|
populates the `registrant_change` field with the change of registrant
|
|
35594
35626
|
in progress.
|
|
35595
35627
|
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
|
|
@@ -27014,7 +27031,7 @@ export interface operations {
|
|
|
27014
27031
|
account_type?: components["schemas"]["ConnectedAccountType"][] | null;
|
|
27015
27032
|
/** @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
27033
|
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. */
|
|
27034
|
+
/** @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
27035
|
include?: components["schemas"]["DomainListIncludeField"][] | null;
|
|
27019
27036
|
};
|
|
27020
27037
|
header?: {
|
|
@@ -28519,7 +28536,7 @@ export interface operations {
|
|
|
28519
28536
|
get_domain_v1_domains__domain_reference__get: {
|
|
28520
28537
|
parameters: {
|
|
28521
28538
|
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. */
|
|
28539
|
+
/** @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
28540
|
include?: components["schemas"]["DomainIncludeField"][] | null;
|
|
28524
28541
|
};
|
|
28525
28542
|
header?: {
|