@gofynd/fdk-client-javascript 1.4.3 → 1.4.5
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 -10
- package/package.json +1 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +48 -48
- package/sdk/application/Cart/CartApplicationClient.js +48 -48
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +69 -69
- package/sdk/application/Catalog/CatalogApplicationClient.js +69 -69
- 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 -32
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +32 -32
- package/sdk/application/Content/ContentApplicationClient.d.ts +45 -45
- package/sdk/application/Content/ContentApplicationClient.js +45 -45
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +5 -5
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +5 -5
- package/sdk/application/Lead/LeadApplicationClient.d.ts +9 -9
- package/sdk/application/Lead/LeadApplicationClient.js +9 -9
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +22 -22
- package/sdk/application/Logistic/LogisticApplicationClient.js +22 -22
- package/sdk/application/Order/OrderApplicationClient.d.ts +14 -25
- package/sdk/application/Order/OrderApplicationClient.js +14 -94
- package/sdk/application/Order/OrderApplicationValidator.d.ts +1 -15
- package/sdk/application/Order/OrderApplicationValidator.js +0 -13
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +71 -71
- package/sdk/application/Payment/PaymentApplicationClient.js +71 -71
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +1 -1
- package/sdk/application/Rewards/RewardsApplicationClient.js +1 -1
- package/sdk/application/Share/ShareApplicationClient.d.ts +1 -1
- package/sdk/application/Share/ShareApplicationClient.js +1 -1
- package/sdk/application/Share/ShareApplicationModel.d.ts +2 -0
- package/sdk/application/Share/ShareApplicationModel.js +2 -0
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
- package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
- package/sdk/application/User/UserApplicationClient.d.ts +74 -74
- package/sdk/application/User/UserApplicationClient.js +74 -74
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +5 -5
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +5 -5
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +13 -13
- package/sdk/platform/Billing/BillingPlatformClient.js +13 -13
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +102 -102
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +102 -102
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +132 -131
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +132 -131
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +130 -130
- package/sdk/platform/Catalog/CatalogPlatformClient.js +130 -130
- package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -2
- package/sdk/platform/Common/CommonPlatformClient.js +2 -2
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +118 -118
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +118 -118
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +22 -22
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +22 -22
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +34 -7
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +35 -5
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +4 -4
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +4 -4
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +41 -41
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +41 -41
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +26 -26
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +26 -26
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +93 -93
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +93 -93
- package/sdk/platform/Content/ContentPlatformClient.d.ts +29 -29
- package/sdk/platform/Content/ContentPlatformClient.js +29 -29
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +18 -18
- package/sdk/platform/Discount/DiscountPlatformClient.js +18 -18
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +18 -17
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +18 -17
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +2 -2
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +4 -4
- package/sdk/platform/Finance/FinancePlatformClient.js +4 -4
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +12 -12
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +15 -15
- package/sdk/platform/Lead/LeadPlatformClient.js +15 -15
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +10 -10
- package/sdk/platform/Order/OrderPlatformClient.d.ts +95 -106
- package/sdk/platform/Order/OrderPlatformClient.js +95 -190
- package/sdk/platform/Order/OrderPlatformModel.d.ts +10 -0
- package/sdk/platform/Order/OrderPlatformModel.js +4 -0
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +1 -33
- package/sdk/platform/Order/OrderPlatformValidator.js +0 -20
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -4
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +77 -77
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +77 -77
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +2 -2
- package/sdk/platform/Payment/PaymentPlatformClient.js +2 -2
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +7 -0
- package/sdk/platform/Payment/PaymentPlatformModel.js +3 -0
- package/sdk/platform/PlatformClient.d.ts +0 -2
- package/sdk/platform/PlatformClient.js +0 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +7 -7
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +7 -7
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +40 -40
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +40 -40
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +51 -50
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +51 -50
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Share/SharePlatformApplicationClient.js +1 -1
- package/sdk/platform/Share/SharePlatformModel.d.ts +2 -0
- package/sdk/platform/Share/SharePlatformModel.js +2 -0
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +34 -104
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +34 -591
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +1 -100
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +0 -92
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +6 -6
- package/sdk/platform/Theme/ThemePlatformClient.js +6 -6
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +35 -35
- package/sdk/platform/User/UserPlatformApplicationClient.js +35 -35
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +7 -6
- package/sdk/platform/Webhook/WebhookPlatformClient.js +7 -6
- package/sdk/platform/index.d.ts +0 -1
- package/sdk/platform/index.js +0 -2
- package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +0 -152
- package/sdk/platform/Inventory/InventoryPlatformClient.js +0 -1017
- package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +0 -1355
- package/sdk/platform/Inventory/InventoryPlatformModel.js +0 -1544
- package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +0 -171
- package/sdk/platform/Inventory/InventoryPlatformValidator.js +0 -159
|
@@ -3,18 +3,10 @@ export = ThemePlatformApplicationValidator;
|
|
|
3
3
|
* @typedef AddThemeToApplicationParam
|
|
4
4
|
* @property {ThemePlatformModel.ThemeReq} body
|
|
5
5
|
*/
|
|
6
|
-
/**
|
|
7
|
-
* @typedef AddToThemeLibraryParam
|
|
8
|
-
* @property {ThemePlatformModel.AddThemeRequestSchema} body
|
|
9
|
-
*/
|
|
10
6
|
/**
|
|
11
7
|
* @typedef ApplyThemeParam
|
|
12
8
|
* @property {string} themeId - The ID of the apply
|
|
13
9
|
*/
|
|
14
|
-
/**
|
|
15
|
-
* @typedef ArchiveThemeParam
|
|
16
|
-
* @property {string} themeId - ID allotted to the theme.
|
|
17
|
-
*/
|
|
18
10
|
/**
|
|
19
11
|
* @typedef CreatePageParam
|
|
20
12
|
* @property {string} themeId - ID of the theme
|
|
@@ -46,13 +38,6 @@ export = ThemePlatformApplicationValidator;
|
|
|
46
38
|
* @property {string} themeId - ID of the theme to be retrieved
|
|
47
39
|
* @property {string} pageValue - Value of the page to be retrieved
|
|
48
40
|
*/
|
|
49
|
-
/**
|
|
50
|
-
* @typedef GetPublicThemesParam
|
|
51
|
-
* @property {number} [pageSize] - The number of items to retrieve in each page.
|
|
52
|
-
* Default value is 10.
|
|
53
|
-
* @property {number} [pageNo] - The page number to navigate through the given
|
|
54
|
-
* set of results. Default value is 1.
|
|
55
|
-
*/
|
|
56
41
|
/**
|
|
57
42
|
* @typedef GetThemeByIdParam
|
|
58
43
|
* @property {string} themeId - The ID of the theme
|
|
@@ -65,29 +50,10 @@ export = ThemePlatformApplicationValidator;
|
|
|
65
50
|
* @typedef GetThemeLastModifiedParam
|
|
66
51
|
* @property {string} themeId - ID allotted to the theme.
|
|
67
52
|
*/
|
|
68
|
-
/**
|
|
69
|
-
* @typedef GetThemeLibraryParam
|
|
70
|
-
* @property {number} [pageSize] - The number of items to retrieve in each page.
|
|
71
|
-
* Default value is 10.
|
|
72
|
-
* @property {number} [pageNo] - The page number to navigate through the given
|
|
73
|
-
* set of results. Default value is 1.
|
|
74
|
-
*/
|
|
75
53
|
/**
|
|
76
54
|
* @typedef IsUpgradableParam
|
|
77
55
|
* @property {string} themeId - The ID of the theme
|
|
78
56
|
*/
|
|
79
|
-
/**
|
|
80
|
-
* @typedef PublishThemeParam
|
|
81
|
-
* @property {string} themeId - ID allotted to the theme.
|
|
82
|
-
*/
|
|
83
|
-
/**
|
|
84
|
-
* @typedef UnarchiveThemeParam
|
|
85
|
-
* @property {string} themeId - ID allotted to the theme.
|
|
86
|
-
*/
|
|
87
|
-
/**
|
|
88
|
-
* @typedef UnpublishThemeParam
|
|
89
|
-
* @property {string} themeId - ID allotted to the theme.
|
|
90
|
-
*/
|
|
91
57
|
/**
|
|
92
58
|
* @typedef UpdateMultiplePagesParam
|
|
93
59
|
* @property {string} themeId - ID of the theme to be retrieved
|
|
@@ -116,12 +82,8 @@ export = ThemePlatformApplicationValidator;
|
|
|
116
82
|
declare class ThemePlatformApplicationValidator {
|
|
117
83
|
/** @returns {AddThemeToApplicationParam} */
|
|
118
84
|
static addThemeToApplication(): AddThemeToApplicationParam;
|
|
119
|
-
/** @returns {AddToThemeLibraryParam} */
|
|
120
|
-
static addToThemeLibrary(): AddToThemeLibraryParam;
|
|
121
85
|
/** @returns {ApplyThemeParam} */
|
|
122
86
|
static applyTheme(): ApplyThemeParam;
|
|
123
|
-
/** @returns {ArchiveThemeParam} */
|
|
124
|
-
static archiveTheme(): ArchiveThemeParam;
|
|
125
87
|
/** @returns {CreatePageParam} */
|
|
126
88
|
static createPage(): CreatePageParam;
|
|
127
89
|
/** @returns {DeletePageParam} */
|
|
@@ -142,24 +104,14 @@ declare class ThemePlatformApplicationValidator {
|
|
|
142
104
|
static getFonts(): any;
|
|
143
105
|
/** @returns {GetPageParam} */
|
|
144
106
|
static getPage(): GetPageParam;
|
|
145
|
-
/** @returns {GetPublicThemesParam} */
|
|
146
|
-
static getPublicThemes(): GetPublicThemesParam;
|
|
147
107
|
/** @returns {GetThemeByIdParam} */
|
|
148
108
|
static getThemeById(): GetThemeByIdParam;
|
|
149
109
|
/** @returns {GetThemeForPreviewParam} */
|
|
150
110
|
static getThemeForPreview(): GetThemeForPreviewParam;
|
|
151
111
|
/** @returns {GetThemeLastModifiedParam} */
|
|
152
112
|
static getThemeLastModified(): GetThemeLastModifiedParam;
|
|
153
|
-
/** @returns {GetThemeLibraryParam} */
|
|
154
|
-
static getThemeLibrary(): GetThemeLibraryParam;
|
|
155
113
|
/** @returns {IsUpgradableParam} */
|
|
156
114
|
static isUpgradable(): IsUpgradableParam;
|
|
157
|
-
/** @returns {PublishThemeParam} */
|
|
158
|
-
static publishTheme(): PublishThemeParam;
|
|
159
|
-
/** @returns {UnarchiveThemeParam} */
|
|
160
|
-
static unarchiveTheme(): UnarchiveThemeParam;
|
|
161
|
-
/** @returns {UnpublishThemeParam} */
|
|
162
|
-
static unpublishTheme(): UnpublishThemeParam;
|
|
163
115
|
/** @returns {UpdateMultiplePagesParam} */
|
|
164
116
|
static updateMultiplePages(): UpdateMultiplePagesParam;
|
|
165
117
|
/** @returns {UpdatePageParam} */
|
|
@@ -172,26 +124,17 @@ declare class ThemePlatformApplicationValidator {
|
|
|
172
124
|
static upgradeTheme(): UpgradeThemeParam;
|
|
173
125
|
}
|
|
174
126
|
declare namespace ThemePlatformApplicationValidator {
|
|
175
|
-
export { AddThemeToApplicationParam,
|
|
127
|
+
export { AddThemeToApplicationParam, ApplyThemeParam, CreatePageParam, DeletePageParam, DeleteThemeParam, DuplicateThemeParam, GetAllPagesParam, GetApplicationThemesParam, GetApplicationThemesCountParam, GetAppliedThemeParam, GetFontsParam, GetPageParam, GetThemeByIdParam, GetThemeForPreviewParam, GetThemeLastModifiedParam, IsUpgradableParam, UpdateMultiplePagesParam, UpdatePageParam, UpdateThemeParam, UpdateThemeNameParam, UpgradeThemeParam };
|
|
176
128
|
}
|
|
177
129
|
type AddThemeToApplicationParam = {
|
|
178
130
|
body: ThemePlatformModel.ThemeReq;
|
|
179
131
|
};
|
|
180
|
-
type AddToThemeLibraryParam = {
|
|
181
|
-
body: ThemePlatformModel.AddThemeRequestSchema;
|
|
182
|
-
};
|
|
183
132
|
type ApplyThemeParam = {
|
|
184
133
|
/**
|
|
185
134
|
* - The ID of the apply
|
|
186
135
|
*/
|
|
187
136
|
themeId: string;
|
|
188
137
|
};
|
|
189
|
-
type ArchiveThemeParam = {
|
|
190
|
-
/**
|
|
191
|
-
* - ID allotted to the theme.
|
|
192
|
-
*/
|
|
193
|
-
themeId: string;
|
|
194
|
-
};
|
|
195
138
|
type CreatePageParam = {
|
|
196
139
|
/**
|
|
197
140
|
* - ID of the theme
|
|
@@ -237,18 +180,6 @@ type GetPageParam = {
|
|
|
237
180
|
*/
|
|
238
181
|
pageValue: string;
|
|
239
182
|
};
|
|
240
|
-
type GetPublicThemesParam = {
|
|
241
|
-
/**
|
|
242
|
-
* - The number of items to retrieve in each page.
|
|
243
|
-
* Default value is 10.
|
|
244
|
-
*/
|
|
245
|
-
pageSize?: number;
|
|
246
|
-
/**
|
|
247
|
-
* - The page number to navigate through the given
|
|
248
|
-
* set of results. Default value is 1.
|
|
249
|
-
*/
|
|
250
|
-
pageNo?: number;
|
|
251
|
-
};
|
|
252
183
|
type GetThemeByIdParam = {
|
|
253
184
|
/**
|
|
254
185
|
* - The ID of the theme
|
|
@@ -267,42 +198,12 @@ type GetThemeLastModifiedParam = {
|
|
|
267
198
|
*/
|
|
268
199
|
themeId: string;
|
|
269
200
|
};
|
|
270
|
-
type GetThemeLibraryParam = {
|
|
271
|
-
/**
|
|
272
|
-
* - The number of items to retrieve in each page.
|
|
273
|
-
* Default value is 10.
|
|
274
|
-
*/
|
|
275
|
-
pageSize?: number;
|
|
276
|
-
/**
|
|
277
|
-
* - The page number to navigate through the given
|
|
278
|
-
* set of results. Default value is 1.
|
|
279
|
-
*/
|
|
280
|
-
pageNo?: number;
|
|
281
|
-
};
|
|
282
201
|
type IsUpgradableParam = {
|
|
283
202
|
/**
|
|
284
203
|
* - The ID of the theme
|
|
285
204
|
*/
|
|
286
205
|
themeId: string;
|
|
287
206
|
};
|
|
288
|
-
type PublishThemeParam = {
|
|
289
|
-
/**
|
|
290
|
-
* - ID allotted to the theme.
|
|
291
|
-
*/
|
|
292
|
-
themeId: string;
|
|
293
|
-
};
|
|
294
|
-
type UnarchiveThemeParam = {
|
|
295
|
-
/**
|
|
296
|
-
* - ID allotted to the theme.
|
|
297
|
-
*/
|
|
298
|
-
themeId: string;
|
|
299
|
-
};
|
|
300
|
-
type UnpublishThemeParam = {
|
|
301
|
-
/**
|
|
302
|
-
* - ID allotted to the theme.
|
|
303
|
-
*/
|
|
304
|
-
themeId: string;
|
|
305
|
-
};
|
|
306
207
|
type UpdateMultiplePagesParam = {
|
|
307
208
|
/**
|
|
308
209
|
* - ID of the theme to be retrieved
|
|
@@ -7,21 +7,11 @@ const ThemePlatformModel = require("./ThemePlatformModel");
|
|
|
7
7
|
* @property {ThemePlatformModel.ThemeReq} body
|
|
8
8
|
*/
|
|
9
9
|
|
|
10
|
-
/**
|
|
11
|
-
* @typedef AddToThemeLibraryParam
|
|
12
|
-
* @property {ThemePlatformModel.AddThemeRequestSchema} body
|
|
13
|
-
*/
|
|
14
|
-
|
|
15
10
|
/**
|
|
16
11
|
* @typedef ApplyThemeParam
|
|
17
12
|
* @property {string} themeId - The ID of the apply
|
|
18
13
|
*/
|
|
19
14
|
|
|
20
|
-
/**
|
|
21
|
-
* @typedef ArchiveThemeParam
|
|
22
|
-
* @property {string} themeId - ID allotted to the theme.
|
|
23
|
-
*/
|
|
24
|
-
|
|
25
15
|
/**
|
|
26
16
|
* @typedef CreatePageParam
|
|
27
17
|
* @property {string} themeId - ID of the theme
|
|
@@ -63,14 +53,6 @@ const ThemePlatformModel = require("./ThemePlatformModel");
|
|
|
63
53
|
* @property {string} pageValue - Value of the page to be retrieved
|
|
64
54
|
*/
|
|
65
55
|
|
|
66
|
-
/**
|
|
67
|
-
* @typedef GetPublicThemesParam
|
|
68
|
-
* @property {number} [pageSize] - The number of items to retrieve in each page.
|
|
69
|
-
* Default value is 10.
|
|
70
|
-
* @property {number} [pageNo] - The page number to navigate through the given
|
|
71
|
-
* set of results. Default value is 1.
|
|
72
|
-
*/
|
|
73
|
-
|
|
74
56
|
/**
|
|
75
57
|
* @typedef GetThemeByIdParam
|
|
76
58
|
* @property {string} themeId - The ID of the theme
|
|
@@ -86,34 +68,11 @@ const ThemePlatformModel = require("./ThemePlatformModel");
|
|
|
86
68
|
* @property {string} themeId - ID allotted to the theme.
|
|
87
69
|
*/
|
|
88
70
|
|
|
89
|
-
/**
|
|
90
|
-
* @typedef GetThemeLibraryParam
|
|
91
|
-
* @property {number} [pageSize] - The number of items to retrieve in each page.
|
|
92
|
-
* Default value is 10.
|
|
93
|
-
* @property {number} [pageNo] - The page number to navigate through the given
|
|
94
|
-
* set of results. Default value is 1.
|
|
95
|
-
*/
|
|
96
|
-
|
|
97
71
|
/**
|
|
98
72
|
* @typedef IsUpgradableParam
|
|
99
73
|
* @property {string} themeId - The ID of the theme
|
|
100
74
|
*/
|
|
101
75
|
|
|
102
|
-
/**
|
|
103
|
-
* @typedef PublishThemeParam
|
|
104
|
-
* @property {string} themeId - ID allotted to the theme.
|
|
105
|
-
*/
|
|
106
|
-
|
|
107
|
-
/**
|
|
108
|
-
* @typedef UnarchiveThemeParam
|
|
109
|
-
* @property {string} themeId - ID allotted to the theme.
|
|
110
|
-
*/
|
|
111
|
-
|
|
112
|
-
/**
|
|
113
|
-
* @typedef UnpublishThemeParam
|
|
114
|
-
* @property {string} themeId - ID allotted to the theme.
|
|
115
|
-
*/
|
|
116
|
-
|
|
117
76
|
/**
|
|
118
77
|
* @typedef UpdateMultiplePagesParam
|
|
119
78
|
* @property {string} themeId - ID of the theme to be retrieved
|
|
@@ -152,13 +111,6 @@ class ThemePlatformApplicationValidator {
|
|
|
152
111
|
}).required();
|
|
153
112
|
}
|
|
154
113
|
|
|
155
|
-
/** @returns {AddToThemeLibraryParam} */
|
|
156
|
-
static addToThemeLibrary() {
|
|
157
|
-
return Joi.object({
|
|
158
|
-
body: ThemePlatformModel.AddThemeRequestSchema().required(),
|
|
159
|
-
}).required();
|
|
160
|
-
}
|
|
161
|
-
|
|
162
114
|
/** @returns {ApplyThemeParam} */
|
|
163
115
|
static applyTheme() {
|
|
164
116
|
return Joi.object({
|
|
@@ -166,13 +118,6 @@ class ThemePlatformApplicationValidator {
|
|
|
166
118
|
}).required();
|
|
167
119
|
}
|
|
168
120
|
|
|
169
|
-
/** @returns {ArchiveThemeParam} */
|
|
170
|
-
static archiveTheme() {
|
|
171
|
-
return Joi.object({
|
|
172
|
-
themeId: Joi.string().allow("").required(),
|
|
173
|
-
}).required();
|
|
174
|
-
}
|
|
175
|
-
|
|
176
121
|
/** @returns {CreatePageParam} */
|
|
177
122
|
static createPage() {
|
|
178
123
|
return Joi.object({
|
|
@@ -238,14 +183,6 @@ class ThemePlatformApplicationValidator {
|
|
|
238
183
|
}).required();
|
|
239
184
|
}
|
|
240
185
|
|
|
241
|
-
/** @returns {GetPublicThemesParam} */
|
|
242
|
-
static getPublicThemes() {
|
|
243
|
-
return Joi.object({
|
|
244
|
-
pageSize: Joi.number(),
|
|
245
|
-
pageNo: Joi.number(),
|
|
246
|
-
}).required();
|
|
247
|
-
}
|
|
248
|
-
|
|
249
186
|
/** @returns {GetThemeByIdParam} */
|
|
250
187
|
static getThemeById() {
|
|
251
188
|
return Joi.object({
|
|
@@ -267,14 +204,6 @@ class ThemePlatformApplicationValidator {
|
|
|
267
204
|
}).required();
|
|
268
205
|
}
|
|
269
206
|
|
|
270
|
-
/** @returns {GetThemeLibraryParam} */
|
|
271
|
-
static getThemeLibrary() {
|
|
272
|
-
return Joi.object({
|
|
273
|
-
pageSize: Joi.number(),
|
|
274
|
-
pageNo: Joi.number(),
|
|
275
|
-
}).required();
|
|
276
|
-
}
|
|
277
|
-
|
|
278
207
|
/** @returns {IsUpgradableParam} */
|
|
279
208
|
static isUpgradable() {
|
|
280
209
|
return Joi.object({
|
|
@@ -282,27 +211,6 @@ class ThemePlatformApplicationValidator {
|
|
|
282
211
|
}).required();
|
|
283
212
|
}
|
|
284
213
|
|
|
285
|
-
/** @returns {PublishThemeParam} */
|
|
286
|
-
static publishTheme() {
|
|
287
|
-
return Joi.object({
|
|
288
|
-
themeId: Joi.string().allow("").required(),
|
|
289
|
-
}).required();
|
|
290
|
-
}
|
|
291
|
-
|
|
292
|
-
/** @returns {UnarchiveThemeParam} */
|
|
293
|
-
static unarchiveTheme() {
|
|
294
|
-
return Joi.object({
|
|
295
|
-
themeId: Joi.string().allow("").required(),
|
|
296
|
-
}).required();
|
|
297
|
-
}
|
|
298
|
-
|
|
299
|
-
/** @returns {UnpublishThemeParam} */
|
|
300
|
-
static unpublishTheme() {
|
|
301
|
-
return Joi.object({
|
|
302
|
-
themeId: Joi.string().allow("").required(),
|
|
303
|
-
}).required();
|
|
304
|
-
}
|
|
305
|
-
|
|
306
214
|
/** @returns {UpdateMultiplePagesParam} */
|
|
307
215
|
static updateMultiplePages() {
|
|
308
216
|
return Joi.object({
|
|
@@ -8,7 +8,7 @@ declare class Theme {
|
|
|
8
8
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
9
9
|
* @returns {Promise<ThemePlatformModel.CompanyThemeSchema>} - Success response
|
|
10
10
|
* @name addMarketplaceThemeToCompany
|
|
11
|
-
* @summary:
|
|
11
|
+
* @summary: Create a company theme
|
|
12
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>;
|
|
@@ -18,7 +18,7 @@ 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 company theme
|
|
21
|
+
* @summary: Delete a company theme
|
|
22
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>;
|
|
@@ -28,8 +28,8 @@ declare class Theme {
|
|
|
28
28
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
29
29
|
* @returns {Promise<ThemePlatformModel.CompanyPrivateTheme[]>} - Success response
|
|
30
30
|
* @name getCompanyLevelPrivateThemes
|
|
31
|
-
* @summary:
|
|
32
|
-
* @description: Retrieve a list of private themes
|
|
31
|
+
* @summary: List private company themes
|
|
32
|
+
* @description: Retrieve a list of private themes added to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getCompanyLevelPrivateThemes/).
|
|
33
33
|
*/
|
|
34
34
|
getCompanyLevelPrivateThemes({ searchText, requestHeaders }?: ThemePlatformValidator.GetCompanyLevelPrivateThemesParam, { responseHeaders }?: object): Promise<ThemePlatformModel.CompanyPrivateTheme[]>;
|
|
35
35
|
/**
|
|
@@ -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:
|
|
42
|
-
* @description: Retrieve themes
|
|
41
|
+
* @summary: List company themes
|
|
42
|
+
* @description: Retrieve themes added 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,7 +20,7 @@ class Theme {
|
|
|
20
20
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
21
21
|
* @returns {Promise<ThemePlatformModel.CompanyThemeSchema>} - Success response
|
|
22
22
|
* @name addMarketplaceThemeToCompany
|
|
23
|
-
* @summary:
|
|
23
|
+
* @summary: Create a company theme
|
|
24
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(
|
|
@@ -101,7 +101,7 @@ class Theme {
|
|
|
101
101
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
102
102
|
* @returns {Promise<ThemePlatformModel.CompanyThemeSchema>} - Success response
|
|
103
103
|
* @name deleteCompanyTheme
|
|
104
|
-
* @summary: Delete company theme
|
|
104
|
+
* @summary: Delete a company theme
|
|
105
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(
|
|
@@ -180,8 +180,8 @@ class Theme {
|
|
|
180
180
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
181
181
|
* @returns {Promise<ThemePlatformModel.CompanyPrivateTheme[]>} - Success response
|
|
182
182
|
* @name getCompanyLevelPrivateThemes
|
|
183
|
-
* @summary:
|
|
184
|
-
* @description: Retrieve a list of private themes
|
|
183
|
+
* @summary: List private company themes
|
|
184
|
+
* @description: Retrieve a list of private themes added to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getCompanyLevelPrivateThemes/).
|
|
185
185
|
*/
|
|
186
186
|
async getCompanyLevelPrivateThemes(
|
|
187
187
|
{ searchText, 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:
|
|
263
|
-
* @description: Retrieve themes
|
|
262
|
+
* @summary: List company themes
|
|
263
|
+
* @description: Retrieve themes added 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: {} },
|
|
@@ -9,8 +9,8 @@ declare class User {
|
|
|
9
9
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
10
10
|
* @returns {Promise<UserPlatformModel.ArchiveUserSuccess>} - Success response
|
|
11
11
|
* @name archiveUser
|
|
12
|
-
* @summary:
|
|
13
|
-
* @description:
|
|
12
|
+
* @summary: Archive User
|
|
13
|
+
* @description: Delete user from sales channel, allowing re-registration with the same mobile/email for a new user account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/archiveUser/).
|
|
14
14
|
*/
|
|
15
15
|
archiveUser({ body, requestHeaders }?: UserPlatformApplicationValidator.ArchiveUserParam, { responseHeaders }?: object): Promise<UserPlatformModel.ArchiveUserSuccess>;
|
|
16
16
|
/**
|
|
@@ -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: Manage user access by blocking or unblocking their accounts, restricting login for blocked accounts and allowing login for unblocked accounts. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/blockOrUnblockUsers/).
|
|
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
|
|
33
|
-
* @description: Register and add a new user to the
|
|
32
|
+
* @summary: Create User
|
|
33
|
+
* @description: Register and add a new user to the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/createUser/).
|
|
34
34
|
*/
|
|
35
35
|
createUser({ body, requestHeaders }?: UserPlatformApplicationValidator.CreateUserParam, { responseHeaders }?: object): Promise<UserPlatformModel.CreateUserResponseSchema>;
|
|
36
36
|
/**
|
|
@@ -43,7 +43,7 @@ declare class User {
|
|
|
43
43
|
* Success response
|
|
44
44
|
* @name createUserAttributeDefinition
|
|
45
45
|
* @summary: Create a User Attribute Definition
|
|
46
|
-
* @description:
|
|
46
|
+
* @description: Create a new User Attribute Definition - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/createUserAttributeDefinition/).
|
|
47
47
|
*/
|
|
48
48
|
createUserAttributeDefinition({ body, requestHeaders }?: UserPlatformApplicationValidator.CreateUserAttributeDefinitionParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserAttributeDefinitionResponse>;
|
|
49
49
|
/**
|
|
@@ -52,7 +52,7 @@ 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
|
|
55
|
+
* @summary: Create User Group
|
|
56
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>;
|
|
@@ -63,8 +63,8 @@ declare class User {
|
|
|
63
63
|
* @returns {Promise<UserPlatformModel.CreateUserSessionResponseSchema>} -
|
|
64
64
|
* Success response
|
|
65
65
|
* @name createUserSession
|
|
66
|
-
* @summary: Create
|
|
67
|
-
* @description:
|
|
66
|
+
* @summary: Create User Session
|
|
67
|
+
* @description: Create 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 User Active Sessions
|
|
80
|
+
* @description: Terminate all 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,7 +87,7 @@ declare class User {
|
|
|
87
87
|
* @returns {Promise<UserPlatformModel.SessionDeleteResponseSchema>} -
|
|
88
88
|
* Success response
|
|
89
89
|
* @name deleteSession
|
|
90
|
-
* @summary: Delete
|
|
90
|
+
* @summary: Delete User Session
|
|
91
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>;
|
|
@@ -97,8 +97,8 @@ declare class User {
|
|
|
97
97
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
98
98
|
* @returns {Promise<UserPlatformModel.SuccessMessageResponse>} - Success response
|
|
99
99
|
* @name deleteUserAttribute
|
|
100
|
-
* @summary:
|
|
101
|
-
* @description:
|
|
100
|
+
* @summary: Delete User Attribute
|
|
101
|
+
* @description: Delete User Attribute - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/deleteUserAttribute/).
|
|
102
102
|
*/
|
|
103
103
|
deleteUserAttribute({ attributeDefId, userId, requestHeaders }?: UserPlatformApplicationValidator.DeleteUserAttributeParam, { responseHeaders }?: object): Promise<UserPlatformModel.SuccessMessageResponse>;
|
|
104
104
|
/**
|
|
@@ -119,7 +119,7 @@ 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
|
|
122
|
+
* @summary: Get User Active Sessions
|
|
123
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>;
|
|
@@ -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: Retrieve
|
|
132
|
+
* @summary: Get a List of Users
|
|
133
|
+
* @description: Retrieve details of users registered in the sales channel - 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
|
|
143
|
-
* @description: Retrieve
|
|
142
|
+
* @summary: Get Platform Config
|
|
143
|
+
* @description: Retrieve platform sales channel authentication configuration. - 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
|
/**
|
|
@@ -149,8 +149,8 @@ declare class User {
|
|
|
149
149
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
150
150
|
* @returns {Promise<UserPlatformModel.UserAttributeResponse>} - Success response
|
|
151
151
|
* @name getUserAttribute
|
|
152
|
-
* @summary:
|
|
153
|
-
* @description:
|
|
152
|
+
* @summary: Get User Attribute
|
|
153
|
+
* @description: Get User Attribute - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserAttribute/).
|
|
154
154
|
*/
|
|
155
155
|
getUserAttribute({ attributeDefId, userId, requestHeaders }?: UserPlatformApplicationValidator.GetUserAttributeParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserAttributeResponse>;
|
|
156
156
|
/**
|
|
@@ -162,7 +162,7 @@ declare class User {
|
|
|
162
162
|
* @returns {Promise<UserPlatformModel.UserAttributeResponse>} - Success response
|
|
163
163
|
* @name getUserAttributeById
|
|
164
164
|
* @summary: Get User Attribute
|
|
165
|
-
* @description:
|
|
165
|
+
* @description: Retrieve User Attribute details by ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserAttributeById/).
|
|
166
166
|
*/
|
|
167
167
|
getUserAttributeById({ attributeId, requestHeaders }?: UserPlatformApplicationValidator.GetUserAttributeByIdParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserAttributeResponse>;
|
|
168
168
|
/**
|
|
@@ -197,8 +197,8 @@ declare class User {
|
|
|
197
197
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
198
198
|
* @returns {Promise<Object>} - Success response
|
|
199
199
|
* @name getUserAttributesForUser
|
|
200
|
-
* @summary: Get
|
|
201
|
-
* @description:
|
|
200
|
+
* @summary: Get All Customer Attributes
|
|
201
|
+
* @description: Retrieve all user attributes for a specific user - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserAttributesForUser/).
|
|
202
202
|
*/
|
|
203
203
|
getUserAttributesForUser({ userId, pageSize, pageNo, requestHeaders }?: UserPlatformApplicationValidator.GetUserAttributesForUserParam, { responseHeaders }?: object): Promise<any>;
|
|
204
204
|
/**
|
|
@@ -207,7 +207,7 @@ 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
|
|
210
|
+
* @summary: Get User Group
|
|
211
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>;
|
|
@@ -218,7 +218,7 @@ declare class User {
|
|
|
218
218
|
* @returns {Promise<UserPlatformModel.UserGroupListResponseSchema>} -
|
|
219
219
|
* Success response
|
|
220
220
|
* @name getUserGroups
|
|
221
|
-
* @summary: Get
|
|
221
|
+
* @summary: Get User Groups
|
|
222
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>;
|
|
@@ -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: Search and filter
|
|
231
|
+
* @summary: Search an Existing Users
|
|
232
|
+
* @description: Search and filter users details registered in the sales channel - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/searchUsers/).
|
|
233
233
|
*/
|
|
234
234
|
searchUsers({ q, query, requestHeaders }?: UserPlatformApplicationValidator.SearchUsersParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserSearchResponseSchema>;
|
|
235
235
|
/**
|
|
@@ -238,7 +238,7 @@ declare class User {
|
|
|
238
238
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
239
239
|
* @returns {Promise<UserPlatformModel.UnDeleteUserSuccess>} - Success response
|
|
240
240
|
* @name unDeleteUser
|
|
241
|
-
* @summary:
|
|
241
|
+
* @summary: Restore Deleted User
|
|
242
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>;
|
|
@@ -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
|
|
254
|
-
* @description: Modify and update platform configuration
|
|
253
|
+
* @summary: Update Platform Config
|
|
254
|
+
* @description: Modify and update platform sales channel authentication configuration. - 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,7 +260,7 @@ 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
|
|
263
|
+
* @summary: Update User Details
|
|
264
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>;
|
|
@@ -292,7 +292,7 @@ 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
|
|
295
|
+
* @summary: Update User Group
|
|
296
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>;
|
|
@@ -304,7 +304,7 @@ declare class User {
|
|
|
304
304
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
305
305
|
* @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
|
|
306
306
|
* @name updateUserGroupPartially
|
|
307
|
-
* @summary:
|
|
307
|
+
* @summary: Modify User Group
|
|
308
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>;
|