@gofynd/fdk-client-javascript 1.2.0 → 1.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (262) hide show
  1. package/README.md +44 -7
  2. package/package.json +1 -2
  3. package/sdk/application/ApplicationAPIClient.d.ts +3 -3
  4. package/sdk/application/ApplicationAPIClient.js +6 -4
  5. package/sdk/application/ApplicationClient.d.ts +2 -3
  6. package/sdk/application/ApplicationClient.js +1 -45
  7. package/sdk/application/ApplicationConfig.d.ts +46 -6
  8. package/sdk/application/ApplicationConfig.js +15 -16
  9. package/sdk/application/Cart/CartApplicationClient.d.ts +61 -33
  10. package/sdk/application/Cart/CartApplicationClient.js +225 -134
  11. package/sdk/application/Cart/CartApplicationModel.d.ts +4 -4
  12. package/sdk/application/Cart/CartApplicationModel.js +4 -4
  13. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +61 -30
  14. package/sdk/application/Catalog/CatalogApplicationClient.js +234 -146
  15. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +115 -13
  16. package/sdk/application/Catalog/CatalogApplicationModel.js +77 -12
  17. package/sdk/application/Common/CommonApplicationClient.d.ts +5 -3
  18. package/sdk/application/Common/CommonApplicationClient.js +13 -11
  19. package/sdk/application/Common/CommonApplicationModel.d.ts +3 -83
  20. package/sdk/application/Common/CommonApplicationModel.js +2 -58
  21. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +9 -3
  22. package/sdk/application/Communication/CommunicationApplicationClient.js +25 -13
  23. package/sdk/application/Communication/CommunicationApplicationModel.d.ts +1 -34
  24. package/sdk/application/Communication/CommunicationApplicationModel.js +0 -36
  25. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +46 -16
  26. package/sdk/application/Configuration/ConfigurationApplicationClient.js +144 -68
  27. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +1 -219
  28. package/sdk/application/Configuration/ConfigurationApplicationModel.js +0 -226
  29. package/sdk/application/Content/ContentApplicationClient.d.ts +49 -21
  30. package/sdk/application/Content/ContentApplicationClient.js +159 -80
  31. package/sdk/application/Content/ContentApplicationModel.d.ts +5 -622
  32. package/sdk/application/Content/ContentApplicationModel.js +11 -763
  33. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -3
  34. package/sdk/application/FileStorage/FileStorageApplicationClient.js +20 -14
  35. package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +1 -152
  36. package/sdk/application/FileStorage/FileStorageApplicationModel.js +0 -180
  37. package/sdk/application/Lead/LeadApplicationClient.d.ts +14 -7
  38. package/sdk/application/Lead/LeadApplicationClient.js +50 -31
  39. package/sdk/application/Lead/LeadApplicationModel.d.ts +22 -741
  40. package/sdk/application/Lead/LeadApplicationModel.js +21 -481
  41. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +11 -5
  42. package/sdk/application/Logistic/LogisticApplicationClient.js +41 -20
  43. package/sdk/application/Order/OrderApplicationClient.d.ts +24 -12
  44. package/sdk/application/Order/OrderApplicationClient.js +88 -56
  45. package/sdk/application/Payment/PaymentApplicationClient.d.ts +91 -42
  46. package/sdk/application/Payment/PaymentApplicationClient.js +293 -194
  47. package/sdk/application/Payment/PaymentApplicationModel.d.ts +36 -36
  48. package/sdk/application/Payment/PaymentApplicationModel.js +36 -36
  49. package/sdk/application/PosCart/PosCartApplicationClient.d.ts +59 -32
  50. package/sdk/application/PosCart/PosCartApplicationClient.js +214 -130
  51. package/sdk/application/PosCart/PosCartApplicationModel.d.ts +2 -2
  52. package/sdk/application/PosCart/PosCartApplicationModel.js +2 -2
  53. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +16 -7
  54. package/sdk/application/Rewards/RewardsApplicationClient.js +56 -29
  55. package/sdk/application/Share/ShareApplicationClient.d.ts +15 -7
  56. package/sdk/application/Share/ShareApplicationClient.js +51 -31
  57. package/sdk/application/Share/ShareApplicationModel.d.ts +1 -33
  58. package/sdk/application/Share/ShareApplicationModel.js +0 -38
  59. package/sdk/application/Theme/ThemeApplicationClient.d.ts +9 -4
  60. package/sdk/application/Theme/ThemeApplicationClient.js +35 -18
  61. package/sdk/application/Theme/ThemeApplicationModel.d.ts +982 -312
  62. package/sdk/application/Theme/ThemeApplicationModel.js +621 -284
  63. package/sdk/application/User/UserApplicationClient.d.ts +74 -35
  64. package/sdk/application/User/UserApplicationClient.js +252 -161
  65. package/sdk/application/User/UserApplicationModel.d.ts +3 -401
  66. package/sdk/application/User/UserApplicationModel.js +2 -490
  67. package/sdk/common/AxiosHelper.js +1 -2
  68. package/sdk/common/FDKError.d.ts +3 -0
  69. package/sdk/common/FDKError.js +8 -0
  70. package/sdk/common/utils.d.ts +3 -0
  71. package/sdk/common/utils.js +29 -0
  72. package/sdk/partner/PartnerAPIClient.d.ts +5 -4
  73. package/sdk/partner/PartnerAPIClient.js +7 -4
  74. package/sdk/partner/PartnerClient.d.ts +2 -0
  75. package/sdk/partner/PartnerClient.js +3 -0
  76. package/sdk/partner/Theme/ThemePartnerClient.d.ts +299 -0
  77. package/sdk/partner/Theme/ThemePartnerClient.js +768 -0
  78. package/sdk/partner/Theme/ThemePartnerModel.d.ts +1706 -0
  79. package/sdk/partner/Theme/ThemePartnerModel.js +1409 -0
  80. package/sdk/partner/Theme/ThemePartnerValidator.d.ts +22 -0
  81. package/sdk/partner/Theme/ThemePartnerValidator.js +157 -0
  82. package/sdk/partner/index.d.ts +3 -1
  83. package/sdk/partner/index.js +3 -1
  84. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +8 -4
  85. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +38 -16
  86. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +1 -13
  87. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +0 -12
  88. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +10 -0
  89. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +4 -0
  90. package/sdk/platform/Billing/BillingPlatformClient.d.ts +59 -14
  91. package/sdk/platform/Billing/BillingPlatformClient.js +315 -64
  92. package/sdk/platform/Billing/BillingPlatformModel.d.ts +56 -196
  93. package/sdk/platform/Billing/BillingPlatformModel.js +63 -217
  94. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +23 -1
  95. package/sdk/platform/Billing/BillingPlatformValidator.js +31 -0
  96. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +124 -63
  97. package/sdk/platform/Cart/CartPlatformApplicationClient.js +431 -265
  98. package/sdk/platform/Cart/CartPlatformModel.d.ts +253 -53
  99. package/sdk/platform/Cart/CartPlatformModel.js +104 -54
  100. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +120 -53
  101. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +398 -247
  102. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +155 -78
  103. package/sdk/platform/Catalog/CatalogPlatformClient.js +561 -355
  104. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +10 -12
  105. package/sdk/platform/Catalog/CatalogPlatformModel.js +10 -12
  106. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +30 -0
  107. package/sdk/platform/Catalog/CatalogPlatformValidator.js +13 -0
  108. package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -3
  109. package/sdk/platform/Common/CommonPlatformClient.js +13 -11
  110. package/sdk/platform/Common/CommonPlatformModel.d.ts +39 -64
  111. package/sdk/platform/Common/CommonPlatformModel.js +23 -57
  112. package/sdk/platform/Common/CommonPlatformValidator.d.ts +5 -10
  113. package/sdk/platform/Common/CommonPlatformValidator.js +3 -4
  114. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +370 -120
  115. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +2328 -888
  116. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +143 -24
  117. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +179 -15
  118. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +2 -1
  119. package/sdk/platform/Communication/CommunicationPlatformClient.js +6 -5
  120. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +386 -308
  121. package/sdk/platform/Communication/CommunicationPlatformModel.js +415 -355
  122. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +38 -13
  123. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +171 -57
  124. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +53 -1
  125. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +54 -0
  126. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +5 -1
  127. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +7 -0
  128. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +96 -29
  129. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +311 -126
  130. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +5 -1
  131. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +7 -0
  132. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +36 -18
  133. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +121 -86
  134. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +13 -180
  135. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +5 -113
  136. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +162 -70
  137. package/sdk/platform/Content/ContentPlatformApplicationClient.js +528 -309
  138. package/sdk/platform/Content/ContentPlatformModel.d.ts +9 -198
  139. package/sdk/platform/Content/ContentPlatformModel.js +8 -231
  140. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +48 -11
  141. package/sdk/platform/Discount/DiscountPlatformClient.js +142 -48
  142. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +40 -1
  143. package/sdk/platform/Discount/DiscountPlatformModel.js +27 -0
  144. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +84 -18
  145. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +486 -53
  146. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +71 -7
  147. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +81 -5
  148. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +13 -18
  149. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +58 -65
  150. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +198 -71
  151. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +212 -64
  152. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +18 -10
  153. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +11 -6
  154. package/sdk/platform/Finance/FinancePlatformClient.d.ts +177 -40
  155. package/sdk/platform/Finance/FinancePlatformClient.js +1028 -132
  156. package/sdk/platform/Finance/FinancePlatformModel.d.ts +670 -22
  157. package/sdk/platform/Finance/FinancePlatformModel.js +809 -23
  158. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +111 -1
  159. package/sdk/platform/Finance/FinancePlatformValidator.js +134 -0
  160. package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +24 -12
  161. package/sdk/platform/Inventory/InventoryPlatformClient.js +94 -52
  162. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +27 -13
  163. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +101 -55
  164. package/sdk/platform/Lead/LeadPlatformClient.d.ts +50 -39
  165. package/sdk/platform/Lead/LeadPlatformClient.js +171 -112
  166. package/sdk/platform/Lead/LeadPlatformModel.d.ts +32 -390
  167. package/sdk/platform/Lead/LeadPlatformModel.js +31 -214
  168. package/sdk/platform/Lead/LeadPlatformValidator.d.ts +33 -33
  169. package/sdk/platform/Lead/LeadPlatformValidator.js +23 -23
  170. package/sdk/platform/OAuthClient.js +6 -2
  171. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +4 -2
  172. package/sdk/platform/Order/OrderPlatformApplicationClient.js +12 -10
  173. package/sdk/platform/Order/OrderPlatformClient.d.ts +165 -71
  174. package/sdk/platform/Order/OrderPlatformClient.js +738 -205
  175. package/sdk/platform/Order/OrderPlatformModel.d.ts +261 -3
  176. package/sdk/platform/Order/OrderPlatformModel.js +225 -2
  177. package/sdk/platform/Order/OrderPlatformValidator.d.ts +104 -3
  178. package/sdk/platform/Order/OrderPlatformValidator.js +85 -2
  179. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -22
  180. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +12 -159
  181. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +1 -30
  182. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +0 -26
  183. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +1 -690
  184. package/sdk/platform/Partner/PartnerPlatformModel.js +0 -809
  185. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +167 -32
  186. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +793 -145
  187. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +91 -1
  188. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +91 -0
  189. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -10
  190. package/sdk/platform/Payment/PaymentPlatformClient.js +68 -47
  191. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +549 -7
  192. package/sdk/platform/Payment/PaymentPlatformModel.js +305 -6
  193. package/sdk/platform/PlatformAPIClient.d.ts +3 -3
  194. package/sdk/platform/PlatformAPIClient.js +2 -2
  195. package/sdk/platform/PlatformClient.d.ts +2 -2
  196. package/sdk/platform/PlatformClient.js +4 -4
  197. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +28 -12
  198. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +90 -53
  199. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +1 -12
  200. package/sdk/platform/Rewards/RewardsPlatformModel.js +0 -14
  201. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +62 -26
  202. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +210 -93
  203. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +20 -11
  204. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +23 -11
  205. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +36 -18
  206. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +142 -78
  207. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +12 -3
  208. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +14 -2
  209. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +10 -26
  210. package/sdk/platform/Share/SharePlatformApplicationClient.js +36 -67
  211. package/sdk/platform/Share/SharePlatformModel.d.ts +4 -4
  212. package/sdk/platform/Share/SharePlatformModel.js +4 -4
  213. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +127 -57
  214. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +564 -189
  215. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +63 -26
  216. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +62 -22
  217. package/sdk/platform/Theme/ThemePlatformClient.d.ts +37 -0
  218. package/sdk/platform/Theme/ThemePlatformClient.js +235 -0
  219. package/sdk/platform/Theme/ThemePlatformModel.d.ts +1167 -261
  220. package/sdk/platform/Theme/ThemePlatformModel.js +801 -244
  221. package/sdk/platform/Theme/ThemePlatformValidator.d.ts +32 -0
  222. package/sdk/platform/Theme/ThemePlatformValidator.js +38 -0
  223. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +35 -17
  224. package/sdk/platform/User/UserPlatformApplicationClient.js +132 -73
  225. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +7 -0
  226. package/sdk/platform/User/UserPlatformApplicationValidator.js +3 -0
  227. package/sdk/platform/User/UserPlatformModel.d.ts +1 -738
  228. package/sdk/platform/User/UserPlatformModel.js +3 -899
  229. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +120 -7
  230. package/sdk/platform/Webhook/WebhookPlatformClient.js +799 -41
  231. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +476 -86
  232. package/sdk/platform/Webhook/WebhookPlatformModel.js +388 -89
  233. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +96 -9
  234. package/sdk/platform/Webhook/WebhookPlatformValidator.js +117 -5
  235. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +5 -3
  236. package/sdk/public/Configuration/ConfigurationPublicClient.js +13 -11
  237. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +3 -106
  238. package/sdk/public/Configuration/ConfigurationPublicModel.js +2 -59
  239. package/sdk/public/Inventory/InventoryPublicClient.d.ts +12 -6
  240. package/sdk/public/Inventory/InventoryPublicClient.js +42 -27
  241. package/sdk/public/Partner/PartnerPublicClient.d.ts +22 -0
  242. package/sdk/public/Partner/PartnerPublicClient.js +110 -0
  243. package/sdk/public/Partner/PartnerPublicModel.d.ts +240 -0
  244. package/sdk/public/Partner/PartnerPublicModel.js +280 -0
  245. package/sdk/public/Partner/PartnerPublicValidator.d.ts +18 -0
  246. package/sdk/public/Partner/PartnerPublicValidator.js +19 -0
  247. package/sdk/public/PublicAPIClient.d.ts +14 -1
  248. package/sdk/public/PublicAPIClient.js +7 -1
  249. package/sdk/public/PublicClient.d.ts +2 -0
  250. package/sdk/public/PublicClient.js +4 -0
  251. package/sdk/public/Webhook/WebhookPublicClient.d.ts +5 -2
  252. package/sdk/public/Webhook/WebhookPublicClient.js +15 -9
  253. package/sdk/public/Webhook/WebhookPublicModel.d.ts +1 -191
  254. package/sdk/public/Webhook/WebhookPublicModel.js +0 -229
  255. package/sdk/public/index.d.ts +1 -0
  256. package/sdk/public/index.js +2 -0
  257. package/sdk/application/ApplicationModels.d.ts +0 -48
  258. package/sdk/application/ApplicationModels.js +0 -38
  259. package/sdk/platform/Partner/PartnerPlatformClient.d.ts +0 -106
  260. package/sdk/platform/Partner/PartnerPlatformClient.js +0 -878
  261. package/sdk/platform/Partner/PartnerPlatformValidator.d.ts +0 -208
  262. package/sdk/platform/Partner/PartnerPlatformValidator.js +0 -169
