@opusdns/api 0.251.0 → 0.253.0

package/package.json

@@ -3,7 +3,7 @@
     "@opusdns/api-spec-ts-generator": "^0.19.0"
   },
   "name": "@opusdns/api",
-  "version": "0.251.0",
+  "version": "0.253.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, BatchSortField, BatchStatus, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ComplianceStatus, ConditionOperator, ContactAttributeSetSortField, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsProtectedReason, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAttributeKey, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainForwardSortField, DomainForwardZoneSortField, DomainSortField, DomainStatus, EmailForwardLogSortField, EmailForwardLogStatus, EmailForwardSortField, EmailForwardZoneSortField, EmailVerificationStatus, EventObjectType, EventSortField, EventSubtype, EventType, ExecutingEntity, HTTPMethod, HostStatus, HttpProtocol, InvoiceResponsePaymentStatus, InvoiceResponseStatus, InvoiceResponseType, JobStatus, LaunchPhaseType, LegalRequirementOperationType, LegalRequirementType, LocalPresenceRequirementType, MetricsGrouping, ObjectEventType, ObjectLogSortField, OrganizationSortField, OrganizationStatus, ParkingSortField, PatchOp, PeriodUnit, Permission, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, Protocol, RedirectCode, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, ReportStatus, ReportTriggerType, ReportType, RequestHistorySortField, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TimeRange, TransferAckType, UserSortField, UserStatus, VerificationType, ZoneSortField } from './schemas';
+import { AllocationMethodType, AttributeType, BatchSortField, BatchStatus, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ComplianceStatus, ConditionOperator, ContactAttributeSetSortField, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsProtectedReason, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAttributeKey, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainForwardSortField, DomainForwardZoneSortField, DomainIncludeField, DomainSortField, DomainStatus, EmailForwardLogSortField, EmailForwardLogStatus, EmailForwardSortField, EmailForwardZoneSortField, EmailVerificationStatus, EventObjectType, EventSortField, EventSubtype, EventType, ExecutingEntity, HTTPMethod, HostStatus, HttpProtocol, InvoiceResponsePaymentStatus, InvoiceResponseStatus, InvoiceResponseType, JobStatus, LaunchPhaseType, LegalRequirementOperationType, LegalRequirementType, LocalPresenceRequirementType, MetricsGrouping, ObjectEventType, ObjectLogSortField, OrganizationSortField, OrganizationStatus, ParkingSortField, PatchOp, PeriodUnit, Permission, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, Protocol, RedirectCode, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, ReportStatus, ReportTriggerType, ReportType, RequestHistorySortField, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TagColor, TagFilterMode, TimeRange, TransferAckType, UserSortField, UserStatus, VerificationType, ZoneSortField } from './schemas';
 
 /**
  * AllocationMethodType. Auto-generated enum for AllocationMethodType
@@ -1501,6 +1501,54 @@ export const DOMAIN_FORWARD_ZONE_SORT_FIELD_VALUES = [
   'updated_on'
 ] as const satisfies [string, ...string[]] | DomainForwardZoneSortField[];
 
+/**
+ * DomainIncludeField. Auto-generated enum for DomainIncludeField
+ *
+ * @remarks
+ * This constant provides both object and array forms for the DomainIncludeField 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 = DOMAIN_INCLUDE_FIELD.SUCCESS;
+ * 
+ * // Using the array form for iteration
+ * const allStatuses = DOMAIN_INCLUDE_FIELD_VALUES;
+ * console.log(`Available statuses: ${allStatuses.join(', ')}`);
+ * ```
+ *
+ * @see {@link DomainIncludeField} - The TypeScript type definition
+ */
+export const DOMAIN_INCLUDE_FIELD = {
+  TAGS: "tags",
+} as const satisfies Record<string, DomainIncludeField>;
+
+/**
+ * Array of all DomainIncludeField enum values
+ *
+ * @remarks
+ * This constant provides a array containing all valid DomainIncludeField enum values.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all values
+ * for (const value of DOMAIN_INCLUDE_FIELD_VALUES) {
+ *   console.log(`Processing: ${value}`);
+ * }
+ * 
+ * // Validation
+ * const isValid = DOMAIN_INCLUDE_FIELD_VALUES.includes(someValue);
+ * ```
+ *
+ * @see {@link DomainIncludeField} - The TypeScript type definition
+ * @see {@link DOMAIN_INCLUDE_FIELD} - The object form of this enum
+ */
+export const DOMAIN_INCLUDE_FIELD_VALUES = [
+  'tags'
+] as const satisfies [string, ...string[]] | DomainIncludeField[];
+
 /**
  * DomainSortField. Auto-generated enum for DomainSortField
  *
@@ -4415,6 +4463,122 @@ export const TLD_TYPE_VALUES = [
   'ccTLD'
 ] as const satisfies [string, ...string[]] | TLDType[];
 
+/**
+ * TagColor. Auto-generated enum for TagColor
+ *
+ * @remarks
+ * This constant provides both object and array forms for the TagColor 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 = TAG_COLOR.SUCCESS;
+ * 
+ * // Using the array form for iteration
+ * const allStatuses = TAG_COLOR_VALUES;
+ * console.log(`Available statuses: ${allStatuses.join(', ')}`);
+ * ```
+ *
+ * @see {@link TagColor} - The TypeScript type definition
+ */
+export const TAG_COLOR = {
+  COLOR_1: "color-1",
+  COLOR_2: "color-2",
+  COLOR_3: "color-3",
+  COLOR_4: "color-4",
+  COLOR_5: "color-5",
+  COLOR_6: "color-6",
+  COLOR_7: "color-7",
+  COLOR_8: "color-8",
+  COLOR_9: "color-9",
+  COLOR_10: "color-10",
+} as const satisfies Record<string, TagColor>;
+
+/**
+ * Array of all TagColor enum values
+ *
+ * @remarks
+ * This constant provides a array containing all valid TagColor enum values.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all values
+ * for (const value of TAG_COLOR_VALUES) {
+ *   console.log(`Processing: ${value}`);
+ * }
+ * 
+ * // Validation
+ * const isValid = TAG_COLOR_VALUES.includes(someValue);
+ * ```
+ *
+ * @see {@link TagColor} - The TypeScript type definition
+ * @see {@link TAG_COLOR} - The object form of this enum
+ */
+export const TAG_COLOR_VALUES = [
+  'color-1',
+  'color-2',
+  'color-3',
+  'color-4',
+  'color-5',
+  'color-6',
+  'color-7',
+  'color-8',
+  'color-9',
+  'color-10'
+] as const satisfies [string, ...string[]] | TagColor[];
+
+/**
+ * TagFilterMode. Auto-generated enum for TagFilterMode
+ *
+ * @remarks
+ * This constant provides both object and array forms for the TagFilterMode 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 = TAG_FILTER_MODE.SUCCESS;
+ * 
+ * // Using the array form for iteration
+ * const allStatuses = TAG_FILTER_MODE_VALUES;
+ * console.log(`Available statuses: ${allStatuses.join(', ')}`);
+ * ```
+ *
+ * @see {@link TagFilterMode} - The TypeScript type definition
+ */
+export const TAG_FILTER_MODE = {
+  MATCH_ANY: "match_any",
+  MATCH_ALL: "match_all",
+} as const satisfies Record<string, TagFilterMode>;
+
+/**
+ * Array of all TagFilterMode enum values
+ *
+ * @remarks
+ * This constant provides a array containing all valid TagFilterMode enum values.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all values
+ * for (const value of TAG_FILTER_MODE_VALUES) {
+ *   console.log(`Processing: ${value}`);
+ * }
+ * 
+ * // Validation
+ * const isValid = TAG_FILTER_MODE_VALUES.includes(someValue);
+ * ```
+ *
+ * @see {@link TagFilterMode} - The TypeScript type definition
+ * @see {@link TAG_FILTER_MODE} - The object form of this enum
+ */
+export const TAG_FILTER_MODE_VALUES = [
+  'match_any',
+  'match_all'
+] as const satisfies [string, ...string[]] | TagFilterMode[];
+
 /**
  * TimeRange. Auto-generated enum for TimeRange
  *

package/src/helpers/keys.ts

@@ -151,6 +151,7 @@ import { DomainStatus2 } from './schemas';
 import { DomainStatusesBase } from './schemas';
 import { DomainSummaryData } from './schemas';
 import { DomainSummary } from './schemas';
+import { DomainTagEnriched } from './schemas';
 import { DomainTransferBulkCommand } from './schemas';
 import { DomainTransferBulkInstance } from './schemas';
 import { DomainTransferBulkPayload } from './schemas';
@@ -15462,6 +15463,31 @@ export const KEY_DOMAIN_ROID: keyof Domain = 'roid';
  * @see {@link KEYS_DOMAIN} - Array of all keys for this type
  */
 export const KEY_DOMAIN_SLD: keyof Domain = 'sld';
