@gofynd/fdk-client-javascript 1.1.6 → 1.3.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 (348) hide show
  1. package/README.md +52 -3
  2. package/index.js +0 -3
  3. package/package.json +1 -2
  4. package/sdk/application/ApplicationAPIClient.d.ts +15 -1
  5. package/sdk/application/ApplicationAPIClient.js +12 -3
  6. package/sdk/application/ApplicationClient.d.ts +36 -6
  7. package/sdk/application/ApplicationClient.js +30 -43
  8. package/sdk/application/ApplicationConfig.d.ts +92 -12
  9. package/sdk/application/ApplicationConfig.js +48 -14
  10. package/sdk/application/Cart/CartApplicationClient.d.ts +200 -357
  11. package/sdk/application/Cart/CartApplicationClient.js +711 -483
  12. package/sdk/application/Cart/CartApplicationModel.d.ts +2054 -96
  13. package/sdk/application/Cart/CartApplicationModel.js +1224 -93
  14. package/sdk/application/Cart/CartApplicationValidator.d.ts +508 -30
  15. package/sdk/application/Cart/CartApplicationValidator.js +270 -15
  16. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +274 -422
  17. package/sdk/application/Catalog/CatalogApplicationClient.js +865 -630
  18. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +2320 -117
  19. package/sdk/application/Catalog/CatalogApplicationModel.js +1566 -172
  20. package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +798 -31
  21. package/sdk/application/Catalog/CatalogApplicationValidator.js +318 -3
  22. package/sdk/application/Common/CommonApplicationClient.d.ts +16 -21
  23. package/sdk/application/Common/CommonApplicationClient.js +52 -33
  24. package/sdk/application/Common/CommonApplicationModel.d.ts +368 -19
  25. package/sdk/application/Common/CommonApplicationModel.js +192 -40
  26. package/sdk/application/Common/CommonApplicationValidator.d.ts +42 -4
  27. package/sdk/application/Common/CommonApplicationValidator.js +21 -3
  28. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +31 -18
  29. package/sdk/application/Communication/CommunicationApplicationClient.js +86 -47
  30. package/sdk/application/Communication/CommunicationApplicationModel.d.ts +157 -14
  31. package/sdk/application/Communication/CommunicationApplicationModel.js +104 -23
  32. package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +27 -4
  33. package/sdk/application/Communication/CommunicationApplicationValidator.js +21 -5
  34. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +149 -118
  35. package/sdk/application/Configuration/ConfigurationApplicationClient.js +457 -260
  36. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +2235 -110
  37. package/sdk/application/Configuration/ConfigurationApplicationModel.js +1113 -193
  38. package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +160 -8
  39. package/sdk/application/Configuration/ConfigurationApplicationValidator.js +88 -4
  40. package/sdk/application/Content/ContentApplicationClient.d.ts +149 -139
  41. package/sdk/application/Content/ContentApplicationClient.js +489 -278
  42. package/sdk/application/Content/ContentApplicationModel.d.ts +1010 -105
  43. package/sdk/application/Content/ContentApplicationModel.js +737 -396
  44. package/sdk/application/Content/ContentApplicationValidator.d.ts +214 -12
  45. package/sdk/application/Content/ContentApplicationValidator.js +113 -3
  46. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +23 -29
  47. package/sdk/application/FileStorage/FileStorageApplicationClient.js +74 -47
  48. package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +148 -20
  49. package/sdk/application/FileStorage/FileStorageApplicationModel.js +100 -87
  50. package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +55 -5
  51. package/sdk/application/FileStorage/FileStorageApplicationValidator.js +33 -6
  52. package/sdk/application/Lead/LeadApplicationClient.d.ts +57 -53
  53. package/sdk/application/Lead/LeadApplicationClient.js +188 -103
  54. package/sdk/application/Lead/LeadApplicationModel.d.ts +686 -54
  55. package/sdk/application/Lead/LeadApplicationModel.js +330 -244
  56. package/sdk/application/Lead/LeadApplicationValidator.d.ts +91 -9
  57. package/sdk/application/Lead/LeadApplicationValidator.js +51 -6
  58. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +40 -33
  59. package/sdk/application/Logistic/LogisticApplicationClient.js +131 -73
  60. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +399 -28
  61. package/sdk/application/Logistic/LogisticApplicationModel.js +293 -24
  62. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +48 -6
  63. package/sdk/application/Logistic/LogisticApplicationValidator.js +34 -6
  64. package/sdk/application/Order/OrderApplicationClient.d.ts +93 -133
  65. package/sdk/application/Order/OrderApplicationClient.js +329 -217
  66. package/sdk/application/Order/OrderApplicationModel.d.ts +1101 -66
  67. package/sdk/application/Order/OrderApplicationModel.js +776 -57
  68. package/sdk/application/Order/OrderApplicationValidator.d.ts +249 -14
  69. package/sdk/application/Order/OrderApplicationValidator.js +114 -5
  70. package/sdk/application/Payment/PaymentApplicationClient.d.ts +400 -366
  71. package/sdk/application/Payment/PaymentApplicationClient.js +1176 -703
  72. package/sdk/application/Payment/PaymentApplicationModel.d.ts +3125 -99
  73. package/sdk/application/Payment/PaymentApplicationModel.js +1158 -62
  74. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +494 -41
  75. package/sdk/application/Payment/PaymentApplicationValidator.js +297 -25
  76. package/sdk/application/PosCart/PosCartApplicationClient.d.ts +205 -350
  77. package/sdk/application/PosCart/PosCartApplicationClient.js +720 -491
  78. package/sdk/application/PosCart/PosCartApplicationModel.d.ts +1823 -89
  79. package/sdk/application/PosCart/PosCartApplicationModel.js +1117 -85
  80. package/sdk/application/PosCart/PosCartApplicationValidator.d.ts +480 -29
  81. package/sdk/application/PosCart/PosCartApplicationValidator.js +262 -15
  82. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +58 -47
  83. package/sdk/application/Rewards/RewardsApplicationClient.js +187 -102
  84. package/sdk/application/Rewards/RewardsApplicationModel.d.ts +343 -22
  85. package/sdk/application/Rewards/RewardsApplicationModel.js +230 -15
  86. package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +70 -7
  87. package/sdk/application/Rewards/RewardsApplicationValidator.js +45 -6
  88. package/sdk/application/Share/ShareApplicationClient.d.ts +52 -50
  89. package/sdk/application/Share/ShareApplicationClient.js +185 -97
  90. package/sdk/application/Share/ShareApplicationModel.d.ts +198 -15
  91. package/sdk/application/Share/ShareApplicationModel.js +131 -31
  92. package/sdk/application/Share/ShareApplicationValidator.d.ts +86 -8
  93. package/sdk/application/Share/ShareApplicationValidator.js +48 -4
  94. package/sdk/application/Theme/ThemeApplicationClient.d.ts +30 -27
  95. package/sdk/application/Theme/ThemeApplicationClient.js +102 -56
  96. package/sdk/application/Theme/ThemeApplicationModel.d.ts +1291 -48
  97. package/sdk/application/Theme/ThemeApplicationModel.js +895 -134
  98. package/sdk/application/Theme/ThemeApplicationValidator.d.ts +49 -5
  99. package/sdk/application/Theme/ThemeApplicationValidator.js +26 -3
  100. package/sdk/application/User/UserApplicationClient.d.ts +260 -305
  101. package/sdk/application/User/UserApplicationClient.js +910 -522
  102. package/sdk/application/User/UserApplicationModel.d.ts +992 -101
  103. package/sdk/application/User/UserApplicationModel.js +699 -248
  104. package/sdk/application/User/UserApplicationValidator.d.ts +457 -33
  105. package/sdk/application/User/UserApplicationValidator.js +265 -31
  106. package/sdk/common/AxiosHelper.js +7 -2
  107. package/sdk/common/FDKError.d.ts +3 -0
  108. package/sdk/common/FDKError.js +8 -0
  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/common/utils.d.ts +3 -0
  113. package/sdk/common/utils.js +29 -0
  114. package/sdk/partner/PartnerAPIClient.d.ts +16 -1
  115. package/sdk/partner/PartnerAPIClient.js +12 -2
  116. package/sdk/partner/PartnerClient.d.ts +22 -3
  117. package/sdk/partner/PartnerClient.js +20 -0
  118. package/sdk/partner/PartnerConfig.d.ts +40 -14
  119. package/sdk/partner/PartnerConfig.js +31 -6
  120. package/sdk/partner/Theme/ThemePartnerClient.d.ts +299 -0
  121. package/sdk/partner/Theme/ThemePartnerClient.js +768 -0
  122. package/sdk/partner/Theme/ThemePartnerModel.d.ts +1706 -0
  123. package/sdk/partner/Theme/ThemePartnerModel.js +1409 -0
  124. package/sdk/partner/Theme/ThemePartnerValidator.d.ts +22 -0
  125. package/sdk/partner/Theme/ThemePartnerValidator.js +157 -0
  126. package/sdk/partner/index.d.ts +3 -1
  127. package/sdk/partner/index.js +3 -1
  128. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +30 -25
  129. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +104 -53
  130. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +190 -17
  131. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +132 -15
  132. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +52 -5
  133. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +30 -4
  134. package/sdk/platform/Billing/BillingPlatformClient.d.ts +133 -97
  135. package/sdk/platform/Billing/BillingPlatformClient.js +561 -191
  136. package/sdk/platform/Billing/BillingPlatformModel.d.ts +1071 -68
  137. package/sdk/platform/Billing/BillingPlatformModel.js +762 -151
  138. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +175 -12
  139. package/sdk/platform/Billing/BillingPlatformValidator.js +118 -8
  140. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +454 -635
  141. package/sdk/platform/Cart/CartPlatformApplicationClient.js +1646 -957
  142. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +827 -57
  143. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +492 -34
  144. package/sdk/platform/Cart/CartPlatformModel.d.ts +3839 -175
  145. package/sdk/platform/Cart/CartPlatformModel.js +2423 -217
  146. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +528 -638
  147. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1600 -984
  148. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1081 -49
  149. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +482 -23
  150. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +652 -826
  151. package/sdk/platform/Catalog/CatalogPlatformClient.js +1979 -1264
  152. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6869 -326
  153. package/sdk/platform/Catalog/CatalogPlatformModel.js +4215 -351
  154. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +1361 -71
  155. package/sdk/platform/Catalog/CatalogPlatformValidator.js +624 -30
  156. package/sdk/platform/Common/CommonPlatformClient.d.ts +16 -21
  157. package/sdk/platform/Common/CommonPlatformClient.js +50 -33
  158. package/sdk/platform/Common/CommonPlatformModel.d.ts +423 -19
  159. package/sdk/platform/Common/CommonPlatformModel.js +214 -40
  160. package/sdk/platform/Common/CommonPlatformValidator.d.ts +37 -4
  161. package/sdk/platform/Common/CommonPlatformValidator.js +20 -3
  162. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +731 -303
  163. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +3095 -785
  164. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +699 -41
  165. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +463 -27
  166. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +19 -5
  167. package/sdk/platform/Communication/CommunicationPlatformClient.js +59 -19
  168. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +1708 -102
  169. package/sdk/platform/Communication/CommunicationPlatformModel.js +1360 -235
  170. package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +16 -3
  171. package/sdk/platform/Communication/CommunicationPlatformValidator.js +11 -3
  172. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +127 -111
  173. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +435 -225
  174. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +882 -43
  175. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +666 -78
  176. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +184 -13
  177. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +105 -10
  178. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +327 -240
  179. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +922 -438
  180. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +297 -22
  181. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +191 -17
  182. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +184 -178
  183. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +555 -311
  184. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +4337 -188
  185. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +2178 -248
  186. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +332 -19
  187. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +153 -10
  188. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +605 -578
  189. package/sdk/platform/Content/ContentPlatformApplicationClient.js +1996 -987
  190. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +872 -62
  191. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +487 -35
  192. package/sdk/platform/Content/ContentPlatformModel.d.ts +1472 -108
  193. package/sdk/platform/Content/ContentPlatformModel.js +1085 -204
  194. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +85 -82
  195. package/sdk/platform/Discount/DiscountPlatformClient.js +333 -175
  196. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +281 -15
  197. package/sdk/platform/Discount/DiscountPlatformModel.js +189 -10
  198. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +185 -13
  199. package/sdk/platform/Discount/DiscountPlatformValidator.js +88 -8
  200. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +109 -52
  201. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +570 -105
  202. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +141 -6
  203. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +118 -7
  204. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +43 -63
  205. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +153 -135
  206. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +426 -20
  207. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +379 -40
  208. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +106 -8
  209. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +60 -8
  210. package/sdk/platform/Finance/FinancePlatformClient.d.ts +260 -129
  211. package/sdk/platform/Finance/FinancePlatformClient.js +1182 -194
  212. package/sdk/platform/Finance/FinancePlatformModel.d.ts +1267 -50
  213. package/sdk/platform/Finance/FinancePlatformModel.js +1252 -38
  214. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +233 -15
  215. package/sdk/platform/Finance/FinancePlatformValidator.js +229 -16
  216. package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +111 -97
  217. package/sdk/platform/Inventory/InventoryPlatformClient.js +330 -199
  218. package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +1354 -61
  219. package/sdk/platform/Inventory/InventoryPlatformModel.js +916 -83
  220. package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +168 -12
  221. package/sdk/platform/Inventory/InventoryPlatformValidator.js +82 -6
  222. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +100 -106
  223. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +372 -186
  224. package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +180 -14
  225. package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +94 -9
  226. package/sdk/platform/Lead/LeadPlatformClient.d.ts +89 -104
  227. package/sdk/platform/Lead/LeadPlatformClient.js +305 -180
  228. package/sdk/platform/Lead/LeadPlatformModel.d.ts +1045 -54
  229. package/sdk/platform/Lead/LeadPlatformModel.js +504 -142
  230. package/sdk/platform/Lead/LeadPlatformValidator.d.ts +173 -12
  231. package/sdk/platform/Lead/LeadPlatformValidator.js +92 -15
  232. package/sdk/platform/OAuthClient.js +6 -2
  233. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +20 -14
  234. package/sdk/platform/Order/OrderPlatformApplicationClient.js +58 -29
  235. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +26 -4
  236. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +16 -3
  237. package/sdk/platform/Order/OrderPlatformClient.d.ts +437 -556
  238. package/sdk/platform/Order/OrderPlatformClient.js +1500 -760
  239. package/sdk/platform/Order/OrderPlatformModel.d.ts +5225 -247
  240. package/sdk/platform/Order/OrderPlatformModel.js +3473 -260
  241. package/sdk/platform/Order/OrderPlatformValidator.d.ts +859 -37
  242. package/sdk/platform/Order/OrderPlatformValidator.js +435 -23
  243. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +16 -42
  244. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +52 -155
  245. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +37 -6
  246. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +19 -17
  247. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +78 -45
  248. package/sdk/platform/Partner/PartnerPlatformModel.js +43 -369
  249. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +418 -288
  250. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +1509 -505
  251. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +438 -30
  252. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +312 -19
  253. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +83 -73
  254. package/sdk/platform/Payment/PaymentPlatformClient.js +259 -154
  255. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +3200 -93
  256. package/sdk/platform/Payment/PaymentPlatformModel.js +1334 -36
  257. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +111 -11
  258. package/sdk/platform/Payment/PaymentPlatformValidator.js +68 -7
  259. package/sdk/platform/PlatformAPIClient.d.ts +16 -1
  260. package/sdk/platform/PlatformAPIClient.js +9 -1
  261. package/sdk/platform/PlatformApplicationClient.d.ts +22 -1798
  262. package/sdk/platform/PlatformApplicationClient.js +17 -1899
  263. package/sdk/platform/PlatformClient.d.ts +31 -12581
  264. package/sdk/platform/PlatformClient.js +30 -15089
  265. package/sdk/platform/PlatformConfig.d.ts +37 -11
  266. package/sdk/platform/PlatformConfig.js +32 -6
  267. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +96 -92
  268. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +344 -177
  269. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +149 -12
  270. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +82 -8
  271. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +360 -23
  272. package/sdk/platform/Rewards/RewardsPlatformModel.js +238 -22
  273. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +159 -92
  274. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +473 -208
  275. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +138 -13
  276. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +100 -14
  277. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +166 -178
  278. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +518 -329
  279. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1408 -96
  280. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1034 -71
  281. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +280 -18
  282. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +134 -11
  283. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +41 -66
  284. package/sdk/platform/Share/SharePlatformApplicationClient.js +149 -116
  285. package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +87 -7
  286. package/sdk/platform/Share/SharePlatformApplicationValidator.js +42 -5
  287. package/sdk/platform/Share/SharePlatformModel.d.ts +250 -16
  288. package/sdk/platform/Share/SharePlatformModel.js +167 -19
  289. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +229 -193
  290. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +976 -352
  291. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +345 -24
  292. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +206 -14
  293. package/sdk/platform/Theme/ThemePlatformClient.d.ts +37 -0
  294. package/sdk/platform/Theme/ThemePlatformClient.js +235 -0
  295. package/sdk/platform/Theme/ThemePlatformModel.d.ts +1527 -48
  296. package/sdk/platform/Theme/ThemePlatformModel.js +1099 -118
  297. package/sdk/platform/Theme/ThemePlatformValidator.d.ts +32 -0
  298. package/sdk/platform/Theme/ThemePlatformValidator.js +38 -0
  299. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +138 -152
  300. package/sdk/platform/User/UserPlatformApplicationClient.js +470 -244
  301. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +242 -18
  302. package/sdk/platform/User/UserPlatformApplicationValidator.js +129 -12
  303. package/sdk/platform/User/UserPlatformModel.d.ts +653 -101
  304. package/sdk/platform/User/UserPlatformModel.js +467 -424
  305. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +153 -49
  306. package/sdk/platform/Webhook/WebhookPlatformClient.js +896 -88
  307. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +632 -16
  308. package/sdk/platform/Webhook/WebhookPlatformModel.js +502 -54
  309. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +170 -7
  310. package/sdk/platform/Webhook/WebhookPlatformValidator.js +157 -7
  311. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +16 -21
  312. package/sdk/public/Configuration/ConfigurationPublicClient.js +48 -33
  313. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +370 -19
  314. package/sdk/public/Configuration/ConfigurationPublicModel.js +191 -40
  315. package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +42 -4
  316. package/sdk/public/Configuration/ConfigurationPublicValidator.js +21 -3
  317. package/sdk/public/Inventory/InventoryPublicClient.d.ts +54 -48
  318. package/sdk/public/Inventory/InventoryPublicClient.js +161 -98
  319. package/sdk/public/Inventory/InventoryPublicModel.d.ts +392 -21
  320. package/sdk/public/Inventory/InventoryPublicModel.js +267 -27
  321. package/sdk/public/Inventory/InventoryPublicValidator.d.ts +90 -8
  322. package/sdk/public/Inventory/InventoryPublicValidator.js +44 -4
  323. package/sdk/public/Partner/PartnerPublicClient.d.ts +22 -0
  324. package/sdk/public/Partner/PartnerPublicClient.js +110 -0
  325. package/sdk/public/Partner/PartnerPublicModel.d.ts +240 -0
  326. package/sdk/public/Partner/PartnerPublicModel.js +280 -0
  327. package/sdk/public/Partner/PartnerPublicValidator.d.ts +18 -0
  328. package/sdk/public/Partner/PartnerPublicValidator.js +19 -0
  329. package/sdk/public/PublicAPIClient.d.ts +14 -1
  330. package/sdk/public/PublicAPIClient.js +7 -1
  331. package/sdk/public/PublicClient.d.ts +21 -3
  332. package/sdk/public/PublicClient.js +20 -0
  333. package/sdk/public/PublicConfig.d.ts +27 -6
  334. package/sdk/public/PublicConfig.js +17 -1
  335. package/sdk/public/Webhook/WebhookPublicClient.d.ts +16 -11
  336. package/sdk/public/Webhook/WebhookPublicClient.js +48 -27
  337. package/sdk/public/Webhook/WebhookPublicModel.d.ts +52 -16
  338. package/sdk/public/Webhook/WebhookPublicModel.js +33 -113
  339. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +18 -3
  340. package/sdk/public/Webhook/WebhookPublicValidator.js +14 -4
  341. package/sdk/public/index.d.ts +1 -0
  342. package/sdk/public/index.js +2 -0
  343. package/sdk/application/ApplicationModels.d.ts +0 -3
  344. package/sdk/application/ApplicationModels.js +0 -20
  345. package/sdk/platform/Partner/PartnerPlatformClient.d.ts +0 -145
  346. package/sdk/platform/Partner/PartnerPlatformClient.js +0 -799
  347. package/sdk/platform/Partner/PartnerPlatformValidator.d.ts +0 -14
  348. package/sdk/platform/Partner/PartnerPlatformValidator.js +0 -87