@@ -6,6 +6,29 @@ const Joi = require("joi");
6
6
  * @property {string} order_id
7
7
  */
8
8
 
9
+ /**
10
+ * @typedef AddressDetail
11
+ * @property {string} address - Address details
12
+ * @property {string} address_type - Address type e.g. home, office
13
+ * @property {string} area - Area details
14
+ * @property {string} area_code - Customer pin/zip code
15
+ * @property {string} area_code_slug - Area slug code, use pin/zip code if not available
16
+ * @property {string} city - City name
17
+ * @property {string} country - Country name
18
+ * @property {string} country_iso_code - Country's code name e.g. `IN`, `GB`
19
+ * @property {string} country_phone_code - Country's phone code
20
+ * @property {string} [email] - Customer email
21
+ * @property {string} [expire_at] - Address expiry timestamp
22
+ * @property {string} g_address_id - Unique address id generated by Fynd platform
23
+ * @property {Object} [geo_location] - Location latitude and logitude
24
+ * @property {Object} [google_map_point] - Google map point of location
25
+ * @property {string} [landmark] - Landmark
26
+ * @property {string} name - Customer name
27
+ * @property {string} phone - Phone number
28
+ * @property {string} state - State of the customer
29
+ * @property {Object[]} [tags] - Optional address tag
30
+ */
31
+
9
32
  /**
10
33
  * @typedef BankDetailsForOTP
11
34
  * @property {string} account_holder
@@ -192,7 +215,7 @@ const Joi = require("joi");
192
215
 
193
216
  /**
194
217
  * @typedef ErrorResponse
195
- * @property {ErrorDescription} [error]
218
+ * @property {Object} [error]
196
219
  * @property {string} message - Message
197
220
  * @property {number} status_code - HTTP status code
198
221
  * @property {boolean} success - Successful or failure
@@ -251,7 +274,7 @@ const Joi = require("joi");
251
274
  * @typedef IntentApp
252
275
  * @property {string} [code] - Code
253
276
  * @property {string} [display_name] - Display_name
254
- * @property {PaymentModeLogo} [logos] - Logos
277
+ * @property {Object} [logos] - Logos
255
278
  * @property {string} [package_name] - Package_name
256
279
  */
