@opusdns/api 1.102.0 → 1.104.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 +15 -0
- package/src/helpers/requests.d.ts +5 -0
- package/src/helpers/responses.d.ts +8 -0
- package/src/helpers/schemas.d.ts +1 -0
- package/src/openapi.yaml +105 -1
- package/src/schema.d.ts +120 -0
package/package.json
CHANGED
package/src/helpers/keys.ts
CHANGED
|
@@ -438,6 +438,7 @@ import type {
|
|
|
438
438
|
RequestAuthcode2,
|
|
439
439
|
RequestAuthcode3,
|
|
440
440
|
RequestAuthcode4,
|
|
441
|
+
RequestAuthcode5,
|
|
441
442
|
DomainAvailabilityList,
|
|
442
443
|
DomainAvailabilityCheck,
|
|
443
444
|
} from './schemas';
|
|
@@ -2922,10 +2923,12 @@ export const KEYS_DOMAIN_WITHDRAW_REQUEST = [
|
|
|
2922
2923
|
KEY_DOMAIN_WITHDRAW_REQUEST_ZONE_DELETE,
|
|
2923
2924
|
] as const satisfies (keyof DomainWithdrawRequest)[];
|
|
2924
2925
|
|
|
2926
|
+
export const KEY_DOMAIN_WITHDRAW_DETAIL = 'detail' satisfies keyof DomainWithdraw;
|
|
2925
2927
|
export const KEY_DOMAIN_WITHDRAW_NAME = 'name' satisfies keyof DomainWithdraw;
|
|
2926
2928
|
export const KEY_DOMAIN_WITHDRAW_SUCCESS = 'success' satisfies keyof DomainWithdraw;
|
|
2927
2929
|
|
|
2928
2930
|
export const KEYS_DOMAIN_WITHDRAW = [
|
|
2931
|
+
KEY_DOMAIN_WITHDRAW_DETAIL,
|
|
2929
2932
|
KEY_DOMAIN_WITHDRAW_NAME,
|
|
2930
2933
|
KEY_DOMAIN_WITHDRAW_SUCCESS,
|
|
2931
2934
|
] as const satisfies (keyof DomainWithdraw)[];
|
|
@@ -5926,6 +5929,18 @@ export const KEYS_REQUEST_AUTHCODE4 = [
|
|
|
5926
5929
|
KEY_REQUEST_AUTHCODE4_SUCCESS,
|
|
5927
5930
|
] as const satisfies (keyof RequestAuthcode4)[];
|
|
5928
5931
|
|
|
5932
|
+
export const KEY_REQUEST_AUTHCODE5_AUTH_CODE = 'auth_code' satisfies keyof RequestAuthcode5;
|
|
5933
|
+
export const KEY_REQUEST_AUTHCODE5_DETAIL = 'detail' satisfies keyof RequestAuthcode5;
|
|
5934
|
+
export const KEY_REQUEST_AUTHCODE5_NAME = 'name' satisfies keyof RequestAuthcode5;
|
|
5935
|
+
export const KEY_REQUEST_AUTHCODE5_SUCCESS = 'success' satisfies keyof RequestAuthcode5;
|
|
5936
|
+
|
|
5937
|
+
export const KEYS_REQUEST_AUTHCODE5 = [
|
|
5938
|
+
KEY_REQUEST_AUTHCODE5_AUTH_CODE,
|
|
5939
|
+
KEY_REQUEST_AUTHCODE5_DETAIL,
|
|
5940
|
+
KEY_REQUEST_AUTHCODE5_NAME,
|
|
5941
|
+
KEY_REQUEST_AUTHCODE5_SUCCESS,
|
|
5942
|
+
] as const satisfies (keyof RequestAuthcode5)[];
|
|
5943
|
+
|
|
5929
5944
|
export const KEY_DOMAIN_AVAILABILITY_LIST_META = 'meta' satisfies keyof DomainAvailabilityList;
|
|
5930
5945
|
export const KEY_DOMAIN_AVAILABILITY_LIST_RESULTS = 'results' satisfies keyof DomainAvailabilityList;
|
|
5931
5946
|
|
|
@@ -638,6 +638,11 @@ export type POST_DomainsTldSpecificNoByDomainReferenceResendDeclarationEmail_Req
|
|
|
638
638
|
};
|
|
639
639
|
export type POST_DomainsTldSpecificNoByDomainReferenceResendDeclarationEmail_Request_Path = POST_DomainsTldSpecificNoByDomainReferenceResendDeclarationEmail_Request['parameters']['path'];
|
|
640
640
|
|
|
641
|
+
export type POST_DomainsTldSpecificSeByDomainReferenceAuthCodeRequest_Request = {
|
|
642
|
+
parameters: operations['request_auth_code_v1_domains_tld_specific_se__domain_reference__auth_code_request_post']['parameters'];
|
|
643
|
+
};
|
|
644
|
+
export type POST_DomainsTldSpecificSeByDomainReferenceAuthCodeRequest_Request_Path = POST_DomainsTldSpecificSeByDomainReferenceAuthCodeRequest_Request['parameters']['path'];
|
|
645
|
+
|
|
641
646
|
export type POST_DomainsTransfer_Request = {
|
|
642
647
|
requestBody: DomainTransferIn;
|
|
643
648
|
};
|
|
@@ -101,6 +101,7 @@ import type {
|
|
|
101
101
|
RequestAuthcode2,
|
|
102
102
|
RequestAuthcode3,
|
|
103
103
|
RequestAuthcode4,
|
|
104
|
+
RequestAuthcode5,
|
|
104
105
|
SetVanityNameserverSetDefaultRes,
|
|
105
106
|
Tag,
|
|
106
107
|
TldResponseShort,
|
|
@@ -1217,6 +1218,13 @@ export type POST_DomainsTldSpecificNoByDomainReferenceResendDeclarationEmail_Res
|
|
|
1217
1218
|
export type POST_DomainsTldSpecificNoByDomainReferenceResendDeclarationEmail_Response_409 = Problem;
|
|
1218
1219
|
export type POST_DomainsTldSpecificNoByDomainReferenceResendDeclarationEmail_Response_422 = HTTPValidationError;
|
|
1219
1220
|
|
|
1221
|
+
export type POST_DomainsTldSpecificSeByDomainReferenceAuthCodeRequest_Response = POST_DomainsTldSpecificSeByDomainReferenceAuthCodeRequest_Response_200 | POST_DomainsTldSpecificSeByDomainReferenceAuthCodeRequest_Response_400 | POST_DomainsTldSpecificSeByDomainReferenceAuthCodeRequest_Response_404 | POST_DomainsTldSpecificSeByDomainReferenceAuthCodeRequest_Response_422;
|
|
1222
|
+
|
|
1223
|
+
export type POST_DomainsTldSpecificSeByDomainReferenceAuthCodeRequest_Response_200 = RequestAuthcode5;
|
|
1224
|
+
export type POST_DomainsTldSpecificSeByDomainReferenceAuthCodeRequest_Response_400 = Problem;
|
|
1225
|
+
export type POST_DomainsTldSpecificSeByDomainReferenceAuthCodeRequest_Response_404 = Problem;
|
|
1226
|
+
export type POST_DomainsTldSpecificSeByDomainReferenceAuthCodeRequest_Response_422 = HTTPValidationError;
|
|
1227
|
+
|
|
1220
1228
|
export type POST_DomainsTransfer_Response = POST_DomainsTransfer_Response_201 | POST_DomainsTransfer_Response_400 | POST_DomainsTransfer_Response_403 | POST_DomainsTransfer_Response_404 | POST_DomainsTransfer_Response_409 | POST_DomainsTransfer_Response_422;
|
|
1221
1229
|
|
|
1222
1230
|
export type POST_DomainsTransfer_Response_201 = Domain;
|
package/src/helpers/schemas.d.ts
CHANGED
|
@@ -583,5 +583,6 @@ export type RequestAuthcode = components['schemas']['api__domain__tld_specific__
|
|
|
583
583
|
export type RequestAuthcode2 = components['schemas']['api__domain__tld_specific__cz__models__RequestAuthcodeResponse'];
|
|
584
584
|
export type RequestAuthcode3 = components['schemas']['api__domain__tld_specific__eu__models__RequestAuthcodeResponse'];
|
|
585
585
|
export type RequestAuthcode4 = components['schemas']['api__domain__tld_specific__lt__models__RequestAuthcodeResponse'];
|
|
586
|
+
export type RequestAuthcode5 = components['schemas']['api__domain__tld_specific__se__models__RequestAuthcodeResponse'];
|
|
586
587
|
export type DomainAvailabilityList = components['schemas']['common__models__availability__datasource__DomainAvailabilityResponse'];
|
|
587
588
|
export type DomainAvailabilityCheck = components['schemas']['common__models__domain__domain__DomainAvailabilityResponse'];
|
package/src/openapi.yaml
CHANGED
|
@@ -6430,6 +6430,12 @@ components:
|
|
|
6430
6430
|
type: object
|
|
6431
6431
|
DomainWithdrawResponse:
|
|
6432
6432
|
properties:
|
|
6433
|
+
detail:
|
|
6434
|
+
anyOf:
|
|
6435
|
+
- type: string
|
|
6436
|
+
- type: 'null'
|
|
6437
|
+
description: Why the withdraw did not succeed
|
|
6438
|
+
title: Detail
|
|
6433
6439
|
name:
|
|
6434
6440
|
description: The domain name that was withdrawn
|
|
6435
6441
|
title: Name
|
|
@@ -14882,6 +14888,33 @@ components:
|
|
|
14882
14888
|
- success
|
|
14883
14889
|
title: RequestAuthcodeResponse
|
|
14884
14890
|
type: object
|
|
14891
|
+
api__domain__tld_specific__se__models__RequestAuthcodeResponse:
|
|
14892
|
+
properties:
|
|
14893
|
+
auth_code:
|
|
14894
|
+
anyOf:
|
|
14895
|
+
- type: string
|
|
14896
|
+
- type: 'null'
|
|
14897
|
+
description: The auth code generated by the registry
|
|
14898
|
+
title: Auth Code
|
|
14899
|
+
detail:
|
|
14900
|
+
anyOf:
|
|
14901
|
+
- type: string
|
|
14902
|
+
- type: 'null'
|
|
14903
|
+
description: Additional information about the result in case of failure
|
|
14904
|
+
title: Detail
|
|
14905
|
+
name:
|
|
14906
|
+
description: The domain name that had the auth code requested
|
|
14907
|
+
title: Name
|
|
14908
|
+
type: string
|
|
14909
|
+
success:
|
|
14910
|
+
description: Whether the registry generated a fresh auth code
|
|
14911
|
+
title: Success
|
|
14912
|
+
type: boolean
|
|
14913
|
+
required:
|
|
14914
|
+
- name
|
|
14915
|
+
- success
|
|
14916
|
+
title: RequestAuthcodeResponse
|
|
14917
|
+
type: object
|
|
14885
14918
|
common__models__availability__datasource__DomainAvailabilityResponse:
|
|
14886
14919
|
properties:
|
|
14887
14920
|
meta:
|
|
@@ -15017,7 +15050,7 @@ info:
|
|
|
15017
15050
|
\n\n"
|
|
15018
15051
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
15019
15052
|
title: OpusDNS API
|
|
15020
|
-
version: 2026-08-07-
|
|
15053
|
+
version: 2026-08-07-193122
|
|
15021
15054
|
x-logo:
|
|
15022
15055
|
altText: OpusDNS API Reference
|
|
15023
15056
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -23921,6 +23954,77 @@ paths:
|
|
|
23921
23954
|
- domain_tld_specific
|
|
23922
23955
|
x-required-permissions:
|
|
23923
23956
|
- domains:manage
|
|
23957
|
+
/v1/domains/tld-specific/se/{domain_reference}/auth_code/request:
|
|
23958
|
+
post:
|
|
23959
|
+
description: '`.se`/`.nu` auth codes are owned by the registry: registrars can
|
|
23960
|
+
only send the literal `auto`, and the generated code is returned in the `iis:updData`
|
|
23961
|
+
extension of a `domain:update`. This endpoint runs that update and stores
|
|
23962
|
+
the fresh code, invalidating any previous one.'
|
|
23963
|
+
operationId: request_auth_code_v1_domains_tld_specific_se__domain_reference__auth_code_request_post
|
|
23964
|
+
parameters:
|
|
23965
|
+
- in: path
|
|
23966
|
+
name: domain_reference
|
|
23967
|
+
required: true
|
|
23968
|
+
schema:
|
|
23969
|
+
anyOf:
|
|
23970
|
+
- examples:
|
|
23971
|
+
- domain_01h45ytscbebyvny4gc8cr8ma2
|
|
23972
|
+
format: typeid
|
|
23973
|
+
pattern: ^domain_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
23974
|
+
type: string
|
|
23975
|
+
x-typeid-prefix: domain
|
|
23976
|
+
- type: string
|
|
23977
|
+
title: Domain Reference
|
|
23978
|
+
- $ref: '#/components/parameters/DatetimeFormatHeader'
|
|
23979
|
+
responses:
|
|
23980
|
+
'200':
|
|
23981
|
+
content:
|
|
23982
|
+
application/json:
|
|
23983
|
+
schema:
|
|
23984
|
+
$ref: '#/components/schemas/api__domain__tld_specific__se__models__RequestAuthcodeResponse'
|
|
23985
|
+
description: Successful Response
|
|
23986
|
+
'400':
|
|
23987
|
+
content:
|
|
23988
|
+
application/problem+json:
|
|
23989
|
+
example:
|
|
23990
|
+
code: ERROR_DOMAIN_TRANSFER
|
|
23991
|
+
detail: There was an error transferring the domain
|
|
23992
|
+
domain_name: Additional error context.
|
|
23993
|
+
reason: An unspecified error occurred
|
|
23994
|
+
status: 400
|
|
23995
|
+
title: Domain Transfer Error
|
|
23996
|
+
type: domain-transfer
|
|
23997
|
+
schema:
|
|
23998
|
+
$ref: '#/components/schemas/Problem'
|
|
23999
|
+
description: Bad Request
|
|
24000
|
+
'404':
|
|
24001
|
+
content:
|
|
24002
|
+
application/problem+json:
|
|
24003
|
+
example:
|
|
24004
|
+
code: ERROR_DOMAIN_NOT_FOUND
|
|
24005
|
+
detail: Domain not found
|
|
24006
|
+
domain_name: Additional error context.
|
|
24007
|
+
status: 404
|
|
24008
|
+
title: Domain Management Error
|
|
24009
|
+
type: domain-not-found
|
|
24010
|
+
schema:
|
|
24011
|
+
$ref: '#/components/schemas/Problem'
|
|
24012
|
+
description: Not Found
|
|
24013
|
+
'422':
|
|
24014
|
+
content:
|
|
24015
|
+
application/problem+json:
|
|
24016
|
+
schema:
|
|
24017
|
+
$ref: '#/components/schemas/HTTPValidationError'
|
|
24018
|
+
description: Validation Error
|
|
24019
|
+
security:
|
|
24020
|
+
- OAuth2PasswordBearer: []
|
|
24021
|
+
- APIKeyHeader: []
|
|
24022
|
+
summary: Generates a fresh auth code at Internetstiftelsen (.se/.nu)
|
|
24023
|
+
tags:
|
|
24024
|
+
- domain
|
|
24025
|
+
- domain_tld_specific
|
|
24026
|
+
x-required-permissions:
|
|
24027
|
+
- domains:manage
|
|
23924
24028
|
/v1/domains/transfer:
|
|
23925
24029
|
post:
|
|
23926
24030
|
description: 'Start the transfer process for a domain <br>
|
package/src/schema.d.ts
CHANGED
|
@@ -1328,6 +1328,26 @@ export interface paths {
|
|
|
1328
1328
|
patch?: never;
|
|
1329
1329
|
trace?: never;
|
|
1330
1330
|
};
|
|
1331
|
+
"/v1/domains/tld-specific/se/{domain_reference}/auth_code/request": {
|
|
1332
|
+
parameters: {
|
|
1333
|
+
query?: never;
|
|
1334
|
+
header?: never;
|
|
1335
|
+
path?: never;
|
|
1336
|
+
cookie?: never;
|
|
1337
|
+
};
|
|
1338
|
+
get?: never;
|
|
1339
|
+
put?: never;
|
|
1340
|
+
/**
|
|
1341
|
+
* Generates a fresh auth code at Internetstiftelsen (.se/.nu)
|
|
1342
|
+
* @description `.se`/`.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.
|
|
1343
|
+
*/
|
|
1344
|
+
post: operations["request_auth_code_v1_domains_tld_specific_se__domain_reference__auth_code_request_post"];
|
|
1345
|
+
delete?: never;
|
|
1346
|
+
options?: never;
|
|
1347
|
+
head?: never;
|
|
1348
|
+
patch?: never;
|
|
1349
|
+
trace?: never;
|
|
1350
|
+
};
|
|
1331
1351
|
"/v1/domains/transfer": {
|
|
1332
1352
|
parameters: {
|
|
1333
1353
|
query?: never;
|
|
@@ -7091,6 +7111,11 @@ export interface components {
|
|
|
7091
7111
|
};
|
|
7092
7112
|
/** DomainWithdrawResponse */
|
|
7093
7113
|
DomainWithdrawResponse: {
|
|
7114
|
+
/**
|
|
7115
|
+
* Detail
|
|
7116
|
+
* @description Why the withdraw did not succeed
|
|
7117
|
+
*/
|
|
7118
|
+
detail?: string | null;
|
|
7094
7119
|
/**
|
|
7095
7120
|
* Name
|
|
7096
7121
|
* @description The domain name that was withdrawn
|
|
@@ -12744,6 +12769,29 @@ export interface components {
|
|
|
12744
12769
|
*/
|
|
12745
12770
|
success: boolean;
|
|
12746
12771
|
};
|
|
12772
|
+
/** RequestAuthcodeResponse */
|
|
12773
|
+
api__domain__tld_specific__se__models__RequestAuthcodeResponse: {
|
|
12774
|
+
/**
|
|
12775
|
+
* Auth Code
|
|
12776
|
+
* @description The auth code generated by the registry
|
|
12777
|
+
*/
|
|
12778
|
+
auth_code?: string | null;
|
|
12779
|
+
/**
|
|
12780
|
+
* Detail
|
|
12781
|
+
* @description Additional information about the result in case of failure
|
|
12782
|
+
*/
|
|
12783
|
+
detail?: string | null;
|
|
12784
|
+
/**
|
|
12785
|
+
* Name
|
|
12786
|
+
* @description The domain name that had the auth code requested
|
|
12787
|
+
*/
|
|
12788
|
+
name: string;
|
|
12789
|
+
/**
|
|
12790
|
+
* Success
|
|
12791
|
+
* @description Whether the registry generated a fresh auth code
|
|
12792
|
+
*/
|
|
12793
|
+
success: boolean;
|
|
12794
|
+
};
|
|
12747
12795
|
/** DomainAvailabilityResponse */
|
|
12748
12796
|
common__models__availability__datasource__DomainAvailabilityResponse: {
|
|
12749
12797
|
meta: components["schemas"]["DomainAvailabilityMeta"];
|
|
@@ -19695,6 +19743,78 @@ export interface operations {
|
|
|
19695
19743
|
};
|
|
19696
19744
|
};
|
|
19697
19745
|
};
|
|
19746
|
+
request_auth_code_v1_domains_tld_specific_se__domain_reference__auth_code_request_post: {
|
|
19747
|
+
parameters: {
|
|
19748
|
+
query?: never;
|
|
19749
|
+
header?: {
|
|
19750
|
+
/**
|
|
19751
|
+
* @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.
|
|
19752
|
+
* @example rfc3339
|
|
19753
|
+
*/
|
|
19754
|
+
"X-Datetime-Format"?: components["parameters"]["DatetimeFormatHeader"];
|
|
19755
|
+
};
|
|
19756
|
+
path: {
|
|
19757
|
+
domain_reference: TypeId<"domain"> | string;
|
|
19758
|
+
};
|
|
19759
|
+
cookie?: never;
|
|
19760
|
+
};
|
|
19761
|
+
requestBody?: never;
|
|
19762
|
+
responses: {
|
|
19763
|
+
/** @description Successful Response */
|
|
19764
|
+
200: {
|
|
19765
|
+
headers: {
|
|
19766
|
+
[name: string]: unknown;
|
|
19767
|
+
};
|
|
19768
|
+
content: {
|
|
19769
|
+
"application/json": components["schemas"]["api__domain__tld_specific__se__models__RequestAuthcodeResponse"];
|
|
19770
|
+
};
|
|
19771
|
+
};
|
|
19772
|
+
/** @description Bad Request */
|
|
19773
|
+
400: {
|
|
19774
|
+
headers: {
|
|
19775
|
+
[name: string]: unknown;
|
|
19776
|
+
};
|
|
19777
|
+
content: {
|
|
19778
|
+
/** @example {
|
|
19779
|
+
* "code": "ERROR_DOMAIN_TRANSFER",
|
|
19780
|
+
* "detail": "There was an error transferring the domain",
|
|
19781
|
+
* "domain_name": "Additional error context.",
|
|
19782
|
+
* "reason": "An unspecified error occurred",
|
|
19783
|
+
* "status": 400,
|
|
19784
|
+
* "title": "Domain Transfer Error",
|
|
19785
|
+
* "type": "domain-transfer"
|
|
19786
|
+
* } */
|
|
19787
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
19788
|
+
};
|
|
19789
|
+
};
|
|
19790
|
+
/** @description Not Found */
|
|
19791
|
+
404: {
|
|
19792
|
+
headers: {
|
|
19793
|
+
[name: string]: unknown;
|
|
19794
|
+
};
|
|
19795
|
+
content: {
|
|
19796
|
+
/** @example {
|
|
19797
|
+
* "code": "ERROR_DOMAIN_NOT_FOUND",
|
|
19798
|
+
* "detail": "Domain not found",
|
|
19799
|
+
* "domain_name": "Additional error context.",
|
|
19800
|
+
* "status": 404,
|
|
19801
|
+
* "title": "Domain Management Error",
|
|
19802
|
+
* "type": "domain-not-found"
|
|
19803
|
+
* } */
|
|
19804
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
19805
|
+
};
|
|
19806
|
+
};
|
|
19807
|
+
/** @description Validation Error */
|
|
19808
|
+
422: {
|
|
19809
|
+
headers: {
|
|
19810
|
+
[name: string]: unknown;
|
|
19811
|
+
};
|
|
19812
|
+
content: {
|
|
19813
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
19814
|
+
};
|
|
19815
|
+
};
|
|
19816
|
+
};
|
|
19817
|
+
};
|
|
19698
19818
|
transfer_domain_v1_domains_transfer_post: {
|
|
19699
19819
|
parameters: {
|
|
19700
19820
|
query?: never;
|