@gofynd/fdk-client-javascript 1.2.0 → 1.3.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 +44 -7
- package/package.json +1 -2
- package/sdk/application/ApplicationAPIClient.d.ts +3 -3
- package/sdk/application/ApplicationAPIClient.js +6 -4
- package/sdk/application/ApplicationClient.d.ts +2 -3
- package/sdk/application/ApplicationClient.js +1 -45
- package/sdk/application/ApplicationConfig.d.ts +46 -6
- package/sdk/application/ApplicationConfig.js +15 -16
- package/sdk/application/Cart/CartApplicationClient.d.ts +61 -33
- package/sdk/application/Cart/CartApplicationClient.js +225 -134
- package/sdk/application/Cart/CartApplicationModel.d.ts +4 -4
- package/sdk/application/Cart/CartApplicationModel.js +4 -4
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +61 -30
- package/sdk/application/Catalog/CatalogApplicationClient.js +234 -146
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +115 -13
- package/sdk/application/Catalog/CatalogApplicationModel.js +77 -12
- package/sdk/application/Common/CommonApplicationClient.d.ts +5 -3
- package/sdk/application/Common/CommonApplicationClient.js +13 -11
- package/sdk/application/Common/CommonApplicationModel.d.ts +3 -83
- package/sdk/application/Common/CommonApplicationModel.js +2 -58
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +9 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +25 -13
- package/sdk/application/Communication/CommunicationApplicationModel.d.ts +1 -34
- package/sdk/application/Communication/CommunicationApplicationModel.js +0 -36
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +46 -16
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +144 -68
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +1 -219
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +0 -226
- package/sdk/application/Content/ContentApplicationClient.d.ts +49 -21
- package/sdk/application/Content/ContentApplicationClient.js +159 -80
- package/sdk/application/Content/ContentApplicationModel.d.ts +5 -622
- package/sdk/application/Content/ContentApplicationModel.js +11 -763
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -3
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +20 -14
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +1 -152
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +0 -180
- package/sdk/application/Lead/LeadApplicationClient.d.ts +14 -7
- package/sdk/application/Lead/LeadApplicationClient.js +50 -31
- package/sdk/application/Lead/LeadApplicationModel.d.ts +22 -741
- package/sdk/application/Lead/LeadApplicationModel.js +21 -481
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +11 -5
- package/sdk/application/Logistic/LogisticApplicationClient.js +41 -20
- package/sdk/application/Order/OrderApplicationClient.d.ts +24 -12
- package/sdk/application/Order/OrderApplicationClient.js +88 -56
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +91 -42
- package/sdk/application/Payment/PaymentApplicationClient.js +293 -194
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +36 -36
- package/sdk/application/Payment/PaymentApplicationModel.js +36 -36
- package/sdk/application/PosCart/PosCartApplicationClient.d.ts +59 -32
- package/sdk/application/PosCart/PosCartApplicationClient.js +214 -130
- package/sdk/application/PosCart/PosCartApplicationModel.d.ts +2 -2
- package/sdk/application/PosCart/PosCartApplicationModel.js +2 -2
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +16 -7
- package/sdk/application/Rewards/RewardsApplicationClient.js +56 -29
- package/sdk/application/Share/ShareApplicationClient.d.ts +15 -7
- package/sdk/application/Share/ShareApplicationClient.js +51 -31
- package/sdk/application/Share/ShareApplicationModel.d.ts +1 -33
- package/sdk/application/Share/ShareApplicationModel.js +0 -38
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +9 -4
- package/sdk/application/Theme/ThemeApplicationClient.js +35 -18
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +982 -312
- package/sdk/application/Theme/ThemeApplicationModel.js +621 -284
- package/sdk/application/User/UserApplicationClient.d.ts +74 -35
- package/sdk/application/User/UserApplicationClient.js +252 -161
- package/sdk/application/User/UserApplicationModel.d.ts +3 -401
- package/sdk/application/User/UserApplicationModel.js +2 -490
- package/sdk/common/AxiosHelper.js +1 -2
- package/sdk/common/FDKError.d.ts +3 -0
- package/sdk/common/FDKError.js +8 -0
- package/sdk/common/utils.d.ts +3 -0
- package/sdk/common/utils.js +29 -0
- package/sdk/partner/PartnerAPIClient.d.ts +5 -4
- package/sdk/partner/PartnerAPIClient.js +7 -4
- package/sdk/partner/PartnerClient.d.ts +2 -0
- package/sdk/partner/PartnerClient.js +3 -0
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +299 -0
- package/sdk/partner/Theme/ThemePartnerClient.js +768 -0
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +1706 -0
- package/sdk/partner/Theme/ThemePartnerModel.js +1409 -0
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +22 -0
- package/sdk/partner/Theme/ThemePartnerValidator.js +157 -0
- package/sdk/partner/index.d.ts +3 -1
- package/sdk/partner/index.js +3 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +8 -4
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +38 -16
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +1 -13
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +0 -12
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +10 -0
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +4 -0
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +59 -14
- package/sdk/platform/Billing/BillingPlatformClient.js +315 -64
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +56 -196
- package/sdk/platform/Billing/BillingPlatformModel.js +63 -217
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +23 -1
- package/sdk/platform/Billing/BillingPlatformValidator.js +31 -0
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +124 -63
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +431 -265
- package/sdk/platform/Cart/CartPlatformModel.d.ts +253 -53
- package/sdk/platform/Cart/CartPlatformModel.js +104 -54
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +120 -53
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +398 -247
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +155 -78
- package/sdk/platform/Catalog/CatalogPlatformClient.js +561 -355
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +10 -12
- package/sdk/platform/Catalog/CatalogPlatformModel.js +10 -12
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +30 -0
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +13 -0
- package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -3
- package/sdk/platform/Common/CommonPlatformClient.js +13 -11
- package/sdk/platform/Common/CommonPlatformModel.d.ts +39 -64
- package/sdk/platform/Common/CommonPlatformModel.js +23 -57
- package/sdk/platform/Common/CommonPlatformValidator.d.ts +5 -10
- package/sdk/platform/Common/CommonPlatformValidator.js +3 -4
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +370 -120
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +2328 -888
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +143 -24
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +179 -15
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +2 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +6 -5
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +386 -308
- package/sdk/platform/Communication/CommunicationPlatformModel.js +415 -355
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +38 -13
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +171 -57
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +53 -1
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +54 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +5 -1
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +7 -0
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +96 -29
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +311 -126
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +5 -1
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +7 -0
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +36 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +121 -86
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +13 -180
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +5 -113
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +162 -70
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +528 -309
- package/sdk/platform/Content/ContentPlatformModel.d.ts +9 -198
- package/sdk/platform/Content/ContentPlatformModel.js +8 -231
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +48 -11
- package/sdk/platform/Discount/DiscountPlatformClient.js +142 -48
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +40 -1
- package/sdk/platform/Discount/DiscountPlatformModel.js +27 -0
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +84 -18
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +486 -53
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +71 -7
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +81 -5
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +13 -18
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +58 -65
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +198 -71
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +212 -64
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +18 -10
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +11 -6
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +177 -40
- package/sdk/platform/Finance/FinancePlatformClient.js +1028 -132
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +670 -22
- package/sdk/platform/Finance/FinancePlatformModel.js +809 -23
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +111 -1
- package/sdk/platform/Finance/FinancePlatformValidator.js +134 -0
- package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +24 -12
- package/sdk/platform/Inventory/InventoryPlatformClient.js +94 -52
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +27 -13
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +101 -55
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +50 -39
- package/sdk/platform/Lead/LeadPlatformClient.js +171 -112
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +32 -390
- package/sdk/platform/Lead/LeadPlatformModel.js +31 -214
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +33 -33
- package/sdk/platform/Lead/LeadPlatformValidator.js +23 -23
- package/sdk/platform/OAuthClient.js +6 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +4 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +12 -10
- package/sdk/platform/Order/OrderPlatformClient.d.ts +165 -71
- package/sdk/platform/Order/OrderPlatformClient.js +738 -205
- package/sdk/platform/Order/OrderPlatformModel.d.ts +261 -3
- package/sdk/platform/Order/OrderPlatformModel.js +225 -2
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +104 -3
- package/sdk/platform/Order/OrderPlatformValidator.js +85 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -22
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +12 -159
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +1 -30
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +0 -26
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +1 -690
- package/sdk/platform/Partner/PartnerPlatformModel.js +0 -809
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +167 -32
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +793 -145
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +91 -1
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +91 -0
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -10
- package/sdk/platform/Payment/PaymentPlatformClient.js +68 -47
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +549 -7
- package/sdk/platform/Payment/PaymentPlatformModel.js +305 -6
- package/sdk/platform/PlatformAPIClient.d.ts +3 -3
- package/sdk/platform/PlatformAPIClient.js +2 -2
- package/sdk/platform/PlatformClient.d.ts +2 -2
- package/sdk/platform/PlatformClient.js +4 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +28 -12
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +90 -53
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +1 -12
- package/sdk/platform/Rewards/RewardsPlatformModel.js +0 -14
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +62 -26
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +210 -93
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +20 -11
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +23 -11
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +36 -18
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +142 -78
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +12 -3
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +14 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +10 -26
- package/sdk/platform/Share/SharePlatformApplicationClient.js +36 -67
- package/sdk/platform/Share/SharePlatformModel.d.ts +4 -4
- package/sdk/platform/Share/SharePlatformModel.js +4 -4
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +127 -57
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +564 -189
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +63 -26
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +62 -22
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +37 -0
- package/sdk/platform/Theme/ThemePlatformClient.js +235 -0
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +1167 -261
- package/sdk/platform/Theme/ThemePlatformModel.js +801 -244
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +32 -0
- package/sdk/platform/Theme/ThemePlatformValidator.js +38 -0
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +35 -17
- package/sdk/platform/User/UserPlatformApplicationClient.js +132 -73
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +7 -0
- package/sdk/platform/User/UserPlatformApplicationValidator.js +3 -0
- package/sdk/platform/User/UserPlatformModel.d.ts +1 -738
- package/sdk/platform/User/UserPlatformModel.js +3 -899
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +120 -7
- package/sdk/platform/Webhook/WebhookPlatformClient.js +799 -41
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +476 -86
- package/sdk/platform/Webhook/WebhookPlatformModel.js +388 -89
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +96 -9
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +117 -5
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +5 -3
- package/sdk/public/Configuration/ConfigurationPublicClient.js +13 -11
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +3 -106
- package/sdk/public/Configuration/ConfigurationPublicModel.js +2 -59
- package/sdk/public/Inventory/InventoryPublicClient.d.ts +12 -6
- package/sdk/public/Inventory/InventoryPublicClient.js +42 -27
- package/sdk/public/Partner/PartnerPublicClient.d.ts +22 -0
- package/sdk/public/Partner/PartnerPublicClient.js +110 -0
- package/sdk/public/Partner/PartnerPublicModel.d.ts +240 -0
- package/sdk/public/Partner/PartnerPublicModel.js +280 -0
- package/sdk/public/Partner/PartnerPublicValidator.d.ts +18 -0
- package/sdk/public/Partner/PartnerPublicValidator.js +19 -0
- package/sdk/public/PublicAPIClient.d.ts +14 -1
- package/sdk/public/PublicAPIClient.js +7 -1
- package/sdk/public/PublicClient.d.ts +2 -0
- package/sdk/public/PublicClient.js +4 -0
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +5 -2
- package/sdk/public/Webhook/WebhookPublicClient.js +15 -9
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +1 -191
- package/sdk/public/Webhook/WebhookPublicModel.js +0 -229
- package/sdk/public/index.d.ts +1 -0
- package/sdk/public/index.js +2 -0
- package/sdk/application/ApplicationModels.d.ts +0 -48
- package/sdk/application/ApplicationModels.js +0 -38
- package/sdk/platform/Partner/PartnerPlatformClient.d.ts +0 -106
- package/sdk/platform/Partner/PartnerPlatformClient.js +0 -878
- package/sdk/platform/Partner/PartnerPlatformValidator.d.ts +0 -208
- package/sdk/platform/Partner/PartnerPlatformValidator.js +0 -169
|
@@ -5,28 +5,31 @@ declare class Payment {
|
|
|
5
5
|
applicationId: any;
|
|
6
6
|
/**
|
|
7
7
|
* @param {PaymentPlatformApplicationValidator.AddEdcDeviceParam} arg - Arg object
|
|
8
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
8
9
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
9
10
|
* @returns {Promise<PaymentPlatformModel.EdcDeviceUpdateResponse>} - Success response
|
|
10
11
|
* @name addEdcDevice
|
|
11
12
|
* @summary: Update store id and device tag of edc device
|
|
12
13
|
* @description: Use this API to Update store id and device tag of edc device - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/addEdcDevice/).
|
|
13
14
|
*/
|
|
14
|
-
addEdcDevice({ terminalUniqueIdentifier, body }?: PaymentPlatformApplicationValidator.AddEdcDeviceParam, {
|
|
15
|
+
addEdcDevice({ terminalUniqueIdentifier, body, requestHeaders }?: PaymentPlatformApplicationValidator.AddEdcDeviceParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.EdcDeviceUpdateResponse>;
|
|
15
16
|
/**
|
|
16
17
|
* @param {PaymentPlatformApplicationValidator.AddRefundBankAccountUsingOTPParam} arg
|
|
17
18
|
* - Arg object
|
|
18
19
|
*
|
|
20
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
19
21
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
20
22
|
* @returns {Promise<PaymentPlatformModel.RefundAccountResponse>} - Success response
|
|
21
23
|
* @name addRefundBankAccountUsingOTP
|
|
22
24
|
* @summary: Save bank details for cancelled/returned order
|
|
23
25
|
* @description: Use this API to save bank details for returned/cancelled order to refund amount in his account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/addRefundBankAccountUsingOTP/).
|
|
24
26
|
*/
|
|
25
|
-
addRefundBankAccountUsingOTP({ body }?: PaymentPlatformApplicationValidator.AddRefundBankAccountUsingOTPParam, {
|
|
27
|
+
addRefundBankAccountUsingOTP({ body, requestHeaders }?: PaymentPlatformApplicationValidator.AddRefundBankAccountUsingOTPParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.RefundAccountResponse>;
|
|
26
28
|
/**
|
|
27
29
|
* @param {PaymentPlatformApplicationValidator.CancelPaymentLinkParam} arg
|
|
28
30
|
* - Arg object
|
|
29
31
|
*
|
|
32
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
30
33
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
31
34
|
* @returns {Promise<PaymentPlatformModel.CancelPaymentLinkResponse>} -
|
|
32
35
|
* Success response
|
|
@@ -34,11 +37,12 @@ declare class Payment {
|
|
|
34
37
|
* @summary: Cancel payment link
|
|
35
38
|
* @description: Use this API to cancel a payment link for the customer - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/cancelPaymentLink/).
|
|
36
39
|
*/
|
|
37
|
-
cancelPaymentLink({ body }?: PaymentPlatformApplicationValidator.CancelPaymentLinkParam, {
|
|
40
|
+
cancelPaymentLink({ body, requestHeaders }?: PaymentPlatformApplicationValidator.CancelPaymentLinkParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.CancelPaymentLinkResponse>;
|
|
38
41
|
/**
|
|
39
42
|
* @param {PaymentPlatformApplicationValidator.CheckAndUpdatePaymentStatusParam} arg
|
|
40
43
|
* - Arg object
|
|
41
44
|
*
|
|
45
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
42
46
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
43
47
|
* @returns {Promise<PaymentPlatformModel.PaymentStatusUpdateResponse>} -
|
|
44
48
|
* Success response
|
|
@@ -46,9 +50,10 @@ declare class Payment {
|
|
|
46
50
|
* @summary: Performs continuous polling to check status of payment on the server
|
|
47
51
|
* @description: Use this API to perform continuous polling at intervals to check the status of payment until timeout. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/checkAndUpdatePaymentStatus/).
|
|
48
52
|
*/
|
|
49
|
-
checkAndUpdatePaymentStatus({ body }?: PaymentPlatformApplicationValidator.CheckAndUpdatePaymentStatusParam, {
|
|
53
|
+
checkAndUpdatePaymentStatus({ body, requestHeaders }?: PaymentPlatformApplicationValidator.CheckAndUpdatePaymentStatusParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentStatusUpdateResponse>;
|
|
50
54
|
/**
|
|
51
55
|
* @param {PaymentPlatformApplicationValidator.ConfirmPaymentParam} arg - Arg object
|
|
56
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
52
57
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
53
58
|
* @returns {Promise<PaymentPlatformModel.PaymentConfirmationResponse>} -
|
|
54
59
|
* Success response
|
|
@@ -56,11 +61,12 @@ declare class Payment {
|
|
|
56
61
|
* @summary: Confirm payment after successful payment from payment gateway
|
|
57
62
|
* @description: Use this API to confirm payment after payment gateway accepted payment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/confirmPayment/).
|
|
58
63
|
*/
|
|
59
|
-
confirmPayment({ body }?: PaymentPlatformApplicationValidator.ConfirmPaymentParam, {
|
|
64
|
+
confirmPayment({ body, requestHeaders }?: PaymentPlatformApplicationValidator.ConfirmPaymentParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentConfirmationResponse>;
|
|
60
65
|
/**
|
|
61
66
|
* @param {PaymentPlatformApplicationValidator.CreatePaymentLinkParam} arg
|
|
62
67
|
* - Arg object
|
|
63
68
|
*
|
|
69
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
64
70
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
65
71
|
* @returns {Promise<PaymentPlatformModel.CreatePaymentLinkResponse>} -
|
|
66
72
|
* Success response
|
|
@@ -68,8 +74,12 @@ declare class Payment {
|
|
|
68
74
|
* @summary: Create payment link
|
|
69
75
|
* @description: Use this API to create a payment link for the customer - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/createPaymentLink/).
|
|
70
76
|
*/
|
|
71
|
-
createPaymentLink({ body }?: PaymentPlatformApplicationValidator.CreatePaymentLinkParam, {
|
|
77
|
+
createPaymentLink({ body, requestHeaders }?: PaymentPlatformApplicationValidator.CreatePaymentLinkParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.CreatePaymentLinkResponse>;
|
|
72
78
|
/**
|
|
79
|
+
* @param {PaymentPlatformApplicationValidator.EdcAggregatorsAndModelListParam} arg
|
|
80
|
+
* - Arg object
|
|
81
|
+
*
|
|
82
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
73
83
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
74
84
|
* @returns {Promise<PaymentPlatformModel.EdcAggregatorAndModelListResponse>}
|
|
75
85
|
* - Success response
|
|
@@ -78,36 +88,44 @@ declare class Payment {
|
|
|
78
88
|
* @summary: get some information about the store and edc device
|
|
79
89
|
* @description: Use this API to get info of devices linked to a particular app. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/edcAggregatorsAndModelList/).
|
|
80
90
|
*/
|
|
81
|
-
edcAggregatorsAndModelList({
|
|
91
|
+
edcAggregatorsAndModelList({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentPlatformModel.EdcAggregatorAndModelListResponse>;
|
|
82
92
|
/**
|
|
83
93
|
* @param {PaymentPlatformApplicationValidator.EdcDeviceListParam} arg - Arg object
|
|
94
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
84
95
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
85
96
|
* @returns {Promise<PaymentPlatformModel.EdcDeviceListResponse>} - Success response
|
|
86
97
|
* @name edcDeviceList
|
|
87
98
|
* @summary: get all the device list of an app
|
|
88
99
|
* @description: Use this API to get all devices linked to a particular app. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/edcDeviceList/).
|
|
89
100
|
*/
|
|
90
|
-
edcDeviceList({ pageNo, pageSize, isActive, storeId, deviceTag }?: PaymentPlatformApplicationValidator.EdcDeviceListParam, {
|
|
101
|
+
edcDeviceList({ pageNo, pageSize, isActive, storeId, deviceTag, requestHeaders }?: PaymentPlatformApplicationValidator.EdcDeviceListParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.EdcDeviceListResponse>;
|
|
91
102
|
/**
|
|
103
|
+
* @param {PaymentPlatformApplicationValidator.EdcDeviceStatsParam} arg - Arg object
|
|
104
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
92
105
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
93
106
|
* @returns {Promise<PaymentPlatformModel.EdcDeviceStatsResponse>} - Success response
|
|
94
107
|
* @name edcDeviceStats
|
|
95
108
|
* @summary: get some information about the store and edc device
|
|
96
109
|
* @description: Use this API to get info of devices linked to a particular app. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/edcDeviceStats/).
|
|
97
110
|
*/
|
|
98
|
-
edcDeviceStats({
|
|
111
|
+
edcDeviceStats({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentPlatformModel.EdcDeviceStatsResponse>;
|
|
99
112
|
/**
|
|
100
113
|
* @param {PaymentPlatformApplicationValidator.GetBankAccountDetailsOpenAPIParam} arg
|
|
101
114
|
* - Arg object
|
|
102
115
|
*
|
|
116
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
103
117
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
104
118
|
* @returns {Promise<PaymentPlatformModel.RefundAccountResponse>} - Success response
|
|
105
119
|
* @name getBankAccountDetailsOpenAPI
|
|
106
120
|
* @summary: Get bank details
|
|
107
121
|
* @description: Use this API to get saved bank details for returned/cancelled order using order id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getBankAccountDetailsOpenAPI/).
|
|
108
122
|
*/
|
|
109
|
-
getBankAccountDetailsOpenAPI({ orderId, requestHash }?: PaymentPlatformApplicationValidator.GetBankAccountDetailsOpenAPIParam, {
|
|
123
|
+
getBankAccountDetailsOpenAPI({ orderId, requestHash, requestHeaders }?: PaymentPlatformApplicationValidator.GetBankAccountDetailsOpenAPIParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.RefundAccountResponse>;
|
|
110
124
|
/**
|
|
125
|
+
* @param {PaymentPlatformApplicationValidator.GetBrandPaymentGatewayConfigParam} arg
|
|
126
|
+
* - Arg object
|
|
127
|
+
*
|
|
128
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
111
129
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
112
130
|
* @returns {Promise<PaymentPlatformModel.PaymentGatewayConfigResponse>} -
|
|
113
131
|
* Success response
|
|
@@ -115,9 +133,10 @@ declare class Payment {
|
|
|
115
133
|
* @summary: Get All Brand Payment Gateway Config Secret
|
|
116
134
|
* @description: Get All Brand Payment Gateway Config Secret - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getBrandPaymentGatewayConfig/).
|
|
117
135
|
*/
|
|
118
|
-
getBrandPaymentGatewayConfig({
|
|
136
|
+
getBrandPaymentGatewayConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentGatewayConfigResponse>;
|
|
119
137
|
/**
|
|
120
138
|
* @param {PaymentPlatformApplicationValidator.GetEdcDeviceParam} arg - Arg object
|
|
139
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
121
140
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
122
141
|
* @returns {Promise<PaymentPlatformModel.EdcDeviceDetailsResponse>} -
|
|
123
142
|
* Success response
|
|
@@ -125,50 +144,97 @@ declare class Payment {
|
|
|
125
144
|
* @summary: get details of a single edc device
|
|
126
145
|
* @description: Use this API to get details of a single edc device - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getEdcDevice/).
|
|
127
146
|
*/
|
|
128
|
-
getEdcDevice({ terminalUniqueIdentifier }?: PaymentPlatformApplicationValidator.GetEdcDeviceParam, {
|
|
147
|
+
getEdcDevice({ terminalUniqueIdentifier, requestHeaders }?: PaymentPlatformApplicationValidator.GetEdcDeviceParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.EdcDeviceDetailsResponse>;
|
|
129
148
|
/**
|
|
149
|
+
* @param {PaymentPlatformApplicationValidator.GetMerchantAggregatorPaymentModeDetailsParam} arg
|
|
150
|
+
* - Arg object
|
|
151
|
+
*
|
|
152
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
153
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
154
|
+
* @returns {Promise<PaymentPlatformModel.MerchnatPaymentModeResponse>} -
|
|
155
|
+
* Success response
|
|
156
|
+
* @name getMerchantAggregatorPaymentModeDetails
|
|
157
|
+
* @summary: Get Aggregator, payment mode and sub payment mode.
|
|
158
|
+
* @description: Get Aggregator, payment mode and sub payment mode details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getMerchantAggregatorPaymentModeDetails/).
|
|
159
|
+
*/
|
|
160
|
+
getMerchantAggregatorPaymentModeDetails({ aggregatorId, businessUnit, device, requestHeaders }?: PaymentPlatformApplicationValidator.GetMerchantAggregatorPaymentModeDetailsParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.MerchnatPaymentModeResponse>;
|
|
161
|
+
/**
|
|
162
|
+
* @param {PaymentPlatformApplicationValidator.GetMerchantPaymentOptionParam} arg
|
|
163
|
+
* - Arg object
|
|
164
|
+
*
|
|
165
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
166
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
167
|
+
* @returns {Promise<PaymentPlatformModel.MerchnatPaymentModeResponse>} -
|
|
168
|
+
* Success response
|
|
169
|
+
* @name getMerchantPaymentOption
|
|
170
|
+
* @summary: Get Payment modes and COD details.
|
|
171
|
+
* @description: This api fetches all the available PGs for merchant and its offline payment mode details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getMerchantPaymentOption/).
|
|
172
|
+
*/
|
|
173
|
+
getMerchantPaymentOption({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentPlatformModel.MerchnatPaymentModeResponse>;
|
|
174
|
+
/**
|
|
175
|
+
* @param {PaymentPlatformApplicationValidator.GetPGConfigAggregatorsParam} arg
|
|
176
|
+
* - Arg object
|
|
177
|
+
*
|
|
178
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
179
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
180
|
+
* @returns {Promise<PaymentPlatformModel.MerchnatPaymentModeResponse>} -
|
|
181
|
+
* Success response
|
|
182
|
+
* @name getPGConfigAggregators
|
|
183
|
+
* @summary: Get Aggregators available to be added as PG.
|
|
184
|
+
* @description: Get Aggregators available to be added as PG. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getPGConfigAggregators/).
|
|
185
|
+
*/
|
|
186
|
+
getPGConfigAggregators({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentPlatformModel.MerchnatPaymentModeResponse>;
|
|
187
|
+
/**
|
|
188
|
+
* @param {PaymentPlatformApplicationValidator.GetPaymentCodeOptionParam} arg
|
|
189
|
+
* - Arg object
|
|
190
|
+
*
|
|
191
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
130
192
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
131
193
|
* @returns {Promise<PaymentPlatformModel.GetPaymentCodeResponse>} - Success response
|
|
132
194
|
* @name getPaymentCodeOption
|
|
133
195
|
* @summary: List Payment Options Method Codes
|
|
134
196
|
* @description: Get all active List Payment Options Method Codes - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getPaymentCodeOption/).
|
|
135
197
|
*/
|
|
136
|
-
getPaymentCodeOption({
|
|
198
|
+
getPaymentCodeOption({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentPlatformModel.GetPaymentCodeResponse>;
|
|
137
199
|
/**
|
|
138
200
|
* @param {PaymentPlatformApplicationValidator.GetPaymentLinkParam} arg - Arg object
|
|
201
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
139
202
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
140
203
|
* @returns {Promise<PaymentPlatformModel.GetPaymentLinkResponse>} - Success response
|
|
141
204
|
* @name getPaymentLink
|
|
142
205
|
* @summary: Get payment link
|
|
143
206
|
* @description: Use this API to get a payment link - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getPaymentLink/).
|
|
144
207
|
*/
|
|
145
|
-
getPaymentLink({ paymentLinkId }?: PaymentPlatformApplicationValidator.GetPaymentLinkParam, {
|
|
208
|
+
getPaymentLink({ paymentLinkId, requestHeaders }?: PaymentPlatformApplicationValidator.GetPaymentLinkParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.GetPaymentLinkResponse>;
|
|
146
209
|
/**
|
|
147
210
|
* @param {PaymentPlatformApplicationValidator.GetPaymentModeRoutesParam} arg
|
|
148
211
|
* - Arg object
|
|
149
212
|
*
|
|
213
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
150
214
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
151
215
|
* @returns {Promise<PaymentPlatformModel.PaymentOptionsResponse>} - Success response
|
|
152
216
|
* @name getPaymentModeRoutes
|
|
153
217
|
* @summary: Get All Valid Payment Options
|
|
154
218
|
* @description: Use this API to get Get All Valid Payment Options for making payment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getPaymentModeRoutes/).
|
|
155
219
|
*/
|
|
156
|
-
getPaymentModeRoutes({ refresh, requestType }?: PaymentPlatformApplicationValidator.GetPaymentModeRoutesParam, {
|
|
220
|
+
getPaymentModeRoutes({ refresh, requestType, requestHeaders }?: PaymentPlatformApplicationValidator.GetPaymentModeRoutesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentOptionsResponse>;
|
|
157
221
|
/**
|
|
158
222
|
* @param {PaymentPlatformApplicationValidator.GetPosPaymentModeRoutesParam} arg
|
|
159
223
|
* - Arg object
|
|
160
224
|
*
|
|
225
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
161
226
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
162
227
|
* @returns {Promise<PaymentPlatformModel.PaymentOptionsResponse>} - Success response
|
|
163
228
|
* @name getPosPaymentModeRoutes
|
|
164
229
|
* @summary: Get All Valid Payment Options
|
|
165
230
|
* @description: Use this API to get Get All Valid Payment Options for making payment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getPosPaymentModeRoutes/).
|
|
166
231
|
*/
|
|
167
|
-
getPosPaymentModeRoutes({ amount, cartId, pincode, checkoutMode, orderType, refresh, cardReference, userDetails, }?: PaymentPlatformApplicationValidator.GetPosPaymentModeRoutesParam, {
|
|
232
|
+
getPosPaymentModeRoutes({ amount, cartId, pincode, checkoutMode, orderType, refresh, cardReference, userDetails, requestHeaders, }?: PaymentPlatformApplicationValidator.GetPosPaymentModeRoutesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentOptionsResponse>;
|
|
168
233
|
/**
|
|
169
234
|
* @param {PaymentPlatformApplicationValidator.GetUserBeneficiariesParam} arg
|
|
170
235
|
* - Arg object
|
|
171
236
|
*
|
|
237
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
172
238
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
173
239
|
* @returns {Promise<PaymentPlatformModel.OrderBeneficiaryResponse>} -
|
|
174
240
|
* Success response
|
|
@@ -176,22 +242,24 @@ declare class Payment {
|
|
|
176
242
|
* @summary: List User Beneficiary
|
|
177
243
|
* @description: Get all active beneficiary details added by the user for refund - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getUserBeneficiaries/).
|
|
178
244
|
*/
|
|
179
|
-
getUserBeneficiaries({ orderId }?: PaymentPlatformApplicationValidator.GetUserBeneficiariesParam, {
|
|
245
|
+
getUserBeneficiaries({ orderId, requestHeaders }?: PaymentPlatformApplicationValidator.GetUserBeneficiariesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.OrderBeneficiaryResponse>;
|
|
180
246
|
/**
|
|
181
247
|
* @param {PaymentPlatformApplicationValidator.GetUserCODlimitRoutesParam} arg
|
|
182
248
|
* - Arg object
|
|
183
249
|
*
|
|
250
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
184
251
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
185
252
|
* @returns {Promise<PaymentPlatformModel.GetUserCODLimitResponse>} - Success response
|
|
186
253
|
* @name getUserCODlimitRoutes
|
|
187
254
|
* @summary: Get COD limit for user
|
|
188
255
|
* @description: Use this API to get user cod limit and reamining limit for the payment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getUserCODlimitRoutes/).
|
|
189
256
|
*/
|
|
190
|
-
getUserCODlimitRoutes({ merchantUserId, mobileNo }?: PaymentPlatformApplicationValidator.GetUserCODlimitRoutesParam, {
|
|
257
|
+
getUserCODlimitRoutes({ merchantUserId, mobileNo, requestHeaders }?: PaymentPlatformApplicationValidator.GetUserCODlimitRoutesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.GetUserCODLimitResponse>;
|
|
191
258
|
/**
|
|
192
259
|
* @param {PaymentPlatformApplicationValidator.GetUserOrderBeneficiariesParam} arg
|
|
193
260
|
* - Arg object
|
|
194
261
|
*
|
|
262
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
195
263
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
196
264
|
* @returns {Promise<PaymentPlatformModel.OrderBeneficiaryResponse>} -
|
|
197
265
|
* Success response
|
|
@@ -199,11 +267,12 @@ declare class Payment {
|
|
|
199
267
|
* @summary: List Order Beneficiary
|
|
200
268
|
* @description: Get all active beneficiary details added by the user for refund - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getUserOrderBeneficiaries/).
|
|
201
269
|
*/
|
|
202
|
-
getUserOrderBeneficiaries({ orderId }?: PaymentPlatformApplicationValidator.GetUserOrderBeneficiariesParam, {
|
|
270
|
+
getUserOrderBeneficiaries({ orderId, requestHeaders }?: PaymentPlatformApplicationValidator.GetUserOrderBeneficiariesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.OrderBeneficiaryResponse>;
|
|
203
271
|
/**
|
|
204
272
|
* @param {PaymentPlatformApplicationValidator.InitialisePaymentParam} arg
|
|
205
273
|
* - Arg object
|
|
206
274
|
*
|
|
275
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
207
276
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
208
277
|
* @returns {Promise<PaymentPlatformModel.PaymentInitializationResponse>} -
|
|
209
278
|
* Success response
|
|
@@ -211,11 +280,12 @@ declare class Payment {
|
|
|
211
280
|
* @summary: Initialize a payment (server-to-server) for UPI and BharatQR
|
|
212
281
|
* @description: PUse this API to inititate payment using UPI, BharatQR, wherein the UPI requests are send to the app and QR code is displayed on the screen. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/initialisePayment/).
|
|
213
282
|
*/
|
|
214
|
-
initialisePayment({ body }?: PaymentPlatformApplicationValidator.InitialisePaymentParam, {
|
|
283
|
+
initialisePayment({ body, requestHeaders }?: PaymentPlatformApplicationValidator.InitialisePaymentParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentInitializationResponse>;
|
|
215
284
|
/**
|
|
216
285
|
* @param {PaymentPlatformApplicationValidator.MerchantOnBoardingParam} arg
|
|
217
286
|
* - Arg object
|
|
218
287
|
*
|
|
288
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
219
289
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
220
290
|
* @returns {Promise<PaymentPlatformModel.MerchantOnBoardingResponse>} -
|
|
221
291
|
* Success response
|
|
@@ -223,20 +293,48 @@ declare class Payment {
|
|
|
223
293
|
* @summary: API to push Ajiodhan merchant data to Gringotts system
|
|
224
294
|
* @description: Use this API to push Ajiodhan merchant data to Gringotts system - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/merchantOnBoarding/).
|
|
225
295
|
*/
|
|
226
|
-
merchantOnBoarding({ body }?: PaymentPlatformApplicationValidator.MerchantOnBoardingParam, {
|
|
296
|
+
merchantOnBoarding({ body, requestHeaders }?: PaymentPlatformApplicationValidator.MerchantOnBoardingParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.MerchantOnBoardingResponse>;
|
|
227
297
|
/**
|
|
228
298
|
* @param {PaymentPlatformApplicationValidator.OauthGetUrlParam} arg - Arg object
|
|
299
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
229
300
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
230
301
|
* @returns {Promise<PaymentPlatformModel.GetOauthUrlResponse>} - Success response
|
|
231
302
|
* @name oauthGetUrl
|
|
232
303
|
* @summary: API to Get the url to call for oauth
|
|
233
304
|
* @description: Use this API to Get the url to call for oauth. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/oauthGetUrl/).
|
|
234
305
|
*/
|
|
235
|
-
oauthGetUrl({ aggregator, successRedirectUrl, failureRedirectUrl }?: PaymentPlatformApplicationValidator.OauthGetUrlParam, {
|
|
306
|
+
oauthGetUrl({ aggregator, successRedirectUrl, failureRedirectUrl, requestHeaders }?: PaymentPlatformApplicationValidator.OauthGetUrlParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.GetOauthUrlResponse>;
|
|
307
|
+
/**
|
|
308
|
+
* @param {PaymentPlatformApplicationValidator.PatchMerchantAggregatorPaymentModeDetailsParam} arg
|
|
309
|
+
* - Arg object
|
|
310
|
+
*
|
|
311
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
312
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
313
|
+
* @returns {Promise<PaymentPlatformModel.MerchnatPaymentModeResponse>} -
|
|
314
|
+
* Success response
|
|
315
|
+
* @name patchMerchantAggregatorPaymentModeDetails
|
|
316
|
+
* @summary: Update Aggregator, payment mode and sub payment mode.
|
|
317
|
+
* @description: Update Aggregator, payment mode and sub payment mode details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/patchMerchantAggregatorPaymentModeDetails/).
|
|
318
|
+
*/
|
|
319
|
+
patchMerchantAggregatorPaymentModeDetails({ aggregatorId, body, requestHeaders }?: PaymentPlatformApplicationValidator.PatchMerchantAggregatorPaymentModeDetailsParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.MerchnatPaymentModeResponse>;
|
|
320
|
+
/**
|
|
321
|
+
* @param {PaymentPlatformApplicationValidator.PatchMerchantPaymentOptionParam} arg
|
|
322
|
+
* - Arg object
|
|
323
|
+
*
|
|
324
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
325
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
326
|
+
* @returns {Promise<PaymentPlatformModel.MerchnatPaymentModeResponse>} -
|
|
327
|
+
* Success response
|
|
328
|
+
* @name patchMerchantPaymentOption
|
|
329
|
+
* @summary: Update Payment modes and COD details.
|
|
330
|
+
* @description: To updated online payment as active/inactive or offline payment configuration like cod charges, anonymous cod allowed flags. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/patchMerchantPaymentOption/).
|
|
331
|
+
*/
|
|
332
|
+
patchMerchantPaymentOption({ body, requestHeaders }?: PaymentPlatformApplicationValidator.PatchMerchantPaymentOptionParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.MerchnatPaymentModeResponse>;
|
|
236
333
|
/**
|
|
237
334
|
* @param {PaymentPlatformApplicationValidator.PaymentStatusBulkParam} arg
|
|
238
335
|
* - Arg object
|
|
239
336
|
*
|
|
337
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
240
338
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
241
339
|
* @returns {Promise<PaymentPlatformModel.PaymentStatusBulkHandlerResponse>}
|
|
242
340
|
* - Success response
|
|
@@ -245,11 +343,12 @@ declare class Payment {
|
|
|
245
343
|
* @summary: Get Payment status and information for a list of order_ids
|
|
246
344
|
* @description: Use this API to get Payment status and information for a list of order_ids - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/paymentStatusBulk/).
|
|
247
345
|
*/
|
|
248
|
-
paymentStatusBulk({ body }?: PaymentPlatformApplicationValidator.PaymentStatusBulkParam, {
|
|
346
|
+
paymentStatusBulk({ body, requestHeaders }?: PaymentPlatformApplicationValidator.PaymentStatusBulkParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentStatusBulkHandlerResponse>;
|
|
249
347
|
/**
|
|
250
348
|
* @param {PaymentPlatformApplicationValidator.PollingPaymentLinkParam} arg
|
|
251
349
|
* - Arg object
|
|
252
350
|
*
|
|
351
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
253
352
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
254
353
|
* @returns {Promise<PaymentPlatformModel.PollingPaymentLinkResponse>} -
|
|
255
354
|
* Success response
|
|
@@ -257,20 +356,22 @@ declare class Payment {
|
|
|
257
356
|
* @summary: Used for polling if payment successful or not
|
|
258
357
|
* @description: Use this API to poll if payment through payment was successful or not - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/pollingPaymentLink/).
|
|
259
358
|
*/
|
|
260
|
-
pollingPaymentLink({ paymentLinkId }?: PaymentPlatformApplicationValidator.PollingPaymentLinkParam, {
|
|
359
|
+
pollingPaymentLink({ paymentLinkId, requestHeaders }?: PaymentPlatformApplicationValidator.PollingPaymentLinkParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PollingPaymentLinkResponse>;
|
|
261
360
|
/**
|
|
262
361
|
* @param {PaymentPlatformApplicationValidator.RepaymentDetailsParam} arg - Arg object
|
|
362
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
263
363
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
264
364
|
* @returns {Promise<PaymentPlatformModel.RepaymentResponse>} - Success response
|
|
265
365
|
* @name repaymentDetails
|
|
266
366
|
* @summary: API to register repayment details
|
|
267
367
|
* @description: Use this API to register any repayment record in the db and notify the aggrgator - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/repaymentDetails/).
|
|
268
368
|
*/
|
|
269
|
-
repaymentDetails({ body }?: PaymentPlatformApplicationValidator.RepaymentDetailsParam, {
|
|
369
|
+
repaymentDetails({ body, requestHeaders }?: PaymentPlatformApplicationValidator.RepaymentDetailsParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.RepaymentResponse>;
|
|
270
370
|
/**
|
|
271
371
|
* @param {PaymentPlatformApplicationValidator.ResendOrCancelPaymentParam} arg
|
|
272
372
|
* - Arg object
|
|
273
373
|
*
|
|
374
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
274
375
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
275
376
|
* @returns {Promise<PaymentPlatformModel.ResendOrCancelPaymentResponse>} -
|
|
276
377
|
* Success response
|
|
@@ -278,11 +379,12 @@ declare class Payment {
|
|
|
278
379
|
* @summary: API to resend and cancel a payment link which was already generated.
|
|
279
380
|
* @description: Use this API to perform resend or cancel a payment link based on request payload. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/resendOrCancelPayment/).
|
|
280
381
|
*/
|
|
281
|
-
resendOrCancelPayment({ body }?: PaymentPlatformApplicationValidator.ResendOrCancelPaymentParam, {
|
|
382
|
+
resendOrCancelPayment({ body, requestHeaders }?: PaymentPlatformApplicationValidator.ResendOrCancelPaymentParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.ResendOrCancelPaymentResponse>;
|
|
282
383
|
/**
|
|
283
384
|
* @param {PaymentPlatformApplicationValidator.ResendPaymentLinkParam} arg
|
|
284
385
|
* - Arg object
|
|
285
386
|
*
|
|
387
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
286
388
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
287
389
|
* @returns {Promise<PaymentPlatformModel.ResendPaymentLinkResponse>} -
|
|
288
390
|
* Success response
|
|
@@ -290,20 +392,22 @@ declare class Payment {
|
|
|
290
392
|
* @summary: Resend payment link
|
|
291
393
|
* @description: Use this API to resend a payment link for the customer - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/resendPaymentLink/).
|
|
292
394
|
*/
|
|
293
|
-
resendPaymentLink({ body }?: PaymentPlatformApplicationValidator.ResendPaymentLinkParam, {
|
|
395
|
+
resendPaymentLink({ body, requestHeaders }?: PaymentPlatformApplicationValidator.ResendPaymentLinkParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.ResendPaymentLinkResponse>;
|
|
294
396
|
/**
|
|
295
397
|
* @param {PaymentPlatformApplicationValidator.RevokeOauthTokenParam} arg - Arg object
|
|
398
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
296
399
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
297
400
|
* @returns {Promise<PaymentPlatformModel.RevokeOAuthToken>} - Success response
|
|
298
401
|
* @name revokeOauthToken
|
|
299
402
|
* @summary: API to Revoke oauth for razorpay partnership
|
|
300
403
|
* @description: Use this API to Revoke oauth for razorpay partnership - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/revokeOauthToken/).
|
|
301
404
|
*/
|
|
302
|
-
revokeOauthToken({ aggregator }?: PaymentPlatformApplicationValidator.RevokeOauthTokenParam, {
|
|
405
|
+
revokeOauthToken({ aggregator, requestHeaders }?: PaymentPlatformApplicationValidator.RevokeOauthTokenParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.RevokeOAuthToken>;
|
|
303
406
|
/**
|
|
304
407
|
* @param {PaymentPlatformApplicationValidator.SaveBrandPaymentGatewayConfigParam} arg
|
|
305
408
|
* - Arg object
|
|
306
409
|
*
|
|
410
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
307
411
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
308
412
|
* @returns {Promise<PaymentPlatformModel.PaymentGatewayToBeReviewed>} -
|
|
309
413
|
* Success response
|
|
@@ -311,31 +415,62 @@ declare class Payment {
|
|
|
311
415
|
* @summary: Save Config Secret For Brand Payment Gateway
|
|
312
416
|
* @description: Save Config Secret For Brand Payment Gateway - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/saveBrandPaymentGatewayConfig/).
|
|
313
417
|
*/
|
|
314
|
-
saveBrandPaymentGatewayConfig({ body }?: PaymentPlatformApplicationValidator.SaveBrandPaymentGatewayConfigParam, {
|
|
418
|
+
saveBrandPaymentGatewayConfig({ body, requestHeaders }?: PaymentPlatformApplicationValidator.SaveBrandPaymentGatewayConfigParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentGatewayToBeReviewed>;
|
|
315
419
|
/**
|
|
316
420
|
* @param {PaymentPlatformApplicationValidator.SetUserCODlimitRoutesParam} arg
|
|
317
421
|
* - Arg object
|
|
318
422
|
*
|
|
423
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
319
424
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
320
425
|
* @returns {Promise<PaymentPlatformModel.SetCODOptionResponse>} - Success response
|
|
321
426
|
* @name setUserCODlimitRoutes
|
|
322
427
|
* @summary: Set COD option for user for payment
|
|
323
428
|
* @description: Use this API to set cod option as true or false for the payment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/setUserCODlimitRoutes/).
|
|
324
429
|
*/
|
|
325
|
-
setUserCODlimitRoutes({ body }?: PaymentPlatformApplicationValidator.SetUserCODlimitRoutesParam, {
|
|
430
|
+
setUserCODlimitRoutes({ body, requestHeaders }?: PaymentPlatformApplicationValidator.SetUserCODlimitRoutesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.SetCODOptionResponse>;
|
|
326
431
|
/**
|
|
327
432
|
* @param {PaymentPlatformApplicationValidator.UpdateEdcDeviceParam} arg - Arg object
|
|
433
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
328
434
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
329
435
|
* @returns {Promise<PaymentPlatformModel.EdcDeviceAddResponse>} - Success response
|
|
330
436
|
* @name updateEdcDevice
|
|
331
437
|
* @summary: map new edc device to the terminal
|
|
332
438
|
* @description: Use this API to map new edc device to the terminal - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/updateEdcDevice/).
|
|
333
439
|
*/
|
|
334
|
-
updateEdcDevice({ body }?: PaymentPlatformApplicationValidator.UpdateEdcDeviceParam, {
|
|
440
|
+
updateEdcDevice({ body, requestHeaders }?: PaymentPlatformApplicationValidator.UpdateEdcDeviceParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.EdcDeviceAddResponse>;
|
|
441
|
+
/**
|
|
442
|
+
* @param {PaymentPlatformApplicationValidator.UpdatePaymentSessionParam} arg
|
|
443
|
+
* - Arg object
|
|
444
|
+
*
|
|
445
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
446
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
447
|
+
* @returns {Promise<PaymentPlatformModel.PaymentSessionResponseSerializer>}
|
|
448
|
+
* - Success response
|
|
449
|
+
*
|
|
450
|
+
* @name updatePaymentSession
|
|
451
|
+
* @summary: API to update status of a payment.
|
|
452
|
+
* @description: A payment_session is initiated against a global identifier (gid) which is identifies the entity payment is initiated against. e.g. order_id, cart_id. This endpoint is to update the status of the said payment_session. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/updatePaymentSession/).
|
|
453
|
+
*/
|
|
454
|
+
updatePaymentSession({ gid, body, requestHeaders }?: PaymentPlatformApplicationValidator.UpdatePaymentSessionParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentSessionResponseSerializer>;
|
|
455
|
+
/**
|
|
456
|
+
* @param {PaymentPlatformApplicationValidator.UpdateRefundSessionParam} arg
|
|
457
|
+
* - Arg object
|
|
458
|
+
*
|
|
459
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
460
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
461
|
+
* @returns {Promise<PaymentPlatformModel.RefundSessionResponseSerializer>}
|
|
462
|
+
* - Success response
|
|
463
|
+
*
|
|
464
|
+
* @name updateRefundSession
|
|
465
|
+
* @summary: API to update the status of a refund
|
|
466
|
+
* @description: A refund_session is initiated against a refund request, and this endpoint is to update the status against the refund request_id. A gid is unique indentifier of the entity against which payment was received e.g. an order. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/updateRefundSession/).
|
|
467
|
+
*/
|
|
468
|
+
updateRefundSession({ gid, requestId, body, requestHeaders }?: PaymentPlatformApplicationValidator.UpdateRefundSessionParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.RefundSessionResponseSerializer>;
|
|
335
469
|
/**
|
|
336
470
|
* @param {PaymentPlatformApplicationValidator.VerifyCustomerForPaymentParam} arg
|
|
337
471
|
* - Arg object
|
|
338
472
|
*
|
|
473
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
339
474
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
340
475
|
* @returns {Promise<PaymentPlatformModel.ValidateCustomerResponse>} -
|
|
341
476
|
* Success response
|
|
@@ -343,7 +478,7 @@ declare class Payment {
|
|
|
343
478
|
* @summary: Validate customer for payment
|
|
344
479
|
* @description: Use this API to check if the customer is eligible to use credit-line facilities such as Simpl Pay Later and Rupifi. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/verifyCustomerForPayment/).
|
|
345
480
|
*/
|
|
346
|
-
verifyCustomerForPayment({ body }?: PaymentPlatformApplicationValidator.VerifyCustomerForPaymentParam, {
|
|
481
|
+
verifyCustomerForPayment({ body, requestHeaders }?: PaymentPlatformApplicationValidator.VerifyCustomerForPaymentParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.ValidateCustomerResponse>;
|
|
347
482
|
}
|
|
348
483
|
import PaymentPlatformApplicationValidator = require("./PaymentPlatformApplicationValidator");
|
|
349
484
|
import PaymentPlatformModel = require("./PaymentPlatformModel");
|