@opusdns/api 0.265.0 → 0.266.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.265.0",
6
+ "version": "0.266.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, 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, TagSortField, TagType, 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, TagFilterMode, TagSortField, TagType, TimeRange, TransferAckType, UserSortField, UserStatus, VerificationType, ZoneIncludeField, ZoneSortField } from './schemas';
25
25
 
26
26
  /**
27
27
  * AllocationMethodType. Auto-generated enum for AllocationMethodType
@@ -4967,6 +4967,54 @@ export const VERIFICATION_TYPE_VALUES = [
4967
4967
  'email'
4968
4968
  ] as const satisfies [string, ...string[]] | VerificationType[];
4969
4969
 
4970
+ /**
4971
+ * ZoneIncludeField. Auto-generated enum for ZoneIncludeField
4972
+ *
4973
+ * @remarks
4974
+ * This constant provides both object and array forms for the ZoneIncludeField enum.
4975
+ * The object form allows key-value access, while the array form enables iteration and validation.
4976
+ *
4977
+ * @example
4978
+ * ```typescript
4979
+ * // Using the object form for key-value access
4980
+ * const status = ZONE_INCLUDE_FIELD.SUCCESS;
4981
+ *
4982
+ * // Using the array form for iteration
4983
+ * const allStatuses = ZONE_INCLUDE_FIELD_VALUES;
4984
+ * console.log(`Available statuses: ${allStatuses.join(', ')}`);
4985
+ * ```
4986
+ *
4987
+ * @see {@link ZoneIncludeField} - The TypeScript type definition
4988
+ */
4989
+ export const ZONE_INCLUDE_FIELD = {
4990
+ TAGS: "tags",
4991
+ } as const satisfies Record<string, ZoneIncludeField>;
4992
+
4993
+ /**
4994
+ * Array of all ZoneIncludeField enum values
4995
+ *
4996
+ * @remarks
4997
+ * This constant provides a array containing all valid ZoneIncludeField enum values.
4998
+ * Useful for iteration, validation, and generating dynamic UI components.
4999
+ *
5000
+ * @example
5001
+ * ```typescript
5002
+ * // Iterating through all values
5003
+ * for (const value of ZONE_INCLUDE_FIELD_VALUES) {
5004
+ * console.log(`Processing: ${value}`);
5005
+ * }
5006
+ *
5007
+ * // Validation
5008
+ * const isValid = ZONE_INCLUDE_FIELD_VALUES.includes(someValue);
5009
+ * ```
5010
+ *
5011
+ * @see {@link ZoneIncludeField} - The TypeScript type definition
5012
+ * @see {@link ZONE_INCLUDE_FIELD} - The object form of this enum
5013
+ */
5014
+ export const ZONE_INCLUDE_FIELD_VALUES = [
5015
+ 'tags'
5016
+ ] as const satisfies [string, ...string[]] | ZoneIncludeField[];
5017
+
4970
5018
  /**
4971
5019
  * ZoneSortField. Auto-generated enum for ZoneSortField
4972
5020
  *
@@ -152,7 +152,6 @@ import { DomainStatus2 } from './schemas';
152
152
  import { DomainStatusesBase } from './schemas';
153
153
  import { DomainSummaryData } from './schemas';
154
154
  import { DomainSummary } from './schemas';
155
- import { DomainTagEnriched } from './schemas';
156
155
  import { DomainTransferBulkCommand } from './schemas';
157
156
  import { DomainTransferBulkInstance } from './schemas';
158
157
  import { DomainTransferBulkPayload } from './schemas';
@@ -280,6 +279,7 @@ import { SpiceDbRelationshipUpdate } from './schemas';
280
279
  import { StatusChanges } from './schemas';
281
280
  import { StatusCodeStatsBucket } from './schemas';
282
281
  import { TagCreate } from './schemas';
282
+ import { TagEnriched } from './schemas';
283
283
  import { Tag } from './schemas';
284
284
  import { TagUpdate } from './schemas';
285
285
  import { TimeSeriesBucket } from './schemas';
@@ -9516,6 +9516,32 @@ export const KEYS_DNS_ZONE_RECORDS_PATCH_OPS = [
9516
9516
  * @see {@link KEYS_DNS_ZONE} - Array of all keys for this type
9517
9517
  */
9518
9518
  export const KEY_DNS_ZONE_CREATED_ON: keyof DnsZone = 'created_on';
9519
+ /**
9520
+ * Dns Zone Id
9521
+ *
9522
+ * The unique identifier of the zone
9523
+ *
9524
+ * @type {string}
9525
+ *
9526
+ *
9527
+ * @remarks
9528
+ * This key constant provides type-safe access to the `dns_zone_id` property of DnsZone objects.
9529
+ * Use this constant when you need to access properties dynamically or ensure type safety.
9530
+ *
9531
+ * @example
9532
+ * ```typescript
9533
+ * // Direct property access
9534
+ * const value = dnszone[KEY_DNS_ZONE_DNS_ZONE_ID];
9535
+ *
9536
+ * // Dynamic property access
9537
+ * const propertyName = KEY_DNS_ZONE_DNS_ZONE_ID;
9538
+ * const value = dnszone[propertyName];
9539
+ * ```
9540
+ *
9541
+ * @see {@link DnsZone} - The TypeScript type definition
9542
+ * @see {@link KEYS_DNS_ZONE} - Array of all keys for this type
9543
+ */
9544
+ export const KEY_DNS_ZONE_DNS_ZONE_ID: keyof DnsZone = 'dns_zone_id';
9519
9545
  /**
9520
9546
  * dnssec_status property
9521
9547
  *
@@ -9614,6 +9640,31 @@ export const KEY_DNS_ZONE_NAME: keyof DnsZone = 'name';
9614
9640
  * @see {@link KEYS_DNS_ZONE} - Array of all keys for this type
9615
9641
  */