@@ -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,85 @@ 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.CreatePlatformTicketHistoryParam} arg - Arg object
7
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
8
+ * @param {import("../PlatformAPIClient").Options} - Options
9
+ * @returns {Promise<LeadPlatformModel.TicketHistory>} - Success response
10
+ * @name createPlatformTicketHistory
10
11
  * @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.
12
+ * @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/createPlatformTicketHistory/).
12
13
  */
13
- createHistory({ id, body }?: {
14
- id: string;
15
- body: TicketHistoryPayload;
16
- }): Promise<TicketHistory>;
14
+ createPlatformTicketHistory({ id, body, requestHeaders }?: LeadPlatformValidator.CreatePlatformTicketHistoryParam, { responseHeaders }?: object): Promise<LeadPlatformModel.TicketHistory>;
17
15
  /**
18
- * @param {Object} arg - Arg object.
19
- * @param {AddTicketPayload} arg.body
20
- * @returns {Promise<Ticket>} - Success response
16
+ * @param {LeadPlatformValidator.CreateTicketParam} arg - Arg object
17
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
18
+ * @param {import("../PlatformAPIClient").Options} - Options
19
+ * @returns {Promise<LeadPlatformModel.Ticket>} - Success response
20
+ * @name createTicket
21
21
  * @summary: Creates a company level ticket
22
- * @description: Creates a company level ticket
22
+ * @description: Creates a company level ticket - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/createTicket/).
23
23
  */