+/**
+ * Tags
+ *
+ * Tags assigned to this domain. Only included when ?include=tags is specified.
+ *
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `tags` property of Domain objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = domain[KEY_DOMAIN_TAGS];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_DOMAIN_TAGS;
+ * const value = domain[propertyName];
+ * ```
+ *
+ * @see {@link Domain} - The TypeScript type definition
+ * @see {@link KEYS_DOMAIN} - Array of all keys for this type
+ */
+export const KEY_DOMAIN_TAGS: keyof Domain = 'tags';
 /**
  * Tld
  *
@@ -15581,6 +15607,7 @@ export const KEYS_DOMAIN = [
   KEY_DOMAIN_RENEWAL_MODE,
   KEY_DOMAIN_ROID,
   KEY_DOMAIN_SLD,
+  KEY_DOMAIN_TAGS,
   KEY_DOMAIN_TLD,
   KEY_DOMAIN_TRANSFER_LOCK,
   KEY_DOMAIN_UPDATED_ON,
@@ -16534,6 +16561,110 @@ export const KEYS_DOMAIN_SUMMARY = [
   KEY_DOMAIN_SUMMARY_ORGANIZATION_ID,
 ] as const satisfies (keyof DomainSummary)[];
 
+/**
+ * color property
+ *
+ * The color of the tag
+ *
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `color` property of DomainTagEnriched objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = domaintagenriched[KEY_DOMAIN_TAG_ENRICHED_COLOR];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_DOMAIN_TAG_ENRICHED_COLOR;
+ * const value = domaintagenriched[propertyName];
+ * ```
+ *
+ * @see {@link DomainTagEnriched} - The TypeScript type definition
+ * @see {@link KEYS_DOMAIN_TAG_ENRICHED} - Array of all keys for this type
+ */
+export const KEY_DOMAIN_TAG_ENRICHED_COLOR: keyof DomainTagEnriched = 'color';
+/**
+ * Label
+ *
+ * The label of the tag
+ *
+ * @type {string}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `label` property of DomainTagEnriched objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = domaintagenriched[KEY_DOMAIN_TAG_ENRICHED_LABEL];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_DOMAIN_TAG_ENRICHED_LABEL;
+ * const value = domaintagenriched[propertyName];
+ * ```
+ *
+ * @see {@link DomainTagEnriched} - The TypeScript type definition
+ * @see {@link KEYS_DOMAIN_TAG_ENRICHED} - Array of all keys for this type
+ */
+export const KEY_DOMAIN_TAG_ENRICHED_LABEL: keyof DomainTagEnriched = 'label';
+/**
+ * Tag Id
+ *
+ * The unique identifier of the tag
+ *
+ * @type {string}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `tag_id` property of DomainTagEnriched objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = domaintagenriched[KEY_DOMAIN_TAG_ENRICHED_TAG_ID];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_DOMAIN_TAG_ENRICHED_TAG_ID;
+ * const value = domaintagenriched[propertyName];
+ * ```
+ *
+ * @see {@link DomainTagEnriched} - The TypeScript type definition
+ * @see {@link KEYS_DOMAIN_TAG_ENRICHED} - Array of all keys for this type
+ */
+export const KEY_DOMAIN_TAG_ENRICHED_TAG_ID: keyof DomainTagEnriched = 'tag_id';
+
+/**
+ * Array of all DomainTagEnriched property keys
+ *
+ * @remarks
+ * This constant provides a readonly array containing all valid property keys for DomainTagEnriched objects.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all keys
+ * for (const key of KEYS_DOMAIN_TAG_ENRICHED) {
+ *   console.log(`Property: ${key}, Value: ${domaintagenriched[key]}`);
+ * }
+ * 
+ * // Validation
+ * const isValidKey = KEYS_DOMAIN_TAG_ENRICHED.includes(someKey);
+ * ```
+ *
+ * @see {@link DomainTagEnriched} - The TypeScript type definition
+ */
+export const KEYS_DOMAIN_TAG_ENRICHED = [
+  KEY_DOMAIN_TAG_ENRICHED_COLOR,
+  KEY_DOMAIN_TAG_ENRICHED_LABEL,
+  KEY_DOMAIN_TAG_ENRICHED_TAG_ID,
+] as const satisfies (keyof DomainTagEnriched)[];
+
 /**
  * Command
  *

package/src/helpers/requests.d.ts

@@ -2639,7 +2639,9 @@ export type GET_DomainSearchSuggest_Request_Query = GET_DomainSearchSuggest_Requ
  * Use this type to ensure type safety when making API requests to this endpoint.
  *
  * @path /v1/domains
+ * @param tag_ids (query) - Filter by tag IDs. Can be specified multiple times.
  * @param registry_statuses (query) - Filter domains by registry status. Can be specified multiple times (union of all provided values).
+ * @param include (query) - Include additional data in the response. Can be specified multiple times.
  *
  * @see {@link GET_Domains_Request_Query} - Query parameters type
  * @see {@link GET_Domains_Request_Path} - Path parameters type
@@ -2661,7 +2663,9 @@ export type GET_Domains_Request = {
  * Use this type to ensure type safety for query parameters.
  *
  * @path /v1/domains
+ * @param tag_ids (query) - Filter by tag IDs. Can be specified multiple times.
  * @param registry_statuses (query) - Filter domains by registry status. Can be specified multiple times (union of all provided values).
+ * @param include (query) - Include additional data in the response. Can be specified multiple times.
  */
 export type GET_Domains_Request_Query = GET_Domains_Request['parameters']['query'];
 
