@gofynd/fdk-client-javascript 1.3.8 → 1.3.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -214,7 +214,7 @@ console.log("Active Theme: ", response.information.name);
214
214
  The above code will log the curl command in the console
215
215
 
216
216
  ```bash
217
- curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 1.3.8' --header 'x-fp-date: 20230222T115108Z' --header 'x-fp-signature: v1.1:1e3ab3b02b5bc626e3c32a37ee844266ade02bbcbaafc28fc7a0e46a76a7a1a8'
217
+ curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 1.3.9' --header 'x-fp-date: 20230222T115108Z' --header 'x-fp-signature: v1.1:1e3ab3b02b5bc626e3c32a37ee844266ade02bbcbaafc28fc7a0e46a76a7a1a8'
218
218
  Active Theme: Emerge
219
219
  ```
220
220
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@gofynd/fdk-client-javascript",
3
- "version": "1.3.8",
3
+ "version": "1.3.9",
4
4
  "description": "",
5
5
  "main": "index.js",
6
6
  "scripts": {
@@ -197,18 +197,44 @@ export = CartApplicationModel;
197
197
  * @property {string} [payment_confirm_url]
198
198
  * @property {boolean} [success]
199
199
  */
200
+ /**
201
+ * @typedef CartCommonConfig
202
+ * @property {DeliveryChargesConfig} [delivery_charges_config]
203
+ */
200
204
  /**
201
205
  * @typedef CartCurrency
202
206
  * @property {string} [code] - Currency code defined by ISO 4217:2015
203
207
  * @property {string} [symbol]
204
208
  */
209
+ /**
210
+ * @typedef CartDetailCoupon
211
+ * @property {number} [cashback_amount]
212
+ * @property {string} [cashback_message_primary]
213
+ * @property {string} [cashback_message_secondary]
214
+ * @property {string} [coupon_code]
215
+ * @property {string} [coupon_description]
216
+ * @property {string} [coupon_id]
217
+ * @property {string} [coupon_subtitle]
218
+ * @property {string} [coupon_title]
219
+ * @property {string} [coupon_type]
220
+ * @property {number} [coupon_value]
221
+ * @property {number} [discount]
222
+ * @property {boolean} [is_applied]
223
+ * @property {boolean} [is_valid]
224
+ * @property {number} [maximum_discount_value]
225
+ * @property {string} [message]
226
+ * @property {number} [minimum_cart_value]
227
+ */
205
228
  /**
206
229
  * @typedef CartDetailResponse
207
230
  * @property {AppliedPromotion[]} [applied_promo_details]
208
231
  * @property {CartBreakup} [breakup_values]
209
232
  * @property {boolean} [buy_now]
233
+ * @property {number} [cart_id]
210
234
  * @property {string} [checkout_mode]
211
235
  * @property {string} [comment]
236
+ * @property {CartCommonConfig} [common_config]
237
+ * @property {CartDetailCoupon} [coupon]
212
238
  * @property {string} [coupon_text]
213
239
  * @property {CartCurrency} [currency]
214
240
  * @property {string} [delivery_charge_info]
@@ -219,10 +245,14 @@ export = CartApplicationModel;
219
245
  * @property {CartProductInfo[]} [items]
220
246
  * @property {string} [last_modified]
221
247
  * @property {string} [message]
248
+ * @property {Object} [notification]
222
249
  * @property {Object} [pan_config]
223
250
  * @property {string} [pan_no]
224
251
  * @property {PaymentSelectionLock} [payment_selection_lock]
225
252
  * @property {boolean} [restrict_checkout]
253
+ * @property {string} [staff_user_id]
254
+ * @property {boolean} [success]
255
+ * @property {string} [uid]
226
256
  */
227
257
  /**
228
258
  * @typedef CartItemCountResponse
@@ -317,6 +347,11 @@ export = CartApplicationModel;
317
347
  * @property {string} [name]
318
348
  * @property {number} [uid] - Product Category Id
319
349
  */
350
+ /**
351
+ * @typedef ChargesThreshold
352
+ * @property {number} [charges]
353
+ * @property {number} [threshold]
354
+ */
320
355
  /**
321
356
  * @typedef CheckCart
322
357
  * @property {CartBreakup} [breakup_values]
@@ -417,6 +452,11 @@ export = CartApplicationModel;
417
452
  * @property {boolean} [success] - True if cart is archived successfully. False
418
453
  * if not archived.
419
454
  */
455
+ /**
456
+ * @typedef DeliveryChargesConfig
457
+ * @property {ChargesThreshold[]} [charges]
458
+ * @property {boolean} [enabled]
459
+ */
420
460
  /**
421
461
  * @typedef DiscountRulesApp
422
462
  * @property {Object} [item_criteria] - Item criteria of promotion
@@ -851,7 +891,7 @@ export = CartApplicationModel;
851
891
  declare class CartApplicationModel {
852
892
  }
853
893
  declare namespace CartApplicationModel {
854
- export { ActionQuery, AddCartDetailResponse, AddCartRequest, AddProductCart, Address, AppliedFreeArticles, AppliedPromotion, ApplyCouponRequest, ArticleGiftDetail, ArticlePriceInfo, BaseInfo, BasePrice, BulkPriceOffer, BulkPriceResponse, BuyRules, CartBreakup, CartCheckoutCustomMeta, CartCheckoutDetailRequest, CartCheckoutDetailV2Request, CartCheckoutResponse, CartCurrency, CartDetailResponse, CartItemCountResponse, CartMetaMissingResponse, CartMetaRequest, CartMetaResponse, CartProduct, CartProductIdentifer, CartProductInfo, CartShipmentsResponse, CategoryInfo, CheckCart, Coupon, CouponBreakup, CouponDetails, CouponValidity, CurrencyInfo, CustomerDetails, DeleteAddressResponse, DeleteCartDetailResponse, DiscountRulesApp, DisplayBreakup, FreeGiftItem, FreeGiftItems, GeoLocation, GetAddressesResponse, GetCouponResponse, GetShareCartLinkRequest, GetShareCartLinkResponse, GiftDetail, LadderOfferItem, LadderPrice, LadderPriceOffer, LadderPriceOffers, LoyaltyPoints, OfferItem, OfferPrice, OfferSeller, OperationErrorResponse, Ownership, PageCoupon, PaymentCouponValidate, PaymentMeta, PaymentMethod, PaymentSelectionLock, ProductAction, ProductArticle, ProductAvailability, ProductAvailabilitySize, ProductImage, ProductPrice, ProductPriceInfo, ProductPricePerUnit, ProductPricePerUnitInfo, PromiseFormatted, PromiseTimestamp, PromoMeta, PromotionOffer, PromotionOffersResponse, RawBreakup, RewardPointRequest, SaveAddressResponse, SelectCartAddressRequest, SharedCart, SharedCartDetails, SharedCartResponse, ShipmentPromise, ShipmentResponse, StaffCheckout, StoreInfo, Tags, UpdateAddressResponse, UpdateCartDetailResponse, UpdateCartPaymentRequest, UpdateCartRequest, UpdateProductCart };
894
+ export { ActionQuery, AddCartDetailResponse, AddCartRequest, AddProductCart, Address, AppliedFreeArticles, AppliedPromotion, ApplyCouponRequest, ArticleGiftDetail, ArticlePriceInfo, BaseInfo, BasePrice, BulkPriceOffer, BulkPriceResponse, BuyRules, CartBreakup, CartCheckoutCustomMeta, CartCheckoutDetailRequest, CartCheckoutDetailV2Request, CartCheckoutResponse, CartCommonConfig, CartCurrency, CartDetailCoupon, CartDetailResponse, CartItemCountResponse, CartMetaMissingResponse, CartMetaRequest, CartMetaResponse, CartProduct, CartProductIdentifer, CartProductInfo, CartShipmentsResponse, CategoryInfo, ChargesThreshold, CheckCart, Coupon, CouponBreakup, CouponDetails, CouponValidity, CurrencyInfo, CustomerDetails, DeleteAddressResponse, DeleteCartDetailResponse, DeliveryChargesConfig, DiscountRulesApp, DisplayBreakup, FreeGiftItem, FreeGiftItems, GeoLocation, GetAddressesResponse, GetCouponResponse, GetShareCartLinkRequest, GetShareCartLinkResponse, GiftDetail, LadderOfferItem, LadderPrice, LadderPriceOffer, LadderPriceOffers, LoyaltyPoints, OfferItem, OfferPrice, OfferSeller, OperationErrorResponse, Ownership, PageCoupon, PaymentCouponValidate, PaymentMeta, PaymentMethod, PaymentSelectionLock, ProductAction, ProductArticle, ProductAvailability, ProductAvailabilitySize, ProductImage, ProductPrice, ProductPriceInfo, ProductPricePerUnit, ProductPricePerUnitInfo, PromiseFormatted, PromiseTimestamp, PromoMeta, PromotionOffer, PromotionOffersResponse, RawBreakup, RewardPointRequest, SaveAddressResponse, SelectCartAddressRequest, SharedCart, SharedCartDetails, SharedCartResponse, ShipmentPromise, ShipmentResponse, StaffCheckout, StoreInfo, Tags, UpdateAddressResponse, UpdateCartDetailResponse, UpdateCartPaymentRequest, UpdateCartRequest, UpdateProductCart };
855
895
  }
856
896
  /** @returns {ActionQuery} */
857
897
  declare function ActionQuery(): ActionQuery;
@@ -1146,6 +1186,11 @@ type CartCheckoutResponse = {
1146
1186
  payment_confirm_url?: string;
1147
1187
  success?: boolean;
1148
1188
  };
1189
+ /** @returns {CartCommonConfig} */
1190
+ declare function CartCommonConfig(): CartCommonConfig;
1191
+ type CartCommonConfig = {
1192
+ delivery_charges_config?: DeliveryChargesConfig;
1193
+ };
1149
1194
  /** @returns {CartCurrency} */
1150
1195
  declare function CartCurrency(): CartCurrency;
1151
1196
  type CartCurrency = {
@@ -1155,14 +1200,37 @@ type CartCurrency = {
1155
1200
  code?: string;
1156
1201
  symbol?: string;
1157
1202
  };
1203
+ /** @returns {CartDetailCoupon} */
1204
+ declare function CartDetailCoupon(): CartDetailCoupon;
1205
+ type CartDetailCoupon = {
1206
+ cashback_amount?: number;
1207
+ cashback_message_primary?: string;
1208
+ cashback_message_secondary?: string;
1209
+ coupon_code?: string;
1210
+ coupon_description?: string;
1211
+ coupon_id?: string;
1212
+ coupon_subtitle?: string;
1213
+ coupon_title?: string;
1214
+ coupon_type?: string;
1215
+ coupon_value?: number;
1216
+ discount?: number;
1217
+ is_applied?: boolean;
1218
+ is_valid?: boolean;
1219
+ maximum_discount_value?: number;
1220
+ message?: string;
1221
+ minimum_cart_value?: number;
1222
+ };
1158
1223
  /** @returns {CartDetailResponse} */
1159
1224
  declare function CartDetailResponse(): CartDetailResponse;
1160
1225
  type CartDetailResponse = {
1161
1226
  applied_promo_details?: AppliedPromotion[];
1162
1227
  breakup_values?: CartBreakup;
1163
1228
  buy_now?: boolean;
1229
+ cart_id?: number;
1164
1230
  checkout_mode?: string;
1165
1231
  comment?: string;
1232
+ common_config?: CartCommonConfig;
1233
+ coupon?: CartDetailCoupon;
1166
1234
  coupon_text?: string;
1167
1235
  currency?: CartCurrency;
1168
1236
  delivery_charge_info?: string;
@@ -1173,10 +1241,14 @@ type CartDetailResponse = {
1173
1241
  items?: CartProductInfo[];
1174
1242
  last_modified?: string;
1175
1243
  message?: string;
1244
+ notification?: any;
1176
1245
  pan_config?: any;
1177
1246
  pan_no?: string;
1178
1247
  payment_selection_lock?: PaymentSelectionLock;
1179
1248
  restrict_checkout?: boolean;
1249
+ staff_user_id?: string;
1250
+ success?: boolean;
1251
+ uid?: string;
1180
1252
  };
1181
1253
  /** @returns {CartItemCountResponse} */
1182
1254
  declare function CartItemCountResponse(): CartItemCountResponse;
@@ -1295,6 +1367,12 @@ type CategoryInfo = {
1295
1367
  */
1296
1368
  uid?: number;
1297
1369
  };
1370
+ /** @returns {ChargesThreshold} */
1371
+ declare function ChargesThreshold(): ChargesThreshold;
1372
+ type ChargesThreshold = {
1373
+ charges?: number;
1374
+ threshold?: number;
1375
+ };
1298
1376
  /** @returns {CheckCart} */
1299
1377
  declare function CheckCart(): CheckCart;
1300
1378
  type CheckCart = {
@@ -1407,6 +1485,12 @@ type DeleteCartDetailResponse = {
1407
1485
  */
1408
1486
  success?: boolean;
1409
1487
  };
1488
+ /** @returns {DeliveryChargesConfig} */
1489
+ declare function DeliveryChargesConfig(): DeliveryChargesConfig;
1490
+ type DeliveryChargesConfig = {
1491
+ charges?: ChargesThreshold[];
1492
+ enabled?: boolean;
1493
+ };
1410
1494
  /** @returns {DiscountRulesApp} */
1411
1495
  declare function DiscountRulesApp(): DiscountRulesApp;
1412
1496
  type DiscountRulesApp = {
@@ -218,19 +218,47 @@ const Joi = require("joi");
218
218
  * @property {boolean} [success]
219
219
  */
220
220
 
221
+ /**
222
+ * @typedef CartCommonConfig
223
+ * @property {DeliveryChargesConfig} [delivery_charges_config]
224
+ */
225
+
221
226
  /**
222
227
  * @typedef CartCurrency
223
228
  * @property {string} [code] - Currency code defined by ISO 4217:2015
224
229
  * @property {string} [symbol]
225
230
  */
226
231
 
232
+ /**
233
+ * @typedef CartDetailCoupon
234
+ * @property {number} [cashback_amount]
235
+ * @property {string} [cashback_message_primary]
236
+ * @property {string} [cashback_message_secondary]
237
+ * @property {string} [coupon_code]
238
+ * @property {string} [coupon_description]
239
+ * @property {string} [coupon_id]
240
+ * @property {string} [coupon_subtitle]
241
+ * @property {string} [coupon_title]
242
+ * @property {string} [coupon_type]
243
+ * @property {number} [coupon_value]
244
+ * @property {number} [discount]
245
+ * @property {boolean} [is_applied]
246
+ * @property {boolean} [is_valid]
247
+ * @property {number} [maximum_discount_value]
248
+ * @property {string} [message]
249
+ * @property {number} [minimum_cart_value]
250
+ */
251
+
227
252
  /**
228
253
  * @typedef CartDetailResponse
229
254
  * @property {AppliedPromotion[]} [applied_promo_details]
230
255
  * @property {CartBreakup} [breakup_values]
231
256
  * @property {boolean} [buy_now]
257
+ * @property {number} [cart_id]
232
258
  * @property {string} [checkout_mode]
233
259
  * @property {string} [comment]
260
+ * @property {CartCommonConfig} [common_config]
261
+ * @property {CartDetailCoupon} [coupon]
234
262
  * @property {string} [coupon_text]
235
263
  * @property {CartCurrency} [currency]
236
264
  * @property {string} [delivery_charge_info]
@@ -241,10 +269,14 @@ const Joi = require("joi");
241
269
  * @property {CartProductInfo[]} [items]
242
270
  * @property {string} [last_modified]
243
271
  * @property {string} [message]
272
+ * @property {Object} [notification]
244
273
  * @property {Object} [pan_config]
245
274
  * @property {string} [pan_no]
246
275
  * @property {PaymentSelectionLock} [payment_selection_lock]
247
276
  * @property {boolean} [restrict_checkout]
277
+ * @property {string} [staff_user_id]
278
+ * @property {boolean} [success]
279
+ * @property {string} [uid]
248
280
  */
249
281
 
250
282
  /**
@@ -349,6 +381,12 @@ const Joi = require("joi");
349
381
  * @property {number} [uid] - Product Category Id
350
382
  */
351
383
 
384
+ /**
385
+ * @typedef ChargesThreshold
386
+ * @property {number} [charges]
387
+ * @property {number} [threshold]
388
+ */
389
+
352
390
  /**
353
391
  * @typedef CheckCart
354
392
  * @property {CartBreakup} [breakup_values]
@@ -458,6 +496,12 @@ const Joi = require("joi");
458
496
  * if not archived.
459
497
  */
460
498
 
499
+ /**
500
+ * @typedef DeliveryChargesConfig
501
+ * @property {ChargesThreshold[]} [charges]
502
+ * @property {boolean} [enabled]
503
+ */
504
+
461
505
  /**
462
506
  * @typedef DiscountRulesApp
463
507
  * @property {Object} [item_criteria] - Item criteria of promotion
@@ -1209,6 +1253,13 @@ class CartApplicationModel {
1209
1253
  });
1210
1254
  }
1211
1255
 
1256
+ /** @returns {CartCommonConfig} */
1257
+ static CartCommonConfig() {
1258
+ return Joi.object({
1259
+ delivery_charges_config: CartApplicationModel.DeliveryChargesConfig(),
1260
+ });
1261
+ }
1262
+
1212
1263
  /** @returns {CartCurrency} */
1213
1264
  static CartCurrency() {
1214
1265
  return Joi.object({
@@ -1217,6 +1268,28 @@ class CartApplicationModel {
1217
1268
  });
1218
1269
  }
1219
1270
 
1271
+ /** @returns {CartDetailCoupon} */
1272
+ static CartDetailCoupon() {
1273
+ return Joi.object({
1274
+ cashback_amount: Joi.number(),
1275
+ cashback_message_primary: Joi.string().allow(""),
1276
+ cashback_message_secondary: Joi.string().allow(""),
1277
+ coupon_code: Joi.string().allow(""),
1278
+ coupon_description: Joi.string().allow(""),
1279
+ coupon_id: Joi.string().allow(""),
1280
+ coupon_subtitle: Joi.string().allow(""),
1281
+ coupon_title: Joi.string().allow(""),
1282
+ coupon_type: Joi.string().allow(""),
1283
+ coupon_value: Joi.number(),
1284
+ discount: Joi.number(),
1285
+ is_applied: Joi.boolean(),
1286
+ is_valid: Joi.boolean(),
1287
+ maximum_discount_value: Joi.number(),
1288
+ message: Joi.string().allow(""),
1289
+ minimum_cart_value: Joi.number(),
1290
+ });
1291
+ }
1292
+
1220
1293
  /** @returns {CartDetailResponse} */
1221
1294
  static CartDetailResponse() {
1222
1295
  return Joi.object({
@@ -1225,8 +1298,11 @@ class CartApplicationModel {
1225
1298
  ),
1226
1299
  breakup_values: CartApplicationModel.CartBreakup(),
1227
1300
  buy_now: Joi.boolean(),
1301
+ cart_id: Joi.number(),
1228
1302
  checkout_mode: Joi.string().allow(""),
1229
1303
  comment: Joi.string().allow(""),
1304
+ common_config: CartApplicationModel.CartCommonConfig(),
1305
+ coupon: CartApplicationModel.CartDetailCoupon(),
1230
1306
  coupon_text: Joi.string().allow(""),
1231
1307
  currency: CartApplicationModel.CartCurrency(),
1232
1308
  delivery_charge_info: Joi.string().allow(""),
@@ -1237,10 +1313,14 @@ class CartApplicationModel {
1237
1313
  items: Joi.array().items(CartApplicationModel.CartProductInfo()),
1238
1314
  last_modified: Joi.string().allow(""),
1239
1315
  message: Joi.string().allow(""),
1316
+ notification: Joi.any(),
1240
1317
  pan_config: Joi.any(),
1241
1318
  pan_no: Joi.string().allow(""),
1242
1319
  payment_selection_lock: CartApplicationModel.PaymentSelectionLock(),
1243
1320
  restrict_checkout: Joi.boolean(),
1321
+ staff_user_id: Joi.string().allow(""),
1322
+ success: Joi.boolean(),
1323
+ uid: Joi.string().allow(""),
1244
1324
  });
1245
1325
  }
1246
1326
 
@@ -1364,6 +1444,14 @@ class CartApplicationModel {
1364
1444
  });
1365
1445
  }
1366
1446
 
1447
+ /** @returns {ChargesThreshold} */
1448
+ static ChargesThreshold() {
1449
+ return Joi.object({
1450
+ charges: Joi.number(),
1451
+ threshold: Joi.number(),
1452
+ });
1453
+ }
1454
+
1367
1455
  /** @returns {CheckCart} */
1368
1456
  static CheckCart() {
1369
1457
  return Joi.object({
@@ -1490,6 +1578,14 @@ class CartApplicationModel {
1490
1578
  });
1491
1579
  }
1492
1580
 
1581
+ /** @returns {DeliveryChargesConfig} */
1582
+ static DeliveryChargesConfig() {
1583
+ return Joi.object({
1584
+ charges: Joi.array().items(CartApplicationModel.ChargesThreshold()),
1585
+ enabled: Joi.boolean(),
1586
+ });
1587
+ }
1588
+
1493
1589
  /** @returns {DiscountRulesApp} */
1494
1590
  static DiscountRulesApp() {
1495
1591
  return Joi.object({
@@ -524,7 +524,7 @@ declare class Catalog {
524
524
  * @summary: Get store meta information.
525
525
  * @description: Use this API to get a list of stores in a specific application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getStores/).
526
526
  */
527
- getStores({ pageNo, pageSize, q, city, range, latitude, longitude, requestHeaders, }?: CatalogApplicationValidator.GetStoresParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.StoreListingResponse>;
527
+ getStores({ pageNo, pageSize, q, city, range, latitude, longitude, tags, requestHeaders, }?: CatalogApplicationValidator.GetStoresParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.StoreListingResponse>;
528
528
  /**
529
529
  * @param {Object} arg - Arg object.
530
530
  * @param {number} [arg.pageSize] - Number of items to retrieve in each page.
@@ -536,17 +536,19 @@ declare class Catalog {
536
536
  * wants to retreive the nearest stores, e.g. 72.8691788
537
537
  * @param {number} [arg.longitude] - Longitude of the location from where
538
538
  * one wants to retreive the nearest stores, e.g. 19.1174114
539
+ * @param {string} [arg.tags] - Search stores based on tags.
539
540
  * @returns {Paginator<CatalogApplicationModel.StoreListingResponse>}
540
541
  * @summary: Get store meta information.
541
542
  * @description: Use this API to get a list of stores in a specific application.
542
543
  */
543
- getStoresPaginator({ pageSize, q, city, range, latitude, longitude }?: {
544
+ getStoresPaginator({ pageSize, q, city, range, latitude, longitude, tags, }?: {
544
545
  pageSize?: number;
545
546
  q?: string;
546
547
  city?: string;
547
548
  range?: number;
548
549
  latitude?: number;
549
550
  longitude?: number;
551
+ tags?: string;
550
552
  }): Paginator<CatalogApplicationModel.StoreListingResponse>;
551
553
  /**
552
554
  * @param {CatalogApplicationValidator.UnfollowByIdParam} arg - Arg object.
@@ -2788,12 +2788,13 @@ class Catalog {
2788
2788
  range,
2789
2789
  latitude,
2790
2790
  longitude,
2791
+ tags,
2791
2792
  requestHeaders,
2792
2793
  } = { requestHeaders: {} },
2793
2794
  { responseHeaders } = { responseHeaders: false }
2794
2795
  ) {
2795
2796
  const { error } = CatalogApplicationValidator.getStores().validate(
2796
- { pageNo, pageSize, q, city, range, latitude, longitude },
2797
+ { pageNo, pageSize, q, city, range, latitude, longitude, tags },
2797
2798
  { abortEarly: false, allowUnknown: true }
2798
2799
  );
2799
2800
  if (error) {
@@ -2804,7 +2805,7 @@ class Catalog {
2804
2805
  const {
2805
2806
  error: warrning,
2806
2807
  } = CatalogApplicationValidator.getStores().validate(
2807
- { pageNo, pageSize, q, city, range, latitude, longitude },
2808
+ { pageNo, pageSize, q, city, range, latitude, longitude, tags },
2808
2809
  { abortEarly: false, allowUnknown: false }
2809
2810
  );
2810
2811
  if (warrning) {
@@ -2822,6 +2823,7 @@ class Catalog {
2822
2823
  query_params["range"] = range;
2823
2824
  query_params["latitude"] = latitude;
2824
2825
  query_params["longitude"] = longitude;
2826
+ query_params["tags"] = tags;
2825
2827
 
2826
2828
  const xHeaders = {};
2827
2829
 
@@ -2875,11 +2877,20 @@ class Catalog {
2875
2877
  * wants to retreive the nearest stores, e.g. 72.8691788
2876
2878
  * @param {number} [arg.longitude] - Longitude of the location from where
2877
2879
  * one wants to retreive the nearest stores, e.g. 19.1174114
2880
+ * @param {string} [arg.tags] - Search stores based on tags.
2878
2881
  * @returns {Paginator<CatalogApplicationModel.StoreListingResponse>}
2879
2882
  * @summary: Get store meta information.
2880
2883
  * @description: Use this API to get a list of stores in a specific application.
2881
2884
  */
2882
- getStoresPaginator({ pageSize, q, city, range, latitude, longitude } = {}) {
2885
+ getStoresPaginator({
2886
+ pageSize,
2887
+ q,
2888
+ city,
2889
+ range,
2890
+ latitude,
2891
+ longitude,
2892
+ tags,
2893
+ } = {}) {
2883
2894
  const paginator = new Paginator();
2884
2895
  const callback = async () => {
2885
2896
  const pageId = paginator.nextId;
@@ -2893,6 +2904,7 @@ class Catalog {
2893
2904
  range: range,
2894
2905
  latitude: latitude,
2895
2906
  longitude: longitude,
2907
+ tags: tags,
2896
2908
  });
2897
2909
  paginator.setPaginator({
2898
2910
  hasNext: data.page.has_next ? true : false,
@@ -871,6 +871,7 @@ export = CatalogApplicationModel;
871
871
  * @property {string} [state]
872
872
  * @property {string} [store_code]
873
873
  * @property {string} [store_email]
874
+ * @property {string[]} [tags]
874
875
  * @property {number} [uid]
875
876
  */
876
877
  /**
@@ -2201,6 +2202,7 @@ type Store = {
2201
2202
  state?: string;
2202
2203
  store_code?: string;
2203
2204
  store_email?: string;
2205
+ tags?: string[];
2204
2206
  uid?: number;
2205
2207
  };
2206
2208
  /** @returns {StoreAddressSerializer} */
@@ -977,6 +977,7 @@ const Joi = require("joi");
977
977
  * @property {string} [state]
978
978
  * @property {string} [store_code]
979
979
  * @property {string} [store_email]
980
+ * @property {string[]} [tags]
980
981
  * @property {number} [uid]
981
982
  */
982
983
 
@@ -2320,6 +2321,7 @@ class CatalogApplicationModel {
2320
2321
  state: Joi.string().allow(""),
2321
2322
  store_code: Joi.string().allow(""),
2322
2323
  store_email: Joi.string().allow(""),
2324
+ tags: Joi.array().items(Joi.string().allow("")),
2323
2325
  uid: Joi.number(),
2324
2326
  });
2325
2327
  }
@@ -246,6 +246,7 @@ export = CatalogApplicationValidator;
246
246
  * to retreive the nearest stores, e.g. 72.8691788
247
247
  * @property {number} [longitude] - Longitude of the location from where one
248
248
  * wants to retreive the nearest stores, e.g. 19.1174114
249
+ * @property {string} [tags] - Search stores based on tags.
249
250
  */
250
251
  /**
251
252
  * @typedef UnfollowByIdParam
@@ -785,6 +786,10 @@ type GetStoresParam = {
785
786
  * wants to retreive the nearest stores, e.g. 19.1174114
786
787
  */
787
788
  longitude?: number;
789
+ /**
790
+ * - Search stores based on tags.
791
+ */
792
+ tags?: string;
788
793
  };
789
794
  type UnfollowByIdParam = {
790
795
  /**
@@ -277,6 +277,7 @@ const CatalogApplicationModel = require("./CatalogApplicationModel");
277
277
  * to retreive the nearest stores, e.g. 72.8691788
278
278
  * @property {number} [longitude] - Longitude of the location from where one
279
279
  * wants to retreive the nearest stores, e.g. 19.1174114
280
+ * @property {string} [tags] - Search stores based on tags.
280
281
  */
281
282
 
282
283
  /**
@@ -540,6 +541,7 @@ class CatalogApplicationValidator {
540
541
  range: Joi.number(),
541
542
  latitude: Joi.number(),
542
543
  longitude: Joi.number(),
544
+ tags: Joi.string().allow(""),
543
545
  });
544
546
  }
545
547
 
@@ -597,6 +597,7 @@ export = CatalogPlatformModel;
597
597
  * @property {string} [sort_on]
598
598
  * @property {string[]} [tag]
599
599
  * @property {string} [type]
600
+ * @property {string} [uid]
600
601
  * @property {string[]} [visible_facets_keys]
601
602
  */
602
603
  /**
@@ -4027,6 +4028,7 @@ type CollectionCreateResponse = {
4027
4028
  sort_on?: string;
4028
4029
  tag?: string[];
4029
4030
  type?: string;
4031
+ uid?: string;
4030
4032
  visible_facets_keys?: string[];
4031
4033
  };
4032
4034
  /** @returns {CollectionDetailResponse} */
@@ -673,6 +673,7 @@ const Joi = require("joi");
673
673
  * @property {string} [sort_on]
674
674
  * @property {string[]} [tag]
675
675
  * @property {string} [type]
676
+ * @property {string} [uid]
676
677
  * @property {string[]} [visible_facets_keys]
677
678
  */
678
679
 
@@ -4295,6 +4296,7 @@ class CatalogPlatformModel {
4295
4296
  sort_on: Joi.string().allow(""),
4296
4297
  tag: Joi.array().items(Joi.string().allow("")),
4297
4298
  type: Joi.string().allow(""),
4299
+ uid: Joi.string().allow(""),
4298
4300
  visible_facets_keys: Joi.array().items(Joi.string().allow("")),
4299
4301
  });
4300
4302
  }
@@ -337,7 +337,7 @@ declare class Order {
337
337
  * @summary:
338
338
  * @description: Get Shipments Listing for the company id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipments/).
339
339
  */
340
- getShipments({ lane, bagStatus, statusOverrideLane, timeToDispatch, searchType, searchValue, fromDate, toDate, dpIds, stores, salesChannels, pageNo, pageSize, fetchActiveShipment, excludeLockedShipments, paymentMethods, channelShipmentId, channelOrderId, customMeta, orderingChannel, companyAffiliateTag, myOrders, platformUserId, sortType, showCrossCompanyData, tags, customerId, orderType, requestHeaders, }?: OrderPlatformValidator.GetShipmentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponse>;
340
+ getShipments({ lane, bagStatus, statusOverrideLane, timeToDispatch, searchType, searchValue, fromDate, toDate, dpIds, stores, salesChannels, pageNo, pageSize, fetchActiveShipment, allowInactive, excludeLockedShipments, paymentMethods, channelShipmentId, channelOrderId, customMeta, orderingChannel, companyAffiliateTag, myOrders, platformUserId, sortType, showCrossCompanyData, tags, customerId, orderType, requestHeaders, }?: OrderPlatformValidator.GetShipmentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponse>;
341
341
  /**
342
342
  * @param {Object} arg - Arg object.
343
343
  * @param {string} [arg.lane] - Name of lane for which data is to be fetched
@@ -354,6 +354,7 @@ declare class Order {
354
354
  * @param {string} [arg.salesChannels] - Comma separated values of sales channel ids
355
355
  * @param {number} [arg.pageSize] - Page size of data received per page
356
356
  * @param {boolean} [arg.fetchActiveShipment] - Flag to fetch active shipments
357
+ * @param {boolean} [arg.allowInactive] - Flag to allow inactive shipments
357
358
  * @param {boolean} [arg.excludeLockedShipments] - Flag to fetch locked shipments
358
359
  * @param {string} [arg.paymentMethods] - Comma separated values of payment methods
359
360
  * @param {string} [arg.channelShipmentId] - App Shipment Id
@@ -373,7 +374,7 @@ declare class Order {
373
374
  * @summary:
374
375
  * @description: Get Shipments Listing for the company id
375
376
  */
376
- getShipmentsPaginator({ lane, bagStatus, statusOverrideLane, timeToDispatch, searchType, searchValue, fromDate, toDate, dpIds, stores, salesChannels, pageSize, fetchActiveShipment, excludeLockedShipments, paymentMethods, channelShipmentId, channelOrderId, customMeta, orderingChannel, companyAffiliateTag, myOrders, platformUserId, sortType, showCrossCompanyData, tags, customerId, orderType, }?: {
377
+ getShipmentsPaginator({ lane, bagStatus, statusOverrideLane, timeToDispatch, searchType, searchValue, fromDate, toDate, dpIds, stores, salesChannels, pageSize, fetchActiveShipment, allowInactive, excludeLockedShipments, paymentMethods, channelShipmentId, channelOrderId, customMeta, orderingChannel, companyAffiliateTag, myOrders, platformUserId, sortType, showCrossCompanyData, tags, customerId, orderType, }?: {
377
378
  lane?: string;
378
379
  bagStatus?: string;
379
380
  statusOverrideLane?: boolean;
@@ -387,6 +388,7 @@ declare class Order {
387
388
  salesChannels?: string;
388
389
  pageSize?: number;
389
390
  fetchActiveShipment?: boolean;
391
+ allowInactive?: boolean;
390
392
  excludeLockedShipments?: boolean;
391
393
  paymentMethods?: string;
392
394
  channelShipmentId?: string;
@@ -2464,6 +2464,7 @@ class Order {
2464
2464
  pageNo,
2465
2465
  pageSize,
2466
2466
  fetchActiveShipment,
2467
+ allowInactive,
2467
2468
  excludeLockedShipments,
2468
2469
  paymentMethods,
2469
2470
  channelShipmentId,
@@ -2498,6 +2499,7 @@ class Order {
2498
2499
  pageNo,
2499
2500
  pageSize,
2500
2501
  fetchActiveShipment,
2502
+ allowInactive,
2501
2503
  excludeLockedShipments,
2502
2504
  paymentMethods,
2503
2505
  channelShipmentId,
@@ -2536,6 +2538,7 @@ class Order {
2536
2538
  pageNo,
2537
2539
  pageSize,
2538
2540
  fetchActiveShipment,
2541
+ allowInactive,
2539
2542
  excludeLockedShipments,
2540
2543
  paymentMethods,
2541
2544
  channelShipmentId,
@@ -2575,6 +2578,7 @@ class Order {
2575
2578
  query_params["page_no"] = pageNo;
2576
2579
  query_params["page_size"] = pageSize;
2577
2580
  query_params["fetch_active_shipment"] = fetchActiveShipment;
2581
+ query_params["allow_inactive"] = allowInactive;
2578
2582
  query_params["exclude_locked_shipments"] = excludeLockedShipments;
2579
2583
  query_params["payment_methods"] = paymentMethods;
2580
2584
  query_params["channel_shipment_id"] = channelShipmentId;
@@ -2644,6 +2648,7 @@ class Order {
2644
2648
  * @param {string} [arg.salesChannels] - Comma separated values of sales channel ids
2645
2649
  * @param {number} [arg.pageSize] - Page size of data received per page
2646
2650
  * @param {boolean} [arg.fetchActiveShipment] - Flag to fetch active shipments
2651
+ * @param {boolean} [arg.allowInactive] - Flag to allow inactive shipments
2647
2652
  * @param {boolean} [arg.excludeLockedShipments] - Flag to fetch locked shipments
2648
2653
  * @param {string} [arg.paymentMethods] - Comma separated values of payment methods
2649
2654
  * @param {string} [arg.channelShipmentId] - App Shipment Id
@@ -2677,6 +2682,7 @@ class Order {
2677
2682
  salesChannels,
2678
2683
  pageSize,
2679
2684
  fetchActiveShipment,
2685
+ allowInactive,
2680
2686
  excludeLockedShipments,
2681
2687
  paymentMethods,
2682
2688
  channelShipmentId,
@@ -2712,6 +2718,7 @@ class Order {
2712
2718
  pageNo: pageNo,
2713
2719
  pageSize: pageSize,
2714
2720
  fetchActiveShipment: fetchActiveShipment,
2721
+ allowInactive: allowInactive,
2715
2722
  excludeLockedShipments: excludeLockedShipments,
2716
2723
  paymentMethods: paymentMethods,
2717
2724
  channelShipmentId: channelShipmentId,
@@ -133,9 +133,12 @@ export = OrderPlatformModel;
133
133
  * @property {string} [channel_order_id]
134
134
  * @property {string} [channel_shipment_id]
135
135
  * @property {string} [coupon_code]
136
+ * @property {number} [customer_selling_price]
136
137
  * @property {string} [due_date]
137
138
  * @property {number} [employee_discount]
139
+ * @property {number} [fulfilment_priority]
138
140
  * @property {boolean} [is_priority]
141
+ * @property {boolean} [is_serial_number_required]
139
142
  * @property {number} [loyalty_discount]
140
143
  * @property {string} [marketplace_invoice_id]
141
144
  * @property {string} [order_item_id]
@@ -2547,9 +2550,12 @@ type AffiliateMeta = {
2547
2550
  channel_order_id?: string;
2548
2551
  channel_shipment_id?: string;
2549
2552
  coupon_code?: string;
2553
+ customer_selling_price?: number;
2550
2554
  due_date?: string;
2551
2555
  employee_discount?: number;
2556
+ fulfilment_priority?: number;
2552
2557
  is_priority?: boolean;
2558
+ is_serial_number_required?: boolean;
2553
2559
  loyalty_discount?: number;
2554
2560
  marketplace_invoice_id?: string;
2555
2561
  order_item_id?: string;
@@ -150,9 +150,12 @@ const Joi = require("joi");
150
150
  * @property {string} [channel_order_id]
151
151
  * @property {string} [channel_shipment_id]
152
152
  * @property {string} [coupon_code]
153
+ * @property {number} [customer_selling_price]
153
154
  * @property {string} [due_date]
154
155
  * @property {number} [employee_discount]
156
+ * @property {number} [fulfilment_priority]
155
157
  * @property {boolean} [is_priority]
158
+ * @property {boolean} [is_serial_number_required]
156
159
  * @property {number} [loyalty_discount]
157
160
  * @property {string} [marketplace_invoice_id]
158
161
  * @property {string} [order_item_id]
@@ -2833,9 +2836,12 @@ class OrderPlatformModel {
2833
2836
  channel_order_id: Joi.string().allow("").allow(null),
2834
2837
  channel_shipment_id: Joi.string().allow("").allow(null),
2835
2838
  coupon_code: Joi.string().allow("").allow(null),
2839
+ customer_selling_price: Joi.number().allow(null),
2836
2840
  due_date: Joi.string().allow("").allow(null),
2837
2841
  employee_discount: Joi.number().allow(null),
2842
+ fulfilment_priority: Joi.number().allow(null),
2838
2843
  is_priority: Joi.boolean().allow(null),
2844
+ is_serial_number_required: Joi.boolean().allow(null),
2839
2845
  loyalty_discount: Joi.number().allow(null),
2840
2846
  marketplace_invoice_id: Joi.string().allow("").allow(null),
2841
2847
  order_item_id: Joi.string().allow("").allow(null),
@@ -190,6 +190,7 @@ export = OrderPlatformValidator;
190
190
  * @property {number} [pageNo] - Page number for paginated data
191
191
  * @property {number} [pageSize] - Page size of data received per page
192
192
  * @property {boolean} [fetchActiveShipment] - Flag to fetch active shipments
193
+ * @property {boolean} [allowInactive] - Flag to allow inactive shipments
193
194
  * @property {boolean} [excludeLockedShipments] - Flag to fetch locked shipments
194
195
  * @property {string} [paymentMethods] - Comma separated values of payment methods
195
196
  * @property {string} [channelShipmentId] - App Shipment Id
@@ -747,6 +748,10 @@ type GetShipmentsParam = {
747
748
  * - Flag to fetch active shipments
748
749
  */
749
750
  fetchActiveShipment?: boolean;
751
+ /**
752
+ * - Flag to allow inactive shipments
753
+ */
754
+ allowInactive?: boolean;
750
755
  /**
751
756
  * - Flag to fetch locked shipments
752
757
  */
@@ -219,6 +219,7 @@ const OrderPlatformModel = require("./OrderPlatformModel");
219
219
  * @property {number} [pageNo] - Page number for paginated data
220
220
  * @property {number} [pageSize] - Page size of data received per page
221
221
  * @property {boolean} [fetchActiveShipment] - Flag to fetch active shipments
222
+ * @property {boolean} [allowInactive] - Flag to allow inactive shipments
222
223
  * @property {boolean} [excludeLockedShipments] - Flag to fetch locked shipments
223
224
  * @property {string} [paymentMethods] - Comma separated values of payment methods
224
225
  * @property {string} [channelShipmentId] - App Shipment Id
@@ -595,6 +596,7 @@ class OrderPlatformValidator {
595
596
  pageNo: Joi.number(),
596
597
  pageSize: Joi.number(),
597
598
  fetchActiveShipment: Joi.boolean(),
599
+ allowInactive: Joi.boolean(),
598
600
  excludeLockedShipments: Joi.boolean(),
599
601
  paymentMethods: Joi.string().allow(""),
600
602
  channelShipmentId: Joi.string().allow(""),