@opusdns/api 0.291.0 → 0.293.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.291.0",
6
+ "version": "0.293.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, ContactIncludeField, ContactSortField, ContactType, 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, EventVersion, ExecutingEntity, HTTPMethod, HolderEntitlement, HostStatus, HttpProtocol, InvoiceResponsePaymentStatus, InvoiceResponseStatus, InvoiceResponseType, JobStatus, LaunchPhaseType, LegalRequirementOperationType, LegalRequirementType, LocalPresenceRequirementType, MemoryFactKind, MessageContextKind, MessageRole, 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, VerificationClaimType, VerificationDeadlineType, VerificationType, ZoneIncludeField, ZoneSortField } from './schemas';
24
+ import { AllocationMethodType, AttributeType, BatchSortField, BatchStatus, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ComplianceStatus, ConditionOperator, ContactAttributeSetSortField, ContactIncludeField, ContactSortField, ContactType, 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, EventVersion, ExecutingEntity, HTTPMethod, HolderEntitlement, HostStatus, HttpProtocol, InvoiceResponsePaymentStatus, InvoiceResponseStatus, InvoiceResponseType, JobStatus, LaunchPhaseType, LegalRequirementOperationType, LegalRequirementType, LocalPresenceRequirementType, MemoryFactKind, MessageContextKind, MessageRole, 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, StatusTagType, SyncOperationType, TLDType, TagColor, TagFilterMode, TagSortField, TagType, TimeRange, TransferAckType, UserSortField, UserStatus, VerificationClaimType, VerificationDeadlineType, VerificationType, ZoneIncludeField, ZoneSortField } from './schemas';
25
25
 
26
26
  /**
27
27
  * AllocationMethodType. Auto-generated enum for AllocationMethodType
@@ -4763,6 +4763,54 @@ export const SORT_ORDER_VALUES = [
4763
4763
  'desc'
4764
4764
  ] as const satisfies [string, ...string[]] | SortOrder[];
4765
4765
 
4766
+ /**
4767
+ * StatusTagType. Auto-generated enum for StatusTagType
4768
+ *
4769
+ * @remarks
4770
+ * This constant provides both object and array forms for the StatusTagType enum.
4771
+ * The object form allows key-value access, while the array form enables iteration and validation.
4772
+ *
4773
+ * @example
4774
+ * ```typescript
4775
+ * // Using the object form for key-value access
4776
+ * const status = STATUS_TAG_TYPE.SUCCESS;
4777
+ *
4778
+ * // Using the array form for iteration
4779
+ * const allStatuses = STATUS_TAG_TYPE_VALUES;
4780
+ * console.log(`Available statuses: ${allStatuses.join(', ')}`);
4781
+ * ```
4782
+ *
4783
+ * @see {@link StatusTagType} - The TypeScript type definition
4784
+ */
4785
+ export const STATUS_TAG_TYPE = {
4786
+ VERIFICATION_REQUIRED: "VERIFICATION_REQUIRED",
4787
+ } as const satisfies Record<string, StatusTagType>;
4788
+
4789
+ /**
4790
+ * Array of all StatusTagType enum values
4791
+ *
4792
+ * @remarks
4793
+ * This constant provides a array containing all valid StatusTagType enum values.
4794
+ * Useful for iteration, validation, and generating dynamic UI components.
4795
+ *
4796
+ * @example
4797
+ * ```typescript
4798
+ * // Iterating through all values
4799
+ * for (const value of STATUS_TAG_TYPE_VALUES) {
4800
+ * console.log(`Processing: ${value}`);
4801
+ * }
4802
+ *
4803
+ * // Validation
4804
+ * const isValid = STATUS_TAG_TYPE_VALUES.includes(someValue);
4805
+ * ```
4806
+ *
4807
+ * @see {@link StatusTagType} - The TypeScript type definition
4808
+ * @see {@link STATUS_TAG_TYPE} - The object form of this enum
4809
+ */
4810
+ export const STATUS_TAG_TYPE_VALUES = [
4811
+ 'VERIFICATION_REQUIRED'
4812
+ ] as const satisfies [string, ...string[]] | StatusTagType[];
4813
+
4766
4814
  /**
4767
4815
  * SyncOperationType. Auto-generated enum for SyncOperationType
4768
4816
  *
@@ -300,6 +300,7 @@ import { SldLength } from './schemas';
300
300
  import { SpiceDbRelationshipUpdate } from './schemas';
301
301
  import { StatusChanges } from './schemas';
302
302
  import { StatusCodeStatsBucket } from './schemas';
303
+ import { StatusTag } from './schemas';
303
304
  import { TagCreate } from './schemas';
304
305
  import { TagEnriched } from './schemas';
305
306
  import { Tag } from './schemas';
@@ -17513,10 +17514,35 @@ export const KEY_DOMAIN_ROID: keyof Domain = 'roid';
17513
17514
  * @see {@link KEYS_DOMAIN} - Array of all keys for this type
17514
17515
  */
17515
17516
  export const KEY_DOMAIN_SLD: keyof Domain = 'sld';