9616
9642
  export const KEY_DNS_ZONE_RRSETS: keyof DnsZone = 'rrsets';
9643
+ /**
9644
+ * Tags
9645
+ *
9646
+ * Tags assigned to this zone. Only included when ?include=tags is specified.
9647
+ *
9648
+ *
9649
+ *
9650
+ * @remarks
9651
+ * This key constant provides type-safe access to the `tags` property of DnsZone objects.
9652
+ * Use this constant when you need to access properties dynamically or ensure type safety.
9653
+ *
9654
+ * @example
9655
+ * ```typescript
9656
+ * // Direct property access
9657
+ * const value = dnszone[KEY_DNS_ZONE_TAGS];
9658
+ *
9659
+ * // Dynamic property access
9660
+ * const propertyName = KEY_DNS_ZONE_TAGS;
9661
+ * const value = dnszone[propertyName];
9662
+ * ```
9663
+ *
9664
+ * @see {@link DnsZone} - The TypeScript type definition
9665
+ * @see {@link KEYS_DNS_ZONE} - Array of all keys for this type
9666
+ */
9667
+ export const KEY_DNS_ZONE_TAGS: keyof DnsZone = 'tags';
9617
9668
  /**
9618
9669
  * Updated On
9619
9670
  *
@@ -9663,10 +9714,12 @@ export const KEY_DNS_ZONE_UPDATED_ON: keyof DnsZone = 'updated_on';
9663
9714
  */
9664
9715
  export const KEYS_DNS_ZONE = [
9665
9716
  KEY_DNS_ZONE_CREATED_ON,
9717
+ KEY_DNS_ZONE_DNS_ZONE_ID,
9666
9718
  KEY_DNS_ZONE_DNSSEC_STATUS,
9667
9719
  KEY_DNS_ZONE_DOMAIN_PARTS,
9668
9720
  KEY_DNS_ZONE_NAME,
9669
9721
  KEY_DNS_ZONE_RRSETS,
9722
+ KEY_DNS_ZONE_TAGS,
9670
9723
  KEY_DNS_ZONE_UPDATED_ON,
9671
9724
  ] as const satisfies (keyof DnsZone)[];
9672
9725
 
@@ -16726,110 +16779,6 @@ export const KEYS_DOMAIN_SUMMARY = [
16726
16779
  KEY_DOMAIN_SUMMARY_ORGANIZATION_ID,
16727
16780
  ] as const satisfies (keyof DomainSummary)[];
16728
16781
 
