idosell 0.4.20 → 0.4.24

package/README.md

@@ -4,6 +4,8 @@ This package wraps around the Idosell REST Api to make it easier to use by imple
 
 Visit [This page](https://idosell-converter.vercel.app/) for more detailed usage and examples.
 
+[![npm version](https://img.shields.io/npm/v/idosell.svg)](https://www.npmjs.com/package/idosell)
+
 ## Basic use
 
 Package translates awkward gate names into more readable method names using REST verbs and gateways. Most of the possible methods are kept as is, only changed to camel case. For example:
@@ -15,7 +17,7 @@ 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. 
-**API_VERSION** version of the API to call, current default version is **v6**
+**API_VERSION** version of the API to call, current default version is **v7**
 Here are some examples:
 ```
 https://yourdomain.com

package/changelog.md

@@ -5,12 +5,25 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.4.24] - 2025-03-21
+### Changed
+- Updated to v7.13
+- Fixed url format
+
+## [0.4.23] - 2025-03-11
+### Changed
+- Added custom error class
+- Fixed types for ids that can be integer instead of string
+- Changed types of execution options, this allows custom logs
+
 ## [0.4.20] - 2025-12-18
+### Changed
 - Added indexing option for utils functions
 - Fixed typings and tests
 - Added descriptions
 
 ## [0.4.18] - 2025-12-18
+### Changed
 - Updated to v7.10
 - Updated utils
 - Fixed dates helper default value

package/dist/app.d.ts

@@ -1,7 +1,13 @@
+export interface ExecutableDumpParams {
+	url: string;
+	method: string;
+	params: Record<string,any>;
+}
+
 export interface ExecutableOptions {
-	log?: boolean,
-    dump?: boolean,
-    logPage?: boolean,
+	log?: boolean | ((obj: ExecutableDumpParams) => void),
+    dump?: boolean | ((obj: ExecutableDumpParams) => void),
+    logPage?: boolean | ((text: string) => void),
 	skipCheck?: boolean
 }
 
@@ -32,12 +38,13 @@ export type GatewayRequestProxyObject = {
 		arrayNode: string,
 		except: string[]
 	},
-	custom?: Record<string,Function>,
+	custom?: Record<string,(..._: any) => false|Record<string,any>>,
 	snakeCase?: boolean,
 	next?: boolean,
 	rootparams?: string|boolean,
 	arrays?: string[],
 	req?: RequirementType[],
+	n?: Record<string,number>,
 } & RequestProxyObject;
 
 export interface Gateway<R = JSObject, P = JSObject> {
@@ -91,4 +98,9 @@ export interface AppendableGateway<T,R = JSObject, P = JSObject> extends Gateway
 	append: () => T
 }
 
-export {};
+export interface IdosellErrorFaultStructure {
+	faultCode: number;
+	faultString: string;
+}
+
+export {};

package/dist/errors.js

@@ -0,0 +1,16 @@
+export class IdosellFaultStringError extends Error {
+    cause;
+    constructor(message, cause) {
+        super(message);
+        this.name = 'IdosellFaultStringError';
+        this.cause = cause;
+    }
+}
+export function catchEmptyList(defaultValue) {
+    return (err) => {
+        if (err?.cause?.faultCode === 2) {
+            return defaultValue;
+        }
+        throw err;
+    };
+}

package/dist/gateways.d.ts

@@ -1,10 +1,18 @@
 /* eslint-disable @typescript-eslint/no-empty-object-type */
-import type { PagableGateway, AppendableGateway, Gateway, DateLike, JSObject } from "./app.d.ts"
+import type { PagableGateway, AppendableGateway, Gateway, DateLike, JSObject, IdosellErrorFaultStructure } from "./app.d.ts"
 import type { GetClientsBalanceResponse, BooleanStatusResponse, GetClientsResponse, PostClientsResponse, PutClientsResponse, SearchClientsCrmResponse, GetClientsDeliveryAddressResponse, PostClientsDeliveryAddressResponse, PutClientsDeliveryAddressResponse, VouchersResponse, PutVouchersResponse, SearchClientsGiftcardsResponse, GetClientsGiftcardsTypesResponse, GetClientsMembershipCardsResponse, PutClientsMembershipCardsResponse, SearchClientsNewsletterEmailResponse, SearchClientsNewsletterSmsResponse, GetClientsPayerAddressResponse, PostClientsPayerAddressResponse, PutClientsPayerAddressResponse, GetClientsPricelistsClientsResponse, PutClientsPricelistsClientsResponse, GetClientsPricelistsResponse, PostClientsPricelistsResponse, GetClientsPricelistsProductsResponse, PutClientsPricelistsProductsResponse, GetClientsPricesActiveCardResponse, GetClientsPricesDiscountGroupsResponse, GetClientsPricesDiscountsResponse, PutClientsPricesDiscountsResponse, GetClientsProfitPointsResponse, GetClientsProvinceListResponse, GetClientsTagsResponse, PostClientsTagsResponse, PutClientsTagsResponse, GetConfigVariablesResponse, PutConfigVariablesResponse, GetCouriersAssignedToShippingProfilesResponse, GetCouriersResponse, GetCouriersPickupPointsResponse, PutCouriersPickupPointsResponse, GetCpaCampaignResponse, CmsCampaignResponse, CmsResponse, GetCpaResponse, GetDeliveriesProfilesResponse, GetDeliveriesRegionsResponse, PostDeliveriesRegionsResponse, GetDiscountsGroupsClientsResponse, GetDiscountsGroupsResponse, PostDiscountsGroupsResponse, GetEntriesResponse, PostEntriesResponse, GetEntriesPagesToDisplayResponse, GetEntriesSourcesResponse, GetMenuResponse, PostMenuResponse, PutMenuResponse, PutMenuSortResponse, GetOrdersAnalyticsResponse, GetOrdersAuctionDetailsResponse, PutOrdersCourierResponse, PostOrdersDocumentsCreateResponse, GetOrdersDocumentsResponse, PostOrdersDocumentsResponse, GetOrdersHandlerResponse, GetOrdersHistoryResponse, GetOrdersImagesResponse, PostOrdersImagesResponse, GetOrdersLabelsResponse, SearchOrdersOpinionsResponse, GetOrdersOpinionsRateResponse, SearchOrdersResponse, PostOrdersResponse, PutOrdersResponse, GetOrdersPackagesResponse, PutOrdersPackagesResponse, PutOrdersProductsSerialNumbersResponse, PutOrdersProfitMarginResponse, GetOrdersProfitabilityResponse, GetOrdersStatusesResponse, GetOrdersWarehouseResponse, PostPackagesLabelsResponse, PutPackagesResponse, SearchPackagesResponse, GetPaymentsFormsResponse, GetPaymentsResponse, PostPaymentsResponse, GetPaymentsProfilesResponse, PostPaymentsRepaymentResponse, GetProductsSKUbyBarcodeResponse, PutProductsAttachmentsResponse, GetProductsAuctionsResponse, GetProductsBrandsResponse, PutProductsBrandsResponse, GetProductsCategoriesResponse, PutProductsCategoriesResponse, SearchProductsCategoriesIdosellResponse, GetProductsCodeExistenceResponse, SearchProductsDeliveryTimeResponse, GetProductsDescriptionsResponse, ProductIdentResponse, PutProductsGroupsSettingsResponse, GetProductsIdBySizecodeResponse, PutProductsImagesResponse, GetProductsMarketingPromotionResponse, PostProductsMarketingPromotionResponse, PutProductsMarketingPromotionResponse, GetProductsMarketingZonesResponse, PutProductsMarketingZonesResponse, GetProductsOmnibusPricesResponse, GetProductsOpinionsResponse, PostProductsOpinionsResponse, GetProductsOpinionsRateResponse, PutProductsParametersResponse, SearchProductsParametersResponse, SearchProductsResponse, PostProductsResponse, PutProductsResponse, GetProductsQuestionsResponse, GetProductsReservationsResponse, GetProductsSeriesResponse, PutProductsSeriesResponse, GetProductsSizesResponse, PutProductsSizesResponse, PutProductsStockQuantityResponse, GetProductsStocksResponse, PutProductsStocksResponse, GetProductsStrikethroughPricesResponse, PutProductsSupplierCodeResponse, PutProductsSupplierProductDataResponse, GetResponsibilityEntitiesResponse, PutResponsibilityEntitiesResponse, GetReturnsResponse, PostReturnsResponse, PutReturnsResponse, PutReturnsSerialNumberResponse, GetRmaResponse, PutRmaResponse, GetRmaStatusesResponse, GetShopsCurrenciesResponse, GetShopsLanguagesResponse, GetSizechartsResponse, PutSizechartsResponse, GetSizesResponse, PutSizesResponse, GetSnippetsCampaignResponse, GetSnippetsCookiesResponse, GetSnippetsResponse, GetSystemConfigResponse, GetSystemCurrenciesResponse, PutSystemCurrenciesResponse, GetSystemProcessesAutomationResponse, GetSystemServerLoadResponse, GetSystemServerTimeResponse, GetSystemShopsDataResponse, GetSystemUnitsResponse, PutSystemUnitsResponse, GetSystemUsersResponse, GetVouchersTypesResponse, GetVouchersResponse, GetWarrantiesCountTotalResponse, PutWarrantiesLanguageDataResponse, GetWarrantiesResponse, PutWarrantiesResponse, GetWmsLocationsResponse, GetWmsStocksdocumentsDocumentsResponse, PostWmsStocksdocumentsDocumentsResponse, PutWmsStocksdocumentsDocumentsResponse, GetWmsStocksdocumentsOpenedDocumentsResponse, GetWmsStocksdocumentsProductsResponse, PutWmsStocksdocumentsProductsResponse, GetWmsSuppliersResponse, PutWmsSuppliersResponse } from "./responses.d.ts"
 import type * as RequestParams from "./reqparams.d.ts";
 import * as ENUMS from "./enums";
 import utils from "./utils";
 
+export class IdosellFaultStringError extends Error {
+    cause: IdosellFaultStringError;
+    constructor(message: string, cause: IdosellErrorFaultStructure);
+}
+
+export function catchEmptyList(): (_err: IdosellFaultStringError) => undefined;
+export function catchEmptyList<T>(_defaultValue: T): (_err: IdosellFaultStringError) => T;
+
 export interface GetClientsBalanceRequest extends PagableGateway<GetClientsBalanceRequest, GetClientsBalanceResponse> {
     /** Customer Id */
     clientNumbers: (value: number|string|number[]|string[]) => this;
@@ -67,7 +75,7 @@ export interface GetClientsRequest extends PagableGateway<GetClientsRequest, Get
     /** Client Registration Date  */
     clientRegistrationDate: (value: JSObject) => this;
     /** The ID of the shop, that client is assigned to. */
-    shopId: (value: string) => this;
+    shopId: (value: number|string) => this;
     /** Define range of dates */
     lastPurchased: (dateFrom: DateLike, dateTo: DateLike) => this;
     /** Define range of dates */
@@ -163,7 +171,7 @@ export interface PutClientsRequest extends AppendableGateway<PutClientsRequest,
     /** Country ID in accordance with ISO-3166. */
     clientCountryId: (clientCountryId: string) => this
     /** Administrative region code. */
-    clientProvinceId: (clientProvinceId: string) => this
+    clientProvinceId: (clientProvinceId: number|string) => this
     /** Customer password (min. 8 characters). */
     clientPassword: (clientPassword: string) => this
     /** Date of birth. */
@@ -331,9 +339,9 @@ export interface PostClientsDeliveryAddressRequest extends AppendableGateway<Pos
     /** Recipient street and number. */
     clientDeliveryAddressStreet: (clientDeliveryAddressStreet: string) => this
     /** Administrative region code. */
-    clientDeliveryAddressRegionId: (clientDeliveryAddressRegionId: string) => this
+    clientDeliveryAddressRegionId: (clientDeliveryAddressRegionId: number|string) => this
     /** Administrative region code. */
-    clientDeliveryAddressProvinceId: (clientDeliveryAddressProvinceId: string) => this
+    clientDeliveryAddressProvinceId: (clientDeliveryAddressProvinceId: number|string) => this
     /** Recipient's postal code. */
     clientDeliveryAddressZipCode: (clientDeliveryAddressZipCode: string) => this
     /** Recipient's country. */
@@ -348,7 +356,7 @@ export interface PutClientsDeliveryAddressRequest extends AppendableGateway<PutC
     /** External system code. */
     clientCodeExternal: (clientCodeExternal: string) => this
     /** Delivery address ID. */
-    clientDeliveryAddressId: (clientDeliveryAddressId: string) => this
+    clientDeliveryAddressId: (clientDeliveryAddressId: number|string) => this
     /** List of stores IDs When mask is determined, this parameter is omitted. */
     shopsIds: (shopsIds: number|string|number[]|string[]) => this
     /** Currency ID */
@@ -366,9 +374,9 @@ export interface PutClientsDeliveryAddressRequest extends AppendableGateway<PutC
     /** Recipient street and number. */
     clientDeliveryAddressStreet: (clientDeliveryAddressStreet: string) => this
     /** Administrative region code. */
-    clientDeliveryAddressRegionId: (clientDeliveryAddressRegionId: string) => this
+    clientDeliveryAddressRegionId: (clientDeliveryAddressRegionId: number|string) => this
     /** Administrative region code. */
-    clientDeliveryAddressProvinceId: (clientDeliveryAddressProvinceId: string) => this
+    clientDeliveryAddressProvinceId: (clientDeliveryAddressProvinceId: number|string) => this
     /** Recipient's postal code. */
     clientDeliveryAddressZipCode: (clientDeliveryAddressZipCode: string) => this
     /** Recipient's country. */
@@ -551,7 +559,7 @@ export interface DeleteClientsPayerAddressRequest extends AppendableGateway<Dele
 
 export interface GetClientsPayerAddressRequest extends PagableGateway<GetClientsPayerAddressRequest, GetClientsPayerAddressResponse> {
     /** Unique client's number. */
-    clientId: (value: string) => this;
+    clientId: (value: number|string) => this;
     /** Page with results number. Numeration starts from 0 */
     resultsPage: (value: number|string) => this;
     /** Number of results on page. Value from 1 to 100 */
@@ -585,9 +593,9 @@ export interface PostClientsPayerAddressRequest extends AppendableGateway<PostCl
 export interface PutClientsPayerAddressRequest extends AppendableGateway<PutClientsPayerAddressRequest, PutClientsPayerAddressResponse, RequestParams.PutClientsPayerAddressParams> {
     payers: (value: RequestParams.PutClientsPayerAddressParams["payers"]) => this;
     /** Unique client's number. */
-    clientId: (clientId: string) => this
+    clientId: (clientId: number|string) => this
     /** Buyer's address id. */
-    payerAddressId: (payerAddressId: string) => this
+    payerAddressId: (payerAddressId: number|string) => this
     /** Buyer's first name. */
     payerAddressFirstName: (payerAddressFirstName: string) => this
     /** Buyer's last name. */
@@ -869,7 +877,7 @@ export interface GetCouriersRequest extends PagableGateway<GetCouriersRequest, G
 export interface DeleteCouriersPickupPointsRequest extends AppendableGateway<DeleteCouriersPickupPointsRequest> {
     pickupPointDeleteRequests: (value: Array<JSObject>) => this;
     /** Collection point ID. */
-    pickupPointId: (pickupPointId: string) => this
+    pickupPointId: (pickupPointId: number|string) => this
     /** external system code. */
     pickupPointExternalId: (pickupPointExternalId: string) => this
     /** Courier ID. */
@@ -880,7 +888,7 @@ export interface GetCouriersPickupPointsRequest extends PagableGateway<GetCourie
     /** Courier ID. */
     courierId: (value: number|string) => this;
     /** Collection point ID. */
-    pickupPointId: (value: string) => this;
+    pickupPointId: (value: number|string) => this;
     /** External system code. */
     pickupPointExternalId: (value: string) => this;
     /** Page with results number. Numeration starts from 0 */
@@ -912,7 +920,7 @@ export interface PostCouriersPickupPointsRequest extends AppendableGateway<PostC
 export interface PutCouriersPickupPointsRequest extends AppendableGateway<PutCouriersPickupPointsRequest, PutCouriersPickupPointsResponse, RequestParams.PutCouriersPickupPointsParams> {
     pickupPoints: (value: RequestParams.PutCouriersPickupPointsParams["pickupPoints"]) => this;
     /** Collection point ID. */
-    pickupPointId: (pickupPointId: string) => this
+    pickupPointId: (pickupPointId: number|string) => this
     /** external system code. */
     pickupPointExternalId: (pickupPointExternalId: string) => this
     /** Courier ID. */
@@ -1272,7 +1280,7 @@ export interface PutMenuFilterRequest extends AppendableGateway<PutMenuFilterReq
     /** Active filters. */
     menuFiltersActive: (value: Array<JSObject>) => this;
     /** Menu filter ID. */
-    menuFilterId: (menuFilterId: string) => this
+    menuFilterId: (menuFilterId: number|string) => this
     /** Filter name on page. */
     menuFilterName: (menuFilterName: string) => this
     /** Display as: "name" - text, "gfx" - graphics, "namegfx" - text and graphics. */
@@ -1321,7 +1329,7 @@ export interface PostMenuRequest extends AppendableGateway<PostMenuRequest, Post
     /** Menu ID. */
     menu_id: (menu_id: number|string) => this
     /** Parent menu element ID. */
-    parent_id: (parent_id: string) => this
+    parent_id: (parent_id: number|string) => this
     /** Menu element text identifier. Example: "item1\item2". */
     parent_textid: (parent_textid: string) => this
     /**  */
@@ -1337,7 +1345,7 @@ export interface PutMenuRequest extends AppendableGateway<PutMenuRequest, PutMen
     /** Menu ID. */
     menu_id: (menu_id: number|string) => this
     /** Menu element ID. */
-    item_id: (item_id: string) => this
+    item_id: (item_id: number|string) => this
     /** Menu element text identifier. Example: "item1\item2\item3". */
     item_textid: (item_textid: string) => this
     /**  */
@@ -1389,7 +1397,7 @@ export interface PutOrdersCourierRequest extends Gateway<PutOrdersCourierRespons
     /** Courier ID. */
     courierId: (value: number|string) => this;
     /** Collection point ID. */
-    pickupPointId: (value: string) => this;
+    pickupPointId: (value: number|string) => this;
 }
 
 export interface PutOrdersDeliveryAddressRequest extends Gateway {
@@ -1436,7 +1444,7 @@ export interface DeleteOrdersDocumentsRequest extends AppendableGateway<DeleteOr
 
 export interface GetOrdersDocumentsRequest extends Gateway<GetOrdersDocumentsResponse> {
     /** Order serial number. */
-    orderSerialNumber: (value: string|string[]) => this;
+    orderSerialNumber: (value: number|string|number[]|string[]) => this;
     /** Document type */
     documentType: (value: 'sales_confirmation'|'vat_invoice'|'corrective_vat_invoice'|'advance_vat_invoice'|'final_advance_vat_invoice'|'pro_forma_invoice'|'advance_pro_forma_invoice'|'final_advance_pro_forma_invoice'|'delivery_note'|'fiscal_receipt'|'fiscal_invoice'|'other') => this;
     /** Elements returned by api */
@@ -1629,7 +1637,7 @@ export interface PostOrdersRequest extends AppendableGateway<PostOrdersRequest,
     /** Courier ID. */
     courierId: (courierId: number|string) => this
     /** Collection point ID. */
-    pickupPointId: (pickupPointId: string) => this
+    pickupPointId: (pickupPointId: number|string) => this
     /** Delivery cost. */
     deliveryCost: (deliveryCost: number) => this
     /** Delivery address data. */
@@ -1656,13 +1664,17 @@ export interface PostOrdersRequest extends AppendableGateway<PostOrdersRequest,
     billingCurrencyRate: (billingCurrencyRate: number) => this
     /** Sale date. ISO 8602 format. */
     purchaseDate: (purchaseDate: string) => this
+    /** Planned date of packing */
+    plannedDateOfPacking: (plannedDateOfPacking: string) => this
+    /** Planned date of shipment */
+    estimatedDeliveryDate: (estimatedDeliveryDate: string) => this
 }
 
 export interface PutOrdersRequest extends AppendableGateway<PutOrdersRequest, PutOrdersResponse, RequestParams.PutOrdersParams> {
     /** Orders. */
     orders: (value: RequestParams.PutOrdersParams["orders"]) => this;
     /** Order ID. */
-    orderId: (orderId: string) => this
+    orderId: (orderId: number|string) => this
     /** Order serial number. */
     orderSerialNumber: (orderSerialNumber: number|string) => this
     /** Order status. Allowed values: "finished_ext" - order status: completed in FA application, "finished" - completed, "new" - not handled, "payment_waiting" - awaiting payment, "delivery_waiting" - awaiting delivery, "on_order" - in progress, "packed" - being picked, "packed_fulfillment" - being picked - fulfilment, "packed_ready" - packed, "ready" - ready, "wait_for_dispatch" - awaiting dispatch date, "suspended" - on hold, "joined" - merged, "missing" - missing, "lost" - lost, "false" - false, "canceled" - Customer canceled. */
@@ -1701,6 +1713,8 @@ export interface PutOrdersRequest extends AppendableGateway<PutOrdersRequest, Pu
     purchaseDate: (purchaseDate: string) => this
     /** Estimated date of shipment of the order in format Y-m-d H:i */
     estimatedDeliveryDate: (estimatedDeliveryDate: string) => this
+    /** Planned date of packing */
+    plannedDateOfPacking: (plannedDateOfPacking: string) => this
 }
 
 export interface SearchOrdersRequest extends PagableGateway<SearchOrdersRequest, SearchOrdersResponse, RequestParams.SearchOrdersParams> {
@@ -1722,7 +1736,7 @@ export interface SearchOrdersRequest extends PagableGateway<SearchOrdersRequest,
     orderType: (value: 'wholesale'|'retail'|'dropshipping'|'deliverer') => this;
     dropshippingOrderStatus: (value: 'all'|'finished'|'canceled'|'notCanceled') => this;
     /** Orders IDs. */
-    ordersIds: (value: string|string[]) => this;
+    ordersIds: (value: number|string|number[]|string[]) => this;
     /** Order serial numbers. */
     ordersSerialNumbers: (value: number|string|number[]|string[]) => this;
     /** Customer data. */
@@ -1816,7 +1830,7 @@ export interface PostOrdersPackagesRequest extends AppendableGateway<PostOrdersP
     /** List of parcels assigned to the order Maximum default number: 100 parcels. */
     orderPackages: (value: RequestParams.PostOrdersPackagesParams["orderPackages"]) => this;
     /** Id. */
-    eventId: (eventId: string) => this
+    eventId: (eventId: number|string) => this
     /** Type. */
     eventType: (eventType: 'order'|'rma'|'return') => this
     /** Information on consignments. */
@@ -1827,7 +1841,7 @@ export interface PutOrdersPackagesRequest extends AppendableGateway<PutOrdersPac
     /** List of parcels assigned to the order Maximum default number: 100 parcels. */
     orderPackages: (value: RequestParams.PutOrdersPackagesParams["orderPackages"]) => this;
     /** Id. */
-    eventId: (eventId: string) => this
+    eventId: (eventId: number|string) => this
     /** Type. */
     eventType: (eventType: 'order'|'rma'|'return') => this
     /** Information on consignments. */
@@ -1838,7 +1852,7 @@ export interface PutOrdersPickupPointRequest extends Gateway<PutOrdersCourierRes
     /** Order serial number. */
     orderSerialNumber: (value: number|string) => this;
     /** Collection point ID. */
-    pickupPointId: (value: string) => this;
+    pickupPointId: (value: number|string) => this;
 }
 
 export interface GetOrdersPrinterDocumentsRequest extends Gateway {
@@ -1904,7 +1918,7 @@ export interface SearchOrdersUnfinishedRequest extends PagableGateway<SearchOrde
     /** Dropshipping order status in the supplier's system. Allowed values: "all" - all, "finished" - sent, "canceled" - canceled, "notCanceled" - failed to cancel. */
     dropshippingOrderStatus: (value: 'all'|'finished'|'canceled'|'notCanceled') => this;
     /** Orders IDs. */
-    ordersIds: (value: string|string[]) => this;
+    ordersIds: (value: number|string|number[]|string[]) => this;
     /** Order serial numbers. */
     ordersSerialNumbers: (value: number|string|number[]|string[]) => this;
     /** Customer data. */
@@ -2008,7 +2022,7 @@ export interface PostPackagesLabelsRequest extends AppendableGateway<PostPackage
     /** Shipment configuration options available for Inpost Smile courier */
     parcelParametersByPackages: (value: RequestParams.PostPackagesLabelsParams["parcelParametersByPackages"]) => this;
     /** Package ID in system. */
-    packageId: (packageId: string) => this
+    packageId: (packageId: number|string) => this
     /** Set order serial number */
     orderSn: (orderSn: number |string) => this;
     /** Set default parcel size */
@@ -2220,7 +2234,7 @@ export interface PutProductsBrandsFilterRequest extends AppendableGateway<PutPro
     /** Active filters. */
     filtersActive: (value: Array<JSObject>) => this;
     /** Menu filter ID. */
-    filterId: (filterId: string) => this
+    filterId: (filterId: number|string) => this
     /** Filter name on page. */
     filterName: (filterName: string) => this
     /** Display as: "name" - text, "gfx" - graphics, "namegfx" - text and graphics. */
@@ -2356,7 +2370,7 @@ export interface GetProductsCodeExistenceRequest extends Gateway<GetProductsCode
     identType: (value: 'id'|'index'|'codeExtern'|'codeProducer'|'codeDeliverer') => this;
     /** Products list. */
     products: (value: string|string[]) => this;
-    delivererId: (value: string) => this;
+    delivererId: (value: number|string) => this;
     /** Set product identifiers */
     productId: (productId: number|string|number|string|number[]|string[], type?: 'id'|'index'|'codeExtern'|'codeProducer') => this;
 }
@@ -2413,7 +2427,7 @@ export interface SearchProductsDeliveryTimeRequest extends AppendableGateway<Sea
     /** Product Id */
     productId: (productId: number|string) => this
     /** Size identifier */
-    sizeId: (sizeId: string) => this
+    sizeId: (sizeId: number|string) => this
     /** Size name */
     sizePanelName: (sizePanelName: string) => this
     /** Product IAI code */
@@ -2492,7 +2506,7 @@ export interface DeleteProductsImagesRequest extends AppendableGateway<DeletePro
     /** Shop Id */
     shopId: (shopId: number|string) => this
     /**  */
-    productImagesId: (productImagesId: string|string[]) => this
+    productImagesId: (productImagesId: number|string|number[]|string[]) => this
 }
 
 export interface PutProductsImagesRequest extends AppendableGateway<PutProductsImagesRequest, PutProductsImagesResponse, RequestParams.PutProductsImagesParams> {
@@ -2558,12 +2572,12 @@ export interface PostProductsMarketingPromotionRequest extends AppendableGateway
     /**  */
     elementType: (elementType: 'product'|'series'|'producer'|'category'|'menu') => this
     /** Identifier of the element affected by the promotion (in the case of a menu in the format: storeId-menuId-itemId) */
-    elementId: (elementId: string) => this
+    elementId: (elementId: number|string) => this
 }
 
 export interface PutProductsMarketingPromotionRequest extends AppendableGateway<PutProductsMarketingPromotionRequest, PutProductsMarketingPromotionResponse, RequestParams.PutProductsMarketingPromotionParams> {
     /** Promotion ID */
-    promotionId: (value: string) => this;
+    promotionId: (value: number|string) => this;
     /** Promotion name */
     promotionName: (value: string) => this;
     /** List of stores IDs When mask is determined, this parameter is omitted. */
@@ -2593,7 +2607,7 @@ export interface PutProductsMarketingPromotionRequest extends AppendableGateway<
     /**  */
     elementType: (elementType: 'product'|'series'|'producer'|'category'|'menu') => this
     /** Identifier of the element affected by the promotion (in the case of a menu in the format: storeId-menuId-itemId) */
-    elementId: (elementId: string) => this
+    elementId: (elementId: number|string) => this
 }
 
 export interface GetProductsMarketingZonesRequest extends Gateway<GetProductsMarketingZonesResponse> {
@@ -2750,9 +2764,9 @@ export interface PutProductsParametersRequest extends AppendableGateway<PutProdu
     /** Icons of section, parameter or value to display on the list of products. */
     link_icons: (link_icons: RequestParams.PutProductsParametersParams["items"][number]["link_icons"]) => this
     /** Parameter's additional feature. 1. Status: context_id = "CONTEXT_STATE" Takes values context_value_id: - CONTEXT_STATE_NEW - New, - CONTEXT_STATE_USED - Used, - CONTEXT_STATE_USED_EXCELLENT - Used - excellent condition - CONTEXT_STATE_USED_VERYGOOD - Used - very good condition - CONTEXT_STATE_USED_CORRECT - Used - good condition - CONTEXT_STATE_USED_ACCEPTABLE - Used - acceptable condition - CONTEXT_STATE_REFURBISHED_EXCELLENT - Refurbished - excellent condition - CONTEXT_STATE_REFURBISHED_VERYGOOD - Refurbished - very good condition - CONTEXT_STATE_REFURBISHED_CORRECT - Refurbished - good condition - CONTEXT_STATE_NEW_OTHERS - New other (see details) - CONTEXT_STATE_NEW_WITH_DEFECTS - New with defects - CONTEXT_STATE_NEW_OEM - New - OEM - CONTEXT_STATE_NEW_OPEN_BOX - New - open box - CONTEXT_STATE_REFURBISHED_BY_PRODUCER - Renewed by a manufacturer, - CONTEXT_STATE_REFURBISHED_BY_SELLER - Renewed by a seller, - CONTEXT_STATE_FOR_PARTS_OR_BROKEN - In parts or damaged. 2. Product weight in grams: context_id = "CONTEXT_STD_UNIT_WEIGHT" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 3. A product's value in milliliters: context_id = "CONTEXT_STD_UNIT_VOLUME" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 4. Sex: context_id = "CONTEXT_SEX" Takes values context_value_id: - CONTEXT_SEX_MAN - Man, - CONTEXT_SEX_WOMAN - Woman, - CONTEXT_SEX_UNISEX - Unisex. 5. Age group: context_id = "CONTEXT_AGE_GROUP" Takes values context_value_id: - CONTEXT_AGE_GROUP_ADULT - Adults, - CONTEXT_AGE_GROUP_MINOR - Children. 6. Maximum number of products in an order: context_id = "CONTEXT_MAX_QUANTITY_PER_RETAIL_ORDER" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 7. Maximum number of products in a wholesale order: context_id = "CONTEXT_MAX_QUANTITY_PER_WHOLESALE_ORDER" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 8. Minimal number of products in an order: context_id = "CONTEXT_MIN_QUANTITY_PER_RETAIL_ORDER" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 9. Minimum number of products in a wholesale order: context_id = "CONTEXT_MIN_QUANTITY_PER_WHOLESALE_ORDER" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 10. Maximal number of a single size in an order: context_id = "CONTEXT_MAX_SIZE_QUANTITY_PER_RETAIL_ORDER" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 11. Maximal number of a single size in a wholesale order: context_id = "CONTEXT_MAX_SIZE_QUANTITY_PER_WHOLESALE_ORDER" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 12. Minimal number of a single size in an order: context_id = "CONTEXT_MIN_SIZE_QUANTITY_PER_RETAIL_ORDER" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 13. Minimal number of a single size in a wholesale order: context_id = "CONTEXT_MIN_SIZE_QUANTITY_PER_WHOLESALE_ORDER" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 14. Net weight: context_id = "CONTEXT_WEIGHT_NET" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 15. Color: context_id = "CONTEXT_COLOR" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 16. #!TylkoDlaDoroslych!#: context_id = "CONTEXT_ONLY_ADULTS" Takes values context_value_id: - CONTEXT_ONLY_ADULTS_YES - yes, - CONTEXT_ONLY_ADULTS_NO - no. 17. Prescription drug: context_id = "CONTEXT_PRESCRIPTION_MEDICINE" Takes values context_value_id: - CONTEXT_PRESCRIPTION_MEDICINE_YES - yes, - CONTEXT_PRESCRIPTION_MEDICINE_NO - no. 18. Season Rate: context_id = "CONTEXT_SEASON" Takes values context_value_id: - CONTEXT_SEASON_SPRING - Spring, - CONTEXT_SEASON_SUMMER - Summer, - CONTEXT_SEASON_FALL - Autumn, - CONTEXT_SEASON_WINTER - Winter, - CONTEXT_SEASON_SPRING_SUMMER - Spring/Summer, - CONTEXT_SEASON_FALL_WINTER - Autumn/Winter 19. Risk - signal word: context_id = \"CONTEXT_HAZMAT_SIGNAL\" Takes values context_value_id: - CONTEXT_HAZMAT_SIGNAL_DANGER - danger, - CONTEXT_HAZMAT_SIGNAL_WARNING - warnging, - CONTEXT_HAZMAT_SIGNAL_CAUTION - caution, - CONTEXT_HAZMAT_SIGNAL_NOTICE - notice, 20. Risk - warning pictogram context_id = \"CONTEXT_HAZMAT_PICTOGRAM\" Takes values context_value_id: - GHS01, GHS02, GHS03, GHS04, GHS05, GHS06, GHS07, GHS08, GHS09 21. Risk - type of hazard: context_id = \"CONTEXT_HAZMAT_STATEMENT\" Takes values context_value_id: - H200, H201, H202, H203, H204, H205, H220, H221, H222, H223, H224, H225, H226, H228, H240, H241, H242, H250, H251, H252, H260, H261, H270, H271, H272, H280, H281, H290, H300, H301, H302, H304, H310, H311, H312, H314, H315, H317, H318, H319, H330, H331, H332, H334, H335, H336, H340, H341, H350, H351, H360, H361, H362, H370, H371, H372, H373, H400, H410, H411, H412, H413, EUH 001, EUH 014, EUH 018, EUH 019, EUH 044, EUH 029, EUH 031, EUH 032, EUH 066, EUH 070, EUH 071, EUH 201, EUH 201A, EUH 202, EUH 203, EUH 204, EUH 205, EUH 206, EUH 207, EUH 208, EUH 209, EUH 209A, EUH 210, EUH 401 22. Repair score: context_id = \"CONTEXT_REPAIR_SCORE\" Takes values context_value_id: - The value of the additional feature is set automatically based on the parameter's value 23. Safety - information pictogram: context_id = \"CONTEXT_SAFETY_PICTOGRAM\" Takes values context_value_id: - 1 (Not suitable for small children) - 2 (CE mark) 24. Safety - type of warning: context_id = \"CONTEXT_SAFETY_STATEMENT\" Takes values context_value_id: - 1 (Not suitable for children under 3 years) - 2 (Keep out of the reach of children) - 3 (Product contains a button cell or coin battery) - 4 (Use under the direct supervision of adults) - 5 (Required protective gear. Do not use in public traffic) - 6 (Contains toy. Adult supervision recommended) - 7 (To prevent possible injury from entanglement, remove this toy as soon as the child begins to crawl) - 8 (Use only in shallow water under adult supervision) - 9 (Only use under adult supervision) - 10 (This toy does not provide protection) - 11 (Contains fragrances that may cause allergies) - 12 (For household use only). */
-    context_id: (context_id: string) => this
+    context_id: (context_id: number|string) => this
     /** value of additional feature - Values described in context_id. */
-    context_value_id: (context_value_id: string) => this
+    context_value_id: (context_value_id: number|string) => this
 }
 
 export interface SearchProductsParametersRequest extends PagableGateway<SearchProductsParametersRequest, SearchProductsParametersResponse, RequestParams.SearchProductsParametersParams> {
@@ -2781,7 +2795,7 @@ export interface DeleteProductsRequest extends AppendableGateway<DeleteProductsR
 
 export interface GetProductsRequest extends Gateway<SearchProductsResponse> {
     /** List of the unique, indexed product codes (IAI code / External system code / Producer code). You can transfer a maximum of 100 products IDs in one request. */
-    productIds: (value: string|string[]) => this;
+    productIds: (value: number|string|number[]|string[]) => this;
 }
 
 export interface PostProductsRequest extends AppendableGateway<PostProductsRequest, PostProductsResponse, RequestParams.PostProductsParams> {
@@ -3520,7 +3534,7 @@ export interface PutProductsSeriesFilterRequest extends AppendableGateway<PutPro
     /** Active filters. */
     filtersActive: (value: Array<JSObject>) => this;
     /** Menu filter ID. */
-    filterId: (filterId: string) => this
+    filterId: (filterId: number|string) => this
     /** Filter name on page. */
     filterName: (filterName: string) => this
     /** Display as: "name" - text, "gfx" - graphics, "namegfx" - text and graphics. */
@@ -3963,7 +3977,7 @@ export interface GetRmaRequest extends PagableGateway<GetRmaRequest, GetRmaRespo
     /** Login of the user handling the complaint */
     operatorLogin: (value: string) => this;
     /** Unique client's number. */
-    clientId: (value: string) => this;
+    clientId: (value: number|string) => this;
     /** Complaint creation date in the YYYY-MM-DD format */
     creationDate: (value: JSObject) => this;
     /** Complaint modification date in the YYYY-MM-DD format */
@@ -4044,7 +4058,7 @@ export interface PutSizesRequest extends AppendableGateway<PutSizesRequest, PutS
     /** Size group ID. */
     group_id: (group_id: number|string) => this
     /** Size identifier. */
-    id: (id: string) => this
+    id: (id: number|string) => this
     /** Category plural name. */
     name: (name: string) => this
     /** Size description. */
@@ -4546,23 +4560,23 @@ export interface PutVouchersRequest extends AppendableGateway<PutVouchersRequest
 }
 
 export interface GetWarrantiesCountTotalRequest extends Gateway<GetWarrantiesCountTotalResponse> {
-    warranty_ids: (value: string|string[]) => this;
+    warranty_ids: (value: number|string|number[]|string[]) => this;
 }
 
 export interface PutWarrantiesLanguageDataRequest extends AppendableGateway<PutWarrantiesLanguageDataRequest, PutWarrantiesLanguageDataResponse, RequestParams.PutWarrantiesLanguageDataParams> {
     lang_data: (value: RequestParams.PutWarrantiesLanguageDataParams["lang_data"]) => this;
     /** Warranty ID (numeric or text based). */
-    warranty_id: (warranty_id: string) => this
+    warranty_id: (warranty_id: number|string) => this
     /**  */
     lang: (lang: RequestParams.PutWarrantiesLanguageDataParams["lang_data"][number]["lang"]) => this
 }
 
 export interface DeleteWarrantiesRequest extends Gateway {
-    warranty_ids: (value: string|string[]) => this;
+    warranty_ids: (value: number|string|number[]|string[]) => this;
 }
 
 export interface GetWarrantiesRequest extends PagableGateway<GetWarrantiesRequest, GetWarrantiesResponse> {
-    warranty_ids: (value: string|string[]) => this;
+    warranty_ids: (value: number|string|number[]|string[]) => this;
     /** Number of results on page. */
     results_limit: (value: number|string) => this;
     /** Result page number. */
@@ -4587,7 +4601,7 @@ export interface PostWarrantiesRequest extends AppendableGateway<PostWarrantiesR
 export interface PutWarrantiesRequest extends AppendableGateway<PutWarrantiesRequest, PutWarrantiesResponse, RequestParams.PutWarrantiesParams> {
     warranties: (value: RequestParams.PutWarrantiesParams["warranties"]) => this;
     /** Warranty ID (numeric or text based). */
-    id: (id: string) => this
+    id: (id: number|string) => this
     /** Name. */
     name: (name: string) => this
     /**  */

package/dist/index.js

@@ -1,12 +1,28 @@
 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;
+function normalizeUrl(input) {
+    const trimmed = input.trim();
+    const withProtocol = trimmed
+        .replace(/^https?:\/\//i, "") // strip existing protocol
+        .replace(/^\/{2}/, ""); // strip bare // (protocol-relative)
+    const normalized = `https://${withProtocol}`;
+    let parsed;
+    try {
+        parsed = new URL(normalized);
+    }
+    catch {
+        throw new Error(`Invalid URL: "${input}"`);
+    }
+    return parsed.origin;
+}
 const idosell = (url, apiKey, version = DEFAULT_VERSION) => {
-    const auth = { url, apiKey, version, apikey: apiKey ? apiKey.slice(0, 6) + '*'.repeat(20) : "" };
+    const auth = { url: normalizeUrl(url), apiKey, version, apikey: apiKey ? apiKey.slice(0, 6) + '*'.repeat(20) : "" };
     Object.defineProperty(auth, 'apiKey', { enumerable: false });
     const element = { auth, params: {} };
     return new Proxy(element, gateProxy);
 };
 export default idosell;
-export { ENUMS, utils };
+export { ENUMS, utils, IdosellFaultStringError, catchEmptyList };

package/dist/methods/putProductsStockQuantity.js

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

package/dist/params.js

@@ -32,10 +32,12 @@ export const paramsProxy = {
                 }
                 else if (object.custom && typeof object.custom[property] === 'function') {
                     const param = object.custom[property](...values);
-                    if (param.root)
-                        Object.assign(object.params, param.root);
-                    else
-                        Object.assign(item, param);
+                    if (param) {
+                        if (param.root)
+                            Object.assign(object.params, param.root);
+                        else
+                            Object.assign(item, param);
+                    }
                 }
                 else {
                     item[property] = values[0];

package/dist/request.js

@@ -1,10 +1,11 @@
 import axios from "axios";
 import { page } from "./helpers.js";
-import { inspect } from 'util';
+import { IdosellFaultStringError } from "./errors.js";
 const DECODE_TABLE = [
     ['Å\x82', "ł"],
     ['Ä\x99', 'ę']
 ];
+const DEFAULT_LOG_FUNCTION = console.log;
 const catchIdosellError = (err) => {
     if (!err.response) {
         if (err.cause)
@@ -29,21 +30,28 @@ const catchIdosellError = (err) => {
     throw new Error(`${err.response.status}: ${message}`, { cause: err.response.status });
 };
 const checkNext = (request, response, logPage) => {
+    if (logPage === true)
+        logPage = DEFAULT_LOG_FUNCTION;
     if (!response)
         return;
-    if (response?.errors?.faultCode > 0)
-        throw new Error(response.errors.faultString, { cause: response.errors });
+    if (response?.errors?.faultString) {
+        const faultStructure = {
+            faultCode: response?.errors?.faultCode ?? 999,
+            faultString: response.errors.faultString,
+        };
+        throw new IdosellFaultStringError(response.errors.faultString, faultStructure);
+    }
     if (response.resultsNumberPage) {
         request.next = response.resultsPage + 1 < response.resultsNumberPage;
         request.params.resultsPage = request.params.resultsPage ? request.params.resultsPage + 1 : 1;
         if (logPage)
-            console.log('Page: ' + response.resultsPage + ' / ' + response.resultsNumberPage);
+            logPage('Page: ' + response.resultsPage + ' / ' + response.resultsNumberPage);
     }
     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)
-            console.log('Page: ' + response.results_page + ' / ' + response.results_page);
+            logPage('Page: ' + response.results_page + ' / ' + response.results_page);
     }
     return response;
 };
@@ -141,10 +149,21 @@ export const sendRequest = async (request, options = {}) => {
     request.next = false;
     const { method, node } = request.gate;
     let url = `${request.auth.url}/api/admin/v${request.auth.version}${node}`;
-    if (options.log || options.dump) {
-        console.log(inspect({ params: request.params, method, url }, { showHidden: false, depth: null, colors: true }));
-        if (options.dump)
+    if (options.dump || options.log) {
+        const dumpData = { params: request.params, method, url };
+        if (options.dump) {
+            if (options.dump === true)
+                DEFAULT_LOG_FUNCTION(dumpData);
+            else
+                options.dump(dumpData);
             return {};
+        }
+        else if (options.log) {
+            if (options.log === true)
+                DEFAULT_LOG_FUNCTION(dumpData);
+            else
+                options.log(dumpData);
+        }
     }
     if (method === 'get' || method === 'delete') {
         url += '?' + queryfy(request.params);

package/dist/responses.d.ts

@@ -1758,6 +1758,10 @@ export type GetOrdersDocumentsResponse = {
         documentId?: string;
         /** @description Document name */
         documentName?: string;
+        /** @description Internal document number in the KSeF system */
+        ksefNumber: string;
+        /** @description Document status in the IdoSell system */
+        ksefDocumentStatus: "pending" | "processing" | "completed" | "failed" | "skipped";
         /** @description Base64 encoded PDF document. */
         pdfWithDocumentsInBase64?: string;
         /** @description Information on error that occurred during gate call. */
@@ -4962,6 +4966,8 @@ export type SearchProductsResponse = {
         responsibleProducerCode?: string | null;
         /** @description Responsible person code */
         responsiblePersonCode?: string | null;
+        /** @description Minimum stock level */
+        minStockLevel?: number;
     }[];
 } & PagedResponse;
 
@@ -8660,7 +8666,484 @@ export type GetProductsResponse = {
         depositProductId?: number;
         /** @description Product deposit count */
         depositCount?: number;
+        /** @description Minimum stock level */
+        minStockLevel?: number;
     }[];
 } & { resultsLimit: number; };
 
+export type GetOrdersResponse = {
+    Results: {
+        /** @description Order ID. */
+        orderId: string;
+        /** @description Order note supported by IAI Bridge. */
+        orderBridgeNote: string;
+        /** @description Order serial number. */
+        orderSerialNumber: number;
+        /** @description Order type. List of values: "p" - wholesale order placed in panel, "t" - wholesale order placed in shop, "n" - retail order placed in shop, "r" - retail order placed in panel. */
+        orderType: "p" | "t" | "n" | "r";
+        /** @description Customer data. */
+        clientResult: {
+            /** @description Client's billing address' data. */
+            clientBillingAddress: {
+                /** @description Customer's first name. */
+                clientFirstName: string;
+                /** @description Customer's last name. */
+                clientLastName: string;
+                /** @description Customer Tax no. */
+                clientNip: string;
+                /** @description Customer's company name. */
+                clientFirm: string;
+                /** @description Product suggestion. */
+                clientAdditional: string;
+                /** @description Street and number. */
+                clientStreet: string;
+                /** @description Customer's postal code. */
+                clientZipCode: string;
+                /** @description Customer's city. */
+                clientCity: string;
+                /** @description Region name takes priority over clientCountryId. */
+                clientCountryName: string;
+                /** @description Client NIP verification status */
+                clientNipUeVerified: string;
+                /** @description Country ID in accordance with ISO-3166. */
+                clientCountryId: string;
+                /** @description Cell phone. */
+                clientPhone1: string;
+                /** @description Land line. */
+                clientPhone2: string;
+                /** @description Administrative region code. */
+                clientProvinceId: string;
+                /** @description Administrative region. */
+                clientProvince: string;
+            };
+            /** @description Delivery address data. */
+            clientDeliveryAddress: {
+                /** @description Delivery address ID. */
+                clientDeliveryAddressId: string;
+                /** @description Recipient's first name. */
+                clientDeliveryAddressFirstName: string;
+                /** @description Recipient's last name. */
+                clientDeliveryAddressLastName: string;
+                /** @description Company name. */
+                clientDeliveryAddressFirm: string;
+                /** @description Recipient street and number. */
+                clientDeliveryAddressStreet: string;
+                /** @description Recipient's postal code. */
+                clientDeliveryAddressZipCode: string;
+                /** @description Recipient's city. */
+                clientDeliveryAddressCity: string;
+                /** @description Recipient's country. */
+                clientDeliveryAddressCountry: string;
+                /** @description Country code in ISO 3166-1 standard. */
+                clientDeliveryAddressCountryId: string;
+                /** @description Cell phone. */
+                clientDeliveryAddressPhone1: string;
+                /** @description Land line. */
+                clientDeliveryAddressPhone2: string;
+                /** @description Administrative region code. */
+                clientDeliveryAddressProvinceId: string;
+                /** @description Administrative region. */
+                clientDeliveryAddressProvince: string;
+                /** @description Type of delivery address resulting from the type of delivery e.g. collection point. Available values: "client" - Address provided by customer to which he/she wishes to receive the shipment, "pickupPoint"- The address of the pickup point selected by the customer from which the customer wishes to pick up the order, "warehouse" - The address of the warehouse selected by the customer from which the customer wishes to pick up the order. */
+                clientDeliveryAddressType: "client" | "pickupPoint" | "warehouse";
+                /** @description Internal Receiving Point Identifier. */
+                clientDeliveryAddressPickupPointInternalId: number;
+            };
+            clientPickupPointAddress: {
+                /** @description Collection point ID. */
+                pickupPointId: string;
+                /** @description External service collection point ID. */
+                externalPickupPointId: string;
+                /** @description Town / City. */
+                city: string;
+                /** @description Address. */
+                street: string;
+                /** @description ZIP / Post code. */
+                zipCode: string;
+                /** @example description */
+                description: string;
+                /** @description Latitude. */
+                latitude: number;
+                /** @description Longitude. */
+                longitude: number;
+                /** @description Name. */
+                name: string;
+            };
+            /** @description Buyer's address data. */
+            payerAddress: {
+                /** @description Buyer's address id. */
+                payerAddressId: string;
+                /** @description Buyer's first name. */
+                payerAddressFirstName: string;
+                /** @description Buyer's last name. */
+                payerAddressLastName: string;
+                /** @description Company name. */
+                payerAddressFirm: string;
+                /** @description Customer VAT ID. */
+                payerAddressNip: string;
+                /** @description Buyer's street name and house number. */
+                payerAddressStreet: string;
+                /** @description Buyer's postal code. */
+                payerAddressZipCode: string;
+                /** @description Buyer's city. */
+                payerAddressCity: string;
+                /** @description Buyer's country. */
+                payerAddressCountry: string;
+                /** @description Country code in the ISO 3166-1 A2 standard. */
+                payerAddressCountryId: string;
+                /** @description Buyer's telephone number. */
+                payerAddressPhone: string;
+            };
+            /** @description Data of customer account in store. */
+            clientAccount: {
+                /** @description Unique client's number. */
+                clientId: number;
+                /** @description Customer's login. */
+                clientLogin: string;
+                /** @description E-mail address. */
+                clientEmail: string;
+                /** @description Cell phone. */
+                clientPhone1: string;
+                /** @description Land line. */
+                clientPhone2: string;
+                /** @description External system code. */
+                clientCodeExternal: string;
+            };
+            /** @description End customer details. */
+            endClientAccount: {
+                /** @description Unique client's number. */
+                clientId: number;
+                /** @description Customer's login. */
+                clientLogin: string;
+                /** @description E-mail address. */
+                clientEmail: string;
+                /** @description Cell phone. */
+                clientPhone1: string;
+                /** @description Land line. */
+                clientPhone2: string;
+                /** @description External system code. */
+                clientCodeExternal: string;
+            };
+            /** @description Is client on black list? */
+            clientOnBlackList: boolean;
+        };
+        /** @description Order data. */
+        orderDetails: {
+            /** @description Flag informing on order registration or completion in external program through API. Allowed values. "none" - order was not registered in external program, "registered" - order was registered in external program, "realized" - order was completed in external program, "registered_pos" - order was registered in external program, "realized_pos" - order was completed in external program. */
+            apiFlag: "none" | "registered" | "realized" | "registered_pos" | "realized_pos" | "registration_fault";
+            /** @description Order status. Allowed values: "finished_ext" - order status: completed in FA application, "finished" - completed, "new" - not handled, "payment_waiting" - awaiting payment, "delivery_waiting" - awaiting delivery, "on_order" - in progress, "packed" - being picked, "packed_fulfillment" - being picked - fulfilment, "packed_ready" - packed, "ready" - ready, "wait_for_dispatch" - awaiting dispatch date, "suspended" - on hold, "joined" - merged, "missing" - missing, "lost" - lost, "false" - false, "canceled" - Customer canceled. */
+            orderStatus: string;
+            /** @description Order status id */
+            orderStatusId: string;
+            /** @description Date of change of status to the currently set status in YYYY-MM-DD HH:MM:SS format. */
+            orderStatusChangeDate: string;
+            /** @example dropshippingOrderStatus */
+            dropshippingOrderStatus: string;
+            /** @description Type of order confirmation. Confirmations listing: "none" - order unconfirmed , "email" - order confirmed by e-mail, "phone_client" - order confirmed by phone call made by client, "phone_service" - order confirmed by phone call made by staff, "postauction" - order confirmed by auction return page, "willingness" - confirmed by willingness to buy letter, "auctionfod" - confirmed by after-sales form Allegro. */
+            orderConfirmation: string;
+            /** @description Date of order placing in YYYY-MM-DD HH:MM:SS format. */
+            orderAddDate: string;
+            /** @description Date of order sending in YYYY-MM-DD HH:MM:SS format. */
+            orderDispatchDate: string | null;
+            /** @example receivedDate */
+            receivedDate: string;
+            /** @description Order handling time in seconds. */
+            orderPrepareTime: string;
+            /** @description Customer comments on order. */
+            clientNoteToOrder: string;
+            /** @description Customer remarks for courier. */
+            clientNoteToCourier: string;
+            /** @description Order payment data. */
+            payments: {
+                /** @description Order payment method. Allowed values. "cash_on_delivery" - cash on delivery, "prepaid" - prepayment, "tradecredit" - Trade credit. */
+                orderPaymentType: string;
+                /** @description Number of days. */
+                orderPaymentDays: number;
+                /** @description Accrued discount. */
+                orderRebatePercent: number;
+                /** @description Information on order value in currency of order adding. */
+                orderCurrency: {
+                    /** @description Currency ID */
+                    currencyId: string;
+                    /** @description Currency average rate set for order (by default, an average rate of order adding date, if it wasn't manually changed). */
+                    orderCurrencyValue: number;
+                    /** @description Currency scaler. */
+                    orderCurrencyScale: number;
+                    /** @description Panel billing currency exchange rate in relation to billing currency in the shop . */
+                    billingCurrencyRate: number;
+                    /** @description Products cost. */
+                    orderProductsCost: number;
+                    /** @description Shipping costs. */
+                    orderDeliveryCost: number;
+                    /** @description Additional charge for selected payment method. */
+                    orderPayformCost: number;
+                    /** @description Additional fee for insurance. */
+                    orderInsuranceCost: number;
+                };
+                /** @description Information on order value in shop account currency. */
+                orderBaseCurrency: {
+                    /** @example billingCurrency */
+                    billingCurrency: string;
+                    /** @description Products cost. */
+                    orderProductsCost: number;
+                    /** @description Shipping costs. */
+                    orderDeliveryCost: number;
+                    /** @description Delivery VAT. */
+                    orderDeliveryVat: number;
+                    /** @description Additional charge for selected payment method. */
+                    orderPayformCost: number;
+                    /** @description VAT for additional fee for the chosen form of payment. */
+                    orderPayformVat: number;
+                    /** @description Additional fee for insurance. */
+                    orderInsuranceCost: number;
+                    /** @description Insurance VAT rate (in percents). */
+                    orderInsuranceVat: number;
+                };
+                /** @description Order currency squaring method. "gross" - calculated in gross prices, "net" - squared in net prices. */
+                orderWorthCalculateType: "gross" | "net";
+                /** @description Information if the VAT for the current order was calculated: "y" - yes, "n" - no. */
+                orderVatExists: string;
+            };
+            /** @description Information about prepayment for the order. */
+            prepaids: {
+                /** @description Order payment identifier. */
+                prepaidId: number;
+                /** @description Payment number for order. */
+                paymentOrdinalNumber: number;
+                /** @description Payment number - [order no.]-[payment no.], i.e. 1234-1. */
+                paymentNumber: string;
+                /** @description Date of payment addition. */
+                paymentAddDate: string;
+                /** @description Client's payment modification date. */
+                paymentModifiedDateByClient: string;
+                /** @description Payment modification date made by shop staff. */
+                paymentModifiedDateByShop: string;
+                /** @description Payment status. */
+                paymentStatus: string;
+                /** @description Transaction type: "payment" - payment, "advance" - advance payment, "repayment" - return, "fee" - handling fee. */
+                paymentType: "payment" | "advance" | "repayment" | "fee";
+                /** @description Form of payment ID. */
+                payformId: number;
+                /** @description Name of payment form. */
+                payformName: string;
+                /** @description Account. */
+                payformAccount: string;
+                /** @description Payment amount. */
+                paymentValue: number;
+                /** @description Currency ID */
+                currencyId: string;
+                /** @description Number of voucher used in a payment. */
+                voucherNumber: string;
+                /** @description Number of gift card used in a payment. */
+                giftCardNumber: string;
+            }[];
+            /** @description Order source data. */
+            orderSourceResults: {
+                /** @description order source type - possible values:. "self_added" - Orders from panel, "shop" - Orders from shop, "search_engine" - Orders from search engines, "auction" - Orders from auctions, "advertisement_campaign" - Advertisement campaigns, "price_comparer" - Price comparison sites, "affiliate_program" - Affiliate programme, "api" - Order from API, "eletronic_offer" - Order from ODT price lst, "cpa" - Order from CPA program, "refferer_site" - Order from reference sites, "pos" - Orders from POS, "marketplace" - Order from the Marketplace, "iai_ads" - Orders from IAI Ads */
+                orderSourceType: string;
+                /** @description Shop Id */
+                shopId: number;
+                /** @description Auction site order comes from. Auction sites listing: "allegro" - Allegro.pl, "testwebapi" - Allegro.pl test site, "ebay" - eBay. */
+                auctionsServiceName: string;
+                /** @description Detailed information on order source. */
+                orderSourceDetails: {
+                    /** @description order source type - possible values:. "self_added" - Orders from panel, "shop" - Orders from shop, "search_engine" - Orders from search engines, "auction" - Orders from auctions, "advertisement_campaign" - Advertisement campaigns, "price_comparer" - Price comparison sites, "affiliate_program" - Affiliate programme, "api" - Order from API, "eletronic_offer" - Order from ODT price lst, "cpa" - Order from CPA program, "refferer_site" - Order from reference sites, "pos" - Orders from POS, "marketplace" - Order from the Marketplace, "iai_ads" - Orders from IAI Ads */
+                    orderSourceType: string;
+                    /** @description Exact source name. */
+                    orderSourceName: string;
+                    /** @description Numerical ID of order source type. */
+                    orderSourceTypeId: number;
+                    /** @description Numerical ID of order source. */
+                    orderSourceId: number;
+                    /** @example 1 */
+                    entryProductIdBeforeOrder: number;
+                    /** @example sourcePageUrl */
+                    sourcePageUrl: string;
+                    /** @description The order ID of the external service */
+                    orderExternalId: string;
+                    /** @description Order from the InPost Fresh marketplace */
+                    fresh: "y" | "n";
+                    /** @description Order supported by InPost fulfillment */
+                    fulfillment: "y" | "n";
+                };
+                preorderSourcesDetails: {
+                    /** @description order source type - possible values:. "self_added" - Orders from panel, "shop" - Orders from shop, "search_engine" - Orders from search engines, "auction" - Orders from auctions, "advertisement_campaign" - Advertisement campaigns, "price_comparer" - Price comparison sites, "affiliate_program" - Affiliate programme, "api" - Order from API, "eletronic_offer" - Order from ODT price lst, "cpa" - Order from CPA program, "refferer_site" - Order from reference sites, "pos" - Orders from POS, "marketplace" - Order from the Marketplace, "iai_ads" - Orders from IAI Ads */
+                    orderSourceType: string;
+                    /** @description Exact source name. */
+                    orderSourceName: string;
+                    /** @description Numerical ID of order source type. */
+                    orderSourceTypeId: number;
+                    /** @description Numerical ID of order source. */
+                    orderSourceId: number;
+                    /** @example entryDate */
+                    entryDate: string;
+                }[];
+            };
+            /** @description Data of auction, order comes from (only if it comes from auction). */
+            auctionInfo: {
+                /** @description Account ID on auction site. */
+                auctionClientId: string;
+                /** @description Account login on auction site. */
+                auctionClientLogin: string;
+                /** @description #!TablicaNumerowAukcjiDoZamowienia!#. */
+                auctionItemsIds: {
+                    /** @description Auction number. */
+                    auctionItemId: string;
+                }[];
+                /** @description The customer's email address at the auction service. */
+                auctionClientEmail: string;
+            };
+            /** @description Consignment data. */
+            dispatch: {
+                /** @description Courier ID. */
+                courierId: number;
+                /** @description Name of the supplier of the shipment. */
+                courierName: string;
+                /** @description Courier via webservice. */
+                courierWebserviceOnly: boolean;
+                /** @description Shipment ID. */
+                deliveryPackageId: string;
+                /** @description Selected delivery date. */
+                deliveryDate: string;
+                /** @description Additional information on delivery date. */
+                deliveryDateAdditional: string;
+                /** @description Estimated date of shipment of the order. */
+                estimatedDeliveryDate: string;
+                /** @description Parcel weight. */
+                deliveryWeight: number;
+            };
+            /** @description The list of products returned due to a gate call */
+            productsResults: {
+                /** @description Product IAI code */
+                productId: number;
+                /** @description Product name. */
+                productName: string;
+                /** @description External product system code */
+                productCode: string;
+                /** @description Name of the parameter value, e.g. orange, green, red */
+                versionName: string;
+                /** @description Size identifier */
+                sizeId: string;
+                /** @description Size name */
+                sizePanelName: string;
+                /** @description External product system code for size. */
+                productSizeCodeExternal: string;
+                /** @description Stock ID */
+                stockId: number;
+                /** @description Serial number of the product. */
+                productSerialNumber: string;
+                /** @description Product quantity. */
+                productQuantity: number;
+                /** @description Weight. */
+                productWeight: number;
+                /** @description Value of VAT */
+                productVat: number;
+                /** @description Is product VAT free Allowed values "y" - yes, "n" - no. */
+                productVatFree: string;
+                /** @description Gross price of the product in the currency of the administration panel. */
+                productPanelPrice: number;
+                /** @description Net price of the product in the currency of the administration panel. */
+                productPanelPriceNet: number;
+                /** @description Product gross price of order in order currency. */
+                productOrderPrice: number;
+                /** @description Product net price of order in order currency. */
+                productOrderPriceNet: number;
+                /** @description Product gross price of order in shop account currency. */
+                productOrderPriceBaseCurrency: number;
+                /** @description Product net price of order in shop account currency. */
+                productOrderPriceNetBaseCurrency: number;
+                /** @description List of product suggestions . */
+                orderAdditionalList: {
+                    /** @description Product suggestion. */
+                    orderAdditional: {
+                        /** @description Name of suggestion. */
+                        orderAdditionalName: string;
+                        /** @description Value of suggestion. */
+                        orderAdditionalValue: string;
+                    };
+                };
+                /** @description Client's remarks on product. */
+                remarksToProduct: string;
+                /** @description Label for grouping products. */
+                label: string;
+                /** @description Product selling mode. Available values: "money", "gift", "points". */
+                orderSalesMode: "money" | "gift" | "points";
+                /** @description A set's ID. */
+                bundleId: number;
+                /** @description Serial numbers. */
+                productSerialNumbers: string;
+                /** @description Additional information. */
+                productOrderAdditional: string;
+                /** @description Item in basket. */
+                basketPosition: number;
+                /** @description price information. */
+                productPriceLog: string;
+                /** @description Information about the selected parameters in the configurator. */
+                priceFormulaParameters: {
+                    /** @description Parameter ID */
+                    parameterId: string;
+                    /** @description Parameter name. */
+                    parameterName: string;
+                    /** @description Parameter values */
+                    parameterValues: {
+                        /** @example valueId */
+                        valueId: string;
+                        /** @example valueName */
+                        valueName: string;
+                    }[];
+                }[];
+                /** @description Is product packed? */
+                productPacked: boolean;
+            }[];
+            /** @description Parameter determines if product has been removed from stock. List of values: "y" - removed from stock, "n" - put in stock. */
+            productRemovedInStock: "y" | "n";
+            /** @description Stock ID */
+            stockId: number;
+            /** @description Customer asked for invoice. List of parameters: "y" - yes (paper invoicing ), "e" - yes (electronic invoicing ), "n" - no. */
+            clientRequestInvoice: string;
+            /** @description Delivery address ID. */
+            clientDeliveryAddressId: number;
+            /** @description Note to the order. */
+            orderNote: string;
+            /** @description Information on used discount code. */
+            discountCode: {
+                /** @description Campaign ID. */
+                campaignId: string;
+                /** @description Name of code. */
+                discountCodeName: string;
+                /** @description Accrued discount */
+                discountCodeValue: string;
+            };
+            /** @description Discount card */
+            discountCard: {
+                /** @description Name of card */
+                discountCardName: string;
+            };
+            /** @description Order handler. */
+            orderOperatorLogin: string;
+            /** @description Order picker. */
+            orderPackingPersonLogin: string;
+            /** @description Sale date. ISO 8602 format. */
+            purchaseDate: string;
+            /** @description Modification date in YYYY-MM-DD HH:MM:SS format . */
+            orderChangeDate: string;
+            /** @description Source subscription identifier. */
+            subscriptionId: number;
+            /** @description Are all products packed? */
+            allProductPacked: boolean;
+            /** @description Planned date of packing */
+            plannedDateOfPacking: string | null;
+            /** @description Is order verified? */
+            verified: boolean;
+        };
+        /** @description Information on error that occurred during gate call. */
+        errors: {
+            /** @description Error code. */
+            faultCode: number;
+            /** @description Error description. */
+            faultString: string;
+        }[];
+    }[];
+};
+
 export { };

package/dist/utils.d.ts

@@ -17,7 +17,7 @@ export type MapProductLocationsFunction = (product: IdosellProduct, stockId?: nu
 
 export type GetLangDataFunction = <T extends { langId: string}>(array: T[], langId?: string) => T|undefined;
 
-export type ClearParametersLangDataFunction = (products: SearchProductsResponse['results'], langId: string = 'pol') => SearchProductsResponse['results'];
+export type ClearParametersLangDataFunction = (products: SearchProductsResponse['results'], langId?: string) => SearchProductsResponse['results'];
 
 declare namespace utils {
     /** @description The method allows you to build an IAI code from the product ID and size ID. */

package/dist/utils.js

@@ -1,4 +1,3 @@
-import { PRODUCE_SIZE_INDEX } from "./enums.d.js";
 import ENUMS from "./enums.js";
 const getIaiCode = (productId, sizeId) => {
     if (sizeId === 'uniw')
@@ -136,9 +135,9 @@ const sumProductQuantities = (productStocksData, nodeName = ENUMS.PRODUCT_SIZE_C
 };
 const getProductIndexFunction = (type, product) => {
     switch (type) {
-        case PRODUCE_SIZE_INDEX.ID: return (obj) => obj.sizeId;
-        case PRODUCE_SIZE_INDEX.IAI_CODE: return (obj) => getIaiCode(product.productId, obj.sizeId);
-        case PRODUCE_SIZE_INDEX.NAME: {
+        case ENUMS.PRODUCE_SIZE_INDEX.ID: return (obj) => obj.sizeId;
+        case ENUMS.PRODUCE_SIZE_INDEX.IAI_CODE: return (obj) => getIaiCode(product.productId, obj.sizeId);
+        case ENUMS.PRODUCE_SIZE_INDEX.NAME: {
             return (obj) => {
                 if (obj.sizePanelName)
                     return obj.sizePanelName;
@@ -263,6 +262,13 @@ const clearParametersLangData = (products, langId = 'pol') => {
     }
     return products;
 };
+const removeRmaAttachments = (rmaResponse) => {
+    for (const rma of rmaResponse.rmas) {
+        for (const product of rma.products)
+            product.attachments = [];
+    }
+    return rmaResponse;
+};
 export default {
     /** @description The method allows you to build an IAI code from the product ID and size ID. */
     getIaiCode,
@@ -279,5 +285,7 @@ export default {
     /** @description Get first item (description, series, parameter name or value) with the selected langId */
     getLangData,
     /** @description Modifies product response by removing all parameter names nad values that are not in selected langId */
-    clearParametersLangData
+    clearParametersLangData,
+    /** @description Removes attachments to RMA that are returned by default, helps to reduce data if serialized or forwarded */
+    removeRmaAttachments
 };

package/package.json

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