@opusdns/api 1.103.0 → 1.105.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 +28 -0
- package/src/helpers/requests.d.ts +5 -0
- package/src/helpers/responses.d.ts +8 -0
- package/src/helpers/schemas.d.ts +3 -0
- package/src/openapi.yaml +157 -3
- package/src/schema.d.ts +152 -3
package/package.json
CHANGED
package/src/helpers/constants.ts
CHANGED
|
@@ -36,6 +36,7 @@ import type {
|
|
|
36
36
|
DomainForwardSortField,
|
|
37
37
|
DomainForwardZoneSortField,
|
|
38
38
|
DomainIncludeField,
|
|
39
|
+
DomainListIncludeField,
|
|
39
40
|
DomainSortField,
|
|
40
41
|
DomainStatus,
|
|
41
42
|
EmailForwardLogSortField,
|
|
@@ -722,12 +723,22 @@ export const DOMAIN_FORWARD_ZONE_SORT_FIELD_VALUES = [
|
|
|
722
723
|
|
|
723
724
|
export const DOMAIN_INCLUDE_FIELD = {
|
|
724
725
|
TAGS: "tags",
|
|
726
|
+
RENEWAL_PRICE: "renewal_price",
|
|
725
727
|
} as const satisfies Record<string, DomainIncludeField>;
|
|
726
728
|
|
|
727
729
|
export const DOMAIN_INCLUDE_FIELD_VALUES = [
|
|
728
730
|
'tags',
|
|
731
|
+
'renewal_price',
|
|
729
732
|
] as const satisfies ReadonlyArray<DomainIncludeField>;
|
|
730
733
|
|
|
734
|
+
export const DOMAIN_LIST_INCLUDE_FIELD = {
|
|
735
|
+
TAGS: "tags",
|
|
736
|
+
} as const satisfies Record<string, DomainListIncludeField>;
|
|
737
|
+
|
|
738
|
+
export const DOMAIN_LIST_INCLUDE_FIELD_VALUES = [
|
|
739
|
+
'tags',
|
|
740
|
+
] as const satisfies ReadonlyArray<DomainListIncludeField>;
|
|
741
|
+
|
|
731
742
|
export const DOMAIN_SORT_FIELD = {
|
|
732
743
|
NAME: "name",
|
|
733
744
|
CREATED_ON: "created_on",
|
package/src/helpers/keys.ts
CHANGED
|
@@ -175,6 +175,7 @@ import type {
|
|
|
175
175
|
DomainRenewRequest,
|
|
176
176
|
DomainRenew,
|
|
177
177
|
DomainRenewalDetails,
|
|
178
|
+
DomainRenewalPrice,
|
|
178
179
|
Domain,
|
|
179
180
|
DomainRestoreRequest,
|
|
180
181
|
DomainRestore,
|
|
@@ -438,6 +439,7 @@ import type {
|
|
|
438
439
|
RequestAuthcode2,
|
|
439
440
|
RequestAuthcode3,
|
|
440
441
|
RequestAuthcode4,
|
|
442
|
+
RequestAuthcode5,
|
|
441
443
|
DomainAvailabilityList,
|
|
442
444
|
DomainAvailabilityCheck,
|
|
443
445
|
} from './schemas';
|
|
@@ -2494,6 +2496,18 @@ export const KEYS_DOMAIN_RENEWAL_DETAILS = [
|
|
|
2494
2496
|
KEY_DOMAIN_RENEWAL_DETAILS_EXPIRES_ON,
|
|
2495
2497
|
] as const satisfies (keyof DomainRenewalDetails)[];
|
|
2496
2498
|
|
|
2499
|
+
export const KEY_DOMAIN_RENEWAL_PRICE_CURRENCY = 'currency' satisfies keyof DomainRenewalPrice;
|
|
2500
|
+
export const KEY_DOMAIN_RENEWAL_PRICE_IS_PREMIUM = 'is_premium' satisfies keyof DomainRenewalPrice;
|
|
2501
|
+
export const KEY_DOMAIN_RENEWAL_PRICE_PERIOD = 'period' satisfies keyof DomainRenewalPrice;
|
|
2502
|
+
export const KEY_DOMAIN_RENEWAL_PRICE_PRICE = 'price' satisfies keyof DomainRenewalPrice;
|
|
2503
|
+
|
|
2504
|
+
export const KEYS_DOMAIN_RENEWAL_PRICE = [
|
|
2505
|
+
KEY_DOMAIN_RENEWAL_PRICE_CURRENCY,
|
|
2506
|
+
KEY_DOMAIN_RENEWAL_PRICE_IS_PREMIUM,
|
|
2507
|
+
KEY_DOMAIN_RENEWAL_PRICE_PERIOD,
|
|
2508
|
+
KEY_DOMAIN_RENEWAL_PRICE_PRICE,
|
|
2509
|
+
] as const satisfies (keyof DomainRenewalPrice)[];
|
|
2510
|
+
|
|
2497
2511
|
export const KEY_DOMAIN_AUTH_CODE = 'auth_code' satisfies keyof Domain;
|
|
2498
2512
|
export const KEY_DOMAIN_AUTH_CODE_EXPIRES_ON = 'auth_code_expires_on' satisfies keyof Domain;
|
|
2499
2513
|
export const KEY_DOMAIN_CANCELED_ON = 'canceled_on' satisfies keyof Domain;
|
|
@@ -2512,6 +2526,7 @@ export const KEY_DOMAIN_REGISTRY_ACCOUNT_ID = 'registry_account_id' satisfies ke
|
|
|
2512
2526
|
export const KEY_DOMAIN_REGISTRY_STATUSES = 'registry_statuses' satisfies keyof Domain;
|
|
2513
2527
|
export const KEY_DOMAIN_RENEWAL_MODE = 'renewal_mode' satisfies keyof Domain;
|
|
2514
2528
|
export const KEY_DOMAIN_RENEWAL_PERIOD = 'renewal_period' satisfies keyof Domain;
|
|
2529
|
+
export const KEY_DOMAIN_RENEWAL_PRICE = 'renewal_price' satisfies keyof Domain;
|
|
2515
2530
|
export const KEY_DOMAIN_ROID = 'roid' satisfies keyof Domain;
|
|
2516
2531
|
export const KEY_DOMAIN_SLD = 'sld' satisfies keyof Domain;
|
|
2517
2532
|
export const KEY_DOMAIN_STATUS_TAGS = 'status_tags' satisfies keyof Domain;
|
|
@@ -2541,6 +2556,7 @@ export const KEYS_DOMAIN = [
|
|
|
2541
2556
|
KEY_DOMAIN_REGISTRY_STATUSES,
|
|
2542
2557
|
KEY_DOMAIN_RENEWAL_MODE,
|
|
2543
2558
|
KEY_DOMAIN_RENEWAL_PERIOD,
|
|
2559
|
+
KEY_DOMAIN_RENEWAL_PRICE,
|
|
2544
2560
|
KEY_DOMAIN_ROID,
|
|
2545
2561
|
KEY_DOMAIN_SLD,
|
|
2546
2562
|
KEY_DOMAIN_STATUS_TAGS,
|
|
@@ -5928,6 +5944,18 @@ export const KEYS_REQUEST_AUTHCODE4 = [
|
|
|
5928
5944
|
KEY_REQUEST_AUTHCODE4_SUCCESS,
|
|
5929
5945
|
] as const satisfies (keyof RequestAuthcode4)[];
|
|
5930
5946
|
|
|
5947
|
+
export const KEY_REQUEST_AUTHCODE5_AUTH_CODE = 'auth_code' satisfies keyof RequestAuthcode5;
|
|
5948
|
+
export const KEY_REQUEST_AUTHCODE5_DETAIL = 'detail' satisfies keyof RequestAuthcode5;
|
|
5949
|
+
export const KEY_REQUEST_AUTHCODE5_NAME = 'name' satisfies keyof RequestAuthcode5;
|
|
5950
|
+
export const KEY_REQUEST_AUTHCODE5_SUCCESS = 'success' satisfies keyof RequestAuthcode5;
|
|
5951
|
+
|
|
5952
|
+
export const KEYS_REQUEST_AUTHCODE5 = [
|
|
5953
|
+
KEY_REQUEST_AUTHCODE5_AUTH_CODE,
|
|
5954
|
+
KEY_REQUEST_AUTHCODE5_DETAIL,
|
|
5955
|
+
KEY_REQUEST_AUTHCODE5_NAME,
|
|
5956
|
+
KEY_REQUEST_AUTHCODE5_SUCCESS,
|
|
5957
|
+
] as const satisfies (keyof RequestAuthcode5)[];
|
|
5958
|
+
|
|
5931
5959
|
export const KEY_DOMAIN_AVAILABILITY_LIST_META = 'meta' satisfies keyof DomainAvailabilityList;
|
|
5932
5960
|
export const KEY_DOMAIN_AVAILABILITY_LIST_RESULTS = 'results' satisfies keyof DomainAvailabilityList;
|
|
5933
5961
|
|
|
@@ -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
|
@@ -209,6 +209,7 @@ export type DomainForwardsContextCreate = components['schemas']['DomainForwardsC
|
|
|
209
209
|
export type DomainHost = components['schemas']['DomainHostResponse'];
|
|
210
210
|
export type DomainIncludeField = components['schemas']['DomainIncludeField'];
|
|
211
211
|
export type DomainLifecycleBase = components['schemas']['DomainLifecycleBase'];
|
|
212
|
+
export type DomainListIncludeField = components['schemas']['DomainListIncludeField'];
|
|
212
213
|
export type DomainNameParts = components['schemas']['DomainNameParts'];
|
|
213
214
|
export type DomainPeriod = components['schemas']['DomainPeriod'];
|
|
214
215
|
export type DomainRecommendationsContext = components['schemas']['DomainRecommendationsContext'];
|
|
@@ -216,6 +217,7 @@ export type DomainRecommendationsContextCreate = components['schemas']['DomainRe
|
|
|
216
217
|
export type DomainRenewRequest = components['schemas']['DomainRenewRequest'];
|
|
217
218
|
export type DomainRenew = components['schemas']['DomainRenewResponse'];
|
|
218
219
|
export type DomainRenewalDetails = components['schemas']['DomainRenewalDetails'];
|
|
220
|
+
export type DomainRenewalPrice = components['schemas']['DomainRenewalPriceResponse'];
|
|
219
221
|
export type Domain = components['schemas']['DomainResponse'];
|
|
220
222
|
export type DomainRestoreRequest = components['schemas']['DomainRestoreRequest'];
|
|
221
223
|
export type DomainRestore = components['schemas']['DomainRestoreResponse'];
|
|
@@ -583,5 +585,6 @@ export type RequestAuthcode = components['schemas']['api__domain__tld_specific__
|
|
|
583
585
|
export type RequestAuthcode2 = components['schemas']['api__domain__tld_specific__cz__models__RequestAuthcodeResponse'];
|
|
584
586
|
export type RequestAuthcode3 = components['schemas']['api__domain__tld_specific__eu__models__RequestAuthcodeResponse'];
|
|
585
587
|
export type RequestAuthcode4 = components['schemas']['api__domain__tld_specific__lt__models__RequestAuthcodeResponse'];
|
|
588
|
+
export type RequestAuthcode5 = components['schemas']['api__domain__tld_specific__se__models__RequestAuthcodeResponse'];
|
|
586
589
|
export type DomainAvailabilityList = components['schemas']['common__models__availability__datasource__DomainAvailabilityResponse'];
|
|
587
590
|
export type DomainAvailabilityCheck = components['schemas']['common__models__domain__domain__DomainAvailabilityResponse'];
|
package/src/openapi.yaml
CHANGED
|
@@ -4990,6 +4990,7 @@ components:
|
|
|
4990
4990
|
DomainIncludeField:
|
|
4991
4991
|
enum:
|
|
4992
4992
|
- tags
|
|
4993
|
+
- renewal_price
|
|
4993
4994
|
title: DomainIncludeField
|
|
4994
4995
|
type: string
|
|
4995
4996
|
DomainLifecycleBase:
|
|
@@ -5126,6 +5127,19 @@ components:
|
|
|
5126
5127
|
- default_transfer_renewal_period
|
|
5127
5128
|
title: DomainLifecycleBase
|
|
5128
5129
|
type: object
|
|
5130
|
+
DomainListIncludeField:
|
|
5131
|
+
description: 'Includes a list endpoint offers.
|
|
5132
|
+
|
|
5133
|
+
|
|
5134
|
+
Deliberately narrower than `DomainIncludeField`: resolving a renewal price
|
|
5135
|
+
|
|
5136
|
+
costs a registry check plus a billing call per premium domain, which a page
|
|
5137
|
+
|
|
5138
|
+
of results would multiply into a registry rate-limit problem.'
|
|
5139
|
+
enum:
|
|
5140
|
+
- tags
|
|
5141
|
+
title: DomainListIncludeField
|
|
5142
|
+
type: string
|
|
5129
5143
|
DomainNameParts:
|
|
5130
5144
|
properties:
|
|
5131
5145
|
domain:
|
|
@@ -5284,6 +5298,37 @@ components:
|
|
|
5284
5298
|
- expires_on
|
|
5285
5299
|
title: DomainRenewalDetails
|
|
5286
5300
|
type: object
|
|
5301
|
+
DomainRenewalPriceResponse:
|
|
5302
|
+
properties:
|
|
5303
|
+
currency:
|
|
5304
|
+
description: ISO 4217 currency code
|
|
5305
|
+
examples:
|
|
5306
|
+
- EUR
|
|
5307
|
+
title: Currency
|
|
5308
|
+
type: string
|
|
5309
|
+
is_premium:
|
|
5310
|
+
description: True when the price came from the registry's premium classification
|
|
5311
|
+
for renew rather than from the organization's standard TLD pricing
|
|
5312
|
+
title: Is Premium
|
|
5313
|
+
type: boolean
|
|
5314
|
+
period:
|
|
5315
|
+
$ref: '#/components/schemas/DomainPeriod'
|
|
5316
|
+
description: Period the price covers
|
|
5317
|
+
price:
|
|
5318
|
+
description: Renewal price for the period below, in the organization's billing
|
|
5319
|
+
currency, taxes excluded
|
|
5320
|
+
examples:
|
|
5321
|
+
- '43.50'
|
|
5322
|
+
pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
|
|
5323
|
+
title: Price
|
|
5324
|
+
type: string
|
|
5325
|
+
required:
|
|
5326
|
+
- price
|
|
5327
|
+
- currency
|
|
5328
|
+
- period
|
|
5329
|
+
- is_premium
|
|
5330
|
+
title: DomainRenewalPriceResponse
|
|
5331
|
+
type: object
|
|
5287
5332
|
DomainResponse:
|
|
5288
5333
|
properties:
|
|
5289
5334
|
auth_code:
|
|
@@ -5349,7 +5394,12 @@ components:
|
|
|
5349
5394
|
type: array
|
|
5350
5395
|
is_premium:
|
|
5351
5396
|
default: false
|
|
5352
|
-
description: Whether this
|
|
5397
|
+
description: 'Whether the registry prices this domain at a premium class
|
|
5398
|
+
for the action it was bought under. Not purchase provenance: a renewal-time
|
|
5399
|
+
check that affirmatively quotes renew as standard corrects the flag, so
|
|
5400
|
+
it tracks the registry''s current classification. Registries classify
|
|
5401
|
+
each action separately, so a domain premium only to restore is not premium
|
|
5402
|
+
here.'
|
|
5353
5403
|
title: Is Premium
|
|
5354
5404
|
type: boolean
|
|
5355
5405
|
name:
|
|
@@ -5407,6 +5457,12 @@ components:
|
|
|
5407
5457
|
'P1M', 'P1Y'). Null when the domain is not set to renew (renewal mode
|
|
5408
5458
|
'expire') or has no active subscription.
|
|
5409
5459
|
title: Renewal Period
|
|
5460
|
+
renewal_price:
|
|
5461
|
+
anyOf:
|
|
5462
|
+
- $ref: '#/components/schemas/DomainRenewalPriceResponse'
|
|
5463
|
+
- type: 'null'
|
|
5464
|
+
description: Price this organization pays to renew this domain for one year.
|
|
5465
|
+
Only included when ?include=renewal_price is specified.
|
|
5410
5466
|
roid:
|
|
5411
5467
|
description: The registry object id of the domain
|
|
5412
5468
|
examples:
|
|
@@ -14888,6 +14944,33 @@ components:
|
|
|
14888
14944
|
- success
|
|
14889
14945
|
title: RequestAuthcodeResponse
|
|
14890
14946
|
type: object
|
|
14947
|
+
api__domain__tld_specific__se__models__RequestAuthcodeResponse:
|
|
14948
|
+
properties:
|
|
14949
|
+
auth_code:
|
|
14950
|
+
anyOf:
|
|
14951
|
+
- type: string
|
|
14952
|
+
- type: 'null'
|
|
14953
|
+
description: The auth code generated by the registry
|
|
14954
|
+
title: Auth Code
|
|
14955
|
+
detail:
|
|
14956
|
+
anyOf:
|
|
14957
|
+
- type: string
|
|
14958
|
+
- type: 'null'
|
|
14959
|
+
description: Additional information about the result in case of failure
|
|
14960
|
+
title: Detail
|
|
14961
|
+
name:
|
|
14962
|
+
description: The domain name that had the auth code requested
|
|
14963
|
+
title: Name
|
|
14964
|
+
type: string
|
|
14965
|
+
success:
|
|
14966
|
+
description: Whether the registry generated a fresh auth code
|
|
14967
|
+
title: Success
|
|
14968
|
+
type: boolean
|
|
14969
|
+
required:
|
|
14970
|
+
- name
|
|
14971
|
+
- success
|
|
14972
|
+
title: RequestAuthcodeResponse
|
|
14973
|
+
type: object
|
|
14891
14974
|
common__models__availability__datasource__DomainAvailabilityResponse:
|
|
14892
14975
|
properties:
|
|
14893
14976
|
meta:
|
|
@@ -15023,7 +15106,7 @@ info:
|
|
|
15023
15106
|
\n\n"
|
|
15024
15107
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
15025
15108
|
title: OpusDNS API
|
|
15026
|
-
version: 2026-08-07-
|
|
15109
|
+
version: 2026-08-07-221736
|
|
15027
15110
|
x-logo:
|
|
15028
15111
|
altText: OpusDNS API Reference
|
|
15029
15112
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -22950,7 +23033,7 @@ paths:
|
|
|
22950
23033
|
schema:
|
|
22951
23034
|
anyOf:
|
|
22952
23035
|
- items:
|
|
22953
|
-
$ref: '#/components/schemas/
|
|
23036
|
+
$ref: '#/components/schemas/DomainListIncludeField'
|
|
22954
23037
|
type: array
|
|
22955
23038
|
- type: 'null'
|
|
22956
23039
|
description: Include additional data in the response. Can be specified multiple
|
|
@@ -23927,6 +24010,77 @@ paths:
|
|
|
23927
24010
|
- domain_tld_specific
|
|
23928
24011
|
x-required-permissions:
|
|
23929
24012
|
- domains:manage
|
|
24013
|
+
/v1/domains/tld-specific/se/{domain_reference}/auth_code/request:
|
|
24014
|
+
post:
|
|
24015
|
+
description: '`.se`/`.nu` auth codes are owned by the registry: registrars can
|
|
24016
|
+
only send the literal `auto`, and the generated code is returned in the `iis:updData`
|
|
24017
|
+
extension of a `domain:update`. This endpoint runs that update and stores
|
|
24018
|
+
the fresh code, invalidating any previous one.'
|
|
24019
|
+
operationId: request_auth_code_v1_domains_tld_specific_se__domain_reference__auth_code_request_post
|
|
24020
|
+
parameters:
|
|
24021
|
+
- in: path
|
|
24022
|
+
name: domain_reference
|
|
24023
|
+
required: true
|
|
24024
|
+
schema:
|
|
24025
|
+
anyOf:
|
|
24026
|
+
- examples:
|
|
24027
|
+
- domain_01h45ytscbebyvny4gc8cr8ma2
|
|
24028
|
+
format: typeid
|
|
24029
|
+
pattern: ^domain_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
24030
|
+
type: string
|
|
24031
|
+
x-typeid-prefix: domain
|
|
24032
|
+
- type: string
|
|
24033
|
+
title: Domain Reference
|
|
24034
|
+
- $ref: '#/components/parameters/DatetimeFormatHeader'
|
|
24035
|
+
responses:
|
|
24036
|
+
'200':
|
|
24037
|
+
content:
|
|
24038
|
+
application/json:
|
|
24039
|
+
schema:
|
|
24040
|
+
$ref: '#/components/schemas/api__domain__tld_specific__se__models__RequestAuthcodeResponse'
|
|
24041
|
+
description: Successful Response
|
|
24042
|
+
'400':
|
|
24043
|
+
content:
|
|
24044
|
+
application/problem+json:
|
|
24045
|
+
example:
|
|
24046
|
+
code: ERROR_DOMAIN_TRANSFER
|
|
24047
|
+
detail: There was an error transferring the domain
|
|
24048
|
+
domain_name: Additional error context.
|
|
24049
|
+
reason: An unspecified error occurred
|
|
24050
|
+
status: 400
|
|
24051
|
+
title: Domain Transfer Error
|
|
24052
|
+
type: domain-transfer
|
|
24053
|
+
schema:
|
|
24054
|
+
$ref: '#/components/schemas/Problem'
|
|
24055
|
+
description: Bad Request
|
|
24056
|
+
'404':
|
|
24057
|
+
content:
|
|
24058
|
+
application/problem+json:
|
|
24059
|
+
example:
|
|
24060
|
+
code: ERROR_DOMAIN_NOT_FOUND
|
|
24061
|
+
detail: Domain not found
|
|
24062
|
+
domain_name: Additional error context.
|
|
24063
|
+
status: 404
|
|
24064
|
+
title: Domain Management Error
|
|
24065
|
+
type: domain-not-found
|
|
24066
|
+
schema:
|
|
24067
|
+
$ref: '#/components/schemas/Problem'
|
|
24068
|
+
description: Not Found
|
|
24069
|
+
'422':
|
|
24070
|
+
content:
|
|
24071
|
+
application/problem+json:
|
|
24072
|
+
schema:
|
|
24073
|
+
$ref: '#/components/schemas/HTTPValidationError'
|
|
24074
|
+
description: Validation Error
|
|
24075
|
+
security:
|
|
24076
|
+
- OAuth2PasswordBearer: []
|
|
24077
|
+
- APIKeyHeader: []
|
|
24078
|
+
summary: Generates a fresh auth code at Internetstiftelsen (.se/.nu)
|
|
24079
|
+
tags:
|
|
24080
|
+
- domain
|
|
24081
|
+
- domain_tld_specific
|
|
24082
|
+
x-required-permissions:
|
|
24083
|
+
- domains:manage
|
|
23930
24084
|
/v1/domains/transfer:
|
|
23931
24085
|
post:
|
|
23932
24086
|
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;
|
|
@@ -6140,7 +6160,7 @@ export interface components {
|
|
|
6140
6160
|
* DomainIncludeField
|
|
6141
6161
|
* @enum {string}
|
|
6142
6162
|
*/
|
|
6143
|
-
DomainIncludeField: "tags";
|
|
6163
|
+
DomainIncludeField: "tags" | "renewal_price";
|
|
6144
6164
|
/** DomainLifecycleBase */
|
|
6145
6165
|
DomainLifecycleBase: {
|
|
6146
6166
|
/**
|
|
@@ -6211,6 +6231,16 @@ export interface components {
|
|
|
6211
6231
|
/** @description List of allowed transfer renewal periods (eg. '1y') */
|
|
6212
6232
|
transfer_renewal_periods?: components["schemas"]["PeriodList"];
|
|
6213
6233
|
};
|
|
6234
|
+
/**
|
|
6235
|
+
* DomainListIncludeField
|
|
6236
|
+
* @description Includes a list endpoint offers.
|
|
6237
|
+
*
|
|
6238
|
+
* Deliberately narrower than `DomainIncludeField`: resolving a renewal price
|
|
6239
|
+
* costs a registry check plus a billing call per premium domain, which a page
|
|
6240
|
+
* of results would multiply into a registry rate-limit problem.
|
|
6241
|
+
* @enum {string}
|
|
6242
|
+
*/
|
|
6243
|
+
DomainListIncludeField: "tags";
|
|
6214
6244
|
/** DomainNameParts */
|
|
6215
6245
|
DomainNameParts: {
|
|
6216
6246
|
/**
|
|
@@ -6327,6 +6357,28 @@ export interface components {
|
|
|
6327
6357
|
*/
|
|
6328
6358
|
expires_on: Date;
|
|
6329
6359
|
};
|
|
6360
|
+
/** DomainRenewalPriceResponse */
|
|
6361
|
+
DomainRenewalPriceResponse: {
|
|
6362
|
+
/**
|
|
6363
|
+
* Currency
|
|
6364
|
+
* @description ISO 4217 currency code
|
|
6365
|
+
* @example EUR
|
|
6366
|
+
*/
|
|
6367
|
+
currency: string;
|
|
6368
|
+
/**
|
|
6369
|
+
* Is Premium
|
|
6370
|
+
* @description True when the price came from the registry's premium classification for renew rather than from the organization's standard TLD pricing
|
|
6371
|
+
*/
|
|
6372
|
+
is_premium: boolean;
|
|
6373
|
+
/** @description Period the price covers */
|
|
6374
|
+
period: components["schemas"]["DomainPeriod"];
|
|
6375
|
+
/**
|
|
6376
|
+
* Price
|
|
6377
|
+
* @description Renewal price for the period below, in the organization's billing currency, taxes excluded
|
|
6378
|
+
* @example 43.50
|
|
6379
|
+
*/
|
|
6380
|
+
price: string;
|
|
6381
|
+
};
|
|
6330
6382
|
/** DomainResponse */
|
|
6331
6383
|
DomainResponse: {
|
|
6332
6384
|
/**
|
|
@@ -6378,7 +6430,7 @@ export interface components {
|
|
|
6378
6430
|
hosts?: components["schemas"]["DomainHostResponse"][];
|
|
6379
6431
|
/**
|
|
6380
6432
|
* Is Premium
|
|
6381
|
-
* @description Whether this
|
|
6433
|
+
* @description Whether the registry prices this domain at a premium class for the action it was bought under. Not purchase provenance: a renewal-time check that affirmatively quotes renew as standard corrects the flag, so it tracks the registry's current classification. Registries classify each action separately, so a domain premium only to restore is not premium here.
|
|
6382
6434
|
* @default false
|
|
6383
6435
|
*/
|
|
6384
6436
|
is_premium: boolean;
|
|
@@ -6425,6 +6477,8 @@ export interface components {
|
|
|
6425
6477
|
* @description Renewal period of the domain as an ISO 8601 duration (e.g. 'P1M', 'P1Y'). Null when the domain is not set to renew (renewal mode 'expire') or has no active subscription.
|
|
6426
6478
|
*/
|
|
6427
6479
|
renewal_period?: string | null;
|
|
6480
|
+
/** @description Price this organization pays to renew this domain for one year. Only included when ?include=renewal_price is specified. */
|
|
6481
|
+
renewal_price?: components["schemas"]["DomainRenewalPriceResponse"] | null;
|
|
6428
6482
|
/**
|
|
6429
6483
|
* Roid
|
|
6430
6484
|
* @description The registry object id of the domain
|
|
@@ -12749,6 +12803,29 @@ export interface components {
|
|
|
12749
12803
|
*/
|
|
12750
12804
|
success: boolean;
|
|
12751
12805
|
};
|
|
12806
|
+
/** RequestAuthcodeResponse */
|
|
12807
|
+
api__domain__tld_specific__se__models__RequestAuthcodeResponse: {
|
|
12808
|
+
/**
|
|
12809
|
+
* Auth Code
|
|
12810
|
+
* @description The auth code generated by the registry
|
|
12811
|
+
*/
|
|
12812
|
+
auth_code?: string | null;
|
|
12813
|
+
/**
|
|
12814
|
+
* Detail
|
|
12815
|
+
* @description Additional information about the result in case of failure
|
|
12816
|
+
*/
|
|
12817
|
+
detail?: string | null;
|
|
12818
|
+
/**
|
|
12819
|
+
* Name
|
|
12820
|
+
* @description The domain name that had the auth code requested
|
|
12821
|
+
*/
|
|
12822
|
+
name: string;
|
|
12823
|
+
/**
|
|
12824
|
+
* Success
|
|
12825
|
+
* @description Whether the registry generated a fresh auth code
|
|
12826
|
+
*/
|
|
12827
|
+
success: boolean;
|
|
12828
|
+
};
|
|
12752
12829
|
/** DomainAvailabilityResponse */
|
|
12753
12830
|
common__models__availability__datasource__DomainAvailabilityResponse: {
|
|
12754
12831
|
meta: components["schemas"]["DomainAvailabilityMeta"];
|
|
@@ -18735,7 +18812,7 @@ export interface operations {
|
|
|
18735
18812
|
/** @description Filter domains by registry status. Can be specified multiple times (union of all provided values). */
|
|
18736
18813
|
registry_statuses?: string[] | null;
|
|
18737
18814
|
/** @description Include additional data in the response. Can be specified multiple times. */
|
|
18738
|
-
include?: components["schemas"]["
|
|
18815
|
+
include?: components["schemas"]["DomainListIncludeField"][] | null;
|
|
18739
18816
|
};
|
|
18740
18817
|
header?: {
|
|
18741
18818
|
/**
|
|
@@ -19700,6 +19777,78 @@ export interface operations {
|
|
|
19700
19777
|
};
|
|
19701
19778
|
};
|
|
19702
19779
|
};
|
|
19780
|
+
request_auth_code_v1_domains_tld_specific_se__domain_reference__auth_code_request_post: {
|
|
19781
|
+
parameters: {
|
|
19782
|
+
query?: never;
|
|
19783
|
+
header?: {
|
|
19784
|
+
/**
|
|
19785
|
+
* @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.
|
|
19786
|
+
* @example rfc3339
|
|
19787
|
+
*/
|
|
19788
|
+
"X-Datetime-Format"?: components["parameters"]["DatetimeFormatHeader"];
|
|
19789
|
+
};
|
|
19790
|
+
path: {
|
|
19791
|
+
domain_reference: TypeId<"domain"> | string;
|
|
19792
|
+
};
|
|
19793
|
+
cookie?: never;
|
|
19794
|
+
};
|
|
19795
|
+
requestBody?: never;
|
|
19796
|
+
responses: {
|
|
19797
|
+
/** @description Successful Response */
|
|
19798
|
+
200: {
|
|
19799
|
+
headers: {
|
|
19800
|
+
[name: string]: unknown;
|
|
19801
|
+
};
|
|
19802
|
+
content: {
|
|
19803
|
+
"application/json": components["schemas"]["api__domain__tld_specific__se__models__RequestAuthcodeResponse"];
|
|
19804
|
+
};
|
|
19805
|
+
};
|
|
19806
|
+
/** @description Bad Request */
|
|
19807
|
+
400: {
|
|
19808
|
+
headers: {
|
|
19809
|
+
[name: string]: unknown;
|
|
19810
|
+
};
|
|
19811
|
+
content: {
|
|
19812
|
+
/** @example {
|
|
19813
|
+
* "code": "ERROR_DOMAIN_TRANSFER",
|
|
19814
|
+
* "detail": "There was an error transferring the domain",
|
|
19815
|
+
* "domain_name": "Additional error context.",
|
|
19816
|
+
* "reason": "An unspecified error occurred",
|
|
19817
|
+
* "status": 400,
|
|
19818
|
+
* "title": "Domain Transfer Error",
|
|
19819
|
+
* "type": "domain-transfer"
|
|
19820
|
+
* } */
|
|
19821
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
19822
|
+
};
|
|
19823
|
+
};
|
|
19824
|
+
/** @description Not Found */
|
|
19825
|
+
404: {
|
|
19826
|
+
headers: {
|
|
19827
|
+
[name: string]: unknown;
|
|
19828
|
+
};
|
|
19829
|
+
content: {
|
|
19830
|
+
/** @example {
|
|
19831
|
+
* "code": "ERROR_DOMAIN_NOT_FOUND",
|
|
19832
|
+
* "detail": "Domain not found",
|
|
19833
|
+
* "domain_name": "Additional error context.",
|
|
19834
|
+
* "status": 404,
|
|
19835
|
+
* "title": "Domain Management Error",
|
|
19836
|
+
* "type": "domain-not-found"
|
|
19837
|
+
* } */
|
|
19838
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
19839
|
+
};
|
|
19840
|
+
};
|
|
19841
|
+
/** @description Validation Error */
|
|
19842
|
+
422: {
|
|
19843
|
+
headers: {
|
|
19844
|
+
[name: string]: unknown;
|
|
19845
|
+
};
|
|
19846
|
+
content: {
|
|
19847
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
19848
|
+
};
|
|
19849
|
+
};
|
|
19850
|
+
};
|
|
19851
|
+
};
|
|
19703
19852
|
transfer_domain_v1_domains_transfer_post: {
|
|
19704
19853
|
parameters: {
|
|
19705
19854
|
query?: never;
|