@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,40 +3,26 @@ export = LeadPlatformModel;
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
  */
11
11
  /**
12
12
  * @typedef AgentChangePayload
13
13
  * @property {string} agent_id - Agent's unique ID
14
14
  */
15
- /**
16
- * @typedef CategoryData
17
- * @property {TicketCategory} [list]
18
- */
19
15
  /**
20
16
  * @typedef CloseVideoRoomResponse
21
17
  * @property {boolean} success - Denotes if operation was successfully
22
18
  */
23
- /**
24
- * @typedef CommunicationDetails
25
- * @property {string} [description] - Short description for the communication method
26
- * @property {boolean} [enabled] - Denotes if this communication method has to be shown
27
- * @property {string} [title] - Title for the communication method
28
- * @property {string} [type] - Enum type for the communication method
29
- * @property {string} [value] - Value for the communication method
30
- */
31
19
  /**
32
20
  * @typedef CreateCustomFormPayload
33
21
  * @property {string} [description] - Description of the form
34
22
  * @property {string} [header_image] - Header image that is to be shown for the form
35
23
  * @property {Object[]} inputs - List of all the form components
36
- * @property {PollForAssignment} [poll_for_assignment] - Describes how polling
37
- * will be done for the tickets createds
38
- * @property {PriorityEnum} priority - Describes the priority of the tickets
39
- * created by the form
24
+ * @property {PollForAssignment} [poll_for_assignment]
25
+ * @property {PriorityEnum} priority
40
26
  * @property {boolean} [should_notify] - Indicates if staff should be notified
41
27
  * when a response is received
42
28
  * @property {string} slug - Slug for the form
@@ -60,19 +46,18 @@ export = LeadPlatformModel;
60
46
  * @typedef CustomForm
61
47
  * @property {string} _id - Unique identifier for the form
62
48
  * @property {string} application_id - Application ID for form
63
- * @property {CreatedOn} [created_on] - Gives details of when the form was created
49
+ * @property {CreatedOn} [created_on]
64
50
  * @property {string} [description] - Form description that will be shown to the user
65
51
  * @property {string} [header_image] - Form header image that will be shown to the user
66
52
  * @property {Object[]} inputs - List of all the form fields
67
53
  * @property {boolean} login_required - Denotes if login is required to make a
68
54
  * form response submission
69
- * @property {PollForAssignment} [poll_for_assignment] - Details of how polling
70
- * should be done for support
71
- * @property {Priority} priority - Sets priority of tickets created by form response
55
+ * @property {PollForAssignment} [poll_for_assignment]
56
+ * @property {Priority} priority
72
57
  * @property {boolean} should_notify - Denotes if new response submission for
73
58
  * the form should be notified to the assignees
74
59
  * @property {string} slug - Slug for the form, which is to be used for accessing the form
75
- * @property {SubmitButton} [submit_button] - Details for submit button
60
+ * @property {SubmitButton} [submit_button]
76
61
  * @property {string} [success_message] - Message that is to be shown on
77
62
  * succesfull form response submission
78
63
  * @property {string} title - Form title that will be shown to the user
@@ -80,12 +65,7 @@ export = LeadPlatformModel;
80
65
  /**
81
66
  * @typedef CustomFormList
82
67
  * @property {CustomForm[]} [items] - List of forms
83
- * @property {Page} [page] - Describes the pagination state
84
- */
85
- /**
86
- * @typedef CustomFormSubmissionPayload
87
- * @property {TicketAsset[]} [attachments] - List of all attachments related to the form
88
- * @property {Object[]} response - Form response
68
+ * @property {Page} [page]
89
69
  */
