@gofynd/fdk-client-javascript 0.1.35 → 0.1.37

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 +1 -1
  2. package/documentation/application/CART.md +272 -249
  3. package/documentation/application/CATALOG.md +417 -413
  4. package/documentation/application/COMMON.md +4 -0
  5. package/documentation/application/COMMUNICATION.md +4 -0
  6. package/documentation/application/CONFIGURATION.md +4 -0
  7. package/documentation/application/CONTENT.md +7 -20
  8. package/documentation/application/FILESTORAGE.md +85 -0
  9. package/documentation/application/LEAD.md +6 -2
  10. package/documentation/application/LOGISTIC.md +427 -101
  11. package/documentation/application/ORDER.md +292 -288
  12. package/documentation/application/PAYMENT.md +445 -259
  13. package/documentation/application/POSCART.md +309 -286
  14. package/documentation/application/README.md +1 -1
  15. package/documentation/application/REWARDS.md +153 -160
  16. package/documentation/application/SHARE.md +4 -0
  17. package/documentation/application/THEME.md +4 -0
  18. package/documentation/application/USER.md +4 -0
  19. package/documentation/platform/ANALYTICS.md +4 -0
  20. package/documentation/platform/AUDITTRAIL.md +6 -2
  21. package/documentation/platform/BILLING.md +4 -0
  22. package/documentation/platform/CART.md +476 -459
  23. package/documentation/platform/CATALOG.md +4138 -2968
  24. package/documentation/platform/COMMON.md +4 -0
  25. package/documentation/platform/COMMUNICATION.md +4 -0
  26. package/documentation/platform/COMPANYPROFILE.md +258 -206
  27. package/documentation/platform/CONFIGURATION.md +4 -0
  28. package/documentation/platform/CONTENT.md +8 -21
  29. package/documentation/platform/DISCOUNT.md +4 -0
  30. package/documentation/platform/FILESTORAGE.md +85 -0
  31. package/documentation/platform/INVENTORY.md +4 -0
  32. package/documentation/platform/LEAD.md +6 -2
  33. package/documentation/platform/ORDER.md +6298 -1448
  34. package/documentation/platform/PARTNER.md +12 -8
  35. package/documentation/platform/PAYMENT.md +107 -103
  36. package/documentation/platform/README.md +2 -2
  37. package/documentation/platform/REWARDS.md +219 -152
  38. package/documentation/platform/SHARE.md +4 -0
  39. package/documentation/platform/THEME.md +4 -0
  40. package/documentation/platform/USER.md +4 -0
  41. package/documentation/platform/WEBHOOK.md +4 -0
  42. package/documentation/public/CONFIGURATION.md +4 -0
  43. package/documentation/public/INVENTORY.md +4 -0
  44. package/documentation/public/WEBHOOK.md +4 -0
  45. package/package.json +2 -2
  46. package/sdk/application/ApplicationAPIClient.js +3 -0
  47. package/sdk/application/ApplicationClient.d.ts +1 -0
  48. package/sdk/application/ApplicationClient.js +11 -1
  49. package/sdk/application/ApplicationConfig.d.ts +1 -0
  50. package/sdk/application/ApplicationConfig.js +1 -0
  51. package/sdk/application/ApplicationModels.d.ts +94 -85
  52. package/sdk/application/ApplicationModels.js +1909 -1792
  53. package/sdk/application/client/CartApplicationClient.d.ts +36 -36
  54. package/sdk/application/client/CatalogApplicationClient.d.ts +39 -39
  55. package/sdk/application/client/CatalogApplicationClient.js +16 -16
  56. package/sdk/application/client/CommonApplicationClient.d.ts +2 -2
  57. package/sdk/application/client/CommunicationApplicationClient.d.ts +5 -5
  58. package/sdk/application/client/ConfigurationApplicationClient.d.ts +17 -17
  59. package/sdk/application/client/ContentApplicationClient.d.ts +19 -19
  60. package/sdk/application/client/FileStorageApplicationClient.d.ts +14 -6
  61. package/sdk/application/client/FileStorageApplicationClient.js +2 -0
  62. package/sdk/application/client/LeadApplicationClient.d.ts +10 -10
  63. package/sdk/application/client/LogisticApplicationClient.d.ts +32 -21
  64. package/sdk/application/client/LogisticApplicationClient.js +62 -27
  65. package/sdk/application/client/OrderApplicationClient.d.ts +15 -15
  66. package/sdk/application/client/OrderApplicationClient.js +1 -1
  67. package/sdk/application/client/PaymentApplicationClient.d.ts +79 -57
  68. package/sdk/application/client/PaymentApplicationClient.js +66 -0
  69. package/sdk/application/client/PosCartApplicationClient.d.ts +38 -38
  70. package/sdk/application/client/RewardsApplicationClient.d.ts +34 -34
  71. package/sdk/application/client/RewardsApplicationClient.js +77 -77
  72. package/sdk/application/client/ShareApplicationClient.d.ts +8 -8
  73. package/sdk/application/client/ThemeApplicationClient.d.ts +4 -4
  74. package/sdk/application/client/UserApplicationClient.d.ts +63 -63
  75. package/sdk/application/models/CatalogValidator.d.ts +1 -1
  76. package/sdk/application/models/CatalogValidator.js +2 -2
  77. package/sdk/application/models/LogisticValidator.d.ts +2 -1
  78. package/sdk/application/models/LogisticValidator.js +11 -6
  79. package/sdk/application/models/PaymentValidator.d.ts +2 -0
  80. package/sdk/application/models/PaymentValidator.js +12 -0
  81. package/sdk/application/models/RewardsValidator.d.ts +3 -3
  82. package/sdk/application/models/RewardsValidator.js +12 -12
  83. package/sdk/common/AxiosHelper.js +1 -1
  84. package/sdk/common/Constant.d.ts +9 -0
  85. package/sdk/common/Constant.js +11 -0
  86. package/sdk/platform/PlatformApplicationClient.d.ts +7962 -6505
  87. package/sdk/platform/PlatformApplicationClient.js +4377 -3635
  88. package/sdk/platform/PlatformApplicationModels.d.ts +26 -31
  89. package/sdk/platform/PlatformApplicationModels.js +5530 -4134
  90. package/sdk/platform/PlatformClient.d.ts +3495 -2780
  91. package/sdk/platform/PlatformClient.js +3985 -3108
  92. package/sdk/platform/PlatformModels.d.ts +354 -273
  93. package/sdk/platform/PlatformModels.js +5635 -4211
  94. package/sdk/platform/client/AnalyticsPlatformClient.d.ts +5 -5
  95. package/sdk/platform/client/AuditTrailPlatformClient.d.ts +1 -1
  96. package/sdk/platform/client/BillingPlatformClient.d.ts +4 -4
  97. package/sdk/platform/client/CatalogPlatformClient.d.ts +222 -154
  98. package/sdk/platform/client/CatalogPlatformClient.js +473 -295
  99. package/sdk/platform/client/CompanyProfilePlatformClient.d.ts +8 -8
  100. package/sdk/platform/client/ConfigurationPlatformClient.d.ts +9 -9
  101. package/sdk/platform/client/DiscountPlatformClient.d.ts +4 -4
  102. package/sdk/platform/client/FileStoragePlatformClient.d.ts +20 -4
  103. package/sdk/platform/client/FileStoragePlatformClient.js +49 -0
  104. package/sdk/platform/client/InventoryPlatformClient.d.ts +3 -3
  105. package/sdk/platform/client/LeadPlatformClient.d.ts +6 -6
  106. package/sdk/platform/client/OrderPlatformClient.d.ts +557 -131
  107. package/sdk/platform/client/OrderPlatformClient.js +1551 -247
  108. package/sdk/platform/client/PaymentPlatformClient.d.ts +4 -4
  109. package/sdk/platform/client/WebhookPlatformClient.d.ts +2 -2
  110. package/sdk/platform/models/CatalogValidator.d.ts +26 -22
  111. package/sdk/platform/models/CatalogValidator.js +109 -72
  112. package/sdk/platform/models/OrderValidator.d.ts +43 -11
  113. package/sdk/platform/models/OrderValidator.js +312 -51
  114. package/sdk/public/client/ConfigurationPublicClient.d.ts +2 -2
  115. package/sdk/public/client/InventoryPublicClient.d.ts +7 -7
  116. package/sdk/public/client/WebhookPublicClient.d.ts +3 -3
  117. package/tests/common/schema/action-url.json +15 -0
  118. package/tests/common/schema/url-action.json +16 -0
