api error interface

src/interfaces/api_error.ts

@@ -0,0 +1,19 @@
+/**
+ * Interface representing the structure of an API error.
+ */
+export interface ApiError {
+	/**
+	 * The error message.
+	 */
+	message: string;
+
+	/**
+	 * The error code representing the type of API error.
+	 */
+	code: number;
+
+	/**
+	 * Additional details about the error (optional).
+	 */
+	details?: any;
+}

src/interfaces/index.ts

@@ -1,4 +1,5 @@
 export { AuthData } from "./auth_data.js";
+export { ApiError } from "./api_error.js";
 export { AuthError } from "./auth_error.js";
 export { Branch } from "./branch.js";
 export { BulkResult } from "./bulk_result.js";

src/models/api_error.ts

@@ -1,8 +1,27 @@
-export class ApiError extends Error {
+import type { ApiError as ApiErrorInterface } from "../interfaces/api_error.js";
+
+/**
+ * Represents an API error with a specific code and optional details.
+ */
+export class ApiError extends Error implements ApiErrorInterface {
+	/**
+	 * The error code representing the type of API error.
+	 */
 	code: number;
+
+	/**
+	 * Additional details about the error (optional).
+	 */
 	details?: any;
 
-	constructor(message: string, code: number, details: any) {
+	/**
+	 * Creates an instance of ApiError.
+	 *
+	 * @param {string} message - The error message.
+	 * @param {number} code - The error code.
+	 * @param {any} [details] - Additional details about the error.
+	 */
+	constructor(message: string, code: number, details?: any) {
 		super(message);
 		this.code = code;
 		this.details = details;