257
280
 
@@ -282,6 +305,19 @@ const Joi = require("joi");
282
305
  * @property {boolean} success - Success/Failure of the transaction
283
306
  */
284
307
 
308
+ /**
309
+ * @typedef MerchnatPaymentModeRequest
310
+ * @property {Object} [offline] - Details to be updated for online payment configuration.
311
+ * @property {Object} [online] - Details to be updated for offline payment configuration.
312
+ */
313
+
314
+ /**
315
+ * @typedef MerchnatPaymentModeResponse
316
+ * @property {Object[]} [items] - List of all aggregator and payment mode details.
317
+ * @property {string} [message] - Message
318
+ * @property {boolean} success - Response is successful or not.
319
+ */
320
+
285
321
  /**
286
322
  * @typedef MultiTenderPaymentMeta
287
323
  * @property {string} [current_status]
@@ -335,6 +371,19 @@ const Joi = require("joi");
335
371
  * @property {boolean} [show_beneficiary_details] - Show beneficiary details or not.
336
372
  */
337
373
 
374
+ /**
375
+ * @typedef OrderDetail
376
+ * @property {string} aggregator - Name of the payment gateway aggregator.
377
+ * @property {Object} aggregator_order_details - Aggregator order details
378
+ * generated by the payment gateway.
379
+ * @property {number} amount - Amount paid.
380
+ * @property {string} currency - Currency of the payment.
381
+ * @property {string} gid - Global identifier of the entity (e.g. order, cart
382
+ * etc.) against which payment_session was initiated. This is generated by
383
+ * Fynd payments platform and is unique.
384
+ * @property {string} status - Order status created by payment gateway aggregator.
385
+ */
386
+
338
387
  /**
339
388
  * @typedef Page
340
389
  * @property {number} [current]
@@ -468,7 +517,7 @@ const Joi = require("joi");
468
517
  * Intent_app_error_dict_list
469
518
  * @property {string[]} [intent_app_error_list] - Intent_app_error_list
470
519
  * @property {boolean} [intent_flow] - Intent_flow
471
- * @property {PaymentModeLogo} [logo_url] - Logo
520
+ * @property {Object} [logo_url] - Logo
472
521
  * @property {string} [merchant_code] - Merchant code
473
522
  * @property {string} [name] - Name
474
523
  * @property {string} [nickname] - Nickname
@@ -516,6 +565,66 @@ const Joi = require("joi");
516
565
  * @property {boolean} success - Response is successful or not
517
566
  */
