@opusdns/api 0.275.0 → 0.276.0

package/package.json

@@ -3,7 +3,7 @@
     "@opusdns/api-spec-ts-generator": "^0.19.0"
   },
   "name": "@opusdns/api",
-  "version": "0.275.0",
+  "version": "0.276.0",
   "description": "TypeScript types for the OpusDNS OpenAPI specification",
   "main": "./src/index.ts",
   "module": "./src/index.ts",

package/src/helpers/constants.ts

@@ -21,7 +21,7 @@
  * ```
  */
 
-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';
+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';
 
 /**
  * AllocationMethodType. Auto-generated enum for AllocationMethodType
@@ -627,6 +627,54 @@ export const CONTACT_ATTRIBUTE_SET_SORT_FIELD_VALUES = [
   'updated_on'
 ] as const satisfies [string, ...string[]] | ContactAttributeSetSortField[];
 
+/**
+ * ContactIncludeField. Auto-generated enum for ContactIncludeField
+ *
+ * @remarks
+ * This constant provides both object and array forms for the ContactIncludeField enum.
+ * The object form allows key-value access, while the array form enables iteration and validation.
+ *
+ * @example
+ * ```typescript
+ * // Using the object form for key-value access
+ * const status = CONTACT_INCLUDE_FIELD.SUCCESS;
+ * 
+ * // Using the array form for iteration
+ * const allStatuses = CONTACT_INCLUDE_FIELD_VALUES;
+ * console.log(`Available statuses: ${allStatuses.join(', ')}`);
+ * ```
+ *
+ * @see {@link ContactIncludeField} - The TypeScript type definition
+ */
+export const CONTACT_INCLUDE_FIELD = {
+  TAGS: "tags",
+} as const satisfies Record<string, ContactIncludeField>;
+
+/**
+ * Array of all ContactIncludeField enum values
+ *
+ * @remarks
+ * This constant provides a array containing all valid ContactIncludeField enum values.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all values
+ * for (const value of CONTACT_INCLUDE_FIELD_VALUES) {
+ *   console.log(`Processing: ${value}`);
+ * }
+ * 
+ * // Validation
+ * const isValid = CONTACT_INCLUDE_FIELD_VALUES.includes(someValue);
+ * ```
+ *
+ * @see {@link ContactIncludeField} - The TypeScript type definition
+ * @see {@link CONTACT_INCLUDE_FIELD} - The object form of this enum
+ */
+export const CONTACT_INCLUDE_FIELD_VALUES = [
+  'tags'
+] as const satisfies [string, ...string[]] | ContactIncludeField[];
+
 /**
  * ContactSortField. Auto-generated enum for ContactSortField
  *

package/src/helpers/keys.ts

@@ -4740,6 +4740,31 @@ export const KEY_CONTACT_STATE: keyof Contact = 'state';
  * @see {@link KEYS_CONTACT} - Array of all keys for this type
  */
 export const KEY_CONTACT_STREET: keyof Contact = 'street';
+/**
+ * Tags
+ *
+ * Tags assigned to this contact
+ *
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `tags` property of Contact objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = contact[KEY_CONTACT_TAGS];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_CONTACT_TAGS;
+ * const value = contact[propertyName];
+ * ```
+ *
+ * @see {@link Contact} - The TypeScript type definition
+ * @see {@link KEYS_CONTACT} - Array of all keys for this type
+ */
+export const KEY_CONTACT_TAGS: keyof Contact = 'tags';
 /**
  * Title
  *
@@ -4803,6 +4828,7 @@ export const KEYS_CONTACT = [
   KEY_CONTACT_POSTAL_CODE,
   KEY_CONTACT_STATE,
   KEY_CONTACT_STREET,
+  KEY_CONTACT_TAGS,
   KEY_CONTACT_TITLE,
 ] as const satisfies (keyof Contact)[];
 

package/src/helpers/requests.d.ts

@@ -451,6 +451,8 @@ export type POST_AvailabilityStream_Request_Body = POST_AvailabilityStream_Reque
  * Use this type to ensure type safety when making API requests to this endpoint.
  *
  * @path /v1/contacts
+ * @param tag_ids (query) - Filter by tag IDs. Can be specified multiple times.
+ * @param include (query) - Include additional data in the response. Can be specified multiple times.
  *
  * @see {@link GET_Contacts_Request_Query} - Query parameters type
  * @see {@link GET_Contacts_Request_Path} - Path parameters type
@@ -472,6 +474,8 @@ export type GET_Contacts_Request = {
  * Use this type to ensure type safety for query parameters.
  *
  * @path /v1/contacts
+ * @param tag_ids (query) - Filter by tag IDs. Can be specified multiple times.
+ * @param include (query) - Include additional data in the response. Can be specified multiple times.
  */
 export type GET_Contacts_Request_Query = GET_Contacts_Request['parameters']['query'];
 
