@gofynd/fdk-client-javascript 1.4.15-beta.2 → 1.4.15-beta.4

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.
Files changed (118) hide show
  1. package/README.md +2 -2
  2. package/application.d.ts +1 -2
  3. package/application.js +2 -3
  4. package/index.d.ts +1 -2
  5. package/index.js +7 -1
  6. package/package.json +2 -3
  7. package/sdk/application/ApplicationClient.js +0 -18
  8. package/sdk/application/Cart/CartApplicationClient.d.ts +55 -90
  9. package/sdk/application/Cart/CartApplicationClient.js +27 -1203
  10. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +80 -142
  11. package/sdk/application/Catalog/CatalogApplicationClient.js +40 -1344
  12. package/sdk/application/Common/CommonApplicationClient.d.ts +4 -8
  13. package/sdk/application/Common/CommonApplicationClient.js +2 -92
  14. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -19
  15. package/sdk/application/Communication/CommunicationApplicationClient.js +3 -148
  16. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -73
  17. package/sdk/application/Configuration/ConfigurationApplicationClient.js +16 -727
  18. package/sdk/application/Content/ContentApplicationClient.d.ts +46 -78
  19. package/sdk/application/Content/ContentApplicationClient.js +23 -941
  20. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -11
  21. package/sdk/application/FileStorage/FileStorageApplicationClient.js +4 -134
  22. package/sdk/application/Lead/LeadApplicationClient.d.ts +10 -18
  23. package/sdk/application/Lead/LeadApplicationClient.js +5 -217
  24. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +22 -39
  25. package/sdk/application/Logistic/LogisticApplicationClient.js +11 -496
  26. package/sdk/application/Order/OrderApplicationClient.d.ts +22 -42
  27. package/sdk/application/Order/OrderApplicationClient.js +11 -505
  28. package/sdk/application/Payment/PaymentApplicationClient.d.ts +92 -212
  29. package/sdk/application/Payment/PaymentApplicationClient.js +46 -2106
  30. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +14 -28
  31. package/sdk/application/Rewards/RewardsApplicationClient.js +7 -311
  32. package/sdk/application/Share/ShareApplicationClient.d.ts +14 -24
  33. package/sdk/application/Share/ShareApplicationClient.js +7 -309
  34. package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -14
  35. package/sdk/application/Theme/ThemeApplicationClient.js +4 -174
  36. package/sdk/application/User/UserApplicationClient.d.ts +85 -136
  37. package/sdk/application/User/UserApplicationClient.js +42 -1818
  38. package/sdk/application/Webhook/WebhookApplicationClient.d.ts +2 -5
  39. package/sdk/application/Webhook/WebhookApplicationClient.js +1 -50
  40. package/sdk/application/index.d.ts +0 -18
  41. package/sdk/application/index.js +0 -33
  42. package/sdk/partner/OAuthClient.js +1 -0
  43. package/sdk/platform/Cart/CartPlatformModel.d.ts +7 -0
  44. package/sdk/platform/Cart/CartPlatformModel.js +3 -0
  45. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +0 -7
  46. package/sdk/platform/Catalog/CatalogPlatformModel.js +0 -3
  47. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +7 -0
  48. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +3 -0
  49. package/sdk/public/Configuration/ConfigurationPublicClient.js +4 -2
  50. package/sdk/public/Content/ContentPublicClient.js +4 -2
  51. package/sdk/public/Partner/PartnerPublicClient.js +4 -2
  52. package/sdk/public/Webhook/WebhookPublicClient.js +4 -2
  53. package/sdk/application/Cart/CartApplicationModel.d.ts +0 -3994
  54. package/sdk/application/Cart/CartApplicationModel.js +0 -2497
  55. package/sdk/application/Cart/CartApplicationValidator.d.ts +0 -769
  56. package/sdk/application/Cart/CartApplicationValidator.js +0 -530
  57. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +0 -3857
  58. package/sdk/application/Catalog/CatalogApplicationModel.js +0 -2629
  59. package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +0 -791
  60. package/sdk/application/Catalog/CatalogApplicationValidator.js +0 -551
  61. package/sdk/application/Common/CommonApplicationModel.d.ts +0 -449
  62. package/sdk/application/Common/CommonApplicationModel.js +0 -308
  63. package/sdk/application/Common/CommonApplicationValidator.d.ts +0 -46
  64. package/sdk/application/Common/CommonApplicationValidator.js +0 -38
  65. package/sdk/application/Communication/CommunicationApplicationModel.d.ts +0 -293
  66. package/sdk/application/Communication/CommunicationApplicationModel.js +0 -201
  67. package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +0 -29
  68. package/sdk/application/Communication/CommunicationApplicationValidator.js +0 -38
  69. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +0 -2556
  70. package/sdk/application/Configuration/ConfigurationApplicationModel.js +0 -1887
  71. package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +0 -179
  72. package/sdk/application/Configuration/ConfigurationApplicationValidator.js +0 -176
  73. package/sdk/application/Content/ContentApplicationModel.d.ts +0 -2133
  74. package/sdk/application/Content/ContentApplicationModel.js +0 -1589
  75. package/sdk/application/Content/ContentApplicationValidator.d.ts +0 -284
  76. package/sdk/application/Content/ContentApplicationValidator.js +0 -264
  77. package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +0 -272
  78. package/sdk/application/FileStorage/FileStorageApplicationModel.js +0 -190
  79. package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +0 -56
  80. package/sdk/application/FileStorage/FileStorageApplicationValidator.js +0 -53
  81. package/sdk/application/Lead/LeadApplicationModel.d.ts +0 -590
  82. package/sdk/application/Lead/LeadApplicationModel.js +0 -480
  83. package/sdk/application/Lead/LeadApplicationValidator.d.ts +0 -68
  84. package/sdk/application/Lead/LeadApplicationValidator.js +0 -71
  85. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +0 -1675
  86. package/sdk/application/Logistic/LogisticApplicationModel.js +0 -1121
  87. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +0 -254
  88. package/sdk/application/Logistic/LogisticApplicationValidator.js +0 -190
  89. package/sdk/application/Order/OrderApplicationModel.d.ts +0 -2296
  90. package/sdk/application/Order/OrderApplicationModel.js +0 -1471
  91. package/sdk/application/Order/OrderApplicationValidator.d.ts +0 -265
  92. package/sdk/application/Order/OrderApplicationValidator.js +0 -197
  93. package/sdk/application/Payment/PaymentApplicationModel.d.ts +0 -4058
  94. package/sdk/application/Payment/PaymentApplicationModel.js +0 -2630
  95. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +0 -576
  96. package/sdk/application/Payment/PaymentApplicationValidator.js +0 -594
  97. package/sdk/application/Rewards/RewardsApplicationModel.d.ts +0 -365
  98. package/sdk/application/Rewards/RewardsApplicationModel.js +0 -396
  99. package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +0 -73
  100. package/sdk/application/Rewards/RewardsApplicationValidator.js +0 -84
  101. package/sdk/application/Share/ShareApplicationModel.d.ts +0 -339
  102. package/sdk/application/Share/ShareApplicationModel.js +0 -234
  103. package/sdk/application/Share/ShareApplicationValidator.d.ts +0 -90
  104. package/sdk/application/Share/ShareApplicationValidator.js +0 -91
  105. package/sdk/application/Theme/ThemeApplicationModel.d.ts +0 -1713
  106. package/sdk/application/Theme/ThemeApplicationModel.js +0 -1426
  107. package/sdk/application/Theme/ThemeApplicationValidator.d.ts +0 -66
  108. package/sdk/application/Theme/ThemeApplicationValidator.js +0 -58
  109. package/sdk/application/User/UserApplicationModel.d.ts +0 -1943
  110. package/sdk/application/User/UserApplicationModel.js +0 -1382
  111. package/sdk/application/User/UserApplicationValidator.d.ts +0 -560
  112. package/sdk/application/User/UserApplicationValidator.js +0 -573
  113. package/sdk/application/Webhook/WebhookApplicationModel.d.ts +0 -52
  114. package/sdk/application/Webhook/WebhookApplicationModel.js +0 -46
  115. package/sdk/application/Webhook/WebhookApplicationValidator.d.ts +0 -16
  116. package/sdk/application/Webhook/WebhookApplicationValidator.js +0 -19
  117. package/sdk/common/Clickstream.d.ts +0 -1
  118. package/sdk/common/Clickstream.js +0 -464
