@gofynd/fdk-client-javascript 1.4.2-beta.4 → 1.4.2-beta.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (140) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/Cart/CartApplicationClient.d.ts +62 -62
  4. package/sdk/application/Cart/CartApplicationClient.js +82 -71
  5. package/sdk/application/Cart/CartApplicationValidator.d.ts +189 -34
  6. package/sdk/application/Cart/CartApplicationValidator.js +59 -34
  7. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +78 -78
  8. package/sdk/application/Catalog/CatalogApplicationClient.js +78 -78
  9. package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
  10. package/sdk/application/Common/CommonApplicationClient.js +4 -4
  11. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -6
  12. package/sdk/application/Communication/CommunicationApplicationClient.js +6 -6
  13. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -67
  14. package/sdk/application/Configuration/ConfigurationApplicationClient.js +32 -106
  15. package/sdk/application/Content/ContentApplicationClient.d.ts +34 -64
  16. package/sdk/application/Content/ContentApplicationClient.js +34 -115
  17. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -42
  18. package/sdk/application/FileStorage/FileStorageApplicationClient.js +6 -42
  19. package/sdk/application/Lead/LeadApplicationClient.d.ts +14 -14
  20. package/sdk/application/Lead/LeadApplicationClient.js +14 -14
  21. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +12 -12
  22. package/sdk/application/Logistic/LogisticApplicationClient.js +12 -12
  23. package/sdk/application/Order/OrderApplicationClient.d.ts +24 -24
  24. package/sdk/application/Order/OrderApplicationClient.js +24 -24
  25. package/sdk/application/Order/OrderApplicationModel.d.ts +23 -1
  26. package/sdk/application/Order/OrderApplicationModel.js +28 -0
  27. package/sdk/application/Payment/PaymentApplicationClient.d.ts +89 -89
  28. package/sdk/application/Payment/PaymentApplicationClient.js +94 -94
  29. package/sdk/application/Payment/PaymentApplicationModel.d.ts +498 -3
  30. package/sdk/application/Payment/PaymentApplicationModel.js +316 -2
  31. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +5 -5
  32. package/sdk/application/Payment/PaymentApplicationValidator.js +3 -3
  33. package/sdk/application/PosCart/PosCartApplicationClient.d.ts +54 -54
  34. package/sdk/application/PosCart/PosCartApplicationClient.js +54 -54
  35. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +14 -25
  36. package/sdk/application/Rewards/RewardsApplicationClient.js +14 -41
  37. package/sdk/application/Share/ShareApplicationClient.d.ts +14 -14
  38. package/sdk/application/Share/ShareApplicationClient.js +14 -14
  39. package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
  40. package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
  41. package/sdk/application/User/UserApplicationClient.d.ts +64 -64
  42. package/sdk/application/User/UserApplicationClient.js +64 -64
  43. package/sdk/partner/Theme/ThemePartnerClient.d.ts +38 -38
  44. package/sdk/partner/Theme/ThemePartnerClient.js +38 -38
  45. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +8 -8
  46. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +8 -8
  47. package/sdk/platform/Billing/BillingPlatformClient.d.ts +34 -36
  48. package/sdk/platform/Billing/BillingPlatformClient.js +34 -36
  49. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +98 -175
  50. package/sdk/platform/Cart/CartPlatformApplicationClient.js +98 -254
  51. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +92 -18
  52. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +28 -18
  53. package/sdk/platform/Cart/CartPlatformModel.d.ts +12 -0
  54. package/sdk/platform/Cart/CartPlatformModel.js +12 -0
  55. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +195 -108
  56. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +278 -113
  57. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +2 -2
  58. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +2 -2
  59. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +335 -136
  60. package/sdk/platform/Catalog/CatalogPlatformClient.js +551 -136
  61. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +5 -5
  62. package/sdk/platform/Catalog/CatalogPlatformModel.js +3 -3
  63. package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -3
  64. package/sdk/platform/Common/CommonPlatformClient.js +3 -3
  65. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +115 -290
  66. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +115 -510
  67. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +2 -13
  68. package/sdk/platform/Communication/CommunicationPlatformClient.js +2 -29
  69. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +32 -32
  70. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +32 -32
  71. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +52 -127
  72. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +52 -204
  73. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +35 -111
  74. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +35 -212
  75. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +142 -1
  76. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +96 -0
  77. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +130 -218
  78. package/sdk/platform/Content/ContentPlatformApplicationClient.js +136 -314
  79. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +4 -4
  80. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +4 -4
  81. package/sdk/platform/Content/ContentPlatformClient.d.ts +1 -1
  82. package/sdk/platform/Content/ContentPlatformClient.js +7 -7
  83. package/sdk/platform/Content/ContentPlatformValidator.d.ts +4 -4
  84. package/sdk/platform/Content/ContentPlatformValidator.js +4 -4
  85. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +22 -48
  86. package/sdk/platform/Discount/DiscountPlatformClient.js +22 -73
  87. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +19 -55
  88. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +19 -55
  89. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +14 -50
  90. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +16 -55
  91. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +13 -12
  92. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +12 -14
  93. package/sdk/platform/Finance/FinancePlatformClient.d.ts +44 -44
  94. package/sdk/platform/Finance/FinancePlatformClient.js +44 -44
  95. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +12 -12
  96. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +12 -12
  97. package/sdk/platform/Lead/LeadPlatformClient.d.ts +22 -48
  98. package/sdk/platform/Lead/LeadPlatformClient.js +22 -72
  99. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +4 -4
  100. package/sdk/platform/Order/OrderPlatformApplicationClient.js +4 -4
  101. package/sdk/platform/Order/OrderPlatformClient.d.ts +79 -208
  102. package/sdk/platform/Order/OrderPlatformClient.js +79 -294
  103. package/sdk/platform/Order/OrderPlatformModel.d.ts +32 -3
  104. package/sdk/platform/Order/OrderPlatformModel.js +34 -2
  105. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -4
  106. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -4
  107. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +4 -4
  108. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +2 -2
  109. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +81 -81
  110. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +81 -81
  111. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
  112. package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
  113. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +23 -40
  114. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +23 -61
  115. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +8 -8
  116. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +8 -8
  117. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +5 -5
  118. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +8 -8
  119. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +2 -2
  120. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +2 -2
  121. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +10 -10
  122. package/sdk/platform/Share/SharePlatformApplicationClient.js +10 -10
  123. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +56 -56
  124. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +56 -56
  125. package/sdk/platform/Theme/ThemePlatformClient.d.ts +6 -6
  126. package/sdk/platform/Theme/ThemePlatformClient.js +6 -6
  127. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +33 -33
  128. package/sdk/platform/User/UserPlatformApplicationClient.js +33 -33
  129. package/sdk/platform/User/UserPlatformModel.d.ts +2 -2
  130. package/sdk/platform/User/UserPlatformModel.js +2 -2
  131. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +32 -45
  132. package/sdk/platform/Webhook/WebhookPlatformClient.js +32 -45
  133. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +58 -1
  134. package/sdk/platform/Webhook/WebhookPlatformModel.js +66 -0
  135. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -2
  136. package/sdk/public/Configuration/ConfigurationPublicClient.js +2 -2
  137. package/sdk/public/Partner/PartnerPublicClient.d.ts +2 -2
  138. package/sdk/public/Partner/PartnerPublicClient.js +2 -2
  139. package/sdk/public/Webhook/WebhookPublicClient.d.ts +4 -4
  140. package/sdk/public/Webhook/WebhookPublicClient.js +4 -4
