@gofynd/fdk-client-javascript 1.4.2-beta.4 → 1.4.2-beta.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 +3 -2
- package/sdk/application/ApplicationClient.js +20 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +62 -62
- package/sdk/application/Cart/CartApplicationClient.js +82 -71
- package/sdk/application/Cart/CartApplicationValidator.d.ts +189 -34
- package/sdk/application/Cart/CartApplicationValidator.js +59 -34
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +78 -78
- package/sdk/application/Catalog/CatalogApplicationClient.js +78 -78
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +4 -4
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -6
- package/sdk/application/Communication/CommunicationApplicationClient.js +6 -6
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -67
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +32 -106
- package/sdk/application/Content/ContentApplicationClient.d.ts +34 -64
- package/sdk/application/Content/ContentApplicationClient.js +34 -115
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -42
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +6 -42
- package/sdk/application/Lead/LeadApplicationClient.d.ts +14 -14
- package/sdk/application/Lead/LeadApplicationClient.js +14 -14
- package/sdk/application/Lead/LeadApplicationModel.js +1 -1
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +12 -12
- package/sdk/application/Logistic/LogisticApplicationClient.js +12 -12
- package/sdk/application/Order/OrderApplicationClient.d.ts +24 -24
- package/sdk/application/Order/OrderApplicationClient.js +24 -24
- package/sdk/application/Order/OrderApplicationModel.d.ts +23 -1
- package/sdk/application/Order/OrderApplicationModel.js +28 -0
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +89 -89
- package/sdk/application/Payment/PaymentApplicationClient.js +94 -94
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +498 -3
- package/sdk/application/Payment/PaymentApplicationModel.js +316 -2
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +5 -5
- package/sdk/application/Payment/PaymentApplicationValidator.js +3 -3
- package/sdk/application/PosCart/PosCartApplicationClient.d.ts +54 -54
- package/sdk/application/PosCart/PosCartApplicationClient.js +54 -54
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +14 -25
- package/sdk/application/Rewards/RewardsApplicationClient.js +14 -41
- package/sdk/application/Share/ShareApplicationClient.d.ts +14 -14
- package/sdk/application/Share/ShareApplicationClient.js +14 -14
- package/sdk/application/Share/ShareApplicationModel.d.ts +0 -4
- package/sdk/application/Share/ShareApplicationModel.js +0 -4
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
- package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
- package/sdk/application/User/UserApplicationClient.d.ts +64 -64
- package/sdk/application/User/UserApplicationClient.js +64 -64
- package/sdk/common/Clickstream.d.ts +1 -0
- package/sdk/common/Clickstream.js +246 -0
- package/sdk/common/Utility.js +1 -4
- package/sdk/partner/Lead/LeadPartnerModel.js +1 -1
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +38 -38
- package/sdk/partner/Theme/ThemePartnerClient.js +38 -38
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +8 -8
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +8 -8
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +34 -36
- package/sdk/platform/Billing/BillingPlatformClient.js +34 -36
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +98 -175
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +98 -254
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +92 -18
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +28 -18
- package/sdk/platform/Cart/CartPlatformModel.d.ts +12 -0
- package/sdk/platform/Cart/CartPlatformModel.js +12 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +195 -108
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +278 -113
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +335 -136
- package/sdk/platform/Catalog/CatalogPlatformClient.js +551 -136
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +5 -5
- package/sdk/platform/Catalog/CatalogPlatformModel.js +3 -3
- package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -3
- package/sdk/platform/Common/CommonPlatformClient.js +3 -3
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +115 -290
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +115 -510
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +2 -13
- package/sdk/platform/Communication/CommunicationPlatformClient.js +2 -29
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +32 -32
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +52 -127
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +52 -204
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +35 -111
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +35 -212
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +142 -1
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +96 -0
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +130 -218
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +136 -314
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +4 -4
- package/sdk/platform/Content/ContentPlatformClient.d.ts +1 -1
- package/sdk/platform/Content/ContentPlatformClient.js +7 -7
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +4 -4
- package/sdk/platform/Content/ContentPlatformValidator.js +4 -4
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +22 -48
- package/sdk/platform/Discount/DiscountPlatformClient.js +22 -73
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +20 -56
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +20 -59
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +0 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +0 -2
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +14 -50
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +16 -55
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +13 -14
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +12 -16
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +44 -44
- package/sdk/platform/Finance/FinancePlatformClient.js +44 -44
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +12 -12
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +22 -48
- package/sdk/platform/Lead/LeadPlatformClient.js +22 -72
- package/sdk/platform/Lead/LeadPlatformModel.js +1 -1
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +4 -4
- package/sdk/platform/Order/OrderPlatformClient.d.ts +79 -208
- package/sdk/platform/Order/OrderPlatformClient.js +79 -294
- package/sdk/platform/Order/OrderPlatformModel.d.ts +32 -3
- package/sdk/platform/Order/OrderPlatformModel.js +34 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +81 -81
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +81 -81
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
- package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +23 -40
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +23 -61
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +5 -5
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +4 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +5 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +2 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +2 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Share/SharePlatformApplicationClient.js +10 -10
- package/sdk/platform/Share/SharePlatformModel.d.ts +0 -4
- package/sdk/platform/Share/SharePlatformModel.js +0 -4
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +56 -56
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +56 -56
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +6 -6
- package/sdk/platform/Theme/ThemePlatformClient.js +6 -6
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +33 -33
- package/sdk/platform/User/UserPlatformApplicationClient.js +33 -33
- package/sdk/platform/User/UserPlatformModel.d.ts +4 -4
- package/sdk/platform/User/UserPlatformModel.js +4 -4
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +32 -45
- package/sdk/platform/Webhook/WebhookPlatformClient.js +32 -45
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +58 -1
- package/sdk/platform/Webhook/WebhookPlatformModel.js +66 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +2 -2
- package/sdk/public/Partner/PartnerPublicClient.d.ts +2 -2
- package/sdk/public/Partner/PartnerPublicClient.js +2 -2
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicClient.js +4 -4
|
@@ -23,8 +23,8 @@ class Theme {
|
|
|
23
23
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
24
24
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
25
25
|
* @name addThemeToApplication
|
|
26
|
-
* @summary: Add
|
|
27
|
-
* @description:
|
|
26
|
+
* @summary: Add theme to application.
|
|
27
|
+
* @description: Include a theme in an application's design. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/addThemeToApplication/).
|
|
28
28
|
*/
|
|
29
29
|
async addThemeToApplication(
|
|
30
30
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -102,8 +102,8 @@ class Theme {
|
|
|
102
102
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
103
103
|
* @returns {Promise<ThemePlatformModel.DummyResponse>} - Success response
|
|
104
104
|
* @name addToThemeLibrary
|
|
105
|
-
* @summary: Add
|
|
106
|
-
* @description:
|
|
105
|
+
* @summary: Add to theme library.
|
|
106
|
+
* @description: Store and add a theme to the platform's library. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/addToThemeLibrary/).
|
|
107
107
|
*/
|
|
108
108
|
async addToThemeLibrary(
|
|
109
109
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -181,8 +181,8 @@ class Theme {
|
|
|
181
181
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
182
182
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
183
183
|
* @name applyTheme
|
|
184
|
-
* @summary: Apply theme
|
|
185
|
-
* @description:
|
|
184
|
+
* @summary: Apply theme.
|
|
185
|
+
* @description: Set and apply a theme to an application or page. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/applyTheme/).
|
|
186
186
|
*/
|
|
187
187
|
async applyTheme(
|
|
188
188
|
{ themeId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -258,8 +258,8 @@ class Theme {
|
|
|
258
258
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
259
259
|
* @returns {Promise<ThemePlatformModel.DummyResponse>} - Success response
|
|
260
260
|
* @name archiveTheme
|
|
261
|
-
* @summary: Archive
|
|
262
|
-
* @description:
|
|
261
|
+
* @summary: Archive theme.
|
|
262
|
+
* @description: Store a theme in an archive. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/archiveTheme/).
|
|
263
263
|
*/
|
|
264
264
|
async archiveTheme(
|
|
265
265
|
{ themeId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -335,8 +335,8 @@ class Theme {
|
|
|
335
335
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
336
336
|
* @returns {Promise<ThemePlatformModel.AvailablePageSchema>} - Success response
|
|
337
337
|
* @name createPage
|
|
338
|
-
* @summary: Create
|
|
339
|
-
* @description:
|
|
338
|
+
* @summary: Create page.
|
|
339
|
+
* @description: Generate and add a new page to the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/createPage/).
|
|
340
340
|
*/
|
|
341
341
|
async createPage(
|
|
342
342
|
{ themeId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -414,8 +414,8 @@ class Theme {
|
|
|
414
414
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
415
415
|
* @returns {Promise<ThemePlatformModel.AvailablePageSchema>} - Success response
|
|
416
416
|
* @name deletePage
|
|
417
|
-
* @summary:
|
|
418
|
-
* @description:
|
|
417
|
+
* @summary: Delete page.
|
|
418
|
+
* @description: Remove a page from the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/deletePage/).
|
|
419
419
|
*/
|
|
420
420
|
async deletePage(
|
|
421
421
|
{ themeId, pageValue, requestHeaders } = { requestHeaders: {} },
|
|
@@ -493,8 +493,8 @@ class Theme {
|
|
|
493
493
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
494
494
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
495
495
|
* @name deleteTheme
|
|
496
|
-
* @summary: Delete
|
|
497
|
-
* @description:
|
|
496
|
+
* @summary: Delete theme.
|
|
497
|
+
* @description: Remove a theme from the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/deleteTheme/).
|
|
498
498
|
*/
|
|
499
499
|
async deleteTheme(
|
|
500
500
|
{ themeId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -570,8 +570,8 @@ class Theme {
|
|
|
570
570
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
571
571
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
572
572
|
* @name duplicateTheme
|
|
573
|
-
* @summary: Duplicate
|
|
574
|
-
* @description:
|
|
573
|
+
* @summary: Duplicate theme.
|
|
574
|
+
* @description: Create a copy of an existing theme. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/duplicateTheme/).
|
|
575
575
|
*/
|
|
576
576
|
async duplicateTheme(
|
|
577
577
|
{ themeId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -649,8 +649,8 @@ class Theme {
|
|
|
649
649
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
650
650
|
* @returns {Promise<ThemePlatformModel.AllAvailablePageSchema>} - Success response
|
|
651
651
|
* @name getAllPages
|
|
652
|
-
* @summary: Get all pages
|
|
653
|
-
* @description:
|
|
652
|
+
* @summary: Get all pages.
|
|
653
|
+
* @description: Retrieve a list of all available pages. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getAllPages/).
|
|
654
654
|
*/
|
|
655
655
|
async getAllPages(
|
|
656
656
|
{ themeId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -728,8 +728,8 @@ class Theme {
|
|
|
728
728
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
729
729
|
* @returns {Promise<ThemePlatformModel.ThemesSchema[]>} - Success response
|
|
730
730
|
* @name getApplicationThemes
|
|
731
|
-
* @summary: Get
|
|
732
|
-
* @description:
|
|
731
|
+
* @summary: Get application themes.
|
|
732
|
+
* @description: Retrieve themes available for an application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getApplicationThemes/).
|
|
733
733
|
*/
|
|
734
734
|
async getApplicationThemes(
|
|
735
735
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -802,8 +802,8 @@ class Theme {
|
|
|
802
802
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
803
803
|
* @returns {Promise<Object>} - Success response
|
|
804
804
|
* @name getApplicationThemesCount
|
|
805
|
-
* @summary: Get
|
|
806
|
-
* @description:
|
|
805
|
+
* @summary: Get application themes count.
|
|
806
|
+
* @description: Count the number of themes available for an application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getApplicationThemesCount/).
|
|
807
807
|
*/
|
|
808
808
|
async getApplicationThemesCount(
|
|
809
809
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -875,8 +875,8 @@ class Theme {
|
|
|
875
875
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
876
876
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
877
877
|
* @name getAppliedTheme
|
|
878
|
-
* @summary: Get
|
|
879
|
-
* @description:
|
|
878
|
+
* @summary: Get applied theme.
|
|
879
|
+
* @description: Retrieve the currently applied theme. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getAppliedTheme/).
|
|
880
880
|
*/
|
|
881
881
|
async getAppliedTheme(
|
|
882
882
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -950,8 +950,8 @@ class Theme {
|
|
|
950
950
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
951
951
|
* @returns {Promise<ThemePlatformModel.FontsSchema>} - Success response
|
|
952
952
|
* @name getFonts
|
|
953
|
-
* @summary: Get
|
|
954
|
-
* @description:
|
|
953
|
+
* @summary: Get fonts.
|
|
954
|
+
* @description: Retrieve a list of available fonts. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getFonts/).
|
|
955
955
|
*/
|
|
956
956
|
async getFonts(
|
|
957
957
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -1023,8 +1023,8 @@ class Theme {
|
|
|
1023
1023
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1024
1024
|
* @returns {Promise<ThemePlatformModel.AvailablePageSchema>} - Success response
|
|
1025
1025
|
* @name getPage
|
|
1026
|
-
* @summary: Get page
|
|
1027
|
-
* @description:
|
|
1026
|
+
* @summary: Get page.
|
|
1027
|
+
* @description: Retrieve detailed information about a specific page. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getPage/).
|
|
1028
1028
|
*/
|
|
1029
1029
|
async getPage(
|
|
1030
1030
|
{ themeId, pageValue, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1102,8 +1102,8 @@ class Theme {
|
|
|
1102
1102
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1103
1103
|
* @returns {Promise<ThemePlatformModel.DummyResponse>} - Success response
|
|
1104
1104
|
* @name getPublicThemes
|
|
1105
|
-
* @summary: Get
|
|
1106
|
-
* @description:
|
|
1105
|
+
* @summary: Get public themes.
|
|
1106
|
+
* @description: Retrieve themes that are publicly accessible. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getPublicThemes/).
|
|
1107
1107
|
*/
|
|
1108
1108
|
async getPublicThemes(
|
|
1109
1109
|
{ pageSize, pageNo, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1185,8 +1185,8 @@ class Theme {
|
|
|
1185
1185
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1186
1186
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
1187
1187
|
* @name getThemeById
|
|
1188
|
-
* @summary: Get
|
|
1189
|
-
* @description:
|
|
1188
|
+
* @summary: Get theme by ID.
|
|
1189
|
+
* @description: Retrieve a theme by its unique identifier. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getThemeById/).
|
|
1190
1190
|
*/
|
|
1191
1191
|
async getThemeById(
|
|
1192
1192
|
{ themeId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1262,8 +1262,8 @@ class Theme {
|
|
|
1262
1262
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1263
1263
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
1264
1264
|
* @name getThemeForPreview
|
|
1265
|
-
* @summary: Get
|
|
1266
|
-
* @description:
|
|
1265
|
+
* @summary: Get theme for preview.
|
|
1266
|
+
* @description: Retrieve a theme for previewing before application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getThemeForPreview/).
|
|
1267
1267
|
*/
|
|
1268
1268
|
async getThemeForPreview(
|
|
1269
1269
|
{ themeId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1343,8 +1343,8 @@ class Theme {
|
|
|
1343
1343
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1344
1344
|
* @returns {Promise<any>} - Success response
|
|
1345
1345
|
* @name getThemeLastModified
|
|
1346
|
-
* @summary:
|
|
1347
|
-
* @description:
|
|
1346
|
+
* @summary: Get theme last modified.
|
|
1347
|
+
* @description: Retrieve the last modification of a theme. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getThemeLastModified/).
|
|
1348
1348
|
*/
|
|
1349
1349
|
async getThemeLastModified(
|
|
1350
1350
|
{ themeId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1419,8 +1419,8 @@ class Theme {
|
|
|
1419
1419
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1420
1420
|
* @returns {Promise<ThemePlatformModel.DummyResponse>} - Success response
|
|
1421
1421
|
* @name getThemeLibrary
|
|
1422
|
-
* @summary: Get
|
|
1423
|
-
* @description:
|
|
1422
|
+
* @summary: Get theme library.
|
|
1423
|
+
* @description: Retrieve themes available in the platform's library. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getThemeLibrary/).
|
|
1424
1424
|
*/
|
|
1425
1425
|
async getThemeLibrary(
|
|
1426
1426
|
{ pageSize, pageNo, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1502,8 +1502,8 @@ class Theme {
|
|
|
1502
1502
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1503
1503
|
* @returns {Promise<ThemePlatformModel.ThemeUpgradableResponse>} - Success response
|
|
1504
1504
|
* @name isUpgradable
|
|
1505
|
-
* @summary:
|
|
1506
|
-
* @description:
|
|
1505
|
+
* @summary: Is upgradable.
|
|
1506
|
+
* @description: Determine if a theme is eligible for an upgrade. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/isUpgradable/).
|
|
1507
1507
|
*/
|
|
1508
1508
|
async isUpgradable(
|
|
1509
1509
|
{ themeId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1579,8 +1579,8 @@ class Theme {
|
|
|
1579
1579
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1580
1580
|
* @returns {Promise<ThemePlatformModel.DummyResponse>} - Success response
|
|
1581
1581
|
* @name publishTheme
|
|
1582
|
-
* @summary: Publish
|
|
1583
|
-
* @description:
|
|
1582
|
+
* @summary: Publish theme.
|
|
1583
|
+
* @description: Make a theme accessible for use. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/publishTheme/).
|
|
1584
1584
|
*/
|
|
1585
1585
|
async publishTheme(
|
|
1586
1586
|
{ themeId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1656,8 +1656,8 @@ class Theme {
|
|
|
1656
1656
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1657
1657
|
* @returns {Promise<ThemePlatformModel.DummyResponse>} - Success response
|
|
1658
1658
|
* @name unarchiveTheme
|
|
1659
|
-
* @summary: Unarchive
|
|
1660
|
-
* @description:
|
|
1659
|
+
* @summary: Unarchive theme.
|
|
1660
|
+
* @description: Retrieve a theme from the archive. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/unarchiveTheme/).
|
|
1661
1661
|
*/
|
|
1662
1662
|
async unarchiveTheme(
|
|
1663
1663
|
{ themeId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1735,8 +1735,8 @@ class Theme {
|
|
|
1735
1735
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1736
1736
|
* @returns {Promise<ThemePlatformModel.DummyResponse>} - Success response
|
|
1737
1737
|
* @name unpublishTheme
|
|
1738
|
-
* @summary: Unpublish
|
|
1739
|
-
* @description:
|
|
1738
|
+
* @summary: Unpublish theme.
|
|
1739
|
+
* @description: Remove a published theme from public access. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/unpublishTheme/).
|
|
1740
1740
|
*/
|
|
1741
1741
|
async unpublishTheme(
|
|
1742
1742
|
{ themeId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1816,8 +1816,8 @@ class Theme {
|
|
|
1816
1816
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1817
1817
|
* @returns {Promise<ThemePlatformModel.AllAvailablePageSchema>} - Success response
|
|
1818
1818
|
* @name updateMultiplePages
|
|
1819
|
-
* @summary: Update multiple pages
|
|
1820
|
-
* @description:
|
|
1819
|
+
* @summary: Update multiple pages.
|
|
1820
|
+
* @description: Modify multiple pages simultaneously. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/updateMultiplePages/).
|
|
1821
1821
|
*/
|
|
1822
1822
|
async updateMultiplePages(
|
|
1823
1823
|
{ themeId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1897,8 +1897,8 @@ class Theme {
|
|
|
1897
1897
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1898
1898
|
* @returns {Promise<ThemePlatformModel.AvailablePageSchema>} - Success response
|
|
1899
1899
|
* @name updatePage
|
|
1900
|
-
* @summary:
|
|
1901
|
-
* @description:
|
|
1900
|
+
* @summary: Update page.
|
|
1901
|
+
* @description: Modify and update the content of a page. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/updatePage/).
|
|
1902
1902
|
*/
|
|
1903
1903
|
async updatePage(
|
|
1904
1904
|
{ themeId, pageValue, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1978,8 +1978,8 @@ class Theme {
|
|
|
1978
1978
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1979
1979
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
1980
1980
|
* @name updateTheme
|
|
1981
|
-
* @summary: Update theme
|
|
1982
|
-
* @description:
|
|
1981
|
+
* @summary: Update theme.
|
|
1982
|
+
* @description: Modify and update the content and settings of a theme - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/updateTheme/).
|
|
1983
1983
|
*/
|
|
1984
1984
|
async updateTheme(
|
|
1985
1985
|
{ themeId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2057,8 +2057,8 @@ class Theme {
|
|
|
2057
2057
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2058
2058
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
2059
2059
|
* @name updateThemeName
|
|
2060
|
-
* @summary: Update
|
|
2061
|
-
* @description:
|
|
2060
|
+
* @summary: Update theme name.
|
|
2061
|
+
* @description: Modify the name of a theme. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/updateThemeName/).
|
|
2062
2062
|
*/
|
|
2063
2063
|
async updateThemeName(
|
|
2064
2064
|
{ themeId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2138,8 +2138,8 @@ class Theme {
|
|
|
2138
2138
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2139
2139
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
2140
2140
|
* @name upgradeTheme
|
|
2141
|
-
* @summary: Upgrade
|
|
2142
|
-
* @description:
|
|
2141
|
+
* @summary: Upgrade theme.
|
|
2142
|
+
* @description: Enhance and update a theme to a new version. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/upgradeTheme/).
|
|
2143
2143
|
*/
|
|
2144
2144
|
async upgradeTheme(
|
|
2145
2145
|
{ themeId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -8,8 +8,8 @@ declare class Theme {
|
|
|
8
8
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
9
9
|
* @returns {Promise<ThemePlatformModel.CompanyThemeSchema>} - Success response
|
|
10
10
|
* @name addMarketplaceThemeToCompany
|
|
11
|
-
* @summary: Add
|
|
12
|
-
* @description:
|
|
11
|
+
* @summary: Add marketplace theme to company.
|
|
12
|
+
* @description: Incorporate a marketplace theme into a company's profile. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/addMarketplaceThemeToCompany/).
|
|
13
13
|
*/
|
|
14
14
|
addMarketplaceThemeToCompany({ body, requestHeaders }?: ThemePlatformValidator.AddMarketplaceThemeToCompanyParam, { responseHeaders }?: object): Promise<ThemePlatformModel.CompanyThemeSchema>;
|
|
15
15
|
/**
|
|
@@ -18,8 +18,8 @@ declare class Theme {
|
|
|
18
18
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
19
19
|
* @returns {Promise<ThemePlatformModel.CompanyThemeSchema>} - Success response
|
|
20
20
|
* @name deleteCompanyTheme
|
|
21
|
-
* @summary: Delete
|
|
22
|
-
* @description:
|
|
21
|
+
* @summary: Delete company theme.
|
|
22
|
+
* @description: Remove a theme associated with a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/deleteCompanyTheme/).
|
|
23
23
|
*/
|
|
24
24
|
deleteCompanyTheme({ themeId, requestHeaders }?: ThemePlatformValidator.DeleteCompanyThemeParam, { responseHeaders }?: object): Promise<ThemePlatformModel.CompanyThemeSchema>;
|
|
25
25
|
/**
|
|
@@ -38,8 +38,8 @@ declare class Theme {
|
|
|
38
38
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
39
39
|
* @returns {Promise<ThemePlatformModel.CompanyThemeSchema[]>} - Success response
|
|
40
40
|
* @name getCompanyLevelThemes
|
|
41
|
-
* @summary: Get themes
|
|
42
|
-
* @description: Retrieve
|
|
41
|
+
* @summary: Get company-level themes.
|
|
42
|
+
* @description: Retrieve themes specific to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getCompanyLevelThemes/).
|
|
43
43
|
*/
|
|
44
44
|
getCompanyLevelThemes({ searchText, requestHeaders }?: ThemePlatformValidator.GetCompanyLevelThemesParam, { responseHeaders }?: object): Promise<ThemePlatformModel.CompanyThemeSchema[]>;
|
|
45
45
|
}
|
|
@@ -20,8 +20,8 @@ class Theme {
|
|
|
20
20
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
21
21
|
* @returns {Promise<ThemePlatformModel.CompanyThemeSchema>} - Success response
|
|
22
22
|
* @name addMarketplaceThemeToCompany
|
|
23
|
-
* @summary: Add
|
|
24
|
-
* @description:
|
|
23
|
+
* @summary: Add marketplace theme to company.
|
|
24
|
+
* @description: Incorporate a marketplace theme into a company's profile. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/addMarketplaceThemeToCompany/).
|
|
25
25
|
*/
|
|
26
26
|
async addMarketplaceThemeToCompany(
|
|
27
27
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -101,8 +101,8 @@ class Theme {
|
|
|
101
101
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
102
102
|
* @returns {Promise<ThemePlatformModel.CompanyThemeSchema>} - Success response
|
|
103
103
|
* @name deleteCompanyTheme
|
|
104
|
-
* @summary: Delete
|
|
105
|
-
* @description:
|
|
104
|
+
* @summary: Delete company theme.
|
|
105
|
+
* @description: Remove a theme associated with a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/deleteCompanyTheme/).
|
|
106
106
|
*/
|
|
107
107
|
async deleteCompanyTheme(
|
|
108
108
|
{ themeId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -259,8 +259,8 @@ class Theme {
|
|
|
259
259
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
260
260
|
* @returns {Promise<ThemePlatformModel.CompanyThemeSchema[]>} - Success response
|
|
261
261
|
* @name getCompanyLevelThemes
|
|
262
|
-
* @summary: Get themes
|
|
263
|
-
* @description: Retrieve
|
|
262
|
+
* @summary: Get company-level themes.
|
|
263
|
+
* @description: Retrieve themes specific to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getCompanyLevelThemes/).
|
|
264
264
|
*/
|
|
265
265
|
async getCompanyLevelThemes(
|
|
266
266
|
{ searchText, requestHeaders } = { requestHeaders: {} },
|
|
@@ -19,8 +19,8 @@ declare class User {
|
|
|
19
19
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
20
20
|
* @returns {Promise<UserPlatformModel.BlockUserSuccess>} - Success response
|
|
21
21
|
* @name blockOrUnblockUsers
|
|
22
|
-
* @summary: Block/
|
|
23
|
-
* @description:
|
|
22
|
+
* @summary: Block/unblock users.
|
|
23
|
+
* @description: Control user access by blocking or unblocking their accounts. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/blockOrUnblockUsers/).
|
|
24
24
|
*/
|
|
25
25
|
blockOrUnblockUsers({ body, requestHeaders }?: UserPlatformApplicationValidator.BlockOrUnblockUsersParam, { responseHeaders }?: object): Promise<UserPlatformModel.BlockUserSuccess>;
|
|
26
26
|
/**
|
|
@@ -29,8 +29,8 @@ declare class User {
|
|
|
29
29
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
30
30
|
* @returns {Promise<UserPlatformModel.CreateUserResponseSchema>} - Success response
|
|
31
31
|
* @name createUser
|
|
32
|
-
* @summary: Create user
|
|
33
|
-
* @description:
|
|
32
|
+
* @summary: Create user.
|
|
33
|
+
* @description: Register and add a new user to the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/createUser/).
|
|
34
34
|
*/
|
|
35
35
|
createUser({ body, requestHeaders }?: UserPlatformApplicationValidator.CreateUserParam, { responseHeaders }?: object): Promise<UserPlatformModel.CreateUserResponseSchema>;
|
|
36
36
|
/**
|
|
@@ -52,8 +52,8 @@ declare class User {
|
|
|
52
52
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
53
53
|
* @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
|
|
54
54
|
* @name createUserGroup
|
|
55
|
-
* @summary: Create
|
|
56
|
-
* @description:
|
|
55
|
+
* @summary: Create user group.
|
|
56
|
+
* @description: Form and add a new user group. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/createUserGroup/).
|
|
57
57
|
*/
|
|
58
58
|
createUserGroup({ body, requestHeaders }?: UserPlatformApplicationValidator.CreateUserGroupParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserGroupResponseSchema>;
|
|
59
59
|
/**
|
|
@@ -63,8 +63,8 @@ declare class User {
|
|
|
63
63
|
* @returns {Promise<UserPlatformModel.CreateUserSessionResponseSchema>} -
|
|
64
64
|
* Success response
|
|
65
65
|
* @name createUserSession
|
|
66
|
-
* @summary: Create user session
|
|
67
|
-
* @description:
|
|
66
|
+
* @summary: Create user session.
|
|
67
|
+
* @description: Establish a session for user interactions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/createUserSession/).
|
|
68
68
|
*/
|
|
69
69
|
createUserSession({ body, requestHeaders }?: UserPlatformApplicationValidator.CreateUserSessionParam, { responseHeaders }?: object): Promise<UserPlatformModel.CreateUserSessionResponseSchema>;
|
|
70
70
|
/**
|
|
@@ -76,8 +76,8 @@ declare class User {
|
|
|
76
76
|
* @returns {Promise<UserPlatformModel.SessionsDeleteResponseSchema>} -
|
|
77
77
|
* Success response
|
|
78
78
|
* @name deleteActiveSessions
|
|
79
|
-
* @summary: Delete
|
|
80
|
-
* @description:
|
|
79
|
+
* @summary: Delete active sessions.
|
|
80
|
+
* @description: End multiple active user sessions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/deleteActiveSessions/).
|
|
81
81
|
*/
|
|
82
82
|
deleteActiveSessions({ id, reason, requestHeaders }?: UserPlatformApplicationValidator.DeleteActiveSessionsParam, { responseHeaders }?: object): Promise<UserPlatformModel.SessionsDeleteResponseSchema>;
|
|
83
83
|
/**
|
|
@@ -87,8 +87,8 @@ declare class User {
|
|
|
87
87
|
* @returns {Promise<UserPlatformModel.SessionDeleteResponseSchema>} -
|
|
88
88
|
* Success response
|
|
89
89
|
* @name deleteSession
|
|
90
|
-
* @summary: Delete
|
|
91
|
-
* @description:
|
|
90
|
+
* @summary: Delete session.
|
|
91
|
+
* @description: Terminate an active user session. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/deleteSession/).
|
|
92
92
|
*/
|
|
93
93
|
deleteSession({ id, sessionId, reason, requestHeaders }?: UserPlatformApplicationValidator.DeleteSessionParam, { responseHeaders }?: object): Promise<UserPlatformModel.SessionDeleteResponseSchema>;
|
|
94
94
|
/**
|
|
@@ -119,8 +119,8 @@ declare class User {
|
|
|
119
119
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
120
120
|
* @returns {Promise<UserPlatformModel.SessionListResponseSchema>} - Success response
|
|
121
121
|
* @name getActiveSessions
|
|
122
|
-
* @summary: Get
|
|
123
|
-
* @description:
|
|
122
|
+
* @summary: Get active sessions.
|
|
123
|
+
* @description: Retrieve a list of currently active user sessions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getActiveSessions/).
|
|
124
124
|
*/
|
|
125
125
|
getActiveSessions({ id, requestHeaders }?: UserPlatformApplicationValidator.GetActiveSessionsParam, { responseHeaders }?: object): Promise<UserPlatformModel.SessionListResponseSchema>;
|
|
126
126
|
/**
|
|
@@ -129,8 +129,8 @@ declare class User {
|
|
|
129
129
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
130
130
|
* @returns {Promise<UserPlatformModel.CustomerListResponseSchema>} - Success response
|
|
131
131
|
* @name getCustomers
|
|
132
|
-
* @summary: Get
|
|
133
|
-
* @description:
|
|
132
|
+
* @summary: Get customers.
|
|
133
|
+
* @description: Retrieve a list of customer profiles. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getCustomers/).
|
|
134
134
|
*/
|
|
135
135
|
getCustomers({ q, pageSize, pageNo, requestHeaders }?: UserPlatformApplicationValidator.GetCustomersParam, { responseHeaders }?: object): Promise<UserPlatformModel.CustomerListResponseSchema>;
|
|
136
136
|
/**
|
|
@@ -139,8 +139,8 @@ declare class User {
|
|
|
139
139
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
140
140
|
* @returns {Promise<UserPlatformModel.PlatformSchema>} - Success response
|
|
141
141
|
* @name getPlatformConfig
|
|
142
|
-
* @summary: Get platform
|
|
143
|
-
* @description:
|
|
142
|
+
* @summary: Get platform config.
|
|
143
|
+
* @description: Retrieve configuration settings for the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getPlatformConfig/).
|
|
144
144
|
*/
|
|
145
145
|
getPlatformConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<UserPlatformModel.PlatformSchema>;
|
|
146
146
|
/**
|
|
@@ -207,8 +207,8 @@ declare class User {
|
|
|
207
207
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
208
208
|
* @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
|
|
209
209
|
* @name getUserGroupById
|
|
210
|
-
* @summary: Get
|
|
211
|
-
* @description:
|
|
210
|
+
* @summary: Get user group by ID.
|
|
211
|
+
* @description: Retrieve a user group by its unique identifier. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserGroupById/).
|
|
212
212
|
*/
|
|
213
213
|
getUserGroupById({ groupId, requestHeaders }?: UserPlatformApplicationValidator.GetUserGroupByIdParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserGroupResponseSchema>;
|
|
214
214
|
/**
|
|
@@ -218,8 +218,8 @@ declare class User {
|
|
|
218
218
|
* @returns {Promise<UserPlatformModel.UserGroupListResponseSchema>} -
|
|
219
219
|
* Success response
|
|
220
220
|
* @name getUserGroups
|
|
221
|
-
* @summary: Get
|
|
222
|
-
* @description:
|
|
221
|
+
* @summary: Get user groups.
|
|
222
|
+
* @description: Retrieve a list of user groups. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserGroups/).
|
|
223
223
|
*/
|
|
224
224
|
getUserGroups({ pageNo, pageSize, name, type, status, groupUid, requestHeaders }?: UserPlatformApplicationValidator.GetUserGroupsParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserGroupListResponseSchema>;
|
|
225
225
|
/**
|
|
@@ -228,8 +228,8 @@ declare class User {
|
|
|
228
228
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
229
229
|
* @returns {Promise<UserPlatformModel.UserSearchResponseSchema>} - Success response
|
|
230
230
|
* @name searchUsers
|
|
231
|
-
* @summary: Search
|
|
232
|
-
* @description:
|
|
231
|
+
* @summary: Search users.
|
|
232
|
+
* @description: Search and filter user profiles. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/searchUsers/).
|
|
233
233
|
*/
|
|
234
234
|
searchUsers({ q, query, requestHeaders }?: UserPlatformApplicationValidator.SearchUsersParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserSearchResponseSchema>;
|
|
235
235
|
/**
|
|
@@ -238,8 +238,8 @@ declare class User {
|
|
|
238
238
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
239
239
|
* @returns {Promise<UserPlatformModel.UnDeleteUserSuccess>} - Success response
|
|
240
240
|
* @name unDeleteUser
|
|
241
|
-
* @summary:
|
|
242
|
-
* @description:
|
|
241
|
+
* @summary: Undelete user.
|
|
242
|
+
* @description: Restore a previously deleted user account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/unDeleteUser/).
|
|
243
243
|
*/
|
|
244
244
|
unDeleteUser({ body, requestHeaders }?: UserPlatformApplicationValidator.UnDeleteUserParam, { responseHeaders }?: object): Promise<UserPlatformModel.UnDeleteUserSuccess>;
|
|
245
245
|
/**
|
|
@@ -250,8 +250,8 @@ declare class User {
|
|
|
250
250
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
251
251
|
* @returns {Promise<UserPlatformModel.PlatformSchema>} - Success response
|
|
252
252
|
* @name updatePlatformConfig
|
|
253
|
-
* @summary: Update platform
|
|
254
|
-
* @description:
|
|
253
|
+
* @summary: Update platform config.
|
|
254
|
+
* @description: Modify and update platform configuration settings. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updatePlatformConfig/).
|
|
255
255
|
*/
|
|
256
256
|
updatePlatformConfig({ body, requestHeaders }?: UserPlatformApplicationValidator.UpdatePlatformConfigParam, { responseHeaders }?: object): Promise<UserPlatformModel.PlatformSchema>;
|
|
257
257
|
/**
|
|
@@ -260,8 +260,8 @@ declare class User {
|
|
|
260
260
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
261
261
|
* @returns {Promise<UserPlatformModel.CreateUserResponseSchema>} - Success response
|
|
262
262
|
* @name updateUser
|
|
263
|
-
* @summary: Update user
|
|
264
|
-
* @description:
|
|
263
|
+
* @summary: Update user.
|
|
264
|
+
* @description: Modify and update user profile information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updateUser/).
|
|
265
265
|
*/
|
|
266
266
|
updateUser({ userId, body, requestHeaders }?: UserPlatformApplicationValidator.UpdateUserParam, { responseHeaders }?: object): Promise<UserPlatformModel.CreateUserResponseSchema>;
|
|
267
267
|
/**
|
|
@@ -292,8 +292,8 @@ declare class User {
|
|
|
292
292
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
293
293
|
* @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
|
|
294
294
|
* @name updateUserGroup
|
|
295
|
-
* @summary: Update
|
|
296
|
-
* @description:
|
|
295
|
+
* @summary: Update user group.
|
|
296
|
+
* @description: Modify and update user group details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updateUserGroup/).
|
|
297
297
|
*/
|
|
298
298
|
updateUserGroup({ groupId, body, requestHeaders }?: UserPlatformApplicationValidator.UpdateUserGroupParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserGroupResponseSchema>;
|
|
299
299
|
/**
|
|
@@ -305,7 +305,7 @@ declare class User {
|
|
|
305
305
|
* @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
|
|
306
306
|
* @name updateUserGroupPartially
|
|
307
307
|
* @summary: Add or Remove an user from particular user group and update user group details
|
|
308
|
-
* @description:
|
|
308
|
+
* @description: Update user group partially on the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updateUserGroupPartially/).
|
|
309
309
|
*/
|
|
310
310
|
updateUserGroupPartially({ groupId, body, requestHeaders }?: UserPlatformApplicationValidator.UpdateUserGroupPartiallyParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserGroupResponseSchema>;
|
|
311
311
|
}
|