@gofynd/fdk-client-javascript 1.2.0 → 1.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (262) hide show
  1. package/README.md +44 -7
  2. package/package.json +1 -2
  3. package/sdk/application/ApplicationAPIClient.d.ts +3 -3
  4. package/sdk/application/ApplicationAPIClient.js +6 -4
  5. package/sdk/application/ApplicationClient.d.ts +2 -3
  6. package/sdk/application/ApplicationClient.js +1 -45
  7. package/sdk/application/ApplicationConfig.d.ts +46 -6
  8. package/sdk/application/ApplicationConfig.js +15 -16
  9. package/sdk/application/Cart/CartApplicationClient.d.ts +61 -33
  10. package/sdk/application/Cart/CartApplicationClient.js +225 -134
  11. package/sdk/application/Cart/CartApplicationModel.d.ts +4 -4
  12. package/sdk/application/Cart/CartApplicationModel.js +4 -4
  13. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +61 -30
  14. package/sdk/application/Catalog/CatalogApplicationClient.js +234 -146
  15. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +115 -13
  16. package/sdk/application/Catalog/CatalogApplicationModel.js +77 -12
  17. package/sdk/application/Common/CommonApplicationClient.d.ts +5 -3
  18. package/sdk/application/Common/CommonApplicationClient.js +13 -11
  19. package/sdk/application/Common/CommonApplicationModel.d.ts +3 -83
  20. package/sdk/application/Common/CommonApplicationModel.js +2 -58
  21. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +9 -3
  22. package/sdk/application/Communication/CommunicationApplicationClient.js +25 -13
  23. package/sdk/application/Communication/CommunicationApplicationModel.d.ts +1 -34
  24. package/sdk/application/Communication/CommunicationApplicationModel.js +0 -36
  25. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +46 -16
  26. package/sdk/application/Configuration/ConfigurationApplicationClient.js +144 -68
  27. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +1 -219
  28. package/sdk/application/Configuration/ConfigurationApplicationModel.js +0 -226
  29. package/sdk/application/Content/ContentApplicationClient.d.ts +49 -21
  30. package/sdk/application/Content/ContentApplicationClient.js +159 -80
  31. package/sdk/application/Content/ContentApplicationModel.d.ts +5 -622
  32. package/sdk/application/Content/ContentApplicationModel.js +11 -763
  33. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -3
  34. package/sdk/application/FileStorage/FileStorageApplicationClient.js +20 -14
  35. package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +1 -152
  36. package/sdk/application/FileStorage/FileStorageApplicationModel.js +0 -180
  37. package/sdk/application/Lead/LeadApplicationClient.d.ts +14 -7
  38. package/sdk/application/Lead/LeadApplicationClient.js +50 -31
  39. package/sdk/application/Lead/LeadApplicationModel.d.ts +22 -741
  40. package/sdk/application/Lead/LeadApplicationModel.js +21 -481
  41. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +11 -5
  42. package/sdk/application/Logistic/LogisticApplicationClient.js +41 -20
  43. package/sdk/application/Order/OrderApplicationClient.d.ts +24 -12
  44. package/sdk/application/Order/OrderApplicationClient.js +88 -56
  45. package/sdk/application/Payment/PaymentApplicationClient.d.ts +91 -42
  46. package/sdk/application/Payment/PaymentApplicationClient.js +293 -194
  47. package/sdk/application/Payment/PaymentApplicationModel.d.ts +36 -36
  48. package/sdk/application/Payment/PaymentApplicationModel.js +36 -36
  49. package/sdk/application/PosCart/PosCartApplicationClient.d.ts +59 -32
  50. package/sdk/application/PosCart/PosCartApplicationClient.js +214 -130
  51. package/sdk/application/PosCart/PosCartApplicationModel.d.ts +2 -2
  52. package/sdk/application/PosCart/PosCartApplicationModel.js +2 -2
  53. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +16 -7
  54. package/sdk/application/Rewards/RewardsApplicationClient.js +56 -29
  55. package/sdk/application/Share/ShareApplicationClient.d.ts +15 -7
  56. package/sdk/application/Share/ShareApplicationClient.js +51 -31
  57. package/sdk/application/Share/ShareApplicationModel.d.ts +1 -33
  58. package/sdk/application/Share/ShareApplicationModel.js +0 -38
  59. package/sdk/application/Theme/ThemeApplicationClient.d.ts +9 -4
  60. package/sdk/application/Theme/ThemeApplicationClient.js +35 -18
  61. package/sdk/application/Theme/ThemeApplicationModel.d.ts +982 -312
  62. package/sdk/application/Theme/ThemeApplicationModel.js +621 -284
  63. package/sdk/application/User/UserApplicationClient.d.ts +74 -35
  64. package/sdk/application/User/UserApplicationClient.js +252 -161
  65. package/sdk/application/User/UserApplicationModel.d.ts +3 -401
  66. package/sdk/application/User/UserApplicationModel.js +2 -490
  67. package/sdk/common/AxiosHelper.js +1 -2
  68. package/sdk/common/FDKError.d.ts +3 -0
  69. package/sdk/common/FDKError.js +8 -0
  70. package/sdk/common/utils.d.ts +3 -0
  71. package/sdk/common/utils.js +29 -0
  72. package/sdk/partner/PartnerAPIClient.d.ts +5 -4
  73. package/sdk/partner/PartnerAPIClient.js +7 -4
  74. package/sdk/partner/PartnerClient.d.ts +2 -0
  75. package/sdk/partner/PartnerClient.js +3 -0
  76. package/sdk/partner/Theme/ThemePartnerClient.d.ts +299 -0
  77. package/sdk/partner/Theme/ThemePartnerClient.js +768 -0
  78. package/sdk/partner/Theme/ThemePartnerModel.d.ts +1706 -0
  79. package/sdk/partner/Theme/ThemePartnerModel.js +1409 -0
  80. package/sdk/partner/Theme/ThemePartnerValidator.d.ts +22 -0
  81. package/sdk/partner/Theme/ThemePartnerValidator.js +157 -0
  82. package/sdk/partner/index.d.ts +3 -1
  83. package/sdk/partner/index.js +3 -1
  84. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +8 -4
  85. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +38 -16
  86. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +1 -13
  87. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +0 -12
  88. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +10 -0
  89. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +4 -0
  90. package/sdk/platform/Billing/BillingPlatformClient.d.ts +59 -14
  91. package/sdk/platform/Billing/BillingPlatformClient.js +315 -64
  92. package/sdk/platform/Billing/BillingPlatformModel.d.ts +56 -196
  93. package/sdk/platform/Billing/BillingPlatformModel.js +63 -217
  94. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +23 -1
  95. package/sdk/platform/Billing/BillingPlatformValidator.js +31 -0
  96. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +124 -63
  97. package/sdk/platform/Cart/CartPlatformApplicationClient.js +431 -265
  98. package/sdk/platform/Cart/CartPlatformModel.d.ts +253 -53
  99. package/sdk/platform/Cart/CartPlatformModel.js +104 -54
  100. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +120 -53
  101. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +398 -247
  102. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +155 -78
  103. package/sdk/platform/Catalog/CatalogPlatformClient.js +561 -355
  104. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +10 -12
  105. package/sdk/platform/Catalog/CatalogPlatformModel.js +10 -12
  106. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +30 -0
  107. package/sdk/platform/Catalog/CatalogPlatformValidator.js +13 -0
  108. package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -3
  109. package/sdk/platform/Common/CommonPlatformClient.js +13 -11
  110. package/sdk/platform/Common/CommonPlatformModel.d.ts +39 -64
  111. package/sdk/platform/Common/CommonPlatformModel.js +23 -57
  112. package/sdk/platform/Common/CommonPlatformValidator.d.ts +5 -10
  113. package/sdk/platform/Common/CommonPlatformValidator.js +3 -4
  114. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +370 -120
  115. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +2328 -888
  116. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +143 -24
  117. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +179 -15
  118. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +2 -1
  119. package/sdk/platform/Communication/CommunicationPlatformClient.js +6 -5
  120. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +386 -308
  121. package/sdk/platform/Communication/CommunicationPlatformModel.js +415 -355
  122. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +38 -13
  123. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +171 -57
  124. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +53 -1
  125. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +54 -0
  126. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +5 -1
  127. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +7 -0
  128. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +96 -29
  129. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +311 -126
  130. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +5 -1
  131. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +7 -0
  132. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +36 -18
  133. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +121 -86
  134. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +13 -180
  135. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +5 -113
  136. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +162 -70
  137. package/sdk/platform/Content/ContentPlatformApplicationClient.js +528 -309
  138. package/sdk/platform/Content/ContentPlatformModel.d.ts +9 -198
  139. package/sdk/platform/Content/ContentPlatformModel.js +8 -231
  140. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +48 -11
  141. package/sdk/platform/Discount/DiscountPlatformClient.js +142 -48
  142. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +40 -1
  143. package/sdk/platform/Discount/DiscountPlatformModel.js +27 -0
  144. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +84 -18
  145. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +486 -53
  146. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +71 -7
  147. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +81 -5
  148. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +13 -18
  149. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +58 -65
  150. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +198 -71
  151. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +212 -64
  152. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +18 -10
  153. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +11 -6
  154. package/sdk/platform/Finance/FinancePlatformClient.d.ts +177 -40
  155. package/sdk/platform/Finance/FinancePlatformClient.js +1028 -132
  156. package/sdk/platform/Finance/FinancePlatformModel.d.ts +670 -22
  157. package/sdk/platform/Finance/FinancePlatformModel.js +809 -23
  158. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +111 -1
  159. package/sdk/platform/Finance/FinancePlatformValidator.js +134 -0
  160. package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +24 -12
  161. package/sdk/platform/Inventory/InventoryPlatformClient.js +94 -52
  162. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +27 -13
  163. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +101 -55
  164. package/sdk/platform/Lead/LeadPlatformClient.d.ts +50 -39
  165. package/sdk/platform/Lead/LeadPlatformClient.js +171 -112
  166. package/sdk/platform/Lead/LeadPlatformModel.d.ts +32 -390
  167. package/sdk/platform/Lead/LeadPlatformModel.js +31 -214
  168. package/sdk/platform/Lead/LeadPlatformValidator.d.ts +33 -33
  169. package/sdk/platform/Lead/LeadPlatformValidator.js +23 -23
  170. package/sdk/platform/OAuthClient.js +6 -2
  171. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +4 -2
  172. package/sdk/platform/Order/OrderPlatformApplicationClient.js +12 -10
  173. package/sdk/platform/Order/OrderPlatformClient.d.ts +165 -71
  174. package/sdk/platform/Order/OrderPlatformClient.js +738 -205
  175. package/sdk/platform/Order/OrderPlatformModel.d.ts +261 -3
  176. package/sdk/platform/Order/OrderPlatformModel.js +225 -2
  177. package/sdk/platform/Order/OrderPlatformValidator.d.ts +104 -3
  178. package/sdk/platform/Order/OrderPlatformValidator.js +85 -2
  179. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -22
  180. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +12 -159
  181. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +1 -30
  182. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +0 -26
  183. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +1 -690
  184. package/sdk/platform/Partner/PartnerPlatformModel.js +0 -809
  185. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +167 -32
  186. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +793 -145
  187. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +91 -1
  188. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +91 -0
  189. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -10
  190. package/sdk/platform/Payment/PaymentPlatformClient.js +68 -47
  191. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +549 -7
  192. package/sdk/platform/Payment/PaymentPlatformModel.js +305 -6
  193. package/sdk/platform/PlatformAPIClient.d.ts +3 -3
  194. package/sdk/platform/PlatformAPIClient.js +2 -2
  195. package/sdk/platform/PlatformClient.d.ts +2 -2
  196. package/sdk/platform/PlatformClient.js +4 -4
  197. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +28 -12
  198. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +90 -53
  199. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +1 -12
  200. package/sdk/platform/Rewards/RewardsPlatformModel.js +0 -14
  201. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +62 -26
  202. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +210 -93
  203. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +20 -11
  204. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +23 -11
  205. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +36 -18
  206. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +142 -78
  207. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +12 -3
  208. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +14 -2
  209. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +10 -26
  210. package/sdk/platform/Share/SharePlatformApplicationClient.js +36 -67
  211. package/sdk/platform/Share/SharePlatformModel.d.ts +4 -4
  212. package/sdk/platform/Share/SharePlatformModel.js +4 -4
  213. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +127 -57
  214. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +564 -189
  215. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +63 -26
  216. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +62 -22
  217. package/sdk/platform/Theme/ThemePlatformClient.d.ts +37 -0
  218. package/sdk/platform/Theme/ThemePlatformClient.js +235 -0
  219. package/sdk/platform/Theme/ThemePlatformModel.d.ts +1167 -261
  220. package/sdk/platform/Theme/ThemePlatformModel.js +801 -244
  221. package/sdk/platform/Theme/ThemePlatformValidator.d.ts +32 -0
  222. package/sdk/platform/Theme/ThemePlatformValidator.js +38 -0
  223. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +35 -17
  224. package/sdk/platform/User/UserPlatformApplicationClient.js +132 -73
  225. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +7 -0
  226. package/sdk/platform/User/UserPlatformApplicationValidator.js +3 -0
  227. package/sdk/platform/User/UserPlatformModel.d.ts +1 -738
  228. package/sdk/platform/User/UserPlatformModel.js +3 -899
  229. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +120 -7
  230. package/sdk/platform/Webhook/WebhookPlatformClient.js +799 -41
  231. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +476 -86
  232. package/sdk/platform/Webhook/WebhookPlatformModel.js +388 -89
  233. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +96 -9
  234. package/sdk/platform/Webhook/WebhookPlatformValidator.js +117 -5
  235. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +5 -3
  236. package/sdk/public/Configuration/ConfigurationPublicClient.js +13 -11
  237. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +3 -106
  238. package/sdk/public/Configuration/ConfigurationPublicModel.js +2 -59
  239. package/sdk/public/Inventory/InventoryPublicClient.d.ts +12 -6
  240. package/sdk/public/Inventory/InventoryPublicClient.js +42 -27
  241. package/sdk/public/Partner/PartnerPublicClient.d.ts +22 -0
  242. package/sdk/public/Partner/PartnerPublicClient.js +110 -0
  243. package/sdk/public/Partner/PartnerPublicModel.d.ts +240 -0
  244. package/sdk/public/Partner/PartnerPublicModel.js +280 -0
  245. package/sdk/public/Partner/PartnerPublicValidator.d.ts +18 -0
  246. package/sdk/public/Partner/PartnerPublicValidator.js +19 -0
  247. package/sdk/public/PublicAPIClient.d.ts +14 -1
  248. package/sdk/public/PublicAPIClient.js +7 -1
  249. package/sdk/public/PublicClient.d.ts +2 -0
  250. package/sdk/public/PublicClient.js +4 -0
  251. package/sdk/public/Webhook/WebhookPublicClient.d.ts +5 -2
  252. package/sdk/public/Webhook/WebhookPublicClient.js +15 -9
  253. package/sdk/public/Webhook/WebhookPublicModel.d.ts +1 -191
  254. package/sdk/public/Webhook/WebhookPublicModel.js +0 -229
  255. package/sdk/public/index.d.ts +1 -0
  256. package/sdk/public/index.js +2 -0
  257. package/sdk/application/ApplicationModels.d.ts +0 -48
  258. package/sdk/application/ApplicationModels.js +0 -38
  259. package/sdk/platform/Partner/PartnerPlatformClient.d.ts +0 -106
  260. package/sdk/platform/Partner/PartnerPlatformClient.js +0 -878
  261. package/sdk/platform/Partner/PartnerPlatformValidator.d.ts +0 -208
  262. package/sdk/platform/Partner/PartnerPlatformValidator.js +0 -169
