@opusdns/api 0.20.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 CHANGED
@@ -8,7 +8,7 @@
8
8
  "typescript": "^5.8.2"
9
9
  },
10
10
  "name": "@opusdns/api",
11
- "version": "0.20.0",
11
+ "version": "0.21.0",
12
12
  "description": "TypeScript types for the OpusDNS OpenAPI specification",
13
13
  "main": "./src/index.ts",
14
14
  "module": "./src/index.ts",
@@ -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';
@@ -118,7 +117,6 @@ import { Problem } from './schemas';
118
117
  import { RdapBase } from './schemas';
119
118
  import { RegistryLockBase } from './schemas';
120
119
  import { RelationSet } from './schemas';
121
- import { RenewalEvent } from './schemas';
122
120
  import { ReservedDomainsBase } from './schemas';
123
121
  import { RgpOperations } from './schemas';
124
122
  import { SignupCreate } from './schemas';
@@ -129,7 +127,6 @@ import { TldBase } from './schemas';
129
127
  import { TldResponseShort } from './schemas';
130
128
  import { TldSpecification } from './schemas';
131
129
  import { TrademarkClaimsBase } from './schemas';
132
- import { TransferEvent } from './schemas';
133
130
  import { TransferPoliciesBase } from './schemas';
134
131
  import { User } from './schemas';
135
132
  import { UserAttributeBase } from './schemas';
@@ -2691,55 +2688,6 @@ export const KEYS_CONTACTS_BASE = [
2691
2688
  KEY_CONTACTS_BASE_SUPPORTED_ROLES,
2692
2689
  ] as const satisfies (keyof ContactsBase)[];
2693
2690
 