24
- createTicket({ body }?: {
25
- body: AddTicketPayload;
26
- }): Promise<Ticket>;
24
+ createTicket({ body, requestHeaders }?: LeadPlatformValidator.CreateTicketParam, { responseHeaders }?: object): Promise<LeadPlatformModel.Ticket>;
27
25
  /**
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
26
+ * @param {LeadPlatformValidator.EditPlatformTicketParam} arg - Arg object
27
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
28
+ * @param {import("../PlatformAPIClient").Options} - Options
29
+ * @returns {Promise<LeadPlatformModel.Ticket>} - Success response
30
+ * @name editPlatformTicket
32
31
  * @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
32
+ * @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/editPlatformTicket/).
34
33
  */
35
- editTicket({ id, body }?: {
36
- id: string;
37
- body: EditTicketPayload;
38
- }): Promise<Ticket>;
34
+ editPlatformTicket({ id, body, requestHeaders }?: LeadPlatformValidator.EditPlatformTicketParam, { responseHeaders }?: object): Promise<LeadPlatformModel.Ticket>;
39
35
  /**
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
36
+ * @param {LeadPlatformValidator.GetFeedbacksParam} arg - Arg object
37
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
38
+ * @param {import("../PlatformAPIClient").Options} - Options
39
+ * @returns {Promise<LeadPlatformModel.TicketFeedbackList>} - Success response
40
+ * @name getFeedbacks
43
41
  * @summary: Gets a list of feedback submitted against that ticket
44
- * @description: Gets a list of feedback submitted against that ticket
42
+ * @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
43
  */
