@opusdns/api 0.234.0 → 0.236.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/src/helpers/constants.ts +5 -1
- package/src/openapi.yaml +24 -10
- package/src/schema.d.ts +1 -1
package/package.json
CHANGED
package/src/helpers/constants.ts
CHANGED
|
@@ -4152,6 +4152,8 @@ export const REPORT_TYPE = {
|
|
|
4152
4152
|
DOMAIN_INVENTORY: "domain_inventory",
|
|
4153
4153
|
DNS_ZONE_SUMMARY: "dns_zone_summary",
|
|
4154
4154
|
DNS_ZONE_RECORDS: "dns_zone_records",
|
|
4155
|
+
BILLING_TRANSACTIONS: "billing_transactions",
|
|
4156
|
+
BILLING_TRANSACTIONS_MONTHLY: "billing_transactions_monthly",
|
|
4155
4157
|
} as const satisfies Record<string, ReportType>;
|
|
4156
4158
|
|
|
4157
4159
|
/**
|
|
@@ -4178,7 +4180,9 @@ export const REPORT_TYPE = {
|
|
|
4178
4180
|
export const REPORT_TYPE_VALUES = [
|
|
4179
4181
|
'domain_inventory',
|
|
4180
4182
|
'dns_zone_summary',
|
|
4181
|
-
'dns_zone_records'
|
|
4183
|
+
'dns_zone_records',
|
|
4184
|
+
'billing_transactions',
|
|
4185
|
+
'billing_transactions_monthly'
|
|
4182
4186
|
] as const satisfies [string, ...string[]] | ReportType[];
|
|
4183
4187
|
|
|
4184
4188
|
/**
|
package/src/openapi.yaml
CHANGED
|
@@ -8275,6 +8275,8 @@ components:
|
|
|
8275
8275
|
- domain_inventory
|
|
8276
8276
|
- dns_zone_summary
|
|
8277
8277
|
- dns_zone_records
|
|
8278
|
+
- billing_transactions
|
|
8279
|
+
- billing_transactions_monthly
|
|
8278
8280
|
title: ReportType
|
|
8279
8281
|
type: string
|
|
8280
8282
|
RequestHistory:
|
|
@@ -9654,7 +9656,7 @@ info:
|
|
|
9654
9656
|
\n\n"
|
|
9655
9657
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
9656
9658
|
title: OpusDNS API
|
|
9657
|
-
version: 2026-04-
|
|
9659
|
+
version: 2026-04-02-151435
|
|
9658
9660
|
x-logo:
|
|
9659
9661
|
altText: OpusDNS API Reference
|
|
9660
9662
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -21331,19 +21333,31 @@ tags:
|
|
|
21331
21333
|
\ the whole system.\n"
|
|
21332
21334
|
name: user
|
|
21333
21335
|
x-displayName: Users
|
|
21334
|
-
- description: "Endpoints for generating and downloading
|
|
21335
|
-
\
|
|
21336
|
+
- description: "Endpoints for generating and downloading reports.\n\nReports provide\
|
|
21337
|
+
\ exportable snapshots of your domain, DNS, and billing data. Reports are generated\
|
|
21336
21338
|
\ asynchronously and can be downloaded as ZIP files once complete.\n\n### Report\
|
|
21337
21339
|
\ Types\n\n| Type | Description |\n|------|-------------|\n| `domain_inventory`\
|
|
21338
21340
|
\ | Full inventory of all domains in the organization |\n| `dns_zone_summary`\
|
|
21339
21341
|
\ | Summary of all DNS zones and their configuration |\n| `dns_zone_records` |\
|
|
21340
|
-
\ Detailed export of all DNS records across zones |\n
|
|
21341
|
-
|
|
21342
|
-
\
|
|
21343
|
-
\
|
|
21344
|
-
\
|
|
21345
|
-
\
|
|
21346
|
-
\
|
|
21342
|
+
\ Detailed export of all DNS records across zones |\n| `billing_transactions`\
|
|
21343
|
+
\ | Billing transactions for the current month to date |\n| `billing_transactions_monthly`\
|
|
21344
|
+
\ | Billing transactions for the previous calendar month |\n\n### Billing Transaction\
|
|
21345
|
+
\ Reports\n\nBilling transaction reports export all completed transactions as\
|
|
21346
|
+
\ a CSV with the following columns: `product_reference`, `action`, `period`, `product_type`,\
|
|
21347
|
+
\ `amount`, `currency`, `completed_on`.\n\nThere are two billing report types:\n\
|
|
21348
|
+
\n- **`billing_transactions`** \u2014 On-demand report covering the current month\
|
|
21349
|
+
\ to date (1st of the month through the time of the request). Request this via\
|
|
21350
|
+
\ the API like any other report type.\n- **`billing_transactions_monthly`** \u2014\
|
|
21351
|
+
\ Automatically generated on the 1st of each month at 5 AM UTC, covering the full\
|
|
21352
|
+
\ previous calendar month. These are scheduled reports and do not need to be manually\
|
|
21353
|
+
\ requested.\n\nBoth types maintain their own retention of 30 reports each, so\
|
|
21354
|
+
\ requesting on-demand reports will not displace the monthly archive.\n\n### Report\
|
|
21355
|
+
\ Lifecycle\n\nA report transitions through the following statuses:\n\n1. **pending**\
|
|
21356
|
+
\ \u2014 Report has been queued for generation\n2. **generating** \u2014 Report\
|
|
21357
|
+
\ is being built\n3. **completed** \u2014 Report is ready for download\n4. **failed**\
|
|
21358
|
+
\ \u2014 Generation failed\n\n### Usage Pattern\n\n1. **Request a report** \u2014\
|
|
21359
|
+
\ `POST /v1/reports` with the desired `report_type`\n2. **Poll for completion**\
|
|
21360
|
+
\ \u2014 `GET /v1/reports/{report_id}` until `status` is `completed`\n3. **Download**\
|
|
21347
21361
|
\ \u2014 `GET /v1/reports/{report_id}/download` returns the report as a streamed\
|
|
21348
21362
|
\ ZIP file\n\n### Downloading Reports\n\n`GET /v1/reports/{report_id}/download`\
|
|
21349
21363
|
\ streams the report file directly to the client. The report **must** have status\
|
package/src/schema.d.ts
CHANGED
|
@@ -7660,7 +7660,7 @@ export interface components {
|
|
|
7660
7660
|
* ReportType
|
|
7661
7661
|
* @enum {string}
|
|
7662
7662
|
*/
|
|
7663
|
-
ReportType: "domain_inventory" | "dns_zone_summary" | "dns_zone_records";
|
|
7663
|
+
ReportType: "domain_inventory" | "dns_zone_summary" | "dns_zone_records" | "billing_transactions" | "billing_transactions_monthly";
|
|
7664
7664
|
/** RequestHistory */
|
|
7665
7665
|
RequestHistory: {
|
|
7666
7666
|
/**
|