@opusdns/api 0.84.0 → 0.86.0

package/package.json

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

package/src/helpers/constants.ts

@@ -21,7 +21,7 @@
  * ```
  */
 
-import { AllocationMethodType, AttributeType, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ContactRoleType, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAttributeKey, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainSortField, DomainStatus, EmailVerificationStatus, EventObjectType, EventSubtype, EventType, GrantType, LaunchPhaseType, LocalPresenceRequirementType, OrganizationStatus, PatchOp, PeriodUnit, Permission, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TransferAckType, UserStatus, VerificationType, ZoneSortField } from './schemas';
+import { AllocationMethodType, AttributeType, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ContactRoleType, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAttributeKey, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainSortField, DomainStatus, EmailVerificationStatus, EventObjectType, EventSortField, EventSubtype, EventType, GrantType, LaunchPhaseType, LocalPresenceRequirementType, OrganizationStatus, PatchOp, PeriodUnit, Permission, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TransferAckType, UserStatus, VerificationType, ZoneSortField } from './schemas';
 
 /**
  * AllocationMethodType. Auto-generated enum for AllocationMethodType
@@ -1387,6 +1387,56 @@ export const EVENT_OBJECT_TYPE_VALUES = [
   'UNKNOWN'
 ] as const satisfies [string, ...string[]] | EventObjectType[];
 
+/**
+ * EventSortField. Auto-generated enum for EventSortField
+ *
+ * @remarks
+ * This constant provides both object and array forms for the EventSortField enum.
+ * The object form allows key-value access, while the array form enables iteration and validation.
+ *
+ * @example
+ * ```typescript
+ * // Using the object form for key-value access
+ * const status = EVENT_SORT_FIELD.SUCCESS;
+ * 
+ * // Using the array form for iteration
+ * const allStatuses = EVENT_SORT_FIELD_VALUES;
+ * console.log(`Available statuses: ${allStatuses.join(', ')}`);
+ * ```
+ *
+ * @see {@link EventSortField} - The TypeScript type definition
+ */
+export const EVENT_SORT_FIELD = {
+  OBJECT_ID: "object_id",
+  CREATED_ON: "created_on",
+} as const satisfies Record<string, EventSortField>;
+
+/**
+ * Array of all EventSortField enum values
+ *
+ * @remarks
+ * This constant provides a array containing all valid EventSortField enum values.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all values
+ * for (const value of EVENT_SORT_FIELD_VALUES) {
+ *   console.log(`Processing: ${value}`);
+ * }
+ * 
+ * // Validation
+ * const isValid = EVENT_SORT_FIELD_VALUES.includes(someValue);
+ * ```
+ *
+ * @see {@link EventSortField} - The TypeScript type definition
+ * @see {@link EVENT_SORT_FIELD} - The object form of this enum
+ */
+export const EVENT_SORT_FIELD_VALUES = [
+  'object_id',
+  'created_on'
+] as const satisfies [string, ...string[]] | EventSortField[];
+
 /**
  * EventSubtype. Auto-generated enum for EventSubtype
  *

package/src/helpers/requests.d.ts

@@ -2443,7 +2443,7 @@ export type PATCH_EmailForwardsZoneNameEnable_Request_Path = PATCH_EmailForwards
  * Request type for GET Events endpoint
  *
  * Get pending events
- * Retrieves a paginated list of pending events for the organization
+ * Retrieves a paginated list of events for the organization
  *
  * @remarks
  * This type defines the complete request structure for the GET Events endpoint.

package/src/helpers/responses.d.ts

@@ -3581,7 +3581,7 @@ export type PATCH_EmailForwardsByZoneNameEnable_Response_422 = HTTPValidationErr
  * Response types for GET Events endpoint
  *
  * Get pending events
- * Retrieves a paginated list of pending events for the organization
+ * Retrieves a paginated list of events for the organization
  *
  * @remarks
  * This type defines all possible response structures for the GET Events endpoint.

package/src/helpers/schemas.d.ts

@@ -1450,6 +1450,22 @@ export type EventResponse = components['schemas']['EventResponse'];
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type EventSchema = components['schemas']['EventSchema'];
+/**
+ * EventSortField
+ *
+ * @remarks
+ * Type alias for the `EventSortField` OpenAPI schema.
+ * This type represents eventsortfield data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getEventSortField();
+ * const item: EventSortField = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type EventSortField = components['schemas']['EventSortField'];
 /**
  * EventSubtype
  *

package/src/openapi.yaml

@@ -2383,6 +2383,12 @@ components:
       - source
       title: EventSchema
       type: object
+    EventSortField:
+      enum:
+      - object_id
+      - created_on
+      title: EventSortField
+      type: string
     EventSubtype:
       enum:
       - NOTIFICATION
@@ -4909,151 +4915,44 @@ components:
           tokenUrl: token
       type: oauth2
 info:
-  description: "# Authentication\n\nDescribes authentication approach.\n\n\n## DNS\
-    \ validation overview (general \u2192 specific) (generated by Cursor on 15th October\
-    \ 2025)\n\nThis document summarizes all DNS validation rules implemented in the\
-    \ codebase and exercised by unit tests. It starts with general hostname requirements\
-    \ and narrows down to zone-, RRSet-, and record-type-specific rules.\n\n### General\
-    \ hostname rules\n\n- **Required trailing dot**: Hostnames must end with a period.\n\
-    - **Lowercase only**: Hostnames are case-insensitive in DNS, but the system enforces\
-    \ lowercase.\n- **Total length**: Must be < 255 octets.\n- **TLD recognized**:\
-    \ The suffix (TLD) must be recognized by `tldextract`.\n- **Allowed characters**:\n\
-    \  - For RRSet types that allow underscores: `- _ . *` plus alphanumerics\n  -\
-    \ For all other types: `- . *` plus alphanumerics\n  - If an underscore appears\
-    \ on a type that does not allow it, validation fails with a type-aware message.\n\
-    - **Periods constraints**:\n  - No consecutive periods (`..`).\n  - Cannot start\
-    \ with a period.\n- **Label-by-label checks**:\n  - Labels cannot be empty (e.g.,\
-    \ from `..`).\n  - Leftmost wildcard `*` is allowed as its own label; any `*`\
-    \ elsewhere (or combined with other chars) is invalid.\n  - Each label must be\
-    \ \u2264 63 octets.\n  - Each label must end with a letter or digit (no trailing\
-    \ `-` or `_`).\n\nTypes that allow underscores in hostnames: `CNAME`, `ALIAS`,\
-    \ `TXT`, `CAA`, `SRV`, `SMIMEA`, `TLSA`, `URI`.\n\nUnit tests: `tests/unit/models/test_dns_validation.py::TestHostnameValidation`,\
-    \ `::TestLabelValidation`.\n\n### Zone-level validation\n\n- **Blocklist**: Certain\
-    \ hostnames are blocked (checked without the trailing dot). If the zone name matches\
-    \ the blocklist, validation fails.\n- **Zone name hostname checks**: Zone name\
-    \ is validated with the general hostname rules.\n- **RRSet validation aggregation**:\
-    \ Each RRSet is validated; all RRSet and record errors are aggregated under `errors[\"\
-    rrsets\"]` keyed by RRSet name.\n- **CNAME conflicts (RFC 1034/2181 semantics)**:\n\
-    \  - A `CNAME` at a name cannot coexist with any other non-DNSSEC type at the\
-    \ same name.\n  - `DNSKEY`/`DS` (DNSSEC) are permitted alongside `CNAME`.\n- **MX\
-    \ target validation (additional policy)**:\n  - MX priority must be an integer\
-    \ in [0, 65535].\n  - MX target cannot be a `CNAME`.\n  - MX target cannot be\
-    \ an IP address (v4 or v6).\n- **Wildcard conflicts**:\n  - `NS` records cannot\
-    \ use wildcard names (e.g., `*.example.com.` is invalid for `NS`).\n- **ALIAS\
-    \ conflicts and DNSSEC interaction (PowerDNS semantics)**:\n  - If any `ALIAS`\
-    \ exists in a zone that also contains DNSSEC types (`DNSKEY` or `DS`), validation\
-    \ fails: ALIAS is not supported in DNSSEC-enabled zones.\n  - At the zone apex,\
-    \ `ALIAS` can only coexist with `SOA` and `NS` (and not with other non-DNSSEC\
-    \ types).\n  - At non-apex names, an `ALIAS` cannot coexist with any other record\
-    \ type (behaves like `CNAME` exclusivity).\n\nUnit tests: `tests/unit/models/test_dns_validation.py::TestZoneValidation`,\
-    \ `tests/unit/service/dns/test_additional_dns_validations.py` (MX, wildcard, ALIAS),\
-    \ `tests/unit/service/dns/test_rrset_validation.py` (relative names and invalid\
-    \ zone names).\n\n### RRSet-level validation\n\n- **Name must be inside zone**:\
-    \ RRSet name must either equal the zone apex or end with `.{zone_name}`.\n- **RRSet\
-    \ name hostname checks**: RRSet names are validated with general hostname rules,\
-    \ taking into account RRSet type for underscore allowance.\n- **Relative name\
-    \ normalization** (service-level helper):\n  - `@` or empty name resolves to the\
-    \ zone apex.\n  - Names without a trailing dot become FQDNs relative to the zone.\n\
-    \  - Already-FQDN names are preserved.\n- **Error aggregation shape for RRSet**:\n\
-    \  - RRSet-level errors are listed under `errors[\"rrsets\"][<rrset_name>][\"\
-    rrset\"]`.\n  - Record-level errors are listed under `errors[\"rrsets\"][<rrset_name>][\"\
-    records\"][<record_rdata>]`.\n\nUnit tests: `tests/unit/service/dns/test_rrset_validation.py`\
-    \ (relative `@`, relative `www`, invalid `invalid-subdomain-`), `tests/unit/models/test_dns_validation.py::TestZoneValidation`\
-    \ (invalid RRSet names).\n\n### Record-level validation engine\n\n- **Parsing**:\
-    \ For all supported types except `ALIAS`, the system delegates RDATA parsing to\
-    \ `dnspython` via `dns.rdata.from_text` for the appropriate type.\n- **Target\
-    \ hostnames**: For `CNAME`, `NS`, `PTR`, `SRV`, and `MX`, the parsed target hostname\
-    \ (`target` or `exchange`) is further validated with the general hostname rules\
-    \ and underscore allowance for the RRSet type.\n- **RDATA normalization before\
-    \ parse**:\n  - `CNAME`, `NS`, `PTR`: the RDATA hostname is normalized to lowercase\
-    \ with a trailing dot.\n  - `SRV`: the trailing hostname portion is normalized;\
-    \ numeric fields are preserved.\n  - `MX`: the trailing target hostname is normalized;\
-    \ the priority is preserved.\n- **ALIAS special case**: `ALIAS` RDATA is treated\
-    \ as a hostname and validated directly (not parsed by `dnspython`) and must be\
-    \ a valid hostname per the RRSet\u2019s underscore rules.\n- **Error mapping**:\
-    \ `dnspython` exceptions are mapped to user-facing messages such as:\n  - \"Invalid\
-    \ <TYPE> record format: <rdata>\"\n  - \"Invalid <TYPE> record data: <rdata>\"\
-    \n  - \"<TYPE> record validation failed: <detail>\"\n  - The top-level detail\
-    \ for the record error is standardized to \"<TYPE> record is not in the expected\
-    \ format\".\n\nUnit tests: `tests/unit/models/test_dns_validation.py::TestRecordValidationErrors`\
-    \ (A, AAAA, CNAME, MX malformed), plus aggregation and structure assertions.\n\
-    \n### Type-specific rules and examples\n\n- **A**:\n  - RDATA must be a valid\
-    \ IPv4 address.\n  - Example invalid: `not.an.ip` \u2192 parse fails.\n- **AAAA**:\n\
-    \  - RDATA must be a valid IPv6 address.\n  - Example invalid: `??::completely::invalid::ipv6`\
-    \ \u2192 parse fails.\n- **CNAME**:\n  - RDATA is a hostname; target is validated;\
-    \ name-level exclusivity enforced at zone level (cannot coexist with other non-DNSSEC\
-    \ types at same name).\n  - Underscores allowed in name/target.\n- **MX**:\n \
-    \ - RDATA: `<priority> <target-hostname>`\n  - Priority range: 0\u201365535 (integer).\
-    \ Invalid or out-of-range triggers errors.\n  - Target hostname cannot be a CNAME\
-    \ name, and cannot be an IP address.\n  - Target hostname is normalized and validated.\n\
-    - **NS**:\n  - RDATA is a hostname; target is validated.\n  - NS cannot use wildcard\
-    \ names (i.e., RRSet name cannot be `*.example.com.`).\n- **PTR**:\n  - RDATA\
-    \ is a hostname; target is validated.\n- **SRV**:\n  - RDATA: `<priority> <weight>\
-    \ <port> <target-hostname>`; target hostname normalized and validated.\n  - Underscores\
-    \ allowed (service labels per RFC 2782).\n- **TXT**:\n  - Delegated to `dnspython`\
-    \ for parsing; underscores allowed in names.\n  - Note: A TODO exists to enforce\
-    \ quotes for TXT content in the future.\n- **CAA**, **SMIMEA**, **TLSA**, **URI**:\n\
-    \  - Delegated to `dnspython` for parsing; underscores allowed in names.\n- **ALIAS**:\n\
-    \  - Treated like a hostname alias (not an RFC standard RRType); normalized and\
-    \ validated as a hostname.\n  - Conflicts/DNSSEC rules as described in the zone-level\
-    \ section.\n- **DNSKEY**, **DS** (DNSSEC):\n  - Not parsed/validated here beyond\
-    \ coexistence logic; allowed to coexist with `CNAME` but disallowed with `ALIAS`\
-    \ when DNSSEC is present.\n\nUnit tests: cover A/AAAA/CNAME/MX malformed cases;\
-    \ underscore handling across many types; ALIAS, wildcard, and DNSSEC compatibility\
-    \ in `tests/unit/service/dns/test_additional_dns_validations.py`.\n\n### Wildcard\
-    \ handling\n\n- `*` is allowed only as the entire leftmost label of a name (e.g.,\
-    \ `*.example.com.`).\n- Any `*` embedded within a label or not in the leftmost\
-    \ position is invalid.\n- `NS` records cannot be defined at wildcard names.\n\n\
-    Unit tests: Wildcard NS invalid; wildcard A alongside explicit siblings and at\
-    \ different levels is allowed.\n\n### Underscore handling (by RRSet type)\n\n\
-    - Allowed in hostnames for types: `CNAME`, `ALIAS`, `TXT`, `CAA`, `SRV`, `SMIMEA`,\
-    \ `TLSA`, `URI`.\n- Disallowed for: `A`, `AAAA`, `NS`, `MX`, `PTR`, `SOA`, `DNSKEY`,\
-    \ `DS`.\n- Applies both at the start of labels (e.g., `_service`) and in the middle\
-    \ (`my_service`), per tests.\n\nUnit tests: `tests/unit/models/test_dns_validation.py::TestUnderscoreHandling`\
-    \ parameterized cases across types.\n\n### Blocked hostnames\n\n- A curated list\
-    \ of blocked apex names (e.g., major providers\u2019 zones) cannot be added as\
-    \ zones. The check is performed on the dotted-stripped value (no trailing dot).\n\
-    \n### Error response shape\n\n- Zone-level failure raises `DnsZoneValidationError`\
-    \ with `extras.errors` containing:\n  - `zone_name`: either a string or a nested\
-    \ mapping of specific hostname errors\n  - `rrsets`: mapping of RRSet name \u2192\
-    \ `{ \"rrset\": [..], \"records\": { rdata \u2192 [..] } }`\n  - Optional sections\
-    \ when relevant: `cname_conflicts`, `mx_validation`, `wildcard_conflicts`, `alias_conflicts`\n\
-    - RRSet-level failure raises `DnsRrsetValidationError` with a similarly structured\
-    \ `errors` mapping for that RRSet.\n- Record-level failures are aggregated into\
-    \ the RRSet structure above.\n\nUnit tests: Assert shapes and representative messages\
-    \ in `tests/unit/models/test_dns_validation.py::TestRecordValidationErrors::test_error_response_structure`.\n\
-    \n### Key normalizers and helpers\n\n- `normalize_zone_name(s)`: lowercases and\
-    \ ensures a trailing dot.\n- `convert_rrset_name(name, zone)`: resolves `@`/empty\
-    \ to apex and converts relative names to FQDNs under the zone.\n- The record validator\
-    \ normalizes hostnames within RDATA for `CNAME`, `NS`, `PTR`, `SRV`, and `MX`\
-    \ before parsing/validation.\n\n### API behavior around trailing dots (for context)\n\
-    \n- API endpoints accept both with/without trailing dot in the path; zone names\
-    \ are normalized internally. This is orthogonal to validation rules but relevant\
-    \ to how names are handled at the boundary.\n\n---\n\nReferences (tests):\n- `tests/unit/models/test_dns_validation.py`\n\
-    - `tests/unit/service/dns/test_additional_dns_validations.py`\n- `tests/unit/service/dns/test_rrset_validation.py`\n\
-    - `tests/unit/api/dns/test_v1.py`, `tests/unit/api/dns/test_dns.py` (API normalization)\n\
-    \nReferences (implementation):\n- `common/models/dns/validation.py`\n- `common/services/dns/utils.py`\n\
-    - `common/lib/utils/dns.py`\n- `common/models/dns/blocked_domains.py`\n\n\n\n\n\
-    # Resource IDs\n\nThe API uses extensively [Type IDs](https://github.com/jetify-com/typeid):\
-    \ type-safe, K-sortable, globally unique identifier inspired by Stripe IDs. They\
-    \ can be easily identified with a format like `prefix_01jxe1nzrmf78scaqbkjx0va0f`.\
-    \ The `prefix` gives context to the ID - some examples include `user`, `organization`,\
-    \ `domain`. The rest of the ID is a 128-bit UUIDv7 encoded as a 26-character string\
-    \ using a modified base32 encoding. See [formal specification for details](https://github.com/jetify-com/typeid/tree/main/spec).\n\
-    \nThis approach allows using unique IDs (UUIDv7), preventing iteration attacks,\
-    \ while also easily identifying the \"namespace\" of the ID. `01975c1f-a15a-7f6c-a5ce-b75fe33de079`\
-    \ is hardly distuingishable from `01975c1f-f120-7874-8dc2-de7d728bf261` by humans\
-    \ on first glance. However, when represented as Type IDs, they could be represented\
-    \ as `user_01jxe1z8atfxpabknqbzhkvr3s` and `domain_01jxe1zw90f1t8vgpyfns8qwk1`,\
-    \ immediately making it easier to differentiate between them.\n\nAdditionally,\
-    \ this gives type safety and additional validation that can be done. There's [libraries\
-    \ available for many languages to make handling Type IDs easier](https://github.com/jetify-com/typeid?tab=readme-ov-file#official-implementations-by-jetify).\
-    \ We're using them ourselves on the backend to quickly catch mistakes like passing\
-    \ the wrong Type ID (passing a user ID like `user_01jxe1z8atfxpabknqbzhkvr3s`\
-    \ where a domain ID `domain_01jxe1zw90f1t8vgpyfns8qwk1` was expected).\n\n\n"
+  description: '# Authentication
+
+
+    Describes authentication approach.
+
+
+
+    # Resource IDs
+
+
+    The API uses extensively [Type IDs](https://github.com/jetify-com/typeid): type-safe,
+    K-sortable, globally unique identifier inspired by Stripe IDs. They can be easily
+    identified with a format like `prefix_01jxe1nzrmf78scaqbkjx0va0f`. The `prefix`
+    gives context to the ID - some examples include `user`, `organization`, `domain`.
+    The rest of the ID is a 128-bit UUIDv7 encoded as a 26-character string using
+    a modified base32 encoding. See [formal specification for details](https://github.com/jetify-com/typeid/tree/main/spec).
+
+
+    This approach allows using unique IDs (UUIDv7), preventing iteration attacks,
+    while also easily identifying the "namespace" of the ID. `01975c1f-a15a-7f6c-a5ce-b75fe33de079`
+    is hardly distuingishable from `01975c1f-f120-7874-8dc2-de7d728bf261` by humans
+    on first glance. However, when represented as Type IDs, they could be represented
+    as `user_01jxe1z8atfxpabknqbzhkvr3s` and `domain_01jxe1zw90f1t8vgpyfns8qwk1`,
+    immediately making it easier to differentiate between them.
+
+
+    Additionally, this gives type safety and additional validation that can be done.
+    There''s [libraries available for many languages to make handling Type IDs easier](https://github.com/jetify-com/typeid?tab=readme-ov-file#official-implementations-by-jetify).
+    We''re using them ourselves on the backend to quickly catch mistakes like passing
+    the wrong Type ID (passing a user ID like `user_01jxe1z8atfxpabknqbzhkvr3s` where
+    a domain ID `domain_01jxe1zw90f1t8vgpyfns8qwk1` was expected).
+
+
+
+    '
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2025-10-15-082524
+  version: 2025-10-27-080440
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -6055,6 +5954,55 @@ paths:
       requestBody:
         content:
           application/json:
+            examples:
+              business_setup:
+                description: A comprehensive setup for a business with multiple subdomains
+                  and services
+                summary: Business setup with multiple services
+                value:
+                  dnssec_status: enabled
+                  name: example.com
+                  rrsets:
+                  - name: '@'
+                    records:
+                    - rdata: 203.0.113.10
+                    ttl: 600
+                    type: A
+                  - name: www
+                    records:
+                    - rdata: example.com.
+                    ttl: 300
+                    type: CNAME
+                  - name: api
+                    records:
+                    - rdata: 203.0.113.20
+                    ttl: 300
+                    type: A
+                  - name: mail
+                    records:
+                    - rdata: 203.0.113.30
+                    ttl: 300
+                    type: A
+                  - name: '@'
+                    records:
+                    - rdata: 10 mail.example.com.
+                    - rdata: 20 backup-mail.example.com.
+                    ttl: 300
+                    type: MX
+                  - name: '@'
+                    records:
+                    - rdata: '"v=spf1 include:_spf.google.com ~all"'
+                    - rdata: '"google-site-verification=abc123def456"'
+                    ttl: 300
+                    type: TXT
+              minimal_setup:
+                description: Create a zone with just the zone name - SOA and NS records
+                  are automatically generated
+                summary: Minimal zone creation
+                value:
+                  dnssec_status: disabled
+                  name: example.com
+                  rrsets: []
             schema:
               $ref: '#/components/schemas/DnsZoneCreate'
         required: true
@@ -6062,12 +6010,126 @@ paths:
         '201':
           content:
             application/json:
+              examples:
+                business_setup_response:
+                  description: Changeset response when creating a comprehensive business
+                    zone
+                  summary: Response for business setup creation
+                  value:
+                    changes:
+                    - action: create_zone
+                    - action: create_record
+                      record_data: example.com.
+                      rrset_name: www.example.com.
+                      rrset_type: CNAME
+                      ttl: 300
+                    - action: create_record
+                      record_data: 203.0.113.30
+                      rrset_name: mail.example.com.
+                      rrset_type: A
+                      ttl: 300
+                    - action: create_record
+                      record_data: 203.0.113.20
+                      rrset_name: api.example.com.
+                      rrset_type: A
+                      ttl: 300
+                    - action: create_record
+                      record_data: '"google-site-verification=abc123def456"'
+                      rrset_name: example.com.
+                      rrset_type: TXT
+                      ttl: 300
+                    - action: create_record
+                      record_data: '"v=spf1 include:_spf.google.com ~all"'
+                      rrset_name: example.com.
+                      rrset_type: TXT
+                      ttl: 300
+                    - action: create_record
+                      record_data: 10 mail.example.com.
+                      rrset_name: example.com.
+                      rrset_type: MX
+                      ttl: 300
+                    - action: create_record
+                      record_data: 20 backup-mail.example.com.
+                      rrset_name: example.com.
+                      rrset_type: MX
+                      ttl: 300
+                    - action: create_record
+                      record_data: ns1.opusdns.com. hostmaster.opusdns.com. 2025101401
+                        10800 3600 604800 300
+                      rrset_name: example.com.
+                      rrset_type: SOA
+                      ttl: 3600
+                    - action: create_record
+                      record_data: ns1.opusdns.com.
+                      rrset_name: example.com.
+                      rrset_type: NS
+                      ttl: 3600
+                    - action: create_record
+                      record_data: ns2.opusdns.com.
+                      rrset_name: example.com.
+                      rrset_type: NS
+                      ttl: 3600
+                    - action: create_record
+                      record_data: 203.0.113.10
+                      rrset_name: example.com.
+                      rrset_type: A
+                      ttl: 600
+                    - action: create_record
+                      record_data: 256 3 13 4epAMhnUgbFbAmKI2zbTXXFHGlVeHamiWLPdwJ8ehE9NgmvDNraqYF/0YdDcoc2elyelvi72KJyQfIR02axEeQ==
+                      rrset_name: example.com.
+                      rrset_type: DNSKEY
+                      ttl: 300
+                    - action: create_record
+                      record_data: 257 3 13 Wx1Wk8Sl+PyanAWPYsCPw9qFv2Nv0U/MXoJGgpmdqgbLgtvPlVM1/66j/MFTOjk4ONGKGZoWbZ86ud18lWvacw==
+                      rrset_name: example.com.
+                      rrset_type: DNSKEY
+                      ttl: 300
+                    - action: create_record
+                      record_data: 17781 13 2 21d0b2b21f501935546de33505a2b43d16ba3b1f375e00b0386dae3942165915
+                      rrset_name: example.com.
+                      rrset_type: DS
+                      ttl: 300
+                    - action: create_record
+                      record_data: 17781 13 4 d10ab2a071c85c20a0338797401928255be1d08c470236b381fbd87df0d60e3aab5d86c6dee8356374167d9b68652608
+                      rrset_name: example.com.
+                      rrset_type: DS
+                      ttl: 300
+                    - action: enable_dnssec
+                    changeset_id: 108e6028-2812-4bd9-aa41-5b46cdc7fbdc
+                    num_changes: 17
+                    zone_name: example.com.
+                minimal_setup_response:
+                  description: Changeset response when creating a zone with automatic
+                    SOA and NS records
+                  summary: Response for minimal zone creation
+                  value:
+                    changes:
+                    - action: create_zone
+                    - action: create_record
+                      record_data: ns1.opusdns.com. hostmaster.opusdns.com. 2025101401
+                        10800 3600 604800 300
+                      rrset_name: example.com.
+                      rrset_type: SOA
+                      ttl: 3600
+                    - action: create_record
+                      record_data: ns1.opusdns.com.
+                      rrset_name: example.com.
+                      rrset_type: NS
+                      ttl: 3600
+                    - action: create_record
+                      record_data: ns2.opusdns.com.
+                      rrset_name: example.com.
+                      rrset_type: NS
+                      ttl: 3600
+                    changeset_id: de28f689-b400-45b7-9f67-9f92d512935a
+                    num_changes: 4
+                    zone_name: example.com.
               schema:
                 anyOf:
                 - $ref: '#/components/schemas/DnsChangesResponse'
                 - type: 'null'
                 title: Response Create Zone V1 Dns Post
-          description: Successful Response
+          description: Zone created successfully
         '400':
           content:
             application/problem+json:
@@ -6083,9 +6145,25 @@ paths:
         '422':
           content:
             application/problem+json:
+              examples:
+                typo_in_name:
+                  description: The request contains a typo in the name field
+                  summary: Typo in name
+                  value:
+                    errors:
+                    - input:
+                        nme: example.com
+                      loc:
+                      - body
+                      - name
+                      msg: Field required
+                      type: missing
+                    status: 422
+                    title: Request validation error.
+                    type: request-validation-failed
               schema:
                 $ref: '#/components/schemas/HTTPValidationError'
-          description: Validation Error
+          description: Invalid request parameters
       security:
       - OAuth2PasswordBearer: []
       summary: Create Zone
@@ -7961,9 +8039,62 @@ paths:
       - email_forward
   /v1/events:
     get:
-      description: Retrieves a paginated list of pending events for the organization
+      description: Retrieves a paginated list of events for the organization
       operationId: get_events_v1_events_get
       parameters:
+      - in: query
+        name: sort_by
+        required: false
+        schema:
+          $ref: '#/components/schemas/EventSortField'
+          default: created_on
+      - in: query
+        name: sort_order
+        required: false
+        schema:
+          $ref: '#/components/schemas/SortOrder'
+          default: desc
+      - in: query
+        name: object_type
+        required: false
+        schema:
+          anyOf:
+          - $ref: '#/components/schemas/EventObjectType'
+          - type: 'null'
+          title: Object Type
+      - in: query
+        name: object_id
+        required: false
+        schema:
+          anyOf:
+          - type: string
+          - type: 'null'
+          title: Object Id
+      - in: query
+        name: type
+        required: false
+        schema:
+          anyOf:
+          - $ref: '#/components/schemas/EventType'
+          - type: 'null'
+          title: Type
+      - in: query
+        name: subtype
+        required: false
+        schema:
+          anyOf:
+          - $ref: '#/components/schemas/EventSubtype'
+          - type: 'null'
+          title: Subtype
+      - in: query
+        name: acknowledged
+        required: false
+        schema:
+          anyOf:
+          - type: boolean
+          - type: 'null'
+          default: false
+          title: Acknowledged
       - in: query
         name: page
         required: false
@@ -9825,6 +9956,11 @@ tags:
     '
   name: email_forward
   x-displayName: Email forwards
+- description: 'Endpoints for creating and managing domain forwards.
+
+    '
+  name: domain_forward
+  x-displayName: Domain forwards
 - description: 'Endpoints for interacting with events.
 
     '
@@ -9871,5 +10007,6 @@ x-tagGroups:
   tags:
   - dns
   - email_forward
+  - domain_forward
   - rdap
   - domain_search

package/src/schema.d.ts

@@ -688,7 +688,7 @@ export interface paths {
         };
         /**
          * Get pending events
-         * @description Retrieves a paginated list of pending events for the organization
+         * @description Retrieves a paginated list of events for the organization
          */
         get: operations["get_events_v1_events_get"];
         put?: never;