16729
- /**
16730
- * color property
16731
- *
16732
- * The color of the tag
16733
- *
16734
- *
16735
- *
16736
- * @remarks
16737
- * This key constant provides type-safe access to the `color` property of DomainTagEnriched objects.
16738
- * Use this constant when you need to access properties dynamically or ensure type safety.
16739
- *
16740
- * @example
16741
- * ```typescript
16742
- * // Direct property access
16743
- * const value = domaintagenriched[KEY_DOMAIN_TAG_ENRICHED_COLOR];
16744
- *
16745
- * // Dynamic property access
16746
- * const propertyName = KEY_DOMAIN_TAG_ENRICHED_COLOR;
16747
- * const value = domaintagenriched[propertyName];
16748
- * ```
16749
- *
16750
- * @see {@link DomainTagEnriched} - The TypeScript type definition
16751
- * @see {@link KEYS_DOMAIN_TAG_ENRICHED} - Array of all keys for this type
16752
- */
16753
- export const KEY_DOMAIN_TAG_ENRICHED_COLOR: keyof DomainTagEnriched = 'color';
16754
- /**
16755
- * Label
16756
- *
16757
- * The label of the tag
16758
- *
16759
- * @type {string}
16760
- *
16761
- *
16762
- * @remarks
16763
- * This key constant provides type-safe access to the `label` property of DomainTagEnriched objects.
16764
- * Use this constant when you need to access properties dynamically or ensure type safety.
16765
- *
16766
- * @example
16767
- * ```typescript
16768
- * // Direct property access
16769
- * const value = domaintagenriched[KEY_DOMAIN_TAG_ENRICHED_LABEL];
16770
- *
16771
- * // Dynamic property access
16772
- * const propertyName = KEY_DOMAIN_TAG_ENRICHED_LABEL;
16773
- * const value = domaintagenriched[propertyName];
16774
- * ```
16775
- *
16776
- * @see {@link DomainTagEnriched} - The TypeScript type definition
16777
- * @see {@link KEYS_DOMAIN_TAG_ENRICHED} - Array of all keys for this type
16778
- */
16779
- export const KEY_DOMAIN_TAG_ENRICHED_LABEL: keyof DomainTagEnriched = 'label';
16780
- /**
16781
- * Tag Id
16782
- *
16783
- * The unique identifier of the tag
16784
- *
16785
- * @type {string}
16786
- *
16787
- *
16788
- * @remarks
16789
- * This key constant provides type-safe access to the `tag_id` property of DomainTagEnriched objects.
16790
- * Use this constant when you need to access properties dynamically or ensure type safety.
16791
- *
16792
- * @example
16793
- * ```typescript
16794
- * // Direct property access
16795
- * const value = domaintagenriched[KEY_DOMAIN_TAG_ENRICHED_TAG_ID];
16796
- *
16797
- * // Dynamic property access
16798
- * const propertyName = KEY_DOMAIN_TAG_ENRICHED_TAG_ID;
16799
- * const value = domaintagenriched[propertyName];
16800
- * ```
16801
- *
16802
- * @see {@link DomainTagEnriched} - The TypeScript type definition
16803
- * @see {@link KEYS_DOMAIN_TAG_ENRICHED} - Array of all keys for this type
16804
- */
16805
- export const KEY_DOMAIN_TAG_ENRICHED_TAG_ID: keyof DomainTagEnriched = 'tag_id';
16806
-
16807
- /**
16808
- * Array of all DomainTagEnriched property keys
16809
- *
16810
- * @remarks
16811
- * This constant provides a readonly array containing all valid property keys for DomainTagEnriched objects.
16812
- * Useful for iteration, validation, and generating dynamic UI components.
16813
- *
16814
- * @example
16815
- * ```typescript
16816
- * // Iterating through all keys
16817
- * for (const key of KEYS_DOMAIN_TAG_ENRICHED) {
16818
- * console.log(`Property: ${key}, Value: ${domaintagenriched[key]}`);
16819
- * }
16820
- *
16821
- * // Validation
16822
- * const isValidKey = KEYS_DOMAIN_TAG_ENRICHED.includes(someKey);
16823
- * ```
16824
- *
16825
- * @see {@link DomainTagEnriched} - The TypeScript type definition
16826
- */
16827
- export const KEYS_DOMAIN_TAG_ENRICHED = [
16828
- KEY_DOMAIN_TAG_ENRICHED_COLOR,
16829
- KEY_DOMAIN_TAG_ENRICHED_LABEL,
16830
- KEY_DOMAIN_TAG_ENRICHED_TAG_ID,
16831
- ] as const satisfies (keyof DomainTagEnriched)[];
16832
-
16833
16782
  /**
16834
16783
  * Command
16835
16784
  *
@@ -34960,6 +34909,110 @@ export const KEYS_TAG_CREATE = [
34960
34909
  KEY_TAG_CREATE_TYPE,
34961
34910
  ] as const satisfies (keyof TagCreate)[];
34962
34911
 
34912
+ /**
34913
+ * color property
34914
+ *
34915
+ * The color of the tag
34916
+ *
34917
+ *
34918
+ *
34919
+ * @remarks
34920
+ * This key constant provides type-safe access to the `color` property of TagEnriched objects.
34921
+ * Use this constant when you need to access properties dynamically or ensure type safety.
34922
+ *
34923
+ * @example
34924
+ * ```typescript
34925
+ * // Direct property access
34926
+ * const value = tagenriched[KEY_TAG_ENRICHED_COLOR];
34927
+ *
34928
+ * // Dynamic property access
34929
+ * const propertyName = KEY_TAG_ENRICHED_COLOR;
34930
+ * const value = tagenriched[propertyName];
34931
+ * ```
34932
+ *
34933
+ * @see {@link TagEnriched} - The TypeScript type definition
34934
+ * @see {@link KEYS_TAG_ENRICHED} - Array of all keys for this type
34935
+ */
34936
+ export const KEY_TAG_ENRICHED_COLOR: keyof TagEnriched = 'color';
34937
+ /**
34938
+ * Label
34939
+ *
34940
+ * The label of the tag
34941
+ *
34942
+ * @type {string}
34943
+ *
34944
+ *
34945
+ * @remarks
34946
+ * This key constant provides type-safe access to the `label` property of TagEnriched objects.
34947
+ * Use this constant when you need to access properties dynamically or ensure type safety.
34948
+ *
34949
+ * @example
34950
+ * ```typescript
34951
+ * // Direct property access
34952
+ * const value = tagenriched[KEY_TAG_ENRICHED_LABEL];
34953
+ *
34954
+ * // Dynamic property access
34955
+ * const propertyName = KEY_TAG_ENRICHED_LABEL;
34956
+ * const value = tagenriched[propertyName];
34957
+ * ```
34958
+ *
34959
+ * @see {@link TagEnriched} - The TypeScript type definition
34960
+ * @see {@link KEYS_TAG_ENRICHED} - Array of all keys for this type
34961
+ */
34962
+ export const KEY_TAG_ENRICHED_LABEL: keyof TagEnriched = 'label';
34963
+ /**
34964
+ * Tag Id
34965
+ *
34966
+ * The unique identifier of the tag
34967
+ *
34968
+ * @type {string}
34969
+ *
34970
+ *
34971
+ * @remarks
34972
+ * This key constant provides type-safe access to the `tag_id` property of TagEnriched objects.
34973
+ * Use this constant when you need to access properties dynamically or ensure type safety.
34974
+ *
34975
+ * @example
34976
+ * ```typescript
34977
+ * // Direct property access
34978
+ * const value = tagenriched[KEY_TAG_ENRICHED_TAG_ID];
34979
+ *
34980
+ * // Dynamic property access
34981
+ * const propertyName = KEY_TAG_ENRICHED_TAG_ID;
34982
+ * const value = tagenriched[propertyName];
34983
+ * ```
34984
+ *
34985
+ * @see {@link TagEnriched} - The TypeScript type definition
34986
+ * @see {@link KEYS_TAG_ENRICHED} - Array of all keys for this type
34987
+ */
34988
+ export const KEY_TAG_ENRICHED_TAG_ID: keyof TagEnriched = 'tag_id';
34989
+
34990
+ /**
34991
+ * Array of all TagEnriched property keys
34992
+ *
34993
+ * @remarks
34994
+ * This constant provides a readonly array containing all valid property keys for TagEnriched objects.
34995
+ * Useful for iteration, validation, and generating dynamic UI components.
34996
+ *
34997
+ * @example
34998
+ * ```typescript
34999
+ * // Iterating through all keys
35000
+ * for (const key of KEYS_TAG_ENRICHED) {
35001
+ * console.log(`Property: ${key}, Value: ${tagenriched[key]}`);
35002
+ * }
35003
+ *
35004
+ * // Validation
35005
+ * const isValidKey = KEYS_TAG_ENRICHED.includes(someKey);
35006
+ * ```
35007
+ *
35008
+ * @see {@link TagEnriched} - The TypeScript type definition
35009
+ */
35010
+ export const KEYS_TAG_ENRICHED = [
35011
+ KEY_TAG_ENRICHED_COLOR,
35012
+ KEY_TAG_ENRICHED_LABEL,
35013
+ KEY_TAG_ENRICHED_TAG_ID,
35014
+ ] as const satisfies (keyof TagEnriched)[];
35015
+
34963
35016
  /**
34964
35017
  * color property
34965
35018
  *
@@ -1137,6 +1137,8 @@ export type GET_ContactsVerify_Request_Query = GET_ContactsVerify_Request['param
1137
1137
  * Use this type to ensure type safety when making API requests to this endpoint.
1138
1138
  *
1139
1139
  * @path /v1/dns
1140
+ * @param tag_ids (query) - Filter by tag IDs. Can be specified multiple times.
1141
+ * @param include (query) - Include additional data in the response. Can be specified multiple times.
1140
1142
  *
1141
1143
  * @see {@link GET_Dns_Request_Query} - Query parameters type
1142
1144
  * @see {@link GET_Dns_Request_Path} - Path parameters type
@@ -1158,6 +1160,8 @@ export type GET_Dns_Request = {
1158
1160
  * Use this type to ensure type safety for query parameters.
1159
1161
  *
1160
1162
  * @path /v1/dns
1163
+ * @param tag_ids (query) - Filter by tag IDs. Can be specified multiple times.
1164
+ * @param include (query) - Include additional data in the response. Can be specified multiple times.
1161
1165
  */
