@gofynd/fdk-client-javascript 1.4.13 → 1.4.14
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/ApplicationClient.d.ts +2 -0
- package/sdk/application/ApplicationClient.js +2 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +60 -53
- package/sdk/application/Cart/CartApplicationClient.js +130 -53
- package/sdk/application/Cart/CartApplicationModel.d.ts +489 -143
- package/sdk/application/Cart/CartApplicationModel.js +380 -159
- package/sdk/application/Cart/CartApplicationValidator.d.ts +38 -19
- package/sdk/application/Cart/CartApplicationValidator.js +34 -18
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +88 -68
- package/sdk/application/Catalog/CatalogApplicationClient.js +114 -94
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +194 -142
- package/sdk/application/Catalog/CatalogApplicationModel.js +171 -133
- package/sdk/application/Common/CommonApplicationClient.d.ts +3 -2
- package/sdk/application/Common/CommonApplicationClient.js +6 -5
- package/sdk/application/Common/CommonApplicationModel.d.ts +9 -9
- package/sdk/application/Common/CommonApplicationModel.js +6 -6
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +34 -27
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +34 -27
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +45 -57
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +35 -47
- package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +2 -2
- package/sdk/application/Configuration/ConfigurationApplicationValidator.js +2 -2
- package/sdk/application/Content/ContentApplicationClient.d.ts +23 -33
- package/sdk/application/Content/ContentApplicationClient.js +54 -75
- package/sdk/application/Content/ContentApplicationModel.d.ts +93 -37
- package/sdk/application/Content/ContentApplicationModel.js +83 -32
- package/sdk/application/Content/ContentApplicationValidator.d.ts +23 -17
- package/sdk/application/Content/ContentApplicationValidator.js +15 -10
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +9 -8
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +14 -13
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +23 -25
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +16 -18
- package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +6 -6
- package/sdk/application/FileStorage/FileStorageApplicationValidator.js +6 -6
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +36 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +202 -0
- package/sdk/application/Finance/FinanceApplicationModel.d.ts +289 -0
- package/sdk/application/Finance/FinanceApplicationModel.js +208 -0
- package/sdk/application/Finance/FinanceApplicationValidator.d.ts +25 -0
- package/sdk/application/Finance/FinanceApplicationValidator.js +31 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +2 -3
- package/sdk/application/Lead/LeadApplicationClient.js +2 -3
- package/sdk/application/Lead/LeadApplicationModel.d.ts +11 -11
- package/sdk/application/Lead/LeadApplicationModel.js +19 -19
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +39 -16
- package/sdk/application/Logistic/LogisticApplicationClient.js +189 -21
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +532 -173
- package/sdk/application/Logistic/LogisticApplicationModel.js +409 -139
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +54 -9
- package/sdk/application/Logistic/LogisticApplicationValidator.js +42 -8
- package/sdk/application/Order/OrderApplicationClient.d.ts +24 -10
- package/sdk/application/Order/OrderApplicationClient.js +96 -13
- package/sdk/application/Order/OrderApplicationModel.d.ts +434 -102
- package/sdk/application/Order/OrderApplicationModel.js +278 -73
- package/sdk/application/Order/OrderApplicationValidator.d.ts +17 -3
- package/sdk/application/Order/OrderApplicationValidator.js +15 -2
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +96 -99
- package/sdk/application/Payment/PaymentApplicationClient.js +111 -114
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +293 -289
- package/sdk/application/Payment/PaymentApplicationModel.js +243 -241
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +46 -46
- package/sdk/application/Payment/PaymentApplicationValidator.js +46 -46
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -16
- package/sdk/application/Rewards/RewardsApplicationClient.js +19 -22
- package/sdk/application/Rewards/RewardsApplicationModel.d.ts +37 -37
- package/sdk/application/Rewards/RewardsApplicationModel.js +29 -29
- package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +6 -6
- package/sdk/application/Rewards/RewardsApplicationValidator.js +6 -6
- package/sdk/application/Share/ShareApplicationModel.js +1 -1
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +2 -2
- package/sdk/application/Theme/ThemeApplicationClient.js +8 -6
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +48 -17
- package/sdk/application/Theme/ThemeApplicationModel.js +42 -22
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +16 -3
- package/sdk/application/Theme/ThemeApplicationValidator.js +9 -2
- package/sdk/application/User/UserApplicationClient.d.ts +10 -10
- package/sdk/application/User/UserApplicationClient.js +10 -10
- package/sdk/application/User/UserApplicationModel.d.ts +17 -17
- package/sdk/application/User/UserApplicationModel.js +16 -16
- package/sdk/application/User/UserApplicationValidator.d.ts +2 -2
- package/sdk/application/User/UserApplicationValidator.js +2 -2
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +4 -4
- package/sdk/application/Webhook/WebhookApplicationModel.d.ts +11 -9
- package/sdk/application/Webhook/WebhookApplicationModel.js +8 -6
- package/sdk/application/Webhook/WebhookApplicationValidator.d.ts +2 -2
- package/sdk/application/Webhook/WebhookApplicationValidator.js +2 -2
- package/sdk/application/index.d.ts +1 -0
- package/sdk/application/index.js +2 -0
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +86 -12
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +582 -24
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +116 -19
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +121 -14
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +8 -1
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +51 -4
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
- package/sdk/partner/Lead/LeadPartnerClient.js +2 -2
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerModel.js +15 -15
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +126 -20
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +970 -20
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +767 -85
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +429 -76
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +10 -0
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +120 -6
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +8 -10
- package/sdk/partner/Theme/ThemePartnerClient.js +14 -16
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +96 -37
- package/sdk/partner/Theme/ThemePartnerModel.js +90 -36
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +28 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +103 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +612 -179
- package/sdk/partner/Webhook/WebhookPartnerModel.js +253 -150
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +1 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +11 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +5 -4
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +14 -8
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +59 -9
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +40 -4
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +2 -32
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -243
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +11 -130
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +12 -152
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
- package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
- package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +134 -103
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +407 -112
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +111 -65
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +106 -44
- package/sdk/platform/Cart/CartPlatformModel.d.ts +4978 -1303
- package/sdk/platform/Cart/CartPlatformModel.js +1922 -1217
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +208 -183
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +383 -358
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +122 -126
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +66 -68
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +141 -118
- package/sdk/platform/Catalog/CatalogPlatformClient.js +193 -170
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1516 -1766
- package/sdk/platform/Catalog/CatalogPlatformModel.js +1393 -1224
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +18 -18
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +18 -18
- package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -2
- package/sdk/platform/Common/CommonPlatformClient.js +3 -2
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +16 -17
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +16 -17
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +43 -33
- package/sdk/platform/Communication/CommunicationPlatformModel.js +38 -34
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +46 -42
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +47 -43
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +210 -212
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +46 -33
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +67 -54
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +45 -24
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +134 -30
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +283 -124
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +219 -94
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +124 -141
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +449 -422
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +179 -141
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +168 -130
- package/sdk/platform/Content/ContentPlatformClient.d.ts +142 -106
- package/sdk/platform/Content/ContentPlatformClient.js +523 -336
- package/sdk/platform/Content/ContentPlatformModel.d.ts +1241 -395
- package/sdk/platform/Content/ContentPlatformModel.js +521 -390
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +168 -117
- package/sdk/platform/Content/ContentPlatformValidator.js +162 -108
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +14 -12
- package/sdk/platform/Discount/DiscountPlatformClient.js +14 -12
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +13 -13
- package/sdk/platform/Discount/DiscountPlatformModel.js +12 -12
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +94 -36
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +462 -60
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +62 -15
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +75 -13
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +19 -19
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +21 -21
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +370 -101
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +313 -84
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +2 -2
- package/sdk/platform/Lead/LeadPlatformClient.js +2 -2
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -5
- package/sdk/platform/Lead/LeadPlatformModel.js +16 -16
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +15 -4
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +83 -5
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +25 -4
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +16 -3
- package/sdk/platform/Order/OrderPlatformClient.d.ts +178 -97
- package/sdk/platform/Order/OrderPlatformClient.js +589 -229
- package/sdk/platform/Order/OrderPlatformModel.d.ts +5447 -3071
- package/sdk/platform/Order/OrderPlatformModel.js +3496 -1653
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +241 -176
- package/sdk/platform/Order/OrderPlatformValidator.js +153 -97
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +9 -7
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
- package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +93 -105
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +129 -141
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +48 -48
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +48 -48
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
- package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +327 -313
- package/sdk/platform/Payment/PaymentPlatformModel.js +283 -273
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
- package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
- package/sdk/platform/PlatformClient.d.ts +0 -2
- package/sdk/platform/PlatformClient.js +0 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +9 -9
- package/sdk/platform/Rewards/RewardsPlatformModel.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +45 -35
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +117 -38
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +22 -13
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +24 -12
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +40 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +58 -64
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +602 -341
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +483 -284
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +8 -8
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.js +2 -2
- package/sdk/platform/Share/SharePlatformModel.d.ts +36 -5
- package/sdk/platform/Share/SharePlatformModel.js +27 -4
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +8 -4
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +5 -0
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +2 -0
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +37 -11
- package/sdk/platform/Theme/ThemePlatformModel.js +33 -15
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/User/UserPlatformApplicationClient.js +12 -12
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/User/UserPlatformApplicationValidator.js +2 -2
- package/sdk/platform/User/UserPlatformModel.d.ts +21 -21
- package/sdk/platform/User/UserPlatformModel.js +23 -23
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +25 -78
- package/sdk/platform/Webhook/WebhookPlatformClient.js +75 -470
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +720 -427
- package/sdk/platform/Webhook/WebhookPlatformModel.js +410 -386
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
- package/sdk/platform/index.d.ts +0 -1
- package/sdk/platform/index.js +0 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +3 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +6 -5
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
- package/sdk/public/Content/ContentPublicClient.d.ts +112 -2
- package/sdk/public/Content/ContentPublicClient.js +791 -5
- package/sdk/public/Content/ContentPublicModel.d.ts +549 -3
- package/sdk/public/Content/ContentPublicModel.js +649 -3
- package/sdk/public/Content/ContentPublicValidator.d.ts +69 -3
- package/sdk/public/Content/ContentPublicValidator.js +88 -2
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +21 -21
- package/sdk/public/Webhook/WebhookPublicModel.js +15 -15
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
- package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2890
- package/sdk/platform/Finance/FinancePlatformModel.js +0 -2148
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
- package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
|
@@ -16,6 +16,15 @@ export = CartApplicationModel;
|
|
|
16
16
|
* @property {string} [payable_category] - Promotion amount payable category.
|
|
17
17
|
* @property {string} [payable_by] - Promotion amount bearable party.
|
|
18
18
|
*/
|
|
19
|
+
/**
|
|
20
|
+
* @typedef FreeGiftItem
|
|
21
|
+
* @property {string} [item_slug] - Item slug.
|
|
22
|
+
* @property {string} [item_name] - Item name.
|
|
23
|
+
* @property {Object} [item_price_details] - Item price details.
|
|
24
|
+
* @property {string} [item_brand_name] - Item brand name.
|
|
25
|
+
* @property {number} [item_id] - Item id.
|
|
26
|
+
* @property {string[]} [item_images_url] - Item images URL.
|
|
27
|
+
*/
|
|
19
28
|
/**
|
|
20
29
|
* @typedef AppliedFreeArticles
|
|
21
30
|
* @property {FreeGiftItems} [free_gift_item_details] - Free gift items details.
|
|
@@ -208,11 +217,22 @@ export = CartApplicationModel;
|
|
|
208
217
|
* @typedef ActionQuery
|
|
209
218
|
* @property {string[]} [product_slug] - Contains list of product slug.
|
|
210
219
|
*/
|
|
220
|
+
/**
|
|
221
|
+
* @typedef ProductActionParams
|
|
222
|
+
* @property {string[]} [slug] - Unique product url name generated via product
|
|
223
|
+
* name and other meta data.
|
|
224
|
+
*/
|
|
225
|
+
/**
|
|
226
|
+
* @typedef ProductActionPage
|
|
227
|
+
* @property {string} [type] - Entity of page to be redirected on click
|
|
228
|
+
* @property {ProductActionParams} [params]
|
|
229
|
+
*/
|
|
211
230
|
/**
|
|
212
231
|
* @typedef ProductAction
|
|
213
232
|
* @property {ActionQuery} [query]
|
|
214
|
-
* @property {string} [url] - Url of the product to render the product
|
|
233
|
+
* @property {string} [url] - Url of the product to render the product
|
|
215
234
|
* @property {string} [type] - Type of action.
|
|
235
|
+
* @property {ProductActionPage} [page]
|
|
216
236
|
*/
|
|
217
237
|
/**
|
|
218
238
|
* @typedef Tags
|
|
@@ -410,7 +430,7 @@ export = CartApplicationModel;
|
|
|
410
430
|
* @property {DeliveryChargesConfig} [delivery_charges_config]
|
|
411
431
|
*/
|
|
412
432
|
/**
|
|
413
|
-
* @typedef
|
|
433
|
+
* @typedef CartDetailResult
|
|
414
434
|
* @property {number} [cart_id] - Unique identifier of the user cart.
|
|
415
435
|
* @property {string} [uid] - Unique identifier of the user cart.
|
|
416
436
|
* @property {AppliedPromotion[]} [applied_promo_details] - List of applied
|
|
@@ -480,18 +500,18 @@ export = CartApplicationModel;
|
|
|
480
500
|
* for store os.
|
|
481
501
|
*/
|
|
482
502
|
/**
|
|
483
|
-
* @typedef
|
|
503
|
+
* @typedef AddCartCreation
|
|
484
504
|
* @property {AddProductCart[]} [items] - List of items detail which need to be
|
|
485
505
|
* added to cart like item id, item size, and item quantity.
|
|
486
506
|
* @property {boolean} [new_cart] - Field to create to new cart whille user adds
|
|
487
507
|
* item to cart.
|
|
488
508
|
*/
|
|
489
509
|
/**
|
|
490
|
-
* @typedef
|
|
510
|
+
* @typedef AddCartDetailResult
|
|
491
511
|
* @property {string} [message] - Message of add to cart API response.
|
|
492
512
|
* @property {boolean} [partial] - When adding multiple items check if all
|
|
493
513
|
* added. True if only few are added.
|
|
494
|
-
* @property {
|
|
514
|
+
* @property {CartDetailResult} [cart]
|
|
495
515
|
* @property {boolean} [success] - True if all items are added successfully.
|
|
496
516
|
* False if partially added or not added.
|
|
497
517
|
*/
|
|
@@ -511,27 +531,35 @@ export = CartApplicationModel;
|
|
|
511
531
|
* @property {Object} [meta] - Field to update meta of the item in cart.
|
|
512
532
|
*/
|
|
513
533
|
/**
|
|
514
|
-
* @typedef
|
|
534
|
+
* @typedef FreeGiftItemCreation
|
|
535
|
+
* @property {string} promotion_id - Unique identifier of the free gift promotion.
|
|
536
|
+
* @property {string} item_id - Unique identifier of the selected free gift item.
|
|
537
|
+
* @property {string} item_size - Size of the selected free gift item.
|
|
538
|
+
*/
|
|
539
|
+
/**
|
|
540
|
+
* @typedef UpdateCartCreation
|
|
515
541
|
* @property {UpdateProductCart[]} [items] - List items data that needs to be
|
|
516
542
|
* updated in cart.
|
|
543
|
+
* @property {FreeGiftItemCreation[]} [free_gift_items] - List of free gift
|
|
544
|
+
* items with updated sizes.
|
|
517
545
|
* @property {string} operation - Field to determine if item to be removed from
|
|
518
546
|
* cart or it needs to be updated.
|
|
519
547
|
*/
|
|
520
548
|
/**
|
|
521
|
-
* @typedef
|
|
549
|
+
* @typedef UpdateCartDetailResult
|
|
522
550
|
* @property {string} [message] - Message of update cart API response.
|
|
523
|
-
* @property {
|
|
551
|
+
* @property {CartDetailResult} [cart]
|
|
524
552
|
* @property {boolean} [success] - True if all items are added successfully.
|
|
525
553
|
* False if partially added or not added.
|
|
526
554
|
*/
|
|
527
555
|
/**
|
|
528
|
-
* @typedef
|
|
556
|
+
* @typedef DeleteCartDetailResult
|
|
529
557
|
* @property {string} [message] - Message for delete cart response.
|
|
530
558
|
* @property {boolean} [success] - True if cart is archived successfully. False
|
|
531
559
|
* if not archived.
|
|
532
560
|
*/
|
|
533
561
|
/**
|
|
534
|
-
* @typedef
|
|
562
|
+
* @typedef CartItemCountResult
|
|
535
563
|
* @property {number} [user_cart_items_count] - Item count present in cart.
|
|
536
564
|
*/
|
|
537
565
|
/**
|
|
@@ -575,13 +603,13 @@ export = CartApplicationModel;
|
|
|
575
603
|
* coupon is applicable for only if payment done by bank or mode specified in coupon.
|
|
576
604
|
*/
|
|
577
605
|
/**
|
|
578
|
-
* @typedef
|
|
606
|
+
* @typedef GetCouponResult
|
|
579
607
|
* @property {PageCoupon} [page]
|
|
580
608
|
* @property {Coupon[]} [available_coupon_list] - List of available coupon which
|
|
581
609
|
* can be applied on cart.
|
|
582
610
|
*/
|
|
583
611
|
/**
|
|
584
|
-
* @typedef
|
|
612
|
+
* @typedef ApplyCoupon
|
|
585
613
|
* @property {string} coupon_code - Coupon code to be applied.
|
|
586
614
|
*/
|
|
587
615
|
/**
|
|
@@ -621,12 +649,12 @@ export = CartApplicationModel;
|
|
|
621
649
|
* @property {OfferSeller} [seller]
|
|
622
650
|
*/
|
|
623
651
|
/**
|
|
624
|
-
* @typedef
|
|
652
|
+
* @typedef BulkPriceResult
|
|
625
653
|
* @property {BulkPriceOffer[]} [data] - Actual data to be in response consist
|
|
626
654
|
* of offers from multiple seller.
|
|
627
655
|
*/
|
|
628
656
|
/**
|
|
629
|
-
* @typedef
|
|
657
|
+
* @typedef RewardPointCreation
|
|
630
658
|
* @property {boolean} points - Points to be applied for cart.
|
|
631
659
|
*/
|
|
632
660
|
/**
|
|
@@ -669,20 +697,26 @@ export = CartApplicationModel;
|
|
|
669
697
|
* @property {Object} [meta] - Metadata of the address.
|
|
670
698
|
*/
|
|
671
699
|
/**
|
|
672
|
-
* @typedef
|
|
700
|
+
* @typedef ValidationConfig
|
|
701
|
+
* @property {number} address_max_limit - The maximum number of addresses a user can have.
|
|
702
|
+
* @property {number} user_address_count - The total number of addresses saved by a user.
|
|
703
|
+
*/
|
|
704
|
+
/**
|
|
705
|
+
* @typedef GetAddressesResult
|
|
673
706
|
* @property {boolean} [pii_masking] - Personally Identifiable Information
|
|
674
707
|
* masking flag to denote if the user data in address is masked or not.
|
|
675
708
|
* @property {Address[]} [address] - Address description for address data.
|
|
709
|
+
* @property {ValidationConfig} [validation_config]
|
|
676
710
|
*/
|
|
677
711
|
/**
|
|
678
|
-
* @typedef
|
|
712
|
+
* @typedef SaveAddressResult
|
|
679
713
|
* @property {string} [id] - Id of the address.
|
|
680
|
-
* @property {boolean} [success] - Success flag of save address
|
|
714
|
+
* @property {boolean} [success] - Success flag of save address Result.
|
|
681
715
|
* @property {boolean} [is_default_address] - Default address flag if no address
|
|
682
716
|
* selected then this should be the default address selected.
|
|
683
717
|
*/
|
|
684
718
|
/**
|
|
685
|
-
* @typedef
|
|
719
|
+
* @typedef UpdateAddressResult
|
|
686
720
|
* @property {boolean} [is_updated] - Updated flag for update address operation
|
|
687
721
|
* if the address updated or not.
|
|
688
722
|
* @property {string} [id] - ID of an address.
|
|
@@ -691,13 +725,13 @@ export = CartApplicationModel;
|
|
|
691
725
|
* selected then this should be the default address selected.
|
|
692
726
|
*/
|
|
693
727
|
/**
|
|
694
|
-
* @typedef
|
|
728
|
+
* @typedef DeleteAddressResult
|
|
695
729
|
* @property {string} [id] - Id of the address.
|
|
696
730
|
* @property {boolean} [is_deleted] - Deleted flag in delete address response
|
|
697
731
|
* states whether the address was deleted or not.
|
|
698
732
|
*/
|
|
699
733
|
/**
|
|
700
|
-
* @typedef
|
|
734
|
+
* @typedef SelectCartAddressCreation
|
|
701
735
|
* @property {string} [id] - Address is selected by user on which shipment to be
|
|
702
736
|
* delivered.
|
|
703
737
|
* @property {string} [billing_address_id] - Billing address id selected by user
|
|
@@ -706,7 +740,7 @@ export = CartApplicationModel;
|
|
|
706
740
|
* address operation performed.
|
|
707
741
|
*/
|
|
708
742
|
/**
|
|
709
|
-
* @typedef
|
|
743
|
+
* @typedef UpdateCartPaymentCreation
|
|
710
744
|
* @property {string} [id] - Cart id of the user cart for which the update cart
|
|
711
745
|
* payment operation performed.
|
|
712
746
|
* @property {string} [payment_identifier] - Payment identifier of the payment
|
|
@@ -729,6 +763,7 @@ export = CartApplicationModel;
|
|
|
729
763
|
* is valid or not.
|
|
730
764
|
* @property {string} [display_message_en] - Display message for coupon validity.
|
|
731
765
|
* @property {string} [code] - Coupon code of the coupon applied.
|
|
766
|
+
* @property {string} [error_en] - Error message for the selected payment mode.
|
|
732
767
|
*/
|
|
733
768
|
/**
|
|
734
769
|
* @typedef PaymentCouponValidate
|
|
@@ -738,7 +773,7 @@ export = CartApplicationModel;
|
|
|
738
773
|
* API response.
|
|
739
774
|
*/
|
|
740
775
|
/**
|
|
741
|
-
* @typedef
|
|
776
|
+
* @typedef ShipmentResult
|
|
742
777
|
* @property {number} [shipments] - Count of shipments that will be shipped.
|
|
743
778
|
* @property {ShipmentPromise} [promise]
|
|
744
779
|
* @property {string} [order_type] - Order type of the shipment like pickAtStore
|
|
@@ -756,11 +791,11 @@ export = CartApplicationModel;
|
|
|
756
791
|
* @property {number} [fulfillment_id] - Fulfilment id of the shipment.
|
|
757
792
|
*/
|
|
758
793
|
/**
|
|
759
|
-
* @typedef
|
|
794
|
+
* @typedef CartShipmentsResult
|
|
760
795
|
* @property {string} [delivery_charge_info] - Delivery charge in information
|
|
761
796
|
* message on shipment.
|
|
762
797
|
* @property {string} [checkout_mode] - Checkout mode of cart.
|
|
763
|
-
* @property {string} [message] -
|
|
798
|
+
* @property {string} [message] - Result message of get shipments API.
|
|
764
799
|
* @property {string} [gstin] - GSTIN number added in cart.
|
|
765
800
|
* @property {boolean} [restrict_checkout] - Restrict checkout flag to restrict
|
|
766
801
|
* the checkout process.
|
|
@@ -771,7 +806,7 @@ export = CartApplicationModel;
|
|
|
771
806
|
* @property {CartBreakup} [breakup_values]
|
|
772
807
|
* @property {CartCurrency} [currency]
|
|
773
808
|
* @property {string} [id] - Cart id of the user cart.
|
|
774
|
-
* @property {
|
|
809
|
+
* @property {ShipmentResult[]} [shipments] - List of Shipments which includes
|
|
775
810
|
* shipment data like shipment items, shipment promise, Shipment type,
|
|
776
811
|
* shipment order type, shipment dp options etc.
|
|
777
812
|
* @property {PaymentSelectionLock} [payment_selection_lock]
|
|
@@ -785,6 +820,11 @@ export = CartApplicationModel;
|
|
|
785
820
|
* @property {Object} [custom_cart_meta] - Custom meta details added cart
|
|
786
821
|
* checkout API payload.
|
|
787
822
|
*/
|
|
823
|
+
/**
|
|
824
|
+
* @typedef CartCheckoutCustomMeta
|
|
825
|
+
* @property {string} key - Key name of custom meta.
|
|
826
|
+
* @property {string} value - Value to be added in key.
|
|
827
|
+
*/
|
|
788
828
|
/**
|
|
789
829
|
* @typedef CustomerDetails
|
|
790
830
|
* @property {string} [email] - Email address of the customer to be added in
|
|
@@ -806,6 +846,51 @@ export = CartApplicationModel;
|
|
|
806
846
|
* on behalf of customer.
|
|
807
847
|
* @property {string} _id - Id of staff who does checkout on behalf of customer.
|
|
808
848
|
*/
|
|
849
|
+
/**
|
|
850
|
+
* @typedef CartCheckoutDetailCreation
|
|
851
|
+
* @property {CartCheckoutCustomMeta[]} [custom_meta] - Custom meta data to be
|
|
852
|
+
* added in order.
|
|
853
|
+
* @property {CustomerDetails} [customer_details] - Customer details to be added in order.
|
|
854
|
+
* @property {string} [merchant_code] - Merchant code of the payment mode
|
|
855
|
+
* selected to do the payment.
|
|
856
|
+
* @property {string} [id] - Cart id of the user cart.
|
|
857
|
+
* @property {boolean} [payment_auto_confirm] - Payment auto confirm flag if
|
|
858
|
+
* payment need not to be collected from user.
|
|
859
|
+
* @property {string} payment_mode - Payment mode from which the payment to be
|
|
860
|
+
* done for the order.
|
|
861
|
+
* @property {string} [aggregator] - Aggregator name of the payment gateway.
|
|
862
|
+
* @property {string} [address_id] - Address id of the user on which the order
|
|
863
|
+
* to be delivered.
|
|
864
|
+
* @property {string} [callback_url] - Callback url to be redirected after
|
|
865
|
+
* payment received/failed.
|
|
866
|
+
* @property {Object} [delivery_address] - Delivery address data which includes
|
|
867
|
+
* customer address, customer phone, customer email, customer pincode,
|
|
868
|
+
* customer landmark and customer name.
|
|
869
|
+
* @property {StaffCheckout} [staff]
|
|
870
|
+
* @property {string} [order_type] - Order type of the order being placed like
|
|
871
|
+
* pickAtStore or HomeDelivery.
|
|
872
|
+
* @property {number} [ordering_store] - Ordering store id of the store from
|
|
873
|
+
* which the order is getting placed.
|
|
874
|
+
* @property {Object} [extra_meta] - Extra meta to be added while checkout in order.
|
|
875
|
+
* @property {string} [payment_identifier] - Payment identifier of the payment
|
|
876
|
+
* mode selected to do the payment.
|
|
877
|
+
* @property {Object} [billing_address] - Billing address json which includes
|
|
878
|
+
* customer address, customer phone, customer email, customer pincode,
|
|
879
|
+
* customer landmark and customer name.
|
|
880
|
+
* @property {Object} [payment_params] - Payment params which includes payment
|
|
881
|
+
* identifier and merchant code.
|
|
882
|
+
* @property {string} [billing_address_id] - Billing address id of the customer
|
|
883
|
+
* on which the invoice to be generated after the order is placed.
|
|
884
|
+
* @property {Object} [meta] - Meta data to be added in order.
|
|
885
|
+
* @property {Object} [payment_extra_identifiers] - Payment extra identifier for
|
|
886
|
+
* the payment mode to do the payment.
|
|
887
|
+
* @property {string} [iin] - Issuer Identification Number' number of card if
|
|
888
|
+
* payment mode is card.
|
|
889
|
+
* @property {string} [network] - Network of card if payment mode is card to do
|
|
890
|
+
* the payment.
|
|
891
|
+
* @property {string} [type] - Type of cart if payment mode is card to do the payment.
|
|
892
|
+
* @property {string} [card_id] - Saved card id if payment mode is card to do the payment.
|
|
893
|
+
*/
|
|
809
894
|
/**
|
|
810
895
|
* @typedef CheckCart
|
|
811
896
|
* @property {string} [checkout_mode] - Checkout mode of user cart.
|
|
@@ -842,10 +927,10 @@ export = CartApplicationModel;
|
|
|
842
927
|
* @property {string} [coupon_text] - Coupon text of the applied coupon on order placed.
|
|
843
928
|
* @property {boolean} [buy_now] - Buy now flag of user cart.
|
|
844
929
|
* @property {number} [cod_charges] - Cash On Delivery charges of the user cart.
|
|
845
|
-
* @property {Object} [custom_cart_meta] -
|
|
930
|
+
* @property {Object} [custom_cart_meta] - Custom cart meta details added in cart.
|
|
846
931
|
*/
|
|
847
932
|
/**
|
|
848
|
-
* @typedef
|
|
933
|
+
* @typedef CartCheckoutResult
|
|
849
934
|
* @property {string} [payment_confirm_url] - Payment confirm url used to
|
|
850
935
|
* redirect after payment is confirmed.
|
|
851
936
|
* @property {string} [app_intercept_url] - App intercept url which is used to
|
|
@@ -871,7 +956,7 @@ export = CartApplicationModel;
|
|
|
871
956
|
* @property {GiftDetail} [article_id]
|
|
872
957
|
*/
|
|
873
958
|
/**
|
|
874
|
-
* @typedef
|
|
959
|
+
* @typedef CartMetaCreation
|
|
875
960
|
* @property {Object} [delivery_slots] - Delivery slots details includes article
|
|
876
961
|
* level time slot when the shipment can be delivered.
|
|
877
962
|
* @property {ArticleGiftDetail} [gift_details]
|
|
@@ -885,22 +970,22 @@ export = CartApplicationModel;
|
|
|
885
970
|
* meta in order detail API or webhook.
|
|
886
971
|
*/
|
|
887
972
|
/**
|
|
888
|
-
* @typedef
|
|
973
|
+
* @typedef CartMetaResult
|
|
889
974
|
* @property {string} [message] - Detailed message.
|
|
890
975
|
* @property {boolean} [is_valid] - Whether added meta was vaild.
|
|
891
976
|
*/
|
|
892
977
|
/**
|
|
893
|
-
* @typedef
|
|
978
|
+
* @typedef CartMetaMissingResult
|
|
894
979
|
* @property {string[]} [errors] - Detailed errors for invalid cart meta request.
|
|
895
980
|
*/
|
|
896
981
|
/**
|
|
897
|
-
* @typedef
|
|
982
|
+
* @typedef GetShareCartLinkCreation
|
|
898
983
|
* @property {string} [id] - Cart id of user cart for generating cart sharing token.
|
|
899
984
|
* @property {Object} [meta] - Staff, Ordering store or any other data. This
|
|
900
985
|
* data will be used to generate link as well as sent as shared details.
|
|
901
986
|
*/
|
|
902
987
|
/**
|
|
903
|
-
* @typedef
|
|
988
|
+
* @typedef GetShareCartLinkResult
|
|
904
989
|
* @property {string} [token] - Short url unique id of the cart which is opted
|
|
905
990
|
* to share with other user.
|
|
906
991
|
* @property {string} [share_url] - Short shareable final url which can populate
|
|
@@ -944,7 +1029,7 @@ export = CartApplicationModel;
|
|
|
944
1029
|
* via update cart meta API.
|
|
945
1030
|
*/
|
|
946
1031
|
/**
|
|
947
|
-
* @typedef
|
|
1032
|
+
* @typedef SharedCartResult
|
|
948
1033
|
* @property {string} [error] - Error details if any error occurs which includes
|
|
949
1034
|
* type of error, error code and error message.
|
|
950
1035
|
* @property {SharedCart} [cart]
|
|
@@ -960,15 +1045,25 @@ export = CartApplicationModel;
|
|
|
960
1045
|
* @property {PriceMinMax} [effective]
|
|
961
1046
|
* @property {string} [currency] - Currency of the article added in cart.
|
|
962
1047
|
*/
|
|
1048
|
+
/**
|
|
1049
|
+
* @typedef ArticlePriceDetails
|
|
1050
|
+
* @property {number} [marked] - The Marked Price refers to the initial price of
|
|
1051
|
+
* the free gift article before product discount.
|
|
1052
|
+
* @property {number} [effective] - The Effective Price refers to the final
|
|
1053
|
+
* amount of the free gift article after applying the product discount.
|
|
1054
|
+
*/
|
|
963
1055
|
/**
|
|
964
1056
|
* @typedef FreeGiftItems
|
|
965
1057
|
* @property {string} [item_slug] - Slug for an item.
|
|
966
1058
|
* @property {string} [item_name] - Name of the free gift item received via free
|
|
967
1059
|
* gift promotion.
|
|
968
1060
|
* @property {ItemPriceDetails} [item_price_details]
|
|
1061
|
+
* @property {ArticlePriceDetails} [article_price]
|
|
969
1062
|
* @property {string} [item_brand_name] - Item brand name of the free gift item
|
|
970
1063
|
* promotion applied on cart.
|
|
971
1064
|
* @property {number} [item_id] - Item id of the free gift item.
|
|
1065
|
+
* @property {string[]} [available_sizes] - Available sizes for the free gift item.
|
|
1066
|
+
* @property {string} [size] - Selected size for the free gift item.
|
|
972
1067
|
* @property {string[]} [item_images_url] - Images URLs for free gift items.
|
|
973
1068
|
*/
|
|
974
1069
|
/**
|
|
@@ -994,7 +1089,7 @@ export = CartApplicationModel;
|
|
|
994
1089
|
* promotion which is avaiable on product.
|
|
995
1090
|
*/
|
|
996
1091
|
/**
|
|
997
|
-
* @typedef
|
|
1092
|
+
* @typedef PromotionOffersResult
|
|
998
1093
|
* @property {PromotionOffer[]} [available_promotions] - Available promotion
|
|
999
1094
|
* details which are available on product which includes promotion data like
|
|
1000
1095
|
* promotion id, promotion name, buy rules, discount rules validity dates etc.
|
|
@@ -1020,13 +1115,13 @@ export = CartApplicationModel;
|
|
|
1020
1115
|
* @property {string} [promotion_name] - Name of the promotion which is available on cart.
|
|
1021
1116
|
*/
|
|
1022
1117
|
/**
|
|
1023
|
-
* @typedef
|
|
1118
|
+
* @typedef PromotionPaymentOffersResult
|
|
1024
1119
|
* @property {boolean} [success] - Success flag of get payment offers API response.
|
|
1025
1120
|
* @property {PromotionPaymentOffer[]} [promotions] - List of promotions data
|
|
1026
1121
|
* which are applicable on cart/product.
|
|
1027
1122
|
*/
|
|
1028
1123
|
/**
|
|
1029
|
-
* @typedef
|
|
1124
|
+
* @typedef OperationErrorResult
|
|
1030
1125
|
* @property {string} [message] - Message of get payment offer API response.
|
|
1031
1126
|
* @property {boolean} [success] - Success flag of get payment offer API response.
|
|
1032
1127
|
*/
|
|
@@ -1100,9 +1195,10 @@ export = CartApplicationModel;
|
|
|
1100
1195
|
* the payment mode to do the payment.
|
|
1101
1196
|
*/
|
|
1102
1197
|
/**
|
|
1103
|
-
* @typedef
|
|
1104
|
-
* @property {
|
|
1105
|
-
*
|
|
1198
|
+
* @typedef CartCheckoutDetailV2Creation
|
|
1199
|
+
* @property {CartCheckoutCustomMeta[]} [custom_meta] - Custom meta data to be
|
|
1200
|
+
* added in order.
|
|
1201
|
+
* @property {CustomerDetails} [customer_details]
|
|
1106
1202
|
* @property {string} [merchant_code] - Merchant code of the payment mode
|
|
1107
1203
|
* selected to do the payment.
|
|
1108
1204
|
* @property {string} [cart_id] - Cart id of the user cart.
|
|
@@ -1143,10 +1239,15 @@ export = CartApplicationModel;
|
|
|
1143
1239
|
* @property {string} [type] - Type of cart if payment mode is card to do the payment.
|
|
1144
1240
|
* @property {string} [card_id] - Saved card id if payment mode is card to do the payment.
|
|
1145
1241
|
*/
|
|
1242
|
+
/**
|
|
1243
|
+
* @typedef ValidationError
|
|
1244
|
+
* @property {string} message - A brief description of the error encountered.
|
|
1245
|
+
* @property {string} field - The field in the request that caused the error.
|
|
1246
|
+
*/
|
|
1146
1247
|
declare class CartApplicationModel {
|
|
1147
1248
|
}
|
|
1148
1249
|
declare namespace CartApplicationModel {
|
|
1149
|
-
export { BuyRules, DiscountRulesApp, Ownership, AppliedFreeArticles, AppliedPromotion, PaymentSelectionLock, PromiseFormatted, PromiseISOFormat, PromiseTimestamp, ShipmentPromise, BasePrice, ArticlePriceInfo, BaseInfo, StoreInfo, ProductArticle, CartProductIdentifer, PromoMeta, ChargesAmount, Charges, ProductPrice, ProductPriceInfo, ProductPricePerUnit, ProductPricePerUnitInfo, ProductAvailabilitySize, ProductAvailability, ActionQuery, ProductAction, Tags, ProductImage, CategoryInfo, CartProduct, CouponDetails, CartProductInfo, DisplayBreakup, RawBreakup, CouponBreakup, LoyaltyPoints, CartBreakup, CartCurrency, CartDetailCoupon, ChargesThreshold, DeliveryChargesConfig, CartCommonConfig,
|
|
1250
|
+
export { BuyRules, DiscountRulesApp, Ownership, FreeGiftItem, AppliedFreeArticles, AppliedPromotion, PaymentSelectionLock, PromiseFormatted, PromiseISOFormat, PromiseTimestamp, ShipmentPromise, BasePrice, ArticlePriceInfo, BaseInfo, StoreInfo, ProductArticle, CartProductIdentifer, PromoMeta, ChargesAmount, Charges, ProductPrice, ProductPriceInfo, ProductPricePerUnit, ProductPricePerUnitInfo, ProductAvailabilitySize, ProductAvailability, ActionQuery, ProductActionParams, ProductActionPage, ProductAction, Tags, ProductImage, CategoryInfo, CartProduct, CouponDetails, CartProductInfo, DisplayBreakup, RawBreakup, CouponBreakup, LoyaltyPoints, CartBreakup, CartCurrency, CartDetailCoupon, ChargesThreshold, DeliveryChargesConfig, CartCommonConfig, CartDetailResult, AddProductCart, AddCartCreation, AddCartDetailResult, UpdateProductCart, FreeGiftItemCreation, UpdateCartCreation, UpdateCartDetailResult, DeleteCartDetailResult, CartItemCountResult, PageCoupon, Coupon, GetCouponResult, ApplyCoupon, OfferPrice, OfferItem, OfferSeller, BulkPriceOffer, BulkPriceResult, RewardPointCreation, GeoLocation, Address, ValidationConfig, GetAddressesResult, SaveAddressResult, UpdateAddressResult, DeleteAddressResult, SelectCartAddressCreation, UpdateCartPaymentCreation, CouponValidity, PaymentCouponValidate, ShipmentResult, CartShipmentsResult, CartCheckoutCustomMeta, CustomerDetails, StaffCheckout, CartCheckoutDetailCreation, CheckCart, CartCheckoutResult, GiftDetail, ArticleGiftDetail, CartMetaCreation, CartMetaResult, CartMetaMissingResult, GetShareCartLinkCreation, GetShareCartLinkResult, SharedCartDetails, SharedCart, SharedCartResult, PriceMinMax, ItemPriceDetails, ArticlePriceDetails, FreeGiftItems, PromotionOffer, PromotionOffersResult, PromotionPaymentOffer, PromotionPaymentOffersResult, OperationErrorResult, LadderPrice, LadderOfferItem, LadderPriceOffer, CurrencyInfo, LadderPriceOffers, PaymentMeta, PaymentMethod, CartCheckoutDetailV2Creation, ValidationError };
|
|
1150
1251
|
}
|
|
1151
1252
|
/** @returns {BuyRules} */
|
|
1152
1253
|
declare function BuyRules(): BuyRules;
|
|
@@ -1192,6 +1293,34 @@ type Ownership = {
|
|
|
1192
1293
|
*/
|
|
1193
1294
|
payable_by?: string;
|
|
1194
1295
|
};
|
|
1296
|
+
/** @returns {FreeGiftItem} */
|
|
1297
|
+
declare function FreeGiftItem(): FreeGiftItem;
|
|
1298
|
+
type FreeGiftItem = {
|
|
1299
|
+
/**
|
|
1300
|
+
* - Item slug.
|
|
1301
|
+
*/
|
|
1302
|
+
item_slug?: string;
|
|
1303
|
+
/**
|
|
1304
|
+
* - Item name.
|
|
1305
|
+
*/
|
|
1306
|
+
item_name?: string;
|
|
1307
|
+
/**
|
|
1308
|
+
* - Item price details.
|
|
1309
|
+
*/
|
|
1310
|
+
item_price_details?: any;
|
|
1311
|
+
/**
|
|
1312
|
+
* - Item brand name.
|
|
1313
|
+
*/
|
|
1314
|
+
item_brand_name?: string;
|
|
1315
|
+
/**
|
|
1316
|
+
* - Item id.
|
|
1317
|
+
*/
|
|
1318
|
+
item_id?: number;
|
|
1319
|
+
/**
|
|
1320
|
+
* - Item images URL.
|
|
1321
|
+
*/
|
|
1322
|
+
item_images_url?: string[];
|
|
1323
|
+
};
|
|
1195
1324
|
/** @returns {AppliedFreeArticles} */
|
|
1196
1325
|
declare function AppliedFreeArticles(): AppliedFreeArticles;
|
|
1197
1326
|
type AppliedFreeArticles = {
|
|
@@ -1656,18 +1785,37 @@ type ActionQuery = {
|
|
|
1656
1785
|
*/
|
|
1657
1786
|
product_slug?: string[];
|
|
1658
1787
|
};
|
|
1788
|
+
/** @returns {ProductActionParams} */
|
|
1789
|
+
declare function ProductActionParams(): ProductActionParams;
|
|
1790
|
+
type ProductActionParams = {
|
|
1791
|
+
/**
|
|
1792
|
+
* - Unique product url name generated via product
|
|
1793
|
+
* name and other meta data.
|
|
1794
|
+
*/
|
|
1795
|
+
slug?: string[];
|
|
1796
|
+
};
|
|
1797
|
+
/** @returns {ProductActionPage} */
|
|
1798
|
+
declare function ProductActionPage(): ProductActionPage;
|
|
1799
|
+
type ProductActionPage = {
|
|
1800
|
+
/**
|
|
1801
|
+
* - Entity of page to be redirected on click
|
|
1802
|
+
*/
|
|
1803
|
+
type?: string;
|
|
1804
|
+
params?: ProductActionParams;
|
|
1805
|
+
};
|
|
1659
1806
|
/** @returns {ProductAction} */
|
|
1660
1807
|
declare function ProductAction(): ProductAction;
|
|
1661
1808
|
type ProductAction = {
|
|
1662
1809
|
query?: ActionQuery;
|
|
1663
1810
|
/**
|
|
1664
|
-
* - Url of the product to render the product
|
|
1811
|
+
* - Url of the product to render the product
|
|
1665
1812
|
*/
|
|
1666
1813
|
url?: string;
|
|
1667
1814
|
/**
|
|
1668
1815
|
* - Type of action.
|
|
1669
1816
|
*/
|
|
1670
1817
|
type?: string;
|
|
1818
|
+
page?: ProductActionPage;
|
|
1671
1819
|
};
|
|
1672
1820
|
/** @returns {Tags} */
|
|
1673
1821
|
declare function Tags(): Tags;
|
|
@@ -2162,9 +2310,9 @@ declare function CartCommonConfig(): CartCommonConfig;
|
|
|
2162
2310
|
type CartCommonConfig = {
|
|
2163
2311
|
delivery_charges_config?: DeliveryChargesConfig;
|
|
2164
2312
|
};
|
|
2165
|
-
/** @returns {
|
|
2166
|
-
declare function
|
|
2167
|
-
type
|
|
2313
|
+
/** @returns {CartDetailResult} */
|
|
2314
|
+
declare function CartDetailResult(): CartDetailResult;
|
|
2315
|
+
type CartDetailResult = {
|
|
2168
2316
|
/**
|
|
2169
2317
|
* - Unique identifier of the user cart.
|
|
2170
2318
|
*/
|
|
@@ -2342,9 +2490,9 @@ type AddProductCart = {
|
|
|
2342
2490
|
*/
|
|
2343
2491
|
seller_identifier?: string;
|
|
2344
2492
|
};
|
|
2345
|
-
/** @returns {
|
|
2346
|
-
declare function
|
|
2347
|
-
type
|
|
2493
|
+
/** @returns {AddCartCreation} */
|
|
2494
|
+
declare function AddCartCreation(): AddCartCreation;
|
|
2495
|
+
type AddCartCreation = {
|
|
2348
2496
|
/**
|
|
2349
2497
|
* - List of items detail which need to be
|
|
2350
2498
|
* added to cart like item id, item size, and item quantity.
|
|
@@ -2356,9 +2504,9 @@ type AddCartRequest = {
|
|
|
2356
2504
|
*/
|
|
2357
2505
|
new_cart?: boolean;
|
|
2358
2506
|
};
|
|
2359
|
-
/** @returns {
|
|
2360
|
-
declare function
|
|
2361
|
-
type
|
|
2507
|
+
/** @returns {AddCartDetailResult} */
|
|
2508
|
+
declare function AddCartDetailResult(): AddCartDetailResult;
|
|
2509
|
+
type AddCartDetailResult = {
|
|
2362
2510
|
/**
|
|
2363
2511
|
* - Message of add to cart API response.
|
|
2364
2512
|
*/
|
|
@@ -2368,7 +2516,7 @@ type AddCartDetailResponse = {
|
|
|
2368
2516
|
* added. True if only few are added.
|
|
2369
2517
|
*/
|
|
2370
2518
|
partial?: boolean;
|
|
2371
|
-
cart?:
|
|
2519
|
+
cart?: CartDetailResult;
|
|
2372
2520
|
/**
|
|
2373
2521
|
* - True if all items are added successfully.
|
|
2374
2522
|
* False if partially added or not added.
|
|
@@ -2418,37 +2566,58 @@ type UpdateProductCart = {
|
|
|
2418
2566
|
*/
|
|
2419
2567
|
meta?: any;
|
|
2420
2568
|
};
|
|
2421
|
-
/** @returns {
|
|
2422
|
-
declare function
|
|
2423
|
-
type
|
|
2569
|
+
/** @returns {FreeGiftItemCreation} */
|
|
2570
|
+
declare function FreeGiftItemCreation(): FreeGiftItemCreation;
|
|
2571
|
+
type FreeGiftItemCreation = {
|
|
2572
|
+
/**
|
|
2573
|
+
* - Unique identifier of the free gift promotion.
|
|
2574
|
+
*/
|
|
2575
|
+
promotion_id: string;
|
|
2576
|
+
/**
|
|
2577
|
+
* - Unique identifier of the selected free gift item.
|
|
2578
|
+
*/
|
|
2579
|
+
item_id: string;
|
|
2580
|
+
/**
|
|
2581
|
+
* - Size of the selected free gift item.
|
|
2582
|
+
*/
|
|
2583
|
+
item_size: string;
|
|
2584
|
+
};
|
|
2585
|
+
/** @returns {UpdateCartCreation} */
|
|
2586
|
+
declare function UpdateCartCreation(): UpdateCartCreation;
|
|
2587
|
+
type UpdateCartCreation = {
|
|
2424
2588
|
/**
|
|
2425
2589
|
* - List items data that needs to be
|
|
2426
2590
|
* updated in cart.
|
|
2427
2591
|
*/
|
|
2428
2592
|
items?: UpdateProductCart[];
|
|
2593
|
+
/**
|
|
2594
|
+
* - List of free gift
|
|
2595
|
+
* items with updated sizes.
|
|
2596
|
+
*/
|
|
2597
|
+
free_gift_items?: FreeGiftItemCreation[];
|
|
2429
2598
|
/**
|
|
2430
2599
|
* - Field to determine if item to be removed from
|
|
2431
2600
|
* cart or it needs to be updated.
|
|
2432
2601
|
*/
|
|
2433
2602
|
operation: string;
|
|
2434
2603
|
};
|
|
2435
|
-
/** @returns {
|
|
2436
|
-
declare function
|
|
2437
|
-
type
|
|
2604
|
+
/** @returns {UpdateCartDetailResult} */
|
|
2605
|
+
declare function UpdateCartDetailResult(): UpdateCartDetailResult;
|
|
2606
|
+
type UpdateCartDetailResult = {
|
|
2438
2607
|
/**
|
|
2439
2608
|
* - Message of update cart API response.
|
|
2440
2609
|
*/
|
|
2441
2610
|
message?: string;
|
|
2442
|
-
cart?:
|
|
2611
|
+
cart?: CartDetailResult;
|
|
2443
2612
|
/**
|
|
2444
2613
|
* - True if all items are added successfully.
|
|
2445
2614
|
* False if partially added or not added.
|
|
2446
2615
|
*/
|
|
2447
2616
|
success?: boolean;
|
|
2448
2617
|
};
|
|
2449
|
-
/** @returns {
|
|
2450
|
-
declare function
|
|
2451
|
-
type
|
|
2618
|
+
/** @returns {DeleteCartDetailResult} */
|
|
2619
|
+
declare function DeleteCartDetailResult(): DeleteCartDetailResult;
|
|
2620
|
+
type DeleteCartDetailResult = {
|
|
2452
2621
|
/**
|
|
2453
2622
|
* - Message for delete cart response.
|
|
2454
2623
|
*/
|
|
@@ -2459,9 +2628,9 @@ type DeleteCartDetailResponse = {
|
|
|
2459
2628
|
*/
|
|
2460
2629
|
success?: boolean;
|
|
2461
2630
|
};
|
|
2462
|
-
/** @returns {
|
|
2463
|
-
declare function
|
|
2464
|
-
type
|
|
2631
|
+
/** @returns {CartItemCountResult} */
|
|
2632
|
+
declare function CartItemCountResult(): CartItemCountResult;
|
|
2633
|
+
type CartItemCountResult = {
|
|
2465
2634
|
/**
|
|
2466
2635
|
* - Item count present in cart.
|
|
2467
2636
|
*/
|
|
@@ -2578,9 +2747,9 @@ type Coupon = {
|
|
|
2578
2747
|
*/
|
|
2579
2748
|
is_bank_offer?: boolean;
|
|
2580
2749
|
};
|
|
2581
|
-
/** @returns {
|
|
2582
|
-
declare function
|
|
2583
|
-
type
|
|
2750
|
+
/** @returns {GetCouponResult} */
|
|
2751
|
+
declare function GetCouponResult(): GetCouponResult;
|
|
2752
|
+
type GetCouponResult = {
|
|
2584
2753
|
page?: PageCoupon;
|
|
2585
2754
|
/**
|
|
2586
2755
|
* - List of available coupon which
|
|
@@ -2588,9 +2757,9 @@ type GetCouponResponse = {
|
|
|
2588
2757
|
*/
|
|
2589
2758
|
available_coupon_list?: Coupon[];
|
|
2590
2759
|
};
|
|
2591
|
-
/** @returns {
|
|
2592
|
-
declare function
|
|
2593
|
-
type
|
|
2760
|
+
/** @returns {ApplyCoupon} */
|
|
2761
|
+
declare function ApplyCoupon(): ApplyCoupon;
|
|
2762
|
+
type ApplyCoupon = {
|
|
2594
2763
|
/**
|
|
2595
2764
|
* - Coupon code to be applied.
|
|
2596
2765
|
*/
|
|
@@ -2678,18 +2847,18 @@ type BulkPriceOffer = {
|
|
|
2678
2847
|
offers?: OfferItem[];
|
|
2679
2848
|
seller?: OfferSeller;
|
|
2680
2849
|
};
|
|
2681
|
-
/** @returns {
|
|
2682
|
-
declare function
|
|
2683
|
-
type
|
|
2850
|
+
/** @returns {BulkPriceResult} */
|
|
2851
|
+
declare function BulkPriceResult(): BulkPriceResult;
|
|
2852
|
+
type BulkPriceResult = {
|
|
2684
2853
|
/**
|
|
2685
2854
|
* - Actual data to be in response consist
|
|
2686
2855
|
* of offers from multiple seller.
|
|
2687
2856
|
*/
|
|
2688
2857
|
data?: BulkPriceOffer[];
|
|
2689
2858
|
};
|
|
2690
|
-
/** @returns {
|
|
2691
|
-
declare function
|
|
2692
|
-
type
|
|
2859
|
+
/** @returns {RewardPointCreation} */
|
|
2860
|
+
declare function RewardPointCreation(): RewardPointCreation;
|
|
2861
|
+
type RewardPointCreation = {
|
|
2693
2862
|
/**
|
|
2694
2863
|
* - Points to be applied for cart.
|
|
2695
2864
|
*/
|
|
@@ -2823,9 +2992,21 @@ type Address = {
|
|
|
2823
2992
|
*/
|
|
2824
2993
|
meta?: any;
|
|
2825
2994
|
};
|
|
2826
|
-
/** @returns {
|
|
2827
|
-
declare function
|
|
2828
|
-
type
|
|
2995
|
+
/** @returns {ValidationConfig} */
|
|
2996
|
+
declare function ValidationConfig(): ValidationConfig;
|
|
2997
|
+
type ValidationConfig = {
|
|
2998
|
+
/**
|
|
2999
|
+
* - The maximum number of addresses a user can have.
|
|
3000
|
+
*/
|
|
3001
|
+
address_max_limit: number;
|
|
3002
|
+
/**
|
|
3003
|
+
* - The total number of addresses saved by a user.
|
|
3004
|
+
*/
|
|
3005
|
+
user_address_count: number;
|
|
3006
|
+
};
|
|
3007
|
+
/** @returns {GetAddressesResult} */
|
|
3008
|
+
declare function GetAddressesResult(): GetAddressesResult;
|
|
3009
|
+
type GetAddressesResult = {
|
|
2829
3010
|
/**
|
|
2830
3011
|
* - Personally Identifiable Information
|
|
2831
3012
|
* masking flag to denote if the user data in address is masked or not.
|
|
@@ -2835,16 +3016,17 @@ type GetAddressesResponse = {
|
|
|
2835
3016
|
* - Address description for address data.
|
|
2836
3017
|
*/
|
|
2837
3018
|
address?: Address[];
|
|
3019
|
+
validation_config?: ValidationConfig;
|
|
2838
3020
|
};
|
|
2839
|
-
/** @returns {
|
|
2840
|
-
declare function
|
|
2841
|
-
type
|
|
3021
|
+
/** @returns {SaveAddressResult} */
|
|
3022
|
+
declare function SaveAddressResult(): SaveAddressResult;
|
|
3023
|
+
type SaveAddressResult = {
|
|
2842
3024
|
/**
|
|
2843
3025
|
* - Id of the address.
|
|
2844
3026
|
*/
|
|
2845
3027
|
id?: string;
|
|
2846
3028
|
/**
|
|
2847
|
-
* - Success flag of save address
|
|
3029
|
+
* - Success flag of save address Result.
|
|
2848
3030
|
*/
|
|
2849
3031
|
success?: boolean;
|
|
2850
3032
|
/**
|
|
@@ -2853,9 +3035,9 @@ type SaveAddressResponse = {
|
|
|
2853
3035
|
*/
|
|
2854
3036
|
is_default_address?: boolean;
|
|
2855
3037
|
};
|
|
2856
|
-
/** @returns {
|
|
2857
|
-
declare function
|
|
2858
|
-
type
|
|
3038
|
+
/** @returns {UpdateAddressResult} */
|
|
3039
|
+
declare function UpdateAddressResult(): UpdateAddressResult;
|
|
3040
|
+
type UpdateAddressResult = {
|
|
2859
3041
|
/**
|
|
2860
3042
|
* - Updated flag for update address operation
|
|
2861
3043
|
* if the address updated or not.
|
|
@@ -2875,9 +3057,9 @@ type UpdateAddressResponse = {
|
|
|
2875
3057
|
*/
|
|
2876
3058
|
is_default_address?: boolean;
|
|
2877
3059
|
};
|
|
2878
|
-
/** @returns {
|
|
2879
|
-
declare function
|
|
2880
|
-
type
|
|
3060
|
+
/** @returns {DeleteAddressResult} */
|
|
3061
|
+
declare function DeleteAddressResult(): DeleteAddressResult;
|
|
3062
|
+
type DeleteAddressResult = {
|
|
2881
3063
|
/**
|
|
2882
3064
|
* - Id of the address.
|
|
2883
3065
|
*/
|
|
@@ -2888,9 +3070,9 @@ type DeleteAddressResponse = {
|
|
|
2888
3070
|
*/
|
|
2889
3071
|
is_deleted?: boolean;
|
|
2890
3072
|
};
|
|
2891
|
-
/** @returns {
|
|
2892
|
-
declare function
|
|
2893
|
-
type
|
|
3073
|
+
/** @returns {SelectCartAddressCreation} */
|
|
3074
|
+
declare function SelectCartAddressCreation(): SelectCartAddressCreation;
|
|
3075
|
+
type SelectCartAddressCreation = {
|
|
2894
3076
|
/**
|
|
2895
3077
|
* - Address is selected by user on which shipment to be
|
|
2896
3078
|
* delivered.
|
|
@@ -2907,9 +3089,9 @@ type SelectCartAddressRequest = {
|
|
|
2907
3089
|
*/
|
|
2908
3090
|
cart_id?: string;
|
|
2909
3091
|
};
|
|
2910
|
-
/** @returns {
|
|
2911
|
-
declare function
|
|
2912
|
-
type
|
|
3092
|
+
/** @returns {UpdateCartPaymentCreation} */
|
|
3093
|
+
declare function UpdateCartPaymentCreation(): UpdateCartPaymentCreation;
|
|
3094
|
+
type UpdateCartPaymentCreation = {
|
|
2913
3095
|
/**
|
|
2914
3096
|
* - Cart id of the user cart for which the update cart
|
|
2915
3097
|
* payment operation performed.
|
|
@@ -2969,6 +3151,10 @@ type CouponValidity = {
|
|
|
2969
3151
|
* - Coupon code of the coupon applied.
|
|
2970
3152
|
*/
|
|
2971
3153
|
code?: string;
|
|
3154
|
+
/**
|
|
3155
|
+
* - Error message for the selected payment mode.
|
|
3156
|
+
*/
|
|
3157
|
+
error_en?: string;
|
|
2972
3158
|
};
|
|
2973
3159
|
/** @returns {PaymentCouponValidate} */
|
|
2974
3160
|
declare function PaymentCouponValidate(): PaymentCouponValidate;
|
|
@@ -2984,9 +3170,9 @@ type PaymentCouponValidate = {
|
|
|
2984
3170
|
*/
|
|
2985
3171
|
success: boolean;
|
|
2986
3172
|
};
|
|
2987
|
-
/** @returns {
|
|
2988
|
-
declare function
|
|
2989
|
-
type
|
|
3173
|
+
/** @returns {ShipmentResult} */
|
|
3174
|
+
declare function ShipmentResult(): ShipmentResult;
|
|
3175
|
+
type ShipmentResult = {
|
|
2990
3176
|
/**
|
|
2991
3177
|
* - Count of shipments that will be shipped.
|
|
2992
3178
|
*/
|
|
@@ -3030,9 +3216,9 @@ type ShipmentResponse = {
|
|
|
3030
3216
|
*/
|
|
3031
3217
|
fulfillment_id?: number;
|
|
3032
3218
|
};
|
|
3033
|
-
/** @returns {
|
|
3034
|
-
declare function
|
|
3035
|
-
type
|
|
3219
|
+
/** @returns {CartShipmentsResult} */
|
|
3220
|
+
declare function CartShipmentsResult(): CartShipmentsResult;
|
|
3221
|
+
type CartShipmentsResult = {
|
|
3036
3222
|
/**
|
|
3037
3223
|
* - Delivery charge in information
|
|
3038
3224
|
* message on shipment.
|
|
@@ -3043,7 +3229,7 @@ type CartShipmentsResponse = {
|
|
|
3043
3229
|
*/
|
|
3044
3230
|
checkout_mode?: string;
|
|
3045
3231
|
/**
|
|
3046
|
-
* -
|
|
3232
|
+
* - Result message of get shipments API.
|
|
3047
3233
|
*/
|
|
3048
3234
|
message?: string;
|
|
3049
3235
|
/**
|
|
@@ -3079,7 +3265,7 @@ type CartShipmentsResponse = {
|
|
|
3079
3265
|
* shipment data like shipment items, shipment promise, Shipment type,
|
|
3080
3266
|
* shipment order type, shipment dp options etc.
|
|
3081
3267
|
*/
|
|
3082
|
-
shipments?:
|
|
3268
|
+
shipments?: ShipmentResult[];
|
|
3083
3269
|
payment_selection_lock?: PaymentSelectionLock;
|
|
3084
3270
|
/**
|
|
3085
3271
|
* - Coupon text of coupon applied on cart.
|
|
@@ -3109,6 +3295,18 @@ type CartShipmentsResponse = {
|
|
|
3109
3295
|
*/
|
|
3110
3296
|
custom_cart_meta?: any;
|
|
3111
3297
|
};
|
|
3298
|
+
/** @returns {CartCheckoutCustomMeta} */
|
|
3299
|
+
declare function CartCheckoutCustomMeta(): CartCheckoutCustomMeta;
|
|
3300
|
+
type CartCheckoutCustomMeta = {
|
|
3301
|
+
/**
|
|
3302
|
+
* - Key name of custom meta.
|
|
3303
|
+
*/
|
|
3304
|
+
key: string;
|
|
3305
|
+
/**
|
|
3306
|
+
* - Value to be added in key.
|
|
3307
|
+
*/
|
|
3308
|
+
value: string;
|
|
3309
|
+
};
|
|
3112
3310
|
/** @returns {CustomerDetails} */
|
|
3113
3311
|
declare function CustomerDetails(): CustomerDetails;
|
|
3114
3312
|
type CustomerDetails = {
|
|
@@ -3156,6 +3354,121 @@ type StaffCheckout = {
|
|
|
3156
3354
|
*/
|
|
3157
3355
|
_id: string;
|
|
3158
3356
|
};
|
|
3357
|
+
/** @returns {CartCheckoutDetailCreation} */
|
|
3358
|
+
declare function CartCheckoutDetailCreation(): CartCheckoutDetailCreation;
|
|
3359
|
+
type CartCheckoutDetailCreation = {
|
|
3360
|
+
/**
|
|
3361
|
+
* - Custom meta data to be
|
|
3362
|
+
* added in order.
|
|
3363
|
+
*/
|
|
3364
|
+
custom_meta?: CartCheckoutCustomMeta[];
|
|
3365
|
+
/**
|
|
3366
|
+
* - Customer details to be added in order.
|
|
3367
|
+
*/
|
|
3368
|
+
customer_details?: CustomerDetails;
|
|
3369
|
+
/**
|
|
3370
|
+
* - Merchant code of the payment mode
|
|
3371
|
+
* selected to do the payment.
|
|
3372
|
+
*/
|
|
3373
|
+
merchant_code?: string;
|
|
3374
|
+
/**
|
|
3375
|
+
* - Cart id of the user cart.
|
|
3376
|
+
*/
|
|
3377
|
+
id?: string;
|
|
3378
|
+
/**
|
|
3379
|
+
* - Payment auto confirm flag if
|
|
3380
|
+
* payment need not to be collected from user.
|
|
3381
|
+
*/
|
|
3382
|
+
payment_auto_confirm?: boolean;
|
|
3383
|
+
/**
|
|
3384
|
+
* - Payment mode from which the payment to be
|
|
3385
|
+
* done for the order.
|
|
3386
|
+
*/
|
|
3387
|
+
payment_mode: string;
|
|
3388
|
+
/**
|
|
3389
|
+
* - Aggregator name of the payment gateway.
|
|
3390
|
+
*/
|
|
3391
|
+
aggregator?: string;
|
|
3392
|
+
/**
|
|
3393
|
+
* - Address id of the user on which the order
|
|
3394
|
+
* to be delivered.
|
|
3395
|
+
*/
|
|
3396
|
+
address_id?: string;
|
|
3397
|
+
/**
|
|
3398
|
+
* - Callback url to be redirected after
|
|
3399
|
+
* payment received/failed.
|
|
3400
|
+
*/
|
|
3401
|
+
callback_url?: string;
|
|
3402
|
+
/**
|
|
3403
|
+
* - Delivery address data which includes
|
|
3404
|
+
* customer address, customer phone, customer email, customer pincode,
|
|
3405
|
+
* customer landmark and customer name.
|
|
3406
|
+
*/
|
|
3407
|
+
delivery_address?: any;
|
|
3408
|
+
staff?: StaffCheckout;
|
|
3409
|
+
/**
|
|
3410
|
+
* - Order type of the order being placed like
|
|
3411
|
+
* pickAtStore or HomeDelivery.
|
|
3412
|
+
*/
|
|
3413
|
+
order_type?: string;
|
|
3414
|
+
/**
|
|
3415
|
+
* - Ordering store id of the store from
|
|
3416
|
+
* which the order is getting placed.
|
|
3417
|
+
*/
|
|
3418
|
+
ordering_store?: number;
|
|
3419
|
+
/**
|
|
3420
|
+
* - Extra meta to be added while checkout in order.
|
|
3421
|
+
*/
|
|
3422
|
+
extra_meta?: any;
|
|
3423
|
+
/**
|
|
3424
|
+
* - Payment identifier of the payment
|
|
3425
|
+
* mode selected to do the payment.
|
|
3426
|
+
*/
|
|
3427
|
+
payment_identifier?: string;
|
|
3428
|
+
/**
|
|
3429
|
+
* - Billing address json which includes
|
|
3430
|
+
* customer address, customer phone, customer email, customer pincode,
|
|
3431
|
+
* customer landmark and customer name.
|
|
3432
|
+
*/
|
|
3433
|
+
billing_address?: any;
|
|
3434
|
+
/**
|
|
3435
|
+
* - Payment params which includes payment
|
|
3436
|
+
* identifier and merchant code.
|
|
3437
|
+
*/
|
|
3438
|
+
payment_params?: any;
|
|
3439
|
+
/**
|
|
3440
|
+
* - Billing address id of the customer
|
|
3441
|
+
* on which the invoice to be generated after the order is placed.
|
|
3442
|
+
*/
|
|
3443
|
+
billing_address_id?: string;
|
|
3444
|
+
/**
|
|
3445
|
+
* - Meta data to be added in order.
|
|
3446
|
+
*/
|
|
3447
|
+
meta?: any;
|
|
3448
|
+
/**
|
|
3449
|
+
* - Payment extra identifier for
|
|
3450
|
+
* the payment mode to do the payment.
|
|
3451
|
+
*/
|
|
3452
|
+
payment_extra_identifiers?: any;
|
|
3453
|
+
/**
|
|
3454
|
+
* - Issuer Identification Number' number of card if
|
|
3455
|
+
* payment mode is card.
|
|
3456
|
+
*/
|
|
3457
|
+
iin?: string;
|
|
3458
|
+
/**
|
|
3459
|
+
* - Network of card if payment mode is card to do
|
|
3460
|
+
* the payment.
|
|
3461
|
+
*/
|
|
3462
|
+
network?: string;
|
|
3463
|
+
/**
|
|
3464
|
+
* - Type of cart if payment mode is card to do the payment.
|
|
3465
|
+
*/
|
|
3466
|
+
type?: string;
|
|
3467
|
+
/**
|
|
3468
|
+
* - Saved card id if payment mode is card to do the payment.
|
|
3469
|
+
*/
|
|
3470
|
+
card_id?: string;
|
|
3471
|
+
};
|
|
3159
3472
|
/** @returns {CheckCart} */
|
|
3160
3473
|
declare function CheckCart(): CheckCart;
|
|
3161
3474
|
type CheckCart = {
|
|
@@ -3269,13 +3582,13 @@ type CheckCart = {
|
|
|
3269
3582
|
*/
|
|
3270
3583
|
cod_charges?: number;
|
|
3271
3584
|
/**
|
|
3272
|
-
* -
|
|
3585
|
+
* - Custom cart meta details added in cart.
|
|
3273
3586
|
*/
|
|
3274
3587
|
custom_cart_meta?: any;
|
|
3275
3588
|
};
|
|
3276
|
-
/** @returns {
|
|
3277
|
-
declare function
|
|
3278
|
-
type
|
|
3589
|
+
/** @returns {CartCheckoutResult} */
|
|
3590
|
+
declare function CartCheckoutResult(): CartCheckoutResult;
|
|
3591
|
+
type CartCheckoutResult = {
|
|
3279
3592
|
/**
|
|
3280
3593
|
* - Payment confirm url used to
|
|
3281
3594
|
* redirect after payment is confirmed.
|
|
@@ -3329,9 +3642,9 @@ declare function ArticleGiftDetail(): ArticleGiftDetail;
|
|
|
3329
3642
|
type ArticleGiftDetail = {
|
|
3330
3643
|
article_id?: GiftDetail;
|
|
3331
3644
|
};
|
|
3332
|
-
/** @returns {
|
|
3333
|
-
declare function
|
|
3334
|
-
type
|
|
3645
|
+
/** @returns {CartMetaCreation} */
|
|
3646
|
+
declare function CartMetaCreation(): CartMetaCreation;
|
|
3647
|
+
type CartMetaCreation = {
|
|
3335
3648
|
/**
|
|
3336
3649
|
* - Delivery slots details includes article
|
|
3337
3650
|
* level time slot when the shipment can be delivered.
|
|
@@ -3362,9 +3675,9 @@ type CartMetaRequest = {
|
|
|
3362
3675
|
*/
|
|
3363
3676
|
custom_cart_meta?: any;
|
|
3364
3677
|
};
|
|
3365
|
-
/** @returns {
|
|
3366
|
-
declare function
|
|
3367
|
-
type
|
|
3678
|
+
/** @returns {CartMetaResult} */
|
|
3679
|
+
declare function CartMetaResult(): CartMetaResult;
|
|
3680
|
+
type CartMetaResult = {
|
|
3368
3681
|
/**
|
|
3369
3682
|
* - Detailed message.
|
|
3370
3683
|
*/
|
|
@@ -3374,17 +3687,17 @@ type CartMetaResponse = {
|
|
|
3374
3687
|
*/
|
|
3375
3688
|
is_valid?: boolean;
|
|
3376
3689
|
};
|
|
3377
|
-
/** @returns {
|
|
3378
|
-
declare function
|
|
3379
|
-
type
|
|
3690
|
+
/** @returns {CartMetaMissingResult} */
|
|
3691
|
+
declare function CartMetaMissingResult(): CartMetaMissingResult;
|
|
3692
|
+
type CartMetaMissingResult = {
|
|
3380
3693
|
/**
|
|
3381
3694
|
* - Detailed errors for invalid cart meta request.
|
|
3382
3695
|
*/
|
|
3383
3696
|
errors?: string[];
|
|
3384
3697
|
};
|
|
3385
|
-
/** @returns {
|
|
3386
|
-
declare function
|
|
3387
|
-
type
|
|
3698
|
+
/** @returns {GetShareCartLinkCreation} */
|
|
3699
|
+
declare function GetShareCartLinkCreation(): GetShareCartLinkCreation;
|
|
3700
|
+
type GetShareCartLinkCreation = {
|
|
3388
3701
|
/**
|
|
3389
3702
|
* - Cart id of user cart for generating cart sharing token.
|
|
3390
3703
|
*/
|
|
@@ -3395,9 +3708,9 @@ type GetShareCartLinkRequest = {
|
|
|
3395
3708
|
*/
|
|
3396
3709
|
meta?: any;
|
|
3397
3710
|
};
|
|
3398
|
-
/** @returns {
|
|
3399
|
-
declare function
|
|
3400
|
-
type
|
|
3711
|
+
/** @returns {GetShareCartLinkResult} */
|
|
3712
|
+
declare function GetShareCartLinkResult(): GetShareCartLinkResult;
|
|
3713
|
+
type GetShareCartLinkResult = {
|
|
3401
3714
|
/**
|
|
3402
3715
|
* - Short url unique id of the cart which is opted
|
|
3403
3716
|
* to share with other user.
|
|
@@ -3508,9 +3821,9 @@ type SharedCart = {
|
|
|
3508
3821
|
*/
|
|
3509
3822
|
custom_cart_meta?: any;
|
|
3510
3823
|
};
|
|
3511
|
-
/** @returns {
|
|
3512
|
-
declare function
|
|
3513
|
-
type
|
|
3824
|
+
/** @returns {SharedCartResult} */
|
|
3825
|
+
declare function SharedCartResult(): SharedCartResult;
|
|
3826
|
+
type SharedCartResult = {
|
|
3514
3827
|
/**
|
|
3515
3828
|
* - Error details if any error occurs which includes
|
|
3516
3829
|
* type of error, error code and error message.
|
|
@@ -3540,6 +3853,20 @@ type ItemPriceDetails = {
|
|
|
3540
3853
|
*/
|
|
3541
3854
|
currency?: string;
|
|
3542
3855
|
};
|
|
3856
|
+
/** @returns {ArticlePriceDetails} */
|
|
3857
|
+
declare function ArticlePriceDetails(): ArticlePriceDetails;
|
|
3858
|
+
type ArticlePriceDetails = {
|
|
3859
|
+
/**
|
|
3860
|
+
* - The Marked Price refers to the initial price of
|
|
3861
|
+
* the free gift article before product discount.
|
|
3862
|
+
*/
|
|
3863
|
+
marked?: number;
|
|
3864
|
+
/**
|
|
3865
|
+
* - The Effective Price refers to the final
|
|
3866
|
+
* amount of the free gift article after applying the product discount.
|
|
3867
|
+
*/
|
|
3868
|
+
effective?: number;
|
|
3869
|
+
};
|
|
3543
3870
|
/** @returns {FreeGiftItems} */
|
|
3544
3871
|
declare function FreeGiftItems(): FreeGiftItems;
|
|
3545
3872
|
type FreeGiftItems = {
|
|
@@ -3553,6 +3880,7 @@ type FreeGiftItems = {
|
|
|
3553
3880
|
*/
|
|
3554
3881
|
item_name?: string;
|
|
3555
3882
|
item_price_details?: ItemPriceDetails;
|
|
3883
|
+
article_price?: ArticlePriceDetails;
|
|
3556
3884
|
/**
|
|
3557
3885
|
* - Item brand name of the free gift item
|
|
3558
3886
|
* promotion applied on cart.
|
|
@@ -3562,6 +3890,14 @@ type FreeGiftItems = {
|
|
|
3562
3890
|
* - Item id of the free gift item.
|
|
3563
3891
|
*/
|
|
3564
3892
|
item_id?: number;
|
|
3893
|
+
/**
|
|
3894
|
+
* - Available sizes for the free gift item.
|
|
3895
|
+
*/
|
|
3896
|
+
available_sizes?: string[];
|
|
3897
|
+
/**
|
|
3898
|
+
* - Selected size for the free gift item.
|
|
3899
|
+
*/
|
|
3900
|
+
size?: string;
|
|
3565
3901
|
/**
|
|
3566
3902
|
* - Images URLs for free gift items.
|
|
3567
3903
|
*/
|
|
@@ -3620,9 +3956,9 @@ type PromotionOffer = {
|
|
|
3620
3956
|
*/
|
|
3621
3957
|
description?: string;
|
|
3622
3958
|
};
|
|
3623
|
-
/** @returns {
|
|
3624
|
-
declare function
|
|
3625
|
-
type
|
|
3959
|
+
/** @returns {PromotionOffersResult} */
|
|
3960
|
+
declare function PromotionOffersResult(): PromotionOffersResult;
|
|
3961
|
+
type PromotionOffersResult = {
|
|
3626
3962
|
/**
|
|
3627
3963
|
* - Available promotion
|
|
3628
3964
|
* details which are available on product which includes promotion data like
|
|
@@ -3681,9 +4017,9 @@ type PromotionPaymentOffer = {
|
|
|
3681
4017
|
*/
|
|
3682
4018
|
promotion_name?: string;
|
|
3683
4019
|
};
|
|
3684
|
-
/** @returns {
|
|
3685
|
-
declare function
|
|
3686
|
-
type
|
|
4020
|
+
/** @returns {PromotionPaymentOffersResult} */
|
|
4021
|
+
declare function PromotionPaymentOffersResult(): PromotionPaymentOffersResult;
|
|
4022
|
+
type PromotionPaymentOffersResult = {
|
|
3687
4023
|
/**
|
|
3688
4024
|
* - Success flag of get payment offers API response.
|
|
3689
4025
|
*/
|
|
@@ -3694,9 +4030,9 @@ type PromotionPaymentOffersResponse = {
|
|
|
3694
4030
|
*/
|
|
3695
4031
|
promotions?: PromotionPaymentOffer[];
|
|
3696
4032
|
};
|
|
3697
|
-
/** @returns {
|
|
3698
|
-
declare function
|
|
3699
|
-
type
|
|
4033
|
+
/** @returns {OperationErrorResult} */
|
|
4034
|
+
declare function OperationErrorResult(): OperationErrorResult;
|
|
4035
|
+
type OperationErrorResult = {
|
|
3700
4036
|
/**
|
|
3701
4037
|
* - Message of get payment offer API response.
|
|
3702
4038
|
*/
|
|
@@ -3875,17 +4211,15 @@ type PaymentMethod = {
|
|
|
3875
4211
|
*/
|
|
3876
4212
|
payment_extra_identifiers?: any;
|
|
3877
4213
|
};
|
|
3878
|
-
/** @returns {
|
|
3879
|
-
declare function
|
|
3880
|
-
type
|
|
4214
|
+
/** @returns {CartCheckoutDetailV2Creation} */
|
|
4215
|
+
declare function CartCheckoutDetailV2Creation(): CartCheckoutDetailV2Creation;
|
|
4216
|
+
type CartCheckoutDetailV2Creation = {
|
|
3881
4217
|
/**
|
|
3882
|
-
* - Custom meta data to be
|
|
4218
|
+
* - Custom meta data to be
|
|
4219
|
+
* added in order.
|
|
3883
4220
|
*/
|
|
3884
|
-
custom_meta?:
|
|
3885
|
-
|
|
3886
|
-
* - Customer details to be added in order.
|
|
3887
|
-
*/
|
|
3888
|
-
customer_details?: any;
|
|
4221
|
+
custom_meta?: CartCheckoutCustomMeta[];
|
|
4222
|
+
customer_details?: CustomerDetails;
|
|
3889
4223
|
/**
|
|
3890
4224
|
* - Merchant code of the payment mode
|
|
3891
4225
|
* selected to do the payment.
|
|
@@ -3992,3 +4326,15 @@ type CartCheckoutDetailV2Request = {
|
|
|
3992
4326
|
*/
|
|
3993
4327
|
card_id?: string;
|
|
3994
4328
|
};
|
|
4329
|
+
/** @returns {ValidationError} */
|
|
4330
|
+
declare function ValidationError(): ValidationError;
|
|
4331
|
+
type ValidationError = {
|
|
4332
|
+
/**
|
|
4333
|
+
* - A brief description of the error encountered.
|
|
4334
|
+
*/
|
|
4335
|
+
message: string;
|
|
4336
|
+
/**
|
|
4337
|
+
* - The field in the request that caused the error.
|
|
4338
|
+
*/
|
|
4339
|
+
field: string;
|
|
4340
|
+
};
|