@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
@@ -21,8 +21,8 @@ class User {
21
21
  * @param {import("../PlatformAPIClient").Options} - Options
22
22
  * @returns {Promise<UserPlatformModel.ArchiveUserSuccess>} - Success response
23
23
  * @name archiveUser
24
- * @summary: archive user
25
- * @description: archive user - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/archiveUser/).
24
+ * @summary: Archive User
25
+ * @description: Delete user from sales channel, allowing re-registration with the same mobile/email for a new user account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/archiveUser/).
26
26
  */
27
27
  async archiveUser(
28
28
  { body, requestHeaders } = { requestHeaders: {} },
@@ -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 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/).
101
+ * @summary: Block/Unblock Users
102
+ * @description: Manage user access by blocking or unblocking their accounts, restricting login for blocked accounts and allowing login for unblocked 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: Register and add a new user to the platform. - 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 sales channel. - 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: {} },
@@ -258,7 +258,7 @@ class User {
258
258
  * Success response
259
259
  * @name createUserAttributeDefinition
260
260
  * @summary: Create a User Attribute Definition
261
- * @description: Use this API to areate a new User Attribute Definition - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/createUserAttributeDefinition/).
261
+ * @description: Create a new User Attribute Definition - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/createUserAttributeDefinition/).
262
262
  */
