@gofynd/fdk-client-javascript 1.1.6 → 1.2.0

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