@gofynd/fdk-client-javascript 1.0.2 → 1.0.4

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