@opusdns/api 0.19.0 → 0.21.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 +1 -203
- package/src/helpers/schemas.d.ts +0 -32
- package/src/openapi.yaml +2 -37
- package/src/schema.d.ts +1 -16
package/package.json
CHANGED
package/src/helpers/keys.ts
CHANGED
|
@@ -39,7 +39,6 @@ import { ContactVerificationApi } from './schemas';
|
|
|
39
39
|
import { ContactVerificationEmail } from './schemas';
|
|
40
40
|
import { ContactVerification } from './schemas';
|
|
41
41
|
import { ContactsBase } from './schemas';
|
|
42
|
-
import { DeletedEvent } from './schemas';
|
|
43
42
|
import { DnsChange } from './schemas';
|
|
44
43
|
import { DnsChanges } from './schemas';
|
|
45
44
|
import { DnsConfigurationBase } from './schemas';
|
|
@@ -128,7 +127,6 @@ import { TldBase } from './schemas';
|
|
|
128
127
|
import { TldResponseShort } from './schemas';
|
|
129
128
|
import { TldSpecification } from './schemas';
|
|
130
129
|
import { TrademarkClaimsBase } from './schemas';
|
|
131
|
-
import { TransferEvent } from './schemas';
|
|
132
130
|
import { TransferPoliciesBase } from './schemas';
|
|
133
131
|
import { User } from './schemas';
|
|
134
132
|
import { UserAttributeBase } from './schemas';
|
|
@@ -2690,55 +2688,6 @@ export const KEYS_CONTACTS_BASE = [
|
|
|
2690
2688
|
KEY_CONTACTS_BASE_SUPPORTED_ROLES,
|
|
2691
2689
|
] as const satisfies (keyof ContactsBase)[];
|
|
2692
2690
|
|
|
2693
|
-
/**
|
|
2694
|
-
* date property
|
|
2695
|
-
*
|
|
2696
|
-
*
|
|
2697
|
-
*
|
|
2698
|
-
*
|
|
2699
|
-
* @remarks
|
|
2700
|
-
* This key constant provides type-safe access to the `date` property of DeletedEvent objects.
|
|
2701
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
2702
|
-
*
|
|
2703
|
-
* @example
|
|
2704
|
-
* ```typescript
|
|
2705
|
-
* // Direct property access
|
|
2706
|
-
* const value = deletedevent[KEY_DELETED_EVENT_DATE];
|
|
2707
|
-
*
|
|
2708
|
-
* // Dynamic property access
|
|
2709
|
-
* const propertyName = KEY_DELETED_EVENT_DATE;
|
|
2710
|
-
* const value = deletedevent[propertyName];
|
|
2711
|
-
* ```
|
|
2712
|
-
*
|
|
2713
|
-
* @see {@link DeletedEvent} - The TypeScript type definition
|
|
2714
|
-
* @see {@link KEYS_DELETED_EVENT} - Array of all keys for this type
|
|
2715
|
-
*/
|
|
2716
|
-
export const KEY_DELETED_EVENT_DATE = 'date' as keyof DeletedEvent;
|
|
2717
|
-
|
|
2718
|
-
/**
|
|
2719
|
-
* Array of all DeletedEvent property keys
|
|
2720
|
-
*
|
|
2721
|
-
* @remarks
|
|
2722
|
-
* This constant provides a readonly array containing all valid property keys for DeletedEvent objects.
|
|
2723
|
-
* Useful for iteration, validation, and generating dynamic UI components.
|
|
2724
|
-
*
|
|
2725
|
-
* @example
|
|
2726
|
-
* ```typescript
|
|
2727
|
-
* // Iterating through all keys
|
|
2728
|
-
* for (const key of KEYS_DELETED_EVENT) {
|
|
2729
|
-
* console.log(`Property: ${key}, Value: ${deletedevent[key]}`);
|
|
2730
|
-
* }
|
|
2731
|
-
*
|
|
2732
|
-
* // Validation
|
|
2733
|
-
* const isValidKey = KEYS_DELETED_EVENT.includes(someKey);
|
|
2734
|
-
* ```
|
|
2735
|
-
*
|
|
2736
|
-
* @see {@link DeletedEvent} - The TypeScript type definition
|
|
2737
|
-
*/
|
|
2738
|
-
export const KEYS_DELETED_EVENT = [
|
|
2739
|
-
KEY_DELETED_EVENT_DATE,
|
|
2740
|
-
] as const satisfies (keyof DeletedEvent)[];
|
|
2741
|
-
|
|
2742
2691
|
/**
|
|
2743
2692
|
* action property
|
|
2744
2693
|
*
|
|
@@ -7849,6 +7798,7 @@ export const KEYS_EMAIL_FORWARD_ALIAS_UPDATE = [
|
|
|
7849
7798
|
* Event Data
|
|
7850
7799
|
*
|
|
7851
7800
|
*
|
|
7801
|
+
* @type {object}
|
|
7852
7802
|
*
|
|
7853
7803
|
*
|
|
7854
7804
|
* @remarks
|
|
@@ -15619,158 +15569,6 @@ export const KEYS_TRADEMARK_CLAIMS_BASE = [
|
|
|
15619
15569
|
KEY_TRADEMARK_CLAIMS_BASE_TMCH_REQUIRED,
|
|
15620
15570
|
] as const satisfies (keyof TrademarkClaimsBase)[];
|
|
15621
15571
|
|
|
15622
|
-
/**
|
|
15623
|
-
* Current Registrar
|
|
15624
|
-
*
|
|
15625
|
-
*
|
|
15626
|
-
* @type {string}
|
|
15627
|
-
*
|
|
15628
|
-
*
|
|
15629
|
-
* @remarks
|
|
15630
|
-
* This key constant provides type-safe access to the `current_registrar` property of TransferEvent objects.
|
|
15631
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
15632
|
-
*
|
|
15633
|
-
* @example
|
|
15634
|
-
* ```typescript
|
|
15635
|
-
* // Direct property access
|
|
15636
|
-
* const value = transferevent[KEY_TRANSFER_EVENT_CURRENT_REGISTRAR];
|
|
15637
|
-
*
|
|
15638
|
-
* // Dynamic property access
|
|
15639
|
-
* const propertyName = KEY_TRANSFER_EVENT_CURRENT_REGISTRAR;
|
|
15640
|
-
* const value = transferevent[propertyName];
|
|
15641
|
-
* ```
|
|
15642
|
-
*
|
|
15643
|
-
* @see {@link TransferEvent} - The TypeScript type definition
|
|
15644
|
-
* @see {@link KEYS_TRANSFER_EVENT} - Array of all keys for this type
|
|
15645
|
-
*/
|
|
15646
|
-
export const KEY_TRANSFER_EVENT_CURRENT_REGISTRAR = 'current_registrar' as keyof TransferEvent;
|
|
15647
|
-
/**
|
|
15648
|
-
* execution_date property
|
|
15649
|
-
*
|
|
15650
|
-
*
|
|
15651
|
-
*
|
|
15652
|
-
*
|
|
15653
|
-
* @remarks
|
|
15654
|
-
* This key constant provides type-safe access to the `execution_date` property of TransferEvent objects.
|
|
15655
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
15656
|
-
*
|
|
15657
|
-
* @example
|
|
15658
|
-
* ```typescript
|
|
15659
|
-
* // Direct property access
|
|
15660
|
-
* const value = transferevent[KEY_TRANSFER_EVENT_EXECUTION_DATE];
|
|
15661
|
-
*
|
|
15662
|
-
* // Dynamic property access
|
|
15663
|
-
* const propertyName = KEY_TRANSFER_EVENT_EXECUTION_DATE;
|
|
15664
|
-
* const value = transferevent[propertyName];
|
|
15665
|
-
* ```
|
|
15666
|
-
*
|
|
15667
|
-
* @see {@link TransferEvent} - The TypeScript type definition
|
|
15668
|
-
* @see {@link KEYS_TRANSFER_EVENT} - Array of all keys for this type
|
|
15669
|
-
*/
|
|
15670
|
-
export const KEY_TRANSFER_EVENT_EXECUTION_DATE = 'execution_date' as keyof TransferEvent;
|
|
15671
|
-
/**
|
|
15672
|
-
* expiration_date property
|
|
15673
|
-
*
|
|
15674
|
-
*
|
|
15675
|
-
*
|
|
15676
|
-
*
|
|
15677
|
-
* @remarks
|
|
15678
|
-
* This key constant provides type-safe access to the `expiration_date` property of TransferEvent objects.
|
|
15679
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
15680
|
-
*
|
|
15681
|
-
* @example
|
|
15682
|
-
* ```typescript
|
|
15683
|
-
* // Direct property access
|
|
15684
|
-
* const value = transferevent[KEY_TRANSFER_EVENT_EXPIRATION_DATE];
|
|
15685
|
-
*
|
|
15686
|
-
* // Dynamic property access
|
|
15687
|
-
* const propertyName = KEY_TRANSFER_EVENT_EXPIRATION_DATE;
|
|
15688
|
-
* const value = transferevent[propertyName];
|
|
15689
|
-
* ```
|
|
15690
|
-
*
|
|
15691
|
-
* @see {@link TransferEvent} - The TypeScript type definition
|
|
15692
|
-
* @see {@link KEYS_TRANSFER_EVENT} - Array of all keys for this type
|
|
15693
|
-
*/
|
|
15694
|
-
export const KEY_TRANSFER_EVENT_EXPIRATION_DATE = 'expiration_date' as keyof TransferEvent;
|
|
15695
|
-
/**
|
|
15696
|
-
* Message
|
|
15697
|
-
*
|
|
15698
|
-
*
|
|
15699
|
-
* @type {string}
|
|
15700
|
-
*
|
|
15701
|
-
*
|
|
15702
|
-
* @remarks
|
|
15703
|
-
* This key constant provides type-safe access to the `message` property of TransferEvent objects.
|
|
15704
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
15705
|
-
*
|
|
15706
|
-
* @example
|
|
15707
|
-
* ```typescript
|
|
15708
|
-
* // Direct property access
|
|
15709
|
-
* const value = transferevent[KEY_TRANSFER_EVENT_MESSAGE];
|
|
15710
|
-
*
|
|
15711
|
-
* // Dynamic property access
|
|
15712
|
-
* const propertyName = KEY_TRANSFER_EVENT_MESSAGE;
|
|
15713
|
-
* const value = transferevent[propertyName];
|
|
15714
|
-
* ```
|
|
15715
|
-
*
|
|
15716
|
-
* @see {@link TransferEvent} - The TypeScript type definition
|
|
15717
|
-
* @see {@link KEYS_TRANSFER_EVENT} - Array of all keys for this type
|
|
15718
|
-
*/
|
|
15719
|
-
export const KEY_TRANSFER_EVENT_MESSAGE = 'message' as keyof TransferEvent;
|
|
15720
|
-
/**
|
|
15721
|
-
* Requesting Registrar
|
|
15722
|
-
*
|
|
15723
|
-
*
|
|
15724
|
-
* @type {string}
|
|
15725
|
-
*
|
|
15726
|
-
*
|
|
15727
|
-
* @remarks
|
|
15728
|
-
* This key constant provides type-safe access to the `requesting_registrar` property of TransferEvent objects.
|
|
15729
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
15730
|
-
*
|
|
15731
|
-
* @example
|
|
15732
|
-
* ```typescript
|
|
15733
|
-
* // Direct property access
|
|
15734
|
-
* const value = transferevent[KEY_TRANSFER_EVENT_REQUESTING_REGISTRAR];
|
|
15735
|
-
*
|
|
15736
|
-
* // Dynamic property access
|
|
15737
|
-
* const propertyName = KEY_TRANSFER_EVENT_REQUESTING_REGISTRAR;
|
|
15738
|
-
* const value = transferevent[propertyName];
|
|
15739
|
-
* ```
|
|
15740
|
-
*
|
|
15741
|
-
* @see {@link TransferEvent} - The TypeScript type definition
|
|
15742
|
-
* @see {@link KEYS_TRANSFER_EVENT} - Array of all keys for this type
|
|
15743
|
-
*/
|
|
15744
|
-
export const KEY_TRANSFER_EVENT_REQUESTING_REGISTRAR = 'requesting_registrar' as keyof TransferEvent;
|
|
15745
|
-
|
|
15746
|
-
/**
|
|
15747
|
-
* Array of all TransferEvent property keys
|
|
15748
|
-
*
|
|
15749
|
-
* @remarks
|
|
15750
|
-
* This constant provides a readonly array containing all valid property keys for TransferEvent objects.
|
|
15751
|
-
* Useful for iteration, validation, and generating dynamic UI components.
|
|
15752
|
-
*
|
|
15753
|
-
* @example
|
|
15754
|
-
* ```typescript
|
|
15755
|
-
* // Iterating through all keys
|
|
15756
|
-
* for (const key of KEYS_TRANSFER_EVENT) {
|
|
15757
|
-
* console.log(`Property: ${key}, Value: ${transferevent[key]}`);
|
|
15758
|
-
* }
|
|
15759
|
-
*
|
|
15760
|
-
* // Validation
|
|
15761
|
-
* const isValidKey = KEYS_TRANSFER_EVENT.includes(someKey);
|
|
15762
|
-
* ```
|
|
15763
|
-
*
|
|
15764
|
-
* @see {@link TransferEvent} - The TypeScript type definition
|
|
15765
|
-
*/
|
|
15766
|
-
export const KEYS_TRANSFER_EVENT = [
|
|
15767
|
-
KEY_TRANSFER_EVENT_CURRENT_REGISTRAR,
|
|
15768
|
-
KEY_TRANSFER_EVENT_EXECUTION_DATE,
|
|
15769
|
-
KEY_TRANSFER_EVENT_EXPIRATION_DATE,
|
|
15770
|
-
KEY_TRANSFER_EVENT_MESSAGE,
|
|
15771
|
-
KEY_TRANSFER_EVENT_REQUESTING_REGISTRAR,
|
|
15772
|
-
] as const satisfies (keyof TransferEvent)[];
|
|
15773
|
-
|
|
15774
15572
|
/**
|
|
15775
15573
|
* Authinfo Max Length
|
|
15776
15574
|
*
|
package/src/helpers/schemas.d.ts
CHANGED
|
@@ -282,22 +282,6 @@ export type Currency = components['schemas']['Currency'];
|
|
|
282
282
|
* @see {@link components} - The OpenAPI components schema definition
|
|
283
283
|
*/
|
|
284
284
|
export type DeletePolicyType = components['schemas']['DeletePolicyType'];
|
|
285
|
-
/**
|
|
286
|
-
* DeletedEvent
|
|
287
|
-
*
|
|
288
|
-
* @remarks
|
|
289
|
-
* Type alias for the `DeletedEvent` OpenAPI schema.
|
|
290
|
-
* This type represents deletedevent data structures used in API requests and responses.
|
|
291
|
-
*
|
|
292
|
-
* @example
|
|
293
|
-
* ```typescript
|
|
294
|
-
* const response = await api.getDeletedEvent();
|
|
295
|
-
* const item: DeletedEvent = response.results;
|
|
296
|
-
* ```
|
|
297
|
-
*
|
|
298
|
-
* @see {@link components} - The OpenAPI components schema definition
|
|
299
|
-
*/
|
|
300
|
-
export type DeletedEvent = components['schemas']['DeletedEvent'];
|
|
301
285
|
/**
|
|
302
286
|
* DnsChangeAction
|
|
303
287
|
*
|
|
@@ -2490,22 +2474,6 @@ export type TrademarkClaimsBase = components['schemas']['TrademarkClaimsBase'];
|
|
|
2490
2474
|
* @see {@link components} - The OpenAPI components schema definition
|
|
2491
2475
|
*/
|
|
2492
2476
|
export type TransferAckType = components['schemas']['TransferAckType'];
|
|
2493
|
-
/**
|
|
2494
|
-
* TransferEvent
|
|
2495
|
-
*
|
|
2496
|
-
* @remarks
|
|
2497
|
-
* Type alias for the `TransferEvent` OpenAPI schema.
|
|
2498
|
-
* This type represents transferevent data structures used in API requests and responses.
|
|
2499
|
-
*
|
|
2500
|
-
* @example
|
|
2501
|
-
* ```typescript
|
|
2502
|
-
* const response = await api.getTransferEvent();
|
|
2503
|
-
* const item: TransferEvent = response.results;
|
|
2504
|
-
* ```
|
|
2505
|
-
*
|
|
2506
|
-
* @see {@link components} - The OpenAPI components schema definition
|
|
2507
|
-
*/
|
|
2508
|
-
export type TransferEvent = components['schemas']['TransferEvent'];
|
|
2509
2477
|
/**
|
|
2510
2478
|
* TransferPoliciesBase
|
|
2511
2479
|
*
|
package/src/openapi.yaml
CHANGED
|
@@ -649,14 +649,6 @@ components:
|
|
|
649
649
|
- expiration
|
|
650
650
|
title: DeletePolicyType
|
|
651
651
|
type: string
|
|
652
|
-
DeletedEvent:
|
|
653
|
-
properties:
|
|
654
|
-
date:
|
|
655
|
-
$ref: '#/components/schemas/EppDateTime'
|
|
656
|
-
required:
|
|
657
|
-
- date
|
|
658
|
-
title: DeletedEvent
|
|
659
|
-
type: object
|
|
660
652
|
DnsChangeAction:
|
|
661
653
|
enum:
|
|
662
654
|
- create_zone
|
|
@@ -1931,10 +1923,8 @@ components:
|
|
|
1931
1923
|
EventResponse:
|
|
1932
1924
|
properties:
|
|
1933
1925
|
event_data:
|
|
1934
|
-
anyOf:
|
|
1935
|
-
- $ref: '#/components/schemas/TransferEvent'
|
|
1936
|
-
- $ref: '#/components/schemas/DeletedEvent'
|
|
1937
1926
|
title: Event Data
|
|
1927
|
+
type: object
|
|
1938
1928
|
event_id:
|
|
1939
1929
|
examples:
|
|
1940
1930
|
- epp_event_01h45ytscbebyvny4gc8cr8ma2
|
|
@@ -4030,31 +4020,6 @@ components:
|
|
|
4030
4020
|
- both
|
|
4031
4021
|
title: TransferAckType
|
|
4032
4022
|
type: string
|
|
4033
|
-
TransferEvent:
|
|
4034
|
-
properties:
|
|
4035
|
-
current_registrar:
|
|
4036
|
-
title: Current Registrar
|
|
4037
|
-
type: string
|
|
4038
|
-
execution_date:
|
|
4039
|
-
$ref: '#/components/schemas/EppDateTime'
|
|
4040
|
-
expiration_date:
|
|
4041
|
-
anyOf:
|
|
4042
|
-
- $ref: '#/components/schemas/EppDateTime'
|
|
4043
|
-
- type: 'null'
|
|
4044
|
-
message:
|
|
4045
|
-
title: Message
|
|
4046
|
-
type: string
|
|
4047
|
-
requesting_registrar:
|
|
4048
|
-
title: Requesting Registrar
|
|
4049
|
-
type: string
|
|
4050
|
-
required:
|
|
4051
|
-
- execution_date
|
|
4052
|
-
- message
|
|
4053
|
-
- requesting_registrar
|
|
4054
|
-
- current_registrar
|
|
4055
|
-
- expiration_date
|
|
4056
|
-
title: TransferEvent
|
|
4057
|
-
type: object
|
|
4058
4023
|
TransferPoliciesBase:
|
|
4059
4024
|
properties:
|
|
4060
4025
|
authinfo_max_length:
|
|
@@ -4839,7 +4804,7 @@ info:
|
|
|
4839
4804
|
'
|
|
4840
4805
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
4841
4806
|
title: OpusDNS API
|
|
4842
|
-
version: 2025-08-15-
|
|
4807
|
+
version: 2025-08-15-211010
|
|
4843
4808
|
x-logo:
|
|
4844
4809
|
altText: OpusDNS API Reference
|
|
4845
4810
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
package/src/schema.d.ts
CHANGED
|
@@ -1562,10 +1562,6 @@ export interface components {
|
|
|
1562
1562
|
* @enum {string}
|
|
1563
1563
|
*/
|
|
1564
1564
|
DeletePolicyType: "immediate" | "expiration";
|
|
1565
|
-
/** DeletedEvent */
|
|
1566
|
-
DeletedEvent: {
|
|
1567
|
-
date: components["schemas"]["EppDateTime"];
|
|
1568
|
-
};
|
|
1569
1565
|
/**
|
|
1570
1566
|
* DnsChangeAction
|
|
1571
1567
|
* @enum {string}
|
|
@@ -2322,7 +2318,7 @@ export interface components {
|
|
|
2322
2318
|
/** EventResponse */
|
|
2323
2319
|
EventResponse: {
|
|
2324
2320
|
/** Event Data */
|
|
2325
|
-
event_data:
|
|
2321
|
+
event_data: Record<string, never>;
|
|
2326
2322
|
/**
|
|
2327
2323
|
* Event Id
|
|
2328
2324
|
* Format: typeid
|
|
@@ -3703,17 +3699,6 @@ export interface components {
|
|
|
3703
3699
|
* @enum {string}
|
|
3704
3700
|
*/
|
|
3705
3701
|
TransferAckType: "none" | "registrar" | "registrant" | "both";
|
|
3706
|
-
/** TransferEvent */
|
|
3707
|
-
TransferEvent: {
|
|
3708
|
-
/** Current Registrar */
|
|
3709
|
-
current_registrar: string;
|
|
3710
|
-
execution_date: components["schemas"]["EppDateTime"];
|
|
3711
|
-
expiration_date: components["schemas"]["EppDateTime"] | null;
|
|
3712
|
-
/** Message */
|
|
3713
|
-
message: string;
|
|
3714
|
-
/** Requesting Registrar */
|
|
3715
|
-
requesting_registrar: string;
|
|
3716
|
-
};
|
|
3717
3702
|
/** TransferPoliciesBase */
|
|
3718
3703
|
TransferPoliciesBase: {
|
|
3719
3704
|
/**
|