@opusdns/api 0.292.0 → 0.294.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 +1 -1
- package/src/helpers/constants.ts +49 -1
- package/src/helpers/keys.ts +209 -1
- package/src/helpers/requests.d.ts +8 -6
- package/src/helpers/responses.d.ts +12 -9
- package/src/helpers/schemas-arrays.d.ts +29 -1
- package/src/helpers/schemas.d.ts +32 -0
- package/src/openapi.yaml +84 -8
- package/src/schema.d.ts +38 -4
package/package.json
CHANGED
package/src/helpers/constants.ts
CHANGED
|
@@ -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
|
*
|
package/src/helpers/keys.ts
CHANGED
|
@@ -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';
|
|
@@ -13012,6 +13013,31 @@ export const KEY_DOMAIN_CREATE_BULK_INSTANCE_CONTACTS: keyof DomainCreateBulkIns
|
|
|
13012
13013
|
* @see {@link KEYS_DOMAIN_CREATE_BULK_INSTANCE} - Array of all keys for this type
|
|
13013
13014
|
*/
|
|
13014
13015
|
export const KEY_DOMAIN_CREATE_BULK_INSTANCE_CREATE_ZONE: keyof DomainCreateBulkInstance = 'create_zone';
|
|
13016
|
+
/**
|
|
13017
|
+
* expected_price property
|
|
13018
|
+
*
|
|
13019
|
+
* Expected price for premium domain confirmation. Required only for premium domains; must be set per-instance because each premium domain has its own price.
|
|
13020
|
+
*
|
|
13021
|
+
*
|
|
13022
|
+
*
|
|
13023
|
+
* @remarks
|
|
13024
|
+
* This key constant provides type-safe access to the `expected_price` property of DomainCreateBulkInstance objects.
|
|
13025
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
13026
|
+
*
|
|
13027
|
+
* @example
|
|
13028
|
+
* ```typescript
|
|
13029
|
+
* // Direct property access
|
|
13030
|
+
* const value = domaincreatebulkinstance[KEY_DOMAIN_CREATE_BULK_INSTANCE_EXPECTED_PRICE];
|
|
13031
|
+
*
|
|
13032
|
+
* // Dynamic property access
|
|
13033
|
+
* const propertyName = KEY_DOMAIN_CREATE_BULK_INSTANCE_EXPECTED_PRICE;
|
|
13034
|
+
* const value = domaincreatebulkinstance[propertyName];
|
|
13035
|
+
* ```
|
|
13036
|
+
*
|
|
13037
|
+
* @see {@link DomainCreateBulkInstance} - The TypeScript type definition
|
|
13038
|
+
* @see {@link KEYS_DOMAIN_CREATE_BULK_INSTANCE} - Array of all keys for this type
|
|
13039
|
+
*/
|
|
13040
|
+
export const KEY_DOMAIN_CREATE_BULK_INSTANCE_EXPECTED_PRICE: keyof DomainCreateBulkInstance = 'expected_price';
|
|
13015
13041
|
/**
|
|
13016
13042
|
* Name
|
|
13017
13043
|
*
|
|
@@ -13138,6 +13164,7 @@ export const KEYS_DOMAIN_CREATE_BULK_INSTANCE = [
|
|
|
13138
13164
|
KEY_DOMAIN_CREATE_BULK_INSTANCE_AUTH_CODE,
|
|
13139
13165
|
KEY_DOMAIN_CREATE_BULK_INSTANCE_CONTACTS,
|
|
13140
13166
|
KEY_DOMAIN_CREATE_BULK_INSTANCE_CREATE_ZONE,
|
|
13167
|
+
KEY_DOMAIN_CREATE_BULK_INSTANCE_EXPECTED_PRICE,
|
|
13141
13168
|
KEY_DOMAIN_CREATE_BULK_INSTANCE_NAME,
|
|
13142
13169
|
KEY_DOMAIN_CREATE_BULK_INSTANCE_NAMESERVERS,
|
|
13143
13170
|
KEY_DOMAIN_CREATE_BULK_INSTANCE_PERIOD,
|
|
@@ -17513,10 +17540,35 @@ export const KEY_DOMAIN_ROID: keyof Domain = 'roid';
|
|
|
17513
17540
|
* @see {@link KEYS_DOMAIN} - Array of all keys for this type
|
|
17514
17541
|
*/
|
|
17515
17542
|
export const KEY_DOMAIN_SLD: keyof Domain = 'sld';
|
|
17543
|
+
/**
|
|
17544
|
+
* Status Tags
|
|
17545
|
+
*
|
|
17546
|
+
* Status tags assigned to this domain. Only included when ?include=tags is specified.
|
|
17547
|
+
*
|
|
17548
|
+
*
|
|
17549
|
+
*
|
|
17550
|
+
* @remarks
|
|
17551
|
+
* This key constant provides type-safe access to the `status_tags` property of Domain objects.
|
|
17552
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
17553
|
+
*
|
|
17554
|
+
* @example
|
|
17555
|
+
* ```typescript
|
|
17556
|
+
* // Direct property access
|
|
17557
|
+
* const value = domain[KEY_DOMAIN_STATUS_TAGS];
|
|
17558
|
+
*
|
|
17559
|
+
* // Dynamic property access
|
|
17560
|
+
* const propertyName = KEY_DOMAIN_STATUS_TAGS;
|
|
17561
|
+
* const value = domain[propertyName];
|
|
17562
|
+
* ```
|
|
17563
|
+
*
|
|
17564
|
+
* @see {@link Domain} - The TypeScript type definition
|
|
17565
|
+
* @see {@link KEYS_DOMAIN} - Array of all keys for this type
|
|
17566
|
+
*/
|
|
17567
|
+
export const KEY_DOMAIN_STATUS_TAGS: keyof Domain = 'status_tags';
|
|
17516
17568
|
/**
|
|
17517
17569
|
* Tags
|
|
17518
17570
|
*
|
|
17519
|
-
*
|
|
17571
|
+
* User tags assigned to this domain. Only included when ?include=tags is specified.
|
|
17520
17572
|
*
|
|
17521
17573
|
*
|
|
17522
17574
|
*
|
|
@@ -17657,6 +17709,7 @@ export const KEYS_DOMAIN = [
|
|
|
17657
17709
|
KEY_DOMAIN_RENEWAL_MODE,
|
|
17658
17710
|
KEY_DOMAIN_ROID,
|
|
17659
17711
|
KEY_DOMAIN_SLD,
|
|
17712
|
+
KEY_DOMAIN_STATUS_TAGS,
|
|
17660
17713
|
KEY_DOMAIN_TAGS,
|
|
17661
17714
|
KEY_DOMAIN_TLD,
|
|
17662
17715
|
KEY_DOMAIN_TRANSFER_LOCK,
|
|
@@ -18866,6 +18919,31 @@ export const KEY_DOMAIN_TRANSFER_BULK_INSTANCE_CONTACTS: keyof DomainTransferBul
|
|
|
18866
18919
|
* @see {@link KEYS_DOMAIN_TRANSFER_BULK_INSTANCE} - Array of all keys for this type
|
|
18867
18920
|
*/
|
|
18868
18921
|
export const KEY_DOMAIN_TRANSFER_BULK_INSTANCE_CREATE_ZONE: keyof DomainTransferBulkInstance = 'create_zone';
|
|
18922
|
+
/**
|
|
18923
|
+
* expected_price property
|
|
18924
|
+
*
|
|
18925
|
+
* Expected price for premium domain confirmation. Required only for premium domains; must be set per-instance because each premium domain has its own price.
|
|
18926
|
+
*
|
|
18927
|
+
*
|
|
18928
|
+
*
|
|
18929
|
+
* @remarks
|
|
18930
|
+
* This key constant provides type-safe access to the `expected_price` property of DomainTransferBulkInstance objects.
|
|
18931
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
18932
|
+
*
|
|
18933
|
+
* @example
|
|
18934
|
+
* ```typescript
|
|
18935
|
+
* // Direct property access
|
|
18936
|
+
* const value = domaintransferbulkinstance[KEY_DOMAIN_TRANSFER_BULK_INSTANCE_EXPECTED_PRICE];
|
|
18937
|
+
*
|
|
18938
|
+
* // Dynamic property access
|
|
18939
|
+
* const propertyName = KEY_DOMAIN_TRANSFER_BULK_INSTANCE_EXPECTED_PRICE;
|
|
18940
|
+
* const value = domaintransferbulkinstance[propertyName];
|
|
18941
|
+
* ```
|
|
18942
|
+
*
|
|
18943
|
+
* @see {@link DomainTransferBulkInstance} - The TypeScript type definition
|
|
18944
|
+
* @see {@link KEYS_DOMAIN_TRANSFER_BULK_INSTANCE} - Array of all keys for this type
|
|
18945
|
+
*/
|
|
18946
|
+
export const KEY_DOMAIN_TRANSFER_BULK_INSTANCE_EXPECTED_PRICE: keyof DomainTransferBulkInstance = 'expected_price';
|
|
18869
18947
|
/**
|
|
18870
18948
|
* Name
|
|
18871
18949
|
*
|
|
@@ -18993,6 +19071,7 @@ export const KEYS_DOMAIN_TRANSFER_BULK_INSTANCE = [
|
|
|
18993
19071
|
KEY_DOMAIN_TRANSFER_BULK_INSTANCE_AUTH_CODE,
|
|
18994
19072
|
KEY_DOMAIN_TRANSFER_BULK_INSTANCE_CONTACTS,
|
|
18995
19073
|
KEY_DOMAIN_TRANSFER_BULK_INSTANCE_CREATE_ZONE,
|
|
19074
|
+
KEY_DOMAIN_TRANSFER_BULK_INSTANCE_EXPECTED_PRICE,
|
|
18996
19075
|
KEY_DOMAIN_TRANSFER_BULK_INSTANCE_NAME,
|
|
18997
19076
|
KEY_DOMAIN_TRANSFER_BULK_INSTANCE_NAMESERVERS,
|
|
18998
19077
|
KEY_DOMAIN_TRANSFER_BULK_INSTANCE_PERIOD,
|
|
@@ -37669,6 +37748,135 @@ export const KEYS_STATUS_CODE_STATS_BUCKET = [
|
|
|
37669
37748
|
KEY_STATUS_CODE_STATS_BUCKET_TOTAL,
|
|
37670
37749
|
] as const satisfies (keyof StatusCodeStatsBucket)[];
|
|
37671
37750
|
|
|
37751
|
+
/**
|
|
37752
|
+
* color property
|
|
37753
|
+
*
|
|
37754
|
+
* The color of the tag
|
|
37755
|
+
*
|
|
37756
|
+
*
|
|
37757
|
+
*
|
|
37758
|
+
* @remarks
|
|
37759
|
+
* This key constant provides type-safe access to the `color` property of StatusTag objects.
|
|
37760
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
37761
|
+
*
|
|
37762
|
+
* @example
|
|
37763
|
+
* ```typescript
|
|
37764
|
+
* // Direct property access
|
|
37765
|
+
* const value = statustag[KEY_STATUS_TAG_COLOR];
|
|
37766
|
+
*
|
|
37767
|
+
* // Dynamic property access
|
|
37768
|
+
* const propertyName = KEY_STATUS_TAG_COLOR;
|
|
37769
|
+
* const value = statustag[propertyName];
|
|
37770
|
+
* ```
|
|
37771
|
+
*
|
|
37772
|
+
* @see {@link StatusTag} - The TypeScript type definition
|
|
37773
|
+
* @see {@link KEYS_STATUS_TAG} - Array of all keys for this type
|
|
37774
|
+
*/
|
|
37775
|
+
export const KEY_STATUS_TAG_COLOR: keyof StatusTag = 'color';
|
|
37776
|
+
/**
|
|
37777
|
+
* Description
|
|
37778
|
+
*
|
|
37779
|
+
* Additional information about this status tag
|
|
37780
|
+
*
|
|
37781
|
+
*
|
|
37782
|
+
*
|
|
37783
|
+
* @remarks
|
|
37784
|
+
* This key constant provides type-safe access to the `description` property of StatusTag objects.
|
|
37785
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
37786
|
+
*
|
|
37787
|
+
* @example
|
|
37788
|
+
* ```typescript
|
|
37789
|
+
* // Direct property access
|
|
37790
|
+
* const value = statustag[KEY_STATUS_TAG_DESCRIPTION];
|
|
37791
|
+
*
|
|
37792
|
+
* // Dynamic property access
|
|
37793
|
+
* const propertyName = KEY_STATUS_TAG_DESCRIPTION;
|
|
37794
|
+
* const value = statustag[propertyName];
|
|
37795
|
+
* ```
|
|
37796
|
+
*
|
|
37797
|
+
* @see {@link StatusTag} - The TypeScript type definition
|
|
37798
|
+
* @see {@link KEYS_STATUS_TAG} - Array of all keys for this type
|
|
37799
|
+
*/
|
|
37800
|
+
export const KEY_STATUS_TAG_DESCRIPTION: keyof StatusTag = 'description';
|
|
37801
|
+
/**
|
|
37802
|
+
* Label
|
|
37803
|
+
*
|
|
37804
|
+
* The label of the tag
|
|
37805
|
+
*
|
|
37806
|
+
* @type {string}
|
|
37807
|
+
*
|
|
37808
|
+
*
|
|
37809
|
+
* @remarks
|
|
37810
|
+
* This key constant provides type-safe access to the `label` property of StatusTag objects.
|
|
37811
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
37812
|
+
*
|
|
37813
|
+
* @example
|
|
37814
|
+
* ```typescript
|
|
37815
|
+
* // Direct property access
|
|
37816
|
+
* const value = statustag[KEY_STATUS_TAG_LABEL];
|
|
37817
|
+
*
|
|
37818
|
+
* // Dynamic property access
|
|
37819
|
+
* const propertyName = KEY_STATUS_TAG_LABEL;
|
|
37820
|
+
* const value = statustag[propertyName];
|
|
37821
|
+
* ```
|
|
37822
|
+
*
|
|
37823
|
+
* @see {@link StatusTag} - The TypeScript type definition
|
|
37824
|
+
* @see {@link KEYS_STATUS_TAG} - Array of all keys for this type
|
|
37825
|
+
*/
|
|
37826
|
+
export const KEY_STATUS_TAG_LABEL: keyof StatusTag = 'label';
|
|
37827
|
+
/**
|
|
37828
|
+
* tag_type property
|
|
37829
|
+
*
|
|
37830
|
+
* The status tag type identifier
|
|
37831
|
+
*
|
|
37832
|
+
*
|
|
37833
|
+
*
|
|
37834
|
+
* @remarks
|
|
37835
|
+
* This key constant provides type-safe access to the `tag_type` property of StatusTag objects.
|
|
37836
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
37837
|
+
*
|
|
37838
|
+
* @example
|
|
37839
|
+
* ```typescript
|
|
37840
|
+
* // Direct property access
|
|
37841
|
+
* const value = statustag[KEY_STATUS_TAG_TAG_TYPE];
|
|
37842
|
+
*
|
|
37843
|
+
* // Dynamic property access
|
|
37844
|
+
* const propertyName = KEY_STATUS_TAG_TAG_TYPE;
|
|
37845
|
+
* const value = statustag[propertyName];
|
|
37846
|
+
* ```
|
|
37847
|
+
*
|
|
37848
|
+
* @see {@link StatusTag} - The TypeScript type definition
|
|
37849
|
+
* @see {@link KEYS_STATUS_TAG} - Array of all keys for this type
|
|
37850
|
+
*/
|
|
37851
|
+
export const KEY_STATUS_TAG_TAG_TYPE: keyof StatusTag = 'tag_type';
|
|
37852
|
+
|
|
37853
|
+
/**
|
|
37854
|
+
* Array of all StatusTag property keys
|
|
37855
|
+
*
|
|
37856
|
+
* @remarks
|
|
37857
|
+
* This constant provides a readonly array containing all valid property keys for StatusTag objects.
|
|
37858
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
37859
|
+
*
|
|
37860
|
+
* @example
|
|
37861
|
+
* ```typescript
|
|
37862
|
+
* // Iterating through all keys
|
|
37863
|
+
* for (const key of KEYS_STATUS_TAG) {
|
|
37864
|
+
* console.log(`Property: ${key}, Value: ${statustag[key]}`);
|
|
37865
|
+
* }
|
|
37866
|
+
*
|
|
37867
|
+
* // Validation
|
|
37868
|
+
* const isValidKey = KEYS_STATUS_TAG.includes(someKey);
|
|
37869
|
+
* ```
|
|
37870
|
+
*
|
|
37871
|
+
* @see {@link StatusTag} - The TypeScript type definition
|
|
37872
|
+
*/
|
|
37873
|
+
export const KEYS_STATUS_TAG = [
|
|
37874
|
+
KEY_STATUS_TAG_COLOR,
|
|
37875
|
+
KEY_STATUS_TAG_DESCRIPTION,
|
|
37876
|
+
KEY_STATUS_TAG_LABEL,
|
|
37877
|
+
KEY_STATUS_TAG_TAG_TYPE,
|
|
37878
|
+
] as const satisfies (keyof StatusTag)[];
|
|
37879
|
+
|
|
37672
37880
|
/**
|
|
37673
37881
|
* color property
|
|
37674
37882
|
*
|
|
@@ -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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
*
|
package/src/helpers/schemas.d.ts
CHANGED
|
@@ -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
|
@@ -3090,6 +3090,13 @@ components:
|
|
|
3090
3090
|
- type: 'null'
|
|
3091
3091
|
description: Override create_zone for this domain
|
|
3092
3092
|
title: Create Zone
|
|
3093
|
+
expected_price:
|
|
3094
|
+
anyOf:
|
|
3095
|
+
- $ref: '#/components/schemas/StrictMoneyDecimal'
|
|
3096
|
+
- type: 'null'
|
|
3097
|
+
description: Expected price for premium domain confirmation. Required only
|
|
3098
|
+
for premium domains; must be set per-instance because each premium domain
|
|
3099
|
+
has its own price.
|
|
3093
3100
|
name:
|
|
3094
3101
|
description: The domain to be created
|
|
3095
3102
|
title: Name
|
|
@@ -4125,13 +4132,22 @@ components:
|
|
|
4125
4132
|
minLength: 1
|
|
4126
4133
|
title: Sld
|
|
4127
4134
|
type: string
|
|
4135
|
+
status_tags:
|
|
4136
|
+
anyOf:
|
|
4137
|
+
- items:
|
|
4138
|
+
$ref: '#/components/schemas/StatusTagResponse'
|
|
4139
|
+
type: array
|
|
4140
|
+
- type: 'null'
|
|
4141
|
+
description: Status tags assigned to this domain. Only included when ?include=tags
|
|
4142
|
+
is specified.
|
|
4143
|
+
title: Status Tags
|
|
4128
4144
|
tags:
|
|
4129
4145
|
anyOf:
|
|
4130
4146
|
- items:
|
|
4131
4147
|
$ref: '#/components/schemas/TagEnrichedResponse'
|
|
4132
4148
|
type: array
|
|
4133
4149
|
- type: 'null'
|
|
4134
|
-
description:
|
|
4150
|
+
description: User tags assigned to this domain. Only included when ?include=tags
|
|
4135
4151
|
is specified.
|
|
4136
4152
|
title: Tags
|
|
4137
4153
|
tld:
|
|
@@ -4459,6 +4475,13 @@ components:
|
|
|
4459
4475
|
- type: 'null'
|
|
4460
4476
|
description: Override create_zone for this domain
|
|
4461
4477
|
title: Create Zone
|
|
4478
|
+
expected_price:
|
|
4479
|
+
anyOf:
|
|
4480
|
+
- $ref: '#/components/schemas/StrictMoneyDecimal'
|
|
4481
|
+
- type: 'null'
|
|
4482
|
+
description: Expected price for premium domain confirmation. Required only
|
|
4483
|
+
for premium domains; must be set per-instance because each premium domain
|
|
4484
|
+
has its own price.
|
|
4462
4485
|
name:
|
|
4463
4486
|
description: The domain to transfer
|
|
4464
4487
|
title: Name
|
|
@@ -9504,6 +9527,36 @@ components:
|
|
|
9504
9527
|
- total
|
|
9505
9528
|
title: StatusCodeStatsBucket
|
|
9506
9529
|
type: object
|
|
9530
|
+
StatusTagResponse:
|
|
9531
|
+
properties:
|
|
9532
|
+
color:
|
|
9533
|
+
$ref: '#/components/schemas/TagColor'
|
|
9534
|
+
description: The color of the tag
|
|
9535
|
+
description:
|
|
9536
|
+
anyOf:
|
|
9537
|
+
- type: string
|
|
9538
|
+
- type: 'null'
|
|
9539
|
+
description: Additional information about this status tag
|
|
9540
|
+
title: Description
|
|
9541
|
+
label:
|
|
9542
|
+
description: The label of the tag
|
|
9543
|
+
minLength: 1
|
|
9544
|
+
title: Label
|
|
9545
|
+
type: string
|
|
9546
|
+
tag_type:
|
|
9547
|
+
$ref: '#/components/schemas/StatusTagType'
|
|
9548
|
+
description: The status tag type identifier
|
|
9549
|
+
required:
|
|
9550
|
+
- tag_type
|
|
9551
|
+
- label
|
|
9552
|
+
- color
|
|
9553
|
+
title: StatusTagResponse
|
|
9554
|
+
type: object
|
|
9555
|
+
StatusTagType:
|
|
9556
|
+
enum:
|
|
9557
|
+
- VERIFICATION_REQUIRED
|
|
9558
|
+
title: StatusTagType
|
|
9559
|
+
type: string
|
|
9507
9560
|
StrictMoneyDecimal:
|
|
9508
9561
|
examples:
|
|
9509
9562
|
- '12.50'
|
|
@@ -11167,7 +11220,7 @@ info:
|
|
|
11167
11220
|
\n\n"
|
|
11168
11221
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
11169
11222
|
title: OpusDNS API
|
|
11170
|
-
version: 2026-05-
|
|
11223
|
+
version: 2026-05-11-170616
|
|
11171
11224
|
x-logo:
|
|
11172
11225
|
altText: OpusDNS API Reference
|
|
11173
11226
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -13189,7 +13242,7 @@ paths:
|
|
|
13189
13242
|
schema:
|
|
13190
13243
|
$ref: '#/components/schemas/SortOrder'
|
|
13191
13244
|
default: desc
|
|
13192
|
-
- description: Filter by tag IDs. Can be specified multiple times.
|
|
13245
|
+
- description: Filter by user tag IDs. Can be specified multiple times.
|
|
13193
13246
|
in: query
|
|
13194
13247
|
name: tag_ids
|
|
13195
13248
|
required: false
|
|
@@ -13204,7 +13257,7 @@ paths:
|
|
|
13204
13257
|
x-typeid-prefix: tag
|
|
13205
13258
|
type: array
|
|
13206
13259
|
- type: 'null'
|
|
13207
|
-
description: Filter by tag IDs. Can be specified multiple times.
|
|
13260
|
+
description: Filter by user tag IDs. Can be specified multiple times.
|
|
13208
13261
|
title: Tag Ids
|
|
13209
13262
|
- in: query
|
|
13210
13263
|
name: tag_mode
|
|
@@ -14241,7 +14294,7 @@ paths:
|
|
|
14241
14294
|
schema:
|
|
14242
14295
|
$ref: '#/components/schemas/SortOrder'
|
|
14243
14296
|
default: desc
|
|
14244
|
-
- description: Filter by tag IDs. Can be specified multiple times.
|
|
14297
|
+
- description: Filter by user tag IDs. Can be specified multiple times.
|
|
14245
14298
|
in: query
|
|
14246
14299
|
name: tag_ids
|
|
14247
14300
|
required: false
|
|
@@ -14256,7 +14309,7 @@ paths:
|
|
|
14256
14309
|
x-typeid-prefix: tag
|
|
14257
14310
|
type: array
|
|
14258
14311
|
- type: 'null'
|
|
14259
|
-
description: Filter by tag IDs. Can be specified multiple times.
|
|
14312
|
+
description: Filter by user tag IDs. Can be specified multiple times.
|
|
14260
14313
|
title: Tag Ids
|
|
14261
14314
|
- in: query
|
|
14262
14315
|
name: tag_mode
|
|
@@ -18114,7 +18167,25 @@ paths:
|
|
|
18114
18167
|
schema:
|
|
18115
18168
|
$ref: '#/components/schemas/SortOrder'
|
|
18116
18169
|
default: desc
|
|
18117
|
-
- description: Filter by tag
|
|
18170
|
+
- description: Filter by status tag types. Can be specified multiple times.
|
|
18171
|
+
in: query
|
|
18172
|
+
name: status_tags
|
|
18173
|
+
required: false
|
|
18174
|
+
schema:
|
|
18175
|
+
anyOf:
|
|
18176
|
+
- items:
|
|
18177
|
+
$ref: '#/components/schemas/StatusTagType'
|
|
18178
|
+
type: array
|
|
18179
|
+
- type: 'null'
|
|
18180
|
+
description: Filter by status tag types. Can be specified multiple times.
|
|
18181
|
+
title: Status Tags
|
|
18182
|
+
- in: query
|
|
18183
|
+
name: status_tag_mode
|
|
18184
|
+
required: false
|
|
18185
|
+
schema:
|
|
18186
|
+
$ref: '#/components/schemas/TagFilterMode'
|
|
18187
|
+
default: match_any
|
|
18188
|
+
- description: Filter by user tag IDs. Can be specified multiple times.
|
|
18118
18189
|
in: query
|
|
18119
18190
|
name: tag_ids
|
|
18120
18191
|
required: false
|
|
@@ -18129,7 +18200,7 @@ paths:
|
|
|
18129
18200
|
x-typeid-prefix: tag
|
|
18130
18201
|
type: array
|
|
18131
18202
|
- type: 'null'
|
|
18132
|
-
description: Filter by tag IDs. Can be specified multiple times.
|
|
18203
|
+
description: Filter by user tag IDs. Can be specified multiple times.
|
|
18133
18204
|
title: Tag Ids
|
|
18134
18205
|
- in: query
|
|
18135
18206
|
name: tag_mode
|
|
@@ -21113,6 +21184,8 @@ paths:
|
|
|
21113
21184
|
period:
|
|
21114
21185
|
unit: y
|
|
21115
21186
|
value: 2
|
|
21187
|
+
- expected_price: '2500.00'
|
|
21188
|
+
name: premium-domain.com
|
|
21116
21189
|
template:
|
|
21117
21190
|
contacts:
|
|
21118
21191
|
admin: contact_01kc433yvre99af2wasxhtpswf
|
|
@@ -21147,6 +21220,9 @@ paths:
|
|
|
21147
21220
|
name: transfer2.com
|
|
21148
21221
|
- auth_code: AUTH789GHI
|
|
21149
21222
|
name: transfer3.com
|
|
21223
|
+
- auth_code: AUTHPREM1
|
|
21224
|
+
expected_price: '1750.00'
|
|
21225
|
+
name: premium-transfer.com
|
|
21150
21226
|
template:
|
|
21151
21227
|
contacts:
|
|
21152
21228
|
admin: contact_01kc433yvre99af2wasxhtpswf
|
package/src/schema.d.ts
CHANGED
|
@@ -4533,6 +4533,8 @@ export interface components {
|
|
|
4533
4533
|
* @description Override create_zone for this domain
|
|
4534
4534
|
*/
|
|
4535
4535
|
create_zone?: boolean | null;
|
|
4536
|
+
/** @description Expected price for premium domain confirmation. Required only for premium domains; must be set per-instance because each premium domain has its own price. */
|
|
4537
|
+
expected_price?: components["schemas"]["StrictMoneyDecimal"] | null;
|
|
4536
4538
|
/**
|
|
4537
4539
|
* Name
|
|
4538
4540
|
* @description The domain to be created
|
|
@@ -5203,9 +5205,14 @@ export interface components {
|
|
|
5203
5205
|
* @example example
|
|
5204
5206
|
*/
|
|
5205
5207
|
sld: string;
|
|
5208
|
+
/**
|
|
5209
|
+
* Status Tags
|
|
5210
|
+
* @description Status tags assigned to this domain. Only included when ?include=tags is specified.
|
|
5211
|
+
*/
|
|
5212
|
+
status_tags?: components["schemas"]["StatusTagResponse"][] | null;
|
|
5206
5213
|
/**
|
|
5207
5214
|
* Tags
|
|
5208
|
-
* @description
|
|
5215
|
+
* @description User tags assigned to this domain. Only included when ?include=tags is specified.
|
|
5209
5216
|
*/
|
|
5210
5217
|
tags?: components["schemas"]["TagEnrichedResponse"][] | null;
|
|
5211
5218
|
/**
|
|
@@ -5417,6 +5424,8 @@ export interface components {
|
|
|
5417
5424
|
* @description Override create_zone for this domain
|
|
5418
5425
|
*/
|
|
5419
5426
|
create_zone?: boolean | null;
|
|
5427
|
+
/** @description Expected price for premium domain confirmation. Required only for premium domains; must be set per-instance because each premium domain has its own price. */
|
|
5428
|
+
expected_price?: components["schemas"]["StrictMoneyDecimal"] | null;
|
|
5420
5429
|
/**
|
|
5421
5430
|
* Name
|
|
5422
5431
|
* @description The domain to transfer
|
|
@@ -8727,6 +8736,28 @@ export interface components {
|
|
|
8727
8736
|
/** Total */
|
|
8728
8737
|
total: number;
|
|
8729
8738
|
};
|
|
8739
|
+
/** StatusTagResponse */
|
|
8740
|
+
StatusTagResponse: {
|
|
8741
|
+
/** @description The color of the tag */
|
|
8742
|
+
color: components["schemas"]["TagColor"];
|
|
8743
|
+
/**
|
|
8744
|
+
* Description
|
|
8745
|
+
* @description Additional information about this status tag
|
|
8746
|
+
*/
|
|
8747
|
+
description?: string | null;
|
|
8748
|
+
/**
|
|
8749
|
+
* Label
|
|
8750
|
+
* @description The label of the tag
|
|
8751
|
+
*/
|
|
8752
|
+
label: string;
|
|
8753
|
+
/** @description The status tag type identifier */
|
|
8754
|
+
tag_type: components["schemas"]["StatusTagType"];
|
|
8755
|
+
};
|
|
8756
|
+
/**
|
|
8757
|
+
* StatusTagType
|
|
8758
|
+
* @enum {string}
|
|
8759
|
+
*/
|
|
8760
|
+
StatusTagType: "VERIFICATION_REQUIRED";
|
|
8730
8761
|
/** @example 12.50 */
|
|
8731
8762
|
StrictMoneyDecimal: string;
|
|
8732
8763
|
/**
|
|
@@ -11502,7 +11533,7 @@ export interface operations {
|
|
|
11502
11533
|
query?: {
|
|
11503
11534
|
sort_by?: components["schemas"]["ContactSortField"];
|
|
11504
11535
|
sort_order?: components["schemas"]["SortOrder"];
|
|
11505
|
-
/** @description Filter by tag IDs. Can be specified multiple times. */
|
|
11536
|
+
/** @description Filter by user tag IDs. Can be specified multiple times. */
|
|
11506
11537
|
tag_ids?: TypeId<"tag">[] | null;
|
|
11507
11538
|
tag_mode?: components["schemas"]["TagFilterMode"];
|
|
11508
11539
|
first_name?: string | null;
|
|
@@ -12464,7 +12495,7 @@ export interface operations {
|
|
|
12464
12495
|
query?: {
|
|
12465
12496
|
sort_by?: components["schemas"]["ZoneSortField"];
|
|
12466
12497
|
sort_order?: components["schemas"]["SortOrder"];
|
|
12467
|
-
/** @description Filter by tag IDs. Can be specified multiple times. */
|
|
12498
|
+
/** @description Filter by user tag IDs. Can be specified multiple times. */
|
|
12468
12499
|
tag_ids?: TypeId<"tag">[] | null;
|
|
12469
12500
|
tag_mode?: components["schemas"]["TagFilterMode"];
|
|
12470
12501
|
dnssec_status?: components["schemas"]["DnssecStatus"] | null;
|
|
@@ -14842,7 +14873,10 @@ export interface operations {
|
|
|
14842
14873
|
query?: {
|
|
14843
14874
|
sort_by?: components["schemas"]["DomainSortField"];
|
|
14844
14875
|
sort_order?: components["schemas"]["SortOrder"];
|
|
14845
|
-
/** @description Filter by tag
|
|
14876
|
+
/** @description Filter by status tag types. Can be specified multiple times. */
|
|
14877
|
+
status_tags?: components["schemas"]["StatusTagType"][] | null;
|
|
14878
|
+
status_tag_mode?: components["schemas"]["TagFilterMode"];
|
|
14879
|
+
/** @description Filter by user tag IDs. Can be specified multiple times. */
|
|
14846
14880
|
tag_ids?: TypeId<"tag">[] | null;
|
|
14847
14881
|
tag_mode?: components["schemas"]["TagFilterMode"];
|
|
14848
14882
|
name?: string | null;
|