46
- getFeedbacks({ id }?: {
47
- id: string;
48
- }): Promise<TicketFeedbackList>;
44
+ getFeedbacks({ id, requestHeaders }?: LeadPlatformValidator.GetFeedbacksParam, { responseHeaders }?: object): Promise<LeadPlatformModel.TicketFeedbackList>;
49
45
  /**
50
- * @param {Object} arg - Arg object.
51
- * @returns {Promise<CloseVideoRoomResponse>} - Success response
46
+ * @param {LeadPlatformValidator.GetGeneralConfigParam} arg - Arg object
47
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
48
+ * @param {import("../PlatformAPIClient").Options} - Options
49
+ * @returns {Promise<LeadPlatformModel.CloseVideoRoomResponse>} - Success response
50
+ * @name getGeneralConfig
52
51
  * @summary: Get general support configuration.
53
- * @description: Get general support configuration.
52
+ * @description: Get general support configuration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getGeneralConfig/).
54
53
  */
55
- getGeneralConfig({}?: any): Promise<CloseVideoRoomResponse>;
54
+ getGeneralConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<LeadPlatformModel.CloseVideoRoomResponse>;
56
55
  /**
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
56
+ * @param {LeadPlatformValidator.GetPlatformTicketParam} arg - Arg object
57
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
58
+ * @param {import("../PlatformAPIClient").Options} - Options
59
+ * @returns {Promise<LeadPlatformModel.Ticket>} - Success response
60
+ * @name getPlatformTicket
60
61
  * @summary: Retreives ticket details of a company level ticket with ticket ID
61
- * @description: Retreives ticket details of a company level ticket
62
+ * @description: Retreives ticket details of a company level ticket - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getPlatformTicket/).
62
63
  */