@@ -3,86 +3,36 @@ export = LeadApplicationModel;
3
3
  * @typedef AddTicketPayload
4
4
  * @property {Object} [_custom_json] - Optional custom data that needs to be sent
5
5
  * @property {string} category - Category of the ticket
6
- * @property {TicketContent} content - Content for the ticket
6
+ * @property {TicketContent} content
7
7
  * @property {Object} [created_by] - Creator of the ticket
8
- * @property {PriorityEnum} [priority] - Priority of the ticket
8
+ * @property {PriorityEnum} [priority]
9
9
  * @property {string} [status] - Status of the ticket
10
10
  * @property {string[]} [subscribers]
11
11
  */
12
- /**
13
- * @typedef AgentChangePayload
14
- * @property {string} agent_id - Agent's unique ID
15
- */
16
- /**
17
- * @typedef CategoryData
18
- * @property {TicketCategory} [list]
19
- */
20
- /**
21
- * @typedef CloseVideoRoomResponse
22
- * @property {boolean} success - Denotes if operation was successfully
23
- */
24
- /**
25
- * @typedef CommunicationDetails
26
- * @property {string} [description] - Short description for the communication method
27
- * @property {boolean} [enabled] - Denotes if this communication method has to be shown
28
- * @property {string} [title] - Title for the communication method
29
- * @property {string} [type] - Enum type for the communication method
30
- * @property {string} [value] - Value for the communication method
31
- */
32
- /**
33
- * @typedef CreateCustomFormPayload
34
- * @property {string} [description] - Description of the form
35
- * @property {string} [header_image] - Header image that is to be shown for the form
36
- * @property {Object[]} inputs - List of all the form components
37
- * @property {PollForAssignment} [poll_for_assignment] - Describes how polling
38
- * will be done for the tickets createds
39
- * @property {PriorityEnum} priority - Describes the priority of the tickets
40
- * created by the form
41
- * @property {boolean} [should_notify] - Indicates if staff should be notified
42
- * when a response is received
43
- * @property {string} slug - Slug for the form
44
- * @property {string} [success_message] - Success message that will be shown on submission
45
- * @property {string} title - Title for the form
46
- */
47
12
  /**
48
13
  * @typedef CreatedOn
49
14
  * @property {string} user_agent - Useragent details
50
15
  */
51
- /**
52
- * @typedef CreateVideoRoomPayload
53
- * @property {NotifyUser[]} [notify] - List of people to be notified
54
- * @property {string} unique_name - Ticket id
55
- */
56
- /**
57
- * @typedef CreateVideoRoomResponse
58
- * @property {string} unique_name - Video Room's unique name
59
- */
60
16
  /**
61
17
  * @typedef CustomForm
62
18
  * @property {string} _id - Unique identifier for the form
63
19
  * @property {string} application_id - Application ID for form
64
- * @property {CreatedOn} [created_on] - Gives details of when the form was created
20
+ * @property {CreatedOn} [created_on]
65
21
  * @property {string} [description] - Form description that will be shown to the user
66
22
  * @property {string} [header_image] - Form header image that will be shown to the user
67
23
  * @property {Object[]} inputs - List of all the form fields
68
24
  * @property {boolean} login_required - Denotes if login is required to make a
69
25
  * form response submission
70
- * @property {PollForAssignment} [poll_for_assignment] - Details of how polling
71
- * should be done for support
72
- * @property {Priority} priority - Sets priority of tickets created by form response
26
+ * @property {PollForAssignment} [poll_for_assignment]
27
+ * @property {Priority} priority
73
28
  * @property {boolean} should_notify - Denotes if new response submission for
74
29
  * the form should be notified to the assignees
75
30
  * @property {string} slug - Slug for the form, which is to be used for accessing the form
76
- * @property {SubmitButton} [submit_button] - Details for submit button
31
+ * @property {SubmitButton} [submit_button]
77
32
  * @property {string} [success_message] - Message that is to be shown on
78
33
  * succesfull form response submission
79
34
  * @property {string} title - Form title that will be shown to the user
80
35
  */
81
- /**
82
- * @typedef CustomFormList
83
- * @property {CustomForm[]} [items] - List of forms
84
- * @property {Page} [page] - Describes the pagination state
85
- */
86
36
  /**
87
37
  * @typedef CustomFormSubmissionPayload
88
38
  * @property {TicketAsset[]} [attachments] - List of all attachments related to the form
@@ -93,35 +43,6 @@ export = LeadApplicationModel;
93
43
  * @property {string} [platform] - Platform of user
94
44
  * @property {string} [source] - Source of user
95
45
  */
