@magentrix-corp/magentrix-cli 1.3.16 → 1.3.17

package/utils/magentrix/api/retrieveEntity.js

@@ -1,86 +1,86 @@
-import { fetchMagentrix } from "../fetch.js";
-
-/**
- * Lists all entities available from the Magentrix API.
- *
- * Makes an authenticated GET request to `/api/3.0/entity` to retrieve metadata
- * about all available entities (objects) in the Magentrix instance.
- *
- * Handles and throws both network errors and API-level errors with detailed messages.
- *
- * @async
- * @param {string} instanceUrl - The base URL of the Magentrix instance.
- * @param {string} token - The OAuth or access token for authentication.
- * @returns {Promise<Object>} Parsed JSON response with entities metadata.
- * @throws {Error} If required arguments are missing, network error occurs,
- *         HTTP error is returned, or API-level errors are found in the response.
- */
-export const listEntities = async (instanceUrl, token) => {
-    // --- Validate required input parameters ---
-    if (!instanceUrl || !token) {
-        throw new Error('Missing required Magentrix instanceUrl or token');
-    }
-
-    const data = await fetchMagentrix({
-        instanceUrl,
-        token,
-        path: '/api/3.0/entity',
-        method: "GET"
-    })
-
-    return data;
-};
-
-/**
- * Retrieves a specific ActiveClass or ActivePage entity by ID from Magentrix via the REST API.
- *
- * @async
- * @function retrieveEntity
- * @param {string} instanceUrl - The base URL of the Magentrix instance (e.g. "https://your.magentrix.com").
- * @param {string} token - The OAuth2 bearer token for authentication.
- * @param {string} entityName - The Magentrix entity type. Allowed: "ActiveClass" or "ActivePage" (case-insensitive).
- * @param {string} recordId - The unique Magentrix record ID to retrieve.
- * @returns {Promise<Object>} The API response object containing the record data.
- * @throws {Error} If required parameters are missing, entityName is invalid, or recordId is not provided.
- *
- * @example
- * const record = await retrieveEntity(
- *   "https://your.magentrix.com",
- *   "yourToken",
- *   "ActiveClass",
- *   "06bdc45e-8222-44f5-9ed2-40f5a7bc6cb3"
- * );
- */
-export const retrieveEntity = async (instanceUrl, token, entityName, recordId) => {
-    // --- Validate required parameters ---
-    if (!instanceUrl || typeof instanceUrl !== 'string') {
-        throw new Error('Missing or invalid Magentrix instanceUrl');
-    }
-    if (!token || typeof token !== 'string') {
-        throw new Error('Missing or invalid Magentrix token');
-    }
-    if (!entityName || typeof entityName !== 'string') {
-        throw new Error("Missing or invalid 'entityName' (must be 'ActiveClass' or 'ActivePage')");
-    }
-    if (!recordId || typeof recordId !== 'string') {
-        throw new Error("Missing or invalid 'recordId' (must be a Magentrix record GUID string)");
-    }
-
-    // --- Validate entity type ---
-    const allowedEntities = ['activeclass', 'activepage'];
-    const entity = entityName.trim().toLowerCase();
-    if (!allowedEntities.includes(entity)) {
-        throw new Error("Invalid 'entityName'. Allowed: 'ActiveClass' or 'ActivePage'");
-    }
-
-    // --- Make GET request to Magentrix API ---
-    const response = await fetchMagentrix({
-        instanceUrl,
-        token,
-        path: `/api/3.0/entity/${entity}/${recordId}`,
-        method: "GET",
-        returnErrorObject: true
-    });
-
-    return response;
-};
+import { fetchMagentrix } from "../fetch.js";
+
+/**
+ * Lists all entities available from the Magentrix API.
+ *
+ * Makes an authenticated GET request to `/api/3.0/entity` to retrieve metadata
+ * about all available entities (objects) in the Magentrix instance.
+ *
+ * Handles and throws both network errors and API-level errors with detailed messages.
+ *
+ * @async
+ * @param {string} instanceUrl - The base URL of the Magentrix instance.
+ * @param {string} token - The OAuth or access token for authentication.
+ * @returns {Promise<Object>} Parsed JSON response with entities metadata.
+ * @throws {Error} If required arguments are missing, network error occurs,
+ *         HTTP error is returned, or API-level errors are found in the response.
+ */
+export const listEntities = async (instanceUrl, token) => {
+    // --- Validate required input parameters ---
+    if (!instanceUrl || !token) {
+        throw new Error('Missing required Magentrix instanceUrl or token');
+    }
+
+    const data = await fetchMagentrix({
+        instanceUrl,
+        token,
+        path: '/api/3.0/entity',
+        method: "GET"
+    })
+
+    return data;
+};
+
+/**
+ * Retrieves a specific ActiveClass or ActivePage entity by ID from Magentrix via the REST API.
+ *
+ * @async
+ * @function retrieveEntity
+ * @param {string} instanceUrl - The base URL of the Magentrix instance (e.g. "https://your.magentrix.com").
+ * @param {string} token - The OAuth2 bearer token for authentication.
+ * @param {string} entityName - The Magentrix entity type. Allowed: "ActiveClass" or "ActivePage" (case-insensitive).
+ * @param {string} recordId - The unique Magentrix record ID to retrieve.
+ * @returns {Promise<Object>} The API response object containing the record data.
+ * @throws {Error} If required parameters are missing, entityName is invalid, or recordId is not provided.
+ *
+ * @example
+ * const record = await retrieveEntity(
+ *   "https://your.magentrix.com",
+ *   "yourToken",
+ *   "ActiveClass",
+ *   "06bdc45e-8222-44f5-9ed2-40f5a7bc6cb3"
+ * );
+ */
+export const retrieveEntity = async (instanceUrl, token, entityName, recordId) => {
+    // --- Validate required parameters ---
+    if (!instanceUrl || typeof instanceUrl !== 'string') {
+        throw new Error('Missing or invalid Magentrix instanceUrl');
+    }
+    if (!token || typeof token !== 'string') {
+        throw new Error('Missing or invalid Magentrix token');
+    }
+    if (!entityName || typeof entityName !== 'string') {
+        throw new Error("Missing or invalid 'entityName' (must be 'ActiveClass' or 'ActivePage')");
+    }
+    if (!recordId || typeof recordId !== 'string') {
+        throw new Error("Missing or invalid 'recordId' (must be a Magentrix record GUID string)");
+    }
+
+    // --- Validate entity type ---
+    const allowedEntities = ['activeclass', 'activepage'];
+    const entity = entityName.trim().toLowerCase();
+    if (!allowedEntities.includes(entity)) {
+        throw new Error("Invalid 'entityName'. Allowed: 'ActiveClass' or 'ActivePage'");
+    }
+
+    // --- Make GET request to Magentrix API ---
+    const response = await fetchMagentrix({
+        instanceUrl,
+        token,
+        path: `/api/3.0/entity/${entity}/${recordId}`,
+        method: "GET",
+        returnErrorObject: true
+    });
+
+    return response;
+};