2694
- /**
2695
- * date property
2696
- *
2697
- *
2698
- *
2699
- *
2700
- * @remarks
2701
- * This key constant provides type-safe access to the `date` property of DeletedEvent objects.
2702
- * Use this constant when you need to access properties dynamically or ensure type safety.
2703
- *
2704
- * @example
2705
- * ```typescript
2706
- * // Direct property access
2707
- * const value = deletedevent[KEY_DELETED_EVENT_DATE];
2708
- *
2709
- * // Dynamic property access
2710
- * const propertyName = KEY_DELETED_EVENT_DATE;
2711
- * const value = deletedevent[propertyName];
2712
- * ```
2713
- *
2714
- * @see {@link DeletedEvent} - The TypeScript type definition
2715
- * @see {@link KEYS_DELETED_EVENT} - Array of all keys for this type
2716
- */
2717
- export const KEY_DELETED_EVENT_DATE = 'date' as keyof DeletedEvent;
2718
-
2719
- /**
2720
- * Array of all DeletedEvent property keys
2721
- *
2722
- * @remarks
2723
- * This constant provides a readonly array containing all valid property keys for DeletedEvent objects.
2724
- * Useful for iteration, validation, and generating dynamic UI components.
2725
- *
2726
- * @example
2727
- * ```typescript
2728
- * // Iterating through all keys
2729
- * for (const key of KEYS_DELETED_EVENT) {
2730
- * console.log(`Property: ${key}, Value: ${deletedevent[key]}`);
2731
- * }
2732
- *
2733
- * // Validation
2734
- * const isValidKey = KEYS_DELETED_EVENT.includes(someKey);
2735
- * ```
2736
- *
2737
- * @see {@link DeletedEvent} - The TypeScript type definition
2738
- */
2739
- export const KEYS_DELETED_EVENT = [
2740
- KEY_DELETED_EVENT_DATE,
2741
- ] as const satisfies (keyof DeletedEvent)[];
2742
-
2743
2691
  /**
2744
2692
  * action property
2745
2693
  *
@@ -7850,6 +7798,7 @@ export const KEYS_EMAIL_FORWARD_ALIAS_UPDATE = [
7850
7798
  * Event Data
7851
7799
  *
7852
7800
  *
7801
+ * @type {object}
7853
7802
  *
7854
7803
  *
7855
7804
  * @remarks
@@ -14439,57 +14388,6 @@ export const KEYS_RELATION_SET = [
14439
14388
  KEY_RELATION_SET_RELATIONS,
14440
14389
  ] as const satisfies (keyof RelationSet)[];
14441
14390
 
14442
- /**
14443
- * Registration Expiration Date
14444
- *
14445
- * The new expiration date/time after the domain has been renewed
14446
- *
14447
- * @type {string}
14448
- *
14449
- *
14450
- * @remarks
14451
- * This key constant provides type-safe access to the `registration_expiration_date` property of RenewalEvent objects.
14452
- * Use this constant when you need to access properties dynamically or ensure type safety.
14453
- *
14454
- * @example
14455
- * ```typescript
14456
- * // Direct property access
14457
- * const value = renewalevent[KEY_RENEWAL_EVENT_REGISTRATION_EXPIRATION_DATE];
14458
- *
14459
- * // Dynamic property access
14460
- * const propertyName = KEY_RENEWAL_EVENT_REGISTRATION_EXPIRATION_DATE;
14461
- * const value = renewalevent[propertyName];
14462
- * ```
14463
- *
14464
- * @see {@link RenewalEvent} - The TypeScript type definition
14465
- * @see {@link KEYS_RENEWAL_EVENT} - Array of all keys for this type
14466
- */
14467
- export const KEY_RENEWAL_EVENT_REGISTRATION_EXPIRATION_DATE = 'registration_expiration_date' as keyof RenewalEvent;
14468
-
14469
- /**
14470
- * Array of all RenewalEvent property keys
14471
- *
14472
- * @remarks
14473
- * This constant provides a readonly array containing all valid property keys for RenewalEvent objects.
14474
- * Useful for iteration, validation, and generating dynamic UI components.
14475
- *
14476
- * @example
14477
- * ```typescript
14478
- * // Iterating through all keys
14479
- * for (const key of KEYS_RENEWAL_EVENT) {
14480
- * console.log(`Property: ${key}, Value: ${renewalevent[key]}`);
14481
- * }
14482
- *
14483
- * // Validation
14484
- * const isValidKey = KEYS_RENEWAL_EVENT.includes(someKey);
14485
- * ```
14486
- *
14487
- * @see {@link RenewalEvent} - The TypeScript type definition
14488
- */
14489
- export const KEYS_RENEWAL_EVENT = [
14490
- KEY_RENEWAL_EVENT_REGISTRATION_EXPIRATION_DATE,
14491
- ] as const satisfies (keyof RenewalEvent)[];
14492
-
14493
14391
  /**
14494
14392
  * source property
14495
14393
  *
@@ -15671,158 +15569,6 @@ export const KEYS_TRADEMARK_CLAIMS_BASE = [
15671
15569
  KEY_TRADEMARK_CLAIMS_BASE_TMCH_REQUIRED,
15672
15570
  ] as const satisfies (keyof TrademarkClaimsBase)[];
15673
15571
 
15674
- /**
15675
- * Current Registrar
15676
- *
15677
- *
15678
- * @type {string}
15679
- *
15680
- *
15681
- * @remarks
15682
- * This key constant provides type-safe access to the `current_registrar` property of TransferEvent objects.
15683
- * Use this constant when you need to access properties dynamically or ensure type safety.
15684
- *
15685
- * @example
15686
- * ```typescript
15687
- * // Direct property access
15688
- * const value = transferevent[KEY_TRANSFER_EVENT_CURRENT_REGISTRAR];
15689
- *
15690
- * // Dynamic property access
15691
- * const propertyName = KEY_TRANSFER_EVENT_CURRENT_REGISTRAR;
15692
- * const value = transferevent[propertyName];
15693
- * ```
15694
- *
15695
- * @see {@link TransferEvent} - The TypeScript type definition
15696
- * @see {@link KEYS_TRANSFER_EVENT} - Array of all keys for this type
15697
- */
15698
- export const KEY_TRANSFER_EVENT_CURRENT_REGISTRAR = 'current_registrar' as keyof TransferEvent;
15699
- /**
15700
- * execution_date property
15701
- *
15702
- *
15703
- *
15704
- *
15705
- * @remarks
15706
- * This key constant provides type-safe access to the `execution_date` property of TransferEvent objects.
15707
- * Use this constant when you need to access properties dynamically or ensure type safety.
15708
- *
15709
- * @example
15710
- * ```typescript
15711
- * // Direct property access
15712
- * const value = transferevent[KEY_TRANSFER_EVENT_EXECUTION_DATE];
15713
- *
15714
- * // Dynamic property access
15715
- * const propertyName = KEY_TRANSFER_EVENT_EXECUTION_DATE;
15716
- * const value = transferevent[propertyName];
15717
- * ```
15718
- *
15719
- * @see {@link TransferEvent} - The TypeScript type definition
15720
- * @see {@link KEYS_TRANSFER_EVENT} - Array of all keys for this type
15721
- */
15722
- export const KEY_TRANSFER_EVENT_EXECUTION_DATE = 'execution_date' as keyof TransferEvent;
15723
- /**
15724
- * expiration_date property
15725
- *
15726
- *
15727
- *
15728
- *
15729
- * @remarks
15730
- * This key constant provides type-safe access to the `expiration_date` property of TransferEvent objects.
15731
- * Use this constant when you need to access properties dynamically or ensure type safety.
15732
- *
15733
- * @example
15734
- * ```typescript
15735
- * // Direct property access
15736
- * const value = transferevent[KEY_TRANSFER_EVENT_EXPIRATION_DATE];
15737
- *
15738
- * // Dynamic property access
15739
- * const propertyName = KEY_TRANSFER_EVENT_EXPIRATION_DATE;
15740
- * const value = transferevent[propertyName];
15741
- * ```
15742
- *
15743
- * @see {@link TransferEvent} - The TypeScript type definition
15744
- * @see {@link KEYS_TRANSFER_EVENT} - Array of all keys for this type
15745
- */
15746
- export const KEY_TRANSFER_EVENT_EXPIRATION_DATE = 'expiration_date' as keyof TransferEvent;
15747
- /**
15748
- * Message
15749
- *
15750
- *
15751
- * @type {string}
15752
- *
15753
- *
15754
- * @remarks
15755
- * This key constant provides type-safe access to the `message` property of TransferEvent objects.
15756
- * Use this constant when you need to access properties dynamically or ensure type safety.
15757
- *
15758
- * @example
15759
- * ```typescript
15760
- * // Direct property access
15761
- * const value = transferevent[KEY_TRANSFER_EVENT_MESSAGE];
15762
- *
15763
- * // Dynamic property access
15764
- * const propertyName = KEY_TRANSFER_EVENT_MESSAGE;
15765
- * const value = transferevent[propertyName];
15766
- * ```
15767
- *
15768
- * @see {@link TransferEvent} - The TypeScript type definition
15769
- * @see {@link KEYS_TRANSFER_EVENT} - Array of all keys for this type
15770
- */
15771
- export const KEY_TRANSFER_EVENT_MESSAGE = 'message' as keyof TransferEvent;
15772
- /**
15773
- * Requesting Registrar
15774
- *
15775
- *
15776
- * @type {string}
15777
- *
15778
- *
15779
- * @remarks
15780
- * This key constant provides type-safe access to the `requesting_registrar` property of TransferEvent objects.
15781
- * Use this constant when you need to access properties dynamically or ensure type safety.
15782
- *
15783
- * @example
15784
- * ```typescript
15785
- * // Direct property access
15786
- * const value = transferevent[KEY_TRANSFER_EVENT_REQUESTING_REGISTRAR];
15787
- *
15788
- * // Dynamic property access
15789
- * const propertyName = KEY_TRANSFER_EVENT_REQUESTING_REGISTRAR;
15790
- * const value = transferevent[propertyName];
15791
- * ```
15792
- *
15793
- * @see {@link TransferEvent} - The TypeScript type definition
15794
- * @see {@link KEYS_TRANSFER_EVENT} - Array of all keys for this type
15795
- */
15796
- export const KEY_TRANSFER_EVENT_REQUESTING_REGISTRAR = 'requesting_registrar' as keyof TransferEvent;
15797
-
15798
- /**
15799
- * Array of all TransferEvent property keys
15800
- *
15801
- * @remarks
15802
- * This constant provides a readonly array containing all valid property keys for TransferEvent objects.
15803
- * Useful for iteration, validation, and generating dynamic UI components.
15804
- *
15805
- * @example
15806
- * ```typescript
15807
- * // Iterating through all keys
15808
- * for (const key of KEYS_TRANSFER_EVENT) {
15809
- * console.log(`Property: ${key}, Value: ${transferevent[key]}`);
15810
- * }
15811
- *
15812
- * // Validation
15813
- * const isValidKey = KEYS_TRANSFER_EVENT.includes(someKey);
15814
- * ```
15815
- *
15816
- * @see {@link TransferEvent} - The TypeScript type definition
15817
- */
15818
- export const KEYS_TRANSFER_EVENT = [
15819
- KEY_TRANSFER_EVENT_CURRENT_REGISTRAR,
15820
- KEY_TRANSFER_EVENT_EXECUTION_DATE,
15821
- KEY_TRANSFER_EVENT_EXPIRATION_DATE,
15822
- KEY_TRANSFER_EVENT_MESSAGE,
15823
- KEY_TRANSFER_EVENT_REQUESTING_REGISTRAR,
15824
- ] as const satisfies (keyof TransferEvent)[];
15825
-
15826
15572
  /**
15827
15573
  * Authinfo Max Length
15828
15574
  *
@@ -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
  *
@@ -1162,22 +1146,6 @@ export type EmailForwardAliasUpdate = components['schemas']['EmailForwardAliasUp
1162
1146
  * @see {@link components} - The OpenAPI components schema definition
1163
1147
  */
