@gofynd/fdk-client-javascript 1.0.1 → 1.0.3

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 (318) hide show
  1. package/documentation/application/CART.md +5934 -4502
  2. package/documentation/application/CATALOG.md +6338 -7245
  3. package/documentation/application/COMMON.md +95 -222
  4. package/documentation/application/COMMUNICATION.md +106 -186
  5. package/documentation/application/CONFIGURATION.md +903 -1597
  6. package/documentation/application/CONTENT.md +562 -1270
  7. package/documentation/application/FILESTORAGE.md +84 -220
  8. package/documentation/application/LEAD.md +314 -660
  9. package/documentation/application/LOGISTIC.md +229 -305
  10. package/documentation/application/ORDER.md +642 -1137
  11. package/documentation/application/PAYMENT.md +2285 -3031
  12. package/documentation/application/POSCART.md +6079 -4642
  13. package/documentation/application/REWARDS.md +94 -248
  14. package/documentation/application/SHARE.md +152 -250
  15. package/documentation/application/THEME.md +952 -1235
  16. package/documentation/application/USER.md +1228 -1765
  17. package/documentation/platform/ANALYTICS.md +207 -349
  18. package/documentation/platform/AUDITTRAIL.md +121 -204
  19. package/documentation/platform/BILLING.md +865 -1376
  20. package/documentation/platform/CART.md +2814 -3662
  21. package/documentation/platform/CATALOG.md +15266 -17619
  22. package/documentation/platform/COMMON.md +95 -222
  23. package/documentation/platform/COMMUNICATION.md +1632 -2380
  24. package/documentation/platform/COMPANYPROFILE.md +572 -957
  25. package/documentation/platform/CONFIGURATION.md +3050 -4073
  26. package/documentation/platform/CONTENT.md +3509 -4121
  27. package/documentation/platform/DISCOUNT.md +140 -236
  28. package/documentation/platform/FILESTORAGE.md +187 -323
  29. package/documentation/platform/INVENTORY.md +268 -911
  30. package/documentation/platform/LEAD.md +2195 -2541
  31. package/documentation/platform/ORDER.md +3750 -5636
  32. package/documentation/platform/PARTNER.md +9 -36
  33. package/documentation/platform/PAYMENT.md +903 -1213
  34. package/documentation/platform/REWARDS.md +183 -347
  35. package/documentation/platform/SHARE.md +120 -213
  36. package/documentation/platform/THEME.md +12956 -13239
  37. package/documentation/platform/USER.md +975 -1120
  38. package/documentation/platform/WEBHOOK.md +78 -184
  39. package/documentation/public/CONFIGURATION.md +95 -222
  40. package/documentation/public/INVENTORY.md +100 -282
  41. package/documentation/public/WEBHOOK.md +27 -133
  42. package/package.json +1 -1
  43. package/sdk/application/ApplicationConfig.js +1 -1
  44. package/sdk/application/Cart/CartApplicationClient.d.ts +243 -243
  45. package/sdk/application/Cart/CartApplicationClient.js +1058 -547
  46. package/sdk/application/Cart/CartApplicationModel.d.ts +64 -63
  47. package/sdk/application/Cart/CartApplicationModel.js +489 -886
  48. package/sdk/application/Cart/CartApplicationValidator.d.ts +17 -17
  49. package/sdk/application/Cart/CartApplicationValidator.js +98 -98
  50. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +358 -358
  51. package/sdk/application/Catalog/CatalogApplicationClient.js +1545 -949
  52. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +90 -90
  53. package/sdk/application/Catalog/CatalogApplicationModel.js +692 -1258
  54. package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +19 -19
  55. package/sdk/application/Catalog/CatalogApplicationValidator.js +110 -110
  56. package/sdk/application/Common/CommonApplicationClient.d.ts +13 -13
  57. package/sdk/application/Common/CommonApplicationClient.js +76 -36
  58. package/sdk/application/Common/CommonApplicationModel.d.ts +12 -12
  59. package/sdk/application/Common/CommonApplicationModel.js +83 -160
  60. package/sdk/application/Common/CommonApplicationValidator.d.ts +1 -1
  61. package/sdk/application/Common/CommonApplicationValidator.js +6 -6
  62. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +11 -11
  63. package/sdk/application/Communication/CommunicationApplicationClient.js +92 -31
  64. package/sdk/application/Communication/CommunicationApplicationModel.d.ts +6 -6
  65. package/sdk/application/Communication/CommunicationApplicationModel.js +38 -83
  66. package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +1 -1
  67. package/sdk/application/Communication/CommunicationApplicationValidator.js +4 -4
  68. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +116 -116
  69. package/sdk/application/Configuration/ConfigurationApplicationClient.js +638 -312
  70. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +85 -85
  71. package/sdk/application/Configuration/ConfigurationApplicationModel.js +480 -851
  72. package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +8 -8
  73. package/sdk/application/Configuration/ConfigurationApplicationValidator.js +33 -33
  74. package/sdk/application/Content/ContentApplicationClient.d.ts +67 -67
  75. package/sdk/application/Content/ContentApplicationClient.js +581 -213
  76. package/sdk/application/Content/ContentApplicationModel.d.ts +76 -75
  77. package/sdk/application/Content/ContentApplicationModel.js +468 -875
  78. package/sdk/application/Content/ContentApplicationValidator.d.ts +5 -5
  79. package/sdk/application/Content/ContentApplicationValidator.js +24 -24
  80. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +25 -25
  81. package/sdk/application/FileStorage/FileStorageApplicationClient.js +121 -59
  82. package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +13 -13
  83. package/sdk/application/FileStorage/FileStorageApplicationModel.js +86 -169
  84. package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +1 -1
  85. package/sdk/application/FileStorage/FileStorageApplicationValidator.js +7 -7
  86. package/sdk/application/Lead/LeadApplicationClient.d.ts +24 -24
  87. package/sdk/application/Lead/LeadApplicationClient.js +230 -96
  88. package/sdk/application/Lead/LeadApplicationModel.d.ts +35 -35
  89. package/sdk/application/Lead/LeadApplicationModel.js +267 -474
  90. package/sdk/application/Lead/LeadApplicationValidator.d.ts +2 -2
  91. package/sdk/application/Lead/LeadApplicationValidator.js +11 -11
  92. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +30 -19
  93. package/sdk/application/Logistic/LogisticApplicationClient.js +196 -47
  94. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +17 -14
  95. package/sdk/application/Logistic/LogisticApplicationModel.js +133 -201
  96. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +3 -2
  97. package/sdk/application/Logistic/LogisticApplicationValidator.js +14 -8
  98. package/sdk/application/Order/OrderApplicationClient.d.ts +86 -86
  99. package/sdk/application/Order/OrderApplicationClient.js +448 -215
  100. package/sdk/application/Order/OrderApplicationModel.d.ts +50 -50
  101. package/sdk/application/Order/OrderApplicationModel.js +357 -661
  102. package/sdk/application/Order/OrderApplicationValidator.d.ts +7 -7
  103. package/sdk/application/Order/OrderApplicationValidator.js +28 -28
  104. package/sdk/application/Payment/PaymentApplicationClient.d.ts +318 -318
  105. package/sdk/application/Payment/PaymentApplicationClient.js +1525 -750
  106. package/sdk/application/Payment/PaymentApplicationModel.d.ts +72 -72
  107. package/sdk/application/Payment/PaymentApplicationModel.js +565 -1033
  108. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +28 -28
  109. package/sdk/application/Payment/PaymentApplicationValidator.js +107 -107
  110. package/sdk/application/PosCart/PosCartApplicationClient.d.ts +254 -254
  111. package/sdk/application/PosCart/PosCartApplicationClient.js +1137 -606
  112. package/sdk/application/PosCart/PosCartApplicationModel.d.ts +61 -60
  113. package/sdk/application/PosCart/PosCartApplicationModel.js +477 -873
  114. package/sdk/application/PosCart/PosCartApplicationValidator.d.ts +18 -18
  115. package/sdk/application/PosCart/PosCartApplicationValidator.js +103 -103
  116. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +27 -27
  117. package/sdk/application/Rewards/RewardsApplicationClient.js +253 -113
  118. package/sdk/application/Rewards/RewardsApplicationModel.d.ts +14 -14
  119. package/sdk/application/Rewards/RewardsApplicationModel.js +96 -191
  120. package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +3 -3
  121. package/sdk/application/Rewards/RewardsApplicationValidator.js +12 -12
  122. package/sdk/application/Share/ShareApplicationClient.d.ts +37 -37
  123. package/sdk/application/Share/ShareApplicationClient.js +221 -96
  124. package/sdk/application/Share/ShareApplicationModel.d.ts +8 -8
  125. package/sdk/application/Share/ShareApplicationModel.js +63 -123
  126. package/sdk/application/Share/ShareApplicationValidator.d.ts +4 -4
  127. package/sdk/application/Share/ShareApplicationValidator.js +12 -12
  128. package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
  129. package/sdk/application/Theme/ThemeApplicationClient.js +115 -37
  130. package/sdk/application/Theme/ThemeApplicationModel.d.ts +34 -34
  131. package/sdk/application/Theme/ThemeApplicationModel.js +190 -336
  132. package/sdk/application/Theme/ThemeApplicationValidator.d.ts +1 -1
  133. package/sdk/application/Theme/ThemeApplicationValidator.js +4 -4
  134. package/sdk/application/User/UserApplicationClient.d.ts +280 -280
  135. package/sdk/application/User/UserApplicationClient.js +1201 -543
  136. package/sdk/application/User/UserApplicationModel.d.ts +79 -72
  137. package/sdk/application/User/UserApplicationModel.js +440 -689
  138. package/sdk/application/User/UserApplicationValidator.d.ts +24 -24
  139. package/sdk/application/User/UserApplicationValidator.js +89 -89
  140. package/sdk/common/AxiosHelper.js +1 -1
  141. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +55 -47
  142. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +308 -151
  143. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +6 -6
  144. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +20 -20
  145. package/sdk/platform/Analytics/AnalyticsPlatformClient.d.ts +8 -4
  146. package/sdk/platform/Analytics/AnalyticsPlatformClient.js +103 -16
  147. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +11 -11
  148. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +95 -178
  149. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +16 -12
  150. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +131 -44
  151. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +10 -10
  152. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +50 -89
  153. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -1
  154. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +6 -6
  155. package/sdk/platform/Billing/BillingPlatformClient.d.ts +68 -56
  156. package/sdk/platform/Billing/BillingPlatformClient.js +416 -171
  157. package/sdk/platform/Billing/BillingPlatformModel.d.ts +40 -40
  158. package/sdk/platform/Billing/BillingPlatformModel.js +342 -668
  159. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +8 -8
  160. package/sdk/platform/Billing/BillingPlatformValidator.js +25 -25
  161. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +176 -159
  162. package/sdk/platform/Cart/CartPlatformApplicationClient.js +837 -500
  163. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +11 -11
  164. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +63 -63
  165. package/sdk/platform/Cart/CartPlatformModel.d.ts +86 -85
  166. package/sdk/platform/Cart/CartPlatformModel.js +677 -1211
  167. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +582 -529
  168. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +2642 -1533
  169. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +40 -40
  170. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +175 -175
  171. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +708 -590
  172. package/sdk/platform/Catalog/CatalogPlatformClient.js +3103 -1362
  173. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +293 -284
  174. package/sdk/platform/Catalog/CatalogPlatformModel.js +2149 -3660
  175. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +66 -64
  176. package/sdk/platform/Catalog/CatalogPlatformValidator.js +235 -216
  177. package/sdk/platform/Common/CommonPlatformClient.d.ts +14 -12
  178. package/sdk/platform/Common/CommonPlatformClient.js +80 -37
  179. package/sdk/platform/Common/CommonPlatformModel.d.ts +12 -12
  180. package/sdk/platform/Common/CommonPlatformModel.js +83 -160
  181. package/sdk/platform/Common/CommonPlatformValidator.d.ts +1 -1
  182. package/sdk/platform/Common/CommonPlatformValidator.js +6 -6
  183. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +333 -293
  184. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +1687 -855
  185. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +30 -30
  186. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +87 -87
  187. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +2 -1
  188. package/sdk/platform/Communication/CommunicationPlatformClient.js +28 -4
  189. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +67 -67
  190. package/sdk/platform/Communication/CommunicationPlatformModel.js +522 -974
  191. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +70 -57
  192. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +463 -182
  193. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +28 -28
  194. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +294 -557
  195. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +7 -7
  196. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +24 -24
  197. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +175 -137
  198. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +1168 -521
  199. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +22 -21
  200. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +69 -63
  201. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +137 -119
  202. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +691 -316
  203. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +148 -146
  204. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +854 -1508
  205. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +9 -9
  206. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +38 -38
  207. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +542 -461
  208. package/sdk/platform/Content/ContentPlatformApplicationClient.js +2600 -1160
  209. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +50 -49
  210. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +159 -152
  211. package/sdk/platform/Content/ContentPlatformModel.d.ts +79 -75
  212. package/sdk/platform/Content/ContentPlatformModel.js +486 -867
  213. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +72 -61
  214. package/sdk/platform/Discount/DiscountPlatformClient.js +424 -198
  215. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +7 -7
  216. package/sdk/platform/Discount/DiscountPlatformModel.js +60 -121
  217. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +6 -6
  218. package/sdk/platform/Discount/DiscountPlatformValidator.js +29 -29
  219. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +26 -22
  220. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +145 -59
  221. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +1 -1
  222. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +8 -8
  223. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +58 -52
  224. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +240 -114
  225. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +13 -13
  226. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +86 -169
  227. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +3 -3
  228. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +11 -11
  229. package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +76 -63
  230. package/sdk/platform/Inventory/InventoryPlatformClient.js +461 -197
  231. package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +30 -30
  232. package/sdk/platform/Inventory/InventoryPlatformModel.js +497 -964
  233. package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +7 -7
  234. package/sdk/platform/Inventory/InventoryPlatformValidator.js +28 -28
  235. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +84 -71
  236. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +441 -182
  237. package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +7 -7
  238. package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +28 -28
  239. package/sdk/platform/Lead/LeadPlatformClient.d.ts +86 -75
  240. package/sdk/platform/Lead/LeadPlatformClient.js +434 -212
  241. package/sdk/platform/Lead/LeadPlatformModel.d.ts +35 -35
  242. package/sdk/platform/Lead/LeadPlatformModel.js +267 -474
  243. package/sdk/platform/Lead/LeadPlatformValidator.d.ts +6 -6
  244. package/sdk/platform/Lead/LeadPlatformValidator.js +24 -24
  245. package/sdk/platform/OAuthClient.js +8 -8
  246. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +14 -11
  247. package/sdk/platform/Order/OrderPlatformApplicationClient.js +113 -49
  248. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +1 -1
  249. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +6 -6
  250. package/sdk/platform/Order/OrderPlatformClient.d.ts +367 -315
  251. package/sdk/platform/Order/OrderPlatformClient.js +1775 -893
  252. package/sdk/platform/Order/OrderPlatformModel.d.ts +198 -192
  253. package/sdk/platform/Order/OrderPlatformModel.js +1591 -2822
  254. package/sdk/platform/Order/OrderPlatformValidator.d.ts +32 -32
  255. package/sdk/platform/Order/OrderPlatformValidator.js +160 -155
  256. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -2
  257. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +52 -8
  258. package/sdk/platform/Partner/PartnerPlatformModel.js +6 -22
  259. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +65 -54
  260. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +395 -164
  261. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +6 -6
  262. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +23 -23
  263. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +55 -45
  264. package/sdk/platform/Payment/PaymentPlatformClient.js +362 -147
  265. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +27 -27
  266. package/sdk/platform/Payment/PaymentPlatformModel.js +220 -408
  267. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +4 -4
  268. package/sdk/platform/Payment/PaymentPlatformValidator.js +21 -21
  269. package/sdk/platform/PlatformApplicationClient.d.ts +1496 -10153
  270. package/sdk/platform/PlatformApplicationClient.js +1584 -13691
  271. package/sdk/platform/PlatformClient.d.ts +7918 -7666
  272. package/sdk/platform/PlatformClient.js +8701 -9926
  273. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +91 -78
  274. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +507 -253
  275. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +8 -8
  276. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +34 -34
  277. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +15 -15
  278. package/sdk/platform/Rewards/RewardsPlatformModel.js +92 -194
  279. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +16 -12
  280. package/sdk/platform/Share/SharePlatformApplicationClient.js +130 -52
  281. package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +1 -1
  282. package/sdk/platform/Share/SharePlatformApplicationValidator.js +6 -6
  283. package/sdk/platform/Share/SharePlatformModel.d.ts +8 -8
  284. package/sdk/platform/Share/SharePlatformModel.js +60 -118
  285. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +148 -124
  286. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +770 -295
  287. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +15 -15
  288. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +44 -44
  289. package/sdk/platform/Theme/ThemePlatformModel.d.ts +34 -34
  290. package/sdk/platform/Theme/ThemePlatformModel.js +190 -336
  291. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +146 -67
  292. package/sdk/platform/User/UserPlatformApplicationClient.js +742 -155
  293. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +12 -7
  294. package/sdk/platform/User/UserPlatformApplicationValidator.js +61 -23
  295. package/sdk/platform/User/UserPlatformModel.d.ts +79 -72
  296. package/sdk/platform/User/UserPlatformModel.js +440 -689
  297. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +35 -29
  298. package/sdk/platform/Webhook/WebhookPlatformClient.js +218 -91
  299. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +7 -7
  300. package/sdk/platform/Webhook/WebhookPlatformModel.js +68 -136
  301. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +3 -3
  302. package/sdk/platform/Webhook/WebhookPlatformValidator.js +14 -14
  303. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +13 -13
  304. package/sdk/public/Configuration/ConfigurationPublicClient.js +81 -38
  305. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +12 -12
  306. package/sdk/public/Configuration/ConfigurationPublicModel.js +85 -162
  307. package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +1 -1
  308. package/sdk/public/Configuration/ConfigurationPublicValidator.js +6 -6
  309. package/sdk/public/Inventory/InventoryPublicClient.d.ts +34 -34
  310. package/sdk/public/Inventory/InventoryPublicClient.js +228 -105
  311. package/sdk/public/Inventory/InventoryPublicModel.d.ts +10 -10
  312. package/sdk/public/Inventory/InventoryPublicModel.js +119 -245
  313. package/sdk/public/Inventory/InventoryPublicValidator.d.ts +3 -3
  314. package/sdk/public/Inventory/InventoryPublicValidator.js +15 -15
  315. package/sdk/public/Webhook/WebhookPublicClient.js +51 -10
  316. package/sdk/public/Webhook/WebhookPublicModel.d.ts +7 -7
  317. package/sdk/public/Webhook/WebhookPublicModel.js +68 -136
  318. package/tests/application/catalog.spec.js +7 -0
