idosell 0.4.24 → 0.4.27

package/dist/methods/deletePromotionsArchive.js

@@ -0,0 +1,6 @@
+import { paramsProxy } from "../params.js";
+export default (object) => {
+    object.gate = { method: 'delete', node: '/promotions/promotionsArchive/delete' };
+    object.req = ["promotionId"];
+    return new Proxy(object, paramsProxy);
+};

package/dist/methods/deletePromotionsElements.js

@@ -0,0 +1,13 @@
+import { paramsProxy } from "../params.js";
+export default (object) => {
+    object.gate = { method: 'post', node: '/promotions/elements/remove' };
+    object.rootparams = "request";
+    object.appendable = {
+        except: [],
+        arrayNode: "elements",
+        index: 0
+    };
+    object.req = ["promotionId", "type", "id"];
+    object.arrays = ["elements"];
+    return new Proxy(object, paramsProxy);
+};

package/dist/methods/getPromotions.js

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

package/dist/methods/getPromotionsArchive.js

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

package/dist/methods/getPromotionsSettings.js

@@ -0,0 +1,5 @@
+import { paramsProxy } from "../params.js";
+export default (object) => {
+    object.gate = { method: 'get', node: '/promotions/settings/get' };
+    return new Proxy(object, paramsProxy);
+};

package/dist/methods/postPromotions.js

@@ -0,0 +1,8 @@
+import { paramsProxy } from "../params.js";
+export default (object) => {
+    object.gate = { method: 'post', node: '/promotions/promotions/add' };
+    object.rootparams = "request";
+    object.req = ["activeInShops", "newPriceValue", "name"];
+    object.arrays = ["activeInShops", "types"];
+    return new Proxy(object, paramsProxy);
+};

package/dist/methods/postPromotionsElements.js

@@ -0,0 +1,13 @@
+import { paramsProxy } from "../params.js";
+export default (object) => {
+    object.gate = { method: 'post', node: '/promotions/elements/add' };
+    object.rootparams = "request";
+    object.appendable = {
+        except: [],
+        arrayNode: "elements",
+        index: 0
+    };
+    object.req = ["promotionId", "id", "type"];
+    object.arrays = ["elements"];
+    return new Proxy(object, paramsProxy);
+};

package/dist/methods/postPromotionsEnd.js

@@ -0,0 +1,7 @@
+import { paramsProxy } from "../params.js";
+export default (object) => {
+    object.gate = { method: 'post', node: '/promotions/promotions/end' };
+    object.rootparams = true;
+    object.req = ["promotionId"];
+    return new Proxy(object, paramsProxy);
+};

package/dist/methods/postPromotionsStart.js

@@ -0,0 +1,7 @@
+import { paramsProxy } from "../params.js";
+export default (object) => {
+    object.gate = { method: 'post', node: '/promotions/promotions/start' };
+    object.rootparams = true;
+    object.req = ["promotionId"];
+    return new Proxy(object, paramsProxy);
+};

package/dist/methods/putPromotions.js

@@ -0,0 +1,8 @@
+import { paramsProxy } from "../params.js";
+export default (object) => {
+    object.gate = { method: 'put', node: '/promotions/promotions/edit' };
+    object.rootparams = "request";
+    object.req = ["promotionId"];
+    object.arrays = ["activeInShops", "types"];
+    return new Proxy(object, paramsProxy);
+};

package/dist/methods/putPromotionsSettings.js

@@ -0,0 +1,6 @@
+import { paramsProxy } from "../params.js";
+export default (object) => {
+    object.gate = { method: 'put', node: '/promotions/settings/set' };
+    object.rootparams = "request";
+    return new Proxy(object, paramsProxy);
+};

package/dist/methods/searchPromotionsArchive.js

@@ -0,0 +1,14 @@
+import { paramsProxy } from "../params.js";
+import { orderByProperty, paginationObject, nest } from "../helpers.js";
+export default (object) => {
+    object.gate = { method: 'post', node: '/promotions/promotionsArchive/list' };
+    object.rootparams = "request";
+    object.custom = {
+        orderByProperty,
+        page: paginationObject,
+        shops: nest("shops", "filter", {}, true),
+        archivedDate: nest("archivedDate", "filter", {}, false)
+    };
+    object.paginationObject = true;
+    return new Proxy(object, paramsProxy);
+};

