idosell 0.1.0 → 0.1.3

package/dist/gates.def.js

@@ -8,7 +8,7 @@
  * @property {(return_elements: Array<String>) => GetClientsBalanceRequest} return_elements Elements to be returned by the endpoint. By default all elements are returned
  * @property {(results_page: Integer) => GetClientsBalanceRequest} results_page Results page number. Numbering begins at 0. Default value: 0.
  * @property {(results_limit: Integer) => GetClientsBalanceRequest} results_limit Maximum number of results on a single page. Default is 100.
- * @property {(dateFrom: DateLike, dateTo: DateLike) => GetClientsBalanceRequest} lastPurchase Type of date according to the index results
+ * @property {(dateFrom: DateLike, dateTo: DateLike) => GetClientsBalanceRequest} lastPurchased Type of date according to the index results
  * @property {(page: Integer, limit: Integer) => GetClientsBalanceRequest} page Define page number and maximum results per page
  * @property {() => Integer} count Returns total numer of results
  * @property {function} exec Excecute request
@@ -39,7 +39,7 @@
  * @property {(returnElements: Array<String>) => GetClientsRequest} returnElements Elements to be returned by the endpoint. By default all elements are returned
  * @property {(resultsPage: Integer) => GetClientsRequest} resultsPage Page with results number. Numeration starts from 0
  * @property {(resultsLimit: Integer) => GetClientsRequest} resultsLimit Number of results on page. Value from 1 to 100
- * @property {(dateFrom: DateLike, dateTo: DateLike) => GetClientsRequest} lastPurchase Type of date according to the index results
+ * @property {(dateFrom: DateLike, dateTo: DateLike) => GetClientsRequest} lastPurchased Type of date according to the index results
  * @property {(dateFrom: DateLike, dateTo: DateLike) => GetClientsRequest} lastModified Type of date according to the index results
  * @property {(page: Integer, limit: Integer) => GetClientsRequest} page Define page number and maximum results per page
  * @property {() => Integer} count Returns total numer of results
@@ -1367,6 +1367,9 @@
  * @property {(ordersBy: Array<Object>) => ListOrdersUnfinishedRequest} ordersBy Possibility of sorting returned list
  * @property {(searchingOperatorTypeMatch: 'no_assignment'|'no_empty'|'empty') => ListOrdersUnfinishedRequest} searchingOperatorTypeMatch Method of searching orders by handler.
  * @property {(ordersDelayed: 'y'|'n') => ListOrdersUnfinishedRequest} ordersDelayed Orders with the exceeded date of shipment.
+ * @property {(shopIds: Array<Integer>) => ListOrdersUnfinishedRequest} shopIds Define shopsIds value nested inside orderSource
+ * @property {(byPackageNumbers: Array<String>) => ListOrdersUnfinishedRequest} byPackageNumbers Define packagesNumbers value nested inside packages
+ * @property {(dateFrom: DateLike, dateTo: DateLike, dateType: "add"|"modified"|"dispatch"|"payment"|"last_payments_operation"|"declared_payments") => ListOrdersUnfinishedRequest} dates Type of date according to the index results. Possible type values: add, modified, dispatch, payment, last_payments_operation, declared_payments
  * @property {(elementName: "id"|"sn"|"order_time"|"status"|"order_source"|"order_cost"|"discount_code"|"ready_to_send_date", descending: Boolean) => ListOrdersUnfinishedRequest} orderBy Define sorting by element and direction
  * @property {(logins: Array<String>) => ListOrdersUnfinishedRequest} logins Define clients by passing array of values
  * @property {(clientIds: Array<String>) => ListOrdersUnfinishedRequest} clientIds Define clients by passing array of values
@@ -1892,9 +1895,6 @@
 /**
  * @typedef {Object} GetProductsMarketingZonesRequest
  * @property {(products: Array<Object>) => GetProductsMarketingZonesRequest} products Products list.
- * @property {(ids: Array<Integer>) => GetProductsMarketingZonesRequest} ids Define products by passing array of values
- * @property {(externalCodes: Array<String>) => GetProductsMarketingZonesRequest} externalCodes Define products by passing array of values
- * @property {(producerCodes: Array<String>) => GetProductsMarketingZonesRequest} producerCodes Define products by passing array of values
  * @property {function} exec Excecute request
  */
 