96
- /**
97
- * @typedef EditCustomFormPayload
98
- * @property {string} [description] - Description of the form
99
- * @property {string} [header_image] - Header image that is to be shown for the form
100
- * @property {Object[]} inputs - List of all the form components
101
- * @property {boolean} [login_required] - Denotes if login is required to make a
102
- * form response submission
103
- * @property {PollForAssignment} [poll_for_assignment] - Describes how polling
104
- * will be done for the tickets createds
105
- * @property {PriorityEnum} priority - Describes the priority of the tickets
106
- * created by the form
107
- * @property {boolean} [should_notify] - Indicates if staff should be notified
108
- * when a response is received
109
- * @property {string} [success_message] - Success message that will be shown on submission
110
- * @property {string} title - Title for the form
111
- */
112
- /**
113
- * @typedef EditTicketPayload
114
- * @property {AgentChangePayload} [assigned_to] - Details of support staff to
115
- * whom ticket is assigned
116
- * @property {string} [category] - Category assigned to the ticket
117
- * @property {TicketContent} [content] - Ticket conetent details
118
- * @property {PriorityEnum} [priority] - Denotes the priority of ticket
119
- * @property {string} [source] - Denotes if the ticket was created at company or
120
- * application level
121
- * @property {string} [status] - Denotes in what state is the ticket
122
- * @property {string} [sub_category] - Sub-category assigned to the ticket
123
- * @property {string[]} [tags] - Tags relevant to ticket
124
- */
125
46
  /**
126
47
  * @typedef Email
127
48
  * @property {boolean} [active] - Denotes if the email is active
@@ -135,19 +56,6 @@ export = LeadApplicationModel;
135
56
  * @property {Object} [timestamps] - Gives details of category releted data
136
57
  * @property {string} [title] - Title for the feed back form
137
58
  */
138
- /**
139
- * @typedef FeedbackResponseItem
140
- * @property {string} display - Question/Title of the form field
141
- * @property {string} key - Key of the form field
142
- * @property {string} value - User response value for the form field
143
- */
144
- /**
145
- * @typedef Filter
146
- * @property {Object[]} assignees - List of support staff availble for tickets assignment
147
- * @property {TicketCategory[]} [categories] - List of possible categories for tickets
148
- * @property {Priority[]} priorities - List of possible priorities for tickets
149
- * @property {Status[]} statuses - List of possible statuses for tickets
150
- */
151
59
  /**
152
60
  * @typedef GetParticipantsInsideVideoRoomResponse
153
61
  * @property {Participant[]} participants - List of participants of the video room
@@ -156,45 +64,11 @@ export = LeadApplicationModel;
156
64
  * @typedef GetTokenForVideoRoomResponse
157
65
  * @property {string} access_token - Access token to be used for video room
158
66
  */
159
- /**
160
- * @typedef IntegrationConfig
161
- * @property {string} [_id] - Unique id
162
- * @property {boolean} allow_ticket_creation - Denotes ticket creation enable or
163
- * disable on platform
164
- * @property {string} [base_url] - Integration base url for validate and create ticket
165
- * @property {CategoryData} [category_data] - Support category array list details
166
- * @property {string} [category_sync_apikey] - Integration apikey to sync
167
- * category of selected type
168
- * @property {boolean} [config_completed] - Denotes the current intergration is
169
- * completed or partially done
170
- * @property {string} [create_ticket_apikey] - Integration apikey to validate
171
- * and create ticket
172
- * @property {string} integration_type - Enum string values for integration
173
- * @property {boolean} show_listing - Denotes ticket listing enable or disable on platform
174
- * @property {string} [update_ticket_apikey] - Integration apikey to update ticket
175
- * @property {string} [webhook_apikey] - Integration webhook apikey to got
176
- * callbacks from integration type dashboard like freshdesk, etc
177
- */
178
- /**
179
- * @typedef NotifyUser
180
- * @property {string} country_code - Country code
181
- * @property {string} phone_number - Phone number
182
- */
183
- /**
184
- * @typedef Page
185
- * @property {number} [current]
186
- * @property {boolean} [has_next]
187
- * @property {boolean} [has_previous]
188
- * @property {number} [item_total]
189
- * @property {string} [next_id]
190
- * @property {number} [size]
191
- * @property {string} type
192
- */
193
67
  /**
194
68
  * @typedef Participant
195
69
  * @property {string} [identity] - Unique identifier of participant
196
70
  * @property {string} [status] - Status of participant
197
- * @property {UserSchema} [user] - Details of participant
71
+ * @property {UserSchema} [user]
198
72
  */
199
73
  /**
200
74
  * @typedef PhoneNumber
@@ -215,7 +89,7 @@ export = LeadApplicationModel;
215
89
  * @typedef Priority
216
90
  * @property {string} color - Color for priority
217
91
  * @property {string} display - Display text for priority
218
- * @property {PriorityEnum} key - Key for priority
92
+ * @property {PriorityEnum} key
219
93
  */
220
94
  /**
221
95
  * @typedef Status
@@ -232,44 +106,27 @@ export = LeadApplicationModel;
232
106
  /**
233
107
  * @typedef SubmitCustomFormResponse
234
108
  * @property {string} message - Success message for form submission
235
- * @property {Ticket} [ticket] - Ticket created on form submission
236
- */
237
- /**
238
- * @typedef SupportGeneralConfig
239
- * @property {string} [_id] - Unique id
240
- * @property {Object} [integration] - Contains integrations basic information
241
- * @property {boolean} [show_communication_info] - Denotes if support
242
- * communication info should be shown
243
- * @property {boolean} [show_support_dris] - Denotes if support DRIS info should be shown
244
- * @property {CommunicationDetails} [support_communication] - Support
245
- * communication array list details
246
- * @property {CommunicationDetails} [support_email] - Support e-mail details
247
- * @property {CommunicationDetails} [support_faq] - Support FAQ details
248
- * @property {CommunicationDetails} [support_phone] - Support Phone number details
249
- * @property {string} [type] - The enity/platform for which the config is stored
109
+ * @property {Ticket} [ticket]
250
110
  */
251
111
  /**
252
112
  * @typedef Ticket
253
113
  * @property {Object} [_custom_json] - Custom json relevant to the ticket
254
114
  * @property {string} _id - Unique identifier for the ticket
255
115
  * @property {Object} [assigned_to] - Details of support staff to whom ticket is assigned
256
- * @property {TicketCategory} category - Category assigned to the ticket
257
- * @property {TicketContent} [content] - Ticket conetent details
258
- * @property {TicketContext} [context] - Details of company and application
259
- * realated to the ticket
116
+ * @property {TicketCategory} category
117
+ * @property {TicketContent} [content]
118
+ * @property {TicketContext} [context]
260
119
  * @property {string} [created_at] - Time when the ticket was created
261
120
  * @property {Object} [created_by] - User details of ticket creator
262
- * @property {CreatedOn} [created_on] - Details of company and application
263
- * realated to the ticket
121
+ * @property {CreatedOn} [created_on]
264
122
  * @property {Object} [integration] - Integration type and its details of the ticket
265
123
  * @property {boolean} [is_feedback_pending] - Denotes if feedback submission is
266
124
  * pending for the ticket
267
- * @property {Priority} priority - Denotes the priority of ticket
125
+ * @property {Priority} priority
268
126
  * @property {string} [response_id] - Details of company and application
269
127
  * realated to the ticket
270
- * @property {TicketSourceEnum} source - Denotes if the ticket was created at
271
- * company or application level
272
- * @property {Status} status - Denotes in what state is the ticket
128
+ * @property {TicketSourceEnum} source
129
+ * @property {Status} status
273
130
  * @property {string} [sub_category] - Sub-category assigned to the ticket
274
131
  * @property {string[]} [tags] - Tags relevant to ticket
275
132
  * @property {string} [updated_at] - Time when the ticket was last updated
@@ -277,16 +134,16 @@ export = LeadApplicationModel;
277
134
  /**
278
135
  * @typedef TicketAsset
279
136
  * @property {string} [display] - Display text for asset
280
- * @property {TicketAssetTypeEnum} type - Type of asset
137
+ * @property {TicketAssetTypeEnum} type
281
138
  * @property {string} value - To be used for details
282
139
  */
