@gofynd/fdk-client-javascript 1.4.12 → 1.4.13
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 +2 -2
- package/sdk/application/Content/ContentApplicationModel.d.ts +3 -2
- package/sdk/application/Content/ContentApplicationModel.js +5 -2
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +3 -2
- package/sdk/application/Theme/ThemeApplicationModel.js +5 -2
- package/sdk/common/Clickstream.js +12 -0
- package/sdk/common/Constant.d.ts +5 -0
- package/sdk/common/Constant.js +5 -0
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +3 -2
- package/sdk/partner/Theme/ThemePartnerModel.js +5 -2
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +38 -35
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +42 -39
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +27 -23
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +14 -12
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +2 -2
- package/sdk/platform/Catalog/CatalogPlatformClient.js +2 -2
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1107 -232
- package/sdk/platform/Catalog/CatalogPlatformModel.js +466 -224
- package/sdk/platform/Content/ContentPlatformModel.d.ts +3 -2
- package/sdk/platform/Content/ContentPlatformModel.js +5 -2
- package/sdk/platform/Order/OrderPlatformClient.d.ts +5 -49
- package/sdk/platform/Order/OrderPlatformClient.js +32 -328
- package/sdk/platform/Order/OrderPlatformModel.d.ts +2638 -1394
- package/sdk/platform/Order/OrderPlatformModel.js +1068 -1387
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +142 -110
- package/sdk/platform/Order/OrderPlatformValidator.js +64 -91
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +3 -2
- package/sdk/platform/Theme/ThemePlatformModel.js +5 -2
package/README.md
CHANGED
|
@@ -237,7 +237,7 @@ console.log("Active Theme: ", response.information.name);
|
|
|
237
237
|
The above code will log the curl command in the console
|
|
238
238
|
|
|
239
239
|
```bash
|
|
240
|
-
curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 1.4.
|
|
240
|
+
curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 1.4.13' --header 'x-fp-date: 20230222T115108Z' --header 'x-fp-signature: v1.1:1e3ab3b02b5bc626e3c32a37ee844266ade02bbcbaafc28fc7a0e46a76a7a1a8'
|
|
241
241
|
Active Theme: Emerge
|
|
242
242
|
```
|
|
243
243
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@gofynd/fdk-client-javascript",
|
|
3
|
-
"version": "1.4.
|
|
3
|
+
"version": "1.4.13",
|
|
4
4
|
"description": "",
|
|
5
5
|
"main": "index.js",
|
|
6
6
|
"scripts": {
|
|
@@ -19,7 +19,7 @@
|
|
|
19
19
|
"loglevel": "^1.8.1",
|
|
20
20
|
"query-string": "^7.1.3",
|
|
21
21
|
"@gofynd/fp-signature": "^1.0.1",
|
|
22
|
-
"@gofynd/flick": "^1.0.
|
|
22
|
+
"@gofynd/flick": "^1.0.9"
|
|
23
23
|
},
|
|
24
24
|
"devDependencies": {
|
|
25
25
|
"axios-cookiejar-support": "^4.0.6",
|
|
@@ -634,7 +634,8 @@ export = ContentApplicationModel;
|
|
|
634
634
|
* | "register"
|
|
635
635
|
* | "shipping-policy"
|
|
636
636
|
* | "return-policy"
|
|
637
|
-
* | "order-status"
|
|
637
|
+
* | "order-status"
|
|
638
|
+
* | "locate-us"} PageType
|
|
638
639
|
*/
|
|
639
640
|
declare class ContentApplicationModel {
|
|
640
641
|
}
|
|
@@ -2129,4 +2130,4 @@ type ActionPage = {
|
|
|
2129
2130
|
* @returns {PageType}
|
|
2130
2131
|
*/
|
|
2131
2132
|
declare function PageType(): PageType;
|
|
2132
|
-
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-emails" | "profile-phones" | "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";
|
|
2133
|
+
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-emails" | "profile-phones" | "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";
|
|
@@ -707,7 +707,8 @@ const Joi = require("joi");
|
|
|
707
707
|
* | "register"
|
|
708
708
|
* | "shipping-policy"
|
|
709
709
|
* | "return-policy"
|
|
710
|
-
* | "order-status"
|
|
710
|
+
* | "order-status"
|
|
711
|
+
* | "locate-us"} PageType
|
|
711
712
|
*/
|
|
712
713
|
|
|
713
714
|
class ContentApplicationModel {
|
|
@@ -1579,7 +1580,9 @@ class ContentApplicationModel {
|
|
|
1579
1580
|
|
|
1580
1581
|
"return-policy",
|
|
1581
1582
|
|
|
1582
|
-
"order-status"
|
|
1583
|
+
"order-status",
|
|
1584
|
+
|
|
1585
|
+
"locate-us"
|
|
1583
1586
|
);
|
|
1584
1587
|
}
|
|
1585
1588
|
}
|
|
@@ -549,7 +549,8 @@ export = ThemeApplicationModel;
|
|
|
549
549
|
* | "register"
|
|
550
550
|
* | "shipping-policy"
|
|
551
551
|
* | "return-policy"
|
|
552
|
-
* | "order-status"
|
|
552
|
+
* | "order-status"
|
|
553
|
+
* | "locate-us"} PageType
|
|
553
554
|
*/
|
|
554
555
|
declare class ThemeApplicationModel {
|
|
555
556
|
}
|
|
@@ -1709,4 +1710,4 @@ type ActionPage = {
|
|
|
1709
1710
|
* @returns {PageType}
|
|
1710
1711
|
*/
|
|
1711
1712
|
declare function PageType(): PageType;
|
|
1712
|
-
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-emails" | "profile-phones" | "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";
|
|
1713
|
+
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-emails" | "profile-phones" | "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";
|
|
@@ -621,7 +621,8 @@ const Joi = require("joi");
|
|
|
621
621
|
* | "register"
|
|
622
622
|
* | "shipping-policy"
|
|
623
623
|
* | "return-policy"
|
|
624
|
-
* | "order-status"
|
|
624
|
+
* | "order-status"
|
|
625
|
+
* | "locate-us"} PageType
|
|
625
626
|
*/
|
|
626
627
|
|
|
627
628
|
class ThemeApplicationModel {
|
|
@@ -1416,7 +1417,9 @@ class ThemeApplicationModel {
|
|
|
1416
1417
|
|
|
1417
1418
|
"return-policy",
|
|
1418
1419
|
|
|
1419
|
-
"order-status"
|
|
1420
|
+
"order-status",
|
|
1421
|
+
|
|
1422
|
+
"locate-us"
|
|
1420
1423
|
);
|
|
1421
1424
|
}
|
|
1422
1425
|
}
|
|
@@ -350,6 +350,10 @@ if (typeof window != "undefined") {
|
|
|
350
350
|
|
|
351
351
|
window.FPI.event.on("product_list.view", (eventData) => {
|
|
352
352
|
Logger({ level: "DEBUG", message: eventData });
|
|
353
|
+
if (eventData.user && eventData.user.user_id) {
|
|
354
|
+
//re identify user if the payload contains user id
|
|
355
|
+
Clickstream.identify(eventData.user.user_id, {}, false);
|
|
356
|
+
}
|
|
353
357
|
Clickstream.sendEvent("product_listing", {
|
|
354
358
|
event_type: "impression",
|
|
355
359
|
query: sg(() => eventData.slug["q"]),
|
|
@@ -372,6 +376,10 @@ if (typeof window != "undefined") {
|
|
|
372
376
|
|
|
373
377
|
window.FPI.event.on("product.view", (eventData) => {
|
|
374
378
|
Logger({ level: "DEBUG", message: eventData });
|
|
379
|
+
if (eventData.user && eventData.user.user_id) {
|
|
380
|
+
//re identify user if the payload contains user id
|
|
381
|
+
Clickstream.identify(eventData.user.user_id, {}, false);
|
|
382
|
+
}
|
|
375
383
|
const payload = {
|
|
376
384
|
event_type: "click",
|
|
377
385
|
product_id: sg(() => eventData.product["uid"]),
|
|
@@ -410,6 +418,10 @@ if (typeof window != "undefined") {
|
|
|
410
418
|
};
|
|
411
419
|
//filter eventData.data to find the products array and item total
|
|
412
420
|
let products = [];
|
|
421
|
+
if (eventData.user && eventData.user.user_id) {
|
|
422
|
+
//re identify user if the payload contains user id
|
|
423
|
+
Clickstream.identify(eventData.user.user_id, {}, false);
|
|
424
|
+
}
|
|
413
425
|
if (eventData.data && eventData.data.length > 0) {
|
|
414
426
|
products = eventData.data
|
|
415
427
|
.filter((item) => {
|
package/sdk/common/Constant.d.ts
CHANGED
|
@@ -46,6 +46,7 @@ export namespace AVAILABLE_PAGE_TYPE {
|
|
|
46
46
|
const SHIPPING_POLICY: string;
|
|
47
47
|
const RETURN_POLICY: string;
|
|
48
48
|
const ORDER_STATUS: string;
|
|
49
|
+
const LOCATE_US: string;
|
|
49
50
|
}
|
|
50
51
|
export const NAVIGATORS: {
|
|
51
52
|
"about-us": {
|
|
@@ -296,4 +297,8 @@ export const NAVIGATORS: {
|
|
|
296
297
|
name: string;
|
|
297
298
|
link: string;
|
|
298
299
|
};
|
|
300
|
+
"locate-us": {
|
|
301
|
+
name: string;
|
|
302
|
+
link: string;
|
|
303
|
+
};
|
|
299
304
|
};
|
package/sdk/common/Constant.js
CHANGED
|
@@ -46,6 +46,7 @@ const AVAILABLE_PAGE_TYPE = {
|
|
|
46
46
|
SHIPPING_POLICY: "shipping-policy",
|
|
47
47
|
RETURN_POLICY: "return-policy",
|
|
48
48
|
ORDER_STATUS: "order-status",
|
|
49
|
+
LOCATE_US: "locate-us",
|
|
49
50
|
};
|
|
50
51
|
|
|
51
52
|
Object.freeze(AVAILABLE_PAGE_TYPE);
|
|
@@ -329,6 +330,10 @@ const NAVIGATORS = {
|
|
|
329
330
|
name: "Order status",
|
|
330
331
|
link: "/cart/order-status",
|
|
331
332
|
},
|
|
333
|
+
"locate-us": {
|
|
334
|
+
name: "Locate us",
|
|
335
|
+
link: "/locate-us",
|
|
336
|
+
},
|
|
332
337
|
};
|
|
333
338
|
|
|
334
339
|
module.exports = {
|
|
@@ -650,7 +650,8 @@ export = ThemePartnerModel;
|
|
|
650
650
|
* | "register"
|
|
651
651
|
* | "shipping-policy"
|
|
652
652
|
* | "return-policy"
|
|
653
|
-
* | "order-status"
|
|
653
|
+
* | "order-status"
|
|
654
|
+
* | "locate-us"} PageType
|
|
654
655
|
*/
|
|
655
656
|
declare class ThemePartnerModel {
|
|
656
657
|
}
|
|
@@ -1835,4 +1836,4 @@ type ActionPage = {
|
|
|
1835
1836
|
* @returns {PageType}
|
|
1836
1837
|
*/
|
|
1837
1838
|
declare function PageType(): PageType;
|
|
1838
|
-
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-emails" | "profile-phones" | "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";
|
|
1839
|
+
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-emails" | "profile-phones" | "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";
|
|
@@ -739,7 +739,8 @@ const Joi = require("joi");
|
|
|
739
739
|
* | "register"
|
|
740
740
|
* | "shipping-policy"
|
|
741
741
|
* | "return-policy"
|
|
742
|
-
* | "order-status"
|
|
742
|
+
* | "order-status"
|
|
743
|
+
* | "locate-us"} PageType
|
|
743
744
|
*/
|
|
744
745
|
|
|
745
746
|
class ThemePartnerModel {
|
|
@@ -1717,7 +1718,9 @@ class ThemePartnerModel {
|
|
|
1717
1718
|
|
|
1718
1719
|
"return-policy",
|
|
1719
1720
|
|
|
1720
|
-
"order-status"
|
|
1721
|
+
"order-status",
|
|
1722
|
+
|
|
1723
|
+
"locate-us"
|
|
1721
1724
|
);
|
|
1722
1725
|
}
|
|
1723
1726
|
}
|
|
@@ -23,24 +23,24 @@ declare class Catalog {
|
|
|
23
23
|
*
|
|
24
24
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
25
25
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
26
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
26
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponseObject>} - Success response
|
|
27
27
|
* @name createAppCategoryReturnConfiguration
|
|
28
28
|
* @summary: Create return configuration
|
|
29
29
|
* @description: Create Category level sales channel Return Configuration setttings - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createAppCategoryReturnConfiguration/).
|
|
30
30
|
*/
|
|
31
|
-
createAppCategoryReturnConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateAppCategoryReturnConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
31
|
+
createAppCategoryReturnConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateAppCategoryReturnConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseObject>;
|
|
32
32
|
/**
|
|
33
33
|
* @param {CatalogPlatformApplicationValidator.CreateAppReturnConfigurationParam} arg
|
|
34
34
|
* - Arg object
|
|
35
35
|
*
|
|
36
36
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
37
37
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
38
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
38
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponseObject>} - Success response
|
|
39
39
|
* @name createAppReturnConfiguration
|
|
40
40
|
* @summary: Create product return configuration
|
|
41
41
|
* @description: This allows you to configure all return-related settings, such as is_returnable and return window etc. for sales channel level - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createAppReturnConfiguration/).
|
|
42
42
|
*/
|
|
43
|
-
createAppReturnConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateAppReturnConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
43
|
+
createAppReturnConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateAppReturnConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseObject>;
|
|
44
44
|
/**
|
|
45
45
|
* @param {CatalogPlatformApplicationValidator.CreateCollectionParam} arg - Arg object
|
|
46
46
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -473,12 +473,13 @@ declare class Catalog {
|
|
|
473
473
|
*
|
|
474
474
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
475
475
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
476
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
476
|
+
* @returns {Promise<CatalogPlatformModel.ApplicationBrandListingSchema>} -
|
|
477
|
+
* Success response
|
|
477
478
|
* @name getApplicationBrandListing
|
|
478
479
|
* @summary: List sales channel brands
|
|
479
480
|
* @description: Retrieve brand listings related to the sales channel. A brand is the name under which a product is being sold - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationBrandListing/).
|
|
480
481
|
*/
|
|
481
|
-
getApplicationBrandListing({ pageNo, pageSize, q, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationBrandListingParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
482
|
+
getApplicationBrandListing({ pageNo, pageSize, q, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationBrandListingParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ApplicationBrandListingSchema>;
|
|
482
483
|
/**
|
|
483
484
|
* @param {Object} arg - Arg object.
|
|
484
485
|
* @param {string} arg.companyId - A `company_id` is a unique identifier for
|
|
@@ -487,9 +488,9 @@ declare class Catalog {
|
|
|
487
488
|
* identifier for a particular sale channel.
|
|
488
489
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
489
490
|
* page. Default is 12.
|
|
490
|
-
* @param {string} [arg.q] - Search query with brand name.Use this
|
|
491
|
-
* to search brands by brand name.
|
|
492
|
-
* @returns {Paginator<CatalogPlatformModel.
|
|
491
|
+
* @param {string} [arg.q] - Search query with brand name. Use this
|
|
492
|
+
* parameter to search brands by brand name.
|
|
493
|
+
* @returns {Paginator<CatalogPlatformModel.ApplicationBrandListingSchema>}
|
|
493
494
|
* @summary: List sales channel brands
|
|
494
495
|
* @description: Retrieve brand listings related to the sales channel. A brand is the name under which a product is being sold
|
|
495
496
|
*/
|
|
@@ -498,7 +499,7 @@ declare class Catalog {
|
|
|
498
499
|
applicationId: string;
|
|
499
500
|
pageSize?: number;
|
|
500
501
|
q?: string;
|
|
501
|
-
}): Paginator<CatalogPlatformModel.
|
|
502
|
+
}): Paginator<CatalogPlatformModel.ApplicationBrandListingSchema>;
|
|
502
503
|
/**
|
|
503
504
|
* @param {CatalogPlatformApplicationValidator.GetApplicationBrandsParam} arg
|
|
504
505
|
* - Arg object
|
|
@@ -508,7 +509,7 @@ declare class Catalog {
|
|
|
508
509
|
* @returns {Promise<CatalogPlatformModel.BrandListingResponse>} - Success response
|
|
509
510
|
* @name getApplicationBrands
|
|
510
511
|
* @summary: List brands
|
|
511
|
-
* @description: List all the brands
|
|
512
|
+
* @description: List all the brands. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationBrands/).
|
|
512
513
|
*/
|
|
513
514
|
getApplicationBrands({ department, pageNo, pageSize, q, brandId, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationBrandsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BrandListingResponse>;
|
|
514
515
|
/**
|
|
@@ -520,16 +521,16 @@ declare class Catalog {
|
|
|
520
521
|
* @param {string} [arg.department] - The name of the department. Use this
|
|
521
522
|
* parameter to filter products by a particular department. See below the
|
|
522
523
|
* list of available departments. You can retrieve available departments
|
|
523
|
-
* from the
|
|
524
|
+
* from the "v1.0/departments/" API
|
|
524
525
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
525
526
|
* page. Default is 12.
|
|
526
|
-
* @param {string} [arg.q] - Search query with brand name.Use this
|
|
527
|
-
* to search brands by brand name.
|
|
527
|
+
* @param {string} [arg.q] - Search query with brand name. Use this
|
|
528
|
+
* parameter to search brands by brand name.
|
|
528
529
|
* @param {number[]} [arg.brandId] - Helps to sort the brands list on the
|
|
529
530
|
* basis of uid list.
|
|
530
531
|
* @returns {Paginator<CatalogPlatformModel.BrandListingResponse>}
|
|
531
532
|
* @summary: List brands
|
|
532
|
-
* @description: List all the brands
|
|
533
|
+
* @description: List all the brands.
|
|
533
534
|
*/
|
|
534
535
|
getApplicationBrandsPaginator({ companyId, applicationId, department, pageSize, q, brandId, }?: {
|
|
535
536
|
companyId: string;
|
|
@@ -545,12 +546,14 @@ declare class Catalog {
|
|
|
545
546
|
*
|
|
546
547
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
547
548
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
548
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
549
|
+
* @returns {Promise<CatalogPlatformModel.ApplicationCategoryListingSchema>}
|
|
550
|
+
* - Success response
|
|
551
|
+
*
|
|
549
552
|
* @name getApplicationCategoryListing
|
|
550
553
|
* @summary: List sales channel categories
|
|
551
554
|
* @description: Retrieve category listings related to the sales channel , with the ability to filter results based on department ,category names etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationCategoryListing/).
|
|
552
555
|
*/
|
|
553
|
-
getApplicationCategoryListing({ departmentId, pageNo, pageSize, q, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationCategoryListingParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
556
|
+
getApplicationCategoryListing({ departmentId, pageNo, pageSize, q, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationCategoryListingParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ApplicationCategoryListingSchema>;
|
|
554
557
|
/**
|
|
555
558
|
* @param {Object} arg - Arg object.
|
|
556
559
|
* @param {string} arg.companyId - A `company_id` is a unique identifier for
|
|
@@ -561,9 +564,9 @@ declare class Catalog {
|
|
|
561
564
|
* identifier for a particular department.
|
|
562
565
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
563
566
|
* page. Default is 12.
|
|
564
|
-
* @param {string} [arg.q] -
|
|
565
|
-
*
|
|
566
|
-
* @returns {Paginator<CatalogPlatformModel.
|
|
567
|
+
* @param {string} [arg.q] - A search query string. Use this parameter to
|
|
568
|
+
* filter results based on a keyword or specific value.
|
|
569
|
+
* @returns {Paginator<CatalogPlatformModel.ApplicationCategoryListingSchema>}
|
|
567
570
|
* @summary: List sales channel categories
|
|
568
571
|
* @description: Retrieve category listings related to the sales channel , with the ability to filter results based on department ,category names etc.
|
|
569
572
|
*/
|
|
@@ -573,7 +576,7 @@ declare class Catalog {
|
|
|
573
576
|
departmentId?: number;
|
|
574
577
|
pageSize?: number;
|
|
575
578
|
q?: string;
|
|
576
|
-
}): Paginator<CatalogPlatformModel.
|
|
579
|
+
}): Paginator<CatalogPlatformModel.ApplicationCategoryListingSchema>;
|
|
577
580
|
/**
|
|
578
581
|
* @param {CatalogPlatformApplicationValidator.GetApplicationDepartmentListingParam} arg
|
|
579
582
|
* - Arg object
|
|
@@ -596,8 +599,8 @@ declare class Catalog {
|
|
|
596
599
|
* identifier for a particular sale channel.
|
|
597
600
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
598
601
|
* page. Default is 12.
|
|
599
|
-
* @param {string} [arg.q] -
|
|
600
|
-
*
|
|
602
|
+
* @param {string} [arg.q] - A search query string. Use this parameter to
|
|
603
|
+
* filter results based on a keyword or specific value.
|
|
601
604
|
* @returns {Paginator<CatalogPlatformModel.ApplicationDepartmentListingResponse>}
|
|
602
605
|
* @summary: List sales channel departments
|
|
603
606
|
* @description: Retrieve department listings related to the sales channel. Departments are used to categorize similar products, and you can filter the results based on department names
|
|
@@ -901,24 +904,24 @@ declare class Catalog {
|
|
|
901
904
|
* @param {CatalogPlatformApplicationValidator.UpdateAppBrandParam} arg - Arg object
|
|
902
905
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
903
906
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
904
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
907
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponseObject>} - Success response
|
|
905
908
|
* @name updateAppBrand
|
|
906
909
|
* @summary: Update sales channel brand
|
|
907
910
|
* @description: Modify data associated to the brand for that particular sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppBrand/).
|
|
908
911
|
*/
|
|
909
|
-
updateAppBrand({ brandUid, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppBrandParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
912
|
+
updateAppBrand({ brandUid, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppBrandParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseObject>;
|
|
910
913
|
/**
|
|
911
914
|
* @param {CatalogPlatformApplicationValidator.UpdateAppCategoryParam} arg
|
|
912
915
|
* - Arg object
|
|
913
916
|
*
|
|
914
917
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
915
918
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
916
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
919
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponseObject>} - Success response
|
|
917
920
|
* @name updateAppCategory
|
|
918
921
|
* @summary: Update sales channel category
|
|
919
922
|
* @description: Modify category data related to the sales channel . - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppCategory/).
|
|
920
923
|
*/
|
|
921
|
-
updateAppCategory({ categoryUid, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppCategoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
924
|
+
updateAppCategory({ categoryUid, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppCategoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseObject>;
|
|
922
925
|
/**
|
|
923
926
|
* @param {CatalogPlatformApplicationValidator.UpdateAppCategoryReturnConfigurationParam} arg
|
|
924
927
|
* - Arg object
|
|
@@ -937,46 +940,46 @@ declare class Catalog {
|
|
|
937
940
|
*
|
|
938
941
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
939
942
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
940
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
943
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponseObject>} - Success response
|
|
941
944
|
* @name updateAppDepartment
|
|
942
945
|
* @summary: Update sales channel department
|
|
943
946
|
* @description: Modify department data associated to the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppDepartment/).
|
|
944
947
|
*/
|
|
945
|
-
updateAppDepartment({ departmentUid, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppDepartmentParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
948
|
+
updateAppDepartment({ departmentUid, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppDepartmentParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseObject>;
|
|
946
949
|
/**
|
|
947
950
|
* @param {CatalogPlatformApplicationValidator.UpdateAppLocationParam} arg
|
|
948
951
|
* - Arg object
|
|
949
952
|
*
|
|
950
953
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
951
954
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
952
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
955
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponseObject>} - Success response
|
|
953
956
|
* @name updateAppLocation
|
|
954
957
|
* @summary: Update sales channel location
|
|
955
958
|
* @description: Modify location data related to the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppLocation/).
|
|
956
959
|
*/
|
|
957
|
-
updateAppLocation({ storeUid, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppLocationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
960
|
+
updateAppLocation({ storeUid, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppLocationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseObject>;
|
|
958
961
|
/**
|
|
959
962
|
* @param {CatalogPlatformApplicationValidator.UpdateAppProductParam} arg - Arg object
|
|
960
963
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
961
964
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
962
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
965
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponseObject>} - Success response
|
|
963
966
|
* @name updateAppProduct
|
|
964
967
|
* @summary: Update sales channel product
|
|
965
968
|
* @description: Allows to update data associated to a item by its item_id for an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppProduct/).
|
|
966
969
|
*/
|
|
967
|
-
updateAppProduct({ itemId, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
970
|
+
updateAppProduct({ itemId, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseObject>;
|
|
968
971
|
/**
|
|
969
972
|
* @param {CatalogPlatformApplicationValidator.UpdateAppReturnConfigurationParam} arg
|
|
970
973
|
* - Arg object
|
|
971
974
|
*
|
|
972
975
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
973
976
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
974
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
977
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponseObject>} - Success response
|
|
975
978
|
* @name updateAppReturnConfiguration
|
|
976
979
|
* @summary: Update product return configuration
|
|
977
980
|
* @description: Update Return configuration level set for an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppReturnConfiguration/).
|
|
978
981
|
*/
|
|
979
|
-
updateAppReturnConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppReturnConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
982
|
+
updateAppReturnConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppReturnConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseObject>;
|
|
980
983
|
/**
|
|
981
984
|
* @param {CatalogPlatformApplicationValidator.UpdateAutocompleteKeywordParam} arg
|
|
982
985
|
* - Arg object
|