@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
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
|
@@ -197,7 +197,7 @@ declare class Cart {
|
|
|
197
197
|
* @summary: List available promotion offers
|
|
198
198
|
* @description: List all promotional offers available for the items in the cart, including details such as offer text, unique promotion ID, and validity period. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/getPromotionOffers/).
|
|
199
199
|
*/
|
|
200
|
-
getPromotionOffers({ slug, pageSize, promotionGroup, storeId, cartType, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<PromotionOffersResult>;
|
|
200
|
+
getPromotionOffers({ slug, pageSize, promotionGroup, storeId, cartType, promotionType, cartId, autoApply, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<PromotionOffersResult>;
|
|
201
201
|
/**
|
|
202
202
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
203
203
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
@@ -830,9 +830,17 @@ class Cart {
|
|
|
830
830
|
* @description: List all promotional offers available for the items in the cart, including details such as offer text, unique promotion ID, and validity period. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/getPromotionOffers/).
|
|
831
831
|
*/
|
|
832
832
|
async getPromotionOffers(
|
|
833
|
-
{
|
|
834
|
-
|
|
835
|
-
|
|
833
|
+
{
|
|
834
|
+
slug,
|
|
835
|
+
pageSize,
|
|
836
|
+
promotionGroup,
|
|
837
|
+
storeId,
|
|
838
|
+
cartType,
|
|
839
|
+
promotionType,
|
|
840
|
+
cartId,
|
|
841
|
+
autoApply,
|
|
842
|
+
requestHeaders,
|
|
843
|
+
} = { requestHeaders: {} },
|
|
836
844
|
{ responseHeaders } = { responseHeaders: false }
|
|
837
845
|
) {
|
|
838
846
|
const query_params = {};
|
|
@@ -841,6 +849,9 @@ class Cart {
|
|
|
841
849
|
query_params["promotion_group"] = promotionGroup;
|
|
842
850
|
query_params["store_id"] = storeId;
|
|
843
851
|
query_params["cart_type"] = cartType;
|
|
852
|
+
query_params["promotion_type"] = promotionType;
|
|
853
|
+
query_params["cart_id"] = cartId;
|
|
854
|
+
query_params["auto_apply"] = autoApply;
|
|
844
855
|
|
|
845
856
|
const xHeaders = {};
|
|
846
857
|
|
|
@@ -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({
|
|
@@ -360,7 +360,7 @@ declare class Cart {
|
|
|
360
360
|
* @summary: List of all available promotion offers
|
|
361
361
|
* @description: Retrieve a list of all promotional offers available for the items in the cart, including details such as offer text, unique promotion ID, and validity period. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getPromotionOffers/).
|
|
362
362
|
*/
|
|
363
|
-
getPromotionOffers({ slug, pageSize, promotionGroup, storeId, cartType, requestHeaders }?: CartPlatformApplicationValidator.GetPromotionOffersParam, { responseHeaders }?: object): Promise<CartPlatformModel.PromotionOffersDetails>;
|
|
363
|
+
getPromotionOffers({ slug, pageSize, promotionGroup, storeId, cartType, promotionType, cartId, autoApply, requestHeaders, }?: CartPlatformApplicationValidator.GetPromotionOffersParam, { responseHeaders }?: object): Promise<CartPlatformModel.PromotionOffersDetails>;
|
|
364
364
|
/**
|
|
365
365
|
* @param {CartPlatformApplicationValidator.GetPromotionPaymentOffersParam} arg
|
|
366
366
|
* - Arg object
|
|
@@ -2861,9 +2861,17 @@ class Cart {
|
|
|
2861
2861
|
* @description: Retrieve a list of all promotional offers available for the items in the cart, including details such as offer text, unique promotion ID, and validity period. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getPromotionOffers/).
|
|
2862
2862
|
*/
|
|
2863
2863
|
async getPromotionOffers(
|
|
2864
|
-
{
|
|
2865
|
-
|
|
2866
|
-
|
|
2864
|
+
{
|
|
2865
|
+
slug,
|
|
2866
|
+
pageSize,
|
|
2867
|
+
promotionGroup,
|
|
2868
|
+
storeId,
|
|
2869
|
+
cartType,
|
|
2870
|
+
promotionType,
|
|
2871
|
+
cartId,
|
|
2872
|
+
autoApply,
|
|
2873
|
+
requestHeaders,
|
|
2874
|
+
} = { requestHeaders: {} },
|
|
2867
2875
|
{ responseHeaders } = { responseHeaders: false }
|
|
2868
2876
|
) {
|
|
2869
2877
|
const {
|
|
@@ -2875,6 +2883,9 @@ class Cart {
|
|
|
2875
2883
|
promotionGroup,
|
|
2876
2884
|
storeId,
|
|
2877
2885
|
cartType,
|
|
2886
|
+
promotionType,
|
|
2887
|
+
cartId,
|
|
2888
|
+
autoApply,
|
|
2878
2889
|
},
|
|
2879
2890
|
{ abortEarly: false, allowUnknown: true }
|
|
2880
2891
|
);
|
|
@@ -2892,6 +2903,9 @@ class Cart {
|
|
|
2892
2903
|
promotionGroup,
|
|
2893
2904
|
storeId,
|
|
2894
2905
|
cartType,
|
|
2906
|
+
promotionType,
|
|
2907
|
+
cartId,
|
|
2908
|
+
autoApply,
|
|
2895
2909
|
},
|
|
2896
2910
|
{ abortEarly: false, allowUnknown: false }
|
|
2897
2911
|
);
|
|
@@ -2908,6 +2922,9 @@ class Cart {
|
|
|
2908
2922
|
query_params["promotion_group"] = promotionGroup;
|
|
2909
2923
|
query_params["store_id"] = storeId;
|
|
2910
2924
|
query_params["cart_type"] = cartType;
|
|
2925
|
+
query_params["promotion_type"] = promotionType;
|
|
2926
|
+
query_params["cart_id"] = cartId;
|
|
2927
|
+
query_params["auto_apply"] = autoApply;
|
|
2911
2928
|
|
|
2912
2929
|
const response = await PlatformAPIClient.execute(
|
|
2913
2930
|
this.config,
|
|
@@ -207,6 +207,10 @@ export = CartPlatformApplicationValidator;
|
|
|
207
207
|
* @property {string} [promotionGroup] - Type of promotion groups
|
|
208
208
|
* @property {number} [storeId] - Unique identifier of a store
|
|
209
209
|
* @property {string} [cartType] - The type of cart
|
|
210
|
+
* @property {string} [promotionType] - Type of promotion to be fetched
|
|
211
|
+
* @property {string} [cartId] - The unique identifier of the user cart.
|
|
212
|
+
* @property {boolean} [autoApply] - Indicates whether to filter promotions
|
|
213
|
+
* based on their auto_apply status.
|
|
210
214
|
*/
|
|
211
215
|
/**
|
|
212
216
|
* @typedef GetPromotionPaymentOffersParam
|
|
@@ -809,6 +813,19 @@ type GetPromotionOffersParam = {
|
|
|
809
813
|
* - The type of cart
|
|
810
814
|
*/
|
|
811
815
|
cartType?: string;
|
|
816
|
+
/**
|
|
817
|
+
* - Type of promotion to be fetched
|
|
818
|
+
*/
|
|
819
|
+
promotionType?: string;
|
|
820
|
+
/**
|
|
821
|
+
* - The unique identifier of the user cart.
|
|
822
|
+
*/
|
|
823
|
+
cartId?: string;
|
|
824
|
+
/**
|
|
825
|
+
* - Indicates whether to filter promotions
|
|
826
|
+
* based on their auto_apply status.
|
|
827
|
+
*/
|
|
828
|
+
autoApply?: boolean;
|
|
812
829
|
};
|
|
813
830
|
type GetPromotionPaymentOffersParam = {
|
|
814
831
|
/**
|
|
@@ -243,6 +243,10 @@ const CartPlatformModel = require("./CartPlatformModel");
|
|
|
243
243
|
* @property {string} [promotionGroup] - Type of promotion groups
|
|
244
244
|
* @property {number} [storeId] - Unique identifier of a store
|
|
245
245
|
* @property {string} [cartType] - The type of cart
|
|
246
|
+
* @property {string} [promotionType] - Type of promotion to be fetched
|
|
247
|
+
* @property {string} [cartId] - The unique identifier of the user cart.
|
|
248
|
+
* @property {boolean} [autoApply] - Indicates whether to filter promotions
|
|
249
|
+
* based on their auto_apply status.
|
|
246
250
|
*/
|
|
247
251
|
|
|
248
252
|
/**
|
|
@@ -800,6 +804,9 @@ class CartPlatformApplicationValidator {
|
|
|
800
804
|
promotionGroup: Joi.string().allow(""),
|
|
801
805
|
storeId: Joi.number(),
|
|
802
806
|
cartType: Joi.string().allow(""),
|
|
807
|
+
promotionType: Joi.string().allow(""),
|
|
808
|
+
cartId: Joi.string().allow(""),
|
|
809
|
+
autoApply: Joi.boolean(),
|
|
803
810
|
}).required();
|
|
804
811
|
}
|
|
805
812
|
|
|
@@ -462,6 +462,8 @@ export = CartPlatformModel;
|
|
|
462
462
|
* @property {PromotionDateMeta} [date_meta]
|
|
463
463
|
* @property {string} [_id] - Unique identifier of promotion
|
|
464
464
|
* @property {string[]} [tags] - List of tags on which promotion is applicable
|
|
465
|
+
* @property {boolean} [auto_apply] - Boolean value to determine if the
|
|
466
|
+
* promotion should be applied automatically or not
|
|
465
467
|
*/
|
|
466
468
|
/**
|
|
467
469
|
* @typedef PromotionsResult
|
|
@@ -497,6 +499,8 @@ export = CartPlatformModel;
|
|
|
497
499
|
* @property {Object} [_custom_json] - Set extra properties in promotion
|
|
498
500
|
* @property {PromotionDateMeta} [date_meta]
|
|
499
501
|
* @property {string[]} [tags] - List of tags applicable for promotion
|
|
502
|
+
* @property {boolean} [auto_apply] - Boolean value to determine if the
|
|
503
|
+
* promotion should be applied automatically or not
|
|
500
504
|
*/
|
|
501
505
|
/**
|
|
502
506
|
* @typedef PromotionAddResult
|
|
@@ -529,6 +533,8 @@ export = CartPlatformModel;
|
|
|
529
533
|
* @property {Object} [_custom_json] - Set extra properties in promotion
|
|
530
534
|
* @property {PromotionDateMeta} [date_meta]
|
|
531
535
|
* @property {string[]} [tags] - List of tags applicable for promotion
|
|
536
|
+
* @property {boolean} [auto_apply] - Boolean value to determine if the
|
|
537
|
+
* promotion should be applied automatically or not
|
|
532
538
|
*/
|
|
533
539
|
/**
|
|
534
540
|
* @typedef PromotionUpdate
|
|
@@ -561,6 +567,8 @@ export = CartPlatformModel;
|
|
|
561
567
|
* @property {Object} [_custom_json] - Set extra properties in promotion
|
|
562
568
|
* @property {PromotionDateMeta} [date_meta]
|
|
563
569
|
* @property {string[]} [tags] - List of tags applicable for promotion
|
|
570
|
+
* @property {boolean} [auto_apply] - Boolean value to determine if the
|
|
571
|
+
* promotion should be applied automatically or not
|
|
564
572
|
*/
|
|
565
573
|
/**
|
|
566
574
|
* @typedef PromotionUpdateResult
|
|
@@ -595,6 +603,8 @@ export = CartPlatformModel;
|
|
|
595
603
|
* @property {Object} [_custom_json] - Set extra properties in promotion
|
|
596
604
|
* @property {PromotionDateMeta} [date_meta]
|
|
597
605
|
* @property {string[]} [tags] - List of tags applicable for promotion
|
|
606
|
+
* @property {boolean} [auto_apply] - Boolean value to determine if the
|
|
607
|
+
* promotion should be applied automatically or not
|
|
598
608
|
*/
|
|
599
609
|
/**
|
|
600
610
|
* @typedef PromotionPartialUpdate
|
|
@@ -952,6 +962,8 @@ export = CartPlatformModel;
|
|
|
952
962
|
* message for the gift
|
|
953
963
|
* @property {string[]} [product_group_tags] - List fot the unique identifier
|
|
954
964
|
* for the product grouping.
|
|
965
|
+
* @property {boolean} [force_new_line_item] - Flag to indicate the item as a
|
|
966
|
+
* seperate article in cart
|
|
955
967
|
* @property {Object} [identifier] - Unique identifier of the article
|
|
956
968
|
* @property {number} [mto_quantity] - Quantity of the product which will
|
|
957
969
|
* specially manufactured as not available in stock
|
|
@@ -1409,6 +1421,8 @@ export = CartPlatformModel;
|
|
|
1409
1421
|
* @property {string} [pan_no] - Permanent Account Number of the user
|
|
1410
1422
|
* @property {Object} [custom_cart_meta] - Custom meta details added cart
|
|
1411
1423
|
* checkout API payload
|
|
1424
|
+
* @property {boolean} [free_gift_selection_available] - Determines if the cart
|
|
1425
|
+
* has available promotion free gift items to choose on its added items
|
|
1412
1426
|
*/
|
|
1413
1427
|
/**
|
|
1414
1428
|
* @typedef AddProductCart
|
|
@@ -1432,6 +1446,8 @@ export = CartPlatformModel;
|
|
|
1432
1446
|
* level while add items to cart
|
|
1433
1447
|
* @property {Object} [_custom_json] - Field to add custom json at article level
|
|
1434
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
|
|
1435
1451
|
* @property {Object} [meta] - Field to add meta data at article level
|
|
1436
1452
|
* @property {boolean} [pos] - Filed to determine whether user is making request
|
|
1437
1453
|
* from pos or not
|
|
@@ -1475,6 +1491,8 @@ export = CartPlatformModel;
|
|
|
1475
1491
|
* @property {Object} [meta] - Field to update meta of the item in cart
|
|
1476
1492
|
* @property {Object} [extra_meta] - Field to update extra meta of the product in cart
|
|
1477
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
|
|
1478
1496
|
* @property {number} [item_id] - Item id of the product that needs to be updated
|
|
1479
1497
|
* @property {number} [item_index] - Item index determines on which index the
|
|
1480
1498
|
* product falls to be updated
|
|
@@ -1702,6 +1720,8 @@ export = CartPlatformModel;
|
|
|
1702
1720
|
* items with updated sizes.
|
|
1703
1721
|
* @property {string} operation - Field to determine if item to be removed from
|
|
1704
1722
|
* cart or it needs to be updated
|
|
1723
|
+
* @property {string} [free_gift_items_operation] - Field to determine if free
|
|
1724
|
+
* gift item to be removed from cart or it needs to be added.
|
|
1705
1725
|
*/
|
|
1706
1726
|
/**
|
|
1707
1727
|
* @typedef DeleteCartDetails
|
|
@@ -1905,6 +1925,7 @@ export = CartPlatformModel;
|
|
|
1905
1925
|
* includes type of error, error code and error message
|
|
1906
1926
|
* @property {string} [pan_no] - Permanent Account Number of the user
|
|
1907
1927
|
* @property {Object} [custom_cart_meta] - Custom cart meta details added in cart
|
|
1928
|
+
* @property {string} [customer_id] - Customer user id associated with cart
|
|
1908
1929
|
*/
|
|
1909
1930
|
/**
|
|
1910
1931
|
* @typedef UpdateCartShipmentItem
|
|
@@ -3440,6 +3461,11 @@ type PromotionListItem = {
|
|
|
3440
3461
|
* - List of tags on which promotion is applicable
|
|
3441
3462
|
*/
|
|
3442
3463
|
tags?: string[];
|
|
3464
|
+
/**
|
|
3465
|
+
* - Boolean value to determine if the
|
|
3466
|
+
* promotion should be applied automatically or not
|
|
3467
|
+
*/
|
|
3468
|
+
auto_apply?: boolean;
|
|
3443
3469
|
};
|
|
3444
3470
|
/** @returns {PromotionsResult} */
|
|
3445
3471
|
declare function PromotionsResult(): PromotionsResult;
|
|
@@ -3522,6 +3548,11 @@ type PromotionAdd = {
|
|
|
3522
3548
|
* - List of tags applicable for promotion
|
|
3523
3549
|
*/
|
|
3524
3550
|
tags?: string[];
|
|
3551
|
+
/**
|
|
3552
|
+
* - Boolean value to determine if the
|
|
3553
|
+
* promotion should be applied automatically or not
|
|
3554
|
+
*/
|
|
3555
|
+
auto_apply?: boolean;
|
|
3525
3556
|
};
|
|
3526
3557
|
/** @returns {PromotionAddResult} */
|
|
3527
3558
|
declare function PromotionAddResult(): PromotionAddResult;
|
|
@@ -3600,6 +3631,11 @@ type PromotionAddResult = {
|
|
|
3600
3631
|
* - List of tags applicable for promotion
|
|
3601
3632
|
*/
|
|
3602
3633
|
tags?: string[];
|
|
3634
|
+
/**
|
|
3635
|
+
* - Boolean value to determine if the
|
|
3636
|
+
* promotion should be applied automatically or not
|
|
3637
|
+
*/
|
|
3638
|
+
auto_apply?: boolean;
|
|
3603
3639
|
};
|
|
3604
3640
|
/** @returns {PromotionUpdate} */
|
|
3605
3641
|
declare function PromotionUpdate(): PromotionUpdate;
|
|
@@ -3678,6 +3714,11 @@ type PromotionUpdate = {
|
|
|
3678
3714
|
* - List of tags applicable for promotion
|
|
3679
3715
|
*/
|
|
3680
3716
|
tags?: string[];
|
|
3717
|
+
/**
|
|
3718
|
+
* - Boolean value to determine if the
|
|
3719
|
+
* promotion should be applied automatically or not
|
|
3720
|
+
*/
|
|
3721
|
+
auto_apply?: boolean;
|
|
3681
3722
|
};
|
|
3682
3723
|
/** @returns {PromotionUpdateResult} */
|
|
3683
3724
|
declare function PromotionUpdateResult(): PromotionUpdateResult;
|
|
@@ -3761,6 +3802,11 @@ type PromotionUpdateResult = {
|
|
|
3761
3802
|
* - List of tags applicable for promotion
|
|
3762
3803
|
*/
|
|
3763
3804
|
tags?: string[];
|
|
3805
|
+
/**
|
|
3806
|
+
* - Boolean value to determine if the
|
|
3807
|
+
* promotion should be applied automatically or not
|
|
3808
|
+
*/
|
|
3809
|
+
auto_apply?: boolean;
|
|
3764
3810
|
};
|
|
3765
3811
|
/** @returns {PromotionPartialUpdate} */
|
|
3766
3812
|
declare function PromotionPartialUpdate(): PromotionPartialUpdate;
|
|
@@ -4644,6 +4690,11 @@ type ProductArticle = {
|
|
|
4644
4690
|
* for the product grouping.
|
|
4645
4691
|
*/
|
|
4646
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;
|
|
4647
4698
|
/**
|
|
4648
4699
|
* - Unique identifier of the article
|
|
4649
4700
|
*/
|
|
@@ -5851,6 +5902,11 @@ type CartDetailResult = {
|
|
|
5851
5902
|
* checkout API payload
|
|
5852
5903
|
*/
|
|
5853
5904
|
custom_cart_meta?: any;
|
|
5905
|
+
/**
|
|
5906
|
+
* - Determines if the cart
|
|
5907
|
+
* has available promotion free gift items to choose on its added items
|
|
5908
|
+
*/
|
|
5909
|
+
free_gift_selection_available?: boolean;
|
|
5854
5910
|
};
|
|
5855
5911
|
/** @returns {AddProductCart} */
|
|
5856
5912
|
declare function AddProductCart(): AddProductCart;
|
|
@@ -5911,6 +5967,11 @@ type AddProductCart = {
|
|
|
5911
5967
|
* while add items to cart
|
|
5912
5968
|
*/
|
|
5913
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;
|
|
5914
5975
|
/**
|
|
5915
5976
|
* - Field to add meta data at article level
|
|
5916
5977
|
*/
|
|
@@ -6021,6 +6082,11 @@ type UpdateProductCart = {
|
|
|
6021
6082
|
* - Field to update custom json of the product in cart
|
|
6022
6083
|
*/
|
|
6023
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;
|
|
6024
6090
|
/**
|
|
6025
6091
|
* - Item id of the product that needs to be updated
|
|
6026
6092
|
*/
|
|
@@ -6600,6 +6666,11 @@ type PlatformUpdateCartDetails = {
|
|
|
6600
6666
|
* cart or it needs to be updated
|
|
6601
6667
|
*/
|
|
6602
6668
|
operation: string;
|
|
6669
|
+
/**
|
|
6670
|
+
* - Field to determine if free
|
|
6671
|
+
* gift item to be removed from cart or it needs to be added.
|
|
6672
|
+
*/
|
|
6673
|
+
free_gift_items_operation?: string;
|
|
6603
6674
|
};
|
|
6604
6675
|
/** @returns {DeleteCartDetails} */
|
|
6605
6676
|
declare function DeleteCartDetails(): DeleteCartDetails;
|
|
@@ -7139,6 +7210,10 @@ type PlatformCartShipmentsResult = {
|
|
|
7139
7210
|
* - Custom cart meta details added in cart
|
|
7140
7211
|
*/
|
|
7141
7212
|
custom_cart_meta?: any;
|
|
7213
|
+
/**
|
|
7214
|
+
* - Customer user id associated with cart
|
|
7215
|
+
*/
|
|
7216
|
+
customer_id?: string;
|
|
7142
7217
|
};
|
|
7143
7218
|
/** @returns {UpdateCartShipmentItem} */
|
|
7144
7219
|
declare function UpdateCartShipmentItem(): UpdateCartShipmentItem;
|