63
- getTicket({ id }?: {
64
- id: string;
65
- }): Promise<Ticket>;
64
+ getPlatformTicket({ id, requestHeaders }?: LeadPlatformValidator.GetPlatformTicketParam, { responseHeaders }?: object): Promise<LeadPlatformModel.Ticket>;
66
65
  /**
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
66
+ * @param {LeadPlatformValidator.GetPlatformTicketHistoryParam} arg - Arg object
67
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
68
+ * @param {import("../PlatformAPIClient").Options} - Options
69
+ * @returns {Promise<LeadPlatformModel.TicketHistoryList>} - Success response
70
+ * @name getPlatformTicketHistory
70
71
  * @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.
72
+ * @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/getPlatformTicketHistory/).
72
73
  */
73
- getTicketHistory({ id }?: {
74
- id: string;
75
- }): Promise<TicketHistoryList>;
74
+ getPlatformTicketHistory({ id, requestHeaders }?: LeadPlatformValidator.GetPlatformTicketHistoryParam, { responseHeaders }?: object): Promise<LeadPlatformModel.TicketHistoryList>;
76
75
  /**
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
76
+ * @param {LeadPlatformValidator.GetPlatformTicketsParam} arg - Arg object
77
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
78
+ * @param {import("../PlatformAPIClient").Options} - Options
79
+ * @returns {Promise<LeadPlatformModel.TicketList>} - Success response
80
+ * @name getPlatformTickets
91
81
  * @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
82
+ * @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/getPlatformTickets/).
93
83
  */
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>;
84
+ getPlatformTickets({ items, filters, q, status, priority, category, pageNo, pageSize, requestHeaders, }?: LeadPlatformValidator.GetPlatformTicketsParam, { responseHeaders }?: object): Promise<LeadPlatformModel.TicketList>;
104
85
  /**
105
86
  * @param {Object} arg - Arg object.
106
87
  * @param {boolean} [arg.items] - Decides that the reponse will contain the
@@ -109,53 +90,57 @@ declare class Lead {
109
90
  * the ticket filters
110
91
  * @param {string} [arg.q] - Search through ticket titles and description
111
92
  * @param {string} [arg.status] - Filter tickets on status
112
- * @param {PriorityEnum} [arg.priority] - Filter tickets on priority
93
+ * @param {LeadPlatformModel.PriorityEnum} [arg.priority] - Filter tickets on priority
113
94
  * @param {string} [arg.category] - Filter tickets on category
114
95
  * @param {number} [arg.pageSize] - Number of items to retrieve in each
115
96
  * page. Default is 12.
97
+ * @returns {Paginator<LeadPlatformModel.TicketList>}
116
98
  * @summary: Gets the list of company level tickets and/or ticket filters depending on query params
117
99
  * @description: Gets the list of company level tickets and/or ticket filters
118
100
  */
