@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,15 +1,171 @@
1
- export = InventoryValidator;
2
- declare class InventoryValidator {
3
- static createJob(): any;
4
- static disable(): any;
1
+ export = InventoryPlatformValidator;
2
+ /**
3
+ * @typedef CreateJobParam
4
+ * @property {InventoryPlatformModel.JobConfigDTO} body
5
+ */
6
+ /**
7
+ * @typedef DisableParam
8
+ * @property {string} integrationId - IntegrationId
9
+ */
10
+ /** @typedef GetConfigByCompanyParam */
11
+ /**
12
+ * @typedef GetJobByCodeParam
13
+ * @property {string} code - Job Code
14
+ */
15
+ /**
16
+ * @typedef GetJobByCompanyAndIntegrationParam
17
+ * @property {string} integrationId - Integration Id
18
+ * @property {number} [pageNo] - Page Number
19
+ * @property {number} [pageSize] - Page Size
20
+ */
21
+ /**
22
+ * @typedef GetJobCodeMetricsParam
23
+ * @property {string} code - Code
24
+ * @property {number} [pageNo] - Page Number
25
+ * @property {number} [pageSize] - Page Size
26
+ * @property {string} [status] - Status
27
+ * @property {string} [date] - From Date
28
+ */
29
+ /**
30
+ * @typedef GetJobCodesByCompanyAndIntegrationParam
31
+ * @property {string} integrationId - Integration Id
32
+ * @property {number} [pageNo] - Page Number
33
+ * @property {number} [pageSize] - Page Size
34
+ */
35
+ /** @typedef GetJobConfigDefaultsParam */
36
+ /**
37
+ * @typedef GetJobStepsParam
38
+ * @property {number} jobId - Job Id
39
+ */
40
+ /**
41
+ * @typedef GetJobsByCompanyParam
42
+ * @property {number} [pageNo] - Page Number
43
+ * @property {number} [pageSize] - Page Size
44
+ */
45
+ /**
46
+ * @typedef SuppressStoresParam
47
+ * @property {InventoryPlatformModel.SuppressStorePayload} body
48
+ */
49
+ /**
50
+ * @typedef UpdateJobParam
51
+ * @property {InventoryPlatformModel.JobConfigDTO} body
52
+ */
53
+ declare class InventoryPlatformValidator {
54
+ /** @returns {CreateJobParam} */
55
+ static createJob(): CreateJobParam;
56
+ /** @returns {DisableParam} */
57
+ static disable(): DisableParam;
58
+ /** @returns {GetConfigByCompanyParam} */
5
59
  static getConfigByCompany(): any;
6
- static getJobByCode(): any;
7
- static getJobByCompanyAndIntegration(): any;
8
- static getJobCodeMetrics(): any;
9
- static getJobCodesByCompanyAndIntegration(): any;
60
+ /** @returns {GetJobByCodeParam} */
61
+ static getJobByCode(): GetJobByCodeParam;
62
+ /** @returns {GetJobByCompanyAndIntegrationParam} */
63
+ static getJobByCompanyAndIntegration(): GetJobByCompanyAndIntegrationParam;
64
+ /** @returns {GetJobCodeMetricsParam} */
65
+ static getJobCodeMetrics(): GetJobCodeMetricsParam;
66
+ /** @returns {GetJobCodesByCompanyAndIntegrationParam} */
67
+ static getJobCodesByCompanyAndIntegration(): GetJobCodesByCompanyAndIntegrationParam;
68
+ /** @returns {GetJobConfigDefaultsParam} */
10
69
  static getJobConfigDefaults(): any;
11
- static getJobSteps(): any;
12
- static getJobsByCompany(): any;
13
- static suppressStores(): any;
14
- static updateJob(): any;
70
+ /** @returns {GetJobStepsParam} */
71
+ static getJobSteps(): GetJobStepsParam;
72
+ /** @returns {GetJobsByCompanyParam} */
73
+ static getJobsByCompany(): GetJobsByCompanyParam;
74
+ /** @returns {SuppressStoresParam} */
75
+ static suppressStores(): SuppressStoresParam;
76
+ /** @returns {UpdateJobParam} */
77
+ static updateJob(): UpdateJobParam;
15
78
  }
79
+ declare namespace InventoryPlatformValidator {
80
+ export { CreateJobParam, DisableParam, GetConfigByCompanyParam, GetJobByCodeParam, GetJobByCompanyAndIntegrationParam, GetJobCodeMetricsParam, GetJobCodesByCompanyAndIntegrationParam, GetJobConfigDefaultsParam, GetJobStepsParam, GetJobsByCompanyParam, SuppressStoresParam, UpdateJobParam };
81
+ }
82
+ type CreateJobParam = {
83
+ body: InventoryPlatformModel.JobConfigDTO;
84
+ };
85
+ type DisableParam = {
86
+ /**
87
+ * - IntegrationId
88
+ */
89
+ integrationId: string;
90
+ };
91
+ type GetJobByCodeParam = {
92
+ /**
93
+ * - Job Code
94
+ */
95
+ code: string;
96
+ };
97
+ type GetJobByCompanyAndIntegrationParam = {
98
+ /**
99
+ * - Integration Id
100
+ */
101
+ integrationId: string;
102
+ /**
103
+ * - Page Number
104
+ */
105
+ pageNo?: number;
106
+ /**
107
+ * - Page Size
108
+ */
109
+ pageSize?: number;
110
+ };
111
+ type GetJobCodeMetricsParam = {
112
+ /**
113
+ * - Code
114
+ */
115
+ code: string;
116
+ /**
117
+ * - Page Number
118
+ */
119
+ pageNo?: number;
120
+ /**
121
+ * - Page Size
122
+ */
123
+ pageSize?: number;
124
+ /**
125
+ * - Status
126
+ */
127
+ status?: string;
128
+ /**
129
+ * - From Date
130
+ */
131
+ date?: string;
132
+ };
133
+ type GetJobCodesByCompanyAndIntegrationParam = {
134
+ /**
135
+ * - Integration Id
136
+ */
137
+ integrationId: string;
138
+ /**
139
+ * - Page Number
140
+ */
141
+ pageNo?: number;
142
+ /**
143
+ * - Page Size
144
+ */
145
+ pageSize?: number;
146
+ };
147
+ type GetJobStepsParam = {
148
+ /**
149
+ * - Job Id
150
+ */
151
+ jobId: number;
152
+ };
153
+ type GetJobsByCompanyParam = {
154
+ /**
155
+ * - Page Number
156
+ */
157
+ pageNo?: number;
158
+ /**
159
+ * - Page Size
160
+ */
161
+ pageSize?: number;
162
+ };
163
+ type SuppressStoresParam = {
164
+ body: InventoryPlatformModel.SuppressStorePayload;
165
+ };
166
+ type UpdateJobParam = {
167
+ body: InventoryPlatformModel.JobConfigDTO;
168
+ };
169
+ type GetConfigByCompanyParam = any;
170
+ type GetJobConfigDefaultsParam = any;
171
+ import InventoryPlatformModel = require("./InventoryPlatformModel");
@@ -1,29 +1,98 @@
1
1
  const Joi = require("joi");
2
2
 
3
- const InventoryModel = require("./InventoryPlatformModel");
4
- class InventoryValidator {
3
+ const InventoryPlatformModel = require("./InventoryPlatformModel");
4
+
5
+ /**
6
+ * @typedef CreateJobParam
7
+ * @property {InventoryPlatformModel.JobConfigDTO} body
8
+ */
9
+
10
+ /**
11
+ * @typedef DisableParam
12
+ * @property {string} integrationId - IntegrationId
13
+ */
14
+
15
+ /** @typedef GetConfigByCompanyParam */
16
+
17
+ /**
18
+ * @typedef GetJobByCodeParam
19
+ * @property {string} code - Job Code
20
+ */
21
+
22
+ /**
23
+ * @typedef GetJobByCompanyAndIntegrationParam
24
+ * @property {string} integrationId - Integration Id
25
+ * @property {number} [pageNo] - Page Number
26
+ * @property {number} [pageSize] - Page Size
27
+ */
28
+
29
+ /**
30
+ * @typedef GetJobCodeMetricsParam
31
+ * @property {string} code - Code
32
+ * @property {number} [pageNo] - Page Number
33
+ * @property {number} [pageSize] - Page Size
34
+ * @property {string} [status] - Status
35
+ * @property {string} [date] - From Date
36
+ */
37
+
38
+ /**
39
+ * @typedef GetJobCodesByCompanyAndIntegrationParam
40
+ * @property {string} integrationId - Integration Id
41
+ * @property {number} [pageNo] - Page Number
42
+ * @property {number} [pageSize] - Page Size
43
+ */
44
+
45
+ /** @typedef GetJobConfigDefaultsParam */
46
+
47
+ /**
48
+ * @typedef GetJobStepsParam
49
+ * @property {number} jobId - Job Id
50
+ */
51
+
52
+ /**
53
+ * @typedef GetJobsByCompanyParam
54
+ * @property {number} [pageNo] - Page Number
55
+ * @property {number} [pageSize] - Page Size
56
+ */
57
+
58
+ /**
59
+ * @typedef SuppressStoresParam
60
+ * @property {InventoryPlatformModel.SuppressStorePayload} body
61
+ */
62
+
63
+ /**
64
+ * @typedef UpdateJobParam
65
+ * @property {InventoryPlatformModel.JobConfigDTO} body
66
+ */
67
+
68
+ class InventoryPlatformValidator {
69
+ /** @returns {CreateJobParam} */
5
70
  static createJob() {
6
71
  return Joi.object({
7
- body: InventoryModel.JobConfigDTO().required(),
72
+ body: InventoryPlatformModel.JobConfigDTO().required(),
8
73
  }).required();
9
74
  }
10
75
 
76
+ /** @returns {DisableParam} */
11
77
  static disable() {
12
78
  return Joi.object({
13
79
  integrationId: Joi.string().allow("").required(),
14
80
  }).required();
15
81
  }
16
82
 
83
+ /** @returns {GetConfigByCompanyParam} */
17
84
  static getConfigByCompany() {
18
85
  return Joi.object({}).required();
19
86
  }
20
87
 
88
+ /** @returns {GetJobByCodeParam} */
21
89
  static getJobByCode() {
22
90
  return Joi.object({
23
91
  code: Joi.string().allow("").required(),
24
92
  }).required();
25
93
  }
26
94
 
95
+ /** @returns {GetJobByCompanyAndIntegrationParam} */
27
96
  static getJobByCompanyAndIntegration() {
28
97
  return Joi.object({
29
98
  integrationId: Joi.string().allow("").required(),
@@ -32,6 +101,7 @@ class InventoryValidator {
32
101
  }).required();
33
102
  }
34
103
 
104
+ /** @returns {GetJobCodeMetricsParam} */
35
105
  static getJobCodeMetrics() {
36
106
  return Joi.object({
37
107
  code: Joi.string().allow("").required(),
@@ -42,6 +112,7 @@ class InventoryValidator {
42
112
  }).required();
43
113
  }
44
114
 
115
+ /** @returns {GetJobCodesByCompanyAndIntegrationParam} */
45
116
  static getJobCodesByCompanyAndIntegration() {
46
117
  return Joi.object({
47
118
  integrationId: Joi.string().allow("").required(),
@@ -50,16 +121,19 @@ class InventoryValidator {
50
121
  }).required();
51
122
  }
52
123
 
124
+ /** @returns {GetJobConfigDefaultsParam} */
53
125
  static getJobConfigDefaults() {
54
126
  return Joi.object({}).required();
55
127
  }
56
128
 
129
+ /** @returns {GetJobStepsParam} */
57
130
  static getJobSteps() {
58
131
  return Joi.object({
59
132
  jobId: Joi.number().required(),
60
133
  }).required();
61
134
  }
62
135
 
136
+ /** @returns {GetJobsByCompanyParam} */
63
137
  static getJobsByCompany() {
64
138
  return Joi.object({
65
139
  pageNo: Joi.number(),
@@ -67,17 +141,19 @@ class InventoryValidator {
67
141
  }).required();
68
142
  }
69
143
 
144
+ /** @returns {SuppressStoresParam} */
70
145
  static suppressStores() {
71
146
  return Joi.object({
72
- body: InventoryModel.SuppressStorePayload().required(),
147
+ body: InventoryPlatformModel.SuppressStorePayload().required(),
73
148
  }).required();
74
149
  }
75
150
 
151
+ /** @returns {UpdateJobParam} */
76
152
  static updateJob() {
77
153
  return Joi.object({
78
- body: InventoryModel.JobConfigDTO().required(),
154
+ body: InventoryPlatformModel.JobConfigDTO().required(),
79
155
  }).required();
80
156
  }
81
157
  }
82
158
 
83
- module.exports = InventoryValidator;
159
+ module.exports = InventoryPlatformValidator;
@@ -4,148 +4,142 @@ declare class Lead {
4
4
  config: any;
5
5
  applicationId: any;
6
6
  /**
7
- * @param {Object} arg - Arg object.
8
- * @param {string} arg.uniqueName - Unique name of Video Room
9
- * @returns {Promise<CloseVideoRoomResponse>} - Success response
7
+ * @param {LeadPlatformApplicationValidator.CloseVideoRoomParam} arg - Arg object
8
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
9
+ * @param {import("../PlatformAPIClient").Options} - Options
10
+ * @returns {Promise<LeadPlatformModel.CloseVideoRoomResponse>} - Success response
11
+ * @name closeVideoRoom
10
12
  * @summary: Close the video room and force all participants to leave.
11
- * @description: Close the video room and force all participants to leave.
13
+ * @description: Close the video room and force all participants to leave. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/closeVideoRoom/).
12
14
  */
13
- closeVideoRoom({ uniqueName }?: {
14
- uniqueName: string;
15
- }): Promise<CloseVideoRoomResponse>;
15
+ closeVideoRoom({ uniqueName, requestHeaders }?: LeadPlatformApplicationValidator.CloseVideoRoomParam, { responseHeaders }?: object): Promise<LeadPlatformModel.CloseVideoRoomResponse>;
16
16
  /**
17
- * @param {Object} arg - Arg object.
18
- * @param {CreateCustomFormPayload} arg.body
19
- * @returns {Promise<CustomForm>} - Success response
17
+ * @param {LeadPlatformApplicationValidator.CreateCustomFormParam} arg - Arg object
18
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
19
+ * @param {import("../PlatformAPIClient").Options} - Options
20
+ * @returns {Promise<LeadPlatformModel.CustomForm>} - Success response
21
+ * @name createCustomForm
20
22
  * @summary: Creates a new custom form
21
- * @description: Creates a new custom form for given application
23
+ * @description: Creates a new custom form for given application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/createCustomForm/).
22
24
  */
23
- createCustomForm({ body }?: {
24
- body: CreateCustomFormPayload;
25
- }): Promise<CustomForm>;
25
+ createCustomForm({ body, requestHeaders }?: LeadPlatformApplicationValidator.CreateCustomFormParam, { responseHeaders }?: object): Promise<LeadPlatformModel.CustomForm>;
26
26
  /**
27
- * @param {Object} arg - Arg object.
28
- * @param {string} arg.id - Ticket ID for which history is created
29
- * @param {TicketHistoryPayload} arg.body
30
- * @returns {Promise<TicketHistory>} - Success response
27
+ * @param {LeadPlatformApplicationValidator.CreateHistoryParam} arg - Arg object
28
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
29
+ * @param {import("../PlatformAPIClient").Options} - Options
30
+ * @returns {Promise<LeadPlatformModel.TicketHistory>} - Success response
31
+ * @name createHistory
31
32
  * @summary: Create history for specific application level ticket
32
- * @description: Create history for specific application level ticket, this history is seen on ticket detail page, this can be comment, log or rating.
33
+ * @description: Create history for specific application 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/).
33
34
  */
34
- createHistory({ id, body }?: {
35
- id: string;
36
- body: TicketHistoryPayload;
37
- }): Promise<TicketHistory>;
35
+ createHistory({ id, body, requestHeaders }?: LeadPlatformApplicationValidator.CreateHistoryParam, { responseHeaders }?: object): Promise<LeadPlatformModel.TicketHistory>;
38
36
  /**
39
- * @param {Object} arg - Arg object.
40
- * @param {string} arg.slug - Slug of form whose response is getting submitted
41
- * @param {EditCustomFormPayload} arg.body
42
- * @returns {Promise<CustomForm>} - Success response
37
+ * @param {LeadPlatformApplicationValidator.EditCustomFormParam} arg - Arg object
38
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
39
+ * @param {import("../PlatformAPIClient").Options} - Options
40
+ * @returns {Promise<LeadPlatformModel.CustomForm>} - Success response
41
+ * @name editCustomForm
43
42
  * @summary: Edit the given custom form
44
- * @description: Edit the given custom form field such as adding or deleting input, assignee, title, decription, notification and polling information.
43
+ * @description: Edit the given custom form field such as adding or deleting input, assignee, title, decription, notification and polling information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/editCustomForm/).
45
44
  */
46
- editCustomForm({ slug, body }?: {
47
- slug: string;
48
- body: EditCustomFormPayload;
49
- }): Promise<CustomForm>;
45
+ editCustomForm({ slug, body, requestHeaders }?: LeadPlatformApplicationValidator.EditCustomFormParam, { responseHeaders }?: object): Promise<LeadPlatformModel.CustomForm>;
50
46
  /**
51
- * @param {Object} arg - Arg object.
52
- * @param {string} arg.id - Ticket ID of ticket to be edited
53
- * @param {EditTicketPayload} arg.body
54
- * @returns {Promise<Ticket>} - Success response
47
+ * @param {LeadPlatformApplicationValidator.EditTicketParam} arg - Arg object
48
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
49
+ * @param {import("../PlatformAPIClient").Options} - Options
50
+ * @returns {Promise<LeadPlatformModel.Ticket>} - Success response
51
+ * @name editTicket
55
52
  * @summary: Edits ticket details of a application level ticket
56
- * @description: Edits ticket details of a application level ticket such as status, priority, category, tags, attachments, assigne & ticket content changes
53
+ * @description: Edits ticket details of a application 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/).
57
54
  */
58
- editTicket({ id, body }?: {
59
- id: string;
60
- body: EditTicketPayload;
61
- }): Promise<Ticket>;
55
+ editTicket({ id, body, requestHeaders }?: LeadPlatformApplicationValidator.EditTicketParam, { responseHeaders }?: object): Promise<LeadPlatformModel.Ticket>;
62
56
  /**
63
- * @param {Object} arg - Arg object.
64
- * @param {string} arg.slug - Slug of form whose response is getting submitted
65
- * @returns {Promise<CustomForm>} - Success response
57
+ * @param {LeadPlatformApplicationValidator.GetCustomFormParam} arg - Arg object
58
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
59
+ * @param {import("../PlatformAPIClient").Options} - Options
60
+ * @returns {Promise<LeadPlatformModel.CustomForm>} - Success response
61
+ * @name getCustomForm
66
62
  * @summary: Get specific custom form using it's slug
67
- * @description: Get specific custom form using it's slug, this is used to view the form.
63
+ * @description: Get specific custom form using it's slug, this is used to view the form. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getCustomForm/).
68
64
  */
69
- getCustomForm({ slug }?: {
70
- slug: string;
71
- }): Promise<CustomForm>;
65
+ getCustomForm({ slug, requestHeaders }?: LeadPlatformApplicationValidator.GetCustomFormParam, { responseHeaders }?: object): Promise<LeadPlatformModel.CustomForm>;
72
66
  /**
73
- * @param {Object} arg - Arg object.
74
- * @returns {Promise<CustomFormList>} - Success response
67
+ * @param {LeadPlatformApplicationValidator.GetCustomFormsParam} arg - Arg object
68
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
69
+ * @param {import("../PlatformAPIClient").Options} - Options
70
+ * @returns {Promise<LeadPlatformModel.CustomFormList>} - Success response
71
+ * @name getCustomForms
75
72
  * @summary: Get list of custom form
76
- * @description: Get list of custom form for given application
73
+ * @description: Get list of custom form for given application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getCustomForms/).
77
74
  */
78
- getCustomForms({}?: any): Promise<CustomFormList>;
75
+ getCustomForms({ requestHeaders }?: any, { responseHeaders }?: object): Promise<LeadPlatformModel.CustomFormList>;
79
76
  /**
80
- * @param {Object} arg - Arg object.
81
- * @param {string} arg.id - Tiket ID of the ticket to be fetched
82
- * @returns {Promise<Ticket>} - Success response
77
+ * @param {LeadPlatformApplicationValidator.GetTicketParam} arg - Arg object
78
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
79
+ * @param {import("../PlatformAPIClient").Options} - Options
80
+ * @returns {Promise<LeadPlatformModel.Ticket>} - Success response
81
+ * @name getTicket
83
82
  * @summary: Retreives ticket details of a application level ticket
84
- * @description: Retreives ticket details of a application level ticket with ticket ID
83
+ * @description: Retreives ticket details of a application level ticket with ticket ID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getTicket/).
85
84
  */
86
- getTicket({ id }?: {
87
- id: string;
88
- }): Promise<Ticket>;
85
+ getTicket({ id, requestHeaders }?: LeadPlatformApplicationValidator.GetTicketParam, { responseHeaders }?: object): Promise<LeadPlatformModel.Ticket>;
89
86
  /**
90
- * @param {Object} arg - Arg object.
91
- * @param {string} arg.id - Ticket ID for which history is to be fetched
92
- * @returns {Promise<TicketHistoryList>} - Success response
87
+ * @param {LeadPlatformApplicationValidator.GetTicketHistoryParam} arg - Arg object
88
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
89
+ * @param {import("../PlatformAPIClient").Options} - Options
90
+ * @returns {Promise<LeadPlatformModel.TicketHistoryList>} - Success response
91
+ * @name getTicketHistory
93
92
  * @summary: Gets history list for specific application level ticket
94
- * @description: Gets history list for specific application level ticket, this history is seen on ticket detail page, this can be comment, log or rating.
93
+ * @description: Gets history list for specific application 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/).
95
94
  */
96
- getTicketHistory({ id }?: {
97
- id: string;
98
- }): Promise<TicketHistoryList>;
95
+ getTicketHistory({ id, requestHeaders }?: LeadPlatformApplicationValidator.GetTicketHistoryParam, { responseHeaders }?: object): Promise<LeadPlatformModel.TicketHistoryList>;
99
96
  /**
100
- * @param {Object} arg - Arg object.
101
- * @param {boolean} [arg.items] - Decides that the reponse will contain the
102
- * list of tickets
103
- * @param {boolean} [arg.filters] - Decides that the reponse will contain
104
- * the ticket filters
105
- * @param {string} [arg.q] - Search through ticket titles and description
106
- * @param {string} [arg.status] - Filter tickets on status
107
- * @param {PriorityEnum} [arg.priority] - Filter tickets on priority
108
- * @param {string} [arg.category] - Filter tickets on category
109
- * @returns {Promise<TicketList>} - Success response
97
+ * @param {LeadPlatformApplicationValidator.GetTicketsParam} arg - Arg object
98
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
99
+ * @param {import("../PlatformAPIClient").Options} - Options
100
+ * @returns {Promise<LeadPlatformModel.TicketList>} - Success response
101
+ * @name getTickets
110
102
  * @summary: Gets the list of Application level Tickets and/or ticket filters depending on query params
111
- * @description: Gets the list of Application level Tickets and/or ticket filters
103
+ * @description: Gets the list of Application level Tickets and/or ticket filters - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getTickets/).
112
104
  */
113
- getTickets({ items, filters, q, status, priority, category }?: {
114
- items?: boolean;
115
- filters?: boolean;
116
- q?: string;
117
- status?: string;
118
- priority?: PriorityEnum;
119
- category?: string;
120
- }): Promise<TicketList>;
105
+ getTickets({ items, filters, q, status, priority, category, requestHeaders }?: LeadPlatformApplicationValidator.GetTicketsParam, { responseHeaders }?: object): Promise<LeadPlatformModel.TicketList>;
121
106
  /**
122
- * @param {Object} arg - Arg object.
123
- * @param {string} arg.uniqueName - Unique name of video room
124
- * @returns {Promise<GetTokenForVideoRoomResponse>} - Success response
107
+ * @param {LeadPlatformApplicationValidator.GetTokenForVideoRoomParam} arg
108
+ * - Arg object
109
+ *
110
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
111
+ * @param {import("../PlatformAPIClient").Options} - Options
112
+ * @returns {Promise<LeadPlatformModel.GetTokenForVideoRoomResponse>} -
113
+ * Success response
114
+ * @name getTokenForVideoRoom
125
115
  * @summary: Get Token to join a specific Video Room using it's unqiue name
126
- * @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.
116
+ * @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/).
127
117
  */
128
- getTokenForVideoRoom({ uniqueName }?: {
129
- uniqueName: string;
130
- }): Promise<GetTokenForVideoRoomResponse>;
118
+ getTokenForVideoRoom({ uniqueName, requestHeaders }?: LeadPlatformApplicationValidator.GetTokenForVideoRoomParam, { responseHeaders }?: object): Promise<LeadPlatformModel.GetTokenForVideoRoomResponse>;
131
119
  /**
132
- * @param {Object} arg - Arg object.
133
- * @param {string} arg.uniqueName - Unique name of Video Room
134
- * @returns {Promise<GetParticipantsInsideVideoRoomResponse>} - Success response
120
+ * @param {LeadPlatformApplicationValidator.GetVideoParticipantsParam} arg
121
+ * - Arg object
122
+ *
123
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
124
+ * @param {import("../PlatformAPIClient").Options} - Options
125
+ * @returns {Promise<LeadPlatformModel.GetParticipantsInsideVideoRoomResponse>}
126
+ * - Success response
127
+ *
128
+ * @name getVideoParticipants
135
129
  * @summary: Get participants of a specific Video Room using it's unique name
136
- * @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.
130
+ * @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/).
137
131
  */
138
- getVideoParticipants({ uniqueName }?: {
139
- uniqueName: string;
140
- }): Promise<GetParticipantsInsideVideoRoomResponse>;
132
+ getVideoParticipants({ uniqueName, requestHeaders }?: LeadPlatformApplicationValidator.GetVideoParticipantsParam, { responseHeaders }?: object): Promise<LeadPlatformModel.GetParticipantsInsideVideoRoomResponse>;
141
133
  /**
142
- * @param {Object} arg - Arg object.
143
- * @param {CreateVideoRoomPayload} arg.body
144
- * @returns {Promise<CreateVideoRoomResponse>} - Success response
134
+ * @param {LeadPlatformApplicationValidator.OpenVideoRoomParam} arg - Arg object
135
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
136
+ * @param {import("../PlatformAPIClient").Options} - Options
137
+ * @returns {Promise<LeadPlatformModel.CreateVideoRoomResponse>} - Success response
138
+ * @name openVideoRoom
145
139
  * @summary: Open a video room.
146
- * @description: Open a video room.
140
+ * @description: Open a video room. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/openVideoRoom/).
147
141
  */
148
- openVideoRoom({ body }?: {
149
- body: CreateVideoRoomPayload;
150
- }): Promise<CreateVideoRoomResponse>;
142
+ openVideoRoom({ body, requestHeaders }?: LeadPlatformApplicationValidator.OpenVideoRoomParam, { responseHeaders }?: object): Promise<LeadPlatformModel.CreateVideoRoomResponse>;
151
143
  }
144
+ import LeadPlatformApplicationValidator = require("./LeadPlatformApplicationValidator");
145
+ import LeadPlatformModel = require("./LeadPlatformModel");