@@ -21,8 +21,8 @@ class Payment {
21
21
  * @param {import("../PlatformAPIClient").Options} - Options
22
22
  * @returns {Promise<PaymentPlatformModel.EdcDeviceUpdateResponse>} - Success response
23
23
  * @name addEdcDevice
24
- * @summary: Update store id and device tag of edc device
25
- * @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/).
24
+ * @summary: Add EDC device.
25
+ * @description: Register and add a new EDC device. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/addEdcDevice/).
26
26
  */
27
27
  async addEdcDevice(
28
28
  { terminalUniqueIdentifier, body, requestHeaders } = { requestHeaders: {} },
@@ -104,8 +104,8 @@ class Payment {
104
104
  * @param {import("../PlatformAPIClient").Options} - Options
105
105
  * @returns {Promise<PaymentPlatformModel.RefundAccountResponse>} - Success response
106
106
  * @name addRefundBankAccountUsingOTP
107
- * @summary: Save bank details for cancelled/returned order
108
- * @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/).
107
+ * @summary: Add refund bank account using OTP.
108
+ * @description: Register a refund bank account with OTP verification. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/addRefundBankAccountUsingOTP/).
109
109
  */
110
110
  async addRefundBankAccountUsingOTP(
111
111
  { body, requestHeaders } = { requestHeaders: {} },
@@ -186,8 +186,8 @@ class Payment {
186
186
  * @returns {Promise<PaymentPlatformModel.CancelPaymentLinkResponse>} -
187
187
  * Success response
188
188
  * @name cancelPaymentLink
189
- * @summary: Cancel payment link
190
- * @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/).
189
+ * @summary: Cancel payment link.
190
+ * @description: Deactivate and cancel a payment link. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/cancelPaymentLink/).
191
191
  */
192
192
  async cancelPaymentLink(
193
193
  { body, requestHeaders } = { requestHeaders: {} },
@@ -268,8 +268,8 @@ class Payment {
268
268
  * @returns {Promise<PaymentPlatformModel.PaymentStatusUpdateResponse>} -
269
269
  * Success response
270
270
  * @name checkAndUpdatePaymentStatus
271
- * @summary: Performs continuous polling to check status of payment on the server
272
- * @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/).
271
+ * @summary: Check and update payment status.
272
+ * @description: Verify and modify the status of a payment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/checkAndUpdatePaymentStatus/).
273
273
  */
274
274
  async checkAndUpdatePaymentStatus(
275
275
  { body, requestHeaders } = { requestHeaders: {} },
@@ -348,8 +348,8 @@ class Payment {
348
348
  * @returns {Promise<PaymentPlatformModel.PaymentConfirmationResponse>} -
349
349
  * Success response
350
350
  * @name confirmPayment
351
- * @summary: Confirm payment after successful payment from payment gateway
352
- * @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/).
351
+ * @summary: Confirm payment.
352
+ * @description: Authenticate and confirm a payment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/confirmPayment/).
353
353
  */