@@ -5,104 +5,296 @@ declare class Content {
5
5
  applicationId: any;
6
6
  /**
7
7
  * @param {Object} arg - Arg object.
8
- * @param {number} [arg.pageNo] - The page number to navigate through the
9
- * given set of results. Default value is 1.
10
- * @param {number} [arg.pageSize] - The number of items to retrieve in each
11
- * page. Default value is 10.
12
- * @summary: Get a list of announcements
13
- * @description: Announcements are useful to highlight a message or information on top of a webpage. Use this API to retrieve a list of announcements.
8
+ * @param {DataLoaderSchema} arg.body
9
+ * @returns {Promise<DataLoaderResponseSchema>} - Success response
10
+ * @summary: Adds a data loader
11
+ * @description: Use this API to add data loader. This includes the data loader name, operationId, service name and its type (url/function) with corresponding value.
14
12
  */
15
- getAnnouncementsList({ pageNo, pageSize }?: {
16
- pageNo?: number;
17
- pageSize?: number;
18
- }): Promise<any>;
13
+ addDataLoader({ body }?: {
14
+ body: DataLoaderSchema;
15
+ }): Promise<DataLoaderResponseSchema>;
19
16
  /**
20
17
  * @param {Object} arg - Arg object.
21
- * @param {string} arg.companyId - Numeric ID allotted to a business account
22
- * on Fynd Platform
23
- * @param {string} arg.applicationId - Numeric ID allotted to an application
24
- * created within a business account.
25
- * @param {number} [arg.pageSize] - The number of items to retrieve in each
26
- * page. Default value is 10.
27
- * @summary: Get a list of announcements
28
- * @description: Announcements are useful to highlight a message or information on top of a webpage. Use this API to retrieve a list of announcements.
18
+ * @param {string} arg.categoryId - ID allotted to an FAQ category.
19
+ * @param {CreateFaqSchema} arg.body
20
+ * @returns {Promise<CreateFaqResponseSchema>} - Success response
21
+ * @summary: Create an FAQ
22
+ * @description: FAQs help users to solve an issue or know more about a process. Use this API to create an FAQ for a given FAQ category.
29
23
  */
30
- getAnnouncementsListPaginator({ companyId, applicationId, pageSize }?: {
31
- companyId: string;
32
- applicationId: string;
33
- pageSize?: number;
34
- }): Paginator;
24
+ addFaq({ categoryId, body }?: {
25
+ categoryId: string;
26
+ body: CreateFaqSchema;
27
+ }): Promise<CreateFaqResponseSchema>;
28
+ /**
29
+ * @param {Object} arg - Arg object.
30
+ * @param {CreateTagRequestSchema} arg.body
31
+ * @returns {Promise<TagsSchema>} - Success response
32
+ * @summary: Add a tag
33
+ * @description: CSS and JS can be injected in the application (website) with the help of tags. Use this API to create such tags by entering the tag name, tag type (css/js), url and position of the tag.
34
+ */
35
+ addInjectableTag({ body }?: {
36
+ body: CreateTagRequestSchema;
37
+ }): Promise<TagsSchema>;
38
+ /**
39
+ * @param {Object} arg - Arg object.
40
+ * @param {PathMappingSchema} arg.body
41
+ * @returns {Promise<PathMappingSchema>} - Success response
42
+ * @summary: Save path based redirection rules
43
+ * @description: Use this API to add redirection rules
44
+ */
45
+ addPathRedirectionRules({ body }?: {
46
+ body: PathMappingSchema;
47
+ }): Promise<PathMappingSchema>;
35
48
  /**
36
49
  * @param {Object} arg - Arg object.
37
50
  * @param {AdminAnnouncementSchema} arg.body
51
+ * @returns {Promise<CreateAnnouncementSchema>} - Success response
38
52
  * @summary: Create an announcement
39
53
  * @description: Announcements are useful to highlight a message or information on top of a webpage. Use this API to create an announcement.
40
54
  */
41
55
  createAnnouncement({ body }?: {
42
56
  body: AdminAnnouncementSchema;
43
- }): Promise<any>;
57
+ }): Promise<CreateAnnouncementSchema>;
44
58
  /**
45
59
  * @param {Object} arg - Arg object.
46
- * @param {string} arg.announcementId - ID allotted to the announcement.
47
- * @summary: Get announcement by ID
48
- * @description: Use this API to retrieve an announcement and its details such as the target platform and pages on which it's applicable
60
+ * @param {BlogRequest} arg.body
61
+ * @returns {Promise<BlogSchema>} - Success response
62
+ * @summary: Create a blog
63
+ * @description: Use this API to create a blog.
49
64
  */