@@ -774,9 +778,23 @@ export type DELETE_ContactsContactId_Request_Path = DELETE_ContactsContactId_Req
  */
 export type GET_ContactsContactId_Request = {
   parameters: {
+    query: operations['get_contact_v1_contacts__contact_id__get']['parameters']['query'];
     path: operations['get_contact_v1_contacts__contact_id__get']['parameters']['path'];
   };
 }
+/**
+ * Query parameters for GET /v1/contacts/{contact_id}
+ *
+ * @remarks
+ * This type defines the query parameters for the GET /v1/contacts/{contact_id} endpoint.
+ * It provides type safety for all query parameters as defined in the OpenAPI specification.
+ *
+ * @example
+ * Use this type to ensure type safety for query parameters.
+ *
+ * @path /v1/contacts/{contact_id}
+ */
+export type GET_ContactsContactId_Request_Query = GET_ContactsContactId_Request['parameters']['query'];
 /**
  * Path parameters for GET /v1/contacts/{contact_id}
  *

package/src/helpers/responses.d.ts

@@ -574,6 +574,8 @@ export type POST_AvailabilityStream_Response_422 = HTTPValidationError
 
  *
  * @path /v1/contacts
+ * @param tag_ids (query) - Filter by tag IDs. Can be specified multiple times.
+ * @param include (query) - Include additional data in the response. Can be specified multiple times.
  *
  * @see {@link GET_Contacts_Response_200} - 200 response type
  * @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
 
  *
  * @path /v1/contacts
+ * @param tag_ids (query) - Filter by tag IDs. Can be specified multiple times.
+ * @param include (query) - Include additional data in the response. Can be specified multiple times.
  *
  * @see {@link GET_Contacts_Response} - The main response type definition
  * @see {@link Pagination_Contact} - The actual schema type definition
@@ -610,6 +614,8 @@ export type GET_Contacts_Response_200 = Pagination_Contact
 
  *
  * @path /v1/contacts
+ * @param tag_ids (query) - Filter by tag IDs. Can be specified multiple times.
+ * @param include (query) - Include additional data in the response. Can be specified multiple times.
  *
  * @see {@link GET_Contacts_Response} - The main response type definition
  * @see {@link HTTPValidationError} - The actual schema type definition

package/src/helpers/schemas-arrays.d.ts

@@ -21,8 +21,22 @@
  * This file is auto-generated from the OpenAPI specification.
  * Do not edit manually.
  */
