@gofynd/fdk-client-javascript 1.3.11-beta.8 → 1.4.0-beta.2

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 (48) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/Cart/CartApplicationModel.d.ts +2 -0
  4. package/sdk/application/Cart/CartApplicationModel.js +2 -0
  5. package/sdk/application/Order/OrderApplicationModel.d.ts +2 -0
  6. package/sdk/application/Order/OrderApplicationModel.js +2 -0
  7. package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +3 -15
  8. package/sdk/partner/FileStorage/FileStoragePartnerModel.js +2 -14
  9. package/sdk/partner/Theme/ThemePartnerModel.d.ts +185 -315
  10. package/sdk/partner/Theme/ThemePartnerModel.js +182 -222
  11. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +2 -12
  12. package/sdk/platform/Catalog/CatalogPlatformClient.js +17 -87
  13. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +11 -25
  14. package/sdk/platform/Catalog/CatalogPlatformValidator.js +4 -17
  15. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +1 -1
  16. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +4 -1
  17. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +5 -0
  18. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +2 -0
  19. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +1 -1
  20. package/sdk/platform/Content/ContentPlatformApplicationClient.js +14 -3
  21. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +14 -5
  22. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +13 -4
  23. package/sdk/platform/Content/ContentPlatformClient.d.ts +1 -1
  24. package/sdk/platform/Content/ContentPlatformClient.js +14 -3
  25. package/sdk/platform/Content/ContentPlatformModel.d.ts +6 -0
  26. package/sdk/platform/Content/ContentPlatformModel.js +6 -0
  27. package/sdk/platform/Content/ContentPlatformValidator.d.ts +12 -3
  28. package/sdk/platform/Content/ContentPlatformValidator.js +11 -2
  29. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +2 -0
  30. package/sdk/platform/Discount/DiscountPlatformModel.js +2 -0
  31. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +118 -58
  32. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +122 -68
  33. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +0 -12
  34. package/sdk/platform/Order/OrderPlatformApplicationClient.js +0 -85
  35. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +1 -12
  36. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +0 -14
  37. package/sdk/platform/Order/OrderPlatformClient.d.ts +11 -61
  38. package/sdk/platform/Order/OrderPlatformClient.js +87 -481
  39. package/sdk/platform/Order/OrderPlatformModel.d.ts +442 -171
  40. package/sdk/platform/Order/OrderPlatformModel.js +483 -169
  41. package/sdk/platform/Order/OrderPlatformValidator.d.ts +22 -69
  42. package/sdk/platform/Order/OrderPlatformValidator.js +17 -79
  43. package/sdk/platform/Theme/ThemePlatformModel.d.ts +103 -21
  44. package/sdk/platform/Theme/ThemePlatformModel.js +108 -20
  45. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +2 -2
  46. package/sdk/platform/Webhook/WebhookPlatformClient.js +4 -2
  47. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +21 -27
  48. package/sdk/platform/Webhook/WebhookPlatformModel.js +30 -27
@@ -186,16 +186,6 @@ declare class Catalog {
186
186
  * @description: This API allows to delete bulk Inventory job associated with company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteBulkInventoryJob/).
187
187
  */
