@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
|
@@ -4,33 +4,26 @@ export = CatalogPlatformApplicationValidator;
|
|
|
4
4
|
* @property {string} id - A `id` is a unique identifier of a collection.
|
|
5
5
|
* @property {CatalogPlatformModel.CollectionItemUpdateSchema} body
|
|
6
6
|
*/
|
|
7
|
-
/**
|
|
8
|
-
* @typedef AddProductsInPriceFactoryByZoneIdParam
|
|
9
|
-
* @property {string} id - An `id` is a unique identifier for a particular price factory.
|
|
10
|
-
* @property {CatalogPlatformModel.CreatePriceFactoryProductRequest} body
|
|
11
|
-
*/
|
|
12
|
-
/**
|
|
13
|
-
* @typedef ClearCollectionItemsPriorityParam
|
|
14
|
-
* @property {string} id - A `id` is a unique identifier of a collection.
|
|
15
|
-
*/
|
|
16
7
|
/**
|
|
17
8
|
* @typedef CreateAppCategoryReturnConfigurationParam
|
|
18
9
|
* @property {CatalogPlatformModel.BaseAppCategoryReturnConfig} body
|
|
19
10
|
*/
|
|
20
|
-
/**
|
|
21
|
-
* @typedef CreateAppPriceFactoryParam
|
|
22
|
-
* @property {CatalogPlatformModel.CreateAppPriceFactoryRequestSchema} body
|
|
23
|
-
*/
|
|
24
11
|
/**
|
|
25
12
|
* @typedef CreateAppReturnConfigurationParam
|
|
26
13
|
* @property {CatalogPlatformModel.CreateUpdateAppReturnConfig} body
|
|
27
14
|
*/
|
|
28
|
-
/**
|
|
29
|
-
* @typedef CreateAutocompleteSettingsParam
|
|
30
|
-
* @property {CatalogPlatformModel.AutocompleteRequestSchema} body
|
|
31
|
-
*/
|
|
32
15
|
/**
|
|
33
16
|
* @typedef CreateCollectionParam
|
|
17
|
+
* @property {string} [q] - Get collection list filtered by q string,
|
|
18
|
+
* @property {string} [scheduleStatus] - Get collection list filtered by scheduled status,
|
|
19
|
+
* @property {string} [type] - Type of the collections
|
|
20
|
+
* @property {string[]} [tags] - Each response will contain next_id param, which
|
|
21
|
+
* should be sent back to make pagination work.
|
|
22
|
+
* @property {boolean} [isActive] - Get collections filtered by active status.
|
|
23
|
+
* @property {number} [pageNo] - The page number to navigate through the given
|
|
24
|
+
* set of results.
|
|
25
|
+
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
26
|
+
* Default is 12.
|
|
34
27
|
* @property {CatalogPlatformModel.CreateCollection} body
|
|
35
28
|
*/
|
|
36
29
|
/**
|
|
@@ -54,58 +47,17 @@ export = CatalogPlatformApplicationValidator;
|
|
|
54
47
|
* @typedef CreateGroupConfigurationParam
|
|
55
48
|
* @property {string} configType - A `config_type` is a unique identifier for a
|
|
56
49
|
* particular group configuration type.
|
|
57
|
-
* @property {CatalogPlatformModel.
|
|
50
|
+
* @property {CatalogPlatformModel.AppConfigurationDetail} body
|
|
58
51
|
*/
|
|
59
52
|
/**
|
|
60
53
|
* @typedef CreateListingConfigurationParam
|
|
61
54
|
* @property {string} configType - A `config_type` is a unique identifier for a
|
|
62
55
|
* particular listing configuration type.
|
|
63
|
-
* @property {CatalogPlatformModel.
|
|
64
|
-
*/
|
|
65
|
-
/**
|
|
66
|
-
* @typedef CreateMerchandisingRuleBoostActionParam
|
|
67
|
-
* @property {string} merchandisingRuleId - A `merchandising_rule_id` is a
|
|
68
|
-
* unique identifier for a particular merchandising rule.
|
|
69
|
-
* @property {CatalogPlatformModel.PostMerchandisingRuleBoostAction} body
|
|
70
|
-
*/
|
|
71
|
-
/**
|
|
72
|
-
* @typedef CreateMerchandisingRuleBuryActionParam
|
|
73
|
-
* @property {string} merchandisingRuleId - A `merchandising_rule_id` is a
|
|
74
|
-
* unique identifier for a particular merchandising rule.
|
|
75
|
-
* @property {CatalogPlatformModel.PostMerchandisingRuleBoostAction} body
|
|
76
|
-
*/
|
|
77
|
-
/**
|
|
78
|
-
* @typedef CreateMerchandisingRuleHideActionParam
|
|
79
|
-
* @property {string} merchandisingRuleId - A `merchandising_rule_id` is a
|
|
80
|
-
* unique identifier for a particular merchandising rule.
|
|
81
|
-
* @property {CatalogPlatformModel.HideRequest} body
|
|
82
|
-
*/
|
|
83
|
-
/**
|
|
84
|
-
* @typedef CreateMerchandisingRulePinActionParam
|
|
85
|
-
* @property {string} merchandisingRuleId - A `merchandising_rule_id` is a
|
|
86
|
-
* unique identifier for a particular merchandising rule.
|
|
87
|
-
* @property {CatalogPlatformModel.PinRequest} body
|
|
88
|
-
*/
|
|
89
|
-
/**
|
|
90
|
-
* @typedef CreateMerchandisingRuleQueryParam
|
|
91
|
-
* @property {CatalogPlatformModel.MerchandisingRuleQueryPost} body
|
|
92
|
-
*/
|
|
93
|
-
/**
|
|
94
|
-
* @typedef CreateProductPriceFactoryBulkJobParam
|
|
95
|
-
* @property {string} id - An `id` is a unique identifier for a particular price factory.
|
|
96
|
-
* @property {CatalogPlatformModel.CreateAppPriceFactoryProductBulkJobRequest} body
|
|
56
|
+
* @property {CatalogPlatformModel.AppConfigurationsSort} body
|
|
97
57
|
*/
|
|
98
58
|
/**
|
|
99
59
|
* @typedef CreateSearchConfigurationParam
|
|
100
|
-
* @property {CatalogPlatformModel.
|
|
101
|
-
*/
|
|
102
|
-
/**
|
|
103
|
-
* @typedef CreateSearchRerankParam
|
|
104
|
-
* @property {CatalogPlatformModel.CreateSearchRerankRequest} body
|
|
105
|
-
*/
|
|
106
|
-
/**
|
|
107
|
-
* @typedef CreateSynonymsParam
|
|
108
|
-
* @property {CatalogPlatformModel.SynonymCreateRequestSchema} body
|
|
60
|
+
* @property {CatalogPlatformModel.CreateSearchConfigurationRequestSchema} body
|
|
109
61
|
*/
|
|
110
62
|
/**
|
|
111
63
|
* @typedef DeleteAppCategoryReturnConfigurationParam
|
|
@@ -134,49 +86,18 @@ export = CatalogPlatformApplicationValidator;
|
|
|
134
86
|
* @property {string} configId - A `config_id` is a unique identifier of a
|
|
135
87
|
* particular configuration.
|
|
136
88
|
*/
|
|
137
|
-
/**
|
|
138
|
-
* @typedef DeleteMerchandisingRuleParam
|
|
139
|
-
* @property {string} merchandisingRuleId - A `merchandising_rule_id` is a
|
|
140
|
-
* unique identifier for a particular merchandising rule.
|
|
141
|
-
*/
|
|
142
|
-
/**
|
|
143
|
-
* @typedef DeleteMerchandisingRulesPreviewParam
|
|
144
|
-
* @property {string} merchandisingRuleId - A `merchandising_rule_id` is a
|
|
145
|
-
* unique identifier for a particular merchandising rule.
|
|
146
|
-
*/
|
|
147
89
|
/** @typedef DeleteSearchConfigurationParam */
|
|
148
90
|
/**
|
|
149
91
|
* @typedef DeleteSearchKeywordsParam
|
|
150
92
|
* @property {string} id - A `id` is a unique identifier for a particular
|
|
151
93
|
* detail. Pass the `id` of the keywords which you want to delete.
|
|
152
94
|
*/
|
|
153
|
-
/**
|
|
154
|
-
* @typedef DeleteSearchRerankConfigurationParam
|
|
155
|
-
* @property {string} id - An `id` is the identifier for a particular search
|
|
156
|
-
* rerank configuration. channel.
|
|
157
|
-
*/
|
|
158
|
-
/**
|
|
159
|
-
* @typedef DeleteSynonymParam
|
|
160
|
-
* @property {string} id - A `id` is a unique identifier of a synonym that is to
|
|
161
|
-
* be deleted.
|
|
162
|
-
*/
|
|
163
|
-
/**
|
|
164
|
-
* @typedef EditAppPriceFactoryParam
|
|
165
|
-
* @property {string} id - An `id` is a unique identifier for a particular price factory.
|
|
166
|
-
* @property {CatalogPlatformModel.EditAppPriceFactoryRequestSchema} body
|
|
167
|
-
*/
|
|
168
|
-
/**
|
|
169
|
-
* @typedef ExportProductsInPriceFactoryParam
|
|
170
|
-
* @property {string} id - An `id` is a unique identifier for a particular price factory.
|
|
171
|
-
* @property {CatalogPlatformModel.CreateAppPriceFactoryProductExportJobRequest} body
|
|
172
|
-
*/
|
|
173
|
-
/** @typedef ExportSynonymsParam */
|
|
174
95
|
/**
|
|
175
96
|
* @typedef GetAllCollectionsParam
|
|
176
97
|
* @property {string} [q] - Get collection list filtered by q string,
|
|
177
98
|
* @property {string} [scheduleStatus] - Get collection list filtered by scheduled status,
|
|
178
99
|
* @property {string} [type] - Type of the collections
|
|
179
|
-
* @property {string[]} [
|
|
100
|
+
* @property {string[]} [tags] - Each response will contain next_id param, which
|
|
180
101
|
* should be sent back to make pagination work.
|
|
181
102
|
* @property {boolean} [isActive] - Get collections filtered by active status.
|
|
182
103
|
* @property {number} [pageNo] - The page number to navigate through the given
|
|
@@ -184,17 +105,7 @@ export = CatalogPlatformApplicationValidator;
|
|
|
184
105
|
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
185
106
|
* Default is 12.
|
|
186
107
|
*/
|
|
187
|
-
/**
|
|
188
|
-
* @typedef GetAllSearchKeywordParam
|
|
189
|
-
* @property {number} [pageNo] - The page number to navigate through the given
|
|
190
|
-
* set of results
|
|
191
|
-
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
192
|
-
* Default is 12.
|
|
193
|
-
* @property {string} [q] - Search query with words name.Use this parameter to
|
|
194
|
-
* search keywords by words.
|
|
195
|
-
* @property {boolean} [isActive] - Can query for keywords based on whether they
|
|
196
|
-
* are active or inactive.
|
|
197
|
-
*/
|
|
108
|
+
/** @typedef GetAllSearchKeywordParam */
|
|
198
109
|
/**
|
|
199
110
|
* @typedef GetAppCategoryReturnConfigParam
|
|
200
111
|
* @property {string} [q] - Get return configurations for categories by matching
|
|
@@ -239,49 +150,10 @@ export = CatalogPlatformApplicationValidator;
|
|
|
239
150
|
* Default is 20.
|
|
240
151
|
* @property {string[]} [tags] - Get locations filtered by tags.
|
|
241
152
|
* @property {string[]} [storeTypes] - Get locations filtered by store types.
|
|
242
|
-
* @property {number[]} [companyUids] - Filter stores by company IDs available
|
|
243
|
-
* in the application.
|
|
244
|
-
*/
|
|
245
|
-
/**
|
|
246
|
-
* @typedef GetAppPriceByIdParam
|
|
247
|
-
* @property {number} itemId - Unique identifier of the product
|
|
248
|
-
* @property {number[]} [storeIds] - An array of unique identifiers representing
|
|
249
|
-
* the store locations from which the product pricing should be fetched. If
|
|
250
|
-
* not provided, pricing for all applicable store locations will be returned.
|
|
251
|
-
* @property {string[]} [factoryTypeIds] - An array of unique factory type
|
|
252
|
-
* identifiers that specify that pricing from which factory type should be
|
|
253
|
-
* retrieved. This parameter allows filtering the price based on factory types.
|
|
254
|
-
* @property {number} [sellerId] - The company uid for which we want to fetch
|
|
255
|
-
* discounted pricing for a product
|
|
256
|
-
*/
|
|
257
|
-
/**
|
|
258
|
-
* @typedef GetAppPriceFactoriesParam
|
|
259
|
-
* @property {boolean} [isActive] - Gets price factory filtered by active status.
|
|
260
|
-
* @property {string} [factoryTypeId] - Gets price factory filtered by factory_type_id.
|
|
261
|
-
* @property {string} [code] - Gets price factory filtered by pricezone code.
|
|
262
|
-
* @property {number} [pageNo] - The page number to navigate through the given
|
|
263
|
-
* set of results.
|
|
264
|
-
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
265
|
-
* Default is 12.
|
|
266
|
-
*/
|
|
267
|
-
/**
|
|
268
|
-
* @typedef GetAppPriceFactoryParam
|
|
269
|
-
* @property {string} id - An `id` is a unique identifier for a particular price factory.
|
|
270
153
|
*/
|
|
271
154
|
/**
|
|
272
155
|
* @typedef GetAppProductParam
|
|
273
|
-
* @property {
|
|
274
|
-
*/
|
|
275
|
-
/**
|
|
276
|
-
* @typedef GetAppProductPricesParam
|
|
277
|
-
* @property {number[]} [itemIds] - List of item ids to get product prices
|
|
278
|
-
* filtered by items.
|
|
279
|
-
* @property {string[]} [factoryTypeIds] - List of factory type ids to get
|
|
280
|
-
* product prices filtered by factory type id.
|
|
281
|
-
* @property {number} [pageNo] - The page number to navigate through the given
|
|
282
|
-
* set of results
|
|
283
|
-
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
284
|
-
* Default is 10.
|
|
156
|
+
* @property {string} itemId - Product id for a particular product.
|
|
285
157
|
*/
|
|
286
158
|
/**
|
|
287
159
|
* @typedef GetAppProductsParam
|
|
@@ -297,41 +169,13 @@ export = CatalogPlatformApplicationValidator;
|
|
|
297
169
|
* @property {string} [q] - Search with Item Code, Name, Slug or Identifier.
|
|
298
170
|
*/
|
|
299
171
|
/** @typedef GetAppReturnConfigurationParam */
|
|
300
|
-
/**
|
|
301
|
-
* @typedef GetAppicationProductsParam
|
|
302
|
-
* @property {string} [q] - The search query. This can be a partial or complete
|
|
303
|
-
* name of a either a product, brand or category
|
|
304
|
-
* @property {string} [f] - The search filter parameters. All the parameter
|
|
305
|
-
* filtered from filter parameters will be passed in **f** parameter in this
|
|
306
|
-
* format. **?f=brand:voi-jeans||and:::category:t-shirts||shirts**
|
|
307
|
-
* @property {string} [c] - The search filter parameters for collection items.
|
|
308
|
-
* All the parameter filtered from filter parameters will be passed in **c**
|
|
309
|
-
* parameter in this format.
|
|
310
|
-
* **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
|
|
311
|
-
* @property {boolean} [filters] - Pass `filters` parameter to fetch the filter
|
|
312
|
-
* details. This flag is used to fetch all filters
|
|
313
|
-
* @property {boolean} [isDependent] - This query parameter is used to get the
|
|
314
|
-
* dependent products in the listing.
|
|
315
|
-
* @property {string} [sortOn] - The order to sort the list of products on. The
|
|
316
|
-
* supported sort parameters are popularity, price, redemption and discount in
|
|
317
|
-
* either ascending or descending order. See the supported values below.
|
|
318
|
-
* @property {string} [pageId] - Each response will contain **page_id** param,
|
|
319
|
-
* which should be sent back to make pagination work.
|
|
320
|
-
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
321
|
-
* Default is 12.
|
|
322
|
-
* @property {number} [pageNo] - If page_type is number then pass it to fetch
|
|
323
|
-
* page items. Default is 1.
|
|
324
|
-
* @property {string} [pageType] - For pagination type should be cursor or
|
|
325
|
-
* number. Default is cursor.
|
|
326
|
-
* @property {string[]} [itemIds] - Item Ids of product
|
|
327
|
-
*/
|
|
328
172
|
/**
|
|
329
173
|
* @typedef GetApplicationBrandListingParam
|
|
330
174
|
* @property {number} [pageNo] - The page number to navigate through the given
|
|
331
175
|
* set of results
|
|
332
176
|
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
333
177
|
* Default is 12.
|
|
334
|
-
* @property {string} [q] - Search query with brand name.Use this parameter to
|
|
178
|
+
* @property {string} [q] - Search query with brand name. Use this parameter to
|
|
335
179
|
* search brands by brand name.
|
|
336
180
|
*/
|
|
337
181
|
/**
|
|
@@ -339,12 +183,12 @@ export = CatalogPlatformApplicationValidator;
|
|
|
339
183
|
* @property {string} [department] - The name of the department. Use this
|
|
340
184
|
* parameter to filter products by a particular department. See below the list
|
|
341
185
|
* of available departments. You can retrieve available departments from the
|
|
342
|
-
*
|
|
186
|
+
* "v1.0/departments/" API
|
|
343
187
|
* @property {number} [pageNo] - The page number to navigate through the given
|
|
344
188
|
* set of results
|
|
345
189
|
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
346
190
|
* Default is 12.
|
|
347
|
-
* @property {string} [q] - Search query with brand name.Use this parameter to
|
|
191
|
+
* @property {string} [q] - Search query with brand name. Use this parameter to
|
|
348
192
|
* search brands by brand name.
|
|
349
193
|
* @property {number[]} [brandId] - Helps to sort the brands list on the basis
|
|
350
194
|
* of uid list.
|
|
@@ -357,8 +201,8 @@ export = CatalogPlatformApplicationValidator;
|
|
|
357
201
|
* set of results
|
|
358
202
|
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
359
203
|
* Default is 12.
|
|
360
|
-
* @property {string} [q] -
|
|
361
|
-
*
|
|
204
|
+
* @property {string} [q] - A search query string. Use this parameter to filter
|
|
205
|
+
* results based on a keyword or specific value.
|
|
362
206
|
*/
|
|
363
207
|
/**
|
|
364
208
|
* @typedef GetApplicationDepartmentListingParam
|
|
@@ -366,69 +210,78 @@ export = CatalogPlatformApplicationValidator;
|
|
|
366
210
|
* set of results
|
|
367
211
|
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
368
212
|
* Default is 12.
|
|
369
|
-
* @property {string} [q] -
|
|
370
|
-
*
|
|
213
|
+
* @property {string} [q] - A search query string. Use this parameter to filter
|
|
214
|
+
* results based on a keyword or specific value.
|
|
371
215
|
*/
|
|
372
216
|
/**
|
|
373
217
|
* @typedef GetApplicationFilterKeysParam
|
|
374
218
|
* @property {string} [c] - The search filter parameters for collection items.
|
|
375
|
-
* All the parameter filtered from filter parameters will be passed in
|
|
376
|
-
* parameter in this format.
|
|
377
|
-
* **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
|
|
219
|
+
* All the parameter filtered from filter parameters will be passed in "c"
|
|
220
|
+
* parameter in this format. "?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts"
|
|
378
221
|
*/
|
|
379
222
|
/**
|
|
380
223
|
* @typedef GetApplicationFilterValuesParam
|
|
381
|
-
* @property {string} filterKey - A `filter_key` is a filter key
|
|
382
|
-
* all the available filter values
|
|
224
|
+
* @property {string} filterKey - A `filter_key` is a filter key which returns
|
|
225
|
+
* all the available filter values.
|
|
383
226
|
* @property {string} [c] - The search filter parameters for collection items.
|
|
384
|
-
* All the parameter filtered from filter parameters will be passed in
|
|
385
|
-
* parameter in this format.
|
|
386
|
-
* **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
|
|
227
|
+
* All the parameter filtered from filter parameters will be passed in "c"
|
|
228
|
+
* parameter in this format. "?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts"
|
|
387
229
|
* @property {string} [collectionId] - A `collection_id` is a unique identifier
|
|
388
|
-
* for a particular collection.
|
|
230
|
+
* for a particular collection.
|
|
389
231
|
* @property {number} [pageNo] - The page number to navigate through the given
|
|
390
232
|
* set of results
|
|
391
233
|
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
392
234
|
* Default is 10.
|
|
393
|
-
* @property {string} [q] -
|
|
235
|
+
* @property {string} [q] - The `q` parameter allows you to search and filter
|
|
236
|
+
* specific data within the filter options. It acts as a query keyword that
|
|
237
|
+
* can refine the results by matching relevant filter values, such as a
|
|
238
|
+
* category name or any other applicable filter criteria.
|
|
394
239
|
*/
|
|
395
240
|
/**
|
|
396
|
-
* @typedef
|
|
397
|
-
* @property {
|
|
398
|
-
*
|
|
241
|
+
* @typedef GetApplicationProductsParam
|
|
242
|
+
* @property {string} [q] - The search query. This can be a partial or complete
|
|
243
|
+
* name of a either a product, brand or category
|
|
244
|
+
* @property {string} [f] - The search filter parameters. All the parameter
|
|
245
|
+
* filtered from filter parameters will be passed in **f** parameter in this
|
|
246
|
+
* format. **?f=brand:voi-jeans||and:::category:t-shirts||shirts**
|
|
247
|
+
* @property {string} [c] - The search filter parameters for collection items.
|
|
248
|
+
* All the parameter filtered from filter parameters will be passed in **c**
|
|
249
|
+
* parameter in this format.
|
|
250
|
+
* **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
|
|
251
|
+
* @property {boolean} [filters] - Pass `filters` parameter to fetch the filter
|
|
252
|
+
* details. This flag is used to fetch all filters
|
|
253
|
+
* @property {boolean} [isDependent] - This query parameter is used to get the
|
|
254
|
+
* dependent products in the listing.
|
|
255
|
+
* @property {string} [sortOn] - The order to sort the list of products on. The
|
|
256
|
+
* supported sort parameters are popularity, price, redemption and discount in
|
|
257
|
+
* either ascending or descending order. See the supported values below.
|
|
258
|
+
* @property {string} [pageId] - Each response will contain **page_id** param,
|
|
259
|
+
* which should be sent back to make pagination work.
|
|
399
260
|
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
400
261
|
* Default is 12.
|
|
401
|
-
* @property {
|
|
402
|
-
*
|
|
403
|
-
* @property {
|
|
404
|
-
*
|
|
262
|
+
* @property {number} [pageNo] - If page_type is number then pass it to fetch
|
|
263
|
+
* page items. Default is 1.
|
|
264
|
+
* @property {string} [pageType] - For pagination type should be cursor or
|
|
265
|
+
* number. Default is cursor.
|
|
266
|
+
* @property {string[]} [itemIds] - Item Ids of product
|
|
405
267
|
*/
|
|
268
|
+
/** @typedef GetAutocompleteConfigParam */
|
|
406
269
|
/**
|
|
407
270
|
* @typedef GetAutocompleteKeywordDetailParam
|
|
408
271
|
* @property {string} id - A `id` is a unique identifier for a particular
|
|
409
272
|
* detail. Pass the `id` of the keywords which you want to retrieve.
|
|
410
273
|
*/
|
|
411
|
-
/**
|
|
412
|
-
* @typedef GetAutocompletePreviewParam
|
|
413
|
-
* @property {string} [q] - Get suggestions related to `q` string.
|
|
414
|
-
* @property {number} [categorySuggestion] - For getting related category suggestions.
|
|
415
|
-
* @property {number} [brandSuggestion] - For getting related brand suggestions.
|
|
416
|
-
* @property {number} [collectionSuggestion] - For getting collection suggestions.
|
|
417
|
-
* @property {number} [productSuggestion] - For getting product suggestions.
|
|
418
|
-
* @property {number} [querySuggestion] - For getting query suggestions.
|
|
419
|
-
*/
|
|
420
|
-
/** @typedef GetAutocompleteSettingsParam */
|
|
421
274
|
/** @typedef GetCatalogConfigurationParam */
|
|
422
275
|
/**
|
|
423
276
|
* @typedef GetCatalogInsightsParam
|
|
424
|
-
* @property {string} [brand] - Brand slug
|
|
277
|
+
* @property {string} [brand] - Brand slug that is to be searched.
|
|
425
278
|
*/
|
|
426
279
|
/**
|
|
427
280
|
* @typedef GetCategoriesParam
|
|
428
281
|
* @property {string} [department] - The name of the department. Use this
|
|
429
282
|
* parameter to filter products by a particular department. See below the list
|
|
430
283
|
* of available departments. You can retrieve available departments from the
|
|
431
|
-
*
|
|
284
|
+
* "v1.0/departments/" API
|
|
432
285
|
*/
|
|
433
286
|
/**
|
|
434
287
|
* @typedef GetCollectionDetailParam
|
|
@@ -441,14 +294,11 @@ export = CatalogPlatformApplicationValidator;
|
|
|
441
294
|
* @property {string} id - A `id` is a unique identifier of a collection.
|
|
442
295
|
* @property {string} [sortOn] - Each response will contain sort_on param, which
|
|
443
296
|
* should be sent back to make pagination work.
|
|
297
|
+
* @property {string} [pageId] - Each response will contain next_id param, which
|
|
298
|
+
* should be sent back to make pagination work.
|
|
444
299
|
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
445
300
|
* Default is 12.
|
|
446
301
|
* @property {number} [pageNo] - Identifies the specific page of results being requested.
|
|
447
|
-
* @property {boolean} [isPinned] - Number of items that are pinned and have
|
|
448
|
-
* priority in each page. Default is 12.
|
|
449
|
-
* @property {string} [q] - Get multiple products filtered by q string
|
|
450
|
-
* @property {boolean} [isExcluded] - Number of items that are excluded from
|
|
451
|
-
* collections in each page. Default is 12.
|
|
452
302
|
*/
|
|
453
303
|
/**
|
|
454
304
|
* @typedef GetConfigurationByTypeParam
|
|
@@ -460,18 +310,18 @@ export = CatalogPlatformApplicationValidator;
|
|
|
460
310
|
* a specific type of configuration.
|
|
461
311
|
* @property {string} [templateSlug] - Get configuration list filtered by
|
|
462
312
|
* `template_slug` string. This is for the details and comparision groups.
|
|
313
|
+
* @property {number} [pageNo] - The page number to navigate through the given
|
|
314
|
+
* set of results.
|
|
315
|
+
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
316
|
+
* @property {string} [q] - Get configuration list filtered by `q` string.
|
|
463
317
|
*/
|
|
464
318
|
/** @typedef GetConfigurationsParam */
|
|
465
|
-
/**
|
|
466
|
-
* @typedef GetConfigurationsFilterMetadataParam
|
|
467
|
-
* @property {string} filter - Filter whose values needs to be fetched.
|
|
468
|
-
*/
|
|
469
319
|
/** @typedef GetDepartmentsParam */
|
|
470
320
|
/**
|
|
471
321
|
* @typedef GetDiscountedInventoryBySizeIdentifierParam
|
|
472
|
-
* @property {number} itemId -
|
|
322
|
+
* @property {number} itemId - A `item_id` is a unique identifier for a specific product.
|
|
473
323
|
* @property {number} sizeIdentifier - Size Identifier (Seller Identifier or
|
|
474
|
-
* Primary Identifier)
|
|
324
|
+
* Primary Identifier).
|
|
475
325
|
* @property {number} [pageNo] - The page number to navigate through the given
|
|
476
326
|
* set of results
|
|
477
327
|
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
@@ -499,65 +349,12 @@ export = CatalogPlatformApplicationValidator;
|
|
|
499
349
|
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
500
350
|
* Default is 12.
|
|
501
351
|
* @property {string} [search] - Get configuration list filtered by `search` string.
|
|
502
|
-
* @property {number[]} [uids] - Only for categories config type, Get
|
|
503
|
-
* configuration list filtered by `uids`.
|
|
504
|
-
*/
|
|
505
|
-
/**
|
|
506
|
-
* @typedef GetLivePreviewParam
|
|
507
|
-
* @property {string} merchandisingRuleId - A `merchandising_rule_id` is a
|
|
508
|
-
* unique identifier for a particular merchandising rule.
|
|
509
|
-
* @property {string} [searchKeyword] - A sample query that can be used to get a
|
|
510
|
-
* live preview of the merchandising rule.
|
|
511
|
-
*/
|
|
512
|
-
/**
|
|
513
|
-
* @typedef GetMerchandisingQueryParam
|
|
514
|
-
* @property {string} merchandisingRuleId - A `merchandising_rule_id` is a
|
|
515
|
-
* unique identifier for a particular merchandising rule.
|
|
516
|
-
*/
|
|
517
|
-
/**
|
|
518
|
-
* @typedef GetMerchandisingRuleBoostActionParam
|
|
519
|
-
* @property {string} merchandisingRuleId - A `merchandising_rule_id` is a
|
|
520
|
-
* unique identifier for a particular merchandising rule.
|
|
521
|
-
*/
|
|
522
|
-
/**
|
|
523
|
-
* @typedef GetMerchandisingRuleBuryActionParam
|
|
524
|
-
* @property {string} merchandisingRuleId - A `merchandising_rule_id` is a
|
|
525
|
-
* unique identifier for a particular merchandising rule.
|
|
526
|
-
*/
|
|
527
|
-
/**
|
|
528
|
-
* @typedef GetMerchandisingRuleHideActionParam
|
|
529
|
-
* @property {string} merchandisingRuleId - A `merchandising_rule_id` is a
|
|
530
|
-
* unique identifier for a particular merchandising rule.
|
|
531
|
-
*/
|
|
532
|
-
/**
|
|
533
|
-
* @typedef GetMerchandisingRulePinActionParam
|
|
534
|
-
* @property {string} merchandisingRuleId - A `merchandising_rule_id` is a
|
|
535
|
-
* unique identifier for a particular merchandising rule.
|
|
536
|
-
*/
|
|
537
|
-
/**
|
|
538
|
-
* @typedef GetMerchandisingRulesParam
|
|
539
|
-
* @property {string} [pageId] - Each response will contain next_id param, which
|
|
540
|
-
* should be sent back to make pagination work.
|
|
541
|
-
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
542
|
-
* Default is 12.
|
|
543
352
|
*/
|
|
544
353
|
/**
|
|
545
354
|
* @typedef GetProductDetailBySlugParam
|
|
546
355
|
* @property {string} slug - The unique identifier of a product. i.e; `slug` of
|
|
547
356
|
* a product. You can retrieve these from the APIs that list products like
|
|
548
|
-
*
|
|
549
|
-
*/
|
|
550
|
-
/**
|
|
551
|
-
* @typedef GetProductsInPriceFactoryByZoneIdParam
|
|
552
|
-
* @property {string} id - An `id` is a unique identifier for a particular price factory.
|
|
553
|
-
* @property {string} zoneId - An `zone_id` is a unique identifier for a
|
|
554
|
-
* particular price factory zone.
|
|
555
|
-
* @property {number} [itemId] - Gets price factory filtered by item_id.
|
|
556
|
-
* @property {string} [q] - Gets price factory filtered by search query.
|
|
557
|
-
* @property {number} [pageNo] - The page number to navigate through the given
|
|
558
|
-
* set of results.
|
|
559
|
-
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
560
|
-
* Default is 12.
|
|
357
|
+
* "v1.0/products/"
|
|
561
358
|
*/
|
|
562
359
|
/** @typedef GetQueryFiltersParam */
|
|
563
360
|
/** @typedef GetSearchConfigurationParam */
|
|
@@ -566,63 +363,20 @@ export = CatalogPlatformApplicationValidator;
|
|
|
566
363
|
* @property {string} id - A `id` is a unique identifier for a particular
|
|
567
364
|
* detail. Pass the `id` of the keywords which you want to retrieve.
|
|
568
365
|
*/
|
|
569
|
-
/** @typedef GetSearchRerankParam */
|
|
570
|
-
/**
|
|
571
|
-
* @typedef GetSearchRerankDetailParam
|
|
572
|
-
* @property {string} id - An `id` is the identifier for a particular search
|
|
573
|
-
* rerank configuration. channel.
|
|
574
|
-
*/
|
|
575
|
-
/**
|
|
576
|
-
* @typedef GetSynonymsParam
|
|
577
|
-
* @property {string} [id] - Mongo id of the particular synonym
|
|
578
|
-
* @property {string} [name] - Synonym name
|
|
579
|
-
* @property {string} [type] - Synonym type - oneway/twoway
|
|
580
|
-
*/
|
|
581
|
-
/**
|
|
582
|
-
* @typedef PollBulkSynonymsParam
|
|
583
|
-
* @property {string} id - Id of the bulk job that needs to be polled.
|
|
584
|
-
*/
|
|
585
|
-
/**
|
|
586
|
-
* @typedef PollPriceFactoryJobsParam
|
|
587
|
-
* @property {string} id - An `id` is a unique identifier for a particular price factory.
|
|
588
|
-
*/
|
|
589
|
-
/**
|
|
590
|
-
* @typedef PollProductPriceFactoryBulkJobParam
|
|
591
|
-
* @property {string} id - An `id` is a unique identifier for a particular price factory.
|
|
592
|
-
* @property {string} jobId - A `job_id` is a unique identifier for a particular bulk job.
|
|
593
|
-
*/
|
|
594
|
-
/**
|
|
595
|
-
* @typedef ProcessBulkSynonymsParam
|
|
596
|
-
* @property {CatalogPlatformModel.SynonymBulkProcessRequestSchema} body
|
|
597
|
-
*/
|
|
598
|
-
/**
|
|
599
|
-
* @typedef ProcessProductPriceFactoryBulkJobParam
|
|
600
|
-
* @property {string} id - An `id` is a unique identifier for a particular price factory.
|
|
601
|
-
* @property {string} jobId - A `job_id` is a unique identifier for a particular bulk job.
|
|
602
|
-
* @property {CatalogPlatformModel.CreateAppPriceFactoryProductBulkJobRequest} body
|
|
603
|
-
*/
|
|
604
|
-
/**
|
|
605
|
-
* @typedef SampleBulkSynonymsFileParam
|
|
606
|
-
* @property {string} type - Type of the file
|
|
607
|
-
*/
|
|
608
|
-
/**
|
|
609
|
-
* @typedef SaveMerchandisingRulesParam
|
|
610
|
-
* @property {string} merchandisingRuleId - A `merchandising_rule_id` is a
|
|
611
|
-
* unique identifier for a particular merchandising rule.
|
|
612
|
-
* @property {CatalogPlatformModel.MerchandisingRuleSave} body
|
|
613
|
-
*/
|
|
614
366
|
/**
|
|
615
367
|
* @typedef UpdateAllowSingleParam
|
|
616
|
-
* @property {CatalogPlatformModel.
|
|
368
|
+
* @property {CatalogPlatformModel.AllowSingleRequestSchema} body
|
|
617
369
|
*/
|
|
618
370
|
/**
|
|
619
371
|
* @typedef UpdateAppBrandParam
|
|
620
|
-
* @property {number} brandUid -
|
|
372
|
+
* @property {number} brandUid - A `brand id` is a unique identifier for a
|
|
373
|
+
* particular brand.
|
|
621
374
|
* @property {CatalogPlatformModel.ApplicationBrandJson} body
|
|
622
375
|
*/
|
|
623
376
|
/**
|
|
624
377
|
* @typedef UpdateAppCategoryParam
|
|
625
|
-
* @property {
|
|
378
|
+
* @property {string} categoryUid - A `category id` is a unique identifier for a
|
|
379
|
+
* particular category.
|
|
626
380
|
* @property {CatalogPlatformModel.ApplicationCategoryJson} body
|
|
627
381
|
*/
|
|
628
382
|
/**
|
|
@@ -631,8 +385,8 @@ export = CatalogPlatformApplicationValidator;
|
|
|
631
385
|
*/
|
|
632
386
|
/**
|
|
633
387
|
* @typedef UpdateAppDepartmentParam
|
|
634
|
-
* @property {number} departmentUid -
|
|
635
|
-
*
|
|
388
|
+
* @property {number} departmentUid - A `department id` is a unique identifier
|
|
389
|
+
* for a particular department.
|
|
636
390
|
* @property {CatalogPlatformModel.ApplicationDepartmentJson} body
|
|
637
391
|
*/
|
|
638
392
|
/**
|
|
@@ -642,7 +396,7 @@ export = CatalogPlatformApplicationValidator;
|
|
|
642
396
|
*/
|
|
643
397
|
/**
|
|
644
398
|
* @typedef UpdateAppProductParam
|
|
645
|
-
* @property {number} itemId -
|
|
399
|
+
* @property {number} itemId - A `item_id` is a unique identifier for a particular item.
|
|
646
400
|
* @property {CatalogPlatformModel.ApplicationItemMeta} body
|
|
647
401
|
*/
|
|
648
402
|
/**
|
|
@@ -655,12 +409,6 @@ export = CatalogPlatformApplicationValidator;
|
|
|
655
409
|
* detail. Pass the `id` of the keywords which you want to delete.
|
|
656
410
|
* @property {CatalogPlatformModel.CreateAutocompleteKeyword} body
|
|
657
411
|
*/
|
|
658
|
-
/**
|
|
659
|
-
* @typedef UpdateAutocompleteSettingsParam
|
|
660
|
-
* @property {string} id - An `id` is a unique identifier for a particular
|
|
661
|
-
* autocomplete settings config.
|
|
662
|
-
* @property {CatalogPlatformModel.AutocompleteRequestSchema} body
|
|
663
|
-
*/
|
|
664
412
|
/**
|
|
665
413
|
* @typedef UpdateCollectionParam
|
|
666
414
|
* @property {string} id - A `id` is a unique identifier of a collection.
|
|
@@ -668,7 +416,7 @@ export = CatalogPlatformApplicationValidator;
|
|
|
668
416
|
*/
|
|
669
417
|
/**
|
|
670
418
|
* @typedef UpdateDefaultSortParam
|
|
671
|
-
* @property {CatalogPlatformModel.
|
|
419
|
+
* @property {CatalogPlatformModel.DefaultKeyRequestSchema} body
|
|
672
420
|
*/
|
|
673
421
|
/**
|
|
674
422
|
* @typedef UpdateGroupConfigurationParam
|
|
@@ -684,41 +432,11 @@ export = CatalogPlatformApplicationValidator;
|
|
|
684
432
|
* particular listing configuration type.
|
|
685
433
|
* @property {string} configId - A `config_id` is a unique identifier of a
|
|
686
434
|
* particular configuration.
|
|
687
|
-
* @property {CatalogPlatformModel.
|
|
688
|
-
*/
|
|
689
|
-
/**
|
|
690
|
-
* @typedef UpdateMerchandisingRuleBoostActionParam
|
|
691
|
-
* @property {string} merchandisingRuleId - A `merchandising_rule_id` is a
|
|
692
|
-
* unique identifier for a particular merchandising rule.
|
|
693
|
-
* @property {CatalogPlatformModel.PostMerchandisingRuleBoostAction} body
|
|
694
|
-
*/
|
|
695
|
-
/**
|
|
696
|
-
* @typedef UpdateMerchandisingRuleBuryActionParam
|
|
697
|
-
* @property {string} merchandisingRuleId - A `merchandising_rule_id` is a
|
|
698
|
-
* unique identifier for a particular merchandising rule.
|
|
699
|
-
* @property {CatalogPlatformModel.PostMerchandisingRuleBoostAction} body
|
|
700
|
-
*/
|
|
701
|
-
/**
|
|
702
|
-
* @typedef UpdateMerchandisingRuleHideActionParam
|
|
703
|
-
* @property {string} merchandisingRuleId - A `merchandising_rule_id` is a
|
|
704
|
-
* unique identifier for a particular merchandising rule.
|
|
705
|
-
* @property {CatalogPlatformModel.HideRequest} body
|
|
706
|
-
*/
|
|
707
|
-
/**
|
|
708
|
-
* @typedef UpdateMerchandisingRulePinActionParam
|
|
709
|
-
* @property {string} merchandisingRuleId - A `merchandising_rule_id` is a
|
|
710
|
-
* unique identifier for a particular merchandising rule.
|
|
711
|
-
* @property {CatalogPlatformModel.PinRequest} body
|
|
712
|
-
*/
|
|
713
|
-
/**
|
|
714
|
-
* @typedef UpdateMerchandisingRuleQueryParam
|
|
715
|
-
* @property {string} merchandisingRuleId - A `merchandising_rule_id` is a
|
|
716
|
-
* unique identifier for a particular merchandising rule.
|
|
717
|
-
* @property {CatalogPlatformModel.MerchandisingRuleQueryPost} body
|
|
435
|
+
* @property {CatalogPlatformModel.AppConfigurationsSort} body
|
|
718
436
|
*/
|
|
719
437
|
/**
|
|
720
438
|
* @typedef UpdateSearchConfigurationParam
|
|
721
|
-
* @property {CatalogPlatformModel.
|
|
439
|
+
* @property {CatalogPlatformModel.UpdateSearchConfigurationRequestSchema} body
|
|
722
440
|
*/
|
|
723
441
|
/**
|
|
724
442
|
* @typedef UpdateSearchKeywordsParam
|
|
@@ -726,47 +444,13 @@ export = CatalogPlatformApplicationValidator;
|
|
|
726
444
|
* detail. Pass the `id` of the keywords which you want to delete.
|
|
727
445
|
* @property {CatalogPlatformModel.CreateSearchKeyword} body
|
|
728
446
|
*/
|
|
729
|
-
/**
|
|
730
|
-
* @typedef UpdateSearchRerankConfigurationParam
|
|
731
|
-
* @property {string} id - An `id` is the identifier for a particular search
|
|
732
|
-
* rerank configuration. channel.
|
|
733
|
-
* @property {CatalogPlatformModel.UpdateSearchRerankRequest} body
|
|
734
|
-
*/
|
|
735
|
-
/**
|
|
736
|
-
* @typedef UpdateSynonymsParam
|
|
737
|
-
* @property {string} id - An `id` is a unique identifier for a particular
|
|
738
|
-
* synonym channel.
|
|
739
|
-
* @property {CatalogPlatformModel.SynonymCreateRequestSchema} body
|
|
740
|
-
*/
|
|
741
|
-
/**
|
|
742
|
-
* @typedef UploadSynonymsParam
|
|
743
|
-
* @property {CatalogPlatformModel.SynonymUploadRequestSchema} body
|
|
744
|
-
*/
|
|
745
|
-
/**
|
|
746
|
-
* @typedef ValidateBulkSynonymsParam
|
|
747
|
-
* @property {CatalogPlatformModel.SynonymBulkValidateRequestSchema} body
|
|
748
|
-
*/
|
|
749
|
-
/**
|
|
750
|
-
* @typedef ValidateProductPriceFactoryBulkJobParam
|
|
751
|
-
* @property {string} id - An `id` is a unique identifier for a particular price factory.
|
|
752
|
-
* @property {string} jobId - A `job_id` is a unique identifier for a particular bulk job.
|
|
753
|
-
* @property {CatalogPlatformModel.CreateAppPriceFactoryProductBulkJobRequest} body
|
|
754
|
-
*/
|
|
755
447
|
declare class CatalogPlatformApplicationValidator {
|
|
756
448
|
/** @returns {AddCollectionItemsParam} */
|
|
757
449
|
static addCollectionItems(): AddCollectionItemsParam;
|
|
758
|
-
/** @returns {AddProductsInPriceFactoryByZoneIdParam} */
|
|
759
|
-
static addProductsInPriceFactoryByZoneId(): AddProductsInPriceFactoryByZoneIdParam;
|
|
760
|
-
/** @returns {ClearCollectionItemsPriorityParam} */
|
|
761
|
-
static clearCollectionItemsPriority(): ClearCollectionItemsPriorityParam;
|
|
762
450
|
/** @returns {CreateAppCategoryReturnConfigurationParam} */
|
|
763
451
|
static createAppCategoryReturnConfiguration(): CreateAppCategoryReturnConfigurationParam;
|
|
764
|
-
/** @returns {CreateAppPriceFactoryParam} */
|
|
765
|
-
static createAppPriceFactory(): CreateAppPriceFactoryParam;
|
|
766
452
|
/** @returns {CreateAppReturnConfigurationParam} */
|
|
767
453
|
static createAppReturnConfiguration(): CreateAppReturnConfigurationParam;
|
|
768
|
-
/** @returns {CreateAutocompleteSettingsParam} */
|
|
769
|
-
static createAutocompleteSettings(): CreateAutocompleteSettingsParam;
|
|
770
454
|
/** @returns {CreateCollectionParam} */
|
|
771
455
|
static createCollection(): CreateCollectionParam;
|
|
772
456
|
/** @returns {CreateConfigurationByTypeParam} */
|
|
@@ -781,24 +465,8 @@ declare class CatalogPlatformApplicationValidator {
|
|
|
781
465
|
static createGroupConfiguration(): CreateGroupConfigurationParam;
|
|
782
466
|
/** @returns {CreateListingConfigurationParam} */
|
|
783
467
|
static createListingConfiguration(): CreateListingConfigurationParam;
|
|
784
|
-
/** @returns {CreateMerchandisingRuleBoostActionParam} */
|
|
785
|
-
static createMerchandisingRuleBoostAction(): CreateMerchandisingRuleBoostActionParam;
|
|
786
|
-
/** @returns {CreateMerchandisingRuleBuryActionParam} */
|
|
787
|
-
static createMerchandisingRuleBuryAction(): CreateMerchandisingRuleBuryActionParam;
|
|
788
|
-
/** @returns {CreateMerchandisingRuleHideActionParam} */
|
|
789
|
-
static createMerchandisingRuleHideAction(): CreateMerchandisingRuleHideActionParam;
|
|
790
|
-
/** @returns {CreateMerchandisingRulePinActionParam} */
|
|
791
|
-
static createMerchandisingRulePinAction(): CreateMerchandisingRulePinActionParam;
|
|
792
|
-
/** @returns {CreateMerchandisingRuleQueryParam} */
|
|
793
|
-
static createMerchandisingRuleQuery(): CreateMerchandisingRuleQueryParam;
|
|
794
|
-
/** @returns {CreateProductPriceFactoryBulkJobParam} */
|
|
795
|
-
static createProductPriceFactoryBulkJob(): CreateProductPriceFactoryBulkJobParam;
|
|
796
468
|
/** @returns {CreateSearchConfigurationParam} */
|
|
797
469
|
static createSearchConfiguration(): CreateSearchConfigurationParam;
|
|
798
|
-
/** @returns {CreateSearchRerankParam} */
|
|
799
|
-
static createSearchRerank(): CreateSearchRerankParam;
|
|
800
|
-
/** @returns {CreateSynonymsParam} */
|
|
801
|
-
static createSynonyms(): CreateSynonymsParam;
|
|
802
470
|
/** @returns {DeleteAppCategoryReturnConfigurationParam} */
|
|
803
471
|
static deleteAppCategoryReturnConfiguration(): DeleteAppCategoryReturnConfigurationParam;
|
|
804
472
|
/** @returns {DeleteAutocompleteKeywordParam} */
|
|
@@ -809,50 +477,26 @@ declare class CatalogPlatformApplicationValidator {
|
|
|
809
477
|
static deleteGroupConfiguration(): DeleteGroupConfigurationParam;
|
|
810
478
|
/** @returns {DeleteListingConfigurationParam} */
|
|
811
479
|
static deleteListingConfiguration(): DeleteListingConfigurationParam;
|
|
812
|
-
/** @returns {DeleteMerchandisingRuleParam} */
|
|
813
|
-
static deleteMerchandisingRule(): DeleteMerchandisingRuleParam;
|
|
814
|
-
/** @returns {DeleteMerchandisingRulesPreviewParam} */
|
|
815
|
-
static deleteMerchandisingRulesPreview(): DeleteMerchandisingRulesPreviewParam;
|
|
816
480
|
/** @returns {DeleteSearchConfigurationParam} */
|
|
817
481
|
static deleteSearchConfiguration(): any;
|
|
818
482
|
/** @returns {DeleteSearchKeywordsParam} */
|
|
819
483
|
static deleteSearchKeywords(): DeleteSearchKeywordsParam;
|
|
820
|
-
/** @returns {DeleteSearchRerankConfigurationParam} */
|
|
821
|
-
static deleteSearchRerankConfiguration(): DeleteSearchRerankConfigurationParam;
|
|
822
|
-
/** @returns {DeleteSynonymParam} */
|
|
823
|
-
static deleteSynonym(): DeleteSynonymParam;
|
|
824
|
-
/** @returns {EditAppPriceFactoryParam} */
|
|
825
|
-
static editAppPriceFactory(): EditAppPriceFactoryParam;
|
|
826
|
-
/** @returns {ExportProductsInPriceFactoryParam} */
|
|
827
|
-
static exportProductsInPriceFactory(): ExportProductsInPriceFactoryParam;
|
|
828
|
-
/** @returns {ExportSynonymsParam} */
|
|
829
|
-
static exportSynonyms(): any;
|
|
830
484
|
/** @returns {GetAllCollectionsParam} */
|
|
831
485
|
static getAllCollections(): GetAllCollectionsParam;
|
|
832
486
|
/** @returns {GetAllSearchKeywordParam} */
|
|
833
|
-
static getAllSearchKeyword():
|
|
487
|
+
static getAllSearchKeyword(): any;
|
|
834
488
|
/** @returns {GetAppCategoryReturnConfigParam} */
|
|
835
489
|
static getAppCategoryReturnConfig(): GetAppCategoryReturnConfigParam;
|
|
836
490
|
/** @returns {GetAppInventoryParam} */
|
|
837
491
|
static getAppInventory(): GetAppInventoryParam;
|
|
838
492
|
/** @returns {GetAppLocationsParam} */
|
|
839
493
|
static getAppLocations(): GetAppLocationsParam;
|
|
840
|
-
/** @returns {GetAppPriceByIdParam} */
|
|
841
|
-
static getAppPriceById(): GetAppPriceByIdParam;
|
|
842
|
-
/** @returns {GetAppPriceFactoriesParam} */
|
|
843
|
-
static getAppPriceFactories(): GetAppPriceFactoriesParam;
|
|
844
|
-
/** @returns {GetAppPriceFactoryParam} */
|
|
845
|
-
static getAppPriceFactory(): GetAppPriceFactoryParam;
|
|
846
494
|
/** @returns {GetAppProductParam} */
|
|
847
495
|
static getAppProduct(): GetAppProductParam;
|
|
848
|
-
/** @returns {GetAppProductPricesParam} */
|
|
849
|
-
static getAppProductPrices(): GetAppProductPricesParam;
|
|
850
496
|
/** @returns {GetAppProductsParam} */
|
|
851
497
|
static getAppProducts(): GetAppProductsParam;
|
|
852
498
|
/** @returns {GetAppReturnConfigurationParam} */
|
|
853
499
|
static getAppReturnConfiguration(): any;
|
|
854
|
-
/** @returns {GetAppicationProductsParam} */
|
|
855
|
-
static getAppicationProducts(): GetAppicationProductsParam;
|
|
856
500
|
/** @returns {GetApplicationBrandListingParam} */
|
|
857
501
|
static getApplicationBrandListing(): GetApplicationBrandListingParam;
|
|
858
502
|
/** @returns {GetApplicationBrandsParam} */
|
|
@@ -865,14 +509,12 @@ declare class CatalogPlatformApplicationValidator {
|
|
|
865
509
|
static getApplicationFilterKeys(): GetApplicationFilterKeysParam;
|
|
866
510
|
/** @returns {GetApplicationFilterValuesParam} */
|
|
867
511
|
static getApplicationFilterValues(): GetApplicationFilterValuesParam;
|
|
512
|
+
/** @returns {GetApplicationProductsParam} */
|
|
513
|
+
static getApplicationProducts(): GetApplicationProductsParam;
|
|
868
514
|
/** @returns {GetAutocompleteConfigParam} */
|
|
869
|
-
static getAutocompleteConfig():
|
|
515
|
+
static getAutocompleteConfig(): any;
|
|
870
516
|
/** @returns {GetAutocompleteKeywordDetailParam} */
|
|
871
517
|
static getAutocompleteKeywordDetail(): GetAutocompleteKeywordDetailParam;
|
|
872
|
-
/** @returns {GetAutocompletePreviewParam} */
|
|
873
|
-
static getAutocompletePreview(): GetAutocompletePreviewParam;
|
|
874
|
-
/** @returns {GetAutocompleteSettingsParam} */
|
|
875
|
-
static getAutocompleteSettings(): any;
|
|
876
518
|
/** @returns {GetCatalogConfigurationParam} */
|
|
877
519
|
static getCatalogConfiguration(): any;
|
|
878
520
|
/** @returns {GetCatalogInsightsParam} */
|
|
@@ -889,8 +531,6 @@ declare class CatalogPlatformApplicationValidator {
|
|
|
889
531
|
static getConfigurationMetadata(): GetConfigurationMetadataParam;
|
|
890
532
|
/** @returns {GetConfigurationsParam} */
|
|
891
533
|
static getConfigurations(): any;
|
|
892
|
-
/** @returns {GetConfigurationsFilterMetadataParam} */
|
|
893
|
-
static getConfigurationsFilterMetadata(): GetConfigurationsFilterMetadataParam;
|
|
894
534
|
/** @returns {GetDepartmentsParam} */
|
|
895
535
|
static getDepartments(): any;
|
|
896
536
|
/** @returns {GetDiscountedInventoryBySizeIdentifierParam} */
|
|
@@ -899,50 +539,14 @@ declare class CatalogPlatformApplicationValidator {
|
|
|
899
539
|
static getGroupConfigurations(): GetGroupConfigurationsParam;
|
|
900
540
|
/** @returns {GetListingConfigurationsParam} */
|
|
901
541
|
static getListingConfigurations(): GetListingConfigurationsParam;
|
|
902
|
-
/** @returns {GetLivePreviewParam} */
|
|
903
|
-
static getLivePreview(): GetLivePreviewParam;
|
|
904
|
-
/** @returns {GetMerchandisingQueryParam} */
|
|
905
|
-
static getMerchandisingQuery(): GetMerchandisingQueryParam;
|
|
906
|
-
/** @returns {GetMerchandisingRuleBoostActionParam} */
|
|
907
|
-
static getMerchandisingRuleBoostAction(): GetMerchandisingRuleBoostActionParam;
|
|
908
|
-
/** @returns {GetMerchandisingRuleBuryActionParam} */
|
|
909
|
-
static getMerchandisingRuleBuryAction(): GetMerchandisingRuleBuryActionParam;
|
|
910
|
-
/** @returns {GetMerchandisingRuleHideActionParam} */
|
|
911
|
-
static getMerchandisingRuleHideAction(): GetMerchandisingRuleHideActionParam;
|
|
912
|
-
/** @returns {GetMerchandisingRulePinActionParam} */
|
|
913
|
-
static getMerchandisingRulePinAction(): GetMerchandisingRulePinActionParam;
|
|
914
|
-
/** @returns {GetMerchandisingRulesParam} */
|
|
915
|
-
static getMerchandisingRules(): GetMerchandisingRulesParam;
|
|
916
542
|
/** @returns {GetProductDetailBySlugParam} */
|
|
917
543
|
static getProductDetailBySlug(): GetProductDetailBySlugParam;
|
|
918
|
-
/** @returns {GetProductsInPriceFactoryByZoneIdParam} */
|
|
919
|
-
static getProductsInPriceFactoryByZoneId(): GetProductsInPriceFactoryByZoneIdParam;
|
|
920
544
|
/** @returns {GetQueryFiltersParam} */
|
|
921
545
|
static getQueryFilters(): any;
|
|
922
546
|
/** @returns {GetSearchConfigurationParam} */
|
|
923
547
|
static getSearchConfiguration(): any;
|
|
924
548
|
/** @returns {GetSearchKeywordsParam} */
|
|
925
549
|
static getSearchKeywords(): GetSearchKeywordsParam;
|
|
926
|
-
/** @returns {GetSearchRerankParam} */
|
|
927
|
-
static getSearchRerank(): any;
|
|
928
|
-
/** @returns {GetSearchRerankDetailParam} */
|
|
929
|
-
static getSearchRerankDetail(): GetSearchRerankDetailParam;
|
|
930
|
-
/** @returns {GetSynonymsParam} */
|
|
931
|
-
static getSynonyms(): GetSynonymsParam;
|
|
932
|
-
/** @returns {PollBulkSynonymsParam} */
|
|
933
|
-
static pollBulkSynonyms(): PollBulkSynonymsParam;
|
|
934
|
-
/** @returns {PollPriceFactoryJobsParam} */
|
|
935
|
-
static pollPriceFactoryJobs(): PollPriceFactoryJobsParam;
|
|
936
|
-
/** @returns {PollProductPriceFactoryBulkJobParam} */
|
|
937
|
-
static pollProductPriceFactoryBulkJob(): PollProductPriceFactoryBulkJobParam;
|
|
938
|
-
/** @returns {ProcessBulkSynonymsParam} */
|
|
939
|
-
static processBulkSynonyms(): ProcessBulkSynonymsParam;
|
|
940
|
-
/** @returns {ProcessProductPriceFactoryBulkJobParam} */
|
|
941
|
-
static processProductPriceFactoryBulkJob(): ProcessProductPriceFactoryBulkJobParam;
|
|
942
|
-
/** @returns {SampleBulkSynonymsFileParam} */
|
|
943
|
-
static sampleBulkSynonymsFile(): SampleBulkSynonymsFileParam;
|
|
944
|
-
/** @returns {SaveMerchandisingRulesParam} */
|
|
945
|
-
static saveMerchandisingRules(): SaveMerchandisingRulesParam;
|
|
946
550
|
/** @returns {UpdateAllowSingleParam} */
|
|
947
551
|
static updateAllowSingle(): UpdateAllowSingleParam;
|
|
948
552
|
/** @returns {UpdateAppBrandParam} */
|
|
@@ -961,8 +565,6 @@ declare class CatalogPlatformApplicationValidator {
|
|
|
961
565
|
static updateAppReturnConfiguration(): UpdateAppReturnConfigurationParam;
|
|
962
566
|
/** @returns {UpdateAutocompleteKeywordParam} */
|
|
963
567
|
static updateAutocompleteKeyword(): UpdateAutocompleteKeywordParam;
|
|
964
|
-
/** @returns {UpdateAutocompleteSettingsParam} */
|
|
965
|
-
static updateAutocompleteSettings(): UpdateAutocompleteSettingsParam;
|
|
966
568
|
/** @returns {UpdateCollectionParam} */
|
|
967
569
|
static updateCollection(): UpdateCollectionParam;
|
|
968
570
|
/** @returns {UpdateDefaultSortParam} */
|
|
@@ -971,33 +573,13 @@ declare class CatalogPlatformApplicationValidator {
|
|
|
971
573
|
static updateGroupConfiguration(): UpdateGroupConfigurationParam;
|
|
972
574
|
/** @returns {UpdateListingConfigurationParam} */
|
|
973
575
|
static updateListingConfiguration(): UpdateListingConfigurationParam;
|
|
974
|
-
/** @returns {UpdateMerchandisingRuleBoostActionParam} */
|
|
975
|
-
static updateMerchandisingRuleBoostAction(): UpdateMerchandisingRuleBoostActionParam;
|
|
976
|
-
/** @returns {UpdateMerchandisingRuleBuryActionParam} */
|
|
977
|
-
static updateMerchandisingRuleBuryAction(): UpdateMerchandisingRuleBuryActionParam;
|
|
978
|
-
/** @returns {UpdateMerchandisingRuleHideActionParam} */
|
|
979
|
-
static updateMerchandisingRuleHideAction(): UpdateMerchandisingRuleHideActionParam;
|
|
980
|
-
/** @returns {UpdateMerchandisingRulePinActionParam} */
|
|
981
|
-
static updateMerchandisingRulePinAction(): UpdateMerchandisingRulePinActionParam;
|
|
982
|
-
/** @returns {UpdateMerchandisingRuleQueryParam} */
|
|
983
|
-
static updateMerchandisingRuleQuery(): UpdateMerchandisingRuleQueryParam;
|
|
984
576
|
/** @returns {UpdateSearchConfigurationParam} */
|
|
985
577
|
static updateSearchConfiguration(): UpdateSearchConfigurationParam;
|
|
986
578
|
/** @returns {UpdateSearchKeywordsParam} */
|
|
987
579
|
static updateSearchKeywords(): UpdateSearchKeywordsParam;
|
|
988
|
-
/** @returns {UpdateSearchRerankConfigurationParam} */
|
|
989
|
-
static updateSearchRerankConfiguration(): UpdateSearchRerankConfigurationParam;
|
|
990
|
-
/** @returns {UpdateSynonymsParam} */
|
|
991
|
-
static updateSynonyms(): UpdateSynonymsParam;
|
|
992
|
-
/** @returns {UploadSynonymsParam} */
|
|
993
|
-
static uploadSynonyms(): UploadSynonymsParam;
|
|
994
|
-
/** @returns {ValidateBulkSynonymsParam} */
|
|
995
|
-
static validateBulkSynonyms(): ValidateBulkSynonymsParam;
|
|
996
|
-
/** @returns {ValidateProductPriceFactoryBulkJobParam} */
|
|
997
|
-
static validateProductPriceFactoryBulkJob(): ValidateProductPriceFactoryBulkJobParam;
|
|
998
580
|
}
|
|
999
581
|
declare namespace CatalogPlatformApplicationValidator {
|
|
1000
|
-
export { AddCollectionItemsParam,
|
|
582
|
+
export { AddCollectionItemsParam, CreateAppCategoryReturnConfigurationParam, CreateAppReturnConfigurationParam, CreateCollectionParam, CreateConfigurationByTypeParam, CreateConfigurationProductListingParam, CreateCustomAutocompleteRuleParam, CreateCustomKeywordParam, CreateGroupConfigurationParam, CreateListingConfigurationParam, CreateSearchConfigurationParam, DeleteAppCategoryReturnConfigurationParam, DeleteAutocompleteKeywordParam, DeleteCollectionParam, DeleteGroupConfigurationParam, DeleteListingConfigurationParam, DeleteSearchConfigurationParam, DeleteSearchKeywordsParam, GetAllCollectionsParam, GetAllSearchKeywordParam, GetAppCategoryReturnConfigParam, GetAppInventoryParam, GetAppLocationsParam, GetAppProductParam, GetAppProductsParam, GetAppReturnConfigurationParam, GetApplicationBrandListingParam, GetApplicationBrandsParam, GetApplicationCategoryListingParam, GetApplicationDepartmentListingParam, GetApplicationFilterKeysParam, GetApplicationFilterValuesParam, GetApplicationProductsParam, GetAutocompleteConfigParam, GetAutocompleteKeywordDetailParam, GetCatalogConfigurationParam, GetCatalogInsightsParam, GetCategoriesParam, GetCollectionDetailParam, GetCollectionItemsParam, GetConfigurationByTypeParam, GetConfigurationMetadataParam, GetConfigurationsParam, GetDepartmentsParam, GetDiscountedInventoryBySizeIdentifierParam, GetGroupConfigurationsParam, GetListingConfigurationsParam, GetProductDetailBySlugParam, GetQueryFiltersParam, GetSearchConfigurationParam, GetSearchKeywordsParam, UpdateAllowSingleParam, UpdateAppBrandParam, UpdateAppCategoryParam, UpdateAppCategoryReturnConfigurationParam, UpdateAppDepartmentParam, UpdateAppLocationParam, UpdateAppProductParam, UpdateAppReturnConfigurationParam, UpdateAutocompleteKeywordParam, UpdateCollectionParam, UpdateDefaultSortParam, UpdateGroupConfigurationParam, UpdateListingConfigurationParam, UpdateSearchConfigurationParam, UpdateSearchKeywordsParam };
|
|
1001
583
|
}
|
|
1002
584
|
type AddCollectionItemsParam = {
|
|
1003
585
|
/**
|
|
@@ -1006,32 +588,44 @@ type AddCollectionItemsParam = {
|
|
|
1006
588
|
id: string;
|
|
1007
589
|
body: CatalogPlatformModel.CollectionItemUpdateSchema;
|
|
1008
590
|
};
|
|
1009
|
-
type AddProductsInPriceFactoryByZoneIdParam = {
|
|
1010
|
-
/**
|
|
1011
|
-
* - An `id` is a unique identifier for a particular price factory.
|
|
1012
|
-
*/
|
|
1013
|
-
id: string;
|
|
1014
|
-
body: CatalogPlatformModel.CreatePriceFactoryProductRequest;
|
|
1015
|
-
};
|
|
1016
|
-
type ClearCollectionItemsPriorityParam = {
|
|
1017
|
-
/**
|
|
1018
|
-
* - A `id` is a unique identifier of a collection.
|
|
1019
|
-
*/
|
|
1020
|
-
id: string;
|
|
1021
|
-
};
|
|
1022
591
|
type CreateAppCategoryReturnConfigurationParam = {
|
|
1023
592
|
body: CatalogPlatformModel.BaseAppCategoryReturnConfig;
|
|
1024
593
|
};
|
|
1025
|
-
type CreateAppPriceFactoryParam = {
|
|
1026
|
-
body: CatalogPlatformModel.CreateAppPriceFactoryRequestSchema;
|
|
1027
|
-
};
|
|
1028
594
|
type CreateAppReturnConfigurationParam = {
|
|
1029
595
|
body: CatalogPlatformModel.CreateUpdateAppReturnConfig;
|
|
1030
596
|
};
|
|
1031
|
-
type CreateAutocompleteSettingsParam = {
|
|
1032
|
-
body: CatalogPlatformModel.AutocompleteRequestSchema;
|
|
1033
|
-
};
|
|
1034
597
|
type CreateCollectionParam = {
|
|
598
|
+
/**
|
|
599
|
+
* - Get collection list filtered by q string,
|
|
600
|
+
*/
|
|
601
|
+
q?: string;
|
|
602
|
+
/**
|
|
603
|
+
* - Get collection list filtered by scheduled status,
|
|
604
|
+
*/
|
|
605
|
+
scheduleStatus?: string;
|
|
606
|
+
/**
|
|
607
|
+
* - Type of the collections
|
|
608
|
+
*/
|
|
609
|
+
type?: string;
|
|
610
|
+
/**
|
|
611
|
+
* - Each response will contain next_id param, which
|
|
612
|
+
* should be sent back to make pagination work.
|
|
613
|
+
*/
|
|
614
|
+
tags?: string[];
|
|
615
|
+
/**
|
|
616
|
+
* - Get collections filtered by active status.
|
|
617
|
+
*/
|
|
618
|
+
isActive?: boolean;
|
|
619
|
+
/**
|
|
620
|
+
* - The page number to navigate through the given
|
|
621
|
+
* set of results.
|
|
622
|
+
*/
|
|
623
|
+
pageNo?: number;
|
|
624
|
+
/**
|
|
625
|
+
* - Number of items to retrieve in each page.
|
|
626
|
+
* Default is 12.
|
|
627
|
+
*/
|
|
628
|
+
pageSize?: number;
|
|
1035
629
|
body: CatalogPlatformModel.CreateCollection;
|
|
1036
630
|
};
|
|
1037
631
|
type CreateConfigurationByTypeParam = {
|
|
@@ -1056,7 +650,7 @@ type CreateGroupConfigurationParam = {
|
|
|
1056
650
|
* particular group configuration type.
|
|
1057
651
|
*/
|
|
1058
652
|
configType: string;
|
|
1059
|
-
body: CatalogPlatformModel.
|
|
653
|
+
body: CatalogPlatformModel.AppConfigurationDetail;
|
|
1060
654
|
};
|
|
1061
655
|
type CreateListingConfigurationParam = {
|
|
1062
656
|
/**
|
|
@@ -1064,68 +658,20 @@ type CreateListingConfigurationParam = {
|
|
|
1064
658
|
* particular listing configuration type.
|
|
1065
659
|
*/
|
|
1066
660
|
configType: string;
|
|
1067
|
-
body: CatalogPlatformModel.
|
|
661
|
+
body: CatalogPlatformModel.AppConfigurationsSort;
|
|
1068
662
|
};
|
|
1069
|
-
type
|
|
1070
|
-
|
|
1071
|
-
* - A `merchandising_rule_id` is a
|
|
1072
|
-
* unique identifier for a particular merchandising rule.
|
|
1073
|
-
*/
|
|
1074
|
-
merchandisingRuleId: string;
|
|
1075
|
-
body: CatalogPlatformModel.PostMerchandisingRuleBoostAction;
|
|
663
|
+
type CreateSearchConfigurationParam = {
|
|
664
|
+
body: CatalogPlatformModel.CreateSearchConfigurationRequestSchema;
|
|
1076
665
|
};
|
|
1077
|
-
type
|
|
1078
|
-
|
|
1079
|
-
* - A `merchandising_rule_id` is a
|
|
1080
|
-
* unique identifier for a particular merchandising rule.
|
|
1081
|
-
*/
|
|
1082
|
-
merchandisingRuleId: string;
|
|
1083
|
-
body: CatalogPlatformModel.PostMerchandisingRuleBoostAction;
|
|
666
|
+
type DeleteAppCategoryReturnConfigurationParam = {
|
|
667
|
+
body: CatalogPlatformModel.DeleteAppCategoryReturnConfig;
|
|
1084
668
|
};
|
|
1085
|
-
type
|
|
669
|
+
type DeleteAutocompleteKeywordParam = {
|
|
1086
670
|
/**
|
|
1087
|
-
* - A `
|
|
1088
|
-
*
|
|
671
|
+
* - A `id` is a unique identifier for a particular
|
|
672
|
+
* detail. Pass the `id` of the keywords which you want to delete.
|
|
1089
673
|
*/
|
|
1090
|
-
|
|
1091
|
-
body: CatalogPlatformModel.HideRequest;
|
|
1092
|
-
};
|
|
1093
|
-
type CreateMerchandisingRulePinActionParam = {
|
|
1094
|
-
/**
|
|
1095
|
-
* - A `merchandising_rule_id` is a
|
|
1096
|
-
* unique identifier for a particular merchandising rule.
|
|
1097
|
-
*/
|
|
1098
|
-
merchandisingRuleId: string;
|
|
1099
|
-
body: CatalogPlatformModel.PinRequest;
|
|
1100
|
-
};
|
|
1101
|
-
type CreateMerchandisingRuleQueryParam = {
|
|
1102
|
-
body: CatalogPlatformModel.MerchandisingRuleQueryPost;
|
|
1103
|
-
};
|
|
1104
|
-
type CreateProductPriceFactoryBulkJobParam = {
|
|
1105
|
-
/**
|
|
1106
|
-
* - An `id` is a unique identifier for a particular price factory.
|
|
1107
|
-
*/
|
|
1108
|
-
id: string;
|
|
1109
|
-
body: CatalogPlatformModel.CreateAppPriceFactoryProductBulkJobRequest;
|
|
1110
|
-
};
|
|
1111
|
-
type CreateSearchConfigurationParam = {
|
|
1112
|
-
body: CatalogPlatformModel.CreateSearchConfigurationRequest;
|
|
1113
|
-
};
|
|
1114
|
-
type CreateSearchRerankParam = {
|
|
1115
|
-
body: CatalogPlatformModel.CreateSearchRerankRequest;
|
|
1116
|
-
};
|
|
1117
|
-
type CreateSynonymsParam = {
|
|
1118
|
-
body: CatalogPlatformModel.SynonymCreateRequestSchema;
|
|
1119
|
-
};
|
|
1120
|
-
type DeleteAppCategoryReturnConfigurationParam = {
|
|
1121
|
-
body: CatalogPlatformModel.DeleteAppCategoryReturnConfig;
|
|
1122
|
-
};
|
|
1123
|
-
type DeleteAutocompleteKeywordParam = {
|
|
1124
|
-
/**
|
|
1125
|
-
* - A `id` is a unique identifier for a particular
|
|
1126
|
-
* detail. Pass the `id` of the keywords which you want to delete.
|
|
1127
|
-
*/
|
|
1128
|
-
id: string;
|
|
674
|
+
id: string;
|
|
1129
675
|
};
|
|
1130
676
|
type DeleteCollectionParam = {
|
|
1131
677
|
/**
|
|
@@ -1157,20 +703,6 @@ type DeleteListingConfigurationParam = {
|
|
|
1157
703
|
*/
|
|
1158
704
|
configId: string;
|
|
1159
705
|
};
|
|
1160
|
-
type DeleteMerchandisingRuleParam = {
|
|
1161
|
-
/**
|
|
1162
|
-
* - A `merchandising_rule_id` is a
|
|
1163
|
-
* unique identifier for a particular merchandising rule.
|
|
1164
|
-
*/
|
|
1165
|
-
merchandisingRuleId: string;
|
|
1166
|
-
};
|
|
1167
|
-
type DeleteMerchandisingRulesPreviewParam = {
|
|
1168
|
-
/**
|
|
1169
|
-
* - A `merchandising_rule_id` is a
|
|
1170
|
-
* unique identifier for a particular merchandising rule.
|
|
1171
|
-
*/
|
|
1172
|
-
merchandisingRuleId: string;
|
|
1173
|
-
};
|
|
1174
706
|
type DeleteSearchKeywordsParam = {
|
|
1175
707
|
/**
|
|
1176
708
|
* - A `id` is a unique identifier for a particular
|
|
@@ -1178,34 +710,6 @@ type DeleteSearchKeywordsParam = {
|
|
|
1178
710
|
*/
|
|
1179
711
|
id: string;
|
|
1180
712
|
};
|
|
1181
|
-
type DeleteSearchRerankConfigurationParam = {
|
|
1182
|
-
/**
|
|
1183
|
-
* - An `id` is the identifier for a particular search
|
|
1184
|
-
* rerank configuration. channel.
|
|
1185
|
-
*/
|
|
1186
|
-
id: string;
|
|
1187
|
-
};
|
|
1188
|
-
type DeleteSynonymParam = {
|
|
1189
|
-
/**
|
|
1190
|
-
* - A `id` is a unique identifier of a synonym that is to
|
|
1191
|
-
* be deleted.
|
|
1192
|
-
*/
|
|
1193
|
-
id: string;
|
|
1194
|
-
};
|
|
1195
|
-
type EditAppPriceFactoryParam = {
|
|
1196
|
-
/**
|
|
1197
|
-
* - An `id` is a unique identifier for a particular price factory.
|
|
1198
|
-
*/
|
|
1199
|
-
id: string;
|
|
1200
|
-
body: CatalogPlatformModel.EditAppPriceFactoryRequestSchema;
|
|
1201
|
-
};
|
|
1202
|
-
type ExportProductsInPriceFactoryParam = {
|
|
1203
|
-
/**
|
|
1204
|
-
* - An `id` is a unique identifier for a particular price factory.
|
|
1205
|
-
*/
|
|
1206
|
-
id: string;
|
|
1207
|
-
body: CatalogPlatformModel.CreateAppPriceFactoryProductExportJobRequest;
|
|
1208
|
-
};
|
|
1209
713
|
type GetAllCollectionsParam = {
|
|
1210
714
|
/**
|
|
1211
715
|
* - Get collection list filtered by q string,
|
|
@@ -1223,7 +727,7 @@ type GetAllCollectionsParam = {
|
|
|
1223
727
|
* - Each response will contain next_id param, which
|
|
1224
728
|
* should be sent back to make pagination work.
|
|
1225
729
|
*/
|
|
1226
|
-
|
|
730
|
+
tags?: string[];
|
|
1227
731
|
/**
|
|
1228
732
|
* - Get collections filtered by active status.
|
|
1229
733
|
*/
|
|
@@ -1239,28 +743,6 @@ type GetAllCollectionsParam = {
|
|
|
1239
743
|
*/
|
|
1240
744
|
pageSize?: number;
|
|
1241
745
|
};
|
|
1242
|
-
type GetAllSearchKeywordParam = {
|
|
1243
|
-
/**
|
|
1244
|
-
* - The page number to navigate through the given
|
|
1245
|
-
* set of results
|
|
1246
|
-
*/
|
|
1247
|
-
pageNo?: number;
|
|
1248
|
-
/**
|
|
1249
|
-
* - Number of items to retrieve in each page.
|
|
1250
|
-
* Default is 12.
|
|
1251
|
-
*/
|
|
1252
|
-
pageSize?: number;
|
|
1253
|
-
/**
|
|
1254
|
-
* - Search query with words name.Use this parameter to
|
|
1255
|
-
* search keywords by words.
|
|
1256
|
-
*/
|
|
1257
|
-
q?: string;
|
|
1258
|
-
/**
|
|
1259
|
-
* - Can query for keywords based on whether they
|
|
1260
|
-
* are active or inactive.
|
|
1261
|
-
*/
|
|
1262
|
-
isActive?: boolean;
|
|
1263
|
-
};
|
|
1264
746
|
type GetAppCategoryReturnConfigParam = {
|
|
1265
747
|
/**
|
|
1266
748
|
* - Get return configurations for categories by matching
|
|
@@ -1371,92 +853,12 @@ type GetAppLocationsParam = {
|
|
|
1371
853
|
* - Get locations filtered by store types.
|
|
1372
854
|
*/
|
|
1373
855
|
storeTypes?: string[];
|
|
1374
|
-
/**
|
|
1375
|
-
* - Filter stores by company IDs available
|
|
1376
|
-
* in the application.
|
|
1377
|
-
*/
|
|
1378
|
-
companyUids?: number[];
|
|
1379
|
-
};
|
|
1380
|
-
type GetAppPriceByIdParam = {
|
|
1381
|
-
/**
|
|
1382
|
-
* - Unique identifier of the product
|
|
1383
|
-
*/
|
|
1384
|
-
itemId: number;
|
|
1385
|
-
/**
|
|
1386
|
-
* - An array of unique identifiers representing
|
|
1387
|
-
* the store locations from which the product pricing should be fetched. If
|
|
1388
|
-
* not provided, pricing for all applicable store locations will be returned.
|
|
1389
|
-
*/
|
|
1390
|
-
storeIds?: number[];
|
|
1391
|
-
/**
|
|
1392
|
-
* - An array of unique factory type
|
|
1393
|
-
* identifiers that specify that pricing from which factory type should be
|
|
1394
|
-
* retrieved. This parameter allows filtering the price based on factory types.
|
|
1395
|
-
*/
|
|
1396
|
-
factoryTypeIds?: string[];
|
|
1397
|
-
/**
|
|
1398
|
-
* - The company uid for which we want to fetch
|
|
1399
|
-
* discounted pricing for a product
|
|
1400
|
-
*/
|
|
1401
|
-
sellerId?: number;
|
|
1402
|
-
};
|
|
1403
|
-
type GetAppPriceFactoriesParam = {
|
|
1404
|
-
/**
|
|
1405
|
-
* - Gets price factory filtered by active status.
|
|
1406
|
-
*/
|
|
1407
|
-
isActive?: boolean;
|
|
1408
|
-
/**
|
|
1409
|
-
* - Gets price factory filtered by factory_type_id.
|
|
1410
|
-
*/
|
|
1411
|
-
factoryTypeId?: string;
|
|
1412
|
-
/**
|
|
1413
|
-
* - Gets price factory filtered by pricezone code.
|
|
1414
|
-
*/
|
|
1415
|
-
code?: string;
|
|
1416
|
-
/**
|
|
1417
|
-
* - The page number to navigate through the given
|
|
1418
|
-
* set of results.
|
|
1419
|
-
*/
|
|
1420
|
-
pageNo?: number;
|
|
1421
|
-
/**
|
|
1422
|
-
* - Number of items to retrieve in each page.
|
|
1423
|
-
* Default is 12.
|
|
1424
|
-
*/
|
|
1425
|
-
pageSize?: number;
|
|
1426
|
-
};
|
|
1427
|
-
type GetAppPriceFactoryParam = {
|
|
1428
|
-
/**
|
|
1429
|
-
* - An `id` is a unique identifier for a particular price factory.
|
|
1430
|
-
*/
|
|
1431
|
-
id: string;
|
|
1432
856
|
};
|
|
1433
857
|
type GetAppProductParam = {
|
|
1434
858
|
/**
|
|
1435
859
|
* - Product id for a particular product.
|
|
1436
860
|
*/
|
|
1437
|
-
itemId:
|
|
1438
|
-
};
|
|
1439
|
-
type GetAppProductPricesParam = {
|
|
1440
|
-
/**
|
|
1441
|
-
* - List of item ids to get product prices
|
|
1442
|
-
* filtered by items.
|
|
1443
|
-
*/
|
|
1444
|
-
itemIds?: number[];
|
|
1445
|
-
/**
|
|
1446
|
-
* - List of factory type ids to get
|
|
1447
|
-
* product prices filtered by factory type id.
|
|
1448
|
-
*/
|
|
1449
|
-
factoryTypeIds?: string[];
|
|
1450
|
-
/**
|
|
1451
|
-
* - The page number to navigate through the given
|
|
1452
|
-
* set of results
|
|
1453
|
-
*/
|
|
1454
|
-
pageNo?: number;
|
|
1455
|
-
/**
|
|
1456
|
-
* - Number of items to retrieve in each page.
|
|
1457
|
-
* Default is 10.
|
|
1458
|
-
*/
|
|
1459
|
-
pageSize?: number;
|
|
861
|
+
itemId: string;
|
|
1460
862
|
};
|
|
1461
863
|
type GetAppProductsParam = {
|
|
1462
864
|
/**
|
|
@@ -1494,66 +896,6 @@ type GetAppProductsParam = {
|
|
|
1494
896
|
*/
|
|
1495
897
|
q?: string;
|
|
1496
898
|
};
|
|
1497
|
-
type GetAppicationProductsParam = {
|
|
1498
|
-
/**
|
|
1499
|
-
* - The search query. This can be a partial or complete
|
|
1500
|
-
* name of a either a product, brand or category
|
|
1501
|
-
*/
|
|
1502
|
-
q?: string;
|
|
1503
|
-
/**
|
|
1504
|
-
* - The search filter parameters. All the parameter
|
|
1505
|
-
* filtered from filter parameters will be passed in **f** parameter in this
|
|
1506
|
-
* format. **?f=brand:voi-jeans||and:::category:t-shirts||shirts**
|
|
1507
|
-
*/
|
|
1508
|
-
f?: string;
|
|
1509
|
-
/**
|
|
1510
|
-
* - The search filter parameters for collection items.
|
|
1511
|
-
* All the parameter filtered from filter parameters will be passed in **c**
|
|
1512
|
-
* parameter in this format.
|
|
1513
|
-
* **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
|
|
1514
|
-
*/
|
|
1515
|
-
c?: string;
|
|
1516
|
-
/**
|
|
1517
|
-
* - Pass `filters` parameter to fetch the filter
|
|
1518
|
-
* details. This flag is used to fetch all filters
|
|
1519
|
-
*/
|
|
1520
|
-
filters?: boolean;
|
|
1521
|
-
/**
|
|
1522
|
-
* - This query parameter is used to get the
|
|
1523
|
-
* dependent products in the listing.
|
|
1524
|
-
*/
|
|
1525
|
-
isDependent?: boolean;
|
|
1526
|
-
/**
|
|
1527
|
-
* - The order to sort the list of products on. The
|
|
1528
|
-
* supported sort parameters are popularity, price, redemption and discount in
|
|
1529
|
-
* either ascending or descending order. See the supported values below.
|
|
1530
|
-
*/
|
|
1531
|
-
sortOn?: string;
|
|
1532
|
-
/**
|
|
1533
|
-
* - Each response will contain **page_id** param,
|
|
1534
|
-
* which should be sent back to make pagination work.
|
|
1535
|
-
*/
|
|
1536
|
-
pageId?: string;
|
|
1537
|
-
/**
|
|
1538
|
-
* - Number of items to retrieve in each page.
|
|
1539
|
-
* Default is 12.
|
|
1540
|
-
*/
|
|
1541
|
-
pageSize?: number;
|
|
1542
|
-
/**
|
|
1543
|
-
* - If page_type is number then pass it to fetch
|
|
1544
|
-
* page items. Default is 1.
|
|
1545
|
-
*/
|
|
1546
|
-
pageNo?: number;
|
|
1547
|
-
/**
|
|
1548
|
-
* - For pagination type should be cursor or
|
|
1549
|
-
* number. Default is cursor.
|
|
1550
|
-
*/
|
|
1551
|
-
pageType?: string;
|
|
1552
|
-
/**
|
|
1553
|
-
* - Item Ids of product
|
|
1554
|
-
*/
|
|
1555
|
-
itemIds?: string[];
|
|
1556
|
-
};
|
|
1557
899
|
type GetApplicationBrandListingParam = {
|
|
1558
900
|
/**
|
|
1559
901
|
* - The page number to navigate through the given
|
|
@@ -1566,7 +908,7 @@ type GetApplicationBrandListingParam = {
|
|
|
1566
908
|
*/
|
|
1567
909
|
pageSize?: number;
|
|
1568
910
|
/**
|
|
1569
|
-
* - Search query with brand name.Use this parameter to
|
|
911
|
+
* - Search query with brand name. Use this parameter to
|
|
1570
912
|
* search brands by brand name.
|
|
1571
913
|
*/
|
|
1572
914
|
q?: string;
|
|
@@ -1576,7 +918,7 @@ type GetApplicationBrandsParam = {
|
|
|
1576
918
|
* - The name of the department. Use this
|
|
1577
919
|
* parameter to filter products by a particular department. See below the list
|
|
1578
920
|
* of available departments. You can retrieve available departments from the
|
|
1579
|
-
*
|
|
921
|
+
* "v1.0/departments/" API
|
|
1580
922
|
*/
|
|
1581
923
|
department?: string;
|
|
1582
924
|
/**
|
|
@@ -1590,7 +932,7 @@ type GetApplicationBrandsParam = {
|
|
|
1590
932
|
*/
|
|
1591
933
|
pageSize?: number;
|
|
1592
934
|
/**
|
|
1593
|
-
* - Search query with brand name.Use this parameter to
|
|
935
|
+
* - Search query with brand name. Use this parameter to
|
|
1594
936
|
* search brands by brand name.
|
|
1595
937
|
*/
|
|
1596
938
|
q?: string;
|
|
@@ -1617,8 +959,8 @@ type GetApplicationCategoryListingParam = {
|
|
|
1617
959
|
*/
|
|
1618
960
|
pageSize?: number;
|
|
1619
961
|
/**
|
|
1620
|
-
* -
|
|
1621
|
-
*
|
|
962
|
+
* - A search query string. Use this parameter to filter
|
|
963
|
+
* results based on a keyword or specific value.
|
|
1622
964
|
*/
|
|
1623
965
|
q?: string;
|
|
1624
966
|
};
|
|
@@ -1634,36 +976,34 @@ type GetApplicationDepartmentListingParam = {
|
|
|
1634
976
|
*/
|
|
1635
977
|
pageSize?: number;
|
|
1636
978
|
/**
|
|
1637
|
-
* -
|
|
1638
|
-
*
|
|
979
|
+
* - A search query string. Use this parameter to filter
|
|
980
|
+
* results based on a keyword or specific value.
|
|
1639
981
|
*/
|
|
1640
982
|
q?: string;
|
|
1641
983
|
};
|
|
1642
984
|
type GetApplicationFilterKeysParam = {
|
|
1643
985
|
/**
|
|
1644
986
|
* - The search filter parameters for collection items.
|
|
1645
|
-
* All the parameter filtered from filter parameters will be passed in
|
|
1646
|
-
* parameter in this format.
|
|
1647
|
-
* **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
|
|
987
|
+
* All the parameter filtered from filter parameters will be passed in "c"
|
|
988
|
+
* parameter in this format. "?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts"
|
|
1648
989
|
*/
|
|
1649
990
|
c?: string;
|
|
1650
991
|
};
|
|
1651
992
|
type GetApplicationFilterValuesParam = {
|
|
1652
993
|
/**
|
|
1653
|
-
* - A `filter_key` is a filter key
|
|
1654
|
-
* all the available filter values
|
|
994
|
+
* - A `filter_key` is a filter key which returns
|
|
995
|
+
* all the available filter values.
|
|
1655
996
|
*/
|
|
1656
997
|
filterKey: string;
|
|
1657
998
|
/**
|
|
1658
999
|
* - The search filter parameters for collection items.
|
|
1659
|
-
* All the parameter filtered from filter parameters will be passed in
|
|
1660
|
-
* parameter in this format.
|
|
1661
|
-
* **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
|
|
1000
|
+
* All the parameter filtered from filter parameters will be passed in "c"
|
|
1001
|
+
* parameter in this format. "?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts"
|
|
1662
1002
|
*/
|
|
1663
1003
|
c?: string;
|
|
1664
1004
|
/**
|
|
1665
1005
|
* - A `collection_id` is a unique identifier
|
|
1666
|
-
* for a particular collection.
|
|
1006
|
+
* for a particular collection.
|
|
1667
1007
|
*/
|
|
1668
1008
|
collectionId?: string;
|
|
1669
1009
|
/**
|
|
@@ -1677,68 +1017,83 @@ type GetApplicationFilterValuesParam = {
|
|
|
1677
1017
|
*/
|
|
1678
1018
|
pageSize?: number;
|
|
1679
1019
|
/**
|
|
1680
|
-
* -
|
|
1020
|
+
* - The `q` parameter allows you to search and filter
|
|
1021
|
+
* specific data within the filter options. It acts as a query keyword that
|
|
1022
|
+
* can refine the results by matching relevant filter values, such as a
|
|
1023
|
+
* category name or any other applicable filter criteria.
|
|
1681
1024
|
*/
|
|
1682
1025
|
q?: string;
|
|
1683
1026
|
};
|
|
1684
|
-
type
|
|
1027
|
+
type GetApplicationProductsParam = {
|
|
1685
1028
|
/**
|
|
1686
|
-
* - The
|
|
1687
|
-
*
|
|
1029
|
+
* - The search query. This can be a partial or complete
|
|
1030
|
+
* name of a either a product, brand or category
|
|
1688
1031
|
*/
|
|
1689
|
-
|
|
1032
|
+
q?: string;
|
|
1690
1033
|
/**
|
|
1691
|
-
* -
|
|
1692
|
-
*
|
|
1034
|
+
* - The search filter parameters. All the parameter
|
|
1035
|
+
* filtered from filter parameters will be passed in **f** parameter in this
|
|
1036
|
+
* format. **?f=brand:voi-jeans||and:::category:t-shirts||shirts**
|
|
1693
1037
|
*/
|
|
1694
|
-
|
|
1038
|
+
f?: string;
|
|
1695
1039
|
/**
|
|
1696
|
-
* -
|
|
1697
|
-
*
|
|
1040
|
+
* - The search filter parameters for collection items.
|
|
1041
|
+
* All the parameter filtered from filter parameters will be passed in **c**
|
|
1042
|
+
* parameter in this format.
|
|
1043
|
+
* **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
|
|
1698
1044
|
*/
|
|
1699
|
-
|
|
1045
|
+
c?: string;
|
|
1700
1046
|
/**
|
|
1701
|
-
* -
|
|
1702
|
-
*
|
|
1047
|
+
* - Pass `filters` parameter to fetch the filter
|
|
1048
|
+
* details. This flag is used to fetch all filters
|
|
1703
1049
|
*/
|
|
1704
|
-
|
|
1705
|
-
};
|
|
1706
|
-
type GetAutocompleteKeywordDetailParam = {
|
|
1050
|
+
filters?: boolean;
|
|
1707
1051
|
/**
|
|
1708
|
-
* -
|
|
1709
|
-
*
|
|
1052
|
+
* - This query parameter is used to get the
|
|
1053
|
+
* dependent products in the listing.
|
|
1710
1054
|
*/
|
|
1711
|
-
|
|
1712
|
-
};
|
|
1713
|
-
type GetAutocompletePreviewParam = {
|
|
1055
|
+
isDependent?: boolean;
|
|
1714
1056
|
/**
|
|
1715
|
-
* -
|
|
1057
|
+
* - The order to sort the list of products on. The
|
|
1058
|
+
* supported sort parameters are popularity, price, redemption and discount in
|
|
1059
|
+
* either ascending or descending order. See the supported values below.
|
|
1716
1060
|
*/
|
|
1717
|
-
|
|
1061
|
+
sortOn?: string;
|
|
1718
1062
|
/**
|
|
1719
|
-
* -
|
|
1063
|
+
* - Each response will contain **page_id** param,
|
|
1064
|
+
* which should be sent back to make pagination work.
|
|
1720
1065
|
*/
|
|
1721
|
-
|
|
1066
|
+
pageId?: string;
|
|
1722
1067
|
/**
|
|
1723
|
-
* -
|
|
1068
|
+
* - Number of items to retrieve in each page.
|
|
1069
|
+
* Default is 12.
|
|
1070
|
+
*/
|
|
1071
|
+
pageSize?: number;
|
|
1072
|
+
/**
|
|
1073
|
+
* - If page_type is number then pass it to fetch
|
|
1074
|
+
* page items. Default is 1.
|
|
1724
1075
|
*/
|
|
1725
|
-
|
|
1076
|
+
pageNo?: number;
|
|
1726
1077
|
/**
|
|
1727
|
-
* - For
|
|
1078
|
+
* - For pagination type should be cursor or
|
|
1079
|
+
* number. Default is cursor.
|
|
1728
1080
|
*/
|
|
1729
|
-
|
|
1081
|
+
pageType?: string;
|
|
1730
1082
|
/**
|
|
1731
|
-
* -
|
|
1083
|
+
* - Item Ids of product
|
|
1732
1084
|
*/
|
|
1733
|
-
|
|
1085
|
+
itemIds?: string[];
|
|
1086
|
+
};
|
|
1087
|
+
type GetAutocompleteKeywordDetailParam = {
|
|
1734
1088
|
/**
|
|
1735
|
-
* -
|
|
1089
|
+
* - A `id` is a unique identifier for a particular
|
|
1090
|
+
* detail. Pass the `id` of the keywords which you want to retrieve.
|
|
1736
1091
|
*/
|
|
1737
|
-
|
|
1092
|
+
id: string;
|
|
1738
1093
|
};
|
|
1739
1094
|
type GetCatalogInsightsParam = {
|
|
1740
1095
|
/**
|
|
1741
|
-
* - Brand slug
|
|
1096
|
+
* - Brand slug that is to be searched.
|
|
1742
1097
|
*/
|
|
1743
1098
|
brand?: string;
|
|
1744
1099
|
};
|
|
@@ -1747,7 +1102,7 @@ type GetCategoriesParam = {
|
|
|
1747
1102
|
* - The name of the department. Use this
|
|
1748
1103
|
* parameter to filter products by a particular department. See below the list
|
|
1749
1104
|
* of available departments. You can retrieve available departments from the
|
|
1750
|
-
*
|
|
1105
|
+
* "v1.0/departments/" API
|
|
1751
1106
|
*/
|
|
1752
1107
|
department?: string;
|
|
1753
1108
|
};
|
|
@@ -1769,6 +1124,11 @@ type GetCollectionItemsParam = {
|
|
|
1769
1124
|
* should be sent back to make pagination work.
|
|
1770
1125
|
*/
|
|
1771
1126
|
sortOn?: string;
|
|
1127
|
+
/**
|
|
1128
|
+
* - Each response will contain next_id param, which
|
|
1129
|
+
* should be sent back to make pagination work.
|
|
1130
|
+
*/
|
|
1131
|
+
pageId?: string;
|
|
1772
1132
|
/**
|
|
1773
1133
|
* - Number of items to retrieve in each page.
|
|
1774
1134
|
* Default is 12.
|
|
@@ -1778,20 +1138,6 @@ type GetCollectionItemsParam = {
|
|
|
1778
1138
|
* - Identifies the specific page of results being requested.
|
|
1779
1139
|
*/
|
|
1780
1140
|
pageNo?: number;
|
|
1781
|
-
/**
|
|
1782
|
-
* - Number of items that are pinned and have
|
|
1783
|
-
* priority in each page. Default is 12.
|
|
1784
|
-
*/
|
|
1785
|
-
isPinned?: boolean;
|
|
1786
|
-
/**
|
|
1787
|
-
* - Get multiple products filtered by q string
|
|
1788
|
-
*/
|
|
1789
|
-
q?: string;
|
|
1790
|
-
/**
|
|
1791
|
-
* - Number of items that are excluded from
|
|
1792
|
-
* collections in each page. Default is 12.
|
|
1793
|
-
*/
|
|
1794
|
-
isExcluded?: boolean;
|
|
1795
1141
|
};
|
|
1796
1142
|
type GetConfigurationByTypeParam = {
|
|
1797
1143
|
/**
|
|
@@ -1810,21 +1156,28 @@ type GetConfigurationMetadataParam = {
|
|
|
1810
1156
|
* `template_slug` string. This is for the details and comparision groups.
|
|
1811
1157
|
*/
|
|
1812
1158
|
templateSlug?: string;
|
|
1813
|
-
};
|
|
1814
|
-
type GetConfigurationsFilterMetadataParam = {
|
|
1815
1159
|
/**
|
|
1816
|
-
* -
|
|
1160
|
+
* - The page number to navigate through the given
|
|
1161
|
+
* set of results.
|
|
1162
|
+
*/
|
|
1163
|
+
pageNo?: number;
|
|
1164
|
+
/**
|
|
1165
|
+
* - Number of items to retrieve in each page.
|
|
1817
1166
|
*/
|
|
1818
|
-
|
|
1167
|
+
pageSize?: number;
|
|
1168
|
+
/**
|
|
1169
|
+
* - Get configuration list filtered by `q` string.
|
|
1170
|
+
*/
|
|
1171
|
+
q?: string;
|
|
1819
1172
|
};
|
|
1820
1173
|
type GetDiscountedInventoryBySizeIdentifierParam = {
|
|
1821
1174
|
/**
|
|
1822
|
-
* -
|
|
1175
|
+
* - A `item_id` is a unique identifier for a specific product.
|
|
1823
1176
|
*/
|
|
1824
1177
|
itemId: number;
|
|
1825
1178
|
/**
|
|
1826
1179
|
* - Size Identifier (Seller Identifier or
|
|
1827
|
-
* Primary Identifier)
|
|
1180
|
+
* Primary Identifier).
|
|
1828
1181
|
*/
|
|
1829
1182
|
sizeIdentifier: number;
|
|
1830
1183
|
/**
|
|
@@ -1888,108 +1241,15 @@ type GetListingConfigurationsParam = {
|
|
|
1888
1241
|
* - Get configuration list filtered by `search` string.
|
|
1889
1242
|
*/
|
|
1890
1243
|
search?: string;
|
|
1891
|
-
/**
|
|
1892
|
-
* - Only for categories config type, Get
|
|
1893
|
-
* configuration list filtered by `uids`.
|
|
1894
|
-
*/
|
|
1895
|
-
uids?: number[];
|
|
1896
|
-
};
|
|
1897
|
-
type GetLivePreviewParam = {
|
|
1898
|
-
/**
|
|
1899
|
-
* - A `merchandising_rule_id` is a
|
|
1900
|
-
* unique identifier for a particular merchandising rule.
|
|
1901
|
-
*/
|
|
1902
|
-
merchandisingRuleId: string;
|
|
1903
|
-
/**
|
|
1904
|
-
* - A sample query that can be used to get a
|
|
1905
|
-
* live preview of the merchandising rule.
|
|
1906
|
-
*/
|
|
1907
|
-
searchKeyword?: string;
|
|
1908
|
-
};
|
|
1909
|
-
type GetMerchandisingQueryParam = {
|
|
1910
|
-
/**
|
|
1911
|
-
* - A `merchandising_rule_id` is a
|
|
1912
|
-
* unique identifier for a particular merchandising rule.
|
|
1913
|
-
*/
|
|
1914
|
-
merchandisingRuleId: string;
|
|
1915
|
-
};
|
|
1916
|
-
type GetMerchandisingRuleBoostActionParam = {
|
|
1917
|
-
/**
|
|
1918
|
-
* - A `merchandising_rule_id` is a
|
|
1919
|
-
* unique identifier for a particular merchandising rule.
|
|
1920
|
-
*/
|
|
1921
|
-
merchandisingRuleId: string;
|
|
1922
|
-
};
|
|
1923
|
-
type GetMerchandisingRuleBuryActionParam = {
|
|
1924
|
-
/**
|
|
1925
|
-
* - A `merchandising_rule_id` is a
|
|
1926
|
-
* unique identifier for a particular merchandising rule.
|
|
1927
|
-
*/
|
|
1928
|
-
merchandisingRuleId: string;
|
|
1929
|
-
};
|
|
1930
|
-
type GetMerchandisingRuleHideActionParam = {
|
|
1931
|
-
/**
|
|
1932
|
-
* - A `merchandising_rule_id` is a
|
|
1933
|
-
* unique identifier for a particular merchandising rule.
|
|
1934
|
-
*/
|
|
1935
|
-
merchandisingRuleId: string;
|
|
1936
|
-
};
|
|
1937
|
-
type GetMerchandisingRulePinActionParam = {
|
|
1938
|
-
/**
|
|
1939
|
-
* - A `merchandising_rule_id` is a
|
|
1940
|
-
* unique identifier for a particular merchandising rule.
|
|
1941
|
-
*/
|
|
1942
|
-
merchandisingRuleId: string;
|
|
1943
|
-
};
|
|
1944
|
-
type GetMerchandisingRulesParam = {
|
|
1945
|
-
/**
|
|
1946
|
-
* - Each response will contain next_id param, which
|
|
1947
|
-
* should be sent back to make pagination work.
|
|
1948
|
-
*/
|
|
1949
|
-
pageId?: string;
|
|
1950
|
-
/**
|
|
1951
|
-
* - Number of items to retrieve in each page.
|
|
1952
|
-
* Default is 12.
|
|
1953
|
-
*/
|
|
1954
|
-
pageSize?: number;
|
|
1955
1244
|
};
|
|
1956
1245
|
type GetProductDetailBySlugParam = {
|
|
1957
1246
|
/**
|
|
1958
1247
|
* - The unique identifier of a product. i.e; `slug` of
|
|
1959
1248
|
* a product. You can retrieve these from the APIs that list products like
|
|
1960
|
-
*
|
|
1249
|
+
* "v1.0/products/"
|
|
1961
1250
|
*/
|
|
1962
1251
|
slug: string;
|
|
1963
1252
|
};
|
|
1964
|
-
type GetProductsInPriceFactoryByZoneIdParam = {
|
|
1965
|
-
/**
|
|
1966
|
-
* - An `id` is a unique identifier for a particular price factory.
|
|
1967
|
-
*/
|
|
1968
|
-
id: string;
|
|
1969
|
-
/**
|
|
1970
|
-
* - An `zone_id` is a unique identifier for a
|
|
1971
|
-
* particular price factory zone.
|
|
1972
|
-
*/
|
|
1973
|
-
zoneId: string;
|
|
1974
|
-
/**
|
|
1975
|
-
* - Gets price factory filtered by item_id.
|
|
1976
|
-
*/
|
|
1977
|
-
itemId?: number;
|
|
1978
|
-
/**
|
|
1979
|
-
* - Gets price factory filtered by search query.
|
|
1980
|
-
*/
|
|
1981
|
-
q?: string;
|
|
1982
|
-
/**
|
|
1983
|
-
* - The page number to navigate through the given
|
|
1984
|
-
* set of results.
|
|
1985
|
-
*/
|
|
1986
|
-
pageNo?: number;
|
|
1987
|
-
/**
|
|
1988
|
-
* - Number of items to retrieve in each page.
|
|
1989
|
-
* Default is 12.
|
|
1990
|
-
*/
|
|
1991
|
-
pageSize?: number;
|
|
1992
|
-
};
|
|
1993
1253
|
type GetSearchKeywordsParam = {
|
|
1994
1254
|
/**
|
|
1995
1255
|
* - A `id` is a unique identifier for a particular
|
|
@@ -1997,92 +1257,23 @@ type GetSearchKeywordsParam = {
|
|
|
1997
1257
|
*/
|
|
1998
1258
|
id: string;
|
|
1999
1259
|
};
|
|
2000
|
-
type GetSearchRerankDetailParam = {
|
|
2001
|
-
/**
|
|
2002
|
-
* - An `id` is the identifier for a particular search
|
|
2003
|
-
* rerank configuration. channel.
|
|
2004
|
-
*/
|
|
2005
|
-
id: string;
|
|
2006
|
-
};
|
|
2007
|
-
type GetSynonymsParam = {
|
|
2008
|
-
/**
|
|
2009
|
-
* - Mongo id of the particular synonym
|
|
2010
|
-
*/
|
|
2011
|
-
id?: string;
|
|
2012
|
-
/**
|
|
2013
|
-
* - Synonym name
|
|
2014
|
-
*/
|
|
2015
|
-
name?: string;
|
|
2016
|
-
/**
|
|
2017
|
-
* - Synonym type - oneway/twoway
|
|
2018
|
-
*/
|
|
2019
|
-
type?: string;
|
|
2020
|
-
};
|
|
2021
|
-
type PollBulkSynonymsParam = {
|
|
2022
|
-
/**
|
|
2023
|
-
* - Id of the bulk job that needs to be polled.
|
|
2024
|
-
*/
|
|
2025
|
-
id: string;
|
|
2026
|
-
};
|
|
2027
|
-
type PollPriceFactoryJobsParam = {
|
|
2028
|
-
/**
|
|
2029
|
-
* - An `id` is a unique identifier for a particular price factory.
|
|
2030
|
-
*/
|
|
2031
|
-
id: string;
|
|
2032
|
-
};
|
|
2033
|
-
type PollProductPriceFactoryBulkJobParam = {
|
|
2034
|
-
/**
|
|
2035
|
-
* - An `id` is a unique identifier for a particular price factory.
|
|
2036
|
-
*/
|
|
2037
|
-
id: string;
|
|
2038
|
-
/**
|
|
2039
|
-
* - A `job_id` is a unique identifier for a particular bulk job.
|
|
2040
|
-
*/
|
|
2041
|
-
jobId: string;
|
|
2042
|
-
};
|
|
2043
|
-
type ProcessBulkSynonymsParam = {
|
|
2044
|
-
body: CatalogPlatformModel.SynonymBulkProcessRequestSchema;
|
|
2045
|
-
};
|
|
2046
|
-
type ProcessProductPriceFactoryBulkJobParam = {
|
|
2047
|
-
/**
|
|
2048
|
-
* - An `id` is a unique identifier for a particular price factory.
|
|
2049
|
-
*/
|
|
2050
|
-
id: string;
|
|
2051
|
-
/**
|
|
2052
|
-
* - A `job_id` is a unique identifier for a particular bulk job.
|
|
2053
|
-
*/
|
|
2054
|
-
jobId: string;
|
|
2055
|
-
body: CatalogPlatformModel.CreateAppPriceFactoryProductBulkJobRequest;
|
|
2056
|
-
};
|
|
2057
|
-
type SampleBulkSynonymsFileParam = {
|
|
2058
|
-
/**
|
|
2059
|
-
* - Type of the file
|
|
2060
|
-
*/
|
|
2061
|
-
type: string;
|
|
2062
|
-
};
|
|
2063
|
-
type SaveMerchandisingRulesParam = {
|
|
2064
|
-
/**
|
|
2065
|
-
* - A `merchandising_rule_id` is a
|
|
2066
|
-
* unique identifier for a particular merchandising rule.
|
|
2067
|
-
*/
|
|
2068
|
-
merchandisingRuleId: string;
|
|
2069
|
-
body: CatalogPlatformModel.MerchandisingRuleSave;
|
|
2070
|
-
};
|
|
2071
1260
|
type UpdateAllowSingleParam = {
|
|
2072
|
-
body: CatalogPlatformModel.
|
|
1261
|
+
body: CatalogPlatformModel.AllowSingleRequestSchema;
|
|
2073
1262
|
};
|
|
2074
1263
|
type UpdateAppBrandParam = {
|
|
2075
1264
|
/**
|
|
2076
|
-
* -
|
|
1265
|
+
* - A `brand id` is a unique identifier for a
|
|
1266
|
+
* particular brand.
|
|
2077
1267
|
*/
|
|
2078
1268
|
brandUid: number;
|
|
2079
1269
|
body: CatalogPlatformModel.ApplicationBrandJson;
|
|
2080
1270
|
};
|
|
2081
1271
|
type UpdateAppCategoryParam = {
|
|
2082
1272
|
/**
|
|
2083
|
-
* -
|
|
1273
|
+
* - A `category id` is a unique identifier for a
|
|
1274
|
+
* particular category.
|
|
2084
1275
|
*/
|
|
2085
|
-
categoryUid:
|
|
1276
|
+
categoryUid: string;
|
|
2086
1277
|
body: CatalogPlatformModel.ApplicationCategoryJson;
|
|
2087
1278
|
};
|
|
2088
1279
|
type UpdateAppCategoryReturnConfigurationParam = {
|
|
@@ -2090,8 +1281,8 @@ type UpdateAppCategoryReturnConfigurationParam = {
|
|
|
2090
1281
|
};
|
|
2091
1282
|
type UpdateAppDepartmentParam = {
|
|
2092
1283
|
/**
|
|
2093
|
-
* -
|
|
2094
|
-
*
|
|
1284
|
+
* - A `department id` is a unique identifier
|
|
1285
|
+
* for a particular department.
|
|
2095
1286
|
*/
|
|
2096
1287
|
departmentUid: number;
|
|
2097
1288
|
body: CatalogPlatformModel.ApplicationDepartmentJson;
|
|
@@ -2105,7 +1296,7 @@ type UpdateAppLocationParam = {
|
|
|
2105
1296
|
};
|
|
2106
1297
|
type UpdateAppProductParam = {
|
|
2107
1298
|
/**
|
|
2108
|
-
* -
|
|
1299
|
+
* - A `item_id` is a unique identifier for a particular item.
|
|
2109
1300
|
*/
|
|
2110
1301
|
itemId: number;
|
|
2111
1302
|
body: CatalogPlatformModel.ApplicationItemMeta;
|
|
@@ -2121,14 +1312,6 @@ type UpdateAutocompleteKeywordParam = {
|
|
|
2121
1312
|
id: string;
|
|
2122
1313
|
body: CatalogPlatformModel.CreateAutocompleteKeyword;
|
|
2123
1314
|
};
|
|
2124
|
-
type UpdateAutocompleteSettingsParam = {
|
|
2125
|
-
/**
|
|
2126
|
-
* - An `id` is a unique identifier for a particular
|
|
2127
|
-
* autocomplete settings config.
|
|
2128
|
-
*/
|
|
2129
|
-
id: string;
|
|
2130
|
-
body: CatalogPlatformModel.AutocompleteRequestSchema;
|
|
2131
|
-
};
|
|
2132
1315
|
type UpdateCollectionParam = {
|
|
2133
1316
|
/**
|
|
2134
1317
|
* - A `id` is a unique identifier of a collection.
|
|
@@ -2137,7 +1320,7 @@ type UpdateCollectionParam = {
|
|
|
2137
1320
|
body: CatalogPlatformModel.UpdateCollection;
|
|
2138
1321
|
};
|
|
2139
1322
|
type UpdateDefaultSortParam = {
|
|
2140
|
-
body: CatalogPlatformModel.
|
|
1323
|
+
body: CatalogPlatformModel.DefaultKeyRequestSchema;
|
|
2141
1324
|
};
|
|
2142
1325
|
type UpdateGroupConfigurationParam = {
|
|
2143
1326
|
/**
|
|
@@ -2163,50 +1346,10 @@ type UpdateListingConfigurationParam = {
|
|
|
2163
1346
|
* particular configuration.
|
|
2164
1347
|
*/
|
|
2165
1348
|
configId: string;
|
|
2166
|
-
body: CatalogPlatformModel.
|
|
2167
|
-
};
|
|
2168
|
-
type UpdateMerchandisingRuleBoostActionParam = {
|
|
2169
|
-
/**
|
|
2170
|
-
* - A `merchandising_rule_id` is a
|
|
2171
|
-
* unique identifier for a particular merchandising rule.
|
|
2172
|
-
*/
|
|
2173
|
-
merchandisingRuleId: string;
|
|
2174
|
-
body: CatalogPlatformModel.PostMerchandisingRuleBoostAction;
|
|
2175
|
-
};
|
|
2176
|
-
type UpdateMerchandisingRuleBuryActionParam = {
|
|
2177
|
-
/**
|
|
2178
|
-
* - A `merchandising_rule_id` is a
|
|
2179
|
-
* unique identifier for a particular merchandising rule.
|
|
2180
|
-
*/
|
|
2181
|
-
merchandisingRuleId: string;
|
|
2182
|
-
body: CatalogPlatformModel.PostMerchandisingRuleBoostAction;
|
|
2183
|
-
};
|
|
2184
|
-
type UpdateMerchandisingRuleHideActionParam = {
|
|
2185
|
-
/**
|
|
2186
|
-
* - A `merchandising_rule_id` is a
|
|
2187
|
-
* unique identifier for a particular merchandising rule.
|
|
2188
|
-
*/
|
|
2189
|
-
merchandisingRuleId: string;
|
|
2190
|
-
body: CatalogPlatformModel.HideRequest;
|
|
2191
|
-
};
|
|
2192
|
-
type UpdateMerchandisingRulePinActionParam = {
|
|
2193
|
-
/**
|
|
2194
|
-
* - A `merchandising_rule_id` is a
|
|
2195
|
-
* unique identifier for a particular merchandising rule.
|
|
2196
|
-
*/
|
|
2197
|
-
merchandisingRuleId: string;
|
|
2198
|
-
body: CatalogPlatformModel.PinRequest;
|
|
2199
|
-
};
|
|
2200
|
-
type UpdateMerchandisingRuleQueryParam = {
|
|
2201
|
-
/**
|
|
2202
|
-
* - A `merchandising_rule_id` is a
|
|
2203
|
-
* unique identifier for a particular merchandising rule.
|
|
2204
|
-
*/
|
|
2205
|
-
merchandisingRuleId: string;
|
|
2206
|
-
body: CatalogPlatformModel.MerchandisingRuleQueryPost;
|
|
1349
|
+
body: CatalogPlatformModel.AppConfigurationsSort;
|
|
2207
1350
|
};
|
|
2208
1351
|
type UpdateSearchConfigurationParam = {
|
|
2209
|
-
body: CatalogPlatformModel.
|
|
1352
|
+
body: CatalogPlatformModel.UpdateSearchConfigurationRequestSchema;
|
|
2210
1353
|
};
|
|
2211
1354
|
type UpdateSearchKeywordsParam = {
|
|
2212
1355
|
/**
|
|
@@ -2216,47 +1359,13 @@ type UpdateSearchKeywordsParam = {
|
|
|
2216
1359
|
id: string;
|
|
2217
1360
|
body: CatalogPlatformModel.CreateSearchKeyword;
|
|
2218
1361
|
};
|
|
2219
|
-
type UpdateSearchRerankConfigurationParam = {
|
|
2220
|
-
/**
|
|
2221
|
-
* - An `id` is the identifier for a particular search
|
|
2222
|
-
* rerank configuration. channel.
|
|
2223
|
-
*/
|
|
2224
|
-
id: string;
|
|
2225
|
-
body: CatalogPlatformModel.UpdateSearchRerankRequest;
|
|
2226
|
-
};
|
|
2227
|
-
type UpdateSynonymsParam = {
|
|
2228
|
-
/**
|
|
2229
|
-
* - An `id` is a unique identifier for a particular
|
|
2230
|
-
* synonym channel.
|
|
2231
|
-
*/
|
|
2232
|
-
id: string;
|
|
2233
|
-
body: CatalogPlatformModel.SynonymCreateRequestSchema;
|
|
2234
|
-
};
|
|
2235
|
-
type UploadSynonymsParam = {
|
|
2236
|
-
body: CatalogPlatformModel.SynonymUploadRequestSchema;
|
|
2237
|
-
};
|
|
2238
|
-
type ValidateBulkSynonymsParam = {
|
|
2239
|
-
body: CatalogPlatformModel.SynonymBulkValidateRequestSchema;
|
|
2240
|
-
};
|
|
2241
|
-
type ValidateProductPriceFactoryBulkJobParam = {
|
|
2242
|
-
/**
|
|
2243
|
-
* - An `id` is a unique identifier for a particular price factory.
|
|
2244
|
-
*/
|
|
2245
|
-
id: string;
|
|
2246
|
-
/**
|
|
2247
|
-
* - A `job_id` is a unique identifier for a particular bulk job.
|
|
2248
|
-
*/
|
|
2249
|
-
jobId: string;
|
|
2250
|
-
body: CatalogPlatformModel.CreateAppPriceFactoryProductBulkJobRequest;
|
|
2251
|
-
};
|
|
2252
1362
|
type DeleteSearchConfigurationParam = any;
|
|
2253
|
-
type
|
|
1363
|
+
type GetAllSearchKeywordParam = any;
|
|
2254
1364
|
type GetAppReturnConfigurationParam = any;
|
|
2255
|
-
type
|
|
1365
|
+
type GetAutocompleteConfigParam = any;
|
|
2256
1366
|
type GetCatalogConfigurationParam = any;
|
|
2257
1367
|
type GetConfigurationsParam = any;
|
|
2258
1368
|
type GetDepartmentsParam = any;
|
|
2259
1369
|
type GetQueryFiltersParam = any;
|
|
2260
1370
|
type GetSearchConfigurationParam = any;
|
|
2261
|
-
type GetSearchRerankParam = any;
|
|
2262
1371
|
import CatalogPlatformModel = require("./CatalogPlatformModel");
|