@gofynd/fdk-client-javascript 1.0.2 → 1.0.4
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 +31 -2
- package/index.d.ts +4 -4
- package/index.js +9 -10
- package/package.json +14 -14
- package/sdk/APIClient.d.ts +11 -0
- package/sdk/APIClient.js +35 -0
- package/sdk/Client.d.ts +6 -0
- package/sdk/Client.js +17 -0
- package/sdk/Config.d.ts +9 -0
- package/sdk/Config.js +17 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +243 -243
- package/sdk/application/Cart/CartApplicationClient.js +595 -594
- package/sdk/application/Cart/CartApplicationModel.d.ts +64 -63
- package/sdk/application/Cart/CartApplicationModel.js +490 -885
- package/sdk/application/Cart/CartApplicationValidator.d.ts +17 -17
- package/sdk/application/Cart/CartApplicationValidator.js +98 -98
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +358 -358
- package/sdk/application/Catalog/CatalogApplicationClient.js +1079 -1078
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +90 -90
- package/sdk/application/Catalog/CatalogApplicationModel.js +683 -1249
- package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +19 -19
- package/sdk/application/Catalog/CatalogApplicationValidator.js +110 -110
- package/sdk/application/Common/CommonApplicationClient.d.ts +13 -13
- package/sdk/application/Common/CommonApplicationClient.js +43 -42
- package/sdk/application/Common/CommonApplicationModel.d.ts +12 -12
- package/sdk/application/Common/CommonApplicationModel.js +83 -160
- package/sdk/application/Common/CommonApplicationValidator.d.ts +1 -1
- package/sdk/application/Common/CommonApplicationValidator.js +6 -6
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +11 -11
- package/sdk/application/Communication/CommunicationApplicationClient.js +32 -31
- package/sdk/application/Communication/CommunicationApplicationModel.d.ts +6 -6
- package/sdk/application/Communication/CommunicationApplicationModel.js +38 -83
- package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +1 -1
- package/sdk/application/Communication/CommunicationApplicationValidator.js +4 -4
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +116 -116
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +350 -349
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +85 -85
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +480 -851
- package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +8 -8
- package/sdk/application/Configuration/ConfigurationApplicationValidator.js +33 -33
- package/sdk/application/Content/ContentApplicationClient.d.ts +67 -67
- package/sdk/application/Content/ContentApplicationClient.js +216 -215
- package/sdk/application/Content/ContentApplicationModel.d.ts +76 -76
- package/sdk/application/Content/ContentApplicationModel.js +468 -884
- package/sdk/application/Content/ContentApplicationValidator.d.ts +5 -5
- package/sdk/application/Content/ContentApplicationValidator.js +24 -24
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +25 -25
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +65 -64
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +13 -13
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +86 -169
- package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +1 -1
- package/sdk/application/FileStorage/FileStorageApplicationValidator.js +7 -7
- package/sdk/application/Lead/LeadApplicationClient.d.ts +24 -24
- package/sdk/application/Lead/LeadApplicationClient.js +109 -108
- package/sdk/application/Lead/LeadApplicationModel.d.ts +35 -35
- package/sdk/application/Lead/LeadApplicationModel.js +267 -474
- package/sdk/application/Lead/LeadApplicationValidator.d.ts +2 -2
- package/sdk/application/Lead/LeadApplicationValidator.js +11 -11
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +31 -22
- package/sdk/application/Logistic/LogisticApplicationClient.js +115 -49
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +17 -14
- package/sdk/application/Logistic/LogisticApplicationModel.js +133 -201
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +3 -2
- package/sdk/application/Logistic/LogisticApplicationValidator.js +14 -9
- package/sdk/application/Order/OrderApplicationClient.d.ts +85 -85
- package/sdk/application/Order/OrderApplicationClient.js +247 -246
- package/sdk/application/Order/OrderApplicationModel.d.ts +50 -50
- package/sdk/application/Order/OrderApplicationModel.js +361 -656
- package/sdk/application/Order/OrderApplicationValidator.d.ts +7 -7
- package/sdk/application/Order/OrderApplicationValidator.js +28 -28
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +318 -318
- package/sdk/application/Payment/PaymentApplicationClient.js +781 -780
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +72 -72
- package/sdk/application/Payment/PaymentApplicationModel.js +570 -1038
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +28 -28
- package/sdk/application/Payment/PaymentApplicationValidator.js +107 -107
- package/sdk/application/PosCart/PosCartApplicationClient.d.ts +254 -254
- package/sdk/application/PosCart/PosCartApplicationClient.js +646 -645
- package/sdk/application/PosCart/PosCartApplicationModel.d.ts +64 -63
- package/sdk/application/PosCart/PosCartApplicationModel.js +476 -870
- package/sdk/application/PosCart/PosCartApplicationValidator.d.ts +18 -18
- package/sdk/application/PosCart/PosCartApplicationValidator.js +103 -103
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +27 -27
- package/sdk/application/Rewards/RewardsApplicationClient.js +122 -121
- package/sdk/application/Rewards/RewardsApplicationModel.d.ts +14 -14
- package/sdk/application/Rewards/RewardsApplicationModel.js +96 -191
- package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +3 -3
- package/sdk/application/Rewards/RewardsApplicationValidator.js +12 -12
- package/sdk/application/Share/ShareApplicationClient.d.ts +37 -37
- package/sdk/application/Share/ShareApplicationClient.js +94 -93
- package/sdk/application/Share/ShareApplicationModel.d.ts +8 -8
- package/sdk/application/Share/ShareApplicationModel.js +63 -123
- package/sdk/application/Share/ShareApplicationValidator.d.ts +4 -4
- package/sdk/application/Share/ShareApplicationValidator.js +12 -12
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
- package/sdk/application/Theme/ThemeApplicationClient.js +38 -37
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +34 -34
- package/sdk/application/Theme/ThemeApplicationModel.js +190 -336
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +1 -1
- package/sdk/application/Theme/ThemeApplicationValidator.js +4 -4
- package/sdk/application/User/UserApplicationClient.d.ts +280 -280
- package/sdk/application/User/UserApplicationClient.js +619 -618
- package/sdk/application/User/UserApplicationModel.d.ts +79 -72
- package/sdk/application/User/UserApplicationModel.js +440 -689
- package/sdk/application/User/UserApplicationValidator.d.ts +24 -24
- package/sdk/application/User/UserApplicationValidator.js +89 -89
- package/sdk/common/AxiosHelper.js +18 -7
- package/sdk/constructUrl.d.ts +5 -0
- package/sdk/constructUrl.js +13 -0
- package/sdk/index.d.ts +3 -0
- package/sdk/index.js +5 -0
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +51 -51
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +182 -180
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +6 -6
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +21 -21
- package/sdk/platform/Analytics/AnalyticsPlatformClient.js +5 -4
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +11 -11
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +95 -178
- package/sdk/platform/Analytics/AnalyticsPlatformValidator.js +1 -0
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +10 -10
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +44 -43
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +10 -10
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +50 -89
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +7 -6
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +60 -60
- package/sdk/platform/Billing/BillingPlatformClient.js +184 -183
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +40 -40
- package/sdk/platform/Billing/BillingPlatformModel.js +342 -668
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +8 -8
- package/sdk/platform/Billing/BillingPlatformValidator.js +26 -25
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +192 -165
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +686 -510
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +14 -11
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +77 -61
- package/sdk/platform/Cart/CartPlatformModel.d.ts +84 -83
- package/sdk/platform/Cart/CartPlatformModel.js +676 -1206
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +632 -632
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1558 -1556
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +40 -40
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +175 -175
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +688 -688
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1556 -1559
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +291 -291
- package/sdk/platform/Catalog/CatalogPlatformModel.js +2133 -3910
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +66 -66
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +229 -228
- package/sdk/platform/Common/CommonPlatformClient.d.ts +12 -12
- package/sdk/platform/Common/CommonPlatformClient.js +40 -51
- package/sdk/platform/Common/CommonPlatformModel.d.ts +12 -12
- package/sdk/platform/Common/CommonPlatformModel.js +83 -160
- package/sdk/platform/Common/CommonPlatformValidator.d.ts +1 -1
- package/sdk/platform/Common/CommonPlatformValidator.js +7 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +326 -326
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +945 -943
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +30 -30
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +88 -88
- package/sdk/platform/Communication/CommunicationPlatformClient.js +4 -3
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +67 -67
- package/sdk/platform/Communication/CommunicationPlatformModel.js +522 -974
- package/sdk/platform/Communication/CommunicationPlatformValidator.js +1 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +55 -55
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +217 -216
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +27 -27
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +279 -542
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +7 -7
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +25 -24
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +163 -153
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +617 -552
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +22 -21
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +70 -64
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +125 -125
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +348 -347
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +148 -146
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +854 -1508
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +9 -9
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +39 -38
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +524 -534
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1287 -1346
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +49 -50
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +153 -159
- package/sdk/platform/Content/ContentPlatformModel.d.ts +78 -78
- package/sdk/platform/Content/ContentPlatformModel.js +485 -907
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +65 -65
- package/sdk/platform/Discount/DiscountPlatformClient.js +219 -218
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +7 -7
- package/sdk/platform/Discount/DiscountPlatformModel.js +60 -121
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +6 -6
- package/sdk/platform/Discount/DiscountPlatformValidator.js +30 -29
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +25 -25
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +83 -61
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +9 -9
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +53 -53
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +147 -125
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +13 -13
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +86 -169
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +3 -3
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +12 -11
- package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +63 -63
- package/sdk/platform/Inventory/InventoryPlatformClient.js +231 -230
- package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +30 -30
- package/sdk/platform/Inventory/InventoryPlatformModel.js +497 -964
- package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +7 -7
- package/sdk/platform/Inventory/InventoryPlatformValidator.js +29 -28
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +73 -73
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +203 -201
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +7 -7
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +29 -29
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +80 -80
- package/sdk/platform/Lead/LeadPlatformClient.js +215 -214
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +35 -35
- package/sdk/platform/Lead/LeadPlatformModel.js +267 -474
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +6 -6
- package/sdk/platform/Lead/LeadPlatformValidator.js +25 -24
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +68 -66
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +7 -7
- package/sdk/platform/Order/OrderPlatformClient.d.ts +357 -357
- package/sdk/platform/Order/OrderPlatformClient.js +1046 -1033
- package/sdk/platform/Order/OrderPlatformModel.d.ts +198 -196
- package/sdk/platform/Order/OrderPlatformModel.js +1575 -2861
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +32 -32
- package/sdk/platform/Order/OrderPlatformValidator.js +161 -160
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +3 -1
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +1 -1
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +1 -1
- package/sdk/platform/Partner/PartnerPlatformModel.js +10 -26
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +58 -58
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +178 -178
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +6 -6
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +24 -24
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +42 -42
- package/sdk/platform/Payment/PaymentPlatformClient.js +156 -155
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +27 -27
- package/sdk/platform/Payment/PaymentPlatformModel.js +222 -410
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +4 -4
- package/sdk/platform/Payment/PaymentPlatformValidator.js +22 -21
- package/sdk/platform/PlatformApplicationClient.d.ts +1496 -10325
- package/sdk/platform/PlatformApplicationClient.js +1584 -13899
- package/sdk/platform/PlatformClient.d.ts +7972 -7888
- package/sdk/platform/PlatformClient.js +8678 -10107
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +85 -85
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +299 -280
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +8 -8
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +35 -35
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +15 -15
- package/sdk/platform/Rewards/RewardsPlatformModel.js +92 -194
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Share/SharePlatformApplicationClient.js +62 -60
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +7 -7
- package/sdk/platform/Share/SharePlatformModel.d.ts +8 -8
- package/sdk/platform/Share/SharePlatformModel.js +60 -118
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +132 -132
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +314 -312
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +15 -15
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +45 -45
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +34 -34
- package/sdk/platform/Theme/ThemePlatformModel.js +190 -336
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +136 -69
- package/sdk/platform/User/UserPlatformApplicationClient.js +507 -166
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +12 -7
- package/sdk/platform/User/UserPlatformApplicationValidator.js +62 -24
- package/sdk/platform/User/UserPlatformModel.d.ts +79 -72
- package/sdk/platform/User/UserPlatformModel.js +440 -689
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +31 -31
- package/sdk/platform/Webhook/WebhookPlatformClient.js +91 -90
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +7 -7
- package/sdk/platform/Webhook/WebhookPlatformModel.js +68 -136
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +3 -3
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +15 -14
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +13 -13
- package/sdk/public/Configuration/ConfigurationPublicClient.js +40 -38
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +12 -12
- package/sdk/public/Configuration/ConfigurationPublicModel.js +85 -162
- package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +1 -1
- package/sdk/public/Configuration/ConfigurationPublicValidator.js +6 -6
- package/sdk/public/Inventory/InventoryPublicClient.d.ts +34 -34
- package/sdk/public/Inventory/InventoryPublicClient.js +115 -113
- package/sdk/public/Inventory/InventoryPublicModel.d.ts +10 -10
- package/sdk/public/Inventory/InventoryPublicModel.js +119 -245
- package/sdk/public/Inventory/InventoryPublicValidator.d.ts +3 -3
- package/sdk/public/Inventory/InventoryPublicValidator.js +15 -15
- package/sdk/public/Webhook/WebhookPublicClient.js +2 -0
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +7 -7
- package/sdk/public/Webhook/WebhookPublicModel.js +68 -136
- package/.github/workflows/on_create_release.yml +0 -23
- package/.github/workflows/on_merge_main.yml +0 -38
- package/.github/workflows/on_pull_request.yml +0 -35
- package/.prettierrc +0 -5
- package/documentation/application/CART.md +0 -7339
- package/documentation/application/CATALOG.md +0 -9597
- package/documentation/application/COMMON.md +0 -452
- package/documentation/application/COMMUNICATION.md +0 -467
- package/documentation/application/CONFIGURATION.md +0 -2906
- package/documentation/application/CONTENT.md +0 -3351
- package/documentation/application/FILESTORAGE.md +0 -578
- package/documentation/application/LEAD.md +0 -1895
- package/documentation/application/LOGISTIC.md +0 -765
- package/documentation/application/ORDER.md +0 -3432
- package/documentation/application/PAYMENT.md +0 -5221
- package/documentation/application/POSCART.md +0 -7938
- package/documentation/application/README.md +0 -21
- package/documentation/application/REWARDS.md +0 -708
- package/documentation/application/SHARE.md +0 -733
- package/documentation/application/THEME.md +0 -5800
- package/documentation/application/USER.md +0 -4335
- package/documentation/platform/ANALYTICS.md +0 -1154
- package/documentation/platform/AUDITTRAIL.md +0 -576
- package/documentation/platform/BILLING.md +0 -2400
- package/documentation/platform/CART.md +0 -5559
- package/documentation/platform/CATALOG.md +0 -23261
- package/documentation/platform/COMMON.md +0 -452
- package/documentation/platform/COMMUNICATION.md +0 -5718
- package/documentation/platform/COMPANYPROFILE.md +0 -2031
- package/documentation/platform/CONFIGURATION.md +0 -7339
- package/documentation/platform/CONTENT.md +0 -9098
- package/documentation/platform/DISCOUNT.md +0 -863
- package/documentation/platform/FILESTORAGE.md +0 -1081
- package/documentation/platform/INVENTORY.md +0 -1779
- package/documentation/platform/LEAD.md +0 -4740
- package/documentation/platform/ORDER.md +0 -8486
- package/documentation/platform/PARTNER.md +0 -220
- package/documentation/platform/PAYMENT.md +0 -3448
- package/documentation/platform/README.md +0 -27
- package/documentation/platform/REWARDS.md +0 -1083
- package/documentation/platform/SHARE.md +0 -606
- package/documentation/platform/THEME.md +0 -35729
- package/documentation/platform/USER.md +0 -2319
- package/documentation/platform/WEBHOOK.md +0 -591
- package/documentation/public/CONFIGURATION.md +0 -452
- package/documentation/public/INVENTORY.md +0 -690
- package/documentation/public/WEBHOOK.md +0 -352
- package/jest.config.d.ts +0 -4
- package/jest.config.js +0 -6
- package/tests/application/catalog.spec.js +0 -47
- package/tests/common/action-url.spec.js +0 -35
- package/tests/common/schema/action-url.json +0 -178
- package/tests/common/schema/url-action.json +0 -683
- package/tests/common/url-action.spec.js +0 -48
- package/tests/helpers/cookie.helper.js +0 -31
- package/tests/helpers/oauth.helper.js +0 -43
- package/tests/platform/catalog.spec.js +0 -49
- package/tests/public/location.spec.js +0 -39
|
@@ -3,65 +3,45 @@ declare class Cart {
|
|
|
3
3
|
constructor(_conf: any);
|
|
4
4
|
_conf: any;
|
|
5
5
|
_relativeUrls: {
|
|
6
|
-
|
|
7
|
-
getCartLastModified: string;
|
|
6
|
+
addAddress: string;
|
|
8
7
|
addItems: string;
|
|
9
|
-
updateCart: string;
|
|
10
|
-
getItemCount: string;
|
|
11
|
-
getCoupons: string;
|
|
12
8
|
applyCoupon: string;
|
|
13
|
-
removeCoupon: string;
|
|
14
|
-
getBulkDiscountOffers: string;
|
|
15
9
|
applyRewardPoints: string;
|
|
16
|
-
|
|
17
|
-
addAddress: string;
|
|
10
|
+
checkoutCart: string;
|
|
18
11
|
getAddressById: string;
|
|
19
|
-
|
|
12
|
+
getAddresses: string;
|
|
13
|
+
getBulkDiscountOffers: string;
|
|
14
|
+
getCart: string;
|
|
15
|
+
getCartLastModified: string;
|
|
16
|
+
getCartShareLink: string;
|
|
17
|
+
getCartSharedItems: string;
|
|
18
|
+
getCoupons: string;
|
|
19
|
+
getItemCount: string;
|
|
20
|
+
getLadderOffers: string;
|
|
21
|
+
getPromotionOffers: string;
|
|
22
|
+
getShipments: string;
|
|
20
23
|
removeAddress: string;
|
|
24
|
+
removeCoupon: string;
|
|
21
25
|
selectAddress: string;
|
|
22
26
|
selectPaymentMode: string;
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
checkoutCart: string;
|
|
27
|
+
updateAddress: string;
|
|
28
|
+
updateCart: string;
|
|
26
29
|
updateCartMeta: string;
|
|
27
|
-
getCartShareLink: string;
|
|
28
|
-
getCartSharedItems: string;
|
|
29
30
|
updateCartWithSharedItems: string;
|
|
30
|
-
|
|
31
|
-
getLadderOffers: string;
|
|
31
|
+
validateCouponForPayment: string;
|
|
32
32
|
};
|
|
33
33
|
_urls: {};
|
|
34
34
|
updateUrls(urls: any): void;
|
|
35
35
|
/**
|
|
36
36
|
* @param {Object} arg - Arg object.
|
|
37
|
-
* @param {
|
|
38
|
-
* @
|
|
39
|
-
* @
|
|
40
|
-
* @
|
|
41
|
-
* @param {string} [arg.areaCode] -
|
|
42
|
-
* @param {boolean} [arg.buyNow] -
|
|
43
|
-
* @returns {Promise<CartDetailResponse>} - Success response
|
|
44
|
-
* @summary: Fetch all items added to the cart
|
|
45
|
-
* @description: Use this API to get details of all the items added to a cart.
|
|
46
|
-
*/
|
|
47
|
-
getCart({ id, i, b, assignCardId, areaCode, buyNow }?: {
|
|
48
|
-
id?: string;
|
|
49
|
-
i?: boolean;
|
|
50
|
-
b?: boolean;
|
|
51
|
-
assignCardId?: number;
|
|
52
|
-
areaCode?: string;
|
|
53
|
-
buyNow?: boolean;
|
|
54
|
-
}): Promise<CartDetailResponse>;
|
|
55
|
-
/**
|
|
56
|
-
* @param {Object} arg - Arg object.
|
|
57
|
-
* @param {string} [arg.id] -
|
|
58
|
-
* @returns {Promise<any>} - Success response
|
|
59
|
-
* @summary: Fetch last-modified timestamp
|
|
60
|
-
* @description: Use this API to fetch Last-Modified timestamp in header metadata.
|
|
37
|
+
* @param {Address} arg.body
|
|
38
|
+
* @returns {Promise<SaveAddressResponse>} - Success response
|
|
39
|
+
* @summary: Add address to an account
|
|
40
|
+
* @description: Use this API to add an address to an account.
|
|
61
41
|
*/
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
}): Promise<
|
|
42
|
+
addAddress({ body }?: {
|
|
43
|
+
body: Address;
|
|
44
|
+
}): Promise<SaveAddressResponse>;
|
|
65
45
|
/**
|
|
66
46
|
* @param {Object} arg - Arg object.
|
|
67
47
|
* @param {boolean} [arg.i] -
|
|
@@ -80,50 +60,6 @@ declare class Cart {
|
|
|
80
60
|
buyNow?: boolean;
|
|
81
61
|
body: AddCartRequest;
|
|
82
62
|
}): Promise<AddCartDetailResponse>;
|
|
83
|
-
/**
|
|
84
|
-
* @param {Object} arg - Arg object.
|
|
85
|
-
* @param {string} [arg.id] -
|
|
86
|
-
* @param {boolean} [arg.i] -
|
|
87
|
-
* @param {boolean} [arg.b] -
|
|
88
|
-
* @param {string} [arg.areaCode] -
|
|
89
|
-
* @param {boolean} [arg.buyNow] -
|
|
90
|
-
* @param {UpdateCartRequest} arg.body
|
|
91
|
-
* @returns {Promise<UpdateCartDetailResponse>} - Success response
|
|
92
|
-
* @summary: Update items in the cart
|
|
93
|
-
* @description: <p>Use this API to update items added to the cart with the help of a request object containing attributes like item_quantity and item_size. These attributes will be fetched from the following APIs</p> <ul> <li><font color="monochrome">operation</font> Operation for current api call. <b>update_item</b> for update items. <b>remove_item</b> for removing items.</li> <li> <font color="monochrome">item_id</font> "/platform/content/v1/products/"</li> <li> <font color="monochrome">item_size</font> "/platform/content/v1/products/:slug/sizes/"</li> <li> <font color="monochrome">quantity</font> item quantity (must be greater than or equal to 1)</li> <li> <font color="monochrome">article_id</font> "/content/v1/products/:identifier/sizes/price/"</li> <li> <font color="monochrome">item_index</font> item position in the cart (must be greater than or equal to 0)</li> </ul>
|
|
94
|
-
*/
|
|
95
|
-
updateCart({ body, id, i, b, areaCode, buyNow }?: {
|
|
96
|
-
id?: string;
|
|
97
|
-
i?: boolean;
|
|
98
|
-
b?: boolean;
|
|
99
|
-
areaCode?: string;
|
|
100
|
-
buyNow?: boolean;
|
|
101
|
-
body: UpdateCartRequest;
|
|
102
|
-
}): Promise<UpdateCartDetailResponse>;
|
|
103
|
-
/**
|
|
104
|
-
* @param {Object} arg - Arg object.
|
|
105
|
-
* @param {string} [arg.id] - The unique identifier of the cart.
|
|
106
|
-
* @param {boolean} [arg.buyNow] -
|
|
107
|
-
* @returns {Promise<CartItemCountResponse>} - Success response
|
|
108
|
-
* @summary: Count items in the cart
|
|
109
|
-
* @description: Use this API to get the total number of items present in cart.
|
|
110
|
-
*/
|
|
111
|
-
getItemCount({ id, buyNow }?: {
|
|
112
|
-
id?: string;
|
|
113
|
-
buyNow?: boolean;
|
|
114
|
-
}): Promise<CartItemCountResponse>;
|
|
115
|
-
/**
|
|
116
|
-
* @param {Object} arg - Arg object.
|
|
117
|
-
* @param {string} [arg.id] -
|
|
118
|
-
* @param {boolean} [arg.buyNow] -
|
|
119
|
-
* @returns {Promise<GetCouponResponse>} - Success response
|
|
120
|
-
* @summary: Fetch Coupon
|
|
121
|
-
* @description: Use this API to get a list of available coupons along with their details.
|
|
122
|
-
*/
|
|
123
|
-
getCoupons({ id, buyNow }?: {
|
|
124
|
-
id?: string;
|
|
125
|
-
buyNow?: boolean;
|
|
126
|
-
}): Promise<GetCouponResponse>;
|
|
127
63
|
/**
|
|
128
64
|
* @param {Object} arg - Arg object.
|
|
129
65
|
* @param {boolean} [arg.i] -
|
|
@@ -147,15 +83,75 @@ declare class Cart {
|
|
|
147
83
|
/**
|
|
148
84
|
* @param {Object} arg - Arg object.
|
|
149
85
|
* @param {string} [arg.id] -
|
|
86
|
+
* @param {boolean} [arg.i] -
|
|
87
|
+
* @param {boolean} [arg.b] -
|
|
150
88
|
* @param {boolean} [arg.buyNow] -
|
|
89
|
+
* @param {RewardPointRequest} arg.body
|
|
151
90
|
* @returns {Promise<CartDetailResponse>} - Success response
|
|
152
|
-
* @summary:
|
|
153
|
-
* @description:
|
|
91
|
+
* @summary: Apply reward points at cart
|
|
92
|
+
* @description: Use this API to redeem a fixed no. of reward points by applying it to the cart.
|
|
154
93
|
*/
|
|
155
|
-
|
|
94
|
+
applyRewardPoints({ body, id, i, b, buyNow }?: {
|
|
156
95
|
id?: string;
|
|
96
|
+
i?: boolean;
|
|
97
|
+
b?: boolean;
|
|
157
98
|
buyNow?: boolean;
|
|
99
|
+
body: RewardPointRequest;
|
|
158
100
|
}): Promise<CartDetailResponse>;
|
|
101
|
+
/**
|
|
102
|
+
* @param {Object} arg - Arg object.
|
|
103
|
+
* @param {boolean} [arg.buyNow] - This indicates the type of cart to checkout
|
|
104
|
+
* @param {CartCheckoutDetailRequest} arg.body
|
|
105
|
+
* @returns {Promise<CartCheckoutResponse>} - Success response
|
|
106
|
+
* @summary: Checkout all items in the cart
|
|
107
|
+
* @description: Use this API to checkout all items in the cart for payment and order generation. For COD, order will be directly generated, whereas for other checkout modes, user will be redirected to a payment gateway.
|
|
108
|
+
*/
|
|
109
|
+
checkoutCart({ body, buyNow }?: {
|
|
110
|
+
buyNow?: boolean;
|
|
111
|
+
body: CartCheckoutDetailRequest;
|
|
112
|
+
}): Promise<CartCheckoutResponse>;
|
|
113
|
+
/**
|
|
114
|
+
* @param {Object} arg - Arg object.
|
|
115
|
+
* @param {string} arg.id -
|
|
116
|
+
* @param {string} [arg.cartId] -
|
|
117
|
+
* @param {boolean} [arg.buyNow] -
|
|
118
|
+
* @param {string} [arg.mobileNo] -
|
|
119
|
+
* @param {string} [arg.checkoutMode] -
|
|
120
|
+
* @param {string} [arg.tags] -
|
|
121
|
+
* @param {boolean} [arg.isDefault] -
|
|
122
|
+
* @returns {Promise<Address>} - Success response
|
|
123
|
+
* @summary: Fetch a single address by its ID
|
|
124
|
+
* @description: Use this API to get an addresses using its ID. If successful, returns a Address resource in the response body specified in `Address`. Attibutes listed below are optional <ul> <li> <font color="monochrome">mobile_no</font></li> <li> <font color="monochrome">checkout_mode</font></li> <li> <font color="monochrome">tags</font></li> <li> <font color="monochrome">default</font></li> </ul>
|
|
125
|
+
*/
|
|
126
|
+
getAddressById({ id, cartId, buyNow, mobileNo, checkoutMode, tags, isDefault, }?: {
|
|
127
|
+
id: string;
|
|
128
|
+
cartId?: string;
|
|
129
|
+
buyNow?: boolean;
|
|
130
|
+
mobileNo?: string;
|
|
131
|
+
checkoutMode?: string;
|
|
132
|
+
tags?: string;
|
|
133
|
+
isDefault?: boolean;
|
|
134
|
+
}): Promise<Address>;
|
|
135
|
+
/**
|
|
136
|
+
* @param {Object} arg - Arg object.
|
|
137
|
+
* @param {string} [arg.cartId] -
|
|
138
|
+
* @param {boolean} [arg.buyNow] -
|
|
139
|
+
* @param {string} [arg.mobileNo] -
|
|
140
|
+
* @param {string} [arg.checkoutMode] -
|
|
141
|
+
* @param {string} [arg.tags] -
|
|
142
|
+
* @param {boolean} [arg.isDefault] -
|
|
143
|
+
* @returns {Promise<GetAddressesResponse>} - Success response
|
|
144
|
+
* @summary: Fetch address
|
|
145
|
+
* @description: Use this API to get all the addresses associated with an account. If successful, returns a Address resource in the response body specified in GetAddressesResponse.attibutes listed below are optional <ul> <li> <font color="monochrome">uid</font></li> <li> <font color="monochrome">address_id</font></li> <li> <font color="monochrome">mobile_no</font></li> <li> <font color="monochrome">checkout_mode</font></li> <li> <font color="monochrome">tags</font></li> <li> <font color="monochrome">default</font></li> </ul>
|
|
146
|
+
*/
|
|
147
|
+
getAddresses({ cartId, buyNow, mobileNo, checkoutMode, tags, isDefault, }?: {
|
|
148
|
+
cartId?: string;
|
|
149
|
+
buyNow?: boolean;
|
|
150
|
+
mobileNo?: string;
|
|
151
|
+
checkoutMode?: string;
|
|
152
|
+
tags?: string;
|
|
153
|
+
isDefault?: boolean;
|
|
154
|
+
}): Promise<GetAddressesResponse>;
|
|
159
155
|
/**
|
|
160
156
|
* @param {Object} arg - Arg object.
|
|
161
157
|
* @param {number} [arg.itemId] - The Item ID of the product
|
|
@@ -179,83 +175,131 @@ declare class Cart {
|
|
|
179
175
|
* @param {string} [arg.id] -
|
|
180
176
|
* @param {boolean} [arg.i] -
|
|
181
177
|
* @param {boolean} [arg.b] -
|
|
178
|
+
* @param {number} [arg.assignCardId] -
|
|
179
|
+
* @param {string} [arg.areaCode] -
|
|
182
180
|
* @param {boolean} [arg.buyNow] -
|
|
183
|
-
* @param {RewardPointRequest} arg.body
|
|
184
181
|
* @returns {Promise<CartDetailResponse>} - Success response
|
|
185
|
-
* @summary:
|
|
186
|
-
* @description: Use this API to
|
|
182
|
+
* @summary: Fetch all items added to the cart
|
|
183
|
+
* @description: Use this API to get details of all the items added to a cart.
|
|
187
184
|
*/
|
|
188
|
-
|
|
185
|
+
getCart({ id, i, b, assignCardId, areaCode, buyNow }?: {
|
|
189
186
|
id?: string;
|
|
190
187
|
i?: boolean;
|
|
191
188
|
b?: boolean;
|
|
189
|
+
assignCardId?: number;
|
|
190
|
+
areaCode?: string;
|
|
192
191
|
buyNow?: boolean;
|
|
193
|
-
body: RewardPointRequest;
|
|
194
192
|
}): Promise<CartDetailResponse>;
|
|
195
193
|
/**
|
|
196
194
|
* @param {Object} arg - Arg object.
|
|
197
|
-
* @param {string} [arg.
|
|
198
|
-
* @
|
|
199
|
-
* @
|
|
200
|
-
* @
|
|
201
|
-
* @param {string} [arg.tags] -
|
|
202
|
-
* @param {boolean} [arg.isDefault] -
|
|
203
|
-
* @returns {Promise<GetAddressesResponse>} - Success response
|
|
204
|
-
* @summary: Fetch address
|
|
205
|
-
* @description: Use this API to get all the addresses associated with an account. If successful, returns a Address resource in the response body specified in GetAddressesResponse.attibutes listed below are optional <ul> <li> <font color="monochrome">uid</font></li> <li> <font color="monochrome">address_id</font></li> <li> <font color="monochrome">mobile_no</font></li> <li> <font color="monochrome">checkout_mode</font></li> <li> <font color="monochrome">tags</font></li> <li> <font color="monochrome">default</font></li> </ul>
|
|
195
|
+
* @param {string} [arg.id] -
|
|
196
|
+
* @returns {Promise<any>} - Success response
|
|
197
|
+
* @summary: Fetch last-modified timestamp
|
|
198
|
+
* @description: Use this API to fetch Last-Modified timestamp in header metadata.
|
|
206
199
|
*/
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
mobileNo?: string;
|
|
211
|
-
checkoutMode?: string;
|
|
212
|
-
tags?: string;
|
|
213
|
-
isDefault?: boolean;
|
|
214
|
-
}): Promise<GetAddressesResponse>;
|
|
200
|
+
getCartLastModified({ id }?: {
|
|
201
|
+
id?: string;
|
|
202
|
+
}): Promise<any>;
|
|
215
203
|
/**
|
|
216
204
|
* @param {Object} arg - Arg object.
|
|
217
|
-
* @param {
|
|
218
|
-
* @returns {Promise<
|
|
219
|
-
* @summary:
|
|
220
|
-
* @description: Use this API to
|
|
205
|
+
* @param {GetShareCartLinkRequest} arg.body
|
|
206
|
+
* @returns {Promise<GetShareCartLinkResponse>} - Success response
|
|
207
|
+
* @summary: Generate token for sharing the cart
|
|
208
|
+
* @description: Use this API to generate a shared cart snapshot and return a shortlink token. The link can be shared with other users for getting the same items in their cart.
|
|
221
209
|
*/
|
|
222
|
-
|
|
223
|
-
body:
|
|
224
|
-
}): Promise<
|
|
210
|
+
getCartShareLink({ body }?: {
|
|
211
|
+
body: GetShareCartLinkRequest;
|
|
212
|
+
}): Promise<GetShareCartLinkResponse>;
|
|
225
213
|
/**
|
|
226
214
|
* @param {Object} arg - Arg object.
|
|
227
|
-
* @param {string} arg.
|
|
228
|
-
* @
|
|
215
|
+
* @param {string} arg.token - Token of the shared short link
|
|
216
|
+
* @returns {Promise<SharedCartResponse>} - Success response
|
|
217
|
+
* @summary: Get details of a shared cart
|
|
218
|
+
* @description: Use this API to get the shared cart details as per the token generated using the share-cart API.
|
|
219
|
+
*/
|
|
220
|
+
getCartSharedItems({ token }?: {
|
|
221
|
+
token: string;
|
|
222
|
+
}): Promise<SharedCartResponse>;
|
|
223
|
+
/**
|
|
224
|
+
* @param {Object} arg - Arg object.
|
|
225
|
+
* @param {string} [arg.id] -
|
|
229
226
|
* @param {boolean} [arg.buyNow] -
|
|
230
|
-
* @
|
|
231
|
-
* @
|
|
232
|
-
* @
|
|
233
|
-
* @param {boolean} [arg.isDefault] -
|
|
234
|
-
* @returns {Promise<Address>} - Success response
|
|
235
|
-
* @summary: Fetch a single address by its ID
|
|
236
|
-
* @description: Use this API to get an addresses using its ID. If successful, returns a Address resource in the response body specified in `Address`. Attibutes listed below are optional <ul> <li> <font color="monochrome">mobile_no</font></li> <li> <font color="monochrome">checkout_mode</font></li> <li> <font color="monochrome">tags</font></li> <li> <font color="monochrome">default</font></li> </ul>
|
|
227
|
+
* @returns {Promise<GetCouponResponse>} - Success response
|
|
228
|
+
* @summary: Fetch Coupon
|
|
229
|
+
* @description: Use this API to get a list of available coupons along with their details.
|
|
237
230
|
*/
|
|
238
|
-
|
|
239
|
-
id
|
|
240
|
-
cartId?: string;
|
|
231
|
+
getCoupons({ id, buyNow }?: {
|
|
232
|
+
id?: string;
|
|
241
233
|
buyNow?: boolean;
|
|
242
|
-
|
|
243
|
-
checkoutMode?: string;
|
|
244
|
-
tags?: string;
|
|
245
|
-
isDefault?: boolean;
|
|
246
|
-
}): Promise<Address>;
|
|
234
|
+
}): Promise<GetCouponResponse>;
|
|
247
235
|
/**
|
|
248
236
|
* @param {Object} arg - Arg object.
|
|
249
|
-
* @param {string} arg.id -
|
|
250
|
-
* @param {
|
|
251
|
-
* @returns {Promise<
|
|
252
|
-
* @summary:
|
|
253
|
-
* @description:
|
|
237
|
+
* @param {string} [arg.id] - The unique identifier of the cart.
|
|
238
|
+
* @param {boolean} [arg.buyNow] -
|
|
239
|
+
* @returns {Promise<CartItemCountResponse>} - Success response
|
|
240
|
+
* @summary: Count items in the cart
|
|
241
|
+
* @description: Use this API to get the total number of items present in cart.
|
|
254
242
|
*/
|
|
255
|
-
|
|
256
|
-
id
|
|
257
|
-
|
|
258
|
-
}): Promise<
|
|
243
|
+
getItemCount({ id, buyNow }?: {
|
|
244
|
+
id?: string;
|
|
245
|
+
buyNow?: boolean;
|
|
246
|
+
}): Promise<CartItemCountResponse>;
|
|
247
|
+
/**
|
|
248
|
+
* @param {Object} arg - Arg object.
|
|
249
|
+
* @param {string} arg.slug - A short, human-readable, URL-friendly
|
|
250
|
+
* identifier of a product. You can get slug value from the endpoint
|
|
251
|
+
* /service/application/catalog/v1.0/products/
|
|
252
|
+
* @param {string} [arg.storeId] - Store uid of assigned store on PDP page.
|
|
253
|
+
* If not passed default first created ladder will be returned
|
|
254
|
+
* @param {string} [arg.promotionId] - Get ladder information of given
|
|
255
|
+
* promotion id explicitely
|
|
256
|
+
* @param {number} [arg.pageSize] - Number of offers to be fetched to show
|
|
257
|
+
* @returns {Promise<LadderPriceOffers>} - Success response
|
|
258
|
+
* @summary: Fetch ladder price promotion
|
|
259
|
+
* @description: Use this API to get applicable ladder price promotion for current product
|
|
260
|
+
*/
|
|
261
|
+
getLadderOffers({ slug, storeId, promotionId, pageSize }?: {
|
|
262
|
+
slug: string;
|
|
263
|
+
storeId?: string;
|
|
264
|
+
promotionId?: string;
|
|
265
|
+
pageSize?: number;
|
|
266
|
+
}): Promise<LadderPriceOffers>;
|
|
267
|
+
/**
|
|
268
|
+
* @param {Object} arg - Arg object.
|
|
269
|
+
* @param {string} [arg.slug] - A short, human-readable, URL-friendly
|
|
270
|
+
* identifier of a product. You can get slug value from the endpoint
|
|
271
|
+
* /service/application/catalog/v1.0/products/
|
|
272
|
+
* @param {number} [arg.pageSize] - Number of offers to be fetched to show
|
|
273
|
+
* @param {string} [arg.promotionGroup] - Type of promotion groups
|
|
274
|
+
* @returns {Promise<PromotionOffersResponse>} - Success response
|
|
275
|
+
* @summary: Fetch available promotions
|
|
276
|
+
* @description: Use this API to get top 5 offers available for current product
|
|
277
|
+
*/
|
|
278
|
+
getPromotionOffers({ slug, pageSize, promotionGroup }?: {
|
|
279
|
+
slug?: string;
|
|
280
|
+
pageSize?: number;
|
|
281
|
+
promotionGroup?: string;
|
|
282
|
+
}): Promise<PromotionOffersResponse>;
|
|
283
|
+
/**
|
|
284
|
+
* @param {Object} arg - Arg object.
|
|
285
|
+
* @param {boolean} [arg.p] - This is a boolean value. Select `true` for
|
|
286
|
+
* getting a payment option in response.
|
|
287
|
+
* @param {string} [arg.id] - The unique identifier of the cart
|
|
288
|
+
* @param {boolean} [arg.buyNow] -
|
|
289
|
+
* @param {string} [arg.addressId] - ID allotted to the selected address
|
|
290
|
+
* @param {string} [arg.areaCode] - The PIN Code of the destination address,
|
|
291
|
+
* e.g. 400059
|
|
292
|
+
* @returns {Promise<CartShipmentsResponse>} - Success response
|
|
293
|
+
* @summary: Get delivery date and options before checkout
|
|
294
|
+
* @description: Use this API to get shipment details, expected delivery date, items and price breakup of the shipment.
|
|
295
|
+
*/
|
|
296
|
+
getShipments({ p, id, buyNow, addressId, areaCode }?: {
|
|
297
|
+
p?: boolean;
|
|
298
|
+
id?: string;
|
|
299
|
+
buyNow?: boolean;
|
|
300
|
+
addressId?: string;
|
|
301
|
+
areaCode?: string;
|
|
302
|
+
}): Promise<CartShipmentsResponse>;
|
|
259
303
|
/**
|
|
260
304
|
* @param {Object} arg - Arg object.
|
|
261
305
|
* @param {string} arg.id - ID allotted to the selected address
|
|
@@ -266,6 +310,18 @@ declare class Cart {
|
|
|
266
310
|
removeAddress({ id }?: {
|
|
267
311
|
id: string;
|
|
268
312
|
}): Promise<DeleteAddressResponse>;
|
|
313
|
+
/**
|
|
314
|
+
* @param {Object} arg - Arg object.
|
|
315
|
+
* @param {string} [arg.id] -
|
|
316
|
+
* @param {boolean} [arg.buyNow] -
|
|
317
|
+
* @returns {Promise<CartDetailResponse>} - Success response
|
|
318
|
+
* @summary: Remove Coupon Applied
|
|
319
|
+
* @description: Remove Coupon applied on the cart by passing uid in request body.
|
|
320
|
+
*/
|
|
321
|
+
removeCoupon({ id, buyNow }?: {
|
|
322
|
+
id?: string;
|
|
323
|
+
buyNow?: boolean;
|
|
324
|
+
}): Promise<CartDetailResponse>;
|
|
269
325
|
/**
|
|
270
326
|
* @param {Object} arg - Arg object.
|
|
271
327
|
* @param {string} [arg.cartId] -
|
|
@@ -300,58 +356,36 @@ declare class Cart {
|
|
|
300
356
|
}): Promise<CartDetailResponse>;
|
|
301
357
|
/**
|
|
302
358
|
* @param {Object} arg - Arg object.
|
|
303
|
-
* @param {string}
|
|
304
|
-
* @param {
|
|
305
|
-
* @
|
|
306
|
-
* @
|
|
307
|
-
* @
|
|
308
|
-
* @param {string} [arg.aggregatorName] -
|
|
309
|
-
* @param {string} [arg.merchantCode] -
|
|
310
|
-
* @returns {Promise<PaymentCouponValidate>} - Success response
|
|
311
|
-
* @summary: Verify the coupon eligibility against the payment mode
|
|
312
|
-
* @description: Use this API to validate a coupon against the payment mode such as NetBanking, Wallet, UPI etc.
|
|
359
|
+
* @param {string} arg.id - ID allotted to the selected address
|
|
360
|
+
* @param {Address} arg.body
|
|
361
|
+
* @returns {Promise<UpdateAddressResponse>} - Success response
|
|
362
|
+
* @summary: Update address added to an account
|
|
363
|
+
* @description: <p>Use this API to update an existing address in the account. Request object should contain attributes mentioned in <font color="blue">Address </font> can be updated. These attributes are:</p> <ul> <li> <font color="monochrome">is_default_address</font></li> <li> <font color="monochrome">landmark</font></li> <li> <font color="monochrome">area</font></li> <li> <font color="monochrome">pincode</font></li> <li> <font color="monochrome">email</font></li> <li> <font color="monochrome">address_type</font></li> <li> <font color="monochrome">name</font></li> <li> <font color="monochrome">address_id</font></li> <li> <font color="monochrome">address</font></li> </ul>
|
|
313
364
|
*/
|
|
314
|
-
|
|
315
|
-
id
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
paymentMode?: string;
|
|
319
|
-
paymentIdentifier?: string;
|
|
320
|
-
aggregatorName?: string;
|
|
321
|
-
merchantCode?: string;
|
|
322
|
-
}): Promise<PaymentCouponValidate>;
|
|
365
|
+
updateAddress({ id, body }?: {
|
|
366
|
+
id: string;
|
|
367
|
+
body: Address;
|
|
368
|
+
}): Promise<UpdateAddressResponse>;
|
|
323
369
|
/**
|
|
324
370
|
* @param {Object} arg - Arg object.
|
|
325
|
-
* @param {
|
|
326
|
-
*
|
|
327
|
-
* @param {
|
|
371
|
+
* @param {string} [arg.id] -
|
|
372
|
+
* @param {boolean} [arg.i] -
|
|
373
|
+
* @param {boolean} [arg.b] -
|
|
374
|
+
* @param {string} [arg.areaCode] -
|
|
328
375
|
* @param {boolean} [arg.buyNow] -
|
|
329
|
-
* @param {
|
|
330
|
-
* @
|
|
331
|
-
*
|
|
332
|
-
* @
|
|
333
|
-
* @summary: Get delivery date and options before checkout
|
|
334
|
-
* @description: Use this API to get shipment details, expected delivery date, items and price breakup of the shipment.
|
|
376
|
+
* @param {UpdateCartRequest} arg.body
|
|
377
|
+
* @returns {Promise<UpdateCartDetailResponse>} - Success response
|
|
378
|
+
* @summary: Update items in the cart
|
|
379
|
+
* @description: <p>Use this API to update items added to the cart with the help of a request object containing attributes like item_quantity and item_size. These attributes will be fetched from the following APIs</p> <ul> <li><font color="monochrome">operation</font> Operation for current api call. <b>update_item</b> for update items. <b>remove_item</b> for removing items.</li> <li> <font color="monochrome">item_id</font> "/platform/content/v1/products/"</li> <li> <font color="monochrome">item_size</font> "/platform/content/v1/products/:slug/sizes/"</li> <li> <font color="monochrome">quantity</font> item quantity (must be greater than or equal to 1)</li> <li> <font color="monochrome">article_id</font> "/content/v1/products/:identifier/sizes/price/"</li> <li> <font color="monochrome">item_index</font> item position in the cart (must be greater than or equal to 0)</li> </ul>
|
|
335
380
|
*/
|
|
336
|
-
|
|
337
|
-
p?: boolean;
|
|
381
|
+
updateCart({ body, id, i, b, areaCode, buyNow }?: {
|
|
338
382
|
id?: string;
|
|
339
|
-
|
|
340
|
-
|
|
383
|
+
i?: boolean;
|
|
384
|
+
b?: boolean;
|
|
341
385
|
areaCode?: string;
|
|
342
|
-
}): Promise<CartShipmentsResponse>;
|
|
343
|
-
/**
|
|
344
|
-
* @param {Object} arg - Arg object.
|
|
345
|
-
* @param {boolean} [arg.buyNow] - This indicates the type of cart to checkout
|
|
346
|
-
* @param {CartCheckoutDetailRequest} arg.body
|
|
347
|
-
* @returns {Promise<CartCheckoutResponse>} - Success response
|
|
348
|
-
* @summary: Checkout all items in the cart
|
|
349
|
-
* @description: Use this API to checkout all items in the cart for payment and order generation. For COD, order will be directly generated, whereas for other checkout modes, user will be redirected to a payment gateway.
|
|
350
|
-
*/
|
|
351
|
-
checkoutCart({ body, buyNow }?: {
|
|
352
386
|
buyNow?: boolean;
|
|
353
|
-
body:
|
|
354
|
-
}): Promise<
|
|
387
|
+
body: UpdateCartRequest;
|
|
388
|
+
}): Promise<UpdateCartDetailResponse>;
|
|
355
389
|
/**
|
|
356
390
|
* @param {Object} arg - Arg object.
|
|
357
391
|
* @param {string} [arg.id] -
|
|
@@ -366,26 +400,6 @@ declare class Cart {
|
|
|
366
400
|
buyNow?: boolean;
|
|
367
401
|
body: CartMetaRequest;
|
|
368
402
|
}): Promise<CartMetaResponse>;
|
|
369
|
-
/**
|
|
370
|
-
* @param {Object} arg - Arg object.
|
|
371
|
-
* @param {GetShareCartLinkRequest} arg.body
|
|
372
|
-
* @returns {Promise<GetShareCartLinkResponse>} - Success response
|
|
373
|
-
* @summary: Generate token for sharing the cart
|
|
374
|
-
* @description: Use this API to generate a shared cart snapshot and return a shortlink token. The link can be shared with other users for getting the same items in their cart.
|
|
375
|
-
*/
|
|
376
|
-
getCartShareLink({ body }?: {
|
|
377
|
-
body: GetShareCartLinkRequest;
|
|
378
|
-
}): Promise<GetShareCartLinkResponse>;
|
|
379
|
-
/**
|
|
380
|
-
* @param {Object} arg - Arg object.
|
|
381
|
-
* @param {string} arg.token - Token of the shared short link
|
|
382
|
-
* @returns {Promise<SharedCartResponse>} - Success response
|
|
383
|
-
* @summary: Get details of a shared cart
|
|
384
|
-
* @description: Use this API to get the shared cart details as per the token generated using the share-cart API.
|
|
385
|
-
*/
|
|
386
|
-
getCartSharedItems({ token }?: {
|
|
387
|
-
token: string;
|
|
388
|
-
}): Promise<SharedCartResponse>;
|
|
389
403
|
/**
|
|
390
404
|
* @param {Object} arg - Arg object.
|
|
391
405
|
* @param {string} arg.token - Token of the shared short link
|
|
@@ -401,38 +415,24 @@ declare class Cart {
|
|
|
401
415
|
}): Promise<SharedCartResponse>;
|
|
402
416
|
/**
|
|
403
417
|
* @param {Object} arg - Arg object.
|
|
404
|
-
* @param {string} [arg.
|
|
405
|
-
*
|
|
406
|
-
*
|
|
407
|
-
* @param {
|
|
408
|
-
* @param {string} [arg.
|
|
409
|
-
* @
|
|
410
|
-
* @
|
|
411
|
-
* @
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
slug?: string;
|
|
415
|
-
pageSize?: number;
|
|
416
|
-
promotionGroup?: string;
|
|
417
|
-
}): Promise<PromotionOffersResponse>;
|
|
418
|
-
/**
|
|
419
|
-
* @param {Object} arg - Arg object.
|
|
420
|
-
* @param {string} arg.slug - A short, human-readable, URL-friendly
|
|
421
|
-
* identifier of a product. You can get slug value from the endpoint
|
|
422
|
-
* /service/application/catalog/v1.0/products/
|
|
423
|
-
* @param {string} [arg.storeId] - Store uid of assigned store on PDP page.
|
|
424
|
-
* If not passed default first created ladder will be returned
|
|
425
|
-
* @param {string} [arg.promotionId] - Get ladder information of given
|
|
426
|
-
* promotion id explicitely
|
|
427
|
-
* @param {number} [arg.pageSize] - Number of offers to be fetched to show
|
|
428
|
-
* @returns {Promise<LadderPriceOffers>} - Success response
|
|
429
|
-
* @summary: Fetch ladder price promotion
|
|
430
|
-
* @description: Use this API to get applicable ladder price promotion for current product
|
|
418
|
+
* @param {string} [arg.id] -
|
|
419
|
+
* @param {boolean} [arg.buyNow] -
|
|
420
|
+
* @param {string} [arg.addressId] -
|
|
421
|
+
* @param {string} [arg.paymentMode] -
|
|
422
|
+
* @param {string} [arg.paymentIdentifier] -
|
|
423
|
+
* @param {string} [arg.aggregatorName] -
|
|
424
|
+
* @param {string} [arg.merchantCode] -
|
|
425
|
+
* @returns {Promise<PaymentCouponValidate>} - Success response
|
|
426
|
+
* @summary: Verify the coupon eligibility against the payment mode
|
|
427
|
+
* @description: Use this API to validate a coupon against the payment mode such as NetBanking, Wallet, UPI etc.
|
|
431
428
|
*/
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
429
|
+
validateCouponForPayment({ id, buyNow, addressId, paymentMode, paymentIdentifier, aggregatorName, merchantCode, }?: {
|
|
430
|
+
id?: string;
|
|
431
|
+
buyNow?: boolean;
|
|
432
|
+
addressId?: string;
|
|
433
|
+
paymentMode?: string;
|
|
434
|
+
paymentIdentifier?: string;
|
|
435
|
+
aggregatorName?: string;
|
|
436
|
+
merchantCode?: string;
|
|
437
|
+
}): Promise<PaymentCouponValidate>;
|
|
438
438
|
}
|