@gofynd/fdk-client-javascript 1.4.15-beta.14 → 1.4.15-beta.15
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.
- package/README.md +23 -26
- package/package.json +5 -1
- package/sdk/application/ApplicationClient.d.ts +5 -6
- package/sdk/application/ApplicationClient.js +24 -20
- package/sdk/application/Cart/CartApplicationClient.d.ts +133 -83
- package/sdk/application/Cart/CartApplicationClient.js +444 -76
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +132 -114
- package/sdk/application/Catalog/CatalogApplicationClient.js +209 -126
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +4 -4
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +3 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +58 -36
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +73 -29
- package/sdk/application/Content/ContentApplicationClient.d.ts +95 -66
- package/sdk/application/Content/ContentApplicationClient.js +274 -111
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +11 -11
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +10 -10
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +111 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +7 -7
- package/sdk/application/Lead/LeadApplicationClient.js +6 -6
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +37 -57
- package/sdk/application/Logistic/LogisticApplicationClient.js +117 -180
- package/sdk/application/Order/OrderApplicationClient.d.ts +63 -21
- package/sdk/application/Order/OrderApplicationClient.js +217 -17
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +179 -149
- package/sdk/application/Payment/PaymentApplicationClient.js +301 -167
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.js +10 -6
- package/sdk/application/User/UserApplicationClient.d.ts +103 -53
- package/sdk/application/User/UserApplicationClient.js +308 -49
- package/sdk/common/AxiosHelper.js +11 -4
- package/sdk/common/Constant.d.ts +27 -4
- package/sdk/common/Constant.js +33 -6
- package/sdk/common/utils.d.ts +10 -0
- package/sdk/common/utils.js +24 -3
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +46 -16
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +266 -40
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +163 -19
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +158 -14
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +5 -2
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +23 -7
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +9 -9
- package/sdk/partner/Lead/LeadPartnerClient.js +9 -9
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +14 -9
- package/sdk/partner/Lead/LeadPartnerModel.js +19 -17
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +264 -49
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +2116 -252
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +2256 -258
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +1187 -230
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +21 -1
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +218 -13
- package/sdk/partner/PartnerClient.d.ts +5 -2
- package/sdk/partner/PartnerClient.js +21 -7
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +32 -34
- package/sdk/partner/Theme/ThemePartnerClient.js +42 -44
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +142 -43
- package/sdk/partner/Theme/ThemePartnerModel.js +129 -44
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +83 -27
- package/sdk/partner/Webhook/WebhookPartnerClient.js +446 -27
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +920 -185
- package/sdk/partner/Webhook/WebhookPartnerModel.js +462 -154
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +5 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +41 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +8 -7
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +17 -11
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +4 -1
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +68 -13
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +44 -6
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +3 -33
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +4 -244
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +49 -145
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +20 -171
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +15 -15
- package/sdk/platform/Billing/BillingPlatformClient.js +18 -18
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
- package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
- package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +266 -203
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +1446 -500
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +729 -100
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +446 -82
- package/sdk/platform/Cart/CartPlatformModel.d.ts +6927 -1396
- package/sdk/platform/Cart/CartPlatformModel.js +3065 -1316
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +433 -248
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1662 -559
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +464 -159
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +304 -87
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +383 -234
- package/sdk/platform/Catalog/CatalogPlatformClient.js +2475 -1557
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +9573 -2678
- package/sdk/platform/Catalog/CatalogPlatformModel.js +5033 -1973
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +364 -117
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +281 -104
- package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -4
- package/sdk/platform/Common/CommonPlatformClient.js +6 -5
- package/sdk/platform/Common/CommonPlatformModel.d.ts +36 -25
- package/sdk/platform/Common/CommonPlatformModel.js +25 -14
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +80 -153
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +102 -541
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +36 -49
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +20 -60
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +189 -43
- package/sdk/platform/Communication/CommunicationPlatformModel.js +165 -42
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +58 -81
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +68 -116
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +291 -249
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +243 -234
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +78 -65
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +101 -88
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +20 -20
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +19 -19
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +68 -34
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +174 -41
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +667 -244
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +474 -155
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +366 -280
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1435 -753
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +323 -223
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +335 -205
- package/sdk/platform/Content/ContentPlatformClient.d.ts +304 -106
- package/sdk/platform/Content/ContentPlatformClient.js +1842 -450
- package/sdk/platform/Content/ContentPlatformModel.d.ts +2582 -566
- package/sdk/platform/Content/ContentPlatformModel.js +1426 -558
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +293 -114
- package/sdk/platform/Content/ContentPlatformValidator.js +328 -101
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +59 -23
- package/sdk/platform/Discount/DiscountPlatformClient.js +84 -23
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +403 -110
- package/sdk/platform/Discount/DiscountPlatformModel.js +121 -107
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +56 -36
- package/sdk/platform/Discount/DiscountPlatformValidator.js +29 -19
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +12 -110
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +14 -684
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +5 -94
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -115
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +20 -20
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +22 -22
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +90 -920
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +53 -949
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +10 -10
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +11 -11
- package/sdk/platform/Lead/LeadPlatformClient.js +11 -11
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +14 -9
- package/sdk/platform/Lead/LeadPlatformModel.js +20 -18
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +56 -9
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +340 -10
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +128 -24
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +81 -19
- package/sdk/platform/Order/OrderPlatformClient.d.ts +517 -160
- package/sdk/platform/Order/OrderPlatformClient.js +1623 -384
- package/sdk/platform/Order/OrderPlatformModel.d.ts +10372 -1587
- package/sdk/platform/Order/OrderPlatformModel.js +5726 -1512
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +539 -123
- package/sdk/platform/Order/OrderPlatformValidator.js +323 -92
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +8 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +11 -9
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +3 -2
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +77 -25
- package/sdk/platform/Partner/PartnerPlatformModel.js +32 -21
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +144 -219
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +307 -796
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +86 -121
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +80 -138
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +30 -30
- package/sdk/platform/Payment/PaymentPlatformClient.js +30 -30
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +901 -761
- package/sdk/platform/Payment/PaymentPlatformModel.js +663 -583
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
- package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
- package/sdk/platform/PlatformApplicationClient.d.ts +0 -2
- package/sdk/platform/PlatformApplicationClient.js +0 -4
- package/sdk/platform/PlatformClient.d.ts +5 -4
- package/sdk/platform/PlatformClient.js +32 -22
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +526 -69
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +3337 -337
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +603 -38
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +529 -32
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +184 -133
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +780 -491
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +9408 -1666
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +5720 -1765
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +257 -180
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +185 -127
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +7 -7
- package/sdk/platform/Share/SharePlatformApplicationClient.js +7 -7
- package/sdk/platform/Share/SharePlatformModel.d.ts +45 -9
- package/sdk/platform/Share/SharePlatformModel.js +31 -6
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +26 -26
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +38 -29
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +18 -3
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +10 -2
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +4 -4
- package/sdk/platform/Theme/ThemePlatformClient.js +4 -4
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +103 -17
- package/sdk/platform/Theme/ThemePlatformModel.js +92 -23
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +167 -45
- package/sdk/platform/User/UserPlatformApplicationClient.js +950 -67
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +189 -3
- package/sdk/platform/User/UserPlatformApplicationValidator.js +157 -3
- package/sdk/platform/User/UserPlatformModel.d.ts +880 -47
- package/sdk/platform/User/UserPlatformModel.js +607 -46
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +33 -86
- package/sdk/platform/Webhook/WebhookPlatformClient.js +79 -474
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +861 -422
- package/sdk/platform/Webhook/WebhookPlatformModel.js +469 -391
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
- package/sdk/platform/index.d.ts +0 -2
- package/sdk/platform/index.js +0 -4
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +22 -0
- package/sdk/public/Catalog/CatalogPublicClient.js +133 -0
- package/sdk/public/Catalog/CatalogPublicModel.d.ts +158 -0
- package/sdk/public/Catalog/CatalogPublicModel.js +116 -0
- package/sdk/public/Catalog/CatalogPublicValidator.d.ts +55 -0
- package/sdk/public/Catalog/CatalogPublicValidator.js +35 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +5 -4
- package/sdk/public/Configuration/ConfigurationPublicClient.js +9 -8
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +41 -21
- package/sdk/public/Configuration/ConfigurationPublicModel.js +28 -12
- package/sdk/public/Content/ContentPublicClient.d.ts +145 -2
- package/sdk/public/Content/ContentPublicClient.js +1067 -17
- package/sdk/public/Content/ContentPublicModel.d.ts +704 -3
- package/sdk/public/Content/ContentPublicModel.js +751 -3
- package/sdk/public/Content/ContentPublicValidator.d.ts +94 -3
- package/sdk/public/Content/ContentPublicValidator.js +119 -2
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +1 -1
- package/sdk/public/Partner/PartnerPublicModel.d.ts +248 -72
- package/sdk/public/Partner/PartnerPublicModel.js +81 -71
- package/sdk/public/Partner/PartnerPublicValidator.d.ts +2 -2
- package/sdk/public/Partner/PartnerPublicValidator.js +1 -1
- package/sdk/public/PublicClient.d.ts +5 -2
- package/sdk/public/PublicClient.js +16 -6
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +13 -13
- package/sdk/public/Webhook/WebhookPublicClient.js +13 -13
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +249 -67
- package/sdk/public/Webhook/WebhookPublicModel.js +81 -61
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/public/index.d.ts +1 -0
- package/sdk/public/index.js +2 -0
- package/utility.d.ts +3 -0
- package/utility.js +7 -0
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +0 -79
- package/sdk/application/Rewards/RewardsApplicationClient.js +0 -315
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +0 -19
- package/sdk/application/Webhook/WebhookApplicationClient.js +0 -72
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
- package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2890
- package/sdk/platform/Finance/FinancePlatformModel.js +0 -2148
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
- package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +0 -136
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +0 -976
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +0 -152
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +0 -157
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +0 -382
- package/sdk/platform/Rewards/RewardsPlatformModel.js +0 -408
|
@@ -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://
|
|
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,9 +20,33 @@ 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://
|
|
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
|
+
/**
|
|
27
|
+
* @param {UserPlatformApplicationValidator.BulkImportStoreFrontUsersParam} arg
|
|
28
|
+
* - Arg object
|
|
29
|
+
*
|
|
30
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
31
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
32
|
+
* @returns {Promise<UserPlatformModel.BulkActionModel>} - Success response
|
|
33
|
+
* @name bulkImportStoreFrontUsers
|
|
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://docs.fynd.com/partners/commerce/sdk/platform/user/bulkImportStoreFrontUsers/).
|
|
36
|
+
*/
|
|
37
|
+
bulkImportStoreFrontUsers({ body, requestHeaders }?: UserPlatformApplicationValidator.BulkImportStoreFrontUsersParam, { responseHeaders }?: object): Promise<UserPlatformModel.BulkActionModel>;
|
|
38
|
+
/**
|
|
39
|
+
* @param {UserPlatformApplicationValidator.CreateBulkExportUsersParam} arg
|
|
40
|
+
* - Arg object
|
|
41
|
+
*
|
|
42
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
43
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
44
|
+
* @returns {Promise<UserPlatformModel.BulkActionModel>} - Success response
|
|
45
|
+
* @name createBulkExportUsers
|
|
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://docs.fynd.com/partners/commerce/sdk/platform/user/createBulkExportUsers/).
|
|
48
|
+
*/
|
|
49
|
+
createBulkExportUsers({ body, requestHeaders }?: UserPlatformApplicationValidator.CreateBulkExportUsersParam, { responseHeaders }?: object): Promise<UserPlatformModel.BulkActionModel>;
|
|
26
50
|
/**
|
|
27
51
|
* @param {UserPlatformApplicationValidator.CreateUserParam} arg - Arg object
|
|
28
52
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -30,22 +54,22 @@ declare class User {
|
|
|
30
54
|
* @returns {Promise<UserPlatformModel.CreateUserResponseSchema>} - Success response
|
|
31
55
|
* @name createUser
|
|
32
56
|
* @summary: Create User
|
|
33
|
-
* @description: Register and add a new user to the sales channel. - Check out [method documentation](https://
|
|
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/).
|
|
34
58
|
*/
|
|
35
|
-
createUser({ body, requestHeaders }?: UserPlatformApplicationValidator.CreateUserParam, { responseHeaders }?: object): Promise<UserPlatformModel.CreateUserResponseSchema>;
|
|
59
|
+
createUser({ body, verified, requestHeaders }?: UserPlatformApplicationValidator.CreateUserParam, { responseHeaders }?: object): Promise<UserPlatformModel.CreateUserResponseSchema>;
|
|
36
60
|
/**
|
|
37
61
|
* @param {UserPlatformApplicationValidator.CreateUserAttributeDefinitionParam} arg
|
|
38
62
|
* - Arg object
|
|
39
63
|
*
|
|
40
64
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
41
65
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
42
|
-
* @returns {Promise<UserPlatformModel.
|
|
66
|
+
* @returns {Promise<UserPlatformModel.UserAttributeDefinitionDetails>} -
|
|
43
67
|
* Success response
|
|
44
68
|
* @name createUserAttributeDefinition
|
|
45
69
|
* @summary: Create a User Attribute Definition
|
|
46
|
-
* @description: Create a new User Attribute Definition - Check out [method documentation](https://
|
|
70
|
+
* @description: Create a new User Attribute Definition - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/createUserAttributeDefinition/).
|
|
47
71
|
*/
|
|
48
|
-
createUserAttributeDefinition({ body, requestHeaders }?: UserPlatformApplicationValidator.CreateUserAttributeDefinitionParam, { responseHeaders }?: object): Promise<UserPlatformModel.
|
|
72
|
+
createUserAttributeDefinition({ body, requestHeaders }?: UserPlatformApplicationValidator.CreateUserAttributeDefinitionParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserAttributeDefinitionDetails>;
|
|
49
73
|
/**
|
|
50
74
|
* @param {UserPlatformApplicationValidator.CreateUserGroupParam} arg - Arg object
|
|
51
75
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -53,7 +77,7 @@ declare class User {
|
|
|
53
77
|
* @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
|
|
54
78
|
* @name createUserGroup
|
|
55
79
|
* @summary: Create User Group
|
|
56
|
-
* @description: Form and add a new user group. - Check out [method documentation](https://
|
|
80
|
+
* @description: Form and add a new user group. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/createUserGroup/).
|
|
57
81
|
*/
|
|
58
82
|
createUserGroup({ body, requestHeaders }?: UserPlatformApplicationValidator.CreateUserGroupParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserGroupResponseSchema>;
|
|
59
83
|
/**
|
|
@@ -64,7 +88,7 @@ declare class User {
|
|
|
64
88
|
* Success response
|
|
65
89
|
* @name createUserSession
|
|
66
90
|
* @summary: Create User Session
|
|
67
|
-
* @description: Create session for user interactions - Check out [method documentation](https://
|
|
91
|
+
* @description: Create session for user interactions - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/createUserSession/).
|
|
68
92
|
*/
|
|
69
93
|
createUserSession({ body, requestHeaders }?: UserPlatformApplicationValidator.CreateUserSessionParam, { responseHeaders }?: object): Promise<UserPlatformModel.CreateUserSessionResponseSchema>;
|
|
70
94
|
/**
|
|
@@ -77,7 +101,7 @@ declare class User {
|
|
|
77
101
|
* Success response
|
|
78
102
|
* @name deleteActiveSessions
|
|
79
103
|
* @summary: Delete User Active Sessions
|
|
80
|
-
* @description: Terminate all active user sessions. - Check out [method documentation](https://
|
|
104
|
+
* @description: Terminate all active user sessions. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/deleteActiveSessions/).
|
|
81
105
|
*/
|
|
82
106
|
deleteActiveSessions({ id, reason, requestHeaders }?: UserPlatformApplicationValidator.DeleteActiveSessionsParam, { responseHeaders }?: object): Promise<UserPlatformModel.SessionsDeleteResponseSchema>;
|
|
83
107
|
/**
|
|
@@ -88,31 +112,65 @@ declare class User {
|
|
|
88
112
|
* Success response
|
|
89
113
|
* @name deleteSession
|
|
90
114
|
* @summary: Delete User Session
|
|
91
|
-
* @description: Terminate an active user session. - Check out [method documentation](https://
|
|
115
|
+
* @description: Terminate an active user session. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/deleteSession/).
|
|
92
116
|
*/
|
|
93
117
|
deleteSession({ id, sessionId, reason, requestHeaders }?: UserPlatformApplicationValidator.DeleteSessionParam, { responseHeaders }?: object): Promise<UserPlatformModel.SessionDeleteResponseSchema>;
|
|
94
118
|
/**
|
|
95
119
|
* @param {UserPlatformApplicationValidator.DeleteUserAttributeParam} arg - Arg object
|
|
96
120
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
97
121
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
98
|
-
* @returns {Promise<UserPlatformModel.
|
|
122
|
+
* @returns {Promise<UserPlatformModel.SuccessMessage>} - Success response
|
|
99
123
|
* @name deleteUserAttribute
|
|
100
124
|
* @summary: Delete User Attribute
|
|
101
|
-
* @description: Delete User Attribute - Check out [method documentation](https://
|
|
125
|
+
* @description: Delete User Attribute - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/deleteUserAttribute/).
|
|
102
126
|
*/
|
|
103
|
-
deleteUserAttribute({ attributeDefId, userId, requestHeaders }?: UserPlatformApplicationValidator.DeleteUserAttributeParam, { responseHeaders }?: object): Promise<UserPlatformModel.
|
|
127
|
+
deleteUserAttribute({ attributeDefId, userId, requestHeaders }?: UserPlatformApplicationValidator.DeleteUserAttributeParam, { responseHeaders }?: object): Promise<UserPlatformModel.SuccessMessage>;
|
|
104
128
|
/**
|
|
105
129
|
* @param {UserPlatformApplicationValidator.DeleteUserAttributeDefinitionByIdParam} arg
|
|
106
130
|
* - Arg object
|
|
107
131
|
*
|
|
108
132
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
109
133
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
110
|
-
* @returns {Promise<UserPlatformModel.
|
|
134
|
+
* @returns {Promise<UserPlatformModel.SuccessMessage>} - Success response
|
|
111
135
|
* @name deleteUserAttributeDefinitionById
|
|
112
136
|
* @summary: Delete User Attribute Definition
|
|
113
|
-
* @description: Delete a user attribute definition by its unique identifier. - Check out [method documentation](https://
|
|
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
|
+
*/
|
|
139
|
+
deleteUserAttributeDefinitionById({ attributeDefId, requestHeaders }?: UserPlatformApplicationValidator.DeleteUserAttributeDefinitionByIdParam, { responseHeaders }?: object): Promise<UserPlatformModel.SuccessMessage>;
|
|
140
|
+
/**
|
|
141
|
+
* @param {UserPlatformApplicationValidator.DeleteUserAttributesInBulkParam} arg
|
|
142
|
+
* - Arg object
|
|
143
|
+
*
|
|
144
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
145
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
146
|
+
* @returns {Promise<UserPlatformModel.SuccessMessage>} - Success response
|
|
147
|
+
* @name deleteUserAttributesInBulk
|
|
148
|
+
* @summary: Delete User Attribute Values in Bulk
|
|
149
|
+
* @description: This request deletes attribute values for a single user based on the provided user attribute definition. Each user attribute definition represents a distinct attribute, and for each definition, a user can have one corresponding value. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/deleteUserAttributesInBulk/).
|
|
150
|
+
*/
|
|
151
|
+
deleteUserAttributesInBulk({ userId, body, requestHeaders }?: UserPlatformApplicationValidator.DeleteUserAttributesInBulkParam, { responseHeaders }?: object): Promise<UserPlatformModel.SuccessMessage>;
|
|
152
|
+
/**
|
|
153
|
+
* @param {UserPlatformApplicationValidator.DeleteUserGroupParam} arg - Arg object
|
|
154
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
155
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
156
|
+
* @returns {Promise<UserPlatformModel.DeleteUserGroupSuccess>} - Success response
|
|
157
|
+
* @name deleteUserGroup
|
|
158
|
+
* @summary: Delete User Group
|
|
159
|
+
* @description: Permanently delete a user group by its unique identifier. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/deleteUserGroup/).
|
|
160
|
+
*/
|
|
161
|
+
deleteUserGroup({ groupId, requestHeaders }?: UserPlatformApplicationValidator.DeleteUserGroupParam, { responseHeaders }?: object): Promise<UserPlatformModel.DeleteUserGroupSuccess>;
|
|
162
|
+
/**
|
|
163
|
+
* @param {UserPlatformApplicationValidator.FilterUsersByAttributesParam} arg
|
|
164
|
+
* - Arg object
|
|
165
|
+
*
|
|
166
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
167
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
168
|
+
* @returns {Promise<UserPlatformModel.UserAttributeFiltered>} - Success response
|
|
169
|
+
* @name filterUsersByAttributes
|
|
170
|
+
* @summary: Filter Users by Attribute Conditions
|
|
171
|
+
* @description: Returns a filtered list of users based on user attribute conditions and along with details of definition Ids. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/filterUsersByAttributes/).
|
|
114
172
|
*/
|
|
115
|
-
|
|
173
|
+
filterUsersByAttributes({ body, requestHeaders }?: UserPlatformApplicationValidator.FilterUsersByAttributesParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserAttributeFiltered>;
|
|
116
174
|
/**
|
|
117
175
|
* @param {UserPlatformApplicationValidator.GetActiveSessionsParam} arg - Arg object
|
|
118
176
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -120,9 +178,37 @@ declare class User {
|
|
|
120
178
|
* @returns {Promise<UserPlatformModel.SessionListResponseSchema>} - Success response
|
|
121
179
|
* @name getActiveSessions
|
|
122
180
|
* @summary: Get User Active Sessions
|
|
123
|
-
* @description: Retrieve a list of currently active user sessions. - Check out [method documentation](https://
|
|
181
|
+
* @description: Retrieve a list of currently active user sessions. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getActiveSessions/).
|
|
124
182
|
*/
|
|
125
183
|
getActiveSessions({ id, requestHeaders }?: UserPlatformApplicationValidator.GetActiveSessionsParam, { responseHeaders }?: object): Promise<UserPlatformModel.SessionListResponseSchema>;
|
|
184
|
+
/**
|
|
185
|
+
* @param {UserPlatformApplicationValidator.GetBulkExportUsersListParam} arg
|
|
186
|
+
* - Arg object
|
|
187
|
+
*
|
|
188
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
189
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
190
|
+
* @returns {Promise<UserPlatformModel.BulkActionPaginationSchema>} - Success response
|
|
191
|
+
* @name getBulkExportUsersList
|
|
192
|
+
* @summary: Get Bulk User's Export Lists for a specific Application.
|
|
193
|
+
* @description: This API allows fetching the list of bulk user exports for a specific application and company.
|
|
194
|
+
* It supports pagination and filtering based on various parameters.
|
|
195
|
+
* - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getBulkExportUsersList/).
|
|
196
|
+
*/
|
|
197
|
+
getBulkExportUsersList({ pageNo, pageSize, fileFormat, search, startDate, endDate, status, requestHeaders, }?: UserPlatformApplicationValidator.GetBulkExportUsersListParam, { responseHeaders }?: object): Promise<UserPlatformModel.BulkActionPaginationSchema>;
|
|
198
|
+
/**
|
|
199
|
+
* @param {UserPlatformApplicationValidator.GetBulkImportUsersListParam} arg
|
|
200
|
+
* - Arg object
|
|
201
|
+
*
|
|
202
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
203
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
204
|
+
* @returns {Promise<UserPlatformModel.BulkActionPaginationSchema>} - Success response
|
|
205
|
+
* @name getBulkImportUsersList
|
|
206
|
+
* @summary: Get Bulk User's Import Lists for a specific Application.
|
|
207
|
+
* @description: This API allows fetching the list of bulk user imports for a specific application and company.
|
|
208
|
+
* It supports pagination and filtering based on various parameters.
|
|
209
|
+
* - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getBulkImportUsersList/).
|
|
210
|
+
*/
|
|
211
|
+
getBulkImportUsersList({ pageNo, pageSize, search, startDate, endDate, status, fileFormat, requestHeaders, }?: UserPlatformApplicationValidator.GetBulkImportUsersListParam, { responseHeaders }?: object): Promise<UserPlatformModel.BulkActionPaginationSchema>;
|
|
126
212
|
/**
|
|
127
213
|
* @param {UserPlatformApplicationValidator.GetCustomersParam} arg - Arg object
|
|
128
214
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -130,7 +216,7 @@ declare class User {
|
|
|
130
216
|
* @returns {Promise<UserPlatformModel.CustomerListResponseSchema>} - Success response
|
|
131
217
|
* @name getCustomers
|
|
132
218
|
* @summary: Get a List of Users
|
|
133
|
-
* @description: Retrieve details of users registered in the sales channel - Check out [method documentation](https://
|
|
219
|
+
* @description: Retrieve details of users registered in the sales channel - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getCustomers/).
|
|
134
220
|
*/
|
|
135
221
|
getCustomers({ q, pageSize, pageNo, requestHeaders }?: UserPlatformApplicationValidator.GetCustomersParam, { responseHeaders }?: object): Promise<UserPlatformModel.CustomerListResponseSchema>;
|
|
136
222
|
/**
|
|
@@ -140,31 +226,31 @@ declare class User {
|
|
|
140
226
|
* @returns {Promise<UserPlatformModel.PlatformSchema>} - Success response
|
|
141
227
|
* @name getPlatformConfig
|
|
142
228
|
* @summary: Get Platform Config
|
|
143
|
-
* @description: Retrieve platform sales channel authentication configuration. - Check out [method documentation](https://
|
|
229
|
+
* @description: Retrieve platform sales channel authentication configuration. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getPlatformConfig/).
|
|
144
230
|
*/
|
|
145
231
|
getPlatformConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<UserPlatformModel.PlatformSchema>;
|
|
146
232
|
/**
|
|
147
233
|
* @param {UserPlatformApplicationValidator.GetUserAttributeParam} arg - Arg object
|
|
148
234
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
149
235
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
150
|
-
* @returns {Promise<UserPlatformModel.
|
|
236
|
+
* @returns {Promise<UserPlatformModel.UserAttribute>} - Success response
|
|
151
237
|
* @name getUserAttribute
|
|
152
238
|
* @summary: Get User Attribute
|
|
153
|
-
* @description: Get User Attribute - Check out [method documentation](https://
|
|
239
|
+
* @description: Get User Attribute - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getUserAttribute/).
|
|
154
240
|
*/
|
|
155
|
-
getUserAttribute({ attributeDefId, userId, requestHeaders }?: UserPlatformApplicationValidator.GetUserAttributeParam, { responseHeaders }?: object): Promise<UserPlatformModel.
|
|
241
|
+
getUserAttribute({ attributeDefId, userId, requestHeaders }?: UserPlatformApplicationValidator.GetUserAttributeParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserAttribute>;
|
|
156
242
|
/**
|
|
157
243
|
* @param {UserPlatformApplicationValidator.GetUserAttributeByIdParam} arg
|
|
158
244
|
* - Arg object
|
|
159
245
|
*
|
|
160
246
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
161
247
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
162
|
-
* @returns {Promise<UserPlatformModel.
|
|
248
|
+
* @returns {Promise<UserPlatformModel.UserAttribute>} - Success response
|
|
163
249
|
* @name getUserAttributeById
|
|
164
250
|
* @summary: Get User Attribute
|
|
165
|
-
* @description: Retrieve User Attribute details by ID. - Check out [method documentation](https://
|
|
251
|
+
* @description: Retrieve User Attribute details by ID. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getUserAttributeById/).
|
|
166
252
|
*/
|
|
167
|
-
getUserAttributeById({ attributeId, requestHeaders }?: UserPlatformApplicationValidator.GetUserAttributeByIdParam, { responseHeaders }?: object): Promise<UserPlatformModel.
|
|
253
|
+
getUserAttributeById({ attributeId, requestHeaders }?: UserPlatformApplicationValidator.GetUserAttributeByIdParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserAttribute>;
|
|
168
254
|
/**
|
|
169
255
|
* @param {UserPlatformApplicationValidator.GetUserAttributeDefinitionByIdParam} arg
|
|
170
256
|
* - Arg object
|
|
@@ -174,7 +260,7 @@ declare class User {
|
|
|
174
260
|
* @returns {Promise<UserPlatformModel.UserAttributeDefinition>} - Success response
|
|
175
261
|
* @name getUserAttributeDefinitionById
|
|
176
262
|
* @summary: Get User Attribute Definition
|
|
177
|
-
* @description: Get a user attribute definition by its unique identifier. - Check out [method documentation](https://
|
|
263
|
+
* @description: Get a user attribute definition by its unique identifier. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getUserAttributeDefinitionById/).
|
|
178
264
|
*/
|
|
179
265
|
getUserAttributeDefinitionById({ attributeDefId, requestHeaders }?: UserPlatformApplicationValidator.GetUserAttributeDefinitionByIdParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserAttributeDefinition>;
|
|
180
266
|
/**
|
|
@@ -183,24 +269,27 @@ declare class User {
|
|
|
183
269
|
*
|
|
184
270
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
185
271
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
186
|
-
* @returns {Promise<
|
|
272
|
+
* @returns {Promise<UserPlatformModel.UserAttributeDefinitionList>} -
|
|
273
|
+
* Success response
|
|
187
274
|
* @name getUserAttributeDefinitions
|
|
188
275
|
* @summary: Get User Attribute Definitions
|
|
189
|
-
* @description: Retrieve user attribute definitions. - Check out [method documentation](https://
|
|
276
|
+
* @description: Retrieve user attribute definitions. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getUserAttributeDefinitions/).
|
|
190
277
|
*/
|
|
191
|
-
getUserAttributeDefinitions({ excludingIds, slug, type, customerEditable, encrypted, pinned, pinOrder, isLocked, name, pageSize, pageNo, requestHeaders, }?: UserPlatformApplicationValidator.GetUserAttributeDefinitionsParam, { responseHeaders }?: object): Promise<
|
|
278
|
+
getUserAttributeDefinitions({ excludingIds, slug, type, customerEditable, encrypted, pinned, pinOrder, isLocked, name, pageSize, pageNo, requestHeaders, }?: UserPlatformApplicationValidator.GetUserAttributeDefinitionsParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserAttributeDefinitionList>;
|
|
192
279
|
/**
|
|
193
280
|
* @param {UserPlatformApplicationValidator.GetUserAttributesForUserParam} arg
|
|
194
281
|
* - Arg object
|
|
195
282
|
*
|
|
196
283
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
197
284
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
198
|
-
* @returns {Promise<
|
|
285
|
+
* @returns {Promise<UserPlatformModel.UserAttributeDefinitionsResponseSchema>}
|
|
286
|
+
* - Success response
|
|
287
|
+
*
|
|
199
288
|
* @name getUserAttributesForUser
|
|
200
289
|
* @summary: Get All Customer Attributes
|
|
201
|
-
* @description: Retrieve all user attributes for a specific user - Check out [method documentation](https://
|
|
290
|
+
* @description: Retrieve all user attributes for a specific user - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getUserAttributesForUser/).
|
|
202
291
|
*/
|
|
203
|
-
getUserAttributesForUser({ userId, pageSize, pageNo, requestHeaders }?: UserPlatformApplicationValidator.GetUserAttributesForUserParam, { responseHeaders }?: object): Promise<
|
|
292
|
+
getUserAttributesForUser({ userId, pageSize, pageNo, requestHeaders }?: UserPlatformApplicationValidator.GetUserAttributesForUserParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserAttributeDefinitionsResponseSchema>;
|
|
204
293
|
/**
|
|
205
294
|
* @param {UserPlatformApplicationValidator.GetUserGroupByIdParam} arg - Arg object
|
|
206
295
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -208,7 +297,7 @@ declare class User {
|
|
|
208
297
|
* @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
|
|
209
298
|
* @name getUserGroupById
|
|
210
299
|
* @summary: Get User Group
|
|
211
|
-
* @description: Retrieve a user group by its unique identifier. - Check out [method documentation](https://
|
|
300
|
+
* @description: Retrieve a user group by its unique identifier. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getUserGroupById/).
|
|
212
301
|
*/
|
|
213
302
|
getUserGroupById({ groupId, requestHeaders }?: UserPlatformApplicationValidator.GetUserGroupByIdParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserGroupResponseSchema>;
|
|
214
303
|
/**
|
|
@@ -219,9 +308,30 @@ declare class User {
|
|
|
219
308
|
* Success response
|
|
220
309
|
* @name getUserGroups
|
|
221
310
|
* @summary: Get User Groups
|
|
222
|
-
* @description: Retrieve a list of user groups. - Check out [method documentation](https://
|
|
311
|
+
* @description: Retrieve a list of user groups. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getUserGroups/).
|
|
223
312
|
*/
|
|
224
313
|
getUserGroups({ pageNo, pageSize, name, type, status, groupUid, requestHeaders }?: UserPlatformApplicationValidator.GetUserGroupsParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserGroupListResponseSchema>;
|
|
314
|
+
/**
|
|
315
|
+
* @param {UserPlatformApplicationValidator.GetUserTimelineParam} arg - Arg object
|
|
316
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
317
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
318
|
+
* @returns {Promise<UserPlatformModel.GetUserTimeline>} - Success response
|
|
319
|
+
* @name getUserTimeline
|
|
320
|
+
* @summary: Get Deleted User Timeline
|
|
321
|
+
* @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/).
|
|
322
|
+
*/
|
|
323
|
+
getUserTimeline({ userId, requestHeaders }?: UserPlatformApplicationValidator.GetUserTimelineParam, { responseHeaders }?: object): Promise<UserPlatformModel.GetUserTimeline>;
|
|
324
|
+
/**
|
|
325
|
+
* @param {UserPlatformApplicationValidator.GetUsersJobByJobIdParam} arg - Arg object
|
|
326
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
327
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
328
|
+
* @returns {Promise<UserPlatformModel.BulkActionModel>} - Success response
|
|
329
|
+
* @name getUsersJobByJobId
|
|
330
|
+
* @summary: Retrieve Job Details by Job ID for a Specific Application, Including Both Import and Export Jobs.
|
|
331
|
+
* @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`.
|
|
332
|
+
* - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getUsersJobByJobId/).
|
|
333
|
+
*/
|
|
334
|
+
getUsersJobByJobId({ jobId, requestHeaders }?: UserPlatformApplicationValidator.GetUsersJobByJobIdParam, { responseHeaders }?: object): Promise<UserPlatformModel.BulkActionModel>;
|
|
225
335
|
/**
|
|
226
336
|
* @param {UserPlatformApplicationValidator.SearchUsersParam} arg - Arg object
|
|
227
337
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -229,7 +339,7 @@ declare class User {
|
|
|
229
339
|
* @returns {Promise<UserPlatformModel.UserSearchResponseSchema>} - Success response
|
|
230
340
|
* @name searchUsers
|
|
231
341
|
* @summary: Search an Existing Users
|
|
232
|
-
* @description: Search and filter users details registered in the sales channel - Check out [method documentation](https://
|
|
342
|
+
* @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/).
|
|
233
343
|
*/
|
|
234
344
|
searchUsers({ q, query, requestHeaders }?: UserPlatformApplicationValidator.SearchUsersParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserSearchResponseSchema>;
|
|
235
345
|
/**
|
|
@@ -239,7 +349,7 @@ declare class User {
|
|
|
239
349
|
* @returns {Promise<UserPlatformModel.UnDeleteUserSuccess>} - Success response
|
|
240
350
|
* @name unDeleteUser
|
|
241
351
|
* @summary: Restore Deleted User
|
|
242
|
-
* @description: Restore a previously deleted user account. - Check out [method documentation](https://
|
|
352
|
+
* @description: Restore a previously deleted user account. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/unDeleteUser/).
|
|
243
353
|
*/
|
|
244
354
|
unDeleteUser({ body, requestHeaders }?: UserPlatformApplicationValidator.UnDeleteUserParam, { responseHeaders }?: object): Promise<UserPlatformModel.UnDeleteUserSuccess>;
|
|
245
355
|
/**
|
|
@@ -251,7 +361,7 @@ declare class User {
|
|
|
251
361
|
* @returns {Promise<UserPlatformModel.PlatformSchema>} - Success response
|
|
252
362
|
* @name updatePlatformConfig
|
|
253
363
|
* @summary: Update Platform Config
|
|
254
|
-
* @description: Modify and update platform sales channel authentication configuration. - Check out [method documentation](https://
|
|
364
|
+
* @description: Modify and update platform sales channel authentication configuration. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/updatePlatformConfig/).
|
|
255
365
|
*/
|
|
256
366
|
updatePlatformConfig({ body, requestHeaders }?: UserPlatformApplicationValidator.UpdatePlatformConfigParam, { responseHeaders }?: object): Promise<UserPlatformModel.PlatformSchema>;
|
|
257
367
|
/**
|
|
@@ -261,19 +371,19 @@ declare class User {
|
|
|
261
371
|
* @returns {Promise<UserPlatformModel.CreateUserResponseSchema>} - Success response
|
|
262
372
|
* @name updateUser
|
|
263
373
|
* @summary: Update User Details
|
|
264
|
-
* @description: Modify and update user profile information. - Check out [method documentation](https://
|
|
374
|
+
* @description: Modify and update user profile information. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/updateUser/).
|
|
265
375
|
*/
|
|
266
376
|
updateUser({ userId, body, requestHeaders }?: UserPlatformApplicationValidator.UpdateUserParam, { responseHeaders }?: object): Promise<UserPlatformModel.CreateUserResponseSchema>;
|
|
267
377
|
/**
|
|
268
378
|
* @param {UserPlatformApplicationValidator.UpdateUserAttributeParam} arg - Arg object
|
|
269
379
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
270
380
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
271
|
-
* @returns {Promise<UserPlatformModel.
|
|
381
|
+
* @returns {Promise<UserPlatformModel.UserAttribute>} - Success response
|
|
272
382
|
* @name updateUserAttribute
|
|
273
383
|
* @summary: Update Or Create User Attribute
|
|
274
|
-
* @description: Update Or Create User Attribute - Check out [method documentation](https://
|
|
384
|
+
* @description: Update Or Create User Attribute - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/updateUserAttribute/).
|
|
275
385
|
*/
|
|
276
|
-
updateUserAttribute({ attributeDefId, userId, body, requestHeaders }?: UserPlatformApplicationValidator.UpdateUserAttributeParam, { responseHeaders }?: object): Promise<UserPlatformModel.
|
|
386
|
+
updateUserAttribute({ attributeDefId, userId, body, requestHeaders }?: UserPlatformApplicationValidator.UpdateUserAttributeParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserAttribute>;
|
|
277
387
|
/**
|
|
278
388
|
* @param {UserPlatformApplicationValidator.UpdateUserAttributeDefinitionParam} arg
|
|
279
389
|
* - Arg object
|
|
@@ -283,9 +393,21 @@ declare class User {
|
|
|
283
393
|
* @returns {Promise<UserPlatformModel.UserAttributeDefinition>} - Success response
|
|
284
394
|
* @name updateUserAttributeDefinition
|
|
285
395
|
* @summary: Update User Attribute Definition
|
|
286
|
-
* @description: Update an existing user attribute definition. - Check out [method documentation](https://
|
|
396
|
+
* @description: Update an existing user attribute definition. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/updateUserAttributeDefinition/).
|
|
287
397
|
*/
|
|
288
398
|
updateUserAttributeDefinition({ attributeDefId, body, requestHeaders }?: UserPlatformApplicationValidator.UpdateUserAttributeDefinitionParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserAttributeDefinition>;
|
|
399
|
+
/**
|
|
400
|
+
* @param {UserPlatformApplicationValidator.UpdateUserAttributesParam} arg
|
|
401
|
+
* - Arg object
|
|
402
|
+
*
|
|
403
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
404
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
405
|
+
* @returns {Promise<UserPlatformModel.BulkUserAttribute>} - Success response
|
|
406
|
+
* @name updateUserAttributes
|
|
407
|
+
* @summary: Create Or Update User Attribute
|
|
408
|
+
* @description: This API is used to create or update multiple user attribute values for the specified user ID. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/updateUserAttributes/).
|
|
409
|
+
*/
|
|
410
|
+
updateUserAttributes({ userId, body, requestHeaders }?: UserPlatformApplicationValidator.UpdateUserAttributesParam, { responseHeaders }?: object): Promise<UserPlatformModel.BulkUserAttribute>;
|
|
289
411
|
/**
|
|
290
412
|
* @param {UserPlatformApplicationValidator.UpdateUserGroupParam} arg - Arg object
|
|
291
413
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -293,7 +415,7 @@ declare class User {
|
|
|
293
415
|
* @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
|
|
294
416
|
* @name updateUserGroup
|
|
295
417
|
* @summary: Update User Group
|
|
296
|
-
* @description: Modify and update user group details. - Check out [method documentation](https://
|
|
418
|
+
* @description: Modify and update user group details. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/updateUserGroup/).
|
|
297
419
|
*/
|
|
298
420
|
updateUserGroup({ groupId, body, requestHeaders }?: UserPlatformApplicationValidator.UpdateUserGroupParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserGroupResponseSchema>;
|
|
299
421
|
/**
|
|
@@ -305,7 +427,7 @@ declare class User {
|
|
|
305
427
|
* @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
|
|
306
428
|
* @name updateUserGroupPartially
|
|
307
429
|
* @summary: Modify User Group
|
|
308
|
-
* @description: Update user group partially on the platform. - Check out [method documentation](https://
|
|
430
|
+
* @description: Update user group partially on the platform. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/updateUserGroupPartially/).
|
|
309
431
|
*/
|
|
310
432
|
updateUserGroupPartially({ groupId, body, requestHeaders }?: UserPlatformApplicationValidator.UpdateUserGroupPartiallyParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserGroupResponseSchema>;
|
|
311
433
|
}
|