@opusdns/api 0.275.0 → 0.277.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 +33 -7
- package/src/helpers/requests.d.ts +18 -0
- package/src/helpers/responses.d.ts +6 -0
- package/src/helpers/schemas-arrays.d.ts +29 -15
- package/src/helpers/schemas.d.ts +16 -0
- package/src/openapi.yaml +64 -4
- package/src/schema.d.ts +21 -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, 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';
|
|
24
|
+
import { AllocationMethodType, AttributeType, BatchSortField, BatchStatus, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ComplianceStatus, ConditionOperator, ContactAttributeSetSortField, ContactIncludeField, 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
|
|
@@ -627,6 +627,54 @@ export const CONTACT_ATTRIBUTE_SET_SORT_FIELD_VALUES = [
|
|
|
627
627
|
'updated_on'
|
|
628
628
|
] as const satisfies [string, ...string[]] | ContactAttributeSetSortField[];
|
|
629
629
|
|
|
630
|
+
/**
|
|
631
|
+
* ContactIncludeField. Auto-generated enum for ContactIncludeField
|
|
632
|
+
*
|
|
633
|
+
* @remarks
|
|
634
|
+
* This constant provides both object and array forms for the ContactIncludeField enum.
|
|
635
|
+
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
636
|
+
*
|
|
637
|
+
* @example
|
|
638
|
+
* ```typescript
|
|
639
|
+
* // Using the object form for key-value access
|
|
640
|
+
* const status = CONTACT_INCLUDE_FIELD.SUCCESS;
|
|
641
|
+
*
|
|
642
|
+
* // Using the array form for iteration
|
|
643
|
+
* const allStatuses = CONTACT_INCLUDE_FIELD_VALUES;
|
|
644
|
+
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
645
|
+
* ```
|
|
646
|
+
*
|
|
647
|
+
* @see {@link ContactIncludeField} - The TypeScript type definition
|
|
648
|
+
*/
|
|
649
|
+
export const CONTACT_INCLUDE_FIELD = {
|
|
650
|
+
TAGS: "tags",
|
|
651
|
+
} as const satisfies Record<string, ContactIncludeField>;
|
|
652
|
+
|
|
653
|
+
/**
|
|
654
|
+
* Array of all ContactIncludeField enum values
|
|
655
|
+
*
|
|
656
|
+
* @remarks
|
|
657
|
+
* This constant provides a array containing all valid ContactIncludeField enum values.
|
|
658
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
659
|
+
*
|
|
660
|
+
* @example
|
|
661
|
+
* ```typescript
|
|
662
|
+
* // Iterating through all values
|
|
663
|
+
* for (const value of CONTACT_INCLUDE_FIELD_VALUES) {
|
|
664
|
+
* console.log(`Processing: ${value}`);
|
|
665
|
+
* }
|
|
666
|
+
*
|
|
667
|
+
* // Validation
|
|
668
|
+
* const isValid = CONTACT_INCLUDE_FIELD_VALUES.includes(someValue);
|
|
669
|
+
* ```
|
|
670
|
+
*
|
|
671
|
+
* @see {@link ContactIncludeField} - The TypeScript type definition
|
|
672
|
+
* @see {@link CONTACT_INCLUDE_FIELD} - The object form of this enum
|
|
673
|
+
*/
|
|
674
|
+
export const CONTACT_INCLUDE_FIELD_VALUES = [
|
|
675
|
+
'tags'
|
|
676
|
+
] as const satisfies [string, ...string[]] | ContactIncludeField[];
|
|
677
|
+
|
|
630
678
|
/**
|
|
631
679
|
* ContactSortField. Auto-generated enum for ContactSortField
|
|
632
680
|
*
|
package/src/helpers/keys.ts
CHANGED
|
@@ -4740,6 +4740,31 @@ export const KEY_CONTACT_STATE: keyof Contact = 'state';
|
|
|
4740
4740
|
* @see {@link KEYS_CONTACT} - Array of all keys for this type
|
|
4741
4741
|
*/
|
|
4742
4742
|
export const KEY_CONTACT_STREET: keyof Contact = 'street';
|
|
4743
|
+
/**
|
|
4744
|
+
* Tags
|
|
4745
|
+
*
|
|
4746
|
+
* Tags assigned to this contact
|
|
4747
|
+
*
|
|
4748
|
+
*
|
|
4749
|
+
*
|
|
4750
|
+
* @remarks
|
|
4751
|
+
* This key constant provides type-safe access to the `tags` property of Contact objects.
|
|
4752
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
4753
|
+
*
|
|
4754
|
+
* @example
|
|
4755
|
+
* ```typescript
|
|
4756
|
+
* // Direct property access
|
|
4757
|
+
* const value = contact[KEY_CONTACT_TAGS];
|
|
4758
|
+
*
|
|
4759
|
+
* // Dynamic property access
|
|
4760
|
+
* const propertyName = KEY_CONTACT_TAGS;
|
|
4761
|
+
* const value = contact[propertyName];
|
|
4762
|
+
* ```
|
|
4763
|
+
*
|
|
4764
|
+
* @see {@link Contact} - The TypeScript type definition
|
|
4765
|
+
* @see {@link KEYS_CONTACT} - Array of all keys for this type
|
|
4766
|
+
*/
|
|
4767
|
+
export const KEY_CONTACT_TAGS: keyof Contact = 'tags';
|
|
4743
4768
|
/**
|
|
4744
4769
|
* Title
|
|
4745
4770
|
*
|
|
@@ -4803,6 +4828,7 @@ export const KEYS_CONTACT = [
|
|
|
4803
4828
|
KEY_CONTACT_POSTAL_CODE,
|
|
4804
4829
|
KEY_CONTACT_STATE,
|
|
4805
4830
|
KEY_CONTACT_STREET,
|
|
4831
|
+
KEY_CONTACT_TAGS,
|
|
4806
4832
|
KEY_CONTACT_TITLE,
|
|
4807
4833
|
] as const satisfies (keyof Contact)[];
|
|
4808
4834
|
|
|
@@ -39820,30 +39846,30 @@ export const KEYS_DOMAIN_AVAILABILITY_LIST = [
|
|
|
39820
39846
|
*/
|
|
39821
39847
|
export const KEY_DOMAIN_AVAILABILITY_CHECK_AVAILABLE: keyof DomainAvailabilityCheck = 'available';
|
|
39822
39848
|
/**
|
|
39823
|
-
*
|
|
39849
|
+
* Claims Key
|
|
39824
39850
|
*
|
|
39825
|
-
*
|
|
39851
|
+
* Claims key, if claims notice acceptance is required
|
|
39826
39852
|
*
|
|
39827
39853
|
*
|
|
39828
39854
|
*
|
|
39829
39855
|
* @remarks
|
|
39830
|
-
* This key constant provides type-safe access to the `
|
|
39856
|
+
* This key constant provides type-safe access to the `claims_key` property of DomainAvailabilityCheck objects.
|
|
39831
39857
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
39832
39858
|
*
|
|
39833
39859
|
* @example
|
|
39834
39860
|
* ```typescript
|
|
39835
39861
|
* // Direct property access
|
|
39836
|
-
* const value = domainavailabilitycheck[
|
|
39862
|
+
* const value = domainavailabilitycheck[KEY_DOMAIN_AVAILABILITY_CHECK_CLAIMS_KEY];
|
|
39837
39863
|
*
|
|
39838
39864
|
* // Dynamic property access
|
|
39839
|
-
* const propertyName =
|
|
39865
|
+
* const propertyName = KEY_DOMAIN_AVAILABILITY_CHECK_CLAIMS_KEY;
|
|
39840
39866
|
* const value = domainavailabilitycheck[propertyName];
|
|
39841
39867
|
* ```
|
|
39842
39868
|
*
|
|
39843
39869
|
* @see {@link DomainAvailabilityCheck} - The TypeScript type definition
|
|
39844
39870
|
* @see {@link KEYS_DOMAIN_AVAILABILITY_CHECK} - Array of all keys for this type
|
|
39845
39871
|
*/
|
|
39846
|
-
export const
|
|
39872
|
+
export const KEY_DOMAIN_AVAILABILITY_CHECK_CLAIMS_KEY: keyof DomainAvailabilityCheck = 'claims_key';
|
|
39847
39873
|
/**
|
|
39848
39874
|
* Domain
|
|
39849
39875
|
*
|
|
@@ -39968,7 +39994,7 @@ export const KEY_DOMAIN_AVAILABILITY_CHECK_REASON: keyof DomainAvailabilityCheck
|
|
|
39968
39994
|
*/
|
|
39969
39995
|
export const KEYS_DOMAIN_AVAILABILITY_CHECK = [
|
|
39970
39996
|
KEY_DOMAIN_AVAILABILITY_CHECK_AVAILABLE,
|
|
39971
|
-
|
|
39997
|
+
KEY_DOMAIN_AVAILABILITY_CHECK_CLAIMS_KEY,
|
|
39972
39998
|
KEY_DOMAIN_AVAILABILITY_CHECK_DOMAIN,
|
|
39973
39999
|
KEY_DOMAIN_AVAILABILITY_CHECK_IS_PREMIUM,
|
|
39974
40000
|
KEY_DOMAIN_AVAILABILITY_CHECK_PREMIUM_PRICING,
|
|
@@ -451,6 +451,8 @@ export type POST_AvailabilityStream_Request_Body = POST_AvailabilityStream_Reque
|
|
|
451
451
|
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
452
452
|
*
|
|
453
453
|
* @path /v1/contacts
|
|
454
|
+
* @param tag_ids (query) - Filter by tag IDs. Can be specified multiple times.
|
|
455
|
+
* @param include (query) - Include additional data in the response. Can be specified multiple times.
|
|
454
456
|
*
|
|
455
457
|
* @see {@link GET_Contacts_Request_Query} - Query parameters type
|
|
456
458
|
* @see {@link GET_Contacts_Request_Path} - Path parameters type
|
|
@@ -472,6 +474,8 @@ export type GET_Contacts_Request = {
|
|
|
472
474
|
* Use this type to ensure type safety for query parameters.
|
|
473
475
|
*
|
|
474
476
|
* @path /v1/contacts
|
|
477
|
+
* @param tag_ids (query) - Filter by tag IDs. Can be specified multiple times.
|
|
478
|
+
* @param include (query) - Include additional data in the response. Can be specified multiple times.
|
|
475
479
|
*/
|
|
476
480
|
export type GET_Contacts_Request_Query = GET_Contacts_Request['parameters']['query'];
|
|
477
481
|
|
|
@@ -774,9 +778,23 @@ export type DELETE_ContactsContactId_Request_Path = DELETE_ContactsContactId_Req
|
|
|
774
778
|
*/
|
|
775
779
|
export type GET_ContactsContactId_Request = {
|
|
776
780
|
parameters: {
|
|
781
|
+
query: operations['get_contact_v1_contacts__contact_id__get']['parameters']['query'];
|
|
777
782
|
path: operations['get_contact_v1_contacts__contact_id__get']['parameters']['path'];
|
|
778
783
|
};
|
|
779
784
|
}
|
|
785
|
+
/**
|
|
786
|
+
* Query parameters for GET /v1/contacts/{contact_id}
|
|
787
|
+
*
|
|
788
|
+
* @remarks
|
|
789
|
+
* This type defines the query parameters for the GET /v1/contacts/{contact_id} endpoint.
|
|
790
|
+
* It provides type safety for all query parameters as defined in the OpenAPI specification.
|
|
791
|
+
*
|
|
792
|
+
* @example
|
|
793
|
+
* Use this type to ensure type safety for query parameters.
|
|
794
|
+
*
|
|
795
|
+
* @path /v1/contacts/{contact_id}
|
|
796
|
+
*/
|
|
797
|
+
export type GET_ContactsContactId_Request_Query = GET_ContactsContactId_Request['parameters']['query'];
|
|
780
798
|
/**
|
|
781
799
|
* Path parameters for GET /v1/contacts/{contact_id}
|
|
782
800
|
*
|
|
@@ -574,6 +574,8 @@ export type POST_AvailabilityStream_Response_422 = HTTPValidationError
|
|
|
574
574
|
|
|
575
575
|
*
|
|
576
576
|
* @path /v1/contacts
|
|
577
|
+
* @param tag_ids (query) - Filter by tag IDs. Can be specified multiple times.
|
|
578
|
+
* @param include (query) - Include additional data in the response. Can be specified multiple times.
|
|
577
579
|
*
|
|
578
580
|
* @see {@link GET_Contacts_Response_200} - 200 response type
|
|
579
581
|
* @see {@link GET_Contacts_Response_422} - 422 response type
|
|
@@ -593,6 +595,8 @@ export type GET_Contacts_Response = GET_Contacts_Response_200 | GET_Contacts_Res
|
|
|
593
595
|
|
|
594
596
|
*
|
|
595
597
|
* @path /v1/contacts
|
|
598
|
+
* @param tag_ids (query) - Filter by tag IDs. Can be specified multiple times.
|
|
599
|
+
* @param include (query) - Include additional data in the response. Can be specified multiple times.
|
|
596
600
|
*
|
|
597
601
|
* @see {@link GET_Contacts_Response} - The main response type definition
|
|
598
602
|
* @see {@link Pagination_Contact} - The actual schema type definition
|
|
@@ -610,6 +614,8 @@ export type GET_Contacts_Response_200 = Pagination_Contact
|
|
|
610
614
|
|
|
611
615
|
*
|
|
612
616
|
* @path /v1/contacts
|
|
617
|
+
* @param tag_ids (query) - Filter by tag IDs. Can be specified multiple times.
|
|
618
|
+
* @param include (query) - Include additional data in the response. Can be specified multiple times.
|
|
613
619
|
*
|
|
614
620
|
* @see {@link GET_Contacts_Response} - The main response type definition
|
|
615
621
|
* @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 { 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,
|
|
24
|
+
import { ContactIncludeField, ZoneIncludeField, DomainIncludeField, DomainDnssecData, DomainDnssecDataCreate, JobStatus, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, ReportType, ReportStatus, TagType, TldResponseShort, AttributeCondition, DomainContactType, ContactCreateBulkInstance, ContactAttributeLinkDetail, TagEnriched, ContactAttributeDefinition, PostalAddressType, ContactConfigBase, CommandError, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsZoneCreateBulkInstance, DnsRecordPatchOp, DnsZonePatchRecordsBulkInstance, DnsRrsetPatchOp, DnsZonePatchRrsetsBulkInstance, DnsRrset, DnsZoneUpdateBulkInstance, DomainAvailabilityCheck, ContactHandle, Nameserver, DomainCreateBulkInstance, BrowserStatsBucket, GeoStatsBucket, TimeSeriesBucket, DomainForwardPatchOp, PlatformStatsBucket, HttpRedirectRequest, HttpRedirectList, ReferrerStatsBucket, StatusCodeStatsBucket, UserAgentStatsBucket, VisitsByKeyBucket, DomainForward, DeletePolicyType, SyncOperationType, DomainContact, DomainHost, DomainSearchSuggestionWithPrice, DomainStatus, DomainTransferBulkInstance, DomainClientStatus, DomainUpdateBulkInstance, EmailForwardAliasCreate, EmailForwardLogEvent, EmailForwardAliasMetrics, EmailForwardAlias, EmailForward, PriceInfo, ValidationError, LaunchPhaseBase, LegalRequirementOperationType, LocalPresenceRequirementType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactAttributeSet, Contact, DnsZone, DomainForwardZone, Domain, EmailForwardLog, EmailForwardZone, EventResponse, Invoice, JobBatchMetadata, Job, ObjectLog, Organization, Parking, RequestHistory, 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
|
+
* ContactIncludeField
|
|
28
|
+
*
|
|
29
|
+
* @remarks
|
|
30
|
+
* Array type for ContactIncludeField objects. Used when the API returns a collection of ContactIncludeField instances.
|
|
31
|
+
*
|
|
32
|
+
* @example
|
|
33
|
+
* ```typescript
|
|
34
|
+
* const items: ContactIncludeFieldArray = await api.getContactIncludeFields();
|
|
35
|
+
* ```
|
|
36
|
+
*
|
|
37
|
+
* @see {@link ContactIncludeField} - The individual ContactIncludeField type definition
|
|
38
|
+
*/
|
|
39
|
+
export type ContactIncludeFieldArray = ContactIncludeField[];
|
|
26
40
|
/**
|
|
27
41
|
* ZoneIncludeField
|
|
28
42
|
*
|
|
@@ -247,6 +261,20 @@ export type ContactCreateBulkInstanceArray = ContactCreateBulkInstance[];
|
|
|
247
261
|
* @see {@link ContactAttributeLinkDetail} - The individual ContactAttributeLinkDetail type definition
|
|
248
262
|
*/
|
|
249
263
|
export type ContactAttributeLinkDetailArray = ContactAttributeLinkDetail[];
|
|
264
|
+
/**
|
|
265
|
+
* TagEnrichedResponse
|
|
266
|
+
*
|
|
267
|
+
* @remarks
|
|
268
|
+
* Array type for TagEnrichedResponse objects. Used when the API returns a collection of TagEnrichedResponse instances.
|
|
269
|
+
*
|
|
270
|
+
* @example
|
|
271
|
+
* ```typescript
|
|
272
|
+
* const items: TagEnrichedArray = await api.getTagEnricheds();
|
|
273
|
+
* ```
|
|
274
|
+
*
|
|
275
|
+
* @see {@link TagEnriched} - The individual TagEnrichedResponse type definition
|
|
276
|
+
*/
|
|
277
|
+
export type TagEnrichedArray = TagEnriched[];
|
|
250
278
|
/**
|
|
251
279
|
* ContactAttributeDefinition. Definition of a possible attribute for a TLD.
|
|
252
280
|
*
|
|
@@ -443,20 +471,6 @@ export type DnsZonePatchRrsetsBulkInstanceArray = DnsZonePatchRrsetsBulkInstance
|
|
|
443
471
|
* @see {@link DnsRrset} - The individual DnsRrsetResponse type definition
|
|
444
472
|
*/
|
|
445
473
|
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[];
|
|
460
474
|
/**
|
|
461
475
|
* DnsZoneUpdateBulkInstance
|
|
462
476
|
*
|
package/src/helpers/schemas.d.ts
CHANGED
|
@@ -602,6 +602,22 @@ export type ContactHandle = components['schemas']['ContactHandle'];
|
|
|
602
602
|
* @see {@link components} - The OpenAPI components schema definition
|
|
603
603
|
*/
|
|
604
604
|
export type ContactIdList = components['schemas']['ContactIdList'];
|
|
605
|
+
/**
|
|
606
|
+
* ContactIncludeField
|
|
607
|
+
*
|
|
608
|
+
* @remarks
|
|
609
|
+
* Type alias for the `ContactIncludeField` OpenAPI schema.
|
|
610
|
+
* This type represents contactincludefield data structures used in API requests and responses.
|
|
611
|
+
*
|
|
612
|
+
* @example
|
|
613
|
+
* ```typescript
|
|
614
|
+
* const response = await api.getContactIncludeField();
|
|
615
|
+
* const item: ContactIncludeField = response.results;
|
|
616
|
+
* ```
|
|
617
|
+
*
|
|
618
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
619
|
+
*/
|
|
620
|
+
export type ContactIncludeField = components['schemas']['ContactIncludeField'];
|
|
605
621
|
/**
|
|
606
622
|
* ContactResponse
|
|
607
623
|
*
|
package/src/openapi.yaml
CHANGED
|
@@ -1072,6 +1072,11 @@ components:
|
|
|
1072
1072
|
propertyNames:
|
|
1073
1073
|
$ref: '#/components/schemas/DomainContactType'
|
|
1074
1074
|
type: object
|
|
1075
|
+
ContactIncludeField:
|
|
1076
|
+
enum:
|
|
1077
|
+
- tags
|
|
1078
|
+
title: ContactIncludeField
|
|
1079
|
+
type: string
|
|
1075
1080
|
ContactResponse:
|
|
1076
1081
|
properties:
|
|
1077
1082
|
attribute_sets:
|
|
@@ -1172,6 +1177,14 @@ components:
|
|
|
1172
1177
|
minLength: 1
|
|
1173
1178
|
title: Street
|
|
1174
1179
|
type: string
|
|
1180
|
+
tags:
|
|
1181
|
+
anyOf:
|
|
1182
|
+
- items:
|
|
1183
|
+
$ref: '#/components/schemas/TagEnrichedResponse'
|
|
1184
|
+
type: array
|
|
1185
|
+
- type: 'null'
|
|
1186
|
+
description: Tags assigned to this contact
|
|
1187
|
+
title: Tags
|
|
1175
1188
|
title:
|
|
1176
1189
|
anyOf:
|
|
1177
1190
|
- minLength: 1
|
|
@@ -10095,12 +10108,12 @@ components:
|
|
|
10095
10108
|
available:
|
|
10096
10109
|
title: Available
|
|
10097
10110
|
type: boolean
|
|
10098
|
-
|
|
10111
|
+
claims_key:
|
|
10099
10112
|
anyOf:
|
|
10100
10113
|
- type: string
|
|
10101
10114
|
- type: 'null'
|
|
10102
|
-
description:
|
|
10103
|
-
title:
|
|
10115
|
+
description: Claims key, if claims notice acceptance is required
|
|
10116
|
+
title: Claims Key
|
|
10104
10117
|
domain:
|
|
10105
10118
|
description: The domain name
|
|
10106
10119
|
examples:
|
|
@@ -10199,7 +10212,7 @@ info:
|
|
|
10199
10212
|
\n\n"
|
|
10200
10213
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
10201
10214
|
title: OpusDNS API
|
|
10202
|
-
version: 2026-04-
|
|
10215
|
+
version: 2026-04-29-122519
|
|
10203
10216
|
x-logo:
|
|
10204
10217
|
altText: OpusDNS API Reference
|
|
10205
10218
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -11050,6 +11063,29 @@ paths:
|
|
|
11050
11063
|
schema:
|
|
11051
11064
|
$ref: '#/components/schemas/SortOrder'
|
|
11052
11065
|
default: desc
|
|
11066
|
+
- description: Filter by tag IDs. Can be specified multiple times.
|
|
11067
|
+
in: query
|
|
11068
|
+
name: tag_ids
|
|
11069
|
+
required: false
|
|
11070
|
+
schema:
|
|
11071
|
+
anyOf:
|
|
11072
|
+
- items:
|
|
11073
|
+
examples:
|
|
11074
|
+
- tag_01h45ytscbebyvny4gc8cr8ma2
|
|
11075
|
+
format: typeid
|
|
11076
|
+
pattern: ^tag_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
11077
|
+
type: string
|
|
11078
|
+
x-typeid-prefix: tag
|
|
11079
|
+
type: array
|
|
11080
|
+
- type: 'null'
|
|
11081
|
+
description: Filter by tag IDs. Can be specified multiple times.
|
|
11082
|
+
title: Tag Ids
|
|
11083
|
+
- in: query
|
|
11084
|
+
name: tag_mode
|
|
11085
|
+
required: false
|
|
11086
|
+
schema:
|
|
11087
|
+
$ref: '#/components/schemas/TagFilterMode'
|
|
11088
|
+
default: match_any
|
|
11053
11089
|
- in: query
|
|
11054
11090
|
name: first_name
|
|
11055
11091
|
required: false
|
|
@@ -11108,6 +11144,20 @@ paths:
|
|
|
11108
11144
|
type: string
|
|
11109
11145
|
- type: 'null'
|
|
11110
11146
|
title: Created Before
|
|
11147
|
+
- description: Include additional data in the response. Can be specified multiple
|
|
11148
|
+
times.
|
|
11149
|
+
in: query
|
|
11150
|
+
name: include
|
|
11151
|
+
required: false
|
|
11152
|
+
schema:
|
|
11153
|
+
anyOf:
|
|
11154
|
+
- items:
|
|
11155
|
+
$ref: '#/components/schemas/ContactIncludeField'
|
|
11156
|
+
type: array
|
|
11157
|
+
- type: 'null'
|
|
11158
|
+
description: Include additional data in the response. Can be specified multiple
|
|
11159
|
+
times.
|
|
11160
|
+
title: Include
|
|
11111
11161
|
- in: query
|
|
11112
11162
|
name: page
|
|
11113
11163
|
required: false
|
|
@@ -11644,6 +11694,16 @@ paths:
|
|
|
11644
11694
|
title: Contact Id
|
|
11645
11695
|
type: string
|
|
11646
11696
|
x-typeid-prefix: contact
|
|
11697
|
+
- in: query
|
|
11698
|
+
name: include
|
|
11699
|
+
required: false
|
|
11700
|
+
schema:
|
|
11701
|
+
anyOf:
|
|
11702
|
+
- items:
|
|
11703
|
+
$ref: '#/components/schemas/ContactIncludeField'
|
|
11704
|
+
type: array
|
|
11705
|
+
- type: 'null'
|
|
11706
|
+
title: Include
|
|
11647
11707
|
responses:
|
|
11648
11708
|
'200':
|
|
11649
11709
|
content:
|
package/src/schema.d.ts
CHANGED
|
@@ -2971,6 +2971,11 @@ export interface components {
|
|
|
2971
2971
|
ContactIdList: {
|
|
2972
2972
|
[key: string]: TypeId<"contact">;
|
|
2973
2973
|
};
|
|
2974
|
+
/**
|
|
2975
|
+
* ContactIncludeField
|
|
2976
|
+
* @enum {string}
|
|
2977
|
+
*/
|
|
2978
|
+
ContactIncludeField: "tags";
|
|
2974
2979
|
/** ContactResponse */
|
|
2975
2980
|
ContactResponse: {
|
|
2976
2981
|
/**
|
|
@@ -3061,6 +3066,11 @@ export interface components {
|
|
|
3061
3066
|
* @description The address of the contact
|
|
3062
3067
|
*/
|
|
3063
3068
|
street: string;
|
|
3069
|
+
/**
|
|
3070
|
+
* Tags
|
|
3071
|
+
* @description Tags assigned to this contact
|
|
3072
|
+
*/
|
|
3073
|
+
tags?: components["schemas"]["TagEnrichedResponse"][] | null;
|
|
3064
3074
|
/**
|
|
3065
3075
|
* Title
|
|
3066
3076
|
* @description The title of the contact
|
|
@@ -9028,10 +9038,10 @@ export interface components {
|
|
|
9028
9038
|
/** Available */
|
|
9029
9039
|
available: boolean;
|
|
9030
9040
|
/**
|
|
9031
|
-
*
|
|
9032
|
-
* @description
|
|
9041
|
+
* Claims Key
|
|
9042
|
+
* @description Claims key, if claims notice acceptance is required
|
|
9033
9043
|
*/
|
|
9034
|
-
|
|
9044
|
+
claims_key?: string | null;
|
|
9035
9045
|
/**
|
|
9036
9046
|
* Domain
|
|
9037
9047
|
* @description The domain name
|
|
@@ -9466,6 +9476,9 @@ export interface operations {
|
|
|
9466
9476
|
query?: {
|
|
9467
9477
|
sort_by?: components["schemas"]["ContactSortField"];
|
|
9468
9478
|
sort_order?: components["schemas"]["SortOrder"];
|
|
9479
|
+
/** @description Filter by tag IDs. Can be specified multiple times. */
|
|
9480
|
+
tag_ids?: TypeId<"tag">[] | null;
|
|
9481
|
+
tag_mode?: components["schemas"]["TagFilterMode"];
|
|
9469
9482
|
first_name?: string | null;
|
|
9470
9483
|
last_name?: string | null;
|
|
9471
9484
|
email?: string | null;
|
|
@@ -9473,6 +9486,8 @@ export interface operations {
|
|
|
9473
9486
|
country?: string | null;
|
|
9474
9487
|
created_after?: Date | null;
|
|
9475
9488
|
created_before?: Date | null;
|
|
9489
|
+
/** @description Include additional data in the response. Can be specified multiple times. */
|
|
9490
|
+
include?: components["schemas"]["ContactIncludeField"][] | null;
|
|
9476
9491
|
page?: number;
|
|
9477
9492
|
page_size?: number;
|
|
9478
9493
|
};
|
|
@@ -9952,7 +9967,9 @@ export interface operations {
|
|
|
9952
9967
|
};
|
|
9953
9968
|
get_contact_v1_contacts__contact_id__get: {
|
|
9954
9969
|
parameters: {
|
|
9955
|
-
query?:
|
|
9970
|
+
query?: {
|
|
9971
|
+
include?: components["schemas"]["ContactIncludeField"][] | null;
|
|
9972
|
+
};
|
|
9956
9973
|
header?: never;
|
|
9957
9974
|
path: {
|
|
9958
9975
|
contact_id: TypeId<"contact">;
|