@@ -2797,6 +2797,11 @@ export interface components {
             /** @description The type of the event - indicates the kind of operation occurring (e.g., 'ACCOUNT_CREATE', 'DOMAIN_MODIFICATION') */
             type?: components["schemas"]["EventType"] | null;
         };
+        /**
+         * EventSortField
+         * @enum {string}
+         */
+        EventSortField: "object_id" | "created_on";
         /**
          * EventSubtype
          * @enum {string}
@@ -5364,7 +5369,7 @@ export interface operations {
             };
         };
         responses: {
-            /** @description Successful Response */
+            /** @description Zone created successfully */
             201: {
                 headers: {
                     [name: string]: unknown;
@@ -5389,7 +5394,7 @@ export interface operations {
                     "application/problem+json": components["schemas"]["Problem"];
                 };
             };
-            /** @description Validation Error */
+            /** @description Invalid request parameters */
             422: {
                 headers: {
                     [name: string]: unknown;
@@ -7095,6 +7100,13 @@ export interface operations {
     get_events_v1_events_get: {
         parameters: {
             query?: {
+                sort_by?: components["schemas"]["EventSortField"];
+                sort_order?: components["schemas"]["SortOrder"];
+                object_type?: components["schemas"]["EventObjectType"] | null;
+                object_id?: string | null;
+                type?: components["schemas"]["EventType"] | null;
+                subtype?: components["schemas"]["EventSubtype"] | null;
+                acknowledged?: boolean | null;
                 page?: number;
                 page_size?: number;
             };