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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (152) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/Cart/CartApplicationClient.d.ts +62 -62
  4. package/sdk/application/Cart/CartApplicationClient.js +82 -71
  5. package/sdk/application/Cart/CartApplicationValidator.d.ts +189 -34
  6. package/sdk/application/Cart/CartApplicationValidator.js +59 -34
  7. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +78 -78
  8. package/sdk/application/Catalog/CatalogApplicationClient.js +78 -78
  9. package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
  10. package/sdk/application/Common/CommonApplicationClient.js +4 -4
  11. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -6
  12. package/sdk/application/Communication/CommunicationApplicationClient.js +6 -6
  13. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -67
  14. package/sdk/application/Configuration/ConfigurationApplicationClient.js +32 -106
  15. package/sdk/application/Content/ContentApplicationClient.d.ts +34 -64
  16. package/sdk/application/Content/ContentApplicationClient.js +34 -115
  17. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -42
  18. package/sdk/application/FileStorage/FileStorageApplicationClient.js +6 -42
  19. package/sdk/application/Lead/LeadApplicationClient.d.ts +14 -14
  20. package/sdk/application/Lead/LeadApplicationClient.js +14 -14
  21. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +12 -12
  22. package/sdk/application/Logistic/LogisticApplicationClient.js +12 -12
  23. package/sdk/application/Order/OrderApplicationClient.d.ts +24 -24
  24. package/sdk/application/Order/OrderApplicationClient.js +24 -24
  25. package/sdk/application/Order/OrderApplicationModel.d.ts +29 -1
  26. package/sdk/application/Order/OrderApplicationModel.js +34 -0
  27. package/sdk/application/Payment/PaymentApplicationClient.d.ts +89 -89
  28. package/sdk/application/Payment/PaymentApplicationClient.js +94 -94
  29. package/sdk/application/Payment/PaymentApplicationModel.d.ts +524 -3
  30. package/sdk/application/Payment/PaymentApplicationModel.js +335 -2
  31. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +5 -5
  32. package/sdk/application/Payment/PaymentApplicationValidator.js +3 -3
  33. package/sdk/application/PosCart/PosCartApplicationClient.d.ts +54 -54
  34. package/sdk/application/PosCart/PosCartApplicationClient.js +54 -54
  35. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +14 -25
  36. package/sdk/application/Rewards/RewardsApplicationClient.js +14 -41
  37. package/sdk/application/Share/ShareApplicationClient.d.ts +14 -14
  38. package/sdk/application/Share/ShareApplicationClient.js +14 -14
  39. package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
  40. package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
  41. package/sdk/application/User/UserApplicationClient.d.ts +66 -66
  42. package/sdk/application/User/UserApplicationClient.js +68 -71
  43. package/sdk/application/User/UserApplicationModel.d.ts +32 -27
  44. package/sdk/application/User/UserApplicationModel.js +22 -32
  45. package/sdk/partner/Theme/ThemePartnerClient.d.ts +38 -38
  46. package/sdk/partner/Theme/ThemePartnerClient.js +38 -38
  47. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +8 -8
  48. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +8 -8
  49. package/sdk/platform/Billing/BillingPlatformClient.d.ts +34 -36
  50. package/sdk/platform/Billing/BillingPlatformClient.js +34 -36
  51. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +98 -175
  52. package/sdk/platform/Cart/CartPlatformApplicationClient.js +98 -254
  53. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +92 -18
  54. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +28 -18
  55. package/sdk/platform/Cart/CartPlatformModel.d.ts +12 -0
  56. package/sdk/platform/Cart/CartPlatformModel.js +12 -0
  57. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +221 -108
  58. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +460 -113
  59. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +72 -3
  60. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +46 -2
  61. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +335 -136
  62. package/sdk/platform/Catalog/CatalogPlatformClient.js +551 -136
  63. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +38 -5
  64. package/sdk/platform/Catalog/CatalogPlatformModel.js +47 -3
  65. package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -3
  66. package/sdk/platform/Common/CommonPlatformClient.js +3 -3
  67. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +115 -290
  68. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +115 -510
  69. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +2 -13
  70. package/sdk/platform/Communication/CommunicationPlatformClient.js +2 -29
  71. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +32 -32
  72. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +32 -32
  73. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +52 -127
  74. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +52 -204
  75. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +35 -111
  76. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +35 -212
  77. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +142 -1
  78. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +96 -0
  79. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +130 -218
  80. package/sdk/platform/Content/ContentPlatformApplicationClient.js +136 -314
  81. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +4 -4
  82. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +4 -4
  83. package/sdk/platform/Content/ContentPlatformClient.d.ts +1 -1
  84. package/sdk/platform/Content/ContentPlatformClient.js +7 -7
  85. package/sdk/platform/Content/ContentPlatformModel.d.ts +18 -1
  86. package/sdk/platform/Content/ContentPlatformModel.js +20 -0
  87. package/sdk/platform/Content/ContentPlatformValidator.d.ts +4 -4
  88. package/sdk/platform/Content/ContentPlatformValidator.js +4 -4
  89. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +22 -48
  90. package/sdk/platform/Discount/DiscountPlatformClient.js +22 -73
  91. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +20 -56
  92. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +23 -56
  93. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +2 -0
  94. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +2 -0
  95. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +12 -48
  96. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +12 -48
  97. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +15 -1
  98. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +14 -0
  99. package/sdk/platform/Finance/FinancePlatformClient.d.ts +44 -44
  100. package/sdk/platform/Finance/FinancePlatformClient.js +44 -44
  101. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +12 -12
  102. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +12 -12
  103. package/sdk/platform/Lead/LeadPlatformClient.d.ts +22 -48
  104. package/sdk/platform/Lead/LeadPlatformClient.js +22 -72
  105. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +4 -4
  106. package/sdk/platform/Order/OrderPlatformApplicationClient.js +4 -4
  107. package/sdk/platform/Order/OrderPlatformClient.d.ts +79 -208
  108. package/sdk/platform/Order/OrderPlatformClient.js +79 -294
  109. package/sdk/platform/Order/OrderPlatformModel.d.ts +42 -1
  110. package/sdk/platform/Order/OrderPlatformModel.js +44 -0
  111. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -4
  112. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -4
  113. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +4 -4
  114. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +2 -2
  115. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +81 -81
  116. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +81 -81
  117. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
  118. package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
  119. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +27 -1
  120. package/sdk/platform/Payment/PaymentPlatformModel.js +19 -0
  121. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +23 -40
  122. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +23 -61
  123. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +8 -8
  124. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +8 -8
  125. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +10 -9
  126. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +11 -10
  127. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +170 -33
  128. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +171 -38
  129. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +2 -2
  130. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +2 -2
  131. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +11 -11
  132. package/sdk/platform/Share/SharePlatformApplicationClient.js +29 -16
  133. package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +13 -3
  134. package/sdk/platform/Share/SharePlatformApplicationValidator.js +6 -2
  135. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +56 -56
  136. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +56 -56
  137. package/sdk/platform/Theme/ThemePlatformClient.d.ts +6 -6
  138. package/sdk/platform/Theme/ThemePlatformClient.js +6 -6
  139. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +33 -33
  140. package/sdk/platform/User/UserPlatformApplicationClient.js +33 -33
  141. package/sdk/platform/User/UserPlatformModel.d.ts +81 -11
  142. package/sdk/platform/User/UserPlatformModel.js +80 -10
  143. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +32 -45
  144. package/sdk/platform/Webhook/WebhookPlatformClient.js +32 -45
  145. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +58 -1
  146. package/sdk/platform/Webhook/WebhookPlatformModel.js +66 -0
  147. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -2
  148. package/sdk/public/Configuration/ConfigurationPublicClient.js +2 -2
  149. package/sdk/public/Partner/PartnerPublicClient.d.ts +2 -2
  150. package/sdk/public/Partner/PartnerPublicClient.js +2 -2
  151. package/sdk/public/Webhook/WebhookPublicClient.d.ts +4 -4
  152. package/sdk/public/Webhook/WebhookPublicClient.js +4 -4