1162
1166
  export type GET_Dns_Request_Query = GET_Dns_Request['parameters']['query'];
1163
1167
 
@@ -1361,6 +1365,7 @@ export type GET_DnsZoneName_Request = {
1361
1365
  parameters: {
1362
1366
  path: operations['get_zone_v1_dns__zone_name__get']['parameters']['path'];
1363
1367
  };
1368
+ requestBody: unknown;
1364
1369
  }
1365
1370
  /**
1366
1371
  * Path parameters for GET /v1/dns/{zone_name}
@@ -1376,6 +1381,19 @@ export type GET_DnsZoneName_Request = {
1376
1381
  * @param zone_name (path) - DNS zone name (trailing dot optional)
1377
1382
  */
1378
1383
  export type GET_DnsZoneName_Request_Path = GET_DnsZoneName_Request['parameters']['path'];
1384
+ /**
1385
+ * Request body for GET /v1/dns/{zone_name}
1386
+ *
1387
+ * @remarks
1388
+ * This type defines the request body structure for the GET /v1/dns/{zone_name} endpoint.
1389
+ * It provides type safety for the request body as defined in the OpenAPI specification.
1390
+ *
1391
+ * @example
1392
+ * Use this type to ensure type safety for request body structure.
1393
+ *
1394
+ * @path /v1/dns/{zone_name}
1395
+ */
1396
+ export type GET_DnsZoneName_Request_Body = GET_DnsZoneName_Request['requestBody'];
1379
1397
 
