@gofynd/fdk-client-javascript 1.0.1 → 1.0.3
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/documentation/application/CART.md +5934 -4502
- package/documentation/application/CATALOG.md +6338 -7245
- package/documentation/application/COMMON.md +95 -222
- package/documentation/application/COMMUNICATION.md +106 -186
- package/documentation/application/CONFIGURATION.md +903 -1597
- package/documentation/application/CONTENT.md +562 -1270
- package/documentation/application/FILESTORAGE.md +84 -220
- package/documentation/application/LEAD.md +314 -660
- package/documentation/application/LOGISTIC.md +229 -305
- package/documentation/application/ORDER.md +642 -1137
- package/documentation/application/PAYMENT.md +2285 -3031
- package/documentation/application/POSCART.md +6079 -4642
- package/documentation/application/REWARDS.md +94 -248
- package/documentation/application/SHARE.md +152 -250
- package/documentation/application/THEME.md +952 -1235
- package/documentation/application/USER.md +1228 -1765
- package/documentation/platform/ANALYTICS.md +207 -349
- package/documentation/platform/AUDITTRAIL.md +121 -204
- package/documentation/platform/BILLING.md +865 -1376
- package/documentation/platform/CART.md +2814 -3662
- package/documentation/platform/CATALOG.md +15266 -17619
- package/documentation/platform/COMMON.md +95 -222
- package/documentation/platform/COMMUNICATION.md +1632 -2380
- package/documentation/platform/COMPANYPROFILE.md +572 -957
- package/documentation/platform/CONFIGURATION.md +3050 -4073
- package/documentation/platform/CONTENT.md +3509 -4121
- package/documentation/platform/DISCOUNT.md +140 -236
- package/documentation/platform/FILESTORAGE.md +187 -323
- package/documentation/platform/INVENTORY.md +268 -911
- package/documentation/platform/LEAD.md +2195 -2541
- package/documentation/platform/ORDER.md +3750 -5636
- package/documentation/platform/PARTNER.md +9 -36
- package/documentation/platform/PAYMENT.md +903 -1213
- package/documentation/platform/REWARDS.md +183 -347
- package/documentation/platform/SHARE.md +120 -213
- package/documentation/platform/THEME.md +12956 -13239
- package/documentation/platform/USER.md +975 -1120
- package/documentation/platform/WEBHOOK.md +78 -184
- package/documentation/public/CONFIGURATION.md +95 -222
- package/documentation/public/INVENTORY.md +100 -282
- package/documentation/public/WEBHOOK.md +27 -133
- package/package.json +1 -1
- package/sdk/application/ApplicationConfig.js +1 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +243 -243
- package/sdk/application/Cart/CartApplicationClient.js +1058 -547
- package/sdk/application/Cart/CartApplicationModel.d.ts +64 -63
- package/sdk/application/Cart/CartApplicationModel.js +489 -886
- 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 +1545 -949
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +90 -90
- package/sdk/application/Catalog/CatalogApplicationModel.js +692 -1258
- 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 +76 -36
- 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 +92 -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 +638 -312
- 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 +581 -213
- package/sdk/application/Content/ContentApplicationModel.d.ts +76 -75
- package/sdk/application/Content/ContentApplicationModel.js +468 -875
- 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 +121 -59
- 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 +230 -96
- 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 +30 -19
- package/sdk/application/Logistic/LogisticApplicationClient.js +196 -47
- 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 -8
- package/sdk/application/Order/OrderApplicationClient.d.ts +86 -86
- package/sdk/application/Order/OrderApplicationClient.js +448 -215
- package/sdk/application/Order/OrderApplicationModel.d.ts +50 -50
- package/sdk/application/Order/OrderApplicationModel.js +357 -661
- 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 +1525 -750
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +72 -72
- package/sdk/application/Payment/PaymentApplicationModel.js +565 -1033
- 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 +1137 -606
- package/sdk/application/PosCart/PosCartApplicationModel.d.ts +61 -60
- package/sdk/application/PosCart/PosCartApplicationModel.js +477 -873
- 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 +253 -113
- 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 +221 -96
- 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 +115 -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 +1201 -543
- 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 +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +55 -47
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +308 -151
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +6 -6
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +20 -20
- package/sdk/platform/Analytics/AnalyticsPlatformClient.d.ts +8 -4
- package/sdk/platform/Analytics/AnalyticsPlatformClient.js +103 -16
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +11 -11
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +95 -178
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +16 -12
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +131 -44
- 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 +6 -6
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +68 -56
- package/sdk/platform/Billing/BillingPlatformClient.js +416 -171
- 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 +25 -25
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +176 -159
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +837 -500
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +11 -11
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +63 -63
- package/sdk/platform/Cart/CartPlatformModel.d.ts +86 -85
- package/sdk/platform/Cart/CartPlatformModel.js +677 -1211
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +582 -529
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +2642 -1533
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +40 -40
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +175 -175
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +708 -590
- package/sdk/platform/Catalog/CatalogPlatformClient.js +3103 -1362
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +293 -284
- package/sdk/platform/Catalog/CatalogPlatformModel.js +2149 -3660
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +66 -64
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +235 -216
- package/sdk/platform/Common/CommonPlatformClient.d.ts +14 -12
- package/sdk/platform/Common/CommonPlatformClient.js +80 -37
- 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 +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +333 -293
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +1687 -855
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +30 -30
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +87 -87
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +2 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +28 -4
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +67 -67
- package/sdk/platform/Communication/CommunicationPlatformModel.js +522 -974
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +70 -57
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +463 -182
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +28 -28
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +294 -557
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +7 -7
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +24 -24
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +175 -137
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +1168 -521
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +22 -21
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +69 -63
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +137 -119
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +691 -316
- 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 +38 -38
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +542 -461
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +2600 -1160
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +50 -49
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +159 -152
- package/sdk/platform/Content/ContentPlatformModel.d.ts +79 -75
- package/sdk/platform/Content/ContentPlatformModel.js +486 -867
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +72 -61
- package/sdk/platform/Discount/DiscountPlatformClient.js +424 -198
- 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 +29 -29
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +26 -22
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +145 -59
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +58 -52
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +240 -114
- 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 +11 -11
- package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +76 -63
- package/sdk/platform/Inventory/InventoryPlatformClient.js +461 -197
- 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 +28 -28
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +84 -71
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +441 -182
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +7 -7
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +28 -28
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +86 -75
- package/sdk/platform/Lead/LeadPlatformClient.js +434 -212
- 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 +24 -24
- package/sdk/platform/OAuthClient.js +8 -8
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +14 -11
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +113 -49
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +6 -6
- package/sdk/platform/Order/OrderPlatformClient.d.ts +367 -315
- package/sdk/platform/Order/OrderPlatformClient.js +1775 -893
- package/sdk/platform/Order/OrderPlatformModel.d.ts +198 -192
- package/sdk/platform/Order/OrderPlatformModel.js +1591 -2822
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +32 -32
- package/sdk/platform/Order/OrderPlatformValidator.js +160 -155
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +52 -8
- package/sdk/platform/Partner/PartnerPlatformModel.js +6 -22
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +65 -54
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +395 -164
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +6 -6
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +23 -23
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +55 -45
- package/sdk/platform/Payment/PaymentPlatformClient.js +362 -147
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +27 -27
- package/sdk/platform/Payment/PaymentPlatformModel.js +220 -408
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +4 -4
- package/sdk/platform/Payment/PaymentPlatformValidator.js +21 -21
- package/sdk/platform/PlatformApplicationClient.d.ts +1496 -10153
- package/sdk/platform/PlatformApplicationClient.js +1584 -13691
- package/sdk/platform/PlatformClient.d.ts +7918 -7666
- package/sdk/platform/PlatformClient.js +8701 -9926
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +91 -78
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +507 -253
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +8 -8
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +34 -34
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +15 -15
- package/sdk/platform/Rewards/RewardsPlatformModel.js +92 -194
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +16 -12
- package/sdk/platform/Share/SharePlatformApplicationClient.js +130 -52
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +6 -6
- package/sdk/platform/Share/SharePlatformModel.d.ts +8 -8
- package/sdk/platform/Share/SharePlatformModel.js +60 -118
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +148 -124
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +770 -295
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +15 -15
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +44 -44
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +34 -34
- package/sdk/platform/Theme/ThemePlatformModel.js +190 -336
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +146 -67
- package/sdk/platform/User/UserPlatformApplicationClient.js +742 -155
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +12 -7
- package/sdk/platform/User/UserPlatformApplicationValidator.js +61 -23
- package/sdk/platform/User/UserPlatformModel.d.ts +79 -72
- package/sdk/platform/User/UserPlatformModel.js +440 -689
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +35 -29
- package/sdk/platform/Webhook/WebhookPlatformClient.js +218 -91
- 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 +14 -14
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +13 -13
- package/sdk/public/Configuration/ConfigurationPublicClient.js +81 -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 +228 -105
- 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 +51 -10
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +7 -7
- package/sdk/public/Webhook/WebhookPublicModel.js +68 -136
- package/tests/application/catalog.spec.js +7 -0
|
@@ -3,62 +3,68 @@ declare class Payment {
|
|
|
3
3
|
constructor(_conf: any);
|
|
4
4
|
_conf: any;
|
|
5
5
|
_relativeUrls: {
|
|
6
|
-
|
|
6
|
+
addBeneficiaryDetails: string;
|
|
7
|
+
addRefundBankAccountUsingOTP: string;
|
|
7
8
|
attachCardToCustomer: string;
|
|
9
|
+
cancelPaymentLink: string;
|
|
10
|
+
checkAndUpdatePaymentStatus: string;
|
|
11
|
+
checkAndUpdatePaymentStatusPaymentLink: string;
|
|
12
|
+
checkCredit: string;
|
|
13
|
+
createOrderHandlerPaymentLink: string;
|
|
14
|
+
createPaymentLink: string;
|
|
15
|
+
customerCreditSummary: string;
|
|
16
|
+
customerOnboard: string;
|
|
17
|
+
deleteUserCard: string;
|
|
18
|
+
enableOrDisableRefundTransferMode: string;
|
|
8
19
|
getActiveCardAggregator: string;
|
|
20
|
+
getActiveRefundTransferModes: string;
|
|
9
21
|
getActiveUserCards: string;
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
checkAndUpdatePaymentStatus: string;
|
|
22
|
+
getAggregatorsConfig: string;
|
|
23
|
+
getEpaylaterBannerDetails: string;
|
|
24
|
+
getOrderBeneficiariesDetail: string;
|
|
25
|
+
getPaymentLink: string;
|
|
15
26
|
getPaymentModeRoutes: string;
|
|
27
|
+
getPaymentModeRoutesPaymentLink: string;
|
|
16
28
|
getPosPaymentModeRoutes: string;
|
|
17
29
|
getRupifiBannerDetails: string;
|
|
18
|
-
|
|
19
|
-
|
|
30
|
+
getUserBeneficiariesDetail: string;
|
|
31
|
+
initialisePayment: string;
|
|
32
|
+
initialisePaymentPaymentLink: string;
|
|
33
|
+
pollingPaymentLink: string;
|
|
34
|
+
redirectToAggregator: string;
|
|
20
35
|
renderHTML: string;
|
|
36
|
+
resendOrCancelPayment: string;
|
|
37
|
+
resendPaymentLink: string;
|
|
38
|
+
updateDefaultBeneficiary: string;
|
|
21
39
|
validateVPA: string;
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
getUserBeneficiariesDetail: string;
|
|
40
|
+
verifyAndChargePayment: string;
|
|
41
|
+
verifyCustomerForPayment: string;
|
|
25
42
|
verifyIfscCode: string;
|
|
26
|
-
getOrderBeneficiariesDetail: string;
|
|
27
43
|
verifyOtpAndAddBeneficiaryForBank: string;
|
|
28
|
-
addBeneficiaryDetails: string;
|
|
29
|
-
addRefundBankAccountUsingOTP: string;
|
|
30
44
|
verifyOtpAndAddBeneficiaryForWallet: string;
|
|
31
|
-
updateDefaultBeneficiary: string;
|
|
32
|
-
getPaymentLink: string;
|
|
33
|
-
createPaymentLink: string;
|
|
34
|
-
resendPaymentLink: string;
|
|
35
|
-
cancelPaymentLink: string;
|
|
36
|
-
getPaymentModeRoutesPaymentLink: string;
|
|
37
|
-
pollingPaymentLink: string;
|
|
38
|
-
createOrderHandlerPaymentLink: string;
|
|
39
|
-
initialisePaymentPaymentLink: string;
|
|
40
|
-
checkAndUpdatePaymentStatusPaymentLink: string;
|
|
41
|
-
customerCreditSummary: string;
|
|
42
|
-
redirectToAggregator: string;
|
|
43
|
-
checkCredit: string;
|
|
44
|
-
customerOnboard: string;
|
|
45
45
|
};
|
|
46
46
|
_urls: {};
|
|
47
47
|
updateUrls(urls: any): void;
|
|
48
48
|
/**
|
|
49
49
|
* @param {Object} arg - Arg object.
|
|
50
|
-
* @param {
|
|
51
|
-
* @
|
|
52
|
-
*
|
|
53
|
-
*
|
|
54
|
-
* @returns {Promise<AggregatorsConfigDetailResponse>} - Success response
|
|
55
|
-
* @summary: Get payment gateway keys
|
|
56
|
-
* @description: Use this API to retrieve the payment gateway key, secrets, merchant, SDK/API details to complete a payment at front-end.
|
|
50
|
+
* @param {AddBeneficiaryDetailsRequest} arg.body
|
|
51
|
+
* @returns {Promise<RefundAccountResponse>} - Success response
|
|
52
|
+
* @summary: Save bank details for cancelled/returned order
|
|
53
|
+
* @description: Use this API to save the bank details for a returned or cancelled order to refund the amount.
|
|
57
54
|
*/
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
55
|
+
addBeneficiaryDetails({ body }?: {
|
|
56
|
+
body: AddBeneficiaryDetailsRequest;
|
|
57
|
+
}): Promise<RefundAccountResponse>;
|
|
58
|
+
/**
|
|
59
|
+
* @param {Object} arg - Arg object.
|
|
60
|
+
* @param {AddBeneficiaryDetailsOTPRequest} arg.body
|
|
61
|
+
* @returns {Promise<RefundAccountResponse>} - Success response
|
|
62
|
+
* @summary: Save bank details for cancelled/returned order
|
|
63
|
+
* @description: Use this API to save bank details for returned/cancelled order to refund amount in his account.
|
|
64
|
+
*/
|
|
65
|
+
addRefundBankAccountUsingOTP({ body }?: {
|
|
66
|
+
body: AddBeneficiaryDetailsOTPRequest;
|
|
67
|
+
}): Promise<RefundAccountResponse>;
|
|
62
68
|
/**
|
|
63
69
|
* @param {Object} arg - Arg object.
|
|
64
70
|
* @param {AttachCardRequest} arg.body
|
|
@@ -71,64 +77,14 @@ declare class Payment {
|
|
|
71
77
|
}): Promise<AttachCardsResponse>;
|
|
72
78
|
/**
|
|
73
79
|
* @param {Object} arg - Arg object.
|
|
74
|
-
* @param {
|
|
75
|
-
* @returns {Promise<
|
|
76
|
-
* @summary:
|
|
77
|
-
* @description: Use this API to
|
|
78
|
-
*/
|
|
79
|
-
getActiveCardAggregator({ refresh }?: {
|
|
80
|
-
refresh?: boolean;
|
|
81
|
-
}): Promise<ActiveCardPaymentGatewayResponse>;
|
|
82
|
-
/**
|
|
83
|
-
* @param {Object} arg - Arg object.
|
|
84
|
-
* @param {boolean} [arg.forceRefresh] -
|
|
85
|
-
* @returns {Promise<ListCardsResponse>} - Success response
|
|
86
|
-
* @summary: Fetch the list of cards saved by the user
|
|
87
|
-
* @description: Use this API to retrieve a list of cards stored by user from an active payment gateway.
|
|
88
|
-
*/
|
|
89
|
-
getActiveUserCards({ forceRefresh }?: {
|
|
90
|
-
forceRefresh?: boolean;
|
|
91
|
-
}): Promise<ListCardsResponse>;
|
|
92
|
-
/**
|
|
93
|
-
* @param {Object} arg - Arg object.
|
|
94
|
-
* @param {DeletehCardRequest} arg.body
|
|
95
|
-
* @returns {Promise<DeleteCardsResponse>} - Success response
|
|
96
|
-
* @summary: Delete a card
|
|
97
|
-
* @description: Use this API to delete a card added by a user on the payment gateway and clear the cache.
|
|
98
|
-
*/
|
|
99
|
-
deleteUserCard({ body }?: {
|
|
100
|
-
body: DeletehCardRequest;
|
|
101
|
-
}): Promise<DeleteCardsResponse>;
|
|
102
|
-
/**
|
|
103
|
-
* @param {Object} arg - Arg object.
|
|
104
|
-
* @param {ValidateCustomerRequest} arg.body
|
|
105
|
-
* @returns {Promise<ValidateCustomerResponse>} - Success response
|
|
106
|
-
* @summary: Validate customer for payment
|
|
107
|
-
* @description: Use this API to check if the customer is eligible to use credit-line facilities such as Simpl Pay Later and Rupifi.
|
|
108
|
-
*/
|
|
109
|
-
verifyCustomerForPayment({ body }?: {
|
|
110
|
-
body: ValidateCustomerRequest;
|
|
111
|
-
}): Promise<ValidateCustomerResponse>;
|
|
112
|
-
/**
|
|
113
|
-
* @param {Object} arg - Arg object.
|
|
114
|
-
* @param {ChargeCustomerRequest} arg.body
|
|
115
|
-
* @returns {Promise<ChargeCustomerResponse>} - Success response
|
|
116
|
-
* @summary: Verify and charge payment
|
|
117
|
-
* @description: Use this API to verify and check the status of a payment transaction (server-to-server) made through aggregators like Simpl and Mswipe.
|
|
118
|
-
*/
|
|
119
|
-
verifyAndChargePayment({ body }?: {
|
|
120
|
-
body: ChargeCustomerRequest;
|
|
121
|
-
}): Promise<ChargeCustomerResponse>;
|
|
122
|
-
/**
|
|
123
|
-
* @param {Object} arg - Arg object.
|
|
124
|
-
* @param {PaymentInitializationRequest} arg.body
|
|
125
|
-
* @returns {Promise<PaymentInitializationResponse>} - Success response
|
|
126
|
-
* @summary: Initialize a payment (server-to-server) for UPI and BharatQR
|
|
127
|
-
* @description: PUse this API to inititate payment using UPI, BharatQR, wherein the UPI requests are send to the app and QR code is displayed on the screen.
|
|
80
|
+
* @param {CancelOrResendPaymentLinkRequest} arg.body
|
|
81
|
+
* @returns {Promise<CancelPaymentLinkResponse>} - Success response
|
|
82
|
+
* @summary: Cancel payment link
|
|
83
|
+
* @description: Use this API to cancel a payment link for the customer
|
|
128
84
|
*/
|
|
129
|
-
|
|
130
|
-
body:
|
|
131
|
-
}): Promise<
|
|
85
|
+
cancelPaymentLink({ body }?: {
|
|
86
|
+
body: CancelOrResendPaymentLinkRequest;
|
|
87
|
+
}): Promise<CancelPaymentLinkResponse>;
|
|
132
88
|
/**
|
|
133
89
|
* @param {Object} arg - Arg object.
|
|
134
90
|
* @param {PaymentStatusUpdateRequest} arg.body
|
|
@@ -141,111 +97,74 @@ declare class Payment {
|
|
|
141
97
|
}): Promise<PaymentStatusUpdateResponse>;
|
|
142
98
|
/**
|
|
143
99
|
* @param {Object} arg - Arg object.
|
|
144
|
-
* @param {
|
|
145
|
-
* @
|
|
146
|
-
* @
|
|
147
|
-
* @
|
|
148
|
-
* @param {boolean} [arg.refresh] - This is a boolean value. Select `true`
|
|
149
|
-
* to remove temporary cache files on payment gateway and replace with the
|
|
150
|
-
* latest one.
|
|
151
|
-
* @param {string} [arg.cardReference] - Card reference id of user's debit
|
|
152
|
-
* or credit card.
|
|
153
|
-
* @param {string} [arg.userDetails] - URIencoded JSON containing details of
|
|
154
|
-
* an anonymous user.
|
|
155
|
-
* @returns {Promise<PaymentModeRouteResponse>} - Success response
|
|
156
|
-
* @summary: Get applicable payment options
|
|
157
|
-
* @description: Use this API to get all valid payment options for doing a payment.
|
|
158
|
-
*/
|
|
159
|
-
getPaymentModeRoutes({ amount, cartId, pincode, checkoutMode, refresh, cardReference, userDetails, }?: {
|
|
160
|
-
amount: number;
|
|
161
|
-
cartId: string;
|
|
162
|
-
pincode: string;
|
|
163
|
-
checkoutMode: string;
|
|
164
|
-
refresh?: boolean;
|
|
165
|
-
cardReference?: string;
|
|
166
|
-
userDetails?: string;
|
|
167
|
-
}): Promise<PaymentModeRouteResponse>;
|
|
168
|
-
/**
|
|
169
|
-
* @param {Object} arg - Arg object.
|
|
170
|
-
* @param {number} arg.amount - Payable amount.
|
|
171
|
-
* @param {string} arg.cartId - Identifier of the cart.
|
|
172
|
-
* @param {string} arg.pincode - The PIN Code of the destination address, e.g. 400059
|
|
173
|
-
* @param {string} arg.checkoutMode - Option to checkout for self or for others.
|
|
174
|
-
* @param {boolean} [arg.refresh] - This is a boolean value. Select `true`
|
|
175
|
-
* to remove temporary cache files on payment gateway and replace with the
|
|
176
|
-
* latest one.
|
|
177
|
-
* @param {string} [arg.cardReference] - Card reference id of user's debit
|
|
178
|
-
* or credit card.
|
|
179
|
-
* @param {string} arg.orderType - The order type of shipment * HomeDelivery
|
|
180
|
-
* - If the customer wants the order home-delivered * PickAtStore - If the
|
|
181
|
-
* customer wants the handover of an order at the store itself.
|
|
182
|
-
* @param {string} [arg.userDetails] - URIencoded JSON containing details of
|
|
183
|
-
* an anonymous user.
|
|
184
|
-
* @returns {Promise<PaymentModeRouteResponse>} - Success response
|
|
185
|
-
* @summary: Get applicable payment options for Point-of-Sale (POS)
|
|
186
|
-
* @description: Use this API to get all valid payment options for doing a payment in POS.
|
|
100
|
+
* @param {PaymentStatusUpdateRequest} arg.body
|
|
101
|
+
* @returns {Promise<PaymentStatusUpdateResponse>} - Success response
|
|
102
|
+
* @summary: Performs continuous polling to check status of payment on the server
|
|
103
|
+
* @description: Use this API to perform continuous polling at intervals to check the status of payment until timeout.
|
|
187
104
|
*/
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
pincode: string;
|
|
192
|
-
checkoutMode: string;
|
|
193
|
-
refresh?: boolean;
|
|
194
|
-
cardReference?: string;
|
|
195
|
-
orderType: string;
|
|
196
|
-
userDetails?: string;
|
|
197
|
-
}): Promise<PaymentModeRouteResponse>;
|
|
105
|
+
checkAndUpdatePaymentStatusPaymentLink({ body }?: {
|
|
106
|
+
body: PaymentStatusUpdateRequest;
|
|
107
|
+
}): Promise<PaymentStatusUpdateResponse>;
|
|
198
108
|
/**
|
|
199
109
|
* @param {Object} arg - Arg object.
|
|
200
|
-
* @
|
|
201
|
-
* @
|
|
202
|
-
* @
|
|
110
|
+
* @param {string} [arg.aggregator] -
|
|
111
|
+
* @returns {Promise<CheckCreditResponse>} - Success response
|
|
112
|
+
* @summary: API to fetch the customer credit summary
|
|
113
|
+
* @description: Use this API to fetch the customer credit summary.
|
|
203
114
|
*/
|
|
204
|
-
|
|
115
|
+
checkCredit({ aggregator }?: {
|
|
116
|
+
aggregator?: string;
|
|
117
|
+
}): Promise<CheckCreditResponse>;
|
|
205
118
|
/**
|
|
206
119
|
* @param {Object} arg - Arg object.
|
|
207
|
-
* @
|
|
208
|
-
* @
|
|
209
|
-
* @
|
|
120
|
+
* @param {CreateOrderUserRequest} arg.body
|
|
121
|
+
* @returns {Promise<CreateOrderUserResponse>} - Success response
|
|
122
|
+
* @summary: Create Order user
|
|
123
|
+
* @description: Use this API to create a order and payment on aggregator side
|
|
210
124
|
*/
|
|
211
|
-
|
|
125
|
+
createOrderHandlerPaymentLink({ body }?: {
|
|
126
|
+
body: CreateOrderUserRequest;
|
|
127
|
+
}): Promise<CreateOrderUserResponse>;
|
|
212
128
|
/**
|
|
213
129
|
* @param {Object} arg - Arg object.
|
|
214
|
-
* @param {
|
|
215
|
-
* @returns {Promise<
|
|
216
|
-
* @summary:
|
|
217
|
-
* @description: Use this API to
|
|
130
|
+
* @param {CreatePaymentLinkRequest} arg.body
|
|
131
|
+
* @returns {Promise<CreatePaymentLinkResponse>} - Success response
|
|
132
|
+
* @summary: Create payment link
|
|
133
|
+
* @description: Use this API to create a payment link for the customer
|
|
218
134
|
*/
|
|
219
|
-
|
|
220
|
-
body:
|
|
221
|
-
}): Promise<
|
|
135
|
+
createPaymentLink({ body }?: {
|
|
136
|
+
body: CreatePaymentLinkRequest;
|
|
137
|
+
}): Promise<CreatePaymentLinkResponse>;
|
|
222
138
|
/**
|
|
223
139
|
* @param {Object} arg - Arg object.
|
|
224
|
-
* @param {
|
|
225
|
-
* @returns {Promise<
|
|
226
|
-
* @summary:
|
|
227
|
-
* @description: Use this API to
|
|
140
|
+
* @param {string} [arg.aggregator] -
|
|
141
|
+
* @returns {Promise<CustomerCreditSummaryResponse>} - Success response
|
|
142
|
+
* @summary: API to fetch the customer credit summary
|
|
143
|
+
* @description: Use this API to fetch the customer credit summary.
|
|
228
144
|
*/
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
}): Promise<
|
|
145
|
+
customerCreditSummary({ aggregator }?: {
|
|
146
|
+
aggregator?: string;
|
|
147
|
+
}): Promise<CustomerCreditSummaryResponse>;
|
|
232
148
|
/**
|
|
233
149
|
* @param {Object} arg - Arg object.
|
|
234
|
-
* @param {
|
|
235
|
-
* @returns {Promise<
|
|
236
|
-
* @summary: API to
|
|
237
|
-
* @description: API to
|
|
150
|
+
* @param {CustomerOnboardingRequest} arg.body
|
|
151
|
+
* @returns {Promise<CustomerOnboardingResponse>} - Success response
|
|
152
|
+
* @summary: API to fetch the customer credit summary
|
|
153
|
+
* @description: Use this API to fetch the customer credit summary.
|
|
238
154
|
*/
|
|
239
|
-
|
|
240
|
-
body:
|
|
241
|
-
}): Promise<
|
|
155
|
+
customerOnboard({ body }?: {
|
|
156
|
+
body: CustomerOnboardingRequest;
|
|
157
|
+
}): Promise<CustomerOnboardingResponse>;
|
|
242
158
|
/**
|
|
243
159
|
* @param {Object} arg - Arg object.
|
|
244
|
-
* @
|
|
245
|
-
* @
|
|
246
|
-
* @
|
|
160
|
+
* @param {DeletehCardRequest} arg.body
|
|
161
|
+
* @returns {Promise<DeleteCardsResponse>} - Success response
|
|
162
|
+
* @summary: Delete a card
|
|
163
|
+
* @description: Use this API to delete a card added by a user on the payment gateway and clear the cache.
|
|
247
164
|
*/
|
|
248
|
-
|
|
165
|
+
deleteUserCard({ body }?: {
|
|
166
|
+
body: DeletehCardRequest;
|
|
167
|
+
}): Promise<DeleteCardsResponse>;
|
|
249
168
|
/**
|
|
250
169
|
* @param {Object} arg - Arg object.
|
|
251
170
|
* @param {UpdateRefundTransferModeRequest} arg.body
|
|
@@ -258,87 +177,63 @@ declare class Payment {
|
|
|
258
177
|
}): Promise<UpdateRefundTransferModeResponse>;
|
|
259
178
|
/**
|
|
260
179
|
* @param {Object} arg - Arg object.
|
|
261
|
-
* @param {
|
|
262
|
-
*
|
|
263
|
-
* @
|
|
264
|
-
* @
|
|
265
|
-
* @description: Use this API to get the details of all active beneficiary added by a user for refund.
|
|
266
|
-
*/
|
|
267
|
-
getUserBeneficiariesDetail({ orderId }?: {
|
|
268
|
-
orderId: string;
|
|
269
|
-
}): Promise<OrderBeneficiaryResponse>;
|
|
270
|
-
/**
|
|
271
|
-
* @param {Object} arg - Arg object.
|
|
272
|
-
* @param {string} [arg.ifscCode] - A 11-digit alphanumeric code that
|
|
273
|
-
* uniquely identifies a bank branch.
|
|
274
|
-
* @returns {Promise<IfscCodeResponse>} - Success response
|
|
275
|
-
* @summary: Verify IFSC Code
|
|
276
|
-
* @description: Use this API to check whether the 11-digit IFSC code is valid and to fetch the bank details for refund.
|
|
277
|
-
*/
|
|
278
|
-
verifyIfscCode({ ifscCode }?: {
|
|
279
|
-
ifscCode?: string;
|
|
280
|
-
}): Promise<IfscCodeResponse>;
|
|
281
|
-
/**
|
|
282
|
-
* @param {Object} arg - Arg object.
|
|
283
|
-
* @param {string} arg.orderId - A unique number used for identifying and
|
|
284
|
-
* tracking your orders.
|
|
285
|
-
* @returns {Promise<OrderBeneficiaryResponse>} - Success response
|
|
286
|
-
* @summary: Lists the beneficiary of a refund
|
|
287
|
-
* @description: Use this API to get the details of all active beneficiary added by a user for refund.
|
|
180
|
+
* @param {boolean} [arg.refresh] -
|
|
181
|
+
* @returns {Promise<ActiveCardPaymentGatewayResponse>} - Success response
|
|
182
|
+
* @summary: Fetch active payment gateway for card payments
|
|
183
|
+
* @description: Use this API to retrieve an active payment aggregator along with the Customer ID. This is applicable for cards payments only.
|
|
288
184
|
*/
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
}): Promise<
|
|
185
|
+
getActiveCardAggregator({ refresh }?: {
|
|
186
|
+
refresh?: boolean;
|
|
187
|
+
}): Promise<ActiveCardPaymentGatewayResponse>;
|
|
292
188
|
/**
|
|
293
189
|
* @param {Object} arg - Arg object.
|
|
294
|
-
* @
|
|
295
|
-
* @
|
|
296
|
-
* @
|
|
297
|
-
* @description: Use this API to perform an OTP validation before saving the beneficiary details added for a refund.
|
|
190
|
+
* @returns {Promise<TransferModeResponse>} - Success response
|
|
191
|
+
* @summary: Lists the mode of refund
|
|
192
|
+
* @description: Use this API to retrieve eligible refund modes (such as Netbanking) and add the beneficiary details.
|
|
298
193
|
*/
|
|
299
|
-
|
|
300
|
-
body: AddBeneficiaryViaOtpVerificationRequest;
|
|
301
|
-
}): Promise<AddBeneficiaryViaOtpVerificationResponse>;
|
|
194
|
+
getActiveRefundTransferModes({}?: any): Promise<TransferModeResponse>;
|
|
302
195
|
/**
|
|
303
196
|
* @param {Object} arg - Arg object.
|
|
304
|
-
* @param {
|
|
305
|
-
* @returns {Promise<
|
|
306
|
-
* @summary:
|
|
307
|
-
* @description: Use this API to
|
|
197
|
+
* @param {boolean} [arg.forceRefresh] -
|
|
198
|
+
* @returns {Promise<ListCardsResponse>} - Success response
|
|
199
|
+
* @summary: Fetch the list of cards saved by the user
|
|
200
|
+
* @description: Use this API to retrieve a list of cards stored by user from an active payment gateway.
|
|
308
201
|
*/
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
}): Promise<
|
|
202
|
+
getActiveUserCards({ forceRefresh }?: {
|
|
203
|
+
forceRefresh?: boolean;
|
|
204
|
+
}): Promise<ListCardsResponse>;
|
|
312
205
|
/**
|
|
313
206
|
* @param {Object} arg - Arg object.
|
|
314
|
-
* @param {
|
|
315
|
-
* @
|
|
316
|
-
*
|
|
317
|
-
*
|
|
207
|
+
* @param {string} [arg.xApiToken] - Used for basic authentication.
|
|
208
|
+
* @param {boolean} [arg.refresh] - This is a boolean value. Select `true`
|
|
209
|
+
* to remove temporary cache files on payment gateway and replace with the
|
|
210
|
+
* latest one.
|
|
211
|
+
* @returns {Promise<AggregatorsConfigDetailResponse>} - Success response
|
|
212
|
+
* @summary: Get payment gateway keys
|
|
213
|
+
* @description: Use this API to retrieve the payment gateway key, secrets, merchant, SDK/API details to complete a payment at front-end.
|
|
318
214
|
*/
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
215
|
+
getAggregatorsConfig({ xApiToken, refresh }?: {
|
|
216
|
+
xApiToken?: string;
|
|
217
|
+
refresh?: boolean;
|
|
218
|
+
}): Promise<AggregatorsConfigDetailResponse>;
|
|
322
219
|
/**
|
|
323
220
|
* @param {Object} arg - Arg object.
|
|
324
|
-
* @
|
|
325
|
-
* @
|
|
326
|
-
* @
|
|
327
|
-
* @description: Use this API to send an OTP while adding a wallet beneficiary by mobile no. verification.
|
|
221
|
+
* @returns {Promise<EpaylaterBannerResponse>} - Success response
|
|
222
|
+
* @summary: Get Epaylater Enabled
|
|
223
|
+
* @description: Get Epaylater Enabled if user is tentatively approved by epaylater
|
|
328
224
|
*/
|
|
329
|
-
|
|
330
|
-
body: WalletOtpRequest;
|
|
331
|
-
}): Promise<WalletOtpResponse>;
|
|
225
|
+
getEpaylaterBannerDetails({}?: any): Promise<EpaylaterBannerResponse>;
|
|
332
226
|
/**
|
|
333
227
|
* @param {Object} arg - Arg object.
|
|
334
|
-
* @param {
|
|
335
|
-
*
|
|
336
|
-
* @
|
|
337
|
-
* @
|
|
228
|
+
* @param {string} arg.orderId - A unique number used for identifying and
|
|
229
|
+
* tracking your orders.
|
|
230
|
+
* @returns {Promise<OrderBeneficiaryResponse>} - Success response
|
|
231
|
+
* @summary: Lists the beneficiary of a refund
|
|
232
|
+
* @description: Use this API to get the details of all active beneficiary added by a user for refund.
|
|
338
233
|
*/
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
}): Promise<
|
|
234
|
+
getOrderBeneficiariesDetail({ orderId }?: {
|
|
235
|
+
orderId: string;
|
|
236
|
+
}): Promise<OrderBeneficiaryResponse>;
|
|
342
237
|
/**
|
|
343
238
|
* @param {Object} arg - Arg object.
|
|
344
239
|
* @param {string} [arg.paymentLinkId] -
|
|
@@ -351,34 +246,30 @@ declare class Payment {
|
|
|
351
246
|
}): Promise<GetPaymentLinkResponse>;
|
|
352
247
|
/**
|
|
353
248
|
* @param {Object} arg - Arg object.
|
|
354
|
-
* @param {
|
|
355
|
-
* @
|
|
356
|
-
* @
|
|
357
|
-
* @
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
* @param {
|
|
364
|
-
*
|
|
365
|
-
* @returns {Promise<
|
|
366
|
-
* @summary:
|
|
367
|
-
* @description: Use this API to
|
|
368
|
-
*/
|
|
369
|
-
resendPaymentLink({ body }?: {
|
|
370
|
-
body: CancelOrResendPaymentLinkRequest;
|
|
371
|
-
}): Promise<ResendPaymentLinkResponse>;
|
|
372
|
-
/**
|
|
373
|
-
* @param {Object} arg - Arg object.
|
|
374
|
-
* @param {CancelOrResendPaymentLinkRequest} arg.body
|
|
375
|
-
* @returns {Promise<CancelPaymentLinkResponse>} - Success response
|
|
376
|
-
* @summary: Cancel payment link
|
|
377
|
-
* @description: Use this API to cancel a payment link for the customer
|
|
249
|
+
* @param {number} arg.amount - Payable amount.
|
|
250
|
+
* @param {string} arg.cartId - Identifier of the cart.
|
|
251
|
+
* @param {string} arg.pincode - The PIN Code of the destination address, e.g. 400059
|
|
252
|
+
* @param {string} arg.checkoutMode - Option to checkout for self or for others.
|
|
253
|
+
* @param {boolean} [arg.refresh] - This is a boolean value. Select `true`
|
|
254
|
+
* to remove temporary cache files on payment gateway and replace with the
|
|
255
|
+
* latest one.
|
|
256
|
+
* @param {string} [arg.cardReference] - Card reference id of user's debit
|
|
257
|
+
* or credit card.
|
|
258
|
+
* @param {string} [arg.userDetails] - URIencoded JSON containing details of
|
|
259
|
+
* an anonymous user.
|
|
260
|
+
* @returns {Promise<PaymentModeRouteResponse>} - Success response
|
|
261
|
+
* @summary: Get applicable payment options
|
|
262
|
+
* @description: Use this API to get all valid payment options for doing a payment.
|
|
378
263
|
*/
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
264
|
+
getPaymentModeRoutes({ amount, cartId, pincode, checkoutMode, refresh, cardReference, userDetails, }?: {
|
|
265
|
+
amount: number;
|
|
266
|
+
cartId: string;
|
|
267
|
+
pincode: string;
|
|
268
|
+
checkoutMode: string;
|
|
269
|
+
refresh?: boolean;
|
|
270
|
+
cardReference?: string;
|
|
271
|
+
userDetails?: string;
|
|
272
|
+
}): Promise<PaymentModeRouteResponse>;
|
|
382
273
|
/**
|
|
383
274
|
* @param {Object} arg - Arg object.
|
|
384
275
|
* @param {string} arg.paymentLinkId - Payment link id
|
|
@@ -391,54 +282,82 @@ declare class Payment {
|
|
|
391
282
|
}): Promise<PaymentModeRouteResponse>;
|
|
392
283
|
/**
|
|
393
284
|
* @param {Object} arg - Arg object.
|
|
394
|
-
* @param {
|
|
395
|
-
* @
|
|
396
|
-
* @
|
|
397
|
-
* @
|
|
285
|
+
* @param {number} arg.amount - Payable amount.
|
|
286
|
+
* @param {string} arg.cartId - Identifier of the cart.
|
|
287
|
+
* @param {string} arg.pincode - The PIN Code of the destination address, e.g. 400059
|
|
288
|
+
* @param {string} arg.checkoutMode - Option to checkout for self or for others.
|
|
289
|
+
* @param {boolean} [arg.refresh] - This is a boolean value. Select `true`
|
|
290
|
+
* to remove temporary cache files on payment gateway and replace with the
|
|
291
|
+
* latest one.
|
|
292
|
+
* @param {string} [arg.cardReference] - Card reference id of user's debit
|
|
293
|
+
* or credit card.
|
|
294
|
+
* @param {string} arg.orderType - The order type of shipment * HomeDelivery
|
|
295
|
+
* - If the customer wants the order home-delivered * PickAtStore - If the
|
|
296
|
+
* customer wants the handover of an order at the store itself.
|
|
297
|
+
* @param {string} [arg.userDetails] - URIencoded JSON containing details of
|
|
298
|
+
* an anonymous user.
|
|
299
|
+
* @returns {Promise<PaymentModeRouteResponse>} - Success response
|
|
300
|
+
* @summary: Get applicable payment options for Point-of-Sale (POS)
|
|
301
|
+
* @description: Use this API to get all valid payment options for doing a payment in POS.
|
|
398
302
|
*/
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
303
|
+
getPosPaymentModeRoutes({ amount, cartId, pincode, checkoutMode, orderType, refresh, cardReference, userDetails, }?: {
|
|
304
|
+
amount: number;
|
|
305
|
+
cartId: string;
|
|
306
|
+
pincode: string;
|
|
307
|
+
checkoutMode: string;
|
|
308
|
+
refresh?: boolean;
|
|
309
|
+
cardReference?: string;
|
|
310
|
+
orderType: string;
|
|
311
|
+
userDetails?: string;
|
|
312
|
+
}): Promise<PaymentModeRouteResponse>;
|
|
402
313
|
/**
|
|
403
314
|
* @param {Object} arg - Arg object.
|
|
404
|
-
* @
|
|
405
|
-
* @
|
|
406
|
-
* @
|
|
407
|
-
* @description: Use this API to create a order and payment on aggregator side
|
|
315
|
+
* @returns {Promise<RupifiBannerResponse>} - Success response
|
|
316
|
+
* @summary: Get CreditLine Offer
|
|
317
|
+
* @description: Get CreditLine Offer if user is tentatively approved by rupifi
|
|
408
318
|
*/
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
319
|
+
getRupifiBannerDetails({}?: any): Promise<RupifiBannerResponse>;
|
|
320
|
+
/**
|
|
321
|
+
* @param {Object} arg - Arg object.
|
|
322
|
+
* @param {string} arg.orderId - A unique number used for identifying and
|
|
323
|
+
* tracking your orders.
|
|
324
|
+
* @returns {Promise<OrderBeneficiaryResponse>} - Success response
|
|
325
|
+
* @summary: Lists the beneficiary of a refund
|
|
326
|
+
* @description: Use this API to get the details of all active beneficiary added by a user for refund.
|
|
327
|
+
*/
|
|
328
|
+
getUserBeneficiariesDetail({ orderId }?: {
|
|
329
|
+
orderId: string;
|
|
330
|
+
}): Promise<OrderBeneficiaryResponse>;
|
|
412
331
|
/**
|
|
413
332
|
* @param {Object} arg - Arg object.
|
|
414
333
|
* @param {PaymentInitializationRequest} arg.body
|
|
415
334
|
* @returns {Promise<PaymentInitializationResponse>} - Success response
|
|
416
335
|
* @summary: Initialize a payment (server-to-server) for UPI and BharatQR
|
|
417
|
-
* @description:
|
|
336
|
+
* @description: PUse this API to inititate payment using UPI, BharatQR, wherein the UPI requests are send to the app and QR code is displayed on the screen.
|
|
418
337
|
*/
|
|
419
|
-
|
|
338
|
+
initialisePayment({ body }?: {
|
|
420
339
|
body: PaymentInitializationRequest;
|
|
421
340
|
}): Promise<PaymentInitializationResponse>;
|
|
422
341
|
/**
|
|
423
342
|
* @param {Object} arg - Arg object.
|
|
424
|
-
* @param {
|
|
425
|
-
* @returns {Promise<
|
|
426
|
-
* @summary:
|
|
427
|
-
* @description: Use this API to
|
|
343
|
+
* @param {PaymentInitializationRequest} arg.body
|
|
344
|
+
* @returns {Promise<PaymentInitializationResponse>} - Success response
|
|
345
|
+
* @summary: Initialize a payment (server-to-server) for UPI and BharatQR
|
|
346
|
+
* @description: Use this API to inititate payment using UPI, BharatQR, wherein the UPI requests are send to the app and QR code is displayed on the screen.
|
|
428
347
|
*/
|
|
429
|
-
|
|
430
|
-
body:
|
|
431
|
-
}): Promise<
|
|
348
|
+
initialisePaymentPaymentLink({ body }?: {
|
|
349
|
+
body: PaymentInitializationRequest;
|
|
350
|
+
}): Promise<PaymentInitializationResponse>;
|
|
432
351
|
/**
|
|
433
352
|
* @param {Object} arg - Arg object.
|
|
434
|
-
* @param {string} [arg.
|
|
435
|
-
* @returns {Promise<
|
|
436
|
-
* @summary:
|
|
437
|
-
* @description: Use this API to
|
|
353
|
+
* @param {string} [arg.paymentLinkId] -
|
|
354
|
+
* @returns {Promise<PollingPaymentLinkResponse>} - Success response
|
|
355
|
+
* @summary: Used for polling if payment successful or not
|
|
356
|
+
* @description: Use this API to poll if payment through payment was successful or not
|
|
438
357
|
*/
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
}): Promise<
|
|
358
|
+
pollingPaymentLink({ paymentLinkId }?: {
|
|
359
|
+
paymentLinkId?: string;
|
|
360
|
+
}): Promise<PollingPaymentLinkResponse>;
|
|
442
361
|
/**
|
|
443
362
|
* @param {Object} arg - Arg object.
|
|
444
363
|
* @param {string} [arg.source] - This is a String value that contains
|
|
@@ -455,22 +374,103 @@ declare class Payment {
|
|
|
455
374
|
}): Promise<RedirectToAggregatorResponse>;
|
|
456
375
|
/**
|
|
457
376
|
* @param {Object} arg - Arg object.
|
|
458
|
-
* @param {
|
|
459
|
-
* @returns {Promise<
|
|
460
|
-
* @summary:
|
|
461
|
-
* @description: Use this API to
|
|
377
|
+
* @param {renderHTMLRequest} arg.body
|
|
378
|
+
* @returns {Promise<renderHTMLResponse>} - Success response
|
|
379
|
+
* @summary: Convert base64 string to HTML form
|
|
380
|
+
* @description: Use this API to decode base64 html form to plain HTML string.
|
|
462
381
|
*/
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
}): Promise<
|
|
382
|
+
renderHTML({ body }?: {
|
|
383
|
+
body: renderHTMLRequest;
|
|
384
|
+
}): Promise<renderHTMLResponse>;
|
|
466
385
|
/**
|
|
467
386
|
* @param {Object} arg - Arg object.
|
|
468
|
-
* @param {
|
|
469
|
-
* @returns {Promise<
|
|
470
|
-
* @summary: API to
|
|
471
|
-
* @description: Use this API to
|
|
387
|
+
* @param {ResendOrCancelPaymentRequest} arg.body
|
|
388
|
+
* @returns {Promise<ResendOrCancelPaymentResponse>} - Success response
|
|
389
|
+
* @summary: API to resend and cancel a payment link which was already generated.
|
|
390
|
+
* @description: Use this API to perform resend or cancel a payment link based on request payload.
|
|
472
391
|
*/
|
|
473
|
-
|
|
474
|
-
body:
|
|
475
|
-
}): Promise<
|
|
392
|
+
resendOrCancelPayment({ body }?: {
|
|
393
|
+
body: ResendOrCancelPaymentRequest;
|
|
394
|
+
}): Promise<ResendOrCancelPaymentResponse>;
|
|
395
|
+
/**
|
|
396
|
+
* @param {Object} arg - Arg object.
|
|
397
|
+
* @param {CancelOrResendPaymentLinkRequest} arg.body
|
|
398
|
+
* @returns {Promise<ResendPaymentLinkResponse>} - Success response
|
|
399
|
+
* @summary: Resend payment link
|
|
400
|
+
* @description: Use this API to resend a payment link for the customer
|
|
401
|
+
*/
|
|
402
|
+
resendPaymentLink({ body }?: {
|
|
403
|
+
body: CancelOrResendPaymentLinkRequest;
|
|
404
|
+
}): Promise<ResendPaymentLinkResponse>;
|
|
405
|
+
/**
|
|
406
|
+
* @param {Object} arg - Arg object.
|
|
407
|
+
* @param {SetDefaultBeneficiaryRequest} arg.body
|
|
408
|
+
* @returns {Promise<SetDefaultBeneficiaryResponse>} - Success response
|
|
409
|
+
* @summary: Set a default beneficiary for a refund
|
|
410
|
+
* @description: Use this API to set a default beneficiary for getting a refund.
|
|
411
|
+
*/
|
|
412
|
+
updateDefaultBeneficiary({ body }?: {
|
|
413
|
+
body: SetDefaultBeneficiaryRequest;
|
|
414
|
+
}): Promise<SetDefaultBeneficiaryResponse>;
|
|
415
|
+
/**
|
|
416
|
+
* @param {Object} arg - Arg object.
|
|
417
|
+
* @param {ValidateVPARequest} arg.body
|
|
418
|
+
* @returns {Promise<ValidateVPAResponse>} - Success response
|
|
419
|
+
* @summary: API to Validate UPI ID
|
|
420
|
+
* @description: API to Validate UPI ID
|
|
421
|
+
*/
|
|
422
|
+
validateVPA({ body }?: {
|
|
423
|
+
body: ValidateVPARequest;
|
|
424
|
+
}): Promise<ValidateVPAResponse>;
|
|
425
|
+
/**
|
|
426
|
+
* @param {Object} arg - Arg object.
|
|
427
|
+
* @param {ChargeCustomerRequest} arg.body
|
|
428
|
+
* @returns {Promise<ChargeCustomerResponse>} - Success response
|
|
429
|
+
* @summary: Verify and charge payment
|
|
430
|
+
* @description: Use this API to verify and check the status of a payment transaction (server-to-server) made through aggregators like Simpl and Mswipe.
|
|
431
|
+
*/
|
|
432
|
+
verifyAndChargePayment({ body }?: {
|
|
433
|
+
body: ChargeCustomerRequest;
|
|
434
|
+
}): Promise<ChargeCustomerResponse>;
|
|
435
|
+
/**
|
|
436
|
+
* @param {Object} arg - Arg object.
|
|
437
|
+
* @param {ValidateCustomerRequest} arg.body
|
|
438
|
+
* @returns {Promise<ValidateCustomerResponse>} - Success response
|
|
439
|
+
* @summary: Validate customer for payment
|
|
440
|
+
* @description: Use this API to check if the customer is eligible to use credit-line facilities such as Simpl Pay Later and Rupifi.
|
|
441
|
+
*/
|
|
442
|
+
verifyCustomerForPayment({ body }?: {
|
|
443
|
+
body: ValidateCustomerRequest;
|
|
444
|
+
}): Promise<ValidateCustomerResponse>;
|
|
445
|
+
/**
|
|
446
|
+
* @param {Object} arg - Arg object.
|
|
447
|
+
* @param {string} [arg.ifscCode] - A 11-digit alphanumeric code that
|
|
448
|
+
* uniquely identifies a bank branch.
|
|
449
|
+
* @returns {Promise<IfscCodeResponse>} - Success response
|
|
450
|
+
* @summary: Verify IFSC Code
|
|
451
|
+
* @description: Use this API to check whether the 11-digit IFSC code is valid and to fetch the bank details for refund.
|
|
452
|
+
*/
|
|
453
|
+
verifyIfscCode({ ifscCode }?: {
|
|
454
|
+
ifscCode?: string;
|
|
455
|
+
}): Promise<IfscCodeResponse>;
|
|
456
|
+
/**
|
|
457
|
+
* @param {Object} arg - Arg object.
|
|
458
|
+
* @param {AddBeneficiaryViaOtpVerificationRequest} arg.body
|
|
459
|
+
* @returns {Promise<AddBeneficiaryViaOtpVerificationResponse>} - Success response
|
|
460
|
+
* @summary: Verify the beneficiary details using OTP
|
|
461
|
+
* @description: Use this API to perform an OTP validation before saving the beneficiary details added for a refund.
|
|
462
|
+
*/
|
|
463
|
+
verifyOtpAndAddBeneficiaryForBank({ body }?: {
|
|
464
|
+
body: AddBeneficiaryViaOtpVerificationRequest;
|
|
465
|
+
}): Promise<AddBeneficiaryViaOtpVerificationResponse>;
|
|
466
|
+
/**
|
|
467
|
+
* @param {Object} arg - Arg object.
|
|
468
|
+
* @param {WalletOtpRequest} arg.body
|
|
469
|
+
* @returns {Promise<WalletOtpResponse>} - Success response
|
|
470
|
+
* @summary: Send OTP on adding a wallet beneficiary
|
|
471
|
+
* @description: Use this API to send an OTP while adding a wallet beneficiary by mobile no. verification.
|
|
472
|
+
*/
|
|
473
|
+
verifyOtpAndAddBeneficiaryForWallet({ body }?: {
|
|
474
|
+
body: WalletOtpRequest;
|
|
475
|
+
}): Promise<WalletOtpResponse>;
|
|
476
476
|
}
|