@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
@@ -1,16 +1,182 @@
1
- export = LeadValidator;
2
- declare class LeadValidator {
3
- static closeVideoRoom(): any;
4
- static createCustomForm(): any;
5
- static createHistory(): any;
6
- static editCustomForm(): any;
7
- static editTicket(): any;
8
- static getCustomForm(): any;
1
+ export = LeadPlatformApplicationValidator;
2
+ /**
3
+ * @typedef CloseVideoRoomParam
4
+ * @property {string} uniqueName - Unique name of Video Room
5
+ */
6
+ /**
7
+ * @typedef CreateCustomFormParam
8
+ * @property {LeadPlatformModel.CreateCustomFormPayload} body
9
+ */
10
+ /**
11
+ * @typedef CreateHistoryParam
12
+ * @property {string} id - Ticket ID for which history is created
13
+ * @property {LeadPlatformModel.TicketHistoryPayload} body
14
+ */
15
+ /**
16
+ * @typedef EditCustomFormParam
17
+ * @property {string} slug - Slug of form whose response is getting submitted
18
+ * @property {LeadPlatformModel.EditCustomFormPayload} body
19
+ */
20
+ /**
21
+ * @typedef EditTicketParam
22
+ * @property {string} id - Ticket ID of ticket to be edited
23
+ * @property {LeadPlatformModel.EditTicketPayload} body
24
+ */
25
+ /**
26
+ * @typedef GetCustomFormParam
27
+ * @property {string} slug - Slug of form whose response is getting submitted
28
+ */
29
+ /** @typedef GetCustomFormsParam */
30
+ /**
31
+ * @typedef GetTicketParam
32
+ * @property {string} id - Tiket ID of the ticket to be fetched
33
+ */
34
+ /**
35
+ * @typedef GetTicketHistoryParam
36
+ * @property {string} id - Ticket ID for which history is to be fetched
37
+ */
38
+ /**
39
+ * @typedef GetTicketsParam
40
+ * @property {boolean} [items] - Decides that the reponse will contain the list of tickets
41
+ * @property {boolean} [filters] - Decides that the reponse will contain the
42
+ * ticket filters
43
+ * @property {string} [q] - Search through ticket titles and description
44
+ * @property {string} [status] - Filter tickets on status
45
+ * @property {LeadPlatformModel.PriorityEnum} [priority] - Filter tickets on priority
46
+ * @property {string} [category] - Filter tickets on category
47
+ */
48
+ /**
49
+ * @typedef GetTokenForVideoRoomParam
50
+ * @property {string} uniqueName - Unique name of video room
51
+ */
52
+ /**
53
+ * @typedef GetVideoParticipantsParam
54
+ * @property {string} uniqueName - Unique name of Video Room
55
+ */
56
+ /**
57
+ * @typedef OpenVideoRoomParam
58
+ * @property {LeadPlatformModel.CreateVideoRoomPayload} body
59
+ */
60
+ declare class LeadPlatformApplicationValidator {
61
+ /** @returns {CloseVideoRoomParam} */
62
+ static closeVideoRoom(): CloseVideoRoomParam;
63
+ /** @returns {CreateCustomFormParam} */
64
+ static createCustomForm(): CreateCustomFormParam;
65
+ /** @returns {CreateHistoryParam} */
66
+ static createHistory(): CreateHistoryParam;
67
+ /** @returns {EditCustomFormParam} */
68
+ static editCustomForm(): EditCustomFormParam;
69
+ /** @returns {EditTicketParam} */
70
+ static editTicket(): EditTicketParam;
71
+ /** @returns {GetCustomFormParam} */
72
+ static getCustomForm(): GetCustomFormParam;
73
+ /** @returns {GetCustomFormsParam} */
9
74
  static getCustomForms(): any;
10
- static getTicket(): any;
11
- static getTicketHistory(): any;
12
- static getTickets(): any;
13
- static getTokenForVideoRoom(): any;
14
- static getVideoParticipants(): any;
15
- static openVideoRoom(): any;
75
+ /** @returns {GetTicketParam} */
76
+ static getTicket(): GetTicketParam;
77
+ /** @returns {GetTicketHistoryParam} */
78
+ static getTicketHistory(): GetTicketHistoryParam;
79
+ /** @returns {GetTicketsParam} */
80
+ static getTickets(): GetTicketsParam;
81
+ /** @returns {GetTokenForVideoRoomParam} */
82
+ static getTokenForVideoRoom(): GetTokenForVideoRoomParam;
83
+ /** @returns {GetVideoParticipantsParam} */
84
+ static getVideoParticipants(): GetVideoParticipantsParam;
85
+ /** @returns {OpenVideoRoomParam} */
86
+ static openVideoRoom(): OpenVideoRoomParam;
16
87
  }
88
+ declare namespace LeadPlatformApplicationValidator {
89
+ export { CloseVideoRoomParam, CreateCustomFormParam, CreateHistoryParam, EditCustomFormParam, EditTicketParam, GetCustomFormParam, GetCustomFormsParam, GetTicketParam, GetTicketHistoryParam, GetTicketsParam, GetTokenForVideoRoomParam, GetVideoParticipantsParam, OpenVideoRoomParam };
90
+ }
91
+ type CloseVideoRoomParam = {
92
+ /**
93
+ * - Unique name of Video Room
94
+ */
95
+ uniqueName: string;
96
+ };
97
+ type CreateCustomFormParam = {
98
+ body: LeadPlatformModel.CreateCustomFormPayload;
99
+ };
100
+ type CreateHistoryParam = {
101
+ /**
102
+ * - Ticket ID for which history is created
103
+ */
104
+ id: string;
105
+ body: LeadPlatformModel.TicketHistoryPayload;
106
+ };
107
+ type EditCustomFormParam = {
108
+ /**
109
+ * - Slug of form whose response is getting submitted
110
+ */
111
+ slug: string;
112
+ body: LeadPlatformModel.EditCustomFormPayload;
113
+ };
114
+ type EditTicketParam = {
115
+ /**
116
+ * - Ticket ID of ticket to be edited
117
+ */
118
+ id: string;
119
+ body: LeadPlatformModel.EditTicketPayload;
120
+ };
121
+ type GetCustomFormParam = {
122
+ /**
123
+ * - Slug of form whose response is getting submitted
124
+ */
125
+ slug: string;
126
+ };
127
+ type GetTicketParam = {
128
+ /**
129
+ * - Tiket ID of the ticket to be fetched
130
+ */
131
+ id: string;
132
+ };
133
+ type GetTicketHistoryParam = {
134
+ /**
135
+ * - Ticket ID for which history is to be fetched
136
+ */
137
+ id: string;
138
+ };
139
+ type GetTicketsParam = {
140
+ /**
141
+ * - Decides that the reponse will contain the list of tickets
142
+ */
143
+ items?: boolean;
144
+ /**
145
+ * - Decides that the reponse will contain the
146
+ * ticket filters
147
+ */
148
+ filters?: boolean;
149
+ /**
150
+ * - Search through ticket titles and description
151
+ */
152
+ q?: string;
153
+ /**
154
+ * - Filter tickets on status
155
+ */
156
+ status?: string;
157
+ /**
158
+ * - Filter tickets on priority
159
+ */
160
+ priority?: LeadPlatformModel.PriorityEnum;
161
+ /**
162
+ * - Filter tickets on category
163
+ */
164
+ category?: string;
165
+ };
166
+ type GetTokenForVideoRoomParam = {
167
+ /**
168
+ * - Unique name of video room
169
+ */
170
+ uniqueName: string;
171
+ };
172
+ type GetVideoParticipantsParam = {
173
+ /**
174
+ * - Unique name of Video Room
175
+ */
176
+ uniqueName: string;
177
+ };
178
+ type OpenVideoRoomParam = {
179
+ body: LeadPlatformModel.CreateVideoRoomPayload;
180
+ };
181
+ type GetCustomFormsParam = any;
182
+ import LeadPlatformModel = require("./LeadPlatformModel");
@@ -1,90 +1,175 @@
1
1
  const Joi = require("joi");
2
2
 
3
- const LeadModel = require("./LeadPlatformModel");
4
- class LeadValidator {
3
+ const LeadPlatformModel = require("./LeadPlatformModel");
4
+
5
+ /**
6
+ * @typedef CloseVideoRoomParam
7
+ * @property {string} uniqueName - Unique name of Video Room
8
+ */
9
+
10
+ /**
11
+ * @typedef CreateCustomFormParam
12
+ * @property {LeadPlatformModel.CreateCustomFormPayload} body
13
+ */
14
+
15
+ /**
16
+ * @typedef CreateHistoryParam
17
+ * @property {string} id - Ticket ID for which history is created
18
+ * @property {LeadPlatformModel.TicketHistoryPayload} body
19
+ */
20
+
21
+ /**
22
+ * @typedef EditCustomFormParam
23
+ * @property {string} slug - Slug of form whose response is getting submitted
24
+ * @property {LeadPlatformModel.EditCustomFormPayload} body
25
+ */
26
+
27
+ /**
28
+ * @typedef EditTicketParam
29
+ * @property {string} id - Ticket ID of ticket to be edited
30
+ * @property {LeadPlatformModel.EditTicketPayload} body
31
+ */
32
+
33
+ /**
34
+ * @typedef GetCustomFormParam
35
+ * @property {string} slug - Slug of form whose response is getting submitted
36
+ */
37
+
38
+ /** @typedef GetCustomFormsParam */
39
+
40
+ /**
41
+ * @typedef GetTicketParam
42
+ * @property {string} id - Tiket ID of the ticket to be fetched
43
+ */
44
+
45
+ /**
46
+ * @typedef GetTicketHistoryParam
47
+ * @property {string} id - Ticket ID for which history is to be fetched
48
+ */
49
+
50
+ /**
51
+ * @typedef GetTicketsParam
52
+ * @property {boolean} [items] - Decides that the reponse will contain the list of tickets
53
+ * @property {boolean} [filters] - Decides that the reponse will contain the
54
+ * ticket filters
55
+ * @property {string} [q] - Search through ticket titles and description
56
+ * @property {string} [status] - Filter tickets on status
57
+ * @property {LeadPlatformModel.PriorityEnum} [priority] - Filter tickets on priority
58
+ * @property {string} [category] - Filter tickets on category
59
+ */
60
+
61
+ /**
62
+ * @typedef GetTokenForVideoRoomParam
63
+ * @property {string} uniqueName - Unique name of video room
64
+ */
65
+
66
+ /**
67
+ * @typedef GetVideoParticipantsParam
68
+ * @property {string} uniqueName - Unique name of Video Room
69
+ */
70
+
71
+ /**
72
+ * @typedef OpenVideoRoomParam
73
+ * @property {LeadPlatformModel.CreateVideoRoomPayload} body
74
+ */
75
+
76
+ class LeadPlatformApplicationValidator {
77
+ /** @returns {CloseVideoRoomParam} */
5
78
  static closeVideoRoom() {
6
79
  return Joi.object({
7
80
  uniqueName: Joi.string().allow("").required(),
8
81
  }).required();
9
82
  }
10
83
 
84
+ /** @returns {CreateCustomFormParam} */
11
85
  static createCustomForm() {
12
86
  return Joi.object({
13
- body: LeadModel.CreateCustomFormPayload().required(),
87
+ body: LeadPlatformModel.CreateCustomFormPayload().required(),
14
88
  }).required();
15
89
  }
16
90
 
91
+ /** @returns {CreateHistoryParam} */
17
92
  static createHistory() {
18
93
  return Joi.object({
19
94
  id: Joi.string().allow("").required(),
20
- body: LeadModel.TicketHistoryPayload().required(),
95
+ body: LeadPlatformModel.TicketHistoryPayload().required(),
21
96
  }).required();
22
97
  }
23
98
 
99
+ /** @returns {EditCustomFormParam} */
24
100
  static editCustomForm() {
25
101
  return Joi.object({
26
102
  slug: Joi.string().allow("").required(),
27
- body: LeadModel.EditCustomFormPayload().required(),
103
+ body: LeadPlatformModel.EditCustomFormPayload().required(),
28
104
  }).required();
29
105
  }
30
106
 
107
+ /** @returns {EditTicketParam} */
31
108
  static editTicket() {
32
109
  return Joi.object({
33
110
  id: Joi.string().allow("").required(),
34
- body: LeadModel.EditTicketPayload().required(),
111
+ body: LeadPlatformModel.EditTicketPayload().required(),
35
112
  }).required();
36
113
  }
37
114
 
115
+ /** @returns {GetCustomFormParam} */
38
116
  static getCustomForm() {
39
117
  return Joi.object({
40
118
  slug: Joi.string().allow("").required(),
41
119
  }).required();
42
120
  }
43
121
 
122
+ /** @returns {GetCustomFormsParam} */
44
123
  static getCustomForms() {
45
124
  return Joi.object({}).required();
46
125
  }
47
126
 
127
+ /** @returns {GetTicketParam} */
48
128
  static getTicket() {
49
129
  return Joi.object({
50
130
  id: Joi.string().allow("").required(),
51
131
  }).required();
52
132
  }
53
133
 
134
+ /** @returns {GetTicketHistoryParam} */
54
135
  static getTicketHistory() {
55
136
  return Joi.object({
56
137
  id: Joi.string().allow("").required(),
57
138
  }).required();
58
139
  }
59
140
 
141
+ /** @returns {GetTicketsParam} */
60
142
  static getTickets() {
61
143
  return Joi.object({
62
144
  items: Joi.boolean(),
63
145
  filters: Joi.boolean(),
64
146
  q: Joi.string().allow(""),
65
147
  status: Joi.string().allow(""),
66
- priority: LeadModel.PriorityEnum(),
148
+ priority: LeadPlatformModel.PriorityEnum(),
67
149
  category: Joi.string().allow(""),
68
150
  }).required();
69
151
  }
70
152
 
153
+ /** @returns {GetTokenForVideoRoomParam} */
71
154
  static getTokenForVideoRoom() {
72
155
  return Joi.object({
73
156
  uniqueName: Joi.string().allow("").required(),
74
157
  }).required();
75
158
  }
76
159
 
160
+ /** @returns {GetVideoParticipantsParam} */
77
161
  static getVideoParticipants() {
78
162
  return Joi.object({
79
163
  uniqueName: Joi.string().allow("").required(),
80
164
  }).required();
81
165
  }
82
166
 
167
+ /** @returns {OpenVideoRoomParam} */
83
168
  static openVideoRoom() {
84
169
  return Joi.object({
85
- body: LeadModel.CreateVideoRoomPayload().required(),
170
+ body: LeadPlatformModel.CreateVideoRoomPayload().required(),
86
171
  }).required();
87
172
  }
88
173
  }
89
174
 
90
- module.exports = LeadValidator;
175
+ module.exports = LeadPlatformApplicationValidator;
@@ -3,104 +3,77 @@ declare class Lead {
3
3
  constructor(config: any);
4
4
  config: any;
5
5
  /**
6
- * @param {Object} arg - Arg object.
7
- * @param {string} arg.id - Ticket ID for which history is created
8
- * @param {TicketHistoryPayload} arg.body
9
- * @returns {Promise<TicketHistory>} - Success response
6
+ * @param {LeadPlatformValidator.CreateHistoryParam} arg - Arg object
7
+ * @param {import("../PlatformAPIClient").Options} - Options
8
+ * @returns {Promise<LeadPlatformModel.TicketHistory>} - Success response
9
+ * @name createHistory
10
10
  * @summary: Create history for specific company level ticket
11
- * @description: Create history for specific company level ticket, this history is seen on ticket detail page, this can be comment, log or rating.
11
+ * @description: Create history for specific company level ticket, this history is seen on ticket detail page, this can be comment, log or rating. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/createHistory/).
12
12
  */
13
- createHistory({ id, body }?: {
14
- id: string;
15
- body: TicketHistoryPayload;
16
- }): Promise<TicketHistory>;
13
+ createHistory({ id, body }?: LeadPlatformValidator.CreateHistoryParam, { headers }?: import("../PlatformAPIClient").Options): Promise<LeadPlatformModel.TicketHistory>;
17
14
  /**
18
- * @param {Object} arg - Arg object.
19
- * @param {AddTicketPayload} arg.body
20
- * @returns {Promise<Ticket>} - Success response
15
+ * @param {LeadPlatformValidator.CreateTicketParam} arg - Arg object
16
+ * @param {import("../PlatformAPIClient").Options} - Options
17
+ * @returns {Promise<LeadPlatformModel.Ticket>} - Success response
18
+ * @name createTicket
21
19
  * @summary: Creates a company level ticket
22
- * @description: Creates a company level ticket
20
+ * @description: Creates a company level ticket - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/createTicket/).
23
21
  */
24
- createTicket({ body }?: {
25
- body: AddTicketPayload;
26
- }): Promise<Ticket>;
22
+ createTicket({ body }?: LeadPlatformValidator.CreateTicketParam, { headers }?: import("../PlatformAPIClient").Options): Promise<LeadPlatformModel.Ticket>;
27
23
  /**
28
- * @param {Object} arg - Arg object.
29
- * @param {string} arg.id - Ticket ID of ticket to be edited
30
- * @param {EditTicketPayload} arg.body
31
- * @returns {Promise<Ticket>} - Success response
24
+ * @param {LeadPlatformValidator.EditTicketParam} arg - Arg object
25
+ * @param {import("../PlatformAPIClient").Options} - Options
26
+ * @returns {Promise<LeadPlatformModel.Ticket>} - Success response
27
+ * @name editTicket
32
28
  * @summary: Edits ticket details of a company level ticket
33
- * @description: Edits ticket details of a company level ticket such as status, priority, category, tags, attachments, assigne & ticket content changes
29
+ * @description: Edits ticket details of a company level ticket such as status, priority, category, tags, attachments, assigne & ticket content changes - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/editTicket/).
34
30
  */
35
- editTicket({ id, body }?: {
36
- id: string;
37
- body: EditTicketPayload;
38
- }): Promise<Ticket>;
31
+ editTicket({ id, body }?: LeadPlatformValidator.EditTicketParam, { headers }?: import("../PlatformAPIClient").Options): Promise<LeadPlatformModel.Ticket>;
39
32
  /**
40
- * @param {Object} arg - Arg object.
41
- * @param {string} arg.id - Ticket ID for which feedbacks are to be fetched
42
- * @returns {Promise<TicketFeedbackList>} - Success response
33
+ * @param {LeadPlatformValidator.GetFeedbacksParam} arg - Arg object
34
+ * @param {import("../PlatformAPIClient").Options} - Options
35
+ * @returns {Promise<LeadPlatformModel.TicketFeedbackList>} - Success response
36
+ * @name getFeedbacks
43
37
  * @summary: Gets a list of feedback submitted against that ticket
44
- * @description: Gets a list of feedback submitted against that ticket
38
+ * @description: Gets a list of feedback submitted against that ticket - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getFeedbacks/).
45
39
  */
46
- getFeedbacks({ id }?: {
47
- id: string;
48
- }): Promise<TicketFeedbackList>;
40
+ getFeedbacks({ id }?: LeadPlatformValidator.GetFeedbacksParam, { headers }?: import("../PlatformAPIClient").Options): Promise<LeadPlatformModel.TicketFeedbackList>;
49
41
  /**
50
- * @param {Object} arg - Arg object.
51
- * @returns {Promise<CloseVideoRoomResponse>} - Success response
42
+ * @param {LeadPlatformValidator.GetGeneralConfigParam} arg - Arg object
43
+ * @param {import("../PlatformAPIClient").Options} - Options
44
+ * @returns {Promise<LeadPlatformModel.CloseVideoRoomResponse>} - Success response
45
+ * @name getGeneralConfig
52
46
  * @summary: Get general support configuration.
53
- * @description: Get general support configuration.
47
+ * @description: Get general support configuration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getGeneralConfig/).
54
48
  */
55
- getGeneralConfig({}?: any): Promise<CloseVideoRoomResponse>;
49
+ getGeneralConfig({ headers }?: any): Promise<LeadPlatformModel.CloseVideoRoomResponse>;
56
50
  /**
57
- * @param {Object} arg - Arg object.
58
- * @param {string} arg.id - Tiket ID of the ticket to be fetched
59
- * @returns {Promise<Ticket>} - Success response
51
+ * @param {LeadPlatformValidator.GetTicketParam} arg - Arg object
52
+ * @param {import("../PlatformAPIClient").Options} - Options
53
+ * @returns {Promise<LeadPlatformModel.Ticket>} - Success response
54
+ * @name getTicket
60
55
  * @summary: Retreives ticket details of a company level ticket with ticket ID
61
- * @description: Retreives ticket details of a company level ticket
56
+ * @description: Retreives ticket details of a company level ticket - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getTicket/).
62
57
  */
63
- getTicket({ id }?: {
64
- id: string;
65
- }): Promise<Ticket>;
58
+ getTicket({ id }?: LeadPlatformValidator.GetTicketParam, { headers }?: import("../PlatformAPIClient").Options): Promise<LeadPlatformModel.Ticket>;
66
59
  /**
67
- * @param {Object} arg - Arg object.
68
- * @param {string} arg.id - Ticket ID for which history is to be fetched
69
- * @returns {Promise<TicketHistoryList>} - Success response
60
+ * @param {LeadPlatformValidator.GetTicketHistoryParam} arg - Arg object
61
+ * @param {import("../PlatformAPIClient").Options} - Options
62
+ * @returns {Promise<LeadPlatformModel.TicketHistoryList>} - Success response
63
+ * @name getTicketHistory
70
64
  * @summary: Gets history list for specific company level ticket
71
- * @description: Gets history list for specific company level ticket, this history is seen on ticket detail page, this can be comment, log or rating.
65
+ * @description: Gets history list for specific company level ticket, this history is seen on ticket detail page, this can be comment, log or rating. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getTicketHistory/).
72
66
  */
73
- getTicketHistory({ id }?: {
74
- id: string;
75
- }): Promise<TicketHistoryList>;
67
+ getTicketHistory({ id }?: LeadPlatformValidator.GetTicketHistoryParam, { headers }?: import("../PlatformAPIClient").Options): Promise<LeadPlatformModel.TicketHistoryList>;
76
68
  /**
77
- * @param {Object} arg - Arg object.
78
- * @param {boolean} [arg.items] - Decides that the reponse will contain the
79
- * list of tickets
80
- * @param {boolean} [arg.filters] - Decides that the reponse will contain
81
- * the ticket filters
82
- * @param {string} [arg.q] - Search through ticket titles and description
83
- * @param {string} [arg.status] - Filter tickets on status
84
- * @param {PriorityEnum} [arg.priority] - Filter tickets on priority
85
- * @param {string} [arg.category] - Filter tickets on category
86
- * @param {number} [arg.pageNo] - The page number to navigate through the
87
- * given set of results.
88
- * @param {number} [arg.pageSize] - Number of items to retrieve in each
89
- * page. Default is 12.
90
- * @returns {Promise<TicketList>} - Success response
69
+ * @param {LeadPlatformValidator.GetTicketsParam} arg - Arg object
70
+ * @param {import("../PlatformAPIClient").Options} - Options
71
+ * @returns {Promise<LeadPlatformModel.TicketList>} - Success response
72
+ * @name getTickets
91
73
  * @summary: Gets the list of company level tickets and/or ticket filters depending on query params
92
- * @description: Gets the list of company level tickets and/or ticket filters
74
+ * @description: Gets the list of company level tickets and/or ticket filters - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getTickets/).
93
75
  */
94
- getTickets({ items, filters, q, status, priority, category, pageNo, pageSize, }?: {
95
- items?: boolean;
96
- filters?: boolean;
97
- q?: string;
98
- status?: string;
99
- priority?: PriorityEnum;
100
- category?: string;
101
- pageNo?: number;
102
- pageSize?: number;
103
- }): Promise<TicketList>;
76
+ getTickets({ items, filters, q, status, priority, category, pageNo, pageSize }?: LeadPlatformValidator.GetTicketsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<LeadPlatformModel.TicketList>;
104
77
  /**
105
78
  * @param {Object} arg - Arg object.
106
79
  * @param {boolean} [arg.items] - Decides that the reponse will contain the
@@ -109,10 +82,11 @@ declare class Lead {
109
82
  * the ticket filters
110
83
  * @param {string} [arg.q] - Search through ticket titles and description
111
84
  * @param {string} [arg.status] - Filter tickets on status
112
- * @param {PriorityEnum} [arg.priority] - Filter tickets on priority
85
+ * @param {LeadPlatformModel.PriorityEnum} [arg.priority] - Filter tickets on priority
113
86
  * @param {string} [arg.category] - Filter tickets on category
114
87
  * @param {number} [arg.pageSize] - Number of items to retrieve in each
115
88
  * page. Default is 12.
89
+ * @returns {Paginator<LeadPlatformModel.TicketList>}
116
90
  * @summary: Gets the list of company level tickets and/or ticket filters depending on query params
117
91
  * @description: Gets the list of company level tickets and/or ticket filters
118
92
  */
@@ -121,41 +95,41 @@ declare class Lead {
121
95
  filters?: boolean;
122
96
  q?: string;
123
97
  status?: string;
124
- priority?: PriorityEnum;
98
+ priority?: LeadPlatformModel.PriorityEnum;
125
99
  category?: string;
126
100
  pageSize?: number;
127
- }): Paginator;
101
+ }): Paginator<LeadPlatformModel.TicketList>;
128
102
  /**
129
- * @param {Object} arg - Arg object.
130
- * @param {string} arg.uniqueName - Unique name of video room
131
- * @returns {Promise<GetTokenForVideoRoomResponse>} - Success response
103
+ * @param {LeadPlatformValidator.GetTokenForVideoRoomParam} arg - Arg object
104
+ * @param {import("../PlatformAPIClient").Options} - Options
105
+ * @returns {Promise<LeadPlatformModel.GetTokenForVideoRoomResponse>} -
106
+ * Success response
107
+ * @name getTokenForVideoRoom
132
108
  * @summary: Get Token to join a specific Video Room using it's unqiue name
133
- * @description: Get Token to join a specific Video Room using it's unqiue name, this Token is your ticket to Room and also creates your identity there.
109
+ * @description: Get Token to join a specific Video Room using it's unqiue name, this Token is your ticket to Room and also creates your identity there. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getTokenForVideoRoom/).
134
110
  */
135
- getTokenForVideoRoom({ uniqueName }?: {
136
- uniqueName: string;
137
- }): Promise<GetTokenForVideoRoomResponse>;
111
+ getTokenForVideoRoom({ uniqueName }?: LeadPlatformValidator.GetTokenForVideoRoomParam, { headers }?: import("../PlatformAPIClient").Options): Promise<LeadPlatformModel.GetTokenForVideoRoomResponse>;
138
112
  /**
139
- * @param {Object} arg - Arg object.
140
- * @param {string} arg.uniqueName - Unique name of Video Room
141
- * @returns {Promise<GetParticipantsInsideVideoRoomResponse>} - Success response
113
+ * @param {LeadPlatformValidator.GetVideoParticipantsParam} arg - Arg object
114
+ * @param {import("../PlatformAPIClient").Options} - Options
115
+ * @returns {Promise<LeadPlatformModel.GetParticipantsInsideVideoRoomResponse>}
116
+ * - Success response
117
+ *
118
+ * @name getVideoParticipants
142
119
  * @summary: Get participants of a specific Video Room using it's unique name
143
- * @description: Get participants of a specific Video Room using it's unique name, this can be used to check if people are already there in the room and also to show their names.
120
+ * @description: Get participants of a specific Video Room using it's unique name, this can be used to check if people are already there in the room and also to show their names. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getVideoParticipants/).
144
121
  */
145
- getVideoParticipants({ uniqueName }?: {
146
- uniqueName: string;
147
- }): Promise<GetParticipantsInsideVideoRoomResponse>;
122
+ getVideoParticipants({ uniqueName }?: LeadPlatformValidator.GetVideoParticipantsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<LeadPlatformModel.GetParticipantsInsideVideoRoomResponse>;
148
123
  /**
149
- * @param {Object} arg - Arg object.
150
- * @param {string} arg.id - Ticket ID for which feedback is to be submitted
151
- * @param {TicketFeedbackPayload} arg.body
152
- * @returns {Promise<TicketFeedback>} - Success response
124
+ * @param {LeadPlatformValidator.SubmitFeedbackParam} arg - Arg object
125
+ * @param {import("../PlatformAPIClient").Options} - Options
126
+ * @returns {Promise<LeadPlatformModel.TicketFeedback>} - Success response
127
+ * @name submitFeedback
153
128
  * @summary: Submit a response for feeback form against that ticket
154
- * @description: Submit a response for feeback form against that ticket
129
+ * @description: Submit a response for feeback form against that ticket - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/submitFeedback/).
155
130
  */
156
- submitFeedback({ id, body }?: {
157
- id: string;
158
- body: TicketFeedbackPayload;
159
- }): Promise<TicketFeedback>;
131
+ submitFeedback({ id, body }?: LeadPlatformValidator.SubmitFeedbackParam, { headers }?: import("../PlatformAPIClient").Options): Promise<LeadPlatformModel.TicketFeedback>;
160
132
  }
133
+ import LeadPlatformValidator = require("./LeadPlatformValidator");
134
+ import LeadPlatformModel = require("./LeadPlatformModel");
161
135
  import Paginator = require("../../common/Paginator");