@gofynd/fdk-client-javascript 1.6.3 → 3.0.0-beta.1
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 +0 -2
- package/sdk/application/ApplicationClient.js +0 -2
- package/sdk/application/Cart/CartApplicationClient.d.ts +113 -93
- package/sdk/application/Cart/CartApplicationClient.js +270 -139
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +110 -110
- package/sdk/application/Catalog/CatalogApplicationClient.js +122 -138
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +43 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +190 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +71 -36
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +103 -29
- package/sdk/application/Content/ContentApplicationClient.d.ts +51 -21
- package/sdk/application/Content/ContentApplicationClient.js +197 -36
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -6
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +3 -3
- package/sdk/application/Lead/LeadApplicationClient.d.ts +3 -3
- package/sdk/application/Lead/LeadApplicationClient.js +3 -3
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +79 -64
- package/sdk/application/Logistic/LogisticApplicationClient.js +246 -264
- package/sdk/application/Order/OrderApplicationClient.d.ts +44 -24
- package/sdk/application/Order/OrderApplicationClient.js +140 -21
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +211 -111
- package/sdk/application/Payment/PaymentApplicationClient.js +610 -109
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +14 -14
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +23 -3
- package/sdk/application/Theme/ThemeApplicationClient.js +103 -5
- package/sdk/application/User/UserApplicationClient.d.ts +13 -23
- package/sdk/application/User/UserApplicationClient.js +9 -57
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +3 -3
- package/sdk/partner/Authorization/AuthorizationPartnerClient.d.ts +66 -0
- package/sdk/partner/Authorization/AuthorizationPartnerClient.js +431 -0
- package/sdk/partner/Authorization/AuthorizationPartnerModel.d.ts +231 -0
- package/sdk/partner/Authorization/AuthorizationPartnerModel.js +152 -0
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.d.ts +8 -0
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.js +39 -0
- package/sdk/partner/Catalog/CatalogPartnerClient.d.ts +26 -0
- package/sdk/partner/Catalog/CatalogPartnerClient.js +173 -0
- package/sdk/partner/Catalog/CatalogPartnerModel.d.ts +238 -0
- package/sdk/partner/Catalog/CatalogPartnerModel.js +248 -0
- package/sdk/partner/Catalog/CatalogPartnerValidator.d.ts +5 -0
- package/sdk/partner/Catalog/CatalogPartnerValidator.js +19 -0
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +12 -22
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +12 -87
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +33 -99
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +25 -84
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +0 -1
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -10
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerClient.js +4 -4
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +100 -49
- package/sdk/partner/Lead/LeadPartnerModel.js +100 -74
- package/sdk/partner/Lead/LeadPartnerValidator.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +33 -160
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +66 -1180
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +288 -1685
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +226 -824
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +1 -13
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +14 -141
- package/sdk/partner/PartnerClient.d.ts +6 -0
- package/sdk/partner/PartnerClient.js +9 -0
- package/sdk/partner/Payment/PaymentPartnerClient.d.ts +116 -0
- package/sdk/partner/Payment/PaymentPartnerClient.js +857 -0
- package/sdk/partner/Payment/PaymentPartnerModel.d.ts +388 -0
- package/sdk/partner/Payment/PaymentPartnerModel.js +442 -0
- package/sdk/partner/Payment/PaymentPartnerValidator.d.ts +14 -0
- package/sdk/partner/Payment/PaymentPartnerValidator.js +74 -0
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +63 -21
- package/sdk/partner/Theme/ThemePartnerClient.js +396 -71
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +104 -72
- package/sdk/partner/Theme/ThemePartnerModel.js +101 -75
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +5 -1
- package/sdk/partner/Theme/ThemePartnerValidator.js +42 -12
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +191 -612
- package/sdk/partner/Webhook/WebhookPartnerModel.js +159 -234
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -3
- package/sdk/partner/index.d.ts +3 -0
- package/sdk/partner/index.js +6 -0
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +1 -4
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +5 -0
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +3 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +32 -2
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +243 -3
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +145 -49
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +171 -20
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +39 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +35 -0
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +406 -15
- package/sdk/platform/Billing/BillingPlatformClient.js +3214 -76
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +3798 -459
- package/sdk/platform/Billing/BillingPlatformModel.js +2577 -342
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +465 -24
- package/sdk/platform/Billing/BillingPlatformValidator.js +490 -14
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +284 -205
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +671 -553
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +165 -165
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +108 -132
- package/sdk/platform/Cart/CartPlatformModel.d.ts +3136 -4788
- package/sdk/platform/Cart/CartPlatformModel.js +2850 -2031
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +1015 -419
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +6450 -2010
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1121 -230
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +919 -127
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +372 -574
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1238 -1317
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +8351 -9825
- package/sdk/platform/Catalog/CatalogPlatformModel.js +9662 -6881
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +288 -235
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +241 -183
- package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -6
- package/sdk/platform/Common/CommonPlatformClient.js +5 -6
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +374 -234
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +875 -583
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +170 -139
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +145 -126
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +56 -3
- package/sdk/platform/Communication/CommunicationPlatformClient.js +307 -4
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +424 -252
- package/sdk/platform/Communication/CommunicationPlatformModel.js +540 -320
- package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +62 -3
- package/sdk/platform/Communication/CommunicationPlatformValidator.js +48 -2
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +68 -99
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +84 -140
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +238 -256
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +222 -244
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +20 -20
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +20 -20
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +333 -118
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +1470 -409
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +158 -55
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +163 -41
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +151 -61
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +595 -101
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +1199 -462
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +1008 -321
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +80 -34
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +79 -24
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +253 -140
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1087 -458
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +221 -178
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +220 -157
- package/sdk/platform/Content/ContentPlatformClient.d.ts +124 -123
- package/sdk/platform/Content/ContentPlatformClient.js +459 -379
- package/sdk/platform/Content/ContentPlatformModel.d.ts +833 -1307
- package/sdk/platform/Content/ContentPlatformModel.js +893 -582
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +140 -150
- package/sdk/platform/Content/ContentPlatformValidator.js +131 -135
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +60 -36
- package/sdk/platform/Discount/DiscountPlatformClient.js +85 -36
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +46 -47
- package/sdk/platform/Discount/DiscountPlatformModel.js +42 -46
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +18 -15
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +24 -22
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +75 -86
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +60 -74
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +320 -0
- package/sdk/platform/Finance/FinancePlatformClient.js +2333 -0
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +2895 -0
- package/sdk/platform/Finance/FinancePlatformModel.js +2150 -0
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +284 -0
- package/sdk/platform/Finance/FinancePlatformValidator.js +354 -0
- 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 +4 -24
- package/sdk/platform/Lead/LeadPlatformClient.js +4 -160
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +142 -57
- package/sdk/platform/Lead/LeadPlatformModel.js +162 -79
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +3 -29
- package/sdk/platform/Lead/LeadPlatformValidator.js +2 -28
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +94 -25
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +600 -57
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +115 -115
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +120 -43
- package/sdk/platform/Order/OrderPlatformClient.d.ts +502 -293
- package/sdk/platform/Order/OrderPlatformClient.js +1466 -913
- package/sdk/platform/Order/OrderPlatformModel.d.ts +4111 -9093
- package/sdk/platform/Order/OrderPlatformModel.js +3202 -4230
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +445 -612
- package/sdk/platform/Order/OrderPlatformValidator.js +316 -326
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +7 -9
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
- package/sdk/platform/Partner/PartnerPlatformModel.js +7 -7
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +382 -135
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +2453 -935
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +306 -93
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +305 -70
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +66 -56
- package/sdk/platform/Payment/PaymentPlatformClient.js +269 -124
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +3525 -1313
- package/sdk/platform/Payment/PaymentPlatformModel.js +3813 -1511
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +64 -35
- package/sdk/platform/Payment/PaymentPlatformValidator.js +60 -34
- package/sdk/platform/PlatformClient.d.ts +2 -0
- package/sdk/platform/PlatformClient.js +4 -0
- 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 +14 -9
- package/sdk/platform/Rewards/RewardsPlatformModel.js +10 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +344 -56
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +2180 -302
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +380 -54
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +336 -37
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +127 -213
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +538 -1306
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +3429 -2979
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +3642 -1785
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +218 -392
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +151 -290
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +4 -16
- package/sdk/platform/Share/SharePlatformApplicationClient.js +8 -86
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +6 -23
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +3 -16
- package/sdk/platform/Share/SharePlatformModel.d.ts +6 -50
- package/sdk/platform/Share/SharePlatformModel.js +3 -43
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +26 -4
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +157 -10
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +21 -10
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +23 -6
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +18 -8
- package/sdk/platform/Theme/ThemePlatformClient.js +85 -8
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +425 -17
- package/sdk/platform/Theme/ThemePlatformModel.js +329 -23
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +7 -3
- package/sdk/platform/Theme/ThemePlatformValidator.js +9 -2
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +22 -12
- package/sdk/platform/User/UserPlatformApplicationClient.js +91 -12
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +15 -3
- package/sdk/platform/User/UserPlatformApplicationValidator.js +14 -2
- package/sdk/platform/User/UserPlatformModel.d.ts +223 -59
- package/sdk/platform/User/UserPlatformModel.js +204 -65
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +78 -25
- package/sdk/platform/Webhook/WebhookPlatformClient.js +470 -75
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +434 -758
- package/sdk/platform/Webhook/WebhookPlatformModel.js +395 -410
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +55 -10
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +72 -12
- package/sdk/platform/index.d.ts +1 -0
- package/sdk/platform/index.js +2 -0
- package/sdk/public/Billing/BillingPublicClient.d.ts +56 -0
- package/sdk/public/Billing/BillingPublicClient.js +397 -0
- package/sdk/public/Billing/BillingPublicModel.d.ts +919 -0
- package/sdk/public/Billing/BillingPublicModel.js +560 -0
- package/sdk/public/Billing/BillingPublicValidator.d.ts +43 -0
- package/sdk/public/Billing/BillingPublicValidator.js +50 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +14 -4
- package/sdk/public/Configuration/ConfigurationPublicClient.js +97 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +102 -40
- package/sdk/public/Configuration/ConfigurationPublicModel.js +111 -29
- package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +11 -1
- package/sdk/public/Configuration/ConfigurationPublicValidator.js +12 -0
- package/sdk/public/Content/ContentPublicClient.d.ts +22 -0
- package/sdk/public/Content/ContentPublicClient.js +183 -0
- package/sdk/public/Content/ContentPublicModel.d.ts +38 -1
- package/sdk/public/Content/ContentPublicModel.js +47 -1
- package/sdk/public/Content/ContentPublicValidator.d.ts +17 -1
- package/sdk/public/Content/ContentPublicValidator.js +19 -0
- 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 +8 -8
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +67 -215
- package/sdk/public/Webhook/WebhookPublicModel.js +61 -66
- 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/application/Finance/FinanceApplicationClient.d.ts +0 -29
- package/sdk/application/Finance/FinanceApplicationClient.js +0 -126
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +0 -22
- package/sdk/public/Catalog/CatalogPublicClient.js +0 -138
- package/sdk/public/Catalog/CatalogPublicModel.d.ts +0 -155
- package/sdk/public/Catalog/CatalogPublicModel.js +0 -116
- package/sdk/public/Catalog/CatalogPublicValidator.d.ts +0 -55
- package/sdk/public/Catalog/CatalogPublicValidator.js +0 -35
|
@@ -4,26 +4,33 @@ 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
|
+
*/
|
|
7
16
|
/**
|
|
8
17
|
* @typedef CreateAppCategoryReturnConfigurationParam
|
|
9
18
|
* @property {CatalogPlatformModel.BaseAppCategoryReturnConfig} body
|
|
10
19
|
*/
|
|
20
|
+
/**
|
|
21
|
+
* @typedef CreateAppPriceFactoryParam
|
|
22
|
+
* @property {CatalogPlatformModel.CreateAppPriceFactoryRequestSchema} body
|
|
23
|
+
*/
|
|
11
24
|
/**
|
|
12
25
|
* @typedef CreateAppReturnConfigurationParam
|
|
13
26
|
* @property {CatalogPlatformModel.CreateUpdateAppReturnConfig} body
|
|
14
27
|
*/
|
|
28
|
+
/**
|
|
29
|
+
* @typedef CreateAutocompleteSettingsParam
|
|
30
|
+
* @property {CatalogPlatformModel.AutocompleteRequestSchema} body
|
|
31
|
+
*/
|
|
15
32
|
/**
|
|
16
33
|
* @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.
|
|
27
34
|
* @property {CatalogPlatformModel.CreateCollection} body
|
|
28
35
|
*/
|
|
29
36
|
/**
|
|
@@ -47,17 +54,58 @@ export = CatalogPlatformApplicationValidator;
|
|
|
47
54
|
* @typedef CreateGroupConfigurationParam
|
|
48
55
|
* @property {string} configType - A `config_type` is a unique identifier for a
|
|
49
56
|
* particular group configuration type.
|
|
50
|
-
* @property {CatalogPlatformModel.
|
|
57
|
+
* @property {CatalogPlatformModel.AppConfigurationCreateDetail} body
|
|
51
58
|
*/
|
|
52
59
|
/**
|
|
53
60
|
* @typedef CreateListingConfigurationParam
|
|
54
61
|
* @property {string} configType - A `config_type` is a unique identifier for a
|
|
55
62
|
* particular listing configuration type.
|
|
56
|
-
* @property {CatalogPlatformModel.
|
|
63
|
+
* @property {CatalogPlatformModel.AppConfigurationsFilter} body
|
|
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
|
|
57
97
|
*/
|
|
58
98
|
/**
|
|
59
99
|
* @typedef CreateSearchConfigurationParam
|
|
60
|
-
* @property {CatalogPlatformModel.
|
|
100
|
+
* @property {CatalogPlatformModel.CreateSearchConfigurationRequest} body
|
|
101
|
+
*/
|
|
102
|
+
/**
|
|
103
|
+
* @typedef CreateSearchRerankParam
|
|
104
|
+
* @property {CatalogPlatformModel.CreateSearchRerankRequest} body
|
|
105
|
+
*/
|
|
106
|
+
/**
|
|
107
|
+
* @typedef CreateSynonymsParam
|
|
108
|
+
* @property {CatalogPlatformModel.SynonymCreateRequestSchema} body
|
|
61
109
|
*/
|
|
62
110
|
/**
|
|
63
111
|
* @typedef DeleteAppCategoryReturnConfigurationParam
|
|
@@ -86,18 +134,49 @@ export = CatalogPlatformApplicationValidator;
|
|
|
86
134
|
* @property {string} configId - A `config_id` is a unique identifier of a
|
|
87
135
|
* particular configuration.
|
|
88
136
|
*/
|
|
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
|
+
*/
|
|
89
147
|
/** @typedef DeleteSearchConfigurationParam */
|
|
90
148
|
/**
|
|
91
149
|
* @typedef DeleteSearchKeywordsParam
|
|
92
150
|
* @property {string} id - A `id` is a unique identifier for a particular
|
|
93
151
|
* detail. Pass the `id` of the keywords which you want to delete.
|
|
94
152
|
*/
|
|
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 */
|
|
95
174
|
/**
|
|
96
175
|
* @typedef GetAllCollectionsParam
|
|
97
176
|
* @property {string} [q] - Get collection list filtered by q string,
|
|
98
177
|
* @property {string} [scheduleStatus] - Get collection list filtered by scheduled status,
|
|
99
178
|
* @property {string} [type] - Type of the collections
|
|
100
|
-
* @property {string[]} [
|
|
179
|
+
* @property {string[]} [tag] - Each response will contain next_id param, which
|
|
101
180
|
* should be sent back to make pagination work.
|
|
102
181
|
* @property {boolean} [isActive] - Get collections filtered by active status.
|
|
103
182
|
* @property {number} [pageNo] - The page number to navigate through the given
|
|
@@ -105,7 +184,17 @@ export = CatalogPlatformApplicationValidator;
|
|
|
105
184
|
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
106
185
|
* Default is 12.
|
|
107
186
|
*/
|
|
108
|
-
/**
|
|
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
|
+
*/
|
|
109
198
|
/**
|
|
110
199
|
* @typedef GetAppCategoryReturnConfigParam
|
|
111
200
|
* @property {string} [q] - Get return configurations for categories by matching
|
|
@@ -150,10 +239,49 @@ export = CatalogPlatformApplicationValidator;
|
|
|
150
239
|
* Default is 20.
|
|
151
240
|
* @property {string[]} [tags] - Get locations filtered by tags.
|
|
152
241
|
* @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.
|
|
153
270
|
*/
|
|
154
271
|
/**
|
|
155
272
|
* @typedef GetAppProductParam
|
|
156
|
-
* @property {
|
|
273
|
+
* @property {number} itemId - Product id for a particular product.
|
|
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.
|
|
157
285
|
*/
|
|
158
286
|
/**
|
|
159
287
|
* @typedef GetAppProductsParam
|
|
@@ -169,13 +297,41 @@ export = CatalogPlatformApplicationValidator;
|
|
|
169
297
|
* @property {string} [q] - Search with Item Code, Name, Slug or Identifier.
|
|
170
298
|
*/
|
|
171
299
|
/** @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
|
+
*/
|
|
172
328
|
/**
|
|
173
329
|
* @typedef GetApplicationBrandListingParam
|
|
174
330
|
* @property {number} [pageNo] - The page number to navigate through the given
|
|
175
331
|
* set of results
|
|
176
332
|
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
177
333
|
* Default is 12.
|
|
178
|
-
* @property {string} [q] - Search query with brand name.
|
|
334
|
+
* @property {string} [q] - Search query with brand name.Use this parameter to
|
|
179
335
|
* search brands by brand name.
|
|
180
336
|
*/
|
|
181
337
|
/**
|
|
@@ -183,12 +339,12 @@ export = CatalogPlatformApplicationValidator;
|
|
|
183
339
|
* @property {string} [department] - The name of the department. Use this
|
|
184
340
|
* parameter to filter products by a particular department. See below the list
|
|
185
341
|
* of available departments. You can retrieve available departments from the
|
|
186
|
-
*
|
|
342
|
+
* **v1.0/departments/** API
|
|
187
343
|
* @property {number} [pageNo] - The page number to navigate through the given
|
|
188
344
|
* set of results
|
|
189
345
|
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
190
346
|
* Default is 12.
|
|
191
|
-
* @property {string} [q] - Search query with brand name.
|
|
347
|
+
* @property {string} [q] - Search query with brand name.Use this parameter to
|
|
192
348
|
* search brands by brand name.
|
|
193
349
|
* @property {number[]} [brandId] - Helps to sort the brands list on the basis
|
|
194
350
|
* of uid list.
|
|
@@ -201,8 +357,8 @@ export = CatalogPlatformApplicationValidator;
|
|
|
201
357
|
* set of results
|
|
202
358
|
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
203
359
|
* Default is 12.
|
|
204
|
-
* @property {string} [q] -
|
|
205
|
-
*
|
|
360
|
+
* @property {string} [q] - Search query with brand name.Use this parameter to
|
|
361
|
+
* search brands by brand name.
|
|
206
362
|
*/
|
|
207
363
|
/**
|
|
208
364
|
* @typedef GetApplicationDepartmentListingParam
|
|
@@ -210,78 +366,69 @@ export = CatalogPlatformApplicationValidator;
|
|
|
210
366
|
* set of results
|
|
211
367
|
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
212
368
|
* Default is 12.
|
|
213
|
-
* @property {string} [q] -
|
|
214
|
-
*
|
|
369
|
+
* @property {string} [q] - Search query with brand name.Use this parameter to
|
|
370
|
+
* search department by name.
|
|
215
371
|
*/
|
|
216
372
|
/**
|
|
217
373
|
* @typedef GetApplicationFilterKeysParam
|
|
218
374
|
* @property {string} [c] - The search filter parameters for collection items.
|
|
219
|
-
* All the parameter filtered from filter parameters will be passed in
|
|
220
|
-
* parameter in this format.
|
|
375
|
+
* All the parameter filtered from filter parameters will be passed in **c**
|
|
376
|
+
* parameter in this format.
|
|
377
|
+
* **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
|
|
221
378
|
*/
|
|
222
379
|
/**
|
|
223
380
|
* @typedef GetApplicationFilterValuesParam
|
|
224
|
-
* @property {string} filterKey - A `filter_key` is a filter key which
|
|
225
|
-
* all the available filter values.
|
|
381
|
+
* @property {string} filterKey - A `filter_key` is a filter key for a for which
|
|
382
|
+
* all the available filter values will returned. channel.
|
|
226
383
|
* @property {string} [c] - The search filter parameters for collection items.
|
|
227
|
-
* All the parameter filtered from filter parameters will be passed in
|
|
228
|
-
* parameter in this format.
|
|
384
|
+
* All the parameter filtered from filter parameters will be passed in **c**
|
|
385
|
+
* parameter in this format.
|
|
386
|
+
* **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
|
|
229
387
|
* @property {string} [collectionId] - A `collection_id` is a unique identifier
|
|
230
|
-
* for a particular collection.
|
|
388
|
+
* for a particular collection. channel.
|
|
231
389
|
* @property {number} [pageNo] - The page number to navigate through the given
|
|
232
390
|
* set of results
|
|
233
391
|
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
234
392
|
* Default is 10.
|
|
235
|
-
* @property {string} [q] -
|
|
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.
|
|
393
|
+
* @property {string} [q] - Get Values filtered by q string
|
|
239
394
|
*/
|
|
240
395
|
/**
|
|
241
|
-
* @typedef
|
|
242
|
-
* @property {
|
|
243
|
-
*
|
|
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.
|
|
396
|
+
* @typedef GetAutocompleteConfigParam
|
|
397
|
+
* @property {number} [pageNo] - The page number to navigate through the given
|
|
398
|
+
* set of results
|
|
260
399
|
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
261
400
|
* Default is 12.
|
|
262
|
-
* @property {
|
|
263
|
-
*
|
|
264
|
-
* @property {
|
|
265
|
-
*
|
|
266
|
-
* @property {string[]} [itemIds] - Item Ids of product
|
|
401
|
+
* @property {string} [q] - Search query with words name.Use this parameter to
|
|
402
|
+
* search keywords by words.
|
|
403
|
+
* @property {boolean} [isActive] - Can query for keywords based on whether they
|
|
404
|
+
* are active or inactive.
|
|
267
405
|
*/
|
|
268
|
-
/** @typedef GetAutocompleteConfigParam */
|
|
269
406
|
/**
|
|
270
407
|
* @typedef GetAutocompleteKeywordDetailParam
|
|
271
408
|
* @property {string} id - A `id` is a unique identifier for a particular
|
|
272
409
|
* detail. Pass the `id` of the keywords which you want to retrieve.
|
|
273
410
|
*/
|
|
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 */
|
|
274
421
|
/** @typedef GetCatalogConfigurationParam */
|
|
275
422
|
/**
|
|
276
423
|
* @typedef GetCatalogInsightsParam
|
|
277
|
-
* @property {string} [brand] - Brand slug
|
|
424
|
+
* @property {string} [brand] - Brand slug
|
|
278
425
|
*/
|
|
279
426
|
/**
|
|
280
427
|
* @typedef GetCategoriesParam
|
|
281
428
|
* @property {string} [department] - The name of the department. Use this
|
|
282
429
|
* parameter to filter products by a particular department. See below the list
|
|
283
430
|
* of available departments. You can retrieve available departments from the
|
|
284
|
-
*
|
|
431
|
+
* **v1.0/departments/** API
|
|
285
432
|
*/
|
|
286
433
|
/**
|
|
287
434
|
* @typedef GetCollectionDetailParam
|
|
@@ -294,11 +441,14 @@ export = CatalogPlatformApplicationValidator;
|
|
|
294
441
|
* @property {string} id - A `id` is a unique identifier of a collection.
|
|
295
442
|
* @property {string} [sortOn] - Each response will contain sort_on param, which
|
|
296
443
|
* 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.
|
|
299
444
|
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
300
445
|
* Default is 12.
|
|
301
446
|
* @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.
|
|
302
452
|
*/
|
|
303
453
|
/**
|
|
304
454
|
* @typedef GetConfigurationByTypeParam
|
|
@@ -310,18 +460,18 @@ export = CatalogPlatformApplicationValidator;
|
|
|
310
460
|
* a specific type of configuration.
|
|
311
461
|
* @property {string} [templateSlug] - Get configuration list filtered by
|
|
312
462
|
* `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.
|
|
317
463
|
*/
|
|
318
464
|
/** @typedef GetConfigurationsParam */
|
|
465
|
+
/**
|
|
466
|
+
* @typedef GetConfigurationsFilterMetadataParam
|
|
467
|
+
* @property {string} filter - Filter whose values needs to be fetched.
|
|
468
|
+
*/
|
|
319
469
|
/** @typedef GetDepartmentsParam */
|
|
320
470
|
/**
|
|
321
471
|
* @typedef GetDiscountedInventoryBySizeIdentifierParam
|
|
322
|
-
* @property {number} itemId -
|
|
472
|
+
* @property {number} itemId - Item code of the product of which size is to be get.
|
|
323
473
|
* @property {number} sizeIdentifier - Size Identifier (Seller Identifier or
|
|
324
|
-
* Primary Identifier).
|
|
474
|
+
* Primary Identifier) of which inventory is to get.
|
|
325
475
|
* @property {number} [pageNo] - The page number to navigate through the given
|
|
326
476
|
* set of results
|
|
327
477
|
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
@@ -349,12 +499,65 @@ export = CatalogPlatformApplicationValidator;
|
|
|
349
499
|
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
350
500
|
* Default is 12.
|
|
351
501
|
* @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.
|
|
352
543
|
*/
|
|
353
544
|
/**
|
|
354
545
|
* @typedef GetProductDetailBySlugParam
|
|
355
546
|
* @property {string} slug - The unique identifier of a product. i.e; `slug` of
|
|
356
547
|
* a product. You can retrieve these from the APIs that list products like
|
|
357
|
-
*
|
|
548
|
+
* **v1.0/products/**
|
|
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.
|
|
358
561
|
*/
|
|
359
562
|
/** @typedef GetQueryFiltersParam */
|
|
360
563
|
/** @typedef GetSearchConfigurationParam */
|
|
@@ -363,20 +566,63 @@ export = CatalogPlatformApplicationValidator;
|
|
|
363
566
|
* @property {string} id - A `id` is a unique identifier for a particular
|
|
364
567
|
* detail. Pass the `id` of the keywords which you want to retrieve.
|
|
365
568
|
*/
|
|
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
|
+
*/
|
|
366
614
|
/**
|
|
367
615
|
* @typedef UpdateAllowSingleParam
|
|
368
|
-
* @property {CatalogPlatformModel.
|
|
616
|
+
* @property {CatalogPlatformModel.AllowSingleRequest} body
|
|
369
617
|
*/
|
|
370
618
|
/**
|
|
371
619
|
* @typedef UpdateAppBrandParam
|
|
372
|
-
* @property {number} brandUid -
|
|
373
|
-
* particular brand.
|
|
620
|
+
* @property {number} brandUid - Brand id for which the custom_json is associated.
|
|
374
621
|
* @property {CatalogPlatformModel.ApplicationBrandJson} body
|
|
375
622
|
*/
|
|
376
623
|
/**
|
|
377
624
|
* @typedef UpdateAppCategoryParam
|
|
378
|
-
* @property {
|
|
379
|
-
* particular category.
|
|
625
|
+
* @property {number} categoryUid - Category id for which the custom_json is associated.
|
|
380
626
|
* @property {CatalogPlatformModel.ApplicationCategoryJson} body
|
|
381
627
|
*/
|
|
382
628
|
/**
|
|
@@ -385,8 +631,8 @@ export = CatalogPlatformApplicationValidator;
|
|
|
385
631
|
*/
|
|
386
632
|
/**
|
|
387
633
|
* @typedef UpdateAppDepartmentParam
|
|
388
|
-
* @property {number} departmentUid -
|
|
389
|
-
*
|
|
634
|
+
* @property {number} departmentUid - Department id for which the custom_json is
|
|
635
|
+
* associated.
|
|
390
636
|
* @property {CatalogPlatformModel.ApplicationDepartmentJson} body
|
|
391
637
|
*/
|
|
392
638
|
/**
|
|
@@ -396,7 +642,7 @@ export = CatalogPlatformApplicationValidator;
|
|
|
396
642
|
*/
|
|
397
643
|
/**
|
|
398
644
|
* @typedef UpdateAppProductParam
|
|
399
|
-
* @property {number} itemId -
|
|
645
|
+
* @property {number} itemId - Product id for which the custom_meta is associated.
|
|
400
646
|
* @property {CatalogPlatformModel.ApplicationItemMeta} body
|
|
401
647
|
*/
|
|
402
648
|
/**
|
|
@@ -409,6 +655,12 @@ export = CatalogPlatformApplicationValidator;
|
|
|
409
655
|
* detail. Pass the `id` of the keywords which you want to delete.
|
|
410
656
|
* @property {CatalogPlatformModel.CreateAutocompleteKeyword} body
|
|
411
657
|
*/
|
|
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
|
+
*/
|
|
412
664
|
/**
|
|
413
665
|
* @typedef UpdateCollectionParam
|
|
414
666
|
* @property {string} id - A `id` is a unique identifier of a collection.
|
|
@@ -416,7 +668,7 @@ export = CatalogPlatformApplicationValidator;
|
|
|
416
668
|
*/
|
|
417
669
|
/**
|
|
418
670
|
* @typedef UpdateDefaultSortParam
|
|
419
|
-
* @property {CatalogPlatformModel.
|
|
671
|
+
* @property {CatalogPlatformModel.DefaultKeyRequest} body
|
|
420
672
|
*/
|
|
421
673
|
/**
|
|
422
674
|
* @typedef UpdateGroupConfigurationParam
|
|
@@ -432,11 +684,41 @@ export = CatalogPlatformApplicationValidator;
|
|
|
432
684
|
* particular listing configuration type.
|
|
433
685
|
* @property {string} configId - A `config_id` is a unique identifier of a
|
|
434
686
|
* particular configuration.
|
|
435
|
-
* @property {CatalogPlatformModel.
|
|
687
|
+
* @property {CatalogPlatformModel.AppConfigurationsFilterResponse} body
|
|
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
|
|
436
718
|
*/
|
|
437
719
|
/**
|
|
438
720
|
* @typedef UpdateSearchConfigurationParam
|
|
439
|
-
* @property {CatalogPlatformModel.
|
|
721
|
+
* @property {CatalogPlatformModel.UpdateSearchConfigurationRequest} body
|
|
440
722
|
*/
|
|
441
723
|
/**
|
|
442
724
|
* @typedef UpdateSearchKeywordsParam
|
|
@@ -444,13 +726,47 @@ export = CatalogPlatformApplicationValidator;
|
|
|
444
726
|
* detail. Pass the `id` of the keywords which you want to delete.
|
|
445
727
|
* @property {CatalogPlatformModel.CreateSearchKeyword} body
|
|
446
728
|
*/
|
|
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
|
+
*/
|
|
447
755
|
declare class CatalogPlatformApplicationValidator {
|
|
448
756
|
/** @returns {AddCollectionItemsParam} */
|
|
449
757
|
static addCollectionItems(): AddCollectionItemsParam;
|
|
758
|
+
/** @returns {AddProductsInPriceFactoryByZoneIdParam} */
|
|
759
|
+
static addProductsInPriceFactoryByZoneId(): AddProductsInPriceFactoryByZoneIdParam;
|
|
760
|
+
/** @returns {ClearCollectionItemsPriorityParam} */
|
|
761
|
+
static clearCollectionItemsPriority(): ClearCollectionItemsPriorityParam;
|
|
450
762
|
/** @returns {CreateAppCategoryReturnConfigurationParam} */
|
|
451
763
|
static createAppCategoryReturnConfiguration(): CreateAppCategoryReturnConfigurationParam;
|
|
764
|
+
/** @returns {CreateAppPriceFactoryParam} */
|
|
765
|
+
static createAppPriceFactory(): CreateAppPriceFactoryParam;
|
|
452
766
|
/** @returns {CreateAppReturnConfigurationParam} */
|
|
453
767
|
static createAppReturnConfiguration(): CreateAppReturnConfigurationParam;
|
|
768
|
+
/** @returns {CreateAutocompleteSettingsParam} */
|
|
769
|
+
static createAutocompleteSettings(): CreateAutocompleteSettingsParam;
|
|
454
770
|
/** @returns {CreateCollectionParam} */
|
|
455
771
|
static createCollection(): CreateCollectionParam;
|
|
456
772
|
/** @returns {CreateConfigurationByTypeParam} */
|
|
@@ -465,8 +781,24 @@ declare class CatalogPlatformApplicationValidator {
|
|
|
465
781
|
static createGroupConfiguration(): CreateGroupConfigurationParam;
|
|
466
782
|
/** @returns {CreateListingConfigurationParam} */
|
|
467
783
|
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;
|
|
468
796
|
/** @returns {CreateSearchConfigurationParam} */
|
|
469
797
|
static createSearchConfiguration(): CreateSearchConfigurationParam;
|
|
798
|
+
/** @returns {CreateSearchRerankParam} */
|
|
799
|
+
static createSearchRerank(): CreateSearchRerankParam;
|
|
800
|
+
/** @returns {CreateSynonymsParam} */
|
|
801
|
+
static createSynonyms(): CreateSynonymsParam;
|
|
470
802
|
/** @returns {DeleteAppCategoryReturnConfigurationParam} */
|
|
471
803
|
static deleteAppCategoryReturnConfiguration(): DeleteAppCategoryReturnConfigurationParam;
|
|
472
804
|
/** @returns {DeleteAutocompleteKeywordParam} */
|
|
@@ -477,26 +809,50 @@ declare class CatalogPlatformApplicationValidator {
|
|
|
477
809
|
static deleteGroupConfiguration(): DeleteGroupConfigurationParam;
|
|
478
810
|
/** @returns {DeleteListingConfigurationParam} */
|
|
479
811
|
static deleteListingConfiguration(): DeleteListingConfigurationParam;
|
|
812
|
+
/** @returns {DeleteMerchandisingRuleParam} */
|
|
813
|
+
static deleteMerchandisingRule(): DeleteMerchandisingRuleParam;
|
|
814
|
+
/** @returns {DeleteMerchandisingRulesPreviewParam} */
|
|
815
|
+
static deleteMerchandisingRulesPreview(): DeleteMerchandisingRulesPreviewParam;
|
|
480
816
|
/** @returns {DeleteSearchConfigurationParam} */
|
|
481
817
|
static deleteSearchConfiguration(): any;
|
|
482
818
|
/** @returns {DeleteSearchKeywordsParam} */
|
|
483
819
|
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;
|
|
484
830
|
/** @returns {GetAllCollectionsParam} */
|
|
485
831
|
static getAllCollections(): GetAllCollectionsParam;
|
|
486
832
|
/** @returns {GetAllSearchKeywordParam} */
|
|
487
|
-
static getAllSearchKeyword():
|
|
833
|
+
static getAllSearchKeyword(): GetAllSearchKeywordParam;
|
|
488
834
|
/** @returns {GetAppCategoryReturnConfigParam} */
|
|
489
835
|
static getAppCategoryReturnConfig(): GetAppCategoryReturnConfigParam;
|
|
490
836
|
/** @returns {GetAppInventoryParam} */
|
|
491
837
|
static getAppInventory(): GetAppInventoryParam;
|
|
492
838
|
/** @returns {GetAppLocationsParam} */
|
|
493
839
|
static getAppLocations(): GetAppLocationsParam;
|
|
840
|
+
/** @returns {GetAppPriceByIdParam} */
|
|
841
|
+
static getAppPriceById(): GetAppPriceByIdParam;
|
|
842
|
+
/** @returns {GetAppPriceFactoriesParam} */
|
|
843
|
+
static getAppPriceFactories(): GetAppPriceFactoriesParam;
|
|
844
|
+
/** @returns {GetAppPriceFactoryParam} */
|
|
845
|
+
static getAppPriceFactory(): GetAppPriceFactoryParam;
|
|
494
846
|
/** @returns {GetAppProductParam} */
|
|
495
847
|
static getAppProduct(): GetAppProductParam;
|
|
848
|
+
/** @returns {GetAppProductPricesParam} */
|
|
849
|
+
static getAppProductPrices(): GetAppProductPricesParam;
|
|
496
850
|
/** @returns {GetAppProductsParam} */
|
|
497
851
|
static getAppProducts(): GetAppProductsParam;
|
|
498
852
|
/** @returns {GetAppReturnConfigurationParam} */
|
|
499
853
|
static getAppReturnConfiguration(): any;
|
|
854
|
+
/** @returns {GetAppicationProductsParam} */
|
|
855
|
+
static getAppicationProducts(): GetAppicationProductsParam;
|
|
500
856
|
/** @returns {GetApplicationBrandListingParam} */
|
|
501
857
|
static getApplicationBrandListing(): GetApplicationBrandListingParam;
|
|
502
858
|
/** @returns {GetApplicationBrandsParam} */
|
|
@@ -509,12 +865,14 @@ declare class CatalogPlatformApplicationValidator {
|
|
|
509
865
|
static getApplicationFilterKeys(): GetApplicationFilterKeysParam;
|
|
510
866
|
/** @returns {GetApplicationFilterValuesParam} */
|
|
511
867
|
static getApplicationFilterValues(): GetApplicationFilterValuesParam;
|
|
512
|
-
/** @returns {GetApplicationProductsParam} */
|
|
513
|
-
static getApplicationProducts(): GetApplicationProductsParam;
|
|
514
868
|
/** @returns {GetAutocompleteConfigParam} */
|
|
515
|
-
static getAutocompleteConfig():
|
|
869
|
+
static getAutocompleteConfig(): GetAutocompleteConfigParam;
|
|
516
870
|
/** @returns {GetAutocompleteKeywordDetailParam} */
|
|
517
871
|
static getAutocompleteKeywordDetail(): GetAutocompleteKeywordDetailParam;
|
|
872
|
+
/** @returns {GetAutocompletePreviewParam} */
|
|
873
|
+
static getAutocompletePreview(): GetAutocompletePreviewParam;
|
|
874
|
+
/** @returns {GetAutocompleteSettingsParam} */
|
|
875
|
+
static getAutocompleteSettings(): any;
|
|
518
876
|
/** @returns {GetCatalogConfigurationParam} */
|
|
519
877
|
static getCatalogConfiguration(): any;
|
|
520
878
|
/** @returns {GetCatalogInsightsParam} */
|
|
@@ -531,6 +889,8 @@ declare class CatalogPlatformApplicationValidator {
|
|
|
531
889
|
static getConfigurationMetadata(): GetConfigurationMetadataParam;
|
|
532
890
|
/** @returns {GetConfigurationsParam} */
|
|
533
891
|
static getConfigurations(): any;
|
|
892
|
+
/** @returns {GetConfigurationsFilterMetadataParam} */
|
|
893
|
+
static getConfigurationsFilterMetadata(): GetConfigurationsFilterMetadataParam;
|
|
534
894
|
/** @returns {GetDepartmentsParam} */
|
|
535
895
|
static getDepartments(): any;
|
|
536
896
|
/** @returns {GetDiscountedInventoryBySizeIdentifierParam} */
|
|
@@ -539,14 +899,50 @@ declare class CatalogPlatformApplicationValidator {
|
|
|
539
899
|
static getGroupConfigurations(): GetGroupConfigurationsParam;
|
|
540
900
|
/** @returns {GetListingConfigurationsParam} */
|
|
541
901
|
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;
|
|
542
916
|
/** @returns {GetProductDetailBySlugParam} */
|
|
543
917
|
static getProductDetailBySlug(): GetProductDetailBySlugParam;
|
|
918
|
+
/** @returns {GetProductsInPriceFactoryByZoneIdParam} */
|
|
919
|
+
static getProductsInPriceFactoryByZoneId(): GetProductsInPriceFactoryByZoneIdParam;
|
|
544
920
|
/** @returns {GetQueryFiltersParam} */
|
|
545
921
|
static getQueryFilters(): any;
|
|
546
922
|
/** @returns {GetSearchConfigurationParam} */
|
|
547
923
|
static getSearchConfiguration(): any;
|
|
548
924
|
/** @returns {GetSearchKeywordsParam} */
|
|
549
925
|
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;
|
|
550
946
|
/** @returns {UpdateAllowSingleParam} */
|
|
551
947
|
static updateAllowSingle(): UpdateAllowSingleParam;
|
|
552
948
|
/** @returns {UpdateAppBrandParam} */
|
|
@@ -565,6 +961,8 @@ declare class CatalogPlatformApplicationValidator {
|
|
|
565
961
|
static updateAppReturnConfiguration(): UpdateAppReturnConfigurationParam;
|
|
566
962
|
/** @returns {UpdateAutocompleteKeywordParam} */
|
|
567
963
|
static updateAutocompleteKeyword(): UpdateAutocompleteKeywordParam;
|
|
964
|
+
/** @returns {UpdateAutocompleteSettingsParam} */
|
|
965
|
+
static updateAutocompleteSettings(): UpdateAutocompleteSettingsParam;
|
|
568
966
|
/** @returns {UpdateCollectionParam} */
|
|
569
967
|
static updateCollection(): UpdateCollectionParam;
|
|
570
968
|
/** @returns {UpdateDefaultSortParam} */
|
|
@@ -573,13 +971,33 @@ declare class CatalogPlatformApplicationValidator {
|
|
|
573
971
|
static updateGroupConfiguration(): UpdateGroupConfigurationParam;
|
|
574
972
|
/** @returns {UpdateListingConfigurationParam} */
|
|
575
973
|
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;
|
|
576
984
|
/** @returns {UpdateSearchConfigurationParam} */
|
|
577
985
|
static updateSearchConfiguration(): UpdateSearchConfigurationParam;
|
|
578
986
|
/** @returns {UpdateSearchKeywordsParam} */
|
|
579
987
|
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;
|
|
580
998
|
}
|
|
581
999
|
declare namespace CatalogPlatformApplicationValidator {
|
|
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,
|
|
1000
|
+
export { AddCollectionItemsParam, AddProductsInPriceFactoryByZoneIdParam, ClearCollectionItemsPriorityParam, CreateAppCategoryReturnConfigurationParam, CreateAppPriceFactoryParam, CreateAppReturnConfigurationParam, CreateAutocompleteSettingsParam, CreateCollectionParam, CreateConfigurationByTypeParam, CreateConfigurationProductListingParam, CreateCustomAutocompleteRuleParam, CreateCustomKeywordParam, CreateGroupConfigurationParam, CreateListingConfigurationParam, CreateMerchandisingRuleBoostActionParam, CreateMerchandisingRuleBuryActionParam, CreateMerchandisingRuleHideActionParam, CreateMerchandisingRulePinActionParam, CreateMerchandisingRuleQueryParam, CreateProductPriceFactoryBulkJobParam, CreateSearchConfigurationParam, CreateSearchRerankParam, CreateSynonymsParam, DeleteAppCategoryReturnConfigurationParam, DeleteAutocompleteKeywordParam, DeleteCollectionParam, DeleteGroupConfigurationParam, DeleteListingConfigurationParam, DeleteMerchandisingRuleParam, DeleteMerchandisingRulesPreviewParam, DeleteSearchConfigurationParam, DeleteSearchKeywordsParam, DeleteSearchRerankConfigurationParam, DeleteSynonymParam, EditAppPriceFactoryParam, ExportProductsInPriceFactoryParam, ExportSynonymsParam, GetAllCollectionsParam, GetAllSearchKeywordParam, GetAppCategoryReturnConfigParam, GetAppInventoryParam, GetAppLocationsParam, GetAppPriceByIdParam, GetAppPriceFactoriesParam, GetAppPriceFactoryParam, GetAppProductParam, GetAppProductPricesParam, GetAppProductsParam, GetAppReturnConfigurationParam, GetAppicationProductsParam, GetApplicationBrandListingParam, GetApplicationBrandsParam, GetApplicationCategoryListingParam, GetApplicationDepartmentListingParam, GetApplicationFilterKeysParam, GetApplicationFilterValuesParam, GetAutocompleteConfigParam, GetAutocompleteKeywordDetailParam, GetAutocompletePreviewParam, GetAutocompleteSettingsParam, GetCatalogConfigurationParam, GetCatalogInsightsParam, GetCategoriesParam, GetCollectionDetailParam, GetCollectionItemsParam, GetConfigurationByTypeParam, GetConfigurationMetadataParam, GetConfigurationsParam, GetConfigurationsFilterMetadataParam, GetDepartmentsParam, GetDiscountedInventoryBySizeIdentifierParam, GetGroupConfigurationsParam, GetListingConfigurationsParam, GetLivePreviewParam, GetMerchandisingQueryParam, GetMerchandisingRuleBoostActionParam, GetMerchandisingRuleBuryActionParam, GetMerchandisingRuleHideActionParam, GetMerchandisingRulePinActionParam, GetMerchandisingRulesParam, GetProductDetailBySlugParam, GetProductsInPriceFactoryByZoneIdParam, GetQueryFiltersParam, GetSearchConfigurationParam, GetSearchKeywordsParam, GetSearchRerankParam, GetSearchRerankDetailParam, GetSynonymsParam, PollBulkSynonymsParam, PollPriceFactoryJobsParam, PollProductPriceFactoryBulkJobParam, ProcessBulkSynonymsParam, ProcessProductPriceFactoryBulkJobParam, SampleBulkSynonymsFileParam, SaveMerchandisingRulesParam, UpdateAllowSingleParam, UpdateAppBrandParam, UpdateAppCategoryParam, UpdateAppCategoryReturnConfigurationParam, UpdateAppDepartmentParam, UpdateAppLocationParam, UpdateAppProductParam, UpdateAppReturnConfigurationParam, UpdateAutocompleteKeywordParam, UpdateAutocompleteSettingsParam, UpdateCollectionParam, UpdateDefaultSortParam, UpdateGroupConfigurationParam, UpdateListingConfigurationParam, UpdateMerchandisingRuleBoostActionParam, UpdateMerchandisingRuleBuryActionParam, UpdateMerchandisingRuleHideActionParam, UpdateMerchandisingRulePinActionParam, UpdateMerchandisingRuleQueryParam, UpdateSearchConfigurationParam, UpdateSearchKeywordsParam, UpdateSearchRerankConfigurationParam, UpdateSynonymsParam, UploadSynonymsParam, ValidateBulkSynonymsParam, ValidateProductPriceFactoryBulkJobParam };
|
|
583
1001
|
}
|
|
584
1002
|
type AddCollectionItemsParam = {
|
|
585
1003
|
/**
|
|
@@ -588,44 +1006,32 @@ type AddCollectionItemsParam = {
|
|
|
588
1006
|
id: string;
|
|
589
1007
|
body: CatalogPlatformModel.CollectionItemUpdateSchema;
|
|
590
1008
|
};
|
|
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
|
+
};
|
|
591
1022
|
type CreateAppCategoryReturnConfigurationParam = {
|
|
592
1023
|
body: CatalogPlatformModel.BaseAppCategoryReturnConfig;
|
|
593
1024
|
};
|
|
1025
|
+
type CreateAppPriceFactoryParam = {
|
|
1026
|
+
body: CatalogPlatformModel.CreateAppPriceFactoryRequestSchema;
|
|
1027
|
+
};
|
|
594
1028
|
type CreateAppReturnConfigurationParam = {
|
|
595
1029
|
body: CatalogPlatformModel.CreateUpdateAppReturnConfig;
|
|
596
1030
|
};
|
|
1031
|
+
type CreateAutocompleteSettingsParam = {
|
|
1032
|
+
body: CatalogPlatformModel.AutocompleteRequestSchema;
|
|
1033
|
+
};
|
|
597
1034
|
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;
|
|
629
1035
|
body: CatalogPlatformModel.CreateCollection;
|
|
630
1036
|
};
|
|
631
1037
|
type CreateConfigurationByTypeParam = {
|
|
@@ -650,7 +1056,7 @@ type CreateGroupConfigurationParam = {
|
|
|
650
1056
|
* particular group configuration type.
|
|
651
1057
|
*/
|
|
652
1058
|
configType: string;
|
|
653
|
-
body: CatalogPlatformModel.
|
|
1059
|
+
body: CatalogPlatformModel.AppConfigurationCreateDetail;
|
|
654
1060
|
};
|
|
655
1061
|
type CreateListingConfigurationParam = {
|
|
656
1062
|
/**
|
|
@@ -658,24 +1064,72 @@ type CreateListingConfigurationParam = {
|
|
|
658
1064
|
* particular listing configuration type.
|
|
659
1065
|
*/
|
|
660
1066
|
configType: string;
|
|
661
|
-
body: CatalogPlatformModel.
|
|
662
|
-
};
|
|
663
|
-
type CreateSearchConfigurationParam = {
|
|
664
|
-
body: CatalogPlatformModel.CreateSearchConfigurationRequestSchema;
|
|
665
|
-
};
|
|
666
|
-
type DeleteAppCategoryReturnConfigurationParam = {
|
|
667
|
-
body: CatalogPlatformModel.DeleteAppCategoryReturnConfig;
|
|
1067
|
+
body: CatalogPlatformModel.AppConfigurationsFilter;
|
|
668
1068
|
};
|
|
669
|
-
type
|
|
1069
|
+
type CreateMerchandisingRuleBoostActionParam = {
|
|
670
1070
|
/**
|
|
671
|
-
* - A `
|
|
672
|
-
*
|
|
1071
|
+
* - A `merchandising_rule_id` is a
|
|
1072
|
+
* unique identifier for a particular merchandising rule.
|
|
673
1073
|
*/
|
|
674
|
-
|
|
1074
|
+
merchandisingRuleId: string;
|
|
1075
|
+
body: CatalogPlatformModel.PostMerchandisingRuleBoostAction;
|
|
675
1076
|
};
|
|
676
|
-
type
|
|
1077
|
+
type CreateMerchandisingRuleBuryActionParam = {
|
|
677
1078
|
/**
|
|
678
|
-
* - A `
|
|
1079
|
+
* - A `merchandising_rule_id` is a
|
|
1080
|
+
* unique identifier for a particular merchandising rule.
|
|
1081
|
+
*/
|
|
1082
|
+
merchandisingRuleId: string;
|
|
1083
|
+
body: CatalogPlatformModel.PostMerchandisingRuleBoostAction;
|
|
1084
|
+
};
|
|
1085
|
+
type CreateMerchandisingRuleHideActionParam = {
|
|
1086
|
+
/**
|
|
1087
|
+
* - A `merchandising_rule_id` is a
|
|
1088
|
+
* unique identifier for a particular merchandising rule.
|
|
1089
|
+
*/
|
|
1090
|
+
merchandisingRuleId: string;
|
|
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;
|
|
1129
|
+
};
|
|
1130
|
+
type DeleteCollectionParam = {
|
|
1131
|
+
/**
|
|
1132
|
+
* - A `id` is a unique identifier of a collection.
|
|
679
1133
|
*/
|
|
680
1134
|
id: string;
|
|
681
1135
|
};
|
|
@@ -703,6 +1157,20 @@ type DeleteListingConfigurationParam = {
|
|
|
703
1157
|
*/
|
|
704
1158
|
configId: string;
|
|
705
1159
|
};
|
|
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
|
+
};
|
|
706
1174
|
type DeleteSearchKeywordsParam = {
|
|
707
1175
|
/**
|
|
708
1176
|
* - A `id` is a unique identifier for a particular
|
|
@@ -710,6 +1178,34 @@ type DeleteSearchKeywordsParam = {
|
|
|
710
1178
|
*/
|
|
711
1179
|
id: string;
|
|
712
1180
|
};
|
|
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
|
+
};
|
|
713
1209
|
type GetAllCollectionsParam = {
|
|
714
1210
|
/**
|
|
715
1211
|
* - Get collection list filtered by q string,
|
|
@@ -727,7 +1223,7 @@ type GetAllCollectionsParam = {
|
|
|
727
1223
|
* - Each response will contain next_id param, which
|
|
728
1224
|
* should be sent back to make pagination work.
|
|
729
1225
|
*/
|
|
730
|
-
|
|
1226
|
+
tag?: string[];
|
|
731
1227
|
/**
|
|
732
1228
|
* - Get collections filtered by active status.
|
|
733
1229
|
*/
|
|
@@ -743,6 +1239,28 @@ type GetAllCollectionsParam = {
|
|
|
743
1239
|
*/
|
|
744
1240
|
pageSize?: number;
|
|
745
1241
|
};
|
|
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
|
+
};
|
|
746
1264
|
type GetAppCategoryReturnConfigParam = {
|
|
747
1265
|
/**
|
|
748
1266
|
* - Get return configurations for categories by matching
|
|
@@ -853,12 +1371,92 @@ type GetAppLocationsParam = {
|
|
|
853
1371
|
* - Get locations filtered by store types.
|
|
854
1372
|
*/
|
|
855
1373
|
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;
|
|
856
1432
|
};
|
|
857
1433
|
type GetAppProductParam = {
|
|
858
1434
|
/**
|
|
859
1435
|
* - Product id for a particular product.
|
|
860
1436
|
*/
|
|
861
|
-
itemId:
|
|
1437
|
+
itemId: number;
|
|
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;
|
|
862
1460
|
};
|
|
863
1461
|
type GetAppProductsParam = {
|
|
864
1462
|
/**
|
|
@@ -896,6 +1494,66 @@ type GetAppProductsParam = {
|
|
|
896
1494
|
*/
|
|
897
1495
|
q?: string;
|
|
898
1496
|
};
|
|
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
|
+
};
|
|
899
1557
|
type GetApplicationBrandListingParam = {
|
|
900
1558
|
/**
|
|
901
1559
|
* - The page number to navigate through the given
|
|
@@ -908,7 +1566,7 @@ type GetApplicationBrandListingParam = {
|
|
|
908
1566
|
*/
|
|
909
1567
|
pageSize?: number;
|
|
910
1568
|
/**
|
|
911
|
-
* - Search query with brand name.
|
|
1569
|
+
* - Search query with brand name.Use this parameter to
|
|
912
1570
|
* search brands by brand name.
|
|
913
1571
|
*/
|
|
914
1572
|
q?: string;
|
|
@@ -918,7 +1576,7 @@ type GetApplicationBrandsParam = {
|
|
|
918
1576
|
* - The name of the department. Use this
|
|
919
1577
|
* parameter to filter products by a particular department. See below the list
|
|
920
1578
|
* of available departments. You can retrieve available departments from the
|
|
921
|
-
*
|
|
1579
|
+
* **v1.0/departments/** API
|
|
922
1580
|
*/
|
|
923
1581
|
department?: string;
|
|
924
1582
|
/**
|
|
@@ -932,7 +1590,7 @@ type GetApplicationBrandsParam = {
|
|
|
932
1590
|
*/
|
|
933
1591
|
pageSize?: number;
|
|
934
1592
|
/**
|
|
935
|
-
* - Search query with brand name.
|
|
1593
|
+
* - Search query with brand name.Use this parameter to
|
|
936
1594
|
* search brands by brand name.
|
|
937
1595
|
*/
|
|
938
1596
|
q?: string;
|
|
@@ -959,8 +1617,8 @@ type GetApplicationCategoryListingParam = {
|
|
|
959
1617
|
*/
|
|
960
1618
|
pageSize?: number;
|
|
961
1619
|
/**
|
|
962
|
-
* -
|
|
963
|
-
*
|
|
1620
|
+
* - Search query with brand name.Use this parameter to
|
|
1621
|
+
* search brands by brand name.
|
|
964
1622
|
*/
|
|
965
1623
|
q?: string;
|
|
966
1624
|
};
|
|
@@ -976,34 +1634,36 @@ type GetApplicationDepartmentListingParam = {
|
|
|
976
1634
|
*/
|
|
977
1635
|
pageSize?: number;
|
|
978
1636
|
/**
|
|
979
|
-
* -
|
|
980
|
-
*
|
|
1637
|
+
* - Search query with brand name.Use this parameter to
|
|
1638
|
+
* search department by name.
|
|
981
1639
|
*/
|
|
982
1640
|
q?: string;
|
|
983
1641
|
};
|
|
984
1642
|
type GetApplicationFilterKeysParam = {
|
|
985
1643
|
/**
|
|
986
1644
|
* - The search filter parameters for collection items.
|
|
987
|
-
* All the parameter filtered from filter parameters will be passed in
|
|
988
|
-
* parameter in this format.
|
|
1645
|
+
* All the parameter filtered from filter parameters will be passed in **c**
|
|
1646
|
+
* parameter in this format.
|
|
1647
|
+
* **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
|
|
989
1648
|
*/
|
|
990
1649
|
c?: string;
|
|
991
1650
|
};
|
|
992
1651
|
type GetApplicationFilterValuesParam = {
|
|
993
1652
|
/**
|
|
994
|
-
* - A `filter_key` is a filter key which
|
|
995
|
-
* all the available filter values.
|
|
1653
|
+
* - A `filter_key` is a filter key for a for which
|
|
1654
|
+
* all the available filter values will returned. channel.
|
|
996
1655
|
*/
|
|
997
1656
|
filterKey: string;
|
|
998
1657
|
/**
|
|
999
1658
|
* - The search filter parameters for collection items.
|
|
1000
|
-
* All the parameter filtered from filter parameters will be passed in
|
|
1001
|
-
* parameter in this format.
|
|
1659
|
+
* All the parameter filtered from filter parameters will be passed in **c**
|
|
1660
|
+
* parameter in this format.
|
|
1661
|
+
* **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
|
|
1002
1662
|
*/
|
|
1003
1663
|
c?: string;
|
|
1004
1664
|
/**
|
|
1005
1665
|
* - A `collection_id` is a unique identifier
|
|
1006
|
-
* for a particular collection.
|
|
1666
|
+
* for a particular collection. channel.
|
|
1007
1667
|
*/
|
|
1008
1668
|
collectionId?: string;
|
|
1009
1669
|
/**
|
|
@@ -1017,83 +1677,68 @@ type GetApplicationFilterValuesParam = {
|
|
|
1017
1677
|
*/
|
|
1018
1678
|
pageSize?: number;
|
|
1019
1679
|
/**
|
|
1020
|
-
* -
|
|
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.
|
|
1680
|
+
* - Get Values filtered by q string
|
|
1024
1681
|
*/
|
|
1025
1682
|
q?: string;
|
|
1026
1683
|
};
|
|
1027
|
-
type
|
|
1684
|
+
type GetAutocompleteConfigParam = {
|
|
1028
1685
|
/**
|
|
1029
|
-
* - The
|
|
1030
|
-
*
|
|
1031
|
-
*/
|
|
1032
|
-
q?: string;
|
|
1033
|
-
/**
|
|
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**
|
|
1686
|
+
* - The page number to navigate through the given
|
|
1687
|
+
* set of results
|
|
1037
1688
|
*/
|
|
1038
|
-
|
|
1689
|
+
pageNo?: number;
|
|
1039
1690
|
/**
|
|
1040
|
-
* -
|
|
1041
|
-
*
|
|
1042
|
-
* parameter in this format.
|
|
1043
|
-
* **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
|
|
1691
|
+
* - Number of items to retrieve in each page.
|
|
1692
|
+
* Default is 12.
|
|
1044
1693
|
*/
|
|
1045
|
-
|
|
1694
|
+
pageSize?: number;
|
|
1046
1695
|
/**
|
|
1047
|
-
* -
|
|
1048
|
-
*
|
|
1696
|
+
* - Search query with words name.Use this parameter to
|
|
1697
|
+
* search keywords by words.
|
|
1049
1698
|
*/
|
|
1050
|
-
|
|
1699
|
+
q?: string;
|
|
1051
1700
|
/**
|
|
1052
|
-
* -
|
|
1053
|
-
*
|
|
1701
|
+
* - Can query for keywords based on whether they
|
|
1702
|
+
* are active or inactive.
|
|
1054
1703
|
*/
|
|
1055
|
-
|
|
1704
|
+
isActive?: boolean;
|
|
1705
|
+
};
|
|
1706
|
+
type GetAutocompleteKeywordDetailParam = {
|
|
1056
1707
|
/**
|
|
1057
|
-
* -
|
|
1058
|
-
*
|
|
1059
|
-
* either ascending or descending order. See the supported values below.
|
|
1708
|
+
* - A `id` is a unique identifier for a particular
|
|
1709
|
+
* detail. Pass the `id` of the keywords which you want to retrieve.
|
|
1060
1710
|
*/
|
|
1061
|
-
|
|
1711
|
+
id: string;
|
|
1712
|
+
};
|
|
1713
|
+
type GetAutocompletePreviewParam = {
|
|
1062
1714
|
/**
|
|
1063
|
-
* -
|
|
1064
|
-
* which should be sent back to make pagination work.
|
|
1715
|
+
* - Get suggestions related to `q` string.
|
|
1065
1716
|
*/
|
|
1066
|
-
|
|
1717
|
+
q?: string;
|
|
1067
1718
|
/**
|
|
1068
|
-
* -
|
|
1069
|
-
* Default is 12.
|
|
1719
|
+
* - For getting related category suggestions.
|
|
1070
1720
|
*/
|
|
1071
|
-
|
|
1721
|
+
categorySuggestion?: number;
|
|
1072
1722
|
/**
|
|
1073
|
-
* -
|
|
1074
|
-
* page items. Default is 1.
|
|
1723
|
+
* - For getting related brand suggestions.
|
|
1075
1724
|
*/
|
|
1076
|
-
|
|
1725
|
+
brandSuggestion?: number;
|
|
1077
1726
|
/**
|
|
1078
|
-
* - For
|
|
1079
|
-
* number. Default is cursor.
|
|
1727
|
+
* - For getting collection suggestions.
|
|
1080
1728
|
*/
|
|
1081
|
-
|
|
1729
|
+
collectionSuggestion?: number;
|
|
1082
1730
|
/**
|
|
1083
|
-
* -
|
|
1731
|
+
* - For getting product suggestions.
|
|
1084
1732
|
*/
|
|
1085
|
-
|
|
1086
|
-
};
|
|
1087
|
-
type GetAutocompleteKeywordDetailParam = {
|
|
1733
|
+
productSuggestion?: number;
|
|
1088
1734
|
/**
|
|
1089
|
-
* -
|
|
1090
|
-
* detail. Pass the `id` of the keywords which you want to retrieve.
|
|
1735
|
+
* - For getting query suggestions.
|
|
1091
1736
|
*/
|
|
1092
|
-
|
|
1737
|
+
querySuggestion?: number;
|
|
1093
1738
|
};
|
|
1094
1739
|
type GetCatalogInsightsParam = {
|
|
1095
1740
|
/**
|
|
1096
|
-
* - Brand slug
|
|
1741
|
+
* - Brand slug
|
|
1097
1742
|
*/
|
|
1098
1743
|
brand?: string;
|
|
1099
1744
|
};
|
|
@@ -1102,7 +1747,7 @@ type GetCategoriesParam = {
|
|
|
1102
1747
|
* - The name of the department. Use this
|
|
1103
1748
|
* parameter to filter products by a particular department. See below the list
|
|
1104
1749
|
* of available departments. You can retrieve available departments from the
|
|
1105
|
-
*
|
|
1750
|
+
* **v1.0/departments/** API
|
|
1106
1751
|
*/
|
|
1107
1752
|
department?: string;
|
|
1108
1753
|
};
|
|
@@ -1124,11 +1769,6 @@ type GetCollectionItemsParam = {
|
|
|
1124
1769
|
* should be sent back to make pagination work.
|
|
1125
1770
|
*/
|
|
1126
1771
|
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;
|
|
1132
1772
|
/**
|
|
1133
1773
|
* - Number of items to retrieve in each page.
|
|
1134
1774
|
* Default is 12.
|
|
@@ -1138,6 +1778,20 @@ type GetCollectionItemsParam = {
|
|
|
1138
1778
|
* - Identifies the specific page of results being requested.
|
|
1139
1779
|
*/
|
|
1140
1780
|
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;
|
|
1141
1795
|
};
|
|
1142
1796
|
type GetConfigurationByTypeParam = {
|
|
1143
1797
|
/**
|
|
@@ -1156,28 +1810,21 @@ type GetConfigurationMetadataParam = {
|
|
|
1156
1810
|
* `template_slug` string. This is for the details and comparision groups.
|
|
1157
1811
|
*/
|
|
1158
1812
|
templateSlug?: string;
|
|
1813
|
+
};
|
|
1814
|
+
type GetConfigurationsFilterMetadataParam = {
|
|
1159
1815
|
/**
|
|
1160
|
-
* -
|
|
1161
|
-
* set of results.
|
|
1162
|
-
*/
|
|
1163
|
-
pageNo?: number;
|
|
1164
|
-
/**
|
|
1165
|
-
* - Number of items to retrieve in each page.
|
|
1166
|
-
*/
|
|
1167
|
-
pageSize?: number;
|
|
1168
|
-
/**
|
|
1169
|
-
* - Get configuration list filtered by `q` string.
|
|
1816
|
+
* - Filter whose values needs to be fetched.
|
|
1170
1817
|
*/
|
|
1171
|
-
|
|
1818
|
+
filter: string;
|
|
1172
1819
|
};
|
|
1173
1820
|
type GetDiscountedInventoryBySizeIdentifierParam = {
|
|
1174
1821
|
/**
|
|
1175
|
-
* -
|
|
1822
|
+
* - Item code of the product of which size is to be get.
|
|
1176
1823
|
*/
|
|
1177
1824
|
itemId: number;
|
|
1178
1825
|
/**
|
|
1179
1826
|
* - Size Identifier (Seller Identifier or
|
|
1180
|
-
* Primary Identifier).
|
|
1827
|
+
* Primary Identifier) of which inventory is to get.
|
|
1181
1828
|
*/
|
|
1182
1829
|
sizeIdentifier: number;
|
|
1183
1830
|
/**
|
|
@@ -1241,15 +1888,108 @@ type GetListingConfigurationsParam = {
|
|
|
1241
1888
|
* - Get configuration list filtered by `search` string.
|
|
1242
1889
|
*/
|
|
1243
1890
|
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;
|
|
1244
1955
|
};
|
|
1245
1956
|
type GetProductDetailBySlugParam = {
|
|
1246
1957
|
/**
|
|
1247
1958
|
* - The unique identifier of a product. i.e; `slug` of
|
|
1248
1959
|
* a product. You can retrieve these from the APIs that list products like
|
|
1249
|
-
*
|
|
1960
|
+
* **v1.0/products/**
|
|
1250
1961
|
*/
|
|
1251
1962
|
slug: string;
|
|
1252
1963
|
};
|
|
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
|
+
};
|
|
1253
1993
|
type GetSearchKeywordsParam = {
|
|
1254
1994
|
/**
|
|
1255
1995
|
* - A `id` is a unique identifier for a particular
|
|
@@ -1257,23 +1997,92 @@ type GetSearchKeywordsParam = {
|
|
|
1257
1997
|
*/
|
|
1258
1998
|
id: string;
|
|
1259
1999
|
};
|
|
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
|
+
};
|
|
1260
2071
|
type UpdateAllowSingleParam = {
|
|
1261
|
-
body: CatalogPlatformModel.
|
|
2072
|
+
body: CatalogPlatformModel.AllowSingleRequest;
|
|
1262
2073
|
};
|
|
1263
2074
|
type UpdateAppBrandParam = {
|
|
1264
2075
|
/**
|
|
1265
|
-
* -
|
|
1266
|
-
* particular brand.
|
|
2076
|
+
* - Brand id for which the custom_json is associated.
|
|
1267
2077
|
*/
|
|
1268
2078
|
brandUid: number;
|
|
1269
2079
|
body: CatalogPlatformModel.ApplicationBrandJson;
|
|
1270
2080
|
};
|
|
1271
2081
|
type UpdateAppCategoryParam = {
|
|
1272
2082
|
/**
|
|
1273
|
-
* -
|
|
1274
|
-
* particular category.
|
|
2083
|
+
* - Category id for which the custom_json is associated.
|
|
1275
2084
|
*/
|
|
1276
|
-
categoryUid:
|
|
2085
|
+
categoryUid: number;
|
|
1277
2086
|
body: CatalogPlatformModel.ApplicationCategoryJson;
|
|
1278
2087
|
};
|
|
1279
2088
|
type UpdateAppCategoryReturnConfigurationParam = {
|
|
@@ -1281,8 +2090,8 @@ type UpdateAppCategoryReturnConfigurationParam = {
|
|
|
1281
2090
|
};
|
|
1282
2091
|
type UpdateAppDepartmentParam = {
|
|
1283
2092
|
/**
|
|
1284
|
-
* -
|
|
1285
|
-
*
|
|
2093
|
+
* - Department id for which the custom_json is
|
|
2094
|
+
* associated.
|
|
1286
2095
|
*/
|
|
1287
2096
|
departmentUid: number;
|
|
1288
2097
|
body: CatalogPlatformModel.ApplicationDepartmentJson;
|
|
@@ -1296,7 +2105,7 @@ type UpdateAppLocationParam = {
|
|
|
1296
2105
|
};
|
|
1297
2106
|
type UpdateAppProductParam = {
|
|
1298
2107
|
/**
|
|
1299
|
-
* -
|
|
2108
|
+
* - Product id for which the custom_meta is associated.
|
|
1300
2109
|
*/
|
|
1301
2110
|
itemId: number;
|
|
1302
2111
|
body: CatalogPlatformModel.ApplicationItemMeta;
|
|
@@ -1312,6 +2121,14 @@ type UpdateAutocompleteKeywordParam = {
|
|
|
1312
2121
|
id: string;
|
|
1313
2122
|
body: CatalogPlatformModel.CreateAutocompleteKeyword;
|
|
1314
2123
|
};
|
|
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
|
+
};
|
|
1315
2132
|
type UpdateCollectionParam = {
|
|
1316
2133
|
/**
|
|
1317
2134
|
* - A `id` is a unique identifier of a collection.
|
|
@@ -1320,7 +2137,7 @@ type UpdateCollectionParam = {
|
|
|
1320
2137
|
body: CatalogPlatformModel.UpdateCollection;
|
|
1321
2138
|
};
|
|
1322
2139
|
type UpdateDefaultSortParam = {
|
|
1323
|
-
body: CatalogPlatformModel.
|
|
2140
|
+
body: CatalogPlatformModel.DefaultKeyRequest;
|
|
1324
2141
|
};
|
|
1325
2142
|
type UpdateGroupConfigurationParam = {
|
|
1326
2143
|
/**
|
|
@@ -1346,10 +2163,50 @@ type UpdateListingConfigurationParam = {
|
|
|
1346
2163
|
* particular configuration.
|
|
1347
2164
|
*/
|
|
1348
2165
|
configId: string;
|
|
1349
|
-
body: CatalogPlatformModel.
|
|
2166
|
+
body: CatalogPlatformModel.AppConfigurationsFilterResponse;
|
|
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;
|
|
1350
2207
|
};
|
|
1351
2208
|
type UpdateSearchConfigurationParam = {
|
|
1352
|
-
body: CatalogPlatformModel.
|
|
2209
|
+
body: CatalogPlatformModel.UpdateSearchConfigurationRequest;
|
|
1353
2210
|
};
|
|
1354
2211
|
type UpdateSearchKeywordsParam = {
|
|
1355
2212
|
/**
|
|
@@ -1359,13 +2216,47 @@ type UpdateSearchKeywordsParam = {
|
|
|
1359
2216
|
id: string;
|
|
1360
2217
|
body: CatalogPlatformModel.CreateSearchKeyword;
|
|
1361
2218
|
};
|
|
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
|
+
};
|
|
1362
2252
|
type DeleteSearchConfigurationParam = any;
|
|
1363
|
-
type
|
|
2253
|
+
type ExportSynonymsParam = any;
|
|
1364
2254
|
type GetAppReturnConfigurationParam = any;
|
|
1365
|
-
type
|
|
2255
|
+
type GetAutocompleteSettingsParam = any;
|
|
1366
2256
|
type GetCatalogConfigurationParam = any;
|
|
1367
2257
|
type GetConfigurationsParam = any;
|
|
1368
2258
|
type GetDepartmentsParam = any;
|
|
1369
2259
|
type GetQueryFiltersParam = any;
|
|
1370
2260
|
type GetSearchConfigurationParam = any;
|
|
2261
|
+
type GetSearchRerankParam = any;
|
|
1371
2262
|
import CatalogPlatformModel = require("./CatalogPlatformModel");
|