@@ -49,7 +49,7 @@ declare class Cart {
49
49
  b?: boolean;
50
50
  assignCardId?: number;
51
51
  buyNow?: boolean;
52
- }): Promise<any>;
52
+ }): Promise<CartDetailResponse>;
53
53
  /**
54
54
  * @param {Object} arg - Arg object.
55
55
  * @param {string} [arg.id] -
@@ -74,8 +74,8 @@ declare class Cart {
74
74
  i?: boolean;
75
75
  b?: boolean;
76
76
  buyNow?: boolean;
77
- body: any;
78
- }): Promise<any>;
77
+ body: AddCartRequest;
78
+ }): Promise<AddCartDetailResponse>;
79
79
  /**
80
80
  * @param {Object} arg - Arg object.
81
81
  * @param {string} [arg.id] -
@@ -92,8 +92,8 @@ declare class Cart {
92
92
  i?: boolean;
93
93
  b?: boolean;
94
94
  buyNow?: boolean;
95
- body: any;
96
- }): Promise<any>;
95
+ body: UpdateCartRequest;
96
+ }): Promise<UpdateCartDetailResponse>;
97
97
  /**
98
98
  * @param {Object} arg - Arg object.
99
99
  * @param {string} [arg.id] - The unique identifier of the cart.
@@ -105,7 +105,7 @@ declare class Cart {
105
105
  getItemCount({ id, buyNow }?: {
106
106
  id?: string;
107
107
  buyNow?: boolean;
108
- }): Promise<any>;
108
+ }): Promise<CartItemCountResponse>;
109
109
  /**
110
110
  * @param {Object} arg - Arg object.
111
111
  * @param {string} [arg.id] -
@@ -117,7 +117,7 @@ declare class Cart {
117
117
  getCoupons({ id, buyNow }?: {
118
118
  id?: string;
119
119
  buyNow?: boolean;
120
- }): Promise<any>;
120
+ }): Promise<GetCouponResponse>;
121
121
  /**
122
122
  * @param {Object} arg - Arg object.
123
123
  * @param {boolean} [arg.i] -
@@ -136,8 +136,8 @@ declare class Cart {
136
136
  p?: boolean;
137
137
  id?: string;
138
138
  buyNow?: boolean;
139
- body: any;
140
- }): Promise<any>;
139
+ body: ApplyCouponRequest;
140
+ }): Promise<CartDetailResponse>;
141
141
  /**
142
142
  * @param {Object} arg - Arg object.
143
143
  * @param {string} [arg.id] -
@@ -149,7 +149,7 @@ declare class Cart {
149
149
  removeCoupon({ id, buyNow }?: {
150
150
  id?: string;
151
151
  buyNow?: boolean;
152
- }): Promise<any>;
152
+ }): Promise<CartDetailResponse>;
153
153
  /**
154
154
  * @param {Object} arg - Arg object.
155
155
  * @param {number} [arg.itemId] - The Item ID of the product
@@ -167,7 +167,7 @@ declare class Cart {
167
167
  articleId?: string;
168
168
  uid?: number;
169
169
  slug?: string;
170
- }): Promise<any>;
170
+ }): Promise<BulkPriceResponse>;
171
171
  /**
172
172
  * @param {Object} arg - Arg object.
173
173
  * @param {string} [arg.id] -
@@ -184,8 +184,8 @@ declare class Cart {
184
184
  i?: boolean;
185
185
  b?: boolean;
186
186
  buyNow?: boolean;
187
- body: any;
188
- }): Promise<any>;
187
+ body: RewardPointRequest;
188
+ }): Promise<CartDetailResponse>;
189
189
  /**
190
190
  * @param {Object} arg - Arg object.
191
191
  * @param {string} [arg.cartId] -
@@ -205,7 +205,7 @@ declare class Cart {
205
205
  checkoutMode?: string;
206
206
  tags?: string;
207
207
  isDefault?: boolean;
208
- }): Promise<any>;
208
+ }): Promise<GetAddressesResponse>;
209
209
  /**
210
210
  * @param {Object} arg - Arg object.
211
211
  * @param {Address} arg.body
@@ -214,8 +214,8 @@ declare class Cart {
214
214
  * @description: Use this API to add an address to an account.
215
215
  */
216
216
  addAddress({ body }?: {
217
- body: any;
218
- }): Promise<any>;
217
+ body: Address;
218
+ }): Promise<SaveAddressResponse>;
219
219
  /**
220
220
  * @param {Object} arg - Arg object.
221
221
  * @param {string} arg.id -
@@ -237,7 +237,7 @@ declare class Cart {
237
237
  checkoutMode?: string;
238
238
  tags?: string;
239
239
  isDefault?: boolean;
240
- }): Promise<any>;
240
+ }): Promise<Address>;
241
241
  /**
242
242
  * @param {Object} arg - Arg object.
243
243
  * @param {string} arg.id - ID allotted to the selected address
@@ -248,8 +248,8 @@ declare class Cart {
248
248
  */
249
249
  updateAddress({ id, body }?: {
250
250
  id: string;
251
- body: any;
252
- }): Promise<any>;
251
+ body: Address;
252
+ }): Promise<UpdateAddressResponse>;
253
253
  /**
254
254
  * @param {Object} arg - Arg object.
255
255
  * @param {string} arg.id - ID allotted to the selected address
@@ -259,7 +259,7 @@ declare class Cart {
259
259
  */
260
260
  removeAddress({ id }?: {
261
261
  id: string;
262
- }): Promise<any>;
262
+ }): Promise<DeleteAddressResponse>;
263
263
  /**
264
264
  * @param {Object} arg - Arg object.
265
265
  * @param {string} [arg.cartId] -
@@ -276,8 +276,8 @@ declare class Cart {
276
276
  buyNow?: boolean;
277
277
  i?: boolean;
278
278
  b?: boolean;
279
- body: any;
280
- }): Promise<any>;
279
+ body: SelectCartAddressRequest;
280
+ }): Promise<CartDetailResponse>;
281
281
  /**
282
282
  * @param {Object} arg - Arg object.
283
283
  * @param {string} [arg.id] -
@@ -290,8 +290,8 @@ declare class Cart {
290
290
  selectPaymentMode({ body, id, buyNow }?: {
291
291
  id?: string;
292
292
  buyNow?: boolean;
293
- body: any;
294
- }): Promise<any>;
293
+ body: UpdateCartPaymentRequest;
294
+ }): Promise<CartDetailResponse>;
295
295
  /**
296
296
  * @param {Object} arg - Arg object.
297
297
  * @param {string} [arg.id] -
@@ -313,7 +313,7 @@ declare class Cart {
313
313
  paymentIdentifier?: string;
314
314
  aggregatorName?: string;
315
315
  merchantCode?: string;
316
- }): Promise<any>;
316
+ }): Promise<PaymentCouponValidate>;
317
317
  /**
318
318
  * @param {Object} arg - Arg object.
319
319
  * @param {boolean} [arg.p] - This is a boolean value. Select `true` for
@@ -333,7 +333,7 @@ declare class Cart {
333
333
  buyNow?: boolean;
334
334
  addressId?: string;
335
335
  areaCode?: string;
336
- }): Promise<any>;
336
+ }): Promise<CartShipmentsResponse>;
337
337
  /**
338
338
  * @param {Object} arg - Arg object.
339
339
  * @param {boolean} [arg.buyNow] - This indicates the type of cart to checkout
@@ -344,8 +344,8 @@ declare class Cart {
344
344
  */
345
345
  checkoutCart({ body, buyNow }?: {
346
346
  buyNow?: boolean;
347
- body: any;
348
- }): Promise<any>;
347
+ body: CartCheckoutDetailRequest;
348
+ }): Promise<CartCheckoutResponse>;
349
349
  /**
350
350
  * @param {Object} arg - Arg object.
351
351
  * @param {string} [arg.id] -
@@ -358,8 +358,8 @@ declare class Cart {
358
358
  updateCartMeta({ body, id, buyNow }?: {
359
359
  id?: string;
360
360
  buyNow?: boolean;
361
- body: any;
362
- }): Promise<any>;
361
+ body: CartMetaRequest;
362
+ }): Promise<CartMetaResponse>;
363
363
  /**
364
364
  * @param {Object} arg - Arg object.
365
365
  * @param {GetShareCartLinkRequest} arg.body
@@ -368,8 +368,8 @@ declare class Cart {
368
368
  * @description: Use this API to generate a shared cart snapshot and return a shortlink token. The link can be shared with other users for getting the same items in their cart.
369
369
  */
370
370
  getCartShareLink({ body }?: {
371
- body: any;
372
- }): Promise<any>;
371
+ body: GetShareCartLinkRequest;
372
+ }): Promise<GetShareCartLinkResponse>;
373
373
  /**
374
374
  * @param {Object} arg - Arg object.
375
375
  * @param {string} arg.token - Token of the shared short link
@@ -379,7 +379,7 @@ declare class Cart {
379
379
  */
380
380
  getCartSharedItems({ token }?: {
381
381
  token: string;
382
- }): Promise<any>;
382
+ }): Promise<SharedCartResponse>;
383
383
  /**
384
384
  * @param {Object} arg - Arg object.
385
385
  * @param {string} arg.token - Token of the shared short link
@@ -392,7 +392,7 @@ declare class Cart {
392
392
  updateCartWithSharedItems({ token, action }?: {
393
393
  token: string;
394
394
  action: string;
395
- }): Promise<any>;
395
+ }): Promise<SharedCartResponse>;
396
396
  /**
397
397
  * @param {Object} arg - Arg object.
398
398
  * @param {string} [arg.slug] - A short, human-readable, URL-friendly
@@ -408,7 +408,7 @@ declare class Cart {
408
408
  slug?: string;
409
409
  pageSize?: number;
410
410
  promotionGroup?: string;
411
- }): Promise<any>;
411
+ }): Promise<PromotionOffersResponse>;
412
412
  /**
413
413
  * @param {Object} arg - Arg object.
414
414
  * @param {string} arg.slug - A short, human-readable, URL-friendly
@@ -428,5 +428,5 @@ declare class Cart {
428
428
  storeId?: string;
429
429
  promotionId?: string;
430
430
  pageSize?: number;
431
- }): Promise<any>;
431
+ }): Promise<LadderPriceOffers>;
432
432
  }
@@ -23,8 +23,8 @@ declare class Catalog {
23
23
  getCollectionItemsBySlug: string;
24
24
  getCollectionDetailBySlug: string;
25
25
  getFollowedListing: string;
26
- unfollowById: string;
27
26
  followById: string;
27
+ unfollowById: string;
28
28
  getFollowerCountById: string;
29
29
  getFollowIds: string;
30
30
  getStores: string;
@@ -47,7 +47,7 @@ declare class Catalog {
47
47
  */
48
48
  getProductDetailBySlug({ slug }?: {
49
49
  slug: string;
50
- }): Promise<any>;
50
+ }): Promise<ProductDetail>;
51
51
  /**
52
52
  * @param {Object} arg - Arg object.
53
53
  * @param {string} arg.slug - A short, human-readable, URL-friendly
@@ -62,7 +62,7 @@ declare class Catalog {
62
62
  getProductSizesBySlug({ slug, storeId }?: {
63
63
  slug: string;
64
64
  storeId?: number;
65
- }): Promise<any>;
65
+ }): Promise<ProductSizes>;
66
66
  /**
67
67
  * @param {Object} arg - Arg object.
68
68
  * @param {string[]} arg.slug - A short, human-readable, URL-friendly
@@ -74,7 +74,7 @@ declare class Catalog {
74
74
  */
