@opusdns/api 0.117.0 → 0.119.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 CHANGED
@@ -3,7 +3,7 @@
3
3
  "@opusdns/api-spec-ts-generator": "^0.9.1"
4
4
  },
5
5
  "name": "@opusdns/api",
6
- "version": "0.117.0",
6
+ "version": "0.119.0",
7
7
  "description": "TypeScript types for the OpusDNS OpenAPI specification",
8
8
  "main": "./src/index.ts",
9
9
  "module": "./src/index.ts",
@@ -2541,6 +2541,7 @@ export const PERMISSION = {
2541
2541
  VIEW: "view",
2542
2542
  VIEW_AUDIT_LOGS: "view_audit_logs",
2543
2543
  VIEW_DOMAIN_FORWARDS: "view_domain_forwards",
2544
+ VIEW_EMAIL_FORWARDS: "view_email_forwards",
2544
2545
  VIEW_EVENTS: "view_events",
2545
2546
  } as const satisfies Record<string, Permission>;
2546
2547
 
@@ -2604,6 +2605,7 @@ export const PERMISSION_VALUES = [
2604
2605
  'view',
2605
2606
  'view_audit_logs',
2606
2607
  'view_domain_forwards',
2608
+ 'view_email_forwards',
2607
2609
  'view_events'
2608
2610
  ] as const satisfies [string, ...string[]] | Permission[];
2609
2611
 
package/src/openapi.yaml CHANGED
@@ -4532,6 +4532,7 @@ components:
4532
4532
  - view
4533
4533
  - view_audit_logs
4534
4534
  - view_domain_forwards
4535
+ - view_email_forwards
4535
4536
  - view_events
4536
4537
  title: Permission
4537
4538
  type: string
@@ -5921,7 +5922,7 @@ info:
5921
5922
  '
5922
5923
  summary: OpusDNS - your gateway to a seamless domain management experience.
5923
5924
  title: OpusDNS API
5924
- version: 2025-12-08-162155
5925
+ version: 2025-12-10-013047
5925
5926
  x-logo:
5926
5927
  altText: OpusDNS API Reference
5927
5928
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -13487,8 +13488,78 @@ tags:
13487
13488
  '
13488
13489
  name: availability
13489
13490
  x-displayName: Availability
13490
- - description: 'Endpoints for submitting and tracking batch command execution (internal
13491
- preview).
13491
+ - description: 'Endpoints for submitting and tracking batch command execution.
13492
+
13493
+
13494
+ The Jobs API enables asynchronous execution of bulk operations through batches.
13495
+ Submit multiple commands in a single request and poll for completion status.
13496
+
13497
+
13498
+ ## Supported Commands
13499
+
13500
+
13501
+ | Command | Description |
13502
+
13503
+ |---------|-------------|
13504
+
13505
+ | `domain_create` | Register a new domain |
13506
+
13507
+ | `domain_update` | Modify domain settings (contacts, nameservers, renewal mode)
13508
+ |
13509
+
13510
+ | `domain_transfer` | Initiate an inbound domain transfer |
13511
+
13512
+ | `dns_zone_create` | Create a new DNS zone with optional records |
13513
+
13514
+
13515
+ ## Batch Lifecycle
13516
+
13517
+
13518
+ Each job within a batch transitions through states:
13519
+
13520
+
13521
+ 1. **queued** - Awaiting processing
13522
+
13523
+ 2. **running** - Currently being executed
13524
+
13525
+ 3. **succeeded** - Completed successfully
13526
+
13527
+ 4. **failed** - Execution failed (check `error_class` and `error_message`)
13528
+
13529
+ 5. **canceled** - Job was canceled before completion
13530
+
13531
+ 6. **dead_letter** - Permanently failed after exhausting retries
13532
+
13533
+
13534
+ ## Usage Pattern
13535
+
13536
+
13537
+ 1. **Submit a batch** - `POST /v1/jobs` with an array of commands
13538
+
13539
+ 2. **Poll for status** - `GET /v1/jobs/{batch_id}` to check progress
13540
+
13541
+ 3. **Review results** - `GET /v1/jobs/{batch_id}/jobs` to see individual job outcomes
13542
+
13543
+
13544
+ ## Limits
13545
+
13546
+
13547
+ - Maximum **50,000 commands** per batch
13548
+
13549
+
13550
+ ## Scheduling
13551
+
13552
+
13553
+ Use `not_before` to schedule batch execution for a future time (UTC timestamp).
13554
+ If not provided, processing begins immediately.
13555
+
13556
+
13557
+ ## Idempotency
13558
+
13559
+
13560
+ Each command can include an optional `idempotency_key` to prevent duplicate execution.
13561
+ If a command with the same idempotency key has already been processed, it will
13562
+ be skipped.
13492
13563
 
13493
13564
  '
13494
13565
  name: jobs
@@ -13577,3 +13648,4 @@ x-tagGroups:
13577
13648
  - rdap
13578
13649
  - domain_search
13579
13650
  - archive
13651
+ - jobs
package/src/schema.d.ts CHANGED
@@ -4570,7 +4570,7 @@ export interface components {
4570
4570
  * Permission
4571
4571
  * @enum {string}
4572
4572
  */
4573
- Permission: "bulk_create" | "bulk_delete" | "bulk_renew_expire" | "bulk_transfer_trade" | "bulk_update" | "corporate_plan" | "create" | "delete" | "delete_domain_forwards" | "enterprise_plan" | "has_accepted_tos" | "manage_api_keys" | "manage_billing" | "manage_cms_content" | "manage_contacts" | "manage_dns_zones" | "manage_domains" | "manage_domain_forwards" | "manage_email_forwards" | "manage_events" | "manage_hosts" | "manage_opusdns_api_keys" | "manage_products" | "manage_reseller" | "manage_sub_zones" | "manage_users" | "manage_user_relations" | "plan_manager" | "premium_plan" | "renew_expire" | "starter_plan" | "transfer_trade" | "update" | "update_domain_forwards" | "verify" | "view" | "view_audit_logs" | "view_domain_forwards" | "view_events";
4573
+ Permission: "bulk_create" | "bulk_delete" | "bulk_renew_expire" | "bulk_transfer_trade" | "bulk_update" | "corporate_plan" | "create" | "delete" | "delete_domain_forwards" | "enterprise_plan" | "has_accepted_tos" | "manage_api_keys" | "manage_billing" | "manage_cms_content" | "manage_contacts" | "manage_dns_zones" | "manage_domains" | "manage_domain_forwards" | "manage_email_forwards" | "manage_events" | "manage_hosts" | "manage_opusdns_api_keys" | "manage_products" | "manage_reseller" | "manage_sub_zones" | "manage_users" | "manage_user_relations" | "plan_manager" | "premium_plan" | "renew_expire" | "starter_plan" | "transfer_trade" | "update" | "update_domain_forwards" | "verify" | "view" | "view_audit_logs" | "view_domain_forwards" | "view_email_forwards" | "view_events";
4574
4574
  /** PermissionSet */
4575
4575
  PermissionSet: {
4576
4576
  /** Permissions */