@gofynd/fdk-client-javascript 3.3.5 → 3.3.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- 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 +30 -30
- package/sdk/application/Catalog/CatalogApplicationClient.js +30 -30
- 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 +9 -9
- package/sdk/application/Logistic/LogisticApplicationClient.js +9 -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 +2 -2
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +1 -1
- 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 +2 -2
- package/sdk/partner/Webhook/WebhookPartnerModel.js +1 -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 +41 -3
- package/sdk/platform/Cart/CartPlatformModel.js +24 -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 +77 -77
- package/sdk/platform/Catalog/CatalogPlatformClient.js +77 -77
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +56 -3
- package/sdk/platform/Catalog/CatalogPlatformModel.js +40 -1
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +2 -2
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +2 -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 +2 -2
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +1 -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 +9 -9
- package/sdk/platform/Order/OrderPlatformModel.js +6 -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 +38 -38
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +38 -38
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +28 -28
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +28 -28
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +2 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1 -1
- 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 +34 -34
- package/sdk/platform/User/UserPlatformApplicationClient.js +34 -34
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +9 -9
- package/sdk/platform/Webhook/WebhookPlatformClient.js +9 -9
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +2 -2
- package/sdk/platform/Webhook/WebhookPlatformModel.js +1 -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
|
@@ -24,7 +24,7 @@ class Theme {
|
|
|
24
24
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
25
25
|
* @name addThemeToApplication
|
|
26
26
|
* @summary: Create theme in sales channel
|
|
27
|
-
* @description: Include a theme in an application drafts from theme collection. - Check out [method documentation](https://
|
|
27
|
+
* @description: Include a theme in an application drafts from theme collection. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/addThemeToApplication/).
|
|
28
28
|
*/
|
|
29
29
|
async addThemeToApplication(
|
|
30
30
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -103,7 +103,7 @@ class Theme {
|
|
|
103
103
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
104
104
|
* @name applyTheme
|
|
105
105
|
* @summary: Apply a theme
|
|
106
|
-
* @description: Change current applied theme with new draft theme. - Check out [method documentation](https://
|
|
106
|
+
* @description: Change current applied theme with new draft theme. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/applyTheme/).
|
|
107
107
|
*/
|
|
108
108
|
async applyTheme(
|
|
109
109
|
{ themeId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -180,7 +180,7 @@ class Theme {
|
|
|
180
180
|
* @returns {Promise<ThemePlatformModel.AvailablePageSchema>} - Success response
|
|
181
181
|
* @name createPage
|
|
182
182
|
* @summary: Create theme page
|
|
183
|
-
* @description: Generate and add a new page to the selected theme of the Platform. - Check out [method documentation](https://
|
|
183
|
+
* @description: Generate and add a new page to the selected theme of the Platform. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/createPage/).
|
|
184
184
|
*/
|
|
185
185
|
async createPage(
|
|
186
186
|
{ themeId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -259,7 +259,7 @@ class Theme {
|
|
|
259
259
|
* @returns {Promise<ThemePlatformModel.AvailablePageSchema>} - Success response
|
|
260
260
|
* @name deletePage
|
|
261
261
|
* @summary: Delete a page
|
|
262
|
-
* @description: Remove a page from a theme of the platform. - Check out [method documentation](https://
|
|
262
|
+
* @description: Remove a page from a theme of the platform. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/deletePage/).
|
|
263
263
|
*/
|
|
264
264
|
async deletePage(
|
|
265
265
|
{ themeId, pageValue, requestHeaders } = { requestHeaders: {} },
|
|
@@ -338,7 +338,7 @@ class Theme {
|
|
|
338
338
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
339
339
|
* @name deleteTheme
|
|
340
340
|
* @summary: Delete theme
|
|
341
|
-
* @description: Remove a theme from theme drafts of a sales channel. - Check out [method documentation](https://
|
|
341
|
+
* @description: Remove a theme from theme drafts of a sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/deleteTheme/).
|
|
342
342
|
*/
|
|
343
343
|
async deleteTheme(
|
|
344
344
|
{ themeId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -415,7 +415,7 @@ class Theme {
|
|
|
415
415
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
416
416
|
* @name duplicateTheme
|
|
417
417
|
* @summary: Duplicate a theme
|
|
418
|
-
* @description: Create a new copy of an existing theme by theme Id - Check out [method documentation](https://
|
|
418
|
+
* @description: Create a new copy of an existing theme by theme Id - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/duplicateTheme/).
|
|
419
419
|
*/
|
|
420
420
|
async duplicateTheme(
|
|
421
421
|
{ themeId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -494,7 +494,7 @@ class Theme {
|
|
|
494
494
|
* @returns {Promise<ThemePlatformModel.AllAvailablePageSchema>} - Success response
|
|
495
495
|
* @name getAllPages
|
|
496
496
|
* @summary: List pages of a theme
|
|
497
|
-
* @description: Retrieve a list of all available pages. - Check out [method documentation](https://
|
|
497
|
+
* @description: Retrieve a list of all available pages. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/getAllPages/).
|
|
498
498
|
*/
|
|
499
499
|
async getAllPages(
|
|
500
500
|
{ themeId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -573,7 +573,7 @@ class Theme {
|
|
|
573
573
|
* @returns {Promise<ThemePlatformModel.ThemesSchema[]>} - Success response
|
|
574
574
|
* @name getApplicationThemes
|
|
575
575
|
* @summary: List sales channel themes
|
|
576
|
-
* @description: Retrieve all draft themes added to sales channel from theme collection. - Check out [method documentation](https://
|
|
576
|
+
* @description: Retrieve all draft themes added to sales channel from theme collection. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/getApplicationThemes/).
|
|
577
577
|
*/
|
|
578
578
|
async getApplicationThemes(
|
|
579
579
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -647,7 +647,7 @@ class Theme {
|
|
|
647
647
|
* @returns {Promise<Object>} - Success response
|
|
648
648
|
* @name getApplicationThemesCount
|
|
649
649
|
* @summary: Get sales channel themes count
|
|
650
|
-
* @description: Retrieve count of all draft themes added to sales channel from theme collection. - Check out [method documentation](https://
|
|
650
|
+
* @description: Retrieve count of all draft themes added to sales channel from theme collection. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/getApplicationThemesCount/).
|
|
651
651
|
*/
|
|
652
652
|
async getApplicationThemesCount(
|
|
653
653
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -720,7 +720,7 @@ class Theme {
|
|
|
720
720
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
721
721
|
* @name getAppliedTheme
|
|
722
722
|
* @summary: Get applied theme
|
|
723
|
-
* @description: Retrieve the currently applied theme of a sales channel using application Id. - Check out [method documentation](https://
|
|
723
|
+
* @description: Retrieve the currently applied theme of a sales channel using application Id. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/getAppliedTheme/).
|
|
724
724
|
*/
|
|
725
725
|
async getAppliedTheme(
|
|
726
726
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -797,7 +797,7 @@ class Theme {
|
|
|
797
797
|
* @returns {Promise<ThemePlatformModel.GetExtensionSectionRes[]>} - Success response
|
|
798
798
|
* @name getExtensionSections
|
|
799
799
|
* @summary: Get extension sections
|
|
800
|
-
* @description: Retrieve the list of extension sections for a given application in the specified company. - Check out [method documentation](https://
|
|
800
|
+
* @description: Retrieve the list of extension sections for a given application in the specified company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/getExtensionSections/).
|
|
801
801
|
*/
|
|
802
802
|
async getExtensionSections(
|
|
803
803
|
{ type, companyMode, requestHeaders } = { requestHeaders: {} },
|
|
@@ -877,7 +877,7 @@ class Theme {
|
|
|
877
877
|
* @returns {Promise<ThemePlatformModel.FontsSchema>} - Success response
|
|
878
878
|
* @name getFonts
|
|
879
879
|
* @summary: List theme fonts
|
|
880
|
-
* @description: Retrieve a list of available fonts that can be used by themes in the platform. - Check out [method documentation](https://
|
|
880
|
+
* @description: Retrieve a list of available fonts that can be used by themes in the platform. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/getFonts/).
|
|
881
881
|
*/
|
|
882
882
|
async getFonts(
|
|
883
883
|
{ capability, requestHeaders } = { requestHeaders: {} },
|
|
@@ -955,7 +955,7 @@ class Theme {
|
|
|
955
955
|
* @returns {Promise<ThemePlatformModel.AvailablePageSchema>} - Success response
|
|
956
956
|
* @name getPage
|
|
957
957
|
* @summary: Get a page
|
|
958
|
-
* @description: Retrieve detailed information about a specific page of a theme. - Check out [method documentation](https://
|
|
958
|
+
* @description: Retrieve detailed information about a specific page of a theme. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/getPage/).
|
|
959
959
|
*/
|
|
960
960
|
async getPage(
|
|
961
961
|
{ themeId, pageValue, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1034,7 +1034,7 @@ class Theme {
|
|
|
1034
1034
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
1035
1035
|
* @name getThemeById
|
|
1036
1036
|
* @summary: Get theme
|
|
1037
|
-
* @description: Retrieve a theme by its unique identifier. Response contains theme template data and data stored in theme editor. - Check out [method documentation](https://
|
|
1037
|
+
* @description: Retrieve a theme by its unique identifier. Response contains theme template data and data stored in theme editor. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/getThemeById/).
|
|
1038
1038
|
*/
|
|
1039
1039
|
async getThemeById(
|
|
1040
1040
|
{ themeId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1111,7 +1111,7 @@ class Theme {
|
|
|
1111
1111
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
1112
1112
|
* @name getThemeForPreview
|
|
1113
1113
|
* @summary: Get theme for preview
|
|
1114
|
-
* @description: Retrieve a theme by its unique identifier. Response contains theme template data and data stored in theme editor. - Check out [method documentation](https://
|
|
1114
|
+
* @description: Retrieve a theme by its unique identifier. Response contains theme template data and data stored in theme editor. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/getThemeForPreview/).
|
|
1115
1115
|
*/
|
|
1116
1116
|
async getThemeForPreview(
|
|
1117
1117
|
{ themeId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1192,7 +1192,7 @@ class Theme {
|
|
|
1192
1192
|
* @returns {Promise<any>} - Success response
|
|
1193
1193
|
* @name getThemeLastModified
|
|
1194
1194
|
* @summary: Get theme last modified date
|
|
1195
|
-
* @description: Retrieve the last modification of a theme used for polling and identifing cross user changes in a theme. - Check out [method documentation](https://
|
|
1195
|
+
* @description: Retrieve the last modification of a theme used for polling and identifing cross user changes in a theme. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/getThemeLastModified/).
|
|
1196
1196
|
*/
|
|
1197
1197
|
async getThemeLastModified(
|
|
1198
1198
|
{ themeId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1268,7 +1268,7 @@ class Theme {
|
|
|
1268
1268
|
* @returns {Promise<ThemePlatformModel.ThemeUpgradable>} - Success response
|
|
1269
1269
|
* @name isUpgradable
|
|
1270
1270
|
* @summary: Check theme is upgradable
|
|
1271
|
-
* @description: Determine if a public theme is eligible for an upgrade to a new version after any new version released in marketplace. - Check out [method documentation](https://
|
|
1271
|
+
* @description: Determine if a public theme is eligible for an upgrade to a new version after any new version released in marketplace. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/isUpgradable/).
|
|
1272
1272
|
*/
|
|
1273
1273
|
async isUpgradable(
|
|
1274
1274
|
{ themeId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1347,7 +1347,7 @@ class Theme {
|
|
|
1347
1347
|
* @returns {Promise<ThemePlatformModel.AllAvailablePageSchema>} - Success response
|
|
1348
1348
|
* @name updateMultiplePages
|
|
1349
1349
|
* @summary: Update theme pages
|
|
1350
|
-
* @description: Modify multiple pages simultaneously of a theme. - Check out [method documentation](https://
|
|
1350
|
+
* @description: Modify multiple pages simultaneously of a theme. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/updateMultiplePages/).
|
|
1351
1351
|
*/
|
|
1352
1352
|
async updateMultiplePages(
|
|
1353
1353
|
{ themeId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1428,7 +1428,7 @@ class Theme {
|
|
|
1428
1428
|
* @returns {Promise<ThemePlatformModel.AvailablePageSchema>} - Success response
|
|
1429
1429
|
* @name updatePage
|
|
1430
1430
|
* @summary: Update a page
|
|
1431
|
-
* @description: Modify and update the content of a page. - Check out [method documentation](https://
|
|
1431
|
+
* @description: Modify and update the content of a page. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/updatePage/).
|
|
1432
1432
|
*/
|
|
1433
1433
|
async updatePage(
|
|
1434
1434
|
{ themeId, pageValue, socketId, body, requestHeaders } = {
|
|
@@ -1513,7 +1513,7 @@ class Theme {
|
|
|
1513
1513
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
1514
1514
|
* @name updateTheme
|
|
1515
1515
|
* @summary: Update theme
|
|
1516
|
-
* @description: Modify and update the content and settings of a theme. - Check out [method documentation](https://
|
|
1516
|
+
* @description: Modify and update the content and settings of a theme. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/updateTheme/).
|
|
1517
1517
|
*/
|
|
1518
1518
|
async updateTheme(
|
|
1519
1519
|
{ themeId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1592,7 +1592,7 @@ class Theme {
|
|
|
1592
1592
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
1593
1593
|
* @name updateThemeName
|
|
1594
1594
|
* @summary: Update theme name
|
|
1595
|
-
* @description: Modify the name of the draft theme by theme Id. - Check out [method documentation](https://
|
|
1595
|
+
* @description: Modify the name of the draft theme by theme Id. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/updateThemeName/).
|
|
1596
1596
|
*/
|
|
1597
1597
|
async updateThemeName(
|
|
1598
1598
|
{ themeId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1673,7 +1673,7 @@ class Theme {
|
|
|
1673
1673
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
1674
1674
|
* @name upgradeTheme
|
|
1675
1675
|
* @summary: Upgrade theme
|
|
1676
|
-
* @description: Update a draft theme to a new version of the marketplace. - Check out [method documentation](https://
|
|
1676
|
+
* @description: Update a draft theme to a new version of the marketplace. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/upgradeTheme/).
|
|
1677
1677
|
*/
|
|
1678
1678
|
async upgradeTheme(
|
|
1679
1679
|
{ themeId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -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,7 +134,7 @@ declare class User {
|
|
|
134
134
|
* @returns {Promise<UserPlatformModel.SuccessMessage>} - Success response
|
|
135
135
|
* @name deleteUserAttributeDefinitionById
|
|
136
136
|
* @summary: Delete User Attribute Definition
|
|
137
|
-
* @description: Delete a user attribute definition by its unique identifier. - Check out [method documentation](https://
|
|
137
|
+
* @description: Delete a user attribute definition by its unique identifier. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/deleteUserAttributeDefinitionById/).
|
|
138
138
|
*/
|
|
139
139
|
deleteUserAttributeDefinitionById({ attributeDefId, requestHeaders }?: UserPlatformApplicationValidator.DeleteUserAttributeDefinitionByIdParam, { responseHeaders }?: object): Promise<UserPlatformModel.SuccessMessage>;
|
|
140
140
|
/**
|
|
@@ -144,7 +144,7 @@ declare class User {
|
|
|
144
144
|
* @returns {Promise<UserPlatformModel.SessionListResponseSchema>} - Success response
|
|
145
145
|
* @name getActiveSessions
|
|
146
146
|
* @summary: Get User Active Sessions
|
|
147
|
-
* @description: Retrieve a list of currently active user sessions. - Check out [method documentation](https://
|
|
147
|
+
* @description: Retrieve a list of currently active user sessions. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getActiveSessions/).
|
|
148
148
|
*/
|
|
149
149
|
getActiveSessions({ id, requestHeaders }?: UserPlatformApplicationValidator.GetActiveSessionsParam, { responseHeaders }?: object): Promise<UserPlatformModel.SessionListResponseSchema>;
|
|
150
150
|
/**
|
|
@@ -158,7 +158,7 @@ declare class User {
|
|
|
158
158
|
* @summary: Get Bulk User's Export Lists for a specific Application.
|
|
159
159
|
* @description: This API allows fetching the list of bulk user exports for a specific application and company.
|
|
160
160
|
* It supports pagination and filtering based on various parameters.
|
|
161
|
-
* - Check out [method documentation](https://
|
|
161
|
+
* - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getBulkExportUsersList/).
|
|
162
162
|
*/
|
|
163
163
|
getBulkExportUsersList({ pageNo, pageSize, fileFormat, search, startDate, endDate, status, requestHeaders, }?: UserPlatformApplicationValidator.GetBulkExportUsersListParam, { responseHeaders }?: object): Promise<UserPlatformModel.BulkActionPaginationSchema>;
|
|
164
164
|
/**
|
|
@@ -172,7 +172,7 @@ declare class User {
|
|
|
172
172
|
* @summary: Get Bulk User's Import Lists for a specific Application.
|
|
173
173
|
* @description: This API allows fetching the list of bulk user imports for a specific application and company.
|
|
174
174
|
* It supports pagination and filtering based on various parameters.
|
|
175
|
-
* - Check out [method documentation](https://
|
|
175
|
+
* - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getBulkImportUsersList/).
|
|
176
176
|
*/
|
|
177
177
|
getBulkImportUsersList({ pageNo, pageSize, search, startDate, endDate, status, fileFormat, requestHeaders, }?: UserPlatformApplicationValidator.GetBulkImportUsersListParam, { responseHeaders }?: object): Promise<UserPlatformModel.BulkActionPaginationSchema>;
|
|
178
178
|
/**
|
|
@@ -182,7 +182,7 @@ declare class User {
|
|
|
182
182
|
* @returns {Promise<UserPlatformModel.CustomerListResponseSchema>} - Success response
|
|
183
183
|
* @name getCustomers
|
|
184
184
|
* @summary: Get a List of Users
|
|
185
|
-
* @description: Retrieve details of users registered in the sales channel - Check out [method documentation](https://
|
|
185
|
+
* @description: Retrieve details of users registered in the sales channel - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getCustomers/).
|
|
186
186
|
*/
|
|
187
187
|
getCustomers({ q, pageSize, pageNo, requestHeaders }?: UserPlatformApplicationValidator.GetCustomersParam, { responseHeaders }?: object): Promise<UserPlatformModel.CustomerListResponseSchema>;
|
|
188
188
|
/**
|
|
@@ -192,7 +192,7 @@ declare class User {
|
|
|
192
192
|
* @returns {Promise<UserPlatformModel.PlatformSchema>} - Success response
|
|
193
193
|
* @name getPlatformConfig
|
|
194
194
|
* @summary: Get Platform Config
|
|
195
|
-
* @description: Retrieve platform sales channel authentication configuration. - Check out [method documentation](https://
|
|
195
|
+
* @description: Retrieve platform sales channel authentication configuration. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getPlatformConfig/).
|
|
196
196
|
*/
|
|
197
197
|
getPlatformConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<UserPlatformModel.PlatformSchema>;
|
|
198
198
|
/**
|
|
@@ -202,7 +202,7 @@ declare class User {
|
|
|
202
202
|
* @returns {Promise<UserPlatformModel.UserAttribute>} - Success response
|
|
203
203
|
* @name getUserAttribute
|
|
204
204
|
* @summary: Get User Attribute
|
|
205
|
-
* @description: Get User Attribute - Check out [method documentation](https://
|
|
205
|
+
* @description: Get User Attribute - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getUserAttribute/).
|
|
206
206
|
*/
|
|
207
207
|
getUserAttribute({ attributeDefId, userId, requestHeaders }?: UserPlatformApplicationValidator.GetUserAttributeParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserAttribute>;
|
|
208
208
|
/**
|
|
@@ -214,7 +214,7 @@ declare class User {
|
|
|
214
214
|
* @returns {Promise<UserPlatformModel.UserAttribute>} - Success response
|
|
215
215
|
* @name getUserAttributeById
|
|
216
216
|
* @summary: Get User Attribute
|
|
217
|
-
* @description: Retrieve User Attribute details by ID. - Check out [method documentation](https://
|
|
217
|
+
* @description: Retrieve User Attribute details by ID. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getUserAttributeById/).
|
|
218
218
|
*/
|
|
219
219
|
getUserAttributeById({ attributeId, requestHeaders }?: UserPlatformApplicationValidator.GetUserAttributeByIdParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserAttribute>;
|
|
220
220
|
/**
|
|
@@ -226,7 +226,7 @@ declare class User {
|
|
|
226
226
|
* @returns {Promise<UserPlatformModel.UserAttributeDefinition>} - Success response
|
|
227
227
|
* @name getUserAttributeDefinitionById
|
|
228
228
|
* @summary: Get User Attribute Definition
|
|
229
|
-
* @description: Get a user attribute definition by its unique identifier. - Check out [method documentation](https://
|
|
229
|
+
* @description: Get a user attribute definition by its unique identifier. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getUserAttributeDefinitionById/).
|
|
230
230
|
*/
|
|
231
231
|
getUserAttributeDefinitionById({ attributeDefId, requestHeaders }?: UserPlatformApplicationValidator.GetUserAttributeDefinitionByIdParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserAttributeDefinition>;
|
|
232
232
|
/**
|
|
@@ -238,7 +238,7 @@ declare class User {
|
|
|
238
238
|
* @returns {Promise<Object>} - Success response
|
|
239
239
|
* @name getUserAttributeDefinitions
|
|
240
240
|
* @summary: Get User Attribute Definitions
|
|
241
|
-
* @description: Retrieve user attribute definitions. - Check out [method documentation](https://
|
|
241
|
+
* @description: Retrieve user attribute definitions. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getUserAttributeDefinitions/).
|
|
242
242
|
*/
|
|
243
243
|
getUserAttributeDefinitions({ excludingIds, slug, type, customerEditable, encrypted, pinned, pinOrder, isLocked, name, pageSize, pageNo, requestHeaders, }?: UserPlatformApplicationValidator.GetUserAttributeDefinitionsParam, { responseHeaders }?: object): Promise<any>;
|
|
244
244
|
/**
|
|
@@ -250,7 +250,7 @@ declare class User {
|
|
|
250
250
|
* @returns {Promise<Object>} - Success response
|
|
251
251
|
* @name getUserAttributesForUser
|
|
252
252
|
* @summary: Get All Customer Attributes
|
|
253
|
-
* @description: Retrieve all user attributes for a specific user - Check out [method documentation](https://
|
|
253
|
+
* @description: Retrieve all user attributes for a specific user - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getUserAttributesForUser/).
|
|
254
254
|
*/
|
|
255
255
|
getUserAttributesForUser({ userId, pageSize, pageNo, requestHeaders }?: UserPlatformApplicationValidator.GetUserAttributesForUserParam, { responseHeaders }?: object): Promise<any>;
|
|
256
256
|
/**
|
|
@@ -260,7 +260,7 @@ declare class User {
|
|
|
260
260
|
* @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
|
|
261
261
|
* @name getUserGroupById
|
|
262
262
|
* @summary: Get User Group
|
|
263
|
-
* @description: Retrieve a user group by its unique identifier. - Check out [method documentation](https://
|
|
263
|
+
* @description: Retrieve a user group by its unique identifier. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getUserGroupById/).
|
|
264
264
|
*/
|
|
265
265
|
getUserGroupById({ groupId, requestHeaders }?: UserPlatformApplicationValidator.GetUserGroupByIdParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserGroupResponseSchema>;
|
|
266
266
|
/**
|
|
@@ -271,7 +271,7 @@ declare class User {
|
|
|
271
271
|
* Success response
|
|
272
272
|
* @name getUserGroups
|
|
273
273
|
* @summary: Get User Groups
|
|
274
|
-
* @description: Retrieve a list of user groups. - Check out [method documentation](https://
|
|
274
|
+
* @description: Retrieve a list of user groups. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getUserGroups/).
|
|
275
275
|
*/
|
|
276
276
|
getUserGroups({ pageNo, pageSize, name, type, status, groupUid, requestHeaders }?: UserPlatformApplicationValidator.GetUserGroupsParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserGroupListResponseSchema>;
|
|
277
277
|
/**
|
|
@@ -281,7 +281,7 @@ declare class User {
|
|
|
281
281
|
* @returns {Promise<UserPlatformModel.GetUserTimeline>} - Success response
|
|
282
282
|
* @name getUserTimeline
|
|
283
283
|
* @summary: Get Deleted User Timeline
|
|
284
|
-
* @description: Fetches the timeline for the user who has made a data erase request. The timeline will show when the request was raised and when the request will be completed. It will also show if request has been cancelled before completion. - Check out [method documentation](https://
|
|
284
|
+
* @description: Fetches the timeline for the user who has made a data erase request. The timeline will show when the request was raised and when the request will be completed. It will also show if request has been cancelled before completion. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getUserTimeline/).
|
|
285
285
|
*/
|
|
286
286
|
getUserTimeline({ userId, requestHeaders }?: UserPlatformApplicationValidator.GetUserTimelineParam, { responseHeaders }?: object): Promise<UserPlatformModel.GetUserTimeline>;
|
|
287
287
|
/**
|
|
@@ -292,7 +292,7 @@ declare class User {
|
|
|
292
292
|
* @name getUsersJobByJobId
|
|
293
293
|
* @summary: Retrieve Job Details by Job ID for a Specific Application, Including Both Import and Export Jobs.
|
|
294
294
|
* @description: This endpoint retrieves the details of a specific user's import and export related jobs associated with a given `job_id`, `application_id`, and `company_id`.
|
|
295
|
-
* - Check out [method documentation](https://
|
|
295
|
+
* - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/getUsersJobByJobId/).
|
|
296
296
|
*/
|
|
297
297
|
getUsersJobByJobId({ jobId, requestHeaders }?: UserPlatformApplicationValidator.GetUsersJobByJobIdParam, { responseHeaders }?: object): Promise<UserPlatformModel.BulkActionModel>;
|
|
298
298
|
/**
|
|
@@ -302,7 +302,7 @@ declare class User {
|
|
|
302
302
|
* @returns {Promise<UserPlatformModel.UserSearchResponseSchema>} - Success response
|
|
303
303
|
* @name searchUsers
|
|
304
304
|
* @summary: Search an Existing Users
|
|
305
|
-
* @description: Search and filter users details registered in the sales channel - Check out [method documentation](https://
|
|
305
|
+
* @description: Search and filter users details registered in the sales channel - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/searchUsers/).
|
|
306
306
|
*/
|
|
307
307
|
searchUsers({ q, query, requestHeaders }?: UserPlatformApplicationValidator.SearchUsersParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserSearchResponseSchema>;
|
|
308
308
|
/**
|
|
@@ -312,7 +312,7 @@ declare class User {
|
|
|
312
312
|
* @returns {Promise<UserPlatformModel.UnDeleteUserSuccess>} - Success response
|
|
313
313
|
* @name unDeleteUser
|
|
314
314
|
* @summary: Restore Deleted User
|
|
315
|
-
* @description: Restore a previously deleted user account. - Check out [method documentation](https://
|
|
315
|
+
* @description: Restore a previously deleted user account. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/unDeleteUser/).
|
|
316
316
|
*/
|
|
317
317
|
unDeleteUser({ body, requestHeaders }?: UserPlatformApplicationValidator.UnDeleteUserParam, { responseHeaders }?: object): Promise<UserPlatformModel.UnDeleteUserSuccess>;
|
|
318
318
|
/**
|
|
@@ -324,7 +324,7 @@ declare class User {
|
|
|
324
324
|
* @returns {Promise<UserPlatformModel.PlatformSchema>} - Success response
|
|
325
325
|
* @name updatePlatformConfig
|
|
326
326
|
* @summary: Update Platform Config
|
|
327
|
-
* @description: Modify and update platform sales channel authentication configuration. - Check out [method documentation](https://
|
|
327
|
+
* @description: Modify and update platform sales channel authentication configuration. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/updatePlatformConfig/).
|
|
328
328
|
*/
|
|
329
329
|
updatePlatformConfig({ body, requestHeaders }?: UserPlatformApplicationValidator.UpdatePlatformConfigParam, { responseHeaders }?: object): Promise<UserPlatformModel.PlatformSchema>;
|
|
330
330
|
/**
|
|
@@ -334,7 +334,7 @@ declare class User {
|
|
|
334
334
|
* @returns {Promise<UserPlatformModel.CreateUserResponseSchema>} - Success response
|
|
335
335
|
* @name updateUser
|
|
336
336
|
* @summary: Update User Details
|
|
337
|
-
* @description: Modify and update user profile information. - Check out [method documentation](https://
|
|
337
|
+
* @description: Modify and update user profile information. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/updateUser/).
|
|
338
338
|
*/
|
|
339
339
|
updateUser({ userId, body, requestHeaders }?: UserPlatformApplicationValidator.UpdateUserParam, { responseHeaders }?: object): Promise<UserPlatformModel.CreateUserResponseSchema>;
|
|
340
340
|
/**
|
|
@@ -344,7 +344,7 @@ declare class User {
|
|
|
344
344
|
* @returns {Promise<UserPlatformModel.UserAttribute>} - Success response
|
|
345
345
|
* @name updateUserAttribute
|
|
346
346
|
* @summary: Update Or Create User Attribute
|
|
347
|
-
* @description: Update Or Create User Attribute - Check out [method documentation](https://
|
|
347
|
+
* @description: Update Or Create User Attribute - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/updateUserAttribute/).
|
|
348
348
|
*/
|
|
349
349
|
updateUserAttribute({ attributeDefId, userId, body, requestHeaders }?: UserPlatformApplicationValidator.UpdateUserAttributeParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserAttribute>;
|
|
350
350
|
/**
|
|
@@ -356,7 +356,7 @@ declare class User {
|
|
|
356
356
|
* @returns {Promise<UserPlatformModel.UserAttributeDefinition>} - Success response
|
|
357
357
|
* @name updateUserAttributeDefinition
|
|
358
358
|
* @summary: Update User Attribute Definition
|
|
359
|
-
* @description: Update an existing user attribute definition. - Check out [method documentation](https://
|
|
359
|
+
* @description: Update an existing user attribute definition. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/updateUserAttributeDefinition/).
|
|
360
360
|
*/
|
|
361
361
|
updateUserAttributeDefinition({ attributeDefId, body, requestHeaders }?: UserPlatformApplicationValidator.UpdateUserAttributeDefinitionParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserAttributeDefinition>;
|
|
362
362
|
/**
|
|
@@ -366,7 +366,7 @@ declare class User {
|
|
|
366
366
|
* @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
|
|
367
367
|
* @name updateUserGroup
|
|
368
368
|
* @summary: Update User Group
|
|
369
|
-
* @description: Modify and update user group details. - Check out [method documentation](https://
|
|
369
|
+
* @description: Modify and update user group details. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/updateUserGroup/).
|
|
370
370
|
*/
|
|
371
371
|
updateUserGroup({ groupId, body, requestHeaders }?: UserPlatformApplicationValidator.UpdateUserGroupParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserGroupResponseSchema>;
|
|
372
372
|
/**
|
|
@@ -378,7 +378,7 @@ declare class User {
|
|
|
378
378
|
* @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
|
|
379
379
|
* @name updateUserGroupPartially
|
|
380
380
|
* @summary: Modify User Group
|
|
381
|
-
* @description: Update user group partially on the platform. - Check out [method documentation](https://
|
|
381
|
+
* @description: Update user group partially on the platform. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/updateUserGroupPartially/).
|
|
382
382
|
*/
|
|
383
383
|
updateUserGroupPartially({ groupId, body, requestHeaders }?: UserPlatformApplicationValidator.UpdateUserGroupPartiallyParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserGroupResponseSchema>;
|
|
384
384
|
}
|