1380
1398
  /**
1381
1399
  * Request type for POST DnsZoneNameDnssecDisable endpoint
@@ -1853,6 +1853,8 @@ export type GET_ContactsVerify_Response_422 = HTTPValidationError
1853
1853
 
1854
1854
  *
1855
1855
  * @path /v1/dns
1856
+ * @param tag_ids (query) - Filter by tag IDs. Can be specified multiple times.
1857
+ * @param include (query) - Include additional data in the response. Can be specified multiple times.
1856
1858
  *
1857
1859
  * @see {@link GET_Dns_Response_200} - 200 response type
1858
1860
  * @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;
1872
1874
 
1873
1875
  *
1874
1876
  * @path /v1/dns
1877
+ * @param tag_ids (query) - Filter by tag IDs. Can be specified multiple times.
1878
+ * @param include (query) - Include additional data in the response. Can be specified multiple times.
1875
1879
  *
1876
1880
  * @see {@link GET_Dns_Response} - The main response type definition
1877
1881
  * @see {@link Pagination_DnsZone} - The actual schema type definition
@@ -1889,6 +1893,8 @@ export type GET_Dns_Response_200 = Pagination_DnsZone
1889
1893
 
1890
1894
  *
1891
1895
  * @path /v1/dns
1896
+ * @param tag_ids (query) - Filter by tag IDs. Can be specified multiple times.
1897
+ * @param include (query) - Include additional data in the response. Can be specified multiple times.
1892
1898
  *
1893
1899
  * @see {@link GET_Dns_Response} - The main response type definition
1894
1900
  * @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 { 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';
24
+ 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';
25
25
 
26
+ /**
27
+ * ZoneIncludeField
28
+ *
29
+ * @remarks
30
+ * Array type for ZoneIncludeField objects. Used when the API returns a collection of ZoneIncludeField instances.
31
+ *
32
+ * @example
33
+ * ```typescript
34
+ * const items: ZoneIncludeFieldArray = await api.getZoneIncludeFields();
35
+ * ```
36
+ *
37
+ * @see {@link ZoneIncludeField} - The individual ZoneIncludeField type definition
38
+ */
39
+ export type ZoneIncludeFieldArray = ZoneIncludeField[];
26
40
  /**
27
41
  * DomainIncludeField
28
42
  *
@@ -429,6 +443,20 @@ export type DnsZonePatchRrsetsBulkInstanceArray = DnsZonePatchRrsetsBulkInstance
429
443
  * @see {@link DnsRrset} - The individual DnsRrsetResponse type definition
430
444
  */
431
445
  export type DnsRrsetArray = DnsRrset[];
446
+ /**
447
+ * TagEnrichedResponse
448
+ *
449
+ * @remarks
450
+ * Array type for TagEnrichedResponse objects. Used when the API returns a collection of TagEnrichedResponse instances.
451
+ *
452
+ * @example
453
+ * ```typescript
454
+ * const items: TagEnrichedArray = await api.getTagEnricheds();
455
+ * ```
456
+ *
457
+ * @see {@link TagEnriched} - The individual TagEnrichedResponse type definition
458
+ */
459
+ export type TagEnrichedArray = TagEnriched[];
432
460
  /**
433
461
  * DnsZoneUpdateBulkInstance
434
462
  *
@@ -723,20 +751,6 @@ export type DomainContactArray = DomainContact[];
723
751
  * @see {@link DomainHost} - The individual DomainHostResponse type definition
724
752
  */
725
753
  export type DomainHostArray = DomainHost[];
726
- /**
727
- * DomainTagEnrichedResponse
728
- *
729
- * @remarks
730
- * Array type for DomainTagEnrichedResponse objects. Used when the API returns a collection of DomainTagEnrichedResponse instances.
731
- *
732
- * @example
733
- * ```typescript
734
- * const items: DomainTagEnrichedArray = await api.getDomainTagEnricheds();
735
- * ```
736
- *
737
- * @see {@link DomainTagEnriched} - The individual DomainTagEnrichedResponse type definition
738
- */
739
- export type DomainTagEnrichedArray = DomainTagEnriched[];
740
754
  /**
741
755
  * DomainSearchSuggestionWithPrice
742
756
  *
@@ -2522,22 +2522,6 @@ export type DomainSummaryData = components['schemas']['DomainSummaryData'];
2522
2522
  * @see {@link components} - The OpenAPI components schema definition
2523
2523
  */
2524
2524
  export type DomainSummary = components['schemas']['DomainSummaryResponse'];
2525
- /**
2526
- * DomainTagEnrichedResponse
2527
- *
2528
- * @remarks
2529
- * Type alias for the `DomainTagEnrichedResponse` OpenAPI schema.
2530
- * This type represents domaintagenrichedresponse data structures used in API requests and responses.
2531
- *
2532
- * @example
2533
- * ```typescript
2534
- * const response = await api.getDomainTagEnriched();
2535
- * const item: DomainTagEnriched = response.results;
2536
- * ```
2537
- *
2538
- * @see {@link components} - The OpenAPI components schema definition
2539
- */
2540
- export type DomainTagEnriched = components['schemas']['DomainTagEnrichedResponse'];
2541
2525
  /**
2542
2526
  * DomainTransferBulkCommand
2543
2527
  *
@@ -5780,6 +5764,22 @@ export type TagColor = components['schemas']['TagColor'];
5780
5764
  * @see {@link components} - The OpenAPI components schema definition
5781
5765
  */