50
- getAnnouncementById({ announcementId }?: {
51
- announcementId: string;
52
- }): Promise<any>;
65
+ createBlog({ body }?: {
66
+ body: BlogRequest;
67
+ }): Promise<BlogSchema>;
53
68
  /**
54
69
  * @param {Object} arg - Arg object.
55
- * @param {string} arg.announcementId - ID allotted to the announcement.
56
- * @param {AdminAnnouncementSchema} arg.body
57
- * @summary: Update an announcement
58
- * @description: Use this API to edit an existing announcement and its details such as the target platform and pages on which it's applicable
70
+ * @param {CreateFaqCategoryRequestSchema} arg.body
71
+ * @returns {Promise<CreateFaqCategorySchema>} - Success response
72
+ * @summary: Create an FAQ category
73
+ * @description: FAQs help users to solve an issue or know more about a process. FAQs can be categorized separately, for e.g. some questions can be related to payment, some could be related to purchase, shipping, navigating, etc. Use this API to create an FAQ category.
59
74
  */
60
- updateAnnouncement({ announcementId, body }?: {
61
- announcementId: string;
62
- body: AdminAnnouncementSchema;
63
- }): Promise<any>;
75
+ createFaqCategory({ body }?: {
76
+ body: CreateFaqCategoryRequestSchema;
77
+ }): Promise<CreateFaqCategorySchema>;
64
78
  /**
65
79
  * @param {Object} arg - Arg object.
66
- * @param {string} arg.announcementId - ID allotted to the announcement.
67
- * @param {ScheduleSchema} arg.body
68
- * @summary: Update the schedule and the publish status of an announcement
69
- * @description: Use this API to edit the duration, i.e. start date-time and end date-time of an announcement. Moreover, you can enable/disable an announcement using this API.
80
+ * @param {LandingPageSchema} arg.body
81
+ * @returns {Promise<LandingPageSchema>} - Success response
82
+ * @summary: Create a landing page
83
+ * @description: Landing page is the first page that a prospect lands upon while visiting a website. Use this API to create a landing page.
70
84
  */
71
- updateAnnouncementSchedule({ announcementId, body }?: {
72
- announcementId: string;
73
- body: ScheduleSchema;
74
- }): Promise<any>;
85
+ createLandingPage({ body }?: {
86
+ body: LandingPageSchema;
87
+ }): Promise<LandingPageSchema>;
88
+ /**
89
+ * @param {Object} arg - Arg object.
90
+ * @param {NavigationRequest} arg.body
91
+ * @returns {Promise<NavigationSchema>} - Success response
92
+ * @summary: Create a navigation
93
+ * @description: Navigation is the arrangement of navigational items to ease the accessibility of resources for users on a website. Use this API to create a navigation.
94
+ */
95
+ createNavigation({ body }?: {
96
+ body: NavigationRequest;
97
+ }): Promise<NavigationSchema>;
98
+ /**
99
+ * @param {Object} arg - Arg object.
100
+ * @param {PageRequest} arg.body
101
+ * @returns {Promise<PageSchema>} - Success response
102
+ * @summary: Create a page
103
+ * @description: Use this API to create a custom page using a title, seo, publish status, feature image, tags, meta, etc.
104
+ */
105
+ createPage({ body }?: {
106
+ body: PageRequest;
107
+ }): Promise<PageSchema>;
108
+ /**
109
+ * @param {Object} arg - Arg object.
110
+ * @param {PageRequest} arg.body
111
+ * @returns {Promise<PageSchema>} - Success response
112
+ * @summary: Create a page preview
113
+ * @description: Use this API to create a page preview to check the appearance of a custom page.
114
+ */
115
+ createPagePreview({ body }?: {
116
+ body: PageRequest;
117
+ }): Promise<PageSchema>;
118
+ /**
119
+ * @param {Object} arg - Arg object.
120
+ * @param {SlideshowRequest} arg.body
121
+ * @returns {Promise<SlideshowSchema>} - Success response
122
+ * @summary: Create a slideshow
123
+ * @description: A slideshow is a group of images, videos or a combination of both that are shown on the website in the form of slides. Use this API to create a slideshow.
124
+ */
125
+ createSlideshow({ body }?: {
126
+ body: SlideshowRequest;
127
+ }): Promise<SlideshowSchema>;
128
+ /**
129
+ * @param {Object} arg - Arg object.
130
+ * @returns {Promise<TagsSchema>} - Success response
131
+ * @summary: Delete tags in application
132
+ * @description: Use this API to delete all the existing tags at once.
133
+ */
134
+ deleteAllInjectableTags({}?: any): Promise<TagsSchema>;
75
135
  /**
76
136
  * @param {Object} arg - Arg object.
77
137
  * @param {string} arg.announcementId - ID allotted to the announcement.
138
+ * @returns {Promise<CreateAnnouncementSchema>} - Success response
78
139
  * @summary: Delete announcement by id
79
140
  * @description: Use this API to delete an existing announcement.
80
141
  */
81
142
  deleteAnnouncement({ announcementId }?: {
82
143
  announcementId: string;
83
- }): Promise<any>;
144
+ }): Promise<CreateAnnouncementSchema>;
84
145
  /**
85
146
  * @param {Object} arg - Arg object.
86
- * @param {BlogRequest} arg.body
87
- * @summary: Create a blog
88
- * @description: Use this API to create a blog.
147
+ * @param {string} arg.id - ID allotted to the blog.
148
+ * @returns {Promise<BlogSchema>} - Success response
149
+ * @summary: Delete blogs
150
+ * @description: Use this API to delete a blog.
89
151
  */
