@gofynd/fdk-client-javascript 1.4.12-beta.1 → 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 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.12-beta.1' --header 'x-fp-date: 20230222T115108Z' --header 'x-fp-signature: v1.1:1e3ab3b02b5bc626e3c32a37ee844266ade02bbcbaafc28fc7a0e46a76a7a1a8'
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.12-beta.1",
3
+ "version": "1.4.13",
4
4
  "description": "",
5
5
  "main": "index.js",
6
6
  "scripts": {
@@ -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.SuccessResponse1>} - Success response
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.SuccessResponse1>;
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.SuccessResponse1>} - Success response
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.SuccessResponse1>;
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.BrandListingResponse>} - Success response
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.BrandListingResponse>;
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 parameter
491
- * to search brands by brand name.
492
- * @returns {Paginator<CatalogPlatformModel.BrandListingResponse>}
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.BrandListingResponse>;
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, and have search capabilities on brand uid, name etc - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationBrands/).
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 **v1.0/departments/** API
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 parameter
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, and have search capabilities on brand uid, name etc
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.BrandListingResponse>} - Success response
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.BrandListingResponse>;
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] - Search query with brand name.Use this parameter
565
- * to search brands by brand name.
566
- * @returns {Paginator<CatalogPlatformModel.BrandListingResponse>}
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.BrandListingResponse>;
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] - Search query with brand name.Use this parameter
600
- * to search department by name.
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.SuccessResponse1>} - Success response
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.SuccessResponse1>;
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.SuccessResponse1>} - Success response
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.SuccessResponse1>;
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.SuccessResponse1>} - Success response
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.SuccessResponse1>;
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.SuccessResponse1>} - Success response
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.SuccessResponse1>;
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.SuccessResponse1>} - Success response
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.SuccessResponse1>;
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.SuccessResponse1>} - Success response
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.SuccessResponse1>;
982
+ updateAppReturnConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppReturnConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseObject>;
980
983
  /**
981
984
  * @param {CatalogPlatformApplicationValidator.UpdateAutocompleteKeywordParam} arg
982
985
  * - Arg object
@@ -106,7 +106,7 @@ class Catalog {
106
106
  *
107
107
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
108
108
  * @param {import("../PlatformAPIClient").Options} - Options
109
- * @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
109
+ * @returns {Promise<CatalogPlatformModel.SuccessResponseObject>} - Success response
110
110
  * @name createAppCategoryReturnConfiguration
111
111
  * @summary: Create return configuration
112
112
  * @description: Create Category level sales channel Return Configuration setttings - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createAppCategoryReturnConfiguration/).
@@ -162,7 +162,7 @@ class Catalog {
162
162
 
163
163
  const {
164
164
  error: res_error,
165
- } = CatalogPlatformModel.SuccessResponse1().validate(responseData, {
165
+ } = CatalogPlatformModel.SuccessResponseObject().validate(responseData, {
166
166
  abortEarly: false,
167
167
  allowUnknown: true,
168
168
  });
@@ -187,7 +187,7 @@ class Catalog {
187
187
  *
188
188
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
189
189
  * @param {import("../PlatformAPIClient").Options} - Options
190
- * @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
190
+ * @returns {Promise<CatalogPlatformModel.SuccessResponseObject>} - Success response
191
191
  * @name createAppReturnConfiguration
192
192
  * @summary: Create product return configuration
193
193
  * @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/).
@@ -243,7 +243,7 @@ class Catalog {
243
243
 
244
244
  const {
245
245
  error: res_error,
246
- } = CatalogPlatformModel.SuccessResponse1().validate(responseData, {
246
+ } = CatalogPlatformModel.SuccessResponseObject().validate(responseData, {
247
247
  abortEarly: false,
248
248
  allowUnknown: true,
249
249
  });
@@ -2649,7 +2649,8 @@ class Catalog {
2649
2649
  *
2650
2650
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
2651
2651
  * @param {import("../PlatformAPIClient").Options} - Options
2652
- * @returns {Promise<CatalogPlatformModel.BrandListingResponse>} - Success response
2652
+ * @returns {Promise<CatalogPlatformModel.ApplicationBrandListingSchema>} -
2653
+ * Success response
2653
2654
  * @name getApplicationBrandListing
2654
2655
  * @summary: List sales channel brands
2655
2656
  * @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/).
@@ -2712,10 +2713,10 @@ class Catalog {
2712
2713
 
2713
2714
  const {
2714
2715
  error: res_error,
2715
- } = CatalogPlatformModel.BrandListingResponse().validate(responseData, {
2716
- abortEarly: false,
2717
- allowUnknown: true,
2718
- });
2716
+ } = CatalogPlatformModel.ApplicationBrandListingSchema().validate(
2717
+ responseData,
2718
+ { abortEarly: false, allowUnknown: true }
2719
+ );
2719
2720
 
2720
2721
  if (res_error) {
2721
2722
  if (this.config.options.strictResponseCheck === true) {
@@ -2739,9 +2740,9 @@ class Catalog {
2739
2740
  * identifier for a particular sale channel.
2740
2741
  * @param {number} [arg.pageSize] - Number of items to retrieve in each
2741
2742
  * page. Default is 12.
2742
- * @param {string} [arg.q] - Search query with brand name.Use this parameter
2743
- * to search brands by brand name.
2744
- * @returns {Paginator<CatalogPlatformModel.BrandListingResponse>}
2743
+ * @param {string} [arg.q] - Search query with brand name. Use this
2744
+ * parameter to search brands by brand name.
2745
+ * @returns {Paginator<CatalogPlatformModel.ApplicationBrandListingSchema>}
2745
2746
  * @summary: List sales channel brands
2746
2747
  * @description: Retrieve brand listings related to the sales channel. A brand is the name under which a product is being sold
2747
2748
  */
