@opusdns/api 0.18.0 → 0.20.0

package/package.json

@@ -8,7 +8,7 @@
     "typescript": "^5.8.2"
   },
   "name": "@opusdns/api",
-  "version": "0.18.0",
+  "version": "0.20.0",
   "description": "TypeScript types for the OpusDNS OpenAPI specification",
   "main": "./src/index.ts",
   "module": "./src/index.ts",

package/src/helpers/keys.ts

@@ -118,6 +118,7 @@ import { Problem } from './schemas';
 import { RdapBase } from './schemas';
 import { RegistryLockBase } from './schemas';
 import { RelationSet } from './schemas';
+import { RenewalEvent } from './schemas';
 import { ReservedDomainsBase } from './schemas';
 import { RgpOperations } from './schemas';
 import { SignupCreate } from './schemas';
@@ -14438,6 +14439,57 @@ export const KEYS_RELATION_SET = [
   KEY_RELATION_SET_RELATIONS,
 ] as const satisfies (keyof RelationSet)[];
 
+/**
+ * Registration Expiration Date
+ *
+ * The new expiration date/time after the domain has been renewed
+ *
+ * @type {string}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `registration_expiration_date` property of RenewalEvent objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = renewalevent[KEY_RENEWAL_EVENT_REGISTRATION_EXPIRATION_DATE];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_RENEWAL_EVENT_REGISTRATION_EXPIRATION_DATE;
+ * const value = renewalevent[propertyName];
+ * ```
+ *
+ * @see {@link RenewalEvent} - The TypeScript type definition
+ * @see {@link KEYS_RENEWAL_EVENT} - Array of all keys for this type
+ */
+export const KEY_RENEWAL_EVENT_REGISTRATION_EXPIRATION_DATE = 'registration_expiration_date' as keyof RenewalEvent;
+
+/**
+ * Array of all RenewalEvent property keys
+ *
+ * @remarks
+ * This constant provides a readonly array containing all valid property keys for RenewalEvent objects.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all keys
+ * for (const key of KEYS_RENEWAL_EVENT) {
+ *   console.log(`Property: ${key}, Value: ${renewalevent[key]}`);
+ * }
+ * 
+ * // Validation
+ * const isValidKey = KEYS_RENEWAL_EVENT.includes(someKey);
+ * ```
+ *
+ * @see {@link RenewalEvent} - The TypeScript type definition
+ */
+export const KEYS_RENEWAL_EVENT = [
+  KEY_RENEWAL_EVENT_REGISTRATION_EXPIRATION_DATE,
+] as const satisfies (keyof RenewalEvent)[];
+
 /**
  * source property
  *

package/src/helpers/schemas.d.ts

@@ -1162,6 +1162,22 @@ export type EmailForwardAliasUpdate = components['schemas']['EmailForwardAliasUp
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type EmailVerificationStatus = components['schemas']['EmailVerificationStatus'];
+/**
+ * EmptyEvent
+ *
+ * @remarks
+ * Type alias for the `EmptyEvent` OpenAPI schema.
+ * This type represents emptyevent data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getEmptyEvent();
+ * const item: EmptyEvent = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type EmptyEvent = components['schemas']['EmptyEvent'];
 /**
  * EppDateTime
  *
@@ -2234,6 +2250,22 @@ export type Relation = components['schemas']['Relation'];
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type RelationSet = components['schemas']['RelationSet'];
+/**
+ * RenewalEvent
+ *
+ * @remarks
+ * Type alias for the `RenewalEvent` OpenAPI schema.
+ * This type represents renewalevent data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getRenewalEvent();
+ * const item: RenewalEvent = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type RenewalEvent = components['schemas']['RenewalEvent'];
 /**
  * RenewalMode
  *

package/src/openapi.yaml

@@ -1914,6 +1914,10 @@ components:
       - canceled
       title: EmailVerificationStatus
       type: string
+    EmptyEvent:
+      properties: {}
+      title: EmptyEvent
+      type: object
     EppDateTime:
       anyOf:
       - format: date-time
@@ -1934,6 +1938,8 @@ components:
           anyOf:
           - $ref: '#/components/schemas/TransferEvent'
           - $ref: '#/components/schemas/DeletedEvent'
+          - $ref: '#/components/schemas/RenewalEvent'
+          - $ref: '#/components/schemas/EmptyEvent'
           title: Event Data
         event_id:
           examples:
@@ -3750,6 +3756,17 @@ components:
           type: array
       title: RelationSet
       type: object
+    RenewalEvent:
+      properties:
+        registration_expiration_date:
+          description: The new expiration date/time after the domain has been renewed
+          format: date-time
+          title: Registration Expiration Date
+          type: string
+      required:
+      - registration_expiration_date
+      title: RenewalEvent
+      type: object
     RenewalMode:
       enum:
       - renew
@@ -4839,7 +4856,7 @@ info:
     '
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2025-08-13-193514
+  version: 2025-08-15-204923
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -5289,23 +5306,6 @@ paths:
       description: List all contacts
       operationId: get_contacts_v1_contacts_get
       parameters:
-      - in: query
-        name: page
-        required: false
-        schema:
-          default: 1
-          minimum: 1
-          title: Page
-          type: integer
-      - in: query
-        name: page_size
-        required: false
-        schema:
-          default: 10
-          maximum: 100
-          minimum: 1
-          title: Page Size
-          type: integer
       - in: query
         name: sort_by
         required: false
@@ -5376,6 +5376,23 @@ paths:
             type: string
           - type: 'null'
           title: Created Before
+      - in: query
+        name: page
+        required: false
+        schema:
+          default: 1
+          minimum: 1
+          title: Page
+          type: integer
+      - in: query
+        name: page_size
+        required: false
+        schema:
+          default: 10
+          maximum: 100
+          minimum: 1
+          title: Page Size
+          type: integer
       responses:
         '200':
           content:
@@ -5971,23 +5988,6 @@ paths:
     get:
       operationId: list_zones_v1_dns_get
       parameters:
-      - in: query
-        name: page
-        required: false
-        schema:
-          default: 1
-          minimum: 1
-          title: Page
-          type: integer
-      - in: query
-        name: page_size
-        required: false
-        schema:
-          default: 10
-          maximum: 100
-          minimum: 1
-          title: Page Size
-          type: integer
       - in: query
         name: sort_by
         required: false
@@ -6068,6 +6068,23 @@ paths:
             type: string
           - type: 'null'
           title: Updated Before
+      - in: query
+        name: page
+        required: false
+        schema:
+          default: 1
+          minimum: 1
+          title: Page
+          type: integer
+      - in: query
+        name: page_size
+        required: false
+        schema:
+          default: 10
+          maximum: 100
+          minimum: 1
+          title: Page Size
+          type: integer
       responses:
         '200':
           content:
@@ -6448,23 +6465,6 @@ paths:
       description: Retrieves a paginated list of all domains
       operationId: get_domains_v1_domains_get
       parameters:
-      - in: query
-        name: page
-        required: false
-        schema:
-          default: 1
-          minimum: 1
-          title: Page
-          type: integer
-      - in: query
-        name: page_size
-        required: false
-        schema:
-          default: 10
-          maximum: 100
-          minimum: 1
-          title: Page Size
-          type: integer
       - in: query
         name: sort_by
         required: false
@@ -6613,6 +6613,23 @@ paths:
             type: string
           - type: 'null'
           title: Registered Before
+      - in: query
+        name: page
+        required: false
+        schema:
+          default: 1
+          minimum: 1
+          title: Page
+          type: integer
+      - in: query
+        name: page_size
+        required: false
+        schema:
+          default: 10
+          maximum: 100
+          minimum: 1
+          title: Page Size
+          type: integer
       responses:
         '200':
           content:

package/src/schema.d.ts

@@ -2313,6 +2313,8 @@ export interface components {
          * @enum {string}
          */
         EmailVerificationStatus: "verified" | "pending" | "canceled";
