@opusdns/api 1.216.0 → 1.218.0

package/package.json

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

package/src/helpers/constants.ts

@@ -1,4 +1,5 @@
 import type {
+  AccountTypeFilterMode,
   AgreementType,
   AllocationMethodType,
   AssignablePublicRole,
@@ -145,6 +146,16 @@ import type {
   ZoneSortField,
 } from './schemas';
 
+export const ACCOUNT_TYPE_FILTER_MODE = {
+  MATCH_ANY: "match_any",
+  MATCH_NONE: "match_none",
+} as const satisfies Record<string, AccountTypeFilterMode>;
+
+export const ACCOUNT_TYPE_FILTER_MODE_VALUES = [
+  'match_any',
+  'match_none',
+] as const satisfies ReadonlyArray<AccountTypeFilterMode>;
+
 export const AGREEMENT_TYPE = {
   TERMS_AND_CONDITIONS: "terms_and_conditions",
   MASTER_SERVICE_AGREEMENT: "master_service_agreement",

package/src/helpers/requests.d.ts

@@ -597,7 +597,9 @@ export type GET_DomainsStatistics_Request = {
 export type GET_DomainsStatistics_Request_Query = GET_DomainsStatistics_Request['parameters']['query'];
 
 export type GET_DomainsSummary_Request = {
+  parameters: operations['get_domain_summary_v1_domains_summary_get']['parameters'];
 };
+export type GET_DomainsSummary_Request_Query = GET_DomainsSummary_Request['parameters']['query'];
 
 export type POST_DomainsTldSpecificAtByDomainReferenceWithdraw_Request = {
   parameters: operations['withdraw_domain_v1_domains_tld_specific_at__domain_reference__withdraw_post']['parameters'];

package/src/helpers/schemas.d.ts

@@ -1,5 +1,6 @@
 import { components } from '../schema';
 
+export type AccountTypeFilterMode = components['schemas']['AccountTypeFilterMode'];
 export type AggregationResult = components['schemas']['AggregationResult'];
 export type AggregationRow = components['schemas']['AggregationRow'];
 export type AggregationsContext = components['schemas']['AggregationsContext'];

package/src/openapi.yaml

@@ -13,6 +13,14 @@ components:
         - rfc3339
         type: string
   schemas:
+    AccountTypeFilterMode:
+      description: How an `account_type` filter applies; no `match_all`, since a domain
+        has exactly one account type.
+      enum:
+      - match_any
+      - match_none
+      title: AccountTypeFilterMode
+      type: string
     AggregationResult:
       properties:
         field:
@@ -23443,6 +23451,8 @@ components:
       properties:
         hostnames:
           description: Fully-qualified vanity NS hostnames, ordered by intended position.
+            A set may not have more hostnames than there are anycast address pairs
+            (each hostname gets its own IPs); a larger set is rejected with 400.
           items:
             type: string
           maxItems: 4
@@ -24958,7 +24968,7 @@ info:
     \n\n"
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2026-10-09-182429
+  version: 2026-10-09-220959
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -33599,10 +33609,10 @@ paths:
       - description: 'Filter domains by the type of the registry account they are
           held on: `ras` for domains on a registrar-abstraction (RAS) account synced
           from a connected external registrar, including those whose credential has
-          since been deleted (their `connected_account` is null); `ams` for domains
-          managed on a customer''s own registry accreditation; `default` for all others,
-          manually managed domains included (their accounts are typed `default`).
-          Can be specified multiple times (union of all provided values).'
+          since been deleted; `ams` for domains managed on a customer''s own registry
+          accreditation; `default` for all others, manually managed domains included
+          (their accounts are typed `default`). Can be specified multiple times (union
+          of all provided values).'
         in: query
         name: account_type
         required: false
@@ -33615,29 +33625,26 @@ paths:
           description: 'Filter domains by the type of the registry account they are
             held on: `ras` for domains on a registrar-abstraction (RAS) account synced
             from a connected external registrar, including those whose credential
-            has since been deleted (their `connected_account` is null); `ams` for
-            domains managed on a customer''s own registry accreditation; `default`
-            for all others, manually managed domains included (their accounts are
-            typed `default`). Can be specified multiple times (union of all provided
-            values).'
+            has since been deleted; `ams` for domains managed on a customer''s own
+            registry accreditation; `default` for all others, manually managed domains
+            included (their accounts are typed `default`). Can be specified multiple
+            times (union of all provided values).'
           title: Account Type
       - description: 'How to apply `account_type`: `match_any` keeps the domains on
           any of the listed types, `match_none` the domains on none of them (so `account_type=ras&account_type_mode=match_none`
-          lists every domain not on a RAS account, and listing every type returns
-          nothing). Has no effect without `account_type`. `match_all` is refused:
-          a domain has exactly one account type.'
+          keeps every domain not on a RAS account, and naming every type keeps none).
+          Has no effect without `account_type`.'
         in: query
         name: account_type_mode
         required: false
         schema:
-          $ref: '#/components/schemas/TagFilterMode'
+          $ref: '#/components/schemas/AccountTypeFilterMode'
           default: match_any
           description: 'How to apply `account_type`: `match_any` keeps the domains
             on any of the listed types, `match_none` the domains on none of them (so
-            `account_type=ras&account_type_mode=match_none` lists every domain not
-            on a RAS account, and listing every type returns nothing). Has no effect
-            without `account_type`. `match_all` is refused: a domain has exactly one
-            account type.'
+            `account_type=ras&account_type_mode=match_none` keeps every domain not
+            on a RAS account, and naming every type keeps none). Has no effect without
+            `account_type`.'
       - 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. `connected_account`
@@ -34091,9 +34098,54 @@ paths:
         by status, status tag, TLD,
 
         registry account type and expiration timeframe. Only `by_organization` includes
-        sub-organizations.'
+        sub-organizations.
+
+        With `account_type`, every count covers only the domains that filter keeps,
+        so a sub-organization
+
+        whose domains all fall outside it is left out of `by_organization`, as one
+        without domains always is.'
       operationId: get_domain_summary_v1_domains_summary_get
       parameters:
+      - description: 'Filter domains by the type of the registry account they are
+          held on: `ras` for domains on a registrar-abstraction (RAS) account synced
+          from a connected external registrar, including those whose credential has
+          since been deleted; `ams` for domains managed on a customer''s own registry
+          accreditation; `default` for all others, manually managed domains included
+          (their accounts are typed `default`). Can be specified multiple times (union
+          of all provided values).'
+        in: query
+        name: account_type
+        required: false
+        schema:
+          anyOf:
+          - items:
+              $ref: '#/components/schemas/ConnectedAccountType'
+            type: array
+          - type: 'null'
+          description: 'Filter domains by the type of the registry account they are
+            held on: `ras` for domains on a registrar-abstraction (RAS) account synced
+            from a connected external registrar, including those whose credential
+            has since been deleted; `ams` for domains managed on a customer''s own
+            registry accreditation; `default` for all others, manually managed domains
+            included (their accounts are typed `default`). Can be specified multiple
+            times (union of all provided values).'
+          title: Account Type
+      - description: 'How to apply `account_type`: `match_any` keeps the domains on
+          any of the listed types, `match_none` the domains on none of them (so `account_type=ras&account_type_mode=match_none`
+          keeps every domain not on a RAS account, and naming every type keeps none).
+          Has no effect without `account_type`.'
+        in: query
+        name: account_type_mode
+        required: false
+        schema:
+          $ref: '#/components/schemas/AccountTypeFilterMode'
+          default: match_any
+          description: 'How to apply `account_type`: `match_any` keeps the domains
+            on any of the listed types, `match_none` the domains on none of them (so
+            `account_type=ras&account_type_mode=match_none` keeps every domain not
+            on a RAS account, and naming every type keeps none). Has no effect without
+            `account_type`.'
       - $ref: '#/components/parameters/DatetimeFormatHeader'
       responses:
         '200':
@@ -43197,15 +43249,14 @@ paths:
         content:
           application/json:
             examples:
-              three_nameservers:
-                description: A set with three branded hostnames under a different
-                  parent domain.
-                summary: Three-nameserver set
+              other_parent:
+                description: A set with two branded hostnames under a different parent
+                  domain.
+                summary: Set under another parent domain
                 value:
                   hostnames:
                   - ns1.acme.example
                   - ns2.acme.example
-                  - ns3.acme.example
                   name: Acme nameservers
                   parent_domain_name: acme.example
                   soa_rname: hostmaster.acme.example

package/src/schema.d.ts

@@ -1213,6 +1213,8 @@ export interface paths {
          * Get domain summary
          * @description Retrieves a summary of your organization's domains, with counts by status, status tag, TLD,
          *     registry account type and expiration timeframe. Only `by_organization` includes sub-organizations.
+         *     With `account_type`, every count covers only the domains that filter keeps, so a sub-organization
+         *     whose domains all fall outside it is left out of `by_organization`, as one without domains always is.
          */
         get: operations["get_domain_summary_v1_domains_summary_get"];
         put?: never;
@@ -3293,6 +3295,12 @@ export interface paths {
 export type webhooks = Record<string, never>;
 export interface components {
     schemas: {
+        /**
+         * AccountTypeFilterMode
+         * @description How an `account_type` filter applies; no `match_all`, since a domain has exactly one account type.
+         * @enum {string}
+         */
+        AccountTypeFilterMode: "match_any" | "match_none";
         /** AggregationResult */
         AggregationResult: {
             /** Field */
@@ -19543,7 +19551,7 @@ export interface components {
         VanityNameserverSetCreate: {
             /**
              * Hostnames
-             * @description Fully-qualified vanity NS hostnames, ordered by intended position.
+             * @description Fully-qualified vanity NS hostnames, ordered by intended position. A set may not have more hostnames than there are anycast address pairs (each hostname gets its own IPs); a larger set is rejected with 400.
              */
             hostnames: string[];
             /**
@@ -26815,10 +26823,10 @@ export interface operations {
                 registrar_credential_id?: TypeId<"registrar_credential">[] | null;
                 /** @description Filter domains held at an external registrar by that registrar. Can be specified multiple times (union of all provided values); combined with `registrar_credential_id`, both must match. Matches exactly the domains whose `connected_account` field carries the registrar, so domains OpusDNS sponsors never match. */
                 registrar?: components["schemas"]["Registrar"][] | null;
-                /** @description Filter domains by the type of the registry account they are held on: `ras` for domains on a registrar-abstraction (RAS) account synced from a connected external registrar, including those whose credential has since been deleted (their `connected_account` is null); `ams` for domains managed on a customer's own registry accreditation; `default` for all others, manually managed domains included (their accounts are typed `default`). Can be specified multiple times (union of all provided values). */
+                /** @description Filter domains by the type of the registry account they are held on: `ras` for domains on a registrar-abstraction (RAS) account synced from a connected external registrar, including those whose credential has since been deleted; `ams` for domains managed on a customer's own registry accreditation; `default` for all others, manually managed domains included (their accounts are typed `default`). Can be specified multiple times (union of all provided values). */
                 account_type?: components["schemas"]["ConnectedAccountType"][] | null;
-                /** @description How to apply `account_type`: `match_any` keeps the domains on any of the listed types, `match_none` the domains on none of them (so `account_type=ras&account_type_mode=match_none` lists every domain not on a RAS account, and listing every type returns nothing). Has no effect without `account_type`. `match_all` is refused: a domain has exactly one account type. */
-                account_type_mode?: components["schemas"]["TagFilterMode"];
+                /** @description How to apply `account_type`: `match_any` keeps the domains on any of the listed types, `match_none` the domains on none of them (so `account_type=ras&account_type_mode=match_none` keeps every domain not on a RAS account, and naming every type keeps none). Has no effect without `account_type`. */
+                account_type_mode?: components["schemas"]["AccountTypeFilterMode"];
                 /** @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. `connected_account` populates the `connected_account` field for domains held at an external registrar. */
                 include?: components["schemas"]["DomainListIncludeField"][] | null;
             };
@@ -27111,7 +27119,12 @@ export interface operations {
     };
     get_domain_summary_v1_domains_summary_get: {
         parameters: {
-            query?: never;
+            query?: {
+                /** @description Filter domains by the type of the registry account they are held on: `ras` for domains on a registrar-abstraction (RAS) account synced from a connected external registrar, including those whose credential has since been deleted; `ams` for domains managed on a customer's own registry accreditation; `default` for all others, manually managed domains included (their accounts are typed `default`). Can be specified multiple times (union of all provided values). */
+                account_type?: components["schemas"]["ConnectedAccountType"][] | null;
+                /** @description How to apply `account_type`: `match_any` keeps the domains on any of the listed types, `match_none` the domains on none of them (so `account_type=ras&account_type_mode=match_none` keeps every domain not on a RAS account, and naming every type keeps none). Has no effect without `account_type`. */
+                account_type_mode?: components["schemas"]["AccountTypeFilterMode"];
+            };
             header?: {
                 /**
                  * @description Accepted for backwards compatibility; has no effect. Response datetimes are always normalized to UTC and serialized as RFC 3339 with a `Z` suffix, whether or not this header is sent.