@@ -1915,9 +1915,6 @@
 /**
  * @typedef {Object} GetProductsOmnibusPricesRequest
  * @property {(products: Array<Object>) => GetProductsOmnibusPricesRequest} products Products list.
- * @property {(ids: Array<[object Object]>) => GetProductsOmnibusPricesRequest} ids Define products by passing array of values
- * @property {(externalCodes: Array<String>) => GetProductsOmnibusPricesRequest} externalCodes Define products by passing array of values
- * @property {(producerCodes: Array<String>) => GetProductsOmnibusPricesRequest} producerCodes Define products by passing array of values
  * @property {function} exec Excecute request
  */
 
@@ -2416,7 +2413,7 @@
 /**
  * @typedef {Object} GetProductsReservationsRequest
  * @property {(productsIdents: Array<Object>) => GetProductsReservationsRequest} productsIdents Products list.
- * @property {(ids: Array<[object Object]>) => GetProductsReservationsRequest} ids Define productsIdents by passing array of values
+ * @property {(ids: Array<Integer>) => GetProductsReservationsRequest} ids Define productsIdents by passing array of values
  * @property {(externalCodes: Array<String>) => GetProductsReservationsRequest} externalCodes Define productsIdents by passing array of values
  * @property {(producerCodes: Array<String>) => GetProductsReservationsRequest} producerCodes Define productsIdents by passing array of values
  * @property {function} exec Excecute request
@@ -2526,7 +2523,7 @@
 /**
  * @typedef {Object} GetProductsStocksRequest
  * @property {(products: Array<Object>) => GetProductsStocksRequest} products Products list.
- * @property {(ids: Array<[object Object]>) => GetProductsStocksRequest} ids Define products by passing array of values
+ * @property {(ids: Array<Integer>) => GetProductsStocksRequest} ids Define products by passing array of values
  * @property {(externalCodes: Array<String>) => GetProductsStocksRequest} externalCodes Define products by passing array of values
  * @property {(producerCodes: Array<String>) => GetProductsStocksRequest} producerCodes Define products by passing array of values
  * @property {function} exec Excecute request
@@ -2546,9 +2543,6 @@
 /**
  * @typedef {Object} GetProductsStrikethroughPricesRequest
  * @property {(products: Array<Object>) => GetProductsStrikethroughPricesRequest} products Products list.
- * @property {(ids: Array<[object Object]>) => GetProductsStrikethroughPricesRequest} ids Define products by passing array of values
- * @property {(externalCodes: Array<String>) => GetProductsStrikethroughPricesRequest} externalCodes Define products by passing array of values
- * @property {(producerCodes: Array<String>) => GetProductsStrikethroughPricesRequest} producerCodes Define products by passing array of values
  * @property {function} exec Excecute request
  */
 

package/dist/gates.js

