@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,131 +1,297 @@
1
1
  const Joi = require("joi");
2
2
 
3
- class LeadModel {
3
+ /**
4
+ * @typedef AddTicketPayload
5
+ * @property {Object} [_custom_json] - Optional custom data that needs to be sent
6
+ * @property {string} category - Category of the ticket
7
+ * @property {TicketContent} content
8
+ * @property {Object} [created_by] - Creator of the ticket
9
+ * @property {PriorityEnum} [priority]
10
+ * @property {string} [status] - Status of the ticket
11
+ * @property {string[]} [subscribers]
12
+ */
13
+
14
+ /**
15
+ * @typedef CreatedOn
16
+ * @property {string} user_agent - Useragent details
17
+ */
18
+
19
+ /**
20
+ * @typedef CustomForm
21
+ * @property {string} _id - Unique identifier for the form
22
+ * @property {string} application_id - Application ID for form
23
+ * @property {CreatedOn} [created_on]
24
+ * @property {string} [description] - Form description that will be shown to the user
25
+ * @property {string} [header_image] - Form header image that will be shown to the user
26
+ * @property {Object[]} inputs - List of all the form fields
27
+ * @property {boolean} login_required - Denotes if login is required to make a
28
+ * form response submission
29
+ * @property {PollForAssignment} [poll_for_assignment]
30
+ * @property {Priority} priority
31
+ * @property {boolean} should_notify - Denotes if new response submission for
32
+ * the form should be notified to the assignees
33
+ * @property {string} slug - Slug for the form, which is to be used for accessing the form
34
+ * @property {SubmitButton} [submit_button]
35
+ * @property {string} [success_message] - Message that is to be shown on
36
+ * succesfull form response submission
37
+ * @property {string} title - Form title that will be shown to the user
38
+ */
39
+
40
+ /**
41
+ * @typedef CustomFormSubmissionPayload
42
+ * @property {TicketAsset[]} [attachments] - List of all attachments related to the form
43
+ * @property {Object[]} response - Form response
44
+ */
45
+
46
+ /**
47
+ * @typedef Debug
48
+ * @property {string} [platform] - Platform of user
49
+ * @property {string} [source] - Source of user
50
+ */
51
+
52
+ /**
53
+ * @typedef Email
54
+ * @property {boolean} [active] - Denotes if the email is active
55
+ * @property {string} [email] - Email Address
56
+ * @property {boolean} [primary] - Denotes it's the primary email for the account
57
+ * @property {boolean} [verified] - Denotes it's a verified email
58
+ */
59
+
60
+ /**
61
+ * @typedef FeedbackForm
62
+ * @property {Object} [inputs] - Input details for the feed back form
63
+ * @property {Object} [timestamps] - Gives details of category releted data
64
+ * @property {string} [title] - Title for the feed back form
65
+ */
66
+
67
+ /**
68
+ * @typedef GetParticipantsInsideVideoRoomResponse
69
+ * @property {Participant[]} participants - List of participants of the video room
70
+ */
71
+
72
+ /**
73
+ * @typedef GetTokenForVideoRoomResponse
74
+ * @property {string} access_token - Access token to be used for video room
75
+ */
76
+
77
+ /**
78
+ * @typedef Participant
79
+ * @property {string} [identity] - Unique identifier of participant
80
+ * @property {string} [status] - Status of participant
81
+ * @property {UserSchema} [user]
82
+ */
83
+
84
+ /**
85
+ * @typedef PhoneNumber
86
+ * @property {boolean} [active] - Denotes if the phone number is active
87
+ * @property {number} [country_code] - Country code
88
+ * @property {string} [phone] - Phone number
89
+ * @property {boolean} [primary] - Denotes it's the primary phone number for the account
90
+ * @property {boolean} [verified] - Denotes it's a verified phone number
91
+ */
92
+
93
+ /**
94
+ * @typedef PollForAssignment
95
+ * @property {number} duration - Duration for polling of staff
96
+ * @property {string} failure_message - Message if polling failed
97
+ * @property {string} message - Message for polling
98
+ * @property {string} success_message - Message for successful polling
99
+ */
100
+
101
+ /**
102
+ * @typedef Priority
103
+ * @property {string} color - Color for priority
104
+ * @property {string} display - Display text for priority
105
+ * @property {PriorityEnum} key
106
+ */
107
+
108
+ /**
109
+ * @typedef Status
110
+ * @property {string} color - Color for status
111
+ * @property {string} display - Display text for status
112
+ * @property {string} key - Key for status
113
+ */
114
+
115
+ /**
116
+ * @typedef SubmitButton
117
+ * @property {string} background_color - Color for submit button
118
+ * @property {string} title - Title for submit button
119
+ * @property {string} title_color - Title color submit button
120
+ */
121
+
122
+ /**
123
+ * @typedef SubmitCustomFormResponse
124
+ * @property {string} message - Success message for form submission
125
+ * @property {Ticket} [ticket]
126
+ */
127
+
128
+ /**
129
+ * @typedef Ticket
130
+ * @property {Object} [_custom_json] - Custom json relevant to the ticket
131
+ * @property {string} _id - Unique identifier for the ticket
132
+ * @property {Object} [assigned_to] - Details of support staff to whom ticket is assigned
133
+ * @property {TicketCategory} category
134
+ * @property {TicketContent} [content]
135
+ * @property {TicketContext} [context]
136
+ * @property {string} [created_at] - Time when the ticket was created
137
+ * @property {Object} [created_by] - User details of ticket creator
138
+ * @property {CreatedOn} [created_on]
139
+ * @property {Object} [integration] - Integration type and its details of the ticket
140
+ * @property {boolean} [is_feedback_pending] - Denotes if feedback submission is
141
+ * pending for the ticket
142
+ * @property {Priority} priority
143
+ * @property {string} [response_id] - Details of company and application
144
+ * realated to the ticket
145
+ * @property {TicketSourceEnum} source
146
+ * @property {Status} status
147
+ * @property {string} [sub_category] - Sub-category assigned to the ticket
148
+ * @property {string[]} [tags] - Tags relevant to ticket
149
+ * @property {string} [updated_at] - Time when the ticket was last updated
150
+ */
151
+
152
+ /**
153
+ * @typedef TicketAsset
154
+ * @property {string} [display] - Display text for asset
155
+ * @property {TicketAssetTypeEnum} type
156
+ * @property {string} value - To be used for details
157
+ */
158
+
159
+ /**
160
+ * @typedef TicketCategory
161
+ * @property {string} display - Category display value identifier
162
+ * @property {FeedbackForm} [feedback_form]
163
+ * @property {number} [group_id] - Group id of category releted data
164
+ * @property {string} key - Category key value identifier
165
+ * @property {TicketCategory} [sub_categories]
166
+ */
167
+
168
+ /**
169
+ * @typedef TicketContent
170
+ * @property {TicketAsset[]} [attachments] - List of all attachments related to the ticket
171
+ * @property {string} [description] - Long description of issue
172
+ * @property {string} title - Title for ticket
173
+ */
174
+
175
+ /**
176
+ * @typedef TicketContext
177
+ * @property {string} [application_id] - Application ID related to the ticket
178
+ * @property {string} company_id - Company ID related to the ticket
179
+ */
180
+
181
+ /**
182
+ * @typedef TicketHistory
183
+ * @property {string} _id - Unique identifier of the history event
184
+ * @property {string} [created_at] - Time of creation of the history event
185
+ * @property {Object} [created_by] - User who created the history event
186
+ * @property {CreatedOn} [created_on]
187
+ * @property {string} ticket_id - Readable ticket number
188
+ * @property {string} type - Type of the history event
189
+ * @property {string} [updated_at] - Time of last update of the history event
190
+ * @property {Object} value - Data of the history event
191
+ */
192
+
193
+ /**
194
+ * @typedef TicketHistoryPayload
195
+ * @property {HistoryTypeEnum} type
196
+ * @property {Object} value - Details of history event
197
+ */
198
+
199
+ /**
200
+ * @typedef UserSchema
201
+ * @property {string} [_id]
202
+ * @property {string} [account_type]
203
+ * @property {boolean} [active]
204
+ * @property {string} [application_id]
205
+ * @property {string} [created_at]
206
+ * @property {string} [dob]
207
+ * @property {Email[]} [emails]
208
+ * @property {string} [first_name]
209
+ * @property {string} [gender]
210
+ * @property {string} [last_name]
211
+ * @property {Object} [meta]
212
+ * @property {PhoneNumber[]} [phone_numbers]
213
+ * @property {string} [profile_pic_url]
214
+ * @property {string} [updated_at]
215
+ * @property {string} [user_id]
216
+ * @property {string} [username]
217
+ */
218
+
219
+ /** @typedef {"rating" | "log" | "comment" | "thread"} HistoryTypeEnum */
220
+
221
+ /** @typedef {"low" | "medium" | "high" | "urgent"} PriorityEnum */
222
+
223
+ /**
224
+ * @typedef {| "image"
225
+ * | "video"
226
+ * | "file"
227
+ * | "youtube"
228
+ * | "product"
229
+ * | "collection"
230
+ * | "brand"
231
+ * | "shipment"
232
+ * | "order"} TicketAssetTypeEnum
233
+ */
234
+
235
+ /** @typedef {"platform_panel" | "sales_channel"} TicketSourceEnum */
236
+
237
+ class LeadApplicationModel {
238
+ /** @returns {AddTicketPayload} */
4
239
  static AddTicketPayload() {
5
240
  return Joi.object({
6
241
  _custom_json: Joi.any(),
7
242
  category: Joi.string().allow("").required(),
8
- content: LeadModel.TicketContent().required(),
243
+ content: LeadApplicationModel.TicketContent().required(),
9
244
  created_by: Joi.any(),
10
- priority: LeadModel.PriorityEnum(),
245
+ priority: LeadApplicationModel.PriorityEnum(),
11
246
  status: Joi.string().allow(""),
12
247
  subscribers: Joi.array().items(Joi.string().allow("")),
13
248
  });
14
249
  }
15
- static AgentChangePayload() {
16
- return Joi.object({
17
- agent_id: Joi.string().allow("").required(),
18
- });
19
- }
20
- static CategoryData() {
21
- return Joi.object({
22
- list: LeadModel.TicketCategory(),
23
- });
24
- }
25
- static CloseVideoRoomResponse() {
26
- return Joi.object({
27
- success: Joi.boolean().required(),
28
- });
29
- }
30
- static CommunicationDetails() {
31
- return Joi.object({
32
- description: Joi.string().allow(""),
33
- enabled: Joi.boolean(),
34
- title: Joi.string().allow(""),
35
- type: Joi.string().allow(""),
36
- value: Joi.string().allow(""),
37
- });
38
- }
39
- static CreateCustomFormPayload() {
40
- return Joi.object({
41
- description: Joi.string().allow(""),
42
- header_image: Joi.string().allow(""),
43
- inputs: Joi.array().items(Joi.any()).required(),
44
- poll_for_assignment: LeadModel.PollForAssignment(),
45
- priority: LeadModel.PriorityEnum().required(),
46
- should_notify: Joi.boolean(),
47
- slug: Joi.string().allow("").required(),
48
- success_message: Joi.string().allow(""),
49
- title: Joi.string().allow("").required(),
50
- });
51
- }
250
+
251
+ /** @returns {CreatedOn} */
52
252
  static CreatedOn() {
53
253
  return Joi.object({
54
254
  user_agent: Joi.string().allow("").required(),
55
255
  });
56
256
  }
57
- static CreateVideoRoomPayload() {
58
- return Joi.object({
59
- notify: Joi.array().items(LeadModel.NotifyUser()),
60
- unique_name: Joi.string().allow("").required(),
61
- });
62
- }
63
- static CreateVideoRoomResponse() {
64
- return Joi.object({
65
- unique_name: Joi.string().allow("").required(),
66
- });
67
- }
257
+
258
+ /** @returns {CustomForm} */
68
259
  static CustomForm() {
69
260
  return Joi.object({
70
261
  _id: Joi.string().allow("").required(),
71
262
  application_id: Joi.string().allow("").required(),
72
- created_on: LeadModel.CreatedOn(),
263
+ created_on: LeadApplicationModel.CreatedOn(),
73
264
  description: Joi.string().allow(""),
74
265
  header_image: Joi.string().allow(""),
75
266
  inputs: Joi.array().items(Joi.any()).required(),
76
267
  login_required: Joi.boolean().required(),
77
- poll_for_assignment: LeadModel.PollForAssignment(),
78
- priority: LeadModel.Priority().required(),
268
+ poll_for_assignment: LeadApplicationModel.PollForAssignment(),
269
+ priority: LeadApplicationModel.Priority().required(),
79
270
  should_notify: Joi.boolean().required(),
80
271
  slug: Joi.string().allow("").required(),
81
- submit_button: LeadModel.SubmitButton(),
272
+ submit_button: LeadApplicationModel.SubmitButton(),
82
273
  success_message: Joi.string().allow(""),
83
274
  title: Joi.string().allow("").required(),
84
275
  });
85
276
  }
86
- static CustomFormList() {
87
- return Joi.object({
88
- items: Joi.array().items(LeadModel.CustomForm()),
89
- page: LeadModel.Page(),
90
- });
91
- }
277
+
278
+ /** @returns {CustomFormSubmissionPayload} */
92
279
  static CustomFormSubmissionPayload() {
93
280
  return Joi.object({
94
- attachments: Joi.array().items(LeadModel.TicketAsset()),
281
+ attachments: Joi.array().items(LeadApplicationModel.TicketAsset()),
95
282
  response: Joi.array().items(Joi.any()).required(),
96
283
  });
97
284
  }
285
+
286
+ /** @returns {Debug} */
98
287
  static Debug() {
99
288
  return Joi.object({
100
289
  platform: Joi.string().allow(""),
101
290
  source: Joi.string().allow(""),
102
291
  });
103
292
  }
104
- static EditCustomFormPayload() {
105
- return Joi.object({
106
- description: Joi.string().allow(""),
107
- header_image: Joi.string().allow(""),
108
- inputs: Joi.array().items(Joi.any()).required(),
109
- login_required: Joi.boolean(),
110
- poll_for_assignment: LeadModel.PollForAssignment(),
111
- priority: LeadModel.PriorityEnum().required(),
112
- should_notify: Joi.boolean(),
113
- success_message: Joi.string().allow(""),
114
- title: Joi.string().allow("").required(),
115
- });
116
- }
117
- static EditTicketPayload() {
118
- return Joi.object({
119
- assigned_to: LeadModel.AgentChangePayload(),
120
- category: Joi.string().allow(""),
121
- content: LeadModel.TicketContent(),
122
- priority: LeadModel.PriorityEnum(),
123
- source: Joi.string().allow(""),
124
- status: Joi.string().allow(""),
125
- sub_category: Joi.string().allow(""),
126
- tags: Joi.array().items(Joi.string().allow("")),
127
- });
128
- }
293
+
294
+ /** @returns {Email} */
129
295
  static Email() {
130
296
  return Joi.object({
131
297
  active: Joi.boolean(),
@@ -134,6 +300,8 @@ class LeadModel {
134
300
  verified: Joi.boolean(),
135
301
  });
136
302
  }
303
+
304
+ /** @returns {FeedbackForm} */
137
305
  static FeedbackForm() {
138
306
  return Joi.object({
139
307
  inputs: Joi.any(),
@@ -141,70 +309,33 @@ class LeadModel {
141
309
  title: Joi.string().allow(""),
142
310
  });
143
311
  }
144
- static FeedbackResponseItem() {
145
- return Joi.object({
146
- display: Joi.string().allow("").required(),
147
- key: Joi.string().allow("").required(),
148
- value: Joi.string().allow("").required(),
149
- });
150
- }
151
- static Filter() {
152
- return Joi.object({
153
- assignees: Joi.array().items(Joi.any()).required(),
154
- categories: Joi.array().items(LeadModel.TicketCategory()),
155
- priorities: Joi.array().items(LeadModel.Priority()).required(),
156
- statuses: Joi.array().items(LeadModel.Status()).required(),
157
- });
158
- }
312
+
313
+ /** @returns {GetParticipantsInsideVideoRoomResponse} */
159
314
  static GetParticipantsInsideVideoRoomResponse() {
160
315
  return Joi.object({
161
- participants: Joi.array().items(LeadModel.Participant()).required(),
316
+ participants: Joi.array()
317
+ .items(LeadApplicationModel.Participant())
318
+ .required(),
162
319
  });
163
320
  }
321
+
322
+ /** @returns {GetTokenForVideoRoomResponse} */
164
323
  static GetTokenForVideoRoomResponse() {
165
324
  return Joi.object({
166
325
  access_token: Joi.string().allow("").required(),
167
326
  });
168
327
  }
169
- static IntegrationConfig() {
170
- return Joi.object({
171
- _id: Joi.string().allow(""),
172
- allow_ticket_creation: Joi.boolean().required(),
173
- base_url: Joi.string().allow(""),
174
- category_data: LeadModel.CategoryData(),
175
- category_sync_apikey: Joi.string().allow(""),
176
- config_completed: Joi.boolean(),
177
- create_ticket_apikey: Joi.string().allow(""),
178
- integration_type: Joi.string().allow("").required(),
179
- show_listing: Joi.boolean().required(),
180
- update_ticket_apikey: Joi.string().allow(""),
181
- webhook_apikey: Joi.string().allow(""),
182
- });
183
- }
184
- static NotifyUser() {
185
- return Joi.object({
186
- country_code: Joi.string().allow("").required(),
187
- phone_number: Joi.string().allow("").required(),
188
- });
189
- }
190
- static Page() {
191
- return Joi.object({
192
- current: Joi.number(),
193
- has_next: Joi.boolean(),
194
- has_previous: Joi.boolean(),
195
- item_total: Joi.number(),
196
- next_id: Joi.string().allow(""),
197
- size: Joi.number(),
198
- type: Joi.string().allow("").required(),
199
- });
200
- }
328
+
329
+ /** @returns {Participant} */
201
330
  static Participant() {
202
331
  return Joi.object({
203
332
  identity: Joi.string().allow(""),
204
333
  status: Joi.string().allow(""),
205
- user: LeadModel.UserSchema(),
334
+ user: LeadApplicationModel.UserSchema(),
206
335
  });
207
336
  }
337
+
338
+ /** @returns {PhoneNumber} */
208
339
  static PhoneNumber() {
209
340
  return Joi.object({
210
341
  active: Joi.boolean(),
@@ -214,6 +345,8 @@ class LeadModel {
214
345
  verified: Joi.boolean(),
215
346
  });
216
347
  }
348
+
349
+ /** @returns {PollForAssignment} */
217
350
  static PollForAssignment() {
218
351
  return Joi.object({
219
352
  duration: Joi.number().required(),
@@ -222,13 +355,17 @@ class LeadModel {
222
355
  success_message: Joi.string().allow("").required(),
223
356
  });
224
357
  }
358
+
359
+ /** @returns {Priority} */
225
360
  static Priority() {
226
361
  return Joi.object({
227
362
  color: Joi.string().allow("").required(),
228
363
  display: Joi.string().allow("").required(),
229
- key: LeadModel.PriorityEnum().required(),
364
+ key: LeadApplicationModel.PriorityEnum().required(),
230
365
  });
231
366
  }
367
+
368
+ /** @returns {Status} */
232
369
  static Status() {
233
370
  return Joi.object({
234
371
  color: Joi.string().allow("").required(),
@@ -236,6 +373,8 @@ class LeadModel {
236
373
  key: Joi.string().allow("").required(),
237
374
  });
238
375
  }
376
+
377
+ /** @returns {SubmitButton} */
239
378
  static SubmitButton() {
240
379
  return Joi.object({
241
380
  background_color: Joi.string().allow("").required(),
@@ -243,142 +382,99 @@ class LeadModel {
243
382
  title_color: Joi.string().allow("").required(),
244
383
  });
245
384
  }
385
+
386
+ /** @returns {SubmitCustomFormResponse} */
246
387
  static SubmitCustomFormResponse() {
247
388
  return Joi.object({
248
389
  message: Joi.string().allow("").required(),
249
- ticket: LeadModel.Ticket(),
250
- });
251
- }
252
- static SupportGeneralConfig() {
253
- return Joi.object({
254
- _id: Joi.string().allow(""),
255
- integration: Joi.any(),
256
- show_communication_info: Joi.boolean(),
257
- show_support_dris: Joi.boolean(),
258
- support_communication: LeadModel.CommunicationDetails(),
259
- support_email: LeadModel.CommunicationDetails(),
260
- support_faq: LeadModel.CommunicationDetails(),
261
- support_phone: LeadModel.CommunicationDetails(),
262
- type: Joi.string().allow(""),
390
+ ticket: LeadApplicationModel.Ticket(),
263
391
  });
264
392
  }
393
+
394
+ /** @returns {Ticket} */
265
395
  static Ticket() {
266
396
  return Joi.object({
267
397
  _custom_json: Joi.any(),
268
398
  _id: Joi.string().allow("").required(),
269
399
  assigned_to: Joi.any(),
270
- category: LeadModel.TicketCategory().required(),
271
- content: LeadModel.TicketContent(),
272
- context: LeadModel.TicketContext(),
400
+ category: LeadApplicationModel.TicketCategory().required(),
401
+ content: LeadApplicationModel.TicketContent(),
402
+ context: LeadApplicationModel.TicketContext(),
273
403
  created_at: Joi.string().allow(""),
274
404
  created_by: Joi.any(),
275
- created_on: LeadModel.CreatedOn(),
405
+ created_on: LeadApplicationModel.CreatedOn(),
276
406
  integration: Joi.any(),
277
407
  is_feedback_pending: Joi.boolean(),
278
- priority: LeadModel.Priority().required(),
408
+ priority: LeadApplicationModel.Priority().required(),
279
409
  response_id: Joi.string().allow(""),
280
- source: LeadModel.TicketSourceEnum().required(),
281
- status: LeadModel.Status().required(),
410
+ source: LeadApplicationModel.TicketSourceEnum().required(),
411
+ status: LeadApplicationModel.Status().required(),
282
412
  sub_category: Joi.string().allow(""),
283
413
  tags: Joi.array().items(Joi.string().allow("")),
284
414
  updated_at: Joi.string().allow(""),
285
415
  });
286
416
  }
417
+
418
+ /** @returns {TicketAsset} */
287
419
  static TicketAsset() {
288
420
  return Joi.object({
289
421
  display: Joi.string().allow(""),
290
- type: LeadModel.TicketAssetTypeEnum().required(),
422
+ type: LeadApplicationModel.TicketAssetTypeEnum().required(),
291
423
  value: Joi.string().allow("").required(),
292
424
  });
293
425
  }
426
+
427
+ /** @returns {TicketCategory} */
294
428
  static TicketCategory() {
295
429
  return Joi.object({
296
430
  display: Joi.string().allow("").required(),
297
- feedback_form: LeadModel.FeedbackForm(),
431
+ feedback_form: LeadApplicationModel.FeedbackForm(),
298
432
  group_id: Joi.number(),
299
433
  key: Joi.string().allow("").required(),
300
434
  sub_categories: Joi.link("#TicketCategory"),
301
435
  }).id("TicketCategory");
302
436
  }
437
+
438
+ /** @returns {TicketContent} */
303
439
  static TicketContent() {
304
440
  return Joi.object({
305
- attachments: Joi.array().items(LeadModel.TicketAsset()),
441
+ attachments: Joi.array().items(LeadApplicationModel.TicketAsset()),
306
442
  description: Joi.string().allow(""),
307
443
  title: Joi.string().allow("").required(),
308
444
  });
309
445
  }
446
+
447
+ /** @returns {TicketContext} */
310
448
  static TicketContext() {
311
449
  return Joi.object({
312
450
  application_id: Joi.string().allow(""),
313
451
  company_id: Joi.string().allow("").required(),
314
452
  });
315
453
  }
316
- static TicketFeedback() {
317
- return Joi.object({
318
- _id: Joi.string().allow("").required(),
319
- category: Joi.string().allow(""),
320
- company_id: Joi.string().allow("").required(),
321
- created_at: Joi.string().allow(""),
322
- response: Joi.array().items(LeadModel.FeedbackResponseItem()).required(),
323
- ticket_id: Joi.string().allow("").required(),
324
- updated_at: Joi.string().allow(""),
325
- user: Joi.any(),
326
- });
327
- }
328
- static TicketFeedbackForm() {
329
- return Joi.object({
330
- display: Joi.array().items(Joi.any()),
331
- title: Joi.string().allow("").required(),
332
- });
333
- }
334
- static TicketFeedbackList() {
335
- return Joi.object({
336
- items: Joi.array().items(LeadModel.TicketFeedback()),
337
- });
338
- }
339
- static TicketFeedbackPayload() {
340
- return Joi.object({
341
- form_response: Joi.any(),
342
- });
343
- }
454
+
455
+ /** @returns {TicketHistory} */
344
456
  static TicketHistory() {
345
457
  return Joi.object({
346
458
  _id: Joi.string().allow("").required(),
347
459
  created_at: Joi.string().allow(""),
348
460
  created_by: Joi.any(),
349
- created_on: LeadModel.CreatedOn(),
461
+ created_on: LeadApplicationModel.CreatedOn(),
350
462
  ticket_id: Joi.string().allow("").required(),
351
463
  type: Joi.string().allow("").required(),
352
464
  updated_at: Joi.string().allow(""),
353
465
  value: Joi.any().required(),
354
466
  });
355
467
  }
356
- static TicketHistoryList() {
357
- return Joi.object({
358
- items: Joi.array().items(LeadModel.TicketHistory()),
359
- page: LeadModel.Page(),
360
- });
361
- }
468
+
469
+ /** @returns {TicketHistoryPayload} */
362
470
  static TicketHistoryPayload() {
363
471
  return Joi.object({
364
- type: LeadModel.HistoryTypeEnum().required(),
472
+ type: LeadApplicationModel.HistoryTypeEnum().required(),
365
473
  value: Joi.any().required(),
366
474
  });
367
475
  }
368
- static TicketList() {
369
- return Joi.object({
370
- filters: LeadModel.Filter(),
371
- items: Joi.array().items(LeadModel.Ticket()),
372
- page: LeadModel.Page(),
373
- });
374
- }
375
- static TicketSubCategory() {
376
- return Joi.object({
377
- display: Joi.string().allow("").required(),
378
- key: Joi.string().allow("").required(),
379
- sub_categories: Joi.link("#TicketSubCategory"),
380
- }).id("TicketSubCategory");
381
- }
476
+
477
+ /** @returns {UserSchema} */
382
478
  static UserSchema() {
383
479
  return Joi.object({
384
480
  _id: Joi.string().allow(""),
@@ -387,12 +483,12 @@ class LeadModel {
387
483
  application_id: Joi.string().allow(""),
388
484
  created_at: Joi.string().allow(""),
389
485
  dob: Joi.string().allow(""),
390
- emails: Joi.array().items(LeadModel.Email()),
486
+ emails: Joi.array().items(LeadApplicationModel.Email()),
391
487
  first_name: Joi.string().allow(""),
392
488
  gender: Joi.string().allow(""),
393
489
  last_name: Joi.string().allow(""),
394
490
  meta: Joi.any(),
395
- phone_numbers: Joi.array().items(LeadModel.PhoneNumber()),
491
+ phone_numbers: Joi.array().items(LeadApplicationModel.PhoneNumber()),
396
492
  profile_pic_url: Joi.string().allow(""),
397
493
  updated_at: Joi.string().allow(""),
398
494
  user_id: Joi.string().allow(""),
@@ -400,10 +496,11 @@ class LeadModel {
400
496
  });
401
497
  }
402
498
 
403
- /*
404
- Enum: HistoryTypeEnum
405
- Used By: Lead
406
- */
499
+ /**
500
+ * Enum: HistoryTypeEnum Used By: Lead
501
+ *
502
+ * @returns {HistoryTypeEnum}
503
+ */
407
504
  static HistoryTypeEnum() {
408
505
  return Joi.string().valid(
409
506
  "rating",
@@ -416,10 +513,11 @@ class LeadModel {
416
513
  );
417
514
  }
418
515
 
419
- /*
420
- Enum: PriorityEnum
421
- Used By: Lead
422
- */
516
+ /**
517
+ * Enum: PriorityEnum Used By: Lead
518
+ *
519
+ * @returns {PriorityEnum}
520
+ */
423
521
  static PriorityEnum() {
424
522
  return Joi.string().valid(
425
523
  "low",
@@ -432,10 +530,11 @@ class LeadModel {
432
530
  );
433
531
  }
434
532
 
435
- /*
436
- Enum: TicketAssetTypeEnum
437
- Used By: Lead
438
- */
533
+ /**
534
+ * Enum: TicketAssetTypeEnum Used By: Lead
535
+ *
536
+ * @returns {TicketAssetTypeEnum}
537
+ */
439
538
  static TicketAssetTypeEnum() {
440
539
  return Joi.string().valid(
441
540
  "image",
@@ -458,24 +557,11 @@ class LeadModel {
458
557
  );
459
558
  }
460
559
 
461
- /*
462
- Enum: TicketIntegrationDetails
463
- Used By: Lead
464
- */
465
- static TicketIntegrationDetails() {
466
- return Joi.string().valid(
467
- "default",
468
-
469
- "freshdesk",
470
-
471
- "kapture"
472
- );
473
- }
474
-
475
- /*
476
- Enum: TicketSourceEnum
477
- Used By: Lead
478
- */
560
+ /**
561
+ * Enum: TicketSourceEnum Used By: Lead
562
+ *
563
+ * @returns {TicketSourceEnum}
564
+ */
479
565
  static TicketSourceEnum() {
480
566
  return Joi.string().valid(
481
567
  "platform_panel",
@@ -484,4 +570,4 @@ class LeadModel {
484
570
  );
485
571
  }
486
572
  }
487
- module.exports = LeadModel;
573
+ module.exports = LeadApplicationModel;