idosell 0.1.2 → 0.1.4

package/dist/gates.def.js

@@ -290,6 +290,9 @@
  * @property {(shops: Array<Integer>) => PutClientsGiftcardsRequest} shops List of shops the card is active in
  * @property {(note: String) => PutClientsGiftcardsRequest} note 
  * @property {function} append Append current data to array and start modifying next row
+ * @property {(amount: Float, currency: String) => PutClientsGiftcardsRequest} add Adds balance to current gift card
+ * @property {(amount: Float, currency: String) => PutClientsGiftcardsRequest} subtract Subtract from balance to current gift card
+ * @property {(amount: Float, currency: String) => PutClientsGiftcardsRequest} set Set balance to current gift card
  * @property {function} exec Excecute request
  */
 
@@ -1187,6 +1190,9 @@
  * @property {(discountCodes: Array<String>) => ListOrdersRequest} discountCodes Define campaign by passing array of values
  * @property {(productId: Integer, sizeId: String|null) => ListProductsRequest} hasProduct Filter by product ID and optionally product size
  * @property {(orderHasPackage: Boolean) => ListProductsRequest} hasPackage Filter by orders that have any package number
+ * @property {(accountName: String) => ListProductsRequest} fromAllegro Filter by orders from auction service Allegro
+ * @property {(accountName: String) => ListProductsRequest} fromEbay Filter by orders from action service EBay
+ * @property {(accountName: String) => ListProductsRequest} fromAmazon Filter by orders from action service Amazon
  * @property {(page: Integer, limit: Integer) => ListOrdersRequest} page Define page number and maximum results per page
  * @property {() => Integer} count Returns total numer of results
  * @property {function} exec Excecute request
@@ -1377,6 +1383,11 @@
  * @property {(stockIds: Array<Integer>) => ListOrdersUnfinishedRequest} stockIds Define stocks by passing array of values
  * @property {(campaignIds: Array<Integer>) => ListOrdersUnfinishedRequest} campaignIds Define campaign by passing array of values
  * @property {(discountCodes: Array<String>) => ListOrdersUnfinishedRequest} discountCodes Define campaign by passing array of values
+ * @property {(productId: Integer, sizeId: String|null) => ListProductsRequest} hasProduct Filter by product ID and optionally product size
+ * @property {(orderHasPackage: Boolean) => ListProductsRequest} hasPackage Filter by orders that have any package number
+ * @property {(accountName: String) => ListProductsRequest} fromAllegro Filter by orders from auction service Allegro
+ * @property {(accountName: String) => ListProductsRequest} fromEbay Filter by orders from action service EBay
+ * @property {(accountName: String) => ListProductsRequest} fromAmazon Filter by orders from action service Amazon
  * @property {(page: Integer, limit: Integer) => ListOrdersUnfinishedRequest} page Define page number and maximum results per page
  * @property {() => Integer} count Returns total numer of results
  * @property {function} exec Excecute request
@@ -1778,6 +1789,7 @@
  * @property {(productDescriptionsLangData: Array<Object>) => PutProductsDescriptionsRequest} productDescriptionsLangData Array of language-dependent elements.
  * @property {(productAuctionDescriptionsData: Array<Object>) => PutProductsDescriptionsRequest} productAuctionDescriptionsData Product data for auction services
  * @property {function} append Append current data to array and start modifying next row
+ * @property {(productId: Integer) => PutProductsDescriptionsRequest} productId Define identValue value nested inside productIdent
  * @property {function} exec Excecute request
  */
 
@@ -1895,9 +1907,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
  */
 
@@ -1918,9 +1927,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
  */
 
@@ -2419,7 +2425,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
@@ -2529,7 +2535,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
@@ -2549,9 +2555,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/helpers.js

@@ -119,6 +119,12 @@ export const nest = (valueName, nodeName, obj = {}, forceArray = false) => (valu
     return params;
 }
 