90
- createBlog({ body }?: {
91
- body: BlogRequest;
152
+ deleteBlog({ id }?: {
153
+ id: string;
154
+ }): Promise<BlogSchema>;
155
+ /**
156
+ * @param {Object} arg - Arg object.
157
+ * @param {string} arg.dataLoaderId - ID allotted to the data loader.
158
+ * @returns {Promise<DataLoaderResponseSchema>} - Success response
159
+ * @summary: Delete data loader in application
160
+ * @description: Use this API to delete data loader.
161
+ */
162
+ deleteDataLoader({ dataLoaderId }?: {
163
+ dataLoaderId: string;
164
+ }): Promise<DataLoaderResponseSchema>;
165
+ /**
166
+ * @param {Object} arg - Arg object.
167
+ * @param {string} arg.categoryId - ID allotted to an FAQ category.
168
+ * @param {string} arg.faqId - ID allotted to an FAQ.
169
+ * @returns {Promise<CreateFaqResponseSchema>} - Success response
170
+ * @summary: Delete an FAQ
171
+ * @description: Use this API to delete an existing FAQ.
172
+ */
173
+ deleteFaq({ categoryId, faqId }?: {
174
+ categoryId: string;
175
+ faqId: string;
176
+ }): Promise<CreateFaqResponseSchema>;
177
+ /**
178
+ * @param {Object} arg - Arg object.
179
+ * @param {string} arg.id - ID allotted to an FAQ category.
180
+ * @returns {Promise<FaqSchema>} - Success response
181
+ * @summary: Delete an FAQ category
182
+ * @description: Use this API to delete an FAQ category.
183
+ */
184
+ deleteFaqCategory({ id }?: {
185
+ id: string;
186
+ }): Promise<FaqSchema>;
187
+ /**
188
+ * @param {Object} arg - Arg object.
189
+ * @param {string} arg.id - ID allotted to a landing page.
190
+ * @returns {Promise<LandingPageSchema>} - Success response
191
+ * @summary: Delete a landing page
192
+ * @description: Use this API to delete an existing landing page.
193
+ */
194
+ deleteLandingPage({ id }?: {
195
+ id: string;
196
+ }): Promise<LandingPageSchema>;
197
+ /**
198
+ * @param {Object} arg - Arg object.
199
+ * @param {string} arg.id - ID allotted to the navigation.
200
+ * @returns {Promise<NavigationSchema>} - Success response
201
+ * @summary: Delete a navigation
202
+ * @description: Use this API to delete an existing navigation.
203
+ */
204
+ deleteNavigation({ id }?: {
205
+ id: string;
206
+ }): Promise<NavigationSchema>;
207
+ /**
208
+ * @param {Object} arg - Arg object.
209
+ * @param {string} arg.id - ID allotted to the page.
210
+ * @returns {Promise<PageSchema>} - Success response
211
+ * @summary: Delete a page
212
+ * @description: Use this API to delete an existing page.
213
+ */
214
+ deletePage({ id }?: {
215
+ id: string;
216
+ }): Promise<PageSchema>;
217
+ /**
218
+ * @param {Object} arg - Arg object.
219
+ * @param {string} arg.pathId - ID allotted to the path redirection rule.
220
+ * @returns {Promise<Object>} - Success response
221
+ * @summary: Delete path based redirection rules
222
+ * @description: Use this API to delete redirection rules
223
+ */
224
+ deletePathRedirectionRules({ pathId }?: {
225
+ pathId: string;
92
226
  }): Promise<any>;
227
+ /**
228
+ * @param {Object} arg - Arg object.
229
+ * @param {string} arg.id - ID allotted to the slideshow.
230
+ * @returns {Promise<SlideshowSchema>} - Success response
231
+ * @summary: Delete a slideshow
232
+ * @description: Use this API to delete an existing slideshow.
233
+ */
234
+ deleteSlideshow({ id }?: {
235
+ id: string;
236
+ }): Promise<SlideshowSchema>;
237
+ /**
238
+ * @param {Object} arg - Arg object.
239
+ * @param {string} arg.dataLoaderId - ID allotted to the data loader.
240
+ * @param {DataLoaderSchema} arg.body
241
+ * @returns {Promise<DataLoaderResponseSchema>} - Success response
242
+ * @summary: Edit a data loader by id
243
+ * @description: Use this API to edit the details of an existing data loader by its ID.
244
+ */
245
+ editDataLoader({ dataLoaderId, body }?: {
246
+ dataLoaderId: string;
247
+ body: DataLoaderSchema;
248
+ }): Promise<DataLoaderResponseSchema>;
249
+ /**
250
+ * @param {Object} arg - Arg object.
251
+ * @param {string} arg.tagId - ID allotted to the tag.
252
+ * @param {UpdateHandpickedSchema} arg.body
253
+ * @returns {Promise<TagsSchema>} - Success response
254
+ * @summary: Edit a tag by id
255
+ * @description: Use this API to edit the details of an existing tag by its ID.
256
+ */
257
+ editInjectableTag({ tagId, body }?: {
258
+ tagId: string;
259
+ body: UpdateHandpickedSchema;
260
+ }): Promise<TagsSchema>;
261
+ /**
262
+ * @param {Object} arg - Arg object.
263
+ * @param {GenerationEntityType} arg.type - String representing the type of
264
+ * SEO content to be generated. Possible values are: title, description
265
+ * @param {GenerateSEOContent} arg.body
266
+ * @returns {Promise<GeneratedSEOContent>} - Success response
267
+ * @summary: Get SEO meta tag title for content
268
+ * @description: Use this API to get GPT3 generated SEO meta tag title for content
269
+ */
270
+ generateSEOTitle({ type, body }?: {
271
+ type: GenerationEntityType;
272
+ body: GenerateSEOContent;
273
+ }): Promise<GeneratedSEOContent>;
274
+ /**
275
+ * @param {Object} arg - Arg object.
276
+ * @param {string} arg.announcementId - ID allotted to the announcement.
277
+ * @returns {Promise<AdminAnnouncementSchema>} - Success response
278
+ * @summary: Get announcement by ID
279
+ * @description: Use this API to retrieve an announcement and its details such as the target platform and pages on which it's applicable
280
+ */
281
+ getAnnouncementById({ announcementId }?: {
282
+ announcementId: string;
283
+ }): Promise<AdminAnnouncementSchema>;
93
284
  /**
94
285
  * @param {Object} arg - Arg object.
95
286
  * @param {number} [arg.pageNo] - The page number to navigate through the
96
287
  * given set of results. Default value is 1.
97
288
  * @param {number} [arg.pageSize] - The number of items to retrieve in each
98
289
  * page. Default value is 10.
99
- * @summary: Get blogs
100
- * @description: Use this API to get a list of blogs along with their details, such as the title, reading time, publish status, feature image, tags, author, etc.
290
+ * @returns {Promise<GetAnnouncementListSchema>} - Success response
291
+ * @summary: Get a list of announcements
292
+ * @description: Announcements are useful to highlight a message or information on top of a webpage. Use this API to retrieve a list of announcements.
101
293
  */
102
- getBlogs({ pageNo, pageSize }?: {
294
+ getAnnouncementsList({ pageNo, pageSize }?: {
103
295
  pageNo?: number;
104
296
  pageSize?: number;
105
- }): Promise<any>;
297
+ }): Promise<GetAnnouncementListSchema>;
106
298
  /**
107
299
  * @param {Object} arg - Arg object.
108
300
  * @param {string} arg.companyId - Numeric ID allotted to a business account
@@ -111,218 +303,136 @@ declare class Content {
111
303
  * created within a business account.
112
304
  * @param {number} [arg.pageSize] - The number of items to retrieve in each
113
305
  * page. Default value is 10.
114
- * @summary: Get blogs
115
- * @description: Use this API to get a list of blogs along with their details, such as the title, reading time, publish status, feature image, tags, author, etc.
306
+ * @summary: Get a list of announcements
307
+ * @description: Announcements are useful to highlight a message or information on top of a webpage. Use this API to retrieve a list of announcements.
116
308
  */
117
- getBlogsPaginator({ companyId, applicationId, pageSize }?: {
309
+ getAnnouncementsListPaginator({ companyId, applicationId, pageSize }?: {
118
310
  companyId: string;
119
311
  applicationId: string;
120
312
  pageSize?: number;
121
313
  }): Paginator;
122
314
  /**
123
315
  * @param {Object} arg - Arg object.
124
- * @param {string} arg.id - ID allotted to the blog.
125
- * @param {BlogRequest} arg.body
126
- * @summary: Update a blog
127
- * @description: Use this API to update the details of an existing blog which includes title, feature image, content, SEO details, expiry, etc.
316
+ * @param {number} [arg.pageNo] - The page number to navigate through the
317
+ * given set of results. Default value is 1.
318
+ * @param {number} [arg.pageSize] - The number of items to retrieve in each
319
+ * page. Default value is 10.
320
+ * @returns {Promise<BlogGetResponse>} - Success response
321
+ * @summary: Get blogs
322
+ * @description: Use this API to get a list of blogs along with their details, such as the title, reading time, publish status, feature image, tags, author, etc.
128
323
  */
129
- updateBlog({ id, body }?: {
130
- id: string;
131
- body: BlogRequest;
132
- }): Promise<any>;
324
+ getBlogs({ pageNo, pageSize }?: {
325
+ pageNo?: number;
326
+ pageSize?: number;
327
+ }): Promise<BlogGetResponse>;
133
328
  /**
134
329
  * @param {Object} arg - Arg object.
135
- * @param {string} arg.id - ID allotted to the blog.
136
- * @summary: Delete blogs
137
- * @description: Use this API to delete a blog.
330
+ * @param {string} arg.companyId - Numeric ID allotted to a business account
331
+ * on Fynd Platform
332
+ * @param {string} arg.applicationId - Numeric ID allotted to an application
333
+ * created within a business account.
334
+ * @param {number} [arg.pageSize] - The number of items to retrieve in each
335
+ * page. Default value is 10.
336
+ * @summary: Get blogs
337
+ * @description: Use this API to get a list of blogs along with their details, such as the title, reading time, publish status, feature image, tags, author, etc.
138
338
  */
139
- deleteBlog({ id }?: {
140
- id: string;
141
- }): Promise<any>;
339
+ getBlogsPaginator({ companyId, applicationId, pageSize }?: {
340
+ companyId: string;
341
+ applicationId: string;
342
+ pageSize?: number;
343
+ }): Paginator;
142
344
  /**
143
345
  * @param {Object} arg - Arg object.
144
346
  * @param {string} arg.slug - A short, human-readable, URL-friendly
145
347
  * identifier of a blog page. You can get slug value of a blog from `getBlogs` API.
348
+ * @returns {Promise<BlogSchema>} - Success response
146
349
  * @summary: Get components of a blog
147
350
  * @description: Use this API to retrieve the components of a blog, such as title, slug, feature image, content, schedule, publish status, author, etc.
148
351
  */
149
352
  getComponentById({ slug }?: {
150
353
  slug: string;
151
- }): Promise<any>;
152
- /**
153
- * @param {Object} arg - Arg object.
154
- * @param {DataLoaderSchema} arg.body
155
- * @summary: Adds a data loader
156
- * @description: Use this API to add data loader. This includes the data loader name, operationId, service name and its type (url/function) with corresponding value.
157
- */
158
- addDataLoader({ body }?: {
159
- body: DataLoaderSchema;
160
- }): Promise<any>;
354
+ }): Promise<BlogSchema>;
161
355
  /**
162
356
  * @param {Object} arg - Arg object.
357
+ * @returns {Promise<DataLoadersSchema>} - Success response
163
358
  * @summary: Get all the data loaders in an application
164
359
  * @description: Use this to get all data loaders of an application
165
360
  */
166
- getDataLoaders({}?: any): Promise<any>;
167
- /**
168
- * @param {Object} arg - Arg object.
169
- * @param {string} arg.dataLoaderId - ID allotted to the data loader.
170
- * @summary: Delete data loader in application
171
- * @description: Use this API to delete data loader.
172
- */
173
- deleteDataLoader({ dataLoaderId }?: {
174
- dataLoaderId: string;
175
- }): Promise<any>;
361
+ getDataLoaders({}?: any): Promise<DataLoadersSchema>;
176
362
  /**
177
363
  * @param {Object} arg - Arg object.
178
- * @param {string} arg.dataLoaderId - ID allotted to the data loader.
179
- * @param {DataLoaderSchema} arg.body
180
- * @summary: Edit a data loader by id
181
- * @description: Use this API to edit the details of an existing data loader by its ID.
182
- */
183
- editDataLoader({ dataLoaderId, body }?: {
184
- dataLoaderId: string;
185
- body: DataLoaderSchema;
186
- }): Promise<any>;
187
- /**
188
- * @param {Object} arg - Arg object.
189
- * @param {string} arg.dataLoaderId - ID allotted to the data loader.
190
- * @summary: Select a data loader by id
191
- * @description: Use this API to select a data loader to be used in applications.
364
+ * @returns {Promise<DefaultNavigationResponse>} - Success response
365
+ * @summary: Get default navigations
366
+ * @description: On any website (application), there are navigations that are present by default. Use this API to retrieve those default navigations.
192
367
  */
193
- selectDataLoader({ dataLoaderId }?: {
194
- dataLoaderId: string;
195
- }): Promise<any>;
368
+ getDefaultNavigations({}?: any): Promise<DefaultNavigationResponse>;
196
369
  /**
197
370
  * @param {Object} arg - Arg object.
198
- * @param {string} arg.service - Name of service.
199
- * @param {string} arg.operationId - Name of operation id of the service.
200
- * @summary: Reset a data loader by serive name and operation Id
201
- * @description: Use this API to reselect a data loader.
371
+ * @param {string} arg.idOrSlug - ID or the slug allotted to an FAQ
372
+ * category. Slug is a short, human-readable, URL-friendly identifier of
373
+ * an object. You can get slug value of an FAQ category from
374
+ * `getFaqCategories` API.
375
+ * @returns {Promise<CreateFaqResponseSchema>} - Success response
376
+ * @summary: Get an FAQ
377
+ * @description: Use this API to retrieve a specific FAQ. You will get the question and answer of that FAQ.
202
378
  */
203
- resetDataLoader({ service, operationId }?: {
204
- service: string;
205
- operationId: string;
206
- }): Promise<any>;
379
+ getFaqByIdOrSlug({ idOrSlug }?: {
380
+ idOrSlug: string;
381
+ }): Promise<CreateFaqResponseSchema>;
207
382
  /**
208
383
  * @param {Object} arg - Arg object.
384
+ * @returns {Promise<GetFaqCategoriesSchema>} - Success response
209
385
  * @summary: Get a list of FAQ categories
210
386
  * @description: FAQs can be divided into categories. Use this API to get a list of FAQ categories.
211
387
  */
212
- getFaqCategories({}?: any): Promise<any>;
388
+ getFaqCategories({}?: any): Promise<GetFaqCategoriesSchema>;
213
389
  /**
214
390
  * @param {Object} arg - Arg object.
215
391
  * @param {string} arg.idOrSlug - ID or the slug allotted to an FAQ
216
392
  * category. Slug is a short, human-readable, URL-friendly identifier of
217
393
  * an object. You can get slug value of an FAQ category from
218
394
  * `getFaqCategories` API.
395
+ * @returns {Promise<GetFaqCategoryBySlugSchema>} - Success response
219
396
  * @summary: Get an FAQ category by slug or id
220
397
  * @description: FAQs can be divided into categories. Use this API to get an FAQ categories using its slug or ID.
221
398
  */
222
399
  getFaqCategoryBySlugOrId({ idOrSlug }?: {
223
400
  idOrSlug: string;
224
- }): Promise<any>;
225
- /**
226
- * @param {Object} arg - Arg object.
227
- * @param {CreateFaqCategoryRequestSchema} arg.body
228
- * @summary: Create an FAQ category
229
- * @description: FAQs help users to solve an issue or know more about a process. FAQs can be categorized separately, for e.g. some questions can be related to payment, some could be related to purchase, shipping, navigating, etc. Use this API to create an FAQ category.
230
- */
231
- createFaqCategory({ body }?: {
232
- body: CreateFaqCategoryRequestSchema;
233
- }): Promise<any>;
234
- /**
235
- * @param {Object} arg - Arg object.
236
- * @param {string} arg.id - ID allotted to an FAQ category.
237
- * @param {UpdateFaqCategoryRequestSchema} arg.body
238
- * @summary: Update an FAQ category
239
- * @description: Use this API to edit an existing FAQ category.
240
- */
241
- updateFaqCategory({ id, body }?: {
242
- id: string;
243
- body: UpdateFaqCategoryRequestSchema;
244
- }): Promise<any>;
245
- /**
246
- * @param {Object} arg - Arg object.
247
- * @param {string} arg.id - ID allotted to an FAQ category.
248
- * @summary: Delete an FAQ category
249
- * @description: Use this API to delete an FAQ category.
250
- */
251
- deleteFaqCategory({ id }?: {
252
- id: string;
253
- }): Promise<any>;
401
+ }): Promise<GetFaqCategoryBySlugSchema>;
254
402
  /**
255
403
  * @param {Object} arg - Arg object.
256
404
  * @param {string} arg.idOrSlug - ID or the slug allotted to an FAQ
257
405
  * category. Slug is a short, human-readable, URL-friendly identifier of
258
406
  * an object. You can get slug value of an FAQ category from
259
407
  * `getFaqCategories` API.
408
+ * @returns {Promise<GetFaqSchema>} - Success response
260
409
  * @summary: Get question and answers within an FAQ category
261
410
  * @description: Use this API to retrieve all the commonly asked question and answers belonging to an FAQ category.
262
411
  */