518
567
 
568
+ /**
569
+ * @typedef PaymentSessionDetail
570
+ * @property {string} [aggregator_customer_id] - Unique customer id generated by
571
+ * payment gateway, not required for standard checkout.
572
+ * @property {string} aggregator_order_id - Unique order id or payment request
573
+ * id generated by payment gateway
574
+ * @property {number} amount - Amount paid.
575
+ * @property {number} amount_captured - Amount which is captured or credited to
576
+ * merchant account
577
+ * @property {number} [amount_refunded]
578
+ * @property {AddressDetail} billing_address - Billing address
579
+ * @property {string} cancel_url - Cancel url sent by Fynd platform at the time
580
+ * of payment creation
581
+ * @property {boolean} [captured] - Whether the payment is captured (credited to
582
+ * merchant account) by payment gateway.
583
+ * @property {string} [created] - Timestamp in epoch
584
+ * @property {string} currency - Currency of the payment.
585
+ * @property {string} g_user_id - Global user identifier - unique user id
586
+ * generated by Fynd platform
587
+ * @property {string} gid - Global identifier of the entity (e.g. order, cart
588
+ * etc.) against which payment_session was initiated. This is generated by
589
+ * Fynd payments platform and is unique.
590
+ * @property {string} [kind] - Optional kind of purchase/payment - one time
591
+ * payment (sale) or subcription. defaults to sale.
592
+ * @property {string} [locale] - User's locale
593
+ * @property {string} [merchant_locale] - Merchant's locale
594
+ * @property {string} mode - Test or live, test mode uses test credentials so
595
+ * that actual payment is not created.
596
+ * @property {string} payment_id - Unique transaction id generated by payment gateway
597
+ * @property {Object[]} payment_methods - Method of payment
598
+ * @property {AddressDetail} shipping_address - Shipping address
599
+ * @property {string} status - Stautus of the payment
600
+ * @property {string} success_url - Success url sent by Fynd platform at the
601
+ * time of payment creation
602
+ */
603
+
604
+ /**
605
+ * @typedef PaymentSessionRequestSerializer
606
+ * @property {string} currency - Currency of the payment.
607
+ * @property {string} gid - Global identifier of the entity (e.g. order, cart
608
+ * etc.) against which payment_session was initiated. This is generated by
609
+ * Fynd payments platform and is unique.
610
+ * @property {OrderDetail} order_details - The details of the order.
611
+ * @property {PaymentSessionDetail[]} payment_details - The payment details with
612
+ * the schema `PaymentSessionDetail`.
613
+ * @property {string} status - Status of the payment.
614
+ * @property {number} total_amount - Amount paid.
615
+ */
616
+
617
+ /**
618
+ * @typedef PaymentSessionResponseSerializer
619
+ * @property {string} currency - Currency of the payment.
620
+ * @property {string} gid - Global identifier of the entity (e.g. order, cart
621
+ * etc.) against which payment_session was initiated. This is generated by
622
+ * Fynd payments platform and is unique.
623
+ * @property {Object[]} platform_transaction_details - Platform transaction details.
624
+ * @property {string} status - Status of the payment.
625
+ * @property {number} total_amount - Amount paid.
626
+ */
627
+
519
628
  /**
520
629
  * @typedef PaymentStatusBulkHandlerRequest
521
630
  * @property {string[]} merchant_order_id - List of order ids
@@ -668,6 +777,47 @@ const Joi = require("joi");
668
777
  * @property {boolean} success - Success or failure flag.
669
778
  */
670
779
 
