@opusdns/api 0.22.0 → 0.24.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 +9 -1
- package/src/helpers/keys.ts +29 -3
- package/src/openapi.yaml +19 -22
- package/src/schema.d.ts +10 -9
package/package.json
CHANGED
package/src/helpers/constants.ts
CHANGED
|
@@ -890,6 +890,10 @@ export const DOMAIN_STATUS = {
|
|
|
890
890
|
CLIENT_DELETE_PROHIBITED: "clientDeleteProhibited",
|
|
891
891
|
CLIENT_RENEW_PROHIBITED: "clientRenewProhibited",
|
|
892
892
|
CLIENT_HOLD: "clientHold",
|
|
893
|
+
FREE: "free",
|
|
894
|
+
CONNECT: "connect",
|
|
895
|
+
FAILED: "failed",
|
|
896
|
+
INVALID: "invalid",
|
|
893
897
|
} as const satisfies Record<string, DomainStatus>;
|
|
894
898
|
|
|
895
899
|
/**
|
|
@@ -938,7 +942,11 @@ export const DOMAIN_STATUS_VALUES = [
|
|
|
938
942
|
'clientUpdateProhibited',
|
|
939
943
|
'clientDeleteProhibited',
|
|
940
944
|
'clientRenewProhibited',
|
|
941
|
-
'clientHold'
|
|
945
|
+
'clientHold',
|
|
946
|
+
'free',
|
|
947
|
+
'connect',
|
|
948
|
+
'failed',
|
|
949
|
+
'invalid'
|
|
942
950
|
] as const satisfies [string, ...string[]] | DomainStatus[];
|
|
943
951
|
|
|
944
952
|
/**
|
package/src/helpers/keys.ts
CHANGED
|
@@ -7305,11 +7305,10 @@ export const KEYS_DOMAIN_SUMMARY = [
|
|
|
7305
7305
|
*/
|
|
7306
7306
|
export const KEY_DOMAIN_TRANSFER_IN_AUTH_CODE = 'auth_code' as keyof DomainTransferIn;
|
|
7307
7307
|
/**
|
|
7308
|
-
*
|
|
7308
|
+
* contacts property
|
|
7309
7309
|
*
|
|
7310
7310
|
* The contacts of the domain
|
|
7311
7311
|
*
|
|
7312
|
-
* @type {object}
|
|
7313
7312
|
*
|
|
7314
7313
|
*
|
|
7315
7314
|
* @remarks
|
|
@@ -7333,7 +7332,7 @@ export const KEY_DOMAIN_TRANSFER_IN_CONTACTS = 'contacts' as keyof DomainTransfe
|
|
|
7333
7332
|
/**
|
|
7334
7333
|
* Name
|
|
7335
7334
|
*
|
|
7336
|
-
* The domain
|
|
7335
|
+
* The domain to be created
|
|
7337
7336
|
*
|
|
7338
7337
|
* @type {string}
|
|
7339
7338
|
*
|
|
@@ -7356,9 +7355,35 @@ export const KEY_DOMAIN_TRANSFER_IN_CONTACTS = 'contacts' as keyof DomainTransfe
|
|
|
7356
7355
|
* @see {@link KEYS_DOMAIN_TRANSFER_IN} - Array of all keys for this type
|
|
7357
7356
|
*/
|
|
7358
7357
|
export const KEY_DOMAIN_TRANSFER_IN_NAME = 'name' as keyof DomainTransferIn;
|
|
7358
|
+
/**
|
|
7359
|
+
* Nameservers
|
|
7360
|
+
*
|
|
7361
|
+
* The name servers for the domain
|
|
7362
|
+
*
|
|
7363
|
+
*
|
|
7364
|
+
*
|
|
7365
|
+
* @remarks
|
|
7366
|
+
* This key constant provides type-safe access to the `nameservers` property of DomainTransferIn objects.
|
|
7367
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
7368
|
+
*
|
|
7369
|
+
* @example
|
|
7370
|
+
* ```typescript
|
|
7371
|
+
* // Direct property access
|
|
7372
|
+
* const value = domaintransferin[KEY_DOMAIN_TRANSFER_IN_NAMESERVERS];
|
|
7373
|
+
*
|
|
7374
|
+
* // Dynamic property access
|
|
7375
|
+
* const propertyName = KEY_DOMAIN_TRANSFER_IN_NAMESERVERS;
|
|
7376
|
+
* const value = domaintransferin[propertyName];
|
|
7377
|
+
* ```
|
|
7378
|
+
*
|
|
7379
|
+
* @see {@link DomainTransferIn} - The TypeScript type definition
|
|
7380
|
+
* @see {@link KEYS_DOMAIN_TRANSFER_IN} - Array of all keys for this type
|
|
7381
|
+
*/
|
|
7382
|
+
export const KEY_DOMAIN_TRANSFER_IN_NAMESERVERS = 'nameservers' as keyof DomainTransferIn;
|
|
7359
7383
|
/**
|
|
7360
7384
|
* renewal_mode property
|
|
7361
7385
|
*
|
|
7386
|
+
* The renewal mode of the domain
|
|
7362
7387
|
*
|
|
7363
7388
|
*
|
|
7364
7389
|
*
|
|
@@ -7405,6 +7430,7 @@ export const KEYS_DOMAIN_TRANSFER_IN = [
|
|
|
7405
7430
|
KEY_DOMAIN_TRANSFER_IN_AUTH_CODE,
|
|
7406
7431
|
KEY_DOMAIN_TRANSFER_IN_CONTACTS,
|
|
7407
7432
|
KEY_DOMAIN_TRANSFER_IN_NAME,
|
|
7433
|
+
KEY_DOMAIN_TRANSFER_IN_NAMESERVERS,
|
|
7408
7434
|
KEY_DOMAIN_TRANSFER_IN_RENEWAL_MODE,
|
|
7409
7435
|
] as const satisfies (keyof DomainTransferIn)[];
|
|
7410
7436
|
|
package/src/openapi.yaml
CHANGED
|
@@ -1159,9 +1159,9 @@ components:
|
|
|
1159
1159
|
description: The renewal mode of the domain
|
|
1160
1160
|
required:
|
|
1161
1161
|
- name
|
|
1162
|
-
- period
|
|
1163
1162
|
- contacts
|
|
1164
1163
|
- renewal_mode
|
|
1164
|
+
- period
|
|
1165
1165
|
title: DomainCreate
|
|
1166
1166
|
type: object
|
|
1167
1167
|
DomainDnssecDataCreate:
|
|
@@ -1697,6 +1697,10 @@ components:
|
|
|
1697
1697
|
- clientDeleteProhibited
|
|
1698
1698
|
- clientRenewProhibited
|
|
1699
1699
|
- clientHold
|
|
1700
|
+
- free
|
|
1701
|
+
- connect
|
|
1702
|
+
- failed
|
|
1703
|
+
- invalid
|
|
1700
1704
|
title: DomainStatus
|
|
1701
1705
|
type: string
|
|
1702
1706
|
DomainStatusesBase:
|
|
@@ -1772,35 +1776,28 @@ components:
|
|
|
1772
1776
|
title: Auth Code
|
|
1773
1777
|
type: string
|
|
1774
1778
|
contacts:
|
|
1775
|
-
|
|
1776
|
-
examples:
|
|
1777
|
-
- contact_01h45ytscbebyvny4gc8cr8ma2
|
|
1778
|
-
format: typeid
|
|
1779
|
-
pattern: ^contact_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
1780
|
-
type: string
|
|
1781
|
-
x-typeid-prefix: contact
|
|
1779
|
+
$ref: '#/components/schemas/ContactIdList'
|
|
1782
1780
|
description: The contacts of the domain
|
|
1783
|
-
examples:
|
|
1784
|
-
- admin: contact_01h45ytscbebyvny4gc8cr8ma2
|
|
1785
|
-
billing: contact_01h45ytscbebyvny4gc8cr8ma2
|
|
1786
|
-
registrant: contact_01h45ytscbebyvny4gc8cr8ma2
|
|
1787
|
-
tech: contact_01h45ytscbebyvny4gc8cr8ma2
|
|
1788
|
-
propertyNames:
|
|
1789
|
-
$ref: '#/components/schemas/DomainContactType'
|
|
1790
|
-
title: Contacts
|
|
1791
|
-
type: object
|
|
1792
1781
|
name:
|
|
1793
|
-
description: The domain
|
|
1794
|
-
examples:
|
|
1795
|
-
- example.com
|
|
1782
|
+
description: The domain to be created
|
|
1796
1783
|
title: Name
|
|
1797
1784
|
type: string
|
|
1785
|
+
nameservers:
|
|
1786
|
+
anyOf:
|
|
1787
|
+
- items:
|
|
1788
|
+
$ref: '#/components/schemas/Nameserver'
|
|
1789
|
+
type: array
|
|
1790
|
+
- type: 'null'
|
|
1791
|
+
description: The name servers for the domain
|
|
1792
|
+
title: Nameservers
|
|
1798
1793
|
renewal_mode:
|
|
1799
1794
|
$ref: '#/components/schemas/RenewalMode'
|
|
1795
|
+
description: The renewal mode of the domain
|
|
1800
1796
|
required:
|
|
1801
1797
|
- name
|
|
1802
|
-
-
|
|
1798
|
+
- contacts
|
|
1803
1799
|
- renewal_mode
|
|
1800
|
+
- auth_code
|
|
1804
1801
|
title: DomainTransferIn
|
|
1805
1802
|
type: object
|
|
1806
1803
|
DomainUpdate:
|
|
@@ -4788,7 +4785,7 @@ info:
|
|
|
4788
4785
|
'
|
|
4789
4786
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
4790
4787
|
title: OpusDNS API
|
|
4791
|
-
version: 2025-08-
|
|
4788
|
+
version: 2025-08-26-091019
|
|
4792
4789
|
x-logo:
|
|
4793
4790
|
altText: OpusDNS API Reference
|
|
4794
4791
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
package/src/schema.d.ts
CHANGED
|
@@ -2171,7 +2171,7 @@ export interface components {
|
|
|
2171
2171
|
* DomainStatus
|
|
2172
2172
|
* @enum {string}
|
|
2173
2173
|
*/
|
|
2174
|
-
DomainStatus: "ok" | "serverTransferProhibited" | "serverUpdateProhibited" | "serverDeleteProhibited" | "serverRenewProhibited" | "serverRestoreProhibited" | "serverHold" | "transferPeriod" | "renewPeriod" | "redemptionPeriod" | "pendingUpdate" | "pendingTransfer" | "pendingRestore" | "pendingRenew" | "pendingDelete" | "pendingCreate" | "inactive" | "autoRenewPeriod" | "addPeriod" | "deleted" | "clientTransferProhibited" | "clientUpdateProhibited" | "clientDeleteProhibited" | "clientRenewProhibited" | "clientHold";
|
|
2174
|
+
DomainStatus: "ok" | "serverTransferProhibited" | "serverUpdateProhibited" | "serverDeleteProhibited" | "serverRenewProhibited" | "serverRestoreProhibited" | "serverHold" | "transferPeriod" | "renewPeriod" | "redemptionPeriod" | "pendingUpdate" | "pendingTransfer" | "pendingRestore" | "pendingRenew" | "pendingDelete" | "pendingCreate" | "inactive" | "autoRenewPeriod" | "addPeriod" | "deleted" | "clientTransferProhibited" | "clientUpdateProhibited" | "clientDeleteProhibited" | "clientRenewProhibited" | "clientHold" | "free" | "connect" | "failed" | "invalid";
|
|
2175
2175
|
/** DomainStatusesBase */
|
|
2176
2176
|
DomainStatusesBase: {
|
|
2177
2177
|
/**
|
|
@@ -2227,18 +2227,19 @@ export interface components {
|
|
|
2227
2227
|
* @description The auth code for the domain
|
|
2228
2228
|
*/
|
|
2229
2229
|
auth_code: string;
|
|
2230
|
-
/**
|
|
2231
|
-
|
|
2232
|
-
* @description The contacts of the domain
|
|
2233
|
-
*/
|
|
2234
|
-
contacts?: {
|
|
2235
|
-
[key: string]: TypeID<"contact">;
|
|
2236
|
-
};
|
|
2230
|
+
/** @description The contacts of the domain */
|
|
2231
|
+
contacts: components["schemas"]["ContactIdList"];
|
|
2237
2232
|
/**
|
|
2238
2233
|
* Name
|
|
2239
|
-
* @description The domain
|
|
2234
|
+
* @description The domain to be created
|
|
2240
2235
|
*/
|
|
2241
2236
|
name: string;
|
|
2237
|
+
/**
|
|
2238
|
+
* Nameservers
|
|
2239
|
+
* @description The name servers for the domain
|
|
2240
|
+
*/
|
|
2241
|
+
nameservers?: components["schemas"]["Nameserver"][] | null;
|
|
2242
|
+
/** @description The renewal mode of the domain */
|
|
2242
2243
|
renewal_mode: components["schemas"]["RenewalMode"];
|
|
2243
2244
|
};
|
|
2244
2245
|
/** DomainUpdate */
|