@opusdns/api 0.265.0 → 0.267.0

package/src/helpers/requests.d.ts

@@ -1137,6 +1137,8 @@ export type GET_ContactsVerify_Request_Query = GET_ContactsVerify_Request['param
  * Use this type to ensure type safety when making API requests to this endpoint.
  *
  * @path /v1/dns
+ * @param tag_ids (query) - Filter by tag IDs. Can be specified multiple times.
+ * @param include (query) - Include additional data in the response. Can be specified multiple times.
  *
  * @see {@link GET_Dns_Request_Query} - Query parameters type
  * @see {@link GET_Dns_Request_Path} - Path parameters type
@@ -1158,6 +1160,8 @@ export type GET_Dns_Request = {
  * Use this type to ensure type safety for query parameters.
  *
  * @path /v1/dns
+ * @param tag_ids (query) - Filter by tag IDs. Can be specified multiple times.
+ * @param include (query) - Include additional data in the response. Can be specified multiple times.
  */
 export type GET_Dns_Request_Query = GET_Dns_Request['parameters']['query'];
 
@@ -1361,6 +1365,7 @@ export type GET_DnsZoneName_Request = {
   parameters: {
     path: operations['get_zone_v1_dns__zone_name__get']['parameters']['path'];
   };
+  requestBody: unknown;
 }
 /**
  * Path parameters for GET /v1/dns/{zone_name}
@@ -1376,6 +1381,19 @@ export type GET_DnsZoneName_Request = {
  * @param zone_name (path) - DNS zone name (trailing dot optional)
  */
 export type GET_DnsZoneName_Request_Path = GET_DnsZoneName_Request['parameters']['path'];
+/**
+ * Request body for GET /v1/dns/{zone_name}
+ *
+ * @remarks
+ * This type defines the request body structure for the GET /v1/dns/{zone_name} endpoint.
+ * It provides type safety for the request body as defined in the OpenAPI specification.
+ *
+ * @example
+ * Use this type to ensure type safety for request body structure.
+ *
+ * @path /v1/dns/{zone_name}
+ */
+export type GET_DnsZoneName_Request_Body = GET_DnsZoneName_Request['requestBody'];
 
 /**
  * Request type for POST DnsZoneNameDnssecDisable endpoint

package/src/helpers/responses.d.ts

@@ -1853,6 +1853,8 @@ export type GET_ContactsVerify_Response_422 = HTTPValidationError
 
  *
  * @path /v1/dns
+ * @param tag_ids (query) - Filter by tag IDs. Can be specified multiple times.
+ * @param include (query) - Include additional data in the response. Can be specified multiple times.
  *
  * @see {@link GET_Dns_Response_200} - 200 response type
  * @see {@link GET_Dns_Response_422} - 422 response type
@@ -1872,6 +1874,8 @@ export type GET_Dns_Response = GET_Dns_Response_200 | GET_Dns_Response_422;
 
  *
  * @path /v1/dns
+ * @param tag_ids (query) - Filter by tag IDs. Can be specified multiple times.
+ * @param include (query) - Include additional data in the response. Can be specified multiple times.
  *
  * @see {@link GET_Dns_Response} - The main response type definition
  * @see {@link Pagination_DnsZone} - The actual schema type definition
@@ -1889,6 +1893,8 @@ export type GET_Dns_Response_200 = Pagination_DnsZone
 
  *
  * @path /v1/dns
+ * @param tag_ids (query) - Filter by tag IDs. Can be specified multiple times.
+ * @param include (query) - Include additional data in the response. Can be specified multiple times.
  *
  * @see {@link GET_Dns_Response} - The main response type definition
  * @see {@link HTTPValidationError} - The actual schema type definition

package/src/helpers/schemas-arrays.d.ts

@@ -21,8 +21,22 @@
  * This file is auto-generated from the OpenAPI specification.
  * Do not edit manually.
  */
-import { DomainIncludeField, DomainDnssecData, DomainDnssecDataCreate, JobStatus, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, ReportType, ReportStatus, TagType, TldResponseShort, AttributeCondition, DomainContactType, ContactCreateBulkInstance, ContactAttributeLinkDetail, ContactAttributeDefinition, PostalAddressType, ContactConfigBase, CommandError, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsZoneCreateBulkInstance, DnsRecordPatchOp, DnsZonePatchRecordsBulkInstance, DnsRrsetPatchOp, DnsZonePatchRrsetsBulkInstance, DnsRrset, DnsZoneUpdateBulkInstance, DomainAvailabilityCheck, ContactHandle, Nameserver, DomainCreateBulkInstance, BrowserStatsBucket, GeoStatsBucket, TimeSeriesBucket, DomainForwardPatchOp, PlatformStatsBucket, HttpRedirectRequest, HttpRedirectList, ReferrerStatsBucket, StatusCodeStatsBucket, UserAgentStatsBucket, VisitsByKeyBucket, DomainForward, DeletePolicyType, SyncOperationType, DomainContact, DomainHost, DomainTagEnriched, DomainSearchSuggestionWithPrice, DomainStatus, DomainTransferBulkInstance, DomainClientStatus, DomainUpdateBulkInstance, EmailForwardAliasCreate, EmailForwardLogEvent, EmailForwardAliasMetrics, EmailForwardAlias, EmailForward, PriceInfo, ValidationError, LaunchPhaseBase, LegalRequirementOperationType, LocalPresenceRequirementType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactAttributeSet, Contact, DnsZone, DomainForwardZone, Domain, EmailForwardLog, EmailForwardZone, EventResponse, Invoice, JobBatchMetadata, Job, ObjectLog, Organization, Parking, RequestHistory, Tag, UserPublic, ParkingCreateBulkInstance, ParkingDeleteBulkInstance, ParkingDisableBulkInstance, ParkingEnableBulkInstance, Period, Permission, PremiumAffectsType, PremiumPriceEntryRes, PremiumPricingAction, PublicReportRes, Relation, LegalRequirementBase, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
+import { ZoneIncludeField, DomainIncludeField, DomainDnssecData, DomainDnssecDataCreate, JobStatus, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, ReportType, ReportStatus, TagType, TldResponseShort, AttributeCondition, DomainContactType, ContactCreateBulkInstance, ContactAttributeLinkDetail, ContactAttributeDefinition, PostalAddressType, ContactConfigBase, CommandError, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsZoneCreateBulkInstance, DnsRecordPatchOp, DnsZonePatchRecordsBulkInstance, DnsRrsetPatchOp, DnsZonePatchRrsetsBulkInstance, DnsRrset, TagEnriched, DnsZoneUpdateBulkInstance, DomainAvailabilityCheck, ContactHandle, Nameserver, DomainCreateBulkInstance, BrowserStatsBucket, GeoStatsBucket, TimeSeriesBucket, DomainForwardPatchOp, PlatformStatsBucket, HttpRedirectRequest, HttpRedirectList, ReferrerStatsBucket, StatusCodeStatsBucket, UserAgentStatsBucket, VisitsByKeyBucket, DomainForward, DeletePolicyType, SyncOperationType, DomainContact, DomainHost, DomainSearchSuggestionWithPrice, DomainStatus, DomainTransferBulkInstance, DomainClientStatus, DomainUpdateBulkInstance, EmailForwardAliasCreate, EmailForwardLogEvent, EmailForwardAliasMetrics, EmailForwardAlias, EmailForward, PriceInfo, ValidationError, LaunchPhaseBase, LegalRequirementOperationType, LocalPresenceRequirementType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactAttributeSet, Contact, DnsZone, DomainForwardZone, Domain, EmailForwardLog, EmailForwardZone, EventResponse, Invoice, JobBatchMetadata, Job, ObjectLog, Organization, Parking, RequestHistory, Tag, UserPublic, ParkingCreateBulkInstance, ParkingDeleteBulkInstance, ParkingDisableBulkInstance, ParkingEnableBulkInstance, Period, Permission, PremiumAffectsType, PremiumPriceEntryRes, PremiumPricingAction, PublicReportRes, Relation, LegalRequirementBase, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
 
+/**
+ * ZoneIncludeField
+ *
+ * @remarks
+ * Array type for ZoneIncludeField objects. Used when the API returns a collection of ZoneIncludeField instances.
+ *
+ * @example
+ * ```typescript
+ * const items: ZoneIncludeFieldArray = await api.getZoneIncludeFields();
+ * ```
+ *
+ * @see {@link ZoneIncludeField} - The individual ZoneIncludeField type definition
+ */
+export type ZoneIncludeFieldArray = ZoneIncludeField[];
 /**
  * DomainIncludeField
  *
@@ -429,6 +443,20 @@ export type DnsZonePatchRrsetsBulkInstanceArray = DnsZonePatchRrsetsBulkInstance
  * @see {@link DnsRrset} - The individual DnsRrsetResponse type definition
  */
 export type DnsRrsetArray = DnsRrset[];
+/**
+ * TagEnrichedResponse
+ *
+ * @remarks
+ * Array type for TagEnrichedResponse objects. Used when the API returns a collection of TagEnrichedResponse instances.
+ *
+ * @example
+ * ```typescript
+ * const items: TagEnrichedArray = await api.getTagEnricheds();
+ * ```
+ *
+ * @see {@link TagEnriched} - The individual TagEnrichedResponse type definition
+ */
+export type TagEnrichedArray = TagEnriched[];
 /**
  * DnsZoneUpdateBulkInstance
  *
@@ -723,20 +751,6 @@ export type DomainContactArray = DomainContact[];
  * @see {@link DomainHost} - The individual DomainHostResponse type definition
  */
 export type DomainHostArray = DomainHost[];
-/**
- * DomainTagEnrichedResponse
- *
- * @remarks
- * Array type for DomainTagEnrichedResponse objects. Used when the API returns a collection of DomainTagEnrichedResponse instances.
- *
- * @example
- * ```typescript
- * const items: DomainTagEnrichedArray = await api.getDomainTagEnricheds();
- * ```
- *
- * @see {@link DomainTagEnriched} - The individual DomainTagEnrichedResponse type definition
- */
-export type DomainTagEnrichedArray = DomainTagEnriched[];
 /**
  * DomainSearchSuggestionWithPrice
  *

package/src/helpers/schemas.d.ts

@@ -778,22 +778,6 @@ export type Currency = components['schemas']['Currency'];
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type DeletePolicyType = components['schemas']['DeletePolicyType'];
-/**
- * DeletedEvent
- *
- * @remarks
- * Type alias for the `DeletedEvent` OpenAPI schema.
- * This type represents deletedevent data structures used in API requests and responses.
- *
- * @example
- * ```typescript
- * const response = await api.getDeletedEvent();
- * const item: DeletedEvent = response.results;
- * ```
- *
- * @see {@link components} - The OpenAPI components schema definition
- */
-export type DeletedEvent = components['schemas']['DeletedEvent'];
 /**
  * DnsChangeAction
  *
@@ -2522,22 +2506,6 @@ export type DomainSummaryData = components['schemas']['DomainSummaryData'];
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type DomainSummary = components['schemas']['DomainSummaryResponse'];
-/**
- * DomainTagEnrichedResponse
- *
- * @remarks
- * Type alias for the `DomainTagEnrichedResponse` OpenAPI schema.
- * This type represents domaintagenrichedresponse data structures used in API requests and responses.
- *
- * @example
- * ```typescript
- * const response = await api.getDomainTagEnriched();
- * const item: DomainTagEnriched = response.results;
- * ```
- *
- * @see {@link components} - The OpenAPI components schema definition
- */
-export type DomainTagEnriched = components['schemas']['DomainTagEnrichedResponse'];
 /**
  * DomainTransferBulkCommand
  *
@@ -3146,38 +3114,6 @@ export type EmailForwardZoneSortField = components['schemas']['EmailForwardZoneS
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type EmailVerificationStatus = components['schemas']['EmailVerificationStatus'];
-/**
- * EmptyEvent
- *
- * @remarks
- * Type alias for the `EmptyEvent` OpenAPI schema.
- * This type represents emptyevent data structures used in API requests and responses.
- *
- * @example
- * ```typescript
- * const response = await api.getEmptyEvent();
- * const item: EmptyEvent = response.results;
- * ```
- *
- * @see {@link components} - The OpenAPI components schema definition
- */
-export type EmptyEvent = components['schemas']['EmptyEvent'];
-/**
- * EppDateTime
- *
- * @remarks
- * Type alias for the `EppDateTime` OpenAPI schema.
- * This type represents eppdatetime data structures used in API requests and responses.
- *
- * @example
- * ```typescript
- * const response = await api.getEppDateTime();
- * const item: EppDateTime = response.results;
- * ```
- *
- * @see {@link components} - The OpenAPI components schema definition
- */
-export type EppDateTime = components['schemas']['EppDateTime'];
 /**
  * EventObjectType
  *
@@ -5460,22 +5396,6 @@ export type Relation = components['schemas']['Relation'];
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type RelationSet = components['schemas']['RelationSet'];
-/**
- * RenewalEvent
- *
- * @remarks
- * Type alias for the `RenewalEvent` OpenAPI schema.
- * This type represents renewalevent data structures used in API requests and responses.
- *
- * @example
- * ```typescript
- * const response = await api.getRenewalEvent();
- * const item: RenewalEvent = response.results;
- * ```
- *
- * @see {@link components} - The OpenAPI components schema definition
- */
-export type RenewalEvent = components['schemas']['RenewalEvent'];
 /**
  * RenewalMode
  *
@@ -5780,6 +5700,22 @@ export type TagColor = components['schemas']['TagColor'];
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type TagCreate = components['schemas']['TagCreate'];
+/**
+ * TagEnrichedResponse
+ *
+ * @remarks
+ * Type alias for the `TagEnrichedResponse` OpenAPI schema.
+ * This type represents tagenrichedresponse data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getTagEnriched();
+ * const item: TagEnriched = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type TagEnriched = components['schemas']['TagEnrichedResponse'];
 /**
  * TagFilterMode
  *
@@ -5972,22 +5908,6 @@ export type TrademarkClaimsBase = components['schemas']['TrademarkClaimsBase'];
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type TransferAckType = components['schemas']['TransferAckType'];
-/**
- * TransferEvent
- *
- * @remarks
- * Type alias for the `TransferEvent` OpenAPI schema.
- * This type represents transferevent data structures used in API requests and responses.
- *
- * @example
- * ```typescript
- * const response = await api.getTransferEvent();
- * const item: TransferEvent = response.results;
- * ```
- *
- * @see {@link components} - The OpenAPI components schema definition
- */
-export type TransferEvent = components['schemas']['TransferEvent'];
 /**
  * TransferLockPolicyBase
  *
@@ -6276,6 +6196,22 @@ export type VisitsByKeyBucket = components['schemas']['VisitsByKeyBucket'];
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type WhoisBase = components['schemas']['WhoisBase'];
+/**
+ * ZoneIncludeField
+ *
+ * @remarks
+ * Type alias for the `ZoneIncludeField` OpenAPI schema.
+ * This type represents zoneincludefield data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getZoneIncludeField();
+ * const item: ZoneIncludeField = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type ZoneIncludeField = components['schemas']['ZoneIncludeField'];
 /**
  * ZoneSortField
  *

package/src/openapi.yaml

@@ -1602,14 +1602,6 @@ components:
       - expiration
       title: DeletePolicyType
       type: string
-    DeletedEvent:
-      properties:
-        date:
-          $ref: '#/components/schemas/EppDateTime'
-      required:
-      - date
-      title: DeletedEvent
-      type: object
     DnsChangeAction:
       enum:
       - create_zone
@@ -2232,6 +2224,15 @@ components:
           format: date-time
           title: Created On
           type: string
+        dns_zone_id:
+          description: The unique identifier of the zone
+          examples:
+          - zone_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^zone_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: Dns Zone Id
+          type: string
+          x-typeid-prefix: zone
         dnssec_status:
           $ref: '#/components/schemas/DnssecStatus'
           default: disabled
@@ -2245,6 +2246,15 @@ components:
             $ref: '#/components/schemas/DnsRrsetResponse'
           title: Rrsets
           type: array
+        tags:
+          anyOf:
+          - items:
+              $ref: '#/components/schemas/TagEnrichedResponse'
+            type: array
+          - type: 'null'
+          description: Tags assigned to this zone. Only included when ?include=tags
+            is specified.
+          title: Tags
         updated_on:
           description: The date/time the entry was last updated on
           format: date-time
@@ -2252,6 +2262,7 @@ components:
           type: string
       required:
       - name
+      - dns_zone_id
       title: DnsZoneResponse
       type: object
     DnsZoneRrsetsCreate:
@@ -3680,7 +3691,7 @@ components:
         tags:
           anyOf:
           - items:
-              $ref: '#/components/schemas/DomainTagEnrichedResponse'
+              $ref: '#/components/schemas/TagEnrichedResponse'
             type: array
           - type: 'null'
           description: Tags assigned to this domain. Only included when ?include=tags
@@ -3953,31 +3964,6 @@ components:
       - domains
       title: DomainSummaryResponse
       type: object
-    DomainTagEnrichedResponse:
-      properties:
-        color:
-          $ref: '#/components/schemas/TagColor'
-          description: The color of the tag
-        label:
-          description: The label of the tag
-          minLength: 1
-          title: Label
-          type: string
-        tag_id:
-          description: The unique identifier of the tag
-          examples:
-          - tag_01h45ytscbebyvny4gc8cr8ma2
-          format: typeid
-          pattern: ^tag_[0-7][0-9a-hjkmnpq-tv-z]{25}$
-          title: Tag Id
-          type: string
-          x-typeid-prefix: tag
-      required:
-      - tag_id
-      - label
-      - color
-      title: DomainTagEnrichedResponse
-      type: object
     DomainTransferBulkCommand:
       properties:
         command:
@@ -5079,15 +5065,6 @@ components:
       - canceled
       title: EmailVerificationStatus
       type: string
-    EmptyEvent:
-      properties: {}
-      title: EmptyEvent
-      type: object
-    EppDateTime:
-      anyOf:
-      - format: date-time
-        type: string
-      - type: string
     EventObjectType:
       enum:
       - DOMAIN
@@ -5147,7 +5124,6 @@ components:
           description: The type of the event - indicates the kind of operation occurring
             (e.g., 'ACCOUNT_CREATE', 'DOMAIN_MODIFICATION')
       required:
-      - event_data
       - created_on
       title: EventResponse
       type: object
@@ -8560,17 +8536,6 @@ components:
           type: array
       title: RelationSet
       type: object
-    RenewalEvent:
-      properties:
-        registration_expiration_date:
-          description: The new expiration date/time after the domain has been renewed
-          format: date-time
-          title: Registration Expiration Date
-          type: string
-      required:
-      - registration_expiration_date
-      title: RenewalEvent
-      type: object
     RenewalMode:
       enum:
       - renew
@@ -8869,6 +8834,31 @@ components:
       - type
       title: TagCreate
       type: object
+    TagEnrichedResponse:
+      properties:
+        color:
+          $ref: '#/components/schemas/TagColor'
+          description: The color of the tag
+        label:
+          description: The label of the tag
+          minLength: 1
+          title: Label
+          type: string
+        tag_id:
+          description: The unique identifier of the tag
+          examples:
+          - tag_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^tag_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: Tag Id
+          type: string
+          x-typeid-prefix: tag
+      required:
+      - tag_id
+      - label
+      - color
+      title: TagEnrichedResponse
+      type: object
     TagFilterMode:
       enum:
       - match_any
@@ -9153,31 +9143,6 @@ components:
       - both
       title: TransferAckType
       type: string
-    TransferEvent:
-      properties:
-        current_registrar:
-          title: Current Registrar
-          type: string
-        execution_date:
-          $ref: '#/components/schemas/EppDateTime'
-        expiration_date:
-          anyOf:
-          - $ref: '#/components/schemas/EppDateTime'
-          - type: 'null'
-        message:
-          title: Message
-          type: string
-        requesting_registrar:
-          title: Requesting Registrar
-          type: string
-      required:
-      - execution_date
-      - message
-      - requesting_registrar
-      - current_registrar
-      - expiration_date
-      title: TransferEvent
-      type: object
     TransferLockPolicyBase:
       properties:
         supported_by_registrar:
@@ -9970,6 +9935,11 @@ components:
           title: Whois Server
       title: WhoisBase
       type: object
+    ZoneIncludeField:
+      enum:
+      - tags
+      title: ZoneIncludeField
+      type: string
     ZoneSortField:
       enum:
       - name
@@ -10156,7 +10126,7 @@ info:
     \n\n"
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2026-04-23-230452
+  version: 2026-04-24-122704
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -12012,6 +11982,29 @@ paths:
         schema:
           $ref: '#/components/schemas/SortOrder'
           default: desc
+      - description: Filter by tag IDs. Can be specified multiple times.
+        in: query
+        name: tag_ids
+        required: false
+        schema:
+          anyOf:
+          - items:
+              examples:
+              - tag_01h45ytscbebyvny4gc8cr8ma2
+              format: typeid
+              pattern: ^tag_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+              type: string
+              x-typeid-prefix: tag
+            type: array
+          - type: 'null'
+          description: Filter by tag IDs. Can be specified multiple times.
+          title: Tag Ids
+      - in: query
+        name: tag_mode
+        required: false
+        schema:
+          $ref: '#/components/schemas/TagFilterMode'
+          default: match_any
       - in: query
         name: dnssec_status
         required: false
@@ -12080,6 +12073,20 @@ paths:
             type: string
           - type: 'null'
           title: Updated Before
+      - description: Include additional data in the response. Can be specified multiple
+          times.
+        in: query
+        name: include
+        required: false
+        schema:
+          anyOf:
+          - items:
+              $ref: '#/components/schemas/ZoneIncludeField'
+            type: array
+          - type: 'null'
+          description: Include additional data in the response. Can be specified multiple
+            times.
+          title: Include
       - in: query
         name: page
         required: false
@@ -12115,6 +12122,7 @@ paths:
                       total_pages: 1
                     results:
                     - created_on: '2025-11-18T12:43:35Z'
+                      dns_zone_id: zone_01kpwv13k2f329vastjvrckwjs
                       dnssec_status: disabled
                       domain_parts:
                         domain: example
@@ -12682,6 +12690,16 @@ paths:
           description: DNS zone name (trailing dot optional)
           title: Zone Name
           type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              anyOf:
+              - items:
+                  $ref: '#/components/schemas/ZoneIncludeField'
+                type: array
+              - type: 'null'
+              title: Include
       responses:
         '200':
           content: