@gofynd/fdk-client-javascript 1.3.3-beta.3 → 1.3.4-beta.1
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/CartApplicationModel.d.ts +4 -0
- package/sdk/application/Cart/CartApplicationModel.js +4 -0
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +6 -8
- package/sdk/application/Theme/ThemeApplicationModel.js +6 -8
- package/sdk/common/AxiosHelper.js +10 -0
- package/sdk/partner/PartnerConfig.js +3 -5
- package/sdk/platform/Cart/CartPlatformModel.d.ts +4 -0
- package/sdk/platform/Cart/CartPlatformModel.js +4 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +56 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +308 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +27 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +38 -0
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +1 -1
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1 -1
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +344 -66
- package/sdk/platform/Catalog/CatalogPlatformModel.js +247 -65
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +26 -0
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +152 -0
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +14 -1
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +19 -0
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +22 -1
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +24 -0
- package/sdk/platform/Order/OrderPlatformModel.d.ts +4 -4
- package/sdk/platform/Order/OrderPlatformModel.js +4 -4
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +12 -0
- package/sdk/platform/User/UserPlatformApplicationClient.js +79 -0
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +15 -1
- package/sdk/platform/User/UserPlatformApplicationValidator.js +14 -0
- package/sdk/platform/User/UserPlatformModel.d.ts +63 -1
- package/sdk/platform/User/UserPlatformModel.js +44 -0
|
@@ -235,6 +235,19 @@ declare class Configuration {
|
|
|
235
235
|
* @description: Fetch the details of the deployment stores (the selling locations where the application will be utilised for placing orders). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getOrderingStoreConfig/).
|
|
236
236
|
*/
|
|
237
237
|
getOrderingStoreConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.OrderingStoreConfig>;
|
|
238
|
+
/**
|
|
239
|
+
* @param {ConfigurationPlatformApplicationValidator.GetOrderingStoreCookieParam} arg
|
|
240
|
+
* - Arg object
|
|
241
|
+
*
|
|
242
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
243
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
244
|
+
* @returns {Promise<ConfigurationPlatformModel.SuccessMessageResponse>} -
|
|
245
|
+
* Success response
|
|
246
|
+
* @name getOrderingStoreCookie
|
|
247
|
+
* @summary: Get an Ordering Store signed cookie on selection of ordering store.
|
|
248
|
+
* @description: Use this API to get an Ordering Store signed cookie upon selecting an ordering store. This will be used by the cart service to verify a coupon against the selected ordering store in cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getOrderingStoreCookie/).
|
|
249
|
+
*/
|
|
250
|
+
getOrderingStoreCookie({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.GetOrderingStoreCookieParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.SuccessMessageResponse>;
|
|
238
251
|
/**
|
|
239
252
|
* @param {ConfigurationPlatformApplicationValidator.GetOrderingStoresByFilterParam} arg
|
|
240
253
|
* - Arg object
|
|
@@ -349,6 +362,19 @@ declare class Configuration {
|
|
|
349
362
|
* @description: Delete a domain (secondary or shortlink domain) added to a sales channel. It will disable user's access to website, shared links, and other features associated with this domain. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/removeDomainById/).
|
|
350
363
|
*/
|
|
351
364
|
removeDomainById({ id, requestHeaders }?: ConfigurationPlatformApplicationValidator.RemoveDomainByIdParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.SuccessMessageResponse>;
|
|
365
|
+
/**
|
|
366
|
+
* @param {ConfigurationPlatformApplicationValidator.RemoveOrderingStoreCookieParam} arg
|
|
367
|
+
* - Arg object
|
|
368
|
+
*
|
|
369
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
370
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
371
|
+
* @returns {Promise<ConfigurationPlatformModel.SuccessMessageResponse>} -
|
|
372
|
+
* Success response
|
|
373
|
+
* @name removeOrderingStoreCookie
|
|
374
|
+
* @summary: Unset the Ordering Store signed cookie.
|
|
375
|
+
* @description: Use this API to unset the Ordering Store cookie upon changing the sales channel, by its domain URL, in the Universal Fynd Store app. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/removeOrderingStoreCookie/).
|
|
376
|
+
*/
|
|
377
|
+
removeOrderingStoreCookie({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.SuccessMessageResponse>;
|
|
352
378
|
/**
|
|
353
379
|
* @param {ConfigurationPlatformApplicationValidator.UpdateAppApiTokensParam} arg
|
|
354
380
|
* - Arg object
|
|
@@ -1289,6 +1289,84 @@ class Configuration {
|
|
|
1289
1289
|
return response;
|
|
1290
1290
|
}
|
|
1291
1291
|
|
|
1292
|
+
/**
|
|
1293
|
+
* @param {ConfigurationPlatformApplicationValidator.GetOrderingStoreCookieParam} arg
|
|
1294
|
+
* - Arg object
|
|
1295
|
+
*
|
|
1296
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1297
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1298
|
+
* @returns {Promise<ConfigurationPlatformModel.SuccessMessageResponse>} -
|
|
1299
|
+
* Success response
|
|
1300
|
+
* @name getOrderingStoreCookie
|
|
1301
|
+
* @summary: Get an Ordering Store signed cookie on selection of ordering store.
|
|
1302
|
+
* @description: Use this API to get an Ordering Store signed cookie upon selecting an ordering store. This will be used by the cart service to verify a coupon against the selected ordering store in cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getOrderingStoreCookie/).
|
|
1303
|
+
*/
|
|
1304
|
+
async getOrderingStoreCookie(
|
|
1305
|
+
{ body, requestHeaders } = { requestHeaders: {} },
|
|
1306
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
1307
|
+
) {
|
|
1308
|
+
const {
|
|
1309
|
+
error,
|
|
1310
|
+
} = ConfigurationPlatformApplicationValidator.getOrderingStoreCookie().validate(
|
|
1311
|
+
{
|
|
1312
|
+
body,
|
|
1313
|
+
},
|
|
1314
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1315
|
+
);
|
|
1316
|
+
if (error) {
|
|
1317
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
1318
|
+
}
|
|
1319
|
+
|
|
1320
|
+
// Showing warrnings if extra unknown parameters are found
|
|
1321
|
+
const {
|
|
1322
|
+
error: warrning,
|
|
1323
|
+
} = ConfigurationPlatformApplicationValidator.getOrderingStoreCookie().validate(
|
|
1324
|
+
{
|
|
1325
|
+
body,
|
|
1326
|
+
},
|
|
1327
|
+
{ abortEarly: false, allowUnknown: false }
|
|
1328
|
+
);
|
|
1329
|
+
if (warrning) {
|
|
1330
|
+
Logger({
|
|
1331
|
+
level: "WARN",
|
|
1332
|
+
message: `Parameter Validation warrnings for platform > Configuration > getOrderingStoreCookie \n ${warrning}`,
|
|
1333
|
+
});
|
|
1334
|
+
}
|
|
1335
|
+
|
|
1336
|
+
const query_params = {};
|
|
1337
|
+
|
|
1338
|
+
const response = await PlatformAPIClient.execute(
|
|
1339
|
+
this.config,
|
|
1340
|
+
"post",
|
|
1341
|
+
`/service/platform/configuration/v1.0/company/${this.config.companyId}/application/${this.applicationId}/ordering-store/select`,
|
|
1342
|
+
query_params,
|
|
1343
|
+
body,
|
|
1344
|
+
requestHeaders,
|
|
1345
|
+
{ responseHeaders }
|
|
1346
|
+
);
|
|
1347
|
+
|
|
1348
|
+
let responseData = response;
|
|
1349
|
+
if (responseHeaders) {
|
|
1350
|
+
responseData = response[0];
|
|
1351
|
+
}
|
|
1352
|
+
|
|
1353
|
+
const {
|
|
1354
|
+
error: res_error,
|
|
1355
|
+
} = ConfigurationPlatformModel.SuccessMessageResponse().validate(
|
|
1356
|
+
responseData,
|
|
1357
|
+
{ abortEarly: false, allowUnknown: false }
|
|
1358
|
+
);
|
|
1359
|
+
|
|
1360
|
+
if (res_error) {
|
|
1361
|
+
Logger({
|
|
1362
|
+
level: "WARN",
|
|
1363
|
+
message: `Response Validation Warnnings for platform > Configuration > getOrderingStoreCookie \n ${res_error}`,
|
|
1364
|
+
});
|
|
1365
|
+
}
|
|
1366
|
+
|
|
1367
|
+
return response;
|
|
1368
|
+
}
|
|
1369
|
+
|
|
1292
1370
|
/**
|
|
1293
1371
|
* @param {ConfigurationPlatformApplicationValidator.GetOrderingStoresByFilterParam} arg
|
|
1294
1372
|
* - Arg object
|
|
@@ -1850,6 +1928,80 @@ class Configuration {
|
|
|
1850
1928
|
return response;
|
|
1851
1929
|
}
|
|
1852
1930
|
|
|
1931
|
+
/**
|
|
1932
|
+
* @param {ConfigurationPlatformApplicationValidator.RemoveOrderingStoreCookieParam} arg
|
|
1933
|
+
* - Arg object
|
|
1934
|
+
*
|
|
1935
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1936
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1937
|
+
* @returns {Promise<ConfigurationPlatformModel.SuccessMessageResponse>} -
|
|
1938
|
+
* Success response
|
|
1939
|
+
* @name removeOrderingStoreCookie
|
|
1940
|
+
* @summary: Unset the Ordering Store signed cookie.
|
|
1941
|
+
* @description: Use this API to unset the Ordering Store cookie upon changing the sales channel, by its domain URL, in the Universal Fynd Store app. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/removeOrderingStoreCookie/).
|
|
1942
|
+
*/
|
|
1943
|
+
async removeOrderingStoreCookie(
|
|
1944
|
+
{ requestHeaders } = { requestHeaders: {} },
|
|
1945
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
1946
|
+
) {
|
|
1947
|
+
const {
|
|
1948
|
+
error,
|
|
1949
|
+
} = ConfigurationPlatformApplicationValidator.removeOrderingStoreCookie().validate(
|
|
1950
|
+
{},
|
|
1951
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1952
|
+
);
|
|
1953
|
+
if (error) {
|
|
1954
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
1955
|
+
}
|
|
1956
|
+
|
|
1957
|
+
// Showing warrnings if extra unknown parameters are found
|
|
1958
|
+
const {
|
|
1959
|
+
error: warrning,
|
|
1960
|
+
} = ConfigurationPlatformApplicationValidator.removeOrderingStoreCookie().validate(
|
|
1961
|
+
{},
|
|
1962
|
+
{ abortEarly: false, allowUnknown: false }
|
|
1963
|
+
);
|
|
1964
|
+
if (warrning) {
|
|
1965
|
+
Logger({
|
|
1966
|
+
level: "WARN",
|
|
1967
|
+
message: `Parameter Validation warrnings for platform > Configuration > removeOrderingStoreCookie \n ${warrning}`,
|
|
1968
|
+
});
|
|
1969
|
+
}
|
|
1970
|
+
|
|
1971
|
+
const query_params = {};
|
|
1972
|
+
|
|
1973
|
+
const response = await PlatformAPIClient.execute(
|
|
1974
|
+
this.config,
|
|
1975
|
+
"delete",
|
|
1976
|
+
`/service/platform/configuration/v1.0/company/${this.config.companyId}/application/${this.applicationId}/ordering-store/select`,
|
|
1977
|
+
query_params,
|
|
1978
|
+
undefined,
|
|
1979
|
+
requestHeaders,
|
|
1980
|
+
{ responseHeaders }
|
|
1981
|
+
);
|
|
1982
|
+
|
|
1983
|
+
let responseData = response;
|
|
1984
|
+
if (responseHeaders) {
|
|
1985
|
+
responseData = response[0];
|
|
1986
|
+
}
|
|
1987
|
+
|
|
1988
|
+
const {
|
|
1989
|
+
error: res_error,
|
|
1990
|
+
} = ConfigurationPlatformModel.SuccessMessageResponse().validate(
|
|
1991
|
+
responseData,
|
|
1992
|
+
{ abortEarly: false, allowUnknown: false }
|
|
1993
|
+
);
|
|
1994
|
+
|
|
1995
|
+
if (res_error) {
|
|
1996
|
+
Logger({
|
|
1997
|
+
level: "WARN",
|
|
1998
|
+
message: `Response Validation Warnnings for platform > Configuration > removeOrderingStoreCookie \n ${res_error}`,
|
|
1999
|
+
});
|
|
2000
|
+
}
|
|
2001
|
+
|
|
2002
|
+
return response;
|
|
2003
|
+
}
|
|
2004
|
+
|
|
1853
2005
|
/**
|
|
1854
2006
|
* @param {ConfigurationPlatformApplicationValidator.UpdateAppApiTokensParam} arg
|
|
1855
2007
|
* - Arg object
|
|
@@ -41,6 +41,10 @@ export = ConfigurationPlatformApplicationValidator;
|
|
|
41
41
|
/** @typedef GetDomainsParam */
|
|
42
42
|
/** @typedef GetInventoryConfigParam */
|
|
43
43
|
/** @typedef GetOrderingStoreConfigParam */
|
|
44
|
+
/**
|
|
45
|
+
* @typedef GetOrderingStoreCookieParam
|
|
46
|
+
* @property {ConfigurationPlatformModel.OrderingStoreSelectRequest} body
|
|
47
|
+
*/
|
|
44
48
|
/**
|
|
45
49
|
* @typedef GetOrderingStoresByFilterParam
|
|
46
50
|
* @property {number} [pageNo] - The page number to navigate through the given
|
|
@@ -74,6 +78,7 @@ export = ConfigurationPlatformApplicationValidator;
|
|
|
74
78
|
* @typedef RemoveDomainByIdParam
|
|
75
79
|
* @property {string} id - The unique identifier (24-digit Mongo Object ID) of the domain
|
|
76
80
|
*/
|
|
81
|
+
/** @typedef RemoveOrderingStoreCookieParam */
|
|
77
82
|
/**
|
|
78
83
|
* @typedef UpdateAppApiTokensParam
|
|
79
84
|
* @property {ConfigurationPlatformModel.TokenResponse} body
|
|
@@ -141,6 +146,8 @@ declare class ConfigurationPlatformApplicationValidator {
|
|
|
141
146
|
static getInventoryConfig(): any;
|
|
142
147
|
/** @returns {GetOrderingStoreConfigParam} */
|
|
143
148
|
static getOrderingStoreConfig(): any;
|
|
149
|
+
/** @returns {GetOrderingStoreCookieParam} */
|
|
150
|
+
static getOrderingStoreCookie(): GetOrderingStoreCookieParam;
|
|
144
151
|
/** @returns {GetOrderingStoresByFilterParam} */
|
|
145
152
|
static getOrderingStoresByFilter(): GetOrderingStoresByFilterParam;
|
|
146
153
|
/** @returns {GetPreviousVersionsParam} */
|
|
@@ -153,6 +160,8 @@ declare class ConfigurationPlatformApplicationValidator {
|
|
|
153
160
|
static partiallyUpdateInventoryConfig(): PartiallyUpdateInventoryConfigParam;
|
|
154
161
|
/** @returns {RemoveDomainByIdParam} */
|
|
155
162
|
static removeDomainById(): RemoveDomainByIdParam;
|
|
163
|
+
/** @returns {RemoveOrderingStoreCookieParam} */
|
|
164
|
+
static removeOrderingStoreCookie(): any;
|
|
156
165
|
/** @returns {UpdateAppApiTokensParam} */
|
|
157
166
|
static updateAppApiTokens(): UpdateAppApiTokensParam;
|
|
158
167
|
/** @returns {UpdateAppBasicDetailsParam} */
|
|
@@ -171,7 +180,7 @@ declare class ConfigurationPlatformApplicationValidator {
|
|
|
171
180
|
static updateOrderingStoreConfig(): UpdateOrderingStoreConfigParam;
|
|
172
181
|
}
|
|
173
182
|
declare namespace ConfigurationPlatformApplicationValidator {
|
|
174
|
-
export { AddDomainParam, ChangeDomainTypeParam, GetAppApiTokensParam, GetAppBasicDetailsParam, GetAppCompaniesParam, GetAppContactInfoParam, GetAppCurrencyConfigParam, GetAppFeaturesParam, GetAppStoresParam, GetAppSupportedCurrencyParam, GetApplicationByIdParam, GetBuildConfigParam, GetDomainStatusParam, GetDomainsParam, GetInventoryConfigParam, GetOrderingStoreConfigParam, GetOrderingStoresByFilterParam, GetPreviousVersionsParam, GetStaffOrderingStoresParam, ModifyAppFeaturesParam, PartiallyUpdateInventoryConfigParam, RemoveDomainByIdParam, UpdateAppApiTokensParam, UpdateAppBasicDetailsParam, UpdateAppContactInfoParam, UpdateAppCurrencyConfigParam, UpdateAppFeaturesParam, UpdateBuildConfigParam, UpdateInventoryConfigParam, UpdateOrderingStoreConfigParam };
|
|
183
|
+
export { AddDomainParam, ChangeDomainTypeParam, GetAppApiTokensParam, GetAppBasicDetailsParam, GetAppCompaniesParam, GetAppContactInfoParam, GetAppCurrencyConfigParam, GetAppFeaturesParam, GetAppStoresParam, GetAppSupportedCurrencyParam, GetApplicationByIdParam, GetBuildConfigParam, GetDomainStatusParam, GetDomainsParam, GetInventoryConfigParam, GetOrderingStoreConfigParam, GetOrderingStoreCookieParam, GetOrderingStoresByFilterParam, GetPreviousVersionsParam, GetStaffOrderingStoresParam, ModifyAppFeaturesParam, PartiallyUpdateInventoryConfigParam, RemoveDomainByIdParam, RemoveOrderingStoreCookieParam, UpdateAppApiTokensParam, UpdateAppBasicDetailsParam, UpdateAppContactInfoParam, UpdateAppCurrencyConfigParam, UpdateAppFeaturesParam, UpdateBuildConfigParam, UpdateInventoryConfigParam, UpdateOrderingStoreConfigParam };
|
|
175
184
|
}
|
|
176
185
|
type AddDomainParam = {
|
|
177
186
|
body: ConfigurationPlatformModel.DomainAddRequest;
|
|
@@ -217,6 +226,9 @@ type GetBuildConfigParam = {
|
|
|
217
226
|
type GetDomainStatusParam = {
|
|
218
227
|
body: ConfigurationPlatformModel.DomainStatusRequest;
|
|
219
228
|
};
|
|
229
|
+
type GetOrderingStoreCookieParam = {
|
|
230
|
+
body: ConfigurationPlatformModel.OrderingStoreSelectRequest;
|
|
231
|
+
};
|
|
220
232
|
type GetOrderingStoresByFilterParam = {
|
|
221
233
|
/**
|
|
222
234
|
* - The page number to navigate through the given
|
|
@@ -304,4 +316,5 @@ type GetApplicationByIdParam = any;
|
|
|
304
316
|
type GetDomainsParam = any;
|
|
305
317
|
type GetInventoryConfigParam = any;
|
|
306
318
|
type GetOrderingStoreConfigParam = any;
|
|
319
|
+
type RemoveOrderingStoreCookieParam = any;
|
|
307
320
|
import ConfigurationPlatformModel = require("./ConfigurationPlatformModel");
|
|
@@ -60,6 +60,11 @@ const ConfigurationPlatformModel = require("./ConfigurationPlatformModel");
|
|
|
60
60
|
|
|
61
61
|
/** @typedef GetOrderingStoreConfigParam */
|
|
62
62
|
|
|
63
|
+
/**
|
|
64
|
+
* @typedef GetOrderingStoreCookieParam
|
|
65
|
+
* @property {ConfigurationPlatformModel.OrderingStoreSelectRequest} body
|
|
66
|
+
*/
|
|
67
|
+
|
|
63
68
|
/**
|
|
64
69
|
* @typedef GetOrderingStoresByFilterParam
|
|
65
70
|
* @property {number} [pageNo] - The page number to navigate through the given
|
|
@@ -99,6 +104,8 @@ const ConfigurationPlatformModel = require("./ConfigurationPlatformModel");
|
|
|
99
104
|
* @property {string} id - The unique identifier (24-digit Mongo Object ID) of the domain
|
|
100
105
|
*/
|
|
101
106
|
|
|
107
|
+
/** @typedef RemoveOrderingStoreCookieParam */
|
|
108
|
+
|
|
102
109
|
/**
|
|
103
110
|
* @typedef UpdateAppApiTokensParam
|
|
104
111
|
* @property {ConfigurationPlatformModel.TokenResponse} body
|
|
@@ -237,6 +244,13 @@ class ConfigurationPlatformApplicationValidator {
|
|
|
237
244
|
return Joi.object({}).required();
|
|
238
245
|
}
|
|
239
246
|
|
|
247
|
+
/** @returns {GetOrderingStoreCookieParam} */
|
|
248
|
+
static getOrderingStoreCookie() {
|
|
249
|
+
return Joi.object({
|
|
250
|
+
body: ConfigurationPlatformModel.OrderingStoreSelectRequest().required(),
|
|
251
|
+
}).required();
|
|
252
|
+
}
|
|
253
|
+
|
|
240
254
|
/** @returns {GetOrderingStoresByFilterParam} */
|
|
241
255
|
static getOrderingStoresByFilter() {
|
|
242
256
|
return Joi.object({
|
|
@@ -283,6 +297,11 @@ class ConfigurationPlatformApplicationValidator {
|
|
|
283
297
|
}).required();
|
|
284
298
|
}
|
|
285
299
|
|
|
300
|
+
/** @returns {RemoveOrderingStoreCookieParam} */
|
|
301
|
+
static removeOrderingStoreCookie() {
|
|
302
|
+
return Joi.object({}).required();
|
|
303
|
+
}
|
|
304
|
+
|
|
286
305
|
/** @returns {UpdateAppApiTokensParam} */
|
|
287
306
|
static updateAppApiTokens() {
|
|
288
307
|
return Joi.object({
|
|
@@ -1127,6 +1127,14 @@ export = ConfigurationPlatformModel;
|
|
|
1127
1127
|
* @property {string} [type] - For hard type delivery, store selection is
|
|
1128
1128
|
* compulsory. For soft type, delivery store selection is optional.
|
|
1129
1129
|
*/
|
|
1130
|
+
/**
|
|
1131
|
+
* @typedef OrderingStoreSelect
|
|
1132
|
+
* @property {number} uid - Ordering store unique uid. It is required.
|
|
1133
|
+
*/
|
|
1134
|
+
/**
|
|
1135
|
+
* @typedef OrderingStoreSelectRequest
|
|
1136
|
+
* @property {OrderingStoreSelect} ordering_store
|
|
1137
|
+
*/
|
|
1130
1138
|
/**
|
|
1131
1139
|
* @typedef OrderingStoresResponse
|
|
1132
1140
|
* @property {OrderingStore[]} [items]
|
|
@@ -1431,7 +1439,7 @@ export = ConfigurationPlatformModel;
|
|
|
1431
1439
|
declare class ConfigurationPlatformModel {
|
|
1432
1440
|
}
|
|
1433
1441
|
declare namespace ConfigurationPlatformModel {
|
|
1434
|
-
export { Android, App, AppCartConfig, AppCurrencyResponse, AppDomain, AppFeature, AppFeatureRequest, AppFeatureResponse, AppInventory, AppInventoryCompanies, AppInventoryConfig, AppInventoryPartialUpdate, AppInventoryStores, Application, ApplicationAuth, ApplicationCors, ApplicationDetail, ApplicationInformation, ApplicationInventory, ApplicationMeta, ApplicationRedirections, ApplicationsResponse, ApplicationWebsite, AppLogisticsConfig, AppOrderConfig, AppPaymentConfig, AppStoreRules, AppSupportedCurrency, ArticleAssignmentConfig, ArticleAssignmentRule, ArticleAssignmentRules, AuthenticationConfig, BlogLink, BrandCompanyInfo, BrandsByCompanyResponse, BrandStoreInfo, BuildVersion, BuildVersionHistory, BusinessHighlights, CallbackUrl, CartFeature, Charges, CommonFeature, CommsConfig, CommunicationConfig, CommunicationOptinDialogFeature, CompaniesResponse, CompanyBrandInfo, CompanyByBrandsRequest, CompanyByBrandsResponse, CompanyValidator, CompareProductsFeature, CreateApplicationRequest, CreateAppResponse, Credentials, Credit, CurrenciesResponse, Currency, CurrencyFeature, Debit, DefaultCurrency, DeliveryCharges, DeploymentMeta, DeploymentStoreSelectionFeature, Domain, DomainAdd, DomainAddRequest, DomainsResponse, DomainStatus, DomainStatusRequest, DomainStatusResponse, DomainSuggestion, DomainSuggestionsRequest, DomainSuggestionsResponse, FacebookLink, FeedbackFeature, FilterOrderingStoreRequest, Firebase, Freshchat, FreshchatCredentials, FyndRewards, FyndRewardsCredentials, GetIntegrationsOptInsResponse, GoogleMap, GoogleMapCredentials, GooglePlusLink, Gtm, GtmCredentials, HomePageFeature, InformationAddress, InformationPhone, InformationSupport, InstagramLink, Integration, IntegrationConfigResponse, IntegrationLevel, IntegrationMeta, IntegrationOptIn, InvalidPayloadRequest, InventoryArticleAssignment, InventoryBrand, InventoryBrandRule, InventoryCategory, InventoryDiscount, InventoryPaymentConfig, InventoryPrice, InventoryStore, InventoryStoreRule, InventoryValidator, Ios, JsonSchema, LandingImage, LandingPageFeature, LastPatch, LaunchPage, LinkedInLink, Links, ListingPriceFeature, LoyaltyPointsConfig, Methods, MobileAppConfigRequest, MobileAppConfiguration, Moengage, MoengageCredentials, NotFound, OptedApplicationResponse, OptedCompany, OptedInventory, OptedStore, OptedStoreAddress, OptedStoreIntegration, OptOutInventory, OptType, OrderFeature, OrderingStore, OrderingStoreConfig, OrderingStores, OrderingStoresResponse, OrderValidator, OtherEntity, OtherEntityData, OtherSellerApplication, OtherSellerApplications, OtherSellerCompany, Page, PanCardConfig, PaymentModeConfig, PaymentSelectionLock, PcrFeature, PinterestLink, ProductDetailFeature, QrFeature, RegistrationPageFeature, RevenueEngineFeature, RewardPointsConfig, Safetynet, SafetynetCredentials, SecureUrl, Segment, SegmentCredentials, SocialLinks, SplashImage, StoreByBrandsRequest, StoreByBrandsResponse, StoreCriteriaRule, StoreLatLong, StorePriority, StorePriorityRule, StoresResponse, StoreValidator, SuccessMessageResponse, TokenResponse, Tokens, TwitterLink, UpdateDomain, UpdateDomainTypeRequest, UpdateIntegrationLevelRequest, ValidationFailedResponse, Validators, VimeoLink, YoutubeLink };
|
|
1442
|
+
export { Android, App, AppCartConfig, AppCurrencyResponse, AppDomain, AppFeature, AppFeatureRequest, AppFeatureResponse, AppInventory, AppInventoryCompanies, AppInventoryConfig, AppInventoryPartialUpdate, AppInventoryStores, Application, ApplicationAuth, ApplicationCors, ApplicationDetail, ApplicationInformation, ApplicationInventory, ApplicationMeta, ApplicationRedirections, ApplicationsResponse, ApplicationWebsite, AppLogisticsConfig, AppOrderConfig, AppPaymentConfig, AppStoreRules, AppSupportedCurrency, ArticleAssignmentConfig, ArticleAssignmentRule, ArticleAssignmentRules, AuthenticationConfig, BlogLink, BrandCompanyInfo, BrandsByCompanyResponse, BrandStoreInfo, BuildVersion, BuildVersionHistory, BusinessHighlights, CallbackUrl, CartFeature, Charges, CommonFeature, CommsConfig, CommunicationConfig, CommunicationOptinDialogFeature, CompaniesResponse, CompanyBrandInfo, CompanyByBrandsRequest, CompanyByBrandsResponse, CompanyValidator, CompareProductsFeature, CreateApplicationRequest, CreateAppResponse, Credentials, Credit, CurrenciesResponse, Currency, CurrencyFeature, Debit, DefaultCurrency, DeliveryCharges, DeploymentMeta, DeploymentStoreSelectionFeature, Domain, DomainAdd, DomainAddRequest, DomainsResponse, DomainStatus, DomainStatusRequest, DomainStatusResponse, DomainSuggestion, DomainSuggestionsRequest, DomainSuggestionsResponse, FacebookLink, FeedbackFeature, FilterOrderingStoreRequest, Firebase, Freshchat, FreshchatCredentials, FyndRewards, FyndRewardsCredentials, GetIntegrationsOptInsResponse, GoogleMap, GoogleMapCredentials, GooglePlusLink, Gtm, GtmCredentials, HomePageFeature, InformationAddress, InformationPhone, InformationSupport, InstagramLink, Integration, IntegrationConfigResponse, IntegrationLevel, IntegrationMeta, IntegrationOptIn, InvalidPayloadRequest, InventoryArticleAssignment, InventoryBrand, InventoryBrandRule, InventoryCategory, InventoryDiscount, InventoryPaymentConfig, InventoryPrice, InventoryStore, InventoryStoreRule, InventoryValidator, Ios, JsonSchema, LandingImage, LandingPageFeature, LastPatch, LaunchPage, LinkedInLink, Links, ListingPriceFeature, LoyaltyPointsConfig, Methods, MobileAppConfigRequest, MobileAppConfiguration, Moengage, MoengageCredentials, NotFound, OptedApplicationResponse, OptedCompany, OptedInventory, OptedStore, OptedStoreAddress, OptedStoreIntegration, OptOutInventory, OptType, OrderFeature, OrderingStore, OrderingStoreConfig, OrderingStores, OrderingStoreSelect, OrderingStoreSelectRequest, OrderingStoresResponse, OrderValidator, OtherEntity, OtherEntityData, OtherSellerApplication, OtherSellerApplications, OtherSellerCompany, Page, PanCardConfig, PaymentModeConfig, PaymentSelectionLock, PcrFeature, PinterestLink, ProductDetailFeature, QrFeature, RegistrationPageFeature, RevenueEngineFeature, RewardPointsConfig, Safetynet, SafetynetCredentials, SecureUrl, Segment, SegmentCredentials, SocialLinks, SplashImage, StoreByBrandsRequest, StoreByBrandsResponse, StoreCriteriaRule, StoreLatLong, StorePriority, StorePriorityRule, StoresResponse, StoreValidator, SuccessMessageResponse, TokenResponse, Tokens, TwitterLink, UpdateDomain, UpdateDomainTypeRequest, UpdateIntegrationLevelRequest, ValidationFailedResponse, Validators, VimeoLink, YoutubeLink };
|
|
1435
1443
|
}
|
|
1436
1444
|
/** @returns {Android} */
|
|
1437
1445
|
declare function Android(): Android;
|
|
@@ -3760,6 +3768,19 @@ type OrderingStores = {
|
|
|
3760
3768
|
*/
|
|
3761
3769
|
type?: string;
|
|
3762
3770
|
};
|
|
3771
|
+
/** @returns {OrderingStoreSelect} */
|
|
3772
|
+
declare function OrderingStoreSelect(): OrderingStoreSelect;
|
|
3773
|
+
type OrderingStoreSelect = {
|
|
3774
|
+
/**
|
|
3775
|
+
* - Ordering store unique uid. It is required.
|
|
3776
|
+
*/
|
|
3777
|
+
uid: number;
|
|
3778
|
+
};
|
|
3779
|
+
/** @returns {OrderingStoreSelectRequest} */
|
|
3780
|
+
declare function OrderingStoreSelectRequest(): OrderingStoreSelectRequest;
|
|
3781
|
+
type OrderingStoreSelectRequest = {
|
|
3782
|
+
ordering_store: OrderingStoreSelect;
|
|
3783
|
+
};
|
|
3763
3784
|
/** @returns {OrderingStoresResponse} */
|
|
3764
3785
|
declare function OrderingStoresResponse(): OrderingStoresResponse;
|
|
3765
3786
|
type OrderingStoresResponse = {
|
|
@@ -1265,6 +1265,16 @@ const Joi = require("joi");
|
|
|
1265
1265
|
* compulsory. For soft type, delivery store selection is optional.
|
|
1266
1266
|
*/
|
|
1267
1267
|
|
|
1268
|
+
/**
|
|
1269
|
+
* @typedef OrderingStoreSelect
|
|
1270
|
+
* @property {number} uid - Ordering store unique uid. It is required.
|
|
1271
|
+
*/
|
|
1272
|
+
|
|
1273
|
+
/**
|
|
1274
|
+
* @typedef OrderingStoreSelectRequest
|
|
1275
|
+
* @property {OrderingStoreSelect} ordering_store
|
|
1276
|
+
*/
|
|
1277
|
+
|
|
1268
1278
|
/**
|
|
1269
1279
|
* @typedef OrderingStoresResponse
|
|
1270
1280
|
* @property {OrderingStore[]} [items]
|
|
@@ -2976,6 +2986,20 @@ class ConfigurationPlatformModel {
|
|
|
2976
2986
|
});
|
|
2977
2987
|
}
|
|
2978
2988
|
|
|
2989
|
+
/** @returns {OrderingStoreSelect} */
|
|
2990
|
+
static OrderingStoreSelect() {
|
|
2991
|
+
return Joi.object({
|
|
2992
|
+
uid: Joi.number().required(),
|
|
2993
|
+
});
|
|
2994
|
+
}
|
|
2995
|
+
|
|
2996
|
+
/** @returns {OrderingStoreSelectRequest} */
|
|
2997
|
+
static OrderingStoreSelectRequest() {
|
|
2998
|
+
return Joi.object({
|
|
2999
|
+
ordering_store: ConfigurationPlatformModel.OrderingStoreSelect().required(),
|
|
3000
|
+
});
|
|
3001
|
+
}
|
|
3002
|
+
|
|
2979
3003
|
/** @returns {OrderingStoresResponse} */
|
|
2980
3004
|
static OrderingStoresResponse() {
|
|
2981
3005
|
return Joi.object({
|
|
@@ -276,7 +276,7 @@ export = OrderPlatformModel;
|
|
|
276
276
|
* @property {string} [display_name]
|
|
277
277
|
* @property {string} [entity_type]
|
|
278
278
|
* @property {FinancialBreakup[]} [financial_breakup]
|
|
279
|
-
* @property {
|
|
279
|
+
* @property {GSTDetailsData} [gst_details]
|
|
280
280
|
* @property {number} [id]
|
|
281
281
|
* @property {string} [identifier]
|
|
282
282
|
* @property {Item} [item]
|
|
@@ -1165,7 +1165,7 @@ export = OrderPlatformModel;
|
|
|
1165
1165
|
* @property {string} [entity_type]
|
|
1166
1166
|
* @property {FinancialBreakup} [financial_breakup]
|
|
1167
1167
|
* @property {string} [group_id]
|
|
1168
|
-
* @property {
|
|
1168
|
+
* @property {GSTDetailsData} [gst_details]
|
|
1169
1169
|
* @property {string} [identifier]
|
|
1170
1170
|
* @property {boolean} [is_parent]
|
|
1171
1171
|
* @property {PlatformItem} [item]
|
|
@@ -2666,7 +2666,7 @@ type BagDetailsPlatformResponse = {
|
|
|
2666
2666
|
display_name?: string;
|
|
2667
2667
|
entity_type?: string;
|
|
2668
2668
|
financial_breakup?: FinancialBreakup[];
|
|
2669
|
-
gst_details?:
|
|
2669
|
+
gst_details?: GSTDetailsData;
|
|
2670
2670
|
id?: number;
|
|
2671
2671
|
identifier?: string;
|
|
2672
2672
|
item?: Item;
|
|
@@ -3820,7 +3820,7 @@ type OrderBags = {
|
|
|
3820
3820
|
entity_type?: string;
|
|
3821
3821
|
financial_breakup?: FinancialBreakup;
|
|
3822
3822
|
group_id?: string;
|
|
3823
|
-
gst_details?:
|
|
3823
|
+
gst_details?: GSTDetailsData;
|
|
3824
3824
|
identifier?: string;
|
|
3825
3825
|
is_parent?: boolean;
|
|
3826
3826
|
item?: PlatformItem;
|
|
@@ -307,7 +307,7 @@ const Joi = require("joi");
|
|
|
307
307
|
* @property {string} [display_name]
|
|
308
308
|
* @property {string} [entity_type]
|
|
309
309
|
* @property {FinancialBreakup[]} [financial_breakup]
|
|
310
|
-
* @property {
|
|
310
|
+
* @property {GSTDetailsData} [gst_details]
|
|
311
311
|
* @property {number} [id]
|
|
312
312
|
* @property {string} [identifier]
|
|
313
313
|
* @property {Item} [item]
|
|
@@ -1293,7 +1293,7 @@ const Joi = require("joi");
|
|
|
1293
1293
|
* @property {string} [entity_type]
|
|
1294
1294
|
* @property {FinancialBreakup} [financial_breakup]
|
|
1295
1295
|
* @property {string} [group_id]
|
|
1296
|
-
* @property {
|
|
1296
|
+
* @property {GSTDetailsData} [gst_details]
|
|
1297
1297
|
* @property {string} [identifier]
|
|
1298
1298
|
* @property {boolean} [is_parent]
|
|
1299
1299
|
* @property {PlatformItem} [item]
|
|
@@ -2980,7 +2980,7 @@ class OrderPlatformModel {
|
|
|
2980
2980
|
financial_breakup: Joi.array().items(
|
|
2981
2981
|
OrderPlatformModel.FinancialBreakup()
|
|
2982
2982
|
),
|
|
2983
|
-
gst_details: OrderPlatformModel.
|
|
2983
|
+
gst_details: OrderPlatformModel.GSTDetailsData(),
|
|
2984
2984
|
id: Joi.number().allow(null),
|
|
2985
2985
|
identifier: Joi.string().allow("").allow(null),
|
|
2986
2986
|
item: OrderPlatformModel.Item(),
|
|
@@ -4163,7 +4163,7 @@ class OrderPlatformModel {
|
|
|
4163
4163
|
entity_type: Joi.string().allow("").allow(null),
|
|
4164
4164
|
financial_breakup: OrderPlatformModel.FinancialBreakup(),
|
|
4165
4165
|
group_id: Joi.string().allow("").allow(null),
|
|
4166
|
-
gst_details: OrderPlatformModel.
|
|
4166
|
+
gst_details: OrderPlatformModel.GSTDetailsData(),
|
|
4167
4167
|
identifier: Joi.string().allow("").allow(null),
|
|
4168
4168
|
is_parent: Joi.boolean().allow(null),
|
|
4169
4169
|
item: OrderPlatformModel.PlatformItem(),
|
|
@@ -181,6 +181,18 @@ declare class User {
|
|
|
181
181
|
* @description: Use this API to update an existing user Group - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updateUserGroup/).
|
|
182
182
|
*/
|
|
183
183
|
updateUserGroup({ groupId, body, requestHeaders }?: UserPlatformApplicationValidator.UpdateUserGroupParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserGroupResponseSchema>;
|
|
184
|
+
/**
|
|
185
|
+
* @param {UserPlatformApplicationValidator.UpdateUserGroupPartiallyParam} arg
|
|
186
|
+
* - Arg object
|
|
187
|
+
*
|
|
188
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
189
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
190
|
+
* @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
|
|
191
|
+
* @name updateUserGroupPartially
|
|
192
|
+
* @summary: Add or Remove an user from particular user group and update user group details
|
|
193
|
+
* @description: Use this API to update user group details and add or remove an user to the user group. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updateUserGroupPartially/).
|
|
194
|
+
*/
|
|
195
|
+
updateUserGroupPartially({ groupId, body, requestHeaders }?: UserPlatformApplicationValidator.UpdateUserGroupPartiallyParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserGroupResponseSchema>;
|
|
184
196
|
}
|
|
185
197
|
import UserPlatformApplicationValidator = require("./UserPlatformApplicationValidator");
|
|
186
198
|
import UserPlatformModel = require("./UserPlatformModel");
|
|
@@ -1316,6 +1316,85 @@ class User {
|
|
|
1316
1316
|
|
|
1317
1317
|
return response;
|
|
1318
1318
|
}
|
|
1319
|
+
|
|
1320
|
+
/**
|
|
1321
|
+
* @param {UserPlatformApplicationValidator.UpdateUserGroupPartiallyParam} arg
|
|
1322
|
+
* - Arg object
|
|
1323
|
+
*
|
|
1324
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1325
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1326
|
+
* @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
|
|
1327
|
+
* @name updateUserGroupPartially
|
|
1328
|
+
* @summary: Add or Remove an user from particular user group and update user group details
|
|
1329
|
+
* @description: Use this API to update user group details and add or remove an user to the user group. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updateUserGroupPartially/).
|
|
1330
|
+
*/
|
|
1331
|
+
async updateUserGroupPartially(
|
|
1332
|
+
{ groupId, body, requestHeaders } = { requestHeaders: {} },
|
|
1333
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
1334
|
+
) {
|
|
1335
|
+
const {
|
|
1336
|
+
error,
|
|
1337
|
+
} = UserPlatformApplicationValidator.updateUserGroupPartially().validate(
|
|
1338
|
+
{
|
|
1339
|
+
groupId,
|
|
1340
|
+
body,
|
|
1341
|
+
},
|
|
1342
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1343
|
+
);
|
|
1344
|
+
if (error) {
|
|
1345
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
1346
|
+
}
|
|
1347
|
+
|
|
1348
|
+
// Showing warrnings if extra unknown parameters are found
|
|
1349
|
+
const {
|
|
1350
|
+
error: warrning,
|
|
1351
|
+
} = UserPlatformApplicationValidator.updateUserGroupPartially().validate(
|
|
1352
|
+
{
|
|
1353
|
+
groupId,
|
|
1354
|
+
body,
|
|
1355
|
+
},
|
|
1356
|
+
{ abortEarly: false, allowUnknown: false }
|
|
1357
|
+
);
|
|
1358
|
+
if (warrning) {
|
|
1359
|
+
Logger({
|
|
1360
|
+
level: "WARN",
|
|
1361
|
+
message: `Parameter Validation warrnings for platform > User > updateUserGroupPartially \n ${warrning}`,
|
|
1362
|
+
});
|
|
1363
|
+
}
|
|
1364
|
+
|
|
1365
|
+
const query_params = {};
|
|
1366
|
+
|
|
1367
|
+
const response = await PlatformAPIClient.execute(
|
|
1368
|
+
this.config,
|
|
1369
|
+
"patch",
|
|
1370
|
+
`/service/platform/user/v1.0/company/${this.config.companyId}/application/${this.applicationId}/user_group/${groupId}`,
|
|
1371
|
+
query_params,
|
|
1372
|
+
body,
|
|
1373
|
+
requestHeaders,
|
|
1374
|
+
{ responseHeaders }
|
|
1375
|
+
);
|
|
1376
|
+
|
|
1377
|
+
let responseData = response;
|
|
1378
|
+
if (responseHeaders) {
|
|
1379
|
+
responseData = response[0];
|
|
1380
|
+
}
|
|
1381
|
+
|
|
1382
|
+
const {
|
|
1383
|
+
error: res_error,
|
|
1384
|
+
} = UserPlatformModel.UserGroupResponseSchema().validate(responseData, {
|
|
1385
|
+
abortEarly: false,
|
|
1386
|
+
allowUnknown: false,
|
|
1387
|
+
});
|
|
1388
|
+
|
|
1389
|
+
if (res_error) {
|
|
1390
|
+
Logger({
|
|
1391
|
+
level: "WARN",
|
|
1392
|
+
message: `Response Validation Warnnings for platform > User > updateUserGroupPartially \n ${res_error}`,
|
|
1393
|
+
});
|
|
1394
|
+
}
|
|
1395
|
+
|
|
1396
|
+
return response;
|
|
1397
|
+
}
|
|
1319
1398
|
}
|
|
1320
1399
|
|
|
1321
1400
|
module.exports = User;
|
|
@@ -80,6 +80,11 @@ export = UserPlatformApplicationValidator;
|
|
|
80
80
|
* @property {string} groupId - Numeric ID allotted to a User Group
|
|
81
81
|
* @property {UserPlatformModel.UpdateUserGroupSchema} body
|
|
82
82
|
*/
|
|
83
|
+
/**
|
|
84
|
+
* @typedef UpdateUserGroupPartiallyParam
|
|
85
|
+
* @property {string} groupId - Numeric ID allotted to a User Group
|
|
86
|
+
* @property {UserPlatformModel.PartialUserGroupUpdateSchema} body
|
|
87
|
+
*/
|
|
83
88
|
declare class UserPlatformApplicationValidator {
|
|
84
89
|
/** @returns {ArchiveUserParam} */
|
|
85
90
|
static archiveUser(): ArchiveUserParam;
|
|
@@ -115,9 +120,11 @@ declare class UserPlatformApplicationValidator {
|
|
|
115
120
|
static updateUser(): UpdateUserParam;
|
|
116
121
|
/** @returns {UpdateUserGroupParam} */
|
|
117
122
|
static updateUserGroup(): UpdateUserGroupParam;
|
|
123
|
+
/** @returns {UpdateUserGroupPartiallyParam} */
|
|
124
|
+
static updateUserGroupPartially(): UpdateUserGroupPartiallyParam;
|
|
118
125
|
}
|
|
119
126
|
declare namespace UserPlatformApplicationValidator {
|
|
120
|
-
export { ArchiveUserParam, BlockOrUnblockUsersParam, CreateUserParam, CreateUserGroupParam, CreateUserSessionParam, DeleteActiveSessionsParam, DeleteSessionParam, GetActiveSessionsParam, GetCustomersParam, GetPlatformConfigParam, GetUserGroupByIdParam, GetUserGroupsParam, SearchUsersParam, UnDeleteUserParam, UpdatePlatformConfigParam, UpdateUserParam, UpdateUserGroupParam };
|
|
127
|
+
export { ArchiveUserParam, BlockOrUnblockUsersParam, CreateUserParam, CreateUserGroupParam, CreateUserSessionParam, DeleteActiveSessionsParam, DeleteSessionParam, GetActiveSessionsParam, GetCustomersParam, GetPlatformConfigParam, GetUserGroupByIdParam, GetUserGroupsParam, SearchUsersParam, UnDeleteUserParam, UpdatePlatformConfigParam, UpdateUserParam, UpdateUserGroupParam, UpdateUserGroupPartiallyParam };
|
|
121
128
|
}
|
|
122
129
|
type ArchiveUserParam = {
|
|
123
130
|
body: UserPlatformModel.ArchiveUserRequestSchema;
|
|
@@ -240,5 +247,12 @@ type UpdateUserGroupParam = {
|
|
|
240
247
|
groupId: string;
|
|
241
248
|
body: UserPlatformModel.UpdateUserGroupSchema;
|
|
242
249
|
};
|
|
250
|
+
type UpdateUserGroupPartiallyParam = {
|
|
251
|
+
/**
|
|
252
|
+
* - Numeric ID allotted to a User Group
|
|
253
|
+
*/
|
|
254
|
+
groupId: string;
|
|
255
|
+
body: UserPlatformModel.PartialUserGroupUpdateSchema;
|
|
256
|
+
};
|
|
243
257
|
type GetPlatformConfigParam = any;
|
|
244
258
|
import UserPlatformModel = require("./UserPlatformModel");
|
|
@@ -100,6 +100,12 @@ const UserPlatformModel = require("./UserPlatformModel");
|
|
|
100
100
|
* @property {UserPlatformModel.UpdateUserGroupSchema} body
|
|
101
101
|
*/
|
|
102
102
|
|
|
103
|
+
/**
|
|
104
|
+
* @typedef UpdateUserGroupPartiallyParam
|
|
105
|
+
* @property {string} groupId - Numeric ID allotted to a User Group
|
|
106
|
+
* @property {UserPlatformModel.PartialUserGroupUpdateSchema} body
|
|
107
|
+
*/
|
|
108
|
+
|
|
103
109
|
class UserPlatformApplicationValidator {
|
|
104
110
|
/** @returns {ArchiveUserParam} */
|
|
105
111
|
static archiveUser() {
|
|
@@ -229,6 +235,14 @@ class UserPlatformApplicationValidator {
|
|
|
229
235
|
body: UserPlatformModel.UpdateUserGroupSchema().required(),
|
|
230
236
|
}).required();
|
|
231
237
|
}
|
|
238
|
+
|
|
239
|
+
/** @returns {UpdateUserGroupPartiallyParam} */
|
|
240
|
+
static updateUserGroupPartially() {
|
|
241
|
+
return Joi.object({
|
|
242
|
+
groupId: Joi.string().allow("").required(),
|
|
243
|
+
body: UserPlatformModel.PartialUserGroupUpdateSchema().required(),
|
|
244
|
+
}).required();
|
|
245
|
+
}
|
|
232
246
|
}
|
|
233
247
|
|
|
234
248
|
module.exports = UserPlatformApplicationValidator;
|