@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.
Files changed (29) hide show
  1. package/README.md +1 -1
  2. package/package.json +2 -2
  3. package/sdk/application/Content/ContentApplicationModel.d.ts +3 -2
  4. package/sdk/application/Content/ContentApplicationModel.js +5 -2
  5. package/sdk/application/Theme/ThemeApplicationModel.d.ts +3 -2
  6. package/sdk/application/Theme/ThemeApplicationModel.js +5 -2
  7. package/sdk/common/Clickstream.js +12 -0
  8. package/sdk/common/Constant.d.ts +5 -0
  9. package/sdk/common/Constant.js +5 -0
  10. package/sdk/partner/Theme/ThemePartnerModel.d.ts +3 -2
  11. package/sdk/partner/Theme/ThemePartnerModel.js +5 -2
  12. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +38 -35
  13. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +42 -39
  14. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +27 -23
  15. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +14 -12
  16. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +2 -2
  17. package/sdk/platform/Catalog/CatalogPlatformClient.js +2 -2
  18. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1107 -232
  19. package/sdk/platform/Catalog/CatalogPlatformModel.js +466 -224
  20. package/sdk/platform/Content/ContentPlatformModel.d.ts +3 -2
  21. package/sdk/platform/Content/ContentPlatformModel.js +5 -2
  22. package/sdk/platform/Order/OrderPlatformClient.d.ts +5 -49
  23. package/sdk/platform/Order/OrderPlatformClient.js +32 -328
  24. package/sdk/platform/Order/OrderPlatformModel.d.ts +2638 -1394
  25. package/sdk/platform/Order/OrderPlatformModel.js +1068 -1387
  26. package/sdk/platform/Order/OrderPlatformValidator.d.ts +142 -110
  27. package/sdk/platform/Order/OrderPlatformValidator.js +64 -91
  28. package/sdk/platform/Theme/ThemePlatformModel.d.ts +3 -2
  29. package/sdk/platform/Theme/ThemePlatformModel.js +5 -2
@@ -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
  });
@@ -193,7 +193,7 @@ export = CatalogPlatformApplicationValidator;
193
193
  * set of results
194
194
  * @property {number} [pageSize] - Number of items to retrieve in each page.
195
195
  * Default is 12.
196
- * @property {string} [q] - Search query with brand name.Use this parameter to
196
+ * @property {string} [q] - Search query with brand name. Use this parameter to
197
197
  * search brands by brand name.
198
198
  */
199
199
  /**
@@ -201,12 +201,12 @@ export = CatalogPlatformApplicationValidator;
201
201
  * @property {string} [department] - The name of the department. Use this
202
202
  * parameter to filter products by a particular department. See below the list
203
203
  * of available departments. You can retrieve available departments from the
204
- * **v1.0/departments/** API
204
+ * "v1.0/departments/" API
205
205
  * @property {number} [pageNo] - The page number to navigate through the given
206
206
  * set of results
207
207
  * @property {number} [pageSize] - Number of items to retrieve in each page.
208
208
  * Default is 12.
209
- * @property {string} [q] - Search query with brand name.Use this parameter to
209
+ * @property {string} [q] - Search query with brand name. Use this parameter to
210
210
  * search brands by brand name.
211
211
  * @property {number[]} [brandId] - Helps to sort the brands list on the basis
212
212
  * of uid list.
@@ -219,8 +219,8 @@ export = CatalogPlatformApplicationValidator;
219
219
  * set of results
220
220
  * @property {number} [pageSize] - Number of items to retrieve in each page.
221
221
  * Default is 12.
222
- * @property {string} [q] - Search query with brand name.Use this parameter to
223
- * search brands by brand name.
222
+ * @property {string} [q] - A search query string. Use this parameter to filter
223
+ * results based on a keyword or specific value.
224
224
  */
225
225
  /**
226
226
  * @typedef GetApplicationDepartmentListingParam
@@ -228,8 +228,8 @@ export = CatalogPlatformApplicationValidator;
228
228
  * set of results
229
229
  * @property {number} [pageSize] - Number of items to retrieve in each page.
230
230
  * Default is 12.
231
- * @property {string} [q] - Search query with brand name.Use this parameter to
232
- * search department by name.
231
+ * @property {string} [q] - A search query string. Use this parameter to filter
232
+ * results based on a keyword or specific value.
233
233
  */
234
234
  /**
235
235
  * @typedef GetApplicationFilterKeysParam
@@ -263,14 +263,14 @@ export = CatalogPlatformApplicationValidator;
263
263
  /** @typedef GetCatalogConfigurationParam */
264
264
  /**
265
265
  * @typedef GetCatalogInsightsParam
266
- * @property {string} [brand] - Brand slug
266
+ * @property {string} [brand] - Brand slug that is to be searched.
267
267
  */
268
268
  /**
269
269
  * @typedef GetCategoriesParam
270
270
  * @property {string} [department] - The name of the department. Use this
271
271
  * parameter to filter products by a particular department. See below the list
272
272
  * of available departments. You can retrieve available departments from the
273
- * **v1.0/departments/** API
273
+ * "v1.0/departments/" API
274
274
  */
