idosell 0.3.5 → 0.3.6

package/changelog.md

@@ -5,6 +5,13 @@ 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.3.6] - 2025-05-24
+### Changed
+- Idosell v5.4 - Added support to subscription methods
+- Idosell v5.6 - Added params to getProductOpinions
+- Enforce arrays where parameters require to i.e. idosellRequest.searchParams.returnElements('code') instead of .returnElements(['code'])
+
+
 ## [0.3.5] - 2025-05-10
 ### Changed
 - Added enums

package/dist/app.d.ts

@@ -30,7 +30,8 @@ export type GatewayRequestProxyObject = {
 	custom?: Record<string,Function>,
 	snakeCase?: boolean,
 	next?: boolean,
-	rootparams?: boolean
+	rootparams?: string|boolean,
+	arrays?: string[]
 } & RequestProxyObject;
 
 export interface Gateway<R = JSObject> {

package/dist/gates.js

@@ -263,6 +263,7 @@ import getSnippets from "./methods/getSnippets.js";
 import postSnippets from "./methods/postSnippets.js";
 import putSnippets from "./methods/putSnippets.js";
 import deleteSnippets from "./methods/deleteSnippets.js";
+import postSubscriptionsAddProduct from "./methods/postSubscriptionsAddProduct.js";
 import postSubscriptionsChangeDeliveryDates from "./methods/postSubscriptionsChangeDeliveryDates.js";
 import postSubscriptionsChangePriceAutoUpdate from "./methods/postSubscriptionsChangePriceAutoUpdate.js";
 import postSubscriptionsChangeStatus from "./methods/postSubscriptionsChangeStatus.js";
@@ -581,6 +582,7 @@ const gates = {
     postSnippets,
     putSnippets,
     deleteSnippets,
+    postSubscriptionsAddProduct,
     postSubscriptionsChangeDeliveryDates,
     postSubscriptionsChangePriceAutoUpdate,
     postSubscriptionsChangeStatus,

package/dist/gateways.d.ts

@@ -2588,6 +2588,10 @@ export interface GetProductsOpinionsRequest extends PagableGateway<GetProductsOp
     products: (value: Object) => this;
     /** Customer data. */
     clients: (value: Object) => this;
+    /** Review positive score data */
+    scorePositive: (value: Object) => this;
+    /** Review negative score data */
+    scoreNegative: (value: Object) => this;
     /** Date range */
     dateRange: (value: Object) => this;
     /** Page with results number. Numeration starts from 0 */
@@ -4153,53 +4157,109 @@ export interface DeleteSnippetsRequest extends Gateway {
     id: (value: number|string|number[]|string[]) => this;
 }
 
+export interface PostSubscriptionsAddProductRequest extends Gateway {
+    /** Id of subscription */
+    subscriptionId: (value: number|string) => this;
+    /** Collection of products to edit */
+    products: (value: Array<JSObject>) => this;
+}
+
 export interface PostSubscriptionsChangeDeliveryDatesRequest extends Gateway {
-    subscriptionsDeliveryDatesModel: (value: Object) => this;
+    /** Subscription ids */
+    subscriptionIds: (value: number|string|number[]|string[]) => this;
+    /** Settings that determinates if price should be updated automaticly */
+    upcomingDeliveryDate: (value: string) => this;
+    /** A setting that determines whether to also change the date of the next delivery. */
+    changeNextDeliveryDate: (value: Boolean) => this;
 }
 
 export interface PostSubscriptionsChangePriceAutoUpdateRequest extends Gateway {
-    subscriptionsAutoPriceModel: (value: Object) => this;
+    /** Subscription ids */
+    subscriptionIds: (value: number|string|number[]|string[]) => this;
+    /** Settings that determinates if price should be updated automaticly */
+    autoPriceUpdate: (value: Boolean) => this;
 }
 
 export interface PostSubscriptionsChangeStatusRequest extends Gateway {
-    subscriptionsStatusModel: (value: Object) => this;
+    /** Subscription ids */
+    subscriptionIds: (value: number|string|number[]|string[]) => this;
+    /** Status to set */
+    subscriptionStatus: (value: 'active'|'hold'|'nonpayment'|'finished') => this;
+    /** Option allowing sending e-mail after status change */
+    sendMailAfterStatusChange: (value: Boolean) => this;
+    /** Optian allowing sending SMS after status change */
+    sendSMSAfterStatusChange: (value: Boolean) => this;
 }
 
 export interface PostSubscriptionsDeleteProductRequest extends Gateway {
-    subscriptionDeleteProducts: (value: Object) => this;
+    /** Id of subscription */
+    subscriptionId: (value: number|string) => this;
+    /** Ids in products table to delete */
+    idsToDelete: (value: number|string|number[]|string[]) => this;
 }
 
 export interface PostSubscriptionsEditRequest extends Gateway {
-    /** Subscriptions model */
-    subscriptionsEditRequest: (value: Object) => this;
+    /** Subscription */
+    subscriptionModels: (value: Array<JSObject>) => this;
 }
 
 export interface PostSubscriptionsEditProductRequest extends Gateway {
-    subscriptionEditProducts: (value: Object) => this;
+    /** Id of subscription */
+    subscriptionId: (value: number|string) => this;
+    /** Collection of products to edit */
+    products: (value: Array<JSObject>) => this;
 }
 
 export interface PostSubscriptionsItemsListRequest extends Gateway {
-    request: (value: Object) => this;
+    filter: (value: Object) => this;
+    orderBy: (value: Object) => this;
+    /** Pagination settings. */
+    pagination: (value: Object) => this;
 }
 
 export interface PostSubscriptionsListViewFetchIdsRequest extends Gateway {
-    /** Filters that limit the result of a customer query. */
-    filter: (value: Object) => this;
+    /** Subscription IDs */
+    ids: (value: number|string|number[]|string[]) => this;
+    /** Subscription statuses */
+    statuses: (value: string|string[]) => this;
+    /** Client ID */
+    clientId: (value: number|string) => this;
+    /** Shop ID */
+    shopId: (value: number|string) => this;
+    /** Price change mode */
+    priceChangeMode: (value: 'auto'|'manual') => this;
+    /** A universal structure for time intervals. */
+    createDateTime: (value: Object) => this;
+    /** A universal structure for time intervals. */
+    finishDateTime: (value: Object) => this;
+    /** Universal structure for intervals. */
+    upcomingDeliveryDate: (value: Object) => this;
+    /** Universal structure for intervals. */
+    nextDeliveryDate: (value: Object) => this;
+    /** Text search phrase */
+    textSearch: (value: string) => this;
 }
 
 export interface PostSubscriptionsListViewListRequest extends Gateway {
-    /** Object describing the request for a list of Subscriptions. */
-    request: (value: Object) => this;
+    select: (value: Object) => this;
+    /** Filters that limit the result of a customer query. */
+    filter: (value: Object) => this;
+    /** Order by settings. */
+    orderBy: (value: Object) => this;
+    /** Pagination settings. */
+    pagination: (value: Object) => this;
 }
 
 export interface PostSubscriptionsSetRebateCodeRequest extends Gateway {
-    /** Object with discount code data to set */
-    request: (value: Object) => this;
+    /** Subscription ID */
+    id: (value: number|string) => this;
+    /** Code value */
+    code: (value: string) => this;
 }
 
 export interface PostSubscriptionsUnsetRebateCodeRequest extends Gateway {
-    /** Object with request witch unset rebate code */
-    request: (value: Object) => this;
+    /** Subscription ID */
+    id: (value: number|string) => this;
 }
 
 export interface GetSystemConfigRequest extends Gateway<GetConfigResponse> {}
@@ -4958,6 +5018,7 @@ export interface Gateways {
     postSnippets: PostSnippetsRequest,
     putSnippets: PutSnippetsRequest,
     deleteSnippets: DeleteSnippetsRequest,
+    postSubscriptionsAddProduct: PostSubscriptionsAddProductRequest,
     postSubscriptionsChangeDeliveryDates: PostSubscriptionsChangeDeliveryDatesRequest,
     postSubscriptionsChangePriceAutoUpdate: PostSubscriptionsChangePriceAutoUpdateRequest,
     postSubscriptionsChangeStatus: PostSubscriptionsChangeStatusRequest,

package/dist/methods/deleteClientsDeliveryAddress.js

@@ -6,5 +6,6 @@ export default (object) => {
         arrayNode: "clients",
         index: 0
     };
+    object.arrays = ["clients"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/deleteClientsGiftcards.js

@@ -6,5 +6,6 @@ export default (object) => {
         arrayNode: "giftCards",
         index: 0
     };
+    object.arrays = ["giftCards"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/deleteClientsPayerAddress.js

@@ -6,5 +6,6 @@ export default (object) => {
         arrayNode: "payers",
         index: 0
     };
+    object.arrays = ["payers"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/deleteClientsTags.js

@@ -1,11 +1,12 @@
 import { paramsProxy } from "../params.js";
 export default (object) => {
     object.gate = { method: 'post', node: '/clients/tags/delete' };
-    object.rootparams = true;
+    object.rootparams = "params";
     object.appendable = {
         except: [],
         arrayNode: "params",
         index: 0
     };
+    object.arrays = ["params"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/deleteCouriersPickupPoints.js

@@ -6,5 +6,6 @@ export default (object) => {
         arrayNode: "pickupPointDeleteRequests",
         index: 0
     };
+    object.arrays = ["pickupPointDeleteRequests"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/deleteDiscountsGroupsProducts.js

@@ -1,5 +1,6 @@
 import { paramsProxy } from "../params.js";
 export default (object) => {
     object.gate = { method: 'post', node: '/discounts/groups/products/delete' };
+    object.arrays = ["products", "producers", "series", "categories", "menuItems"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/deleteDiscountsRebatesCard.js

@@ -1,6 +1,6 @@
 import { paramsProxy } from "../params.js";
 export default (object) => {
     object.gate = { method: 'post', node: '/discounts/rebates/card/delete' };
-    object.rootparams = true;
+    object.rootparams = "campaign_id";
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/deleteDiscountsRebatesCode.js

@@ -1,6 +1,6 @@
 import { paramsProxy } from "../params.js";
 export default (object) => {
     object.gate = { method: 'post', node: '/discounts/rebates/code/delete' };
-    object.rootparams = true;
+    object.rootparams = "campaign_id";
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/deleteMenu.js

@@ -7,5 +7,6 @@ export default (object) => {
         arrayNode: "menu_list",
         index: 0
     };
+    object.arrays = ["menu_list"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/deleteOrdersDocuments.js

@@ -6,5 +6,6 @@ export default (object) => {
         arrayNode: "documents",
         index: 0
     };
+    object.arrays = ["documents"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/deleteOrdersImages.js

@@ -6,5 +6,6 @@ export default (object) => {
         arrayNode: "images",
         index: 0
     };
+    object.arrays = ["images"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/deleteProducts.js

@@ -6,5 +6,6 @@ export default (object) => {
         arrayNode: "products",
         index: 0
     };
+    object.arrays = ["products"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/deleteProductsBrands.js

@@ -1,5 +1,6 @@
 import { paramsProxy } from "../params.js";
 export default (object) => {
     object.gate = { method: 'post', node: '/products/brands/delete' };
+    object.arrays = ["ids"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/deleteProductsBundlesProducts.js

@@ -1,11 +1,12 @@
 import { paramsProxy } from "../params.js";
 export default (object) => {
     object.gate = { method: 'post', node: '/products/bundles/products/delete' };
-    object.rootparams = true;
+    object.rootparams = "params";
     object.appendable = {
         except: [],
         arrayNode: "params",
         index: 0
     };
+    object.arrays = ["params"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/deleteProductsCollectionsProducts.js

@@ -1,11 +1,12 @@
 import { paramsProxy } from "../params.js";
 export default (object) => {
     object.gate = { method: 'post', node: '/products/collections/products/delete' };
-    object.rootparams = true;
+    object.rootparams = "params";
     object.appendable = {
         except: [],
         arrayNode: "params",
         index: 0
     };
+    object.arrays = ["params"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/deleteProductsImages.js

@@ -1,11 +1,12 @@
 import { paramsProxy } from "../params.js";
 export default (object) => {
     object.gate = { method: 'post', node: '/products/images/delete' };
-    object.rootparams = true;
+    object.rootparams = "params";
     object.appendable = {
         except: [],
         arrayNode: "params",
         index: 0
     };
+    object.arrays = ["params"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/deleteProductsParameters.js

@@ -1,5 +1,6 @@
 import { paramsProxy } from "../params.js";
 export default (object) => {
     object.gate = { method: 'post', node: '/products/parameters/delete' };
+    object.arrays = ["ids"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/deleteProductsProductsToFacebookCatalog.js

@@ -1,5 +1,6 @@
 import { paramsProxy } from "../params.js";
 export default (object) => {
     object.gate = { method: 'post', node: '/products/productsToFacebookCatalog/delete' };
+    object.arrays = ["products"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/deleteProductsProductsToPromotion.js

@@ -1,5 +1,6 @@
 import { paramsProxy } from "../params.js";
 export default (object) => {
     object.gate = { method: 'post', node: '/products/productsToPromotion/delete' };
+    object.arrays = ["products"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/deleteProductsSeries.js

@@ -1,5 +1,6 @@
 import { paramsProxy } from "../params.js";
 export default (object) => {
     object.gate = { method: 'post', node: '/products/series/delete' };
+    object.arrays = ["ids"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/deleteProductsSizes.js

@@ -7,5 +7,6 @@ export default (object) => {
         arrayNode: "params",
         index: 0
     };
+    object.arrays = ["params", "deleteSizesIndexesData"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/deleteSizecharts.js

@@ -1,5 +1,6 @@
 import { paramsProxy } from "../params.js";
 export default (object) => {
     object.gate = { method: 'post', node: '/sizecharts/sizecharts/delete' };
+    object.arrays = ["ids"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/deleteVouchers.js

@@ -6,5 +6,6 @@ export default (object) => {
         arrayNode: "vouchers",
         index: 0
     };
+    object.arrays = ["vouchers"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/deleteWarranties.js

@@ -1,5 +1,6 @@
 import { paramsProxy } from "../params.js";
 export default (object) => {
     object.gate = { method: 'post', node: '/warranties/warranties/delete' };
+    object.arrays = ["warranty_ids"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/deleteWmsStocksdocumentsProducts.js

@@ -6,5 +6,6 @@ export default (object) => {
         arrayNode: "products",
         index: 0
     };
+    object.arrays = ["products"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/deleteWmsSuppliers.js

@@ -1,5 +1,6 @@
 import { paramsProxy } from "../params.js";
 export default (object) => {
     object.gate = { method: 'post', node: '/wms/suppliers/suppliers/delete' };
+    object.arrays = ["ids"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/postClients.js

@@ -6,5 +6,6 @@ export default (object) => {
         arrayNode: "clients",
         index: 0
     };
+    object.arrays = ["clients"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/postClientsDeliveryAddress.js

@@ -6,5 +6,6 @@ export default (object) => {
         arrayNode: "clients",
         index: 0
     };
+    object.arrays = ["clients"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/postClientsGiftcards.js

@@ -6,5 +6,6 @@ export default (object) => {
         arrayNode: "giftCards",
         index: 0
     };
+    object.arrays = ["giftCards"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/postClientsPayerAddress.js

@@ -6,5 +6,6 @@ export default (object) => {
         arrayNode: "payers",
         index: 0
     };
+    object.arrays = ["payers"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/postClientsTags.js

@@ -1,11 +1,12 @@
 import { paramsProxy } from "../params.js";
 export default (object) => {
     object.gate = { method: 'post', node: '/clients/tags' };
-    object.rootparams = true;
+    object.rootparams = "params";
     object.appendable = {
         except: [],
         arrayNode: "params",
         index: 0
     };
+    object.arrays = ["params"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/postCouriersPickupPoints.js

@@ -6,5 +6,6 @@ export default (object) => {
         arrayNode: "pickupPoints",
         index: 0
     };
+    object.arrays = ["pickupPoints"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/postCpa.js

@@ -6,5 +6,6 @@ export default (object) => {
         arrayNode: "cpa",
         index: 0
     };
+    object.arrays = ["cpa"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/postCpaCampaign.js

@@ -6,5 +6,6 @@ export default (object) => {
         arrayNode: "campaigns",
         index: 0
     };
+    object.arrays = ["campaigns"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/postEntries.js

@@ -6,5 +6,6 @@ export default (object) => {
         arrayNode: "langs",
         index: 0
     };
+    object.arrays = ["visibleOnSitesList", "products", "langs"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/postMenu.js

@@ -7,5 +7,6 @@ export default (object) => {
         arrayNode: "menu_list",
         index: 0
     };
+    object.arrays = ["menu_list"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/postOrders.js

@@ -6,5 +6,6 @@ export default (object) => {
         arrayNode: "orders",
         index: 0
     };
+    object.arrays = ["orders"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/postOrdersDocuments.js

@@ -6,5 +6,6 @@ export default (object) => {
         arrayNode: "documents",
         index: 0
     };
+    object.arrays = ["documents"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/postOrdersDocumentsCreate.js

@@ -1,5 +1,6 @@
 import { paramsProxy } from "../params.js";
 export default (object) => {
     object.gate = { method: 'post', node: '/orders/documents/create' };
+    object.arrays = ["orderSerialNumbers"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/postOrdersImages.js

@@ -13,5 +13,6 @@ export default (object) => {
         arrayNode: "images",
         index: 0
     };
+    object.arrays = ["images"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/postOrdersPackages.js

@@ -6,5 +6,6 @@ export default (object) => {
         arrayNode: "orderPackages",
         index: 0
     };
+    object.arrays = ["orderPackages"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/postPackages.js

@@ -6,5 +6,6 @@ export default (object) => {
         arrayNode: "orderPackages",
         index: 0
     };
+    object.arrays = ["orderPackages"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/postPackagesLabels.js

@@ -6,5 +6,6 @@ export default (object) => {
         arrayNode: "parcelParametersByPackages",
         index: 0
     };
+    object.arrays = ["parcelParameters", "parcelParametersByPackages"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/postProducts.js

@@ -12,5 +12,6 @@ export default (object) => {
         arrayNode: "products",
         index: 0
     };
+    object.arrays = ["products"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/postProductsBrands.js

@@ -6,5 +6,6 @@ export default (object) => {
         arrayNode: "producers",
         index: 0
     };
+    object.arrays = ["producers"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/postProductsBundles.js

@@ -1,11 +1,12 @@
 import { paramsProxy } from "../params.js";
 export default (object) => {
     object.gate = { method: 'post', node: '/products/bundles/bundles' };
-    object.rootparams = true;
+    object.rootparams = "params";
     object.appendable = {
         except: [],
         arrayNode: "params",
         index: 0
     };
+    object.arrays = ["params"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/postProductsBundlesProducts.js

@@ -1,11 +1,12 @@
 import { paramsProxy } from "../params.js";
 export default (object) => {
     object.gate = { method: 'post', node: '/products/bundles/products' };
-    object.rootparams = true;
+    object.rootparams = "params";
     object.appendable = {
         except: [],
         arrayNode: "params",
         index: 0
     };
+    object.arrays = ["params"];
     return new Proxy(object, paramsProxy);
 };

package/dist/methods/postProductsCollections.js

@@ -1,11 +1,12 @@
 import { paramsProxy } from "../params.js";
 export default (object) => {
     object.gate = { method: 'post', node: '/products/collections' };
-    object.rootparams = true;
+    object.rootparams = "params";
     object.appendable = {
         except: [],
         arrayNode: "params",
         index: 0
     };
+    object.arrays = ["params"];
     return new Proxy(object, paramsProxy);
 };