@opusdns/api 0.306.0 → 0.307.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": "^0.19.0"
4
4
  },
5
5
  "name": "@opusdns/api",
6
- "version": "0.306.0",
6
+ "version": "0.307.0",
7
7
  "description": "TypeScript types for the OpusDNS OpenAPI specification",
8
8
  "main": "./src/index.ts",
9
9
  "module": "./src/index.ts",
@@ -27938,6 +27938,56 @@ export const KEY_JOB_DOMAIN_NAME: keyof Job = 'domain_name';
27938
27938
  * @see {@link KEYS_JOB} - Array of all keys for this type
27939
27939
  */
27940
27940
  export const KEY_JOB_ERROR_CLASS: keyof Job = 'error_class';
27941
+ /**
27942
+ * Error Code
27943
+ *
27944
+ * Stable semantic error code propagated verbatim from the failing upstream service (e.g. 'ERROR_DOMAIN_TRANSFER_INVALID_AUTH_CODE'). Suitable for i18n / per-error UI branching. Null when the job did not fail or the upstream error did not carry a code.
27945
+ *
27946
+ *
27947
+ *
27948
+ * @remarks
27949
+ * This key constant provides type-safe access to the `error_code` property of Job objects.
27950
+ * Use this constant when you need to access properties dynamically or ensure type safety.
27951
+ *
27952
+ * @example
27953
+ * ```typescript
27954
+ * // Direct property access
27955
+ * const value = job[KEY_JOB_ERROR_CODE];
27956
+ *
27957
+ * // Dynamic property access
27958
+ * const propertyName = KEY_JOB_ERROR_CODE;
27959
+ * const value = job[propertyName];
27960
+ * ```
27961
+ *
27962
+ * @see {@link Job} - The TypeScript type definition
27963
+ * @see {@link KEYS_JOB} - Array of all keys for this type
27964
+ */
27965
+ export const KEY_JOB_ERROR_CODE: keyof Job = 'error_code';
27966
+ /**
27967
+ * Error Details
27968
+ *
27969
+ * Full upstream problem-details payload (RFC 9457) preserved verbatim — e.g. type/title/status/code/detail plus service-specific extras like domain_name, reason. Null when the failure didn't originate from a typed upstream response.
27970
+ *
27971
+ *
27972
+ *
27973
+ * @remarks
27974
+ * This key constant provides type-safe access to the `error_details` property of Job objects.
27975
+ * Use this constant when you need to access properties dynamically or ensure type safety.
27976
+ *
27977
+ * @example
27978
+ * ```typescript
27979
+ * // Direct property access
27980
+ * const value = job[KEY_JOB_ERROR_DETAILS];
27981
+ *
27982
+ * // Dynamic property access
27983
+ * const propertyName = KEY_JOB_ERROR_DETAILS;
27984
+ * const value = job[propertyName];
27985
+ * ```
27986
+ *
27987
+ * @see {@link Job} - The TypeScript type definition
27988
+ * @see {@link KEYS_JOB} - Array of all keys for this type
27989
+ */
27990
+ export const KEY_JOB_ERROR_DETAILS: keyof Job = 'error_details';
27941
27991
  /**
27942
27992
  * Error Message
27943
27993
  *
@@ -28217,6 +28267,8 @@ export const KEYS_JOB = [
28217
28267
  KEY_JOB_DISPLAY,
28218
28268
  KEY_JOB_DOMAIN_NAME,
28219
28269
  KEY_JOB_ERROR_CLASS,
28270
+ KEY_JOB_ERROR_CODE,
28271
+ KEY_JOB_ERROR_DETAILS,
28220
28272
  KEY_JOB_ERROR_MESSAGE,
28221
28273
  KEY_JOB_FINISHED_AT,
28222
28274
  KEY_JOB_JOB_ID,
package/src/openapi.yaml CHANGED
@@ -6720,6 +6720,25 @@ components:
6720
6720
  - type: 'null'
6721
6721
  description: Error type if the job failed (e.g., ValidationError, TimeoutError)
6722
6722
  title: Error Class
6723
+ error_code:
6724
+ anyOf:
6725
+ - type: string
6726
+ - type: 'null'
6727
+ description: Stable semantic error code propagated verbatim from the failing
6728
+ upstream service (e.g. 'ERROR_DOMAIN_TRANSFER_INVALID_AUTH_CODE'). Suitable
6729
+ for i18n / per-error UI branching. Null when the job did not fail or the
6730
+ upstream error did not carry a code.
6731
+ title: Error Code
6732
+ error_details:
6733
+ anyOf:
6734
+ - additionalProperties: true
6735
+ type: object
6736
+ - type: 'null'
6737
+ description: "Full upstream problem-details payload (RFC 9457) preserved\
6738
+ \ verbatim \u2014 e.g. type/title/status/code/detail plus service-specific\
6739
+ \ extras like domain_name, reason. Null when the failure didn't originate\
6740
+ \ from a typed upstream response."
6741
+ title: Error Details
6723
6742
  error_message:
6724
6743
  anyOf:
6725
6744
  - type: string
@@ -11486,7 +11505,7 @@ info:
11486
11505
  \n\n"
11487
11506
  summary: OpusDNS - your gateway to a seamless domain management experience.
11488
11507
  title: OpusDNS API
11489
- version: 2026-05-18-161414
11508
+ version: 2026-05-18-215758
11490
11509
  x-logo:
11491
11510
  altText: OpusDNS API Reference
11492
11511
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -22219,8 +22238,18 @@ paths:
22219
22238
  created_on: '2025-01-15T10:00:00Z'
22220
22239
  display: Update Domain 'flaky-domain.com'
22221
22240
  domain_name: flaky-domain.com
22222
- error_class: RegistryError
22223
- error_message: Registry unavailable after 5 retry attempts
22241
+ error_class: DomainsClientError
22242
+ error_code: ERROR_DOMAIN_TRANSFER_INVALID_AUTH_CODE
22243
+ error_details:
22244
+ code: ERROR_DOMAIN_TRANSFER_INVALID_AUTH_CODE
22245
+ detail: There was an error transferring the domain
22246
+ domain_name: flaky-domain.com
22247
+ reason: Domain transfer failed, invalid auth code provided
22248
+ status: 403
22249
+ title: Domain Transfer Error
22250
+ type: domain-transfer-invalid-auth
22251
+ error_message: 'Domains service error: There was an error transferring
22252
+ the domain'
22224
22253
  finished_at: '2025-01-15T10:15:30Z'
22225
22254
  job_id: job_01h45ytscbebyvny4gc8cr8ma7
22226
22255
  operation: update
package/src/schema.d.ts CHANGED
@@ -6954,6 +6954,18 @@ export interface components {
6954
6954
  * @description Error type if the job failed (e.g., ValidationError, TimeoutError)
6955
6955
  */
6956
6956
  error_class?: string | null;
6957
+ /**
6958
+ * Error Code
6959
+ * @description Stable semantic error code propagated verbatim from the failing upstream service (e.g. 'ERROR_DOMAIN_TRANSFER_INVALID_AUTH_CODE'). Suitable for i18n / per-error UI branching. Null when the job did not fail or the upstream error did not carry a code.
6960
+ */
6961
+ error_code?: string | null;
6962
+ /**
6963
+ * Error Details
6964
+ * @description Full upstream problem-details payload (RFC 9457) preserved verbatim — e.g. type/title/status/code/detail plus service-specific extras like domain_name, reason. Null when the failure didn't originate from a typed upstream response.
6965
+ */
6966
+ error_details?: {
6967
+ [key: string]: unknown;
6968
+ } | null;
6957
6969
  /**
6958
6970
  * Error Message
6959
6971
  * @description Detailed error message if the job failed