5782
5766
  export type TagCreate = components['schemas']['TagCreate'];
5767
+ /**
5768
+ * TagEnrichedResponse
5769
+ *
5770
+ * @remarks
5771
+ * Type alias for the `TagEnrichedResponse` OpenAPI schema.
5772
+ * This type represents tagenrichedresponse data structures used in API requests and responses.
5773
+ *
5774
+ * @example
5775
+ * ```typescript
5776
+ * const response = await api.getTagEnriched();
5777
+ * const item: TagEnriched = response.results;
5778
+ * ```
5779
+ *
5780
+ * @see {@link components} - The OpenAPI components schema definition
5781
+ */
5782
+ export type TagEnriched = components['schemas']['TagEnrichedResponse'];
5783
5783
  /**
5784
5784
  * TagFilterMode
5785
5785
  *
@@ -6276,6 +6276,22 @@ export type VisitsByKeyBucket = components['schemas']['VisitsByKeyBucket'];
6276
6276
  * @see {@link components} - The OpenAPI components schema definition
6277
6277
  */
6278
6278
  export type WhoisBase = components['schemas']['WhoisBase'];
6279
+ /**
6280
+ * ZoneIncludeField
6281
+ *
6282
+ * @remarks
6283
+ * Type alias for the `ZoneIncludeField` OpenAPI schema.
6284
+ * This type represents zoneincludefield data structures used in API requests and responses.
6285
+ *
6286
+ * @example
6287
+ * ```typescript
6288
+ * const response = await api.getZoneIncludeField();
6289
+ * const item: ZoneIncludeField = response.results;
6290
+ * ```
6291
+ *
6292
+ * @see {@link components} - The OpenAPI components schema definition
6293
+ */
6294
+ export type ZoneIncludeField = components['schemas']['ZoneIncludeField'];
6279
6295
  /**
6280
6296
  * ZoneSortField
6281
6297
  *
package/src/openapi.yaml CHANGED
@@ -2232,6 +2232,15 @@ components:
2232
2232
  format: date-time
2233
2233
  title: Created On
2234
2234
  type: string
2235
+ dns_zone_id:
2236
+ description: The unique identifier of the zone
2237
+ examples:
2238
+ - zone_01h45ytscbebyvny4gc8cr8ma2
2239
+ format: typeid
2240
+ pattern: ^zone_[0-7][0-9a-hjkmnpq-tv-z]{25}$
2241
+ title: Dns Zone Id
2242
+ type: string
2243
+ x-typeid-prefix: zone
2235
2244
  dnssec_status:
2236
2245
  $ref: '#/components/schemas/DnssecStatus'
2237
2246
  default: disabled
@@ -2245,6 +2254,15 @@ components:
2245
2254
  $ref: '#/components/schemas/DnsRrsetResponse'
2246
2255
  title: Rrsets
2247
2256
  type: array
2257
+ tags:
2258
+ anyOf:
2259
+ - items:
2260
+ $ref: '#/components/schemas/TagEnrichedResponse'
2261
+ type: array
2262
+ - type: 'null'
2263
+ description: Tags assigned to this zone. Only included when ?include=tags
2264
+ is specified.
2265
+ title: Tags
2248
2266
  updated_on:
2249
2267
  description: The date/time the entry was last updated on
2250
2268
  format: date-time
@@ -2252,6 +2270,7 @@ components:
2252
2270
  type: string
2253
2271
  required:
2254
2272
  - name
2273
+ - dns_zone_id
2255
2274
  title: DnsZoneResponse
2256
2275
  type: object
2257
2276
  DnsZoneRrsetsCreate:
@@ -3680,7 +3699,7 @@ components:
3680
3699
  tags:
3681
3700
  anyOf:
3682
3701
  - items:
3683
- $ref: '#/components/schemas/DomainTagEnrichedResponse'
3702
+ $ref: '#/components/schemas/TagEnrichedResponse'
3684
3703
  type: array
3685
3704
  - type: 'null'
3686
3705
  description: Tags assigned to this domain. Only included when ?include=tags
@@ -3953,31 +3972,6 @@ components:
3953
3972
  - domains
3954
3973
  title: DomainSummaryResponse
3955
3974
  type: object
3956
- DomainTagEnrichedResponse:
3957
- properties:
3958
- color:
3959
- $ref: '#/components/schemas/TagColor'
3960
- description: The color of the tag
3961
- label:
3962
- description: The label of the tag
3963
- minLength: 1
3964
- title: Label
3965
- type: string
3966
- tag_id:
3967
- description: The unique identifier of the tag
3968
- examples:
3969
- - tag_01h45ytscbebyvny4gc8cr8ma2
3970
- format: typeid
3971
- pattern: ^tag_[0-7][0-9a-hjkmnpq-tv-z]{25}$
3972
- title: Tag Id
3973
- type: string
3974
- x-typeid-prefix: tag
3975
- required:
3976
- - tag_id
3977
- - label
3978
- - color
3979
- title: DomainTagEnrichedResponse
3980
- type: object
3981
3975
  DomainTransferBulkCommand:
3982
3976
  properties:
3983
3977
  command:
@@ -8869,6 +8863,31 @@ components:
8869
8863
  - type
8870
8864
  title: TagCreate
8871
8865
  type: object
8866
+ TagEnrichedResponse:
8867
+ properties:
8868
+ color:
8869
+ $ref: '#/components/schemas/TagColor'
8870
+ description: The color of the tag
8871
+ label:
8872
+ description: The label of the tag
8873
+ minLength: 1
8874
+ title: Label
8875
+ type: string
8876
+ tag_id:
8877
+ description: The unique identifier of the tag
8878
+ examples:
8879
+ - tag_01h45ytscbebyvny4gc8cr8ma2
8880
+ format: typeid
8881
+ pattern: ^tag_[0-7][0-9a-hjkmnpq-tv-z]{25}$
8882
+ title: Tag Id
8883
+ type: string
8884
+ x-typeid-prefix: tag
8885
+ required:
8886
+ - tag_id
8887
+ - label
8888
+ - color
8889
+ title: TagEnrichedResponse
8890
+ type: object
8872
8891
  TagFilterMode:
8873
8892
  enum:
8874
8893
  - match_any
@@ -9970,6 +9989,11 @@ components:
9970
9989
  title: Whois Server
9971
9990
  title: WhoisBase
9972
9991
  type: object
9992
+ ZoneIncludeField:
9993
+ enum:
9994
+ - tags
9995
+ title: ZoneIncludeField
9996
+ type: string
9973
9997
  ZoneSortField:
9974
9998
  enum:
9975
9999
  - name
@@ -10156,7 +10180,7 @@ info:
10156
10180
  \n\n"
10157
10181
  summary: OpusDNS - your gateway to a seamless domain management experience.
10158
10182
  title: OpusDNS API
10159
- version: 2026-04-23-230452
10183
+ version: 2026-04-24-085952
10160
10184
  x-logo:
10161
10185
  altText: OpusDNS API Reference
10162
10186
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -12012,6 +12036,29 @@ paths:
12012
12036
  schema:
12013
12037
  $ref: '#/components/schemas/SortOrder'
12014
12038
  default: desc
12039
+ - description: Filter by tag IDs. Can be specified multiple times.
12040
+ in: query
12041
+ name: tag_ids
12042
+ required: false
12043
+ schema:
12044
+ anyOf:
12045
+ - items:
12046
+ examples:
12047
+ - tag_01h45ytscbebyvny4gc8cr8ma2
12048
+ format: typeid
12049
+ pattern: ^tag_[0-7][0-9a-hjkmnpq-tv-z]{25}$
12050
+ type: string
12051
+ x-typeid-prefix: tag
12052
+ type: array
12053
+ - type: 'null'
12054
+ description: Filter by tag IDs. Can be specified multiple times.
12055
+ title: Tag Ids
12056
+ - in: query
12057
+ name: tag_mode
12058
+ required: false
12059
+ schema:
12060
+ $ref: '#/components/schemas/TagFilterMode'
12061
+ default: match_any
12015
12062
  - in: query
12016
12063
  name: dnssec_status
12017
12064
  required: false
@@ -12080,6 +12127,20 @@ paths:
12080
12127
  type: string
12081
12128
  - type: 'null'
12082
12129
  title: Updated Before
12130
+ - description: Include additional data in the response. Can be specified multiple
12131
+ times.
12132
+ in: query
12133
+ name: include
12134
+ required: false
12135
+ schema:
12136
+ anyOf:
12137
+ - items:
12138
+ $ref: '#/components/schemas/ZoneIncludeField'
12139
+ type: array
12140
+ - type: 'null'
12141
+ description: Include additional data in the response. Can be specified multiple
12142
+ times.
12143
+ title: Include
12083
12144
  - in: query
12084
12145
  name: page
12085
12146
  required: false
@@ -12115,6 +12176,7 @@ paths:
12115
12176
  total_pages: 1
12116
12177
  results:
12117
12178
  - created_on: '2025-11-18T12:43:35Z'
12179
+ dns_zone_id: zone_01kpwv13k2f329vastjvrckwjs
12118
12180
  dnssec_status: disabled
12119
12181
  domain_parts:
12120
12182
  domain: example
@@ -12682,6 +12744,16 @@ paths:
12682
12744
  description: DNS zone name (trailing dot optional)
12683
12745
  title: Zone Name
12684
12746
  type: string
12747
+ requestBody:
12748
+ content:
12749
+ application/json:
12750
+ schema:
12751
+ anyOf:
12752
+ - items:
12753
+ $ref: '#/components/schemas/ZoneIncludeField'
12754
+ type: array
12755
+ - type: 'null'
12756
+ title: Include
12685
12757
  responses:
12686
12758
  '200':
12687
12759
  content:
package/src/schema.d.ts CHANGED
@@ -3770,6 +3770,13 @@ export interface components {
3770
3770
  * @description The date/time the entry was created on
3771
3771
  */
