@opusdns/api 0.251.0 → 0.252.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "@opusdns/api-spec-ts-generator": "^0.19.0"
4
4
  },
5
5
  "name": "@opusdns/api",
6
- "version": "0.251.0",
6
+ "version": "0.252.0",
7
7
  "description": "TypeScript types for the OpusDNS OpenAPI specification",
8
8
  "main": "./src/index.ts",
9
9
  "module": "./src/index.ts",
@@ -21,7 +21,7 @@
21
21
  * ```
22
22
  */
23
23
 
24
- 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';
24
+ 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, TimeRange, TransferAckType, UserSortField, UserStatus, VerificationType, ZoneSortField } from './schemas';
25
25
 
26
26
  /**
27
27
  * AllocationMethodType. Auto-generated enum for AllocationMethodType
@@ -1501,6 +1501,54 @@ export const DOMAIN_FORWARD_ZONE_SORT_FIELD_VALUES = [
1501
1501
  'updated_on'
1502
1502
  ] as const satisfies [string, ...string[]] | DomainForwardZoneSortField[];
1503
1503
 
1504
+ /**
1505
+ * DomainIncludeField. Auto-generated enum for DomainIncludeField
1506
+ *
1507
+ * @remarks
1508
+ * This constant provides both object and array forms for the DomainIncludeField enum.
1509
+ * The object form allows key-value access, while the array form enables iteration and validation.
1510
+ *
1511
+ * @example
1512
+ * ```typescript
1513
+ * // Using the object form for key-value access
1514
+ * const status = DOMAIN_INCLUDE_FIELD.SUCCESS;
1515
+ *
1516
+ * // Using the array form for iteration
1517
+ * const allStatuses = DOMAIN_INCLUDE_FIELD_VALUES;
1518
+ * console.log(`Available statuses: ${allStatuses.join(', ')}`);
1519
+ * ```
1520
+ *
1521
+ * @see {@link DomainIncludeField} - The TypeScript type definition
1522
+ */
1523
+ export const DOMAIN_INCLUDE_FIELD = {
1524
+ TAGS: "tags",
1525
+ } as const satisfies Record<string, DomainIncludeField>;
1526
+
1527
+ /**
1528
+ * Array of all DomainIncludeField enum values
1529
+ *
1530
+ * @remarks
1531
+ * This constant provides a array containing all valid DomainIncludeField enum values.
1532
+ * Useful for iteration, validation, and generating dynamic UI components.
1533
+ *
1534
+ * @example
1535
+ * ```typescript
1536
+ * // Iterating through all values
1537
+ * for (const value of DOMAIN_INCLUDE_FIELD_VALUES) {
1538
+ * console.log(`Processing: ${value}`);
1539
+ * }
1540
+ *
1541
+ * // Validation
1542
+ * const isValid = DOMAIN_INCLUDE_FIELD_VALUES.includes(someValue);
1543
+ * ```
1544
+ *
1545
+ * @see {@link DomainIncludeField} - The TypeScript type definition
1546
+ * @see {@link DOMAIN_INCLUDE_FIELD} - The object form of this enum
1547
+ */
1548
+ export const DOMAIN_INCLUDE_FIELD_VALUES = [
1549
+ 'tags'
1550
+ ] as const satisfies [string, ...string[]] | DomainIncludeField[];
1551
+
1504
1552
  /**
1505
1553
  * DomainSortField. Auto-generated enum for DomainSortField
1506
1554
  *
@@ -4415,6 +4463,72 @@ export const TLD_TYPE_VALUES = [
4415
4463
  'ccTLD'
4416
4464
  ] as const satisfies [string, ...string[]] | TLDType[];
4417
4465
 
4466
+ /**
4467
+ * TagColor. Auto-generated enum for TagColor
4468
+ *
4469
+ * @remarks
4470
+ * This constant provides both object and array forms for the TagColor enum.
4471
+ * The object form allows key-value access, while the array form enables iteration and validation.
4472
+ *
4473
+ * @example
4474
+ * ```typescript
4475
+ * // Using the object form for key-value access
4476
+ * const status = TAG_COLOR.SUCCESS;
4477
+ *
4478
+ * // Using the array form for iteration
4479
+ * const allStatuses = TAG_COLOR_VALUES;
4480
+ * console.log(`Available statuses: ${allStatuses.join(', ')}`);
4481
+ * ```
4482
+ *
4483
+ * @see {@link TagColor} - The TypeScript type definition
4484
+ */
4485
+ export const TAG_COLOR = {
4486
+ COLOR_1: "color-1",
4487
+ COLOR_2: "color-2",
4488
+ COLOR_3: "color-3",
4489
+ COLOR_4: "color-4",
4490
+ COLOR_5: "color-5",
4491
+ COLOR_6: "color-6",
4492
+ COLOR_7: "color-7",
4493
+ COLOR_8: "color-8",
4494
+ COLOR_9: "color-9",
4495
+ COLOR_10: "color-10",
4496
+ } as const satisfies Record<string, TagColor>;
4497
+
4498
+ /**
4499
+ * Array of all TagColor enum values
4500
+ *
4501
+ * @remarks
4502
+ * This constant provides a array containing all valid TagColor enum values.
4503
+ * Useful for iteration, validation, and generating dynamic UI components.
4504
+ *
4505
+ * @example
4506
+ * ```typescript
4507
+ * // Iterating through all values
4508
+ * for (const value of TAG_COLOR_VALUES) {
4509
+ * console.log(`Processing: ${value}`);
4510
+ * }
4511
+ *
4512
+ * // Validation
4513
+ * const isValid = TAG_COLOR_VALUES.includes(someValue);
4514
+ * ```
4515
+ *
4516
+ * @see {@link TagColor} - The TypeScript type definition
4517
+ * @see {@link TAG_COLOR} - The object form of this enum
4518
+ */
4519
+ export const TAG_COLOR_VALUES = [
4520
+ 'color-1',
4521
+ 'color-2',
4522
+ 'color-3',
4523
+ 'color-4',
4524
+ 'color-5',
4525
+ 'color-6',
4526
+ 'color-7',
4527
+ 'color-8',
4528
+ 'color-9',
4529
+ 'color-10'
4530
+ ] as const satisfies [string, ...string[]] | TagColor[];
4531
+
4418
4532
  /**
4419
4533
  * TimeRange. Auto-generated enum for TimeRange
4420
4534
  *
@@ -151,6 +151,7 @@ import { DomainStatus2 } from './schemas';
151
151
  import { DomainStatusesBase } from './schemas';
152
152
  import { DomainSummaryData } from './schemas';
153
153
  import { DomainSummary } from './schemas';
154
+ import { DomainTagEnriched } from './schemas';
154
155
  import { DomainTransferBulkCommand } from './schemas';
155
156
  import { DomainTransferBulkInstance } from './schemas';
156
157
  import { DomainTransferBulkPayload } from './schemas';
@@ -15462,6 +15463,31 @@ export const KEY_DOMAIN_ROID: keyof Domain = 'roid';
15462
15463
  * @see {@link KEYS_DOMAIN} - Array of all keys for this type
15463
15464
  */
15464
15465
  export const KEY_DOMAIN_SLD: keyof Domain = 'sld';
15466
+ /**
15467
+ * Tags
15468
+ *
15469
+ * Tags assigned to this domain. Only included when ?include=tags is specified.
15470
+ *
15471
+ *
15472
+ *
15473
+ * @remarks
15474
+ * This key constant provides type-safe access to the `tags` property of Domain objects.
15475
+ * Use this constant when you need to access properties dynamically or ensure type safety.
15476
+ *
15477
+ * @example
15478
+ * ```typescript
15479
+ * // Direct property access
15480
+ * const value = domain[KEY_DOMAIN_TAGS];
15481
+ *
15482
+ * // Dynamic property access
15483
+ * const propertyName = KEY_DOMAIN_TAGS;
15484
+ * const value = domain[propertyName];
15485
+ * ```
15486
+ *
15487
+ * @see {@link Domain} - The TypeScript type definition
15488
+ * @see {@link KEYS_DOMAIN} - Array of all keys for this type
15489
+ */
15490
+ export const KEY_DOMAIN_TAGS: keyof Domain = 'tags';
15465
15491
  /**
15466
15492
  * Tld
15467
15493
  *
@@ -15581,6 +15607,7 @@ export const KEYS_DOMAIN = [
15581
15607
  KEY_DOMAIN_RENEWAL_MODE,
15582
15608
  KEY_DOMAIN_ROID,
15583
15609
  KEY_DOMAIN_SLD,
15610
+ KEY_DOMAIN_TAGS,
15584
15611
  KEY_DOMAIN_TLD,
15585
15612
  KEY_DOMAIN_TRANSFER_LOCK,
15586
15613
  KEY_DOMAIN_UPDATED_ON,
@@ -16534,6 +16561,110 @@ export const KEYS_DOMAIN_SUMMARY = [
16534
16561
  KEY_DOMAIN_SUMMARY_ORGANIZATION_ID,
16535
16562
  ] as const satisfies (keyof DomainSummary)[];
16536
16563
 
16564
+ /**
16565
+ * color property
16566
+ *
16567
+ * The color of the tag
16568
+ *
16569
+ *
16570
+ *
16571
+ * @remarks
16572
+ * This key constant provides type-safe access to the `color` property of DomainTagEnriched objects.
16573
+ * Use this constant when you need to access properties dynamically or ensure type safety.
16574
+ *
16575
+ * @example
16576
+ * ```typescript
16577
+ * // Direct property access
16578
+ * const value = domaintagenriched[KEY_DOMAIN_TAG_ENRICHED_COLOR];
16579
+ *
16580
+ * // Dynamic property access
16581
+ * const propertyName = KEY_DOMAIN_TAG_ENRICHED_COLOR;
16582
+ * const value = domaintagenriched[propertyName];
16583
+ * ```
16584
+ *
16585
+ * @see {@link DomainTagEnriched} - The TypeScript type definition
16586
+ * @see {@link KEYS_DOMAIN_TAG_ENRICHED} - Array of all keys for this type
16587
+ */
16588
+ export const KEY_DOMAIN_TAG_ENRICHED_COLOR: keyof DomainTagEnriched = 'color';
16589
+ /**
16590
+ * Label
16591
+ *
16592
+ * The label of the tag
16593
+ *
16594
+ * @type {string}
16595
+ *
16596
+ *
16597
+ * @remarks
16598
+ * This key constant provides type-safe access to the `label` property of DomainTagEnriched objects.
16599
+ * Use this constant when you need to access properties dynamically or ensure type safety.
16600
+ *
16601
+ * @example
16602
+ * ```typescript
16603
+ * // Direct property access
16604
+ * const value = domaintagenriched[KEY_DOMAIN_TAG_ENRICHED_LABEL];
16605
+ *
16606
+ * // Dynamic property access
16607
+ * const propertyName = KEY_DOMAIN_TAG_ENRICHED_LABEL;
16608
+ * const value = domaintagenriched[propertyName];
16609
+ * ```
16610
+ *
16611
+ * @see {@link DomainTagEnriched} - The TypeScript type definition
16612
+ * @see {@link KEYS_DOMAIN_TAG_ENRICHED} - Array of all keys for this type
16613
+ */
16614
+ export const KEY_DOMAIN_TAG_ENRICHED_LABEL: keyof DomainTagEnriched = 'label';
16615
+ /**
16616
+ * Tag Id
16617
+ *
16618
+ * The unique identifier of the tag
16619
+ *
16620
+ * @type {string}
16621
+ *
16622
+ *
16623
+ * @remarks
16624
+ * This key constant provides type-safe access to the `tag_id` property of DomainTagEnriched objects.
16625
+ * Use this constant when you need to access properties dynamically or ensure type safety.
16626
+ *
16627
+ * @example
16628
+ * ```typescript
16629
+ * // Direct property access
16630
+ * const value = domaintagenriched[KEY_DOMAIN_TAG_ENRICHED_TAG_ID];
16631
+ *
16632
+ * // Dynamic property access
16633
+ * const propertyName = KEY_DOMAIN_TAG_ENRICHED_TAG_ID;
16634
+ * const value = domaintagenriched[propertyName];
16635
+ * ```
16636
+ *
16637
+ * @see {@link DomainTagEnriched} - The TypeScript type definition
16638
+ * @see {@link KEYS_DOMAIN_TAG_ENRICHED} - Array of all keys for this type
16639
+ */
16640
+ export const KEY_DOMAIN_TAG_ENRICHED_TAG_ID: keyof DomainTagEnriched = 'tag_id';
16641
+
16642
+ /**
16643
+ * Array of all DomainTagEnriched property keys
16644
+ *
16645
+ * @remarks
16646
+ * This constant provides a readonly array containing all valid property keys for DomainTagEnriched objects.
16647
+ * Useful for iteration, validation, and generating dynamic UI components.
16648
+ *
16649
+ * @example
16650
+ * ```typescript
16651
+ * // Iterating through all keys
16652
+ * for (const key of KEYS_DOMAIN_TAG_ENRICHED) {
16653
+ * console.log(`Property: ${key}, Value: ${domaintagenriched[key]}`);
16654
+ * }
16655
+ *
16656
+ * // Validation
16657
+ * const isValidKey = KEYS_DOMAIN_TAG_ENRICHED.includes(someKey);
16658
+ * ```
16659
+ *
16660
+ * @see {@link DomainTagEnriched} - The TypeScript type definition
16661
+ */
16662
+ export const KEYS_DOMAIN_TAG_ENRICHED = [
16663
+ KEY_DOMAIN_TAG_ENRICHED_COLOR,
16664
+ KEY_DOMAIN_TAG_ENRICHED_LABEL,
16665
+ KEY_DOMAIN_TAG_ENRICHED_TAG_ID,
16666
+ ] as const satisfies (keyof DomainTagEnriched)[];
16667
+
16537
16668
  /**
16538
16669
  * Command
16539
16670
  *
@@ -2640,6 +2640,8 @@ export type GET_DomainSearchSuggest_Request_Query = GET_DomainSearchSuggest_Requ
2640
2640
  *
2641
2641
  * @path /v1/domains
2642
2642
  * @param registry_statuses (query) - Filter domains by registry status. Can be specified multiple times (union of all provided values).
2643
+ * @param tag_ids (query) - Filter domains by tag IDs (OR semantics). Can be specified multiple times.
2644
+ * @param include (query) - Include additional data in the response. Can be specified multiple times.
2643
2645
  *
2644
2646
  * @see {@link GET_Domains_Request_Query} - Query parameters type
2645
2647
  * @see {@link GET_Domains_Request_Path} - Path parameters type
@@ -2662,6 +2664,8 @@ export type GET_Domains_Request = {
2662
2664
  *
2663
2665
  * @path /v1/domains
2664
2666
  * @param registry_statuses (query) - Filter domains by registry status. Can be specified multiple times (union of all provided values).
2667
+ * @param tag_ids (query) - Filter domains by tag IDs (OR semantics). Can be specified multiple times.
2668
+ * @param include (query) - Include additional data in the response. Can be specified multiple times.
2665
2669
  */
2666
2670
  export type GET_Domains_Request_Query = GET_Domains_Request['parameters']['query'];
2667
2671
 
@@ -2801,6 +2805,7 @@ export type DELETE_DomainsDomainReference_Request_Path = DELETE_DomainsDomainRef
2801
2805
  * Use this type to ensure type safety when making API requests to this endpoint.
2802
2806
  *
2803
2807
  * @path /v1/domains/{domain_reference}
2808
+ * @param include (query) - Include additional data in the response.
2804
2809
  *
2805
2810
  * @see {@link GET_DomainsDomainReference_Request_Query} - Query parameters type
2806
2811
  * @see {@link GET_DomainsDomainReference_Request_Path} - Path parameters type
@@ -2808,9 +2813,24 @@ export type DELETE_DomainsDomainReference_Request_Path = DELETE_DomainsDomainRef
2808
2813
  */
2809
2814
  export type GET_DomainsDomainReference_Request = {
2810
2815
  parameters: {
2816
+ query: operations['get_domain_v1_domains__domain_reference__get']['parameters']['query'];
2811
2817
  path: operations['get_domain_v1_domains__domain_reference__get']['parameters']['path'];
2812
2818
  };
2813
2819
  }
2820
+ /**
2821
+ * Query parameters for GET /v1/domains/{domain_reference}
2822
+ *
2823
+ * @remarks
2824
+ * This type defines the query parameters for the GET /v1/domains/{domain_reference} endpoint.
2825
+ * It provides type safety for all query parameters as defined in the OpenAPI specification.
2826
+ *
2827
+ * @example
2828
+ * Use this type to ensure type safety for query parameters.
2829
+ *
2830
+ * @path /v1/domains/{domain_reference}
2831
+ * @param include (query) - Include additional data in the response.
2832
+ */
2833
+ export type GET_DomainsDomainReference_Request_Query = GET_DomainsDomainReference_Request['parameters']['query'];
2814
2834
  /**
2815
2835
  * Path parameters for GET /v1/domains/{domain_reference}
2816
2836
  *
@@ -5048,6 +5048,8 @@ export type GET_DomainSearchSuggest_Response_502 = Problem
5048
5048
  *
5049
5049
  * @path /v1/domains
5050
5050
  * @param registry_statuses (query) - Filter domains by registry status. Can be specified multiple times (union of all provided values).
5051
+ * @param tag_ids (query) - Filter domains by tag IDs (OR semantics). Can be specified multiple times.
5052
+ * @param include (query) - Include additional data in the response. Can be specified multiple times.
5051
5053
  *
5052
5054
  * @see {@link GET_Domains_Response_200} - 200 response type
5053
5055
  * @see {@link GET_Domains_Response_422} - 422 response type
@@ -5068,6 +5070,8 @@ export type GET_Domains_Response = GET_Domains_Response_200 | GET_Domains_Respon
5068
5070
  *
5069
5071
  * @path /v1/domains
5070
5072
  * @param registry_statuses (query) - Filter domains by registry status. Can be specified multiple times (union of all provided values).
5073
+ * @param tag_ids (query) - Filter domains by tag IDs (OR semantics). Can be specified multiple times.
5074
+ * @param include (query) - Include additional data in the response. Can be specified multiple times.
5071
5075
  *
5072
5076
  * @see {@link GET_Domains_Response} - The main response type definition
5073
5077
  * @see {@link Pagination_Domain} - The actual schema type definition
@@ -5086,6 +5090,8 @@ export type GET_Domains_Response_200 = Pagination_Domain
5086
5090
  *
5087
5091
  * @path /v1/domains
5088
5092
  * @param registry_statuses (query) - Filter domains by registry status. Can be specified multiple times (union of all provided values).
5093
+ * @param tag_ids (query) - Filter domains by tag IDs (OR semantics). Can be specified multiple times.
5094
+ * @param include (query) - Include additional data in the response. Can be specified multiple times.
5089
5095
  *
5090
5096
  * @see {@link GET_Domains_Response} - The main response type definition
5091
5097
  * @see {@link HTTPValidationError} - The actual schema type definition
@@ -5291,6 +5297,7 @@ export type DELETE_DomainsByDomainReference_Response_422 = HTTPValidationError
5291
5297
 
5292
5298
  *
5293
5299
  * @path /v1/domains/{domain_reference}
5300
+ * @param include (query) - Include additional data in the response.
5294
5301
  *
5295
5302
  * @see {@link GET_DomainsByDomainReference_Response_200} - 200 response type
5296
5303
  * @see {@link GET_DomainsByDomainReference_Response_404} - 404 response type
@@ -5311,6 +5318,7 @@ export type GET_DomainsByDomainReference_Response = GET_DomainsByDomainReference
5311
5318
 
5312
5319
  *
5313
5320
  * @path /v1/domains/{domain_reference}
5321
+ * @param include (query) - Include additional data in the response.
5314
5322
  *
5315
5323
  * @see {@link GET_DomainsByDomainReference_Response} - The main response type definition
5316
5324
  * @see {@link Domain} - The actual schema type definition
@@ -5328,6 +5336,7 @@ export type GET_DomainsByDomainReference_Response_200 = Domain
5328
5336
 
5329
5337
  *
5330
5338
  * @path /v1/domains/{domain_reference}
5339
+ * @param include (query) - Include additional data in the response.
5331
5340
  *
5332
5341
  * @see {@link GET_DomainsByDomainReference_Response} - The main response type definition
5333
5342
  * @see {@link Problem} - The actual schema type definition
@@ -5345,6 +5354,7 @@ export type GET_DomainsByDomainReference_Response_404 = Problem
5345
5354
 
5346
5355
  *
5347
5356
  * @path /v1/domains/{domain_reference}
5357
+ * @param include (query) - Include additional data in the response.
5348
5358
  *
5349
5359
  * @see {@link GET_DomainsByDomainReference_Response} - The main response type definition
5350
5360
  * @see {@link HTTPValidationError} - The actual schema type definition
@@ -21,8 +21,22 @@
21
21
  * This file is auto-generated from the OpenAPI specification.
22
22
  * Do not edit manually.
23
23
  */
24
- 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';
24
+ 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';
25
25
 
26
+ /**
27
+ * DomainIncludeField
28
+ *
29
+ * @remarks
30
+ * Array type for DomainIncludeField objects. Used when the API returns a collection of DomainIncludeField instances.
31
+ *
32
+ * @example
33
+ * ```typescript
34
+ * const items: DomainIncludeFieldArray = await api.getDomainIncludeFields();
35
+ * ```
36
+ *
37
+ * @see {@link DomainIncludeField} - The individual DomainIncludeField type definition
38
+ */
39
+ export type DomainIncludeFieldArray = DomainIncludeField[];
26
40
  /**
27
41
  * DomainDnssecDataResponse
28
42
  *
@@ -695,6 +709,20 @@ export type DomainContactArray = DomainContact[];
695
709
  * @see {@link DomainHost} - The individual DomainHostResponse type definition
696
710
  */
697
711
  export type DomainHostArray = DomainHost[];
712
+ /**
713
+ * DomainTagEnrichedResponse
714
+ *
715
+ * @remarks
716
+ * Array type for DomainTagEnrichedResponse objects. Used when the API returns a collection of DomainTagEnrichedResponse instances.
717
+ *
718
+ * @example
719
+ * ```typescript
720
+ * const items: DomainTagEnrichedArray = await api.getDomainTagEnricheds();
721
+ * ```
722
+ *
723
+ * @see {@link DomainTagEnriched} - The individual DomainTagEnrichedResponse type definition
724
+ */
725
+ export type DomainTagEnrichedArray = DomainTagEnriched[];
698
726
  /**
699
727
  * DomainSearchSuggestionWithPrice
700
728
  *
@@ -2202,6 +2202,22 @@ export type DomainForwardZoneSortField = components['schemas']['DomainForwardZon
2202
2202
  * @see {@link components} - The OpenAPI components schema definition
2203
2203
  */
2204
2204
  export type DomainHost = components['schemas']['DomainHostResponse'];
2205
+ /**
2206
+ * DomainIncludeField
2207
+ *
2208
+ * @remarks
2209
+ * Type alias for the `DomainIncludeField` OpenAPI schema.
2210
+ * This type represents domainincludefield data structures used in API requests and responses.
2211
+ *
2212
+ * @example
2213
+ * ```typescript
2214
+ * const response = await api.getDomainIncludeField();
2215
+ * const item: DomainIncludeField = response.results;
2216
+ * ```
2217
+ *
2218
+ * @see {@link components} - The OpenAPI components schema definition
2219
+ */
2220
+ export type DomainIncludeField = components['schemas']['DomainIncludeField'];
2205
2221
  /**
2206
2222
  * DomainLifecycleBase
2207
2223
  *
@@ -2490,6 +2506,22 @@ export type DomainSummaryData = components['schemas']['DomainSummaryData'];
2490
2506
  * @see {@link components} - The OpenAPI components schema definition
2491
2507
  */
2492
2508
  export type DomainSummary = components['schemas']['DomainSummaryResponse'];
2509
+ /**
2510
+ * DomainTagEnrichedResponse
2511
+ *
2512
+ * @remarks
2513
+ * Type alias for the `DomainTagEnrichedResponse` OpenAPI schema.
2514
+ * This type represents domaintagenrichedresponse data structures used in API requests and responses.
2515
+ *
2516
+ * @example
2517
+ * ```typescript
2518
+ * const response = await api.getDomainTagEnriched();
2519
+ * const item: DomainTagEnriched = response.results;
2520
+ * ```
2521
+ *
2522
+ * @see {@link components} - The OpenAPI components schema definition
2523
+ */
2524
+ export type DomainTagEnriched = components['schemas']['DomainTagEnrichedResponse'];
2493
2525
  /**
2494
2526
  * DomainTransferBulkCommand
2495
2527
  *
@@ -5604,6 +5636,22 @@ export type SyncOperationType = components['schemas']['SyncOperationType'];
5604
5636
  * @see {@link components} - The OpenAPI components schema definition
5605
5637
  */
5606
5638
  export type TLDType = components['schemas']['TLDType'];
5639
+ /**
5640
+ * TagColor
5641
+ *
5642
+ * @remarks
5643
+ * Type alias for the `TagColor` OpenAPI schema.
5644
+ * This type represents tagcolor data structures used in API requests and responses.
5645
+ *
5646
+ * @example
5647
+ * ```typescript
5648
+ * const response = await api.getTagColor();
5649
+ * const item: TagColor = response.results;
5650
+ * ```
5651
+ *
5652
+ * @see {@link components} - The OpenAPI components schema definition
5653
+ */
5654
+ export type TagColor = components['schemas']['TagColor'];
5607
5655
  /**
5608
5656
  * TimeRange
5609
5657
  *
package/src/openapi.yaml CHANGED
@@ -3276,6 +3276,11 @@ components:
3276
3276
  - host_id
3277
3277
  title: DomainHostResponse
3278
3278
  type: object
3279
+ DomainIncludeField:
3280
+ enum:
3281
+ - tags
3282
+ title: DomainIncludeField
3283
+ type: string
3279
3284
  DomainLifecycleBase:
3280
3285
  properties:
3281
3286
  add_grace_period:
@@ -3610,6 +3615,15 @@ components:
3610
3615
  minLength: 1
3611
3616
  title: Sld
3612
3617
  type: string
3618
+ tags:
3619
+ anyOf:
3620
+ - items:
3621
+ $ref: '#/components/schemas/DomainTagEnrichedResponse'
3622
+ type: array
3623
+ - type: 'null'
3624
+ description: Tags assigned to this domain. Only included when ?include=tags
3625
+ is specified.
3626
+ title: Tags
3613
3627
  tld:
3614
3628
  description: The top level domain of the domain
3615
3629
  examples:
@@ -3880,6 +3894,31 @@ components:
3880
3894
  - domains
3881
3895
  title: DomainSummaryResponse
3882
3896
  type: object
3897
+ DomainTagEnrichedResponse:
3898
+ properties:
3899
+ color:
3900
+ $ref: '#/components/schemas/TagColor'
3901
+ description: The color of the tag
3902
+ label:
3903
+ description: The label of the tag
3904
+ minLength: 1
3905
+ title: Label
3906
+ type: string
3907
+ tag_id:
3908
+ description: The unique identifier of the tag
3909
+ examples:
3910
+ - tag_01h45ytscbebyvny4gc8cr8ma2
3911
+ format: typeid
3912
+ pattern: ^tag_[0-7][0-9a-hjkmnpq-tv-z]{25}$
3913
+ title: Tag Id
3914
+ type: string
3915
+ x-typeid-prefix: tag
3916
+ required:
3917
+ - tag_id
3918
+ - label
3919
+ - color
3920
+ title: DomainTagEnrichedResponse
3921
+ type: object
3883
3922
  DomainTransferBulkCommand:
3884
3923
  properties:
3885
3924
  command:
@@ -8623,6 +8662,20 @@ components:
8623
8662
  - ccTLD
8624
8663
  title: TLDType
8625
8664
  type: string
8665
+ TagColor:
8666
+ enum:
8667
+ - color-1
8668
+ - color-2
8669
+ - color-3
8670
+ - color-4
8671
+ - color-5
8672
+ - color-6
8673
+ - color-7
8674
+ - color-8
8675
+ - color-9
8676
+ - color-10
8677
+ title: TagColor
8678
+ type: string
8626
8679
  TimeRange:
8627
8680
  enum:
8628
8681
  - 1h
@@ -9807,7 +9860,7 @@ info:
9807
9860
  \n\n"
9808
9861
  summary: OpusDNS - your gateway to a seamless domain management experience.
9809
9862
  title: OpusDNS API
9810
- version: 2026-04-15-160751
9863
+ version: 2026-04-16-100706
9811
9864
  x-logo:
9812
9865
  altText: OpusDNS API Reference
9813
9866
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -15533,6 +15586,39 @@ paths:
15533
15586
  description: Filter domains by registry status. Can be specified multiple
15534
15587
  times (union of all provided values).
15535
15588
  title: Registry Statuses
15589
+ - description: Filter domains by tag IDs (OR semantics). Can be specified multiple
15590
+ times.
15591
+ in: query
15592
+ name: tag_ids
15593
+ required: false
15594
+ schema:
15595
+ anyOf:
15596
+ - items:
15597
+ examples:
15598
+ - tag_01h45ytscbebyvny4gc8cr8ma2
15599
+ format: typeid
15600
+ pattern: ^tag_[0-7][0-9a-hjkmnpq-tv-z]{25}$
15601
+ type: string
15602
+ x-typeid-prefix: tag
15603
+ type: array
15604
+ - type: 'null'
15605
+ description: Filter domains by tag IDs (OR semantics). Can be specified
15606
+ multiple times.
15607
+ title: Tag Ids
15608
+ - description: Include additional data in the response. Can be specified multiple
15609
+ times.
15610
+ in: query
15611
+ name: include
15612
+ required: false
15613
+ schema:
15614
+ anyOf:
15615
+ - items:
15616
+ $ref: '#/components/schemas/DomainIncludeField'
15617
+ type: array
15618
+ - type: 'null'
15619
+ description: Include additional data in the response. Can be specified multiple
15620
+ times.
15621
+ title: Include
15536
15622
  - in: query
15537
15623
  name: page
15538
15624
  required: false
@@ -16116,6 +16202,18 @@ paths:
16116
16202
  x-typeid-prefix: domain
16117
16203
  - type: string
16118
16204
  title: Domain Reference
16205
+ - description: Include additional data in the response.
16206
+ in: query
16207
+ name: include
16208
+ required: false
16209
+ schema:
16210
+ anyOf:
16211
+ - items:
16212
+ $ref: '#/components/schemas/DomainIncludeField'
16213
+ type: array
16214
+ - type: 'null'
16215
+ description: Include additional data in the response.
16216
+ title: Include
16119
16217
  responses:
16120
16218
  '200':
16121
16219
  content:
package/src/schema.d.ts CHANGED
@@ -4351,6 +4351,11 @@ export interface components {
4351
4351
  */
4352
4352
  host_id: TypeId<"host">;
4353
4353
  };
4354
+ /**
4355
+ * DomainIncludeField
4356
+ * @enum {string}
4357
+ */
4358
+ DomainIncludeField: "tags";
4354
4359
  /** DomainLifecycleBase */
4355
4360
  DomainLifecycleBase: {
4356
4361
  /**
@@ -4582,6 +4587,11 @@ export interface components {
4582
4587
  * @example example
4583
4588
  */
4584
4589
  sld: string;
4590
+ /**
4591
+ * Tags
4592
+ * @description Tags assigned to this domain. Only included when ?include=tags is specified.
4593
+ */
4594
+ tags?: components["schemas"]["DomainTagEnrichedResponse"][] | null;
4585
4595
  /**
4586
4596
  * Tld
4587
4597
  * @description The top level domain of the domain
@@ -4746,6 +4756,23 @@ export interface components {
4746
4756
  */
4747
4757
  organization_id: TypeId<"organization">;
4748
4758
  };
4759
+ /** DomainTagEnrichedResponse */
4760
+ DomainTagEnrichedResponse: {
4761
+ /** @description The color of the tag */
4762
+ color: components["schemas"]["TagColor"];
4763
+ /**
4764
+ * Label
4765
+ * @description The label of the tag
4766
+ */
4767
+ label: string;
4768
+ /**
4769
+ * Tag Id
4770
+ * Format: typeid
4771
+ * @description The unique identifier of the tag
4772
+ * @example tag_01h45ytscbebyvny4gc8cr8ma2
4773
+ */
4774
+ tag_id: TypeId<"tag">;
4775
+ };
4749
4776
  /** DomainTransferBulkCommand */
4750
4777
  DomainTransferBulkCommand: {
4751
4778
  /**
@@ -7909,6 +7936,11 @@ export interface components {
7909
7936
  * @enum {string}
7910
7937
  */
7911
7938
  TLDType: "gTLD" | "ccTLD";
7939
+ /**
7940
+ * TagColor
7941
+ * @enum {string}
7942
+ */
7943
+ TagColor: "color-1" | "color-2" | "color-3" | "color-4" | "color-5" | "color-6" | "color-7" | "color-8" | "color-9" | "color-10";
7912
7944
  /**
7913
7945
  * TimeRange
7914
7946
  * @enum {string}
@@ -12466,6 +12498,10 @@ export interface operations {
12466
12498
  registered_before?: Date | null;
12467
12499
  /** @description Filter domains by registry status. Can be specified multiple times (union of all provided values). */
12468
12500
  registry_statuses?: string[] | null;
12501
+ /** @description Filter domains by tag IDs (OR semantics). Can be specified multiple times. */
12502
+ tag_ids?: TypeId<"tag">[] | null;
12503
+ /** @description Include additional data in the response. Can be specified multiple times. */
12504
+ include?: components["schemas"]["DomainIncludeField"][] | null;
12469
12505
  page?: number;
12470
12506
  page_size?: number;
12471
12507
  };
@@ -12963,7 +12999,10 @@ export interface operations {
12963
12999
  };
12964
13000
  get_domain_v1_domains__domain_reference__get: {
12965
13001
  parameters: {
12966
- query?: never;
13002
+ query?: {
13003
+ /** @description Include additional data in the response. */
13004
+ include?: components["schemas"]["DomainIncludeField"][] | null;
13005
+ };
12967
13006
  header?: never;
12968
13007
  path: {
12969
13008
  domain_reference: TypeId<"domain"> | string;