1164
1148
  export type EmailVerificationStatus = components['schemas']['EmailVerificationStatus'];
1165
- /**
1166
- * EmptyEvent
1167
- *
1168
- * @remarks
1169
- * Type alias for the `EmptyEvent` OpenAPI schema.
1170
- * This type represents emptyevent data structures used in API requests and responses.
1171
- *
1172
- * @example
1173
- * ```typescript
1174
- * const response = await api.getEmptyEvent();
1175
- * const item: EmptyEvent = response.results;
1176
- * ```
1177
- *
1178
- * @see {@link components} - The OpenAPI components schema definition
1179
- */
1180
- export type EmptyEvent = components['schemas']['EmptyEvent'];
1181
1149
  /**
1182
1150
  * EppDateTime
1183
1151
  *
@@ -2250,22 +2218,6 @@ export type Relation = components['schemas']['Relation'];
2250
2218
  * @see {@link components} - The OpenAPI components schema definition
2251
2219
  */
2252
2220
  export type RelationSet = components['schemas']['RelationSet'];
2253
- /**
2254
- * RenewalEvent
2255
- *
2256
- * @remarks
2257
- * Type alias for the `RenewalEvent` OpenAPI schema.
2258
- * This type represents renewalevent data structures used in API requests and responses.
2259
- *
2260
- * @example
2261
- * ```typescript
2262
- * const response = await api.getRenewalEvent();
2263
- * const item: RenewalEvent = response.results;
2264
- * ```
2265
- *
2266
- * @see {@link components} - The OpenAPI components schema definition
2267
- */
2268
- export type RenewalEvent = components['schemas']['RenewalEvent'];
2269
2221
  /**
2270
2222
  * RenewalMode
2271
2223
  *
@@ -2522,22 +2474,6 @@ export type TrademarkClaimsBase = components['schemas']['TrademarkClaimsBase'];
2522
2474
  * @see {@link components} - The OpenAPI components schema definition
2523
2475
  */
