@opusdns/api 1.86.0 → 1.88.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/src/helpers/constants.ts +11 -0
- package/src/helpers/keys.ts +20 -0
- package/src/helpers/requests.d.ts +8 -0
- package/src/helpers/responses.d.ts +14 -4
- package/src/helpers/schemas.d.ts +3 -0
- package/src/openapi.yaml +208 -11
- package/src/schema.d.ts +180 -11
package/package.json
CHANGED
package/src/helpers/constants.ts
CHANGED
|
@@ -71,6 +71,7 @@ import type {
|
|
|
71
71
|
OrganizationCredentialStatus,
|
|
72
72
|
OrganizationSortField,
|
|
73
73
|
OrganizationStatus,
|
|
74
|
+
OutboundTransferAction,
|
|
74
75
|
ParkingSortField,
|
|
75
76
|
PatchOp,
|
|
76
77
|
PeriodUnit,
|
|
@@ -1309,6 +1310,16 @@ export const ORGANIZATION_STATUS_VALUES = [
|
|
|
1309
1310
|
'inactive',
|
|
1310
1311
|
] as const satisfies ReadonlyArray<OrganizationStatus>;
|
|
1311
1312
|
|
|
1313
|
+
export const OUTBOUND_TRANSFER_ACTION = {
|
|
1314
|
+
APPROVE: "approve",
|
|
1315
|
+
REJECT: "reject",
|
|
1316
|
+
} as const satisfies Record<string, OutboundTransferAction>;
|
|
1317
|
+
|
|
1318
|
+
export const OUTBOUND_TRANSFER_ACTION_VALUES = [
|
|
1319
|
+
'approve',
|
|
1320
|
+
'reject',
|
|
1321
|
+
] as const satisfies ReadonlyArray<OutboundTransferAction>;
|
|
1322
|
+
|
|
1312
1323
|
export const PARKING_SORT_FIELD = {
|
|
1313
1324
|
DOMAIN: "domain",
|
|
1314
1325
|
CREATED_ON: "created_on",
|
package/src/helpers/keys.ts
CHANGED
|
@@ -304,6 +304,8 @@ import type {
|
|
|
304
304
|
OrganizationToken,
|
|
305
305
|
OrganizationUpdate,
|
|
306
306
|
OrganizationWithBillingData,
|
|
307
|
+
OutboundTransferRequest,
|
|
308
|
+
OutboundTransfer,
|
|
307
309
|
PageResponse_EmailForwardLog,
|
|
308
310
|
PageResponse_JobBatchMetadata,
|
|
309
311
|
PageResponse_Job,
|
|
@@ -1330,6 +1332,7 @@ export const KEY_DNS_CONFIGURATION_BASE_CZDS_AVAILABLE = 'czds_available' satisf
|
|
|
1330
1332
|
export const KEY_DNS_CONFIGURATION_BASE_DNSSEC_ALLOWED = 'dnssec_allowed' satisfies keyof DnsConfigurationBase;
|
|
1331
1333
|
export const KEY_DNS_CONFIGURATION_BASE_DNSSEC_MANDATORY = 'dnssec_mandatory' satisfies keyof DnsConfigurationBase;
|
|
1332
1334
|
export const KEY_DNS_CONFIGURATION_BASE_DNSSEC_MODE = 'dnssec_mode' satisfies keyof DnsConfigurationBase;
|
|
1335
|
+
export const KEY_DNS_CONFIGURATION_BASE_DNSSEC_SUBMIT_DIGEST_TYPES = 'dnssec_submit_digest_types' satisfies keyof DnsConfigurationBase;
|
|
1333
1336
|
export const KEY_DNS_CONFIGURATION_BASE_HOST_OBJECTS = 'host_objects' satisfies keyof DnsConfigurationBase;
|
|
1334
1337
|
export const KEY_DNS_CONFIGURATION_BASE_HOST_PARENT_CHECK_TLDS = 'host_parent_check_tlds' satisfies keyof DnsConfigurationBase;
|
|
1335
1338
|
export const KEY_DNS_CONFIGURATION_BASE_REGISTRY_NAMESERVER_CHECK = 'registry_nameserver_check' satisfies keyof DnsConfigurationBase;
|
|
@@ -1341,6 +1344,7 @@ export const KEYS_DNS_CONFIGURATION_BASE = [
|
|
|
1341
1344
|
KEY_DNS_CONFIGURATION_BASE_DNSSEC_ALLOWED,
|
|
1342
1345
|
KEY_DNS_CONFIGURATION_BASE_DNSSEC_MANDATORY,
|
|
1343
1346
|
KEY_DNS_CONFIGURATION_BASE_DNSSEC_MODE,
|
|
1347
|
+
KEY_DNS_CONFIGURATION_BASE_DNSSEC_SUBMIT_DIGEST_TYPES,
|
|
1344
1348
|
KEY_DNS_CONFIGURATION_BASE_HOST_OBJECTS,
|
|
1345
1349
|
KEY_DNS_CONFIGURATION_BASE_HOST_PARENT_CHECK_TLDS,
|
|
1346
1350
|
KEY_DNS_CONFIGURATION_BASE_REGISTRY_NAMESERVER_CHECK,
|
|
@@ -4279,6 +4283,22 @@ export const KEYS_ORGANIZATION_WITH_BILLING_DATA = [
|
|
|
4279
4283
|
KEY_ORGANIZATION_WITH_BILLING_DATA_USERS,
|
|
4280
4284
|
] as const satisfies (keyof OrganizationWithBillingData)[];
|
|
4281
4285
|
|
|
4286
|
+
export const KEY_OUTBOUND_TRANSFER_REQUEST_ACTION = 'action' satisfies keyof OutboundTransferRequest;
|
|
4287
|
+
|
|
4288
|
+
export const KEYS_OUTBOUND_TRANSFER_REQUEST = [
|
|
4289
|
+
KEY_OUTBOUND_TRANSFER_REQUEST_ACTION,
|
|
4290
|
+
] as const satisfies (keyof OutboundTransferRequest)[];
|
|
4291
|
+
|
|
4292
|
+
export const KEY_OUTBOUND_TRANSFER_ACTION = 'action' satisfies keyof OutboundTransfer;
|
|
4293
|
+
export const KEY_OUTBOUND_TRANSFER_DOMAIN_ID = 'domain_id' satisfies keyof OutboundTransfer;
|
|
4294
|
+
export const KEY_OUTBOUND_TRANSFER_DOMAIN_NAME = 'domain_name' satisfies keyof OutboundTransfer;
|
|
4295
|
+
|
|
4296
|
+
export const KEYS_OUTBOUND_TRANSFER = [
|
|
4297
|
+
KEY_OUTBOUND_TRANSFER_ACTION,
|
|
4298
|
+
KEY_OUTBOUND_TRANSFER_DOMAIN_ID,
|
|
4299
|
+
KEY_OUTBOUND_TRANSFER_DOMAIN_NAME,
|
|
4300
|
+
] as const satisfies (keyof OutboundTransfer)[];
|
|
4301
|
+
|
|
4282
4302
|
export const KEY_PAGE_RESPONSE_EMAIL_FORWARD_LOG_PAGINATION = 'pagination' satisfies keyof PageResponse_EmailForwardLog;
|
|
4283
4303
|
export const KEY_PAGE_RESPONSE_EMAIL_FORWARD_LOG_RESULTS = 'results' satisfies keyof PageResponse_EmailForwardLog;
|
|
4284
4304
|
|
|
@@ -44,6 +44,7 @@ import type {
|
|
|
44
44
|
OrganizationAttributeUpdate,
|
|
45
45
|
OrganizationCreate,
|
|
46
46
|
OrganizationUpdate,
|
|
47
|
+
OutboundTransferRequest,
|
|
47
48
|
ParkingSignupRequest,
|
|
48
49
|
PreviewMailReq,
|
|
49
50
|
PublicAuthRequestForm,
|
|
@@ -554,6 +555,13 @@ export type DELETE_DomainsByDomainReferenceTransfer_Request = {
|
|
|
554
555
|
};
|
|
555
556
|
export type DELETE_DomainsByDomainReferenceTransfer_Request_Path = DELETE_DomainsByDomainReferenceTransfer_Request['parameters']['path'];
|
|
556
557
|
|
|
558
|
+
export type POST_DomainsByDomainReferenceTransferOutbound_Request = {
|
|
559
|
+
parameters: operations['resolve_outbound_transfer_v1_domains__domain_reference__transfer_outbound_post']['parameters'];
|
|
560
|
+
requestBody: OutboundTransferRequest;
|
|
561
|
+
};
|
|
562
|
+
export type POST_DomainsByDomainReferenceTransferOutbound_Request_Path = POST_DomainsByDomainReferenceTransferOutbound_Request['parameters']['path'];
|
|
563
|
+
export type POST_DomainsByDomainReferenceTransferOutbound_Request_Body = POST_DomainsByDomainReferenceTransferOutbound_Request['requestBody'];
|
|
564
|
+
|
|
557
565
|
export type GET_DomainsCheck_Request = {
|
|
558
566
|
parameters: operations['epp_check_domain_v1_domains_check_get']['parameters'];
|
|
559
567
|
};
|
|
@@ -64,6 +64,7 @@ import type {
|
|
|
64
64
|
OrganizationAttribute2,
|
|
65
65
|
OrganizationCredential,
|
|
66
66
|
OrganizationWithBillingData,
|
|
67
|
+
OutboundTransfer,
|
|
67
68
|
PageResponse_EmailForwardLog,
|
|
68
69
|
PageResponse_Job,
|
|
69
70
|
PageResponse_JobBatchMetadata,
|
|
@@ -1092,11 +1093,12 @@ export type POST_DnsByZoneNameDnssecDisable_Response_200 = DnsChanges;
|
|
|
1092
1093
|
export type POST_DnsByZoneNameDnssecDisable_Response_400 = Problem;
|
|
1093
1094
|
export type POST_DnsByZoneNameDnssecDisable_Response_422 = HTTPValidationError;
|
|
1094
1095
|
|
|
1095
|
-
export type POST_DnsByZoneNameDnssecEnable_Response = POST_DnsByZoneNameDnssecEnable_Response_200 | POST_DnsByZoneNameDnssecEnable_Response_400 | POST_DnsByZoneNameDnssecEnable_Response_422;
|
|
1096
|
+
export type POST_DnsByZoneNameDnssecEnable_Response = POST_DnsByZoneNameDnssecEnable_Response_200 | POST_DnsByZoneNameDnssecEnable_Response_400 | POST_DnsByZoneNameDnssecEnable_Response_409 | POST_DnsByZoneNameDnssecEnable_Response_422;
|
|
1096
1097
|
|
|
1097
1098
|
export type POST_DnsByZoneNameDnssecEnable_Response_200 = DnsChanges;
|
|
1098
1099
|
export type POST_DnsByZoneNameDnssecEnable_Response_400 = Problem;
|
|
1099
|
-
export type
|
|
1100
|
+
export type POST_DnsByZoneNameDnssecEnable_Response_409 = Problem;
|
|
1101
|
+
export type POST_DnsByZoneNameDnssecEnable_Response_422 = Problem;
|
|
1100
1102
|
|
|
1101
1103
|
export type POST_DomainForwards_Response = POST_DomainForwards_Response_201 | POST_DomainForwards_Response_401 | POST_DomainForwards_Response_403 | POST_DomainForwards_Response_404 | POST_DomainForwards_Response_409 | POST_DomainForwards_Response_422;
|
|
1102
1104
|
|
|
@@ -1130,11 +1132,12 @@ export type POST_DomainsByDomainReferenceDnssecDisable_Response = POST_DomainsBy
|
|
|
1130
1132
|
export type POST_DomainsByDomainReferenceDnssecDisable_Response_404 = Problem;
|
|
1131
1133
|
export type POST_DomainsByDomainReferenceDnssecDisable_Response_422 = HTTPValidationError;
|
|
1132
1134
|
|
|
1133
|
-
export type POST_DomainsByDomainReferenceDnssecEnable_Response = POST_DomainsByDomainReferenceDnssecEnable_Response_200 | POST_DomainsByDomainReferenceDnssecEnable_Response_404 | POST_DomainsByDomainReferenceDnssecEnable_Response_422;
|
|
1135
|
+
export type POST_DomainsByDomainReferenceDnssecEnable_Response = POST_DomainsByDomainReferenceDnssecEnable_Response_200 | POST_DomainsByDomainReferenceDnssecEnable_Response_404 | POST_DomainsByDomainReferenceDnssecEnable_Response_409 | POST_DomainsByDomainReferenceDnssecEnable_Response_422;
|
|
1134
1136
|
|
|
1135
1137
|
export type POST_DomainsByDomainReferenceDnssecEnable_Response_200 = DomainDnssecData[];
|
|
1136
1138
|
export type POST_DomainsByDomainReferenceDnssecEnable_Response_404 = Problem;
|
|
1137
|
-
export type
|
|
1139
|
+
export type POST_DomainsByDomainReferenceDnssecEnable_Response_409 = Problem;
|
|
1140
|
+
export type POST_DomainsByDomainReferenceDnssecEnable_Response_422 = Problem;
|
|
1138
1141
|
|
|
1139
1142
|
export type POST_DomainsByDomainReferenceRenew_Response = POST_DomainsByDomainReferenceRenew_Response_200 | POST_DomainsByDomainReferenceRenew_Response_422;
|
|
1140
1143
|
|
|
@@ -1146,6 +1149,13 @@ export type POST_DomainsByDomainReferenceRestore_Response = POST_DomainsByDomain
|
|
|
1146
1149
|
export type POST_DomainsByDomainReferenceRestore_Response_200 = DomainRestore;
|
|
1147
1150
|
export type POST_DomainsByDomainReferenceRestore_Response_422 = HTTPValidationError;
|
|
1148
1151
|
|
|
1152
|
+
export type POST_DomainsByDomainReferenceTransferOutbound_Response = POST_DomainsByDomainReferenceTransferOutbound_Response_200 | POST_DomainsByDomainReferenceTransferOutbound_Response_400 | POST_DomainsByDomainReferenceTransferOutbound_Response_404 | POST_DomainsByDomainReferenceTransferOutbound_Response_422;
|
|
1153
|
+
|
|
1154
|
+
export type POST_DomainsByDomainReferenceTransferOutbound_Response_200 = OutboundTransfer;
|
|
1155
|
+
export type POST_DomainsByDomainReferenceTransferOutbound_Response_400 = Problem;
|
|
1156
|
+
export type POST_DomainsByDomainReferenceTransferOutbound_Response_404 = Problem;
|
|
1157
|
+
export type POST_DomainsByDomainReferenceTransferOutbound_Response_422 = Problem;
|
|
1158
|
+
|
|
1149
1159
|
export type POST_DomainsClaimsNotices_Response = POST_DomainsClaimsNotices_Response_200 | POST_DomainsClaimsNotices_Response_404 | POST_DomainsClaimsNotices_Response_422 | POST_DomainsClaimsNotices_Response_503;
|
|
1150
1160
|
|
|
1151
1161
|
export type POST_DomainsClaimsNotices_Response_200 = ClaimsNotices;
|
package/src/helpers/schemas.d.ts
CHANGED
|
@@ -382,6 +382,9 @@ export type OrganizationStatus = components['schemas']['OrganizationStatus'];
|
|
|
382
382
|
export type OrganizationToken = components['schemas']['OrganizationTokenResponse'];
|
|
383
383
|
export type OrganizationUpdate = components['schemas']['OrganizationUpdate'];
|
|
384
384
|
export type OrganizationWithBillingData = components['schemas']['OrganizationWithBillingData'];
|
|
385
|
+
export type OutboundTransferAction = components['schemas']['OutboundTransferAction'];
|
|
386
|
+
export type OutboundTransferRequest = components['schemas']['OutboundTransferRequest'];
|
|
387
|
+
export type OutboundTransfer = components['schemas']['OutboundTransferResponse'];
|
|
385
388
|
export type PageResponse_EmailForwardLog = components['schemas']['PageResponse_EmailForwardLog_'];
|
|
386
389
|
export type PageResponse_JobBatchMetadata = components['schemas']['PageResponse_JobBatchMetadataResponse_'];
|
|
387
390
|
export type PageResponse_Job = components['schemas']['PageResponse_JobResponse_'];
|
package/src/openapi.yaml
CHANGED
|
@@ -2547,6 +2547,19 @@ components:
|
|
|
2547
2547
|
- $ref: '#/components/schemas/DnssecModeType'
|
|
2548
2548
|
- type: 'null'
|
|
2549
2549
|
description: DNSSEC mode
|
|
2550
|
+
dnssec_submit_digest_types:
|
|
2551
|
+
anyOf:
|
|
2552
|
+
- items:
|
|
2553
|
+
type: integer
|
|
2554
|
+
minItems: 1
|
|
2555
|
+
type: array
|
|
2556
|
+
- type: 'null'
|
|
2557
|
+
description: 'Which DS digest types we submit to the registry for zones
|
|
2558
|
+
we host, in order of preference: the first listed type the zone has a
|
|
2559
|
+
DS record for is submitted, later entries are fallbacks. Absent means
|
|
2560
|
+
submit every digest type the zone publishes. This is our submission policy,
|
|
2561
|
+
not the set of digest types the registry accepts.'
|
|
2562
|
+
title: Dnssec Submit Digest Types
|
|
2550
2563
|
host_objects:
|
|
2551
2564
|
description: Whether the registry supports host objects or use attributes
|
|
2552
2565
|
title: Host Objects
|
|
@@ -10257,6 +10270,45 @@ components:
|
|
|
10257
10270
|
- name
|
|
10258
10271
|
title: OrganizationWithBillingData
|
|
10259
10272
|
type: object
|
|
10273
|
+
OutboundTransferAction:
|
|
10274
|
+
enum:
|
|
10275
|
+
- approve
|
|
10276
|
+
- reject
|
|
10277
|
+
title: OutboundTransferAction
|
|
10278
|
+
type: string
|
|
10279
|
+
OutboundTransferRequest:
|
|
10280
|
+
properties:
|
|
10281
|
+
action:
|
|
10282
|
+
$ref: '#/components/schemas/OutboundTransferAction'
|
|
10283
|
+
description: Whether to approve or reject the pending outbound transfer
|
|
10284
|
+
required:
|
|
10285
|
+
- action
|
|
10286
|
+
title: OutboundTransferRequest
|
|
10287
|
+
type: object
|
|
10288
|
+
OutboundTransferResponse:
|
|
10289
|
+
properties:
|
|
10290
|
+
action:
|
|
10291
|
+
$ref: '#/components/schemas/OutboundTransferAction'
|
|
10292
|
+
description: The action that was applied to the outbound transfer
|
|
10293
|
+
domain_id:
|
|
10294
|
+
description: The ID of the domain whose outbound transfer was resolved
|
|
10295
|
+
examples:
|
|
10296
|
+
- domain_01h45ytscbebyvny4gc8cr8ma2
|
|
10297
|
+
format: typeid
|
|
10298
|
+
pattern: ^domain_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
10299
|
+
title: Domain Id
|
|
10300
|
+
type: string
|
|
10301
|
+
x-typeid-prefix: domain
|
|
10302
|
+
domain_name:
|
|
10303
|
+
description: The name of the domain whose outbound transfer was resolved
|
|
10304
|
+
title: Domain Name
|
|
10305
|
+
type: string
|
|
10306
|
+
required:
|
|
10307
|
+
- domain_id
|
|
10308
|
+
- domain_name
|
|
10309
|
+
- action
|
|
10310
|
+
title: OutboundTransferResponse
|
|
10311
|
+
type: object
|
|
10260
10312
|
PageResponse_EmailForwardLog_:
|
|
10261
10313
|
properties:
|
|
10262
10314
|
pagination:
|
|
@@ -14882,7 +14934,7 @@ info:
|
|
|
14882
14934
|
\n\n"
|
|
14883
14935
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
14884
14936
|
title: OpusDNS API
|
|
14885
|
-
version: 2026-07-
|
|
14937
|
+
version: 2026-07-29-143904
|
|
14886
14938
|
x-logo:
|
|
14887
14939
|
altText: OpusDNS API Reference
|
|
14888
14940
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -19292,12 +19344,35 @@ paths:
|
|
|
19292
19344
|
schema:
|
|
19293
19345
|
$ref: '#/components/schemas/Problem'
|
|
19294
19346
|
description: Bad Request
|
|
19347
|
+
'409':
|
|
19348
|
+
content:
|
|
19349
|
+
application/problem+json:
|
|
19350
|
+
example:
|
|
19351
|
+
code: ERROR_DOMAIN_DNSSEC_ZONE_RECORDS_UNAVAILABLE
|
|
19352
|
+
detail: DNS zone 'example.com.' is DNSSEC-enabled but has no usable
|
|
19353
|
+
DS records to publish
|
|
19354
|
+
status: 409
|
|
19355
|
+
title: DNSSEC Zone Records Unavailable
|
|
19356
|
+
type: domain-dnssec-zone-records-unavailable
|
|
19357
|
+
zone_name: example.com.
|
|
19358
|
+
schema:
|
|
19359
|
+
$ref: '#/components/schemas/Problem'
|
|
19360
|
+
description: Conflict
|
|
19295
19361
|
'422':
|
|
19296
19362
|
content:
|
|
19297
19363
|
application/problem+json:
|
|
19364
|
+
example:
|
|
19365
|
+
code: ERROR_DOMAIN_DNSSEC_DIGEST_POLICY
|
|
19366
|
+
detail: The DNS zone publishes DS digest type(s) [4], but only digest
|
|
19367
|
+
type(s) [2] can be submitted for TLD 'it'
|
|
19368
|
+
domain_name: example.it
|
|
19369
|
+
status: 422
|
|
19370
|
+
title: DNSSEC Digest Policy Error
|
|
19371
|
+
tld: it
|
|
19372
|
+
type: domain-dnssec-digest-policy
|
|
19298
19373
|
schema:
|
|
19299
|
-
$ref: '#/components/schemas/
|
|
19300
|
-
description:
|
|
19374
|
+
$ref: '#/components/schemas/Problem'
|
|
19375
|
+
description: Unprocessable Content
|
|
19301
19376
|
security:
|
|
19302
19377
|
- OAuth2PasswordBearer: []
|
|
19303
19378
|
- APIKeyHeader: []
|
|
@@ -24253,12 +24328,22 @@ paths:
|
|
|
24253
24328
|
'422':
|
|
24254
24329
|
content:
|
|
24255
24330
|
application/problem+json:
|
|
24256
|
-
|
|
24257
|
-
|
|
24258
|
-
|
|
24259
|
-
|
|
24260
|
-
|
|
24261
|
-
|
|
24331
|
+
examples:
|
|
24332
|
+
Domain Management Error:
|
|
24333
|
+
value:
|
|
24334
|
+
code: ERROR_DOMAIN_DNSSEC_NOT_SUPPORTED
|
|
24335
|
+
detail: DNSSEC not supported for this TLD
|
|
24336
|
+
domain_name: Additional error context.
|
|
24337
|
+
status: 422
|
|
24338
|
+
title: Domain Management Error
|
|
24339
|
+
type: domain-dnssec-not-supported
|
|
24340
|
+
Policy Validation Error:
|
|
24341
|
+
value:
|
|
24342
|
+
code: ERROR_POLICY_VALIDATION
|
|
24343
|
+
detail: Additional error context.
|
|
24344
|
+
status: 422
|
|
24345
|
+
title: Policy Validation Error
|
|
24346
|
+
type: policy-validation-error
|
|
24262
24347
|
schema:
|
|
24263
24348
|
$ref: '#/components/schemas/Problem'
|
|
24264
24349
|
description: Unprocessable Content
|
|
@@ -24360,12 +24445,45 @@ paths:
|
|
|
24360
24445
|
schema:
|
|
24361
24446
|
$ref: '#/components/schemas/Problem'
|
|
24362
24447
|
description: Not Found
|
|
24448
|
+
'409':
|
|
24449
|
+
content:
|
|
24450
|
+
application/problem+json:
|
|
24451
|
+
example:
|
|
24452
|
+
code: ERROR_DOMAIN_DNSSEC_ZONE_RECORDS_UNAVAILABLE
|
|
24453
|
+
detail: DNS zone 'example.com.' is DNSSEC-enabled but has no usable
|
|
24454
|
+
DS records to publish
|
|
24455
|
+
status: 409
|
|
24456
|
+
title: DNSSEC Zone Records Unavailable
|
|
24457
|
+
type: domain-dnssec-zone-records-unavailable
|
|
24458
|
+
zone_name: example.com.
|
|
24459
|
+
schema:
|
|
24460
|
+
$ref: '#/components/schemas/Problem'
|
|
24461
|
+
description: Conflict
|
|
24363
24462
|
'422':
|
|
24364
24463
|
content:
|
|
24365
24464
|
application/problem+json:
|
|
24465
|
+
examples:
|
|
24466
|
+
DNSSEC Digest Policy Error:
|
|
24467
|
+
value:
|
|
24468
|
+
code: ERROR_DOMAIN_DNSSEC_DIGEST_POLICY
|
|
24469
|
+
detail: The DNS zone publishes DS digest type(s) [4], but only
|
|
24470
|
+
digest type(s) [2] can be submitted for TLD 'it'
|
|
24471
|
+
domain_name: example.it
|
|
24472
|
+
status: 422
|
|
24473
|
+
title: DNSSEC Digest Policy Error
|
|
24474
|
+
tld: it
|
|
24475
|
+
type: domain-dnssec-digest-policy
|
|
24476
|
+
Domain Management Error:
|
|
24477
|
+
value:
|
|
24478
|
+
code: ERROR_DOMAIN_DNSSEC_NOT_SUPPORTED
|
|
24479
|
+
detail: DNSSEC not supported for this TLD
|
|
24480
|
+
domain_name: Additional error context.
|
|
24481
|
+
status: 422
|
|
24482
|
+
title: Domain Management Error
|
|
24483
|
+
type: domain-dnssec-not-supported
|
|
24366
24484
|
schema:
|
|
24367
|
-
$ref: '#/components/schemas/
|
|
24368
|
-
description:
|
|
24485
|
+
$ref: '#/components/schemas/Problem'
|
|
24486
|
+
description: Unprocessable Content
|
|
24369
24487
|
security:
|
|
24370
24488
|
- OAuth2PasswordBearer: []
|
|
24371
24489
|
- APIKeyHeader: []
|
|
@@ -24532,6 +24650,85 @@ paths:
|
|
|
24532
24650
|
- domain
|
|
24533
24651
|
x-required-permissions:
|
|
24534
24652
|
- domains:manage
|
|
24653
|
+
/v1/domains/{domain_reference}/transfer/outbound:
|
|
24654
|
+
post:
|
|
24655
|
+
operationId: resolve_outbound_transfer_v1_domains__domain_reference__transfer_outbound_post
|
|
24656
|
+
parameters:
|
|
24657
|
+
- in: path
|
|
24658
|
+
name: domain_reference
|
|
24659
|
+
required: true
|
|
24660
|
+
schema:
|
|
24661
|
+
anyOf:
|
|
24662
|
+
- examples:
|
|
24663
|
+
- domain_01h45ytscbebyvny4gc8cr8ma2
|
|
24664
|
+
format: typeid
|
|
24665
|
+
pattern: ^domain_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
24666
|
+
type: string
|
|
24667
|
+
x-typeid-prefix: domain
|
|
24668
|
+
- type: string
|
|
24669
|
+
title: Domain Reference
|
|
24670
|
+
- $ref: '#/components/parameters/DatetimeFormatHeader'
|
|
24671
|
+
requestBody:
|
|
24672
|
+
content:
|
|
24673
|
+
application/json:
|
|
24674
|
+
schema:
|
|
24675
|
+
$ref: '#/components/schemas/OutboundTransferRequest'
|
|
24676
|
+
required: true
|
|
24677
|
+
responses:
|
|
24678
|
+
'200':
|
|
24679
|
+
content:
|
|
24680
|
+
application/json:
|
|
24681
|
+
schema:
|
|
24682
|
+
$ref: '#/components/schemas/OutboundTransferResponse'
|
|
24683
|
+
description: Successful Response
|
|
24684
|
+
'400':
|
|
24685
|
+
content:
|
|
24686
|
+
application/problem+json:
|
|
24687
|
+
example:
|
|
24688
|
+
code: ERROR_DOMAIN_TRANSFER
|
|
24689
|
+
detail: There was an error transferring the domain
|
|
24690
|
+
domain_name: Additional error context.
|
|
24691
|
+
reason: An unspecified error occurred
|
|
24692
|
+
status: 400
|
|
24693
|
+
title: Domain Transfer Error
|
|
24694
|
+
type: domain-transfer
|
|
24695
|
+
schema:
|
|
24696
|
+
$ref: '#/components/schemas/Problem'
|
|
24697
|
+
description: Bad Request
|
|
24698
|
+
'404':
|
|
24699
|
+
content:
|
|
24700
|
+
application/problem+json:
|
|
24701
|
+
example:
|
|
24702
|
+
code: ERROR_DOMAIN_NOT_FOUND
|
|
24703
|
+
detail: Domain not found
|
|
24704
|
+
domain_name: Additional error context.
|
|
24705
|
+
status: 404
|
|
24706
|
+
title: Domain Management Error
|
|
24707
|
+
type: domain-not-found
|
|
24708
|
+
schema:
|
|
24709
|
+
$ref: '#/components/schemas/Problem'
|
|
24710
|
+
description: Not Found
|
|
24711
|
+
'422':
|
|
24712
|
+
content:
|
|
24713
|
+
application/problem+json:
|
|
24714
|
+
example:
|
|
24715
|
+
code: ERROR_REGISTRY_POLICY
|
|
24716
|
+
detail: The registry rejected the request due to a policy violation
|
|
24717
|
+
domain_name: Additional error context.
|
|
24718
|
+
status: 422
|
|
24719
|
+
title: Registry Policy Error
|
|
24720
|
+
type: domain-registry-policy
|
|
24721
|
+
schema:
|
|
24722
|
+
$ref: '#/components/schemas/Problem'
|
|
24723
|
+
description: Unprocessable Content
|
|
24724
|
+
security:
|
|
24725
|
+
- OAuth2PasswordBearer: []
|
|
24726
|
+
- APIKeyHeader: []
|
|
24727
|
+
summary: Approve or reject an outbound domain transfer
|
|
24728
|
+
tags:
|
|
24729
|
+
- domain
|
|
24730
|
+
x-required-permissions:
|
|
24731
|
+
- domains:manage
|
|
24535
24732
|
/v1/email-forwards:
|
|
24536
24733
|
get:
|
|
24537
24734
|
description: Retrieves a paginated list of all email forwards for the organization.
|
package/src/schema.d.ts
CHANGED
|
@@ -1501,6 +1501,23 @@ export interface paths {
|
|
|
1501
1501
|
patch?: never;
|
|
1502
1502
|
trace?: never;
|
|
1503
1503
|
};
|
|
1504
|
+
"/v1/domains/{domain_reference}/transfer/outbound": {
|
|
1505
|
+
parameters: {
|
|
1506
|
+
query?: never;
|
|
1507
|
+
header?: never;
|
|
1508
|
+
path?: never;
|
|
1509
|
+
cookie?: never;
|
|
1510
|
+
};
|
|
1511
|
+
get?: never;
|
|
1512
|
+
put?: never;
|
|
1513
|
+
/** Approve or reject an outbound domain transfer */
|
|
1514
|
+
post: operations["resolve_outbound_transfer_v1_domains__domain_reference__transfer_outbound_post"];
|
|
1515
|
+
delete?: never;
|
|
1516
|
+
options?: never;
|
|
1517
|
+
head?: never;
|
|
1518
|
+
patch?: never;
|
|
1519
|
+
trace?: never;
|
|
1520
|
+
};
|
|
1504
1521
|
"/v1/email-forwards": {
|
|
1505
1522
|
parameters: {
|
|
1506
1523
|
query?: never;
|
|
@@ -4586,6 +4603,11 @@ export interface components {
|
|
|
4586
4603
|
dnssec_mandatory?: boolean | null;
|
|
4587
4604
|
/** @description DNSSEC mode */
|
|
4588
4605
|
dnssec_mode?: components["schemas"]["DnssecModeType"] | null;
|
|
4606
|
+
/**
|
|
4607
|
+
* Dnssec Submit Digest Types
|
|
4608
|
+
* @description Which DS digest types we submit to the registry for zones we host, in order of preference: the first listed type the zone has a DS record for is submitted, later entries are fallbacks. Absent means submit every digest type the zone publishes. This is our submission policy, not the set of digest types the registry accepts.
|
|
4609
|
+
*/
|
|
4610
|
+
dnssec_submit_digest_types?: number[] | null;
|
|
4589
4611
|
/**
|
|
4590
4612
|
* Host Objects
|
|
4591
4613
|
* @description Whether the registry supports host objects or use attributes
|
|
@@ -9717,6 +9739,33 @@ export interface components {
|
|
|
9717
9739
|
/** Users */
|
|
9718
9740
|
users?: components["schemas"]["User"][];
|
|
9719
9741
|
};
|
|
9742
|
+
/**
|
|
9743
|
+
* OutboundTransferAction
|
|
9744
|
+
* @enum {string}
|
|
9745
|
+
*/
|
|
9746
|
+
OutboundTransferAction: "approve" | "reject";
|
|
9747
|
+
/** OutboundTransferRequest */
|
|
9748
|
+
OutboundTransferRequest: {
|
|
9749
|
+
/** @description Whether to approve or reject the pending outbound transfer */
|
|
9750
|
+
action: components["schemas"]["OutboundTransferAction"];
|
|
9751
|
+
};
|
|
9752
|
+
/** OutboundTransferResponse */
|
|
9753
|
+
OutboundTransferResponse: {
|
|
9754
|
+
/** @description The action that was applied to the outbound transfer */
|
|
9755
|
+
action: components["schemas"]["OutboundTransferAction"];
|
|
9756
|
+
/**
|
|
9757
|
+
* Domain Id
|
|
9758
|
+
* Format: typeid
|
|
9759
|
+
* @description The ID of the domain whose outbound transfer was resolved
|
|
9760
|
+
* @example domain_01h45ytscbebyvny4gc8cr8ma2
|
|
9761
|
+
*/
|
|
9762
|
+
domain_id: TypeId<"domain">;
|
|
9763
|
+
/**
|
|
9764
|
+
* Domain Name
|
|
9765
|
+
* @description The name of the domain whose outbound transfer was resolved
|
|
9766
|
+
*/
|
|
9767
|
+
domain_name: string;
|
|
9768
|
+
};
|
|
9720
9769
|
/** PageResponse[EmailForwardLog] */
|
|
9721
9770
|
PageResponse_EmailForwardLog_: {
|
|
9722
9771
|
pagination: components["schemas"]["PaginationMetadata"];
|
|
@@ -16266,13 +16315,39 @@ export interface operations {
|
|
|
16266
16315
|
"application/problem+json": components["schemas"]["Problem"];
|
|
16267
16316
|
};
|
|
16268
16317
|
};
|
|
16269
|
-
/** @description
|
|
16318
|
+
/** @description Conflict */
|
|
16319
|
+
409: {
|
|
16320
|
+
headers: {
|
|
16321
|
+
[name: string]: unknown;
|
|
16322
|
+
};
|
|
16323
|
+
content: {
|
|
16324
|
+
/** @example {
|
|
16325
|
+
* "code": "ERROR_DOMAIN_DNSSEC_ZONE_RECORDS_UNAVAILABLE",
|
|
16326
|
+
* "detail": "DNS zone 'example.com.' is DNSSEC-enabled but has no usable DS records to publish",
|
|
16327
|
+
* "status": 409,
|
|
16328
|
+
* "title": "DNSSEC Zone Records Unavailable",
|
|
16329
|
+
* "type": "domain-dnssec-zone-records-unavailable",
|
|
16330
|
+
* "zone_name": "example.com."
|
|
16331
|
+
* } */
|
|
16332
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
16333
|
+
};
|
|
16334
|
+
};
|
|
16335
|
+
/** @description Unprocessable Content */
|
|
16270
16336
|
422: {
|
|
16271
16337
|
headers: {
|
|
16272
16338
|
[name: string]: unknown;
|
|
16273
16339
|
};
|
|
16274
16340
|
content: {
|
|
16275
|
-
|
|
16341
|
+
/** @example {
|
|
16342
|
+
* "code": "ERROR_DOMAIN_DNSSEC_DIGEST_POLICY",
|
|
16343
|
+
* "detail": "The DNS zone publishes DS digest type(s) [4], but only digest type(s) [2] can be submitted for TLD 'it'",
|
|
16344
|
+
* "domain_name": "example.it",
|
|
16345
|
+
* "status": 422,
|
|
16346
|
+
* "title": "DNSSEC Digest Policy Error",
|
|
16347
|
+
* "tld": "it",
|
|
16348
|
+
* "type": "domain-dnssec-digest-policy"
|
|
16349
|
+
* } */
|
|
16350
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
16276
16351
|
};
|
|
16277
16352
|
};
|
|
16278
16353
|
};
|
|
@@ -19978,13 +20053,6 @@ export interface operations {
|
|
|
19978
20053
|
[name: string]: unknown;
|
|
19979
20054
|
};
|
|
19980
20055
|
content: {
|
|
19981
|
-
/** @example {
|
|
19982
|
-
* "code": "ERROR_POLICY_VALIDATION",
|
|
19983
|
-
* "detail": "Additional error context.",
|
|
19984
|
-
* "status": 422,
|
|
19985
|
-
* "title": "Policy Validation Error",
|
|
19986
|
-
* "type": "policy-validation-error"
|
|
19987
|
-
* } */
|
|
19988
20056
|
"application/problem+json": components["schemas"]["Problem"];
|
|
19989
20057
|
};
|
|
19990
20058
|
};
|
|
@@ -20137,13 +20205,30 @@ export interface operations {
|
|
|
20137
20205
|
"application/problem+json": components["schemas"]["Problem"];
|
|
20138
20206
|
};
|
|
20139
20207
|
};
|
|
20140
|
-
/** @description
|
|
20208
|
+
/** @description Conflict */
|
|
20209
|
+
409: {
|
|
20210
|
+
headers: {
|
|
20211
|
+
[name: string]: unknown;
|
|
20212
|
+
};
|
|
20213
|
+
content: {
|
|
20214
|
+
/** @example {
|
|
20215
|
+
* "code": "ERROR_DOMAIN_DNSSEC_ZONE_RECORDS_UNAVAILABLE",
|
|
20216
|
+
* "detail": "DNS zone 'example.com.' is DNSSEC-enabled but has no usable DS records to publish",
|
|
20217
|
+
* "status": 409,
|
|
20218
|
+
* "title": "DNSSEC Zone Records Unavailable",
|
|
20219
|
+
* "type": "domain-dnssec-zone-records-unavailable",
|
|
20220
|
+
* "zone_name": "example.com."
|
|
20221
|
+
* } */
|
|
20222
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
20223
|
+
};
|
|
20224
|
+
};
|
|
20225
|
+
/** @description Unprocessable Content */
|
|
20141
20226
|
422: {
|
|
20142
20227
|
headers: {
|
|
20143
20228
|
[name: string]: unknown;
|
|
20144
20229
|
};
|
|
20145
20230
|
content: {
|
|
20146
|
-
"application/problem+json": components["schemas"]["
|
|
20231
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
20147
20232
|
};
|
|
20148
20233
|
};
|
|
20149
20234
|
};
|
|
@@ -20300,6 +20385,90 @@ export interface operations {
|
|
|
20300
20385
|
};
|
|
20301
20386
|
};
|
|
20302
20387
|
};
|
|
20388
|
+
resolve_outbound_transfer_v1_domains__domain_reference__transfer_outbound_post: {
|
|
20389
|
+
parameters: {
|
|
20390
|
+
query?: never;
|
|
20391
|
+
header?: {
|
|
20392
|
+
/**
|
|
20393
|
+
* @description Opt in to RFC 3339 datetime serialization. When set to `rfc3339`, response datetimes are normalized to UTC and serialized with a `Z` suffix. This is opt-in until the announced default cutover date, after which RFC 3339 becomes the default and this header is accepted as a no-op. Any other value or omission uses the current default serialization.
|
|
20394
|
+
* @example rfc3339
|
|
20395
|
+
*/
|
|
20396
|
+
"X-Datetime-Format"?: components["parameters"]["DatetimeFormatHeader"];
|
|
20397
|
+
};
|
|
20398
|
+
path: {
|
|
20399
|
+
domain_reference: TypeId<"domain"> | string;
|
|
20400
|
+
};
|
|
20401
|
+
cookie?: never;
|
|
20402
|
+
};
|
|
20403
|
+
requestBody: {
|
|
20404
|
+
content: {
|
|
20405
|
+
"application/json": components["schemas"]["OutboundTransferRequest"];
|
|
20406
|
+
};
|
|
20407
|
+
};
|
|
20408
|
+
responses: {
|
|
20409
|
+
/** @description Successful Response */
|
|
20410
|
+
200: {
|
|
20411
|
+
headers: {
|
|
20412
|
+
[name: string]: unknown;
|
|
20413
|
+
};
|
|
20414
|
+
content: {
|
|
20415
|
+
"application/json": components["schemas"]["OutboundTransferResponse"];
|
|
20416
|
+
};
|
|
20417
|
+
};
|
|
20418
|
+
/** @description Bad Request */
|
|
20419
|
+
400: {
|
|
20420
|
+
headers: {
|
|
20421
|
+
[name: string]: unknown;
|
|
20422
|
+
};
|
|
20423
|
+
content: {
|
|
20424
|
+
/** @example {
|
|
20425
|
+
* "code": "ERROR_DOMAIN_TRANSFER",
|
|
20426
|
+
* "detail": "There was an error transferring the domain",
|
|
20427
|
+
* "domain_name": "Additional error context.",
|
|
20428
|
+
* "reason": "An unspecified error occurred",
|
|
20429
|
+
* "status": 400,
|
|
20430
|
+
* "title": "Domain Transfer Error",
|
|
20431
|
+
* "type": "domain-transfer"
|
|
20432
|
+
* } */
|
|
20433
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
20434
|
+
};
|
|
20435
|
+
};
|
|
20436
|
+
/** @description Not Found */
|
|
20437
|
+
404: {
|
|
20438
|
+
headers: {
|
|
20439
|
+
[name: string]: unknown;
|
|
20440
|
+
};
|
|
20441
|
+
content: {
|
|
20442
|
+
/** @example {
|
|
20443
|
+
* "code": "ERROR_DOMAIN_NOT_FOUND",
|
|
20444
|
+
* "detail": "Domain not found",
|
|
20445
|
+
* "domain_name": "Additional error context.",
|
|
20446
|
+
* "status": 404,
|
|
20447
|
+
* "title": "Domain Management Error",
|
|
20448
|
+
* "type": "domain-not-found"
|
|
20449
|
+
* } */
|
|
20450
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
20451
|
+
};
|
|
20452
|
+
};
|
|
20453
|
+
/** @description Unprocessable Content */
|
|
20454
|
+
422: {
|
|
20455
|
+
headers: {
|
|
20456
|
+
[name: string]: unknown;
|
|
20457
|
+
};
|
|
20458
|
+
content: {
|
|
20459
|
+
/** @example {
|
|
20460
|
+
* "code": "ERROR_REGISTRY_POLICY",
|
|
20461
|
+
* "detail": "The registry rejected the request due to a policy violation",
|
|
20462
|
+
* "domain_name": "Additional error context.",
|
|
20463
|
+
* "status": 422,
|
|
20464
|
+
* "title": "Registry Policy Error",
|
|
20465
|
+
* "type": "domain-registry-policy"
|
|
20466
|
+
* } */
|
|
20467
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
20468
|
+
};
|
|
20469
|
+
};
|
|
20470
|
+
};
|
|
20471
|
+
};
|
|
20303
20472
|
list_email_forwards_v1_email_forwards_get: {
|
|
20304
20473
|
parameters: {
|
|
20305
20474
|
query?: {
|