263
412
  getFaqsByCategoryIdOrSlug({ idOrSlug }?: {
264
413
  idOrSlug: string;
265
- }): Promise<any>;
266
- /**
267
- * @param {Object} arg - Arg object.
268
- * @param {string} arg.categoryId - ID allotted to an FAQ category.
269
- * @param {CreateFaqSchema} arg.body
270
- * @summary: Create an FAQ
271
- * @description: FAQs help users to solve an issue or know more about a process. Use this API to create an FAQ for a given FAQ category.
272
- */
273
- addFaq({ categoryId, body }?: {
274
- categoryId: string;
275
- body: CreateFaqSchema;
276
- }): Promise<any>;
277
- /**
278
- * @param {Object} arg - Arg object.
279
- * @param {string} arg.categoryId - ID allotted to an FAQ category.
280
- * @param {string} arg.faqId - ID allotted to an FAQ.
281
- * @param {CreateFaqSchema} arg.body
282
- * @summary: Update an FAQ
283
- * @description: Use this API to edit an existing FAQ.
284
- */
285
- updateFaq({ categoryId, faqId, body }?: {
286
- categoryId: string;
287
- faqId: string;
288
- body: CreateFaqSchema;
289
- }): Promise<any>;
290
- /**
291
- * @param {Object} arg - Arg object.
292
- * @param {string} arg.categoryId - ID allotted to an FAQ category.
293
- * @param {string} arg.faqId - ID allotted to an FAQ.
294
- * @summary: Delete an FAQ
295
- * @description: Use this API to delete an existing FAQ.
296
- */
297
- deleteFaq({ categoryId, faqId }?: {
298
- categoryId: string;
299
- faqId: string;
300
- }): Promise<any>;
414
+ }): Promise<GetFaqSchema>;
301
415
  /**
302
416
  * @param {Object} arg - Arg object.
303
- * @param {string} arg.idOrSlug - ID or the slug allotted to an FAQ
304
- * category. Slug is a short, human-readable, URL-friendly identifier of
305
- * an object. You can get slug value of an FAQ category from
306
- * `getFaqCategories` API.
307
- * @summary: Get an FAQ
308
- * @description: Use this API to retrieve a specific FAQ. You will get the question and answer of that FAQ.
417
+ * @returns {Promise<TagsSchema>} - Success response
418
+ * @summary: Get all the tags in an application
419
+ * @description: Use this API to get all the CSS and JS injected in the application in the form of tags.
309
420
  */
310
- getFaqByIdOrSlug({ idOrSlug }?: {
311
- idOrSlug: string;
312
- }): Promise<any>;
421
+ getInjectableTags({}?: any): Promise<TagsSchema>;
313
422
  /**
314
423
  * @param {Object} arg - Arg object.
315
424
  * @param {number} [arg.pageNo] - The page number to navigate through the
316
425
  * given set of results. Default value is 1.
317
426
  * @param {number} [arg.pageSize] - The number of items to retrieve in each
318
427
  * page. Default value is 10.
428
+ * @returns {Promise<LandingPageGetResponse>} - Success response
319
429
  * @summary: Get landing pages
320
430
  * @description: Landing page is the first page that a prospect lands upon while visiting a website. Use this API to fetch a list of landing pages.
321
431
  */
322
432
  getLandingPages({ pageNo, pageSize }?: {
323
433
  pageNo?: number;
324
434
  pageSize?: number;
325
- }): Promise<any>;
435
+ }): Promise<LandingPageGetResponse>;
326
436
  /**
327
437
  * @param {Object} arg - Arg object.
328
438
  * @param {string} arg.companyId - Numeric ID allotted to a business account
@@ -341,48 +451,26 @@ declare class Content {
341
451
  }): Paginator;
342
452
  /**
343
453
  * @param {Object} arg - Arg object.
344
- * @param {LandingPageSchema} arg.body
345
- * @summary: Create a landing page
346
- * @description: Landing page is the first page that a prospect lands upon while visiting a website. Use this API to create a landing page.
347
- */
348
- createLandingPage({ body }?: {
349
- body: LandingPageSchema;
350
- }): Promise<any>;
351
- /**
352
- * @param {Object} arg - Arg object.
353
- * @param {string} arg.id - ID allotted to a landing page.
354
- * @param {LandingPageSchema} arg.body
355
- * @summary: Update a landing page
356
- * @description: Use this API to edit the details of an existing landing page.
357
- */
358
- updateLandingPage({ id, body }?: {
359
- id: string;
360
- body: LandingPageSchema;
361
- }): Promise<any>;
362
- /**
363
- * @param {Object} arg - Arg object.
364
- * @param {string} arg.id - ID allotted to a landing page.
365
- * @summary: Delete a landing page
366
- * @description: Use this API to delete an existing landing page.
367
- */
368
- deleteLandingPage({ id }?: {
369
- id: string;
370
- }): Promise<any>;
371
- /**
372
- * @param {Object} arg - Arg object.
454
+ * @returns {Promise<ApplicationLegal>} - Success response
373
455
  * @summary: Get legal information
374
456
  * @description: Use this API to get the legal information of an application, which includes Policy, Terms and Conditions, Shipping Policy and FAQ regarding the application.
375
457
  */
