@opusdns/api 1.178.0 → 1.180.0

package/package.json

@@ -3,7 +3,7 @@
     "@opusdns/api-spec-ts-generator": "^1.6.0"
   },
   "name": "@opusdns/api",
-  "version": "1.178.0",
+  "version": "1.180.0",
   "description": "TypeScript types for the OpusDNS OpenAPI specification",
   "main": "./src/index.ts",
   "module": "./src/index.ts",

package/src/helpers/keys.ts

@@ -193,7 +193,7 @@ import type {
   DomainSearch,
   DomainSearchSuggestionPriceData,
   DomainSearchSuggestionWithPrice,
-  DomainStatisticsBreakdown2,
+  DomainStatisticsBreakdownRow,
   DomainStatisticsBucket,
   DomainStatistics,
   DomainStatisticsTotals,
@@ -2783,34 +2783,55 @@ export const KEYS_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE = [
   KEY_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE_RENEWAL_PRICE,
 ] as const satisfies (keyof DomainSearchSuggestionWithPrice)[];
 
-export const KEY_DOMAIN_STATISTICS_BREAKDOWN2_CREATE = 'create' satisfies keyof DomainStatisticsBreakdown2;
-export const KEY_DOMAIN_STATISTICS_BREAKDOWN2_KEY = 'key' satisfies keyof DomainStatisticsBreakdown2;
-export const KEY_DOMAIN_STATISTICS_BREAKDOWN2_LABEL = 'label' satisfies keyof DomainStatisticsBreakdown2;
-export const KEY_DOMAIN_STATISTICS_BREAKDOWN2_TOTAL = 'total' satisfies keyof DomainStatisticsBreakdown2;
-export const KEY_DOMAIN_STATISTICS_BREAKDOWN2_TRANSFER = 'transfer' satisfies keyof DomainStatisticsBreakdown2;
-
-export const KEYS_DOMAIN_STATISTICS_BREAKDOWN2 = [
-  KEY_DOMAIN_STATISTICS_BREAKDOWN2_CREATE,
-  KEY_DOMAIN_STATISTICS_BREAKDOWN2_KEY,
-  KEY_DOMAIN_STATISTICS_BREAKDOWN2_LABEL,
-  KEY_DOMAIN_STATISTICS_BREAKDOWN2_TOTAL,
-  KEY_DOMAIN_STATISTICS_BREAKDOWN2_TRANSFER,
-] as const satisfies (keyof DomainStatisticsBreakdown2)[];
+export const KEY_DOMAIN_STATISTICS_BREAKDOWN_ROW_CREATE = 'create' satisfies keyof DomainStatisticsBreakdownRow;
+export const KEY_DOMAIN_STATISTICS_BREAKDOWN_ROW_DELETE = 'delete' satisfies keyof DomainStatisticsBreakdownRow;
+export const KEY_DOMAIN_STATISTICS_BREAKDOWN_ROW_KEY = 'key' satisfies keyof DomainStatisticsBreakdownRow;
+export const KEY_DOMAIN_STATISTICS_BREAKDOWN_ROW_LABEL = 'label' satisfies keyof DomainStatisticsBreakdownRow;
+export const KEY_DOMAIN_STATISTICS_BREAKDOWN_ROW_NET = 'net' satisfies keyof DomainStatisticsBreakdownRow;
+export const KEY_DOMAIN_STATISTICS_BREAKDOWN_ROW_RENEW = 'renew' satisfies keyof DomainStatisticsBreakdownRow;
+export const KEY_DOMAIN_STATISTICS_BREAKDOWN_ROW_RESTORE = 'restore' satisfies keyof DomainStatisticsBreakdownRow;
+export const KEY_DOMAIN_STATISTICS_BREAKDOWN_ROW_TOTAL = 'total' satisfies keyof DomainStatisticsBreakdownRow;
+export const KEY_DOMAIN_STATISTICS_BREAKDOWN_ROW_TRANSFER = 'transfer' satisfies keyof DomainStatisticsBreakdownRow;
+export const KEY_DOMAIN_STATISTICS_BREAKDOWN_ROW_TRANSFER_OUT = 'transfer_out' satisfies keyof DomainStatisticsBreakdownRow;
+
+export const KEYS_DOMAIN_STATISTICS_BREAKDOWN_ROW = [
+  KEY_DOMAIN_STATISTICS_BREAKDOWN_ROW_CREATE,
+  KEY_DOMAIN_STATISTICS_BREAKDOWN_ROW_DELETE,
+  KEY_DOMAIN_STATISTICS_BREAKDOWN_ROW_KEY,
+  KEY_DOMAIN_STATISTICS_BREAKDOWN_ROW_LABEL,
+  KEY_DOMAIN_STATISTICS_BREAKDOWN_ROW_NET,
+  KEY_DOMAIN_STATISTICS_BREAKDOWN_ROW_RENEW,
+  KEY_DOMAIN_STATISTICS_BREAKDOWN_ROW_RESTORE,
+  KEY_DOMAIN_STATISTICS_BREAKDOWN_ROW_TOTAL,
+  KEY_DOMAIN_STATISTICS_BREAKDOWN_ROW_TRANSFER,
+  KEY_DOMAIN_STATISTICS_BREAKDOWN_ROW_TRANSFER_OUT,
+] as const satisfies (keyof DomainStatisticsBreakdownRow)[];
 
 export const KEY_DOMAIN_STATISTICS_BUCKET_CREATE = 'create' satisfies keyof DomainStatisticsBucket;
+export const KEY_DOMAIN_STATISTICS_BUCKET_DELETE = 'delete' satisfies keyof DomainStatisticsBucket;
+export const KEY_DOMAIN_STATISTICS_BUCKET_NET = 'net' satisfies keyof DomainStatisticsBucket;
 export const KEY_DOMAIN_STATISTICS_BUCKET_PARTIAL = 'partial' satisfies keyof DomainStatisticsBucket;
 export const KEY_DOMAIN_STATISTICS_BUCKET_PERIOD_START = 'period_start' satisfies keyof DomainStatisticsBucket;
+export const KEY_DOMAIN_STATISTICS_BUCKET_RENEW = 'renew' satisfies keyof DomainStatisticsBucket;
+export const KEY_DOMAIN_STATISTICS_BUCKET_RESTORE = 'restore' satisfies keyof DomainStatisticsBucket;
 export const KEY_DOMAIN_STATISTICS_BUCKET_TRANSFER = 'transfer' satisfies keyof DomainStatisticsBucket;
+export const KEY_DOMAIN_STATISTICS_BUCKET_TRANSFER_OUT = 'transfer_out' satisfies keyof DomainStatisticsBucket;
 
 export const KEYS_DOMAIN_STATISTICS_BUCKET = [
   KEY_DOMAIN_STATISTICS_BUCKET_CREATE,
+  KEY_DOMAIN_STATISTICS_BUCKET_DELETE,
+  KEY_DOMAIN_STATISTICS_BUCKET_NET,
   KEY_DOMAIN_STATISTICS_BUCKET_PARTIAL,
   KEY_DOMAIN_STATISTICS_BUCKET_PERIOD_START,
+  KEY_DOMAIN_STATISTICS_BUCKET_RENEW,
+  KEY_DOMAIN_STATISTICS_BUCKET_RESTORE,
   KEY_DOMAIN_STATISTICS_BUCKET_TRANSFER,
+  KEY_DOMAIN_STATISTICS_BUCKET_TRANSFER_OUT,
 ] as const satisfies (keyof DomainStatisticsBucket)[];
 
 export const KEY_DOMAIN_STATISTICS_BREAKDOWN = 'breakdown' satisfies keyof DomainStatistics;
 export const KEY_DOMAIN_STATISTICS_BUCKETS = 'buckets' satisfies keyof DomainStatistics;
+export const KEY_DOMAIN_STATISTICS_DATA_AVAILABLE_FROM = 'data_available_from' satisfies keyof DomainStatistics;
 export const KEY_DOMAIN_STATISTICS_END_DATE = 'end_date' satisfies keyof DomainStatistics;
 export const KEY_DOMAIN_STATISTICS_GRANULARITY = 'granularity' satisfies keyof DomainStatistics;
 export const KEY_DOMAIN_STATISTICS_ORGANIZATION_ID = 'organization_id' satisfies keyof DomainStatistics;
@@ -2820,6 +2841,7 @@ export const KEY_DOMAIN_STATISTICS_TOTALS = 'totals' satisfies keyof DomainStati
 export const KEYS_DOMAIN_STATISTICS = [
   KEY_DOMAIN_STATISTICS_BREAKDOWN,
   KEY_DOMAIN_STATISTICS_BUCKETS,
+  KEY_DOMAIN_STATISTICS_DATA_AVAILABLE_FROM,
   KEY_DOMAIN_STATISTICS_END_DATE,
   KEY_DOMAIN_STATISTICS_GRANULARITY,
   KEY_DOMAIN_STATISTICS_ORGANIZATION_ID,
@@ -2828,13 +2850,23 @@ export const KEYS_DOMAIN_STATISTICS = [
 ] as const satisfies (keyof DomainStatistics)[];
 
 export const KEY_DOMAIN_STATISTICS_TOTALS_CREATE = 'create' satisfies keyof DomainStatisticsTotals;
+export const KEY_DOMAIN_STATISTICS_TOTALS_DELETE = 'delete' satisfies keyof DomainStatisticsTotals;
+export const KEY_DOMAIN_STATISTICS_TOTALS_NET = 'net' satisfies keyof DomainStatisticsTotals;
+export const KEY_DOMAIN_STATISTICS_TOTALS_RENEW = 'renew' satisfies keyof DomainStatisticsTotals;
+export const KEY_DOMAIN_STATISTICS_TOTALS_RESTORE = 'restore' satisfies keyof DomainStatisticsTotals;
 export const KEY_DOMAIN_STATISTICS_TOTALS_TOTAL = 'total' satisfies keyof DomainStatisticsTotals;
 export const KEY_DOMAIN_STATISTICS_TOTALS_TRANSFER = 'transfer' satisfies keyof DomainStatisticsTotals;
+export const KEY_DOMAIN_STATISTICS_TOTALS_TRANSFER_OUT = 'transfer_out' satisfies keyof DomainStatisticsTotals;
 
 export const KEYS_DOMAIN_STATISTICS_TOTALS = [
   KEY_DOMAIN_STATISTICS_TOTALS_CREATE,
+  KEY_DOMAIN_STATISTICS_TOTALS_DELETE,
+  KEY_DOMAIN_STATISTICS_TOTALS_NET,
+  KEY_DOMAIN_STATISTICS_TOTALS_RENEW,
+  KEY_DOMAIN_STATISTICS_TOTALS_RESTORE,
   KEY_DOMAIN_STATISTICS_TOTALS_TOTAL,
   KEY_DOMAIN_STATISTICS_TOTALS_TRANSFER,
+  KEY_DOMAIN_STATISTICS_TOTALS_TRANSFER_OUT,
 ] as const satisfies (keyof DomainStatisticsTotals)[];
 
 export const KEY_DOMAIN_STATUS2_STATUS = 'status' satisfies keyof DomainStatus2;

package/src/helpers/schemas.d.ts

@@ -239,7 +239,7 @@ export type DomainSearchSuggestionPriceData = components['schemas']['DomainSearc
 export type DomainSearchSuggestionWithPrice = components['schemas']['DomainSearchSuggestionWithPrice'];
 export type DomainSortField = components['schemas']['DomainSortField'];
 export type DomainStatisticsBreakdown = components['schemas']['DomainStatisticsBreakdown'];
-export type DomainStatisticsBreakdown2 = components['schemas']['DomainStatisticsBreakdownResponse'];
+export type DomainStatisticsBreakdownRow = components['schemas']['DomainStatisticsBreakdownRowResponse'];
 export type DomainStatisticsBucket = components['schemas']['DomainStatisticsBucketResponse'];
 export type DomainStatistics = components['schemas']['DomainStatisticsResponse'];
 export type DomainStatisticsTotals = components['schemas']['DomainStatisticsTotalsResponse'];

package/src/openapi.yaml

@@ -6170,11 +6170,14 @@ components:
       - tld
       title: DomainStatisticsBreakdown
       type: string
-    DomainStatisticsBreakdownResponse:
+    DomainStatisticsBreakdownRowResponse:
       properties:
         create:
           title: Create
           type: integer
+        delete:
+          title: Delete
+          type: integer
         key:
           description: Organization id, or the TLD without the leading dot
           title: Key
@@ -6185,19 +6188,39 @@ components:
           - type: 'null'
           description: Organization name; absent for TLD rows
           title: Label
+        net:
+          description: Created plus transferred in, minus deleted and transferred
+            out
+          title: Net
+          type: integer
+        renew:
+          title: Renew
+          type: integer
+        restore:
+          title: Restore
+          type: integer
         total:
+          description: Created plus transferred
           title: Total
           type: integer
         transfer:
           title: Transfer
           type: integer
+        transfer_out:
+          title: Transfer Out
+          type: integer
       required:
       - key
       - label
       - create
       - transfer
       - total
-      title: DomainStatisticsBreakdownResponse
+      - delete
+      - transfer_out
+      - renew
+      - restore
+      - net
+      title: DomainStatisticsBreakdownRowResponse
       type: object
     DomainStatisticsBucketResponse:
       properties:
@@ -6205,6 +6228,15 @@ components:
           description: Domains created in this bucket
           title: Create
           type: integer
+        delete:
+          description: Domains deleted in this bucket
+          title: Delete
+          type: integer
+        net:
+          description: Created plus transferred in, minus deleted and transferred
+            out
+          title: Net
+          type: integer
         partial:
           description: The bucket reaches outside the requested window, so its counts
             cover only part of its span and must not be read as a rise or fall against
@@ -6216,14 +6248,31 @@ components:
           format: date
           title: Period Start
           type: string
+        renew:
+          description: Domain renewals in this bucket
+          title: Renew
+          type: integer
+        restore:
+          description: Domains restored in this bucket
+          title: Restore
+          type: integer
         transfer:
           description: Domains transferred in during this bucket
           title: Transfer
           type: integer
+        transfer_out:
+          description: Domains transferred away during this bucket
+          title: Transfer Out
+          type: integer
       required:
       - period_start
       - create
       - transfer
+      - delete
+      - transfer_out
+      - renew
+      - restore
+      - net
       - partial
       title: DomainStatisticsBucketResponse
       type: object
@@ -6233,7 +6282,7 @@ components:
           description: Top organizations or TLDs by acquisitions in the window; empty
             unless requested
           items:
-            $ref: '#/components/schemas/DomainStatisticsBreakdownResponse'
+            $ref: '#/components/schemas/DomainStatisticsBreakdownRowResponse'
           title: Breakdown
           type: array
         buckets:
@@ -6243,6 +6292,16 @@ components:
             $ref: '#/components/schemas/DomainStatisticsBucketResponse'
           title: Buckets
           type: array
+        data_available_from:
+          anyOf:
+          - format: date-time
+            type: string
+          - type: 'null'
+          description: Oldest day these statistics can report on. They are read from
+            the domain event log, which starts later than the domains themselves,
+            so a window reaching further back is empty before this instant rather
+            than zero.
+          title: Data Available From
         end_date:
           description: Last day of the window, inclusive
           format: date
@@ -6275,6 +6334,7 @@ components:
       - totals
       - buckets
       - breakdown
+      - data_available_from
       title: DomainStatisticsResponse
       type: object
     DomainStatisticsTotalsResponse:
@@ -6283,6 +6343,24 @@ components:
           description: Domains created (newly registered) in the window
           title: Create
           type: integer
+        delete:
+          description: Domains deleted in the window
+          title: Delete
+          type: integer
+        net:
+          description: Created plus transferred in, minus deleted and transferred
+            out
+          title: Net
+          type: integer
+        renew:
+          description: Domains renewed in the window, counted once per day a domain
+            was renewed
+          title: Renew
+          type: integer
+        restore:
+          description: Domains restored from redemption in the window
+          title: Restore
+          type: integer
         total:
           description: Created plus transferred
           title: Total
@@ -6291,10 +6369,19 @@ components:
           description: Domains transferred to OpusDNS in the window
           title: Transfer
           type: integer
+        transfer_out:
+          description: Domains transferred away from OpusDNS in the window
+          title: Transfer Out
+          type: integer
       required:
       - create
       - transfer
       - total
+      - delete
+      - transfer_out
+      - renew
+      - restore
+      - net
       title: DomainStatisticsTotalsResponse
       type: object
     DomainStatus:
@@ -16949,7 +17036,7 @@ info:
     \n\n"
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2026-09-14-120239
+  version: 2026-09-14-164748
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -25541,9 +25628,11 @@ paths:
       - domains:manage
   /v1/domains/statistics:
     get:
-      description: 'Counts the domains your organization acquired in a window of whole
-        days, split into creates (new registrations) and inbound transfers and bucketed
-        by the requested granularity.
+      description: 'Counts the domains that moved in or out of your organization''s
+        portfolio in a window of whole days, bucketed by the requested granularity:
+        creates (new registrations), inbound transfers, deletes, outbound transfers,
+        renewals and restores, plus `net` (created and transferred in, minus deleted
+        and transferred out).
 
 
         Counts cover your organization and its sub-organizations, like the domain
@@ -25551,12 +25640,20 @@ paths:
         is counted on the day OpusDNS took the order and a transfer on the day it
         completed, so domains that have since been deleted still appear in the window
         they were acquired in. Imported domains count as creates on the day they were
-        imported. Domains held at a connected external registrar are not included.
+        imported. Renewals and restores are counted once per day a domain was renewed
+        or restored, so a domain renewed in two different months counts in both. Domains
+        held at a connected external registrar are not included.
 
 
         Every bucket the window touches is present, so the series can be charted as
         is. A bucket marked `partial` reaches outside the window and covers only part
-        of its span.'
+        of its span.
+
+
+        These counts are read from the domain event log, which begins later than the
+        domains themselves. `data_available_from` reports the oldest event it holds:
+        a window reaching further back is empty before that instant rather than genuinely
+        zero.'
       operationId: get_domain_statistics_v1_domains_statistics_get
       parameters:
       - in: query

package/src/schema.d.ts

@@ -1185,11 +1185,13 @@ export interface paths {
         };
         /**
          * Get domain statistics
-         * @description Counts the domains your organization acquired in a window of whole days, split into creates (new registrations) and inbound transfers and bucketed by the requested granularity.
+         * @description Counts the domains that moved in or out of your organization's portfolio in a window of whole days, bucketed by the requested granularity: creates (new registrations), inbound transfers, deletes, outbound transfers, renewals and restores, plus `net` (created and transferred in, minus deleted and transferred out).
          *
-         *     Counts cover your organization and its sub-organizations, like the domain summary; `breakdown=organization` shows how they divide between them. A create is counted on the day OpusDNS took the order and a transfer on the day it completed, so domains that have since been deleted still appear in the window they were acquired in. Imported domains count as creates on the day they were imported. Domains held at a connected external registrar are not included.
+         *     Counts cover your organization and its sub-organizations, like the domain summary; `breakdown=organization` shows how they divide between them. A create is counted on the day OpusDNS took the order and a transfer on the day it completed, so domains that have since been deleted still appear in the window they were acquired in. Imported domains count as creates on the day they were imported. Renewals and restores are counted once per day a domain was renewed or restored, so a domain renewed in two different months counts in both. Domains held at a connected external registrar are not included.
          *
          *     Every bucket the window touches is present, so the series can be charted as is. A bucket marked `partial` reaches outside the window and covers only part of its span.
+         *
+         *     These counts are read from the domain event log, which begins later than the domains themselves. `data_available_from` reports the oldest event it holds: a window reaching further back is empty before that instant rather than genuinely zero.
          */
         get: operations["get_domain_statistics_v1_domains_statistics_get"];
         put?: never;
@@ -7200,10 +7202,12 @@ export interface components {
          * @enum {string}
          */
         DomainStatisticsBreakdown: "none" | "organization" | "tld";
-        /** DomainStatisticsBreakdownResponse */
-        DomainStatisticsBreakdownResponse: {
+        /** DomainStatisticsBreakdownRowResponse */
+        DomainStatisticsBreakdownRowResponse: {
             /** Create */
             create: number;
+            /** Delete */
+            delete: number;
             /**
              * Key
              * @description Organization id, or the TLD without the leading dot
@@ -7214,10 +7218,24 @@ export interface components {
              * @description Organization name; absent for TLD rows
              */
             label: string | null;
-            /** Total */
+            /**
+             * Net
+             * @description Created plus transferred in, minus deleted and transferred out
+             */
+            net: number;
+            /** Renew */
+            renew: number;
+            /** Restore */
+            restore: number;
+            /**
+             * Total
+             * @description Created plus transferred
+             */
             total: number;
             /** Transfer */
             transfer: number;
+            /** Transfer Out */
+            transfer_out: number;
         };
         /** DomainStatisticsBucketResponse */
         DomainStatisticsBucketResponse: {
@@ -7226,6 +7244,16 @@ export interface components {
              * @description Domains created in this bucket
              */
             create: number;
+            /**
+             * Delete
+             * @description Domains deleted in this bucket
+             */
+            delete: number;
+            /**
+             * Net
+             * @description Created plus transferred in, minus deleted and transferred out
+             */
+            net: number;
             /**
              * Partial
              * @description The bucket reaches outside the requested window, so its counts cover only part of its span and must not be read as a rise or fall against its neighbours
@@ -7237,11 +7265,26 @@ export interface components {
              * @description First day of the bucket (UTC)
              */
             period_start: string;
+            /**
+             * Renew
+             * @description Domain renewals in this bucket
+             */
+            renew: number;
+            /**
+             * Restore
+             * @description Domains restored in this bucket
+             */
+            restore: number;
             /**
              * Transfer
              * @description Domains transferred in during this bucket
              */
             transfer: number;
+            /**
+             * Transfer Out
+             * @description Domains transferred away during this bucket
+             */
+            transfer_out: number;
         };
         /** DomainStatisticsResponse */
         DomainStatisticsResponse: {
@@ -7249,12 +7292,17 @@ export interface components {
              * Breakdown
              * @description Top organizations or TLDs by acquisitions in the window; empty unless requested
              */
-            breakdown: components["schemas"]["DomainStatisticsBreakdownResponse"][];
+            breakdown: components["schemas"]["DomainStatisticsBreakdownRowResponse"][];
             /**
              * Buckets
              * @description One entry per bucket the window touches, oldest first, including empty buckets
              */
             buckets: components["schemas"]["DomainStatisticsBucketResponse"][];
+            /**
+             * Data Available From
+             * @description Oldest day these statistics can report on. They are read from the domain event log, which starts later than the domains themselves, so a window reaching further back is empty before this instant rather than zero.
+             */
+            data_available_from: Date | null;
             /**
              * End Date
              * Format: date
@@ -7285,6 +7333,26 @@ export interface components {
              * @description Domains created (newly registered) in the window
              */
             create: number;
+            /**
+             * Delete
+             * @description Domains deleted in the window
+             */
+            delete: number;
+            /**
+             * Net
+             * @description Created plus transferred in, minus deleted and transferred out
+             */
+            net: number;
+            /**
+             * Renew
+             * @description Domains renewed in the window, counted once per day a domain was renewed
+             */
+            renew: number;
+            /**
+             * Restore
+             * @description Domains restored from redemption in the window
+             */
+            restore: number;
             /**
              * Total
              * @description Created plus transferred
@@ -7295,6 +7363,11 @@ export interface components {
              * @description Domains transferred to OpusDNS in the window
              */
             transfer: number;
+            /**
+             * Transfer Out
+             * @description Domains transferred away from OpusDNS in the window
+             */
+            transfer_out: number;
         };
         /**
          * DomainStatus