@opusdns/api 0.26.0 → 0.28.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 +26 -0
- package/src/helpers/schemas-arrays.d.ts +11 -11
- package/src/openapi.yaml +18 -5
- package/src/schema.d.ts +9 -2
package/package.json
CHANGED
package/src/helpers/keys.ts
CHANGED
|
@@ -7018,6 +7018,31 @@ export const KEYS_DOMAIN_SEARCH_SUGGESTION = [
|
|
|
7018
7018
|
* @see {@link KEYS_DOMAIN_STATUSES_BASE} - Array of all keys for this type
|
|
7019
7019
|
*/
|
|
7020
7020
|
export const KEY_DOMAIN_STATUSES_BASE_DEFAULT = 'default' as keyof DomainStatusesBase;
|
|
7021
|
+
/**
|
|
7022
|
+
* Status Mapping
|
|
7023
|
+
*
|
|
7024
|
+
* Mapping of registry-specific statuses to their equivalent default ones, if any
|
|
7025
|
+
*
|
|
7026
|
+
*
|
|
7027
|
+
*
|
|
7028
|
+
* @remarks
|
|
7029
|
+
* This key constant provides type-safe access to the `status_mapping` property of DomainStatusesBase objects.
|
|
7030
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
7031
|
+
*
|
|
7032
|
+
* @example
|
|
7033
|
+
* ```typescript
|
|
7034
|
+
* // Direct property access
|
|
7035
|
+
* const value = domainstatusesbase[KEY_DOMAIN_STATUSES_BASE_STATUS_MAPPING];
|
|
7036
|
+
*
|
|
7037
|
+
* // Dynamic property access
|
|
7038
|
+
* const propertyName = KEY_DOMAIN_STATUSES_BASE_STATUS_MAPPING;
|
|
7039
|
+
* const value = domainstatusesbase[propertyName];
|
|
7040
|
+
* ```
|
|
7041
|
+
*
|
|
7042
|
+
* @see {@link DomainStatusesBase} - The TypeScript type definition
|
|
7043
|
+
* @see {@link KEYS_DOMAIN_STATUSES_BASE} - Array of all keys for this type
|
|
7044
|
+
*/
|
|
7045
|
+
export const KEY_DOMAIN_STATUSES_BASE_STATUS_MAPPING = 'status_mapping' as keyof DomainStatusesBase;
|
|
7021
7046
|
/**
|
|
7022
7047
|
* Supported Statuses
|
|
7023
7048
|
*
|
|
@@ -7067,6 +7092,7 @@ export const KEY_DOMAIN_STATUSES_BASE_SUPPORTED_STATUSES = 'supported_statuses'
|
|
|
7067
7092
|
*/
|
|
7068
7093
|
export const KEYS_DOMAIN_STATUSES_BASE = [
|
|
7069
7094
|
KEY_DOMAIN_STATUSES_BASE_DEFAULT,
|
|
7095
|
+
KEY_DOMAIN_STATUSES_BASE_STATUS_MAPPING,
|
|
7070
7096
|
KEY_DOMAIN_STATUSES_BASE_SUPPORTED_STATUSES,
|
|
7071
7097
|
] as const satisfies (keyof DomainStatusesBase)[];
|
|
7072
7098
|
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
* This file is auto-generated from the OpenAPI specification.
|
|
22
22
|
* Do not edit manually.
|
|
23
23
|
*/
|
|
24
|
-
import { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, TldResponseShort, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, Nameserver, DeletePolicyType, SyncOperationType, DomainContact,
|
|
24
|
+
import { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, TldResponseShort, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, Nameserver, DeletePolicyType, SyncOperationType, DomainContact, DomainSearchSuggestion, DomainStatus, DomainClientStatus, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, ContactRoleType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, ContactSchema, DnsZone, Domain, EmailForwardAlias, EventResponse, OrganizationCredential, Organization, UserNotificationSummary, Period, Permission, PremiumAffectsType, Relation, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
|
|
25
25
|
|
|
26
26
|
/**
|
|
27
27
|
* DomainDnssecDataResponse
|
|
@@ -304,33 +304,33 @@ export type SyncOperationTypeArray = SyncOperationType[];
|
|
|
304
304
|
*/
|
|
305
305
|
export type DomainContactArray = DomainContact[];
|
|
306
306
|
/**
|
|
307
|
-
*
|
|
307
|
+
* DomainSearchSuggestion
|
|
308
308
|
*
|
|
309
309
|
* @remarks
|
|
310
|
-
* Array type for
|
|
310
|
+
* Array type for DomainSearchSuggestion objects. Used when the API returns a collection of DomainSearchSuggestion instances.
|
|
311
311
|
*
|
|
312
312
|
* @example
|
|
313
313
|
* ```typescript
|
|
314
|
-
* const items:
|
|
314
|
+
* const items: DomainSearchSuggestionArray = await api.getDomainSearchSuggestions();
|
|
315
315
|
* ```
|
|
316
316
|
*
|
|
317
|
-
* @see {@link
|
|
317
|
+
* @see {@link DomainSearchSuggestion} - The individual DomainSearchSuggestion type definition
|
|
318
318
|
*/
|
|
319
|
-
export type
|
|
319
|
+
export type DomainSearchSuggestionArray = DomainSearchSuggestion[];
|
|
320
320
|
/**
|
|
321
|
-
*
|
|
321
|
+
* DomainStatus
|
|
322
322
|
*
|
|
323
323
|
* @remarks
|
|
324
|
-
* Array type for
|
|
324
|
+
* Array type for DomainStatus objects. Used when the API returns a collection of DomainStatus instances.
|
|
325
325
|
*
|
|
326
326
|
* @example
|
|
327
327
|
* ```typescript
|
|
328
|
-
* const items:
|
|
328
|
+
* const items: DomainStatusArray = await api.getDomainStatuss();
|
|
329
329
|
* ```
|
|
330
330
|
*
|
|
331
|
-
* @see {@link
|
|
331
|
+
* @see {@link DomainStatus} - The individual DomainStatus type definition
|
|
332
332
|
*/
|
|
333
|
-
export type
|
|
333
|
+
export type DomainStatusArray = DomainStatus[];
|
|
334
334
|
/**
|
|
335
335
|
* DomainClientStatus
|
|
336
336
|
*
|
package/src/openapi.yaml
CHANGED
|
@@ -1574,7 +1574,7 @@ components:
|
|
|
1574
1574
|
registry_statuses:
|
|
1575
1575
|
description: All the domain statuses
|
|
1576
1576
|
items:
|
|
1577
|
-
|
|
1577
|
+
type: string
|
|
1578
1578
|
title: Registry Statuses
|
|
1579
1579
|
type: array
|
|
1580
1580
|
renewal_mode:
|
|
@@ -1711,10 +1711,21 @@ components:
|
|
|
1711
1711
|
type: string
|
|
1712
1712
|
title: Default
|
|
1713
1713
|
type: array
|
|
1714
|
+
status_mapping:
|
|
1715
|
+
anyOf:
|
|
1716
|
+
- additionalProperties:
|
|
1717
|
+
items:
|
|
1718
|
+
$ref: '#/components/schemas/DomainStatus'
|
|
1719
|
+
type: array
|
|
1720
|
+
type: object
|
|
1721
|
+
- type: 'null'
|
|
1722
|
+
description: Mapping of registry-specific statuses to their equivalent default
|
|
1723
|
+
ones, if any
|
|
1724
|
+
title: Status Mapping
|
|
1714
1725
|
supported_statuses:
|
|
1715
1726
|
description: Supported domain statuses
|
|
1716
1727
|
items:
|
|
1717
|
-
|
|
1728
|
+
type: string
|
|
1718
1729
|
title: Supported Statuses
|
|
1719
1730
|
type: array
|
|
1720
1731
|
required:
|
|
@@ -2317,8 +2328,10 @@ components:
|
|
|
2317
2328
|
ip_addresses:
|
|
2318
2329
|
description: The ip addresses of the name server
|
|
2319
2330
|
examples:
|
|
2320
|
-
- 0.0.0.0
|
|
2321
|
-
|
|
2331
|
+
- - 0.0.0.0
|
|
2332
|
+
- 127.0.0.1
|
|
2333
|
+
- - 2001:db8::1
|
|
2334
|
+
- 2001:db8::2
|
|
2322
2335
|
items:
|
|
2323
2336
|
format: ipvanyaddress
|
|
2324
2337
|
type: string
|
|
@@ -4785,7 +4798,7 @@ info:
|
|
|
4785
4798
|
'
|
|
4786
4799
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
4787
4800
|
title: OpusDNS API
|
|
4788
|
-
version: 2025-08-
|
|
4801
|
+
version: 2025-08-29-171808
|
|
4789
4802
|
x-logo:
|
|
4790
4803
|
altText: OpusDNS API Reference
|
|
4791
4804
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
package/src/schema.d.ts
CHANGED
|
@@ -2092,7 +2092,7 @@ export interface components {
|
|
|
2092
2092
|
* Registry Statuses
|
|
2093
2093
|
* @description All the domain statuses
|
|
2094
2094
|
*/
|
|
2095
|
-
registry_statuses?:
|
|
2095
|
+
registry_statuses?: string[];
|
|
2096
2096
|
/** @description The renewal mode of the domain */
|
|
2097
2097
|
renewal_mode?: components["schemas"]["RenewalMode"];
|
|
2098
2098
|
/**
|
|
@@ -2162,11 +2162,18 @@ export interface components {
|
|
|
2162
2162
|
* @description The default status for an active domain with no restrictions
|
|
2163
2163
|
*/
|
|
2164
2164
|
default: string[];
|
|
2165
|
+
/**
|
|
2166
|
+
* Status Mapping
|
|
2167
|
+
* @description Mapping of registry-specific statuses to their equivalent default ones, if any
|
|
2168
|
+
*/
|
|
2169
|
+
status_mapping?: {
|
|
2170
|
+
[key: string]: components["schemas"]["DomainStatus"][];
|
|
2171
|
+
} | null;
|
|
2165
2172
|
/**
|
|
2166
2173
|
* Supported Statuses
|
|
2167
2174
|
* @description Supported domain statuses
|
|
2168
2175
|
*/
|
|
2169
|
-
supported_statuses:
|
|
2176
|
+
supported_statuses: string[];
|
|
2170
2177
|
};
|
|
2171
2178
|
/** DomainSummaryData */
|
|
2172
2179
|
DomainSummaryData: {
|