@gofynd/fdk-client-javascript 3.4.4 → 3.6.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.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/ApplicationAPIClient.d.ts +1 -1
- package/sdk/application/ApplicationClient.d.ts +1 -1
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +50 -0
- package/sdk/application/Payment/PaymentApplicationClient.js +210 -0
- package/sdk/partner/OAuthClient.d.ts +3 -3
- package/sdk/partner/PartnerAPIClient.d.ts +1 -1
- package/sdk/partner/PartnerClient.d.ts +2 -2
- package/sdk/platform/Cart/CartPlatformModel.d.ts +11 -0
- package/sdk/platform/Cart/CartPlatformModel.js +5 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1 -4
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +0 -5
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +0 -2
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +125 -1
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1075 -95
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1017 -46
- package/sdk/platform/Catalog/CatalogPlatformModel.js +681 -5
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +200 -5
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +174 -4
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +17 -1
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +15 -0
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +9 -4
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +4 -4
- package/sdk/platform/OAuthClient.d.ts +3 -3
- package/sdk/platform/Order/OrderPlatformModel.d.ts +49 -1
- package/sdk/platform/Order/OrderPlatformModel.js +28 -0
- package/sdk/platform/PlatformAPIClient.d.ts +1 -1
- package/sdk/platform/PlatformClient.d.ts +2 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +13 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +89 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +25 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +17 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +50 -11
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +36 -4
- package/sdk/public/PublicAPIClient.d.ts +1 -1
|
@@ -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.
|
|
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.CreateTaxComponentName} 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.
|
|
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
|
|
@@ -462,6 +512,17 @@ export = CatalogPlatformValidator;
|
|
|
462
512
|
* @property {string} id - Identifier of the size guide to be edited
|
|
463
513
|
* @property {CatalogPlatformModel.ValidateSizeGuide} body
|
|
464
514
|
*/
|
|
515
|
+
/**
|
|
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
|
|
525
|
+
*/
|
|
465
526
|
/**
|
|
466
527
|
* @typedef UploadBulkProductsParam
|
|
467
528
|
* @property {string} department - Department of the product to be uploaded.
|
|
@@ -507,6 +568,8 @@ declare class CatalogPlatformValidator {
|
|
|
507
568
|
static createBulkInventoryJob(): CreateBulkInventoryJobParam;
|
|
508
569
|
/** @returns {CreateBulkProductUploadJobParam} */
|
|
509
570
|
static createBulkProductUploadJob(): CreateBulkProductUploadJobParam;
|
|
571
|
+
/** @returns {CreateHsCodeParam} */
|
|
572
|
+
static createHsCode(): CreateHsCodeParam;
|
|
510
573
|
/** @returns {CreateInventoryExportParam} */
|
|
511
574
|
static createInventoryExport(): CreateInventoryExportParam;
|
|
512
575
|
/** @returns {CreateInventoryExportJobParam} */
|
|
@@ -525,6 +588,12 @@ declare class CatalogPlatformValidator {
|
|
|
525
588
|
static createProductsInBulk(): CreateProductsInBulkParam;
|
|
526
589
|
/** @returns {CreateSizeGuideParam} */
|
|
527
590
|
static createSizeGuide(): CreateSizeGuideParam;
|
|
591
|
+
/** @returns {CreateTaxParam} */
|
|
592
|
+
static createTax(): CreateTaxParam;
|
|
593
|
+
/** @returns {CreateTaxComponentNameParam} */
|
|
594
|
+
static createTaxComponentName(): CreateTaxComponentNameParam;
|
|
595
|
+
/** @returns {CreateTaxVersionParam} */
|
|
596
|
+
static createTaxVersion(): CreateTaxVersionParam;
|
|
528
597
|
/** @returns {DeleteBulkInventoryJobParam} */
|
|
529
598
|
static deleteBulkInventoryJob(): DeleteBulkInventoryJobParam;
|
|
530
599
|
/** @returns {DeleteProductParam} */
|
|
@@ -535,6 +604,10 @@ declare class CatalogPlatformValidator {
|
|
|
535
604
|
static deleteRealtimeInventory(): DeleteRealtimeInventoryParam;
|
|
536
605
|
/** @returns {DeleteSizeParam} */
|
|
537
606
|
static deleteSize(): DeleteSizeParam;
|
|
607
|
+
/** @returns {DeleteTaxRuleParam} */
|
|
608
|
+
static deleteTaxRule(): DeleteTaxRuleParam;
|
|
609
|
+
/** @returns {DeleteTaxVersionParam} */
|
|
610
|
+
static deleteTaxVersion(): DeleteTaxVersionParam;
|
|
538
611
|
/** @returns {DownloadInventoryTemplateViewParam} */
|
|
539
612
|
static downloadInventoryTemplateView(): DownloadInventoryTemplateViewParam;
|
|
540
613
|
/** @returns {DownloadProductTemplateViewsParam} */
|
|
@@ -545,6 +618,8 @@ declare class CatalogPlatformValidator {
|
|
|
545
618
|
static exportInventoryConfig(): ExportInventoryConfigParam;
|
|
546
619
|
/** @returns {GetAllProductHsnCodesParam} */
|
|
547
620
|
static getAllProductHsnCodes(): GetAllProductHsnCodesParam;
|
|
621
|
+
/** @returns {GetAllTaxRulesParam} */
|
|
622
|
+
static getAllTaxRules(): GetAllTaxRulesParam;
|
|
548
623
|
/** @returns {GetAttributeParam} */
|
|
549
624
|
static getAttribute(): GetAttributeParam;
|
|
550
625
|
/** @returns {GetCategoryDataParam} */
|
|
@@ -557,6 +632,8 @@ declare class CatalogPlatformValidator {
|
|
|
557
632
|
static getCompanyMetrics(): any;
|
|
558
633
|
/** @returns {GetDepartmentDataParam} */
|
|
559
634
|
static getDepartmentData(): GetDepartmentDataParam;
|
|
635
|
+
/** @returns {GetHsCodesParam} */
|
|
636
|
+
static getHsCodes(): GetHsCodesParam;
|
|
560
637
|
/** @returns {GetHsnCodeParam} */
|
|
561
638
|
static getHsnCode(): GetHsnCodeParam;
|
|
562
639
|
/** @returns {GetInventoriesParam} */
|
|
@@ -607,6 +684,10 @@ declare class CatalogPlatformValidator {
|
|
|
607
684
|
static getSizeGuides(): GetSizeGuidesParam;
|
|
608
685
|
/** @returns {GetStoreDetailParam} */
|
|
609
686
|
static getStoreDetail(): GetStoreDetailParam;
|
|
687
|
+
/** @returns {GetTaxComponentNamesParam} */
|
|
688
|
+
static getTaxComponentNames(): any;
|
|
689
|
+
/** @returns {GetTaxVersionDetailsParam} */
|
|
690
|
+
static getTaxVersionDetails(): GetTaxVersionDetailsParam;
|
|
610
691
|
/** @returns {GetVariantsOfProductsParam} */
|
|
611
692
|
static getVariantsOfProducts(): GetVariantsOfProductsParam;
|
|
612
693
|
/** @returns {ListCategoriesParam} */
|
|
@@ -641,6 +722,10 @@ declare class CatalogPlatformValidator {
|
|
|
641
722
|
static updateRealtimeInventory(): UpdateRealtimeInventoryParam;
|
|
642
723
|
/** @returns {UpdateSizeGuideParam} */
|
|
643
724
|
static updateSizeGuide(): UpdateSizeGuideParam;
|
|
725
|
+
/** @returns {UpdateTaxRuleParam} */
|
|
726
|
+
static updateTaxRule(): UpdateTaxRuleParam;
|
|
727
|
+
/** @returns {UpdateTaxVersionParam} */
|
|
728
|
+
static updateTaxVersion(): UpdateTaxVersionParam;
|
|
644
729
|
/** @returns {UploadBulkProductsParam} */
|
|
645
730
|
static uploadBulkProducts(): UploadBulkProductsParam;
|
|
646
731
|
/** @returns {ValidateProductGlobalTemplateParam} */
|
|
@@ -651,7 +736,7 @@ declare class CatalogPlatformValidator {
|
|
|
651
736
|
static validateProductTemplateSchema(): ValidateProductTemplateSchemaParam;
|
|
652
737
|
}
|
|
653
738
|
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 };
|
|
739
|
+
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, UploadBulkProductsParam, ValidateProductGlobalTemplateParam, ValidateProductTemplateParam, ValidateProductTemplateSchemaParam };
|
|
655
740
|
}
|
|
656
741
|
type AddInventoryParam = {
|
|
657
742
|
/**
|
|
@@ -686,6 +771,9 @@ type CreateBulkInventoryJobParam = {
|
|
|
686
771
|
type CreateBulkProductUploadJobParam = {
|
|
687
772
|
body: CatalogPlatformModel.BulkJob;
|
|
688
773
|
};
|
|
774
|
+
type CreateHsCodeParam = {
|
|
775
|
+
body: CatalogPlatformModel.HSCodeItem;
|
|
776
|
+
};
|
|
689
777
|
type CreateInventoryExportParam = {
|
|
690
778
|
body: CatalogPlatformModel.InventoryCreateRequestSchema;
|
|
691
779
|
};
|
|
@@ -701,7 +789,7 @@ type CreateMarketplaceOptinParam = {
|
|
|
701
789
|
body: CatalogPlatformModel.OptInPostRequestSchema;
|
|
702
790
|
};
|
|
703
791
|
type CreateProductParam = {
|
|
704
|
-
body: CatalogPlatformModel.
|
|
792
|
+
body: CatalogPlatformModel.ProductCreateSchemaV3;
|
|
705
793
|
};
|
|
706
794
|
type CreateProductAssetsInBulkParam = {
|
|
707
795
|
body: CatalogPlatformModel.ProductBulkAssets;
|
|
@@ -722,6 +810,19 @@ type CreateProductsInBulkParam = {
|
|
|
722
810
|
type CreateSizeGuideParam = {
|
|
723
811
|
body: CatalogPlatformModel.ValidateSizeGuide;
|
|
724
812
|
};
|
|
813
|
+
type CreateTaxParam = {
|
|
814
|
+
body: CatalogPlatformModel.CreateTaxRequestBody;
|
|
815
|
+
};
|
|
816
|
+
type CreateTaxComponentNameParam = {
|
|
817
|
+
body: CatalogPlatformModel.CreateTaxComponentName;
|
|
818
|
+
};
|
|
819
|
+
type CreateTaxVersionParam = {
|
|
820
|
+
/**
|
|
821
|
+
* - The ID of the tax rule.
|
|
822
|
+
*/
|
|
823
|
+
ruleId: string;
|
|
824
|
+
body: CatalogPlatformModel.CreateTaxVersionRequestBody;
|
|
825
|
+
};
|
|
725
826
|
type DeleteBulkInventoryJobParam = {
|
|
726
827
|
/**
|
|
727
828
|
* - Batch Id of the bulk delete job.
|
|
@@ -762,6 +863,22 @@ type DeleteSizeParam = {
|
|
|
762
863
|
*/
|
|
763
864
|
size: string;
|
|
764
865
|
};
|
|
866
|
+
type DeleteTaxRuleParam = {
|
|
867
|
+
/**
|
|
868
|
+
* - The ID of the tax rule to be deleted.
|
|
869
|
+
*/
|
|
870
|
+
ruleId: string;
|
|
871
|
+
};
|
|
872
|
+
type DeleteTaxVersionParam = {
|
|
873
|
+
/**
|
|
874
|
+
* - The ID of the tax rule to be deleted.
|
|
875
|
+
*/
|
|
876
|
+
ruleId: string;
|
|
877
|
+
/**
|
|
878
|
+
* - The ID of the tax version to be deleted.
|
|
879
|
+
*/
|
|
880
|
+
versionId: string;
|
|
881
|
+
};
|
|
765
882
|
type DownloadInventoryTemplateViewParam = {
|
|
766
883
|
/**
|
|
767
884
|
* - Specifies the type of template to download.
|
|
@@ -793,7 +910,7 @@ type EditProductParam = {
|
|
|
793
910
|
* - Id of the product to be updated.
|
|
794
911
|
*/
|
|
795
912
|
itemId: number;
|
|
796
|
-
body: CatalogPlatformModel.
|
|
913
|
+
body: CatalogPlatformModel.ProductUpdateSchemaV3;
|
|
797
914
|
};
|
|
798
915
|
type ExportInventoryConfigParam = {
|
|
799
916
|
/**
|
|
@@ -820,6 +937,28 @@ type GetAllProductHsnCodesParam = {
|
|
|
820
937
|
*/
|
|
821
938
|
type?: string;
|
|
822
939
|
};
|
|
940
|
+
type GetAllTaxRulesParam = {
|
|
941
|
+
/**
|
|
942
|
+
* - The search query to filter tax rules.
|
|
943
|
+
*/
|
|
944
|
+
q?: string;
|
|
945
|
+
/**
|
|
946
|
+
* - The status of the tax rules to filter.
|
|
947
|
+
*/
|
|
948
|
+
statuses?: string;
|
|
949
|
+
/**
|
|
950
|
+
* - The page number to retrieve.
|
|
951
|
+
*/
|
|
952
|
+
page?: number;
|
|
953
|
+
/**
|
|
954
|
+
* - The number of items per page.
|
|
955
|
+
*/
|
|
956
|
+
limit?: number;
|
|
957
|
+
/**
|
|
958
|
+
* - The status of the tax rule versions to filter.
|
|
959
|
+
*/
|
|
960
|
+
versionStatus?: string;
|
|
961
|
+
};
|
|
823
962
|
type GetAttributeParam = {
|
|
824
963
|
/**
|
|
825
964
|
* - Slug of the attribute for which you want
|
|
@@ -863,6 +1002,24 @@ type GetDepartmentDataParam = {
|
|
|
863
1002
|
*/
|
|
864
1003
|
uid: string;
|
|
865
1004
|
};
|
|
1005
|
+
type GetHsCodesParam = {
|
|
1006
|
+
/**
|
|
1007
|
+
* - The page number for pagination.
|
|
1008
|
+
*/
|
|
1009
|
+
page?: number;
|
|
1010
|
+
/**
|
|
1011
|
+
* - The number of items to return per page.
|
|
1012
|
+
*/
|
|
1013
|
+
limit?: number;
|
|
1014
|
+
/**
|
|
1015
|
+
* - Filter by HS/SAC code type.
|
|
1016
|
+
*/
|
|
1017
|
+
type?: CatalogPlatformModel.HsTypeEnum;
|
|
1018
|
+
/**
|
|
1019
|
+
* - Search query to filter HS/SAC codes by code or description.
|
|
1020
|
+
*/
|
|
1021
|
+
q?: string;
|
|
1022
|
+
};
|
|
866
1023
|
type GetHsnCodeParam = {
|
|
867
1024
|
/**
|
|
868
1025
|
* - Unique id
|
|
@@ -1302,6 +1459,25 @@ type GetStoreDetailParam = {
|
|
|
1302
1459
|
*/
|
|
1303
1460
|
pageSize?: number;
|
|
1304
1461
|
};
|
|
1462
|
+
type GetTaxVersionDetailsParam = {
|
|
1463
|
+
/**
|
|
1464
|
+
* - The ID of the tax rule.
|
|
1465
|
+
*/
|
|
1466
|
+
ruleId: string;
|
|
1467
|
+
/**
|
|
1468
|
+
* - Filter by tax version status.
|
|
1469
|
+
*/
|
|
1470
|
+
versionStatus?: string;
|
|
1471
|
+
/**
|
|
1472
|
+
* - The number of items to return per page for
|
|
1473
|
+
* paginated past versions.
|
|
1474
|
+
*/
|
|
1475
|
+
limit?: string;
|
|
1476
|
+
/**
|
|
1477
|
+
* - The page number for paginated past versions.
|
|
1478
|
+
*/
|
|
1479
|
+
page?: string;
|
|
1480
|
+
};
|
|
1305
1481
|
type GetVariantsOfProductsParam = {
|
|
1306
1482
|
/**
|
|
1307
1483
|
* - Get list of variants of item Id
|
|
@@ -1532,6 +1708,24 @@ type UpdateSizeGuideParam = {
|
|
|
1532
1708
|
id: string;
|
|
1533
1709
|
body: CatalogPlatformModel.ValidateSizeGuide;
|
|
1534
1710
|
};
|
|
1711
|
+
type UpdateTaxRuleParam = {
|
|
1712
|
+
/**
|
|
1713
|
+
* - Tax rule id that you want to update.
|
|
1714
|
+
*/
|
|
1715
|
+
ruleId: string;
|
|
1716
|
+
body: CatalogPlatformModel.UpdateTaxRequestBody;
|
|
1717
|
+
};
|
|
1718
|
+
type UpdateTaxVersionParam = {
|
|
1719
|
+
/**
|
|
1720
|
+
* - The ID of the tax rule to be updated.
|
|
1721
|
+
*/
|
|
1722
|
+
ruleId: string;
|
|
1723
|
+
/**
|
|
1724
|
+
* - The ID of the tax version to be updated.
|
|
1725
|
+
*/
|
|
1726
|
+
versionId: string;
|
|
1727
|
+
body: CatalogPlatformModel.UpdateTaxVersionRequestBody;
|
|
1728
|
+
};
|
|
1535
1729
|
type UploadBulkProductsParam = {
|
|
1536
1730
|
/**
|
|
1537
1731
|
* - Department of the product to be uploaded.
|
|
@@ -1594,6 +1788,7 @@ type GetMarketplaceOptinDetailParam = any;
|
|
|
1594
1788
|
type GetMarketplacesParam = any;
|
|
1595
1789
|
type GetProductTagsParam = any;
|
|
1596
1790
|
type GetProductValidationParam = any;
|
|
1791
|
+
type GetTaxComponentNamesParam = any;
|
|
1597
1792
|
type ListHSNCodesParam = any;
|
|
1598
1793
|
type ListProductTemplateExportDetailsParam = any;
|
|
1599
1794
|
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.
|
|
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.CreateTaxComponentName} 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.
|
|
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
|
|
@@ -538,6 +598,19 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
|
|
|
538
598
|
* @property {CatalogPlatformModel.ValidateSizeGuide} body
|
|
539
599
|
*/
|
|
540
600
|
|
|
601
|
+
/**
|
|
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
|
|
612
|
+
*/
|
|
613
|
+
|
|
541
614
|
/**
|
|
542
615
|
* @typedef UploadBulkProductsParam
|
|
543
616
|
* @property {string} department - Department of the product to be uploaded.
|
|
@@ -620,6 +693,13 @@ class CatalogPlatformValidator {
|
|
|
620
693
|
}).required();
|
|
621
694
|
}
|
|
622
695
|
|
|
696
|
+
/** @returns {CreateHsCodeParam} */
|
|
697
|
+
static createHsCode() {
|
|
698
|
+
return Joi.object({
|
|
699
|
+
body: CatalogPlatformModel.HSCodeItem().required(),
|
|
700
|
+
}).required();
|
|
701
|
+
}
|
|
702
|
+
|
|
623
703
|
/** @returns {CreateInventoryExportParam} */
|
|
624
704
|
static createInventoryExport() {
|
|
625
705
|
return Joi.object({
|
|
@@ -645,7 +725,7 @@ class CatalogPlatformValidator {
|
|
|
645
725
|
/** @returns {CreateProductParam} */
|
|
646
726
|
static createProduct() {
|
|
647
727
|
return Joi.object({
|
|
648
|
-
body: CatalogPlatformModel.
|
|
728
|
+
body: CatalogPlatformModel.ProductCreateSchemaV3().required(),
|
|
649
729
|
}).required();
|
|
650
730
|
}
|
|
651
731
|
|
|
@@ -685,6 +765,28 @@ class CatalogPlatformValidator {
|
|
|
685
765
|
}).required();
|
|
686
766
|
}
|
|
687
767
|
|
|
768
|
+
/** @returns {CreateTaxParam} */
|
|
769
|
+
static createTax() {
|
|
770
|
+
return Joi.object({
|
|
771
|
+
body: CatalogPlatformModel.CreateTaxRequestBody().required(),
|
|
772
|
+
}).required();
|
|
773
|
+
}
|
|
774
|
+
|
|
775
|
+
/** @returns {CreateTaxComponentNameParam} */
|
|
776
|
+
static createTaxComponentName() {
|
|
777
|
+
return Joi.object({
|
|
778
|
+
body: CatalogPlatformModel.CreateTaxComponentName().required(),
|
|
779
|
+
}).required();
|
|
780
|
+
}
|
|
781
|
+
|
|
782
|
+
/** @returns {CreateTaxVersionParam} */
|
|
783
|
+
static createTaxVersion() {
|
|
784
|
+
return Joi.object({
|
|
785
|
+
ruleId: Joi.string().allow("").required(),
|
|
786
|
+
body: CatalogPlatformModel.CreateTaxVersionRequestBody().required(),
|
|
787
|
+
}).required();
|
|
788
|
+
}
|
|
789
|
+
|
|
688
790
|
/** @returns {DeleteBulkInventoryJobParam} */
|
|
689
791
|
static deleteBulkInventoryJob() {
|
|
690
792
|
return Joi.object({
|
|
@@ -723,6 +825,21 @@ class CatalogPlatformValidator {
|
|
|
723
825
|
}).required();
|
|
724
826
|
}
|
|
725
827
|
|
|
828
|
+
/** @returns {DeleteTaxRuleParam} */
|
|
829
|
+
static deleteTaxRule() {
|
|
830
|
+
return Joi.object({
|
|
831
|
+
ruleId: Joi.string().allow("").required(),
|
|
832
|
+
}).required();
|
|
833
|
+
}
|
|
834
|
+
|
|
835
|
+
/** @returns {DeleteTaxVersionParam} */
|
|
836
|
+
static deleteTaxVersion() {
|
|
837
|
+
return Joi.object({
|
|
838
|
+
ruleId: Joi.string().allow("").required(),
|
|
839
|
+
versionId: Joi.string().allow("").required(),
|
|
840
|
+
}).required();
|
|
841
|
+
}
|
|
842
|
+
|
|
726
843
|
/** @returns {DownloadInventoryTemplateViewParam} */
|
|
727
844
|
static downloadInventoryTemplateView() {
|
|
728
845
|
return Joi.object({
|
|
@@ -744,7 +861,7 @@ class CatalogPlatformValidator {
|
|
|
744
861
|
static editProduct() {
|
|
745
862
|
return Joi.object({
|
|
746
863
|
itemId: Joi.number().required(),
|
|
747
|
-
body: CatalogPlatformModel.
|
|
864
|
+
body: CatalogPlatformModel.ProductUpdateSchemaV3().required(),
|
|
748
865
|
}).required();
|
|
749
866
|
}
|
|
750
867
|
|
|
@@ -765,6 +882,17 @@ class CatalogPlatformValidator {
|
|
|
765
882
|
}).required();
|
|
766
883
|
}
|
|
767
884
|
|
|
885
|
+
/** @returns {GetAllTaxRulesParam} */
|
|
886
|
+
static getAllTaxRules() {
|
|
887
|
+
return Joi.object({
|
|
888
|
+
q: Joi.string().allow(""),
|
|
889
|
+
statuses: Joi.string().allow(""),
|
|
890
|
+
page: Joi.number(),
|
|
891
|
+
limit: Joi.number(),
|
|
892
|
+
versionStatus: Joi.string().allow(""),
|
|
893
|
+
}).required();
|
|
894
|
+
}
|
|
895
|
+
|
|
768
896
|
/** @returns {GetAttributeParam} */
|
|
769
897
|
static getAttribute() {
|
|
770
898
|
return Joi.object({
|
|
@@ -807,6 +935,16 @@ class CatalogPlatformValidator {
|
|
|
807
935
|
}).required();
|
|
808
936
|
}
|
|
809
937
|
|
|
938
|
+
/** @returns {GetHsCodesParam} */
|
|
939
|
+
static getHsCodes() {
|
|
940
|
+
return Joi.object({
|
|
941
|
+
page: Joi.number(),
|
|
942
|
+
limit: Joi.number(),
|
|
943
|
+
type: CatalogPlatformModel.HsTypeEnum(),
|
|
944
|
+
q: Joi.string().allow(""),
|
|
945
|
+
}).required();
|
|
946
|
+
}
|
|
947
|
+
|
|
810
948
|
/** @returns {GetHsnCodeParam} */
|
|
811
949
|
static getHsnCode() {
|
|
812
950
|
return Joi.object({
|
|
@@ -1042,6 +1180,21 @@ class CatalogPlatformValidator {
|
|
|
1042
1180
|
}).required();
|
|
1043
1181
|
}
|
|
1044
1182
|
|
|
1183
|
+
/** @returns {GetTaxComponentNamesParam} */
|
|
1184
|
+
static getTaxComponentNames() {
|
|
1185
|
+
return Joi.object({}).required();
|
|
1186
|
+
}
|
|
1187
|
+
|
|
1188
|
+
/** @returns {GetTaxVersionDetailsParam} */
|
|
1189
|
+
static getTaxVersionDetails() {
|
|
1190
|
+
return Joi.object({
|
|
1191
|
+
ruleId: Joi.string().allow("").required(),
|
|
1192
|
+
versionStatus: Joi.string().allow(""),
|
|
1193
|
+
limit: Joi.string().allow(""),
|
|
1194
|
+
page: Joi.string().allow(""),
|
|
1195
|
+
}).required();
|
|
1196
|
+
}
|
|
1197
|
+
|
|
1045
1198
|
/** @returns {GetVariantsOfProductsParam} */
|
|
1046
1199
|
static getVariantsOfProducts() {
|
|
1047
1200
|
return Joi.object({
|
|
@@ -1192,6 +1345,23 @@ class CatalogPlatformValidator {
|
|
|
1192
1345
|
}).required();
|
|
1193
1346
|
}
|
|
1194
1347
|
|
|
1348
|
+
/** @returns {UpdateTaxRuleParam} */
|
|
1349
|
+
static updateTaxRule() {
|
|
1350
|
+
return Joi.object({
|
|
1351
|
+
ruleId: Joi.string().allow("").required(),
|
|
1352
|
+
body: CatalogPlatformModel.UpdateTaxRequestBody().required(),
|
|
1353
|
+
}).required();
|
|
1354
|
+
}
|
|
1355
|
+
|
|
1356
|
+
/** @returns {UpdateTaxVersionParam} */
|
|
1357
|
+
static updateTaxVersion() {
|
|
1358
|
+
return Joi.object({
|
|
1359
|
+
ruleId: Joi.string().allow("").required(),
|
|
1360
|
+
versionId: Joi.string().allow("").required(),
|
|
1361
|
+
body: CatalogPlatformModel.UpdateTaxVersionRequestBody().required(),
|
|
1362
|
+
}).required();
|
|
1363
|
+
}
|
|
1364
|
+
|
|
1195
1365
|
/** @returns {UploadBulkProductsParam} */
|
|
1196
1366
|
static uploadBulkProducts() {
|
|
1197
1367
|
return Joi.object({
|