@@ -98,8 +98,8 @@ class User {
98
98
  * @param {import("../PlatformAPIClient").Options} - Options
99
99
  * @returns {Promise<UserPlatformModel.BlockUserSuccess>} - Success response
100
100
  * @name blockOrUnblockUsers
101
- * @summary: Block/Unblock user
102
- * @description: Block/Unblock user - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/blockOrUnblockUsers/).
101
+ * @summary: Block/unblock users.
102
+ * @description: Control user access by blocking or unblocking their accounts. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/blockOrUnblockUsers/).
103
103
  */
104
104
  async blockOrUnblockUsers(
105
105
  { body, requestHeaders } = { requestHeaders: {} },
@@ -177,8 +177,8 @@ class User {
177
177
  * @param {import("../PlatformAPIClient").Options} - Options
178
178
  * @returns {Promise<UserPlatformModel.CreateUserResponseSchema>} - Success response
179
179
  * @name createUser
180
- * @summary: Create user
181
- * @description: Create user - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/createUser/).
180
+ * @summary: Create user.
181
+ * @description: Register and add a new user to the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/createUser/).
182
182
  */
183
183
  async createUser(
184
184
  { body, requestHeaders } = { requestHeaders: {} },
@@ -336,8 +336,8 @@ class User {
336
336
  * @param {import("../PlatformAPIClient").Options} - Options
337
337
  * @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
338
338
  * @name createUserGroup
339
- * @summary: Create an User Group
340
- * @description: Use this API to create new user Group - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/createUserGroup/).
339
+ * @summary: Create user group.
340
+ * @description: Form and add a new user group. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/createUserGroup/).
341
341
  */
