@opusdns/api 1.156.0 → 1.157.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/keys.ts +4 -0
- package/src/openapi.yaml +39 -19
- package/src/schema.d.ts +20 -10
package/package.json
CHANGED
package/src/helpers/keys.ts
CHANGED
|
@@ -5990,6 +5990,8 @@ export const KEYS_WHITELABEL_BRANDING_RECHECK = [
|
|
|
5990
5990
|
] as const satisfies (keyof WhitelabelBrandingRecheck)[];
|
|
5991
5991
|
|
|
5992
5992
|
export const KEY_WHITELABEL_BRANDING_AUTH_HOSTNAME = 'auth_hostname' satisfies keyof WhitelabelBranding;
|
|
5993
|
+
export const KEY_WHITELABEL_BRANDING_BASE_AUTH_HOSTNAME = 'base_auth_hostname' satisfies keyof WhitelabelBranding;
|
|
5994
|
+
export const KEY_WHITELABEL_BRANDING_BASE_HOSTNAME = 'base_hostname' satisfies keyof WhitelabelBranding;
|
|
5993
5995
|
export const KEY_WHITELABEL_BRANDING_BASE_LABEL = 'base_label' satisfies keyof WhitelabelBranding;
|
|
5994
5996
|
export const KEY_WHITELABEL_BRANDING_CREATED_ON = 'created_on' satisfies keyof WhitelabelBranding;
|
|
5995
5997
|
export const KEY_WHITELABEL_BRANDING_ENABLED = 'enabled' satisfies keyof WhitelabelBranding;
|
|
@@ -6008,6 +6010,8 @@ export const KEY_WHITELABEL_BRANDING_WHITELABEL_BRANDING_ID = 'whitelabel_brandi
|
|
|
6008
6010
|
|
|
6009
6011
|
export const KEYS_WHITELABEL_BRANDING = [
|
|
6010
6012
|
KEY_WHITELABEL_BRANDING_AUTH_HOSTNAME,
|
|
6013
|
+
KEY_WHITELABEL_BRANDING_BASE_AUTH_HOSTNAME,
|
|
6014
|
+
KEY_WHITELABEL_BRANDING_BASE_HOSTNAME,
|
|
6011
6015
|
KEY_WHITELABEL_BRANDING_BASE_LABEL,
|
|
6012
6016
|
KEY_WHITELABEL_BRANDING_CREATED_ON,
|
|
6013
6017
|
KEY_WHITELABEL_BRANDING_ENABLED,
|
package/src/openapi.yaml
CHANGED
|
@@ -15239,20 +15239,20 @@ components:
|
|
|
15239
15239
|
title: WhitelabelBaseCreate
|
|
15240
15240
|
type: object
|
|
15241
15241
|
WhitelabelBrandingPatch:
|
|
15242
|
-
description: 'Public patch body. `label` moves the base subdomain to
|
|
15243
|
-
label (
|
|
15242
|
+
description: 'Public patch body. `label` moves the managed base subdomain to
|
|
15243
|
+
a different label (on plus the
|
|
15244
15244
|
|
|
15245
|
-
|
|
15246
|
-
|
|
15245
|
+
custom domain is untouched - it is re-pointed by its hostnames through recheck)
|
|
15246
|
+
and `enabled`
|
|
15247
15247
|
|
|
15248
|
-
serving
|
|
15249
|
-
purchase.
|
|
15248
|
+
starts or stops serving - both applied asynchronously via the reconcile job,
|
|
15249
|
+
neither a purchase.
|
|
15250
15250
|
|
|
15251
|
-
sets the subscription''s auto-renew intent synchronously (EXPIRE
|
|
15252
|
-
at period
|
|
15251
|
+
`renewal_mode` sets the subscription''s auto-renew intent synchronously (EXPIRE
|
|
15252
|
+
= cancel at period
|
|
15253
15253
|
|
|
15254
|
-
un-cancel); it is not a purchase either - no price change. At
|
|
15255
|
-
be given.'
|
|
15254
|
+
end, RENEW = un-cancel); it is not a purchase either - no price change. At
|
|
15255
|
+
least one must be given.'
|
|
15256
15256
|
properties:
|
|
15257
15257
|
enabled:
|
|
15258
15258
|
anyOf:
|
|
@@ -15266,8 +15266,8 @@ components:
|
|
|
15266
15266
|
minLength: 1
|
|
15267
15267
|
type: string
|
|
15268
15268
|
- type: 'null'
|
|
15269
|
-
description: New
|
|
15270
|
-
/ auth.<label>.<suffix>.
|
|
15269
|
+
description: New managed-subdomain label; the base hosts become app.<label>.<suffix>
|
|
15270
|
+
/ auth.<label>.<suffix>. On plus the custom domain keeps serving unchanged.
|
|
15271
15271
|
title: Label
|
|
15272
15272
|
renewal_mode:
|
|
15273
15273
|
anyOf:
|
|
@@ -15336,9 +15336,28 @@ components:
|
|
|
15336
15336
|
minLength: 1
|
|
15337
15337
|
title: Auth Hostname
|
|
15338
15338
|
type: string
|
|
15339
|
+
base_auth_hostname:
|
|
15340
|
+
anyOf:
|
|
15341
|
+
- maxLength: 255
|
|
15342
|
+
minLength: 1
|
|
15343
|
+
type: string
|
|
15344
|
+
- type: 'null'
|
|
15345
|
+
description: Managed base auth host (auth.<base_label>.<suffix>); null until
|
|
15346
|
+
first published
|
|
15347
|
+
title: Base Auth Hostname
|
|
15348
|
+
base_hostname:
|
|
15349
|
+
anyOf:
|
|
15350
|
+
- maxLength: 255
|
|
15351
|
+
minLength: 1
|
|
15352
|
+
type: string
|
|
15353
|
+
- type: 'null'
|
|
15354
|
+
description: Managed base dashboard host (app.<base_label>.<suffix>); on
|
|
15355
|
+
plus a backup address served alongside the custom domain, null until first
|
|
15356
|
+
published
|
|
15357
|
+
title: Base Hostname
|
|
15339
15358
|
base_label:
|
|
15340
|
-
description: Managed-subdomain label;
|
|
15341
|
-
on plus
|
|
15359
|
+
description: Managed-subdomain label; the composed pair is the served pair
|
|
15360
|
+
on base, the backup pair on plus
|
|
15342
15361
|
maxLength: 255
|
|
15343
15362
|
minLength: 1
|
|
15344
15363
|
title: Base Label
|
|
@@ -15498,10 +15517,10 @@ components:
|
|
|
15498
15517
|
type: string
|
|
15499
15518
|
WhitelabelPlusCreate:
|
|
15500
15519
|
additionalProperties: false
|
|
15501
|
-
description: 'Create the plus tier: served on the customer''s own domain
|
|
15502
|
-
|
|
15520
|
+
description: 'Create the plus tier: served on the customer''s own domain, with
|
|
15521
|
+
the managed base subdomain
|
|
15503
15522
|
|
|
15504
|
-
|
|
15523
|
+
composed from `label` served alongside it as a backup address.'
|
|
15505
15524
|
properties:
|
|
15506
15525
|
auth_subdomain:
|
|
15507
15526
|
description: Subdomain the login is served on (e.g. auth -> auth.customer.com)
|
|
@@ -15534,7 +15553,8 @@ components:
|
|
|
15534
15553
|
title: Hostname
|
|
15535
15554
|
type: string
|
|
15536
15555
|
label:
|
|
15537
|
-
description: Managed-subdomain label
|
|
15556
|
+
description: Managed-subdomain label; the composed pair is served alongside
|
|
15557
|
+
the custom domain as a backup
|
|
15538
15558
|
maxLength: 63
|
|
15539
15559
|
minLength: 1
|
|
15540
15560
|
title: Label
|
|
@@ -16176,7 +16196,7 @@ info:
|
|
|
16176
16196
|
\n\n"
|
|
16177
16197
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
16178
16198
|
title: OpusDNS API
|
|
16179
|
-
version: 2026-09-07-
|
|
16199
|
+
version: 2026-09-07-115957
|
|
16180
16200
|
x-logo:
|
|
16181
16201
|
altText: OpusDNS API Reference
|
|
16182
16202
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
package/src/schema.d.ts
CHANGED
|
@@ -13224,11 +13224,11 @@ export interface components {
|
|
|
13224
13224
|
};
|
|
13225
13225
|
/**
|
|
13226
13226
|
* WhitelabelBrandingPatch
|
|
13227
|
-
* @description Public patch body. `label` moves the base subdomain to a different label (
|
|
13228
|
-
*
|
|
13229
|
-
* serving
|
|
13230
|
-
* sets the subscription's auto-renew intent synchronously (EXPIRE = cancel at period
|
|
13231
|
-
* un-cancel); it is not a purchase either - no price change. At least one must be given.
|
|
13227
|
+
* @description Public patch body. `label` moves the managed base subdomain to a different label (on plus the
|
|
13228
|
+
* custom domain is untouched - it is re-pointed by its hostnames through recheck) and `enabled`
|
|
13229
|
+
* starts or stops serving - both applied asynchronously via the reconcile job, neither a purchase.
|
|
13230
|
+
* `renewal_mode` sets the subscription's auto-renew intent synchronously (EXPIRE = cancel at period
|
|
13231
|
+
* end, RENEW = un-cancel); it is not a purchase either - no price change. At least one must be given.
|
|
13232
13232
|
*/
|
|
13233
13233
|
WhitelabelBrandingPatch: {
|
|
13234
13234
|
/**
|
|
@@ -13238,7 +13238,7 @@ export interface components {
|
|
|
13238
13238
|
enabled?: boolean | null;
|
|
13239
13239
|
/**
|
|
13240
13240
|
* Label
|
|
13241
|
-
* @description New
|
|
13241
|
+
* @description New managed-subdomain label; the base hosts become app.<label>.<suffix> / auth.<label>.<suffix>. On plus the custom domain keeps serving unchanged.
|
|
13242
13242
|
*/
|
|
13243
13243
|
label?: string | null;
|
|
13244
13244
|
/** @description Set auto-renew intent: expire cancels at period end (serves out the term), renew un-cancels */
|
|
@@ -13283,9 +13283,19 @@ export interface components {
|
|
|
13283
13283
|
* @description Auth/login hostname served by the authentication system (e.g. auth.customer.com)
|
|
13284
13284
|
*/
|
|
13285
13285
|
auth_hostname: string;
|
|
13286
|
+
/**
|
|
13287
|
+
* Base Auth Hostname
|
|
13288
|
+
* @description Managed base auth host (auth.<base_label>.<suffix>); null until first published
|
|
13289
|
+
*/
|
|
13290
|
+
base_auth_hostname?: string | null;
|
|
13291
|
+
/**
|
|
13292
|
+
* Base Hostname
|
|
13293
|
+
* @description Managed base dashboard host (app.<base_label>.<suffix>); on plus a backup address served alongside the custom domain, null until first published
|
|
13294
|
+
*/
|
|
13295
|
+
base_hostname?: string | null;
|
|
13286
13296
|
/**
|
|
13287
13297
|
* Base Label
|
|
13288
|
-
* @description Managed-subdomain label; served on the
|
|
13298
|
+
* @description Managed-subdomain label; the composed pair is the served pair on base, the backup pair on plus
|
|
13289
13299
|
*/
|
|
13290
13300
|
base_label: string;
|
|
13291
13301
|
/**
|
|
@@ -13377,8 +13387,8 @@ export interface components {
|
|
|
13377
13387
|
WhitelabelOnboardingStatus: "pending_domain_verification" | "verifying" | "provisioning" | "active" | "failed" | "terminated";
|
|
13378
13388
|
/**
|
|
13379
13389
|
* WhitelabelPlusCreate
|
|
13380
|
-
* @description Create the plus tier: served on the customer's own domain
|
|
13381
|
-
*
|
|
13390
|
+
* @description Create the plus tier: served on the customer's own domain, with the managed base subdomain
|
|
13391
|
+
* composed from `label` served alongside it as a backup address.
|
|
13382
13392
|
*/
|
|
13383
13393
|
WhitelabelPlusCreate: {
|
|
13384
13394
|
/**
|
|
@@ -13404,7 +13414,7 @@ export interface components {
|
|
|
13404
13414
|
hostname: string;
|
|
13405
13415
|
/**
|
|
13406
13416
|
* Label
|
|
13407
|
-
* @description Managed-subdomain label
|
|
13417
|
+
* @description Managed-subdomain label; the composed pair is served alongside the custom domain as a backup
|
|
13408
13418
|
*/
|
|
13409
13419
|
label: string;
|
|
13410
13420
|
/** @description Billing period; offered: 1 month or 1 year */
|