+export const orderSource = (sourceName) => (accountName = null) => {
+    const params = { orderSource: { auctionsParams: { auctionsServicesNames: [ sourceName ]}}};
+    if (accountName) params.orderSource.auctionsParams.auctionsAccounts = [{auctionsAccountLogin: 'monk'}];
+    return params;
+}
+
 const TEXT_NODES = {
     name: {
         main: 'productNames',

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/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/listOrders.js

@@ -1,5 +1,5 @@
 import { paramsProxy } from "../params.js";
-import { nest, dateRangeType, orderBy, arrayOfObjects, page } from "../helpers.js";
+import { nest, dateRangeType, orderBy, arrayOfObjects, orderSource, page } from "../helpers.js";
 
 export default (object) => {
     object.gate = { method: 'post', node: '/orders/orders/get' }
@@ -16,6 +16,9 @@ export default (object) => {
         discountCodes: arrayOfObjects("campaign", "discountCodes"),
         hasProduct: (productId, sizeId = null) => { const product = { productId }; if (sizeId) product.sizeId = sizeId; return { products: [ product ]}},
         hasPackage: (orderHasPackage = true) => ({ packages: { orderHasPackageNumbers: orderHasPackage ? "y" : "n" }}),
+        fromAllegro: orderSource("allegro"),
+        fromEbay: orderSource("ebay"),
+        fromAmazon: orderSource("amazon"),
         page
     };
     return new Proxy(object, paramsProxy);

package/dist/methods/listOrdersUnfinished.js

@@ -1,5 +1,5 @@
 import { paramsProxy } from "../params.js";
-import { nest, dateRangeType, orderBy, arrayOfObjects, page } from "../helpers.js";
+import { nest, dateRangeType, orderBy, arrayOfObjects, orderSource, page } from "../helpers.js";
 
 export default (object) => {
     object.gate = { method: 'post', node: '/orders/unfinished/get' }
@@ -14,6 +14,11 @@ export default (object) => {
         stockIds: arrayOfObjects("stocks", "stockId"),
         campaignIds: arrayOfObjects("campaign", "campaignId"),
         discountCodes: arrayOfObjects("campaign", "discountCodes"),
+        hasProduct: (productId, sizeId = null) => { const product = { productId }; if (sizeId) product.sizeId = sizeId; return { products: [ product ]}},
+        hasPackage: (orderHasPackage = true) => ({ packages: { orderHasPackageNumbers: orderHasPackage ? "y" : "n" }}),
+        fromAllegro: orderSource("allegro"),
+        fromEbay: orderSource("ebay"),
+        fromAmazon: orderSource("amazon"),
         page
     };
     return new Proxy(object, paramsProxy);

package/dist/methods/putClientsGiftcards.js

@@ -2,6 +2,11 @@ import { paramsProxy } from "../params.js";
 
 export default (object) => {
     object.gate = { method: 'put', node: '/clients/giftcards' }
+    object.custom = {
+        add: (amount, currency = "PLN") => ({ balance: { amount, currency }, balanceOperationType: "add" }),
+        subtract: (amount, currency = "PLN") => ({ balance: { amount, currency }, balanceOperationType: "subtract" }),
+        set: (amount, currency = "PLN") => ({ balance: { amount, currency }, balanceOperationType: "set" })
+    };
     object.appendable = {
         except: [],
         arrayNode: "giftCards",

package/dist/methods/putProductsDescriptions.js

@@ -1,7 +1,11 @@
 import { paramsProxy } from "../params.js";
+import { nest } from "../helpers.js";
 
 export default (object) => {
     object.gate = { method: 'put', node: '/products/descriptions' }
+    object.custom = {
+        productId: nest("identValue", "productIdent", {"productIdentType":"id"})
+    };
     object.appendable = {
         except: [],
         arrayNode: "products",

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}&`;

package/package.json

@@ -1,27 +1,27 @@
-{
-  "name": "idosell",
-  "version": "0.1.2",
-  "description": "Idosell 3 REST connector",
-  "main": "dist/index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/ltung7/idosell.git"
-  },
-  "keywords": [
-    "idosell",
-    "rest"
-  ],
-  "author": "Tung Le",
-  "license": "ISC",
-  "bugs": {
-    "url": "https://github.com/ltung7/idosell.git/issues"
-  },
-  "homepage": "https://github.com/ltung7/idosell.git",
-  "dependencies": {
-    "axios": "^1.6.2"
-  },
-  "type": "module"
-}
+{
+  "name": "idosell",
+  "version": "0.1.4",
+  "description": "Idosell 3 REST connector",
+  "main": "dist/index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ltung7/idosell.git"
+  },
+  "keywords": [
+    "idosell",
+    "rest"
+  ],
+  "author": "Tung Le",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/ltung7/idosell.git/issues"
+  },
+  "homepage": "https://github.com/ltung7/idosell.git",
+  "dependencies": {
+    "axios": "^1.6.2"
+  },
+  "type": "module"
+}

package/readme.md

@@ -315,6 +315,6 @@ const orderRequest = idosellRequest.getOrders.ordersSerialNumbers([123, 456, 789
 // Will return Object: { ordersSerialNumbers: [ 123, 456, 789 ] }
 ```
 
-## examples
+## Examples
 
-Read documentation and examples on [This page](https://idosell-converter.vercel.app/examples)
+Read documentation from this package and more examples on [This page](https://idosell-converter.vercel.app/examples)

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/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/listOrders.test.js

@@ -54,4 +54,9 @@ test("listOrdersHasPackage", () => {
 test("listOrdersShopIds", () => {
     const params = idosell().listOrders.shopIds([3]).getParams();
     expect(params).toEqual({"orderSource":{"shopsIds":[3]}});
+})
+
+test("listOrdersFromAllegro", () => {
+    const params = idosell().listOrders.fromAllegro().getParams();
+    expect(params).toEqual({"orderSource":{"auctionsParams":{"auctionsServicesNames":["allegro"]}}});
 })

package/tests/putClientsGiftcards.test.js

@@ -2,6 +2,16 @@ import idosell from "./dist/index.js"
 import { expect, test } from "vitest"
 
 test("putClientsGiftcardsName", () => {
-    const params = idosell().putClientsGiftcards.id(23).name("MyCard").getParams();
-    expect(params).toEqual({"giftCards":[{"id":23,"name":"MyCard"}]});
-})
+    const params = idosell().putClientsGiftcards.id(23).name("My Card").getParams();
+    expect(params).toEqual({"giftCards":[{"id":23,"name":"My Card"}]});
+})
+
+test("putClientsGiftcardsAdd", () => {
+    const params = idosell().putClientsGiftcards.id(23).add(10, "PLN").getParams();
+    expect(params).toEqual({"giftCards":[{"id":23,"balance":{"amount":10,"currency":"PLN"},"balanceOperationType":"add"}]});
+})
+
+test("putClientsGiftcardsMultiple", () => {
+    const params = idosell().putClientsGiftcards.id(23).set(100, "PLN").append().id(24).subtract(20).getParams();
+    expect(params).toEqual({"giftCards":[{"id":23,"balance":{"amount":100,"currency":"PLN"},"balanceOperationType":"set"},{"id":24,"balance":{"amount":20,"currency":"PLN"},"balanceOperationType":"subtract"}]});
+})

package/tests/putProductsDescriptions.test.js

@@ -1,7 +1,12 @@
 import idosell from "./dist/index.js"
 import { expect, test } from "vitest"
 
-test("putProductsDescriptionsProductDescriptionsLangData", () => {
-    const params = idosell().putProductsDescriptions.productIdent({"productIdentType":"id","identValue":"33"}).productDescriptionsLangData([{"langId":"pol","productName":"KrzesłoPavoN"}]).getParams();
-    expect(params).toEqual({"products":[{"productIdent":{"productIdentType":"id","identValue":"33"},"productDescriptionsLangData":[{"langId":"pol","productName":"KrzesłoPavoN"}]}]});
+test("putProductsDescriptionsProductIdent", () => {
+    const params = idosell().putProductsDescriptions.productIdent({"productIdentType":"id","identValue":"33"}).productDescriptionsLangData([{"langId":"pol","productName":"Krzesło Pavon"}]).getParams();
+    expect(params).toEqual({"products":[{"productIdent":{"productIdentType":"id","identValue":"33"},"productDescriptionsLangData":[{"langId":"pol","productName":"Krzesło Pavon"}]}]});
+})
+
+test("putProductsDescriptionsProductId", () => {
+    const params = idosell().putProductsDescriptions.productId(33).productDescriptionsLangData([{"langId": "pol","productName": "Krzesło Pavon"}]).getParams();
+    expect(params).toEqual({"products":[{"productIdent":{"productIdentType":"id","identValue":33},"productDescriptionsLangData":[{"langId":"pol","productName":"Krzesło Pavon"}]}]});
 })