@gofynd/fdk-client-javascript 3.3.3 → 3.3.6

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 (158) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/Cart/CartApplicationClient.d.ts +30 -30
  4. package/sdk/application/Cart/CartApplicationClient.js +30 -30
  5. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +30 -30
  6. package/sdk/application/Catalog/CatalogApplicationClient.js +30 -30
  7. package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
  8. package/sdk/application/Common/CommonApplicationClient.js +2 -2
  9. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -3
  10. package/sdk/application/Communication/CommunicationApplicationClient.js +3 -3
  11. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +16 -16
  12. package/sdk/application/Configuration/ConfigurationApplicationClient.js +16 -16
  13. package/sdk/application/Content/ContentApplicationClient.d.ts +24 -24
  14. package/sdk/application/Content/ContentApplicationClient.js +24 -24
  15. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +3 -3
  16. package/sdk/application/FileStorage/FileStorageApplicationClient.js +3 -3
  17. package/sdk/application/Finance/FinanceApplicationClient.d.ts +2 -2
  18. package/sdk/application/Finance/FinanceApplicationClient.js +2 -2
  19. package/sdk/application/Lead/LeadApplicationClient.d.ts +5 -5
  20. package/sdk/application/Lead/LeadApplicationClient.js +5 -5
  21. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +9 -9
  22. package/sdk/application/Logistic/LogisticApplicationClient.js +9 -9
  23. package/sdk/application/Order/OrderApplicationClient.d.ts +12 -12
  24. package/sdk/application/Order/OrderApplicationClient.js +12 -12
  25. package/sdk/application/Payment/PaymentApplicationClient.d.ts +46 -46
  26. package/sdk/application/Payment/PaymentApplicationClient.js +46 -46
  27. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +7 -7
  28. package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
  29. package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
  30. package/sdk/application/Share/ShareApplicationClient.js +7 -7
  31. package/sdk/application/Theme/ThemeApplicationClient.d.ts +4 -4
  32. package/sdk/application/Theme/ThemeApplicationClient.js +4 -4
  33. package/sdk/application/User/UserApplicationClient.d.ts +47 -47
  34. package/sdk/application/User/UserApplicationClient.js +47 -47
  35. package/sdk/application/Webhook/WebhookApplicationClient.d.ts +1 -1
  36. package/sdk/application/Webhook/WebhookApplicationClient.js +1 -1
  37. package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +6 -6
  38. package/sdk/partner/FileStorage/FileStoragePartnerClient.js +6 -6
  39. package/sdk/partner/Lead/LeadPartnerClient.d.ts +7 -7
  40. package/sdk/partner/Lead/LeadPartnerClient.js +7 -7
  41. package/sdk/partner/Lead/LeadPartnerModel.d.ts +2 -2
  42. package/sdk/partner/Lead/LeadPartnerModel.js +1 -1
  43. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +25 -25
  44. package/sdk/partner/Logistics/LogisticsPartnerClient.js +25 -25
  45. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +57 -3
  46. package/sdk/partner/Logistics/LogisticsPartnerModel.js +40 -1
  47. package/sdk/partner/Theme/ThemePartnerClient.d.ts +24 -24
  48. package/sdk/partner/Theme/ThemePartnerClient.js +24 -24
  49. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +10 -10
  50. package/sdk/partner/Webhook/WebhookPartnerClient.js +10 -10
  51. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +2 -2
  52. package/sdk/partner/Webhook/WebhookPartnerModel.js +1 -1
  53. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +3 -3
  54. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +3 -3
  55. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +2 -2
  56. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +1 -1
  57. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +1 -1
  58. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +1 -1
  59. package/sdk/platform/Billing/BillingPlatformClient.d.ts +5 -5
  60. package/sdk/platform/Billing/BillingPlatformClient.js +5 -5
  61. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +62 -62
  62. package/sdk/platform/Cart/CartPlatformApplicationClient.js +62 -62
  63. package/sdk/platform/Cart/CartPlatformModel.d.ts +62 -3
  64. package/sdk/platform/Cart/CartPlatformModel.js +33 -1
  65. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +66 -66
  66. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +66 -66
  67. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +89 -82
  68. package/sdk/platform/Catalog/CatalogPlatformClient.js +121 -85
  69. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +61 -3
  70. package/sdk/platform/Catalog/CatalogPlatformModel.js +42 -1
  71. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +46 -5
  72. package/sdk/platform/Catalog/CatalogPlatformValidator.js +21 -4
  73. package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -2
  74. package/sdk/platform/Common/CommonPlatformClient.js +2 -2
  75. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +67 -67
  76. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +67 -67
  77. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
  78. package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
  79. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +2 -2
  80. package/sdk/platform/Communication/CommunicationPlatformModel.js +1 -1
  81. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +14 -14
  82. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +14 -14
  83. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -2
  84. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +1 -1
  85. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +32 -32
  86. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +32 -32
  87. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +11 -11
  88. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +11 -11
  89. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +2 -2
  90. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +1 -1
  91. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +107 -107
  92. package/sdk/platform/Content/ContentPlatformApplicationClient.js +107 -107
  93. package/sdk/platform/Content/ContentPlatformClient.d.ts +40 -40
  94. package/sdk/platform/Content/ContentPlatformClient.js +40 -40
  95. package/sdk/platform/Content/ContentPlatformModel.d.ts +2 -2
  96. package/sdk/platform/Content/ContentPlatformModel.js +1 -1
  97. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +11 -11
  98. package/sdk/platform/Discount/DiscountPlatformClient.js +11 -11
  99. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +2 -2
  100. package/sdk/platform/Discount/DiscountPlatformModel.js +1 -1
  101. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +4 -4
  102. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +4 -4
  103. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +6 -6
  104. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +6 -6
  105. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +10 -10
  106. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +10 -10
  107. package/sdk/platform/Lead/LeadPlatformClient.d.ts +9 -9
  108. package/sdk/platform/Lead/LeadPlatformClient.js +9 -9
  109. package/sdk/platform/Lead/LeadPlatformModel.d.ts +2 -2
  110. package/sdk/platform/Lead/LeadPlatformModel.js +1 -1
  111. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +5 -5
  112. package/sdk/platform/Order/OrderPlatformApplicationClient.js +5 -5
  113. package/sdk/platform/Order/OrderPlatformClient.d.ts +58 -58
  114. package/sdk/platform/Order/OrderPlatformClient.js +58 -58
  115. package/sdk/platform/Order/OrderPlatformModel.d.ts +9 -9
  116. package/sdk/platform/Order/OrderPlatformModel.js +6 -6
  117. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +2 -2
  118. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +2 -2
  119. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +51 -51
  120. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +51 -51
  121. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +10 -10
  122. package/sdk/platform/Payment/PaymentPlatformClient.js +10 -10
  123. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +85 -3
  124. package/sdk/platform/Payment/PaymentPlatformModel.js +49 -1
  125. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +12 -12
  126. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +12 -12
  127. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +2 -2
  128. package/sdk/platform/Rewards/RewardsPlatformModel.js +1 -1
  129. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +38 -38
  130. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +38 -38
  131. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +28 -28
  132. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +28 -28
  133. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +59 -3
  134. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +42 -1
  135. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +5 -5
  136. package/sdk/platform/Share/SharePlatformApplicationClient.js +5 -5
  137. package/sdk/platform/Share/SharePlatformModel.d.ts +2 -2
  138. package/sdk/platform/Share/SharePlatformModel.js +1 -1
  139. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +22 -22
  140. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +22 -22
  141. package/sdk/platform/Theme/ThemePlatformClient.d.ts +4 -4
  142. package/sdk/platform/Theme/ThemePlatformClient.js +4 -4
  143. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +34 -34
  144. package/sdk/platform/User/UserPlatformApplicationClient.js +34 -34
  145. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +9 -9
  146. package/sdk/platform/Webhook/WebhookPlatformClient.js +9 -9
  147. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +2 -2
  148. package/sdk/platform/Webhook/WebhookPlatformModel.js +1 -1
  149. package/sdk/public/Catalog/CatalogPublicClient.d.ts +1 -1
  150. package/sdk/public/Catalog/CatalogPublicClient.js +1 -1
  151. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -2
  152. package/sdk/public/Configuration/ConfigurationPublicClient.js +2 -2
  153. package/sdk/public/Content/ContentPublicClient.d.ts +14 -14
  154. package/sdk/public/Content/ContentPublicClient.js +14 -14
  155. package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
  156. package/sdk/public/Partner/PartnerPublicClient.js +1 -1
  157. package/sdk/public/Webhook/WebhookPublicClient.d.ts +5 -5
  158. package/sdk/public/Webhook/WebhookPublicClient.js +5 -5
@@ -10,7 +10,7 @@ declare class User {
10
10
  * @returns {Promise<UserPlatformModel.ArchiveUserSuccess>} - Success response
11
11
  * @name archiveUser
12
12
  * @summary: Archive User
13
- * @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/).
13
+ * @description: Delete user from sales channel, allowing re-registration with the same mobile/email for a new user account. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/archiveUser/).
14
14
  */
15
15
  archiveUser({ body, requestHeaders }?: UserPlatformApplicationValidator.ArchiveUserParam, { responseHeaders }?: object): Promise<UserPlatformModel.ArchiveUserSuccess>;
16
16
  /**
@@ -20,7 +20,7 @@ declare class User {
20
20
  * @returns {Promise<UserPlatformModel.BlockUserSuccess>} - Success response
21
21
  * @name blockOrUnblockUsers
22
22
  * @summary: Block/Unblock Users
23
- * @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/).
23
+ * @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://docs.fynd.com/partners/commerce/sdk/platform/user/blockOrUnblockUsers/).
24
24
  */
25
25
  blockOrUnblockUsers({ body, requestHeaders }?: UserPlatformApplicationValidator.BlockOrUnblockUsersParam, { responseHeaders }?: object): Promise<UserPlatformModel.BlockUserSuccess>;
26
26
  /**
@@ -32,7 +32,7 @@ declare class User {
32
32
  * @returns {Promise<UserPlatformModel.BulkActionModel>} - Success response
33
33
  * @name bulkImportStoreFrontUsers
34
34
  * @summary: Bulk import storefront customers using CSV and XLSX files.
35
- * @description: The API allows bulk import of storefront customers using CSV or XLSX files. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/bulkImportStoreFrontUsers/).
35
+ * @description: The API allows bulk import of storefront customers using CSV or XLSX files. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/bulkImportStoreFrontUsers/).
36
36
  */
37
37
  bulkImportStoreFrontUsers({ body, requestHeaders }?: UserPlatformApplicationValidator.BulkImportStoreFrontUsersParam, { responseHeaders }?: object): Promise<UserPlatformModel.BulkActionModel>;
38
38
  /**
@@ -44,7 +44,7 @@ declare class User {
44
44
  * @returns {Promise<UserPlatformModel.BulkActionModel>} - Success response
45
45
  * @name createBulkExportUsers
46
46
  * @summary: Bulk export storefront customers using CSV and XLSX files.
47
- * @description: This API allows bulk export of storefront users by requesting files in CSV or XLSX format. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/createBulkExportUsers/).
47
+ * @description: This API allows bulk export of storefront users by requesting files in CSV or XLSX format. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/createBulkExportUsers/).
48
48
  */
49
49
  createBulkExportUsers({ body, requestHeaders }?: UserPlatformApplicationValidator.CreateBulkExportUsersParam, { responseHeaders }?: object): Promise<UserPlatformModel.BulkActionModel>;
50
50
  /**
@@ -54,7 +54,7 @@ declare class User {
54
54
  * @returns {Promise<UserPlatformModel.CreateUserResponseSchema>} - Success response
55
55
  * @name createUser
56
56
  * @summary: Create User
57
- * @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/).
57
+ * @description: Register and add a new user to the sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/createUser/).
58
58
  */
59
59
  createUser({ body, requestHeaders }?: UserPlatformApplicationValidator.CreateUserParam, { responseHeaders }?: object): Promise<UserPlatformModel.CreateUserResponseSchema>;