@@ -2801,6 +2805,7 @@ export type DELETE_DomainsDomainReference_Request_Path = DELETE_DomainsDomainRef
  * Use this type to ensure type safety when making API requests to this endpoint.
  *
  * @path /v1/domains/{domain_reference}
+ * @param include (query) - Include additional data in the response.
  *
  * @see {@link GET_DomainsDomainReference_Request_Query} - Query parameters type
  * @see {@link GET_DomainsDomainReference_Request_Path} - Path parameters type
@@ -2808,9 +2813,24 @@ export type DELETE_DomainsDomainReference_Request_Path = DELETE_DomainsDomainRef
  */
 export type GET_DomainsDomainReference_Request = {
   parameters: {
+    query: operations['get_domain_v1_domains__domain_reference__get']['parameters']['query'];
     path: operations['get_domain_v1_domains__domain_reference__get']['parameters']['path'];
   };
 }
+/**
+ * Query parameters for GET /v1/domains/{domain_reference}
+ *
+ * @remarks
+ * This type defines the query parameters for the GET /v1/domains/{domain_reference} endpoint.
+ * It provides type safety for all query parameters as defined in the OpenAPI specification.
+ *
+ * @example
+ * Use this type to ensure type safety for query parameters.
+ *
+ * @path /v1/domains/{domain_reference}
+ * @param include (query) - Include additional data in the response.
+ */
+export type GET_DomainsDomainReference_Request_Query = GET_DomainsDomainReference_Request['parameters']['query'];
 /**
  * Path parameters for GET /v1/domains/{domain_reference}
  *

package/src/helpers/responses.d.ts

@@ -5047,7 +5047,9 @@ export type GET_DomainSearchSuggest_Response_502 = Problem
 
  *
  * @path /v1/domains
+ * @param tag_ids (query) - Filter by tag IDs. Can be specified multiple times.
  * @param registry_statuses (query) - Filter domains by registry status. Can be specified multiple times (union of all provided values).
+ * @param include (query) - Include additional data in the response. Can be specified multiple times.
  *
  * @see {@link GET_Domains_Response_200} - 200 response type
  * @see {@link GET_Domains_Response_422} - 422 response type
@@ -5067,7 +5069,9 @@ export type GET_Domains_Response = GET_Domains_Response_200 | GET_Domains_Respon
 
  *
  * @path /v1/domains
+ * @param tag_ids (query) - Filter by tag IDs. Can be specified multiple times.
  * @param registry_statuses (query) - Filter domains by registry status. Can be specified multiple times (union of all provided values).
+ * @param include (query) - Include additional data in the response. Can be specified multiple times.
  *
  * @see {@link GET_Domains_Response} - The main response type definition
  * @see {@link Pagination_Domain} - The actual schema type definition
@@ -5085,7 +5089,9 @@ export type GET_Domains_Response_200 = Pagination_Domain
 
  *
  * @path /v1/domains
+ * @param tag_ids (query) - Filter by tag IDs. Can be specified multiple times.
  * @param registry_statuses (query) - Filter domains by registry status. Can be specified multiple times (union of all provided values).
+ * @param include (query) - Include additional data in the response. Can be specified multiple times.
  *
  * @see {@link GET_Domains_Response} - The main response type definition
  * @see {@link HTTPValidationError} - The actual schema type definition
@@ -5291,6 +5297,7 @@ export type DELETE_DomainsByDomainReference_Response_422 = HTTPValidationError
 
  *
  * @path /v1/domains/{domain_reference}
+ * @param include (query) - Include additional data in the response.
  *
  * @see {@link GET_DomainsByDomainReference_Response_200} - 200 response type
  * @see {@link GET_DomainsByDomainReference_Response_404} - 404 response type
@@ -5311,6 +5318,7 @@ export type GET_DomainsByDomainReference_Response = GET_DomainsByDomainReference
 
  *
  * @path /v1/domains/{domain_reference}
+ * @param include (query) - Include additional data in the response.
  *
  * @see {@link GET_DomainsByDomainReference_Response} - The main response type definition
  * @see {@link Domain} - The actual schema type definition
@@ -5328,6 +5336,7 @@ export type GET_DomainsByDomainReference_Response_200 = Domain
 
  *
  * @path /v1/domains/{domain_reference}
+ * @param include (query) - Include additional data in the response.
  *
  * @see {@link GET_DomainsByDomainReference_Response} - The main response type definition
  * @see {@link Problem} - The actual schema type definition
@@ -5345,6 +5354,7 @@ export type GET_DomainsByDomainReference_Response_404 = Problem
 
  *
  * @path /v1/domains/{domain_reference}
+ * @param include (query) - Include additional data in the response.
  *
  * @see {@link GET_DomainsByDomainReference_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 { DomainDnssecData, DomainDnssecDataCreate, JobStatus, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, ReportType, ReportStatus, 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, 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, UserPublic, ParkingCreateBulkInstance, ParkingDeleteBulkInstance, ParkingDisableBulkInstance, ParkingEnableBulkInstance, Period, Permission, PremiumAffectsType, PremiumPricingAction, PublicReportRes, Relation, LegalRequirementBase, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
+import { DomainIncludeField, DomainDnssecData, DomainDnssecDataCreate, JobStatus, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, ReportType, ReportStatus, 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, UserPublic, ParkingCreateBulkInstance, ParkingDeleteBulkInstance, ParkingDisableBulkInstance, ParkingEnableBulkInstance, Period, Permission, PremiumAffectsType, PremiumPricingAction, PublicReportRes, Relation, LegalRequirementBase, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
 
+/**
+ * DomainIncludeField
+ *
+ * @remarks
+ * Array type for DomainIncludeField objects. Used when the API returns a collection of DomainIncludeField instances.
+ *
+ * @example
+ * ```typescript
+ * const items: DomainIncludeFieldArray = await api.getDomainIncludeFields();
+ * ```
+ *
+ * @see {@link DomainIncludeField} - The individual DomainIncludeField type definition
+ */
+export type DomainIncludeFieldArray = DomainIncludeField[];
 /**
  * DomainDnssecDataResponse
  *
@@ -695,6 +709,20 @@ 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

@@ -2202,6 +2202,22 @@ export type DomainForwardZoneSortField = components['schemas']['DomainForwardZon
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type DomainHost = components['schemas']['DomainHostResponse'];
+/**
+ * DomainIncludeField
+ *
+ * @remarks
+ * Type alias for the `DomainIncludeField` OpenAPI schema.
+ * This type represents domainincludefield data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getDomainIncludeField();
+ * const item: DomainIncludeField = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type DomainIncludeField = components['schemas']['DomainIncludeField'];
 /**
  * DomainLifecycleBase
  *
@@ -2490,6 +2506,22 @@ 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
  *
@@ -5604,6 +5636,38 @@ export type SyncOperationType = components['schemas']['SyncOperationType'];
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type TLDType = components['schemas']['TLDType'];
+/**
+ * TagColor
+ *
+ * @remarks
+ * Type alias for the `TagColor` OpenAPI schema.
+ * This type represents tagcolor data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getTagColor();
+ * const item: TagColor = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type TagColor = components['schemas']['TagColor'];
+/**
+ * TagFilterMode
+ *
+ * @remarks
+ * Type alias for the `TagFilterMode` OpenAPI schema.
+ * This type represents tagfiltermode data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getTagFilterMode();
+ * const item: TagFilterMode = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type TagFilterMode = components['schemas']['TagFilterMode'];
 /**
  * TimeRange
  *

package/src/openapi.yaml

@@ -3276,6 +3276,11 @@ components:
       - host_id
       title: DomainHostResponse
       type: object
+    DomainIncludeField:
+      enum:
+      - tags
+      title: DomainIncludeField
+      type: string
     DomainLifecycleBase:
       properties:
         add_grace_period:
@@ -3610,6 +3615,15 @@ components:
           minLength: 1
           title: Sld
           type: string
+        tags:
+          anyOf:
+          - items:
+              $ref: '#/components/schemas/DomainTagEnrichedResponse'
+            type: array
+          - type: 'null'
+          description: Tags assigned to this domain. Only included when ?include=tags
+            is specified.
+          title: Tags
         tld:
           description: The top level domain of the domain
           examples:
@@ -3880,6 +3894,31 @@ 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:
@@ -8623,6 +8662,26 @@ components:
       - ccTLD
       title: TLDType
       type: string
+    TagColor:
+      enum:
+      - color-1
+      - color-2
+      - color-3
+      - color-4
+      - color-5
+      - color-6
+      - color-7
+      - color-8
+      - color-9
+      - color-10
+      title: TagColor
+      type: string
+    TagFilterMode:
+      enum:
+      - match_any
+      - match_all
+      title: TagFilterMode
+      type: string
     TimeRange:
       enum:
       - 1h
@@ -9807,7 +9866,7 @@ info:
     \n\n"
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2026-04-15-160751
+  version: 2026-04-17-091139
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -15383,6 +15442,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: name
         required: false
@@ -15533,6 +15615,20 @@ paths:
           description: Filter domains by registry status. Can be specified multiple
             times (union of all provided values).
           title: Registry Statuses
+      - description: Include additional data in the response. Can be specified multiple
+          times.
+        in: query
+        name: include
+        required: false
+        schema:
+          anyOf:
+          - items:
+              $ref: '#/components/schemas/DomainIncludeField'
+            type: array
+          - type: 'null'
+          description: Include additional data in the response. Can be specified multiple
+            times.
+          title: Include
       - in: query
         name: page
         required: false
@@ -16116,6 +16212,18 @@ paths:
             x-typeid-prefix: domain
           - type: string
           title: Domain Reference
+      - description: Include additional data in the response.
+        in: query
+        name: include
+        required: false
+        schema:
+          anyOf:
+          - items:
+              $ref: '#/components/schemas/DomainIncludeField'
+            type: array
+          - type: 'null'
+          description: Include additional data in the response.
+          title: Include
       responses:
         '200':
           content:

package/src/schema.d.ts

@@ -4351,6 +4351,11 @@ export interface components {
              */
             host_id: TypeId<"host">;
         };