2524
2476
  export type TransferAckType = components['schemas']['TransferAckType'];
2525
- /**
2526
- * TransferEvent
2527
- *
2528
- * @remarks
2529
- * Type alias for the `TransferEvent` OpenAPI schema.
2530
- * This type represents transferevent data structures used in API requests and responses.
2531
- *
2532
- * @example
2533
- * ```typescript
2534
- * const response = await api.getTransferEvent();
2535
- * const item: TransferEvent = response.results;
2536
- * ```
2537
- *
2538
- * @see {@link components} - The OpenAPI components schema definition
2539
- */
2540
- export type TransferEvent = components['schemas']['TransferEvent'];
2541
2477
  /**
2542
2478
  * TransferPoliciesBase
2543
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
@@ -1914,10 +1906,6 @@ components:
1914
1906
  - canceled
1915
1907
  title: EmailVerificationStatus
1916
1908
  type: string
1917
- EmptyEvent:
1918
- properties: {}
1919
- title: EmptyEvent
1920
- type: object
1921
1909
  EppDateTime:
1922
1910
  anyOf:
1923
1911
  - format: date-time
@@ -1935,12 +1923,8 @@ components:
1935
1923
  EventResponse:
1936
1924
  properties:
1937
1925
  event_data:
1938
- anyOf:
1939
- - $ref: '#/components/schemas/TransferEvent'
1940
- - $ref: '#/components/schemas/DeletedEvent'
1941
- - $ref: '#/components/schemas/RenewalEvent'
1942
- - $ref: '#/components/schemas/EmptyEvent'
1943
1926
  title: Event Data
1927
+ type: object
1944
1928
  event_id:
1945
1929
  examples:
1946
1930
  - epp_event_01h45ytscbebyvny4gc8cr8ma2
@@ -3756,17 +3740,6 @@ components:
3756
3740
  type: array
3757
3741
  title: RelationSet
3758
3742
  type: object
3759
- RenewalEvent:
3760
- properties:
3761
- registration_expiration_date:
3762
- description: The new expiration date/time after the domain has been renewed
3763
- format: date-time
3764
- title: Registration Expiration Date
3765
- type: string
3766
- required:
3767
- - registration_expiration_date
3768
- title: RenewalEvent
3769
- type: object
3770
3743
  RenewalMode:
3771
3744
  enum:
3772
3745
  - renew
@@ -4047,31 +4020,6 @@ components:
4047
4020
  - both
4048
4021
  title: TransferAckType
4049
4022
  type: string
4050
- TransferEvent:
4051
- properties:
4052
- current_registrar:
4053
- title: Current Registrar
4054
- type: string
4055
- execution_date:
4056
- $ref: '#/components/schemas/EppDateTime'
4057
- expiration_date:
4058
- anyOf:
4059
- - $ref: '#/components/schemas/EppDateTime'
4060
- - type: 'null'
4061
- message:
4062
- title: Message
4063
- type: string
4064
- requesting_registrar:
4065
- title: Requesting Registrar
4066
- type: string
4067
- required:
4068
- - execution_date
4069
- - message
4070
- - requesting_registrar
4071
- - current_registrar
4072
- - expiration_date
4073
- title: TransferEvent
4074
- type: object
4075
4023
  TransferPoliciesBase:
4076
4024
  properties:
4077
4025
  authinfo_max_length:
@@ -4856,7 +4804,7 @@ info:
4856
4804
  '
4857
4805
  summary: OpusDNS - your gateway to a seamless domain management experience.
4858
4806
  title: OpusDNS API
4859
- version: 2025-08-15-204923
4807
+ version: 2025-08-15-211010
4860
4808
  x-logo:
4861
4809
  altText: OpusDNS API Reference
4862
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}
@@ -2313,8 +2309,6 @@ export interface components {
2313
2309
  * @enum {string}
2314
2310
  */
