@opusdns/api 1.215.0 → 1.217.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 +22 -0
- package/src/helpers/endpoints.ts +2 -0
- package/src/helpers/keys.ts +15 -0
- package/src/helpers/permissions.ts +8 -0
- package/src/helpers/requests.d.ts +7 -0
- package/src/helpers/responses.d.ts +9 -0
- package/src/helpers/schemas.d.ts +3 -0
- package/src/openapi.yaml +282 -37
- package/src/schema.d.ts +223 -13
package/package.json
CHANGED
package/src/helpers/constants.ts
CHANGED
|
@@ -1,8 +1,10 @@
|
|
|
1
1
|
import type {
|
|
2
|
+
AccountTypeFilterMode,
|
|
2
3
|
AgreementType,
|
|
3
4
|
AllocationMethodType,
|
|
4
5
|
AssignablePublicRole,
|
|
5
6
|
AttributeType,
|
|
7
|
+
AuthCodeDelivery,
|
|
6
8
|
BatchSortField,
|
|
7
9
|
BatchStatus,
|
|
8
10
|
BillingMode,
|
|
@@ -144,6 +146,16 @@ import type {
|
|
|
144
146
|
ZoneSortField,
|
|
145
147
|
} from './schemas';
|
|
146
148
|
|
|
149
|
+
export const ACCOUNT_TYPE_FILTER_MODE = {
|
|
150
|
+
MATCH_ANY: "match_any",
|
|
151
|
+
MATCH_NONE: "match_none",
|
|
152
|
+
} as const satisfies Record<string, AccountTypeFilterMode>;
|
|
153
|
+
|
|
154
|
+
export const ACCOUNT_TYPE_FILTER_MODE_VALUES = [
|
|
155
|
+
'match_any',
|
|
156
|
+
'match_none',
|
|
157
|
+
] as const satisfies ReadonlyArray<AccountTypeFilterMode>;
|
|
158
|
+
|
|
147
159
|
export const AGREEMENT_TYPE = {
|
|
148
160
|
TERMS_AND_CONDITIONS: "terms_and_conditions",
|
|
149
161
|
MASTER_SERVICE_AGREEMENT: "master_service_agreement",
|
|
@@ -206,6 +218,16 @@ export const ATTRIBUTE_TYPE_VALUES = [
|
|
|
206
218
|
'uri_template',
|
|
207
219
|
] as const satisfies ReadonlyArray<AttributeType>;
|
|
208
220
|
|
|
221
|
+
export const AUTH_CODE_DELIVERY = {
|
|
222
|
+
RESPONSE: "response",
|
|
223
|
+
REGISTRANT_EMAIL: "registrant_email",
|
|
224
|
+
} as const satisfies Record<string, AuthCodeDelivery>;
|
|
225
|
+
|
|
226
|
+
export const AUTH_CODE_DELIVERY_VALUES = [
|
|
227
|
+
'response',
|
|
228
|
+
'registrant_email',
|
|
229
|
+
] as const satisfies ReadonlyArray<AuthCodeDelivery>;
|
|
230
|
+
|
|
209
231
|
export const BATCH_SORT_FIELD = {
|
|
210
232
|
CREATED_ON: "created_on",
|
|
211
233
|
STARTED_AT: "started_at",
|
package/src/helpers/endpoints.ts
CHANGED
|
@@ -74,6 +74,7 @@ export const DOMAINS_TLD_SPECIFIC_SE_BY_DOMAIN_REFERENCE_AUTH_CODE_REQUEST_ENDPO
|
|
|
74
74
|
export const DOMAINS_TLD_SPECIFIC_WALES_BY_DOMAIN_REFERENCE_AUTH_CODE_REQUEST_ENDPOINT = '/v1/domains/tld-specific/wales/{domain_reference}/auth_code/request';
|
|
75
75
|
export const DOMAINS_TRANSFER_ENDPOINT = '/v1/domains/transfer';
|
|
76
76
|
export const DOMAINS_BY_DOMAIN_REFERENCE_ENDPOINT = '/v1/domains/{domain_reference}';
|
|
77
|
+
export const DOMAINS_BY_DOMAIN_REFERENCE_AUTH_CODE_ENDPOINT = '/v1/domains/{domain_reference}/auth-code';
|
|
77
78
|
export const DOMAINS_BY_DOMAIN_REFERENCE_DNSSEC_ENDPOINT = '/v1/domains/{domain_reference}/dnssec';
|
|
78
79
|
export const DOMAINS_BY_DOMAIN_REFERENCE_DNSSEC_DISABLE_ENDPOINT = '/v1/domains/{domain_reference}/dnssec/disable';
|
|
79
80
|
export const DOMAINS_BY_DOMAIN_REFERENCE_DNSSEC_ENABLE_ENDPOINT = '/v1/domains/{domain_reference}/dnssec/enable';
|
|
@@ -236,6 +237,7 @@ export type Endpoint =
|
|
|
236
237
|
| typeof DOMAINS_TLD_SPECIFIC_WALES_BY_DOMAIN_REFERENCE_AUTH_CODE_REQUEST_ENDPOINT
|
|
237
238
|
| typeof DOMAINS_TRANSFER_ENDPOINT
|
|
238
239
|
| typeof DOMAINS_BY_DOMAIN_REFERENCE_ENDPOINT
|
|
240
|
+
| typeof DOMAINS_BY_DOMAIN_REFERENCE_AUTH_CODE_ENDPOINT
|
|
239
241
|
| typeof DOMAINS_BY_DOMAIN_REFERENCE_DNSSEC_ENDPOINT
|
|
240
242
|
| typeof DOMAINS_BY_DOMAIN_REFERENCE_DNSSEC_DISABLE_ENDPOINT
|
|
241
243
|
| typeof DOMAINS_BY_DOMAIN_REFERENCE_DNSSEC_ENABLE_ENDPOINT
|
package/src/helpers/keys.ts
CHANGED
|
@@ -131,6 +131,7 @@ import type {
|
|
|
131
131
|
DnsZoneUpdatePayloadData,
|
|
132
132
|
DnsZoneUpdateWorkerPayload,
|
|
133
133
|
DnsZoneVanitySetUpdateRes,
|
|
134
|
+
DomainAuthCode,
|
|
134
135
|
DomainAvailability,
|
|
135
136
|
DomainAvailabilityError,
|
|
136
137
|
DomainAvailabilityMeta,
|
|
@@ -2106,6 +2107,20 @@ export const KEYS_DNS_ZONE_VANITY_SET_UPDATE_RES = [
|
|
|
2106
2107
|
KEY_DNS_ZONE_VANITY_SET_UPDATE_RES_ZONE,
|
|
2107
2108
|
] as const satisfies (keyof DnsZoneVanitySetUpdateRes)[];
|
|
2108
2109
|
|
|
2110
|
+
export const KEY_DOMAIN_AUTH_CODE_AUTH_CODE = 'auth_code' satisfies keyof DomainAuthCode;
|
|
2111
|
+
export const KEY_DOMAIN_AUTH_CODE_AUTH_CODE_EXPIRES_ON = 'auth_code_expires_on' satisfies keyof DomainAuthCode;
|
|
2112
|
+
export const KEY_DOMAIN_AUTH_CODE_DELIVERY = 'delivery' satisfies keyof DomainAuthCode;
|
|
2113
|
+
export const KEY_DOMAIN_AUTH_CODE_NAME = 'name' satisfies keyof DomainAuthCode;
|
|
2114
|
+
export const KEY_DOMAIN_AUTH_CODE_RECIPIENTS = 'recipients' satisfies keyof DomainAuthCode;
|
|
2115
|
+
|
|
2116
|
+
export const KEYS_DOMAIN_AUTH_CODE = [
|
|
2117
|
+
KEY_DOMAIN_AUTH_CODE_AUTH_CODE,
|
|
2118
|
+
KEY_DOMAIN_AUTH_CODE_AUTH_CODE_EXPIRES_ON,
|
|
2119
|
+
KEY_DOMAIN_AUTH_CODE_DELIVERY,
|
|
2120
|
+
KEY_DOMAIN_AUTH_CODE_NAME,
|
|
2121
|
+
KEY_DOMAIN_AUTH_CODE_RECIPIENTS,
|
|
2122
|
+
] as const satisfies (keyof DomainAuthCode)[];
|
|
2123
|
+
|
|
2109
2124
|
export const KEY_DOMAIN_AVAILABILITY_DOMAIN = 'domain' satisfies keyof DomainAvailability;
|
|
2110
2125
|
export const KEY_DOMAIN_AVAILABILITY_ERROR = 'error' satisfies keyof DomainAvailability;
|
|
2111
2126
|
export const KEY_DOMAIN_AVAILABILITY_STATUS = 'status' satisfies keyof DomainAvailability;
|
|
@@ -57,6 +57,7 @@ import {
|
|
|
57
57
|
DOMAIN_FORWARDS_METRICS_USER_AGENT_ENDPOINT,
|
|
58
58
|
DOMAIN_FORWARDS_METRICS_VISITS_BY_KEY_ENDPOINT,
|
|
59
59
|
DOMAIN_SEARCH_SUGGEST_ENDPOINT,
|
|
60
|
+
DOMAINS_BY_DOMAIN_REFERENCE_AUTH_CODE_ENDPOINT,
|
|
60
61
|
DOMAINS_BY_DOMAIN_REFERENCE_DNSSEC_DISABLE_ENDPOINT,
|
|
61
62
|
DOMAINS_BY_DOMAIN_REFERENCE_DNSSEC_ENABLE_ENDPOINT,
|
|
62
63
|
DOMAINS_BY_DOMAIN_REFERENCE_DNSSEC_ENDPOINT,
|
|
@@ -618,6 +619,13 @@ export const REQUIRED_PERMISSIONS = {
|
|
|
618
619
|
patch: [],
|
|
619
620
|
delete: [],
|
|
620
621
|
},
|
|
622
|
+
[DOMAINS_BY_DOMAIN_REFERENCE_AUTH_CODE_ENDPOINT]: {
|
|
623
|
+
get: [],
|
|
624
|
+
post: [PUBLIC_PERMISSION.DOMAINS_MANAGE],
|
|
625
|
+
put: [],
|
|
626
|
+
patch: [],
|
|
627
|
+
delete: [],
|
|
628
|
+
},
|
|
621
629
|
[DOMAINS_BY_DOMAIN_REFERENCE_DNSSEC_DISABLE_ENDPOINT]: {
|
|
622
630
|
get: [],
|
|
623
631
|
post: [PUBLIC_PERMISSION.DOMAINS_MANAGE],
|
|
@@ -518,6 +518,11 @@ export type PATCH_DomainsByDomainReference_Request = {
|
|
|
518
518
|
export type PATCH_DomainsByDomainReference_Request_Path = PATCH_DomainsByDomainReference_Request['parameters']['path'];
|
|
519
519
|
export type PATCH_DomainsByDomainReference_Request_Body = PATCH_DomainsByDomainReference_Request['requestBody'];
|
|
520
520
|
|
|
521
|
+
export type POST_DomainsByDomainReferenceAuthCode_Request = {
|
|
522
|
+
parameters: operations['request_domain_auth_code_v1_domains__domain_reference__auth_code_post']['parameters'];
|
|
523
|
+
};
|
|
524
|
+
export type POST_DomainsByDomainReferenceAuthCode_Request_Path = POST_DomainsByDomainReferenceAuthCode_Request['parameters']['path'];
|
|
525
|
+
|
|
521
526
|
export type DELETE_DomainsByDomainReferenceDnssec_Request = {
|
|
522
527
|
parameters: operations['delete_dnssec_v1_domains__domain_reference__dnssec_delete']['parameters'];
|
|
523
528
|
};
|
|
@@ -592,7 +597,9 @@ export type GET_DomainsStatistics_Request = {
|
|
|
592
597
|
export type GET_DomainsStatistics_Request_Query = GET_DomainsStatistics_Request['parameters']['query'];
|
|
593
598
|
|
|
594
599
|
export type GET_DomainsSummary_Request = {
|
|
600
|
+
parameters: operations['get_domain_summary_v1_domains_summary_get']['parameters'];
|
|
595
601
|
};
|
|
602
|
+
export type GET_DomainsSummary_Request_Query = GET_DomainsSummary_Request['parameters']['query'];
|
|
596
603
|
|
|
597
604
|
export type POST_DomainsTldSpecificAtByDomainReferenceWithdraw_Request = {
|
|
598
605
|
parameters: operations['withdraw_domain_v1_domains_tld_specific_at__domain_reference__withdraw_post']['parameters'];
|
|
@@ -20,6 +20,7 @@ import type {
|
|
|
20
20
|
DnsZoneSummary,
|
|
21
21
|
DnsZoneVanitySetUpdateRes,
|
|
22
22
|
Domain,
|
|
23
|
+
DomainAuthCode,
|
|
23
24
|
DomainAvailabilityList,
|
|
24
25
|
DomainCheck,
|
|
25
26
|
DomainDnssecData,
|
|
@@ -1190,6 +1191,14 @@ export type POST_Domains_Response_409 = Problem;
|
|
|
1190
1191
|
export type POST_Domains_Response_422 = Problem;
|
|
1191
1192
|
export type POST_Domains_Response_503 = Problem;
|
|
1192
1193
|
|
|
1194
|
+
export type POST_DomainsByDomainReferenceAuthCode_Response = POST_DomainsByDomainReferenceAuthCode_Response_200 | POST_DomainsByDomainReferenceAuthCode_Response_400 | POST_DomainsByDomainReferenceAuthCode_Response_404 | POST_DomainsByDomainReferenceAuthCode_Response_422 | POST_DomainsByDomainReferenceAuthCode_Response_502;
|
|
1195
|
+
|
|
1196
|
+
export type POST_DomainsByDomainReferenceAuthCode_Response_200 = DomainAuthCode;
|
|
1197
|
+
export type POST_DomainsByDomainReferenceAuthCode_Response_400 = Problem;
|
|
1198
|
+
export type POST_DomainsByDomainReferenceAuthCode_Response_404 = Problem;
|
|
1199
|
+
export type POST_DomainsByDomainReferenceAuthCode_Response_422 = Problem;
|
|
1200
|
+
export type POST_DomainsByDomainReferenceAuthCode_Response_502 = Problem;
|
|
1201
|
+
|
|
1193
1202
|
export type POST_DomainsByDomainReferenceDnssecDisable_Response = POST_DomainsByDomainReferenceDnssecDisable_Response_404 | POST_DomainsByDomainReferenceDnssecDisable_Response_422;
|
|
1194
1203
|
|
|
1195
1204
|
export type POST_DomainsByDomainReferenceDnssecDisable_Response_404 = Problem;
|
package/src/helpers/schemas.d.ts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { components } from '../schema';
|
|
2
2
|
|
|
3
|
+
export type AccountTypeFilterMode = components['schemas']['AccountTypeFilterMode'];
|
|
3
4
|
export type AggregationResult = components['schemas']['AggregationResult'];
|
|
4
5
|
export type AggregationRow = components['schemas']['AggregationRow'];
|
|
5
6
|
export type AggregationsContext = components['schemas']['AggregationsContext'];
|
|
@@ -16,6 +17,7 @@ export type AssignablePublicRole = components['schemas']['AssignablePublicRole']
|
|
|
16
17
|
export type AttributeCondition = components['schemas']['AttributeCondition'];
|
|
17
18
|
export type AttributeType = components['schemas']['AttributeType'];
|
|
18
19
|
export type Auth = components['schemas']['Auth'];
|
|
20
|
+
export type AuthCodeDelivery = components['schemas']['AuthCodeDelivery'];
|
|
19
21
|
export type BatchSortField = components['schemas']['BatchSortField'];
|
|
20
22
|
export type BatchStatus = components['schemas']['BatchStatus'];
|
|
21
23
|
export type BillingMetadata = components['schemas']['BillingMetadata'];
|
|
@@ -171,6 +173,7 @@ export type DnssecRecordType = components['schemas']['DnssecRecordType'];
|
|
|
171
173
|
export type DnssecRegistryPublishOutcome = components['schemas']['DnssecRegistryPublishOutcome'];
|
|
172
174
|
export type DnssecStatus = components['schemas']['DnssecStatus'];
|
|
173
175
|
export type DomainAttributeKey = components['schemas']['DomainAttributeKey'];
|
|
176
|
+
export type DomainAuthCode = components['schemas']['DomainAuthCodeResponse'];
|
|
174
177
|
export type DomainAvailability = components['schemas']['DomainAvailability'];
|
|
175
178
|
export type DomainAvailabilityError = components['schemas']['DomainAvailabilityError'];
|
|
176
179
|
export type DomainAvailabilityMeta = components['schemas']['DomainAvailabilityMeta'];
|
package/src/openapi.yaml
CHANGED
|
@@ -13,6 +13,14 @@ components:
|
|
|
13
13
|
- rfc3339
|
|
14
14
|
type: string
|
|
15
15
|
schemas:
|
|
16
|
+
AccountTypeFilterMode:
|
|
17
|
+
description: How an `account_type` filter applies; no `match_all`, since a domain
|
|
18
|
+
has exactly one account type.
|
|
19
|
+
enum:
|
|
20
|
+
- match_any
|
|
21
|
+
- match_none
|
|
22
|
+
title: AccountTypeFilterMode
|
|
23
|
+
type: string
|
|
16
24
|
AggregationResult:
|
|
17
25
|
properties:
|
|
18
26
|
field:
|
|
@@ -356,6 +364,12 @@ components:
|
|
|
356
364
|
title: Client Id
|
|
357
365
|
title: Auth
|
|
358
366
|
type: object
|
|
367
|
+
AuthCodeDelivery:
|
|
368
|
+
enum:
|
|
369
|
+
- response
|
|
370
|
+
- registrant_email
|
|
371
|
+
title: AuthCodeDelivery
|
|
372
|
+
type: string
|
|
359
373
|
BatchSortField:
|
|
360
374
|
enum:
|
|
361
375
|
- created_on
|
|
@@ -6616,6 +6630,37 @@ components:
|
|
|
6616
6630
|
- operationId
|
|
6617
6631
|
title: request_auth_code_v1_domains_tld_specific_wales__domain_reference__auth_code_request_post
|
|
6618
6632
|
type: object
|
|
6633
|
+
- properties:
|
|
6634
|
+
data:
|
|
6635
|
+
anyOf:
|
|
6636
|
+
- $ref: '#/components/schemas/DomainAuthCodeResponse'
|
|
6637
|
+
- type: string
|
|
6638
|
+
headers:
|
|
6639
|
+
additionalProperties:
|
|
6640
|
+
type: string
|
|
6641
|
+
description: Selected response headers
|
|
6642
|
+
title: Headers
|
|
6643
|
+
type: object
|
|
6644
|
+
httpStatus:
|
|
6645
|
+
anyOf:
|
|
6646
|
+
- type: integer
|
|
6647
|
+
- type: 'null'
|
|
6648
|
+
description: HTTP status returned by the underlying API
|
|
6649
|
+
title: Httpstatus
|
|
6650
|
+
operationId:
|
|
6651
|
+
const: request_domain_auth_code_v1_domains__domain_reference__auth_code_post
|
|
6652
|
+
status:
|
|
6653
|
+
const: ok
|
|
6654
|
+
truncated:
|
|
6655
|
+
default: false
|
|
6656
|
+
description: True when the gateway capped an oversized payload
|
|
6657
|
+
title: Truncated
|
|
6658
|
+
type: boolean
|
|
6659
|
+
required:
|
|
6660
|
+
- status
|
|
6661
|
+
- operationId
|
|
6662
|
+
title: request_domain_auth_code_v1_domains__domain_reference__auth_code_post
|
|
6663
|
+
type: object
|
|
6619
6664
|
- properties:
|
|
6620
6665
|
data:
|
|
6621
6666
|
anyOf:
|
|
@@ -11387,6 +11432,45 @@ components:
|
|
|
11387
11432
|
- registry_reseller_id
|
|
11388
11433
|
title: DomainAttributeKey
|
|
11389
11434
|
type: string
|
|
11435
|
+
DomainAuthCodeResponse:
|
|
11436
|
+
properties:
|
|
11437
|
+
auth_code:
|
|
11438
|
+
anyOf:
|
|
11439
|
+
- type: string
|
|
11440
|
+
- type: 'null'
|
|
11441
|
+
description: The auth code, when `delivery` is `response`. Hidden when the
|
|
11442
|
+
caller cannot view the domain's auth codes
|
|
11443
|
+
title: Auth Code
|
|
11444
|
+
auth_code_expires_on:
|
|
11445
|
+
anyOf:
|
|
11446
|
+
- format: date-time
|
|
11447
|
+
type: string
|
|
11448
|
+
- type: 'null'
|
|
11449
|
+
description: When the auth code expires, if the registry limits its validity
|
|
11450
|
+
title: Auth Code Expires On
|
|
11451
|
+
delivery:
|
|
11452
|
+
$ref: '#/components/schemas/AuthCodeDelivery'
|
|
11453
|
+
description: 'Where the auth code ends up: `response` returns it in `auth_code`,
|
|
11454
|
+
`registrant_email` means the registry emails it to the registrant and
|
|
11455
|
+
it never reaches us'
|
|
11456
|
+
name:
|
|
11457
|
+
description: The domain name the auth code belongs to
|
|
11458
|
+
title: Name
|
|
11459
|
+
type: string
|
|
11460
|
+
recipients:
|
|
11461
|
+
anyOf:
|
|
11462
|
+
- items:
|
|
11463
|
+
type: string
|
|
11464
|
+
type: array
|
|
11465
|
+
- type: 'null'
|
|
11466
|
+
description: The addresses the registry sent the auth code to, when it reports
|
|
11467
|
+
them
|
|
11468
|
+
title: Recipients
|
|
11469
|
+
required:
|
|
11470
|
+
- name
|
|
11471
|
+
- delivery
|
|
11472
|
+
title: DomainAuthCodeResponse
|
|
11473
|
+
type: object
|
|
11390
11474
|
DomainAvailability:
|
|
11391
11475
|
properties:
|
|
11392
11476
|
domain:
|
|
@@ -24882,7 +24966,7 @@ info:
|
|
|
24882
24966
|
\n\n"
|
|
24883
24967
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
24884
24968
|
title: OpusDNS API
|
|
24885
|
-
version: 2026-10-
|
|
24969
|
+
version: 2026-10-09-190403
|
|
24886
24970
|
x-logo:
|
|
24887
24971
|
altText: OpusDNS API Reference
|
|
24888
24972
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -33523,10 +33607,10 @@ paths:
|
|
|
33523
33607
|
- description: 'Filter domains by the type of the registry account they are
|
|
33524
33608
|
held on: `ras` for domains on a registrar-abstraction (RAS) account synced
|
|
33525
33609
|
from a connected external registrar, including those whose credential has
|
|
33526
|
-
since been deleted
|
|
33527
|
-
|
|
33528
|
-
|
|
33529
|
-
|
|
33610
|
+
since been deleted; `ams` for domains managed on a customer''s own registry
|
|
33611
|
+
accreditation; `default` for all others, manually managed domains included
|
|
33612
|
+
(their accounts are typed `default`). Can be specified multiple times (union
|
|
33613
|
+
of all provided values).'
|
|
33530
33614
|
in: query
|
|
33531
33615
|
name: account_type
|
|
33532
33616
|
required: false
|
|
@@ -33539,29 +33623,26 @@ paths:
|
|
|
33539
33623
|
description: 'Filter domains by the type of the registry account they are
|
|
33540
33624
|
held on: `ras` for domains on a registrar-abstraction (RAS) account synced
|
|
33541
33625
|
from a connected external registrar, including those whose credential
|
|
33542
|
-
has since been deleted
|
|
33543
|
-
|
|
33544
|
-
|
|
33545
|
-
|
|
33546
|
-
values).'
|
|
33626
|
+
has since been deleted; `ams` for domains managed on a customer''s own
|
|
33627
|
+
registry accreditation; `default` for all others, manually managed domains
|
|
33628
|
+
included (their accounts are typed `default`). Can be specified multiple
|
|
33629
|
+
times (union of all provided values).'
|
|
33547
33630
|
title: Account Type
|
|
33548
33631
|
- description: 'How to apply `account_type`: `match_any` keeps the domains on
|
|
33549
33632
|
any of the listed types, `match_none` the domains on none of them (so `account_type=ras&account_type_mode=match_none`
|
|
33550
|
-
|
|
33551
|
-
|
|
33552
|
-
a domain has exactly one account type.'
|
|
33633
|
+
keeps every domain not on a RAS account, and naming every type keeps none).
|
|
33634
|
+
Has no effect without `account_type`.'
|
|
33553
33635
|
in: query
|
|
33554
33636
|
name: account_type_mode
|
|
33555
33637
|
required: false
|
|
33556
33638
|
schema:
|
|
33557
|
-
$ref: '#/components/schemas/
|
|
33639
|
+
$ref: '#/components/schemas/AccountTypeFilterMode'
|
|
33558
33640
|
default: match_any
|
|
33559
33641
|
description: 'How to apply `account_type`: `match_any` keeps the domains
|
|
33560
33642
|
on any of the listed types, `match_none` the domains on none of them (so
|
|
33561
|
-
`account_type=ras&account_type_mode=match_none`
|
|
33562
|
-
on a RAS account, and
|
|
33563
|
-
|
|
33564
|
-
account type.'
|
|
33643
|
+
`account_type=ras&account_type_mode=match_none` keeps every domain not
|
|
33644
|
+
on a RAS account, and naming every type keeps none). Has no effect without
|
|
33645
|
+
`account_type`.'
|
|
33565
33646
|
- description: Extra data to include in each result. `tags` populates the `tags`
|
|
33566
33647
|
(user tags) and `status_tags` fields, which are otherwise null; filtering
|
|
33567
33648
|
by `tag_ids` or `status_tags` alone does not populate them. `connected_account`
|
|
@@ -34015,9 +34096,54 @@ paths:
|
|
|
34015
34096
|
by status, status tag, TLD,
|
|
34016
34097
|
|
|
34017
34098
|
registry account type and expiration timeframe. Only `by_organization` includes
|
|
34018
|
-
sub-organizations.
|
|
34099
|
+
sub-organizations.
|
|
34100
|
+
|
|
34101
|
+
With `account_type`, every count covers only the domains that filter keeps,
|
|
34102
|
+
so a sub-organization
|
|
34103
|
+
|
|
34104
|
+
whose domains all fall outside it is left out of `by_organization`, as one
|
|
34105
|
+
without domains always is.'
|
|
34019
34106
|
operationId: get_domain_summary_v1_domains_summary_get
|
|
34020
34107
|
parameters:
|
|
34108
|
+
- description: 'Filter domains by the type of the registry account they are
|
|
34109
|
+
held on: `ras` for domains on a registrar-abstraction (RAS) account synced
|
|
34110
|
+
from a connected external registrar, including those whose credential has
|
|
34111
|
+
since been deleted; `ams` for domains managed on a customer''s own registry
|
|
34112
|
+
accreditation; `default` for all others, manually managed domains included
|
|
34113
|
+
(their accounts are typed `default`). Can be specified multiple times (union
|
|
34114
|
+
of all provided values).'
|
|
34115
|
+
in: query
|
|
34116
|
+
name: account_type
|
|
34117
|
+
required: false
|
|
34118
|
+
schema:
|
|
34119
|
+
anyOf:
|
|
34120
|
+
- items:
|
|
34121
|
+
$ref: '#/components/schemas/ConnectedAccountType'
|
|
34122
|
+
type: array
|
|
34123
|
+
- type: 'null'
|
|
34124
|
+
description: 'Filter domains by the type of the registry account they are
|
|
34125
|
+
held on: `ras` for domains on a registrar-abstraction (RAS) account synced
|
|
34126
|
+
from a connected external registrar, including those whose credential
|
|
34127
|
+
has since been deleted; `ams` for domains managed on a customer''s own
|
|
34128
|
+
registry accreditation; `default` for all others, manually managed domains
|
|
34129
|
+
included (their accounts are typed `default`). Can be specified multiple
|
|
34130
|
+
times (union of all provided values).'
|
|
34131
|
+
title: Account Type
|
|
34132
|
+
- description: 'How to apply `account_type`: `match_any` keeps the domains on
|
|
34133
|
+
any of the listed types, `match_none` the domains on none of them (so `account_type=ras&account_type_mode=match_none`
|
|
34134
|
+
keeps every domain not on a RAS account, and naming every type keeps none).
|
|
34135
|
+
Has no effect without `account_type`.'
|
|
34136
|
+
in: query
|
|
34137
|
+
name: account_type_mode
|
|
34138
|
+
required: false
|
|
34139
|
+
schema:
|
|
34140
|
+
$ref: '#/components/schemas/AccountTypeFilterMode'
|
|
34141
|
+
default: match_any
|
|
34142
|
+
description: 'How to apply `account_type`: `match_any` keeps the domains
|
|
34143
|
+
on any of the listed types, `match_none` the domains on none of them (so
|
|
34144
|
+
`account_type=ras&account_type_mode=match_none` keeps every domain not
|
|
34145
|
+
on a RAS account, and naming every type keeps none). Has no effect without
|
|
34146
|
+
`account_type`.'
|
|
34021
34147
|
- $ref: '#/components/parameters/DatetimeFormatHeader'
|
|
34022
34148
|
responses:
|
|
34023
34149
|
'200':
|
|
@@ -34101,6 +34227,9 @@ paths:
|
|
|
34101
34227
|
- domains:manage
|
|
34102
34228
|
/v1/domains/tld-specific/be/{domain_reference}/auth_code/request:
|
|
34103
34229
|
post:
|
|
34230
|
+
deprecated: true
|
|
34231
|
+
description: 'Deprecated: use `POST /v1/domains/{domain_reference}/auth-code`,
|
|
34232
|
+
which handles every TLD.'
|
|
34104
34233
|
operationId: request_auth_code_v1_domains_tld_specific_be__domain_reference__auth_code_request_post
|
|
34105
34234
|
parameters:
|
|
34106
34235
|
- in: path
|
|
@@ -34168,11 +34297,13 @@ paths:
|
|
|
34168
34297
|
- domains:manage
|
|
34169
34298
|
/v1/domains/tld-specific/cymru/{domain_reference}/auth_code/request:
|
|
34170
34299
|
post:
|
|
34171
|
-
|
|
34172
|
-
|
|
34173
|
-
|
|
34174
|
-
|
|
34175
|
-
code
|
|
34300
|
+
deprecated: true
|
|
34301
|
+
description: 'Deprecated: use `POST /v1/domains/{domain_reference}/auth-code`,
|
|
34302
|
+
which handles every TLD. Nominet expires a Transfer Authorisation Code after
|
|
34303
|
+
14 days or on use in a transfer, and enforces complexity requirements on it.
|
|
34304
|
+
This endpoint mints a compliant code, sets it through a `domain:update` and
|
|
34305
|
+
returns it, invalidating any previous one. It is the only way to change a
|
|
34306
|
+
`.cymru` auth code.'
|
|
34176
34307
|
operationId: request_auth_code_v1_domains_tld_specific_cymru__domain_reference__auth_code_request_post
|
|
34177
34308
|
parameters:
|
|
34178
34309
|
- in: path
|
|
@@ -34240,6 +34371,9 @@ paths:
|
|
|
34240
34371
|
- domains:manage
|
|
34241
34372
|
/v1/domains/tld-specific/cz/{domain_reference}/auth_code/request:
|
|
34242
34373
|
post:
|
|
34374
|
+
deprecated: true
|
|
34375
|
+
description: 'Deprecated: use `POST /v1/domains/{domain_reference}/auth-code`,
|
|
34376
|
+
which handles every TLD.'
|
|
34243
34377
|
operationId: request_auth_code_v1_domains_tld_specific_cz__domain_reference__auth_code_request_post
|
|
34244
34378
|
parameters:
|
|
34245
34379
|
- in: path
|
|
@@ -34366,6 +34500,9 @@ paths:
|
|
|
34366
34500
|
- domains:manage
|
|
34367
34501
|
/v1/domains/tld-specific/dk/{domain_reference}/auth_code/request:
|
|
34368
34502
|
post:
|
|
34503
|
+
deprecated: true
|
|
34504
|
+
description: 'Deprecated: use `POST /v1/domains/{domain_reference}/auth-code`,
|
|
34505
|
+
which handles every TLD.'
|
|
34369
34506
|
operationId: request_auth_code_v1_domains_tld_specific_dk__domain_reference__auth_code_request_post
|
|
34370
34507
|
parameters:
|
|
34371
34508
|
- in: path
|
|
@@ -34433,6 +34570,9 @@ paths:
|
|
|
34433
34570
|
- domains:manage
|
|
34434
34571
|
/v1/domains/tld-specific/eu/{domain_reference}/auth_code/request:
|
|
34435
34572
|
post:
|
|
34573
|
+
deprecated: true
|
|
34574
|
+
description: 'Deprecated: use `POST /v1/domains/{domain_reference}/auth-code`,
|
|
34575
|
+
which handles every TLD.'
|
|
34436
34576
|
operationId: request_auth_code_v1_domains_tld_specific_eu__domain_reference__auth_code_request_post
|
|
34437
34577
|
parameters:
|
|
34438
34578
|
- in: path
|
|
@@ -34500,6 +34640,9 @@ paths:
|
|
|
34500
34640
|
- domains:manage
|
|
34501
34641
|
/v1/domains/tld-specific/lt/{domain_reference}/auth_code/request:
|
|
34502
34642
|
post:
|
|
34643
|
+
deprecated: true
|
|
34644
|
+
description: 'Deprecated: use `POST /v1/domains/{domain_reference}/auth-code`,
|
|
34645
|
+
which handles every TLD.'
|
|
34503
34646
|
operationId: request_auth_code_v1_domains_tld_specific_lt__domain_reference__auth_code_request_post
|
|
34504
34647
|
parameters:
|
|
34505
34648
|
- in: path
|
|
@@ -34828,10 +34971,12 @@ paths:
|
|
|
34828
34971
|
- domains:manage
|
|
34829
34972
|
/v1/domains/tld-specific/nu/{domain_reference}/auth_code/request:
|
|
34830
34973
|
post:
|
|
34831
|
-
|
|
34832
|
-
|
|
34833
|
-
|
|
34834
|
-
the
|
|
34974
|
+
deprecated: true
|
|
34975
|
+
description: 'Deprecated: use `POST /v1/domains/{domain_reference}/auth-code`,
|
|
34976
|
+
which handles every TLD. `.nu` auth codes are owned by the registry: registrars
|
|
34977
|
+
can only send the literal `auto`, and the generated code is returned in the
|
|
34978
|
+
`iis:updData` extension of a `domain:update`. This endpoint runs that update
|
|
34979
|
+
and stores the fresh code, invalidating any previous one.'
|
|
34835
34980
|
operationId: request_auth_code_v1_domains_tld_specific_nu__domain_reference__auth_code_request_post
|
|
34836
34981
|
parameters:
|
|
34837
34982
|
- in: path
|
|
@@ -34899,10 +35044,12 @@ paths:
|
|
|
34899
35044
|
- domains:manage
|
|
34900
35045
|
/v1/domains/tld-specific/se/{domain_reference}/auth_code/request:
|
|
34901
35046
|
post:
|
|
34902
|
-
|
|
34903
|
-
|
|
34904
|
-
|
|
34905
|
-
the
|
|
35047
|
+
deprecated: true
|
|
35048
|
+
description: 'Deprecated: use `POST /v1/domains/{domain_reference}/auth-code`,
|
|
35049
|
+
which handles every TLD. `.se` auth codes are owned by the registry: registrars
|
|
35050
|
+
can only send the literal `auto`, and the generated code is returned in the
|
|
35051
|
+
`iis:updData` extension of a `domain:update`. This endpoint runs that update
|
|
35052
|
+
and stores the fresh code, invalidating any previous one.'
|
|
34906
35053
|
operationId: request_auth_code_v1_domains_tld_specific_se__domain_reference__auth_code_request_post
|
|
34907
35054
|
parameters:
|
|
34908
35055
|
- in: path
|
|
@@ -34970,11 +35117,13 @@ paths:
|
|
|
34970
35117
|
- domains:manage
|
|
34971
35118
|
/v1/domains/tld-specific/wales/{domain_reference}/auth_code/request:
|
|
34972
35119
|
post:
|
|
34973
|
-
|
|
34974
|
-
|
|
34975
|
-
|
|
34976
|
-
|
|
34977
|
-
code
|
|
35120
|
+
deprecated: true
|
|
35121
|
+
description: 'Deprecated: use `POST /v1/domains/{domain_reference}/auth-code`,
|
|
35122
|
+
which handles every TLD. Nominet expires a Transfer Authorisation Code after
|
|
35123
|
+
14 days or on use in a transfer, and enforces complexity requirements on it.
|
|
35124
|
+
This endpoint mints a compliant code, sets it through a `domain:update` and
|
|
35125
|
+
returns it, invalidating any previous one. It is the only way to change a
|
|
35126
|
+
`.wales` auth code.'
|
|
34978
35127
|
operationId: request_auth_code_v1_domains_tld_specific_wales__domain_reference__auth_code_request_post
|
|
34979
35128
|
parameters:
|
|
34980
35129
|
- in: path
|
|
@@ -35407,6 +35556,102 @@ paths:
|
|
|
35407
35556
|
- domain
|
|
35408
35557
|
x-required-permissions:
|
|
35409
35558
|
- domains:manage
|
|
35559
|
+
/v1/domains/{domain_reference}/auth-code:
|
|
35560
|
+
post:
|
|
35561
|
+
description: Gets the domain a fresh auth code, whatever the registry's model.
|
|
35562
|
+
Where the registrar sets the code, one is generated, set at the registry and
|
|
35563
|
+
returned, invalidating the previous one. Where the registry generates it,
|
|
35564
|
+
it is requested there and returned, or, for registries that only send it to
|
|
35565
|
+
the registrant (`.be`, `.cz`), `delivery` is `registrant_email` and no code
|
|
35566
|
+
is returned. TLDs without auth codes answer 422. `auth_code` is hidden when
|
|
35567
|
+
the caller cannot view the domain's auth codes.
|
|
35568
|
+
operationId: request_domain_auth_code_v1_domains__domain_reference__auth_code_post
|
|
35569
|
+
parameters:
|
|
35570
|
+
- in: path
|
|
35571
|
+
name: domain_reference
|
|
35572
|
+
required: true
|
|
35573
|
+
schema:
|
|
35574
|
+
anyOf:
|
|
35575
|
+
- examples:
|
|
35576
|
+
- domain_01h45ytscbebyvny4gc8cr8ma2
|
|
35577
|
+
format: typeid
|
|
35578
|
+
pattern: ^domain_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
35579
|
+
type: string
|
|
35580
|
+
x-typeid-prefix: domain
|
|
35581
|
+
- type: string
|
|
35582
|
+
title: Domain Reference
|
|
35583
|
+
- $ref: '#/components/parameters/DatetimeFormatHeader'
|
|
35584
|
+
responses:
|
|
35585
|
+
'200':
|
|
35586
|
+
content:
|
|
35587
|
+
application/json:
|
|
35588
|
+
schema:
|
|
35589
|
+
$ref: '#/components/schemas/DomainAuthCodeResponse'
|
|
35590
|
+
description: Successful Response
|
|
35591
|
+
'400':
|
|
35592
|
+
content:
|
|
35593
|
+
application/problem+json:
|
|
35594
|
+
example:
|
|
35595
|
+
code: ERROR_DOMAIN_TRANSFER
|
|
35596
|
+
detail: There was an error transferring the domain
|
|
35597
|
+
domain_name: Additional error context.
|
|
35598
|
+
reason: An unspecified error occurred
|
|
35599
|
+
status: 400
|
|
35600
|
+
title: Domain Transfer Error
|
|
35601
|
+
type: domain-transfer
|
|
35602
|
+
schema:
|
|
35603
|
+
$ref: '#/components/schemas/Problem'
|
|
35604
|
+
description: Bad Request
|
|
35605
|
+
'404':
|
|
35606
|
+
content:
|
|
35607
|
+
application/problem+json:
|
|
35608
|
+
example:
|
|
35609
|
+
code: ERROR_DOMAIN_NOT_FOUND
|
|
35610
|
+
detail: Domain not found
|
|
35611
|
+
domain_name: Additional error context.
|
|
35612
|
+
status: 404
|
|
35613
|
+
title: Domain Management Error
|
|
35614
|
+
type: domain-not-found
|
|
35615
|
+
schema:
|
|
35616
|
+
$ref: '#/components/schemas/Problem'
|
|
35617
|
+
description: Not Found
|
|
35618
|
+
'422':
|
|
35619
|
+
content:
|
|
35620
|
+
application/problem+json:
|
|
35621
|
+
example:
|
|
35622
|
+
code: ERROR_DOMAIN_AUTH_CODE_NOT_SUPPORTED
|
|
35623
|
+
detail: Auth codes are not used
|
|
35624
|
+
domain_name: example.lu
|
|
35625
|
+
status: 422
|
|
35626
|
+
title: Domain Management Error
|
|
35627
|
+
tld: lu
|
|
35628
|
+
type: domain-auth-code-not-supported
|
|
35629
|
+
schema:
|
|
35630
|
+
$ref: '#/components/schemas/Problem'
|
|
35631
|
+
description: Unprocessable Content
|
|
35632
|
+
'502':
|
|
35633
|
+
content:
|
|
35634
|
+
application/problem+json:
|
|
35635
|
+
example:
|
|
35636
|
+
code: ERROR_AUTH_CODE
|
|
35637
|
+
detail: The registry did not return an auth code
|
|
35638
|
+
domain_name: example.eu
|
|
35639
|
+
reason: No auth code returned
|
|
35640
|
+
status: 502
|
|
35641
|
+
title: Domain Management Error
|
|
35642
|
+
type: domain-auth-code-unavailable
|
|
35643
|
+
schema:
|
|
35644
|
+
$ref: '#/components/schemas/Problem'
|
|
35645
|
+
description: Bad Gateway
|
|
35646
|
+
security:
|
|
35647
|
+
- OAuth2PasswordBearer: []
|
|
35648
|
+
- APIKeyHeader: []
|
|
35649
|
+
summary: Request a fresh auth code
|
|
35650
|
+
tags:
|
|
35651
|
+
- domain
|
|
35652
|
+
- domain
|
|
35653
|
+
x-required-permissions:
|
|
35654
|
+
- domains:manage
|
|
35410
35655
|
/v1/domains/{domain_reference}/dnssec:
|
|
35411
35656
|
delete:
|
|
35412
35657
|
description: Removes all DNSSEC data for a domain
|
package/src/schema.d.ts
CHANGED
|
@@ -1213,6 +1213,8 @@ export interface paths {
|
|
|
1213
1213
|
* Get domain summary
|
|
1214
1214
|
* @description Retrieves a summary of your organization's domains, with counts by status, status tag, TLD,
|
|
1215
1215
|
* registry account type and expiration timeframe. Only `by_organization` includes sub-organizations.
|
|
1216
|
+
* With `account_type`, every count covers only the domains that filter keeps, so a sub-organization
|
|
1217
|
+
* whose domains all fall outside it is left out of `by_organization`, as one without domains always is.
|
|
1216
1218
|
*/
|
|
1217
1219
|
get: operations["get_domain_summary_v1_domains_summary_get"];
|
|
1218
1220
|
put?: never;
|
|
@@ -1249,7 +1251,11 @@ export interface paths {
|
|
|
1249
1251
|
};
|
|
1250
1252
|
get?: never;
|
|
1251
1253
|
put?: never;
|
|
1252
|
-
/**
|
|
1254
|
+
/**
|
|
1255
|
+
* Requests your auth code directly from DNS Belgium (registry)
|
|
1256
|
+
* @deprecated
|
|
1257
|
+
* @description Deprecated: use `POST /v1/domains/{domain_reference}/auth-code`, which handles every TLD.
|
|
1258
|
+
*/
|
|
1253
1259
|
post: operations["request_auth_code_v1_domains_tld_specific_be__domain_reference__auth_code_request_post"];
|
|
1254
1260
|
delete?: never;
|
|
1255
1261
|
options?: never;
|
|
@@ -1268,7 +1274,8 @@ export interface paths {
|
|
|
1268
1274
|
put?: never;
|
|
1269
1275
|
/**
|
|
1270
1276
|
* Generates a fresh auth code at Nominet (.cymru)
|
|
1271
|
-
* @
|
|
1277
|
+
* @deprecated
|
|
1278
|
+
* @description Deprecated: use `POST /v1/domains/{domain_reference}/auth-code`, which handles every TLD. Nominet expires a Transfer Authorisation Code after 14 days or on use in a transfer, and enforces complexity requirements on it. This endpoint mints a compliant code, sets it through a `domain:update` and returns it, invalidating any previous one. It is the only way to change a `.cymru` auth code.
|
|
1272
1279
|
*/
|
|
1273
1280
|
post: operations["request_auth_code_v1_domains_tld_specific_cymru__domain_reference__auth_code_request_post"];
|
|
1274
1281
|
delete?: never;
|
|
@@ -1286,7 +1293,11 @@ export interface paths {
|
|
|
1286
1293
|
};
|
|
1287
1294
|
get?: never;
|
|
1288
1295
|
put?: never;
|
|
1289
|
-
/**
|
|
1296
|
+
/**
|
|
1297
|
+
* Requests your auth code directly from CZ.NIC (registry)
|
|
1298
|
+
* @deprecated
|
|
1299
|
+
* @description Deprecated: use `POST /v1/domains/{domain_reference}/auth-code`, which handles every TLD.
|
|
1300
|
+
*/
|
|
1290
1301
|
post: operations["request_auth_code_v1_domains_tld_specific_cz__domain_reference__auth_code_request_post"];
|
|
1291
1302
|
delete?: never;
|
|
1292
1303
|
options?: never;
|
|
@@ -1320,7 +1331,11 @@ export interface paths {
|
|
|
1320
1331
|
};
|
|
1321
1332
|
get?: never;
|
|
1322
1333
|
put?: never;
|
|
1323
|
-
/**
|
|
1334
|
+
/**
|
|
1335
|
+
* Requests your auth code directly from Punktum dk (registry)
|
|
1336
|
+
* @deprecated
|
|
1337
|
+
* @description Deprecated: use `POST /v1/domains/{domain_reference}/auth-code`, which handles every TLD.
|
|
1338
|
+
*/
|
|
1324
1339
|
post: operations["request_auth_code_v1_domains_tld_specific_dk__domain_reference__auth_code_request_post"];
|
|
1325
1340
|
delete?: never;
|
|
1326
1341
|
options?: never;
|
|
@@ -1337,7 +1352,11 @@ export interface paths {
|
|
|
1337
1352
|
};
|
|
1338
1353
|
get?: never;
|
|
1339
1354
|
put?: never;
|
|
1340
|
-
/**
|
|
1355
|
+
/**
|
|
1356
|
+
* Requests your auth code directly from EURid (registry)
|
|
1357
|
+
* @deprecated
|
|
1358
|
+
* @description Deprecated: use `POST /v1/domains/{domain_reference}/auth-code`, which handles every TLD.
|
|
1359
|
+
*/
|
|
1341
1360
|
post: operations["request_auth_code_v1_domains_tld_specific_eu__domain_reference__auth_code_request_post"];
|
|
1342
1361
|
delete?: never;
|
|
1343
1362
|
options?: never;
|
|
@@ -1354,7 +1373,11 @@ export interface paths {
|
|
|
1354
1373
|
};
|
|
1355
1374
|
get?: never;
|
|
1356
1375
|
put?: never;
|
|
1357
|
-
/**
|
|
1376
|
+
/**
|
|
1377
|
+
* Requests your auth code directly from DOMREG (registry)
|
|
1378
|
+
* @deprecated
|
|
1379
|
+
* @description Deprecated: use `POST /v1/domains/{domain_reference}/auth-code`, which handles every TLD.
|
|
1380
|
+
*/
|
|
1358
1381
|
post: operations["request_auth_code_v1_domains_tld_specific_lt__domain_reference__auth_code_request_post"];
|
|
1359
1382
|
delete?: never;
|
|
1360
1383
|
options?: never;
|
|
@@ -1431,7 +1454,8 @@ export interface paths {
|
|
|
1431
1454
|
put?: never;
|
|
1432
1455
|
/**
|
|
1433
1456
|
* Generates a fresh auth code at Internetstiftelsen (.nu)
|
|
1434
|
-
* @
|
|
1457
|
+
* @deprecated
|
|
1458
|
+
* @description Deprecated: use `POST /v1/domains/{domain_reference}/auth-code`, which handles every TLD. `.nu` auth codes are owned by the registry: registrars can only send the literal `auto`, and the generated code is returned in the `iis:updData` extension of a `domain:update`. This endpoint runs that update and stores the fresh code, invalidating any previous one.
|
|
1435
1459
|
*/
|
|
1436
1460
|
post: operations["request_auth_code_v1_domains_tld_specific_nu__domain_reference__auth_code_request_post"];
|
|
1437
1461
|
delete?: never;
|
|
@@ -1451,7 +1475,8 @@ export interface paths {
|
|
|
1451
1475
|
put?: never;
|
|
1452
1476
|
/**
|
|
1453
1477
|
* Generates a fresh auth code at Internetstiftelsen (.se)
|
|
1454
|
-
* @
|
|
1478
|
+
* @deprecated
|
|
1479
|
+
* @description Deprecated: use `POST /v1/domains/{domain_reference}/auth-code`, which handles every TLD. `.se` auth codes are owned by the registry: registrars can only send the literal `auto`, and the generated code is returned in the `iis:updData` extension of a `domain:update`. This endpoint runs that update and stores the fresh code, invalidating any previous one.
|
|
1455
1480
|
*/
|
|
1456
1481
|
post: operations["request_auth_code_v1_domains_tld_specific_se__domain_reference__auth_code_request_post"];
|
|
1457
1482
|
delete?: never;
|
|
@@ -1471,7 +1496,8 @@ export interface paths {
|
|
|
1471
1496
|
put?: never;
|
|
1472
1497
|
/**
|
|
1473
1498
|
* Generates a fresh auth code at Nominet (.wales)
|
|
1474
|
-
* @
|
|
1499
|
+
* @deprecated
|
|
1500
|
+
* @description Deprecated: use `POST /v1/domains/{domain_reference}/auth-code`, which handles every TLD. Nominet expires a Transfer Authorisation Code after 14 days or on use in a transfer, and enforces complexity requirements on it. This endpoint mints a compliant code, sets it through a `domain:update` and returns it, invalidating any previous one. It is the only way to change a `.wales` auth code.
|
|
1475
1501
|
*/
|
|
1476
1502
|
post: operations["request_auth_code_v1_domains_tld_specific_wales__domain_reference__auth_code_request_post"];
|
|
1477
1503
|
delete?: never;
|
|
@@ -1537,6 +1563,26 @@ export interface paths {
|
|
|
1537
1563
|
patch: operations["update_domain_v1_domains__domain_reference__patch"];
|
|
1538
1564
|
trace?: never;
|
|
1539
1565
|
};
|
|
1566
|
+
"/v1/domains/{domain_reference}/auth-code": {
|
|
1567
|
+
parameters: {
|
|
1568
|
+
query?: never;
|
|
1569
|
+
header?: never;
|
|
1570
|
+
path?: never;
|
|
1571
|
+
cookie?: never;
|
|
1572
|
+
};
|
|
1573
|
+
get?: never;
|
|
1574
|
+
put?: never;
|
|
1575
|
+
/**
|
|
1576
|
+
* Request a fresh auth code
|
|
1577
|
+
* @description Gets the domain a fresh auth code, whatever the registry's model. Where the registrar sets the code, one is generated, set at the registry and returned, invalidating the previous one. Where the registry generates it, it is requested there and returned, or, for registries that only send it to the registrant (`.be`, `.cz`), `delivery` is `registrant_email` and no code is returned. TLDs without auth codes answer 422. `auth_code` is hidden when the caller cannot view the domain's auth codes.
|
|
1578
|
+
*/
|
|
1579
|
+
post: operations["request_domain_auth_code_v1_domains__domain_reference__auth_code_post"];
|
|
1580
|
+
delete?: never;
|
|
1581
|
+
options?: never;
|
|
1582
|
+
head?: never;
|
|
1583
|
+
patch?: never;
|
|
1584
|
+
trace?: never;
|
|
1585
|
+
};
|
|
1540
1586
|
"/v1/domains/{domain_reference}/dnssec": {
|
|
1541
1587
|
parameters: {
|
|
1542
1588
|
query?: never;
|
|
@@ -3249,6 +3295,12 @@ export interface paths {
|
|
|
3249
3295
|
export type webhooks = Record<string, never>;
|
|
3250
3296
|
export interface components {
|
|
3251
3297
|
schemas: {
|
|
3298
|
+
/**
|
|
3299
|
+
* AccountTypeFilterMode
|
|
3300
|
+
* @description How an `account_type` filter applies; no `match_all`, since a domain has exactly one account type.
|
|
3301
|
+
* @enum {string}
|
|
3302
|
+
*/
|
|
3303
|
+
AccountTypeFilterMode: "match_any" | "match_none";
|
|
3252
3304
|
/** AggregationResult */
|
|
3253
3305
|
AggregationResult: {
|
|
3254
3306
|
/** Field */
|
|
@@ -3459,6 +3511,11 @@ export interface components {
|
|
|
3459
3511
|
/** Client Id */
|
|
3460
3512
|
client_id?: string | null;
|
|
3461
3513
|
};
|
|
3514
|
+
/**
|
|
3515
|
+
* AuthCodeDelivery
|
|
3516
|
+
* @enum {string}
|
|
3517
|
+
*/
|
|
3518
|
+
AuthCodeDelivery: "response" | "registrant_email";
|
|
3462
3519
|
/**
|
|
3463
3520
|
* BatchSortField
|
|
3464
3521
|
* @enum {string}
|
|
@@ -8154,6 +8211,30 @@ export interface components {
|
|
|
8154
8211
|
* @default false
|
|
8155
8212
|
*/
|
|
8156
8213
|
truncated: boolean;
|
|
8214
|
+
} | {
|
|
8215
|
+
data?: components["schemas"]["DomainAuthCodeResponse"] | string;
|
|
8216
|
+
/**
|
|
8217
|
+
* Headers
|
|
8218
|
+
* @description Selected response headers
|
|
8219
|
+
*/
|
|
8220
|
+
headers?: {
|
|
8221
|
+
[key: string]: string;
|
|
8222
|
+
};
|
|
8223
|
+
/**
|
|
8224
|
+
* Httpstatus
|
|
8225
|
+
* @description HTTP status returned by the underlying API
|
|
8226
|
+
*/
|
|
8227
|
+
httpStatus?: number | null;
|
|
8228
|
+
/** @constant */
|
|
8229
|
+
operationId: "request_domain_auth_code_v1_domains__domain_reference__auth_code_post";
|
|
8230
|
+
/** @constant */
|
|
8231
|
+
status: "ok";
|
|
8232
|
+
/**
|
|
8233
|
+
* Truncated
|
|
8234
|
+
* @description True when the gateway capped an oversized payload
|
|
8235
|
+
* @default false
|
|
8236
|
+
*/
|
|
8237
|
+
truncated: boolean;
|
|
8157
8238
|
} | {
|
|
8158
8239
|
data?: string;
|
|
8159
8240
|
/**
|
|
@@ -11397,6 +11478,31 @@ export interface components {
|
|
|
11397
11478
|
* @enum {string}
|
|
11398
11479
|
*/
|
|
11399
11480
|
DomainAttributeKey: "auto_renew_period" | "music_registrant_attestation" | "nic_it_compliance_confirmation" | "travel_industry_acknowledgement" | "verification_required" | "de_general_request_contact" | "de_abuse_contact" | "nor_id_applicant_version" | "nor_id_applicant_accept_name" | "nor_id_applicant_accept_date" | "nor_id_declaration" | "nor_id_declaration_token" | "punktum_dk_terms_acceptance" | "punktum_dk_tracking_no" | "internet_ee_registrant_agreement" | "promotion" | "promotion_eligibility" | "domain_contact_attributes" | "registry_reseller_id";
|
|
11481
|
+
/** DomainAuthCodeResponse */
|
|
11482
|
+
DomainAuthCodeResponse: {
|
|
11483
|
+
/**
|
|
11484
|
+
* Auth Code
|
|
11485
|
+
* @description The auth code, when `delivery` is `response`. Hidden when the caller cannot view the domain's auth codes
|
|
11486
|
+
*/
|
|
11487
|
+
auth_code?: string | null;
|
|
11488
|
+
/**
|
|
11489
|
+
* Auth Code Expires On
|
|
11490
|
+
* @description When the auth code expires, if the registry limits its validity
|
|
11491
|
+
*/
|
|
11492
|
+
auth_code_expires_on?: Date | null;
|
|
11493
|
+
/** @description Where the auth code ends up: `response` returns it in `auth_code`, `registrant_email` means the registry emails it to the registrant and it never reaches us */
|
|
11494
|
+
delivery: components["schemas"]["AuthCodeDelivery"];
|
|
11495
|
+
/**
|
|
11496
|
+
* Name
|
|
11497
|
+
* @description The domain name the auth code belongs to
|
|
11498
|
+
*/
|
|
11499
|
+
name: string;
|
|
11500
|
+
/**
|
|
11501
|
+
* Recipients
|
|
11502
|
+
* @description The addresses the registry sent the auth code to, when it reports them
|
|
11503
|
+
*/
|
|
11504
|
+
recipients?: string[] | null;
|
|
11505
|
+
};
|
|
11400
11506
|
/** DomainAvailability */
|
|
11401
11507
|
DomainAvailability: {
|
|
11402
11508
|
/** Domain */
|
|
@@ -26717,10 +26823,10 @@ export interface operations {
|
|
|
26717
26823
|
registrar_credential_id?: TypeId<"registrar_credential">[] | null;
|
|
26718
26824
|
/** @description Filter domains held at an external registrar by that registrar. Can be specified multiple times (union of all provided values); combined with `registrar_credential_id`, both must match. Matches exactly the domains whose `connected_account` field carries the registrar, so domains OpusDNS sponsors never match. */
|
|
26719
26825
|
registrar?: components["schemas"]["Registrar"][] | null;
|
|
26720
|
-
/** @description Filter domains by the type of the registry account they are held on: `ras` for domains on a registrar-abstraction (RAS) account synced from a connected external registrar, including those whose credential has since been deleted
|
|
26826
|
+
/** @description Filter domains by the type of the registry account they are held on: `ras` for domains on a registrar-abstraction (RAS) account synced from a connected external registrar, including those whose credential has since been deleted; `ams` for domains managed on a customer's own registry accreditation; `default` for all others, manually managed domains included (their accounts are typed `default`). Can be specified multiple times (union of all provided values). */
|
|
26721
26827
|
account_type?: components["schemas"]["ConnectedAccountType"][] | null;
|
|
26722
|
-
/** @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`
|
|
26723
|
-
account_type_mode?: components["schemas"]["
|
|
26828
|
+
/** @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`. */
|
|
26829
|
+
account_type_mode?: components["schemas"]["AccountTypeFilterMode"];
|
|
26724
26830
|
/** @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. */
|
|
26725
26831
|
include?: components["schemas"]["DomainListIncludeField"][] | null;
|
|
26726
26832
|
};
|
|
@@ -27013,7 +27119,12 @@ export interface operations {
|
|
|
27013
27119
|
};
|
|
27014
27120
|
get_domain_summary_v1_domains_summary_get: {
|
|
27015
27121
|
parameters: {
|
|
27016
|
-
query?:
|
|
27122
|
+
query?: {
|
|
27123
|
+
/** @description Filter domains by the type of the registry account they are held on: `ras` for domains on a registrar-abstraction (RAS) account synced from a connected external registrar, including those whose credential has since been deleted; `ams` for domains managed on a customer's own registry accreditation; `default` for all others, manually managed domains included (their accounts are typed `default`). Can be specified multiple times (union of all provided values). */
|
|
27124
|
+
account_type?: components["schemas"]["ConnectedAccountType"][] | null;
|
|
27125
|
+
/** @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`. */
|
|
27126
|
+
account_type_mode?: components["schemas"]["AccountTypeFilterMode"];
|
|
27127
|
+
};
|
|
27017
27128
|
header?: {
|
|
27018
27129
|
/**
|
|
27019
27130
|
* @description Accepted for backwards compatibility; has no effect. Response datetimes are always normalized to UTC and serialized as RFC 3339 with a `Z` suffix, whether or not this header is sent.
|
|
@@ -28373,6 +28484,105 @@ export interface operations {
|
|
|
28373
28484
|
};
|
|
28374
28485
|
};
|
|
28375
28486
|
};
|
|
28487
|
+
request_domain_auth_code_v1_domains__domain_reference__auth_code_post: {
|
|
28488
|
+
parameters: {
|
|
28489
|
+
query?: never;
|
|
28490
|
+
header?: {
|
|
28491
|
+
/**
|
|
28492
|
+
* @description Accepted for backwards compatibility; has no effect. Response datetimes are always normalized to UTC and serialized as RFC 3339 with a `Z` suffix, whether or not this header is sent.
|
|
28493
|
+
* @example rfc3339
|
|
28494
|
+
*/
|
|
28495
|
+
"X-Datetime-Format"?: components["parameters"]["DatetimeFormatHeader"];
|
|
28496
|
+
};
|
|
28497
|
+
path: {
|
|
28498
|
+
domain_reference: TypeId<"domain"> | string;
|
|
28499
|
+
};
|
|
28500
|
+
cookie?: never;
|
|
28501
|
+
};
|
|
28502
|
+
requestBody?: never;
|
|
28503
|
+
responses: {
|
|
28504
|
+
/** @description Successful Response */
|
|
28505
|
+
200: {
|
|
28506
|
+
headers: {
|
|
28507
|
+
[name: string]: unknown;
|
|
28508
|
+
};
|
|
28509
|
+
content: {
|
|
28510
|
+
"application/json": components["schemas"]["DomainAuthCodeResponse"];
|
|
28511
|
+
};
|
|
28512
|
+
};
|
|
28513
|
+
/** @description Bad Request */
|
|
28514
|
+
400: {
|
|
28515
|
+
headers: {
|
|
28516
|
+
[name: string]: unknown;
|
|
28517
|
+
};
|
|
28518
|
+
content: {
|
|
28519
|
+
/** @example {
|
|
28520
|
+
* "code": "ERROR_DOMAIN_TRANSFER",
|
|
28521
|
+
* "detail": "There was an error transferring the domain",
|
|
28522
|
+
* "domain_name": "Additional error context.",
|
|
28523
|
+
* "reason": "An unspecified error occurred",
|
|
28524
|
+
* "status": 400,
|
|
28525
|
+
* "title": "Domain Transfer Error",
|
|
28526
|
+
* "type": "domain-transfer"
|
|
28527
|
+
* } */
|
|
28528
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
28529
|
+
};
|
|
28530
|
+
};
|
|
28531
|
+
/** @description Not Found */
|
|
28532
|
+
404: {
|
|
28533
|
+
headers: {
|
|
28534
|
+
[name: string]: unknown;
|
|
28535
|
+
};
|
|
28536
|
+
content: {
|
|
28537
|
+
/** @example {
|
|
28538
|
+
* "code": "ERROR_DOMAIN_NOT_FOUND",
|
|
28539
|
+
* "detail": "Domain not found",
|
|
28540
|
+
* "domain_name": "Additional error context.",
|
|
28541
|
+
* "status": 404,
|
|
28542
|
+
* "title": "Domain Management Error",
|
|
28543
|
+
* "type": "domain-not-found"
|
|
28544
|
+
* } */
|
|
28545
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
28546
|
+
};
|
|
28547
|
+
};
|
|
28548
|
+
/** @description Unprocessable Content */
|
|
28549
|
+
422: {
|
|
28550
|
+
headers: {
|
|
28551
|
+
[name: string]: unknown;
|
|
28552
|
+
};
|
|
28553
|
+
content: {
|
|
28554
|
+
/** @example {
|
|
28555
|
+
* "code": "ERROR_DOMAIN_AUTH_CODE_NOT_SUPPORTED",
|
|
28556
|
+
* "detail": "Auth codes are not used",
|
|
28557
|
+
* "domain_name": "example.lu",
|
|
28558
|
+
* "status": 422,
|
|
28559
|
+
* "title": "Domain Management Error",
|
|
28560
|
+
* "tld": "lu",
|
|
28561
|
+
* "type": "domain-auth-code-not-supported"
|
|
28562
|
+
* } */
|
|
28563
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
28564
|
+
};
|
|
28565
|
+
};
|
|
28566
|
+
/** @description Bad Gateway */
|
|
28567
|
+
502: {
|
|
28568
|
+
headers: {
|
|
28569
|
+
[name: string]: unknown;
|
|
28570
|
+
};
|
|
28571
|
+
content: {
|
|
28572
|
+
/** @example {
|
|
28573
|
+
* "code": "ERROR_AUTH_CODE",
|
|
28574
|
+
* "detail": "The registry did not return an auth code",
|
|
28575
|
+
* "domain_name": "example.eu",
|
|
28576
|
+
* "reason": "No auth code returned",
|
|
28577
|
+
* "status": 502,
|
|
28578
|
+
* "title": "Domain Management Error",
|
|
28579
|
+
* "type": "domain-auth-code-unavailable"
|
|
28580
|
+
* } */
|
|
28581
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
28582
|
+
};
|
|
28583
|
+
};
|
|
28584
|
+
};
|
|
28585
|
+
};
|
|
28376
28586
|
get_dnssec_v1_domains__domain_reference__dnssec_get: {
|
|
28377
28587
|
parameters: {
|
|
28378
28588
|
query?: never;
|