@gofynd/fdk-client-javascript 3.3.2 → 3.3.5
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/application/Cart/CartApplicationClient.d.ts +1 -1
- package/sdk/application/Cart/CartApplicationClient.js +14 -3
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +55 -1
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +39 -0
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +20 -3
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +17 -0
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +7 -0
- package/sdk/platform/Cart/CartPlatformModel.d.ts +75 -0
- package/sdk/platform/Cart/CartPlatformModel.js +32 -0
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +12 -5
- package/sdk/platform/Catalog/CatalogPlatformClient.js +44 -8
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +5 -0
- package/sdk/platform/Catalog/CatalogPlatformModel.js +2 -0
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +44 -3
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +19 -2
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +4 -0
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +2 -0
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +2 -0
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +105 -1
- package/sdk/platform/Payment/PaymentPlatformModel.js +70 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +57 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +41 -0
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +1 -1
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +16 -1
- package/sdk/platform/Theme/ThemePlatformModel.js +18 -0
|
@@ -511,6 +511,8 @@ const Joi = require("joi");
|
|
|
511
511
|
* @property {PromotionDateMeta} [date_meta]
|
|
512
512
|
* @property {string} [_id] - Unique identifier of promotion
|
|
513
513
|
* @property {string[]} [tags] - List of tags on which promotion is applicable
|
|
514
|
+
* @property {boolean} [auto_apply] - Boolean value to determine if the
|
|
515
|
+
* promotion should be applied automatically or not
|
|
514
516
|
*/
|
|
515
517
|
|
|
516
518
|
/**
|
|
@@ -548,6 +550,8 @@ const Joi = require("joi");
|
|
|
548
550
|
* @property {Object} [_custom_json] - Set extra properties in promotion
|
|
549
551
|
* @property {PromotionDateMeta} [date_meta]
|
|
550
552
|
* @property {string[]} [tags] - List of tags applicable for promotion
|
|
553
|
+
* @property {boolean} [auto_apply] - Boolean value to determine if the
|
|
554
|
+
* promotion should be applied automatically or not
|
|
551
555
|
*/
|
|
552
556
|
|
|
553
557
|
/**
|
|
@@ -581,6 +585,8 @@ const Joi = require("joi");
|
|
|
581
585
|
* @property {Object} [_custom_json] - Set extra properties in promotion
|
|
582
586
|
* @property {PromotionDateMeta} [date_meta]
|
|
583
587
|
* @property {string[]} [tags] - List of tags applicable for promotion
|
|
588
|
+
* @property {boolean} [auto_apply] - Boolean value to determine if the
|
|
589
|
+
* promotion should be applied automatically or not
|
|
584
590
|
*/
|
|
585
591
|
|
|
586
592
|
/**
|
|
@@ -614,6 +620,8 @@ const Joi = require("joi");
|
|
|
614
620
|
* @property {Object} [_custom_json] - Set extra properties in promotion
|
|
615
621
|
* @property {PromotionDateMeta} [date_meta]
|
|
616
622
|
* @property {string[]} [tags] - List of tags applicable for promotion
|
|
623
|
+
* @property {boolean} [auto_apply] - Boolean value to determine if the
|
|
624
|
+
* promotion should be applied automatically or not
|
|
617
625
|
*/
|
|
618
626
|
|
|
619
627
|
/**
|
|
@@ -649,6 +657,8 @@ const Joi = require("joi");
|
|
|
649
657
|
* @property {Object} [_custom_json] - Set extra properties in promotion
|
|
650
658
|
* @property {PromotionDateMeta} [date_meta]
|
|
651
659
|
* @property {string[]} [tags] - List of tags applicable for promotion
|
|
660
|
+
* @property {boolean} [auto_apply] - Boolean value to determine if the
|
|
661
|
+
* promotion should be applied automatically or not
|
|
652
662
|
*/
|
|
653
663
|
|
|
654
664
|
/**
|
|
@@ -1043,6 +1053,8 @@ const Joi = require("joi");
|
|
|
1043
1053
|
* message for the gift
|
|
1044
1054
|
* @property {string[]} [product_group_tags] - List fot the unique identifier
|
|
1045
1055
|
* for the product grouping.
|
|
1056
|
+
* @property {boolean} [force_new_line_item] - Flag to indicate the item as a
|
|
1057
|
+
* seperate article in cart
|
|
1046
1058
|
* @property {Object} [identifier] - Unique identifier of the article
|
|
1047
1059
|
* @property {number} [mto_quantity] - Quantity of the product which will
|
|
1048
1060
|
* specially manufactured as not available in stock
|
|
@@ -1539,6 +1551,8 @@ const Joi = require("joi");
|
|
|
1539
1551
|
* @property {string} [pan_no] - Permanent Account Number of the user
|
|
1540
1552
|
* @property {Object} [custom_cart_meta] - Custom meta details added cart
|
|
1541
1553
|
* checkout API payload
|
|
1554
|
+
* @property {boolean} [free_gift_selection_available] - Determines if the cart
|
|
1555
|
+
* has available promotion free gift items to choose on its added items
|
|
1542
1556
|
*/
|
|
1543
1557
|
|
|
1544
1558
|
/**
|
|
@@ -1563,6 +1577,8 @@ const Joi = require("joi");
|
|
|
1563
1577
|
* level while add items to cart
|
|
1564
1578
|
* @property {Object} [_custom_json] - Field to add custom json at article level
|
|
1565
1579
|
* while add items to cart
|
|
1580
|
+
* @property {boolean} [force_new_line_item] - Field used to decide the product
|
|
1581
|
+
* add as a seperate product in cart
|
|
1566
1582
|
* @property {Object} [meta] - Field to add meta data at article level
|
|
1567
1583
|
* @property {boolean} [pos] - Filed to determine whether user is making request
|
|
1568
1584
|
* from pos or not
|
|
@@ -1610,6 +1626,8 @@ const Joi = require("joi");
|
|
|
1610
1626
|
* @property {Object} [meta] - Field to update meta of the item in cart
|
|
1611
1627
|
* @property {Object} [extra_meta] - Field to update extra meta of the product in cart
|
|
1612
1628
|
* @property {Object} [_custom_json] - Field to update custom json of the product in cart
|
|
1629
|
+
* @property {boolean} [force_new_line_item] - Field used to decide the product
|
|
1630
|
+
* add as a seperate product in cart
|
|
1613
1631
|
* @property {number} [item_id] - Item id of the product that needs to be updated
|
|
1614
1632
|
* @property {number} [item_index] - Item index determines on which index the
|
|
1615
1633
|
* product falls to be updated
|
|
@@ -1856,6 +1874,8 @@ const Joi = require("joi");
|
|
|
1856
1874
|
* items with updated sizes.
|
|
1857
1875
|
* @property {string} operation - Field to determine if item to be removed from
|
|
1858
1876
|
* cart or it needs to be updated
|
|
1877
|
+
* @property {string} [free_gift_items_operation] - Field to determine if free
|
|
1878
|
+
* gift item to be removed from cart or it needs to be added.
|
|
1859
1879
|
*/
|
|
1860
1880
|
|
|
1861
1881
|
/**
|
|
@@ -2077,6 +2097,7 @@ const Joi = require("joi");
|
|
|
2077
2097
|
* includes type of error, error code and error message
|
|
2078
2098
|
* @property {string} [pan_no] - Permanent Account Number of the user
|
|
2079
2099
|
* @property {Object} [custom_cart_meta] - Custom cart meta details added in cart
|
|
2100
|
+
* @property {string} [customer_id] - Customer user id associated with cart
|
|
2080
2101
|
*/
|
|
2081
2102
|
|
|
2082
2103
|
/**
|
|
@@ -3084,6 +3105,7 @@ class CartPlatformModel {
|
|
|
3084
3105
|
date_meta: CartPlatformModel.PromotionDateMeta(),
|
|
3085
3106
|
_id: Joi.string().allow(""),
|
|
3086
3107
|
tags: Joi.array().items(Joi.string().allow("")),
|
|
3108
|
+
auto_apply: Joi.boolean(),
|
|
3087
3109
|
});
|
|
3088
3110
|
}
|
|
3089
3111
|
|
|
@@ -3121,6 +3143,7 @@ class CartPlatformModel {
|
|
|
3121
3143
|
_custom_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
3122
3144
|
date_meta: CartPlatformModel.PromotionDateMeta(),
|
|
3123
3145
|
tags: Joi.array().items(Joi.string().allow("")),
|
|
3146
|
+
auto_apply: Joi.boolean(),
|
|
3124
3147
|
});
|
|
3125
3148
|
}
|
|
3126
3149
|
|
|
@@ -3151,6 +3174,7 @@ class CartPlatformModel {
|
|
|
3151
3174
|
_custom_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
3152
3175
|
date_meta: CartPlatformModel.PromotionDateMeta(),
|
|
3153
3176
|
tags: Joi.array().items(Joi.string().allow("")),
|
|
3177
|
+
auto_apply: Joi.boolean(),
|
|
3154
3178
|
});
|
|
3155
3179
|
}
|
|
3156
3180
|
|
|
@@ -3181,6 +3205,7 @@ class CartPlatformModel {
|
|
|
3181
3205
|
_custom_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
3182
3206
|
date_meta: CartPlatformModel.PromotionDateMeta(),
|
|
3183
3207
|
tags: Joi.array().items(Joi.string().allow("")),
|
|
3208
|
+
auto_apply: Joi.boolean(),
|
|
3184
3209
|
});
|
|
3185
3210
|
}
|
|
3186
3211
|
|
|
@@ -3212,6 +3237,7 @@ class CartPlatformModel {
|
|
|
3212
3237
|
_custom_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
3213
3238
|
date_meta: CartPlatformModel.PromotionDateMeta(),
|
|
3214
3239
|
tags: Joi.array().items(Joi.string().allow("")),
|
|
3240
|
+
auto_apply: Joi.boolean(),
|
|
3215
3241
|
});
|
|
3216
3242
|
}
|
|
3217
3243
|
|
|
@@ -3622,6 +3648,7 @@ class CartPlatformModel {
|
|
|
3622
3648
|
uid: Joi.string().allow(""),
|
|
3623
3649
|
gift_card: Joi.object().pattern(/\S/, Joi.any()),
|
|
3624
3650
|
product_group_tags: Joi.array().items(Joi.string().allow("")),
|
|
3651
|
+
force_new_line_item: Joi.boolean(),
|
|
3625
3652
|
identifier: Joi.object().pattern(/\S/, Joi.any()),
|
|
3626
3653
|
mto_quantity: Joi.number(),
|
|
3627
3654
|
extra_meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
@@ -4143,6 +4170,7 @@ class CartPlatformModel {
|
|
|
4143
4170
|
),
|
|
4144
4171
|
pan_no: Joi.string().allow(""),
|
|
4145
4172
|
custom_cart_meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
4173
|
+
free_gift_selection_available: Joi.boolean(),
|
|
4146
4174
|
});
|
|
4147
4175
|
}
|
|
4148
4176
|
|
|
@@ -4163,6 +4191,7 @@ class CartPlatformModel {
|
|
|
4163
4191
|
item_id: Joi.number(),
|
|
4164
4192
|
extra_meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
4165
4193
|
_custom_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
4194
|
+
force_new_line_item: Joi.boolean(),
|
|
4166
4195
|
meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
4167
4196
|
pos: Joi.boolean(),
|
|
4168
4197
|
seller_identifier: Joi.string().allow(""),
|
|
@@ -4209,6 +4238,7 @@ class CartPlatformModel {
|
|
|
4209
4238
|
meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
4210
4239
|
extra_meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
4211
4240
|
_custom_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
4241
|
+
force_new_line_item: Joi.boolean(),
|
|
4212
4242
|
item_id: Joi.number(),
|
|
4213
4243
|
item_index: Joi.number(),
|
|
4214
4244
|
identifiers: CartPlatformModel.CartProductIdentifer().required(),
|
|
@@ -4457,6 +4487,7 @@ class CartPlatformModel {
|
|
|
4457
4487
|
CartPlatformModel.FreeGiftItemCreation()
|
|
4458
4488
|
),
|
|
4459
4489
|
operation: Joi.string().allow("").required(),
|
|
4490
|
+
free_gift_items_operation: Joi.string().allow(""),
|
|
4460
4491
|
});
|
|
4461
4492
|
}
|
|
4462
4493
|
|
|
@@ -4681,6 +4712,7 @@ class CartPlatformModel {
|
|
|
4681
4712
|
error: Joi.boolean(),
|
|
4682
4713
|
pan_no: Joi.string().allow(""),
|
|
4683
4714
|
custom_cart_meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
4715
|
+
customer_id: Joi.string().allow(""),
|
|
4684
4716
|
});
|
|
4685
4717
|
}
|
|
4686
4718
|
|
|
@@ -224,7 +224,7 @@ declare class Catalog {
|
|
|
224
224
|
* @summary: Download inventory template data
|
|
225
225
|
* @description: Allows you to download inventory product template data for a specific company in formats like csv and excel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/downloadInventoryTemplateView/).
|
|
226
226
|
*/
|
|
227
|
-
downloadInventoryTemplateView({
|
|
227
|
+
downloadInventoryTemplateView({ schemaType, type, requestHeaders }?: CatalogPlatformValidator.DownloadInventoryTemplateViewParam, { responseHeaders }?: object): Promise<string>;
|
|
228
228
|
/**
|
|
229
229
|
* @param {CatalogPlatformValidator.DownloadProductTemplateViewsParam} arg
|
|
230
230
|
* - Arg object
|
|
@@ -411,19 +411,26 @@ declare class Catalog {
|
|
|
411
411
|
* @summary: List bulk inventory upload history
|
|
412
412
|
* @description: Helps to get bulk Inventory upload jobs status. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventoryBulkUploadHistory/).
|
|
413
413
|
*/
|
|
414
|
-
getInventoryBulkUploadHistory({ pageNo, pageSize, search, requestHeaders }?: CatalogPlatformValidator.GetInventoryBulkUploadHistoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkInventoryGet>;
|
|
414
|
+
getInventoryBulkUploadHistory({ pageNo, pageSize, search, startDate, endDate, stage, requestHeaders }?: CatalogPlatformValidator.GetInventoryBulkUploadHistoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkInventoryGet>;
|
|
415
415
|
/**
|
|
416
416
|
* @param {Object} arg - Arg object.
|
|
417
417
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
418
418
|
* page. Default is 12.
|
|
419
419
|
* @param {string} [arg.search] - Search string to filter the results by batch id
|
|
420
|
+
* @param {string} [arg.startDate] - Filter results by the job's start date.
|
|
421
|
+
* @param {string} [arg.endDate] - Filter results by the job's end date.
|
|
422
|
+
* @param {string} [arg.stage] - Filter results by the current stage of the
|
|
423
|
+
* import job.
|
|
420
424
|
* @returns {Paginator<CatalogPlatformModel.BulkInventoryGet>}
|
|
421
425
|
* @summary: List bulk inventory upload history
|
|
422
426
|
* @description: Helps to get bulk Inventory upload jobs status.
|
|
423
427
|
*/
|
|
424
|
-
getInventoryBulkUploadHistoryPaginator({ pageSize, search }?: {
|
|
428
|
+
getInventoryBulkUploadHistoryPaginator({ pageSize, search, startDate, endDate, stage, }?: {
|
|
425
429
|
pageSize?: number;
|
|
426
430
|
search?: string;
|
|
431
|
+
startDate?: string;
|
|
432
|
+
endDate?: string;
|
|
433
|
+
stage?: string;
|
|
427
434
|
}): Paginator<CatalogPlatformModel.BulkInventoryGet>;
|
|
428
435
|
/**
|
|
429
436
|
* @param {CatalogPlatformValidator.GetInventoryBySizeParam} arg - Arg object
|
|
@@ -900,7 +907,7 @@ declare class Catalog {
|
|
|
900
907
|
* @summary: List product templates
|
|
901
908
|
* @description: Allows you to list all product templates for a specific company. also can filter by department. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listProductTemplate/).
|
|
902
909
|
*/
|
|
903
|
-
listProductTemplate({ department, requestHeaders }?: CatalogPlatformValidator.ListProductTemplateParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TemplatesResponseSchema>;
|
|
910
|
+
listProductTemplate({ department, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.ListProductTemplateParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TemplatesResponseSchema>;
|
|
904
911
|
/**
|
|
905
912
|
* @param {CatalogPlatformValidator.ListProductTemplateCategoriesParam} arg
|
|
906
913
|
* - Arg object
|
|
@@ -1079,7 +1086,7 @@ declare class Catalog {
|
|
|
1079
1086
|
* @summary: Validate product template schema
|
|
1080
1087
|
* @description: Allows you to list all product templates validation values for all the fields present in the database for a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/validateProductTemplateSchema/).
|
|
1081
1088
|
*/
|
|
1082
|
-
validateProductTemplateSchema({ itemType, requestHeaders }?: CatalogPlatformValidator.ValidateProductTemplateSchemaParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryValidationResponseSchema>;
|
|
1089
|
+
validateProductTemplateSchema({ itemType, schemaType, requestHeaders }?: CatalogPlatformValidator.ValidateProductTemplateSchemaParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryValidationResponseSchema>;
|
|
1083
1090
|
}
|
|
1084
1091
|
import CatalogPlatformValidator = require("./CatalogPlatformValidator");
|
|
1085
1092
|
import CatalogPlatformModel = require("./CatalogPlatformModel");
|
|
@@ -1643,14 +1643,15 @@ class Catalog {
|
|
|
1643
1643
|
* @description: Allows you to download inventory product template data for a specific company in formats like csv and excel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/downloadInventoryTemplateView/).
|
|
1644
1644
|
*/
|
|
1645
1645
|
async downloadInventoryTemplateView(
|
|
1646
|
-
{
|
|
1646
|
+
{ schemaType, type, requestHeaders } = { requestHeaders: {} },
|
|
1647
1647
|
{ responseHeaders } = { responseHeaders: false }
|
|
1648
1648
|
) {
|
|
1649
1649
|
const {
|
|
1650
1650
|
error,
|
|
1651
1651
|
} = CatalogPlatformValidator.downloadInventoryTemplateView().validate(
|
|
1652
1652
|
{
|
|
1653
|
-
|
|
1653
|
+
schemaType,
|
|
1654
|
+
type,
|
|
1654
1655
|
},
|
|
1655
1656
|
{ abortEarly: false, allowUnknown: true }
|
|
1656
1657
|
);
|
|
@@ -1663,7 +1664,8 @@ class Catalog {
|
|
|
1663
1664
|
error: warrning,
|
|
1664
1665
|
} = CatalogPlatformValidator.downloadInventoryTemplateView().validate(
|
|
1665
1666
|
{
|
|
1666
|
-
|
|
1667
|
+
schemaType,
|
|
1668
|
+
type,
|
|
1667
1669
|
},
|
|
1668
1670
|
{ abortEarly: false, allowUnknown: false }
|
|
1669
1671
|
);
|
|
@@ -1675,7 +1677,8 @@ class Catalog {
|
|
|
1675
1677
|
}
|
|
1676
1678
|
|
|
1677
1679
|
const query_params = {};
|
|
1678
|
-
query_params["
|
|
1680
|
+
query_params["schema_type"] = schemaType;
|
|
1681
|
+
query_params["type"] = type;
|
|
1679
1682
|
|
|
1680
1683
|
const xHeaders = {};
|
|
1681
1684
|
|
|
@@ -2850,7 +2853,9 @@ class Catalog {
|
|
|
2850
2853
|
* @description: Helps to get bulk Inventory upload jobs status. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventoryBulkUploadHistory/).
|
|
2851
2854
|
*/
|
|
2852
2855
|
async getInventoryBulkUploadHistory(
|
|
2853
|
-
{ pageNo, pageSize, search, requestHeaders } = {
|
|
2856
|
+
{ pageNo, pageSize, search, startDate, endDate, stage, requestHeaders } = {
|
|
2857
|
+
requestHeaders: {},
|
|
2858
|
+
},
|
|
2854
2859
|
{ responseHeaders } = { responseHeaders: false }
|
|
2855
2860
|
) {
|
|
2856
2861
|
const {
|
|
@@ -2860,6 +2865,9 @@ class Catalog {
|
|
|
2860
2865
|
pageNo,
|
|
2861
2866
|
pageSize,
|
|
2862
2867
|
search,
|
|
2868
|
+
startDate,
|
|
2869
|
+
endDate,
|
|
2870
|
+
stage,
|
|
2863
2871
|
},
|
|
2864
2872
|
{ abortEarly: false, allowUnknown: true }
|
|
2865
2873
|
);
|
|
@@ -2875,6 +2883,9 @@ class Catalog {
|
|
|
2875
2883
|
pageNo,
|
|
2876
2884
|
pageSize,
|
|
2877
2885
|
search,
|
|
2886
|
+
startDate,
|
|
2887
|
+
endDate,
|
|
2888
|
+
stage,
|
|
2878
2889
|
},
|
|
2879
2890
|
{ abortEarly: false, allowUnknown: false }
|
|
2880
2891
|
);
|
|
@@ -2889,6 +2900,9 @@ class Catalog {
|
|
|
2889
2900
|
query_params["page_no"] = pageNo;
|
|
2890
2901
|
query_params["page_size"] = pageSize;
|
|
2891
2902
|
query_params["search"] = search;
|
|
2903
|
+
query_params["start_date"] = startDate;
|
|
2904
|
+
query_params["end_date"] = endDate;
|
|
2905
|
+
query_params["stage"] = stage;
|
|
2892
2906
|
|
|
2893
2907
|
const xHeaders = {};
|
|
2894
2908
|
|
|
@@ -2933,11 +2947,21 @@ class Catalog {
|
|
|
2933
2947
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
2934
2948
|
* page. Default is 12.
|
|
2935
2949
|
* @param {string} [arg.search] - Search string to filter the results by batch id
|
|
2950
|
+
* @param {string} [arg.startDate] - Filter results by the job's start date.
|
|
2951
|
+
* @param {string} [arg.endDate] - Filter results by the job's end date.
|
|
2952
|
+
* @param {string} [arg.stage] - Filter results by the current stage of the
|
|
2953
|
+
* import job.
|
|
2936
2954
|
* @returns {Paginator<CatalogPlatformModel.BulkInventoryGet>}
|
|
2937
2955
|
* @summary: List bulk inventory upload history
|
|
2938
2956
|
* @description: Helps to get bulk Inventory upload jobs status.
|
|
2939
2957
|
*/
|
|
2940
|
-
getInventoryBulkUploadHistoryPaginator({
|
|
2958
|
+
getInventoryBulkUploadHistoryPaginator({
|
|
2959
|
+
pageSize,
|
|
2960
|
+
search,
|
|
2961
|
+
startDate,
|
|
2962
|
+
endDate,
|
|
2963
|
+
stage,
|
|
2964
|
+
} = {}) {
|
|
2941
2965
|
const paginator = new Paginator();
|
|
2942
2966
|
const callback = async () => {
|
|
2943
2967
|
const pageId = paginator.nextId;
|
|
@@ -2947,6 +2971,9 @@ class Catalog {
|
|
|
2947
2971
|
pageNo: pageNo,
|
|
2948
2972
|
pageSize: pageSize,
|
|
2949
2973
|
search: search,
|
|
2974
|
+
startDate: startDate,
|
|
2975
|
+
endDate: endDate,
|
|
2976
|
+
stage: stage,
|
|
2950
2977
|
});
|
|
2951
2978
|
paginator.setPaginator({
|
|
2952
2979
|
hasNext: data.page.has_next ? true : false,
|
|
@@ -5718,12 +5745,14 @@ class Catalog {
|
|
|
5718
5745
|
* @description: Allows you to list all product templates for a specific company. also can filter by department. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listProductTemplate/).
|
|
5719
5746
|
*/
|
|
5720
5747
|
async listProductTemplate(
|
|
5721
|
-
{ department, requestHeaders } = { requestHeaders: {} },
|
|
5748
|
+
{ department, pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
5722
5749
|
{ responseHeaders } = { responseHeaders: false }
|
|
5723
5750
|
) {
|
|
5724
5751
|
const { error } = CatalogPlatformValidator.listProductTemplate().validate(
|
|
5725
5752
|
{
|
|
5726
5753
|
department,
|
|
5754
|
+
pageNo,
|
|
5755
|
+
pageSize,
|
|
5727
5756
|
},
|
|
5728
5757
|
{ abortEarly: false, allowUnknown: true }
|
|
5729
5758
|
);
|
|
@@ -5737,6 +5766,8 @@ class Catalog {
|
|
|
5737
5766
|
} = CatalogPlatformValidator.listProductTemplate().validate(
|
|
5738
5767
|
{
|
|
5739
5768
|
department,
|
|
5769
|
+
pageNo,
|
|
5770
|
+
pageSize,
|
|
5740
5771
|
},
|
|
5741
5772
|
{ abortEarly: false, allowUnknown: false }
|
|
5742
5773
|
);
|
|
@@ -5749,6 +5780,8 @@ class Catalog {
|
|
|
5749
5780
|
|
|
5750
5781
|
const query_params = {};
|
|
5751
5782
|
query_params["department"] = department;
|
|
5783
|
+
query_params["page_no"] = pageNo;
|
|
5784
|
+
query_params["page_size"] = pageSize;
|
|
5752
5785
|
|
|
5753
5786
|
const xHeaders = {};
|
|
5754
5787
|
|
|
@@ -6996,7 +7029,7 @@ class Catalog {
|
|
|
6996
7029
|
* @description: Allows you to list all product templates validation values for all the fields present in the database for a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/validateProductTemplateSchema/).
|
|
6997
7030
|
*/
|
|
6998
7031
|
async validateProductTemplateSchema(
|
|
6999
|
-
{ itemType, requestHeaders } = { requestHeaders: {} },
|
|
7032
|
+
{ itemType, schemaType, requestHeaders } = { requestHeaders: {} },
|
|
7000
7033
|
{ responseHeaders } = { responseHeaders: false }
|
|
7001
7034
|
) {
|
|
7002
7035
|
const {
|
|
@@ -7004,6 +7037,7 @@ class Catalog {
|
|
|
7004
7037
|
} = CatalogPlatformValidator.validateProductTemplateSchema().validate(
|
|
7005
7038
|
{
|
|
7006
7039
|
itemType,
|
|
7040
|
+
schemaType,
|
|
7007
7041
|
},
|
|
7008
7042
|
{ abortEarly: false, allowUnknown: true }
|
|
7009
7043
|
);
|
|
@@ -7017,6 +7051,7 @@ class Catalog {
|
|
|
7017
7051
|
} = CatalogPlatformValidator.validateProductTemplateSchema().validate(
|
|
7018
7052
|
{
|
|
7019
7053
|
itemType,
|
|
7054
|
+
schemaType,
|
|
7020
7055
|
},
|
|
7021
7056
|
{ abortEarly: false, allowUnknown: false }
|
|
7022
7057
|
);
|
|
@@ -7029,6 +7064,7 @@ class Catalog {
|
|
|
7029
7064
|
|
|
7030
7065
|
const query_params = {};
|
|
7031
7066
|
query_params["item_type"] = itemType;
|
|
7067
|
+
query_params["schema_type"] = schemaType;
|
|
7032
7068
|
|
|
7033
7069
|
const xHeaders = {};
|
|
7034
7070
|
|
|
@@ -614,6 +614,7 @@ export = CatalogPlatformModel;
|
|
|
614
614
|
* @property {number} [failed]
|
|
615
615
|
* @property {Object[]} [failed_records]
|
|
616
616
|
* @property {string} [file_path]
|
|
617
|
+
* @property {string} [file_type] - Type of inventory File
|
|
617
618
|
* @property {boolean} [is_active] - Whether the item is active or not.
|
|
618
619
|
* @property {string} [modified_by] - The user who last modified the item.
|
|
619
620
|
* @property {string} [modified_on] - The date and time when the item was last modified.
|
|
@@ -5674,6 +5675,10 @@ type BulkJob = {
|
|
|
5674
5675
|
failed?: number;
|
|
5675
5676
|
failed_records?: any[];
|
|
5676
5677
|
file_path?: string;
|
|
5678
|
+
/**
|
|
5679
|
+
* - Type of inventory File
|
|
5680
|
+
*/
|
|
5681
|
+
file_type?: string;
|
|
5677
5682
|
/**
|
|
5678
5683
|
* - Whether the item is active or not.
|
|
5679
5684
|
*/
|
|
@@ -675,6 +675,7 @@ const Joi = require("joi");
|
|
|
675
675
|
* @property {number} [failed]
|
|
676
676
|
* @property {Object[]} [failed_records]
|
|
677
677
|
* @property {string} [file_path]
|
|
678
|
+
* @property {string} [file_type] - Type of inventory File
|
|
678
679
|
* @property {boolean} [is_active] - Whether the item is active or not.
|
|
679
680
|
* @property {string} [modified_by] - The user who last modified the item.
|
|
680
681
|
* @property {string} [modified_on] - The date and time when the item was last modified.
|
|
@@ -5514,6 +5515,7 @@ class CatalogPlatformModel {
|
|
|
5514
5515
|
failed: Joi.number(),
|
|
5515
5516
|
failed_records: Joi.array().items(Joi.object().pattern(/\S/, Joi.any())),
|
|
5516
5517
|
file_path: Joi.string().allow(""),
|
|
5518
|
+
file_type: Joi.string().allow(""),
|
|
5517
5519
|
is_active: Joi.boolean(),
|
|
5518
5520
|
modified_by: Joi.string().allow("").allow(null),
|
|
5519
5521
|
modified_on: Joi.string().allow(""),
|
|
@@ -91,7 +91,9 @@ export = CatalogPlatformValidator;
|
|
|
91
91
|
*/
|
|
92
92
|
/**
|
|
93
93
|
* @typedef DownloadInventoryTemplateViewParam
|
|
94
|
-
* @property {string}
|
|
94
|
+
* @property {string} schemaType - Specifies the type of template to download.
|
|
95
|
+
* Either quantity or price
|
|
96
|
+
* @property {string} type - File extension type
|
|
95
97
|
*/
|
|
96
98
|
/**
|
|
97
99
|
* @typedef DownloadProductTemplateViewsParam
|
|
@@ -183,6 +185,9 @@ export = CatalogPlatformValidator;
|
|
|
183
185
|
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
184
186
|
* Default is 12.
|
|
185
187
|
* @property {string} [search] - Search string to filter the results by batch id
|
|
188
|
+
* @property {string} [startDate] - Filter results by the job's start date.
|
|
189
|
+
* @property {string} [endDate] - Filter results by the job's end date.
|
|
190
|
+
* @property {string} [stage] - Filter results by the current stage of the import job.
|
|
186
191
|
*/
|
|
187
192
|
/**
|
|
188
193
|
* @typedef GetInventoryBySizeParam
|
|
@@ -387,6 +392,10 @@ export = CatalogPlatformValidator;
|
|
|
387
392
|
/**
|
|
388
393
|
* @typedef ListProductTemplateParam
|
|
389
394
|
* @property {string} department - A `department` is the name of a particular department.
|
|
395
|
+
* @property {number} [pageNo] - The page number to navigate through the given
|
|
396
|
+
* set of results
|
|
397
|
+
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
398
|
+
* Default is 12.
|
|
390
399
|
*/
|
|
391
400
|
/**
|
|
392
401
|
* @typedef ListProductTemplateCategoriesParam
|
|
@@ -482,6 +491,7 @@ export = CatalogPlatformValidator;
|
|
|
482
491
|
* @typedef ValidateProductTemplateSchemaParam
|
|
483
492
|
* @property {string} itemType - An `item_type` defines the type of item. The
|
|
484
493
|
* default value is standard.
|
|
494
|
+
* @property {string} [schemaType] - Schema of price or quantity template
|
|
485
495
|
*/
|
|
486
496
|
declare class CatalogPlatformValidator {
|
|
487
497
|
/** @returns {AddInventoryParam} */
|
|
@@ -753,9 +763,14 @@ type DeleteSizeParam = {
|
|
|
753
763
|
};
|
|
754
764
|
type DownloadInventoryTemplateViewParam = {
|
|
755
765
|
/**
|
|
756
|
-
* -
|
|
766
|
+
* - Specifies the type of template to download.
|
|
767
|
+
* Either quantity or price
|
|
757
768
|
*/
|
|
758
|
-
|
|
769
|
+
schemaType: string;
|
|
770
|
+
/**
|
|
771
|
+
* - File extension type
|
|
772
|
+
*/
|
|
773
|
+
type: string;
|
|
759
774
|
};
|
|
760
775
|
type DownloadProductTemplateViewsParam = {
|
|
761
776
|
/**
|
|
@@ -948,6 +963,18 @@ type GetInventoryBulkUploadHistoryParam = {
|
|
|
948
963
|
* - Search string to filter the results by batch id
|
|
949
964
|
*/
|
|
950
965
|
search?: string;
|
|
966
|
+
/**
|
|
967
|
+
* - Filter results by the job's start date.
|
|
968
|
+
*/
|
|
969
|
+
startDate?: string;
|
|
970
|
+
/**
|
|
971
|
+
* - Filter results by the job's end date.
|
|
972
|
+
*/
|
|
973
|
+
endDate?: string;
|
|
974
|
+
/**
|
|
975
|
+
* - Filter results by the current stage of the import job.
|
|
976
|
+
*/
|
|
977
|
+
stage?: string;
|
|
951
978
|
};
|
|
952
979
|
type GetInventoryBySizeParam = {
|
|
953
980
|
/**
|
|
@@ -1391,6 +1418,16 @@ type ListProductTemplateParam = {
|
|
|
1391
1418
|
* - A `department` is the name of a particular department.
|
|
1392
1419
|
*/
|
|
1393
1420
|
department: string;
|
|
1421
|
+
/**
|
|
1422
|
+
* - The page number to navigate through the given
|
|
1423
|
+
* set of results
|
|
1424
|
+
*/
|
|
1425
|
+
pageNo?: number;
|
|
1426
|
+
/**
|
|
1427
|
+
* - Number of items to retrieve in each page.
|
|
1428
|
+
* Default is 12.
|
|
1429
|
+
*/
|
|
1430
|
+
pageSize?: number;
|
|
1394
1431
|
};
|
|
1395
1432
|
type ListProductTemplateCategoriesParam = {
|
|
1396
1433
|
/**
|
|
@@ -1540,6 +1577,10 @@ type ValidateProductTemplateSchemaParam = {
|
|
|
1540
1577
|
* default value is standard.
|
|
1541
1578
|
*/
|
|
1542
1579
|
itemType: string;
|
|
1580
|
+
/**
|
|
1581
|
+
* - Schema of price or quantity template
|
|
1582
|
+
*/
|
|
1583
|
+
schemaType?: string;
|
|
1543
1584
|
};
|
|
1544
1585
|
type GetCompanyDetailParam = any;
|
|
1545
1586
|
type GetCompanyMetricsParam = any;
|
|
@@ -114,7 +114,9 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
|
|
|
114
114
|
|
|
115
115
|
/**
|
|
116
116
|
* @typedef DownloadInventoryTemplateViewParam
|
|
117
|
-
* @property {string}
|
|
117
|
+
* @property {string} schemaType - Specifies the type of template to download.
|
|
118
|
+
* Either quantity or price
|
|
119
|
+
* @property {string} type - File extension type
|
|
118
120
|
*/
|
|
119
121
|
|
|
120
122
|
/**
|
|
@@ -219,6 +221,9 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
|
|
|
219
221
|
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
220
222
|
* Default is 12.
|
|
221
223
|
* @property {string} [search] - Search string to filter the results by batch id
|
|
224
|
+
* @property {string} [startDate] - Filter results by the job's start date.
|
|
225
|
+
* @property {string} [endDate] - Filter results by the job's end date.
|
|
226
|
+
* @property {string} [stage] - Filter results by the current stage of the import job.
|
|
222
227
|
*/
|
|
223
228
|
|
|
224
229
|
/**
|
|
@@ -451,6 +456,10 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
|
|
|
451
456
|
/**
|
|
452
457
|
* @typedef ListProductTemplateParam
|
|
453
458
|
* @property {string} department - A `department` is the name of a particular department.
|
|
459
|
+
* @property {number} [pageNo] - The page number to navigate through the given
|
|
460
|
+
* set of results
|
|
461
|
+
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
462
|
+
* Default is 12.
|
|
454
463
|
*/
|
|
455
464
|
|
|
456
465
|
/**
|
|
@@ -561,6 +570,7 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
|
|
|
561
570
|
* @typedef ValidateProductTemplateSchemaParam
|
|
562
571
|
* @property {string} itemType - An `item_type` defines the type of item. The
|
|
563
572
|
* default value is standard.
|
|
573
|
+
* @property {string} [schemaType] - Schema of price or quantity template
|
|
564
574
|
*/
|
|
565
575
|
|
|
566
576
|
class CatalogPlatformValidator {
|
|
@@ -715,7 +725,8 @@ class CatalogPlatformValidator {
|
|
|
715
725
|
/** @returns {DownloadInventoryTemplateViewParam} */
|
|
716
726
|
static downloadInventoryTemplateView() {
|
|
717
727
|
return Joi.object({
|
|
718
|
-
|
|
728
|
+
schemaType: Joi.string().allow("").required(),
|
|
729
|
+
type: Joi.string().allow("").required(),
|
|
719
730
|
}).required();
|
|
720
731
|
}
|
|
721
732
|
|
|
@@ -831,6 +842,9 @@ class CatalogPlatformValidator {
|
|
|
831
842
|
pageNo: Joi.number(),
|
|
832
843
|
pageSize: Joi.number(),
|
|
833
844
|
search: Joi.string().allow(""),
|
|
845
|
+
startDate: Joi.string().allow(""),
|
|
846
|
+
endDate: Joi.string().allow(""),
|
|
847
|
+
stage: Joi.string().allow(""),
|
|
834
848
|
}).required();
|
|
835
849
|
}
|
|
836
850
|
|
|
@@ -1083,6 +1097,8 @@ class CatalogPlatformValidator {
|
|
|
1083
1097
|
static listProductTemplate() {
|
|
1084
1098
|
return Joi.object({
|
|
1085
1099
|
department: Joi.string().allow("").required(),
|
|
1100
|
+
pageNo: Joi.number(),
|
|
1101
|
+
pageSize: Joi.number(),
|
|
1086
1102
|
}).required();
|
|
1087
1103
|
}
|
|
1088
1104
|
|
|
@@ -1204,6 +1220,7 @@ class CatalogPlatformValidator {
|
|
|
1204
1220
|
static validateProductTemplateSchema() {
|
|
1205
1221
|
return Joi.object({
|
|
1206
1222
|
itemType: Joi.string().allow("").required(),
|
|
1223
|
+
schemaType: Joi.string().allow(""),
|
|
1207
1224
|
}).required();
|
|
1208
1225
|
}
|
|
1209
1226
|
}
|
|
@@ -317,7 +317,7 @@ declare class Payment {
|
|
|
317
317
|
* @summary: List POS payment modes
|
|
318
318
|
* @description: Available payment methods on the payment page for POS, specifying the aggregator for each option, such as 'CARD powered by Juspay' and 'QR powered by Razorpay'. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getPosPaymentModeRoutes/).
|
|
319
319
|
*/
|
|
320
|
-
getPosPaymentModeRoutes({ amount, pincode, orderType, xOrderingSource, cartId, checkoutMode, refresh, orderId, cardReference, userDetails, displaySplit, advancePayment, shipmentId, requestHeaders, }?: PaymentPlatformApplicationValidator.GetPosPaymentModeRoutesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentModeRouteDetails>;
|
|
320
|
+
getPosPaymentModeRoutes({ amount, pincode, orderType, xOrderingSource, cartId, checkoutMode, refresh, orderId, cardReference, userDetails, displaySplit, advancePayment, shipmentId, customerId, requestHeaders, }?: PaymentPlatformApplicationValidator.GetPosPaymentModeRoutesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentModeRouteDetails>;
|
|
321
321
|
/**
|
|
322
322
|
* @param {PaymentPlatformApplicationValidator.GetUserBeneficiariesParam} arg
|
|
323
323
|
* - Arg object
|
|
@@ -2124,6 +2124,7 @@ class Payment {
|
|
|
2124
2124
|
displaySplit,
|
|
2125
2125
|
advancePayment,
|
|
2126
2126
|
shipmentId,
|
|
2127
|
+
customerId,
|
|
2127
2128
|
requestHeaders,
|
|
2128
2129
|
} = { requestHeaders: {} },
|
|
2129
2130
|
{ responseHeaders } = { responseHeaders: false }
|
|
@@ -2145,6 +2146,7 @@ class Payment {
|
|
|
2145
2146
|
displaySplit,
|
|
2146
2147
|
advancePayment,
|
|
2147
2148
|
shipmentId,
|
|
2149
|
+
customerId,
|
|
2148
2150
|
},
|
|
2149
2151
|
{ abortEarly: false, allowUnknown: true }
|
|
2150
2152
|
);
|
|
@@ -2170,6 +2172,7 @@ class Payment {
|
|
|
2170
2172
|
displaySplit,
|
|
2171
2173
|
advancePayment,
|
|
2172
2174
|
shipmentId,
|
|
2175
|
+
customerId,
|
|
2173
2176
|
},
|
|
2174
2177
|
{ abortEarly: false, allowUnknown: false }
|
|
2175
2178
|
);
|
|
@@ -2193,6 +2196,7 @@ class Payment {
|
|
|
2193
2196
|
query_params["display_split"] = displaySplit;
|
|
2194
2197
|
query_params["advance_payment"] = advancePayment;
|
|
2195
2198
|
query_params["shipment_id"] = shipmentId;
|
|
2199
|
+
query_params["customer_id"] = customerId;
|
|
2196
2200
|
|
|
2197
2201
|
const response = await PlatformAPIClient.execute(
|
|
2198
2202
|
this.config,
|
|
@@ -132,6 +132,7 @@ export = PaymentPlatformApplicationValidator;
|
|
|
132
132
|
* @property {boolean} [displaySplit] - Display Split Payment Option or not
|
|
133
133
|
* @property {boolean} [advancePayment] - Display Advance Payment Options or Normal
|
|
134
134
|
* @property {string} [shipmentId]
|
|
135
|
+
* @property {string} [customerId]
|
|
135
136
|
*/
|
|
136
137
|
/**
|
|
137
138
|
* @typedef GetUserBeneficiariesParam
|
|
@@ -544,6 +545,7 @@ type GetPosPaymentModeRoutesParam = {
|
|
|
544
545
|
*/
|
|
545
546
|
advancePayment?: boolean;
|
|
546
547
|
shipmentId?: string;
|
|
548
|
+
customerId?: string;
|
|
547
549
|
};
|
|
548
550
|
type GetUserBeneficiariesParam = {
|
|
549
551
|
orderId: string;
|