17517
+ /**
17518
+ * Status Tags
17519
+ *
17520
+ * Status tags assigned to this domain. Only included when ?include=tags is specified.
17521
+ *
17522
+ *
17523
+ *
17524
+ * @remarks
17525
+ * This key constant provides type-safe access to the `status_tags` property of Domain objects.
17526
+ * Use this constant when you need to access properties dynamically or ensure type safety.
17527
+ *
17528
+ * @example
17529
+ * ```typescript
17530
+ * // Direct property access
17531
+ * const value = domain[KEY_DOMAIN_STATUS_TAGS];
17532
+ *
17533
+ * // Dynamic property access
17534
+ * const propertyName = KEY_DOMAIN_STATUS_TAGS;
17535
+ * const value = domain[propertyName];
17536
+ * ```
17537
+ *
17538
+ * @see {@link Domain} - The TypeScript type definition
17539
+ * @see {@link KEYS_DOMAIN} - Array of all keys for this type
17540
+ */
17541
+ export const KEY_DOMAIN_STATUS_TAGS: keyof Domain = 'status_tags';
17516
17542
  /**
17517
17543
  * Tags
17518
17544
  *
17519
- * Tags assigned to this domain. Only included when ?include=tags is specified.
17545
+ * User tags assigned to this domain. Only included when ?include=tags is specified.
17520
17546
  *
17521
17547
  *
17522
17548
  *
@@ -17657,6 +17683,7 @@ export const KEYS_DOMAIN = [
17657
17683
  KEY_DOMAIN_RENEWAL_MODE,
17658
17684
  KEY_DOMAIN_ROID,
17659
17685
  KEY_DOMAIN_SLD,
17686
+ KEY_DOMAIN_STATUS_TAGS,
17660
17687
  KEY_DOMAIN_TAGS,
17661
17688
  KEY_DOMAIN_TLD,
17662
17689
  KEY_DOMAIN_TRANSFER_LOCK,
@@ -37669,6 +37696,135 @@ export const KEYS_STATUS_CODE_STATS_BUCKET = [
37669
37696
  KEY_STATUS_CODE_STATS_BUCKET_TOTAL,
37670
37697
  ] as const satisfies (keyof StatusCodeStatsBucket)[];
37671
37698
 
37699
+ /**
37700
+ * color property
37701
+ *
37702
+ * The color of the tag
37703
+ *
37704
+ *
37705
+ *
37706
+ * @remarks
37707
+ * This key constant provides type-safe access to the `color` property of StatusTag objects.
37708
+ * Use this constant when you need to access properties dynamically or ensure type safety.
37709
+ *
37710
+ * @example
37711
+ * ```typescript
37712
+ * // Direct property access
37713
+ * const value = statustag[KEY_STATUS_TAG_COLOR];
37714
+ *
37715
+ * // Dynamic property access
37716
+ * const propertyName = KEY_STATUS_TAG_COLOR;
37717
+ * const value = statustag[propertyName];
37718
+ * ```
37719
+ *
37720
+ * @see {@link StatusTag} - The TypeScript type definition
37721
+ * @see {@link KEYS_STATUS_TAG} - Array of all keys for this type
37722
+ */
37723
+ export const KEY_STATUS_TAG_COLOR: keyof StatusTag = 'color';
37724
+ /**
37725
+ * Description
37726
+ *
37727
+ * Additional information about this status tag
37728
+ *
37729
+ *
37730
+ *
37731
+ * @remarks
37732
+ * This key constant provides type-safe access to the `description` property of StatusTag objects.
37733
+ * Use this constant when you need to access properties dynamically or ensure type safety.
37734
+ *
37735
+ * @example
37736
+ * ```typescript
37737
+ * // Direct property access
37738
+ * const value = statustag[KEY_STATUS_TAG_DESCRIPTION];
37739
+ *
37740
+ * // Dynamic property access
37741
+ * const propertyName = KEY_STATUS_TAG_DESCRIPTION;
37742
+ * const value = statustag[propertyName];
37743
+ * ```
37744
+ *
37745
+ * @see {@link StatusTag} - The TypeScript type definition
37746
+ * @see {@link KEYS_STATUS_TAG} - Array of all keys for this type
37747
+ */
37748
+ export const KEY_STATUS_TAG_DESCRIPTION: keyof StatusTag = 'description';
37749
+ /**
37750
+ * Label
37751
+ *
37752
+ * The label of the tag
37753
+ *
37754
+ * @type {string}
37755
+ *
37756
+ *
37757
+ * @remarks
37758
+ * This key constant provides type-safe access to the `label` property of StatusTag objects.
37759
+ * Use this constant when you need to access properties dynamically or ensure type safety.
37760
+ *
37761
+ * @example
37762
+ * ```typescript
37763
+ * // Direct property access
37764
+ * const value = statustag[KEY_STATUS_TAG_LABEL];
37765
+ *
37766
+ * // Dynamic property access
37767
+ * const propertyName = KEY_STATUS_TAG_LABEL;
37768
+ * const value = statustag[propertyName];
37769
+ * ```
37770
+ *
37771
+ * @see {@link StatusTag} - The TypeScript type definition
37772
+ * @see {@link KEYS_STATUS_TAG} - Array of all keys for this type
37773
+ */
37774
+ export const KEY_STATUS_TAG_LABEL: keyof StatusTag = 'label';
37775
+ /**
37776
+ * tag_type property
37777
+ *
37778
+ * The status tag type identifier
37779
+ *
37780
+ *
37781
+ *
37782
+ * @remarks
37783
+ * This key constant provides type-safe access to the `tag_type` property of StatusTag objects.
37784
+ * Use this constant when you need to access properties dynamically or ensure type safety.
37785
+ *
37786
+ * @example
37787
+ * ```typescript
37788
+ * // Direct property access
37789
+ * const value = statustag[KEY_STATUS_TAG_TAG_TYPE];
37790
+ *
37791
+ * // Dynamic property access
37792
+ * const propertyName = KEY_STATUS_TAG_TAG_TYPE;
37793
+ * const value = statustag[propertyName];
37794
+ * ```
37795
+ *
37796
+ * @see {@link StatusTag} - The TypeScript type definition
37797
+ * @see {@link KEYS_STATUS_TAG} - Array of all keys for this type
37798
+ */
37799
+ export const KEY_STATUS_TAG_TAG_TYPE: keyof StatusTag = 'tag_type';
37800
+
37801
+ /**
37802
+ * Array of all StatusTag property keys
37803
+ *
37804
+ * @remarks
37805
+ * This constant provides a readonly array containing all valid property keys for StatusTag objects.
37806
+ * Useful for iteration, validation, and generating dynamic UI components.
37807
+ *
37808
+ * @example
37809
+ * ```typescript
37810
+ * // Iterating through all keys
37811
+ * for (const key of KEYS_STATUS_TAG) {
37812
+ * console.log(`Property: ${key}, Value: ${statustag[key]}`);
37813
+ * }
37814
+ *
37815
+ * // Validation
37816
+ * const isValidKey = KEYS_STATUS_TAG.includes(someKey);
37817
+ * ```
37818
+ *
37819
+ * @see {@link StatusTag} - The TypeScript type definition
37820
+ */
37821
+ export const KEYS_STATUS_TAG = [
37822
+ KEY_STATUS_TAG_COLOR,
37823
+ KEY_STATUS_TAG_DESCRIPTION,
37824
+ KEY_STATUS_TAG_LABEL,
37825
+ KEY_STATUS_TAG_TAG_TYPE,
37826
+ ] as const satisfies (keyof StatusTag)[];
37827
+
37672
37828
  /**
37673
37829
  * color property
37674
37830
  *
@@ -1113,7 +1113,7 @@ export type POST_AvailabilityStream_Request_Body = POST_AvailabilityStream_Reque
1113
1113
  * Use this type to ensure type safety when making API requests to this endpoint.
1114
1114
  *
1115
1115
  * @path /v1/contacts
1116
- * @param tag_ids (query) - Filter by tag IDs. Can be specified multiple times.
1116
+ * @param tag_ids (query) - Filter by user tag IDs. Can be specified multiple times.
1117
1117
  * @param include (query) - Include additional data in the response. Can be specified multiple times.
1118
1118
  *
1119
1119
  * @see {@link GET_Contacts_Request_Query} - Query parameters type
@@ -1136,7 +1136,7 @@ export type GET_Contacts_Request = {
1136
1136
  * Use this type to ensure type safety for query parameters.
1137
1137
  *
1138
1138
  * @path /v1/contacts
1139
- * @param tag_ids (query) - Filter by tag IDs. Can be specified multiple times.
1139
+ * @param tag_ids (query) - Filter by user tag IDs. Can be specified multiple times.
1140
1140
  * @param include (query) - Include additional data in the response. Can be specified multiple times.
1141
1141
  */