376
- getLegalInformation({}?: any): Promise<any>;
458
+ getLegalInformation({}?: any): Promise<ApplicationLegal>;
377
459
  /**
378
460
  * @param {Object} arg - Arg object.
379
- * @param {ApplicationLegal} arg.body
380
- * @summary: Save legal information
381
- * @description: Use this API to edit, update and save the legal information of an application, which includes Policy, Terms and Conditions, Shipping Policy and FAQ regarding the application.
461
+ * @param {string} arg.slug - A short, human-readable, URL-friendly
462
+ * identifier of a navigation. You can get slug value of a navigation from
463
+ * `getNavigations` API.
464
+ * @param {string} arg.devicePlatform - Filter navigations by platform.
465
+ * Acceptable values are: web, android, ios, all
466
+ * @returns {Promise<NavigationSchema>} - Success response
467
+ * @summary: Get a navigation by slug
468
+ * @description: Use this API to retrieve a navigation by its slug.
382
469
  */
383
- updateLegalInformation({ body }?: {
384
- body: ApplicationLegal;
385
- }): Promise<any>;
470
+ getNavigationBySlug({ slug, devicePlatform }?: {
471
+ slug: string;
472
+ devicePlatform: string;
473
+ }): Promise<NavigationSchema>;
386
474
  /**
387
475
  * @param {Object} arg - Arg object.
388
476
  * @param {string} arg.devicePlatform - Filter navigations by platform.
@@ -391,6 +479,7 @@ declare class Content {
391
479
  * given set of results. Default value is 1.
392
480
  * @param {number} [arg.pageSize] - The number of items to retrieve in each
393
481
  * page. Default value is 10.
482
+ * @returns {Promise<NavigationGetResponse>} - Success response
394
483
  * @summary: Get navigations
395
484
  * @description: Use this API to fetch the navigations details which includes the items of the navigation pane. It also shows the orientation, links, sub-navigations, etc.
396
485
  */
@@ -398,7 +487,7 @@ declare class Content {
398
487
  devicePlatform: string;
399
488
  pageNo?: number;
400
489
  pageSize?: number;
401
- }): Promise<any>;
490
+ }): Promise<NavigationGetResponse>;
402
491
  /**
403
492
  * @param {Object} arg - Arg object.
404
493
  * @param {string} arg.companyId - Numeric ID allotted to a business account
@@ -418,163 +507,107 @@ declare class Content {
418
507
  devicePlatform: string;
419
508
  pageSize?: number;
420
509
  }): Paginator;
421
- /**
422
- * @param {Object} arg - Arg object.
423
- * @param {NavigationRequest} arg.body
424
- * @summary: Create a navigation
425
- * @description: Navigation is the arrangement of navigational items to ease the accessibility of resources for users on a website. Use this API to create a navigation.
426
- */
427
- createNavigation({ body }?: {
428
- body: NavigationRequest;
429
- }): Promise<any>;
430
- /**
431
- * @param {Object} arg - Arg object.
432
- * @summary: Get default navigations
433
- * @description: On any website (application), there are navigations that are present by default. Use this API to retrieve those default navigations.
434
- */
435
- getDefaultNavigations({}?: any): Promise<any>;
436
510
  /**
437
511
  * @param {Object} arg - Arg object.
438
512
  * @param {string} arg.slug - A short, human-readable, URL-friendly
439
- * identifier of a navigation. You can get slug value of a navigation from
440
- * `getNavigations` API.
441
- * @param {string} arg.devicePlatform - Filter navigations by platform.
442
- * Acceptable values are: web, android, ios, all
443
- * @summary: Get a navigation by slug
444
- * @description: Use this API to retrieve a navigation by its slug.
513
+ * identifier of a page. You can get slug value of a page from `getPages` API.
514
+ * @returns {Promise<PageSchema>} - Success response
515
+ * @summary: Get pages by component Id
516
+ * @description: Use this API to retrieve the components of a page, such as its title, seo, publish status, feature image, tags, schedule, etc.
445
517
  */
446
- getNavigationBySlug({ slug, devicePlatform }?: {
518
+ getPageBySlug({ slug }?: {
447
519
  slug: string;
448
- devicePlatform: string;
449
- }): Promise<any>;
450
- /**
451
- * @param {Object} arg - Arg object.
452
- * @param {string} arg.id - ID allotted to the navigation.
453
- * @param {NavigationRequest} arg.body
454
- * @summary: Update a navigation
455
- * @description: Use this API to edit the details of an existing navigation.
456
- */
457
- updateNavigation({ id, body }?: {
458
- id: string;
459
- body: NavigationRequest;
460
- }): Promise<any>;
461
- /**
462
- * @param {Object} arg - Arg object.
463
- * @param {string} arg.id - ID allotted to the navigation.
464
- * @summary: Delete a navigation
465
- * @description: Use this API to delete an existing navigation.
466
- */
467
- deleteNavigation({ id }?: {
468
- id: string;
469
- }): Promise<any>;
520
+ }): Promise<PageSchema>;
470
521
  /**
471
522
  * @param {Object} arg - Arg object.
523
+ * @returns {Promise<PageMetaSchema>} - Success response
472
524
  * @summary: Get page meta
473
525
  * @description: Use this API to get the meta of custom pages (blog, page) and default system pages (e.g. home/brand/category/collection).
474
526
  */
475
- getPageMeta({}?: any): Promise<any>;
527
+ getPageMeta({}?: any): Promise<PageMetaSchema>;
476
528
  /**
477
529
  * @param {Object} arg - Arg object.
530
+ * @returns {Promise<PageSpec>} - Success response
478
531
  * @summary: Get page spec
479
532
  * @description: Use this API to get the specifications of a page, such as page type, display name, params and query.
480
533
  */
481
- getPageSpec({}?: any): Promise<any>;
482
- /**
483
- * @param {Object} arg - Arg object.
484
- * @param {PageRequest} arg.body
485
- * @summary: Create a page preview
486
- * @description: Use this API to create a page preview to check the appearance of a custom page.
487
- */
488
- createPagePreview({ body }?: {
489
- body: PageRequest;
490
- }): Promise<any>;
491
- /**
492
- * @param {Object} arg - Arg object.
493
- * @param {string} arg.slug - A short, human-readable, URL-friendly
494
- * identifier of a page. You can get slug value of a page from `getPages` API.
495
- * @param {PagePublishRequest} arg.body
496
- * @summary: Change the publish status of a page
497
- * @description: Use this API to change the publish status of an existing page. Allows you to publish and unpublish the page.
498
- */
499
- updatePagePreview({ slug, body }?: {
500
- slug: string;
501
- body: PagePublishRequest;
502
- }): Promise<any>;
503
- /**
504
- * @param {Object} arg - Arg object.
505
- * @param {string} arg.id - ID allotted to the page.
506
- * @summary: Delete a page
507
- * @description: Use this API to delete an existing page.
508
- */
509
- deletePage({ id }?: {
510
- id: string;
511
- }): Promise<any>;
534
+ getPageSpec({}?: any): Promise<PageSpec>;
512
535
  /**
513
536
  * @param {Object} arg - Arg object.
514
- * @param {PathMappingSchema} arg.body
515
- * @summary: Save path based redirection rules
516
- * @description: Use this API to add redirection rules
537
+ * @param {number} [arg.pageNo] - The page number to navigate through the
538
+ * given set of results. Default value is 1.
539
+ * @param {number} [arg.pageSize] - The number of items to retrieve in each
540
+ * page. Default value is 10.
541
+ * @returns {Promise<PageGetResponse>} - Success response
542
+ * @summary: Get a list of pages
543
+ * @description: Use this API to retrieve a list of pages.
517
544
  */
518
- addPathRedirectionRules({ body }?: {
519
- body: PathMappingSchema;
520
- }): Promise<any>;
545
+ getPages({ pageNo, pageSize }?: {
546
+ pageNo?: number;
547
+ pageSize?: number;
548
+ }): Promise<PageGetResponse>;
521
549
  /**
522
550
  * @param {Object} arg - Arg object.
551
+ * @param {string} arg.companyId - Numeric ID allotted to a business account
552
+ * on Fynd Platform
553
+ * @param {string} arg.applicationId - Numeric ID allotted to an application
554
+ * created within a business account.
523
555
  * @param {number} [arg.pageSize] - The number of items to retrieve in each
524
- * page. Default value is 5.
525
- * @param {number} [arg.pageNo] - The page number to navigate through the
526
- * given set of results. Default value is 1.
527
- * @summary: Get path based redirection rules
528
- * @description: Use this API to get path based redirection rules.
556
+ * page. Default value is 10.
557
+ * @summary: Get a list of pages
558
+ * @description: Use this API to retrieve a list of pages.
529
559
  */
530
- getPathRedirectionRules({ pageSize, pageNo }?: {
560
+ getPagesPaginator({ companyId, applicationId, pageSize }?: {
561
+ companyId: string;
562
+ applicationId: string;
531
563
  pageSize?: number;
532
- pageNo?: number;
533
- }): Promise<any>;
564
+ }): Paginator;
534
565
  /**
535
566
  * @param {Object} arg - Arg object.
536
567
  * @param {string} arg.pathId - ID allotted to the path redirection rule.
568
+ * @returns {Promise<PathMappingSchema>} - Success response
537
569
  * @summary: Get path based redirection rule
538
570
  * @description: Use this API to get path based redirection rule.
539
571
  */
