idosell 0.3.7 → 0.3.11

package/changelog.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.3.11] - 2025-07-05
+### Fixed
+- Added hard requirements for search/POST and GET gates
+- Auto reset current page on change parameters on paged gates
+- Fixed appendable type
+
 ## [0.3.7] - 2025-07-05
 ### Fixed
 - Fixed chaining then after await

package/dist/app.d.ts

@@ -79,7 +79,7 @@ export interface PagableGateway<T,R = JSObject> extends Gateway<R> {
 	hasNext: () => boolean
 }
 
-export interface AppendableGateway<T> extends Gateway {
+export interface AppendableGateway<T,R = JSObject> extends Gateway<R> {
 	/**
 	 * Start creating next item in list
 	 */

package/dist/methods/getClientsDeliveryAddress.js

@@ -1,5 +1,6 @@
 import { paramsProxy } from "../params.js";
 export default (object) => {
     object.gate = { method: 'get', node: '/clients/deliveryAddress' };
+    object.req = [{ "any": ["clientCodesExternal", "clientIds", "clientLogins"] }];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/getClientsPayerAddress.js

@@ -5,5 +5,6 @@ export default (object) => {
     object.custom = {
         page
     };
+    object.req = ["clientId"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/getClientsPricelistsClients.js

@@ -1,5 +1,6 @@
 import { paramsProxy } from "../params.js";
 export default (object) => {
     object.gate = { method: 'get', node: '/clients/pricelists/clients' };
+    object.req = ["priceListId"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/getClientsPricelistsProducts.js

@@ -5,5 +5,6 @@ export default (object) => {
     object.custom = {
         page
     };
+    object.req = ["priceListId"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/getClientsTags.js

@@ -1,5 +1,6 @@
 import { paramsProxy } from "../params.js";
 export default (object) => {
     object.gate = { method: 'get', node: '/clients/tags' };
+    object.req = ["clientId"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/getConfigVariables.js

@@ -5,5 +5,6 @@ export default (object) => {
     object.custom = {
         page
     };
+    object.req = ["type"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/getCouriers.js

@@ -5,5 +5,6 @@ export default (object) => {
     object.custom = {
         page
     };
+    object.req = ["countryCode"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/getCouriersPickupPoints.js

@@ -5,5 +5,6 @@ export default (object) => {
     object.custom = {
         page
     };
+    object.req = ["courierId"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/getDeliveriesRegions.js

@@ -1,5 +1,6 @@
 import { paramsProxy } from "../params.js";
 export default (object) => {
     object.gate = { method: 'get', node: '/deliveries/regions' };
+    object.req = ["shopId"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/getDiscountsGroupsClients.js

@@ -1,5 +1,6 @@
 import { paramsProxy } from "../params.js";
 export default (object) => {
     object.gate = { method: 'get', node: '/discounts/groups/clients' };
+    object.req = ["discountGroupId"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/getMenu.js

@@ -1,5 +1,6 @@
 import { paramsProxy } from "../params.js";
 export default (object) => {
     object.gate = { method: 'get', node: '/menu/menu' };
+    object.req = ["shop_id", "lang_id", "menu_id"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/getMenuFilter.js

@@ -1,5 +1,6 @@
 import { paramsProxy } from "../params.js";
 export default (object) => {
     object.gate = { method: 'get', node: '/menu/filter' };
+    object.req = ["shopId", "languageId", "productMenuTreeId", "productMenuNodeId"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/getOrders.js

@@ -1,5 +1,6 @@
 import { paramsProxy } from "../params.js";
 export default (object) => {
     object.gate = { method: 'get', node: '/orders/orders' };
+    object.req = [{ "any": ["ordersIds", "ordersSerialNumbers", "orderExternalId"] }];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/getOrdersAnalytics.js

@@ -1,5 +1,6 @@
 import { paramsProxy } from "../params.js";
 export default (object) => {
     object.gate = { method: 'get', node: '/orders/analytics' };
+    object.req = ["orderSerialNumber"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/getOrdersDocuments.js

@@ -1,5 +1,6 @@
 import { paramsProxy } from "../params.js";
 export default (object) => {
     object.gate = { method: 'get', node: '/orders/documents' };
+    object.req = ["orderSerialNumber", "documentType"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/getOrdersExportdocumentsEPP.js

@@ -5,5 +5,6 @@ export default (object) => {
     object.custom = {
         dates: dateRange({ "fromName": "dateBegin", "toName": "dateEnd" })
     };
+    object.req = ["dateBegin", "dateEnd", "dateEnd", "applicationType", "documentType"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/getOrdersExportdocumentsJPK.js

@@ -5,5 +5,6 @@ export default (object) => {
     object.custom = {
         dates: dateRange({ "fromName": "dateBegin", "toName": "dateEnd" })
     };
+    object.req = ["documentType", "dateBegin", "dateEnd", "currency"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/getOrdersHandler.js

@@ -1,5 +1,6 @@
 import { paramsProxy } from "../params.js";
 export default (object) => {
     object.gate = { method: 'get', node: '/orders/handler' };
+    object.req = ["orderSerialNumber"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/getOrdersHistory.js

@@ -1,5 +1,6 @@
 import { paramsProxy } from "../params.js";
 export default (object) => {
     object.gate = { method: 'get', node: '/orders/history' };
+    object.req = ["orderSerialNumber"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/getOrdersImages.js

@@ -1,5 +1,6 @@
 import { paramsProxy } from "../params.js";
 export default (object) => {
     object.gate = { method: 'get', node: '/orders/images' };
+    object.req = ["imageId"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/getOrdersLabels.js

@@ -1,5 +1,6 @@
 import { paramsProxy } from "../params.js";
 export default (object) => {
     object.gate = { method: 'get', node: '/orders/labels' };
+    object.req = ["orderSerialNumber"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/getOrdersOpinionsRate.js

@@ -1,5 +1,6 @@
 import { paramsProxy } from "../params.js";
 export default (object) => {
     object.gate = { method: 'get', node: '/orders/opinionsRate' };
+    object.req = ["id", "operation"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/getOrdersPackages.js

@@ -1,5 +1,6 @@
 import { paramsProxy } from "../params.js";
 export default (object) => {
     object.gate = { method: 'get', node: '/orders/packages' };
+    object.req = [{ "any": ["rmaNumbers", "returnNumbers", "orderNumbers", "deliveryPackageNumbers"] }];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/getOrdersProfitability.js

@@ -1,5 +1,6 @@
 import { paramsProxy } from "../params.js";
 export default (object) => {
     object.gate = { method: 'get', node: '/orders/profitability' };
+    object.req = ["orderSerialNumber"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/getOrdersWarehouse.js

@@ -1,5 +1,6 @@
 import { paramsProxy } from "../params.js";
 export default (object) => {
     object.gate = { method: 'get', node: '/orders/warehouse' };
+    object.req = ["orderSerialNumber"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/getPackagesLabels.js

@@ -6,5 +6,6 @@ export default (object) => {
         rm: (rmaId) => ({ eventType: "rma", eventId: rmaId }),
         return: (returnId) => ({ eventType: "return", eventId: returnId })
     };
+    object.req = ["eventId", "eventType"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/getPayments.js

@@ -1,5 +1,6 @@
 import { paramsProxy } from "../params.js";
 export default (object) => {
     object.gate = { method: 'get', node: '/payments/payments' };
+    object.req = ["paymentNumber", "sourceType"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/getProductsBrandsFilter.js

@@ -1,5 +1,6 @@
 import { paramsProxy } from "../params.js";
 export default (object) => {
     object.gate = { method: 'get', node: '/products/brands/filter' };
+    object.req = ["shopId", "languageId", "producerId"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/getProductsCodeExistence.js

@@ -5,5 +5,6 @@ export default (object) => {
     object.custom = {
         productId: getProductIdentList
     };
+    object.req = ["products", "identType"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/getProductsDescriptions.js

@@ -1,5 +1,6 @@
 import { paramsProxy } from "../params.js";
 export default (object) => {
     object.gate = { method: 'get', node: '/products/descriptions' };
+    object.req = ["type", "ids"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/getProductsIdBySizecode.js

@@ -1,5 +1,6 @@
 import { paramsProxy } from "../params.js";
 export default (object) => {
     object.gate = { method: 'get', node: '/products/idBySizecode' };
+    object.req = ["codes"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/getProductsMarketingAllFacebookCatalogIds.js

@@ -1,5 +1,6 @@
 import { paramsProxy } from "../params.js";
 export default (object) => {
     object.gate = { method: 'get', node: '/products/marketing/allFacebookCatalogIds' };
+    object.req = ["shopId"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/getProductsMarketingZones.js

@@ -5,5 +5,6 @@ export default (object) => {
     object.custom = {
         productId: getProductIdentList
     };
+    object.req = ["identType", "products"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/getProductsOmnibusPrices.js

@@ -5,5 +5,6 @@ export default (object) => {
     object.custom = {
         productId: getProductIdentList
     };
+    object.req = ["identType", "products"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/getProductsOpinionsRate.js

@@ -1,5 +1,6 @@
 import { paramsProxy } from "../params.js";
 export default (object) => {
     object.gate = { method: 'get', node: '/products/opinions/rate' };
+    object.req = ["id", "operation"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/getProductsProductsToFacebookCatalog.js

@@ -1,5 +1,6 @@
 import { paramsProxy } from "../params.js";
 export default (object) => {
     object.gate = { method: 'get', node: '/products/productsToFacebookCatalog' };
+    object.req = ["facebookCatalogId", "shopId"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/getProductsQuestions.js

@@ -1,5 +1,6 @@
 import { paramsProxy } from "../params.js";
 export default (object) => {
     object.gate = { method: 'get', node: '/products/questions' };
+    object.req = [{ "any": ["id", "productId"] }];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/getProductsReservations.js

@@ -5,5 +5,6 @@ export default (object) => {
     object.custom = {
         productId: getProductIdentList
     };
+    object.req = ["products", "identType"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/getProductsSKUbyBarcode.js

@@ -1,5 +1,6 @@
 import { paramsProxy } from "../params.js";
 export default (object) => {
     object.gate = { method: 'get', node: '/products/SKUbyBarcode' };
+    object.req = ["productIndices"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/getProductsSeriesFilter.js

@@ -1,5 +1,6 @@
 import { paramsProxy } from "../params.js";
 export default (object) => {
     object.gate = { method: 'get', node: '/products/series/filter' };
+    object.req = ["shopId", "languageId", "serieId"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/getProductsStocks.js

@@ -5,5 +5,6 @@ export default (object) => {
     object.custom = {
         productId: getProductIdentList
     };
+    object.req = ["identType", "products"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/getProductsStrikethroughPrices.js

@@ -5,5 +5,6 @@ export default (object) => {
     object.custom = {
         productId: getProductIdentList
     };
+    object.req = ["identType", "products"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/getRefundsGetPossibleAutoRefunds.js

@@ -1,5 +1,6 @@
 import { paramsProxy } from "../params.js";
 export default (object) => {
     object.gate = { method: 'get', node: '/refunds/getPossibleAutoRefunds' };
+    object.req = ["sourceId", "sourceType"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/getRefundsGetRefundStatus.js

@@ -1,5 +1,6 @@
 import { paramsProxy } from "../params.js";
 export default (object) => {
     object.gate = { method: 'get', node: '/refunds/getRefundStatus' };
+    object.req = ["sourceId", "paymentId", "sourceType"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/getRefundsRetrieveRefundsList.js

@@ -5,5 +5,6 @@ export default (object) => {
     object.custom = {
         page
     };
+    object.req = ["sourceType"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/getResponsibilityEntities.js

@@ -5,5 +5,6 @@ export default (object) => {
     object.custom = {
         page
     };
+    object.req = ["type"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/getWmsLocations.js

@@ -5,5 +5,6 @@ export default (object) => {
     object.custom = {
         page
     };
+    object.req = [{ "any": ["locationId", "stockId"] }];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/getWmsStocksdocumentsDocuments.js

@@ -6,5 +6,6 @@ export default (object) => {
         dates: dateRangeType({ "nodeName": "dateRange", "fromName": "dateBegin", "toName": "dateEnd", "typeName": "dateType", "format": "YYYY-MM-DD HH:mm:ss", "defaultType": "open" }),
         page
     };
+    object.req = ["stockDocumentType"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/getWmsStocksdocumentsProducts.js

@@ -6,5 +6,6 @@ export default (object) => {
         page
     };
     object.snakeCase = true;
+    object.req = ["type", "id"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/searchClientsGiftcards.js

@@ -7,6 +7,7 @@ export default (object) => {
         number: arrayOfObjects("giftCards", "number"),
         pins: arrayOfObjects("giftCards", "pin")
     };
+    object.req = [{ "any": ["giftCards", "searchGiftCards"] }];
     object.arrays = ["giftCards"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/searchPackages.js

@@ -11,6 +11,7 @@ export default (object) => {
         arrayNode: "events",
         index: 0
     };
+    object.req = [{ "any": ["events", "deliveryPackageNumbers"] }];
     object.arrays = ["deliveryPackageNumbers", "events"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/searchProductsDeliveryTime.js

@@ -6,6 +6,7 @@ export default (object) => {
         arrayNode: "products",
         index: 0
     };
+    object.req = ["productId", "sizeId", "products"];
     object.arrays = ["products"];
     return new Proxy(object, paramsProxy);
 };

package/dist/params.js

@@ -41,8 +41,9 @@ export const paramsProxy = {
                 }
             }
             else if (object.custom && typeof object.custom[property] === 'function') {
-                if (property === 'page')
-                    values.push(Boolean(object.snakeCase));
+                if (property === 'page') {
+                    values = [values[0] ?? 0, values[1] ?? 100, Boolean(object.snakeCase)];
+                }
                 const param = object.custom[property](...values);
                 Object.assign(object.params, param);
             }
@@ -55,6 +56,12 @@ export const paramsProxy = {
             else {
                 object.params[property] = values[0];
             }
+            if (object.custom?.page && property !== 'page') {
+                if (object.params.resultsPage)
+                    delete object.params.resultsPage;
+                if (object.params.results_page)
+                    delete object.params.results_page;
+            }
             return receiver;
         };
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "idosell",
-  "version": "0.3.7",
+  "version": "0.3.11",
   "description": "Idosell 3 REST connector",
   "main": "dist/index.js",
   "types": "dist/gateways.d.ts",