3772
3772
  created_on?: Date;
3773
+ /**
3774
+ * Dns Zone Id
3775
+ * Format: typeid
3776
+ * @description The unique identifier of the zone
3777
+ * @example zone_01h45ytscbebyvny4gc8cr8ma2
3778
+ */
3779
+ dns_zone_id: TypeId<"zone">;
3773
3780
  /** @default disabled */
3774
3781
  dnssec_status: components["schemas"]["DnssecStatus"];
3775
3782
  domain_parts?: components["schemas"]["DomainNameParts"];
@@ -3777,6 +3784,11 @@ export interface components {
3777
3784
  name: string;
3778
3785
  /** Rrsets */
3779
3786
  rrsets?: components["schemas"]["DnsRrsetResponse"][];
3787
+ /**
3788
+ * Tags
3789
+ * @description Tags assigned to this zone. Only included when ?include=tags is specified.
3790
+ */
3791
+ tags?: components["schemas"]["TagEnrichedResponse"][] | null;
3780
3792
  /**
3781
3793
  * Updated On
3782
3794
  * Format: date-time
@@ -4704,7 +4716,7 @@ export interface components {
4704
4716
  * Tags
4705
4717
  * @description Tags assigned to this domain. Only included when ?include=tags is specified.
4706
4718
  */
4707
- tags?: components["schemas"]["DomainTagEnrichedResponse"][] | null;
4719
+ tags?: components["schemas"]["TagEnrichedResponse"][] | null;
4708
4720
  /**
4709
4721
  * Tld
4710
4722
  * @description The top level domain of the domain
@@ -4868,23 +4880,6 @@ export interface components {
4868
4880
  */
4869
4881
  organization_id: TypeId<"organization">;
4870
4882
  };
