@opusdns/api 0.8.0 → 0.9.0

package/package.json

@@ -8,7 +8,7 @@
     "typescript": "^5.8.2"
   },
   "name": "@opusdns/api",
-  "version": "0.8.0",
+  "version": "0.9.0",
   "description": "TypeScript types for the OpusDNS OpenAPI specification",
   "main": "src/schema.d.ts",
   "types": "src/schema.d.ts",

package/src/openapi.yaml

@@ -1438,6 +1438,53 @@ components:
       - clientHold
       title: DomainStatus
       type: string
+    DomainSummaryData:
+      properties:
+        by_status:
+          additionalProperties:
+            type: integer
+          description: 'Domain counts by status (status: count)'
+          title: By Status
+          type: object
+        by_tld:
+          additionalProperties:
+            type: integer
+          description: 'Domain counts by TLD (tld: count)'
+          title: By Tld
+          type: object
+        expiring_soon:
+          $ref: '#/components/schemas/DomainsExpiringSoon'
+          description: Domains expiring soon
+        total_count:
+          description: Total number of domains
+          title: Total Count
+          type: integer
+      required:
+      - total_count
+      - by_status
+      - by_tld
+      - expiring_soon
+      title: DomainSummaryData
+      type: object
+    DomainSummaryResponse:
+      properties:
+        domains:
+          $ref: '#/components/schemas/DomainSummaryData'
+          description: Domain summary data
+        organization_id:
+          description: The organization ID
+          examples:
+          - organization_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: Organization Id
+          type: string
+          x-typeid-prefix: organization
+      required:
+      - organization_id
+      - domains
+      title: DomainSummaryResponse
+      type: object
     DomainTransferIn:
       properties:
         auth_code:
@@ -1528,6 +1575,26 @@ components:
           title: Statuses
       title: DomainUpdate
       type: object
+    DomainsExpiringSoon:
+      properties:
+        next_30_days:
+          description: Number of domains expiring in the next 30 days
+          title: Next 30 Days
+          type: integer
+        next_60_days:
+          description: Number of domains expiring in the next 60 days
+          title: Next 60 Days
+          type: integer
+        next_90_days:
+          description: Number of domains expiring in the next 90 days
+          title: Next 90 Days
+          type: integer
+      required:
+      - next_30_days
+      - next_60_days
+      - next_90_days
+      title: DomainsExpiringSoon
+      type: object
     EmailForward:
       properties:
         created_on:
@@ -3997,7 +4064,7 @@ info:
     '
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2025-07-24-074916
+  version: 2025-07-25-140023
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -5835,6 +5902,23 @@ paths:
       summary: Check domain availability
       tags:
       - domain
+  /v1/domains/summary:
+    get:
+      description: Retrieves a summary of domains including counts by status, TLD,
+        and expiration timeframes
+      operationId: get_domain_summary_v1_domains_summary_get
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/DomainSummaryResponse'
+          description: Successful Response
+      security:
+      - OAuth2PasswordBearer: []
+      summary: Get domain summary
+      tags:
+      - domain
   /v1/domains/transfer:
     post:
       description: 'Start the transfer process for a domain <br>

package/src/schema.d.ts

