@opusdns/api 1.152.0 → 1.153.0

package/package.json

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

package/src/helpers/constants.ts

@@ -1916,6 +1916,7 @@ export const REPORT_STATUS = {
   GENERATING: "generating",
   COMPLETED: "completed",
   FAILED: "failed",
+  EMPTY: "empty",
 } as const satisfies Record<string, ReportStatus>;
 
 export const REPORT_STATUS_VALUES = [
@@ -1923,6 +1924,7 @@ export const REPORT_STATUS_VALUES = [
   'generating',
   'completed',
   'failed',
+  'empty',
 ] as const satisfies ReadonlyArray<ReportStatus>;
 
 export const REPORT_TRIGGER_TYPE = {

package/src/openapi.yaml

@@ -12909,6 +12909,7 @@ components:
       - generating
       - completed
       - failed
+      - empty
       title: ReportStatus
       type: string
     ReportTriggerType:
@@ -16164,7 +16165,7 @@ info:
     \n\n"
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2026-09-02-220446
+  version: 2026-09-03-091013
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -34612,8 +34613,9 @@ tags:
     \ the registrar-elements OpenSearch index, populated by the scheduled daily registrar\
     \ syncs. Report generation does not trigger a sync; it uses the most recently\
     \ synced data as-is. If the credential has no portfolio data yet (for example,\
-    \ a credential created since the last sync), generation fails with an error indicating\
-    \ the credential is too new to report on.\n\nThe downloaded ZIP contains `registrar-portfolio-{report_typeid}.pdf`.\
+    \ a credential created since the last sync), the report ends as `empty` rather\
+    \ than `failed`: there is nothing to report on yet, and the next run after a sync\
+    \ produces the real report.\n\nThe downloaded ZIP contains `registrar-portfolio-{report_typeid}.pdf`.\
     \ Before each PDF generation, the report service loads the organization's current\
     \ available TLD list from the backend and uses it to mark TLDs in the portfolio\
     \ as available or unavailable. The first version includes the sections backed\
@@ -34624,14 +34626,18 @@ tags:
     \ through the following statuses:\n\n1. **pending** \u2014 Report has been queued\
     \ for generation\n2. **generating** \u2014 Report is being built\n3. **completed**\
     \ \u2014 Report is ready for download\n4. **failed** \u2014 Generation failed\n\
+    5. **empty** \u2014 The organization had no data for this report type (for example\
+    \ no domains, zones or forwards). No file is produced and download returns `409\
+    \ Conflict`. `record_count` is `0`.\n\n`completed`, `failed` and `empty` are terminal.\n\
     \n### Usage Pattern\n\n1. **Request a report** \u2014 `POST /v1/reports` with\
     \ the desired `report_type`\n2. **Poll for completion** \u2014 `GET /v1/reports/{report_id}`\
-    \ until `status` is `completed`\n3. **Download** \u2014 `GET /v1/reports/{report_id}/download`\
-    \ returns the report as a streamed ZIP file\n\n### Downloading Reports\n\n`GET\
-    \ /v1/reports/{report_id}/download` streams the report file directly to the client.\
-    \ The report **must** have status `completed` before it can be downloaded \u2014\
-    \ calling this endpoint on a report that is still `pending` or `generating` returns\
-    \ `409 Conflict`.\n\n**Response details:**\n\n| Header | Value |\n|--------|-------|\n\
+    \ until `status` is terminal (`completed`, `empty` or `failed`)\n3. **Download**\
+    \ \u2014 `GET /v1/reports/{report_id}/download` returns the report as a streamed\
+    \ ZIP file\n\n### Downloading Reports\n\n`GET /v1/reports/{report_id}/download`\
+    \ streams the report file directly to the client. The report **must** have status\
+    \ `completed` before it can be downloaded \u2014 calling this endpoint on a report\
+    \ that is still `pending` or `generating`, or that ended `empty`, returns `409\
+    \ Conflict`.\n\n**Response details:**\n\n| Header | Value |\n|--------|-------|\n\
     | `Content-Type` | `application/zip` |\n| `Content-Disposition` | `attachment;\
     \ filename={report_type}-{report_id}.zip` |\n| `Content-Length` | File size in\
     \ bytes (included when known) |\n\nThe response body is streamed in chunks, so\
@@ -34647,13 +34653,17 @@ tags:
     \ per clock hour** (UTC) can be generated. Duplicate requests within the same\
     \ hour will not produce an additional report.\n\n### Retention\n\nThe **30 most\
     \ recent reports** of each type are kept per organization. Older reports and their\
-    \ associated files are automatically deleted when a new report is generated.\n\
-    \n### Listing Reports\n\nUse `GET /v1/reports` to list reports with optional filters:\n\
-    \n| Parameter | Description |\n|-----------|-------------|\n| `report_type` |\
-    \ Filter by report type (repeatable) |\n| `status` | Filter by report status (repeatable)\
-    \ |\n| `trigger_type` | Filter by trigger type |\n| `created_after` | Only reports\
-    \ created after this timestamp |\n| `created_before` | Only reports created before\
-    \ this timestamp |\n"
+    \ associated files are automatically deleted when a new report is generated. Of\
+    \ the `empty` reports of a type, only the most recent one is kept, so scheduled\
+    \ runs for an organization without data do not fill the list with identical entries.\
+    \ `registrar_portfolio_pdf` is exempt from that rule, because its reports are\
+    \ per registrar credential and an `empty` result for one credential says nothing\
+    \ about another.\n\n### Listing Reports\n\nUse `GET /v1/reports` to list reports\
+    \ with optional filters:\n\n| Parameter | Description |\n|-----------|-------------|\n\
+    | `report_type` | Filter by report type (repeatable) |\n| `status` | Filter by\
+    \ report status (repeatable) |\n| `trigger_type` | Filter by trigger type |\n\
+    | `created_after` | Only reports created after this timestamp |\n| `created_before`\
+    \ | Only reports created before this timestamp |\n"
   name: report
   x-displayName: Reports
 - description: Endpoints for creating new Tags

package/src/schema.d.ts

@@ -11582,7 +11582,7 @@ export interface components {
          * ReportStatus
          * @enum {string}
          */
-        ReportStatus: "pending" | "generating" | "completed" | "failed";
+        ReportStatus: "pending" | "generating" | "completed" | "failed" | "empty";
         /**
          * ReportTriggerType
          * @enum {string}