@opusdns/api 0.19.0 → 0.20.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 +52 -0
- package/src/helpers/schemas.d.ts +32 -0
- package/src/openapi.yaml +18 -1
- package/src/schema.d.ts +12 -1
package/package.json
CHANGED
package/src/helpers/keys.ts
CHANGED
|
@@ -118,6 +118,7 @@ import { Problem } from './schemas';
|
|
|
118
118
|
import { RdapBase } from './schemas';
|
|
119
119
|
import { RegistryLockBase } from './schemas';
|
|
120
120
|
import { RelationSet } from './schemas';
|
|
121
|
+
import { RenewalEvent } from './schemas';
|
|
121
122
|
import { ReservedDomainsBase } from './schemas';
|
|
122
123
|
import { RgpOperations } from './schemas';
|
|
123
124
|
import { SignupCreate } from './schemas';
|
|
@@ -14438,6 +14439,57 @@ export const KEYS_RELATION_SET = [
|
|
|
14438
14439
|
KEY_RELATION_SET_RELATIONS,
|
|
14439
14440
|
] as const satisfies (keyof RelationSet)[];
|
|
14440
14441
|
|
|
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
|
+
|
|
14441
14493
|
/**
|
|
14442
14494
|
* source property
|
|
14443
14495
|
*
|
package/src/helpers/schemas.d.ts
CHANGED
|
@@ -1162,6 +1162,22 @@ export type EmailForwardAliasUpdate = components['schemas']['EmailForwardAliasUp
|
|
|
1162
1162
|
* @see {@link components} - The OpenAPI components schema definition
|
|
1163
1163
|
*/
|
|
1164
1164
|
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'];
|
|
1165
1181
|
/**
|
|
1166
1182
|
* EppDateTime
|
|
1167
1183
|
*
|
|
@@ -2234,6 +2250,22 @@ export type Relation = components['schemas']['Relation'];
|
|
|
2234
2250
|
* @see {@link components} - The OpenAPI components schema definition
|
|
2235
2251
|
*/
|
|
2236
2252
|
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'];
|
|
2237
2269
|
/**
|
|
2238
2270
|
* RenewalMode
|
|
2239
2271
|
*
|
package/src/openapi.yaml
CHANGED
|
@@ -1914,6 +1914,10 @@ components:
|
|
|
1914
1914
|
- canceled
|
|
1915
1915
|
title: EmailVerificationStatus
|
|
1916
1916
|
type: string
|
|
1917
|
+
EmptyEvent:
|
|
1918
|
+
properties: {}
|
|
1919
|
+
title: EmptyEvent
|
|
1920
|
+
type: object
|
|
1917
1921
|
EppDateTime:
|
|
1918
1922
|
anyOf:
|
|
1919
1923
|
- format: date-time
|
|
@@ -1934,6 +1938,8 @@ components:
|
|
|
1934
1938
|
anyOf:
|
|
1935
1939
|
- $ref: '#/components/schemas/TransferEvent'
|
|
1936
1940
|
- $ref: '#/components/schemas/DeletedEvent'
|
|
1941
|
+
- $ref: '#/components/schemas/RenewalEvent'
|
|
1942
|
+
- $ref: '#/components/schemas/EmptyEvent'
|
|
1937
1943
|
title: Event Data
|
|
1938
1944
|
event_id:
|
|
1939
1945
|
examples:
|
|
@@ -3750,6 +3756,17 @@ components:
|
|
|
3750
3756
|
type: array
|
|
3751
3757
|
title: RelationSet
|
|
3752
3758
|
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
|
|
3753
3770
|
RenewalMode:
|
|
3754
3771
|
enum:
|
|
3755
3772
|
- renew
|
|
@@ -4839,7 +4856,7 @@ info:
|
|
|
4839
4856
|
'
|
|
4840
4857
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
4841
4858
|
title: OpusDNS API
|
|
4842
|
-
version: 2025-08-15-
|
|
4859
|
+
version: 2025-08-15-204923
|
|
4843
4860
|
x-logo:
|
|
4844
4861
|
altText: OpusDNS API Reference
|
|
4845
4862
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
package/src/schema.d.ts
CHANGED
|
@@ -2313,6 +2313,8 @@ export interface components {
|
|
|
2313
2313
|
* @enum {string}
|
|
2314
2314
|
*/
|
|
2315
2315
|
EmailVerificationStatus: "verified" | "pending" | "canceled";
|
|
2316
|
+
/** EmptyEvent */
|
|
2317
|
+
EmptyEvent: Record<string, never>;
|
|
2316
2318
|
EppDateTime: Date | string;
|
|
2317
2319
|
/**
|
|
2318
2320
|
* EventObjectType
|
|
@@ -2322,7 +2324,7 @@ export interface components {
|
|
|
2322
2324
|
/** EventResponse */
|
|
2323
2325
|
EventResponse: {
|
|
2324
2326
|
/** Event Data */
|
|
2325
|
-
event_data: components["schemas"]["TransferEvent"] | components["schemas"]["DeletedEvent"];
|
|
2327
|
+
event_data: components["schemas"]["TransferEvent"] | components["schemas"]["DeletedEvent"] | components["schemas"]["RenewalEvent"] | components["schemas"]["EmptyEvent"];
|
|
2326
2328
|
/**
|
|
2327
2329
|
* Event Id
|
|
2328
2330
|
* Format: typeid
|
|
@@ -3534,6 +3536,15 @@ export interface components {
|
|
|
3534
3536
|
/** Relations */
|
|
3535
3537
|
relations?: components["schemas"]["Relation"][];
|
|
3536
3538
|
};
|
|
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
|
+
};
|
|
3537
3548
|
/**
|
|
3538
3549
|
* RenewalMode
|
|
3539
3550
|
* @enum {string}
|