@opusdns/api 0.209.0 → 0.211.0

package/src/helpers/responses.d.ts

@@ -34,7 +34,7 @@
 
 import { DomainDnssecDataArray, OrganizationAttribute2Array, IpRestrictionArray, TldResponseShortArray } from './schemas-arrays.d';
 
-import { Pagination_EmailForwardLog, HTTPValidationError, Pagination_ObjectLog, Pagination_RequestHistory, Problem, DomainAvailabilityList, Pagination_ContactDetail, ContactSchema, Pagination_ContactAttributeSet, ContactAttributeSet, ContactDetail, ContactAttributeLink, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DomainForwardZone, EmailForwardZone, Pagination_DomainForwardZone, Pagination_EmailForwardZone, DnsZoneSummary, Pagination_DomainForward, DomainForward, DomainForwardSet, DomainForwardMetrics, DomainForwardBrowserStats, DomainForwardGeoStats, DomainForwardPlatformStats, DomainForwardReferrerStats, DomainForwardStatusCodeStats, DomainForwardMetricsTimeSeries, DomainForwardUserAgentStats, DomainForwardVisitsByKey, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, DomainWithdraw, RequestAuthcode, DomainTransit, RequestAuthcode2, Pagination_EmailForward, EmailForward, EmailForwardAlias, EmailForwardMetrics, Pagination_Event, EventSchema, Pagination_Organization, Organization, OrganizationWithBillingData, Pagination_Invoice, GetPrices, Pagination_BillingTransaction, BillingTransaction, IpRestriction, Pagination_UserPublic, Pagination_Parking, ParkingMetrics, ParkingTotalMetrics, ParkingSignup, ParkingSignupStatus, TldSpecification, UserPublic, UserPublicWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
+import { Pagination_EmailForwardLog, HTTPValidationError, Pagination_ObjectLog, Pagination_RequestHistory, Problem, DomainAvailabilityList, Pagination_Contact, ContactSchema, Pagination_ContactAttributeSet, ContactAttributeSet, Contact, ContactAttributeLink, ContactVerification, Pagination_DnsZone, DnsZone, DnsChanges, DomainForwardZone, EmailForwardZone, Pagination_DomainForwardZone, Pagination_EmailForwardZone, DnsZoneSummary, Pagination_DomainForward, DomainForward, DomainForwardSet, DomainForwardMetrics, DomainForwardBrowserStats, DomainForwardGeoStats, DomainForwardPlatformStats, DomainForwardReferrerStats, DomainForwardStatusCodeStats, DomainForwardMetricsTimeSeries, DomainForwardUserAgentStats, DomainForwardVisitsByKey, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, DomainWithdraw, RequestAuthcode, DomainTransit, RequestAuthcode2, Pagination_EmailForward, EmailForward, EmailForwardAlias, EmailForwardMetrics, Pagination_Event, EventSchema, Pagination_Organization, Organization, OrganizationWithBillingData, Pagination_Invoice, GetPrices, Pagination_BillingTransaction, BillingTransaction, IpRestriction, Pagination_UserPublic, Pagination_Parking, ParkingMetrics, ParkingTotalMetrics, ParkingSignup, ParkingSignupStatus, TldSpecification, UserPublic, UserPublicWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
 
 /**
  * Response types for GET ArchiveEmailForwardLogsAliasesByEmailForwardAliasId endpoint
@@ -599,9 +599,9 @@ export type GET_Contacts_Response = GET_Contacts_Response_200 | GET_Contacts_Res
  * @path /v1/contacts
  *
  * @see {@link GET_Contacts_Response} - The main response type definition
- * @see {@link Pagination_ContactDetail} - The actual schema type definition
+ * @see {@link Pagination_Contact} - The actual schema type definition
  */
-export type GET_Contacts_Response_200 = Pagination_ContactDetail
+export type GET_Contacts_Response_200 = Pagination_Contact
 
 /**
  * 422 response for GET Contacts endpoint
@@ -1135,9 +1135,9 @@ export type GET_ContactsByContactId_Response = GET_ContactsByContactId_Response_
  * @path /v1/contacts/{contact_id}
  *
  * @see {@link GET_ContactsByContactId_Response} - The main response type definition
- * @see {@link ContactDetail} - The actual schema type definition
+ * @see {@link Contact} - The actual schema type definition
  */
-export type GET_ContactsByContactId_Response_200 = ContactDetail
+export type GET_ContactsByContactId_Response_200 = Contact
 
 /**
  * 404 response for GET ContactsByContactId endpoint

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

@@ -21,7 +21,7 @@
  * This file is auto-generated from the OpenAPI specification.
  * Do not edit manually.
  */
-import { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, TldResponseShort, AttributeCondition, DomainContactType, ContactAttributeLinkDetail, ContactAttributeDefinition, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, ContactHandle, Nameserver, BrowserStatsBucket, GeoStatsBucket, TimeSeriesBucket, DomainForwardPatchOp, PlatformStatsBucket, HttpRedirectRequest, HttpRedirectList, ReferrerStatsBucket, StatusCodeStatsBucket, UserAgentStatsBucket, VisitsByKeyBucket, DomainForward, DeletePolicyType, SyncOperationType, DomainContact, DomainHost, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, EmailForwardAliasCreate, EmailForwardLogEvent, EmailForwardAliasMetrics, EmailForwardAlias, EmailForward, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactAttributeSet, ContactDetail, DnsZone, DomainForwardZone, Domain, EmailForwardLog, EmailForwardZone, EventResponse, Invoice, ObjectLog, Organization, Parking, RequestHistory, UserPublic, Period, Permission, PremiumAffectsType, Relation, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
+import { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, TldResponseShort, AttributeCondition, DomainContactType, ContactAttributeLinkDetail, ContactAttributeDefinition, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, ContactHandle, Nameserver, BrowserStatsBucket, GeoStatsBucket, TimeSeriesBucket, DomainForwardPatchOp, PlatformStatsBucket, HttpRedirectRequest, HttpRedirectList, ReferrerStatsBucket, StatusCodeStatsBucket, UserAgentStatsBucket, VisitsByKeyBucket, DomainForward, DeletePolicyType, SyncOperationType, DomainContact, DomainHost, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, EmailForwardAliasCreate, EmailForwardLogEvent, EmailForwardAliasMetrics, EmailForwardAlias, EmailForward, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactAttributeSet, Contact, DnsZone, DomainForwardZone, Domain, EmailForwardLog, EmailForwardZone, EventResponse, Invoice, ObjectLog, Organization, Parking, RequestHistory, UserPublic, Period, Permission, PremiumAffectsType, Relation, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
 
 /**
  * DomainDnssecDataResponse
@@ -808,19 +808,19 @@ export type BillingTransactionArray = BillingTransaction[];
  */
 export type ContactAttributeSetArray = ContactAttributeSet[];
 /**
- * ContactDetailResponse
+ * ContactResponse
  *
  * @remarks
- * Array type for ContactDetailResponse objects. Used when the API returns a collection of ContactDetailResponse instances.
+ * Array type for ContactResponse objects. Used when the API returns a collection of ContactResponse instances.
  *
  * @example
  * ```typescript
- * const items: ContactDetailArray = await api.getContactDetails();
+ * const items: ContactArray = await api.getContacts();
  * ```
  *
- * @see {@link ContactDetail} - The individual ContactDetailResponse type definition
+ * @see {@link Contact} - The individual ContactResponse type definition
  */
-export type ContactDetailArray = ContactDetail[];
+export type ContactArray = Contact[];
 /**
  * DnsZoneResponse
  *

package/src/helpers/schemas.d.ts

@@ -378,22 +378,6 @@ export type ContactConfigBase = components['schemas']['ContactConfigBase'];
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type ContactCreate = components['schemas']['ContactCreate'];
-/**
- * ContactDetailResponse
- *
- * @remarks
- * Type alias for the `ContactDetailResponse` OpenAPI schema.
- * This type represents contactdetailresponse data structures used in API requests and responses.
- *
- * @example
- * ```typescript
- * const response = await api.getContactDetail();
- * const item: ContactDetail = response.results;
- * ```
- *
- * @see {@link components} - The OpenAPI components schema definition
- */
-export type ContactDetail = components['schemas']['ContactDetailResponse'];
 /**
  * ContactHandle
  *
@@ -3061,21 +3045,21 @@ export type Pagination_BillingTransaction = components['schemas']['Pagination_Bi
  */
 export type Pagination_ContactAttributeSet = components['schemas']['Pagination_ContactAttributeSetResponse_'];
 /**
- * Pagination[ContactDetailResponse]
+ * Pagination[ContactResponse]
  *
  * @remarks
- * Type alias for the `Pagination_ContactDetailResponse_` OpenAPI schema.
- * This type represents pagination[contactdetailresponse] data structures used in API requests and responses.
+ * Type alias for the `Pagination_ContactResponse_` OpenAPI schema.
+ * This type represents pagination[contactresponse] data structures used in API requests and responses.
  *
  * @example
  * ```typescript
- * const response = await api.getPagination_ContactDetail();
- * const item: Pagination_ContactDetail = response.results;
+ * const response = await api.getPagination_Contact();
+ * const item: Pagination_Contact = response.results;
  * ```
  *
  * @see {@link components} - The OpenAPI components schema definition
  */
-export type Pagination_ContactDetail = components['schemas']['Pagination_ContactDetailResponse_'];
+export type Pagination_Contact = components['schemas']['Pagination_ContactResponse_'];
 /**
  * Pagination[DnsZoneResponse]
  *

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:
@@ -596,132 +601,6 @@ components:
       - disclose
       title: ContactCreate
       type: object
-    ContactDetailResponse:
-      properties:
-        attribute_sets:
-          description: Linked attribute sets for this contact
-          items:
-            $ref: '#/components/schemas/ContactAttributeLinkDetail'
-          title: Attribute Sets
-          type: array
-        city:
-          description: The city of the contact
-          minLength: 1
-          title: City
-          type: string
-        contact_id:
-          examples:
-          - contact_01h45ytscbebyvny4gc8cr8ma2
-          format: typeid
-          pattern: ^contact_[0-7][0-9a-hjkmnpq-tv-z]{25}$
-          title: Contact Id
-          type: string
-          x-typeid-prefix: contact
-        country:
-          description: The country of the contact
-          pattern: ^\w{2}$
-          title: Country
-          type: string
-        created_on:
-          description: The date/time the entry was created on
-          format: date-time
-          title: Created On
-          type: string
-        deleted_on:
-          anyOf:
-          - format: date-time
-            type: string
-          - type: 'null'
-          description: The date/time the entry was deleted on
-          title: Deleted On
-        disclose:
-          description: Whether the contact details should be disclosed. The Disclose
-            function may not work with all TLDs. Some registries still display the
-            data in Whois if, for example, the organization field is filled in.
-          title: Disclose
-          type: boolean
-        email:
-          description: The email of the contact
-          format: email
-          title: Email
-          type: string
-        fax:
-          anyOf:
-          - format: phone
-            type: string
-          - type: 'null'
-          description: The contacts's fax number
-          title: Fax
-        first_name:
-          description: The first name of the contact
-          minLength: 1
-          title: First Name
-          type: string
-        last_name:
-          description: The last name of the contact
-          minLength: 1
-          title: Last Name
-          type: string
-        org:
-          anyOf:
-          - minLength: 1
-            type: string
-          - type: 'null'
-          description: The organization of the contact
-          title: Org
-        organization_id:
-          default: None
-          description: The organization that owns the domain
-          examples:
-          - organization_01h45ytscbebyvny4gc8cr8ma2
-          format: typeid
-          pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
-          title: Organization Id
-          type: string
-          x-typeid-prefix: organization
-        phone:
-          description: The contact's phone number
-          examples:
-          - '+1.2125552368'
-          format: phone
-          title: Phone
-          type: string
-        postal_code:
-          description: The postal code of the contact
-          minLength: 1
-          title: Postal Code
-          type: string
-        state:
-          anyOf:
-          - minLength: 1
-            type: string
-          - type: 'null'
-          description: The state of the contact
-          title: State
-        street:
-          description: The address of the contact
-          minLength: 1
-          title: Street
-          type: string
-        title:
-          anyOf:
-          - minLength: 1
-            type: string
-          - type: 'null'
-          description: The title of the contact
-          title: Title
-      required:
-      - first_name
-      - last_name
-      - email
-      - phone
-      - street
-      - city
-      - postal_code
-      - country
-      - disclose
-      title: ContactDetailResponse
-      type: object
     ContactHandle:
       properties:
         attributes:
@@ -761,16 +640,35 @@ components:
       type: object
     ContactResponse:
       properties:
+        attribute_sets:
+          description: Linked attribute sets for this contact
+          items:
+            $ref: '#/components/schemas/ContactAttributeLinkDetail'
+          title: Attribute Sets
+          type: array
         city:
           description: The city of the contact
           minLength: 1
           title: City
           type: string
+        contact_id:
+          examples:
+          - contact_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^contact_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: Contact Id
+          type: string
+          x-typeid-prefix: contact
         country:
           description: The country of the contact
           pattern: ^\w{2}$
           title: Country
           type: string
+        created_on:
+          description: The date/time the entry was created on
+          format: date-time
+          title: Created On
+          type: string
         disclose:
           description: Whether the contact details should be disclosed. The Disclose
             function may not work with all TLDs. Some registries still display the
@@ -806,6 +704,16 @@ components:
           - type: 'null'
           description: The organization of the contact
           title: Org
+        organization_id:
+          default: None
+          description: The organization that owns the domain
+          examples:
+          - organization_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: Organization Id
+          type: string
+          x-typeid-prefix: organization
         phone:
           description: The contact's phone number
           examples:
@@ -874,13 +782,6 @@ components:
           format: date-time
           title: Created On
           type: string
-        deleted_on:
-          anyOf:
-          - format: date-time
-            type: string
-          - type: 'null'
-          description: The date/time the entry was deleted on
-          title: Deleted On
         disclose:
           description: Whether the contact details should be disclosed. The Disclose
             function may not work with all TLDs. Some registries still display the
@@ -5101,19 +5002,19 @@ components:
       - pagination
       title: Pagination[ContactAttributeSetResponse]
       type: object
-    Pagination_ContactDetailResponse_:
+    Pagination_ContactResponse_:
       properties:
         pagination:
           $ref: '#/components/schemas/PaginationMetadata'
         results:
           items:
-            $ref: '#/components/schemas/ContactDetailResponse'
+            $ref: '#/components/schemas/ContactResponse'
           title: Results
           type: array
       required:
       - results
       - pagination
-      title: Pagination[ContactDetailResponse]
+      title: Pagination[ContactResponse]
       type: object
     Pagination_DnsZoneResponse_:
       properties:
@@ -7317,7 +7218,7 @@ info:
     '
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2026-02-26-134941
+  version: 2026-03-02-094551
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -8223,7 +8124,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/Pagination_ContactDetailResponse_'
+                $ref: '#/components/schemas/Pagination_ContactResponse_'
           description: Successful Response
         '422':
           content:
@@ -8724,7 +8625,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/ContactDetailResponse'
+                $ref: '#/components/schemas/ContactResponse'
           description: Successful Response
         '404':
           content:

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
@@ -2351,8 +2357,29 @@ export interface components {
              */
             title?: string | null;
         };
-        /** ContactDetailResponse */
-        ContactDetailResponse: {
+        /** ContactHandle */
+        ContactHandle: {
+            /**
+             * Attributes
+             * @description Additional attributes related to the contact
+             */
+            attributes?: {
+                [key: string]: string;
+            } | null;
+            /**
+             * Contact Id
+             * Format: typeid
+             * @description The contact id of the contact
+             * @example contact_01h45ytscbebyvny4gc8cr8ma2
+             */
+            contact_id: TypeId<"contact">;
+        };
+        /** @description The contacts of the domain */
+        ContactIdList: {
+            [key: string]: TypeId<"contact">;
+        };
+        /** ContactResponse */
+        ContactResponse: {
             /**
              * Attribute Sets
              * @description Linked attribute sets for this contact
@@ -2380,11 +2407,6 @@ export interface components {
              * @description The date/time the entry was created on
              */
             created_on?: Date;
-            /**
-             * Deleted On
-             * @description The date/time the entry was deleted on
-             */
-            deleted_on?: Date | null;
             /**
              * Disclose
              * @description Whether the contact details should be disclosed. The Disclose function may not work with all TLDs. Some registries still display the data in Whois if, for example, the organization field is filled in.
@@ -2452,98 +2474,6 @@ export interface components {
              */
             title?: string | null;
         };
-        /** ContactHandle */
-        ContactHandle: {
-            /**
-             * Attributes
-             * @description Additional attributes related to the contact
-             */
-            attributes?: {
-                [key: string]: string;
-            } | null;
-            /**
-             * Contact Id
-             * Format: typeid
-             * @description The contact id of the contact
-             * @example contact_01h45ytscbebyvny4gc8cr8ma2
-             */
-            contact_id: TypeId<"contact">;
-        };
-        /** @description The contacts of the domain */
-        ContactIdList: {
-            [key: string]: TypeId<"contact">;
-        };
-        /** ContactResponse */
-        ContactResponse: {
-            /**
-             * City
-             * @description The city of the contact
-             */
-            city: string;
-            /**
-             * Country
-             * @description The country of the contact
-             */
-            country: string;
-            /**
-             * Disclose
-             * @description Whether the contact details should be disclosed. The Disclose function may not work with all TLDs. Some registries still display the data in Whois if, for example, the organization field is filled in.
-             */
-            disclose: boolean;
-            /**
-             * Email
-             * Format: email
-             * @description The email of the contact
-             */
-            email: string;
-            /**
-             * Fax
-             * @description The contacts's fax number
-             */
-            fax?: string | null;
-            /**
-             * First Name
-             * @description The first name of the contact
-             */
-            first_name: string;
-            /**
-             * Last Name
-             * @description The last name of the contact
-             */
-            last_name: string;
-            /**
-             * Org
-             * @description The organization of the contact
-             */
-            org?: string | null;
-            /**
-             * Phone
-             * Format: phone
-             * @description The contact's phone number
-             * @example +1.2125552368
-             */
-            phone: string;
-            /**
-             * Postal Code
-             * @description The postal code of the contact
-             */
-            postal_code: string;
-            /**
-             * State
-             * @description The state of the contact
-             */
-            state?: string | null;
-            /**
-             * Street
-             * @description The address of the contact
-             */
-            street: string;
-            /**
-             * Title
-             * @description The title of the contact
-             */
-            title?: string | null;
-        };
         /** ContactSchema */
         ContactSchema: {
             /**
@@ -2568,11 +2498,6 @@ export interface components {
              * @description The date/time the entry was created on
              */
             created_on?: Date;
-            /**
-             * Deleted On
-             * @description The date/time the entry was deleted on
-             */
-            deleted_on?: Date | null;
             /**
              * Disclose
              * @description Whether the contact details should be disclosed. The Disclose function may not work with all TLDs. Some registries still display the data in Whois if, for example, the organization field is filled in.
@@ -5374,11 +5299,11 @@ export interface components {
             /** Results */
             results: components["schemas"]["ContactAttributeSetResponse"][];
         };
-        /** Pagination[ContactDetailResponse] */
-        Pagination_ContactDetailResponse_: {
+        /** Pagination[ContactResponse] */
+        Pagination_ContactResponse_: {
             pagination: components["schemas"]["PaginationMetadata"];
             /** Results */
-            results: components["schemas"]["ContactDetailResponse"][];
+            results: components["schemas"]["ContactResponse"][];
         };
         /** Pagination[DnsZoneResponse] */
         Pagination_DnsZoneResponse_: {
@@ -7203,7 +7128,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["Pagination_ContactDetailResponse_"];
+                    "application/json": components["schemas"]["Pagination_ContactResponse_"];
                 };
             };
             /** @description Validation Error */
@@ -7680,7 +7605,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["ContactDetailResponse"];
+                    "application/json": components["schemas"]["ContactResponse"];
                 };
             };
             /** @description Not Found */