@@ -546,7 +546,7 @@ const gates = {
     deleteWmsSuppliers,
     getWmsSuppliers,
     putWmsSuppliers,
-};
+}
 
 export const gateProxy = {
     get: (object, property) => gates[property](object)

package/dist/index.js

@@ -1,5 +1,5 @@
 import { gateProxy } from "./gates.js";
-const DEFAULT_VERSION = 2;
+const DEFAULT_VERSION = 3;
 
 /**
  * Initializes the idosell API client.

package/dist/methods/getClients.js

@@ -4,7 +4,7 @@ import { dateRange, page } from "../helpers.js";
 export default (object) => {
     object.gate = { method: 'get', node: '/clients/clients' }
     object.custom = {
-        lastPurchase: dateRange({"nodeName":"clientLastPurchaseDate","fromName":"clientLastPurchaseDateBegin","toName":"clientLastPurchaseDateEnd"}),
+        lastPurchased: dateRange({"nodeName":"clientLastPurchaseDate","fromName":"clientLastPurchaseDateBegin","toName":"clientLastPurchaseDateEnd"}),
         lastModified: dateRange({"nodeName":"clientsLastModificationDate","fromName":"clientsLastModificationDateBegin","toName":"clientsLastModificationDateEnd"}),
         page
     };

package/dist/methods/getClientsBalance.js

@@ -4,7 +4,7 @@ import { dateRange, page } from "../helpers.js";
 export default (object) => {
     object.gate = { method: 'get', node: '/clients/balance' }
     object.custom = {
-        lastPurchase: dateRange({"nodeName":"last_purchase_date","fromName":"from","toName":"to"}),
+        lastPurchased: dateRange({"nodeName":"last_purchase_date","fromName":"from","toName":"to"}),
         page
     };
     object.snakeCase = true;

package/dist/methods/getProductsMarketingZones.js

@@ -1,12 +1,6 @@
 import { paramsProxy } from "../params.js";
-import { arrayOfObjects } from "../helpers.js";
 
 export default (object) => {
     object.gate = { method: 'get', node: '/products/marketingZones' }
-    object.custom = {
-        ids: arrayOfObjects("products", "value", {"type":"id"}),
-        externalCodes: arrayOfObjects("products", "value", {"type":"codeExtern"}),
-        producerCodes: arrayOfObjects("products", "value", {"type":"codeProducer"})
-    };
     return new Proxy(object, paramsProxy);
 }

package/dist/methods/getProductsOmnibusPrices.js

@@ -1,12 +1,6 @@
 import { paramsProxy } from "../params.js";
-import { arrayOfObjects } from "../helpers.js";
 
 export default (object) => {
     object.gate = { method: 'get', node: '/products/omnibusPrices' }
-    object.custom = {
-        ids: arrayOfObjects("products", "value"),
-        externalCodes: arrayOfObjects("products", "value", {"type":"codeExtern"}),
-        producerCodes: arrayOfObjects("products", "value", {"type":"codeProducer"})
-    };
     return new Proxy(object, paramsProxy);
 }

package/dist/methods/getProductsReservations.js

@@ -4,9 +4,9 @@ import { arrayOfObjects } from "../helpers.js";
 export default (object) => {
     object.gate = { method: 'get', node: '/products/reservations' }
     object.custom = {
-        ids: arrayOfObjects("productsIdents", "value"),
-        externalCodes: arrayOfObjects("productsIdents", "value", {"type":"codeExtern"}),
-        producerCodes: arrayOfObjects("productsIdents", "value", {"type":"codeProducer"})
+        ids: arrayOfObjects("productsIdents", "identValue", {"identType":"id"}),
+        externalCodes: arrayOfObjects("productsIdents", "identValue", {"identType":"codeExtern"}),
+        producerCodes: arrayOfObjects("productsIdents", "identValue", {"identType":"codeProducer"})
     };
     return new Proxy(object, paramsProxy);
 }

package/dist/methods/getProductsStocks.js

@@ -4,9 +4,9 @@ import { arrayOfObjects } from "../helpers.js";
 export default (object) => {
     object.gate = { method: 'get', node: '/products/stocks' }
     object.custom = {
-        ids: arrayOfObjects("products", "value"),
-        externalCodes: arrayOfObjects("products", "value", {"type":"codeExtern"}),
-        producerCodes: arrayOfObjects("products", "value", {"type":"codeProducer"})
+        ids: arrayOfObjects("products", "identValue", {"identType":"id"}),
+        externalCodes: arrayOfObjects("products", "identValue", {"identType":"codeExtern"}),
+        producerCodes: arrayOfObjects("products", "identValue", {"identType":"codeProducer"})
     };
     return new Proxy(object, paramsProxy);
 }

package/dist/methods/getProductsStrikethroughPrices.js

@@ -1,12 +1,6 @@
 import { paramsProxy } from "../params.js";
-import { arrayOfObjects } from "../helpers.js";
 
 export default (object) => {
     object.gate = { method: 'get', node: '/products/strikethroughPrices' }
-    object.custom = {
-        ids: arrayOfObjects("products", "value"),
-        externalCodes: arrayOfObjects("products", "value", {"type":"codeExtern"}),
-        producerCodes: arrayOfObjects("products", "value", {"type":"codeProducer"})
-    };
     return new Proxy(object, paramsProxy);
 }

package/dist/methods/listOrdersUnfinished.js

@@ -1,9 +1,12 @@
 import { paramsProxy } from "../params.js";
-import { orderBy, arrayOfObjects, page } from "../helpers.js";
+import { nest, dateRangeType, orderBy, arrayOfObjects, page } from "../helpers.js";
 
 export default (object) => {
     object.gate = { method: 'post', node: '/orders/unfinished/get' }
     object.custom = {
+        shopIds: nest("shopsIds", "orderSource", {}, true),
+        byPackageNumbers: nest("packagesNumbers", "packages", {"orderHasPackageNumbers":"y"}, true),
+        dates: dateRangeType({"nodeName":"ordersDateRange","fromName":"ordersDateBegin","toName":"ordersDateEnd","typeName":"ordersDateType","format":"YYYY-MM-DD HH:mm:ss","nested":"ordersRange","defaultType":"add"}),
         orderBy,
         logins: arrayOfObjects("clients", "clientLogin", {"type":"login"}),
         clientIds: arrayOfObjects("clients", "clientId", {"type":"id"}),

package/dist/request.js

@@ -31,7 +31,11 @@ export const queryfy = (params) => {
     let output = '';
     for (const [ key, value ] of Object.entries(params)) {
         if (Array.isArray(value)) {
-            output += `${key}=${value.join('%2C')}&`;
+            if (typeof value[0] === 'object') {
+                const newValue = value.map(obj => encodeURIComponent(JSON.stringify(obj)));
+                output += `${key}=${newValue.join('%2C')}&`;
+            }
+            else output += `${key}=${value.join('%2C')}&`;
         } else if (typeof value === 'object') {
             for (const [ subkey, subvalue ] of Object.entries(value)) {
                 output += `${key}%5B${subkey}%5D=${subvalue}&`;
@@ -58,9 +62,7 @@ export const sendRequest = async (request, options = {}) => {
     if (options.dump) return;
     
     if (method === 'get') {
-        // url += '?' + qs.stringify(request.params, { arrayFormat: 'comma' });
         url += '?' + queryfy(request.params);
-        console.log({ url })
         const response = await axios.get(url, { headers }).then(response => response.data).catch(catchIdosellError);
         return checkNext(request, response);
     } else {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "idosell",
-  "version": "0.1.0",
+  "version": "0.1.3",
   "description": "Idosell 3 REST connector",
   "main": "dist/index.js",
   "scripts": {

package/readme.md

@@ -8,11 +8,13 @@ Package translates awkward gate names into more readable method names using REST
 
 ```javascript
 import idosell from 'idosell';
-const idosellRequest = idosell('SHOP_URL', 'API_KEY')
+const idosellRequest = idosell('SHOP_URL', 'API_KEY', API_VERSION)
 ```
 
 **API_KEY** can be obtained in your Idosell panel.
-**SHOP_URL** is the base URI of your shop. Here are some examples:
+**SHOP_URL** is the base URI of your shop. 
+**API_VERSION** version of the API to call, current default version is **v3**
+Here are some examples:
 ```
 https://yourdomain.com
 https://clientXXXX.idosell.com
@@ -48,14 +50,14 @@ idosellRequest.deleteProductsOpinions.exec() // Translates to POST on products/o
 Alternatively to setting parameters in an object, you can chain several methods named after top-level parameters to set their value to your request. To execute the request after setting all the parameters, run the *exec()* method.
 
 ```javascript
-const idosellRequest = idosell('SHOP_URL', 'API_KEY');
-const categories = idosellRequest.ids([123, 456, 789]).languages(['pol', 'eng']).result_page(1).result_limit(10).getProductsCategories.exec();
+const idosellRequest = idosell('https://yourdomain.com', 'API_KEY');
+const categories = idosellRequest.getProductsCategories.ids([123, 456, 789]).languages(['pol', 'eng']).result_page(1).result_limit(10).exec();
 ```
 
 This example will generate the following GET request:
 
 ```
-https://yourdomain.com/api/admin/v1/products/categories?ids=123,456,789&languages=pol,eng&result_page=1&result_limit=10
+https://yourdomain.com/api/admin/v3/products/categories?ids=123,456,789&languages=pol,eng&result_page=1&result_limit=10
 ```
 
 A POST request will generate a JSON body request.
@@ -241,7 +243,7 @@ This will translate to following request parameters:
 This method is used specifically for updating and creating products and allows you to easily set multiple types of descriptions in different languages and different shops.
 
 ```javascript
-setText(text, type, languageId, shopId)
+idosellRequest.putProducts.setText(text, type, languageId, shopId)
 ```
 
 | Field | Description | Default | Possible values |
@@ -311,4 +313,8 @@ You can use the *getParams()* function to retrieve request parameters as Javascr
 ```javascript 
 const orderRequest = idosellRequest.getOrders.ordersSerialNumbers([123, 456, 789]).getParams();
 // Will return Object: { ordersSerialNumbers: [ 123, 456, 789 ] }
-```
+```
+
+## examples
+
+Read documentation and examples on [This page](https://idosell-converter.vercel.app/examples)

package/tests/getClientsBalance.test.js

@@ -1,8 +1,8 @@
 import idosell from "./dist/index.js"
-import { expect, test } from 'vitest'
+import { expect, test } from "vitest"
 
-test('getClientsBalanceActive', () => {
-    const params = idosell().getClientsBalance.active('yes').getParams();
+test("getClientsBalanceActive", () => {
+    const params = idosell().getClientsBalance.active("yes").getParams();
     expect(params).toEqual({ "active": "yes" });
 })
 
@@ -16,7 +16,7 @@ test("getClientsBalanceClient_numbers", () => {
     expect(params).toEqual({"client_numbers":[123,456,678]});
 })
 
-test("getClientsBalanceLastPurchase", () => {
-    const params = idosell().getClientsBalance.lastPurchase("2023-01-01", 1672704000000).getParams();
+test("getClientsBalanceLastPurchased", () => {
+    const params = idosell().getClientsBalance.lastPurchased("2023-01-01", 1672704000000).getParams();
     expect(params).toEqual({"last_purchase_date":{"from":"2023-01-01","to":"2023-01-03"}});
 })

package/tests/getProductsCodeExistence.test.js

@@ -0,0 +1,17 @@
+import idosell from "./dist/index.js"
+import { expect, test } from "vitest"
+
+test("getProductsCodeExistenceExternalCodes", () => {
+    const params = idosell().getProductsCodeExistence.externalCodes(["pav01"]).getParams();
+    expect(params).toEqual({"products":[{"productIdentType":"codeExtern","productId":"pav01"}]});
+})
+
+test("getProductsCodeExistenceProducerCodes", () => {
+    const params = idosell().getProductsCodeExistence.producerCodes(99099099099).getParams();
+    expect(params).toEqual({"products":[{"productIdentType":"codeProducer","productId":99099099099}]});
+})
+
+test("getProductsCodeExistenceIds", () => {
+    const params = idosell().getProductsCodeExistence.ids([30,33]).getParams();
+    expect(params).toEqual({"products":[{"productIdentType":"id","productId":30},{"productIdentType":"id","productId":33}]});
+})

package/tests/getProductsReservations.test.js

@@ -0,0 +1,17 @@
+import idosell from "./dist/index.js"
+import { expect, test } from "vitest"
+
+test("getProductsReservationsIds", () => {
+    const params = idosell().getProductsReservations.ids(33).getParams();
+    expect(params).toEqual({"productsIdents":[{"identType":"id","identValue":33}]});
+})
+
+test("getProductsReservationsExternalCodes", () => {
+    const params = idosell().getProductsReservations.externalCodes(["pav01"]).getParams();
+    expect(params).toEqual({"productsIdents":[{"identType":"codeExtern","identValue":"pav01"}]});
+})
+
+test("getProductsReservationsProducerCodes", () => {
+    const params = idosell().getProductsReservations.producerCodes([99099099099]).getParams();
+    expect(params).toEqual({"productsIdents":[{"identType":"codeProducer","identValue":99099099099}]});
+})

package/tests/getProductsSizes.test.js

@@ -2,6 +2,11 @@ import idosell from "./dist/index.js"
 import { expect, test } from "vitest"
 
 test("getProductsSizesResult::page", () => {
-    const params = idosell().getProductsSizes['result::page'](123).getParams();
+    const params = idosell().getProductsSizes["result::page"](123).getParams();
     expect(params).toEqual({"result::page":123});
+})
+
+test("getProductsSizesPage", () => {
+    const params = idosell().getProductsSizes.page(0,100).getParams();
+    expect(params).toEqual({"result::page":0,"result::pageNumber":100});
 })

package/tests/getProductsStocks.test.js

@@ -0,0 +1,17 @@
+import idosell from "./dist/index.js"
+import { expect, test } from "vitest"
+
+test("getProductsStocksIds", () => {
+    const params = idosell().getProductsStocks.ids(33).getParams();
+    expect(params).toEqual({"products":[{"identType":"id","identValue":33}]});
+})
+
+test("getProductsStocksExternalCodes", () => {
+    const params = idosell().getProductsStocks.externalCodes(["pav01"]).getParams();
+    expect(params).toEqual({"products":[{"identType":"codeExtern","identValue":"pav01"}]});
+})
+
+test("getProductsStocksProducerCodes", () => {
+    const params = idosell().getProductsStocks.producerCodes(99099099099).getParams();
+    expect(params).toEqual({"products":[{"identType":"codeProducer","identValue":99099099099}]});
+})

package/tests/putProducts.test.js

@@ -4,4 +4,9 @@ import { expect, test } from "vitest"
 test("putProductsSetText", () => {
     const params = idosell().putProducts.productId(33).setText("Krzesło Pavon", "name").getParams();
     expect(params).toEqual({"products":[{"productId":33,"productNames":{"productNamesLangData":[{"langId":"pol","productName":"Krzesło Pavon"}]}}]});
+})
+
+test("putProductsCountryOfOrigin", () => {
+    const params = idosell().putProducts.productId(33).countryOfOrigin("PL").getParams();
+    expect(params).toEqual({"products":[{"productId":33,"countryOfOrigin":"PL"}]});
 })

package/tests/rootparams.test.js

@@ -3,18 +3,18 @@ import { expect, test } from "vitest"
 
 // Only partial test
 
-const ROOTPARAMS_NODE = 'rootparams';
+const ROOTPARAMS_NODE = "rootparams";
 const routes = [
-    'postProductsCollectionsProducts',
-    'putProductsCollectionsProducts',
-    'putProductsCollectionsRenew',
-    'deleteProductsSizes',
-    'deleteClientsTags',
-    'deleteDiscountsRebatesCode',
-    'postDiscountsRebatesCard',
-    'putSystemCurrencies',
-    'putProductsParameters',
-    'postProductsRestore'
+    "postProductsCollectionsProducts",
+    "putProductsCollectionsProducts",
+    "putProductsCollectionsRenew",
+    "deleteProductsSizes",
+    "deleteClientsTags",
+    "deleteDiscountsRebatesCode",
+    "postDiscountsRebatesCard",
+    "putSystemCurrencies",
+    "putProductsParameters",
+    "postProductsRestore"
 ]
 
 for (const route of routes) {

package/tests/url.test.js

@@ -7,5 +7,5 @@ import { expect, test } from "vitest"
 test("putWmsSuppliersName", () => {
     const params = idosell().getClients.clientsIds([123,456,789]).lastPurchase("2023-01-01", 1672704000000).getParams();
     const search = queryfy(params);
-    expect(search).toEqual('clientsIds=123%2C456%2C789&clientLastPurchaseDate%5BclientLastPurchaseDateBegin%5D=2023-01-01&clientLastPurchaseDate%5BclientLastPurchaseDateEnd%5D=2023-01-03')
+    expect(search).toEqual("clientsIds=123%2C456%2C789&clientLastPurchaseDate%5BclientLastPurchaseDateBegin%5D=2023-01-01&clientLastPurchaseDate%5BclientLastPurchaseDateEnd%5D=2023-01-03")
 })