60
60
  /**
@@ -67,7 +67,7 @@ declare class User {
67
67
  * Success response
68
68
  * @name createUserAttributeDefinition
69
69
  * @summary: Create a User Attribute Definition
70
- * @description: Create a new User Attribute Definition - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/createUserAttributeDefinition/).
70
+ * @description: Create a new User Attribute Definition - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/createUserAttributeDefinition/).
71
71
  */
72
72
  createUserAttributeDefinition({ body, requestHeaders }?: UserPlatformApplicationValidator.CreateUserAttributeDefinitionParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserAttributeDefinitionDetails>;
73
73
  /**
@@ -77,7 +77,7 @@ declare class User {
77
77
  * @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
78
78
  * @name createUserGroup
79
79
  * @summary: Create User Group
80
- * @description: Form and add a new user group. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/createUserGroup/).
80
+ * @description: Form and add a new user group. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/createUserGroup/).
81
81
  */
82
82
  createUserGroup({ body, requestHeaders }?: UserPlatformApplicationValidator.CreateUserGroupParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserGroupResponseSchema>;
83
83
  /**
@@ -88,7 +88,7 @@ declare class User {
88
88
  * Success response
89
89
  * @name createUserSession
90
90
  * @summary: Create User Session
91
- * @description: Create session for user interactions - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/createUserSession/).
91
+ * @description: Create session for user interactions - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/createUserSession/).
92
92
  */
93
93
  createUserSession({ body, requestHeaders }?: UserPlatformApplicationValidator.CreateUserSessionParam, { responseHeaders }?: object): Promise<UserPlatformModel.CreateUserSessionResponseSchema>;
94
94
  /**
@@ -101,7 +101,7 @@ declare class User {
101
101
  * Success response
102
102
  * @name deleteActiveSessions
103
103
  * @summary: Delete User Active Sessions
104
- * @description: Terminate all active user sessions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/deleteActiveSessions/).
104
+ * @description: Terminate all active user sessions. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/deleteActiveSessions/).
105
105
  */
106
106
  deleteActiveSessions({ id, reason, requestHeaders }?: UserPlatformApplicationValidator.DeleteActiveSessionsParam, { responseHeaders }?: object): Promise<UserPlatformModel.SessionsDeleteResponseSchema>;
107
107
  /**
@@ -112,7 +112,7 @@ declare class User {
112
112
  * Success response
113
113
  * @name deleteSession
114
114
  * @summary: Delete User Session
115
- * @description: Terminate an active user session. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/deleteSession/).
115
+ * @description: Terminate an active user session. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/deleteSession/).
116
116
  */
117
117
  deleteSession({ id, sessionId, reason, requestHeaders }?: UserPlatformApplicationValidator.DeleteSessionParam, { responseHeaders }?: object): Promise<UserPlatformModel.SessionDeleteResponseSchema>;
118
118
  /**
@@ -122,7 +122,7 @@ declare class User {
122
122
  * @returns {Promise<UserPlatformModel.SuccessMessage>} - Success response
123
123
  * @name deleteUserAttribute
124
124
  * @summary: Delete User Attribute
125
- * @description: Delete User Attribute - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/deleteUserAttribute/).
125
+ * @description: Delete User Attribute - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/deleteUserAttribute/).
126
126
  */
127
127
  deleteUserAttribute({ attributeDefId, userId, requestHeaders }?: UserPlatformApplicationValidator.DeleteUserAttributeParam, { responseHeaders }?: object): Promise<UserPlatformModel.SuccessMessage>;
128
128
  /**
@@ -134,7 +134,7 @@ declare class User {
134
134
  * @returns {Promise<UserPlatformModel.SuccessMessage>} - Success response
135
135
  * @name deleteUserAttributeDefinitionById
136
136
  * @summary: Delete User Attribute Definition
137
- * @description: Delete a user attribute definition by its unique identifier. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/deleteUserAttributeDefinitionById/).
137
+ * @description: Delete a user attribute definition by its unique identifier. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/deleteUserAttributeDefinitionById/).
138
138
  */
139
139
  deleteUserAttributeDefinitionById({ attributeDefId, requestHeaders }?: UserPlatformApplicationValidator.DeleteUserAttributeDefinitionByIdParam, { responseHeaders }?: object): Promise<UserPlatformModel.SuccessMessage>;
140
140
  /**
@@ -144,7 +144,7 @@ declare class User {
144
144
  * @returns {Promise<UserPlatformModel.SessionListResponseSchema>} - Success response
145
145
  * @name getActiveSessions
146
146
  * @summary: Get User Active Sessions
147
- * @description: Retrieve a list of currently active user sessions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getActiveSessions/).
147
+ * @description: Retrieve a list of currently active user sessions. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getActiveSessions/).
148
148
  */
149
149
  getActiveSessions({ id, requestHeaders }?: UserPlatformApplicationValidator.GetActiveSessionsParam, { responseHeaders }?: object): Promise<UserPlatformModel.SessionListResponseSchema>;
150
150
  /**
@@ -158,7 +158,7 @@ declare class User {
158
158
  * @summary: Get Bulk User's Export Lists for a specific Application.
159
159
  * @description: This API allows fetching the list of bulk user exports for a specific application and company.
160
160
  * It supports pagination and filtering based on various parameters.
161
- * - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getBulkExportUsersList/).
161
+ * - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getBulkExportUsersList/).
162
162
  */
163
163
  getBulkExportUsersList({ pageNo, pageSize, fileFormat, search, startDate, endDate, status, requestHeaders, }?: UserPlatformApplicationValidator.GetBulkExportUsersListParam, { responseHeaders }?: object): Promise<UserPlatformModel.BulkActionPaginationSchema>;
164
164
  /**
@@ -172,7 +172,7 @@ declare class User {
172
172
  * @summary: Get Bulk User's Import Lists for a specific Application.
173
173
  * @description: This API allows fetching the list of bulk user imports for a specific application and company.
174
174
  * It supports pagination and filtering based on various parameters.
175
- * - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getBulkImportUsersList/).
175
+ * - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getBulkImportUsersList/).
176
176
  */
177
177
  getBulkImportUsersList({ pageNo, pageSize, search, startDate, endDate, status, fileFormat, requestHeaders, }?: UserPlatformApplicationValidator.GetBulkImportUsersListParam, { responseHeaders }?: object): Promise<UserPlatformModel.BulkActionPaginationSchema>;
178
178
  /**
@@ -182,7 +182,7 @@ declare class User {
182
182
  * @returns {Promise<UserPlatformModel.CustomerListResponseSchema>} - Success response
183
183
  * @name getCustomers
184
184
  * @summary: Get a List of Users
185
- * @description: Retrieve details of users registered in the sales channel - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getCustomers/).
185
+ * @description: Retrieve details of users registered in the sales channel - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getCustomers/).
186
186
  */
187
187
  getCustomers({ q, pageSize, pageNo, requestHeaders }?: UserPlatformApplicationValidator.GetCustomersParam, { responseHeaders }?: object): Promise<UserPlatformModel.CustomerListResponseSchema>;
188
188
  /**
@@ -192,7 +192,7 @@ declare class User {
192
192
  * @returns {Promise<UserPlatformModel.PlatformSchema>} - Success response
193
193
  * @name getPlatformConfig
194
194
  * @summary: Get Platform Config
195
- * @description: Retrieve platform sales channel authentication configuration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getPlatformConfig/).
195
+ * @description: Retrieve platform sales channel authentication configuration. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getPlatformConfig/).
196
196
  */
197
197
  getPlatformConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<UserPlatformModel.PlatformSchema>;
198
198
  /**
@@ -202,7 +202,7 @@ declare class User {
202
202
  * @returns {Promise<UserPlatformModel.UserAttribute>} - Success response
203
203
  * @name getUserAttribute
204
204
  * @summary: Get User Attribute
205
- * @description: Get User Attribute - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserAttribute/).
205
+ * @description: Get User Attribute - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getUserAttribute/).
206
206
  */
207
207
  getUserAttribute({ attributeDefId, userId, requestHeaders }?: UserPlatformApplicationValidator.GetUserAttributeParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserAttribute>;
208
208
  /**
@@ -214,7 +214,7 @@ declare class User {
214
214
  * @returns {Promise<UserPlatformModel.UserAttribute>} - Success response
215
215
  * @name getUserAttributeById
216
216
  * @summary: Get User Attribute
217
- * @description: Retrieve User Attribute details by ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserAttributeById/).
217
+ * @description: Retrieve User Attribute details by ID. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getUserAttributeById/).
218
218
  */
219
219
  getUserAttributeById({ attributeId, requestHeaders }?: UserPlatformApplicationValidator.GetUserAttributeByIdParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserAttribute>;
220
220
  /**
@@ -226,7 +226,7 @@ declare class User {
226
226
  * @returns {Promise<UserPlatformModel.UserAttributeDefinition>} - Success response
227
227
  * @name getUserAttributeDefinitionById
228
228
  * @summary: Get User Attribute Definition
229
- * @description: Get a user attribute definition by its unique identifier. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserAttributeDefinitionById/).
229
+ * @description: Get a user attribute definition by its unique identifier. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getUserAttributeDefinitionById/).
230
230
  */
231
231
  getUserAttributeDefinitionById({ attributeDefId, requestHeaders }?: UserPlatformApplicationValidator.GetUserAttributeDefinitionByIdParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserAttributeDefinition>;
232
232
  /**
@@ -238,7 +238,7 @@ declare class User {
238
238
  * @returns {Promise<Object>} - Success response
239
239
  * @name getUserAttributeDefinitions
240
240
  * @summary: Get User Attribute Definitions
241
- * @description: Retrieve user attribute definitions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserAttributeDefinitions/).
241
+ * @description: Retrieve user attribute definitions. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getUserAttributeDefinitions/).
242
242
  */
243
243
  getUserAttributeDefinitions({ excludingIds, slug, type, customerEditable, encrypted, pinned, pinOrder, isLocked, name, pageSize, pageNo, requestHeaders, }?: UserPlatformApplicationValidator.GetUserAttributeDefinitionsParam, { responseHeaders }?: object): Promise<any>;
244
244
  /**
@@ -250,7 +250,7 @@ declare class User {
250
250
  * @returns {Promise<Object>} - Success response
251
251
  * @name getUserAttributesForUser
252
252
  * @summary: Get All Customer Attributes
253
- * @description: Retrieve all user attributes for a specific user - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserAttributesForUser/).
253
+ * @description: Retrieve all user attributes for a specific user - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getUserAttributesForUser/).
254
254
  */
255
255
  getUserAttributesForUser({ userId, pageSize, pageNo, requestHeaders }?: UserPlatformApplicationValidator.GetUserAttributesForUserParam, { responseHeaders }?: object): Promise<any>;
256
256
  /**
@@ -260,7 +260,7 @@ declare class User {
260
260
  * @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
261
261
  * @name getUserGroupById
262
262
  * @summary: Get User Group
263
- * @description: Retrieve a user group by its unique identifier. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserGroupById/).
263
+ * @description: Retrieve a user group by its unique identifier. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getUserGroupById/).
264
264
  */
265
265
  getUserGroupById({ groupId, requestHeaders }?: UserPlatformApplicationValidator.GetUserGroupByIdParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserGroupResponseSchema>;
266
266
  /**
@@ -271,7 +271,7 @@ declare class User {
271
271
  * Success response
272
272
  * @name getUserGroups
273
273
  * @summary: Get User Groups
274
- * @description: Retrieve a list of user groups. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserGroups/).
274
+ * @description: Retrieve a list of user groups. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getUserGroups/).
275
275
  */
276
276
  getUserGroups({ pageNo, pageSize, name, type, status, groupUid, requestHeaders }?: UserPlatformApplicationValidator.GetUserGroupsParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserGroupListResponseSchema>;
277
277
  /**
@@ -281,7 +281,7 @@ declare class User {
281
281
  * @returns {Promise<UserPlatformModel.GetUserTimeline>} - Success response
282
282
  * @name getUserTimeline
283
283
  * @summary: Get Deleted User Timeline
284
- * @description: Fetches the timeline for the user who has made a data erase request. The timeline will show when the request was raised and when the request will be completed. It will also show if request has been cancelled before completion. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserTimeline/).
284
+ * @description: Fetches the timeline for the user who has made a data erase request. The timeline will show when the request was raised and when the request will be completed. It will also show if request has been cancelled before completion. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getUserTimeline/).
285
285
  */
286
286
  getUserTimeline({ userId, requestHeaders }?: UserPlatformApplicationValidator.GetUserTimelineParam, { responseHeaders }?: object): Promise<UserPlatformModel.GetUserTimeline>;
287
287
  /**
@@ -292,7 +292,7 @@ declare class User {
292
292
  * @name getUsersJobByJobId
293
293
  * @summary: Retrieve Job Details by Job ID for a Specific Application, Including Both Import and Export Jobs.
294
294
  * @description: This endpoint retrieves the details of a specific user's import and export related jobs associated with a given `job_id`, `application_id`, and `company_id`.
295
- * - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUsersJobByJobId/).
295
+ * - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getUsersJobByJobId/).
296
296
  */
297
297
  getUsersJobByJobId({ jobId, requestHeaders }?: UserPlatformApplicationValidator.GetUsersJobByJobIdParam, { responseHeaders }?: object): Promise<UserPlatformModel.BulkActionModel>;
298
298
  /**
@@ -302,7 +302,7 @@ declare class User {
302
302
  * @returns {Promise<UserPlatformModel.UserSearchResponseSchema>} - Success response
303
303
  * @name searchUsers
304
304
  * @summary: Search an Existing Users
305
- * @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/).
305
+ * @description: Search and filter users details registered in the sales channel - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/searchUsers/).
306
306
  */
307
307
  searchUsers({ q, query, requestHeaders }?: UserPlatformApplicationValidator.SearchUsersParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserSearchResponseSchema>;
308
308
  /**
@@ -312,7 +312,7 @@ declare class User {
312
312
  * @returns {Promise<UserPlatformModel.UnDeleteUserSuccess>} - Success response
313
313
  * @name unDeleteUser
314
314
  * @summary: Restore Deleted User
315
- * @description: Restore a previously deleted user account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/unDeleteUser/).
315
+ * @description: Restore a previously deleted user account. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/unDeleteUser/).
316
316
  */
317
317
  unDeleteUser({ body, requestHeaders }?: UserPlatformApplicationValidator.UnDeleteUserParam, { responseHeaders }?: object): Promise<UserPlatformModel.UnDeleteUserSuccess>;
318
318
  /**
@@ -324,7 +324,7 @@ declare class User {
324
324
  * @returns {Promise<UserPlatformModel.PlatformSchema>} - Success response
325
325
  * @name updatePlatformConfig
326
326
  * @summary: Update Platform Config
327
- * @description: Modify and update platform sales channel authentication configuration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updatePlatformConfig/).
327
+ * @description: Modify and update platform sales channel authentication configuration. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/updatePlatformConfig/).
328
328
  */
329
329
  updatePlatformConfig({ body, requestHeaders }?: UserPlatformApplicationValidator.UpdatePlatformConfigParam, { responseHeaders }?: object): Promise<UserPlatformModel.PlatformSchema>;
330
330
  /**
@@ -334,7 +334,7 @@ declare class User {
334
334
  * @returns {Promise<UserPlatformModel.CreateUserResponseSchema>} - Success response
335
335
  * @name updateUser
336
336
  * @summary: Update User Details
337
- * @description: Modify and update user profile information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updateUser/).
337
+ * @description: Modify and update user profile information. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/updateUser/).
338
338
  */
339
339
  updateUser({ userId, body, requestHeaders }?: UserPlatformApplicationValidator.UpdateUserParam, { responseHeaders }?: object): Promise<UserPlatformModel.CreateUserResponseSchema>;
340
340
  /**
@@ -344,7 +344,7 @@ declare class User {
344
344
  * @returns {Promise<UserPlatformModel.UserAttribute>} - Success response
345
345
  * @name updateUserAttribute
346
346
  * @summary: Update Or Create User Attribute
347
- * @description: Update Or Create User Attribute - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updateUserAttribute/).
347
+ * @description: Update Or Create User Attribute - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/updateUserAttribute/).
348
348
  */
349
349
  updateUserAttribute({ attributeDefId, userId, body, requestHeaders }?: UserPlatformApplicationValidator.UpdateUserAttributeParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserAttribute>;
350
350
  /**
@@ -356,7 +356,7 @@ declare class User {
356
356
  * @returns {Promise<UserPlatformModel.UserAttributeDefinition>} - Success response
357
357
  * @name updateUserAttributeDefinition
358
358
  * @summary: Update User Attribute Definition
359
- * @description: Update an existing user attribute definition. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updateUserAttributeDefinition/).
359
+ * @description: Update an existing user attribute definition. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/updateUserAttributeDefinition/).
360
360
  */
361
361
  updateUserAttributeDefinition({ attributeDefId, body, requestHeaders }?: UserPlatformApplicationValidator.UpdateUserAttributeDefinitionParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserAttributeDefinition>;
362
362
  /**
@@ -366,7 +366,7 @@ declare class User {
366
366
  * @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
367
367
  * @name updateUserGroup
368
368
  * @summary: Update User Group
369
- * @description: Modify and update user group details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updateUserGroup/).
369
+ * @description: Modify and update user group details. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/updateUserGroup/).
370
370
  */
371
371
  updateUserGroup({ groupId, body, requestHeaders }?: UserPlatformApplicationValidator.UpdateUserGroupParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserGroupResponseSchema>;
372
372
  /**
@@ -378,7 +378,7 @@ declare class User {
378
378
  * @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
379
379
  * @name updateUserGroupPartially
380
380
  * @summary: Modify User Group
381
- * @description: Update user group partially on the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updateUserGroupPartially/).
381
+ * @description: Update user group partially on the platform. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/updateUserGroupPartially/).
382
382
  */
383
383
  updateUserGroupPartially({ groupId, body, requestHeaders }?: UserPlatformApplicationValidator.UpdateUserGroupPartiallyParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserGroupResponseSchema>;
384
384
  }
@@ -22,7 +22,7 @@ class User {
22
22
  * @returns {Promise<UserPlatformModel.ArchiveUserSuccess>} - Success response
23
23
  * @name archiveUser
24
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/).
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://docs.fynd.com/partners/commerce/sdk/platform/user/archiveUser/).
26
26
  */
27
27
  async archiveUser(
28
28
  { body, requestHeaders } = { requestHeaders: {} },
@@ -99,7 +99,7 @@ class User {
99
99
  * @returns {Promise<UserPlatformModel.BlockUserSuccess>} - Success response
100
100
  * @name blockOrUnblockUsers
101
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/).
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://docs.fynd.com/partners/commerce/sdk/platform/user/blockOrUnblockUsers/).
103
103
  */
104
104
  async blockOrUnblockUsers(
105
105
  { body, requestHeaders } = { requestHeaders: {} },
@@ -180,7 +180,7 @@ class User {
180
180
  * @returns {Promise<UserPlatformModel.BulkActionModel>} - Success response
181
181
  * @name bulkImportStoreFrontUsers
182
182
  * @summary: Bulk import storefront customers using CSV and XLSX files.
183
- * @description: The API allows bulk import of storefront customers using CSV or XLSX files. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/bulkImportStoreFrontUsers/).
183
+ * @description: The API allows bulk import of storefront customers using CSV or XLSX files. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/bulkImportStoreFrontUsers/).
184
184
  */
185
185
  async bulkImportStoreFrontUsers(
186
186
  { body, requestHeaders } = { requestHeaders: {} },
@@ -261,7 +261,7 @@ class User {
261
261
  * @returns {Promise<UserPlatformModel.BulkActionModel>} - Success response
262
262
  * @name createBulkExportUsers
263
263
  * @summary: Bulk export storefront customers using CSV and XLSX files.
264
- * @description: This API allows bulk export of storefront users by requesting files in CSV or XLSX format. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/createBulkExportUsers/).
264
+ * @description: This API allows bulk export of storefront users by requesting files in CSV or XLSX format. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/createBulkExportUsers/).
265
265
  */
266
266
  async createBulkExportUsers(
267
267
  { body, requestHeaders } = { requestHeaders: {} },
@@ -340,7 +340,7 @@ class User {
340
340
  * @returns {Promise<UserPlatformModel.CreateUserResponseSchema>} - Success response
341
341
  * @name createUser
342
342
  * @summary: Create User
343
- * @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/).
343
+ * @description: Register and add a new user to the sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/createUser/).
344
344
  */
345
345
  async createUser(
346
346
  { body, requestHeaders } = { requestHeaders: {} },
@@ -420,7 +420,7 @@ class User {
420
420
  * Success response
421
421
  * @name createUserAttributeDefinition
422
422
  * @summary: Create a User Attribute Definition
423
- * @description: Create a new User Attribute Definition - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/createUserAttributeDefinition/).
423
+ * @description: Create a new User Attribute Definition - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/createUserAttributeDefinition/).
424
424
  */
425
425
  async createUserAttributeDefinition(
426
426
  { body, requestHeaders } = { requestHeaders: {} },
@@ -499,7 +499,7 @@ class User {
499
499
  * @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
500
500
  * @name createUserGroup
501
501
  * @summary: Create User Group
502
- * @description: Form and add a new user group. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/createUserGroup/).
502
+ * @description: Form and add a new user group. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/createUserGroup/).
503
503
  */
504
504
  async createUserGroup(
505
505
  { body, requestHeaders } = { requestHeaders: {} },
@@ -579,7 +579,7 @@ class User {
579
579
  * Success response
580
580
  * @name createUserSession
581
581
  * @summary: Create User Session
582
- * @description: Create session for user interactions - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/createUserSession/).
582
+ * @description: Create session for user interactions - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/createUserSession/).
583
583
  */
584
584
  async createUserSession(
585
585
  { body, requestHeaders } = { requestHeaders: {} },
@@ -661,7 +661,7 @@ class User {
661
661
  * Success response
662
662
  * @name deleteActiveSessions
663
663
  * @summary: Delete User Active Sessions
664
- * @description: Terminate all active user sessions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/deleteActiveSessions/).
664
+ * @description: Terminate all active user sessions. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/deleteActiveSessions/).
665
665
  */
666
666
  async deleteActiveSessions(
667
667
  { id, reason, requestHeaders } = { requestHeaders: {} },
@@ -745,7 +745,7 @@ class User {
745
745
  * Success response
746
746
  * @name deleteSession
747
747
  * @summary: Delete User Session
748
- * @description: Terminate an active user session. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/deleteSession/).
748
+ * @description: Terminate an active user session. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/deleteSession/).
749
749
  */
750
750
  async deleteSession(
751
751
  { id, sessionId, reason, requestHeaders } = { requestHeaders: {} },
@@ -829,7 +829,7 @@ class User {
829
829
  * @returns {Promise<UserPlatformModel.SuccessMessage>} - Success response
830
830
  * @name deleteUserAttribute
831
831
  * @summary: Delete User Attribute
832
- * @description: Delete User Attribute - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/deleteUserAttribute/).
832
+ * @description: Delete User Attribute - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/deleteUserAttribute/).
833
833
  */
834
834
  async deleteUserAttribute(
835
835
  { attributeDefId, userId, requestHeaders } = { requestHeaders: {} },
@@ -906,7 +906,7 @@ class User {
906
906
  * @returns {Promise<UserPlatformModel.SuccessMessage>} - Success response
907
907
  * @name deleteUserAttributeDefinitionById
908
908
  * @summary: Delete User Attribute Definition
909
- * @description: Delete a user attribute definition by its unique identifier. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/deleteUserAttributeDefinitionById/).
909
+ * @description: Delete a user attribute definition by its unique identifier. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/deleteUserAttributeDefinitionById/).
910
910
  */
911
911
  async deleteUserAttributeDefinitionById(
912
912
  { attributeDefId, requestHeaders } = { requestHeaders: {} },
@@ -981,7 +981,7 @@ class User {
981
981
  * @returns {Promise<UserPlatformModel.SessionListResponseSchema>} - Success response
982
982
  * @name getActiveSessions
983
983
  * @summary: Get User Active Sessions
984
- * @description: Retrieve a list of currently active user sessions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getActiveSessions/).
984
+ * @description: Retrieve a list of currently active user sessions. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getActiveSessions/).
985
985
  */
986
986
  async getActiveSessions(
987
987
  { id, requestHeaders } = { requestHeaders: {} },
@@ -1065,7 +1065,7 @@ class User {
1065
1065
  * @summary: Get Bulk User's Export Lists for a specific Application.
1066
1066
  * @description: This API allows fetching the list of bulk user exports for a specific application and company.
1067
1067
  * It supports pagination and filtering based on various parameters.
1068
- * - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getBulkExportUsersList/).
1068
+ * - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getBulkExportUsersList/).
1069
1069
  */
1070
1070
  async getBulkExportUsersList(
1071
1071
  {
@@ -1176,7 +1176,7 @@ class User {
1176
1176
  * @summary: Get Bulk User's Import Lists for a specific Application.
1177
1177
  * @description: This API allows fetching the list of bulk user imports for a specific application and company.
1178
1178
  * It supports pagination and filtering based on various parameters.
1179
- * - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getBulkImportUsersList/).
1179
+ * - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getBulkImportUsersList/).
1180
1180
  */
1181
1181
  async getBulkImportUsersList(
1182
1182
  {
@@ -1283,7 +1283,7 @@ class User {
1283
1283
  * @returns {Promise<UserPlatformModel.CustomerListResponseSchema>} - Success response
1284
1284
  * @name getCustomers
1285
1285
  * @summary: Get a List of Users
1286
- * @description: Retrieve details of users registered in the sales channel - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getCustomers/).
1286
+ * @description: Retrieve details of users registered in the sales channel - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getCustomers/).
1287
1287
  */
1288
1288
  async getCustomers(
1289
1289
  { q, pageSize, pageNo, requestHeaders } = { requestHeaders: {} },
@@ -1367,7 +1367,7 @@ class User {
1367
1367
  * @returns {Promise<UserPlatformModel.PlatformSchema>} - Success response
1368
1368
  * @name getPlatformConfig
1369
1369
  * @summary: Get Platform Config
1370
- * @description: Retrieve platform sales channel authentication configuration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getPlatformConfig/).
1370
+ * @description: Retrieve platform sales channel authentication configuration. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getPlatformConfig/).
1371
1371
  */
1372
1372
  async getPlatformConfig(
1373
1373
  { requestHeaders } = { requestHeaders: {} },
@@ -1442,7 +1442,7 @@ class User {
1442
1442
  * @returns {Promise<UserPlatformModel.UserAttribute>} - Success response
1443
1443
  * @name getUserAttribute
1444
1444
  * @summary: Get User Attribute
1445
- * @description: Get User Attribute - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserAttribute/).
1445
+ * @description: Get User Attribute - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getUserAttribute/).
1446
1446
  */
1447
1447
  async getUserAttribute(
1448
1448
  { attributeDefId, userId, requestHeaders } = { requestHeaders: {} },
@@ -1519,7 +1519,7 @@ class User {
1519
1519
  * @returns {Promise<UserPlatformModel.UserAttribute>} - Success response
1520
1520
  * @name getUserAttributeById
1521
1521
  * @summary: Get User Attribute
1522
- * @description: Retrieve User Attribute details by ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserAttributeById/).
1522
+ * @description: Retrieve User Attribute details by ID. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getUserAttributeById/).
1523
1523
  */
1524
1524
  async getUserAttributeById(
1525
1525
  { attributeId, requestHeaders } = { requestHeaders: {} },
@@ -1596,7 +1596,7 @@ class User {
1596
1596
  * @returns {Promise<UserPlatformModel.UserAttributeDefinition>} - Success response
1597
1597
  * @name getUserAttributeDefinitionById
1598
1598
  * @summary: Get User Attribute Definition
1599
- * @description: Get a user attribute definition by its unique identifier. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserAttributeDefinitionById/).
1599
+ * @description: Get a user attribute definition by its unique identifier. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getUserAttributeDefinitionById/).
1600
1600
  */
1601
1601
  async getUserAttributeDefinitionById(
1602
1602
  { attributeDefId, requestHeaders } = { requestHeaders: {} },
@@ -1673,7 +1673,7 @@ class User {
1673
1673
  * @returns {Promise<Object>} - Success response
1674
1674
  * @name getUserAttributeDefinitions
1675
1675
  * @summary: Get User Attribute Definitions
1676
- * @description: Retrieve user attribute definitions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserAttributeDefinitions/).
1676
+ * @description: Retrieve user attribute definitions. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getUserAttributeDefinitions/).
1677
1677
  */
1678
1678
  async getUserAttributeDefinitions(
1679
1679
  {
@@ -1796,7 +1796,7 @@ class User {
1796
1796
  * @returns {Promise<Object>} - Success response
1797
1797
  * @name getUserAttributesForUser
1798
1798
  * @summary: Get All Customer Attributes
1799
- * @description: Retrieve all user attributes for a specific user - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserAttributesForUser/).
1799
+ * @description: Retrieve all user attributes for a specific user - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getUserAttributesForUser/).
1800
1800
  */
1801
1801
  async getUserAttributesForUser(
1802
1802
  { userId, pageSize, pageNo, requestHeaders } = { requestHeaders: {} },
@@ -1881,7 +1881,7 @@ class User {
1881
1881
  * @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
1882
1882
  * @name getUserGroupById
1883
1883
  * @summary: Get User Group
1884
- * @description: Retrieve a user group by its unique identifier. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserGroupById/).
1884
+ * @description: Retrieve a user group by its unique identifier. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getUserGroupById/).
1885
1885
  */
1886
1886
  async getUserGroupById(
1887
1887
  { groupId, requestHeaders } = { requestHeaders: {} },
@@ -1961,7 +1961,7 @@ class User {
1961
1961
  * Success response
1962
1962
  * @name getUserGroups
1963
1963
  * @summary: Get User Groups
1964
- * @description: Retrieve a list of user groups. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserGroups/).
1964
+ * @description: Retrieve a list of user groups. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getUserGroups/).
1965
1965
  */
1966
1966
  async getUserGroups(
1967
1967
  { pageNo, pageSize, name, type, status, groupUid, requestHeaders } = {
@@ -2056,7 +2056,7 @@ class User {
2056
2056
  * @returns {Promise<UserPlatformModel.GetUserTimeline>} - Success response
2057
2057
  * @name getUserTimeline
2058
2058
  * @summary: Get Deleted User Timeline
2059
- * @description: Fetches the timeline for the user who has made a data erase request. The timeline will show when the request was raised and when the request will be completed. It will also show if request has been cancelled before completion. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserTimeline/).
2059
+ * @description: Fetches the timeline for the user who has made a data erase request. The timeline will show when the request was raised and when the request will be completed. It will also show if request has been cancelled before completion. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getUserTimeline/).
2060
2060
  */
2061
2061
  async getUserTimeline(
2062
2062
  { userId, requestHeaders } = { requestHeaders: {} },
@@ -2136,7 +2136,7 @@ class User {
2136
2136
  * @name getUsersJobByJobId
2137
2137
  * @summary: Retrieve Job Details by Job ID for a Specific Application, Including Both Import and Export Jobs.
2138
2138
  * @description: This endpoint retrieves the details of a specific user's import and export related jobs associated with a given `job_id`, `application_id`, and `company_id`.
2139
- * - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUsersJobByJobId/).
2139
+ * - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getUsersJobByJobId/).
2140
2140
  */
2141
2141
  async getUsersJobByJobId(
2142
2142
  { jobId, requestHeaders } = { requestHeaders: {} },
@@ -2215,7 +2215,7 @@ class User {
2215
2215
  * @returns {Promise<UserPlatformModel.UserSearchResponseSchema>} - Success response
2216
2216
  * @name searchUsers
2217
2217
  * @summary: Search an Existing Users
2218
- * @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/).
2218
+ * @description: Search and filter users details registered in the sales channel - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/searchUsers/).
2219
2219
  */
2220
2220
  async searchUsers(
2221
2221
  { q, query, requestHeaders } = { requestHeaders: {} },
@@ -2296,7 +2296,7 @@ class User {
2296
2296
  * @returns {Promise<UserPlatformModel.UnDeleteUserSuccess>} - Success response
2297
2297
  * @name unDeleteUser
2298
2298
  * @summary: Restore Deleted User
2299
- * @description: Restore a previously deleted user account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/unDeleteUser/).
2299
+ * @description: Restore a previously deleted user account. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/unDeleteUser/).
2300
2300
  */
2301
2301
  async unDeleteUser(
2302
2302
  { body, requestHeaders } = { requestHeaders: {} },
@@ -2375,7 +2375,7 @@ class User {
2375
2375
  * @returns {Promise<UserPlatformModel.PlatformSchema>} - Success response
2376
2376
  * @name updatePlatformConfig
2377
2377
  * @summary: Update Platform Config
2378
- * @description: Modify and update platform sales channel authentication configuration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updatePlatformConfig/).
2378
+ * @description: Modify and update platform sales channel authentication configuration. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/updatePlatformConfig/).
2379
2379
  */
2380
2380
  async updatePlatformConfig(
2381
2381
  { body, requestHeaders } = { requestHeaders: {} },
@@ -2454,7 +2454,7 @@ class User {
2454
2454
  * @returns {Promise<UserPlatformModel.CreateUserResponseSchema>} - Success response
2455
2455
  * @name updateUser
2456
2456
  * @summary: Update User Details
2457
- * @description: Modify and update user profile information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updateUser/).
2457
+ * @description: Modify and update user profile information. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/updateUser/).
2458
2458
  */
2459
2459
  async updateUser(
2460
2460
  { userId, body, requestHeaders } = { requestHeaders: {} },
@@ -2533,7 +2533,7 @@ class User {
2533
2533
  * @returns {Promise<UserPlatformModel.UserAttribute>} - Success response
2534
2534
  * @name updateUserAttribute
2535
2535
  * @summary: Update Or Create User Attribute
2536
- * @description: Update Or Create User Attribute - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updateUserAttribute/).
2536
+ * @description: Update Or Create User Attribute - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/updateUserAttribute/).
2537
2537
  */
2538
2538
  async updateUserAttribute(
2539
2539
  { attributeDefId, userId, body, requestHeaders } = { requestHeaders: {} },
@@ -2620,7 +2620,7 @@ class User {
2620
2620
  * @returns {Promise<UserPlatformModel.UserAttributeDefinition>} - Success response
2621
2621
  * @name updateUserAttributeDefinition
2622
2622
  * @summary: Update User Attribute Definition
2623
- * @description: Update an existing user attribute definition. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updateUserAttributeDefinition/).
2623
+ * @description: Update an existing user attribute definition. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/updateUserAttributeDefinition/).
2624
2624
  */
2625
2625
  async updateUserAttributeDefinition(
2626
2626
  { attributeDefId, body, requestHeaders } = { requestHeaders: {} },
@@ -2703,7 +2703,7 @@ class User {
2703
2703
  * @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
2704
2704
  * @name updateUserGroup
2705
2705
  * @summary: Update User Group
2706
- * @description: Modify and update user group details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updateUserGroup/).
2706
+ * @description: Modify and update user group details. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/updateUserGroup/).
2707
2707
  */
2708
2708
  async updateUserGroup(
2709
2709
  { groupId, body, requestHeaders } = { requestHeaders: {} },
@@ -2786,7 +2786,7 @@ class User {
2786
2786
  * @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
2787
2787
  * @name updateUserGroupPartially
2788
2788
  * @summary: Modify User Group
2789
- * @description: Update user group partially on the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updateUserGroupPartially/).
2789
+ * @description: Update user group partially on the platform. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/updateUserGroupPartially/).
2790
2790
  */
2791
2791
  async updateUserGroupPartially(
2792
2792
  { groupId, body, requestHeaders } = { requestHeaders: {} },