540
572
  getPathRedirectionRule({ pathId }?: {
541
573
  pathId: string;
542
- }): Promise<any>;
543
- /**
544
- * @param {Object} arg - Arg object.
545
- * @param {string} arg.pathId - ID allotted to the path redirection rule.
546
- * @param {PathMappingSchema} arg.body
547
- * @summary: Update path based redirection rules
548
- * @description: Use this API to update redirection rules
549
- */
550
- updatePathRedirectionRules({ pathId, body }?: {
551
- pathId: string;
552
- body: PathMappingSchema;
553
- }): Promise<any>;
554
- /**
555
- * @param {Object} arg - Arg object.
556
- * @param {string} arg.pathId - ID allotted to the path redirection rule.
557
- * @summary: Delete path based redirection rules
558
- * @description: Use this API to delete redirection rules
559
- */
560
- deletePathRedirectionRules({ pathId }?: {
561
- pathId: string;
562
- }): Promise<any>;
574
+ }): Promise<PathMappingSchema>;
575
+ /**
576
+ * @param {Object} arg - Arg object.
577
+ * @param {number} [arg.pageSize] - The number of items to retrieve in each
578
+ * page. Default value is 5.
579
+ * @param {number} [arg.pageNo] - The page number to navigate through the
580
+ * given set of results. Default value is 1.
581
+ * @returns {Promise<PathMappingSchema>} - Success response
582
+ * @summary: Get path based redirection rules
583
+ * @description: Use this API to get path based redirection rules.
584
+ */
585
+ getPathRedirectionRules({ pageSize, pageNo }?: {
586
+ pageSize?: number;
587
+ pageNo?: number;
588
+ }): Promise<PathMappingSchema>;
563
589
  /**
564
590
  * @param {Object} arg - Arg object.
591
+ * @returns {Promise<SeoComponent>} - Success response
565
592
  * @summary: Get SEO configuration of an application
566
593
  * @description: Use this API to know how the SEO is configured in the application. This includes the sitemap, robot.txt, custom meta tags, etc.
567
594
  */
568
- getSEOConfiguration({}?: any): Promise<any>;
595
+ getSEOConfiguration({}?: any): Promise<SeoComponent>;
569
596
  /**
570
597
  * @param {Object} arg - Arg object.
571
- * @param {SeoComponent} arg.body
572
- * @summary: Update SEO of application
573
- * @description: Use this API to edit the SEO details of an application. This includes the sitemap, robot.txt, custom meta tags, etc.
598
+ * @param {string} arg.slug - A short, human-readable, URL-friendly
599
+ * identifier of a slideshow. You can get slug value of a page from
600
+ * `getSlideshows` API.
601
+ * @param {string} arg.devicePlatform - Filter slideshows by platform.
602
+ * Acceptable values are: web, android, ios and all
603
+ * @returns {Promise<SlideshowSchema>} - Success response
604
+ * @summary: Get slideshow by slug
605
+ * @description: Use this API to retrieve the details of a slideshow by its slug.
574
606
  */
575
- updateSEOConfiguration({ body }?: {
576
- body: SeoComponent;
577
- }): Promise<any>;
607
+ getSlideshowBySlug({ slug, devicePlatform }?: {
608
+ slug: string;
609
+ devicePlatform: string;
610
+ }): Promise<SlideshowSchema>;
578
611
  /**
579
612
  * @param {Object} arg - Arg object.
580
613
  * @param {string} arg.devicePlatform - Filter slideshows by platform.
@@ -583,6 +616,7 @@ declare class Content {
583
616
  * given set of results. Default value is 1.
584
617
  * @param {number} [arg.pageSize] - The number of items to retrieve in each
585
618
  * page. Default value is 10.
619
+ * @returns {Promise<SlideshowGetResponse>} - Success response
586
620
  * @summary: Get slideshows
587
621
  * @description: A slideshow is a group of images, videos or a combination of both that are shown on the website in the form of slides. Use this API to fetch a list of slideshows.
588
622
  */
@@ -590,7 +624,7 @@ declare class Content {
590
624
  devicePlatform: string;
591
625
  pageNo?: number;
592
626
  pageSize?: number;
593
- }): Promise<any>;
627
+ }): Promise<SlideshowGetResponse>;
594
628
  /**
595
629
  * @param {Object} arg - Arg object.
596
630
  * @param {string} arg.companyId - Numeric ID allotted to a business account
@@ -612,170 +646,217 @@ declare class Content {
612
646
  }): Paginator;
613
647
  /**
614
648
  * @param {Object} arg - Arg object.
615
- * @param {SlideshowRequest} arg.body
616
- * @summary: Create a slideshow
617
- * @description: A slideshow is a group of images, videos or a combination of both that are shown on the website in the form of slides. Use this API to create a slideshow.
649
+ * @returns {Promise<Support>} - Success response
650
+ * @summary: Get support information
651
+ * @description: Use this API to get the contact details for customer support, including emails and phone numbers.
618
652
  */
619
- createSlideshow({ body }?: {
620
- body: SlideshowRequest;
621
- }): Promise<any>;
653
+ getSupportInformation({}?: any): Promise<Support>;
622
654
  /**
623
655
  * @param {Object} arg - Arg object.
624
- * @param {string} arg.slug - A short, human-readable, URL-friendly
625
- * identifier of a slideshow. You can get slug value of a page from
626
- * `getSlideshows` API.
627
- * @param {string} arg.devicePlatform - Filter slideshows by platform.
628
- * Acceptable values are: web, android, ios and all
629
- * @summary: Get slideshow by slug
630
- * @description: Use this API to retrieve the details of a slideshow by its slug.
656
+ * @param {RemoveHandpickedSchema} arg.body
657
+ * @returns {Promise<TagDeleteSuccessResponse>} - Success response
658
+ * @summary: Remove a tag
659
+ * @description: Use this API to delete an existing tag.
631
660
  */
632
- getSlideshowBySlug({ slug, devicePlatform }?: {
633
- slug: string;
634
- devicePlatform: string;
635
- }): Promise<any>;
661
+ removeInjectableTag({ body }?: {
662
+ body: RemoveHandpickedSchema;
663
+ }): Promise<TagDeleteSuccessResponse>;
636
664
  /**
637
665
  * @param {Object} arg - Arg object.
638
- * @param {string} arg.id - ID allotted to the slideshow.
639
- * @param {SlideshowRequest} arg.body
640
- * @summary: Update a slideshow
641
- * @description: Use this API to edit the details of an existing slideshow.
666
+ * @param {string} arg.service - Name of service.
667
+ * @param {string} arg.operationId - Name of operation id of the service.
668
+ * @returns {Promise<DataLoaderResetResponseSchema>} - Success response
669
+ * @summary: Reset a data loader by serive name and operation Id
670
+ * @description: Use this API to reselect a data loader.
642
671
  */
643
- updateSlideshow({ id, body }?: {
644
- id: string;
645
- body: SlideshowRequest;
646
- }): Promise<any>;
672
+ resetDataLoader({ service, operationId }?: {
673
+ service: string;
674
+ operationId: string;
675
+ }): Promise<DataLoaderResetResponseSchema>;
647
676
  /**
648
677
  * @param {Object} arg - Arg object.
649
- * @param {string} arg.id - ID allotted to the slideshow.
650
- * @summary: Delete a slideshow
651
- * @description: Use this API to delete an existing slideshow.
678
+ * @param {string} arg.dataLoaderId - ID allotted to the data loader.
679
+ * @returns {Promise<DataLoaderResponseSchema>} - Success response
680
+ * @summary: Select a data loader by id
681
+ * @description: Use this API to select a data loader to be used in applications.
652
682
  */
653
- deleteSlideshow({ id }?: {
654
- id: string;
655
- }): Promise<any>;
683
+ selectDataLoader({ dataLoaderId }?: {
684
+ dataLoaderId: string;
685
+ }): Promise<DataLoaderResponseSchema>;
656
686
  /**
657
687
  * @param {Object} arg - Arg object.
658
- * @summary: Get support information
659
- * @description: Use this API to get the contact details for customer support, including emails and phone numbers.
688
+ * @param {string} arg.announcementId - ID allotted to the announcement.
689
+ * @param {AdminAnnouncementSchema} arg.body
690
+ * @returns {Promise<CreateAnnouncementSchema>} - Success response
691
+ * @summary: Update an announcement
692
+ * @description: Use this API to edit an existing announcement and its details such as the target platform and pages on which it's applicable
660
693
  */
661
- getSupportInformation({}?: any): Promise<any>;
694
+ updateAnnouncement({ announcementId, body }?: {
695
+ announcementId: string;
696
+ body: AdminAnnouncementSchema;
697
+ }): Promise<CreateAnnouncementSchema>;
662
698
  /**
663
699
  * @param {Object} arg - Arg object.
664
- * @param {Support} arg.body
665
- * @summary: Update the support data of an application
666
- * @description: Use this API to edit the existing contact details for customer support, including emails and phone numbers.
700
+ * @param {string} arg.announcementId - ID allotted to the announcement.
701
+ * @param {ScheduleSchema} arg.body
702
+ * @returns {Promise<CreateAnnouncementSchema>} - Success response
703
+ * @summary: Update the schedule and the publish status of an announcement
704
+ * @description: Use this API to edit the duration, i.e. start date-time and end date-time of an announcement. Moreover, you can enable/disable an announcement using this API.
667
705
  */
668
- updateSupportInformation({ body }?: {
669
- body: Support;
670
- }): Promise<any>;
706
+ updateAnnouncementSchedule({ announcementId, body }?: {
707
+ announcementId: string;
708
+ body: ScheduleSchema;
709
+ }): Promise<CreateAnnouncementSchema>;
671
710
  /**
672
711
  * @param {Object} arg - Arg object.
673
- * @param {CreateTagRequestSchema} arg.body
674
- * @summary: Update a tag
675
- * @description: Use this API to edit the details of an existing tag. This includes the tag name, tag type (css/js), url and position of the tag.
712
+ * @param {string} arg.id - ID allotted to the blog.
713
+ * @param {BlogRequest} arg.body
714
+ * @returns {Promise<BlogSchema>} - Success response
715
+ * @summary: Update a blog
716
+ * @description: Use this API to update the details of an existing blog which includes title, feature image, content, SEO details, expiry, etc.
676
717
  */