90
70
  /**
91
71
  * @typedef Debug
@@ -99,10 +79,8 @@ export = LeadPlatformModel;
99
79
  * @property {Object[]} inputs - List of all the form components
100
80
  * @property {boolean} [login_required] - Denotes if login is required to make a
101
81
  * form response submission
102
- * @property {PollForAssignment} [poll_for_assignment] - Describes how polling
103
- * will be done for the tickets createds
104
- * @property {PriorityEnum} priority - Describes the priority of the tickets
105
- * created by the form
82
+ * @property {PollForAssignment} [poll_for_assignment]
83
+ * @property {PriorityEnum} priority
106
84
  * @property {boolean} [should_notify] - Indicates if staff should be notified
107
85
  * when a response is received
108
86
  * @property {string} [success_message] - Success message that will be shown on submission
@@ -110,11 +88,10 @@ export = LeadPlatformModel;
110
88
  */
111
89
  /**
112
90
  * @typedef EditTicketPayload
113
- * @property {AgentChangePayload} [assigned_to] - Details of support staff to
114
- * whom ticket is assigned
91
+ * @property {AgentChangePayload} [assigned_to]
115
92
  * @property {string} [category] - Category assigned to the ticket
116
- * @property {TicketContent} [content] - Ticket conetent details
117
- * @property {PriorityEnum} [priority] - Denotes the priority of ticket
93
+ * @property {TicketContent} [content]
94
+ * @property {PriorityEnum} [priority]
118
95
  * @property {string} [source] - Denotes if the ticket was created at company or
119
96
  * application level
120
97
  * @property {string} [status] - Denotes in what state is the ticket
@@ -155,25 +132,6 @@ export = LeadPlatformModel;
155
132
  * @typedef GetTokenForVideoRoomResponse
156
133
  * @property {string} access_token - Access token to be used for video room
157
134
  */
158
- /**
159
- * @typedef IntegrationConfig
160
- * @property {string} [_id] - Unique id
161
- * @property {boolean} allow_ticket_creation - Denotes ticket creation enable or
162
- * disable on platform
163
- * @property {string} [base_url] - Integration base url for validate and create ticket
164
- * @property {CategoryData} [category_data] - Support category array list details
165
- * @property {string} [category_sync_apikey] - Integration apikey to sync
166
- * category of selected type
167
- * @property {boolean} [config_completed] - Denotes the current intergration is
168
- * completed or partially done
169
- * @property {string} [create_ticket_apikey] - Integration apikey to validate
170
- * and create ticket
171
- * @property {string} integration_type - Enum string values for integration
172
- * @property {boolean} show_listing - Denotes ticket listing enable or disable on platform
173
- * @property {string} [update_ticket_apikey] - Integration apikey to update ticket
174
- * @property {string} [webhook_apikey] - Integration webhook apikey to got
175
- * callbacks from integration type dashboard like freshdesk, etc
176
- */
177
135
  /**
178
136
  * @typedef NotifyUser
179
137
  * @property {string} country_code - Country code
@@ -193,7 +151,7 @@ export = LeadPlatformModel;
193
151
  * @typedef Participant
194
152
  * @property {string} [identity] - Unique identifier of participant
195
153
  * @property {string} [status] - Status of participant
196
- * @property {UserSchema} [user] - Details of participant
154
+ * @property {UserSchema} [user]
197
155
  */
198
156
  /**
199
157
  * @typedef PhoneNumber
@@ -214,7 +172,7 @@ export = LeadPlatformModel;
214
172
  * @typedef Priority
215
173
  * @property {string} color - Color for priority
216
174
  * @property {string} display - Display text for priority
217
- * @property {PriorityEnum} key - Key for priority
175
+ * @property {PriorityEnum} key
218
176
  */
219
177
  /**
220
178
  * @typedef Status
@@ -228,47 +186,25 @@ export = LeadPlatformModel;
228
186
  * @property {string} title - Title for submit button
229
187
  * @property {string} title_color - Title color submit button
230
188
  */