780
+ /**
781
+ * @typedef RefundSessionDetail
782
+ * @property {number} amount - Amount refunded.
783
+ * @property {string} [balance_transaction] - Balance transaction.
784
+ * @property {string} created - Timestamp in epoch.
785
+ * @property {string} currency - Currency of the payment.
786
+ * @property {string} payment_id - Unique payment id generated by payment gateway.
787
+ * @property {string} [reason] - Reason for refund, optional
788
+ * @property {string} [receipt_number] - Unique receipt for refund, generated by
789
+ * payment gateway, if not available can be utr.
790
+ * @property {string} [refund_utr] - Unique refund utr generated by payment gateway.
791
+ * @property {string} request_id - Refund request id, unique id generated by Fynd platform
792
+ * @property {string} [source_transfer_reversal] - Description in case of
793
+ * reversal of payment.
794
+ * @property {string} status - Status of the refund.
795
+ * @property {string} [transfer_reversal] - Description in case of reversal of payment.
796
+ */
797
+
798
+ /**
799
+ * @typedef RefundSessionRequestSerializer
800
+ * @property {string} currency - The currency of the payment.
801
+ * @property {string} gid - Global identifier of the entity (e.g. order, cart
802
+ * etc.) against which payment_session was initiated. This is generated by
803
+ * Fynd payments platform and is unique.
804
+ * @property {PaymentSessionDetail} payment_details - Details of the payment
805
+ * @property {RefundSessionDetail[]} [refund_details] - Details of the refund
806
+ * @property {string} status - The status of the refund.
807
+ * @property {number} total_amount - The total amount refunded.
808
+ */
809
+
810
+ /**
811
+ * @typedef RefundSessionResponseSerializer
812
+ * @property {string} currency - The currency of the payment.
813
+ * @property {string} gid - Global identifier of the entity (e.g. order, cart
814
+ * etc.) against which payment_session was initiated. This is generated by
815
+ * Fynd payments platform and is unique.
816
+ * @property {Object[]} platform_refund_details - Details of the refund
817
+ * @property {string} status - The status of the refund.
818
+ * @property {number} total_refund_amount - The total amount refunded.
819
+ */
820
+
671
821
  /**
672
822
  * @typedef RepaymentDetailsSerialiserPayAll
673
823
  * @property {string} aggregator_order_id - Id of payment gateway
@@ -823,6 +973,31 @@ class PaymentPlatformModel {
823
973
  });
824
974
  }
825
975
 
976
+ /** @returns {AddressDetail} */
977
+ static AddressDetail() {
978
+ return Joi.object({
979
+ address: Joi.string().allow("").required(),
980
+ address_type: Joi.string().allow("").required(),
981
+ area: Joi.string().allow("").required(),
982
+ area_code: Joi.string().allow("").required(),
983
+ area_code_slug: Joi.string().allow("").required(),
984
+ city: Joi.string().allow("").required(),
985
+ country: Joi.string().allow("").required(),
986
+ country_iso_code: Joi.string().allow("").required(),
987
+ country_phone_code: Joi.string().allow("").required(),
988
+ email: Joi.string().allow(""),
989
+ expire_at: Joi.string().allow(""),
990
+ g_address_id: Joi.string().allow("").required(),
991
+ geo_location: Joi.any(),
992
+ google_map_point: Joi.any(),
993
+ landmark: Joi.string().allow(""),
994
+ name: Joi.string().allow("").required(),
995
+ phone: Joi.string().allow("").required(),
996
+ state: Joi.string().allow("").required(),
997
+ tags: Joi.array().items(Joi.any()),
998
+ });
999
+ }
1000
+
826
1001
  /** @returns {BankDetailsForOTP} */