package/dist/methods/searchPromotionsElements.js

@@ -0,0 +1,15 @@
+import { paramsProxy } from "../params.js";
+import { orderByProperty, paginationObject, nest } from "../helpers.js";
+export default (object) => {
+    object.gate = { method: 'post', node: '/promotions/elements/list' };
+    object.rootparams = "request";
+    object.custom = {
+        orderByProperty,
+        page: paginationObject,
+        ids: nest("ids", "filter", {}, true),
+        types: nest("types", "filter", {}, true),
+        promotionIds: nest("promotionIds", "filter", {}, true)
+    };
+    object.paginationObject = true;
+    return new Proxy(object, paramsProxy);
+};

package/dist/methods/searchPromotionsHistory.js

@@ -0,0 +1,13 @@
+import { paramsProxy } from "../params.js";
+import { paginationObject, nest } from "../helpers.js";
+export default (object) => {
+    object.gate = { method: 'post', node: '/promotions/history/get' };
+    object.rootparams = "request";
+    object.custom = {
+        page: paginationObject,
+        promotionId: nest("promotionId", "filter", {}, false)
+    };
+    object.paginationObject = true;
+    object.req = ["filter"];
+    return new Proxy(object, paramsProxy);
+};

package/dist/methods/searchPromotionsListView.js

@@ -0,0 +1,21 @@
+import { paramsProxy } from "../params.js";
+import { orderByProperty, paginationObject, nest } from "../helpers.js";
+export default (object) => {
+    object.gate = { method: 'post', node: '/promotions/promotions/listView/list' };
+    object.rootparams = "request";
+    object.custom = {
+        orderByProperty,
+        page: paginationObject,
+        ids: nest("ids", "filter", {}, true),
+        name: nest("name", "filter", {}, false),
+        changeVisibility: nest("changeVisibility", "filter", {}, false),
+        activeInShops: nest("activeInShops", "filter", {}, true),
+        types: nest("types", "filter", {}, true),
+        priceTypes: nest("priceTypes", "filter", {}, true),
+        statuses: nest("statuses", "filter", {}, true),
+        dateRange: nest("dateRange", "filter", {}, false),
+        productsNotInPromotion: nest("productsNotInPromotion", "filter", {}, true)
+    };
+    object.paginationObject = true;
+    return new Proxy(object, paramsProxy);
+};

package/dist/params.js

@@ -13,6 +13,19 @@ const requests = {
         return receiver;
     }
 };