283
140
  /**
284
141
  * @typedef TicketCategory
285
142
  * @property {string} display - Category display value identifier
286
- * @property {FeedbackForm} [feedback_form] - Support category array list details
143
+ * @property {FeedbackForm} [feedback_form]
287
144
  * @property {number} [group_id] - Group id of category releted data
288
145
  * @property {string} key - Category key value identifier
289
- * @property {TicketCategory} [sub_categories] - Support category array list details
146
+ * @property {TicketCategory} [sub_categories]
290
147
  */
291
148
  /**
292
149
  * @typedef TicketContent
@@ -299,64 +156,22 @@ export = LeadApplicationModel;
299
156
  * @property {string} [application_id] - Application ID related to the ticket
300
157
  * @property {string} company_id - Company ID related to the ticket
301
158
  */
302
- /**
303
- * @typedef TicketFeedback
304
- * @property {string} _id - Unique identifier for the feedback
305
- * @property {string} [category] - Category of the ticket
306
- * @property {string} company_id - Company id for which ticket was raised
307
- * @property {string} [created_at] - Time when the feedback was created
308
- * @property {FeedbackResponseItem[]} response
309
- * @property {string} ticket_id - Readable ticket number
310
- * @property {string} [updated_at] - Time when the feedback was last updated
311
- * @property {Object} [user] - User who submitted the feedback
312
- */
313
- /**
314
- * @typedef TicketFeedbackForm
315
- * @property {Object[]} [display] - List of all the form fields
316
- * @property {string} title - Feedback form title that will be shown to the user
317
- */
318
- /**
319
- * @typedef TicketFeedbackList
320
- * @property {TicketFeedback[]} [items] - List of all ticket feedback for the ticket
321
- */
322
- /**
323
- * @typedef TicketFeedbackPayload
324
- * @property {Object} [form_response] - Key-value pairs of all the form fields
325
- * and their response
326
- */
327
159
  /**
328
160
  * @typedef TicketHistory
329
161
  * @property {string} _id - Unique identifier of the history event
330
162
  * @property {string} [created_at] - Time of creation of the history event
331
163
  * @property {Object} [created_by] - User who created the history event
332
- * @property {CreatedOn} [created_on] - Time of creation of the history event
164
+ * @property {CreatedOn} [created_on]
333
165
  * @property {string} ticket_id - Readable ticket number
334
166
  * @property {string} type - Type of the history event
335
167
  * @property {string} [updated_at] - Time of last update of the history event
336
168
  * @property {Object} value - Data of the history event
337
169
  */
338
- /**
339
- * @typedef TicketHistoryList
340
- * @property {TicketHistory[]} [items] - List of ticket history
341
- * @property {Page} [page] - Describes the pagination state
342
- */
343
170
  /**
344
171
  * @typedef TicketHistoryPayload
345
- * @property {HistoryTypeEnum} type - Type of history event
172
+ * @property {HistoryTypeEnum} type
346
173
  * @property {Object} value - Details of history event
347
174
  */
348
- /**
349
- * @typedef TicketList
350
- * @property {Filter} [filters] - All the filters available for tickets
351
- * @property {Ticket[]} [items] - List of tickets
352
- * @property {Page} [page] - Describes the pagination state
353
- */
354
- /**
355
- * @typedef TicketSubCategory
356
- * @property {string} display - Display text for sub-category
357
- * @property {string} key - Key for sub-category
358
- * @property {TicketSubCategory} [sub_categories]
359
- */
360
175
  /**
361
176
  * @typedef UserSchema
362
177
  * @property {string} [_id]
@@ -389,12 +204,11 @@ export = LeadApplicationModel;
389
204
  * | "shipment"
390
205
  * | "order"} TicketAssetTypeEnum
391
206
  */
392
- /** @typedef {"default" | "freshdesk" | "kapture"} TicketIntegrationDetails */
393
207
  /** @typedef {"platform_panel" | "sales_channel"} TicketSourceEnum */
394
208
  declare class LeadApplicationModel {
395
209
  }
396
210
  declare namespace LeadApplicationModel {
397
- export { AddTicketPayload, AgentChangePayload, CategoryData, CloseVideoRoomResponse, CommunicationDetails, CreateCustomFormPayload, CreatedOn, CreateVideoRoomPayload, CreateVideoRoomResponse, CustomForm, CustomFormList, CustomFormSubmissionPayload, Debug, EditCustomFormPayload, EditTicketPayload, Email, FeedbackForm, FeedbackResponseItem, Filter, GetParticipantsInsideVideoRoomResponse, GetTokenForVideoRoomResponse, IntegrationConfig, NotifyUser, Page, Participant, PhoneNumber, PollForAssignment, Priority, Status, SubmitButton, SubmitCustomFormResponse, SupportGeneralConfig, Ticket, TicketAsset, TicketCategory, TicketContent, TicketContext, TicketFeedback, TicketFeedbackForm, TicketFeedbackList, TicketFeedbackPayload, TicketHistory, TicketHistoryList, TicketHistoryPayload, TicketList, TicketSubCategory, UserSchema, HistoryTypeEnum, PriorityEnum, TicketAssetTypeEnum, TicketIntegrationDetails, TicketSourceEnum };
211
+ export { AddTicketPayload, CreatedOn, CustomForm, CustomFormSubmissionPayload, Debug, Email, FeedbackForm, GetParticipantsInsideVideoRoomResponse, GetTokenForVideoRoomResponse, Participant, PhoneNumber, PollForAssignment, Priority, Status, SubmitButton, SubmitCustomFormResponse, Ticket, TicketAsset, TicketCategory, TicketContent, TicketContext, TicketHistory, TicketHistoryPayload, UserSchema, HistoryTypeEnum, PriorityEnum, TicketAssetTypeEnum, TicketSourceEnum };
398
212
  }
399
213
  /** @returns {AddTicketPayload} */
400
214
  declare function AddTicketPayload(): AddTicketPayload;