75
75
  getProductComparisonBySlugs({ slug }?: {
76
76
  slug: string[];
77
- }): Promise<any>;
77
+ }): Promise<ProductsComparisonResponse>;
78
78
  /**
79
79
  * @param {Object} arg - Arg object.
80
80
  * @param {string} arg.slug - A short, human-readable, URL-friendly
@@ -86,7 +86,7 @@ declare class Catalog {
86
86
  */
87
87
  getSimilarComparisonProductBySlug({ slug }?: {
88
88
  slug: string;
89
- }): Promise<any>;
89
+ }): Promise<ProductCompareResponse>;
90
90
  /**
91
91
  * @param {Object} arg - Arg object.
92
92
  * @param {string} arg.slug - A short, human-readable, URL-friendly
@@ -98,7 +98,7 @@ declare class Catalog {
98
98
  */
99
99
  getComparedFrequentlyProductBySlug({ slug }?: {
100
100
  slug: string;
101
- }): Promise<any>;
101
+ }): Promise<ProductFrequentlyComparedSimilarResponse>;
102
102
  /**
103
103
  * @param {Object} arg - Arg object.
104
104
  * @param {string} arg.slug - A short, human-readable, URL-friendly
@@ -110,7 +110,7 @@ declare class Catalog {
110
110
  */
111
111
  getProductVariantsBySlug({ slug }?: {
112
112
  slug: string;
113
- }): Promise<any>;
113
+ }): Promise<ProductVariantsResponse>;
114
114
  /**
115
115
  * @param {Object} arg - Arg object.
116
116
  * @param {string} [arg.itemId] - The Item ID of the product (Max. 50 allowed)
@@ -132,7 +132,7 @@ declare class Catalog {
132
132
  skuCode?: string;
133
133
  ean?: string;
134
134
  upc?: string;
135
- }): Promise<any>;
135
+ }): Promise<ProductStockStatusResponse>;
136
136
  /**
137
137
  * @param {Object} arg - Arg object.
138
138
  * @param {string} arg.timestamp - Timestamp in UTC format (2020-07-23T10:27:50Z)
@@ -146,7 +146,7 @@ declare class Catalog {
146
146
  timestamp: string;
147
147
  pageSize?: number;
148
148
  pageId?: string;
149
- }): Promise<any>;
149
+ }): Promise<ProductStockPolling>;
150
150
  /**
151
151
  * @param {Object} arg - Arg object.
152
152
  * @param {string} arg.timestamp - Timestamp in UTC format (2020-07-23T10:27:50Z)
@@ -189,7 +189,7 @@ declare class Catalog {
189
189
  pageSize?: number;
190
190
  pageNo?: number;
191
191
  pageType?: string;
192
- }): Promise<any>;
192
+ }): Promise<ProductListingResponse>;
193
193
  /**
194
194
  * @param {Object} arg - Arg object.
195
195
  * @param {string} [arg.q] - The search query for entering partial or full
@@ -231,7 +231,7 @@ declare class Catalog {
231
231
  department?: string;
232
232
  pageNo?: number;
233
233
  pageSize?: number;
234
- }): Promise<any>;
234
+ }): Promise<BrandListingResponse>;
235
235
  /**
236
236
  * @param {Object} arg - Arg object.
237
237
  * @param {string} [arg.department] - The name of the department. Use this
@@ -257,7 +257,7 @@ declare class Catalog {
257
257
  */
258
258
  getBrandDetailBySlug({ slug }?: {
259
259
  slug: string;
260
- }): Promise<any>;
260
+ }): Promise<BrandDetailResponse>;
261
261
  /**
262
262
  * @param {Object} arg - Arg object.
263
263
  * @param {string} [arg.department] - The name of the department. Use this
@@ -270,7 +270,7 @@ declare class Catalog {
270
270
  */
271
271
  getCategories({ department }?: {
272
272
  department?: string;
273
- }): Promise<any>;
273
+ }): Promise<CategoryListingResponse>;
274
274
  /**
275
275
  * @param {Object} arg - Arg object.
276
276
  * @param {string} arg.slug - A short, human-readable, URL-friendly
@@ -282,7 +282,7 @@ declare class Catalog {
282
282
  */
283
283
  getCategoryDetailBySlug({ slug }?: {
284
284
  slug: string;
285
- }): Promise<any>;
285
+ }): Promise<CategoryMetaResponse>;
286
286
  /**
287
287
  * @param {Object} arg - Arg object.
288
288
  * @param {string} [arg.sortOn] - The order in which the list of products
@@ -298,7 +298,7 @@ declare class Catalog {
298
298
  sortOn?: string;
299
299
  pageId?: string;
300
300
  pageSize?: number;
301
- }): Promise<any>;
301
+ }): Promise<HomeListingResponse>;
302
302
  /**
303
303
  * @param {Object} arg - Arg object.
304
304
  * @param {string} [arg.sortOn] - The order in which the list of products
@@ -318,20 +318,20 @@ declare class Catalog {
318
318
  * @summary: List all the departments
319
319
  * @description: Departments are a way to categorise similar products. A product can lie in multiple departments. For example, a skirt can below to the 'Women's Fashion' Department while a handbag can lie in 'Women's Accessories' Department. Use this API to list all the departments. If successful, returns the list of departments specified in `DepartmentResponse`
320
320
  */
