@opusdns/api 0.12.1 → 0.14.0

package/package.json

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

package/src/helpers/keys.ts

@@ -59,6 +59,7 @@ import { DnsZoneRecordsPatchOps } from './schemas';
 import { DnsZone } from './schemas';
 import { DnsZoneRrsetsCreate } from './schemas';
 import { DnsZoneRrsetsPatchOps } from './schemas';
+import { DnsZoneSummary } from './schemas';
 import { DomainAvailability } from './schemas';
 import { DomainAvailabilityMeta } from './schemas';
 import { DomainCheck } from './schemas';
@@ -4589,6 +4590,84 @@ export const KEYS_DNS_ZONE_RRSETS_PATCH_OPS = [
   KEY_DNS_ZONE_RRSETS_PATCH_OPS_OPS,
 ] as const satisfies (keyof DnsZoneRrsetsPatchOps)[];
 
+/**
+ * Total Zones
+ *
+ * Total number of DNS zones
+ *
+ * @type {integer}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `total_zones` property of DnsZoneSummary objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = dnszonesummary[KEY_DNS_ZONE_SUMMARY_TOTAL_ZONES];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_DNS_ZONE_SUMMARY_TOTAL_ZONES;
+ * const value = dnszonesummary[propertyName];
+ * ```
+ *
+ * @see {@link DnsZoneSummary} - The TypeScript type definition
+ * @see {@link KEYS_DNS_ZONE_SUMMARY} - Array of all keys for this type
+ */
+export const KEY_DNS_ZONE_SUMMARY_TOTAL_ZONES = 'total_zones' as keyof DnsZoneSummary;
+/**
+ * Zones By Dnssec
+ *
+ * Count of zones by DNSSEC status
+ *
+ * @type {object}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `zones_by_dnssec` property of DnsZoneSummary objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = dnszonesummary[KEY_DNS_ZONE_SUMMARY_ZONES_BY_DNSSEC];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_DNS_ZONE_SUMMARY_ZONES_BY_DNSSEC;
+ * const value = dnszonesummary[propertyName];
+ * ```
+ *
+ * @see {@link DnsZoneSummary} - The TypeScript type definition
+ * @see {@link KEYS_DNS_ZONE_SUMMARY} - Array of all keys for this type
+ */
+export const KEY_DNS_ZONE_SUMMARY_ZONES_BY_DNSSEC = 'zones_by_dnssec' as keyof DnsZoneSummary;
+
+/**
+ * Array of all DnsZoneSummary property keys
+ *
+ * @remarks
+ * This constant provides a readonly array containing all valid property keys for DnsZoneSummary objects.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all keys
+ * for (const key of KEYS_DNS_ZONE_SUMMARY) {
+ *   console.log(`Property: ${key}, Value: ${dnszonesummary[key]}`);
+ * }
+ * 
+ * // Validation
+ * const isValidKey = KEYS_DNS_ZONE_SUMMARY.includes(someKey);
+ * ```
+ *
+ * @see {@link DnsZoneSummary} - The TypeScript type definition
+ */
+export const KEYS_DNS_ZONE_SUMMARY = [
+  KEY_DNS_ZONE_SUMMARY_TOTAL_ZONES,
+  KEY_DNS_ZONE_SUMMARY_ZONES_BY_DNSSEC,
+] as const satisfies (keyof DnsZoneSummary)[];
+
 /**
  * Domain
  *

package/src/helpers/requests.d.ts

@@ -884,6 +884,28 @@ export type POST_Dns_Request = {
  */
 export type POST_Dns_Request_Body = POST_Dns_Request['requestBody'];
 
+/**
+ * Request type for GET DnsSummary endpoint
+ *
+ * Get Zones Summary
+ *
+ * @remarks
+ * This type defines the complete request structure for the GET DnsSummary endpoint.
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
+ * Use this type to ensure type safety when making API requests to this endpoint.
+ *
+ * @example
+ * Use this type to ensure type safety when making API requests to this endpoint.
+ *
+ * @path /v1/dns/summary
+ *
+ * @see {@link GET_DnsSummary_Request_Query} - Query parameters type
+ * @see {@link GET_DnsSummary_Request_Path} - Path parameters type
+ * @see {@link GET_DnsSummary_Request_Body} - Request body type
+ */
+export type GET_DnsSummary_Request = {
+}
+
 /**
  * Request type for DELETE DnsZoneName endpoint
  *

package/src/helpers/responses.d.ts

@@ -34,7 +34,7 @@
 
 import { DomainDnssecDataArray, OrganizationAttribute2Array, IpRestrictionArray, TldResponseShortArray } from './schemas-arrays.d';
 
-import { Pagination_OrganizationCredential, Problem, HTTPValidationError, OrganizationCredentialCreated, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainCheck, DomainSummary, Pagination_EmailForward, EmailForward, EmailForwardBulkDeleteResult, EmailForwardBulkUpdateResult, Pagination_Event, EventSchema, Pagination_UserNotificationSummary, Notification, UserNotification, Pagination_Organization, Organization, OrganizationWithPlan, IpRestriction, Pagination_User, TldSpecification, User, UserWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
+import { Pagination_OrganizationCredential, Problem, HTTPValidationError, OrganizationCredentialCreated, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DnsZoneSummary, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainCheck, DomainSummary, Pagination_EmailForward, EmailForward, EmailForwardBulkDeleteResult, EmailForwardBulkUpdateResult, Pagination_Event, EventSchema, Pagination_UserNotificationSummary, Notification, UserNotification, Pagination_Organization, Organization, OrganizationWithPlan, IpRestriction, Pagination_User, TldSpecification, User, UserWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
 
 /**
  * Response types for GET AuthClientCredentials endpoint
@@ -1925,6 +1925,43 @@ export type PUT_DnsByZoneNameRrsets_Response = PUT_DnsByZoneNameRrsets_Response_
  */
 export type PUT_DnsByZoneNameRrsets_Response_422 = HTTPValidationError
 
