@opusdns/api 1.100.0 → 1.101.0

package/package.json

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

package/src/helpers/keys.ts

@@ -5788,21 +5788,25 @@ export const KEYS_VISITS_BY_KEY_BUCKET = [
   KEY_VISITS_BY_KEY_BUCKET_UNIQUE,
 ] as const satisfies (keyof VisitsByKeyBucket)[];
 
-export const KEY_WHITELABEL_BRANDING_CREATE_AUTH_HOSTNAME = 'auth_hostname' satisfies keyof WhitelabelBrandingCreate;
+export const KEY_WHITELABEL_BRANDING_CREATE_AUTH_SUBDOMAIN = 'auth_subdomain' satisfies keyof WhitelabelBrandingCreate;
+export const KEY_WHITELABEL_BRANDING_CREATE_DASHBOARD_SUBDOMAIN = 'dashboard_subdomain' satisfies keyof WhitelabelBrandingCreate;
 export const KEY_WHITELABEL_BRANDING_CREATE_HOSTNAME = 'hostname' satisfies keyof WhitelabelBrandingCreate;
 export const KEY_WHITELABEL_BRANDING_CREATE_PERIOD = 'period' satisfies keyof WhitelabelBrandingCreate;
 
 export const KEYS_WHITELABEL_BRANDING_CREATE = [
-  KEY_WHITELABEL_BRANDING_CREATE_AUTH_HOSTNAME,
+  KEY_WHITELABEL_BRANDING_CREATE_AUTH_SUBDOMAIN,
+  KEY_WHITELABEL_BRANDING_CREATE_DASHBOARD_SUBDOMAIN,
   KEY_WHITELABEL_BRANDING_CREATE_HOSTNAME,
   KEY_WHITELABEL_BRANDING_CREATE_PERIOD,
 ] as const satisfies (keyof WhitelabelBrandingCreate)[];
 
-export const KEY_WHITELABEL_BRANDING_RECHECK_AUTH_HOSTNAME = 'auth_hostname' satisfies keyof WhitelabelBrandingRecheck;
+export const KEY_WHITELABEL_BRANDING_RECHECK_AUTH_SUBDOMAIN = 'auth_subdomain' satisfies keyof WhitelabelBrandingRecheck;
+export const KEY_WHITELABEL_BRANDING_RECHECK_DASHBOARD_SUBDOMAIN = 'dashboard_subdomain' satisfies keyof WhitelabelBrandingRecheck;
 export const KEY_WHITELABEL_BRANDING_RECHECK_HOSTNAME = 'hostname' satisfies keyof WhitelabelBrandingRecheck;
 
 export const KEYS_WHITELABEL_BRANDING_RECHECK = [
-  KEY_WHITELABEL_BRANDING_RECHECK_AUTH_HOSTNAME,
+  KEY_WHITELABEL_BRANDING_RECHECK_AUTH_SUBDOMAIN,
+  KEY_WHITELABEL_BRANDING_RECHECK_DASHBOARD_SUBDOMAIN,
   KEY_WHITELABEL_BRANDING_RECHECK_HOSTNAME,
 ] as const satisfies (keyof WhitelabelBrandingRecheck)[];
 

package/src/openapi.yaml

@@ -14470,23 +14470,39 @@ components:
       title: VisitsByKeyBucket
       type: object
     WhitelabelBrandingCreate:
-      description: 'Public create request body. The owning org comes from auth context,
-        and
+      description: 'Public create request body. The customer supplies their domain
+        plus the subdomains the
+
+        two whitelabel hosts live on; the full hostnames are composed here. `dashboard_subdomain`
+
+        is optional - omitted, the dashboard is served on `hostname` itself (the zone
+        apex when
 
-        `verification_domain` is derived server-side (the registrable domain of `hostname`),
+        `hostname` is the bare domain). The owning org comes from auth context, and
 
-        so neither is accepted here. Both hostnames must resolve to the same registrable
+        `verification_domain` is derived server-side (the registrable domain of the
+        composed
 
-        domain (checked server-side in WhitelabelBrandingService.create).'
+        dashboard host), so neither is accepted here.'
       properties:
-        auth_hostname:
-          description: Auth/login hostname served by Keycloak (e.g. auth.customer.com)
+        auth_subdomain:
+          description: Subdomain the Keycloak login is served on (e.g. auth -> auth.customer.com)
           maxLength: 255
           minLength: 1
-          title: Auth Hostname
+          title: Auth Subdomain
           type: string
+        dashboard_subdomain:
+          anyOf:
+          - maxLength: 255
+            minLength: 1
+            type: string
+          - type: 'null'
+          description: Subdomain the dashboard is served on (e.g. dash -> dash.customer.com);
+            omit for the apex
+          title: Dashboard Subdomain
         hostname:
-          description: Dashboard hostname the customer wants to brand (e.g. dash.customer.com)
+          description: Domain the whitelabel runs under (e.g. customer.com); must
+            be an OpusDNS-hosted zone
           maxLength: 255
           minLength: 1
           title: Hostname
@@ -14497,7 +14513,7 @@ components:
             year'
       required:
       - hostname
-      - auth_hostname
+      - auth_subdomain
       - period
       title: WhitelabelBrandingCreate
       type: object
@@ -14505,18 +14521,28 @@ components:
       description: 'Public recheck body. Empty = re-run onboarding against the stored
         hosts (retry after
 
-        fixing DNS). Both hosts present = re-point a wrong domain before re-running
-        (pre-provisioning
+        fixing DNS). hostname + auth_subdomain present = re-point a wrong domain before
+        re-running
 
-        only; server rejects once a Keycloak client exists).'
+        (pre-provisioning only; server rejects once a Keycloak client exists). Same
+        composition
+
+        rules as WhitelabelBrandingCreate.'
       properties:
-        auth_hostname:
+        auth_subdomain:
           anyOf:
           - maxLength: 255
             minLength: 1
             type: string
           - type: 'null'
-          title: Auth Hostname
+          title: Auth Subdomain
+        dashboard_subdomain:
+          anyOf:
+          - maxLength: 255
+            minLength: 1
+            type: string
+          - type: 'null'
+          title: Dashboard Subdomain
         hostname:
           anyOf:
           - maxLength: 255
@@ -14990,7 +15016,7 @@ info:
     \n\n"
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2026-08-06-121126
+  version: 2026-08-07-130930
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -32319,6 +32345,12 @@ tags:
   x-displayName: Vanity Nameservers
 - description: 'Endpoints for managing an organization''s whitelabel branding configuration.
 
+
+    The create body carries the customer''s domain plus subdomains: `{"hostname":
+    "customer.com", "dashboard_subdomain": "dash", "auth_subdomain": "auth"}` composes
+    `dash.customer.com` and `auth.customer.com`; omitting `dashboard_subdomain` serves
+    the dashboard on the domain apex itself.
+
     '
   name: whitelabel
   x-displayName: Whitelabel Branding

package/src/schema.d.ts

@@ -12476,20 +12476,27 @@ export interface components {
         };
         /**
          * WhitelabelBrandingCreate
-         * @description Public create request body. The owning org comes from auth context, and
-         *     `verification_domain` is derived server-side (the registrable domain of `hostname`),
-         *     so neither is accepted here. Both hostnames must resolve to the same registrable
-         *     domain (checked server-side in WhitelabelBrandingService.create).
+         * @description Public create request body. The customer supplies their domain plus the subdomains the
+         *     two whitelabel hosts live on; the full hostnames are composed here. `dashboard_subdomain`
+         *     is optional - omitted, the dashboard is served on `hostname` itself (the zone apex when
+         *     `hostname` is the bare domain). The owning org comes from auth context, and
+         *     `verification_domain` is derived server-side (the registrable domain of the composed
+         *     dashboard host), so neither is accepted here.
          */
         WhitelabelBrandingCreate: {
             /**
-             * Auth Hostname
-             * @description Auth/login hostname served by Keycloak (e.g. auth.customer.com)
+             * Auth Subdomain
+             * @description Subdomain the Keycloak login is served on (e.g. auth -> auth.customer.com)
              */
-            auth_hostname: string;
+            auth_subdomain: string;
+            /**
+             * Dashboard Subdomain
+             * @description Subdomain the dashboard is served on (e.g. dash -> dash.customer.com); omit for the apex
+             */
+            dashboard_subdomain?: string | null;
             /**
              * Hostname
-             * @description Dashboard hostname the customer wants to brand (e.g. dash.customer.com)
+             * @description Domain the whitelabel runs under (e.g. customer.com); must be an OpusDNS-hosted zone
              */
             hostname: string;
             /** @description Billing period for the subscription; offered: 1 month or 1 year */
@@ -12498,12 +12505,15 @@ export interface components {
         /**
          * WhitelabelBrandingRecheck
          * @description Public recheck body. Empty = re-run onboarding against the stored hosts (retry after
-         *     fixing DNS). Both hosts present = re-point a wrong domain before re-running (pre-provisioning
-         *     only; server rejects once a Keycloak client exists).
+         *     fixing DNS). hostname + auth_subdomain present = re-point a wrong domain before re-running
+         *     (pre-provisioning only; server rejects once a Keycloak client exists). Same composition
+         *     rules as WhitelabelBrandingCreate.
          */
         WhitelabelBrandingRecheck: {
-            /** Auth Hostname */
-            auth_hostname?: string | null;
+            /** Auth Subdomain */
+            auth_subdomain?: string | null;
+            /** Dashboard Subdomain */
+            dashboard_subdomain?: string | null;
             /** Hostname */
             hostname?: string | null;
         };