@gofynd/fdk-client-javascript 3.25.0 → 3.27.0
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/Catalog/CatalogApplicationClient.d.ts +7 -4
- package/sdk/application/Catalog/CatalogApplicationClient.js +8 -2
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +2 -1
- package/sdk/partner/Theme/ThemePartnerModel.js +3 -0
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +10 -0
- package/sdk/platform/Catalog/CatalogPlatformClient.js +75 -0
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +31 -2
- package/sdk/platform/Catalog/CatalogPlatformModel.js +23 -0
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +5 -1
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +7 -0
- package/sdk/platform/Content/ContentPlatformModel.d.ts +2 -1
- package/sdk/platform/Content/ContentPlatformModel.js +3 -0
- package/sdk/platform/Order/OrderPlatformModel.d.ts +18 -18
- package/sdk/platform/Order/OrderPlatformModel.js +18 -18
- package/sdk/platform/PlatformApplicationClient.d.ts +0 -2
- package/sdk/platform/PlatformApplicationClient.js +0 -4
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +2 -1
- package/sdk/platform/Theme/ThemePlatformModel.js +3 -0
- package/sdk/platform/index.d.ts +0 -1
- package/sdk/platform/index.js +0 -2
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +0 -44
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +0 -263
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +0 -42
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +0 -45
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +0 -136
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +0 -95
package/README.md
CHANGED
|
@@ -234,7 +234,7 @@ console.log("Active Theme: ", response.information.name);
|
|
|
234
234
|
The above code will log the curl command in the console
|
|
235
235
|
|
|
236
236
|
```bash
|
|
237
|
-
curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 3.
|
|
237
|
+
curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 3.27.0' --header 'x-fp-date: 20230222T115108Z' --header 'x-fp-signature: v1.1:1e3ab3b02b5bc626e3c32a37ee844266ade02bbcbaafc28fc7a0e46a76a7a1a8'
|
|
238
238
|
Active Theme: Emerge
|
|
239
239
|
```
|
|
240
240
|
|
package/package.json
CHANGED
|
@@ -344,9 +344,9 @@ declare class Catalog {
|
|
|
344
344
|
* @returns {Promise<ProductSizeSellersResponseV4>} - Success response
|
|
345
345
|
* @name getProductSellersBySlug
|
|
346
346
|
* @summary: List sellers
|
|
347
|
-
* @description: List all sellers offering a specific product identified by its slug and size. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getProductSellersBySlug/).
|
|
347
|
+
* @description: List all sellers offering a specific product identified by its slug and size. Optionally filter the seller list by store name, seller name, or store code using the `q` query parameter. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getProductSellersBySlug/).
|
|
348
348
|
*/
|
|
349
|
-
getProductSellersBySlug({ slug, size, strategy, fulfillmentOptionSlug, pageNo, pageSize, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductSizeSellersResponseV4>;
|
|
349
|
+
getProductSellersBySlug({ slug, size, strategy, fulfillmentOptionSlug, pageNo, pageSize, q, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductSizeSellersResponseV4>;
|
|
350
350
|
/**
|
|
351
351
|
* @param {Object} arg - Arg object.
|
|
352
352
|
* @param {string} arg.slug - A short, human-readable, URL-friendly
|
|
@@ -360,16 +360,19 @@ declare class Catalog {
|
|
|
360
360
|
* @param {string} [arg.fulfillmentOptionSlug] - Specifies the fulfillment
|
|
361
361
|
* method, indicating whether an order is for home delivery or store pickup
|
|
362
362
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
363
|
+
* @param {string} [arg.q] - Filter sellers by matching text against store
|
|
364
|
+
* name, seller name, or store code. Case-insensitive partial match.
|
|
363
365
|
* @returns {Paginator<ProductSizeSellersResponseV4>}
|
|
364
366
|
* @summary: List sellers
|
|
365
|
-
* @description: List all sellers offering a specific product identified by its slug and size.
|
|
367
|
+
* @description: List all sellers offering a specific product identified by its slug and size. Optionally filter the seller list by store name, seller name, or store code using the `q` query parameter.
|
|
366
368
|
*/
|
|
367
|
-
getProductSellersBySlugPaginator({ slug, size, strategy, fulfillmentOptionSlug, pageSize, }?: {
|
|
369
|
+
getProductSellersBySlugPaginator({ slug, size, strategy, fulfillmentOptionSlug, pageSize, q, }?: {
|
|
368
370
|
slug: string;
|
|
369
371
|
size: string;
|
|
370
372
|
strategy?: string;
|
|
371
373
|
fulfillmentOptionSlug?: string;
|
|
372
374
|
pageSize?: number;
|
|
375
|
+
q?: string;
|
|
373
376
|
}): Paginator<ProductSizeSellersResponseV4>;
|
|
374
377
|
/**
|
|
375
378
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -1279,7 +1279,7 @@ class Catalog {
|
|
|
1279
1279
|
* @returns {Promise<ProductSizeSellersResponseV4>} - Success response
|
|
1280
1280
|
* @name getProductSellersBySlug
|
|
1281
1281
|
* @summary: List sellers
|
|
1282
|
-
* @description: List all sellers offering a specific product identified by its slug and size. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getProductSellersBySlug/).
|
|
1282
|
+
* @description: List all sellers offering a specific product identified by its slug and size. Optionally filter the seller list by store name, seller name, or store code using the `q` query parameter. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getProductSellersBySlug/).
|
|
1283
1283
|
*/
|
|
1284
1284
|
async getProductSellersBySlug(
|
|
1285
1285
|
{
|
|
@@ -1289,6 +1289,7 @@ class Catalog {
|
|
|
1289
1289
|
fulfillmentOptionSlug,
|
|
1290
1290
|
pageNo,
|
|
1291
1291
|
pageSize,
|
|
1292
|
+
q,
|
|
1292
1293
|
requestHeaders,
|
|
1293
1294
|
} = { requestHeaders: {} },
|
|
1294
1295
|
{ responseHeaders } = { responseHeaders: false }
|
|
@@ -1307,6 +1308,7 @@ class Catalog {
|
|
|
1307
1308
|
query_params["fulfillment_option_slug"] = fulfillmentOptionSlug;
|
|
1308
1309
|
query_params["page_no"] = pageNo;
|
|
1309
1310
|
query_params["page_size"] = pageSize;
|
|
1311
|
+
query_params["q"] = q;
|
|
1310
1312
|
|
|
1311
1313
|
const xHeaders = {};
|
|
1312
1314
|
|
|
@@ -1344,9 +1346,11 @@ class Catalog {
|
|
|
1344
1346
|
* @param {string} [arg.fulfillmentOptionSlug] - Specifies the fulfillment
|
|
1345
1347
|
* method, indicating whether an order is for home delivery or store pickup
|
|
1346
1348
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
1349
|
+
* @param {string} [arg.q] - Filter sellers by matching text against store
|
|
1350
|
+
* name, seller name, or store code. Case-insensitive partial match.
|
|
1347
1351
|
* @returns {Paginator<ProductSizeSellersResponseV4>}
|
|
1348
1352
|
* @summary: List sellers
|
|
1349
|
-
* @description: List all sellers offering a specific product identified by its slug and size.
|
|
1353
|
+
* @description: List all sellers offering a specific product identified by its slug and size. Optionally filter the seller list by store name, seller name, or store code using the `q` query parameter.
|
|
1350
1354
|
*/
|
|
1351
1355
|
getProductSellersBySlugPaginator({
|
|
1352
1356
|
slug,
|
|
@@ -1354,6 +1358,7 @@ class Catalog {
|
|
|
1354
1358
|
strategy,
|
|
1355
1359
|
fulfillmentOptionSlug,
|
|
1356
1360
|
pageSize,
|
|
1361
|
+
q,
|
|
1357
1362
|
} = {}) {
|
|
1358
1363
|
const paginator = new Paginator();
|
|
1359
1364
|
const callback = async () => {
|
|
@@ -1367,6 +1372,7 @@ class Catalog {
|
|
|
1367
1372
|
fulfillmentOptionSlug: fulfillmentOptionSlug,
|
|
1368
1373
|
pageNo: pageNo,
|
|
1369
1374
|
pageSize: pageSize,
|
|
1375
|
+
q: q,
|
|
1370
1376
|
});
|
|
1371
1377
|
paginator.setPaginator({
|
|
1372
1378
|
hasNext: data.page.has_next ? true : false,
|
|
@@ -656,6 +656,7 @@ export = ThemePartnerModel;
|
|
|
656
656
|
* | "profile-company"
|
|
657
657
|
* | "profile-email"
|
|
658
658
|
* | "profile-phone"
|
|
659
|
+
* | "profile-loyalty-rewards"
|
|
659
660
|
* | "rate-us"
|
|
660
661
|
* | "refer-earn"
|
|
661
662
|
* | "settings"
|
|
@@ -1898,4 +1899,4 @@ type ActionPage = {
|
|
|
1898
1899
|
* @returns {PageType}
|
|
1899
1900
|
*/
|
|
1900
1901
|
declare function PageType(): PageType;
|
|
1901
|
-
type PageType = "about-us" | "addresses" | "blog" | "brands" | "cards" | "cart" | "categories" | "brand" | "category" | "collection" | "collections" | "custom" | "contact-us" | "external" | "faq" | "freshchat" | "home" | "notification-settings" | "orders" | "page" | "policy" | "product" | "product-request" | "products" | "profile" | "profile-order-shipment" | "profile-basic" | "profile-company" | "profile-email" | "profile-phone" | "rate-us" | "refer-earn" | "settings" | "shared-cart" | "tnc" | "track-order" | "wishlist" | "sections" | "form" | "cart-delivery" | "cart-payment" | "cart-review" | "login" | "register" | "shipping-policy" | "return-policy" | "order-status" | "locate-us" | "single-page-checkout" | "request-reattempt" | "files";
|
|
1902
|
+
type PageType = "about-us" | "addresses" | "blog" | "brands" | "cards" | "cart" | "categories" | "brand" | "category" | "collection" | "collections" | "custom" | "contact-us" | "external" | "faq" | "freshchat" | "home" | "notification-settings" | "orders" | "page" | "policy" | "product" | "product-request" | "products" | "profile" | "profile-order-shipment" | "profile-basic" | "profile-company" | "profile-email" | "profile-phone" | "profile-loyalty-rewards" | "rate-us" | "refer-earn" | "settings" | "shared-cart" | "tnc" | "track-order" | "wishlist" | "sections" | "form" | "cart-delivery" | "cart-payment" | "cart-review" | "login" | "register" | "shipping-policy" | "return-policy" | "order-status" | "locate-us" | "single-page-checkout" | "request-reattempt" | "files";
|
|
@@ -748,6 +748,7 @@ const Joi = require("joi");
|
|
|
748
748
|
* | "profile-company"
|
|
749
749
|
* | "profile-email"
|
|
750
750
|
* | "profile-phone"
|
|
751
|
+
* | "profile-loyalty-rewards"
|
|
751
752
|
* | "rate-us"
|
|
752
753
|
* | "refer-earn"
|
|
753
754
|
* | "settings"
|
|
@@ -1743,6 +1744,8 @@ class ThemePartnerModel {
|
|
|
1743
1744
|
|
|
1744
1745
|
"profile-phone",
|
|
1745
1746
|
|
|
1747
|
+
"profile-loyalty-rewards",
|
|
1748
|
+
|
|
1746
1749
|
"rate-us",
|
|
1747
1750
|
|
|
1748
1751
|
"refer-earn",
|
|
@@ -32,6 +32,16 @@ declare class Catalog {
|
|
|
32
32
|
* @description: Execute bulk updates for HSN codes across multiple products. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/bulkHsnCode/).
|
|
33
33
|
*/
|
|
34
34
|
bulkHsnCode({ body, requestHeaders }?: CatalogPlatformValidator.BulkHsnCodeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkHsnResponseSchema>;
|
|
35
|
+
/**
|
|
36
|
+
* @param {CatalogPlatformValidator.CbsOnboardGetParam} arg - Arg object
|
|
37
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
38
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
39
|
+
* @returns {Promise<CatalogPlatformModel.GetCompanySchema>} - Success response
|
|
40
|
+
* @name cbsOnboardGet
|
|
41
|
+
* @summary: Get company profile
|
|
42
|
+
* @description: Retrieves the seller-facing company profile for the specified company. The response includes onboarding metadata, contact and address details, legal documents, and deployment region metadata for the company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/cbsOnboardGet/).
|
|
43
|
+
*/
|
|
44
|
+
cbsOnboardGet({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetCompanySchema>;
|
|
35
45
|
/**
|
|
36
46
|
* @param {CatalogPlatformValidator.CreateBulkInventoryParam} arg - Arg object
|
|
37
47
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -251,6 +251,81 @@ class Catalog {
|
|
|
251
251
|
return response;
|
|
252
252
|
}
|
|
253
253
|
|
|
254
|
+
/**
|
|
255
|
+
* @param {CatalogPlatformValidator.CbsOnboardGetParam} arg - Arg object
|
|
256
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
257
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
258
|
+
* @returns {Promise<CatalogPlatformModel.GetCompanySchema>} - Success response
|
|
259
|
+
* @name cbsOnboardGet
|
|
260
|
+
* @summary: Get company profile
|
|
261
|
+
* @description: Retrieves the seller-facing company profile for the specified company. The response includes onboarding metadata, contact and address details, legal documents, and deployment region metadata for the company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/cbsOnboardGet/).
|
|
262
|
+
*/
|
|
263
|
+
async cbsOnboardGet(
|
|
264
|
+
{ requestHeaders } = { requestHeaders: {} },
|
|
265
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
266
|
+
) {
|
|
267
|
+
const { error } = CatalogPlatformValidator.cbsOnboardGet().validate(
|
|
268
|
+
{},
|
|
269
|
+
{ abortEarly: false, allowUnknown: true }
|
|
270
|
+
);
|
|
271
|
+
if (error) {
|
|
272
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
273
|
+
}
|
|
274
|
+
|
|
275
|
+
// Showing warrnings if extra unknown parameters are found
|
|
276
|
+
const {
|
|
277
|
+
error: warrning,
|
|
278
|
+
} = CatalogPlatformValidator.cbsOnboardGet().validate(
|
|
279
|
+
{},
|
|
280
|
+
{ abortEarly: false, allowUnknown: false }
|
|
281
|
+
);
|
|
282
|
+
if (warrning) {
|
|
283
|
+
Logger({
|
|
284
|
+
level: "WARN",
|
|
285
|
+
message: `Parameter Validation warrnings for platform > Catalog > cbsOnboardGet \n ${warrning}`,
|
|
286
|
+
});
|
|
287
|
+
}
|
|
288
|
+
|
|
289
|
+
const query_params = {};
|
|
290
|
+
|
|
291
|
+
const xHeaders = {};
|
|
292
|
+
|
|
293
|
+
const response = await PlatformAPIClient.execute(
|
|
294
|
+
this.config,
|
|
295
|
+
"get",
|
|
296
|
+
`/service/platform/catalog/v2.0/company/${this.config.companyId}/`,
|
|
297
|
+
query_params,
|
|
298
|
+
undefined,
|
|
299
|
+
{ ...xHeaders, ...requestHeaders },
|
|
300
|
+
{ responseHeaders }
|
|
301
|
+
);
|
|
302
|
+
|
|
303
|
+
let responseData = response;
|
|
304
|
+
if (responseHeaders) {
|
|
305
|
+
responseData = response[0];
|
|
306
|
+
}
|
|
307
|
+
|
|
308
|
+
const {
|
|
309
|
+
error: res_error,
|
|
310
|
+
} = CatalogPlatformModel.GetCompanySchema().validate(responseData, {
|
|
311
|
+
abortEarly: false,
|
|
312
|
+
allowUnknown: true,
|
|
313
|
+
});
|
|
314
|
+
|
|
315
|
+
if (res_error) {
|
|
316
|
+
if (this.config.options.strictResponseCheck === true) {
|
|
317
|
+
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
318
|
+
} else {
|
|
319
|
+
Logger({
|
|
320
|
+
level: "WARN",
|
|
321
|
+
message: `Response Validation Warnings for platform > Catalog > cbsOnboardGet \n ${res_error}`,
|
|
322
|
+
});
|
|
323
|
+
}
|
|
324
|
+
}
|
|
325
|
+
|
|
326
|
+
return response;
|
|
327
|
+
}
|
|
328
|
+
|
|
254
329
|
/**
|
|
255
330
|
* @param {CatalogPlatformValidator.CreateBulkInventoryParam} arg - Arg object
|
|
256
331
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -1574,6 +1574,11 @@ export = CatalogPlatformModel;
|
|
|
1574
1574
|
* @property {string} [pincode] - The postal code or ZIP code associated with the address.
|
|
1575
1575
|
* @property {string} [state] - The state or region where the address is located.
|
|
1576
1576
|
*/
|
|
1577
|
+
/**
|
|
1578
|
+
* @typedef RegionDetailsSchema
|
|
1579
|
+
* @property {string} [slug] - Base region slug.
|
|
1580
|
+
* @property {string} [zone] - Zone or cluster slug.
|
|
1581
|
+
*/
|
|
1577
1582
|
/**
|
|
1578
1583
|
* @typedef GetAllSizes
|
|
1579
1584
|
* @property {AllSizes[]} [all_sizes]
|
|
@@ -1681,6 +1686,10 @@ export = CatalogPlatformModel;
|
|
|
1681
1686
|
* @property {string} [modified_on] - The date and time when the company record
|
|
1682
1687
|
* was last updated.
|
|
1683
1688
|
* @property {string} [name] - The registered name of the company.
|
|
1689
|
+
* @property {string} [region] - Deployment region slug for the company profile.
|
|
1690
|
+
* When the zone is default, this is the region slug; otherwise it is
|
|
1691
|
+
* formatted as region/zone.
|
|
1692
|
+
* @property {RegionDetailsSchema} [region_details]
|
|
1684
1693
|
* @property {string} [reject_reason] - If applicable, the reason why the
|
|
1685
1694
|
* company's application or status was rejected.
|
|
1686
1695
|
* @property {string} [stage] - Current operational stage of the company, such
|
|
@@ -4971,6 +4980,7 @@ export = CatalogPlatformModel;
|
|
|
4971
4980
|
* | "profile-company"
|
|
4972
4981
|
* | "profile-email"
|
|
4973
4982
|
* | "profile-phone"
|
|
4983
|
+
* | "profile-loyalty-rewards"
|
|
4974
4984
|
* | "rate-us"
|
|
4975
4985
|
* | "refer-earn"
|
|
4976
4986
|
* | "settings"
|
|
@@ -4996,7 +5006,7 @@ export = CatalogPlatformModel;
|
|
|
4996
5006
|
declare class CatalogPlatformModel {
|
|
4997
5007
|
}
|
|
4998
5008
|
declare namespace CatalogPlatformModel {
|
|
4999
|
-
export { Action, ValidationErrors, StandardError, AllSizes, AllowSingleRequestSchema, AppCatalogConfiguration, AppCategoryReturnConfig, AppCategoryReturnConfigResponseSchema, AppConfiguration, AppConfigurationDetail, AppConfigurationsSort, SortWeights, CohortWeights, HighSpenderRepeatCustomerWeights, HyperactiveRepeatCustomerWeights, HighSpenderOccasionalCustomerWeights, StandardOccasionalCustomerWeights, DormantPremiumCustomerWeights, BudgetRegularCustomerWeights, HighSpenderRegularCustomerWeights, StandardCustomerAboutToChurnWeights, PremiumCustomerAboutToChurnWeights, HighSpenderCustomerAboutToChurnWeights, StandardDormantCustomerWeights, HighSpenderDormantCustomerWeights, PotentialCustomerWeights, NewCustomerWeights, BudgetRepeatCustomerWeights, AverageSpenderRepeatCustomerWeights, CohortSortingConfiguration, ApplicationBrandJson, ApplicationCategoryJson, ApplicationDepartment, ApplicationDepartmentJson, ApplicationDepartmentListingResponseSchema, ApplicationItemMOQ, Scores, ApplicationItemMeta, ApplicationItemSeoSitemap, ApplicationItemSEO, ApplicationProductsSchema, ApplicationProductListingResponseSchema, ApplicationStoreJson, AppReturnConfigResponseSchema, ArticleStoreResponseSchema, 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, InventoryRecord, 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, GetCollectionListingResponseSchema, GetCollectionQueryOptionResponseSchema, GetCompanySchema, ConditionItem, DataItem, ValueTypeItem, SortTypeItem, GetConfigMetadataResponseSchema, GetConfigMetadataValues, GetConfigResponseSchema, ConfigItem, AttributeConfig, GetDepartment, GetInventories, GetInventoriesResponseSchema, GetLocationSchema, GetOptInPlatform, GetProducts, ProductDetails, GetCollectionDetailResponseSchema, CommonResponseSchemaCollection, GetQueryFiltersKeysResponseSchema, GetQueryFiltersResponseSchema, GetCollectionItemsResponseSchemaV2, CollectionItemV2, 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, BundleDetails, 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, PriceStrategySchema, PriceFactoryResponseSchema, Product, ProductAttributesResponseSchema, ProductBrand, ProductBulkAssets, ProductBulkRequestSchema, ProductBulkRequestList, ProductConfigurationDownloads, ProductCreateSchemaV3, ProductUpdateSchemaV3, ProductPatchSchemaV3, ProductSizePatch, 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, StoreDetail, StoreMeta, SuccessResponseSchema, SuccessResponseObject, TaxIdentifier, TaxIdentifierV3, 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, TaxReqBodyRule, TaxThreshold, TaxComponent, TaxComponentResponseSchema, TaxComponentName, CreateTaxComponentNameRequestSchema, TaxReqBodyVersion, TaxGeoArea, AreaDetails, Country, Area, RegionReference, CreateTaxRequestBody, TaxVersion, UpdateTaxVersionRequestBody, CreateTaxVersionRequestBody, TaxRule, TaxVersionDetail, CreateTax, UpdateTaxRequestBody, TaxRuleItem, TaxRules, TaxVersionPastData, TaxRuleVersion, HSCodeItem, HSCodes, GetTaxComponents, PriceFactoryListItemsSchema, PriceFactoryListResponseSchema, CreatePriceFactoryConfigSchema, UpdatePriceFactoryConfigSchema, PriceFactoryConfigSchema, CurrencyPriceSchema, UpsertPriceFactorySizesSchema, UpsertPriceFactoryProductSchema, PriceFactoryCurrencyPriceSchema, PriceFactorySizesSchema, PriceFactoryProductResponseSchema, PriceFactoryProductListResponseSchema, PriceRange, CurrencyPrice, ProductPrice, AppProductPricesSchema, ActionPage, ValidationError, Price1, MultiCategoriesSchema, NetQuantitySchema, CustomMeta, TaxStatusEnum, TaxVersionScopeEnum, HsTypeEnum, PageType };
|
|
5009
|
+
export { Action, ValidationErrors, StandardError, AllSizes, AllowSingleRequestSchema, AppCatalogConfiguration, AppCategoryReturnConfig, AppCategoryReturnConfigResponseSchema, AppConfiguration, AppConfigurationDetail, AppConfigurationsSort, SortWeights, CohortWeights, HighSpenderRepeatCustomerWeights, HyperactiveRepeatCustomerWeights, HighSpenderOccasionalCustomerWeights, StandardOccasionalCustomerWeights, DormantPremiumCustomerWeights, BudgetRegularCustomerWeights, HighSpenderRegularCustomerWeights, StandardCustomerAboutToChurnWeights, PremiumCustomerAboutToChurnWeights, HighSpenderCustomerAboutToChurnWeights, StandardDormantCustomerWeights, HighSpenderDormantCustomerWeights, PotentialCustomerWeights, NewCustomerWeights, BudgetRepeatCustomerWeights, AverageSpenderRepeatCustomerWeights, CohortSortingConfiguration, ApplicationBrandJson, ApplicationCategoryJson, ApplicationDepartment, ApplicationDepartmentJson, ApplicationDepartmentListingResponseSchema, ApplicationItemMOQ, Scores, ApplicationItemMeta, ApplicationItemSeoSitemap, ApplicationItemSEO, ApplicationProductsSchema, ApplicationProductListingResponseSchema, ApplicationStoreJson, AppReturnConfigResponseSchema, ArticleStoreResponseSchema, 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, InventoryRecord, 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, RegionDetailsSchema, GetAllSizes, GetAppCatalogConfiguration, GetAppCatalogEntityConfiguration, GetAutocompleteWordsData, GetAutocompleteWordsResponseSchema, GetCatalogConfigurationDetailsProduct, GetCatalogConfigurationDetailsSchemaListing, GetCatalogConfigurationMetaData, GetCollectionDetailNest, GetCollectionListingResponseSchema, GetCollectionQueryOptionResponseSchema, GetCompanySchema, ConditionItem, DataItem, ValueTypeItem, SortTypeItem, GetConfigMetadataResponseSchema, GetConfigMetadataValues, GetConfigResponseSchema, ConfigItem, AttributeConfig, GetDepartment, GetInventories, GetInventoriesResponseSchema, GetLocationSchema, GetOptInPlatform, GetProducts, ProductDetails, GetCollectionDetailResponseSchema, CommonResponseSchemaCollection, GetQueryFiltersKeysResponseSchema, GetQueryFiltersResponseSchema, GetCollectionItemsResponseSchemaV2, CollectionItemV2, 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, BundleDetails, 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, PriceStrategySchema, PriceFactoryResponseSchema, Product, ProductAttributesResponseSchema, ProductBrand, ProductBulkAssets, ProductBulkRequestSchema, ProductBulkRequestList, ProductConfigurationDownloads, ProductCreateSchemaV3, ProductUpdateSchemaV3, ProductPatchSchemaV3, ProductSizePatch, 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, StoreDetail, StoreMeta, SuccessResponseSchema, SuccessResponseObject, TaxIdentifier, TaxIdentifierV3, 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, TaxReqBodyRule, TaxThreshold, TaxComponent, TaxComponentResponseSchema, TaxComponentName, CreateTaxComponentNameRequestSchema, TaxReqBodyVersion, TaxGeoArea, AreaDetails, Country, Area, RegionReference, CreateTaxRequestBody, TaxVersion, UpdateTaxVersionRequestBody, CreateTaxVersionRequestBody, TaxRule, TaxVersionDetail, CreateTax, UpdateTaxRequestBody, TaxRuleItem, TaxRules, TaxVersionPastData, TaxRuleVersion, HSCodeItem, HSCodes, GetTaxComponents, PriceFactoryListItemsSchema, PriceFactoryListResponseSchema, CreatePriceFactoryConfigSchema, UpdatePriceFactoryConfigSchema, PriceFactoryConfigSchema, CurrencyPriceSchema, UpsertPriceFactorySizesSchema, UpsertPriceFactoryProductSchema, PriceFactoryCurrencyPriceSchema, PriceFactorySizesSchema, PriceFactoryProductResponseSchema, PriceFactoryProductListResponseSchema, PriceRange, CurrencyPrice, ProductPrice, AppProductPricesSchema, ActionPage, ValidationError, Price1, MultiCategoriesSchema, NetQuantitySchema, CustomMeta, TaxStatusEnum, TaxVersionScopeEnum, HsTypeEnum, PageType };
|
|
5000
5010
|
}
|
|
5001
5011
|
/** @returns {Action} */
|
|
5002
5012
|
declare function Action(): Action;
|
|
@@ -8190,6 +8200,18 @@ type GetAddressSchema = {
|
|
|
8190
8200
|
*/
|
|
8191
8201
|
state?: string;
|
|
8192
8202
|
};
|
|
8203
|
+
/** @returns {RegionDetailsSchema} */
|
|
8204
|
+
declare function RegionDetailsSchema(): RegionDetailsSchema;
|
|
8205
|
+
type RegionDetailsSchema = {
|
|
8206
|
+
/**
|
|
8207
|
+
* - Base region slug.
|
|
8208
|
+
*/
|
|
8209
|
+
slug?: string;
|
|
8210
|
+
/**
|
|
8211
|
+
* - Zone or cluster slug.
|
|
8212
|
+
*/
|
|
8213
|
+
zone?: string;
|
|
8214
|
+
};
|
|
8193
8215
|
/** @returns {GetAllSizes} */
|
|
8194
8216
|
declare function GetAllSizes(): GetAllSizes;
|
|
8195
8217
|
type GetAllSizes = {
|
|
@@ -8393,6 +8415,13 @@ type GetCompanySchema = {
|
|
|
8393
8415
|
* - The registered name of the company.
|
|
8394
8416
|
*/
|
|
8395
8417
|
name?: string;
|
|
8418
|
+
/**
|
|
8419
|
+
* - Deployment region slug for the company profile.
|
|
8420
|
+
* When the zone is default, this is the region slug; otherwise it is
|
|
8421
|
+
* formatted as region/zone.
|
|
8422
|
+
*/
|
|
8423
|
+
region?: string;
|
|
8424
|
+
region_details?: RegionDetailsSchema;
|
|
8396
8425
|
/**
|
|
8397
8426
|
* - If applicable, the reason why the
|
|
8398
8427
|
* company's application or status was rejected.
|
|
@@ -15640,4 +15669,4 @@ type HsTypeEnum = "HS" | "SAC";
|
|
|
15640
15669
|
* @returns {PageType}
|
|
15641
15670
|
*/
|
|
15642
15671
|
declare function PageType(): PageType;
|
|
15643
|
-
type PageType = "about-us" | "addresses" | "blog" | "brands" | "cards" | "cart" | "categories" | "brand" | "category" | "collection" | "collections" | "custom" | "contact-us" | "external" | "faq" | "freshchat" | "home" | "notification-settings" | "orders" | "page" | "policy" | "product" | "product-request" | "products" | "profile" | "profile-order-shipment" | "profile-basic" | "profile-company" | "profile-email" | "profile-phone" | "rate-us" | "refer-earn" | "settings" | "shared-cart" | "tnc" | "track-order" | "wishlist" | "sections" | "form" | "cart-delivery" | "cart-payment" | "cart-review" | "login" | "register" | "shipping-policy" | "return-policy" | "order-status" | "locate-us" | "single-page-checkout" | "request-reattempt" | "files";
|
|
15672
|
+
type PageType = "about-us" | "addresses" | "blog" | "brands" | "cards" | "cart" | "categories" | "brand" | "category" | "collection" | "collections" | "custom" | "contact-us" | "external" | "faq" | "freshchat" | "home" | "notification-settings" | "orders" | "page" | "policy" | "product" | "product-request" | "products" | "profile" | "profile-order-shipment" | "profile-basic" | "profile-company" | "profile-email" | "profile-phone" | "profile-loyalty-rewards" | "rate-us" | "refer-earn" | "settings" | "shared-cart" | "tnc" | "track-order" | "wishlist" | "sections" | "form" | "cart-delivery" | "cart-payment" | "cart-review" | "login" | "register" | "shipping-policy" | "return-policy" | "order-status" | "locate-us" | "single-page-checkout" | "request-reattempt" | "files";
|
|
@@ -1731,6 +1731,12 @@ const Joi = require("joi");
|
|
|
1731
1731
|
* @property {string} [state] - The state or region where the address is located.
|
|
1732
1732
|
*/
|
|
1733
1733
|
|
|
1734
|
+
/**
|
|
1735
|
+
* @typedef RegionDetailsSchema
|
|
1736
|
+
* @property {string} [slug] - Base region slug.
|
|
1737
|
+
* @property {string} [zone] - Zone or cluster slug.
|
|
1738
|
+
*/
|
|
1739
|
+
|
|
1734
1740
|
/**
|
|
1735
1741
|
* @typedef GetAllSizes
|
|
1736
1742
|
* @property {AllSizes[]} [all_sizes]
|
|
@@ -1849,6 +1855,10 @@ const Joi = require("joi");
|
|
|
1849
1855
|
* @property {string} [modified_on] - The date and time when the company record
|
|
1850
1856
|
* was last updated.
|
|
1851
1857
|
* @property {string} [name] - The registered name of the company.
|
|
1858
|
+
* @property {string} [region] - Deployment region slug for the company profile.
|
|
1859
|
+
* When the zone is default, this is the region slug; otherwise it is
|
|
1860
|
+
* formatted as region/zone.
|
|
1861
|
+
* @property {RegionDetailsSchema} [region_details]
|
|
1852
1862
|
* @property {string} [reject_reason] - If applicable, the reason why the
|
|
1853
1863
|
* company's application or status was rejected.
|
|
1854
1864
|
* @property {string} [stage] - Current operational stage of the company, such
|
|
@@ -5453,6 +5463,7 @@ const Joi = require("joi");
|
|
|
5453
5463
|
* | "profile-company"
|
|
5454
5464
|
* | "profile-email"
|
|
5455
5465
|
* | "profile-phone"
|
|
5466
|
+
* | "profile-loyalty-rewards"
|
|
5456
5467
|
* | "rate-us"
|
|
5457
5468
|
* | "refer-earn"
|
|
5458
5469
|
* | "settings"
|
|
@@ -7279,6 +7290,14 @@ class CatalogPlatformModel {
|
|
|
7279
7290
|
});
|
|
7280
7291
|
}
|
|
7281
7292
|
|
|
7293
|
+
/** @returns {RegionDetailsSchema} */
|
|
7294
|
+
static RegionDetailsSchema() {
|
|
7295
|
+
return Joi.object({
|
|
7296
|
+
slug: Joi.string().allow(""),
|
|
7297
|
+
zone: Joi.string().allow(""),
|
|
7298
|
+
});
|
|
7299
|
+
}
|
|
7300
|
+
|
|
7282
7301
|
/** @returns {GetAllSizes} */
|
|
7283
7302
|
static GetAllSizes() {
|
|
7284
7303
|
return Joi.object({
|
|
@@ -7410,6 +7429,8 @@ class CatalogPlatformModel {
|
|
|
7410
7429
|
modified_by: CatalogPlatformModel.UserSchema(),
|
|
7411
7430
|
modified_on: Joi.string().allow(""),
|
|
7412
7431
|
name: Joi.string().allow(""),
|
|
7432
|
+
region: Joi.string().allow(""),
|
|
7433
|
+
region_details: CatalogPlatformModel.RegionDetailsSchema(),
|
|
7413
7434
|
reject_reason: Joi.string().allow(""),
|
|
7414
7435
|
stage: Joi.string().allow(""),
|
|
7415
7436
|
uid: Joi.number(),
|
|
@@ -11316,6 +11337,8 @@ class CatalogPlatformModel {
|
|
|
11316
11337
|
|
|
11317
11338
|
"profile-phone",
|
|
11318
11339
|
|
|
11340
|
+
"profile-loyalty-rewards",
|
|
11341
|
+
|
|
11319
11342
|
"rate-us",
|
|
11320
11343
|
|
|
11321
11344
|
"refer-earn",
|
|
@@ -13,6 +13,7 @@ export = CatalogPlatformValidator;
|
|
|
13
13
|
* @typedef BulkHsnCodeParam
|
|
14
14
|
* @property {CatalogPlatformModel.BulkHsnUpsert} body
|
|
15
15
|
*/
|
|
16
|
+
/** @typedef CbsOnboardGetParam */
|
|
16
17
|
/**
|
|
17
18
|
* @typedef CreateBulkInventoryParam
|
|
18
19
|
* @property {string} batchId - Batch Id of the bulk create job.
|
|
@@ -535,6 +536,8 @@ declare class CatalogPlatformValidator {
|
|
|
535
536
|
static allSizes(): AllSizesParam;
|
|
536
537
|
/** @returns {BulkHsnCodeParam} */
|
|
537
538
|
static bulkHsnCode(): BulkHsnCodeParam;
|
|
539
|
+
/** @returns {CbsOnboardGetParam} */
|
|
540
|
+
static cbsOnboardGet(): any;
|
|
538
541
|
/** @returns {CreateBulkInventoryParam} */
|
|
539
542
|
static createBulkInventory(): CreateBulkInventoryParam;
|
|
540
543
|
/** @returns {CreateBulkInventoryJobParam} */
|
|
@@ -699,7 +702,7 @@ declare class CatalogPlatformValidator {
|
|
|
699
702
|
static validateProductTemplateSchema(): ValidateProductTemplateSchemaParam;
|
|
700
703
|
}
|
|
701
704
|
declare namespace CatalogPlatformValidator {
|
|
702
|
-
export { AddInventoryParam, AllSizesParam, BulkHsnCodeParam, CreateBulkInventoryParam, CreateBulkInventoryJobParam, CreateBulkProductUploadJobParam, CreateHsCodeParam, CreateInventoryExportParam, CreateInventoryExportJobParam, CreateMarketplaceOptinParam, CreateProductParam, CreateProductAssetsInBulkParam, CreateProductExportJobParam, CreateProductsInBulkParam, CreateSizeGuideParam, CreateTaxParam, CreateTaxComponentNameParam, CreateTaxVersionParam, DeleteBulkInventoryJobParam, DeleteProductParam, DeleteProductBulkJobParam, DeleteRealtimeInventoryParam, DeleteSizeParam, DeleteTaxRuleParam, DeleteTaxVersionParam, DownloadInventoryTemplateViewParam, DownloadProductTemplateViewsParam, EditProductParam, ExportInventoryConfigParam, GetAllProductHsnCodesParam, GetAllTaxRulesParam, GetAttributeParam, GetCategoryDataParam, GetCompanyBrandDetailParam, GetCompanyDetailParam, GetCompanyMetricsParam, GetDepartmentDataParam, GetHsCodesParam, GetHsnCodeParam, GetInventoriesParam, GetInventoryBulkUploadHistoryParam, GetInventoryBySizeParam, GetInventoryBySizeIdentifierParam, GetInventoryExportParam, GetMarketplaceOptinDetailParam, GetMarketplacesParam, GetProductParam, GetProductAssetsInBulkParam, GetProductAttributesParam, GetProductBulkUploadHistoryParam, GetProductExportJobsParam, GetProductSizeParam, GetProductTagsParam, GetProductValidationParam, GetProductsParam, GetSellerInsightsParam, GetSingleProductHSNCodeParam, GetSizeGuideParam, GetSizeGuidesParam, GetStoreDetailParam, GetTaxComponentNamesParam, GetTaxVersionDetailsParam, GetVariantsOfProductsParam, ListCategoriesParam, ListDepartmentsDataParam, ListHSNCodesParam, ListInventoryExportParam, ListProductTemplateParam, ListProductTemplateCategoriesParam, ListProductTemplateExportDetailsParam, ListTemplateBrandTypeValuesParam, PartialUpdateProductParam, UpdateHsnCodeParam, UpdateInventoriesParam, UpdateLocationPriceParam, UpdateLocationQuantityParam, UpdateMarketplaceOptinParam, UpdateRealtimeInventoryParam, UpdateSizeGuideParam, UpdateTaxRuleParam, UpdateTaxVersionParam, ValidateProductGlobalTemplateParam, ValidateProductTemplateParam, ValidateProductTemplateSchemaParam };
|
|
705
|
+
export { AddInventoryParam, AllSizesParam, BulkHsnCodeParam, CbsOnboardGetParam, CreateBulkInventoryParam, CreateBulkInventoryJobParam, CreateBulkProductUploadJobParam, CreateHsCodeParam, CreateInventoryExportParam, CreateInventoryExportJobParam, CreateMarketplaceOptinParam, CreateProductParam, CreateProductAssetsInBulkParam, CreateProductExportJobParam, CreateProductsInBulkParam, CreateSizeGuideParam, CreateTaxParam, CreateTaxComponentNameParam, CreateTaxVersionParam, DeleteBulkInventoryJobParam, DeleteProductParam, DeleteProductBulkJobParam, DeleteRealtimeInventoryParam, DeleteSizeParam, DeleteTaxRuleParam, DeleteTaxVersionParam, DownloadInventoryTemplateViewParam, DownloadProductTemplateViewsParam, EditProductParam, ExportInventoryConfigParam, GetAllProductHsnCodesParam, GetAllTaxRulesParam, GetAttributeParam, GetCategoryDataParam, GetCompanyBrandDetailParam, GetCompanyDetailParam, GetCompanyMetricsParam, GetDepartmentDataParam, GetHsCodesParam, GetHsnCodeParam, GetInventoriesParam, GetInventoryBulkUploadHistoryParam, GetInventoryBySizeParam, GetInventoryBySizeIdentifierParam, GetInventoryExportParam, GetMarketplaceOptinDetailParam, GetMarketplacesParam, GetProductParam, GetProductAssetsInBulkParam, GetProductAttributesParam, GetProductBulkUploadHistoryParam, GetProductExportJobsParam, GetProductSizeParam, GetProductTagsParam, GetProductValidationParam, GetProductsParam, GetSellerInsightsParam, GetSingleProductHSNCodeParam, GetSizeGuideParam, GetSizeGuidesParam, GetStoreDetailParam, GetTaxComponentNamesParam, GetTaxVersionDetailsParam, GetVariantsOfProductsParam, ListCategoriesParam, ListDepartmentsDataParam, ListHSNCodesParam, ListInventoryExportParam, ListProductTemplateParam, ListProductTemplateCategoriesParam, ListProductTemplateExportDetailsParam, ListTemplateBrandTypeValuesParam, PartialUpdateProductParam, UpdateHsnCodeParam, UpdateInventoriesParam, UpdateLocationPriceParam, UpdateLocationQuantityParam, UpdateMarketplaceOptinParam, UpdateRealtimeInventoryParam, UpdateSizeGuideParam, UpdateTaxRuleParam, UpdateTaxVersionParam, ValidateProductGlobalTemplateParam, ValidateProductTemplateParam, ValidateProductTemplateSchemaParam };
|
|
703
706
|
}
|
|
704
707
|
type AddInventoryParam = {
|
|
705
708
|
/**
|
|
@@ -1704,6 +1707,7 @@ type ValidateProductTemplateSchemaParam = {
|
|
|
1704
1707
|
*/
|
|
1705
1708
|
schemaType?: string;
|
|
1706
1709
|
};
|
|
1710
|
+
type CbsOnboardGetParam = any;
|
|
1707
1711
|
type GetCompanyDetailParam = any;
|
|
1708
1712
|
type GetCompanyMetricsParam = any;
|
|
1709
1713
|
type GetInventoryExportParam = any;
|
|
@@ -19,6 +19,8 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
|
|
|
19
19
|
* @property {CatalogPlatformModel.BulkHsnUpsert} body
|
|
20
20
|
*/
|
|
21
21
|
|
|
22
|
+
/** @typedef CbsOnboardGetParam */
|
|
23
|
+
|
|
22
24
|
/**
|
|
23
25
|
* @typedef CreateBulkInventoryParam
|
|
24
26
|
* @property {string} batchId - Batch Id of the bulk create job.
|
|
@@ -639,6 +641,11 @@ class CatalogPlatformValidator {
|
|
|
639
641
|
}).required();
|
|
640
642
|
}
|
|
641
643
|
|
|
644
|
+
/** @returns {CbsOnboardGetParam} */
|
|
645
|
+
static cbsOnboardGet() {
|
|
646
|
+
return Joi.object({}).required();
|
|
647
|
+
}
|
|
648
|
+
|
|
642
649
|
/** @returns {CreateBulkInventoryParam} */
|
|
643
650
|
static createBulkInventory() {
|
|
644
651
|
return Joi.object({
|
|
@@ -1637,6 +1637,7 @@ export = ContentPlatformModel;
|
|
|
1637
1637
|
* | "profile-company"
|
|
1638
1638
|
* | "profile-email"
|
|
1639
1639
|
* | "profile-phone"
|
|
1640
|
+
* | "profile-loyalty-rewards"
|
|
1640
1641
|
* | "rate-us"
|
|
1641
1642
|
* | "refer-earn"
|
|
1642
1643
|
* | "settings"
|
|
@@ -4751,4 +4752,4 @@ type GenerationEntityType = "title" | "description";
|
|
|
4751
4752
|
* @returns {PageType}
|
|
4752
4753
|
*/
|
|
4753
4754
|
declare function PageType(): PageType;
|
|
4754
|
-
type PageType = "about-us" | "addresses" | "blog" | "brands" | "cards" | "cart" | "categories" | "brand" | "category" | "collection" | "collections" | "custom" | "contact-us" | "external" | "faq" | "freshchat" | "home" | "notification-settings" | "orders" | "page" | "policy" | "product" | "product-request" | "products" | "profile" | "profile-order-shipment" | "profile-basic" | "profile-company" | "profile-email" | "profile-phone" | "rate-us" | "refer-earn" | "settings" | "shared-cart" | "tnc" | "track-order" | "wishlist" | "sections" | "form" | "cart-delivery" | "cart-payment" | "cart-review" | "login" | "register" | "shipping-policy" | "return-policy" | "order-status" | "locate-us" | "single-page-checkout" | "request-reattempt" | "files";
|
|
4755
|
+
type PageType = "about-us" | "addresses" | "blog" | "brands" | "cards" | "cart" | "categories" | "brand" | "category" | "collection" | "collections" | "custom" | "contact-us" | "external" | "faq" | "freshchat" | "home" | "notification-settings" | "orders" | "page" | "policy" | "product" | "product-request" | "products" | "profile" | "profile-order-shipment" | "profile-basic" | "profile-company" | "profile-email" | "profile-phone" | "profile-loyalty-rewards" | "rate-us" | "refer-earn" | "settings" | "shared-cart" | "tnc" | "track-order" | "wishlist" | "sections" | "form" | "cart-delivery" | "cart-payment" | "cart-review" | "login" | "register" | "shipping-policy" | "return-policy" | "order-status" | "locate-us" | "single-page-checkout" | "request-reattempt" | "files";
|
|
@@ -1844,6 +1844,7 @@ const Joi = require("joi");
|
|
|
1844
1844
|
* | "profile-company"
|
|
1845
1845
|
* | "profile-email"
|
|
1846
1846
|
* | "profile-phone"
|
|
1847
|
+
* | "profile-loyalty-rewards"
|
|
1847
1848
|
* | "rate-us"
|
|
1848
1849
|
* | "refer-earn"
|
|
1849
1850
|
* | "settings"
|
|
@@ -4115,6 +4116,8 @@ class ContentPlatformModel {
|
|
|
4115
4116
|
|
|
4116
4117
|
"profile-phone",
|
|
4117
4118
|
|
|
4119
|
+
"profile-loyalty-rewards",
|
|
4120
|
+
|
|
4118
4121
|
"rate-us",
|
|
4119
4122
|
|
|
4120
4123
|
"refer-earn",
|
|
@@ -2671,18 +2671,18 @@ export = OrderPlatformModel;
|
|
|
2671
2671
|
*/
|
|
2672
2672
|
/**
|
|
2673
2673
|
* @typedef BundleDetailsSchema
|
|
2674
|
-
* @property {boolean}
|
|
2674
|
+
* @property {boolean} is_base - This serves as the base item, with all other
|
|
2675
2675
|
* items acting as child elements within the bundle to display the hero
|
|
2676
2676
|
* product prominently at the top.
|
|
2677
|
-
* @property {string[]}
|
|
2678
|
-
* @property {string}
|
|
2677
|
+
* @property {string[]} images - An array of image URLs associated with the bundle.
|
|
2678
|
+
* @property {string} group_id - Unique group identifier for the bundle
|
|
2679
2679
|
* generated by seller to club the articles
|
|
2680
|
-
* @property {string}
|
|
2681
|
-
* @property {string}
|
|
2682
|
-
* @property {number}
|
|
2683
|
-
* @property {string}
|
|
2684
|
-
* @property {string}
|
|
2685
|
-
* @property {string}
|
|
2680
|
+
* @property {string} name - Name of the bundle.
|
|
2681
|
+
* @property {string} item_type - Type of the bundle item
|
|
2682
|
+
* @property {number} item_id - Unique identifier of the item.
|
|
2683
|
+
* @property {string} item_code - Item code for the item.
|
|
2684
|
+
* @property {string} item_name - Name of the item.
|
|
2685
|
+
* @property {string} seller_identifier - Identifier for the seller of the bundle.
|
|
2686
2686
|
* @property {number} [bundle_article_quantity] - In orders with multiple
|
|
2687
2687
|
* quantities of the same line item, the line item count remains constant, but
|
|
2688
2688
|
* multiple bundles can exist. To distinguish between these bundles, the
|
|
@@ -11020,40 +11020,40 @@ type BundleDetailsSchema = {
|
|
|
11020
11020
|
* items acting as child elements within the bundle to display the hero
|
|
11021
11021
|
* product prominently at the top.
|
|
11022
11022
|
*/
|
|
11023
|
-
is_base
|
|
11023
|
+
is_base: boolean;
|
|
11024
11024
|
/**
|
|
11025
11025
|
* - An array of image URLs associated with the bundle.
|
|
11026
11026
|
*/
|
|
11027
|
-
images
|
|
11027
|
+
images: string[];
|
|
11028
11028
|
/**
|
|
11029
11029
|
* - Unique group identifier for the bundle
|
|
11030
11030
|
* generated by seller to club the articles
|
|
11031
11031
|
*/
|
|
11032
|
-
group_id
|
|
11032
|
+
group_id: string;
|
|
11033
11033
|
/**
|
|
11034
11034
|
* - Name of the bundle.
|
|
11035
11035
|
*/
|
|
11036
|
-
name
|
|
11036
|
+
name: string;
|
|
11037
11037
|
/**
|
|
11038
11038
|
* - Type of the bundle item
|
|
11039
11039
|
*/
|
|
11040
|
-
item_type
|
|
11040
|
+
item_type: string;
|
|
11041
11041
|
/**
|
|
11042
11042
|
* - Unique identifier of the item.
|
|
11043
11043
|
*/
|
|
11044
|
-
item_id
|
|
11044
|
+
item_id: number;
|
|
11045
11045
|
/**
|
|
11046
11046
|
* - Item code for the item.
|
|
11047
11047
|
*/
|
|
11048
|
-
item_code
|
|
11048
|
+
item_code: string;
|
|
11049
11049
|
/**
|
|
11050
11050
|
* - Name of the item.
|
|
11051
11051
|
*/
|
|
11052
|
-
item_name
|
|
11052
|
+
item_name: string;
|
|
11053
11053
|
/**
|
|
11054
11054
|
* - Identifier for the seller of the bundle.
|
|
11055
11055
|
*/
|
|
11056
|
-
seller_identifier
|
|
11056
|
+
seller_identifier: string;
|
|
11057
11057
|
/**
|
|
11058
11058
|
* - In orders with multiple
|
|
11059
11059
|
* quantities of the same line item, the line item count remains constant, but
|