@gofynd/fdk-client-javascript 3.7.0 → 3.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -26,6 +26,10 @@ export = CatalogPlatformValidator;
26
26
  * @typedef CreateBulkProductUploadJobParam
27
27
  * @property {CatalogPlatformModel.BulkJob} body
28
28
  */
29
+ /**
30
+ * @typedef CreateHsCodeParam
31
+ * @property {CatalogPlatformModel.HSCodeItem} body
32
+ */
29
33
  /**
30
34
  * @typedef CreateInventoryExportParam
31
35
  * @property {CatalogPlatformModel.InventoryCreateRequestSchema} body
@@ -42,7 +46,7 @@ export = CatalogPlatformValidator;
42
46
  */
43
47
  /**
44
48
  * @typedef CreateProductParam
45
- * @property {CatalogPlatformModel.ProductCreateSchemaV2} body
49
+ * @property {CatalogPlatformModel.ProductCreateSchemaV3} body
46
50
  */
47
51
  /**
48
52
  * @typedef CreateProductAssetsInBulkParam
@@ -65,6 +69,19 @@ export = CatalogPlatformValidator;
65
69
  * @typedef CreateSizeGuideParam
66
70
  * @property {CatalogPlatformModel.ValidateSizeGuide} body
67
71
  */
72
+ /**
73
+ * @typedef CreateTaxParam
74
+ * @property {CatalogPlatformModel.CreateTaxRequestBody} body
75
+ */
76
+ /**
77
+ * @typedef CreateTaxComponentNameParam
78
+ * @property {CatalogPlatformModel.CreateTaxComponentNameRequestSchema} body
79
+ */
80
+ /**
81
+ * @typedef CreateTaxVersionParam
82
+ * @property {string} ruleId - The ID of the tax rule.
83
+ * @property {CatalogPlatformModel.CreateTaxVersionRequestBody} body
84
+ */
68
85
  /**
69
86
  * @typedef DeleteBulkInventoryJobParam
70
87
  * @property {string} batchId - Batch Id of the bulk delete job.
@@ -89,6 +106,15 @@ export = CatalogPlatformValidator;
89
106
  * @property {number} itemId - Item Id of the product associated with size to be deleted.
90
107
  * @property {string} size - Size to be deleted.
91
108
  */
109
+ /**
110
+ * @typedef DeleteTaxRuleParam
111
+ * @property {string} ruleId - The ID of the tax rule to be deleted.
112
+ */
113
+ /**
114
+ * @typedef DeleteTaxVersionParam
115
+ * @property {string} ruleId - The ID of the tax rule to be deleted.
116
+ * @property {string} versionId - The ID of the tax version to be deleted.
117
+ */
92
118
  /**
93
119
  * @typedef DownloadInventoryTemplateViewParam
94
120
  * @property {string} schemaType - Specifies the type of template to download.
@@ -105,7 +131,7 @@ export = CatalogPlatformValidator;
105
131
  /**
106
132
  * @typedef EditProductParam
107
133
  * @property {number} itemId - Id of the product to be updated.
108
- * @property {CatalogPlatformModel.ProductUpdateSchemaV2} body
134
+ * @property {CatalogPlatformModel.ProductUpdateSchemaV3} body
109
135
  */
110
136
  /**
111
137
  * @typedef ExportInventoryConfigParam
@@ -119,6 +145,14 @@ export = CatalogPlatformValidator;
119
145
  * @property {string} [q] - Search using hsn code, description, reporting_hsn
120
146
  * @property {string} [type] - Search using type
121
147
  */
148
+ /**
149
+ * @typedef GetAllTaxRulesParam
150
+ * @property {string} [q] - The search query to filter tax rules.
151
+ * @property {string} [statuses] - The status of the tax rules to filter.
152
+ * @property {number} [page] - The page number to retrieve.
153
+ * @property {number} [limit] - The number of items per page.
154
+ * @property {string} [versionStatus] - The status of the tax rule versions to filter.
155
+ */
122
156
  /**
123
157
  * @typedef GetAttributeParam
124
158
  * @property {string} attributeSlug - Slug of the attribute for which you want
@@ -144,6 +178,13 @@ export = CatalogPlatformValidator;
144
178
  * @typedef GetDepartmentDataParam
145
179
  * @property {string} uid - A `uid` is a unique identifier of a department.
146
180
  */
