@opusdns/api 1.132.0 → 1.134.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 +2 -0
- package/src/helpers/keys.ts +6 -0
- package/src/openapi.yaml +28 -2
- package/src/schema.d.ts +18 -1
package/package.json
CHANGED
package/src/helpers/constants.ts
CHANGED
|
@@ -2244,6 +2244,7 @@ export const WHITELABEL_ONBOARDING_FAILURE_CODE = {
|
|
|
2244
2244
|
ZONE_NOT_OWNED: "zone_not_owned",
|
|
2245
2245
|
DELEGATION_MISSING: "delegation_missing",
|
|
2246
2246
|
DELEGATION_MISMATCH: "delegation_mismatch",
|
|
2247
|
+
ZONE_CREATE_FAILED: "zone_create_failed",
|
|
2247
2248
|
DNS_RECORD_REJECTED: "dns_record_rejected",
|
|
2248
2249
|
AUTH_CLIENT_REJECTED: "auth_client_rejected",
|
|
2249
2250
|
BRANDING_REJECTED: "branding_rejected",
|
|
@@ -2254,6 +2255,7 @@ export const WHITELABEL_ONBOARDING_FAILURE_CODE_VALUES = [
|
|
|
2254
2255
|
'zone_not_owned',
|
|
2255
2256
|
'delegation_missing',
|
|
2256
2257
|
'delegation_mismatch',
|
|
2258
|
+
'zone_create_failed',
|
|
2257
2259
|
'dns_record_rejected',
|
|
2258
2260
|
'auth_client_rejected',
|
|
2259
2261
|
'branding_rejected',
|
package/src/helpers/keys.ts
CHANGED
|
@@ -5915,11 +5915,13 @@ export const KEYS_WHITELABEL_BRANDING_PATCH = [
|
|
|
5915
5915
|
] as const satisfies (keyof WhitelabelBrandingPatch)[];
|
|
5916
5916
|
|
|
5917
5917
|
export const KEY_WHITELABEL_BRANDING_RECHECK_AUTH_SUBDOMAIN = 'auth_subdomain' satisfies keyof WhitelabelBrandingRecheck;
|
|
5918
|
+
export const KEY_WHITELABEL_BRANDING_RECHECK_CREATE_ZONE = 'create_zone' satisfies keyof WhitelabelBrandingRecheck;
|
|
5918
5919
|
export const KEY_WHITELABEL_BRANDING_RECHECK_DASHBOARD_SUBDOMAIN = 'dashboard_subdomain' satisfies keyof WhitelabelBrandingRecheck;
|
|
5919
5920
|
export const KEY_WHITELABEL_BRANDING_RECHECK_HOSTNAME = 'hostname' satisfies keyof WhitelabelBrandingRecheck;
|
|
5920
5921
|
|
|
5921
5922
|
export const KEYS_WHITELABEL_BRANDING_RECHECK = [
|
|
5922
5923
|
KEY_WHITELABEL_BRANDING_RECHECK_AUTH_SUBDOMAIN,
|
|
5924
|
+
KEY_WHITELABEL_BRANDING_RECHECK_CREATE_ZONE,
|
|
5923
5925
|
KEY_WHITELABEL_BRANDING_RECHECK_DASHBOARD_SUBDOMAIN,
|
|
5924
5926
|
KEY_WHITELABEL_BRANDING_RECHECK_HOSTNAME,
|
|
5925
5927
|
] as const satisfies (keyof WhitelabelBrandingRecheck)[];
|
|
@@ -5961,6 +5963,7 @@ export const KEYS_WHITELABEL_BRANDING = [
|
|
|
5961
5963
|
] as const satisfies (keyof WhitelabelBranding)[];
|
|
5962
5964
|
|
|
5963
5965
|
export const KEY_WHITELABEL_PLUS_CREATE_AUTH_SUBDOMAIN = 'auth_subdomain' satisfies keyof WhitelabelPlusCreate;
|
|
5966
|
+
export const KEY_WHITELABEL_PLUS_CREATE_CREATE_ZONE = 'create_zone' satisfies keyof WhitelabelPlusCreate;
|
|
5964
5967
|
export const KEY_WHITELABEL_PLUS_CREATE_DASHBOARD_SUBDOMAIN = 'dashboard_subdomain' satisfies keyof WhitelabelPlusCreate;
|
|
5965
5968
|
export const KEY_WHITELABEL_PLUS_CREATE_HOSTNAME = 'hostname' satisfies keyof WhitelabelPlusCreate;
|
|
5966
5969
|
export const KEY_WHITELABEL_PLUS_CREATE_LABEL = 'label' satisfies keyof WhitelabelPlusCreate;
|
|
@@ -5969,6 +5972,7 @@ export const KEY_WHITELABEL_PLUS_CREATE_TIER = 'tier' satisfies keyof Whitelabel
|
|
|
5969
5972
|
|
|
5970
5973
|
export const KEYS_WHITELABEL_PLUS_CREATE = [
|
|
5971
5974
|
KEY_WHITELABEL_PLUS_CREATE_AUTH_SUBDOMAIN,
|
|
5975
|
+
KEY_WHITELABEL_PLUS_CREATE_CREATE_ZONE,
|
|
5972
5976
|
KEY_WHITELABEL_PLUS_CREATE_DASHBOARD_SUBDOMAIN,
|
|
5973
5977
|
KEY_WHITELABEL_PLUS_CREATE_HOSTNAME,
|
|
5974
5978
|
KEY_WHITELABEL_PLUS_CREATE_LABEL,
|
|
@@ -5991,11 +5995,13 @@ export const KEYS_WHITELABEL_SUBSCRIPTION_INFO = [
|
|
|
5991
5995
|
] as const satisfies (keyof WhitelabelSubscriptionInfo)[];
|
|
5992
5996
|
|
|
5993
5997
|
export const KEY_WHITELABEL_UPGRADE_TO_PLUS_AUTH_SUBDOMAIN = 'auth_subdomain' satisfies keyof WhitelabelUpgradeToPlus;
|
|
5998
|
+
export const KEY_WHITELABEL_UPGRADE_TO_PLUS_CREATE_ZONE = 'create_zone' satisfies keyof WhitelabelUpgradeToPlus;
|
|
5994
5999
|
export const KEY_WHITELABEL_UPGRADE_TO_PLUS_DASHBOARD_SUBDOMAIN = 'dashboard_subdomain' satisfies keyof WhitelabelUpgradeToPlus;
|
|
5995
6000
|
export const KEY_WHITELABEL_UPGRADE_TO_PLUS_HOSTNAME = 'hostname' satisfies keyof WhitelabelUpgradeToPlus;
|
|
5996
6001
|
|
|
5997
6002
|
export const KEYS_WHITELABEL_UPGRADE_TO_PLUS = [
|
|
5998
6003
|
KEY_WHITELABEL_UPGRADE_TO_PLUS_AUTH_SUBDOMAIN,
|
|
6004
|
+
KEY_WHITELABEL_UPGRADE_TO_PLUS_CREATE_ZONE,
|
|
5999
6005
|
KEY_WHITELABEL_UPGRADE_TO_PLUS_DASHBOARD_SUBDOMAIN,
|
|
6000
6006
|
KEY_WHITELABEL_UPGRADE_TO_PLUS_HOSTNAME,
|
|
6001
6007
|
] as const satisfies (keyof WhitelabelUpgradeToPlus)[];
|
package/src/openapi.yaml
CHANGED
|
@@ -14918,6 +14918,15 @@ components:
|
|
|
14918
14918
|
- type: 'null'
|
|
14919
14919
|
description: Subdomain the login is served on; required together with hostname
|
|
14920
14920
|
title: Auth Subdomain
|
|
14921
|
+
create_zone:
|
|
14922
|
+
anyOf:
|
|
14923
|
+
- type: boolean
|
|
14924
|
+
- type: 'null'
|
|
14925
|
+
description: Opt in (or out) of onboarding creating the OpusDNS-hosted zone
|
|
14926
|
+
if it is missing, applied before this re-run and to any re-pointed domain.
|
|
14927
|
+
Omit to keep the config's current setting - a plain retry never changes
|
|
14928
|
+
it. Plus tier only.
|
|
14929
|
+
title: Create Zone
|
|
14921
14930
|
dashboard_subdomain:
|
|
14922
14931
|
anyOf:
|
|
14923
14932
|
- maxLength: 255
|
|
@@ -15083,6 +15092,7 @@ components:
|
|
|
15083
15092
|
- zone_not_owned
|
|
15084
15093
|
- delegation_missing
|
|
15085
15094
|
- delegation_mismatch
|
|
15095
|
+
- zone_create_failed
|
|
15086
15096
|
- dns_record_rejected
|
|
15087
15097
|
- auth_client_rejected
|
|
15088
15098
|
- branding_rejected
|
|
@@ -15120,6 +15130,14 @@ components:
|
|
|
15120
15130
|
minLength: 1
|
|
15121
15131
|
title: Auth Subdomain
|
|
15122
15132
|
type: string
|
|
15133
|
+
create_zone:
|
|
15134
|
+
default: false
|
|
15135
|
+
description: Create the OpusDNS-hosted DNS zone for this domain during onboarding
|
|
15136
|
+
if it does not already exist, instead of requiring it to exist beforehand.
|
|
15137
|
+
The domain must still be delegated to the OpusDNS nameservers for verification
|
|
15138
|
+
to pass. The dashboard sends true; other API callers opt in explicitly.
|
|
15139
|
+
title: Create Zone
|
|
15140
|
+
type: boolean
|
|
15123
15141
|
dashboard_subdomain:
|
|
15124
15142
|
anyOf:
|
|
15125
15143
|
- maxLength: 255
|
|
@@ -15247,6 +15265,14 @@ components:
|
|
|
15247
15265
|
minLength: 1
|
|
15248
15266
|
title: Auth Subdomain
|
|
15249
15267
|
type: string
|
|
15268
|
+
create_zone:
|
|
15269
|
+
default: false
|
|
15270
|
+
description: Create the OpusDNS-hosted DNS zone for this domain during onboarding
|
|
15271
|
+
if it does not already exist, instead of requiring it to exist beforehand.
|
|
15272
|
+
The domain must still be delegated to the OpusDNS nameservers for verification
|
|
15273
|
+
to pass. The dashboard sends true; other API callers opt in explicitly.
|
|
15274
|
+
title: Create Zone
|
|
15275
|
+
type: boolean
|
|
15250
15276
|
dashboard_subdomain:
|
|
15251
15277
|
anyOf:
|
|
15252
15278
|
- maxLength: 255
|
|
@@ -15710,7 +15736,7 @@ info:
|
|
|
15710
15736
|
\n\n"
|
|
15711
15737
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
15712
15738
|
title: OpusDNS API
|
|
15713
|
-
version: 2026-08-25-
|
|
15739
|
+
version: 2026-08-25-193748
|
|
15714
15740
|
x-logo:
|
|
15715
15741
|
altText: OpusDNS API Reference
|
|
15716
15742
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -23392,7 +23418,7 @@ paths:
|
|
|
23392
23418
|
schema:
|
|
23393
23419
|
anyOf:
|
|
23394
23420
|
- items:
|
|
23395
|
-
pattern: ^[a-zA-
|
|
23421
|
+
pattern: ^[a-zA-Z0-9]+(?:[.-]+[a-zA-Z0-9]+)*$
|
|
23396
23422
|
type: string
|
|
23397
23423
|
type: array
|
|
23398
23424
|
- type: 'null'
|
package/src/schema.d.ts
CHANGED
|
@@ -12790,6 +12790,11 @@ export interface components {
|
|
|
12790
12790
|
* @description Subdomain the login is served on; required together with hostname
|
|
12791
12791
|
*/
|
|
12792
12792
|
auth_subdomain?: string | null;
|
|
12793
|
+
/**
|
|
12794
|
+
* Create Zone
|
|
12795
|
+
* @description Opt in (or out) of onboarding creating the OpusDNS-hosted zone if it is missing, applied before this re-run and to any re-pointed domain. Omit to keep the config's current setting - a plain retry never changes it. Plus tier only.
|
|
12796
|
+
*/
|
|
12797
|
+
create_zone?: boolean | null;
|
|
12793
12798
|
/**
|
|
12794
12799
|
* Dashboard Subdomain
|
|
12795
12800
|
* @description Subdomain the dashboard is served on; omit for apex. Only together with hostname.
|
|
@@ -12892,7 +12897,7 @@ export interface components {
|
|
|
12892
12897
|
* detail that accompanies it is for support/debugging, never for customer display.
|
|
12893
12898
|
* @enum {string}
|
|
12894
12899
|
*/
|
|
12895
|
-
WhitelabelOnboardingFailureCode: "zone_not_owned" | "delegation_missing" | "delegation_mismatch" | "dns_record_rejected" | "auth_client_rejected" | "branding_rejected" | "retries_exhausted";
|
|
12900
|
+
WhitelabelOnboardingFailureCode: "zone_not_owned" | "delegation_missing" | "delegation_mismatch" | "zone_create_failed" | "dns_record_rejected" | "auth_client_rejected" | "branding_rejected" | "retries_exhausted";
|
|
12896
12901
|
/**
|
|
12897
12902
|
* WhitelabelOnboardingFailureType
|
|
12898
12903
|
* @enum {string}
|
|
@@ -12914,6 +12919,12 @@ export interface components {
|
|
|
12914
12919
|
* @description Subdomain the login is served on (e.g. auth -> auth.customer.com)
|
|
12915
12920
|
*/
|
|
12916
12921
|
auth_subdomain: string;
|
|
12922
|
+
/**
|
|
12923
|
+
* Create Zone
|
|
12924
|
+
* @description Create the OpusDNS-hosted DNS zone for this domain during onboarding if it does not already exist, instead of requiring it to exist beforehand. The domain must still be delegated to the OpusDNS nameservers for verification to pass. The dashboard sends true; other API callers opt in explicitly.
|
|
12925
|
+
* @default false
|
|
12926
|
+
*/
|
|
12927
|
+
create_zone: boolean;
|
|
12917
12928
|
/**
|
|
12918
12929
|
* Dashboard Subdomain
|
|
12919
12930
|
* @description Subdomain the dashboard is served on (e.g. dash -> dash.customer.com); omit for apex
|
|
@@ -12989,6 +13000,12 @@ export interface components {
|
|
|
12989
13000
|
* @description Subdomain the login is served on (e.g. auth -> auth.customer.com)
|
|
12990
13001
|
*/
|
|
12991
13002
|
auth_subdomain: string;
|
|
13003
|
+
/**
|
|
13004
|
+
* Create Zone
|
|
13005
|
+
* @description Create the OpusDNS-hosted DNS zone for this domain during onboarding if it does not already exist, instead of requiring it to exist beforehand. The domain must still be delegated to the OpusDNS nameservers for verification to pass. The dashboard sends true; other API callers opt in explicitly.
|
|
13006
|
+
* @default false
|
|
13007
|
+
*/
|
|
13008
|
+
create_zone: boolean;
|
|
12992
13009
|
/**
|
|
12993
13010
|
* Dashboard Subdomain
|
|
12994
13011
|
* @description Subdomain the dashboard is served on (e.g. dash -> dash.customer.com); omit for apex
|