321
- getDepartments({}?: any): Promise<any>;
321
+ getDepartments({}?: any): Promise<DepartmentResponse>;
322
322
  /**
323
323
  * @param {Object} arg - Arg object.
324
324
  * @param {string} arg.q - The search query for entering partial or full
325
325
  * name of a product, brand or category. For example, if the given search
326
- * query `q` is *ski*, the relevant search suggestions could be *skirt*,
327
- * *ski shoes*, _*skin cream* etc.
326
+ * query `q` is _ski_, the relevant search suggestions could be _skirt_,
327
+ * _ski shoes_, __skin cream_ etc.
328
328
  * @returns {Promise<AutoCompleteResponse>} - Success response
329
329
  * @summary: Get relevant suggestions for a search query
330
330
  * @description: Retrieves a list of suggestions for a given search query. Each suggestion is a valid search term that's generated on the basis of query. This is particularly useful to enhance the user experience while using the search tool.
331
331
  */
332
332
  getSearchResults({ q }?: {
333
333
  q: string;
334
- }): Promise<any>;
334
+ }): Promise<AutoCompleteResponse>;
335
335
  /**
336
336
  * @param {Object} arg - Arg object.
337
337
  * @param {number} [arg.pageNo] - The page number to navigate through the
@@ -346,7 +346,7 @@ declare class Catalog {
346
346
  pageNo?: number;
347
347
  pageSize?: number;
348
348
  tag?: string[];
349
- }): Promise<any>;
349
+ }): Promise<GetCollectionListingResponse>;
350
350
  /**
351
351
  * @param {Object} arg - Arg object.
352
352
  * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
@@ -385,7 +385,7 @@ declare class Catalog {
385
385
  sortOn?: string;
386
386
  pageId?: string;
387
387
  pageSize?: number;
388
- }): Promise<any>;
388
+ }): Promise<ProductListingResponse>;
389
389
  /**
390
390
  * @param {Object} arg - Arg object.
391
391
  * @param {string} arg.slug - A short, human-readable, URL-friendly
@@ -422,7 +422,7 @@ declare class Catalog {
422
422
  */
423
423
  getCollectionDetailBySlug({ slug }?: {
424
424
  slug: string;
425
- }): Promise<any>;
425
+ }): Promise<CollectionDetailResponse>;
426
426
  /**
427
427
  * @param {Object} arg - Arg object.
428
428
  * @param {string} arg.collectionType - Type of collection followed, i.e.
@@ -437,7 +437,7 @@ declare class Catalog {
437
437
  collectionType: string;
438
438
  pageId?: string;
439
439
  pageSize?: number;
440
- }): Promise<any>;
440
+ }): Promise<GetFollowListingResponse>;
441
441
  /**
442
442
  * @param {Object} arg - Arg object.
443
443
  * @param {string} arg.collectionType - Type of collection followed, i.e.
@@ -456,26 +456,26 @@ declare class Catalog {
456
456
  * products, brands, or collections.
457
457
  * @param {string} arg.collectionId - The ID of the collection type.
458
458
  * @returns {Promise<FollowPostResponse>} - Success response
459
- * @summary: Unfollow an entity (product/brand/collection)
460
- * @description: You can undo a followed product, brand or collection by its ID. This action is referred as _unfollow_.
459
+ * @summary: Follow an entity (product/brand/collection)
460
+ * @description: Follow a particular entity such as product, brand, collection specified by its ID.
461
461
  */
462
- unfollowById({ collectionType, collectionId }?: {
462
+ followById({ collectionType, collectionId }?: {
463
463
  collectionType: string;
464
464
  collectionId: string;
465
- }): Promise<any>;
465
+ }): Promise<FollowPostResponse>;
466
466
  /**
467
467
  * @param {Object} arg - Arg object.
468
468
  * @param {string} arg.collectionType - Type of collection followed, i.e.
469
469
  * products, brands, or collections.
470
470
  * @param {string} arg.collectionId - The ID of the collection type.
471
471
  * @returns {Promise<FollowPostResponse>} - Success response
472
- * @summary: Follow an entity (product/brand/collection)
473
- * @description: Follow a particular entity such as product, brand, collection specified by its ID.
472
+ * @summary: Unfollow an entity (product/brand/collection)
473
+ * @description: You can undo a followed product, brand or collection by its ID. This action is referred as _unfollow_.
474
474
  */