@@ -407,17 +221,11 @@ type AddTicketPayload = {
407
221
  * - Category of the ticket
408
222
  */
409
223
  category: string;
410
- /**
411
- * - Content for the ticket
412
- */
413
224
  content: TicketContent;
414
225
  /**
415
226
  * - Creator of the ticket
416
227
  */
417
228
  created_by?: any;
418
- /**
419
- * - Priority of the ticket
420
- */
421
229
  priority?: PriorityEnum;
422
230
  /**
423
231
  * - Status of the ticket
@@ -425,94 +233,6 @@ type AddTicketPayload = {
425
233
  status?: string;
426
234
  subscribers?: string[];
427
235
  };
428
- /** @returns {AgentChangePayload} */
429
- declare function AgentChangePayload(): AgentChangePayload;
430
- type AgentChangePayload = {
431
- /**
432
- * - Agent's unique ID
433
- */
434
- agent_id: string;
435
- };
436
- /** @returns {CategoryData} */
437
- declare function CategoryData(): CategoryData;
438
- type CategoryData = {
439
- list?: TicketCategory;
440
- };
441
- /** @returns {CloseVideoRoomResponse} */
442
- declare function CloseVideoRoomResponse(): CloseVideoRoomResponse;
443
- type CloseVideoRoomResponse = {
444
- /**
445
- * - Denotes if operation was successfully
446
- */
447
- success: boolean;
448
- };
449
- /** @returns {CommunicationDetails} */
450
- declare function CommunicationDetails(): CommunicationDetails;
451
- type CommunicationDetails = {
452
- /**
453
- * - Short description for the communication method
454
- */
455
- description?: string;
456
- /**
457
- * - Denotes if this communication method has to be shown
458
- */
459
- enabled?: boolean;
460
- /**
461
- * - Title for the communication method
462
- */
463
- title?: string;
464
- /**
465
- * - Enum type for the communication method
466
- */
467
- type?: string;
468
- /**
469
- * - Value for the communication method
470
- */
471
- value?: string;
472
- };
473
- /** @returns {CreateCustomFormPayload} */
474
- declare function CreateCustomFormPayload(): CreateCustomFormPayload;
475
- type CreateCustomFormPayload = {
476
- /**
477
- * - Description of the form
478
- */
479
- description?: string;
480
- /**
481
- * - Header image that is to be shown for the form
482
- */
483
- header_image?: string;
484
- /**
485
- * - List of all the form components
486
- */
487
- inputs: any[];
488
- /**
489
- * - Describes how polling
490
- * will be done for the tickets createds
491
- */
492
- poll_for_assignment?: PollForAssignment;
493
- /**
494
- * - Describes the priority of the tickets
495
- * created by the form
496
- */
497
- priority: PriorityEnum;
498
- /**
499
- * - Indicates if staff should be notified
500
- * when a response is received
501
- */
502
- should_notify?: boolean;
503
- /**
504
- * - Slug for the form
505
- */
506
- slug: string;
507
- /**
508
- * - Success message that will be shown on submission
509
- */
510
- success_message?: string;
511
- /**
512
- * - Title for the form
513
- */
514
- title: string;
515
- };
516
236
  /** @returns {CreatedOn} */
517
237
  declare function CreatedOn(): CreatedOn;
518
238
  type CreatedOn = {
@@ -521,26 +241,6 @@ type CreatedOn = {
521
241
  */
522
242
  user_agent: string;
523
243
  };
524
- /** @returns {CreateVideoRoomPayload} */
525
- declare function CreateVideoRoomPayload(): CreateVideoRoomPayload;
526
- type CreateVideoRoomPayload = {
527
- /**
528
- * - List of people to be notified
529
- */
530
- notify?: NotifyUser[];
531
- /**
532
- * - Ticket id
533
- */
534
- unique_name: string;
535
- };
536
- /** @returns {CreateVideoRoomResponse} */
537
- declare function CreateVideoRoomResponse(): CreateVideoRoomResponse;
538
- type CreateVideoRoomResponse = {
539
- /**
540
- * - Video Room's unique name
541
- */
542
- unique_name: string;
543
- };
544
244
  /** @returns {CustomForm} */
545
245
  declare function CustomForm(): CustomForm;
546
246
  type CustomForm = {
@@ -552,9 +252,6 @@ type CustomForm = {
552
252
  * - Application ID for form
553
253
  */
554
254
  application_id: string;
555
- /**
556
- * - Gives details of when the form was created
557
- */
558
255
  created_on?: CreatedOn;
559
256
  /**
560
257
  * - Form description that will be shown to the user
@@ -573,14 +270,7 @@ type CustomForm = {
573
270
  * form response submission
574
271
  */
575
272
  login_required: boolean;
576
- /**
577
- * - Details of how polling
578
- * should be done for support
579
- */
580
273
  poll_for_assignment?: PollForAssignment;
581
- /**
582
- * - Sets priority of tickets created by form response
583
- */
584
274
  priority: Priority;
585
275
  /**
586
276
  * - Denotes if new response submission for
@@ -591,9 +281,6 @@ type CustomForm = {
591
281
  * - Slug for the form, which is to be used for accessing the form
592
282
  */
593
283
  slug: string;
594
- /**
595
- * - Details for submit button
596
- */
597
284
  submit_button?: SubmitButton;
598
285
  /**
599
286
  * - Message that is to be shown on
@@ -605,18 +292,6 @@ type CustomForm = {
605
292
  */
606
293
  title: string;
607
294
  };
608
- /** @returns {CustomFormList} */
609
- declare function CustomFormList(): CustomFormList;
610
- type CustomFormList = {
611
- /**
612
- * - List of forms
613
- */
614
- items?: CustomForm[];
615
- /**
616
- * - Describes the pagination state
617
- */
618
- page?: Page;
619
- };
620
295
  /** @returns {CustomFormSubmissionPayload} */
621
296
  declare function CustomFormSubmissionPayload(): CustomFormSubmissionPayload;
622
297
  type CustomFormSubmissionPayload = {
@@ -641,88 +316,6 @@ type Debug = {
641
316
  */
642
317
  source?: string;
643
318
  };
644
- /** @returns {EditCustomFormPayload} */
645
- declare function EditCustomFormPayload(): EditCustomFormPayload;
646
- type EditCustomFormPayload = {
647
- /**
648
- * - Description of the form
649
- */
650
- description?: string;
651
- /**
652
- * - Header image that is to be shown for the form
653
- */
654
- header_image?: string;
655
- /**
656
- * - List of all the form components
657
- */
658
- inputs: any[];
659
- /**
660
- * - Denotes if login is required to make a
661
- * form response submission
662
- */
663
- login_required?: boolean;
664
- /**
665
- * - Describes how polling
666
- * will be done for the tickets createds
667
- */
668
- poll_for_assignment?: PollForAssignment;
669
- /**
670
- * - Describes the priority of the tickets
671
- * created by the form
672
- */
673
- priority: PriorityEnum;
674
- /**
675
- * - Indicates if staff should be notified
676
- * when a response is received
677
- */
678
- should_notify?: boolean;
679
- /**
680
- * - Success message that will be shown on submission
681
- */
682
- success_message?: string;
683
- /**
684
- * - Title for the form
685
- */
686
- title: string;
687
- };
688
- /** @returns {EditTicketPayload} */
689
- declare function EditTicketPayload(): EditTicketPayload;
690
- type EditTicketPayload = {
691
- /**
692
- * - Details of support staff to
693
- * whom ticket is assigned
694
- */
695
- assigned_to?: AgentChangePayload;
696
- /**
697
- * - Category assigned to the ticket
698
- */
699
- category?: string;
700
- /**
701
- * - Ticket conetent details
702
- */
703
- content?: TicketContent;
704
- /**
705
- * - Denotes the priority of ticket
706
- */
707
- priority?: PriorityEnum;
708
- /**
709
- * - Denotes if the ticket was created at company or
710
- * application level
711
- */
712
- source?: string;
713
- /**
714
- * - Denotes in what state is the ticket
715
- */
716
- status?: string;
717
- /**
718
- * - Sub-category assigned to the ticket
719
- */
720
- sub_category?: string;
721
- /**
722
- * - Tags relevant to ticket
723
- */
724
- tags?: string[];
725
- };
726
319
  /** @returns {Email} */
727
320
  declare function Email(): Email;
728
321
  type Email = {
@@ -759,42 +352,6 @@ type FeedbackForm = {
759
352
  */
760
353
  title?: string;
761
354
  };
762
- /** @returns {FeedbackResponseItem} */
763
- declare function FeedbackResponseItem(): FeedbackResponseItem;
764
- type FeedbackResponseItem = {
765
- /**
766
- * - Question/Title of the form field
767
- */
768
- display: string;
769
- /**
770
- * - Key of the form field
771
- */
772
- key: string;
773
- /**
774
- * - User response value for the form field
775
- */
776
- value: string;
777
- };
778
- /** @returns {Filter} */
779
- declare function Filter(): Filter;
780
- type Filter = {
781
- /**
782
- * - List of support staff availble for tickets assignment
783
- */
784
- assignees: any[];
785
- /**
786
- * - List of possible categories for tickets
787
- */
788
- categories?: TicketCategory[];
789
- /**
790
- * - List of possible priorities for tickets
791
- */
792
- priorities: Priority[];
793
- /**
794
- * - List of possible statuses for tickets
795
- */
796
- statuses: Status[];
797
- };
798
355
  /** @returns {GetParticipantsInsideVideoRoomResponse} */
799
356
  declare function GetParticipantsInsideVideoRoomResponse(): GetParticipantsInsideVideoRoomResponse;
800
357
  type GetParticipantsInsideVideoRoomResponse = {
@@ -811,82 +368,6 @@ type GetTokenForVideoRoomResponse = {
811
368
  */
812
369
  access_token: string;
813
370
  };
814
- /** @returns {IntegrationConfig} */
815
- declare function IntegrationConfig(): IntegrationConfig;
816
- type IntegrationConfig = {
817
- /**
818
- * - Unique id
819
- */
820
- _id?: string;
821
- /**
822
- * - Denotes ticket creation enable or
823
- * disable on platform
824
- */
825
- allow_ticket_creation: boolean;
826
- /**
827
- * - Integration base url for validate and create ticket
828
- */
829
- base_url?: string;
830
- /**
831
- * - Support category array list details
832
- */
833
- category_data?: CategoryData;
834
- /**
835
- * - Integration apikey to sync
836
- * category of selected type
837
- */
838
- category_sync_apikey?: string;
839
- /**
840
- * - Denotes the current intergration is
841
- * completed or partially done
842
- */
843
- config_completed?: boolean;
844
- /**
845
- * - Integration apikey to validate
846
- * and create ticket
847
- */
848
- create_ticket_apikey?: string;
849
- /**
850
- * - Enum string values for integration
851
- */
852
- integration_type: string;
853
- /**
854
- * - Denotes ticket listing enable or disable on platform
855
- */
856
- show_listing: boolean;
857
- /**
858
- * - Integration apikey to update ticket
859
- */
860
- update_ticket_apikey?: string;
861
- /**
862
- * - Integration webhook apikey to got
863
- * callbacks from integration type dashboard like freshdesk, etc
864
- */
865
- webhook_apikey?: string;
866
- };
867
- /** @returns {NotifyUser} */
868
- declare function NotifyUser(): NotifyUser;
869
- type NotifyUser = {
870
- /**
871
- * - Country code
872
- */
873
- country_code: string;
874
- /**
875
- * - Phone number
876
- */
877
- phone_number: string;
878
- };
879
- /** @returns {Page} */
880
- declare function Page(): Page;
881
- type Page = {
882
- current?: number;
883
- has_next?: boolean;
884
- has_previous?: boolean;
885
- item_total?: number;
886
- next_id?: string;
887
- size?: number;
888
- type: string;
889
- };
890
371
  /** @returns {Participant} */
891
372
  declare function Participant(): Participant;
892
373
  type Participant = {
@@ -898,9 +379,6 @@ type Participant = {
898
379
  * - Status of participant
899
380
  */
900
381
  status?: string;
901
- /**
902
- * - Details of participant
903
- */
904
382
  user?: UserSchema;
905
383
  };
906
384
  /** @returns {PhoneNumber} */
@@ -958,9 +436,6 @@ type Priority = {
958
436
  * - Display text for priority
959
437
  */
960
438
  display: string;
961
- /**
962
- * - Key for priority
963
- */
964
439
  key: PriorityEnum;
965
440
  };
966
441
  /** @returns {Status} */
@@ -1002,53 +477,8 @@ type SubmitCustomFormResponse = {
1002
477
  * - Success message for form submission
1003
478
  */
1004
479
  message: string;
1005
- /**
1006
- * - Ticket created on form submission
1007
- */
1008
480
  ticket?: Ticket;
1009
481
  };
1010
- /** @returns {SupportGeneralConfig} */
1011
- declare function SupportGeneralConfig(): SupportGeneralConfig;
1012
- type SupportGeneralConfig = {
1013
- /**
1014
- * - Unique id
1015
- */
1016
- _id?: string;
1017
- /**
1018
- * - Contains integrations basic information
1019
- */
1020
- integration?: any;
1021
- /**
1022
- * - Denotes if support
1023
- * communication info should be shown
1024
- */
1025
- show_communication_info?: boolean;
1026
- /**
1027
- * - Denotes if support DRIS info should be shown
1028
- */
1029
- show_support_dris?: boolean;
1030
- /**
1031
- * - Support
1032
- * communication array list details
1033
- */
1034
- support_communication?: CommunicationDetails;
1035
- /**
1036
- * - Support e-mail details
1037
- */
1038
- support_email?: CommunicationDetails;
1039
- /**
1040
- * - Support FAQ details
1041
- */
1042
- support_faq?: CommunicationDetails;
1043
- /**
1044
- * - Support Phone number details
1045
- */
1046
- support_phone?: CommunicationDetails;
1047
- /**
1048
- * - The enity/platform for which the config is stored
1049
- */
1050
- type?: string;
1051
- };
1052
482
  /** @returns {Ticket} */
1053
483
  declare function Ticket(): Ticket;
1054
484
  type Ticket = {
@@ -1064,18 +494,8 @@ type Ticket = {
1064
494
  * - Details of support staff to whom ticket is assigned
1065
495
  */
1066
496
  assigned_to?: any;
1067
- /**
1068
- * - Category assigned to the ticket
1069
- */
1070
497
  category: TicketCategory;
1071
- /**
1072
- * - Ticket conetent details
1073
- */
1074
498
  content?: TicketContent;
1075
- /**
1076
- * - Details of company and application
1077
- * realated to the ticket
1078
- */
1079
499
  context?: TicketContext;
1080
500
  /**
1081
501
  * - Time when the ticket was created
@@ -1085,10 +505,6 @@ type Ticket = {
1085
505
  * - User details of ticket creator
1086
506
  */
1087
507
  created_by?: any;
1088
- /**
1089
- * - Details of company and application
1090
- * realated to the ticket
1091
- */
1092
508
  created_on?: CreatedOn;
1093
509
  /**
1094
510
  * - Integration type and its details of the ticket
@@ -1099,23 +515,13 @@ type Ticket = {
1099
515
  * pending for the ticket
1100
516
  */
1101
517
  is_feedback_pending?: boolean;
1102
- /**
1103
- * - Denotes the priority of ticket
1104
- */
1105
518
  priority: Priority;
1106
519
  /**
1107
520
  * - Details of company and application
1108
521
  * realated to the ticket
1109
522
  */
1110
523
  response_id?: string;
1111
- /**
1112
- * - Denotes if the ticket was created at
1113
- * company or application level
1114
- */
1115
524
  source: TicketSourceEnum;
1116
- /**
1117
- * - Denotes in what state is the ticket
1118
- */
1119
525
  status: Status;
1120
526
  /**
1121
527
  * - Sub-category assigned to the ticket
@@ -1137,9 +543,6 @@ type TicketAsset = {
1137
543
  * - Display text for asset
1138
544
  */
1139
545
  display?: string;
1140
- /**
1141
- * - Type of asset
1142
- */
1143
546
  type: TicketAssetTypeEnum;
1144
547
  /**
1145
548
  * - To be used for details
@@ -1153,9 +556,6 @@ type TicketCategory = {
1153
556
  * - Category display value identifier
1154
557
  */
1155
558
  display: string;
1156
- /**
1157
- * - Support category array list details
1158
- */
1159
559
  feedback_form?: FeedbackForm;
1160
560
  /**
1161
561
  * - Group id of category releted data
@@ -1165,9 +565,6 @@ type TicketCategory = {
1165
565
  * - Category key value identifier
1166
566
  */
1167
567
  key: string;
1168
- /**
1169
- * - Support category array list details
1170
- */
1171
568
  sub_categories?: TicketCategory;
1172
569
  };
1173
570
  /** @returns {TicketContent} */
@@ -1198,68 +595,6 @@ type TicketContext = {
1198
595
  */
1199
596
  company_id: string;
1200
597
  };
1201
- /** @returns {TicketFeedback} */
1202
- declare function TicketFeedback(): TicketFeedback;
1203
- type TicketFeedback = {
1204
- /**
1205
- * - Unique identifier for the feedback
1206
- */
1207
- _id: string;
1208
- /**
1209
- * - Category of the ticket
1210
- */
1211
- category?: string;
1212
- /**
1213
- * - Company id for which ticket was raised
1214
- */
1215
- company_id: string;
1216
- /**
1217
- * - Time when the feedback was created
1218
- */
1219
- created_at?: string;
1220
- response: FeedbackResponseItem[];
1221
- /**
1222
- * - Readable ticket number
1223
- */
1224
- ticket_id: string;
1225
- /**
1226
- * - Time when the feedback was last updated
1227
- */
1228
- updated_at?: string;
1229
- /**
1230
- * - User who submitted the feedback
1231
- */
1232
- user?: any;
1233
- };
1234
- /** @returns {TicketFeedbackForm} */
1235
- declare function TicketFeedbackForm(): TicketFeedbackForm;
1236
- type TicketFeedbackForm = {
1237
- /**
1238
- * - List of all the form fields
1239
- */
1240
- display?: any[];
1241
- /**
1242
- * - Feedback form title that will be shown to the user
1243
- */
1244
- title: string;
1245
- };
1246
- /** @returns {TicketFeedbackList} */
1247
- declare function TicketFeedbackList(): TicketFeedbackList;
1248
- type TicketFeedbackList = {
1249
- /**
1250
- * - List of all ticket feedback for the ticket
1251
- */
1252
- items?: TicketFeedback[];
1253
- };
1254
- /** @returns {TicketFeedbackPayload} */
1255
- declare function TicketFeedbackPayload(): TicketFeedbackPayload;
1256
- type TicketFeedbackPayload = {
1257
- /**
1258
- * - Key-value pairs of all the form fields
1259
- * and their response
1260
- */
1261
- form_response?: any;
1262
- };
1263
598
  /** @returns {TicketHistory} */
1264
599
  declare function TicketHistory(): TicketHistory;
1265
600
  type TicketHistory = {
@@ -1275,9 +610,6 @@ type TicketHistory = {
1275
610
  * - User who created the history event
1276
611
  */
1277
612
  created_by?: any;
1278
- /**
1279
- * - Time of creation of the history event
1280
- */
1281
613
  created_on?: CreatedOn;
1282
614
  /**
1283
615
  * - Readable ticket number
@@ -1296,59 +628,15 @@ type TicketHistory = {
1296
628
  */
1297
629
  value: any;
1298
630
  };
1299
- /** @returns {TicketHistoryList} */
1300
- declare function TicketHistoryList(): TicketHistoryList;
1301
- type TicketHistoryList = {
1302
- /**
1303
- * - List of ticket history
1304
- */
1305
- items?: TicketHistory[];
1306
- /**
1307
- * - Describes the pagination state
1308
- */
1309
- page?: Page;
1310
- };
1311
631
  /** @returns {TicketHistoryPayload} */
1312
632
  declare function TicketHistoryPayload(): TicketHistoryPayload;
1313
633
  type TicketHistoryPayload = {
1314
- /**
1315
- * - Type of history event
1316
- */
1317
634
  type: HistoryTypeEnum;
1318
635
  /**
1319
636
  * - Details of history event
1320
637
  */
1321
638
  value: any;
1322
639
  };
1323
- /** @returns {TicketList} */
1324
- declare function TicketList(): TicketList;
1325
- type TicketList = {
1326
- /**
1327
- * - All the filters available for tickets
1328
- */
1329
- filters?: Filter;
1330
- /**
1331
- * - List of tickets
1332
- */
1333
- items?: Ticket[];
1334
- /**
1335
- * - Describes the pagination state
1336
- */
1337
- page?: Page;
1338
- };
1339
- /** @returns {TicketSubCategory} */
1340
- declare function TicketSubCategory(): TicketSubCategory;
1341
- type TicketSubCategory = {
1342
- /**
1343
- * - Display text for sub-category
1344
- */
1345
- display: string;
1346
- /**
1347
- * - Key for sub-category
1348
- */
1349
- key: string;
1350
- sub_categories?: TicketSubCategory;
1351
- };
1352
640
  /** @returns {UserSchema} */
1353
641
  declare function UserSchema(): UserSchema;
1354
642
  type UserSchema = {
@@ -1390,13 +678,6 @@ type PriorityEnum = "low" | "medium" | "high" | "urgent";
1390
678
  */
1391
679
  declare function TicketAssetTypeEnum(): TicketAssetTypeEnum;
1392
680
  type TicketAssetTypeEnum = "image" | "video" | "file" | "youtube" | "product" | "collection" | "brand" | "shipment" | "order";
1393
- /**
1394
- * Enum: TicketIntegrationDetails Used By: Lead
1395
- *
1396
- * @returns {TicketIntegrationDetails}
1397
- */
1398
- declare function TicketIntegrationDetails(): TicketIntegrationDetails;
1399
- type TicketIntegrationDetails = "default" | "freshdesk" | "kapture";
1400
681
  /**
1401
682
  * Enum: TicketSourceEnum Used By: Lead
1402
683
  *