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

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