+function deepAssignSecondLevel(target, source) {
+    for (const key of Object.keys(source)) {
+        if (key in target &&
+            typeof target[key] === 'object' && target[key] !== null &&
+            typeof source[key] === 'object' && source[key] !== null) {
+            Object.assign(target[key], source[key]);
+        }
+        else {
+            target[key] = source[key];
+        }
+    }
+    return target;
+}
 export const paramsProxy = {
     get: (object, property, receiver) => {
         if (property === 'then') {
@@ -48,7 +61,8 @@ export const paramsProxy = {
                     values = [values[0] ?? 0, values[1] ?? 100, Boolean(object.snakeCase)];
                 }
                 const param = object.custom[property](...values);
-                Object.assign(object.params, param);
+                if (param)
+                    deepAssignSecondLevel(object.params, param);
             }
             else if (object.arrays && object.arrays.includes(property)) {
                 if (Array.isArray(values[0]))

package/dist/reqparams.d.ts

@@ -6312,7 +6312,7 @@ export type PostPackagesParams = {
     }[];
 };
 
-export type PostProductsProductsToFacebookCatalogParams = {
+export type PostProductsToFacebookCatalogParams = {
     /** @description You can read the Facebook Catalog ID in the Marketing & Integrations/Facebook/Facebook Product Catalog admin panel */
     facebookCatalogId?: number;
     /** @description Shop Id */
@@ -6321,7 +6321,7 @@ export type PostProductsProductsToFacebookCatalogParams = {
     products?: number[];
 };
 
-export type PostProductsProductsToPromotionParams = {
+export type PostProductsToPromotionParams = {
     /** @description Special offer ID */
     promotionId?: number;
     /** @description Products list. */
@@ -7154,4 +7154,167 @@ export type PutWmsStocksdocumentsAcceptMMParams = {
     id: number;
 };
 
+export type PromotionIdParams = {
+    /** @description ID of promotion */
+    promotionId: number;
+};
+
+type PaginationParam = {
+    /** @description Page index (starting from 0)
+     * @default 0 */
+    page?: number;
+    /** @description Number of records per page.
+     * @default 100 */
+    perPage?: number;
+};
+
+type DateRangeParam = {
+    /** Format: date
+     * @description Date "from" (RFC) */
+    from?: string | null;
+    /** Format: date
+     * @description Date "to" (RFC) */
+    to?: string | null;
+} | null;
+
+type PromotionBody = {
+    /** @description Promotion name */
+    name?: string;
+    /** @description Promotion zones */
+    types?: ("promotion" | "special" | "discount" | "distinguished" | "bestseller" | "new")[];
+    /** @description Promotion start datetime */
+    startTime?: string;
+    /** @description Promotion end datetime */
+    endTime?: string;
+    /** @description Change visibility */
+    changeVisibility?: boolean;
+    /** @description Auto unpin */
+    autoUnpin?: boolean;
+    /** @description Auto unpin own stocks */
+    autoUnpinOwnStocks?: boolean;
+    /** @description Price type */
+    priceType?: "retail" | "wholesale" | "pos";
+    /** @description Currency */
+    currency?: string;
+    /** @description Discount type */
+    newPriceDiscountType?: "percent" | "minus" | "set";
+    /** @description New price round */
+    newPriceRound?: "whole" | "first" | "second";
+    /** @description New price end */
+    newPriceEnd?: number;
+    /** @description Net or gross */
+    netGross?: "gross" | "net";
+    /** @description Charge type */
+    chargeType?: "lowest" | "sum";
+    /** @description Enable in marketplaces */
+    enableInMarketplaces?: "y" | "n" | "yes_for_dynamic_pricing_products";
+    /** @description Status */
+    status?: "waiting" | "active" | "closed";
+};
+
+export type PostPromotionsParams = PromotionBody & {
+    /** @description Array of shop ids */
+    activeInShops: number[];
+    /** @description A representation of a floating-point number with precise accuracy. */
+    newPriceValue: { value: string };
+};
+
+export type PutPromotionsParams = PromotionBody & PromotionIdParams & {
+    /** @description Array of shop ids */
+    activeInShops?: number[];
+    /** @description A representation of a floating-point number with precise accuracy. */
+    newPriceValue?: { value: string };
+};
+
+type PromotionElementsBody = {
+    /** @description Array of PromotionElement objects */
+    elements: {
+        /** @description ID */
+        id: string;
+        /** @description Promotion element type */
+        type: "product" | "series" | "producer" | "category" | "menu";
+        /** @description Promotion ID */
+        promotionId: number;
+    }[];
+};
+
+export type PostPromotionsElementsParams = PromotionElementsBody;
+export type DeletePromotionsElementsParams = PromotionElementsBody;
+
+export type SearchPromotionsHistoryParams = {
+    filter: {
+        /** @description Promotion ID */
+        promotionId: number;
+    };
+    pagination?: PaginationParam;
+};
+
+export type SearchPromotionsElementsParams = {
+    /** @example {"types": ["category", "series"], "ids": ["213"], "promotionIds": [534]} */
+    filter?: {
+        /** @description Elements IDs */
+        ids?: string[];
+        /** @description Element types */
+        types?: ("product" | "series" | "producer" | "category" | "menu")[];
+        /** @description Promotion IDs */
+        promotionIds?: number[];
+    };
+    pagination?: PaginationParam;
+    orderBy?: {
+        /** @default promotion_id */
+        property?: "promotion_id" | "type" | "element_id";
+        /** @default desc */
+        orderByDirection?: "asc" | "desc";
+    };
+};
+
+export type SearchPromotionsListViewParams = {
+    filter?: {
+        ids?: number[] | null;
+        name?: string;
+        changeVisibility?: boolean;
+        /** @description Array of shop ids */
+        activeInShops?: number[];
+        types?: ("promotion" | "special" | "discount" | "distinguished" | "bestseller" | "new")[];
+        priceTypes?: ("retail" | "wholesale" | "pos")[];
+        statuses?: ("waiting" | "active" | "closed")[];
+        dateRange?: DateRangeParam;
+        productsNotInPromotion?: number[] | null;
+    };
+    pagination?: PaginationParam;
+    orderBy?: {
+        /** @default id */
+        property?: "id" | "name" | "start_time" | "end_time" | "new_price_value" | "new_price_end" | "elements_modification_date";
+        /** @default desc */
+        orderByDirection?: "asc" | "desc";
+    };
+};
+
+export type SearchPromotionsArchiveParams = {
+    filter?: {
+        shops?: number[];
+        archivedDate?: DateRangeParam;
+    };
+    pagination?: PaginationParam;
+    orderBy?: {
+        /** @default id */
+        property?: "id" | "shop_mask" | "archived_date";
+        /** @default desc */
+        orderByDirection?: "asc" | "desc";
+    };
+};
+
+export type PutPromotionsSettingsParams = {
+    daysLeftToArchive?: number;
+    daysLeftToRemove?: number;
+    showPriceOnProductsList?: number;
+    automaticallySuggestDefaultStartDate?: "on" | "off";
+    automaticallySuggestDefaultEndDate?: "on" | "off";
+    defaultStartDate?: number;
+    defaultEndDate?: number;
+    defaultStartTime?: number;
+    defaultEndTime?: number;
+    daysLeftToClose?: number;
+};
+
 export { };

package/dist/request.js

@@ -16,9 +16,20 @@ const catchIdosellError = (err) => {
     if (!err.response.headers['x-error'] && err.response.headers['content-type'].indexOf('json') < 0)
         throw new Error('500: Invalid response from Api gateway');
     let message = err.response.headers['x-error'];
-    for (const [search, replace] of DECODE_TABLE) {
-        message = message.replaceAll(search, replace);
+    if (err.response?.data?.errors) {
+        let errorObj = err.response?.data?.errors;
+        if (Array.isArray(errorObj))
+            errorObj = errorObj[0];
+        if (errorObj.message)
+            message = errorObj.message;
+    }
+    if (message) {
+        for (const [search, replace] of DECODE_TABLE) {
+            message = message.replaceAll(search, replace);
+        }
     }
+    else
+        message = 'Unknown error';
     if (err.response.status === 403) {
         const match = message.match(/Scope: ([a-z]+), level: ([rw]{1,2})/);
         if (match) {
@@ -41,17 +52,30 @@ const checkNext = (request, response, logPage) => {
         };
         throw new IdosellFaultStringError(response.errors.faultString, faultStructure);
     }
+    function handlePagination(currentPage, totalPages, request, paramsUpdate) {
+        request.next = currentPage + 1 < totalPages;
+        if (paramsUpdate)
+            Object.assign(request.params, paramsUpdate);
+        if (typeof logPage === 'function') {
+            logPage('Page: ' + currentPage + ' / ' + totalPages);
+        }
+    }
     if (response.resultsNumberPage) {
-        request.next = response.resultsPage + 1 < response.resultsNumberPage;
-        request.params.resultsPage = request.params.resultsPage ? request.params.resultsPage + 1 : 1;
-        if (logPage)
-            logPage('Page: ' + response.resultsPage + ' / ' + response.resultsNumberPage);
+        handlePagination(response.resultsPage, response.resultsNumberPage, request, { resultsPage: response.resultsPage + 1 });
     }
     else if (response.results_number_page) {
-        request.next = response.results_page + 1 < response.results_number_page;
-        request.params.results_page = request.params.results_page ? request.params.results_page + 1 : 1;
-        if (logPage)
-            logPage('Page: ' + response.results_page + ' / ' + response.results_page);
+        handlePagination(response.results_page, response.results_number_page, request, { results_page: response.results_page + 1 });
+    }
+    else if (response.pagination) {
+        console.log({ rp: request.params, qp: response.pagination });
+        request.params.pagination.page = response.pagination.resultsPage + 1;
+        handlePagination(response.pagination.resultsPage, response.pagination.resultsNumberPage, request);
+    }
+    else if (response.data?.pagination) {
+        if (!request.params.pagination)
+            request.params.pagination = {};
+        request.params.pagination.page = response.data.pagination.resultsPage + 1;
+        handlePagination(response.data.pagination.resultsPage, response.data.pagination.resultsNumberPage, request);
     }
     return response;
 };
@@ -190,6 +214,8 @@ export const countResults = async (request, options) => {
         return 0;
     if (request.snakeCase)
         return parseInt(response.results_number_all);
+    else if (request.paginationObject)
+        return response.pagination.resultsNumberAll;
     else
         return response.resultsNumberAll;
 };

package/dist/responses.d.ts

@@ -20,6 +20,9 @@ type PagedSnakecaseResponse = {
     results_limit: number;
 };
 
+type PaginatedResponse = {
+    pagination: PagedResponse
+}
 type FaultCodeString = {
     /** @description Error code. */
     faultCode: number;
@@ -9146,4 +9149,112 @@ export type GetOrdersResponse = {
     }[];
 };
 
+type PromotionErrorEntry = {
+    /** @description Error code. */
+    code: string;
+    /** @description Field associated with the error. */
+    field: string | null;
+    /** @description Error description. */
+    message: string | null;
+    /** @description Value associated with the error. */
+    value: string | null;
+    /** @description Unique identifier of the error (for support). */
+    uid: string | null;
+};
+
+type PromotionApiResponse<T> = {
+    data: T;
+    isError: boolean;
+    errors: PromotionErrorEntry[];
+};
+
+type PromotionData = {
+    /** @description ID of promotion */
+    promotionId: number;
+    name: string;
+    /** @description Array of shop ids */
+    activeInShops: number[];
+    types: ("promotion" | "special" | "discount" | "distinguished" | "bestseller" | "new")[];
+    startTime: string;
+    endTime: string;
+    changeVisibility: boolean;
+    autoUnpin: boolean;
+    autoUnpinOwnStocks: boolean;
+    priceType: "retail" | "wholesale" | "pos";
+    /** @description A representation of a floating-point number with precise accuracy. */
+    newPriceValue: { value: string };
+    currency: string;
+    newPriceDiscountType: "percent" | "minus" | "set";
+    newPriceRound: "whole" | "first" | "second";
+    newPriceEnd: number;
+    netGross: "gross" | "net";
+    chargeType: "lowest" | "sum";
+    enableInMarketplaces: "y" | "n" | "yes_for_dynamic_pricing_products";
+    status: "waiting" | "active" | "closed";
+    elementsModificationDate: string | null;
+    /** @description Promotion archive datetime — optional in list/get, required in archive */
+    archivedDate?: string | null;
+    /** @description Promotion elements count e.g. { "products": 1 } */
+    elementsCount: Record<string, number>;
+    elements?: unknown[];
+};
+
+type PromotionArchiveData = Omit<PromotionData, "archivedDate" | "elementsCount" | "elements"> & {
+    archivedDate: string | null;
+    elementsCount: Record<string, never>;
+    elements: unknown[];
+};
+
+export type SearchPromotionsHistoryResponse = PromotionApiResponse<{
+    list: {
+        readonly id: number;
+        readonly date: string;
+        readonly login: string;
+        readonly description: string;
+    }[];
+    pagination: PagedResponse;
+}>;
+
+export type SearchPromotionsElementsResponse = PromotionApiResponse<{
+    list: {
+        id: string;
+        type: "product" | "series" | "producer" | "category" | "menu";
+        name: string;
+        promotionId: number;
+        /** @description Correlated elements id */
+        correlatedElementsId?: number[];
+    }[];
+    pagination: PagedResponse;
+}>;
+
+export type SearchPromotionsListViewResponse = PromotionApiResponse<{
+    list: PromotionData[];
+    pagination: PagedResponse;
+}>;
+
+export type SearchPromotionsArchiveResponse = PromotionApiResponse<{
+    list: PromotionArchiveData[];
+    pagination: PagedResponse;
+}>;
+
+export type GetPromotionsResponse = PromotionApiResponse<PromotionData>;
+export type GetPromotionsArchiveResponse = PromotionApiResponse<PromotionArchiveData>;
+
+export type GetPromotionsSettingsResponse = PromotionApiResponse<{
+    daysLeftToArchive: number;
+    daysLeftToRemove: number;
+    showPriceOnProductsList: number;
+    automaticallySuggestDefaultStartDate: "on" | "off";
+    automaticallySuggestDefaultEndDate: "on" | "off";
+    defaultStartDate: number;
+    defaultEndDate: number;
+    defaultStartTime: number;
+    defaultEndTime: number;
+    daysLeftToClose: number;
+}>;
+
+export type PromotionIdResponse = PromotionApiResponse<number>;
+
+export type PromotionBoolResponse = PromotionApiResponse<boolean | null>;
+
 export { };

package/package.json

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

package/tests/deleteProductsToFacebookCatalog.test.js

@@ -0,0 +1,7 @@
+import idosell from "./dist/index"
+import { expect, test } from "vitest"
+
+test("deleteProductsToFacebookCatalogFacebookCatalogId", () => {
+    const params = idosell().deleteProductsToFacebookCatalog.shopId(1).products([9]).facebookCatalogId(123).checkParams();
+    expect(params).toEqual({"shopId":1,"products":[9],"facebookCatalogId":123});
+})

package/tests/deleteProductsToPromotion.test.js

@@ -0,0 +1,7 @@
+import idosell from "./dist/index"
+import { expect, test } from "vitest"
+
+test("deleteProductsToPromotionProducts", () => {
+    const params = idosell().deleteProductsToPromotion.promotionId(2).products([11]).checkParams();
+    expect(params).toEqual({"promotionId":2,"products":[11]});
+})

package/tests/deletePromotions.test.js

@@ -0,0 +1,7 @@
+import idosell from "./dist/index.ts"
+import { expect, test } from "vitest"
+
+test("deletePromotionsPromotionId", () => {
+    const params = idosell().deletePromotions.promotionId(123).checkParams();
+    expect(params).toEqual({"promotionId":123});
+})

package/tests/deletePromotionsArchive.test.js

@@ -0,0 +1,7 @@
+import idosell from "./dist/index.ts"
+import { expect, test } from "vitest"
+
+test("deletePromotionsArchivePromotionId", () => {
+    const params = idosell().deletePromotionsArchive.promotionId(123).checkParams();
+    expect(params).toEqual({"promotionId":123});
+})

package/tests/deletePromotionsElements.test.js

@@ -0,0 +1,7 @@
+import idosell from "./dist/index.ts"
+import { expect, test } from "vitest"
+
+test("deletePromotionsElementsId", () => {
+    const params = idosell().deletePromotionsElements.promotionId(4).type("product").id("288").checkParams();
+    expect(params).toEqual({"elements":[{"promotionId":4,"type":"product","id":"288"}]});
+})

package/tests/getProductsToFacebookCatalog.test.js

@@ -0,0 +1,8 @@
+import idosell from "./dist/index"
+import { expect, test } from "vitest"
+
+
+test("getProductsToFacebookCatalogFacebookCatalogId", () => {
+    const params = idosell().getProductsToFacebookCatalog.shopId(1).facebookCatalogId(123).checkParams();
+    expect(params).toEqual({"shopId":1,"facebookCatalogId":123});
+})

package/tests/getPromotions.test.js

@@ -0,0 +1,7 @@
+import idosell from "./dist/index.ts"
+import { expect, test } from "vitest"
+
+test("getPromotionsPromotionId", () => {
+    const params = idosell().getPromotions.promotionId(123).checkParams();
+    expect(params).toEqual({"promotionId":123});
+})

package/tests/getPromotionsArchive.test.js

@@ -0,0 +1,7 @@
+import idosell from "./dist/index.ts"
+import { expect, test } from "vitest"
+
+test("getPromotionsArchivePromotionId", () => {
+    const params = idosell().getPromotionsArchive.promotionId(123).checkParams();
+    expect(params).toEqual({"promotionId":123});
+})