@gofynd/fdk-client-javascript 1.4.2-beta.4 → 1.4.2-beta.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +62 -62
- package/sdk/application/Cart/CartApplicationClient.js +82 -71
- package/sdk/application/Cart/CartApplicationValidator.d.ts +189 -34
- package/sdk/application/Cart/CartApplicationValidator.js +59 -34
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +78 -78
- package/sdk/application/Catalog/CatalogApplicationClient.js +78 -78
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +4 -4
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -6
- package/sdk/application/Communication/CommunicationApplicationClient.js +6 -6
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -67
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +32 -106
- package/sdk/application/Content/ContentApplicationClient.d.ts +34 -64
- package/sdk/application/Content/ContentApplicationClient.js +34 -115
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -42
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +6 -42
- package/sdk/application/Lead/LeadApplicationClient.d.ts +14 -14
- package/sdk/application/Lead/LeadApplicationClient.js +14 -14
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +12 -12
- package/sdk/application/Logistic/LogisticApplicationClient.js +12 -12
- package/sdk/application/Order/OrderApplicationClient.d.ts +24 -24
- package/sdk/application/Order/OrderApplicationClient.js +24 -24
- package/sdk/application/Order/OrderApplicationModel.d.ts +23 -1
- package/sdk/application/Order/OrderApplicationModel.js +28 -0
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +89 -89
- package/sdk/application/Payment/PaymentApplicationClient.js +94 -94
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +498 -3
- package/sdk/application/Payment/PaymentApplicationModel.js +316 -2
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +5 -5
- package/sdk/application/Payment/PaymentApplicationValidator.js +3 -3
- package/sdk/application/PosCart/PosCartApplicationClient.d.ts +54 -54
- package/sdk/application/PosCart/PosCartApplicationClient.js +54 -54
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +14 -25
- package/sdk/application/Rewards/RewardsApplicationClient.js +14 -41
- package/sdk/application/Share/ShareApplicationClient.d.ts +14 -14
- package/sdk/application/Share/ShareApplicationClient.js +14 -14
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
- package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
- package/sdk/application/User/UserApplicationClient.d.ts +64 -64
- package/sdk/application/User/UserApplicationClient.js +64 -64
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +38 -38
- package/sdk/partner/Theme/ThemePartnerClient.js +38 -38
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +8 -8
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +8 -8
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +34 -36
- package/sdk/platform/Billing/BillingPlatformClient.js +34 -36
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +98 -175
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +98 -254
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +92 -18
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +28 -18
- package/sdk/platform/Cart/CartPlatformModel.d.ts +12 -0
- package/sdk/platform/Cart/CartPlatformModel.js +12 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +195 -108
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +278 -113
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +335 -136
- package/sdk/platform/Catalog/CatalogPlatformClient.js +551 -136
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +5 -5
- package/sdk/platform/Catalog/CatalogPlatformModel.js +3 -3
- package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -3
- package/sdk/platform/Common/CommonPlatformClient.js +3 -3
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +115 -290
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +115 -510
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +2 -13
- package/sdk/platform/Communication/CommunicationPlatformClient.js +2 -29
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +32 -32
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +52 -127
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +52 -204
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +35 -111
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +35 -212
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +142 -1
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +96 -0
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +130 -218
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +136 -314
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +4 -4
- package/sdk/platform/Content/ContentPlatformClient.d.ts +1 -1
- package/sdk/platform/Content/ContentPlatformClient.js +7 -7
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +4 -4
- package/sdk/platform/Content/ContentPlatformValidator.js +4 -4
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +22 -48
- package/sdk/platform/Discount/DiscountPlatformClient.js +22 -73
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +19 -55
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +19 -55
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +14 -50
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +16 -55
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +13 -12
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +12 -14
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +44 -44
- package/sdk/platform/Finance/FinancePlatformClient.js +44 -44
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +12 -12
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +22 -48
- package/sdk/platform/Lead/LeadPlatformClient.js +22 -72
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +4 -4
- package/sdk/platform/Order/OrderPlatformClient.d.ts +79 -208
- package/sdk/platform/Order/OrderPlatformClient.js +79 -294
- package/sdk/platform/Order/OrderPlatformModel.d.ts +32 -3
- package/sdk/platform/Order/OrderPlatformModel.js +34 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +81 -81
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +81 -81
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
- package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +23 -40
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +23 -61
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +5 -5
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +2 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +2 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Share/SharePlatformApplicationClient.js +10 -10
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +56 -56
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +56 -56
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +6 -6
- package/sdk/platform/Theme/ThemePlatformClient.js +6 -6
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +33 -33
- package/sdk/platform/User/UserPlatformApplicationClient.js +33 -33
- package/sdk/platform/User/UserPlatformModel.d.ts +2 -2
- package/sdk/platform/User/UserPlatformModel.js +2 -2
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +32 -45
- package/sdk/platform/Webhook/WebhookPlatformClient.js +32 -45
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +58 -1
- package/sdk/platform/Webhook/WebhookPlatformModel.js +66 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +2 -2
- package/sdk/public/Partner/PartnerPublicClient.d.ts +2 -2
- package/sdk/public/Partner/PartnerPublicClient.js +2 -2
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicClient.js +4 -4
|
@@ -89,7 +89,7 @@ class Payment {
|
|
|
89
89
|
"/service/application/payment/v1.0/refund/verification/bank",
|
|
90
90
|
verifyOtpAndAddBeneficiaryForWallet:
|
|
91
91
|
"/service/application/payment/v1.0/refund/verification/wallet",
|
|
92
|
-
|
|
92
|
+
walletLinkInitate:
|
|
93
93
|
"/service/application/payment/v1.0/payment/options/wallet/link",
|
|
94
94
|
};
|
|
95
95
|
this._urls = Object.entries(this._relativeUrls).reduce(
|
|
@@ -115,8 +115,8 @@ class Payment {
|
|
|
115
115
|
* @returns {Promise<PaymentApplicationModel.RefundAccountResponse>} -
|
|
116
116
|
* Success response
|
|
117
117
|
* @name addBeneficiaryDetails
|
|
118
|
-
* @summary:
|
|
119
|
-
* @description:
|
|
118
|
+
* @summary: Add beneficiary.
|
|
119
|
+
* @description: Adds beneficiary details for future transactions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/addBeneficiaryDetails/).
|
|
120
120
|
*/
|
|
121
121
|
async addBeneficiaryDetails(
|
|
122
122
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -198,8 +198,8 @@ class Payment {
|
|
|
198
198
|
* @returns {Promise<PaymentApplicationModel.RefundAccountResponse>} -
|
|
199
199
|
* Success response
|
|
200
200
|
* @name addRefundBankAccountUsingOTP
|
|
201
|
-
* @summary:
|
|
202
|
-
* @description:
|
|
201
|
+
* @summary: Add refund account.
|
|
202
|
+
* @description: Adds a bank account for refunds using OTP verification. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/addRefundBankAccountUsingOTP/).
|
|
203
203
|
*/
|
|
204
204
|
async addRefundBankAccountUsingOTP(
|
|
205
205
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -278,8 +278,8 @@ class Payment {
|
|
|
278
278
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
279
279
|
* @returns {Promise<PaymentApplicationModel.AttachCardsResponse>} - Success response
|
|
280
280
|
* @name attachCardToCustomer
|
|
281
|
-
* @summary: Attach
|
|
282
|
-
* @description:
|
|
281
|
+
* @summary: Attach card to user.
|
|
282
|
+
* @description: Links a payment card to a customer's account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/attachCardToCustomer/).
|
|
283
283
|
*/
|
|
284
284
|
async attachCardToCustomer(
|
|
285
285
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -359,8 +359,8 @@ class Payment {
|
|
|
359
359
|
* @returns {Promise<PaymentApplicationModel.CancelPaymentLinkResponse>} -
|
|
360
360
|
* Success response
|
|
361
361
|
* @name cancelPaymentLink
|
|
362
|
-
* @summary: Cancel
|
|
363
|
-
* @description:
|
|
362
|
+
* @summary: Cancel link.
|
|
363
|
+
* @description: Cancels a previously generated payment link. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/cancelPaymentLink/).
|
|
364
364
|
*/
|
|
365
365
|
async cancelPaymentLink(
|
|
366
366
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -437,8 +437,8 @@ class Payment {
|
|
|
437
437
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
438
438
|
* @returns {Promise<PaymentApplicationModel.CardDetailsResponse>} - Success response
|
|
439
439
|
* @name cardDetails
|
|
440
|
-
* @summary:
|
|
441
|
-
* @description:
|
|
440
|
+
* @summary: Fetch card details.
|
|
441
|
+
* @description: Gets the details of a specified payment card. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/cardDetails/).
|
|
442
442
|
*/
|
|
443
443
|
async cardDetails(
|
|
444
444
|
{ cardInfo, aggregator, requestHeaders } = { requestHeaders: {} },
|
|
@@ -520,8 +520,8 @@ class Payment {
|
|
|
520
520
|
* - Success response
|
|
521
521
|
*
|
|
522
522
|
* @name checkAndUpdatePaymentStatus
|
|
523
|
-
* @summary:
|
|
524
|
-
* @description:
|
|
523
|
+
* @summary: Update payment status.
|
|
524
|
+
* @description: Checks and updates the current status of a payment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/checkAndUpdatePaymentStatus/).
|
|
525
525
|
*/
|
|
526
526
|
async checkAndUpdatePaymentStatus(
|
|
527
527
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -604,8 +604,8 @@ class Payment {
|
|
|
604
604
|
* - Success response
|
|
605
605
|
*
|
|
606
606
|
* @name checkAndUpdatePaymentStatusPaymentLink
|
|
607
|
-
* @summary:
|
|
608
|
-
* @description:
|
|
607
|
+
* @summary: Update link status.
|
|
608
|
+
* @description: Checks and updates the status of payment via a link. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/checkAndUpdatePaymentStatusPaymentLink/).
|
|
609
609
|
*/
|
|
610
610
|
async checkAndUpdatePaymentStatusPaymentLink(
|
|
611
611
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -684,8 +684,8 @@ class Payment {
|
|
|
684
684
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
685
685
|
* @returns {Promise<PaymentApplicationModel.CheckCreditResponse>} - Success response
|
|
686
686
|
* @name checkCredit
|
|
687
|
-
* @summary:
|
|
688
|
-
* @description:
|
|
687
|
+
* @summary: Verify credit.
|
|
688
|
+
* @description: Checks the availability and status of customer credit. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/checkCredit/).
|
|
689
689
|
*/
|
|
690
690
|
async checkCredit(
|
|
691
691
|
{ aggregator, requestHeaders } = { requestHeaders: {} },
|
|
@@ -766,8 +766,8 @@ class Payment {
|
|
|
766
766
|
* @returns {Promise<PaymentApplicationModel.CreateOrderUserResponse>} -
|
|
767
767
|
* Success response
|
|
768
768
|
* @name createOrderHandlerPaymentLink
|
|
769
|
-
* @summary:
|
|
770
|
-
* @description:
|
|
769
|
+
* @summary: Order via link.
|
|
770
|
+
* @description: Creates an order handler for payment through a link. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/createOrderHandlerPaymentLink/).
|
|
771
771
|
*/
|
|
772
772
|
async createOrderHandlerPaymentLink(
|
|
773
773
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -847,8 +847,8 @@ class Payment {
|
|
|
847
847
|
* @returns {Promise<PaymentApplicationModel.CreatePaymentLinkResponse>} -
|
|
848
848
|
* Success response
|
|
849
849
|
* @name createPaymentLink
|
|
850
|
-
* @summary: Create payment link
|
|
851
|
-
* @description:
|
|
850
|
+
* @summary: Create payment link.
|
|
851
|
+
* @description: Generates a new payment link for transactions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/createPaymentLink/).
|
|
852
852
|
*/
|
|
853
853
|
async createPaymentLink(
|
|
854
854
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1005,8 +1005,8 @@ class Payment {
|
|
|
1005
1005
|
* - Success response
|
|
1006
1006
|
*
|
|
1007
1007
|
* @name customerCreditSummary
|
|
1008
|
-
* @summary:
|
|
1009
|
-
* @description:
|
|
1008
|
+
* @summary: Credit summary.
|
|
1009
|
+
* @description: Retrieves a summary of the customer's credit details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/customerCreditSummary/).
|
|
1010
1010
|
*/
|
|
1011
1011
|
async customerCreditSummary(
|
|
1012
1012
|
{ aggregator, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1087,8 +1087,8 @@ class Payment {
|
|
|
1087
1087
|
* @returns {Promise<PaymentApplicationModel.CustomerOnboardingResponse>} -
|
|
1088
1088
|
* Success response
|
|
1089
1089
|
* @name customerOnboard
|
|
1090
|
-
* @summary:
|
|
1091
|
-
* @description:
|
|
1090
|
+
* @summary: Onboard customer.
|
|
1091
|
+
* @description: Initiates the onboarding process for payment services. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/customerOnboard/).
|
|
1092
1092
|
*/
|
|
1093
1093
|
async customerOnboard(
|
|
1094
1094
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1165,8 +1165,8 @@ class Payment {
|
|
|
1165
1165
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1166
1166
|
* @returns {Promise<PaymentApplicationModel.DeleteCardsResponse>} - Success response
|
|
1167
1167
|
* @name deleteUserCard
|
|
1168
|
-
* @summary:
|
|
1169
|
-
* @description:
|
|
1168
|
+
* @summary: Remove user's card.
|
|
1169
|
+
* @description: Deletes a payment card from the user's account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/deleteUserCard/).
|
|
1170
1170
|
*/
|
|
1171
1171
|
async deleteUserCard(
|
|
1172
1172
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1325,8 +1325,8 @@ class Payment {
|
|
|
1325
1325
|
* - Success response
|
|
1326
1326
|
*
|
|
1327
1327
|
* @name enableOrDisableRefundTransferMode
|
|
1328
|
-
* @summary:
|
|
1329
|
-
* @description:
|
|
1328
|
+
* @summary: Toggle refund mode.
|
|
1329
|
+
* @description: Enables or disables a particular refund transfer mode. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/enableOrDisableRefundTransferMode/).
|
|
1330
1330
|
*/
|
|
1331
1331
|
async enableOrDisableRefundTransferMode(
|
|
1332
1332
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1407,8 +1407,8 @@ class Payment {
|
|
|
1407
1407
|
* - Success response
|
|
1408
1408
|
*
|
|
1409
1409
|
* @name getActiveCardAggregator
|
|
1410
|
-
* @summary:
|
|
1411
|
-
* @description:
|
|
1410
|
+
* @summary: Active card info.
|
|
1411
|
+
* @description: Gets the active card aggregator for the user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getActiveCardAggregator/).
|
|
1412
1412
|
*/
|
|
1413
1413
|
async getActiveCardAggregator(
|
|
1414
1414
|
{ refresh, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1490,8 +1490,8 @@ class Payment {
|
|
|
1490
1490
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1491
1491
|
* @returns {Promise<PaymentApplicationModel.TransferModeResponse>} - Success response
|
|
1492
1492
|
* @name getActiveRefundTransferModes
|
|
1493
|
-
* @summary:
|
|
1494
|
-
* @description:
|
|
1493
|
+
* @summary: Refund modes.
|
|
1494
|
+
* @description: Lists the active transfer modes for refunds. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getActiveRefundTransferModes/).
|
|
1495
1495
|
*/
|
|
1496
1496
|
async getActiveRefundTransferModes(
|
|
1497
1497
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -1570,8 +1570,8 @@ class Payment {
|
|
|
1570
1570
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1571
1571
|
* @returns {Promise<PaymentApplicationModel.ListCardsResponse>} - Success response
|
|
1572
1572
|
* @name getActiveUserCards
|
|
1573
|
-
* @summary:
|
|
1574
|
-
* @description:
|
|
1573
|
+
* @summary: List user's cards.
|
|
1574
|
+
* @description: Retrieves all active cards linked to a user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getActiveUserCards/).
|
|
1575
1575
|
*/
|
|
1576
1576
|
async getActiveUserCards(
|
|
1577
1577
|
{ forceRefresh, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1651,8 +1651,8 @@ class Payment {
|
|
|
1651
1651
|
* - Success response
|
|
1652
1652
|
*
|
|
1653
1653
|
* @name getAggregatorsConfig
|
|
1654
|
-
* @summary:
|
|
1655
|
-
* @description:
|
|
1654
|
+
* @summary: Fetch payment aggregators.
|
|
1655
|
+
* @description: Retrieves configuration details for available payment aggregators. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getAggregatorsConfig/).
|
|
1656
1656
|
*/
|
|
1657
1657
|
async getAggregatorsConfig(
|
|
1658
1658
|
{ xApiToken, refresh, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1736,8 +1736,8 @@ class Payment {
|
|
|
1736
1736
|
* @returns {Promise<PaymentApplicationModel.EpaylaterBannerResponse>} -
|
|
1737
1737
|
* Success response
|
|
1738
1738
|
* @name getEpaylaterBannerDetails
|
|
1739
|
-
* @summary:
|
|
1740
|
-
* @description:
|
|
1739
|
+
* @summary: Epay banner info.
|
|
1740
|
+
* @description: Gets details for displaying the Epaylater payment banner. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getEpaylaterBannerDetails/).
|
|
1741
1741
|
*/
|
|
1742
1742
|
async getEpaylaterBannerDetails(
|
|
1743
1743
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -1819,8 +1819,8 @@ class Payment {
|
|
|
1819
1819
|
* @returns {Promise<PaymentApplicationModel.OrderBeneficiaryResponse>} -
|
|
1820
1820
|
* Success response
|
|
1821
1821
|
* @name getOrderBeneficiariesDetail
|
|
1822
|
-
* @summary:
|
|
1823
|
-
* @description:
|
|
1822
|
+
* @summary: Order beneficiaries.
|
|
1823
|
+
* @description: Retrieve the beneficiary details related to an order. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getOrderBeneficiariesDetail/).
|
|
1824
1824
|
*/
|
|
1825
1825
|
async getOrderBeneficiariesDetail(
|
|
1826
1826
|
{ orderId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1901,8 +1901,8 @@ class Payment {
|
|
|
1901
1901
|
* @returns {Promise<PaymentApplicationModel.GetPaymentLinkResponse>} -
|
|
1902
1902
|
* Success response
|
|
1903
1903
|
* @name getPaymentLink
|
|
1904
|
-
* @summary:
|
|
1905
|
-
* @description:
|
|
1904
|
+
* @summary: Fetch payment link.
|
|
1905
|
+
* @description: Retrieves a generated payment link. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getPaymentLink/).
|
|
1906
1906
|
*/
|
|
1907
1907
|
async getPaymentLink(
|
|
1908
1908
|
{ paymentLinkId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1981,8 +1981,8 @@ class Payment {
|
|
|
1981
1981
|
* @returns {Promise<PaymentApplicationModel.PaymentModeRouteResponse>} -
|
|
1982
1982
|
* Success response
|
|
1983
1983
|
* @name getPaymentModeRoutes
|
|
1984
|
-
* @summary: Get
|
|
1985
|
-
* @description:
|
|
1984
|
+
* @summary: Get payment modes.
|
|
1985
|
+
* @description: Lists the payment mode options and their routing details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getPaymentModeRoutes/).
|
|
1986
1986
|
*/
|
|
1987
1987
|
async getPaymentModeRoutes(
|
|
1988
1988
|
{
|
|
@@ -2108,8 +2108,8 @@ class Payment {
|
|
|
2108
2108
|
* @returns {Promise<PaymentApplicationModel.PaymentModeRouteResponse>} -
|
|
2109
2109
|
* Success response
|
|
2110
2110
|
* @name getPaymentModeRoutesPaymentLink
|
|
2111
|
-
* @summary:
|
|
2112
|
-
* @description:
|
|
2111
|
+
* @summary: Payment link modes.
|
|
2112
|
+
* @description: Lists payment modes available for a given payment link. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getPaymentModeRoutesPaymentLink/).
|
|
2113
2113
|
*/
|
|
2114
2114
|
async getPaymentModeRoutesPaymentLink(
|
|
2115
2115
|
{ paymentLinkId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2190,8 +2190,8 @@ class Payment {
|
|
|
2190
2190
|
* @returns {Promise<PaymentApplicationModel.PaymentModeRouteResponse>} -
|
|
2191
2191
|
* Success response
|
|
2192
2192
|
* @name getPosPaymentModeRoutes
|
|
2193
|
-
* @summary:
|
|
2194
|
-
* @description:
|
|
2193
|
+
* @summary: POS payment modes.
|
|
2194
|
+
* @description: Lists payment modes available for Point-of-Sale (POS). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getPosPaymentModeRoutes/).
|
|
2195
2195
|
*/
|
|
2196
2196
|
async getPosPaymentModeRoutes(
|
|
2197
2197
|
{
|
|
@@ -2306,8 +2306,8 @@ class Payment {
|
|
|
2306
2306
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
2307
2307
|
* @returns {Promise<PaymentApplicationModel.RupifiBannerResponse>} - Success response
|
|
2308
2308
|
* @name getRupifiBannerDetails
|
|
2309
|
-
* @summary:
|
|
2310
|
-
* @description:
|
|
2309
|
+
* @summary: Rupifi banner info.
|
|
2310
|
+
* @description: Retrieve details for displaying the Rupifi payment banner. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getRupifiBannerDetails/).
|
|
2311
2311
|
*/
|
|
2312
2312
|
async getRupifiBannerDetails(
|
|
2313
2313
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -2389,8 +2389,8 @@ class Payment {
|
|
|
2389
2389
|
* @returns {Promise<PaymentApplicationModel.OrderBeneficiaryResponse>} -
|
|
2390
2390
|
* Success response
|
|
2391
2391
|
* @name getUserBeneficiariesDetail
|
|
2392
|
-
* @summary:
|
|
2393
|
-
* @description:
|
|
2392
|
+
* @summary: Beneficiary info.
|
|
2393
|
+
* @description: Retrieves details of beneficiaries linked to the user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getUserBeneficiariesDetail/).
|
|
2394
2394
|
*/
|
|
2395
2395
|
async getUserBeneficiariesDetail(
|
|
2396
2396
|
{ orderId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2472,8 +2472,8 @@ class Payment {
|
|
|
2472
2472
|
* - Success response
|
|
2473
2473
|
*
|
|
2474
2474
|
* @name initialisePayment
|
|
2475
|
-
* @summary:
|
|
2476
|
-
* @description:
|
|
2475
|
+
* @summary: Start payment process.
|
|
2476
|
+
* @description: Initializes the payment procedure for an order. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/initialisePayment/).
|
|
2477
2477
|
*/
|
|
2478
2478
|
async initialisePayment(
|
|
2479
2479
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2554,8 +2554,8 @@ class Payment {
|
|
|
2554
2554
|
* - Success response
|
|
2555
2555
|
*
|
|
2556
2556
|
* @name initialisePaymentPaymentLink
|
|
2557
|
-
* @summary:
|
|
2558
|
-
* @description:
|
|
2557
|
+
* @summary: Initialise link payment.
|
|
2558
|
+
* @description: Initializes payment for an order via a payment link. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/initialisePaymentPaymentLink/).
|
|
2559
2559
|
*/
|
|
2560
2560
|
async initialisePaymentPaymentLink(
|
|
2561
2561
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2714,8 +2714,8 @@ class Payment {
|
|
|
2714
2714
|
* - Success response
|
|
2715
2715
|
*
|
|
2716
2716
|
* @name outstandingOrderDetails
|
|
2717
|
-
* @summary:
|
|
2718
|
-
* @description:
|
|
2717
|
+
* @summary: Outstanding orders.
|
|
2718
|
+
* @description: Lists details of orders with outstanding payments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/outstandingOrderDetails/).
|
|
2719
2719
|
*/
|
|
2720
2720
|
async outstandingOrderDetails(
|
|
2721
2721
|
{ aggregator, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2796,8 +2796,8 @@ class Payment {
|
|
|
2796
2796
|
* @returns {Promise<PaymentApplicationModel.PaidOrderDetailsResponse>} -
|
|
2797
2797
|
* Success response
|
|
2798
2798
|
* @name paidOrderDetails
|
|
2799
|
-
* @summary:
|
|
2800
|
-
* @description:
|
|
2799
|
+
* @summary: Paid orders.
|
|
2800
|
+
* @description: Retrieves details of orders that have been paid for. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/paidOrderDetails/).
|
|
2801
2801
|
*/
|
|
2802
2802
|
async paidOrderDetails(
|
|
2803
2803
|
{ aggregator, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2876,8 +2876,8 @@ class Payment {
|
|
|
2876
2876
|
* @returns {Promise<PaymentApplicationModel.PollingPaymentLinkResponse>} -
|
|
2877
2877
|
* Success response
|
|
2878
2878
|
* @name pollingPaymentLink
|
|
2879
|
-
* @summary:
|
|
2880
|
-
* @description:
|
|
2879
|
+
* @summary: Poll payment link.
|
|
2880
|
+
* @description: Polls the status of a payment link for updates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/pollingPaymentLink/).
|
|
2881
2881
|
*/
|
|
2882
2882
|
async pollingPaymentLink(
|
|
2883
2883
|
{ paymentLinkId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2957,8 +2957,8 @@ class Payment {
|
|
|
2957
2957
|
* - Success response
|
|
2958
2958
|
*
|
|
2959
2959
|
* @name redirectToAggregator
|
|
2960
|
-
* @summary:
|
|
2961
|
-
* @description:
|
|
2960
|
+
* @summary: Redirect for payment.
|
|
2961
|
+
* @description: Redirects the user to the payment aggregator's interface. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/redirectToAggregator/).
|
|
2962
2962
|
*/
|
|
2963
2963
|
async redirectToAggregator(
|
|
2964
2964
|
{ source, aggregator, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3039,8 +3039,8 @@ class Payment {
|
|
|
3039
3039
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
3040
3040
|
* @returns {Promise<PaymentApplicationModel.renderHTMLResponse>} - Success response
|
|
3041
3041
|
* @name renderHTML
|
|
3042
|
-
* @summary:
|
|
3043
|
-
* @description:
|
|
3042
|
+
* @summary: Render HTML.
|
|
3043
|
+
* @description: Generates HTML for payment-related interfaces. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/renderHTML/).
|
|
3044
3044
|
*/
|
|
3045
3045
|
async renderHTML(
|
|
3046
3046
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3119,8 +3119,8 @@ class Payment {
|
|
|
3119
3119
|
* - Success response
|
|
3120
3120
|
*
|
|
3121
3121
|
* @name resendOrCancelPayment
|
|
3122
|
-
* @summary:
|
|
3123
|
-
* @description:
|
|
3122
|
+
* @summary: Manage payment.
|
|
3123
|
+
* @description: Resends or cancels a pending payment transaction. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/resendOrCancelPayment/).
|
|
3124
3124
|
*/
|
|
3125
3125
|
async resendOrCancelPayment(
|
|
3126
3126
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3200,8 +3200,8 @@ class Payment {
|
|
|
3200
3200
|
* @returns {Promise<PaymentApplicationModel.ResendPaymentLinkResponse>} -
|
|
3201
3201
|
* Success response
|
|
3202
3202
|
* @name resendPaymentLink
|
|
3203
|
-
* @summary: Resend
|
|
3204
|
-
* @description:
|
|
3203
|
+
* @summary: Resend link.
|
|
3204
|
+
* @description: Resends an existing payment link to the user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/resendPaymentLink/).
|
|
3205
3205
|
*/
|
|
3206
3206
|
async resendPaymentLink(
|
|
3207
3207
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3281,8 +3281,8 @@ class Payment {
|
|
|
3281
3281
|
* - Success response
|
|
3282
3282
|
*
|
|
3283
3283
|
* @name updateDefaultBeneficiary
|
|
3284
|
-
* @summary: Set
|
|
3285
|
-
* @description:
|
|
3284
|
+
* @summary: Set default beneficiary.
|
|
3285
|
+
* @description: Updates the default beneficiary for the user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/updateDefaultBeneficiary/).
|
|
3286
3286
|
*/
|
|
3287
3287
|
async updateDefaultBeneficiary(
|
|
3288
3288
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3361,8 +3361,8 @@ class Payment {
|
|
|
3361
3361
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
3362
3362
|
* @returns {Promise<PaymentApplicationModel.ValidateVPAResponse>} - Success response
|
|
3363
3363
|
* @name validateVPA
|
|
3364
|
-
* @summary:
|
|
3365
|
-
* @description:
|
|
3364
|
+
* @summary: Validate VPA.
|
|
3365
|
+
* @description: Checks the validity of a Virtual Payment Address (VPA). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/validateVPA/).
|
|
3366
3366
|
*/
|
|
3367
3367
|
async validateVPA(
|
|
3368
3368
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3440,8 +3440,8 @@ class Payment {
|
|
|
3440
3440
|
* @returns {Promise<PaymentApplicationModel.ChargeCustomerResponse>} -
|
|
3441
3441
|
* Success response
|
|
3442
3442
|
* @name verifyAndChargePayment
|
|
3443
|
-
* @summary: Verify and charge
|
|
3444
|
-
* @description:
|
|
3443
|
+
* @summary: Verify and charge.
|
|
3444
|
+
* @description: Validates and processes a payment transaction. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/verifyAndChargePayment/).
|
|
3445
3445
|
*/
|
|
3446
3446
|
async verifyAndChargePayment(
|
|
3447
3447
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3522,8 +3522,8 @@ class Payment {
|
|
|
3522
3522
|
* @returns {Promise<PaymentApplicationModel.ValidateCustomerResponse>} -
|
|
3523
3523
|
* Success response
|
|
3524
3524
|
* @name verifyCustomerForPayment
|
|
3525
|
-
* @summary:
|
|
3526
|
-
* @description:
|
|
3525
|
+
* @summary: Verify payment customer.
|
|
3526
|
+
* @description: Checks the user's validity for proceeding with payment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/verifyCustomerForPayment/).
|
|
3527
3527
|
*/
|
|
3528
3528
|
async verifyCustomerForPayment(
|
|
3529
3529
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3602,8 +3602,8 @@ class Payment {
|
|
|
3602
3602
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
3603
3603
|
* @returns {Promise<PaymentApplicationModel.IfscCodeResponse>} - Success response
|
|
3604
3604
|
* @name verifyIfscCode
|
|
3605
|
-
* @summary: Verify IFSC
|
|
3606
|
-
* @description:
|
|
3605
|
+
* @summary: Verify IFSC.
|
|
3606
|
+
* @description: Checks the validity of an IFSC code for bank transactions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/verifyIfscCode/).
|
|
3607
3607
|
*/
|
|
3608
3608
|
async verifyIfscCode(
|
|
3609
3609
|
{ ifscCode, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3685,8 +3685,8 @@ class Payment {
|
|
|
3685
3685
|
* - Success response
|
|
3686
3686
|
*
|
|
3687
3687
|
* @name verifyOtpAndAddBeneficiaryForBank
|
|
3688
|
-
* @summary: Verify
|
|
3689
|
-
* @description:
|
|
3688
|
+
* @summary: Verify OTP for bank.
|
|
3689
|
+
* @description: Confirms OTP and adds a bank beneficiary. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/verifyOtpAndAddBeneficiaryForBank/).
|
|
3690
3690
|
*/
|
|
3691
3691
|
async verifyOtpAndAddBeneficiaryForBank(
|
|
3692
3692
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3767,8 +3767,8 @@ class Payment {
|
|
|
3767
3767
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
3768
3768
|
* @returns {Promise<PaymentApplicationModel.WalletOtpResponse>} - Success response
|
|
3769
3769
|
* @name verifyOtpAndAddBeneficiaryForWallet
|
|
3770
|
-
* @summary:
|
|
3771
|
-
* @description:
|
|
3770
|
+
* @summary: Verify OTP for wallet.
|
|
3771
|
+
* @description: Confirms OTP and adds a wallet beneficiary. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/verifyOtpAndAddBeneficiaryForWallet/).
|
|
3772
3772
|
*/
|
|
3773
3773
|
async verifyOtpAndAddBeneficiaryForWallet(
|
|
3774
3774
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3842,19 +3842,19 @@ class Payment {
|
|
|
3842
3842
|
}
|
|
3843
3843
|
|
|
3844
3844
|
/**
|
|
3845
|
-
* @param {PaymentApplicationValidator.
|
|
3845
|
+
* @param {PaymentApplicationValidator.WalletLinkInitateParam} arg - Arg object.
|
|
3846
3846
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
3847
3847
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
3848
3848
|
* @returns {Promise<PaymentApplicationModel.WalletResponseSchema>} - Success response
|
|
3849
|
-
* @name
|
|
3849
|
+
* @name walletLinkInitate
|
|
3850
3850
|
* @summary: Initiate linking of wallet
|
|
3851
|
-
* @description: It will initiate linking of wallet for the aggregator. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/
|
|
3851
|
+
* @description: It will initiate linking of wallet for the aggregator. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/walletLinkInitate/).
|
|
3852
3852
|
*/
|
|
3853
|
-
async
|
|
3853
|
+
async walletLinkInitate(
|
|
3854
3854
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
3855
3855
|
{ responseHeaders } = { responseHeaders: false }
|
|
3856
3856
|
) {
|
|
3857
|
-
const { error } = PaymentApplicationValidator.
|
|
3857
|
+
const { error } = PaymentApplicationValidator.walletLinkInitate().validate(
|
|
3858
3858
|
{ body },
|
|
3859
3859
|
{ abortEarly: false, allowUnknown: true }
|
|
3860
3860
|
);
|
|
@@ -3865,14 +3865,14 @@ class Payment {
|
|
|
3865
3865
|
// Showing warrnings if extra unknown parameters are found
|
|
3866
3866
|
const {
|
|
3867
3867
|
error: warrning,
|
|
3868
|
-
} = PaymentApplicationValidator.
|
|
3868
|
+
} = PaymentApplicationValidator.walletLinkInitate().validate(
|
|
3869
3869
|
{ body },
|
|
3870
3870
|
{ abortEarly: false, allowUnknown: false }
|
|
3871
3871
|
);
|
|
3872
3872
|
if (warrning) {
|
|
3873
3873
|
Logger({
|
|
3874
3874
|
level: "WARN",
|
|
3875
|
-
message: `Parameter Validation warrnings for application > Payment >
|
|
3875
|
+
message: `Parameter Validation warrnings for application > Payment > walletLinkInitate \n ${warrning}`,
|
|
3876
3876
|
});
|
|
3877
3877
|
}
|
|
3878
3878
|
|
|
@@ -3884,7 +3884,7 @@ class Payment {
|
|
|
3884
3884
|
this._conf,
|
|
3885
3885
|
"post",
|
|
3886
3886
|
constructUrl({
|
|
3887
|
-
url: this._urls["
|
|
3887
|
+
url: this._urls["walletLinkInitate"],
|
|
3888
3888
|
params: {},
|
|
3889
3889
|
}),
|
|
3890
3890
|
query_params,
|
|
@@ -3911,7 +3911,7 @@ class Payment {
|
|
|
3911
3911
|
} else {
|
|
3912
3912
|
Logger({
|
|
3913
3913
|
level: "WARN",
|
|
3914
|
-
message: `Response Validation Warnings for application > Payment >
|
|
3914
|
+
message: `Response Validation Warnings for application > Payment > walletLinkInitate \n ${res_error}`,
|
|
3915
3915
|
});
|
|
3916
3916
|
}
|
|
3917
3917
|
}
|