@gofynd/fdk-client-javascript 3.0.0-beta.1 → 3.0.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/ApplicationClient.d.ts +2 -0
- package/sdk/application/ApplicationClient.js +2 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +93 -113
- package/sdk/application/Cart/CartApplicationClient.js +157 -530
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +110 -110
- package/sdk/application/Catalog/CatalogApplicationClient.js +214 -447
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +4 -19
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -43
- package/sdk/application/Communication/CommunicationApplicationClient.js +4 -214
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +41 -54
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +39 -192
- package/sdk/application/Content/ContentApplicationClient.d.ts +65 -55
- package/sdk/application/Content/ContentApplicationClient.js +211 -341
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -6
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +14 -33
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +111 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +6 -6
- package/sdk/application/Lead/LeadApplicationClient.js +24 -55
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +32 -87
- package/sdk/application/Logistic/LogisticApplicationClient.js +126 -383
- package/sdk/application/Order/OrderApplicationClient.d.ts +31 -51
- package/sdk/application/Order/OrderApplicationClient.js +89 -293
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +108 -218
- package/sdk/application/Payment/PaymentApplicationClient.js +100 -1081
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +14 -14
- package/sdk/application/Rewards/RewardsApplicationClient.js +13 -66
- package/sdk/application/Share/ShareApplicationClient.d.ts +11 -11
- package/sdk/application/Share/ShareApplicationClient.js +35 -89
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +5 -25
- package/sdk/application/Theme/ThemeApplicationClient.js +24 -150
- package/sdk/application/User/UserApplicationClient.d.ts +23 -13
- package/sdk/application/User/UserApplicationClient.js +49 -407
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +4 -11
- package/sdk/common/Utility.d.ts +1 -1
- package/sdk/common/Utility.js +10 -7
- package/sdk/common/Validator.d.ts +1 -0
- package/sdk/common/Validator.js +20 -0
- package/sdk/common/utils.d.ts +0 -1
- package/sdk/common/utils.js +0 -14
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +18 -62
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +40 -372
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +99 -33
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +84 -25
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +1 -5
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +7 -38
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerClient.js +4 -4
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +52 -98
- package/sdk/partner/Lead/LeadPartnerModel.js +76 -100
- package/sdk/partner/Lead/LeadPartnerValidator.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +172 -41
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +1222 -85
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1921 -297
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +973 -258
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +13 -1
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +148 -16
- package/sdk/partner/PartnerClient.d.ts +0 -6
- package/sdk/partner/PartnerClient.js +0 -9
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +21 -63
- package/sdk/partner/Theme/ThemePartnerClient.js +67 -392
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +72 -104
- package/sdk/partner/Theme/ThemePartnerModel.js +75 -101
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +1 -5
- package/sdk/partner/Theme/ThemePartnerValidator.js +12 -42
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +673 -189
- package/sdk/partner/Webhook/WebhookPartnerModel.js +270 -159
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -3
- package/sdk/partner/index.d.ts +0 -3
- package/sdk/partner/index.js +0 -6
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +4 -1
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +3 -3
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +3 -3
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +2 -32
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -243
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +49 -145
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +20 -171
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +15 -406
- package/sdk/platform/Billing/BillingPlatformClient.js +76 -3214
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +459 -3798
- package/sdk/platform/Billing/BillingPlatformModel.js +338 -2573
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +24 -465
- package/sdk/platform/Billing/BillingPlatformValidator.js +14 -490
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +205 -284
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +554 -672
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +165 -165
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +132 -108
- package/sdk/platform/Cart/CartPlatformModel.d.ts +4865 -3148
- package/sdk/platform/Cart/CartPlatformModel.js +2071 -2854
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +419 -1015
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +2004 -6444
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +226 -1117
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +127 -919
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +574 -372
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1315 -1238
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +9334 -7634
- package/sdk/platform/Catalog/CatalogPlatformModel.js +6980 -9652
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +239 -294
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +186 -246
- package/sdk/platform/Common/CommonPlatformClient.d.ts +6 -5
- package/sdk/platform/Common/CommonPlatformClient.js +6 -5
- package/sdk/platform/Common/CommonPlatformModel.d.ts +19 -25
- package/sdk/platform/Common/CommonPlatformModel.js +11 -14
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +236 -376
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +579 -868
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +139 -170
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +126 -145
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +3 -56
- package/sdk/platform/Communication/CommunicationPlatformClient.js +4 -307
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +314 -422
- package/sdk/platform/Communication/CommunicationPlatformModel.js +382 -538
- package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +3 -62
- package/sdk/platform/Communication/CommunicationPlatformValidator.js +2 -48
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +72 -68
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +88 -84
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +270 -241
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +248 -226
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +20 -20
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +20 -20
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +118 -333
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +409 -1470
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +55 -158
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +41 -163
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +65 -142
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +103 -568
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +565 -1282
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +369 -1034
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +34 -80
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +24 -79
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +302 -246
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1297 -776
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +330 -218
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +325 -208
- package/sdk/platform/Content/ContentPlatformClient.d.ts +279 -118
- package/sdk/platform/Content/ContentPlatformClient.js +1617 -492
- package/sdk/platform/Content/ContentPlatformModel.d.ts +2374 -877
- package/sdk/platform/Content/ContentPlatformModel.js +1304 -930
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +272 -134
- package/sdk/platform/Content/ContentPlatformValidator.js +295 -118
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +53 -43
- package/sdk/platform/Discount/DiscountPlatformClient.js +53 -43
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +383 -110
- package/sdk/platform/Discount/DiscountPlatformModel.js +117 -108
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +56 -36
- package/sdk/platform/Discount/DiscountPlatformValidator.js +29 -19
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +4 -163
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +4 -1078
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +5 -141
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -177
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +30 -1123
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +24 -1135
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +17 -17
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +33 -33
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +19 -19
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +14 -14
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +24 -4
- package/sdk/platform/Lead/LeadPlatformClient.js +160 -4
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +60 -140
- package/sdk/platform/Lead/LeadPlatformModel.js +81 -162
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +29 -3
- package/sdk/platform/Lead/LeadPlatformValidator.js +28 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +19 -98
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +27 -662
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +91 -118
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +32 -127
- package/sdk/platform/Order/OrderPlatformClient.d.ts +421 -418
- package/sdk/platform/Order/OrderPlatformClient.js +1194 -1350
- package/sdk/platform/Order/OrderPlatformModel.d.ts +9145 -4107
- package/sdk/platform/Order/OrderPlatformModel.js +4257 -3197
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +641 -442
- package/sdk/platform/Order/OrderPlatformValidator.js +341 -311
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +9 -7
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +67 -19
- package/sdk/platform/Partner/PartnerPlatformModel.js +26 -17
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +135 -382
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +934 -2452
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +93 -306
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +70 -305
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +56 -66
- package/sdk/platform/Payment/PaymentPlatformClient.js +124 -269
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +1327 -3529
- package/sdk/platform/Payment/PaymentPlatformModel.js +1397 -3693
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +35 -64
- package/sdk/platform/Payment/PaymentPlatformValidator.js +34 -60
- package/sdk/platform/PlatformClient.d.ts +0 -2
- package/sdk/platform/PlatformClient.js +0 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +12 -12
- package/sdk/platform/Rewards/RewardsPlatformModel.js +10 -10
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +64 -136
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +111 -513
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +75 -103
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +50 -99
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +162 -127
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +775 -435
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +6250 -3861
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +3178 -3798
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +295 -199
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +205 -133
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +16 -4
- package/sdk/platform/Share/SharePlatformApplicationClient.js +86 -8
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +23 -6
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +16 -3
- package/sdk/platform/Share/SharePlatformModel.d.ts +53 -4
- package/sdk/platform/Share/SharePlatformModel.js +45 -3
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +4 -26
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +10 -157
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +10 -21
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +6 -23
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +8 -18
- package/sdk/platform/Theme/ThemePlatformClient.js +8 -85
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +17 -425
- package/sdk/platform/Theme/ThemePlatformModel.js +23 -329
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +3 -7
- package/sdk/platform/Theme/ThemePlatformValidator.js +2 -9
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +81 -18
- package/sdk/platform/User/UserPlatformApplicationClient.js +491 -27
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +126 -10
- package/sdk/platform/User/UserPlatformApplicationValidator.js +92 -7
- package/sdk/platform/User/UserPlatformModel.d.ts +317 -218
- package/sdk/platform/User/UserPlatformModel.js +253 -210
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +25 -78
- package/sdk/platform/Webhook/WebhookPlatformClient.js +75 -470
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +813 -426
- package/sdk/platform/Webhook/WebhookPlatformModel.js +446 -395
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
- package/sdk/platform/index.d.ts +0 -1
- package/sdk/platform/index.js +0 -2
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +22 -0
- package/sdk/public/Catalog/CatalogPublicClient.js +133 -0
- package/sdk/public/Catalog/CatalogPublicModel.d.ts +158 -0
- package/sdk/public/Catalog/CatalogPublicModel.js +116 -0
- package/sdk/public/Catalog/CatalogPublicValidator.d.ts +55 -0
- package/sdk/public/Catalog/CatalogPublicValidator.js +35 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +4 -14
- package/sdk/public/Configuration/ConfigurationPublicClient.js +10 -113
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +46 -114
- package/sdk/public/Configuration/ConfigurationPublicModel.js +32 -117
- package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +1 -11
- package/sdk/public/Configuration/ConfigurationPublicValidator.js +0 -12
- package/sdk/public/Content/ContentPublicClient.d.ts +36 -25
- package/sdk/public/Content/ContentPublicClient.js +254 -280
- package/sdk/public/Content/ContentPublicModel.d.ts +151 -38
- package/sdk/public/Content/ContentPublicModel.js +98 -44
- package/sdk/public/Content/ContentPublicValidator.d.ts +18 -17
- package/sdk/public/Content/ContentPublicValidator.js +26 -19
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +6 -11
- package/sdk/public/Partner/PartnerPublicModel.d.ts +248 -72
- package/sdk/public/Partner/PartnerPublicModel.js +81 -71
- package/sdk/public/Partner/PartnerPublicValidator.d.ts +2 -2
- package/sdk/public/Partner/PartnerPublicValidator.js +1 -1
- package/sdk/public/PublicClient.d.ts +2 -2
- package/sdk/public/PublicClient.js +2 -2
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +9 -48
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +215 -67
- package/sdk/public/Webhook/WebhookPublicModel.js +66 -61
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/public/index.d.ts +1 -1
- package/sdk/public/index.js +1 -1
- package/sdk/partner/Authorization/AuthorizationPartnerClient.d.ts +0 -66
- package/sdk/partner/Authorization/AuthorizationPartnerClient.js +0 -431
- package/sdk/partner/Authorization/AuthorizationPartnerModel.d.ts +0 -231
- package/sdk/partner/Authorization/AuthorizationPartnerModel.js +0 -152
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.d.ts +0 -8
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.js +0 -39
- package/sdk/partner/Catalog/CatalogPartnerClient.d.ts +0 -26
- package/sdk/partner/Catalog/CatalogPartnerClient.js +0 -173
- package/sdk/partner/Catalog/CatalogPartnerModel.d.ts +0 -238
- package/sdk/partner/Catalog/CatalogPartnerModel.js +0 -248
- package/sdk/partner/Catalog/CatalogPartnerValidator.d.ts +0 -5
- package/sdk/partner/Catalog/CatalogPartnerValidator.js +0 -19
- package/sdk/partner/Payment/PaymentPartnerClient.d.ts +0 -116
- package/sdk/partner/Payment/PaymentPartnerClient.js +0 -857
- package/sdk/partner/Payment/PaymentPartnerModel.d.ts +0 -388
- package/sdk/partner/Payment/PaymentPartnerModel.js +0 -442
- package/sdk/partner/Payment/PaymentPartnerValidator.d.ts +0 -14
- package/sdk/partner/Payment/PaymentPartnerValidator.js +0 -74
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
- package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2895
- package/sdk/platform/Finance/FinancePlatformModel.js +0 -2150
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
- package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
- package/sdk/public/Billing/BillingPublicClient.d.ts +0 -56
- package/sdk/public/Billing/BillingPublicClient.js +0 -397
- package/sdk/public/Billing/BillingPublicModel.d.ts +0 -919
- package/sdk/public/Billing/BillingPublicModel.js +0 -560
- package/sdk/public/Billing/BillingPublicValidator.d.ts +0 -43
- package/sdk/public/Billing/BillingPublicValidator.js +0 -50
|
@@ -1,45 +1,48 @@
|
|
|
1
1
|
export = CatalogPlatformValidator;
|
|
2
|
+
/**
|
|
3
|
+
* @typedef AddInventoryParam
|
|
4
|
+
* @property {number} itemId - Item id of the product of which size is to be get.
|
|
5
|
+
* @property {string} size - Size in which inventory is to be added.
|
|
6
|
+
* @property {CatalogPlatformModel.InventoryRequestSchema} body
|
|
7
|
+
*/
|
|
2
8
|
/**
|
|
3
9
|
* @typedef AllSizesParam
|
|
4
10
|
* @property {number} itemId - Id of the product to be updated.
|
|
5
11
|
*/
|
|
12
|
+
/**
|
|
13
|
+
* @typedef BulkHsnCodeParam
|
|
14
|
+
* @property {CatalogPlatformModel.BulkHsnUpsert} body
|
|
15
|
+
*/
|
|
6
16
|
/**
|
|
7
17
|
* @typedef CreateBulkInventoryParam
|
|
8
18
|
* @property {string} batchId - Batch Id of the bulk create job.
|
|
9
|
-
* @property {CatalogPlatformModel.
|
|
19
|
+
* @property {CatalogPlatformModel.InventoryBulkRequestSchema} body
|
|
10
20
|
*/
|
|
11
21
|
/**
|
|
12
22
|
* @typedef CreateBulkInventoryJobParam
|
|
13
|
-
* @property {CatalogPlatformModel.
|
|
23
|
+
* @property {CatalogPlatformModel.BulkJob} body
|
|
14
24
|
*/
|
|
15
25
|
/**
|
|
16
26
|
* @typedef CreateBulkProductUploadJobParam
|
|
17
|
-
* @property {CatalogPlatformModel.
|
|
18
|
-
*/
|
|
19
|
-
/**
|
|
20
|
-
* @typedef CreateCategoriesParam
|
|
21
|
-
* @property {CatalogPlatformModel.CategoryRequestBody} body
|
|
22
|
-
*/
|
|
23
|
-
/**
|
|
24
|
-
* @typedef CreateDepartmentsParam
|
|
25
|
-
* @property {CatalogPlatformModel.DepartmentCreateUpdate} body
|
|
27
|
+
* @property {CatalogPlatformModel.BulkJob} body
|
|
26
28
|
*/
|
|
27
29
|
/**
|
|
28
30
|
* @typedef CreateInventoryExportParam
|
|
29
|
-
* @property {CatalogPlatformModel.
|
|
31
|
+
* @property {CatalogPlatformModel.InventoryCreateRequestSchema} body
|
|
30
32
|
*/
|
|
31
33
|
/**
|
|
32
34
|
* @typedef CreateInventoryExportJobParam
|
|
33
|
-
* @property {CatalogPlatformModel.
|
|
35
|
+
* @property {CatalogPlatformModel.InventoryExportRequestSchema} body
|
|
34
36
|
*/
|
|
35
37
|
/**
|
|
36
38
|
* @typedef CreateMarketplaceOptinParam
|
|
37
|
-
* @property {string}
|
|
38
|
-
*
|
|
39
|
+
* @property {string} marketplaceSlug - The marketplace for which the detail
|
|
40
|
+
* needs to be retrieved.
|
|
41
|
+
* @property {CatalogPlatformModel.OptInPostRequestSchema} body
|
|
39
42
|
*/
|
|
40
43
|
/**
|
|
41
44
|
* @typedef CreateProductParam
|
|
42
|
-
* @property {CatalogPlatformModel.
|
|
45
|
+
* @property {CatalogPlatformModel.ProductCreateSchemaV2} body
|
|
43
46
|
*/
|
|
44
47
|
/**
|
|
45
48
|
* @typedef CreateProductAssetsInBulkParam
|
|
@@ -47,7 +50,7 @@ export = CatalogPlatformValidator;
|
|
|
47
50
|
*/
|
|
48
51
|
/**
|
|
49
52
|
* @typedef CreateProductBundleParam
|
|
50
|
-
* @property {CatalogPlatformModel.
|
|
53
|
+
* @property {CatalogPlatformModel.ProductBundleRequestSchema} body
|
|
51
54
|
*/
|
|
52
55
|
/**
|
|
53
56
|
* @typedef CreateProductExportJobParam
|
|
@@ -56,7 +59,7 @@ export = CatalogPlatformValidator;
|
|
|
56
59
|
/**
|
|
57
60
|
* @typedef CreateProductsInBulkParam
|
|
58
61
|
* @property {string} batchId - Batch Id in which assets to be uploaded.
|
|
59
|
-
* @property {CatalogPlatformModel.
|
|
62
|
+
* @property {CatalogPlatformModel.BulkProductRequestSchema} body
|
|
60
63
|
*/
|
|
61
64
|
/**
|
|
62
65
|
* @typedef CreateSizeGuideParam
|
|
@@ -68,11 +71,11 @@ export = CatalogPlatformValidator;
|
|
|
68
71
|
*/
|
|
69
72
|
/**
|
|
70
73
|
* @typedef DeleteProductParam
|
|
71
|
-
* @property {number} itemId - Id of the product to be
|
|
74
|
+
* @property {number} itemId - Id of the product to be deleted.
|
|
72
75
|
*/
|
|
73
76
|
/**
|
|
74
77
|
* @typedef DeleteProductBulkJobParam
|
|
75
|
-
* @property {
|
|
78
|
+
* @property {number} batchId - Batch Id of the bulk product job to be deleted.
|
|
76
79
|
*/
|
|
77
80
|
/**
|
|
78
81
|
* @typedef DeleteRealtimeInventoryParam
|
|
@@ -88,7 +91,7 @@ export = CatalogPlatformValidator;
|
|
|
88
91
|
*/
|
|
89
92
|
/**
|
|
90
93
|
* @typedef DownloadInventoryTemplateViewParam
|
|
91
|
-
* @property {string}
|
|
94
|
+
* @property {string} itemType - An `item_type` defines the type of item.
|
|
92
95
|
*/
|
|
93
96
|
/**
|
|
94
97
|
* @typedef DownloadProductTemplateViewsParam
|
|
@@ -100,19 +103,25 @@ export = CatalogPlatformValidator;
|
|
|
100
103
|
/**
|
|
101
104
|
* @typedef EditProductParam
|
|
102
105
|
* @property {number} itemId - Id of the product to be updated.
|
|
103
|
-
* @property {CatalogPlatformModel.
|
|
106
|
+
* @property {CatalogPlatformModel.ProductUpdateSchemaV2} body
|
|
104
107
|
*/
|
|
105
108
|
/**
|
|
106
109
|
* @typedef ExportInventoryConfigParam
|
|
107
|
-
* @property {string}
|
|
110
|
+
* @property {string} [filterType] - Filter type from any one of ['brand',
|
|
111
|
+
* 'store', 'type']
|
|
108
112
|
*/
|
|
109
113
|
/**
|
|
110
114
|
* @typedef GetAllProductHsnCodesParam
|
|
111
|
-
* @property {number} [pageNo] -
|
|
112
|
-
* @property {number} [pageSize] -
|
|
115
|
+
* @property {number} [pageNo] - Indicates current page number
|
|
116
|
+
* @property {number} [pageSize] - Indicates page size
|
|
113
117
|
* @property {string} [q] - Search using hsn code, description, reporting_hsn
|
|
114
118
|
* @property {string} [type] - Search using type
|
|
115
119
|
*/
|
|
120
|
+
/**
|
|
121
|
+
* @typedef GetAttributeParam
|
|
122
|
+
* @property {string} attributeSlug - Slug of the attribute for which you want
|
|
123
|
+
* to view the details
|
|
124
|
+
*/
|
|
116
125
|
/**
|
|
117
126
|
* @typedef GetCategoryDataParam
|
|
118
127
|
* @property {string} uid - Category unique id
|
|
@@ -127,37 +136,19 @@ export = CatalogPlatformValidator;
|
|
|
127
136
|
* @property {string} [marketplace] - The marketplace platform associated with
|
|
128
137
|
* the company id.
|
|
129
138
|
*/
|
|
130
|
-
/**
|
|
131
|
-
* @typedef GetCompanyBrandsDRIParam
|
|
132
|
-
* @property {number} [pageNo] - The page number to navigate through the given
|
|
133
|
-
* set of results
|
|
134
|
-
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
135
|
-
* Default is 10.
|
|
136
|
-
*/
|
|
137
139
|
/** @typedef GetCompanyDetailParam */
|
|
138
140
|
/** @typedef GetCompanyMetricsParam */
|
|
139
|
-
/**
|
|
140
|
-
* @typedef GetCompanyVerificationParam
|
|
141
|
-
* @property {string} [q] - A `q` parameter is used to search the company by its name.
|
|
142
|
-
* @property {number} [pageNo] - A `page_no` parameter is a number of the page requested.
|
|
143
|
-
* @property {number} [pageSize] - A `page_size` is the no of items per page.
|
|
144
|
-
*/
|
|
145
141
|
/**
|
|
146
142
|
* @typedef GetDepartmentDataParam
|
|
147
143
|
* @property {string} uid - A `uid` is a unique identifier of a department.
|
|
148
144
|
*/
|
|
149
|
-
/**
|
|
150
|
-
* @typedef GetGenderAttributeParam
|
|
151
|
-
* @property {string} attributeSlug - Slug of the attribute for which you want
|
|
152
|
-
* to view the genders
|
|
153
|
-
*/
|
|
154
145
|
/**
|
|
155
146
|
* @typedef GetHsnCodeParam
|
|
156
147
|
* @property {string} id - Unique id
|
|
157
148
|
*/
|
|
158
149
|
/**
|
|
159
150
|
* @typedef GetInventoriesParam
|
|
160
|
-
* @property {
|
|
151
|
+
* @property {string} [itemId] - Item code of the product of which size is to be get.
|
|
161
152
|
* @property {string} [size] - Size of which inventory is to get.
|
|
162
153
|
* @property {number} [pageNo] - The page number to navigate through the given
|
|
163
154
|
* set of results
|
|
@@ -171,12 +162,17 @@ export = CatalogPlatformValidator;
|
|
|
171
162
|
* @property {number[]} [brandIds] - The Brand Id of products to fetch inventory.
|
|
172
163
|
* @property {string[]} [sellerIdentifiers] - The Seller Identifier or Primary
|
|
173
164
|
* Identifier of the inventory.
|
|
174
|
-
* @property {number} [
|
|
175
|
-
*
|
|
165
|
+
* @property {number} [qtyGt] - This field allows you to filter for inventories
|
|
166
|
+
* that have quantity greater than to the specified value based on qty_type filter.
|
|
167
|
+
* @property {number} [qtyLt] - This field allows you to filter for inventories
|
|
168
|
+
* that have a quantity less than to the specified value based on qty_type filter.
|
|
169
|
+
* @property {string} [qtyType] - This field provides flexibility in selecting
|
|
170
|
+
* filter for inventory quantity counts and date queries. For example, you
|
|
171
|
+
* might use this field to specify "total" or "sellable" quantity.
|
|
176
172
|
* @property {string} [fromDate] - Inventory updated on filter to get
|
|
177
|
-
* inventories greater then provided date.
|
|
173
|
+
* inventories greater then or equal to provided date based on qty_type value.
|
|
178
174
|
* @property {string} [toDate] - Inventory updated on filter to get inventories
|
|
179
|
-
* less then provided date.
|
|
175
|
+
* less then or equal to provided date based on qty_type value.
|
|
180
176
|
* @property {string} [sizeIdentifier] - Size Identifier (Seller Identifier or
|
|
181
177
|
* Primary Identifier) of which inventory is to get.
|
|
182
178
|
*/
|
|
@@ -186,6 +182,7 @@ export = CatalogPlatformValidator;
|
|
|
186
182
|
* set of results
|
|
187
183
|
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
188
184
|
* Default is 12.
|
|
185
|
+
* @property {string} [search] - Search string to filter the results by batch id
|
|
189
186
|
*/
|
|
190
187
|
/**
|
|
191
188
|
* @typedef GetInventoryBySizeParam
|
|
@@ -211,12 +208,12 @@ export = CatalogPlatformValidator;
|
|
|
211
208
|
* @property {number[]} [locationIds] - Search by store ids.
|
|
212
209
|
*/
|
|
213
210
|
/** @typedef GetInventoryExportParam */
|
|
211
|
+
/** @typedef GetMarketplaceOptinDetailParam */
|
|
212
|
+
/** @typedef GetMarketplacesParam */
|
|
214
213
|
/**
|
|
215
|
-
* @typedef
|
|
216
|
-
* @property {
|
|
214
|
+
* @typedef GetOptimalLocationsParam
|
|
215
|
+
* @property {CatalogPlatformModel.AssignStore} body
|
|
217
216
|
*/
|
|
218
|
-
/** @typedef GetLocationTagsParam */
|
|
219
|
-
/** @typedef GetMarketplacesParam */
|
|
220
217
|
/**
|
|
221
218
|
* @typedef GetProductParam
|
|
222
219
|
* @property {number} itemId - Item Id of the product.
|
|
@@ -258,10 +255,6 @@ export = CatalogPlatformValidator;
|
|
|
258
255
|
* @property {string} id - A `id` is a unique identifier for a particular
|
|
259
256
|
* detail. Pass the `id` of the keywords which you want to retrieve.
|
|
260
257
|
*/
|
|
261
|
-
/**
|
|
262
|
-
* @typedef GetProductExportDetailParam
|
|
263
|
-
* @property {string} jobId - Company Id in which assets to be uploaded.
|
|
264
|
-
*/
|
|
265
258
|
/**
|
|
266
259
|
* @typedef GetProductExportJobsParam
|
|
267
260
|
* @property {string} [status] - This is a parameter used to find all the jobs
|
|
@@ -279,27 +272,16 @@ export = CatalogPlatformValidator;
|
|
|
279
272
|
*/
|
|
280
273
|
/**
|
|
281
274
|
* @typedef GetProductSizeParam
|
|
275
|
+
* @property {string} [itemCode] - Item code of the product size.
|
|
282
276
|
* @property {number} itemId - Item Id of the product size.
|
|
277
|
+
* @property {number} [brandUid] - Brand Id of the product size.
|
|
278
|
+
* @property {number} [uid] - Id of the product size.
|
|
283
279
|
*/
|
|
284
280
|
/** @typedef GetProductTagsParam */
|
|
285
|
-
/**
|
|
286
|
-
* @typedef GetProductTemplateBySlugParam
|
|
287
|
-
* @property {string} slug - Slug of the template.
|
|
288
|
-
*/
|
|
289
|
-
/**
|
|
290
|
-
* @typedef GetProductValidationParam
|
|
291
|
-
* @property {string} type - Type of identifier to validate the product against.
|
|
292
|
-
* @property {string} slug - Type of identifier to validate the product against.
|
|
293
|
-
*/
|
|
294
|
-
/**
|
|
295
|
-
* @typedef GetProductVerificationDetailsParam
|
|
296
|
-
* @property {number} itemId - A `item_id` is a unique identifier for a specific product.
|
|
297
|
-
*/
|
|
281
|
+
/** @typedef GetProductValidationParam */
|
|
298
282
|
/**
|
|
299
283
|
* @typedef GetProductsParam
|
|
300
284
|
* @property {number[]} [brandIds] - Get multiple products filtered by Brand Ids
|
|
301
|
-
* @property {boolean} [multiSize] - Get multiple products filtered by weather
|
|
302
|
-
* have multiple sizes or not
|
|
303
285
|
* @property {number[]} [categoryIds] - Get multiple products filtered by Category Ids
|
|
304
286
|
* @property {number[]} [itemIds] - Get multiple products filtered by Item Ids
|
|
305
287
|
* @property {number[]} [departmentIds] - Get multiple products filtered by Department Ids
|
|
@@ -339,12 +321,12 @@ export = CatalogPlatformValidator;
|
|
|
339
321
|
* @typedef GetSizeGuidesParam
|
|
340
322
|
* @property {boolean} [active] - Filter size guide on basis of active, in-active
|
|
341
323
|
* @property {string} [q] - Query that is to be searched.
|
|
342
|
-
* @property {number} [brandId] - Brand id that is to be searched.
|
|
343
324
|
* @property {string} [tag] - To filter size guide on basis of tag.
|
|
344
325
|
* @property {number} [pageNo] - The page number to navigate through the given
|
|
345
326
|
* set of results
|
|
346
327
|
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
347
328
|
* Default is 10.
|
|
329
|
+
* @property {number} [brandId] - Brand id that is to be searched.
|
|
348
330
|
*/
|
|
349
331
|
/**
|
|
350
332
|
* @typedef GetStoreDetailParam
|
|
@@ -353,11 +335,6 @@ export = CatalogPlatformValidator;
|
|
|
353
335
|
* @property {number} [pageSize] - Number of records that can be seen on the
|
|
354
336
|
* page for the company id.
|
|
355
337
|
*/
|
|
356
|
-
/**
|
|
357
|
-
* @typedef GetVariantTypesParam
|
|
358
|
-
* @property {string} templateTag - The page number to navigate through the
|
|
359
|
-
* given set of results
|
|
360
|
-
*/
|
|
361
338
|
/**
|
|
362
339
|
* @typedef GetVariantsOfProductsParam
|
|
363
340
|
* @property {number} itemId - Get list of variants of item Id
|
|
@@ -377,6 +354,7 @@ export = CatalogPlatformValidator;
|
|
|
377
354
|
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
378
355
|
* Default is 10.
|
|
379
356
|
* @property {number[]} [uids] - Get multiple categories filtered by category uids.
|
|
357
|
+
* @property {string} [slug] - Get category by slug
|
|
380
358
|
*/
|
|
381
359
|
/**
|
|
382
360
|
* @typedef ListDepartmentsDataParam
|
|
@@ -391,12 +369,12 @@ export = CatalogPlatformValidator;
|
|
|
391
369
|
* department in search parameter.
|
|
392
370
|
* @property {boolean} [isActive] - Can query for departments based on whether
|
|
393
371
|
* they are active or inactive.
|
|
394
|
-
* @property {
|
|
372
|
+
* @property {string} [slug] - Can filter by slug
|
|
395
373
|
*/
|
|
396
374
|
/** @typedef ListHSNCodesParam */
|
|
397
375
|
/**
|
|
398
376
|
* @typedef ListInventoryExportParam
|
|
399
|
-
* @property {string} [status] - Status of the export job.
|
|
377
|
+
* @property {string} [status] - Status of the export job.(Pending, Running, Success)
|
|
400
378
|
* @property {string} [fromDate] - Inventory export history filtered according
|
|
401
379
|
* to from_date.
|
|
402
380
|
* @property {string} [toDate] - Inventory export history filtered according to from_date.
|
|
@@ -416,11 +394,8 @@ export = CatalogPlatformValidator;
|
|
|
416
394
|
* whose category needs to be listed. Can specify multiple departments.
|
|
417
395
|
* @property {string} itemType - An `item_type` is the type of item, it can be
|
|
418
396
|
* `set`, `standard`, `digital`, etc.
|
|
419
|
-
* @property {number} [pageSize] - Number of categories needed in one page
|
|
420
|
-
* @property {number} [pageNo] - Page number to fetch, for example if pagesize
|
|
421
|
-
* is 10 and page number 1,
|
|
422
|
-
* @property {number} [q] - Search string to search categories from
|
|
423
397
|
*/
|
|
398
|
+
/** @typedef ListProductTemplateExportDetailsParam */
|
|
424
399
|
/**
|
|
425
400
|
* @typedef ListTemplateBrandTypeValuesParam
|
|
426
401
|
* @property {string} filter - A `filter` is the unique identifier of the type
|
|
@@ -431,39 +406,39 @@ export = CatalogPlatformValidator;
|
|
|
431
406
|
* of template required.
|
|
432
407
|
*/
|
|
433
408
|
/**
|
|
434
|
-
* @typedef
|
|
435
|
-
* @property {string}
|
|
436
|
-
* @property {CatalogPlatformModel.
|
|
437
|
-
*/
|
|
438
|
-
/**
|
|
439
|
-
* @typedef PatchProductExportDetailParam
|
|
440
|
-
* @property {string} jobId - Company Id in which assets to be uploaded.
|
|
441
|
-
* @property {CatalogPlatformModel.ExportPatchRequest} body
|
|
409
|
+
* @typedef UpdateHsnCodeParam
|
|
410
|
+
* @property {string} id - Unique id
|
|
411
|
+
* @property {CatalogPlatformModel.HsnUpsert} body
|
|
442
412
|
*/
|
|
443
413
|
/**
|
|
444
|
-
* @typedef
|
|
445
|
-
* @property {
|
|
446
|
-
* @property {CatalogPlatformModel.CategoryRequestBody} body
|
|
414
|
+
* @typedef UpdateInventoriesParam
|
|
415
|
+
* @property {CatalogPlatformModel.InventoryRequestSchemaV2} body
|
|
447
416
|
*/
|
|
448
417
|
/**
|
|
449
|
-
* @typedef
|
|
450
|
-
* @property {
|
|
451
|
-
* @property {
|
|
418
|
+
* @typedef UpdateLocationPriceParam
|
|
419
|
+
* @property {number} storeId - The Store Id to update price of size for specific store.
|
|
420
|
+
* @property {string} sellerIdentifier - Size Identifier (Seller Identifier or
|
|
421
|
+
* Primary Identifier) of which article price is to update.
|
|
422
|
+
* @property {CatalogPlatformModel.LocationPriceRequestSchema} body
|
|
452
423
|
*/
|
|
453
424
|
/**
|
|
454
|
-
* @typedef
|
|
455
|
-
* @property {
|
|
425
|
+
* @typedef UpdateLocationQuantityParam
|
|
426
|
+
* @property {number} storeId - The Store Id to update quantity of size for
|
|
427
|
+
* specific store.
|
|
428
|
+
* @property {string} sellerIdentifier - Size Identifier (Seller Identifier or
|
|
429
|
+
* Primary Identifier) of which article quantity is to update.
|
|
430
|
+
* @property {CatalogPlatformModel.LocationQuantityRequestSchema} body
|
|
456
431
|
*/
|
|
457
432
|
/**
|
|
458
433
|
* @typedef UpdateMarketplaceOptinParam
|
|
459
|
-
* @property {string}
|
|
460
|
-
* @property {CatalogPlatformModel.
|
|
434
|
+
* @property {string} marketplaceSlug - Slug of the marketplace .
|
|
435
|
+
* @property {CatalogPlatformModel.UpdateMarketplaceOptinRequestSchema} body
|
|
461
436
|
*/
|
|
462
437
|
/**
|
|
463
438
|
* @typedef UpdateProductBundleParam
|
|
464
439
|
* @property {string} id - A `id` is a unique identifier for a particular
|
|
465
440
|
* detail. Pass the `id` of the keywords which you want to delete.
|
|
466
|
-
* @property {CatalogPlatformModel.
|
|
441
|
+
* @property {CatalogPlatformModel.ProductBundleUpdateRequestSchema} body
|
|
467
442
|
*/
|
|
468
443
|
/**
|
|
469
444
|
* @typedef UpdateRealtimeInventoryParam
|
|
@@ -474,16 +449,25 @@ export = CatalogPlatformValidator;
|
|
|
474
449
|
*/
|
|
475
450
|
/**
|
|
476
451
|
* @typedef UpdateSizeGuideParam
|
|
477
|
-
* @property {string} id -
|
|
452
|
+
* @property {string} id - Identifier of the size guide to be edited
|
|
478
453
|
* @property {CatalogPlatformModel.ValidateSizeGuide} body
|
|
479
454
|
*/
|
|
480
455
|
/**
|
|
481
456
|
* @typedef UploadBulkProductsParam
|
|
482
457
|
* @property {string} department - Department of the product to be uploaded.
|
|
483
458
|
* @property {string} productType - Product type of the product to be uploaded
|
|
484
|
-
* i.e. set, standard
|
|
459
|
+
* i.e. set, standard, digital.
|
|
485
460
|
* @property {CatalogPlatformModel.BulkProductJob} body
|
|
486
461
|
*/
|
|
462
|
+
/**
|
|
463
|
+
* @typedef ValidateProductGlobalTemplateParam
|
|
464
|
+
* @property {string} [itemType] - An `item_type` defines the type of item. The
|
|
465
|
+
* default value is standard.
|
|
466
|
+
* @property {boolean} [bulk] - This specification determines the schema type to
|
|
467
|
+
* be retrieved. When set to true, it will return the schema for bulk data;
|
|
468
|
+
* when set to false, it will provide the schema for a single product. The
|
|
469
|
+
* default value is false.
|
|
470
|
+
*/
|
|
487
471
|
/**
|
|
488
472
|
* @typedef ValidateProductTemplateParam
|
|
489
473
|
* @property {string} slug - A `slug` is a unique identifier for a particular template.
|
|
@@ -498,21 +482,20 @@ export = CatalogPlatformValidator;
|
|
|
498
482
|
* @typedef ValidateProductTemplateSchemaParam
|
|
499
483
|
* @property {string} itemType - An `item_type` defines the type of item. The
|
|
500
484
|
* default value is standard.
|
|
501
|
-
* @property {boolean} bulk - Type of file template i.e if bulk
|
|
502
485
|
*/
|
|
503
486
|
declare class CatalogPlatformValidator {
|
|
487
|
+
/** @returns {AddInventoryParam} */
|
|
488
|
+
static addInventory(): AddInventoryParam;
|
|
504
489
|
/** @returns {AllSizesParam} */
|
|
505
490
|
static allSizes(): AllSizesParam;
|
|
491
|
+
/** @returns {BulkHsnCodeParam} */
|
|
492
|
+
static bulkHsnCode(): BulkHsnCodeParam;
|
|
506
493
|
/** @returns {CreateBulkInventoryParam} */
|
|
507
494
|
static createBulkInventory(): CreateBulkInventoryParam;
|
|
508
495
|
/** @returns {CreateBulkInventoryJobParam} */
|
|
509
496
|
static createBulkInventoryJob(): CreateBulkInventoryJobParam;
|
|
510
497
|
/** @returns {CreateBulkProductUploadJobParam} */
|
|
511
498
|
static createBulkProductUploadJob(): CreateBulkProductUploadJobParam;
|
|
512
|
-
/** @returns {CreateCategoriesParam} */
|
|
513
|
-
static createCategories(): CreateCategoriesParam;
|
|
514
|
-
/** @returns {CreateDepartmentsParam} */
|
|
515
|
-
static createDepartments(): CreateDepartmentsParam;
|
|
516
499
|
/** @returns {CreateInventoryExportParam} */
|
|
517
500
|
static createInventoryExport(): CreateInventoryExportParam;
|
|
518
501
|
/** @returns {CreateInventoryExportJobParam} */
|
|
@@ -551,22 +534,18 @@ declare class CatalogPlatformValidator {
|
|
|
551
534
|
static exportInventoryConfig(): ExportInventoryConfigParam;
|
|
552
535
|
/** @returns {GetAllProductHsnCodesParam} */
|
|
553
536
|
static getAllProductHsnCodes(): GetAllProductHsnCodesParam;
|
|
537
|
+
/** @returns {GetAttributeParam} */
|
|
538
|
+
static getAttribute(): GetAttributeParam;
|
|
554
539
|
/** @returns {GetCategoryDataParam} */
|
|
555
540
|
static getCategoryData(): GetCategoryDataParam;
|
|
556
541
|
/** @returns {GetCompanyBrandDetailParam} */
|
|
557
542
|
static getCompanyBrandDetail(): GetCompanyBrandDetailParam;
|
|
558
|
-
/** @returns {GetCompanyBrandsDRIParam} */
|
|
559
|
-
static getCompanyBrandsDRI(): GetCompanyBrandsDRIParam;
|
|
560
543
|
/** @returns {GetCompanyDetailParam} */
|
|
561
544
|
static getCompanyDetail(): any;
|
|
562
545
|
/** @returns {GetCompanyMetricsParam} */
|
|
563
546
|
static getCompanyMetrics(): any;
|
|
564
|
-
/** @returns {GetCompanyVerificationParam} */
|
|
565
|
-
static getCompanyVerification(): GetCompanyVerificationParam;
|
|
566
547
|
/** @returns {GetDepartmentDataParam} */
|
|
567
548
|
static getDepartmentData(): GetDepartmentDataParam;
|
|
568
|
-
/** @returns {GetGenderAttributeParam} */
|
|
569
|
-
static getGenderAttribute(): GetGenderAttributeParam;
|
|
570
549
|
/** @returns {GetHsnCodeParam} */
|
|
571
550
|
static getHsnCode(): GetHsnCodeParam;
|
|
572
551
|
/** @returns {GetInventoriesParam} */
|
|
@@ -579,12 +558,12 @@ declare class CatalogPlatformValidator {
|
|
|
579
558
|
static getInventoryBySizeIdentifier(): GetInventoryBySizeIdentifierParam;
|
|
580
559
|
/** @returns {GetInventoryExportParam} */
|
|
581
560
|
static getInventoryExport(): any;
|
|
582
|
-
/** @returns {
|
|
583
|
-
static
|
|
584
|
-
/** @returns {GetLocationTagsParam} */
|
|
585
|
-
static getLocationTags(): any;
|
|
561
|
+
/** @returns {GetMarketplaceOptinDetailParam} */
|
|
562
|
+
static getMarketplaceOptinDetail(): any;
|
|
586
563
|
/** @returns {GetMarketplacesParam} */
|
|
587
564
|
static getMarketplaces(): any;
|
|
565
|
+
/** @returns {GetOptimalLocationsParam} */
|
|
566
|
+
static getOptimalLocations(): GetOptimalLocationsParam;
|
|
588
567
|
/** @returns {GetProductParam} */
|
|
589
568
|
static getProduct(): GetProductParam;
|
|
590
569
|
/** @returns {GetProductAssetsInBulkParam} */
|
|
@@ -597,20 +576,14 @@ declare class CatalogPlatformValidator {
|
|
|
597
576
|
static getProductBundle(): GetProductBundleParam;
|
|
598
577
|
/** @returns {GetProductBundleDetailParam} */
|
|
599
578
|
static getProductBundleDetail(): GetProductBundleDetailParam;
|
|
600
|
-
/** @returns {GetProductExportDetailParam} */
|
|
601
|
-
static getProductExportDetail(): GetProductExportDetailParam;
|
|
602
579
|
/** @returns {GetProductExportJobsParam} */
|
|
603
580
|
static getProductExportJobs(): GetProductExportJobsParam;
|
|
604
581
|
/** @returns {GetProductSizeParam} */
|
|
605
582
|
static getProductSize(): GetProductSizeParam;
|
|
606
583
|
/** @returns {GetProductTagsParam} */
|
|
607
584
|
static getProductTags(): any;
|
|
608
|
-
/** @returns {GetProductTemplateBySlugParam} */
|
|
609
|
-
static getProductTemplateBySlug(): GetProductTemplateBySlugParam;
|
|
610
585
|
/** @returns {GetProductValidationParam} */
|
|
611
|
-
static getProductValidation():
|
|
612
|
-
/** @returns {GetProductVerificationDetailsParam} */
|
|
613
|
-
static getProductVerificationDetails(): GetProductVerificationDetailsParam;
|
|
586
|
+
static getProductValidation(): any;
|
|
614
587
|
/** @returns {GetProductsParam} */
|
|
615
588
|
static getProducts(): GetProductsParam;
|
|
616
589
|
/** @returns {GetSellerInsightsParam} */
|
|
@@ -623,8 +596,6 @@ declare class CatalogPlatformValidator {
|
|
|
623
596
|
static getSizeGuides(): GetSizeGuidesParam;
|
|
624
597
|
/** @returns {GetStoreDetailParam} */
|
|
625
598
|
static getStoreDetail(): GetStoreDetailParam;
|
|
626
|
-
/** @returns {GetVariantTypesParam} */
|
|
627
|
-
static getVariantTypes(): GetVariantTypesParam;
|
|
628
599
|
/** @returns {GetVariantsOfProductsParam} */
|
|
629
600
|
static getVariantsOfProducts(): GetVariantsOfProductsParam;
|
|
630
601
|
/** @returns {ListCategoriesParam} */
|
|
@@ -639,18 +610,18 @@ declare class CatalogPlatformValidator {
|
|
|
639
610
|
static listProductTemplate(): ListProductTemplateParam;
|
|
640
611
|
/** @returns {ListProductTemplateCategoriesParam} */
|
|
641
612
|
static listProductTemplateCategories(): ListProductTemplateCategoriesParam;
|
|
613
|
+
/** @returns {ListProductTemplateExportDetailsParam} */
|
|
614
|
+
static listProductTemplateExportDetails(): any;
|
|
642
615
|
/** @returns {ListTemplateBrandTypeValuesParam} */
|
|
643
616
|
static listTemplateBrandTypeValues(): ListTemplateBrandTypeValuesParam;
|
|
644
|
-
/** @returns {
|
|
645
|
-
static
|
|
646
|
-
/** @returns {PatchProductExportDetailParam} */
|
|
647
|
-
static patchProductExportDetail(): PatchProductExportDetailParam;
|
|
648
|
-
/** @returns {UpdateCategoryParam} */
|
|
649
|
-
static updateCategory(): UpdateCategoryParam;
|
|
650
|
-
/** @returns {UpdateDepartmentParam} */
|
|
651
|
-
static updateDepartment(): UpdateDepartmentParam;
|
|
617
|
+
/** @returns {UpdateHsnCodeParam} */
|
|
618
|
+
static updateHsnCode(): UpdateHsnCodeParam;
|
|
652
619
|
/** @returns {UpdateInventoriesParam} */
|
|
653
620
|
static updateInventories(): UpdateInventoriesParam;
|
|
621
|
+
/** @returns {UpdateLocationPriceParam} */
|
|
622
|
+
static updateLocationPrice(): UpdateLocationPriceParam;
|
|
623
|
+
/** @returns {UpdateLocationQuantityParam} */
|
|
624
|
+
static updateLocationQuantity(): UpdateLocationQuantityParam;
|
|
654
625
|
/** @returns {UpdateMarketplaceOptinParam} */
|
|
655
626
|
static updateMarketplaceOptin(): UpdateMarketplaceOptinParam;
|
|
656
627
|
/** @returns {UpdateProductBundleParam} */
|
|
@@ -661,60 +632,71 @@ declare class CatalogPlatformValidator {
|
|
|
661
632
|
static updateSizeGuide(): UpdateSizeGuideParam;
|
|
662
633
|
/** @returns {UploadBulkProductsParam} */
|
|
663
634
|
static uploadBulkProducts(): UploadBulkProductsParam;
|
|
635
|
+
/** @returns {ValidateProductGlobalTemplateParam} */
|
|
636
|
+
static validateProductGlobalTemplate(): ValidateProductGlobalTemplateParam;
|
|
664
637
|
/** @returns {ValidateProductTemplateParam} */
|
|
665
638
|
static validateProductTemplate(): ValidateProductTemplateParam;
|
|
666
639
|
/** @returns {ValidateProductTemplateSchemaParam} */
|
|
667
640
|
static validateProductTemplateSchema(): ValidateProductTemplateSchemaParam;
|
|
668
641
|
}
|
|
669
642
|
declare namespace CatalogPlatformValidator {
|
|
670
|
-
export { AllSizesParam, CreateBulkInventoryParam, CreateBulkInventoryJobParam, CreateBulkProductUploadJobParam,
|
|
643
|
+
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 };
|
|
671
644
|
}
|
|
645
|
+
type AddInventoryParam = {
|
|
646
|
+
/**
|
|
647
|
+
* - Item id of the product of which size is to be get.
|
|
648
|
+
*/
|
|
649
|
+
itemId: number;
|
|
650
|
+
/**
|
|
651
|
+
* - Size in which inventory is to be added.
|
|
652
|
+
*/
|
|
653
|
+
size: string;
|
|
654
|
+
body: CatalogPlatformModel.InventoryRequestSchema;
|
|
655
|
+
};
|
|
672
656
|
type AllSizesParam = {
|
|
673
657
|
/**
|
|
674
658
|
* - Id of the product to be updated.
|
|
675
659
|
*/
|
|
676
660
|
itemId: number;
|
|
677
661
|
};
|
|
662
|
+
type BulkHsnCodeParam = {
|
|
663
|
+
body: CatalogPlatformModel.BulkHsnUpsert;
|
|
664
|
+
};
|
|
678
665
|
type CreateBulkInventoryParam = {
|
|
679
666
|
/**
|
|
680
667
|
* - Batch Id of the bulk create job.
|
|
681
668
|
*/
|
|
682
669
|
batchId: string;
|
|
683
|
-
body: CatalogPlatformModel.
|
|
670
|
+
body: CatalogPlatformModel.InventoryBulkRequestSchema;
|
|
684
671
|
};
|
|
685
672
|
type CreateBulkInventoryJobParam = {
|
|
686
|
-
body: CatalogPlatformModel.
|
|
673
|
+
body: CatalogPlatformModel.BulkJob;
|
|
687
674
|
};
|
|
688
675
|
type CreateBulkProductUploadJobParam = {
|
|
689
|
-
body: CatalogPlatformModel.
|
|
690
|
-
};
|
|
691
|
-
type CreateCategoriesParam = {
|
|
692
|
-
body: CatalogPlatformModel.CategoryRequestBody;
|
|
693
|
-
};
|
|
694
|
-
type CreateDepartmentsParam = {
|
|
695
|
-
body: CatalogPlatformModel.DepartmentCreateUpdate;
|
|
676
|
+
body: CatalogPlatformModel.BulkJob;
|
|
696
677
|
};
|
|
697
678
|
type CreateInventoryExportParam = {
|
|
698
|
-
body: CatalogPlatformModel.
|
|
679
|
+
body: CatalogPlatformModel.InventoryCreateRequestSchema;
|
|
699
680
|
};
|
|
700
681
|
type CreateInventoryExportJobParam = {
|
|
701
|
-
body: CatalogPlatformModel.
|
|
682
|
+
body: CatalogPlatformModel.InventoryExportRequestSchema;
|
|
702
683
|
};
|
|
703
684
|
type CreateMarketplaceOptinParam = {
|
|
704
685
|
/**
|
|
705
|
-
* -
|
|
686
|
+
* - The marketplace for which the detail
|
|
687
|
+
* needs to be retrieved.
|
|
706
688
|
*/
|
|
707
|
-
|
|
708
|
-
body: CatalogPlatformModel.
|
|
689
|
+
marketplaceSlug: string;
|
|
690
|
+
body: CatalogPlatformModel.OptInPostRequestSchema;
|
|
709
691
|
};
|
|
710
692
|
type CreateProductParam = {
|
|
711
|
-
body: CatalogPlatformModel.
|
|
693
|
+
body: CatalogPlatformModel.ProductCreateSchemaV2;
|
|
712
694
|
};
|
|
713
695
|
type CreateProductAssetsInBulkParam = {
|
|
714
696
|
body: CatalogPlatformModel.ProductBulkAssets;
|
|
715
697
|
};
|
|
716
698
|
type CreateProductBundleParam = {
|
|
717
|
-
body: CatalogPlatformModel.
|
|
699
|
+
body: CatalogPlatformModel.ProductBundleRequestSchema;
|
|
718
700
|
};
|
|
719
701
|
type CreateProductExportJobParam = {
|
|
720
702
|
body: CatalogPlatformModel.ProductTemplateDownloadsExport;
|
|
@@ -724,7 +706,7 @@ type CreateProductsInBulkParam = {
|
|
|
724
706
|
* - Batch Id in which assets to be uploaded.
|
|
725
707
|
*/
|
|
726
708
|
batchId: string;
|
|
727
|
-
body: CatalogPlatformModel.
|
|
709
|
+
body: CatalogPlatformModel.BulkProductRequestSchema;
|
|
728
710
|
};
|
|
729
711
|
type CreateSizeGuideParam = {
|
|
730
712
|
body: CatalogPlatformModel.ValidateSizeGuide;
|
|
@@ -737,7 +719,7 @@ type DeleteBulkInventoryJobParam = {
|
|
|
737
719
|
};
|
|
738
720
|
type DeleteProductParam = {
|
|
739
721
|
/**
|
|
740
|
-
* - Id of the product to be
|
|
722
|
+
* - Id of the product to be deleted.
|
|
741
723
|
*/
|
|
742
724
|
itemId: number;
|
|
743
725
|
};
|
|
@@ -745,7 +727,7 @@ type DeleteProductBulkJobParam = {
|
|
|
745
727
|
/**
|
|
746
728
|
* - Batch Id of the bulk product job to be deleted.
|
|
747
729
|
*/
|
|
748
|
-
batchId:
|
|
730
|
+
batchId: number;
|
|
749
731
|
};
|
|
750
732
|
type DeleteRealtimeInventoryParam = {
|
|
751
733
|
/**
|
|
@@ -771,9 +753,9 @@ type DeleteSizeParam = {
|
|
|
771
753
|
};
|
|
772
754
|
type DownloadInventoryTemplateViewParam = {
|
|
773
755
|
/**
|
|
774
|
-
* -
|
|
756
|
+
* - An `item_type` defines the type of item.
|
|
775
757
|
*/
|
|
776
|
-
|
|
758
|
+
itemType: string;
|
|
777
759
|
};
|
|
778
760
|
type DownloadProductTemplateViewsParam = {
|
|
779
761
|
/**
|
|
@@ -795,21 +777,22 @@ type EditProductParam = {
|
|
|
795
777
|
* - Id of the product to be updated.
|
|
796
778
|
*/
|
|
797
779
|
itemId: number;
|
|
798
|
-
body: CatalogPlatformModel.
|
|
780
|
+
body: CatalogPlatformModel.ProductUpdateSchemaV2;
|
|
799
781
|
};
|
|
800
782
|
type ExportInventoryConfigParam = {
|
|
801
783
|
/**
|
|
802
|
-
* - Filter type from any one of ['brand',
|
|
784
|
+
* - Filter type from any one of ['brand',
|
|
785
|
+
* 'store', 'type']
|
|
803
786
|
*/
|
|
804
|
-
|
|
787
|
+
filterType?: string;
|
|
805
788
|
};
|
|
806
789
|
type GetAllProductHsnCodesParam = {
|
|
807
790
|
/**
|
|
808
|
-
* -
|
|
791
|
+
* - Indicates current page number
|
|
809
792
|
*/
|
|
810
793
|
pageNo?: number;
|
|
811
794
|
/**
|
|
812
|
-
* -
|
|
795
|
+
* - Indicates page size
|
|
813
796
|
*/
|
|
814
797
|
pageSize?: number;
|
|
815
798
|
/**
|
|
@@ -821,6 +804,13 @@ type GetAllProductHsnCodesParam = {
|
|
|
821
804
|
*/
|
|
822
805
|
type?: string;
|
|
823
806
|
};
|
|
807
|
+
type GetAttributeParam = {
|
|
808
|
+
/**
|
|
809
|
+
* - Slug of the attribute for which you want
|
|
810
|
+
* to view the details
|
|
811
|
+
*/
|
|
812
|
+
attributeSlug: string;
|
|
813
|
+
};
|
|
824
814
|
type GetCategoryDataParam = {
|
|
825
815
|
/**
|
|
826
816
|
* - Category unique id
|
|
@@ -851,45 +841,12 @@ type GetCompanyBrandDetailParam = {
|
|
|
851
841
|
*/
|
|
852
842
|
marketplace?: string;
|
|
853
843
|
};
|
|
854
|
-
type GetCompanyBrandsDRIParam = {
|
|
855
|
-
/**
|
|
856
|
-
* - The page number to navigate through the given
|
|
857
|
-
* set of results
|
|
858
|
-
*/
|
|
859
|
-
pageNo?: number;
|
|
860
|
-
/**
|
|
861
|
-
* - Number of items to retrieve in each page.
|
|
862
|
-
* Default is 10.
|
|
863
|
-
*/
|
|
864
|
-
pageSize?: number;
|
|
865
|
-
};
|
|
866
|
-
type GetCompanyVerificationParam = {
|
|
867
|
-
/**
|
|
868
|
-
* - A `q` parameter is used to search the company by its name.
|
|
869
|
-
*/
|
|
870
|
-
q?: string;
|
|
871
|
-
/**
|
|
872
|
-
* - A `page_no` parameter is a number of the page requested.
|
|
873
|
-
*/
|
|
874
|
-
pageNo?: number;
|
|
875
|
-
/**
|
|
876
|
-
* - A `page_size` is the no of items per page.
|
|
877
|
-
*/
|
|
878
|
-
pageSize?: number;
|
|
879
|
-
};
|
|
880
844
|
type GetDepartmentDataParam = {
|
|
881
845
|
/**
|
|
882
846
|
* - A `uid` is a unique identifier of a department.
|
|
883
847
|
*/
|
|
884
848
|
uid: string;
|
|
885
849
|
};
|
|
886
|
-
type GetGenderAttributeParam = {
|
|
887
|
-
/**
|
|
888
|
-
* - Slug of the attribute for which you want
|
|
889
|
-
* to view the genders
|
|
890
|
-
*/
|
|
891
|
-
attributeSlug: string;
|
|
892
|
-
};
|
|
893
850
|
type GetHsnCodeParam = {
|
|
894
851
|
/**
|
|
895
852
|
* - Unique id
|
|
@@ -900,7 +857,7 @@ type GetInventoriesParam = {
|
|
|
900
857
|
/**
|
|
901
858
|
* - Item code of the product of which size is to be get.
|
|
902
859
|
*/
|
|
903
|
-
itemId?:
|
|
860
|
+
itemId?: string;
|
|
904
861
|
/**
|
|
905
862
|
* - Size of which inventory is to get.
|
|
906
863
|
*/
|
|
@@ -945,21 +902,29 @@ type GetInventoriesParam = {
|
|
|
945
902
|
*/
|
|
946
903
|
sellerIdentifiers?: string[];
|
|
947
904
|
/**
|
|
948
|
-
* -
|
|
905
|
+
* - This field allows you to filter for inventories
|
|
906
|
+
* that have quantity greater than to the specified value based on qty_type filter.
|
|
949
907
|
*/
|
|
950
|
-
|
|
908
|
+
qtyGt?: number;
|
|
951
909
|
/**
|
|
952
|
-
* -
|
|
910
|
+
* - This field allows you to filter for inventories
|
|
911
|
+
* that have a quantity less than to the specified value based on qty_type filter.
|
|
953
912
|
*/
|
|
954
|
-
|
|
913
|
+
qtyLt?: number;
|
|
914
|
+
/**
|
|
915
|
+
* - This field provides flexibility in selecting
|
|
916
|
+
* filter for inventory quantity counts and date queries. For example, you
|
|
917
|
+
* might use this field to specify "total" or "sellable" quantity.
|
|
918
|
+
*/
|
|
919
|
+
qtyType?: string;
|
|
955
920
|
/**
|
|
956
921
|
* - Inventory updated on filter to get
|
|
957
|
-
* inventories greater then provided date.
|
|
922
|
+
* inventories greater then or equal to provided date based on qty_type value.
|
|
958
923
|
*/
|
|
959
924
|
fromDate?: string;
|
|
960
925
|
/**
|
|
961
926
|
* - Inventory updated on filter to get inventories
|
|
962
|
-
* less then provided date.
|
|
927
|
+
* less then or equal to provided date based on qty_type value.
|
|
963
928
|
*/
|
|
964
929
|
toDate?: string;
|
|
965
930
|
/**
|
|
@@ -979,6 +944,10 @@ type GetInventoryBulkUploadHistoryParam = {
|
|
|
979
944
|
* Default is 12.
|
|
980
945
|
*/
|
|
981
946
|
pageSize?: number;
|
|
947
|
+
/**
|
|
948
|
+
* - Search string to filter the results by batch id
|
|
949
|
+
*/
|
|
950
|
+
search?: string;
|
|
982
951
|
};
|
|
983
952
|
type GetInventoryBySizeParam = {
|
|
984
953
|
/**
|
|
@@ -1037,11 +1006,8 @@ type GetInventoryBySizeIdentifierParam = {
|
|
|
1037
1006
|
*/
|
|
1038
1007
|
locationIds?: number[];
|
|
1039
1008
|
};
|
|
1040
|
-
type
|
|
1041
|
-
|
|
1042
|
-
* - Company Id in which assets to be uploaded.
|
|
1043
|
-
*/
|
|
1044
|
-
jobId: string;
|
|
1009
|
+
type GetOptimalLocationsParam = {
|
|
1010
|
+
body: CatalogPlatformModel.AssignStore;
|
|
1045
1011
|
};
|
|
1046
1012
|
type GetProductParam = {
|
|
1047
1013
|
/**
|
|
@@ -1123,12 +1089,6 @@ type GetProductBundleDetailParam = {
|
|
|
1123
1089
|
*/
|
|
1124
1090
|
id: string;
|
|
1125
1091
|
};
|
|
1126
|
-
type GetProductExportDetailParam = {
|
|
1127
|
-
/**
|
|
1128
|
-
* - Company Id in which assets to be uploaded.
|
|
1129
|
-
*/
|
|
1130
|
-
jobId: string;
|
|
1131
|
-
};
|
|
1132
1092
|
type GetProductExportJobsParam = {
|
|
1133
1093
|
/**
|
|
1134
1094
|
* - This is a parameter used to find all the jobs
|
|
@@ -1163,42 +1123,27 @@ type GetProductExportJobsParam = {
|
|
|
1163
1123
|
};
|
|
1164
1124
|
type GetProductSizeParam = {
|
|
1165
1125
|
/**
|
|
1166
|
-
* - Item
|
|
1126
|
+
* - Item code of the product size.
|
|
1167
1127
|
*/
|
|
1168
|
-
|
|
1169
|
-
};
|
|
1170
|
-
type GetProductTemplateBySlugParam = {
|
|
1171
|
-
/**
|
|
1172
|
-
* - Slug of the template.
|
|
1173
|
-
*/
|
|
1174
|
-
slug: string;
|
|
1175
|
-
};
|
|
1176
|
-
type GetProductValidationParam = {
|
|
1128
|
+
itemCode?: string;
|
|
1177
1129
|
/**
|
|
1178
|
-
* -
|
|
1130
|
+
* - Item Id of the product size.
|
|
1179
1131
|
*/
|
|
1180
|
-
|
|
1132
|
+
itemId: number;
|
|
1181
1133
|
/**
|
|
1182
|
-
* -
|
|
1134
|
+
* - Brand Id of the product size.
|
|
1183
1135
|
*/
|
|
1184
|
-
|
|
1185
|
-
};
|
|
1186
|
-
type GetProductVerificationDetailsParam = {
|
|
1136
|
+
brandUid?: number;
|
|
1187
1137
|
/**
|
|
1188
|
-
* -
|
|
1138
|
+
* - Id of the product size.
|
|
1189
1139
|
*/
|
|
1190
|
-
|
|
1140
|
+
uid?: number;
|
|
1191
1141
|
};
|
|
1192
1142
|
type GetProductsParam = {
|
|
1193
1143
|
/**
|
|
1194
1144
|
* - Get multiple products filtered by Brand Ids
|
|
1195
1145
|
*/
|
|
1196
1146
|
brandIds?: number[];
|
|
1197
|
-
/**
|
|
1198
|
-
* - Get multiple products filtered by weather
|
|
1199
|
-
* have multiple sizes or not
|
|
1200
|
-
*/
|
|
1201
|
-
multiSize?: boolean;
|
|
1202
1147
|
/**
|
|
1203
1148
|
* - Get multiple products filtered by Category Ids
|
|
1204
1149
|
*/
|
|
@@ -1291,10 +1236,6 @@ type GetSizeGuidesParam = {
|
|
|
1291
1236
|
* - Query that is to be searched.
|
|
1292
1237
|
*/
|
|
1293
1238
|
q?: string;
|
|
1294
|
-
/**
|
|
1295
|
-
* - Brand id that is to be searched.
|
|
1296
|
-
*/
|
|
1297
|
-
brandId?: number;
|
|
1298
1239
|
/**
|
|
1299
1240
|
* - To filter size guide on basis of tag.
|
|
1300
1241
|
*/
|
|
@@ -1309,6 +1250,10 @@ type GetSizeGuidesParam = {
|
|
|
1309
1250
|
* Default is 10.
|
|
1310
1251
|
*/
|
|
1311
1252
|
pageSize?: number;
|
|
1253
|
+
/**
|
|
1254
|
+
* - Brand id that is to be searched.
|
|
1255
|
+
*/
|
|
1256
|
+
brandId?: number;
|
|
1312
1257
|
};
|
|
1313
1258
|
type GetStoreDetailParam = {
|
|
1314
1259
|
/**
|
|
@@ -1325,13 +1270,6 @@ type GetStoreDetailParam = {
|
|
|
1325
1270
|
*/
|
|
1326
1271
|
pageSize?: number;
|
|
1327
1272
|
};
|
|
1328
|
-
type GetVariantTypesParam = {
|
|
1329
|
-
/**
|
|
1330
|
-
* - The page number to navigate through the
|
|
1331
|
-
* given set of results
|
|
1332
|
-
*/
|
|
1333
|
-
templateTag: string;
|
|
1334
|
-
};
|
|
1335
1273
|
type GetVariantsOfProductsParam = {
|
|
1336
1274
|
/**
|
|
1337
1275
|
* - Get list of variants of item Id
|
|
@@ -1379,6 +1317,10 @@ type ListCategoriesParam = {
|
|
|
1379
1317
|
* - Get multiple categories filtered by category uids.
|
|
1380
1318
|
*/
|
|
1381
1319
|
uids?: number[];
|
|
1320
|
+
/**
|
|
1321
|
+
* - Get category by slug
|
|
1322
|
+
*/
|
|
1323
|
+
slug?: string;
|
|
1382
1324
|
};
|
|
1383
1325
|
type ListDepartmentsDataParam = {
|
|
1384
1326
|
/**
|
|
@@ -1411,13 +1353,13 @@ type ListDepartmentsDataParam = {
|
|
|
1411
1353
|
*/
|
|
1412
1354
|
isActive?: boolean;
|
|
1413
1355
|
/**
|
|
1414
|
-
* -
|
|
1356
|
+
* - Can filter by slug
|
|
1415
1357
|
*/
|
|
1416
|
-
|
|
1358
|
+
slug?: string;
|
|
1417
1359
|
};
|
|
1418
1360
|
type ListInventoryExportParam = {
|
|
1419
1361
|
/**
|
|
1420
|
-
* - Status of the export job.
|
|
1362
|
+
* - Status of the export job.(Pending, Running, Success)
|
|
1421
1363
|
*/
|
|
1422
1364
|
status?: string;
|
|
1423
1365
|
/**
|
|
@@ -1461,19 +1403,6 @@ type ListProductTemplateCategoriesParam = {
|
|
|
1461
1403
|
* `set`, `standard`, `digital`, etc.
|
|
1462
1404
|
*/
|
|
1463
1405
|
itemType: string;
|
|
1464
|
-
/**
|
|
1465
|
-
* - Number of categories needed in one page
|
|
1466
|
-
*/
|
|
1467
|
-
pageSize?: number;
|
|
1468
|
-
/**
|
|
1469
|
-
* - Page number to fetch, for example if pagesize
|
|
1470
|
-
* is 10 and page number 1,
|
|
1471
|
-
*/
|
|
1472
|
-
pageNo?: number;
|
|
1473
|
-
/**
|
|
1474
|
-
* - Search string to search categories from
|
|
1475
|
-
*/
|
|
1476
|
-
q?: number;
|
|
1477
1406
|
};
|
|
1478
1407
|
type ListTemplateBrandTypeValuesParam = {
|
|
1479
1408
|
/**
|
|
@@ -1492,43 +1421,47 @@ type ListTemplateBrandTypeValuesParam = {
|
|
|
1492
1421
|
*/
|
|
1493
1422
|
itemType?: string;
|
|
1494
1423
|
};
|
|
1495
|
-
type
|
|
1424
|
+
type UpdateHsnCodeParam = {
|
|
1496
1425
|
/**
|
|
1497
|
-
* -
|
|
1426
|
+
* - Unique id
|
|
1498
1427
|
*/
|
|
1499
|
-
|
|
1500
|
-
body: CatalogPlatformModel.
|
|
1428
|
+
id: string;
|
|
1429
|
+
body: CatalogPlatformModel.HsnUpsert;
|
|
1430
|
+
};
|
|
1431
|
+
type UpdateInventoriesParam = {
|
|
1432
|
+
body: CatalogPlatformModel.InventoryRequestSchemaV2;
|
|
1501
1433
|
};
|
|
1502
|
-
type
|
|
1434
|
+
type UpdateLocationPriceParam = {
|
|
1503
1435
|
/**
|
|
1504
|
-
* -
|
|
1436
|
+
* - The Store Id to update price of size for specific store.
|
|
1505
1437
|
*/
|
|
1506
|
-
|
|
1507
|
-
body: CatalogPlatformModel.ExportPatchRequest;
|
|
1508
|
-
};
|
|
1509
|
-
type UpdateCategoryParam = {
|
|
1438
|
+
storeId: number;
|
|
1510
1439
|
/**
|
|
1511
|
-
* -
|
|
1440
|
+
* - Size Identifier (Seller Identifier or
|
|
1441
|
+
* Primary Identifier) of which article price is to update.
|
|
1512
1442
|
*/
|
|
1513
|
-
|
|
1514
|
-
body: CatalogPlatformModel.
|
|
1443
|
+
sellerIdentifier: string;
|
|
1444
|
+
body: CatalogPlatformModel.LocationPriceRequestSchema;
|
|
1515
1445
|
};
|
|
1516
|
-
type
|
|
1446
|
+
type UpdateLocationQuantityParam = {
|
|
1517
1447
|
/**
|
|
1518
|
-
* -
|
|
1448
|
+
* - The Store Id to update quantity of size for
|
|
1449
|
+
* specific store.
|
|
1519
1450
|
*/
|
|
1520
|
-
|
|
1521
|
-
|
|
1522
|
-
|
|
1523
|
-
|
|
1524
|
-
|
|
1451
|
+
storeId: number;
|
|
1452
|
+
/**
|
|
1453
|
+
* - Size Identifier (Seller Identifier or
|
|
1454
|
+
* Primary Identifier) of which article quantity is to update.
|
|
1455
|
+
*/
|
|
1456
|
+
sellerIdentifier: string;
|
|
1457
|
+
body: CatalogPlatformModel.LocationQuantityRequestSchema;
|
|
1525
1458
|
};
|
|
1526
1459
|
type UpdateMarketplaceOptinParam = {
|
|
1527
1460
|
/**
|
|
1528
1461
|
* - Slug of the marketplace .
|
|
1529
1462
|
*/
|
|
1530
|
-
|
|
1531
|
-
body: CatalogPlatformModel.
|
|
1463
|
+
marketplaceSlug: string;
|
|
1464
|
+
body: CatalogPlatformModel.UpdateMarketplaceOptinRequestSchema;
|
|
1532
1465
|
};
|
|
1533
1466
|
type UpdateProductBundleParam = {
|
|
1534
1467
|
/**
|
|
@@ -1536,7 +1469,7 @@ type UpdateProductBundleParam = {
|
|
|
1536
1469
|
* detail. Pass the `id` of the keywords which you want to delete.
|
|
1537
1470
|
*/
|
|
1538
1471
|
id: string;
|
|
1539
|
-
body: CatalogPlatformModel.
|
|
1472
|
+
body: CatalogPlatformModel.ProductBundleUpdateRequestSchema;
|
|
1540
1473
|
};
|
|
1541
1474
|
type UpdateRealtimeInventoryParam = {
|
|
1542
1475
|
/**
|
|
@@ -1552,7 +1485,7 @@ type UpdateRealtimeInventoryParam = {
|
|
|
1552
1485
|
};
|
|
1553
1486
|
type UpdateSizeGuideParam = {
|
|
1554
1487
|
/**
|
|
1555
|
-
* -
|
|
1488
|
+
* - Identifier of the size guide to be edited
|
|
1556
1489
|
*/
|
|
1557
1490
|
id: string;
|
|
1558
1491
|
body: CatalogPlatformModel.ValidateSizeGuide;
|
|
@@ -1564,11 +1497,25 @@ type UploadBulkProductsParam = {
|
|
|
1564
1497
|
department: string;
|
|
1565
1498
|
/**
|
|
1566
1499
|
* - Product type of the product to be uploaded
|
|
1567
|
-
* i.e. set, standard
|
|
1500
|
+
* i.e. set, standard, digital.
|
|
1568
1501
|
*/
|
|
1569
1502
|
productType: string;
|
|
1570
1503
|
body: CatalogPlatformModel.BulkProductJob;
|
|
1571
1504
|
};
|
|
1505
|
+
type ValidateProductGlobalTemplateParam = {
|
|
1506
|
+
/**
|
|
1507
|
+
* - An `item_type` defines the type of item. The
|
|
1508
|
+
* default value is standard.
|
|
1509
|
+
*/
|
|
1510
|
+
itemType?: string;
|
|
1511
|
+
/**
|
|
1512
|
+
* - This specification determines the schema type to
|
|
1513
|
+
* be retrieved. When set to true, it will return the schema for bulk data;
|
|
1514
|
+
* when set to false, it will provide the schema for a single product. The
|
|
1515
|
+
* default value is false.
|
|
1516
|
+
*/
|
|
1517
|
+
bulk?: boolean;
|
|
1518
|
+
};
|
|
1572
1519
|
type ValidateProductTemplateParam = {
|
|
1573
1520
|
/**
|
|
1574
1521
|
* - A `slug` is a unique identifier for a particular template.
|
|
@@ -1593,16 +1540,14 @@ type ValidateProductTemplateSchemaParam = {
|
|
|
1593
1540
|
* default value is standard.
|
|
1594
1541
|
*/
|
|
1595
1542
|
itemType: string;
|
|
1596
|
-
/**
|
|
1597
|
-
* - Type of file template i.e if bulk
|
|
1598
|
-
*/
|
|
1599
|
-
bulk: boolean;
|
|
1600
1543
|
};
|
|
1601
1544
|
type GetCompanyDetailParam = any;
|
|
1602
1545
|
type GetCompanyMetricsParam = any;
|
|
1603
1546
|
type GetInventoryExportParam = any;
|
|
1604
|
-
type
|
|
1547
|
+
type GetMarketplaceOptinDetailParam = any;
|
|
1605
1548
|
type GetMarketplacesParam = any;
|
|
1606
1549
|
type GetProductTagsParam = any;
|
|
1550
|
+
type GetProductValidationParam = any;
|
|
1607
1551
|
type ListHSNCodesParam = any;
|
|
1552
|
+
type ListProductTemplateExportDetailsParam = any;
|
|
1608
1553
|
import CatalogPlatformModel = require("./CatalogPlatformModel");
|