@opusdns/api 0.210.0 → 0.212.0

package/package.json

@@ -3,7 +3,7 @@
     "@opusdns/api-spec-ts-generator": "^0.19.0"
   },
   "name": "@opusdns/api",
-  "version": "0.210.0",
+  "version": "0.212.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, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ComplianceStatus, ConditionOperator, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAttributeKey, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainForwardSortField, DomainForwardZoneSortField, DomainSortField, DomainStatus, EmailForwardLogSortField, EmailForwardLogStatus, EmailForwardSortField, EmailForwardZoneSortField, EmailVerificationStatus, EventObjectType, EventSortField, EventSubtype, EventType, ExecutingEntity, GrantType, HTTPMethod, HostStatus, HttpProtocol, InvoiceResponsePaymentStatus, InvoiceResponseStatus, InvoiceResponseType, LaunchPhaseType, LocalPresenceRequirementType, MetricsGrouping, ObjectEventType, ObjectLogSortField, OrganizationStatus, ParkingSortField, PatchOp, PeriodUnit, Permission, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, Protocol, RedirectCode, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, RequestHistorySortField, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TimeRange, TransferAckType, UserStatus, VerificationType, ZoneSortField } from './schemas';
+import { AllocationMethodType, AttributeType, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ComplianceStatus, ConditionOperator, ContactAttributeSetSortField, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAttributeKey, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainForwardSortField, DomainForwardZoneSortField, DomainSortField, DomainStatus, EmailForwardLogSortField, EmailForwardLogStatus, EmailForwardSortField, EmailForwardZoneSortField, EmailVerificationStatus, EventObjectType, EventSortField, EventSubtype, EventType, ExecutingEntity, GrantType, HTTPMethod, HostStatus, HttpProtocol, InvoiceResponsePaymentStatus, InvoiceResponseStatus, InvoiceResponseType, LaunchPhaseType, LocalPresenceRequirementType, MetricsGrouping, ObjectEventType, ObjectLogSortField, OrganizationStatus, ParkingSortField, PatchOp, PeriodUnit, Permission, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, Protocol, RedirectCode, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, RequestHistorySortField, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TimeRange, TransferAckType, UserStatus, VerificationType, ZoneSortField } from './schemas';
 
 /**
  * AllocationMethodType. Auto-generated enum for AllocationMethodType
@@ -467,6 +467,60 @@ export const CONDITION_OPERATOR_VALUES = [
   'not_in'
 ] as const satisfies [string, ...string[]] | ConditionOperator[];
 
+/**
+ * ContactAttributeSetSortField. Auto-generated enum for ContactAttributeSetSortField
+ *
+ * @remarks
+ * This constant provides both object and array forms for the ContactAttributeSetSortField 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_ATTRIBUTE_SET_SORT_FIELD.SUCCESS;
+ * 
+ * // Using the array form for iteration
+ * const allStatuses = CONTACT_ATTRIBUTE_SET_SORT_FIELD_VALUES;
+ * console.log(`Available statuses: ${allStatuses.join(', ')}`);
+ * ```
+ *
+ * @see {@link ContactAttributeSetSortField} - The TypeScript type definition
+ */
+export const CONTACT_ATTRIBUTE_SET_SORT_FIELD = {
+  LABEL: "label",
+  TLD: "tld",
+  CREATED_ON: "created_on",
+  UPDATED_ON: "updated_on",
+} as const satisfies Record<string, ContactAttributeSetSortField>;
+
+/**
+ * Array of all ContactAttributeSetSortField enum values
+ *
+ * @remarks
+ * This constant provides a array containing all valid ContactAttributeSetSortField enum values.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all values
+ * for (const value of CONTACT_ATTRIBUTE_SET_SORT_FIELD_VALUES) {
+ *   console.log(`Processing: ${value}`);
+ * }
+ * 
+ * // Validation
+ * const isValid = CONTACT_ATTRIBUTE_SET_SORT_FIELD_VALUES.includes(someValue);
+ * ```
+ *
+ * @see {@link ContactAttributeSetSortField} - The TypeScript type definition
+ * @see {@link CONTACT_ATTRIBUTE_SET_SORT_FIELD} - The object form of this enum
+ */
+export const CONTACT_ATTRIBUTE_SET_SORT_FIELD_VALUES = [
+  'label',
+  'tld',
+  'created_on',
+  'updated_on'
+] as const satisfies [string, ...string[]] | ContactAttributeSetSortField[];
+
 /**
  * ContactSortField. Auto-generated enum for ContactSortField
  *

package/src/helpers/keys.ts

@@ -1829,6 +1829,32 @@ export const KEY_CONTACT_ATTRIBUTE_SET_CREATED_ON: keyof ContactAttributeSet = '
  * @see {@link KEYS_CONTACT_ATTRIBUTE_SET} - Array of all keys for this type
  */
 export const KEY_CONTACT_ATTRIBUTE_SET_LABEL: keyof ContactAttributeSet = 'label';
