@gofynd/fdk-client-javascript 1.0.3 → 1.0.4

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