-import { ZoneIncludeField, DomainIncludeField, DomainDnssecData, DomainDnssecDataCreate, JobStatus, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, ReportType, ReportStatus, TagType, TldResponseShort, AttributeCondition, DomainContactType, ContactCreateBulkInstance, ContactAttributeLinkDetail, ContactAttributeDefinition, PostalAddressType, ContactConfigBase, CommandError, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsZoneCreateBulkInstance, DnsRecordPatchOp, DnsZonePatchRecordsBulkInstance, DnsRrsetPatchOp, DnsZonePatchRrsetsBulkInstance, DnsRrset, TagEnriched, DnsZoneUpdateBulkInstance, DomainAvailabilityCheck, ContactHandle, Nameserver, DomainCreateBulkInstance, BrowserStatsBucket, GeoStatsBucket, TimeSeriesBucket, DomainForwardPatchOp, PlatformStatsBucket, HttpRedirectRequest, HttpRedirectList, ReferrerStatsBucket, StatusCodeStatsBucket, UserAgentStatsBucket, VisitsByKeyBucket, DomainForward, DeletePolicyType, SyncOperationType, DomainContact, DomainHost, DomainSearchSuggestionWithPrice, DomainStatus, DomainTransferBulkInstance, DomainClientStatus, DomainUpdateBulkInstance, EmailForwardAliasCreate, EmailForwardLogEvent, EmailForwardAliasMetrics, EmailForwardAlias, EmailForward, PriceInfo, ValidationError, LaunchPhaseBase, LegalRequirementOperationType, LocalPresenceRequirementType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactAttributeSet, Contact, DnsZone, DomainForwardZone, Domain, EmailForwardLog, EmailForwardZone, EventResponse, Invoice, JobBatchMetadata, Job, ObjectLog, Organization, Parking, RequestHistory, Tag, UserPublic, ParkingCreateBulkInstance, ParkingDeleteBulkInstance, ParkingDisableBulkInstance, ParkingEnableBulkInstance, Period, Permission, PremiumAffectsType, PremiumPriceEntryRes, PremiumPricingAction, PublicReportRes, Relation, LegalRequirementBase, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
+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';
 
+/**
+ * ContactIncludeField
+ *
+ * @remarks
+ * Array type for ContactIncludeField objects. Used when the API returns a collection of ContactIncludeField instances.
+ *
+ * @example
+ * ```typescript
+ * const items: ContactIncludeFieldArray = await api.getContactIncludeFields();
+ * ```
+ *
+ * @see {@link ContactIncludeField} - The individual ContactIncludeField type definition
+ */
+export type ContactIncludeFieldArray = ContactIncludeField[];
 /**
  * ZoneIncludeField
  *
@@ -247,6 +261,20 @@ export type ContactCreateBulkInstanceArray = ContactCreateBulkInstance[];
  * @see {@link ContactAttributeLinkDetail} - The individual ContactAttributeLinkDetail type definition
  */
 export type ContactAttributeLinkDetailArray = ContactAttributeLinkDetail[];
+/**
+ * TagEnrichedResponse
+ *
+ * @remarks
+ * Array type for TagEnrichedResponse objects. Used when the API returns a collection of TagEnrichedResponse instances.
+ *
+ * @example
+ * ```typescript
+ * const items: TagEnrichedArray = await api.getTagEnricheds();
+ * ```
+ *
+ * @see {@link TagEnriched} - The individual TagEnrichedResponse type definition
+ */
+export type TagEnrichedArray = TagEnriched[];
 /**
  * ContactAttributeDefinition. Definition of a possible attribute for a TLD.
  *
@@ -443,20 +471,6 @@ export type DnsZonePatchRrsetsBulkInstanceArray = DnsZonePatchRrsetsBulkInstance
  * @see {@link DnsRrset} - The individual DnsRrsetResponse type definition
  */
 export type DnsRrsetArray = DnsRrset[];
-/**
- * TagEnrichedResponse
- *
- * @remarks
- * Array type for TagEnrichedResponse objects. Used when the API returns a collection of TagEnrichedResponse instances.
- *
- * @example
- * ```typescript
- * const items: TagEnrichedArray = await api.getTagEnricheds();
- * ```
- *
- * @see {@link TagEnriched} - The individual TagEnrichedResponse type definition
- */
-export type TagEnrichedArray = TagEnriched[];
 /**
  * DnsZoneUpdateBulkInstance
  *

package/src/helpers/schemas.d.ts

@@ -602,6 +602,22 @@ export type ContactHandle = components['schemas']['ContactHandle'];
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type ContactIdList = components['schemas']['ContactIdList'];
+/**
+ * ContactIncludeField
+ *
+ * @remarks
+ * Type alias for the `ContactIncludeField` OpenAPI schema.
+ * This type represents contactincludefield data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getContactIncludeField();
+ * const item: ContactIncludeField = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type ContactIncludeField = components['schemas']['ContactIncludeField'];
 /**
  * ContactResponse
  *

package/src/openapi.yaml

@@ -1072,6 +1072,11 @@ components:
       propertyNames:
         $ref: '#/components/schemas/DomainContactType'
       type: object
+    ContactIncludeField:
+      enum:
+      - tags
+      title: ContactIncludeField
+      type: string
     ContactResponse:
       properties:
         attribute_sets:
@@ -1172,6 +1177,14 @@ components:
           minLength: 1
           title: Street
           type: string
+        tags:
+          anyOf:
+          - items:
+              $ref: '#/components/schemas/TagEnrichedResponse'
+            type: array
+          - type: 'null'
+          description: Tags assigned to this contact
+          title: Tags
         title:
           anyOf:
           - minLength: 1
@@ -10199,7 +10212,7 @@ info:
     \n\n"
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2026-04-27-193424
+  version: 2026-04-28-063751
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -11050,6 +11063,29 @@ paths:
         schema:
           $ref: '#/components/schemas/SortOrder'
           default: desc
+      - description: Filter by tag IDs. Can be specified multiple times.
+        in: query
+        name: tag_ids
+        required: false
+        schema:
+          anyOf:
+          - items:
+              examples:
+              - tag_01h45ytscbebyvny4gc8cr8ma2
+              format: typeid
+              pattern: ^tag_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+              type: string
+              x-typeid-prefix: tag
+            type: array
+          - type: 'null'
+          description: Filter by tag IDs. Can be specified multiple times.
+          title: Tag Ids
+      - in: query
+        name: tag_mode
+        required: false
+        schema:
+          $ref: '#/components/schemas/TagFilterMode'
+          default: match_any
       - in: query
         name: first_name
         required: false
@@ -11108,6 +11144,20 @@ paths:
             type: string
           - type: 'null'
           title: Created Before
+      - description: Include additional data in the response. Can be specified multiple
+          times.
+        in: query
+        name: include
+        required: false
+        schema:
+          anyOf:
+          - items:
+              $ref: '#/components/schemas/ContactIncludeField'
+            type: array
+          - type: 'null'
+          description: Include additional data in the response. Can be specified multiple
+            times.
+          title: Include
       - in: query
         name: page
         required: false
@@ -11644,6 +11694,16 @@ paths:
           title: Contact Id
           type: string
           x-typeid-prefix: contact
+      - in: query
+        name: include
+        required: false
+        schema:
+          anyOf:
+          - items:
+              $ref: '#/components/schemas/ContactIncludeField'
+            type: array
+          - type: 'null'
+          title: Include
       responses:
         '200':
           content:

package/src/schema.d.ts

@@ -2971,6 +2971,11 @@ export interface components {
         ContactIdList: {
             [key: string]: TypeId<"contact">;
         };
+        /**
+         * ContactIncludeField
+         * @enum {string}
+         */
+        ContactIncludeField: "tags";
         /** ContactResponse */
         ContactResponse: {
             /**
@@ -3061,6 +3066,11 @@ export interface components {
              * @description The address of the contact
              */
             street: string;
+            /**
+             * Tags
+             * @description Tags assigned to this contact
+             */
+            tags?: components["schemas"]["TagEnrichedResponse"][] | null;
             /**
              * Title
              * @description The title of the contact
@@ -9466,6 +9476,9 @@ export interface operations {
             query?: {
                 sort_by?: components["schemas"]["ContactSortField"];
                 sort_order?: components["schemas"]["SortOrder"];
+                /** @description Filter by tag IDs. Can be specified multiple times. */
+                tag_ids?: TypeId<"tag">[] | null;
+                tag_mode?: components["schemas"]["TagFilterMode"];
                 first_name?: string | null;
                 last_name?: string | null;
                 email?: string | null;
@@ -9473,6 +9486,8 @@ export interface operations {
                 country?: string | null;
                 created_after?: Date | null;
                 created_before?: Date | null;
+                /** @description Include additional data in the response. Can be specified multiple times. */
+                include?: components["schemas"]["ContactIncludeField"][] | null;
                 page?: number;
                 page_size?: number;
             };
@@ -9952,7 +9967,9 @@ export interface operations {
     };
     get_contact_v1_contacts__contact_id__get: {
         parameters: {
-            query?: never;
+            query?: {
+                include?: components["schemas"]["ContactIncludeField"][] | null;
+            };
             header?: never;
             path: {
                 contact_id: TypeId<"contact">;