263
263
  async createUserAttributeDefinition(
264
264
  { body, requestHeaders } = { requestHeaders: {} },
@@ -336,7 +336,7 @@ class User {
336
336
  * @param {import("../PlatformAPIClient").Options} - Options
337
337
  * @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
338
338
  * @name createUserGroup
339
- * @summary: Create user group
339
+ * @summary: Create User Group
340
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(
@@ -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: Establish a session for user interactions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/createUserSession/).
419
+ * @summary: Create User Session
420
+ * @description: Create 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 active sessions
502
- * @description: End multiple active user sessions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/deleteActiveSessions/).
501
+ * @summary: Delete User Active Sessions
502
+ * @description: Terminate all 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,7 +582,7 @@ class User {
582
582
  * @returns {Promise<UserPlatformModel.SessionDeleteResponseSchema>} -
583
583
  * Success response
584
584
  * @name deleteSession
585
- * @summary: Delete session
585
+ * @summary: Delete User Session
586
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(
@@ -666,8 +666,8 @@ class User {
666
666
  * @param {import("../PlatformAPIClient").Options} - Options
667
667
  * @returns {Promise<UserPlatformModel.SuccessMessageResponse>} - Success response
668
668
  * @name deleteUserAttribute
669
- * @summary: delete User Attribute
670
- * @description: delete User Attribute - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/deleteUserAttribute/).
669
+ * @summary: Delete User Attribute
670
+ * @description: Delete User Attribute - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/deleteUserAttribute/).
671
671
  */
672
672
  async deleteUserAttribute(
673
673
  { attributeDefId, userId, requestHeaders } = { requestHeaders: {} },
@@ -818,7 +818,7 @@ class User {
818
818
  * @param {import("../PlatformAPIClient").Options} - Options
819
819
  * @returns {Promise<UserPlatformModel.SessionListResponseSchema>} - Success response
820
820
  * @name getActiveSessions
821
- * @summary: Get active sessions
821
+ * @summary: Get User Active Sessions
822
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(
@@ -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 customers
902
- * @description: Retrieve a list of customer profiles. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getCustomers/).
901
+ * @summary: Get a List of Users
902
+ * @description: Retrieve details of users registered in the sales channel - 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 config
986
- * @description: Retrieve configuration settings for the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getPlatformConfig/).
985
+ * @summary: Get Platform Config
986
+ * @description: Retrieve platform sales channel authentication configuration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getPlatformConfig/).
987
987
  */
988
988
  async getPlatformConfig(
989
989
  { requestHeaders } = { requestHeaders: {} },
@@ -1057,8 +1057,8 @@ class User {
1057
1057
  * @param {import("../PlatformAPIClient").Options} - Options
1058
1058
  * @returns {Promise<UserPlatformModel.UserAttributeResponse>} - Success response
1059
1059
  * @name getUserAttribute
1060
- * @summary: get User Attribute
1061
- * @description: get User Attribute - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserAttribute/).
1060
+ * @summary: Get User Attribute
1061
+ * @description: Get User Attribute - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserAttribute/).
1062
1062
  */
1063
1063
  async getUserAttribute(
1064
1064
  { attributeDefId, userId, requestHeaders } = { requestHeaders: {} },
@@ -1135,7 +1135,7 @@ class User {
1135
1135
  * @returns {Promise<UserPlatformModel.UserAttributeResponse>} - Success response
1136
1136
  * @name getUserAttributeById
1137
1137
  * @summary: Get User Attribute
1138
- * @description: Get User Attribute details by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserAttributeById/).
1138
+ * @description: Retrieve User Attribute details by ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserAttributeById/).
1139
1139
  */
1140
1140
  async getUserAttributeById(
1141
1141
  { attributeId, requestHeaders } = { requestHeaders: {} },
@@ -1411,8 +1411,8 @@ class User {
1411
1411
  * @param {import("../PlatformAPIClient").Options} - Options
1412
1412
  * @returns {Promise<Object>} - Success response
1413
1413
  * @name getUserAttributesForUser
1414
- * @summary: Get User Attributes for user
1415
- * @description: Get all user attributes for user - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserAttributesForUser/).
1414
+ * @summary: Get All Customer Attributes
1415
+ * @description: Retrieve all user attributes for a specific user - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserAttributesForUser/).
1416
1416
  */
1417
1417
  async getUserAttributesForUser(
1418
1418
  { userId, pageSize, pageNo, requestHeaders } = { requestHeaders: {} },
@@ -1496,7 +1496,7 @@ class User {
1496
1496
  * @param {import("../PlatformAPIClient").Options} - Options
1497
1497
  * @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
1498
1498
  * @name getUserGroupById
1499
- * @summary: Get user group by ID
1499
+ * @summary: Get User Group
1500
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(
@@ -1576,7 +1576,7 @@ class User {
1576
1576
  * @returns {Promise<UserPlatformModel.UserGroupListResponseSchema>} -
1577
1577
  * Success response
1578
1578
  * @name getUserGroups
1579
- * @summary: Get user groups
1579
+ * @summary: Get User Groups
1580
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(
@@ -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 users
1675
- * @description: Search and filter user profiles. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/searchUsers/).
1674
+ * @summary: Search an Existing Users
1675
+ * @description: Search and filter users details registered in the sales channel - 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,7 +1752,7 @@ 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
1755
+ * @summary: Restore Deleted User
1756
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(
@@ -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 config
1835
- * @description: Modify and update platform configuration settings. - 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 sales channel authentication configuration. - 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,7 +1910,7 @@ 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
1913
+ * @summary: Update User Details
1914
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(
@@ -2159,7 +2159,7 @@ class User {
2159
2159
  * @param {import("../PlatformAPIClient").Options} - Options
2160
2160
  * @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
2161
2161
  * @name updateUserGroup
2162
- * @summary: Update user group
2162
+ * @summary: Update User Group
2163
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(
@@ -2242,7 +2242,7 @@ class User {
2242
2242
  * @param {import("../PlatformAPIClient").Options} - Options
2243
2243
  * @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
2244
2244
  * @name updateUserGroupPartially
2245
- * @summary: Add or Remove an user from particular user group and update user group details
2245
+ * @summary: Modify User Group
2246
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(
@@ -9,7 +9,8 @@ declare class Webhook {
9
9
  * @returns {Promise<WebhookPlatformModel.CancelResponse>} - Success response
10
10
  * @name cancelJobByName
11
11
  * @summary: Cancel job by name
12
- * @description: Cancel a specific job by its name. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/cancelJobByName/).
12
+ * @description: It will cancel export job triggerd by user in order to fetch
13
+ * historical delivery summery - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/cancelJobByName/).
13
14
  */
14
15
  cancelJobByName({ filename, requestHeaders }?: WebhookPlatformValidator.CancelJobByNameParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.CancelResponse>;
15
16
  /**
@@ -28,7 +29,7 @@ declare class Webhook {
28
29
  * @param {import("../PlatformAPIClient").Options} - Options
29
30
  * @returns {Promise<WebhookPlatformModel.EventConfigResponse>} - Success response
30
31
  * @name fetchAllEventConfigurations
31
- * @summary: Fetch all event configurations
32
+ * @summary: List event configurations
32
33
  * @description: Retrieve all configurations for event handling. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/fetchAllEventConfigurations/).
33
34
  */
34
35
  fetchAllEventConfigurations({ requestHeaders }?: any, { responseHeaders }?: object): Promise<WebhookPlatformModel.EventConfigResponse>;
@@ -88,7 +89,7 @@ declare class Webhook {
88
89
  * @param {import("../PlatformAPIClient").Options} - Options
89
90
  * @returns {Promise<WebhookPlatformModel.SubscriberResponse>} - Success response
90
91
  * @name getSubscriberById
91
- * @summary: Get subscriber by ID
92
+ * @summary: Get a subscriber
92
93
  * @description: Retrieve a subscriber's details by their unique identifier. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getSubscriberById/).
93
94
  */
94
95
  getSubscriberById({ subscriberId, requestHeaders }?: WebhookPlatformValidator.GetSubscriberByIdParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.SubscriberResponse>;
@@ -98,7 +99,7 @@ declare class Webhook {
98
99
  * @param {import("../PlatformAPIClient").Options} - Options
99
100
  * @returns {Promise<WebhookPlatformModel.SubscriberConfigList>} - Success response
100
101
  * @name getSubscribersByCompany
101
- * @summary: Get subscribers by company
102
+ * @summary: List subscribers by company
102
103
  * @description: Retrieve subscribers associated with a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getSubscribersByCompany/).
103
104
  */
104
105
  getSubscribersByCompany({ pageNo, pageSize, extensionId, requestHeaders }?: WebhookPlatformValidator.GetSubscribersByCompanyParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.SubscriberConfigList>;
@@ -108,7 +109,7 @@ declare class Webhook {
108
109
  * @param {import("../PlatformAPIClient").Options} - Options
109
110
  * @returns {Promise<WebhookPlatformModel.SubscriberConfigList>} - Success response
110
111
  * @name getSubscribersByExtensionId
111
- * @summary: Get subscribers by extension ID
112
+ * @summary: List subscribers by extension ID
112
113
  * @description: Retrieve subscribers associated with a specific extension. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getSubscribersByExtensionId/).
113
114
  */
114
115
  getSubscribersByExtensionId({ extensionId, pageNo, pageSize, requestHeaders }?: WebhookPlatformValidator.GetSubscribersByExtensionIdParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.SubscriberConfigList>;
@@ -160,7 +161,7 @@ declare class Webhook {
160
161
  * @returns {Promise<WebhookPlatformModel.SubscriberConfigResponse>} -
161
162
  * Success response
162
163
  * @name updateSubscriberConfig
163
- * @summary: Update subscriber config
164
+ * @summary: Update a subscriber config
164
165
  * @description: Modify and update subscriber configuration settings. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/updateSubscriberConfig/).
165
166
  */
166
167
  updateSubscriberConfig({ body, requestHeaders }?: WebhookPlatformValidator.UpdateSubscriberConfigParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.SubscriberConfigResponse>;
@@ -21,7 +21,8 @@ class Webhook {
21
21
  * @returns {Promise<WebhookPlatformModel.CancelResponse>} - Success response
22
22
  * @name cancelJobByName
23
23
  * @summary: Cancel job by name
24
- * @description: Cancel a specific job by its name. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/cancelJobByName/).
24
+ * @description: It will cancel export job triggerd by user in order to fetch
25
+ * historical delivery summery - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/cancelJobByName/).
25
26
  */
26
27
  async cancelJobByName(
27
28
  { filename, requestHeaders } = { requestHeaders: {} },
@@ -180,7 +181,7 @@ class Webhook {
180
181
  * @param {import("../PlatformAPIClient").Options} - Options
181
182
  * @returns {Promise<WebhookPlatformModel.EventConfigResponse>} - Success response
182
183
  * @name fetchAllEventConfigurations
183
- * @summary: Fetch all event configurations
184
+ * @summary: List event configurations
184
185
  * @description: Retrieve all configurations for event handling. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/fetchAllEventConfigurations/).
185
186
  */
186
187
  async fetchAllEventConfigurations(
@@ -645,7 +646,7 @@ class Webhook {
645
646
  * @param {import("../PlatformAPIClient").Options} - Options
646
647
  * @returns {Promise<WebhookPlatformModel.SubscriberResponse>} - Success response
647
648
  * @name getSubscriberById
648
- * @summary: Get subscriber by ID
649
+ * @summary: Get a subscriber
649
650
  * @description: Retrieve a subscriber's details by their unique identifier. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getSubscriberById/).
650
651
  */
651
652
  async getSubscriberById(
@@ -724,7 +725,7 @@ class Webhook {
724
725
  * @param {import("../PlatformAPIClient").Options} - Options
725
726
  * @returns {Promise<WebhookPlatformModel.SubscriberConfigList>} - Success response
726
727
  * @name getSubscribersByCompany
727
- * @summary: Get subscribers by company
728
+ * @summary: List subscribers by company
728
729
  * @description: Retrieve subscribers associated with a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getSubscribersByCompany/).
729
730
  */
730
731
  async getSubscribersByCompany(
@@ -812,7 +813,7 @@ class Webhook {
812
813
  * @param {import("../PlatformAPIClient").Options} - Options
813
814
  * @returns {Promise<WebhookPlatformModel.SubscriberConfigList>} - Success response
814
815
  * @name getSubscribersByExtensionId
815
- * @summary: Get subscribers by extension ID
816
+ * @summary: List subscribers by extension ID
816
817
  * @description: Retrieve subscribers associated with a specific extension. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getSubscribersByExtensionId/).
817
818
  */
818
819
  async getSubscribersByExtensionId(
@@ -1212,7 +1213,7 @@ class Webhook {
1212
1213
  * @returns {Promise<WebhookPlatformModel.SubscriberConfigResponse>} -
1213
1214
  * Success response
1214
1215
  * @name updateSubscriberConfig
1215
- * @summary: Update subscriber config
1216
+ * @summary: Update a subscriber config
1216
1217
  * @description: Modify and update subscriber configuration settings. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/updateSubscriberConfig/).
1217
1218
  */
1218
1219
  async updateSubscriberConfig(
@@ -13,7 +13,6 @@ export namespace PlatformModel {
13
13
  const DiscountPlatformModel: typeof import("./Discount/DiscountPlatformModel");
14
14
  const FileStoragePlatformModel: typeof import("./FileStorage/FileStoragePlatformModel");
15
15
  const FinancePlatformModel: typeof import("./Finance/FinancePlatformModel");
16
- const InventoryPlatformModel: typeof import("./Inventory/InventoryPlatformModel");
17
16
  const LeadPlatformModel: typeof import("./Lead/LeadPlatformModel");
18
17
  const ServiceabilityPlatformModel: typeof import("./Serviceability/ServiceabilityPlatformModel");
19
18
  const OrderPlatformModel: typeof import("./Order/OrderPlatformModel");
@@ -26,8 +26,6 @@ module.exports = {
26
26
 
27
27
  FinancePlatformModel: require("./Finance/FinancePlatformModel"),
28
28
 
29
- InventoryPlatformModel: require("./Inventory/InventoryPlatformModel"),
30
-
31
29
  LeadPlatformModel: require("./Lead/LeadPlatformModel"),
32
30
 
33
31
  ServiceabilityPlatformModel: require("./Serviceability/ServiceabilityPlatformModel"),
@@ -1,152 +0,0 @@
1
- export = Inventory;
2
- declare class Inventory {
3
- constructor(config: any);
4
- config: any;
5
- /**
6
- * @param {InventoryPlatformValidator.CreateJobParam} arg - Arg object
7
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
8
- * @param {import("../PlatformAPIClient").Options} - Options
9
- * @returns {Promise<InventoryPlatformModel.ResponseEnvelopeString>} -
10
- * Success response
11
- * @name createJob
12
- * @summary: Creates A New Job Config
13
- * @description: REST Endpoint that creates a new job config - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/inventory/createJob/).
14
- */
15
- createJob({ body, requestHeaders }?: InventoryPlatformValidator.CreateJobParam, { responseHeaders }?: object): Promise<InventoryPlatformModel.ResponseEnvelopeString>;
16
- /**
17
- * @param {InventoryPlatformValidator.DisableParam} arg - Arg object
18
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
19
- * @param {import("../PlatformAPIClient").Options} - Options
20
- * @returns {Promise<InventoryPlatformModel.ResponseEnvelopeString>} -
21
- * Success response
22
- * @name disable
23
- * @summary: Disable Job Config
24
- * @description: REST Endpoint that disables Inventory Job Config - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/inventory/disable/).
25
- */
26
- disable({ integrationId, requestHeaders }?: InventoryPlatformValidator.DisableParam, { responseHeaders }?: object): Promise<InventoryPlatformModel.ResponseEnvelopeString>;
27
- /**
28
- * @param {InventoryPlatformValidator.GetConfigByCompanyParam} arg - Arg object
29
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
30
- * @param {import("../PlatformAPIClient").Options} - Options
31
- * @returns {Promise<InventoryPlatformModel.ResponseEnvelopeListSlingshotConfigurationDetail>}
32
- * - Success response
33
- *
34
- * @name getConfigByCompany
35
- * @summary: Get Slingshot Configuration Of A Company
36
- * @description: REST Endpoint that returns all configuration detail of a company - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/inventory/getConfigByCompany/).
37
- */
38
- getConfigByCompany({ requestHeaders }?: any, { responseHeaders }?: object): Promise<InventoryPlatformModel.ResponseEnvelopeListSlingshotConfigurationDetail>;
39
- /**
40
- * @param {InventoryPlatformValidator.GetJobByCodeParam} arg - Arg object
41
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
42
- * @param {import("../PlatformAPIClient").Options} - Options
43
- * @returns {Promise<InventoryPlatformModel.ResponseEnvelopeJobConfigDTO>}
44
- * - Success response
45
- *
46
- * @name getJobByCode
47
- * @summary: Get Job Config By Code
48
- * @description: REST Endpoint that returns job config by code - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/inventory/getJobByCode/).
49
- */
50
- getJobByCode({ code, requestHeaders }?: InventoryPlatformValidator.GetJobByCodeParam, { responseHeaders }?: object): Promise<InventoryPlatformModel.ResponseEnvelopeJobConfigDTO>;
51
- /**
52
- * @param {InventoryPlatformValidator.GetJobByCompanyAndIntegrationParam} arg
53
- * - Arg object
54
- *
55
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
56
- * @param {import("../PlatformAPIClient").Options} - Options
57
- * @returns {Promise<InventoryPlatformModel.ResponseEnvelopeListJobConfigDTO>}
58
- * - Success response
59
- *
60
- * @name getJobByCompanyAndIntegration
61
- * @summary: Get Job Configs By Company And Integration
62
- * @description: REST Endpoint that returns all job configs by company And integration - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/inventory/getJobByCompanyAndIntegration/).
63
- */
64
- getJobByCompanyAndIntegration({ integrationId, pageNo, pageSize, requestHeaders }?: InventoryPlatformValidator.GetJobByCompanyAndIntegrationParam, { responseHeaders }?: object): Promise<InventoryPlatformModel.ResponseEnvelopeListJobConfigDTO>;
65
- /**
66
- * @param {InventoryPlatformValidator.GetJobCodeMetricsParam} arg - Arg object
67
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
68
- * @param {import("../PlatformAPIClient").Options} - Options
69
- * @returns {Promise<InventoryPlatformModel.ResponseEnvelopeJobMetricsDto>}
70
- * - Success response
71
- *
72
- * @name getJobCodeMetrics
73
- * @summary: Get Job Metrics
74
- * @description: REST Endpoint that returns Inventory Run History For A Job Code - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/inventory/getJobCodeMetrics/).
75
- */
76
- getJobCodeMetrics({ code, pageNo, pageSize, status, date, requestHeaders }?: InventoryPlatformValidator.GetJobCodeMetricsParam, { responseHeaders }?: object): Promise<InventoryPlatformModel.ResponseEnvelopeJobMetricsDto>;
77
- /**
78
- * @param {InventoryPlatformValidator.GetJobCodesByCompanyAndIntegrationParam} arg
79
- * - Arg object
80
- *
81
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
82
- * @param {import("../PlatformAPIClient").Options} - Options
83
- * @returns {Promise<InventoryPlatformModel.ResponseEnvelopeListJobConfigListDTO>}
84
- * - Success response
85
- *
86
- * @name getJobCodesByCompanyAndIntegration
87
- * @summary: Get Job Codes By Company And Integration
88
- * @description: REST Endpoint that returns all job codes by company And integration - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/inventory/getJobCodesByCompanyAndIntegration/).
89
- */
90
- getJobCodesByCompanyAndIntegration({ integrationId, pageNo, pageSize, requestHeaders }?: InventoryPlatformValidator.GetJobCodesByCompanyAndIntegrationParam, { responseHeaders }?: object): Promise<InventoryPlatformModel.ResponseEnvelopeListJobConfigListDTO>;
91
- /**
92
- * @param {InventoryPlatformValidator.GetJobConfigDefaultsParam} arg - Arg object
93
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
94
- * @param {import("../PlatformAPIClient").Options} - Options
95
- * @returns {Promise<InventoryPlatformModel.ResponseEnvelopeJobConfigDTO>}
96
- * - Success response
97
- *
98
- * @name getJobConfigDefaults
99
- * @summary: Get Job Configs Defaults
100
- * @description: REST Endpoint that returns default fields job configs by company And integration - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/inventory/getJobConfigDefaults/).
101
- */
102
- getJobConfigDefaults({ requestHeaders }?: any, { responseHeaders }?: object): Promise<InventoryPlatformModel.ResponseEnvelopeJobConfigDTO>;
103
- /**
104
- * @param {InventoryPlatformValidator.GetJobStepsParam} arg - Arg object
105
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
106
- * @param {import("../PlatformAPIClient").Options} - Options
107
- * @returns {Promise<InventoryPlatformModel.ResponseEnvelopeListJobStepsDTO>}
108
- * - Success response
109
- *
110
- * @name getJobSteps
111
- * @summary: Get Job Code Steps
112
- * @description: REST Endpoint that returns Inventory Job Steps - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/inventory/getJobSteps/).
113
- */
114
- getJobSteps({ jobId, requestHeaders }?: InventoryPlatformValidator.GetJobStepsParam, { responseHeaders }?: object): Promise<InventoryPlatformModel.ResponseEnvelopeListJobStepsDTO>;
115
- /**
116
- * @param {InventoryPlatformValidator.GetJobsByCompanyParam} arg - Arg object
117
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
118
- * @param {import("../PlatformAPIClient").Options} - Options
119
- * @returns {Promise<InventoryPlatformModel.ResponseEnvelopeListJobConfigRawDTO>}
120
- * - Success response
121
- *
122
- * @name getJobsByCompany
123
- * @summary: Get Job Configs For A Company
124
- * @description: REST Endpoint that returns all job configs for a company - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/inventory/getJobsByCompany/).
125
- */
126
- getJobsByCompany({ pageNo, pageSize, requestHeaders }?: InventoryPlatformValidator.GetJobsByCompanyParam, { responseHeaders }?: object): Promise<InventoryPlatformModel.ResponseEnvelopeListJobConfigRawDTO>;
127
- /**
128
- * @param {InventoryPlatformValidator.SuppressStoresParam} arg - Arg object
129
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
130
- * @param {import("../PlatformAPIClient").Options} - Options
131
- * @returns {Promise<InventoryPlatformModel.ResponseEnvelopeKafkaResponse>}
132
- * - Success response
133
- *
134
- * @name suppressStores
135
- * @summary: Get Slingshot Configuration Of A Company
136
- * @description: REST Endpoint that returns all configuration detail of a company - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/inventory/suppressStores/).
137
- */
138
- suppressStores({ body, requestHeaders }?: InventoryPlatformValidator.SuppressStoresParam, { responseHeaders }?: object): Promise<InventoryPlatformModel.ResponseEnvelopeKafkaResponse>;
139
- /**
140
- * @param {InventoryPlatformValidator.UpdateJobParam} arg - Arg object
141
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
142
- * @param {import("../PlatformAPIClient").Options} - Options
143
- * @returns {Promise<InventoryPlatformModel.ResponseEnvelopeString>} -
144
- * Success response
145
- * @name updateJob
146
- * @summary: Updates An Existing Job Config
147
- * @description: REST Endpoint that updates a job config - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/inventory/updateJob/).
148
- */
149
- updateJob({ body, requestHeaders }?: InventoryPlatformValidator.UpdateJobParam, { responseHeaders }?: object): Promise<InventoryPlatformModel.ResponseEnvelopeString>;
150
- }
151
- import InventoryPlatformValidator = require("./InventoryPlatformValidator");
152
- import InventoryPlatformModel = require("./InventoryPlatformModel");