@gofynd/fdk-client-javascript 1.4.3 → 1.4.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 (125) hide show
  1. package/README.md +1 -10
  2. package/package.json +1 -1
  3. package/sdk/application/Cart/CartApplicationClient.d.ts +48 -48
  4. package/sdk/application/Cart/CartApplicationClient.js +48 -48
  5. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +69 -69
  6. package/sdk/application/Catalog/CatalogApplicationClient.js +69 -69
  7. package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
  8. package/sdk/application/Common/CommonApplicationClient.js +4 -4
  9. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -6
  10. package/sdk/application/Communication/CommunicationApplicationClient.js +6 -6
  11. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -32
  12. package/sdk/application/Configuration/ConfigurationApplicationClient.js +32 -32
  13. package/sdk/application/Content/ContentApplicationClient.d.ts +45 -45
  14. package/sdk/application/Content/ContentApplicationClient.js +45 -45
  15. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +5 -5
  16. package/sdk/application/FileStorage/FileStorageApplicationClient.js +5 -5
  17. package/sdk/application/Lead/LeadApplicationClient.d.ts +9 -9
  18. package/sdk/application/Lead/LeadApplicationClient.js +9 -9
  19. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +22 -22
  20. package/sdk/application/Logistic/LogisticApplicationClient.js +22 -22
  21. package/sdk/application/Order/OrderApplicationClient.d.ts +14 -25
  22. package/sdk/application/Order/OrderApplicationClient.js +14 -94
  23. package/sdk/application/Order/OrderApplicationValidator.d.ts +1 -15
  24. package/sdk/application/Order/OrderApplicationValidator.js +0 -13
  25. package/sdk/application/Payment/PaymentApplicationClient.d.ts +71 -71
  26. package/sdk/application/Payment/PaymentApplicationClient.js +71 -71
  27. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +1 -1
  28. package/sdk/application/Rewards/RewardsApplicationClient.js +1 -1
  29. package/sdk/application/Share/ShareApplicationClient.d.ts +1 -1
  30. package/sdk/application/Share/ShareApplicationClient.js +1 -1
  31. package/sdk/application/Share/ShareApplicationModel.d.ts +2 -0
  32. package/sdk/application/Share/ShareApplicationModel.js +2 -0
  33. package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
  34. package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
  35. package/sdk/application/User/UserApplicationClient.d.ts +74 -74
  36. package/sdk/application/User/UserApplicationClient.js +74 -74
  37. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +5 -5
  38. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +5 -5
  39. package/sdk/platform/Billing/BillingPlatformClient.d.ts +13 -13
  40. package/sdk/platform/Billing/BillingPlatformClient.js +13 -13
  41. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +102 -102
  42. package/sdk/platform/Cart/CartPlatformApplicationClient.js +102 -102
  43. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +132 -131
  44. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +132 -131
  45. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +130 -130
  46. package/sdk/platform/Catalog/CatalogPlatformClient.js +130 -130
  47. package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -2
  48. package/sdk/platform/Common/CommonPlatformClient.js +2 -2
  49. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +118 -118
  50. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +118 -118
  51. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
  52. package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
  53. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +22 -22
  54. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +22 -22
  55. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +34 -7
  56. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +35 -5
  57. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +4 -4
  58. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +4 -4
  59. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +41 -41
  60. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +41 -41
  61. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +26 -26
  62. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +26 -26
  63. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +93 -93
  64. package/sdk/platform/Content/ContentPlatformApplicationClient.js +93 -93
  65. package/sdk/platform/Content/ContentPlatformClient.d.ts +29 -29
  66. package/sdk/platform/Content/ContentPlatformClient.js +29 -29
  67. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +18 -18
  68. package/sdk/platform/Discount/DiscountPlatformClient.js +18 -18
  69. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +18 -17
  70. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +18 -17
  71. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +6 -6
  72. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +6 -6
  73. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +2 -2
  74. package/sdk/platform/Finance/FinancePlatformClient.d.ts +4 -4
  75. package/sdk/platform/Finance/FinancePlatformClient.js +4 -4
  76. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +12 -12
  77. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +12 -12
  78. package/sdk/platform/Lead/LeadPlatformClient.d.ts +15 -15
  79. package/sdk/platform/Lead/LeadPlatformClient.js +15 -15
  80. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +10 -10
  81. package/sdk/platform/Order/OrderPlatformApplicationClient.js +10 -10
  82. package/sdk/platform/Order/OrderPlatformClient.d.ts +95 -106
  83. package/sdk/platform/Order/OrderPlatformClient.js +95 -190
  84. package/sdk/platform/Order/OrderPlatformModel.d.ts +10 -0
  85. package/sdk/platform/Order/OrderPlatformModel.js +4 -0
  86. package/sdk/platform/Order/OrderPlatformValidator.d.ts +1 -33
  87. package/sdk/platform/Order/OrderPlatformValidator.js +0 -20
  88. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -4
  89. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -4
  90. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +77 -77
  91. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +77 -77
  92. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +2 -2
  93. package/sdk/platform/Payment/PaymentPlatformClient.js +2 -2
  94. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +7 -0
  95. package/sdk/platform/Payment/PaymentPlatformModel.js +3 -0
  96. package/sdk/platform/PlatformClient.d.ts +0 -2
  97. package/sdk/platform/PlatformClient.js +0 -4
  98. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +7 -7
  99. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +7 -7
  100. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +40 -40
  101. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +40 -40
  102. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +51 -50
  103. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +51 -50
  104. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +1 -1
  105. package/sdk/platform/Share/SharePlatformApplicationClient.js +1 -1
  106. package/sdk/platform/Share/SharePlatformModel.d.ts +2 -0
  107. package/sdk/platform/Share/SharePlatformModel.js +2 -0
  108. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +34 -104
  109. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +34 -591
  110. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +1 -100
  111. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +0 -92
  112. package/sdk/platform/Theme/ThemePlatformClient.d.ts +6 -6
  113. package/sdk/platform/Theme/ThemePlatformClient.js +6 -6
  114. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +35 -35
  115. package/sdk/platform/User/UserPlatformApplicationClient.js +35 -35
  116. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +7 -6
  117. package/sdk/platform/Webhook/WebhookPlatformClient.js +7 -6
  118. package/sdk/platform/index.d.ts +0 -1
  119. package/sdk/platform/index.js +0 -2
  120. package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +0 -152
  121. package/sdk/platform/Inventory/InventoryPlatformClient.js +0 -1017
  122. package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +0 -1355
  123. package/sdk/platform/Inventory/InventoryPlatformModel.js +0 -1544
  124. package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +0 -171
  125. package/sdk/platform/Inventory/InventoryPlatformValidator.js +0 -159