@@ -2782,7 +2783,7 @@ class Catalog {
2782
2783
  * @returns {Promise<CatalogPlatformModel.BrandListingResponse>} - Success response
2783
2784
  * @name getApplicationBrands
2784
2785
  * @summary: List brands
2785
- * @description: List all the brands, and have search capabilities on brand uid, name etc - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationBrands/).
2786
+ * @description: List all the brands. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationBrands/).
2786
2787
  */
2787
2788
  async getApplicationBrands(
2788
2789
  { department, pageNo, pageSize, q, brandId, requestHeaders } = {
@@ -2878,16 +2879,16 @@ class Catalog {
2878
2879
  * @param {string} [arg.department] - The name of the department. Use this
2879
2880
  * parameter to filter products by a particular department. See below the
2880
2881
  * list of available departments. You can retrieve available departments
2881
- * from the **v1.0/departments/** API
2882
+ * from the "v1.0/departments/" API
2882
2883
  * @param {number} [arg.pageSize] - Number of items to retrieve in each
2883
2884
  * page. Default is 12.
2884
- * @param {string} [arg.q] - Search query with brand name.Use this parameter
2885
- * to search brands by brand name.
2885
+ * @param {string} [arg.q] - Search query with brand name. Use this
2886
+ * parameter to search brands by brand name.
2886
2887
  * @param {number[]} [arg.brandId] - Helps to sort the brands list on the
2887
2888
  * basis of uid list.
2888
2889
  * @returns {Paginator<CatalogPlatformModel.BrandListingResponse>}
2889
2890
  * @summary: List brands
2890
- * @description: List all the brands, and have search capabilities on brand uid, name etc
2891
+ * @description: List all the brands.
2891
2892
  */
2892
2893
  getApplicationBrandsPaginator({
2893
2894
  companyId,
@@ -2927,7 +2928,9 @@ class Catalog {
2927
2928
  *
2928
2929
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
2929
2930
  * @param {import("../PlatformAPIClient").Options} - Options
2930
- * @returns {Promise<CatalogPlatformModel.BrandListingResponse>} - Success response
2931
+ * @returns {Promise<CatalogPlatformModel.ApplicationCategoryListingSchema>}
2932
+ * - Success response
2933
+ *
2931
2934
  * @name getApplicationCategoryListing
2932
2935
  * @summary: List sales channel categories
2933
2936
  * @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/).
@@ -2995,10 +2998,10 @@ class Catalog {
2995
2998
 
2996
2999
  const {
2997
3000
  error: res_error,
2998
- } = CatalogPlatformModel.BrandListingResponse().validate(responseData, {
2999
- abortEarly: false,
3000
- allowUnknown: true,
3001
- });
3001
+ } = CatalogPlatformModel.ApplicationCategoryListingSchema().validate(
3002
+ responseData,
3003
+ { abortEarly: false, allowUnknown: true }
3004
+ );
3002
3005
 
3003
3006
  if (res_error) {
3004
3007
  if (this.config.options.strictResponseCheck === true) {
@@ -3024,9 +3027,9 @@ class Catalog {
3024
3027
  * identifier for a particular department.
3025
3028
  * @param {number} [arg.pageSize] - Number of items to retrieve in each
3026
3029
  * page. Default is 12.
3027
- * @param {string} [arg.q] - Search query with brand name.Use this parameter
3028
- * to search brands by brand name.
3029
- * @returns {Paginator<CatalogPlatformModel.BrandListingResponse>}
3030
+ * @param {string} [arg.q] - A search query string. Use this parameter to
3031
+ * filter results based on a keyword or specific value.
3032
+ * @returns {Paginator<CatalogPlatformModel.ApplicationCategoryListingSchema>}
3030
3033
  * @summary: List sales channel categories
3031
3034
  * @description: Retrieve category listings related to the sales channel , with the ability to filter results based on department ,category names etc.
3032
3035
  */
@@ -3158,8 +3161,8 @@ class Catalog {
3158
3161
  * identifier for a particular sale channel.
3159
3162
  * @param {number} [arg.pageSize] - Number of items to retrieve in each
3160
3163
  * page. Default is 12.
3161
- * @param {string} [arg.q] - Search query with brand name.Use this parameter
3162
- * to search department by name.
3164
+ * @param {string} [arg.q] - A search query string. Use this parameter to
3165
+ * filter results based on a keyword or specific value.
3163
3166
  * @returns {Paginator<CatalogPlatformModel.ApplicationDepartmentListingResponse>}
3164
3167
  * @summary: List sales channel departments
3165
3168
  * @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
@@ -5025,7 +5028,7 @@ class Catalog {
5025
5028
  * @param {CatalogPlatformApplicationValidator.UpdateAppBrandParam} arg - Arg object
5026
5029
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
5027
5030
  * @param {import("../PlatformAPIClient").Options} - Options
5028
- * @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
5031
+ * @returns {Promise<CatalogPlatformModel.SuccessResponseObject>} - Success response
5029
5032
  * @name updateAppBrand
5030
5033
  * @summary: Update sales channel brand
5031
5034
  * @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/).
@@ -5083,7 +5086,7 @@ class Catalog {
5083
5086
 
5084
5087
  const {
5085
5088
  error: res_error,
5086
- } = CatalogPlatformModel.SuccessResponse1().validate(responseData, {
5089
+ } = CatalogPlatformModel.SuccessResponseObject().validate(responseData, {
5087
5090
  abortEarly: false,
5088
5091
  allowUnknown: true,
5089
5092
  });
@@ -5108,7 +5111,7 @@ class Catalog {
5108
5111
  *
5109
5112
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
5110
5113
  * @param {import("../PlatformAPIClient").Options} - Options
5111
- * @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
5114
+ * @returns {Promise<CatalogPlatformModel.SuccessResponseObject>} - Success response
5112
5115
  * @name updateAppCategory
5113
5116
  * @summary: Update sales channel category
5114
5117
  * @description: Modify category data related to the sales channel . - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppCategory/).
@@ -5166,7 +5169,7 @@ class Catalog {
5166
5169
 
5167
5170
  const {
5168
5171
  error: res_error,
5169
- } = CatalogPlatformModel.SuccessResponse1().validate(responseData, {
5172
+ } = CatalogPlatformModel.SuccessResponseObject().validate(responseData, {
5170
5173
  abortEarly: false,
5171
5174
  allowUnknown: true,
5172
5175
  });
@@ -5272,7 +5275,7 @@ class Catalog {
5272
5275
  *
5273
5276
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
5274
5277
  * @param {import("../PlatformAPIClient").Options} - Options
5275
- * @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
5278
+ * @returns {Promise<CatalogPlatformModel.SuccessResponseObject>} - Success response
5276
5279
  * @name updateAppDepartment
5277
5280
  * @summary: Update sales channel department
5278
5281
  * @description: Modify department data associated to the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppDepartment/).
@@ -5330,7 +5333,7 @@ class Catalog {
5330
5333
 
5331
5334
  const {
5332
5335
  error: res_error,
5333
- } = CatalogPlatformModel.SuccessResponse1().validate(responseData, {
5336
+ } = CatalogPlatformModel.SuccessResponseObject().validate(responseData, {
5334
5337
  abortEarly: false,
5335
5338
  allowUnknown: true,
5336
5339
  });
@@ -5355,7 +5358,7 @@ class Catalog {
5355
5358
  *
5356
5359
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
5357
5360
  * @param {import("../PlatformAPIClient").Options} - Options
5358
- * @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
5361
+ * @returns {Promise<CatalogPlatformModel.SuccessResponseObject>} - Success response
5359
5362
  * @name updateAppLocation
5360
5363
  * @summary: Update sales channel location
5361
5364
  * @description: Modify location data related to the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppLocation/).
@@ -5413,7 +5416,7 @@ class Catalog {
5413
5416
 
5414
5417
  const {
5415
5418
  error: res_error,
5416
- } = CatalogPlatformModel.SuccessResponse1().validate(responseData, {
5419
+ } = CatalogPlatformModel.SuccessResponseObject().validate(responseData, {
5417
5420
  abortEarly: false,
5418
5421
  allowUnknown: true,
5419
5422
  });
@@ -5436,7 +5439,7 @@ class Catalog {
5436
5439
  * @param {CatalogPlatformApplicationValidator.UpdateAppProductParam} arg - Arg object
5437
5440
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
5438
5441
  * @param {import("../PlatformAPIClient").Options} - Options
5439
- * @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
5442
+ * @returns {Promise<CatalogPlatformModel.SuccessResponseObject>} - Success response
5440
5443
  * @name updateAppProduct
5441
5444
  * @summary: Update sales channel product
5442
5445
  * @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/).
@@ -5494,7 +5497,7 @@ class Catalog {
5494
5497
 
5495
5498
  const {
5496
5499
  error: res_error,
5497
- } = CatalogPlatformModel.SuccessResponse1().validate(responseData, {
5500
+ } = CatalogPlatformModel.SuccessResponseObject().validate(responseData, {
5498
5501
  abortEarly: false,
5499
5502
  allowUnknown: true,
5500
5503
  });
@@ -5519,7 +5522,7 @@ class Catalog {
5519
5522
  *
5520
5523
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
5521
5524
  * @param {import("../PlatformAPIClient").Options} - Options
5522
- * @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
5525
+ * @returns {Promise<CatalogPlatformModel.SuccessResponseObject>} - Success response
5523
5526
  * @name updateAppReturnConfiguration
5524
5527
  * @summary: Update product return configuration
5525
5528
  * @description: Update Return configuration level set for an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppReturnConfiguration/).
@@ -5575,7 +5578,7 @@ class Catalog {
5575
5578
 
5576
5579
  const {
5577
5580
  error: res_error,
5578
- } = CatalogPlatformModel.SuccessResponse1().validate(responseData, {
5581
+ } = CatalogPlatformModel.SuccessResponseObject().validate(responseData, {
5579
5582
  abortEarly: false,
5580
5583
  allowUnknown: true,
5581
5584
  });