@opusdns/api 0.213.0 → 0.215.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 +57 -1
- package/src/helpers/keys.ts +52 -0
- package/src/helpers/responses.d.ts +19 -1
- package/src/helpers/schemas.d.ts +16 -0
- package/src/openapi.yaml +32 -1
- package/src/schema.d.ts +25 -0
package/package.json
CHANGED
package/src/helpers/constants.ts
CHANGED
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
* ```
|
|
22
22
|
*/
|
|
23
23
|
|
|
24
|
-
import { AllocationMethodType, AttributeType, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ComplianceStatus, ConditionOperator, ContactAttributeSetSortField, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAttributeKey, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainForwardSortField, DomainForwardZoneSortField, DomainSortField, DomainStatus, EmailForwardLogSortField, EmailForwardLogStatus, EmailForwardSortField, EmailForwardZoneSortField, EmailVerificationStatus, EventObjectType, EventSortField, EventSubtype, EventType, ExecutingEntity, GrantType, HTTPMethod, HostStatus, HttpProtocol, InvoiceResponsePaymentStatus, InvoiceResponseStatus, InvoiceResponseType, LaunchPhaseType, LegalRequirementOperationType, LegalRequirementType, LocalPresenceRequirementType, MetricsGrouping, ObjectEventType, ObjectLogSortField, OrganizationStatus, ParkingSortField, PatchOp, PeriodUnit, Permission, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, Protocol, RedirectCode, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, RequestHistorySortField, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TimeRange, TransferAckType, UserStatus, VerificationType, ZoneSortField } from './schemas';
|
|
24
|
+
import { AllocationMethodType, AttributeType, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ComplianceStatus, ConditionOperator, ContactAttributeSetSortField, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsProtectedReason, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAttributeKey, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainForwardSortField, DomainForwardZoneSortField, DomainSortField, DomainStatus, EmailForwardLogSortField, EmailForwardLogStatus, EmailForwardSortField, EmailForwardZoneSortField, EmailVerificationStatus, EventObjectType, EventSortField, EventSubtype, EventType, ExecutingEntity, GrantType, HTTPMethod, HostStatus, HttpProtocol, InvoiceResponsePaymentStatus, InvoiceResponseStatus, InvoiceResponseType, LaunchPhaseType, LegalRequirementOperationType, LegalRequirementType, LocalPresenceRequirementType, MetricsGrouping, ObjectEventType, ObjectLogSortField, OrganizationStatus, ParkingSortField, PatchOp, PeriodUnit, Permission, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, Protocol, RedirectCode, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, RequestHistorySortField, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TimeRange, TransferAckType, UserStatus, VerificationType, ZoneSortField } from './schemas';
|
|
25
25
|
|
|
26
26
|
/**
|
|
27
27
|
* AllocationMethodType. Auto-generated enum for AllocationMethodType
|
|
@@ -733,6 +733,62 @@ export const DNS_CHANGE_ACTION_VALUES = [
|
|
|
733
733
|
'disable_dnssec'
|
|
734
734
|
] as const satisfies [string, ...string[]] | DnsChangeAction[];
|
|
735
735
|
|
|
736
|
+
/**
|
|
737
|
+
* DnsProtectedReason. Auto-generated enum for DnsProtectedReason
|
|
738
|
+
*
|
|
739
|
+
* @remarks
|
|
740
|
+
* This constant provides both object and array forms for the DnsProtectedReason enum.
|
|
741
|
+
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
742
|
+
*
|
|
743
|
+
* @example
|
|
744
|
+
* ```typescript
|
|
745
|
+
* // Using the object form for key-value access
|
|
746
|
+
* const status = DNS_PROTECTED_REASON.SUCCESS;
|
|
747
|
+
*
|
|
748
|
+
* // Using the array form for iteration
|
|
749
|
+
* const allStatuses = DNS_PROTECTED_REASON_VALUES;
|
|
750
|
+
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
751
|
+
* ```
|
|
752
|
+
*
|
|
753
|
+
* @see {@link DnsProtectedReason} - The TypeScript type definition
|
|
754
|
+
*/
|
|
755
|
+
export const DNS_PROTECTED_REASON = {
|
|
756
|
+
SYSTEM_MANAGED_SOA: "SYSTEM_MANAGED_SOA",
|
|
757
|
+
SYSTEM_MANAGED_NS: "SYSTEM_MANAGED_NS",
|
|
758
|
+
EMAIL_FORWARD: "EMAIL_FORWARD",
|
|
759
|
+
DOMAIN_FORWARD: "DOMAIN_FORWARD",
|
|
760
|
+
GENERIC: "GENERIC",
|
|
761
|
+
} as const satisfies Record<string, DnsProtectedReason>;
|
|
762
|
+
|
|
763
|
+
/**
|
|
764
|
+
* Array of all DnsProtectedReason enum values
|
|
765
|
+
*
|
|
766
|
+
* @remarks
|
|
767
|
+
* This constant provides a array containing all valid DnsProtectedReason enum values.
|
|
768
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
769
|
+
*
|
|
770
|
+
* @example
|
|
771
|
+
* ```typescript
|
|
772
|
+
* // Iterating through all values
|
|
773
|
+
* for (const value of DNS_PROTECTED_REASON_VALUES) {
|
|
774
|
+
* console.log(`Processing: ${value}`);
|
|
775
|
+
* }
|
|
776
|
+
*
|
|
777
|
+
* // Validation
|
|
778
|
+
* const isValid = DNS_PROTECTED_REASON_VALUES.includes(someValue);
|
|
779
|
+
* ```
|
|
780
|
+
*
|
|
781
|
+
* @see {@link DnsProtectedReason} - The TypeScript type definition
|
|
782
|
+
* @see {@link DNS_PROTECTED_REASON} - The object form of this enum
|
|
783
|
+
*/
|
|
784
|
+
export const DNS_PROTECTED_REASON_VALUES = [
|
|
785
|
+
'SYSTEM_MANAGED_SOA',
|
|
786
|
+
'SYSTEM_MANAGED_NS',
|
|
787
|
+
'EMAIL_FORWARD',
|
|
788
|
+
'DOMAIN_FORWARD',
|
|
789
|
+
'GENERIC'
|
|
790
|
+
] as const satisfies [string, ...string[]] | DnsProtectedReason[];
|
|
791
|
+
|
|
736
792
|
/**
|
|
737
793
|
* DnsRrsetType. Auto-generated enum for DnsRrsetType
|
|
738
794
|
*
|
package/src/helpers/keys.ts
CHANGED
|
@@ -5302,6 +5302,31 @@ export const KEYS_DNS_RECORD_PATCH_OP = [
|
|
|
5302
5302
|
* @see {@link KEYS_DNS_RECORD} - Array of all keys for this type
|
|
5303
5303
|
*/
|
|
5304
5304
|
export const KEY_DNS_RECORD_PROTECTED: keyof DnsRecord = 'protected';
|
|
5305
|
+
/**
|
|
5306
|
+
* protected_reason property
|
|
5307
|
+
*
|
|
5308
|
+
* Reason why the record is protected
|
|
5309
|
+
*
|
|
5310
|
+
*
|
|
5311
|
+
*
|
|
5312
|
+
* @remarks
|
|
5313
|
+
* This key constant provides type-safe access to the `protected_reason` property of DnsRecord objects.
|
|
5314
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
5315
|
+
*
|
|
5316
|
+
* @example
|
|
5317
|
+
* ```typescript
|
|
5318
|
+
* // Direct property access
|
|
5319
|
+
* const value = dnsrecord[KEY_DNS_RECORD_PROTECTED_REASON];
|
|
5320
|
+
*
|
|
5321
|
+
* // Dynamic property access
|
|
5322
|
+
* const propertyName = KEY_DNS_RECORD_PROTECTED_REASON;
|
|
5323
|
+
* const value = dnsrecord[propertyName];
|
|
5324
|
+
* ```
|
|
5325
|
+
*
|
|
5326
|
+
* @see {@link DnsRecord} - The TypeScript type definition
|
|
5327
|
+
* @see {@link KEYS_DNS_RECORD} - Array of all keys for this type
|
|
5328
|
+
*/
|
|
5329
|
+
export const KEY_DNS_RECORD_PROTECTED_REASON: keyof DnsRecord = 'protected_reason';
|
|
5305
5330
|
/**
|
|
5306
5331
|
* Rdata
|
|
5307
5332
|
*
|
|
@@ -5350,6 +5375,7 @@ export const KEY_DNS_RECORD_RDATA: keyof DnsRecord = 'rdata';
|
|
|
5350
5375
|
*/
|
|
5351
5376
|
export const KEYS_DNS_RECORD = [
|
|
5352
5377
|
KEY_DNS_RECORD_PROTECTED,
|
|
5378
|
+
KEY_DNS_RECORD_PROTECTED_REASON,
|
|
5353
5379
|
KEY_DNS_RECORD_RDATA,
|
|
5354
5380
|
] as const satisfies (keyof DnsRecord)[];
|
|
5355
5381
|
|
|
@@ -5732,6 +5758,31 @@ export const KEY_DNS_RRSET_NAME: keyof DnsRrset = 'name';
|
|
|
5732
5758
|
* @see {@link KEYS_DNS_RRSET} - Array of all keys for this type
|
|
5733
5759
|
*/
|
|
5734
5760
|
export const KEY_DNS_RRSET_PROTECTED: keyof DnsRrset = 'protected';
|
|
5761
|
+
/**
|
|
5762
|
+
* protected_reason property
|
|
5763
|
+
*
|
|
5764
|
+
* Reason why the RRset is protected
|
|
5765
|
+
*
|
|
5766
|
+
*
|
|
5767
|
+
*
|
|
5768
|
+
* @remarks
|
|
5769
|
+
* This key constant provides type-safe access to the `protected_reason` property of DnsRrset objects.
|
|
5770
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
5771
|
+
*
|
|
5772
|
+
* @example
|
|
5773
|
+
* ```typescript
|
|
5774
|
+
* // Direct property access
|
|
5775
|
+
* const value = dnsrrset[KEY_DNS_RRSET_PROTECTED_REASON];
|
|
5776
|
+
*
|
|
5777
|
+
* // Dynamic property access
|
|
5778
|
+
* const propertyName = KEY_DNS_RRSET_PROTECTED_REASON;
|
|
5779
|
+
* const value = dnsrrset[propertyName];
|
|
5780
|
+
* ```
|
|
5781
|
+
*
|
|
5782
|
+
* @see {@link DnsRrset} - The TypeScript type definition
|
|
5783
|
+
* @see {@link KEYS_DNS_RRSET} - Array of all keys for this type
|
|
5784
|
+
*/
|
|
5785
|
+
export const KEY_DNS_RRSET_PROTECTED_REASON: keyof DnsRrset = 'protected_reason';
|
|
5735
5786
|
/**
|
|
5736
5787
|
* Records
|
|
5737
5788
|
*
|
|
@@ -5830,6 +5881,7 @@ export const KEY_DNS_RRSET_TYPE: keyof DnsRrset = 'type';
|
|
|
5830
5881
|
export const KEYS_DNS_RRSET = [
|
|
5831
5882
|
KEY_DNS_RRSET_NAME,
|
|
5832
5883
|
KEY_DNS_RRSET_PROTECTED,
|
|
5884
|
+
KEY_DNS_RRSET_PROTECTED_REASON,
|
|
5833
5885
|
KEY_DNS_RRSET_RECORDS,
|
|
5834
5886
|
KEY_DNS_RRSET_TTL,
|
|
5835
5887
|
KEY_DNS_RRSET_TYPE,
|
|
@@ -10268,12 +10268,30 @@ export type POST_Users_Response_422 = HTTPValidationError
|
|
|
10268
10268
|
*
|
|
10269
10269
|
* @path /v1/users/{user_id}
|
|
10270
10270
|
*
|
|
10271
|
+
* @see {@link DELETE_UsersByUserId_Response_403} - 403 response type
|
|
10271
10272
|
* @see {@link DELETE_UsersByUserId_Response_409} - 409 response type
|
|
10272
10273
|
* @see {@link DELETE_UsersByUserId_Response_422} - 422 response type
|
|
10273
10274
|
*
|
|
10274
10275
|
|
|
10275
10276
|
*/
|
|
10276
|
-
export type DELETE_UsersByUserId_Response = DELETE_UsersByUserId_Response_409 | DELETE_UsersByUserId_Response_422;
|
|
10277
|
+
export type DELETE_UsersByUserId_Response = DELETE_UsersByUserId_Response_403 | DELETE_UsersByUserId_Response_409 | DELETE_UsersByUserId_Response_422;
|
|
10278
|
+
|
|
10279
|
+
/**
|
|
10280
|
+
* 403 response for DELETE UsersByUserId endpoint
|
|
10281
|
+
*
|
|
10282
|
+
* @remarks
|
|
10283
|
+
* This type defines the response structure for the 403 status code
|
|
10284
|
+
* of the DELETE UsersByUserId endpoint.
|
|
10285
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
10286
|
+
*
|
|
10287
|
+
|
|
10288
|
+
*
|
|
10289
|
+
* @path /v1/users/{user_id}
|
|
10290
|
+
*
|
|
10291
|
+
* @see {@link DELETE_UsersByUserId_Response} - The main response type definition
|
|
10292
|
+
* @see {@link Problem} - The actual schema type definition
|
|
10293
|
+
*/
|
|
10294
|
+
export type DELETE_UsersByUserId_Response_403 = Problem
|
|
10277
10295
|
|
|
10278
10296
|
/**
|
|
10279
10297
|
* 409 response for DELETE UsersByUserId endpoint
|
package/src/helpers/schemas.d.ts
CHANGED
|
@@ -650,6 +650,22 @@ export type DnsChanges = components['schemas']['DnsChangesResponse'];
|
|
|
650
650
|
* @see {@link components} - The OpenAPI components schema definition
|
|
651
651
|
*/
|
|
652
652
|
export type DnsConfigurationBase = components['schemas']['DnsConfigurationBase'];
|
|
653
|
+
/**
|
|
654
|
+
* DnsProtectedReason
|
|
655
|
+
*
|
|
656
|
+
* @remarks
|
|
657
|
+
* Type alias for the `DnsProtectedReason` OpenAPI schema.
|
|
658
|
+
* This type represents dnsprotectedreason data structures used in API requests and responses.
|
|
659
|
+
*
|
|
660
|
+
* @example
|
|
661
|
+
* ```typescript
|
|
662
|
+
* const response = await api.getDnsProtectedReason();
|
|
663
|
+
* const item: DnsProtectedReason = response.results;
|
|
664
|
+
* ```
|
|
665
|
+
*
|
|
666
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
667
|
+
*/
|
|
668
|
+
export type DnsProtectedReason = components['schemas']['DnsProtectedReason'];
|
|
653
669
|
/**
|
|
654
670
|
* DnsRecordCreate
|
|
655
671
|
*
|
package/src/openapi.yaml
CHANGED
|
@@ -1287,6 +1287,15 @@ components:
|
|
|
1287
1287
|
- host_objects
|
|
1288
1288
|
title: DnsConfigurationBase
|
|
1289
1289
|
type: object
|
|
1290
|
+
DnsProtectedReason:
|
|
1291
|
+
enum:
|
|
1292
|
+
- SYSTEM_MANAGED_SOA
|
|
1293
|
+
- SYSTEM_MANAGED_NS
|
|
1294
|
+
- EMAIL_FORWARD
|
|
1295
|
+
- DOMAIN_FORWARD
|
|
1296
|
+
- GENERIC
|
|
1297
|
+
title: DnsProtectedReason
|
|
1298
|
+
type: string
|
|
1290
1299
|
DnsRecordCreate:
|
|
1291
1300
|
properties:
|
|
1292
1301
|
rdata:
|
|
@@ -1314,6 +1323,11 @@ components:
|
|
|
1314
1323
|
description: Whether the record is protected
|
|
1315
1324
|
title: Protected
|
|
1316
1325
|
type: boolean
|
|
1326
|
+
protected_reason:
|
|
1327
|
+
anyOf:
|
|
1328
|
+
- $ref: '#/components/schemas/DnsProtectedReason'
|
|
1329
|
+
- type: 'null'
|
|
1330
|
+
description: Reason why the record is protected
|
|
1317
1331
|
rdata:
|
|
1318
1332
|
title: Rdata
|
|
1319
1333
|
type: string
|
|
@@ -1386,6 +1400,11 @@ components:
|
|
|
1386
1400
|
description: Whether the RRset is protected
|
|
1387
1401
|
title: Protected
|
|
1388
1402
|
type: boolean
|
|
1403
|
+
protected_reason:
|
|
1404
|
+
anyOf:
|
|
1405
|
+
- $ref: '#/components/schemas/DnsProtectedReason'
|
|
1406
|
+
- type: 'null'
|
|
1407
|
+
description: Reason why the RRset is protected
|
|
1389
1408
|
records:
|
|
1390
1409
|
items:
|
|
1391
1410
|
$ref: '#/components/schemas/DnsRecordResponse'
|
|
@@ -7277,7 +7296,7 @@ info:
|
|
|
7277
7296
|
'
|
|
7278
7297
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
7279
7298
|
title: OpusDNS API
|
|
7280
|
-
version: 2026-03-
|
|
7299
|
+
version: 2026-03-09-100152
|
|
7281
7300
|
x-logo:
|
|
7282
7301
|
altText: OpusDNS API Reference
|
|
7283
7302
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -17122,6 +17141,18 @@ paths:
|
|
|
17122
17141
|
responses:
|
|
17123
17142
|
'204':
|
|
17124
17143
|
description: Successful Response
|
|
17144
|
+
'403':
|
|
17145
|
+
content:
|
|
17146
|
+
application/problem+json:
|
|
17147
|
+
example:
|
|
17148
|
+
code: ERROR_USER_CANNOT_DELETE_SELF
|
|
17149
|
+
detail: Additional error context.
|
|
17150
|
+
status: 403
|
|
17151
|
+
title: User Management Error
|
|
17152
|
+
type: user-cannot-delete-self
|
|
17153
|
+
schema:
|
|
17154
|
+
$ref: '#/components/schemas/Problem'
|
|
17155
|
+
description: Forbidden
|
|
17125
17156
|
'409':
|
|
17126
17157
|
content:
|
|
17127
17158
|
application/problem+json:
|
package/src/schema.d.ts
CHANGED
|
@@ -2860,6 +2860,11 @@ export interface components {
|
|
|
2860
2860
|
*/
|
|
2861
2861
|
registry_root_nameserver_update: number;
|
|
2862
2862
|
};
|
|
2863
|
+
/**
|
|
2864
|
+
* DnsProtectedReason
|
|
2865
|
+
* @enum {string}
|
|
2866
|
+
*/
|
|
2867
|
+
DnsProtectedReason: "SYSTEM_MANAGED_SOA" | "SYSTEM_MANAGED_NS" | "EMAIL_FORWARD" | "DOMAIN_FORWARD" | "GENERIC";
|
|
2863
2868
|
/** DnsRecordCreate */
|
|
2864
2869
|
DnsRecordCreate: {
|
|
2865
2870
|
/** Rdata */
|
|
@@ -2878,6 +2883,8 @@ export interface components {
|
|
|
2878
2883
|
* @default false
|
|
2879
2884
|
*/
|
|
2880
2885
|
protected: boolean;
|
|
2886
|
+
/** @description Reason why the record is protected */
|
|
2887
|
+
protected_reason?: components["schemas"]["DnsProtectedReason"] | null;
|
|
2881
2888
|
/** Rdata */
|
|
2882
2889
|
rdata: string;
|
|
2883
2890
|
};
|
|
@@ -2916,6 +2923,8 @@ export interface components {
|
|
|
2916
2923
|
* @default false
|
|
2917
2924
|
*/
|
|
2918
2925
|
protected: boolean;
|
|
2926
|
+
/** @description Reason why the RRset is protected */
|
|
2927
|
+
protected_reason?: components["schemas"]["DnsProtectedReason"] | null;
|
|
2919
2928
|
/** Records */
|
|
2920
2929
|
records?: components["schemas"]["DnsRecordResponse"][];
|
|
2921
2930
|
/** Ttl */
|
|
@@ -14389,6 +14398,22 @@ export interface operations {
|
|
|
14389
14398
|
};
|
|
14390
14399
|
content?: never;
|
|
14391
14400
|
};
|
|
14401
|
+
/** @description Forbidden */
|
|
14402
|
+
403: {
|
|
14403
|
+
headers: {
|
|
14404
|
+
[name: string]: unknown;
|
|
14405
|
+
};
|
|
14406
|
+
content: {
|
|
14407
|
+
/** @example {
|
|
14408
|
+
* "code": "ERROR_USER_CANNOT_DELETE_SELF",
|
|
14409
|
+
* "detail": "Additional error context.",
|
|
14410
|
+
* "status": 403,
|
|
14411
|
+
* "title": "User Management Error",
|
|
14412
|
+
* "type": "user-cannot-delete-self"
|
|
14413
|
+
* } */
|
|
14414
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
14415
|
+
};
|
|
14416
|
+
};
|
|
14392
14417
|
/** @description Conflict */
|
|
14393
14418
|
409: {
|
|
14394
14419
|
headers: {
|