1142
1142
  export type GET_Contacts_Request_Query = GET_Contacts_Request['parameters']['query'];
@@ -1817,7 +1817,7 @@ export type GET_ContactsVerify_Request_Query = GET_ContactsVerify_Request['param
1817
1817
  * Use this type to ensure type safety when making API requests to this endpoint.
1818
1818
  *
1819
1819
  * @path /v1/dns
1820
- * @param tag_ids (query) - Filter by tag IDs. Can be specified multiple times.
1820
+ * @param tag_ids (query) - Filter by user tag IDs. Can be specified multiple times.
1821
1821
  * @param include (query) - Include additional data in the response. Can be specified multiple times.
1822
1822
  *
1823
1823
  * @see {@link GET_Dns_Request_Query} - Query parameters type
@@ -1840,7 +1840,7 @@ export type GET_Dns_Request = {
1840
1840
  * Use this type to ensure type safety for query parameters.
1841
1841
  *
1842
1842
  * @path /v1/dns
1843
- * @param tag_ids (query) - Filter by tag IDs. Can be specified multiple times.
1843
+ * @param tag_ids (query) - Filter by user tag IDs. Can be specified multiple times.
1844
1844
  * @param include (query) - Include additional data in the response. Can be specified multiple times.
1845
1845
  */
1846
1846
  export type GET_Dns_Request_Query = GET_Dns_Request['parameters']['query'];
@@ -3337,7 +3337,8 @@ export type GET_DomainSearchSuggest_Request_Query = GET_DomainSearchSuggest_Requ
3337
3337
  * Use this type to ensure type safety when making API requests to this endpoint.
3338
3338
  *
3339
3339
  * @path /v1/domains
3340
- * @param tag_ids (query) - Filter by tag IDs. Can be specified multiple times.
3340
+ * @param status_tags (query) - Filter by status tag types. Can be specified multiple times.
3341
+ * @param tag_ids (query) - Filter by user tag IDs. Can be specified multiple times.
3341
3342
  * @param registry_statuses (query) - Filter domains by registry status. Can be specified multiple times (union of all provided values).
3342
3343
  * @param include (query) - Include additional data in the response. Can be specified multiple times.
3343
3344
  *
@@ -3361,7 +3362,8 @@ export type GET_Domains_Request = {
3361
3362
  * Use this type to ensure type safety for query parameters.
3362
3363
  *
3363
3364
  * @path /v1/domains
3364
- * @param tag_ids (query) - Filter by tag IDs. Can be specified multiple times.
3365
+ * @param status_tags (query) - Filter by status tag types. Can be specified multiple times.
3366
+ * @param tag_ids (query) - Filter by user tag IDs. Can be specified multiple times.
3365
3367
  * @param registry_statuses (query) - Filter domains by registry status. Can be specified multiple times (union of all provided values).
3366
3368
  * @param include (query) - Include additional data in the response. Can be specified multiple times.
3367
3369
  */
@@ -2201,7 +2201,7 @@ export type POST_AvailabilityStream_Response_422 = HTTPValidationError
2201
2201
 
2202
2202
  *
2203
2203
  * @path /v1/contacts
2204
- * @param tag_ids (query) - Filter by tag IDs. Can be specified multiple times.
2204
+ * @param tag_ids (query) - Filter by user tag IDs. Can be specified multiple times.
2205
2205
  * @param include (query) - Include additional data in the response. Can be specified multiple times.
2206
2206
  *
2207
2207
  * @see {@link GET_Contacts_Response_200} - 200 response type
@@ -2222,7 +2222,7 @@ export type GET_Contacts_Response = GET_Contacts_Response_200 | GET_Contacts_Res
2222
2222
 
2223
2223
  *
2224
2224
  * @path /v1/contacts
2225
- * @param tag_ids (query) - Filter by tag IDs. Can be specified multiple times.
2225
+ * @param tag_ids (query) - Filter by user tag IDs. Can be specified multiple times.
2226
2226
  * @param include (query) - Include additional data in the response. Can be specified multiple times.
2227
2227
  *
2228
2228
  * @see {@link GET_Contacts_Response} - The main response type definition
@@ -2241,7 +2241,7 @@ export type GET_Contacts_Response_200 = Pagination_Contact
2241
2241
 
2242
2242
  *
2243
2243
  * @path /v1/contacts
2244
- * @param tag_ids (query) - Filter by tag IDs. Can be specified multiple times.
2244
+ * @param tag_ids (query) - Filter by user tag IDs. Can be specified multiple times.
2245
2245
  * @param include (query) - Include additional data in the response. Can be specified multiple times.
2246
2246
  *
2247
2247
  * @see {@link GET_Contacts_Response} - The main response type definition
@@ -3486,7 +3486,7 @@ export type GET_ContactsVerify_Response_422 = HTTPValidationError
3486
3486
 
3487
3487
  *
3488
3488
  * @path /v1/dns
3489
- * @param tag_ids (query) - Filter by tag IDs. Can be specified multiple times.
3489
+ * @param tag_ids (query) - Filter by user tag IDs. Can be specified multiple times.
3490
3490
  * @param include (query) - Include additional data in the response. Can be specified multiple times.
3491
3491
  *
3492
3492
  * @see {@link GET_Dns_Response_200} - 200 response type
@@ -3507,7 +3507,7 @@ export type GET_Dns_Response = GET_Dns_Response_200 | GET_Dns_Response_422;
3507
3507
 
3508
3508
  *
3509
3509
  * @path /v1/dns
3510
- * @param tag_ids (query) - Filter by tag IDs. Can be specified multiple times.
3510
+ * @param tag_ids (query) - Filter by user tag IDs. Can be specified multiple times.
3511
3511
  * @param include (query) - Include additional data in the response. Can be specified multiple times.
3512
3512
  *
3513
3513
  * @see {@link GET_Dns_Response} - The main response type definition
@@ -3526,7 +3526,7 @@ export type GET_Dns_Response_200 = Pagination_DnsZone
3526
3526
 
3527
3527
  *
3528
3528
  * @path /v1/dns
3529
- * @param tag_ids (query) - Filter by tag IDs. Can be specified multiple times.
3529
+ * @param tag_ids (query) - Filter by user tag IDs. Can be specified multiple times.
3530
3530
  * @param include (query) - Include additional data in the response. Can be specified multiple times.
3531
3531
  *
3532
3532
  * @see {@link GET_Dns_Response} - The main response type definition
@@ -6686,7 +6686,8 @@ export type GET_DomainSearchSuggest_Response_502 = Problem
6686
6686
 
6687
6687
  *
6688
6688
  * @path /v1/domains
6689
- * @param tag_ids (query) - Filter by tag IDs. Can be specified multiple times.
6689
+ * @param status_tags (query) - Filter by status tag types. Can be specified multiple times.
6690
+ * @param tag_ids (query) - Filter by user tag IDs. Can be specified multiple times.
6690
6691
  * @param registry_statuses (query) - Filter domains by registry status. Can be specified multiple times (union of all provided values).
6691
6692
  * @param include (query) - Include additional data in the response. Can be specified multiple times.
6692
6693
  *
@@ -6708,7 +6709,8 @@ export type GET_Domains_Response = GET_Domains_Response_200 | GET_Domains_Respon
6708
6709
 
6709
6710
  *
6710
6711
  * @path /v1/domains
6711
- * @param tag_ids (query) - Filter by tag IDs. Can be specified multiple times.
6712
+ * @param status_tags (query) - Filter by status tag types. Can be specified multiple times.
6713
+ * @param tag_ids (query) - Filter by user tag IDs. Can be specified multiple times.
6712
6714
  * @param registry_statuses (query) - Filter domains by registry status. Can be specified multiple times (union of all provided values).
6713
6715
  * @param include (query) - Include additional data in the response. Can be specified multiple times.
6714
6716
  *
@@ -6728,7 +6730,8 @@ export type GET_Domains_Response_200 = Pagination_Domain
6728
6730
 
6729
6731
  *
6730
6732
  * @path /v1/domains
6731
- * @param tag_ids (query) - Filter by tag IDs. Can be specified multiple times.
6733
+ * @param status_tags (query) - Filter by status tag types. Can be specified multiple times.
6734
+ * @param tag_ids (query) - Filter by user tag IDs. Can be specified multiple times.
6732
6735
  * @param registry_statuses (query) - Filter domains by registry status. Can be specified multiple times (union of all provided values).
6733
6736
  * @param include (query) - Include additional data in the response. Can be specified multiple times.
6734
6737
  *
@@ -21,7 +21,7 @@
21
21
  * This file is auto-generated from the OpenAPI specification.
22
22
  * Do not edit manually.
23
23
  */
24
- import { ContactIncludeField, ZoneIncludeField, DomainIncludeField, DomainDnssecData, DomainDnssecDataCreate, JobStatus, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, ReportType, ReportStatus, TagType, TldResponseShort, TmClaim, ClaimsNotice, AttributeCondition, DomainContactType, ContactCreateBulkInstance, ContactAttributeLinkDetail, TagEnriched, ContactAttributeDefinition, PostalAddressType, ContactConfigBase, Context, Conversation, DuplicateCommand, 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, VerificationRegistrantDetails, VerificationClaimType, VerificationDeadline, EmailForwardAliasCreate, EmailForwardLogEvent, EmailForwardAliasMetrics, EmailForwardAlias, EmailForward, PriceInfo, ValidationError, LaunchPhaseBase, LegalRequirementOperationType, LocalPresenceRequirementType, MemoryFact, Message, 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, TmClassDesc, TmContact, TmHolder, TmCourt, TmUdrp, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
24
+ import { ContactIncludeField, ZoneIncludeField, StatusTagType, DomainIncludeField, DomainDnssecData, DomainDnssecDataCreate, JobStatus, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, ReportType, ReportStatus, TagType, TldResponseShort, TmClaim, ClaimsNotice, AttributeCondition, DomainContactType, ContactCreateBulkInstance, ContactAttributeLinkDetail, TagEnriched, ContactAttributeDefinition, PostalAddressType, ContactConfigBase, Context, Conversation, DuplicateCommand, 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, StatusTag, DomainSearchSuggestionWithPrice, DomainStatus, DomainTransferBulkInstance, DomainClientStatus, DomainUpdateBulkInstance, VerificationRegistrantDetails, VerificationClaimType, VerificationDeadline, EmailForwardAliasCreate, EmailForwardLogEvent, EmailForwardAliasMetrics, EmailForwardAlias, EmailForward, PriceInfo, ValidationError, LaunchPhaseBase, LegalRequirementOperationType, LocalPresenceRequirementType, MemoryFact, Message, 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, TmClassDesc, TmContact, TmHolder, TmCourt, TmUdrp, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
25
25
 
26
26
  /**
27
27
  * ContactIncludeField
@@ -51,6 +51,20 @@ export type ContactIncludeFieldArray = ContactIncludeField[];
51
51
  * @see {@link ZoneIncludeField} - The individual ZoneIncludeField type definition
52
52
  */
53
53
  export type ZoneIncludeFieldArray = ZoneIncludeField[];
54
+ /**
55
+ * StatusTagType
56
+ *
57
+ * @remarks
58
+ * Array type for StatusTagType objects. Used when the API returns a collection of StatusTagType instances.
59
+ *
60
+ * @example
61
+ * ```typescript
62
+ * const items: StatusTagTypeArray = await api.getStatusTagTypes();
63
+ * ```
64
+ *
65
+ * @see {@link StatusTagType} - The individual StatusTagType type definition
66
+ */
67
+ export type StatusTagTypeArray = StatusTagType[];
54
68
  /**
55
69
  * DomainIncludeField
56
70
  *
@@ -835,6 +849,20 @@ export type DomainContactArray = DomainContact[];
835
849
  * @see {@link DomainHost} - The individual DomainHostResponse type definition
836
850
  */
837
851
  export type DomainHostArray = DomainHost[];
852
+ /**
853
+ * StatusTagResponse
854
+ *
855
+ * @remarks
856
+ * Array type for StatusTagResponse objects. Used when the API returns a collection of StatusTagResponse instances.
857
+ *
858
+ * @example
859
+ * ```typescript
860
+ * const items: StatusTagArray = await api.getStatusTags();
861
+ * ```
862
+ *
863
+ * @see {@link StatusTag} - The individual StatusTagResponse type definition
864
+ */
865
+ export type StatusTagArray = StatusTag[];
838
866
  /**
839
867
  * DomainSearchSuggestionWithPrice
840
868
  *
@@ -6116,6 +6116,38 @@ export type StatusChanges = components['schemas']['StatusChanges'];
6116
6116
  * @see {@link components} - The OpenAPI components schema definition
6117
6117
  */
6118
6118
  export type StatusCodeStatsBucket = components['schemas']['StatusCodeStatsBucket'];
6119
+ /**
6120
+ * StatusTagResponse
6121
+ *
6122
+ * @remarks
6123
+ * Type alias for the `StatusTagResponse` OpenAPI schema.
6124
+ * This type represents statustagresponse data structures used in API requests and responses.
6125
+ *
6126
+ * @example
6127
+ * ```typescript
6128
+ * const response = await api.getStatusTag();
6129
+ * const item: StatusTag = response.results;
6130
+ * ```
6131
+ *
6132
+ * @see {@link components} - The OpenAPI components schema definition
6133
+ */
6134
+ export type StatusTag = components['schemas']['StatusTagResponse'];
6135
+ /**
6136
+ * StatusTagType
6137
+ *
6138
+ * @remarks
6139
+ * Type alias for the `StatusTagType` OpenAPI schema.
6140
+ * This type represents statustagtype data structures used in API requests and responses.
6141
+ *
6142
+ * @example
6143
+ * ```typescript
6144
+ * const response = await api.getStatusTagType();
6145
+ * const item: StatusTagType = response.results;
6146
+ * ```
6147
+ *
6148
+ * @see {@link components} - The OpenAPI components schema definition
6149
+ */
6150
+ export type StatusTagType = components['schemas']['StatusTagType'];
6119
6151
  /**
6120
6152
  * StrictMoneyDecimal
6121
6153
  *
package/src/openapi.yaml CHANGED
@@ -4125,13 +4125,22 @@ components:
4125
4125
  minLength: 1
4126
4126
  title: Sld
4127
4127
  type: string
4128
+ status_tags:
4129
+ anyOf:
4130
+ - items:
4131
+ $ref: '#/components/schemas/StatusTagResponse'
4132
+ type: array
4133
+ - type: 'null'
4134
+ description: Status tags assigned to this domain. Only included when ?include=tags
4135
+ is specified.
4136
+ title: Status Tags
4128
4137
  tags:
4129
4138
  anyOf:
4130
4139
  - items:
4131
4140
  $ref: '#/components/schemas/TagEnrichedResponse'
4132
4141
  type: array
4133
4142
  - type: 'null'
4134
- description: Tags assigned to this domain. Only included when ?include=tags
4143
+ description: User tags assigned to this domain. Only included when ?include=tags
4135
4144
  is specified.
4136
4145
  title: Tags
4137
4146
  tld:
@@ -5651,12 +5660,12 @@ components:
5651
5660
  $ref: '#/components/schemas/EventData'
5652
5661
  event_id:
5653
5662
  examples:
5654
- - epp_event_01h45ytscbebyvny4gc8cr8ma2
5663
+ - event_01h45ytscbebyvny4gc8cr8ma2
5655
5664
  format: typeid
5656
- pattern: ^epp_event_[0-7][0-9a-hjkmnpq-tv-z]{25}$
5665
+ pattern: ^event_[0-7][0-9a-hjkmnpq-tv-z]{25}$
5657
5666
  title: Event Id
5658
5667
  type: string
5659
- x-typeid-prefix: epp_event
5668
+ x-typeid-prefix: event
5660
5669
  object_id:
5661
5670
  anyOf:
5662
5671
  - type: string
@@ -9504,6 +9513,36 @@ components:
9504
9513
  - total
9505
9514
  title: StatusCodeStatsBucket
9506
9515
  type: object
9516
+ StatusTagResponse:
9517
+ properties:
9518
+ color:
9519
+ $ref: '#/components/schemas/TagColor'
9520
+ description: The color of the tag
9521
+ description:
9522
+ anyOf:
9523
+ - type: string
9524
+ - type: 'null'
9525
+ description: Additional information about this status tag
9526
+ title: Description
9527
+ label:
9528
+ description: The label of the tag
9529
+ minLength: 1
9530
+ title: Label
9531
+ type: string
9532
+ tag_type:
9533
+ $ref: '#/components/schemas/StatusTagType'
9534
+ description: The status tag type identifier
9535
+ required:
9536
+ - tag_type
9537
+ - label
9538
+ - color
9539
+ title: StatusTagResponse
9540
+ type: object
9541
+ StatusTagType:
9542
+ enum:
9543
+ - VERIFICATION_REQUIRED
9544
+ title: StatusTagType
9545
+ type: string
9507
9546
  StrictMoneyDecimal:
9508
9547
  examples:
9509
9548
  - '12.50'
@@ -11167,7 +11206,7 @@ info:
11167
11206
  \n\n"
11168
11207
  summary: OpusDNS - your gateway to a seamless domain management experience.
11169
11208
  title: OpusDNS API
11170
- version: 2026-05-08-122221
11209
+ version: 2026-05-11-075637
11171
11210
  x-logo:
11172
11211
  altText: OpusDNS API Reference
11173
11212
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -13189,7 +13228,7 @@ paths:
13189
13228
  schema:
13190
13229
  $ref: '#/components/schemas/SortOrder'
13191
13230
  default: desc
13192
- - description: Filter by tag IDs. Can be specified multiple times.
13231
+ - description: Filter by user tag IDs. Can be specified multiple times.
13193
13232
  in: query
13194
13233
  name: tag_ids
13195
13234
  required: false
@@ -13204,7 +13243,7 @@ paths:
13204
13243
  x-typeid-prefix: tag
13205
13244
  type: array
13206
13245
  - type: 'null'
13207
- description: Filter by tag IDs. Can be specified multiple times.
13246
+ description: Filter by user tag IDs. Can be specified multiple times.
13208
13247
  title: Tag Ids
13209
13248
  - in: query
13210
13249
  name: tag_mode
@@ -14241,7 +14280,7 @@ paths:
14241
14280
  schema:
14242
14281
  $ref: '#/components/schemas/SortOrder'
14243
14282
  default: desc
14244
- - description: Filter by tag IDs. Can be specified multiple times.
14283
+ - description: Filter by user tag IDs. Can be specified multiple times.
14245
14284
  in: query
14246
14285
  name: tag_ids
14247
14286
  required: false
@@ -14256,7 +14295,7 @@ paths:
14256
14295
  x-typeid-prefix: tag
14257
14296
  type: array
14258
14297
  - type: 'null'
14259
- description: Filter by tag IDs. Can be specified multiple times.
14298
+ description: Filter by user tag IDs. Can be specified multiple times.
14260
14299
  title: Tag Ids
14261
14300
  - in: query
14262
14301
  name: tag_mode
@@ -18114,7 +18153,25 @@ paths:
18114
18153
  schema:
18115
18154
  $ref: '#/components/schemas/SortOrder'
18116
18155
  default: desc
18117
- - description: Filter by tag IDs. Can be specified multiple times.
18156
+ - description: Filter by status tag types. Can be specified multiple times.
18157
+ in: query
18158
+ name: status_tags
18159
+ required: false
18160
+ schema:
18161
+ anyOf:
18162
+ - items:
18163
+ $ref: '#/components/schemas/StatusTagType'
18164
+ type: array
18165
+ - type: 'null'
18166
+ description: Filter by status tag types. Can be specified multiple times.
18167
+ title: Status Tags
18168
+ - in: query
18169
+ name: status_tag_mode
18170
+ required: false
18171
+ schema:
18172
+ $ref: '#/components/schemas/TagFilterMode'
18173
+ default: match_any
18174
+ - description: Filter by user tag IDs. Can be specified multiple times.
18118
18175
  in: query
18119
18176
  name: tag_ids
18120
18177
  required: false
@@ -18129,7 +18186,7 @@ paths:
18129
18186
  x-typeid-prefix: tag
18130
18187
  type: array
18131
18188
  - type: 'null'
18132
- description: Filter by tag IDs. Can be specified multiple times.
18189
+ description: Filter by user tag IDs. Can be specified multiple times.
18133
18190
  title: Tag Ids
18134
18191
  - in: query
18135
18192
  name: tag_mode
@@ -20613,12 +20670,12 @@ paths:
20613
20670
  required: true
20614
20671
  schema:
20615
20672
  examples:
20616
- - epp_event_01h45ytscbebyvny4gc8cr8ma2
20673
+ - event_01h45ytscbebyvny4gc8cr8ma2
20617
20674
  format: typeid
20618
- pattern: ^epp_event_[0-7][0-9a-hjkmnpq-tv-z]{25}$
20675
+ pattern: ^event_[0-7][0-9a-hjkmnpq-tv-z]{25}$
20619
20676
  title: Event Id
20620
20677
  type: string
20621
- x-typeid-prefix: epp_event
20678
+ x-typeid-prefix: event
20622
20679
  responses:
20623
20680
  '200':
20624
20681
  content:
@@ -20672,12 +20729,12 @@ paths:
20672
20729
  required: true
20673
20730
  schema:
20674
20731
  examples:
20675
- - epp_event_01h45ytscbebyvny4gc8cr8ma2
20732
+ - event_01h45ytscbebyvny4gc8cr8ma2
20676
20733
  format: typeid
20677
- pattern: ^epp_event_[0-7][0-9a-hjkmnpq-tv-z]{25}$
20734
+ pattern: ^event_[0-7][0-9a-hjkmnpq-tv-z]{25}$
20678
20735
  title: Event Id
20679
20736
  type: string
20680
- x-typeid-prefix: epp_event
20737
+ x-typeid-prefix: event
20681
20738
  responses:
20682
20739
  '204':
20683
20740
  description: Successful Response
package/src/schema.d.ts CHANGED
@@ -5203,9 +5203,14 @@ export interface components {
5203
5203
  * @example example
5204
5204
  */
5205
5205
  sld: string;
5206
+ /**
5207
+ * Status Tags
5208
+ * @description Status tags assigned to this domain. Only included when ?include=tags is specified.
5209
+ */
5210
+ status_tags?: components["schemas"]["StatusTagResponse"][] | null;
5206
5211
  /**
5207
5212
  * Tags
5208
- * @description Tags assigned to this domain. Only included when ?include=tags is specified.
5213
+ * @description User tags assigned to this domain. Only included when ?include=tags is specified.
5209
5214
  */
5210
5215
  tags?: components["schemas"]["TagEnrichedResponse"][] | null;
5211
5216
  /**
@@ -6251,9 +6256,9 @@ export interface components {
6251
6256
  /**
6252
6257
  * Event Id
6253
6258
  * Format: typeid
6254
- * @example epp_event_01h45ytscbebyvny4gc8cr8ma2
6259
+ * @example event_01h45ytscbebyvny4gc8cr8ma2
6255
6260
  */
6256
- event_id?: TypeId<"epp_event">;
6261
+ event_id?: TypeId<"event">;
6257
6262
  /**
6258
6263
  * Object Id
6259
6264
  * @description The id of the object that the event is about
@@ -8727,6 +8732,28 @@ export interface components {
8727
8732
  /** Total */
8728
8733
  total: number;
8729
8734
  };
8735
+ /** StatusTagResponse */
8736
+ StatusTagResponse: {
8737
+ /** @description The color of the tag */
8738
+ color: components["schemas"]["TagColor"];
8739
+ /**
8740
+ * Description
8741
+ * @description Additional information about this status tag
8742
+ */
8743
+ description?: string | null;
8744
+ /**
8745
+ * Label
8746
+ * @description The label of the tag
8747
+ */
8748
+ label: string;
8749
+ /** @description The status tag type identifier */
8750
+ tag_type: components["schemas"]["StatusTagType"];
8751
+ };
8752
+ /**
8753
+ * StatusTagType
8754
+ * @enum {string}
8755
+ */
8756
+ StatusTagType: "VERIFICATION_REQUIRED";
8730
8757
  /** @example 12.50 */
8731
8758
  StrictMoneyDecimal: string;
8732
8759
  /**
@@ -11502,7 +11529,7 @@ export interface operations {
11502
11529
  query?: {
11503
11530
  sort_by?: components["schemas"]["ContactSortField"];
11504
11531
  sort_order?: components["schemas"]["SortOrder"];
11505
- /** @description Filter by tag IDs. Can be specified multiple times. */
11532
+ /** @description Filter by user tag IDs. Can be specified multiple times. */
11506
11533
  tag_ids?: TypeId<"tag">[] | null;
11507
11534
  tag_mode?: components["schemas"]["TagFilterMode"];
11508
11535
  first_name?: string | null;
@@ -12464,7 +12491,7 @@ export interface operations {
12464
12491
  query?: {
12465
12492
  sort_by?: components["schemas"]["ZoneSortField"];
12466
12493
  sort_order?: components["schemas"]["SortOrder"];
12467
- /** @description Filter by tag IDs. Can be specified multiple times. */
12494
+ /** @description Filter by user tag IDs. Can be specified multiple times. */
12468
12495
  tag_ids?: TypeId<"tag">[] | null;
12469
12496
  tag_mode?: components["schemas"]["TagFilterMode"];
12470
12497
  dnssec_status?: components["schemas"]["DnssecStatus"] | null;
@@ -14842,7 +14869,10 @@ export interface operations {
14842
14869
  query?: {
14843
14870
  sort_by?: components["schemas"]["DomainSortField"];
14844
14871
  sort_order?: components["schemas"]["SortOrder"];
14845
- /** @description Filter by tag IDs. Can be specified multiple times. */
14872
+ /** @description Filter by status tag types. Can be specified multiple times. */
14873
+ status_tags?: components["schemas"]["StatusTagType"][] | null;
14874
+ status_tag_mode?: components["schemas"]["TagFilterMode"];
14875
+ /** @description Filter by user tag IDs. Can be specified multiple times. */
14846
14876
  tag_ids?: TypeId<"tag">[] | null;
14847
14877
  tag_mode?: components["schemas"]["TagFilterMode"];
14848
14878
  name?: string | null;
@@ -16845,7 +16875,7 @@ export interface operations {
16845
16875
  query?: never;
16846
16876
  header?: never;
16847
16877
  path: {
16848
- event_id: TypeId<"epp_event">;
16878
+ event_id: TypeId<"event">;
16849
16879
  };
16850
16880
  cookie?: never;
16851
16881
  };
@@ -16909,7 +16939,7 @@ export interface operations {
16909
16939
  query?: never;
16910
16940
  header?: never;
16911
16941
  path: {
16912
- event_id: TypeId<"epp_event">;
16942
+ event_id: TypeId<"event">;
16913
16943
  };
16914
16944
  cookie?: never;
16915
16945
  };