package/utils/magentrix/api/updateEntity.js

@@ -1,66 +1,66 @@
-import { fetchMagentrix } from "../fetch.js";
-
-/**
- * Updates an existing ActiveClass or ActivePage entity in Magentrix via the REST API.
- *
- * @async
- * @function updateEntity
- * @param {string} instanceUrl - The base URL of the Magentrix instance (e.g. "https://your.magentrix.com").
- * @param {string} token - The OAuth2 bearer token for authentication.
- * @param {string} entityName - The Magentrix entity type. Allowed: "ActiveClass" or "ActivePage" (case-insensitive).
- * @param {string} recordId - The unique Magentrix record ID to update.
- * @param {Object} data - The fields to update on the entity. Provide any subset of updatable fields (e.g. Name, Description, Body, Type, etc).
- * @returns {Promise<Object>} The API response object containing updated record data.
- * @throws {Error} If required parameters are missing, entityName is invalid, recordId is not provided, or data is not an object.
- *
- * @example
- * const updated = await updateEntity(
- *   "https://your.magentrix.com",
- *   "yourToken",
- *   "ActiveClass",
- *   "06bdc45e-8222-44f5-9ed2-40f5a7bc6cb3",
- *   { Name: "RenamedClass", Description: "Updated" }
- * );
- */
-export const updateEntity = async (instanceUrl, token, entityName, recordId, data) => {
-    // --- Validate required parameters ---
-    if (!instanceUrl || typeof instanceUrl !== 'string') {
-        throw new Error('Missing or invalid Magentrix instanceUrl');
-    }
-    if (!token || typeof token !== 'string') {
-        throw new Error('Missing or invalid Magentrix token');
-    }
-    if (!entityName || typeof entityName !== 'string') {
-        throw new Error("Missing or invalid 'entityName' (must be 'ActiveClass' or 'ActivePage')");
-    }
-    if (!recordId || typeof recordId !== 'string') {
-        throw new Error("Missing or invalid 'recordId' (must be a Magentrix record GUID string)");
-    }
-
-    // --- Validate entity type ---
-    const allowedEntities = ['activeclass', 'activepage'];
-    const entity = entityName.trim().toLowerCase();
-    if (!allowedEntities.includes(entity)) {
-        throw new Error("Invalid 'entityName'. Allowed: 'ActiveClass' or 'ActivePage'");
-    }
-
-    // --- Validate update data ---
-    if (!data || typeof data !== 'object' || Array.isArray(data)) {
-        throw new Error('Missing or invalid data object for entity update');
-    }
-    if (Object.keys(data).length === 0) {
-        throw new Error('No fields provided to update');
-    }
-
-    // --- Make PATCH request to Magentrix API ---
-    const response = await fetchMagentrix({
-        instanceUrl,
-        token,
-        path: `/api/3.0/entity/${entity}/${recordId}`,
-        method: "PATCH",
-        body: data,
-        returnErrorObject: true
-    });
-
-    return response;
-};
+import { fetchMagentrix } from "../fetch.js";
+
+/**
+ * Updates an existing ActiveClass or ActivePage entity in Magentrix via the REST API.
+ *
+ * @async
+ * @function updateEntity
+ * @param {string} instanceUrl - The base URL of the Magentrix instance (e.g. "https://your.magentrix.com").
+ * @param {string} token - The OAuth2 bearer token for authentication.
+ * @param {string} entityName - The Magentrix entity type. Allowed: "ActiveClass" or "ActivePage" (case-insensitive).
+ * @param {string} recordId - The unique Magentrix record ID to update.
+ * @param {Object} data - The fields to update on the entity. Provide any subset of updatable fields (e.g. Name, Description, Body, Type, etc).
+ * @returns {Promise<Object>} The API response object containing updated record data.
+ * @throws {Error} If required parameters are missing, entityName is invalid, recordId is not provided, or data is not an object.
+ *
+ * @example
+ * const updated = await updateEntity(
+ *   "https://your.magentrix.com",
+ *   "yourToken",
+ *   "ActiveClass",
+ *   "06bdc45e-8222-44f5-9ed2-40f5a7bc6cb3",
+ *   { Name: "RenamedClass", Description: "Updated" }
+ * );
+ */
+export const updateEntity = async (instanceUrl, token, entityName, recordId, data) => {
+    // --- Validate required parameters ---
+    if (!instanceUrl || typeof instanceUrl !== 'string') {
+        throw new Error('Missing or invalid Magentrix instanceUrl');
+    }
+    if (!token || typeof token !== 'string') {
+        throw new Error('Missing or invalid Magentrix token');
+    }
+    if (!entityName || typeof entityName !== 'string') {
+        throw new Error("Missing or invalid 'entityName' (must be 'ActiveClass' or 'ActivePage')");
+    }
+    if (!recordId || typeof recordId !== 'string') {
+        throw new Error("Missing or invalid 'recordId' (must be a Magentrix record GUID string)");
+    }
+
+    // --- Validate entity type ---
+    const allowedEntities = ['activeclass', 'activepage'];
+    const entity = entityName.trim().toLowerCase();
+    if (!allowedEntities.includes(entity)) {
+        throw new Error("Invalid 'entityName'. Allowed: 'ActiveClass' or 'ActivePage'");
+    }
+
+    // --- Validate update data ---
+    if (!data || typeof data !== 'object' || Array.isArray(data)) {
+        throw new Error('Missing or invalid data object for entity update');
+    }
+    if (Object.keys(data).length === 0) {
+        throw new Error('No fields provided to update');
+    }
+
+    // --- Make PATCH request to Magentrix API ---
+    const response = await fetchMagentrix({
+        instanceUrl,
+        token,
+        path: `/api/3.0/entity/${entity}/${recordId}`,
+        method: "PATCH",
+        body: data,
+        returnErrorObject: true
+    });
+
+    return response;
+};