@@ -410,6 +410,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/domains/summary": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get domain summary
+         * @description Retrieves a summary of domains including counts by status, TLD, and expiration timeframes
+         */
+        get: operations["get_domain_summary_v1_domains_summary_get"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/domains/transfer": {
         parameters: {
             query?: never;
@@ -1904,6 +1924,41 @@ export interface components {
          * @enum {string}
          */
         DomainStatus: "ok" | "serverTransferProhibited" | "serverUpdateProhibited" | "serverDeleteProhibited" | "serverRenewProhibited" | "serverHold" | "transferPeriod" | "renewPeriod" | "redemptionPeriod" | "pendingUpdate" | "pendingTransfer" | "pendingRestore" | "pendingRenew" | "pendingDelete" | "pendingCreate" | "inactive" | "autoRenewPeriod" | "addPeriod" | "deleted" | "clientTransferProhibited" | "clientUpdateProhibited" | "clientDeleteProhibited" | "clientRenewProhibited" | "clientHold";
+        /** DomainSummaryData */
+        DomainSummaryData: {
+            /**
+             * By Status
+             * @description Domain counts by status (status: count)
+             */
+            by_status: {
+                [key: string]: number;
+            };
+            /**
+             * By Tld
+             * @description Domain counts by TLD (tld: count)
+             */
+            by_tld: {
+                [key: string]: number;
+            };
+            /** @description Domains expiring soon */
+            expiring_soon: components["schemas"]["DomainsExpiringSoon"];
+            /**
+             * Total Count
+             * @description Total number of domains
+             */
+            total_count: number;
+        };
+        /** DomainSummaryResponse */
+        DomainSummaryResponse: {
+            /** @description Domain summary data */
+            domains: components["schemas"]["DomainSummaryData"];
+            /**
+             * Organization Id
+             * Format: typeid
+             * @description The organization ID
+             */
+            organization_id: TypeID<"organization">;
+        };
         /** DomainTransferIn */
         DomainTransferIn: {
             /**
@@ -1952,6 +2007,24 @@ export interface components {
              */
             statuses?: components["schemas"]["DomainClientStatus"][] | null;
         };
+        /** DomainsExpiringSoon */
+        DomainsExpiringSoon: {
+            /**
+             * Next 30 Days
+             * @description Number of domains expiring in the next 30 days
+             */
+            next_30_days: number;
+            /**
+             * Next 60 Days
+             * @description Number of domains expiring in the next 60 days
+             */
+            next_60_days: number;
+            /**
+             * Next 90 Days
+             * @description Number of domains expiring in the next 90 days
+             */
+            next_90_days: number;
+        };
         /** EmailForward */
         EmailForward: {
             /**
@@ -4939,6 +5012,26 @@ export interface operations {
             };
         };
     };
+    get_domain_summary_v1_domains_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"]["DomainSummaryResponse"];
+                };
+            };
+        };
+    };
     transfer_domain_v1_domains_transfer_post: {
         parameters: {
             query?: never;

package/src/types/constants.ts

@@ -1,6 +1,6 @@
 /**
  * Auto-generated enums from OpenAPI schema
- * Generated on: 2025-07-24T07:50:32.358Z
+ * Generated on: 2025-07-25T14:03:33.604Z
  */
 
 /**

package/src/types/keys.ts

@@ -17,6 +17,7 @@ import { Get_Domains_Response_V1 } from './types';
 import { Get_DomainsBydomainReference_Response_V1 } from './types';
 import { Get_DomainsCheck_Response_V1 } from './types';
 import { Get_DomainSearchSuggest_Response_V1 } from './types';
+import { Get_DomainsSummary_Response_V1 } from './types';
 import { Get_EmailForwards_Response_V1 } from './types';
 import { Get_EmailForwardsByemailForwardId_Response_V1 } from './types';
 import { Get_Event_Response_V1 } from './types';
@@ -50,6 +51,7 @@ import { DnsZone } from './types';
 import { DomainCheck } from './types';
 import { Domain } from './types';
 import { DomainSearch } from './types';
+import { DomainSummary } from './types';
 import { EmailForward } from './types';
 import { EventSchema } from './types';
 import { IpRestriction } from './types';
@@ -258,6 +260,14 @@ export const GET_DOMAIN_SEARCH_SUGGEST_RESPONSE_V1_KEYS = [
   GET_DOMAIN_SEARCH_SUGGEST_RESPONSE_V1_KEY_RESULTS,
 ] as const;
 
+export const GET_DOMAINS_SUMMARY_RESPONSE_V1_KEY_DOMAINS = 'domains' as keyof Get_DomainsSummary_Response_V1;
+export const GET_DOMAINS_SUMMARY_RESPONSE_V1_KEY_ORGANIZATION_ID = 'organization_id' as keyof Get_DomainsSummary_Response_V1;
+
+export const GET_DOMAINS_SUMMARY_RESPONSE_V1_KEYS = [
+  GET_DOMAINS_SUMMARY_RESPONSE_V1_KEY_DOMAINS,
+  GET_DOMAINS_SUMMARY_RESPONSE_V1_KEY_ORGANIZATION_ID,
+] as const;
+
 export const GET_EMAIL_FORWARDS_RESPONSE_V1_KEY_PAGINATION = 'pagination' as keyof Get_EmailForwards_Response_V1;
 export const GET_EMAIL_FORWARDS_RESPONSE_V1_KEY_RESULTS = 'results' as keyof Get_EmailForwards_Response_V1;
 
@@ -974,6 +984,14 @@ export const DOMAIN_SEARCH_KEYS = [
   DOMAIN_SEARCH_KEY_RESULTS,
 ] as const;
 
+export const DOMAIN_SUMMARY_KEY_DOMAINS = 'domains' as keyof DomainSummary;
+export const DOMAIN_SUMMARY_KEY_ORGANIZATION_ID = 'organization_id' as keyof DomainSummary;
+
+export const DOMAIN_SUMMARY_KEYS = [
+  DOMAIN_SUMMARY_KEY_DOMAINS,
+  DOMAIN_SUMMARY_KEY_ORGANIZATION_ID,
+] as const;
+
 export const EMAIL_FORWARD_KEY_CREATED_ON = 'created_on' as keyof EmailForward;
 export const EMAIL_FORWARD_KEY_EMAIL_FORWARD_ID = 'email_forward_id' as keyof EmailForward;
 export const EMAIL_FORWARD_KEY_SOURCE_ADDRESS = 'source_address' as keyof EmailForward;

package/src/types/types.ts

@@ -23,6 +23,7 @@ export type Get_Domains_Response_V1 = components['schemas']['Pagination_DomainRe
 export type Get_DomainsBydomainReference_Response_V1 = components['schemas']['DomainResponse'];
 export type Get_DomainsCheck_Response_V1 = components['schemas']['DomainCheckResponse'];
 export type Get_DomainSearchSuggest_Response_V1 = components['schemas']['DomainSearchResponse'];
+export type Get_DomainsSummary_Response_V1 = components['schemas']['DomainSummaryResponse'];
 export type Get_EmailForwards_Response_V1 = components['schemas']['Pagination_EmailForward_'];
 export type Get_EmailForwardsByemailForwardId_Response_V1 = components['schemas']['EmailForward'];
 export type Get_Event_Response_V1 = components['schemas']['Pagination_EventResponse_'];
@@ -151,6 +152,7 @@ export type DomainNameserversArray = Domain['nameservers'];
 export type DomainRegistry_statusesArray = Domain['registry_statuses'];
 export type DomainSearch = components['schemas']['DomainSearchResponse'];
 export type DomainSearchResultsArray = DomainSearch['results'];
+export type DomainSummary = components['schemas']['DomainSummaryResponse'];
 export type EmailForward = components['schemas']['EmailForward'];
 export type EventSchema = components['schemas']['EventSchema'];
 export type IpRestriction = components['schemas']['IpRestrictionResponse'];