@gofynd/fdk-client-javascript 3.4.1 → 3.4.3
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 +23 -26
- package/package.json +1 -1
- package/sdk/application/ApplicationClient.d.ts +3 -2
- package/sdk/application/ApplicationClient.js +25 -19
- package/sdk/common/utils.js +6 -3
- package/sdk/partner/PartnerClient.d.ts +5 -2
- package/sdk/partner/PartnerClient.js +21 -7
- package/sdk/platform/Cart/CartPlatformModel.d.ts +2 -81
- package/sdk/platform/Cart/CartPlatformModel.js +2 -239
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +39 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +256 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +59 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +45 -0
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +31 -3
- package/sdk/platform/Catalog/CatalogPlatformModel.js +29 -2
- package/sdk/platform/Order/OrderPlatformModel.d.ts +7 -0
- package/sdk/platform/Order/OrderPlatformModel.js +3 -0
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +0 -64
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +0 -487
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +6 -68
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +3 -76
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +1 -420
- package/sdk/platform/Payment/PaymentPlatformModel.js +0 -494
- package/sdk/platform/PlatformClient.d.ts +5 -2
- package/sdk/platform/PlatformClient.js +32 -18
- package/sdk/public/PublicClient.d.ts +3 -2
- package/sdk/public/PublicClient.js +13 -7
|
@@ -231,6 +231,19 @@ declare class Catalog {
|
|
|
231
231
|
* @description: Delete a search keywords by its id for a specific company and sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/deleteSearchKeywords/).
|
|
232
232
|
*/
|
|
233
233
|
deleteSearchKeywords({ id, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteSearchKeywordsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DeleteResponseSchema>;
|
|
234
|
+
/**
|
|
235
|
+
* @param {CatalogPlatformApplicationValidator.FollowProductByIdParam} arg
|
|
236
|
+
* - Arg object
|
|
237
|
+
*
|
|
238
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
239
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
240
|
+
* @returns {Promise<CatalogPlatformModel.FollowProduct>} - Success response
|
|
241
|
+
* @name followProductById
|
|
242
|
+
* @summary: Follow a Specific Product by ID
|
|
243
|
+
* @description: This endpoint enables a user to follow a specific product identified by its unique item ID for a sales channel.
|
|
244
|
+
* - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/followProductById/).
|
|
245
|
+
*/
|
|
246
|
+
followProductById({ userId, itemId, requestHeaders }?: CatalogPlatformApplicationValidator.FollowProductByIdParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.FollowProduct>;
|
|
234
247
|
/**
|
|
235
248
|
* @param {CatalogPlatformApplicationValidator.GetAllCollectionsParam} arg
|
|
236
249
|
* - Arg object
|
|
@@ -836,6 +849,19 @@ declare class Catalog {
|
|
|
836
849
|
pageSize?: number;
|
|
837
850
|
locationIds?: number[];
|
|
838
851
|
}): Paginator<CatalogPlatformModel.ApplicationInventorySellerIdentifierResponsePaginated>;
|
|
852
|
+
/**
|
|
853
|
+
* @param {CatalogPlatformApplicationValidator.GetFollowedProductsParam} arg
|
|
854
|
+
* - Arg object
|
|
855
|
+
*
|
|
856
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
857
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
858
|
+
* @returns {Promise<CatalogPlatformModel.FollowedProducts>} - Success response
|
|
859
|
+
* @name getFollowedProducts
|
|
860
|
+
* @summary: Retrieve followed products by user
|
|
861
|
+
* @description: List all product ids a user has wishlisted or is following for sales channel.
|
|
862
|
+
* - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getFollowedProducts/).
|
|
863
|
+
*/
|
|
864
|
+
getFollowedProducts({ userId, pageId, pageSize, requestHeaders }?: CatalogPlatformApplicationValidator.GetFollowedProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.FollowedProducts>;
|
|
839
865
|
/**
|
|
840
866
|
* @param {CatalogPlatformApplicationValidator.GetGroupConfigurationsParam} arg
|
|
841
867
|
* - Arg object
|
|
@@ -911,6 +937,19 @@ declare class Catalog {
|
|
|
911
937
|
* @description: Retrieve a list of a specific list of keywords by its id for a specific company and sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getSearchKeywords/).
|
|
912
938
|
*/
|
|
913
939
|
getSearchKeywords({ id, requestHeaders }?: CatalogPlatformApplicationValidator.GetSearchKeywordsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetSearchWordsDetailResponseSchema>;
|
|
940
|
+
/**
|
|
941
|
+
* @param {CatalogPlatformApplicationValidator.UnfollowProductByIdParam} arg
|
|
942
|
+
* - Arg object
|
|
943
|
+
*
|
|
944
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
945
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
946
|
+
* @returns {Promise<CatalogPlatformModel.FollowProduct>} - Success response
|
|
947
|
+
* @name unfollowProductById
|
|
948
|
+
* @summary: Unfollow a Specific Product by ID
|
|
949
|
+
* @description: This endpoint allows a user to unfollow a previously followed product using its unique item ID for a sales channel.
|
|
950
|
+
* - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/unfollowProductById/).
|
|
951
|
+
*/
|
|
952
|
+
unfollowProductById({ userId, itemId, requestHeaders }?: CatalogPlatformApplicationValidator.UnfollowProductByIdParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.FollowProduct>;
|
|
914
953
|
/**
|
|
915
954
|
* @param {CatalogPlatformApplicationValidator.UpdateAllowSingleParam} arg
|
|
916
955
|
* - Arg object
|
|
@@ -1524,6 +1524,90 @@ class Catalog {
|
|
|
1524
1524
|
return response;
|
|
1525
1525
|
}
|
|
1526
1526
|
|
|
1527
|
+
/**
|
|
1528
|
+
* @param {CatalogPlatformApplicationValidator.FollowProductByIdParam} arg
|
|
1529
|
+
* - Arg object
|
|
1530
|
+
*
|
|
1531
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1532
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1533
|
+
* @returns {Promise<CatalogPlatformModel.FollowProduct>} - Success response
|
|
1534
|
+
* @name followProductById
|
|
1535
|
+
* @summary: Follow a Specific Product by ID
|
|
1536
|
+
* @description: This endpoint enables a user to follow a specific product identified by its unique item ID for a sales channel.
|
|
1537
|
+
* - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/followProductById/).
|
|
1538
|
+
*/
|
|
1539
|
+
async followProductById(
|
|
1540
|
+
{ userId, itemId, requestHeaders } = { requestHeaders: {} },
|
|
1541
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
1542
|
+
) {
|
|
1543
|
+
const {
|
|
1544
|
+
error,
|
|
1545
|
+
} = CatalogPlatformApplicationValidator.followProductById().validate(
|
|
1546
|
+
{
|
|
1547
|
+
userId,
|
|
1548
|
+
itemId,
|
|
1549
|
+
},
|
|
1550
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1551
|
+
);
|
|
1552
|
+
if (error) {
|
|
1553
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
1554
|
+
}
|
|
1555
|
+
|
|
1556
|
+
// Showing warrnings if extra unknown parameters are found
|
|
1557
|
+
const {
|
|
1558
|
+
error: warrning,
|
|
1559
|
+
} = CatalogPlatformApplicationValidator.followProductById().validate(
|
|
1560
|
+
{
|
|
1561
|
+
userId,
|
|
1562
|
+
itemId,
|
|
1563
|
+
},
|
|
1564
|
+
{ abortEarly: false, allowUnknown: false }
|
|
1565
|
+
);
|
|
1566
|
+
if (warrning) {
|
|
1567
|
+
Logger({
|
|
1568
|
+
level: "WARN",
|
|
1569
|
+
message: `Parameter Validation warrnings for platform > Catalog > followProductById \n ${warrning}`,
|
|
1570
|
+
});
|
|
1571
|
+
}
|
|
1572
|
+
|
|
1573
|
+
const query_params = {};
|
|
1574
|
+
|
|
1575
|
+
const response = await PlatformAPIClient.execute(
|
|
1576
|
+
this.config,
|
|
1577
|
+
"put",
|
|
1578
|
+
`/service/platform/catalog/v1.0/company/${this.config.companyId}/application/${this.applicationId}/user/${userId}/products/${itemId}/follow`,
|
|
1579
|
+
query_params,
|
|
1580
|
+
undefined,
|
|
1581
|
+
requestHeaders,
|
|
1582
|
+
{ responseHeaders }
|
|
1583
|
+
);
|
|
1584
|
+
|
|
1585
|
+
let responseData = response;
|
|
1586
|
+
if (responseHeaders) {
|
|
1587
|
+
responseData = response[0];
|
|
1588
|
+
}
|
|
1589
|
+
|
|
1590
|
+
const {
|
|
1591
|
+
error: res_error,
|
|
1592
|
+
} = CatalogPlatformModel.FollowProduct().validate(responseData, {
|
|
1593
|
+
abortEarly: false,
|
|
1594
|
+
allowUnknown: true,
|
|
1595
|
+
});
|
|
1596
|
+
|
|
1597
|
+
if (res_error) {
|
|
1598
|
+
if (this.config.options.strictResponseCheck === true) {
|
|
1599
|
+
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
1600
|
+
} else {
|
|
1601
|
+
Logger({
|
|
1602
|
+
level: "WARN",
|
|
1603
|
+
message: `Response Validation Warnings for platform > Catalog > followProductById \n ${res_error}`,
|
|
1604
|
+
});
|
|
1605
|
+
}
|
|
1606
|
+
}
|
|
1607
|
+
|
|
1608
|
+
return response;
|
|
1609
|
+
}
|
|
1610
|
+
|
|
1527
1611
|
/**
|
|
1528
1612
|
* @param {CatalogPlatformApplicationValidator.GetAllCollectionsParam} arg
|
|
1529
1613
|
* - Arg object
|
|
@@ -4494,6 +4578,94 @@ class Catalog {
|
|
|
4494
4578
|
return paginator;
|
|
4495
4579
|
}
|
|
4496
4580
|
|
|
4581
|
+
/**
|
|
4582
|
+
* @param {CatalogPlatformApplicationValidator.GetFollowedProductsParam} arg
|
|
4583
|
+
* - Arg object
|
|
4584
|
+
*
|
|
4585
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
4586
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4587
|
+
* @returns {Promise<CatalogPlatformModel.FollowedProducts>} - Success response
|
|
4588
|
+
* @name getFollowedProducts
|
|
4589
|
+
* @summary: Retrieve followed products by user
|
|
4590
|
+
* @description: List all product ids a user has wishlisted or is following for sales channel.
|
|
4591
|
+
* - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getFollowedProducts/).
|
|
4592
|
+
*/
|
|
4593
|
+
async getFollowedProducts(
|
|
4594
|
+
{ userId, pageId, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
4595
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
4596
|
+
) {
|
|
4597
|
+
const {
|
|
4598
|
+
error,
|
|
4599
|
+
} = CatalogPlatformApplicationValidator.getFollowedProducts().validate(
|
|
4600
|
+
{
|
|
4601
|
+
userId,
|
|
4602
|
+
pageId,
|
|
4603
|
+
pageSize,
|
|
4604
|
+
},
|
|
4605
|
+
{ abortEarly: false, allowUnknown: true }
|
|
4606
|
+
);
|
|
4607
|
+
if (error) {
|
|
4608
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
4609
|
+
}
|
|
4610
|
+
|
|
4611
|
+
// Showing warrnings if extra unknown parameters are found
|
|
4612
|
+
const {
|
|
4613
|
+
error: warrning,
|
|
4614
|
+
} = CatalogPlatformApplicationValidator.getFollowedProducts().validate(
|
|
4615
|
+
{
|
|
4616
|
+
userId,
|
|
4617
|
+
pageId,
|
|
4618
|
+
pageSize,
|
|
4619
|
+
},
|
|
4620
|
+
{ abortEarly: false, allowUnknown: false }
|
|
4621
|
+
);
|
|
4622
|
+
if (warrning) {
|
|
4623
|
+
Logger({
|
|
4624
|
+
level: "WARN",
|
|
4625
|
+
message: `Parameter Validation warrnings for platform > Catalog > getFollowedProducts \n ${warrning}`,
|
|
4626
|
+
});
|
|
4627
|
+
}
|
|
4628
|
+
|
|
4629
|
+
const query_params = {};
|
|
4630
|
+
query_params["page_id"] = pageId;
|
|
4631
|
+
query_params["page_size"] = pageSize;
|
|
4632
|
+
|
|
4633
|
+
const response = await PlatformAPIClient.execute(
|
|
4634
|
+
this.config,
|
|
4635
|
+
"get",
|
|
4636
|
+
`/service/platform/catalog/v1.0/company/${this.config.companyId}/application/${this.applicationId}/user/${userId}/products/follow`,
|
|
4637
|
+
query_params,
|
|
4638
|
+
undefined,
|
|
4639
|
+
requestHeaders,
|
|
4640
|
+
{ responseHeaders }
|
|
4641
|
+
);
|
|
4642
|
+
|
|
4643
|
+
let responseData = response;
|
|
4644
|
+
if (responseHeaders) {
|
|
4645
|
+
responseData = response[0];
|
|
4646
|
+
}
|
|
4647
|
+
|
|
4648
|
+
const {
|
|
4649
|
+
error: res_error,
|
|
4650
|
+
} = CatalogPlatformModel.FollowedProducts().validate(responseData, {
|
|
4651
|
+
abortEarly: false,
|
|
4652
|
+
allowUnknown: true,
|
|
4653
|
+
});
|
|
4654
|
+
|
|
4655
|
+
if (res_error) {
|
|
4656
|
+
if (this.config.options.strictResponseCheck === true) {
|
|
4657
|
+
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
4658
|
+
} else {
|
|
4659
|
+
Logger({
|
|
4660
|
+
level: "WARN",
|
|
4661
|
+
message: `Response Validation Warnings for platform > Catalog > getFollowedProducts \n ${res_error}`,
|
|
4662
|
+
});
|
|
4663
|
+
}
|
|
4664
|
+
}
|
|
4665
|
+
|
|
4666
|
+
return response;
|
|
4667
|
+
}
|
|
4668
|
+
|
|
4497
4669
|
/**
|
|
4498
4670
|
* @param {CatalogPlatformApplicationValidator.GetGroupConfigurationsParam} arg
|
|
4499
4671
|
* - Arg object
|
|
@@ -5000,6 +5172,90 @@ class Catalog {
|
|
|
5000
5172
|
return response;
|
|
5001
5173
|
}
|
|
5002
5174
|
|
|
5175
|
+
/**
|
|
5176
|
+
* @param {CatalogPlatformApplicationValidator.UnfollowProductByIdParam} arg
|
|
5177
|
+
* - Arg object
|
|
5178
|
+
*
|
|
5179
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
5180
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
5181
|
+
* @returns {Promise<CatalogPlatformModel.FollowProduct>} - Success response
|
|
5182
|
+
* @name unfollowProductById
|
|
5183
|
+
* @summary: Unfollow a Specific Product by ID
|
|
5184
|
+
* @description: This endpoint allows a user to unfollow a previously followed product using its unique item ID for a sales channel.
|
|
5185
|
+
* - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/unfollowProductById/).
|
|
5186
|
+
*/
|
|
5187
|
+
async unfollowProductById(
|
|
5188
|
+
{ userId, itemId, requestHeaders } = { requestHeaders: {} },
|
|
5189
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
5190
|
+
) {
|
|
5191
|
+
const {
|
|
5192
|
+
error,
|
|
5193
|
+
} = CatalogPlatformApplicationValidator.unfollowProductById().validate(
|
|
5194
|
+
{
|
|
5195
|
+
userId,
|
|
5196
|
+
itemId,
|
|
5197
|
+
},
|
|
5198
|
+
{ abortEarly: false, allowUnknown: true }
|
|
5199
|
+
);
|
|
5200
|
+
if (error) {
|
|
5201
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
5202
|
+
}
|
|
5203
|
+
|
|
5204
|
+
// Showing warrnings if extra unknown parameters are found
|
|
5205
|
+
const {
|
|
5206
|
+
error: warrning,
|
|
5207
|
+
} = CatalogPlatformApplicationValidator.unfollowProductById().validate(
|
|
5208
|
+
{
|
|
5209
|
+
userId,
|
|
5210
|
+
itemId,
|
|
5211
|
+
},
|
|
5212
|
+
{ abortEarly: false, allowUnknown: false }
|
|
5213
|
+
);
|
|
5214
|
+
if (warrning) {
|
|
5215
|
+
Logger({
|
|
5216
|
+
level: "WARN",
|
|
5217
|
+
message: `Parameter Validation warrnings for platform > Catalog > unfollowProductById \n ${warrning}`,
|
|
5218
|
+
});
|
|
5219
|
+
}
|
|
5220
|
+
|
|
5221
|
+
const query_params = {};
|
|
5222
|
+
|
|
5223
|
+
const response = await PlatformAPIClient.execute(
|
|
5224
|
+
this.config,
|
|
5225
|
+
"delete",
|
|
5226
|
+
`/service/platform/catalog/v1.0/company/${this.config.companyId}/application/${this.applicationId}/user/${userId}/products/${itemId}/follow`,
|
|
5227
|
+
query_params,
|
|
5228
|
+
undefined,
|
|
5229
|
+
requestHeaders,
|
|
5230
|
+
{ responseHeaders }
|
|
5231
|
+
);
|
|
5232
|
+
|
|
5233
|
+
let responseData = response;
|
|
5234
|
+
if (responseHeaders) {
|
|
5235
|
+
responseData = response[0];
|
|
5236
|
+
}
|
|
5237
|
+
|
|
5238
|
+
const {
|
|
5239
|
+
error: res_error,
|
|
5240
|
+
} = CatalogPlatformModel.FollowProduct().validate(responseData, {
|
|
5241
|
+
abortEarly: false,
|
|
5242
|
+
allowUnknown: true,
|
|
5243
|
+
});
|
|
5244
|
+
|
|
5245
|
+
if (res_error) {
|
|
5246
|
+
if (this.config.options.strictResponseCheck === true) {
|
|
5247
|
+
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
5248
|
+
} else {
|
|
5249
|
+
Logger({
|
|
5250
|
+
level: "WARN",
|
|
5251
|
+
message: `Response Validation Warnings for platform > Catalog > unfollowProductById \n ${res_error}`,
|
|
5252
|
+
});
|
|
5253
|
+
}
|
|
5254
|
+
}
|
|
5255
|
+
|
|
5256
|
+
return response;
|
|
5257
|
+
}
|
|
5258
|
+
|
|
5003
5259
|
/**
|
|
5004
5260
|
* @param {CatalogPlatformApplicationValidator.UpdateAllowSingleParam} arg
|
|
5005
5261
|
* - Arg object
|
|
@@ -92,6 +92,11 @@ export = CatalogPlatformApplicationValidator;
|
|
|
92
92
|
* @property {string} id - A `id` is a unique identifier for a particular
|
|
93
93
|
* detail. Pass the `id` of the keywords which you want to delete.
|
|
94
94
|
*/
|
|
95
|
+
/**
|
|
96
|
+
* @typedef FollowProductByIdParam
|
|
97
|
+
* @property {string} userId - User ID of User
|
|
98
|
+
* @property {string} itemId - Item ID of Product
|
|
99
|
+
*/
|
|
95
100
|
/**
|
|
96
101
|
* @typedef GetAllCollectionsParam
|
|
97
102
|
* @property {string} [q] - Get collection list filtered by q string,
|
|
@@ -331,6 +336,13 @@ export = CatalogPlatformApplicationValidator;
|
|
|
331
336
|
* Default is 12.
|
|
332
337
|
* @property {number[]} [locationIds] - Search by store ids.
|
|
333
338
|
*/
|
|
339
|
+
/**
|
|
340
|
+
* @typedef GetFollowedProductsParam
|
|
341
|
+
* @property {string} userId - User ID to fetch the followed list
|
|
342
|
+
* @property {string} [pageId] - The identifier used to retrieve the next set of
|
|
343
|
+
* results. This parameter follows cursor-based pagination.
|
|
344
|
+
* @property {number} [pageSize] - Number of items per page
|
|
345
|
+
*/
|
|
334
346
|
/**
|
|
335
347
|
* @typedef GetGroupConfigurationsParam
|
|
336
348
|
* @property {string} configType - A `config_type` is an identifier that defines
|
|
@@ -366,6 +378,11 @@ export = CatalogPlatformApplicationValidator;
|
|
|
366
378
|
* @property {string} id - A `id` is a unique identifier for a particular
|
|
367
379
|
* detail. Pass the `id` of the keywords which you want to retrieve.
|
|
368
380
|
*/
|
|
381
|
+
/**
|
|
382
|
+
* @typedef UnfollowProductByIdParam
|
|
383
|
+
* @property {string} userId - User ID of User
|
|
384
|
+
* @property {string} itemId - Item ID of Product
|
|
385
|
+
*/
|
|
369
386
|
/**
|
|
370
387
|
* @typedef UpdateAllowSingleParam
|
|
371
388
|
* @property {CatalogPlatformModel.AllowSingleRequestSchema} body
|
|
@@ -484,6 +501,8 @@ declare class CatalogPlatformApplicationValidator {
|
|
|
484
501
|
static deleteSearchConfiguration(): any;
|
|
485
502
|
/** @returns {DeleteSearchKeywordsParam} */
|
|
486
503
|
static deleteSearchKeywords(): DeleteSearchKeywordsParam;
|
|
504
|
+
/** @returns {FollowProductByIdParam} */
|
|
505
|
+
static followProductById(): FollowProductByIdParam;
|
|
487
506
|
/** @returns {GetAllCollectionsParam} */
|
|
488
507
|
static getAllCollections(): GetAllCollectionsParam;
|
|
489
508
|
/** @returns {GetAllSearchKeywordParam} */
|
|
@@ -538,6 +557,8 @@ declare class CatalogPlatformApplicationValidator {
|
|
|
538
557
|
static getDepartments(): any;
|
|
539
558
|
/** @returns {GetDiscountedInventoryBySizeIdentifierParam} */
|
|
540
559
|
static getDiscountedInventoryBySizeIdentifier(): GetDiscountedInventoryBySizeIdentifierParam;
|
|
560
|
+
/** @returns {GetFollowedProductsParam} */
|
|
561
|
+
static getFollowedProducts(): GetFollowedProductsParam;
|
|
541
562
|
/** @returns {GetGroupConfigurationsParam} */
|
|
542
563
|
static getGroupConfigurations(): GetGroupConfigurationsParam;
|
|
543
564
|
/** @returns {GetListingConfigurationsParam} */
|
|
@@ -550,6 +571,8 @@ declare class CatalogPlatformApplicationValidator {
|
|
|
550
571
|
static getSearchConfiguration(): any;
|
|
551
572
|
/** @returns {GetSearchKeywordsParam} */
|
|
552
573
|
static getSearchKeywords(): GetSearchKeywordsParam;
|
|
574
|
+
/** @returns {UnfollowProductByIdParam} */
|
|
575
|
+
static unfollowProductById(): UnfollowProductByIdParam;
|
|
553
576
|
/** @returns {UpdateAllowSingleParam} */
|
|
554
577
|
static updateAllowSingle(): UpdateAllowSingleParam;
|
|
555
578
|
/** @returns {UpdateAppBrandParam} */
|
|
@@ -582,7 +605,7 @@ declare class CatalogPlatformApplicationValidator {
|
|
|
582
605
|
static updateSearchKeywords(): UpdateSearchKeywordsParam;
|
|
583
606
|
}
|
|
584
607
|
declare namespace CatalogPlatformApplicationValidator {
|
|
585
|
-
export { AddCollectionItemsParam, CreateAppCategoryReturnConfigurationParam, CreateAppReturnConfigurationParam, CreateCollectionParam, CreateConfigurationByTypeParam, CreateConfigurationProductListingParam, CreateCustomAutocompleteRuleParam, CreateCustomKeywordParam, CreateGroupConfigurationParam, CreateListingConfigurationParam, CreateSearchConfigurationParam, DeleteAppCategoryReturnConfigurationParam, DeleteAutocompleteKeywordParam, DeleteCollectionParam, DeleteGroupConfigurationParam, DeleteListingConfigurationParam, DeleteSearchConfigurationParam, DeleteSearchKeywordsParam, GetAllCollectionsParam, GetAllSearchKeywordParam, GetAppCategoryReturnConfigParam, GetAppInventoryParam, GetAppLocationsParam, GetAppProductParam, GetAppProductsParam, GetAppReturnConfigurationParam, GetApplicationBrandListingParam, GetApplicationBrandsParam, GetApplicationCategoryListingParam, GetApplicationDepartmentListingParam, GetApplicationFilterKeysParam, GetApplicationFilterValuesParam, GetApplicationProductsParam, GetAutocompleteConfigParam, GetAutocompleteKeywordDetailParam, GetCatalogConfigurationParam, GetCatalogInsightsParam, GetCategoriesParam, GetCollectionDetailParam, GetCollectionItemsParam, GetConfigurationByTypeParam, GetConfigurationMetadataParam, GetConfigurationsParam, GetDepartmentsParam, GetDiscountedInventoryBySizeIdentifierParam, GetGroupConfigurationsParam, GetListingConfigurationsParam, GetProductDetailBySlugParam, GetQueryFiltersParam, GetSearchConfigurationParam, GetSearchKeywordsParam, UpdateAllowSingleParam, UpdateAppBrandParam, UpdateAppCategoryParam, UpdateAppCategoryReturnConfigurationParam, UpdateAppDepartmentParam, UpdateAppLocationParam, UpdateAppProductParam, UpdateAppReturnConfigurationParam, UpdateAutocompleteKeywordParam, UpdateCollectionParam, UpdateDefaultSortParam, UpdateGroupConfigurationParam, UpdateListingConfigurationParam, UpdateSearchConfigurationParam, UpdateSearchKeywordsParam };
|
|
608
|
+
export { AddCollectionItemsParam, CreateAppCategoryReturnConfigurationParam, CreateAppReturnConfigurationParam, CreateCollectionParam, CreateConfigurationByTypeParam, CreateConfigurationProductListingParam, CreateCustomAutocompleteRuleParam, CreateCustomKeywordParam, CreateGroupConfigurationParam, CreateListingConfigurationParam, CreateSearchConfigurationParam, DeleteAppCategoryReturnConfigurationParam, DeleteAutocompleteKeywordParam, DeleteCollectionParam, DeleteGroupConfigurationParam, DeleteListingConfigurationParam, DeleteSearchConfigurationParam, DeleteSearchKeywordsParam, FollowProductByIdParam, GetAllCollectionsParam, GetAllSearchKeywordParam, GetAppCategoryReturnConfigParam, GetAppInventoryParam, GetAppLocationsParam, GetAppProductParam, GetAppProductsParam, GetAppReturnConfigurationParam, GetApplicationBrandListingParam, GetApplicationBrandsParam, GetApplicationCategoryListingParam, GetApplicationDepartmentListingParam, GetApplicationFilterKeysParam, GetApplicationFilterValuesParam, GetApplicationProductsParam, GetAutocompleteConfigParam, GetAutocompleteKeywordDetailParam, GetCatalogConfigurationParam, GetCatalogInsightsParam, GetCategoriesParam, GetCollectionDetailParam, GetCollectionItemsParam, GetConfigurationByTypeParam, GetConfigurationMetadataParam, GetConfigurationsParam, GetDepartmentsParam, GetDiscountedInventoryBySizeIdentifierParam, GetFollowedProductsParam, GetGroupConfigurationsParam, GetListingConfigurationsParam, GetProductDetailBySlugParam, GetQueryFiltersParam, GetSearchConfigurationParam, GetSearchKeywordsParam, UnfollowProductByIdParam, UpdateAllowSingleParam, UpdateAppBrandParam, UpdateAppCategoryParam, UpdateAppCategoryReturnConfigurationParam, UpdateAppDepartmentParam, UpdateAppLocationParam, UpdateAppProductParam, UpdateAppReturnConfigurationParam, UpdateAutocompleteKeywordParam, UpdateCollectionParam, UpdateDefaultSortParam, UpdateGroupConfigurationParam, UpdateListingConfigurationParam, UpdateSearchConfigurationParam, UpdateSearchKeywordsParam };
|
|
586
609
|
}
|
|
587
610
|
type AddCollectionItemsParam = {
|
|
588
611
|
/**
|
|
@@ -713,6 +736,16 @@ type DeleteSearchKeywordsParam = {
|
|
|
713
736
|
*/
|
|
714
737
|
id: string;
|
|
715
738
|
};
|
|
739
|
+
type FollowProductByIdParam = {
|
|
740
|
+
/**
|
|
741
|
+
* - User ID of User
|
|
742
|
+
*/
|
|
743
|
+
userId: string;
|
|
744
|
+
/**
|
|
745
|
+
* - Item ID of Product
|
|
746
|
+
*/
|
|
747
|
+
itemId: string;
|
|
748
|
+
};
|
|
716
749
|
type GetAllCollectionsParam = {
|
|
717
750
|
/**
|
|
718
751
|
* - Get collection list filtered by q string,
|
|
@@ -1204,6 +1237,21 @@ type GetDiscountedInventoryBySizeIdentifierParam = {
|
|
|
1204
1237
|
*/
|
|
1205
1238
|
locationIds?: number[];
|
|
1206
1239
|
};
|
|
1240
|
+
type GetFollowedProductsParam = {
|
|
1241
|
+
/**
|
|
1242
|
+
* - User ID to fetch the followed list
|
|
1243
|
+
*/
|
|
1244
|
+
userId: string;
|
|
1245
|
+
/**
|
|
1246
|
+
* - The identifier used to retrieve the next set of
|
|
1247
|
+
* results. This parameter follows cursor-based pagination.
|
|
1248
|
+
*/
|
|
1249
|
+
pageId?: string;
|
|
1250
|
+
/**
|
|
1251
|
+
* - Number of items per page
|
|
1252
|
+
*/
|
|
1253
|
+
pageSize?: number;
|
|
1254
|
+
};
|
|
1207
1255
|
type GetGroupConfigurationsParam = {
|
|
1208
1256
|
/**
|
|
1209
1257
|
* - A `config_type` is an identifier that defines
|
|
@@ -1266,6 +1314,16 @@ type GetSearchKeywordsParam = {
|
|
|
1266
1314
|
*/
|
|
1267
1315
|
id: string;
|
|
1268
1316
|
};
|
|
1317
|
+
type UnfollowProductByIdParam = {
|
|
1318
|
+
/**
|
|
1319
|
+
* - User ID of User
|
|
1320
|
+
*/
|
|
1321
|
+
userId: string;
|
|
1322
|
+
/**
|
|
1323
|
+
* - Item ID of Product
|
|
1324
|
+
*/
|
|
1325
|
+
itemId: string;
|
|
1326
|
+
};
|
|
1269
1327
|
type UpdateAllowSingleParam = {
|
|
1270
1328
|
body: CatalogPlatformModel.AllowSingleRequestSchema;
|
|
1271
1329
|
};
|
|
@@ -113,6 +113,12 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
|
|
|
113
113
|
* detail. Pass the `id` of the keywords which you want to delete.
|
|
114
114
|
*/
|
|
115
115
|
|
|
116
|
+
/**
|
|
117
|
+
* @typedef FollowProductByIdParam
|
|
118
|
+
* @property {string} userId - User ID of User
|
|
119
|
+
* @property {string} itemId - Item ID of Product
|
|
120
|
+
*/
|
|
121
|
+
|
|
116
122
|
/**
|
|
117
123
|
* @typedef GetAllCollectionsParam
|
|
118
124
|
* @property {string} [q] - Get collection list filtered by q string,
|
|
@@ -379,6 +385,14 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
|
|
|
379
385
|
* @property {number[]} [locationIds] - Search by store ids.
|
|
380
386
|
*/
|
|
381
387
|
|
|
388
|
+
/**
|
|
389
|
+
* @typedef GetFollowedProductsParam
|
|
390
|
+
* @property {string} userId - User ID to fetch the followed list
|
|
391
|
+
* @property {string} [pageId] - The identifier used to retrieve the next set of
|
|
392
|
+
* results. This parameter follows cursor-based pagination.
|
|
393
|
+
* @property {number} [pageSize] - Number of items per page
|
|
394
|
+
*/
|
|
395
|
+
|
|
382
396
|
/**
|
|
383
397
|
* @typedef GetGroupConfigurationsParam
|
|
384
398
|
* @property {string} configType - A `config_type` is an identifier that defines
|
|
@@ -420,6 +434,12 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
|
|
|
420
434
|
* detail. Pass the `id` of the keywords which you want to retrieve.
|
|
421
435
|
*/
|
|
422
436
|
|
|
437
|
+
/**
|
|
438
|
+
* @typedef UnfollowProductByIdParam
|
|
439
|
+
* @property {string} userId - User ID of User
|
|
440
|
+
* @property {string} itemId - Item ID of Product
|
|
441
|
+
*/
|
|
442
|
+
|
|
423
443
|
/**
|
|
424
444
|
* @typedef UpdateAllowSingleParam
|
|
425
445
|
* @property {CatalogPlatformModel.AllowSingleRequestSchema} body
|
|
@@ -654,6 +674,14 @@ class CatalogPlatformApplicationValidator {
|
|
|
654
674
|
}).required();
|
|
655
675
|
}
|
|
656
676
|
|
|
677
|
+
/** @returns {FollowProductByIdParam} */
|
|
678
|
+
static followProductById() {
|
|
679
|
+
return Joi.object({
|
|
680
|
+
userId: Joi.string().allow("").required(),
|
|
681
|
+
itemId: Joi.string().allow("").required(),
|
|
682
|
+
}).required();
|
|
683
|
+
}
|
|
684
|
+
|
|
657
685
|
/** @returns {GetAllCollectionsParam} */
|
|
658
686
|
static getAllCollections() {
|
|
659
687
|
return Joi.object({
|
|
@@ -903,6 +931,15 @@ class CatalogPlatformApplicationValidator {
|
|
|
903
931
|
}).required();
|
|
904
932
|
}
|
|
905
933
|
|
|
934
|
+
/** @returns {GetFollowedProductsParam} */
|
|
935
|
+
static getFollowedProducts() {
|
|
936
|
+
return Joi.object({
|
|
937
|
+
userId: Joi.string().allow("").required(),
|
|
938
|
+
pageId: Joi.string().allow(""),
|
|
939
|
+
pageSize: Joi.number(),
|
|
940
|
+
}).required();
|
|
941
|
+
}
|
|
942
|
+
|
|
906
943
|
/** @returns {GetGroupConfigurationsParam} */
|
|
907
944
|
static getGroupConfigurations() {
|
|
908
945
|
return Joi.object({
|
|
@@ -948,6 +985,14 @@ class CatalogPlatformApplicationValidator {
|
|
|
948
985
|
}).required();
|
|
949
986
|
}
|
|
950
987
|
|
|
988
|
+
/** @returns {UnfollowProductByIdParam} */
|
|
989
|
+
static unfollowProductById() {
|
|
990
|
+
return Joi.object({
|
|
991
|
+
userId: Joi.string().allow("").required(),
|
|
992
|
+
itemId: Joi.string().allow("").required(),
|
|
993
|
+
}).required();
|
|
994
|
+
}
|
|
995
|
+
|
|
951
996
|
/** @returns {UpdateAllowSingleParam} */
|
|
952
997
|
static updateAllowSingle() {
|
|
953
998
|
return Joi.object({
|
|
@@ -632,7 +632,6 @@ export = CatalogPlatformModel;
|
|
|
632
632
|
* @property {string} [template_tag]
|
|
633
633
|
* @property {number} [total]
|
|
634
634
|
* @property {string} [tracking_url]
|
|
635
|
-
* @property {string[]} [tags]
|
|
636
635
|
*/
|
|
637
636
|
/**
|
|
638
637
|
* @typedef BulkProductRequestSchema
|
|
@@ -4253,6 +4252,7 @@ export = CatalogPlatformModel;
|
|
|
4253
4252
|
* either price or quantity.
|
|
4254
4253
|
* @property {string} file_path - URL of the uploaded file containing inventory
|
|
4255
4254
|
* update data.
|
|
4255
|
+
* @property {string[]} [tags] - Tags associated with the inventory update job.
|
|
4256
4256
|
* @property {BulkMeta} [meta]
|
|
4257
4257
|
*/
|
|
4258
4258
|
/**
|
|
@@ -4307,6 +4307,16 @@ export = CatalogPlatformModel;
|
|
|
4307
4307
|
* @property {string} [to_date] - The modified-on date till when the data needs
|
|
4308
4308
|
* to be exported.
|
|
4309
4309
|
*/
|
|
4310
|
+
/**
|
|
4311
|
+
* @typedef FollowedProducts
|
|
4312
|
+
* @property {number[]} [item_ids]
|
|
4313
|
+
* @property {Page} [page]
|
|
4314
|
+
*/
|
|
4315
|
+
/**
|
|
4316
|
+
* @typedef FollowProduct
|
|
4317
|
+
* @property {string} [message] - A message indicating the result of the follow
|
|
4318
|
+
* or unfollow operation.
|
|
4319
|
+
*/
|
|
4310
4320
|
/**
|
|
4311
4321
|
* @typedef ActionPage
|
|
4312
4322
|
* @property {Object} [params] - Parameters that should be considered in path.
|
|
@@ -4402,7 +4412,7 @@ export = CatalogPlatformModel;
|
|
|
4402
4412
|
declare class CatalogPlatformModel {
|
|
4403
4413
|
}
|
|
4404
4414
|
declare namespace CatalogPlatformModel {
|
|
4405
|
-
export { Action, ValidationErrors, AllSizes, AllowSingleRequestSchema, AppCatalogConfiguration, AppCategoryReturnConfig, AppCategoryReturnConfigResponseSchema, AppConfiguration, AppConfigurationDetail, AppConfigurationsSort, ApplicationBrandJson, ApplicationCategoryJson, ApplicationDepartment, ApplicationDepartmentJson, ApplicationDepartmentListingResponseSchema, ApplicationItemMOQ, ApplicationItemMeta, ApplicationItemSeoSitemap, ApplicationItemSEO, ApplicationProductsSchema, ApplicationProductListingResponseSchema, ApplicationStoreJson, AppReturnConfigResponseSchema, ArticleAssignment, ArticleAssignment1, ArticleQuery, ArticleStoreResponseSchema, AssignStore, AssignStoreArticle, AttributeDetailsGroup, AttributeMaster, AttributeMasterDetails, AttributeMasterFilter, AttributeMasterMandatoryDetails, AttributeMasterMeta, AttributeMasterSchema, AttributeSchemaRange, AutoCompleteMedia, AutocompleteAction, AutocompletePageAction, AutocompleteResult, BannerImage, BaseAppCategoryReturnConfig, BaseAppCategoryReturnConfigResponseSchema, Brand, BrandItem, BrandListingResponseSchema, ApplicationBrandListingItemSchema, ApplicationBrandListingSchema, ApplicationCategoryListingSchema, ApplicationCategoryListingItemSchema, BrandMeta, InventoryBrandMeta, BulkAssetResponseSchema, BulkHsnResponseSchema, BulkHsnUpsert, BulkInventoryGet, FailedRecord, BulkInventoryGetItems, BulkMeta, BulkProductJob, BulkJob, BulkProductRequestSchema, BulkResponseSchema, CatalogInsightBrand, CatalogInsightItem, CatalogInsightResponseSchema, CategoriesResponseSchema, Category, CategoryItems, CategoryListingResponseSchema, CategoryMapping, CategoryMappingValues, CategoryResponseSchema, Child, CollectionBadge, CollectionBanner, CollectionCreateResponseSchema, CollectionDetailResponseSchema, CollectionImage, CollectionItem, CollectionItemUpdate, CollectionListingFilter, CollectionListingFilterTag, CollectionListingFilterType, CollectionQuery, CollectionSchedule, CompanyBrandDetail, CompanyMeta, InventoryCompanyMeta, CompanyOptIn, ConfigErrorResponseSchema, ConfigSuccessResponseSchema, ConfigurationBucketPoints, ConfigurationListing, ConfigurationListingFilter, ConfigurationListingFilterConfig, ConfigurationListingFilterValue, ConfigurationListingSort, ConfigurationListingSortConfig, ConfigurationProduct, ConfigurationProductConfig, ConfigurationProductSimilar, ConfigurationProductVariant, ConfigurationProductVariantConfig, CreateAutocompleteKeyword, CreateAutocompleteWordsResponseSchema, CreateCollection, CreateSearchConfigurationRequestSchema, CreateSearchConfigurationResponseSchema, CreateSearchKeyword, CreateUpdateAppReturnConfig, CrossSellingData, CrossSellingResponseSchema, CustomOrder, DateMeta, DefaultKeyRequestSchema, DeleteAppCategoryReturnConfig, DeleteResponseSchema, DeleteSearchConfigurationResponseSchema, Department, DepartmentCategoryTree, DepartmentErrorResponseSchema, DepartmentIdentifier, DepartmentResponseSchema, DepartmentsResponseSchema, DimensionResponseSchema, InventoryDimensionResponseSchema, Document, EntityConfiguration, ErrorResponseSchema, FilerList, RawProduct, RawProductListingResponseSchema, GTIN, AttributeDetail, LatLong, ApplicationLocationAddressSchema, GetAddressSchema, GetAllSizes, GetAppCatalogConfiguration, GetAppCatalogEntityConfiguration, GetAutocompleteWordsData, GetAutocompleteWordsResponseSchema, GetCatalogConfigurationDetailsProduct, GetCatalogConfigurationDetailsSchemaListing, GetCatalogConfigurationMetaData, GetCollectionDetailNest, GetCollectionItemsResponseSchema, GetCollectionListingResponseSchema, GetCollectionQueryOptionResponseSchema, GetCompanySchema, ConditionItem, DataItem, ValueTypeItem, SortTypeItem, GetConfigMetadataResponseSchema, GetConfigMetadataValues, GetConfigResponseSchema, ConfigItem, AttributeConfig, GetDepartment, GetInventories, GetInventoriesResponseSchema, GetLocationSchema, GetOptInPlatform, GetProductBundleCreateResponseSchema, GetProductBundleListingResponseSchema, GetProductBundleResponseSchema, GetProducts, ProductDetails, GetCollectionDetailResponseSchema, CommonResponseSchemaCollection, GetQueryFiltersKeysResponseSchema, GetQueryFiltersResponseSchema, GetCollectionItemsResponseSchemaV2, Page1, CollectionItemSchemaV2, CollectionItemUpdateSchema, CollectionQuerySchemaV2, ProductDetailV2, GetSearchConfigurationResponseSchema, GetSearchWordsData, GetSearchWordsDetailResponseSchema, GetSearchWordsResponseSchema, GlobalValidation, Guide, HSNCodesResponseSchema, HSNData, CreatedBySchema, ModifiedBySchema, HSNDataInsertV2, Hierarchy, HsnCode, HsnCodesListingResponseSchemaV2, HsnCodesObject, HsnUpsert, Image, ImageUrls, InvSize, InventoryBulkRequestSchema, InventoryConfig, InventoryCreateRequestSchema, InventoryExportAdvanceOption, InventoryExportFilter, InventoryExportJob, InventoryExportJobListResponseSchema, InventoryExportQuantityFilter, InventoryExportRequestSchema, InventoryExportResponseSchema, InventoryFailedReason, InventoryJobDetailResponseSchema, InventoryJobFilters, InventoryJobPayload, InventoryPage, AddInventoryRequestPayload, InventoryPayload, InventoryRequestSchema, InventoryRequestSchemaV2, InventoryResponseSchema, InventoryResponseItem, InventoryResponsePaginated, InventorySellerIdentifierResponsePaginated, ApplicationInventorySellerIdentifierResponsePaginated, InventorySellerResponseSchema, ApplicationInventorySellerResponseSchema, InventorySet, InventoryStockResponseSchema, InventoryUpdateResponseSchema, InventoryValidationResponseSchema, InvoiceCredSchema, InvoiceDetailsSchema, ItemQuery, Items, LimitedProductData, SizeGuideItem, ListSizeGuide, LocationDayWiseSchema, LocationIntegrationType, LocationListSchema, LocationManagerSchema, LocationTimingSchema, Logo, MOQData, ManufacturerResponseSchema, InventoryManufacturerResponseSchema, Media, Media1, DepartmentMedia, BrandMedia, Meta, MetaDataListingFilterMetaResponseSchema, MetaDataListingFilterResponseSchema, MetaDataListingResponseSchema, MetaDataListingSortMetaResponseSchema, MetaDataListingSortResponseSchema, MetaFields, NetQuantity, NetQuantityResponseSchema, NextSchedule, LocationPriceRequestSchema, LocationQuantityRequestSchema, LocationPriceQuantitySuccessResponseSchema, OptInPostRequestSchema, OptinCompanyBrandDetailsView, OptinCompanyDetail, OptinCompanyMetrics, OptinStoreDetails, OwnerAppItemResponseSchema, PTErrorResponseSchema, Page, PageResponseSchema, PageResponseType, Price, ProductListingDetailPrice, PriceArticle, PriceMeta, ProdcutTemplateCategoriesResponseSchema, Product, ProductAttributesResponseSchema, ProductBrand, ProductBulkAssets, ProductBulkRequestSchema, ProductBulkRequestList, ProductBundleItem, ProductBundleRequestSchema, ProductBundleUpdateRequestSchema, ProductConfigurationDownloads, ProductUpdateSchemaV2, ProductCreateSchemaV2, ProductDetail, ProductDetailAttribute, ProductDetailGroupedAttribute, ProductDownloadsResponseSchema, CollectionProductFilters, ProductFilters, GetQueryFiltersValuesResponseSchema, ProductFiltersKeysOnly, ProductFiltersKey, ProductQueryFiltersValue, CollectionProductFiltersValue, ProductFiltersValue, CollectionProductListingDetail, ProductCategory, ApplicationCategoryAction, ApplicationCategoryItem, ApplicationProductMedia, ApplicationProductCategoryItem, CategoryPageAction, CategoryQuery, CategoryImage, ProductListingDetail, ActionObject, PageAction, ProductListingPrice, ProductListingResponseSchema, ProductListingResponseV2, ProductPublish, ProductPublished, ProductReturnConfigSchema, ProductReturnConfigBaseSchema, Identifier, SizeDetails, ProductSchemaV2, ProductSize, ProductSizeDeleteDataResponseSchema, ProductSizeDeleteResponseSchema, CollectionProductSortOn, ProductSortOn, ProductTagsViewResponseSchema, CreatedBy, ModifiedBy, ProductTemplate, ProductTemplateDownloadsExport, ProductTemplateExportFilterRequestSchema, ProductTemplateExportResponseSchema, ProductVariants, ProductVariantsResponseSchema, Properties, Quantities, QuantitiesArticle, Quantity, QuantityBase, ReturnConfig, InventoryReturnConfig, ReturnConfig2, ReturnConfigResponseSchema, Sitemap, PageQuery, ApplicationCollectionItemSeoPage, ApplicationCollectionItemSeoAction, ApplicationItemSeoAction, ApplicationItemSeoBreadcrumbs, ApplicationCollectionItemSeoBreadcrumbs, ApplicationItemSeoMetaTagItem, ApplicationItemSeoMetaTags, Metatags, SizePromotionThreshold, SEOData, SearchKeywordResult, SearchableAttribute, SecondLevelChild, SellerPhoneNumber, CollectionSeoDetail, SeoDetail, SetSize, SingleCategoryResponseSchema, SingleProductResponseSchema, Size, SizeDistribution, SizeGuideResponseSchema, StoreAssignResponseSchema, StoreDetail, StoreMeta, SuccessResponseSchema, SuccessResponseObject, TaxIdentifier, TaxSlab, TeaserTag, TemplateDetails, TemplateGlobalValidationData, TemplateValidationData, TemplatesResponseSchema, TemplatesGlobalValidationResponseSchema, TemplatesValidationResponseSchema, ThirdLevelChild, Trader, Trader1, TraderResponseSchema, UpdateCollection, UpdateSearchConfigurationRequestSchema, UpdateSearchConfigurationResponseSchema, CreateMarketplaceOptinResponseSchema, UserCommon, UserDetail, UserDetail1, UserInfo, UserSchema, RequestUserSchema, ValidateIdentifier, ValidateProduct, ValidateSizeGuide, VerifiedBy, WeightResponseSchema, InventoryWeightResponseSchema, BulkInventoryJob, Marketplaces, GetAllMarketplaces, UpdateMarketplaceOptinRequestSchema, UpdateMarketplaceOptinResponseSchema, Filters, ActionPage, ValidationError, Price1, MultiCategoriesSchema, NetQuantitySchema, CustomMeta, PageType };
|
|
4415
|
+
export { Action, ValidationErrors, AllSizes, AllowSingleRequestSchema, AppCatalogConfiguration, AppCategoryReturnConfig, AppCategoryReturnConfigResponseSchema, AppConfiguration, AppConfigurationDetail, AppConfigurationsSort, ApplicationBrandJson, ApplicationCategoryJson, ApplicationDepartment, ApplicationDepartmentJson, ApplicationDepartmentListingResponseSchema, ApplicationItemMOQ, ApplicationItemMeta, ApplicationItemSeoSitemap, ApplicationItemSEO, ApplicationProductsSchema, ApplicationProductListingResponseSchema, ApplicationStoreJson, AppReturnConfigResponseSchema, ArticleAssignment, ArticleAssignment1, ArticleQuery, ArticleStoreResponseSchema, AssignStore, AssignStoreArticle, AttributeDetailsGroup, AttributeMaster, AttributeMasterDetails, AttributeMasterFilter, AttributeMasterMandatoryDetails, AttributeMasterMeta, AttributeMasterSchema, AttributeSchemaRange, AutoCompleteMedia, AutocompleteAction, AutocompletePageAction, AutocompleteResult, BannerImage, BaseAppCategoryReturnConfig, BaseAppCategoryReturnConfigResponseSchema, Brand, BrandItem, BrandListingResponseSchema, ApplicationBrandListingItemSchema, ApplicationBrandListingSchema, ApplicationCategoryListingSchema, ApplicationCategoryListingItemSchema, BrandMeta, InventoryBrandMeta, BulkAssetResponseSchema, BulkHsnResponseSchema, BulkHsnUpsert, BulkInventoryGet, FailedRecord, BulkInventoryGetItems, BulkMeta, BulkProductJob, BulkJob, BulkProductRequestSchema, BulkResponseSchema, CatalogInsightBrand, CatalogInsightItem, CatalogInsightResponseSchema, CategoriesResponseSchema, Category, CategoryItems, CategoryListingResponseSchema, CategoryMapping, CategoryMappingValues, CategoryResponseSchema, Child, CollectionBadge, CollectionBanner, CollectionCreateResponseSchema, CollectionDetailResponseSchema, CollectionImage, CollectionItem, CollectionItemUpdate, CollectionListingFilter, CollectionListingFilterTag, CollectionListingFilterType, CollectionQuery, CollectionSchedule, CompanyBrandDetail, CompanyMeta, InventoryCompanyMeta, CompanyOptIn, ConfigErrorResponseSchema, ConfigSuccessResponseSchema, ConfigurationBucketPoints, ConfigurationListing, ConfigurationListingFilter, ConfigurationListingFilterConfig, ConfigurationListingFilterValue, ConfigurationListingSort, ConfigurationListingSortConfig, ConfigurationProduct, ConfigurationProductConfig, ConfigurationProductSimilar, ConfigurationProductVariant, ConfigurationProductVariantConfig, CreateAutocompleteKeyword, CreateAutocompleteWordsResponseSchema, CreateCollection, CreateSearchConfigurationRequestSchema, CreateSearchConfigurationResponseSchema, CreateSearchKeyword, CreateUpdateAppReturnConfig, CrossSellingData, CrossSellingResponseSchema, CustomOrder, DateMeta, DefaultKeyRequestSchema, DeleteAppCategoryReturnConfig, DeleteResponseSchema, DeleteSearchConfigurationResponseSchema, Department, DepartmentCategoryTree, DepartmentErrorResponseSchema, DepartmentIdentifier, DepartmentResponseSchema, DepartmentsResponseSchema, DimensionResponseSchema, InventoryDimensionResponseSchema, Document, EntityConfiguration, ErrorResponseSchema, FilerList, RawProduct, RawProductListingResponseSchema, GTIN, AttributeDetail, LatLong, ApplicationLocationAddressSchema, GetAddressSchema, GetAllSizes, GetAppCatalogConfiguration, GetAppCatalogEntityConfiguration, GetAutocompleteWordsData, GetAutocompleteWordsResponseSchema, GetCatalogConfigurationDetailsProduct, GetCatalogConfigurationDetailsSchemaListing, GetCatalogConfigurationMetaData, GetCollectionDetailNest, GetCollectionItemsResponseSchema, GetCollectionListingResponseSchema, GetCollectionQueryOptionResponseSchema, GetCompanySchema, ConditionItem, DataItem, ValueTypeItem, SortTypeItem, GetConfigMetadataResponseSchema, GetConfigMetadataValues, GetConfigResponseSchema, ConfigItem, AttributeConfig, GetDepartment, GetInventories, GetInventoriesResponseSchema, GetLocationSchema, GetOptInPlatform, GetProductBundleCreateResponseSchema, GetProductBundleListingResponseSchema, GetProductBundleResponseSchema, GetProducts, ProductDetails, GetCollectionDetailResponseSchema, CommonResponseSchemaCollection, GetQueryFiltersKeysResponseSchema, GetQueryFiltersResponseSchema, GetCollectionItemsResponseSchemaV2, Page1, CollectionItemSchemaV2, CollectionItemUpdateSchema, CollectionQuerySchemaV2, ProductDetailV2, GetSearchConfigurationResponseSchema, GetSearchWordsData, GetSearchWordsDetailResponseSchema, GetSearchWordsResponseSchema, GlobalValidation, Guide, HSNCodesResponseSchema, HSNData, CreatedBySchema, ModifiedBySchema, HSNDataInsertV2, Hierarchy, HsnCode, HsnCodesListingResponseSchemaV2, HsnCodesObject, HsnUpsert, Image, ImageUrls, InvSize, InventoryBulkRequestSchema, InventoryConfig, InventoryCreateRequestSchema, InventoryExportAdvanceOption, InventoryExportFilter, InventoryExportJob, InventoryExportJobListResponseSchema, InventoryExportQuantityFilter, InventoryExportRequestSchema, InventoryExportResponseSchema, InventoryFailedReason, InventoryJobDetailResponseSchema, InventoryJobFilters, InventoryJobPayload, InventoryPage, AddInventoryRequestPayload, InventoryPayload, InventoryRequestSchema, InventoryRequestSchemaV2, InventoryResponseSchema, InventoryResponseItem, InventoryResponsePaginated, InventorySellerIdentifierResponsePaginated, ApplicationInventorySellerIdentifierResponsePaginated, InventorySellerResponseSchema, ApplicationInventorySellerResponseSchema, InventorySet, InventoryStockResponseSchema, InventoryUpdateResponseSchema, InventoryValidationResponseSchema, InvoiceCredSchema, InvoiceDetailsSchema, ItemQuery, Items, LimitedProductData, SizeGuideItem, ListSizeGuide, LocationDayWiseSchema, LocationIntegrationType, LocationListSchema, LocationManagerSchema, LocationTimingSchema, Logo, MOQData, ManufacturerResponseSchema, InventoryManufacturerResponseSchema, Media, Media1, DepartmentMedia, BrandMedia, Meta, MetaDataListingFilterMetaResponseSchema, MetaDataListingFilterResponseSchema, MetaDataListingResponseSchema, MetaDataListingSortMetaResponseSchema, MetaDataListingSortResponseSchema, MetaFields, NetQuantity, NetQuantityResponseSchema, NextSchedule, LocationPriceRequestSchema, LocationQuantityRequestSchema, LocationPriceQuantitySuccessResponseSchema, OptInPostRequestSchema, OptinCompanyBrandDetailsView, OptinCompanyDetail, OptinCompanyMetrics, OptinStoreDetails, OwnerAppItemResponseSchema, PTErrorResponseSchema, Page, PageResponseSchema, PageResponseType, Price, ProductListingDetailPrice, PriceArticle, PriceMeta, ProdcutTemplateCategoriesResponseSchema, Product, ProductAttributesResponseSchema, ProductBrand, ProductBulkAssets, ProductBulkRequestSchema, ProductBulkRequestList, ProductBundleItem, ProductBundleRequestSchema, ProductBundleUpdateRequestSchema, ProductConfigurationDownloads, ProductUpdateSchemaV2, ProductCreateSchemaV2, ProductDetail, ProductDetailAttribute, ProductDetailGroupedAttribute, ProductDownloadsResponseSchema, CollectionProductFilters, ProductFilters, GetQueryFiltersValuesResponseSchema, ProductFiltersKeysOnly, ProductFiltersKey, ProductQueryFiltersValue, CollectionProductFiltersValue, ProductFiltersValue, CollectionProductListingDetail, ProductCategory, ApplicationCategoryAction, ApplicationCategoryItem, ApplicationProductMedia, ApplicationProductCategoryItem, CategoryPageAction, CategoryQuery, CategoryImage, ProductListingDetail, ActionObject, PageAction, ProductListingPrice, ProductListingResponseSchema, ProductListingResponseV2, ProductPublish, ProductPublished, ProductReturnConfigSchema, ProductReturnConfigBaseSchema, Identifier, SizeDetails, ProductSchemaV2, ProductSize, ProductSizeDeleteDataResponseSchema, ProductSizeDeleteResponseSchema, CollectionProductSortOn, ProductSortOn, ProductTagsViewResponseSchema, CreatedBy, ModifiedBy, ProductTemplate, ProductTemplateDownloadsExport, ProductTemplateExportFilterRequestSchema, ProductTemplateExportResponseSchema, ProductVariants, ProductVariantsResponseSchema, Properties, Quantities, QuantitiesArticle, Quantity, QuantityBase, ReturnConfig, InventoryReturnConfig, ReturnConfig2, ReturnConfigResponseSchema, Sitemap, PageQuery, ApplicationCollectionItemSeoPage, ApplicationCollectionItemSeoAction, ApplicationItemSeoAction, ApplicationItemSeoBreadcrumbs, ApplicationCollectionItemSeoBreadcrumbs, ApplicationItemSeoMetaTagItem, ApplicationItemSeoMetaTags, Metatags, SizePromotionThreshold, SEOData, SearchKeywordResult, SearchableAttribute, SecondLevelChild, SellerPhoneNumber, CollectionSeoDetail, SeoDetail, SetSize, SingleCategoryResponseSchema, SingleProductResponseSchema, Size, SizeDistribution, SizeGuideResponseSchema, StoreAssignResponseSchema, StoreDetail, StoreMeta, SuccessResponseSchema, SuccessResponseObject, TaxIdentifier, TaxSlab, TeaserTag, TemplateDetails, TemplateGlobalValidationData, TemplateValidationData, TemplatesResponseSchema, TemplatesGlobalValidationResponseSchema, TemplatesValidationResponseSchema, ThirdLevelChild, Trader, Trader1, TraderResponseSchema, UpdateCollection, UpdateSearchConfigurationRequestSchema, UpdateSearchConfigurationResponseSchema, CreateMarketplaceOptinResponseSchema, UserCommon, UserDetail, UserDetail1, UserInfo, UserSchema, RequestUserSchema, ValidateIdentifier, ValidateProduct, ValidateSizeGuide, VerifiedBy, WeightResponseSchema, InventoryWeightResponseSchema, BulkInventoryJob, Marketplaces, GetAllMarketplaces, UpdateMarketplaceOptinRequestSchema, UpdateMarketplaceOptinResponseSchema, Filters, FollowedProducts, FollowProduct, ActionPage, ValidationError, Price1, MultiCategoriesSchema, NetQuantitySchema, CustomMeta, PageType };
|
|
4406
4416
|
}
|
|
4407
4417
|
/** @returns {Action} */
|
|
4408
4418
|
declare function Action(): Action;
|
|
@@ -5738,7 +5748,6 @@ type BulkJob = {
|
|
|
5738
5748
|
template_tag?: string;
|
|
5739
5749
|
total?: number;
|
|
5740
5750
|
tracking_url?: string;
|
|
5741
|
-
tags?: string[];
|
|
5742
5751
|
};
|
|
5743
5752
|
/** @returns {BulkProductRequestSchema} */
|
|
5744
5753
|
declare function BulkProductRequestSchema(): BulkProductRequestSchema;
|
|
@@ -13669,6 +13678,10 @@ type BulkInventoryJob = {
|
|
|
13669
13678
|
* update data.
|
|
13670
13679
|
*/
|
|
13671
13680
|
file_path: string;
|
|
13681
|
+
/**
|
|
13682
|
+
* - Tags associated with the inventory update job.
|
|
13683
|
+
*/
|
|
13684
|
+
tags?: string[];
|
|
13672
13685
|
meta?: BulkMeta;
|
|
13673
13686
|
};
|
|
13674
13687
|
/** @returns {Marketplaces} */
|
|
@@ -13743,6 +13756,21 @@ type Filters = {
|
|
|
13743
13756
|
*/
|
|
13744
13757
|
to_date?: string;
|
|
13745
13758
|
};
|
|
13759
|
+
/** @returns {FollowedProducts} */
|
|
13760
|
+
declare function FollowedProducts(): FollowedProducts;
|
|
13761
|
+
type FollowedProducts = {
|
|
13762
|
+
item_ids?: number[];
|
|
13763
|
+
page?: Page;
|
|
13764
|
+
};
|
|
13765
|
+
/** @returns {FollowProduct} */
|
|
13766
|
+
declare function FollowProduct(): FollowProduct;
|
|
13767
|
+
type FollowProduct = {
|
|
13768
|
+
/**
|
|
13769
|
+
* - A message indicating the result of the follow
|
|
13770
|
+
* or unfollow operation.
|
|
13771
|
+
*/
|
|
13772
|
+
message?: string;
|
|
13773
|
+
};
|
|
13746
13774
|
/** @returns {ActionPage} */
|
|
13747
13775
|
declare function ActionPage(): ActionPage;
|
|
13748
13776
|
type ActionPage = {
|