@gofynd/fdk-client-javascript 0.1.35

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 (277) hide show
  1. package/.github/workflows/on_create_release.yml +23 -0
  2. package/.github/workflows/on_merge_main.yml +38 -0
  3. package/.github/workflows/on_pull_request.yml +35 -0
  4. package/.prettierrc +5 -0
  5. package/LICENSE +21 -0
  6. package/README.md +118 -0
  7. package/application.d.ts +3 -0
  8. package/application.js +6 -0
  9. package/common.d.ts +4 -0
  10. package/common.js +9 -0
  11. package/documentation/application/CART.md +7290 -0
  12. package/documentation/application/CATALOG.md +9570 -0
  13. package/documentation/application/COMMON.md +448 -0
  14. package/documentation/application/COMMUNICATION.md +463 -0
  15. package/documentation/application/CONFIGURATION.md +2902 -0
  16. package/documentation/application/CONTENT.md +3350 -0
  17. package/documentation/application/FILESTORAGE.md +491 -0
  18. package/documentation/application/LEAD.md +1891 -0
  19. package/documentation/application/LOGISTIC.md +439 -0
  20. package/documentation/application/ORDER.md +3428 -0
  21. package/documentation/application/PAYMENT.md +5035 -0
  22. package/documentation/application/POSCART.md +7889 -0
  23. package/documentation/application/README.md +21 -0
  24. package/documentation/application/REWARDS.md +714 -0
  25. package/documentation/application/SHARE.md +729 -0
  26. package/documentation/application/THEME.md +5796 -0
  27. package/documentation/application/USER.md +4326 -0
  28. package/documentation/platform/ANALYTICS.md +1150 -0
  29. package/documentation/platform/AUDITTRAIL.md +572 -0
  30. package/documentation/platform/BILLING.md +2396 -0
  31. package/documentation/platform/CART.md +5539 -0
  32. package/documentation/platform/CATALOG.md +21624 -0
  33. package/documentation/platform/COMMON.md +448 -0
  34. package/documentation/platform/COMMUNICATION.md +5714 -0
  35. package/documentation/platform/COMPANYPROFILE.md +2141 -0
  36. package/documentation/platform/CONFIGURATION.md +7335 -0
  37. package/documentation/platform/CONTENT.md +8989 -0
  38. package/documentation/platform/DISCOUNT.md +773 -0
  39. package/documentation/platform/FILESTORAGE.md +994 -0
  40. package/documentation/platform/INVENTORY.md +1775 -0
  41. package/documentation/platform/LEAD.md +4736 -0
  42. package/documentation/platform/ORDER.md +3764 -0
  43. package/documentation/platform/PARTNER.md +216 -0
  44. package/documentation/platform/PAYMENT.md +3444 -0
  45. package/documentation/platform/README.md +27 -0
  46. package/documentation/platform/REWARDS.md +871 -0
  47. package/documentation/platform/SHARE.md +602 -0
  48. package/documentation/platform/THEME.md +35725 -0
  49. package/documentation/platform/USER.md +2305 -0
  50. package/documentation/platform/WEBHOOK.md +587 -0
  51. package/documentation/public/CONFIGURATION.md +448 -0
  52. package/documentation/public/INVENTORY.md +686 -0
  53. package/documentation/public/WEBHOOK.md +348 -0
  54. package/index.d.ts +10 -0
  55. package/index.js +18 -0
  56. package/jest.config.d.ts +4 -0
  57. package/jest.config.js +6 -0
  58. package/package.json +35 -0
  59. package/platform.d.ts +3 -0
  60. package/platform.js +6 -0
  61. package/public.d.ts +3 -0
  62. package/public.js +6 -0
  63. package/sdk/application/ApplicationAPIClient.d.ts +11 -0
  64. package/sdk/application/ApplicationAPIClient.js +44 -0
  65. package/sdk/application/ApplicationClient.d.ts +40 -0
  66. package/sdk/application/ApplicationClient.js +84 -0
  67. package/sdk/application/ApplicationConfig.d.ts +19 -0
  68. package/sdk/application/ApplicationConfig.js +55 -0
  69. package/sdk/application/ApplicationModels.d.ts +826 -0
  70. package/sdk/application/ApplicationModels.js +10474 -0
  71. package/sdk/application/client/CartApplicationClient.d.ts +432 -0
  72. package/sdk/application/client/CartApplicationClient.js +1066 -0
  73. package/sdk/application/client/CatalogApplicationClient.d.ts +694 -0
  74. package/sdk/application/client/CatalogApplicationClient.js +1629 -0
  75. package/sdk/application/client/CommonApplicationClient.d.ts +38 -0
  76. package/sdk/application/client/CommonApplicationClient.js +105 -0
  77. package/sdk/application/client/CommunicationApplicationClient.d.ts +39 -0
  78. package/sdk/application/client/CommunicationApplicationClient.js +131 -0
  79. package/sdk/application/client/ConfigurationApplicationClient.d.ts +210 -0
  80. package/sdk/application/client/ConfigurationApplicationClient.js +649 -0
  81. package/sdk/application/client/ContentApplicationClient.d.ts +256 -0
  82. package/sdk/application/client/ContentApplicationClient.js +785 -0
  83. package/sdk/application/client/FileStorageApplicationClient.d.ts +88 -0
  84. package/sdk/application/client/FileStorageApplicationClient.js +214 -0
  85. package/sdk/application/client/LeadApplicationClient.d.ts +90 -0
  86. package/sdk/application/client/LeadApplicationClient.js +264 -0
  87. package/sdk/application/client/LogisticApplicationClient.d.ts +42 -0
  88. package/sdk/application/client/LogisticApplicationClient.js +128 -0
  89. package/sdk/application/client/OrderApplicationClient.d.ts +190 -0
  90. package/sdk/application/client/OrderApplicationClient.js +479 -0
  91. package/sdk/application/client/PaymentApplicationClient.d.ts +454 -0
  92. package/sdk/application/client/PaymentApplicationClient.js +1378 -0
  93. package/sdk/application/client/PosCartApplicationClient.d.ts +449 -0
  94. package/sdk/application/client/PosCartApplicationClient.js +1123 -0
  95. package/sdk/application/client/RewardsApplicationClient.d.ts +93 -0
  96. package/sdk/application/client/RewardsApplicationClient.js +293 -0
  97. package/sdk/application/client/ShareApplicationClient.d.ts +87 -0
  98. package/sdk/application/client/ShareApplicationClient.js +268 -0
  99. package/sdk/application/client/ThemeApplicationClient.d.ts +52 -0
  100. package/sdk/application/client/ThemeApplicationClient.js +161 -0
  101. package/sdk/application/client/UserApplicationClient.d.ts +446 -0
  102. package/sdk/application/client/UserApplicationClient.js +1275 -0
  103. package/sdk/application/constructUrl.d.ts +5 -0
  104. package/sdk/application/constructUrl.js +13 -0
  105. package/sdk/application/index.d.ts +2 -0
  106. package/sdk/application/index.js +4 -0
  107. package/sdk/application/models/CartValidator.d.ts +29 -0
  108. package/sdk/application/models/CartValidator.js +223 -0
  109. package/sdk/application/models/CatalogValidator.d.ts +33 -0
  110. package/sdk/application/models/CatalogValidator.js +233 -0
  111. package/sdk/application/models/CommonValidator.d.ts +5 -0
  112. package/sdk/application/models/CommonValidator.js +18 -0
  113. package/sdk/application/models/CommunicationValidator.d.ts +6 -0
  114. package/sdk/application/models/CommunicationValidator.js +20 -0
  115. package/sdk/application/models/ConfigurationValidator.d.ts +19 -0
  116. package/sdk/application/models/ConfigurationValidator.js +88 -0
  117. package/sdk/application/models/ContentValidator.d.ts +22 -0
  118. package/sdk/application/models/ContentValidator.js +106 -0
  119. package/sdk/application/models/FileStorageValidator.d.ts +6 -0
  120. package/sdk/application/models/FileStorageValidator.js +24 -0
  121. package/sdk/application/models/LeadValidator.d.ts +10 -0
  122. package/sdk/application/models/LeadValidator.js +48 -0
  123. package/sdk/application/models/LogisticValidator.d.ts +6 -0
  124. package/sdk/application/models/LogisticValidator.js +22 -0
  125. package/sdk/application/models/OrderValidator.d.ts +15 -0
  126. package/sdk/application/models/OrderValidator.js +87 -0
  127. package/sdk/application/models/PaymentValidator.d.ts +40 -0
  128. package/sdk/application/models/PaymentValidator.js +235 -0
  129. package/sdk/application/models/PosCartValidator.d.ts +30 -0
  130. package/sdk/application/models/PosCartValidator.js +232 -0
  131. package/sdk/application/models/RewardsValidator.d.ts +10 -0
  132. package/sdk/application/models/RewardsValidator.js +43 -0
  133. package/sdk/application/models/ShareValidator.d.ts +10 -0
  134. package/sdk/application/models/ShareValidator.js +44 -0
  135. package/sdk/application/models/ThemeValidator.d.ts +7 -0
  136. package/sdk/application/models/ThemeValidator.js +27 -0
  137. package/sdk/application/models/UserValidator.d.ts +38 -0
  138. package/sdk/application/models/UserValidator.js +233 -0
  139. package/sdk/common/AxiosHelper.d.ts +1 -0
  140. package/sdk/common/AxiosHelper.js +141 -0
  141. package/sdk/common/Constant.d.ts +294 -0
  142. package/sdk/common/Constant.js +332 -0
  143. package/sdk/common/FDKError.d.ts +26 -0
  144. package/sdk/common/FDKError.js +51 -0
  145. package/sdk/common/Logger.d.ts +2 -0
  146. package/sdk/common/Logger.js +85 -0
  147. package/sdk/common/Paginator.d.ts +16 -0
  148. package/sdk/common/Paginator.js +26 -0
  149. package/sdk/common/RequestSigner.d.ts +1 -0
  150. package/sdk/common/RequestSigner.js +306 -0
  151. package/sdk/common/Utility.d.ts +9 -0
  152. package/sdk/common/Utility.js +86 -0
  153. package/sdk/common/utils.d.ts +14 -0
  154. package/sdk/common/utils.js +165 -0
  155. package/sdk/platform/OAuthClient.d.ts +26 -0
  156. package/sdk/platform/OAuthClient.js +221 -0
  157. package/sdk/platform/PlatformAPIClient.d.ts +12 -0
  158. package/sdk/platform/PlatformAPIClient.js +43 -0
  159. package/sdk/platform/PlatformApplicationClient.d.ts +24398 -0
  160. package/sdk/platform/PlatformApplicationClient.js +23185 -0
  161. package/sdk/platform/PlatformApplicationModels.d.ts +333 -0
  162. package/sdk/platform/PlatformApplicationModels.js +21262 -0
  163. package/sdk/platform/PlatformClient.d.ts +9535 -0
  164. package/sdk/platform/PlatformClient.js +12336 -0
  165. package/sdk/platform/PlatformConfig.d.ts +29 -0
  166. package/sdk/platform/PlatformConfig.js +36 -0
  167. package/sdk/platform/PlatformModels.d.ts +1396 -0
  168. package/sdk/platform/PlatformModels.js +19222 -0
  169. package/sdk/platform/client/AnalyticsPlatformClient.d.ts +84 -0
  170. package/sdk/platform/client/AnalyticsPlatformClient.js +215 -0
  171. package/sdk/platform/client/AuditTrailPlatformClient.d.ts +38 -0
  172. package/sdk/platform/client/AuditTrailPlatformClient.js +133 -0
  173. package/sdk/platform/client/BillingPlatformClient.d.ts +109 -0
  174. package/sdk/platform/client/BillingPlatformClient.js +381 -0
  175. package/sdk/platform/client/CatalogPlatformClient.d.ts +806 -0
  176. package/sdk/platform/client/CatalogPlatformClient.js +2462 -0
  177. package/sdk/platform/client/CommonPlatformClient.d.ts +30 -0
  178. package/sdk/platform/client/CommonPlatformClient.js +84 -0
  179. package/sdk/platform/client/CommunicationPlatformClient.d.ts +26 -0
  180. package/sdk/platform/client/CommunicationPlatformClient.js +72 -0
  181. package/sdk/platform/client/CompanyProfilePlatformClient.d.ts +182 -0
  182. package/sdk/platform/client/CompanyProfilePlatformClient.js +540 -0
  183. package/sdk/platform/client/ConfigurationPlatformClient.d.ts +277 -0
  184. package/sdk/platform/client/ConfigurationPlatformClient.js +806 -0
  185. package/sdk/platform/client/DiscountPlatformClient.d.ts +118 -0
  186. package/sdk/platform/client/DiscountPlatformClient.js +364 -0
  187. package/sdk/platform/client/FileStoragePlatformClient.d.ts +111 -0
  188. package/sdk/platform/client/FileStoragePlatformClient.js +268 -0
  189. package/sdk/platform/client/InventoryPlatformClient.d.ts +125 -0
  190. package/sdk/platform/client/InventoryPlatformClient.js +409 -0
  191. package/sdk/platform/client/LeadPlatformClient.d.ts +150 -0
  192. package/sdk/platform/client/LeadPlatformClient.js +439 -0
  193. package/sdk/platform/client/OrderPlatformClient.d.ts +190 -0
  194. package/sdk/platform/client/OrderPlatformClient.js +521 -0
  195. package/sdk/platform/client/PaymentPlatformClient.d.ts +98 -0
  196. package/sdk/platform/client/PaymentPlatformClient.js +331 -0
  197. package/sdk/platform/client/WebhookPlatformClient.d.ts +64 -0
  198. package/sdk/platform/client/WebhookPlatformClient.js +207 -0
  199. package/sdk/platform/index.d.ts +2 -0
  200. package/sdk/platform/index.js +4 -0
  201. package/sdk/platform/models/AnalyticsValidator.d.ts +7 -0
  202. package/sdk/platform/models/AnalyticsValidator.js +36 -0
  203. package/sdk/platform/models/AuditTrailValidator.d.ts +7 -0
  204. package/sdk/platform/models/AuditTrailValidator.js +26 -0
  205. package/sdk/platform/models/BillingValidator.d.ts +15 -0
  206. package/sdk/platform/models/BillingValidator.js +72 -0
  207. package/sdk/platform/models/CartValidator.d.ts +0 -0
  208. package/sdk/platform/models/CartValidator.js +0 -0
  209. package/sdk/platform/models/CatalogValidator.d.ts +74 -0
  210. package/sdk/platform/models/CatalogValidator.js +484 -0
  211. package/sdk/platform/models/CommonValidator.d.ts +5 -0
  212. package/sdk/platform/models/CommonValidator.js +18 -0
  213. package/sdk/platform/models/CommunicationValidator.d.ts +4 -0
  214. package/sdk/platform/models/CommunicationValidator.js +11 -0
  215. package/sdk/platform/models/CompanyProfileValidator.d.ts +17 -0
  216. package/sdk/platform/models/CompanyProfileValidator.js +93 -0
  217. package/sdk/platform/models/ConfigurationValidator.d.ts +21 -0
  218. package/sdk/platform/models/ConfigurationValidator.js +134 -0
  219. package/sdk/platform/models/ContentValidator.d.ts +0 -0
  220. package/sdk/platform/models/ContentValidator.js +0 -0
  221. package/sdk/platform/models/DiscountValidator.d.ts +13 -0
  222. package/sdk/platform/models/DiscountValidator.js +75 -0
  223. package/sdk/platform/models/FileStorageValidator.d.ts +9 -0
  224. package/sdk/platform/models/FileStorageValidator.js +44 -0
  225. package/sdk/platform/models/InventoryValidator.d.ts +15 -0
  226. package/sdk/platform/models/InventoryValidator.js +81 -0
  227. package/sdk/platform/models/LeadValidator.d.ts +14 -0
  228. package/sdk/platform/models/LeadValidator.js +78 -0
  229. package/sdk/platform/models/OrderValidator.d.ts +14 -0
  230. package/sdk/platform/models/OrderValidator.js +110 -0
  231. package/sdk/platform/models/PartnerValidator.d.ts +0 -0
  232. package/sdk/platform/models/PartnerValidator.js +0 -0
  233. package/sdk/platform/models/PaymentValidator.d.ts +13 -0
  234. package/sdk/platform/models/PaymentValidator.js +65 -0
  235. package/sdk/platform/models/RewardsValidator.d.ts +0 -0
  236. package/sdk/platform/models/RewardsValidator.js +0 -0
  237. package/sdk/platform/models/ShareValidator.d.ts +0 -0
  238. package/sdk/platform/models/ShareValidator.js +0 -0
  239. package/sdk/platform/models/ThemeValidator.d.ts +0 -0
  240. package/sdk/platform/models/ThemeValidator.js +0 -0
  241. package/sdk/platform/models/UserValidator.d.ts +0 -0
  242. package/sdk/platform/models/UserValidator.js +0 -0
  243. package/sdk/platform/models/WebhookValidator.d.ts +9 -0
  244. package/sdk/platform/models/WebhookValidator.js +42 -0
  245. package/sdk/public/PublicAPIClient.d.ts +11 -0
  246. package/sdk/public/PublicAPIClient.js +38 -0
  247. package/sdk/public/PublicClient.d.ts +12 -0
  248. package/sdk/public/PublicClient.js +24 -0
  249. package/sdk/public/PublicConfig.d.ts +10 -0
  250. package/sdk/public/PublicConfig.js +12 -0
  251. package/sdk/public/PublicModels.d.ts +50 -0
  252. package/sdk/public/PublicModels.js +712 -0
  253. package/sdk/public/client/ConfigurationPublicClient.d.ts +38 -0
  254. package/sdk/public/client/ConfigurationPublicClient.js +102 -0
  255. package/sdk/public/client/InventoryPublicClient.d.ts +81 -0
  256. package/sdk/public/client/InventoryPublicClient.js +239 -0
  257. package/sdk/public/client/WebhookPublicClient.d.ts +28 -0
  258. package/sdk/public/client/WebhookPublicClient.js +92 -0
  259. package/sdk/public/constructUrl.d.ts +5 -0
  260. package/sdk/public/constructUrl.js +13 -0
  261. package/sdk/public/index.d.ts +2 -0
  262. package/sdk/public/index.js +4 -0
  263. package/sdk/public/models/ConfigurationValidator.d.ts +5 -0
  264. package/sdk/public/models/ConfigurationValidator.js +18 -0
  265. package/sdk/public/models/InventoryValidator.d.ts +9 -0
  266. package/sdk/public/models/InventoryValidator.js +43 -0
  267. package/sdk/public/models/WebhookValidator.d.ts +5 -0
  268. package/sdk/public/models/WebhookValidator.js +14 -0
  269. package/tests/application/catalog.spec.js +47 -0
  270. package/tests/common/action-url.spec.js +35 -0
  271. package/tests/common/schema/action-url.json +163 -0
  272. package/tests/common/schema/url-action.json +667 -0
  273. package/tests/common/url-action.spec.js +48 -0
  274. package/tests/helpers/cookie.helper.js +31 -0
  275. package/tests/helpers/oauth.helper.js +43 -0
  276. package/tests/platform/catalog.spec.js +49 -0
  277. package/tests/public/location.spec.js +39 -0