4871
- /** DomainTagEnrichedResponse */
4872
- DomainTagEnrichedResponse: {
4873
- /** @description The color of the tag */
4874
- color: components["schemas"]["TagColor"];
4875
- /**
4876
- * Label
4877
- * @description The label of the tag
4878
- */
4879
- label: string;
4880
- /**
4881
- * Tag Id
4882
- * Format: typeid
4883
- * @description The unique identifier of the tag
4884
- * @example tag_01h45ytscbebyvny4gc8cr8ma2
4885
- */
4886
- tag_id: TypeId<"tag">;
4887
- };
4888
4883
  /** DomainTransferBulkCommand */
4889
4884
  DomainTransferBulkCommand: {
4890
4885
  /**
@@ -8142,6 +8137,23 @@ export interface components {
8142
8137
  /** @description Which category a tag applies to, cannot be changed once created */
8143
8138
  type: components["schemas"]["TagType"];
8144
8139
  };
8140
+ /** TagEnrichedResponse */
8141
+ TagEnrichedResponse: {
8142
+ /** @description The color of the tag */
8143
+ color: components["schemas"]["TagColor"];
8144
+ /**
8145
+ * Label
8146
+ * @description The label of the tag
8147
+ */
8148
+ label: string;
8149
+ /**
8150
+ * Tag Id
8151
+ * Format: typeid
8152
+ * @description The unique identifier of the tag
8153
+ * @example tag_01h45ytscbebyvny4gc8cr8ma2
8154
+ */
8155
+ tag_id: TypeId<"tag">;
8156
+ };
8145
8157
  /**
8146
8158
  * TagFilterMode
8147
8159
  * @enum {string}
@@ -8932,6 +8944,11 @@ export interface components {
8932
8944
  */
8933
8945
  whois_server?: string | null;
8934
8946
  };
8947
+ /**
8948
+ * ZoneIncludeField
8949
+ * @enum {string}
8950
+ */
8951
+ ZoneIncludeField: "tags";
8935
8952
  /**
8936
8953
  * ZoneSortField
8937
8954
  * @enum {string}
@@ -10387,6 +10404,9 @@ export interface operations {
10387
10404
  query?: {
10388
10405
  sort_by?: components["schemas"]["ZoneSortField"];
10389
10406
  sort_order?: components["schemas"]["SortOrder"];
10407
+ /** @description Filter by tag IDs. Can be specified multiple times. */
10408
+ tag_ids?: TypeId<"tag">[] | null;
10409
+ tag_mode?: components["schemas"]["TagFilterMode"];
10390
10410
  dnssec_status?: components["schemas"]["DnssecStatus"] | null;
10391
10411
  name?: string | null;
10392
10412
  search?: string | null;
@@ -10395,6 +10415,8 @@ export interface operations {
10395
10415
  created_before?: Date | null;
10396
10416
  updated_after?: Date | null;
10397
10417
  updated_before?: Date | null;
10418
+ /** @description Include additional data in the response. Can be specified multiple times. */
10419
+ include?: components["schemas"]["ZoneIncludeField"][] | null;
10398
10420
  page?: number;
10399
10421
  page_size?: number;
10400
10422
  };
@@ -10646,7 +10668,11 @@ export interface operations {
10646
10668
  };
10647
10669
  cookie?: never;
10648
10670
  };
10649
- requestBody?: never;
10671
+ requestBody?: {
10672
+ content: {
10673
+ "application/json": components["schemas"]["ZoneIncludeField"][] | null;
10674
+ };
10675
+ };
10650
10676
  responses: {
10651
10677
  /** @description Successful Response */
10652
10678
  200: {