+        /** EmptyEvent */
+        EmptyEvent: Record<string, never>;
         EppDateTime: Date | string;
         /**
          * EventObjectType
@@ -2322,7 +2324,7 @@ export interface components {
         /** EventResponse */
         EventResponse: {
             /** Event Data */
-            event_data: components["schemas"]["TransferEvent"] | components["schemas"]["DeletedEvent"];
+            event_data: components["schemas"]["TransferEvent"] | components["schemas"]["DeletedEvent"] | components["schemas"]["RenewalEvent"] | components["schemas"]["EmptyEvent"];
             /**
              * Event Id
              * Format: typeid
@@ -3534,6 +3536,15 @@ export interface components {
             /** Relations */
             relations?: components["schemas"]["Relation"][];
         };
+        /** RenewalEvent */
+        RenewalEvent: {
+            /**
+             * Registration Expiration Date
+             * Format: date-time
+             * @description The new expiration date/time after the domain has been renewed
+             */
+            registration_expiration_date: Date;
+        };
         /**
          * RenewalMode
          * @enum {string}
@@ -4681,8 +4692,6 @@ export interface operations {
     get_contacts_v1_contacts_get: {
         parameters: {
             query?: {
-                page?: number;
-                page_size?: number;
                 sort_by?: components["schemas"]["ContactSortField"];
                 sort_order?: components["schemas"]["SortOrder"];
                 first_name?: string | null;
@@ -4692,6 +4701,8 @@ export interface operations {
                 country?: string | null;
                 created_after?: Date | null;
                 created_before?: Date | null;
+                page?: number;
+                page_size?: number;
             };
             header?: never;
             path?: never;
@@ -5355,8 +5366,6 @@ export interface operations {
     list_zones_v1_dns_get: {
         parameters: {
             query?: {
-                page?: number;
-                page_size?: number;
                 sort_by?: components["schemas"]["ZoneSortField"];
                 sort_order?: components["schemas"]["SortOrder"];
                 dnssec_status?: components["schemas"]["DnssecStatus"] | null;
@@ -5367,6 +5376,8 @@ export interface operations {
                 created_before?: Date | null;
                 updated_after?: Date | null;
                 updated_before?: Date | null;
+                page?: number;
+                page_size?: number;
             };
             header?: never;
             path?: never;
@@ -5750,8 +5761,6 @@ export interface operations {
     get_domains_v1_domains_get: {
         parameters: {
             query?: {
-                page?: number;
-                page_size?: number;
                 sort_by?: components["schemas"]["DomainSortField"];
                 sort_order?: components["schemas"]["SortOrder"];
                 name?: string | null;
@@ -5770,6 +5779,8 @@ export interface operations {
                 expires_in_90_days?: boolean | null;
                 registered_after?: Date | null;
                 registered_before?: Date | null;
+                page?: number;
+                page_size?: number;
             };
             header?: never;
             path?: never;