181
+ /**
182
+ * @typedef GetHsCodesParam
183
+ * @property {number} [page] - The page number for pagination.
184
+ * @property {number} [limit] - The number of items to return per page.
185
+ * @property {CatalogPlatformModel.HsTypeEnum} [type] - Filter by HS/SAC code type.
186
+ * @property {string} [q] - Search query to filter HS/SAC codes by code or description.
187
+ */
147
188
  /**
148
189
  * @typedef GetHsnCodeParam
149
190
  * @property {string} id - Unique id
@@ -341,6 +382,15 @@ export = CatalogPlatformValidator;
341
382
  * @property {number} [pageSize] - Number of records that can be seen on the
342
383
  * page for the company id.
343
384
  */
385
+ /** @typedef GetTaxComponentNamesParam */
386
+ /**
387
+ * @typedef GetTaxVersionDetailsParam
388
+ * @property {string} ruleId - The ID of the tax rule.
389
+ * @property {string} [versionStatus] - Filter by tax version status.
390
+ * @property {string} [limit] - The number of items to return per page for
391
+ * paginated past versions.
392
+ * @property {string} [page] - The page number for paginated past versions.
393
+ */
344
394
  /**
345
395
  * @typedef GetVariantsOfProductsParam
346
396
  * @property {number} itemId - Get list of variants of item Id
@@ -463,11 +513,15 @@ export = CatalogPlatformValidator;
463
513
  * @property {CatalogPlatformModel.ValidateSizeGuide} body
464
514
  */
465
515
  /**
466
- * @typedef UploadBulkProductsParam
467
- * @property {string} department - Department of the product to be uploaded.
468
- * @property {string} productType - Product type of the product to be uploaded
469
- * i.e. set, standard, digital.
470
- * @property {CatalogPlatformModel.BulkProductJob} body
516
+ * @typedef UpdateTaxRuleParam
517
+ * @property {string} ruleId - Tax rule id that you want to update.
518
+ * @property {CatalogPlatformModel.UpdateTaxRequestBody} body
519
+ */
520
+ /**
521
+ * @typedef UpdateTaxVersionParam
522
+ * @property {string} ruleId - The ID of the tax rule to be updated.
523
+ * @property {string} versionId - The ID of the tax version to be updated.
524
+ * @property {CatalogPlatformModel.UpdateTaxVersionRequestBody} body
471
525
  */
472
526
  /**
473
527
  * @typedef ValidateProductGlobalTemplateParam
@@ -507,6 +561,8 @@ declare class CatalogPlatformValidator {
507
561
  static createBulkInventoryJob(): CreateBulkInventoryJobParam;
508
562
  /** @returns {CreateBulkProductUploadJobParam} */
509
563
  static createBulkProductUploadJob(): CreateBulkProductUploadJobParam;
564
+ /** @returns {CreateHsCodeParam} */
565
+ static createHsCode(): CreateHsCodeParam;
510
566
  /** @returns {CreateInventoryExportParam} */
511
567
  static createInventoryExport(): CreateInventoryExportParam;
512
568
  /** @returns {CreateInventoryExportJobParam} */