475
- followById({ collectionType, collectionId }?: {
475
+ unfollowById({ collectionType, collectionId }?: {
476
476
  collectionType: string;
477
477
  collectionId: string;
478
- }): Promise<any>;
478
+ }): Promise<FollowPostResponse>;
479
479
  /**
480
480
  * @param {Object} arg - Arg object.
481
481
  * @param {string} arg.collectionType - Type of collection, i.e. products,
@@ -488,7 +488,7 @@ declare class Catalog {
488
488
  getFollowerCountById({ collectionType, collectionId }?: {
489
489
  collectionType: string;
490
490
  collectionId: string;
491
- }): Promise<any>;
491
+ }): Promise<FollowerCountResponse>;
492
492
  /**
493
493
  * @param {Object} arg - Arg object.
494
494
  * @param {string} [arg.collectionType] - Type of collection, i.e. products,
@@ -499,7 +499,7 @@ declare class Catalog {
499
499
  */
500
500
  getFollowIds({ collectionType }?: {
501
501
  collectionType?: string;
502
- }): Promise<any>;
502
+ }): Promise<FollowIdsResponse>;
503
503
  /**
504
504
  * @param {Object} arg - Arg object.
505
505
  * @param {number} [arg.pageNo] - The page number to navigate through the
@@ -525,7 +525,7 @@ declare class Catalog {
525
525
  range?: number;
526
526
  latitude?: number;
527
527
  longitude?: number;
528
- }): Promise<any>;
528
+ }): Promise<StoreListingResponse>;
529
529
  /**
530
530
  * @param {Object} arg - Arg object.
531
531
  * @param {number} [arg.pageSize] - Number of items to retrieve in each page.
@@ -573,7 +573,7 @@ declare class Catalog {
573
573
  range?: number;
574
574
  latitude?: number;
575
575
  longitude?: number;
576
- }): Promise<any>;
576
+ }): Promise<ApplicationStoreListing>;
577
577
  /**
578
578
  * @param {Object} arg - Arg object.
579
579
  * @param {number} [arg.pageSize] - Number of items to retrieve in each page.
@@ -605,7 +605,7 @@ declare class Catalog {
605
605
  */
606
606
  getLocationDetailsById({ locationId }?: {
607
607
  locationId: number;
608
- }): Promise<any>;
608
+ }): Promise<StoreDetails>;
609
609
  /**
610
610
  * @param {Object} arg - Arg object.
611
611
  * @param {string} [arg.slug] - Product slug for which bundles need to be fetched.
@@ -617,7 +617,7 @@ declare class Catalog {
617
617
  getProductBundlesBySlug({ slug, id }?: {
618
618
  slug?: string;
619
619
  id?: string;
620
- }): Promise<any>;
620
+ }): Promise<ProductBundle>;
621
621
  /**
622
622
  * @param {Object} arg - Arg object.
623
623
  * @param {string} arg.slug - A short, human-readable, URL-friendly
@@ -639,7 +639,7 @@ declare class Catalog {
639
639
  size: string;
640
640
  storeId?: number;
641
641
  pincode?: string;
642
- }): Promise<any>;
642
+ }): Promise<ProductSizePriceResponseV2>;
643
643
  /**
644
644
  * @param {Object} arg - Arg object.
645
645
  * @param {string} arg.slug - A short, human-readable, URL-friendly
@@ -666,7 +666,7 @@ declare class Catalog {
666
666
  strategy?: string;
667
667
  pageNo?: number;
668
668
  pageSize?: number;
669
- }): Promise<any>;
669
+ }): Promise<ProductSizeSellersResponseV2>;
670
670
  /**
671
671
  * @param {Object} arg - Arg object.
672
672
  * @param {string} arg.slug - A short, human-readable, URL-friendly
@@ -40,10 +40,10 @@ class Catalog {
40
40
  "/service/application/catalog/v1.0/collections/{slug}/",
41
41
  getFollowedListing:
42
42
  "/service/application/catalog/v1.0/follow/{collection_type}/",
43
- unfollowById:
44
- "/service/application/catalog/v1.0/follow/{collection_type}/{collection_id}/",
45
43
  followById:
46
44
  "/service/application/catalog/v1.0/follow/{collection_type}/{collection_id}/",
45
+ unfollowById:
46
+ "/service/application/catalog/v1.0/follow/{collection_type}/{collection_id}/",
47
47
  getFollowerCountById:
48
48
  "/service/application/catalog/v1.0/follow/{collection_type}/{collection_id}/count/",
49
49
  getFollowIds: "/service/application/catalog/v1.0/follow/ids/",
@@ -784,8 +784,8 @@ class Catalog {
784
784
  * @param {Object} arg - Arg object.
785
785
  * @param {string} arg.q - The search query for entering partial or full
786
786
  * name of a product, brand or category. For example, if the given search
787
- * query `q` is *ski*, the relevant search suggestions could be *skirt*,
788
- * *ski shoes*, _*skin cream* etc.
787
+ * query `q` is _ski_, the relevant search suggestions could be _skirt_,
788
+ * _ski shoes_, __skin cream_ etc.
789
789
  * @returns {Promise<AutoCompleteResponse>} - Success response
790
790
  * @summary: Get relevant suggestions for a search query
791
791
  * @description: Retrieves a list of suggestions for a given search query. Each suggestion is a valid search term that's generated on the basis of query. This is particularly useful to enhance the user experience while using the search tool.
@@ -1093,11 +1093,11 @@ class Catalog {
1093
1093
  * products, brands, or collections.
1094
1094
  * @param {string} arg.collectionId - The ID of the collection type.
1095
1095
  * @returns {Promise<FollowPostResponse>} - Success response
1096
- * @summary: Unfollow an entity (product/brand/collection)
1097
- * @description: You can undo a followed product, brand or collection by its ID. This action is referred as _unfollow_.
1096
+ * @summary: Follow an entity (product/brand/collection)
1097
+ * @description: Follow a particular entity such as product, brand, collection specified by its ID.
1098
1098
  */
