idosell 0.4.25 → 0.4.30

package/dist/index.js

@@ -2,7 +2,7 @@ import ENUMS from "./enums.js";
 import utils from "./utils.js";
 import { gateProxy } from "./gates.js";
 import { IdosellFaultStringError, catchEmptyList } from "./errors.js";
-export const DEFAULT_VERSION = 7;
+export const DEFAULT_VERSION = 8;
 function normalizeUrl(input = "") {
     if (!input.length)
         return "";

package/dist/methods/getProductsAttachmentsGetContent.js

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

package/dist/methods/getProductsMarketingPromotion.js

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

package/dist/methods/getRegulationsHistory.js

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

package/dist/methods/postProductsMarketingPromotion.js

@@ -1,6 +1,7 @@
 import { paramsProxy } from "../params.js";
 export default (object) => {
     object.gate = { method: 'post', node: '/products/marketing/promotion' };
+    object.auth.version = 7;
     object.appendable = {
         except: ["promotionName", "shopsIds", "marketingZones", "newPriceSettings", "startDate", "endDate", "changeProductsToVisibleWhileStarting", "removeProductsAfterStockLevelRunsDown", "reduceBasingPrice", "calculationMethod"],
         arrayNode: "promotionElements",

package/dist/methods/postPromotions.js

@@ -2,6 +2,7 @@ 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/putClientsExternalCode.js

@@ -1,6 +1,12 @@
 import { paramsProxy } from "../params.js";
 export default (object) => {
     object.gate = { method: 'put', node: '/clients/externalCode' };
+    object.appendable = {
+        except: [],
+        arrayNode: "clients",
+        index: 0
+    };
     object.req = [{ "any": ["client_id", "client_login"] }];
+    object.arrays = ["clients"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/putProductsMarketingPromotion.js

@@ -1,6 +1,7 @@
 import { paramsProxy } from "../params.js";
 export default (object) => {
     object.gate = { method: 'put', node: '/products/marketing/promotion' };
+    object.auth.version = 7;
     object.appendable = {
         except: ["promotionId", "promotionName", "shopsIds", "marketingZones", "newPriceSettings", "startDate", "endDate", "changeProductsToVisibleWhileStarting", "removeProductsAfterStockLevelRunsDown", "reduceBasingPrice", "calculationMethod", "removeAllPromotionElements"],
         arrayNode: "promotionElements",

package/dist/reqparams.d.ts

@@ -325,50 +325,6 @@ export type PostProductsParams = {
         productPictures?: string[];
         /** @description List of photos descriptions */
         productDescriptionPictures?: string[];
-        /** @description Reduced price */
-        productPromotion?: {
-            /** @description Object determines if the promotion should be active.. Allowed values "y" - active promotion, "n" - inactive promotion. */
-            promoteInEnabled?: string;
-            /** @description Strikethrough price */
-            promoteItemNormalPrice?: number;
-            /** @description Strikethrough wholesale price */
-            promoteItemWholesaleNormalPrice?: number;
-            /** @description Switching off date */
-            promoteItemEndingDate?: string;
-        };
-        /** @description Discount for shop. */
-        productDiscount?: {
-            /** @description Object determines if the promotion should be active.. Allowed values "y" - active promotion, "n" - inactive promotion. */
-            promoteInEnabled?: string;
-            /** @description Strikethrough price */
-            promoteItemNormalPrice?: number;
-            /** @description Strikethrough wholesale price */
-            promoteItemWholesaleNormalPrice?: number;
-            /** @description Switching off date */
-            promoteItemEndingDate?: string;
-        };
-        /** @description Distinguished product in store. */
-        productDistinguished?: {
-            /** @description Object determines if the promotion should be active.. Allowed values "y" - active promotion, "n" - inactive promotion. */
-            promoteInEnabled?: string;
-            /** @description Strikethrough price */
-            promoteItemNormalPrice?: number;
-            /** @description Strikethrough wholesale price */
-            promoteItemWholesaleNormalPrice?: number;
-            /** @description Switching off date */
-            promoteItemEndingDate?: string;
-        };
-        /** @description Special product in store. */
-        productSpecial?: {
-            /** @description Object determines if the promotion should be active.. Allowed values "y" - active promotion, "n" - inactive promotion. */
-            promoteInEnabled?: string;
-            /** @description Strikethrough price */
-            promoteItemNormalPrice?: number;
-            /** @description Strikethrough wholesale price */
-            promoteItemWholesaleNormalPrice?: number;
-            /** @description Switching off date */
-            promoteItemEndingDate?: string;
-        };
         /** @description Parameters (distinguished). */
         productParametersDistinction?: {
             /** @description Parameter ID */
@@ -1094,66 +1050,6 @@ export type PutProductsParams = {
             /** @description A picture in url or base64 (depends on pictures_input_type). */
             productPictureSource?: string;
         }[];
-        /** @description Reduced price */
-        productPromotion?: {
-            /** @description Is attribute set */
-            promoteIsEnabled?: string;
-            /** @description Strikethrough price */
-            promoteItemNormalPrice?: number;
-            /** @description Net strikethrough price. */
-            promoteItemNormalPriceNet?: number;
-            /** @description Strikethrough wholesale price */
-            promoteItemWholesaleNormalPrice?: number;
-            /** @description Net wholesale strikethrough price. */
-            promoteItemWholesaleNormalPriceNet?: number;
-            /** @description Switching off date */
-            promoteItemEndingDate?: string;
-        };
-        /** @description Discount for shop. */
-        productDiscount?: {
-            /** @description Is attribute set */
-            promoteIsEnabled?: string;
-            /** @description Strikethrough price */
-            promoteItemNormalPrice?: number;
-            /** @description Net strikethrough price. */
-            promoteItemNormalPriceNet?: number;
-            /** @description Strikethrough wholesale price */
-            promoteItemWholesaleNormalPrice?: number;
-            /** @description Net wholesale strikethrough price. */
-            promoteItemWholesaleNormalPriceNet?: number;
-            /** @description Switching off date */
-            promoteItemEndingDate?: string;
-        };
-        /** @description Distinguished product in store. */
-        productDistinguished?: {
-            /** @description Is attribute set */
-            promoteIsEnabled?: string;
-            /** @description Strikethrough price */
-            promoteItemNormalPrice?: number;
-            /** @description Net strikethrough price. */
-            promoteItemNormalPriceNet?: number;
-            /** @description Strikethrough wholesale price */
-            promoteItemWholesaleNormalPrice?: number;
-            /** @description Switching off date */
-            promoteItemEndingDate?: string;
-            /** @description Net wholesale strikethrough price. */
-            promoteItemWholesaleNormalPriceNet?: number;
-        };
-        /** @description Special product in store. */
-        productSpecial?: {
-            /** @description Is attribute set */
-            promoteIsEnabled?: string;
-            /** @description Strikethrough price */
-            promoteItemNormalPrice?: number;
-            /** @description Net strikethrough price. */
-            promoteItemNormalPriceNet?: number;
-            /** @description Strikethrough wholesale price */
-            promoteItemWholesaleNormalPrice?: number;
-            /** @description Net wholesale strikethrough price. */
-            promoteItemWholesaleNormalPriceNet?: number;
-            /** @description Switching off date */
-            promoteItemEndingDate?: string;
-        };
         /** @description Parameters (distinguished). */
         productParametersDistinction?: {
             /** @description Parameter ID */
@@ -6512,12 +6408,15 @@ export type PostDiscountsRebatesCodeParams = {
 };
 
 export type PutClientsExternalCodeParams = {
-    /** @example 1 */
-    client_id?: number;
-    /** @description Customer's login. */
-    client_login?: string;
-    /** @description External system code. */
-    code_extern?: string;
+    /** @description Customer data. */
+    clients: {
+        /** @example 1 */
+        client_id?: number;
+        /** @description Customer's login. */
+        client_login?: string;
+        /** @description External system code. */
+        code_extern?: string;
+    }[];
 };
 
 export type PutClientsGiftcardsParams = {
@@ -7154,4 +7053,176 @@ 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 type GetProductsAttachmentsGetContentParams = {
+    /** @description - product identifier value */
+    productIdentValue: string;
+    /** @description - product identifier type */
+    productIdentType: "codeExtern" | "codeProducer" | "index" | "id";
+    /** @description - product attachment ID */
+    attachmentId: number;
+};
+
 export { };

package/dist/request.js

@@ -71,6 +71,8 @@ const checkNext = (request, response, logPage) => {
         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);
     }

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;
@@ -989,7 +992,7 @@ export type GetConfigVariablesResponse = {
         /** @description Key of config value. */
         key: string;
         /** @description Name of config item. */
-        readonly name: string;
+        name: string;
         /** @description Value of config item. */
         value: string;
     } & {
@@ -1009,7 +1012,7 @@ export type PutConfigVariablesResponse = {
             /** @description Key of config value. */
             key: string;
             /** @description Name of config item. */
-            readonly name?: string;
+            name?: string;
             /** @description Value of config item. */
             value: string;
         } & {
@@ -1182,9 +1185,9 @@ export type GetCpaCampaignResponse = {
         /** @description Whether the snippet is active */
         active: "y" | "n";
         /** @description Number of CPA programs associated with the campaign. */
-        readonly cpaCount: number | null;
+        cpaCount: number | null;
         /** @description Number of active CPA programs associated with the campaign. */
-        readonly activeCpaCount: number | null;
+        activeCpaCount: number | null;
     }[];
     pagination: PagedResponse;
 };
@@ -3490,6 +3493,8 @@ export type PutProductsMarketingZonesResponse = {
 export type GetProductsOmnibusPricesResponse = {
     /** @description Products list. */
     products: never[] | Record<string, {
+        /** @description Product ID */
+        productId: number;
         shops: never[] | Record<string, {
             /** @description Shop Id */
             shop_id: number;
@@ -6248,18 +6253,18 @@ export type GetSnippetsCampaignResponse = {
         /** @description Whether the snippet is active */
         active: "y" | "n";
         /** @description Whether the snippet campaign is deleted */
-        readonly deleted: "y" | "n";
+        deleted: "y" | "n";
         /** @description Snippet order. */
         order: number;
         /** @description Number of code snippets associated with the campaign. */
-        readonly snippetCount: number | null;
+        snippetCount: number | null;
         /** @description Number of active code snippets associated with the campaign. */
-        readonly activeSnippetCount: number | null;
+        activeSnippetCount: number | null;
         configVariables: {
             /** @description Key of config value. */
             key: string;
             /** @description Name of config item. */
-            readonly name: string;
+            name: string;
             /** @description Value of config item. */
             value: string;
         }[];
@@ -6428,9 +6433,9 @@ export type GetSnippetsResponse = {
             } | null;
         };
         /** @description Whether the snippet is marked as deleted. */
-        readonly deleted: "y" | "n";
+        deleted: "y" | "n";
         /** @description The number of cookies associated with the snippet. */
-        readonly cookiesCount: number;
+        cookiesCount: number;
     }[];
     pagination: PagedResponse;
 };
@@ -9146,4 +9151,148 @@ 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: {
+        id: number;
+        date: string;
+        login: string;
+        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 type GetRegulationsHistoryResponse = {
+    results: {
+        /** @description Document's type */
+        type: string;
+        /** @description Language ISO code. */
+        langId: string;
+        /** @description Shop ID. */
+        shopId: number;
+        /** @description Content. */
+        content: string;
+        /** @description Creation time. */
+        creationTime: number;
+        /** @description User. */
+        user: string;
+        /** @description Change type. */
+        changeType: "auto" | "user";
+        /** @description Change source (y - auto, m - markdown editor, n - WYSIWYG/HTML editor). */
+        isDefault: "y" | "m" | "n";
+        /** @description Setting to check if revision was published in shop. */
+        wasPublished: number;
+        /** @description 2-letter ISO country code. */
+        country: string;
+    }[];
+    pagination: {
+        /** @description Pagination settings. */
+        appliedFilter: {
+            /** @description Page index (starting from 0)
+             * @default 0 */
+            page: number;
+            /** @description Number of records per page.
+             * @default 100 */
+            perPage: number;
+        };
+    };
+};
+
 export { };

package/package.json

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

package/tests/getProductsAttachmentsGetContent.test.js

@@ -0,0 +1,7 @@
+import idosell from "./dist/index.ts"
+import { expect, test } from "vitest"
+
+test("getProductsAttachmentsGetContentAttachmentId", () => {
+    const params = idosell().getProductsAttachmentsGetContent.productIdentType("id").productIdentValue("294").attachmentId(5).checkParams();
+    expect(params).toEqual({"productIdentType":"id","productIdentValue":"294","attachmentId":5});
+})

package/tests/postPromotions.test.js

@@ -0,0 +1,7 @@
+import idosell from "./dist/index.ts"
+import { expect, test } from "vitest"
+
+test("postPromotionsName", () => {
+    const params = idosell().postPromotions.activeInShops([1]).newPriceValue({ "value": "5" }).name("Promo").checkParams();
+    expect(params).toEqual({"activeInShops":[1],"newPriceValue":{"value":"5"},"name":"Promo"});
+})

package/tests/putClientsExternalCode.test.js

@@ -1,7 +1,7 @@
-import idosell from "./dist/index"
+import idosell from "./dist/index.ts"
 import { expect, test } from "vitest"
 
 test("putClientsExternalCodeCode_extern", () => {
-    const params = idosell().putClientsExternalCode.client_login("iai_demo").code_extern("abc").checkParams();
-    expect(params).toEqual({"client_login":"iai_demo","code_extern":"abc"});
+    const params = idosell().putClientsExternalCode.client_id(10).code_extern("vip10").checkParams();
+    expect(params).toEqual({"clients":[{"client_id":10,"code_extern":"vip10"}]});
 })