@gofynd/fdk-client-javascript 1.4.1 → 1.4.2-beta.10

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 (265) hide show
  1. package/README.md +1 -1
  2. package/package.json +3 -2
  3. package/sdk/application/ApplicationClient.js +20 -0
  4. package/sdk/application/Cart/CartApplicationClient.d.ts +1 -1
  5. package/sdk/application/Cart/CartApplicationClient.js +3 -5
  6. package/sdk/application/Cart/CartApplicationModel.d.ts +1634 -1742
  7. package/sdk/application/Cart/CartApplicationModel.js +1388 -1464
  8. package/sdk/application/Cart/CartApplicationValidator.d.ts +0 -4
  9. package/sdk/application/Cart/CartApplicationValidator.js +0 -4
  10. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +6 -3
  11. package/sdk/application/Catalog/CatalogApplicationClient.js +20 -7
  12. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +1917 -1917
  13. package/sdk/application/Catalog/CatalogApplicationModel.js +1613 -1613
  14. package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +14 -0
  15. package/sdk/application/Catalog/CatalogApplicationValidator.js +6 -0
  16. package/sdk/application/Common/CommonApplicationModel.d.ts +235 -235
  17. package/sdk/application/Common/CommonApplicationModel.js +172 -172
  18. package/sdk/application/Communication/CommunicationApplicationModel.d.ts +72 -72
  19. package/sdk/application/Communication/CommunicationApplicationModel.js +64 -64
  20. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +1492 -1626
  21. package/sdk/application/Configuration/ConfigurationApplicationModel.js +1038 -1180
  22. package/sdk/application/Content/ContentApplicationClient.d.ts +0 -36
  23. package/sdk/application/Content/ContentApplicationClient.js +0 -246
  24. package/sdk/application/Content/ContentApplicationModel.d.ts +546 -753
  25. package/sdk/application/Content/ContentApplicationModel.js +565 -817
  26. package/sdk/application/Content/ContentApplicationValidator.d.ts +1 -40
  27. package/sdk/application/Content/ContentApplicationValidator.js +0 -41
  28. package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +79 -79
  29. package/sdk/application/FileStorage/FileStorageApplicationModel.js +84 -84
  30. package/sdk/application/Lead/LeadApplicationModel.d.ts +417 -417
  31. package/sdk/application/Lead/LeadApplicationModel.js +301 -301
  32. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +0 -67
  33. package/sdk/application/Logistic/LogisticApplicationClient.js +0 -547
  34. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +257 -712
  35. package/sdk/application/Logistic/LogisticApplicationModel.js +267 -755
  36. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +1 -211
  37. package/sdk/application/Logistic/LogisticApplicationValidator.js +0 -131
  38. package/sdk/application/Order/OrderApplicationClient.d.ts +3 -3
  39. package/sdk/application/Order/OrderApplicationClient.js +8 -32
  40. package/sdk/application/Order/OrderApplicationModel.d.ts +845 -853
  41. package/sdk/application/Order/OrderApplicationModel.js +816 -824
  42. package/sdk/application/Order/OrderApplicationValidator.d.ts +0 -20
  43. package/sdk/application/Order/OrderApplicationValidator.js +0 -8
  44. package/sdk/application/Payment/PaymentApplicationClient.d.ts +2 -46
  45. package/sdk/application/Payment/PaymentApplicationClient.js +10 -341
  46. package/sdk/application/Payment/PaymentApplicationModel.d.ts +1892 -2199
  47. package/sdk/application/Payment/PaymentApplicationModel.js +1235 -1506
  48. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +14 -59
  49. package/sdk/application/Payment/PaymentApplicationValidator.js +10 -64
  50. package/sdk/application/PosCart/PosCartApplicationModel.d.ts +1396 -1429
  51. package/sdk/application/PosCart/PosCartApplicationModel.js +1233 -1257
  52. package/sdk/application/Rewards/RewardsApplicationModel.d.ts +214 -214
  53. package/sdk/application/Rewards/RewardsApplicationModel.js +211 -211
  54. package/sdk/application/Share/ShareApplicationModel.d.ts +114 -114
  55. package/sdk/application/Share/ShareApplicationModel.js +121 -121
  56. package/sdk/application/Theme/ThemeApplicationClient.d.ts +1 -1
  57. package/sdk/application/Theme/ThemeApplicationClient.js +3 -7
  58. package/sdk/application/Theme/ThemeApplicationModel.d.ts +783 -969
  59. package/sdk/application/Theme/ThemeApplicationModel.js +571 -867
  60. package/sdk/application/Theme/ThemeApplicationValidator.d.ts +0 -10
  61. package/sdk/application/Theme/ThemeApplicationValidator.js +0 -4
  62. package/sdk/application/User/UserApplicationClient.d.ts +0 -33
  63. package/sdk/application/User/UserApplicationClient.js +0 -239
  64. package/sdk/application/User/UserApplicationModel.d.ts +753 -768
  65. package/sdk/application/User/UserApplicationModel.js +731 -755
  66. package/sdk/application/User/UserApplicationValidator.d.ts +1 -34
  67. package/sdk/application/User/UserApplicationValidator.js +0 -36
  68. package/sdk/common/Clickstream.d.ts +1 -0
  69. package/sdk/common/Clickstream.js +254 -0
  70. package/sdk/common/Utility.js +1 -4
  71. package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +72 -60
  72. package/sdk/partner/FileStorage/FileStoragePartnerModel.js +70 -58
  73. package/sdk/partner/PartnerClient.d.ts +0 -6
  74. package/sdk/partner/PartnerClient.js +0 -9
  75. package/sdk/partner/Theme/ThemePartnerClient.d.ts +0 -10
  76. package/sdk/partner/Theme/ThemePartnerClient.js +0 -80
  77. package/sdk/partner/Theme/ThemePartnerModel.d.ts +1178 -1153
  78. package/sdk/partner/Theme/ThemePartnerModel.js +830 -974
  79. package/sdk/partner/Theme/ThemePartnerValidator.d.ts +0 -1
  80. package/sdk/partner/Theme/ThemePartnerValidator.js +0 -9
  81. package/sdk/partner/index.d.ts +0 -3
  82. package/sdk/partner/index.js +0 -6
  83. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +2 -2
  84. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +123 -123
  85. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +109 -109
  86. package/sdk/platform/Billing/BillingPlatformClient.d.ts +1 -11
  87. package/sdk/platform/Billing/BillingPlatformClient.js +3 -110
  88. package/sdk/platform/Billing/BillingPlatformModel.d.ts +734 -800
  89. package/sdk/platform/Billing/BillingPlatformModel.js +732 -810
  90. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +4 -43
  91. package/sdk/platform/Billing/BillingPlatformValidator.js +2 -29
  92. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +11 -1
  93. package/sdk/platform/Cart/CartPlatformApplicationClient.js +81 -7
  94. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +13 -5
  95. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +12 -4
  96. package/sdk/platform/Cart/CartPlatformModel.d.ts +3223 -3328
  97. package/sdk/platform/Cart/CartPlatformModel.js +2875 -2946
  98. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +11 -15
  99. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +21 -52
  100. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +0 -27
  101. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +0 -11
  102. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +15 -27
  103. package/sdk/platform/Catalog/CatalogPlatformClient.js +93 -189
  104. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +617 -920
  105. package/sdk/platform/Catalog/CatalogPlatformModel.js +584 -919
  106. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +27 -41
  107. package/sdk/platform/Catalog/CatalogPlatformValidator.js +19 -31
  108. package/sdk/platform/Common/CommonPlatformModel.d.ts +255 -255
  109. package/sdk/platform/Common/CommonPlatformModel.js +187 -187
  110. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +37 -139
  111. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +52 -737
  112. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +3 -133
  113. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +1 -113
  114. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +1079 -1228
  115. package/sdk/platform/Communication/CommunicationPlatformModel.js +1090 -1262
  116. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +2 -8
  117. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +4 -32
  118. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +629 -658
  119. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +641 -675
  120. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +0 -14
  121. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +0 -6
  122. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +8 -8
  123. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +4 -4
  124. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +2992 -3231
  125. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +2092 -2303
  126. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +2 -2
  127. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +2 -2
  128. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +0 -391
  129. package/sdk/platform/Content/ContentPlatformApplicationClient.js +1074 -3656
  130. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +1 -351
  131. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +0 -410
  132. package/sdk/platform/Content/ContentPlatformModel.d.ts +972 -2071
  133. package/sdk/platform/Content/ContentPlatformModel.js +1039 -2355
  134. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +2 -2
  135. package/sdk/platform/Discount/DiscountPlatformClient.js +2 -2
  136. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +174 -259
  137. package/sdk/platform/Discount/DiscountPlatformModel.js +163 -257
  138. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +6 -16
  139. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +8 -117
  140. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +4 -55
  141. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +2 -39
  142. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +821 -892
  143. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +833 -901
  144. package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -33
  145. package/sdk/platform/Finance/FinancePlatformClient.js +0 -240
  146. package/sdk/platform/Finance/FinancePlatformModel.d.ts +910 -1056
  147. package/sdk/platform/Finance/FinancePlatformModel.js +884 -1070
  148. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +1 -38
  149. package/sdk/platform/Finance/FinancePlatformValidator.js +0 -38
  150. package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +942 -942
  151. package/sdk/platform/Inventory/InventoryPlatformModel.js +1003 -1003
  152. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +28 -38
  153. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +56 -137
  154. package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +29 -41
  155. package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +21 -33
  156. package/sdk/platform/Lead/LeadPlatformModel.d.ts +601 -610
  157. package/sdk/platform/Lead/LeadPlatformModel.js +457 -471
  158. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +1 -11
  159. package/sdk/platform/Order/OrderPlatformApplicationClient.js +1 -93
  160. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +1 -28
  161. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +0 -18
  162. package/sdk/platform/Order/OrderPlatformClient.d.ts +22 -143
  163. package/sdk/platform/Order/OrderPlatformClient.js +160 -1190
  164. package/sdk/platform/Order/OrderPlatformModel.d.ts +4451 -5275
  165. package/sdk/platform/Order/OrderPlatformModel.js +4039 -4994
  166. package/sdk/platform/Order/OrderPlatformValidator.d.ts +21 -257
  167. package/sdk/platform/Order/OrderPlatformValidator.js +15 -216
  168. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +22 -22
  169. package/sdk/platform/Partner/PartnerPlatformModel.js +22 -22
  170. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +13 -119
  171. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +40 -750
  172. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +7 -143
  173. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +6 -133
  174. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +1 -1
  175. package/sdk/platform/Payment/PaymentPlatformClient.js +1 -1
  176. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +2067 -2929
  177. package/sdk/platform/Payment/PaymentPlatformModel.js +1427 -2090
  178. package/sdk/platform/PlatformApplicationClient.d.ts +2 -2
  179. package/sdk/platform/PlatformApplicationClient.js +4 -4
  180. package/sdk/platform/PlatformClient.d.ts +2 -4
  181. package/sdk/platform/PlatformClient.js +4 -8
  182. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +204 -204
  183. package/sdk/platform/Rewards/RewardsPlatformModel.js +199 -199
  184. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +66 -142
  185. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +147 -645
  186. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +63 -131
  187. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +47 -126
  188. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +105 -217
  189. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +349 -1138
  190. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +990 -1589
  191. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +986 -1702
  192. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +133 -382
  193. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +102 -266
  194. package/sdk/platform/Share/SharePlatformModel.d.ts +147 -147
  195. package/sdk/platform/Share/SharePlatformModel.js +139 -139
  196. package/sdk/platform/Theme/ThemePlatformClient.d.ts +1 -11
  197. package/sdk/platform/Theme/ThemePlatformClient.js +3 -87
  198. package/sdk/platform/Theme/ThemePlatformModel.d.ts +765 -1133
  199. package/sdk/platform/Theme/ThemePlatformModel.js +561 -1009
  200. package/sdk/platform/Theme/ThemePlatformValidator.d.ts +4 -28
  201. package/sdk/platform/Theme/ThemePlatformValidator.js +2 -21
  202. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +1 -116
  203. package/sdk/platform/User/UserPlatformApplicationClient.js +86 -932
  204. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +7 -224
  205. package/sdk/platform/User/UserPlatformApplicationValidator.js +5 -173
  206. package/sdk/platform/User/UserPlatformModel.d.ts +428 -765
  207. package/sdk/platform/User/UserPlatformModel.js +428 -679
  208. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +37 -45
  209. package/sdk/platform/Webhook/WebhookPlatformClient.js +57 -61
  210. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +403 -448
  211. package/sdk/platform/Webhook/WebhookPlatformModel.js +309 -369
  212. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -7
  213. package/sdk/platform/Webhook/WebhookPlatformValidator.js +6 -6
  214. package/sdk/platform/index.d.ts +1 -1
  215. package/sdk/platform/index.js +2 -2
  216. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +237 -237
  217. package/sdk/public/Configuration/ConfigurationPublicModel.js +174 -174
  218. package/sdk/public/Inventory/InventoryPublicModel.d.ts +237 -237
  219. package/sdk/public/Inventory/InventoryPublicModel.js +257 -257
  220. package/sdk/public/Partner/PartnerPublicModel.d.ts +104 -104
  221. package/sdk/public/Partner/PartnerPublicModel.js +113 -113
  222. package/sdk/public/PublicClient.d.ts +0 -4
  223. package/sdk/public/PublicClient.js +0 -8
  224. package/sdk/public/Webhook/WebhookPublicClient.d.ts +0 -33
  225. package/sdk/public/Webhook/WebhookPublicClient.js +0 -242
  226. package/sdk/public/Webhook/WebhookPublicModel.d.ts +15 -161
  227. package/sdk/public/Webhook/WebhookPublicModel.js +13 -189
  228. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +1 -23
  229. package/sdk/public/Webhook/WebhookPublicValidator.js +0 -31
  230. package/sdk/public/index.d.ts +0 -2
  231. package/sdk/public/index.js +0 -4
  232. package/sdk/partner/Lead/LeadPartnerClient.d.ts +0 -125
  233. package/sdk/partner/Lead/LeadPartnerClient.js +0 -785
  234. package/sdk/partner/Lead/LeadPartnerModel.d.ts +0 -1127
  235. package/sdk/partner/Lead/LeadPartnerModel.js +0 -896
  236. package/sdk/partner/Lead/LeadPartnerValidator.d.ts +0 -12
  237. package/sdk/partner/Lead/LeadPartnerValidator.js +0 -67
  238. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +0 -155
  239. package/sdk/partner/Logistics/LogisticsPartnerClient.js +0 -1195
  240. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +0 -372
  241. package/sdk/partner/Logistics/LogisticsPartnerModel.js +0 -442
  242. package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +0 -16
  243. package/sdk/partner/Logistics/LogisticsPartnerValidator.js +0 -123
  244. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +0 -99
  245. package/sdk/partner/Webhook/WebhookPartnerClient.js +0 -753
  246. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +0 -566
  247. package/sdk/partner/Webhook/WebhookPartnerModel.js +0 -583
  248. package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +0 -12
  249. package/sdk/partner/Webhook/WebhookPartnerValidator.js +0 -74
  250. package/sdk/platform/Content/ContentPlatformClient.d.ts +0 -277
  251. package/sdk/platform/Content/ContentPlatformClient.js +0 -2011
  252. package/sdk/platform/Content/ContentPlatformValidator.d.ts +0 -247
  253. package/sdk/platform/Content/ContentPlatformValidator.js +0 -319
  254. package/sdk/public/Billing/BillingPublicClient.d.ts +0 -23
  255. package/sdk/public/Billing/BillingPublicClient.js +0 -116
  256. package/sdk/public/Billing/BillingPublicModel.d.ts +0 -92
  257. package/sdk/public/Billing/BillingPublicModel.js +0 -96
  258. package/sdk/public/Billing/BillingPublicValidator.d.ts +0 -18
  259. package/sdk/public/Billing/BillingPublicValidator.js +0 -19
  260. package/sdk/public/Content/ContentPublicClient.d.ts +0 -22
  261. package/sdk/public/Content/ContentPublicClient.js +0 -114
  262. package/sdk/public/Content/ContentPublicModel.d.ts +0 -53
  263. package/sdk/public/Content/ContentPublicModel.js +0 -60
  264. package/sdk/public/Content/ContentPublicValidator.d.ts +0 -18
  265. package/sdk/public/Content/ContentPublicValidator.js +0 -19
