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