342
342
  async createUserGroup(
343
343
  { body, requestHeaders } = { requestHeaders: {} },
@@ -416,8 +416,8 @@ class User {
416
416
  * @returns {Promise<UserPlatformModel.CreateUserSessionResponseSchema>} -
417
417
  * Success response
418
418
  * @name createUserSession
419
- * @summary: Create user session
420
- * @description: Create user session - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/createUserSession/).
419
+ * @summary: Create user session.
420
+ * @description: Establish a session for user interactions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/createUserSession/).
421
421
  */
422
422
  async createUserSession(
423
423
  { body, requestHeaders } = { requestHeaders: {} },
@@ -498,8 +498,8 @@ class User {
498
498
  * @returns {Promise<UserPlatformModel.SessionsDeleteResponseSchema>} -
499
499
  * Success response
500
500
  * @name deleteActiveSessions
501
- * @summary: Delete a list of all session for a user
502
- * @description: Use this API to Delete a list of session of customers who have registered in the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/deleteActiveSessions/).
501
+ * @summary: Delete active sessions.
502
+ * @description: End multiple active user sessions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/deleteActiveSessions/).
503
503
  */
504
504
  async deleteActiveSessions(
505
505
  { id, reason, requestHeaders } = { requestHeaders: {} },
@@ -582,8 +582,8 @@ class User {
582
582
  * @returns {Promise<UserPlatformModel.SessionDeleteResponseSchema>} -
583
583
  * Success response
584
584
  * @name deleteSession
585
- * @summary: Delete a session for a user
586
- * @description: Use this API to Delete a session of customers who have registered in the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/deleteSession/).
585
+ * @summary: Delete session.
586
+ * @description: Terminate an active user session. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/deleteSession/).
587
587
  */
588
588
  async deleteSession(
589
589
  { id, sessionId, reason, requestHeaders } = { requestHeaders: {} },
@@ -818,8 +818,8 @@ class User {
818
818
  * @param {import("../PlatformAPIClient").Options} - Options
819
819
  * @returns {Promise<UserPlatformModel.SessionListResponseSchema>} - Success response
820
820
  * @name getActiveSessions
821
- * @summary: Get a list of all session with info for a user
822
- * @description: Use this API to retrieve a list of session with info of customers who have registered in the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getActiveSessions/).
821
+ * @summary: Get active sessions.
822
+ * @description: Retrieve a list of currently active user sessions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getActiveSessions/).
823
823
  */
824
824
  async getActiveSessions(
825
825
  { id, requestHeaders } = { requestHeaders: {} },
@@ -898,8 +898,8 @@ class User {
898
898
  * @param {import("../PlatformAPIClient").Options} - Options
899
899
  * @returns {Promise<UserPlatformModel.CustomerListResponseSchema>} - Success response
900
900
  * @name getCustomers
901
- * @summary: Get a list of customers
902
- * @description: Use this API to retrieve a list of customers who have registered in the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getCustomers/).
901
+ * @summary: Get customers.
902
+ * @description: Retrieve a list of customer profiles. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getCustomers/).
903
903
  */
904
904
  async getCustomers(
905
905
  { q, pageSize, pageNo, requestHeaders } = { requestHeaders: {} },
@@ -982,8 +982,8 @@ class User {
982
982
  * @param {import("../PlatformAPIClient").Options} - Options
983
983
  * @returns {Promise<UserPlatformModel.PlatformSchema>} - Success response
984
984
  * @name getPlatformConfig
985
- * @summary: Get platform configurations
986
- * @description: Use this API to get all the platform configurations such as mobile image, desktop image, social logins, and all other text. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getPlatformConfig/).
985
+ * @summary: Get platform config.
986
+ * @description: Retrieve configuration settings for the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getPlatformConfig/).
987
987
  */
988
988
  async getPlatformConfig(
989
989
  { requestHeaders } = { requestHeaders: {} },
@@ -1496,8 +1496,8 @@ class User {
1496
1496
  * @param {import("../PlatformAPIClient").Options} - Options
1497
1497
  * @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
1498
1498
  * @name getUserGroupById
1499
- * @summary: Get an User Group by Id
1500
- * @description: Use this API to get details of an existing user Group - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserGroupById/).
1499
+ * @summary: Get user group by ID.
1500
+ * @description: Retrieve a user group by its unique identifier. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserGroupById/).
1501
1501
  */
