@opusdns/api 1.91.0 → 1.92.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "@opusdns/api-spec-ts-generator": "^1.2.0"
4
4
  },
5
5
  "name": "@opusdns/api",
6
- "version": "1.91.0",
6
+ "version": "1.92.0",
7
7
  "description": "TypeScript types for the OpusDNS OpenAPI specification",
8
8
  "main": "./src/index.ts",
9
9
  "module": "./src/index.ts",
@@ -112,6 +112,7 @@ import type {
112
112
  DnsZoneUpdateWorkerPayload,
113
113
  DnsZoneVanitySetUpdateRes,
114
114
  DomainAvailability,
115
+ DomainAvailabilityError,
115
116
  DomainAvailabilityMeta,
116
117
  DomainAvailabilityRequest,
117
118
  DomainCheck,
@@ -1804,13 +1805,23 @@ export const KEYS_DNS_ZONE_VANITY_SET_UPDATE_RES = [
1804
1805
  ] as const satisfies (keyof DnsZoneVanitySetUpdateRes)[];
1805
1806
 
1806
1807
  export const KEY_DOMAIN_AVAILABILITY_DOMAIN = 'domain' satisfies keyof DomainAvailability;
1808
+ export const KEY_DOMAIN_AVAILABILITY_ERROR = 'error' satisfies keyof DomainAvailability;
1807
1809
  export const KEY_DOMAIN_AVAILABILITY_STATUS = 'status' satisfies keyof DomainAvailability;
1808
1810
 
1809
1811
  export const KEYS_DOMAIN_AVAILABILITY = [
1810
1812
  KEY_DOMAIN_AVAILABILITY_DOMAIN,
1813
+ KEY_DOMAIN_AVAILABILITY_ERROR,
1811
1814
  KEY_DOMAIN_AVAILABILITY_STATUS,
1812
1815
  ] as const satisfies (keyof DomainAvailability)[];
1813
1816
 
1817
+ export const KEY_DOMAIN_AVAILABILITY_ERROR_MESSAGE = 'message' satisfies keyof DomainAvailabilityError;
1818
+ export const KEY_DOMAIN_AVAILABILITY_ERROR_TYPE = 'type' satisfies keyof DomainAvailabilityError;
1819
+
1820
+ export const KEYS_DOMAIN_AVAILABILITY_ERROR = [
1821
+ KEY_DOMAIN_AVAILABILITY_ERROR_MESSAGE,
1822
+ KEY_DOMAIN_AVAILABILITY_ERROR_TYPE,
1823
+ ] as const satisfies (keyof DomainAvailabilityError)[];
1824
+
1814
1825
  export const KEY_DOMAIN_AVAILABILITY_META_PROCESSING_TIME_MS = 'processing_time_ms' satisfies keyof DomainAvailabilityMeta;
1815
1826
  export const KEY_DOMAIN_AVAILABILITY_META_TOTAL = 'total' satisfies keyof DomainAvailabilityMeta;
1816
1827
 
@@ -146,6 +146,7 @@ export type DnssecRecordType = components['schemas']['DnssecRecordType'];
146
146
  export type DnssecStatus = components['schemas']['DnssecStatus'];
147
147
  export type DomainAttributeKey = components['schemas']['DomainAttributeKey'];
148
148
  export type DomainAvailability = components['schemas']['DomainAvailability'];
149
+ export type DomainAvailabilityError = components['schemas']['DomainAvailabilityError'];
149
150
  export type DomainAvailabilityMeta = components['schemas']['DomainAvailabilityMeta'];
150
151
  export type DomainAvailabilityRequest = components['schemas']['DomainAvailabilityRequest'];
151
152
  export type DomainAvailabilityStatus = components['schemas']['DomainAvailabilityStatus'];
package/src/openapi.yaml CHANGED
@@ -3647,6 +3647,12 @@ components:
3647
3647
  domain:
3648
3648
  title: Domain
3649
3649
  type: string
3650
+ error:
3651
+ anyOf:
3652
+ - $ref: '#/components/schemas/DomainAvailabilityError'
3653
+ - type: 'null'
3654
+ description: Error details when status is 'error', e.g. why a domain is
3655
+ invalid
3650
3656
  status:
3651
3657
  $ref: '#/components/schemas/DomainAvailabilityStatus'
3652
3658
  required:
@@ -3654,6 +3660,21 @@ components:
3654
3660
  - status
3655
3661
  title: DomainAvailability
3656
3662
  type: object
3663
+ DomainAvailabilityError:
3664
+ properties:
3665
+ message:
3666
+ description: Human-readable error message
3667
+ title: Message
3668
+ type: string
3669
+ type:
3670
+ description: Error type identifier, e.g. validation_error or check_error
3671
+ title: Type
3672
+ type: string
3673
+ required:
3674
+ - type
3675
+ - message
3676
+ title: DomainAvailabilityError
3677
+ type: object
3657
3678
  DomainAvailabilityMeta:
3658
3679
  properties:
3659
3680
  processing_time_ms:
@@ -3671,6 +3692,7 @@ components:
3671
3692
  properties:
3672
3693
  domains:
3673
3694
  items:
3695
+ maxLength: 1024
3674
3696
  type: string
3675
3697
  maxItems: 1000
3676
3698
  minItems: 1
@@ -14954,7 +14976,7 @@ info:
14954
14976
  \n\n"
14955
14977
  summary: OpusDNS - your gateway to a seamless domain management experience.
14956
14978
  title: OpusDNS API
14957
- version: 2026-07-30-170548
14979
+ version: 2026-07-31-115412
14958
14980
  x-logo:
14959
14981
  altText: OpusDNS API Reference
14960
14982
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -16930,7 +16952,9 @@ paths:
16930
16952
  - authentication
16931
16953
  /v1/availability:
16932
16954
  get:
16933
- description: Check the availability of one or more domains.
16955
+ description: Check the availability of one or more domains. Invalid domains
16956
+ are reported per domain (status 'error' with error details) instead of failing
16957
+ the whole request.
16934
16958
  operationId: bulk_availability_v1_availability_get
16935
16959
  parameters:
16936
16960
  - description: '
@@ -16954,6 +16978,7 @@ paths:
16954
16978
 
16955
16979
  '
16956
16980
  items:
16981
+ maxLength: 1024
16957
16982
  type: string
16958
16983
  maxItems: 50
16959
16984
  title: Domains
@@ -17018,6 +17043,7 @@ paths:
17018
17043
 
17019
17044
  '
17020
17045
  items:
17046
+ maxLength: 1024
17021
17047
  type: string
17022
17048
  maxItems: 1000
17023
17049
  title: Domains
package/src/schema.d.ts CHANGED
@@ -301,7 +301,7 @@ export interface paths {
301
301
  };
302
302
  /**
303
303
  * Check domain availability
304
- * @description Check the availability of one or more domains.
304
+ * @description Check the availability of one or more domains. Invalid domains are reported per domain (status 'error' with error details) instead of failing the whole request.
305
305
  */
306
306
  get: operations["bulk_availability_v1_availability_get"];
307
307
  put?: never;
@@ -5271,8 +5271,23 @@ export interface components {
5271
5271
  DomainAvailability: {
5272
5272
  /** Domain */
5273
5273
  domain: string;
5274
+ /** @description Error details when status is 'error', e.g. why a domain is invalid */
5275
+ error?: components["schemas"]["DomainAvailabilityError"] | null;
5274
5276
  status: components["schemas"]["DomainAvailabilityStatus"];
5275
5277
  };
5278
+ /** DomainAvailabilityError */
5279
+ DomainAvailabilityError: {
5280
+ /**
5281
+ * Message
5282
+ * @description Human-readable error message
5283
+ */
5284
+ message: string;
5285
+ /**
5286
+ * Type
5287
+ * @description Error type identifier, e.g. validation_error or check_error
5288
+ */
5289
+ type: string;
5290
+ };
5276
5291
  /** DomainAvailabilityMeta */
5277
5292
  DomainAvailabilityMeta: {
5278
5293
  /** Processing Time Ms */