275
275
  /**
276
276
  * @typedef GetCollectionDetailParam
@@ -358,12 +358,14 @@ export = CatalogPlatformApplicationValidator;
358
358
  */
359
359
  /**
360
360
  * @typedef UpdateAppBrandParam
361
- * @property {string} brandUid - Brand id for which the custom_json is associated.
361
+ * @property {number} brandUid - A `brand id` is a unique identifier for a
362
+ * particular brand.
362
363
  * @property {CatalogPlatformModel.ApplicationBrandJson} body
363
364
  */
364
365
  /**
365
366
  * @typedef UpdateAppCategoryParam
366
- * @property {string} categoryUid - Category id for which the custom_json is associated.
367
+ * @property {string} categoryUid - A `category id` is a unique identifier for a
368
+ * particular category.
367
369
  * @property {CatalogPlatformModel.ApplicationCategoryJson} body
368
370
  */
369
371
  /**
@@ -924,7 +926,7 @@ type GetApplicationBrandListingParam = {
924
926
  */
925
927
  pageSize?: number;
926
928
  /**
927
- * - Search query with brand name.Use this parameter to
929
+ * - Search query with brand name. Use this parameter to
928
930
  * search brands by brand name.
929
931
  */
930
932
  q?: string;
@@ -934,7 +936,7 @@ type GetApplicationBrandsParam = {
934
936
  * - The name of the department. Use this
935
937
  * parameter to filter products by a particular department. See below the list
936
938
  * of available departments. You can retrieve available departments from the
937
- * **v1.0/departments/** API
939
+ * "v1.0/departments/" API
938
940
  */
939
941
  department?: string;
940
942
  /**
@@ -948,7 +950,7 @@ type GetApplicationBrandsParam = {
948
950
  */
949
951
  pageSize?: number;
950
952
  /**
951
- * - Search query with brand name.Use this parameter to
953
+ * - Search query with brand name. Use this parameter to
952
954
  * search brands by brand name.
953
955
  */
954
956
  q?: string;
@@ -975,8 +977,8 @@ type GetApplicationCategoryListingParam = {
975
977
  */
976
978
  pageSize?: number;
977
979
  /**
978
- * - Search query with brand name.Use this parameter to
979
- * search brands by brand name.
980
+ * - A search query string. Use this parameter to filter
981
+ * results based on a keyword or specific value.
980
982
  */
981
983
  q?: string;
982
984
  };
@@ -992,8 +994,8 @@ type GetApplicationDepartmentListingParam = {
992
994
  */
993
995
  pageSize?: number;
994
996
  /**
995
- * - Search query with brand name.Use this parameter to
996
- * search department by name.
997
+ * - A search query string. Use this parameter to filter
998
+ * results based on a keyword or specific value.
997
999
  */
998
1000
  q?: string;
999
1001
  };
@@ -1048,7 +1050,7 @@ type GetAutocompleteKeywordDetailParam = {
1048
1050
  };
1049
1051
  type GetCatalogInsightsParam = {
1050
1052
  /**
1051
- * - Brand slug
1053
+ * - Brand slug that is to be searched.
1052
1054
  */
1053
1055
  brand?: string;
1054
1056
  };
@@ -1057,7 +1059,7 @@ type GetCategoriesParam = {
1057
1059
  * - The name of the department. Use this
1058
1060
  * parameter to filter products by a particular department. See below the list
1059
1061
  * of available departments. You can retrieve available departments from the
1060
- * **v1.0/departments/** API
1062
+ * "v1.0/departments/" API
1061
1063
  */
1062
1064
  department?: string;
1063
1065
  };
@@ -1217,14 +1219,16 @@ type UpdateAllowSingleParam = {
1217
1219
  };
1218
1220
  type UpdateAppBrandParam = {
1219
1221
  /**
1220
- * - Brand id for which the custom_json is associated.
1222
+ * - A `brand id` is a unique identifier for a
1223
+ * particular brand.
1221
1224
  */
1222
- brandUid: string;
1225
+ brandUid: number;
1223
1226
  body: CatalogPlatformModel.ApplicationBrandJson;
1224
1227
  };
1225
1228
  type UpdateAppCategoryParam = {
1226
1229
  /**
1227
- * - Category id for which the custom_json is associated.
1230
+ * - A `category id` is a unique identifier for a
1231
+ * particular category.
1228
1232
  */
1229
1233
  categoryUid: string;
1230
1234
  body: CatalogPlatformModel.ApplicationCategoryJson;
@@ -223,7 +223,7 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
223
223
  * set of results
224
224
  * @property {number} [pageSize] - Number of items to retrieve in each page.
225
225
  * Default is 12.
226
- * @property {string} [q] - Search query with brand name.Use this parameter to
226
+ * @property {string} [q] - Search query with brand name. Use this parameter to
227
227
  * search brands by brand name.
228
228
  */
229
229
 
@@ -232,12 +232,12 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
232
232
  * @property {string} [department] - The name of the department. Use this
233
233
  * parameter to filter products by a particular department. See below the list
234
234
  * of available departments. You can retrieve available departments from the
235
- * **v1.0/departments/** API
235
+ * "v1.0/departments/" API
236
236
  * @property {number} [pageNo] - The page number to navigate through the given
237
237
  * set of results
238
238
  * @property {number} [pageSize] - Number of items to retrieve in each page.
239
239
  * Default is 12.
240
- * @property {string} [q] - Search query with brand name.Use this parameter to
240
+ * @property {string} [q] - Search query with brand name. Use this parameter to
241
241
  * search brands by brand name.
242
242
  * @property {number[]} [brandId] - Helps to sort the brands list on the basis
243
243
  * of uid list.
@@ -251,8 +251,8 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
251
251
  * set of results
252
252
  * @property {number} [pageSize] - Number of items to retrieve in each page.
253
253
  * Default is 12.
254
- * @property {string} [q] - Search query with brand name.Use this parameter to
255
- * search brands by brand name.
254
+ * @property {string} [q] - A search query string. Use this parameter to filter
255
+ * results based on a keyword or specific value.
256
256
  */
257
257
 
258
258
  /**
@@ -261,8 +261,8 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
261
261
  * set of results
262
262
  * @property {number} [pageSize] - Number of items to retrieve in each page.
263
263
  * Default is 12.
264
- * @property {string} [q] - Search query with brand name.Use this parameter to
265
- * search department by name.
264
+ * @property {string} [q] - A search query string. Use this parameter to filter
265
+ * results based on a keyword or specific value.
266
266
  */
267
267
 
268
268
  /**
@@ -302,7 +302,7 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
302
302
 
303
303
  /**
304
304
  * @typedef GetCatalogInsightsParam
305
- * @property {string} [brand] - Brand slug
305
+ * @property {string} [brand] - Brand slug that is to be searched.
306
306
  */
307
307
 
308
308
  /**
@@ -310,7 +310,7 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
310
310
  * @property {string} [department] - The name of the department. Use this
311
311
  * parameter to filter products by a particular department. See below the list
312
312
  * of available departments. You can retrieve available departments from the
313
- * **v1.0/departments/** API
313
+ * "v1.0/departments/" API
314
314
  */
315
315
 
316
316
  /**
@@ -413,13 +413,15 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
413
413
 
414
414
  /**
415
415
  * @typedef UpdateAppBrandParam
416
- * @property {string} brandUid - Brand id for which the custom_json is associated.
416
+ * @property {number} brandUid - A `brand id` is a unique identifier for a
417
+ * particular brand.
417
418
  * @property {CatalogPlatformModel.ApplicationBrandJson} body
418
419
  */
419
420
 
420
421
  /**
421
422
  * @typedef UpdateAppCategoryParam
422
- * @property {string} categoryUid - Category id for which the custom_json is associated.
423
+ * @property {string} categoryUid - A `category id` is a unique identifier for a
424
+ * particular category.
423
425
  * @property {CatalogPlatformModel.ApplicationCategoryJson} body
424
426
  */
425
427
 
@@ -934,7 +936,7 @@ class CatalogPlatformApplicationValidator {
934
936
  /** @returns {UpdateAppBrandParam} */
935
937
  static updateAppBrand() {
936
938
  return Joi.object({
937
- brandUid: Joi.string().allow("").required(),
939
+ brandUid: Joi.number().required(),
938
940
  body: CatalogPlatformModel.ApplicationBrandJson().required(),
939
941
  }).required();
940
942
  }
@@ -98,12 +98,12 @@ declare class Catalog {
98
98
  * @param {CatalogPlatformValidator.CreateProductParam} arg - Arg object
99
99
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
100
100
  * @param {import("../PlatformAPIClient").Options} - Options
101
- * @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
101
+ * @returns {Promise<CatalogPlatformModel.SuccessResponseObject>} - Success response
102
102
  * @name createProduct
103
103
  * @summary: Create product
104
104
  * @description: Users can create a product using this API, associating it with the provided company ID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProduct/).
105
105
  */
106
- createProduct({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
106
+ createProduct({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseObject>;
107
107
  /**
108
108
  * @param {CatalogPlatformValidator.CreateProductAssetsInBulkParam} arg - Arg object
109
109
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -743,7 +743,7 @@ class Catalog {
743
743
  * @param {CatalogPlatformValidator.CreateProductParam} arg - Arg object
744
744
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
745
745
  * @param {import("../PlatformAPIClient").Options} - Options
746
- * @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
746
+ * @returns {Promise<CatalogPlatformModel.SuccessResponseObject>} - Success response
747
747
  * @name createProduct
748
748
  * @summary: Create product
749
749
  * @description: Users can create a product using this API, associating it with the provided company ID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProduct/).
@@ -799,7 +799,7 @@ class Catalog {
799
799
 
800
800
  const {
801
801
  error: res_error,
802
- } = CatalogPlatformModel.SuccessResponse1().validate(responseData, {
802
+ } = CatalogPlatformModel.SuccessResponseObject().validate(responseData, {
803
803
  abortEarly: false,
804
804
  allowUnknown: true,
805
805
  });