231
- /**
232
- * @typedef SubmitCustomFormResponse
233
- * @property {string} message - Success message for form submission
234
- * @property {Ticket} [ticket] - Ticket created on form submission
235
- */
236
- /**
237
- * @typedef SupportGeneralConfig
238
- * @property {string} [_id] - Unique id
239
- * @property {Object} [integration] - Contains integrations basic information
240
- * @property {boolean} [show_communication_info] - Denotes if support
241
- * communication info should be shown
242
- * @property {boolean} [show_support_dris] - Denotes if support DRIS info should be shown
243
- * @property {CommunicationDetails} [support_communication] - Support
244
- * communication array list details
245
- * @property {CommunicationDetails} [support_email] - Support e-mail details
246
- * @property {CommunicationDetails} [support_faq] - Support FAQ details
247
- * @property {CommunicationDetails} [support_phone] - Support Phone number details
248
- * @property {string} [type] - The enity/platform for which the config is stored
249
- */
250
189
  /**
251
190
  * @typedef Ticket
252
191
  * @property {Object} [_custom_json] - Custom json relevant to the ticket
253
192
  * @property {string} _id - Unique identifier for the ticket
254
193
  * @property {Object} [assigned_to] - Details of support staff to whom ticket is assigned
255
- * @property {TicketCategory} category - Category assigned to the ticket
256
- * @property {TicketContent} [content] - Ticket conetent details
257
- * @property {TicketContext} [context] - Details of company and application
258
- * realated to the ticket
194
+ * @property {TicketCategory} category
195
+ * @property {TicketContent} [content]
196
+ * @property {TicketContext} [context]
259
197
  * @property {string} [created_at] - Time when the ticket was created
260
198
  * @property {Object} [created_by] - User details of ticket creator
261
- * @property {CreatedOn} [created_on] - Details of company and application
262
- * realated to the ticket
199
+ * @property {CreatedOn} [created_on]
263
200
  * @property {Object} [integration] - Integration type and its details of the ticket
264
201
  * @property {boolean} [is_feedback_pending] - Denotes if feedback submission is
265
202
  * pending for the ticket
266
- * @property {Priority} priority - Denotes the priority of ticket
203
+ * @property {Priority} priority
267
204
  * @property {string} [response_id] - Details of company and application
268
205
  * realated to the ticket
269
- * @property {TicketSourceEnum} source - Denotes if the ticket was created at
270
- * company or application level
271
- * @property {Status} status - Denotes in what state is the ticket
206
+ * @property {TicketSourceEnum} source
207
+ * @property {Status} status
272
208
  * @property {string} [sub_category] - Sub-category assigned to the ticket
273
209
  * @property {string[]} [tags] - Tags relevant to ticket
274
210
  * @property {string} [updated_at] - Time when the ticket was last updated
@@ -276,16 +212,16 @@ export = LeadPlatformModel;
276
212
  /**
277
213
  * @typedef TicketAsset
278
214
  * @property {string} [display] - Display text for asset
279
- * @property {TicketAssetTypeEnum} type - Type of asset
215
+ * @property {TicketAssetTypeEnum} type
280
216
  * @property {string} value - To be used for details
281
217
  */
282
218
  /**
283
219
  * @typedef TicketCategory
284
220
  * @property {string} display - Category display value identifier
285
- * @property {FeedbackForm} [feedback_form] - Support category array list details
221
+ * @property {FeedbackForm} [feedback_form]
286
222
  * @property {number} [group_id] - Group id of category releted data
287
223
  * @property {string} key - Category key value identifier
288
- * @property {TicketCategory} [sub_categories] - Support category array list details
224
+ * @property {TicketCategory} [sub_categories]
289
225
  */
290
226
  /**
291
227
  * @typedef TicketContent
@@ -309,11 +245,6 @@ export = LeadPlatformModel;
309
245
  * @property {string} [updated_at] - Time when the feedback was last updated
310
246
  * @property {Object} [user] - User who submitted the feedback
311
247
  */
