@opusdns/api 1.156.0 → 1.158.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 +2 -0
- package/src/helpers/keys.ts +6 -0
- package/src/openapi.yaml +113 -59
- package/src/schema.d.ts +48 -21
package/package.json
CHANGED
package/src/helpers/constants.ts
CHANGED
|
@@ -670,6 +670,7 @@ export const DOMAIN_ATTRIBUTE_KEY = {
|
|
|
670
670
|
INTERNET_EE_REGISTRANT_AGREEMENT: "internet_ee_registrant_agreement",
|
|
671
671
|
PROMOTION: "promotion",
|
|
672
672
|
PROMOTION_ELIGIBILITY: "promotion_eligibility",
|
|
673
|
+
DOMAIN_CONTACT_ATTRIBUTES: "domain_contact_attributes",
|
|
673
674
|
} as const satisfies Record<string, DomainAttributeKey>;
|
|
674
675
|
|
|
675
676
|
export const DOMAIN_ATTRIBUTE_KEY_VALUES = [
|
|
@@ -690,6 +691,7 @@ export const DOMAIN_ATTRIBUTE_KEY_VALUES = [
|
|
|
690
691
|
'internet_ee_registrant_agreement',
|
|
691
692
|
'promotion',
|
|
692
693
|
'promotion_eligibility',
|
|
694
|
+
'domain_contact_attributes',
|
|
693
695
|
] as const satisfies ReadonlyArray<DomainAttributeKey>;
|
|
694
696
|
|
|
695
697
|
export const DOMAIN_AVAILABILITY_STATUS = {
|
package/src/helpers/keys.ts
CHANGED
|
@@ -1929,10 +1929,12 @@ export const KEYS_DOMAIN_CHECK = [
|
|
|
1929
1929
|
KEY_DOMAIN_CHECK_RESULTS,
|
|
1930
1930
|
] as const satisfies (keyof DomainCheck)[];
|
|
1931
1931
|
|
|
1932
|
+
export const KEY_DOMAIN_CONTACT_ATTRIBUTES = 'attributes' satisfies keyof DomainContact;
|
|
1932
1933
|
export const KEY_DOMAIN_CONTACT_CONTACT_ID = 'contact_id' satisfies keyof DomainContact;
|
|
1933
1934
|
export const KEY_DOMAIN_CONTACT_CONTACT_TYPE = 'contact_type' satisfies keyof DomainContact;
|
|
1934
1935
|
|
|
1935
1936
|
export const KEYS_DOMAIN_CONTACT = [
|
|
1937
|
+
KEY_DOMAIN_CONTACT_ATTRIBUTES,
|
|
1936
1938
|
KEY_DOMAIN_CONTACT_CONTACT_ID,
|
|
1937
1939
|
KEY_DOMAIN_CONTACT_CONTACT_TYPE,
|
|
1938
1940
|
] as const satisfies (keyof DomainContact)[];
|
|
@@ -5990,6 +5992,8 @@ export const KEYS_WHITELABEL_BRANDING_RECHECK = [
|
|
|
5990
5992
|
] as const satisfies (keyof WhitelabelBrandingRecheck)[];
|
|
5991
5993
|
|
|
5992
5994
|
export const KEY_WHITELABEL_BRANDING_AUTH_HOSTNAME = 'auth_hostname' satisfies keyof WhitelabelBranding;
|
|
5995
|
+
export const KEY_WHITELABEL_BRANDING_BASE_AUTH_HOSTNAME = 'base_auth_hostname' satisfies keyof WhitelabelBranding;
|
|
5996
|
+
export const KEY_WHITELABEL_BRANDING_BASE_HOSTNAME = 'base_hostname' satisfies keyof WhitelabelBranding;
|
|
5993
5997
|
export const KEY_WHITELABEL_BRANDING_BASE_LABEL = 'base_label' satisfies keyof WhitelabelBranding;
|
|
5994
5998
|
export const KEY_WHITELABEL_BRANDING_CREATED_ON = 'created_on' satisfies keyof WhitelabelBranding;
|
|
5995
5999
|
export const KEY_WHITELABEL_BRANDING_ENABLED = 'enabled' satisfies keyof WhitelabelBranding;
|
|
@@ -6008,6 +6012,8 @@ export const KEY_WHITELABEL_BRANDING_WHITELABEL_BRANDING_ID = 'whitelabel_brandi
|
|
|
6008
6012
|
|
|
6009
6013
|
export const KEYS_WHITELABEL_BRANDING = [
|
|
6010
6014
|
KEY_WHITELABEL_BRANDING_AUTH_HOSTNAME,
|
|
6015
|
+
KEY_WHITELABEL_BRANDING_BASE_AUTH_HOSTNAME,
|
|
6016
|
+
KEY_WHITELABEL_BRANDING_BASE_HOSTNAME,
|
|
6011
6017
|
KEY_WHITELABEL_BRANDING_BASE_LABEL,
|
|
6012
6018
|
KEY_WHITELABEL_BRANDING_CREATED_ON,
|
|
6013
6019
|
KEY_WHITELABEL_BRANDING_ENABLED,
|
package/src/openapi.yaml
CHANGED
|
@@ -3848,6 +3848,7 @@ components:
|
|
|
3848
3848
|
- internet_ee_registrant_agreement
|
|
3849
3849
|
- promotion
|
|
3850
3850
|
- promotion_eligibility
|
|
3851
|
+
- domain_contact_attributes
|
|
3851
3852
|
title: DomainAttributeKey
|
|
3852
3853
|
type: string
|
|
3853
3854
|
DomainAvailability:
|
|
@@ -3951,6 +3952,19 @@ components:
|
|
|
3951
3952
|
type: object
|
|
3952
3953
|
DomainContactResponse:
|
|
3953
3954
|
properties:
|
|
3955
|
+
attributes:
|
|
3956
|
+
anyOf:
|
|
3957
|
+
- additionalProperties:
|
|
3958
|
+
type: string
|
|
3959
|
+
propertyNames:
|
|
3960
|
+
$ref: '#/components/schemas/RegistryHandleAttributeType'
|
|
3961
|
+
type: object
|
|
3962
|
+
- type: 'null'
|
|
3963
|
+
description: Registry-specific attributes supplied inline for this contact
|
|
3964
|
+
in this role. Omitted when the contact was submitted without inline attributes;
|
|
3965
|
+
attributes taken from a linked contact attribute set are not reported
|
|
3966
|
+
here.
|
|
3967
|
+
title: Attributes
|
|
3954
3968
|
contact_id:
|
|
3955
3969
|
description: The contact id of the contact
|
|
3956
3970
|
examples:
|
|
@@ -4002,10 +4016,12 @@ components:
|
|
|
4002
4016
|
\ =\n `REQUEST`. `.de` only.\n\nBoolean keys also accept `1` and `yes`.\n\
|
|
4003
4017
|
\nWritten by the platform and rejected if supplied: `verification_required`,\
|
|
4004
4018
|
\ `promotion`, `promotion_eligibility`,\n`nor_id_declaration`, `nor_id_declaration_token`,\
|
|
4005
|
-
\ `punktum_dk_tracking_no`. They are never
|
|
4006
|
-
|
|
4007
|
-
\ `
|
|
4008
|
-
\
|
|
4019
|
+
\ `punktum_dk_tracking_no`, `domain_contact_attributes`. They are never\n\
|
|
4020
|
+
returned under `attributes`; inline contact attributes surface on the\
|
|
4021
|
+
\ matching `contacts` entry instead.\n\nDerived from the signed `.no`\
|
|
4022
|
+
\ applicant declaration and ignored if supplied: `nor_id_applicant_version`,\n\
|
|
4023
|
+
`nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.\n\nOn\
|
|
4024
|
+
\ update, only `.de` stores attributes and an empty value removes the\
|
|
4009
4025
|
\ stored attribute; `.dk` reads\n`punktum_dk_terms_acceptance` to confirm\
|
|
4010
4026
|
\ a registrant change and other registries ignore attributes.\n"
|
|
4011
4027
|
examples:
|
|
@@ -4121,10 +4137,12 @@ components:
|
|
|
4121
4137
|
\ =\n `REQUEST`. `.de` only.\n\nBoolean keys also accept `1` and `yes`.\n\
|
|
4122
4138
|
\nWritten by the platform and rejected if supplied: `verification_required`,\
|
|
4123
4139
|
\ `promotion`, `promotion_eligibility`,\n`nor_id_declaration`, `nor_id_declaration_token`,\
|
|
4124
|
-
\ `punktum_dk_tracking_no`. They are never
|
|
4125
|
-
|
|
4126
|
-
\ `
|
|
4127
|
-
\
|
|
4140
|
+
\ `punktum_dk_tracking_no`, `domain_contact_attributes`. They are never\n\
|
|
4141
|
+
returned under `attributes`; inline contact attributes surface on the\
|
|
4142
|
+
\ matching `contacts` entry instead.\n\nDerived from the signed `.no`\
|
|
4143
|
+
\ applicant declaration and ignored if supplied: `nor_id_applicant_version`,\n\
|
|
4144
|
+
`nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.\n\nOn\
|
|
4145
|
+
\ update, only `.de` stores attributes and an empty value removes the\
|
|
4128
4146
|
\ stored attribute; `.dk` reads\n`punktum_dk_terms_acceptance` to confirm\
|
|
4129
4147
|
\ a registrant change and other registries ignore attributes.\n"
|
|
4130
4148
|
title: Attributes
|
|
@@ -4224,10 +4242,12 @@ components:
|
|
|
4224
4242
|
\ =\n `REQUEST`. `.de` only.\n\nBoolean keys also accept `1` and `yes`.\n\
|
|
4225
4243
|
\nWritten by the platform and rejected if supplied: `verification_required`,\
|
|
4226
4244
|
\ `promotion`, `promotion_eligibility`,\n`nor_id_declaration`, `nor_id_declaration_token`,\
|
|
4227
|
-
\ `punktum_dk_tracking_no`. They are never
|
|
4228
|
-
|
|
4229
|
-
\ `
|
|
4230
|
-
\
|
|
4245
|
+
\ `punktum_dk_tracking_no`, `domain_contact_attributes`. They are never\n\
|
|
4246
|
+
returned under `attributes`; inline contact attributes surface on the\
|
|
4247
|
+
\ matching `contacts` entry instead.\n\nDerived from the signed `.no`\
|
|
4248
|
+
\ applicant declaration and ignored if supplied: `nor_id_applicant_version`,\n\
|
|
4249
|
+
`nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.\n\nOn\
|
|
4250
|
+
\ update, only `.de` stores attributes and an empty value removes the\
|
|
4231
4251
|
\ stored attribute; `.dk` reads\n`punktum_dk_terms_acceptance` to confirm\
|
|
4232
4252
|
\ a registrant change and other registries ignore attributes.\n"
|
|
4233
4253
|
title: Attributes
|
|
@@ -4317,10 +4337,12 @@ components:
|
|
|
4317
4337
|
\ =\n `REQUEST`. `.de` only.\n\nBoolean keys also accept `1` and `yes`.\n\
|
|
4318
4338
|
\nWritten by the platform and rejected if supplied: `verification_required`,\
|
|
4319
4339
|
\ `promotion`, `promotion_eligibility`,\n`nor_id_declaration`, `nor_id_declaration_token`,\
|
|
4320
|
-
\ `punktum_dk_tracking_no`. They are never
|
|
4321
|
-
|
|
4322
|
-
\ `
|
|
4323
|
-
\
|
|
4340
|
+
\ `punktum_dk_tracking_no`, `domain_contact_attributes`. They are never\n\
|
|
4341
|
+
returned under `attributes`; inline contact attributes surface on the\
|
|
4342
|
+
\ matching `contacts` entry instead.\n\nDerived from the signed `.no`\
|
|
4343
|
+
\ applicant declaration and ignored if supplied: `nor_id_applicant_version`,\n\
|
|
4344
|
+
`nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.\n\nOn\
|
|
4345
|
+
\ update, only `.de` stores attributes and an empty value removes the\
|
|
4324
4346
|
\ stored attribute; `.dk` reads\n`punktum_dk_terms_acceptance` to confirm\
|
|
4325
4347
|
\ a registrant change and other registries ignore attributes.\n"
|
|
4326
4348
|
examples:
|
|
@@ -6198,10 +6220,12 @@ components:
|
|
|
6198
6220
|
\ =\n `REQUEST`. `.de` only.\n\nBoolean keys also accept `1` and `yes`.\n\
|
|
6199
6221
|
\nWritten by the platform and rejected if supplied: `verification_required`,\
|
|
6200
6222
|
\ `promotion`, `promotion_eligibility`,\n`nor_id_declaration`, `nor_id_declaration_token`,\
|
|
6201
|
-
\ `punktum_dk_tracking_no`. They are never
|
|
6202
|
-
|
|
6203
|
-
\ `
|
|
6204
|
-
\
|
|
6223
|
+
\ `punktum_dk_tracking_no`, `domain_contact_attributes`. They are never\n\
|
|
6224
|
+
returned under `attributes`; inline contact attributes surface on the\
|
|
6225
|
+
\ matching `contacts` entry instead.\n\nDerived from the signed `.no`\
|
|
6226
|
+
\ applicant declaration and ignored if supplied: `nor_id_applicant_version`,\n\
|
|
6227
|
+
`nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.\n\nOn\
|
|
6228
|
+
\ update, only `.de` stores attributes and an empty value removes the\
|
|
6205
6229
|
\ stored attribute; `.dk` reads\n`punktum_dk_terms_acceptance` to confirm\
|
|
6206
6230
|
\ a registrant change and other registries ignore attributes.\n"
|
|
6207
6231
|
title: Attributes
|
|
@@ -6301,10 +6325,12 @@ components:
|
|
|
6301
6325
|
\ =\n `REQUEST`. `.de` only.\n\nBoolean keys also accept `1` and `yes`.\n\
|
|
6302
6326
|
\nWritten by the platform and rejected if supplied: `verification_required`,\
|
|
6303
6327
|
\ `promotion`, `promotion_eligibility`,\n`nor_id_declaration`, `nor_id_declaration_token`,\
|
|
6304
|
-
\ `punktum_dk_tracking_no`. They are never
|
|
6305
|
-
|
|
6306
|
-
\ `
|
|
6307
|
-
\
|
|
6328
|
+
\ `punktum_dk_tracking_no`, `domain_contact_attributes`. They are never\n\
|
|
6329
|
+
returned under `attributes`; inline contact attributes surface on the\
|
|
6330
|
+
\ matching `contacts` entry instead.\n\nDerived from the signed `.no`\
|
|
6331
|
+
\ applicant declaration and ignored if supplied: `nor_id_applicant_version`,\n\
|
|
6332
|
+
`nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.\n\nOn\
|
|
6333
|
+
\ update, only `.de` stores attributes and an empty value removes the\
|
|
6308
6334
|
\ stored attribute; `.dk` reads\n`punktum_dk_terms_acceptance` to confirm\
|
|
6309
6335
|
\ a registrant change and other registries ignore attributes.\n"
|
|
6310
6336
|
title: Attributes
|
|
@@ -6388,10 +6414,12 @@ components:
|
|
|
6388
6414
|
\ =\n `REQUEST`. `.de` only.\n\nBoolean keys also accept `1` and `yes`.\n\
|
|
6389
6415
|
\nWritten by the platform and rejected if supplied: `verification_required`,\
|
|
6390
6416
|
\ `promotion`, `promotion_eligibility`,\n`nor_id_declaration`, `nor_id_declaration_token`,\
|
|
6391
|
-
\ `punktum_dk_tracking_no`. They are never
|
|
6392
|
-
|
|
6393
|
-
\ `
|
|
6394
|
-
\
|
|
6417
|
+
\ `punktum_dk_tracking_no`, `domain_contact_attributes`. They are never\n\
|
|
6418
|
+
returned under `attributes`; inline contact attributes surface on the\
|
|
6419
|
+
\ matching `contacts` entry instead.\n\nDerived from the signed `.no`\
|
|
6420
|
+
\ applicant declaration and ignored if supplied: `nor_id_applicant_version`,\n\
|
|
6421
|
+
`nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.\n\nOn\
|
|
6422
|
+
\ update, only `.de` stores attributes and an empty value removes the\
|
|
6395
6423
|
\ stored attribute; `.dk` reads\n`punktum_dk_terms_acceptance` to confirm\
|
|
6396
6424
|
\ a registrant change and other registries ignore attributes.\n"
|
|
6397
6425
|
examples:
|
|
@@ -6475,10 +6503,12 @@ components:
|
|
|
6475
6503
|
\ =\n `REQUEST`. `.de` only.\n\nBoolean keys also accept `1` and `yes`.\n\
|
|
6476
6504
|
\nWritten by the platform and rejected if supplied: `verification_required`,\
|
|
6477
6505
|
\ `promotion`, `promotion_eligibility`,\n`nor_id_declaration`, `nor_id_declaration_token`,\
|
|
6478
|
-
\ `punktum_dk_tracking_no`. They are never
|
|
6479
|
-
|
|
6480
|
-
\ `
|
|
6481
|
-
\
|
|
6506
|
+
\ `punktum_dk_tracking_no`, `domain_contact_attributes`. They are never\n\
|
|
6507
|
+
returned under `attributes`; inline contact attributes surface on the\
|
|
6508
|
+
\ matching `contacts` entry instead.\n\nDerived from the signed `.no`\
|
|
6509
|
+
\ applicant declaration and ignored if supplied: `nor_id_applicant_version`,\n\
|
|
6510
|
+
`nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.\n\nOn\
|
|
6511
|
+
\ update, only `.de` stores attributes and an empty value removes the\
|
|
6482
6512
|
\ stored attribute; `.dk` reads\n`punktum_dk_terms_acceptance` to confirm\
|
|
6483
6513
|
\ a registrant change and other registries ignore attributes.\n"
|
|
6484
6514
|
examples:
|
|
@@ -6607,10 +6637,12 @@ components:
|
|
|
6607
6637
|
\ =\n `REQUEST`. `.de` only.\n\nBoolean keys also accept `1` and `yes`.\n\
|
|
6608
6638
|
\nWritten by the platform and rejected if supplied: `verification_required`,\
|
|
6609
6639
|
\ `promotion`, `promotion_eligibility`,\n`nor_id_declaration`, `nor_id_declaration_token`,\
|
|
6610
|
-
\ `punktum_dk_tracking_no`. They are never
|
|
6611
|
-
|
|
6612
|
-
\ `
|
|
6613
|
-
\
|
|
6640
|
+
\ `punktum_dk_tracking_no`, `domain_contact_attributes`. They are never\n\
|
|
6641
|
+
returned under `attributes`; inline contact attributes surface on the\
|
|
6642
|
+
\ matching `contacts` entry instead.\n\nDerived from the signed `.no`\
|
|
6643
|
+
\ applicant declaration and ignored if supplied: `nor_id_applicant_version`,\n\
|
|
6644
|
+
`nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.\n\nOn\
|
|
6645
|
+
\ update, only `.de` stores attributes and an empty value removes the\
|
|
6614
6646
|
\ stored attribute; `.dk` reads\n`punktum_dk_terms_acceptance` to confirm\
|
|
6615
6647
|
\ a registrant change and other registries ignore attributes.\n"
|
|
6616
6648
|
examples:
|
|
@@ -6848,10 +6880,12 @@ components:
|
|
|
6848
6880
|
\ =\n `REQUEST`. `.de` only.\n\nBoolean keys also accept `1` and `yes`.\n\
|
|
6849
6881
|
\nWritten by the platform and rejected if supplied: `verification_required`,\
|
|
6850
6882
|
\ `promotion`, `promotion_eligibility`,\n`nor_id_declaration`, `nor_id_declaration_token`,\
|
|
6851
|
-
\ `punktum_dk_tracking_no`. They are never
|
|
6852
|
-
|
|
6853
|
-
\ `
|
|
6854
|
-
\
|
|
6883
|
+
\ `punktum_dk_tracking_no`, `domain_contact_attributes`. They are never\n\
|
|
6884
|
+
returned under `attributes`; inline contact attributes surface on the\
|
|
6885
|
+
\ matching `contacts` entry instead.\n\nDerived from the signed `.no`\
|
|
6886
|
+
\ applicant declaration and ignored if supplied: `nor_id_applicant_version`,\n\
|
|
6887
|
+
`nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.\n\nOn\
|
|
6888
|
+
\ update, only `.de` stores attributes and an empty value removes the\
|
|
6855
6889
|
\ stored attribute; `.dk` reads\n`punktum_dk_terms_acceptance` to confirm\
|
|
6856
6890
|
\ a registrant change and other registries ignore attributes.\n"
|
|
6857
6891
|
examples:
|
|
@@ -15239,20 +15273,20 @@ components:
|
|
|
15239
15273
|
title: WhitelabelBaseCreate
|
|
15240
15274
|
type: object
|
|
15241
15275
|
WhitelabelBrandingPatch:
|
|
15242
|
-
description: 'Public patch body. `label` moves the base subdomain to
|
|
15243
|
-
label (
|
|
15276
|
+
description: 'Public patch body. `label` moves the managed base subdomain to
|
|
15277
|
+
a different label (on plus the
|
|
15244
15278
|
|
|
15245
|
-
|
|
15246
|
-
|
|
15279
|
+
custom domain is untouched - it is re-pointed by its hostnames through recheck)
|
|
15280
|
+
and `enabled`
|
|
15247
15281
|
|
|
15248
|
-
serving
|
|
15249
|
-
purchase.
|
|
15282
|
+
starts or stops serving - both applied asynchronously via the reconcile job,
|
|
15283
|
+
neither a purchase.
|
|
15250
15284
|
|
|
15251
|
-
sets the subscription''s auto-renew intent synchronously (EXPIRE
|
|
15252
|
-
at period
|
|
15285
|
+
`renewal_mode` sets the subscription''s auto-renew intent synchronously (EXPIRE
|
|
15286
|
+
= cancel at period
|
|
15253
15287
|
|
|
15254
|
-
un-cancel); it is not a purchase either - no price change. At
|
|
15255
|
-
be given.'
|
|
15288
|
+
end, RENEW = un-cancel); it is not a purchase either - no price change. At
|
|
15289
|
+
least one must be given.'
|
|
15256
15290
|
properties:
|
|
15257
15291
|
enabled:
|
|
15258
15292
|
anyOf:
|
|
@@ -15266,8 +15300,8 @@ components:
|
|
|
15266
15300
|
minLength: 1
|
|
15267
15301
|
type: string
|
|
15268
15302
|
- type: 'null'
|
|
15269
|
-
description: New
|
|
15270
|
-
/ auth.<label>.<suffix>.
|
|
15303
|
+
description: New managed-subdomain label; the base hosts become app.<label>.<suffix>
|
|
15304
|
+
/ auth.<label>.<suffix>. On plus the custom domain keeps serving unchanged.
|
|
15271
15305
|
title: Label
|
|
15272
15306
|
renewal_mode:
|
|
15273
15307
|
anyOf:
|
|
@@ -15336,9 +15370,28 @@ components:
|
|
|
15336
15370
|
minLength: 1
|
|
15337
15371
|
title: Auth Hostname
|
|
15338
15372
|
type: string
|
|
15373
|
+
base_auth_hostname:
|
|
15374
|
+
anyOf:
|
|
15375
|
+
- maxLength: 255
|
|
15376
|
+
minLength: 1
|
|
15377
|
+
type: string
|
|
15378
|
+
- type: 'null'
|
|
15379
|
+
description: Managed base auth host (auth.<base_label>.<suffix>); null until
|
|
15380
|
+
first published
|
|
15381
|
+
title: Base Auth Hostname
|
|
15382
|
+
base_hostname:
|
|
15383
|
+
anyOf:
|
|
15384
|
+
- maxLength: 255
|
|
15385
|
+
minLength: 1
|
|
15386
|
+
type: string
|
|
15387
|
+
- type: 'null'
|
|
15388
|
+
description: Managed base dashboard host (app.<base_label>.<suffix>); on
|
|
15389
|
+
plus a backup address served alongside the custom domain, null until first
|
|
15390
|
+
published
|
|
15391
|
+
title: Base Hostname
|
|
15339
15392
|
base_label:
|
|
15340
|
-
description: Managed-subdomain label;
|
|
15341
|
-
on plus
|
|
15393
|
+
description: Managed-subdomain label; the composed pair is the served pair
|
|
15394
|
+
on base, the backup pair on plus
|
|
15342
15395
|
maxLength: 255
|
|
15343
15396
|
minLength: 1
|
|
15344
15397
|
title: Base Label
|
|
@@ -15498,10 +15551,10 @@ components:
|
|
|
15498
15551
|
type: string
|
|
15499
15552
|
WhitelabelPlusCreate:
|
|
15500
15553
|
additionalProperties: false
|
|
15501
|
-
description: 'Create the plus tier: served on the customer''s own domain
|
|
15502
|
-
|
|
15554
|
+
description: 'Create the plus tier: served on the customer''s own domain, with
|
|
15555
|
+
the managed base subdomain
|
|
15503
15556
|
|
|
15504
|
-
|
|
15557
|
+
composed from `label` served alongside it as a backup address.'
|
|
15505
15558
|
properties:
|
|
15506
15559
|
auth_subdomain:
|
|
15507
15560
|
description: Subdomain the login is served on (e.g. auth -> auth.customer.com)
|
|
@@ -15534,7 +15587,8 @@ components:
|
|
|
15534
15587
|
title: Hostname
|
|
15535
15588
|
type: string
|
|
15536
15589
|
label:
|
|
15537
|
-
description: Managed-subdomain label
|
|
15590
|
+
description: Managed-subdomain label; the composed pair is served alongside
|
|
15591
|
+
the custom domain as a backup
|
|
15538
15592
|
maxLength: 63
|
|
15539
15593
|
minLength: 1
|
|
15540
15594
|
title: Label
|
|
@@ -16176,7 +16230,7 @@ info:
|
|
|
16176
16230
|
\n\n"
|
|
16177
16231
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
16178
16232
|
title: OpusDNS API
|
|
16179
|
-
version: 2026-09-07-
|
|
16233
|
+
version: 2026-09-07-195702
|
|
16180
16234
|
x-logo:
|
|
16181
16235
|
altText: OpusDNS API Reference
|
|
16182
16236
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
package/src/schema.d.ts
CHANGED
|
@@ -5557,7 +5557,7 @@ export interface components {
|
|
|
5557
5557
|
* DomainAttributeKey
|
|
5558
5558
|
* @enum {string}
|
|
5559
5559
|
*/
|
|
5560
|
-
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";
|
|
5560
|
+
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";
|
|
5561
5561
|
/** DomainAvailability */
|
|
5562
5562
|
DomainAvailability: {
|
|
5563
5563
|
/** Domain */
|
|
@@ -5612,6 +5612,13 @@ export interface components {
|
|
|
5612
5612
|
};
|
|
5613
5613
|
/** DomainContactResponse */
|
|
5614
5614
|
DomainContactResponse: {
|
|
5615
|
+
/**
|
|
5616
|
+
* Attributes
|
|
5617
|
+
* @description Registry-specific attributes supplied inline for this contact in this role. Omitted when the contact was submitted without inline attributes; attributes taken from a linked contact attribute set are not reported here.
|
|
5618
|
+
*/
|
|
5619
|
+
attributes?: {
|
|
5620
|
+
[key: string]: string;
|
|
5621
|
+
} | null;
|
|
5615
5622
|
/**
|
|
5616
5623
|
* Contact Id
|
|
5617
5624
|
* Format: typeid
|
|
@@ -5650,7 +5657,8 @@ export interface components {
|
|
|
5650
5657
|
* Boolean keys also accept `1` and `yes`.
|
|
5651
5658
|
*
|
|
5652
5659
|
* Written by the platform and rejected if supplied: `verification_required`, `promotion`, `promotion_eligibility`,
|
|
5653
|
-
* `nor_id_declaration`, `nor_id_declaration_token`, `punktum_dk_tracking_no`. They are never
|
|
5660
|
+
* `nor_id_declaration`, `nor_id_declaration_token`, `punktum_dk_tracking_no`, `domain_contact_attributes`. They are never
|
|
5661
|
+
* returned under `attributes`; inline contact attributes surface on the matching `contacts` entry instead.
|
|
5654
5662
|
*
|
|
5655
5663
|
* Derived from the signed `.no` applicant declaration and ignored if supplied: `nor_id_applicant_version`,
|
|
5656
5664
|
* `nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.
|
|
@@ -5752,7 +5760,8 @@ export interface components {
|
|
|
5752
5760
|
* Boolean keys also accept `1` and `yes`.
|
|
5753
5761
|
*
|
|
5754
5762
|
* Written by the platform and rejected if supplied: `verification_required`, `promotion`, `promotion_eligibility`,
|
|
5755
|
-
* `nor_id_declaration`, `nor_id_declaration_token`, `punktum_dk_tracking_no`. They are never
|
|
5763
|
+
* `nor_id_declaration`, `nor_id_declaration_token`, `punktum_dk_tracking_no`, `domain_contact_attributes`. They are never
|
|
5764
|
+
* returned under `attributes`; inline contact attributes surface on the matching `contacts` entry instead.
|
|
5756
5765
|
*
|
|
5757
5766
|
* Derived from the signed `.no` applicant declaration and ignored if supplied: `nor_id_applicant_version`,
|
|
5758
5767
|
* `nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.
|
|
@@ -5826,7 +5835,8 @@ export interface components {
|
|
|
5826
5835
|
* Boolean keys also accept `1` and `yes`.
|
|
5827
5836
|
*
|
|
5828
5837
|
* Written by the platform and rejected if supplied: `verification_required`, `promotion`, `promotion_eligibility`,
|
|
5829
|
-
* `nor_id_declaration`, `nor_id_declaration_token`, `punktum_dk_tracking_no`. They are never
|
|
5838
|
+
* `nor_id_declaration`, `nor_id_declaration_token`, `punktum_dk_tracking_no`, `domain_contact_attributes`. They are never
|
|
5839
|
+
* returned under `attributes`; inline contact attributes surface on the matching `contacts` entry instead.
|
|
5830
5840
|
*
|
|
5831
5841
|
* Derived from the signed `.no` applicant declaration and ignored if supplied: `nor_id_applicant_version`,
|
|
5832
5842
|
* `nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.
|
|
@@ -5904,7 +5914,8 @@ export interface components {
|
|
|
5904
5914
|
* Boolean keys also accept `1` and `yes`.
|
|
5905
5915
|
*
|
|
5906
5916
|
* Written by the platform and rejected if supplied: `verification_required`, `promotion`, `promotion_eligibility`,
|
|
5907
|
-
* `nor_id_declaration`, `nor_id_declaration_token`, `punktum_dk_tracking_no`. They are never
|
|
5917
|
+
* `nor_id_declaration`, `nor_id_declaration_token`, `punktum_dk_tracking_no`, `domain_contact_attributes`. They are never
|
|
5918
|
+
* returned under `attributes`; inline contact attributes surface on the matching `contacts` entry instead.
|
|
5908
5919
|
*
|
|
5909
5920
|
* Derived from the signed `.no` applicant declaration and ignored if supplied: `nor_id_applicant_version`,
|
|
5910
5921
|
* `nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.
|
|
@@ -7149,7 +7160,8 @@ export interface components {
|
|
|
7149
7160
|
* Boolean keys also accept `1` and `yes`.
|
|
7150
7161
|
*
|
|
7151
7162
|
* Written by the platform and rejected if supplied: `verification_required`, `promotion`, `promotion_eligibility`,
|
|
7152
|
-
* `nor_id_declaration`, `nor_id_declaration_token`, `punktum_dk_tracking_no`. They are never
|
|
7163
|
+
* `nor_id_declaration`, `nor_id_declaration_token`, `punktum_dk_tracking_no`, `domain_contact_attributes`. They are never
|
|
7164
|
+
* returned under `attributes`; inline contact attributes surface on the matching `contacts` entry instead.
|
|
7153
7165
|
*
|
|
7154
7166
|
* Derived from the signed `.no` applicant declaration and ignored if supplied: `nor_id_applicant_version`,
|
|
7155
7167
|
* `nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.
|
|
@@ -7223,7 +7235,8 @@ export interface components {
|
|
|
7223
7235
|
* Boolean keys also accept `1` and `yes`.
|
|
7224
7236
|
*
|
|
7225
7237
|
* Written by the platform and rejected if supplied: `verification_required`, `promotion`, `promotion_eligibility`,
|
|
7226
|
-
* `nor_id_declaration`, `nor_id_declaration_token`, `punktum_dk_tracking_no`. They are never
|
|
7238
|
+
* `nor_id_declaration`, `nor_id_declaration_token`, `punktum_dk_tracking_no`, `domain_contact_attributes`. They are never
|
|
7239
|
+
* returned under `attributes`; inline contact attributes surface on the matching `contacts` entry instead.
|
|
7227
7240
|
*
|
|
7228
7241
|
* Derived from the signed `.no` applicant declaration and ignored if supplied: `nor_id_applicant_version`,
|
|
7229
7242
|
* `nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.
|
|
@@ -7297,7 +7310,8 @@ export interface components {
|
|
|
7297
7310
|
* Boolean keys also accept `1` and `yes`.
|
|
7298
7311
|
*
|
|
7299
7312
|
* Written by the platform and rejected if supplied: `verification_required`, `promotion`, `promotion_eligibility`,
|
|
7300
|
-
* `nor_id_declaration`, `nor_id_declaration_token`, `punktum_dk_tracking_no`. They are never
|
|
7313
|
+
* `nor_id_declaration`, `nor_id_declaration_token`, `punktum_dk_tracking_no`, `domain_contact_attributes`. They are never
|
|
7314
|
+
* returned under `attributes`; inline contact attributes surface on the matching `contacts` entry instead.
|
|
7301
7315
|
*
|
|
7302
7316
|
* Derived from the signed `.no` applicant declaration and ignored if supplied: `nor_id_applicant_version`,
|
|
7303
7317
|
* `nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.
|
|
@@ -7371,7 +7385,8 @@ export interface components {
|
|
|
7371
7385
|
* Boolean keys also accept `1` and `yes`.
|
|
7372
7386
|
*
|
|
7373
7387
|
* Written by the platform and rejected if supplied: `verification_required`, `promotion`, `promotion_eligibility`,
|
|
7374
|
-
* `nor_id_declaration`, `nor_id_declaration_token`, `punktum_dk_tracking_no`. They are never
|
|
7388
|
+
* `nor_id_declaration`, `nor_id_declaration_token`, `punktum_dk_tracking_no`, `domain_contact_attributes`. They are never
|
|
7389
|
+
* returned under `attributes`; inline contact attributes surface on the matching `contacts` entry instead.
|
|
7375
7390
|
*
|
|
7376
7391
|
* Derived from the signed `.no` applicant declaration and ignored if supplied: `nor_id_applicant_version`,
|
|
7377
7392
|
* `nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.
|
|
@@ -7477,7 +7492,8 @@ export interface components {
|
|
|
7477
7492
|
* Boolean keys also accept `1` and `yes`.
|
|
7478
7493
|
*
|
|
7479
7494
|
* Written by the platform and rejected if supplied: `verification_required`, `promotion`, `promotion_eligibility`,
|
|
7480
|
-
* `nor_id_declaration`, `nor_id_declaration_token`, `punktum_dk_tracking_no`. They are never
|
|
7495
|
+
* `nor_id_declaration`, `nor_id_declaration_token`, `punktum_dk_tracking_no`, `domain_contact_attributes`. They are never
|
|
7496
|
+
* returned under `attributes`; inline contact attributes surface on the matching `contacts` entry instead.
|
|
7481
7497
|
*
|
|
7482
7498
|
* Derived from the signed `.no` applicant declaration and ignored if supplied: `nor_id_applicant_version`,
|
|
7483
7499
|
* `nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.
|
|
@@ -7651,7 +7667,8 @@ export interface components {
|
|
|
7651
7667
|
* Boolean keys also accept `1` and `yes`.
|
|
7652
7668
|
*
|
|
7653
7669
|
* Written by the platform and rejected if supplied: `verification_required`, `promotion`, `promotion_eligibility`,
|
|
7654
|
-
* `nor_id_declaration`, `nor_id_declaration_token`, `punktum_dk_tracking_no`. They are never
|
|
7670
|
+
* `nor_id_declaration`, `nor_id_declaration_token`, `punktum_dk_tracking_no`, `domain_contact_attributes`. They are never
|
|
7671
|
+
* returned under `attributes`; inline contact attributes surface on the matching `contacts` entry instead.
|
|
7655
7672
|
*
|
|
7656
7673
|
* Derived from the signed `.no` applicant declaration and ignored if supplied: `nor_id_applicant_version`,
|
|
7657
7674
|
* `nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.
|
|
@@ -13224,11 +13241,11 @@ export interface components {
|
|
|
13224
13241
|
};
|
|
13225
13242
|
/**
|
|
13226
13243
|
* WhitelabelBrandingPatch
|
|
13227
|
-
* @description Public patch body. `label` moves the base subdomain to a different label (
|
|
13228
|
-
*
|
|
13229
|
-
* serving
|
|
13230
|
-
* sets the subscription's auto-renew intent synchronously (EXPIRE = cancel at period
|
|
13231
|
-
* un-cancel); it is not a purchase either - no price change. At least one must be given.
|
|
13244
|
+
* @description Public patch body. `label` moves the managed base subdomain to a different label (on plus the
|
|
13245
|
+
* custom domain is untouched - it is re-pointed by its hostnames through recheck) and `enabled`
|
|
13246
|
+
* starts or stops serving - both applied asynchronously via the reconcile job, neither a purchase.
|
|
13247
|
+
* `renewal_mode` sets the subscription's auto-renew intent synchronously (EXPIRE = cancel at period
|
|
13248
|
+
* end, RENEW = un-cancel); it is not a purchase either - no price change. At least one must be given.
|
|
13232
13249
|
*/
|
|
13233
13250
|
WhitelabelBrandingPatch: {
|
|
13234
13251
|
/**
|
|
@@ -13238,7 +13255,7 @@ export interface components {
|
|
|
13238
13255
|
enabled?: boolean | null;
|
|
13239
13256
|
/**
|
|
13240
13257
|
* Label
|
|
13241
|
-
* @description New
|
|
13258
|
+
* @description New managed-subdomain label; the base hosts become app.<label>.<suffix> / auth.<label>.<suffix>. On plus the custom domain keeps serving unchanged.
|
|
13242
13259
|
*/
|
|
13243
13260
|
label?: string | null;
|
|
13244
13261
|
/** @description Set auto-renew intent: expire cancels at period end (serves out the term), renew un-cancels */
|
|
@@ -13283,9 +13300,19 @@ export interface components {
|
|
|
13283
13300
|
* @description Auth/login hostname served by the authentication system (e.g. auth.customer.com)
|
|
13284
13301
|
*/
|
|
13285
13302
|
auth_hostname: string;
|
|
13303
|
+
/**
|
|
13304
|
+
* Base Auth Hostname
|
|
13305
|
+
* @description Managed base auth host (auth.<base_label>.<suffix>); null until first published
|
|
13306
|
+
*/
|
|
13307
|
+
base_auth_hostname?: string | null;
|
|
13308
|
+
/**
|
|
13309
|
+
* Base Hostname
|
|
13310
|
+
* @description Managed base dashboard host (app.<base_label>.<suffix>); on plus a backup address served alongside the custom domain, null until first published
|
|
13311
|
+
*/
|
|
13312
|
+
base_hostname?: string | null;
|
|
13286
13313
|
/**
|
|
13287
13314
|
* Base Label
|
|
13288
|
-
* @description Managed-subdomain label; served on the
|
|
13315
|
+
* @description Managed-subdomain label; the composed pair is the served pair on base, the backup pair on plus
|
|
13289
13316
|
*/
|
|
13290
13317
|
base_label: string;
|
|
13291
13318
|
/**
|
|
@@ -13377,8 +13404,8 @@ export interface components {
|
|
|
13377
13404
|
WhitelabelOnboardingStatus: "pending_domain_verification" | "verifying" | "provisioning" | "active" | "failed" | "terminated";
|
|
13378
13405
|
/**
|
|
13379
13406
|
* WhitelabelPlusCreate
|
|
13380
|
-
* @description Create the plus tier: served on the customer's own domain
|
|
13381
|
-
*
|
|
13407
|
+
* @description Create the plus tier: served on the customer's own domain, with the managed base subdomain
|
|
13408
|
+
* composed from `label` served alongside it as a backup address.
|
|
13382
13409
|
*/
|
|
13383
13410
|
WhitelabelPlusCreate: {
|
|
13384
13411
|
/**
|
|
@@ -13404,7 +13431,7 @@ export interface components {
|
|
|
13404
13431
|
hostname: string;
|
|
13405
13432
|
/**
|
|
13406
13433
|
* Label
|
|
13407
|
-
* @description Managed-subdomain label
|
|
13434
|
+
* @description Managed-subdomain label; the composed pair is served alongside the custom domain as a backup
|
|
13408
13435
|
*/
|
|
13409
13436
|
label: string;
|
|
13410
13437
|
/** @description Billing period; offered: 1 month or 1 year */
|