@@ -0,0 +1,4736 @@
1
+
2
+
3
+
4
+
5
+ ##### [Back to Platform docs](./README.md)
6
+
7
+ ## Lead Methods
8
+ Handles communication between Administrator <-> Staff and Staff <-> Users
9
+ * [getTickets](#gettickets)
10
+ * [createTicket](#createticket)
11
+ * [getTickets](#gettickets)
12
+ * [getTicket](#getticket)
13
+ * [editTicket](#editticket)
14
+ * [getTicket](#getticket)
15
+ * [editTicket](#editticket)
16
+ * [createHistory](#createhistory)
17
+ * [getTicketHistory](#gettickethistory)
18
+ * [getFeedbacks](#getfeedbacks)
19
+ * [submitFeedback](#submitfeedback)
20
+ * [createHistory](#createhistory)
21
+ * [getTicketHistory](#gettickethistory)
22
+ * [getCustomForm](#getcustomform)
23
+ * [editCustomForm](#editcustomform)
24
+ * [getCustomForms](#getcustomforms)
25
+ * [createCustomForm](#createcustomform)
26
+ * [getTokenForVideoRoom](#gettokenforvideoroom)
27
+ * [getTokenForVideoRoom](#gettokenforvideoroom)
28
+ * [getVideoParticipants](#getvideoparticipants)
29
+ * [getVideoParticipants](#getvideoparticipants)
30
+ * [openVideoRoom](#openvideoroom)
31
+ * [closeVideoRoom](#closevideoroom)
32
+ * [getGeneralConfig](#getgeneralconfig)
33
+
34
+
35
+
36
+ ## Methods with example and description
37
+
38
+
39
+ ### getTickets
40
+ Gets the list of company level tickets and/or ticket filters depending on query params
41
+
42
+
43
+
44
+ ```javascript
45
+ // Promise
46
+ const promise = client.lead.getTickets({ items : value,
47
+ filters : value,
48
+ q : value,
49
+ status : value,
50
+ priority : value,
51
+ category : value,
52
+ pageNo : value,
53
+ pageSize : value });
54
+
55
+ // Async/Await
56
+ const data = await client.lead.getTickets({ items : value,
57
+ filters : value,
58
+ q : value,
59
+ status : value,
60
+ priority : value,
61
+ category : value,
62
+ pageNo : value,
63
+ pageSize : value });
64
+ ```
65
+
66
+
67
+
68
+
69
+
70
+ | Argument | Type | Required | Description |
71
+ | --------- | ----- | -------- | ----------- |
72
+ | items | boolean | no | Decides that the reponse will contain the list of tickets |
73
+ | filters | boolean | no | Decides that the reponse will contain the ticket filters |
74
+ | q | string | no | Search through ticket titles and description |
75
+ | status | string | no | Filter tickets on status |
76
+ | priority | PriorityEnum | no | Filter tickets on priority |
77
+ | category | string | no | Filter tickets on category |
78
+ | pageNo | number | no | The page number to navigate through the given set of results. |
79
+ | pageSize | number | no | Number of items to retrieve in each page. Default is 12. |
80
+
81
+
82
+
83
+ Gets the list of company level tickets and/or ticket filters
84
+
85
+ *Returned Response:*
86
+
87
+
88
+
89
+
90
+ [TicketList](#TicketList)
91
+
92
+ Success
93
+
94
+
95
+
96
+
97
+ <details>
98
+ <summary><i>&nbsp; Examples:</i></summary>
99
+
100
+
101
+ <details>
102
+ <summary><i>&nbsp; Without items</i></summary>
103
+
104
+ ```json
105
+ {
106
+ "value": {
107
+ "filters": {
108
+ "statuses": [
109
+ {
110
+ "display": "Pending",
111
+ "color": "#eae22b",
112
+ "key": "pending"
113
+ },
114
+ {
115
+ "display": "In Progress",
116
+ "color": "#ffa951",
117
+ "key": "in_progress"
118
+ },
119
+ {
120
+ "display": "Resolved",
121
+ "color": "#20c3a6",
122
+ "key": "resolved"
123
+ },
124
+ {
125
+ "display": "Closed",
126
+ "color": "#41434c",
127
+ "key": "closed"
128
+ }
129
+ ],
130
+ "priorities": [
131
+ {
132
+ "display": "Low",
133
+ "color": "#fed766",
134
+ "key": "low"
135
+ },
136
+ {
137
+ "display": "Medium",
138
+ "color": "#f37736",
139
+ "key": "medium"
140
+ },
141
+ {
142
+ "display": "High",
143
+ "color": "#fe4a49",
144
+ "key": "high"
145
+ }
146
+ ],
147
+ "assignees": [],
148
+ "categories": [
149
+ {
150
+ "form": {
151
+ "login_required": false,
152
+ "should_notify": false,
153
+ "inputs": [
154
+ {
155
+ "type": "email",
156
+ "showRegexInput": false,
157
+ "enum": [],
158
+ "regex": "\\S+@\\S+\\.\\S+",
159
+ "display": "email",
160
+ "required": true,
161
+ "key": "email"
162
+ }
163
+ ],
164
+ "available_assignees": [],
165
+ "_id": "602e900a2042255c03cadaf0",
166
+ "title": "service-test-satyen",
167
+ "description": "testing form from service",
168
+ "slug": "service-test-satyen",
169
+ "header_image": "https://hdn-1.addsale.com/x0/support-ticket/files/free/original/KZL86aN5l-service-test-satyen.jpeg",
170
+ "application_id": "000000000000000000000001",
171
+ "created_on": {
172
+ "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 11_2_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.150 Safari/537.36",
173
+ "platform": "web",
174
+ "meta": {
175
+ "browser": {
176
+ "name": "Chrome",
177
+ "version": "88.0.4324.150"
178
+ },
179
+ "os": {
180
+ "name": "macOS",
181
+ "version": "11.2.0"
182
+ },
183
+ "platform": {
184
+ "type": "desktop",
185
+ "vendor": "Apple"
186
+ },
187
+ "engine": {
188
+ "name": "Blink"
189
+ }
190
+ }
191
+ },
192
+ "created_by": "5f8147abbd1a0a870f61f1a6",
193
+ "createdAt": "2021-02-18T16:04:26.495Z",
194
+ "updatedAt": "2021-02-18T16:04:26.495Z",
195
+ "__v": 0
196
+ },
197
+ "key": "service-test-satyen",
198
+ "display": "service-test-satyen"
199
+ }
200
+ ]
201
+ }
202
+ }
203
+ }
204
+ ```
205
+ </details>
206
+
207
+ <details>
208
+ <summary><i>&nbsp; With items</i></summary>
209
+
210
+ ```json
211
+ {
212
+ "value": {
213
+ "docs": [
214
+ {
215
+ "_id": "602d2652ce284d0b008d5c97",
216
+ "status": {
217
+ "display": "Pending",
218
+ "color": "#eae22b",
219
+ "key": "pending"
220
+ },
221
+ "priority": {
222
+ "display": "Medium",
223
+ "color": "#f37736",
224
+ "key": "medium"
225
+ },
226
+ "assigned_to": {
227
+ "agent_id": "5e79e721768c6bf54b783146",
228
+ "gender": "male",
229
+ "accountType": "user",
230
+ "active": true,
231
+ "profilePicUrl": "https://d2co8r51m5ca2d.cloudfront.net/inapp_banners/default_profile_img.png",
232
+ "hasOldPasswordHash": false,
233
+ "_id": "5e79e721768c6bf54b783146",
234
+ "emails": [
235
+ {
236
+ "active": true,
237
+ "primary": true,
238
+ "verified": true,
239
+ "email": "nikhilmshchs@gmail.com"
240
+ },
241
+ {
242
+ "active": true,
243
+ "primary": false,
244
+ "verified": true,
245
+ "email": "nikhilmanapure@gofynd.com"
246
+ },
247
+ {
248
+ "active": true,
249
+ "primary": false,
250
+ "verified": true,
251
+ "email": "nikhilmanapure@fynd.com"
252
+ },
253
+ {
254
+ "active": true,
255
+ "primary": false,
256
+ "verified": true,
257
+ "email": "nikhilmanapure@uniket.store"
258
+ }
259
+ ],
260
+ "phoneNumbers": [
261
+ {
262
+ "active": true,
263
+ "primary": true,
264
+ "verified": true,
265
+ "countryCode": 91,
266
+ "phone": "9890425946"
267
+ }
268
+ ],
269
+ "firstName": "Nikhil",
270
+ "lastName": "Manapure",
271
+ "username": "nikhilmanapure_gofynd_com_29298",
272
+ "createdAt": "2020-03-24T10:55:29.298Z",
273
+ "updatedAt": "2020-05-12T07:46:41.816Z",
274
+ "uid": "5567",
275
+ "__v": 2
276
+ },
277
+ "tags": [
278
+ "asdf444"
279
+ ],
280
+ "context": {
281
+ "application_id": "000000000000000000000001",
282
+ "company_id": "1"
283
+ },
284
+ "created_on": {
285
+ "user_agent": "Fynd Platform/0.0.1 (com.fynd.platform; build:3; iOS 14.2.0) Alamofire/5.0.2",
286
+ "platform": "web",
287
+ "meta": {
288
+ "browser": {
289
+ "name": "Fynd Platform",
290
+ "version": "0.0.1"
291
+ }
292
+ }
293
+ },
294
+ "source": "sales_channel",
295
+ "content": {
296
+ "title": "asdf444 Response",
297
+ "description": "",
298
+ "attachments": []
299
+ },
300
+ "response_id": "602d2652ce284dee3c8d5c96",
301
+ "category": {
302
+ "form": {
303
+ "login_required": false,
304
+ "should_notify": true,
305
+ "inputs": [
306
+ {
307
+ "type": "text",
308
+ "showRegexInput": false,
309
+ "enum": [],
310
+ "display": "asdf",
311
+ "key": "asdf"
312
+ },
313
+ {
314
+ "type": "mobile",
315
+ "showRegexInput": false,
316
+ "enum": [],
317
+ "display": "mob num",
318
+ "regex": "[0-9]{10}$",
319
+ "key": "mob-num"
320
+ }
321
+ ],
322
+ "available_assignees": [
323
+ "5e79e721768c6bf54b783146"
324
+ ],
325
+ "_id": "60124e4a4d2bc363625e1bf4",
326
+ "title": "asdf444",
327
+ "description": "adf",
328
+ "slug": "asdf444",
329
+ "application_id": "000000000000000000000001",
330
+ "created_on": {
331
+ "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.96 Safari/537.36",
332
+ "platform": "web",
333
+ "meta": {
334
+ "browser": {
335
+ "name": "Chrome",
336
+ "version": "88.0.4324.96"
337
+ },
338
+ "os": {
339
+ "name": "macOS",
340
+ "version": "10.15.7",
341
+ "versionName": "Catalina"
342
+ },
343
+ "platform": {
344
+ "type": "desktop",
345
+ "vendor": "Apple"
346
+ },
347
+ "engine": {
348
+ "name": "Blink"
349
+ }
350
+ }
351
+ },
352
+ "created_by": "5e79e721768c6bf54b783146",
353
+ "createdAt": "2021-01-28T05:40:26.271Z",
354
+ "updatedAt": "2021-02-18T16:02:32.086Z",
355
+ "__v": 0,
356
+ "poll_for_assignment": {
357
+ "duration": 20,
358
+ "message": "We are looking for executive to connect you",
359
+ "success_message": "Executive found",
360
+ "failure_message": "All our executives are busy at the moment, We have accepted your request and someone will connect with you soon!"
361
+ }
362
+ },
363
+ "key": "asdf444",
364
+ "display": "asdf444"
365
+ },
366
+ "ticket_id": "472",
367
+ "createdAt": "2021-02-17T14:21:06.774Z",
368
+ "updatedAt": "2021-02-17T14:21:06.774Z",
369
+ "__v": 0,
370
+ "id": "602d2652ce284d0b008d5c97"
371
+ }
372
+ ],
373
+ "total": 472,
374
+ "limit": 10,
375
+ "page": 1,
376
+ "pages": 48,
377
+ "filters": {
378
+ "statuses": [
379
+ {
380
+ "display": "Pending",
381
+ "color": "#eae22b",
382
+ "key": "pending"
383
+ },
384
+ {
385
+ "display": "In Progress",
386
+ "color": "#ffa951",
387
+ "key": "in_progress"
388
+ },
389
+ {
390
+ "display": "Resolved",
391
+ "color": "#20c3a6",
392
+ "key": "resolved"
393
+ },
394
+ {
395
+ "display": "Closed",
396
+ "color": "#41434c",
397
+ "key": "closed"
398
+ }
399
+ ],
400
+ "priorities": [
401
+ {
402
+ "display": "Low",
403
+ "color": "#fed766",
404
+ "key": "low"
405
+ },
406
+ {
407
+ "display": "Medium",
408
+ "color": "#f37736",
409
+ "key": "medium"
410
+ },
411
+ {
412
+ "display": "High",
413
+ "color": "#fe4a49",
414
+ "key": "high"
415
+ }
416
+ ],
417
+ "assignees": [],
418
+ "categories": [
419
+ {
420
+ "form": {
421
+ "login_required": false,
422
+ "should_notify": false,
423
+ "inputs": [
424
+ {
425
+ "type": "email",
426
+ "showRegexInput": false,
427
+ "enum": [],
428
+ "regex": "\\S+@\\S+\\.\\S+",
429
+ "display": "email",
430
+ "required": true,
431
+ "key": "email"
432
+ }
433
+ ],
434
+ "available_assignees": [],
435
+ "_id": "602e900a2042255c03cadaf0",
436
+ "title": "service-test-satyen",
437
+ "description": "testing form from service",
438
+ "slug": "service-test-satyen",
439
+ "header_image": "https://hdn-1.addsale.com/x0/support-ticket/files/free/original/KZL86aN5l-service-test-satyen.jpeg",
440
+ "application_id": "000000000000000000000001",
441
+ "created_on": {
442
+ "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 11_2_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.150 Safari/537.36",
443
+ "platform": "web",
444
+ "meta": {
445
+ "browser": {
446
+ "name": "Chrome",
447
+ "version": "88.0.4324.150"
448
+ },
449
+ "os": {
450
+ "name": "macOS",
451
+ "version": "11.2.0"
452
+ },
453
+ "platform": {
454
+ "type": "desktop",
455
+ "vendor": "Apple"
456
+ },
457
+ "engine": {
458
+ "name": "Blink"
459
+ }
460
+ }
461
+ },
462
+ "created_by": "5f8147abbd1a0a870f61f1a6",
463
+ "createdAt": "2021-02-18T16:04:26.495Z",
464
+ "updatedAt": "2021-02-18T16:04:26.495Z",
465
+ "__v": 0
466
+ },
467
+ "key": "service-test-satyen",
468
+ "display": "service-test-satyen"
469
+ }
470
+ ]
471
+ }
472
+ }
473
+ }
474
+ ```
475
+ </details>
476
+
477
+ </details>
478
+
479
+
480
+
481
+
482
+
483
+
484
+
485
+
486
+
487
+ ---
488
+
489
+
490
+ ### createTicket
491
+ Creates a company level ticket
492
+
493
+
494
+
495
+ ```javascript
496
+ // Promise
497
+ const promise = client.lead.createTicket({ body : value });
498
+
499
+ // Async/Await
500
+ const data = await client.lead.createTicket({ body : value });
501
+ ```
502
+
503
+
504
+
505
+
506
+
507
+ | Argument | Type | Required | Description |
508
+ | --------- | ----- | -------- | ----------- |
509
+ | body | [AddTicketPayload](#AddTicketPayload) | yes | Request body |
510
+
511
+
512
+ Creates a company level ticket
513
+
514
+ *Returned Response:*
515
+
516
+
517
+
518
+
519
+ [Ticket](#Ticket)
520
+
521
+ Success
522
+
523
+
524
+
525
+
526
+ <details>
527
+ <summary><i>&nbsp; Examples:</i></summary>
528
+
529
+
530
+ <details>
531
+ <summary><i>&nbsp; Default</i></summary>
532
+
533
+ ```json
534
+ {
535
+ "value": {
536
+ "context": {
537
+ "company_id": "884"
538
+ },
539
+ "content": {
540
+ "title": "SOme title Response",
541
+ "description": "<b>Single lineeee</b>: asdf<br><b>Email</b>: asdf@asdf.com<br><b>dfsdf</b>: asdf<br>",
542
+ "attachments": []
543
+ },
544
+ "status": {
545
+ "display": "In Progress",
546
+ "color": "#ffa951",
547
+ "key": "in_progress"
548
+ },
549
+ "priority": {
550
+ "display": "Medium",
551
+ "color": "#f37736",
552
+ "key": "medium"
553
+ },
554
+ "assigned_to": {
555
+ "agent_id": "5d1363adf599d850df93175e",
556
+ "gender": "male",
557
+ "accountType": "user",
558
+ "active": true,
559
+ "profilePicUrl": "https://platform-lookaside.fbsbx.com/platform/profilepic/?asid=2136700473091190&height=400&width=400&ext=1554542761&hash=AeS6cuWIdjDdJJ-b",
560
+ "hasOldPasswordHash": false,
561
+ "_id": "5d1363adf599d850df93175e",
562
+ "phoneNumbers": [
563
+ {
564
+ "active": true,
565
+ "primary": true,
566
+ "verified": true,
567
+ "countryCode": 91,
568
+ "phone": "9890425946"
569
+ }
570
+ ],
571
+ "firstName": "Nikhil",
572
+ "lastName": "Manapure",
573
+ "emails": [
574
+ {
575
+ "active": true,
576
+ "primary": true,
577
+ "verified": true,
578
+ "email": "nikhilmshchs@gmail.com"
579
+ }
580
+ ],
581
+ "username": "nikhilmshchs_gmail_com_38425_20500281",
582
+ "createdAt": "2019-01-01T17:22:38.528Z",
583
+ "updatedAt": "2021-01-22T10:02:42.258Z",
584
+ "uid": "20500281",
585
+ "__v": 56
586
+ },
587
+ "tags": [
588
+ "some-title"
589
+ ],
590
+ "_id": "6012f38557751ee8fc162cf7",
591
+ "created_on": {
592
+ "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.96 Safari/537.36",
593
+ "platform": "web",
594
+ "meta": {
595
+ "browser": {
596
+ "name": "Chrome",
597
+ "version": "88.0.4324.96"
598
+ },
599
+ "os": {
600
+ "name": "macOS",
601
+ "version": "10.15.7",
602
+ "versionName": "Catalina"
603
+ },
604
+ "platform": {
605
+ "type": "desktop",
606
+ "vendor": "Apple"
607
+ },
608
+ "engine": {
609
+ "name": "Blink"
610
+ }
611
+ }
612
+ },
613
+ "source": "sales_channel",
614
+ "created_by": {
615
+ "id": "5d1363adf599d850df93175e",
616
+ "user": {
617
+ "gender": "male",
618
+ "accountType": "user",
619
+ "active": true,
620
+ "profilePicUrl": "https://platform-lookaside.fbsbx.com/platform/profilepic/?asid=2136700473091190&height=400&width=400&ext=1554542761&hash=AeS6cuWIdjDdJJ-b",
621
+ "hasOldPasswordHash": false,
622
+ "_id": "5d1363adf599d850df93175e",
623
+ "phoneNumbers": [
624
+ {
625
+ "active": true,
626
+ "primary": true,
627
+ "verified": true,
628
+ "countryCode": 91,
629
+ "phone": "9890425946"
630
+ }
631
+ ],
632
+ "firstName": "Nikhil",
633
+ "lastName": "Manapure",
634
+ "emails": [
635
+ {
636
+ "active": true,
637
+ "primary": true,
638
+ "verified": true,
639
+ "email": "nikhilmshchs@gmail.com"
640
+ }
641
+ ],
642
+ "username": "nikhilmshchs_gmail_com_38425_20500281",
643
+ "createdAt": "2019-01-01T17:22:38.528Z",
644
+ "updatedAt": "2021-01-22T10:02:42.258Z",
645
+ "uid": "20500281",
646
+ "__v": 56
647
+ }
648
+ },
649
+ "response_id": "6012f38457751e0fb8162cf6",
650
+ "category": {
651
+ "form": {
652
+ "login_required": false,
653
+ "should_notify": false,
654
+ "inputs": [
655
+ {
656
+ "required": false,
657
+ "type": "text",
658
+ "enum": [],
659
+ "display": "Single lineeee",
660
+ "key": "single-lineeee",
661
+ "showRegexInput": false
662
+ },
663
+ {
664
+ "required": false,
665
+ "type": "email",
666
+ "enum": [],
667
+ "display": "Email",
668
+ "regex": "\\S+@\\S+\\.\\S+",
669
+ "key": "email",
670
+ "showRegexInput": true
671
+ },
672
+ {
673
+ "required": false,
674
+ "type": "text",
675
+ "enum": [],
676
+ "display": "dfsdf",
677
+ "key": "dfsdf",
678
+ "showRegexInput": false
679
+ }
680
+ ],
681
+ "available_assignees": [
682
+ "5b9b98150df588546aaea6d2",
683
+ "5c45d78395d7504f76c2cb37"
684
+ ],
685
+ "_id": "5fd72db3dc250f8decfc61b2",
686
+ "title": "SOme title",
687
+ "description": "SOme big description",
688
+ "slug": "some-title",
689
+ "application_id": "000000000000000000000003",
690
+ "created_on": {
691
+ "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.88 Safari/537.36",
692
+ "platform": "web",
693
+ "meta": {
694
+ "browser": {
695
+ "name": "Chrome",
696
+ "version": "87.0.4280.88"
697
+ },
698
+ "os": {
699
+ "name": "macOS",
700
+ "version": "10.15.6",
701
+ "versionName": "Catalina"
702
+ },
703
+ "platform": {
704
+ "type": "desktop",
705
+ "vendor": "Apple"
706
+ },
707
+ "engine": {
708
+ "name": "Blink"
709
+ }
710
+ }
711
+ },
712
+ "created_by": "5d1363adf599d850df93175e",
713
+ "createdAt": "2020-12-14T09:17:39.953Z",
714
+ "updatedAt": "2021-01-28T18:48:07.717Z",
715
+ "__v": 0
716
+ },
717
+ "key": "some-title",
718
+ "display": "SOme title"
719
+ },
720
+ "ticket_id": "43",
721
+ "createdAt": "2021-01-28T17:25:25.013Z",
722
+ "updatedAt": "2021-01-28T17:25:33.396Z",
723
+ "__v": 0,
724
+ "video_room_id": "6012f38557751ee8fc162cf7"
725
+ }
726
+ }
727
+ ```
728
+ </details>
729
+
730
+ </details>
731
+
732
+
733
+
734
+
735
+
736
+
737
+
738
+
739
+
740
+ ---
741
+
742
+
743
+ ### getTickets
744
+ Gets the list of Application level Tickets and/or ticket filters depending on query params
745
+
746
+
747
+
748
+ ```javascript
749
+ // Promise
750
+ const promise = client.application("<APPLICATION_ID>").lead.getTickets({ items : value,
751
+ filters : value,
752
+ q : value,
753
+ status : value,
754
+ priority : value,
755
+ category : value });
756
+
757
+ // Async/Await
758
+ const data = await client.application("<APPLICATION_ID>").lead.getTickets({ items : value,
759
+ filters : value,
760
+ q : value,
761
+ status : value,
762
+ priority : value,
763
+ category : value });
764
+ ```
765
+
766
+
767
+
768
+
769
+
770
+ | Argument | Type | Required | Description |
771
+ | --------- | ----- | -------- | ----------- |
772
+ | items | boolean | no | Decides that the reponse will contain the list of tickets |
773
+ | filters | boolean | no | Decides that the reponse will contain the ticket filters |
774
+ | q | string | no | Search through ticket titles and description |
775
+ | status | string | no | Filter tickets on status |
776
+ | priority | PriorityEnum | no | Filter tickets on priority |
777
+ | category | string | no | Filter tickets on category |
778
+
779
+
780
+
781
+ Gets the list of Application level Tickets and/or ticket filters
782
+
783
+ *Returned Response:*
784
+
785
+
786
+
787
+
788
+ [TicketList](#TicketList)
789
+
790
+ Success
791
+
792
+
793
+
794
+
795
+ <details>
796
+ <summary><i>&nbsp; Examples:</i></summary>
797
+
798
+
799
+ <details>
800
+ <summary><i>&nbsp; Without items</i></summary>
801
+
802
+ ```json
803
+ {
804
+ "value": {
805
+ "filters": {
806
+ "statuses": [
807
+ {
808
+ "display": "Pending",
809
+ "color": "#eae22b",
810
+ "key": "pending"
811
+ },
812
+ {
813
+ "display": "In Progress",
814
+ "color": "#ffa951",
815
+ "key": "in_progress"
816
+ },
817
+ {
818
+ "display": "Resolved",
819
+ "color": "#20c3a6",
820
+ "key": "resolved"
821
+ },
822
+ {
823
+ "display": "Closed",
824
+ "color": "#41434c",
825
+ "key": "closed"
826
+ }
827
+ ],
828
+ "priorities": [
829
+ {
830
+ "display": "Low",
831
+ "color": "#fed766",
832
+ "key": "low"
833
+ },
834
+ {
835
+ "display": "Medium",
836
+ "color": "#f37736",
837
+ "key": "medium"
838
+ },
839
+ {
840
+ "display": "High",
841
+ "color": "#fe4a49",
842
+ "key": "high"
843
+ }
844
+ ],
845
+ "assignees": [],
846
+ "categories": [
847
+ {
848
+ "form": {
849
+ "login_required": false,
850
+ "should_notify": false,
851
+ "inputs": [
852
+ {
853
+ "type": "email",
854
+ "showRegexInput": false,
855
+ "enum": [],
856
+ "regex": "\\S+@\\S+\\.\\S+",
857
+ "display": "email",
858
+ "required": true,
859
+ "key": "email"
860
+ }
861
+ ],
862
+ "available_assignees": [],
863
+ "_id": "602e900a2042255c03cadaf0",
864
+ "title": "service-test-satyen",
865
+ "description": "testing form from service",
866
+ "slug": "service-test-satyen",
867
+ "header_image": "https://hdn-1.addsale.com/x0/support-ticket/files/free/original/KZL86aN5l-service-test-satyen.jpeg",
868
+ "application_id": "000000000000000000000001",
869
+ "created_on": {
870
+ "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 11_2_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.150 Safari/537.36",
871
+ "platform": "web",
872
+ "meta": {
873
+ "browser": {
874
+ "name": "Chrome",
875
+ "version": "88.0.4324.150"
876
+ },
877
+ "os": {
878
+ "name": "macOS",
879
+ "version": "11.2.0"
880
+ },
881
+ "platform": {
882
+ "type": "desktop",
883
+ "vendor": "Apple"
884
+ },
885
+ "engine": {
886
+ "name": "Blink"
887
+ }
888
+ }
889
+ },
890
+ "created_by": "5f8147abbd1a0a870f61f1a6",
891
+ "createdAt": "2021-02-18T16:04:26.495Z",
892
+ "updatedAt": "2021-02-18T16:04:26.495Z",
893
+ "__v": 0
894
+ },
895
+ "key": "service-test-satyen",
896
+ "display": "service-test-satyen"
897
+ }
898
+ ]
899
+ }
900
+ }
901
+ }
902
+ ```
903
+ </details>
904
+
905
+ <details>
906
+ <summary><i>&nbsp; With items</i></summary>
907
+
908
+ ```json
909
+ {
910
+ "value": {
911
+ "docs": [
912
+ {
913
+ "_id": "602d2652ce284d0b008d5c97",
914
+ "status": {
915
+ "display": "Pending",
916
+ "color": "#eae22b",
917
+ "key": "pending"
918
+ },
919
+ "priority": {
920
+ "display": "Medium",
921
+ "color": "#f37736",
922
+ "key": "medium"
923
+ },
924
+ "assigned_to": {
925
+ "agent_id": "5e79e721768c6bf54b783146",
926
+ "gender": "male",
927
+ "accountType": "user",
928
+ "active": true,
929
+ "profilePicUrl": "https://d2co8r51m5ca2d.cloudfront.net/inapp_banners/default_profile_img.png",
930
+ "hasOldPasswordHash": false,
931
+ "_id": "5e79e721768c6bf54b783146",
932
+ "emails": [
933
+ {
934
+ "active": true,
935
+ "primary": true,
936
+ "verified": true,
937
+ "email": "nikhilmshchs@gmail.com"
938
+ },
939
+ {
940
+ "active": true,
941
+ "primary": false,
942
+ "verified": true,
943
+ "email": "nikhilmanapure@gofynd.com"
944
+ },
945
+ {
946
+ "active": true,
947
+ "primary": false,
948
+ "verified": true,
949
+ "email": "nikhilmanapure@fynd.com"
950
+ },
951
+ {
952
+ "active": true,
953
+ "primary": false,
954
+ "verified": true,
955
+ "email": "nikhilmanapure@uniket.store"
956
+ }
957
+ ],
958
+ "phoneNumbers": [
959
+ {
960
+ "active": true,
961
+ "primary": true,
962
+ "verified": true,
963
+ "countryCode": 91,
964
+ "phone": "9890425946"
965
+ }
966
+ ],
967
+ "firstName": "Nikhil",
968
+ "lastName": "Manapure",
969
+ "username": "nikhilmanapure_gofynd_com_29298",
970
+ "createdAt": "2020-03-24T10:55:29.298Z",
971
+ "updatedAt": "2020-05-12T07:46:41.816Z",
972
+ "uid": "5567",
973
+ "__v": 2
974
+ },
975
+ "tags": [
976
+ "asdf444"
977
+ ],
978
+ "context": {
979
+ "application_id": "000000000000000000000001",
980
+ "company_id": "1"
981
+ },
982
+ "created_on": {
983
+ "user_agent": "Fynd Platform/0.0.1 (com.fynd.platform; build:3; iOS 14.2.0) Alamofire/5.0.2",
984
+ "platform": "web",
985
+ "meta": {
986
+ "browser": {
987
+ "name": "Fynd Platform",
988
+ "version": "0.0.1"
989
+ }
990
+ }
991
+ },
992
+ "source": "sales_channel",
993
+ "content": {
994
+ "title": "asdf444 Response",
995
+ "description": "",
996
+ "attachments": []
997
+ },
998
+ "response_id": "602d2652ce284dee3c8d5c96",
999
+ "category": {
1000
+ "form": {
1001
+ "login_required": false,
1002
+ "should_notify": true,
1003
+ "inputs": [
1004
+ {
1005
+ "type": "text",
1006
+ "showRegexInput": false,
1007
+ "enum": [],
1008
+ "display": "asdf",
1009
+ "key": "asdf"
1010
+ },
1011
+ {
1012
+ "type": "mobile",
1013
+ "showRegexInput": false,
1014
+ "enum": [],
1015
+ "display": "mob num",
1016
+ "regex": "[0-9]{10}$",
1017
+ "key": "mob-num"
1018
+ }
1019
+ ],
1020
+ "available_assignees": [
1021
+ "5e79e721768c6bf54b783146"
1022
+ ],
1023
+ "_id": "60124e4a4d2bc363625e1bf4",
1024
+ "title": "asdf444",
1025
+ "description": "adf",
1026
+ "slug": "asdf444",
1027
+ "application_id": "000000000000000000000001",
1028
+ "created_on": {
1029
+ "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.96 Safari/537.36",
1030
+ "platform": "web",
1031
+ "meta": {
1032
+ "browser": {
1033
+ "name": "Chrome",
1034
+ "version": "88.0.4324.96"
1035
+ },
1036
+ "os": {
1037
+ "name": "macOS",
1038
+ "version": "10.15.7",
1039
+ "versionName": "Catalina"
1040
+ },
1041
+ "platform": {
1042
+ "type": "desktop",
1043
+ "vendor": "Apple"
1044
+ },
1045
+ "engine": {
1046
+ "name": "Blink"
1047
+ }
1048
+ }
1049
+ },
1050
+ "created_by": "5e79e721768c6bf54b783146",
1051
+ "createdAt": "2021-01-28T05:40:26.271Z",
1052
+ "updatedAt": "2021-02-18T16:02:32.086Z",
1053
+ "__v": 0,
1054
+ "poll_for_assignment": {
1055
+ "duration": 20,
1056
+ "message": "We are looking for executive to connect you",
1057
+ "success_message": "Executive found",
1058
+ "failure_message": "All our executives are busy at the moment, We have accepted your request and someone will connect with you soon!"
1059
+ }
1060
+ },
1061
+ "key": "asdf444",
1062
+ "display": "asdf444"
1063
+ },
1064
+ "ticket_id": "472",
1065
+ "createdAt": "2021-02-17T14:21:06.774Z",
1066
+ "updatedAt": "2021-02-17T14:21:06.774Z",
1067
+ "__v": 0,
1068
+ "id": "602d2652ce284d0b008d5c97"
1069
+ }
1070
+ ],
1071
+ "total": 472,
1072
+ "limit": 10,
1073
+ "page": 1,
1074
+ "pages": 48,
1075
+ "filters": {
1076
+ "statuses": [
1077
+ {
1078
+ "display": "Pending",
1079
+ "color": "#eae22b",
1080
+ "key": "pending"
1081
+ },
1082
+ {
1083
+ "display": "In Progress",
1084
+ "color": "#ffa951",
1085
+ "key": "in_progress"
1086
+ },
1087
+ {
1088
+ "display": "Resolved",
1089
+ "color": "#20c3a6",
1090
+ "key": "resolved"
1091
+ },
1092
+ {
1093
+ "display": "Closed",
1094
+ "color": "#41434c",
1095
+ "key": "closed"
1096
+ }
1097
+ ],
1098
+ "priorities": [
1099
+ {
1100
+ "display": "Low",
1101
+ "color": "#fed766",
1102
+ "key": "low"
1103
+ },
1104
+ {
1105
+ "display": "Medium",
1106
+ "color": "#f37736",
1107
+ "key": "medium"
1108
+ },
1109
+ {
1110
+ "display": "High",
1111
+ "color": "#fe4a49",
1112
+ "key": "high"
1113
+ }
1114
+ ],
1115
+ "assignees": [],
1116
+ "categories": [
1117
+ {
1118
+ "form": {
1119
+ "login_required": false,
1120
+ "should_notify": false,
1121
+ "inputs": [
1122
+ {
1123
+ "type": "email",
1124
+ "showRegexInput": false,
1125
+ "enum": [],
1126
+ "regex": "\\S+@\\S+\\.\\S+",
1127
+ "display": "email",
1128
+ "required": true,
1129
+ "key": "email"
1130
+ }
1131
+ ],
1132
+ "available_assignees": [],
1133
+ "_id": "602e900a2042255c03cadaf0",
1134
+ "title": "service-test-satyen",
1135
+ "description": "testing form from service",
1136
+ "slug": "service-test-satyen",
1137
+ "header_image": "https://hdn-1.addsale.com/x0/support-ticket/files/free/original/KZL86aN5l-service-test-satyen.jpeg",
1138
+ "application_id": "000000000000000000000001",
1139
+ "created_on": {
1140
+ "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 11_2_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.150 Safari/537.36",
1141
+ "platform": "web",
1142
+ "meta": {
1143
+ "browser": {
1144
+ "name": "Chrome",
1145
+ "version": "88.0.4324.150"
1146
+ },
1147
+ "os": {
1148
+ "name": "macOS",
1149
+ "version": "11.2.0"
1150
+ },
1151
+ "platform": {
1152
+ "type": "desktop",
1153
+ "vendor": "Apple"
1154
+ },
1155
+ "engine": {
1156
+ "name": "Blink"
1157
+ }
1158
+ }
1159
+ },
1160
+ "created_by": "5f8147abbd1a0a870f61f1a6",
1161
+ "createdAt": "2021-02-18T16:04:26.495Z",
1162
+ "updatedAt": "2021-02-18T16:04:26.495Z",
1163
+ "__v": 0
1164
+ },
1165
+ "key": "service-test-satyen",
1166
+ "display": "service-test-satyen"
1167
+ }
1168
+ ]
1169
+ }
1170
+ }
1171
+ }
1172
+ ```
1173
+ </details>
1174
+
1175
+ </details>
1176
+
1177
+
1178
+
1179
+
1180
+
1181
+
1182
+
1183
+
1184
+
1185
+ ---
1186
+
1187
+
1188
+ ### getTicket
1189
+ Retreives ticket details of a company level ticket with ticket ID
1190
+
1191
+
1192
+
1193
+ ```javascript
1194
+ // Promise
1195
+ const promise = client.lead.getTicket({ id : value });
1196
+
1197
+ // Async/Await
1198
+ const data = await client.lead.getTicket({ id : value });
1199
+ ```
1200
+
1201
+
1202
+
1203
+
1204
+
1205
+ | Argument | Type | Required | Description |
1206
+ | --------- | ----- | -------- | ----------- |
1207
+ | id | string | yes | Tiket ID of the ticket to be fetched |
1208
+
1209
+
1210
+
1211
+ Retreives ticket details of a company level ticket
1212
+
1213
+ *Returned Response:*
1214
+
1215
+
1216
+
1217
+
1218
+ [Ticket](#Ticket)
1219
+
1220
+ Success
1221
+
1222
+
1223
+
1224
+
1225
+ <details>
1226
+ <summary><i>&nbsp; Examples:</i></summary>
1227
+
1228
+
1229
+ <details>
1230
+ <summary><i>&nbsp; Default</i></summary>
1231
+
1232
+ ```json
1233
+ {
1234
+ "value": {
1235
+ "context": {
1236
+ "company_id": "1"
1237
+ },
1238
+ "content": {
1239
+ "title": "SOme title Response",
1240
+ "description": "<b>Single lineeee</b>: asdf<br><b>Email</b>: asdf@asdf.com<br><b>dfsdf</b>: asdf<br>",
1241
+ "attachments": []
1242
+ },
1243
+ "status": {
1244
+ "display": "In Progress",
1245
+ "color": "#ffa951",
1246
+ "key": "in_progress"
1247
+ },
1248
+ "priority": {
1249
+ "display": "Medium",
1250
+ "color": "#f37736",
1251
+ "key": "medium"
1252
+ },
1253
+ "assigned_to": {
1254
+ "agent_id": "5d1363adf599d850df93175e",
1255
+ "gender": "male",
1256
+ "accountType": "user",
1257
+ "active": true,
1258
+ "profilePicUrl": "https://platform-lookaside.fbsbx.com/platform/profilepic/?asid=2136700473091190&height=400&width=400&ext=1554542761&hash=AeS6cuWIdjDdJJ-b",
1259
+ "hasOldPasswordHash": false,
1260
+ "_id": "5d1363adf599d850df93175e",
1261
+ "phoneNumbers": [
1262
+ {
1263
+ "active": true,
1264
+ "primary": true,
1265
+ "verified": true,
1266
+ "countryCode": 91,
1267
+ "phone": "9890425946"
1268
+ }
1269
+ ],
1270
+ "firstName": "Nikhil",
1271
+ "lastName": "Manapure",
1272
+ "emails": [
1273
+ {
1274
+ "active": true,
1275
+ "primary": true,
1276
+ "verified": true,
1277
+ "email": "nikhilmshchs@gmail.com"
1278
+ }
1279
+ ],
1280
+ "username": "nikhilmshchs_gmail_com_38425_20500281",
1281
+ "createdAt": "2019-01-01T17:22:38.528Z",
1282
+ "updatedAt": "2021-01-22T10:02:42.258Z",
1283
+ "uid": "20500281",
1284
+ "__v": 56
1285
+ },
1286
+ "tags": [
1287
+ "some-title"
1288
+ ],
1289
+ "_id": "6012f38557751ee8fc162cf7",
1290
+ "created_on": {
1291
+ "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.96 Safari/537.36",
1292
+ "platform": "web",
1293
+ "meta": {
1294
+ "browser": {
1295
+ "name": "Chrome",
1296
+ "version": "88.0.4324.96"
1297
+ },
1298
+ "os": {
1299
+ "name": "macOS",
1300
+ "version": "10.15.7",
1301
+ "versionName": "Catalina"
1302
+ },
1303
+ "platform": {
1304
+ "type": "desktop",
1305
+ "vendor": "Apple"
1306
+ },
1307
+ "engine": {
1308
+ "name": "Blink"
1309
+ }
1310
+ }
1311
+ },
1312
+ "source": "sales_channel",
1313
+ "created_by": {
1314
+ "id": "5d1363adf599d850df93175e",
1315
+ "user": {
1316
+ "gender": "male",
1317
+ "accountType": "user",
1318
+ "active": true,
1319
+ "profilePicUrl": "https://platform-lookaside.fbsbx.com/platform/profilepic/?asid=2136700473091190&height=400&width=400&ext=1554542761&hash=AeS6cuWIdjDdJJ-b",
1320
+ "hasOldPasswordHash": false,
1321
+ "_id": "5d1363adf599d850df93175e",
1322
+ "phoneNumbers": [
1323
+ {
1324
+ "active": true,
1325
+ "primary": true,
1326
+ "verified": true,
1327
+ "countryCode": 91,
1328
+ "phone": "9890425946"
1329
+ }
1330
+ ],
1331
+ "firstName": "Nikhil",
1332
+ "lastName": "Manapure",
1333
+ "emails": [
1334
+ {
1335
+ "active": true,
1336
+ "primary": true,
1337
+ "verified": true,
1338
+ "email": "nikhilmshchs@gmail.com"
1339
+ }
1340
+ ],
1341
+ "username": "nikhilmshchs_gmail_com_38425_20500281",
1342
+ "createdAt": "2019-01-01T17:22:38.528Z",
1343
+ "updatedAt": "2021-01-22T10:02:42.258Z",
1344
+ "uid": "20500281",
1345
+ "__v": 56
1346
+ }
1347
+ },
1348
+ "response_id": "6012f38457751e0fb8162cf6",
1349
+ "category": {
1350
+ "form": {
1351
+ "login_required": false,
1352
+ "should_notify": false,
1353
+ "inputs": [
1354
+ {
1355
+ "required": false,
1356
+ "type": "text",
1357
+ "enum": [],
1358
+ "display": "Single lineeee",
1359
+ "key": "single-lineeee",
1360
+ "showRegexInput": false
1361
+ },
1362
+ {
1363
+ "required": false,
1364
+ "type": "email",
1365
+ "enum": [],
1366
+ "display": "Email",
1367
+ "regex": "\\S+@\\S+\\.\\S+",
1368
+ "key": "email",
1369
+ "showRegexInput": true
1370
+ },
1371
+ {
1372
+ "required": false,
1373
+ "type": "text",
1374
+ "enum": [],
1375
+ "display": "dfsdf",
1376
+ "key": "dfsdf",
1377
+ "showRegexInput": false
1378
+ }
1379
+ ],
1380
+ "available_assignees": [
1381
+ "5b9b98150df588546aaea6d2",
1382
+ "5c45d78395d7504f76c2cb37"
1383
+ ],
1384
+ "_id": "5fd72db3dc250f8decfc61b2",
1385
+ "title": "SOme title",
1386
+ "description": "SOme big description",
1387
+ "slug": "some-title",
1388
+ "application_id": "000000000000000000000003",
1389
+ "created_on": {
1390
+ "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.88 Safari/537.36",
1391
+ "platform": "web",
1392
+ "meta": {
1393
+ "browser": {
1394
+ "name": "Chrome",
1395
+ "version": "87.0.4280.88"
1396
+ },
1397
+ "os": {
1398
+ "name": "macOS",
1399
+ "version": "10.15.6",
1400
+ "versionName": "Catalina"
1401
+ },
1402
+ "platform": {
1403
+ "type": "desktop",
1404
+ "vendor": "Apple"
1405
+ },
1406
+ "engine": {
1407
+ "name": "Blink"
1408
+ }
1409
+ }
1410
+ },
1411
+ "created_by": "5d1363adf599d850df93175e",
1412
+ "createdAt": "2020-12-14T09:17:39.953Z",
1413
+ "updatedAt": "2021-01-28T18:48:07.717Z",
1414
+ "__v": 0
1415
+ },
1416
+ "key": "some-title",
1417
+ "display": "SOme title"
1418
+ },
1419
+ "ticket_id": "43",
1420
+ "createdAt": "2021-01-28T17:25:25.013Z",
1421
+ "updatedAt": "2021-01-28T17:25:33.396Z",
1422
+ "__v": 0,
1423
+ "video_room_id": "6012f38557751ee8fc162cf7"
1424
+ }
1425
+ }
1426
+ ```
1427
+ </details>
1428
+
1429
+ </details>
1430
+
1431
+
1432
+
1433
+
1434
+
1435
+
1436
+
1437
+
1438
+
1439
+ ---
1440
+
1441
+
1442
+ ### editTicket
1443
+ Edits ticket details of a company level ticket
1444
+
1445
+
1446
+
1447
+ ```javascript
1448
+ // Promise
1449
+ const promise = client.lead.editTicket({ id : value,
1450
+ body : value });
1451
+
1452
+ // Async/Await
1453
+ const data = await client.lead.editTicket({ id : value,
1454
+ body : value });
1455
+ ```
1456
+
1457
+
1458
+
1459
+
1460
+
1461
+ | Argument | Type | Required | Description |
1462
+ | --------- | ----- | -------- | ----------- |
1463
+ | id | string | yes | Ticket ID of ticket to be edited |
1464
+ | body | [EditTicketPayload](#EditTicketPayload) | yes | Request body |
1465
+
1466
+
1467
+ Edits ticket details of a company level ticket such as status, priority, category, tags, attachments, assigne & ticket content changes
1468
+
1469
+ *Returned Response:*
1470
+
1471
+
1472
+
1473
+
1474
+ [Ticket](#Ticket)
1475
+
1476
+ Success
1477
+
1478
+
1479
+
1480
+
1481
+ <details>
1482
+ <summary><i>&nbsp; Examples:</i></summary>
1483
+
1484
+
1485
+ <details>
1486
+ <summary><i>&nbsp; Default</i></summary>
1487
+
1488
+ ```json
1489
+ {
1490
+ "value": {
1491
+ "context": {
1492
+ "company_id": "1"
1493
+ },
1494
+ "content": {
1495
+ "title": "SOme title Response",
1496
+ "description": "<b>Single lineeee</b>: asdf<br><b>Email</b>: asdf@asdf.com<br><b>dfsdf</b>: asdf<br>",
1497
+ "attachments": []
1498
+ },
1499
+ "status": {
1500
+ "display": "In Progress",
1501
+ "color": "#ffa951",
1502
+ "key": "in_progress"
1503
+ },
1504
+ "priority": {
1505
+ "display": "Medium",
1506
+ "color": "#f37736",
1507
+ "key": "medium"
1508
+ },
1509
+ "assigned_to": {
1510
+ "agent_id": "5d1363adf599d850df93175e",
1511
+ "gender": "male",
1512
+ "accountType": "user",
1513
+ "active": true,
1514
+ "profilePicUrl": "https://platform-lookaside.fbsbx.com/platform/profilepic/?asid=2136700473091190&height=400&width=400&ext=1554542761&hash=AeS6cuWIdjDdJJ-b",
1515
+ "hasOldPasswordHash": false,
1516
+ "_id": "5d1363adf599d850df93175e",
1517
+ "phoneNumbers": [
1518
+ {
1519
+ "active": true,
1520
+ "primary": true,
1521
+ "verified": true,
1522
+ "countryCode": 91,
1523
+ "phone": "9890425946"
1524
+ }
1525
+ ],
1526
+ "firstName": "Nikhil",
1527
+ "lastName": "Manapure",
1528
+ "emails": [
1529
+ {
1530
+ "active": true,
1531
+ "primary": true,
1532
+ "verified": true,
1533
+ "email": "nikhilmshchs@gmail.com"
1534
+ }
1535
+ ],
1536
+ "username": "nikhilmshchs_gmail_com_38425_20500281",
1537
+ "createdAt": "2019-01-01T17:22:38.528Z",
1538
+ "updatedAt": "2021-01-22T10:02:42.258Z",
1539
+ "uid": "20500281",
1540
+ "__v": 56
1541
+ },
1542
+ "tags": [
1543
+ "some-title"
1544
+ ],
1545
+ "_id": "6012f38557751ee8fc162cf7",
1546
+ "created_on": {
1547
+ "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.96 Safari/537.36",
1548
+ "platform": "web",
1549
+ "meta": {
1550
+ "browser": {
1551
+ "name": "Chrome",
1552
+ "version": "88.0.4324.96"
1553
+ },
1554
+ "os": {
1555
+ "name": "macOS",
1556
+ "version": "10.15.7",
1557
+ "versionName": "Catalina"
1558
+ },
1559
+ "platform": {
1560
+ "type": "desktop",
1561
+ "vendor": "Apple"
1562
+ },
1563
+ "engine": {
1564
+ "name": "Blink"
1565
+ }
1566
+ }
1567
+ },
1568
+ "source": "sales_channel",
1569
+ "created_by": {
1570
+ "id": "5d1363adf599d850df93175e",
1571
+ "user": {
1572
+ "gender": "male",
1573
+ "accountType": "user",
1574
+ "active": true,
1575
+ "profilePicUrl": "https://platform-lookaside.fbsbx.com/platform/profilepic/?asid=2136700473091190&height=400&width=400&ext=1554542761&hash=AeS6cuWIdjDdJJ-b",
1576
+ "hasOldPasswordHash": false,
1577
+ "_id": "5d1363adf599d850df93175e",
1578
+ "phoneNumbers": [
1579
+ {
1580
+ "active": true,
1581
+ "primary": true,
1582
+ "verified": true,
1583
+ "countryCode": 91,
1584
+ "phone": "9890425946"
1585
+ }
1586
+ ],
1587
+ "firstName": "Nikhil",
1588
+ "lastName": "Manapure",
1589
+ "emails": [
1590
+ {
1591
+ "active": true,
1592
+ "primary": true,
1593
+ "verified": true,
1594
+ "email": "nikhilmshchs@gmail.com"
1595
+ }
1596
+ ],
1597
+ "username": "nikhilmshchs_gmail_com_38425_20500281",
1598
+ "createdAt": "2019-01-01T17:22:38.528Z",
1599
+ "updatedAt": "2021-01-22T10:02:42.258Z",
1600
+ "uid": "20500281",
1601
+ "__v": 56
1602
+ }
1603
+ },
1604
+ "response_id": "6012f38457751e0fb8162cf6",
1605
+ "category": {
1606
+ "form": {
1607
+ "login_required": false,
1608
+ "should_notify": false,
1609
+ "inputs": [
1610
+ {
1611
+ "required": false,
1612
+ "type": "text",
1613
+ "enum": [],
1614
+ "display": "Single lineeee",
1615
+ "key": "single-lineeee",
1616
+ "showRegexInput": false
1617
+ },
1618
+ {
1619
+ "required": false,
1620
+ "type": "email",
1621
+ "enum": [],
1622
+ "display": "Email",
1623
+ "regex": "\\S+@\\S+\\.\\S+",
1624
+ "key": "email",
1625
+ "showRegexInput": true
1626
+ },
1627
+ {
1628
+ "required": false,
1629
+ "type": "text",
1630
+ "enum": [],
1631
+ "display": "dfsdf",
1632
+ "key": "dfsdf",
1633
+ "showRegexInput": false
1634
+ }
1635
+ ],
1636
+ "available_assignees": [
1637
+ "5b9b98150df588546aaea6d2",
1638
+ "5c45d78395d7504f76c2cb37"
1639
+ ],
1640
+ "_id": "5fd72db3dc250f8decfc61b2",
1641
+ "title": "SOme title",
1642
+ "description": "SOme big description",
1643
+ "slug": "some-title",
1644
+ "application_id": "000000000000000000000003",
1645
+ "created_on": {
1646
+ "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.88 Safari/537.36",
1647
+ "platform": "web",
1648
+ "meta": {
1649
+ "browser": {
1650
+ "name": "Chrome",
1651
+ "version": "87.0.4280.88"
1652
+ },
1653
+ "os": {
1654
+ "name": "macOS",
1655
+ "version": "10.15.6",
1656
+ "versionName": "Catalina"
1657
+ },
1658
+ "platform": {
1659
+ "type": "desktop",
1660
+ "vendor": "Apple"
1661
+ },
1662
+ "engine": {
1663
+ "name": "Blink"
1664
+ }
1665
+ }
1666
+ },
1667
+ "created_by": "5d1363adf599d850df93175e",
1668
+ "createdAt": "2020-12-14T09:17:39.953Z",
1669
+ "updatedAt": "2021-01-28T18:48:07.717Z",
1670
+ "__v": 0
1671
+ },
1672
+ "key": "some-title",
1673
+ "display": "SOme title"
1674
+ },
1675
+ "ticket_id": "43",
1676
+ "createdAt": "2021-01-28T17:25:25.013Z",
1677
+ "updatedAt": "2021-01-28T17:25:33.396Z",
1678
+ "__v": 0,
1679
+ "video_room_id": "6012f38557751ee8fc162cf7"
1680
+ }
1681
+ }
1682
+ ```
1683
+ </details>
1684
+
1685
+ </details>
1686
+
1687
+
1688
+
1689
+
1690
+
1691
+
1692
+
1693
+
1694
+
1695
+ ---
1696
+
1697
+
1698
+ ### getTicket
1699
+ Retreives ticket details of a application level ticket
1700
+
1701
+
1702
+
1703
+ ```javascript
1704
+ // Promise
1705
+ const promise = client.application("<APPLICATION_ID>").lead.getTicket({ id : value });
1706
+
1707
+ // Async/Await
1708
+ const data = await client.application("<APPLICATION_ID>").lead.getTicket({ id : value });
1709
+ ```
1710
+
1711
+
1712
+
1713
+
1714
+
1715
+ | Argument | Type | Required | Description |
1716
+ | --------- | ----- | -------- | ----------- |
1717
+ | id | string | yes | Tiket ID of the ticket to be fetched |
1718
+
1719
+
1720
+
1721
+ Retreives ticket details of a application level ticket with ticket ID
1722
+
1723
+ *Returned Response:*
1724
+
1725
+
1726
+
1727
+
1728
+ [Ticket](#Ticket)
1729
+
1730
+ Success
1731
+
1732
+
1733
+
1734
+
1735
+ <details>
1736
+ <summary><i>&nbsp; Examples:</i></summary>
1737
+
1738
+
1739
+ <details>
1740
+ <summary><i>&nbsp; Default</i></summary>
1741
+
1742
+ ```json
1743
+ {
1744
+ "value": {
1745
+ "context": {
1746
+ "application_id": "000000000000000000000003",
1747
+ "company_id": "884"
1748
+ },
1749
+ "content": {
1750
+ "title": "SOme title Response",
1751
+ "description": "<b>Single lineeee</b>: asdf<br><b>Email</b>: asdf@asdf.com<br><b>dfsdf</b>: asdf<br>",
1752
+ "attachments": []
1753
+ },
1754
+ "status": {
1755
+ "display": "In Progress",
1756
+ "color": "#ffa951",
1757
+ "key": "in_progress"
1758
+ },
1759
+ "priority": {
1760
+ "display": "Medium",
1761
+ "color": "#f37736",
1762
+ "key": "medium"
1763
+ },
1764
+ "assigned_to": {
1765
+ "agent_id": "5d1363adf599d850df93175e",
1766
+ "gender": "male",
1767
+ "accountType": "user",
1768
+ "active": true,
1769
+ "profilePicUrl": "https://platform-lookaside.fbsbx.com/platform/profilepic/?asid=2136700473091190&height=400&width=400&ext=1554542761&hash=AeS6cuWIdjDdJJ-b",
1770
+ "hasOldPasswordHash": false,
1771
+ "_id": "5d1363adf599d850df93175e",
1772
+ "phoneNumbers": [
1773
+ {
1774
+ "active": true,
1775
+ "primary": true,
1776
+ "verified": true,
1777
+ "countryCode": 91,
1778
+ "phone": "9890425946"
1779
+ }
1780
+ ],
1781
+ "firstName": "Nikhil",
1782
+ "lastName": "Manapure",
1783
+ "emails": [
1784
+ {
1785
+ "active": true,
1786
+ "primary": true,
1787
+ "verified": true,
1788
+ "email": "nikhilmshchs@gmail.com"
1789
+ }
1790
+ ],
1791
+ "username": "nikhilmshchs_gmail_com_38425_20500281",
1792
+ "createdAt": "2019-01-01T17:22:38.528Z",
1793
+ "updatedAt": "2021-01-22T10:02:42.258Z",
1794
+ "uid": "20500281",
1795
+ "__v": 56
1796
+ },
1797
+ "tags": [
1798
+ "some-title"
1799
+ ],
1800
+ "_id": "6012f38557751ee8fc162cf7",
1801
+ "created_on": {
1802
+ "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.96 Safari/537.36",
1803
+ "platform": "web",
1804
+ "meta": {
1805
+ "browser": {
1806
+ "name": "Chrome",
1807
+ "version": "88.0.4324.96"
1808
+ },
1809
+ "os": {
1810
+ "name": "macOS",
1811
+ "version": "10.15.7",
1812
+ "versionName": "Catalina"
1813
+ },
1814
+ "platform": {
1815
+ "type": "desktop",
1816
+ "vendor": "Apple"
1817
+ },
1818
+ "engine": {
1819
+ "name": "Blink"
1820
+ }
1821
+ }
1822
+ },
1823
+ "source": "sales_channel",
1824
+ "created_by": {
1825
+ "id": "5d1363adf599d850df93175e",
1826
+ "user": {
1827
+ "gender": "male",
1828
+ "accountType": "user",
1829
+ "active": true,
1830
+ "profilePicUrl": "https://platform-lookaside.fbsbx.com/platform/profilepic/?asid=2136700473091190&height=400&width=400&ext=1554542761&hash=AeS6cuWIdjDdJJ-b",
1831
+ "hasOldPasswordHash": false,
1832
+ "_id": "5d1363adf599d850df93175e",
1833
+ "phoneNumbers": [
1834
+ {
1835
+ "active": true,
1836
+ "primary": true,
1837
+ "verified": true,
1838
+ "countryCode": 91,
1839
+ "phone": "9890425946"
1840
+ }
1841
+ ],
1842
+ "firstName": "Nikhil",
1843
+ "lastName": "Manapure",
1844
+ "emails": [
1845
+ {
1846
+ "active": true,
1847
+ "primary": true,
1848
+ "verified": true,
1849
+ "email": "nikhilmshchs@gmail.com"
1850
+ }
1851
+ ],
1852
+ "username": "nikhilmshchs_gmail_com_38425_20500281",
1853
+ "createdAt": "2019-01-01T17:22:38.528Z",
1854
+ "updatedAt": "2021-01-22T10:02:42.258Z",
1855
+ "uid": "20500281",
1856
+ "__v": 56
1857
+ }
1858
+ },
1859
+ "response_id": "6012f38457751e0fb8162cf6",
1860
+ "category": {
1861
+ "form": {
1862
+ "login_required": false,
1863
+ "should_notify": false,
1864
+ "inputs": [
1865
+ {
1866
+ "required": false,
1867
+ "type": "text",
1868
+ "enum": [],
1869
+ "display": "Single lineeee",
1870
+ "key": "single-lineeee",
1871
+ "showRegexInput": false
1872
+ },
1873
+ {
1874
+ "required": false,
1875
+ "type": "email",
1876
+ "enum": [],
1877
+ "display": "Email",
1878
+ "regex": "\\S+@\\S+\\.\\S+",
1879
+ "key": "email",
1880
+ "showRegexInput": true
1881
+ },
1882
+ {
1883
+ "required": false,
1884
+ "type": "text",
1885
+ "enum": [],
1886
+ "display": "dfsdf",
1887
+ "key": "dfsdf",
1888
+ "showRegexInput": false
1889
+ }
1890
+ ],
1891
+ "available_assignees": [
1892
+ "5b9b98150df588546aaea6d2",
1893
+ "5c45d78395d7504f76c2cb37"
1894
+ ],
1895
+ "_id": "5fd72db3dc250f8decfc61b2",
1896
+ "title": "SOme title",
1897
+ "description": "SOme big description",
1898
+ "slug": "some-title",
1899
+ "application_id": "000000000000000000000003",
1900
+ "created_on": {
1901
+ "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.88 Safari/537.36",
1902
+ "platform": "web",
1903
+ "meta": {
1904
+ "browser": {
1905
+ "name": "Chrome",
1906
+ "version": "87.0.4280.88"
1907
+ },
1908
+ "os": {
1909
+ "name": "macOS",
1910
+ "version": "10.15.6",
1911
+ "versionName": "Catalina"
1912
+ },
1913
+ "platform": {
1914
+ "type": "desktop",
1915
+ "vendor": "Apple"
1916
+ },
1917
+ "engine": {
1918
+ "name": "Blink"
1919
+ }
1920
+ }
1921
+ },
1922
+ "created_by": "5d1363adf599d850df93175e",
1923
+ "createdAt": "2020-12-14T09:17:39.953Z",
1924
+ "updatedAt": "2021-01-28T18:48:07.717Z",
1925
+ "__v": 0
1926
+ },
1927
+ "key": "some-title",
1928
+ "display": "SOme title"
1929
+ },
1930
+ "ticket_id": "43",
1931
+ "createdAt": "2021-01-28T17:25:25.013Z",
1932
+ "updatedAt": "2021-01-28T17:25:33.396Z",
1933
+ "__v": 0,
1934
+ "video_room_id": "6012f38557751ee8fc162cf7"
1935
+ }
1936
+ }
1937
+ ```
1938
+ </details>
1939
+
1940
+ </details>
1941
+
1942
+
1943
+
1944
+
1945
+
1946
+
1947
+
1948
+
1949
+
1950
+ ---
1951
+
1952
+
1953
+ ### editTicket
1954
+ Edits ticket details of a application level ticket
1955
+
1956
+
1957
+
1958
+ ```javascript
1959
+ // Promise
1960
+ const promise = client.application("<APPLICATION_ID>").lead.editTicket({ id : value,
1961
+ body : value });
1962
+
1963
+ // Async/Await
1964
+ const data = await client.application("<APPLICATION_ID>").lead.editTicket({ id : value,
1965
+ body : value });
1966
+ ```
1967
+
1968
+
1969
+
1970
+
1971
+
1972
+ | Argument | Type | Required | Description |
1973
+ | --------- | ----- | -------- | ----------- |
1974
+ | id | string | yes | Ticket ID of ticket to be edited |
1975
+ | body | [EditTicketPayload](#EditTicketPayload) | yes | Request body |
1976
+
1977
+
1978
+ Edits ticket details of a application level ticket such as status, priority, category, tags, attachments, assigne & ticket content changes
1979
+
1980
+ *Returned Response:*
1981
+
1982
+
1983
+
1984
+
1985
+ [Ticket](#Ticket)
1986
+
1987
+ Success
1988
+
1989
+
1990
+
1991
+
1992
+ <details>
1993
+ <summary><i>&nbsp; Examples:</i></summary>
1994
+
1995
+
1996
+ <details>
1997
+ <summary><i>&nbsp; Default</i></summary>
1998
+
1999
+ ```json
2000
+ {
2001
+ "value": {
2002
+ "context": {
2003
+ "application_id": "000000000000000000000003",
2004
+ "company_id": "884"
2005
+ },
2006
+ "content": {
2007
+ "title": "SOme title Response",
2008
+ "description": "<b>Single lineeee</b>: asdf<br><b>Email</b>: asdf@asdf.com<br><b>dfsdf</b>: asdf<br>",
2009
+ "attachments": []
2010
+ },
2011
+ "status": {
2012
+ "display": "In Progress",
2013
+ "color": "#ffa951",
2014
+ "key": "in_progress"
2015
+ },
2016
+ "priority": {
2017
+ "display": "Medium",
2018
+ "color": "#f37736",
2019
+ "key": "medium"
2020
+ },
2021
+ "assigned_to": {
2022
+ "agent_id": "5d1363adf599d850df93175e",
2023
+ "gender": "male",
2024
+ "accountType": "user",
2025
+ "active": true,
2026
+ "profilePicUrl": "https://platform-lookaside.fbsbx.com/platform/profilepic/?asid=2136700473091190&height=400&width=400&ext=1554542761&hash=AeS6cuWIdjDdJJ-b",
2027
+ "hasOldPasswordHash": false,
2028
+ "_id": "5d1363adf599d850df93175e",
2029
+ "phoneNumbers": [
2030
+ {
2031
+ "active": true,
2032
+ "primary": true,
2033
+ "verified": true,
2034
+ "countryCode": 91,
2035
+ "phone": "9890425946"
2036
+ }
2037
+ ],
2038
+ "firstName": "Nikhil",
2039
+ "lastName": "Manapure",
2040
+ "emails": [
2041
+ {
2042
+ "active": true,
2043
+ "primary": true,
2044
+ "verified": true,
2045
+ "email": "nikhilmshchs@gmail.com"
2046
+ }
2047
+ ],
2048
+ "username": "nikhilmshchs_gmail_com_38425_20500281",
2049
+ "createdAt": "2019-01-01T17:22:38.528Z",
2050
+ "updatedAt": "2021-01-22T10:02:42.258Z",
2051
+ "uid": "20500281",
2052
+ "__v": 56
2053
+ },
2054
+ "tags": [
2055
+ "some-title"
2056
+ ],
2057
+ "_id": "6012f38557751ee8fc162cf7",
2058
+ "created_on": {
2059
+ "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.96 Safari/537.36",
2060
+ "platform": "web",
2061
+ "meta": {
2062
+ "browser": {
2063
+ "name": "Chrome",
2064
+ "version": "88.0.4324.96"
2065
+ },
2066
+ "os": {
2067
+ "name": "macOS",
2068
+ "version": "10.15.7",
2069
+ "versionName": "Catalina"
2070
+ },
2071
+ "platform": {
2072
+ "type": "desktop",
2073
+ "vendor": "Apple"
2074
+ },
2075
+ "engine": {
2076
+ "name": "Blink"
2077
+ }
2078
+ }
2079
+ },
2080
+ "source": "sales_channel",
2081
+ "created_by": {
2082
+ "id": "5d1363adf599d850df93175e",
2083
+ "user": {
2084
+ "gender": "male",
2085
+ "accountType": "user",
2086
+ "active": true,
2087
+ "profilePicUrl": "https://platform-lookaside.fbsbx.com/platform/profilepic/?asid=2136700473091190&height=400&width=400&ext=1554542761&hash=AeS6cuWIdjDdJJ-b",
2088
+ "hasOldPasswordHash": false,
2089
+ "_id": "5d1363adf599d850df93175e",
2090
+ "phoneNumbers": [
2091
+ {
2092
+ "active": true,
2093
+ "primary": true,
2094
+ "verified": true,
2095
+ "countryCode": 91,
2096
+ "phone": "9890425946"
2097
+ }
2098
+ ],
2099
+ "firstName": "Nikhil",
2100
+ "lastName": "Manapure",
2101
+ "emails": [
2102
+ {
2103
+ "active": true,
2104
+ "primary": true,
2105
+ "verified": true,
2106
+ "email": "nikhilmshchs@gmail.com"
2107
+ }
2108
+ ],
2109
+ "username": "nikhilmshchs_gmail_com_38425_20500281",
2110
+ "createdAt": "2019-01-01T17:22:38.528Z",
2111
+ "updatedAt": "2021-01-22T10:02:42.258Z",
2112
+ "uid": "20500281",
2113
+ "__v": 56
2114
+ }
2115
+ },
2116
+ "response_id": "6012f38457751e0fb8162cf6",
2117
+ "category": {
2118
+ "form": {
2119
+ "login_required": false,
2120
+ "should_notify": false,
2121
+ "inputs": [
2122
+ {
2123
+ "required": false,
2124
+ "type": "text",
2125
+ "enum": [],
2126
+ "display": "Single lineeee",
2127
+ "key": "single-lineeee",
2128
+ "showRegexInput": false
2129
+ },
2130
+ {
2131
+ "required": false,
2132
+ "type": "email",
2133
+ "enum": [],
2134
+ "display": "Email",
2135
+ "regex": "\\S+@\\S+\\.\\S+",
2136
+ "key": "email",
2137
+ "showRegexInput": true
2138
+ },
2139
+ {
2140
+ "required": false,
2141
+ "type": "text",
2142
+ "enum": [],
2143
+ "display": "dfsdf",
2144
+ "key": "dfsdf",
2145
+ "showRegexInput": false
2146
+ }
2147
+ ],
2148
+ "available_assignees": [
2149
+ "5b9b98150df588546aaea6d2",
2150
+ "5c45d78395d7504f76c2cb37"
2151
+ ],
2152
+ "_id": "5fd72db3dc250f8decfc61b2",
2153
+ "title": "SOme title",
2154
+ "description": "SOme big description",
2155
+ "slug": "some-title",
2156
+ "application_id": "000000000000000000000003",
2157
+ "created_on": {
2158
+ "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.88 Safari/537.36",
2159
+ "platform": "web",
2160
+ "meta": {
2161
+ "browser": {
2162
+ "name": "Chrome",
2163
+ "version": "87.0.4280.88"
2164
+ },
2165
+ "os": {
2166
+ "name": "macOS",
2167
+ "version": "10.15.6",
2168
+ "versionName": "Catalina"
2169
+ },
2170
+ "platform": {
2171
+ "type": "desktop",
2172
+ "vendor": "Apple"
2173
+ },
2174
+ "engine": {
2175
+ "name": "Blink"
2176
+ }
2177
+ }
2178
+ },
2179
+ "created_by": "5d1363adf599d850df93175e",
2180
+ "createdAt": "2020-12-14T09:17:39.953Z",
2181
+ "updatedAt": "2021-01-28T18:48:07.717Z",
2182
+ "__v": 0
2183
+ },
2184
+ "key": "some-title",
2185
+ "display": "SOme title"
2186
+ },
2187
+ "ticket_id": "43",
2188
+ "createdAt": "2021-01-28T17:25:25.013Z",
2189
+ "updatedAt": "2021-01-28T17:25:33.396Z",
2190
+ "__v": 0,
2191
+ "video_room_id": "6012f38557751ee8fc162cf7"
2192
+ }
2193
+ }
2194
+ ```
2195
+ </details>
2196
+
2197
+ </details>
2198
+
2199
+
2200
+
2201
+
2202
+
2203
+
2204
+
2205
+
2206
+
2207
+ ---
2208
+
2209
+
2210
+ ### createHistory
2211
+ Create history for specific company level ticket
2212
+
2213
+
2214
+
2215
+ ```javascript
2216
+ // Promise
2217
+ const promise = client.lead.createHistory({ id : value,
2218
+ body : value });
2219
+
2220
+ // Async/Await
2221
+ const data = await client.lead.createHistory({ id : value,
2222
+ body : value });
2223
+ ```
2224
+
2225
+
2226
+
2227
+
2228
+
2229
+ | Argument | Type | Required | Description |
2230
+ | --------- | ----- | -------- | ----------- |
2231
+ | id | string | yes | Ticket ID for which history is created |
2232
+ | body | [TicketHistoryPayload](#TicketHistoryPayload) | yes | Request body |
2233
+
2234
+
2235
+ Create history for specific company level ticket, this history is seen on ticket detail page, this can be comment, log or rating.
2236
+
2237
+ *Returned Response:*
2238
+
2239
+
2240
+
2241
+
2242
+ [TicketHistory](#TicketHistory)
2243
+
2244
+ Success
2245
+
2246
+
2247
+
2248
+
2249
+ <details>
2250
+ <summary><i>&nbsp; Examples:</i></summary>
2251
+
2252
+
2253
+ <details>
2254
+ <summary><i>&nbsp; Default</i></summary>
2255
+
2256
+ ```json
2257
+ {
2258
+ "value": {
2259
+ "_id": "601a9d52c26687d086c499ef",
2260
+ "ticket_id": "43",
2261
+ "type": "comment",
2262
+ "value": {
2263
+ "text": "d",
2264
+ "media": []
2265
+ },
2266
+ "created_on": {
2267
+ "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.96 Safari/537.36",
2268
+ "platform": "web",
2269
+ "meta": {
2270
+ "browser": {
2271
+ "name": "Chrome",
2272
+ "version": "88.0.4324.96"
2273
+ },
2274
+ "os": {
2275
+ "name": "macOS",
2276
+ "version": "10.15.7",
2277
+ "versionName": "Catalina"
2278
+ },
2279
+ "platform": {
2280
+ "type": "desktop",
2281
+ "vendor": "Apple"
2282
+ },
2283
+ "engine": {
2284
+ "name": "Blink"
2285
+ }
2286
+ }
2287
+ },
2288
+ "created_by": "5d1363adf599d850df93175e",
2289
+ "createdAt": "2021-02-03T12:55:46.808Z",
2290
+ "updatedAt": "2021-02-03T12:55:46.808Z",
2291
+ "__v": 0
2292
+ }
2293
+ }
2294
+ ```
2295
+ </details>
2296
+
2297
+ </details>
2298
+
2299
+
2300
+
2301
+
2302
+
2303
+
2304
+
2305
+
2306
+
2307
+ ---
2308
+
2309
+
2310
+ ### getTicketHistory
2311
+ Gets history list for specific company level ticket
2312
+
2313
+
2314
+
2315
+ ```javascript
2316
+ // Promise
2317
+ const promise = client.lead.getTicketHistory({ id : value });
2318
+
2319
+ // Async/Await
2320
+ const data = await client.lead.getTicketHistory({ id : value });
2321
+ ```
2322
+
2323
+
2324
+
2325
+
2326
+
2327
+ | Argument | Type | Required | Description |
2328
+ | --------- | ----- | -------- | ----------- |
2329
+ | id | string | yes | Ticket ID for which history is to be fetched |
2330
+
2331
+
2332
+
2333
+ Gets history list for specific company level ticket, this history is seen on ticket detail page, this can be comment, log or rating.
2334
+
2335
+ *Returned Response:*
2336
+
2337
+
2338
+
2339
+
2340
+ [TicketHistoryList](#TicketHistoryList)
2341
+
2342
+ Success
2343
+
2344
+
2345
+
2346
+
2347
+ <details>
2348
+ <summary><i>&nbsp; Examples:</i></summary>
2349
+
2350
+
2351
+ <details>
2352
+ <summary><i>&nbsp; Default</i></summary>
2353
+
2354
+ ```json
2355
+ {
2356
+ "value": {
2357
+ "docs": [
2358
+ {
2359
+ "_id": "602e5384204225eed5cadae7",
2360
+ "ticket_id": "41",
2361
+ "type": "comment",
2362
+ "value": {
2363
+ "text": "hello service",
2364
+ "media": []
2365
+ },
2366
+ "created_on": {
2367
+ "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 11_2_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.150 Safari/537.36",
2368
+ "platform": "web",
2369
+ "meta": {
2370
+ "browser": {
2371
+ "name": "Chrome",
2372
+ "version": "88.0.4324.150"
2373
+ },
2374
+ "os": {
2375
+ "name": "macOS",
2376
+ "version": "11.2.0"
2377
+ },
2378
+ "platform": {
2379
+ "type": "desktop",
2380
+ "vendor": "Apple"
2381
+ },
2382
+ "engine": {
2383
+ "name": "Blink"
2384
+ }
2385
+ }
2386
+ },
2387
+ "created_by": {
2388
+ "gender": "male",
2389
+ "accountType": "user",
2390
+ "active": true,
2391
+ "profilePicUrl": "https://hdn-1.fynd.com/company/884/applications/000000000000000000000001/theme/pictures/free/original/default-profile_nxhzui.png",
2392
+ "hasOldPasswordHash": false,
2393
+ "_id": "5f8147abbd1a0a870f61f1a6",
2394
+ "phoneNumbers": [
2395
+ {
2396
+ "active": true,
2397
+ "primary": true,
2398
+ "verified": true,
2399
+ "phone": "8412805281",
2400
+ "countryCode": 91
2401
+ }
2402
+ ],
2403
+ "firstName": "Satyen",
2404
+ "lastName": "Maurya",
2405
+ "emails": [
2406
+ {
2407
+ "active": true,
2408
+ "primary": true,
2409
+ "verified": true,
2410
+ "email": "satyenmaurya95@gmail.com"
2411
+ }
2412
+ ],
2413
+ "username": "satyenmaurya95_gmail_com_11118",
2414
+ "createdAt": "2020-10-10T05:33:31.119Z",
2415
+ "updatedAt": "2020-10-10T05:33:31.119Z",
2416
+ "uid": "5678",
2417
+ "__v": 0
2418
+ },
2419
+ "createdAt": "2021-02-18T11:46:12.522Z",
2420
+ "updatedAt": "2021-02-18T11:46:12.522Z",
2421
+ "__v": 0,
2422
+ "id": "602e5384204225eed5cadae7"
2423
+ },
2424
+ {
2425
+ "_id": "60372aa78a046d4d79c46e15",
2426
+ "ticket_id": "41",
2427
+ "type": "diff",
2428
+ "value": {
2429
+ "status": [
2430
+ "pending",
2431
+ "in_progress"
2432
+ ]
2433
+ },
2434
+ "created_by": {
2435
+ "gender": "male",
2436
+ "accountType": "user",
2437
+ "active": true,
2438
+ "profilePicUrl": "https://d2co8r51m5ca2d.cloudfront.net/inapp_banners/default_profile_img.png",
2439
+ "hasOldPasswordHash": false,
2440
+ "_id": "5e79e721768c6bf54b783146",
2441
+ "emails": [
2442
+ {
2443
+ "active": true,
2444
+ "primary": true,
2445
+ "verified": true,
2446
+ "email": "nikhilmshchs@gmail.com"
2447
+ },
2448
+ {
2449
+ "active": true,
2450
+ "primary": false,
2451
+ "verified": true,
2452
+ "email": "nikhilmanapure@gofynd.com"
2453
+ },
2454
+ {
2455
+ "active": true,
2456
+ "primary": false,
2457
+ "verified": true,
2458
+ "email": "nikhilmanapure@fynd.com"
2459
+ },
2460
+ {
2461
+ "active": true,
2462
+ "primary": false,
2463
+ "verified": true,
2464
+ "email": "nikhilmanapure@uniket.store"
2465
+ }
2466
+ ],
2467
+ "phoneNumbers": [
2468
+ {
2469
+ "active": true,
2470
+ "primary": true,
2471
+ "verified": true,
2472
+ "countryCode": 91,
2473
+ "phone": "9890425946"
2474
+ }
2475
+ ],
2476
+ "firstName": "Nikhil",
2477
+ "lastName": "Manapure",
2478
+ "username": "nikhilmanapure_gofynd_com_29298",
2479
+ "createdAt": "2020-03-24T10:55:29.298Z",
2480
+ "updatedAt": "2020-05-12T07:46:41.816Z",
2481
+ "uid": "5567",
2482
+ "__v": 2
2483
+ },
2484
+ "createdAt": "2021-02-25T04:42:15.225Z",
2485
+ "updatedAt": "2021-02-25T04:42:15.225Z",
2486
+ "__v": 0,
2487
+ "id": "60372aa78a046d4d79c46e15"
2488
+ }
2489
+ ],
2490
+ "total": 2,
2491
+ "limit": 100,
2492
+ "page": 1,
2493
+ "pages": 1
2494
+ }
2495
+ }
2496
+ ```
2497
+ </details>
2498
+
2499
+ </details>
2500
+
2501
+
2502
+
2503
+
2504
+
2505
+
2506
+
2507
+
2508
+
2509
+ ---
2510
+
2511
+
2512
+ ### getFeedbacks
2513
+ Gets a list of feedback submitted against that ticket
2514
+
2515
+
2516
+
2517
+ ```javascript
2518
+ // Promise
2519
+ const promise = client.lead.getFeedbacks({ id : value });
2520
+
2521
+ // Async/Await
2522
+ const data = await client.lead.getFeedbacks({ id : value });
2523
+ ```
2524
+
2525
+
2526
+
2527
+
2528
+
2529
+ | Argument | Type | Required | Description |
2530
+ | --------- | ----- | -------- | ----------- |
2531
+ | id | string | yes | Ticket ID for which feedbacks are to be fetched |
2532
+
2533
+
2534
+
2535
+ Gets a list of feedback submitted against that ticket
2536
+
2537
+ *Returned Response:*
2538
+
2539
+
2540
+
2541
+
2542
+ [TicketFeedbackList](#TicketFeedbackList)
2543
+
2544
+ Success
2545
+
2546
+
2547
+
2548
+
2549
+ <details>
2550
+ <summary><i>&nbsp; Examples:</i></summary>
2551
+
2552
+
2553
+ <details>
2554
+ <summary><i>&nbsp; Default</i></summary>
2555
+
2556
+ ```json
2557
+ {
2558
+ "value": {
2559
+ "items": [
2560
+ {
2561
+ "_id": "60c255bf00ecabfad19e9601",
2562
+ "company_id": "1",
2563
+ "ticket_id": "6095812876d2bf17143cb3b3",
2564
+ "user": {
2565
+ "_id": "5f8147abbd1a0a870f61f1a6",
2566
+ "authenticated": true,
2567
+ "user_id": "5f8147abbd1a0a870f61f1a6"
2568
+ },
2569
+ "category": "customers",
2570
+ "response": {
2571
+ "audio": 2,
2572
+ "video": 6
2573
+ },
2574
+ "createdAt": "2021-06-10T18:11:11.349Z",
2575
+ "updatedAt": "2021-06-10T18:11:11.349Z",
2576
+ "__v": 0
2577
+ }
2578
+ ]
2579
+ }
2580
+ }
2581
+ ```
2582
+ </details>
2583
+
2584
+ </details>
2585
+
2586
+
2587
+
2588
+
2589
+
2590
+
2591
+
2592
+
2593
+
2594
+ ---
2595
+
2596
+
2597
+ ### submitFeedback
2598
+ Submit a response for feeback form against that ticket
2599
+
2600
+
2601
+
2602
+ ```javascript
2603
+ // Promise
2604
+ const promise = client.lead.submitFeedback({ id : value,
2605
+ body : value });
2606
+
2607
+ // Async/Await
2608
+ const data = await client.lead.submitFeedback({ id : value,
2609
+ body : value });
2610
+ ```
2611
+
2612
+
2613
+
2614
+
2615
+
2616
+ | Argument | Type | Required | Description |
2617
+ | --------- | ----- | -------- | ----------- |
2618
+ | id | string | yes | Ticket ID for which feedback is to be submitted |
2619
+ | body | [TicketFeedbackPayload](#TicketFeedbackPayload) | yes | Request body |
2620
+
2621
+
2622
+ Submit a response for feeback form against that ticket
2623
+
2624
+ *Returned Response:*
2625
+
2626
+
2627
+
2628
+
2629
+ [TicketFeedback](#TicketFeedback)
2630
+
2631
+ Success
2632
+
2633
+
2634
+
2635
+
2636
+ <details>
2637
+ <summary><i>&nbsp; Examples:</i></summary>
2638
+
2639
+
2640
+ <details>
2641
+ <summary><i>&nbsp; Default</i></summary>
2642
+
2643
+ ```json
2644
+ {
2645
+ "value": {
2646
+ "_id": "60c255bf00ecabfad19e9601",
2647
+ "company_id": "1",
2648
+ "ticket_id": "6095812876d2bf17143cb3b3",
2649
+ "user": {
2650
+ "_id": "5f8147abbd1a0a870f61f1a6",
2651
+ "authenticated": true,
2652
+ "user_id": "5f8147abbd1a0a870f61f1a6"
2653
+ },
2654
+ "category": "customers",
2655
+ "response": {
2656
+ "audio": 2,
2657
+ "video": 6
2658
+ },
2659
+ "createdAt": "2021-06-10T18:11:11.349Z",
2660
+ "updatedAt": "2021-06-10T18:11:11.349Z",
2661
+ "__v": 0
2662
+ }
2663
+ }
2664
+ ```
2665
+ </details>
2666
+
2667
+ </details>
2668
+
2669
+
2670
+
2671
+
2672
+
2673
+
2674
+
2675
+
2676
+
2677
+ ---
2678
+
2679
+
2680
+ ### createHistory
2681
+ Create history for specific application level ticket
2682
+
2683
+
2684
+
2685
+ ```javascript
2686
+ // Promise
2687
+ const promise = client.application("<APPLICATION_ID>").lead.createHistory({ id : value,
2688
+ body : value });
2689
+
2690
+ // Async/Await
2691
+ const data = await client.application("<APPLICATION_ID>").lead.createHistory({ id : value,
2692
+ body : value });
2693
+ ```
2694
+
2695
+
2696
+
2697
+
2698
+
2699
+ | Argument | Type | Required | Description |
2700
+ | --------- | ----- | -------- | ----------- |
2701
+ | id | string | yes | Ticket ID for which history is created |
2702
+ | body | [TicketHistoryPayload](#TicketHistoryPayload) | yes | Request body |
2703
+
2704
+
2705
+ Create history for specific application level ticket, this history is seen on ticket detail page, this can be comment, log or rating.
2706
+
2707
+ *Returned Response:*
2708
+
2709
+
2710
+
2711
+
2712
+ [TicketHistory](#TicketHistory)
2713
+
2714
+ Success
2715
+
2716
+
2717
+
2718
+
2719
+ <details>
2720
+ <summary><i>&nbsp; Examples:</i></summary>
2721
+
2722
+
2723
+ <details>
2724
+ <summary><i>&nbsp; Default</i></summary>
2725
+
2726
+ ```json
2727
+ {
2728
+ "value": {
2729
+ "_id": "601a9d52c26687d086c499ef",
2730
+ "ticket_id": "41",
2731
+ "type": "comment",
2732
+ "value": {
2733
+ "text": "d",
2734
+ "media": []
2735
+ },
2736
+ "created_on": {
2737
+ "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.96 Safari/537.36",
2738
+ "platform": "web",
2739
+ "meta": {
2740
+ "browser": {
2741
+ "name": "Chrome",
2742
+ "version": "88.0.4324.96"
2743
+ },
2744
+ "os": {
2745
+ "name": "macOS",
2746
+ "version": "10.15.7",
2747
+ "versionName": "Catalina"
2748
+ },
2749
+ "platform": {
2750
+ "type": "desktop",
2751
+ "vendor": "Apple"
2752
+ },
2753
+ "engine": {
2754
+ "name": "Blink"
2755
+ }
2756
+ }
2757
+ },
2758
+ "created_by": "5d1363adf599d850df93175e",
2759
+ "createdAt": "2021-02-03T12:55:46.808Z",
2760
+ "updatedAt": "2021-02-03T12:55:46.808Z",
2761
+ "__v": 0
2762
+ }
2763
+ }
2764
+ ```
2765
+ </details>
2766
+
2767
+ </details>
2768
+
2769
+
2770
+
2771
+
2772
+
2773
+
2774
+
2775
+
2776
+
2777
+ ---
2778
+
2779
+
2780
+ ### getTicketHistory
2781
+ Gets history list for specific application level ticket
2782
+
2783
+
2784
+
2785
+ ```javascript
2786
+ // Promise
2787
+ const promise = client.application("<APPLICATION_ID>").lead.getTicketHistory({ id : value });
2788
+
2789
+ // Async/Await
2790
+ const data = await client.application("<APPLICATION_ID>").lead.getTicketHistory({ id : value });
2791
+ ```
2792
+
2793
+
2794
+
2795
+
2796
+
2797
+ | Argument | Type | Required | Description |
2798
+ | --------- | ----- | -------- | ----------- |
2799
+ | id | string | yes | Ticket ID for which history is to be fetched |
2800
+
2801
+
2802
+
2803
+ Gets history list for specific application level ticket, this history is seen on ticket detail page, this can be comment, log or rating.
2804
+
2805
+ *Returned Response:*
2806
+
2807
+
2808
+
2809
+
2810
+ [TicketHistoryList](#TicketHistoryList)
2811
+
2812
+ Success
2813
+
2814
+
2815
+
2816
+
2817
+ <details>
2818
+ <summary><i>&nbsp; Examples:</i></summary>
2819
+
2820
+
2821
+ <details>
2822
+ <summary><i>&nbsp; Default</i></summary>
2823
+
2824
+ ```json
2825
+ {
2826
+ "value": {
2827
+ "docs": [
2828
+ {
2829
+ "_id": "602e5384204225eed5cadae7",
2830
+ "ticket_id": "41",
2831
+ "type": "comment",
2832
+ "value": {
2833
+ "text": "hello service",
2834
+ "media": []
2835
+ },
2836
+ "created_on": {
2837
+ "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 11_2_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.150 Safari/537.36",
2838
+ "platform": "web",
2839
+ "meta": {
2840
+ "browser": {
2841
+ "name": "Chrome",
2842
+ "version": "88.0.4324.150"
2843
+ },
2844
+ "os": {
2845
+ "name": "macOS",
2846
+ "version": "11.2.0"
2847
+ },
2848
+ "platform": {
2849
+ "type": "desktop",
2850
+ "vendor": "Apple"
2851
+ },
2852
+ "engine": {
2853
+ "name": "Blink"
2854
+ }
2855
+ }
2856
+ },
2857
+ "created_by": {
2858
+ "gender": "male",
2859
+ "accountType": "user",
2860
+ "active": true,
2861
+ "profilePicUrl": "https://hdn-1.fynd.com/company/884/applications/000000000000000000000001/theme/pictures/free/original/default-profile_nxhzui.png",
2862
+ "hasOldPasswordHash": false,
2863
+ "_id": "5f8147abbd1a0a870f61f1a6",
2864
+ "phoneNumbers": [
2865
+ {
2866
+ "active": true,
2867
+ "primary": true,
2868
+ "verified": true,
2869
+ "phone": "8412805281",
2870
+ "countryCode": 91
2871
+ }
2872
+ ],
2873
+ "firstName": "Satyen",
2874
+ "lastName": "Maurya",
2875
+ "emails": [
2876
+ {
2877
+ "active": true,
2878
+ "primary": true,
2879
+ "verified": true,
2880
+ "email": "satyenmaurya95@gmail.com"
2881
+ }
2882
+ ],
2883
+ "username": "satyenmaurya95_gmail_com_11118",
2884
+ "createdAt": "2020-10-10T05:33:31.119Z",
2885
+ "updatedAt": "2020-10-10T05:33:31.119Z",
2886
+ "uid": "5678",
2887
+ "__v": 0
2888
+ },
2889
+ "createdAt": "2021-02-18T11:46:12.522Z",
2890
+ "updatedAt": "2021-02-18T11:46:12.522Z",
2891
+ "__v": 0,
2892
+ "id": "602e5384204225eed5cadae7"
2893
+ },
2894
+ {
2895
+ "_id": "60372aa78a046d4d79c46e15",
2896
+ "ticket_id": "41",
2897
+ "type": "diff",
2898
+ "value": {
2899
+ "status": [
2900
+ "pending",
2901
+ "in_progress"
2902
+ ]
2903
+ },
2904
+ "created_by": {
2905
+ "gender": "male",
2906
+ "accountType": "user",
2907
+ "active": true,
2908
+ "profilePicUrl": "https://d2co8r51m5ca2d.cloudfront.net/inapp_banners/default_profile_img.png",
2909
+ "hasOldPasswordHash": false,
2910
+ "_id": "5e79e721768c6bf54b783146",
2911
+ "emails": [
2912
+ {
2913
+ "active": true,
2914
+ "primary": true,
2915
+ "verified": true,
2916
+ "email": "nikhilmshchs@gmail.com"
2917
+ },
2918
+ {
2919
+ "active": true,
2920
+ "primary": false,
2921
+ "verified": true,
2922
+ "email": "nikhilmanapure@gofynd.com"
2923
+ },
2924
+ {
2925
+ "active": true,
2926
+ "primary": false,
2927
+ "verified": true,
2928
+ "email": "nikhilmanapure@fynd.com"
2929
+ },
2930
+ {
2931
+ "active": true,
2932
+ "primary": false,
2933
+ "verified": true,
2934
+ "email": "nikhilmanapure@uniket.store"
2935
+ }
2936
+ ],
2937
+ "phoneNumbers": [
2938
+ {
2939
+ "active": true,
2940
+ "primary": true,
2941
+ "verified": true,
2942
+ "countryCode": 91,
2943
+ "phone": "9890425946"
2944
+ }
2945
+ ],
2946
+ "firstName": "Nikhil",
2947
+ "lastName": "Manapure",
2948
+ "username": "nikhilmanapure_gofynd_com_29298",
2949
+ "createdAt": "2020-03-24T10:55:29.298Z",
2950
+ "updatedAt": "2020-05-12T07:46:41.816Z",
2951
+ "uid": "5567",
2952
+ "__v": 2
2953
+ },
2954
+ "createdAt": "2021-02-25T04:42:15.225Z",
2955
+ "updatedAt": "2021-02-25T04:42:15.225Z",
2956
+ "__v": 0,
2957
+ "id": "60372aa78a046d4d79c46e15"
2958
+ }
2959
+ ],
2960
+ "total": 2,
2961
+ "limit": 100,
2962
+ "page": 1,
2963
+ "pages": 1
2964
+ }
2965
+ }
2966
+ ```
2967
+ </details>
2968
+
2969
+ </details>
2970
+
2971
+
2972
+
2973
+
2974
+
2975
+
2976
+
2977
+
2978
+
2979
+ ---
2980
+
2981
+
2982
+ ### getCustomForm
2983
+ Get specific custom form using it's slug
2984
+
2985
+
2986
+
2987
+ ```javascript
2988
+ // Promise
2989
+ const promise = client.application("<APPLICATION_ID>").lead.getCustomForm({ slug : value });
2990
+
2991
+ // Async/Await
2992
+ const data = await client.application("<APPLICATION_ID>").lead.getCustomForm({ slug : value });
2993
+ ```
2994
+
2995
+
2996
+
2997
+
2998
+
2999
+ | Argument | Type | Required | Description |
3000
+ | --------- | ----- | -------- | ----------- |
3001
+ | slug | string | yes | Slug of form whose response is getting submitted |
3002
+
3003
+
3004
+
3005
+ Get specific custom form using it's slug, this is used to view the form.
3006
+
3007
+ *Returned Response:*
3008
+
3009
+
3010
+
3011
+
3012
+ [CustomForm](#CustomForm)
3013
+
3014
+ Success
3015
+
3016
+
3017
+
3018
+
3019
+ <details>
3020
+ <summary><i>&nbsp; Examples:</i></summary>
3021
+
3022
+
3023
+ <details>
3024
+ <summary><i>&nbsp; Default</i></summary>
3025
+
3026
+ ```json
3027
+ {
3028
+ "value": {
3029
+ "login_required": false,
3030
+ "should_notify": false,
3031
+ "inputs": [
3032
+ {
3033
+ "required": false,
3034
+ "type": "text",
3035
+ "display": "Name",
3036
+ "placeholder": "Please enter your name",
3037
+ "key": "name"
3038
+ }
3039
+ ],
3040
+ "available_assignees": [],
3041
+ "_id": "5fd258a9088f957f34c288fc",
3042
+ "title": "trail form",
3043
+ "description": "Trail form description",
3044
+ "slug": "trail-form",
3045
+ "application_id": "000000000000000000000003",
3046
+ "created_on": {
3047
+ "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.88 Safari/537.36",
3048
+ "platform": "web",
3049
+ "meta": {
3050
+ "browser": {
3051
+ "name": "Chrome",
3052
+ "version": "87.0.4280.88"
3053
+ },
3054
+ "os": {
3055
+ "name": "macOS",
3056
+ "version": "10.15.6",
3057
+ "versionName": "Catalina"
3058
+ },
3059
+ "platform": {
3060
+ "type": "desktop",
3061
+ "vendor": "Apple"
3062
+ },
3063
+ "engine": {
3064
+ "name": "Blink"
3065
+ }
3066
+ }
3067
+ },
3068
+ "created_by": "5d1363adf599d850df93175e",
3069
+ "createdAt": "2020-12-10T17:19:37.515Z",
3070
+ "updatedAt": "2020-12-10T17:19:43.214Z",
3071
+ "__v": 0
3072
+ }
3073
+ }
3074
+ ```
3075
+ </details>
3076
+
3077
+ </details>
3078
+
3079
+
3080
+
3081
+
3082
+
3083
+
3084
+
3085
+
3086
+
3087
+ ---
3088
+
3089
+
3090
+ ### editCustomForm
3091
+ Edit the given custom form
3092
+
3093
+
3094
+
3095
+ ```javascript
3096
+ // Promise
3097
+ const promise = client.application("<APPLICATION_ID>").lead.editCustomForm({ slug : value,
3098
+ body : value });
3099
+
3100
+ // Async/Await
3101
+ const data = await client.application("<APPLICATION_ID>").lead.editCustomForm({ slug : value,
3102
+ body : value });
3103
+ ```
3104
+
3105
+
3106
+
3107
+
3108
+
3109
+ | Argument | Type | Required | Description |
3110
+ | --------- | ----- | -------- | ----------- |
3111
+ | slug | string | yes | Slug of form whose response is getting submitted |
3112
+ | body | [EditCustomFormPayload](#EditCustomFormPayload) | yes | Request body |
3113
+
3114
+
3115
+ Edit the given custom form field such as adding or deleting input, assignee, title, decription, notification and polling information.
3116
+
3117
+ *Returned Response:*
3118
+
3119
+
3120
+
3121
+
3122
+ [CustomForm](#CustomForm)
3123
+
3124
+ Success
3125
+
3126
+
3127
+
3128
+
3129
+ <details>
3130
+ <summary><i>&nbsp; Examples:</i></summary>
3131
+
3132
+
3133
+ <details>
3134
+ <summary><i>&nbsp; Default</i></summary>
3135
+
3136
+ ```json
3137
+ {
3138
+ "value": {
3139
+ "login_required": false,
3140
+ "should_notify": false,
3141
+ "inputs": [
3142
+ {
3143
+ "type": "email",
3144
+ "showRegexInput": true,
3145
+ "enum": [],
3146
+ "regex": "\\S+@\\S+\\.\\S+",
3147
+ "display": "email",
3148
+ "required": true,
3149
+ "key": "email"
3150
+ },
3151
+ {
3152
+ "type": "number",
3153
+ "showRegexInput": false,
3154
+ "enum": [],
3155
+ "display": "Enter your fav number",
3156
+ "placeholder": "123",
3157
+ "key": "enter-your-fav-number"
3158
+ }
3159
+ ],
3160
+ "available_assignees": [],
3161
+ "_id": "602e900a2042255c03cadaf0",
3162
+ "title": "service-test-satyen",
3163
+ "description": "testing form from service",
3164
+ "slug": "service-test-satyen",
3165
+ "header_image": "https://hdn-1.addsale.com/x0/support-ticket/files/free/original/KZL86aN5l-service-test-satyen.jpeg",
3166
+ "application_id": "000000000000000000000001",
3167
+ "created_on": {
3168
+ "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 11_2_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.150 Safari/537.36",
3169
+ "platform": "web",
3170
+ "meta": {
3171
+ "browser": {
3172
+ "name": "Chrome",
3173
+ "version": "88.0.4324.150"
3174
+ },
3175
+ "os": {
3176
+ "name": "macOS",
3177
+ "version": "11.2.0"
3178
+ },
3179
+ "platform": {
3180
+ "type": "desktop",
3181
+ "vendor": "Apple"
3182
+ },
3183
+ "engine": {
3184
+ "name": "Blink"
3185
+ }
3186
+ }
3187
+ },
3188
+ "created_by": "5f8147abbd1a0a870f61f1a6",
3189
+ "createdAt": "2021-02-18T16:04:26.495Z",
3190
+ "updatedAt": "2021-02-26T10:16:49.272Z",
3191
+ "__v": 0
3192
+ }
3193
+ }
3194
+ ```
3195
+ </details>
3196
+
3197
+ </details>
3198
+
3199
+
3200
+
3201
+
3202
+
3203
+
3204
+
3205
+
3206
+
3207
+ ---
3208
+
3209
+
3210
+ ### getCustomForms
3211
+ Get list of custom form
3212
+
3213
+
3214
+
3215
+ ```javascript
3216
+ // Promise
3217
+ const promise = client.application("<APPLICATION_ID>").lead.getCustomForms();
3218
+
3219
+ // Async/Await
3220
+ const data = await client.application("<APPLICATION_ID>").lead.getCustomForms();
3221
+ ```
3222
+
3223
+
3224
+
3225
+
3226
+
3227
+
3228
+ Get list of custom form for given application
3229
+
3230
+ *Returned Response:*
3231
+
3232
+
3233
+
3234
+
3235
+ [CustomFormList](#CustomFormList)
3236
+
3237
+ Success
3238
+
3239
+
3240
+
3241
+
3242
+ <details>
3243
+ <summary><i>&nbsp; Examples:</i></summary>
3244
+
3245
+
3246
+ <details>
3247
+ <summary><i>&nbsp; Default</i></summary>
3248
+
3249
+ ```json
3250
+ {
3251
+ "value": {
3252
+ "docs": [
3253
+ {
3254
+ "_id": "602e900a2042255c03cadaf0",
3255
+ "login_required": false,
3256
+ "should_notify": false,
3257
+ "inputs": [
3258
+ {
3259
+ "type": "email",
3260
+ "showRegexInput": true,
3261
+ "enum": [],
3262
+ "regex": "\\S+@\\S+\\.\\S+",
3263
+ "display": "email",
3264
+ "required": true,
3265
+ "key": "email"
3266
+ },
3267
+ {
3268
+ "type": "number",
3269
+ "showRegexInput": false,
3270
+ "enum": [],
3271
+ "display": "Enter your fav number",
3272
+ "placeholder": "123",
3273
+ "key": "enter-your-fav-number"
3274
+ },
3275
+ {
3276
+ "type": "textarea",
3277
+ "showRegexInput": false,
3278
+ "enum": [],
3279
+ "display": "kjhgjhvjb",
3280
+ "required": true,
3281
+ "key": "kjhgjhvjb"
3282
+ }
3283
+ ],
3284
+ "available_assignees": [],
3285
+ "title": "service-test-satyen",
3286
+ "description": "testing form from service",
3287
+ "slug": "service-test-satyen",
3288
+ "header_image": "https://hdn-1.addsale.com/x0/support-ticket/files/free/original/KZL86aN5l-service-test-satyen.jpeg",
3289
+ "application_id": "000000000000000000000001",
3290
+ "created_on": {
3291
+ "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 11_2_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.150 Safari/537.36",
3292
+ "platform": "web",
3293
+ "meta": {
3294
+ "browser": {
3295
+ "name": "Chrome",
3296
+ "version": "88.0.4324.150"
3297
+ },
3298
+ "os": {
3299
+ "name": "macOS",
3300
+ "version": "11.2.0"
3301
+ },
3302
+ "platform": {
3303
+ "type": "desktop",
3304
+ "vendor": "Apple"
3305
+ },
3306
+ "engine": {
3307
+ "name": "Blink"
3308
+ }
3309
+ }
3310
+ },
3311
+ "created_by": "5f8147abbd1a0a870f61f1a6",
3312
+ "createdAt": "2021-02-18T16:04:26.495Z",
3313
+ "updatedAt": "2021-02-24T15:49:56.256Z",
3314
+ "__v": 0,
3315
+ "id": "602e900a2042255c03cadaf0"
3316
+ },
3317
+ {
3318
+ "_id": "60124e4a4d2bc363625e1bf4",
3319
+ "login_required": false,
3320
+ "should_notify": true,
3321
+ "inputs": [
3322
+ {
3323
+ "type": "text",
3324
+ "showRegexInput": false,
3325
+ "enum": [],
3326
+ "display": "asdf",
3327
+ "key": "asdf"
3328
+ },
3329
+ {
3330
+ "type": "mobile",
3331
+ "showRegexInput": false,
3332
+ "enum": [],
3333
+ "display": "mob num",
3334
+ "regex": "[0-9]{10}$",
3335
+ "key": "mob-num"
3336
+ }
3337
+ ],
3338
+ "available_assignees": [
3339
+ "5e79e721768c6bf54b783146"
3340
+ ],
3341
+ "title": "asdf444",
3342
+ "description": "adf",
3343
+ "slug": "asdf444",
3344
+ "application_id": "000000000000000000000001",
3345
+ "created_on": {
3346
+ "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.96 Safari/537.36",
3347
+ "platform": "web",
3348
+ "meta": {
3349
+ "browser": {
3350
+ "name": "Chrome",
3351
+ "version": "88.0.4324.96"
3352
+ },
3353
+ "os": {
3354
+ "name": "macOS",
3355
+ "version": "10.15.7",
3356
+ "versionName": "Catalina"
3357
+ },
3358
+ "platform": {
3359
+ "type": "desktop",
3360
+ "vendor": "Apple"
3361
+ },
3362
+ "engine": {
3363
+ "name": "Blink"
3364
+ }
3365
+ }
3366
+ },
3367
+ "created_by": "5e79e721768c6bf54b783146",
3368
+ "createdAt": "2021-01-28T05:40:26.271Z",
3369
+ "updatedAt": "2021-02-18T16:02:32.086Z",
3370
+ "__v": 0,
3371
+ "poll_for_assignment": {
3372
+ "duration": 20,
3373
+ "message": "We are looking for executive to connect you",
3374
+ "success_message": "Executive found",
3375
+ "failure_message": "All our executives are busy at the moment, We have accepted your request and someone will connect with you soon!"
3376
+ },
3377
+ "id": "60124e4a4d2bc363625e1bf4"
3378
+ }
3379
+ ],
3380
+ "total": 2,
3381
+ "limit": 10,
3382
+ "page": 1,
3383
+ "pages": 1
3384
+ }
3385
+ }
3386
+ ```
3387
+ </details>
3388
+
3389
+ </details>
3390
+
3391
+
3392
+
3393
+
3394
+
3395
+
3396
+
3397
+
3398
+
3399
+ ---
3400
+
3401
+
3402
+ ### createCustomForm
3403
+ Creates a new custom form
3404
+
3405
+
3406
+
3407
+ ```javascript
3408
+ // Promise
3409
+ const promise = client.application("<APPLICATION_ID>").lead.createCustomForm({ body : value });
3410
+
3411
+ // Async/Await
3412
+ const data = await client.application("<APPLICATION_ID>").lead.createCustomForm({ body : value });
3413
+ ```
3414
+
3415
+
3416
+
3417
+
3418
+
3419
+ | Argument | Type | Required | Description |
3420
+ | --------- | ----- | -------- | ----------- |
3421
+ | body | [CreateCustomFormPayload](#CreateCustomFormPayload) | yes | Request body |
3422
+
3423
+
3424
+ Creates a new custom form for given application
3425
+
3426
+ *Returned Response:*
3427
+
3428
+
3429
+
3430
+
3431
+ [CustomForm](#CustomForm)
3432
+
3433
+ Success
3434
+
3435
+
3436
+
3437
+
3438
+ <details>
3439
+ <summary><i>&nbsp; Examples:</i></summary>
3440
+
3441
+
3442
+ <details>
3443
+ <summary><i>&nbsp; Default</i></summary>
3444
+
3445
+ ```json
3446
+ {
3447
+ "value": {
3448
+ "login_required": false,
3449
+ "should_notify": false,
3450
+ "inputs": [
3451
+ {
3452
+ "type": "email",
3453
+ "showRegexInput": true,
3454
+ "enum": [],
3455
+ "regex": "\\S+@\\S+\\.\\S+",
3456
+ "display": "email",
3457
+ "required": true,
3458
+ "key": "email"
3459
+ },
3460
+ {
3461
+ "type": "number",
3462
+ "showRegexInput": false,
3463
+ "enum": [],
3464
+ "display": "Enter your fav number",
3465
+ "placeholder": "123",
3466
+ "key": "enter-your-fav-number"
3467
+ }
3468
+ ],
3469
+ "available_assignees": [],
3470
+ "_id": "602e900a2042255c03cadaf0",
3471
+ "title": "service-test-satyen",
3472
+ "description": "testing form from service",
3473
+ "slug": "service-test-satyen",
3474
+ "header_image": "https://hdn-1.addsale.com/x0/support-ticket/files/free/original/KZL86aN5l-service-test-satyen.jpeg",
3475
+ "application_id": "000000000000000000000001",
3476
+ "created_on": {
3477
+ "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 11_2_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.150 Safari/537.36",
3478
+ "platform": "web",
3479
+ "meta": {
3480
+ "browser": {
3481
+ "name": "Chrome",
3482
+ "version": "88.0.4324.150"
3483
+ },
3484
+ "os": {
3485
+ "name": "macOS",
3486
+ "version": "11.2.0"
3487
+ },
3488
+ "platform": {
3489
+ "type": "desktop",
3490
+ "vendor": "Apple"
3491
+ },
3492
+ "engine": {
3493
+ "name": "Blink"
3494
+ }
3495
+ }
3496
+ },
3497
+ "created_by": "5f8147abbd1a0a870f61f1a6",
3498
+ "createdAt": "2021-02-18T16:04:26.495Z",
3499
+ "updatedAt": "2021-02-26T10:16:49.272Z",
3500
+ "__v": 0
3501
+ }
3502
+ }
3503
+ ```
3504
+ </details>
3505
+
3506
+ </details>
3507
+
3508
+
3509
+
3510
+
3511
+
3512
+
3513
+
3514
+
3515
+
3516
+ ---
3517
+
3518
+
3519
+ ### getTokenForVideoRoom
3520
+ Get Token to join a specific Video Room using it's unqiue name
3521
+
3522
+
3523
+
3524
+ ```javascript
3525
+ // Promise
3526
+ const promise = client.lead.getTokenForVideoRoom({ uniqueName : value });
3527
+
3528
+ // Async/Await
3529
+ const data = await client.lead.getTokenForVideoRoom({ uniqueName : value });
3530
+ ```
3531
+
3532
+
3533
+
3534
+
3535
+
3536
+ | Argument | Type | Required | Description |
3537
+ | --------- | ----- | -------- | ----------- |
3538
+ | uniqueName | string | yes | Unique name of video room |
3539
+
3540
+
3541
+
3542
+ 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.
3543
+
3544
+ *Returned Response:*
3545
+
3546
+
3547
+
3548
+
3549
+ [GetTokenForVideoRoomResponse](#GetTokenForVideoRoomResponse)
3550
+
3551
+ Success
3552
+
3553
+
3554
+
3555
+
3556
+ <details>
3557
+ <summary><i>&nbsp; Examples:</i></summary>
3558
+
3559
+
3560
+ <details>
3561
+ <summary><i>&nbsp; Default</i></summary>
3562
+
3563
+ ```json
3564
+ {
3565
+ "value": {
3566
+ "access_token": "your_token_to_the_room"
3567
+ }
3568
+ }
3569
+ ```
3570
+ </details>
3571
+
3572
+ </details>
3573
+
3574
+
3575
+
3576
+
3577
+
3578
+
3579
+
3580
+
3581
+
3582
+ ---
3583
+
3584
+
3585
+ ### getTokenForVideoRoom
3586
+ Get Token to join a specific Video Room using it's unqiue name
3587
+
3588
+
3589
+
3590
+ ```javascript
3591
+ // Promise
3592
+ const promise = client.application("<APPLICATION_ID>").lead.getTokenForVideoRoom({ uniqueName : value });
3593
+
3594
+ // Async/Await
3595
+ const data = await client.application("<APPLICATION_ID>").lead.getTokenForVideoRoom({ uniqueName : value });
3596
+ ```
3597
+
3598
+
3599
+
3600
+
3601
+
3602
+ | Argument | Type | Required | Description |
3603
+ | --------- | ----- | -------- | ----------- |
3604
+ | uniqueName | string | yes | Unique name of video room |
3605
+
3606
+
3607
+
3608
+ 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.
3609
+
3610
+ *Returned Response:*
3611
+
3612
+
3613
+
3614
+
3615
+ [GetTokenForVideoRoomResponse](#GetTokenForVideoRoomResponse)
3616
+
3617
+ Success
3618
+
3619
+
3620
+
3621
+
3622
+ <details>
3623
+ <summary><i>&nbsp; Examples:</i></summary>
3624
+
3625
+
3626
+ <details>
3627
+ <summary><i>&nbsp; Default</i></summary>
3628
+
3629
+ ```json
3630
+ {
3631
+ "value": {
3632
+ "access_token": "your_token_to_the_room"
3633
+ }
3634
+ }
3635
+ ```
3636
+ </details>
3637
+
3638
+ </details>
3639
+
3640
+
3641
+
3642
+
3643
+
3644
+
3645
+
3646
+
3647
+
3648
+ ---
3649
+
3650
+
3651
+ ### getVideoParticipants
3652
+ Get participants of a specific Video Room using it's unique name
3653
+
3654
+
3655
+
3656
+ ```javascript
3657
+ // Promise
3658
+ const promise = client.lead.getVideoParticipants({ uniqueName : value });
3659
+
3660
+ // Async/Await
3661
+ const data = await client.lead.getVideoParticipants({ uniqueName : value });
3662
+ ```
3663
+
3664
+
3665
+
3666
+
3667
+
3668
+ | Argument | Type | Required | Description |
3669
+ | --------- | ----- | -------- | ----------- |
3670
+ | uniqueName | string | yes | Unique name of Video Room |
3671
+
3672
+
3673
+
3674
+ 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.
3675
+
3676
+ *Returned Response:*
3677
+
3678
+
3679
+
3680
+
3681
+ [GetParticipantsInsideVideoRoomResponse](#GetParticipantsInsideVideoRoomResponse)
3682
+
3683
+ Success
3684
+
3685
+
3686
+
3687
+
3688
+ <details>
3689
+ <summary><i>&nbsp; Examples:</i></summary>
3690
+
3691
+
3692
+ <details>
3693
+ <summary><i>&nbsp; Default</i></summary>
3694
+
3695
+ ```json
3696
+ {
3697
+ "value": {
3698
+ "participants": []
3699
+ }
3700
+ }
3701
+ ```
3702
+ </details>
3703
+
3704
+ </details>
3705
+
3706
+
3707
+
3708
+
3709
+
3710
+
3711
+
3712
+
3713
+
3714
+ ---
3715
+
3716
+
3717
+ ### getVideoParticipants
3718
+ Get participants of a specific Video Room using it's unique name
3719
+
3720
+
3721
+
3722
+ ```javascript
3723
+ // Promise
3724
+ const promise = client.application("<APPLICATION_ID>").lead.getVideoParticipants({ uniqueName : value });
3725
+
3726
+ // Async/Await
3727
+ const data = await client.application("<APPLICATION_ID>").lead.getVideoParticipants({ uniqueName : value });
3728
+ ```
3729
+
3730
+
3731
+
3732
+
3733
+
3734
+ | Argument | Type | Required | Description |
3735
+ | --------- | ----- | -------- | ----------- |
3736
+ | uniqueName | string | yes | Unique name of Video Room |
3737
+
3738
+
3739
+
3740
+ 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.
3741
+
3742
+ *Returned Response:*
3743
+
3744
+
3745
+
3746
+
3747
+ [GetParticipantsInsideVideoRoomResponse](#GetParticipantsInsideVideoRoomResponse)
3748
+
3749
+ Success
3750
+
3751
+
3752
+
3753
+
3754
+ <details>
3755
+ <summary><i>&nbsp; Examples:</i></summary>
3756
+
3757
+
3758
+ <details>
3759
+ <summary><i>&nbsp; Default</i></summary>
3760
+
3761
+ ```json
3762
+ {
3763
+ "value": {
3764
+ "participants": []
3765
+ }
3766
+ }
3767
+ ```
3768
+ </details>
3769
+
3770
+ </details>
3771
+
3772
+
3773
+
3774
+
3775
+
3776
+
3777
+
3778
+
3779
+
3780
+ ---
3781
+
3782
+
3783
+ ### openVideoRoom
3784
+ Open a video room.
3785
+
3786
+
3787
+
3788
+ ```javascript
3789
+ // Promise
3790
+ const promise = client.application("<APPLICATION_ID>").lead.openVideoRoom({ body : value });
3791
+
3792
+ // Async/Await
3793
+ const data = await client.application("<APPLICATION_ID>").lead.openVideoRoom({ body : value });
3794
+ ```
3795
+
3796
+
3797
+
3798
+
3799
+
3800
+ | Argument | Type | Required | Description |
3801
+ | --------- | ----- | -------- | ----------- |
3802
+ | body | [CreateVideoRoomPayload](#CreateVideoRoomPayload) | yes | Request body |
3803
+
3804
+
3805
+ Open a video room.
3806
+
3807
+ *Returned Response:*
3808
+
3809
+
3810
+
3811
+
3812
+ [CreateVideoRoomResponse](#CreateVideoRoomResponse)
3813
+
3814
+ Success
3815
+
3816
+
3817
+
3818
+
3819
+ <details>
3820
+ <summary><i>&nbsp; Examples:</i></summary>
3821
+
3822
+
3823
+ <details>
3824
+ <summary><i>&nbsp; Default</i></summary>
3825
+
3826
+ ```json
3827
+ {
3828
+ "value": {
3829
+ "unique_name": "alphanumeric123"
3830
+ }
3831
+ }
3832
+ ```
3833
+ </details>
3834
+
3835
+ </details>
3836
+
3837
+
3838
+
3839
+
3840
+
3841
+
3842
+
3843
+
3844
+
3845
+ ---
3846
+
3847
+
3848
+ ### closeVideoRoom
3849
+ Close the video room and force all participants to leave.
3850
+
3851
+
3852
+
3853
+ ```javascript
3854
+ // Promise
3855
+ const promise = client.application("<APPLICATION_ID>").lead.closeVideoRoom({ uniqueName : value });
3856
+
3857
+ // Async/Await
3858
+ const data = await client.application("<APPLICATION_ID>").lead.closeVideoRoom({ uniqueName : value });
3859
+ ```
3860
+
3861
+
3862
+
3863
+
3864
+
3865
+ | Argument | Type | Required | Description |
3866
+ | --------- | ----- | -------- | ----------- |
3867
+ | uniqueName | string | yes | Unique name of Video Room |
3868
+
3869
+
3870
+
3871
+ Close the video room and force all participants to leave.
3872
+
3873
+ *Returned Response:*
3874
+
3875
+
3876
+
3877
+
3878
+ [CloseVideoRoomResponse](#CloseVideoRoomResponse)
3879
+
3880
+ Success
3881
+
3882
+
3883
+
3884
+
3885
+ <details>
3886
+ <summary><i>&nbsp; Examples:</i></summary>
3887
+
3888
+
3889
+ <details>
3890
+ <summary><i>&nbsp; Default</i></summary>
3891
+
3892
+ ```json
3893
+ {
3894
+ "value": {
3895
+ "success": true
3896
+ }
3897
+ }
3898
+ ```
3899
+ </details>
3900
+
3901
+ </details>
3902
+
3903
+
3904
+
3905
+
3906
+
3907
+
3908
+
3909
+
3910
+
3911
+ ---
3912
+
3913
+
3914
+ ### getGeneralConfig
3915
+ Get general support configuration.
3916
+
3917
+
3918
+
3919
+ ```javascript
3920
+ // Promise
3921
+ const promise = client.lead.getGeneralConfig();
3922
+
3923
+ // Async/Await
3924
+ const data = await client.lead.getGeneralConfig();
3925
+ ```
3926
+
3927
+
3928
+
3929
+
3930
+
3931
+
3932
+ Get general support configuration.
3933
+
3934
+ *Returned Response:*
3935
+
3936
+
3937
+
3938
+
3939
+ [CloseVideoRoomResponse](#CloseVideoRoomResponse)
3940
+
3941
+ Success
3942
+
3943
+
3944
+
3945
+
3946
+ <details>
3947
+ <summary><i>&nbsp; Examples:</i></summary>
3948
+
3949
+
3950
+ <details>
3951
+ <summary><i>&nbsp; Default</i></summary>
3952
+
3953
+ ```json
3954
+ {
3955
+ "value": {
3956
+ "success": true
3957
+ }
3958
+ }
3959
+ ```
3960
+ </details>
3961
+
3962
+ </details>
3963
+
3964
+
3965
+
3966
+
3967
+
3968
+
3969
+
3970
+
3971
+
3972
+ ---
3973
+
3974
+
3975
+
3976
+ ### Schemas
3977
+
3978
+
3979
+
3980
+ #### [TicketList](#TicketList)
3981
+
3982
+ | Properties | Type | Nullable | Description |
3983
+ | ---------- | ---- | -------- | ----------- |
3984
+ | items | [[Ticket](#Ticket)] | no | List of tickets |
3985
+ | filters | [Filter](#Filter) | no | All the filters available for tickets |
3986
+ | page | [Page](#Page) | no | Describes the pagination state |
3987
+
3988
+ ---
3989
+
3990
+
3991
+
3992
+
3993
+ #### [Page](#Page)
3994
+
3995
+ | Properties | Type | Nullable | Description |
3996
+ | ---------- | ---- | -------- | ----------- |
3997
+ | item_total | number | no | |
3998
+ | next_id | string | no | |
3999
+ | has_previous | boolean | no | |
4000
+ | has_next | boolean | no | |
4001
+ | current | number | no | |
4002
+ | type | string | yes | |
4003
+ | size | number | no | |
4004
+
4005
+ ---
4006
+
4007
+
4008
+
4009
+
4010
+ #### [TicketHistoryList](#TicketHistoryList)
4011
+
4012
+ | Properties | Type | Nullable | Description |
4013
+ | ---------- | ---- | -------- | ----------- |
4014
+ | items | [[TicketHistory](#TicketHistory)] | no | List of ticket history |
4015
+ | page | [Page](#Page) | no | Describes the pagination state |
4016
+
4017
+ ---
4018
+
4019
+
4020
+
4021
+
4022
+ #### [CustomFormList](#CustomFormList)
4023
+
4024
+ | Properties | Type | Nullable | Description |
4025
+ | ---------- | ---- | -------- | ----------- |
4026
+ | items | [[CustomForm](#CustomForm)] | no | List of forms |
4027
+ | page | [Page](#Page) | no | Describes the pagination state |
4028
+
4029
+ ---
4030
+
4031
+
4032
+
4033
+
4034
+ #### [CreateCustomFormPayload](#CreateCustomFormPayload)
4035
+
4036
+ | Properties | Type | Nullable | Description |
4037
+ | ---------- | ---- | -------- | ----------- |
4038
+ | slug | string | yes | Slug for the form |
4039
+ | title | string | yes | Title for the form |
4040
+ | inputs | [string] | yes | List of all the form components |
4041
+ | description | string | no | Description of the form |
4042
+ | header_image | string | no | Header image that is to be shown for the form |
4043
+ | priority | [PriorityEnum](#PriorityEnum) | yes | Describes the priority of the tickets created by the form |
4044
+ | should_notify | boolean | no | Indicates if staff should be notified when a response is received |
4045
+ | success_message | string | no | Success message that will be shown on submission |
4046
+ | poll_for_assignment | [PollForAssignment](#PollForAssignment) | no | Describes how polling will be done for the tickets createds |
4047
+
4048
+ ---
4049
+
4050
+
4051
+
4052
+
4053
+ #### [EditCustomFormPayload](#EditCustomFormPayload)
4054
+
4055
+ | Properties | Type | Nullable | Description |
4056
+ | ---------- | ---- | -------- | ----------- |
4057
+ | title | string | yes | Title for the form |
4058
+ | inputs | [string] | yes | List of all the form components |
4059
+ | description | string | no | Description of the form |
4060
+ | priority | [PriorityEnum](#PriorityEnum) | yes | Describes the priority of the tickets created by the form |
4061
+ | header_image | string | no | Header image that is to be shown for the form |
4062
+ | should_notify | boolean | no | Indicates if staff should be notified when a response is received |
4063
+ | login_required | boolean | no | Denotes if login is required to make a form response submission |
4064
+ | success_message | string | no | Success message that will be shown on submission |
4065
+ | poll_for_assignment | [PollForAssignment](#PollForAssignment) | no | Describes how polling will be done for the tickets createds |
4066
+
4067
+ ---
4068
+
4069
+
4070
+
4071
+
4072
+ #### [EditTicketPayload](#EditTicketPayload)
4073
+
4074
+ | Properties | Type | Nullable | Description |
4075
+ | ---------- | ---- | -------- | ----------- |
4076
+ | content | [TicketContent](#TicketContent) | no | Ticket conetent details |
4077
+ | category | string | no | Category assigned to the ticket |
4078
+ | sub_category | string | no | Sub-category assigned to the ticket |
4079
+ | source | string | no | Denotes if the ticket was created at company or application level |
4080
+ | status | string | no | Denotes in what state is the ticket |
4081
+ | priority | [PriorityEnum](#PriorityEnum) | no | Denotes the priority of ticket |
4082
+ | assigned_to | [AgentChangePayload](#AgentChangePayload) | no | Details of support staff to whom ticket is assigned |
4083
+ | tags | [string] | no | Tags relevant to ticket |
4084
+
4085
+ ---
4086
+
4087
+
4088
+
4089
+
4090
+ #### [AgentChangePayload](#AgentChangePayload)
4091
+
4092
+ | Properties | Type | Nullable | Description |
4093
+ | ---------- | ---- | -------- | ----------- |
4094
+ | agent_id | string | yes | Agent's unique ID |
4095
+
4096
+ ---
4097
+
4098
+
4099
+
4100
+
4101
+ #### [CreateVideoRoomResponse](#CreateVideoRoomResponse)
4102
+
4103
+ | Properties | Type | Nullable | Description |
4104
+ | ---------- | ---- | -------- | ----------- |
4105
+ | unique_name | string | yes | Video Room's unique name |
4106
+
4107
+ ---
4108
+
4109
+
4110
+
4111
+
4112
+ #### [CloseVideoRoomResponse](#CloseVideoRoomResponse)
4113
+
4114
+ | Properties | Type | Nullable | Description |
4115
+ | ---------- | ---- | -------- | ----------- |
4116
+ | success | boolean | yes | Denotes if operation was successfully |
4117
+
4118
+ ---
4119
+
4120
+
4121
+
4122
+
4123
+ #### [CreateVideoRoomPayload](#CreateVideoRoomPayload)
4124
+
4125
+ | Properties | Type | Nullable | Description |
4126
+ | ---------- | ---- | -------- | ----------- |
4127
+ | unique_name | string | yes | Ticket id |
4128
+ | notify | [[NotifyUser](#NotifyUser)] | no | List of people to be notified |
4129
+
4130
+ ---
4131
+
4132
+
4133
+
4134
+
4135
+ #### [NotifyUser](#NotifyUser)
4136
+
4137
+ | Properties | Type | Nullable | Description |
4138
+ | ---------- | ---- | -------- | ----------- |
4139
+ | country_code | string | yes | Country code |
4140
+ | phone_number | string | yes | Phone number |
4141
+
4142
+ ---
4143
+
4144
+
4145
+
4146
+
4147
+ #### [Filter](#Filter)
4148
+
4149
+ | Properties | Type | Nullable | Description |
4150
+ | ---------- | ---- | -------- | ----------- |
4151
+ | priorities | [[Priority](#Priority)] | yes | List of possible priorities for tickets |
4152
+ | categories | [[TicketCategory](#TicketCategory)] | no | List of possible categories for tickets |
4153
+ | statuses | [[Status](#Status)] | yes | List of possible statuses for tickets |
4154
+ | assignees | [string] | yes | List of support staff availble for tickets assignment |
4155
+
4156
+ ---
4157
+
4158
+
4159
+
4160
+
4161
+ #### [TicketHistoryPayload](#TicketHistoryPayload)
4162
+
4163
+ | Properties | Type | Nullable | Description |
4164
+ | ---------- | ---- | -------- | ----------- |
4165
+ | value | string | yes | Details of history event |
4166
+ | type | [HistoryTypeEnum](#HistoryTypeEnum) | yes | Type of history event |
4167
+
4168
+ ---
4169
+
4170
+
4171
+
4172
+
4173
+ #### [CustomFormSubmissionPayload](#CustomFormSubmissionPayload)
4174
+
4175
+ | Properties | Type | Nullable | Description |
4176
+ | ---------- | ---- | -------- | ----------- |
4177
+ | response | [string] | yes | Form response |
4178
+ | attachments | [[TicketAsset](#TicketAsset)] | no | List of all attachments related to the form |
4179
+
4180
+ ---
4181
+
4182
+
4183
+
4184
+
4185
+ #### [GetTokenForVideoRoomResponse](#GetTokenForVideoRoomResponse)
4186
+
4187
+ | Properties | Type | Nullable | Description |
4188
+ | ---------- | ---- | -------- | ----------- |
4189
+ | access_token | string | yes | Access token to be used for video room |
4190
+
4191
+ ---
4192
+
4193
+
4194
+
4195
+
4196
+ #### [GetParticipantsInsideVideoRoomResponse](#GetParticipantsInsideVideoRoomResponse)
4197
+
4198
+ | Properties | Type | Nullable | Description |
4199
+ | ---------- | ---- | -------- | ----------- |
4200
+ | participants | [[Participant](#Participant)] | yes | List of participants of the video room |
4201
+
4202
+ ---
4203
+
4204
+
4205
+
4206
+
4207
+ #### [Participant](#Participant)
4208
+
4209
+ | Properties | Type | Nullable | Description |
4210
+ | ---------- | ---- | -------- | ----------- |
4211
+ | user | [UserSchema](#UserSchema) | no | Details of participant |
4212
+ | identity | string | no | Unique identifier of participant |
4213
+ | status | string | no | Status of participant |
4214
+
4215
+ ---
4216
+
4217
+
4218
+
4219
+
4220
+ #### [UserSchema](#UserSchema)
4221
+
4222
+ | Properties | Type | Nullable | Description |
4223
+ | ---------- | ---- | -------- | ----------- |
4224
+ | first_name | string | no | First name |
4225
+ | last_name | string | no | Last name |
4226
+ | phone_numbers | [[PhoneNumber](#PhoneNumber)] | no | List of phone numbers |
4227
+ | emails | [[Email](#Email)] | no | List of email addresses |
4228
+ | gender | string | no | Gender of user |
4229
+ | active | boolean | no | Is account active |
4230
+ | profile_pic_url | string | no | URL for profile pic |
4231
+ | username | string | no | username of user |
4232
+ | account_type | string | no | Type of account |
4233
+ | uid | string | no | Unique identifier of user |
4234
+ | debug | [Debug](#Debug) | no | Used for debugging |
4235
+ | has_old_password_hash | boolean | no | Denotes if user has old password hash |
4236
+ | _id | string | no | Unique identifier of user |
4237
+ | created_at | string | no | Time of user creation |
4238
+ | updated_at | string | no | Last time of user details update |
4239
+
4240
+ ---
4241
+
4242
+
4243
+
4244
+
4245
+ #### [PhoneNumber](#PhoneNumber)
4246
+
4247
+ | Properties | Type | Nullable | Description |
4248
+ | ---------- | ---- | -------- | ----------- |
4249
+ | active | boolean | no | Denotes if the phone number is active |
4250
+ | primary | boolean | no | Denotes it's the primary phone number for the account |
4251
+ | verified | boolean | no | Denotes it's a verified phone number |
4252
+ | phone | string | no | Phone number |
4253
+ | country_code | number | no | Country code |
4254
+
4255
+ ---
4256
+
4257
+
4258
+
4259
+
4260
+ #### [Email](#Email)
4261
+
4262
+ | Properties | Type | Nullable | Description |
4263
+ | ---------- | ---- | -------- | ----------- |
4264
+ | primary | boolean | no | Denotes it's the primary email for the account |
4265
+ | verified | boolean | no | Denotes it's a verified email |
4266
+ | email | string | no | Email Address |
4267
+ | active | boolean | no | Denotes if the email is active |
4268
+
4269
+ ---
4270
+
4271
+
4272
+
4273
+
4274
+ #### [Debug](#Debug)
4275
+
4276
+ | Properties | Type | Nullable | Description |
4277
+ | ---------- | ---- | -------- | ----------- |
4278
+ | source | string | no | Source of user |
4279
+ | platform | string | no | Platform of user |
4280
+
4281
+ ---
4282
+
4283
+
4284
+
4285
+
4286
+ #### [SubmitCustomFormResponse](#SubmitCustomFormResponse)
4287
+
4288
+ | Properties | Type | Nullable | Description |
4289
+ | ---------- | ---- | -------- | ----------- |
4290
+ | message | string | yes | Success message for form submission |
4291
+ | ticket | [Ticket](#Ticket) | yes | Ticket created on form submission |
4292
+
4293
+ ---
4294
+
4295
+
4296
+
4297
+
4298
+ #### [TicketContext](#TicketContext)
4299
+
4300
+ | Properties | Type | Nullable | Description |
4301
+ | ---------- | ---- | -------- | ----------- |
4302
+ | application_id | string | no | Application ID related to the ticket |
4303
+ | company_id | string | yes | Company ID related to the ticket |
4304
+
4305
+ ---
4306
+
4307
+
4308
+
4309
+
4310
+ #### [CreatedOn](#CreatedOn)
4311
+
4312
+ | Properties | Type | Nullable | Description |
4313
+ | ---------- | ---- | -------- | ----------- |
4314
+ | user_agent | string | yes | Useragent details |
4315
+
4316
+ ---
4317
+
4318
+
4319
+
4320
+
4321
+ #### [TicketAsset](#TicketAsset)
4322
+
4323
+ | Properties | Type | Nullable | Description |
4324
+ | ---------- | ---- | -------- | ----------- |
4325
+ | display | string | no | Display text for asset |
4326
+ | value | string | yes | To be used for details |
4327
+ | type | [TicketAssetTypeEnum](#TicketAssetTypeEnum) | yes | Type of asset |
4328
+
4329
+ ---
4330
+
4331
+
4332
+
4333
+
4334
+ #### [TicketContent](#TicketContent)
4335
+
4336
+ | Properties | Type | Nullable | Description |
4337
+ | ---------- | ---- | -------- | ----------- |
4338
+ | title | string | yes | Title for ticket |
4339
+ | description | string | no | Long description of issue |
4340
+ | attachments | [[TicketAsset](#TicketAsset)] | no | List of all attachments related to the ticket |
4341
+
4342
+ ---
4343
+
4344
+
4345
+
4346
+
4347
+ #### [AddTicketPayload](#AddTicketPayload)
4348
+
4349
+ | Properties | Type | Nullable | Description |
4350
+ | ---------- | ---- | -------- | ----------- |
4351
+ | created_by | string | no | Creator of the ticket |
4352
+ | status | string | no | Status of the ticket |
4353
+ | priority | [PriorityEnum](#PriorityEnum) | no | Priority of the ticket |
4354
+ | category | string | yes | Category of the ticket |
4355
+ | content | [TicketContent](#TicketContent) | yes | Content for the ticket |
4356
+ | _custom_json | string | no | optional custom data that needs to be sent |
4357
+
4358
+ ---
4359
+
4360
+
4361
+
4362
+
4363
+ #### [Priority](#Priority)
4364
+
4365
+ | Properties | Type | Nullable | Description |
4366
+ | ---------- | ---- | -------- | ----------- |
4367
+ | key | [PriorityEnum](#PriorityEnum) | yes | Key for priority |
4368
+ | display | string | yes | Display text for priority |
4369
+ | color | string | yes | Color for priority |
4370
+
4371
+ ---
4372
+
4373
+
4374
+
4375
+
4376
+ #### [Status](#Status)
4377
+
4378
+ | Properties | Type | Nullable | Description |
4379
+ | ---------- | ---- | -------- | ----------- |
4380
+ | key | string | yes | Key for status |
4381
+ | display | string | yes | Display text for status |
4382
+ | color | string | yes | Color for status |
4383
+
4384
+ ---
4385
+
4386
+
4387
+
4388
+
4389
+ #### [TicketFeedbackForm](#TicketFeedbackForm)
4390
+
4391
+ | Properties | Type | Nullable | Description |
4392
+ | ---------- | ---- | -------- | ----------- |
4393
+ | title | string | yes | Feedback form title that will be shown to the user |
4394
+ | display | [string] | no | List of all the form fields |
4395
+
4396
+ ---
4397
+
4398
+
4399
+
4400
+
4401
+ #### [TicketFeedbackList](#TicketFeedbackList)
4402
+
4403
+ | Properties | Type | Nullable | Description |
4404
+ | ---------- | ---- | -------- | ----------- |
4405
+ | items | [[TicketFeedback](#TicketFeedback)] | no | List of all ticket feedback for the ticket |
4406
+
4407
+ ---
4408
+
4409
+
4410
+
4411
+
4412
+ #### [TicketFeedbackPayload](#TicketFeedbackPayload)
4413
+
4414
+ | Properties | Type | Nullable | Description |
4415
+ | ---------- | ---- | -------- | ----------- |
4416
+ | form_response | string | no | Key-value pairs of all the form fields and their response |
4417
+
4418
+ ---
4419
+
4420
+
4421
+
4422
+
4423
+ #### [SubmitButton](#SubmitButton)
4424
+
4425
+ | Properties | Type | Nullable | Description |
4426
+ | ---------- | ---- | -------- | ----------- |
4427
+ | title | string | yes | Title for submit button |
4428
+ | title_color | string | yes | Title color submit button |
4429
+ | background_color | string | yes | Color for submit button |
4430
+
4431
+ ---
4432
+
4433
+
4434
+
4435
+
4436
+ #### [PollForAssignment](#PollForAssignment)
4437
+
4438
+ | Properties | Type | Nullable | Description |
4439
+ | ---------- | ---- | -------- | ----------- |
4440
+ | duration | number | yes | Duration for polling of staff |
4441
+ | message | string | yes | Message for polling |
4442
+ | success_message | string | yes | Message for successful polling |
4443
+ | failure_message | string | yes | Message if polling failed |
4444
+
4445
+ ---
4446
+
4447
+
4448
+
4449
+
4450
+ #### [CustomForm](#CustomForm)
4451
+
4452
+ | Properties | Type | Nullable | Description |
4453
+ | ---------- | ---- | -------- | ----------- |
4454
+ | application_id | string | yes | Application ID for form |
4455
+ | slug | string | yes | Slug for the form, which is to be used for accessing the form |
4456
+ | header_image | string | no | Form header image that will be shown to the user |
4457
+ | title | string | yes | Form title that will be shown to the user |
4458
+ | description | string | no | Form description that will be shown to the user |
4459
+ | priority | [Priority](#Priority) | yes | Sets priority of tickets created by form response |
4460
+ | login_required | boolean | yes | Denotes if login is required to make a form response submission |
4461
+ | should_notify | boolean | yes | Denotes if new response submission for the form should be notified to the assignees |
4462
+ | success_message | string | no | Message that is to be shown on succesfull form response submission |
4463
+ | submit_button | [SubmitButton](#SubmitButton) | no | Details for submit button |
4464
+ | inputs | [string] | yes | List of all the form fields |
4465
+ | created_on | [CreatedOn](#CreatedOn) | no | Gives details of when the form was created |
4466
+ | poll_for_assignment | [PollForAssignment](#PollForAssignment) | no | Details of how polling should be done for support |
4467
+ | _id | string | yes | Unique identifier for the form |
4468
+
4469
+ ---
4470
+
4471
+
4472
+
4473
+
4474
+ #### [CommunicationDetails](#CommunicationDetails)
4475
+
4476
+ | Properties | Type | Nullable | Description |
4477
+ | ---------- | ---- | -------- | ----------- |
4478
+ | type | string | no | Enum type for the communication method |
4479
+ | title | string | no | Title for the communication method |
4480
+ | value | string | no | Value for the communication method |
4481
+ | description | string | no | Short description for the communication method |
4482
+ | enabled | boolean | no | Denotes if this communication method has to be shown |
4483
+
4484
+ ---
4485
+
4486
+
4487
+
4488
+
4489
+ #### [SupportGeneralConfig](#SupportGeneralConfig)
4490
+
4491
+ | Properties | Type | Nullable | Description |
4492
+ | ---------- | ---- | -------- | ----------- |
4493
+ | _id | string | no | Unique id |
4494
+ | support_email | [CommunicationDetails](#CommunicationDetails) | no | Support e-mail details |
4495
+ | support_phone | [CommunicationDetails](#CommunicationDetails) | no | Support Phone number details |
4496
+ | support_faq | [CommunicationDetails](#CommunicationDetails) | no | Support FAQ details |
4497
+ | show_communication_info | boolean | no | Denotes if support communication info should be shown |
4498
+ | support_communication | [CommunicationDetails](#CommunicationDetails) | no | Support communication array list details |
4499
+ | show_support_dris | boolean | no | Denotes if support DRIS info should be shown |
4500
+ | integration | string | no | Contains integrations basic information |
4501
+
4502
+ ---
4503
+
4504
+
4505
+
4506
+
4507
+ #### [FeedbackForm](#FeedbackForm)
4508
+
4509
+ | Properties | Type | Nullable | Description |
4510
+ | ---------- | ---- | -------- | ----------- |
4511
+ | inputs | string | no | Input details for the feed back form |
4512
+ | title | string | no | Title for the feed back form |
4513
+ | timestamps | string | no | Gives details of category releted data |
4514
+
4515
+ ---
4516
+
4517
+
4518
+
4519
+
4520
+ #### [TicketSubCategory](#TicketSubCategory)
4521
+
4522
+ | Properties | Type | Nullable | Description |
4523
+ | ---------- | ---- | -------- | ----------- |
4524
+ | key | string | yes | Key for sub-category |
4525
+ | display | string | yes | Display text for sub-category |
4526
+ | sub_categories | [TicketSubCategory](#TicketSubCategory) | no | |
4527
+
4528
+ ---
4529
+
4530
+
4531
+
4532
+
4533
+ #### [TicketCategory](#TicketCategory)
4534
+
4535
+ | Properties | Type | Nullable | Description |
4536
+ | ---------- | ---- | -------- | ----------- |
4537
+ | display | string | yes | Category display value identifier |
4538
+ | key | string | yes | Category key value identifier |
4539
+ | sub_categories | [TicketCategory](#TicketCategory) | no | Support category array list details |
4540
+ | group_id | number | no | Group id of category releted data |
4541
+ | feedback_form | [FeedbackForm](#FeedbackForm) | no | Support category array list details |
4542
+
4543
+ ---
4544
+
4545
+
4546
+
4547
+
4548
+ #### [CategoryData](#CategoryData)
4549
+
4550
+ | Properties | Type | Nullable | Description |
4551
+ | ---------- | ---- | -------- | ----------- |
4552
+ | list | [TicketCategory](#TicketCategory) | no | |
4553
+
4554
+ ---
4555
+
4556
+
4557
+
4558
+
4559
+ #### [IntegrationConfig](#IntegrationConfig)
4560
+
4561
+ | Properties | Type | Nullable | Description |
4562
+ | ---------- | ---- | -------- | ----------- |
4563
+ | _id | string | no | Unique id |
4564
+ | integration_type | string | yes | Enum string values for integration |
4565
+ | base_url | string | no | Integration base url for validate and create ticket |
4566
+ | create_ticket_apikey | string | no | Integration apikey to validate and create ticket |
4567
+ | update_ticket_apikey | string | no | Integration apikey to update ticket |
4568
+ | category_sync_apikey | string | no | Integration apikey to sync category of selected type |
4569
+ | category_data | [CategoryData](#CategoryData) | no | Support category array list details |
4570
+ | webhook_apikey | string | no | Integration webhook apikey to got callbacks from integration type dashboard like freshdesk, etc |
4571
+ | config_completed | boolean | no | Denotes the current intergration is completed or partially done |
4572
+ | allow_ticket_creation | boolean | yes | Denotes ticket creation enable or disable on platform |
4573
+ | show_listing | boolean | yes | Denotes ticket listing enable or disable on platform |
4574
+
4575
+ ---
4576
+
4577
+
4578
+
4579
+
4580
+ #### [FeedbackResponseItem](#FeedbackResponseItem)
4581
+
4582
+ | Properties | Type | Nullable | Description |
4583
+ | ---------- | ---- | -------- | ----------- |
4584
+ | display | string | yes | Question/Title of the form field |
4585
+ | key | string | yes | Key of the form field |
4586
+ | value | string | yes | User response value for the form field |
4587
+
4588
+ ---
4589
+
4590
+
4591
+
4592
+
4593
+ #### [TicketFeedback](#TicketFeedback)
4594
+
4595
+ | Properties | Type | Nullable | Description |
4596
+ | ---------- | ---- | -------- | ----------- |
4597
+ | _id | string | yes | Unique identifier for the feedback |
4598
+ | ticket_id | string | yes | Readable ticket number |
4599
+ | company_id | string | yes | Company id for which ticket was raised |
4600
+ | response | [[FeedbackResponseItem](#FeedbackResponseItem)] | yes | |
4601
+ | category | string | no | Category of the ticket |
4602
+ | user | string | no | User who submitted the feedback |
4603
+ | updated_at | string | no | Time when the feedback was last updated |
4604
+ | created_at | string | no | Time when the feedback was created |
4605
+
4606
+ ---
4607
+
4608
+
4609
+
4610
+
4611
+ #### [TicketHistory](#TicketHistory)
4612
+
4613
+ | Properties | Type | Nullable | Description |
4614
+ | ---------- | ---- | -------- | ----------- |
4615
+ | type | string | yes | Type of the history event |
4616
+ | value | string | yes | Data of the history event |
4617
+ | ticket_id | string | yes | Readable ticket number |
4618
+ | created_on | [CreatedOn](#CreatedOn) | no | Time of creation of the history event |
4619
+ | created_by | string | no | User who created the history event |
4620
+ | _id | string | yes | Unique identifier of the history event |
4621
+ | updated_at | string | no | Time of last update of the history event |
4622
+ | created_at | string | no | Time of creation of the history event |
4623
+
4624
+ ---
4625
+
4626
+
4627
+
4628
+
4629
+ #### [Ticket](#Ticket)
4630
+
4631
+ | Properties | Type | Nullable | Description |
4632
+ | ---------- | ---- | -------- | ----------- |
4633
+ | context | [TicketContext](#TicketContext) | no | Details of company and application realated to the ticket |
4634
+ | created_on | [CreatedOn](#CreatedOn) | no | Details of company and application realated to the ticket |
4635
+ | response_id | string | no | Details of company and application realated to the ticket |
4636
+ | content | [TicketContent](#TicketContent) | no | Ticket conetent details |
4637
+ | category | string | yes | Category assigned to the ticket |
4638
+ | sub_category | string | no | Sub-category assigned to the ticket |
4639
+ | source | [TicketSourceEnum](#TicketSourceEnum) | yes | Denotes if the ticket was created at company or application level |
4640
+ | status | [Status](#Status) | yes | Denotes in what state is the ticket |
4641
+ | priority | [Priority](#Priority) | yes | Denotes the priority of ticket |
4642
+ | created_by | string | no | User details of ticket creator |
4643
+ | assigned_to | string | no | Details of support staff to whom ticket is assigned |
4644
+ | tags | [string] | no | Tags relevant to ticket |
4645
+ | _custom_json | string | no | custom json relevant to the ticket |
4646
+ | is_feedback_pending | boolean | no | Denotes if feedback submission is pending for the ticket |
4647
+ | integration | string | no | Integration type and its details of the ticket |
4648
+ | _id | string | yes | Unique identifier for the ticket |
4649
+ | updated_at | string | no | Time when the ticket was last updated |
4650
+ | created_at | string | no | Time when the ticket was created |
4651
+
4652
+ ---
4653
+
4654
+
4655
+
4656
+
4657
+ ### Enums
4658
+
4659
+
4660
+
4661
+
4662
+
4663
+ #### [PriorityEnum](#PriorityEnum)
4664
+ Type : string
4665
+
4666
+ | Name | Value | Description |
4667
+ | ---- | ----- | ----------- |
4668
+ | low | low | This means ticket is low priority |
4669
+ | medium | medium | This means ticket is medium priority |
4670
+ | high | high | This means ticket is high priority |
4671
+ | urgent | urgent | This means ticket is of urgent priority |
4672
+
4673
+ ---
4674
+
4675
+
4676
+
4677
+ #### [HistoryTypeEnum](#HistoryTypeEnum)
4678
+ Type : string
4679
+
4680
+ | Name | Value | Description |
4681
+ | ---- | ----- | ----------- |
4682
+ | rating | rating | This means history event is a rating |
4683
+ | log | log | This means history event is a changelog |
4684
+ | comment | comment | This means history event is a comment |
4685
+
4686
+ ---
4687
+
4688
+
4689
+
4690
+ #### [TicketAssetTypeEnum](#TicketAssetTypeEnum)
4691
+ Type : string
4692
+
4693
+ | Name | Value | Description |
4694
+ | ---- | ----- | ----------- |
4695
+ | image | image | Denotes asset is of image type |
4696
+ | video | video | Denotes asset is of video type |
4697
+ | file | file | Denotes asset is of file type |
4698
+ | youtube | youtube | Denotes asset is an youtube link |
4699
+ | product | product | Denotes asset is of product type |
4700
+ | collection | collection | Denotes asset is of collection type |
4701
+ | brand | brand | Denotes asset is of brand type |
4702
+ | shipment | shipment | Denotes asset is of shipment type |
4703
+ | order | order | Denotes asset is of order type |
4704
+
4705
+ ---
4706
+
4707
+
4708
+
4709
+ #### [TicketSourceEnum](#TicketSourceEnum)
4710
+ Type : string
4711
+
4712
+ | Name | Value | Description |
4713
+ | ---- | ----- | ----------- |
4714
+ | platformPanel | platform_panel | This means it is company level ticket |
4715
+ | salesChannel | sales_channel | This means it is a application/sales channel level ticket |
4716
+
4717
+ ---
4718
+
4719
+
4720
+
4721
+ #### [TicketIntegrationDetails](#TicketIntegrationDetails)
4722
+ Type : string
4723
+
4724
+ | Name | Value | Description |
4725
+ | ---- | ----- | ----------- |
4726
+ | defaultCase | default | This means it is default level ticket integration |
4727
+ | freshdesk | freshdesk | This means it is default level freshdesk integration |
4728
+ | kapture | kapture | This means it is default level kapture integration |
4729
+
4730
+ ---
4731
+
4732
+
4733
+
4734
+
4735
+
4736
+