@gofynd/fdk-client-javascript 3.3.5 → 3.4.0
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 +30 -30
- package/sdk/application/Cart/CartApplicationClient.js +30 -30
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +36 -33
- package/sdk/application/Catalog/CatalogApplicationClient.js +54 -35
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +2 -2
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +3 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +16 -16
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +16 -16
- package/sdk/application/Content/ContentApplicationClient.d.ts +24 -24
- package/sdk/application/Content/ContentApplicationClient.js +24 -24
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +3 -3
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +3 -3
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +2 -2
- package/sdk/application/Finance/FinanceApplicationClient.js +2 -2
- package/sdk/application/Lead/LeadApplicationClient.d.ts +5 -5
- package/sdk/application/Lead/LeadApplicationClient.js +5 -5
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +19 -9
- package/sdk/application/Logistic/LogisticApplicationClient.js +53 -9
- package/sdk/application/Order/OrderApplicationClient.d.ts +12 -12
- package/sdk/application/Order/OrderApplicationClient.js +12 -12
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +46 -46
- package/sdk/application/Payment/PaymentApplicationClient.js +46 -46
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +7 -7
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +4 -4
- package/sdk/application/Theme/ThemeApplicationClient.js +4 -4
- package/sdk/application/User/UserApplicationClient.d.ts +47 -47
- package/sdk/application/User/UserApplicationClient.js +47 -47
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +1 -1
- package/sdk/application/Webhook/WebhookApplicationClient.js +1 -1
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +6 -6
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +6 -6
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +7 -7
- package/sdk/partner/Lead/LeadPartnerClient.js +7 -7
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +2 -2
- package/sdk/partner/Lead/LeadPartnerModel.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +25 -25
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +25 -25
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +6 -6
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +3 -3
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +24 -24
- package/sdk/partner/Theme/ThemePartnerClient.js +24 -24
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +10 -10
- package/sdk/partner/Webhook/WebhookPartnerClient.js +10 -10
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +7 -2
- package/sdk/partner/Webhook/WebhookPartnerModel.js +3 -1
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +3 -3
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +2 -2
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +1 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +1 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +1 -1
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +5 -5
- package/sdk/platform/Billing/BillingPlatformClient.js +5 -5
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +62 -62
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +62 -62
- package/sdk/platform/Cart/CartPlatformModel.d.ts +233 -3
- package/sdk/platform/Cart/CartPlatformModel.js +147 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +66 -66
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +66 -66
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +81 -79
- package/sdk/platform/Catalog/CatalogPlatformClient.js +93 -80
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +89 -5
- package/sdk/platform/Catalog/CatalogPlatformModel.js +57 -3
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +7 -2
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +4 -2
- package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -2
- package/sdk/platform/Common/CommonPlatformClient.js +2 -2
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +67 -67
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +67 -67
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +2 -2
- package/sdk/platform/Communication/CommunicationPlatformModel.js +1 -1
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +14 -14
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +14 -14
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -2
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +1 -1
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +11 -11
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +11 -11
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +19 -3
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +16 -1
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +107 -107
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +107 -107
- package/sdk/platform/Content/ContentPlatformClient.d.ts +40 -40
- package/sdk/platform/Content/ContentPlatformClient.js +40 -40
- package/sdk/platform/Content/ContentPlatformModel.d.ts +2 -2
- package/sdk/platform/Content/ContentPlatformModel.js +1 -1
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +11 -11
- package/sdk/platform/Discount/DiscountPlatformClient.js +11 -11
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformModel.js +1 -1
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +6 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +10 -10
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +9 -9
- package/sdk/platform/Lead/LeadPlatformClient.js +9 -9
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +2 -2
- package/sdk/platform/Lead/LeadPlatformModel.js +1 -1
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +5 -5
- package/sdk/platform/Order/OrderPlatformClient.d.ts +58 -58
- package/sdk/platform/Order/OrderPlatformClient.js +58 -58
- package/sdk/platform/Order/OrderPlatformModel.d.ts +29 -10
- package/sdk/platform/Order/OrderPlatformModel.js +28 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +2 -2
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +51 -51
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +51 -51
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +10 -10
- package/sdk/platform/Payment/PaymentPlatformClient.js +10 -10
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +2 -2
- package/sdk/platform/Payment/PaymentPlatformModel.js +1 -1
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +12 -12
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.js +1 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +162 -39
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +840 -73
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +139 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +125 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +30 -30
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +36 -30
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +936 -62
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +591 -33
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +12 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +5 -0
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Share/SharePlatformApplicationClient.js +5 -5
- package/sdk/platform/Share/SharePlatformModel.d.ts +2 -2
- package/sdk/platform/Share/SharePlatformModel.js +1 -1
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +22 -22
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +22 -22
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +4 -4
- package/sdk/platform/Theme/ThemePlatformClient.js +4 -4
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +70 -34
- package/sdk/platform/User/UserPlatformApplicationClient.js +285 -34
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +38 -1
- package/sdk/platform/User/UserPlatformApplicationValidator.js +42 -0
- package/sdk/platform/User/UserPlatformModel.d.ts +430 -10
- package/sdk/platform/User/UserPlatformModel.js +276 -7
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +9 -9
- package/sdk/platform/Webhook/WebhookPlatformClient.js +9 -9
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +12 -2
- package/sdk/platform/Webhook/WebhookPlatformModel.js +5 -1
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +1 -1
- package/sdk/public/Catalog/CatalogPublicClient.js +1 -1
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +2 -2
- package/sdk/public/Content/ContentPublicClient.d.ts +14 -14
- package/sdk/public/Content/ContentPublicClient.js +14 -14
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +1 -1
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +5 -5
- package/sdk/public/Webhook/WebhookPublicClient.js +5 -5
|
@@ -112,7 +112,7 @@ class Payment {
|
|
|
112
112
|
* @returns {Promise<RefundAccountDetails>} - Success response
|
|
113
113
|
* @name addBeneficiaryDetails
|
|
114
114
|
* @summary: Add beneficiary for refund
|
|
115
|
-
* @description: Add beneficiary details specifically for refund transactions, including account holder name, account number and bank details. - Check out [method documentation](https://
|
|
115
|
+
* @description: Add beneficiary details specifically for refund transactions, including account holder name, account number and bank details. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/addBeneficiaryDetails/).
|
|
116
116
|
*/
|
|
117
117
|
async addBeneficiaryDetails(
|
|
118
118
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -149,7 +149,7 @@ class Payment {
|
|
|
149
149
|
* @returns {Promise<RefundAccountDetails>} - Success response
|
|
150
150
|
* @name addRefundBankAccountUsingOTP
|
|
151
151
|
* @summary: Add refund account using OTP verification
|
|
152
|
-
* @description: Add bank account specifically for refunds, employing OTP verification for security. - Check out [method documentation](https://
|
|
152
|
+
* @description: Add bank account specifically for refunds, employing OTP verification for security. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/addRefundBankAccountUsingOTP/).
|
|
153
153
|
*/
|
|
154
154
|
async addRefundBankAccountUsingOTP(
|
|
155
155
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -186,7 +186,7 @@ class Payment {
|
|
|
186
186
|
* @returns {Promise<AttachCardsDetails>} - Success response
|
|
187
187
|
* @name attachCardToCustomer
|
|
188
188
|
* @summary: Link payment card to customer
|
|
189
|
-
* @description: Link payment card to a user account for seamless transactions. Upon successful linking, the card becomes associated with the user's profile, enabling secure and convenient payments. - Check out [method documentation](https://
|
|
189
|
+
* @description: Link payment card to a user account for seamless transactions. Upon successful linking, the card becomes associated with the user's profile, enabling secure and convenient payments. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/attachCardToCustomer/).
|
|
190
190
|
*/
|
|
191
191
|
async attachCardToCustomer(
|
|
192
192
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -223,7 +223,7 @@ class Payment {
|
|
|
223
223
|
* @returns {Promise<CancelPaymentLinkDetails>} - Success response
|
|
224
224
|
* @name cancelPaymentLink
|
|
225
225
|
* @summary: Cancel payment link
|
|
226
|
-
* @description: Cancel previously generated payment link. - Check out [method documentation](https://
|
|
226
|
+
* @description: Cancel previously generated payment link. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/cancelPaymentLink/).
|
|
227
227
|
*/
|
|
228
228
|
async cancelPaymentLink(
|
|
229
229
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -260,7 +260,7 @@ class Payment {
|
|
|
260
260
|
* @returns {Promise<CardDetailsFetchedDetails>} - Success response
|
|
261
261
|
* @name cardDetails
|
|
262
262
|
* @summary: Get card details
|
|
263
|
-
* @description: Get details of a specified payment card, including information such as the card type, brand, country, and expiration date. - Check out [method documentation](https://
|
|
263
|
+
* @description: Get details of a specified payment card, including information such as the card type, brand, country, and expiration date. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/cardDetails/).
|
|
264
264
|
*/
|
|
265
265
|
async cardDetails(
|
|
266
266
|
{ cardInfo, aggregator, requestHeaders } = { requestHeaders: {} },
|
|
@@ -307,7 +307,7 @@ class Payment {
|
|
|
307
307
|
* @returns {Promise<PaymentStatusUpdateDetails>} - Success response
|
|
308
308
|
* @name checkAndUpdatePaymentStatus
|
|
309
309
|
* @summary: Update payment status
|
|
310
|
-
* @description: Polling process to confirm the payment status. It periodically checks and updates the current status of a payment, ensuring timely and accurate confirmation of payment transactions. - Check out [method documentation](https://
|
|
310
|
+
* @description: Polling process to confirm the payment status. It periodically checks and updates the current status of a payment, ensuring timely and accurate confirmation of payment transactions. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/checkAndUpdatePaymentStatus/).
|
|
311
311
|
*/
|
|
312
312
|
async checkAndUpdatePaymentStatus(
|
|
313
313
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -344,7 +344,7 @@ class Payment {
|
|
|
344
344
|
* @returns {Promise<PaymentStatusUpdateDetails>} - Success response
|
|
345
345
|
* @name checkAndUpdatePaymentStatusPaymentLink
|
|
346
346
|
* @summary: Update payment link status
|
|
347
|
-
* @description: Verify and update status of a payment made through a link.Upon successful verification and update, the response includes details about the aggregator name, payment status, and whether retrying the process is required. - Check out [method documentation](https://
|
|
347
|
+
* @description: Verify and update status of a payment made through a link.Upon successful verification and update, the response includes details about the aggregator name, payment status, and whether retrying the process is required. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/checkAndUpdatePaymentStatusPaymentLink/).
|
|
348
348
|
*/
|
|
349
349
|
async checkAndUpdatePaymentStatusPaymentLink(
|
|
350
350
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -381,7 +381,7 @@ class Payment {
|
|
|
381
381
|
* @returns {Promise<CheckCreditDetails>} - Success response
|
|
382
382
|
* @name checkCredit
|
|
383
383
|
* @summary: Verify credit availability and status
|
|
384
|
-
* @description: Check the availability and status of customer credit, providing the status of payment along with registration information and signup URL if the customer is not registered. - Check out [method documentation](https://
|
|
384
|
+
* @description: Check the availability and status of customer credit, providing the status of payment along with registration information and signup URL if the customer is not registered. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/checkCredit/).
|
|
385
385
|
*/
|
|
386
386
|
async checkCredit(
|
|
387
387
|
{ aggregator, requestHeaders } = { requestHeaders: {} },
|
|
@@ -419,7 +419,7 @@ class Payment {
|
|
|
419
419
|
* @returns {Promise<CreateOrderUserDetails>} - Success response
|
|
420
420
|
* @name createOrderHandlerPaymentLink
|
|
421
421
|
* @summary: Create order for payment via link
|
|
422
|
-
* @description: Initiate the creation of an order handler for processing payments through a link. - Check out [method documentation](https://
|
|
422
|
+
* @description: Initiate the creation of an order handler for processing payments through a link. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/createOrderHandlerPaymentLink/).
|
|
423
423
|
*/
|
|
424
424
|
async createOrderHandlerPaymentLink(
|
|
425
425
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -456,7 +456,7 @@ class Payment {
|
|
|
456
456
|
* @returns {Promise<CreatePaymentLinkDetails>} - Success response
|
|
457
457
|
* @name createPaymentLink
|
|
458
458
|
* @summary: Create payment link
|
|
459
|
-
* @description: Create new payment link for transactions. - Check out [method documentation](https://
|
|
459
|
+
* @description: Create new payment link for transactions. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/createPaymentLink/).
|
|
460
460
|
*/
|
|
461
461
|
async createPaymentLink(
|
|
462
462
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -493,7 +493,7 @@ class Payment {
|
|
|
493
493
|
* @returns {Promise<PaymentOrderDetails>} - Success response
|
|
494
494
|
* @name createPaymentOrder
|
|
495
495
|
* @summary: Create Order
|
|
496
|
-
* @description: Create an order and payment on the aggregator side. - Check out [method documentation](https://
|
|
496
|
+
* @description: Create an order and payment on the aggregator side. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/createPaymentOrder/).
|
|
497
497
|
*/
|
|
498
498
|
async createPaymentOrder(
|
|
499
499
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -530,7 +530,7 @@ class Payment {
|
|
|
530
530
|
* @returns {Promise<CustomerCreditSummaryDetails>} - Success response
|
|
531
531
|
* @name customerCreditSummary
|
|
532
532
|
* @summary: Credit summary
|
|
533
|
-
* @description: Get summary of the customer's credit information, including details such as merchant customer reference ID, status, balance, limit, due amount, used amount, due date, days overdue, total due amount, and a repayment URL. - Check out [method documentation](https://
|
|
533
|
+
* @description: Get summary of the customer's credit information, including details such as merchant customer reference ID, status, balance, limit, due amount, used amount, due date, days overdue, total due amount, and a repayment URL. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/customerCreditSummary/).
|
|
534
534
|
*/
|
|
535
535
|
async customerCreditSummary(
|
|
536
536
|
{ aggregator, requestHeaders } = { requestHeaders: {} },
|
|
@@ -568,7 +568,7 @@ class Payment {
|
|
|
568
568
|
* @returns {Promise<CustomerOnboardingDetails>} - Success response
|
|
569
569
|
* @name customerOnboard
|
|
570
570
|
* @summary: Onboard customer for payment
|
|
571
|
-
* @description: Initiate the onboarding process for payment services, providing personal, business, and device information, along with marketplace details, to enable customer registration and credit availability. - Check out [method documentation](https://
|
|
571
|
+
* @description: Initiate the onboarding process for payment services, providing personal, business, and device information, along with marketplace details, to enable customer registration and credit availability. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/customerOnboard/).
|
|
572
572
|
*/
|
|
573
573
|
async customerOnboard(
|
|
574
574
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -605,7 +605,7 @@ class Payment {
|
|
|
605
605
|
* @returns {Promise<DeleteCardsDetails>} - Success response
|
|
606
606
|
* @name deleteUserCard
|
|
607
607
|
* @summary: Delete customer card
|
|
608
|
-
* @description: Delete payment card from the user's account. - Check out [method documentation](https://
|
|
608
|
+
* @description: Delete payment card from the user's account. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/deleteUserCard/).
|
|
609
609
|
*/
|
|
610
610
|
async deleteUserCard(
|
|
611
611
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -642,7 +642,7 @@ class Payment {
|
|
|
642
642
|
* @returns {Promise<WalletResponseSchema>} - Success response
|
|
643
643
|
* @name delinkWallet
|
|
644
644
|
* @summary: Delink the wallet
|
|
645
|
-
* @description: Delink the wallet. - Check out [method documentation](https://
|
|
645
|
+
* @description: Delink the wallet. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/delinkWallet/).
|
|
646
646
|
*/
|
|
647
647
|
async delinkWallet(
|
|
648
648
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -679,7 +679,7 @@ class Payment {
|
|
|
679
679
|
* @returns {Promise<RefundTransferModeUpdateDetails>} - Success response
|
|
680
680
|
* @name enableOrDisableRefundTransferMode
|
|
681
681
|
* @summary: Toggle refund mode
|
|
682
|
-
* @description: Enable/Disable a particular refund transfer mode based on the request body parameters, indicating whether the mode should be enabled or disabled. - Check out [method documentation](https://
|
|
682
|
+
* @description: Enable/Disable a particular refund transfer mode based on the request body parameters, indicating whether the mode should be enabled or disabled. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/enableOrDisableRefundTransferMode/).
|
|
683
683
|
*/
|
|
684
684
|
async enableOrDisableRefundTransferMode(
|
|
685
685
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -716,7 +716,7 @@ class Payment {
|
|
|
716
716
|
* @returns {Promise<ActiveCardPaymentGatewayDetails>} - Success response
|
|
717
717
|
* @name getActiveCardAggregator
|
|
718
718
|
* @summary: Retrieve active card aggregator
|
|
719
|
-
* @description: Get details about the active card aggregator used by the user, including the aggregator name.You can refresh the data by setting the 'refresh' parameter to true if needed. - Check out [method documentation](https://
|
|
719
|
+
* @description: Get details about the active card aggregator used by the user, including the aggregator name.You can refresh the data by setting the 'refresh' parameter to true if needed. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/getActiveCardAggregator/).
|
|
720
720
|
*/
|
|
721
721
|
async getActiveCardAggregator(
|
|
722
722
|
{ refresh, requestHeaders } = { requestHeaders: {} },
|
|
@@ -754,7 +754,7 @@ class Payment {
|
|
|
754
754
|
* @returns {Promise<TransferModeFetchDetails>} - Success response
|
|
755
755
|
* @name getActiveRefundTransferModes
|
|
756
756
|
* @summary: Get refund transfer modes
|
|
757
|
-
* @description: Lists available refund modes, such as UPI, providing details like display name, logo, and ID for each mode. - Check out [method documentation](https://
|
|
757
|
+
* @description: Lists available refund modes, such as UPI, providing details like display name, logo, and ID for each mode. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/getActiveRefundTransferModes/).
|
|
758
758
|
*/
|
|
759
759
|
async getActiveRefundTransferModes(
|
|
760
760
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -791,7 +791,7 @@ class Payment {
|
|
|
791
791
|
* @returns {Promise<ListCardsDetails>} - Success response
|
|
792
792
|
* @name getActiveUserCards
|
|
793
793
|
* @summary: Get customer cards
|
|
794
|
-
* @description: List all active cards saved by the user.Includes details such as the card's aggregator name, card ID, token, reference, number, expiration date, type, issuer, brand, nickname, and whether it has expired. - Check out [method documentation](https://
|
|
794
|
+
* @description: List all active cards saved by the user.Includes details such as the card's aggregator name, card ID, token, reference, number, expiration date, type, issuer, brand, nickname, and whether it has expired. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/getActiveUserCards/).
|
|
795
795
|
*/
|
|
796
796
|
async getActiveUserCards(
|
|
797
797
|
{ forceRefresh, requestHeaders } = { requestHeaders: {} },
|
|
@@ -829,7 +829,7 @@ class Payment {
|
|
|
829
829
|
* @returns {Promise<AggregatorsConfigDetail>} - Success response
|
|
830
830
|
* @name getAggregatorsConfig
|
|
831
831
|
* @summary: Get payment aggregators
|
|
832
|
-
* @description: Get aggregator secret key of all payment gateways utilized for payments when using the SDK for the payment gateway. - Check out [method documentation](https://
|
|
832
|
+
* @description: Get aggregator secret key of all payment gateways utilized for payments when using the SDK for the payment gateway. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/getAggregatorsConfig/).
|
|
833
833
|
*/
|
|
834
834
|
async getAggregatorsConfig(
|
|
835
835
|
{ refresh, requestHeaders } = { requestHeaders: {} },
|
|
@@ -867,7 +867,7 @@ class Payment {
|
|
|
867
867
|
* @returns {Promise<EpaylaterBannerDetails>} - Success response
|
|
868
868
|
* @name getEpaylaterBannerDetails
|
|
869
869
|
* @summary: Epaylater banner info
|
|
870
|
-
* @description: Get Epaylater payment banner details. It provides information about the banner's display status, along with relevant messages and the user's registration status. - Check out [method documentation](https://
|
|
870
|
+
* @description: Get Epaylater payment banner details. It provides information about the banner's display status, along with relevant messages and the user's registration status. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/getEpaylaterBannerDetails/).
|
|
871
871
|
*/
|
|
872
872
|
async getEpaylaterBannerDetails(
|
|
873
873
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -904,7 +904,7 @@ class Payment {
|
|
|
904
904
|
* @returns {Promise<OrderBeneficiaryFetchDetails>} - Success response
|
|
905
905
|
* @name getOrderBeneficiariesDetail
|
|
906
906
|
* @summary: Retrieve beneficiary details
|
|
907
|
-
* @description: Get beneficiary details like bank name , ifsc code , branch name associated with a specific order for refund processing. - Check out [method documentation](https://
|
|
907
|
+
* @description: Get beneficiary details like bank name , ifsc code , branch name associated with a specific order for refund processing. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/getOrderBeneficiariesDetail/).
|
|
908
908
|
*/
|
|
909
909
|
async getOrderBeneficiariesDetail(
|
|
910
910
|
{ orderId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -942,7 +942,7 @@ class Payment {
|
|
|
942
942
|
* @returns {Promise<GetPaymentLinkDetails>} - Success response
|
|
943
943
|
* @name getPaymentLink
|
|
944
944
|
* @summary: Get payment link
|
|
945
|
-
* @description: Get a generated payment link. - Check out [method documentation](https://
|
|
945
|
+
* @description: Get a generated payment link. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/getPaymentLink/).
|
|
946
946
|
*/
|
|
947
947
|
async getPaymentLink(
|
|
948
948
|
{ paymentLinkId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -980,7 +980,7 @@ class Payment {
|
|
|
980
980
|
* @returns {Promise<PaymentModeRouteDetails>} - Success response
|
|
981
981
|
* @name getPaymentModeRoutes
|
|
982
982
|
* @summary: Get payment modes
|
|
983
|
-
* @description: Get available payment methods on the payment page, specifying the aggregator for each option, such as 'Netbanking powered by Juspay' and 'Card powered by Razorpay'. - Check out [method documentation](https://
|
|
983
|
+
* @description: Get available payment methods on the payment page, specifying the aggregator for each option, such as 'Netbanking powered by Juspay' and 'Card powered by Razorpay'. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/getPaymentModeRoutes/).
|
|
984
984
|
*/
|
|
985
985
|
async getPaymentModeRoutes(
|
|
986
986
|
{
|
|
@@ -1039,7 +1039,7 @@ class Payment {
|
|
|
1039
1039
|
* @returns {Promise<PaymentModeRouteDetails>} - Success response
|
|
1040
1040
|
* @name getPaymentModeRoutesPaymentLink
|
|
1041
1041
|
* @summary: Payment modes for payment link
|
|
1042
|
-
* @description: List payment modes available for a given payment link. - Check out [method documentation](https://
|
|
1042
|
+
* @description: List payment modes available for a given payment link. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/getPaymentModeRoutesPaymentLink/).
|
|
1043
1043
|
*/
|
|
1044
1044
|
async getPaymentModeRoutesPaymentLink(
|
|
1045
1045
|
{ paymentLinkId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1077,7 +1077,7 @@ class Payment {
|
|
|
1077
1077
|
* @returns {Promise<PaymentModeRouteDetails>} - Success response
|
|
1078
1078
|
* @name getPosPaymentModeRoutes
|
|
1079
1079
|
* @summary: POS payment modes
|
|
1080
|
-
* @description: Get available payment methods on the payment page for POS, specifying the aggregator for each option, such as 'CARD powered by Juspay' and 'QR powered by Razorpay'. - Check out [method documentation](https://
|
|
1080
|
+
* @description: Get available payment methods on the payment page for POS, specifying the aggregator for each option, such as 'CARD powered by Juspay' and 'QR powered by Razorpay'. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/getPosPaymentModeRoutes/).
|
|
1081
1081
|
*/
|
|
1082
1082
|
async getPosPaymentModeRoutes(
|
|
1083
1083
|
{
|
|
@@ -1132,7 +1132,7 @@ class Payment {
|
|
|
1132
1132
|
* @returns {Promise<RupifiBannerDetails>} - Success response
|
|
1133
1133
|
* @name getRupifiBannerDetails
|
|
1134
1134
|
* @summary: Rupifi banner info
|
|
1135
|
-
* @description: Get Rupifi payment banner details. It provides information such as the KYC URL and the current status of the Rupifi payment banner. - Check out [method documentation](https://
|
|
1135
|
+
* @description: Get Rupifi payment banner details. It provides information such as the KYC URL and the current status of the Rupifi payment banner. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/getRupifiBannerDetails/).
|
|
1136
1136
|
*/
|
|
1137
1137
|
async getRupifiBannerDetails(
|
|
1138
1138
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -1169,7 +1169,7 @@ class Payment {
|
|
|
1169
1169
|
* @returns {Promise<OrderBeneficiaryFetchDetails>} - Success response
|
|
1170
1170
|
* @name getUserBeneficiariesDetail
|
|
1171
1171
|
* @summary: Retrieve beneficiary details
|
|
1172
|
-
* @description: Get beneficiaries associated with the user for processing refunds, based on the provided order ID. - Check out [method documentation](https://
|
|
1172
|
+
* @description: Get beneficiaries associated with the user for processing refunds, based on the provided order ID. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/getUserBeneficiariesDetail/).
|
|
1173
1173
|
*/
|
|
1174
1174
|
async getUserBeneficiariesDetail(
|
|
1175
1175
|
{ orderId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1207,7 +1207,7 @@ class Payment {
|
|
|
1207
1207
|
* @returns {Promise<PaymentInitializationDetails>} - Success response
|
|
1208
1208
|
* @name initialisePayment
|
|
1209
1209
|
* @summary: Start payment process
|
|
1210
|
-
* @description: Initiate the payment procedure for an order. Upon successful initiation, it returns a details including the success status, aggregator information, payment method, status, merchant order ID aggregator order , polling URL, timeout, virtual ID, Razorpay payment ID, customer ID, and device ID. - Check out [method documentation](https://
|
|
1210
|
+
* @description: Initiate the payment procedure for an order. Upon successful initiation, it returns a details including the success status, aggregator information, payment method, status, merchant order ID aggregator order , polling URL, timeout, virtual ID, Razorpay payment ID, customer ID, and device ID. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/initialisePayment/).
|
|
1211
1211
|
*/
|
|
1212
1212
|
async initialisePayment(
|
|
1213
1213
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1244,7 +1244,7 @@ class Payment {
|
|
|
1244
1244
|
* @returns {Promise<PaymentInitializationDetails>} - Success response
|
|
1245
1245
|
* @name initialisePaymentPaymentLink
|
|
1246
1246
|
* @summary: Initialize payment link
|
|
1247
|
-
* @description: Begin payment process for an order by initializing it through a payment link.Upon successful initialization, the response includes details about the payment status, aggregator details, order IDs, polling URL for status updates, and other relevant information. - Check out [method documentation](https://
|
|
1247
|
+
* @description: Begin payment process for an order by initializing it through a payment link.Upon successful initialization, the response includes details about the payment status, aggregator details, order IDs, polling URL for status updates, and other relevant information. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/initialisePaymentPaymentLink/).
|
|
1248
1248
|
*/
|
|
1249
1249
|
async initialisePaymentPaymentLink(
|
|
1250
1250
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1281,7 +1281,7 @@ class Payment {
|
|
|
1281
1281
|
* @returns {Promise<WalletResponseSchema>} - Success response
|
|
1282
1282
|
* @name linkWallet
|
|
1283
1283
|
* @summary: OTP verification
|
|
1284
|
-
* @description: Verify the linking of wallet using OTP for further processing of payment. - Check out [method documentation](https://
|
|
1284
|
+
* @description: Verify the linking of wallet using OTP for further processing of payment. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/linkWallet/).
|
|
1285
1285
|
*/
|
|
1286
1286
|
async linkWallet(
|
|
1287
1287
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1318,7 +1318,7 @@ class Payment {
|
|
|
1318
1318
|
* @returns {Promise<PaidOrderDetails>} - Success response
|
|
1319
1319
|
* @name paidOrderDetails
|
|
1320
1320
|
* @summary: Retrieve details of paid orders
|
|
1321
|
-
* @description: Get details of orders that have been paid for, including shipment ID, order ID, due date, payment date, amount, and transaction ID, based on the aggregator merchant user ID. - Check out [method documentation](https://
|
|
1321
|
+
* @description: Get details of orders that have been paid for, including shipment ID, order ID, due date, payment date, amount, and transaction ID, based on the aggregator merchant user ID. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/paidOrderDetails/).
|
|
1322
1322
|
*/
|
|
1323
1323
|
async paidOrderDetails(
|
|
1324
1324
|
{ aggregator, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1356,7 +1356,7 @@ class Payment {
|
|
|
1356
1356
|
* @returns {Promise<PollingPaymentLinkDetails>} - Success response
|
|
1357
1357
|
* @name pollingPaymentLink
|
|
1358
1358
|
* @summary: Poll status of payment link
|
|
1359
|
-
* @description: Get real-time information about the payment link's current status, such as whether it has been processed, cancelled, or expired. - Check out [method documentation](https://
|
|
1359
|
+
* @description: Get real-time information about the payment link's current status, such as whether it has been processed, cancelled, or expired. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/pollingPaymentLink/).
|
|
1360
1360
|
*/
|
|
1361
1361
|
async pollingPaymentLink(
|
|
1362
1362
|
{ paymentLinkId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1394,7 +1394,7 @@ class Payment {
|
|
|
1394
1394
|
* @returns {Promise<RedirectToAggregatorDetails>} - Success response
|
|
1395
1395
|
* @name redirectToAggregator
|
|
1396
1396
|
* @summary: Redirects users to the payment aggregator's interface
|
|
1397
|
-
* @description: This endpoint is used to redirect users to the payment aggregator's platform where they can complete the payment process. The request may include necessary details for initiating the payment on the aggregator’s side, and the user is transferred seamlessly to their interface. - Check out [method documentation](https://
|
|
1397
|
+
* @description: This endpoint is used to redirect users to the payment aggregator's platform where they can complete the payment process. The request may include necessary details for initiating the payment on the aggregator’s side, and the user is transferred seamlessly to their interface. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/redirectToAggregator/).
|
|
1398
1398
|
*/
|
|
1399
1399
|
async redirectToAggregator(
|
|
1400
1400
|
{ aggregator, source, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1433,7 +1433,7 @@ class Payment {
|
|
|
1433
1433
|
* @returns {Promise<RenderHTMLDetails>} - Success response
|
|
1434
1434
|
* @name renderHTML
|
|
1435
1435
|
* @summary: Render HTML
|
|
1436
|
-
* @description: Render HTML for a payment aggregator page. - Check out [method documentation](https://
|
|
1436
|
+
* @description: Render HTML for a payment aggregator page. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/renderHTML/).
|
|
1437
1437
|
*/
|
|
1438
1438
|
async renderHTML(
|
|
1439
1439
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1470,7 +1470,7 @@ class Payment {
|
|
|
1470
1470
|
* @returns {Promise<ResendOrCancelPaymentDetails>} - Success response
|
|
1471
1471
|
* @name resendOrCancelPayment
|
|
1472
1472
|
* @summary: Resend or cancel a pending payment transaction
|
|
1473
|
-
* @description: Resend or cancel payment link that have been initiated but may require modification or cancellation for various reasons, ensuring flexibility and control in payment processing. - Check out [method documentation](https://
|
|
1473
|
+
* @description: Resend or cancel payment link that have been initiated but may require modification or cancellation for various reasons, ensuring flexibility and control in payment processing. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/resendOrCancelPayment/).
|
|
1474
1474
|
*/
|
|
1475
1475
|
async resendOrCancelPayment(
|
|
1476
1476
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1507,7 +1507,7 @@ class Payment {
|
|
|
1507
1507
|
* @returns {Promise<ResendPaymentLinkDetails>} - Success response
|
|
1508
1508
|
* @name resendPaymentLink
|
|
1509
1509
|
* @summary: Resend payment link
|
|
1510
|
-
* @description: Resend an existing payment link to the user to complete the payment. - Check out [method documentation](https://
|
|
1510
|
+
* @description: Resend an existing payment link to the user to complete the payment. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/resendPaymentLink/).
|
|
1511
1511
|
*/
|
|
1512
1512
|
async resendPaymentLink(
|
|
1513
1513
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1544,7 +1544,7 @@ class Payment {
|
|
|
1544
1544
|
* @returns {Promise<SetDefaultBeneficiaryDetails>} - Success response
|
|
1545
1545
|
* @name updateDefaultBeneficiary
|
|
1546
1546
|
* @summary: Set default beneficiary for refund
|
|
1547
|
-
* @description: Update default beneficiary for the order refund of the user. - Check out [method documentation](https://
|
|
1547
|
+
* @description: Update default beneficiary for the order refund of the user. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/updateDefaultBeneficiary/).
|
|
1548
1548
|
*/
|
|
1549
1549
|
async updateDefaultBeneficiary(
|
|
1550
1550
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1581,7 +1581,7 @@ class Payment {
|
|
|
1581
1581
|
* @returns {Promise<ValidateCustomerCreditSchema>} - Success response
|
|
1582
1582
|
* @name validateCustomerAndCreditSummary
|
|
1583
1583
|
* @summary: Verify payment customer and show credit summary
|
|
1584
|
-
* @description: Verify if the user is eligible for payment and also show credit summary if activated. - Check out [method documentation](https://
|
|
1584
|
+
* @description: Verify if the user is eligible for payment and also show credit summary if activated. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/validateCustomerAndCreditSummary/).
|
|
1585
1585
|
*/
|
|
1586
1586
|
async validateCustomerAndCreditSummary(
|
|
1587
1587
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1618,7 +1618,7 @@ class Payment {
|
|
|
1618
1618
|
* @returns {Promise<ValidateVPADetails>} - Success response
|
|
1619
1619
|
* @name validateVPA
|
|
1620
1620
|
* @summary: Validate VPA
|
|
1621
|
-
* @description: Validate if a Virtual Payment Address (VPA) is valid for processing payments and returns the validation result.is_valid boolean value indicating whether the VPA is valid for payments. - Check out [method documentation](https://
|
|
1621
|
+
* @description: Validate if a Virtual Payment Address (VPA) is valid for processing payments and returns the validation result.is_valid boolean value indicating whether the VPA is valid for payments. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/validateVPA/).
|
|
1622
1622
|
*/
|
|
1623
1623
|
async validateVPA(
|
|
1624
1624
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1655,7 +1655,7 @@ class Payment {
|
|
|
1655
1655
|
* @returns {Promise<ChargeCustomerDetails>} - Success response
|
|
1656
1656
|
* @name verifyAndChargePayment
|
|
1657
1657
|
* @summary: Verify order confirmation and charge
|
|
1658
|
-
* @description: Verify the payment status and charge from the customer's BNPL (Buy Now, Pay Later) account after order confirmation. - Check out [method documentation](https://
|
|
1658
|
+
* @description: Verify the payment status and charge from the customer's BNPL (Buy Now, Pay Later) account after order confirmation. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/verifyAndChargePayment/).
|
|
1659
1659
|
*/
|
|
1660
1660
|
async verifyAndChargePayment(
|
|
1661
1661
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1692,7 +1692,7 @@ class Payment {
|
|
|
1692
1692
|
* @returns {Promise<ValidateCustomerDetails>} - Success response
|
|
1693
1693
|
* @name verifyCustomerForPayment
|
|
1694
1694
|
* @summary: Verify payment customer
|
|
1695
|
-
* @description: Verify if the user is eligible for pay-later payment from the payment aggregator side using the customer's phone number. - Check out [method documentation](https://
|
|
1695
|
+
* @description: Verify if the user is eligible for pay-later payment from the payment aggregator side using the customer's phone number. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/verifyCustomerForPayment/).
|
|
1696
1696
|
*/
|
|
1697
1697
|
async verifyCustomerForPayment(
|
|
1698
1698
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1729,7 +1729,7 @@ class Payment {
|
|
|
1729
1729
|
* @returns {Promise<IfscCodeDetails>} - Success response
|
|
1730
1730
|
* @name verifyIfscCode
|
|
1731
1731
|
* @summary: Verify IFSC
|
|
1732
|
-
* @description: Validate IFSC code and returns bank details if valid. - Check out [method documentation](https://
|
|
1732
|
+
* @description: Validate IFSC code and returns bank details if valid. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/verifyIfscCode/).
|
|
1733
1733
|
*/
|
|
1734
1734
|
async verifyIfscCode(
|
|
1735
1735
|
{ ifscCode, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1767,7 +1767,7 @@ class Payment {
|
|
|
1767
1767
|
* @returns {Promise<AddBeneficiaryViaOtpVerificationDetails>} - Success response
|
|
1768
1768
|
* @name verifyOtpAndAddBeneficiaryForBank
|
|
1769
1769
|
* @summary: Verify OTP for bank and add beneficiary
|
|
1770
|
-
* @description: Verify the OTP provided by the user and adds a bank beneficiary for refund processing. - Check out [method documentation](https://
|
|
1770
|
+
* @description: Verify the OTP provided by the user and adds a bank beneficiary for refund processing. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/verifyOtpAndAddBeneficiaryForBank/).
|
|
1771
1771
|
*/
|
|
1772
1772
|
async verifyOtpAndAddBeneficiaryForBank(
|
|
1773
1773
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1804,7 +1804,7 @@ class Payment {
|
|
|
1804
1804
|
* @returns {Promise<WalletOtpDetails>} - Success response
|
|
1805
1805
|
* @name verifyOtpAndAddBeneficiaryForWallet
|
|
1806
1806
|
* @summary: Verify OTP for wallet
|
|
1807
|
-
* @description: Verify OTP provided by the user and adds a wallet beneficiary. - Check out [method documentation](https://
|
|
1807
|
+
* @description: Verify OTP provided by the user and adds a wallet beneficiary. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/verifyOtpAndAddBeneficiaryForWallet/).
|
|
1808
1808
|
*/
|
|
1809
1809
|
async verifyOtpAndAddBeneficiaryForWallet(
|
|
1810
1810
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1841,7 +1841,7 @@ class Payment {
|
|
|
1841
1841
|
* @returns {Promise<WalletResponseSchema>} - Success response
|
|
1842
1842
|
* @name walletLinkInitiate
|
|
1843
1843
|
* @summary: Initiate linking of wallet
|
|
1844
|
-
* @description: Link wallet for the aggregator for processing of payment. - Check out [method documentation](https://
|
|
1844
|
+
* @description: Link wallet for the aggregator for processing of payment. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/walletLinkInitiate/).
|
|
1845
1845
|
*/
|
|
1846
1846
|
async walletLinkInitiate(
|
|
1847
1847
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -19,7 +19,7 @@ declare class Rewards {
|
|
|
19
19
|
* @returns {Promise<CatalogueOrderDetails>} - Success response
|
|
20
20
|
* @name catalogueOrder
|
|
21
21
|
* @summary: Order from catalogue
|
|
22
|
-
* @description: Place a reward on order items available in the catalogue. - Check out [method documentation](https://
|
|
22
|
+
* @description: Place a reward on order items available in the catalogue. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/rewards/catalogueOrder/).
|
|
23
23
|
*/
|
|
24
24
|
catalogueOrder({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CatalogueOrderDetails>;
|
|
25
25
|
/**
|
|
@@ -28,7 +28,7 @@ declare class Rewards {
|
|
|
28
28
|
* @returns {Promise<Offer>} - Success response
|
|
29
29
|
* @name getOfferByName
|
|
30
30
|
* @summary: Get specific offer
|
|
31
|
-
* @description: Retrieves detailed information about an offer by its name. - Check out [method documentation](https://
|
|
31
|
+
* @description: Retrieves detailed information about an offer by its name. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/rewards/getOfferByName/).
|
|
32
32
|
*/
|
|
33
33
|
getOfferByName({ name, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<Offer>;
|
|
34
34
|
/**
|
|
@@ -37,7 +37,7 @@ declare class Rewards {
|
|
|
37
37
|
* @returns {Promise<OrderDiscountDetails>} - Success response
|
|
38
38
|
* @name getOrderDiscount
|
|
39
39
|
* @summary: Order discount
|
|
40
|
-
* @description: Retrieve the discount applied to a specific order. - Check out [method documentation](https://
|
|
40
|
+
* @description: Retrieve the discount applied to a specific order. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/rewards/getOrderDiscount/).
|
|
41
41
|
*/
|
|
42
42
|
getOrderDiscount({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<OrderDiscountDetails>;
|
|
43
43
|
/**
|
|
@@ -46,7 +46,7 @@ declare class Rewards {
|
|
|
46
46
|
* @returns {Promise<PointsDetails>} - Success response
|
|
47
47
|
* @name getUserPoints
|
|
48
48
|
* @summary: Current points
|
|
49
|
-
* @description: Retrieves the current reward points balance for the user. - Check out [method documentation](https://
|
|
49
|
+
* @description: Retrieves the current reward points balance for the user. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/rewards/getUserPoints/).
|
|
50
50
|
*/
|
|
51
51
|
getUserPoints({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<PointsDetails>;
|
|
52
52
|
/**
|
|
@@ -55,7 +55,7 @@ declare class Rewards {
|
|
|
55
55
|
* @returns {Promise<PointsHistoryDetails>} - Success response
|
|
56
56
|
* @name getUserPointsHistory
|
|
57
57
|
* @summary: Points history
|
|
58
|
-
* @description: Gets the historical data of points earned or spent by the user. - Check out [method documentation](https://
|
|
58
|
+
* @description: Gets the historical data of points earned or spent by the user. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/rewards/getUserPointsHistory/).
|
|
59
59
|
*/
|
|
60
60
|
getUserPointsHistory({ pageId, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<PointsHistoryDetails>;
|
|
61
61
|
/**
|
|
@@ -64,7 +64,7 @@ declare class Rewards {
|
|
|
64
64
|
* @returns {Promise<ReferralDetails>} - Success response
|
|
65
65
|
* @name getUserReferralDetails
|
|
66
66
|
* @summary: Referral details
|
|
67
|
-
* @description: Gets the details of the user’s referral status and codes. - Check out [method documentation](https://
|
|
67
|
+
* @description: Gets the details of the user’s referral status and codes. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/rewards/getUserReferralDetails/).
|
|
68
68
|
*/
|
|
69
69
|
getUserReferralDetails({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ReferralDetails>;
|
|
70
70
|
/**
|
|
@@ -73,7 +73,7 @@ declare class Rewards {
|
|
|
73
73
|
* @returns {Promise<RedeemReferralCodeDetails>} - Success response
|
|
74
74
|
* @name redeemReferralCode
|
|
75
75
|
* @summary: Redeem code
|
|
76
|
-
* @description: Applies a referral code to earn or redeem rewards. - Check out [method documentation](https://
|
|
76
|
+
* @description: Applies a referral code to earn or redeem rewards. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/rewards/redeemReferralCode/).
|
|
77
77
|
*/
|
|
78
78
|
redeemReferralCode({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<RedeemReferralCodeDetails>;
|
|
79
79
|
}
|
|
@@ -47,7 +47,7 @@ class Rewards {
|
|
|
47
47
|
* @returns {Promise<CatalogueOrderDetails>} - Success response
|
|
48
48
|
* @name catalogueOrder
|
|
49
49
|
* @summary: Order from catalogue
|
|
50
|
-
* @description: Place a reward on order items available in the catalogue. - Check out [method documentation](https://
|
|
50
|
+
* @description: Place a reward on order items available in the catalogue. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/rewards/catalogueOrder/).
|
|
51
51
|
*/
|
|
52
52
|
async catalogueOrder(
|
|
53
53
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -84,7 +84,7 @@ class Rewards {
|
|
|
84
84
|
* @returns {Promise<Offer>} - Success response
|
|
85
85
|
* @name getOfferByName
|
|
86
86
|
* @summary: Get specific offer
|
|
87
|
-
* @description: Retrieves detailed information about an offer by its name. - Check out [method documentation](https://
|
|
87
|
+
* @description: Retrieves detailed information about an offer by its name. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/rewards/getOfferByName/).
|
|
88
88
|
*/
|
|
89
89
|
async getOfferByName(
|
|
90
90
|
{ name, requestHeaders } = { requestHeaders: {} },
|
|
@@ -130,7 +130,7 @@ class Rewards {
|
|
|
130
130
|
* @returns {Promise<OrderDiscountDetails>} - Success response
|
|
131
131
|
* @name getOrderDiscount
|
|
132
132
|
* @summary: Order discount
|
|
133
|
-
* @description: Retrieve the discount applied to a specific order. - Check out [method documentation](https://
|
|
133
|
+
* @description: Retrieve the discount applied to a specific order. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/rewards/getOrderDiscount/).
|
|
134
134
|
*/
|
|
135
135
|
async getOrderDiscount(
|
|
136
136
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -167,7 +167,7 @@ class Rewards {
|
|
|
167
167
|
* @returns {Promise<PointsDetails>} - Success response
|
|
168
168
|
* @name getUserPoints
|
|
169
169
|
* @summary: Current points
|
|
170
|
-
* @description: Retrieves the current reward points balance for the user. - Check out [method documentation](https://
|
|
170
|
+
* @description: Retrieves the current reward points balance for the user. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/rewards/getUserPoints/).
|
|
171
171
|
*/
|
|
172
172
|
async getUserPoints(
|
|
173
173
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -204,7 +204,7 @@ class Rewards {
|
|
|
204
204
|
* @returns {Promise<PointsHistoryDetails>} - Success response
|
|
205
205
|
* @name getUserPointsHistory
|
|
206
206
|
* @summary: Points history
|
|
207
|
-
* @description: Gets the historical data of points earned or spent by the user. - Check out [method documentation](https://
|
|
207
|
+
* @description: Gets the historical data of points earned or spent by the user. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/rewards/getUserPointsHistory/).
|
|
208
208
|
*/
|
|
209
209
|
async getUserPointsHistory(
|
|
210
210
|
{ pageId, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
@@ -243,7 +243,7 @@ class Rewards {
|
|
|
243
243
|
* @returns {Promise<ReferralDetails>} - Success response
|
|
244
244
|
* @name getUserReferralDetails
|
|
245
245
|
* @summary: Referral details
|
|
246
|
-
* @description: Gets the details of the user’s referral status and codes. - Check out [method documentation](https://
|
|
246
|
+
* @description: Gets the details of the user’s referral status and codes. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/rewards/getUserReferralDetails/).
|
|
247
247
|
*/
|
|
248
248
|
async getUserReferralDetails(
|
|
249
249
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -280,7 +280,7 @@ class Rewards {
|
|
|
280
280
|
* @returns {Promise<RedeemReferralCodeDetails>} - Success response
|
|
281
281
|
* @name redeemReferralCode
|
|
282
282
|
* @summary: Redeem code
|
|
283
|
-
* @description: Applies a referral code to earn or redeem rewards. - Check out [method documentation](https://
|
|
283
|
+
* @description: Applies a referral code to earn or redeem rewards. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/rewards/redeemReferralCode/).
|
|
284
284
|
*/
|
|
285
285
|
async redeemReferralCode(
|
|
286
286
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -19,7 +19,7 @@ declare class Share {
|
|
|
19
19
|
* @returns {Promise<ShortLinkRes>} - Success response
|
|
20
20
|
* @name createShortLink
|
|
21
21
|
* @summary: Shorten URL
|
|
22
|
-
* @description: Creates a shortened version of a given URL for easier sharing. - Check out [method documentation](https://
|
|
22
|
+
* @description: Creates a shortened version of a given URL for easier sharing. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/share/createShortLink/).
|
|
23
23
|
*/
|
|
24
24
|
createShortLink({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ShortLinkRes>;
|
|
25
25
|
/**
|
|
@@ -28,7 +28,7 @@ declare class Share {
|
|
|
28
28
|
* @returns {Promise<QRCodeResp>} - Success response
|
|
29
29
|
* @name getApplicationQRCode
|
|
30
30
|
* @summary: App QR code
|
|
31
|
-
* @description: Generates a QR code for the application for easy sharing. - Check out [method documentation](https://
|
|
31
|
+
* @description: Generates a QR code for the application for easy sharing. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/share/getApplicationQRCode/).
|
|
32
32
|
*/
|
|
33
33
|
getApplicationQRCode({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<QRCodeResp>;
|
|
34
34
|
/**
|
|
@@ -37,7 +37,7 @@ declare class Share {
|
|
|
37
37
|
* @returns {Promise<QRCodeResp>} - Success response
|
|
38
38
|
* @name getCollectionQRCodeBySlug
|
|
39
39
|
* @summary: Collection QR code
|
|
40
|
-
* @description: Generates a QR code for a specific product collection using its slug. - Check out [method documentation](https://
|
|
40
|
+
* @description: Generates a QR code for a specific product collection using its slug. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/share/getCollectionQRCodeBySlug/).
|
|
41
41
|
*/
|
|
42
42
|
getCollectionQRCodeBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<QRCodeResp>;
|
|
43
43
|
/**
|
|
@@ -46,7 +46,7 @@ declare class Share {
|
|
|
46
46
|
* @returns {Promise<ShortLinkRes>} - Success response
|
|
47
47
|
* @name getOriginalShortLinkByHash
|
|
48
48
|
* @summary: Original URL
|
|
49
|
-
* @description: Retrieve the original link from a short-link by using a hash value. - Check out [method documentation](https://
|
|
49
|
+
* @description: Retrieve the original link from a short-link by using a hash value. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/share/getOriginalShortLinkByHash/).
|
|
50
50
|
*/
|
|
51
51
|
getOriginalShortLinkByHash({ hash, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ShortLinkRes>;
|
|
52
52
|
/**
|
|
@@ -55,7 +55,7 @@ declare class Share {
|
|
|
55
55
|
* @returns {Promise<QRCodeResp>} - Success response
|
|
56
56
|
* @name getProductQRCodeBySlug
|
|
57
57
|
* @summary: Product QR code
|
|
58
|
-
* @description: Creates a QR code for a specific product identified by its slug. - Check out [method documentation](https://
|
|
58
|
+
* @description: Creates a QR code for a specific product identified by its slug. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/share/getProductQRCodeBySlug/).
|
|
59
59
|
*/
|
|
60
60
|
getProductQRCodeBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<QRCodeResp>;
|
|
61
61
|
/**
|
|
@@ -64,7 +64,7 @@ declare class Share {
|
|
|
64
64
|
* @returns {Promise<ShortLinkRes>} - Success response
|
|
65
65
|
* @name getShortLinkByHash
|
|
66
66
|
* @summary: Get short link
|
|
67
|
-
* @description: Retrieves a previously created short link using its hash identifier. - Check out [method documentation](https://
|
|
67
|
+
* @description: Retrieves a previously created short link using its hash identifier. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/share/getShortLinkByHash/).
|
|
68
68
|
*/
|
|
69
69
|
getShortLinkByHash({ hash, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ShortLinkRes>;
|
|
70
70
|
/**
|
|
@@ -73,7 +73,7 @@ declare class Share {
|
|
|
73
73
|
* @returns {Promise<QRCodeResp>} - Success response
|
|
74
74
|
* @name getUrlQRCode
|
|
75
75
|
* @summary: URL to QR code
|
|
76
|
-
* @description: Converts a given URL into a scannable QR code. - Check out [method documentation](https://
|
|
76
|
+
* @description: Converts a given URL into a scannable QR code. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/share/getUrlQRCode/).
|
|
77
77
|
*/
|
|
78
78
|
getUrlQRCode({ url, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<QRCodeResp>;
|
|
79
79
|
}
|