@gofynd/fdk-client-javascript 1.4.16-beta.4 → 1.4.16-beta.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/ApplicationClient.d.ts +2 -0
- package/sdk/application/ApplicationClient.js +2 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +68 -48
- package/sdk/application/Cart/CartApplicationClient.js +118 -27
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +59 -58
- package/sdk/application/Catalog/CatalogApplicationClient.js +30 -29
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +1 -1
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +20 -20
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +10 -10
- package/sdk/application/Content/ContentApplicationClient.d.ts +51 -30
- package/sdk/application/Content/ContentApplicationClient.js +161 -56
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +9 -11
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +7 -10
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +111 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +2 -2
- package/sdk/application/Lead/LeadApplicationClient.js +1 -1
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +35 -15
- package/sdk/application/Logistic/LogisticApplicationClient.js +101 -8
- package/sdk/application/Order/OrderApplicationClient.d.ts +22 -12
- package/sdk/application/Order/OrderApplicationClient.js +56 -8
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +87 -87
- package/sdk/application/Payment/PaymentApplicationClient.js +46 -46
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +2 -2
- package/sdk/application/Theme/ThemeApplicationClient.js +4 -2
- package/sdk/application/User/UserApplicationClient.d.ts +10 -10
- package/sdk/application/User/UserApplicationClient.js +6 -6
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +3 -3
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +86 -12
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +582 -24
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +116 -21
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +121 -16
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +8 -1
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +51 -4
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
- package/sdk/partner/Lead/LeadPartnerClient.js +2 -2
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerModel.js +15 -15
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +126 -20
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +970 -20
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1200 -167
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +571 -160
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +10 -0
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +121 -7
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +8 -10
- package/sdk/partner/Theme/ThemePartnerClient.js +14 -16
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +96 -37
- package/sdk/partner/Theme/ThemePartnerModel.js +90 -36
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +28 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +103 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +612 -179
- package/sdk/partner/Webhook/WebhookPartnerModel.js +253 -150
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +1 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +11 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +5 -4
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +14 -8
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +59 -9
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +40 -4
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +2 -32
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -243
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +11 -130
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +12 -152
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
- package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
- package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +134 -103
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +419 -115
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +121 -65
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +109 -44
- package/sdk/platform/Cart/CartPlatformModel.d.ts +5070 -1296
- package/sdk/platform/Cart/CartPlatformModel.js +1992 -1217
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +209 -183
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +452 -395
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +185 -142
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +96 -78
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +154 -117
- package/sdk/platform/Catalog/CatalogPlatformClient.js +292 -172
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6512 -1770
- package/sdk/platform/Catalog/CatalogPlatformModel.js +3228 -1687
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +72 -31
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +50 -24
- package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -2
- package/sdk/platform/Common/CommonPlatformClient.js +3 -2
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +16 -17
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +16 -17
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +43 -33
- package/sdk/platform/Communication/CommunicationPlatformModel.js +38 -34
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +46 -42
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +47 -43
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +210 -212
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +46 -33
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +67 -54
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +45 -24
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +134 -30
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +283 -124
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +219 -94
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +204 -141
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1076 -478
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +253 -141
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +256 -130
- package/sdk/platform/Content/ContentPlatformClient.d.ts +142 -106
- package/sdk/platform/Content/ContentPlatformClient.js +523 -336
- package/sdk/platform/Content/ContentPlatformModel.d.ts +1372 -400
- package/sdk/platform/Content/ContentPlatformModel.js +631 -394
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +168 -117
- package/sdk/platform/Content/ContentPlatformValidator.js +162 -108
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +14 -12
- package/sdk/platform/Discount/DiscountPlatformClient.js +14 -12
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +13 -13
- package/sdk/platform/Discount/DiscountPlatformModel.js +12 -12
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +95 -39
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +462 -63
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +62 -15
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +75 -13
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +20 -22
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +21 -24
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +370 -116
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +313 -104
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +2 -2
- package/sdk/platform/Lead/LeadPlatformClient.js +2 -2
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -5
- package/sdk/platform/Lead/LeadPlatformModel.js +16 -16
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +17 -6
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +85 -7
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +95 -24
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +39 -19
- package/sdk/platform/Order/OrderPlatformClient.d.ts +153 -96
- package/sdk/platform/Order/OrderPlatformClient.js +416 -198
- package/sdk/platform/Order/OrderPlatformModel.d.ts +7607 -1267
- package/sdk/platform/Order/OrderPlatformModel.js +3929 -1269
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +270 -109
- package/sdk/platform/Order/OrderPlatformValidator.js +135 -77
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +9 -7
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
- package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +93 -105
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +129 -141
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +48 -48
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +48 -48
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
- package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +333 -319
- package/sdk/platform/Payment/PaymentPlatformModel.js +288 -278
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
- package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
- package/sdk/platform/PlatformClient.d.ts +0 -2
- package/sdk/platform/PlatformClient.js +0 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +9 -9
- package/sdk/platform/Rewards/RewardsPlatformModel.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +46 -36
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +132 -41
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +46 -17
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +34 -14
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +40 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +58 -64
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1842 -609
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +886 -554
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +42 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +26 -28
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Share/SharePlatformApplicationClient.js +9 -9
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +3 -6
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +2 -2
- package/sdk/platform/Share/SharePlatformModel.d.ts +46 -7
- package/sdk/platform/Share/SharePlatformModel.js +31 -6
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +8 -4
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +5 -0
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +2 -0
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +37 -11
- package/sdk/platform/Theme/ThemePlatformModel.js +33 -15
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/User/UserPlatformApplicationClient.js +12 -12
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/User/UserPlatformApplicationValidator.js +2 -2
- package/sdk/platform/User/UserPlatformModel.d.ts +21 -21
- package/sdk/platform/User/UserPlatformModel.js +23 -23
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +25 -78
- package/sdk/platform/Webhook/WebhookPlatformClient.js +75 -470
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +720 -427
- package/sdk/platform/Webhook/WebhookPlatformModel.js +410 -386
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
- package/sdk/platform/index.d.ts +0 -1
- package/sdk/platform/index.js +0 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +3 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +6 -5
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
- package/sdk/public/Content/ContentPublicClient.d.ts +112 -2
- package/sdk/public/Content/ContentPublicClient.js +810 -6
- package/sdk/public/Content/ContentPublicModel.d.ts +549 -3
- package/sdk/public/Content/ContentPublicModel.js +649 -3
- package/sdk/public/Content/ContentPublicValidator.d.ts +69 -3
- package/sdk/public/Content/ContentPublicValidator.js +88 -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 +21 -21
- package/sdk/public/Webhook/WebhookPublicModel.js +15 -15
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
- package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2890
- package/sdk/platform/Finance/FinancePlatformModel.js +0 -2148
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
- package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
|
@@ -14,6 +14,16 @@ export = CatalogPlatformApplicationValidator;
|
|
|
14
14
|
*/
|
|
15
15
|
/**
|
|
16
16
|
* @typedef CreateCollectionParam
|
|
17
|
+
* @property {string} [q] - Get collection list filtered by q string,
|
|
18
|
+
* @property {string} [scheduleStatus] - Get collection list filtered by scheduled status,
|
|
19
|
+
* @property {string} [type] - Type of the collections
|
|
20
|
+
* @property {string[]} [tags] - Each response will contain next_id param, which
|
|
21
|
+
* should be sent back to make pagination work.
|
|
22
|
+
* @property {boolean} [isActive] - Get collections filtered by active status.
|
|
23
|
+
* @property {number} [pageNo] - The page number to navigate through the given
|
|
24
|
+
* set of results.
|
|
25
|
+
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
26
|
+
* Default is 12.
|
|
17
27
|
* @property {CatalogPlatformModel.CreateCollection} body
|
|
18
28
|
*/
|
|
19
29
|
/**
|
|
@@ -47,7 +57,7 @@ export = CatalogPlatformApplicationValidator;
|
|
|
47
57
|
*/
|
|
48
58
|
/**
|
|
49
59
|
* @typedef CreateSearchConfigurationParam
|
|
50
|
-
* @property {CatalogPlatformModel.
|
|
60
|
+
* @property {CatalogPlatformModel.CreateSearchConfigurationRequestSchema} body
|
|
51
61
|
*/
|
|
52
62
|
/**
|
|
53
63
|
* @typedef DeleteAppCategoryReturnConfigurationParam
|
|
@@ -159,34 +169,6 @@ export = CatalogPlatformApplicationValidator;
|
|
|
159
169
|
* @property {string} [q] - Search with Item Code, Name, Slug or Identifier.
|
|
160
170
|
*/
|
|
161
171
|
/** @typedef GetAppReturnConfigurationParam */
|
|
162
|
-
/**
|
|
163
|
-
* @typedef GetAppicationProductsParam
|
|
164
|
-
* @property {string} [q] - The search query. This can be a partial or complete
|
|
165
|
-
* name of a either a product, brand or category
|
|
166
|
-
* @property {string} [f] - The search filter parameters. All the parameter
|
|
167
|
-
* filtered from filter parameters will be passed in **f** parameter in this
|
|
168
|
-
* format. **?f=brand:voi-jeans||and:::category:t-shirts||shirts**
|
|
169
|
-
* @property {string} [c] - The search filter parameters for collection items.
|
|
170
|
-
* All the parameter filtered from filter parameters will be passed in **c**
|
|
171
|
-
* parameter in this format.
|
|
172
|
-
* **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
|
|
173
|
-
* @property {boolean} [filters] - Pass `filters` parameter to fetch the filter
|
|
174
|
-
* details. This flag is used to fetch all filters
|
|
175
|
-
* @property {boolean} [isDependent] - This query parameter is used to get the
|
|
176
|
-
* dependent products in the listing.
|
|
177
|
-
* @property {string} [sortOn] - The order to sort the list of products on. The
|
|
178
|
-
* supported sort parameters are popularity, price, redemption and discount in
|
|
179
|
-
* either ascending or descending order. See the supported values below.
|
|
180
|
-
* @property {string} [pageId] - Each response will contain **page_id** param,
|
|
181
|
-
* which should be sent back to make pagination work.
|
|
182
|
-
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
183
|
-
* Default is 12.
|
|
184
|
-
* @property {number} [pageNo] - If page_type is number then pass it to fetch
|
|
185
|
-
* page items. Default is 1.
|
|
186
|
-
* @property {string} [pageType] - For pagination type should be cursor or
|
|
187
|
-
* number. Default is cursor.
|
|
188
|
-
* @property {number[]} [itemIds] - Item Ids of product
|
|
189
|
-
*/
|
|
190
172
|
/**
|
|
191
173
|
* @typedef GetApplicationBrandListingParam
|
|
192
174
|
* @property {number} [pageNo] - The page number to navigate through the given
|
|
@@ -234,25 +216,54 @@ export = CatalogPlatformApplicationValidator;
|
|
|
234
216
|
/**
|
|
235
217
|
* @typedef GetApplicationFilterKeysParam
|
|
236
218
|
* @property {string} [c] - The search filter parameters for collection items.
|
|
237
|
-
* All the parameter filtered from filter parameters will be passed in
|
|
238
|
-
* parameter in this format.
|
|
239
|
-
* **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
|
|
219
|
+
* All the parameter filtered from filter parameters will be passed in "c"
|
|
220
|
+
* parameter in this format. "?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts"
|
|
240
221
|
*/
|
|
241
222
|
/**
|
|
242
223
|
* @typedef GetApplicationFilterValuesParam
|
|
243
|
-
* @property {string} filterKey - A `filter_key` is a filter key
|
|
244
|
-
* all the available filter values
|
|
224
|
+
* @property {string} filterKey - A `filter_key` is a filter key which returns
|
|
225
|
+
* all the available filter values.
|
|
245
226
|
* @property {string} [c] - The search filter parameters for collection items.
|
|
246
|
-
* All the parameter filtered from filter parameters will be passed in
|
|
247
|
-
* parameter in this format.
|
|
248
|
-
* **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
|
|
227
|
+
* All the parameter filtered from filter parameters will be passed in "c"
|
|
228
|
+
* parameter in this format. "?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts"
|
|
249
229
|
* @property {string} [collectionId] - A `collection_id` is a unique identifier
|
|
250
|
-
* for a particular collection.
|
|
230
|
+
* for a particular collection.
|
|
251
231
|
* @property {number} [pageNo] - The page number to navigate through the given
|
|
252
232
|
* set of results
|
|
253
233
|
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
254
234
|
* Default is 10.
|
|
255
|
-
* @property {string} [q] -
|
|
235
|
+
* @property {string} [q] - The `q` parameter allows you to search and filter
|
|
236
|
+
* specific data within the filter options. It acts as a query keyword that
|
|
237
|
+
* can refine the results by matching relevant filter values, such as a
|
|
238
|
+
* category name or any other applicable filter criteria.
|
|
239
|
+
*/
|
|
240
|
+
/**
|
|
241
|
+
* @typedef GetApplicationProductsParam
|
|
242
|
+
* @property {string} [q] - The search query. This can be a partial or complete
|
|
243
|
+
* name of a either a product, brand or category
|
|
244
|
+
* @property {string} [f] - The search filter parameters. All the parameter
|
|
245
|
+
* filtered from filter parameters will be passed in **f** parameter in this
|
|
246
|
+
* format. **?f=brand:voi-jeans||and:::category:t-shirts||shirts**
|
|
247
|
+
* @property {string} [c] - The search filter parameters for collection items.
|
|
248
|
+
* All the parameter filtered from filter parameters will be passed in **c**
|
|
249
|
+
* parameter in this format.
|
|
250
|
+
* **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
|
|
251
|
+
* @property {boolean} [filters] - Pass `filters` parameter to fetch the filter
|
|
252
|
+
* details. This flag is used to fetch all filters
|
|
253
|
+
* @property {boolean} [isDependent] - This query parameter is used to get the
|
|
254
|
+
* dependent products in the listing.
|
|
255
|
+
* @property {string} [sortOn] - The order to sort the list of products on. The
|
|
256
|
+
* supported sort parameters are popularity, price, redemption and discount in
|
|
257
|
+
* either ascending or descending order. See the supported values below.
|
|
258
|
+
* @property {string} [pageId] - Each response will contain **page_id** param,
|
|
259
|
+
* which should be sent back to make pagination work.
|
|
260
|
+
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
261
|
+
* Default is 12.
|
|
262
|
+
* @property {number} [pageNo] - If page_type is number then pass it to fetch
|
|
263
|
+
* page items. Default is 1.
|
|
264
|
+
* @property {string} [pageType] - For pagination type should be cursor or
|
|
265
|
+
* number. Default is cursor.
|
|
266
|
+
* @property {string[]} [itemIds] - Item Ids of product
|
|
256
267
|
*/
|
|
257
268
|
/** @typedef GetAutocompleteConfigParam */
|
|
258
269
|
/**
|
|
@@ -287,6 +298,7 @@ export = CatalogPlatformApplicationValidator;
|
|
|
287
298
|
* should be sent back to make pagination work.
|
|
288
299
|
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
289
300
|
* Default is 12.
|
|
301
|
+
* @property {number} [pageNo] - Identifies the specific page of results being requested.
|
|
290
302
|
*/
|
|
291
303
|
/**
|
|
292
304
|
* @typedef GetConfigurationByTypeParam
|
|
@@ -307,14 +319,13 @@ export = CatalogPlatformApplicationValidator;
|
|
|
307
319
|
/** @typedef GetDepartmentsParam */
|
|
308
320
|
/**
|
|
309
321
|
* @typedef GetDiscountedInventoryBySizeIdentifierParam
|
|
310
|
-
* @property {number} itemId -
|
|
311
|
-
* @property {
|
|
312
|
-
* Primary Identifier)
|
|
322
|
+
* @property {number} itemId - A `item_id` is a unique identifier for a specific product.
|
|
323
|
+
* @property {number} sizeIdentifier - Size Identifier (Seller Identifier or
|
|
324
|
+
* Primary Identifier).
|
|
313
325
|
* @property {number} [pageNo] - The page number to navigate through the given
|
|
314
326
|
* set of results
|
|
315
327
|
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
316
328
|
* Default is 12.
|
|
317
|
-
* @property {string} [q] - Search with help of store code.
|
|
318
329
|
* @property {number[]} [locationIds] - Search by store ids.
|
|
319
330
|
*/
|
|
320
331
|
/**
|
|
@@ -343,7 +354,7 @@ export = CatalogPlatformApplicationValidator;
|
|
|
343
354
|
* @typedef GetProductDetailBySlugParam
|
|
344
355
|
* @property {string} slug - The unique identifier of a product. i.e; `slug` of
|
|
345
356
|
* a product. You can retrieve these from the APIs that list products like
|
|
346
|
-
*
|
|
357
|
+
* "v1.0/products/"
|
|
347
358
|
*/
|
|
348
359
|
/** @typedef GetQueryFiltersParam */
|
|
349
360
|
/** @typedef GetSearchConfigurationParam */
|
|
@@ -354,7 +365,7 @@ export = CatalogPlatformApplicationValidator;
|
|
|
354
365
|
*/
|
|
355
366
|
/**
|
|
356
367
|
* @typedef UpdateAllowSingleParam
|
|
357
|
-
* @property {CatalogPlatformModel.
|
|
368
|
+
* @property {CatalogPlatformModel.AllowSingleRequestSchema} body
|
|
358
369
|
*/
|
|
359
370
|
/**
|
|
360
371
|
* @typedef UpdateAppBrandParam
|
|
@@ -374,18 +385,18 @@ export = CatalogPlatformApplicationValidator;
|
|
|
374
385
|
*/
|
|
375
386
|
/**
|
|
376
387
|
* @typedef UpdateAppDepartmentParam
|
|
377
|
-
* @property {
|
|
378
|
-
*
|
|
388
|
+
* @property {number} departmentUid - A `department id` is a unique identifier
|
|
389
|
+
* for a particular department.
|
|
379
390
|
* @property {CatalogPlatformModel.ApplicationDepartmentJson} body
|
|
380
391
|
*/
|
|
381
392
|
/**
|
|
382
393
|
* @typedef UpdateAppLocationParam
|
|
383
|
-
* @property {
|
|
394
|
+
* @property {number} storeUid - Store id for which the custom_json is associated.
|
|
384
395
|
* @property {CatalogPlatformModel.ApplicationStoreJson} body
|
|
385
396
|
*/
|
|
386
397
|
/**
|
|
387
398
|
* @typedef UpdateAppProductParam
|
|
388
|
-
* @property {
|
|
399
|
+
* @property {number} itemId - A `item_id` is a unique identifier for a particular item.
|
|
389
400
|
* @property {CatalogPlatformModel.ApplicationItemMeta} body
|
|
390
401
|
*/
|
|
391
402
|
/**
|
|
@@ -405,7 +416,7 @@ export = CatalogPlatformApplicationValidator;
|
|
|
405
416
|
*/
|
|
406
417
|
/**
|
|
407
418
|
* @typedef UpdateDefaultSortParam
|
|
408
|
-
* @property {CatalogPlatformModel.
|
|
419
|
+
* @property {CatalogPlatformModel.DefaultKeyRequestSchema} body
|
|
409
420
|
*/
|
|
410
421
|
/**
|
|
411
422
|
* @typedef UpdateGroupConfigurationParam
|
|
@@ -425,7 +436,7 @@ export = CatalogPlatformApplicationValidator;
|
|
|
425
436
|
*/
|
|
426
437
|
/**
|
|
427
438
|
* @typedef UpdateSearchConfigurationParam
|
|
428
|
-
* @property {CatalogPlatformModel.
|
|
439
|
+
* @property {CatalogPlatformModel.UpdateSearchConfigurationRequestSchema} body
|
|
429
440
|
*/
|
|
430
441
|
/**
|
|
431
442
|
* @typedef UpdateSearchKeywordsParam
|
|
@@ -486,8 +497,6 @@ declare class CatalogPlatformApplicationValidator {
|
|
|
486
497
|
static getAppProducts(): GetAppProductsParam;
|
|
487
498
|
/** @returns {GetAppReturnConfigurationParam} */
|
|
488
499
|
static getAppReturnConfiguration(): any;
|
|
489
|
-
/** @returns {GetAppicationProductsParam} */
|
|
490
|
-
static getAppicationProducts(): GetAppicationProductsParam;
|
|
491
500
|
/** @returns {GetApplicationBrandListingParam} */
|
|
492
501
|
static getApplicationBrandListing(): GetApplicationBrandListingParam;
|
|
493
502
|
/** @returns {GetApplicationBrandsParam} */
|
|
@@ -500,6 +509,8 @@ declare class CatalogPlatformApplicationValidator {
|
|
|
500
509
|
static getApplicationFilterKeys(): GetApplicationFilterKeysParam;
|
|
501
510
|
/** @returns {GetApplicationFilterValuesParam} */
|
|
502
511
|
static getApplicationFilterValues(): GetApplicationFilterValuesParam;
|
|
512
|
+
/** @returns {GetApplicationProductsParam} */
|
|
513
|
+
static getApplicationProducts(): GetApplicationProductsParam;
|
|
503
514
|
/** @returns {GetAutocompleteConfigParam} */
|
|
504
515
|
static getAutocompleteConfig(): any;
|
|
505
516
|
/** @returns {GetAutocompleteKeywordDetailParam} */
|
|
@@ -568,7 +579,7 @@ declare class CatalogPlatformApplicationValidator {
|
|
|
568
579
|
static updateSearchKeywords(): UpdateSearchKeywordsParam;
|
|
569
580
|
}
|
|
570
581
|
declare namespace CatalogPlatformApplicationValidator {
|
|
571
|
-
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,
|
|
582
|
+
export { AddCollectionItemsParam, CreateAppCategoryReturnConfigurationParam, CreateAppReturnConfigurationParam, CreateCollectionParam, CreateConfigurationByTypeParam, CreateConfigurationProductListingParam, CreateCustomAutocompleteRuleParam, CreateCustomKeywordParam, CreateGroupConfigurationParam, CreateListingConfigurationParam, CreateSearchConfigurationParam, DeleteAppCategoryReturnConfigurationParam, DeleteAutocompleteKeywordParam, DeleteCollectionParam, DeleteGroupConfigurationParam, DeleteListingConfigurationParam, DeleteSearchConfigurationParam, DeleteSearchKeywordsParam, GetAllCollectionsParam, GetAllSearchKeywordParam, GetAppCategoryReturnConfigParam, GetAppInventoryParam, GetAppLocationsParam, GetAppProductParam, GetAppProductsParam, GetAppReturnConfigurationParam, GetApplicationBrandListingParam, GetApplicationBrandsParam, GetApplicationCategoryListingParam, GetApplicationDepartmentListingParam, GetApplicationFilterKeysParam, GetApplicationFilterValuesParam, GetApplicationProductsParam, GetAutocompleteConfigParam, GetAutocompleteKeywordDetailParam, GetCatalogConfigurationParam, GetCatalogInsightsParam, GetCategoriesParam, GetCollectionDetailParam, GetCollectionItemsParam, GetConfigurationByTypeParam, GetConfigurationMetadataParam, GetConfigurationsParam, GetDepartmentsParam, GetDiscountedInventoryBySizeIdentifierParam, GetGroupConfigurationsParam, GetListingConfigurationsParam, GetProductDetailBySlugParam, GetQueryFiltersParam, GetSearchConfigurationParam, GetSearchKeywordsParam, UpdateAllowSingleParam, UpdateAppBrandParam, UpdateAppCategoryParam, UpdateAppCategoryReturnConfigurationParam, UpdateAppDepartmentParam, UpdateAppLocationParam, UpdateAppProductParam, UpdateAppReturnConfigurationParam, UpdateAutocompleteKeywordParam, UpdateCollectionParam, UpdateDefaultSortParam, UpdateGroupConfigurationParam, UpdateListingConfigurationParam, UpdateSearchConfigurationParam, UpdateSearchKeywordsParam };
|
|
572
583
|
}
|
|
573
584
|
type AddCollectionItemsParam = {
|
|
574
585
|
/**
|
|
@@ -584,6 +595,37 @@ type CreateAppReturnConfigurationParam = {
|
|
|
584
595
|
body: CatalogPlatformModel.CreateUpdateAppReturnConfig;
|
|
585
596
|
};
|
|
586
597
|
type CreateCollectionParam = {
|
|
598
|
+
/**
|
|
599
|
+
* - Get collection list filtered by q string,
|
|
600
|
+
*/
|
|
601
|
+
q?: string;
|
|
602
|
+
/**
|
|
603
|
+
* - Get collection list filtered by scheduled status,
|
|
604
|
+
*/
|
|
605
|
+
scheduleStatus?: string;
|
|
606
|
+
/**
|
|
607
|
+
* - Type of the collections
|
|
608
|
+
*/
|
|
609
|
+
type?: string;
|
|
610
|
+
/**
|
|
611
|
+
* - Each response will contain next_id param, which
|
|
612
|
+
* should be sent back to make pagination work.
|
|
613
|
+
*/
|
|
614
|
+
tags?: string[];
|
|
615
|
+
/**
|
|
616
|
+
* - Get collections filtered by active status.
|
|
617
|
+
*/
|
|
618
|
+
isActive?: boolean;
|
|
619
|
+
/**
|
|
620
|
+
* - The page number to navigate through the given
|
|
621
|
+
* set of results.
|
|
622
|
+
*/
|
|
623
|
+
pageNo?: number;
|
|
624
|
+
/**
|
|
625
|
+
* - Number of items to retrieve in each page.
|
|
626
|
+
* Default is 12.
|
|
627
|
+
*/
|
|
628
|
+
pageSize?: number;
|
|
587
629
|
body: CatalogPlatformModel.CreateCollection;
|
|
588
630
|
};
|
|
589
631
|
type CreateConfigurationByTypeParam = {
|
|
@@ -619,7 +661,7 @@ type CreateListingConfigurationParam = {
|
|
|
619
661
|
body: CatalogPlatformModel.AppConfigurationsSort;
|
|
620
662
|
};
|
|
621
663
|
type CreateSearchConfigurationParam = {
|
|
622
|
-
body: CatalogPlatformModel.
|
|
664
|
+
body: CatalogPlatformModel.CreateSearchConfigurationRequestSchema;
|
|
623
665
|
};
|
|
624
666
|
type DeleteAppCategoryReturnConfigurationParam = {
|
|
625
667
|
body: CatalogPlatformModel.DeleteAppCategoryReturnConfig;
|
|
@@ -854,66 +896,6 @@ type GetAppProductsParam = {
|
|
|
854
896
|
*/
|
|
855
897
|
q?: string;
|
|
856
898
|
};
|
|
857
|
-
type GetAppicationProductsParam = {
|
|
858
|
-
/**
|
|
859
|
-
* - The search query. This can be a partial or complete
|
|
860
|
-
* name of a either a product, brand or category
|
|
861
|
-
*/
|
|
862
|
-
q?: string;
|
|
863
|
-
/**
|
|
864
|
-
* - The search filter parameters. All the parameter
|
|
865
|
-
* filtered from filter parameters will be passed in **f** parameter in this
|
|
866
|
-
* format. **?f=brand:voi-jeans||and:::category:t-shirts||shirts**
|
|
867
|
-
*/
|
|
868
|
-
f?: string;
|
|
869
|
-
/**
|
|
870
|
-
* - The search filter parameters for collection items.
|
|
871
|
-
* All the parameter filtered from filter parameters will be passed in **c**
|
|
872
|
-
* parameter in this format.
|
|
873
|
-
* **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
|
|
874
|
-
*/
|
|
875
|
-
c?: string;
|
|
876
|
-
/**
|
|
877
|
-
* - Pass `filters` parameter to fetch the filter
|
|
878
|
-
* details. This flag is used to fetch all filters
|
|
879
|
-
*/
|
|
880
|
-
filters?: boolean;
|
|
881
|
-
/**
|
|
882
|
-
* - This query parameter is used to get the
|
|
883
|
-
* dependent products in the listing.
|
|
884
|
-
*/
|
|
885
|
-
isDependent?: boolean;
|
|
886
|
-
/**
|
|
887
|
-
* - The order to sort the list of products on. The
|
|
888
|
-
* supported sort parameters are popularity, price, redemption and discount in
|
|
889
|
-
* either ascending or descending order. See the supported values below.
|
|
890
|
-
*/
|
|
891
|
-
sortOn?: string;
|
|
892
|
-
/**
|
|
893
|
-
* - Each response will contain **page_id** param,
|
|
894
|
-
* which should be sent back to make pagination work.
|
|
895
|
-
*/
|
|
896
|
-
pageId?: string;
|
|
897
|
-
/**
|
|
898
|
-
* - Number of items to retrieve in each page.
|
|
899
|
-
* Default is 12.
|
|
900
|
-
*/
|
|
901
|
-
pageSize?: number;
|
|
902
|
-
/**
|
|
903
|
-
* - If page_type is number then pass it to fetch
|
|
904
|
-
* page items. Default is 1.
|
|
905
|
-
*/
|
|
906
|
-
pageNo?: number;
|
|
907
|
-
/**
|
|
908
|
-
* - For pagination type should be cursor or
|
|
909
|
-
* number. Default is cursor.
|
|
910
|
-
*/
|
|
911
|
-
pageType?: string;
|
|
912
|
-
/**
|
|
913
|
-
* - Item Ids of product
|
|
914
|
-
*/
|
|
915
|
-
itemIds?: number[];
|
|
916
|
-
};
|
|
917
899
|
type GetApplicationBrandListingParam = {
|
|
918
900
|
/**
|
|
919
901
|
* - The page number to navigate through the given
|
|
@@ -1002,28 +984,26 @@ type GetApplicationDepartmentListingParam = {
|
|
|
1002
984
|
type GetApplicationFilterKeysParam = {
|
|
1003
985
|
/**
|
|
1004
986
|
* - The search filter parameters for collection items.
|
|
1005
|
-
* All the parameter filtered from filter parameters will be passed in
|
|
1006
|
-
* parameter in this format.
|
|
1007
|
-
* **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
|
|
987
|
+
* All the parameter filtered from filter parameters will be passed in "c"
|
|
988
|
+
* parameter in this format. "?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts"
|
|
1008
989
|
*/
|
|
1009
990
|
c?: string;
|
|
1010
991
|
};
|
|
1011
992
|
type GetApplicationFilterValuesParam = {
|
|
1012
993
|
/**
|
|
1013
|
-
* - A `filter_key` is a filter key
|
|
1014
|
-
* all the available filter values
|
|
994
|
+
* - A `filter_key` is a filter key which returns
|
|
995
|
+
* all the available filter values.
|
|
1015
996
|
*/
|
|
1016
997
|
filterKey: string;
|
|
1017
998
|
/**
|
|
1018
999
|
* - The search filter parameters for collection items.
|
|
1019
|
-
* All the parameter filtered from filter parameters will be passed in
|
|
1020
|
-
* parameter in this format.
|
|
1021
|
-
* **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
|
|
1000
|
+
* All the parameter filtered from filter parameters will be passed in "c"
|
|
1001
|
+
* parameter in this format. "?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts"
|
|
1022
1002
|
*/
|
|
1023
1003
|
c?: string;
|
|
1024
1004
|
/**
|
|
1025
1005
|
* - A `collection_id` is a unique identifier
|
|
1026
|
-
* for a particular collection.
|
|
1006
|
+
* for a particular collection.
|
|
1027
1007
|
*/
|
|
1028
1008
|
collectionId?: string;
|
|
1029
1009
|
/**
|
|
@@ -1037,9 +1017,72 @@ type GetApplicationFilterValuesParam = {
|
|
|
1037
1017
|
*/
|
|
1038
1018
|
pageSize?: number;
|
|
1039
1019
|
/**
|
|
1040
|
-
* -
|
|
1020
|
+
* - The `q` parameter allows you to search and filter
|
|
1021
|
+
* specific data within the filter options. It acts as a query keyword that
|
|
1022
|
+
* can refine the results by matching relevant filter values, such as a
|
|
1023
|
+
* category name or any other applicable filter criteria.
|
|
1024
|
+
*/
|
|
1025
|
+
q?: string;
|
|
1026
|
+
};
|
|
1027
|
+
type GetApplicationProductsParam = {
|
|
1028
|
+
/**
|
|
1029
|
+
* - The search query. This can be a partial or complete
|
|
1030
|
+
* name of a either a product, brand or category
|
|
1041
1031
|
*/
|
|
1042
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**
|
|
1037
|
+
*/
|
|
1038
|
+
f?: string;
|
|
1039
|
+
/**
|
|
1040
|
+
* - The search filter parameters for collection items.
|
|
1041
|
+
* All the parameter filtered from filter parameters will be passed in **c**
|
|
1042
|
+
* parameter in this format.
|
|
1043
|
+
* **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
|
|
1044
|
+
*/
|
|
1045
|
+
c?: string;
|
|
1046
|
+
/**
|
|
1047
|
+
* - Pass `filters` parameter to fetch the filter
|
|
1048
|
+
* details. This flag is used to fetch all filters
|
|
1049
|
+
*/
|
|
1050
|
+
filters?: boolean;
|
|
1051
|
+
/**
|
|
1052
|
+
* - This query parameter is used to get the
|
|
1053
|
+
* dependent products in the listing.
|
|
1054
|
+
*/
|
|
1055
|
+
isDependent?: boolean;
|
|
1056
|
+
/**
|
|
1057
|
+
* - The order to sort the list of products on. The
|
|
1058
|
+
* supported sort parameters are popularity, price, redemption and discount in
|
|
1059
|
+
* either ascending or descending order. See the supported values below.
|
|
1060
|
+
*/
|
|
1061
|
+
sortOn?: string;
|
|
1062
|
+
/**
|
|
1063
|
+
* - Each response will contain **page_id** param,
|
|
1064
|
+
* which should be sent back to make pagination work.
|
|
1065
|
+
*/
|
|
1066
|
+
pageId?: string;
|
|
1067
|
+
/**
|
|
1068
|
+
* - Number of items to retrieve in each page.
|
|
1069
|
+
* Default is 12.
|
|
1070
|
+
*/
|
|
1071
|
+
pageSize?: number;
|
|
1072
|
+
/**
|
|
1073
|
+
* - If page_type is number then pass it to fetch
|
|
1074
|
+
* page items. Default is 1.
|
|
1075
|
+
*/
|
|
1076
|
+
pageNo?: number;
|
|
1077
|
+
/**
|
|
1078
|
+
* - For pagination type should be cursor or
|
|
1079
|
+
* number. Default is cursor.
|
|
1080
|
+
*/
|
|
1081
|
+
pageType?: string;
|
|
1082
|
+
/**
|
|
1083
|
+
* - Item Ids of product
|
|
1084
|
+
*/
|
|
1085
|
+
itemIds?: string[];
|
|
1043
1086
|
};
|
|
1044
1087
|
type GetAutocompleteKeywordDetailParam = {
|
|
1045
1088
|
/**
|
|
@@ -1091,6 +1134,10 @@ type GetCollectionItemsParam = {
|
|
|
1091
1134
|
* Default is 12.
|
|
1092
1135
|
*/
|
|
1093
1136
|
pageSize?: number;
|
|
1137
|
+
/**
|
|
1138
|
+
* - Identifies the specific page of results being requested.
|
|
1139
|
+
*/
|
|
1140
|
+
pageNo?: number;
|
|
1094
1141
|
};
|
|
1095
1142
|
type GetConfigurationByTypeParam = {
|
|
1096
1143
|
/**
|
|
@@ -1125,14 +1172,14 @@ type GetConfigurationMetadataParam = {
|
|
|
1125
1172
|
};
|
|
1126
1173
|
type GetDiscountedInventoryBySizeIdentifierParam = {
|
|
1127
1174
|
/**
|
|
1128
|
-
* -
|
|
1175
|
+
* - A `item_id` is a unique identifier for a specific product.
|
|
1129
1176
|
*/
|
|
1130
1177
|
itemId: number;
|
|
1131
1178
|
/**
|
|
1132
1179
|
* - Size Identifier (Seller Identifier or
|
|
1133
|
-
* Primary Identifier)
|
|
1180
|
+
* Primary Identifier).
|
|
1134
1181
|
*/
|
|
1135
|
-
sizeIdentifier:
|
|
1182
|
+
sizeIdentifier: number;
|
|
1136
1183
|
/**
|
|
1137
1184
|
* - The page number to navigate through the given
|
|
1138
1185
|
* set of results
|
|
@@ -1143,10 +1190,6 @@ type GetDiscountedInventoryBySizeIdentifierParam = {
|
|
|
1143
1190
|
* Default is 12.
|
|
1144
1191
|
*/
|
|
1145
1192
|
pageSize?: number;
|
|
1146
|
-
/**
|
|
1147
|
-
* - Search with help of store code.
|
|
1148
|
-
*/
|
|
1149
|
-
q?: string;
|
|
1150
1193
|
/**
|
|
1151
1194
|
* - Search by store ids.
|
|
1152
1195
|
*/
|
|
@@ -1203,7 +1246,7 @@ type GetProductDetailBySlugParam = {
|
|
|
1203
1246
|
/**
|
|
1204
1247
|
* - The unique identifier of a product. i.e; `slug` of
|
|
1205
1248
|
* a product. You can retrieve these from the APIs that list products like
|
|
1206
|
-
*
|
|
1249
|
+
* "v1.0/products/"
|
|
1207
1250
|
*/
|
|
1208
1251
|
slug: string;
|
|
1209
1252
|
};
|
|
@@ -1215,7 +1258,7 @@ type GetSearchKeywordsParam = {
|
|
|
1215
1258
|
id: string;
|
|
1216
1259
|
};
|
|
1217
1260
|
type UpdateAllowSingleParam = {
|
|
1218
|
-
body: CatalogPlatformModel.
|
|
1261
|
+
body: CatalogPlatformModel.AllowSingleRequestSchema;
|
|
1219
1262
|
};
|
|
1220
1263
|
type UpdateAppBrandParam = {
|
|
1221
1264
|
/**
|
|
@@ -1238,24 +1281,24 @@ type UpdateAppCategoryReturnConfigurationParam = {
|
|
|
1238
1281
|
};
|
|
1239
1282
|
type UpdateAppDepartmentParam = {
|
|
1240
1283
|
/**
|
|
1241
|
-
* -
|
|
1242
|
-
*
|
|
1284
|
+
* - A `department id` is a unique identifier
|
|
1285
|
+
* for a particular department.
|
|
1243
1286
|
*/
|
|
1244
|
-
departmentUid:
|
|
1287
|
+
departmentUid: number;
|
|
1245
1288
|
body: CatalogPlatformModel.ApplicationDepartmentJson;
|
|
1246
1289
|
};
|
|
1247
1290
|
type UpdateAppLocationParam = {
|
|
1248
1291
|
/**
|
|
1249
1292
|
* - Store id for which the custom_json is associated.
|
|
1250
1293
|
*/
|
|
1251
|
-
storeUid:
|
|
1294
|
+
storeUid: number;
|
|
1252
1295
|
body: CatalogPlatformModel.ApplicationStoreJson;
|
|
1253
1296
|
};
|
|
1254
1297
|
type UpdateAppProductParam = {
|
|
1255
1298
|
/**
|
|
1256
|
-
* -
|
|
1299
|
+
* - A `item_id` is a unique identifier for a particular item.
|
|
1257
1300
|
*/
|
|
1258
|
-
itemId:
|
|
1301
|
+
itemId: number;
|
|
1259
1302
|
body: CatalogPlatformModel.ApplicationItemMeta;
|
|
1260
1303
|
};
|
|
1261
1304
|
type UpdateAppReturnConfigurationParam = {
|
|
@@ -1277,7 +1320,7 @@ type UpdateCollectionParam = {
|
|
|
1277
1320
|
body: CatalogPlatformModel.UpdateCollection;
|
|
1278
1321
|
};
|
|
1279
1322
|
type UpdateDefaultSortParam = {
|
|
1280
|
-
body: CatalogPlatformModel.
|
|
1323
|
+
body: CatalogPlatformModel.DefaultKeyRequestSchema;
|
|
1281
1324
|
};
|
|
1282
1325
|
type UpdateGroupConfigurationParam = {
|
|
1283
1326
|
/**
|
|
@@ -1306,7 +1349,7 @@ type UpdateListingConfigurationParam = {
|
|
|
1306
1349
|
body: CatalogPlatformModel.AppConfigurationsSort;
|
|
1307
1350
|
};
|
|
1308
1351
|
type UpdateSearchConfigurationParam = {
|
|
1309
|
-
body: CatalogPlatformModel.
|
|
1352
|
+
body: CatalogPlatformModel.UpdateSearchConfigurationRequestSchema;
|
|
1310
1353
|
};
|
|
1311
1354
|
type UpdateSearchKeywordsParam = {
|
|
1312
1355
|
/**
|