312
- /**
313
- * @typedef TicketFeedbackForm
314
- * @property {Object[]} [display] - List of all the form fields
315
- * @property {string} title - Feedback form title that will be shown to the user
316
- */
317
248
  /**
318
249
  * @typedef TicketFeedbackList
319
250
  * @property {TicketFeedback[]} [items] - List of all ticket feedback for the ticket
@@ -328,7 +259,7 @@ export = LeadPlatformModel;
328
259
  * @property {string} _id - Unique identifier of the history event
329
260
  * @property {string} [created_at] - Time of creation of the history event
330
261
  * @property {Object} [created_by] - User who created the history event
331
- * @property {CreatedOn} [created_on] - Time of creation of the history event
262
+ * @property {CreatedOn} [created_on]
332
263
  * @property {string} ticket_id - Readable ticket number
333
264
  * @property {string} type - Type of the history event
334
265
  * @property {string} [updated_at] - Time of last update of the history event
@@ -337,24 +268,18 @@ export = LeadPlatformModel;
337
268
  /**
338
269
  * @typedef TicketHistoryList
339
270
  * @property {TicketHistory[]} [items] - List of ticket history
340
- * @property {Page} [page] - Describes the pagination state
271
+ * @property {Page} [page]
341
272
  */
342
273
  /**
343
274
  * @typedef TicketHistoryPayload
344
- * @property {HistoryTypeEnum} type - Type of history event
275
+ * @property {HistoryTypeEnum} type
345
276
  * @property {Object} value - Details of history event
346
277
  */
347
278
  /**
348
279
  * @typedef TicketList
349
- * @property {Filter} [filters] - All the filters available for tickets
280
+ * @property {Filter} [filters]
350
281
  * @property {Ticket[]} [items] - List of tickets
351
- * @property {Page} [page] - Describes the pagination state
352
- */
353
- /**
354
- * @typedef TicketSubCategory
355
- * @property {string} display - Display text for sub-category
356
- * @property {string} key - Key for sub-category
357
- * @property {TicketSubCategory} [sub_categories]
282
+ * @property {Page} [page]
358
283
  */
359
284
  /**
360
285
  * @typedef UserSchema
@@ -388,12 +313,11 @@ export = LeadPlatformModel;
388
313
  * | "shipment"
389
314
  * | "order"} TicketAssetTypeEnum
390
315
  */
391
- /** @typedef {"default" | "freshdesk" | "kapture"} TicketIntegrationDetails */
392
316
  /** @typedef {"platform_panel" | "sales_channel"} TicketSourceEnum */
393
317
  declare class LeadPlatformModel {
394
318
  }
395
319
  declare namespace LeadPlatformModel {
396
- 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 };
320
+ export { AddTicketPayload, AgentChangePayload, CloseVideoRoomResponse, CreateCustomFormPayload, CreatedOn, CreateVideoRoomPayload, CreateVideoRoomResponse, CustomForm, CustomFormList, Debug, EditCustomFormPayload, EditTicketPayload, Email, FeedbackForm, FeedbackResponseItem, Filter, GetParticipantsInsideVideoRoomResponse, GetTokenForVideoRoomResponse, NotifyUser, Page, Participant, PhoneNumber, PollForAssignment, Priority, Status, SubmitButton, Ticket, TicketAsset, TicketCategory, TicketContent, TicketContext, TicketFeedback, TicketFeedbackList, TicketFeedbackPayload, TicketHistory, TicketHistoryList, TicketHistoryPayload, TicketList, UserSchema, HistoryTypeEnum, PriorityEnum, TicketAssetTypeEnum, TicketSourceEnum };
397
321
  }
398
322
  /** @returns {AddTicketPayload} */
399
323
  declare function AddTicketPayload(): AddTicketPayload;
@@ -406,17 +330,11 @@ type AddTicketPayload = {
406
330
  * - Category of the ticket
407
331
  */
408
332
  category: string;
409
- /**
410
- * - Content for the ticket
411
- */
412
333
  content: TicketContent;
413
334
  /**
414
335
  * - Creator of the ticket
415
336
  */
416
337
  created_by?: any;
417
- /**
418
- * - Priority of the ticket
419
- */
420
338
  priority?: PriorityEnum;
421
339
  /**
422
340
  * - Status of the ticket
@@ -431,11 +349,6 @@ type AgentChangePayload = {
431
349
  */
432
350
  agent_id: string;
433
351
  };
