@gofynd/fdk-client-javascript 3.6.0 → 3.7.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/Payment/PaymentApplicationClient.d.ts +0 -50
- package/sdk/application/Payment/PaymentApplicationClient.js +0 -210
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +4 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +5 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +2 -0
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +1 -125
- package/sdk/platform/Catalog/CatalogPlatformClient.js +131 -1111
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +228 -1009
- package/sdk/platform/Catalog/CatalogPlatformModel.js +102 -681
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +5 -200
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +4 -174
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +4 -9
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +4 -4
- package/sdk/platform/Order/OrderPlatformModel.d.ts +8 -60
- package/sdk/platform/Order/OrderPlatformModel.js +3 -33
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +2 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +3 -2
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +10 -6
- package/sdk/platform/Partner/PartnerPlatformModel.js +5 -3
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +10 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +4 -0
|
@@ -26,10 +26,6 @@ export = CatalogPlatformValidator;
|
|
|
26
26
|
* @typedef CreateBulkProductUploadJobParam
|
|
27
27
|
* @property {CatalogPlatformModel.BulkJob} body
|
|
28
28
|
*/
|
|
29
|
-
/**
|
|
30
|
-
* @typedef CreateHsCodeParam
|
|
31
|
-
* @property {CatalogPlatformModel.HSCodeItem} body
|
|
32
|
-
*/
|
|
33
29
|
/**
|
|
34
30
|
* @typedef CreateInventoryExportParam
|
|
35
31
|
* @property {CatalogPlatformModel.InventoryCreateRequestSchema} body
|
|
@@ -46,7 +42,7 @@ export = CatalogPlatformValidator;
|
|
|
46
42
|
*/
|
|
47
43
|
/**
|
|
48
44
|
* @typedef CreateProductParam
|
|
49
|
-
* @property {CatalogPlatformModel.
|
|
45
|
+
* @property {CatalogPlatformModel.ProductCreateSchemaV2} body
|
|
50
46
|
*/
|
|
51
47
|
/**
|
|
52
48
|
* @typedef CreateProductAssetsInBulkParam
|
|
@@ -69,19 +65,6 @@ export = CatalogPlatformValidator;
|
|
|
69
65
|
* @typedef CreateSizeGuideParam
|
|
70
66
|
* @property {CatalogPlatformModel.ValidateSizeGuide} body
|
|
71
67
|
*/
|
|
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
|
-
*/
|
|
85
68
|
/**
|
|
86
69
|
* @typedef DeleteBulkInventoryJobParam
|
|
87
70
|
* @property {string} batchId - Batch Id of the bulk delete job.
|
|
@@ -106,15 +89,6 @@ export = CatalogPlatformValidator;
|
|
|
106
89
|
* @property {number} itemId - Item Id of the product associated with size to be deleted.
|
|
107
90
|
* @property {string} size - Size to be deleted.
|
|
108
91
|
*/
|
|
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
|
-
*/
|
|
118
92
|
/**
|
|
119
93
|
* @typedef DownloadInventoryTemplateViewParam
|
|
120
94
|
* @property {string} schemaType - Specifies the type of template to download.
|
|
@@ -131,7 +105,7 @@ export = CatalogPlatformValidator;
|
|
|
131
105
|
/**
|
|
132
106
|
* @typedef EditProductParam
|
|
133
107
|
* @property {number} itemId - Id of the product to be updated.
|
|
134
|
-
* @property {CatalogPlatformModel.
|
|
108
|
+
* @property {CatalogPlatformModel.ProductUpdateSchemaV2} body
|
|
135
109
|
*/
|
|
136
110
|
/**
|
|
137
111
|
* @typedef ExportInventoryConfigParam
|
|
@@ -145,14 +119,6 @@ export = CatalogPlatformValidator;
|
|
|
145
119
|
* @property {string} [q] - Search using hsn code, description, reporting_hsn
|
|
146
120
|
* @property {string} [type] - Search using type
|
|
147
121
|
*/
|
|
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
|
-
*/
|
|
156
122
|
/**
|
|
157
123
|
* @typedef GetAttributeParam
|
|
158
124
|
* @property {string} attributeSlug - Slug of the attribute for which you want
|
|
@@ -178,13 +144,6 @@ export = CatalogPlatformValidator;
|
|
|
178
144
|
* @typedef GetDepartmentDataParam
|
|
179
145
|
* @property {string} uid - A `uid` is a unique identifier of a department.
|
|
180
146
|
*/
|
|
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
|
-
*/
|
|
188
147
|
/**
|
|
189
148
|
* @typedef GetHsnCodeParam
|
|
190
149
|
* @property {string} id - Unique id
|
|
@@ -382,15 +341,6 @@ export = CatalogPlatformValidator;
|
|
|
382
341
|
* @property {number} [pageSize] - Number of records that can be seen on the
|
|
383
342
|
* page for the company id.
|
|
384
343
|
*/
|
|
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
|
-
*/
|
|
394
344
|
/**
|
|
395
345
|
* @typedef GetVariantsOfProductsParam
|
|
396
346
|
* @property {number} itemId - Get list of variants of item Id
|
|
@@ -512,17 +462,6 @@ export = CatalogPlatformValidator;
|
|
|
512
462
|
* @property {string} id - Identifier of the size guide to be edited
|
|
513
463
|
* @property {CatalogPlatformModel.ValidateSizeGuide} body
|
|
514
464
|
*/
|
|
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
|
-
*/
|
|
526
465
|
/**
|
|
527
466
|
* @typedef UploadBulkProductsParam
|
|
528
467
|
* @property {string} department - Department of the product to be uploaded.
|
|
@@ -568,8 +507,6 @@ declare class CatalogPlatformValidator {
|
|
|
568
507
|
static createBulkInventoryJob(): CreateBulkInventoryJobParam;
|
|
569
508
|
/** @returns {CreateBulkProductUploadJobParam} */
|
|
570
509
|
static createBulkProductUploadJob(): CreateBulkProductUploadJobParam;
|
|
571
|
-
/** @returns {CreateHsCodeParam} */
|
|
572
|
-
static createHsCode(): CreateHsCodeParam;
|
|
573
510
|
/** @returns {CreateInventoryExportParam} */
|
|
574
511
|
static createInventoryExport(): CreateInventoryExportParam;
|
|
575
512
|
/** @returns {CreateInventoryExportJobParam} */
|
|
@@ -588,12 +525,6 @@ declare class CatalogPlatformValidator {
|
|
|
588
525
|
static createProductsInBulk(): CreateProductsInBulkParam;
|
|
589
526
|
/** @returns {CreateSizeGuideParam} */
|
|
590
527
|
static createSizeGuide(): CreateSizeGuideParam;
|
|
591
|
-
/** @returns {CreateTaxParam} */
|
|
592
|
-
static createTax(): CreateTaxParam;
|
|
593
|
-
/** @returns {CreateTaxComponentNameParam} */
|
|
594
|
-
static createTaxComponentName(): CreateTaxComponentNameParam;
|
|
595
|
-
/** @returns {CreateTaxVersionParam} */
|
|
596
|
-
static createTaxVersion(): CreateTaxVersionParam;
|
|
597
528
|
/** @returns {DeleteBulkInventoryJobParam} */
|
|
598
529
|
static deleteBulkInventoryJob(): DeleteBulkInventoryJobParam;
|
|
599
530
|
/** @returns {DeleteProductParam} */
|
|
@@ -604,10 +535,6 @@ declare class CatalogPlatformValidator {
|
|
|
604
535
|
static deleteRealtimeInventory(): DeleteRealtimeInventoryParam;
|
|
605
536
|
/** @returns {DeleteSizeParam} */
|
|
606
537
|
static deleteSize(): DeleteSizeParam;
|
|
607
|
-
/** @returns {DeleteTaxRuleParam} */
|
|
608
|
-
static deleteTaxRule(): DeleteTaxRuleParam;
|
|
609
|
-
/** @returns {DeleteTaxVersionParam} */
|
|
610
|
-
static deleteTaxVersion(): DeleteTaxVersionParam;
|
|
611
538
|
/** @returns {DownloadInventoryTemplateViewParam} */
|
|
612
539
|
static downloadInventoryTemplateView(): DownloadInventoryTemplateViewParam;
|
|
613
540
|
/** @returns {DownloadProductTemplateViewsParam} */
|
|
@@ -618,8 +545,6 @@ declare class CatalogPlatformValidator {
|
|
|
618
545
|
static exportInventoryConfig(): ExportInventoryConfigParam;
|
|
619
546
|
/** @returns {GetAllProductHsnCodesParam} */
|
|
620
547
|
static getAllProductHsnCodes(): GetAllProductHsnCodesParam;
|
|
621
|
-
/** @returns {GetAllTaxRulesParam} */
|
|
622
|
-
static getAllTaxRules(): GetAllTaxRulesParam;
|
|
623
548
|
/** @returns {GetAttributeParam} */
|
|
624
549
|
static getAttribute(): GetAttributeParam;
|
|
625
550
|
/** @returns {GetCategoryDataParam} */
|
|
@@ -632,8 +557,6 @@ declare class CatalogPlatformValidator {
|
|
|
632
557
|
static getCompanyMetrics(): any;
|
|
633
558
|
/** @returns {GetDepartmentDataParam} */
|
|
634
559
|
static getDepartmentData(): GetDepartmentDataParam;
|
|
635
|
-
/** @returns {GetHsCodesParam} */
|
|
636
|
-
static getHsCodes(): GetHsCodesParam;
|
|
637
560
|
/** @returns {GetHsnCodeParam} */
|
|
638
561
|
static getHsnCode(): GetHsnCodeParam;
|
|
639
562
|
/** @returns {GetInventoriesParam} */
|
|
@@ -684,10 +607,6 @@ declare class CatalogPlatformValidator {
|
|
|
684
607
|
static getSizeGuides(): GetSizeGuidesParam;
|
|
685
608
|
/** @returns {GetStoreDetailParam} */
|
|
686
609
|
static getStoreDetail(): GetStoreDetailParam;
|
|
687
|
-
/** @returns {GetTaxComponentNamesParam} */
|
|
688
|
-
static getTaxComponentNames(): any;
|
|
689
|
-
/** @returns {GetTaxVersionDetailsParam} */
|
|
690
|
-
static getTaxVersionDetails(): GetTaxVersionDetailsParam;
|
|
691
610
|
/** @returns {GetVariantsOfProductsParam} */
|
|
692
611
|
static getVariantsOfProducts(): GetVariantsOfProductsParam;
|
|
693
612
|
/** @returns {ListCategoriesParam} */
|
|
@@ -722,10 +641,6 @@ declare class CatalogPlatformValidator {
|
|
|
722
641
|
static updateRealtimeInventory(): UpdateRealtimeInventoryParam;
|
|
723
642
|
/** @returns {UpdateSizeGuideParam} */
|
|
724
643
|
static updateSizeGuide(): UpdateSizeGuideParam;
|
|
725
|
-
/** @returns {UpdateTaxRuleParam} */
|
|
726
|
-
static updateTaxRule(): UpdateTaxRuleParam;
|
|
727
|
-
/** @returns {UpdateTaxVersionParam} */
|
|
728
|
-
static updateTaxVersion(): UpdateTaxVersionParam;
|
|
729
644
|
/** @returns {UploadBulkProductsParam} */
|
|
730
645
|
static uploadBulkProducts(): UploadBulkProductsParam;
|
|
731
646
|
/** @returns {ValidateProductGlobalTemplateParam} */
|
|
@@ -736,7 +651,7 @@ declare class CatalogPlatformValidator {
|
|
|
736
651
|
static validateProductTemplateSchema(): ValidateProductTemplateSchemaParam;
|
|
737
652
|
}
|
|
738
653
|
declare namespace CatalogPlatformValidator {
|
|
739
|
-
export { AddInventoryParam, AllSizesParam, BulkHsnCodeParam, CreateBulkInventoryParam, CreateBulkInventoryJobParam, CreateBulkProductUploadJobParam,
|
|
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 };
|
|
740
655
|
}
|
|
741
656
|
type AddInventoryParam = {
|
|
742
657
|
/**
|
|
@@ -771,9 +686,6 @@ type CreateBulkInventoryJobParam = {
|
|
|
771
686
|
type CreateBulkProductUploadJobParam = {
|
|
772
687
|
body: CatalogPlatformModel.BulkJob;
|
|
773
688
|
};
|
|
774
|
-
type CreateHsCodeParam = {
|
|
775
|
-
body: CatalogPlatformModel.HSCodeItem;
|
|
776
|
-
};
|
|
777
689
|
type CreateInventoryExportParam = {
|
|
778
690
|
body: CatalogPlatformModel.InventoryCreateRequestSchema;
|
|
779
691
|
};
|
|
@@ -789,7 +701,7 @@ type CreateMarketplaceOptinParam = {
|
|
|
789
701
|
body: CatalogPlatformModel.OptInPostRequestSchema;
|
|
790
702
|
};
|
|
791
703
|
type CreateProductParam = {
|
|
792
|
-
body: CatalogPlatformModel.
|
|
704
|
+
body: CatalogPlatformModel.ProductCreateSchemaV2;
|
|
793
705
|
};
|
|
794
706
|
type CreateProductAssetsInBulkParam = {
|
|
795
707
|
body: CatalogPlatformModel.ProductBulkAssets;
|
|
@@ -810,19 +722,6 @@ type CreateProductsInBulkParam = {
|
|
|
810
722
|
type CreateSizeGuideParam = {
|
|
811
723
|
body: CatalogPlatformModel.ValidateSizeGuide;
|
|
812
724
|
};
|
|
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
|
-
};
|
|
826
725
|
type DeleteBulkInventoryJobParam = {
|
|
827
726
|
/**
|
|
828
727
|
* - Batch Id of the bulk delete job.
|
|
@@ -863,22 +762,6 @@ type DeleteSizeParam = {
|
|
|
863
762
|
*/
|
|
864
763
|
size: string;
|
|
865
764
|
};
|
|
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
|
-
};
|
|
882
765
|
type DownloadInventoryTemplateViewParam = {
|
|
883
766
|
/**
|
|
884
767
|
* - Specifies the type of template to download.
|
|
@@ -910,7 +793,7 @@ type EditProductParam = {
|
|
|
910
793
|
* - Id of the product to be updated.
|
|
911
794
|
*/
|
|
912
795
|
itemId: number;
|
|
913
|
-
body: CatalogPlatformModel.
|
|
796
|
+
body: CatalogPlatformModel.ProductUpdateSchemaV2;
|
|
914
797
|
};
|
|
915
798
|
type ExportInventoryConfigParam = {
|
|
916
799
|
/**
|
|
@@ -937,28 +820,6 @@ type GetAllProductHsnCodesParam = {
|
|
|
937
820
|
*/
|
|
938
821
|
type?: string;
|
|
939
822
|
};
|
|
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
|
-
};
|
|
962
823
|
type GetAttributeParam = {
|
|
963
824
|
/**
|
|
964
825
|
* - Slug of the attribute for which you want
|
|
@@ -1002,24 +863,6 @@ type GetDepartmentDataParam = {
|
|
|
1002
863
|
*/
|
|
1003
864
|
uid: string;
|
|
1004
865
|
};
|
|
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
|
-
};
|
|
1023
866
|
type GetHsnCodeParam = {
|
|
1024
867
|
/**
|
|
1025
868
|
* - Unique id
|
|
@@ -1459,25 +1302,6 @@ type GetStoreDetailParam = {
|
|
|
1459
1302
|
*/
|
|
1460
1303
|
pageSize?: number;
|
|
1461
1304
|
};
|
|
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
|
-
};
|
|
1481
1305
|
type GetVariantsOfProductsParam = {
|
|
1482
1306
|
/**
|
|
1483
1307
|
* - Get list of variants of item Id
|
|
@@ -1708,24 +1532,6 @@ type UpdateSizeGuideParam = {
|
|
|
1708
1532
|
id: string;
|
|
1709
1533
|
body: CatalogPlatformModel.ValidateSizeGuide;
|
|
1710
1534
|
};
|
|
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
|
-
};
|
|
1729
1535
|
type UploadBulkProductsParam = {
|
|
1730
1536
|
/**
|
|
1731
1537
|
* - Department of the product to be uploaded.
|
|
@@ -1788,7 +1594,6 @@ type GetMarketplaceOptinDetailParam = any;
|
|
|
1788
1594
|
type GetMarketplacesParam = any;
|
|
1789
1595
|
type GetProductTagsParam = any;
|
|
1790
1596
|
type GetProductValidationParam = any;
|
|
1791
|
-
type GetTaxComponentNamesParam = any;
|
|
1792
1597
|
type ListHSNCodesParam = any;
|
|
1793
1598
|
type ListProductTemplateExportDetailsParam = any;
|
|
1794
1599
|
import CatalogPlatformModel = require("./CatalogPlatformModel");
|
|
@@ -35,11 +35,6 @@ 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
|
-
|
|
43
38
|
/**
|
|
44
39
|
* @typedef CreateInventoryExportParam
|
|
45
40
|
* @property {CatalogPlatformModel.InventoryCreateRequestSchema} body
|
|
@@ -59,7 +54,7 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
|
|
|
59
54
|
|
|
60
55
|
/**
|
|
61
56
|
* @typedef CreateProductParam
|
|
62
|
-
* @property {CatalogPlatformModel.
|
|
57
|
+
* @property {CatalogPlatformModel.ProductCreateSchemaV2} body
|
|
63
58
|
*/
|
|
64
59
|
|
|
65
60
|
/**
|
|
@@ -88,22 +83,6 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
|
|
|
88
83
|
* @property {CatalogPlatformModel.ValidateSizeGuide} body
|
|
89
84
|
*/
|
|
90
85
|
|
|
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
|
-
|
|
107
86
|
/**
|
|
108
87
|
* @typedef DeleteBulkInventoryJobParam
|
|
109
88
|
* @property {string} batchId - Batch Id of the bulk delete job.
|
|
@@ -133,17 +112,6 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
|
|
|
133
112
|
* @property {string} size - Size to be deleted.
|
|
134
113
|
*/
|
|
135
114
|
|
|
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
|
-
|
|
147
115
|
/**
|
|
148
116
|
* @typedef DownloadInventoryTemplateViewParam
|
|
149
117
|
* @property {string} schemaType - Specifies the type of template to download.
|
|
@@ -162,7 +130,7 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
|
|
|
162
130
|
/**
|
|
163
131
|
* @typedef EditProductParam
|
|
164
132
|
* @property {number} itemId - Id of the product to be updated.
|
|
165
|
-
* @property {CatalogPlatformModel.
|
|
133
|
+
* @property {CatalogPlatformModel.ProductUpdateSchemaV2} body
|
|
166
134
|
*/
|
|
167
135
|
|
|
168
136
|
/**
|
|
@@ -179,15 +147,6 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
|
|
|
179
147
|
* @property {string} [type] - Search using type
|
|
180
148
|
*/
|
|
181
149
|
|
|
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
|
-
|
|
191
150
|
/**
|
|
192
151
|
* @typedef GetAttributeParam
|
|
193
152
|
* @property {string} attributeSlug - Slug of the attribute for which you want
|
|
@@ -219,14 +178,6 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
|
|
|
219
178
|
* @property {string} uid - A `uid` is a unique identifier of a department.
|
|
220
179
|
*/
|
|
221
180
|
|
|
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
|
-
|
|
230
181
|
/**
|
|
231
182
|
* @typedef GetHsnCodeParam
|
|
232
183
|
* @property {string} id - Unique id
|
|
@@ -449,17 +400,6 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
|
|
|
449
400
|
* page for the company id.
|
|
450
401
|
*/
|
|
451
402
|
|
|
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
|
-
|
|
463
403
|
/**
|
|
464
404
|
* @typedef GetVariantsOfProductsParam
|
|
465
405
|
* @property {number} itemId - Get list of variants of item Id
|
|
@@ -598,19 +538,6 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
|
|
|
598
538
|
* @property {CatalogPlatformModel.ValidateSizeGuide} body
|
|
599
539
|
*/
|
|
600
540
|
|
|
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
|
-
|
|
614
541
|
/**
|
|
615
542
|
* @typedef UploadBulkProductsParam
|
|
616
543
|
* @property {string} department - Department of the product to be uploaded.
|
|
@@ -693,13 +620,6 @@ class CatalogPlatformValidator {
|
|
|
693
620
|
}).required();
|
|
694
621
|
}
|
|
695
622
|
|
|
696
|
-
/** @returns {CreateHsCodeParam} */
|
|
697
|
-
static createHsCode() {
|
|
698
|
-
return Joi.object({
|
|
699
|
-
body: CatalogPlatformModel.HSCodeItem().required(),
|
|
700
|
-
}).required();
|
|
701
|
-
}
|
|
702
|
-
|
|
703
623
|
/** @returns {CreateInventoryExportParam} */
|
|
704
624
|
static createInventoryExport() {
|
|
705
625
|
return Joi.object({
|
|
@@ -725,7 +645,7 @@ class CatalogPlatformValidator {
|
|
|
725
645
|
/** @returns {CreateProductParam} */
|
|
726
646
|
static createProduct() {
|
|
727
647
|
return Joi.object({
|
|
728
|
-
body: CatalogPlatformModel.
|
|
648
|
+
body: CatalogPlatformModel.ProductCreateSchemaV2().required(),
|
|
729
649
|
}).required();
|
|
730
650
|
}
|
|
731
651
|
|
|
@@ -765,28 +685,6 @@ class CatalogPlatformValidator {
|
|
|
765
685
|
}).required();
|
|
766
686
|
}
|
|
767
687
|
|
|
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
|
-
|
|
790
688
|
/** @returns {DeleteBulkInventoryJobParam} */
|
|
791
689
|
static deleteBulkInventoryJob() {
|
|
792
690
|
return Joi.object({
|
|
@@ -825,21 +723,6 @@ class CatalogPlatformValidator {
|
|
|
825
723
|
}).required();
|
|
826
724
|
}
|
|
827
725
|
|
|
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
|
-
|
|
843
726
|
/** @returns {DownloadInventoryTemplateViewParam} */
|
|
844
727
|
static downloadInventoryTemplateView() {
|
|
845
728
|
return Joi.object({
|
|
@@ -861,7 +744,7 @@ class CatalogPlatformValidator {
|
|
|
861
744
|
static editProduct() {
|
|
862
745
|
return Joi.object({
|
|
863
746
|
itemId: Joi.number().required(),
|
|
864
|
-
body: CatalogPlatformModel.
|
|
747
|
+
body: CatalogPlatformModel.ProductUpdateSchemaV2().required(),
|
|
865
748
|
}).required();
|
|
866
749
|
}
|
|
867
750
|
|
|
@@ -882,17 +765,6 @@ class CatalogPlatformValidator {
|
|
|
882
765
|
}).required();
|
|
883
766
|
}
|
|
884
767
|
|
|
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
|
-
|
|
896
768
|
/** @returns {GetAttributeParam} */
|
|
897
769
|
static getAttribute() {
|
|
898
770
|
return Joi.object({
|
|
@@ -935,16 +807,6 @@ class CatalogPlatformValidator {
|
|
|
935
807
|
}).required();
|
|
936
808
|
}
|
|
937
809
|
|
|
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
|
-
|
|
948
810
|
/** @returns {GetHsnCodeParam} */
|
|
949
811
|
static getHsnCode() {
|
|
950
812
|
return Joi.object({
|
|
@@ -1180,21 +1042,6 @@ class CatalogPlatformValidator {
|
|
|
1180
1042
|
}).required();
|
|
1181
1043
|
}
|
|
1182
1044
|
|
|
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
|
-
|
|
1198
1045
|
/** @returns {GetVariantsOfProductsParam} */
|
|
1199
1046
|
static getVariantsOfProducts() {
|
|
1200
1047
|
return Joi.object({
|
|
@@ -1345,23 +1192,6 @@ class CatalogPlatformValidator {
|
|
|
1345
1192
|
}).required();
|
|
1346
1193
|
}
|
|
1347
1194
|
|
|
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
|
-
|
|
1365
1195
|
/** @returns {UploadBulkProductsParam} */
|
|
1366
1196
|
static uploadBulkProducts() {
|
|
1367
1197
|
return Joi.object({
|