@@ -1,1127 +0,0 @@
1
- export = LeadPartnerModel;
2
- /**
3
- * @typedef AddTicketPayload
4
- * @property {Object} [_custom_json] - Optional custom data that needs to be sent
5
- * @property {string} category - Category of the ticket
6
- * @property {TicketContent} content
7
- * @property {Object} [created_by] - Creator of the ticket
8
- * @property {PriorityEnum} [priority]
9
- * @property {string} [status] - Status of the ticket
10
- */
11
- /**
12
- * @typedef AgentChangePayload
13
- * @property {string} agent_id - Agent's unique ID
14
- */
15
- /**
16
- * @typedef CloseVideoRoomResponse
17
- * @property {boolean} success - Denotes if operation was successfully
18
- */
19
- /**
20
- * @typedef CreateCustomFormPayload
21
- * @property {string} [description] - Description of the form
22
- * @property {string} [header_image] - Header image that is to be shown for the form
23
- * @property {Object[]} inputs - List of all the form components
24
- * @property {PollForAssignment} [poll_for_assignment]
25
- * @property {PriorityEnum} priority
26
- * @property {boolean} [should_notify] - Indicates if staff should be notified
27
- * when a response is received
28
- * @property {string} slug - Slug for the form
29
- * @property {string} [success_message] - Success message that will be shown on submission
30
- * @property {string} title - Title for the form
31
- */
32
- /**
33
- * @typedef CreatedOn
34
- * @property {string} user_agent - Useragent details
35
- */
36
- /**
37
- * @typedef CreateVideoRoomPayload
38
- * @property {NotifyUser[]} [notify] - List of people to be notified
39
- * @property {string} unique_name - Ticket id
40
- */
41
- /**
42
- * @typedef CreateVideoRoomResponse
43
- * @property {string} unique_name - Video Room's unique name
44
- */
45
- /**
46
- * @typedef CustomForm
47
- * @property {string} _id - Unique identifier for the form
48
- * @property {string} application_id - Application ID for form
49
- * @property {CreatedOn} [created_on]
50
- * @property {string} [description] - Form description that will be shown to the user
51
- * @property {string} [header_image] - Form header image that will be shown to the user
52
- * @property {Object[]} inputs - List of all the form fields
53
- * @property {boolean} login_required - Denotes if login is required to make a
54
- * form response submission
55
- * @property {PollForAssignment} [poll_for_assignment]
56
- * @property {Priority} priority
57
- * @property {boolean} should_notify - Denotes if new response submission for
58
- * the form should be notified to the assignees
59
- * @property {string} slug - Slug for the form, which is to be used for accessing the form
60
- * @property {SubmitButton} [submit_button]
61
- * @property {string} [success_message] - Message that is to be shown on
62
- * succesfull form response submission
63
- * @property {string} title - Form title that will be shown to the user
64
- */
65
- /**
66
- * @typedef CustomFormList
67
- * @property {CustomForm[]} [items] - List of forms
68
- * @property {Page} [page]
69
- */
70
- /**
71
- * @typedef Debug
72
- * @property {string} [platform] - Platform of user
73
- * @property {string} [source] - Source of user
74
- */
75
- /**
76
- * @typedef EditCustomFormPayload
77
- * @property {string} [description] - Description of the form
78
- * @property {string} [header_image] - Header image that is to be shown for the form
79
- * @property {Object[]} inputs - List of all the form components
80
- * @property {boolean} [login_required] - Denotes if login is required to make a
81
- * form response submission
82
- * @property {PollForAssignment} [poll_for_assignment]
83
- * @property {PriorityEnum} priority
84
- * @property {boolean} [should_notify] - Indicates if staff should be notified
85
- * when a response is received
86
- * @property {string} [success_message] - Success message that will be shown on submission
87
- * @property {string} title - Title for the form
88
- */
89
- /**
90
- * @typedef EditTicketPayload
91
- * @property {AgentChangePayload} [assigned_to]
92
- * @property {string} [category] - Category assigned to the ticket
93
- * @property {TicketContent} [content]
94
- * @property {PriorityEnum} [priority]
95
- * @property {string} [source] - Denotes if the ticket was created at partner or
96
- * application level
97
- * @property {string} [status] - Denotes in what state is the ticket
98
- * @property {string} [sub_category] - Sub-category assigned to the ticket
99
- * @property {string[]} [tags] - Tags relevant to ticket
100
- */
101
- /**
102
- * @typedef Email
103
- * @property {boolean} [active] - Denotes if the email is active
104
- * @property {string} [email] - Email Address
105
- * @property {boolean} [primary] - Denotes it's the primary email for the account
106
- * @property {boolean} [verified] - Denotes it's a verified email
107
- */
108
- /**
109
- * @typedef FeedbackForm
110
- * @property {Object} [inputs] - Input details for the feed back form
111
- * @property {Object} [timestamps] - Gives details of category releted data
112
- * @property {string} [title] - Title for the feed back form
113
- */
114
- /**
115
- * @typedef FeedbackResponseItem
116
- * @property {string} display - Question/Title of the form field
117
- * @property {string} key - Key of the form field
118
- * @property {string} value - User response value for the form field
119
- */
120
- /**
121
- * @typedef Filter
122
- * @property {Object[]} assignees - List of support staff availble for tickets assignment
123
- * @property {TicketCategory[]} [categories] - List of possible categories for tickets
124
- * @property {Priority[]} priorities - List of possible priorities for tickets
125
- * @property {Status[]} statuses - List of possible statuses for tickets
126
- */
127
- /**
128
- * @typedef GeneralConfigIntegrationSchema
129
- * @property {string} [type]
130
- */
131
- /**
132
- * @typedef GeneralConfigResponse
133
- * @property {string[]} [available_integration]
134
- * @property {GeneralConfigIntegrationSchema} [integration]
135
- * @property {SupportCommunicationSchema[]} [support_communication]
136
- * @property {string} [type]
137
- */
138
- /**
139
- * @typedef GetParticipantsInsideVideoRoomResponse
140
- * @property {Participant[]} participants - List of participants of the video room
141
- */
142
- /**
143
- * @typedef GetTokenForVideoRoomResponse
144
- * @property {string} access_token - Access token to be used for video room
145
- */
146
- /**
147
- * @typedef NotifyUser
148
- * @property {string} country_code - Country code
149
- * @property {string} phone_number - Phone number
150
- */
151
- /**
152
- * @typedef Page
153
- * @property {number} [current]
154
- * @property {boolean} [has_next]
155
- * @property {boolean} [has_previous]
156
- * @property {number} [item_total]
157
- * @property {string} [next_id]
158
- * @property {number} [size]
159
- * @property {string} type
160
- */
161
- /**
162
- * @typedef Participant
163
- * @property {string} [identity] - Unique identifier of participant
164
- * @property {string} [status] - Status of participant
165
- * @property {UserSchema} [user]
166
- */
167
- /**
168
- * @typedef PhoneNumber
169
- * @property {boolean} [active] - Denotes if the phone number is active
170
- * @property {number} [country_code] - Country code
171
- * @property {string} [phone] - Phone number
172
- * @property {boolean} [primary] - Denotes it's the primary phone number for the account
173
- * @property {boolean} [verified] - Denotes it's a verified phone number
174
- */
175
- /**
176
- * @typedef PollForAssignment
177
- * @property {number} duration - Duration for polling of staff
178
- * @property {string} failure_message - Message if polling failed
179
- * @property {string} message - Message for polling
180
- * @property {string} success_message - Message for successful polling
181
- */
182
- /**
183
- * @typedef Priority
184
- * @property {string} color - Color for priority
185
- * @property {string} display - Display text for priority
186
- * @property {PriorityEnum} key
187
- */
188
- /**
189
- * @typedef Status
190
- * @property {string} color - Color for status
191
- * @property {string} display - Display text for status
192
- * @property {string} key - Key for status
193
- */
194
- /**
195
- * @typedef SubmitButton
196
- * @property {string} background_color - Color for submit button
197
- * @property {string} title - Title for submit button
198
- * @property {string} title_color - Title color submit button
199
- */
200
- /**
201
- * @typedef SupportCommunicationSchema
202
- * @property {string} [description]
203
- * @property {boolean} [enabled]
204
- * @property {string} [title]
205
- * @property {string} [type]
206
- * @property {Object} [value]
207
- */
208
- /**
209
- * @typedef Ticket
210
- * @property {Object} [_custom_json] - Custom json relevant to the ticket
211
- * @property {string} _id - Unique identifier for the ticket
212
- * @property {Object} [assigned_to] - Details of support staff to whom ticket is assigned
213
- * @property {TicketCategory} category
214
- * @property {TicketContent} [content]
215
- * @property {TicketContext} [context]
216
- * @property {string} [created_at] - Time when the ticket was created
217
- * @property {Object} [created_by] - User details of ticket creator
218
- * @property {CreatedOn} [created_on]
219
- * @property {Object} [integration] - Integration type and its details of the ticket
220
- * @property {boolean} [is_feedback_pending] - Denotes if feedback submission is
221
- * pending for the ticket
222
- * @property {Priority} priority
223
- * @property {string} [response_id] - Details of partner and application
224
- * realated to the ticket
225
- * @property {TicketSourceEnum} source
226
- * @property {Status} status
227
- * @property {string} [sub_category] - Sub-category assigned to the ticket
228
- * @property {string[]} [tags] - Tags relevant to ticket
229
- * @property {string} [updated_at] - Time when the ticket was last updated
230
- */
231
- /**
232
- * @typedef TicketAsset
233
- * @property {string} [display] - Display text for asset
234
- * @property {TicketAssetTypeEnum} type
235
- * @property {string} value - To be used for details
236
- */
237
- /**
238
- * @typedef TicketCategory
239
- * @property {string} display - Category display value identifier
240
- * @property {FeedbackForm} [feedback_form]
241
- * @property {number} [group_id] - Group id of category releted data
242
- * @property {string} key - Category key value identifier
243
- * @property {TicketCategory} [sub_categories]
244
- */
245
- /**
246
- * @typedef TicketContent
247
- * @property {TicketAsset[]} [attachments] - List of all attachments related to the ticket
248
- * @property {string} [description] - Long description of issue
249
- * @property {string} title - Title for ticket
250
- */
251
- /**
252
- * @typedef TicketContext
253
- * @property {string} [application_id] - Application ID related to the ticket
254
- * @property {string} partner_id - Partner ID related to the ticket
255
- */
256
- /**
257
- * @typedef TicketFeedback
258
- * @property {string} _id - Unique identifier for the feedback
259
- * @property {string} [category] - Category of the ticket
260
- * @property {string} [created_at] - Time when the feedback was created
261
- * @property {string} partner_id - Partner id for which ticket was raised
262
- * @property {FeedbackResponseItem[]} response
263
- * @property {string} ticket_id - Readable ticket number
264
- * @property {string} [updated_at] - Time when the feedback was last updated
265
- * @property {Object} [user] - User who submitted the feedback
266
- */
267
- /**
268
- * @typedef TicketFeedbackList
269
- * @property {TicketFeedback[]} [items] - List of all ticket feedback for the ticket
270
- */
271
- /**
272
- * @typedef TicketFeedbackPayload
273
- * @property {Object} [form_response] - Key-value pairs of all the form fields
274
- * and their response
275
- */
276
- /**
277
- * @typedef TicketHistory
278
- * @property {string} _id - Unique identifier of the history event
279
- * @property {string} [created_at] - Time of creation of the history event
280
- * @property {Object} [created_by] - User who created the history event
281
- * @property {CreatedOn} [created_on]
282
- * @property {string} ticket_id - Readable ticket number
283
- * @property {string} type - Type of the history event
284
- * @property {string} [updated_at] - Time of last update of the history event
285
- * @property {Object} value - Data of the history event
286
- */
287
- /**
288
- * @typedef TicketHistoryList
289
- * @property {TicketHistory[]} [items] - List of ticket history
290
- * @property {Page} [page]
291
- */
292
- /**
293
- * @typedef TicketHistoryPayload
294
- * @property {HistoryTypeEnum} type
295
- * @property {Object} value - Details of history event
296
- */
297
- /**
298
- * @typedef TicketList
299
- * @property {Filter} [filters]
300
- * @property {Ticket[]} [items] - List of tickets
301
- * @property {Page} [page]
302
- */
303
- /**
304
- * @typedef UserSchema
305
- * @property {string} [_id] - Unique identifier of user
306
- * @property {string} [account_type] - Type of account
307
- * @property {boolean} [active] - Is account active
308
- * @property {string} [created_at] - Time of user creation
309
- * @property {Debug} [debug]
310
- * @property {Email[]} [emails] - List of email addresses
311
- * @property {string} [first_name] - First name
312
- * @property {string} [gender] - Gender of user
313
- * @property {boolean} [has_old_password_hash] - Denotes if user has old password hash
314
- * @property {string} [last_name] - Last name
315
- * @property {PhoneNumber[]} [phone_numbers] - List of phone numbers
316
- * @property {string} [profile_pic_url] - URL for profile pic
317
- * @property {string} [uid] - Unique identifier of user
318
- * @property {string} [updated_at] - Last time of user details update
319
- * @property {string} [username] - Username of user
320
- */
321
- /** @typedef {"rating" | "log" | "comment"} HistoryTypeEnum */
322
- /** @typedef {"low" | "medium" | "high" | "urgent"} PriorityEnum */
323
- /**
324
- * @typedef {| "image"
325
- * | "video"
326
- * | "file"
327
- * | "youtube"
328
- * | "product"
329
- * | "collection"
330
- * | "brand"
331
- * | "shipment"
332
- * | "order"} TicketAssetTypeEnum
333
- */
334
- /** @typedef {"platform_panel" | "sales_channel"} TicketSourceEnum */
335
- declare class LeadPartnerModel {
336
- }
337
- declare namespace LeadPartnerModel {
338
- export { AddTicketPayload, AgentChangePayload, CloseVideoRoomResponse, CreateCustomFormPayload, CreatedOn, CreateVideoRoomPayload, CreateVideoRoomResponse, CustomForm, CustomFormList, Debug, EditCustomFormPayload, EditTicketPayload, Email, FeedbackForm, FeedbackResponseItem, Filter, GeneralConfigIntegrationSchema, GeneralConfigResponse, GetParticipantsInsideVideoRoomResponse, GetTokenForVideoRoomResponse, NotifyUser, Page, Participant, PhoneNumber, PollForAssignment, Priority, Status, SubmitButton, SupportCommunicationSchema, Ticket, TicketAsset, TicketCategory, TicketContent, TicketContext, TicketFeedback, TicketFeedbackList, TicketFeedbackPayload, TicketHistory, TicketHistoryList, TicketHistoryPayload, TicketList, UserSchema, HistoryTypeEnum, PriorityEnum, TicketAssetTypeEnum, TicketSourceEnum };
339
- }
340
- /** @returns {AddTicketPayload} */
341
- declare function AddTicketPayload(): AddTicketPayload;
342
- type AddTicketPayload = {
343
- /**
344
- * - Optional custom data that needs to be sent
345
- */
346
- _custom_json?: any;
347
- /**
348
- * - Category of the ticket
349
- */
350
- category: string;
351
- content: TicketContent;
352
- /**
353
- * - Creator of the ticket
354
- */
355
- created_by?: any;
356
- priority?: PriorityEnum;
357
- /**
358
- * - Status of the ticket
359
- */
360
- status?: string;
361
- };
362
- /** @returns {AgentChangePayload} */
363
- declare function AgentChangePayload(): AgentChangePayload;
364
- type AgentChangePayload = {
365
- /**
366
- * - Agent's unique ID
367
- */
368
- agent_id: string;
369
- };
370
- /** @returns {CloseVideoRoomResponse} */
371
- declare function CloseVideoRoomResponse(): CloseVideoRoomResponse;
372
- type CloseVideoRoomResponse = {
373
- /**
374
- * - Denotes if operation was successfully
375
- */
376
- success: boolean;
377
- };
378
- /** @returns {CreateCustomFormPayload} */
379
- declare function CreateCustomFormPayload(): CreateCustomFormPayload;
380
- type CreateCustomFormPayload = {
381
- /**
382
- * - Description of the form
383
- */
384
- description?: string;
385
- /**
386
- * - Header image that is to be shown for the form
387
- */
388
- header_image?: string;
389
- /**
390
- * - List of all the form components
391
- */
392
- inputs: any[];
393
- poll_for_assignment?: PollForAssignment;
394
- priority: PriorityEnum;
395
- /**
396
- * - Indicates if staff should be notified
397
- * when a response is received
398
- */
399
- should_notify?: boolean;
400
- /**
401
- * - Slug for the form
402
- */
403
- slug: string;
404
- /**
405
- * - Success message that will be shown on submission
406
- */
407
- success_message?: string;
408
- /**
409
- * - Title for the form
410
- */
411
- title: string;
412
- };
413
- /** @returns {CreatedOn} */
414
- declare function CreatedOn(): CreatedOn;
415
- type CreatedOn = {
416
- /**
417
- * - Useragent details
418
- */
419
- user_agent: string;
420
- };
421
- /** @returns {CreateVideoRoomPayload} */
422
- declare function CreateVideoRoomPayload(): CreateVideoRoomPayload;
423
- type CreateVideoRoomPayload = {
424
- /**
425
- * - List of people to be notified
426
- */
427
- notify?: NotifyUser[];
428
- /**
429
- * - Ticket id
430
- */
431
- unique_name: string;
432
- };
433
- /** @returns {CreateVideoRoomResponse} */
434
- declare function CreateVideoRoomResponse(): CreateVideoRoomResponse;
435
- type CreateVideoRoomResponse = {
436
- /**
437
- * - Video Room's unique name
438
- */
439
- unique_name: string;
440
- };
441
- /** @returns {CustomForm} */
442
- declare function CustomForm(): CustomForm;
443
- type CustomForm = {
444
- /**
445
- * - Unique identifier for the form
446
- */
447
- _id: string;
448
- /**
449
- * - Application ID for form
450
- */
451
- application_id: string;
452
- created_on?: CreatedOn;
453
- /**
454
- * - Form description that will be shown to the user
455
- */
456
- description?: string;
457
- /**
458
- * - Form header image that will be shown to the user
459
- */
460
- header_image?: string;
461
- /**
462
- * - List of all the form fields
463
- */
464
- inputs: any[];
465
- /**
466
- * - Denotes if login is required to make a
467
- * form response submission
468
- */
469
- login_required: boolean;
470
- poll_for_assignment?: PollForAssignment;
471
- priority: Priority;
472
- /**
473
- * - Denotes if new response submission for
474
- * the form should be notified to the assignees
475
- */
476
- should_notify: boolean;
477
- /**
478
- * - Slug for the form, which is to be used for accessing the form
479
- */
480
- slug: string;
481
- submit_button?: SubmitButton;
482
- /**
483
- * - Message that is to be shown on
484
- * succesfull form response submission
485
- */
486
- success_message?: string;
487
- /**
488
- * - Form title that will be shown to the user
489
- */
490
- title: string;
491
- };
492
- /** @returns {CustomFormList} */
493
- declare function CustomFormList(): CustomFormList;
494
- type CustomFormList = {
495
- /**
496
- * - List of forms
497
- */
498
- items?: CustomForm[];
499
- page?: Page;
500
- };
501
- /** @returns {Debug} */
502
- declare function Debug(): Debug;
503
- type Debug = {
504
- /**
505
- * - Platform of user
506
- */
507
- platform?: string;
508
- /**
509
- * - Source of user
510
- */
511
- source?: string;
512
- };
513
- /** @returns {EditCustomFormPayload} */
514
- declare function EditCustomFormPayload(): EditCustomFormPayload;
515
- type EditCustomFormPayload = {
516
- /**
517
- * - Description of the form
518
- */
519
- description?: string;
520
- /**
521
- * - Header image that is to be shown for the form
522
- */
523
- header_image?: string;
524
- /**
525
- * - List of all the form components
526
- */
527
- inputs: any[];
528
- /**
529
- * - Denotes if login is required to make a
530
- * form response submission
531
- */
532
- login_required?: boolean;
533
- poll_for_assignment?: PollForAssignment;
534
- priority: PriorityEnum;
535
- /**
536
- * - Indicates if staff should be notified
537
- * when a response is received
538
- */
539
- should_notify?: boolean;
540
- /**
541
- * - Success message that will be shown on submission
542
- */
543
- success_message?: string;
544
- /**
545
- * - Title for the form
546
- */
547
- title: string;
548
- };
549
- /** @returns {EditTicketPayload} */
550
- declare function EditTicketPayload(): EditTicketPayload;
551
- type EditTicketPayload = {
552
- assigned_to?: AgentChangePayload;
553
- /**
554
- * - Category assigned to the ticket
555
- */
556
- category?: string;
557
- content?: TicketContent;
558
- priority?: PriorityEnum;
559
- /**
560
- * - Denotes if the ticket was created at partner or
561
- * application level
562
- */
563
- source?: string;
564
- /**
565
- * - Denotes in what state is the ticket
566
- */
567
- status?: string;
568
- /**
569
- * - Sub-category assigned to the ticket
570
- */
571
- sub_category?: string;
572
- /**
573
- * - Tags relevant to ticket
574
- */
575
- tags?: string[];
576
- };
577
- /** @returns {Email} */
578
- declare function Email(): Email;
579
- type Email = {
580
- /**
581
- * - Denotes if the email is active
582
- */
583
- active?: boolean;
584
- /**
585
- * - Email Address
586
- */
587
- email?: string;
588
- /**
589
- * - Denotes it's the primary email for the account
590
- */
591
- primary?: boolean;
592
- /**
593
- * - Denotes it's a verified email
594
- */
595
- verified?: boolean;
596
- };
597
- /** @returns {FeedbackForm} */
598
- declare function FeedbackForm(): FeedbackForm;
599
- type FeedbackForm = {
600
- /**
601
- * - Input details for the feed back form
602
- */
603
- inputs?: any;
604
- /**
605
- * - Gives details of category releted data
606
- */
607
- timestamps?: any;
608
- /**
609
- * - Title for the feed back form
610
- */
611
- title?: string;
612
- };
613
- /** @returns {FeedbackResponseItem} */
614
- declare function FeedbackResponseItem(): FeedbackResponseItem;
615
- type FeedbackResponseItem = {
616
- /**
617
- * - Question/Title of the form field
618
- */
619
- display: string;
620
- /**
621
- * - Key of the form field
622
- */
623
- key: string;
624
- /**
625
- * - User response value for the form field
626
- */
627
- value: string;
628
- };
629
- /** @returns {Filter} */
630
- declare function Filter(): Filter;
631
- type Filter = {
632
- /**
633
- * - List of support staff availble for tickets assignment
634
- */
635
- assignees: any[];
636
- /**
637
- * - List of possible categories for tickets
638
- */
639
- categories?: TicketCategory[];
640
- /**
641
- * - List of possible priorities for tickets
642
- */
643
- priorities: Priority[];
644
- /**
645
- * - List of possible statuses for tickets
646
- */
647
- statuses: Status[];
648
- };
649
- /** @returns {GeneralConfigIntegrationSchema} */
650
- declare function GeneralConfigIntegrationSchema(): GeneralConfigIntegrationSchema;
651
- type GeneralConfigIntegrationSchema = {
652
- type?: string;
653
- };
654
- /** @returns {GeneralConfigResponse} */
655
- declare function GeneralConfigResponse(): GeneralConfigResponse;
656
- type GeneralConfigResponse = {
657
- available_integration?: string[];
658
- integration?: GeneralConfigIntegrationSchema;
659
- support_communication?: SupportCommunicationSchema[];
660
- type?: string;
661
- };
662
- /** @returns {GetParticipantsInsideVideoRoomResponse} */
663
- declare function GetParticipantsInsideVideoRoomResponse(): GetParticipantsInsideVideoRoomResponse;
664
- type GetParticipantsInsideVideoRoomResponse = {
665
- /**
666
- * - List of participants of the video room
667
- */
668
- participants: Participant[];
669
- };
670
- /** @returns {GetTokenForVideoRoomResponse} */
671
- declare function GetTokenForVideoRoomResponse(): GetTokenForVideoRoomResponse;
672
- type GetTokenForVideoRoomResponse = {
673
- /**
674
- * - Access token to be used for video room
675
- */
676
- access_token: string;
677
- };
678
- /** @returns {NotifyUser} */
679
- declare function NotifyUser(): NotifyUser;
680
- type NotifyUser = {
681
- /**
682
- * - Country code
683
- */
684
- country_code: string;
685
- /**
686
- * - Phone number
687
- */
688
- phone_number: string;
689
- };
690
- /** @returns {Page} */
691
- declare function Page(): Page;
692
- type Page = {
693
- current?: number;
694
- has_next?: boolean;
695
- has_previous?: boolean;
696
- item_total?: number;
697
- next_id?: string;
698
- size?: number;
699
- type: string;
700
- };
701
- /** @returns {Participant} */
702
- declare function Participant(): Participant;
703
- type Participant = {
704
- /**
705
- * - Unique identifier of participant
706
- */
707
- identity?: string;
708
- /**
709
- * - Status of participant
710
- */
711
- status?: string;
712
- user?: UserSchema;
713
- };
714
- /** @returns {PhoneNumber} */
715
- declare function PhoneNumber(): PhoneNumber;
716
- type PhoneNumber = {
717
- /**
718
- * - Denotes if the phone number is active
719
- */
720
- active?: boolean;
721
- /**
722
- * - Country code
723
- */
724
- country_code?: number;
725
- /**
726
- * - Phone number
727
- */
728
- phone?: string;
729
- /**
730
- * - Denotes it's the primary phone number for the account
731
- */
732
- primary?: boolean;
733
- /**
734
- * - Denotes it's a verified phone number
735
- */
736
- verified?: boolean;
737
- };
738
- /** @returns {PollForAssignment} */
739
- declare function PollForAssignment(): PollForAssignment;
740
- type PollForAssignment = {
741
- /**
742
- * - Duration for polling of staff
743
- */
744
- duration: number;
745
- /**
746
- * - Message if polling failed
747
- */
748
- failure_message: string;
749
- /**
750
- * - Message for polling
751
- */
752
- message: string;
753
- /**
754
- * - Message for successful polling
755
- */
756
- success_message: string;
757
- };
758
- /** @returns {Priority} */
759
- declare function Priority(): Priority;
760
- type Priority = {
761
- /**
762
- * - Color for priority
763
- */
764
- color: string;
765
- /**
766
- * - Display text for priority
767
- */
768
- display: string;
769
- key: PriorityEnum;
770
- };
771
- /** @returns {Status} */
772
- declare function Status(): Status;
773
- type Status = {
774
- /**
775
- * - Color for status
776
- */
777
- color: string;
778
- /**
779
- * - Display text for status
780
- */
781
- display: string;
782
- /**
783
- * - Key for status
784
- */
785
- key: string;
786
- };
787
- /** @returns {SubmitButton} */
788
- declare function SubmitButton(): SubmitButton;
789
- type SubmitButton = {
790
- /**
791
- * - Color for submit button
792
- */
793
- background_color: string;
794
- /**
795
- * - Title for submit button
796
- */
797
- title: string;
798
- /**
799
- * - Title color submit button
800
- */
801
- title_color: string;
802
- };
803
- /** @returns {SupportCommunicationSchema} */
804
- declare function SupportCommunicationSchema(): SupportCommunicationSchema;
805
- type SupportCommunicationSchema = {
806
- description?: string;
807
- enabled?: boolean;
808
- title?: string;
809
- type?: string;
810
- value?: any;
811
- };
812
- /** @returns {Ticket} */
813
- declare function Ticket(): Ticket;
814
- type Ticket = {
815
- /**
816
- * - Custom json relevant to the ticket
817
- */
818
- _custom_json?: any;
819
- /**
820
- * - Unique identifier for the ticket
821
- */
822
- _id: string;
823
- /**
824
- * - Details of support staff to whom ticket is assigned
825
- */
826
- assigned_to?: any;
827
- category: TicketCategory;
828
- content?: TicketContent;
829
- context?: TicketContext;
830
- /**
831
- * - Time when the ticket was created
832
- */
833
- created_at?: string;
834
- /**
835
- * - User details of ticket creator
836
- */
837
- created_by?: any;
838
- created_on?: CreatedOn;
839
- /**
840
- * - Integration type and its details of the ticket
841
- */
842
- integration?: any;
843
- /**
844
- * - Denotes if feedback submission is
845
- * pending for the ticket
846
- */
847
- is_feedback_pending?: boolean;
848
- priority: Priority;
849
- /**
850
- * - Details of partner and application
851
- * realated to the ticket
852
- */
853
- response_id?: string;
854
- source: TicketSourceEnum;
855
- status: Status;
856
- /**
857
- * - Sub-category assigned to the ticket
858
- */
859
- sub_category?: string;
860
- /**
861
- * - Tags relevant to ticket
862
- */
863
- tags?: string[];
864
- /**
865
- * - Time when the ticket was last updated
866
- */
867
- updated_at?: string;
868
- };
869
- /** @returns {TicketAsset} */
870
- declare function TicketAsset(): TicketAsset;
871
- type TicketAsset = {
872
- /**
873
- * - Display text for asset
874
- */
875
- display?: string;
876
- type: TicketAssetTypeEnum;
877
- /**
878
- * - To be used for details
879
- */
880
- value: string;
881
- };
882
- /** @returns {TicketCategory} */
883
- declare function TicketCategory(): TicketCategory;
884
- type TicketCategory = {
885
- /**
886
- * - Category display value identifier
887
- */
888
- display: string;
889
- feedback_form?: FeedbackForm;
890
- /**
891
- * - Group id of category releted data
892
- */
893
- group_id?: number;
894
- /**
895
- * - Category key value identifier
896
- */
897
- key: string;
898
- sub_categories?: TicketCategory;
899
- };
900
- /** @returns {TicketContent} */
901
- declare function TicketContent(): TicketContent;
902
- type TicketContent = {
903
- /**
904
- * - List of all attachments related to the ticket
905
- */
906
- attachments?: TicketAsset[];
907
- /**
908
- * - Long description of issue
909
- */
910
- description?: string;
911
- /**
912
- * - Title for ticket
913
- */
914
- title: string;
915
- };
916
- /** @returns {TicketContext} */
917
- declare function TicketContext(): TicketContext;
918
- type TicketContext = {
919
- /**
920
- * - Application ID related to the ticket
921
- */
922
- application_id?: string;
923
- /**
924
- * - Partner ID related to the ticket
925
- */
926
- partner_id: string;
927
- };
928
- /** @returns {TicketFeedback} */
929
- declare function TicketFeedback(): TicketFeedback;
930
- type TicketFeedback = {
931
- /**
932
- * - Unique identifier for the feedback
933
- */
934
- _id: string;
935
- /**
936
- * - Category of the ticket
937
- */
938
- category?: string;
939
- /**
940
- * - Time when the feedback was created
941
- */
942
- created_at?: string;
943
- /**
944
- * - Partner id for which ticket was raised
945
- */
946
- partner_id: string;
947
- response: FeedbackResponseItem[];
948
- /**
949
- * - Readable ticket number
950
- */
951
- ticket_id: string;
952
- /**
953
- * - Time when the feedback was last updated
954
- */
955
- updated_at?: string;
956
- /**
957
- * - User who submitted the feedback
958
- */
959
- user?: any;
960
- };
961
- /** @returns {TicketFeedbackList} */
962
- declare function TicketFeedbackList(): TicketFeedbackList;
963
- type TicketFeedbackList = {
964
- /**
965
- * - List of all ticket feedback for the ticket
966
- */
967
- items?: TicketFeedback[];
968
- };
969
- /** @returns {TicketFeedbackPayload} */
970
- declare function TicketFeedbackPayload(): TicketFeedbackPayload;
971
- type TicketFeedbackPayload = {
972
- /**
973
- * - Key-value pairs of all the form fields
974
- * and their response
975
- */
976
- form_response?: any;
977
- };
978
- /** @returns {TicketHistory} */
979
- declare function TicketHistory(): TicketHistory;
980
- type TicketHistory = {
981
- /**
982
- * - Unique identifier of the history event
983
- */
984
- _id: string;
985
- /**
986
- * - Time of creation of the history event
987
- */
988
- created_at?: string;
989
- /**
990
- * - User who created the history event
991
- */
992
- created_by?: any;
993
- created_on?: CreatedOn;
994
- /**
995
- * - Readable ticket number
996
- */
997
- ticket_id: string;
998
- /**
999
- * - Type of the history event
1000
- */
1001
- type: string;
1002
- /**
1003
- * - Time of last update of the history event
1004
- */
1005
- updated_at?: string;
1006
- /**
1007
- * - Data of the history event
1008
- */
1009
- value: any;
1010
- };
1011
- /** @returns {TicketHistoryList} */
1012
- declare function TicketHistoryList(): TicketHistoryList;
1013
- type TicketHistoryList = {
1014
- /**
1015
- * - List of ticket history
1016
- */
1017
- items?: TicketHistory[];
1018
- page?: Page;
1019
- };
1020
- /** @returns {TicketHistoryPayload} */
1021
- declare function TicketHistoryPayload(): TicketHistoryPayload;
1022
- type TicketHistoryPayload = {
1023
- type: HistoryTypeEnum;
1024
- /**
1025
- * - Details of history event
1026
- */
1027
- value: any;
1028
- };
1029
- /** @returns {TicketList} */
1030
- declare function TicketList(): TicketList;
1031
- type TicketList = {
1032
- filters?: Filter;
1033
- /**
1034
- * - List of tickets
1035
- */
1036
- items?: Ticket[];
1037
- page?: Page;
1038
- };
1039
- /** @returns {UserSchema} */
1040
- declare function UserSchema(): UserSchema;
1041
- type UserSchema = {
1042
- /**
1043
- * - Unique identifier of user
1044
- */
1045
- _id?: string;
1046
- /**
1047
- * - Type of account
1048
- */
1049
- account_type?: string;
1050
- /**
1051
- * - Is account active
1052
- */
1053
- active?: boolean;
1054
- /**
1055
- * - Time of user creation
1056
- */
1057
- created_at?: string;
1058
- debug?: Debug;
1059
- /**
1060
- * - List of email addresses
1061
- */
1062
- emails?: Email[];
1063
- /**
1064
- * - First name
1065
- */
1066
- first_name?: string;
1067
- /**
1068
- * - Gender of user
1069
- */
1070
- gender?: string;
1071
- /**
1072
- * - Denotes if user has old password hash
1073
- */
1074
- has_old_password_hash?: boolean;
1075
- /**
1076
- * - Last name
1077
- */
1078
- last_name?: string;
1079
- /**
1080
- * - List of phone numbers
1081
- */
1082
- phone_numbers?: PhoneNumber[];
1083
- /**
1084
- * - URL for profile pic
1085
- */
1086
- profile_pic_url?: string;
1087
- /**
1088
- * - Unique identifier of user
1089
- */
1090
- uid?: string;
1091
- /**
1092
- * - Last time of user details update
1093
- */
1094
- updated_at?: string;
1095
- /**
1096
- * - Username of user
1097
- */
1098
- username?: string;
1099
- };
1100
- /**
1101
- * Enum: HistoryTypeEnum Used By: Lead
1102
- *
1103
- * @returns {HistoryTypeEnum}
1104
- */
1105
- declare function HistoryTypeEnum(): HistoryTypeEnum;
1106
- type HistoryTypeEnum = "rating" | "log" | "comment";
1107
- /**
1108
- * Enum: PriorityEnum Used By: Lead
1109
- *
1110
- * @returns {PriorityEnum}
1111
- */
1112
- declare function PriorityEnum(): PriorityEnum;
1113
- type PriorityEnum = "low" | "medium" | "high" | "urgent";
1114
- /**
1115
- * Enum: TicketAssetTypeEnum Used By: Lead
1116
- *
1117
- * @returns {TicketAssetTypeEnum}
1118
- */
1119
- declare function TicketAssetTypeEnum(): TicketAssetTypeEnum;
1120
- type TicketAssetTypeEnum = "image" | "video" | "file" | "youtube" | "product" | "collection" | "brand" | "shipment" | "order";
1121
- /**
1122
- * Enum: TicketSourceEnum Used By: Lead
1123
- *
1124
- * @returns {TicketSourceEnum}
1125
- */
1126
- declare function TicketSourceEnum(): TicketSourceEnum;
1127
- type TicketSourceEnum = "platform_panel" | "sales_channel";