1502
1502
  async getUserGroupById(
1503
1503
  { groupId, requestHeaders } = { requestHeaders: {} },
@@ -1576,8 +1576,8 @@ class User {
1576
1576
  * @returns {Promise<UserPlatformModel.UserGroupListResponseSchema>} -
1577
1577
  * Success response
1578
1578
  * @name getUserGroups
1579
- * @summary: Get User Groups mathcing criteria
1580
- * @description: Use this API to get User Groups mathing criteria passed in query - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserGroups/).
1579
+ * @summary: Get user groups.
1580
+ * @description: Retrieve a list of user groups. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserGroups/).
1581
1581
  */
1582
1582
  async getUserGroups(
1583
1583
  { pageNo, pageSize, name, type, status, groupUid, requestHeaders } = {
@@ -1671,8 +1671,8 @@ class User {
1671
1671
  * @param {import("../PlatformAPIClient").Options} - Options
1672
1672
  * @returns {Promise<UserPlatformModel.UserSearchResponseSchema>} - Success response
1673
1673
  * @name searchUsers
1674
- * @summary: Search an existing user.
1675
- * @description: Use this API to retrieve an existing user from a list. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/searchUsers/).
1674
+ * @summary: Search users.
1675
+ * @description: Search and filter user profiles. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/searchUsers/).
1676
1676
  */
1677
1677
  async searchUsers(
1678
1678
  { q, query, requestHeaders } = { requestHeaders: {} },
@@ -1752,8 +1752,8 @@ class User {
1752
1752
  * @param {import("../PlatformAPIClient").Options} - Options
1753
1753
  * @returns {Promise<UserPlatformModel.UnDeleteUserSuccess>} - Success response
1754
1754
  * @name unDeleteUser
1755
- * @summary: undelete user who deleted from application and have not elapsed the platform configured delete days
1756
- * @description: undelete user who deleted from application and have not elapsed the platform configured delete days - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/unDeleteUser/).
1755
+ * @summary: Undelete user.
1756
+ * @description: Restore a previously deleted user account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/unDeleteUser/).
1757
1757
  */
1758
1758
  async unDeleteUser(
1759
1759
  { body, requestHeaders } = { requestHeaders: {} },
@@ -1831,8 +1831,8 @@ class User {
1831
1831
  * @param {import("../PlatformAPIClient").Options} - Options
1832
1832
  * @returns {Promise<UserPlatformModel.PlatformSchema>} - Success response
1833
1833
  * @name updatePlatformConfig
1834
- * @summary: Update platform configurations
1835
- * @description: Use this API to edit the existing platform configurations such as mobile image, desktop image, social logins, and all other text. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updatePlatformConfig/).
1834
+ * @summary: Update platform config.
1835
+ * @description: Modify and update platform configuration settings. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updatePlatformConfig/).
1836
1836
  */
1837
1837
  async updatePlatformConfig(
1838
1838
  { body, requestHeaders } = { requestHeaders: {} },
@@ -1910,8 +1910,8 @@ class User {
1910
1910
  * @param {import("../PlatformAPIClient").Options} - Options
1911
1911
  * @returns {Promise<UserPlatformModel.CreateUserResponseSchema>} - Success response
1912
1912
  * @name updateUser
1913
- * @summary: Update user
1914
- * @description: Use this API to update user details, Note: Existing emails and phone numbers of user will be replaced directly if phone_numbers or emails field sent in request data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updateUser/).
1913
+ * @summary: Update user.
1914
+ * @description: Modify and update user profile information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updateUser/).
1915
1915
  */
1916
1916
  async updateUser(
1917
1917
  { userId, body, requestHeaders } = { requestHeaders: {} },
@@ -2159,8 +2159,8 @@ class User {
2159
2159
  * @param {import("../PlatformAPIClient").Options} - Options
2160
2160
  * @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
2161
2161
  * @name updateUserGroup
2162
- * @summary: Update an User Group
2163
- * @description: Use this API to update an existing user Group - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updateUserGroup/).
2162
+ * @summary: Update user group.
2163
+ * @description: Modify and update user group details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updateUserGroup/).
2164
2164
  */
2165
2165
  async updateUserGroup(
2166
2166
  { groupId, body, requestHeaders } = { requestHeaders: {} },
@@ -2243,7 +2243,7 @@ class User {
2243
2243
  * @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
2244
2244
  * @name updateUserGroupPartially
2245
2245
  * @summary: Add or Remove an user from particular user group and update user group details
2246
- * @description: Use this API to update user group details and add or remove an user to the user group. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updateUserGroupPartially/).
2246
+ * @description: Update user group partially on the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updateUserGroupPartially/).
2247
2247
  */
2248
2248
  async updateUserGroupPartially(
2249
2249
  { groupId, body, requestHeaders } = { requestHeaders: {} },
@@ -108,7 +108,7 @@ export = UserPlatformModel;
108
108
  */
109
109
  /**
110
110
  * @typedef UserSearchResponseSchema
111
- * @property {UserSchema[]} [users]
111
+ * @property {UserSearchSchema[]} [users]
112
112
  */
113
113
  /**
114
114
  * @typedef CustomerListResponseSchema
@@ -138,8 +138,14 @@ export = UserPlatformModel;
138
138
  * @property {string[]} [session_ids]
139
139
  */
140
140
  /**
141
- * @typedef AuthenticationApiErrorSchema
141
+ * @typedef APIError
142
+ * @property {string} [code]
142
143
  * @property {string} [message]
144
+ * @property {string} [info] - Error code description link
145
+ * @property {string} [request_id]
146
+ * @property {string} [error]
147
+ * @property {Object} [meta]
148
+ * @property {boolean} [authenticated]
143
149
  */
144
150
  /**
145
151
  * @typedef SessionListResponseInfo
@@ -148,6 +154,7 @@ export = UserPlatformModel;
148
154
  * @property {string} [ip]
149
155
  * @property {string} [domain]
150
156
  * @property {string} [expire_in]
157
+ * @property {string} [location]
151
158
  */
152
159
  /**
153
160
  * @typedef Conditions
@@ -251,8 +258,9 @@ export = UserPlatformModel;
251
258
  * @property {string} [desktop_image]
252
259
  * @property {number} [delete_account_day]
253
260
  * @property {DeleteAccountReasons[]} [delete_account_reasons]
254
- * @property {Object} [delete_account_consent]
255
- * @property {Object} [session_config]
261
+ * @property {DeleteAccountConsent} [delete_account_consent]
262
+ * @property {SessionExpiry} [session_config]
263
+ * @property {number} [__v]
256
264
  */
257
265
  /**
258
266
  * @typedef LookAndFeel
@@ -330,14 +338,17 @@ export = UserPlatformModel;
330
338
  /**
331
339
  * @typedef Facebook
332
340
  * @property {string} [app_id]
341
+ * @property {string} [app_secret]
333
342
  */
334
343
  /**
335
344
  * @typedef Accountkit
336
345
  * @property {string} [app_id]
346
+ * @property {string} [app_secret]
337
347
  */
338
348
  /**
339
349
  * @typedef Google
340
350
  * @property {string} [app_id]
351
+ * @property {string} [app_secret]
341
352
  */
342
353
  /**
343
354
  * @typedef SessionExpiry
@@ -419,6 +430,28 @@ export = UserPlatformModel;
419
430
  * @property {string} [updated_at]
420
431
  * @property {string} [external_id]
421
432
  */
433
+ /**
434
+ * @typedef UserSearchSchema
435
+ * @property {string} [application_id]
436
+ * @property {string} [user_id]
437
+ * @property {string} [first_name]
438
+ * @property {Object} [meta]
439
+ * @property {string} [last_name]
440
+ * @property {PhoneNumber[]} [phone_numbers]
441
+ * @property {Email[]} [emails]
442
+ * @property {string} [gender]
443
+ * @property {string} [dob]
444
+ * @property {boolean} [active]
445
+ * @property {string} [profile_pic_url]
446
+ * @property {string} [username]
447
+ * @property {string} [account_type]
448
+ * @property {string} [_id]
449
+ * @property {string} [created_at]
450
+ * @property {string} [updated_at]
451
+ * @property {string} [external_id]
452
+ * @property {boolean} [archive]
453
+ * @property {string} [status]
454
+ */
422
455
  /**
423
456
  * @typedef PhoneNumber
424
457
  * @property {boolean} [active]
@@ -437,7 +470,7 @@ export = UserPlatformModel;
437
470
  declare class UserPlatformModel {
438
471
  }
439
472
  declare namespace UserPlatformModel {
440
- export { SuccessMessageResponse, UserAttributeDefinition, UserAttributeDefinitionResponse, UserAttributeDefinitionValidation, UserAttributeResponse, CreateUserAttributeRequest, CreateUserAttributeDefinition, BlockUserRequestSchema, ArchiveUserRequestSchema, UnDeleteUserRequestSchema, BlockUserSuccess, ArchiveUserSuccess, UnDeleteUserSuccess, UserSearchResponseSchema, CustomerListResponseSchema, PaginationSchema, SessionListResponseSchema, SessionDeleteResponseSchema, SessionsDeleteResponseSchema, AuthenticationApiErrorSchema, SessionListResponseInfo, Conditions, UserResponseErrorSchema, UserGroupResponseSchema, UserGroupListResponseSchema, ConditionsSchema, CreateUserGroup, CreateUserRequestSchema, CreateUserResponseSchema, CreateUserSessionRequestSchema, CreateUserSessionResponseSchema, PlatformSchema, LookAndFeel, Login, MetaSchema, Social, RequiredFields, PlatformEmail, PlatformMobile, RegisterRequiredFields, RegisterRequiredFieldsEmail, RegisterRequiredFieldsMobile, FlashCard, SocialTokens, DeleteAccountReasons, DeleteAccountConsent, Facebook, Accountkit, Google, SessionExpiry, UpdateUserGroupSchema, PartialUserGroupUpdateSchema, UserGroupUpdateData, UpdateUserRequestSchema, UserEmails, UserPhoneNumbers, UserSchema, PhoneNumber, Email };
473
+ export { SuccessMessageResponse, UserAttributeDefinition, UserAttributeDefinitionResponse, UserAttributeDefinitionValidation, UserAttributeResponse, CreateUserAttributeRequest, CreateUserAttributeDefinition, BlockUserRequestSchema, ArchiveUserRequestSchema, UnDeleteUserRequestSchema, BlockUserSuccess, ArchiveUserSuccess, UnDeleteUserSuccess, UserSearchResponseSchema, CustomerListResponseSchema, PaginationSchema, SessionListResponseSchema, SessionDeleteResponseSchema, SessionsDeleteResponseSchema, APIError, SessionListResponseInfo, Conditions, UserResponseErrorSchema, UserGroupResponseSchema, UserGroupListResponseSchema, ConditionsSchema, CreateUserGroup, CreateUserRequestSchema, CreateUserResponseSchema, CreateUserSessionRequestSchema, CreateUserSessionResponseSchema, PlatformSchema, LookAndFeel, Login, MetaSchema, Social, RequiredFields, PlatformEmail, PlatformMobile, RegisterRequiredFields, RegisterRequiredFieldsEmail, RegisterRequiredFieldsMobile, FlashCard, SocialTokens, DeleteAccountReasons, DeleteAccountConsent, Facebook, Accountkit, Google, SessionExpiry, UpdateUserGroupSchema, PartialUserGroupUpdateSchema, UserGroupUpdateData, UpdateUserRequestSchema, UserEmails, UserPhoneNumbers, UserSchema, UserSearchSchema, PhoneNumber, Email };
441
474
  }
442
475
  /** @returns {SuccessMessageResponse} */
443
476
  declare function SuccessMessageResponse(): SuccessMessageResponse;
@@ -679,7 +712,7 @@ type UnDeleteUserSuccess = {
679
712
  /** @returns {UserSearchResponseSchema} */
680
713
  declare function UserSearchResponseSchema(): UserSearchResponseSchema;
681
714
  type UserSearchResponseSchema = {
682
- users?: UserSchema[];
715
+ users?: UserSearchSchema[];
683
716
  };
684
717
  /** @returns {CustomerListResponseSchema} */
685
718
  declare function CustomerListResponseSchema(): CustomerListResponseSchema;
@@ -713,10 +746,19 @@ type SessionsDeleteResponseSchema = {
713
746
  user_id?: string;
714
747
  session_ids?: string[];
715
748
  };
716
- /** @returns {AuthenticationApiErrorSchema} */
717
- declare function AuthenticationApiErrorSchema(): AuthenticationApiErrorSchema;
718
- type AuthenticationApiErrorSchema = {
749
+ /** @returns {APIError} */
750
+ declare function APIError(): APIError;
751
+ type APIError = {
752
+ code?: string;
719
753
  message?: string;
754
+ /**
755
+ * - Error code description link
756
+ */
757
+ info?: string;
758
+ request_id?: string;
759
+ error?: string;
760
+ meta?: any;
761
+ authenticated?: boolean;
720
762
  };
721
763
  /** @returns {SessionListResponseInfo} */
722
764
  declare function SessionListResponseInfo(): SessionListResponseInfo;
@@ -726,6 +768,7 @@ type SessionListResponseInfo = {
726
768
  ip?: string;
727
769
  domain?: string;
728
770
  expire_in?: string;
771
+ location?: string;
729
772
  };
730
773
  /** @returns {Conditions} */
731
774
  declare function Conditions(): Conditions;
@@ -840,8 +883,9 @@ type PlatformSchema = {
840
883
  desktop_image?: string;
841
884
  delete_account_day?: number;
842
885
  delete_account_reasons?: DeleteAccountReasons[];
843
- delete_account_consent?: any;
844
- session_config?: any;
886
+ delete_account_consent?: DeleteAccountConsent;
887
+ session_config?: SessionExpiry;
888
+ __v?: number;
845
889
  };
846
890
  /** @returns {LookAndFeel} */
847
891
  declare function LookAndFeel(): LookAndFeel;
@@ -934,16 +978,19 @@ type DeleteAccountConsent = {
934
978
  declare function Facebook(): Facebook;
935
979
  type Facebook = {
936
980
  app_id?: string;
981
+ app_secret?: string;
937
982
  };
938
983
  /** @returns {Accountkit} */
939
984
  declare function Accountkit(): Accountkit;
940
985
  type Accountkit = {
941
986
  app_id?: string;
987
+ app_secret?: string;
942
988
  };
943
989
  /** @returns {Google} */
944
990
  declare function Google(): Google;
945
991
  type Google = {
946
992
  app_id?: string;
993
+ app_secret?: string;
947
994
  };
948
995
  /** @returns {SessionExpiry} */
949
996
  declare function SessionExpiry(): SessionExpiry;
@@ -1051,6 +1098,29 @@ type UserSchema = {
1051
1098
  updated_at?: string;
1052
1099
  external_id?: string;
1053
1100
  };
1101
+ /** @returns {UserSearchSchema} */
1102
+ declare function UserSearchSchema(): UserSearchSchema;
1103
+ type UserSearchSchema = {
1104
+ application_id?: string;
1105
+ user_id?: string;
1106
+ first_name?: string;
1107
+ meta?: any;
1108
+ last_name?: string;
1109
+ phone_numbers?: PhoneNumber[];
1110
+ emails?: Email[];
1111
+ gender?: string;
1112
+ dob?: string;
1113
+ active?: boolean;
1114
+ profile_pic_url?: string;
1115
+ username?: string;
1116
+ account_type?: string;
1117
+ _id?: string;
1118
+ created_at?: string;
1119
+ updated_at?: string;
1120
+ external_id?: string;
1121
+ archive?: boolean;
1122
+ status?: string;
1123
+ };
1054
1124
  /** @returns {PhoneNumber} */
1055
1125
  declare function PhoneNumber(): PhoneNumber;
1056
1126
  type PhoneNumber = {
@@ -122,7 +122,7 @@ const Joi = require("joi");
122
122
 
123
123
  /**
124
124
  * @typedef UserSearchResponseSchema
125
- * @property {UserSchema[]} [users]
125
+ * @property {UserSearchSchema[]} [users]
126
126
  */
127
127
 
128
128
  /**
@@ -158,8 +158,14 @@ const Joi = require("joi");
158
158
  */
159
159
 
160
160
  /**
161
- * @typedef AuthenticationApiErrorSchema
161
+ * @typedef APIError
162
+ * @property {string} [code]
162
163
  * @property {string} [message]
164
+ * @property {string} [info] - Error code description link
165
+ * @property {string} [request_id]
166
+ * @property {string} [error]
167
+ * @property {Object} [meta]
168
+ * @property {boolean} [authenticated]
163
169
  */
164
170
 
165
171
  /**
@@ -169,6 +175,7 @@ const Joi = require("joi");
169
175
  * @property {string} [ip]
170
176
  * @property {string} [domain]
171
177
  * @property {string} [expire_in]
178
+ * @property {string} [location]
172
179
  */
173
180
 
174
181
  /**
@@ -283,8 +290,9 @@ const Joi = require("joi");
283
290
  * @property {string} [desktop_image]
284
291
  * @property {number} [delete_account_day]
285
292
  * @property {DeleteAccountReasons[]} [delete_account_reasons]
286
- * @property {Object} [delete_account_consent]
287
- * @property {Object} [session_config]
293
+ * @property {DeleteAccountConsent} [delete_account_consent]
294
+ * @property {SessionExpiry} [session_config]
295
+ * @property {number} [__v]
288
296
  */
289
297
 
290
298
  /**
@@ -377,16 +385,19 @@ const Joi = require("joi");
377
385
  /**
378
386
  * @typedef Facebook
379
387
  * @property {string} [app_id]
388
+ * @property {string} [app_secret]
380
389
  */
381
390
 
382
391
  /**
383
392
  * @typedef Accountkit
384
393
  * @property {string} [app_id]
394
+ * @property {string} [app_secret]
385
395
  */
386
396
 
387
397
  /**
388
398
  * @typedef Google
389
399
  * @property {string} [app_id]
400
+ * @property {string} [app_secret]
390
401
  */
391
402
 
392
403
  /**
@@ -477,6 +488,29 @@ const Joi = require("joi");
477
488
  * @property {string} [external_id]
478
489
  */
479
490
 
491
+ /**
492
+ * @typedef UserSearchSchema
493
+ * @property {string} [application_id]
494
+ * @property {string} [user_id]
495
+ * @property {string} [first_name]
496
+ * @property {Object} [meta]
497
+ * @property {string} [last_name]
498
+ * @property {PhoneNumber[]} [phone_numbers]
499
+ * @property {Email[]} [emails]
500
+ * @property {string} [gender]
501
+ * @property {string} [dob]
502
+ * @property {boolean} [active]
503
+ * @property {string} [profile_pic_url]
504
+ * @property {string} [username]
505
+ * @property {string} [account_type]
506
+ * @property {string} [_id]
507
+ * @property {string} [created_at]
508
+ * @property {string} [updated_at]
509
+ * @property {string} [external_id]
510
+ * @property {boolean} [archive]
511
+ * @property {string} [status]
512
+ */
513
+
480
514
  /**
481
515
  * @typedef PhoneNumber
482
516
  * @property {boolean} [active]
@@ -645,7 +679,7 @@ class UserPlatformModel {
645
679
  /** @returns {UserSearchResponseSchema} */
646
680
  static UserSearchResponseSchema() {
647
681
  return Joi.object({
648
- users: Joi.array().items(UserPlatformModel.UserSchema()),
682
+ users: Joi.array().items(UserPlatformModel.UserSearchSchema()),
649
683
  });
650
684
  }
651
685
 
@@ -691,10 +725,16 @@ class UserPlatformModel {
691
725
  });
692
726
  }
693
727
 
694
- /** @returns {AuthenticationApiErrorSchema} */
695
- static AuthenticationApiErrorSchema() {
728
+ /** @returns {APIError} */
729
+ static APIError() {
696
730
  return Joi.object({
731
+ code: Joi.string().allow(""),
697
732
  message: Joi.string().allow(""),
733
+ info: Joi.string().allow(""),
734
+ request_id: Joi.string().allow(""),
735
+ error: Joi.string().allow(""),
736
+ meta: Joi.any(),
737
+ authenticated: Joi.boolean(),
698
738
  });
699
739
  }
700
740
 
@@ -706,6 +746,7 @@ class UserPlatformModel {
706
746
  ip: Joi.string().allow(""),
707
747
  domain: Joi.string().allow(""),
708
748
  expire_in: Joi.string().allow(""),
749
+ location: Joi.string().allow(""),
709
750
  });
710
751
  }
711
752
 
@@ -812,7 +853,7 @@ class UserPlatformModel {
812
853
  max_age: Joi.number(),
813
854
  secure: Joi.boolean(),
814
855
  http_only: Joi.boolean(),
815
- cookie: Joi.any(),
856
+ cookie: Joi.object().pattern(/\S/, Joi.any()),
816
857
  });
817
858
  }
818
859
 
@@ -844,8 +885,9 @@ class UserPlatformModel {
844
885
  delete_account_reasons: Joi.array().items(
845
886
  UserPlatformModel.DeleteAccountReasons()
846
887
  ),
847
- delete_account_consent: Joi.any(),
848
- session_config: Joi.any(),
888
+ delete_account_consent: UserPlatformModel.DeleteAccountConsent(),
889
+ session_config: UserPlatformModel.SessionExpiry(),
890
+ __v: Joi.number(),
849
891
  });