@@ -115,8 +115,8 @@ class Payment {
115
115
  * @returns {Promise<PaymentApplicationModel.RefundAccountResponse>} -
116
116
  * Success response
117
117
  * @name addBeneficiaryDetails
118
- * @summary: Add beneficiary
119
- * @description: Adds beneficiary details for future transactions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/addBeneficiaryDetails/).
118
+ * @summary: Add beneficiary for refund
119
+ * @description: Adds beneficiary details specifically for refund transactions, including account holder name, account number and bank details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/addBeneficiaryDetails/).
120
120
  */
121
121
  async addBeneficiaryDetails(
122
122
  { body, requestHeaders } = { requestHeaders: {} },
@@ -198,8 +198,8 @@ class Payment {
198
198
  * @returns {Promise<PaymentApplicationModel.RefundAccountResponse>} -
199
199
  * Success response
200
200
  * @name addRefundBankAccountUsingOTP
201
- * @summary: Add refund account
202
- * @description: Adds a bank account for refunds using OTP verification. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/addRefundBankAccountUsingOTP/).
201
+ * @summary: Add refund account using OTP verification
202
+ * @description: The addition of a bank account specifically for refunds, employing OTP verification for security - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/addRefundBankAccountUsingOTP/).
203
203
  */
204
204
  async addRefundBankAccountUsingOTP(
205
205
  { body, requestHeaders } = { requestHeaders: {} },
@@ -278,8 +278,8 @@ class Payment {
278
278
  * @param {import("../ApplicationAPIClient").Options} - Options
279
279
  * @returns {Promise<PaymentApplicationModel.AttachCardsResponse>} - Success response
280
280
  * @name attachCardToCustomer
281
- * @summary: Attach card to user
282
- * @description: Links a payment card to a customer's account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/attachCardToCustomer/).
281
+ * @summary: Link payment card to customer
282
+ * @description: Linking of a payment card to a user's account for seamless transactions. Upon successful linking, the card becomes associated with the user's profile, enabling secure and convenient payments - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/attachCardToCustomer/).
283
283
  */
284
284
  async attachCardToCustomer(
285
285
  { body, requestHeaders } = { requestHeaders: {} },
@@ -359,7 +359,7 @@ class Payment {
359
359
  * @returns {Promise<PaymentApplicationModel.CancelPaymentLinkResponse>} -
360
360
  * Success response
361
361
  * @name cancelPaymentLink
362
- * @summary: Cancel link
362
+ * @summary: Cancel payment link
363
363
  * @description: Cancels a previously generated payment link. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/cancelPaymentLink/).
364
364
  */
365
365
  async cancelPaymentLink(
@@ -437,8 +437,8 @@ class Payment {
437
437
  * @param {import("../ApplicationAPIClient").Options} - Options
438
438
  * @returns {Promise<PaymentApplicationModel.CardDetailsResponse>} - Success response
439
439
  * @name cardDetails
440
- * @summary: Fetch card details
441
- * @description: Gets the details of a specified payment card. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/cardDetails/).
440
+ * @summary: Get card details
441
+ * @description: Fetches the details of a specified payment card, including information such as the card type, brand, country, and expiration date. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/cardDetails/).
442
442
  */
443
443
  async cardDetails(
444
444
  { cardInfo, aggregator, requestHeaders } = { requestHeaders: {} },
@@ -521,7 +521,7 @@ class Payment {
521
521
  *
522
522
  * @name checkAndUpdatePaymentStatus
523
523
  * @summary: Update payment status
524
- * @description: Checks and updates the current status of a payment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/checkAndUpdatePaymentStatus/).
524
+ * @description: Polling process to confirm the payment status. It periodically checks and updates the current status of a payment, ensuring timely and accurate confirmation of payment transactions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/checkAndUpdatePaymentStatus/).
525
525
  */
526
526
  async checkAndUpdatePaymentStatus(
527
527
  { body, requestHeaders } = { requestHeaders: {} },
@@ -604,8 +604,8 @@ class Payment {
604
604
  * - Success response
605
605
  *
606
606
  * @name checkAndUpdatePaymentStatusPaymentLink
607
- * @summary: Update link status
608
- * @description: Checks and updates the status of payment via a link. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/checkAndUpdatePaymentStatusPaymentLink/).
607
+ * @summary: Update payment link status
608
+ * @description: Verifies and updates the status of a payment made through a link.Upon successful verification and update, the response includes details about the aggregator name, payment status, and whether retrying the process is required. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/checkAndUpdatePaymentStatusPaymentLink/).
609
609
  */
610
610
  async checkAndUpdatePaymentStatusPaymentLink(
611
611
  { body, requestHeaders } = { requestHeaders: {} },
@@ -684,8 +684,8 @@ class Payment {
684
684
  * @param {import("../ApplicationAPIClient").Options} - Options
685
685
  * @returns {Promise<PaymentApplicationModel.CheckCreditResponse>} - Success response
686
686
  * @name checkCredit
687
- * @summary: Verify credit
688
- * @description: Checks the availability and status of customer credit. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/checkCredit/).
687
+ * @summary: Verify credit availability and status
688
+ * @description: Checks the availability and status of customer credit, providing the status of payment along with registration information and signup URL if the customer is not registered. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/checkCredit/).
689
689
  */
690
690
  async checkCredit(
691
691
  { aggregator, requestHeaders } = { requestHeaders: {} },
@@ -766,8 +766,8 @@ class Payment {
766
766
  * @returns {Promise<PaymentApplicationModel.CreateOrderUserResponse>} -
767
767
  * Success response
768
768
  * @name createOrderHandlerPaymentLink
769
- * @summary: Order via link
770
- * @description: Creates an order handler for payment through a link. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/createOrderHandlerPaymentLink/).
769
+ * @summary: Create order for payment via link
770
+ * @description: Initiates the creation of an order handler for processing payments through a link. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/createOrderHandlerPaymentLink/).
771
771
  */
772
772
  async createOrderHandlerPaymentLink(
773
773
  { body, requestHeaders } = { requestHeaders: {} },
@@ -926,7 +926,7 @@ class Payment {
926
926
  * @returns {Promise<PaymentApplicationModel.PaymentOrderResponse>} - Success response
927
927
  * @name createPaymentOrder
928
928
  * @summary: Create Order
929
- * @description: Use this API to create a order and payment on aggregator side - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/createPaymentOrder/).
929
+ * @description: Create an order and payment on the aggregator side - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/createPaymentOrder/).
930
930
  */
931
931
  async createPaymentOrder(
932
932
  { body, requestHeaders } = { requestHeaders: {} },
@@ -1006,7 +1006,7 @@ class Payment {
1006
1006
  *
1007
1007
  * @name customerCreditSummary
1008
1008
  * @summary: Credit summary
1009
- * @description: Retrieves a summary of the customer's credit details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/customerCreditSummary/).
1009
+ * @description: Fetches a summary of the customer's credit information, including details such as merchant customer reference ID, status, balance, limit, due amount, used amount, due date, days overdue, total due amount, and a repayment URL. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/customerCreditSummary/).
1010
1010
  */
1011
1011
  async customerCreditSummary(
1012
1012
  { aggregator, requestHeaders } = { requestHeaders: {} },
@@ -1087,8 +1087,8 @@ class Payment {
1087
1087
  * @returns {Promise<PaymentApplicationModel.CustomerOnboardingResponse>} -
1088
1088
  * Success response
1089
1089
  * @name customerOnboard
1090
- * @summary: Onboard customer
1091
- * @description: Initiates the onboarding process for payment services. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/customerOnboard/).
1090
+ * @summary: Onboard customer for payment
1091
+ * @description: Initiates the onboarding process for payment services, providing personal, business, and device information, along with marketplace details, to enable customer registration and credit availability. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/customerOnboard/).
1092
1092
  */
1093
1093
  async customerOnboard(
1094
1094
  { body, requestHeaders } = { requestHeaders: {} },
@@ -1165,8 +1165,8 @@ class Payment {
1165
1165
  * @param {import("../ApplicationAPIClient").Options} - Options
1166
1166
  * @returns {Promise<PaymentApplicationModel.DeleteCardsResponse>} - Success response
1167
1167
  * @name deleteUserCard
1168
- * @summary: Remove user's card
1169
- * @description: Deletes a payment card from the user's account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/deleteUserCard/).
1168
+ * @summary: Delete customer card
1169
+ * @description: Deletion of a payment card from the user's account - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/deleteUserCard/).
1170
1170
  */
1171
1171
  async deleteUserCard(
1172
1172
  { body, requestHeaders } = { requestHeaders: {} },
@@ -1244,7 +1244,7 @@ class Payment {
1244
1244
  * @returns {Promise<PaymentApplicationModel.WalletResponseSchema>} - Success response
1245
1245
  * @name delinkWallet
1246
1246
  * @summary: Delink the wallet
1247
- * @description: It Removes already linked wallet - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/delinkWallet/).
1247
+ * @description: User removes already linked wallet. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/delinkWallet/).
1248
1248
  */
1249
1249
  async delinkWallet(
1250
1250
  { body, requestHeaders } = { requestHeaders: {} },
@@ -1326,7 +1326,7 @@ class Payment {
1326
1326
  *
1327
1327
  * @name enableOrDisableRefundTransferMode
1328
1328
  * @summary: Toggle refund mode
1329
- * @description: Enables or disables a particular refund transfer mode. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/enableOrDisableRefundTransferMode/).
1329
+ * @description: Enables or disables a particular refund transfer mode based on the request body parameters, indicating whether the mode should be enabled or disabled - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/enableOrDisableRefundTransferMode/).
1330
1330
  */
1331
1331
  async enableOrDisableRefundTransferMode(
1332
1332
  { body, requestHeaders } = { requestHeaders: {} },
@@ -1407,8 +1407,8 @@ class Payment {
1407
1407
  * - Success response
1408
1408
  *
1409
1409
  * @name getActiveCardAggregator
1410
- * @summary: Active card info
1411
- * @description: Gets the active card aggregator for the user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getActiveCardAggregator/).
1410
+ * @summary: Retrieve active card aggregator
1411
+ * @description: Fetches details about the active card aggregator used by the user, including the aggregator's name.You can refresh the data by setting the "refresh" parameter to true if needed. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getActiveCardAggregator/).
1412
1412
  */
1413
1413
  async getActiveCardAggregator(
1414
1414
  { refresh, requestHeaders } = { requestHeaders: {} },
@@ -1490,8 +1490,8 @@ class Payment {
1490
1490
  * @param {import("../ApplicationAPIClient").Options} - Options
1491
1491
  * @returns {Promise<PaymentApplicationModel.TransferModeResponse>} - Success response
1492
1492
  * @name getActiveRefundTransferModes
1493
- * @summary: Refund modes
1494
- * @description: Lists the active transfer modes for refunds. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getActiveRefundTransferModes/).
1493
+ * @summary: Get refund transfer modes
1494
+ * @description: Lists the available refund modes, such as UPI, providing details like display name, logo, and ID for each mode - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getActiveRefundTransferModes/).
1495
1495
  */
1496
1496
  async getActiveRefundTransferModes(
1497
1497
  { requestHeaders } = { requestHeaders: {} },
@@ -1570,8 +1570,8 @@ class Payment {
1570
1570
  * @param {import("../ApplicationAPIClient").Options} - Options
1571
1571
  * @returns {Promise<PaymentApplicationModel.ListCardsResponse>} - Success response
1572
1572
  * @name getActiveUserCards
1573
- * @summary: List user's cards
1574
- * @description: Retrieves all active cards linked to a user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getActiveUserCards/).
1573
+ * @summary: Get customer cards
1574
+ * @description: Retrieves a list of all active cards saved by the user.Includes details such as the card's aggregator name, card ID, token, reference, number, expiration date, type, issuer, brand, nickname, and whether it has expired. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getActiveUserCards/).
1575
1575
  */
1576
1576
  async getActiveUserCards(
1577
1577
  { forceRefresh, requestHeaders } = { requestHeaders: {} },
@@ -1651,8 +1651,8 @@ class Payment {
1651
1651
  * - Success response
1652
1652
  *
1653
1653
  * @name getAggregatorsConfig
1654
- * @summary: Fetch payment aggregators
1655
- * @description: Retrieves configuration details for available payment aggregators. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getAggregatorsConfig/).
1654
+ * @summary: Get payment aggregators
1655
+ * @description: Retrieve the aggregator secret key of all payment gateways utilized for payments when using the SDK for the payment gateway - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getAggregatorsConfig/).
1656
1656
  */
1657
1657
  async getAggregatorsConfig(
1658
1658
  { xApiToken, refresh, requestHeaders } = { requestHeaders: {} },
@@ -1736,8 +1736,8 @@ class Payment {
1736
1736
  * @returns {Promise<PaymentApplicationModel.EpaylaterBannerResponse>} -
1737
1737
  * Success response
1738
1738
  * @name getEpaylaterBannerDetails
1739
- * @summary: Epay banner info
1740
- * @description: Gets details for displaying the Epaylater payment banner. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getEpaylaterBannerDetails/).
1739
+ * @summary: Epaylater banner info
1740
+ * @description: Retrieves details required to display the Epaylater payment banner. It provides information about the banner's display status, along with relevant messages and the user's registration status. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getEpaylaterBannerDetails/).
1741
1741
  */
1742
1742
  async getEpaylaterBannerDetails(
1743
1743
  { requestHeaders } = { requestHeaders: {} },
@@ -1819,8 +1819,8 @@ class Payment {
1819
1819
  * @returns {Promise<PaymentApplicationModel.OrderBeneficiaryResponse>} -
1820
1820
  * Success response
1821
1821
  * @name getOrderBeneficiariesDetail
1822
- * @summary: Order beneficiaries
1823
- * @description: Retrieve the beneficiary details related to an order. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getOrderBeneficiariesDetail/).
1822
+ * @summary: Retrieve beneficiary details
1823
+ * @description: Retrieve beneficiary details like bank name , ifsc code , branch name associated with a specific order for refund processing - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getOrderBeneficiariesDetail/).
1824
1824
  */
1825
1825
  async getOrderBeneficiariesDetail(
1826
1826
  { orderId, requestHeaders } = { requestHeaders: {} },
@@ -1901,7 +1901,7 @@ class Payment {
1901
1901
  * @returns {Promise<PaymentApplicationModel.GetPaymentLinkResponse>} -
1902
1902
  * Success response
1903
1903
  * @name getPaymentLink
1904
- * @summary: Fetch payment link
1904
+ * @summary: Get payment link
1905
1905
  * @description: Retrieves a generated payment link. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getPaymentLink/).
1906
1906
  */
1907
1907
  async getPaymentLink(
@@ -1982,7 +1982,7 @@ class Payment {
1982
1982
  * Success response
1983
1983
  * @name getPaymentModeRoutes
1984
1984
  * @summary: Get payment modes
1985
- * @description: Lists the payment mode options and their routing details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getPaymentModeRoutes/).
1985
+ * @description: Available payment methods on the payment page, specifying the aggregator for each option, such as 'Netbanking powered by Juspay' and 'Card powered by Razorpay'. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getPaymentModeRoutes/).
1986
1986
  */
1987
1987
  async getPaymentModeRoutes(
1988
1988
  {
@@ -2108,7 +2108,7 @@ class Payment {
2108
2108
  * @returns {Promise<PaymentApplicationModel.PaymentModeRouteResponse>} -
2109
2109
  * Success response
2110
2110
  * @name getPaymentModeRoutesPaymentLink
2111
- * @summary: Payment link modes
2111
+ * @summary: Payment modes for payment link
2112
2112
  * @description: Lists payment modes available for a given payment link. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getPaymentModeRoutesPaymentLink/).
2113
2113
  */
2114
2114
  async getPaymentModeRoutesPaymentLink(
@@ -2191,7 +2191,7 @@ class Payment {
2191
2191
  * Success response
2192
2192
  * @name getPosPaymentModeRoutes
2193
2193
  * @summary: POS payment modes
2194
- * @description: Lists payment modes available for Point-of-Sale (POS). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getPosPaymentModeRoutes/).
2194
+ * @description: Available payment methods on the payment page for POS, specifying the aggregator for each option, such as 'CARD powered by Juspay' and 'QR powered by Razorpay'. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getPosPaymentModeRoutes/).
2195
2195
  */
2196
2196
  async getPosPaymentModeRoutes(
2197
2197
  {
@@ -2307,7 +2307,7 @@ class Payment {
2307
2307
  * @returns {Promise<PaymentApplicationModel.RupifiBannerResponse>} - Success response
2308
2308
  * @name getRupifiBannerDetails
2309
2309
  * @summary: Rupifi banner info
2310
- * @description: Retrieve details for displaying the Rupifi payment banner. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getRupifiBannerDetails/).
2310
+ * @description: Retrieves details necessary for displaying the Rupifi payment banner. It provides information such as the KYC URL and the current status of the Rupifi payment banner. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getRupifiBannerDetails/).
2311
2311
  */
2312
2312
  async getRupifiBannerDetails(
2313
2313
  { requestHeaders } = { requestHeaders: {} },
@@ -2389,8 +2389,8 @@ class Payment {
2389
2389
  * @returns {Promise<PaymentApplicationModel.OrderBeneficiaryResponse>} -
2390
2390
  * Success response
2391
2391
  * @name getUserBeneficiariesDetail
2392
- * @summary: Beneficiary info
2393
- * @description: Retrieves details of beneficiaries linked to the user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getUserBeneficiariesDetail/).
2392
+ * @summary: Retrieve beneficiary details
2393
+ * @description: Retrieves information about beneficiaries associated with the user for processing refunds, based on the provided order ID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getUserBeneficiariesDetail/).
2394
2394
  */
2395
2395
  async getUserBeneficiariesDetail(
2396
2396
  { orderId, requestHeaders } = { requestHeaders: {} },
@@ -2473,7 +2473,7 @@ class Payment {
2473
2473
  *
2474
2474
  * @name initialisePayment
2475
2475
  * @summary: Start payment process
2476
- * @description: Initializes the payment procedure for an order. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/initialisePayment/).
2476
+ * @description: Initiates the payment procedure for an order.Upon successful initiation, it returns a details including the success status, aggregator information, payment method, status, merchant order ID aggregator order , polling URL, timeout, virtual ID, Razorpay payment ID, customer ID, and device ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/initialisePayment/).
2477
2477
  */
2478
2478
  async initialisePayment(
2479
2479
  { body, requestHeaders } = { requestHeaders: {} },
@@ -2554,8 +2554,8 @@ class Payment {
2554
2554
  * - Success response
2555
2555
  *
2556
2556
  * @name initialisePaymentPaymentLink
2557
- * @summary: Initialise link payment
2558
- * @description: Initializes payment for an order via a payment link. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/initialisePaymentPaymentLink/).
2557
+ * @summary: Initialize payment link
2558
+ * @description: Begins the payment process for an order by initializing it through a payment link.Upon successful initialization, the response includes details about the payment status, aggregator details, order IDs, polling URL for status updates, and other relevant information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/initialisePaymentPaymentLink/).
2559
2559
  */
2560
2560
  async initialisePaymentPaymentLink(
2561
2561
  { body, requestHeaders } = { requestHeaders: {} },
@@ -2634,8 +2634,8 @@ class Payment {
2634
2634
  * @param {import("../ApplicationAPIClient").Options} - Options
2635
2635
  * @returns {Promise<PaymentApplicationModel.WalletResponseSchema>} - Success response
2636
2636
  * @name linkWallet
2637
- * @summary: OTP verification for linking of wallet
2638
- * @description: It Verifies the linking of wallet using OTP - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/linkWallet/).
2637
+ * @summary: OTP verification
2638
+ * @description: Verifies the linking of wallet using OTP for further processing of payment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/linkWallet/).
2639
2639
  */
2640
2640
  async linkWallet(
2641
2641
  { body, requestHeaders } = { requestHeaders: {} },
@@ -2715,7 +2715,7 @@ class Payment {
2715
2715
  *
2716
2716
  * @name outstandingOrderDetails
2717
2717
  * @summary: Outstanding orders
2718
- * @description: Lists details of orders with outstanding payments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/outstandingOrderDetails/).
2718
+ * @description: Retrieve details of orders with outstanding payments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/outstandingOrderDetails/).
2719
2719
  */
2720
2720
  async outstandingOrderDetails(
2721
2721
  { aggregator, requestHeaders } = { requestHeaders: {} },
@@ -2796,8 +2796,8 @@ class Payment {
2796
2796
  * @returns {Promise<PaymentApplicationModel.PaidOrderDetailsResponse>} -
2797
2797
  * Success response
2798
2798
  * @name paidOrderDetails
2799
- * @summary: Paid orders
2800
- * @description: Retrieves details of orders that have been paid for. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/paidOrderDetails/).
2799
+ * @summary: Retrieve details of paid orders
2800
+ * @description: Retrieves details of orders that have been paid for, including shipment ID, order ID, due date, payment date, amount, and transaction ID, based on the aggregator's merchant user ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/paidOrderDetails/).
2801
2801
  */
2802
2802
  async paidOrderDetails(
2803
2803
  { aggregator, requestHeaders } = { requestHeaders: {} },
@@ -2876,8 +2876,8 @@ class Payment {
2876
2876
  * @returns {Promise<PaymentApplicationModel.PollingPaymentLinkResponse>} -
2877
2877
  * Success response
2878
2878
  * @name pollingPaymentLink
2879
- * @summary: Poll payment link
2880
- * @description: Polls the status of a payment link for updates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/pollingPaymentLink/).
2879
+ * @summary: Poll status of payment link
2880
+ * @description: Periodically checks the status of a payment link to monitor for any updates or changes.retrieve real-time information about the payment link's current status, such as whether it has been processed, cancelled, or expired. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/pollingPaymentLink/).
2881
2881
  */
2882
2882
  async pollingPaymentLink(
2883
2883
  { paymentLinkId, requestHeaders } = { requestHeaders: {} },
@@ -2957,8 +2957,8 @@ class Payment {
2957
2957
  * - Success response
2958
2958
  *
2959
2959
  * @name redirectToAggregator
2960
- * @summary: Redirect for payment
2961
- * @description: Redirects the user to the payment aggregator's interface. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/redirectToAggregator/).
2960
+ * @summary: Redirects users to the payment aggregator's interface
2961
+ * @description: Redirects users to the payment aggregator's interface and provides necessary parameters such as the callback URL and aggregator name. Returns the status of the payment along with the redirect URL and signup URL. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/redirectToAggregator/).
2962
2962
  */
2963
2963
  async redirectToAggregator(
2964
2964
  { source, aggregator, requestHeaders } = { requestHeaders: {} },
@@ -3040,7 +3040,7 @@ class Payment {
3040
3040
  * @returns {Promise<PaymentApplicationModel.renderHTMLResponse>} - Success response
3041
3041
  * @name renderHTML
3042
3042
  * @summary: Render HTML
3043
- * @description: Generates HTML for payment-related interfaces. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/renderHTML/).
3043
+ * @description: Render HTML for a payment aggregator page - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/renderHTML/).
3044
3044
  */
3045
3045
  async renderHTML(
3046
3046
  { body, requestHeaders } = { requestHeaders: {} },
@@ -3119,8 +3119,8 @@ class Payment {
3119
3119
  * - Success response
3120
3120
  *
3121
3121
  * @name resendOrCancelPayment
3122
- * @summary: Manage payment
3123
- * @description: Resends or cancels a pending payment transaction. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/resendOrCancelPayment/).
3122
+ * @summary: Resend or cancel a pending payment transaction
3123
+ * @description: Enable you to perform actions related to the resending and cancellation of payment links through SMS or E-mail. Resend or cancel payment link that have been initiated but may require modification or cancellation for various reasons, ensuring flexibility and control in payment processing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/resendOrCancelPayment/).
3124
3124
  */
3125
3125
  async resendOrCancelPayment(
3126
3126
  { body, requestHeaders } = { requestHeaders: {} },
@@ -3200,8 +3200,8 @@ class Payment {
3200
3200
  * @returns {Promise<PaymentApplicationModel.ResendPaymentLinkResponse>} -
3201
3201
  * Success response
3202
3202
  * @name resendPaymentLink
3203
- * @summary: Resend link
3204
- * @description: Resends an existing payment link to the user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/resendPaymentLink/).
3203
+ * @summary: Resend payment link
3204
+ * @description: Resends an existing payment link to the user to complete the payment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/resendPaymentLink/).
3205
3205
  */
3206
3206
  async resendPaymentLink(
3207
3207
  { body, requestHeaders } = { requestHeaders: {} },
@@ -3281,8 +3281,8 @@ class Payment {
3281
3281
  * - Success response
3282
3282
  *
3283
3283
  * @name updateDefaultBeneficiary
3284
- * @summary: Set default beneficiary
3285
- * @description: Updates the default beneficiary for the user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/updateDefaultBeneficiary/).
3284
+ * @summary: Set default beneficiary for refund
3285
+ * @description: Updates the default beneficiary for the order refund of the user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/updateDefaultBeneficiary/).
3286
3286
  */
3287
3287
  async updateDefaultBeneficiary(
3288
3288
  { body, requestHeaders } = { requestHeaders: {} },
@@ -3362,7 +3362,7 @@ class Payment {
3362
3362
  * @returns {Promise<PaymentApplicationModel.ValidateVPAResponse>} - Success response
3363
3363
  * @name validateVPA
3364
3364
  * @summary: Validate VPA
3365
- * @description: Checks the validity of a Virtual Payment Address (VPA). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/validateVPA/).
3365
+ * @description: Checks whether a Virtual Payment Address (VPA) is valid for processing payments and returns the validation result.is_valid boolean value indicating whether the VPA is valid for payments - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/validateVPA/).
3366
3366
  */
3367
3367
  async validateVPA(
3368
3368
  { body, requestHeaders } = { requestHeaders: {} },
@@ -3440,8 +3440,8 @@ class Payment {
3440
3440
  * @returns {Promise<PaymentApplicationModel.ChargeCustomerResponse>} -
3441
3441
  * Success response
3442
3442
  * @name verifyAndChargePayment
3443
- * @summary: Verify and charge
3444
- * @description: Validates and processes a payment transaction. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/verifyAndChargePayment/).
3443
+ * @summary: Verify order confirmation and charge
3444
+ * @description: Verify the payment status and charge from the customer's BNPL (Buy Now, Pay Later) account after order confirmation. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/verifyAndChargePayment/).
3445
3445
  */
3446
3446
  async verifyAndChargePayment(
3447
3447
  { body, requestHeaders } = { requestHeaders: {} },
@@ -3523,7 +3523,7 @@ class Payment {
3523
3523
  * Success response
3524
3524
  * @name verifyCustomerForPayment
3525
3525
  * @summary: Verify payment customer
3526
- * @description: Checks the user's validity for proceeding with payment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/verifyCustomerForPayment/).
3526
+ * @description: Verify whether the user is eligible for pay-later payment from the payment aggregator's side using the customer's phone number - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/verifyCustomerForPayment/).
3527
3527
  */
3528
3528
  async verifyCustomerForPayment(
3529
3529
  { body, requestHeaders } = { requestHeaders: {} },
@@ -3603,7 +3603,7 @@ class Payment {
3603
3603
  * @returns {Promise<PaymentApplicationModel.IfscCodeResponse>} - Success response
3604
3604
  * @name verifyIfscCode
3605
3605
  * @summary: Verify IFSC
3606
- * @description: Checks the validity of an IFSC code for bank transactions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/verifyIfscCode/).
3606
+ * @description: Checks the validity of the provided IFSC code and returns bank details if valid. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/verifyIfscCode/).
3607
3607
  */
3608
3608
  async verifyIfscCode(
3609
3609
  { ifscCode, requestHeaders } = { requestHeaders: {} },
@@ -3685,8 +3685,8 @@ class Payment {
3685
3685
  * - Success response
3686
3686
  *
3687
3687
  * @name verifyOtpAndAddBeneficiaryForBank
3688
- * @summary: Verify OTP for bank
3689
- * @description: Confirms OTP and adds a bank beneficiary. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/verifyOtpAndAddBeneficiaryForBank/).
3688
+ * @summary: Verify OTP for bank and add beneficiary
3689
+ * @description: This endpoint confirms the OTP provided by the user and adds a bank beneficiary for refund processing - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/verifyOtpAndAddBeneficiaryForBank/).
3690
3690
  */
3691
3691
  async verifyOtpAndAddBeneficiaryForBank(
3692
3692
  { body, requestHeaders } = { requestHeaders: {} },
@@ -3768,7 +3768,7 @@ class Payment {
3768
3768
  * @returns {Promise<PaymentApplicationModel.WalletOtpResponse>} - Success response
3769
3769
  * @name verifyOtpAndAddBeneficiaryForWallet
3770
3770
  * @summary: Verify OTP for wallet
3771
- * @description: Confirms OTP and adds a wallet beneficiary. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/verifyOtpAndAddBeneficiaryForWallet/).
3771
+ * @description: Confirm OTP provided by the user and adds a wallet beneficiary - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/verifyOtpAndAddBeneficiaryForWallet/).
3772
3772
  */
3773
3773
  async verifyOtpAndAddBeneficiaryForWallet(
3774
3774
  { body, requestHeaders } = { requestHeaders: {} },
@@ -3848,7 +3848,7 @@ class Payment {
3848
3848
  * @returns {Promise<PaymentApplicationModel.WalletResponseSchema>} - Success response
3849
3849
  * @name walletLinkInitiate
3850
3850
  * @summary: Initiate linking of wallet
3851
- * @description: It will initiate linking of wallet for the aggregator. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/walletLinkInitiate/).
3851
+ * @description: Link wallet for the aggregator for processing of payment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/walletLinkInitiate/).
3852
3852
  */
3853
3853
  async walletLinkInitiate(
3854
3854
  { body, requestHeaders } = { requestHeaders: {} },
@@ -30,7 +30,7 @@ declare class Rewards {
30
30
  * @param {import("../ApplicationAPIClient").Options} - Options
31
31
  * @returns {Promise<RewardsApplicationModel.Offer>} - Success response
32
32
  * @name getOfferByName
33
- * @summary: Fetch specific offer
33
+ * @summary: Get specific offer
34
34
  * @description: Retrieves detailed information about an offer by its name. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/rewards/getOfferByName/).
35
35
  */
36
36
  getOfferByName({ name, requestHeaders }?: RewardsApplicationValidator.GetOfferByNameParam, { responseHeaders }?: object): Promise<RewardsApplicationModel.Offer>;
@@ -128,7 +128,7 @@ class Rewards {
128
128
  * @param {import("../ApplicationAPIClient").Options} - Options
129
129
  * @returns {Promise<RewardsApplicationModel.Offer>} - Success response
130
130
  * @name getOfferByName
131
- * @summary: Fetch specific offer
131
+ * @summary: Get specific offer
132
132
  * @description: Retrieves detailed information about an offer by its name. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/rewards/getOfferByName/).
133
133
  */
134
134
  async getOfferByName(
@@ -70,7 +70,7 @@ declare class Share {
70
70
  * @param {import("../ApplicationAPIClient").Options} - Options
71
71
  * @returns {Promise<ShareApplicationModel.ShortLinkRes>} - Success response
72
72
  * @name getShortLinkByHash
73
- * @summary: Fetch short link
73
+ * @summary: Get short link
74
74
  * @description: Retrieves a previously created short link using its hash identifier. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/share/getShortLinkByHash/).
75
75
  */
76
76
  getShortLinkByHash({ hash, requestHeaders }?: ShareApplicationValidator.GetShortLinkByHashParam, { responseHeaders }?: object): Promise<ShareApplicationModel.ShortLinkRes>;
@@ -445,7 +445,7 @@ class Share {
445
445
  * @param {import("../ApplicationAPIClient").Options} - Options
446
446
  * @returns {Promise<ShareApplicationModel.ShortLinkRes>} - Success response
447
447
  * @name getShortLinkByHash
448
- * @summary: Fetch short link
448
+ * @summary: Get short link
449
449
  * @description: Retrieves a previously created short link using its hash identifier. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/share/getShortLinkByHash/).
450
450
  */
451
451
  async getShortLinkByHash(
@@ -55,6 +55,7 @@ export = ShareApplicationModel;
55
55
  * @typedef UrlInfo
56
56
  * @property {string} [original]
57
57
  * @property {string} [hash]
58
+ * @property {string} [short_url]
58
59
  */
59
60
  /**
60
61
  * @typedef ShortLinkRes
@@ -162,6 +163,7 @@ declare function UrlInfo(): UrlInfo;
162
163
  type UrlInfo = {
163
164
  original?: string;
164
165
  hash?: string;
166
+ short_url?: string;
165
167
  };
166
168
  /** @returns {ShortLinkRes} */
167
169
  declare function ShortLinkRes(): ShortLinkRes;
@@ -64,6 +64,7 @@ const Joi = require("joi");
64
64
  * @typedef UrlInfo
65
65
  * @property {string} [original]
66
66
  * @property {string} [hash]
67
+ * @property {string} [short_url]
67
68
  */
68
69
 
69
70
  /**
@@ -177,6 +178,7 @@ class ShareApplicationModel {
177
178
  return Joi.object({
178
179
  original: Joi.string().allow(""),
179
180
  hash: Joi.string().allow(""),
181
+ short_url: Joi.string().allow(""),
180
182
  });
181
183
  }
182
184
 
@@ -16,8 +16,8 @@ declare class Theme {
16
16
  * @param {import("../ApplicationAPIClient").Options} - Options
17
17
  * @returns {Promise<ThemeApplicationModel.AllAvailablePageSchema>} - Success response
18
18
  * @name getAllPages
19
- * @summary: Fetch all pages
20
- * @description: Retrieves a list of all the pages available within the applied theme. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/theme/getAllPages/).
19
+ * @summary: List pages
20
+ * @description: Get all page level configs, sections and SEO data of a theme - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/theme/getAllPages/).
21
21
  */
22
22
  getAllPages({ themeId, requestHeaders }?: ThemeApplicationValidator.GetAllPagesParam, { responseHeaders }?: object): Promise<ThemeApplicationModel.AllAvailablePageSchema>;
23
23
  /**
@@ -26,8 +26,8 @@ declare class Theme {
26
26
  * @param {import("../ApplicationAPIClient").Options} - Options
27
27
  * @returns {Promise<ThemeApplicationModel.ThemesSchema>} - Success response
28
28
  * @name getAppliedTheme
29
- * @summary: Current theme
30
- * @description: Gets the theme currently applied to the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/theme/getAppliedTheme/).
29
+ * @summary: Get applied theme
30
+ * @description: Gets the theme configuration and template details of a theme applied to the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/theme/getAppliedTheme/).
31
31
  */
32
32
  getAppliedTheme({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ThemeApplicationModel.ThemesSchema>;
33
33
  /**
@@ -36,8 +36,8 @@ declare class Theme {
36
36
  * @param {import("../ApplicationAPIClient").Options} - Options
37
37
  * @returns {Promise<ThemeApplicationModel.AvailablePageSchema>} - Success response
38
38
  * @name getPage
39
- * @summary: Single page details
40
- * @description: Retrieve detailed information for a specific page within the theme. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/theme/getPage/).
39
+ * @summary: Get theme page
40
+ * @description: Get page level configurations, applied sections and SEO data of a page by `page_value` received from list pages API - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/theme/getPage/).
41
41
  */
42
42
  getPage({ themeId, pageValue, filters, company, requestHeaders }?: ThemeApplicationValidator.GetPageParam, { responseHeaders }?: object): Promise<ThemeApplicationModel.AvailablePageSchema>;
43
43
  /**
@@ -46,8 +46,8 @@ declare class Theme {
46
46
  * @param {import("../ApplicationAPIClient").Options} - Options
47
47
  * @returns {Promise<ThemeApplicationModel.ThemesSchema>} - Success response
48
48
  * @name getThemeForPreview
49
- * @summary: Preview theme
50
- * @description: Retrieves a theme for previewing before applying it to the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/theme/getThemeForPreview/).
49
+ * @summary: Get theme for preview
50
+ * @description: Gets the theme configuration and template details of a theme by theme Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/theme/getThemeForPreview/).
51
51
  */
52
52
  getThemeForPreview({ themeId, requestHeaders }?: ThemeApplicationValidator.GetThemeForPreviewParam, { responseHeaders }?: object): Promise<ThemeApplicationModel.ThemesSchema>;
53
53
  }
@@ -41,8 +41,8 @@ class Theme {
41
41
  * @param {import("../ApplicationAPIClient").Options} - Options
42
42
  * @returns {Promise<ThemeApplicationModel.AllAvailablePageSchema>} - Success response
43
43
  * @name getAllPages
44
- * @summary: Fetch all pages
45
- * @description: Retrieves a list of all the pages available within the applied theme. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/theme/getAllPages/).
44
+ * @summary: List pages
45
+ * @description: Get all page level configs, sections and SEO data of a theme - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/theme/getAllPages/).
46
46
  */
47
47
  async getAllPages(
48
48
  { themeId, requestHeaders } = { requestHeaders: {} },
@@ -119,8 +119,8 @@ class Theme {
119
119
  * @param {import("../ApplicationAPIClient").Options} - Options
120
120
  * @returns {Promise<ThemeApplicationModel.ThemesSchema>} - Success response
121
121
  * @name getAppliedTheme
122
- * @summary: Current theme
123
- * @description: Gets the theme currently applied to the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/theme/getAppliedTheme/).
122
+ * @summary: Get applied theme
123
+ * @description: Gets the theme configuration and template details of a theme applied to the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/theme/getAppliedTheme/).
124
124
  */
125
125
  async getAppliedTheme(
126
126
  { requestHeaders } = { requestHeaders: {} },
@@ -197,8 +197,8 @@ class Theme {
197
197
  * @param {import("../ApplicationAPIClient").Options} - Options
198
198
  * @returns {Promise<ThemeApplicationModel.AvailablePageSchema>} - Success response
199
199
  * @name getPage
200
- * @summary: Single page details
201
- * @description: Retrieve detailed information for a specific page within the theme. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/theme/getPage/).
200
+ * @summary: Get theme page
201
+ * @description: Get page level configurations, applied sections and SEO data of a page by `page_value` received from list pages API - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/theme/getPage/).
202
202
  */
203
203
  async getPage(
204
204
  { themeId, pageValue, filters, company, requestHeaders } = {
@@ -277,8 +277,8 @@ class Theme {
277
277
  * @param {import("../ApplicationAPIClient").Options} - Options
278
278
  * @returns {Promise<ThemeApplicationModel.ThemesSchema>} - Success response
279
279
  * @name getThemeForPreview
280
- * @summary: Preview theme
281
- * @description: Retrieves a theme for previewing before applying it to the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/theme/getThemeForPreview/).
280
+ * @summary: Get theme for preview
281
+ * @description: Gets the theme configuration and template details of a theme by theme Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/theme/getThemeForPreview/).
282
282
  */
283
283
  async getThemeForPreview(
284
284
  { themeId, requestHeaders } = { requestHeaders: {} },