@gofynd/fdk-client-javascript 3.3.3 → 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/partner/Logistics/LogisticsPartnerModel.d.ts +55 -1
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +39 -0
- package/sdk/platform/Cart/CartPlatformModel.d.ts +21 -0
- package/sdk/platform/Cart/CartPlatformModel.js +9 -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/PaymentPlatformModel.d.ts +83 -1
- package/sdk/platform/Payment/PaymentPlatformModel.js +48 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +57 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +41 -0
package/README.md
CHANGED
|
@@ -237,7 +237,7 @@ console.log("Active Theme: ", response.information.name);
|
|
|
237
237
|
The above code will log the curl command in the console
|
|
238
238
|
|
|
239
239
|
```bash
|
|
240
|
-
curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 3.3.
|
|
240
|
+
curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 3.3.5' --header 'x-fp-date: 20230222T115108Z' --header 'x-fp-signature: v1.1:1e3ab3b02b5bc626e3c32a37ee844266ade02bbcbaafc28fc7a0e46a76a7a1a8'
|
|
241
241
|
Active Theme: Emerge
|
|
242
242
|
```
|
|
243
243
|
|
package/package.json
CHANGED
|
@@ -359,6 +359,11 @@ export = LogisticsPartnerModel;
|
|
|
359
359
|
* @property {string} [scheme_id] - Unique identifier for the scheme, used to
|
|
360
360
|
* fetch or modify scheme details.
|
|
361
361
|
* @property {string} name - Name of the scheme.
|
|
362
|
+
* @property {string} [default_forward_pickup_cutoff] - Default cutoff time for
|
|
363
|
+
* forward pickup (nullable).
|
|
364
|
+
* @property {string} [default_reverse_pickup_cutoff] - Default cutoff time for
|
|
365
|
+
* reverse pickup (nullable).
|
|
366
|
+
* @property {CourierPartnerSchemeDefaultTat} [default_tat]
|
|
362
367
|
* @property {ArithmeticOperations} weight
|
|
363
368
|
* @property {ArithmeticOperations} [volumetric_weight]
|
|
364
369
|
* @property {string} transport_type - Mode of transport associated with the
|
|
@@ -570,6 +575,18 @@ export = LogisticsPartnerModel;
|
|
|
570
575
|
* @property {string} stage - A string indicating the current stage of the scheme.
|
|
571
576
|
* @property {CourierPartnerSchemeFeatures} feature
|
|
572
577
|
*/
|
|
578
|
+
/**
|
|
579
|
+
* @typedef CourierPartnerSchemeDefaultTat
|
|
580
|
+
* @property {boolean} [enabled] - Indicates whether the default turn around
|
|
581
|
+
* time (tat) to be used for the given scheme or not.
|
|
582
|
+
* @property {CourierPartnerSchemeTat} [tat]
|
|
583
|
+
*/
|
|
584
|
+
/**
|
|
585
|
+
* @typedef CourierPartnerSchemeTat
|
|
586
|
+
* @property {number} [min] - Minimum turn around time (tat) value for a scheme.
|
|
587
|
+
* @property {number} [max] - Maximum turn around time (tat) value for a scheme.
|
|
588
|
+
* @property {string} [unit] - Unit for the turn around time (tat) values for a scheme.
|
|
589
|
+
*/
|
|
573
590
|
/**
|
|
574
591
|
* @typedef GetCountriesItems
|
|
575
592
|
* @property {string} [id] - A string serving as the unique identifier.
|
|
@@ -616,7 +633,7 @@ export = LogisticsPartnerModel;
|
|
|
616
633
|
declare class LogisticsPartnerModel {
|
|
617
634
|
}
|
|
618
635
|
declare namespace LogisticsPartnerModel {
|
|
619
|
-
export { CourierPartnerSchemeModelSchema, BulkRegionServiceabilityTatDetails, BulkRegionServiceabilityTatResultItemData, CommonErrorResult, BulkFailureResult, FailureResult, BulkRegionServiceabilityTatResult, RegionTatItemResult, RegionServiceabilityItemResult, ServiceabilityDetailsResult, ServiceabilityDetails, RegionServiceabilityResult, RegionServiceabilityDetails, RegionTatDetails, RegionTatResult, BulkRegionJobDetails, BulkRegionResultItemData, BulkRegionResult, CourierAccountDetailsBody, CompanyCourierPartnerAccountListResult, CourierAccountResult, CourierPartnerSchemeDetailsModel, CourierPartnerPutSchema, CourierPartnerSchemeList, CourierPartnerSchemeUpdateDetails, GetCountries, TATUpdateDetails, StandardError, ValidationErrors, CreatedBy, ModifiedBy, ArithmeticOperations, CourierPartnerSchemeFeatures, Error, Page, TATDetails, CourierPartnerSchemeModel, GetCountriesItems, HierarchyItems, CurrencyObject, ValidationError };
|
|
636
|
+
export { CourierPartnerSchemeModelSchema, BulkRegionServiceabilityTatDetails, BulkRegionServiceabilityTatResultItemData, CommonErrorResult, BulkFailureResult, FailureResult, BulkRegionServiceabilityTatResult, RegionTatItemResult, RegionServiceabilityItemResult, ServiceabilityDetailsResult, ServiceabilityDetails, RegionServiceabilityResult, RegionServiceabilityDetails, RegionTatDetails, RegionTatResult, BulkRegionJobDetails, BulkRegionResultItemData, BulkRegionResult, CourierAccountDetailsBody, CompanyCourierPartnerAccountListResult, CourierAccountResult, CourierPartnerSchemeDetailsModel, CourierPartnerPutSchema, CourierPartnerSchemeList, CourierPartnerSchemeUpdateDetails, GetCountries, TATUpdateDetails, StandardError, ValidationErrors, CreatedBy, ModifiedBy, ArithmeticOperations, CourierPartnerSchemeFeatures, Error, Page, TATDetails, CourierPartnerSchemeModel, CourierPartnerSchemeDefaultTat, CourierPartnerSchemeTat, GetCountriesItems, HierarchyItems, CurrencyObject, ValidationError };
|
|
620
637
|
}
|
|
621
638
|
/** @returns {CourierPartnerSchemeModelSchema} */
|
|
622
639
|
declare function CourierPartnerSchemeModelSchema(): CourierPartnerSchemeModelSchema;
|
|
@@ -1477,6 +1494,17 @@ type CourierPartnerSchemeDetailsModel = {
|
|
|
1477
1494
|
* - Name of the scheme.
|
|
1478
1495
|
*/
|
|
1479
1496
|
name: string;
|
|
1497
|
+
/**
|
|
1498
|
+
* - Default cutoff time for
|
|
1499
|
+
* forward pickup (nullable).
|
|
1500
|
+
*/
|
|
1501
|
+
default_forward_pickup_cutoff?: string;
|
|
1502
|
+
/**
|
|
1503
|
+
* - Default cutoff time for
|
|
1504
|
+
* reverse pickup (nullable).
|
|
1505
|
+
*/
|
|
1506
|
+
default_reverse_pickup_cutoff?: string;
|
|
1507
|
+
default_tat?: CourierPartnerSchemeDefaultTat;
|
|
1480
1508
|
weight: ArithmeticOperations;
|
|
1481
1509
|
volumetric_weight?: ArithmeticOperations;
|
|
1482
1510
|
/**
|
|
@@ -1964,6 +1992,32 @@ type CourierPartnerSchemeModel = {
|
|
|
1964
1992
|
stage: string;
|
|
1965
1993
|
feature: CourierPartnerSchemeFeatures;
|
|
1966
1994
|
};
|
|
1995
|
+
/** @returns {CourierPartnerSchemeDefaultTat} */
|
|
1996
|
+
declare function CourierPartnerSchemeDefaultTat(): CourierPartnerSchemeDefaultTat;
|
|
1997
|
+
type CourierPartnerSchemeDefaultTat = {
|
|
1998
|
+
/**
|
|
1999
|
+
* - Indicates whether the default turn around
|
|
2000
|
+
* time (tat) to be used for the given scheme or not.
|
|
2001
|
+
*/
|
|
2002
|
+
enabled?: boolean;
|
|
2003
|
+
tat?: CourierPartnerSchemeTat;
|
|
2004
|
+
};
|
|
2005
|
+
/** @returns {CourierPartnerSchemeTat} */
|
|
2006
|
+
declare function CourierPartnerSchemeTat(): CourierPartnerSchemeTat;
|
|
2007
|
+
type CourierPartnerSchemeTat = {
|
|
2008
|
+
/**
|
|
2009
|
+
* - Minimum turn around time (tat) value for a scheme.
|
|
2010
|
+
*/
|
|
2011
|
+
min?: number;
|
|
2012
|
+
/**
|
|
2013
|
+
* - Maximum turn around time (tat) value for a scheme.
|
|
2014
|
+
*/
|
|
2015
|
+
max?: number;
|
|
2016
|
+
/**
|
|
2017
|
+
* - Unit for the turn around time (tat) values for a scheme.
|
|
2018
|
+
*/
|
|
2019
|
+
unit?: string;
|
|
2020
|
+
};
|
|
1967
2021
|
/** @returns {GetCountriesItems} */
|
|
1968
2022
|
declare function GetCountriesItems(): GetCountriesItems;
|
|
1969
2023
|
type GetCountriesItems = {
|
|
@@ -381,6 +381,11 @@ const Joi = require("joi");
|
|
|
381
381
|
* @property {string} [scheme_id] - Unique identifier for the scheme, used to
|
|
382
382
|
* fetch or modify scheme details.
|
|
383
383
|
* @property {string} name - Name of the scheme.
|
|
384
|
+
* @property {string} [default_forward_pickup_cutoff] - Default cutoff time for
|
|
385
|
+
* forward pickup (nullable).
|
|
386
|
+
* @property {string} [default_reverse_pickup_cutoff] - Default cutoff time for
|
|
387
|
+
* reverse pickup (nullable).
|
|
388
|
+
* @property {CourierPartnerSchemeDefaultTat} [default_tat]
|
|
384
389
|
* @property {ArithmeticOperations} weight
|
|
385
390
|
* @property {ArithmeticOperations} [volumetric_weight]
|
|
386
391
|
* @property {string} transport_type - Mode of transport associated with the
|
|
@@ -608,6 +613,20 @@ const Joi = require("joi");
|
|
|
608
613
|
* @property {CourierPartnerSchemeFeatures} feature
|
|
609
614
|
*/
|
|
610
615
|
|
|
616
|
+
/**
|
|
617
|
+
* @typedef CourierPartnerSchemeDefaultTat
|
|
618
|
+
* @property {boolean} [enabled] - Indicates whether the default turn around
|
|
619
|
+
* time (tat) to be used for the given scheme or not.
|
|
620
|
+
* @property {CourierPartnerSchemeTat} [tat]
|
|
621
|
+
*/
|
|
622
|
+
|
|
623
|
+
/**
|
|
624
|
+
* @typedef CourierPartnerSchemeTat
|
|
625
|
+
* @property {number} [min] - Minimum turn around time (tat) value for a scheme.
|
|
626
|
+
* @property {number} [max] - Maximum turn around time (tat) value for a scheme.
|
|
627
|
+
* @property {string} [unit] - Unit for the turn around time (tat) values for a scheme.
|
|
628
|
+
*/
|
|
629
|
+
|
|
611
630
|
/**
|
|
612
631
|
* @typedef GetCountriesItems
|
|
613
632
|
* @property {string} [id] - A string serving as the unique identifier.
|
|
@@ -969,6 +988,9 @@ class LogisticsPartnerModel {
|
|
|
969
988
|
extension_id: Joi.string().allow("").required(),
|
|
970
989
|
scheme_id: Joi.string().allow(""),
|
|
971
990
|
name: Joi.string().allow("").required(),
|
|
991
|
+
default_forward_pickup_cutoff: Joi.string().allow("").allow(null),
|
|
992
|
+
default_reverse_pickup_cutoff: Joi.string().allow("").allow(null),
|
|
993
|
+
default_tat: LogisticsPartnerModel.CourierPartnerSchemeDefaultTat(),
|
|
972
994
|
weight: LogisticsPartnerModel.ArithmeticOperations().required(),
|
|
973
995
|
volumetric_weight: LogisticsPartnerModel.ArithmeticOperations(),
|
|
974
996
|
transport_type: Joi.string().allow("").required(),
|
|
@@ -1173,6 +1195,23 @@ class LogisticsPartnerModel {
|
|
|
1173
1195
|
});
|
|
1174
1196
|
}
|
|
1175
1197
|
|
|
1198
|
+
/** @returns {CourierPartnerSchemeDefaultTat} */
|
|
1199
|
+
static CourierPartnerSchemeDefaultTat() {
|
|
1200
|
+
return Joi.object({
|
|
1201
|
+
enabled: Joi.boolean(),
|
|
1202
|
+
tat: LogisticsPartnerModel.CourierPartnerSchemeTat(),
|
|
1203
|
+
});
|
|
1204
|
+
}
|
|
1205
|
+
|
|
1206
|
+
/** @returns {CourierPartnerSchemeTat} */
|
|
1207
|
+
static CourierPartnerSchemeTat() {
|
|
1208
|
+
return Joi.object({
|
|
1209
|
+
min: Joi.number(),
|
|
1210
|
+
max: Joi.number(),
|
|
1211
|
+
unit: Joi.string().allow(""),
|
|
1212
|
+
});
|
|
1213
|
+
}
|
|
1214
|
+
|
|
1176
1215
|
/** @returns {GetCountriesItems} */
|
|
1177
1216
|
static GetCountriesItems() {
|
|
1178
1217
|
return Joi.object({
|
|
@@ -962,6 +962,8 @@ export = CartPlatformModel;
|
|
|
962
962
|
* message for the gift
|
|
963
963
|
* @property {string[]} [product_group_tags] - List fot the unique identifier
|
|
964
964
|
* for the product grouping.
|
|
965
|
+
* @property {boolean} [force_new_line_item] - Flag to indicate the item as a
|
|
966
|
+
* seperate article in cart
|
|
965
967
|
* @property {Object} [identifier] - Unique identifier of the article
|
|
966
968
|
* @property {number} [mto_quantity] - Quantity of the product which will
|
|
967
969
|
* specially manufactured as not available in stock
|
|
@@ -1444,6 +1446,8 @@ export = CartPlatformModel;
|
|
|
1444
1446
|
* level while add items to cart
|
|
1445
1447
|
* @property {Object} [_custom_json] - Field to add custom json at article level
|
|
1446
1448
|
* while add items to cart
|
|
1449
|
+
* @property {boolean} [force_new_line_item] - Field used to decide the product
|
|
1450
|
+
* add as a seperate product in cart
|
|
1447
1451
|
* @property {Object} [meta] - Field to add meta data at article level
|
|
1448
1452
|
* @property {boolean} [pos] - Filed to determine whether user is making request
|
|
1449
1453
|
* from pos or not
|
|
@@ -1487,6 +1491,8 @@ export = CartPlatformModel;
|
|
|
1487
1491
|
* @property {Object} [meta] - Field to update meta of the item in cart
|
|
1488
1492
|
* @property {Object} [extra_meta] - Field to update extra meta of the product in cart
|
|
1489
1493
|
* @property {Object} [_custom_json] - Field to update custom json of the product in cart
|
|
1494
|
+
* @property {boolean} [force_new_line_item] - Field used to decide the product
|
|
1495
|
+
* add as a seperate product in cart
|
|
1490
1496
|
* @property {number} [item_id] - Item id of the product that needs to be updated
|
|
1491
1497
|
* @property {number} [item_index] - Item index determines on which index the
|
|
1492
1498
|
* product falls to be updated
|
|
@@ -4684,6 +4690,11 @@ type ProductArticle = {
|
|
|
4684
4690
|
* for the product grouping.
|
|
4685
4691
|
*/
|
|
4686
4692
|
product_group_tags?: string[];
|
|
4693
|
+
/**
|
|
4694
|
+
* - Flag to indicate the item as a
|
|
4695
|
+
* seperate article in cart
|
|
4696
|
+
*/
|
|
4697
|
+
force_new_line_item?: boolean;
|
|
4687
4698
|
/**
|
|
4688
4699
|
* - Unique identifier of the article
|
|
4689
4700
|
*/
|
|
@@ -5956,6 +5967,11 @@ type AddProductCart = {
|
|
|
5956
5967
|
* while add items to cart
|
|
5957
5968
|
*/
|
|
5958
5969
|
_custom_json?: any;
|
|
5970
|
+
/**
|
|
5971
|
+
* - Field used to decide the product
|
|
5972
|
+
* add as a seperate product in cart
|
|
5973
|
+
*/
|
|
5974
|
+
force_new_line_item?: boolean;
|
|
5959
5975
|
/**
|
|
5960
5976
|
* - Field to add meta data at article level
|
|
5961
5977
|
*/
|
|
@@ -6066,6 +6082,11 @@ type UpdateProductCart = {
|
|
|
6066
6082
|
* - Field to update custom json of the product in cart
|
|
6067
6083
|
*/
|
|
6068
6084
|
_custom_json?: any;
|
|
6085
|
+
/**
|
|
6086
|
+
* - Field used to decide the product
|
|
6087
|
+
* add as a seperate product in cart
|
|
6088
|
+
*/
|
|
6089
|
+
force_new_line_item?: boolean;
|
|
6069
6090
|
/**
|
|
6070
6091
|
* - Item id of the product that needs to be updated
|
|
6071
6092
|
*/
|
|
@@ -1053,6 +1053,8 @@ const Joi = require("joi");
|
|
|
1053
1053
|
* message for the gift
|
|
1054
1054
|
* @property {string[]} [product_group_tags] - List fot the unique identifier
|
|
1055
1055
|
* for the product grouping.
|
|
1056
|
+
* @property {boolean} [force_new_line_item] - Flag to indicate the item as a
|
|
1057
|
+
* seperate article in cart
|
|
1056
1058
|
* @property {Object} [identifier] - Unique identifier of the article
|
|
1057
1059
|
* @property {number} [mto_quantity] - Quantity of the product which will
|
|
1058
1060
|
* specially manufactured as not available in stock
|
|
@@ -1575,6 +1577,8 @@ const Joi = require("joi");
|
|
|
1575
1577
|
* level while add items to cart
|
|
1576
1578
|
* @property {Object} [_custom_json] - Field to add custom json at article level
|
|
1577
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
|
|
1578
1582
|
* @property {Object} [meta] - Field to add meta data at article level
|
|
1579
1583
|
* @property {boolean} [pos] - Filed to determine whether user is making request
|
|
1580
1584
|
* from pos or not
|
|
@@ -1622,6 +1626,8 @@ const Joi = require("joi");
|
|
|
1622
1626
|
* @property {Object} [meta] - Field to update meta of the item in cart
|
|
1623
1627
|
* @property {Object} [extra_meta] - Field to update extra meta of the product in cart
|
|
1624
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
|
|
1625
1631
|
* @property {number} [item_id] - Item id of the product that needs to be updated
|
|
1626
1632
|
* @property {number} [item_index] - Item index determines on which index the
|
|
1627
1633
|
* product falls to be updated
|
|
@@ -3642,6 +3648,7 @@ class CartPlatformModel {
|
|
|
3642
3648
|
uid: Joi.string().allow(""),
|
|
3643
3649
|
gift_card: Joi.object().pattern(/\S/, Joi.any()),
|
|
3644
3650
|
product_group_tags: Joi.array().items(Joi.string().allow("")),
|
|
3651
|
+
force_new_line_item: Joi.boolean(),
|
|
3645
3652
|
identifier: Joi.object().pattern(/\S/, Joi.any()),
|
|
3646
3653
|
mto_quantity: Joi.number(),
|
|
3647
3654
|
extra_meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
@@ -4184,6 +4191,7 @@ class CartPlatformModel {
|
|
|
4184
4191
|
item_id: Joi.number(),
|
|
4185
4192
|
extra_meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
4186
4193
|
_custom_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
4194
|
+
force_new_line_item: Joi.boolean(),
|
|
4187
4195
|
meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
4188
4196
|
pos: Joi.boolean(),
|
|
4189
4197
|
seller_identifier: Joi.string().allow(""),
|
|
@@ -4230,6 +4238,7 @@ class CartPlatformModel {
|
|
|
4230
4238
|
meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
4231
4239
|
extra_meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
4232
4240
|
_custom_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
4241
|
+
force_new_line_item: Joi.boolean(),
|
|
4233
4242
|
item_id: Joi.number(),
|
|
4234
4243
|
item_index: Joi.number(),
|
|
4235
4244
|
identifiers: CartPlatformModel.CartProductIdentifer().required(),
|
|
@@ -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
|
}
|
|
@@ -795,6 +795,8 @@ export = PaymentPlatformModel;
|
|
|
795
795
|
* redirected after a successful payment.
|
|
796
796
|
* @property {string} [failure_redirection_url] - URL to which the user will be
|
|
797
797
|
* redirected if the payment fails.
|
|
798
|
+
* @property {boolean} [send_communication] - Flag indicating whether to send
|
|
799
|
+
* communications (e.g., SMS or email) for the payment link
|
|
798
800
|
*/
|
|
799
801
|
/**
|
|
800
802
|
* @typedef CreatePaymentLinkDetails
|
|
@@ -868,6 +870,25 @@ export = PaymentPlatformModel;
|
|
|
868
870
|
* @property {Object} [offline] - Details to be updated for online payment configuration.
|
|
869
871
|
* @property {Object} [online] - Details to be updated for offline payment configuration.
|
|
870
872
|
*/
|
|
873
|
+
/**
|
|
874
|
+
* @typedef SkuDetails
|
|
875
|
+
* @property {string} [identifier] - SKU identifier of the offer
|
|
876
|
+
* @property {string} [sku_id] - Unique SKU identifier (example: GTIN, variant ID)
|
|
877
|
+
* @property {string} [sku_name] - Display name of the SKU
|
|
878
|
+
*/
|
|
879
|
+
/**
|
|
880
|
+
* @typedef AppliedOffer
|
|
881
|
+
* @property {boolean} [is_mop] - Whether the offer is a mop or not. MOP is a
|
|
882
|
+
* discount that is applied on the total order value.
|
|
883
|
+
* @property {string} [offer_type] - Type of offer. It can be either a bank or
|
|
884
|
+
* brand offer.
|
|
885
|
+
* @property {string} [offer_id] - Unique identifier for the offer.
|
|
886
|
+
* @property {string} [description] - Description of the offer.
|
|
887
|
+
* @property {number} [amount] - Amount of the offer in paise. (Example: ₹1 = 100 paise)
|
|
888
|
+
* @property {Object} [meta] - Extra meta data specific to extension
|
|
889
|
+
* @property {SkuDetails[]} [sku_details] - List of sku details for which the
|
|
890
|
+
* offer is applicable. This is applicable only for brand offers.
|
|
891
|
+
*/
|
|
871
892
|
/**
|
|
872
893
|
* @typedef OrderDetail
|
|
873
894
|
* @property {string} gid - Global identifier of the entity (e.g. order, cart
|
|
@@ -879,6 +900,7 @@ export = PaymentPlatformModel;
|
|
|
879
900
|
* @property {Object} aggregator_order_details - Aggregator order details
|
|
880
901
|
* generated by the payment gateway.
|
|
881
902
|
* @property {string} aggregator - Name of the payment gateway aggregator.
|
|
903
|
+
* @property {AppliedOffer[]} [applied_offers] - List of offers applied on the order.
|
|
882
904
|
*/
|
|
883
905
|
/**
|
|
884
906
|
* @typedef AddressDetail
|
|
@@ -1271,7 +1293,7 @@ export = PaymentPlatformModel;
|
|
|
1271
1293
|
declare class PaymentPlatformModel {
|
|
1272
1294
|
}
|
|
1273
1295
|
declare namespace PaymentPlatformModel {
|
|
1274
|
-
export { PaymentGatewayConfigDetails, ErrorCodeDescription, PaymentGatewayConfig, PaymentGatewayConfigCreation, PaymentGatewayToBeReviewed, ErrorCodeAndDescription, HttpErrorDetails, IntentAppErrorList, ProductCODData, CODChargesLimitsDetails, PaymentModeLogo, IntentApp, PaymentModeList, PaymentConfirmationElement, RootPaymentMode, PaymentOptions, AggregatorRoute, PaymentDefaultSelection, PaymentFlow, PaymentOptionAndFlow, AdvanceObject, SplitObject, AdvancePaymentObject, PaymentModeRouteDetails, PaymentOptionsDetails, PayoutCustomer, PayoutMoreAttributes, PayoutAggregator, Payout, PayoutsDetails, PayoutBankDetails, PayoutCreation, PayoutDetails, UpdatePayoutDetails, UpdatePayoutCreation, DeletePayoutDetails, SubscriptionPaymentMethodDetails, DeleteSubscriptionPaymentMethodDetails, SubscriptionConfigDetails, SaveSubscriptionSetupIntentCreation, SaveSubscriptionSetupIntentDetails, RefundAccountDetails, NotFoundResourceError, BankDetailsForOTP, AddBeneficiaryDetailsOTPCreation, IfscCodeDetails, OrderBeneficiaryDetails, OrderBeneficiaryFetchResults, MultiTenderPaymentMeta, MultiTenderPaymentMethod, PaymentConfirmationCreation, PaymentConfirmationDetails, CODdata, CODLimitConfig, CODPaymentLimitConfig, GetUserBULimitResponseSchema, GetUserCODLimitDetails, SetCODForUserCreation, SetCODOptionDetails, EdcModelData, EdcAggregatorAndModelListDetails, StatisticsData, EdcDeviceStatsDetails, EdcAddCreation, EdcDevice, EdcDeviceAddDetails, EdcDeviceDetails, EdcUpdate, EdcDeviceUpdateDetails, Page, EdcDeviceListDetails, PaymentInitializationCreation, PaymentInitializationDetails, PaymentStatusUpdateCreation, PaymentStatusUpdateDetails, ResendOrCancelPaymentCreation, LinkStatus, ResendOrCancelPaymentDetails, PaymentStatusBulkHandlerCreation, PaymentObjectList, PaymentStatusObject, PaymentStatusBulkHandlerDetails, GetOauthUrlDetails, RevokeOAuthToken, RepaymentRequestDetails, RepaymentDetailsSerialiserPayAll, RepaymentDetails, MerchantOnBoardingCreation, MerchantOnBoardingDetails, ValidateCustomerCreation, ValidateCustomerDetails, GetPaymentLinkDetails, ErrorDescription, ErrorDetails, CreatePaymentLinkMeta, CreatePaymentLinkCreation, CreatePaymentLinkDetails, PollingPaymentLinkDetails, CancelOrResendPaymentLinkCreation, ResendPaymentLinkDetails, CancelPaymentLinkDetails, Code, PaymentCode, GetPaymentCode, GetPaymentCodeDetails, PlatformPaymentModeDetails, MerchnatPaymentModeCreation, OrderDetail, AddressDetail, ReasonDetail, PaymentSessionDetail, PaymentSessionCreation, PaymentSessionPutDetails, RefundSessionDetail, RefundSessionCreation, RefundSessionDetails, PaymentDetails, CartDetails, RefundDetails, PaymentSessionFetchDetails, RefundSourcesPriority, RefundPriorityDetails, RefundPriorityCreation, MerchantPaymentModeCreation, FromConfig, ToConfig, PlatformPaymentModeCopyConfigCreation, PaymentMethodsMetaOrder, PaymentOrderMethods, PaymentOrderCreation, PaymentOrderData, PaymentOrderDetails, AggregatorVersionItemSchema, AggregatorVersionDetails, AggregatorVersionRequestSchema, PatchAggregatorControl, PaymentModeCustomConfigSchema, PaymentCustomConfigDetailsSchema, PaymentCustomConfigCustomerSchema, PaymentCustomConfigModeSchema, PaymentCustomConfigDetailsRequestSchema, PaymentCustomConfigCustomerRequestSchema, PaymentCustomConfigRequestSchema, PaymentCustomConfigResponseSchema, CustomerValidationSchema, UserCreditSchema, CreditAccountSummary, ValidateCustomerCreditSchema };
|
|
1296
|
+
export { PaymentGatewayConfigDetails, ErrorCodeDescription, PaymentGatewayConfig, PaymentGatewayConfigCreation, PaymentGatewayToBeReviewed, ErrorCodeAndDescription, HttpErrorDetails, IntentAppErrorList, ProductCODData, CODChargesLimitsDetails, PaymentModeLogo, IntentApp, PaymentModeList, PaymentConfirmationElement, RootPaymentMode, PaymentOptions, AggregatorRoute, PaymentDefaultSelection, PaymentFlow, PaymentOptionAndFlow, AdvanceObject, SplitObject, AdvancePaymentObject, PaymentModeRouteDetails, PaymentOptionsDetails, PayoutCustomer, PayoutMoreAttributes, PayoutAggregator, Payout, PayoutsDetails, PayoutBankDetails, PayoutCreation, PayoutDetails, UpdatePayoutDetails, UpdatePayoutCreation, DeletePayoutDetails, SubscriptionPaymentMethodDetails, DeleteSubscriptionPaymentMethodDetails, SubscriptionConfigDetails, SaveSubscriptionSetupIntentCreation, SaveSubscriptionSetupIntentDetails, RefundAccountDetails, NotFoundResourceError, BankDetailsForOTP, AddBeneficiaryDetailsOTPCreation, IfscCodeDetails, OrderBeneficiaryDetails, OrderBeneficiaryFetchResults, MultiTenderPaymentMeta, MultiTenderPaymentMethod, PaymentConfirmationCreation, PaymentConfirmationDetails, CODdata, CODLimitConfig, CODPaymentLimitConfig, GetUserBULimitResponseSchema, GetUserCODLimitDetails, SetCODForUserCreation, SetCODOptionDetails, EdcModelData, EdcAggregatorAndModelListDetails, StatisticsData, EdcDeviceStatsDetails, EdcAddCreation, EdcDevice, EdcDeviceAddDetails, EdcDeviceDetails, EdcUpdate, EdcDeviceUpdateDetails, Page, EdcDeviceListDetails, PaymentInitializationCreation, PaymentInitializationDetails, PaymentStatusUpdateCreation, PaymentStatusUpdateDetails, ResendOrCancelPaymentCreation, LinkStatus, ResendOrCancelPaymentDetails, PaymentStatusBulkHandlerCreation, PaymentObjectList, PaymentStatusObject, PaymentStatusBulkHandlerDetails, GetOauthUrlDetails, RevokeOAuthToken, RepaymentRequestDetails, RepaymentDetailsSerialiserPayAll, RepaymentDetails, MerchantOnBoardingCreation, MerchantOnBoardingDetails, ValidateCustomerCreation, ValidateCustomerDetails, GetPaymentLinkDetails, ErrorDescription, ErrorDetails, CreatePaymentLinkMeta, CreatePaymentLinkCreation, CreatePaymentLinkDetails, PollingPaymentLinkDetails, CancelOrResendPaymentLinkCreation, ResendPaymentLinkDetails, CancelPaymentLinkDetails, Code, PaymentCode, GetPaymentCode, GetPaymentCodeDetails, PlatformPaymentModeDetails, MerchnatPaymentModeCreation, SkuDetails, AppliedOffer, OrderDetail, AddressDetail, ReasonDetail, PaymentSessionDetail, PaymentSessionCreation, PaymentSessionPutDetails, RefundSessionDetail, RefundSessionCreation, RefundSessionDetails, PaymentDetails, CartDetails, RefundDetails, PaymentSessionFetchDetails, RefundSourcesPriority, RefundPriorityDetails, RefundPriorityCreation, MerchantPaymentModeCreation, FromConfig, ToConfig, PlatformPaymentModeCopyConfigCreation, PaymentMethodsMetaOrder, PaymentOrderMethods, PaymentOrderCreation, PaymentOrderData, PaymentOrderDetails, AggregatorVersionItemSchema, AggregatorVersionDetails, AggregatorVersionRequestSchema, PatchAggregatorControl, PaymentModeCustomConfigSchema, PaymentCustomConfigDetailsSchema, PaymentCustomConfigCustomerSchema, PaymentCustomConfigModeSchema, PaymentCustomConfigDetailsRequestSchema, PaymentCustomConfigCustomerRequestSchema, PaymentCustomConfigRequestSchema, PaymentCustomConfigResponseSchema, CustomerValidationSchema, UserCreditSchema, CreditAccountSummary, ValidateCustomerCreditSchema };
|
|
1275
1297
|
}
|
|
1276
1298
|
/** @returns {PaymentGatewayConfigDetails} */
|
|
1277
1299
|
declare function PaymentGatewayConfigDetails(): PaymentGatewayConfigDetails;
|
|
@@ -3374,6 +3396,11 @@ type CreatePaymentLinkCreation = {
|
|
|
3374
3396
|
* redirected if the payment fails.
|
|
3375
3397
|
*/
|
|
3376
3398
|
failure_redirection_url?: string;
|
|
3399
|
+
/**
|
|
3400
|
+
* - Flag indicating whether to send
|
|
3401
|
+
* communications (e.g., SMS or email) for the payment link
|
|
3402
|
+
*/
|
|
3403
|
+
send_communication?: boolean;
|
|
3377
3404
|
};
|
|
3378
3405
|
/** @returns {CreatePaymentLinkDetails} */
|
|
3379
3406
|
declare function CreatePaymentLinkDetails(): CreatePaymentLinkDetails;
|
|
@@ -3566,6 +3593,57 @@ type MerchnatPaymentModeCreation = {
|
|
|
3566
3593
|
*/
|
|
3567
3594
|
online?: any;
|
|
3568
3595
|
};
|
|
3596
|
+
/** @returns {SkuDetails} */
|
|
3597
|
+
declare function SkuDetails(): SkuDetails;
|
|
3598
|
+
type SkuDetails = {
|
|
3599
|
+
/**
|
|
3600
|
+
* - SKU identifier of the offer
|
|
3601
|
+
*/
|
|
3602
|
+
identifier?: string;
|
|
3603
|
+
/**
|
|
3604
|
+
* - Unique SKU identifier (example: GTIN, variant ID)
|
|
3605
|
+
*/
|
|
3606
|
+
sku_id?: string;
|
|
3607
|
+
/**
|
|
3608
|
+
* - Display name of the SKU
|
|
3609
|
+
*/
|
|
3610
|
+
sku_name?: string;
|
|
3611
|
+
};
|
|
3612
|
+
/** @returns {AppliedOffer} */
|
|
3613
|
+
declare function AppliedOffer(): AppliedOffer;
|
|
3614
|
+
type AppliedOffer = {
|
|
3615
|
+
/**
|
|
3616
|
+
* - Whether the offer is a mop or not. MOP is a
|
|
3617
|
+
* discount that is applied on the total order value.
|
|
3618
|
+
*/
|
|
3619
|
+
is_mop?: boolean;
|
|
3620
|
+
/**
|
|
3621
|
+
* - Type of offer. It can be either a bank or
|
|
3622
|
+
* brand offer.
|
|
3623
|
+
*/
|
|
3624
|
+
offer_type?: string;
|
|
3625
|
+
/**
|
|
3626
|
+
* - Unique identifier for the offer.
|
|
3627
|
+
*/
|
|
3628
|
+
offer_id?: string;
|
|
3629
|
+
/**
|
|
3630
|
+
* - Description of the offer.
|
|
3631
|
+
*/
|
|
3632
|
+
description?: string;
|
|
3633
|
+
/**
|
|
3634
|
+
* - Amount of the offer in paise. (Example: ₹1 = 100 paise)
|
|
3635
|
+
*/
|
|
3636
|
+
amount?: number;
|
|
3637
|
+
/**
|
|
3638
|
+
* - Extra meta data specific to extension
|
|
3639
|
+
*/
|
|
3640
|
+
meta?: any;
|
|
3641
|
+
/**
|
|
3642
|
+
* - List of sku details for which the
|
|
3643
|
+
* offer is applicable. This is applicable only for brand offers.
|
|
3644
|
+
*/
|
|
3645
|
+
sku_details?: SkuDetails[];
|
|
3646
|
+
};
|
|
3569
3647
|
/** @returns {OrderDetail} */
|
|
3570
3648
|
declare function OrderDetail(): OrderDetail;
|
|
3571
3649
|
type OrderDetail = {
|
|
@@ -3596,6 +3674,10 @@ type OrderDetail = {
|
|
|
3596
3674
|
* - Name of the payment gateway aggregator.
|
|
3597
3675
|
*/
|
|
3598
3676
|
aggregator: string;
|
|
3677
|
+
/**
|
|
3678
|
+
* - List of offers applied on the order.
|
|
3679
|
+
*/
|
|
3680
|
+
applied_offers?: AppliedOffer[];
|
|
3599
3681
|
};
|
|
3600
3682
|
/** @returns {AddressDetail} */
|
|
3601
3683
|
declare function AddressDetail(): AddressDetail;
|
|
@@ -891,6 +891,8 @@ const Joi = require("joi");
|
|
|
891
891
|
* redirected after a successful payment.
|
|
892
892
|
* @property {string} [failure_redirection_url] - URL to which the user will be
|
|
893
893
|
* redirected if the payment fails.
|
|
894
|
+
* @property {boolean} [send_communication] - Flag indicating whether to send
|
|
895
|
+
* communications (e.g., SMS or email) for the payment link
|
|
894
896
|
*/
|
|
895
897
|
|
|
896
898
|
/**
|
|
@@ -976,6 +978,27 @@ const Joi = require("joi");
|
|
|
976
978
|
* @property {Object} [online] - Details to be updated for offline payment configuration.
|
|
977
979
|
*/
|
|
978
980
|
|
|
981
|
+
/**
|
|
982
|
+
* @typedef SkuDetails
|
|
983
|
+
* @property {string} [identifier] - SKU identifier of the offer
|
|
984
|
+
* @property {string} [sku_id] - Unique SKU identifier (example: GTIN, variant ID)
|
|
985
|
+
* @property {string} [sku_name] - Display name of the SKU
|
|
986
|
+
*/
|
|
987
|
+
|
|
988
|
+
/**
|
|
989
|
+
* @typedef AppliedOffer
|
|
990
|
+
* @property {boolean} [is_mop] - Whether the offer is a mop or not. MOP is a
|
|
991
|
+
* discount that is applied on the total order value.
|
|
992
|
+
* @property {string} [offer_type] - Type of offer. It can be either a bank or
|
|
993
|
+
* brand offer.
|
|
994
|
+
* @property {string} [offer_id] - Unique identifier for the offer.
|
|
995
|
+
* @property {string} [description] - Description of the offer.
|
|
996
|
+
* @property {number} [amount] - Amount of the offer in paise. (Example: ₹1 = 100 paise)
|
|
997
|
+
* @property {Object} [meta] - Extra meta data specific to extension
|
|
998
|
+
* @property {SkuDetails[]} [sku_details] - List of sku details for which the
|
|
999
|
+
* offer is applicable. This is applicable only for brand offers.
|
|
1000
|
+
*/
|
|
1001
|
+
|
|
979
1002
|
/**
|
|
980
1003
|
* @typedef OrderDetail
|
|
981
1004
|
* @property {string} gid - Global identifier of the entity (e.g. order, cart
|
|
@@ -987,6 +1010,7 @@ const Joi = require("joi");
|
|
|
987
1010
|
* @property {Object} aggregator_order_details - Aggregator order details
|
|
988
1011
|
* generated by the payment gateway.
|
|
989
1012
|
* @property {string} aggregator - Name of the payment gateway aggregator.
|
|
1013
|
+
* @property {AppliedOffer[]} [applied_offers] - List of offers applied on the order.
|
|
990
1014
|
*/
|
|
991
1015
|
|
|
992
1016
|
/**
|
|
@@ -2509,6 +2533,7 @@ class PaymentPlatformModel {
|
|
|
2509
2533
|
external_order_id: Joi.string().allow("").required(),
|
|
2510
2534
|
success_redirection_url: Joi.string().allow(""),
|
|
2511
2535
|
failure_redirection_url: Joi.string().allow(""),
|
|
2536
|
+
send_communication: Joi.boolean(),
|
|
2512
2537
|
});
|
|
2513
2538
|
}
|
|
2514
2539
|
|
|
@@ -2617,6 +2642,28 @@ class PaymentPlatformModel {
|
|
|
2617
2642
|
});
|
|
2618
2643
|
}
|
|
2619
2644
|
|
|
2645
|
+
/** @returns {SkuDetails} */
|
|
2646
|
+
static SkuDetails() {
|
|
2647
|
+
return Joi.object({
|
|
2648
|
+
identifier: Joi.string().allow(""),
|
|
2649
|
+
sku_id: Joi.string().allow(""),
|
|
2650
|
+
sku_name: Joi.string().allow(""),
|
|
2651
|
+
});
|
|
2652
|
+
}
|
|
2653
|
+
|
|
2654
|
+
/** @returns {AppliedOffer} */
|
|
2655
|
+
static AppliedOffer() {
|
|
2656
|
+
return Joi.object({
|
|
2657
|
+
is_mop: Joi.boolean(),
|
|
2658
|
+
offer_type: Joi.string().allow(""),
|
|
2659
|
+
offer_id: Joi.string().allow(""),
|
|
2660
|
+
description: Joi.string().allow(""),
|
|
2661
|
+
amount: Joi.number(),
|
|
2662
|
+
meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
2663
|
+
sku_details: Joi.array().items(PaymentPlatformModel.SkuDetails()),
|
|
2664
|
+
});
|
|
2665
|
+
}
|
|
2666
|
+
|
|
2620
2667
|
/** @returns {OrderDetail} */
|
|
2621
2668
|
static OrderDetail() {
|
|
2622
2669
|
return Joi.object({
|
|
@@ -2628,6 +2675,7 @@ class PaymentPlatformModel {
|
|
|
2628
2675
|
.pattern(/\S/, Joi.any())
|
|
2629
2676
|
.required(),
|
|
2630
2677
|
aggregator: Joi.string().allow("").required(),
|
|
2678
|
+
applied_offers: Joi.array().items(PaymentPlatformModel.AppliedOffer()),
|
|
2631
2679
|
});
|
|
2632
2680
|
}
|
|
2633
2681
|
|
|
@@ -776,6 +776,11 @@ export = ServiceabilityPlatformModel;
|
|
|
776
776
|
* @property {string} [scheme_id] - Unique identifier for the scheme, used to
|
|
777
777
|
* fetch or modify scheme details.
|
|
778
778
|
* @property {string} name - Name of the scheme.
|
|
779
|
+
* @property {string} [default_forward_pickup_cutoff] - Default cutoff time for
|
|
780
|
+
* forward pickup (nullable).
|
|
781
|
+
* @property {string} [default_reverse_pickup_cutoff] - Default cutoff time for
|
|
782
|
+
* reverse pickup (nullable).
|
|
783
|
+
* @property {CourierPartnerSchemeDefaultTat} [default_tat]
|
|
779
784
|
* @property {ArithmeticOperations} weight
|
|
780
785
|
* @property {ArithmeticOperations} [volumetric_weight]
|
|
781
786
|
* @property {string} transport_type - Mode of transport associated with the
|
|
@@ -1281,6 +1286,7 @@ export = ServiceabilityPlatformModel;
|
|
|
1281
1286
|
* @property {ArithmeticOperations} [shipment_weight]
|
|
1282
1287
|
* @property {ArithmeticOperations} [shipment_cost]
|
|
1283
1288
|
* @property {ArithmeticOperations} [shipment_volumetric_weight]
|
|
1289
|
+
* @property {StringComparisonOperations} [store_customer_location]
|
|
1284
1290
|
*/
|
|
1285
1291
|
/**
|
|
1286
1292
|
* @typedef LocationRule
|
|
@@ -1332,6 +1338,18 @@ export = ServiceabilityPlatformModel;
|
|
|
1332
1338
|
* @property {string} [stage] - Represents the current stage of the courier
|
|
1333
1339
|
* partner account (e.g., active, inactive, etc.).
|
|
1334
1340
|
*/
|
|
1341
|
+
/**
|
|
1342
|
+
* @typedef CourierPartnerSchemeDefaultTat
|
|
1343
|
+
* @property {boolean} [enabled] - Indicates whether the default turn around
|
|
1344
|
+
* time (tat) to be used for the given scheme or not.
|
|
1345
|
+
* @property {CourierPartnerSchemeTat} [tat]
|
|
1346
|
+
*/
|
|
1347
|
+
/**
|
|
1348
|
+
* @typedef CourierPartnerSchemeTat
|
|
1349
|
+
* @property {number} [min] - Minimum turn around time (tat) value for a scheme.
|
|
1350
|
+
* @property {number} [max] - Maximum turn around time (tat) value for a scheme.
|
|
1351
|
+
* @property {string} [unit] - Unit for the turn around time (tat) values for a scheme.
|
|
1352
|
+
*/
|
|
1335
1353
|
/**
|
|
1336
1354
|
* @typedef CourierPartnerSchemeFeatures
|
|
1337
1355
|
* @property {boolean} [doorstep_qc] - Indicates if the courier partner offers
|
|
@@ -2018,7 +2036,7 @@ export = ServiceabilityPlatformModel;
|
|
|
2018
2036
|
declare class ServiceabilityPlatformModel {
|
|
2019
2037
|
}
|
|
2020
2038
|
declare namespace ServiceabilityPlatformModel {
|
|
2021
|
-
export { SelfshipSchema, ServiceabilityErrorResult, UpdateZoneData, ZoneUpdateSuccessResult, ServiceabilityDeleteErrorResult, ZoneDeleteSuccessResult, ListViewSchema, GetZoneByIdSchema, CommonErrorResult, CreateZoneDataSchema, ZoneBulkExport, GetZoneBulkExport, CreateBulkZoneData, ZoneSchema, CreateBulkZoneResult, BulkCreateZoneExport, PincodeMopData, PincodeMOPResult, PincodeMopUpdateAuditError, PincodeMopBulkError, CommonError, PincodeMopBulkData, PincodeBulkViewResult, PincodeCodStatusListingDetails, PincodeCodStatusListingResult, PincodeMopUpdateAuditHistoryDetails, PincodeMopUpdateAuditHistoryResultData, BulkGeoAreaDetails, BulkGeoAreaResult, BulkGeoAreaGetResult, GeoAreaBulkCreationResult, GeoAreaBulkExportResult, GeoAreaRequestBody, GeoAreaErrorResult, GeoAreaResponseBody, GeoAreaPutResponseBody, GeoAreaGetResponseBody, GeoAreaDetails, Error, CourierAccountDetailsBody, CourierPartnerRuleResult, CourierPartnerRule, BulkFailureResult, FailureResult, CourierPartnerRulesListResult, ShipmentCourierPartnerDetails, ShipmentCourierPartnerResult, CompanyConfig, ApplicationConfigPatch, ApplicationConfigPatchResult, BulkRegionJobDetails, BulkRegionResultItemData, BulkRegionResult, StoreRuleConfigData, StoreRuleDataSchema, GetStoreRulesApiResult, CreateStoreRuleDetailsSchema, StoreRuleResultSchema, StoreRuleUpdateResultSchema, CourierAccountResult, CompanyCourierPartnerAccountListResult, PackageMaterial, PackageMaterialNotFound, PackageMaterialsErrorResult, PackageMaterialResult, PackageRule, PackageRuleResult, PackagesListResult, PackageItem, RulePriorityDetails, RulePriorityResult, OptimalLocationsResult, OptimlLocationsRequestSchema, ValidationError, StandardError, CourierPartnerSchemeDetailsModel, CourierPartnerSchemeModelSchema, CourierPartnerSchemeUpdateDetailsSchema, CourierPartnerSchemeList, BulkRegionServiceabilityTatDetails, BulkRegionServiceabilityTatResultItemData, BulkRegionServiceabilityTatResult, GetCountries, GetLocalities, GetCountry, BulkImportLocalitiesDetails, BulkImportLocalitiesResult, BulkErrorResult, LocalitiesBulkExport, LocalitiesBulkExportFetch, LocalitiesErrorResult, GetLocality, ValidateAddress, ErrorResult, ApplicationConfigPut, ApplicationConfigPutDetail, ApplicationConfigGetResult, InstallCourierPartnerResponseSchema, GetLocalitiesBulkHistory, CompanyConfigurationSchema, ProductSchema, StoresSchema, CreatedBy, ModifiedBy, ListViewItems, GeoArea, ListViewProduct, Summary, RegionSchema, Page, ZoneStores, ZoneProduct, ZoneBulkItem, PincodeMopUpdateResult, PincodeCodStatusItem, PincodeCodStatusListingSummary, PincodeMopUpdateAuditHistoryPaging, PincodeMopUpdateAuditHistoryResult, Area, GeoAreaResponseDetail, GeoAreaItemResult, AreaExpanded, Country, Region, Page2, CourierPartnerRuleConditions, LocationRule, LocationRuleValues, StringComparisonOperations, IntComparisonOperations, ArithmeticOperations, CourierPartnerRuleCPListResult, CourierPartnerSchemeFeatures, CourierPartnerList, ShipmentsCourierPartnersServiceability, CPShipments, ShipmentDimension, ShipmentsArticles, ArticleWeight, ArticleAttributes, ArticleDimension, ArticleSet, ArticleSizeDistribution, SetSize, ArticleDeliverySlots, ArticleReturnReason, CourierPartners, CourierPartnerPromise, CourierPartnerAttributes, CourierPartnerTAT, ShipmentCourierPartners, CourierPartnerConfig, BuyboxRuleConfig, PromiseConfig, StorePromiseAttributeConfig, DeliveryServiceAttributeConfig, BufferField, StorePrioritySchema, StoreRuleConditionSchema, CustomerRadiusSchema, DateOperations, CourierPartnerSchemeModel, PackageMaterialRule, PackageMaterialRuleQuantity, Channel, PackageRuleCategory, PackageRuleProduct, PackageRuleProductTag, PackageRuleDepartmentId, PackageRuleProductAttributes, PackageChannel, StoreFilter, PackageRuleSchema, Quantity, PackagePageInfo, OptimalLocationAssignedStoresResult, OptimalLocationArticlesResult, ArticleAssignment, LocationDetailsServiceability, ServiceabilityLocation, OptimalLocationsArticles, GetCountriesItems, HierarchyItems, CurrencyObject, Localities, PincodeLatLongData, LocalityParent, CountryMetaFields, ApplicationFields, GetCountryFieldsAddress, FieldValidation, FieldValidationRegex, LengthValidation, GetCountryFieldsAddressValues, GetOneOrAll, GetOneOrAllParams, GetOneOrAllPath, GetOneOrAllQuery, GetCountryFieldsAddressTemplateApplication, CountryHierarchy, GetCountryFields, GetCountryFieldsAddressTemplate, LocalityParents, ZoneConfig, PromiseType, InstallCourierPartnerItemsSchema, HistoryObject };
|
|
2039
|
+
export { SelfshipSchema, ServiceabilityErrorResult, UpdateZoneData, ZoneUpdateSuccessResult, ServiceabilityDeleteErrorResult, ZoneDeleteSuccessResult, ListViewSchema, GetZoneByIdSchema, CommonErrorResult, CreateZoneDataSchema, ZoneBulkExport, GetZoneBulkExport, CreateBulkZoneData, ZoneSchema, CreateBulkZoneResult, BulkCreateZoneExport, PincodeMopData, PincodeMOPResult, PincodeMopUpdateAuditError, PincodeMopBulkError, CommonError, PincodeMopBulkData, PincodeBulkViewResult, PincodeCodStatusListingDetails, PincodeCodStatusListingResult, PincodeMopUpdateAuditHistoryDetails, PincodeMopUpdateAuditHistoryResultData, BulkGeoAreaDetails, BulkGeoAreaResult, BulkGeoAreaGetResult, GeoAreaBulkCreationResult, GeoAreaBulkExportResult, GeoAreaRequestBody, GeoAreaErrorResult, GeoAreaResponseBody, GeoAreaPutResponseBody, GeoAreaGetResponseBody, GeoAreaDetails, Error, CourierAccountDetailsBody, CourierPartnerRuleResult, CourierPartnerRule, BulkFailureResult, FailureResult, CourierPartnerRulesListResult, ShipmentCourierPartnerDetails, ShipmentCourierPartnerResult, CompanyConfig, ApplicationConfigPatch, ApplicationConfigPatchResult, BulkRegionJobDetails, BulkRegionResultItemData, BulkRegionResult, StoreRuleConfigData, StoreRuleDataSchema, GetStoreRulesApiResult, CreateStoreRuleDetailsSchema, StoreRuleResultSchema, StoreRuleUpdateResultSchema, CourierAccountResult, CompanyCourierPartnerAccountListResult, PackageMaterial, PackageMaterialNotFound, PackageMaterialsErrorResult, PackageMaterialResult, PackageRule, PackageRuleResult, PackagesListResult, PackageItem, RulePriorityDetails, RulePriorityResult, OptimalLocationsResult, OptimlLocationsRequestSchema, ValidationError, StandardError, CourierPartnerSchemeDetailsModel, CourierPartnerSchemeModelSchema, CourierPartnerSchemeUpdateDetailsSchema, CourierPartnerSchemeList, BulkRegionServiceabilityTatDetails, BulkRegionServiceabilityTatResultItemData, BulkRegionServiceabilityTatResult, GetCountries, GetLocalities, GetCountry, BulkImportLocalitiesDetails, BulkImportLocalitiesResult, BulkErrorResult, LocalitiesBulkExport, LocalitiesBulkExportFetch, LocalitiesErrorResult, GetLocality, ValidateAddress, ErrorResult, ApplicationConfigPut, ApplicationConfigPutDetail, ApplicationConfigGetResult, InstallCourierPartnerResponseSchema, GetLocalitiesBulkHistory, CompanyConfigurationSchema, ProductSchema, StoresSchema, CreatedBy, ModifiedBy, ListViewItems, GeoArea, ListViewProduct, Summary, RegionSchema, Page, ZoneStores, ZoneProduct, ZoneBulkItem, PincodeMopUpdateResult, PincodeCodStatusItem, PincodeCodStatusListingSummary, PincodeMopUpdateAuditHistoryPaging, PincodeMopUpdateAuditHistoryResult, Area, GeoAreaResponseDetail, GeoAreaItemResult, AreaExpanded, Country, Region, Page2, CourierPartnerRuleConditions, LocationRule, LocationRuleValues, StringComparisonOperations, IntComparisonOperations, ArithmeticOperations, CourierPartnerRuleCPListResult, CourierPartnerSchemeDefaultTat, CourierPartnerSchemeTat, CourierPartnerSchemeFeatures, CourierPartnerList, ShipmentsCourierPartnersServiceability, CPShipments, ShipmentDimension, ShipmentsArticles, ArticleWeight, ArticleAttributes, ArticleDimension, ArticleSet, ArticleSizeDistribution, SetSize, ArticleDeliverySlots, ArticleReturnReason, CourierPartners, CourierPartnerPromise, CourierPartnerAttributes, CourierPartnerTAT, ShipmentCourierPartners, CourierPartnerConfig, BuyboxRuleConfig, PromiseConfig, StorePromiseAttributeConfig, DeliveryServiceAttributeConfig, BufferField, StorePrioritySchema, StoreRuleConditionSchema, CustomerRadiusSchema, DateOperations, CourierPartnerSchemeModel, PackageMaterialRule, PackageMaterialRuleQuantity, Channel, PackageRuleCategory, PackageRuleProduct, PackageRuleProductTag, PackageRuleDepartmentId, PackageRuleProductAttributes, PackageChannel, StoreFilter, PackageRuleSchema, Quantity, PackagePageInfo, OptimalLocationAssignedStoresResult, OptimalLocationArticlesResult, ArticleAssignment, LocationDetailsServiceability, ServiceabilityLocation, OptimalLocationsArticles, GetCountriesItems, HierarchyItems, CurrencyObject, Localities, PincodeLatLongData, LocalityParent, CountryMetaFields, ApplicationFields, GetCountryFieldsAddress, FieldValidation, FieldValidationRegex, LengthValidation, GetCountryFieldsAddressValues, GetOneOrAll, GetOneOrAllParams, GetOneOrAllPath, GetOneOrAllQuery, GetCountryFieldsAddressTemplateApplication, CountryHierarchy, GetCountryFields, GetCountryFieldsAddressTemplate, LocalityParents, ZoneConfig, PromiseType, InstallCourierPartnerItemsSchema, HistoryObject };
|
|
2022
2040
|
}
|
|
2023
2041
|
/** @returns {SelfshipSchema} */
|
|
2024
2042
|
declare function SelfshipSchema(): SelfshipSchema;
|
|
@@ -3992,6 +4010,17 @@ type CourierPartnerSchemeDetailsModel = {
|
|
|
3992
4010
|
* - Name of the scheme.
|
|
3993
4011
|
*/
|
|
3994
4012
|
name: string;
|
|
4013
|
+
/**
|
|
4014
|
+
* - Default cutoff time for
|
|
4015
|
+
* forward pickup (nullable).
|
|
4016
|
+
*/
|
|
4017
|
+
default_forward_pickup_cutoff?: string;
|
|
4018
|
+
/**
|
|
4019
|
+
* - Default cutoff time for
|
|
4020
|
+
* reverse pickup (nullable).
|
|
4021
|
+
*/
|
|
4022
|
+
default_reverse_pickup_cutoff?: string;
|
|
4023
|
+
default_tat?: CourierPartnerSchemeDefaultTat;
|
|
3995
4024
|
weight: ArithmeticOperations;
|
|
3996
4025
|
volumetric_weight?: ArithmeticOperations;
|
|
3997
4026
|
/**
|
|
@@ -5195,6 +5224,7 @@ type CourierPartnerRuleConditions = {
|
|
|
5195
5224
|
shipment_weight?: ArithmeticOperations;
|
|
5196
5225
|
shipment_cost?: ArithmeticOperations;
|
|
5197
5226
|
shipment_volumetric_weight?: ArithmeticOperations;
|
|
5227
|
+
store_customer_location?: StringComparisonOperations;
|
|
5198
5228
|
};
|
|
5199
5229
|
/** @returns {LocationRule} */
|
|
5200
5230
|
declare function LocationRule(): LocationRule;
|
|
@@ -5309,6 +5339,32 @@ type CourierPartnerRuleCPListResult = {
|
|
|
5309
5339
|
*/
|
|
5310
5340
|
stage?: string;
|
|
5311
5341
|
};
|
|
5342
|
+
/** @returns {CourierPartnerSchemeDefaultTat} */
|
|
5343
|
+
declare function CourierPartnerSchemeDefaultTat(): CourierPartnerSchemeDefaultTat;
|
|
5344
|
+
type CourierPartnerSchemeDefaultTat = {
|
|
5345
|
+
/**
|
|
5346
|
+
* - Indicates whether the default turn around
|
|
5347
|
+
* time (tat) to be used for the given scheme or not.
|
|
5348
|
+
*/
|
|
5349
|
+
enabled?: boolean;
|
|
5350
|
+
tat?: CourierPartnerSchemeTat;
|
|
5351
|
+
};
|
|
5352
|
+
/** @returns {CourierPartnerSchemeTat} */
|
|
5353
|
+
declare function CourierPartnerSchemeTat(): CourierPartnerSchemeTat;
|
|
5354
|
+
type CourierPartnerSchemeTat = {
|
|
5355
|
+
/**
|
|
5356
|
+
* - Minimum turn around time (tat) value for a scheme.
|
|
5357
|
+
*/
|
|
5358
|
+
min?: number;
|
|
5359
|
+
/**
|
|
5360
|
+
* - Maximum turn around time (tat) value for a scheme.
|
|
5361
|
+
*/
|
|
5362
|
+
max?: number;
|
|
5363
|
+
/**
|
|
5364
|
+
* - Unit for the turn around time (tat) values for a scheme.
|
|
5365
|
+
*/
|
|
5366
|
+
unit?: string;
|
|
5367
|
+
};
|
|
5312
5368
|
/** @returns {CourierPartnerSchemeFeatures} */
|
|
5313
5369
|
declare function CourierPartnerSchemeFeatures(): CourierPartnerSchemeFeatures;
|
|
5314
5370
|
type CourierPartnerSchemeFeatures = {
|
|
@@ -852,6 +852,11 @@ const Joi = require("joi");
|
|
|
852
852
|
* @property {string} [scheme_id] - Unique identifier for the scheme, used to
|
|
853
853
|
* fetch or modify scheme details.
|
|
854
854
|
* @property {string} name - Name of the scheme.
|
|
855
|
+
* @property {string} [default_forward_pickup_cutoff] - Default cutoff time for
|
|
856
|
+
* forward pickup (nullable).
|
|
857
|
+
* @property {string} [default_reverse_pickup_cutoff] - Default cutoff time for
|
|
858
|
+
* reverse pickup (nullable).
|
|
859
|
+
* @property {CourierPartnerSchemeDefaultTat} [default_tat]
|
|
855
860
|
* @property {ArithmeticOperations} weight
|
|
856
861
|
* @property {ArithmeticOperations} [volumetric_weight]
|
|
857
862
|
* @property {string} transport_type - Mode of transport associated with the
|
|
@@ -1407,6 +1412,7 @@ const Joi = require("joi");
|
|
|
1407
1412
|
* @property {ArithmeticOperations} [shipment_weight]
|
|
1408
1413
|
* @property {ArithmeticOperations} [shipment_cost]
|
|
1409
1414
|
* @property {ArithmeticOperations} [shipment_volumetric_weight]
|
|
1415
|
+
* @property {StringComparisonOperations} [store_customer_location]
|
|
1410
1416
|
*/
|
|
1411
1417
|
|
|
1412
1418
|
/**
|
|
@@ -1465,6 +1471,20 @@ const Joi = require("joi");
|
|
|
1465
1471
|
* partner account (e.g., active, inactive, etc.).
|
|
1466
1472
|
*/
|
|
1467
1473
|
|
|
1474
|
+
/**
|
|
1475
|
+
* @typedef CourierPartnerSchemeDefaultTat
|
|
1476
|
+
* @property {boolean} [enabled] - Indicates whether the default turn around
|
|
1477
|
+
* time (tat) to be used for the given scheme or not.
|
|
1478
|
+
* @property {CourierPartnerSchemeTat} [tat]
|
|
1479
|
+
*/
|
|
1480
|
+
|
|
1481
|
+
/**
|
|
1482
|
+
* @typedef CourierPartnerSchemeTat
|
|
1483
|
+
* @property {number} [min] - Minimum turn around time (tat) value for a scheme.
|
|
1484
|
+
* @property {number} [max] - Maximum turn around time (tat) value for a scheme.
|
|
1485
|
+
* @property {string} [unit] - Unit for the turn around time (tat) values for a scheme.
|
|
1486
|
+
*/
|
|
1487
|
+
|
|
1468
1488
|
/**
|
|
1469
1489
|
* @typedef CourierPartnerSchemeFeatures
|
|
1470
1490
|
* @property {boolean} [doorstep_qc] - Indicates if the courier partner offers
|
|
@@ -3162,6 +3182,9 @@ class ServiceabilityPlatformModel {
|
|
|
3162
3182
|
extension_id: Joi.string().allow("").required(),
|
|
3163
3183
|
scheme_id: Joi.string().allow(""),
|
|
3164
3184
|
name: Joi.string().allow("").required(),
|
|
3185
|
+
default_forward_pickup_cutoff: Joi.string().allow("").allow(null),
|
|
3186
|
+
default_reverse_pickup_cutoff: Joi.string().allow("").allow(null),
|
|
3187
|
+
default_tat: ServiceabilityPlatformModel.CourierPartnerSchemeDefaultTat(),
|
|
3165
3188
|
weight: ServiceabilityPlatformModel.ArithmeticOperations().required(),
|
|
3166
3189
|
volumetric_weight: ServiceabilityPlatformModel.ArithmeticOperations(),
|
|
3167
3190
|
transport_type: Joi.string().allow("").required(),
|
|
@@ -3748,6 +3771,7 @@ class ServiceabilityPlatformModel {
|
|
|
3748
3771
|
shipment_weight: ServiceabilityPlatformModel.ArithmeticOperations(),
|
|
3749
3772
|
shipment_cost: ServiceabilityPlatformModel.ArithmeticOperations(),
|
|
3750
3773
|
shipment_volumetric_weight: ServiceabilityPlatformModel.ArithmeticOperations(),
|
|
3774
|
+
store_customer_location: ServiceabilityPlatformModel.StringComparisonOperations(),
|
|
3751
3775
|
});
|
|
3752
3776
|
}
|
|
3753
3777
|
|
|
@@ -3809,6 +3833,23 @@ class ServiceabilityPlatformModel {
|
|
|
3809
3833
|
});
|
|
3810
3834
|
}
|
|
3811
3835
|
|
|
3836
|
+
/** @returns {CourierPartnerSchemeDefaultTat} */
|
|
3837
|
+
static CourierPartnerSchemeDefaultTat() {
|
|
3838
|
+
return Joi.object({
|
|
3839
|
+
enabled: Joi.boolean(),
|
|
3840
|
+
tat: ServiceabilityPlatformModel.CourierPartnerSchemeTat(),
|
|
3841
|
+
});
|
|
3842
|
+
}
|
|
3843
|
+
|
|
3844
|
+
/** @returns {CourierPartnerSchemeTat} */
|
|
3845
|
+
static CourierPartnerSchemeTat() {
|
|
3846
|
+
return Joi.object({
|
|
3847
|
+
min: Joi.number(),
|
|
3848
|
+
max: Joi.number(),
|
|
3849
|
+
unit: Joi.string().allow(""),
|
|
3850
|
+
});
|
|
3851
|
+
}
|
|
3852
|
+
|
|
3812
3853
|
/** @returns {CourierPartnerSchemeFeatures} */
|
|
3813
3854
|
static CourierPartnerSchemeFeatures() {
|
|
3814
3855
|
return Joi.object({
|