@@ -1,791 +0,0 @@
1
- export = CatalogApplicationValidator;
2
- /**
3
- * @typedef FollowByIdParam
4
- * @property {string} collectionType - Type of collection followed, i.e.
5
- * products, brands, or collections.
6
- * @property {string} collectionId - The ID of the collection type.
7
- */
8
- /**
9
- * @typedef GetBrandDetailBySlugParam
10
- * @property {string} slug - A short, human-readable, URL-friendly identifier of
11
- * a brand. You can get slug value from the endpoint
12
- * /service/application/catalog/v1.0/brands/.
13
- */
14
- /**
15
- * @typedef GetBrandsParam
16
- * @property {string} [department] - The name of the department. Use this
17
- * parameter to filter products by a particular department. See the list of
18
- * available departments below. Also, you can get available departments from
19
- * the endpoint /service/application/catalog/v1.0/departments/.
20
- * @property {number} [pageNo] - The page number to navigate through the given
21
- * set of results.
22
- * @property {number} [pageSize] - The number of items to retrieve in each page.
23
- */
24
- /**
25
- * @typedef GetCategoriesParam
26
- * @property {string} [department] - The name of the department. Use this
27
- * parameter to filter products by a particular department. See the list of
28
- * available departments below. Also, you can get available departments from
29
- * the endpoint /service/application/catalog/v1.0/departments/.
30
- */
31
- /**
32
- * @typedef GetCategoryDetailBySlugParam
33
- * @property {string} slug - A short, human-readable, URL-friendly identifier of
34
- * a brand. You can get slug value from the endpoint
35
- * /service/application/catalog/v1.0/brands/.
36
- */
37
- /**
38
- * @typedef GetCollectionDetailBySlugParam
39
- * @property {string} slug - A short, human-readable, URL-friendly identifier of
40
- * a collection. You can get slug value from the endpoint
41
- * /service/application/catalog/v1.0/collections/.
42
- */
43
- /**
44
- * @typedef GetCollectionItemsBySlugParam
45
- * @property {string} slug - A short, human-readable, URL-friendly identifier of
46
- * a collection. You can get slug value from the endpoint
47
- * /service/application/catalog/v1.0/collections/.
48
- * @property {string} [f] - The search filter parameters. Filter parameters will
49
- * be passed in f parameter as shown in the example below. Double Pipe (||)
50
- * denotes the OR condition, whereas Triple-colon (:::) indicates a new filter
51
- * parameter applied as an AND condition.
52
- * @property {string} [q] - The search query for entering partial or full name
53
- * of product, brand, category, or collection.
54
- * @property {boolean} [filters] - True for fetching all filter parameters and
55
- * False for disabling the filter parameters.
56
- * @property {string} [sortOn] - The order in which the list of products should
57
- * be sorted, e.g. popularity, price, latest and discount, in either ascending
58
- * or descending order. See the supported values below.
59
- * @property {string} [pageId] - Page ID to retrieve next set of results.
60
- * @property {number} [pageSize] - The number of items to retrieve in each page.
61
- * @property {number} [pageNo] - Page Number to retrieve next set of results.
62
- * @property {string} [pageType] - Page Type to retrieve set of results can be
63
- * cursor or number.
64
- */
65
- /**
66
- * @typedef GetCollectionsParam
67
- * @property {number} [pageNo] - The page number to navigate through the given
68
- * set of results.
69
- * @property {number} [pageSize] - The number of items to retrieve in each page.
70
- * @property {string[]} [tag] - List of tags to filter collections.
71
- * @property {string} [q] - Name of the collection to filter collection.
72
- */
73
- /**
74
- * @typedef GetComparedFrequentlyProductBySlugParam
75
- * @property {string} slug - A short, human-readable, URL-friendly identifier of
76
- * a product. You can get slug value from the endpoint
77
- * /service/application/catalog/v1.0/products/.
78
- */
79
- /** @typedef GetDepartmentsParam */
80
- /**
81
- * @typedef GetFollowIdsParam
82
- * @property {string} [collectionType] - Type of collection, i.e. products,
83
- * brands, collections.
84
- */
85
- /**
86
- * @typedef GetFollowedListingParam
87
- * @property {string} collectionType - Type of collection followed, i.e.
88
- * products, brands, or collections.
89
- * @property {string} [pageId] - Page ID to retrieve next set of results.
90
- * @property {number} [pageSize] - Page ID to retrieve next set of results.
91
- */
92
- /**
93
- * @typedef GetFollowerCountByIdParam
94
- * @property {string} collectionType - Type of collection, i.e. products,
95
- * brands, or collections.
96
- * @property {string} collectionId - The ID of the collection type.
97
- */
98
- /**
99
- * @typedef GetHomeProductsParam
100
- * @property {string} [sortOn] - The order in which the list of products should
101
- * be sorted, e.g. popularity, price, latest and discount, in either ascending
102
- * or descending order.
103
- * @property {string} [pageId] - Page ID to retrieve next set of results.
104
- * @property {number} [pageSize] - The number of items to retrieve in each page.
105
- */
106
- /**
107
- * @typedef GetInStockLocationsParam
108
- * @property {number} [pageNo] - The page number to navigate through the given
109
- * set of results.
110
- * @property {number} [pageSize] - Number of items to retrieve in each page.
111
- * @property {string} [q] - Search a store by its name or store_code.
112
- * @property {string} [city] - Search stores by the city in which they are situated.
113
- * @property {number} [range] - Use this to retrieve stores within a particular
114
- * range in meters, e.g. 10000, to indicate a 10km range.
115
- * @property {number} [latitude] - Latitude of the location from where one wants
116
- * to retrieve the nearest stores, e.g. 72.8691788.
117
- * @property {number} [longitude] - Longitude of the location from where one
118
- * wants to retrieve the nearest stores, e.g. 19.1174114.
119
- */
120
- /**
121
- * @typedef GetLocationDetailsByIdParam
122
- * @property {number} locationId - Unique Location ID.
123
- */
124
- /**
125
- * @typedef GetProductBundlesBySlugParam
126
- * @property {string} [slug] - Product slug for which bundles need to be fetched.
127
- * @property {string} [id] - Product uid.
128
- */
129
- /**
130
- * @typedef GetProductComparisonBySlugsParam
131
- * @property {string[]} slug - A short, human-readable, URL-friendly identifier
132
- * of a product. You can get slug value from the endpoint
133
- * /service/application/catalog/v1.0/products/.
134
- */
135
- /**
136
- * @typedef GetProductDetailBySlugParam
137
- * @property {string} slug - A short, human-readable, URL-friendly identifier of
138
- * a product. You can get slug value from the endpoint
139
- * /service/application/catalog/v1.0/products/.
140
- */
141
- /**
142
- * @typedef GetProductPriceBySlugParam
143
- * @property {string} slug - A short, human-readable, URL-friendly identifier of
144
- * a product. You can get slug value from the endpoint
145
- * /service/application/catalog/v1.0/products/.
146
- * @property {string} size - A string indicating the size of the product, e.g.
147
- * S, M, XL. You can get slug value from the endpoint
148
- * /service/application/catalog/v1.0/products/sizes.
149
- * @property {number} [storeId] - The ID of the store that is selling the
150
- * product, e.g. 1,2,3.
151
- * @property {number} [moq] - An Integer indication the Minimum Order Quantity
152
- * of a product, e.g. 100.
153
- */
154
- /**
155
- * @typedef GetProductSellersBySlugParam
156
- * @property {string} slug - A short, human-readable, URL-friendly identifier of
157
- * a product. You can get slug value from the endpoint
158
- * /service/application/catalog/v1.0/products/.
159
- * @property {string} size - A string indicating the size of the product, e.g.
160
- * S, M, XL. You can get slug value from the endpoint
161
- * /service/application/catalog/v1.0/products/sizes.
162
- * @property {string} [strategy] - Sort stores on the basis of strategy. eg,
163
- * fast-delivery, low-price, optimal.
164
- * @property {number} [pageNo] - The page number to navigate through the given
165
- * set of results.
166
- * @property {number} [pageSize] - The number of items to retrieve in each page.
167
- */
168
- /**
169
- * @typedef GetProductSizesBySlugParam
170
- * @property {string} slug - A short, human-readable, URL-friendly identifier of
171
- * a product. You can get slug value from the endpoint
172
- * /service/application/catalog/v1.0/products/.
173
- * @property {number} [storeId] - The ID of the store that is selling the
174
- * product, e.g. 1,2,3.
175
- */
176
- /**
177
- * @typedef GetProductStockByIdsParam
178
- * @property {string} [itemId] - The Item ID of the product (Max. 50 allowed).
179
- * @property {string} [alu] - ALU of the product (limited upto 50 ALU identifier
180
- * in a single request).
181
- * @property {string} [skuCode] - Stock-keeping Unit of the product (limited
182
- * upto 50 SKU Code in a single request).
183
- * @property {string} [ean] - European Article Number of the product (limited
184
- * upto 50 EAN identifier in a single request).
185
- * @property {string} [upc] - Universal Product Code of the product (limited
186
- * upto 50 UPC identifier in a single request).
187
- */
188
- /**
189
- * @typedef GetProductStockForTimeByIdsParam
190
- * @property {string} timestamp - Timestamp in UTC format (2020-07-23T10:27:50Z).
191
- * @property {number} [pageSize] - The number of items to retrieve in each page.
192
- * @property {string} [pageId] - Page ID to retrieve next set of results.
193
- */
194
- /**
195
- * @typedef GetProductVariantsBySlugParam
196
- * @property {string} slug - A short, human-readable, URL-friendly identifier of
197
- * a product. You can get slug value from the endpoint
198
- * /service/application/catalog/v1.0/products/.
199
- */
200
- /**
201
- * @typedef GetProductsParam
202
- * @property {string} [q] - The search query for entering partial or full name
203
- * of product, brand, category, or collection.
204
- * @property {string} [f] - The search filter parameters. Filter parameters will
205
- * be passed in f parameter as shown in the example below. Double Pipe (||)
206
- * denotes the OR condition, whereas Triple-colon (:::) indicates a new filter
207
- * parameter applied as an AND condition.
208
- * @property {boolean} [filters] - True for fetching all filter parameters and
209
- * False for disabling the filter parameters.
210
- * @property {string} [sortOn] - The order in which the list of products should
211
- * be sorted, e.g. popularity, price, latest and discount, in either ascending
212
- * or descending order. See the supported values below.
213
- * @property {string} [pageId] - Page ID to retrieve next set of results.
214
- * @property {number} [pageSize] - The number of items to retrieve in each page.
215
- * @property {number} [pageNo] - The page number to navigate through the given
216
- * set of results.
217
- * @property {string} [pageType] - Available pagination types are cursor or number.
218
- */
219
- /**
220
- * @typedef GetSearchResultsParam
221
- * @property {string} q - The search query for entering partial or full name of
222
- * a product, brand or category. For example, if the given search query `q` is
223
- * _ski_, the relevant search suggestions could be _skirt_, _ski shoes_,
224
- * __skin cream_ etc.
225
- */
226
- /**
227
- * @typedef GetSimilarComparisonProductBySlugParam
228
- * @property {string} slug - A short, human-readable, URL-friendly identifier of
229
- * a product. You can get slug value from the endpoint
230
- * /service/application/catalog/v1.0/products/.
231
- */
232
- /**
233
- * @typedef GetStoresParam
234
- * @property {number} [pageNo] - The page number to navigate through the given
235
- * set of results.
236
- * @property {number} [pageSize] - Number of items to retrieve in each page.
237
- * @property {string} [q] - Search a store by its name or store_code.
238
- * @property {string} [city] - Search stores by the city in which they are situated.
239
- * @property {number} [range] - Use this to retrieve stores within a particular
240
- * range in meters, e.g. 10000, to indicate a 10km range.
241
- * @property {number} [latitude] - Latitude of the location from where one wants
242
- * to retrieve the nearest stores, e.g. 72.8691788.
243
- * @property {number} [longitude] - Longitude of the location from where one
244
- * wants to retrieve the nearest stores, e.g. 19.1174114.
245
- * @property {string} [tags] - Search stores based on tags.
246
- */
247
- /**
248
- * @typedef UnfollowByIdParam
249
- * @property {string} collectionType - Type of collection followed, i.e.
250
- * products, brands, or collections.
251
- * @property {string} collectionId - The ID of the collection type.
252
- */
253
- declare class CatalogApplicationValidator {
254
- /** @returns {FollowByIdParam} */
255
- static followById(): FollowByIdParam;
256
- /** @returns {GetBrandDetailBySlugParam} */
257
- static getBrandDetailBySlug(): GetBrandDetailBySlugParam;
258
- /** @returns {GetBrandsParam} */
259
- static getBrands(): GetBrandsParam;
260
- /** @returns {GetCategoriesParam} */
261
- static getCategories(): GetCategoriesParam;
262
- /** @returns {GetCategoryDetailBySlugParam} */
263
- static getCategoryDetailBySlug(): GetCategoryDetailBySlugParam;
264
- /** @returns {GetCollectionDetailBySlugParam} */
265
- static getCollectionDetailBySlug(): GetCollectionDetailBySlugParam;
266
- /** @returns {GetCollectionItemsBySlugParam} */
267
- static getCollectionItemsBySlug(): GetCollectionItemsBySlugParam;
268
- /** @returns {GetCollectionsParam} */
269
- static getCollections(): GetCollectionsParam;
270
- /** @returns {GetComparedFrequentlyProductBySlugParam} */
271
- static getComparedFrequentlyProductBySlug(): GetComparedFrequentlyProductBySlugParam;
272
- /** @returns {GetDepartmentsParam} */
273
- static getDepartments(): any;
274
- /** @returns {GetFollowIdsParam} */
275
- static getFollowIds(): GetFollowIdsParam;
276
- /** @returns {GetFollowedListingParam} */
277
- static getFollowedListing(): GetFollowedListingParam;
278
- /** @returns {GetFollowerCountByIdParam} */
279
- static getFollowerCountById(): GetFollowerCountByIdParam;
280
- /** @returns {GetHomeProductsParam} */
281
- static getHomeProducts(): GetHomeProductsParam;
282
- /** @returns {GetInStockLocationsParam} */
283
- static getInStockLocations(): GetInStockLocationsParam;
284
- /** @returns {GetLocationDetailsByIdParam} */
285
- static getLocationDetailsById(): GetLocationDetailsByIdParam;
286
- /** @returns {GetProductBundlesBySlugParam} */
287
- static getProductBundlesBySlug(): GetProductBundlesBySlugParam;
288
- /** @returns {GetProductComparisonBySlugsParam} */
289
- static getProductComparisonBySlugs(): GetProductComparisonBySlugsParam;
290
- /** @returns {GetProductDetailBySlugParam} */
291
- static getProductDetailBySlug(): GetProductDetailBySlugParam;
292
- /** @returns {GetProductPriceBySlugParam} */
293
- static getProductPriceBySlug(): GetProductPriceBySlugParam;
294
- /** @returns {GetProductSellersBySlugParam} */
295
- static getProductSellersBySlug(): GetProductSellersBySlugParam;
296
- /** @returns {GetProductSizesBySlugParam} */
297
- static getProductSizesBySlug(): GetProductSizesBySlugParam;
298
- /** @returns {GetProductStockByIdsParam} */
299
- static getProductStockByIds(): GetProductStockByIdsParam;
300
- /** @returns {GetProductStockForTimeByIdsParam} */
301
- static getProductStockForTimeByIds(): GetProductStockForTimeByIdsParam;
302
- /** @returns {GetProductVariantsBySlugParam} */
303
- static getProductVariantsBySlug(): GetProductVariantsBySlugParam;
304
- /** @returns {GetProductsParam} */
305
- static getProducts(): GetProductsParam;
306
- /** @returns {GetSearchResultsParam} */
307
- static getSearchResults(): GetSearchResultsParam;
308
- /** @returns {GetSimilarComparisonProductBySlugParam} */
309
- static getSimilarComparisonProductBySlug(): GetSimilarComparisonProductBySlugParam;
310
- /** @returns {GetStoresParam} */
311
- static getStores(): GetStoresParam;
312
- /** @returns {UnfollowByIdParam} */
313
- static unfollowById(): UnfollowByIdParam;
314
- }
315
- declare namespace CatalogApplicationValidator {
316
- export { FollowByIdParam, GetBrandDetailBySlugParam, GetBrandsParam, GetCategoriesParam, GetCategoryDetailBySlugParam, GetCollectionDetailBySlugParam, GetCollectionItemsBySlugParam, GetCollectionsParam, GetComparedFrequentlyProductBySlugParam, GetDepartmentsParam, GetFollowIdsParam, GetFollowedListingParam, GetFollowerCountByIdParam, GetHomeProductsParam, GetInStockLocationsParam, GetLocationDetailsByIdParam, GetProductBundlesBySlugParam, GetProductComparisonBySlugsParam, GetProductDetailBySlugParam, GetProductPriceBySlugParam, GetProductSellersBySlugParam, GetProductSizesBySlugParam, GetProductStockByIdsParam, GetProductStockForTimeByIdsParam, GetProductVariantsBySlugParam, GetProductsParam, GetSearchResultsParam, GetSimilarComparisonProductBySlugParam, GetStoresParam, UnfollowByIdParam };
317
- }
318
- type FollowByIdParam = {
319
- /**
320
- * - Type of collection followed, i.e.
321
- * products, brands, or collections.
322
- */
323
- collectionType: string;
324
- /**
325
- * - The ID of the collection type.
326
- */
327
- collectionId: string;
328
- };
329
- type GetBrandDetailBySlugParam = {
330
- /**
331
- * - A short, human-readable, URL-friendly identifier of
332
- * a brand. You can get slug value from the endpoint
333
- * /service/application/catalog/v1.0/brands/.
334
- */
335
- slug: string;
336
- };
337
- type GetBrandsParam = {
338
- /**
339
- * - The name of the department. Use this
340
- * parameter to filter products by a particular department. See the list of
341
- * available departments below. Also, you can get available departments from
342
- * the endpoint /service/application/catalog/v1.0/departments/.
343
- */
344
- department?: string;
345
- /**
346
- * - The page number to navigate through the given
347
- * set of results.
348
- */
349
- pageNo?: number;
350
- /**
351
- * - The number of items to retrieve in each page.
352
- */
353
- pageSize?: number;
354
- };
355
- type GetCategoriesParam = {
356
- /**
357
- * - The name of the department. Use this
358
- * parameter to filter products by a particular department. See the list of
359
- * available departments below. Also, you can get available departments from
360
- * the endpoint /service/application/catalog/v1.0/departments/.
361
- */
362
- department?: string;
363
- };
364
- type GetCategoryDetailBySlugParam = {
365
- /**
366
- * - A short, human-readable, URL-friendly identifier of
367
- * a brand. You can get slug value from the endpoint
368
- * /service/application/catalog/v1.0/brands/.
369
- */
370
- slug: string;
371
- };
372
- type GetCollectionDetailBySlugParam = {
373
- /**
374
- * - A short, human-readable, URL-friendly identifier of
375
- * a collection. You can get slug value from the endpoint
376
- * /service/application/catalog/v1.0/collections/.
377
- */
378
- slug: string;
379
- };
380
- type GetCollectionItemsBySlugParam = {
381
- /**
382
- * - A short, human-readable, URL-friendly identifier of
383
- * a collection. You can get slug value from the endpoint
384
- * /service/application/catalog/v1.0/collections/.
385
- */
386
- slug: string;
387
- /**
388
- * - The search filter parameters. Filter parameters will
389
- * be passed in f parameter as shown in the example below. Double Pipe (||)
390
- * denotes the OR condition, whereas Triple-colon (:::) indicates a new filter
391
- * parameter applied as an AND condition.
392
- */
393
- f?: string;
394
- /**
395
- * - The search query for entering partial or full name
396
- * of product, brand, category, or collection.
397
- */
398
- q?: string;
399
- /**
400
- * - True for fetching all filter parameters and
401
- * False for disabling the filter parameters.
402
- */
403
- filters?: boolean;
404
- /**
405
- * - The order in which the list of products should
406
- * be sorted, e.g. popularity, price, latest and discount, in either ascending
407
- * or descending order. See the supported values below.
408
- */
409
- sortOn?: string;
410
- /**
411
- * - Page ID to retrieve next set of results.
412
- */
413
- pageId?: string;
414
- /**
415
- * - The number of items to retrieve in each page.
416
- */
417
- pageSize?: number;
418
- /**
419
- * - Page Number to retrieve next set of results.
420
- */
421
- pageNo?: number;
422
- /**
423
- * - Page Type to retrieve set of results can be
424
- * cursor or number.
425
- */
426
- pageType?: string;
427
- };
428
- type GetCollectionsParam = {
429
- /**
430
- * - The page number to navigate through the given
431
- * set of results.
432
- */
433
- pageNo?: number;
434
- /**
435
- * - The number of items to retrieve in each page.
436
- */
437
- pageSize?: number;
438
- /**
439
- * - List of tags to filter collections.
440
- */
441
- tag?: string[];
442
- /**
443
- * - Name of the collection to filter collection.
444
- */
445
- q?: string;
446
- };
447
- type GetComparedFrequentlyProductBySlugParam = {
448
- /**
449
- * - A short, human-readable, URL-friendly identifier of
450
- * a product. You can get slug value from the endpoint
451
- * /service/application/catalog/v1.0/products/.
452
- */
453
- slug: string;
454
- };
455
- type GetFollowIdsParam = {
456
- /**
457
- * - Type of collection, i.e. products,
458
- * brands, collections.
459
- */
460
- collectionType?: string;
461
- };
462
- type GetFollowedListingParam = {
463
- /**
464
- * - Type of collection followed, i.e.
465
- * products, brands, or collections.
466
- */
467
- collectionType: string;
468
- /**
469
- * - Page ID to retrieve next set of results.
470
- */
471
- pageId?: string;
472
- /**
473
- * - Page ID to retrieve next set of results.
474
- */
475
- pageSize?: number;
476
- };
477
- type GetFollowerCountByIdParam = {
478
- /**
479
- * - Type of collection, i.e. products,
480
- * brands, or collections.
481
- */
482
- collectionType: string;
483
- /**
484
- * - The ID of the collection type.
485
- */
486
- collectionId: string;
487
- };
488
- type GetHomeProductsParam = {
489
- /**
490
- * - The order in which the list of products should
491
- * be sorted, e.g. popularity, price, latest and discount, in either ascending
492
- * or descending order.
493
- */
494
- sortOn?: string;
495
- /**
496
- * - Page ID to retrieve next set of results.
497
- */
498
- pageId?: string;
499
- /**
500
- * - The number of items to retrieve in each page.
501
- */
502
- pageSize?: number;
503
- };
504
- type GetInStockLocationsParam = {
505
- /**
506
- * - The page number to navigate through the given
507
- * set of results.
508
- */
509
- pageNo?: number;
510
- /**
511
- * - Number of items to retrieve in each page.
512
- */
513
- pageSize?: number;
514
- /**
515
- * - Search a store by its name or store_code.
516
- */
517
- q?: string;
518
- /**
519
- * - Search stores by the city in which they are situated.
520
- */
521
- city?: string;
522
- /**
523
- * - Use this to retrieve stores within a particular
524
- * range in meters, e.g. 10000, to indicate a 10km range.
525
- */
526
- range?: number;
527
- /**
528
- * - Latitude of the location from where one wants
529
- * to retrieve the nearest stores, e.g. 72.8691788.
530
- */
531
- latitude?: number;
532
- /**
533
- * - Longitude of the location from where one
534
- * wants to retrieve the nearest stores, e.g. 19.1174114.
535
- */
536
- longitude?: number;
537
- };
538
- type GetLocationDetailsByIdParam = {
539
- /**
540
- * - Unique Location ID.
541
- */
542
- locationId: number;
543
- };
544
- type GetProductBundlesBySlugParam = {
545
- /**
546
- * - Product slug for which bundles need to be fetched.
547
- */
548
- slug?: string;
549
- /**
550
- * - Product uid.
551
- */
552
- id?: string;
553
- };
554
- type GetProductComparisonBySlugsParam = {
555
- /**
556
- * - A short, human-readable, URL-friendly identifier
557
- * of a product. You can get slug value from the endpoint
558
- * /service/application/catalog/v1.0/products/.
559
- */
560
- slug: string[];
561
- };
562
- type GetProductDetailBySlugParam = {
563
- /**
564
- * - A short, human-readable, URL-friendly identifier of
565
- * a product. You can get slug value from the endpoint
566
- * /service/application/catalog/v1.0/products/.
567
- */
568
- slug: string;
569
- };
570
- type GetProductPriceBySlugParam = {
571
- /**
572
- * - A short, human-readable, URL-friendly identifier of
573
- * a product. You can get slug value from the endpoint
574
- * /service/application/catalog/v1.0/products/.
575
- */
576
- slug: string;
577
- /**
578
- * - A string indicating the size of the product, e.g.
579
- * S, M, XL. You can get slug value from the endpoint
580
- * /service/application/catalog/v1.0/products/sizes.
581
- */
582
- size: string;
583
- /**
584
- * - The ID of the store that is selling the
585
- * product, e.g. 1,2,3.
586
- */
587
- storeId?: number;
588
- /**
589
- * - An Integer indication the Minimum Order Quantity
590
- * of a product, e.g. 100.
591
- */
592
- moq?: number;
593
- };
594
- type GetProductSellersBySlugParam = {
595
- /**
596
- * - A short, human-readable, URL-friendly identifier of
597
- * a product. You can get slug value from the endpoint
598
- * /service/application/catalog/v1.0/products/.
599
- */
600
- slug: string;
601
- /**
602
- * - A string indicating the size of the product, e.g.
603
- * S, M, XL. You can get slug value from the endpoint
604
- * /service/application/catalog/v1.0/products/sizes.
605
- */
606
- size: string;
607
- /**
608
- * - Sort stores on the basis of strategy. eg,
609
- * fast-delivery, low-price, optimal.
610
- */
611
- strategy?: string;
612
- /**
613
- * - The page number to navigate through the given
614
- * set of results.
615
- */
616
- pageNo?: number;
617
- /**
618
- * - The number of items to retrieve in each page.
619
- */
620
- pageSize?: number;
621
- };
622
- type GetProductSizesBySlugParam = {
623
- /**
624
- * - A short, human-readable, URL-friendly identifier of
625
- * a product. You can get slug value from the endpoint
626
- * /service/application/catalog/v1.0/products/.
627
- */
628
- slug: string;
629
- /**
630
- * - The ID of the store that is selling the
631
- * product, e.g. 1,2,3.
632
- */
633
- storeId?: number;
634
- };
635
- type GetProductStockByIdsParam = {
636
- /**
637
- * - The Item ID of the product (Max. 50 allowed).
638
- */
639
- itemId?: string;
640
- /**
641
- * - ALU of the product (limited upto 50 ALU identifier
642
- * in a single request).
643
- */
644
- alu?: string;
645
- /**
646
- * - Stock-keeping Unit of the product (limited
647
- * upto 50 SKU Code in a single request).
648
- */
649
- skuCode?: string;
650
- /**
651
- * - European Article Number of the product (limited
652
- * upto 50 EAN identifier in a single request).
653
- */
654
- ean?: string;
655
- /**
656
- * - Universal Product Code of the product (limited
657
- * upto 50 UPC identifier in a single request).
658
- */
659
- upc?: string;
660
- };
661
- type GetProductStockForTimeByIdsParam = {
662
- /**
663
- * - Timestamp in UTC format (2020-07-23T10:27:50Z).
664
- */
665
- timestamp: string;
666
- /**
667
- * - The number of items to retrieve in each page.
668
- */
669
- pageSize?: number;
670
- /**
671
- * - Page ID to retrieve next set of results.
672
- */
673
- pageId?: string;
674
- };
675
- type GetProductVariantsBySlugParam = {
676
- /**
677
- * - A short, human-readable, URL-friendly identifier of
678
- * a product. You can get slug value from the endpoint
679
- * /service/application/catalog/v1.0/products/.
680
- */
681
- slug: string;
682
- };
683
- type GetProductsParam = {
684
- /**
685
- * - The search query for entering partial or full name
686
- * of product, brand, category, or collection.
687
- */
688
- q?: string;
689
- /**
690
- * - The search filter parameters. Filter parameters will
691
- * be passed in f parameter as shown in the example below. Double Pipe (||)
692
- * denotes the OR condition, whereas Triple-colon (:::) indicates a new filter
693
- * parameter applied as an AND condition.
694
- */
695
- f?: string;
696
- /**
697
- * - True for fetching all filter parameters and
698
- * False for disabling the filter parameters.
699
- */
700
- filters?: boolean;
701
- /**
702
- * - The order in which the list of products should
703
- * be sorted, e.g. popularity, price, latest and discount, in either ascending
704
- * or descending order. See the supported values below.
705
- */
706
- sortOn?: string;
707
- /**
708
- * - Page ID to retrieve next set of results.
709
- */
710
- pageId?: string;
711
- /**
712
- * - The number of items to retrieve in each page.
713
- */
714
- pageSize?: number;
715
- /**
716
- * - The page number to navigate through the given
717
- * set of results.
718
- */
719
- pageNo?: number;
720
- /**
721
- * - Available pagination types are cursor or number.
722
- */
723
- pageType?: string;
724
- };
725
- type GetSearchResultsParam = {
726
- /**
727
- * - The search query for entering partial or full name of
728
- * a product, brand or category. For example, if the given search query `q` is
729
- * _ski_, the relevant search suggestions could be _skirt_, _ski shoes_,
730
- * __skin cream_ etc.
731
- */
732
- q: string;
733
- };
734
- type GetSimilarComparisonProductBySlugParam = {
735
- /**
736
- * - A short, human-readable, URL-friendly identifier of
737
- * a product. You can get slug value from the endpoint
738
- * /service/application/catalog/v1.0/products/.
739
- */
740
- slug: string;
741
- };
742
- type GetStoresParam = {
743
- /**
744
- * - The page number to navigate through the given
745
- * set of results.
746
- */
747
- pageNo?: number;
748
- /**
749
- * - Number of items to retrieve in each page.
750
- */
751
- pageSize?: number;
752
- /**
753
- * - Search a store by its name or store_code.
754
- */
755
- q?: string;
756
- /**
757
- * - Search stores by the city in which they are situated.
758
- */
759
- city?: string;
760
- /**
761
- * - Use this to retrieve stores within a particular
762
- * range in meters, e.g. 10000, to indicate a 10km range.
763
- */
764
- range?: number;
765
- /**
766
- * - Latitude of the location from where one wants
767
- * to retrieve the nearest stores, e.g. 72.8691788.
768
- */
769
- latitude?: number;
770
- /**
771
- * - Longitude of the location from where one
772
- * wants to retrieve the nearest stores, e.g. 19.1174114.
773
- */
774
- longitude?: number;
775
- /**
776
- * - Search stores based on tags.
777
- */
778
- tags?: string;
779
- };
780
- type UnfollowByIdParam = {
781
- /**
782
- * - Type of collection followed, i.e.
783
- * products, brands, or collections.
784
- */
785
- collectionType: string;
786
- /**
787
- * - The ID of the collection type.
788
- */
789
- collectionId: string;
790
- };
791
- type GetDepartmentsParam = any;