@gofynd/fdk-client-javascript 3.4.0 → 3.4.1
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 +1 -1
- package/package.json +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +111 -43
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +65 -33
- package/sdk/platform/Cart/CartPlatformModel.d.ts +262 -12
- package/sdk/platform/Cart/CartPlatformModel.js +334 -10
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +4 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +9 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +4 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +2 -0
- package/sdk/platform/Content/ContentPlatformModel.d.ts +14 -19
- package/sdk/platform/Content/ContentPlatformModel.js +6 -20
- package/sdk/platform/Order/OrderPlatformModel.d.ts +218 -17
- package/sdk/platform/Order/OrderPlatformModel.js +366 -14
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +15 -15
- package/sdk/platform/Order/OrderPlatformValidator.js +9 -9
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +7 -5
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +4 -3
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +97 -1
- package/sdk/platform/Payment/PaymentPlatformModel.js +273 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +50 -4
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +22 -2
|
@@ -356,6 +356,58 @@ const Joi = require("joi");
|
|
|
356
356
|
* @property {string[]} [item_sku] - List of all item sku on which promotion is applicable
|
|
357
357
|
*/
|
|
358
358
|
|
|
359
|
+
/**
|
|
360
|
+
* @typedef BuyRuleItemCriteria
|
|
361
|
+
* @property {CompareObject} [cart_quantity]
|
|
362
|
+
* @property {string[]} [available_zones] - List of all zones on which promotion
|
|
363
|
+
* is applicable
|
|
364
|
+
* @property {number[]} [item_exclude_company] - List of all company id on which
|
|
365
|
+
* promotion is not applicable
|
|
366
|
+
* @property {number[]} [item_id] - List of all item ids on which promotion is applicable
|
|
367
|
+
* @property {number[]} [item_l1_category] - List of all L1 category on which
|
|
368
|
+
* promotion is applicable
|
|
369
|
+
* @property {CompareObject} [cart_total]
|
|
370
|
+
* @property {CompareObject} [cart_unique_item_quantity]
|
|
371
|
+
* @property {CompareObject} [cart_unique_item_amount]
|
|
372
|
+
* @property {number[]} [item_exclude_id] - List of all item ids on which
|
|
373
|
+
* promotion is not applicable
|
|
374
|
+
* @property {boolean} [all_items] - Boolean flag set true to applicable the
|
|
375
|
+
* promotion for all products
|
|
376
|
+
* @property {number[]} [item_exclude_l1_category] - List of all item ids on
|
|
377
|
+
* which promotion is not applicable
|
|
378
|
+
* @property {string[]} [item_size] - List of all item sizes on which promotion
|
|
379
|
+
* is applicable
|
|
380
|
+
* @property {number[]} [item_store] - List of all item store ids on which
|
|
381
|
+
* promotion is applicable
|
|
382
|
+
* @property {string[]} [item_exclude_sku] - List of all item sku on which
|
|
383
|
+
* promotion is not applicable
|
|
384
|
+
* @property {number[]} [item_department] - List of all departments ids on which
|
|
385
|
+
* promotion is applicable
|
|
386
|
+
* @property {number[]} [item_exclude_store] - List of all item store ids on
|
|
387
|
+
* which promotion is not applicable
|
|
388
|
+
* @property {number[]} [item_brand] - List of all brand ids on which promotion
|
|
389
|
+
* is applicable
|
|
390
|
+
* @property {number[]} [item_exclude_department] - List of all department ids
|
|
391
|
+
* on which promotion is not applicable
|
|
392
|
+
* @property {number[]} [item_exclude_category] - List of all L3 category on
|
|
393
|
+
* which promotion is not applicable
|
|
394
|
+
* @property {number[]} [item_category] - List of all L3 category on which
|
|
395
|
+
* promotion is applicable
|
|
396
|
+
* @property {string[]} [buy_rules]
|
|
397
|
+
* @property {number[]} [item_exclude_brand] - List of all brand ids on which
|
|
398
|
+
* promotion is not applicable
|
|
399
|
+
* @property {number[]} [item_l2_category] - List of all L2 category on which
|
|
400
|
+
* promotion is applicable
|
|
401
|
+
* @property {number[]} [item_company] - List of all company ids on which
|
|
402
|
+
* promotion is applicable
|
|
403
|
+
* @property {string[]} [item_tags] - List of all product tags on which
|
|
404
|
+
* promotion is applicable
|
|
405
|
+
* @property {number[]} [item_exclude_l2_category] - List of all L2 category on
|
|
406
|
+
* which promotion is not applicable
|
|
407
|
+
* @property {string[]} [item_sku] - List of all item sku on which promotion is applicable
|
|
408
|
+
* @property {ItemSizeMapping} [meta]
|
|
409
|
+
*/
|
|
410
|
+
|
|
359
411
|
/**
|
|
360
412
|
* @typedef DiscountOffer
|
|
361
413
|
* @property {number} [max_discount_amount] - Maximum discount amount in promotion
|
|
@@ -546,7 +598,7 @@ const Joi = require("joi");
|
|
|
546
598
|
* @property {PromotionAuthor} [author]
|
|
547
599
|
* @property {Visibility} [visiblility]
|
|
548
600
|
* @property {string} application_id - Current application id of sales channel
|
|
549
|
-
* @property {
|
|
601
|
+
* @property {BuyRuleItemCriteria} [buy_rules]
|
|
550
602
|
* @property {Object} [_custom_json] - Set extra properties in promotion
|
|
551
603
|
* @property {PromotionDateMeta} [date_meta]
|
|
552
604
|
* @property {string[]} [tags] - List of tags applicable for promotion
|
|
@@ -653,7 +705,7 @@ const Joi = require("joi");
|
|
|
653
705
|
* @property {PromotionAuthor} [author]
|
|
654
706
|
* @property {Visibility} [visiblility]
|
|
655
707
|
* @property {string} application_id - Current application id of sales channel
|
|
656
|
-
* @property {
|
|
708
|
+
* @property {BuyRuleItemCriteria} [buy_rules]
|
|
657
709
|
* @property {Object} [_custom_json] - Set extra properties in promotion
|
|
658
710
|
* @property {PromotionDateMeta} [date_meta]
|
|
659
711
|
* @property {string[]} [tags] - List of tags applicable for promotion
|
|
@@ -1315,7 +1367,7 @@ const Joi = require("joi");
|
|
|
1315
1367
|
* @property {string} [state] - State of the address
|
|
1316
1368
|
* @property {string} [city] - City of the address
|
|
1317
1369
|
* @property {number} [phone] - Phone number for address
|
|
1318
|
-
* @property {string} area_code - Area code of the address
|
|
1370
|
+
* @property {string} [area_code] - Area code of the address
|
|
1319
1371
|
* @property {string} [country_iso_code] - Country iso code for address
|
|
1320
1372
|
* @property {string} [country_phone_code] - Country phone code for address
|
|
1321
1373
|
* @property {Object} [meta] - Metadata of the address
|
|
@@ -1863,7 +1915,8 @@ const Joi = require("joi");
|
|
|
1863
1915
|
|
|
1864
1916
|
/**
|
|
1865
1917
|
* @typedef UpdateUserCartMapping
|
|
1866
|
-
* @property {string} user_id -
|
|
1918
|
+
* @property {string} [user_id] - Customer user ID to associate with the cart.
|
|
1919
|
+
* Send null to remove existing mapping of customer from cart.
|
|
1867
1920
|
*/
|
|
1868
1921
|
|
|
1869
1922
|
/**
|
|
@@ -2613,9 +2666,88 @@ const Joi = require("joi");
|
|
|
2613
2666
|
* | "kiosk"
|
|
2614
2667
|
* | "scan_go"
|
|
2615
2668
|
* | "smart_trolley"
|
|
2669
|
+
* | "gofynd"
|
|
2670
|
+
* | "uniket"
|
|
2616
2671
|
* | "marketplace"
|
|
2617
2672
|
* | "social_commerce"
|
|
2618
|
-
* | "ondc"
|
|
2673
|
+
* | "ondc"
|
|
2674
|
+
* | "nexus"
|
|
2675
|
+
* | "nykaa_fashion"
|
|
2676
|
+
* | "etsy"
|
|
2677
|
+
* | "vuivui"
|
|
2678
|
+
* | "zilingo"
|
|
2679
|
+
* | "firstcry"
|
|
2680
|
+
* | "bukalapak"
|
|
2681
|
+
* | "myntra_ppmp"
|
|
2682
|
+
* | "lazada"
|
|
2683
|
+
* | "tiktok"
|
|
2684
|
+
* | "sfcc"
|
|
2685
|
+
* | "debenhams"
|
|
2686
|
+
* | "prestomall"
|
|
2687
|
+
* | "meesho"
|
|
2688
|
+
* | "amazon_vdf"
|
|
2689
|
+
* | "bigcommerce"
|
|
2690
|
+
* | "sendo"
|
|
2691
|
+
* | "storehippo"
|
|
2692
|
+
* | "cdiscount"
|
|
2693
|
+
* | "nykaa"
|
|
2694
|
+
* | "trendyol"
|
|
2695
|
+
* | "weloveshopping"
|
|
2696
|
+
* | "jollee"
|
|
2697
|
+
* | "wish"
|
|
2698
|
+
* | "tiki"
|
|
2699
|
+
* | "central_online"
|
|
2700
|
+
* | "q10"
|
|
2701
|
+
* | "cred"
|
|
2702
|
+
* | "walmart"
|
|
2703
|
+
* | "snapdeal"
|
|
2704
|
+
* | "flipkart"
|
|
2705
|
+
* | "blibli"
|
|
2706
|
+
* | "ajio_jit"
|
|
2707
|
+
* | "pharmeasy"
|
|
2708
|
+
* | "ezmall"
|
|
2709
|
+
* | "adobe_commerce"
|
|
2710
|
+
* | "kartmax"
|
|
2711
|
+
* | "shopee"
|
|
2712
|
+
* | "zalora"
|
|
2713
|
+
* | "prestashop"
|
|
2714
|
+
* | "smytten"
|
|
2715
|
+
* | "amazon_sc"
|
|
2716
|
+
* | "urbanpiper"
|
|
2717
|
+
* | "flipkart_quick"
|
|
2718
|
+
* | "woocommerce"
|
|
2719
|
+
* | "zivame"
|
|
2720
|
+
* | "lelong"
|
|
2721
|
+
* | "facebook"
|
|
2722
|
+
* | "jiomart"
|
|
2723
|
+
* | "gmc"
|
|
2724
|
+
* | "robins"
|
|
2725
|
+
* | "akulaku"
|
|
2726
|
+
* | "noon"
|
|
2727
|
+
* | "tatacliq"
|
|
2728
|
+
* | "kartrocket"
|
|
2729
|
+
* | "inorbit"
|
|
2730
|
+
* | "ajio_business"
|
|
2731
|
+
* | "swiggy"
|
|
2732
|
+
* | "asos"
|
|
2733
|
+
* | "tokopedia"
|
|
2734
|
+
* | "limeroad"
|
|
2735
|
+
* | "myntra_omni"
|
|
2736
|
+
* | "spoyl"
|
|
2737
|
+
* | "amazon_mlf"
|
|
2738
|
+
* | "fulfilled_by_lazada"
|
|
2739
|
+
* | "ebay"
|
|
2740
|
+
* | "jd"
|
|
2741
|
+
* | "amazon_pharmacy"
|
|
2742
|
+
* | "ajio_vms"
|
|
2743
|
+
* | "daraz"
|
|
2744
|
+
* | "oker"
|
|
2745
|
+
* | "flipkart_b2b"
|
|
2746
|
+
* | "amazon_mlf_ss"
|
|
2747
|
+
* | "woovly"
|
|
2748
|
+
* | "tata1mg"
|
|
2749
|
+
* | "zomato"
|
|
2750
|
+
* | "shopify"} OrderingSource
|
|
2619
2751
|
*/
|
|
2620
2752
|
|
|
2621
2753
|
class CartPlatformModel {
|
|
@@ -3006,6 +3138,40 @@ class CartPlatformModel {
|
|
|
3006
3138
|
});
|
|
3007
3139
|
}
|
|
3008
3140
|
|
|
3141
|
+
/** @returns {BuyRuleItemCriteria} */
|
|
3142
|
+
static BuyRuleItemCriteria() {
|
|
3143
|
+
return Joi.object({
|
|
3144
|
+
cart_quantity: CartPlatformModel.CompareObject(),
|
|
3145
|
+
available_zones: Joi.array().items(Joi.string().allow("")),
|
|
3146
|
+
item_exclude_company: Joi.array().items(Joi.number()),
|
|
3147
|
+
item_id: Joi.array().items(Joi.number()),
|
|
3148
|
+
item_l1_category: Joi.array().items(Joi.number()),
|
|
3149
|
+
cart_total: CartPlatformModel.CompareObject(),
|
|
3150
|
+
cart_unique_item_quantity: CartPlatformModel.CompareObject(),
|
|
3151
|
+
cart_unique_item_amount: CartPlatformModel.CompareObject(),
|
|
3152
|
+
item_exclude_id: Joi.array().items(Joi.number()),
|
|
3153
|
+
all_items: Joi.boolean(),
|
|
3154
|
+
item_exclude_l1_category: Joi.array().items(Joi.number()),
|
|
3155
|
+
item_size: Joi.array().items(Joi.string().allow("")),
|
|
3156
|
+
item_store: Joi.array().items(Joi.number()),
|
|
3157
|
+
item_exclude_sku: Joi.array().items(Joi.string().allow("")),
|
|
3158
|
+
item_department: Joi.array().items(Joi.number()),
|
|
3159
|
+
item_exclude_store: Joi.array().items(Joi.number()),
|
|
3160
|
+
item_brand: Joi.array().items(Joi.number()),
|
|
3161
|
+
item_exclude_department: Joi.array().items(Joi.number()),
|
|
3162
|
+
item_exclude_category: Joi.array().items(Joi.number()),
|
|
3163
|
+
item_category: Joi.array().items(Joi.number()),
|
|
3164
|
+
buy_rules: Joi.array().items(Joi.string().allow("")),
|
|
3165
|
+
item_exclude_brand: Joi.array().items(Joi.number()),
|
|
3166
|
+
item_l2_category: Joi.array().items(Joi.number()),
|
|
3167
|
+
item_company: Joi.array().items(Joi.number()),
|
|
3168
|
+
item_tags: Joi.array().items(Joi.string().allow("")),
|
|
3169
|
+
item_exclude_l2_category: Joi.array().items(Joi.number()),
|
|
3170
|
+
item_sku: Joi.array().items(Joi.string().allow("")),
|
|
3171
|
+
meta: CartPlatformModel.ItemSizeMapping(),
|
|
3172
|
+
});
|
|
3173
|
+
}
|
|
3174
|
+
|
|
3009
3175
|
/** @returns {DiscountOffer} */
|
|
3010
3176
|
static DiscountOffer() {
|
|
3011
3177
|
return Joi.object({
|
|
@@ -3212,7 +3378,7 @@ class CartPlatformModel {
|
|
|
3212
3378
|
author: CartPlatformModel.PromotionAuthor(),
|
|
3213
3379
|
visiblility: CartPlatformModel.Visibility(),
|
|
3214
3380
|
application_id: Joi.string().allow("").required(),
|
|
3215
|
-
buy_rules: CartPlatformModel.
|
|
3381
|
+
buy_rules: CartPlatformModel.BuyRuleItemCriteria(),
|
|
3216
3382
|
_custom_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
3217
3383
|
date_meta: CartPlatformModel.PromotionDateMeta(),
|
|
3218
3384
|
tags: Joi.array().items(Joi.string().allow("")),
|
|
@@ -3306,7 +3472,7 @@ class CartPlatformModel {
|
|
|
3306
3472
|
author: CartPlatformModel.PromotionAuthor(),
|
|
3307
3473
|
visiblility: CartPlatformModel.Visibility(),
|
|
3308
3474
|
application_id: Joi.string().allow("").required(),
|
|
3309
|
-
buy_rules: CartPlatformModel.
|
|
3475
|
+
buy_rules: CartPlatformModel.BuyRuleItemCriteria(),
|
|
3310
3476
|
_custom_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
3311
3477
|
date_meta: CartPlatformModel.PromotionDateMeta(),
|
|
3312
3478
|
tags: Joi.array().items(Joi.string().allow("")),
|
|
@@ -4005,7 +4171,7 @@ class CartPlatformModel {
|
|
|
4005
4171
|
state: Joi.string().allow("").allow(null),
|
|
4006
4172
|
city: Joi.string().allow("").allow(null),
|
|
4007
4173
|
phone: Joi.number(),
|
|
4008
|
-
area_code: Joi.string().allow("")
|
|
4174
|
+
area_code: Joi.string().allow(""),
|
|
4009
4175
|
country_iso_code: Joi.string().allow(""),
|
|
4010
4176
|
country_phone_code: Joi.string().allow(""),
|
|
4011
4177
|
meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
@@ -4555,7 +4721,7 @@ class CartPlatformModel {
|
|
|
4555
4721
|
/** @returns {UpdateUserCartMapping} */
|
|
4556
4722
|
static UpdateUserCartMapping() {
|
|
4557
4723
|
return Joi.object({
|
|
4558
|
-
user_id: Joi.string().allow("").
|
|
4724
|
+
user_id: Joi.string().allow("").allow(null),
|
|
4559
4725
|
});
|
|
4560
4726
|
}
|
|
4561
4727
|
|
|
@@ -5323,11 +5489,169 @@ class CartPlatformModel {
|
|
|
5323
5489
|
|
|
5324
5490
|
"smart_trolley",
|
|
5325
5491
|
|
|
5492
|
+
"gofynd",
|
|
5493
|
+
|
|
5494
|
+
"uniket",
|
|
5495
|
+
|
|
5326
5496
|
"marketplace",
|
|
5327
5497
|
|
|
5328
5498
|
"social_commerce",
|
|
5329
5499
|
|
|
5330
|
-
"ondc"
|
|
5500
|
+
"ondc",
|
|
5501
|
+
|
|
5502
|
+
"nexus",
|
|
5503
|
+
|
|
5504
|
+
"nykaa_fashion",
|
|
5505
|
+
|
|
5506
|
+
"etsy",
|
|
5507
|
+
|
|
5508
|
+
"vuivui",
|
|
5509
|
+
|
|
5510
|
+
"zilingo",
|
|
5511
|
+
|
|
5512
|
+
"firstcry",
|
|
5513
|
+
|
|
5514
|
+
"bukalapak",
|
|
5515
|
+
|
|
5516
|
+
"myntra_ppmp",
|
|
5517
|
+
|
|
5518
|
+
"lazada",
|
|
5519
|
+
|
|
5520
|
+
"tiktok",
|
|
5521
|
+
|
|
5522
|
+
"sfcc",
|
|
5523
|
+
|
|
5524
|
+
"debenhams",
|
|
5525
|
+
|
|
5526
|
+
"prestomall",
|
|
5527
|
+
|
|
5528
|
+
"meesho",
|
|
5529
|
+
|
|
5530
|
+
"amazon_vdf",
|
|
5531
|
+
|
|
5532
|
+
"bigcommerce",
|
|
5533
|
+
|
|
5534
|
+
"sendo",
|
|
5535
|
+
|
|
5536
|
+
"storehippo",
|
|
5537
|
+
|
|
5538
|
+
"cdiscount",
|
|
5539
|
+
|
|
5540
|
+
"nykaa",
|
|
5541
|
+
|
|
5542
|
+
"trendyol",
|
|
5543
|
+
|
|
5544
|
+
"weloveshopping",
|
|
5545
|
+
|
|
5546
|
+
"jollee",
|
|
5547
|
+
|
|
5548
|
+
"wish",
|
|
5549
|
+
|
|
5550
|
+
"tiki",
|
|
5551
|
+
|
|
5552
|
+
"central_online",
|
|
5553
|
+
|
|
5554
|
+
"q10",
|
|
5555
|
+
|
|
5556
|
+
"cred",
|
|
5557
|
+
|
|
5558
|
+
"walmart",
|
|
5559
|
+
|
|
5560
|
+
"snapdeal",
|
|
5561
|
+
|
|
5562
|
+
"flipkart",
|
|
5563
|
+
|
|
5564
|
+
"blibli",
|
|
5565
|
+
|
|
5566
|
+
"ajio_jit",
|
|
5567
|
+
|
|
5568
|
+
"pharmeasy",
|
|
5569
|
+
|
|
5570
|
+
"ezmall",
|
|
5571
|
+
|
|
5572
|
+
"adobe_commerce",
|
|
5573
|
+
|
|
5574
|
+
"kartmax",
|
|
5575
|
+
|
|
5576
|
+
"shopee",
|
|
5577
|
+
|
|
5578
|
+
"zalora",
|
|
5579
|
+
|
|
5580
|
+
"prestashop",
|
|
5581
|
+
|
|
5582
|
+
"smytten",
|
|
5583
|
+
|
|
5584
|
+
"amazon_sc",
|
|
5585
|
+
|
|
5586
|
+
"urbanpiper",
|
|
5587
|
+
|
|
5588
|
+
"flipkart_quick",
|
|
5589
|
+
|
|
5590
|
+
"woocommerce",
|
|
5591
|
+
|
|
5592
|
+
"zivame",
|
|
5593
|
+
|
|
5594
|
+
"lelong",
|
|
5595
|
+
|
|
5596
|
+
"facebook",
|
|
5597
|
+
|
|
5598
|
+
"jiomart",
|
|
5599
|
+
|
|
5600
|
+
"gmc",
|
|
5601
|
+
|
|
5602
|
+
"robins",
|
|
5603
|
+
|
|
5604
|
+
"akulaku",
|
|
5605
|
+
|
|
5606
|
+
"noon",
|
|
5607
|
+
|
|
5608
|
+
"tatacliq",
|
|
5609
|
+
|
|
5610
|
+
"kartrocket",
|
|
5611
|
+
|
|
5612
|
+
"inorbit",
|
|
5613
|
+
|
|
5614
|
+
"ajio_business",
|
|
5615
|
+
|
|
5616
|
+
"swiggy",
|
|
5617
|
+
|
|
5618
|
+
"asos",
|
|
5619
|
+
|
|
5620
|
+
"tokopedia",
|
|
5621
|
+
|
|
5622
|
+
"limeroad",
|
|
5623
|
+
|
|
5624
|
+
"myntra_omni",
|
|
5625
|
+
|
|
5626
|
+
"spoyl",
|
|
5627
|
+
|
|
5628
|
+
"amazon_mlf",
|
|
5629
|
+
|
|
5630
|
+
"fulfilled_by_lazada",
|
|
5631
|
+
|
|
5632
|
+
"ebay",
|
|
5633
|
+
|
|
5634
|
+
"jd",
|
|
5635
|
+
|
|
5636
|
+
"amazon_pharmacy",
|
|
5637
|
+
|
|
5638
|
+
"ajio_vms",
|
|
5639
|
+
|
|
5640
|
+
"daraz",
|
|
5641
|
+
|
|
5642
|
+
"oker",
|
|
5643
|
+
|
|
5644
|
+
"flipkart_b2b",
|
|
5645
|
+
|
|
5646
|
+
"amazon_mlf_ss",
|
|
5647
|
+
|
|
5648
|
+
"woovly",
|
|
5649
|
+
|
|
5650
|
+
"tata1mg",
|
|
5651
|
+
|
|
5652
|
+
"zomato",
|
|
5653
|
+
|
|
5654
|
+
"shopify"
|
|
5331
5655
|
);
|
|
5332
5656
|
}
|
|
5333
5657
|
}
|
|
@@ -758,7 +758,7 @@ declare class Catalog {
|
|
|
758
758
|
* @summary: Get configuration
|
|
759
759
|
* @description: Retrieve configuration details based on a specific type in the catalog for a company and an sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getConfigurationByType/).
|
|
760
760
|
*/
|
|
761
|
-
getConfigurationByType({ type, requestHeaders }?: CatalogPlatformApplicationValidator.GetConfigurationByTypeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAppCatalogEntityConfiguration>;
|
|
761
|
+
getConfigurationByType({ type, includeInactive, requestHeaders }?: CatalogPlatformApplicationValidator.GetConfigurationByTypeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAppCatalogEntityConfiguration>;
|
|
762
762
|
/**
|
|
763
763
|
* @param {CatalogPlatformApplicationValidator.GetConfigurationMetadataParam} arg
|
|
764
764
|
* - Arg object
|
|
@@ -4021,7 +4021,7 @@ class Catalog {
|
|
|
4021
4021
|
* @description: Retrieve configuration details based on a specific type in the catalog for a company and an sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getConfigurationByType/).
|
|
4022
4022
|
*/
|
|
4023
4023
|
async getConfigurationByType(
|
|
4024
|
-
{ type, requestHeaders } = { requestHeaders: {} },
|
|
4024
|
+
{ type, includeInactive, requestHeaders } = { requestHeaders: {} },
|
|
4025
4025
|
{ responseHeaders } = { responseHeaders: false }
|
|
4026
4026
|
) {
|
|
4027
4027
|
const {
|
|
@@ -4029,6 +4029,7 @@ class Catalog {
|
|
|
4029
4029
|
} = CatalogPlatformApplicationValidator.getConfigurationByType().validate(
|
|
4030
4030
|
{
|
|
4031
4031
|
type,
|
|
4032
|
+
includeInactive,
|
|
4032
4033
|
},
|
|
4033
4034
|
{ abortEarly: false, allowUnknown: true }
|
|
4034
4035
|
);
|
|
@@ -4042,6 +4043,7 @@ class Catalog {
|
|
|
4042
4043
|
} = CatalogPlatformApplicationValidator.getConfigurationByType().validate(
|
|
4043
4044
|
{
|
|
4044
4045
|
type,
|
|
4046
|
+
includeInactive,
|
|
4045
4047
|
},
|
|
4046
4048
|
{ abortEarly: false, allowUnknown: false }
|
|
4047
4049
|
);
|
|
@@ -4053,6 +4055,7 @@ class Catalog {
|
|
|
4053
4055
|
}
|
|
4054
4056
|
|
|
4055
4057
|
const query_params = {};
|
|
4058
|
+
query_params["include_inactive"] = includeInactive;
|
|
4056
4059
|
|
|
4057
4060
|
const response = await PlatformAPIClient.execute(
|
|
4058
4061
|
this.config,
|
|
@@ -303,6 +303,9 @@ export = CatalogPlatformApplicationValidator;
|
|
|
303
303
|
/**
|
|
304
304
|
* @typedef GetConfigurationByTypeParam
|
|
305
305
|
* @property {string} type - Type can be brands, categories etc.
|
|
306
|
+
* @property {boolean} [includeInactive] - Pass the `include_inactive` parameter
|
|
307
|
+
* to retrieve inactive brand or category details. This flag enables fetching
|
|
308
|
+
* all brands or categories,including those that are inactive.
|
|
306
309
|
*/
|
|
307
310
|
/**
|
|
308
311
|
* @typedef GetConfigurationMetadataParam
|
|
@@ -1144,6 +1147,12 @@ type GetConfigurationByTypeParam = {
|
|
|
1144
1147
|
* - Type can be brands, categories etc.
|
|
1145
1148
|
*/
|
|
1146
1149
|
type: string;
|
|
1150
|
+
/**
|
|
1151
|
+
* - Pass the `include_inactive` parameter
|
|
1152
|
+
* to retrieve inactive brand or category details. This flag enables fetching
|
|
1153
|
+
* all brands or categories,including those that are inactive.
|
|
1154
|
+
*/
|
|
1155
|
+
includeInactive?: boolean;
|
|
1147
1156
|
};
|
|
1148
1157
|
type GetConfigurationMetadataParam = {
|
|
1149
1158
|
/**
|
|
@@ -346,6 +346,9 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
|
|
|
346
346
|
/**
|
|
347
347
|
* @typedef GetConfigurationByTypeParam
|
|
348
348
|
* @property {string} type - Type can be brands, categories etc.
|
|
349
|
+
* @property {boolean} [includeInactive] - Pass the `include_inactive` parameter
|
|
350
|
+
* to retrieve inactive brand or category details. This flag enables fetching
|
|
351
|
+
* all brands or categories,including those that are inactive.
|
|
349
352
|
*/
|
|
350
353
|
|
|
351
354
|
/**
|
|
@@ -864,6 +867,7 @@ class CatalogPlatformApplicationValidator {
|
|
|
864
867
|
static getConfigurationByType() {
|
|
865
868
|
return Joi.object({
|
|
866
869
|
type: Joi.string().allow("").required(),
|
|
870
|
+
includeInactive: Joi.boolean(),
|
|
867
871
|
}).required();
|
|
868
872
|
}
|
|
869
873
|
|
|
@@ -375,6 +375,7 @@ export = CompanyProfilePlatformModel;
|
|
|
375
375
|
* @property {AverageOrderProcessingTime} [avg_order_processing_time]
|
|
376
376
|
* @property {boolean} [bulk_shipment]
|
|
377
377
|
* @property {boolean} [auto_assign_courier_partner]
|
|
378
|
+
* @property {boolean} [qc_based_return_inventory_sync]
|
|
378
379
|
*/
|
|
379
380
|
/**
|
|
380
381
|
* @typedef LocationListSchema
|
|
@@ -892,6 +893,7 @@ type GetLocationSchema = {
|
|
|
892
893
|
avg_order_processing_time?: AverageOrderProcessingTime;
|
|
893
894
|
bulk_shipment?: boolean;
|
|
894
895
|
auto_assign_courier_partner?: boolean;
|
|
896
|
+
qc_based_return_inventory_sync?: boolean;
|
|
895
897
|
};
|
|
896
898
|
/** @returns {LocationListSchema} */
|
|
897
899
|
declare function LocationListSchema(): LocationListSchema;
|
|
@@ -414,6 +414,7 @@ const Joi = require("joi");
|
|
|
414
414
|
* @property {AverageOrderProcessingTime} [avg_order_processing_time]
|
|
415
415
|
* @property {boolean} [bulk_shipment]
|
|
416
416
|
* @property {boolean} [auto_assign_courier_partner]
|
|
417
|
+
* @property {boolean} [qc_based_return_inventory_sync]
|
|
417
418
|
*/
|
|
418
419
|
|
|
419
420
|
/**
|
|
@@ -1002,6 +1003,7 @@ class CompanyProfilePlatformModel {
|
|
|
1002
1003
|
avg_order_processing_time: CompanyProfilePlatformModel.AverageOrderProcessingTime(),
|
|
1003
1004
|
bulk_shipment: Joi.boolean(),
|
|
1004
1005
|
auto_assign_courier_partner: Joi.boolean(),
|
|
1006
|
+
qc_based_return_inventory_sync: Joi.boolean(),
|
|
1005
1007
|
});
|
|
1006
1008
|
}
|
|
1007
1009
|
|
|
@@ -1438,12 +1438,7 @@ export = ContentPlatformModel;
|
|
|
1438
1438
|
* @typedef ResourceTranslation
|
|
1439
1439
|
* @property {string} [_id] - Unique identifier for the translation entry
|
|
1440
1440
|
* @property {string} [locale] - Language code for this translation
|
|
1441
|
-
* @property {
|
|
1442
|
-
*/
|
|
1443
|
-
/**
|
|
1444
|
-
* @typedef TranslationValue
|
|
1445
|
-
* @property {string} [name] - Translated name
|
|
1446
|
-
* @property {TranslationSeo} [seo]
|
|
1441
|
+
* @property {Object} [value] - Translated content in key-value format
|
|
1447
1442
|
*/
|
|
1448
1443
|
/**
|
|
1449
1444
|
* @typedef TranslationSeo
|
|
@@ -1462,11 +1457,11 @@ export = ContentPlatformModel;
|
|
|
1462
1457
|
* @property {string} [type] - Type of content being translated
|
|
1463
1458
|
* @property {string} [resource_id] - Identifier of the resource requiring translation
|
|
1464
1459
|
* @property {string} [locale] - Target language code for the translation
|
|
1465
|
-
* @property {
|
|
1460
|
+
* @property {Object} [value] - Translated content in key-value format
|
|
1466
1461
|
*/
|
|
1467
1462
|
/**
|
|
1468
1463
|
* @typedef ResourceTranslationUpdate
|
|
1469
|
-
* @property {
|
|
1464
|
+
* @property {Object} [value] - Translated content in key-value format
|
|
1470
1465
|
*/
|
|
1471
1466
|
/**
|
|
1472
1467
|
* @typedef TranslatableSection
|
|
@@ -1562,7 +1557,7 @@ export = ContentPlatformModel;
|
|
|
1562
1557
|
declare class ContentPlatformModel {
|
|
1563
1558
|
}
|
|
1564
1559
|
declare namespace ContentPlatformModel {
|
|
1565
|
-
export { ValidationError, GenerateSEOContent, GeneratedSEOContent, ApplicationLegal, ApplicationLegalFAQ, PathMappingSchema, PathSourceSchema, SeoComponent, SeoSchema, CustomMetaTag, Detail, SeoSchemaComponent, SEOSchemaMarkupTemplate, SEOSchemaMarkupTemplateRequestBody, AnnouncementPageSchema, EditorMeta, AnnouncementAuthorSchema, AdminAnnouncementSchema, DefaultSchemaComponent, DefaultSEOSchemaMarkupTemplate, ScheduleSchema, NextSchedule, BlogGetDetails, BlogFilters, ResourceContent, Asset, Author, BlogSchema, SEO, SEOImage, SEOMetaItem, SEOMetaItems, SEOSitemap, SEObreadcrumb, DateMeta, BlogPayload, GetAnnouncementListSchema, CreateAnnouncementSchema, DataLoaderResponseSchema, DataLoaderResetResponseSchema, LocaleLanguage, Language, Action, NavigationReference, CronBasedScheduleSchema, UpdateHandpickedSchema, HandpickedTagSchema, RemoveHandpickedSchema, CreateTagSchema, CreateTagRequestSchema, DataLoaderSchema, DataLoaderSourceSchema, DataLoadersSchema, TagDeleteSuccessDetails, ContentAPIError, CommonError, CategorySchema, ChildrenSchema, CategoryRequestSchema, FAQCategorySchema, FaqSchema, FAQ, CreateFaqResponseSchema, CreateFaqSchema, GetFaqSchema, UpdateFaqCategoryRequestSchema, CreateFaqCategoryRequestSchema, CreateFaqCategorySchema, GetFaqCategoriesSchema, GetFaqCategoryBySlugSchema, Page, LandingPageGetDetails, LandingPageSchema, DefaultNavigationDetails, NavigationGetDetails, Orientation, NavigationSchema, NavigationPayload, PageGetDetails, PageSpec, PageSpecParam, PageSpecItem, PageSchema, CreatedBySchema, PagePayload, CronSchedule, PagePublishPayload, PageMetaSchema, Support, PhoneProperties, PhoneSchema, EmailProperties, EmailSchema, ContactSchema, TagsSchema, TagSchema, TagSourceSchema, ResourcesSchema, ResourceSchema, FieldValidations, FieldDefinitionSchema, CustomFieldDefinitionsSchema, CustomFieldDefinitionRequestSchema, CustomObjectCustomFieldDefinitions, CustomObjectDefinitionUpdateRequestSchema, CustomFieldDefinitionDetailResSchema, MetaFieldDefinitionDetailResSchema, CustomDataDeleteSchema, CustomFieldValue, CustomFieldSchema, CustomFieldsResponseSchema, CustomFieldsDeleteSchema, CustomFieldsResponseByResourceIdSchema, CustomField, CustomFieldRequestSchema, CustomObjectSchema, CustomObjectDefinitionRequestSchema, CustomObjectDefinitionSlugSchema, CustomObjectDefinitionDeleteResponseSchema, CustomObjectEntryBulkUploadDetails, CustomObjectListItemDefinitionModel, CustomObjectListItemSchema, CustomObjectsSchema, CustomObjectFieldDefinition, CustomObjectBySlugSchema, CustomObjectBulkEntryInitiateDownload, CustomObjectMetaSchema, JobSchema, CustomFieldBulkEntry, CustomObjectBulkEntry, MetafieldTypesSchema, CustomFieldTypeSchema, SupportedValidationsMetaExampleSchema, SupportedValidationsMetaSchema, SupportedValidationsSchema, Duration, HTML, StringSingleLine, StringMultiLine, Dropdown, Integer, FloatType, BooleanType, Date, Datetime, Json, File, Url, Metaobject, Product, CustomObjectEntry, CustomObjectDefinitionsSchema, CustomObjectEntryFieldSchema, CustomObjectEntryFieldSchemaWithoutID, CustomObjectRequestSchema, CustomObjectRequestSchemaWithoutId, CustomObjectBulkSchema, ActionPage, TranslateUiLabels, TranslateUiLabelsCreate, StaticResourceUpdate, TranslateUiLabelsPage, Error, Meta, CompanyLanguage, CompanyLanguageCreate, CompanyLanguageUpdate, ApplicationLanguage, unPublishApplicationLanguage, ApplicationLanguageCreate, ApplicationLanguageUpdate, TranslatableResource, ResourceDefinition, ResourceJsonSchema, ResourceJsonSchemaType, ResourceUISchema, ResourceBulkDetails, Title, FeatureImage, Seo, MetaTag, MetaTagItem, ResourceTranslation,
|
|
1560
|
+
export { ValidationError, GenerateSEOContent, GeneratedSEOContent, ApplicationLegal, ApplicationLegalFAQ, PathMappingSchema, PathSourceSchema, SeoComponent, SeoSchema, CustomMetaTag, Detail, SeoSchemaComponent, SEOSchemaMarkupTemplate, SEOSchemaMarkupTemplateRequestBody, AnnouncementPageSchema, EditorMeta, AnnouncementAuthorSchema, AdminAnnouncementSchema, DefaultSchemaComponent, DefaultSEOSchemaMarkupTemplate, ScheduleSchema, NextSchedule, BlogGetDetails, BlogFilters, ResourceContent, Asset, Author, BlogSchema, SEO, SEOImage, SEOMetaItem, SEOMetaItems, SEOSitemap, SEObreadcrumb, DateMeta, BlogPayload, GetAnnouncementListSchema, CreateAnnouncementSchema, DataLoaderResponseSchema, DataLoaderResetResponseSchema, LocaleLanguage, Language, Action, NavigationReference, CronBasedScheduleSchema, UpdateHandpickedSchema, HandpickedTagSchema, RemoveHandpickedSchema, CreateTagSchema, CreateTagRequestSchema, DataLoaderSchema, DataLoaderSourceSchema, DataLoadersSchema, TagDeleteSuccessDetails, ContentAPIError, CommonError, CategorySchema, ChildrenSchema, CategoryRequestSchema, FAQCategorySchema, FaqSchema, FAQ, CreateFaqResponseSchema, CreateFaqSchema, GetFaqSchema, UpdateFaqCategoryRequestSchema, CreateFaqCategoryRequestSchema, CreateFaqCategorySchema, GetFaqCategoriesSchema, GetFaqCategoryBySlugSchema, Page, LandingPageGetDetails, LandingPageSchema, DefaultNavigationDetails, NavigationGetDetails, Orientation, NavigationSchema, NavigationPayload, PageGetDetails, PageSpec, PageSpecParam, PageSpecItem, PageSchema, CreatedBySchema, PagePayload, CronSchedule, PagePublishPayload, PageMetaSchema, Support, PhoneProperties, PhoneSchema, EmailProperties, EmailSchema, ContactSchema, TagsSchema, TagSchema, TagSourceSchema, ResourcesSchema, ResourceSchema, FieldValidations, FieldDefinitionSchema, CustomFieldDefinitionsSchema, CustomFieldDefinitionRequestSchema, CustomObjectCustomFieldDefinitions, CustomObjectDefinitionUpdateRequestSchema, CustomFieldDefinitionDetailResSchema, MetaFieldDefinitionDetailResSchema, CustomDataDeleteSchema, CustomFieldValue, CustomFieldSchema, CustomFieldsResponseSchema, CustomFieldsDeleteSchema, CustomFieldsResponseByResourceIdSchema, CustomField, CustomFieldRequestSchema, CustomObjectSchema, CustomObjectDefinitionRequestSchema, CustomObjectDefinitionSlugSchema, CustomObjectDefinitionDeleteResponseSchema, CustomObjectEntryBulkUploadDetails, CustomObjectListItemDefinitionModel, CustomObjectListItemSchema, CustomObjectsSchema, CustomObjectFieldDefinition, CustomObjectBySlugSchema, CustomObjectBulkEntryInitiateDownload, CustomObjectMetaSchema, JobSchema, CustomFieldBulkEntry, CustomObjectBulkEntry, MetafieldTypesSchema, CustomFieldTypeSchema, SupportedValidationsMetaExampleSchema, SupportedValidationsMetaSchema, SupportedValidationsSchema, Duration, HTML, StringSingleLine, StringMultiLine, Dropdown, Integer, FloatType, BooleanType, Date, Datetime, Json, File, Url, Metaobject, Product, CustomObjectEntry, CustomObjectDefinitionsSchema, CustomObjectEntryFieldSchema, CustomObjectEntryFieldSchemaWithoutID, CustomObjectRequestSchema, CustomObjectRequestSchemaWithoutId, CustomObjectBulkSchema, ActionPage, TranslateUiLabels, TranslateUiLabelsCreate, StaticResourceUpdate, TranslateUiLabelsPage, Error, Meta, CompanyLanguage, CompanyLanguageCreate, CompanyLanguageUpdate, ApplicationLanguage, unPublishApplicationLanguage, ApplicationLanguageCreate, ApplicationLanguageUpdate, TranslatableResource, ResourceDefinition, ResourceJsonSchema, ResourceJsonSchemaType, ResourceUISchema, ResourceBulkDetails, Title, FeatureImage, Seo, MetaTag, MetaTagItem, ResourceTranslation, TranslationSeo, ResourceTranslationList, ResourceTranslationCreate, ResourceTranslationUpdate, TranslatableSection, Metrics, ResourceTranslationUpsertItem, ResourceTranslationBulkUpsert, StandardError, OperationResponseSchema, GenerationEntityType, PageType };
|
|
1566
1561
|
}
|
|
1567
1562
|
/** @returns {ValidationError} */
|
|
1568
1563
|
declare function ValidationError(): ValidationError;
|
|
@@ -4245,16 +4240,10 @@ type ResourceTranslation = {
|
|
|
4245
4240
|
* - Language code for this translation
|
|
4246
4241
|
*/
|
|
4247
4242
|
locale?: string;
|
|
4248
|
-
value?: TranslationValue;
|
|
4249
|
-
};
|
|
4250
|
-
/** @returns {TranslationValue} */
|
|
4251
|
-
declare function TranslationValue(): TranslationValue;
|
|
4252
|
-
type TranslationValue = {
|
|
4253
4243
|
/**
|
|
4254
|
-
* - Translated
|
|
4244
|
+
* - Translated content in key-value format
|
|
4255
4245
|
*/
|
|
4256
|
-
|
|
4257
|
-
seo?: TranslationSeo;
|
|
4246
|
+
value?: any;
|
|
4258
4247
|
};
|
|
4259
4248
|
/** @returns {TranslationSeo} */
|
|
4260
4249
|
declare function TranslationSeo(): TranslationSeo;
|
|
@@ -4300,12 +4289,18 @@ type ResourceTranslationCreate = {
|
|
|
4300
4289
|
* - Target language code for the translation
|
|
4301
4290
|
*/
|
|
4302
4291
|
locale?: string;
|
|
4303
|
-
|
|
4292
|
+
/**
|
|
4293
|
+
* - Translated content in key-value format
|
|
4294
|
+
*/
|
|
4295
|
+
value?: any;
|
|
4304
4296
|
};
|
|
4305
4297
|
/** @returns {ResourceTranslationUpdate} */
|
|
4306
4298
|
declare function ResourceTranslationUpdate(): ResourceTranslationUpdate;
|
|
4307
4299
|
type ResourceTranslationUpdate = {
|
|
4308
|
-
|
|
4300
|
+
/**
|
|
4301
|
+
* - Translated content in key-value format
|
|
4302
|
+
*/
|
|
4303
|
+
value?: any;
|
|
4309
4304
|
};
|
|
4310
4305
|
/** @returns {TranslatableSection} */
|
|
4311
4306
|
declare function TranslatableSection(): TranslatableSection;
|