677
- updateInjectableTag({ body }?: {
678
- body: CreateTagRequestSchema;
679
- }): Promise<any>;
718
+ updateBlog({ id, body }?: {
719
+ id: string;
720
+ body: BlogRequest;
721
+ }): Promise<BlogSchema>;
680
722
  /**
681
723
  * @param {Object} arg - Arg object.
682
- * @summary: Delete tags in application
683
- * @description: Use this API to delete all the existing tags at once.
724
+ * @param {string} arg.categoryId - ID allotted to an FAQ category.
725
+ * @param {string} arg.faqId - ID allotted to an FAQ.
726
+ * @param {CreateFaqSchema} arg.body
727
+ * @returns {Promise<CreateFaqResponseSchema>} - Success response
728
+ * @summary: Update an FAQ
729
+ * @description: Use this API to edit an existing FAQ.
684
730
  */
685
- deleteAllInjectableTags({}?: any): Promise<any>;
731
+ updateFaq({ categoryId, faqId, body }?: {
732
+ categoryId: string;
733
+ faqId: string;
734
+ body: CreateFaqSchema;
735
+ }): Promise<CreateFaqResponseSchema>;
686
736
  /**
687
737
  * @param {Object} arg - Arg object.
688
- * @summary: Get all the tags in an application
689
- * @description: Use this API to get all the CSS and JS injected in the application in the form of tags.
738
+ * @param {string} arg.id - ID allotted to an FAQ category.
739
+ * @param {UpdateFaqCategoryRequestSchema} arg.body
740
+ * @returns {Promise<CreateFaqCategorySchema>} - Success response
741
+ * @summary: Update an FAQ category
742
+ * @description: Use this API to edit an existing FAQ category.
690
743
  */
691
- getInjectableTags({}?: any): Promise<any>;
744
+ updateFaqCategory({ id, body }?: {
745
+ id: string;
746
+ body: UpdateFaqCategoryRequestSchema;
747
+ }): Promise<CreateFaqCategorySchema>;
692
748
  /**
693
749
  * @param {Object} arg - Arg object.
694
750
  * @param {CreateTagRequestSchema} arg.body
695
- * @summary: Add a tag
696
- * @description: CSS and JS can be injected in the application (website) with the help of tags. Use this API to create such tags by entering the tag name, tag type (css/js), url and position of the tag.
751
+ * @returns {Promise<TagsSchema>} - Success response
752
+ * @summary: Update a tag
753
+ * @description: Use this API to edit the details of an existing tag. This includes the tag name, tag type (css/js), url and position of the tag.
697
754
  */
698
- addInjectableTag({ body }?: {
755
+ updateInjectableTag({ body }?: {
699
756
  body: CreateTagRequestSchema;
700
- }): Promise<any>;
701
- /**
702
- * @param {Object} arg - Arg object.
703
- * @param {RemoveHandpickedSchema} arg.body
704
- * @summary: Remove a tag
705
- * @description: Use this API to delete an existing tag.
706
- */
707
- removeInjectableTag({ body }?: {
708
- body: RemoveHandpickedSchema;
709
- }): Promise<any>;
710
- /**
711
- * @param {Object} arg - Arg object.
712
- * @param {string} arg.tagId - ID allotted to the tag.
713
- * @param {UpdateHandpickedSchema} arg.body
714
- * @summary: Edit a tag by id
715
- * @description: Use this API to edit the details of an existing tag by its ID.
716
- */
717
- editInjectableTag({ tagId, body }?: {
718
- tagId: string;
719
- body: UpdateHandpickedSchema;
720
- }): Promise<any>;
757
+ }): Promise<TagsSchema>;
721
758
  /**
722
759
  * @param {Object} arg - Arg object.
723
- * @param {PageRequest} arg.body
724
- * @summary: Create a page
725
- * @description: Use this API to create a custom page using a title, seo, publish status, feature image, tags, meta, etc.
760
+ * @param {string} arg.id - ID allotted to a landing page.
761
+ * @param {LandingPageSchema} arg.body
762
+ * @returns {Promise<LandingPageSchema>} - Success response
763
+ * @summary: Update a landing page
764
+ * @description: Use this API to edit the details of an existing landing page.
726
765
  */
727
- createPage({ body }?: {
728
- body: PageRequest;
729
- }): Promise<any>;
766
+ updateLandingPage({ id, body }?: {
767
+ id: string;
768
+ body: LandingPageSchema;
769
+ }): Promise<LandingPageSchema>;
730
770
  /**
731
771
  * @param {Object} arg - Arg object.
732
- * @param {number} [arg.pageNo] - The page number to navigate through the
733
- * given set of results. Default value is 1.
734
- * @param {number} [arg.pageSize] - The number of items to retrieve in each
735
- * page. Default value is 10.
736
- * @summary: Get a list of pages
737
- * @description: Use this API to retrieve a list of pages.
772
+ * @param {ApplicationLegal} arg.body
773
+ * @returns {Promise<ApplicationLegal>} - Success response
774
+ * @summary: Save legal information
775
+ * @description: Use this API to edit, update and save the legal information of an application, which includes Policy, Terms and Conditions, Shipping Policy and FAQ regarding the application.
738
776
  */
739
- getPages({ pageNo, pageSize }?: {
740
- pageNo?: number;
741
- pageSize?: number;
742
- }): Promise<any>;
777
+ updateLegalInformation({ body }?: {
778
+ body: ApplicationLegal;
779
+ }): Promise<ApplicationLegal>;
743
780
  /**
744
781
  * @param {Object} arg - Arg object.
745
- * @param {string} arg.companyId - Numeric ID allotted to a business account
746
- * on Fynd Platform
747
- * @param {string} arg.applicationId - Numeric ID allotted to an application
748
- * created within a business account.
749
- * @param {number} [arg.pageSize] - The number of items to retrieve in each
750
- * page. Default value is 10.
751
- * @summary: Get a list of pages
752
- * @description: Use this API to retrieve a list of pages.
782
+ * @param {string} arg.id - ID allotted to the navigation.
783
+ * @param {NavigationRequest} arg.body
784
+ * @returns {Promise<NavigationSchema>} - Success response
785
+ * @summary: Update a navigation
786
+ * @description: Use this API to edit the details of an existing navigation.
753
787
  */
754
- getPagesPaginator({ companyId, applicationId, pageSize }?: {
755
- companyId: string;
756
- applicationId: string;
757
- pageSize?: number;
758
- }): Paginator;
788
+ updateNavigation({ id, body }?: {
789
+ id: string;
790
+ body: NavigationRequest;
791
+ }): Promise<NavigationSchema>;
759
792
  /**
760
793
  * @param {Object} arg - Arg object.
761
794
  * @param {string} arg.id - ID allotted to the page.
762
795
  * @param {PageSchema} arg.body
796
+ * @returns {Promise<PageSchema>} - Success response
763
797
  * @summary: Update a page
764
798
  * @description: Use this API to edit the details of an existing page, such as its title, seo, publish status, feature image, tags, schedule, etc.
765
799
  */
766
800
  updatePage({ id, body }?: {
767
801
  id: string;
768
802
  body: PageSchema;
769
- }): Promise<any>;
803
+ }): Promise<PageSchema>;
770
804
  /**
771
805
  * @param {Object} arg - Arg object.
772
806
  * @param {string} arg.slug - A short, human-readable, URL-friendly
773
807
  * identifier of a page. You can get slug value of a page from `getPages` API.
774
- * @summary: Get pages by component Id
775
- * @description: Use this API to retrieve the components of a page, such as its title, seo, publish status, feature image, tags, schedule, etc.
808
+ * @param {PagePublishRequest} arg.body
809
+ * @returns {Promise<PageSchema>} - Success response
810
+ * @summary: Change the publish status of a page
811
+ * @description: Use this API to change the publish status of an existing page. Allows you to publish and unpublish the page.
776
812
  */
777
- getPageBySlug({ slug }?: {
813
+ updatePagePreview({ slug, body }?: {
778
814
  slug: string;
779
- }): Promise<any>;
815
+ body: PagePublishRequest;
816
+ }): Promise<PageSchema>;
817
+ /**
818
+ * @param {Object} arg - Arg object.
819
+ * @param {string} arg.pathId - ID allotted to the path redirection rule.
820
+ * @param {PathMappingSchema} arg.body
821
+ * @returns {Promise<PathMappingSchema>} - Success response
822
+ * @summary: Update path based redirection rules
823
+ * @description: Use this API to update redirection rules
824
+ */
825
+ updatePathRedirectionRules({ pathId, body }?: {
826
+ pathId: string;
827
+ body: PathMappingSchema;
828
+ }): Promise<PathMappingSchema>;
829
+ /**
830
+ * @param {Object} arg - Arg object.
831
+ * @param {SeoComponent} arg.body
832
+ * @returns {Promise<SeoSchema>} - Success response
833
+ * @summary: Update SEO of application
834
+ * @description: Use this API to edit the SEO details of an application. This includes the sitemap, robot.txt, custom meta tags, etc.
835
+ */
836
+ updateSEOConfiguration({ body }?: {
837
+ body: SeoComponent;
838
+ }): Promise<SeoSchema>;
839
+ /**
840
+ * @param {Object} arg - Arg object.
841
+ * @param {string} arg.id - ID allotted to the slideshow.
842
+ * @param {SlideshowRequest} arg.body
843
+ * @returns {Promise<SlideshowSchema>} - Success response
844
+ * @summary: Update a slideshow
845
+ * @description: Use this API to edit the details of an existing slideshow.
846
+ */
847
+ updateSlideshow({ id, body }?: {
848
+ id: string;
849
+ body: SlideshowRequest;
850
+ }): Promise<SlideshowSchema>;
851
+ /**
852
+ * @param {Object} arg - Arg object.
853
+ * @param {Support} arg.body
854
+ * @returns {Promise<Support>} - Success response
855
+ * @summary: Update the support data of an application
856
+ * @description: Use this API to edit the existing contact details for customer support, including emails and phone numbers.
857
+ */
858
+ updateSupportInformation({ body }?: {
859
+ body: Support;
860
+ }): Promise<Support>;
780
861
  }
781
862
  import Paginator = require("../../common/Paginator");