@opusdns/api 1.74.0 → 1.75.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 +11 -0
- package/src/helpers/keys.ts +8 -0
- package/src/helpers/schemas.d.ts +1 -0
- package/src/openapi.yaml +41 -1
- package/src/schema.d.ts +25 -0
package/package.json
CHANGED
package/src/helpers/constants.ts
CHANGED
|
@@ -87,6 +87,7 @@ import type {
|
|
|
87
87
|
RegistrantChangeType,
|
|
88
88
|
RegistryHandleAttributeType,
|
|
89
89
|
RenewalMode,
|
|
90
|
+
RenewalModeDTO,
|
|
90
91
|
ReportStatus,
|
|
91
92
|
ReportTriggerType,
|
|
92
93
|
ReportType,
|
|
@@ -1628,6 +1629,16 @@ export const RENEWAL_MODE_VALUES = [
|
|
|
1628
1629
|
'expire',
|
|
1629
1630
|
] as const satisfies ReadonlyArray<RenewalMode>;
|
|
1630
1631
|
|
|
1632
|
+
export const RENEWAL_MODE_DTO = {
|
|
1633
|
+
RENEW: "renew",
|
|
1634
|
+
EXPIRE: "expire",
|
|
1635
|
+
} as const satisfies Record<string, RenewalModeDTO>;
|
|
1636
|
+
|
|
1637
|
+
export const RENEWAL_MODE_DTO_VALUES = [
|
|
1638
|
+
'renew',
|
|
1639
|
+
'expire',
|
|
1640
|
+
] as const satisfies ReadonlyArray<RenewalModeDTO>;
|
|
1641
|
+
|
|
1631
1642
|
export const REPORT_STATUS = {
|
|
1632
1643
|
PENDING: "pending",
|
|
1633
1644
|
GENERATING: "generating",
|
package/src/helpers/keys.ts
CHANGED
|
@@ -5600,21 +5600,29 @@ export const KEYS_VANITY_NAMESERVER_SET_DTO = [
|
|
|
5600
5600
|
KEY_VANITY_NAMESERVER_SET_DTO_SOA_RNAME,
|
|
5601
5601
|
] as const satisfies (keyof VanityNameserverSetDTO)[];
|
|
5602
5602
|
|
|
5603
|
+
export const KEY_VANITY_NAMESERVER_SET_SUMMARY_DTO_EXPIRES_ON = 'expires_on' satisfies keyof VanityNameserverSetSummaryDTO;
|
|
5604
|
+
export const KEY_VANITY_NAMESERVER_SET_SUMMARY_DTO_GRACE_PERIOD_ENDS_AT = 'grace_period_ends_at' satisfies keyof VanityNameserverSetSummaryDTO;
|
|
5603
5605
|
export const KEY_VANITY_NAMESERVER_SET_SUMMARY_DTO_IS_DEFAULT = 'is_default' satisfies keyof VanityNameserverSetSummaryDTO;
|
|
5604
5606
|
export const KEY_VANITY_NAMESERVER_SET_SUMMARY_DTO_NAME = 'name' satisfies keyof VanityNameserverSetSummaryDTO;
|
|
5605
5607
|
export const KEY_VANITY_NAMESERVER_SET_SUMMARY_DTO_NAMESERVERS = 'nameservers' satisfies keyof VanityNameserverSetSummaryDTO;
|
|
5606
5608
|
export const KEY_VANITY_NAMESERVER_SET_SUMMARY_DTO_ORGANIZATION_ID = 'organization_id' satisfies keyof VanityNameserverSetSummaryDTO;
|
|
5607
5609
|
export const KEY_VANITY_NAMESERVER_SET_SUMMARY_DTO_PARENT_DOMAIN_NAME = 'parent_domain_name' satisfies keyof VanityNameserverSetSummaryDTO;
|
|
5610
|
+
export const KEY_VANITY_NAMESERVER_SET_SUMMARY_DTO_RENEW_SCHEDULED_AT = 'renew_scheduled_at' satisfies keyof VanityNameserverSetSummaryDTO;
|
|
5611
|
+
export const KEY_VANITY_NAMESERVER_SET_SUMMARY_DTO_RENEWAL_MODE = 'renewal_mode' satisfies keyof VanityNameserverSetSummaryDTO;
|
|
5608
5612
|
export const KEY_VANITY_NAMESERVER_SET_SUMMARY_DTO_SET_ID = 'set_id' satisfies keyof VanityNameserverSetSummaryDTO;
|
|
5609
5613
|
export const KEY_VANITY_NAMESERVER_SET_SUMMARY_DTO_SOA_RNAME = 'soa_rname' satisfies keyof VanityNameserverSetSummaryDTO;
|
|
5610
5614
|
export const KEY_VANITY_NAMESERVER_SET_SUMMARY_DTO_STATUS = 'status' satisfies keyof VanityNameserverSetSummaryDTO;
|
|
5611
5615
|
|
|
5612
5616
|
export const KEYS_VANITY_NAMESERVER_SET_SUMMARY_DTO = [
|
|
5617
|
+
KEY_VANITY_NAMESERVER_SET_SUMMARY_DTO_EXPIRES_ON,
|
|
5618
|
+
KEY_VANITY_NAMESERVER_SET_SUMMARY_DTO_GRACE_PERIOD_ENDS_AT,
|
|
5613
5619
|
KEY_VANITY_NAMESERVER_SET_SUMMARY_DTO_IS_DEFAULT,
|
|
5614
5620
|
KEY_VANITY_NAMESERVER_SET_SUMMARY_DTO_NAME,
|
|
5615
5621
|
KEY_VANITY_NAMESERVER_SET_SUMMARY_DTO_NAMESERVERS,
|
|
5616
5622
|
KEY_VANITY_NAMESERVER_SET_SUMMARY_DTO_ORGANIZATION_ID,
|
|
5617
5623
|
KEY_VANITY_NAMESERVER_SET_SUMMARY_DTO_PARENT_DOMAIN_NAME,
|
|
5624
|
+
KEY_VANITY_NAMESERVER_SET_SUMMARY_DTO_RENEW_SCHEDULED_AT,
|
|
5625
|
+
KEY_VANITY_NAMESERVER_SET_SUMMARY_DTO_RENEWAL_MODE,
|
|
5618
5626
|
KEY_VANITY_NAMESERVER_SET_SUMMARY_DTO_SET_ID,
|
|
5619
5627
|
KEY_VANITY_NAMESERVER_SET_SUMMARY_DTO_SOA_RNAME,
|
|
5620
5628
|
KEY_VANITY_NAMESERVER_SET_SUMMARY_DTO_STATUS,
|
package/src/helpers/schemas.d.ts
CHANGED
|
@@ -476,6 +476,7 @@ export type RegistrarZone = components['schemas']['RegistrarZone'];
|
|
|
476
476
|
export type RegistryHandleAttributeType = components['schemas']['RegistryHandleAttributeType'];
|
|
477
477
|
export type RegistryLockBase = components['schemas']['RegistryLockBase'];
|
|
478
478
|
export type RenewalMode = components['schemas']['RenewalMode'];
|
|
479
|
+
export type RenewalModeDTO = components['schemas']['RenewalModeDTO'];
|
|
479
480
|
export type ReportStatus = components['schemas']['ReportStatus'];
|
|
480
481
|
export type ReportTriggerType = components['schemas']['ReportTriggerType'];
|
|
481
482
|
export type ReportType = components['schemas']['ReportType'];
|
package/src/openapi.yaml
CHANGED
|
@@ -12063,6 +12063,16 @@ components:
|
|
|
12063
12063
|
- expire
|
|
12064
12064
|
title: RenewalMode
|
|
12065
12065
|
type: string
|
|
12066
|
+
RenewalModeDTO:
|
|
12067
|
+
description: "Wire mirror of the domain `RenewalMode` vocabulary \u2014 local\
|
|
12068
|
+
\ so dns_client doesn't\npull schema imports. The subscription itself has\
|
|
12069
|
+
\ no renewal_mode column; api-nameserver\nderives this from whether a renewal\
|
|
12070
|
+
\ is scheduled."
|
|
12071
|
+
enum:
|
|
12072
|
+
- renew
|
|
12073
|
+
- expire
|
|
12074
|
+
title: RenewalModeDTO
|
|
12075
|
+
type: string
|
|
12066
12076
|
ReportStatus:
|
|
12067
12077
|
enum:
|
|
12068
12078
|
- pending
|
|
@@ -13932,6 +13942,22 @@ components:
|
|
|
13932
13942
|
|
|
13933
13943
|
`VanityNameserverSetDTO` stays the brandable-only read shape (always ACTIVE).'
|
|
13934
13944
|
properties:
|
|
13945
|
+
expires_on:
|
|
13946
|
+
anyOf:
|
|
13947
|
+
- format: date-time
|
|
13948
|
+
type: string
|
|
13949
|
+
- type: 'null'
|
|
13950
|
+
description: When the vanity nameserver set's current service period ends
|
|
13951
|
+
(renews or lapses)
|
|
13952
|
+
title: Expires On
|
|
13953
|
+
grace_period_ends_at:
|
|
13954
|
+
anyOf:
|
|
13955
|
+
- format: date-time
|
|
13956
|
+
type: string
|
|
13957
|
+
- type: 'null'
|
|
13958
|
+
description: When the grace period ends, or null when the set is not in
|
|
13959
|
+
a grace period
|
|
13960
|
+
title: Grace Period Ends At
|
|
13935
13961
|
is_default:
|
|
13936
13962
|
description: Whether this is the org's default vanity NS set
|
|
13937
13963
|
title: Is Default
|
|
@@ -13959,6 +13985,20 @@ components:
|
|
|
13959
13985
|
description: Parent domain used as the apex of the vanity NS zone
|
|
13960
13986
|
title: Parent Domain Name
|
|
13961
13987
|
type: string
|
|
13988
|
+
renew_scheduled_at:
|
|
13989
|
+
anyOf:
|
|
13990
|
+
- format: date-time
|
|
13991
|
+
type: string
|
|
13992
|
+
- type: 'null'
|
|
13993
|
+
description: When the next automatic renewal is scheduled. Null when the
|
|
13994
|
+
set will not renew.
|
|
13995
|
+
title: Renew Scheduled At
|
|
13996
|
+
renewal_mode:
|
|
13997
|
+
anyOf:
|
|
13998
|
+
- $ref: '#/components/schemas/RenewalModeDTO'
|
|
13999
|
+
- type: 'null'
|
|
14000
|
+
description: Whether the set is set to renew or expire at the end of the
|
|
14001
|
+
current period
|
|
13962
14002
|
set_id:
|
|
13963
14003
|
description: Stable identifier for the vanity NS set
|
|
13964
14004
|
examples:
|
|
@@ -14655,7 +14695,7 @@ info:
|
|
|
14655
14695
|
\n\n"
|
|
14656
14696
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
14657
14697
|
title: OpusDNS API
|
|
14658
|
-
version: 2026-07-22-
|
|
14698
|
+
version: 2026-07-22-211713
|
|
14659
14699
|
x-logo:
|
|
14660
14700
|
altText: OpusDNS API Reference
|
|
14661
14701
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
package/src/schema.d.ts
CHANGED
|
@@ -10722,6 +10722,14 @@ export interface components {
|
|
|
10722
10722
|
* @enum {string}
|
|
10723
10723
|
*/
|
|
10724
10724
|
RenewalMode: "renew" | "expire";
|
|
10725
|
+
/**
|
|
10726
|
+
* RenewalModeDTO
|
|
10727
|
+
* @description Wire mirror of the domain `RenewalMode` vocabulary — local so dns_client doesn't
|
|
10728
|
+
* pull schema imports. The subscription itself has no renewal_mode column; api-nameserver
|
|
10729
|
+
* derives this from whether a renewal is scheduled.
|
|
10730
|
+
* @enum {string}
|
|
10731
|
+
*/
|
|
10732
|
+
RenewalModeDTO: "renew" | "expire";
|
|
10725
10733
|
/**
|
|
10726
10734
|
* ReportStatus
|
|
10727
10735
|
* @enum {string}
|
|
@@ -12048,6 +12056,16 @@ export interface components {
|
|
|
12048
12056
|
* `VanityNameserverSetDTO` stays the brandable-only read shape (always ACTIVE).
|
|
12049
12057
|
*/
|
|
12050
12058
|
VanityNameserverSetSummaryDTO: {
|
|
12059
|
+
/**
|
|
12060
|
+
* Expires On
|
|
12061
|
+
* @description When the vanity nameserver set's current service period ends (renews or lapses)
|
|
12062
|
+
*/
|
|
12063
|
+
expires_on?: Date | null;
|
|
12064
|
+
/**
|
|
12065
|
+
* Grace Period Ends At
|
|
12066
|
+
* @description When the grace period ends, or null when the set is not in a grace period
|
|
12067
|
+
*/
|
|
12068
|
+
grace_period_ends_at?: Date | null;
|
|
12051
12069
|
/**
|
|
12052
12070
|
* Is Default
|
|
12053
12071
|
* @description Whether this is the org's default vanity NS set
|
|
@@ -12075,6 +12093,13 @@ export interface components {
|
|
|
12075
12093
|
* @description Parent domain used as the apex of the vanity NS zone
|
|
12076
12094
|
*/
|
|
12077
12095
|
parent_domain_name: string;
|
|
12096
|
+
/**
|
|
12097
|
+
* Renew Scheduled At
|
|
12098
|
+
* @description When the next automatic renewal is scheduled. Null when the set will not renew.
|
|
12099
|
+
*/
|
|
12100
|
+
renew_scheduled_at?: Date | null;
|
|
12101
|
+
/** @description Whether the set is set to renew or expire at the end of the current period */
|
|
12102
|
+
renewal_mode?: components["schemas"]["RenewalModeDTO"] | null;
|
|
12078
12103
|
/**
|
|
12079
12104
|
* Set Id
|
|
12080
12105
|
* Format: typeid
|