+/**
+ * Linked Contacts
+ *
+ * Number of contacts linked to this attribute set
+ *
+ * @type {integer}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `linked_contacts` property of ContactAttributeSet objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = contactattributeset[KEY_CONTACT_ATTRIBUTE_SET_LINKED_CONTACTS];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_CONTACT_ATTRIBUTE_SET_LINKED_CONTACTS;
+ * const value = contactattributeset[propertyName];
+ * ```
+ *
+ * @see {@link ContactAttributeSet} - The TypeScript type definition
+ * @see {@link KEYS_CONTACT_ATTRIBUTE_SET} - Array of all keys for this type
+ */
+export const KEY_CONTACT_ATTRIBUTE_SET_LINKED_CONTACTS: keyof ContactAttributeSet = 'linked_contacts';
 /**
  * Organization Id
  *
@@ -1933,6 +1959,7 @@ export const KEYS_CONTACT_ATTRIBUTE_SET = [
   KEY_CONTACT_ATTRIBUTE_SET_CONTACT_ATTRIBUTE_SET_ID,
   KEY_CONTACT_ATTRIBUTE_SET_CREATED_ON,
   KEY_CONTACT_ATTRIBUTE_SET_LABEL,
+  KEY_CONTACT_ATTRIBUTE_SET_LINKED_CONTACTS,
   KEY_CONTACT_ATTRIBUTE_SET_ORGANIZATION_ID,
   KEY_CONTACT_ATTRIBUTE_SET_TLD,
   KEY_CONTACT_ATTRIBUTE_SET_UPDATED_ON,

package/src/helpers/requests.d.ts

@@ -475,7 +475,6 @@ export type POST_Contacts_Request_Body = POST_Contacts_Request['requestBody'];
  * Use this type to ensure type safety when making API requests to this endpoint.
  *
  * @path /v1/contacts/attribute-sets
- * @param tld (query) - Filter by TLD (e.g. 'de', '.de', 'DE')
  *
  * @see {@link GET_ContactsAttributeSets_Request_Query} - Query parameters type
  * @see {@link GET_ContactsAttributeSets_Request_Path} - Path parameters type
@@ -497,7 +496,6 @@ export type GET_ContactsAttributeSets_Request = {
  * Use this type to ensure type safety for query parameters.
  *
  * @path /v1/contacts/attribute-sets
- * @param tld (query) - Filter by TLD (e.g. 'de', '.de', 'DE')
  */
 export type GET_ContactsAttributeSets_Request_Query = GET_ContactsAttributeSets_Request['parameters']['query'];
 

package/src/helpers/responses.d.ts

@@ -689,7 +689,6 @@ export type POST_Contacts_Response_422 = HTTPValidationError
 
  *
  * @path /v1/contacts/attribute-sets
- * @param tld (query) - Filter by TLD (e.g. 'de', '.de', 'DE')
  *
  * @see {@link GET_ContactsAttributeSets_Response_200} - 200 response type
  * @see {@link GET_ContactsAttributeSets_Response_422} - 422 response type
@@ -709,7 +708,6 @@ export type GET_ContactsAttributeSets_Response = GET_ContactsAttributeSets_Respo
 
  *
  * @path /v1/contacts/attribute-sets
- * @param tld (query) - Filter by TLD (e.g. 'de', '.de', 'DE')
  *
  * @see {@link GET_ContactsAttributeSets_Response} - The main response type definition
  * @see {@link Pagination_ContactAttributeSet} - The actual schema type definition