119
- getTicketsPaginator({ items, filters, q, status, priority, category, pageSize, }?: {
101
+ getPlatformTicketsPaginator({ items, filters, q, status, priority, category, pageSize, }?: {
120
102
  items?: boolean;
121
103
  filters?: boolean;
122
104
  q?: string;
123
105
  status?: string;
124
- priority?: PriorityEnum;
106
+ priority?: LeadPlatformModel.PriorityEnum;
125
107
  category?: string;
126
108
  pageSize?: number;
127
- }): Paginator;
109
+ }): Paginator<LeadPlatformModel.TicketList>;
128
110
  /**
129
- * @param {Object} arg - Arg object.
130
- * @param {string} arg.uniqueName - Unique name of video room
131
- * @returns {Promise<GetTokenForVideoRoomResponse>} - Success response
132
- * @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.
111
+ * @param {LeadPlatformValidator.GetPlatformVideoParticipantsParam} arg - Arg object
112
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
113
+ * @param {import("../PlatformAPIClient").Options} - Options
114
+ * @returns {Promise<LeadPlatformModel.GetParticipantsInsideVideoRoomResponse>}
115
+ * - Success response
116
+ *
117
+ * @name getPlatformVideoParticipants
118
+ * @summary: Get participants of a specific Video Room using it's unique name
119
+ * @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/getPlatformVideoParticipants/).
134
120
  */
