@gofynd/fdk-client-javascript 3.3.5 → 3.4.0
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 +1 -1
- package/package.json +1 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +30 -30
- package/sdk/application/Cart/CartApplicationClient.js +30 -30
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +36 -33
- package/sdk/application/Catalog/CatalogApplicationClient.js +54 -35
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +2 -2
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +3 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +16 -16
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +16 -16
- package/sdk/application/Content/ContentApplicationClient.d.ts +24 -24
- package/sdk/application/Content/ContentApplicationClient.js +24 -24
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +3 -3
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +3 -3
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +2 -2
- package/sdk/application/Finance/FinanceApplicationClient.js +2 -2
- package/sdk/application/Lead/LeadApplicationClient.d.ts +5 -5
- package/sdk/application/Lead/LeadApplicationClient.js +5 -5
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +19 -9
- package/sdk/application/Logistic/LogisticApplicationClient.js +53 -9
- package/sdk/application/Order/OrderApplicationClient.d.ts +12 -12
- package/sdk/application/Order/OrderApplicationClient.js +12 -12
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +46 -46
- package/sdk/application/Payment/PaymentApplicationClient.js +46 -46
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +7 -7
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +4 -4
- package/sdk/application/Theme/ThemeApplicationClient.js +4 -4
- package/sdk/application/User/UserApplicationClient.d.ts +47 -47
- package/sdk/application/User/UserApplicationClient.js +47 -47
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +1 -1
- package/sdk/application/Webhook/WebhookApplicationClient.js +1 -1
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +6 -6
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +6 -6
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +7 -7
- package/sdk/partner/Lead/LeadPartnerClient.js +7 -7
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +2 -2
- package/sdk/partner/Lead/LeadPartnerModel.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +25 -25
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +25 -25
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +6 -6
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +3 -3
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +24 -24
- package/sdk/partner/Theme/ThemePartnerClient.js +24 -24
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +10 -10
- package/sdk/partner/Webhook/WebhookPartnerClient.js +10 -10
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +7 -2
- package/sdk/partner/Webhook/WebhookPartnerModel.js +3 -1
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +3 -3
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +2 -2
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +1 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +1 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +1 -1
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +5 -5
- package/sdk/platform/Billing/BillingPlatformClient.js +5 -5
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +62 -62
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +62 -62
- package/sdk/platform/Cart/CartPlatformModel.d.ts +233 -3
- package/sdk/platform/Cart/CartPlatformModel.js +147 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +66 -66
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +66 -66
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +81 -79
- package/sdk/platform/Catalog/CatalogPlatformClient.js +93 -80
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +89 -5
- package/sdk/platform/Catalog/CatalogPlatformModel.js +57 -3
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +7 -2
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +4 -2
- package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -2
- package/sdk/platform/Common/CommonPlatformClient.js +2 -2
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +67 -67
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +67 -67
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +2 -2
- package/sdk/platform/Communication/CommunicationPlatformModel.js +1 -1
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +14 -14
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +14 -14
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -2
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +1 -1
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +11 -11
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +11 -11
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +19 -3
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +16 -1
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +107 -107
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +107 -107
- package/sdk/platform/Content/ContentPlatformClient.d.ts +40 -40
- package/sdk/platform/Content/ContentPlatformClient.js +40 -40
- package/sdk/platform/Content/ContentPlatformModel.d.ts +2 -2
- package/sdk/platform/Content/ContentPlatformModel.js +1 -1
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +11 -11
- package/sdk/platform/Discount/DiscountPlatformClient.js +11 -11
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformModel.js +1 -1
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformClient.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 +9 -9
- package/sdk/platform/Lead/LeadPlatformClient.js +9 -9
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +2 -2
- package/sdk/platform/Lead/LeadPlatformModel.js +1 -1
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +5 -5
- package/sdk/platform/Order/OrderPlatformClient.d.ts +58 -58
- package/sdk/platform/Order/OrderPlatformClient.js +58 -58
- package/sdk/platform/Order/OrderPlatformModel.d.ts +29 -10
- package/sdk/platform/Order/OrderPlatformModel.js +28 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +2 -2
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +51 -51
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +51 -51
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +10 -10
- package/sdk/platform/Payment/PaymentPlatformClient.js +10 -10
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +2 -2
- package/sdk/platform/Payment/PaymentPlatformModel.js +1 -1
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +12 -12
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.js +1 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +162 -39
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +840 -73
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +139 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +125 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +30 -30
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +36 -30
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +936 -62
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +591 -33
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +12 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +5 -0
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Share/SharePlatformApplicationClient.js +5 -5
- package/sdk/platform/Share/SharePlatformModel.d.ts +2 -2
- package/sdk/platform/Share/SharePlatformModel.js +1 -1
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +22 -22
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +22 -22
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +4 -4
- package/sdk/platform/Theme/ThemePlatformClient.js +4 -4
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +70 -34
- package/sdk/platform/User/UserPlatformApplicationClient.js +285 -34
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +38 -1
- package/sdk/platform/User/UserPlatformApplicationValidator.js +42 -0
- package/sdk/platform/User/UserPlatformModel.d.ts +430 -10
- package/sdk/platform/User/UserPlatformModel.js +276 -7
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +9 -9
- package/sdk/platform/Webhook/WebhookPlatformClient.js +9 -9
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +12 -2
- package/sdk/platform/Webhook/WebhookPlatformModel.js +5 -1
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +1 -1
- package/sdk/public/Catalog/CatalogPublicClient.js +1 -1
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +2 -2
- package/sdk/public/Content/ContentPublicClient.d.ts +14 -14
- package/sdk/public/Content/ContentPublicClient.js +14 -14
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +1 -1
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +5 -5
- package/sdk/public/Webhook/WebhookPublicClient.js +5 -5
|
@@ -9,7 +9,7 @@ declare class Theme {
|
|
|
9
9
|
* @returns {Promise<ThemePlatformModel.CompanyThemeSchema>} - Success response
|
|
10
10
|
* @name addMarketplaceThemeToCompany
|
|
11
11
|
* @summary: Create a company theme
|
|
12
|
-
* @description: Incorporate a marketplace theme into a company's profile. - Check out [method documentation](https://
|
|
12
|
+
* @description: Incorporate a marketplace theme into a company's profile. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/addMarketplaceThemeToCompany/).
|
|
13
13
|
*/
|
|
14
14
|
addMarketplaceThemeToCompany({ body, requestHeaders }?: ThemePlatformValidator.AddMarketplaceThemeToCompanyParam, { responseHeaders }?: object): Promise<ThemePlatformModel.CompanyThemeSchema>;
|
|
15
15
|
/**
|
|
@@ -19,7 +19,7 @@ declare class Theme {
|
|
|
19
19
|
* @returns {Promise<ThemePlatformModel.CompanyThemeSchema>} - Success response
|
|
20
20
|
* @name deleteCompanyTheme
|
|
21
21
|
* @summary: Delete a company theme
|
|
22
|
-
* @description: Remove a theme associated with a company. - Check out [method documentation](https://
|
|
22
|
+
* @description: Remove a theme associated with a company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/deleteCompanyTheme/).
|
|
23
23
|
*/
|
|
24
24
|
deleteCompanyTheme({ themeId, requestHeaders }?: ThemePlatformValidator.DeleteCompanyThemeParam, { responseHeaders }?: object): Promise<ThemePlatformModel.CompanyThemeSchema>;
|
|
25
25
|
/**
|
|
@@ -29,7 +29,7 @@ declare class Theme {
|
|
|
29
29
|
* @returns {Promise<ThemePlatformModel.CompanyPrivateTheme[]>} - Success response
|
|
30
30
|
* @name getCompanyLevelPrivateThemes
|
|
31
31
|
* @summary: List private company themes
|
|
32
|
-
* @description: Retrieve a list of private themes added to a company. - Check out [method documentation](https://
|
|
32
|
+
* @description: Retrieve a list of private themes added to a company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/getCompanyLevelPrivateThemes/).
|
|
33
33
|
*/
|
|
34
34
|
getCompanyLevelPrivateThemes({ searchText, requestHeaders }?: ThemePlatformValidator.GetCompanyLevelPrivateThemesParam, { responseHeaders }?: object): Promise<ThemePlatformModel.CompanyPrivateTheme[]>;
|
|
35
35
|
/**
|
|
@@ -39,7 +39,7 @@ declare class Theme {
|
|
|
39
39
|
* @returns {Promise<ThemePlatformModel.CompanyThemeSchema[]>} - Success response
|
|
40
40
|
* @name getCompanyLevelThemes
|
|
41
41
|
* @summary: List company themes
|
|
42
|
-
* @description: Retrieve themes added to a company. - Check out [method documentation](https://
|
|
42
|
+
* @description: Retrieve themes added to a company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/getCompanyLevelThemes/).
|
|
43
43
|
*/
|
|
44
44
|
getCompanyLevelThemes({ searchText, requestHeaders }?: ThemePlatformValidator.GetCompanyLevelThemesParam, { responseHeaders }?: object): Promise<ThemePlatformModel.CompanyThemeSchema[]>;
|
|
45
45
|
}
|
|
@@ -21,7 +21,7 @@ class Theme {
|
|
|
21
21
|
* @returns {Promise<ThemePlatformModel.CompanyThemeSchema>} - Success response
|
|
22
22
|
* @name addMarketplaceThemeToCompany
|
|
23
23
|
* @summary: Create a company theme
|
|
24
|
-
* @description: Incorporate a marketplace theme into a company's profile. - Check out [method documentation](https://
|
|
24
|
+
* @description: Incorporate a marketplace theme into a company's profile. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/addMarketplaceThemeToCompany/).
|
|
25
25
|
*/
|
|
26
26
|
async addMarketplaceThemeToCompany(
|
|
27
27
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -102,7 +102,7 @@ class Theme {
|
|
|
102
102
|
* @returns {Promise<ThemePlatformModel.CompanyThemeSchema>} - Success response
|
|
103
103
|
* @name deleteCompanyTheme
|
|
104
104
|
* @summary: Delete a company theme
|
|
105
|
-
* @description: Remove a theme associated with a company. - Check out [method documentation](https://
|
|
105
|
+
* @description: Remove a theme associated with a company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/deleteCompanyTheme/).
|
|
106
106
|
*/
|
|
107
107
|
async deleteCompanyTheme(
|
|
108
108
|
{ themeId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -181,7 +181,7 @@ class Theme {
|
|
|
181
181
|
* @returns {Promise<ThemePlatformModel.CompanyPrivateTheme[]>} - Success response
|
|
182
182
|
* @name getCompanyLevelPrivateThemes
|
|
183
183
|
* @summary: List private company themes
|
|
184
|
-
* @description: Retrieve a list of private themes added to a company. - Check out [method documentation](https://
|
|
184
|
+
* @description: Retrieve a list of private themes added to a company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/getCompanyLevelPrivateThemes/).
|
|
185
185
|
*/
|
|
186
186
|
async getCompanyLevelPrivateThemes(
|
|
187
187
|
{ searchText, requestHeaders } = { requestHeaders: {} },
|
|
@@ -260,7 +260,7 @@ class Theme {
|
|
|
260
260
|
* @returns {Promise<ThemePlatformModel.CompanyThemeSchema[]>} - Success response
|
|
261
261
|
* @name getCompanyLevelThemes
|
|
262
262
|
* @summary: List company themes
|
|
263
|
-
* @description: Retrieve themes added to a company. - Check out [method documentation](https://
|
|
263
|
+
* @description: Retrieve themes added to a company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/getCompanyLevelThemes/).
|
|
264
264
|
*/
|
|
265
265
|
async getCompanyLevelThemes(
|
|
266
266
|
{ searchText, requestHeaders } = { requestHeaders: {} },
|
|
@@ -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,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://
|
|
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://
|
|
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://
|
|
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://
|
|
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://
|
|
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://
|
|
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://
|
|
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://
|
|
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://
|
|
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://
|
|
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,9 +134,33 @@ 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://
|
|
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
|
+
/**
|
|
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.FilterUsersByAttributesParam} arg
|
|
154
|
+
* - Arg object
|
|
155
|
+
*
|
|
156
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
157
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
158
|
+
* @returns {Promise<UserPlatformModel.UserAttributeFiltered>} - Success response
|
|
159
|
+
* @name filterUsersByAttributes
|
|
160
|
+
* @summary: Filter Users by Attribute Conditions
|
|
161
|
+
* @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/).
|
|
162
|
+
*/
|
|
163
|
+
filterUsersByAttributes({ body, requestHeaders }?: UserPlatformApplicationValidator.FilterUsersByAttributesParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserAttributeFiltered>;
|
|
140
164
|
/**
|
|
141
165
|
* @param {UserPlatformApplicationValidator.GetActiveSessionsParam} arg - Arg object
|
|
142
166
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -144,7 +168,7 @@ declare class User {
|
|
|
144
168
|
* @returns {Promise<UserPlatformModel.SessionListResponseSchema>} - Success response
|
|
145
169
|
* @name getActiveSessions
|
|
146
170
|
* @summary: Get User Active Sessions
|
|
147
|
-
* @description: Retrieve a list of currently active user sessions. - Check out [method documentation](https://
|
|
171
|
+
* @description: Retrieve a list of currently active user sessions. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getActiveSessions/).
|
|
148
172
|
*/
|
|
149
173
|
getActiveSessions({ id, requestHeaders }?: UserPlatformApplicationValidator.GetActiveSessionsParam, { responseHeaders }?: object): Promise<UserPlatformModel.SessionListResponseSchema>;
|
|
150
174
|
/**
|
|
@@ -158,7 +182,7 @@ declare class User {
|
|
|
158
182
|
* @summary: Get Bulk User's Export Lists for a specific Application.
|
|
159
183
|
* @description: This API allows fetching the list of bulk user exports for a specific application and company.
|
|
160
184
|
* It supports pagination and filtering based on various parameters.
|
|
161
|
-
* - Check out [method documentation](https://
|
|
185
|
+
* - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getBulkExportUsersList/).
|
|
162
186
|
*/
|
|
163
187
|
getBulkExportUsersList({ pageNo, pageSize, fileFormat, search, startDate, endDate, status, requestHeaders, }?: UserPlatformApplicationValidator.GetBulkExportUsersListParam, { responseHeaders }?: object): Promise<UserPlatformModel.BulkActionPaginationSchema>;
|
|
164
188
|
/**
|
|
@@ -172,7 +196,7 @@ declare class User {
|
|
|
172
196
|
* @summary: Get Bulk User's Import Lists for a specific Application.
|
|
173
197
|
* @description: This API allows fetching the list of bulk user imports for a specific application and company.
|
|
174
198
|
* It supports pagination and filtering based on various parameters.
|
|
175
|
-
* - Check out [method documentation](https://
|
|
199
|
+
* - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getBulkImportUsersList/).
|
|
176
200
|
*/
|
|
177
201
|
getBulkImportUsersList({ pageNo, pageSize, search, startDate, endDate, status, fileFormat, requestHeaders, }?: UserPlatformApplicationValidator.GetBulkImportUsersListParam, { responseHeaders }?: object): Promise<UserPlatformModel.BulkActionPaginationSchema>;
|
|
178
202
|
/**
|
|
@@ -182,7 +206,7 @@ declare class User {
|
|
|
182
206
|
* @returns {Promise<UserPlatformModel.CustomerListResponseSchema>} - Success response
|
|
183
207
|
* @name getCustomers
|
|
184
208
|
* @summary: Get a List of Users
|
|
185
|
-
* @description: Retrieve details of users registered in the sales channel - Check out [method documentation](https://
|
|
209
|
+
* @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
210
|
*/
|
|
187
211
|
getCustomers({ q, pageSize, pageNo, requestHeaders }?: UserPlatformApplicationValidator.GetCustomersParam, { responseHeaders }?: object): Promise<UserPlatformModel.CustomerListResponseSchema>;
|
|
188
212
|
/**
|
|
@@ -192,7 +216,7 @@ declare class User {
|
|
|
192
216
|
* @returns {Promise<UserPlatformModel.PlatformSchema>} - Success response
|
|
193
217
|
* @name getPlatformConfig
|
|
194
218
|
* @summary: Get Platform Config
|
|
195
|
-
* @description: Retrieve platform sales channel authentication configuration. - Check out [method documentation](https://
|
|
219
|
+
* @description: Retrieve platform sales channel authentication configuration. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getPlatformConfig/).
|
|
196
220
|
*/
|
|
197
221
|
getPlatformConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<UserPlatformModel.PlatformSchema>;
|
|
198
222
|
/**
|
|
@@ -202,7 +226,7 @@ declare class User {
|
|
|
202
226
|
* @returns {Promise<UserPlatformModel.UserAttribute>} - Success response
|
|
203
227
|
* @name getUserAttribute
|
|
204
228
|
* @summary: Get User Attribute
|
|
205
|
-
* @description: Get User Attribute - Check out [method documentation](https://
|
|
229
|
+
* @description: Get User Attribute - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getUserAttribute/).
|
|
206
230
|
*/
|
|
207
231
|
getUserAttribute({ attributeDefId, userId, requestHeaders }?: UserPlatformApplicationValidator.GetUserAttributeParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserAttribute>;
|
|
208
232
|
/**
|
|
@@ -214,7 +238,7 @@ declare class User {
|
|
|
214
238
|
* @returns {Promise<UserPlatformModel.UserAttribute>} - Success response
|
|
215
239
|
* @name getUserAttributeById
|
|
216
240
|
* @summary: Get User Attribute
|
|
217
|
-
* @description: Retrieve User Attribute details by ID. - Check out [method documentation](https://
|
|
241
|
+
* @description: Retrieve User Attribute details by ID. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getUserAttributeById/).
|
|
218
242
|
*/
|
|
219
243
|
getUserAttributeById({ attributeId, requestHeaders }?: UserPlatformApplicationValidator.GetUserAttributeByIdParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserAttribute>;
|
|
220
244
|
/**
|
|
@@ -226,7 +250,7 @@ declare class User {
|
|
|
226
250
|
* @returns {Promise<UserPlatformModel.UserAttributeDefinition>} - Success response
|
|
227
251
|
* @name getUserAttributeDefinitionById
|
|
228
252
|
* @summary: Get User Attribute Definition
|
|
229
|
-
* @description: Get a user attribute definition by its unique identifier. - Check out [method documentation](https://
|
|
253
|
+
* @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
254
|
*/
|
|
231
255
|
getUserAttributeDefinitionById({ attributeDefId, requestHeaders }?: UserPlatformApplicationValidator.GetUserAttributeDefinitionByIdParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserAttributeDefinition>;
|
|
232
256
|
/**
|
|
@@ -238,7 +262,7 @@ declare class User {
|
|
|
238
262
|
* @returns {Promise<Object>} - Success response
|
|
239
263
|
* @name getUserAttributeDefinitions
|
|
240
264
|
* @summary: Get User Attribute Definitions
|
|
241
|
-
* @description: Retrieve user attribute definitions. - Check out [method documentation](https://
|
|
265
|
+
* @description: Retrieve user attribute definitions. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getUserAttributeDefinitions/).
|
|
242
266
|
*/
|
|
243
267
|
getUserAttributeDefinitions({ excludingIds, slug, type, customerEditable, encrypted, pinned, pinOrder, isLocked, name, pageSize, pageNo, requestHeaders, }?: UserPlatformApplicationValidator.GetUserAttributeDefinitionsParam, { responseHeaders }?: object): Promise<any>;
|
|
244
268
|
/**
|
|
@@ -250,7 +274,7 @@ declare class User {
|
|
|
250
274
|
* @returns {Promise<Object>} - Success response
|
|
251
275
|
* @name getUserAttributesForUser
|
|
252
276
|
* @summary: Get All Customer Attributes
|
|
253
|
-
* @description: Retrieve all user attributes for a specific user - Check out [method documentation](https://
|
|
277
|
+
* @description: Retrieve all user attributes for a specific user - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getUserAttributesForUser/).
|
|
254
278
|
*/
|
|
255
279
|
getUserAttributesForUser({ userId, pageSize, pageNo, requestHeaders }?: UserPlatformApplicationValidator.GetUserAttributesForUserParam, { responseHeaders }?: object): Promise<any>;
|
|
256
280
|
/**
|
|
@@ -260,7 +284,7 @@ declare class User {
|
|
|
260
284
|
* @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
|
|
261
285
|
* @name getUserGroupById
|
|
262
286
|
* @summary: Get User Group
|
|
263
|
-
* @description: Retrieve a user group by its unique identifier. - Check out [method documentation](https://
|
|
287
|
+
* @description: Retrieve a user group by its unique identifier. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getUserGroupById/).
|
|
264
288
|
*/
|
|
265
289
|
getUserGroupById({ groupId, requestHeaders }?: UserPlatformApplicationValidator.GetUserGroupByIdParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserGroupResponseSchema>;
|
|
266
290
|
/**
|
|
@@ -271,7 +295,7 @@ declare class User {
|
|
|
271
295
|
* Success response
|
|
272
296
|
* @name getUserGroups
|
|
273
297
|
* @summary: Get User Groups
|
|
274
|
-
* @description: Retrieve a list of user groups. - Check out [method documentation](https://
|
|
298
|
+
* @description: Retrieve a list of user groups. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getUserGroups/).
|
|
275
299
|
*/
|
|
276
300
|
getUserGroups({ pageNo, pageSize, name, type, status, groupUid, requestHeaders }?: UserPlatformApplicationValidator.GetUserGroupsParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserGroupListResponseSchema>;
|
|
277
301
|
/**
|
|
@@ -281,7 +305,7 @@ declare class User {
|
|
|
281
305
|
* @returns {Promise<UserPlatformModel.GetUserTimeline>} - Success response
|
|
282
306
|
* @name getUserTimeline
|
|
283
307
|
* @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://
|
|
308
|
+
* @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
309
|
*/
|
|
286
310
|
getUserTimeline({ userId, requestHeaders }?: UserPlatformApplicationValidator.GetUserTimelineParam, { responseHeaders }?: object): Promise<UserPlatformModel.GetUserTimeline>;
|
|
287
311
|
/**
|
|
@@ -292,7 +316,7 @@ declare class User {
|
|
|
292
316
|
* @name getUsersJobByJobId
|
|
293
317
|
* @summary: Retrieve Job Details by Job ID for a Specific Application, Including Both Import and Export Jobs.
|
|
294
318
|
* @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://
|
|
319
|
+
* - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getUsersJobByJobId/).
|
|
296
320
|
*/
|
|
297
321
|
getUsersJobByJobId({ jobId, requestHeaders }?: UserPlatformApplicationValidator.GetUsersJobByJobIdParam, { responseHeaders }?: object): Promise<UserPlatformModel.BulkActionModel>;
|
|
298
322
|
/**
|
|
@@ -302,7 +326,7 @@ declare class User {
|
|
|
302
326
|
* @returns {Promise<UserPlatformModel.UserSearchResponseSchema>} - Success response
|
|
303
327
|
* @name searchUsers
|
|
304
328
|
* @summary: Search an Existing Users
|
|
305
|
-
* @description: Search and filter users details registered in the sales channel - Check out [method documentation](https://
|
|
329
|
+
* @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
330
|
*/
|
|
307
331
|
searchUsers({ q, query, requestHeaders }?: UserPlatformApplicationValidator.SearchUsersParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserSearchResponseSchema>;
|
|
308
332
|
/**
|
|
@@ -312,7 +336,7 @@ declare class User {
|
|
|
312
336
|
* @returns {Promise<UserPlatformModel.UnDeleteUserSuccess>} - Success response
|
|
313
337
|
* @name unDeleteUser
|
|
314
338
|
* @summary: Restore Deleted User
|
|
315
|
-
* @description: Restore a previously deleted user account. - Check out [method documentation](https://
|
|
339
|
+
* @description: Restore a previously deleted user account. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/unDeleteUser/).
|
|
316
340
|
*/
|
|
317
341
|
unDeleteUser({ body, requestHeaders }?: UserPlatformApplicationValidator.UnDeleteUserParam, { responseHeaders }?: object): Promise<UserPlatformModel.UnDeleteUserSuccess>;
|
|
318
342
|
/**
|
|
@@ -324,7 +348,7 @@ declare class User {
|
|
|
324
348
|
* @returns {Promise<UserPlatformModel.PlatformSchema>} - Success response
|
|
325
349
|
* @name updatePlatformConfig
|
|
326
350
|
* @summary: Update Platform Config
|
|
327
|
-
* @description: Modify and update platform sales channel authentication configuration. - Check out [method documentation](https://
|
|
351
|
+
* @description: Modify and update platform sales channel authentication configuration. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/updatePlatformConfig/).
|
|
328
352
|
*/
|
|
329
353
|
updatePlatformConfig({ body, requestHeaders }?: UserPlatformApplicationValidator.UpdatePlatformConfigParam, { responseHeaders }?: object): Promise<UserPlatformModel.PlatformSchema>;
|
|
330
354
|
/**
|
|
@@ -334,7 +358,7 @@ declare class User {
|
|
|
334
358
|
* @returns {Promise<UserPlatformModel.CreateUserResponseSchema>} - Success response
|
|
335
359
|
* @name updateUser
|
|
336
360
|
* @summary: Update User Details
|
|
337
|
-
* @description: Modify and update user profile information. - Check out [method documentation](https://
|
|
361
|
+
* @description: Modify and update user profile information. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/updateUser/).
|
|
338
362
|
*/
|
|
339
363
|
updateUser({ userId, body, requestHeaders }?: UserPlatformApplicationValidator.UpdateUserParam, { responseHeaders }?: object): Promise<UserPlatformModel.CreateUserResponseSchema>;
|
|
340
364
|
/**
|
|
@@ -344,7 +368,7 @@ declare class User {
|
|
|
344
368
|
* @returns {Promise<UserPlatformModel.UserAttribute>} - Success response
|
|
345
369
|
* @name updateUserAttribute
|
|
346
370
|
* @summary: Update Or Create User Attribute
|
|
347
|
-
* @description: Update Or Create User Attribute - Check out [method documentation](https://
|
|
371
|
+
* @description: Update Or Create User Attribute - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/updateUserAttribute/).
|
|
348
372
|
*/
|
|
349
373
|
updateUserAttribute({ attributeDefId, userId, body, requestHeaders }?: UserPlatformApplicationValidator.UpdateUserAttributeParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserAttribute>;
|
|
350
374
|
/**
|
|
@@ -356,9 +380,21 @@ declare class User {
|
|
|
356
380
|
* @returns {Promise<UserPlatformModel.UserAttributeDefinition>} - Success response
|
|
357
381
|
* @name updateUserAttributeDefinition
|
|
358
382
|
* @summary: Update User Attribute Definition
|
|
359
|
-
* @description: Update an existing user attribute definition. - Check out [method documentation](https://
|
|
383
|
+
* @description: Update an existing user attribute definition. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/updateUserAttributeDefinition/).
|
|
360
384
|
*/
|
|
361
385
|
updateUserAttributeDefinition({ attributeDefId, body, requestHeaders }?: UserPlatformApplicationValidator.UpdateUserAttributeDefinitionParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserAttributeDefinition>;
|
|
386
|
+
/**
|
|
387
|
+
* @param {UserPlatformApplicationValidator.UpdateUserAttributesParam} arg
|
|
388
|
+
* - Arg object
|
|
389
|
+
*
|
|
390
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
391
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
392
|
+
* @returns {Promise<UserPlatformModel.BulkUserAttribute>} - Success response
|
|
393
|
+
* @name updateUserAttributes
|
|
394
|
+
* @summary: Create Or Update User Attribute
|
|
395
|
+
* @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/).
|
|
396
|
+
*/
|
|
397
|
+
updateUserAttributes({ userId, body, requestHeaders }?: UserPlatformApplicationValidator.UpdateUserAttributesParam, { responseHeaders }?: object): Promise<UserPlatformModel.BulkUserAttribute>;
|
|
362
398
|
/**
|
|
363
399
|
* @param {UserPlatformApplicationValidator.UpdateUserGroupParam} arg - Arg object
|
|
364
400
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -366,7 +402,7 @@ declare class User {
|
|
|
366
402
|
* @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
|
|
367
403
|
* @name updateUserGroup
|
|
368
404
|
* @summary: Update User Group
|
|
369
|
-
* @description: Modify and update user group details. - Check out [method documentation](https://
|
|
405
|
+
* @description: Modify and update user group details. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/updateUserGroup/).
|
|
370
406
|
*/
|
|
371
407
|
updateUserGroup({ groupId, body, requestHeaders }?: UserPlatformApplicationValidator.UpdateUserGroupParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserGroupResponseSchema>;
|
|
372
408
|
/**
|
|
@@ -378,7 +414,7 @@ declare class User {
|
|
|
378
414
|
* @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
|
|
379
415
|
* @name updateUserGroupPartially
|
|
380
416
|
* @summary: Modify User Group
|
|
381
|
-
* @description: Update user group partially on the platform. - Check out [method documentation](https://
|
|
417
|
+
* @description: Update user group partially on the platform. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/updateUserGroupPartially/).
|
|
382
418
|
*/
|
|
383
419
|
updateUserGroupPartially({ groupId, body, requestHeaders }?: UserPlatformApplicationValidator.UpdateUserGroupPartiallyParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserGroupResponseSchema>;
|
|
384
420
|
}
|