@opusdns/api 1.162.0 → 1.163.0

package/package.json

@@ -3,7 +3,7 @@
     "@opusdns/api-spec-ts-generator": "^1.5.0"
   },
   "name": "@opusdns/api",
-  "version": "1.162.0",
+  "version": "1.163.0",
   "description": "TypeScript types for the OpusDNS OpenAPI specification",
   "main": "./src/index.ts",
   "module": "./src/index.ts",

package/src/helpers/constants.ts

@@ -123,6 +123,7 @@ import type {
   VerificationDeadlineType,
   VerificationType,
   WhitelabelBrandingTier,
+  WhitelabelDnsCheckReason,
   WhitelabelOnboardingFailureCode,
   WhitelabelOnboardingFailureType,
   WhitelabelOnboardingStatus,
@@ -2324,6 +2325,20 @@ export const WHITELABEL_BRANDING_TIER_VALUES = [
   'plus',
 ] as const satisfies ReadonlyArray<WhitelabelBrandingTier>;
 
+export const WHITELABEL_DNS_CHECK_REASON = {
+  VERIFIED: "verified",
+  MISSING: "missing",
+  MISMATCH: "mismatch",
+  DNS_ERROR: "dns_error",
+} as const satisfies Record<string, WhitelabelDnsCheckReason>;
+
+export const WHITELABEL_DNS_CHECK_REASON_VALUES = [
+  'verified',
+  'missing',
+  'mismatch',
+  'dns_error',
+] as const satisfies ReadonlyArray<WhitelabelDnsCheckReason>;
+
 export const WHITELABEL_ONBOARDING_FAILURE_CODE = {
   ZONE_NOT_OWNED: "zone_not_owned",
   DELEGATION_MISSING: "delegation_missing",

package/src/helpers/endpoints.ts

@@ -149,6 +149,7 @@ export const VANITY_NAMESERVER_SETS_BY_SET_ID_ZONES_ENDPOINT = '/v1/vanity-names
 export const WHITELABEL_BRANDING_ENDPOINT = '/v1/whitelabel-branding';
 export const WHITELABEL_BRANDING_ASSETS_ENDPOINT = '/v1/whitelabel-branding/assets';
 export const WHITELABEL_BRANDING_ASSETS_BY_ASSET_ID_ENDPOINT = '/v1/whitelabel-branding/assets/{asset_id}';
+export const WHITELABEL_BRANDING_DNS_CHECK_ENDPOINT = '/v1/whitelabel-branding/dns-check';
 export const WHITELABEL_BRANDING_DOCUMENT_ENDPOINT = '/v1/whitelabel-branding/document';
 export const WHITELABEL_BRANDING_EMAIL_PREVIEW_ENDPOINT = '/v1/whitelabel-branding/email/preview';
 export const WHITELABEL_BRANDING_EMAIL_TEMPLATES_ENDPOINT = '/v1/whitelabel-branding/email/templates';
@@ -308,6 +309,7 @@ export type Endpoint =
   | typeof WHITELABEL_BRANDING_ENDPOINT
   | typeof WHITELABEL_BRANDING_ASSETS_ENDPOINT
   | typeof WHITELABEL_BRANDING_ASSETS_BY_ASSET_ID_ENDPOINT
+  | typeof WHITELABEL_BRANDING_DNS_CHECK_ENDPOINT
   | typeof WHITELABEL_BRANDING_DOCUMENT_ENDPOINT
   | typeof WHITELABEL_BRANDING_EMAIL_PREVIEW_ENDPOINT
   | typeof WHITELABEL_BRANDING_EMAIL_TEMPLATES_ENDPOINT

package/src/helpers/keys.ts

@@ -446,6 +446,8 @@ import type {
   WhitelabelBrandingPatch,
   WhitelabelBrandingRecheck,
   WhitelabelBranding,
+  WhitelabelDnsCheckItem,
+  WhitelabelDnsCheck,
   WhitelabelPlusCreate,
   WhitelabelSubscriptionInfo,
   WhitelabelUpgradeToPlus,
@@ -6062,6 +6064,32 @@ export const KEYS_WHITELABEL_BRANDING = [
   KEY_WHITELABEL_BRANDING_WHITELABEL_BRANDING_ID,
 ] as const satisfies (keyof WhitelabelBranding)[];
 
+export const KEY_WHITELABEL_DNS_CHECK_ITEM_EXPECTED = 'expected' satisfies keyof WhitelabelDnsCheckItem;
+export const KEY_WHITELABEL_DNS_CHECK_ITEM_NAME = 'name' satisfies keyof WhitelabelDnsCheckItem;
+export const KEY_WHITELABEL_DNS_CHECK_ITEM_OBSERVED = 'observed' satisfies keyof WhitelabelDnsCheckItem;
+export const KEY_WHITELABEL_DNS_CHECK_ITEM_OK = 'ok' satisfies keyof WhitelabelDnsCheckItem;
+export const KEY_WHITELABEL_DNS_CHECK_ITEM_REASON = 'reason' satisfies keyof WhitelabelDnsCheckItem;
+export const KEY_WHITELABEL_DNS_CHECK_ITEM_REQUIRED = 'required' satisfies keyof WhitelabelDnsCheckItem;
+export const KEY_WHITELABEL_DNS_CHECK_ITEM_TYPE = 'type' satisfies keyof WhitelabelDnsCheckItem;
+
+export const KEYS_WHITELABEL_DNS_CHECK_ITEM = [
+  KEY_WHITELABEL_DNS_CHECK_ITEM_EXPECTED,
+  KEY_WHITELABEL_DNS_CHECK_ITEM_NAME,
+  KEY_WHITELABEL_DNS_CHECK_ITEM_OBSERVED,
+  KEY_WHITELABEL_DNS_CHECK_ITEM_OK,
+  KEY_WHITELABEL_DNS_CHECK_ITEM_REASON,
+  KEY_WHITELABEL_DNS_CHECK_ITEM_REQUIRED,
+  KEY_WHITELABEL_DNS_CHECK_ITEM_TYPE,
+] as const satisfies (keyof WhitelabelDnsCheckItem)[];
+
+export const KEY_WHITELABEL_DNS_CHECK_CHECKS = 'checks' satisfies keyof WhitelabelDnsCheck;
+export const KEY_WHITELABEL_DNS_CHECK_READY = 'ready' satisfies keyof WhitelabelDnsCheck;
+
+export const KEYS_WHITELABEL_DNS_CHECK = [
+  KEY_WHITELABEL_DNS_CHECK_CHECKS,
+  KEY_WHITELABEL_DNS_CHECK_READY,
+] as const satisfies (keyof WhitelabelDnsCheck)[];
+
 export const KEY_WHITELABEL_PLUS_CREATE_AUTH_SUBDOMAIN = 'auth_subdomain' satisfies keyof WhitelabelPlusCreate;
 export const KEY_WHITELABEL_PLUS_CREATE_CREATE_ZONE = 'create_zone' satisfies keyof WhitelabelPlusCreate;
 export const KEY_WHITELABEL_PLUS_CREATE_DASHBOARD_SUBDOMAIN = 'dashboard_subdomain' satisfies keyof WhitelabelPlusCreate;

package/src/helpers/permissions.ts

@@ -152,6 +152,7 @@ import {
   VANITY_NAMESERVER_SETS_ENDPOINT,
   WHITELABEL_BRANDING_ASSETS_BY_ASSET_ID_ENDPOINT,
   WHITELABEL_BRANDING_ASSETS_ENDPOINT,
+  WHITELABEL_BRANDING_DNS_CHECK_ENDPOINT,
   WHITELABEL_BRANDING_DOCUMENT_ENDPOINT,
   WHITELABEL_BRANDING_EMAIL_PREVIEW_ENDPOINT,
   WHITELABEL_BRANDING_EMAIL_TEMPLATES_ENDPOINT,
@@ -1277,6 +1278,13 @@ export const REQUIRED_PERMISSIONS = {
     patch: [],
     delete: [],
   },
+  [WHITELABEL_BRANDING_DNS_CHECK_ENDPOINT]: {
+    get: [PUBLIC_PERMISSION.WHITELABEL_BRANDING_READ],
+    post: [],
+    put: [],
+    patch: [],
+    delete: [],
+  },
   [WHITELABEL_BRANDING_DOCUMENT_ENDPOINT]: {
     get: [PUBLIC_PERMISSION.WHITELABEL_BRANDING_READ],
     post: [PUBLIC_PERMISSION.WHITELABEL_BRANDING_MANAGE],

package/src/helpers/requests.d.ts

@@ -1203,6 +1203,9 @@ export type DELETE_WhitelabelBrandingAssetsByAssetId_Request = {
 };
 export type DELETE_WhitelabelBrandingAssetsByAssetId_Request_Path = DELETE_WhitelabelBrandingAssetsByAssetId_Request['parameters']['path'];
 
+export type GET_WhitelabelBrandingDnsCheck_Request = {
+};
+
 export type GET_WhitelabelBrandingDocument_Request = {
 };
 

package/src/helpers/responses.d.ts

@@ -120,6 +120,7 @@ import type {
   VanityNameserverSetSummaryDTO,
   VanityNsCheckRes,
   WhitelabelBranding,
+  WhitelabelDnsCheck,
 } from './schemas';
 
 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
 export type GET_WhitelabelBrandingAssets_Response_200 = ListBrandingAssets;
 export type GET_WhitelabelBrandingAssets_Response_422 = HTTPValidationError;
 
+export type GET_WhitelabelBrandingDnsCheck_Response = GET_WhitelabelBrandingDnsCheck_Response_200 | GET_WhitelabelBrandingDnsCheck_Response_422;
+
+export type GET_WhitelabelBrandingDnsCheck_Response_200 = WhitelabelDnsCheck;
+export type GET_WhitelabelBrandingDnsCheck_Response_422 = HTTPValidationError;
+
 export type GET_WhitelabelBrandingDocument_Response = GET_WhitelabelBrandingDocument_Response_200 | GET_WhitelabelBrandingDocument_Response_422;
 
 export type GET_WhitelabelBrandingDocument_Response_200 = BrandingDocument;

package/src/helpers/schemas.d.ts

@@ -594,6 +594,9 @@ export type WhitelabelBrandingPatch = components['schemas']['WhitelabelBrandingP
 export type WhitelabelBrandingRecheck = components['schemas']['WhitelabelBrandingRecheck'];
 export type WhitelabelBranding = components['schemas']['WhitelabelBrandingResponse'];
 export type WhitelabelBrandingTier = components['schemas']['WhitelabelBrandingTier'];
+export type WhitelabelDnsCheckItem = components['schemas']['WhitelabelDnsCheckItem'];
+export type WhitelabelDnsCheckReason = components['schemas']['WhitelabelDnsCheckReason'];
+export type WhitelabelDnsCheck = components['schemas']['WhitelabelDnsCheckResponse'];
 export type WhitelabelOnboardingFailureCode = components['schemas']['WhitelabelOnboardingFailureCode'];
 export type WhitelabelOnboardingFailureType = components['schemas']['WhitelabelOnboardingFailureType'];
 export type WhitelabelOnboardingStatus = components['schemas']['WhitelabelOnboardingStatus'];

package/src/openapi.yaml

@@ -15673,6 +15673,64 @@ components:
       - plus
       title: WhitelabelBrandingTier
       type: string
+    WhitelabelDnsCheckItem:
+      properties:
+        expected:
+          items:
+            type: string
+          title: Expected
+          type: array
+        name:
+          title: Name
+          type: string
+        observed:
+          items:
+            type: string
+          title: Observed
+          type: array
+        ok:
+          title: Ok
+          type: boolean
+        reason:
+          $ref: '#/components/schemas/WhitelabelDnsCheckReason'
+        required:
+          default: true
+          title: Required
+          type: boolean
+        type:
+          $ref: '#/components/schemas/DnsRrsetType'
+      required:
+      - name
+      - type
+      - expected
+      - observed
+      - ok
+      - reason
+      title: WhitelabelDnsCheckItem
+      type: object
+    WhitelabelDnsCheckReason:
+      enum:
+      - verified
+      - missing
+      - mismatch
+      - dns_error
+      title: WhitelabelDnsCheckReason
+      type: string
+    WhitelabelDnsCheckResponse:
+      properties:
+        checks:
+          items:
+            $ref: '#/components/schemas/WhitelabelDnsCheckItem'
+          title: Checks
+          type: array
+        ready:
+          title: Ready
+          type: boolean
+      required:
+      - ready
+      - checks
+      title: WhitelabelDnsCheckResponse
+      type: object
     WhitelabelOnboardingFailureCode:
       description: 'Stable, frontend-facing reason a terminal onboarding failure happened.
         The free-text
@@ -16385,7 +16443,7 @@ info:
     \n\n"
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2026-09-08-214430
+  version: 2026-09-09-151559
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -34274,6 +34332,33 @@ paths:
       - whitelabel
       x-required-permissions:
       - whitelabel_branding:manage
+  /v1/whitelabel-branding/dns-check:
+    get:
+      operationId: check_whitelabel_dns_v1_whitelabel_branding_dns_check_get
+      parameters:
+      - $ref: '#/components/parameters/DatetimeFormatHeader'
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/WhitelabelDnsCheckResponse'
+          description: Successful Response
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      - APIKeyHeader: []
+      summary: Check whether the whitelabel's DNS (delegation + serving records) resolves
+        yet
+      tags:
+      - whitelabel
+      x-required-permissions:
+      - whitelabel_branding:read
   /v1/whitelabel-branding/document:
     get:
       operationId: get_whitelabel_document_v1_whitelabel_branding_document_get

package/src/schema.d.ts

@@ -3067,6 +3067,23 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/whitelabel-branding/dns-check": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Check whether the whitelabel's DNS (delegation + serving records) resolves yet */
+        get: operations["check_whitelabel_dns_v1_whitelabel_branding_dns_check_get"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/whitelabel-branding/document": {
         parameters: {
             query?: never;
@@ -13550,6 +13567,36 @@ export interface components {
          * @enum {string}
          */
         WhitelabelBrandingTier: "base" | "plus";
+        /** WhitelabelDnsCheckItem */
+        WhitelabelDnsCheckItem: {
+            /** Expected */
+            expected: string[];
+            /** Name */
+            name: string;
+            /** Observed */
+            observed: string[];
+            /** Ok */
+            ok: boolean;
+            reason: components["schemas"]["WhitelabelDnsCheckReason"];
+            /**
+             * Required
+             * @default true
+             */
+            required: boolean;
+            type: components["schemas"]["DnsRrsetType"];
+        };
+        /**
+         * WhitelabelDnsCheckReason
+         * @enum {string}
+         */
+        WhitelabelDnsCheckReason: "verified" | "missing" | "mismatch" | "dns_error";
+        /** WhitelabelDnsCheckResponse */
+        WhitelabelDnsCheckResponse: {
+            /** Checks */
+            checks: components["schemas"]["WhitelabelDnsCheckItem"][];
+            /** Ready */
+            ready: boolean;
+        };
         /**
          * WhitelabelOnboardingFailureCode
          * @description Stable, frontend-facing reason a terminal onboarding failure happened. The free-text
@@ -28712,6 +28759,41 @@ export interface operations {
             };
         };
     };
+    check_whitelabel_dns_v1_whitelabel_branding_dns_check_get: {
+        parameters: {
+            query?: never;
+            header?: {
+                /**
+                 * @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.
+                 * @example rfc3339
+                 */
+                "X-Datetime-Format"?: components["parameters"]["DatetimeFormatHeader"];
+            };
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["WhitelabelDnsCheckResponse"];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
     get_whitelabel_document_v1_whitelabel_branding_document_get: {
         parameters: {
             query?: never;