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