354
354
  async confirmPayment(
355
355
  { body, requestHeaders } = { requestHeaders: {} },
@@ -431,8 +431,8 @@ class Payment {
431
431
  * - Success response
432
432
  *
433
433
  * @name createMerchantRefundPriority
434
- * @summary: API to create merchant refund priority
435
- * @description: API to update merchant refund priority - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/createMerchantRefundPriority/).
434
+ * @summary: Crete merchant refund priority
435
+ * @description: Crete merchant refund priority. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/createMerchantRefundPriority/).
436
436
  */
437
437
  async createMerchantRefundPriority(
438
438
  { configType, body, requestHeaders } = { requestHeaders: {} },
@@ -515,8 +515,8 @@ class Payment {
515
515
  * @returns {Promise<PaymentPlatformModel.CreatePaymentLinkResponse>} -
516
516
  * Success response
517
517
  * @name createPaymentLink
518
- * @summary: Create payment link
519
- * @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/).
518
+ * @summary: Create payment link.
519
+ * @description: Generate a new link for accepting payments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/createPaymentLink/).
520
520
  */
521
521
  async createPaymentLink(
522
522
  { body, requestHeaders } = { requestHeaders: {} },
@@ -679,8 +679,8 @@ class Payment {
679
679
  * - Success response
680
680
  *
681
681
  * @name edcAggregatorsAndModelList
682
- * @summary: get some information about the store and edc device
683
- * @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/).
682
+ * @summary: EDC aggregators and model list.
683
+ * @description: Retrieve a list of EDC (Electronic Data Capture) aggregators and models. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/edcAggregatorsAndModelList/).
684
684
  */
685
685
  async edcAggregatorsAndModelList(
686
686
  { requestHeaders } = { requestHeaders: {} },
@@ -754,8 +754,8 @@ class Payment {
754
754
  * @param {import("../PlatformAPIClient").Options} - Options
755
755
  * @returns {Promise<PaymentPlatformModel.EdcDeviceListResponse>} - Success response
756
756
  * @name edcDeviceList
757
- * @summary: get all the device list of an app
758
- * @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/).
757
+ * @summary: EDC device list.
758
+ * @description: Retrieve a list of available EDC devices. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/edcDeviceList/).
759
759
  */