@@ -727,7 +725,6 @@ export type GET_ContactsAttributeSets_Response_200 = Pagination_ContactAttribute
 
  *
  * @path /v1/contacts/attribute-sets
- * @param tld (query) - Filter by TLD (e.g. 'de', '.de', 'DE')
  *
  * @see {@link GET_ContactsAttributeSets_Response} - The main response type definition
  * @see {@link HTTPValidationError} - The actual schema type definition

package/src/helpers/schemas.d.ts

@@ -330,6 +330,22 @@ export type ContactAttributeSetCreate = components['schemas']['ContactAttributeS
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type ContactAttributeSet = components['schemas']['ContactAttributeSetResponse'];
+/**
+ * ContactAttributeSetSortField
+ *
+ * @remarks
+ * Type alias for the `ContactAttributeSetSortField` OpenAPI schema.
+ * This type represents contactattributesetsortfield data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getContactAttributeSetSortField();
+ * const item: ContactAttributeSetSortField = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type ContactAttributeSetSortField = components['schemas']['ContactAttributeSetSortField'];
 /**
  * ContactAttributeSetUpdate
  *

package/src/openapi.yaml

@@ -444,6 +444,11 @@ components:
           minLength: 1
           title: Label
           type: string
+        linked_contacts:
+          default: 0
+          description: Number of contacts linked to this attribute set
+          title: Linked Contacts
+          type: integer
         organization_id:
           description: The organization that owns this attribute set
           examples:
@@ -472,6 +477,14 @@ components:
       - updated_on
       title: ContactAttributeSetResponse
       type: object
+    ContactAttributeSetSortField:
+      enum:
+      - label
+      - tld
+      - created_on
+      - updated_on
+      title: ContactAttributeSetSortField
+      type: string
     ContactAttributeSetUpdate:
       properties:
         label:
@@ -7213,7 +7226,7 @@ info:
     '
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2026-03-02-094357
+  version: 2026-03-02-095654
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -8165,16 +8178,34 @@ paths:
     get:
       operationId: list_attribute_sets_v1_contacts_attribute_sets_get
       parameters:
-      - description: Filter by TLD (e.g. 'de', '.de', 'DE')
-        in: query
+      - in: query
+        name: sort_by
+        required: false
+        schema:
+          $ref: '#/components/schemas/ContactAttributeSetSortField'
+          default: created_on
+      - in: query
+        name: sort_order
+        required: false
+        schema:
+          $ref: '#/components/schemas/SortOrder'
+          default: desc
+      - in: query
         name: tld
         required: false
         schema:
           anyOf:
           - type: string
           - type: 'null'
-          description: Filter by TLD (e.g. 'de', '.de', 'DE')
           title: Tld
+      - in: query
+        name: label
+        required: false
+        schema:
+          anyOf:
+          - type: string
+          - type: 'null'
+          title: Label
       - in: query
         name: page
         required: false

package/src/schema.d.ts

@@ -2238,6 +2238,12 @@ export interface components {
              * @description A human-readable label explaining the purpose of this attribute set
              */
             label: string;
+            /**
+             * Linked Contacts
+             * @description Number of contacts linked to this attribute set
+             * @default 0
+             */
+            linked_contacts: number;
             /**
              * Organization Id
              * Format: typeid
@@ -2257,6 +2263,11 @@ export interface components {
              */
             updated_on: Date;
         };
+        /**
+         * ContactAttributeSetSortField
+         * @enum {string}
+         */
+        ContactAttributeSetSortField: "label" | "tld" | "created_on" | "updated_on";
         /** ContactAttributeSetUpdate */
         ContactAttributeSetUpdate: {
             /**
@@ -7172,8 +7183,10 @@ export interface operations {
     list_attribute_sets_v1_contacts_attribute_sets_get: {
         parameters: {
             query?: {
-                /** @description Filter by TLD (e.g. 'de', '.de', 'DE') */
+                sort_by?: components["schemas"]["ContactAttributeSetSortField"];
+                sort_order?: components["schemas"]["SortOrder"];
                 tld?: string | null;
+                label?: string | null;
                 page?: number;
                 page_size?: number;
             };