188
188
  deleteBulkInventoryJob({ batchId, requestHeaders }?: CatalogPlatformValidator.DeleteBulkInventoryJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
189
- /**
190
- * @param {CatalogPlatformValidator.DeleteInventoryParam} arg - Arg object
191
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
192
- * @param {import("../PlatformAPIClient").Options} - Options
193
- * @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
194
- * @name deleteInventory
195
- * @summary: Delete a Inventory.
196
- * @description: This API allows to delete inventory of a particular product for particular company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteInventory/).
197
- */
198
- deleteInventory({ size, itemId, locationId, requestHeaders }?: CatalogPlatformValidator.DeleteInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
199
189
  /**
200
190
  * @param {CatalogPlatformValidator.DeleteProductParam} arg - Arg object
201
191
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -636,7 +626,7 @@ declare class Catalog {
636
626
  * @summary: Get product categories list
637
627
  * @description: This API gets meta associated to product categories. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listCategories/).
638
628
  */
639
- listCategories({ level, department, q, pageNo, pageSize, uids, requestHeaders }?: CatalogPlatformValidator.ListCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CategoryResponse>;
629
+ listCategories({ level, department, q, pageNo, pageSize, uids, slug, requestHeaders }?: CatalogPlatformValidator.ListCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CategoryResponse>;
640
630
  /**
641
631
  * @param {CatalogPlatformValidator.ListDepartmentsDataParam} arg - Arg object
642
632
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -646,7 +636,7 @@ declare class Catalog {
646
636
  * @summary: List all Departments.
647
637
  * @description: Allows you to list all departments, also can search using name and filter active and incative departments, and item type. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listDepartmentsData/).
648
638
  */
649
- listDepartmentsData({ pageNo, itemType, pageSize, name, search, isActive, requestHeaders }?: CatalogPlatformValidator.ListDepartmentsDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentsResponse>;
639
+ listDepartmentsData({ pageNo, itemType, pageSize, name, search, isActive, slug, requestHeaders, }?: CatalogPlatformValidator.ListDepartmentsDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentsResponse>;
650
640
  /**
651
641
  * @param {CatalogPlatformValidator.ListHSNCodesParam} arg - Arg object
652
642
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -1460,89 +1460,6 @@ class Catalog {
1460
1460
  return response;
1461
1461
  }
1462
1462
 
1463
- /**
1464
- * @param {CatalogPlatformValidator.DeleteInventoryParam} arg - Arg object
1465
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1466
- * @param {import("../PlatformAPIClient").Options} - Options
1467
- * @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
1468
- * @name deleteInventory
1469
- * @summary: Delete a Inventory.
1470
- * @description: This API allows to delete inventory of a particular product for particular company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteInventory/).
1471
- */
1472
- async deleteInventory(
1473
- { size, itemId, locationId, requestHeaders } = { requestHeaders: {} },
1474
- { responseHeaders } = { responseHeaders: false }
1475
- ) {
1476
- const { error } = CatalogPlatformValidator.deleteInventory().validate(
1477
- {
1478
- size,
1479
- itemId,
1480
- locationId,
1481
- },
1482
- { abortEarly: false, allowUnknown: true }
1483
- );
1484
- if (error) {
1485
- return Promise.reject(new FDKClientValidationError(error));
1486
- }
1487
-
1488
- // Showing warrnings if extra unknown parameters are found
1489
- const {
1490
- error: warrning,
1491
- } = CatalogPlatformValidator.deleteInventory().validate(
1492
- {
1493
- size,
1494
- itemId,
1495
- locationId,
1496
- },
1497
- { abortEarly: false, allowUnknown: false }
1498
- );
1499
- if (warrning) {
1500
- Logger({
1501
- level: "WARN",
1502
- message: `Parameter Validation warrnings for platform > Catalog > deleteInventory \n ${warrning}`,
1503
- });
1504
- }
1505
-
1506
- const query_params = {};
1507
-
1508
- const xHeaders = {};
1509
-
1510
- const response = await PlatformAPIClient.execute(
1511
- this.config,
1512
- "delete",
1513
- `/service/platform/catalog/v1.0/company/${this.config.companyId}/products/${itemId}/sizes/${size}/location/${locationId}/`,
1514
- query_params,
1515
- undefined,
1516
- { ...xHeaders, ...requestHeaders },
1517
- { responseHeaders }
1518
- );
1519
-
1520
- let responseData = response;
1521
- if (responseHeaders) {
1522
- responseData = response[0];
1523
- }
1524
-
1525
- const {
1526
- error: res_error,
1527
- } = CatalogPlatformModel.SuccessResponse().validate(responseData, {
1528
- abortEarly: false,
1529
- allowUnknown: true,
1530
- });
1531
-
1532
- if (res_error) {
1533
- if (this.config.options.strictResponseCheck === true) {
1534
- return Promise.reject(new FDKResponseValidationError(res_error));
1535
- } else {
1536
- Logger({
1537
- level: "WARN",
1538
- message: `Response Validation Warnings for platform > Catalog > deleteInventory \n ${res_error}`,
1539
- });
1540
- }
1541
- }
1542
-
1543
- return response;
1544
- }
1545
-
1546
1463
  /**
1547
1464
  * @param {CatalogPlatformValidator.DeleteProductParam} arg - Arg object
1548
1465
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -5017,7 +4934,7 @@ class Catalog {
5017
4934
  * @description: This API gets meta associated to product categories. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listCategories/).
5018
4935
  */
5019
4936
  async listCategories(
5020
- { level, department, q, pageNo, pageSize, uids, requestHeaders } = {
4937
+ { level, department, q, pageNo, pageSize, uids, slug, requestHeaders } = {
5021
4938
  requestHeaders: {},
5022
4939
  },
5023
4940
  { responseHeaders } = { responseHeaders: false }
@@ -5030,6 +4947,7 @@ class Catalog {
5030
4947
  pageNo,
5031
4948
  pageSize,
5032
4949
  uids,
4950
+ slug,
5033
4951
  },
5034
4952
  { abortEarly: false, allowUnknown: true }
5035
4953
  );
@@ -5048,6 +4966,7 @@ class Catalog {
5048
4966
  pageNo,
5049
4967
  pageSize,
5050
4968
  uids,
4969
+ slug,
5051
4970
  },
5052
4971
  { abortEarly: false, allowUnknown: false }
5053
4972
  );
@@ -5065,6 +4984,7 @@ class Catalog {
5065
4984
  query_params["page_no"] = pageNo;
5066
4985
  query_params["page_size"] = pageSize;
5067
4986
  query_params["uids"] = uids;
4987
+ query_params["slug"] = slug;
5068
4988
 
5069
4989
  const xHeaders = {};
5070
4990
 
@@ -5114,9 +5034,16 @@ class Catalog {
5114
5034
  * @description: Allows you to list all departments, also can search using name and filter active and incative departments, and item type. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listDepartmentsData/).
5115
5035
  */
5116
5036
  async listDepartmentsData(
5117
- { pageNo, itemType, pageSize, name, search, isActive, requestHeaders } = {
5118
- requestHeaders: {},
5119
- },
5037
+ {
5038
+ pageNo,
5039
+ itemType,
5040
+ pageSize,
5041
+ name,
5042
+ search,
5043
+ isActive,
5044
+ slug,
5045
+ requestHeaders,
5046
+ } = { requestHeaders: {} },
5120
5047
  { responseHeaders } = { responseHeaders: false }
5121
5048
  ) {
5122
5049
  const { error } = CatalogPlatformValidator.listDepartmentsData().validate(
@@ -5127,6 +5054,7 @@ class Catalog {
5127
5054
  name,
5128
5055
  search,
5129
5056
  isActive,
5057
+ slug,
5130
5058
  },
5131
5059
  { abortEarly: false, allowUnknown: true }
5132
5060
  );
@@ -5145,6 +5073,7 @@ class Catalog {
5145
5073
  name,
5146
5074
  search,
5147
5075
  isActive,
5076
+ slug,
5148
5077
  },
5149
5078
  { abortEarly: false, allowUnknown: false }
5150
5079
  );
@@ -5162,6 +5091,7 @@ class Catalog {
5162
5091
  query_params["name"] = name;
5163
5092
  query_params["search"] = search;
5164
5093
  query_params["is_active"] = isActive;
5094
+ query_params["slug"] = slug;
5165
5095
 
5166
5096
  const xHeaders = {};
5167
5097
 
@@ -77,13 +77,6 @@ export = CatalogPlatformValidator;
77
77
  * @typedef DeleteBulkInventoryJobParam
78
78
  * @property {string} batchId - Batch Id of the bulk delete job.
79
79
  */
80
- /**
81
- * @typedef DeleteInventoryParam
82
- * @property {string} size - Size that is to be deleted.
83
- * @property {number} itemId - Id of the product associated with Inventory to be deleted.
84
- * @property {number} locationId - Location ID of store of which inventory is to
85
- * be deleted.
86
- */
87
80
  /**
88
81
  * @typedef DeleteProductParam
89
82
  * @property {number} itemId - Id of the product to be updated.
@@ -333,6 +326,7 @@ export = CatalogPlatformValidator;
333
326
  * @property {number} [pageSize] - Number of items to retrieve in each page.
334
327
  * Default is 10.
335
328
  * @property {number[]} [uids] - Get multiple categories filtered by category uids.
329
+ * @property {string} [slug] - Get category by slug
336
330
  */
337
331
  /**
338
332
  * @typedef ListDepartmentsDataParam
@@ -347,6 +341,7 @@ export = CatalogPlatformValidator;
347
341
  * department in search parameter.
348
342
  * @property {boolean} [isActive] - Can query for departments based on whether
349
343
  * they are active or inactive.
344
+ * @property {string} [slug] - Can filter by slug
350
345
  */
351
346
  /** @typedef ListHSNCodesParam */
352
347
  /**
@@ -479,8 +474,6 @@ declare class CatalogPlatformValidator {
479
474
  static createSizeGuide(): CreateSizeGuideParam;
480
475
  /** @returns {DeleteBulkInventoryJobParam} */
481
476
  static deleteBulkInventoryJob(): DeleteBulkInventoryJobParam;
482
- /** @returns {DeleteInventoryParam} */
483
- static deleteInventory(): DeleteInventoryParam;
484
477
  /** @returns {DeleteProductParam} */
485
478
  static deleteProduct(): DeleteProductParam;
486
479
  /** @returns {DeleteProductBulkJobParam} */
@@ -603,7 +596,7 @@ declare class CatalogPlatformValidator {
603
596
  static validateProductTemplateSchema(): ValidateProductTemplateSchemaParam;
604
597
  }
605
598
  declare namespace CatalogPlatformValidator {
606
- export { AddInventoryParam, AllSizesParam, BulkHsnCodeParam, CreateBulkInventoryParam, CreateBulkInventoryJobParam, CreateBulkProductUploadJobParam, CreateCategoriesParam, CreateDepartmentsParam, CreateInventoryExportParam, CreateInventoryExportJobParam, CreateMarketplaceOptinParam, CreateProductParam, CreateProductAssetsInBulkParam, CreateProductBundleParam, CreateProductExportJobParam, CreateProductsInBulkParam, CreateSizeGuideParam, DeleteBulkInventoryJobParam, DeleteInventoryParam, DeleteProductParam, DeleteProductBulkJobParam, DeleteRealtimeInventoryParam, DeleteSizeParam, DownloadInventoryTemplateViewParam, DownloadProductTemplateViewsParam, EditProductParam, ExportInventoryConfigParam, GetAllProductHsnCodesParam, GetCategoryDataParam, GetCompanyBrandDetailParam, GetCompanyDetailParam, GetCompanyMetricsParam, GetDepartmentDataParam, GetGenderAttributeParam, GetHsnCodeParam, GetInventoriesParam, GetInventoryBulkUploadHistoryParam, GetInventoryBySizeParam, GetInventoryBySizeIdentifierParam, GetInventoryExportParam, GetMarketplaceOptinDetailParam, GetMarketplacesParam, GetOptimalLocationsParam, GetProductParam, GetProductAssetsInBulkParam, GetProductAttributesParam, GetProductBulkUploadHistoryParam, GetProductBundleParam, GetProductBundleDetailParam, GetProductExportJobsParam, GetProductSizeParam, GetProductTagsParam, GetProductValidationParam, GetProductsParam, GetSellerInsightsParam, GetSingleProductHSNCodeParam, GetSizeGuideParam, GetSizeGuidesParam, GetStoreDetailParam, GetVariantsOfProductsParam, ListCategoriesParam, ListDepartmentsDataParam, ListHSNCodesParam, ListInventoryExportParam, ListProductTemplateParam, ListProductTemplateCategoriesParam, ListProductTemplateExportDetailsParam, ListTemplateBrandTypeValuesParam, UpdateCategoryParam, UpdateDepartmentParam, UpdateHsnCodeParam, UpdateInventoriesParam, UpdateMarketplaceOptinParam, UpdateProductBundleParam, UpdateRealtimeInventoryParam, UpdateSizeGuideParam, UploadBulkProductsParam, ValidateProductTemplateParam, ValidateProductTemplateSchemaParam };
599
+ export { AddInventoryParam, AllSizesParam, BulkHsnCodeParam, CreateBulkInventoryParam, CreateBulkInventoryJobParam, CreateBulkProductUploadJobParam, CreateCategoriesParam, CreateDepartmentsParam, CreateInventoryExportParam, CreateInventoryExportJobParam, CreateMarketplaceOptinParam, CreateProductParam, CreateProductAssetsInBulkParam, CreateProductBundleParam, CreateProductExportJobParam, CreateProductsInBulkParam, CreateSizeGuideParam, DeleteBulkInventoryJobParam, DeleteProductParam, DeleteProductBulkJobParam, DeleteRealtimeInventoryParam, DeleteSizeParam, DownloadInventoryTemplateViewParam, DownloadProductTemplateViewsParam, EditProductParam, ExportInventoryConfigParam, GetAllProductHsnCodesParam, GetCategoryDataParam, GetCompanyBrandDetailParam, GetCompanyDetailParam, GetCompanyMetricsParam, GetDepartmentDataParam, GetGenderAttributeParam, GetHsnCodeParam, GetInventoriesParam, GetInventoryBulkUploadHistoryParam, GetInventoryBySizeParam, GetInventoryBySizeIdentifierParam, GetInventoryExportParam, GetMarketplaceOptinDetailParam, GetMarketplacesParam, GetOptimalLocationsParam, GetProductParam, GetProductAssetsInBulkParam, GetProductAttributesParam, GetProductBulkUploadHistoryParam, GetProductBundleParam, GetProductBundleDetailParam, GetProductExportJobsParam, GetProductSizeParam, GetProductTagsParam, GetProductValidationParam, GetProductsParam, GetSellerInsightsParam, GetSingleProductHSNCodeParam, GetSizeGuideParam, GetSizeGuidesParam, GetStoreDetailParam, GetVariantsOfProductsParam, ListCategoriesParam, ListDepartmentsDataParam, ListHSNCodesParam, ListInventoryExportParam, ListProductTemplateParam, ListProductTemplateCategoriesParam, ListProductTemplateExportDetailsParam, ListTemplateBrandTypeValuesParam, UpdateCategoryParam, UpdateDepartmentParam, UpdateHsnCodeParam, UpdateInventoriesParam, UpdateMarketplaceOptinParam, UpdateProductBundleParam, UpdateRealtimeInventoryParam, UpdateSizeGuideParam, UploadBulkProductsParam, ValidateProductTemplateParam, ValidateProductTemplateSchemaParam };
607
600
  }
608
601
  type AddInventoryParam = {
609
602
  /**
@@ -686,21 +679,6 @@ type DeleteBulkInventoryJobParam = {
686
679
  */
687
680
  batchId: string;
688
681
  };
689
- type DeleteInventoryParam = {
690
- /**
691
- * - Size that is to be deleted.
692
- */
693
- size: string;
694
- /**
695
- * - Id of the product associated with Inventory to be deleted.
696
- */
697
- itemId: number;
698
- /**
699
- * - Location ID of store of which inventory is to
700
- * be deleted.
701
- */
702
- locationId: number;
703
- };
704
682
  type DeleteProductParam = {
705
683
  /**
706
684
  * - Id of the product to be updated.
@@ -1205,6 +1183,10 @@ type ListCategoriesParam = {
1205
1183
  * - Get multiple categories filtered by category uids.
1206
1184
  */
1207
1185
  uids?: number[];
1186
+ /**
1187
+ * - Get category by slug
1188
+ */
1189
+ slug?: string;
1208
1190
  };
1209
1191
  type ListDepartmentsDataParam = {
1210
1192
  /**
@@ -1236,6 +1218,10 @@ type ListDepartmentsDataParam = {
1236
1218
  * they are active or inactive.
1237
1219
  */
1238
1220
  isActive?: boolean;
1221
+ /**
1222
+ * - Can filter by slug
1223
+ */
1224
+ slug?: string;
1239
1225
  };
1240
1226
  type ListInventoryExportParam = {
1241
1227
  /**
@@ -98,14 +98,6 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
98
98
  * @property {string} batchId - Batch Id of the bulk delete job.
99
99
  */
100
100
 
101
- /**
102
- * @typedef DeleteInventoryParam
103
- * @property {string} size - Size that is to be deleted.
104
- * @property {number} itemId - Id of the product associated with Inventory to be deleted.
105
- * @property {number} locationId - Location ID of store of which inventory is to
106
- * be deleted.
107
- */
108
-
109
101
  /**
110
102
  * @typedef DeleteProductParam
111
103
  * @property {number} itemId - Id of the product to be updated.
@@ -396,6 +388,7 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
396
388
  * @property {number} [pageSize] - Number of items to retrieve in each page.
397
389
  * Default is 10.
398
390
  * @property {number[]} [uids] - Get multiple categories filtered by category uids.
391
+ * @property {string} [slug] - Get category by slug
399
392
  */
400
393
 
401
394
  /**
@@ -411,6 +404,7 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
411
404
  * department in search parameter.
412
405
  * @property {boolean} [isActive] - Can query for departments based on whether
413
406
  * they are active or inactive.
407
+ * @property {string} [slug] - Can filter by slug
414
408
  */
415
409
 
416
410
  /** @typedef ListHSNCodesParam */
@@ -656,15 +650,6 @@ class CatalogPlatformValidator {
656
650
  }).required();
657
651
  }
658
652
 
659
- /** @returns {DeleteInventoryParam} */
660
- static deleteInventory() {
661
- return Joi.object({
662
- size: Joi.string().allow("").required(),
663
- itemId: Joi.number().required(),
664
- locationId: Joi.number().required(),
665
- }).required();
666
- }
667
-
668
653
  /** @returns {DeleteProductParam} */
669
654
  static deleteProduct() {
670
655
  return Joi.object({
@@ -1009,6 +994,7 @@ class CatalogPlatformValidator {
1009
994
  pageNo: Joi.number(),
1010
995
  pageSize: Joi.number(),
1011
996
  uids: Joi.array().items(Joi.number()),
997
+ slug: Joi.string().allow(""),
1012
998
  }).required();
1013
999
  }
1014
1000
 
@@ -1021,6 +1007,7 @@ class CatalogPlatformValidator {
1021
1007
  name: Joi.string().allow(""),
1022
1008
  search: Joi.string().allow(""),
1023
1009
  isActive: Joi.boolean(),
1010
+ slug: Joi.string().allow(""),
1024
1011
  }).required();
1025
1012
  }
1026
1013
 
@@ -674,7 +674,7 @@ declare class Communication {
674
674
  * @summary: Get sms providers
675
675
  * @description: Get sms providers - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSmsProviders/).
676
676
  */
677
- getSmsProviders({ pageNo, pageSize, sort, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSmsProvidersParam, { responseHeaders }?: object): Promise<any>;
677
+ getSmsProviders({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSmsProvidersParam, { responseHeaders }?: object): Promise<any>;
678
678
  /**
679
679
  * @param {CommunicationPlatformApplicationValidator.GetSmsTemplateByIdParam} arg
680
680
  * - Arg object
@@ -3895,7 +3895,7 @@ class Communication {
3895
3895
  * @description: Get sms providers - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSmsProviders/).
3896
3896
  */
3897
3897
  async getSmsProviders(
3898
- { pageNo, pageSize, sort, requestHeaders } = { requestHeaders: {} },
3898
+ { pageNo, pageSize, sort, query, requestHeaders } = { requestHeaders: {} },
3899
3899
  { responseHeaders } = { responseHeaders: false }
3900
3900
  ) {
3901
3901
  const {
@@ -3905,6 +3905,7 @@ class Communication {
3905
3905
  pageNo,
3906
3906
  pageSize,
3907
3907
  sort,
3908
+ query,
3908
3909
  },
3909
3910
  { abortEarly: false, allowUnknown: true }
3910
3911
  );
@@ -3920,6 +3921,7 @@ class Communication {
3920
3921
  pageNo,
3921
3922
  pageSize,
3922
3923
  sort,
3924
+ query,
3923
3925
  },
3924
3926
  { abortEarly: false, allowUnknown: false }
3925
3927
  );
@@ -3934,6 +3936,7 @@ class Communication {
3934
3936
  query_params["page_no"] = pageNo;
3935
3937
  query_params["page_size"] = pageSize;
3936
3938
  query_params["sort"] = sort;
3939
+ query_params["query"] = query;
3937
3940
 
3938
3941
  const response = await PlatformAPIClient.execute(
3939
3942
  this.config,
@@ -176,6 +176,7 @@ export = CommunicationPlatformApplicationValidator;
176
176
  * @property {number} [pageNo] - Current page no
177
177
  * @property {number} [pageSize] - Current request items count
178
178
  * @property {Object} [sort] - To sort based on created_at
179
+ * @property {Object} [query] - To search based on plain text
179
180
  */
180
181
  /**
181
182
  * @typedef GetSmsTemplateByIdParam
@@ -687,6 +688,10 @@ type GetSmsProvidersParam = {
687
688
  * - To sort based on created_at
688
689
  */
689
690
  sort?: any;
691
+ /**
692
+ * - To search based on plain text
693
+ */
694
+ query?: any;
690
695
  };
691
696
  type GetSmsTemplateByIdParam = {
692
697
  /**
@@ -223,6 +223,7 @@ const CommunicationPlatformModel = require("./CommunicationPlatformModel");
223
223
  * @property {number} [pageNo] - Current page no
224
224
  * @property {number} [pageSize] - Current request items count
225
225
  * @property {Object} [sort] - To sort based on created_at
226
+ * @property {Object} [query] - To search based on plain text
226
227
  */
227
228
 
228
229
  /**
@@ -657,6 +658,7 @@ class CommunicationPlatformApplicationValidator {
657
658
  pageNo: Joi.number(),
658
659
  pageSize: Joi.number(),
659
660
  sort: Joi.any(),
661
+ query: Joi.any(),
660
662
  }).required();
661
663
  }
662
664
 
@@ -576,7 +576,7 @@ declare class Content {
576
576
  * @summary: Get list of custom objects
577
577
  * @description: Use this API to retrieve the custom objects. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getAppCustomObjects/).
578
578
  */
579
- getAppCustomObjects({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomObjectsSchema>;
579
+ getAppCustomObjects({ pageNo, pageSize, definitionId, requestHeaders }?: ContentPlatformApplicationValidator.GetAppCustomObjectsParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomObjectsSchema>;
580
580
  /**
581
581
  * @param {ContentPlatformApplicationValidator.GetAppJobsParam} arg - Arg object
582
582
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -3803,13 +3803,17 @@ class Content {
3803
3803
  * @description: Use this API to retrieve the custom objects. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getAppCustomObjects/).
3804
3804
  */
3805
3805
  async getAppCustomObjects(
3806
- { requestHeaders } = { requestHeaders: {} },
3806
+ { pageNo, pageSize, definitionId, requestHeaders } = { requestHeaders: {} },
3807
3807
  { responseHeaders } = { responseHeaders: false }
3808
3808
  ) {
3809
3809
  const {
3810
3810
  error,
3811
3811
  } = ContentPlatformApplicationValidator.getAppCustomObjects().validate(
3812
- {},
3812
+ {
3813
+ pageNo,
3814
+ pageSize,
3815
+ definitionId,
3816
+ },
3813
3817
  { abortEarly: false, allowUnknown: true }
3814
3818
  );
3815
3819
  if (error) {
@@ -3820,7 +3824,11 @@ class Content {
3820
3824
  const {
3821
3825
  error: warrning,
3822
3826
  } = ContentPlatformApplicationValidator.getAppCustomObjects().validate(
3823
- {},
3827
+ {
3828
+ pageNo,
3829
+ pageSize,
3830
+ definitionId,
3831
+ },
3824
3832
  { abortEarly: false, allowUnknown: false }
3825
3833
  );
3826
3834
  if (warrning) {
@@ -3831,6 +3839,9 @@ class Content {
3831
3839
  }
3832
3840
 
3833
3841
  const query_params = {};
3842
+ query_params["definition_id"] = definitionId;
3843
+ query_params["page_no"] = pageNo;
3844
+ query_params["page_size"] = pageSize;
3834
3845
 
3835
3846
  const response = await PlatformAPIClient.execute(
3836
3847
  this.config,
@@ -142,7 +142,7 @@ export = ContentPlatformApplicationValidator;
142
142
  * @typedef EditSEOMarkupSchemaParam
143
143
  * @property {string} id - Alphanumeric ID allotted to a SEO Markup Schema
144
144
  * Template created within a business.
145
- * @property {ContentPlatformModel.SEOSchemaMarkupTemplate} body
145
+ * @property {ContentPlatformModel.SEOSchemaMarkupTemplateRequestBody} body
146
146
  */
147
147
  /**
148
148
  * @typedef ExportAppCustomObjectEntriesParam
@@ -202,7 +202,12 @@ export = ContentPlatformApplicationValidator;
202
202
  * @property {string} pageSize
203
203
  * @property {string} [search]
204
204
  */
205
- /** @typedef GetAppCustomObjectsParam */
205
+ /**
206
+ * @typedef GetAppCustomObjectsParam
207
+ * @property {string} [definitionId]
208
+ * @property {string} pageNo
209
+ * @property {string} pageSize
210
+ */
206
211
  /**
207
212
  * @typedef GetAppJobsParam
208
213
  * @property {string} page
@@ -546,7 +551,7 @@ declare class ContentPlatformApplicationValidator {
546
551
  /** @returns {GetAppCustomObjectDefinitionsParam} */
547
552
  static getAppCustomObjectDefinitions(): GetAppCustomObjectDefinitionsParam;
548
553
  /** @returns {GetAppCustomObjectsParam} */
549
- static getAppCustomObjects(): any;
554
+ static getAppCustomObjects(): GetAppCustomObjectsParam;
550
555
  /** @returns {GetAppJobsParam} */
551
556
  static getAppJobs(): GetAppJobsParam;
552
557
  /** @returns {GetAppResourcesParam} */
@@ -814,7 +819,7 @@ type EditSEOMarkupSchemaParam = {
814
819
  * Template created within a business.
815
820
  */
816
821
  id: string;
817
- body: ContentPlatformModel.SEOSchemaMarkupTemplate;
822
+ body: ContentPlatformModel.SEOSchemaMarkupTemplateRequestBody;
818
823
  };
819
824
  type ExportAppCustomObjectEntriesParam = {
820
825
  definitionId: string;
@@ -874,6 +879,11 @@ type GetAppCustomObjectDefinitionsParam = {
874
879
  pageSize: string;
875
880
  search?: string;
876
881
  };
882
+ type GetAppCustomObjectsParam = {
883
+ definitionId?: string;
884
+ pageNo: string;
885
+ pageSize: string;
886
+ };
877
887
  type GetAppJobsParam = {
878
888
  page: string;
879
889
  pageSize: string;
@@ -1215,7 +1225,6 @@ type UpdateSupportInformationParam = {
1215
1225
  body: ContentPlatformModel.Support;
1216
1226
  };
1217
1227
  type GetAppCustomFieldTypesParam = any;
1218
- type GetAppCustomObjectsParam = any;
1219
1228
  type GetAppResourcesParam = any;
1220
1229
  type GetDataLoadersParam = any;
1221
1230
  type GetDefaultNavigationsParam = any;
@@ -178,7 +178,7 @@ const ContentPlatformModel = require("./ContentPlatformModel");
178
178
  * @typedef EditSEOMarkupSchemaParam
179
179
  * @property {string} id - Alphanumeric ID allotted to a SEO Markup Schema
180
180
  * Template created within a business.
181
- * @property {ContentPlatformModel.SEOSchemaMarkupTemplate} body
181
+ * @property {ContentPlatformModel.SEOSchemaMarkupTemplateRequestBody} body
182
182
  */
183
183
 
184
184
  /**
@@ -251,7 +251,12 @@ const ContentPlatformModel = require("./ContentPlatformModel");
251
251
  * @property {string} [search]
252
252
  */
253
253
 
254
- /** @typedef GetAppCustomObjectsParam */
254
+ /**
255
+ * @typedef GetAppCustomObjectsParam
256
+ * @property {string} [definitionId]
257
+ * @property {string} pageNo
258
+ * @property {string} pageSize
259
+ */
255
260
 
256
261
  /**
257
262
  * @typedef GetAppJobsParam
@@ -797,7 +802,7 @@ class ContentPlatformApplicationValidator {
797
802
  static editSEOMarkupSchema() {
798
803
  return Joi.object({
799
804
  id: Joi.string().allow("").required(),
800
- body: ContentPlatformModel.SEOSchemaMarkupTemplate().required(),
805
+ body: ContentPlatformModel.SEOSchemaMarkupTemplateRequestBody().required(),
801
806
  }).required();
802
807
  }
803
808
 
@@ -894,7 +899,11 @@ class ContentPlatformApplicationValidator {
894
899
 
895
900
  /** @returns {GetAppCustomObjectsParam} */
896
901
  static getAppCustomObjects() {
897
- return Joi.object({}).required();
902
+ return Joi.object({
903
+ definitionId: Joi.string().allow(""),
904
+ pageNo: Joi.string().allow("").required(),
905
+ pageSize: Joi.string().allow("").required(),
906
+ }).required();
898
907
  }
899
908
 
900
909
  /** @returns {GetAppJobsParam} */
@@ -194,7 +194,7 @@ declare class Content {
194
194
  * @summary: Get list of custom objects
195
195
  * @description: Use this API to retrieve the custom objects. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getCustomObjects/).
196
196
  */
197
- getCustomObjects({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomObjectsSchema>;
197
+ getCustomObjects({ pageNo, pageSize, definitionId, requestHeaders }?: ContentPlatformValidator.GetCustomObjectsParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomObjectsSchema>;
198
198
  /**
199
199
  * @param {ContentPlatformValidator.GetJobsParam} arg - Arg object
200
200
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -1357,11 +1357,15 @@ class Content {
1357
1357
  * @description: Use this API to retrieve the custom objects. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getCustomObjects/).
1358
1358
  */
1359
1359
  async getCustomObjects(
1360
- { requestHeaders } = { requestHeaders: {} },
1360
+ { pageNo, pageSize, definitionId, requestHeaders } = { requestHeaders: {} },
1361
1361
  { responseHeaders } = { responseHeaders: false }
1362
1362
  ) {
1363
1363
  const { error } = ContentPlatformValidator.getCustomObjects().validate(
1364
- {},
1364
+ {
1365
+ pageNo,
1366
+ pageSize,
1367
+ definitionId,
1368
+ },
1365
1369
  { abortEarly: false, allowUnknown: true }
1366
1370
  );
1367
1371
  if (error) {
@@ -1372,7 +1376,11 @@ class Content {
1372
1376
  const {
1373
1377
  error: warrning,
1374
1378
  } = ContentPlatformValidator.getCustomObjects().validate(
1375
- {},
1379
+ {
1380
+ pageNo,
1381
+ pageSize,
1382
+ definitionId,
1383
+ },
1376
1384
  { abortEarly: false, allowUnknown: false }
1377
1385
  );
1378
1386
  if (warrning) {
@@ -1383,6 +1391,9 @@ class Content {
1383
1391
  }
1384
1392
 
1385
1393
  const query_params = {};
1394
+ query_params["definition_id"] = definitionId;
1395
+ query_params["page_no"] = pageNo;
1396
+ query_params["page_size"] = pageSize;
1386
1397
 
1387
1398
  const xHeaders = {};
1388
1399