760
760
  async edcDeviceList(
761
761
  { pageNo, pageSize, isActive, storeId, deviceTag, requestHeaders } = {
@@ -848,8 +848,8 @@ class Payment {
848
848
  * @param {import("../PlatformAPIClient").Options} - Options
849
849
  * @returns {Promise<PaymentPlatformModel.EdcDeviceStatsResponse>} - Success response
850
850
  * @name edcDeviceStats
851
- * @summary: get some information about the store and edc device
852
- * @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/).
851
+ * @summary: EDC device stats.
852
+ * @description: Get statistics and data related to EDC devices. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/edcDeviceStats/).
853
853
  */
854
854
  async edcDeviceStats(
855
855
  { requestHeaders } = { requestHeaders: {} },
@@ -925,8 +925,8 @@ class Payment {
925
925
  * @param {import("../PlatformAPIClient").Options} - Options
926
926
  * @returns {Promise<PaymentPlatformModel.RefundAccountResponse>} - Success response
927
927
  * @name getBankAccountDetailsOpenAPI
928
- * @summary: Get bank details
929
- * @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/).
928
+ * @summary: Get bank account details.
929
+ * @description: Retrieve bank account information using an open API. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getBankAccountDetailsOpenAPI/).
930
930
  */
931
931
  async getBankAccountDetailsOpenAPI(
932
932
  { orderId, requestHash, requestHeaders } = { requestHeaders: {} },
@@ -1013,8 +1013,8 @@ class Payment {
1013
1013
  * @returns {Promise<PaymentPlatformModel.PaymentGatewayConfigResponse>} -
1014
1014
  * Success response
1015
1015
  * @name getBrandPaymentGatewayConfig
1016
- * @summary: Get All Brand Payment Gateway Config Secret
1017
- * @description: Get All Brand Payment Gateway Config Secret - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getBrandPaymentGatewayConfig/).
1016
+ * @summary: Get brand payment gateway config
1017
+ * @description: Retrieve configuration settings for brand payment gateways. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getBrandPaymentGatewayConfig/).
1018
1018
  */
1019
1019
  async getBrandPaymentGatewayConfig(
1020
1020
  { aggregator, configType, requestHeaders } = { requestHeaders: {} },
@@ -1097,8 +1097,8 @@ class Payment {
1097
1097
  * @returns {Promise<PaymentPlatformModel.EdcDeviceDetailsResponse>} -
1098
1098
  * Success response
1099
1099
  * @name getEdcDevice
1100
- * @summary: get details of a single edc device
1101
- * @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/).
1100
+ * @summary: Get EDC device.
1101
+ * @description: Retrieve detailed information about an EDC device. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getEdcDevice/).
1102
1102
  */
1103
1103
  async getEdcDevice(
1104
1104
  { terminalUniqueIdentifier, requestHeaders } = { requestHeaders: {} },
@@ -1280,8 +1280,8 @@ class Payment {
1280
1280
  * @returns {Promise<PaymentPlatformModel.PlatformPaymentModeResponse>} -
1281
1281
  * Success response
1282
1282
  * @name getMerchantAggregatorPaymentModeDetails
1283
- * @summary: Get Aggregator, payment mode and sub payment mode.
1284
- * @description: Get Aggregator, payment mode and sub payment mode details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getMerchantAggregatorPaymentModeDetails/).
1283
+ * @summary: Get merchant aggregator payment mode details.
1284
+ * @description: swagger not found. so operationId not found - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getMerchantAggregatorPaymentModeDetails/).
1285
1285
  */
1286
1286
  async getMerchantAggregatorPaymentModeDetails(
1287
1287
  { aggregatorId, businessUnit, device, requestHeaders } = {
@@ -1370,8 +1370,8 @@ class Payment {
1370
1370
  * @returns {Promise<PaymentPlatformModel.PlatformPaymentModeResponse>} -
1371
1371
  * Success response
1372
1372
  * @name getMerchantPaymentOption
1373
- * @summary: Get Payment modes and COD details.
1374
- * @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/).
1373
+ * @summary: Get merchant payment option
1374
+ * @description: Retrieve all the available Paymet Gateways for merchant and its offline payment mode details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getMerchantPaymentOption/).
1375
1375
  */
1376
1376
  async getMerchantPaymentOption(
1377
1377
  { requestHeaders } = { requestHeaders: {} },
@@ -1449,8 +1449,8 @@ class Payment {
1449
1449
  * - Success response
1450
1450
  *
1451
1451
  * @name getMerchantRefundPriority
1452
- * @summary: API to get merchant refund priority
1453
- * @description: API to get merchant refund priority - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getMerchantRefundPriority/).
1452
+ * @summary: Get merchant refund priority
1453
+ * @description: Get merchant refund priority. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getMerchantRefundPriority/).
1454
1454
  */
1455
1455
  async getMerchantRefundPriority(
1456
1456
  { configType, requestHeaders } = { requestHeaders: {} },
@@ -1531,8 +1531,8 @@ class Payment {
1531
1531
  * @returns {Promise<PaymentPlatformModel.PlatformPaymentModeResponse>} -
1532
1532
  * Success response
1533
1533
  * @name getPGConfigAggregators
1534
- * @summary: Get Aggregators available to be added as PG.
1535
- * @description: Get Aggregators available to be added as PG. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getPGConfigAggregators/).
1534
+ * @summary: Get PG (Payment Gateway) config aggregators.
1535
+ * @description: swagger not found. so operationId not found - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getPGConfigAggregators/).
1536
1536
  */
1537
1537
  async getPGConfigAggregators(
1538
1538
  { requestHeaders } = { requestHeaders: {} },
@@ -1608,8 +1608,8 @@ class Payment {
1608
1608
  * @param {import("../PlatformAPIClient").Options} - Options
1609
1609
  * @returns {Promise<PaymentPlatformModel.GetPaymentCodeResponse>} - Success response
1610
1610
  * @name getPaymentCodeOption
1611
- * @summary: List Payment Options Method Codes
1612
- * @description: Get all active List Payment Options Method Codes - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getPaymentCodeOption/).
1611
+ * @summary: Get payment mode code.
1612
+ * @description: Retrieve options for payment codes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getPaymentCodeOption/).
1613
1613
  */
1614
1614
  async getPaymentCodeOption(
1615
1615
  { requestHeaders } = { requestHeaders: {} },
@@ -1683,8 +1683,8 @@ class Payment {
1683
1683
  * @param {import("../PlatformAPIClient").Options} - Options
1684
1684
  * @returns {Promise<PaymentPlatformModel.GetPaymentLinkResponse>} - Success response
1685
1685
  * @name getPaymentLink
1686
- * @summary: Get payment link
1687
- * @description: Use this API to get a payment link - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getPaymentLink/).
1686
+ * @summary: Get payment link.
1687
+ * @description: Retrieve a link for making payments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getPaymentLink/).
1688
1688
  */
1689
1689
  async getPaymentLink(
1690
1690
  { paymentLinkId, requestHeaders } = { requestHeaders: {} },
@@ -1930,8 +1930,8 @@ class Payment {
1930
1930
  * @param {import("../PlatformAPIClient").Options} - Options
1931
1931
  * @returns {Promise<PaymentPlatformModel.PaymentOptionsResponse>} - Success response
1932
1932
  * @name getPaymentModeRoutes
1933
- * @summary: Get All Valid Payment Options
1934
- * @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/).
1933
+ * @summary: Get payment mode routes.
1934
+ * @description: Retrieve routes and options for payment modes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getPaymentModeRoutes/).
1935
1935
  */
1936
1936
  async getPaymentModeRoutes(
1937
1937
  { refresh, requestType, orderId, shipmentId, requestHeaders } = {
@@ -2109,8 +2109,8 @@ class Payment {
2109
2109
  * @returns {Promise<PaymentPlatformModel.PaymentModeRouteResponse>} -
2110
2110
  * Success response
2111
2111
  * @name getPosPaymentModeRoutes
2112
- * @summary: Get All Valid Payment Options
2113
- * @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/).
2112
+ * @summary: Get POS payment mode routes.
2113
+ * @description: Retrieve payment options and aggregator for point-of-sale (POS). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getPosPaymentModeRoutes/).
2114
2114
  */
2115
2115
  async getPosPaymentModeRoutes(
2116
2116
  {
@@ -2239,8 +2239,8 @@ class Payment {
2239
2239
  * @returns {Promise<PaymentPlatformModel.OrderBeneficiaryResponse>} -
2240
2240
  * Success response
2241
2241
  * @name getUserBeneficiaries
2242
- * @summary: List User Beneficiary
2243
- * @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/).
2242
+ * @summary: Get user beneficiaries.
2243
+ * @description: Retrieve beneficiaries associated with a user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getUserBeneficiaries/).
2244
2244
  */
2245
2245
  async getUserBeneficiaries(
2246
2246
  { orderId, requestHeaders } = { requestHeaders: {} },
@@ -2317,8 +2317,8 @@ class Payment {
2317
2317
  * @param {import("../PlatformAPIClient").Options} - Options
2318
2318
  * @returns {Promise<PaymentPlatformModel.GetUserCODLimitResponse>} - Success response
2319
2319
  * @name getUserCODlimitRoutes
2320
- * @summary: Get COD limit for user
2321
- * @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/).
2320
+ * @summary: Get user COD limit routes.
2321
+ * @description: Retrieve routes and limits for user cash-on-delivery (COD) transactions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getUserCODlimitRoutes/).
2322
2322
  */
2323
2323
  async getUserCODlimitRoutes(
2324
2324
  { merchantUserId, mobileNo, requestHeaders } = { requestHeaders: {} },
@@ -2403,8 +2403,8 @@ class Payment {
2403
2403
  * @returns {Promise<PaymentPlatformModel.OrderBeneficiaryResponse>} -
2404
2404
  * Success response
2405
2405
  * @name getUserOrderBeneficiaries
2406
- * @summary: List Order Beneficiary
2407
- * @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/).
2406
+ * @summary: Get user order beneficiaries.
2407
+ * @description: Retrieve beneficiaries associated with a user orders. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getUserOrderBeneficiaries/).
2408
2408
  */
2409
2409
  async getUserOrderBeneficiaries(
2410
2410
  { orderId, requestHeaders } = { requestHeaders: {} },
@@ -2482,8 +2482,8 @@ class Payment {
2482
2482
  * @returns {Promise<PaymentPlatformModel.PaymentInitializationResponse>} -
2483
2483
  * Success response
2484
2484
  * @name initialisePayment
2485
- * @summary: Initialize a payment (server-to-server) for UPI and BharatQR
2486
- * @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/).
2485
+ * @summary: Initialize payment.
2486
+ * @description: Start the payment initiation process for UPI and QR code. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/initialisePayment/).
2487
2487
  */
2488
2488
  async initialisePayment(
2489
2489
  { body, requestHeaders } = { requestHeaders: {} },
@@ -2564,8 +2564,8 @@ class Payment {
2564
2564
  * @returns {Promise<PaymentPlatformModel.MerchantOnBoardingResponse>} -
2565
2565
  * Success response
2566
2566
  * @name merchantOnBoarding
2567
- * @summary: API to push Ajiodhan merchant data to Gringotts system
2568
- * @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/).
2567
+ * @summary: Merchant onboarding for BNPL.
2568
+ * @description: Initiate the onboarding process for a merchant. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/merchantOnBoarding/).
2569
2569
  */
2570
2570
  async merchantOnBoarding(
2571
2571
  { body, requestHeaders } = { requestHeaders: {} },
@@ -2643,8 +2643,8 @@ class Payment {
2643
2643
  * @param {import("../PlatformAPIClient").Options} - Options
2644
2644
  * @returns {Promise<PaymentPlatformModel.GetOauthUrlResponse>} - Success response
2645
2645
  * @name oauthGetUrl
2646
- * @summary: API to Get the url to call for oauth
2647
- * @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/).
2646
+ * @summary: Get OAuth URL.
2647
+ * @description: Retrieve an OAuth URL for PG API authentication. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/oauthGetUrl/).
2648
2648
  */
2649
2649
  async oauthGetUrl(
2650
2650
  { aggregator, successRedirectUrl, failureRedirectUrl, requestHeaders } = {
@@ -2733,8 +2733,8 @@ class Payment {
2733
2733
  * @returns {Promise<PaymentPlatformModel.PlatformPaymentModeResponse>} -
2734
2734
  * Success response
2735
2735
  * @name patchMerchantAggregatorPaymentModeDetails
2736
- * @summary: Update Aggregator, payment mode and sub payment mode.
2737
- * @description: Update Aggregator, payment mode and sub payment mode details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/patchMerchantAggregatorPaymentModeDetails/).
2736
+ * @summary: Patch merchant aggregator payment mode details.
2737
+ * @description: swagger not found. so operationId not found - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/patchMerchantAggregatorPaymentModeDetails/).
2738
2738
  */
2739
2739
  async patchMerchantAggregatorPaymentModeDetails(
2740
2740
  { aggregatorId, body, requestHeaders } = { requestHeaders: {} },
@@ -2817,7 +2817,7 @@ class Payment {
2817
2817
  * @returns {Promise<PaymentPlatformModel.PlatformPaymentModeResponse>} -
2818
2818
  * Success response
2819
2819
  * @name patchMerchantPaymentOption
2820
- * @summary: Update Payment modes and COD details.
2820
+ * @summary: Patch merchant payment option
2821
2821
  * @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/).
2822
2822
  */
2823
2823
  async patchMerchantPaymentOption(
@@ -2984,8 +2984,8 @@ class Payment {
2984
2984
  * - Success response
2985
2985
  *
2986
2986
  * @name paymentStatusBulk
2987
- * @summary: Get Payment status and information for a list of order_ids
2988
- * @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/).
2987
+ * @summary: Payment status bulk.
2988
+ * @description: Retrieve the status of multiple payments in bulk. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/paymentStatusBulk/).
2989
2989
  */
2990
2990
  async paymentStatusBulk(
2991
2991
  { body, requestHeaders } = { requestHeaders: {} },
@@ -3066,8 +3066,8 @@ class Payment {
3066
3066
  * @returns {Promise<PaymentPlatformModel.PollingPaymentLinkResponse>} -
3067
3067
  * Success response
3068
3068
  * @name pollingPaymentLink
3069
- * @summary: Used for polling if payment successful or not
3070
- * @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/).
3069
+ * @summary: Polling payment link.
3070
+ * @description: Continuously check the status of a payment link. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/pollingPaymentLink/).
3071
3071
  */
3072
3072
  async pollingPaymentLink(
3073
3073
  { paymentLinkId, requestHeaders } = { requestHeaders: {} },
@@ -3146,8 +3146,8 @@ class Payment {
3146
3146
  * @param {import("../PlatformAPIClient").Options} - Options
3147
3147
  * @returns {Promise<PaymentPlatformModel.RepaymentResponse>} - Success response
3148
3148
  * @name repaymentDetails
3149
- * @summary: API to register repayment details
3150
- * @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/).
3149
+ * @summary: Repayment details for BNPL.
3150
+ * @description: Retrieve information about repayment transactions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/repaymentDetails/).
3151
3151
  */
3152
3152
  async repaymentDetails(
3153
3153
  { body, requestHeaders } = { requestHeaders: {} },
@@ -3228,8 +3228,8 @@ class Payment {
3228
3228
  * @returns {Promise<PaymentPlatformModel.ResendOrCancelPaymentResponse>} -
3229
3229
  * Success response
3230
3230
  * @name resendOrCancelPayment
3231
- * @summary: API to resend and cancel a payment link which was already generated.
3232
- * @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/).
3231
+ * @summary: Resend or cancel payment.
3232
+ * @description: Resend or cancel a payment link. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/resendOrCancelPayment/).
3233
3233
  */
3234
3234
  async resendOrCancelPayment(
3235
3235
  { body, requestHeaders } = { requestHeaders: {} },
@@ -3310,8 +3310,8 @@ class Payment {
3310
3310
  * @returns {Promise<PaymentPlatformModel.ResendPaymentLinkResponse>} -
3311
3311
  * Success response
3312
3312
  * @name resendPaymentLink
3313
- * @summary: Resend payment link
3314
- * @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/).
3313
+ * @summary: Resend payment link.
3314
+ * @description: Reissue a payment link to a recipient. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/resendPaymentLink/).
3315
3315
  */
3316
3316
  async resendPaymentLink(
3317
3317
  { body, requestHeaders } = { requestHeaders: {} },
@@ -3389,8 +3389,8 @@ class Payment {
3389
3389
  * @param {import("../PlatformAPIClient").Options} - Options
3390
3390
  * @returns {Promise<PaymentPlatformModel.RevokeOAuthToken>} - Success response
3391
3391
  * @name revokeOauthToken
3392
- * @summary: API to Revoke oauth for razorpay partnership
3393
- * @description: Use this API to Revoke oauth for razorpay partnership - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/revokeOauthToken/).
3392
+ * @summary: Revoke OAuth token.
3393
+ * @description: Invalidate an OAuth token. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/revokeOauthToken/).
3394
3394
  */
3395
3395
  async revokeOauthToken(
3396
3396
  { aggregator, requestHeaders } = { requestHeaders: {} },
@@ -3471,8 +3471,8 @@ class Payment {
3471
3471
  * @returns {Promise<PaymentPlatformModel.PaymentGatewayToBeReviewed>} -
3472
3472
  * Success response
3473
3473
  * @name saveBrandPaymentGatewayConfig
3474
- * @summary: Save Config Secret For Brand Payment Gateway
3475
- * @description: Save Config Secret For Brand Payment Gateway - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/saveBrandPaymentGatewayConfig/).
3474
+ * @summary: Save brand payment gateway config.
3475
+ * @description: Store and update configuration settings for brand payment gateways. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/saveBrandPaymentGatewayConfig/).
3476
3476
  */
3477
3477
  async saveBrandPaymentGatewayConfig(
3478
3478
  { body, requestHeaders } = { requestHeaders: {} },
@@ -3721,8 +3721,8 @@ class Payment {
3721
3721
  * @param {import("../PlatformAPIClient").Options} - Options
3722
3722
  * @returns {Promise<PaymentPlatformModel.SetCODOptionResponse>} - Success response
3723
3723
  * @name setUserCODlimitRoutes
3724
- * @summary: Set COD option for user for payment
3725
- * @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/).
3724
+ * @summary: Set user COD limit routes.
3725
+ * @description: Configure routes and limits for user COD transactions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/setUserCODlimitRoutes/).
3726
3726
  */
3727
3727
  async setUserCODlimitRoutes(
3728
3728
  { body, requestHeaders } = { requestHeaders: {} },
@@ -3800,8 +3800,8 @@ class Payment {
3800
3800
  * @param {import("../PlatformAPIClient").Options} - Options
3801
3801
  * @returns {Promise<PaymentPlatformModel.EdcDeviceAddResponse>} - Success response
3802
3802
  * @name updateEdcDevice
3803
- * @summary: map new edc device to the terminal
3804
- * @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/).
3803
+ * @summary: Update EDC device.
3804
+ * @description: Modify the settings and details of an EDC device. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/updateEdcDevice/).
3805
3805
  */
3806
3806
  async updateEdcDevice(
3807
3807
  { body, requestHeaders } = { requestHeaders: {} },
@@ -3968,8 +3968,8 @@ class Payment {
3968
3968
  * - Success response
3969
3969
  *
3970
3970
  * @name updatePaymentSession
3971
- * @summary: API to update status of a payment.
3972
- * @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/).
3971
+ * @summary: Update payment session.
3972
+ * @description: Modify the details of a payment session. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/updatePaymentSession/).
3973
3973
  */
3974
3974
  async updatePaymentSession(
3975
3975
  { gid, body, requestHeaders } = { requestHeaders: {} },
@@ -4053,8 +4053,8 @@ class Payment {
4053
4053
  * - Success response
4054
4054
  *
4055
4055
  * @name updateRefundSession
4056
- * @summary: API to update the status of a refund
4057
- * @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/).
4056
+ * @summary: Update refund session.
4057
+ * @description: Modify the details of a refund session. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/updateRefundSession/).
4058
4058
  */
4059
4059
  async updateRefundSession(
4060
4060
  { gid, requestId, body, requestHeaders } = { requestHeaders: {} },
@@ -4139,8 +4139,8 @@ class Payment {
4139
4139
  * @returns {Promise<PaymentPlatformModel.ValidateCustomerResponse>} -
4140
4140
  * Success response
4141
4141
  * @name verifyCustomerForPayment
4142
- * @summary: Validate customer for payment
4143
- * @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/).
4142
+ * @summary: Verify customer for payment.
4143
+ * @description: Retrieve a link for making payments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/verifyCustomerForPayment/).
4144
4144
  */
4145
4145
  async verifyCustomerForPayment(
4146
4146
  { body, requestHeaders } = { requestHeaders: {} },
@@ -8,8 +8,8 @@ declare class Payment {
8
8
  * @param {import("../PlatformAPIClient").Options} - Options
9
9
  * @returns {Promise<PaymentPlatformModel.UpdatePayoutResponse>} - Success response
10
10
  * @name activateAndDectivatePayout
11
- * @summary: Partial Update Payout
12
- * @description: Partial Update Payout - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/activateAndDectivatePayout/).
11
+ * @summary: Activate/Deactivate payout.
12
+ * @description: Enable or disable payout functionality. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/activateAndDectivatePayout/).
13
13
  */
14
14
  activateAndDectivatePayout({ uniqueTransferNo, body, requestHeaders }?: PaymentPlatformValidator.ActivateAndDectivatePayoutParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.UpdatePayoutResponse>;
15
15
  /**
@@ -18,8 +18,8 @@ declare class Payment {
18
18
  * @param {import("../PlatformAPIClient").Options} - Options
19
19
  * @returns {Promise<PaymentPlatformModel.DeletePayoutResponse>} - Success response
20
20
  * @name deletePayout
21
- * @summary: Delete Payout
22
- * @description: Delete Payout - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/deletePayout/).
21
+ * @summary: Delete payout.
22
+ * @description: Remove a payout transaction from the system. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/deletePayout/).
23
23
  */
24
24
  deletePayout({ uniqueTransferNo, requestHeaders }?: PaymentPlatformValidator.DeletePayoutParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.DeletePayoutResponse>;
25
25
  /**
@@ -32,8 +32,8 @@ declare class Payment {
32
32
  * - Success response
33
33
  *
34
34
  * @name deleteSubscriptionPaymentMethod
35
- * @summary: Delete Subscription Payment Method
36
- * @description: Uses this api to Delete Subscription Payment Method - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/deleteSubscriptionPaymentMethod/).
35
+ * @summary: Delete subscription payment method.
36
+ * @description: Remove a payment method from subscription options. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/deleteSubscriptionPaymentMethod/).
37
37
  */
38
38
  deleteSubscriptionPaymentMethod({ uniqueExternalId, paymentMethodId, requestHeaders }?: PaymentPlatformValidator.DeleteSubscriptionPaymentMethodParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.DeleteSubscriptionPaymentMethodResponse>;
39
39
  /**
@@ -42,8 +42,8 @@ declare class Payment {
42
42
  * @param {import("../PlatformAPIClient").Options} - Options
43
43
  * @returns {Promise<PaymentPlatformModel.PayoutsResponse>} - Success response
44
44
  * @name getAllPayouts
45
- * @summary: Get All Payouts
46
- * @description: Get All Payouts - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getAllPayouts/).
45
+ * @summary: Get all payouts.
46
+ * @description: Retrieve a list of all payout transactions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getAllPayouts/).
47
47
  */
48
48
  getAllPayouts({ uniqueExternalId, requestHeaders }?: PaymentPlatformValidator.GetAllPayoutsParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PayoutsResponse>;
49
49
  /**
@@ -53,8 +53,8 @@ declare class Payment {
53
53
  * @returns {Promise<PaymentPlatformModel.SubscriptionConfigResponse>} -
54
54
  * Success response
55
55
  * @name getSubscriptionConfig
56
- * @summary: List Subscription Config
57
- * @description: Get all Subscription Config details - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getSubscriptionConfig/).
56
+ * @summary: Get subscription config.
57
+ * @description: Retrieve configuration settings for subscriptions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getSubscriptionConfig/).
58
58
  */
59
59
  getSubscriptionConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentPlatformModel.SubscriptionConfigResponse>;
60
60
  /**
@@ -67,8 +67,8 @@ declare class Payment {
67
67
  * - Success response
68
68
  *
69
69
  * @name getSubscriptionPaymentMethod
70
- * @summary: List Subscription Payment Method
71
- * @description: Get all Subscription Payment Method - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getSubscriptionPaymentMethod/).
70
+ * @summary: Get subscription payment method.
71
+ * @description: Retrieve payment methods for subscriptions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getSubscriptionPaymentMethod/).
72
72
  */
73
73
  getSubscriptionPaymentMethod({ uniqueExternalId, requestHeaders }?: PaymentPlatformValidator.GetSubscriptionPaymentMethodParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.SubscriptionPaymentMethodResponse>;
74
74
  /**
@@ -77,8 +77,8 @@ declare class Payment {
77
77
  * @param {import("../PlatformAPIClient").Options} - Options
78
78
  * @returns {Promise<PaymentPlatformModel.PayoutResponse>} - Success response
79
79
  * @name savePayout
80
- * @summary: Save Payout
81
- * @description: Save Payout - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/savePayout/).
80
+ * @summary: Save payout.
81
+ * @description: Store and process a payout transaction. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/savePayout/).
82
82
  */
83
83
  savePayout({ body, requestHeaders }?: PaymentPlatformValidator.SavePayoutParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PayoutResponse>;
84
84
  /**
@@ -89,8 +89,8 @@ declare class Payment {
89
89
  * - Success response
90
90
  *
91
91
  * @name saveSubscriptionSetupIntent
92
- * @summary: Save Subscription Setup Intent
93
- * @description: Uses this api to Save Subscription Setup Intent - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/saveSubscriptionSetupIntent/).
92
+ * @summary: Save subscription setup intent.
93
+ * @description: Store and process setup intent for subscriptions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/saveSubscriptionSetupIntent/).
94
94
  */
95
95
  saveSubscriptionSetupIntent({ body, requestHeaders }?: PaymentPlatformValidator.SaveSubscriptionSetupIntentParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.SaveSubscriptionSetupIntentResponse>;
96
96
  /**
@@ -99,8 +99,8 @@ declare class Payment {
99
99
  * @param {import("../PlatformAPIClient").Options} - Options
100
100
  * @returns {Promise<PaymentPlatformModel.UpdatePayoutResponse>} - Success response
101
101
  * @name updatePayout
102
- * @summary: Update Payout
103
- * @description: Update Payout - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/updatePayout/).
102
+ * @summary: Update payout.
103
+ * @description: Modify the details of a payout transaction. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/updatePayout/).
104
104
  */
105
105
  updatePayout({ uniqueTransferNo, body, requestHeaders }?: PaymentPlatformValidator.UpdatePayoutParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.UpdatePayoutResponse>;
106
106
  /**
@@ -109,8 +109,8 @@ declare class Payment {
109
109
  * @param {import("../PlatformAPIClient").Options} - Options
110
110
  * @returns {Promise<PaymentPlatformModel.IfscCodeResponse>} - Success response
111
111
  * @name verifyIfscCode
112
- * @summary: Ifsc Code Verification
113
- * @description: Get True or False for correct IFSC Code for adding bank details for refund - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/verifyIfscCode/).
112
+ * @summary: Verify IFSC code.
113
+ * @description: Check the authenticity of an IFSC code. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/verifyIfscCode/).
114
114
  */
115
115
  verifyIfscCode({ ifscCode, requestHeaders }?: PaymentPlatformValidator.VerifyIfscCodeParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.IfscCodeResponse>;
116
116
  }