@opusdns/api 1.164.0 → 1.166.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 +0 -15
- package/src/helpers/endpoints.ts +0 -2
- package/src/helpers/keys.ts +2 -28
- package/src/helpers/permissions.ts +0 -8
- package/src/helpers/requests.d.ts +0 -3
- package/src/helpers/responses.d.ts +0 -6
- package/src/helpers/schemas.d.ts +0 -3
- package/src/openapi.yaml +11 -86
- package/src/schema.d.ts +7 -82
package/package.json
CHANGED
package/src/helpers/constants.ts
CHANGED
|
@@ -123,7 +123,6 @@ import type {
|
|
|
123
123
|
VerificationDeadlineType,
|
|
124
124
|
VerificationType,
|
|
125
125
|
WhitelabelBrandingTier,
|
|
126
|
-
WhitelabelDnsCheckReason,
|
|
127
126
|
WhitelabelOnboardingFailureCode,
|
|
128
127
|
WhitelabelOnboardingFailureType,
|
|
129
128
|
WhitelabelOnboardingStatus,
|
|
@@ -2325,20 +2324,6 @@ export const WHITELABEL_BRANDING_TIER_VALUES = [
|
|
|
2325
2324
|
'plus',
|
|
2326
2325
|
] as const satisfies ReadonlyArray<WhitelabelBrandingTier>;
|
|
2327
2326
|
|
|
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
|
-
|
|
2342
2327
|
export const WHITELABEL_ONBOARDING_FAILURE_CODE = {
|
|
2343
2328
|
ZONE_NOT_OWNED: "zone_not_owned",
|
|
2344
2329
|
DELEGATION_MISSING: "delegation_missing",
|
package/src/helpers/endpoints.ts
CHANGED
|
@@ -149,7 +149,6 @@ 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';
|
|
153
152
|
export const WHITELABEL_BRANDING_DOCUMENT_ENDPOINT = '/v1/whitelabel-branding/document';
|
|
154
153
|
export const WHITELABEL_BRANDING_EMAIL_PREVIEW_ENDPOINT = '/v1/whitelabel-branding/email/preview';
|
|
155
154
|
export const WHITELABEL_BRANDING_EMAIL_TEMPLATES_ENDPOINT = '/v1/whitelabel-branding/email/templates';
|
|
@@ -309,7 +308,6 @@ export type Endpoint =
|
|
|
309
308
|
| typeof WHITELABEL_BRANDING_ENDPOINT
|
|
310
309
|
| typeof WHITELABEL_BRANDING_ASSETS_ENDPOINT
|
|
311
310
|
| typeof WHITELABEL_BRANDING_ASSETS_BY_ASSET_ID_ENDPOINT
|
|
312
|
-
| typeof WHITELABEL_BRANDING_DNS_CHECK_ENDPOINT
|
|
313
311
|
| typeof WHITELABEL_BRANDING_DOCUMENT_ENDPOINT
|
|
314
312
|
| typeof WHITELABEL_BRANDING_EMAIL_PREVIEW_ENDPOINT
|
|
315
313
|
| typeof WHITELABEL_BRANDING_EMAIL_TEMPLATES_ENDPOINT
|
package/src/helpers/keys.ts
CHANGED
|
@@ -446,8 +446,6 @@ import type {
|
|
|
446
446
|
WhitelabelBrandingPatch,
|
|
447
447
|
WhitelabelBrandingRecheck,
|
|
448
448
|
WhitelabelBranding,
|
|
449
|
-
WhitelabelDnsCheckItem,
|
|
450
|
-
WhitelabelDnsCheck,
|
|
451
449
|
WhitelabelPlusCreate,
|
|
452
450
|
WhitelabelSubscriptionInfo,
|
|
453
451
|
WhitelabelUpgradeToPlus,
|
|
@@ -4130,6 +4128,7 @@ export const KEY_NOR_ID_DECLARATION_DOMAIN_NAME = 'domain_name' satisfies keyof
|
|
|
4130
4128
|
export const KEY_NOR_ID_DECLARATION_EXPIRES_ON = 'expires_on' satisfies keyof NorIdDeclaration;
|
|
4131
4129
|
export const KEY_NOR_ID_DECLARATION_IDENTITY_TYPE = 'identity_type' satisfies keyof NorIdDeclaration;
|
|
4132
4130
|
export const KEY_NOR_ID_DECLARATION_IDENTITY_VALUE = 'identity_value' satisfies keyof NorIdDeclaration;
|
|
4131
|
+
export const KEY_NOR_ID_DECLARATION_ORGANIZATION_ID = 'organization_id' satisfies keyof NorIdDeclaration;
|
|
4133
4132
|
export const KEY_NOR_ID_DECLARATION_STATUS = 'status' satisfies keyof NorIdDeclaration;
|
|
4134
4133
|
export const KEY_NOR_ID_DECLARATION_SUBSCRIBER_NAME = 'subscriber_name' satisfies keyof NorIdDeclaration;
|
|
4135
4134
|
|
|
@@ -4142,6 +4141,7 @@ export const KEYS_NOR_ID_DECLARATION = [
|
|
|
4142
4141
|
KEY_NOR_ID_DECLARATION_EXPIRES_ON,
|
|
4143
4142
|
KEY_NOR_ID_DECLARATION_IDENTITY_TYPE,
|
|
4144
4143
|
KEY_NOR_ID_DECLARATION_IDENTITY_VALUE,
|
|
4144
|
+
KEY_NOR_ID_DECLARATION_ORGANIZATION_ID,
|
|
4145
4145
|
KEY_NOR_ID_DECLARATION_STATUS,
|
|
4146
4146
|
KEY_NOR_ID_DECLARATION_SUBSCRIBER_NAME,
|
|
4147
4147
|
] as const satisfies (keyof NorIdDeclaration)[];
|
|
@@ -6064,32 +6064,6 @@ export const KEYS_WHITELABEL_BRANDING = [
|
|
|
6064
6064
|
KEY_WHITELABEL_BRANDING_WHITELABEL_BRANDING_ID,
|
|
6065
6065
|
] as const satisfies (keyof WhitelabelBranding)[];
|
|
6066
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
|
-
|
|
6093
6067
|
export const KEY_WHITELABEL_PLUS_CREATE_AUTH_SUBDOMAIN = 'auth_subdomain' satisfies keyof WhitelabelPlusCreate;
|
|
6094
6068
|
export const KEY_WHITELABEL_PLUS_CREATE_CREATE_ZONE = 'create_zone' satisfies keyof WhitelabelPlusCreate;
|
|
6095
6069
|
export const KEY_WHITELABEL_PLUS_CREATE_DASHBOARD_SUBDOMAIN = 'dashboard_subdomain' satisfies keyof WhitelabelPlusCreate;
|
|
@@ -152,7 +152,6 @@ 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,
|
|
156
155
|
WHITELABEL_BRANDING_DOCUMENT_ENDPOINT,
|
|
157
156
|
WHITELABEL_BRANDING_EMAIL_PREVIEW_ENDPOINT,
|
|
158
157
|
WHITELABEL_BRANDING_EMAIL_TEMPLATES_ENDPOINT,
|
|
@@ -1278,13 +1277,6 @@ export const REQUIRED_PERMISSIONS = {
|
|
|
1278
1277
|
patch: [],
|
|
1279
1278
|
delete: [],
|
|
1280
1279
|
},
|
|
1281
|
-
[WHITELABEL_BRANDING_DNS_CHECK_ENDPOINT]: {
|
|
1282
|
-
get: [PUBLIC_PERMISSION.WHITELABEL_BRANDING_READ],
|
|
1283
|
-
post: [],
|
|
1284
|
-
put: [],
|
|
1285
|
-
patch: [],
|
|
1286
|
-
delete: [],
|
|
1287
|
-
},
|
|
1288
1280
|
[WHITELABEL_BRANDING_DOCUMENT_ENDPOINT]: {
|
|
1289
1281
|
get: [PUBLIC_PERMISSION.WHITELABEL_BRANDING_READ],
|
|
1290
1282
|
post: [PUBLIC_PERMISSION.WHITELABEL_BRANDING_MANAGE],
|
|
@@ -1203,9 +1203,6 @@ 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
|
-
|
|
1209
1206
|
export type GET_WhitelabelBrandingDocument_Request = {
|
|
1210
1207
|
};
|
|
1211
1208
|
|
|
@@ -120,7 +120,6 @@ import type {
|
|
|
120
120
|
VanityNameserverSetSummaryDTO,
|
|
121
121
|
VanityNsCheckRes,
|
|
122
122
|
WhitelabelBranding,
|
|
123
|
-
WhitelabelDnsCheck,
|
|
124
123
|
} from './schemas';
|
|
125
124
|
|
|
126
125
|
export type DELETE_AiConciergeConversationsByConversationId_Response = DELETE_AiConciergeConversationsByConversationId_Response_401 | DELETE_AiConciergeConversationsByConversationId_Response_404 | DELETE_AiConciergeConversationsByConversationId_Response_422 | DELETE_AiConciergeConversationsByConversationId_Response_502;
|
|
@@ -888,11 +887,6 @@ export type GET_WhitelabelBrandingAssets_Response = GET_WhitelabelBrandingAssets
|
|
|
888
887
|
export type GET_WhitelabelBrandingAssets_Response_200 = ListBrandingAssets;
|
|
889
888
|
export type GET_WhitelabelBrandingAssets_Response_422 = HTTPValidationError;
|
|
890
889
|
|
|
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
|
-
|
|
896
890
|
export type GET_WhitelabelBrandingDocument_Response = GET_WhitelabelBrandingDocument_Response_200 | GET_WhitelabelBrandingDocument_Response_422;
|
|
897
891
|
|
|
898
892
|
export type GET_WhitelabelBrandingDocument_Response_200 = BrandingDocument;
|
package/src/helpers/schemas.d.ts
CHANGED
|
@@ -594,9 +594,6 @@ 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'];
|
|
600
597
|
export type WhitelabelOnboardingFailureCode = components['schemas']['WhitelabelOnboardingFailureCode'];
|
|
601
598
|
export type WhitelabelOnboardingFailureType = components['schemas']['WhitelabelOnboardingFailureType'];
|
|
602
599
|
export type WhitelabelOnboardingStatus = components['schemas']['WhitelabelOnboardingStatus'];
|
package/src/openapi.yaml
CHANGED
|
@@ -10088,6 +10088,15 @@ components:
|
|
|
10088
10088
|
- type: 'null'
|
|
10089
10089
|
description: The subscriber identity (organization number or Person-ID)
|
|
10090
10090
|
title: Identity Value
|
|
10091
|
+
organization_id:
|
|
10092
|
+
description: The organization that owns the domain; used to brand the page
|
|
10093
|
+
examples:
|
|
10094
|
+
- organization_01h45ytscbebyvny4gc8cr8ma2
|
|
10095
|
+
format: typeid
|
|
10096
|
+
pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
10097
|
+
title: Organization Id
|
|
10098
|
+
type: string
|
|
10099
|
+
x-typeid-prefix: organization
|
|
10091
10100
|
status:
|
|
10092
10101
|
$ref: '#/components/schemas/NorIdDeclarationStatus'
|
|
10093
10102
|
description: The declaration status
|
|
@@ -10096,6 +10105,7 @@ components:
|
|
|
10096
10105
|
title: Subscriber Name
|
|
10097
10106
|
type: string
|
|
10098
10107
|
required:
|
|
10108
|
+
- organization_id
|
|
10099
10109
|
- domain_name
|
|
10100
10110
|
- subscriber_name
|
|
10101
10111
|
- declaration_version
|
|
@@ -15705,64 +15715,6 @@ components:
|
|
|
15705
15715
|
- plus
|
|
15706
15716
|
title: WhitelabelBrandingTier
|
|
15707
15717
|
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
|
|
15766
15718
|
WhitelabelOnboardingFailureCode:
|
|
15767
15719
|
description: 'Stable, frontend-facing reason a terminal onboarding failure happened.
|
|
15768
15720
|
The free-text
|
|
@@ -16475,7 +16427,7 @@ info:
|
|
|
16475
16427
|
\n\n"
|
|
16476
16428
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
16477
16429
|
title: OpusDNS API
|
|
16478
|
-
version: 2026-09-
|
|
16430
|
+
version: 2026-09-10-090448
|
|
16479
16431
|
x-logo:
|
|
16480
16432
|
altText: OpusDNS API Reference
|
|
16481
16433
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -34364,33 +34316,6 @@ paths:
|
|
|
34364
34316
|
- whitelabel
|
|
34365
34317
|
x-required-permissions:
|
|
34366
34318
|
- 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
|
|
34394
34319
|
/v1/whitelabel-branding/document:
|
|
34395
34320
|
get:
|
|
34396
34321
|
operationId: get_whitelabel_document_v1_whitelabel_branding_document_get
|
package/src/schema.d.ts
CHANGED
|
@@ -3067,23 +3067,6 @@ 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
|
-
};
|
|
3087
3070
|
"/v1/whitelabel-branding/document": {
|
|
3088
3071
|
parameters: {
|
|
3089
3072
|
query?: never;
|
|
@@ -9958,6 +9941,13 @@ export interface components {
|
|
|
9958
9941
|
* @description The subscriber identity (organization number or Person-ID)
|
|
9959
9942
|
*/
|
|
9960
9943
|
identity_value?: string | null;
|
|
9944
|
+
/**
|
|
9945
|
+
* Organization Id
|
|
9946
|
+
* Format: typeid
|
|
9947
|
+
* @description The organization that owns the domain; used to brand the page
|
|
9948
|
+
* @example organization_01h45ytscbebyvny4gc8cr8ma2
|
|
9949
|
+
*/
|
|
9950
|
+
organization_id: TypeId<"organization">;
|
|
9961
9951
|
/** @description The declaration status */
|
|
9962
9952
|
status: components["schemas"]["NorIdDeclarationStatus"];
|
|
9963
9953
|
/**
|
|
@@ -13587,36 +13577,6 @@ export interface components {
|
|
|
13587
13577
|
* @enum {string}
|
|
13588
13578
|
*/
|
|
13589
13579
|
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
|
-
};
|
|
13620
13580
|
/**
|
|
13621
13581
|
* WhitelabelOnboardingFailureCode
|
|
13622
13582
|
* @description Stable, frontend-facing reason a terminal onboarding failure happened. The free-text
|
|
@@ -28779,41 +28739,6 @@ export interface operations {
|
|
|
28779
28739
|
};
|
|
28780
28740
|
};
|
|
28781
28741
|
};
|
|
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
|
-
};
|
|
28817
28742
|
get_whitelabel_document_v1_whitelabel_branding_document_get: {
|
|
28818
28743
|
parameters: {
|
|
28819
28744
|
query?: never;
|