@opusdns/api 1.131.0 → 1.133.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 +8 -0
- package/src/openapi.yaml +37 -1
- package/src/schema.d.ts +25 -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
|
@@ -2726,6 +2726,7 @@ export const KEYS_DOMAIN_STATUSES_BASE = [
|
|
|
2726
2726
|
|
|
2727
2727
|
export const KEY_DOMAIN_SUMMARY_DATA_BY_ORGANIZATION = 'by_organization' satisfies keyof DomainSummaryData;
|
|
2728
2728
|
export const KEY_DOMAIN_SUMMARY_DATA_BY_STATUS = 'by_status' satisfies keyof DomainSummaryData;
|
|
2729
|
+
export const KEY_DOMAIN_SUMMARY_DATA_BY_STATUS_TAG = 'by_status_tag' satisfies keyof DomainSummaryData;
|
|
2729
2730
|
export const KEY_DOMAIN_SUMMARY_DATA_BY_TLD = 'by_tld' satisfies keyof DomainSummaryData;
|
|
2730
2731
|
export const KEY_DOMAIN_SUMMARY_DATA_EXPIRING_SOON = 'expiring_soon' satisfies keyof DomainSummaryData;
|
|
2731
2732
|
export const KEY_DOMAIN_SUMMARY_DATA_TOTAL_COUNT = 'total_count' satisfies keyof DomainSummaryData;
|
|
@@ -2733,6 +2734,7 @@ export const KEY_DOMAIN_SUMMARY_DATA_TOTAL_COUNT = 'total_count' satisfies keyof
|
|
|
2733
2734
|
export const KEYS_DOMAIN_SUMMARY_DATA = [
|
|
2734
2735
|
KEY_DOMAIN_SUMMARY_DATA_BY_ORGANIZATION,
|
|
2735
2736
|
KEY_DOMAIN_SUMMARY_DATA_BY_STATUS,
|
|
2737
|
+
KEY_DOMAIN_SUMMARY_DATA_BY_STATUS_TAG,
|
|
2736
2738
|
KEY_DOMAIN_SUMMARY_DATA_BY_TLD,
|
|
2737
2739
|
KEY_DOMAIN_SUMMARY_DATA_EXPIRING_SOON,
|
|
2738
2740
|
KEY_DOMAIN_SUMMARY_DATA_TOTAL_COUNT,
|
|
@@ -5913,11 +5915,13 @@ export const KEYS_WHITELABEL_BRANDING_PATCH = [
|
|
|
5913
5915
|
] as const satisfies (keyof WhitelabelBrandingPatch)[];
|
|
5914
5916
|
|
|
5915
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;
|
|
5916
5919
|
export const KEY_WHITELABEL_BRANDING_RECHECK_DASHBOARD_SUBDOMAIN = 'dashboard_subdomain' satisfies keyof WhitelabelBrandingRecheck;
|
|
5917
5920
|
export const KEY_WHITELABEL_BRANDING_RECHECK_HOSTNAME = 'hostname' satisfies keyof WhitelabelBrandingRecheck;
|
|
5918
5921
|
|
|
5919
5922
|
export const KEYS_WHITELABEL_BRANDING_RECHECK = [
|
|
5920
5923
|
KEY_WHITELABEL_BRANDING_RECHECK_AUTH_SUBDOMAIN,
|
|
5924
|
+
KEY_WHITELABEL_BRANDING_RECHECK_CREATE_ZONE,
|
|
5921
5925
|
KEY_WHITELABEL_BRANDING_RECHECK_DASHBOARD_SUBDOMAIN,
|
|
5922
5926
|
KEY_WHITELABEL_BRANDING_RECHECK_HOSTNAME,
|
|
5923
5927
|
] as const satisfies (keyof WhitelabelBrandingRecheck)[];
|
|
@@ -5959,6 +5963,7 @@ export const KEYS_WHITELABEL_BRANDING = [
|
|
|
5959
5963
|
] as const satisfies (keyof WhitelabelBranding)[];
|
|
5960
5964
|
|
|
5961
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;
|
|
5962
5967
|
export const KEY_WHITELABEL_PLUS_CREATE_DASHBOARD_SUBDOMAIN = 'dashboard_subdomain' satisfies keyof WhitelabelPlusCreate;
|
|
5963
5968
|
export const KEY_WHITELABEL_PLUS_CREATE_HOSTNAME = 'hostname' satisfies keyof WhitelabelPlusCreate;
|
|
5964
5969
|
export const KEY_WHITELABEL_PLUS_CREATE_LABEL = 'label' satisfies keyof WhitelabelPlusCreate;
|
|
@@ -5967,6 +5972,7 @@ export const KEY_WHITELABEL_PLUS_CREATE_TIER = 'tier' satisfies keyof Whitelabel
|
|
|
5967
5972
|
|
|
5968
5973
|
export const KEYS_WHITELABEL_PLUS_CREATE = [
|
|
5969
5974
|
KEY_WHITELABEL_PLUS_CREATE_AUTH_SUBDOMAIN,
|
|
5975
|
+
KEY_WHITELABEL_PLUS_CREATE_CREATE_ZONE,
|
|
5970
5976
|
KEY_WHITELABEL_PLUS_CREATE_DASHBOARD_SUBDOMAIN,
|
|
5971
5977
|
KEY_WHITELABEL_PLUS_CREATE_HOSTNAME,
|
|
5972
5978
|
KEY_WHITELABEL_PLUS_CREATE_LABEL,
|
|
@@ -5989,11 +5995,13 @@ export const KEYS_WHITELABEL_SUBSCRIPTION_INFO = [
|
|
|
5989
5995
|
] as const satisfies (keyof WhitelabelSubscriptionInfo)[];
|
|
5990
5996
|
|
|
5991
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;
|
|
5992
5999
|
export const KEY_WHITELABEL_UPGRADE_TO_PLUS_DASHBOARD_SUBDOMAIN = 'dashboard_subdomain' satisfies keyof WhitelabelUpgradeToPlus;
|
|
5993
6000
|
export const KEY_WHITELABEL_UPGRADE_TO_PLUS_HOSTNAME = 'hostname' satisfies keyof WhitelabelUpgradeToPlus;
|
|
5994
6001
|
|
|
5995
6002
|
export const KEYS_WHITELABEL_UPGRADE_TO_PLUS = [
|
|
5996
6003
|
KEY_WHITELABEL_UPGRADE_TO_PLUS_AUTH_SUBDOMAIN,
|
|
6004
|
+
KEY_WHITELABEL_UPGRADE_TO_PLUS_CREATE_ZONE,
|
|
5997
6005
|
KEY_WHITELABEL_UPGRADE_TO_PLUS_DASHBOARD_SUBDOMAIN,
|
|
5998
6006
|
KEY_WHITELABEL_UPGRADE_TO_PLUS_HOSTNAME,
|
|
5999
6007
|
] as const satisfies (keyof WhitelabelUpgradeToPlus)[];
|
package/src/openapi.yaml
CHANGED
|
@@ -5958,6 +5958,15 @@ components:
|
|
|
5958
5958
|
description: 'Domain counts by status (status: count)'
|
|
5959
5959
|
title: By Status
|
|
5960
5960
|
type: object
|
|
5961
|
+
by_status_tag:
|
|
5962
|
+
additionalProperties:
|
|
5963
|
+
type: integer
|
|
5964
|
+
description: 'Domain counts by status tag (status_tag: count), only status
|
|
5965
|
+
tags with at least one domain'
|
|
5966
|
+
propertyNames:
|
|
5967
|
+
$ref: '#/components/schemas/StatusTagType'
|
|
5968
|
+
title: By Status Tag
|
|
5969
|
+
type: object
|
|
5961
5970
|
by_tld:
|
|
5962
5971
|
additionalProperties:
|
|
5963
5972
|
type: integer
|
|
@@ -5974,6 +5983,7 @@ components:
|
|
|
5974
5983
|
required:
|
|
5975
5984
|
- total_count
|
|
5976
5985
|
- by_status
|
|
5986
|
+
- by_status_tag
|
|
5977
5987
|
- by_tld
|
|
5978
5988
|
- by_organization
|
|
5979
5989
|
- expiring_soon
|
|
@@ -14908,6 +14918,15 @@ components:
|
|
|
14908
14918
|
- type: 'null'
|
|
14909
14919
|
description: Subdomain the login is served on; required together with hostname
|
|
14910
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
|
|
14911
14930
|
dashboard_subdomain:
|
|
14912
14931
|
anyOf:
|
|
14913
14932
|
- maxLength: 255
|
|
@@ -15073,6 +15092,7 @@ components:
|
|
|
15073
15092
|
- zone_not_owned
|
|
15074
15093
|
- delegation_missing
|
|
15075
15094
|
- delegation_mismatch
|
|
15095
|
+
- zone_create_failed
|
|
15076
15096
|
- dns_record_rejected
|
|
15077
15097
|
- auth_client_rejected
|
|
15078
15098
|
- branding_rejected
|
|
@@ -15110,6 +15130,14 @@ components:
|
|
|
15110
15130
|
minLength: 1
|
|
15111
15131
|
title: Auth Subdomain
|
|
15112
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
|
|
15113
15141
|
dashboard_subdomain:
|
|
15114
15142
|
anyOf:
|
|
15115
15143
|
- maxLength: 255
|
|
@@ -15237,6 +15265,14 @@ components:
|
|
|
15237
15265
|
minLength: 1
|
|
15238
15266
|
title: Auth Subdomain
|
|
15239
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
|
|
15240
15276
|
dashboard_subdomain:
|
|
15241
15277
|
anyOf:
|
|
15242
15278
|
- maxLength: 255
|
|
@@ -15700,7 +15736,7 @@ info:
|
|
|
15700
15736
|
\n\n"
|
|
15701
15737
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
15702
15738
|
title: OpusDNS API
|
|
15703
|
-
version: 2026-08-25-
|
|
15739
|
+
version: 2026-08-25-080032
|
|
15704
15740
|
x-logo:
|
|
15705
15741
|
altText: OpusDNS API Reference
|
|
15706
15742
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
package/src/schema.d.ts
CHANGED
|
@@ -6839,6 +6839,13 @@ export interface components {
|
|
|
6839
6839
|
by_status: {
|
|
6840
6840
|
[key: string]: number;
|
|
6841
6841
|
};
|
|
6842
|
+
/**
|
|
6843
|
+
* By Status Tag
|
|
6844
|
+
* @description Domain counts by status tag (status_tag: count), only status tags with at least one domain
|
|
6845
|
+
*/
|
|
6846
|
+
by_status_tag: {
|
|
6847
|
+
[key: string]: number;
|
|
6848
|
+
};
|
|
6842
6849
|
/**
|
|
6843
6850
|
* By Tld
|
|
6844
6851
|
* @description Domain counts by TLD (tld: count)
|
|
@@ -12783,6 +12790,11 @@ export interface components {
|
|
|
12783
12790
|
* @description Subdomain the login is served on; required together with hostname
|
|
12784
12791
|
*/
|
|
12785
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;
|
|
12786
12798
|
/**
|
|
12787
12799
|
* Dashboard Subdomain
|
|
12788
12800
|
* @description Subdomain the dashboard is served on; omit for apex. Only together with hostname.
|
|
@@ -12885,7 +12897,7 @@ export interface components {
|
|
|
12885
12897
|
* detail that accompanies it is for support/debugging, never for customer display.
|
|
12886
12898
|
* @enum {string}
|
|
12887
12899
|
*/
|
|
12888
|
-
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";
|
|
12889
12901
|
/**
|
|
12890
12902
|
* WhitelabelOnboardingFailureType
|
|
12891
12903
|
* @enum {string}
|
|
@@ -12907,6 +12919,12 @@ export interface components {
|
|
|
12907
12919
|
* @description Subdomain the login is served on (e.g. auth -> auth.customer.com)
|
|
12908
12920
|
*/
|
|
12909
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;
|
|
12910
12928
|
/**
|
|
12911
12929
|
* Dashboard Subdomain
|
|
12912
12930
|
* @description Subdomain the dashboard is served on (e.g. dash -> dash.customer.com); omit for apex
|
|
@@ -12982,6 +13000,12 @@ export interface components {
|
|
|
12982
13000
|
* @description Subdomain the login is served on (e.g. auth -> auth.customer.com)
|
|
12983
13001
|
*/
|
|
12984
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;
|
|
12985
13009
|
/**
|
|
12986
13010
|
* Dashboard Subdomain
|
|
12987
13011
|
* @description Subdomain the dashboard is served on (e.g. dash -> dash.customer.com); omit for apex
|