@opusdns/api 0.153.0 → 0.155.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 +105 -0
- package/src/openapi.yaml +23 -1
- package/src/schema.d.ts +15 -0
package/package.json
CHANGED
package/src/helpers/keys.ts
CHANGED
|
@@ -8477,6 +8477,31 @@ export const KEY_DOMAIN_LIFECYCLE_BASE_RGP_OPERATIONS: keyof DomainLifecycleBase
|
|
|
8477
8477
|
* @see {@link KEYS_DOMAIN_LIFECYCLE_BASE} - Array of all keys for this type
|
|
8478
8478
|
*/
|
|
8479
8479
|
export const KEY_DOMAIN_LIFECYCLE_BASE_SYNC_AFTER_OPERATIONS: keyof DomainLifecycleBase = 'sync_after_operations';
|
|
8480
|
+
/**
|
|
8481
|
+
* transfer_renewal_periods property
|
|
8482
|
+
*
|
|
8483
|
+
* List of allowed transfer renewal periods (eg. '1y')
|
|
8484
|
+
*
|
|
8485
|
+
*
|
|
8486
|
+
*
|
|
8487
|
+
* @remarks
|
|
8488
|
+
* This key constant provides type-safe access to the `transfer_renewal_periods` property of DomainLifecycleBase objects.
|
|
8489
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
8490
|
+
*
|
|
8491
|
+
* @example
|
|
8492
|
+
* ```typescript
|
|
8493
|
+
* // Direct property access
|
|
8494
|
+
* const value = domainlifecyclebase[KEY_DOMAIN_LIFECYCLE_BASE_TRANSFER_RENEWAL_PERIODS];
|
|
8495
|
+
*
|
|
8496
|
+
* // Dynamic property access
|
|
8497
|
+
* const propertyName = KEY_DOMAIN_LIFECYCLE_BASE_TRANSFER_RENEWAL_PERIODS;
|
|
8498
|
+
* const value = domainlifecyclebase[propertyName];
|
|
8499
|
+
* ```
|
|
8500
|
+
*
|
|
8501
|
+
* @see {@link DomainLifecycleBase} - The TypeScript type definition
|
|
8502
|
+
* @see {@link KEYS_DOMAIN_LIFECYCLE_BASE} - Array of all keys for this type
|
|
8503
|
+
*/
|
|
8504
|
+
export const KEY_DOMAIN_LIFECYCLE_BASE_TRANSFER_RENEWAL_PERIODS: keyof DomainLifecycleBase = 'transfer_renewal_periods';
|
|
8480
8505
|
|
|
8481
8506
|
/**
|
|
8482
8507
|
* Array of all DomainLifecycleBase property keys
|
|
@@ -8512,6 +8537,7 @@ export const KEYS_DOMAIN_LIFECYCLE_BASE = [
|
|
|
8512
8537
|
KEY_DOMAIN_LIFECYCLE_BASE_RENEWAL_PERIODS,
|
|
8513
8538
|
KEY_DOMAIN_LIFECYCLE_BASE_RGP_OPERATIONS,
|
|
8514
8539
|
KEY_DOMAIN_LIFECYCLE_BASE_SYNC_AFTER_OPERATIONS,
|
|
8540
|
+
KEY_DOMAIN_LIFECYCLE_BASE_TRANSFER_RENEWAL_PERIODS,
|
|
8515
8541
|
] as const satisfies (keyof DomainLifecycleBase)[];
|
|
8516
8542
|
|
|
8517
8543
|
/**
|
|
@@ -10582,6 +10608,31 @@ export const KEY_DOMAIN_TRANSFER_IN_NAME: keyof DomainTransferIn = 'name';
|
|
|
10582
10608
|
* @see {@link KEYS_DOMAIN_TRANSFER_IN} - Array of all keys for this type
|
|
10583
10609
|
*/
|
|
10584
10610
|
export const KEY_DOMAIN_TRANSFER_IN_NAMESERVERS: keyof DomainTransferIn = 'nameservers';
|
|
10611
|
+
/**
|
|
10612
|
+
* period property
|
|
10613
|
+
*
|
|
10614
|
+
* Additional registration period to add to the domain upon transfer completion. If omitted, the registry default policy will be applied.
|
|
10615
|
+
*
|
|
10616
|
+
*
|
|
10617
|
+
*
|
|
10618
|
+
* @remarks
|
|
10619
|
+
* This key constant provides type-safe access to the `period` property of DomainTransferIn objects.
|
|
10620
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
10621
|
+
*
|
|
10622
|
+
* @example
|
|
10623
|
+
* ```typescript
|
|
10624
|
+
* // Direct property access
|
|
10625
|
+
* const value = domaintransferin[KEY_DOMAIN_TRANSFER_IN_PERIOD];
|
|
10626
|
+
*
|
|
10627
|
+
* // Dynamic property access
|
|
10628
|
+
* const propertyName = KEY_DOMAIN_TRANSFER_IN_PERIOD;
|
|
10629
|
+
* const value = domaintransferin[propertyName];
|
|
10630
|
+
* ```
|
|
10631
|
+
*
|
|
10632
|
+
* @see {@link DomainTransferIn} - The TypeScript type definition
|
|
10633
|
+
* @see {@link KEYS_DOMAIN_TRANSFER_IN} - Array of all keys for this type
|
|
10634
|
+
*/
|
|
10635
|
+
export const KEY_DOMAIN_TRANSFER_IN_PERIOD: keyof DomainTransferIn = 'period';
|
|
10585
10636
|
/**
|
|
10586
10637
|
* renewal_mode property
|
|
10587
10638
|
*
|
|
@@ -10635,6 +10686,7 @@ export const KEYS_DOMAIN_TRANSFER_IN = [
|
|
|
10635
10686
|
KEY_DOMAIN_TRANSFER_IN_CREATE_ZONE,
|
|
10636
10687
|
KEY_DOMAIN_TRANSFER_IN_NAME,
|
|
10637
10688
|
KEY_DOMAIN_TRANSFER_IN_NAMESERVERS,
|
|
10689
|
+
KEY_DOMAIN_TRANSFER_IN_PERIOD,
|
|
10638
10690
|
KEY_DOMAIN_TRANSFER_IN_RENEWAL_MODE,
|
|
10639
10691
|
] as const satisfies (keyof DomainTransferIn)[];
|
|
10640
10692
|
|
|
@@ -12433,6 +12485,57 @@ export const KEYS_EMAIL_FORWARD_ZONE = [
|
|
|
12433
12485
|
KEY_EMAIL_FORWARD_ZONE_ZONE_NAME,
|
|
12434
12486
|
] as const satisfies (keyof EmailForwardZone)[];
|
|
12435
12487
|
|
|
12488
|
+
/**
|
|
12489
|
+
* Acknowledged On
|
|
12490
|
+
*
|
|
12491
|
+
* When the event was acknowledged
|
|
12492
|
+
*
|
|
12493
|
+
*
|
|
12494
|
+
*
|
|
12495
|
+
* @remarks
|
|
12496
|
+
* This key constant provides type-safe access to the `acknowledged_on` property of EventResponse objects.
|
|
12497
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
12498
|
+
*
|
|
12499
|
+
* @example
|
|
12500
|
+
* ```typescript
|
|
12501
|
+
* // Direct property access
|
|
12502
|
+
* const value = eventresponse[KEY_EVENT_RESPONSE_ACKNOWLEDGED_ON];
|
|
12503
|
+
*
|
|
12504
|
+
* // Dynamic property access
|
|
12505
|
+
* const propertyName = KEY_EVENT_RESPONSE_ACKNOWLEDGED_ON;
|
|
12506
|
+
* const value = eventresponse[propertyName];
|
|
12507
|
+
* ```
|
|
12508
|
+
*
|
|
12509
|
+
* @see {@link EventResponse} - The TypeScript type definition
|
|
12510
|
+
* @see {@link KEYS_EVENT_RESPONSE} - Array of all keys for this type
|
|
12511
|
+
*/
|
|
12512
|
+
export const KEY_EVENT_RESPONSE_ACKNOWLEDGED_ON: keyof EventResponse = 'acknowledged_on';
|
|
12513
|
+
/**
|
|
12514
|
+
* Created On
|
|
12515
|
+
*
|
|
12516
|
+
* When the event was created
|
|
12517
|
+
*
|
|
12518
|
+
* @type {string}
|
|
12519
|
+
*
|
|
12520
|
+
*
|
|
12521
|
+
* @remarks
|
|
12522
|
+
* This key constant provides type-safe access to the `created_on` property of EventResponse objects.
|
|
12523
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
12524
|
+
*
|
|
12525
|
+
* @example
|
|
12526
|
+
* ```typescript
|
|
12527
|
+
* // Direct property access
|
|
12528
|
+
* const value = eventresponse[KEY_EVENT_RESPONSE_CREATED_ON];
|
|
12529
|
+
*
|
|
12530
|
+
* // Dynamic property access
|
|
12531
|
+
* const propertyName = KEY_EVENT_RESPONSE_CREATED_ON;
|
|
12532
|
+
* const value = eventresponse[propertyName];
|
|
12533
|
+
* ```
|
|
12534
|
+
*
|
|
12535
|
+
* @see {@link EventResponse} - The TypeScript type definition
|
|
12536
|
+
* @see {@link KEYS_EVENT_RESPONSE} - Array of all keys for this type
|
|
12537
|
+
*/
|
|
12538
|
+
export const KEY_EVENT_RESPONSE_CREATED_ON: keyof EventResponse = 'created_on';
|
|
12436
12539
|
/**
|
|
12437
12540
|
* Event Data
|
|
12438
12541
|
*
|
|
@@ -12605,6 +12708,8 @@ export const KEY_EVENT_RESPONSE_TYPE: keyof EventResponse = 'type';
|
|
|
12605
12708
|
* @see {@link EventResponse} - The TypeScript type definition
|
|
12606
12709
|
*/
|
|
12607
12710
|
export const KEYS_EVENT_RESPONSE = [
|
|
12711
|
+
KEY_EVENT_RESPONSE_ACKNOWLEDGED_ON,
|
|
12712
|
+
KEY_EVENT_RESPONSE_CREATED_ON,
|
|
12608
12713
|
KEY_EVENT_RESPONSE_EVENT_DATA,
|
|
12609
12714
|
KEY_EVENT_RESPONSE_EVENT_ID,
|
|
12610
12715
|
KEY_EVENT_RESPONSE_OBJECT_ID,
|
package/src/openapi.yaml
CHANGED
|
@@ -2025,6 +2025,9 @@ components:
|
|
|
2025
2025
|
- type: 'null'
|
|
2026
2026
|
description: Operations that trigger a sync with the registry
|
|
2027
2027
|
title: Sync After Operations
|
|
2028
|
+
transfer_renewal_periods:
|
|
2029
|
+
$ref: '#/components/schemas/PeriodList'
|
|
2030
|
+
description: List of allowed transfer renewal periods (eg. '1y')
|
|
2028
2031
|
title: DomainLifecycleBase
|
|
2029
2032
|
type: object
|
|
2030
2033
|
DomainNameParts:
|
|
@@ -2537,6 +2540,12 @@ components:
|
|
|
2537
2540
|
- type: 'null'
|
|
2538
2541
|
description: The name servers for the domain
|
|
2539
2542
|
title: Nameservers
|
|
2543
|
+
period:
|
|
2544
|
+
anyOf:
|
|
2545
|
+
- $ref: '#/components/schemas/DomainPeriod'
|
|
2546
|
+
- type: 'null'
|
|
2547
|
+
description: Additional registration period to add to the domain upon transfer
|
|
2548
|
+
completion. If omitted, the registry default policy will be applied.
|
|
2540
2549
|
renewal_mode:
|
|
2541
2550
|
$ref: '#/components/schemas/RenewalMode'
|
|
2542
2551
|
description: The renewal mode of the domain
|
|
@@ -2996,6 +3005,18 @@ components:
|
|
|
2996
3005
|
type: string
|
|
2997
3006
|
EventResponse:
|
|
2998
3007
|
properties:
|
|
3008
|
+
acknowledged_on:
|
|
3009
|
+
anyOf:
|
|
3010
|
+
- format: date-time
|
|
3011
|
+
type: string
|
|
3012
|
+
- type: 'null'
|
|
3013
|
+
description: When the event was acknowledged
|
|
3014
|
+
title: Acknowledged On
|
|
3015
|
+
created_on:
|
|
3016
|
+
description: When the event was created
|
|
3017
|
+
format: date-time
|
|
3018
|
+
title: Created On
|
|
3019
|
+
type: string
|
|
2999
3020
|
event_data:
|
|
3000
3021
|
additionalProperties: true
|
|
3001
3022
|
title: Event Data
|
|
@@ -3033,6 +3054,7 @@ components:
|
|
|
3033
3054
|
(e.g., 'ACCOUNT_CREATE', 'DOMAIN_MODIFICATION')
|
|
3034
3055
|
required:
|
|
3035
3056
|
- event_data
|
|
3057
|
+
- created_on
|
|
3036
3058
|
title: EventResponse
|
|
3037
3059
|
type: object
|
|
3038
3060
|
EventSchema:
|
|
@@ -6528,7 +6550,7 @@ info:
|
|
|
6528
6550
|
'
|
|
6529
6551
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
6530
6552
|
title: OpusDNS API
|
|
6531
|
-
version: 2026-01-
|
|
6553
|
+
version: 2026-01-13-160651
|
|
6532
6554
|
x-logo:
|
|
6533
6555
|
altText: OpusDNS API Reference
|
|
6534
6556
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
package/src/schema.d.ts
CHANGED
|
@@ -3047,6 +3047,8 @@ export interface components {
|
|
|
3047
3047
|
* @description Operations that trigger a sync with the registry
|
|
3048
3048
|
*/
|
|
3049
3049
|
sync_after_operations?: components["schemas"]["SyncOperationType"][] | null;
|
|
3050
|
+
/** @description List of allowed transfer renewal periods (eg. '1y') */
|
|
3051
|
+
transfer_renewal_periods?: components["schemas"]["PeriodList"];
|
|
3050
3052
|
};
|
|
3051
3053
|
/** DomainNameParts */
|
|
3052
3054
|
DomainNameParts: {
|
|
@@ -3407,6 +3409,8 @@ export interface components {
|
|
|
3407
3409
|
* @description The name servers for the domain
|
|
3408
3410
|
*/
|
|
3409
3411
|
nameservers?: components["schemas"]["Nameserver"][] | null;
|
|
3412
|
+
/** @description Additional registration period to add to the domain upon transfer completion. If omitted, the registry default policy will be applied. */
|
|
3413
|
+
period?: components["schemas"]["DomainPeriod"] | null;
|
|
3410
3414
|
/** @description The renewal mode of the domain */
|
|
3411
3415
|
renewal_mode: components["schemas"]["RenewalMode"];
|
|
3412
3416
|
};
|
|
@@ -3738,6 +3742,17 @@ export interface components {
|
|
|
3738
3742
|
EventObjectType: "DOMAIN" | "CONTACT" | "HOST" | "RAW" | "UNKNOWN";
|
|
3739
3743
|
/** EventResponse */
|
|
3740
3744
|
EventResponse: {
|
|
3745
|
+
/**
|
|
3746
|
+
* Acknowledged On
|
|
3747
|
+
* @description When the event was acknowledged
|
|
3748
|
+
*/
|
|
3749
|
+
acknowledged_on?: Date | null;
|
|
3750
|
+
/**
|
|
3751
|
+
* Created On
|
|
3752
|
+
* Format: date-time
|
|
3753
|
+
* @description When the event was created
|
|
3754
|
+
*/
|
|
3755
|
+
created_on: Date;
|
|
3741
3756
|
/** Event Data */
|
|
3742
3757
|
event_data: {
|
|
3743
3758
|
[key: string]: unknown;
|