@opusdns/api 1.147.0 → 1.148.0

package/package.json

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

package/src/helpers/constants.ts

@@ -89,6 +89,7 @@ import type {
   PublicScope,
   RedirectCode,
   RegistrantChangeType,
+  Registrar,
   RegistryHandleAttributeType,
   RegistryServiceBackend,
   RenewalMode,
@@ -768,19 +769,23 @@ export const DOMAIN_FORWARD_ZONE_SORT_FIELD_VALUES = [
 export const DOMAIN_INCLUDE_FIELD = {
   TAGS: "tags",
   RENEWAL_PRICE: "renewal_price",
+  REGISTRAR_CREDENTIAL: "registrar_credential",
 } as const satisfies Record<string, DomainIncludeField>;
 
 export const DOMAIN_INCLUDE_FIELD_VALUES = [
   'tags',
   'renewal_price',
+  'registrar_credential',
 ] as const satisfies ReadonlyArray<DomainIncludeField>;
 
 export const DOMAIN_LIST_INCLUDE_FIELD = {
   TAGS: "tags",
+  REGISTRAR_CREDENTIAL: "registrar_credential",
 } as const satisfies Record<string, DomainListIncludeField>;
 
 export const DOMAIN_LIST_INCLUDE_FIELD_VALUES = [
   'tags',
+  'registrar_credential',
 ] as const satisfies ReadonlyArray<DomainListIncludeField>;
 
 export const DOMAIN_SORT_FIELD = {
@@ -1586,6 +1591,30 @@ export const REGISTRANT_CHANGE_TYPE_VALUES = [
   'trade',
 ] as const satisfies ReadonlyArray<RegistrantChangeType>;
 
+export const REGISTRAR = {
+  INTERNETX: "INTERNETX",
+  MONIKER: "MONIKER",
+  DOMAIN_BESTELLSYSTEM: "DOMAIN_BESTELLSYSTEM",
+  CENTRALNIC: "CENTRALNIC",
+  NICMANAGER: "NICMANAGER",
+  OPUSDNS: "OPUSDNS",
+  ENOM: "ENOM",
+  OPENSRS: "OPENSRS",
+  NIC_DIRECT: "NIC_DIRECT",
+} as const satisfies Record<string, Registrar>;
+
+export const REGISTRAR_VALUES = [
+  'INTERNETX',
+  'MONIKER',
+  'DOMAIN_BESTELLSYSTEM',
+  'CENTRALNIC',
+  'NICMANAGER',
+  'OPUSDNS',
+  'ENOM',
+  'OPENSRS',
+  'NIC_DIRECT',
+] as const satisfies ReadonlyArray<Registrar>;
+
 export const REGISTRY_HANDLE_ATTRIBUTE_TYPE = {
   AT_EXT_CONTACT_TYPE: "at-ext-contact:type",
   DE_CONTACT_TYPE: "DE_CONTACT_TYPE",

package/src/helpers/keys.ts

@@ -177,6 +177,7 @@ import type {
   DomainPeriod,
   DomainRecommendationsContext,
   DomainRecommendationsContextCreate,
+  DomainRegistrarCredential,
   DomainRenewRequest,
   DomainRenew,
   DomainRenewalDetails,
@@ -2552,6 +2553,16 @@ export const KEYS_DOMAIN_RECOMMENDATIONS_CONTEXT_CREATE = [
   KEY_DOMAIN_RECOMMENDATIONS_CONTEXT_CREATE_PAYLOAD,
 ] as const satisfies (keyof DomainRecommendationsContextCreate)[];
 
+export const KEY_DOMAIN_REGISTRAR_CREDENTIAL_NAME = 'name' satisfies keyof DomainRegistrarCredential;
+export const KEY_DOMAIN_REGISTRAR_CREDENTIAL_REGISTRAR = 'registrar' satisfies keyof DomainRegistrarCredential;
+export const KEY_DOMAIN_REGISTRAR_CREDENTIAL_REGISTRAR_CREDENTIAL_ID = 'registrar_credential_id' satisfies keyof DomainRegistrarCredential;
+
+export const KEYS_DOMAIN_REGISTRAR_CREDENTIAL = [
+  KEY_DOMAIN_REGISTRAR_CREDENTIAL_NAME,
+  KEY_DOMAIN_REGISTRAR_CREDENTIAL_REGISTRAR,
+  KEY_DOMAIN_REGISTRAR_CREDENTIAL_REGISTRAR_CREDENTIAL_ID,
+] as const satisfies (keyof DomainRegistrarCredential)[];
+
 export const KEY_DOMAIN_RENEW_REQUEST_CURRENT_EXPIRY_DATE = 'current_expiry_date' satisfies keyof DomainRenewRequest;
 export const KEY_DOMAIN_RENEW_REQUEST_EXPECTED_PRICE = 'expected_price' satisfies keyof DomainRenewRequest;
 export const KEY_DOMAIN_RENEW_REQUEST_PERIOD = 'period' satisfies keyof DomainRenewRequest;
@@ -2607,6 +2618,7 @@ export const KEY_DOMAIN_NAMESERVERS = 'nameservers' satisfies keyof Domain;
 export const KEY_DOMAIN_OWNER_ID = 'owner_id' satisfies keyof Domain;
 export const KEY_DOMAIN_READ_ONLY = 'read_only' satisfies keyof Domain;
 export const KEY_DOMAIN_REGISTERED_ON = 'registered_on' satisfies keyof Domain;
+export const KEY_DOMAIN_REGISTRAR_CREDENTIAL = 'registrar_credential' satisfies keyof Domain;
 export const KEY_DOMAIN_REGISTRY_ACCOUNT_ID = 'registry_account_id' satisfies keyof Domain;
 export const KEY_DOMAIN_REGISTRY_STATUSES = 'registry_statuses' satisfies keyof Domain;
 export const KEY_DOMAIN_RENEWAL_MODE = 'renewal_mode' satisfies keyof Domain;
@@ -2638,6 +2650,7 @@ export const KEYS_DOMAIN = [
   KEY_DOMAIN_OWNER_ID,
   KEY_DOMAIN_READ_ONLY,
   KEY_DOMAIN_REGISTERED_ON,
+  KEY_DOMAIN_REGISTRAR_CREDENTIAL,
   KEY_DOMAIN_REGISTRY_ACCOUNT_ID,
   KEY_DOMAIN_REGISTRY_STATUSES,
   KEY_DOMAIN_RENEWAL_MODE,

package/src/helpers/schemas.d.ts

@@ -221,6 +221,7 @@ export type DomainNameParts = components['schemas']['DomainNameParts'];
 export type DomainPeriod = components['schemas']['DomainPeriod'];
 export type DomainRecommendationsContext = components['schemas']['DomainRecommendationsContext'];
 export type DomainRecommendationsContextCreate = components['schemas']['DomainRecommendationsContextCreate'];
+export type DomainRegistrarCredential = components['schemas']['DomainRegistrarCredentialResponse'];
 export type DomainRenewRequest = components['schemas']['DomainRenewRequest'];
 export type DomainRenew = components['schemas']['DomainRenewResponse'];
 export type DomainRenewalDetails = components['schemas']['DomainRenewalDetails'];
@@ -484,6 +485,7 @@ export type RdapBase = components['schemas']['RdapBase'];
 export type RedirectCode = components['schemas']['RedirectCode'];
 export type ReferrerStatsBucket = components['schemas']['ReferrerStatsBucket'];
 export type RegistrantChangeType = components['schemas']['RegistrantChangeType'];
+export type Registrar = components['schemas']['Registrar'];
 export type RegistrarContact = components['schemas']['RegistrarContact'];
 export type RegistrarDomain = components['schemas']['RegistrarDomain'];
 export type RegistrarNameserver = components['schemas']['RegistrarNameserver'];

package/src/openapi.yaml

@@ -5192,6 +5192,7 @@ components:
       enum:
       - tags
       - renewal_price
+      - registrar_credential
       title: DomainIncludeField
       type: string
     DomainLifecycleBase:
@@ -5345,9 +5346,15 @@ components:
 
         costs a registry check plus a billing call per premium domain, which a page
 
-        of results would multiply into a registry rate-limit problem.'
+        of results would multiply into a registry rate-limit problem.
+
+
+        Also typed on the internal domains-service list request, which implements
+
+        only `TAGS`; the public list route is the only consumer of every member.'
       enum:
       - tags
+      - registrar_credential
       title: DomainListIncludeField
       type: string
     DomainNameParts:
@@ -5452,6 +5459,30 @@ components:
       - payload
       title: DomainRecommendationsContextCreate
       type: object
+    DomainRegistrarCredentialResponse:
+      properties:
+        name:
+          description: Human-readable name for this credential
+          title: Name
+          type: string
+        registrar:
+          $ref: '#/components/schemas/Registrar'
+          description: The registrar this credential is for
+        registrar_credential_id:
+          description: Unique identifier for this credential
+          examples:
+          - registrar_credential_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^registrar_credential_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: Registrar Credential Id
+          type: string
+          x-typeid-prefix: registrar_credential
+      required:
+      - registrar_credential_id
+      - name
+      - registrar
+      title: DomainRegistrarCredentialResponse
+      type: object
     DomainRenewRequest:
       properties:
         current_expiry_date:
@@ -5650,6 +5681,14 @@ components:
           - type: 'null'
           description: When the domain was registered
           title: Registered On
+        registrar_credential:
+          anyOf:
+          - $ref: '#/components/schemas/DomainRegistrarCredentialResponse'
+          - type: 'null'
+          description: The connected registrar credential this domain is synced from.
+            Null unless `include=registrar_credential` is requested, and null even
+            then for natively registered domains, for domains on operator-managed
+            registry accounts, and when the credential was deleted.
         registry_account_id:
           default: None
           examples:
@@ -12267,6 +12306,19 @@ components:
       - trade
       title: RegistrantChangeType
       type: string
+    Registrar:
+      enum:
+      - INTERNETX
+      - MONIKER
+      - DOMAIN_BESTELLSYSTEM
+      - CENTRALNIC
+      - NICMANAGER
+      - OPUSDNS
+      - ENOM
+      - OPENSRS
+      - NIC_DIRECT
+      title: Registrar
+      type: string
     RegistrarContact:
       properties:
         city:
@@ -15898,7 +15950,7 @@ info:
     \n\n"
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2026-09-01-130544
+  version: 2026-09-02-183544
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -24016,7 +24068,9 @@ paths:
           title: Registry Statuses
       - description: Extra data to include in each result. `tags` populates the `tags`
           (user tags) and `status_tags` fields, which are otherwise null; filtering
-          by `tag_ids` or `status_tags` alone does not populate them.
+          by `tag_ids` or `status_tags` alone does not populate them. `registrar_credential`
+          populates the `registrar_credential` field for domains held at an external
+          registrar.
         in: query
         name: include
         required: false
@@ -24029,6 +24083,8 @@ paths:
           description: Extra data to include in each result. `tags` populates the
             `tags` (user tags) and `status_tags` fields, which are otherwise null;
             filtering by `tag_ids` or `status_tags` alone does not populate them.
+            `registrar_credential` populates the `registrar_credential` field for
+            domains held at an external registrar.
           title: Include
       - $ref: '#/components/parameters/DatetimeFormatHeader'
       responses:
@@ -25588,7 +25644,8 @@ paths:
           title: Domain Reference
       - description: Extra data to include in the response. `tags` populates the `tags`
           and `status_tags` fields, which are otherwise null. `renewal_price` resolves
-          the domain's renewal price.
+          the domain's renewal price. `registrar_credential` populates the `registrar_credential`
+          field for domains held at an external registrar.
         in: query
         name: include
         required: false
@@ -25600,7 +25657,8 @@ paths:
           - type: 'null'
           description: Extra data to include in the response. `tags` populates the
             `tags` and `status_tags` fields, which are otherwise null. `renewal_price`
-            resolves the domain's renewal price.
+            resolves the domain's renewal price. `registrar_credential` populates
+            the `registrar_credential` field for domains held at an external registrar.
           title: Include
       - $ref: '#/components/parameters/DatetimeFormatHeader'
       responses:

package/src/schema.d.ts

@@ -6425,7 +6425,7 @@ export interface components {
          * DomainIncludeField
          * @enum {string}
          */
-        DomainIncludeField: "tags" | "renewal_price";
+        DomainIncludeField: "tags" | "renewal_price" | "registrar_credential";
         /** DomainLifecycleBase */
         DomainLifecycleBase: {
             /**
@@ -6509,9 +6509,12 @@ export interface components {
          *     Deliberately narrower than `DomainIncludeField`: resolving a renewal price
          *     costs a registry check plus a billing call per premium domain, which a page
          *     of results would multiply into a registry rate-limit problem.
+         *
+         *     Also typed on the internal domains-service list request, which implements
+         *     only `TAGS`; the public list route is the only consumer of every member.
          * @enum {string}
          */
-        DomainListIncludeField: "tags";
+        DomainListIncludeField: "tags" | "registrar_credential";
         /** DomainNameParts */
         DomainNameParts: {
             /**
@@ -6583,6 +6586,23 @@ export interface components {
             kind: "domain_recommendations";
             payload: components["schemas"]["ContextPayload_DomainSearchSuggestionWithPrice_"];
         };
+        /** DomainRegistrarCredentialResponse */
+        DomainRegistrarCredentialResponse: {
+            /**
+             * Name
+             * @description Human-readable name for this credential
+             */
+            name: string;
+            /** @description The registrar this credential is for */
+            registrar: components["schemas"]["Registrar"];
+            /**
+             * Registrar Credential Id
+             * Format: typeid
+             * @description Unique identifier for this credential
+             * @example registrar_credential_01h45ytscbebyvny4gc8cr8ma2
+             */
+            registrar_credential_id: TypeId<"registrar_credential">;
+        };
         /** DomainRenewRequest */
         DomainRenewRequest: {
             /**
@@ -6735,6 +6755,8 @@ export interface components {
              * @description When the domain was registered
              */
             registered_on?: Date | null;
+            /** @description The connected registrar credential this domain is synced from. Null unless `include=registrar_credential` is requested, and null even then for natively registered domains, for domains on operator-managed registry accounts, and when the credential was deleted. */
+            registrar_credential?: components["schemas"]["DomainRegistrarCredentialResponse"] | null;
             /**
              * Registry Account Id
              * Format: typeid
@@ -11117,6 +11139,11 @@ export interface components {
          * @enum {string}
          */
         RegistrantChangeType: "update" | "trade";
+        /**
+         * Registrar
+         * @enum {string}
+         */
+        Registrar: "INTERNETX" | "MONIKER" | "DOMAIN_BESTELLSYSTEM" | "CENTRALNIC" | "NICMANAGER" | "OPUSDNS" | "ENOM" | "OPENSRS" | "NIC_DIRECT";
         /** RegistrarContact */
         RegistrarContact: {
             /** City */
@@ -19537,7 +19564,7 @@ export interface operations {
                 transferred_before?: Date | null;
                 /** @description Filter domains by registry status. Can be specified multiple times (union of all provided values). */
                 registry_statuses?: string[] | null;
-                /** @description Extra data to include in each result. `tags` populates the `tags` (user tags) and `status_tags` fields, which are otherwise null; filtering by `tag_ids` or `status_tags` alone does not populate them. */
+                /** @description Extra data to include in each result. `tags` populates the `tags` (user tags) and `status_tags` fields, which are otherwise null; filtering by `tag_ids` or `status_tags` alone does not populate them. `registrar_credential` populates the `registrar_credential` field for domains held at an external registrar. */
                 include?: components["schemas"]["DomainListIncludeField"][] | null;
             };
             header?: {
@@ -20965,7 +20992,7 @@ export interface operations {
     get_domain_v1_domains__domain_reference__get: {
         parameters: {
             query?: {
-                /** @description Extra data to include in the response. `tags` populates the `tags` and `status_tags` fields, which are otherwise null. `renewal_price` resolves the domain's renewal price. */
+                /** @description Extra data to include in the response. `tags` populates the `tags` and `status_tags` fields, which are otherwise null. `renewal_price` resolves the domain's renewal price. `registrar_credential` populates the `registrar_credential` field for domains held at an external registrar. */
                 include?: components["schemas"]["DomainIncludeField"][] | null;
             };
             header?: {