+        /**
+         * DomainIncludeField
+         * @enum {string}
+         */
+        DomainIncludeField: "tags";
         /** DomainLifecycleBase */
         DomainLifecycleBase: {
             /**
@@ -4582,6 +4587,11 @@ export interface components {
              * @example example
              */
             sld: string;
+            /**
+             * Tags
+             * @description Tags assigned to this domain. Only included when ?include=tags is specified.
+             */
+            tags?: components["schemas"]["DomainTagEnrichedResponse"][] | null;
             /**
              * Tld
              * @description The top level domain of the domain
@@ -4746,6 +4756,23 @@ export interface components {
              */
             organization_id: TypeId<"organization">;
         };
+        /** DomainTagEnrichedResponse */
+        DomainTagEnrichedResponse: {
+            /** @description The color of the tag */
+            color: components["schemas"]["TagColor"];
+            /**
+             * Label
+             * @description The label of the tag
+             */
+            label: string;
+            /**
+             * Tag Id
+             * Format: typeid
+             * @description The unique identifier of the tag
+             * @example tag_01h45ytscbebyvny4gc8cr8ma2
+             */
+            tag_id: TypeId<"tag">;
+        };
         /** DomainTransferBulkCommand */
         DomainTransferBulkCommand: {
             /**
@@ -7909,6 +7936,16 @@ export interface components {
          * @enum {string}
          */
         TLDType: "gTLD" | "ccTLD";
+        /**
+         * TagColor
+         * @enum {string}
+         */
+        TagColor: "color-1" | "color-2" | "color-3" | "color-4" | "color-5" | "color-6" | "color-7" | "color-8" | "color-9" | "color-10";
+        /**
+         * TagFilterMode
+         * @enum {string}
+         */
+        TagFilterMode: "match_any" | "match_all";
         /**
          * TimeRange
          * @enum {string}
@@ -12448,6 +12485,9 @@ export interface operations {
             query?: {
                 sort_by?: components["schemas"]["DomainSortField"];
                 sort_order?: components["schemas"]["SortOrder"];
+                /** @description Filter by tag IDs. Can be specified multiple times. */
+                tag_ids?: TypeId<"tag">[] | null;
+                tag_mode?: components["schemas"]["TagFilterMode"];
                 name?: string | null;
                 search?: string | null;
                 tld?: string | null;
@@ -12466,6 +12506,8 @@ export interface operations {
                 registered_before?: Date | null;
                 /** @description Filter domains by registry status. Can be specified multiple times (union of all provided values). */
                 registry_statuses?: string[] | null;
+                /** @description Include additional data in the response. Can be specified multiple times. */
+                include?: components["schemas"]["DomainIncludeField"][] | null;
                 page?: number;
                 page_size?: number;
             };
@@ -12963,7 +13005,10 @@ export interface operations {
     };
     get_domain_v1_domains__domain_reference__get: {
         parameters: {
-            query?: never;
+            query?: {
+                /** @description Include additional data in the response. */
+                include?: components["schemas"]["DomainIncludeField"][] | null;
+            };
             header?: never;
             path: {
                 domain_reference: TypeId<"domain"> | string;