@opusdns/api 1.80.0 → 1.81.0

package/package.json

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

package/src/helpers/constants.ts

@@ -114,6 +114,8 @@ import type {
   VerificationClaimType,
   VerificationDeadlineType,
   VerificationType,
+  WhitelabelOnboardingFailureCode,
+  WhitelabelOnboardingFailureType,
   WhitelabelOnboardingStatus,
   ZoneIncludeField,
   ZoneSortField,
@@ -1992,6 +1994,40 @@ export const VERIFICATION_TYPE_VALUES = [
   'email',
 ] as const satisfies ReadonlyArray<VerificationType>;
 
+export const WHITELABEL_ONBOARDING_FAILURE_CODE = {
+  ZONE_NOT_OWNED: "zone_not_owned",
+  DELEGATION_MISSING: "delegation_missing",
+  DELEGATION_MISMATCH: "delegation_mismatch",
+  DNS_RECORD_REJECTED: "dns_record_rejected",
+  AUTH_CLIENT_REJECTED: "auth_client_rejected",
+  BRANDING_REJECTED: "branding_rejected",
+  RETRIES_EXHAUSTED: "retries_exhausted",
+} as const satisfies Record<string, WhitelabelOnboardingFailureCode>;
+
+export const WHITELABEL_ONBOARDING_FAILURE_CODE_VALUES = [
+  'zone_not_owned',
+  'delegation_missing',
+  'delegation_mismatch',
+  'dns_record_rejected',
+  'auth_client_rejected',
+  'branding_rejected',
+  'retries_exhausted',
+] as const satisfies ReadonlyArray<WhitelabelOnboardingFailureCode>;
+
+export const WHITELABEL_ONBOARDING_FAILURE_TYPE = {
+  DNS: "dns",
+  AUTH: "auth",
+  BRANDING: "branding",
+  SYSTEM: "system",
+} as const satisfies Record<string, WhitelabelOnboardingFailureType>;
+
+export const WHITELABEL_ONBOARDING_FAILURE_TYPE_VALUES = [
+  'dns',
+  'auth',
+  'branding',
+  'system',
+] as const satisfies ReadonlyArray<WhitelabelOnboardingFailureType>;
+
 export const WHITELABEL_ONBOARDING_STATUS = {
   PENDING_DOMAIN_VERIFICATION: "pending_domain_verification",
   VERIFYING: "verifying",

package/src/helpers/keys.ts

@@ -5765,7 +5765,9 @@ export const KEYS_WHITELABEL_BRANDING_CREATE = [
 
 export const KEY_WHITELABEL_BRANDING_AUTH_HOSTNAME = 'auth_hostname' satisfies keyof WhitelabelBranding;
 export const KEY_WHITELABEL_BRANDING_CREATED_ON = 'created_on' satisfies keyof WhitelabelBranding;
-export const KEY_WHITELABEL_BRANDING_FAILURE_REASON = 'failure_reason' satisfies keyof WhitelabelBranding;
+export const KEY_WHITELABEL_BRANDING_FAILURE_CODE = 'failure_code' satisfies keyof WhitelabelBranding;
+export const KEY_WHITELABEL_BRANDING_FAILURE_DETAIL = 'failure_detail' satisfies keyof WhitelabelBranding;
+export const KEY_WHITELABEL_BRANDING_FAILURE_TYPE = 'failure_type' satisfies keyof WhitelabelBranding;
 export const KEY_WHITELABEL_BRANDING_HOSTNAME = 'hostname' satisfies keyof WhitelabelBranding;
 export const KEY_WHITELABEL_BRANDING_KEYCLOAK_CLIENT_ID = 'keycloak_client_id' satisfies keyof WhitelabelBranding;
 export const KEY_WHITELABEL_BRANDING_ONBOARDING_STATUS = 'onboarding_status' satisfies keyof WhitelabelBranding;
@@ -5777,7 +5779,9 @@ export const KEY_WHITELABEL_BRANDING_WHITELABEL_BRANDING_ID = 'whitelabel_brandi
 export const KEYS_WHITELABEL_BRANDING = [
   KEY_WHITELABEL_BRANDING_AUTH_HOSTNAME,
   KEY_WHITELABEL_BRANDING_CREATED_ON,
-  KEY_WHITELABEL_BRANDING_FAILURE_REASON,
+  KEY_WHITELABEL_BRANDING_FAILURE_CODE,
+  KEY_WHITELABEL_BRANDING_FAILURE_DETAIL,
+  KEY_WHITELABEL_BRANDING_FAILURE_TYPE,
   KEY_WHITELABEL_BRANDING_HOSTNAME,
   KEY_WHITELABEL_BRANDING_KEYCLOAK_CLIENT_ID,
   KEY_WHITELABEL_BRANDING_ONBOARDING_STATUS,

package/src/helpers/schemas.d.ts

@@ -565,6 +565,8 @@ export type VerificationType = components['schemas']['VerificationType'];
 export type VisitsByKeyBucket = components['schemas']['VisitsByKeyBucket'];
 export type WhitelabelBrandingCreate = components['schemas']['WhitelabelBrandingCreate'];
 export type WhitelabelBranding = components['schemas']['WhitelabelBrandingResponse'];
+export type WhitelabelOnboardingFailureCode = components['schemas']['WhitelabelOnboardingFailureCode'];
+export type WhitelabelOnboardingFailureType = components['schemas']['WhitelabelOnboardingFailureType'];
 export type WhitelabelOnboardingStatus = components['schemas']['WhitelabelOnboardingStatus'];
 export type WhoisBase = components['schemas']['WhoisBase'];
 export type ZoneIncludeField = components['schemas']['ZoneIncludeField'];

package/src/openapi.yaml

@@ -14401,11 +14401,20 @@ components:
           format: date-time
           title: Created On
           type: string
-        failure_reason:
+        failure_code:
+          anyOf:
+          - $ref: '#/components/schemas/WhitelabelOnboardingFailureCode'
+          - type: 'null'
+        failure_detail:
           anyOf:
           - type: string
           - type: 'null'
-          title: Failure Reason
+          title: Failure Detail
+        failure_type:
+          anyOf:
+          - $ref: '#/components/schemas/WhitelabelOnboardingFailureType'
+          - type: 'null'
+          readOnly: true
         hostname:
           maxLength: 255
           minLength: 1
@@ -14453,11 +14462,34 @@ components:
       - auth_hostname
       - verification_domain
       - keycloak_client_id
-      - failure_reason
       - created_on
       - updated_on
+      - failure_type
       title: WhitelabelBrandingResponse
       type: object
+    WhitelabelOnboardingFailureCode:
+      description: 'Stable, frontend-facing reason a terminal onboarding failure happened.
+        The free-text
+
+        detail that accompanies it is for support/debugging, never for customer display.'
+      enum:
+      - zone_not_owned
+      - delegation_missing
+      - delegation_mismatch
+      - dns_record_rejected
+      - auth_client_rejected
+      - branding_rejected
+      - retries_exhausted
+      title: WhitelabelOnboardingFailureCode
+      type: string
+    WhitelabelOnboardingFailureType:
+      enum:
+      - dns
+      - auth
+      - branding
+      - system
+      title: WhitelabelOnboardingFailureType
+      type: string
     WhitelabelOnboardingStatus:
       enum:
       - pending_domain_verification
@@ -14793,7 +14825,7 @@ info:
     \n\n"
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2026-07-26-224919
+  version: 2026-07-27-074918
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg

package/src/schema.d.ts

@@ -12423,8 +12423,10 @@ export interface components {
              * Format: date-time
              */
             created_on: Date;
-            /** Failure Reason */
-            failure_reason: string | null;
+            failure_code?: components["schemas"]["WhitelabelOnboardingFailureCode"] | null;
+            /** Failure Detail */
+            failure_detail?: string | null;
+            readonly failure_type: components["schemas"]["WhitelabelOnboardingFailureType"] | null;
             /** Hostname */
             hostname: string;
             /** Keycloak Client Id */
@@ -12450,6 +12452,18 @@ export interface components {
              */
             whitelabel_branding_id: TypeId<"wlb">;
         };
+        /**
+         * WhitelabelOnboardingFailureCode
+         * @description Stable, frontend-facing reason a terminal onboarding failure happened. The free-text
+         *     detail that accompanies it is for support/debugging, never for customer display.
+         * @enum {string}
+         */
+        WhitelabelOnboardingFailureCode: "zone_not_owned" | "delegation_missing" | "delegation_mismatch" | "dns_record_rejected" | "auth_client_rejected" | "branding_rejected" | "retries_exhausted";
+        /**
+         * WhitelabelOnboardingFailureType
+         * @enum {string}
+         */
+        WhitelabelOnboardingFailureType: "dns" | "auth" | "branding" | "system";
         /**
          * WhitelabelOnboardingStatus
          * @enum {string}