2315
2311
  EmailVerificationStatus: "verified" | "pending" | "canceled";
2316
- /** EmptyEvent */
2317
- EmptyEvent: Record<string, never>;
2318
2312
  EppDateTime: Date | string;
2319
2313
  /**
2320
2314
  * EventObjectType
@@ -2324,7 +2318,7 @@ export interface components {
2324
2318
  /** EventResponse */
2325
2319
  EventResponse: {
2326
2320
  /** Event Data */
2327
- event_data: components["schemas"]["TransferEvent"] | components["schemas"]["DeletedEvent"] | components["schemas"]["RenewalEvent"] | components["schemas"]["EmptyEvent"];
2321
+ event_data: Record<string, never>;
2328
2322
  /**
2329
2323
  * Event Id
2330
2324
  * Format: typeid
@@ -3536,15 +3530,6 @@ export interface components {
3536
3530
  /** Relations */
3537
3531
  relations?: components["schemas"]["Relation"][];
3538
3532
  };
3539
- /** RenewalEvent */
3540
- RenewalEvent: {
3541
- /**
3542
- * Registration Expiration Date
3543
- * Format: date-time
3544
- * @description The new expiration date/time after the domain has been renewed
3545
- */
3546
- registration_expiration_date: Date;
3547
- };
3548
3533
  /**
3549
3534
  * RenewalMode
3550
3535
  * @enum {string}
@@ -3714,17 +3699,6 @@ export interface components {
3714
3699
  * @enum {string}
3715
3700
  */
3716
3701
  TransferAckType: "none" | "registrar" | "registrant" | "both";
3717
- /** TransferEvent */
3718
- TransferEvent: {
3719
- /** Current Registrar */
3720
- current_registrar: string;
3721
- execution_date: components["schemas"]["EppDateTime"];
3722
- expiration_date: components["schemas"]["EppDateTime"] | null;
3723
- /** Message */
3724
- message: string;
3725
- /** Requesting Registrar */
3726
- requesting_registrar: string;
3727
- };
3728
3702
  /** TransferPoliciesBase */
3729
3703
  TransferPoliciesBase: {
3730
3704
  /**