@gofynd/fdk-client-javascript 1.3.11-beta.7 → 1.4.0-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +1 -1
- package/sdk/application/Cart/CartApplicationClient.js +5 -3
- package/sdk/application/Cart/CartApplicationModel.d.ts +107 -1
- package/sdk/application/Cart/CartApplicationModel.js +74 -0
- package/sdk/application/Cart/CartApplicationValidator.d.ts +4 -0
- package/sdk/application/Cart/CartApplicationValidator.js +4 -0
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +3 -6
- package/sdk/application/Catalog/CatalogApplicationClient.js +7 -20
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +2 -2
- package/sdk/application/Catalog/CatalogApplicationModel.js +2 -2
- package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +0 -14
- package/sdk/application/Catalog/CatalogApplicationValidator.js +0 -6
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +183 -49
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +173 -31
- package/sdk/application/Content/ContentApplicationClient.d.ts +36 -0
- package/sdk/application/Content/ContentApplicationClient.js +246 -0
- package/sdk/application/Content/ContentApplicationModel.d.ts +208 -1
- package/sdk/application/Content/ContentApplicationModel.js +252 -0
- package/sdk/application/Content/ContentApplicationValidator.d.ts +40 -1
- package/sdk/application/Content/ContentApplicationValidator.js +41 -0
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +67 -0
- package/sdk/application/Logistic/LogisticApplicationClient.js +547 -0
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +456 -1
- package/sdk/application/Logistic/LogisticApplicationModel.js +488 -0
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +211 -1
- package/sdk/application/Logistic/LogisticApplicationValidator.js +131 -0
- package/sdk/application/Order/OrderApplicationClient.d.ts +3 -3
- package/sdk/application/Order/OrderApplicationClient.js +32 -8
- package/sdk/application/Order/OrderApplicationModel.d.ts +6 -0
- package/sdk/application/Order/OrderApplicationModel.js +6 -0
- package/sdk/application/Order/OrderApplicationValidator.d.ts +20 -0
- package/sdk/application/Order/OrderApplicationValidator.js +8 -0
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +46 -2
- package/sdk/application/Payment/PaymentApplicationClient.js +341 -10
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +493 -186
- package/sdk/application/Payment/PaymentApplicationModel.js +341 -70
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +59 -14
- package/sdk/application/Payment/PaymentApplicationValidator.js +64 -10
- package/sdk/application/PosCart/PosCartApplicationModel.d.ts +34 -1
- package/sdk/application/PosCart/PosCartApplicationModel.js +24 -0
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +1 -1
- package/sdk/application/Theme/ThemeApplicationClient.js +7 -3
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +222 -36
- package/sdk/application/Theme/ThemeApplicationModel.js +322 -26
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +10 -0
- package/sdk/application/Theme/ThemeApplicationValidator.js +4 -0
- package/sdk/application/User/UserApplicationClient.d.ts +33 -0
- package/sdk/application/User/UserApplicationClient.js +239 -0
- package/sdk/application/User/UserApplicationModel.d.ts +28 -13
- package/sdk/application/User/UserApplicationModel.js +36 -12
- package/sdk/application/User/UserApplicationValidator.d.ts +34 -1
- package/sdk/application/User/UserApplicationValidator.js +36 -0
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +3 -15
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +2 -14
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +125 -0
- package/sdk/partner/Lead/LeadPartnerClient.js +785 -0
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +1127 -0
- package/sdk/partner/Lead/LeadPartnerModel.js +896 -0
- package/sdk/partner/Lead/LeadPartnerValidator.d.ts +12 -0
- package/sdk/partner/Lead/LeadPartnerValidator.js +67 -0
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +155 -0
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +1195 -0
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +372 -0
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +442 -0
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +16 -0
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +123 -0
- package/sdk/partner/PartnerClient.d.ts +6 -0
- package/sdk/partner/PartnerClient.js +9 -0
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +10 -0
- package/sdk/partner/Theme/ThemePartnerClient.js +80 -0
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +100 -43
- package/sdk/partner/Theme/ThemePartnerModel.js +74 -30
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +1 -0
- package/sdk/partner/Theme/ThemePartnerValidator.js +9 -0
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +99 -0
- package/sdk/partner/Webhook/WebhookPartnerClient.js +753 -0
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +566 -0
- package/sdk/partner/Webhook/WebhookPartnerModel.js +583 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +12 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +74 -0
- package/sdk/partner/index.d.ts +3 -0
- package/sdk/partner/index.js +6 -0
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +2 -2
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +11 -1
- package/sdk/platform/Billing/BillingPlatformClient.js +110 -3
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +67 -1
- package/sdk/platform/Billing/BillingPlatformModel.js +78 -0
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +43 -4
- package/sdk/platform/Billing/BillingPlatformValidator.js +29 -2
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +7 -1
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +4 -0
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +4 -0
- package/sdk/platform/Cart/CartPlatformModel.d.ts +100 -5
- package/sdk/platform/Cart/CartPlatformModel.js +71 -4
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +15 -11
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +52 -21
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +27 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +11 -0
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +26 -4
- package/sdk/platform/Catalog/CatalogPlatformClient.js +173 -7
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +304 -1
- package/sdk/platform/Catalog/CatalogPlatformModel.js +335 -0
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +31 -3
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +27 -2
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +138 -36
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +739 -57
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +128 -3
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +111 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +150 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.js +172 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +8 -2
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +32 -4
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +38 -9
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +42 -8
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +14 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +6 -0
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +8 -8
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +4 -4
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +371 -132
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +288 -77
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +2 -2
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +2 -2
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +391 -0
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +3641 -1059
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +351 -1
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +410 -0
- package/sdk/platform/Content/ContentPlatformClient.d.ts +277 -0
- package/sdk/platform/Content/ContentPlatformClient.js +2011 -0
- package/sdk/platform/Content/ContentPlatformModel.d.ts +1100 -1
- package/sdk/platform/Content/ContentPlatformModel.js +1362 -46
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +247 -0
- package/sdk/platform/Content/ContentPlatformValidator.js +319 -0
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformClient.js +2 -2
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +96 -13
- package/sdk/platform/Discount/DiscountPlatformModel.js +104 -12
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +16 -6
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +117 -8
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +55 -4
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +39 -2
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +18 -19
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +20 -18
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +33 -0
- package/sdk/platform/Finance/FinancePlatformClient.js +240 -0
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +151 -5
- package/sdk/platform/Finance/FinancePlatformModel.js +190 -4
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +38 -1
- package/sdk/platform/Finance/FinancePlatformValidator.js +38 -0
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +38 -28
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +137 -56
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +41 -29
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +33 -21
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +12 -3
- package/sdk/platform/Lead/LeadPlatformModel.js +16 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +23 -1
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +178 -1
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +39 -1
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +32 -0
- package/sdk/platform/Order/OrderPlatformClient.d.ts +202 -31
- package/sdk/platform/Order/OrderPlatformClient.js +2010 -586
- package/sdk/platform/Order/OrderPlatformModel.d.ts +1032 -470
- package/sdk/platform/Order/OrderPlatformModel.js +1187 -534
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +318 -35
- package/sdk/platform/Order/OrderPlatformValidator.js +292 -29
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +119 -13
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +749 -39
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +143 -7
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +133 -6
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +1 -1
- package/sdk/platform/Payment/PaymentPlatformClient.js +1 -1
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +996 -134
- package/sdk/platform/Payment/PaymentPlatformModel.js +721 -58
- package/sdk/platform/PlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/PlatformApplicationClient.js +4 -4
- package/sdk/platform/PlatformClient.d.ts +4 -2
- package/sdk/platform/PlatformClient.js +8 -4
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +142 -66
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +645 -147
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +131 -63
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +126 -47
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +217 -105
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +1136 -347
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +912 -313
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1071 -355
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +382 -133
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +266 -102
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +11 -1
- package/sdk/platform/Theme/ThemePlatformClient.js +87 -3
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +333 -47
- package/sdk/platform/Theme/ThemePlatformModel.js +395 -35
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +28 -4
- package/sdk/platform/Theme/ThemePlatformValidator.js +21 -2
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +116 -1
- package/sdk/platform/User/UserPlatformApplicationClient.js +931 -85
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +224 -7
- package/sdk/platform/User/UserPlatformApplicationValidator.js +173 -5
- package/sdk/platform/User/UserPlatformModel.d.ts +344 -7
- package/sdk/platform/User/UserPlatformModel.js +256 -5
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +47 -39
- package/sdk/platform/Webhook/WebhookPlatformClient.js +63 -61
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +264 -156
- package/sdk/platform/Webhook/WebhookPlatformModel.js +276 -153
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +7 -10
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +6 -6
- package/sdk/platform/index.d.ts +1 -1
- package/sdk/platform/index.js +2 -2
- package/sdk/public/Billing/BillingPublicClient.d.ts +23 -0
- package/sdk/public/Billing/BillingPublicClient.js +116 -0
- package/sdk/public/Billing/BillingPublicModel.d.ts +92 -0
- package/sdk/public/Billing/BillingPublicModel.js +96 -0
- package/sdk/public/Billing/BillingPublicValidator.d.ts +18 -0
- package/sdk/public/Billing/BillingPublicValidator.js +19 -0
- package/sdk/public/Content/ContentPublicClient.d.ts +22 -0
- package/sdk/public/Content/ContentPublicClient.js +114 -0
- package/sdk/public/Content/ContentPublicModel.d.ts +53 -0
- package/sdk/public/Content/ContentPublicModel.js +60 -0
- package/sdk/public/Content/ContentPublicValidator.d.ts +18 -0
- package/sdk/public/Content/ContentPublicValidator.js +19 -0
- package/sdk/public/PublicClient.d.ts +4 -0
- package/sdk/public/PublicClient.js +8 -0
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +33 -0
- package/sdk/public/Webhook/WebhookPublicClient.js +242 -0
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +147 -1
- package/sdk/public/Webhook/WebhookPublicModel.js +177 -1
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +23 -1
- package/sdk/public/Webhook/WebhookPublicValidator.js +31 -0
- package/sdk/public/index.d.ts +2 -0
- package/sdk/public/index.js +4 -0
|
@@ -90,6 +90,7 @@ export = CartPlatformModel;
|
|
|
90
90
|
* @property {string[]} [product_group_tags]
|
|
91
91
|
* @property {number} [quantity]
|
|
92
92
|
* @property {number} [seller_id]
|
|
93
|
+
* @property {string} [seller_identifier] - Add items using seller identifier for store os
|
|
93
94
|
* @property {number} [store_id]
|
|
94
95
|
*/
|
|
95
96
|
/**
|
|
@@ -107,6 +108,7 @@ export = CartPlatformModel;
|
|
|
107
108
|
* @property {number} [article_quantity] - Quantity of article on which
|
|
108
109
|
* promotion is applicable
|
|
109
110
|
* @property {BuyRules[]} [buy_rules] - Buy rules for promotions
|
|
111
|
+
* @property {CartCurrency} [currency]
|
|
110
112
|
* @property {DiscountRulesApp[]} [discount_rules] - Discount rules for promotions
|
|
111
113
|
* @property {boolean} [mrp_promotion] - If applied promotion is applied on
|
|
112
114
|
* product MRP or ESP
|
|
@@ -262,6 +264,7 @@ export = CartPlatformModel;
|
|
|
262
264
|
* @property {string} [cart_id]
|
|
263
265
|
* @property {number} [cart_value]
|
|
264
266
|
* @property {string} [created_on]
|
|
267
|
+
* @property {string} [currency_code]
|
|
265
268
|
* @property {number} [item_counts]
|
|
266
269
|
* @property {Object} [pick_up_customer_details]
|
|
267
270
|
* @property {string} [user_id]
|
|
@@ -404,16 +407,19 @@ export = CartPlatformModel;
|
|
|
404
407
|
*/
|
|
405
408
|
/**
|
|
406
409
|
* @typedef Coupon
|
|
410
|
+
* @property {string} [coupon_applicable_message]
|
|
407
411
|
* @property {string} [coupon_code]
|
|
408
412
|
* @property {string} [coupon_type]
|
|
409
413
|
* @property {number} [coupon_value]
|
|
410
414
|
* @property {string} [description]
|
|
415
|
+
* @property {string} [end_date]
|
|
411
416
|
* @property {string} [expires_on]
|
|
412
417
|
* @property {boolean} [is_applicable]
|
|
413
418
|
* @property {boolean} [is_applied]
|
|
414
419
|
* @property {number} [max_discount_value]
|
|
415
420
|
* @property {string} [message]
|
|
416
421
|
* @property {number} [minimum_cart_value]
|
|
422
|
+
* @property {string} [start_date]
|
|
417
423
|
* @property {string} [sub_title]
|
|
418
424
|
* @property {string} [title]
|
|
419
425
|
*/
|
|
@@ -820,6 +826,7 @@ export = CartPlatformModel;
|
|
|
820
826
|
/**
|
|
821
827
|
* @typedef OverrideCartItemPromo
|
|
822
828
|
* @property {Object[]} [item_list]
|
|
829
|
+
* @property {string} [parent_promo_id]
|
|
823
830
|
* @property {string} promo_amount
|
|
824
831
|
* @property {string} [promo_desc]
|
|
825
832
|
* @property {string} promo_id
|
|
@@ -952,6 +959,7 @@ export = CartPlatformModel;
|
|
|
952
959
|
*/
|
|
953
960
|
/**
|
|
954
961
|
* @typedef PlatformAddress
|
|
962
|
+
* @property {Object} [_custom_json]
|
|
955
963
|
* @property {string} [address]
|
|
956
964
|
* @property {string} [address_type]
|
|
957
965
|
* @property {string} [area]
|
|
@@ -962,6 +970,8 @@ export = CartPlatformModel;
|
|
|
962
970
|
* @property {string} [city]
|
|
963
971
|
* @property {string} [country]
|
|
964
972
|
* @property {string} [country_code]
|
|
973
|
+
* @property {string} [country_iso_code]
|
|
974
|
+
* @property {string} [country_phone_code]
|
|
965
975
|
* @property {string} [created_by_user_id]
|
|
966
976
|
* @property {string} [email]
|
|
967
977
|
* @property {GeoLocation} [geo_location]
|
|
@@ -973,7 +983,9 @@ export = CartPlatformModel;
|
|
|
973
983
|
* @property {Object} [meta]
|
|
974
984
|
* @property {string} [name]
|
|
975
985
|
* @property {string} [phone]
|
|
986
|
+
* @property {string} [sector]
|
|
976
987
|
* @property {string} [state]
|
|
988
|
+
* @property {string} [state_code] - State code for international address
|
|
977
989
|
* @property {string[]} [tags]
|
|
978
990
|
* @property {string} [user_id]
|
|
979
991
|
*/
|
|
@@ -1130,6 +1142,9 @@ export = CartPlatformModel;
|
|
|
1130
1142
|
* authenticated
|
|
1131
1143
|
* @property {string} message - The message associated with the price adjustment
|
|
1132
1144
|
* @property {Object} [meta]
|
|
1145
|
+
* @property {PriceAdjustmentRestrictions} [restrictions] - This field accepts
|
|
1146
|
+
* the restrictions applied to this particular item or service, including
|
|
1147
|
+
* whether or not cancellation and return are allowed, etc
|
|
1133
1148
|
* @property {string} type - Type of price adjusment
|
|
1134
1149
|
* @property {number} value
|
|
1135
1150
|
*/
|
|
@@ -1148,6 +1163,9 @@ export = CartPlatformModel;
|
|
|
1148
1163
|
* authenticated
|
|
1149
1164
|
* @property {string} message - The message associated with the price adjustment
|
|
1150
1165
|
* @property {Object} [meta]
|
|
1166
|
+
* @property {PriceAdjustmentRestrictions} [restrictions] - This field accepts
|
|
1167
|
+
* the restrictions applied to this particular item or service, including
|
|
1168
|
+
* whether or not cancellation and return are allowed, etc
|
|
1151
1169
|
* @property {string} type - Type of price adjusment
|
|
1152
1170
|
* @property {number} value
|
|
1153
1171
|
*/
|
|
@@ -1155,6 +1173,11 @@ export = CartPlatformModel;
|
|
|
1155
1173
|
* @typedef PriceAdjustmentResponse
|
|
1156
1174
|
* @property {PriceAdjustment} [data]
|
|
1157
1175
|
*/
|
|
1176
|
+
/**
|
|
1177
|
+
* @typedef PriceAdjustmentRestrictions
|
|
1178
|
+
* @property {Object} [post_order] - This field holds the post-order
|
|
1179
|
+
* restrictions, indicated by nested fields ['cancellation_allowed','return_allowed']
|
|
1180
|
+
*/
|
|
1158
1181
|
/**
|
|
1159
1182
|
* @typedef PriceAdjustmentUpdate
|
|
1160
1183
|
* @property {boolean} [allowed_refund] - Flag indicating whether refunds are
|
|
@@ -1170,6 +1193,9 @@ export = CartPlatformModel;
|
|
|
1170
1193
|
* @property {string} message - The message associated with the price adjustment
|
|
1171
1194
|
* @property {Object} [meta]
|
|
1172
1195
|
* @property {string} [modified_by] - The entity that modified the field
|
|
1196
|
+
* @property {PriceAdjustmentRestrictions} [restrictions] - Restrictions applied
|
|
1197
|
+
* to this particular item or product, including whether or not cancellation
|
|
1198
|
+
* and return are allowed.
|
|
1173
1199
|
* @property {string} type - Type of price adjusment
|
|
1174
1200
|
* @property {number} value
|
|
1175
1201
|
*/
|
|
@@ -1202,6 +1228,7 @@ export = CartPlatformModel;
|
|
|
1202
1228
|
* @property {string} [seller_identifier]
|
|
1203
1229
|
* @property {string} [size]
|
|
1204
1230
|
* @property {StoreInfo} [store]
|
|
1231
|
+
* @property {string[]} [tags] - A list of article tags
|
|
1205
1232
|
* @property {string} [type]
|
|
1206
1233
|
* @property {string} [uid]
|
|
1207
1234
|
*/
|
|
@@ -1245,6 +1272,11 @@ export = CartPlatformModel;
|
|
|
1245
1272
|
* @property {string} [max]
|
|
1246
1273
|
* @property {string} [min]
|
|
1247
1274
|
*/
|
|
1275
|
+
/**
|
|
1276
|
+
* @typedef PromiseISOFormat
|
|
1277
|
+
* @property {string} [max] - Max promise in ISO format.
|
|
1278
|
+
* @property {string} [min] - Min Promise in ISO format.
|
|
1279
|
+
*/
|
|
1248
1280
|
/**
|
|
1249
1281
|
* @typedef PromiseTimestamp
|
|
1250
1282
|
* @property {number} [max]
|
|
@@ -1411,12 +1443,12 @@ export = CartPlatformModel;
|
|
|
1411
1443
|
* @property {boolean} [anonymous_users]
|
|
1412
1444
|
* @property {number} [order_quantity]
|
|
1413
1445
|
* @property {number[]} [ordering_stores]
|
|
1414
|
-
* @property {
|
|
1446
|
+
* @property {Object} [payments]
|
|
1415
1447
|
* @property {string[]} [platforms]
|
|
1416
1448
|
* @property {PostOrder1} [post_order]
|
|
1417
1449
|
* @property {number[]} [user_groups]
|
|
1418
1450
|
* @property {string[]} [user_id]
|
|
1419
|
-
* @property {
|
|
1451
|
+
* @property {UserRegistered} [user_registered]
|
|
1420
1452
|
* @property {UsesRestriction1} uses
|
|
1421
1453
|
*/
|
|
1422
1454
|
/**
|
|
@@ -1488,6 +1520,7 @@ export = CartPlatformModel;
|
|
|
1488
1520
|
/**
|
|
1489
1521
|
* @typedef ShipmentPromise
|
|
1490
1522
|
* @property {PromiseFormatted} [formatted]
|
|
1523
|
+
* @property {PromiseISOFormat} [iso]
|
|
1491
1524
|
* @property {PromiseTimestamp} [timestamp]
|
|
1492
1525
|
*/
|
|
1493
1526
|
/**
|
|
@@ -1687,7 +1720,7 @@ export = CartPlatformModel;
|
|
|
1687
1720
|
declare class CartPlatformModel {
|
|
1688
1721
|
}
|
|
1689
1722
|
declare namespace CartPlatformModel {
|
|
1690
|
-
export { AbandonedCart, AbandonedCartResponse, ActionQuery, ActivePromosResponse, AddCartDetailResponse, AddCartRequest, AddProductCart, AppliedFreeArticles, AppliedPromotion, ApplyCouponRequest, Article, ArticlePriceInfo, BaseInfo, BasePrice, BulkBundleRestriction, BuyRules, CartBreakup, CartCheckoutCustomMeta, CartCheckoutResponse, CartCommonConfig, CartCurrency, CartDeliveryModesResponse, CartDetailCoupon, CartDetailResponse, CartItem, CartItemCountResponse, CartItemMeta, CartList, CartMetaConfigAdd, CartMetaConfigUpdate, CartMetaMissingResponse, CartMetaResponse, CartProduct, CartProductIdentifer, CartProductInfo, CategoryInfo, Charges, ChargesThreshold, CheckCart, Collection, CompareObject, Coupon, CouponAction, CouponAdd, CouponAuthor, CouponBreakup, CouponDateMeta, CouponDetails, CouponPartialUpdate, CouponSchedule, CouponsResponse, CouponUpdate, CouponValidity, CustomerDetails, DeleteAddressResponse, DeleteCartDetailResponse, DeleteCartRequest, DeliveryCharges, DeliveryChargesConfig, DiscountOffer, DiscountRule, DiscountRulesApp, DisplayBreakup, DisplayMeta, DisplayMeta1, DisplayMetaDict, Files, FreeGiftItem, GeoLocation, GetCouponResponse, GetShareCartLinkRequest, GetShareCartLinkResponse, Identifier, ItemCriteria, LoyaltyPoints, MultiCartResponse, MultiTenderPaymentMeta, MultiTenderPaymentMethod, OpenapiCartDetailsRequest, OpenapiCartDetailsResponse, OpenApiCartServiceabilityRequest, OpenApiCartServiceabilityResponse, OpenApiCheckoutResponse, OpenApiErrorResponse, OpenApiFiles, OpenApiOrderItem, OpenApiPlatformCheckoutReq, OperationErrorResponse, OverrideCartItem, OverrideCartItemPromo, OverrideCheckoutReq, OverrideCheckoutResponse, Ownership, Ownership1, Ownership2, Page, PageCoupon, PaymentAllowValue, PaymentAllowValue1, PaymentCouponValidate, PaymentMeta, PaymentMethod, PaymentModes, PaymentSelectionLock, PickupStoreDetail, PlatformAddCartRequest, PlatformAddress, PlatformCartCheckoutDetailRequest, PlatformCartCheckoutDetailV2Request, PlatformCartMetaRequest, PlatformCartShipmentsResponse, PlatformGetAddressesResponse, PlatformSelectCartAddressRequest, PlatformShipmentResponse, PlatformUpdateCartRequest, PostOrder, PostOrder1, PriceAdjustment, PriceAdjustmentAdd, PriceAdjustmentResponse, PriceAdjustmentUpdate, PriceRange, ProductAction, ProductArticle, ProductAvailability, ProductAvailabilitySize, ProductImage, ProductPrice, ProductPriceInfo, PromiseFormatted, PromiseTimestamp, PromoMeta, PromotionAction, PromotionAdd, PromotionAuthor, PromotionDateMeta, PromotionListItem, PromotionPartialUpdate, PromotionPaymentModes, PromotionSchedule, PromotionsResponse, PromotionUpdate, RawBreakup, Restrictions, Restrictions1, Rule, RuleDefinition, SaveAddressResponse, SharedCart, SharedCartDetails, SharedCartResponse, ShipmentArticle, ShipmentPromise, ShippingAddress, StaffCheckout, State, StoreDetailsResponse, StoreInfo, SuccessMessage, Tags, UpdateAddressResponse, UpdateCartDetailResponse, UpdateCartPaymentRequest, UpdateCartPaymentRequestV2, UpdateCartRequest, UpdateCartShipmentItem, UpdateCartShipmentRequest, UpdateProductCart, UpdateUserCartMapping, UserCartMappingResponse, UserInfo, UserRegistered, UsesRemaining, UsesRemaining1, UsesRestriction, UsesRestriction1, Validation, Validity, Visibility };
|
|
1723
|
+
export { AbandonedCart, AbandonedCartResponse, ActionQuery, ActivePromosResponse, AddCartDetailResponse, AddCartRequest, AddProductCart, AppliedFreeArticles, AppliedPromotion, ApplyCouponRequest, Article, ArticlePriceInfo, BaseInfo, BasePrice, BulkBundleRestriction, BuyRules, CartBreakup, CartCheckoutCustomMeta, CartCheckoutResponse, CartCommonConfig, CartCurrency, CartDeliveryModesResponse, CartDetailCoupon, CartDetailResponse, CartItem, CartItemCountResponse, CartItemMeta, CartList, CartMetaConfigAdd, CartMetaConfigUpdate, CartMetaMissingResponse, CartMetaResponse, CartProduct, CartProductIdentifer, CartProductInfo, CategoryInfo, Charges, ChargesThreshold, CheckCart, Collection, CompareObject, Coupon, CouponAction, CouponAdd, CouponAuthor, CouponBreakup, CouponDateMeta, CouponDetails, CouponPartialUpdate, CouponSchedule, CouponsResponse, CouponUpdate, CouponValidity, CustomerDetails, DeleteAddressResponse, DeleteCartDetailResponse, DeleteCartRequest, DeliveryCharges, DeliveryChargesConfig, DiscountOffer, DiscountRule, DiscountRulesApp, DisplayBreakup, DisplayMeta, DisplayMeta1, DisplayMetaDict, Files, FreeGiftItem, GeoLocation, GetCouponResponse, GetShareCartLinkRequest, GetShareCartLinkResponse, Identifier, ItemCriteria, LoyaltyPoints, MultiCartResponse, MultiTenderPaymentMeta, MultiTenderPaymentMethod, OpenapiCartDetailsRequest, OpenapiCartDetailsResponse, OpenApiCartServiceabilityRequest, OpenApiCartServiceabilityResponse, OpenApiCheckoutResponse, OpenApiErrorResponse, OpenApiFiles, OpenApiOrderItem, OpenApiPlatformCheckoutReq, OperationErrorResponse, OverrideCartItem, OverrideCartItemPromo, OverrideCheckoutReq, OverrideCheckoutResponse, Ownership, Ownership1, Ownership2, Page, PageCoupon, PaymentAllowValue, PaymentAllowValue1, PaymentCouponValidate, PaymentMeta, PaymentMethod, PaymentModes, PaymentSelectionLock, PickupStoreDetail, PlatformAddCartRequest, PlatformAddress, PlatformCartCheckoutDetailRequest, PlatformCartCheckoutDetailV2Request, PlatformCartMetaRequest, PlatformCartShipmentsResponse, PlatformGetAddressesResponse, PlatformSelectCartAddressRequest, PlatformShipmentResponse, PlatformUpdateCartRequest, PostOrder, PostOrder1, PriceAdjustment, PriceAdjustmentAdd, PriceAdjustmentResponse, PriceAdjustmentRestrictions, PriceAdjustmentUpdate, PriceRange, ProductAction, ProductArticle, ProductAvailability, ProductAvailabilitySize, ProductImage, ProductPrice, ProductPriceInfo, PromiseFormatted, PromiseISOFormat, PromiseTimestamp, PromoMeta, PromotionAction, PromotionAdd, PromotionAuthor, PromotionDateMeta, PromotionListItem, PromotionPartialUpdate, PromotionPaymentModes, PromotionSchedule, PromotionsResponse, PromotionUpdate, RawBreakup, Restrictions, Restrictions1, Rule, RuleDefinition, SaveAddressResponse, SharedCart, SharedCartDetails, SharedCartResponse, ShipmentArticle, ShipmentPromise, ShippingAddress, StaffCheckout, State, StoreDetailsResponse, StoreInfo, SuccessMessage, Tags, UpdateAddressResponse, UpdateCartDetailResponse, UpdateCartPaymentRequest, UpdateCartPaymentRequestV2, UpdateCartRequest, UpdateCartShipmentItem, UpdateCartShipmentRequest, UpdateProductCart, UpdateUserCartMapping, UserCartMappingResponse, UserInfo, UserRegistered, UsesRemaining, UsesRemaining1, UsesRestriction, UsesRestriction1, Validation, Validity, Visibility };
|
|
1691
1724
|
}
|
|
1692
1725
|
/** @returns {AbandonedCart} */
|
|
1693
1726
|
declare function AbandonedCart(): AbandonedCart;
|
|
@@ -1829,6 +1862,10 @@ type AddProductCart = {
|
|
|
1829
1862
|
product_group_tags?: string[];
|
|
1830
1863
|
quantity?: number;
|
|
1831
1864
|
seller_id?: number;
|
|
1865
|
+
/**
|
|
1866
|
+
* - Add items using seller identifier for store os
|
|
1867
|
+
*/
|
|
1868
|
+
seller_identifier?: string;
|
|
1832
1869
|
store_id?: number;
|
|
1833
1870
|
};
|
|
1834
1871
|
/** @returns {AppliedFreeArticles} */
|
|
@@ -1872,6 +1909,7 @@ type AppliedPromotion = {
|
|
|
1872
1909
|
* - Buy rules for promotions
|
|
1873
1910
|
*/
|
|
1874
1911
|
buy_rules?: BuyRules[];
|
|
1912
|
+
currency?: CartCurrency;
|
|
1875
1913
|
/**
|
|
1876
1914
|
* - Discount rules for promotions
|
|
1877
1915
|
*/
|
|
@@ -2109,6 +2147,7 @@ type CartList = {
|
|
|
2109
2147
|
cart_id?: string;
|
|
2110
2148
|
cart_value?: number;
|
|
2111
2149
|
created_on?: string;
|
|
2150
|
+
currency_code?: string;
|
|
2112
2151
|
item_counts?: number;
|
|
2113
2152
|
pick_up_customer_details?: any;
|
|
2114
2153
|
user_id?: string;
|
|
@@ -2274,16 +2313,19 @@ type CompareObject = {
|
|
|
2274
2313
|
/** @returns {Coupon} */
|
|
2275
2314
|
declare function Coupon(): Coupon;
|
|
2276
2315
|
type Coupon = {
|
|
2316
|
+
coupon_applicable_message?: string;
|
|
2277
2317
|
coupon_code?: string;
|
|
2278
2318
|
coupon_type?: string;
|
|
2279
2319
|
coupon_value?: number;
|
|
2280
2320
|
description?: string;
|
|
2321
|
+
end_date?: string;
|
|
2281
2322
|
expires_on?: string;
|
|
2282
2323
|
is_applicable?: boolean;
|
|
2283
2324
|
is_applied?: boolean;
|
|
2284
2325
|
max_discount_value?: number;
|
|
2285
2326
|
message?: string;
|
|
2286
2327
|
minimum_cart_value?: number;
|
|
2328
|
+
start_date?: string;
|
|
2287
2329
|
sub_title?: string;
|
|
2288
2330
|
title?: string;
|
|
2289
2331
|
};
|
|
@@ -2804,6 +2846,7 @@ type OverrideCartItem = {
|
|
|
2804
2846
|
declare function OverrideCartItemPromo(): OverrideCartItemPromo;
|
|
2805
2847
|
type OverrideCartItemPromo = {
|
|
2806
2848
|
item_list?: any[];
|
|
2849
|
+
parent_promo_id?: string;
|
|
2807
2850
|
promo_amount: string;
|
|
2808
2851
|
promo_desc?: string;
|
|
2809
2852
|
promo_id: string;
|
|
@@ -2959,6 +3002,7 @@ type PlatformAddCartRequest = {
|
|
|
2959
3002
|
/** @returns {PlatformAddress} */
|
|
2960
3003
|
declare function PlatformAddress(): PlatformAddress;
|
|
2961
3004
|
type PlatformAddress = {
|
|
3005
|
+
_custom_json?: any;
|
|
2962
3006
|
address?: string;
|
|
2963
3007
|
address_type?: string;
|
|
2964
3008
|
area?: string;
|
|
@@ -2969,6 +3013,8 @@ type PlatformAddress = {
|
|
|
2969
3013
|
city?: string;
|
|
2970
3014
|
country?: string;
|
|
2971
3015
|
country_code?: string;
|
|
3016
|
+
country_iso_code?: string;
|
|
3017
|
+
country_phone_code?: string;
|
|
2972
3018
|
created_by_user_id?: string;
|
|
2973
3019
|
email?: string;
|
|
2974
3020
|
geo_location?: GeoLocation;
|
|
@@ -2980,7 +3026,12 @@ type PlatformAddress = {
|
|
|
2980
3026
|
meta?: any;
|
|
2981
3027
|
name?: string;
|
|
2982
3028
|
phone?: string;
|
|
3029
|
+
sector?: string;
|
|
2983
3030
|
state?: string;
|
|
3031
|
+
/**
|
|
3032
|
+
* - State code for international address
|
|
3033
|
+
*/
|
|
3034
|
+
state_code?: string;
|
|
2984
3035
|
tags?: string[];
|
|
2985
3036
|
user_id?: string;
|
|
2986
3037
|
};
|
|
@@ -3187,6 +3238,12 @@ type PriceAdjustment = {
|
|
|
3187
3238
|
*/
|
|
3188
3239
|
message: string;
|
|
3189
3240
|
meta?: any;
|
|
3241
|
+
/**
|
|
3242
|
+
* - This field accepts
|
|
3243
|
+
* the restrictions applied to this particular item or service, including
|
|
3244
|
+
* whether or not cancellation and return are allowed, etc
|
|
3245
|
+
*/
|
|
3246
|
+
restrictions?: PriceAdjustmentRestrictions;
|
|
3190
3247
|
/**
|
|
3191
3248
|
* - Type of price adjusment
|
|
3192
3249
|
*/
|
|
@@ -3233,6 +3290,12 @@ type PriceAdjustmentAdd = {
|
|
|
3233
3290
|
*/
|
|
3234
3291
|
message: string;
|
|
3235
3292
|
meta?: any;
|
|
3293
|
+
/**
|
|
3294
|
+
* - This field accepts
|
|
3295
|
+
* the restrictions applied to this particular item or service, including
|
|
3296
|
+
* whether or not cancellation and return are allowed, etc
|
|
3297
|
+
*/
|
|
3298
|
+
restrictions?: PriceAdjustmentRestrictions;
|
|
3236
3299
|
/**
|
|
3237
3300
|
* - Type of price adjusment
|
|
3238
3301
|
*/
|
|
@@ -3244,6 +3307,15 @@ declare function PriceAdjustmentResponse(): PriceAdjustmentResponse;
|
|
|
3244
3307
|
type PriceAdjustmentResponse = {
|
|
3245
3308
|
data?: PriceAdjustment;
|
|
3246
3309
|
};
|
|
3310
|
+
/** @returns {PriceAdjustmentRestrictions} */
|
|
3311
|
+
declare function PriceAdjustmentRestrictions(): PriceAdjustmentRestrictions;
|
|
3312
|
+
type PriceAdjustmentRestrictions = {
|
|
3313
|
+
/**
|
|
3314
|
+
* - This field holds the post-order
|
|
3315
|
+
* restrictions, indicated by nested fields ['cancellation_allowed','return_allowed']
|
|
3316
|
+
*/
|
|
3317
|
+
post_order?: any;
|
|
3318
|
+
};
|
|
3247
3319
|
/** @returns {PriceAdjustmentUpdate} */
|
|
3248
3320
|
declare function PriceAdjustmentUpdate(): PriceAdjustmentUpdate;
|
|
3249
3321
|
type PriceAdjustmentUpdate = {
|
|
@@ -3284,6 +3356,12 @@ type PriceAdjustmentUpdate = {
|
|
|
3284
3356
|
* - The entity that modified the field
|
|
3285
3357
|
*/
|
|
3286
3358
|
modified_by?: string;
|
|
3359
|
+
/**
|
|
3360
|
+
* - Restrictions applied
|
|
3361
|
+
* to this particular item or product, including whether or not cancellation
|
|
3362
|
+
* and return are allowed.
|
|
3363
|
+
*/
|
|
3364
|
+
restrictions?: PriceAdjustmentRestrictions;
|
|
3287
3365
|
/**
|
|
3288
3366
|
* - Type of price adjusment
|
|
3289
3367
|
*/
|
|
@@ -3322,6 +3400,10 @@ type ProductArticle = {
|
|
|
3322
3400
|
seller_identifier?: string;
|
|
3323
3401
|
size?: string;
|
|
3324
3402
|
store?: StoreInfo;
|
|
3403
|
+
/**
|
|
3404
|
+
* - A list of article tags
|
|
3405
|
+
*/
|
|
3406
|
+
tags?: string[];
|
|
3325
3407
|
type?: string;
|
|
3326
3408
|
uid?: string;
|
|
3327
3409
|
};
|
|
@@ -3371,6 +3453,18 @@ type PromiseFormatted = {
|
|
|
3371
3453
|
max?: string;
|
|
3372
3454
|
min?: string;
|
|
3373
3455
|
};
|
|
3456
|
+
/** @returns {PromiseISOFormat} */
|
|
3457
|
+
declare function PromiseISOFormat(): PromiseISOFormat;
|
|
3458
|
+
type PromiseISOFormat = {
|
|
3459
|
+
/**
|
|
3460
|
+
* - Max promise in ISO format.
|
|
3461
|
+
*/
|
|
3462
|
+
max?: string;
|
|
3463
|
+
/**
|
|
3464
|
+
* - Min Promise in ISO format.
|
|
3465
|
+
*/
|
|
3466
|
+
min?: string;
|
|
3467
|
+
};
|
|
3374
3468
|
/** @returns {PromiseTimestamp} */
|
|
3375
3469
|
declare function PromiseTimestamp(): PromiseTimestamp;
|
|
3376
3470
|
type PromiseTimestamp = {
|
|
@@ -3606,12 +3700,12 @@ type Restrictions1 = {
|
|
|
3606
3700
|
anonymous_users?: boolean;
|
|
3607
3701
|
order_quantity?: number;
|
|
3608
3702
|
ordering_stores?: number[];
|
|
3609
|
-
payments?:
|
|
3703
|
+
payments?: any;
|
|
3610
3704
|
platforms?: string[];
|
|
3611
3705
|
post_order?: PostOrder1;
|
|
3612
3706
|
user_groups?: number[];
|
|
3613
3707
|
user_id?: string[];
|
|
3614
|
-
user_registered?:
|
|
3708
|
+
user_registered?: UserRegistered;
|
|
3615
3709
|
uses: UsesRestriction1;
|
|
3616
3710
|
};
|
|
3617
3711
|
/** @returns {Rule} */
|
|
@@ -3703,6 +3797,7 @@ type ShipmentArticle = {
|
|
|
3703
3797
|
declare function ShipmentPromise(): ShipmentPromise;
|
|
3704
3798
|
type ShipmentPromise = {
|
|
3705
3799
|
formatted?: PromiseFormatted;
|
|
3800
|
+
iso?: PromiseISOFormat;
|
|
3706
3801
|
timestamp?: PromiseTimestamp;
|
|
3707
3802
|
};
|
|
3708
3803
|
/** @returns {ShippingAddress} */
|
|
@@ -97,6 +97,7 @@ const Joi = require("joi");
|
|
|
97
97
|
* @property {string[]} [product_group_tags]
|
|
98
98
|
* @property {number} [quantity]
|
|
99
99
|
* @property {number} [seller_id]
|
|
100
|
+
* @property {string} [seller_identifier] - Add items using seller identifier for store os
|
|
100
101
|
* @property {number} [store_id]
|
|
101
102
|
*/
|
|
102
103
|
|
|
@@ -116,6 +117,7 @@ const Joi = require("joi");
|
|
|
116
117
|
* @property {number} [article_quantity] - Quantity of article on which
|
|
117
118
|
* promotion is applicable
|
|
118
119
|
* @property {BuyRules[]} [buy_rules] - Buy rules for promotions
|
|
120
|
+
* @property {CartCurrency} [currency]
|
|
119
121
|
* @property {DiscountRulesApp[]} [discount_rules] - Discount rules for promotions
|
|
120
122
|
* @property {boolean} [mrp_promotion] - If applied promotion is applied on
|
|
121
123
|
* product MRP or ESP
|
|
@@ -290,6 +292,7 @@ const Joi = require("joi");
|
|
|
290
292
|
* @property {string} [cart_id]
|
|
291
293
|
* @property {number} [cart_value]
|
|
292
294
|
* @property {string} [created_on]
|
|
295
|
+
* @property {string} [currency_code]
|
|
293
296
|
* @property {number} [item_counts]
|
|
294
297
|
* @property {Object} [pick_up_customer_details]
|
|
295
298
|
* @property {string} [user_id]
|
|
@@ -446,16 +449,19 @@ const Joi = require("joi");
|
|
|
446
449
|
|
|
447
450
|
/**
|
|
448
451
|
* @typedef Coupon
|
|
452
|
+
* @property {string} [coupon_applicable_message]
|
|
449
453
|
* @property {string} [coupon_code]
|
|
450
454
|
* @property {string} [coupon_type]
|
|
451
455
|
* @property {number} [coupon_value]
|
|
452
456
|
* @property {string} [description]
|
|
457
|
+
* @property {string} [end_date]
|
|
453
458
|
* @property {string} [expires_on]
|
|
454
459
|
* @property {boolean} [is_applicable]
|
|
455
460
|
* @property {boolean} [is_applied]
|
|
456
461
|
* @property {number} [max_discount_value]
|
|
457
462
|
* @property {string} [message]
|
|
458
463
|
* @property {number} [minimum_cart_value]
|
|
464
|
+
* @property {string} [start_date]
|
|
459
465
|
* @property {string} [sub_title]
|
|
460
466
|
* @property {string} [title]
|
|
461
467
|
*/
|
|
@@ -910,6 +916,7 @@ const Joi = require("joi");
|
|
|
910
916
|
/**
|
|
911
917
|
* @typedef OverrideCartItemPromo
|
|
912
918
|
* @property {Object[]} [item_list]
|
|
919
|
+
* @property {string} [parent_promo_id]
|
|
913
920
|
* @property {string} promo_amount
|
|
914
921
|
* @property {string} [promo_desc]
|
|
915
922
|
* @property {string} promo_id
|
|
@@ -1059,6 +1066,7 @@ const Joi = require("joi");
|
|
|
1059
1066
|
|
|
1060
1067
|
/**
|
|
1061
1068
|
* @typedef PlatformAddress
|
|
1069
|
+
* @property {Object} [_custom_json]
|
|
1062
1070
|
* @property {string} [address]
|
|
1063
1071
|
* @property {string} [address_type]
|
|
1064
1072
|
* @property {string} [area]
|
|
@@ -1069,6 +1077,8 @@ const Joi = require("joi");
|
|
|
1069
1077
|
* @property {string} [city]
|
|
1070
1078
|
* @property {string} [country]
|
|
1071
1079
|
* @property {string} [country_code]
|
|
1080
|
+
* @property {string} [country_iso_code]
|
|
1081
|
+
* @property {string} [country_phone_code]
|
|
1072
1082
|
* @property {string} [created_by_user_id]
|
|
1073
1083
|
* @property {string} [email]
|
|
1074
1084
|
* @property {GeoLocation} [geo_location]
|
|
@@ -1080,7 +1090,9 @@ const Joi = require("joi");
|
|
|
1080
1090
|
* @property {Object} [meta]
|
|
1081
1091
|
* @property {string} [name]
|
|
1082
1092
|
* @property {string} [phone]
|
|
1093
|
+
* @property {string} [sector]
|
|
1083
1094
|
* @property {string} [state]
|
|
1095
|
+
* @property {string} [state_code] - State code for international address
|
|
1084
1096
|
* @property {string[]} [tags]
|
|
1085
1097
|
* @property {string} [user_id]
|
|
1086
1098
|
*/
|
|
@@ -1248,6 +1260,9 @@ const Joi = require("joi");
|
|
|
1248
1260
|
* authenticated
|
|
1249
1261
|
* @property {string} message - The message associated with the price adjustment
|
|
1250
1262
|
* @property {Object} [meta]
|
|
1263
|
+
* @property {PriceAdjustmentRestrictions} [restrictions] - This field accepts
|
|
1264
|
+
* the restrictions applied to this particular item or service, including
|
|
1265
|
+
* whether or not cancellation and return are allowed, etc
|
|
1251
1266
|
* @property {string} type - Type of price adjusment
|
|
1252
1267
|
* @property {number} value
|
|
1253
1268
|
*/
|
|
@@ -1267,6 +1282,9 @@ const Joi = require("joi");
|
|
|
1267
1282
|
* authenticated
|
|
1268
1283
|
* @property {string} message - The message associated with the price adjustment
|
|
1269
1284
|
* @property {Object} [meta]
|
|
1285
|
+
* @property {PriceAdjustmentRestrictions} [restrictions] - This field accepts
|
|
1286
|
+
* the restrictions applied to this particular item or service, including
|
|
1287
|
+
* whether or not cancellation and return are allowed, etc
|
|
1270
1288
|
* @property {string} type - Type of price adjusment
|
|
1271
1289
|
* @property {number} value
|
|
1272
1290
|
*/
|
|
@@ -1276,6 +1294,12 @@ const Joi = require("joi");
|
|
|
1276
1294
|
* @property {PriceAdjustment} [data]
|
|
1277
1295
|
*/
|
|
1278
1296
|
|
|
1297
|
+
/**
|
|
1298
|
+
* @typedef PriceAdjustmentRestrictions
|
|
1299
|
+
* @property {Object} [post_order] - This field holds the post-order
|
|
1300
|
+
* restrictions, indicated by nested fields ['cancellation_allowed','return_allowed']
|
|
1301
|
+
*/
|
|
1302
|
+
|
|
1279
1303
|
/**
|
|
1280
1304
|
* @typedef PriceAdjustmentUpdate
|
|
1281
1305
|
* @property {boolean} [allowed_refund] - Flag indicating whether refunds are
|
|
@@ -1291,6 +1315,9 @@ const Joi = require("joi");
|
|
|
1291
1315
|
* @property {string} message - The message associated with the price adjustment
|
|
1292
1316
|
* @property {Object} [meta]
|
|
1293
1317
|
* @property {string} [modified_by] - The entity that modified the field
|
|
1318
|
+
* @property {PriceAdjustmentRestrictions} [restrictions] - Restrictions applied
|
|
1319
|
+
* to this particular item or product, including whether or not cancellation
|
|
1320
|
+
* and return are allowed.
|
|
1294
1321
|
* @property {string} type - Type of price adjusment
|
|
1295
1322
|
* @property {number} value
|
|
1296
1323
|
*/
|
|
@@ -1326,6 +1353,7 @@ const Joi = require("joi");
|
|
|
1326
1353
|
* @property {string} [seller_identifier]
|
|
1327
1354
|
* @property {string} [size]
|
|
1328
1355
|
* @property {StoreInfo} [store]
|
|
1356
|
+
* @property {string[]} [tags] - A list of article tags
|
|
1329
1357
|
* @property {string} [type]
|
|
1330
1358
|
* @property {string} [uid]
|
|
1331
1359
|
*/
|
|
@@ -1376,6 +1404,12 @@ const Joi = require("joi");
|
|
|
1376
1404
|
* @property {string} [min]
|
|
1377
1405
|
*/
|
|
1378
1406
|
|
|
1407
|
+
/**
|
|
1408
|
+
* @typedef PromiseISOFormat
|
|
1409
|
+
* @property {string} [max] - Max promise in ISO format.
|
|
1410
|
+
* @property {string} [min] - Min Promise in ISO format.
|
|
1411
|
+
*/
|
|
1412
|
+
|
|
1379
1413
|
/**
|
|
1380
1414
|
* @typedef PromiseTimestamp
|
|
1381
1415
|
* @property {number} [max]
|
|
@@ -1556,12 +1590,12 @@ const Joi = require("joi");
|
|
|
1556
1590
|
* @property {boolean} [anonymous_users]
|
|
1557
1591
|
* @property {number} [order_quantity]
|
|
1558
1592
|
* @property {number[]} [ordering_stores]
|
|
1559
|
-
* @property {
|
|
1593
|
+
* @property {Object} [payments]
|
|
1560
1594
|
* @property {string[]} [platforms]
|
|
1561
1595
|
* @property {PostOrder1} [post_order]
|
|
1562
1596
|
* @property {number[]} [user_groups]
|
|
1563
1597
|
* @property {string[]} [user_id]
|
|
1564
|
-
* @property {
|
|
1598
|
+
* @property {UserRegistered} [user_registered]
|
|
1565
1599
|
* @property {UsesRestriction1} uses
|
|
1566
1600
|
*/
|
|
1567
1601
|
|
|
@@ -1641,6 +1675,7 @@ const Joi = require("joi");
|
|
|
1641
1675
|
/**
|
|
1642
1676
|
* @typedef ShipmentPromise
|
|
1643
1677
|
* @property {PromiseFormatted} [formatted]
|
|
1678
|
+
* @property {PromiseISOFormat} [iso]
|
|
1644
1679
|
* @property {PromiseTimestamp} [timestamp]
|
|
1645
1680
|
*/
|
|
1646
1681
|
|
|
@@ -1974,6 +2009,7 @@ class CartPlatformModel {
|
|
|
1974
2009
|
product_group_tags: Joi.array().items(Joi.string().allow("").allow(null)),
|
|
1975
2010
|
quantity: Joi.number(),
|
|
1976
2011
|
seller_id: Joi.number(),
|
|
2012
|
+
seller_identifier: Joi.string().allow(""),
|
|
1977
2013
|
store_id: Joi.number(),
|
|
1978
2014
|
});
|
|
1979
2015
|
}
|
|
@@ -1997,6 +2033,7 @@ class CartPlatformModel {
|
|
|
1997
2033
|
),
|
|
1998
2034
|
article_quantity: Joi.number(),
|
|
1999
2035
|
buy_rules: Joi.array().items(CartPlatformModel.BuyRules()),
|
|
2036
|
+
currency: CartPlatformModel.CartCurrency(),
|
|
2000
2037
|
discount_rules: Joi.array().items(CartPlatformModel.DiscountRulesApp()),
|
|
2001
2038
|
mrp_promotion: Joi.boolean(),
|
|
2002
2039
|
offer_text: Joi.string().allow(""),
|
|
@@ -2209,6 +2246,7 @@ class CartPlatformModel {
|
|
|
2209
2246
|
cart_id: Joi.string().allow(""),
|
|
2210
2247
|
cart_value: Joi.number(),
|
|
2211
2248
|
created_on: Joi.string().allow(""),
|
|
2249
|
+
currency_code: Joi.string().allow(""),
|
|
2212
2250
|
item_counts: Joi.number(),
|
|
2213
2251
|
pick_up_customer_details: Joi.any(),
|
|
2214
2252
|
user_id: Joi.string().allow(""),
|
|
@@ -2394,16 +2432,19 @@ class CartPlatformModel {
|
|
|
2394
2432
|
/** @returns {Coupon} */
|
|
2395
2433
|
static Coupon() {
|
|
2396
2434
|
return Joi.object({
|
|
2435
|
+
coupon_applicable_message: Joi.string().allow(""),
|
|
2397
2436
|
coupon_code: Joi.string().allow(""),
|
|
2398
2437
|
coupon_type: Joi.string().allow("").allow(null),
|
|
2399
2438
|
coupon_value: Joi.number(),
|
|
2400
2439
|
description: Joi.string().allow("").allow(null),
|
|
2440
|
+
end_date: Joi.string().allow("").allow(null),
|
|
2401
2441
|
expires_on: Joi.string().allow(""),
|
|
2402
2442
|
is_applicable: Joi.boolean(),
|
|
2403
2443
|
is_applied: Joi.boolean(),
|
|
2404
2444
|
max_discount_value: Joi.number(),
|
|
2405
2445
|
message: Joi.string().allow(""),
|
|
2406
2446
|
minimum_cart_value: Joi.number(),
|
|
2447
|
+
start_date: Joi.string().allow("").allow(null),
|
|
2407
2448
|
sub_title: Joi.string().allow(""),
|
|
2408
2449
|
title: Joi.string().allow(""),
|
|
2409
2450
|
});
|
|
@@ -2957,6 +2998,7 @@ class CartPlatformModel {
|
|
|
2957
2998
|
static OverrideCartItemPromo() {
|
|
2958
2999
|
return Joi.object({
|
|
2959
3000
|
item_list: Joi.array().items(Joi.any().allow(null)),
|
|
3001
|
+
parent_promo_id: Joi.string().allow(""),
|
|
2960
3002
|
promo_amount: Joi.string().allow("").required(),
|
|
2961
3003
|
promo_desc: Joi.string().allow(""),
|
|
2962
3004
|
promo_id: Joi.string().allow("").required(),
|
|
@@ -3142,6 +3184,7 @@ class CartPlatformModel {
|
|
|
3142
3184
|
/** @returns {PlatformAddress} */
|
|
3143
3185
|
static PlatformAddress() {
|
|
3144
3186
|
return Joi.object({
|
|
3187
|
+
_custom_json: Joi.any(),
|
|
3145
3188
|
address: Joi.string().allow(""),
|
|
3146
3189
|
address_type: Joi.string().allow(""),
|
|
3147
3190
|
area: Joi.string().allow(""),
|
|
@@ -3152,6 +3195,8 @@ class CartPlatformModel {
|
|
|
3152
3195
|
city: Joi.string().allow(""),
|
|
3153
3196
|
country: Joi.string().allow(""),
|
|
3154
3197
|
country_code: Joi.string().allow(""),
|
|
3198
|
+
country_iso_code: Joi.string().allow(""),
|
|
3199
|
+
country_phone_code: Joi.string().allow(""),
|
|
3155
3200
|
created_by_user_id: Joi.string().allow(""),
|
|
3156
3201
|
email: Joi.string().allow(""),
|
|
3157
3202
|
geo_location: CartPlatformModel.GeoLocation(),
|
|
@@ -3163,7 +3208,9 @@ class CartPlatformModel {
|
|
|
3163
3208
|
meta: Joi.any(),
|
|
3164
3209
|
name: Joi.string().allow(""),
|
|
3165
3210
|
phone: Joi.string().allow(""),
|
|
3211
|
+
sector: Joi.string().allow(""),
|
|
3166
3212
|
state: Joi.string().allow(""),
|
|
3213
|
+
state_code: Joi.string().allow(""),
|
|
3167
3214
|
tags: Joi.array().items(Joi.string().allow("")),
|
|
3168
3215
|
user_id: Joi.string().allow(""),
|
|
3169
3216
|
});
|
|
@@ -3357,6 +3404,7 @@ class CartPlatformModel {
|
|
|
3357
3404
|
is_authenticated: Joi.boolean().required(),
|
|
3358
3405
|
message: Joi.string().allow("").required(),
|
|
3359
3406
|
meta: Joi.any(),
|
|
3407
|
+
restrictions: CartPlatformModel.PriceAdjustmentRestrictions(),
|
|
3360
3408
|
type: Joi.string().allow("").required(),
|
|
3361
3409
|
value: Joi.number().required(),
|
|
3362
3410
|
});
|
|
@@ -3375,6 +3423,7 @@ class CartPlatformModel {
|
|
|
3375
3423
|
is_authenticated: Joi.boolean().required(),
|
|
3376
3424
|
message: Joi.string().allow("").required(),
|
|
3377
3425
|
meta: Joi.any(),
|
|
3426
|
+
restrictions: CartPlatformModel.PriceAdjustmentRestrictions(),
|
|
3378
3427
|
type: Joi.string().allow("").required(),
|
|
3379
3428
|
value: Joi.number().required(),
|
|
3380
3429
|
});
|
|
@@ -3387,6 +3436,13 @@ class CartPlatformModel {
|
|
|
3387
3436
|
});
|
|
3388
3437
|
}
|
|
3389
3438
|
|
|
3439
|
+
/** @returns {PriceAdjustmentRestrictions} */
|
|
3440
|
+
static PriceAdjustmentRestrictions() {
|
|
3441
|
+
return Joi.object({
|
|
3442
|
+
post_order: Joi.any(),
|
|
3443
|
+
});
|
|
3444
|
+
}
|
|
3445
|
+
|
|
3390
3446
|
/** @returns {PriceAdjustmentUpdate} */
|
|
3391
3447
|
static PriceAdjustmentUpdate() {
|
|
3392
3448
|
return Joi.object({
|
|
@@ -3400,6 +3456,7 @@ class CartPlatformModel {
|
|
|
3400
3456
|
message: Joi.string().allow("").required(),
|
|
3401
3457
|
meta: Joi.any(),
|
|
3402
3458
|
modified_by: Joi.string().allow(""),
|
|
3459
|
+
restrictions: CartPlatformModel.PriceAdjustmentRestrictions(),
|
|
3403
3460
|
type: Joi.string().allow("").required(),
|
|
3404
3461
|
value: Joi.number().required(),
|
|
3405
3462
|
});
|
|
@@ -3441,6 +3498,7 @@ class CartPlatformModel {
|
|
|
3441
3498
|
seller_identifier: Joi.string().allow(""),
|
|
3442
3499
|
size: Joi.string().allow(""),
|
|
3443
3500
|
store: CartPlatformModel.StoreInfo(),
|
|
3501
|
+
tags: Joi.array().items(Joi.string().allow("")),
|
|
3444
3502
|
type: Joi.string().allow(""),
|
|
3445
3503
|
uid: Joi.string().allow(""),
|
|
3446
3504
|
});
|
|
@@ -3506,6 +3564,14 @@ class CartPlatformModel {
|
|
|
3506
3564
|
});
|
|
3507
3565
|
}
|
|
3508
3566
|
|
|
3567
|
+
/** @returns {PromiseISOFormat} */
|
|
3568
|
+
static PromiseISOFormat() {
|
|
3569
|
+
return Joi.object({
|
|
3570
|
+
max: Joi.string().allow(""),
|
|
3571
|
+
min: Joi.string().allow(""),
|
|
3572
|
+
});
|
|
3573
|
+
}
|
|
3574
|
+
|
|
3509
3575
|
/** @returns {PromiseTimestamp} */
|
|
3510
3576
|
static PromiseTimestamp() {
|
|
3511
3577
|
return Joi.object({
|
|
@@ -3720,12 +3786,12 @@ class CartPlatformModel {
|
|
|
3720
3786
|
anonymous_users: Joi.boolean(),
|
|
3721
3787
|
order_quantity: Joi.number(),
|
|
3722
3788
|
ordering_stores: Joi.array().items(Joi.number()),
|
|
3723
|
-
payments: Joi.
|
|
3789
|
+
payments: Joi.any(),
|
|
3724
3790
|
platforms: Joi.array().items(Joi.string().allow("")),
|
|
3725
3791
|
post_order: CartPlatformModel.PostOrder1(),
|
|
3726
3792
|
user_groups: Joi.array().items(Joi.number()),
|
|
3727
3793
|
user_id: Joi.array().items(Joi.string().allow("")),
|
|
3728
|
-
user_registered:
|
|
3794
|
+
user_registered: CartPlatformModel.UserRegistered(),
|
|
3729
3795
|
uses: CartPlatformModel.UsesRestriction1().required(),
|
|
3730
3796
|
});
|
|
3731
3797
|
}
|
|
@@ -3821,6 +3887,7 @@ class CartPlatformModel {
|
|
|
3821
3887
|
static ShipmentPromise() {
|
|
3822
3888
|
return Joi.object({
|
|
3823
3889
|
formatted: CartPlatformModel.PromiseFormatted(),
|
|
3890
|
+
iso: CartPlatformModel.PromiseISOFormat(),
|
|
3824
3891
|
timestamp: CartPlatformModel.PromiseTimestamp(),
|
|
3825
3892
|
});
|
|
3826
3893
|
}
|