1099
- unfollowById({ collectionType, collectionId } = {}) {
1100
- const { error } = CatalogValidator.unfollowById().validate(
1099
+ followById({ collectionType, collectionId } = {}) {
1100
+ const { error } = CatalogValidator.followById().validate(
1101
1101
  { collectionType, collectionId },
1102
1102
  { abortEarly: false, allowUnknown: true }
1103
1103
  );
@@ -1110,9 +1110,9 @@ class Catalog {
1110
1110
 
1111
1111
  return APIClient.execute(
1112
1112
  this._conf,
1113
- "delete",
1113
+ "post",
1114
1114
  constructUrl({
1115
- url: this._urls["unfollowById"],
1115
+ url: this._urls["followById"],
1116
1116
  params: { collectionType, collectionId },
1117
1117
  }),
1118
1118
  query_params,
@@ -1127,11 +1127,11 @@ class Catalog {
1127
1127
  * products, brands, or collections.
1128
1128
  * @param {string} arg.collectionId - The ID of the collection type.
1129
1129
  * @returns {Promise<FollowPostResponse>} - Success response
1130
- * @summary: Follow an entity (product/brand/collection)
1131
- * @description: Follow a particular entity such as product, brand, collection specified by its ID.
1130
+ * @summary: Unfollow an entity (product/brand/collection)
1131
+ * @description: You can undo a followed product, brand or collection by its ID. This action is referred as _unfollow_.
1132
1132
  */
1133
- followById({ collectionType, collectionId } = {}) {
1134
- const { error } = CatalogValidator.followById().validate(
1133
+ unfollowById({ collectionType, collectionId } = {}) {
1134
+ const { error } = CatalogValidator.unfollowById().validate(
1135
1135
  { collectionType, collectionId },
1136
1136
  { abortEarly: false, allowUnknown: true }
1137
1137
  );
@@ -1144,9 +1144,9 @@ class Catalog {
1144
1144
 
1145
1145
  return APIClient.execute(
1146
1146
  this._conf,
1147
- "post",
1147
+ "delete",
1148
1148
  constructUrl({
1149
- url: this._urls["followById"],
1149
+ url: this._urls["unfollowById"],
1150
1150
  params: { collectionType, collectionId },
1151
1151
  }),
1152
1152
  query_params,
@@ -19,7 +19,7 @@ declare class Common {
19
19
  searchApplication({ authorization, query }?: {
20
20
  authorization?: string;
21
21
  query?: string;
22
- }): Promise<any>;
22
+ }): Promise<ApplicationResponse>;
23
23
  /**
24
24
  * @param {Object} arg - Arg object.
25
25
  * @param {string} [arg.locationType] - Provide location type to query on.
@@ -34,5 +34,5 @@ declare class Common {
34
34
  getLocations({ locationType, id }?: {
35
35
  locationType?: string;
36
36
  id?: string;
37
- }): Promise<any>;
37
+ }): Promise<Locations>;
38
38
  }
@@ -15,7 +15,7 @@ declare class Communication {
15
15
  * @summary: Get communication consent
16
16
  * @description: Use this API to retrieve the consent provided by the user for receiving communication messages over Email/SMS/WhatsApp.
17
17
  */
18
- getCommunicationConsent({}?: any): Promise<any>;
18
+ getCommunicationConsent({}?: any): Promise<CommunicationConsent>;
19
19
  /**
20
20
  * @param {Object} arg - Arg object.
21
21
  * @param {CommunicationConsentReq} arg.body
@@ -24,8 +24,8 @@ declare class Communication {
24
24
  * @description: Use this API to update and insert the consent provided by the user for receiving communication messages over Email/SMS/WhatsApp.
25
25
  */
26
26
  upsertCommunicationConsent({ body }?: {
27
- body: any;
28
- }): Promise<any>;
27
+ body: CommunicationConsentReq;
28
+ }): Promise<CommunicationConsentRes>;
29
29
  /**
30
30
  * @param {Object} arg - Arg object.
31
31
  * @param {PushtokenReq} arg.body
@@ -34,6 +34,6 @@ declare class Communication {
34
34
  * @description: Use this API to update and insert the push token of the user.
35
35
  */
36
36
  upsertAppPushtoken({ body }?: {
37
- body: any;
38
- }): Promise<any>;
37
+ body: PushtokenReq;
38
+ }): Promise<PushtokenRes>;
39
39
  }