@@ -525,6 +581,12 @@ declare class CatalogPlatformValidator {
525
581
  static createProductsInBulk(): CreateProductsInBulkParam;
526
582
  /** @returns {CreateSizeGuideParam} */
527
583
  static createSizeGuide(): CreateSizeGuideParam;
584
+ /** @returns {CreateTaxParam} */
585
+ static createTax(): CreateTaxParam;
586
+ /** @returns {CreateTaxComponentNameParam} */
587
+ static createTaxComponentName(): CreateTaxComponentNameParam;
588
+ /** @returns {CreateTaxVersionParam} */
589
+ static createTaxVersion(): CreateTaxVersionParam;
528
590
  /** @returns {DeleteBulkInventoryJobParam} */
529
591
  static deleteBulkInventoryJob(): DeleteBulkInventoryJobParam;
530
592
  /** @returns {DeleteProductParam} */
@@ -535,6 +597,10 @@ declare class CatalogPlatformValidator {
535
597
  static deleteRealtimeInventory(): DeleteRealtimeInventoryParam;
536
598
  /** @returns {DeleteSizeParam} */
537
599
  static deleteSize(): DeleteSizeParam;
600
+ /** @returns {DeleteTaxRuleParam} */
601
+ static deleteTaxRule(): DeleteTaxRuleParam;
602
+ /** @returns {DeleteTaxVersionParam} */
603
+ static deleteTaxVersion(): DeleteTaxVersionParam;
538
604
  /** @returns {DownloadInventoryTemplateViewParam} */
539
605
  static downloadInventoryTemplateView(): DownloadInventoryTemplateViewParam;
540
606
  /** @returns {DownloadProductTemplateViewsParam} */
@@ -545,6 +611,8 @@ declare class CatalogPlatformValidator {
545
611
  static exportInventoryConfig(): ExportInventoryConfigParam;
546
612
  /** @returns {GetAllProductHsnCodesParam} */
547
613
  static getAllProductHsnCodes(): GetAllProductHsnCodesParam;
614
+ /** @returns {GetAllTaxRulesParam} */
615
+ static getAllTaxRules(): GetAllTaxRulesParam;
548
616
  /** @returns {GetAttributeParam} */
549
617
  static getAttribute(): GetAttributeParam;
550
618
  /** @returns {GetCategoryDataParam} */
@@ -557,6 +625,8 @@ declare class CatalogPlatformValidator {
557
625
  static getCompanyMetrics(): any;
558
626
  /** @returns {GetDepartmentDataParam} */
559
627
  static getDepartmentData(): GetDepartmentDataParam;
628
+ /** @returns {GetHsCodesParam} */
629
+ static getHsCodes(): GetHsCodesParam;
560
630
  /** @returns {GetHsnCodeParam} */
561
631
  static getHsnCode(): GetHsnCodeParam;
562
632
  /** @returns {GetInventoriesParam} */
@@ -607,6 +677,10 @@ declare class CatalogPlatformValidator {
607
677
  static getSizeGuides(): GetSizeGuidesParam;
608
678
  /** @returns {GetStoreDetailParam} */
609
679
  static getStoreDetail(): GetStoreDetailParam;
680
+ /** @returns {GetTaxComponentNamesParam} */
681
+ static getTaxComponentNames(): any;
682
+ /** @returns {GetTaxVersionDetailsParam} */
683
+ static getTaxVersionDetails(): GetTaxVersionDetailsParam;
610
684
  /** @returns {GetVariantsOfProductsParam} */
611
685
  static getVariantsOfProducts(): GetVariantsOfProductsParam;
612
686
  /** @returns {ListCategoriesParam} */
@@ -641,8 +715,10 @@ declare class CatalogPlatformValidator {
641
715
  static updateRealtimeInventory(): UpdateRealtimeInventoryParam;
642
716
  /** @returns {UpdateSizeGuideParam} */
643
717
  static updateSizeGuide(): UpdateSizeGuideParam;
644
- /** @returns {UploadBulkProductsParam} */
645
- static uploadBulkProducts(): UploadBulkProductsParam;
718
+ /** @returns {UpdateTaxRuleParam} */
719
+ static updateTaxRule(): UpdateTaxRuleParam;
720
+ /** @returns {UpdateTaxVersionParam} */
721
+ static updateTaxVersion(): UpdateTaxVersionParam;
646
722
  /** @returns {ValidateProductGlobalTemplateParam} */
647
723
  static validateProductGlobalTemplate(): ValidateProductGlobalTemplateParam;
648
724
  /** @returns {ValidateProductTemplateParam} */
@@ -651,7 +727,7 @@ declare class CatalogPlatformValidator {
651
727
  static validateProductTemplateSchema(): ValidateProductTemplateSchemaParam;
652
728
  }
653
729
  declare namespace CatalogPlatformValidator {
654
- export { AddInventoryParam, AllSizesParam, BulkHsnCodeParam, CreateBulkInventoryParam, CreateBulkInventoryJobParam, CreateBulkProductUploadJobParam, CreateInventoryExportParam, CreateInventoryExportJobParam, CreateMarketplaceOptinParam, CreateProductParam, CreateProductAssetsInBulkParam, CreateProductBundleParam, CreateProductExportJobParam, CreateProductsInBulkParam, CreateSizeGuideParam, DeleteBulkInventoryJobParam, DeleteProductParam, DeleteProductBulkJobParam, DeleteRealtimeInventoryParam, DeleteSizeParam, DownloadInventoryTemplateViewParam, DownloadProductTemplateViewsParam, EditProductParam, ExportInventoryConfigParam, GetAllProductHsnCodesParam, GetAttributeParam, GetCategoryDataParam, GetCompanyBrandDetailParam, GetCompanyDetailParam, GetCompanyMetricsParam, GetDepartmentDataParam, 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, UpdateHsnCodeParam, UpdateInventoriesParam, UpdateLocationPriceParam, UpdateLocationQuantityParam, UpdateMarketplaceOptinParam, UpdateProductBundleParam, UpdateRealtimeInventoryParam, UpdateSizeGuideParam, UploadBulkProductsParam, ValidateProductGlobalTemplateParam, ValidateProductTemplateParam, ValidateProductTemplateSchemaParam };
730
+ export { AddInventoryParam, AllSizesParam, BulkHsnCodeParam, CreateBulkInventoryParam, CreateBulkInventoryJobParam, CreateBulkProductUploadJobParam, CreateHsCodeParam, CreateInventoryExportParam, CreateInventoryExportJobParam, CreateMarketplaceOptinParam, CreateProductParam, CreateProductAssetsInBulkParam, CreateProductBundleParam, CreateProductExportJobParam, CreateProductsInBulkParam, CreateSizeGuideParam, CreateTaxParam, CreateTaxComponentNameParam, CreateTaxVersionParam, DeleteBulkInventoryJobParam, DeleteProductParam, DeleteProductBulkJobParam, DeleteRealtimeInventoryParam, DeleteSizeParam, DeleteTaxRuleParam, DeleteTaxVersionParam, DownloadInventoryTemplateViewParam, DownloadProductTemplateViewsParam, EditProductParam, ExportInventoryConfigParam, GetAllProductHsnCodesParam, GetAllTaxRulesParam, GetAttributeParam, GetCategoryDataParam, GetCompanyBrandDetailParam, GetCompanyDetailParam, GetCompanyMetricsParam, GetDepartmentDataParam, GetHsCodesParam, GetHsnCodeParam, GetInventoriesParam, GetInventoryBulkUploadHistoryParam, GetInventoryBySizeParam, GetInventoryBySizeIdentifierParam, GetInventoryExportParam, GetMarketplaceOptinDetailParam, GetMarketplacesParam, GetOptimalLocationsParam, GetProductParam, GetProductAssetsInBulkParam, GetProductAttributesParam, GetProductBulkUploadHistoryParam, GetProductBundleParam, GetProductBundleDetailParam, GetProductExportJobsParam, GetProductSizeParam, GetProductTagsParam, GetProductValidationParam, GetProductsParam, GetSellerInsightsParam, GetSingleProductHSNCodeParam, GetSizeGuideParam, GetSizeGuidesParam, GetStoreDetailParam, GetTaxComponentNamesParam, GetTaxVersionDetailsParam, GetVariantsOfProductsParam, ListCategoriesParam, ListDepartmentsDataParam, ListHSNCodesParam, ListInventoryExportParam, ListProductTemplateParam, ListProductTemplateCategoriesParam, ListProductTemplateExportDetailsParam, ListTemplateBrandTypeValuesParam, UpdateHsnCodeParam, UpdateInventoriesParam, UpdateLocationPriceParam, UpdateLocationQuantityParam, UpdateMarketplaceOptinParam, UpdateProductBundleParam, UpdateRealtimeInventoryParam, UpdateSizeGuideParam, UpdateTaxRuleParam, UpdateTaxVersionParam, ValidateProductGlobalTemplateParam, ValidateProductTemplateParam, ValidateProductTemplateSchemaParam };
655
731
  }
656
732
  type AddInventoryParam = {
657
733
  /**
@@ -686,6 +762,9 @@ type CreateBulkInventoryJobParam = {
686
762
  type CreateBulkProductUploadJobParam = {
687
763
  body: CatalogPlatformModel.BulkJob;
688
764
  };
765
+ type CreateHsCodeParam = {
766
+ body: CatalogPlatformModel.HSCodeItem;
767
+ };
689
768
  type CreateInventoryExportParam = {
690
769
  body: CatalogPlatformModel.InventoryCreateRequestSchema;
691
770
  };
@@ -701,7 +780,7 @@ type CreateMarketplaceOptinParam = {
701
780
  body: CatalogPlatformModel.OptInPostRequestSchema;
702
781
  };
703
782
  type CreateProductParam = {
704
- body: CatalogPlatformModel.ProductCreateSchemaV2;
783
+ body: CatalogPlatformModel.ProductCreateSchemaV3;
705
784
  };
706
785
  type CreateProductAssetsInBulkParam = {
707
786
  body: CatalogPlatformModel.ProductBulkAssets;
@@ -722,6 +801,19 @@ type CreateProductsInBulkParam = {
722
801
  type CreateSizeGuideParam = {
723
802
  body: CatalogPlatformModel.ValidateSizeGuide;
724
803
  };
804
+ type CreateTaxParam = {
805
+ body: CatalogPlatformModel.CreateTaxRequestBody;
806
+ };
807
+ type CreateTaxComponentNameParam = {
808
+ body: CatalogPlatformModel.CreateTaxComponentNameRequestSchema;
809
+ };
810
+ type CreateTaxVersionParam = {
811
+ /**
812
+ * - The ID of the tax rule.
813
+ */
814
+ ruleId: string;
815
+ body: CatalogPlatformModel.CreateTaxVersionRequestBody;
816
+ };
725
817
  type DeleteBulkInventoryJobParam = {
726
818
  /**
727
819
  * - Batch Id of the bulk delete job.
@@ -762,6 +854,22 @@ type DeleteSizeParam = {
762
854
  */
763
855
  size: string;
764
856
  };
857
+ type DeleteTaxRuleParam = {
858
+ /**
859
+ * - The ID of the tax rule to be deleted.
860
+ */
861
+ ruleId: string;
862
+ };
863
+ type DeleteTaxVersionParam = {
864
+ /**
865
+ * - The ID of the tax rule to be deleted.
866
+ */
867
+ ruleId: string;
868
+ /**
869
+ * - The ID of the tax version to be deleted.
870
+ */
871
+ versionId: string;
872
+ };
765
873
  type DownloadInventoryTemplateViewParam = {
766
874
  /**
767
875
  * - Specifies the type of template to download.
@@ -793,7 +901,7 @@ type EditProductParam = {
793
901
  * - Id of the product to be updated.
794
902
  */
795
903
  itemId: number;
796
- body: CatalogPlatformModel.ProductUpdateSchemaV2;
904
+ body: CatalogPlatformModel.ProductUpdateSchemaV3;
797
905
  };
798
906
  type ExportInventoryConfigParam = {
799
907
  /**
@@ -820,6 +928,28 @@ type GetAllProductHsnCodesParam = {
820
928
  */
821
929
  type?: string;
822
930
  };
931
+ type GetAllTaxRulesParam = {
932
+ /**
933
+ * - The search query to filter tax rules.
934
+ */
935
+ q?: string;
936
+ /**
937
+ * - The status of the tax rules to filter.
938
+ */
939
+ statuses?: string;
940
+ /**
941
+ * - The page number to retrieve.
942
+ */
943
+ page?: number;
944
+ /**
945
+ * - The number of items per page.
946
+ */
947
+ limit?: number;
948
+ /**
949
+ * - The status of the tax rule versions to filter.
950
+ */
951
+ versionStatus?: string;
952
+ };
823
953
  type GetAttributeParam = {
824
954
  /**
825
955
  * - Slug of the attribute for which you want
@@ -863,6 +993,24 @@ type GetDepartmentDataParam = {
863
993
  */
864
994
  uid: string;
865
995
  };
996
+ type GetHsCodesParam = {
997
+ /**
998
+ * - The page number for pagination.
999
+ */
1000
+ page?: number;
1001
+ /**
1002
+ * - The number of items to return per page.
1003
+ */
1004
+ limit?: number;
1005
+ /**
1006
+ * - Filter by HS/SAC code type.
1007
+ */
1008
+ type?: CatalogPlatformModel.HsTypeEnum;
1009
+ /**
1010
+ * - Search query to filter HS/SAC codes by code or description.
1011
+ */
1012
+ q?: string;
1013
+ };
866
1014
  type GetHsnCodeParam = {
867
1015
  /**
868
1016
  * - Unique id
@@ -1302,6 +1450,25 @@ type GetStoreDetailParam = {
1302
1450
  */
1303
1451
  pageSize?: number;
1304
1452
  };
1453
+ type GetTaxVersionDetailsParam = {
1454
+ /**
1455
+ * - The ID of the tax rule.
1456
+ */
1457
+ ruleId: string;
1458
+ /**
1459
+ * - Filter by tax version status.
1460
+ */
1461
+ versionStatus?: string;
1462
+ /**
1463
+ * - The number of items to return per page for
1464
+ * paginated past versions.
1465
+ */
1466
+ limit?: string;
1467
+ /**
1468
+ * - The page number for paginated past versions.
1469
+ */
1470
+ page?: string;
1471
+ };
1305
1472
  type GetVariantsOfProductsParam = {
1306
1473
  /**
1307
1474
  * - Get list of variants of item Id
@@ -1532,17 +1699,23 @@ type UpdateSizeGuideParam = {
1532
1699
  id: string;
1533
1700
  body: CatalogPlatformModel.ValidateSizeGuide;
1534
1701
  };
1535
- type UploadBulkProductsParam = {
1702
+ type UpdateTaxRuleParam = {
1536
1703
  /**
1537
- * - Department of the product to be uploaded.
1704
+ * - Tax rule id that you want to update.
1538
1705
  */
1539
- department: string;
1706
+ ruleId: string;
1707
+ body: CatalogPlatformModel.UpdateTaxRequestBody;
1708
+ };
1709
+ type UpdateTaxVersionParam = {
1710
+ /**
1711
+ * - The ID of the tax rule to be updated.
1712
+ */
1713
+ ruleId: string;
1540
1714
  /**
1541
- * - Product type of the product to be uploaded
1542
- * i.e. set, standard, digital.
1715
+ * - The ID of the tax version to be updated.
1543
1716
  */
1544
- productType: string;
1545
- body: CatalogPlatformModel.BulkProductJob;
1717
+ versionId: string;
1718
+ body: CatalogPlatformModel.UpdateTaxVersionRequestBody;
1546
1719
  };
1547
1720
  type ValidateProductGlobalTemplateParam = {
1548
1721
  /**
@@ -1594,6 +1767,7 @@ type GetMarketplaceOptinDetailParam = any;
1594
1767
  type GetMarketplacesParam = any;
1595
1768
  type GetProductTagsParam = any;
1596
1769
  type GetProductValidationParam = any;
1770
+ type GetTaxComponentNamesParam = any;
1597
1771
  type ListHSNCodesParam = any;
1598
1772
  type ListProductTemplateExportDetailsParam = any;
1599
1773
  import CatalogPlatformModel = require("./CatalogPlatformModel");
@@ -35,6 +35,11 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
35
35
  * @property {CatalogPlatformModel.BulkJob} body
36
36
  */
37
37
 
38
+ /**
39
+ * @typedef CreateHsCodeParam
40
+ * @property {CatalogPlatformModel.HSCodeItem} body
41
+ */
42
+
38
43
  /**
39
44
  * @typedef CreateInventoryExportParam
40
45
  * @property {CatalogPlatformModel.InventoryCreateRequestSchema} body
@@ -54,7 +59,7 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
54
59
 
55
60
  /**
56
61
  * @typedef CreateProductParam
57
- * @property {CatalogPlatformModel.ProductCreateSchemaV2} body
62
+ * @property {CatalogPlatformModel.ProductCreateSchemaV3} body
58
63
  */
59
64
 
60
65
  /**
@@ -83,6 +88,22 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
83
88
  * @property {CatalogPlatformModel.ValidateSizeGuide} body
84
89
  */
85
90
 
91
+ /**
92
+ * @typedef CreateTaxParam
93
+ * @property {CatalogPlatformModel.CreateTaxRequestBody} body
94
+ */
95
+
96
+ /**
97
+ * @typedef CreateTaxComponentNameParam
98
+ * @property {CatalogPlatformModel.CreateTaxComponentNameRequestSchema} body
99
+ */
100
+
101
+ /**
102
+ * @typedef CreateTaxVersionParam
103
+ * @property {string} ruleId - The ID of the tax rule.
104
+ * @property {CatalogPlatformModel.CreateTaxVersionRequestBody} body
105
+ */
106
+
86
107
  /**
87
108
  * @typedef DeleteBulkInventoryJobParam
88
109
  * @property {string} batchId - Batch Id of the bulk delete job.
@@ -112,6 +133,17 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
112
133
  * @property {string} size - Size to be deleted.
113
134
  */
114
135
 
136
+ /**
137
+ * @typedef DeleteTaxRuleParam
138
+ * @property {string} ruleId - The ID of the tax rule to be deleted.
139
+ */
140
+
141
+ /**
142
+ * @typedef DeleteTaxVersionParam
143
+ * @property {string} ruleId - The ID of the tax rule to be deleted.
144
+ * @property {string} versionId - The ID of the tax version to be deleted.
145
+ */
146
+
115
147
  /**
116
148
  * @typedef DownloadInventoryTemplateViewParam
117
149
  * @property {string} schemaType - Specifies the type of template to download.
@@ -130,7 +162,7 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
130
162
  /**
131
163
  * @typedef EditProductParam
132
164
  * @property {number} itemId - Id of the product to be updated.
133
- * @property {CatalogPlatformModel.ProductUpdateSchemaV2} body
165
+ * @property {CatalogPlatformModel.ProductUpdateSchemaV3} body
134
166
  */
135
167
 
136
168
  /**
@@ -147,6 +179,15 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
147
179
  * @property {string} [type] - Search using type
148
180
  */
149
181
 
182
+ /**
183
+ * @typedef GetAllTaxRulesParam
184
+ * @property {string} [q] - The search query to filter tax rules.
185
+ * @property {string} [statuses] - The status of the tax rules to filter.
186
+ * @property {number} [page] - The page number to retrieve.
187
+ * @property {number} [limit] - The number of items per page.
188
+ * @property {string} [versionStatus] - The status of the tax rule versions to filter.
189
+ */
190
+
150
191
  /**
151
192
  * @typedef GetAttributeParam
152
193
  * @property {string} attributeSlug - Slug of the attribute for which you want
@@ -178,6 +219,14 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
178
219
  * @property {string} uid - A `uid` is a unique identifier of a department.
179
220
  */
180
221
 
222
+ /**
223
+ * @typedef GetHsCodesParam
224
+ * @property {number} [page] - The page number for pagination.
225
+ * @property {number} [limit] - The number of items to return per page.
226
+ * @property {CatalogPlatformModel.HsTypeEnum} [type] - Filter by HS/SAC code type.
227
+ * @property {string} [q] - Search query to filter HS/SAC codes by code or description.
228
+ */
229
+
181
230
  /**
182
231
  * @typedef GetHsnCodeParam
183
232
  * @property {string} id - Unique id
@@ -400,6 +449,17 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
400
449
  * page for the company id.
401
450
  */
402
451
 
452
+ /** @typedef GetTaxComponentNamesParam */
453
+
454
+ /**
455
+ * @typedef GetTaxVersionDetailsParam
456
+ * @property {string} ruleId - The ID of the tax rule.
457
+ * @property {string} [versionStatus] - Filter by tax version status.
458
+ * @property {string} [limit] - The number of items to return per page for
459
+ * paginated past versions.
460
+ * @property {string} [page] - The page number for paginated past versions.
461
+ */
462
+
403
463
  /**
404
464
  * @typedef GetVariantsOfProductsParam
405
465
  * @property {number} itemId - Get list of variants of item Id
@@ -539,11 +599,16 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
539
599
  */
540
600
 
541
601
  /**
542
- * @typedef UploadBulkProductsParam
543
- * @property {string} department - Department of the product to be uploaded.
544
- * @property {string} productType - Product type of the product to be uploaded
545
- * i.e. set, standard, digital.
546
- * @property {CatalogPlatformModel.BulkProductJob} body
602
+ * @typedef UpdateTaxRuleParam
603
+ * @property {string} ruleId - Tax rule id that you want to update.
604
+ * @property {CatalogPlatformModel.UpdateTaxRequestBody} body
605
+ */
606
+
607
+ /**
608
+ * @typedef UpdateTaxVersionParam
609
+ * @property {string} ruleId - The ID of the tax rule to be updated.
610
+ * @property {string} versionId - The ID of the tax version to be updated.
611
+ * @property {CatalogPlatformModel.UpdateTaxVersionRequestBody} body
547
612
  */
548
613
 
549
614
  /**
@@ -620,6 +685,13 @@ class CatalogPlatformValidator {
620
685
  }).required();
621
686
  }
622
687
 
688
+ /** @returns {CreateHsCodeParam} */
689
+ static createHsCode() {
690
+ return Joi.object({
691
+ body: CatalogPlatformModel.HSCodeItem().required(),
692
+ }).required();
693
+ }
694
+
623
695
  /** @returns {CreateInventoryExportParam} */
624
696
  static createInventoryExport() {
625
697
  return Joi.object({
@@ -645,7 +717,7 @@ class CatalogPlatformValidator {
645
717
  /** @returns {CreateProductParam} */
646
718
  static createProduct() {
647
719
  return Joi.object({
648
- body: CatalogPlatformModel.ProductCreateSchemaV2().required(),
720
+ body: CatalogPlatformModel.ProductCreateSchemaV3().required(),
649
721
  }).required();
650
722
  }
651
723
 
@@ -685,6 +757,28 @@ class CatalogPlatformValidator {
685
757
  }).required();
686
758
  }
687
759
 
760
+ /** @returns {CreateTaxParam} */
761
+ static createTax() {
762
+ return Joi.object({
763
+ body: CatalogPlatformModel.CreateTaxRequestBody().required(),
764
+ }).required();
765
+ }
766
+
767
+ /** @returns {CreateTaxComponentNameParam} */
768
+ static createTaxComponentName() {
769
+ return Joi.object({
770
+ body: CatalogPlatformModel.CreateTaxComponentNameRequestSchema().required(),
771
+ }).required();
772
+ }
773
+
774
+ /** @returns {CreateTaxVersionParam} */
775
+ static createTaxVersion() {
776
+ return Joi.object({
777
+ ruleId: Joi.string().allow("").required(),
778
+ body: CatalogPlatformModel.CreateTaxVersionRequestBody().required(),
779
+ }).required();
780
+ }
781
+
688
782
  /** @returns {DeleteBulkInventoryJobParam} */
689
783
  static deleteBulkInventoryJob() {
690
784
  return Joi.object({
@@ -723,6 +817,21 @@ class CatalogPlatformValidator {
723
817
  }).required();
724
818
  }
725
819
 
820
+ /** @returns {DeleteTaxRuleParam} */
821
+ static deleteTaxRule() {
822
+ return Joi.object({
823
+ ruleId: Joi.string().allow("").required(),
824
+ }).required();
825
+ }
826
+
827
+ /** @returns {DeleteTaxVersionParam} */
828
+ static deleteTaxVersion() {
829
+ return Joi.object({
830
+ ruleId: Joi.string().allow("").required(),
831
+ versionId: Joi.string().allow("").required(),
832
+ }).required();
833
+ }
834
+
726
835
  /** @returns {DownloadInventoryTemplateViewParam} */
727
836
  static downloadInventoryTemplateView() {
728
837
  return Joi.object({
@@ -744,7 +853,7 @@ class CatalogPlatformValidator {
744
853
  static editProduct() {
745
854
  return Joi.object({
746
855
  itemId: Joi.number().required(),
747
- body: CatalogPlatformModel.ProductUpdateSchemaV2().required(),
856
+ body: CatalogPlatformModel.ProductUpdateSchemaV3().required(),
748
857
  }).required();
749
858
  }
750
859
 
@@ -765,6 +874,17 @@ class CatalogPlatformValidator {
765
874
  }).required();
766
875
  }
767
876
 
877
+ /** @returns {GetAllTaxRulesParam} */
878
+ static getAllTaxRules() {
879
+ return Joi.object({
880
+ q: Joi.string().allow(""),
881
+ statuses: Joi.string().allow(""),
882
+ page: Joi.number(),
883
+ limit: Joi.number(),
884
+ versionStatus: Joi.string().allow(""),
885
+ }).required();
886
+ }
887
+
768
888
  /** @returns {GetAttributeParam} */
769
889
  static getAttribute() {
770
890
  return Joi.object({
@@ -807,6 +927,16 @@ class CatalogPlatformValidator {
807
927
  }).required();
808
928
  }
809
929
 
930
+ /** @returns {GetHsCodesParam} */
931
+ static getHsCodes() {
932
+ return Joi.object({
933
+ page: Joi.number(),
934
+ limit: Joi.number(),
935
+ type: CatalogPlatformModel.HsTypeEnum(),
936
+ q: Joi.string().allow(""),
937
+ }).required();
938
+ }
939
+
810
940
  /** @returns {GetHsnCodeParam} */
811
941
  static getHsnCode() {
812
942
  return Joi.object({
@@ -1042,6 +1172,21 @@ class CatalogPlatformValidator {
1042
1172
  }).required();
1043
1173
  }
1044
1174
 
1175
+ /** @returns {GetTaxComponentNamesParam} */
1176
+ static getTaxComponentNames() {
1177
+ return Joi.object({}).required();
1178
+ }
1179
+
1180
+ /** @returns {GetTaxVersionDetailsParam} */
1181
+ static getTaxVersionDetails() {
1182
+ return Joi.object({
1183
+ ruleId: Joi.string().allow("").required(),
1184
+ versionStatus: Joi.string().allow(""),
1185
+ limit: Joi.string().allow(""),
1186
+ page: Joi.string().allow(""),
1187
+ }).required();
1188
+ }
1189
+
1045
1190
  /** @returns {GetVariantsOfProductsParam} */
1046
1191
  static getVariantsOfProducts() {
1047
1192
  return Joi.object({
@@ -1192,12 +1337,20 @@ class CatalogPlatformValidator {
1192
1337
  }).required();
1193
1338
  }
1194
1339
 
1195
- /** @returns {UploadBulkProductsParam} */
1196
- static uploadBulkProducts() {
1340
+ /** @returns {UpdateTaxRuleParam} */
1341
+ static updateTaxRule() {
1197
1342
  return Joi.object({
1198
- department: Joi.string().allow("").required(),
1199
- productType: Joi.string().allow("").required(),
1200
- body: CatalogPlatformModel.BulkProductJob().required(),
1343
+ ruleId: Joi.string().allow("").required(),
1344
+ body: CatalogPlatformModel.UpdateTaxRequestBody().required(),
1345
+ }).required();
1346
+ }
1347
+
1348
+ /** @returns {UpdateTaxVersionParam} */
1349
+ static updateTaxVersion() {
1350
+ return Joi.object({
1351
+ ruleId: Joi.string().allow("").required(),
1352
+ versionId: Joi.string().allow("").required(),
1353
+ body: CatalogPlatformModel.UpdateTaxVersionRequestBody().required(),
1201
1354
  }).required();
1202
1355
  }
1203
1356