@opusdns/api 1.120.0 → 1.122.0

package/package.json

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

package/src/helpers/keys.ts

@@ -2597,6 +2597,7 @@ export const KEY_DOMAIN_IS_PREMIUM = 'is_premium' satisfies keyof Domain;
 export const KEY_DOMAIN_NAME = 'name' satisfies keyof Domain;
 export const KEY_DOMAIN_NAMESERVERS = 'nameservers' satisfies keyof Domain;
 export const KEY_DOMAIN_OWNER_ID = 'owner_id' satisfies keyof Domain;
+export const KEY_DOMAIN_READ_ONLY = 'read_only' satisfies keyof Domain;
 export const KEY_DOMAIN_REGISTERED_ON = 'registered_on' satisfies keyof Domain;
 export const KEY_DOMAIN_REGISTRY_ACCOUNT_ID = 'registry_account_id' satisfies keyof Domain;
 export const KEY_DOMAIN_REGISTRY_STATUSES = 'registry_statuses' satisfies keyof Domain;
@@ -2627,6 +2628,7 @@ export const KEYS_DOMAIN = [
   KEY_DOMAIN_NAME,
   KEY_DOMAIN_NAMESERVERS,
   KEY_DOMAIN_OWNER_ID,
+  KEY_DOMAIN_READ_ONLY,
   KEY_DOMAIN_REGISTERED_ON,
   KEY_DOMAIN_REGISTRY_ACCOUNT_ID,
   KEY_DOMAIN_REGISTRY_STATUSES,
@@ -5972,12 +5974,14 @@ export const KEYS_WHITELABEL_PLUS_CREATE = [
 
 export const KEY_WHITELABEL_SUBSCRIPTION_INFO_EXPIRES_ON = 'expires_on' satisfies keyof WhitelabelSubscriptionInfo;
 export const KEY_WHITELABEL_SUBSCRIPTION_INFO_GRACE_PERIOD_ENDS_AT = 'grace_period_ends_at' satisfies keyof WhitelabelSubscriptionInfo;
+export const KEY_WHITELABEL_SUBSCRIPTION_INFO_PERIOD = 'period' satisfies keyof WhitelabelSubscriptionInfo;
 export const KEY_WHITELABEL_SUBSCRIPTION_INFO_RENEW_SCHEDULED_AT = 'renew_scheduled_at' satisfies keyof WhitelabelSubscriptionInfo;
 export const KEY_WHITELABEL_SUBSCRIPTION_INFO_RENEWAL_MODE = 'renewal_mode' satisfies keyof WhitelabelSubscriptionInfo;
 
 export const KEYS_WHITELABEL_SUBSCRIPTION_INFO = [
   KEY_WHITELABEL_SUBSCRIPTION_INFO_EXPIRES_ON,
   KEY_WHITELABEL_SUBSCRIPTION_INFO_GRACE_PERIOD_ENDS_AT,
+  KEY_WHITELABEL_SUBSCRIPTION_INFO_PERIOD,
   KEY_WHITELABEL_SUBSCRIPTION_INFO_RENEW_SCHEDULED_AT,
   KEY_WHITELABEL_SUBSCRIPTION_INFO_RENEWAL_MODE,
 ] as const satisfies (keyof WhitelabelSubscriptionInfo)[];

package/src/openapi.yaml

@@ -5579,6 +5579,15 @@ components:
           title: Owner Id
           type: string
           x-typeid-prefix: organization
+        read_only:
+          default: false
+          description: "Whether the domain is read-only in OpusDNS. When `true`, the\
+            \ domain is listed in your portfolio but cannot be managed \u2014 for\
+            \ example while it awaits a migration, is locked for legal reasons, or\
+            \ is managed at an external registrar. The flag is set and removed by\
+            \ OpusDNS; it cannot be changed through the API."
+          title: Read Only
+          type: boolean
         registered_on:
           anyOf:
           - format: date-time
@@ -14715,6 +14724,8 @@ components:
           description: 'Billing period; offered: 1 month or 1 year'
         tier:
           const: base
+          description: Tier discriminator; base = served on a managed subdomain of
+            an OpusDNS-owned zone
           title: Tier
           type: string
       required:
@@ -14769,8 +14780,8 @@ components:
         fixing DNS). hostname + auth_subdomain present = re-point a wrong domain before
         re-running
 
-        (pre-provisioning only; server rejects once a Keycloak client exists). Plus
-        tier only - a
+        (pre-provisioning only; server rejects once an authentication client exists).
+        Plus tier only - a
 
         base whitelabel is re-labelled through PATCH instead.'
       properties:
@@ -14780,6 +14791,7 @@ components:
             minLength: 1
             type: string
           - type: 'null'
+          description: Subdomain the login is served on; required together with hostname
           title: Auth Subdomain
         dashboard_subdomain:
           anyOf:
@@ -14787,6 +14799,8 @@ components:
             minLength: 1
             type: string
           - type: 'null'
+          description: Subdomain the dashboard is served on; omit for apex. Only together
+            with hostname.
           title: Dashboard Subdomain
         hostname:
           anyOf:
@@ -14794,6 +14808,8 @@ components:
             minLength: 1
             type: string
           - type: 'null'
+          description: New domain to run the whitelabel under; omit to re-run against
+            the stored hosts
           title: Hostname
       title: WhitelabelBrandingRecheck
       type: object
@@ -14801,11 +14817,15 @@ components:
       description: Public read shape for an organization's whitelabel branding config.
       properties:
         auth_hostname:
+          description: Auth/login hostname served by the authentication system (e.g.
+            auth.customer.com)
           maxLength: 255
           minLength: 1
           title: Auth Hostname
           type: string
         base_label:
+          description: Managed-subdomain label; served on the base tier, reserved
+            on plus
           maxLength: 255
           minLength: 1
           title: Base Label
@@ -14816,16 +14836,21 @@ components:
           type: string
         enabled:
           default: true
+          description: Whether this whitelabel is served; false freezes serving but
+            keeps the config
           title: Enabled
           type: boolean
         failure_code:
           anyOf:
           - $ref: '#/components/schemas/WhitelabelOnboardingFailureCode'
           - type: 'null'
+          description: Stable code of the last terminal onboarding failure
         failure_detail:
           anyOf:
           - type: string
           - type: 'null'
+          description: Free-text detail of the last onboarding failure (support/debugging,
+            not for customer display)
           title: Failure Detail
         failure_type:
           anyOf:
@@ -14833,6 +14858,7 @@ components:
           - type: 'null'
           readOnly: true
         hostname:
+          description: Dashboard hostname being served (e.g. app.customer.com)
           maxLength: 255
           minLength: 1
           title: Hostname
@@ -14843,9 +14869,12 @@ components:
             minLength: 1
             type: string
           - type: 'null'
+          description: Authentication-system client provisioned for this whitelabel;
+            null until provisioning
           title: Keycloak Client Id
         onboarding_status:
           $ref: '#/components/schemas/WhitelabelOnboardingStatus'
+          description: Onboarding lifecycle state
         organization_id:
           examples:
           - organization_01h45ytscbebyvny4gc8cr8ma2
@@ -14858,13 +14887,18 @@ components:
           anyOf:
           - $ref: '#/components/schemas/WhitelabelSubscriptionInfo'
           - type: 'null'
+          description: Billing-lifecycle block; null when the config has no live subscription
+            (provisioning or terminated)
         tier:
           $ref: '#/components/schemas/WhitelabelBrandingTier'
+          description: 'Tier this config is on: base (managed subdomain) or plus (customer''s
+            own domain)'
         updated_on:
           format: date-time
           title: Updated On
           type: string
         verification_domain:
+          description: Registrable domain of the served hostname
           maxLength: 255
           minLength: 1
           title: Verification Domain
@@ -14956,7 +14990,7 @@ components:
         subdomain (kept for the redirect/downgrade).'
       properties:
         auth_subdomain:
-          description: Subdomain the Keycloak login is served on (e.g. auth -> auth.customer.com)
+          description: Subdomain the login is served on (e.g. auth -> auth.customer.com)
           maxLength: 255
           minLength: 1
           title: Auth Subdomain
@@ -14988,6 +15022,7 @@ components:
           description: 'Billing period; offered: 1 month or 1 year'
         tier:
           const: plus
+          description: Tier discriminator; plus = served on the customer's own domain
           title: Tier
           type: string
       required:
@@ -15034,23 +15069,35 @@ components:
           - format: date-time
             type: string
           - type: 'null'
+          description: End of the current paid term; on an expiring config, when serving
+            stops
           title: Expires On
         grace_period_ends_at:
           anyOf:
           - format: date-time
             type: string
           - type: 'null'
+          description: End of the grace period, if the subscription is in one
           title: Grace Period Ends At
+        period:
+          $ref: '#/components/schemas/Period'
+          description: Billing period the subscription renews on (same shape as the
+            create body's period)
         renew_scheduled_at:
           anyOf:
           - format: date-time
             type: string
           - type: 'null'
+          description: When the next automatic renewal runs; only surfaced on a renewing
+            config
           title: Renew Scheduled At
         renewal_mode:
           $ref: '#/components/schemas/WhitelabelRenewalMode'
+          description: Whether the subscription auto-renews (renew) or lapses at period
+            end (expire, i.e. cancelled)
       required:
       - renewal_mode
+      - period
       title: WhitelabelSubscriptionInfo
       type: object
     WhitelabelUpgradeToPlus:
@@ -15070,7 +15117,7 @@ components:
         instead - so this body only ever moves to plus (no tier field, no period).'
       properties:
         auth_subdomain:
-          description: Subdomain the Keycloak login is served on (e.g. auth -> auth.customer.com)
+          description: Subdomain the login is served on (e.g. auth -> auth.customer.com)
           maxLength: 255
           minLength: 1
           title: Auth Subdomain
@@ -15538,7 +15585,7 @@ info:
     \n\n"
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2026-08-18-144629
+  version: 2026-08-19-080746
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -23349,6 +23396,14 @@ paths:
           - type: boolean
           - type: 'null'
           title: Transfer Lock
+      - in: query
+        name: read_only
+        required: false
+        schema:
+          anyOf:
+          - type: boolean
+          - type: 'null'
+          title: Read Only
       - in: query
         name: is_premium
         required: false

package/src/schema.d.ts

@@ -6613,6 +6613,12 @@ export interface components {
              * @example organization_01h45ytscbebyvny4gc8cr8ma2
              */
             owner_id: TypeId<"organization">;
+            /**
+             * Read Only
+             * @description Whether the domain is read-only in OpusDNS. When `true`, the domain is listed in your portfolio but cannot be managed — for example while it awaits a migration, is locked for legal reasons, or is managed at an external registrar. The flag is set and removed by OpusDNS; it cannot be changed through the API.
+             * @default false
+             */
+            read_only: boolean;
             /**
              * Registered On
              * @description When the domain was registered
@@ -12711,7 +12717,7 @@ export interface components {
             /** @description Billing period; offered: 1 month or 1 year */
             period: components["schemas"]["Period"];
             /**
-             * @description discriminator enum property added by openapi-typescript
+             * @description Tier discriminator; base = served on a managed subdomain of an OpusDNS-owned zone (enum property replaced by openapi-typescript)
              * @enum {string}
              */
             tier: "base";
@@ -12742,15 +12748,24 @@ export interface components {
          * WhitelabelBrandingRecheck
          * @description Public recheck body. Empty = re-run onboarding against the stored hosts (retry after
          *     fixing DNS). hostname + auth_subdomain present = re-point a wrong domain before re-running
-         *     (pre-provisioning only; server rejects once a Keycloak client exists). Plus tier only - a
+         *     (pre-provisioning only; server rejects once an authentication client exists). Plus tier only - a
          *     base whitelabel is re-labelled through PATCH instead.
          */
         WhitelabelBrandingRecheck: {
-            /** Auth Subdomain */
+            /**
+             * Auth Subdomain
+             * @description Subdomain the login is served on; required together with hostname
+             */
             auth_subdomain?: string | null;
-            /** Dashboard Subdomain */
+            /**
+             * Dashboard Subdomain
+             * @description Subdomain the dashboard is served on; omit for apex. Only together with hostname.
+             */
             dashboard_subdomain?: string | null;
-            /** Hostname */
+            /**
+             * Hostname
+             * @description New domain to run the whitelabel under; omit to re-run against the stored hosts
+             */
             hostname?: string | null;
         };
         /**
@@ -12758,9 +12773,15 @@ export interface components {
          * @description Public read shape for an organization's whitelabel branding config.
          */
         WhitelabelBrandingResponse: {
-            /** Auth Hostname */
+            /**
+             * Auth Hostname
+             * @description Auth/login hostname served by the authentication system (e.g. auth.customer.com)
+             */
             auth_hostname: string;
-            /** Base Label */
+            /**
+             * Base Label
+             * @description Managed-subdomain label; served on the base tier, reserved on plus
+             */
             base_label: string;
             /**
              * Created On
@@ -12769,17 +12790,29 @@ export interface components {
             created_on: Date;
             /**
              * Enabled
+             * @description Whether this whitelabel is served; false freezes serving but keeps the config
              * @default true
              */
             enabled: boolean;
+            /** @description Stable code of the last terminal onboarding failure */
             failure_code?: components["schemas"]["WhitelabelOnboardingFailureCode"] | null;
-            /** Failure Detail */
+            /**
+             * Failure Detail
+             * @description Free-text detail of the last onboarding failure (support/debugging, not for customer display)
+             */
             failure_detail?: string | null;
             readonly failure_type: components["schemas"]["WhitelabelOnboardingFailureType"] | null;
-            /** Hostname */
+            /**
+             * Hostname
+             * @description Dashboard hostname being served (e.g. app.customer.com)
+             */
             hostname: string;
-            /** Keycloak Client Id */
+            /**
+             * Keycloak Client Id
+             * @description Authentication-system client provisioned for this whitelabel; null until provisioning
+             */
             keycloak_client_id: string | null;
+            /** @description Onboarding lifecycle state */
             onboarding_status: components["schemas"]["WhitelabelOnboardingStatus"];
             /**
              * Organization Id
@@ -12787,14 +12820,19 @@ export interface components {
              * @example organization_01h45ytscbebyvny4gc8cr8ma2
              */
             organization_id: TypeId<"organization">;
+            /** @description Billing-lifecycle block; null when the config has no live subscription (provisioning or terminated) */
             subscription?: components["schemas"]["WhitelabelSubscriptionInfo"] | null;
+            /** @description Tier this config is on: base (managed subdomain) or plus (customer's own domain) */
             tier: components["schemas"]["WhitelabelBrandingTier"];
             /**
              * Updated On
              * Format: date-time
              */
             updated_on: Date;
-            /** Verification Domain */
+            /**
+             * Verification Domain
+             * @description Registrable domain of the served hostname
+             */
             verification_domain: string;
             /**
              * Whitelabel Branding Id
@@ -12840,7 +12878,7 @@ export interface components {
         WhitelabelPlusCreate: {
             /**
              * Auth Subdomain
-             * @description Subdomain the Keycloak login is served on (e.g. auth -> auth.customer.com)
+             * @description Subdomain the login is served on (e.g. auth -> auth.customer.com)
              */
             auth_subdomain: string;
             /**
@@ -12861,7 +12899,7 @@ export interface components {
             /** @description Billing period; offered: 1 month or 1 year */
             period: components["schemas"]["Period"];
             /**
-             * @description discriminator enum property added by openapi-typescript
+             * @description Tier discriminator; plus = served on the customer's own domain (enum property replaced by openapi-typescript)
              * @enum {string}
              */
             tier: "plus";
@@ -12884,12 +12922,24 @@ export interface components {
          *     cancelled whitelabel reads: "cancelled, served until expires_on".
          */
         WhitelabelSubscriptionInfo: {
-            /** Expires On */
+            /**
+             * Expires On
+             * @description End of the current paid term; on an expiring config, when serving stops
+             */
             expires_on?: Date | null;
-            /** Grace Period Ends At */
+            /**
+             * Grace Period Ends At
+             * @description End of the grace period, if the subscription is in one
+             */
             grace_period_ends_at?: Date | null;
-            /** Renew Scheduled At */
+            /** @description Billing period the subscription renews on (same shape as the create body's period) */
+            period: components["schemas"]["Period"];
+            /**
+             * Renew Scheduled At
+             * @description When the next automatic renewal runs; only surfaced on a renewing config
+             */
             renew_scheduled_at?: Date | null;
+            /** @description Whether the subscription auto-renews (renew) or lapses at period end (expire, i.e. cancelled) */
             renewal_mode: components["schemas"]["WhitelabelRenewalMode"];
         };
         /**
@@ -12903,7 +12953,7 @@ export interface components {
         WhitelabelUpgradeToPlus: {
             /**
              * Auth Subdomain
-             * @description Subdomain the Keycloak login is served on (e.g. auth -> auth.customer.com)
+             * @description Subdomain the login is served on (e.g. auth -> auth.customer.com)
              */
             auth_subdomain: string;
             /**
@@ -19126,6 +19176,7 @@ export interface operations {
                 tld?: string[] | null;
                 sld?: string | null;
                 transfer_lock?: boolean | null;
+                read_only?: boolean | null;
                 is_premium?: boolean | null;
                 created_after?: Date | null;
                 created_before?: Date | null;