850
892
  }
851
893
 
@@ -968,6 +1010,7 @@ class UserPlatformModel {
968
1010
  static Facebook() {
969
1011
  return Joi.object({
970
1012
  app_id: Joi.string().allow(""),
1013
+ app_secret: Joi.string().allow(""),
971
1014
  });
972
1015
  }
973
1016
 
@@ -975,6 +1018,7 @@ class UserPlatformModel {
975
1018
  static Accountkit() {
976
1019
  return Joi.object({
977
1020
  app_id: Joi.string().allow(""),
1021
+ app_secret: Joi.string().allow(""),
978
1022
  });
979
1023
  }
980
1024
 
@@ -982,6 +1026,7 @@ class UserPlatformModel {
982
1026
  static Google() {
983
1027
  return Joi.object({
984
1028
  app_id: Joi.string().allow(""),
1029
+ app_secret: Joi.string().allow(""),
985
1030
  });
986
1031
  }
987
1032
 
@@ -1083,6 +1128,31 @@ class UserPlatformModel {
1083
1128
  });
1084
1129
  }
1085
1130
 
1131
+ /** @returns {UserSearchSchema} */
1132
+ static UserSearchSchema() {
1133
+ return Joi.object({
1134
+ application_id: Joi.string().allow(""),
1135
+ user_id: Joi.string().allow(""),
1136
+ first_name: Joi.string().allow(""),
1137
+ meta: Joi.any(),
1138
+ last_name: Joi.string().allow(""),
1139
+ phone_numbers: Joi.array().items(UserPlatformModel.PhoneNumber()),
1140
+ emails: Joi.array().items(UserPlatformModel.Email()),
1141
+ gender: Joi.string().allow(""),
1142
+ dob: Joi.string().allow(""),
1143
+ active: Joi.boolean(),
1144
+ profile_pic_url: Joi.string().allow(""),
1145
+ username: Joi.string().allow(""),
1146
+ account_type: Joi.string().allow(""),
1147
+ _id: Joi.string().allow(""),
1148
+ created_at: Joi.string().allow(""),
1149
+ updated_at: Joi.string().allow(""),
1150
+ external_id: Joi.string().allow(""),
1151
+ archive: Joi.boolean(),
1152
+ status: Joi.string().allow(""),
1153
+ });
1154
+ }
1155
+
1086
1156
  /** @returns {PhoneNumber} */
1087
1157
  static PhoneNumber() {
1088
1158
  return Joi.object({