@opusdns/api 1.162.0 → 1.164.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 +15 -0
- package/src/helpers/endpoints.ts +2 -0
- package/src/helpers/keys.ts +28 -0
- package/src/helpers/permissions.ts +8 -0
- package/src/helpers/requests.d.ts +3 -0
- package/src/helpers/responses.d.ts +6 -0
- package/src/helpers/schemas.d.ts +3 -0
- package/src/openapi.yaml +220 -103
- package/src/schema.d.ts +122 -20
package/package.json
CHANGED
package/src/helpers/constants.ts
CHANGED
|
@@ -123,6 +123,7 @@ import type {
|
|
|
123
123
|
VerificationDeadlineType,
|
|
124
124
|
VerificationType,
|
|
125
125
|
WhitelabelBrandingTier,
|
|
126
|
+
WhitelabelDnsCheckReason,
|
|
126
127
|
WhitelabelOnboardingFailureCode,
|
|
127
128
|
WhitelabelOnboardingFailureType,
|
|
128
129
|
WhitelabelOnboardingStatus,
|
|
@@ -2324,6 +2325,20 @@ export const WHITELABEL_BRANDING_TIER_VALUES = [
|
|
|
2324
2325
|
'plus',
|
|
2325
2326
|
] as const satisfies ReadonlyArray<WhitelabelBrandingTier>;
|
|
2326
2327
|
|
|
2328
|
+
export const WHITELABEL_DNS_CHECK_REASON = {
|
|
2329
|
+
VERIFIED: "verified",
|
|
2330
|
+
MISSING: "missing",
|
|
2331
|
+
MISMATCH: "mismatch",
|
|
2332
|
+
DNS_ERROR: "dns_error",
|
|
2333
|
+
} as const satisfies Record<string, WhitelabelDnsCheckReason>;
|
|
2334
|
+
|
|
2335
|
+
export const WHITELABEL_DNS_CHECK_REASON_VALUES = [
|
|
2336
|
+
'verified',
|
|
2337
|
+
'missing',
|
|
2338
|
+
'mismatch',
|
|
2339
|
+
'dns_error',
|
|
2340
|
+
] as const satisfies ReadonlyArray<WhitelabelDnsCheckReason>;
|
|
2341
|
+
|
|
2327
2342
|
export const WHITELABEL_ONBOARDING_FAILURE_CODE = {
|
|
2328
2343
|
ZONE_NOT_OWNED: "zone_not_owned",
|
|
2329
2344
|
DELEGATION_MISSING: "delegation_missing",
|
package/src/helpers/endpoints.ts
CHANGED
|
@@ -149,6 +149,7 @@ export const VANITY_NAMESERVER_SETS_BY_SET_ID_ZONES_ENDPOINT = '/v1/vanity-names
|
|
|
149
149
|
export const WHITELABEL_BRANDING_ENDPOINT = '/v1/whitelabel-branding';
|
|
150
150
|
export const WHITELABEL_BRANDING_ASSETS_ENDPOINT = '/v1/whitelabel-branding/assets';
|
|
151
151
|
export const WHITELABEL_BRANDING_ASSETS_BY_ASSET_ID_ENDPOINT = '/v1/whitelabel-branding/assets/{asset_id}';
|
|
152
|
+
export const WHITELABEL_BRANDING_DNS_CHECK_ENDPOINT = '/v1/whitelabel-branding/dns-check';
|
|
152
153
|
export const WHITELABEL_BRANDING_DOCUMENT_ENDPOINT = '/v1/whitelabel-branding/document';
|
|
153
154
|
export const WHITELABEL_BRANDING_EMAIL_PREVIEW_ENDPOINT = '/v1/whitelabel-branding/email/preview';
|
|
154
155
|
export const WHITELABEL_BRANDING_EMAIL_TEMPLATES_ENDPOINT = '/v1/whitelabel-branding/email/templates';
|
|
@@ -308,6 +309,7 @@ export type Endpoint =
|
|
|
308
309
|
| typeof WHITELABEL_BRANDING_ENDPOINT
|
|
309
310
|
| typeof WHITELABEL_BRANDING_ASSETS_ENDPOINT
|
|
310
311
|
| typeof WHITELABEL_BRANDING_ASSETS_BY_ASSET_ID_ENDPOINT
|
|
312
|
+
| typeof WHITELABEL_BRANDING_DNS_CHECK_ENDPOINT
|
|
311
313
|
| typeof WHITELABEL_BRANDING_DOCUMENT_ENDPOINT
|
|
312
314
|
| typeof WHITELABEL_BRANDING_EMAIL_PREVIEW_ENDPOINT
|
|
313
315
|
| typeof WHITELABEL_BRANDING_EMAIL_TEMPLATES_ENDPOINT
|
package/src/helpers/keys.ts
CHANGED
|
@@ -446,6 +446,8 @@ import type {
|
|
|
446
446
|
WhitelabelBrandingPatch,
|
|
447
447
|
WhitelabelBrandingRecheck,
|
|
448
448
|
WhitelabelBranding,
|
|
449
|
+
WhitelabelDnsCheckItem,
|
|
450
|
+
WhitelabelDnsCheck,
|
|
449
451
|
WhitelabelPlusCreate,
|
|
450
452
|
WhitelabelSubscriptionInfo,
|
|
451
453
|
WhitelabelUpgradeToPlus,
|
|
@@ -6062,6 +6064,32 @@ export const KEYS_WHITELABEL_BRANDING = [
|
|
|
6062
6064
|
KEY_WHITELABEL_BRANDING_WHITELABEL_BRANDING_ID,
|
|
6063
6065
|
] as const satisfies (keyof WhitelabelBranding)[];
|
|
6064
6066
|
|
|
6067
|
+
export const KEY_WHITELABEL_DNS_CHECK_ITEM_EXPECTED = 'expected' satisfies keyof WhitelabelDnsCheckItem;
|
|
6068
|
+
export const KEY_WHITELABEL_DNS_CHECK_ITEM_NAME = 'name' satisfies keyof WhitelabelDnsCheckItem;
|
|
6069
|
+
export const KEY_WHITELABEL_DNS_CHECK_ITEM_OBSERVED = 'observed' satisfies keyof WhitelabelDnsCheckItem;
|
|
6070
|
+
export const KEY_WHITELABEL_DNS_CHECK_ITEM_OK = 'ok' satisfies keyof WhitelabelDnsCheckItem;
|
|
6071
|
+
export const KEY_WHITELABEL_DNS_CHECK_ITEM_REASON = 'reason' satisfies keyof WhitelabelDnsCheckItem;
|
|
6072
|
+
export const KEY_WHITELABEL_DNS_CHECK_ITEM_REQUIRED = 'required' satisfies keyof WhitelabelDnsCheckItem;
|
|
6073
|
+
export const KEY_WHITELABEL_DNS_CHECK_ITEM_TYPE = 'type' satisfies keyof WhitelabelDnsCheckItem;
|
|
6074
|
+
|
|
6075
|
+
export const KEYS_WHITELABEL_DNS_CHECK_ITEM = [
|
|
6076
|
+
KEY_WHITELABEL_DNS_CHECK_ITEM_EXPECTED,
|
|
6077
|
+
KEY_WHITELABEL_DNS_CHECK_ITEM_NAME,
|
|
6078
|
+
KEY_WHITELABEL_DNS_CHECK_ITEM_OBSERVED,
|
|
6079
|
+
KEY_WHITELABEL_DNS_CHECK_ITEM_OK,
|
|
6080
|
+
KEY_WHITELABEL_DNS_CHECK_ITEM_REASON,
|
|
6081
|
+
KEY_WHITELABEL_DNS_CHECK_ITEM_REQUIRED,
|
|
6082
|
+
KEY_WHITELABEL_DNS_CHECK_ITEM_TYPE,
|
|
6083
|
+
] as const satisfies (keyof WhitelabelDnsCheckItem)[];
|
|
6084
|
+
|
|
6085
|
+
export const KEY_WHITELABEL_DNS_CHECK_CHECKS = 'checks' satisfies keyof WhitelabelDnsCheck;
|
|
6086
|
+
export const KEY_WHITELABEL_DNS_CHECK_READY = 'ready' satisfies keyof WhitelabelDnsCheck;
|
|
6087
|
+
|
|
6088
|
+
export const KEYS_WHITELABEL_DNS_CHECK = [
|
|
6089
|
+
KEY_WHITELABEL_DNS_CHECK_CHECKS,
|
|
6090
|
+
KEY_WHITELABEL_DNS_CHECK_READY,
|
|
6091
|
+
] as const satisfies (keyof WhitelabelDnsCheck)[];
|
|
6092
|
+
|
|
6065
6093
|
export const KEY_WHITELABEL_PLUS_CREATE_AUTH_SUBDOMAIN = 'auth_subdomain' satisfies keyof WhitelabelPlusCreate;
|
|
6066
6094
|
export const KEY_WHITELABEL_PLUS_CREATE_CREATE_ZONE = 'create_zone' satisfies keyof WhitelabelPlusCreate;
|
|
6067
6095
|
export const KEY_WHITELABEL_PLUS_CREATE_DASHBOARD_SUBDOMAIN = 'dashboard_subdomain' satisfies keyof WhitelabelPlusCreate;
|
|
@@ -152,6 +152,7 @@ import {
|
|
|
152
152
|
VANITY_NAMESERVER_SETS_ENDPOINT,
|
|
153
153
|
WHITELABEL_BRANDING_ASSETS_BY_ASSET_ID_ENDPOINT,
|
|
154
154
|
WHITELABEL_BRANDING_ASSETS_ENDPOINT,
|
|
155
|
+
WHITELABEL_BRANDING_DNS_CHECK_ENDPOINT,
|
|
155
156
|
WHITELABEL_BRANDING_DOCUMENT_ENDPOINT,
|
|
156
157
|
WHITELABEL_BRANDING_EMAIL_PREVIEW_ENDPOINT,
|
|
157
158
|
WHITELABEL_BRANDING_EMAIL_TEMPLATES_ENDPOINT,
|
|
@@ -1277,6 +1278,13 @@ export const REQUIRED_PERMISSIONS = {
|
|
|
1277
1278
|
patch: [],
|
|
1278
1279
|
delete: [],
|
|
1279
1280
|
},
|
|
1281
|
+
[WHITELABEL_BRANDING_DNS_CHECK_ENDPOINT]: {
|
|
1282
|
+
get: [PUBLIC_PERMISSION.WHITELABEL_BRANDING_READ],
|
|
1283
|
+
post: [],
|
|
1284
|
+
put: [],
|
|
1285
|
+
patch: [],
|
|
1286
|
+
delete: [],
|
|
1287
|
+
},
|
|
1280
1288
|
[WHITELABEL_BRANDING_DOCUMENT_ENDPOINT]: {
|
|
1281
1289
|
get: [PUBLIC_PERMISSION.WHITELABEL_BRANDING_READ],
|
|
1282
1290
|
post: [PUBLIC_PERMISSION.WHITELABEL_BRANDING_MANAGE],
|
|
@@ -1203,6 +1203,9 @@ export type DELETE_WhitelabelBrandingAssetsByAssetId_Request = {
|
|
|
1203
1203
|
};
|
|
1204
1204
|
export type DELETE_WhitelabelBrandingAssetsByAssetId_Request_Path = DELETE_WhitelabelBrandingAssetsByAssetId_Request['parameters']['path'];
|
|
1205
1205
|
|
|
1206
|
+
export type GET_WhitelabelBrandingDnsCheck_Request = {
|
|
1207
|
+
};
|
|
1208
|
+
|
|
1206
1209
|
export type GET_WhitelabelBrandingDocument_Request = {
|
|
1207
1210
|
};
|
|
1208
1211
|
|
|
@@ -120,6 +120,7 @@ import type {
|
|
|
120
120
|
VanityNameserverSetSummaryDTO,
|
|
121
121
|
VanityNsCheckRes,
|
|
122
122
|
WhitelabelBranding,
|
|
123
|
+
WhitelabelDnsCheck,
|
|
123
124
|
} from './schemas';
|
|
124
125
|
|
|
125
126
|
export type DELETE_AiConciergeConversationsByConversationId_Response = DELETE_AiConciergeConversationsByConversationId_Response_401 | DELETE_AiConciergeConversationsByConversationId_Response_404 | DELETE_AiConciergeConversationsByConversationId_Response_422 | DELETE_AiConciergeConversationsByConversationId_Response_502;
|
|
@@ -887,6 +888,11 @@ export type GET_WhitelabelBrandingAssets_Response = GET_WhitelabelBrandingAssets
|
|
|
887
888
|
export type GET_WhitelabelBrandingAssets_Response_200 = ListBrandingAssets;
|
|
888
889
|
export type GET_WhitelabelBrandingAssets_Response_422 = HTTPValidationError;
|
|
889
890
|
|
|
891
|
+
export type GET_WhitelabelBrandingDnsCheck_Response = GET_WhitelabelBrandingDnsCheck_Response_200 | GET_WhitelabelBrandingDnsCheck_Response_422;
|
|
892
|
+
|
|
893
|
+
export type GET_WhitelabelBrandingDnsCheck_Response_200 = WhitelabelDnsCheck;
|
|
894
|
+
export type GET_WhitelabelBrandingDnsCheck_Response_422 = HTTPValidationError;
|
|
895
|
+
|
|
890
896
|
export type GET_WhitelabelBrandingDocument_Response = GET_WhitelabelBrandingDocument_Response_200 | GET_WhitelabelBrandingDocument_Response_422;
|
|
891
897
|
|
|
892
898
|
export type GET_WhitelabelBrandingDocument_Response_200 = BrandingDocument;
|
package/src/helpers/schemas.d.ts
CHANGED
|
@@ -594,6 +594,9 @@ export type WhitelabelBrandingPatch = components['schemas']['WhitelabelBrandingP
|
|
|
594
594
|
export type WhitelabelBrandingRecheck = components['schemas']['WhitelabelBrandingRecheck'];
|
|
595
595
|
export type WhitelabelBranding = components['schemas']['WhitelabelBrandingResponse'];
|
|
596
596
|
export type WhitelabelBrandingTier = components['schemas']['WhitelabelBrandingTier'];
|
|
597
|
+
export type WhitelabelDnsCheckItem = components['schemas']['WhitelabelDnsCheckItem'];
|
|
598
|
+
export type WhitelabelDnsCheckReason = components['schemas']['WhitelabelDnsCheckReason'];
|
|
599
|
+
export type WhitelabelDnsCheck = components['schemas']['WhitelabelDnsCheckResponse'];
|
|
597
600
|
export type WhitelabelOnboardingFailureCode = components['schemas']['WhitelabelOnboardingFailureCode'];
|
|
598
601
|
export type WhitelabelOnboardingFailureType = components['schemas']['WhitelabelOnboardingFailureType'];
|
|
599
602
|
export type WhitelabelOnboardingStatus = components['schemas']['WhitelabelOnboardingStatus'];
|
package/src/openapi.yaml
CHANGED
|
@@ -4049,18 +4049,21 @@ components:
|
|
|
4049
4049
|
\ `monthly` or `yearly`. All TLDs on create, transfer-in and update. Selects\
|
|
4050
4050
|
\ the\n period of the next renewal; the current expiry date does not\
|
|
4051
4051
|
\ move. On transfer-in without `period` it also sets the\n period added\
|
|
4052
|
-
\ by the transfer.
|
|
4053
|
-
\
|
|
4054
|
-
\
|
|
4055
|
-
\
|
|
4056
|
-
\
|
|
4057
|
-
\
|
|
4058
|
-
- `
|
|
4059
|
-
|
|
4060
|
-
|
|
4061
|
-
|
|
4062
|
-
\
|
|
4063
|
-
\ `
|
|
4052
|
+
\ by the transfer. Omitted on create or transfer-in, it follows the term\
|
|
4053
|
+
\ being bought: a one-month\n `period` renews monthly and anything else\
|
|
4054
|
+
\ yearly, except a longer month-unit term, which leaves it unset so that\
|
|
4055
|
+
\ the\n product's default billing period decides. Supplying `monthly`\
|
|
4056
|
+
\ where the TLD sells no one-month renewal is rejected on\n create, transfer-in\
|
|
4057
|
+
\ and update; a `monthly` stored before that rule applied is ignored at\
|
|
4058
|
+
\ renewal.\n- `music_registrant_attestation`: `true`. `.music` registration.\n\
|
|
4059
|
+
- `nic_it_compliance_confirmation`: `true`. `.it` registration and transfer.\n\
|
|
4060
|
+
- `travel_industry_acknowledgement`: `true`. `.travel` registration.\n\
|
|
4061
|
+
- `internet_ee_registrant_agreement`: `true`. `.ee` registration.\n- `punktum_dk_terms_acceptance`:\
|
|
4062
|
+
\ `true`. `.dk` registration and registrant change.\n- `de_general_request_contact`,\
|
|
4063
|
+
\ `de_abuse_contact`: id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE`\
|
|
4064
|
+
\ =\n `REQUEST`. `.de` only.\n\nBoolean keys also accept `1` and `yes`.\n\
|
|
4065
|
+
\nWritten by the platform and rejected if supplied: `verification_required`,\
|
|
4066
|
+
\ `promotion`, `promotion_eligibility`,\n`nor_id_declaration`, `nor_id_declaration_token`,\
|
|
4064
4067
|
\ `punktum_dk_tracking_no`, `domain_contact_attributes`. They are never\n\
|
|
4065
4068
|
returned under `attributes`; inline contact attributes surface on the\
|
|
4066
4069
|
\ matching `contacts` entry instead.\n\nDerived from the signed `.no`\
|
|
@@ -4178,9 +4181,13 @@ components:
|
|
|
4178
4181
|
\ keys:\n\n- `auto_renew_period`: `monthly` or `yearly`. All TLDs on create,\
|
|
4179
4182
|
\ transfer-in and update. Selects the\n period of the next renewal; the\
|
|
4180
4183
|
\ current expiry date does not move. On transfer-in without `period` it\
|
|
4181
|
-
\ also sets the\n period added by the transfer.
|
|
4182
|
-
\
|
|
4183
|
-
\
|
|
4184
|
+
\ also sets the\n period added by the transfer. Omitted on create or\
|
|
4185
|
+
\ transfer-in, it follows the term being bought: a one-month\n `period`\
|
|
4186
|
+
\ renews monthly and anything else yearly, except a longer month-unit\
|
|
4187
|
+
\ term, which leaves it unset so that the\n product's default billing\
|
|
4188
|
+
\ period decides. Supplying `monthly` where the TLD sells no one-month\
|
|
4189
|
+
\ renewal is rejected on\n create, transfer-in and update; a `monthly`\
|
|
4190
|
+
\ stored before that rule applied is ignored at renewal.\n- `music_registrant_attestation`:\
|
|
4184
4191
|
\ `true`. `.music` registration.\n- `nic_it_compliance_confirmation`:\
|
|
4185
4192
|
\ `true`. `.it` registration and transfer.\n- `travel_industry_acknowledgement`:\
|
|
4186
4193
|
\ `true`. `.travel` registration.\n- `internet_ee_registrant_agreement`:\
|
|
@@ -4292,18 +4299,21 @@ components:
|
|
|
4292
4299
|
\ `monthly` or `yearly`. All TLDs on create, transfer-in and update. Selects\
|
|
4293
4300
|
\ the\n period of the next renewal; the current expiry date does not\
|
|
4294
4301
|
\ move. On transfer-in without `period` it also sets the\n period added\
|
|
4295
|
-
\ by the transfer.
|
|
4296
|
-
\
|
|
4297
|
-
\
|
|
4298
|
-
\
|
|
4299
|
-
\
|
|
4300
|
-
\
|
|
4301
|
-
- `
|
|
4302
|
-
|
|
4303
|
-
|
|
4304
|
-
|
|
4305
|
-
\
|
|
4306
|
-
\ `
|
|
4302
|
+
\ by the transfer. Omitted on create or transfer-in, it follows the term\
|
|
4303
|
+
\ being bought: a one-month\n `period` renews monthly and anything else\
|
|
4304
|
+
\ yearly, except a longer month-unit term, which leaves it unset so that\
|
|
4305
|
+
\ the\n product's default billing period decides. Supplying `monthly`\
|
|
4306
|
+
\ where the TLD sells no one-month renewal is rejected on\n create, transfer-in\
|
|
4307
|
+
\ and update; a `monthly` stored before that rule applied is ignored at\
|
|
4308
|
+
\ renewal.\n- `music_registrant_attestation`: `true`. `.music` registration.\n\
|
|
4309
|
+
- `nic_it_compliance_confirmation`: `true`. `.it` registration and transfer.\n\
|
|
4310
|
+
- `travel_industry_acknowledgement`: `true`. `.travel` registration.\n\
|
|
4311
|
+
- `internet_ee_registrant_agreement`: `true`. `.ee` registration.\n- `punktum_dk_terms_acceptance`:\
|
|
4312
|
+
\ `true`. `.dk` registration and registrant change.\n- `de_general_request_contact`,\
|
|
4313
|
+
\ `de_abuse_contact`: id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE`\
|
|
4314
|
+
\ =\n `REQUEST`. `.de` only.\n\nBoolean keys also accept `1` and `yes`.\n\
|
|
4315
|
+
\nWritten by the platform and rejected if supplied: `verification_required`,\
|
|
4316
|
+
\ `promotion`, `promotion_eligibility`,\n`nor_id_declaration`, `nor_id_declaration_token`,\
|
|
4307
4317
|
\ `punktum_dk_tracking_no`, `domain_contact_attributes`. They are never\n\
|
|
4308
4318
|
returned under `attributes`; inline contact attributes surface on the\
|
|
4309
4319
|
\ matching `contacts` entry instead.\n\nDerived from the signed `.no`\
|
|
@@ -4396,18 +4406,21 @@ components:
|
|
|
4396
4406
|
\ `monthly` or `yearly`. All TLDs on create, transfer-in and update. Selects\
|
|
4397
4407
|
\ the\n period of the next renewal; the current expiry date does not\
|
|
4398
4408
|
\ move. On transfer-in without `period` it also sets the\n period added\
|
|
4399
|
-
\ by the transfer.
|
|
4400
|
-
\
|
|
4401
|
-
\
|
|
4402
|
-
\
|
|
4403
|
-
\
|
|
4404
|
-
\
|
|
4405
|
-
- `
|
|
4406
|
-
|
|
4407
|
-
|
|
4408
|
-
|
|
4409
|
-
\
|
|
4410
|
-
\ `
|
|
4409
|
+
\ by the transfer. Omitted on create or transfer-in, it follows the term\
|
|
4410
|
+
\ being bought: a one-month\n `period` renews monthly and anything else\
|
|
4411
|
+
\ yearly, except a longer month-unit term, which leaves it unset so that\
|
|
4412
|
+
\ the\n product's default billing period decides. Supplying `monthly`\
|
|
4413
|
+
\ where the TLD sells no one-month renewal is rejected on\n create, transfer-in\
|
|
4414
|
+
\ and update; a `monthly` stored before that rule applied is ignored at\
|
|
4415
|
+
\ renewal.\n- `music_registrant_attestation`: `true`. `.music` registration.\n\
|
|
4416
|
+
- `nic_it_compliance_confirmation`: `true`. `.it` registration and transfer.\n\
|
|
4417
|
+
- `travel_industry_acknowledgement`: `true`. `.travel` registration.\n\
|
|
4418
|
+
- `internet_ee_registrant_agreement`: `true`. `.ee` registration.\n- `punktum_dk_terms_acceptance`:\
|
|
4419
|
+
\ `true`. `.dk` registration and registrant change.\n- `de_general_request_contact`,\
|
|
4420
|
+
\ `de_abuse_contact`: id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE`\
|
|
4421
|
+
\ =\n `REQUEST`. `.de` only.\n\nBoolean keys also accept `1` and `yes`.\n\
|
|
4422
|
+
\nWritten by the platform and rejected if supplied: `verification_required`,\
|
|
4423
|
+
\ `promotion`, `promotion_eligibility`,\n`nor_id_declaration`, `nor_id_declaration_token`,\
|
|
4411
4424
|
\ `punktum_dk_tracking_no`, `domain_contact_attributes`. They are never\n\
|
|
4412
4425
|
returned under `attributes`; inline contact attributes surface on the\
|
|
4413
4426
|
\ matching `contacts` entry instead.\n\nDerived from the signed `.no`\
|
|
@@ -6287,9 +6300,13 @@ components:
|
|
|
6287
6300
|
\ keys:\n\n- `auto_renew_period`: `monthly` or `yearly`. All TLDs on create,\
|
|
6288
6301
|
\ transfer-in and update. Selects the\n period of the next renewal; the\
|
|
6289
6302
|
\ current expiry date does not move. On transfer-in without `period` it\
|
|
6290
|
-
\ also sets the\n period added by the transfer.
|
|
6291
|
-
\
|
|
6292
|
-
\
|
|
6303
|
+
\ also sets the\n period added by the transfer. Omitted on create or\
|
|
6304
|
+
\ transfer-in, it follows the term being bought: a one-month\n `period`\
|
|
6305
|
+
\ renews monthly and anything else yearly, except a longer month-unit\
|
|
6306
|
+
\ term, which leaves it unset so that the\n product's default billing\
|
|
6307
|
+
\ period decides. Supplying `monthly` where the TLD sells no one-month\
|
|
6308
|
+
\ renewal is rejected on\n create, transfer-in and update; a `monthly`\
|
|
6309
|
+
\ stored before that rule applied is ignored at renewal.\n- `music_registrant_attestation`:\
|
|
6293
6310
|
\ `true`. `.music` registration.\n- `nic_it_compliance_confirmation`:\
|
|
6294
6311
|
\ `true`. `.it` registration and transfer.\n- `travel_industry_acknowledgement`:\
|
|
6295
6312
|
\ `true`. `.travel` registration.\n- `internet_ee_registrant_agreement`:\
|
|
@@ -6401,18 +6418,21 @@ components:
|
|
|
6401
6418
|
\ `monthly` or `yearly`. All TLDs on create, transfer-in and update. Selects\
|
|
6402
6419
|
\ the\n period of the next renewal; the current expiry date does not\
|
|
6403
6420
|
\ move. On transfer-in without `period` it also sets the\n period added\
|
|
6404
|
-
\ by the transfer.
|
|
6405
|
-
\
|
|
6406
|
-
\
|
|
6407
|
-
\
|
|
6408
|
-
\
|
|
6409
|
-
\
|
|
6410
|
-
- `
|
|
6411
|
-
|
|
6412
|
-
|
|
6413
|
-
|
|
6414
|
-
\
|
|
6415
|
-
\ `
|
|
6421
|
+
\ by the transfer. Omitted on create or transfer-in, it follows the term\
|
|
6422
|
+
\ being bought: a one-month\n `period` renews monthly and anything else\
|
|
6423
|
+
\ yearly, except a longer month-unit term, which leaves it unset so that\
|
|
6424
|
+
\ the\n product's default billing period decides. Supplying `monthly`\
|
|
6425
|
+
\ where the TLD sells no one-month renewal is rejected on\n create, transfer-in\
|
|
6426
|
+
\ and update; a `monthly` stored before that rule applied is ignored at\
|
|
6427
|
+
\ renewal.\n- `music_registrant_attestation`: `true`. `.music` registration.\n\
|
|
6428
|
+
- `nic_it_compliance_confirmation`: `true`. `.it` registration and transfer.\n\
|
|
6429
|
+
- `travel_industry_acknowledgement`: `true`. `.travel` registration.\n\
|
|
6430
|
+
- `internet_ee_registrant_agreement`: `true`. `.ee` registration.\n- `punktum_dk_terms_acceptance`:\
|
|
6431
|
+
\ `true`. `.dk` registration and registrant change.\n- `de_general_request_contact`,\
|
|
6432
|
+
\ `de_abuse_contact`: id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE`\
|
|
6433
|
+
\ =\n `REQUEST`. `.de` only.\n\nBoolean keys also accept `1` and `yes`.\n\
|
|
6434
|
+
\nWritten by the platform and rejected if supplied: `verification_required`,\
|
|
6435
|
+
\ `promotion`, `promotion_eligibility`,\n`nor_id_declaration`, `nor_id_declaration_token`,\
|
|
6416
6436
|
\ `punktum_dk_tracking_no`, `domain_contact_attributes`. They are never\n\
|
|
6417
6437
|
returned under `attributes`; inline contact attributes surface on the\
|
|
6418
6438
|
\ matching `contacts` entry instead.\n\nDerived from the signed `.no`\
|
|
@@ -6499,18 +6519,21 @@ components:
|
|
|
6499
6519
|
\ `monthly` or `yearly`. All TLDs on create, transfer-in and update. Selects\
|
|
6500
6520
|
\ the\n period of the next renewal; the current expiry date does not\
|
|
6501
6521
|
\ move. On transfer-in without `period` it also sets the\n period added\
|
|
6502
|
-
\ by the transfer.
|
|
6503
|
-
\
|
|
6504
|
-
\
|
|
6505
|
-
\
|
|
6506
|
-
\
|
|
6507
|
-
\
|
|
6508
|
-
- `
|
|
6509
|
-
|
|
6510
|
-
|
|
6511
|
-
|
|
6512
|
-
\
|
|
6513
|
-
\ `
|
|
6522
|
+
\ by the transfer. Omitted on create or transfer-in, it follows the term\
|
|
6523
|
+
\ being bought: a one-month\n `period` renews monthly and anything else\
|
|
6524
|
+
\ yearly, except a longer month-unit term, which leaves it unset so that\
|
|
6525
|
+
\ the\n product's default billing period decides. Supplying `monthly`\
|
|
6526
|
+
\ where the TLD sells no one-month renewal is rejected on\n create, transfer-in\
|
|
6527
|
+
\ and update; a `monthly` stored before that rule applied is ignored at\
|
|
6528
|
+
\ renewal.\n- `music_registrant_attestation`: `true`. `.music` registration.\n\
|
|
6529
|
+
- `nic_it_compliance_confirmation`: `true`. `.it` registration and transfer.\n\
|
|
6530
|
+
- `travel_industry_acknowledgement`: `true`. `.travel` registration.\n\
|
|
6531
|
+
- `internet_ee_registrant_agreement`: `true`. `.ee` registration.\n- `punktum_dk_terms_acceptance`:\
|
|
6532
|
+
\ `true`. `.dk` registration and registrant change.\n- `de_general_request_contact`,\
|
|
6533
|
+
\ `de_abuse_contact`: id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE`\
|
|
6534
|
+
\ =\n `REQUEST`. `.de` only.\n\nBoolean keys also accept `1` and `yes`.\n\
|
|
6535
|
+
\nWritten by the platform and rejected if supplied: `verification_required`,\
|
|
6536
|
+
\ `promotion`, `promotion_eligibility`,\n`nor_id_declaration`, `nor_id_declaration_token`,\
|
|
6514
6537
|
\ `punktum_dk_tracking_no`, `domain_contact_attributes`. They are never\n\
|
|
6515
6538
|
returned under `attributes`; inline contact attributes surface on the\
|
|
6516
6539
|
\ matching `contacts` entry instead.\n\nDerived from the signed `.no`\
|
|
@@ -6597,18 +6620,21 @@ components:
|
|
|
6597
6620
|
\ `monthly` or `yearly`. All TLDs on create, transfer-in and update. Selects\
|
|
6598
6621
|
\ the\n period of the next renewal; the current expiry date does not\
|
|
6599
6622
|
\ move. On transfer-in without `period` it also sets the\n period added\
|
|
6600
|
-
\ by the transfer.
|
|
6601
|
-
\
|
|
6602
|
-
\
|
|
6603
|
-
\
|
|
6604
|
-
\
|
|
6605
|
-
\
|
|
6606
|
-
- `
|
|
6607
|
-
|
|
6608
|
-
|
|
6609
|
-
|
|
6610
|
-
\
|
|
6611
|
-
\ `
|
|
6623
|
+
\ by the transfer. Omitted on create or transfer-in, it follows the term\
|
|
6624
|
+
\ being bought: a one-month\n `period` renews monthly and anything else\
|
|
6625
|
+
\ yearly, except a longer month-unit term, which leaves it unset so that\
|
|
6626
|
+
\ the\n product's default billing period decides. Supplying `monthly`\
|
|
6627
|
+
\ where the TLD sells no one-month renewal is rejected on\n create, transfer-in\
|
|
6628
|
+
\ and update; a `monthly` stored before that rule applied is ignored at\
|
|
6629
|
+
\ renewal.\n- `music_registrant_attestation`: `true`. `.music` registration.\n\
|
|
6630
|
+
- `nic_it_compliance_confirmation`: `true`. `.it` registration and transfer.\n\
|
|
6631
|
+
- `travel_industry_acknowledgement`: `true`. `.travel` registration.\n\
|
|
6632
|
+
- `internet_ee_registrant_agreement`: `true`. `.ee` registration.\n- `punktum_dk_terms_acceptance`:\
|
|
6633
|
+
\ `true`. `.dk` registration and registrant change.\n- `de_general_request_contact`,\
|
|
6634
|
+
\ `de_abuse_contact`: id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE`\
|
|
6635
|
+
\ =\n `REQUEST`. `.de` only.\n\nBoolean keys also accept `1` and `yes`.\n\
|
|
6636
|
+
\nWritten by the platform and rejected if supplied: `verification_required`,\
|
|
6637
|
+
\ `promotion`, `promotion_eligibility`,\n`nor_id_declaration`, `nor_id_declaration_token`,\
|
|
6612
6638
|
\ `punktum_dk_tracking_no`, `domain_contact_attributes`. They are never\n\
|
|
6613
6639
|
returned under `attributes`; inline contact attributes surface on the\
|
|
6614
6640
|
\ matching `contacts` entry instead.\n\nDerived from the signed `.no`\
|
|
@@ -6740,18 +6766,21 @@ components:
|
|
|
6740
6766
|
\ `monthly` or `yearly`. All TLDs on create, transfer-in and update. Selects\
|
|
6741
6767
|
\ the\n period of the next renewal; the current expiry date does not\
|
|
6742
6768
|
\ move. On transfer-in without `period` it also sets the\n period added\
|
|
6743
|
-
\ by the transfer.
|
|
6744
|
-
\
|
|
6745
|
-
\
|
|
6746
|
-
\
|
|
6747
|
-
\
|
|
6748
|
-
\
|
|
6749
|
-
- `
|
|
6750
|
-
|
|
6751
|
-
|
|
6752
|
-
|
|
6753
|
-
\
|
|
6754
|
-
\ `
|
|
6769
|
+
\ by the transfer. Omitted on create or transfer-in, it follows the term\
|
|
6770
|
+
\ being bought: a one-month\n `period` renews monthly and anything else\
|
|
6771
|
+
\ yearly, except a longer month-unit term, which leaves it unset so that\
|
|
6772
|
+
\ the\n product's default billing period decides. Supplying `monthly`\
|
|
6773
|
+
\ where the TLD sells no one-month renewal is rejected on\n create, transfer-in\
|
|
6774
|
+
\ and update; a `monthly` stored before that rule applied is ignored at\
|
|
6775
|
+
\ renewal.\n- `music_registrant_attestation`: `true`. `.music` registration.\n\
|
|
6776
|
+
- `nic_it_compliance_confirmation`: `true`. `.it` registration and transfer.\n\
|
|
6777
|
+
- `travel_industry_acknowledgement`: `true`. `.travel` registration.\n\
|
|
6778
|
+
- `internet_ee_registrant_agreement`: `true`. `.ee` registration.\n- `punktum_dk_terms_acceptance`:\
|
|
6779
|
+
\ `true`. `.dk` registration and registrant change.\n- `de_general_request_contact`,\
|
|
6780
|
+
\ `de_abuse_contact`: id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE`\
|
|
6781
|
+
\ =\n `REQUEST`. `.de` only.\n\nBoolean keys also accept `1` and `yes`.\n\
|
|
6782
|
+
\nWritten by the platform and rejected if supplied: `verification_required`,\
|
|
6783
|
+
\ `promotion`, `promotion_eligibility`,\n`nor_id_declaration`, `nor_id_declaration_token`,\
|
|
6755
6784
|
\ `punktum_dk_tracking_no`, `domain_contact_attributes`. They are never\n\
|
|
6756
6785
|
returned under `attributes`; inline contact attributes surface on the\
|
|
6757
6786
|
\ matching `contacts` entry instead.\n\nDerived from the signed `.no`\
|
|
@@ -6992,18 +7021,21 @@ components:
|
|
|
6992
7021
|
\ `monthly` or `yearly`. All TLDs on create, transfer-in and update. Selects\
|
|
6993
7022
|
\ the\n period of the next renewal; the current expiry date does not\
|
|
6994
7023
|
\ move. On transfer-in without `period` it also sets the\n period added\
|
|
6995
|
-
\ by the transfer.
|
|
6996
|
-
\
|
|
6997
|
-
\
|
|
6998
|
-
\
|
|
6999
|
-
\
|
|
7000
|
-
\
|
|
7001
|
-
- `
|
|
7002
|
-
|
|
7003
|
-
|
|
7004
|
-
|
|
7005
|
-
\
|
|
7006
|
-
\ `
|
|
7024
|
+
\ by the transfer. Omitted on create or transfer-in, it follows the term\
|
|
7025
|
+
\ being bought: a one-month\n `period` renews monthly and anything else\
|
|
7026
|
+
\ yearly, except a longer month-unit term, which leaves it unset so that\
|
|
7027
|
+
\ the\n product's default billing period decides. Supplying `monthly`\
|
|
7028
|
+
\ where the TLD sells no one-month renewal is rejected on\n create, transfer-in\
|
|
7029
|
+
\ and update; a `monthly` stored before that rule applied is ignored at\
|
|
7030
|
+
\ renewal.\n- `music_registrant_attestation`: `true`. `.music` registration.\n\
|
|
7031
|
+
- `nic_it_compliance_confirmation`: `true`. `.it` registration and transfer.\n\
|
|
7032
|
+
- `travel_industry_acknowledgement`: `true`. `.travel` registration.\n\
|
|
7033
|
+
- `internet_ee_registrant_agreement`: `true`. `.ee` registration.\n- `punktum_dk_terms_acceptance`:\
|
|
7034
|
+
\ `true`. `.dk` registration and registrant change.\n- `de_general_request_contact`,\
|
|
7035
|
+
\ `de_abuse_contact`: id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE`\
|
|
7036
|
+
\ =\n `REQUEST`. `.de` only.\n\nBoolean keys also accept `1` and `yes`.\n\
|
|
7037
|
+
\nWritten by the platform and rejected if supplied: `verification_required`,\
|
|
7038
|
+
\ `promotion`, `promotion_eligibility`,\n`nor_id_declaration`, `nor_id_declaration_token`,\
|
|
7007
7039
|
\ `punktum_dk_tracking_no`, `domain_contact_attributes`. They are never\n\
|
|
7008
7040
|
returned under `attributes`; inline contact attributes surface on the\
|
|
7009
7041
|
\ matching `contacts` entry instead.\n\nDerived from the signed `.no`\
|
|
@@ -15673,6 +15705,64 @@ components:
|
|
|
15673
15705
|
- plus
|
|
15674
15706
|
title: WhitelabelBrandingTier
|
|
15675
15707
|
type: string
|
|
15708
|
+
WhitelabelDnsCheckItem:
|
|
15709
|
+
properties:
|
|
15710
|
+
expected:
|
|
15711
|
+
items:
|
|
15712
|
+
type: string
|
|
15713
|
+
title: Expected
|
|
15714
|
+
type: array
|
|
15715
|
+
name:
|
|
15716
|
+
title: Name
|
|
15717
|
+
type: string
|
|
15718
|
+
observed:
|
|
15719
|
+
items:
|
|
15720
|
+
type: string
|
|
15721
|
+
title: Observed
|
|
15722
|
+
type: array
|
|
15723
|
+
ok:
|
|
15724
|
+
title: Ok
|
|
15725
|
+
type: boolean
|
|
15726
|
+
reason:
|
|
15727
|
+
$ref: '#/components/schemas/WhitelabelDnsCheckReason'
|
|
15728
|
+
required:
|
|
15729
|
+
default: true
|
|
15730
|
+
title: Required
|
|
15731
|
+
type: boolean
|
|
15732
|
+
type:
|
|
15733
|
+
$ref: '#/components/schemas/DnsRrsetType'
|
|
15734
|
+
required:
|
|
15735
|
+
- name
|
|
15736
|
+
- type
|
|
15737
|
+
- expected
|
|
15738
|
+
- observed
|
|
15739
|
+
- ok
|
|
15740
|
+
- reason
|
|
15741
|
+
title: WhitelabelDnsCheckItem
|
|
15742
|
+
type: object
|
|
15743
|
+
WhitelabelDnsCheckReason:
|
|
15744
|
+
enum:
|
|
15745
|
+
- verified
|
|
15746
|
+
- missing
|
|
15747
|
+
- mismatch
|
|
15748
|
+
- dns_error
|
|
15749
|
+
title: WhitelabelDnsCheckReason
|
|
15750
|
+
type: string
|
|
15751
|
+
WhitelabelDnsCheckResponse:
|
|
15752
|
+
properties:
|
|
15753
|
+
checks:
|
|
15754
|
+
items:
|
|
15755
|
+
$ref: '#/components/schemas/WhitelabelDnsCheckItem'
|
|
15756
|
+
title: Checks
|
|
15757
|
+
type: array
|
|
15758
|
+
ready:
|
|
15759
|
+
title: Ready
|
|
15760
|
+
type: boolean
|
|
15761
|
+
required:
|
|
15762
|
+
- ready
|
|
15763
|
+
- checks
|
|
15764
|
+
title: WhitelabelDnsCheckResponse
|
|
15765
|
+
type: object
|
|
15676
15766
|
WhitelabelOnboardingFailureCode:
|
|
15677
15767
|
description: 'Stable, frontend-facing reason a terminal onboarding failure happened.
|
|
15678
15768
|
The free-text
|
|
@@ -16385,7 +16475,7 @@ info:
|
|
|
16385
16475
|
\n\n"
|
|
16386
16476
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
16387
16477
|
title: OpusDNS API
|
|
16388
|
-
version: 2026-09-
|
|
16478
|
+
version: 2026-09-09-232649
|
|
16389
16479
|
x-logo:
|
|
16390
16480
|
altText: OpusDNS API Reference
|
|
16391
16481
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -34274,6 +34364,33 @@ paths:
|
|
|
34274
34364
|
- whitelabel
|
|
34275
34365
|
x-required-permissions:
|
|
34276
34366
|
- whitelabel_branding:manage
|
|
34367
|
+
/v1/whitelabel-branding/dns-check:
|
|
34368
|
+
get:
|
|
34369
|
+
operationId: check_whitelabel_dns_v1_whitelabel_branding_dns_check_get
|
|
34370
|
+
parameters:
|
|
34371
|
+
- $ref: '#/components/parameters/DatetimeFormatHeader'
|
|
34372
|
+
responses:
|
|
34373
|
+
'200':
|
|
34374
|
+
content:
|
|
34375
|
+
application/json:
|
|
34376
|
+
schema:
|
|
34377
|
+
$ref: '#/components/schemas/WhitelabelDnsCheckResponse'
|
|
34378
|
+
description: Successful Response
|
|
34379
|
+
'422':
|
|
34380
|
+
content:
|
|
34381
|
+
application/problem+json:
|
|
34382
|
+
schema:
|
|
34383
|
+
$ref: '#/components/schemas/HTTPValidationError'
|
|
34384
|
+
description: Validation Error
|
|
34385
|
+
security:
|
|
34386
|
+
- OAuth2PasswordBearer: []
|
|
34387
|
+
- APIKeyHeader: []
|
|
34388
|
+
summary: Check whether the whitelabel's DNS (delegation + serving records) resolves
|
|
34389
|
+
yet
|
|
34390
|
+
tags:
|
|
34391
|
+
- whitelabel
|
|
34392
|
+
x-required-permissions:
|
|
34393
|
+
- whitelabel_branding:read
|
|
34277
34394
|
/v1/whitelabel-branding/document:
|
|
34278
34395
|
get:
|
|
34279
34396
|
operationId: get_whitelabel_document_v1_whitelabel_branding_document_get
|
package/src/schema.d.ts
CHANGED
|
@@ -3067,6 +3067,23 @@ export interface paths {
|
|
|
3067
3067
|
patch?: never;
|
|
3068
3068
|
trace?: never;
|
|
3069
3069
|
};
|
|
3070
|
+
"/v1/whitelabel-branding/dns-check": {
|
|
3071
|
+
parameters: {
|
|
3072
|
+
query?: never;
|
|
3073
|
+
header?: never;
|
|
3074
|
+
path?: never;
|
|
3075
|
+
cookie?: never;
|
|
3076
|
+
};
|
|
3077
|
+
/** Check whether the whitelabel's DNS (delegation + serving records) resolves yet */
|
|
3078
|
+
get: operations["check_whitelabel_dns_v1_whitelabel_branding_dns_check_get"];
|
|
3079
|
+
put?: never;
|
|
3080
|
+
post?: never;
|
|
3081
|
+
delete?: never;
|
|
3082
|
+
options?: never;
|
|
3083
|
+
head?: never;
|
|
3084
|
+
patch?: never;
|
|
3085
|
+
trace?: never;
|
|
3086
|
+
};
|
|
3070
3087
|
"/v1/whitelabel-branding/document": {
|
|
3071
3088
|
parameters: {
|
|
3072
3089
|
query?: never;
|
|
@@ -5735,8 +5752,10 @@ export interface components {
|
|
|
5735
5752
|
*
|
|
5736
5753
|
* - `auto_renew_period`: `monthly` or `yearly`. All TLDs on create, transfer-in and update. Selects the
|
|
5737
5754
|
* period of the next renewal; the current expiry date does not move. On transfer-in without `period` it also sets the
|
|
5738
|
-
* period added by the transfer.
|
|
5739
|
-
* a
|
|
5755
|
+
* period added by the transfer. Omitted on create or transfer-in, it follows the term being bought: a one-month
|
|
5756
|
+
* `period` renews monthly and anything else yearly, except a longer month-unit term, which leaves it unset so that the
|
|
5757
|
+
* product's default billing period decides. Supplying `monthly` where the TLD sells no one-month renewal is rejected on
|
|
5758
|
+
* create, transfer-in and update; a `monthly` stored before that rule applied is ignored at renewal.
|
|
5740
5759
|
* - `music_registrant_attestation`: `true`. `.music` registration.
|
|
5741
5760
|
* - `nic_it_compliance_confirmation`: `true`. `.it` registration and transfer.
|
|
5742
5761
|
* - `travel_industry_acknowledgement`: `true`. `.travel` registration.
|
|
@@ -5843,8 +5862,10 @@ export interface components {
|
|
|
5843
5862
|
*
|
|
5844
5863
|
* - `auto_renew_period`: `monthly` or `yearly`. All TLDs on create, transfer-in and update. Selects the
|
|
5845
5864
|
* period of the next renewal; the current expiry date does not move. On transfer-in without `period` it also sets the
|
|
5846
|
-
* period added by the transfer.
|
|
5847
|
-
* a
|
|
5865
|
+
* period added by the transfer. Omitted on create or transfer-in, it follows the term being bought: a one-month
|
|
5866
|
+
* `period` renews monthly and anything else yearly, except a longer month-unit term, which leaves it unset so that the
|
|
5867
|
+
* product's default billing period decides. Supplying `monthly` where the TLD sells no one-month renewal is rejected on
|
|
5868
|
+
* create, transfer-in and update; a `monthly` stored before that rule applied is ignored at renewal.
|
|
5848
5869
|
* - `music_registrant_attestation`: `true`. `.music` registration.
|
|
5849
5870
|
* - `nic_it_compliance_confirmation`: `true`. `.it` registration and transfer.
|
|
5850
5871
|
* - `travel_industry_acknowledgement`: `true`. `.travel` registration.
|
|
@@ -5923,8 +5944,10 @@ export interface components {
|
|
|
5923
5944
|
*
|
|
5924
5945
|
* - `auto_renew_period`: `monthly` or `yearly`. All TLDs on create, transfer-in and update. Selects the
|
|
5925
5946
|
* period of the next renewal; the current expiry date does not move. On transfer-in without `period` it also sets the
|
|
5926
|
-
* period added by the transfer.
|
|
5927
|
-
* a
|
|
5947
|
+
* period added by the transfer. Omitted on create or transfer-in, it follows the term being bought: a one-month
|
|
5948
|
+
* `period` renews monthly and anything else yearly, except a longer month-unit term, which leaves it unset so that the
|
|
5949
|
+
* product's default billing period decides. Supplying `monthly` where the TLD sells no one-month renewal is rejected on
|
|
5950
|
+
* create, transfer-in and update; a `monthly` stored before that rule applied is ignored at renewal.
|
|
5928
5951
|
* - `music_registrant_attestation`: `true`. `.music` registration.
|
|
5929
5952
|
* - `nic_it_compliance_confirmation`: `true`. `.it` registration and transfer.
|
|
5930
5953
|
* - `travel_industry_acknowledgement`: `true`. `.travel` registration.
|
|
@@ -6007,8 +6030,10 @@ export interface components {
|
|
|
6007
6030
|
*
|
|
6008
6031
|
* - `auto_renew_period`: `monthly` or `yearly`. All TLDs on create, transfer-in and update. Selects the
|
|
6009
6032
|
* period of the next renewal; the current expiry date does not move. On transfer-in without `period` it also sets the
|
|
6010
|
-
* period added by the transfer.
|
|
6011
|
-
* a
|
|
6033
|
+
* period added by the transfer. Omitted on create or transfer-in, it follows the term being bought: a one-month
|
|
6034
|
+
* `period` renews monthly and anything else yearly, except a longer month-unit term, which leaves it unset so that the
|
|
6035
|
+
* product's default billing period decides. Supplying `monthly` where the TLD sells no one-month renewal is rejected on
|
|
6036
|
+
* create, transfer-in and update; a `monthly` stored before that rule applied is ignored at renewal.
|
|
6012
6037
|
* - `music_registrant_attestation`: `true`. `.music` registration.
|
|
6013
6038
|
* - `nic_it_compliance_confirmation`: `true`. `.it` registration and transfer.
|
|
6014
6039
|
* - `travel_industry_acknowledgement`: `true`. `.travel` registration.
|
|
@@ -7258,8 +7283,10 @@ export interface components {
|
|
|
7258
7283
|
*
|
|
7259
7284
|
* - `auto_renew_period`: `monthly` or `yearly`. All TLDs on create, transfer-in and update. Selects the
|
|
7260
7285
|
* period of the next renewal; the current expiry date does not move. On transfer-in without `period` it also sets the
|
|
7261
|
-
* period added by the transfer.
|
|
7262
|
-
* a
|
|
7286
|
+
* period added by the transfer. Omitted on create or transfer-in, it follows the term being bought: a one-month
|
|
7287
|
+
* `period` renews monthly and anything else yearly, except a longer month-unit term, which leaves it unset so that the
|
|
7288
|
+
* product's default billing period decides. Supplying `monthly` where the TLD sells no one-month renewal is rejected on
|
|
7289
|
+
* create, transfer-in and update; a `monthly` stored before that rule applied is ignored at renewal.
|
|
7263
7290
|
* - `music_registrant_attestation`: `true`. `.music` registration.
|
|
7264
7291
|
* - `nic_it_compliance_confirmation`: `true`. `.it` registration and transfer.
|
|
7265
7292
|
* - `travel_industry_acknowledgement`: `true`. `.travel` registration.
|
|
@@ -7338,8 +7365,10 @@ export interface components {
|
|
|
7338
7365
|
*
|
|
7339
7366
|
* - `auto_renew_period`: `monthly` or `yearly`. All TLDs on create, transfer-in and update. Selects the
|
|
7340
7367
|
* period of the next renewal; the current expiry date does not move. On transfer-in without `period` it also sets the
|
|
7341
|
-
* period added by the transfer.
|
|
7342
|
-
* a
|
|
7368
|
+
* period added by the transfer. Omitted on create or transfer-in, it follows the term being bought: a one-month
|
|
7369
|
+
* `period` renews monthly and anything else yearly, except a longer month-unit term, which leaves it unset so that the
|
|
7370
|
+
* product's default billing period decides. Supplying `monthly` where the TLD sells no one-month renewal is rejected on
|
|
7371
|
+
* create, transfer-in and update; a `monthly` stored before that rule applied is ignored at renewal.
|
|
7343
7372
|
* - `music_registrant_attestation`: `true`. `.music` registration.
|
|
7344
7373
|
* - `nic_it_compliance_confirmation`: `true`. `.it` registration and transfer.
|
|
7345
7374
|
* - `travel_industry_acknowledgement`: `true`. `.travel` registration.
|
|
@@ -7418,8 +7447,10 @@ export interface components {
|
|
|
7418
7447
|
*
|
|
7419
7448
|
* - `auto_renew_period`: `monthly` or `yearly`. All TLDs on create, transfer-in and update. Selects the
|
|
7420
7449
|
* period of the next renewal; the current expiry date does not move. On transfer-in without `period` it also sets the
|
|
7421
|
-
* period added by the transfer.
|
|
7422
|
-
* a
|
|
7450
|
+
* period added by the transfer. Omitted on create or transfer-in, it follows the term being bought: a one-month
|
|
7451
|
+
* `period` renews monthly and anything else yearly, except a longer month-unit term, which leaves it unset so that the
|
|
7452
|
+
* product's default billing period decides. Supplying `monthly` where the TLD sells no one-month renewal is rejected on
|
|
7453
|
+
* create, transfer-in and update; a `monthly` stored before that rule applied is ignored at renewal.
|
|
7423
7454
|
* - `music_registrant_attestation`: `true`. `.music` registration.
|
|
7424
7455
|
* - `nic_it_compliance_confirmation`: `true`. `.it` registration and transfer.
|
|
7425
7456
|
* - `travel_industry_acknowledgement`: `true`. `.travel` registration.
|
|
@@ -7498,8 +7529,10 @@ export interface components {
|
|
|
7498
7529
|
*
|
|
7499
7530
|
* - `auto_renew_period`: `monthly` or `yearly`. All TLDs on create, transfer-in and update. Selects the
|
|
7500
7531
|
* period of the next renewal; the current expiry date does not move. On transfer-in without `period` it also sets the
|
|
7501
|
-
* period added by the transfer.
|
|
7502
|
-
* a
|
|
7532
|
+
* period added by the transfer. Omitted on create or transfer-in, it follows the term being bought: a one-month
|
|
7533
|
+
* `period` renews monthly and anything else yearly, except a longer month-unit term, which leaves it unset so that the
|
|
7534
|
+
* product's default billing period decides. Supplying `monthly` where the TLD sells no one-month renewal is rejected on
|
|
7535
|
+
* create, transfer-in and update; a `monthly` stored before that rule applied is ignored at renewal.
|
|
7503
7536
|
* - `music_registrant_attestation`: `true`. `.music` registration.
|
|
7504
7537
|
* - `nic_it_compliance_confirmation`: `true`. `.it` registration and transfer.
|
|
7505
7538
|
* - `travel_industry_acknowledgement`: `true`. `.travel` registration.
|
|
@@ -7610,8 +7643,10 @@ export interface components {
|
|
|
7610
7643
|
*
|
|
7611
7644
|
* - `auto_renew_period`: `monthly` or `yearly`. All TLDs on create, transfer-in and update. Selects the
|
|
7612
7645
|
* period of the next renewal; the current expiry date does not move. On transfer-in without `period` it also sets the
|
|
7613
|
-
* period added by the transfer.
|
|
7614
|
-
* a
|
|
7646
|
+
* period added by the transfer. Omitted on create or transfer-in, it follows the term being bought: a one-month
|
|
7647
|
+
* `period` renews monthly and anything else yearly, except a longer month-unit term, which leaves it unset so that the
|
|
7648
|
+
* product's default billing period decides. Supplying `monthly` where the TLD sells no one-month renewal is rejected on
|
|
7649
|
+
* create, transfer-in and update; a `monthly` stored before that rule applied is ignored at renewal.
|
|
7615
7650
|
* - `music_registrant_attestation`: `true`. `.music` registration.
|
|
7616
7651
|
* - `nic_it_compliance_confirmation`: `true`. `.it` registration and transfer.
|
|
7617
7652
|
* - `travel_industry_acknowledgement`: `true`. `.travel` registration.
|
|
@@ -7790,8 +7825,10 @@ export interface components {
|
|
|
7790
7825
|
*
|
|
7791
7826
|
* - `auto_renew_period`: `monthly` or `yearly`. All TLDs on create, transfer-in and update. Selects the
|
|
7792
7827
|
* period of the next renewal; the current expiry date does not move. On transfer-in without `period` it also sets the
|
|
7793
|
-
* period added by the transfer.
|
|
7794
|
-
* a
|
|
7828
|
+
* period added by the transfer. Omitted on create or transfer-in, it follows the term being bought: a one-month
|
|
7829
|
+
* `period` renews monthly and anything else yearly, except a longer month-unit term, which leaves it unset so that the
|
|
7830
|
+
* product's default billing period decides. Supplying `monthly` where the TLD sells no one-month renewal is rejected on
|
|
7831
|
+
* create, transfer-in and update; a `monthly` stored before that rule applied is ignored at renewal.
|
|
7795
7832
|
* - `music_registrant_attestation`: `true`. `.music` registration.
|
|
7796
7833
|
* - `nic_it_compliance_confirmation`: `true`. `.it` registration and transfer.
|
|
7797
7834
|
* - `travel_industry_acknowledgement`: `true`. `.travel` registration.
|
|
@@ -13550,6 +13587,36 @@ export interface components {
|
|
|
13550
13587
|
* @enum {string}
|
|
13551
13588
|
*/
|
|
13552
13589
|
WhitelabelBrandingTier: "base" | "plus";
|
|
13590
|
+
/** WhitelabelDnsCheckItem */
|
|
13591
|
+
WhitelabelDnsCheckItem: {
|
|
13592
|
+
/** Expected */
|
|
13593
|
+
expected: string[];
|
|
13594
|
+
/** Name */
|
|
13595
|
+
name: string;
|
|
13596
|
+
/** Observed */
|
|
13597
|
+
observed: string[];
|
|
13598
|
+
/** Ok */
|
|
13599
|
+
ok: boolean;
|
|
13600
|
+
reason: components["schemas"]["WhitelabelDnsCheckReason"];
|
|
13601
|
+
/**
|
|
13602
|
+
* Required
|
|
13603
|
+
* @default true
|
|
13604
|
+
*/
|
|
13605
|
+
required: boolean;
|
|
13606
|
+
type: components["schemas"]["DnsRrsetType"];
|
|
13607
|
+
};
|
|
13608
|
+
/**
|
|
13609
|
+
* WhitelabelDnsCheckReason
|
|
13610
|
+
* @enum {string}
|
|
13611
|
+
*/
|
|
13612
|
+
WhitelabelDnsCheckReason: "verified" | "missing" | "mismatch" | "dns_error";
|
|
13613
|
+
/** WhitelabelDnsCheckResponse */
|
|
13614
|
+
WhitelabelDnsCheckResponse: {
|
|
13615
|
+
/** Checks */
|
|
13616
|
+
checks: components["schemas"]["WhitelabelDnsCheckItem"][];
|
|
13617
|
+
/** Ready */
|
|
13618
|
+
ready: boolean;
|
|
13619
|
+
};
|
|
13553
13620
|
/**
|
|
13554
13621
|
* WhitelabelOnboardingFailureCode
|
|
13555
13622
|
* @description Stable, frontend-facing reason a terminal onboarding failure happened. The free-text
|
|
@@ -28712,6 +28779,41 @@ export interface operations {
|
|
|
28712
28779
|
};
|
|
28713
28780
|
};
|
|
28714
28781
|
};
|
|
28782
|
+
check_whitelabel_dns_v1_whitelabel_branding_dns_check_get: {
|
|
28783
|
+
parameters: {
|
|
28784
|
+
query?: never;
|
|
28785
|
+
header?: {
|
|
28786
|
+
/**
|
|
28787
|
+
* @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.
|
|
28788
|
+
* @example rfc3339
|
|
28789
|
+
*/
|
|
28790
|
+
"X-Datetime-Format"?: components["parameters"]["DatetimeFormatHeader"];
|
|
28791
|
+
};
|
|
28792
|
+
path?: never;
|
|
28793
|
+
cookie?: never;
|
|
28794
|
+
};
|
|
28795
|
+
requestBody?: never;
|
|
28796
|
+
responses: {
|
|
28797
|
+
/** @description Successful Response */
|
|
28798
|
+
200: {
|
|
28799
|
+
headers: {
|
|
28800
|
+
[name: string]: unknown;
|
|
28801
|
+
};
|
|
28802
|
+
content: {
|
|
28803
|
+
"application/json": components["schemas"]["WhitelabelDnsCheckResponse"];
|
|
28804
|
+
};
|
|
28805
|
+
};
|
|
28806
|
+
/** @description Validation Error */
|
|
28807
|
+
422: {
|
|
28808
|
+
headers: {
|
|
28809
|
+
[name: string]: unknown;
|
|
28810
|
+
};
|
|
28811
|
+
content: {
|
|
28812
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
28813
|
+
};
|
|
28814
|
+
};
|
|
28815
|
+
};
|
|
28816
|
+
};
|
|
28715
28817
|
get_whitelabel_document_v1_whitelabel_branding_document_get: {
|
|
28716
28818
|
parameters: {
|
|
28717
28819
|
query?: never;
|