+/**
+ * Response types for GET DnsSummary endpoint
+ *
+ * Get Zones Summary
+ *
+ * @remarks
+ * This type defines all possible response structures for the GET DnsSummary endpoint.
+ * Each response code maps to a specific response type as defined in the OpenAPI specification.
+ * Use this type to ensure type safety when handling API responses from this endpoint.
+ *
+
+ *
+ * @path /v1/dns/summary
+ *
+ * @see {@link GET_DnsSummary_Response_200} - 200 response type
+ *
+
+ */
+export type GET_DnsSummary_Response = GET_DnsSummary_Response_200;
+
+/**
+ * 200 response for GET DnsSummary endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 200 status code
+ * of the GET DnsSummary endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/dns/summary
+ *
+ * @see {@link GET_DnsSummary_Response} - The main response type definition
+ * @see {@link DnsZoneSummary} - The actual schema type definition
+ */
+export type GET_DnsSummary_Response_200 = DnsZoneSummary
+
 /**
  * Response types for GET DomainSearchSuggest endpoint
  *

package/src/helpers/schemas.d.ts

@@ -650,6 +650,22 @@ export type DnsZoneRrsetsCreate = components['schemas']['DnsZoneRrsetsCreate'];
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type DnsZoneRrsetsPatchOps = components['schemas']['DnsZoneRrsetsPatchOps'];
+/**
+ * DnsZoneSummary
+ *
+ * @remarks
+ * Type alias for the `DnsZoneSummary` OpenAPI schema.
+ * This type represents dnszonesummary data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getDnsZoneSummary();
+ * const item: DnsZoneSummary = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type DnsZoneSummary = components['schemas']['DnsZoneSummary'];
 /**
  * DnssecAlgorithm
  *

package/src/openapi.yaml

@@ -1030,6 +1030,24 @@ components:
       - ops
       title: DnsZoneRrsetsPatchOps
       type: object
+    DnsZoneSummary:
+      properties:
+        total_zones:
+          description: Total number of DNS zones
+          title: Total Zones
+          type: integer
+        zones_by_dnssec:
+          additionalProperties:
+            type: integer
+          description: Count of zones by DNSSEC status
+          propertyNames:
+            $ref: '#/components/schemas/DnssecStatus'
+          title: Zones By Dnssec
+          type: object
+      required:
+      - total_zones
+      title: DnsZoneSummary
+      type: object
     DnssecAlgorithm:
       enum:
       - 1
@@ -4953,7 +4971,7 @@ info:
     '
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2025-07-31-235405
+  version: 2025-08-01-144457
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -6229,6 +6247,21 @@ paths:
       summary: Create Zone
       tags:
       - dns
+  /v1/dns/summary:
+    get:
+      operationId: get_zones_summary_v1_dns_summary_get
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/DnsZoneSummary'
+          description: Successful Response
+      security:
+      - OAuth2PasswordBearer: []
+      summary: Get Zones Summary
+      tags:
+      - dns
   /v1/dns/{zone_name}:
     delete:
       operationId: delete_zone_v1_dns__zone_name__delete
@@ -6670,6 +6703,30 @@ paths:
             type: string
           - type: 'null'
           title: Expires Before
+      - in: query
+        name: expires_in_30_days
+        required: false
+        schema:
+          anyOf:
+          - type: boolean
+          - type: 'null'
+          title: Expires In 30 Days
+      - in: query
+        name: expires_in_60_days
+        required: false
+        schema:
+          anyOf:
+          - type: boolean
+          - type: 'null'
+          title: Expires In 60 Days
+      - in: query
+        name: expires_in_90_days
+        required: false
+        schema:
+          anyOf:
+          - type: boolean
+          - type: 'null'
+          title: Expires In 90 Days
       - in: query
         name: registered_after
         required: false

package/src/schema.d.ts

@@ -282,6 +282,23 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/dns/summary": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Get Zones Summary */
+        get: operations["get_zones_summary_v1_dns_summary_get"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/dns/{zone_name}": {
         parameters: {
             query?: never;
@@ -1740,6 +1757,21 @@ export interface components {
             /** Ops */
             ops: components["schemas"]["DnsRrsetPatchOp"][];
         };
+        /** DnsZoneSummary */
+        DnsZoneSummary: {
+            /**
+             * Total Zones
+             * @description Total number of DNS zones
+             */
+            total_zones: number;
+            /**
+             * Zones By Dnssec
+             * @description Count of zones by DNSSEC status
+             */
+            zones_by_dnssec?: {
+                [key: string]: number;
+            };
+        };
         /**
          * DnssecAlgorithm
          * @enum {integer}
@@ -5483,6 +5515,26 @@ export interface operations {
             };
         };
     };
+    get_zones_summary_v1_dns_summary_get: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["DnsZoneSummary"];
+                };
+            };
+        };
+    };
     get_zone_v1_dns__zone_name__get: {
         parameters: {
             query?: never;
@@ -5801,6 +5853,9 @@ export interface operations {
                 updated_before?: Date | null;
                 expires_after?: Date | null;
                 expires_before?: Date | null;
+                expires_in_30_days?: boolean | null;
+                expires_in_60_days?: boolean | null;
+                expires_in_90_days?: boolean | null;
                 registered_after?: Date | null;
                 registered_before?: Date | null;
             };