135
- getTokenForVideoRoom({ uniqueName }?: {
136
- uniqueName: string;
137
- }): Promise<GetTokenForVideoRoomResponse>;
121
+ getPlatformVideoParticipants({ uniqueName, requestHeaders }?: LeadPlatformValidator.GetPlatformVideoParticipantsParam, { responseHeaders }?: object): Promise<LeadPlatformModel.GetParticipantsInsideVideoRoomResponse>;
138
122
  /**
139
- * @param {Object} arg - Arg object.
140
- * @param {string} arg.uniqueName - Unique name of Video Room
141
- * @returns {Promise<GetParticipantsInsideVideoRoomResponse>} - Success response
142
- * @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.
123
+ * @param {LeadPlatformValidator.GetTokenForPlatformVideoRoomParam} arg - Arg object
124
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
125
+ * @param {import("../PlatformAPIClient").Options} - Options
126
+ * @returns {Promise<LeadPlatformModel.GetTokenForVideoRoomResponse>} -
127
+ * Success response
128
+ * @name getTokenForPlatformVideoRoom
129
+ * @summary: Get Token to join a specific Video Room using it's unqiue name
130
+ * @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/getTokenForPlatformVideoRoom/).
144
131
  */
145
- getVideoParticipants({ uniqueName }?: {
146
- uniqueName: string;
147
- }): Promise<GetParticipantsInsideVideoRoomResponse>;
132
+ getTokenForPlatformVideoRoom({ uniqueName, requestHeaders }?: LeadPlatformValidator.GetTokenForPlatformVideoRoomParam, { responseHeaders }?: object): Promise<LeadPlatformModel.GetTokenForVideoRoomResponse>;
148
133
  /**
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
134
+ * @param {LeadPlatformValidator.SubmitFeedbackParam} arg - Arg object
135
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
136
+ * @param {import("../PlatformAPIClient").Options} - Options
137
+ * @returns {Promise<LeadPlatformModel.TicketFeedback>} - Success response
138
+ * @name submitFeedback
153
139
  * @summary: Submit a response for feeback form against that ticket
154
- * @description: Submit a response for feeback form against that ticket
140
+ * @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
141
  */
156
- submitFeedback({ id, body }?: {
157
- id: string;
158
- body: TicketFeedbackPayload;
159
- }): Promise<TicketFeedback>;
142
+ submitFeedback({ id, body, requestHeaders }?: LeadPlatformValidator.SubmitFeedbackParam, { responseHeaders }?: object): Promise<LeadPlatformModel.TicketFeedback>;
160
143
  }
144
+ import LeadPlatformValidator = require("./LeadPlatformValidator");
145
+ import LeadPlatformModel = require("./LeadPlatformModel");
161
146
  import Paginator = require("../../common/Paginator");