package/utils/magentrix/fetch.js

@@ -1,168 +1,168 @@
-import debug from '../debug.js';
-
-/**
- * Checks if a request body should be JSON-stringified.
- * Excludes FormData, Blob, ArrayBuffer, URLSearchParams, and typed arrays.
- * @param {any} body
- * @returns {boolean}
- */
-function isJsonBody(body) {
-    return (
-        typeof body === 'object' &&
-        body !== null &&
-        !(body instanceof FormData) &&
-        !(body instanceof Blob) &&
-        !(body instanceof ArrayBuffer) &&
-        !(body instanceof URLSearchParams) &&
-        !ArrayBuffer.isView(body) // covers Uint8Array, etc.
-    );
-}
-
-/**
- * Fetch helper for Magentrix API.
- * Handles network, HTTP, and API-level errors with detailed messages or returns error info as JSON object.
- *
- * @async
- * @function fetchMagentrix
- * @param {Object} opts - Fetch options.
- * @param {string} opts.instanceUrl - Magentrix instance base URL (e.g. https://your.magentrix.com).
- * @param {string} [opts.token] - OAuth2 bearer token for authentication (optional for public endpoints).
- * @param {string} opts.path - API path (e.g. '/api/3.0/entity/activeclass').
- * @param {string} [opts.method='GET'] - HTTP method.
- * @param {any} [opts.body] - Request body (object for JSON, or raw for FormData, Blob, string, etc).
- * @param {Object} [opts.headers] - Additional headers to merge with defaults.
- * @param {boolean} [opts.returnErrorObject=false] - If true, errors are returned as JSON objects instead of thrown as Error.
- * @returns {Promise<Object>} Parsed JSON response from the API if successful.
- * @throws {Error|Object} Throws Error (default) or error object if returnErrorObject is true.
- */
-export const fetchMagentrix = async ({
-    instanceUrl,
-    token,
-    path,
-    method = 'GET',
-    body,
-    headers = {},
-    ignoreContentType = false,
-    returnErrorObject = false,
-    errorConfig = {
-        includeStatus: false,
-        includeURL: false,
-        label: '', // 'Magentrix errors:',
-        bullets: false
-    },
-}) => {
-    if (!instanceUrl || !path) {
-        const err = { type: 'client', message: 'Missing required parameter(s): instanceUrl or path' };
-        if (returnErrorObject) throw err;
-        throw new Error(err.message);
-    }
-
-    const finalHeaders = {
-        'Accept': 'application/json',
-        ...headers
-    };
-    if (isJsonBody(body)) finalHeaders['Content-Type'] = 'application/json';
-    if (token) finalHeaders['Authorization'] = `Bearer ${token}`;
-    let requestBody;
-    if (body === undefined || body === null) {
-        requestBody = undefined;
-    } else if (isJsonBody(body)) {
-        requestBody = JSON.stringify(body);
-    } else {
-        requestBody = body;
-    }
-    if (!finalHeaders['Content-Type'] && !ignoreContentType) finalHeaders['Content-Type'] = 'application/json';
-
-    const fullUrl = `${instanceUrl.replace(/\/$/, '')}${path}`;
-    debug.request(method, fullUrl, finalHeaders, body);
-
-    let response, responseData;
-    try {
-        response = await fetch(fullUrl, {
-            method,
-            headers: finalHeaders,
-            body: requestBody
-        });
-    } catch (err) {
-        const cause = err.cause || {};
-        const rootDetail = cause.code ? `${cause.code}: ${cause.message || ''}` : '';
-        debug.log('HTTP-ERR', `Network error: ${err.message}${rootDetail ? ` (${rootDetail})` : ''}`);
-        if (cause.code) debug.log('HTTP-ERR', `Error code: ${cause.code}, hostname: ${cause.hostname || 'N/A'}`);
-        if (err.stack) debug.log('HTTP-ERR', `Stack: ${err.stack}`);
-        const errorObj = {
-            type: 'network',
-            message: `Network error contacting Magentrix API: ${err.message}`,
-            error: err
-        };
-        if (returnErrorObject) throw errorObj;
-        throw new Error(errorObj.message);
-    }
-
-    try {
-        responseData = await response.json();
-    } catch {
-        responseData = null;
-    }
-
-    debug.response(response.status, response.statusText, response.headers, responseData);
-
-    if (!response.ok) {
-        const errorObj = {
-            type: 'http',
-            status: response.status,
-            statusText: response.statusText,
-            url: response.url,
-            response: responseData,
-        };
-        // Optionally add detailed error message
-        let msg = errorConfig?.includeStatus ? `HTTP ${response.status} ${response.statusText}\n` : '';
-        if (responseData) {
-            const responseErrs = responseData.errors || responseData.Errors;
-
-            if (Array.isArray(responseErrs) && responseErrs.length) {
-                msg += `${errorConfig?.label}${errorConfig?.label ? '\n' : ''}` + responseErrs.map(e => `${errorConfig?.bullets ? " •  " : ""}${e.code ? `[${e.code || '500'}] ` : ''}${e.message || e}`).join('\n');
-            } else if (responseData.message) {
-                msg += `Magentrix message: ${responseData.message}`;
-            } else {
-                msg += JSON.stringify(responseData);
-            }
-        }
-        if (errorConfig?.includeURL) msg += `\nURL: ${response.url}`;
-        errorObj.message = msg;
-        debug.log('HTTP-ERR', `HTTP ${response.status}: ${msg}`);
-        if (returnErrorObject) throw errorObj;
-        throw new Error(msg);
-    }
-
-    // Handle API-level business logic errors
-    if (
-        !responseData ||
-        responseData.success === false ||
-        (Array.isArray(responseData?.errors) && responseData.errors.length > 0) ||
-        responseData.error
-    ) {
-        const errorObj = {
-            type: 'api',
-            url: response.url,
-            response: responseData
-        };
-        let details = '';
-        if (Array.isArray(responseData?.errors) && responseData.errors.length) {
-            details = responseData.errors
-                .map(e => `  • ${e.code ? `[${e.code}] ` : ''}${e.message}`)
-                .join('\n');
-        } else if (responseData?.message) {
-            details = responseData.message;
-        } else if (typeof responseData === 'object') {
-            details = JSON.stringify(responseData);
-        } else {
-            details = String(responseData);
-        }
-        errorObj.message = `Magentrix API error:\n${details}`;
-        debug.log('API-ERR', errorObj.message);
-        if (returnErrorObject) throw errorObj;
-        throw new Error(errorObj.message);
-    }
-
-    return responseData;
-};
+import debug from '../debug.js';
+
+/**
+ * Checks if a request body should be JSON-stringified.
+ * Excludes FormData, Blob, ArrayBuffer, URLSearchParams, and typed arrays.
+ * @param {any} body
+ * @returns {boolean}
+ */
+function isJsonBody(body) {
+    return (
+        typeof body === 'object' &&
+        body !== null &&
+        !(body instanceof FormData) &&
+        !(body instanceof Blob) &&
+        !(body instanceof ArrayBuffer) &&
+        !(body instanceof URLSearchParams) &&
+        !ArrayBuffer.isView(body) // covers Uint8Array, etc.
+    );
+}
+
+/**
+ * Fetch helper for Magentrix API.
+ * Handles network, HTTP, and API-level errors with detailed messages or returns error info as JSON object.
+ *
+ * @async
+ * @function fetchMagentrix
+ * @param {Object} opts - Fetch options.
+ * @param {string} opts.instanceUrl - Magentrix instance base URL (e.g. https://your.magentrix.com).
+ * @param {string} [opts.token] - OAuth2 bearer token for authentication (optional for public endpoints).
+ * @param {string} opts.path - API path (e.g. '/api/3.0/entity/activeclass').
+ * @param {string} [opts.method='GET'] - HTTP method.
+ * @param {any} [opts.body] - Request body (object for JSON, or raw for FormData, Blob, string, etc).
+ * @param {Object} [opts.headers] - Additional headers to merge with defaults.
+ * @param {boolean} [opts.returnErrorObject=false] - If true, errors are returned as JSON objects instead of thrown as Error.
+ * @returns {Promise<Object>} Parsed JSON response from the API if successful.
+ * @throws {Error|Object} Throws Error (default) or error object if returnErrorObject is true.
+ */
+export const fetchMagentrix = async ({
+    instanceUrl,
+    token,
+    path,
+    method = 'GET',
+    body,
+    headers = {},
+    ignoreContentType = false,
+    returnErrorObject = false,
+    errorConfig = {
+        includeStatus: false,
+        includeURL: false,
+        label: '', // 'Magentrix errors:',
+        bullets: false
+    },
+}) => {
+    if (!instanceUrl || !path) {
+        const err = { type: 'client', message: 'Missing required parameter(s): instanceUrl or path' };
+        if (returnErrorObject) throw err;
+        throw new Error(err.message);
+    }
+
+    const finalHeaders = {
+        'Accept': 'application/json',
+        ...headers
+    };
+    if (isJsonBody(body)) finalHeaders['Content-Type'] = 'application/json';
+    if (token) finalHeaders['Authorization'] = `Bearer ${token}`;
+    let requestBody;
+    if (body === undefined || body === null) {
+        requestBody = undefined;
+    } else if (isJsonBody(body)) {
+        requestBody = JSON.stringify(body);
+    } else {
+        requestBody = body;
+    }
+    if (!finalHeaders['Content-Type'] && !ignoreContentType) finalHeaders['Content-Type'] = 'application/json';
+
+    const fullUrl = `${instanceUrl.replace(/\/$/, '')}${path}`;
+    debug.request(method, fullUrl, finalHeaders, body);
+
+    let response, responseData;
+    try {
+        response = await fetch(fullUrl, {
+            method,
+            headers: finalHeaders,
+            body: requestBody
+        });
+    } catch (err) {
+        const cause = err.cause || {};
+        const rootDetail = cause.code ? `${cause.code}: ${cause.message || ''}` : '';
+        debug.log('HTTP-ERR', `Network error: ${err.message}${rootDetail ? ` (${rootDetail})` : ''}`);
+        if (cause.code) debug.log('HTTP-ERR', `Error code: ${cause.code}, hostname: ${cause.hostname || 'N/A'}`);
+        if (err.stack) debug.log('HTTP-ERR', `Stack: ${err.stack}`);
+        const errorObj = {
+            type: 'network',
+            message: `Network error contacting Magentrix API: ${err.message}`,
+            error: err
+        };
+        if (returnErrorObject) throw errorObj;
+        throw new Error(errorObj.message);
+    }
+
+    try {
+        responseData = await response.json();
+    } catch {
+        responseData = null;
+    }
+
+    debug.response(response.status, response.statusText, response.headers, responseData);
+
+    if (!response.ok) {
+        const errorObj = {
+            type: 'http',
+            status: response.status,
+            statusText: response.statusText,
+            url: response.url,
+            response: responseData,
+        };
+        // Optionally add detailed error message
+        let msg = errorConfig?.includeStatus ? `HTTP ${response.status} ${response.statusText}\n` : '';
+        if (responseData) {
+            const responseErrs = responseData.errors || responseData.Errors;
+
+            if (Array.isArray(responseErrs) && responseErrs.length) {
+                msg += `${errorConfig?.label}${errorConfig?.label ? '\n' : ''}` + responseErrs.map(e => `${errorConfig?.bullets ? " •  " : ""}${e.code ? `[${e.code || '500'}] ` : ''}${e.message || e}`).join('\n');
+            } else if (responseData.message) {
+                msg += `Magentrix message: ${responseData.message}`;
+            } else {
+                msg += JSON.stringify(responseData);
+            }
+        }
+        if (errorConfig?.includeURL) msg += `\nURL: ${response.url}`;
+        errorObj.message = msg;
+        debug.log('HTTP-ERR', `HTTP ${response.status}: ${msg}`);
+        if (returnErrorObject) throw errorObj;
+        throw new Error(msg);
+    }
+
+    // Handle API-level business logic errors
+    if (
+        !responseData ||
+        responseData.success === false ||
+        (Array.isArray(responseData?.errors) && responseData.errors.length > 0) ||
+        responseData.error
+    ) {
+        const errorObj = {
+            type: 'api',
+            url: response.url,
+            response: responseData
+        };
+        let details = '';
+        if (Array.isArray(responseData?.errors) && responseData.errors.length) {
+            details = responseData.errors
+                .map(e => `  • ${e.code ? `[${e.code}] ` : ''}${e.message}`)
+                .join('\n');
+        } else if (responseData?.message) {
+            details = responseData.message;
+        } else if (typeof responseData === 'object') {
+            details = JSON.stringify(responseData);
+        } else {
+            details = String(responseData);
+        }
+        errorObj.message = `Magentrix API error:\n${details}`;
+        debug.log('API-ERR', errorObj.message);
+        if (returnErrorObject) throw errorObj;
+        throw new Error(errorObj.message);
+    }
+
+    return responseData;
+};