434
- /** @returns {CategoryData} */
435
- declare function CategoryData(): CategoryData;
436
- type CategoryData = {
437
- list?: TicketCategory;
438
- };
439
352
  /** @returns {CloseVideoRoomResponse} */
440
353
  declare function CloseVideoRoomResponse(): CloseVideoRoomResponse;
441
354
  type CloseVideoRoomResponse = {
@@ -444,30 +357,6 @@ type CloseVideoRoomResponse = {
444
357
  */
445
358
  success: boolean;
446
359
  };
447
- /** @returns {CommunicationDetails} */
448
- declare function CommunicationDetails(): CommunicationDetails;
449
- type CommunicationDetails = {
450
- /**
451
- * - Short description for the communication method
452
- */
453
- description?: string;
454
- /**
455
- * - Denotes if this communication method has to be shown
456
- */
457
- enabled?: boolean;
458
- /**
459
- * - Title for the communication method
460
- */
461
- title?: string;
462
- /**
463
- * - Enum type for the communication method
464
- */
465
- type?: string;
466
- /**
467
- * - Value for the communication method
468
- */
469
- value?: string;
470
- };
471
360
  /** @returns {CreateCustomFormPayload} */
472
361
  declare function CreateCustomFormPayload(): CreateCustomFormPayload;
473
362
  type CreateCustomFormPayload = {
@@ -483,15 +372,7 @@ type CreateCustomFormPayload = {
483
372
  * - List of all the form components
484
373
  */
485
374
  inputs: any[];
486
- /**
487
- * - Describes how polling
488
- * will be done for the tickets createds
489
- */
490
375
  poll_for_assignment?: PollForAssignment;
491
- /**
492
- * - Describes the priority of the tickets
493
- * created by the form
494
- */
495
376
  priority: PriorityEnum;
496
377
  /**
497
378
  * - Indicates if staff should be notified
@@ -550,9 +431,6 @@ type CustomForm = {
550
431
  * - Application ID for form
551
432
  */
552
433
  application_id: string;
553
- /**
554
- * - Gives details of when the form was created
555
- */
556
434
  created_on?: CreatedOn;
557
435
  /**
558
436
  * - Form description that will be shown to the user
@@ -571,14 +449,7 @@ type CustomForm = {
571
449
  * form response submission
572
450
  */
573
451
  login_required: boolean;
574
- /**
575
- * - Details of how polling
576
- * should be done for support
577
- */
578
452
  poll_for_assignment?: PollForAssignment;
579
- /**
580
- * - Sets priority of tickets created by form response
581
- */
582
453
  priority: Priority;
583
454
  /**
584
455
  * - Denotes if new response submission for
@@ -589,9 +460,6 @@ type CustomForm = {
589
460
  * - Slug for the form, which is to be used for accessing the form
590
461
  */
591
462
  slug: string;
592
- /**
593
- * - Details for submit button
594
- */
595
463
  submit_button?: SubmitButton;
596
464
  /**
597
465
  * - Message that is to be shown on
@@ -610,23 +478,8 @@ type CustomFormList = {
610
478
  * - List of forms
611
479
  */
612
480
  items?: CustomForm[];
613
- /**
614
- * - Describes the pagination state
615
- */
616
481
  page?: Page;
617
482
  };
618
- /** @returns {CustomFormSubmissionPayload} */
619
- declare function CustomFormSubmissionPayload(): CustomFormSubmissionPayload;
620
- type CustomFormSubmissionPayload = {
621
- /**
622
- * - List of all attachments related to the form
623
- */
624
- attachments?: TicketAsset[];
625
- /**
626
- * - Form response
627
- */
628
- response: any[];
629
- };
630
483
  /** @returns {Debug} */
631
484
  declare function Debug(): Debug;
632
485
  type Debug = {
@@ -659,15 +512,7 @@ type EditCustomFormPayload = {
659
512
  * form response submission
660
513
  */
661
514
  login_required?: boolean;
662
- /**
663
- * - Describes how polling
664
- * will be done for the tickets createds
665
- */
666
515
  poll_for_assignment?: PollForAssignment;
667
- /**
668
- * - Describes the priority of the tickets
669
- * created by the form
670
- */
671
516
  priority: PriorityEnum;
672
517
  /**
673
518
  * - Indicates if staff should be notified
@@ -686,22 +531,12 @@ type EditCustomFormPayload = {
686
531
  /** @returns {EditTicketPayload} */
687
532
  declare function EditTicketPayload(): EditTicketPayload;
688
533
  type EditTicketPayload = {
689
- /**
690
- * - Details of support staff to
691
- * whom ticket is assigned
692
- */
693
534
  assigned_to?: AgentChangePayload;
694
535
  /**
695
536
  * - Category assigned to the ticket
696
537
  */
697
538
  category?: string;
698
- /**
699
- * - Ticket conetent details
700
- */
701
539
  content?: TicketContent;
702
- /**
703
- * - Denotes the priority of ticket
704
- */
705
540
  priority?: PriorityEnum;
706
541
  /**
707
542
  * - Denotes if the ticket was created at company or
@@ -809,59 +644,6 @@ type GetTokenForVideoRoomResponse = {
809
644
  */
810
645
  access_token: string;
811
646
  };
812
- /** @returns {IntegrationConfig} */
813
- declare function IntegrationConfig(): IntegrationConfig;
814
- type IntegrationConfig = {
815
- /**
816
- * - Unique id
817
- */
818
- _id?: string;
819
- /**
820
- * - Denotes ticket creation enable or
821
- * disable on platform
822
- */
823
- allow_ticket_creation: boolean;
824
- /**
825
- * - Integration base url for validate and create ticket
826
- */
827
- base_url?: string;
828
- /**
829
- * - Support category array list details
830
- */
831
- category_data?: CategoryData;
832
- /**
833
- * - Integration apikey to sync
834
- * category of selected type
835
- */
836
- category_sync_apikey?: string;
837
- /**
838
- * - Denotes the current intergration is
839
- * completed or partially done
840
- */
841
- config_completed?: boolean;
842
- /**
843
- * - Integration apikey to validate
844
- * and create ticket
845
- */
846
- create_ticket_apikey?: string;
847
- /**
848
- * - Enum string values for integration
849
- */
850
- integration_type: string;
851
- /**
852
- * - Denotes ticket listing enable or disable on platform
853
- */
854
- show_listing: boolean;
855
- /**
856
- * - Integration apikey to update ticket
857
- */
858
- update_ticket_apikey?: string;
859
- /**
860
- * - Integration webhook apikey to got
861
- * callbacks from integration type dashboard like freshdesk, etc
862
- */
863
- webhook_apikey?: string;
864
- };
865
647
  /** @returns {NotifyUser} */
866
648
  declare function NotifyUser(): NotifyUser;
867
649
  type NotifyUser = {
@@ -896,9 +678,6 @@ type Participant = {
896
678
  * - Status of participant
897
679
  */
898
680
  status?: string;
899
- /**
900
- * - Details of participant
901
- */
902
681
  user?: UserSchema;
903
682
  };
904
683
  /** @returns {PhoneNumber} */
@@ -956,9 +735,6 @@ type Priority = {
956
735
  * - Display text for priority
957
736
  */
958
737
  display: string;
959
- /**
960
- * - Key for priority
961
- */
962
738
  key: PriorityEnum;
963
739
  };
964
740
  /** @returns {Status} */
@@ -993,60 +769,6 @@ type SubmitButton = {
993
769
  */
994
770
  title_color: string;
995
771
  };
996
- /** @returns {SubmitCustomFormResponse} */
997
- declare function SubmitCustomFormResponse(): SubmitCustomFormResponse;
998
- type SubmitCustomFormResponse = {
999
- /**
1000
- * - Success message for form submission
1001
- */
1002
- message: string;
1003
- /**
1004
- * - Ticket created on form submission
1005
- */
1006
- ticket?: Ticket;
1007
- };
1008
- /** @returns {SupportGeneralConfig} */
1009
- declare function SupportGeneralConfig(): SupportGeneralConfig;
1010
- type SupportGeneralConfig = {
1011
- /**
1012
- * - Unique id
1013
- */
1014
- _id?: string;
1015
- /**
1016
- * - Contains integrations basic information
1017
- */
1018
- integration?: any;
1019
- /**
1020
- * - Denotes if support
1021
- * communication info should be shown
1022
- */
1023
- show_communication_info?: boolean;
1024
- /**
1025
- * - Denotes if support DRIS info should be shown
1026
- */
1027
- show_support_dris?: boolean;
1028
- /**
1029
- * - Support
1030
- * communication array list details
1031
- */
1032
- support_communication?: CommunicationDetails;
1033
- /**
1034
- * - Support e-mail details
1035
- */
1036
- support_email?: CommunicationDetails;
1037
- /**
1038
- * - Support FAQ details
1039
- */
1040
- support_faq?: CommunicationDetails;
1041
- /**
1042
- * - Support Phone number details
1043
- */
1044
- support_phone?: CommunicationDetails;
1045
- /**
1046
- * - The enity/platform for which the config is stored
1047
- */
1048
- type?: string;
1049
- };
1050
772
  /** @returns {Ticket} */
1051
773
  declare function Ticket(): Ticket;
1052
774
  type Ticket = {
@@ -1062,18 +784,8 @@ type Ticket = {
1062
784
  * - Details of support staff to whom ticket is assigned
1063
785
  */
1064
786
  assigned_to?: any;
1065
- /**
1066
- * - Category assigned to the ticket
1067
- */
1068
787
  category: TicketCategory;
1069
- /**
1070
- * - Ticket conetent details
1071
- */
1072
788
  content?: TicketContent;
1073
- /**
1074
- * - Details of company and application
1075
- * realated to the ticket
1076
- */
1077
789
  context?: TicketContext;
1078
790
  /**
1079
791
  * - Time when the ticket was created
@@ -1083,10 +795,6 @@ type Ticket = {
1083
795
  * - User details of ticket creator
1084
796
  */
1085
797
  created_by?: any;
1086
- /**
1087
- * - Details of company and application
1088
- * realated to the ticket
1089
- */
1090
798
  created_on?: CreatedOn;
1091
799
  /**
1092
800
  * - Integration type and its details of the ticket
@@ -1097,23 +805,13 @@ type Ticket = {
1097
805
  * pending for the ticket
1098
806
  */
1099
807
  is_feedback_pending?: boolean;
1100
- /**
1101
- * - Denotes the priority of ticket
1102
- */
1103
808
  priority: Priority;
1104
809
  /**
1105
810
  * - Details of company and application
1106
811
  * realated to the ticket
1107
812
  */
1108
813
  response_id?: string;
1109
- /**
1110
- * - Denotes if the ticket was created at
1111
- * company or application level
1112
- */
1113
814
  source: TicketSourceEnum;
1114
- /**
1115
- * - Denotes in what state is the ticket
1116
- */
1117
815
  status: Status;
1118
816
  /**
1119
817
  * - Sub-category assigned to the ticket
@@ -1135,9 +833,6 @@ type TicketAsset = {
1135
833
  * - Display text for asset
1136
834
  */
1137
835
  display?: string;
1138
- /**
1139
- * - Type of asset
1140
- */
1141
836
  type: TicketAssetTypeEnum;
1142
837
  /**
1143
838
  * - To be used for details
@@ -1151,9 +846,6 @@ type TicketCategory = {
1151
846
  * - Category display value identifier
1152
847
  */
1153
848
  display: string;
1154
- /**
1155
- * - Support category array list details
1156
- */
1157
849
  feedback_form?: FeedbackForm;
1158
850
  /**
1159
851
  * - Group id of category releted data
@@ -1163,9 +855,6 @@ type TicketCategory = {
1163
855
  * - Category key value identifier
1164
856
  */
1165
857
  key: string;
1166
- /**
1167
- * - Support category array list details
1168
- */
1169
858
  sub_categories?: TicketCategory;
1170
859
  };
1171
860
  /** @returns {TicketContent} */
@@ -1229,18 +918,6 @@ type TicketFeedback = {
1229
918
  */
1230
919
  user?: any;
1231
920
  };
1232
- /** @returns {TicketFeedbackForm} */
1233
- declare function TicketFeedbackForm(): TicketFeedbackForm;
1234
- type TicketFeedbackForm = {
1235
- /**
1236
- * - List of all the form fields
1237
- */
1238
- display?: any[];
1239
- /**
1240
- * - Feedback form title that will be shown to the user
1241
- */
1242
- title: string;
1243
- };
1244
921
  /** @returns {TicketFeedbackList} */
1245
922
  declare function TicketFeedbackList(): TicketFeedbackList;
1246
923
  type TicketFeedbackList = {
@@ -1273,9 +950,6 @@ type TicketHistory = {
1273
950
  * - User who created the history event
1274
951
  */
1275
952
  created_by?: any;
1276
- /**
1277
- * - Time of creation of the history event
1278
- */
1279
953
  created_on?: CreatedOn;
1280
954
  /**
1281
955
  * - Readable ticket number
@@ -1301,17 +975,11 @@ type TicketHistoryList = {
1301
975
  * - List of ticket history
1302
976
  */
1303
977
  items?: TicketHistory[];
1304
- /**
1305
- * - Describes the pagination state
1306
- */
1307
978
  page?: Page;
1308
979
  };
1309
980
  /** @returns {TicketHistoryPayload} */
1310
981
  declare function TicketHistoryPayload(): TicketHistoryPayload;
1311
982
  type TicketHistoryPayload = {
1312
- /**
1313
- * - Type of history event
1314
- */
1315
983
  type: HistoryTypeEnum;
1316
984
  /**
1317
985
  * - Details of history event
@@ -1321,32 +989,13 @@ type TicketHistoryPayload = {
1321
989
  /** @returns {TicketList} */
1322
990
  declare function TicketList(): TicketList;
1323
991
  type TicketList = {
1324
- /**
1325
- * - All the filters available for tickets
1326
- */
1327
992
  filters?: Filter;
1328
993
  /**
1329
994
  * - List of tickets
1330
995
  */
1331
996
  items?: Ticket[];
1332
- /**
1333
- * - Describes the pagination state
1334
- */
1335
997
  page?: Page;
1336
998
  };
1337
- /** @returns {TicketSubCategory} */
1338
- declare function TicketSubCategory(): TicketSubCategory;
1339
- type TicketSubCategory = {
1340
- /**
1341
- * - Display text for sub-category
1342
- */
1343
- display: string;
1344
- /**
1345
- * - Key for sub-category
1346
- */
1347
- key: string;
1348
- sub_categories?: TicketSubCategory;
1349
- };
1350
999
  /** @returns {UserSchema} */
1351
1000
  declare function UserSchema(): UserSchema;
1352
1001
  type UserSchema = {
@@ -1388,13 +1037,6 @@ type PriorityEnum = "low" | "medium" | "high" | "urgent";
1388
1037
  */
1389
1038
  declare function TicketAssetTypeEnum(): TicketAssetTypeEnum;
1390
1039
  type TicketAssetTypeEnum = "image" | "video" | "file" | "youtube" | "product" | "collection" | "brand" | "shipment" | "order";
1391
- /**
1392
- * Enum: TicketIntegrationDetails Used By: Lead
1393
- *
1394
- * @returns {TicketIntegrationDetails}
1395
- */
1396
- declare function TicketIntegrationDetails(): TicketIntegrationDetails;
1397
- type TicketIntegrationDetails = "default" | "freshdesk" | "kapture";
1398
1040
  /**
1399
1041
  * Enum: TicketSourceEnum Used By: Lead
1400
1042
  *