@gofynd/fdk-client-javascript 1.4.2-beta.2 → 1.4.2-beta.4

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