827
1002
  static BankDetailsForOTP() {
828
1003
  return Joi.object({
@@ -1052,7 +1227,7 @@ class PaymentPlatformModel {
1052
1227
  /** @returns {ErrorResponse} */
1053
1228
  static ErrorResponse() {
1054
1229
  return Joi.object({
1055
- error: PaymentPlatformModel.ErrorDescription(),
1230
+ error: Joi.any().allow(null),
1056
1231
  message: Joi.string().allow("").required(),
1057
1232
  status_code: Joi.number().required(),
1058
1233
  success: Joi.boolean().required(),
@@ -1127,7 +1302,7 @@ class PaymentPlatformModel {
1127
1302
  return Joi.object({
1128
1303
  code: Joi.string().allow("").allow(null),
1129
1304
  display_name: Joi.string().allow("").allow(null),
1130
- logos: PaymentPlatformModel.PaymentModeLogo(),
1305
+ logos: Joi.any().allow(null),
1131
1306
  package_name: Joi.string().allow("").allow(null),
1132
1307
  });
1133
1308
  }
@@ -1167,6 +1342,23 @@ class PaymentPlatformModel {
1167
1342
  });
1168
1343
  }
1169
1344
 
1345
+ /** @returns {MerchnatPaymentModeRequest} */
1346
+ static MerchnatPaymentModeRequest() {
1347
+ return Joi.object({
1348
+ offline: Joi.any().allow(null),
1349
+ online: Joi.any().allow(null),
1350
+ });
1351
+ }
1352
+
1353
+ /** @returns {MerchnatPaymentModeResponse} */
1354
+ static MerchnatPaymentModeResponse() {
1355
+ return Joi.object({
1356
+ items: Joi.array().items(Joi.any()),
1357
+ message: Joi.string().allow("").allow(null),
1358
+ success: Joi.boolean().required(),
1359
+ });
1360
+ }
1361
+
1170
1362
  /** @returns {MultiTenderPaymentMeta} */
1171
1363
  static MultiTenderPaymentMeta() {
1172
1364
  return Joi.object({
@@ -1232,6 +1424,18 @@ class PaymentPlatformModel {
1232
1424
  });
1233
1425
  }
1234
1426
 
1427
+ /** @returns {OrderDetail} */
1428
+ static OrderDetail() {
1429
+ return Joi.object({
1430
+ aggregator: Joi.string().allow("").required(),
1431
+ aggregator_order_details: Joi.any().required(),
1432
+ amount: Joi.number().required(),
1433
+ currency: Joi.string().allow("").required(),
1434
+ gid: Joi.string().allow("").required(),
1435
+ status: Joi.string().allow("").required(),
1436
+ });
1437
+ }
1438
+
1235
1439
  /** @returns {Page} */
1236
1440
  static Page() {
1237
1441
  return Joi.object({
@@ -1387,7 +1591,7 @@ class PaymentPlatformModel {
1387
1591
  ),
1388
1592
  intent_app_error_list: Joi.array().items(Joi.string().allow("")),
1389
1593
  intent_flow: Joi.boolean().allow(null),
1390
- logo_url: PaymentPlatformModel.PaymentModeLogo(),
1594
+ logo_url: Joi.any().allow(null),
1391
1595
  merchant_code: Joi.string().allow("").allow(null),
1392
1596
  name: Joi.string().allow("").allow(null),
1393
1597
  nickname: Joi.string().allow("").allow(null),
@@ -1446,6 +1650,58 @@ class PaymentPlatformModel {
1446
1650
  });
1447
1651
  }
1448
1652
 
1653
+ /** @returns {PaymentSessionDetail} */
1654
+ static PaymentSessionDetail() {
1655
+ return Joi.object({
1656
+ aggregator_customer_id: Joi.string().allow(""),
1657
+ aggregator_order_id: Joi.string().allow("").required(),
1658
+ amount: Joi.number().required(),
1659
+ amount_captured: Joi.number().required(),
1660
+ amount_refunded: Joi.number(),
1661
+ billing_address: PaymentPlatformModel.AddressDetail().required(),
1662
+ cancel_url: Joi.string().allow("").required(),
1663
+ captured: Joi.boolean(),
1664
+ created: Joi.string().allow(""),
1665
+ currency: Joi.string().allow("").required(),
1666
+ g_user_id: Joi.string().allow("").required(),
1667
+ gid: Joi.string().allow("").required(),
1668
+ kind: Joi.string().allow(""),
1669
+ locale: Joi.string().allow(""),
1670
+ merchant_locale: Joi.string().allow(""),
1671
+ mode: Joi.string().allow("").required(),
1672
+ payment_id: Joi.string().allow("").required(),
1673
+ payment_methods: Joi.array().items(Joi.any()).required(),
1674
+ shipping_address: PaymentPlatformModel.AddressDetail().required(),
1675
+ status: Joi.string().allow("").required(),
1676
+ success_url: Joi.string().allow("").required(),
1677
+ });
1678
+ }
1679
+
1680
+ /** @returns {PaymentSessionRequestSerializer} */
1681
+ static PaymentSessionRequestSerializer() {
1682
+ return Joi.object({
1683
+ currency: Joi.string().allow("").required(),
1684
+ gid: Joi.string().allow("").required(),
1685
+ order_details: PaymentPlatformModel.OrderDetail().required(),
1686
+ payment_details: Joi.array()
1687
+ .items(PaymentPlatformModel.PaymentSessionDetail())
1688
+ .required(),
1689
+ status: Joi.string().allow("").required(),
1690
+ total_amount: Joi.number().required(),
1691
+ });
1692
+ }
1693
+
1694
+ /** @returns {PaymentSessionResponseSerializer} */
1695
+ static PaymentSessionResponseSerializer() {
1696
+ return Joi.object({
1697
+ currency: Joi.string().allow("").required(),
1698
+ gid: Joi.string().allow("").required(),
1699
+ platform_transaction_details: Joi.array().items(Joi.any()).required(),
1700
+ status: Joi.string().allow("").required(),
1701
+ total_amount: Joi.number().required(),
1702
+ });
1703
+ }
1704
+
1449
1705
  /** @returns {PaymentStatusBulkHandlerRequest} */
1450
1706
  static PaymentStatusBulkHandlerRequest() {
1451
1707
  return Joi.object({
@@ -1632,6 +1888,49 @@ class PaymentPlatformModel {
1632
1888
  });
1633
1889
  }
1634
1890
 
1891
+ /** @returns {RefundSessionDetail} */
1892
+ static RefundSessionDetail() {
1893
+ return Joi.object({
1894
+ amount: Joi.number().required(),
1895
+ balance_transaction: Joi.string().allow(""),
1896
+ created: Joi.string().allow("").required(),
1897
+ currency: Joi.string().allow("").required(),
1898
+ payment_id: Joi.string().allow("").required(),
1899
+ reason: Joi.string().allow(""),
1900
+ receipt_number: Joi.string().allow(""),
1901
+ refund_utr: Joi.string().allow(""),
1902
+ request_id: Joi.string().allow("").required(),
1903
+ source_transfer_reversal: Joi.string().allow(""),
1904
+ status: Joi.string().allow("").required(),
1905
+ transfer_reversal: Joi.string().allow(""),
1906
+ });
1907
+ }
1908
+
1909
+ /** @returns {RefundSessionRequestSerializer} */
1910
+ static RefundSessionRequestSerializer() {
1911
+ return Joi.object({
1912
+ currency: Joi.string().allow("").required(),
1913
+ gid: Joi.string().allow("").required(),
1914
+ payment_details: PaymentPlatformModel.PaymentSessionDetail().required(),
1915
+ refund_details: Joi.array().items(
1916
+ PaymentPlatformModel.RefundSessionDetail()
1917
+ ),
1918
+ status: Joi.string().allow("").required(),
1919
+ total_amount: Joi.number().required(),
1920
+ });
1921
+ }
1922
+
1923
+ /** @returns {RefundSessionResponseSerializer} */
1924
+ static RefundSessionResponseSerializer() {
1925
+ return Joi.object({
1926
+ currency: Joi.string().allow("").required(),
1927
+ gid: Joi.string().allow("").required(),
1928
+ platform_refund_details: Joi.array().items(Joi.any()).required(),
1929
+ status: Joi.string().allow("").required(),
1930
+ total_refund_amount: Joi.number().required(),
1931
+ });
1932
+ }
1933
+
1635
1934
  /** @returns {RepaymentDetailsSerialiserPayAll} */
1636
1935
  static RepaymentDetailsSerialiserPayAll() {
1637
1936
  return Joi.object({
@@ -1,7 +1,7 @@
1
1
  export = APIClient;
2
2
  /**
3
3
  * @typedef {Object} Options
4
- * @property {boolean} headers - Whether headers are returned or not.
4
+ * @property {boolean} responseHeaders - Whether response headers are returned or not.
5
5
  */
6
6
  declare class APIClient {
7
7
  /**
@@ -21,7 +21,7 @@ declare namespace APIClient {
21
21
  }
22
22
  type Options = {
23
23
  /**
24
- * - Whether headers are returned or not.
24
+ * - Whether response headers are returned or not.
25
25
  */
26
- headers: boolean;
26
+ responseHeaders: boolean;
27
27
  };
@@ -2,7 +2,7 @@ const { fdkAxios } = require("../common/AxiosHelper");
2
2
 
3
3
  /**
4
4
  * @typedef {Object} Options
5
- * @property {boolean} headers - Whether headers are returned or not.
5
+ * @property {boolean} responseHeaders - Whether response headers are returned or not.
6
6
  */
7
7
 
8
8
  class APIClient {
@@ -34,7 +34,7 @@ class APIClient {
34
34
  ...extraHeaders,
35
35
  ...xHeaders,
36
36
  },
37
- _returnHeaders: options.headers,
37
+ responseHeaders: options.responseHeaders,
38
38
  };
39
39
  rawRequest = JSON.parse(JSON.stringify(rawRequest));
40
40
 
@@ -25,9 +25,9 @@ declare class PlatformClient {
25
25
  inventory: Inventory;
26
26
  lead: Lead;
27
27
  order: Order;
28
- partner: Partner;
29
28
  payment: Payment;
30
29
  serviceability: Serviceability;
30
+ theme: Theme;
31
31
  webhook: Webhook;
32
32
  /**
33
33
  * Creates an instance of PlatformApplicationClient to interact with a
@@ -60,8 +60,8 @@ import Finance = require("./Finance/FinancePlatformClient");
60
60
  import Inventory = require("./Inventory/InventoryPlatformClient");
61
61
  import Lead = require("./Lead/LeadPlatformClient");
62
62
  import Order = require("./Order/OrderPlatformClient");
63
- import Partner = require("./Partner/PartnerPlatformClient");
64
63
  import Payment = require("./Payment/PaymentPlatformClient");
65
64
  import Serviceability = require("./Serviceability/ServiceabilityPlatformClient");
65
+ import Theme = require("./Theme/ThemePlatformClient");
66
66
  import Webhook = require("./Webhook/WebhookPlatformClient");
67
67
  import PlatformApplicationClient = require("./PlatformApplicationClient");
@@ -24,12 +24,12 @@ const Lead = require("./Lead/LeadPlatformClient");
24
24
 
25
25
  const Order = require("./Order/OrderPlatformClient");
26
26
 
27
- const Partner = require("./Partner/PartnerPlatformClient");
28
-
29
27
  const Payment = require("./Payment/PaymentPlatformClient");
30
28
 
31
29
  const Serviceability = require("./Serviceability/ServiceabilityPlatformClient");
32
30
 
31
+ const Theme = require("./Theme/ThemePlatformClient");
32
+
33
33
  const Webhook = require("./Webhook/WebhookPlatformClient");
34
34
 
35
35
  const PlatformApplicationClient = require("./PlatformApplicationClient");
@@ -75,12 +75,12 @@ class PlatformClient {
75
75
 
76
76
  this.order = new Order(config);
77
77
 
78
- this.partner = new Partner(config);
79
-
80
78
  this.payment = new Payment(config);
81
79
 
82
80
  this.serviceability = new Serviceability(config);
83
81
 
82
+ this.theme = new Theme(config);
83
+
84
84
  this.webhook = new Webhook(config);
85
85
  }
86
86
 
@@ -5,50 +5,58 @@ declare class Rewards {
5
5
  applicationId: any;
6
6
  /**
7
7
  * @param {RewardsPlatformApplicationValidator.GetGiveawayByIdParam} arg - Arg object
8
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
8
9
  * @param {import("../PlatformAPIClient").Options} - Options
9
10
  * @returns {Promise<RewardsPlatformModel.Giveaway>} - Success response
10
11
  * @name getGiveawayById
11
12
  * @summary: Get giveaway by ID.
12
13
  * @description: Retrieve the specific giveaway by giveaway ID. It will show all the details of the requested giveaway. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/getGiveawayById/).
13
14
  */
14
- getGiveawayById({ id }?: RewardsPlatformApplicationValidator.GetGiveawayByIdParam, { headers }?: import("../PlatformAPIClient").Options): Promise<RewardsPlatformModel.Giveaway>;
15
+ getGiveawayById({ id, requestHeaders }?: RewardsPlatformApplicationValidator.GetGiveawayByIdParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.Giveaway>;
15
16
  /**
16
17
  * @param {RewardsPlatformApplicationValidator.GetOfferByNameParam} arg - Arg object
18
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
17
19
  * @param {import("../PlatformAPIClient").Options} - Options
18
20
  * @returns {Promise<RewardsPlatformModel.Offer>} - Success response
19
21
  * @name getOfferByName
20
22
  * @summary: Fetch a offer by its name
21
23
  * @description: Fetch the specific offer details and configuration by the name of the offer. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/getOfferByName/).
22
24
  */
23
- getOfferByName({ name }?: RewardsPlatformApplicationValidator.GetOfferByNameParam, { headers }?: import("../PlatformAPIClient").Options): Promise<RewardsPlatformModel.Offer>;
25
+ getOfferByName({ name, requestHeaders }?: RewardsPlatformApplicationValidator.GetOfferByNameParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.Offer>;
24
26
  /**
27
+ * @param {RewardsPlatformApplicationValidator.GetRewardsConfigurationParam} arg
28
+ * - Arg object
29
+ *
30
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
25
31
  * @param {import("../PlatformAPIClient").Options} - Options
26
32
  * @returns {Promise<RewardsPlatformModel.ConfigurationRes>} - Success response
27
33
  * @name getRewardsConfiguration
28
34
  * @summary: Get all valid android paths
29
35
  * @description: Use this API to get a list of valid android paths required by the Rewards INIT API to validate a fraudulent device. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/getRewardsConfiguration/).
30
36
  */
31
- getRewardsConfiguration({ headers }?: import("../PlatformAPIClient").Options): Promise<RewardsPlatformModel.ConfigurationRes>;
37
+ getRewardsConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<RewardsPlatformModel.ConfigurationRes>;
32
38
  /**
33
39
  * @param {RewardsPlatformApplicationValidator.GetUserDetailsParam} arg - Arg object
40
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
34
41
  * @param {import("../PlatformAPIClient").Options} - Options
35
42
  * @returns {Promise<RewardsPlatformModel.UserRes>} - Success response
36
43
  * @name getUserDetails
37
44
  * @summary: Get user reward details
38
45
  * @description: Fetches the user details and the user reward details with their current reward points for the specific user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/getUserDetails/).
39
46
  */
40
- getUserDetails({ userId }?: RewardsPlatformApplicationValidator.GetUserDetailsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<RewardsPlatformModel.UserRes>;
47
+ getUserDetails({ userId, requestHeaders }?: RewardsPlatformApplicationValidator.GetUserDetailsParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.UserRes>;
41
48
  /**
42
49
  * @param {RewardsPlatformApplicationValidator.GetUserPointsHistoryParam} arg
43
50
  * - Arg object
44
51
  *
52
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
45
53
  * @param {import("../PlatformAPIClient").Options} - Options
46
54
  * @returns {Promise<RewardsPlatformModel.HistoryRes>} - Success response
47
55
  * @name getUserPointsHistory
48
56
  * @summary: Get all transactions of reward points
49
57
  * @description: Fetches a list of points transactions like giveaway points, signup points, referral points, order earn points, redeem points and expired points. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/getUserPointsHistory/).
50
58
  */
51
- getUserPointsHistory({ userId, pageId, pageSize }?: RewardsPlatformApplicationValidator.GetUserPointsHistoryParam, { headers }?: import("../PlatformAPIClient").Options): Promise<RewardsPlatformModel.HistoryRes>;
59
+ getUserPointsHistory({ userId, pageId, pageSize, requestHeaders }?: RewardsPlatformApplicationValidator.GetUserPointsHistoryParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.HistoryRes>;
52
60
  /**
53
61
  * @param {Object} arg - Arg object.
54
62
  * @param {string} arg.userId - User id
@@ -67,70 +75,78 @@ declare class Rewards {
67
75
  }): Paginator<RewardsPlatformModel.HistoryRes>;
68
76
  /**
69
77
  * @param {RewardsPlatformApplicationValidator.SaveGiveAwayParam} arg - Arg object
78
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
70
79
  * @param {import("../PlatformAPIClient").Options} - Options
71
80
  * @returns {Promise<RewardsPlatformModel.Giveaway>} - Success response
72
81
  * @name saveGiveAway
73
82
  * @summary: List of giveaways of the current application.
74
83
  * @description: Creates a new giveaway in the current application, specifying the target audience, points allocation, as well as the name and display name of the giveaway. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/saveGiveAway/).
75
84
  */
76
- saveGiveAway({ body }?: RewardsPlatformApplicationValidator.SaveGiveAwayParam, { headers }?: import("../PlatformAPIClient").Options): Promise<RewardsPlatformModel.Giveaway>;
85
+ saveGiveAway({ body, requestHeaders }?: RewardsPlatformApplicationValidator.SaveGiveAwayParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.Giveaway>;
77
86
  /**
78
87
  * @param {RewardsPlatformApplicationValidator.SetRewardsConfigurationParam} arg
79
88
  * - Arg object
80
89
  *
90
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
81
91
  * @param {import("../PlatformAPIClient").Options} - Options
82
92
  * @returns {Promise<RewardsPlatformModel.SetConfigurationRes>} - Success response
83
93
  * @name setRewardsConfiguration
84
94
  * @summary: Updates the collection with given android paths.
85
95
  * @description: Updates the configuration or inserts new records with the given android paths. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/setRewardsConfiguration/).
86
96
  */
87
- setRewardsConfiguration({ body }?: RewardsPlatformApplicationValidator.SetRewardsConfigurationParam, { headers }?: import("../PlatformAPIClient").Options): Promise<RewardsPlatformModel.SetConfigurationRes>;
97
+ setRewardsConfiguration({ body, requestHeaders }?: RewardsPlatformApplicationValidator.SetRewardsConfigurationParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.SetConfigurationRes>;
88
98
  /**
89
99
  * @param {RewardsPlatformApplicationValidator.ShowGiveawaysParam} arg - Arg object
100
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
90
101
  * @param {import("../PlatformAPIClient").Options} - Options
91
102
  * @returns {Promise<RewardsPlatformModel.GiveawayResponse>} - Success response
92
103
  * @name showGiveaways
93
104
  * @summary: List of giveaways of the current application.
94
105
  * @description: Fetch the detailed compilation of live, completed, and scheduled point-based giveaways created. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/showGiveaways/).
95
106
  */
96
- showGiveaways({ pageId, pageSize }?: RewardsPlatformApplicationValidator.ShowGiveawaysParam, { headers }?: import("../PlatformAPIClient").Options): Promise<RewardsPlatformModel.GiveawayResponse>;
107
+ showGiveaways({ pageId, pageSize, requestHeaders }?: RewardsPlatformApplicationValidator.ShowGiveawaysParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.GiveawayResponse>;
97
108
  /**
109
+ * @param {RewardsPlatformApplicationValidator.ShowOffersParam} arg - Arg object
110
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
98
111
  * @param {import("../PlatformAPIClient").Options} - Options
99
112
  * @returns {Promise<RewardsPlatformModel.Offer[]>} - Success response
100
113
  * @name showOffers
101
114
  * @summary: List of offers of the current application.
102
115
  * @description: Retrieve the list of offers within the current application, including order_discount, order, sign_up, and referral, along with their respective details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/showOffers/).
103
116
  */
104
- showOffers({ headers }?: import("../PlatformAPIClient").Options): Promise<RewardsPlatformModel.Offer[]>;
117
+ showOffers({ requestHeaders }?: any, { responseHeaders }?: object): Promise<RewardsPlatformModel.Offer[]>;
105
118
  /**
106
119
  * @param {RewardsPlatformApplicationValidator.UpdateGiveAwayParam} arg - Arg object
120
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
107
121
  * @param {import("../PlatformAPIClient").Options} - Options
108
122
  * @returns {Promise<RewardsPlatformModel.Giveaway>} - Success response
109
123
  * @name updateGiveAway
110
124
  * @summary: Updates the giveaway by it's ID.
111
125
  * @description: Make the necessary updates to the giveaway based on its giveaway ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/updateGiveAway/).
112
126
  */
113
- updateGiveAway({ id, body }?: RewardsPlatformApplicationValidator.UpdateGiveAwayParam, { headers }?: import("../PlatformAPIClient").Options): Promise<RewardsPlatformModel.Giveaway>;
127
+ updateGiveAway({ id, body, requestHeaders }?: RewardsPlatformApplicationValidator.UpdateGiveAwayParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.Giveaway>;
114
128
  /**
115
129
  * @param {RewardsPlatformApplicationValidator.UpdateOfferByNameParam} arg
116
130
  * - Arg object
117
131
  *
132
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
118
133
  * @param {import("../PlatformAPIClient").Options} - Options
119
134
  * @returns {Promise<RewardsPlatformModel.Offer>} - Success response
120
135
  * @name updateOfferByName
121
136
  * @summary: Update offer by name
122
137
  * @description: Update the specific offer details and its configuration by offer name. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/updateOfferByName/).
123
138
  */
124
- updateOfferByName({ name, body }?: RewardsPlatformApplicationValidator.UpdateOfferByNameParam, { headers }?: import("../PlatformAPIClient").Options): Promise<RewardsPlatformModel.Offer>;
139
+ updateOfferByName({ name, body, requestHeaders }?: RewardsPlatformApplicationValidator.UpdateOfferByNameParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.Offer>;
125
140
  /**
126
141
  * @param {RewardsPlatformApplicationValidator.UpdateUserStatusParam} arg - Arg object
142
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
127
143
  * @param {import("../PlatformAPIClient").Options} - Options
128
144
  * @returns {Promise<RewardsPlatformModel.AppUser>} - Success response
129
145
  * @name updateUserStatus
130
146
  * @summary: Update user status
131
147
  * @description: Update the user status by marking them as a block or unblock. It can be done by changing the active flag in request body. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/updateUserStatus/).
132
148
  */
133
- updateUserStatus({ userId, body }?: RewardsPlatformApplicationValidator.UpdateUserStatusParam, { headers }?: import("../PlatformAPIClient").Options): Promise<RewardsPlatformModel.AppUser>;
149
+ updateUserStatus({ userId, body, requestHeaders }?: RewardsPlatformApplicationValidator.UpdateUserStatusParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.AppUser>;
134
150
  }
135
151
  import RewardsPlatformApplicationValidator = require("./RewardsPlatformApplicationValidator");
136
152
  import RewardsPlatformModel = require("./RewardsPlatformModel");