gizmovsky 1.0.0 → 1.0.1

package/README.md

@@ -19,7 +19,7 @@ import { GizmoSDK } from 'gizmo-sdk';
 
 const config = {
     ip: '127.0.0.1',
-    port: 81,
+    port: 80,
     ssl: false,
     username: 'admin',
     password: 'admin',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gizmovsky",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Unofficial SDK for Gizmo API",
   "main": "src/index.js",
   "type": "module",

package/src/GizmoClient.js

@@ -14,7 +14,6 @@ export class GizmoClient {
     }
 
     async request(method, url, data = {}, params = {}) {
-        // URL формируется только из относительного пути, версия не подставляется
         const finalUrl = url.startsWith('/') ? url : `/${url}`;
         try {
             const res = await this.axios({
@@ -25,7 +24,6 @@ export class GizmoClient {
             });
             return res.data;
         } catch (error) {
-            // Пробрасываем ошибку наружу для обработки пользователем
             throw error;
         }
     }

package/src/index.js

@@ -47,6 +47,8 @@ import { UserGroups as UserGroupsV2 } from './v2/UserGroups.js';
 import { Users as UsersV2 } from './v2/Users.js';
 import { Variables as VariablesV2 } from './v2/Variables.js';
 import { Verifications as VerificationsV2 } from './v2/Verifications.js';
+// v3
+// Unusable, waiting for API updates
 
 function createV1Categories(client) {
     return {
@@ -105,14 +107,17 @@ function createV2Categories(client) {
     };
 }
 
+function createV3Categories(client) {
+    return {
+        
+    };
+}
+
 export class GizmoSDK {
     constructor(config) {
         this.client = new GizmoClient(config);
         this.v1 = createV1Categories(this.client);
         this.v2 = createV2Categories(this.client);
-        // Для v3 аналогично, если появится swagger
-        this.v3 = {};
-
-        // Доступ к категориям только через sdk.v1, sdk.v2, sdk.v3
+        this.v3 = createV3Categories(this.client);
     }
 }

package/src/v1/Apps.js

@@ -1,37 +1,89 @@
 import { GizmoClient } from '../GizmoClient.js';
 
+/**
+ * Class for application operations.
+ */
 export class Apps {
+    /**
+     * Create an Apps instance.
+     * @param {GizmoClient} client - The GizmoClient instance.
+     */
     constructor(client) {
         this.client = client;
     }
-    // Методы для /api/apps
+    /**
+     * Get all applications.
+     * @param {Object} params - Query parameters
+     * @returns {Promise<any>} List of applications
+     */
     getApps(params = {}) {
         return this.client.request('get', '/apps', {}, params);
     }
+    /**
+     * Get application by ID.
+     * @param {number|string} appId - Application ID
+     * @returns {Promise<any>} Application details
+     */
     getAppById(appId) {
         return this.client.request('get', `/apps/${appId}`);
     }
+    /**
+     * Get all application titles.
+     * @returns {Promise<any>} List of titles
+     */
     getAppTitles() {
         return this.client.request('get', '/apps/titles');
     }
+    /**
+     * Get application image by ID.
+     * @param {number|string} appId - Application ID
+     * @returns {Promise<any>} Image data
+     */
     getAppImage(appId) {
         return this.client.request('get', `/apps/${appId}/image`);
     }
+    /**
+     * Get application rating by ID.
+     * @param {number|string} appId - Application ID
+     * @returns {Promise<any>} Rating data
+     */
     getAppRating(appId) {
         return this.client.request('get', `/apps/${appId}/rating`);
     }
+    /**
+     * Get average rating for application.
+     * @param {number|string} appId - Application ID
+     * @returns {Promise<any>} Average rating
+     */
     getAppAverageRating(appId) {
         return this.client.request('get', `/apps/${appId}/rating/average`);
     }
+    /**
+     * Get rating count for application.
+     * @param {number|string} appId - Application ID
+     * @returns {Promise<any>} Rating count
+     */
     getAppRatingCount(appId) {
         return this.client.request('get', `/apps/${appId}/rating/count`);
     }
+    /**
+     * Get info for all applications.
+     * @returns {Promise<any>} Applications info
+     */
     getAppsInfo() {
         return this.client.request('get', '/apps/infos');
     }
+    /**
+     * Get top rated applications info.
+     * @returns {Promise<any>} Top rated applications
+     */
     getAppsInfoTopRating() {
         return this.client.request('get', '/apps/infos/top/rating');
     }
+    /**
+     * Get top used applications info.
+     * @returns {Promise<any>} Top used applications
+     */
     getAppsInfoTopUse() {
         return this.client.request('get', '/apps/infos/top/use');
     }

package/src/v1/Attributes.js

@@ -1,18 +1,44 @@
 import { GizmoClient } from '../GizmoClient.js';
 
+/**
+ * Class for attribute operations.
+ */
 export class Attributes {
+    /**
+     * Create an Attributes instance.
+     * @param {GizmoClient} client - The GizmoClient instance.
+     */
     constructor(client) {
         this.client = client;
     }
+    /**
+     * Get all attributes.
+     * @returns {Promise<any>} List of attributes
+     */
     getAttributes() {
         return this.client.request('get', '/attributes');
     }
+    /**
+     * Add a new attribute.
+     * @param {Object} data - Attribute data
+     * @returns {Promise<any>} Added attribute
+     */
     addAttribute(data) {
         return this.client.request('put', '/attributes', data);
     }
+    /**
+     * Update an attribute.
+     * @param {Object} data - Attribute data
+     * @returns {Promise<any>} Updated attribute
+     */
     updateAttribute(data) {
         return this.client.request('post', '/attributes', data);
     }
+    /**
+     * Delete an attribute by ID.
+     * @param {number|string} attributeId - Attribute ID
+     * @returns {Promise<any>} Delete result
+     */
     deleteAttribute(attributeId) {
         return this.client.request('delete', `/attributes/${attributeId}`);
     }

package/src/v1/Export.js

@@ -1,9 +1,21 @@
 import { GizmoClient } from '../GizmoClient.js';
 
+/**
+ * Class for export operations.
+ */
 export class Export {
+    /**
+     * Create an Export instance.
+     * @param {GizmoClient} client - The GizmoClient instance.
+     */
     constructor(client) {
         this.client = client;
     }
+    /**
+     * Export application image.
+     * @param {Object} params - Query parameters
+     * @returns {Promise<any>} Exported image
+     */
     exportAppImage(params = {}) {
         return this.client.request('get', '/export/app/image', {}, params);
     }

package/src/v1/HostComputers.js

@@ -1,39 +1,106 @@
 import { GizmoClient } from '../GizmoClient.js';
 
+/**
+ * Class for host computer operations.
+ */
 export class HostComputers {
+    /**
+     * Create a HostComputers instance.
+     * @param {GizmoClient} client - The GizmoClient instance.
+     */
     constructor(client) {
         this.client = client;
     }
+    /**
+     * Get all host computers.
+     * @returns {Promise<any>} List of host computers
+     */
     getHostComputers() {
         return this.client.request('get', '/hostcomputers');
     }
+    /**
+     * Get host computer by hostname.
+     * @param {string} hostname - Hostname
+     * @returns {Promise<any>} Host computer details
+     */
     getHostComputerByHostname(hostname) {
         return this.client.request('get', `/hostcomputers/${hostname}`);
     }
+    /**
+     * Get processes for a host.
+     * @param {number|string} hostId - Host ID
+     * @returns {Promise<any>} List of processes
+     */
     getHostProcesses(hostId) {
         return this.client.request('get', `/hostcomputers/${hostId}/process`);
     }
+    /**
+     * Create a process for a host.
+     * @param {number|string} hostId - Host ID
+     * @param {Object} data - Process data
+     * @returns {Promise<any>} Created process
+     */
     createHostProcess(hostId, data) {
         return this.client.request('put', `/hostcomputers/${hostId}/process`, data);
     }
+    /**
+     * Terminate all processes for a host.
+     * @param {number|string} hostId - Host ID
+     * @returns {Promise<any>} Termination result
+     */
     terminateHostProcess(hostId) {
         return this.client.request('delete', `/hostcomputers/${hostId}/process`);
     }
+    /**
+     * Get process by ID for a host.
+     * @param {number|string} hostId - Host ID
+     * @param {number|string} processId - Process ID
+     * @returns {Promise<any>} Process details
+     */
     getHostProcessById(hostId, processId) {
         return this.client.request('get', `/hostcomputers/${hostId}/process/${processId}`);
     }
+    /**
+     * Terminate process by ID for a host.
+     * @param {number|string} hostId - Host ID
+     * @param {number|string} processId - Process ID
+     * @returns {Promise<any>} Termination result
+     */
     terminateHostProcessById(hostId, processId) {
         return this.client.request('delete', `/hostcomputers/${hostId}/process/${processId}`);
     }
+    /**
+     * Get process by name for a host.
+     * @param {number|string} hostId - Host ID
+     * @param {string} processName - Process name
+     * @returns {Promise<any>} Process details
+     */
     getHostProcessByName(hostId, processName) {
         return this.client.request('get', `/hostcomputers/${hostId}/process/${processName}`);
     }
+    /**
+     * Set host security state.
+     * @param {number|string} hostId - Host ID
+     * @param {boolean} enabled - Security enabled
+     * @returns {Promise<any>} Security state result
+     */
     setHostSecurityState(hostId, enabled) {
         return this.client.request('post', `/hostcomputers/${hostId}/security/${enabled}`);
     }
+    /**
+     * Get host maintenance state.
+     * @param {number|string} hostId - Host ID
+     * @returns {Promise<any>} Maintenance state
+     */
     getHostMaintenanceState(hostId) {
         return this.client.request('get', `/hostcomputers/${hostId}/maintenance`);
     }
+    /**
+     * Set host maintenance state.
+     * @param {number|string} hostId - Host ID
+     * @param {boolean} enabled - Maintenance enabled
+     * @returns {Promise<any>} Maintenance state result
+     */
     setHostMaintenanceState(hostId, enabled) {
         return this.client.request('post', `/hostcomputers/${hostId}/maintenance/${enabled}`);
     }

package/src/v1/HostGroups.js

@@ -1,15 +1,36 @@
 import { GizmoClient } from '../GizmoClient.js';
 
+/**
+ * Class for host group operations.
+ */
 export class HostGroups {
+    /**
+     * Create a HostGroups instance.
+     * @param {GizmoClient} client - The GizmoClient instance.
+     */
     constructor(client) {
         this.client = client;
     }
+    /**
+     * Get all host groups.
+     * @returns {Promise<any>} List of host groups
+     */
     getHostGroups() {
         return this.client.request('get', '/hostgroups');
     }
+    /**
+     * Get host group by ID.
+     * @param {number|string} hostGroupId - Host group ID
+     * @returns {Promise<any>} Host group details
+     */
     getHostGroupById(hostGroupId) {
         return this.client.request('get', `/hostgroups/${hostGroupId}`);
     }
+    /**
+     * Get disallowed user groups for host group.
+     * @param {number|string} hostGroupId - Host group ID
+     * @returns {Promise<any>} Disallowed user groups
+     */
     getDisallowedUserGroups(hostGroupId) {
         return this.client.request('get', `/hostgroups/${hostGroupId}/disallowedusergroups`);
     }

package/src/v1/Hosts.js

@@ -1,48 +1,126 @@
 import { GizmoClient } from '../GizmoClient.js';
 
+/**
+ * Class for host operations.
+ */
 export class Hosts {
+    /**
+     * Create a Hosts instance.
+     * @param {GizmoClient} client - The GizmoClient instance.
+     */
     constructor(client) {
         this.client = client;
     }
+    /**
+     * Get all hosts.
+     * @returns {Promise<any>} List of hosts
+     */
     getHosts() {
         return this.client.request('get', '/hosts');
     }
+    /**
+     * Get host by ID.
+     * @param {number|string} hostId - Host ID
+     * @returns {Promise<any>} Host details
+     */
     getHostById(hostId) {
         return this.client.request('get', `/hosts/${hostId}`);
     }
+    /**
+     * Delete host by ID.
+     * @param {number|string} hostId - Host ID
+     * @returns {Promise<any>} Delete result
+     */
     deleteHost(hostId) {
         return this.client.request('delete', `/hosts/${hostId}`);
     }
+    /**
+     * Get hosts by number.
+     * @param {number|string} hostNumber - Host number
+     * @returns {Promise<any>} Hosts list
+     */
     getHostsByNumber(hostNumber) {
         return this.client.request('get', `/hosts/number/${hostNumber}`);
     }
+    /**
+     * Add a new host.
+     * @param {Object} data - Host data
+     * @returns {Promise<any>} Added host
+     */
     addHost(data) {
         return this.client.request('put', '/hosts/host', data);
     }
+    /**
+     * Update a host.
+     * @param {Object} data - Host data
+     * @returns {Promise<any>} Updated host
+     */
     updateHost(data) {
         return this.client.request('post', '/hosts/host', data);
     }
+    /**
+     * Add a host computer.
+     * @param {Object} data - Host computer data
+     * @returns {Promise<any>} Added host computer
+     */
     addHostComputer(data) {
         return this.client.request('put', '/hosts/hostcomputer', data);
     }
+    /**
+     * Update a host computer.
+     * @param {Object} data - Host computer data
+     * @returns {Promise<any>} Updated host computer
+     */
     updateHostComputer(data) {
         return this.client.request('post', '/hosts/hostcomputer', data);
     }
+    /**
+     * Add a host endpoint.
+     * @param {Object} data - Host endpoint data
+     * @returns {Promise<any>} Added host endpoint
+     */
     addHostEndpoint(data) {
         return this.client.request('put', '/hosts/hostendpoint', data);
     }
+    /**
+     * Update a host endpoint.
+     * @param {Object} data - Host endpoint data
+     * @returns {Promise<any>} Updated host endpoint
+     */
     updateHostEndpoint(data) {
         return this.client.request('post', '/hosts/hostendpoint', data);
     }
+    /**
+     * Get last user login for host.
+     * @param {number|string} hostId - Host ID
+     * @returns {Promise<any>} Last user login
+     */
     getLastUserLogin(hostId) {
         return this.client.request('get', `/hosts/${hostId}/lastuserlogin`);
     }
+    /**
+     * Get last user logout for host.
+     * @param {number|string} hostId - Host ID
+     * @returns {Promise<any>} Last user logout
+     */
     getLastUserLogout(hostId) {
         return this.client.request('get', `/hosts/${hostId}/lastuserlogout`);
     }
+    /**
+     * Set host lock state.
+     * @param {number|string} hostId - Host ID
+     * @param {boolean} locked - Lock state
+     * @returns {Promise<any>} Lock state result
+     */
     setHostLockState(hostId, locked) {
         return this.client.request('post', `/hosts/${hostId}/lock/${locked}`);
     }
+    /**
+     * Set host order state.
+     * @param {number|string} hostId - Host ID
+     * @param {boolean} inOrder - Order state
+     * @returns {Promise<any>} Order state result
+     */
     setHostOrderState(hostId, inOrder) {
         return this.client.request('post', `/hosts/${hostId}/orderstate/${inOrder}`);
     }

package/src/v1/Invoices.js

@@ -1,18 +1,45 @@
 import { GizmoClient } from '../GizmoClient.js';
 
+/**
+ * Class for invoice operations.
+ */
 export class Invoices {
+    /**
+     * Create an Invoices instance.
+     * @param {GizmoClient} client - The GizmoClient instance.
+     */
     constructor(client) {
         this.client = client;
     }
+    /**
+     * Get all invoices.
+     * @returns {Promise<any>} List of invoices
+     */
     getInvoices() {
         return this.client.request('get', '/invoices');
     }
+    /**
+     * Get invoice by ID.
+     * @param {number|string} invoiceId - Invoice ID
+     * @returns {Promise<any>} Invoice details
+     */
     getInvoiceById(invoiceId) {
         return this.client.request('get', `/invoices/${invoiceId}`);
     }
+    /**
+     * Void invoice by ID.
+     * @param {number|string} invoiceId - Invoice ID
+     * @returns {Promise<any>} Void result
+     */
     voidInvoice(invoiceId) {
         return this.client.request('delete', `/invoices/void/${invoiceId}`);
     }
+    /**
+     * Void invoice with refund method.
+     * @param {number|string} invoiceId - Invoice ID
+     * @param {string} refundMethod - Refund method
+     * @returns {Promise<any>} Void result
+     */
     voidInvoiceWithRefund(invoiceId, refundMethod) {
         return this.client.request('delete', `/invoices/void/${invoiceId}/${refundMethod}`);
     }

package/src/v1/Licenses.js

@@ -1,9 +1,20 @@
 import { GizmoClient } from '../GizmoClient.js';
 
+/**
+ * Class for license operations.
+ */
 export class Licenses {
+    /**
+     * Create a Licenses instance.
+     * @param {GizmoClient} client - The GizmoClient instance.
+     */
     constructor(client) {
         this.client = client;
     }
+    /**
+     * Get reserved keys info.
+     * @returns {Promise<any>} Reserved keys info
+     */
     getReservedKeysInfo() {
         return this.client.request('get', '/licenses/keys/reserved/info');
     }

package/src/v1/MonetaryUnit.js

@@ -1,18 +1,44 @@
 import { GizmoClient } from '../GizmoClient.js';
 
+/**
+ * Class for monetary unit operations.
+ */
 export class MonetaryUnit {
+    /**
+     * Create a MonetaryUnit instance.
+     * @param {GizmoClient} client - The GizmoClient instance.
+     */
     constructor(client) {
         this.client = client;
     }
+    /**
+     * Get all monetary units.
+     * @returns {Promise<any>} List of monetary units
+     */
     getMonetaryUnits() {
         return this.client.request('get', '/monetaryunit');
     }
+    /**
+     * Add a new monetary unit.
+     * @param {Object} data - Monetary unit data
+     * @returns {Promise<any>} Added monetary unit
+     */
     addMonetaryUnit(data) {
         return this.client.request('put', '/monetaryunit', data);
     }
+    /**
+     * Update a monetary unit.
+     * @param {Object} data - Monetary unit data
+     * @returns {Promise<any>} Updated monetary unit
+     */
     updateMonetaryUnit(data) {
         return this.client.request('post', '/monetaryunit', data);
     }
+    /**
+     * Delete a monetary unit by ID.
+     * @param {number|string} monetaryUnitId - Monetary unit ID
+     * @returns {Promise<any>} Delete result
+     */
     deleteMonetaryUnit(monetaryUnitId) {
         return this.client.request('delete', `/monetaryunit/${monetaryUnitId}`);
     }

package/src/v1/Points.js

@@ -1,21 +1,52 @@
 import { GizmoClient } from '../GizmoClient.js';
 
+/**
+ * Class for points operations.
+ */
 export class Points {
+    /**
+     * Create a Points instance.
+     * @param {GizmoClient} client - The GizmoClient instance.
+     */
     constructor(client) {
         this.client = client;
     }
+    /**
+     * Get all points transactions.
+     * @returns {Promise<any>} List of points transactions
+     */
     getPointsTransactions() {
         return this.client.request('get', '/points');
     }
+    /**
+     * Reset all points.
+     * @returns {Promise<any>} Reset result
+     */
     resetAllPoints() {
         return this.client.request('post', '/points/reset');
     }
+    /**
+     * Reset points for a user.
+     * @param {number|string} userId - User ID
+     * @returns {Promise<any>} Reset result
+     */
     resetUserPoints(userId) {
         return this.client.request('post', `/points/${userId}/reset`);
     }
+    /**
+     * Set points for all users.
+     * @param {number} amount - Points amount
+     * @returns {Promise<any>} Set result
+     */
     setAllUsersPoints(amount) {
         return this.client.request('post', `/points/${amount}`);
     }
+    /**
+     * Set points for a user.
+     * @param {number|string} userId - User ID
+     * @param {number} amount - Points amount
+     * @returns {Promise<any>} Set result
+     */
     setUserPoints(userId, amount) {
         return this.client.request('post', `/points/${userId}/${amount}`);
     }