@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
@@ -108,7 +108,7 @@ class User {
108
108
  * @param {import("../ApplicationAPIClient").Options} - Options
109
109
  * @returns {Promise<UserApplicationModel.VerifyEmailOTPSuccess>} - Success response
110
110
  * @name addEmail
111
- * @summary: Add email
111
+ * @summary: Add Email to Profile
112
112
  * @description: Adds a new email address to the user's profile. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/addEmail/).
113
113
  */
114
114
  async addEmail(
@@ -185,7 +185,7 @@ class User {
185
185
  * @param {import("../ApplicationAPIClient").Options} - Options
186
186
  * @returns {Promise<UserApplicationModel.VerifyMobileOTPSuccess>} - Success response
187
187
  * @name addMobileNumber
188
- * @summary: Add mobile
188
+ * @summary: Add Mobile Number to Profile
189
189
  * @description: Adds a new mobile number to the user's profile. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/addMobileNumber/).
190
190
  */
191
191
  async addMobileNumber(
@@ -264,8 +264,8 @@ class User {
264
264
  * @param {import("../ApplicationAPIClient").Options} - Options
265
265
  * @returns {Promise<UserApplicationModel.LoginSuccess>} - Success response
266
266
  * @name deleteEmail
267
- * @summary: Delete email
268
- * @description: Removes an email address from the user's profile. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/deleteEmail/).
267
+ * @summary: Delete Email From Profile
268
+ * @description: Delete Email From Profile - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/deleteEmail/).
269
269
  */
270
270
  async deleteEmail(
271
271
  { active, primary, verified, email, platform, requestHeaders } = {
@@ -347,8 +347,8 @@ class User {
347
347
  * @param {import("../ApplicationAPIClient").Options} - Options
348
348
  * @returns {Promise<UserApplicationModel.LoginSuccess>} - Success response
349
349
  * @name deleteMobileNumber
350
- * @summary: Delete mobile number from profile
351
- * @description: Use this API to delete a mobile number from a profile. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/deleteMobileNumber/).
350
+ * @summary: Delete Mobile Number From Profile
351
+ * @description: Delete Mobile Number From Profile. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/deleteMobileNumber/).
352
352
  */
353
353
  async deleteMobileNumber(
354
354
  {
@@ -439,8 +439,8 @@ class User {
439
439
  * @param {import("../ApplicationAPIClient").Options} - Options
440
440
  * @returns {Promise<UserApplicationModel.DeleteUserSuccess>} - Success response
441
441
  * @name deleteUser
442
- * @summary: verify otp and delete user
443
- * @description: verify otp and delete user - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/deleteUser/).
442
+ * @summary: Verify OTP and Delete User
443
+ * @description: Verify OTP sent to mobile/email and Delete the user's account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/deleteUser/).
444
444
  */
445
445
  async deleteUser(
446
446
  { body, requestHeaders } = { requestHeaders: {} },
@@ -515,8 +515,8 @@ class User {
515
515
  * @param {import("../ApplicationAPIClient").Options} - Options
516
516
  * @returns {Promise<UserApplicationModel.LoginSuccess>} - Success response
517
517
  * @name forgotPassword
518
- * @summary: Forgot password
519
- * @description: Initiates the password recovery process for the user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/forgotPassword/).
518
+ * @summary: Reset Password via Code and login
519
+ * @description: Reset a password using the code sent on email or SMS the Login. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/forgotPassword/).
520
520
  */
521
521
  async forgotPassword(
522
522
  { body, requestHeaders } = { requestHeaders: {} },
@@ -593,8 +593,8 @@ class User {
593
593
  * @param {import("../ApplicationAPIClient").Options} - Options
594
594
  * @returns {Promise<UserApplicationModel.SessionListSuccess>} - Success response
595
595
  * @name getListOfActiveSessions
596
- * @summary: Get list of sessions
597
- * @description: Use this API to retrieve all active sessions of a user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/getListOfActiveSessions/).
596
+ * @summary: Get List OF Active Sessions
597
+ * @description: Retrieve all active sessions of a user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/getListOfActiveSessions/).
598
598
  */
599
599
  async getListOfActiveSessions(
600
600
  { requestHeaders } = { requestHeaders: {} },
@@ -673,7 +673,7 @@ class User {
673
673
  * @param {import("../ApplicationAPIClient").Options} - Options
674
674
  * @returns {Promise<UserApplicationModel.UserObjectSchema>} - Success response
675
675
  * @name getLoggedInUser
676
- * @summary: Current user
676
+ * @summary: Get Logged in User
677
677
  * @description: Retrieve information about the currently logged-in user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/getLoggedInUser/).
678
678
  */
679
679
  async getLoggedInUser(
@@ -751,8 +751,8 @@ class User {
751
751
  * @param {import("../ApplicationAPIClient").Options} - Options
752
752
  * @returns {Promise<UserApplicationModel.PlatformSchema>} - Success response
753
753
  * @name getPlatformConfig
754
- * @summary: Platform config
755
- * @description: Retrieve configuration settings related to the user platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/getPlatformConfig/).
754
+ * @summary: Get Platform Configuration
755
+ * @description: Retrieve platform sales channel authentication configuration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/getPlatformConfig/).
756
756
  */
757
757
  async getPlatformConfig(
758
758
  { name, requestHeaders } = { requestHeaders: {} },
@@ -830,8 +830,8 @@ class User {
830
830
  * @param {import("../ApplicationAPIClient").Options} - Options
831
831
  * @returns {Promise<UserApplicationModel.UserAttributes>} - Success response
832
832
  * @name getUserAttributes
833
- * @summary: Get user attributes
834
- * @description: Use this API to get the list of user attributes - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/getUserAttributes/).
833
+ * @summary: Get User Attributes
834
+ * @description: Get the list of user attributes - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/getUserAttributes/).
835
835
  */
836
836
  async getUserAttributes(
837
837
  { slug, requestHeaders } = { requestHeaders: {} },
@@ -909,8 +909,8 @@ class User {
909
909
  * @param {import("../ApplicationAPIClient").Options} - Options
910
910
  * @returns {Promise<UserApplicationModel.HasPasswordSuccess>} - Success response
911
911
  * @name hasPassword
912
- * @summary: Check password
913
- * @description: Checks if the user has set a password for the account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/hasPassword/).
912
+ * @summary: Check Password Existence
913
+ * @description: Check if user has set an account password - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/hasPassword/).
914
914
  */
915
915
  async hasPassword(
916
916
  { requestHeaders } = { requestHeaders: {} },
@@ -985,8 +985,8 @@ class User {
985
985
  * @param {import("../ApplicationAPIClient").Options} - Options
986
986
  * @returns {Promise<UserApplicationModel.AuthSuccess>} - Success response
987
987
  * @name loginWithAppleIOS
988
- * @summary: Apple iOS login
989
- * @description: Enables login through Apple ID specifically for iOS users. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/loginWithAppleIOS/).
988
+ * @summary: iOS Login with Apple
989
+ * @description: Enables iOS users to log in to the system using their Apple ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/loginWithAppleIOS/).
990
990
  */
991
991
  async loginWithAppleIOS(
992
992
  { body, platform, requestHeaders } = { requestHeaders: {} },
@@ -1064,8 +1064,8 @@ class User {
1064
1064
  * @param {import("../ApplicationAPIClient").Options} - Options
1065
1065
  * @returns {Promise<UserApplicationModel.LoginSuccess>} - Success response
1066
1066
  * @name loginWithEmailAndPassword
1067
- * @summary: Email/password login
1068
- * @description: Enables login using an email and password combination. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/loginWithEmailAndPassword/).
1067
+ * @summary: Email and Password Login
1068
+ * @description: Allows login using an email and password combination. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/loginWithEmailAndPassword/).
1069
1069
  */
1070
1070
  async loginWithEmailAndPassword(
1071
1071
  { body, requestHeaders } = { requestHeaders: {} },
@@ -1144,8 +1144,8 @@ class User {
1144
1144
  * @param {import("../ApplicationAPIClient").Options} - Options
1145
1145
  * @returns {Promise<UserApplicationModel.AuthSuccess>} - Success response
1146
1146
  * @name loginWithFacebook
1147
- * @summary: Facebook login
1148
- * @description: Enables login through Facebook accounts. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/loginWithFacebook/).
1147
+ * @summary: Login with Facebook
1148
+ * @description: Enables users to log in to the system using their Facebook accounts. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/loginWithFacebook/).
1149
1149
  */
1150
1150
  async loginWithFacebook(
1151
1151
  { body, platform, requestHeaders } = { requestHeaders: {} },
@@ -1223,8 +1223,8 @@ class User {
1223
1223
  * @param {import("../ApplicationAPIClient").Options} - Options
1224
1224
  * @returns {Promise<UserApplicationModel.AuthSuccess>} - Success response
1225
1225
  * @name loginWithGoogle
1226
- * @summary: Google login
1227
- * @description: Enables login through Google accounts. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/loginWithGoogle/).
1226
+ * @summary: Login with Google
1227
+ * @description: Enables website users to log in to the system using their Google accounts. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/loginWithGoogle/).
1228
1228
  */
1229
1229
  async loginWithGoogle(
1230
1230
  { body, platform, requestHeaders } = { requestHeaders: {} },
@@ -1302,8 +1302,8 @@ class User {
1302
1302
  * @param {import("../ApplicationAPIClient").Options} - Options
1303
1303
  * @returns {Promise<UserApplicationModel.AuthSuccess>} - Success response
1304
1304
  * @name loginWithGoogleAndroid
1305
- * @summary: Android Google login
1306
- * @description: Facilitates Google login specifically for Android users. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/loginWithGoogleAndroid/).
1305
+ * @summary: Android Login with Google
1306
+ * @description: Enables Android users to log in to the system using their Facebook accounts. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/loginWithGoogleAndroid/).
1307
1307
  */
1308
1308
  async loginWithGoogleAndroid(
1309
1309
  { body, platform, requestHeaders } = { requestHeaders: {} },
@@ -1383,8 +1383,8 @@ class User {
1383
1383
  * @param {import("../ApplicationAPIClient").Options} - Options
1384
1384
  * @returns {Promise<UserApplicationModel.AuthSuccess>} - Success response
1385
1385
  * @name loginWithGoogleIOS
1386
- * @summary: iOS Google login
1387
- * @description: Facilitates Google login specifically for iOS users. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/loginWithGoogleIOS/).
1386
+ * @summary: iOS Login with Google
1387
+ * @description: Enables iOS users to log in to the system using their Facebook accounts. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/loginWithGoogleIOS/).
1388
1388
  */
1389
1389
  async loginWithGoogleIOS(
1390
1390
  { body, platform, requestHeaders } = { requestHeaders: {} },
@@ -1462,8 +1462,8 @@ class User {
1462
1462
  * @param {import("../ApplicationAPIClient").Options} - Options
1463
1463
  * @returns {Promise<UserApplicationModel.SendOtpResponse>} - Success response
1464
1464
  * @name loginWithOTP
1465
- * @summary: OTP login
1466
- * @description: Allows users to log in using a one-time password. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/loginWithOTP/).
1465
+ * @summary: Login with Mobile OTP
1466
+ * @description: Allows users to log in using a one-time password sent to their mobile - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/loginWithOTP/).
1467
1467
  */
1468
1468
  async loginWithOTP(
1469
1469
  { body, platform, requestHeaders } = { requestHeaders: {} },
@@ -1541,8 +1541,8 @@ class User {
1541
1541
  * @param {import("../ApplicationAPIClient").Options} - Options
1542
1542
  * @returns {Promise<UserApplicationModel.LoginSuccess>} - Success response
1543
1543
  * @name loginWithToken
1544
- * @summary: Login or Register with token
1545
- * @description: Use this API to login or register using a token for authentication. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/loginWithToken/).
1544
+ * @summary: Login with Token
1545
+ * @description: Login User using a token for authentication. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/loginWithToken/).
1546
1546
  */
1547
1547
  async loginWithToken(
1548
1548
  { body, requestHeaders } = { requestHeaders: {} },
@@ -1619,8 +1619,8 @@ class User {
1619
1619
  * @param {import("../ApplicationAPIClient").Options} - Options
1620
1620
  * @returns {Promise<UserApplicationModel.LogoutSuccess>} - Success response
1621
1621
  * @name logout
1622
- * @summary: Logs out currently logged in user
1623
- * @description: Use this API to check to logout a user from the app. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/logout/).
1622
+ * @summary: Logout Current User
1623
+ * @description: Logout currently logged-in user - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/logout/).
1624
1624
  */
1625
1625
  async logout(
1626
1626
  { requestHeaders } = { requestHeaders: {} },
@@ -1695,7 +1695,7 @@ class User {
1695
1695
  * @param {import("../ApplicationAPIClient").Options} - Options
1696
1696
  * @returns {Promise<UserApplicationModel.RegisterFormSuccess>} - Success response
1697
1697
  * @name registerWithForm
1698
- * @summary: User registration
1698
+ * @summary: Register User with Form
1699
1699
  * @description: Enables new users to register using a form. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/registerWithForm/).
1700
1700
  */
1701
1701
  async registerWithForm(
@@ -1775,8 +1775,8 @@ class User {
1775
1775
  * @returns {Promise<UserApplicationModel.ResetForgotPasswordSuccess>} -
1776
1776
  * Success response
1777
1777
  * @name resetForgotPassword
1778
- * @summary: Forgot password
1779
- * @description: Initiates the password recovery process for the user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/resetForgotPassword/).
1778
+ * @summary: Reset Password via Code
1779
+ * @description: Reset a password using the code sent on email or SMS. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/resetForgotPassword/).
1780
1780
  */
1781
1781
  async resetForgotPassword(
1782
1782
  { body, requestHeaders } = { requestHeaders: {} },
@@ -1853,8 +1853,8 @@ class User {
1853
1853
  * @param {import("../ApplicationAPIClient").Options} - Options
1854
1854
  * @returns {Promise<UserApplicationModel.EmailOtpSuccess>} - Success response
1855
1855
  * @name sendForgotOTPOnEmail
1856
- * @summary: Send Forgot OTP Email
1857
- * @description: Sends a one-time password to the user's forgot email for verification request. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/sendForgotOTPOnEmail/).
1856
+ * @summary: Send Email OTP for Forgot Password
1857
+ * @description: Sends a one-time password to the user's email for verification when resetting a forgotten password. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/sendForgotOTPOnEmail/).
1858
1858
  */
1859
1859
  async sendForgotOTPOnEmail(
1860
1860
  { body, platform, requestHeaders } = { requestHeaders: {} },
@@ -1932,8 +1932,8 @@ class User {
1932
1932
  * @param {import("../ApplicationAPIClient").Options} - Options
1933
1933
  * @returns {Promise<UserApplicationModel.OtpSuccess>} - Success response
1934
1934
  * @name sendForgotOTPOnMobile
1935
- * @summary: Send forgot OTP on mobile
1936
- * @description: Sends a one-time password to the user's forgot mobile for verification request. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/sendForgotOTPOnMobile/).
1935
+ * @summary: Send mobile OTP for forgot-password
1936
+ * @description: Sends a one-time password to the user's mobile for verification when resetting a forgotten password. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/sendForgotOTPOnMobile/).
1937
1937
  */
1938
1938
  async sendForgotOTPOnMobile(
1939
1939
  { body, platform, requestHeaders } = { requestHeaders: {} },
@@ -2011,7 +2011,7 @@ class User {
2011
2011
  * @param {import("../ApplicationAPIClient").Options} - Options
2012
2012
  * @returns {Promise<UserApplicationModel.EmailOtpSuccess>} - Success response
2013
2013
  * @name sendOTPOnEmail
2014
- * @summary: Send email OTP
2014
+ * @summary: Send OTP on Email
2015
2015
  * @description: Sends a one-time password to the user's email for verification. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/sendOTPOnEmail/).
2016
2016
  */
2017
2017
  async sendOTPOnEmail(
@@ -2090,7 +2090,7 @@ class User {
2090
2090
  * @param {import("../ApplicationAPIClient").Options} - Options
2091
2091
  * @returns {Promise<UserApplicationModel.OtpSuccess>} - Success response
2092
2092
  * @name sendOTPOnMobile
2093
- * @summary: Send mobile OTP
2093
+ * @summary: Send OTP on Mobile
2094
2094
  * @description: Sends a one-time password to the user's mobile for verification. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/sendOTPOnMobile/).
2095
2095
  */
2096
2096
  async sendOTPOnMobile(
@@ -2169,7 +2169,7 @@ class User {
2169
2169
  * @param {import("../ApplicationAPIClient").Options} - Options
2170
2170
  * @returns {Promise<UserApplicationModel.ResetPasswordSuccess>} - Success response
2171
2171
  * @name sendResetPasswordEmail
2172
- * @summary: Reset password (Email)
2172
+ * @summary: Reset Password via Email
2173
2173
  * @description: Sends a password reset link to the user's email. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/sendResetPasswordEmail/).
2174
2174
  */
2175
2175
  async sendResetPasswordEmail(
@@ -2250,8 +2250,8 @@ class User {
2250
2250
  * @param {import("../ApplicationAPIClient").Options} - Options
2251
2251
  * @returns {Promise<any>} - Success response
2252
2252
  * @name sendResetPasswordMobile
2253
- * @summary: Reset password (Mobile)
2254
- * @description: Sends a password reset OTP to the user's mobile number. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/sendResetPasswordMobile/).
2253
+ * @summary: Reset Password via Mobile
2254
+ * @description: Sends a password reset link to the user's Mobile. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/sendResetPasswordMobile/).
2255
2255
  */
2256
2256
  async sendResetPasswordMobile(
2257
2257
  { body, platform, requestHeaders } = { requestHeaders: {} },
@@ -2328,8 +2328,8 @@ class User {
2328
2328
  * @param {import("../ApplicationAPIClient").Options} - Options
2329
2329
  * @returns {Promise<UserApplicationModel.ResetPasswordSuccess>} - Success response
2330
2330
  * @name sendResetToken
2331
- * @summary: Reset Password using token
2332
- * @description: Use this API to send code to reset password. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/sendResetToken/).
2331
+ * @summary: Validate Password Reset Code
2332
+ * @description: Validate Password Reset link Code - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/sendResetToken/).
2333
2333
  */
2334
2334
  async sendResetToken(
2335
2335
  { body, requestHeaders } = { requestHeaders: {} },
@@ -2408,7 +2408,7 @@ class User {
2408
2408
  * @returns {Promise<UserApplicationModel.SendEmailVerifyLinkSuccess>} -
2409
2409
  * Success response
2410
2410
  * @name sendVerificationLinkToEmail
2411
- * @summary: Verify new email
2411
+ * @summary: Send Verification Link to Email
2412
2412
  * @description: Sends a verification link to a newly added email address. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/sendVerificationLinkToEmail/).
2413
2413
  */
2414
2414
  async sendVerificationLinkToEmail(
@@ -2492,7 +2492,7 @@ class User {
2492
2492
  * @returns {Promise<UserApplicationModel.SendMobileVerifyLinkSuccess>} -
2493
2493
  * Success response
2494
2494
  * @name sendVerificationLinkToMobile
2495
- * @summary: Verify new mobile
2495
+ * @summary: Send Verification Link to Mobile
2496
2496
  * @description: Sends a verification link to a newly added mobile number. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/sendVerificationLinkToMobile/).
2497
2497
  */
2498
2498
  async sendVerificationLinkToMobile(
@@ -2573,7 +2573,7 @@ class User {
2573
2573
  * @param {import("../ApplicationAPIClient").Options} - Options
2574
2574
  * @returns {Promise<UserApplicationModel.LoginSuccess>} - Success response
2575
2575
  * @name setEmailAsPrimary
2576
- * @summary: Set primary email
2576
+ * @summary: Set Email as Primary
2577
2577
  * @description: Sets an email address as the primary contact for the user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/setEmailAsPrimary/).
2578
2578
  */
2579
2579
  async setEmailAsPrimary(
@@ -2651,7 +2651,7 @@ class User {
2651
2651
  * @param {import("../ApplicationAPIClient").Options} - Options
2652
2652
  * @returns {Promise<UserApplicationModel.LoginSuccess>} - Success response
2653
2653
  * @name setMobileNumberAsPrimary
2654
- * @summary: Set primary mobile
2654
+ * @summary: Set Mobile as Primary
2655
2655
  * @description: Sets a mobile number as the primary contact for the user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/setMobileNumberAsPrimary/).
2656
2656
  */
2657
2657
  async setMobileNumberAsPrimary(
@@ -2731,8 +2731,8 @@ class User {
2731
2731
  * @param {import("../ApplicationAPIClient").Options} - Options
2732
2732
  * @returns {Promise<UserApplicationModel.VerifyEmailSuccess>} - Success response
2733
2733
  * @name updatePassword
2734
- * @summary: Update password
2735
- * @description: Allows users to update their existing password. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/updatePassword/).
2734
+ * @summary: Update Password
2735
+ * @description: Allow user to change their password. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/updatePassword/).
2736
2736
  */
2737
2737
  async updatePassword(
2738
2738
  { body, requestHeaders } = { requestHeaders: {} },
@@ -2809,8 +2809,8 @@ class User {
2809
2809
  * @param {import("../ApplicationAPIClient").Options} - Options
2810
2810
  * @returns {Promise<UserApplicationModel.ProfileEditSuccess>} - Success response
2811
2811
  * @name updateProfile
2812
- * @summary: Edit Profile Details
2813
- * @description: Use this API to update details in the user profile. Details can be first name, last name, gender, email, phone number, or profile picture. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/updateProfile/).
2812
+ * @summary: Edit User Profile Details
2813
+ * @description: Allows users to modify and update their profile details - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/updateProfile/).
2814
2814
  */
2815
2815
  async updateProfile(
2816
2816
  { body, platform, requestHeaders } = { requestHeaders: {} },
@@ -2888,8 +2888,8 @@ class User {
2888
2888
  * @param {import("../ApplicationAPIClient").Options} - Options
2889
2889
  * @returns {Promise<UserApplicationModel.UserAttributes>} - Success response
2890
2890
  * @name updateUserAttributes
2891
- * @summary: Update user attributes
2892
- * @description: Use this API to update user attributes - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/updateUserAttributes/).
2891
+ * @summary: Update User Attributes
2892
+ * @description: Update user attributes - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/updateUserAttributes/).
2893
2893
  */
2894
2894
  async updateUserAttributes(
2895
2895
  { body, requestHeaders } = { requestHeaders: {} },
@@ -2966,8 +2966,8 @@ class User {
2966
2966
  * @param {import("../ApplicationAPIClient").Options} - Options
2967
2967
  * @returns {Promise<UserApplicationModel.UserExistsResponse>} - Success response
2968
2968
  * @name userExists
2969
- * @summary: Check user is already registered or not
2970
- * @description: Use this API to check whether user is already registered or not to the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/userExists/).
2969
+ * @summary: Chcek User Existence
2970
+ * @description: Check whether user is already registered or not to the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/userExists/).
2971
2971
  */
2972
2972
  async userExists(
2973
2973
  { q, requestHeaders } = { requestHeaders: {} },
@@ -3043,8 +3043,8 @@ class User {
3043
3043
  * @param {import("../ApplicationAPIClient").Options} - Options
3044
3044
  * @returns {Promise<UserApplicationModel.VerifyEmailSuccess>} - Success response
3045
3045
  * @name verifyEmail
3046
- * @summary: Verify email
3047
- * @description: Verifies the user's email address. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/verifyEmail/).
3046
+ * @summary: Verify Email with Code
3047
+ * @description: Verifies user email with a code sent within a link sent to their email. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/verifyEmail/).
3048
3048
  */
3049
3049
  async verifyEmail(
3050
3050
  { body, requestHeaders } = { requestHeaders: {} },
@@ -3119,8 +3119,8 @@ class User {
3119
3119
  * @param {import("../ApplicationAPIClient").Options} - Options
3120
3120
  * @returns {Promise<UserApplicationModel.VerifyForgotOtpSuccess>} - Success response
3121
3121
  * @name verifyEmailForgotOTP
3122
- * @summary: Verify Email Forgot OTP
3123
- * @description: Validates the OTP sent to the user's forgot email address request. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/verifyEmailForgotOTP/).
3122
+ * @summary: Verify Email OTP for Forgot Password
3123
+ * @description: Verify one-time password sent to user's email for resetting a forgotten password - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/verifyEmailForgotOTP/).
3124
3124
  */
3125
3125
  async verifyEmailForgotOTP(
3126
3126
  { body, platform, requestHeaders } = { requestHeaders: {} },
@@ -3199,7 +3199,7 @@ class User {
3199
3199
  * @returns {Promise<UserApplicationModel.VerifyOtpSuccess>} - Success response
3200
3200
  * @name verifyEmailOTP
3201
3201
  * @summary: Verify Email OTP
3202
- * @description: Validates the OTP sent to the user's email address request. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/verifyEmailOTP/).
3202
+ * @description: Verify one-time password sent to user's email. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/verifyEmailOTP/).
3203
3203
  */
3204
3204
  async verifyEmailOTP(
3205
3205
  { body, platform, requestHeaders } = { requestHeaders: {} },
@@ -3277,8 +3277,8 @@ class User {
3277
3277
  * @param {import("../ApplicationAPIClient").Options} - Options
3278
3278
  * @returns {Promise<UserApplicationModel.VerifyEmailSuccess>} - Success response
3279
3279
  * @name verifyMobile
3280
- * @summary: Verify mobile
3281
- * @description: Verifies the user's mobile number. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/verifyMobile/).
3280
+ * @summary: Verify Mobile with Code
3281
+ * @description: Verifies user mobile with a code sent within a link sent to their mobile. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/verifyMobile/).
3282
3282
  */
3283
3283
  async verifyMobile(
3284
3284
  { body, requestHeaders } = { requestHeaders: {} },
@@ -3355,8 +3355,8 @@ class User {
3355
3355
  * @param {import("../ApplicationAPIClient").Options} - Options
3356
3356
  * @returns {Promise<UserApplicationModel.VerifyForgotOtpSuccess>} - Success response
3357
3357
  * @name verifyMobileForgotOTP
3358
- * @summary: Verify Forgot OTP on mobile
3359
- * @description: Use this API to verify the Forgot OTP received on a mobile number. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/verifyMobileForgotOTP/).
3358
+ * @summary: Verify Mobile OTP for Forgot Password
3359
+ * @description: Verify one-time password sent to user's mobile for resetting a forgotten password - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/verifyMobileForgotOTP/).
3360
3360
  */
3361
3361
  async verifyMobileForgotOTP(
3362
3362
  { body, platform, requestHeaders } = { requestHeaders: {} },
@@ -3434,8 +3434,8 @@ class User {
3434
3434
  * @param {import("../ApplicationAPIClient").Options} - Options
3435
3435
  * @returns {Promise<UserApplicationModel.VerifyOtpSuccess>} - Success response
3436
3436
  * @name verifyMobileOTP
3437
- * @summary: Verify mobile OTP
3438
- * @description: Validates the OTP sent to the user's mobile. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/verifyMobileOTP/).
3437
+ * @summary: Verify Mobile OTP
3438
+ * @description: Verify one-time password sent to user's mobile. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/verifyMobileOTP/).
3439
3439
  */
3440
3440
  async verifyMobileOTP(
3441
3441
  { body, platform, requestHeaders } = { requestHeaders: {} },
@@ -18,8 +18,8 @@ declare class AuditTrail {
18
18
  * @param {import("../PlatformAPIClient").Options} - Options
19
19
  * @returns {Promise<AuditTrailPlatformModel.LogSchemaResponse>} - Success response
20
20
  * @name getAuditLog
21
- * @summary: Get an audit log entry
22
- * @description: Retrieve a specific audit log entry - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getAuditLog/).
21
+ * @summary: Get an audit log
22
+ * @description: Retrieve a specific audit log entry. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getAuditLog/).
23
23
  */
24
24
  getAuditLog({ id, requestHeaders }?: AuditTrailPlatformValidator.GetAuditLogParam, { responseHeaders }?: object): Promise<AuditTrailPlatformModel.LogSchemaResponse>;
25
25
  /**
@@ -28,7 +28,7 @@ declare class AuditTrail {
28
28
  * @param {import("../PlatformAPIClient").Options} - Options
29
29
  * @returns {Promise<AuditTrailPlatformModel.LogSchemaResponse>} - Success response
30
30
  * @name getAuditLogs
31
- * @summary: Retrieve audit logs
31
+ * @summary: Get audit logs
32
32
  * @description: Retrieve audit logs for system events and actions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getAuditLogs/).
33
33
  */
34
34
  getAuditLogs({ qs, limit, sort, requestHeaders }?: AuditTrailPlatformValidator.GetAuditLogsParam, { responseHeaders }?: object): Promise<AuditTrailPlatformModel.LogSchemaResponse>;
@@ -38,8 +38,8 @@ declare class AuditTrail {
38
38
  * @param {import("../PlatformAPIClient").Options} - Options
39
39
  * @returns {Promise<AuditTrailPlatformModel.EntityTypesResponse>} - Success response
40
40
  * @name getEntityTypes
41
- * @summary: Obtain entity types for auditing
42
- * @description: List of entity types that can be audited within the platform's - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getEntityTypes/).
41
+ * @summary: List entity types
42
+ * @description: List of entity types that can be audited within the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getEntityTypes/).
43
43
  */
44
44
  getEntityTypes({ requestHeaders }?: any, { responseHeaders }?: object): Promise<AuditTrailPlatformModel.EntityTypesResponse>;
45
45
  }
@@ -99,8 +99,8 @@ class AuditTrail {
99
99
  * @param {import("../PlatformAPIClient").Options} - Options
100
100
  * @returns {Promise<AuditTrailPlatformModel.LogSchemaResponse>} - Success response
101
101
  * @name getAuditLog
102
- * @summary: Get an audit log entry
103
- * @description: Retrieve a specific audit log entry - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getAuditLog/).
102
+ * @summary: Get an audit log
103
+ * @description: Retrieve a specific audit log entry. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getAuditLog/).
104
104
  */
105
105
  async getAuditLog(
106
106
  { id, requestHeaders } = { requestHeaders: {} },
@@ -178,7 +178,7 @@ class AuditTrail {
178
178
  * @param {import("../PlatformAPIClient").Options} - Options
179
179
  * @returns {Promise<AuditTrailPlatformModel.LogSchemaResponse>} - Success response
180
180
  * @name getAuditLogs
181
- * @summary: Retrieve audit logs
181
+ * @summary: Get audit logs
182
182
  * @description: Retrieve audit logs for system events and actions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getAuditLogs/).
183
183
  */
184
184
  async getAuditLogs(
@@ -264,8 +264,8 @@ class AuditTrail {
264
264
  * @param {import("../PlatformAPIClient").Options} - Options
265
265
  * @returns {Promise<AuditTrailPlatformModel.EntityTypesResponse>} - Success response
266
266
  * @name getEntityTypes
267
- * @summary: Obtain entity types for auditing
268
- * @description: List of entity types that can be audited within the platform's - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getEntityTypes/).
267
+ * @summary: List entity types
268
+ * @description: List of entity types that can be audited within the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getEntityTypes/).
269
269
  */
270
270
  async getEntityTypes(
271
271
  { requestHeaders } = { requestHeaders: {} },
@@ -19,7 +19,7 @@ declare class Billing {
19
19
  * @returns {Promise<BillingPlatformModel.EntitySubscription>} - Success response
20
20
  * @name cancelSubscriptionCharge
21
21
  * @summary: Cancel a subscription charge
22
- * @description: Cancel an ongoing subscription charge for a customer. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/cancelSubscriptionCharge/).
22
+ * @description: When uninstalling, the extension statue will be marked as canceled. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/cancelSubscriptionCharge/).
23
23
  */
24
24
  cancelSubscriptionCharge({ extensionId, subscriptionId, requestHeaders }?: BillingPlatformValidator.CancelSubscriptionChargeParam, { responseHeaders }?: object): Promise<BillingPlatformModel.EntitySubscription>;
25
25
  /**
@@ -29,7 +29,7 @@ declare class Billing {
29
29
  * @returns {Promise<BillingPlatformModel.CancelSubscriptionRes>} - Success response
30
30
  * @name cancelSubscriptionPlan
31
31
  * @summary: Cancel a subscription plan
32
- * @description: Cancel an active subscription plan for a customer - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/cancelSubscriptionPlan/).
32
+ * @description: The seller will initiate a request to cancel their current subscription on the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/cancelSubscriptionPlan/).
33
33
  */
34
34
  cancelSubscriptionPlan({ body, requestHeaders }?: BillingPlatformValidator.CancelSubscriptionPlanParam, { responseHeaders }?: object): Promise<BillingPlatformModel.CancelSubscriptionRes>;
35
35
  /**
@@ -60,7 +60,7 @@ declare class Billing {
60
60
  * @returns {Promise<BillingPlatformModel.CreateSubscriptionResponse>} -
61
61
  * Success response
62
62
  * @name createSubscriptionCharge
63
- * @summary: Initiate subscription billing
63
+ * @summary: Register extension for the seller
64
64
  * @description: Register a subscription charge for a seller using your extension. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/createSubscriptionCharge/).
65
65
  */
66
66
  createSubscriptionCharge({ extensionId, body, requestHeaders }?: BillingPlatformValidator.CreateSubscriptionChargeParam, { responseHeaders }?: object): Promise<BillingPlatformModel.CreateSubscriptionResponse>;
@@ -71,7 +71,7 @@ declare class Billing {
71
71
  * @returns {Promise<BillingPlatformModel.OneTimeChargeEntity>} - Success response
72
72
  * @name getChargeDetails
73
73
  * @summary: Obtain charge details
74
- * @description: Retrieve comprehensive details about a specific billing charge. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getChargeDetails/).
74
+ * @description: It will fetch the information regarding the subscription for the extension. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getChargeDetails/).
75
75
  */
76
76
  getChargeDetails({ extensionId, chargeId, requestHeaders }?: BillingPlatformValidator.GetChargeDetailsParam, { responseHeaders }?: object): Promise<BillingPlatformModel.OneTimeChargeEntity>;
77
77
  /**
@@ -80,8 +80,8 @@ declare class Billing {
80
80
  * @param {import("../PlatformAPIClient").Options} - Options
81
81
  * @returns {Promise<BillingPlatformModel.SubscriptionCustomer>} - Success response
82
82
  * @name getCustomerDetail
83
- * @summary: Fetch customer details
84
- * @description: Obtain customer-related billing information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getCustomerDetail/).
83
+ * @summary: Get seller details
84
+ * @description: Retrieve seller information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getCustomerDetail/).
85
85
  */
86
86
  getCustomerDetail({ requestHeaders }?: any, { responseHeaders }?: object): Promise<BillingPlatformModel.SubscriptionCustomer>;
87
87
  /**
@@ -90,7 +90,7 @@ declare class Billing {
90
90
  * @param {import("../PlatformAPIClient").Options} - Options
91
91
  * @returns {Promise<BillingPlatformModel.Plan[]>} - Success response
92
92
  * @name getEnterprisePlans
93
- * @summary: Retrieve enterprise-level plans
93
+ * @summary: Get enterprise-level plans
94
94
  * @description: Retrieve available enterprise-level subscription plans. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getEnterprisePlans/).
95
95
  */
96
96
  getEnterprisePlans({ requestHeaders }?: any, { responseHeaders }?: object): Promise<BillingPlatformModel.Plan[]>;
@@ -120,7 +120,7 @@ declare class Billing {
120
120
  * @param {import("../PlatformAPIClient").Options} - Options
121
121
  * @returns {Promise<BillingPlatformModel.Invoices>} - Success response
122
122
  * @name getInvoices
123
- * @summary: Retrieve invoices
123
+ * @summary: Get invoices
124
124
  * @description: Retrieve invoices for billing and payment tracking. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getInvoices/).
125
125
  */
126
126
  getInvoices({ requestHeaders }?: any, { responseHeaders }?: object): Promise<BillingPlatformModel.Invoices>;
@@ -130,8 +130,8 @@ declare class Billing {
130
130
  * @param {import("../PlatformAPIClient").Options} - Options
131
131
  * @returns {Promise<BillingPlatformModel.SubscriptionStatus>} - Success response
132
132
  * @name getSubscription
133
- * @summary: Retrieve subscription details
134
- * @description: Retrieve details of a customer's subscription information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getSubscription/).
133
+ * @summary: Get subscription details
134
+ * @description: t will show the most recent subscriptions of the seller for each ordering channel, regardless of their status—whether they're active, cancelled, or otherwise. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getSubscription/).
135
135
  */
136
136
  getSubscription({ requestHeaders }?: any, { responseHeaders }?: object): Promise<BillingPlatformModel.SubscriptionStatus>;
137
137
  /**
@@ -140,7 +140,7 @@ declare class Billing {
140
140
  * @param {import("../PlatformAPIClient").Options} - Options
141
141
  * @returns {Promise<BillingPlatformModel.EntitySubscription>} - Success response
142
142
  * @name getSubscriptionCharge
143
- * @summary: Retrieve subscription charge details
143
+ * @summary: Get subscription charge details
144
144
  * @description: Retrieve detailed information about subscription charges using this API. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getSubscriptionCharge/).
145
145
  */
146
146
  getSubscriptionCharge({ extensionId, subscriptionId, requestHeaders }?: BillingPlatformValidator.GetSubscriptionChargeParam, { responseHeaders }?: object): Promise<BillingPlatformModel.EntitySubscription>;
@@ -180,8 +180,8 @@ declare class Billing {
180
180
  * @param {import("../PlatformAPIClient").Options} - Options
181
181
  * @returns {Promise<BillingPlatformModel.SubscriptionCustomer>} - Success response
182
182
  * @name upsertCustomerDetail
183
- * @summary: Update or insert customer details
184
- * @description: Allows you to modify or insert customer information in the billing system. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/upsertCustomerDetail/).
183
+ * @summary: Update or insert seller details
184
+ * @description: Allows you to modify or insert seller information in the billing system. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/upsertCustomerDetail/).
185
185
  */
186
186
  upsertCustomerDetail({ body, requestHeaders }?: BillingPlatformValidator.UpsertCustomerDetailParam, { responseHeaders }?: object): Promise<BillingPlatformModel.SubscriptionCustomer>;
187
187
  }