@gofynd/fdk-client-javascript 1.4.2-beta.1 → 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.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/Cart/CartApplicationModel.d.ts +1742 -1726
- package/sdk/application/Cart/CartApplicationModel.js +1497 -1481
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +1917 -1917
- package/sdk/application/Catalog/CatalogApplicationModel.js +1611 -1611
- package/sdk/application/Common/CommonApplicationModel.d.ts +235 -235
- package/sdk/application/Common/CommonApplicationModel.js +172 -172
- package/sdk/application/Communication/CommunicationApplicationModel.d.ts +72 -72
- package/sdk/application/Communication/CommunicationApplicationModel.js +64 -64
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +1614 -1614
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +1151 -1151
- package/sdk/application/Content/ContentApplicationModel.d.ts +797 -797
- package/sdk/application/Content/ContentApplicationModel.js +757 -757
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +79 -79
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +84 -84
- package/sdk/application/Lead/LeadApplicationModel.d.ts +417 -417
- package/sdk/application/Lead/LeadApplicationModel.js +301 -301
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +666 -666
- package/sdk/application/Logistic/LogisticApplicationModel.js +601 -601
- package/sdk/application/Order/OrderApplicationModel.d.ts +846 -846
- package/sdk/application/Order/OrderApplicationModel.js +822 -822
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +5 -5
- package/sdk/application/Payment/PaymentApplicationClient.js +10 -10
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +2155 -2150
- package/sdk/application/Payment/PaymentApplicationModel.js +1460 -1458
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +5 -5
- package/sdk/application/Payment/PaymentApplicationValidator.js +3 -3
- package/sdk/application/PosCart/PosCartApplicationModel.d.ts +1462 -1462
- package/sdk/application/PosCart/PosCartApplicationModel.js +1260 -1260
- package/sdk/application/Rewards/RewardsApplicationModel.d.ts +214 -214
- package/sdk/application/Rewards/RewardsApplicationModel.js +211 -211
- package/sdk/application/Share/ShareApplicationModel.d.ts +114 -114
- package/sdk/application/Share/ShareApplicationModel.js +121 -121
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +895 -895
- package/sdk/application/Theme/ThemeApplicationModel.js +684 -684
- package/sdk/application/User/UserApplicationModel.d.ts +762 -762
- package/sdk/application/User/UserApplicationModel.js +738 -738
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +63 -63
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +65 -65
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +661 -661
- package/sdk/partner/Lead/LeadPartnerModel.js +491 -491
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +223 -223
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +235 -235
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +1087 -1087
- package/sdk/partner/Theme/ThemePartnerModel.js +819 -819
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +386 -386
- package/sdk/partner/Webhook/WebhookPartnerModel.js +342 -342
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +123 -123
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +109 -109
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +801 -801
- package/sdk/platform/Billing/BillingPlatformModel.js +783 -783
- package/sdk/platform/Cart/CartPlatformModel.d.ts +3333 -3317
- package/sdk/platform/Cart/CartPlatformModel.js +2936 -2920
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1013 -1013
- package/sdk/platform/Catalog/CatalogPlatformModel.js +923 -923
- package/sdk/platform/Common/CommonPlatformModel.d.ts +255 -255
- package/sdk/platform/Common/CommonPlatformModel.js +187 -187
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +1238 -1238
- package/sdk/platform/Communication/CommunicationPlatformModel.js +1273 -1273
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +661 -661
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +692 -692
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +3198 -3198
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +2247 -2247
- package/sdk/platform/Content/ContentPlatformModel.d.ts +1833 -1833
- package/sdk/platform/Content/ContentPlatformModel.js +1837 -1837
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +245 -245
- package/sdk/platform/Discount/DiscountPlatformModel.js +248 -248
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +865 -865
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +877 -877
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +1044 -1044
- package/sdk/platform/Finance/FinancePlatformModel.js +974 -974
- package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +942 -942
- package/sdk/platform/Inventory/InventoryPlatformModel.js +1003 -1003
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +608 -608
- package/sdk/platform/Lead/LeadPlatformModel.js +465 -465
- package/sdk/platform/Order/OrderPlatformModel.d.ts +5180 -5176
- package/sdk/platform/Order/OrderPlatformModel.js +4740 -4736
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +22 -22
- package/sdk/platform/Partner/PartnerPlatformModel.js +22 -22
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +2670 -2660
- package/sdk/platform/Payment/PaymentPlatformModel.js +1831 -1827
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +204 -204
- package/sdk/platform/Rewards/RewardsPlatformModel.js +199 -199
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1505 -1507
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1532 -1536
- package/sdk/platform/Share/SharePlatformModel.d.ts +147 -147
- package/sdk/platform/Share/SharePlatformModel.js +139 -139
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +1046 -1046
- package/sdk/platform/Theme/ThemePlatformModel.js +789 -789
- package/sdk/platform/User/UserPlatformModel.d.ts +758 -758
- package/sdk/platform/User/UserPlatformModel.js +643 -643
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +439 -439
- package/sdk/platform/Webhook/WebhookPlatformModel.js +364 -364
- package/sdk/public/Billing/BillingPublicModel.d.ts +55 -55
- package/sdk/public/Billing/BillingPublicModel.js +51 -51
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +237 -237
- package/sdk/public/Configuration/ConfigurationPublicModel.js +174 -174
- package/sdk/public/Content/ContentPublicModel.d.ts +26 -26
- package/sdk/public/Content/ContentPublicModel.js +28 -28
- package/sdk/public/Inventory/InventoryPublicModel.d.ts +237 -237
- package/sdk/public/Inventory/InventoryPublicModel.js +257 -257
- package/sdk/public/Partner/PartnerPublicModel.d.ts +104 -104
- package/sdk/public/Partner/PartnerPublicModel.js +113 -113
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +87 -87
- package/sdk/public/Webhook/WebhookPublicModel.js +93 -93
|
@@ -1,332 +1,312 @@
|
|
|
1
1
|
export = LeadApplicationModel;
|
|
2
2
|
/**
|
|
3
|
-
* @typedef
|
|
4
|
-
* @property {Object}
|
|
5
|
-
* @property {
|
|
6
|
-
* @property {TicketContent} content
|
|
7
|
-
* @property {Object} [created_by] - Creator of the ticket
|
|
8
|
-
* @property {PriorityEnum} [priority]
|
|
9
|
-
* @property {string} [status] - Status of the ticket
|
|
10
|
-
* @property {string[]} [subscribers]
|
|
3
|
+
* @typedef TicketHistoryPayload
|
|
4
|
+
* @property {Object} value - Details of history event
|
|
5
|
+
* @property {HistoryTypeEnum} type
|
|
11
6
|
*/
|
|
12
7
|
/**
|
|
13
|
-
* @typedef
|
|
14
|
-
* @property {
|
|
8
|
+
* @typedef CustomFormSubmissionPayload
|
|
9
|
+
* @property {Object[]} response - Form response
|
|
10
|
+
* @property {TicketAsset[]} [attachments] - List of all attachments related to the form
|
|
15
11
|
*/
|
|
16
12
|
/**
|
|
17
|
-
* @typedef
|
|
18
|
-
* @property {string}
|
|
19
|
-
* @property {string} application_id - Application ID for form
|
|
20
|
-
* @property {CreatedOn} [created_on]
|
|
21
|
-
* @property {string} [description] - Form description that will be shown to the user
|
|
22
|
-
* @property {string} [header_image] - Form header image that will be shown to the user
|
|
23
|
-
* @property {Object[]} inputs - List of all the form fields
|
|
24
|
-
* @property {boolean} login_required - Denotes if login is required to make a
|
|
25
|
-
* form response submission
|
|
26
|
-
* @property {PollForAssignment} [poll_for_assignment]
|
|
27
|
-
* @property {Priority} priority
|
|
28
|
-
* @property {boolean} should_notify - Denotes if new response submission for
|
|
29
|
-
* the form should be notified to the assignees
|
|
30
|
-
* @property {string} slug - Slug for the form, which is to be used for accessing the form
|
|
31
|
-
* @property {SubmitButton} [submit_button]
|
|
32
|
-
* @property {string} [success_message] - Message that is to be shown on
|
|
33
|
-
* succesfull form response submission
|
|
34
|
-
* @property {string} title - Form title that will be shown to the user
|
|
13
|
+
* @typedef GetTokenForVideoRoomResponse
|
|
14
|
+
* @property {string} access_token - Access token to be used for video room
|
|
35
15
|
*/
|
|
36
16
|
/**
|
|
37
|
-
* @typedef
|
|
38
|
-
* @property {
|
|
39
|
-
* @property {Object[]} response - Form response
|
|
17
|
+
* @typedef GetParticipantsInsideVideoRoomResponse
|
|
18
|
+
* @property {Participant[]} participants - List of participants of the video room
|
|
40
19
|
*/
|
|
41
20
|
/**
|
|
42
|
-
* @typedef
|
|
43
|
-
* @property {
|
|
44
|
-
* @property {string} [
|
|
21
|
+
* @typedef Participant
|
|
22
|
+
* @property {UserSchema} [user]
|
|
23
|
+
* @property {string} [identity] - Unique identifier of participant
|
|
24
|
+
* @property {string} [status] - Status of participant
|
|
25
|
+
*/
|
|
26
|
+
/**
|
|
27
|
+
* @typedef UserSchema
|
|
28
|
+
* @property {string} [application_id]
|
|
29
|
+
* @property {string} [user_id]
|
|
30
|
+
* @property {string} [first_name]
|
|
31
|
+
* @property {Object} [meta]
|
|
32
|
+
* @property {string} [last_name]
|
|
33
|
+
* @property {PhoneNumber[]} [phone_numbers]
|
|
34
|
+
* @property {Email[]} [emails]
|
|
35
|
+
* @property {string} [gender]
|
|
36
|
+
* @property {string} [dob]
|
|
37
|
+
* @property {boolean} [active]
|
|
38
|
+
* @property {string} [profile_pic_url]
|
|
39
|
+
* @property {string} [username]
|
|
40
|
+
* @property {string} [account_type]
|
|
41
|
+
* @property {string} [_id]
|
|
42
|
+
* @property {string} [created_at]
|
|
43
|
+
* @property {string} [updated_at]
|
|
44
|
+
*/
|
|
45
|
+
/**
|
|
46
|
+
* @typedef PhoneNumber
|
|
47
|
+
* @property {boolean} [active] - Denotes if the phone number is active
|
|
48
|
+
* @property {boolean} [primary] - Denotes it's the primary phone number for the account
|
|
49
|
+
* @property {boolean} [verified] - Denotes it's a verified phone number
|
|
50
|
+
* @property {string} [phone] - Phone number
|
|
51
|
+
* @property {number} [country_code] - Country code
|
|
45
52
|
*/
|
|
46
53
|
/**
|
|
47
54
|
* @typedef Email
|
|
48
|
-
* @property {boolean} [active] - Denotes if the email is active
|
|
49
|
-
* @property {string} [email] - Email Address
|
|
50
55
|
* @property {boolean} [primary] - Denotes it's the primary email for the account
|
|
51
56
|
* @property {boolean} [verified] - Denotes it's a verified email
|
|
57
|
+
* @property {string} [email] - Email Address
|
|
58
|
+
* @property {boolean} [active] - Denotes if the email is active
|
|
52
59
|
*/
|
|
53
60
|
/**
|
|
54
|
-
* @typedef
|
|
55
|
-
* @property {
|
|
56
|
-
* @property {
|
|
57
|
-
* @property {string} [title] - Title for the feed back form
|
|
61
|
+
* @typedef Debug
|
|
62
|
+
* @property {string} [source] - Source of user
|
|
63
|
+
* @property {string} [platform] - Platform of user
|
|
58
64
|
*/
|
|
59
65
|
/**
|
|
60
|
-
* @typedef
|
|
61
|
-
* @property {
|
|
66
|
+
* @typedef SubmitCustomFormResponse
|
|
67
|
+
* @property {string} message - Success message for form submission
|
|
68
|
+
* @property {Ticket} [ticket]
|
|
62
69
|
*/
|
|
63
70
|
/**
|
|
64
|
-
* @typedef
|
|
65
|
-
* @property {string}
|
|
71
|
+
* @typedef TicketContext
|
|
72
|
+
* @property {string} [application_id] - Application ID related to the ticket
|
|
73
|
+
* @property {string} company_id - Company ID related to the ticket
|
|
66
74
|
*/
|
|
67
75
|
/**
|
|
68
|
-
* @typedef
|
|
69
|
-
* @property {string}
|
|
70
|
-
* @property {string} [status] - Status of participant
|
|
71
|
-
* @property {UserSchema} [user]
|
|
76
|
+
* @typedef CreatedOn
|
|
77
|
+
* @property {string} user_agent - Useragent details
|
|
72
78
|
*/
|
|
73
79
|
/**
|
|
74
|
-
* @typedef
|
|
75
|
-
* @property {
|
|
76
|
-
* @property {
|
|
77
|
-
* @property {
|
|
78
|
-
* @property {boolean} [primary] - Denotes it's the primary phone number for the account
|
|
79
|
-
* @property {boolean} [verified] - Denotes it's a verified phone number
|
|
80
|
+
* @typedef TicketAsset
|
|
81
|
+
* @property {string} [display] - Display text for asset
|
|
82
|
+
* @property {string} value - To be used for details
|
|
83
|
+
* @property {TicketAssetTypeEnum} type
|
|
80
84
|
*/
|
|
81
85
|
/**
|
|
82
|
-
* @typedef
|
|
83
|
-
* @property {
|
|
84
|
-
* @property {string}
|
|
85
|
-
* @property {
|
|
86
|
-
|
|
86
|
+
* @typedef TicketContent
|
|
87
|
+
* @property {string} title - Title for ticket
|
|
88
|
+
* @property {string} [description] - Long description of issue
|
|
89
|
+
* @property {TicketAsset[]} [attachments] - List of all attachments related to the ticket
|
|
90
|
+
*/
|
|
91
|
+
/**
|
|
92
|
+
* @typedef AddTicketPayload
|
|
93
|
+
* @property {Object} [created_by] - Creator of the ticket
|
|
94
|
+
* @property {string} [status] - Status of the ticket
|
|
95
|
+
* @property {PriorityEnum} [priority]
|
|
96
|
+
* @property {string} category - Category of the ticket
|
|
97
|
+
* @property {TicketContent} content
|
|
98
|
+
* @property {Object} [_custom_json] - Optional custom data that needs to be sent
|
|
99
|
+
* @property {string[]} [subscribers]
|
|
87
100
|
*/
|
|
88
101
|
/**
|
|
89
102
|
* @typedef Priority
|
|
90
|
-
* @property {string} color - Color for priority
|
|
91
|
-
* @property {string} display - Display text for priority
|
|
92
103
|
* @property {PriorityEnum} key
|
|
104
|
+
* @property {string} display - Display text for priority
|
|
105
|
+
* @property {string} color - Color for priority
|
|
93
106
|
*/
|
|
94
107
|
/**
|
|
95
108
|
* @typedef Status
|
|
96
|
-
* @property {string} color - Color for status
|
|
97
|
-
* @property {string} display - Display text for status
|
|
98
109
|
* @property {string} key - Key for status
|
|
110
|
+
* @property {string} display - Display text for status
|
|
111
|
+
* @property {string} color - Color for status
|
|
99
112
|
*/
|
|
100
113
|
/**
|
|
101
114
|
* @typedef SubmitButton
|
|
102
|
-
* @property {string} background_color - Color for submit button
|
|
103
115
|
* @property {string} title - Title for submit button
|
|
104
116
|
* @property {string} title_color - Title color submit button
|
|
117
|
+
* @property {string} background_color - Color for submit button
|
|
105
118
|
*/
|
|
106
119
|
/**
|
|
107
|
-
* @typedef
|
|
108
|
-
* @property {
|
|
109
|
-
* @property {
|
|
120
|
+
* @typedef PollForAssignment
|
|
121
|
+
* @property {number} duration - Duration for polling of staff
|
|
122
|
+
* @property {string} message - Message for polling
|
|
123
|
+
* @property {string} success_message - Message for successful polling
|
|
124
|
+
* @property {string} failure_message - Message if polling failed
|
|
110
125
|
*/
|
|
111
126
|
/**
|
|
112
|
-
* @typedef
|
|
113
|
-
* @property {
|
|
114
|
-
* @property {string}
|
|
115
|
-
* @property {
|
|
116
|
-
* @property {
|
|
117
|
-
* @property {
|
|
118
|
-
* @property {TicketContext} [context]
|
|
119
|
-
* @property {string} [created_at] - Time when the ticket was created
|
|
120
|
-
* @property {Object} [created_by] - User details of ticket creator
|
|
121
|
-
* @property {CreatedOn} [created_on]
|
|
122
|
-
* @property {Object} [integration] - Integration type and its details of the ticket
|
|
123
|
-
* @property {boolean} [is_feedback_pending] - Denotes if feedback submission is
|
|
124
|
-
* pending for the ticket
|
|
127
|
+
* @typedef CustomForm
|
|
128
|
+
* @property {string} application_id - Application ID for form
|
|
129
|
+
* @property {string} slug - Slug for the form, which is to be used for accessing the form
|
|
130
|
+
* @property {string} [header_image] - Form header image that will be shown to the user
|
|
131
|
+
* @property {string} title - Form title that will be shown to the user
|
|
132
|
+
* @property {string} [description] - Form description that will be shown to the user
|
|
125
133
|
* @property {Priority} priority
|
|
126
|
-
* @property {
|
|
127
|
-
*
|
|
128
|
-
* @property {
|
|
129
|
-
*
|
|
130
|
-
* @property {string} [
|
|
131
|
-
*
|
|
132
|
-
* @property {
|
|
134
|
+
* @property {boolean} login_required - Denotes if login is required to make a
|
|
135
|
+
* form response submission
|
|
136
|
+
* @property {boolean} should_notify - Denotes if new response submission for
|
|
137
|
+
* the form should be notified to the assignees
|
|
138
|
+
* @property {string} [success_message] - Message that is to be shown on
|
|
139
|
+
* succesfull form response submission
|
|
140
|
+
* @property {SubmitButton} [submit_button]
|
|
141
|
+
* @property {Object[]} inputs - List of all the form fields
|
|
142
|
+
* @property {CreatedOn} [created_on]
|
|
143
|
+
* @property {PollForAssignment} [poll_for_assignment]
|
|
144
|
+
* @property {string} _id - Unique identifier for the form
|
|
133
145
|
*/
|
|
134
146
|
/**
|
|
135
|
-
* @typedef
|
|
136
|
-
* @property {
|
|
137
|
-
* @property {
|
|
138
|
-
* @property {
|
|
147
|
+
* @typedef FeedbackForm
|
|
148
|
+
* @property {Object} [inputs] - Input details for the feed back form
|
|
149
|
+
* @property {string} [title] - Title for the feed back form
|
|
150
|
+
* @property {Object} [timestamps] - Gives details of category releted data
|
|
139
151
|
*/
|
|
140
152
|
/**
|
|
141
153
|
* @typedef TicketCategory
|
|
142
154
|
* @property {string} display - Category display value identifier
|
|
143
|
-
* @property {FeedbackForm} [feedback_form]
|
|
144
|
-
* @property {number} [group_id] - Group id of category releted data
|
|
145
155
|
* @property {string} key - Category key value identifier
|
|
146
156
|
* @property {TicketCategory} [sub_categories]
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
* @typedef TicketContent
|
|
150
|
-
* @property {TicketAsset[]} [attachments] - List of all attachments related to the ticket
|
|
151
|
-
* @property {string} [description] - Long description of issue
|
|
152
|
-
* @property {string} title - Title for ticket
|
|
153
|
-
*/
|
|
154
|
-
/**
|
|
155
|
-
* @typedef TicketContext
|
|
156
|
-
* @property {string} [application_id] - Application ID related to the ticket
|
|
157
|
-
* @property {string} company_id - Company ID related to the ticket
|
|
157
|
+
* @property {number} [group_id] - Group id of category releted data
|
|
158
|
+
* @property {FeedbackForm} [feedback_form]
|
|
158
159
|
*/
|
|
159
160
|
/**
|
|
160
161
|
* @typedef TicketHistory
|
|
161
|
-
* @property {string} _id - Unique identifier of the history event
|
|
162
|
-
* @property {string} [created_at] - Time of creation of the history event
|
|
163
|
-
* @property {Object} [created_by] - User who created the history event
|
|
164
|
-
* @property {CreatedOn} [created_on]
|
|
165
|
-
* @property {string} ticket_id - Readable ticket number
|
|
166
162
|
* @property {string} type - Type of the history event
|
|
167
|
-
* @property {string} [updated_at] - Time of last update of the history event
|
|
168
163
|
* @property {Object} value - Data of the history event
|
|
164
|
+
* @property {string} ticket_id - Readable ticket number
|
|
165
|
+
* @property {CreatedOn} [created_on]
|
|
166
|
+
* @property {Object} [created_by] - User who created the history event
|
|
167
|
+
* @property {string} _id - Unique identifier of the history event
|
|
168
|
+
* @property {string} [updated_at] - Time of last update of the history event
|
|
169
|
+
* @property {string} [created_at] - Time of creation of the history event
|
|
169
170
|
*/
|
|
170
171
|
/**
|
|
171
|
-
* @typedef
|
|
172
|
-
* @property {
|
|
173
|
-
* @property {
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
* @
|
|
177
|
-
* @property {
|
|
178
|
-
* @property {string} [
|
|
179
|
-
* @property {
|
|
180
|
-
* @property {
|
|
181
|
-
* @property {
|
|
182
|
-
* @property {
|
|
183
|
-
* @property {
|
|
184
|
-
* @property {string} [
|
|
185
|
-
* @property {
|
|
186
|
-
* @property {
|
|
187
|
-
*
|
|
188
|
-
* @property {
|
|
189
|
-
* @property {string}
|
|
190
|
-
* @property {string} [updated_at]
|
|
191
|
-
* @property {string} [
|
|
192
|
-
* @property {string} [username]
|
|
172
|
+
* @typedef Ticket
|
|
173
|
+
* @property {TicketContext} [context]
|
|
174
|
+
* @property {CreatedOn} [created_on]
|
|
175
|
+
* @property {string} [response_id] - Details of company and application
|
|
176
|
+
* realated to the ticket
|
|
177
|
+
* @property {TicketContent} [content]
|
|
178
|
+
* @property {TicketCategory} category
|
|
179
|
+
* @property {string} [sub_category] - Sub-category assigned to the ticket
|
|
180
|
+
* @property {TicketSourceEnum} source
|
|
181
|
+
* @property {Status} status
|
|
182
|
+
* @property {Priority} priority
|
|
183
|
+
* @property {Object} [created_by] - User details of ticket creator
|
|
184
|
+
* @property {Object} [assigned_to] - Details of support staff to whom ticket is assigned
|
|
185
|
+
* @property {string[]} [tags] - Tags relevant to ticket
|
|
186
|
+
* @property {Object} [_custom_json] - Custom json relevant to the ticket
|
|
187
|
+
* @property {boolean} [is_feedback_pending] - Denotes if feedback submission is
|
|
188
|
+
* pending for the ticket
|
|
189
|
+
* @property {Object} [integration] - Integration type and its details of the ticket
|
|
190
|
+
* @property {string} _id - Unique identifier for the ticket
|
|
191
|
+
* @property {string} [updated_at] - Time when the ticket was last updated
|
|
192
|
+
* @property {string} [created_at] - Time when the ticket was created
|
|
193
193
|
*/
|
|
194
|
-
/** @typedef {"rating" | "log" | "comment" | "thread"} HistoryTypeEnum */
|
|
195
194
|
/** @typedef {"low" | "medium" | "high" | "urgent"} PriorityEnum */
|
|
195
|
+
/** @typedef {"rating" | "log" | "comment" | "thread"} HistoryTypeEnum */
|
|
196
196
|
/**
|
|
197
197
|
* @typedef {| "image"
|
|
198
198
|
* | "video"
|
|
199
199
|
* | "file"
|
|
200
200
|
* | "youtube"
|
|
201
|
-
* | "product"
|
|
202
|
-
* | "collection"
|
|
203
|
-
* | "brand"
|
|
204
|
-
* | "shipment"
|
|
205
|
-
* | "order"} TicketAssetTypeEnum
|
|
206
|
-
*/
|
|
207
|
-
/** @typedef {"platform_panel" | "sales_channel"} TicketSourceEnum */
|
|
208
|
-
declare class LeadApplicationModel {
|
|
209
|
-
}
|
|
210
|
-
declare namespace LeadApplicationModel {
|
|
211
|
-
export {
|
|
212
|
-
}
|
|
213
|
-
/** @returns {
|
|
214
|
-
declare function
|
|
215
|
-
type
|
|
216
|
-
/**
|
|
217
|
-
* - Optional custom data that needs to be sent
|
|
218
|
-
*/
|
|
219
|
-
_custom_json?: any;
|
|
220
|
-
/**
|
|
221
|
-
* - Category of the ticket
|
|
222
|
-
*/
|
|
223
|
-
category: string;
|
|
224
|
-
content: TicketContent;
|
|
225
|
-
/**
|
|
226
|
-
* - Creator of the ticket
|
|
227
|
-
*/
|
|
228
|
-
created_by?: any;
|
|
229
|
-
priority?: PriorityEnum;
|
|
230
|
-
/**
|
|
231
|
-
* - Status of the ticket
|
|
232
|
-
*/
|
|
233
|
-
status?: string;
|
|
234
|
-
subscribers?: string[];
|
|
235
|
-
};
|
|
236
|
-
/** @returns {CreatedOn} */
|
|
237
|
-
declare function CreatedOn(): CreatedOn;
|
|
238
|
-
type CreatedOn = {
|
|
239
|
-
/**
|
|
240
|
-
* - Useragent details
|
|
241
|
-
*/
|
|
242
|
-
user_agent: string;
|
|
243
|
-
};
|
|
244
|
-
/** @returns {CustomForm} */
|
|
245
|
-
declare function CustomForm(): CustomForm;
|
|
246
|
-
type CustomForm = {
|
|
247
|
-
/**
|
|
248
|
-
* - Unique identifier for the form
|
|
249
|
-
*/
|
|
250
|
-
_id: string;
|
|
251
|
-
/**
|
|
252
|
-
* - Application ID for form
|
|
253
|
-
*/
|
|
254
|
-
application_id: string;
|
|
255
|
-
created_on?: CreatedOn;
|
|
201
|
+
* | "product"
|
|
202
|
+
* | "collection"
|
|
203
|
+
* | "brand"
|
|
204
|
+
* | "shipment"
|
|
205
|
+
* | "order"} TicketAssetTypeEnum
|
|
206
|
+
*/
|
|
207
|
+
/** @typedef {"platform_panel" | "sales_channel"} TicketSourceEnum */
|
|
208
|
+
declare class LeadApplicationModel {
|
|
209
|
+
}
|
|
210
|
+
declare namespace LeadApplicationModel {
|
|
211
|
+
export { TicketHistoryPayload, CustomFormSubmissionPayload, GetTokenForVideoRoomResponse, GetParticipantsInsideVideoRoomResponse, Participant, UserSchema, PhoneNumber, Email, Debug, SubmitCustomFormResponse, TicketContext, CreatedOn, TicketAsset, TicketContent, AddTicketPayload, Priority, Status, SubmitButton, PollForAssignment, CustomForm, FeedbackForm, TicketCategory, TicketHistory, Ticket, PriorityEnum, HistoryTypeEnum, TicketAssetTypeEnum, TicketSourceEnum };
|
|
212
|
+
}
|
|
213
|
+
/** @returns {TicketHistoryPayload} */
|
|
214
|
+
declare function TicketHistoryPayload(): TicketHistoryPayload;
|
|
215
|
+
type TicketHistoryPayload = {
|
|
256
216
|
/**
|
|
257
|
-
* -
|
|
217
|
+
* - Details of history event
|
|
258
218
|
*/
|
|
259
|
-
|
|
219
|
+
value: any;
|
|
220
|
+
type: HistoryTypeEnum;
|
|
221
|
+
};
|
|
222
|
+
/** @returns {CustomFormSubmissionPayload} */
|
|
223
|
+
declare function CustomFormSubmissionPayload(): CustomFormSubmissionPayload;
|
|
224
|
+
type CustomFormSubmissionPayload = {
|
|
260
225
|
/**
|
|
261
|
-
* - Form
|
|
226
|
+
* - Form response
|
|
262
227
|
*/
|
|
263
|
-
|
|
228
|
+
response: any[];
|
|
264
229
|
/**
|
|
265
|
-
* - List of all the form
|
|
230
|
+
* - List of all attachments related to the form
|
|
266
231
|
*/
|
|
267
|
-
|
|
232
|
+
attachments?: TicketAsset[];
|
|
233
|
+
};
|
|
234
|
+
/** @returns {GetTokenForVideoRoomResponse} */
|
|
235
|
+
declare function GetTokenForVideoRoomResponse(): GetTokenForVideoRoomResponse;
|
|
236
|
+
type GetTokenForVideoRoomResponse = {
|
|
268
237
|
/**
|
|
269
|
-
* -
|
|
270
|
-
* form response submission
|
|
238
|
+
* - Access token to be used for video room
|
|
271
239
|
*/
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
240
|
+
access_token: string;
|
|
241
|
+
};
|
|
242
|
+
/** @returns {GetParticipantsInsideVideoRoomResponse} */
|
|
243
|
+
declare function GetParticipantsInsideVideoRoomResponse(): GetParticipantsInsideVideoRoomResponse;
|
|
244
|
+
type GetParticipantsInsideVideoRoomResponse = {
|
|
275
245
|
/**
|
|
276
|
-
* -
|
|
277
|
-
* the form should be notified to the assignees
|
|
246
|
+
* - List of participants of the video room
|
|
278
247
|
*/
|
|
279
|
-
|
|
248
|
+
participants: Participant[];
|
|
249
|
+
};
|
|
250
|
+
/** @returns {Participant} */
|
|
251
|
+
declare function Participant(): Participant;
|
|
252
|
+
type Participant = {
|
|
253
|
+
user?: UserSchema;
|
|
280
254
|
/**
|
|
281
|
-
* -
|
|
255
|
+
* - Unique identifier of participant
|
|
282
256
|
*/
|
|
283
|
-
|
|
284
|
-
submit_button?: SubmitButton;
|
|
257
|
+
identity?: string;
|
|
285
258
|
/**
|
|
286
|
-
* -
|
|
287
|
-
* succesfull form response submission
|
|
259
|
+
* - Status of participant
|
|
288
260
|
*/
|
|
289
|
-
|
|
261
|
+
status?: string;
|
|
262
|
+
};
|
|
263
|
+
/** @returns {UserSchema} */
|
|
264
|
+
declare function UserSchema(): UserSchema;
|
|
265
|
+
type UserSchema = {
|
|
266
|
+
application_id?: string;
|
|
267
|
+
user_id?: string;
|
|
268
|
+
first_name?: string;
|
|
269
|
+
meta?: any;
|
|
270
|
+
last_name?: string;
|
|
271
|
+
phone_numbers?: PhoneNumber[];
|
|
272
|
+
emails?: Email[];
|
|
273
|
+
gender?: string;
|
|
274
|
+
dob?: string;
|
|
275
|
+
active?: boolean;
|
|
276
|
+
profile_pic_url?: string;
|
|
277
|
+
username?: string;
|
|
278
|
+
account_type?: string;
|
|
279
|
+
_id?: string;
|
|
280
|
+
created_at?: string;
|
|
281
|
+
updated_at?: string;
|
|
282
|
+
};
|
|
283
|
+
/** @returns {PhoneNumber} */
|
|
284
|
+
declare function PhoneNumber(): PhoneNumber;
|
|
285
|
+
type PhoneNumber = {
|
|
290
286
|
/**
|
|
291
|
-
* -
|
|
287
|
+
* - Denotes if the phone number is active
|
|
292
288
|
*/
|
|
293
|
-
|
|
294
|
-
};
|
|
295
|
-
/** @returns {CustomFormSubmissionPayload} */
|
|
296
|
-
declare function CustomFormSubmissionPayload(): CustomFormSubmissionPayload;
|
|
297
|
-
type CustomFormSubmissionPayload = {
|
|
289
|
+
active?: boolean;
|
|
298
290
|
/**
|
|
299
|
-
* -
|
|
291
|
+
* - Denotes it's the primary phone number for the account
|
|
300
292
|
*/
|
|
301
|
-
|
|
293
|
+
primary?: boolean;
|
|
302
294
|
/**
|
|
303
|
-
* -
|
|
295
|
+
* - Denotes it's a verified phone number
|
|
304
296
|
*/
|
|
305
|
-
|
|
306
|
-
};
|
|
307
|
-
/** @returns {Debug} */
|
|
308
|
-
declare function Debug(): Debug;
|
|
309
|
-
type Debug = {
|
|
297
|
+
verified?: boolean;
|
|
310
298
|
/**
|
|
311
|
-
* -
|
|
299
|
+
* - Phone number
|
|
312
300
|
*/
|
|
313
|
-
|
|
301
|
+
phone?: string;
|
|
314
302
|
/**
|
|
315
|
-
* -
|
|
303
|
+
* - Country code
|
|
316
304
|
*/
|
|
317
|
-
|
|
305
|
+
country_code?: number;
|
|
318
306
|
};
|
|
319
307
|
/** @returns {Email} */
|
|
320
308
|
declare function Email(): Email;
|
|
321
309
|
type Email = {
|
|
322
|
-
/**
|
|
323
|
-
* - Denotes if the email is active
|
|
324
|
-
*/
|
|
325
|
-
active?: boolean;
|
|
326
|
-
/**
|
|
327
|
-
* - Email Address
|
|
328
|
-
*/
|
|
329
|
-
email?: string;
|
|
330
310
|
/**
|
|
331
311
|
* - Denotes it's the primary email for the account
|
|
332
312
|
*/
|
|
@@ -335,132 +315,140 @@ type Email = {
|
|
|
335
315
|
* - Denotes it's a verified email
|
|
336
316
|
*/
|
|
337
317
|
verified?: boolean;
|
|
338
|
-
};
|
|
339
|
-
/** @returns {FeedbackForm} */
|
|
340
|
-
declare function FeedbackForm(): FeedbackForm;
|
|
341
|
-
type FeedbackForm = {
|
|
342
318
|
/**
|
|
343
|
-
* -
|
|
319
|
+
* - Email Address
|
|
344
320
|
*/
|
|
345
|
-
|
|
321
|
+
email?: string;
|
|
346
322
|
/**
|
|
347
|
-
* -
|
|
323
|
+
* - Denotes if the email is active
|
|
348
324
|
*/
|
|
349
|
-
|
|
325
|
+
active?: boolean;
|
|
326
|
+
};
|
|
327
|
+
/** @returns {Debug} */
|
|
328
|
+
declare function Debug(): Debug;
|
|
329
|
+
type Debug = {
|
|
350
330
|
/**
|
|
351
|
-
* -
|
|
331
|
+
* - Source of user
|
|
352
332
|
*/
|
|
353
|
-
|
|
354
|
-
};
|
|
355
|
-
/** @returns {GetParticipantsInsideVideoRoomResponse} */
|
|
356
|
-
declare function GetParticipantsInsideVideoRoomResponse(): GetParticipantsInsideVideoRoomResponse;
|
|
357
|
-
type GetParticipantsInsideVideoRoomResponse = {
|
|
333
|
+
source?: string;
|
|
358
334
|
/**
|
|
359
|
-
* -
|
|
335
|
+
* - Platform of user
|
|
360
336
|
*/
|
|
361
|
-
|
|
337
|
+
platform?: string;
|
|
362
338
|
};
|
|
363
|
-
/** @returns {
|
|
364
|
-
declare function
|
|
365
|
-
type
|
|
339
|
+
/** @returns {SubmitCustomFormResponse} */
|
|
340
|
+
declare function SubmitCustomFormResponse(): SubmitCustomFormResponse;
|
|
341
|
+
type SubmitCustomFormResponse = {
|
|
366
342
|
/**
|
|
367
|
-
* -
|
|
343
|
+
* - Success message for form submission
|
|
368
344
|
*/
|
|
369
|
-
|
|
345
|
+
message: string;
|
|
346
|
+
ticket?: Ticket;
|
|
370
347
|
};
|
|
371
|
-
/** @returns {
|
|
372
|
-
declare function
|
|
373
|
-
type
|
|
348
|
+
/** @returns {TicketContext} */
|
|
349
|
+
declare function TicketContext(): TicketContext;
|
|
350
|
+
type TicketContext = {
|
|
374
351
|
/**
|
|
375
|
-
* -
|
|
352
|
+
* - Application ID related to the ticket
|
|
376
353
|
*/
|
|
377
|
-
|
|
354
|
+
application_id?: string;
|
|
378
355
|
/**
|
|
379
|
-
* -
|
|
356
|
+
* - Company ID related to the ticket
|
|
380
357
|
*/
|
|
381
|
-
|
|
382
|
-
user?: UserSchema;
|
|
358
|
+
company_id: string;
|
|
383
359
|
};
|
|
384
|
-
/** @returns {
|
|
385
|
-
declare function
|
|
386
|
-
type
|
|
360
|
+
/** @returns {CreatedOn} */
|
|
361
|
+
declare function CreatedOn(): CreatedOn;
|
|
362
|
+
type CreatedOn = {
|
|
387
363
|
/**
|
|
388
|
-
* -
|
|
364
|
+
* - Useragent details
|
|
389
365
|
*/
|
|
390
|
-
|
|
366
|
+
user_agent: string;
|
|
367
|
+
};
|
|
368
|
+
/** @returns {TicketAsset} */
|
|
369
|
+
declare function TicketAsset(): TicketAsset;
|
|
370
|
+
type TicketAsset = {
|
|
391
371
|
/**
|
|
392
|
-
* -
|
|
372
|
+
* - Display text for asset
|
|
393
373
|
*/
|
|
394
|
-
|
|
374
|
+
display?: string;
|
|
395
375
|
/**
|
|
396
|
-
* -
|
|
376
|
+
* - To be used for details
|
|
397
377
|
*/
|
|
398
|
-
|
|
378
|
+
value: string;
|
|
379
|
+
type: TicketAssetTypeEnum;
|
|
380
|
+
};
|
|
381
|
+
/** @returns {TicketContent} */
|
|
382
|
+
declare function TicketContent(): TicketContent;
|
|
383
|
+
type TicketContent = {
|
|
399
384
|
/**
|
|
400
|
-
* -
|
|
385
|
+
* - Title for ticket
|
|
401
386
|
*/
|
|
402
|
-
|
|
387
|
+
title: string;
|
|
403
388
|
/**
|
|
404
|
-
* -
|
|
389
|
+
* - Long description of issue
|
|
405
390
|
*/
|
|
406
|
-
|
|
391
|
+
description?: string;
|
|
392
|
+
/**
|
|
393
|
+
* - List of all attachments related to the ticket
|
|
394
|
+
*/
|
|
395
|
+
attachments?: TicketAsset[];
|
|
407
396
|
};
|
|
408
|
-
/** @returns {
|
|
409
|
-
declare function
|
|
410
|
-
type
|
|
397
|
+
/** @returns {AddTicketPayload} */
|
|
398
|
+
declare function AddTicketPayload(): AddTicketPayload;
|
|
399
|
+
type AddTicketPayload = {
|
|
411
400
|
/**
|
|
412
|
-
* -
|
|
401
|
+
* - Creator of the ticket
|
|
413
402
|
*/
|
|
414
|
-
|
|
403
|
+
created_by?: any;
|
|
415
404
|
/**
|
|
416
|
-
* -
|
|
405
|
+
* - Status of the ticket
|
|
417
406
|
*/
|
|
418
|
-
|
|
407
|
+
status?: string;
|
|
408
|
+
priority?: PriorityEnum;
|
|
419
409
|
/**
|
|
420
|
-
* -
|
|
410
|
+
* - Category of the ticket
|
|
421
411
|
*/
|
|
422
|
-
|
|
412
|
+
category: string;
|
|
413
|
+
content: TicketContent;
|
|
423
414
|
/**
|
|
424
|
-
* -
|
|
415
|
+
* - Optional custom data that needs to be sent
|
|
425
416
|
*/
|
|
426
|
-
|
|
417
|
+
_custom_json?: any;
|
|
418
|
+
subscribers?: string[];
|
|
427
419
|
};
|
|
428
420
|
/** @returns {Priority} */
|
|
429
421
|
declare function Priority(): Priority;
|
|
430
422
|
type Priority = {
|
|
431
|
-
|
|
432
|
-
* - Color for priority
|
|
433
|
-
*/
|
|
434
|
-
color: string;
|
|
423
|
+
key: PriorityEnum;
|
|
435
424
|
/**
|
|
436
425
|
* - Display text for priority
|
|
437
426
|
*/
|
|
438
427
|
display: string;
|
|
439
|
-
|
|
428
|
+
/**
|
|
429
|
+
* - Color for priority
|
|
430
|
+
*/
|
|
431
|
+
color: string;
|
|
440
432
|
};
|
|
441
433
|
/** @returns {Status} */
|
|
442
434
|
declare function Status(): Status;
|
|
443
435
|
type Status = {
|
|
444
436
|
/**
|
|
445
|
-
* -
|
|
437
|
+
* - Key for status
|
|
446
438
|
*/
|
|
447
|
-
|
|
439
|
+
key: string;
|
|
448
440
|
/**
|
|
449
441
|
* - Display text for status
|
|
450
442
|
*/
|
|
451
443
|
display: string;
|
|
452
444
|
/**
|
|
453
|
-
* -
|
|
445
|
+
* - Color for status
|
|
454
446
|
*/
|
|
455
|
-
|
|
447
|
+
color: string;
|
|
456
448
|
};
|
|
457
449
|
/** @returns {SubmitButton} */
|
|
458
450
|
declare function SubmitButton(): SubmitButton;
|
|
459
451
|
type SubmitButton = {
|
|
460
|
-
/**
|
|
461
|
-
* - Color for submit button
|
|
462
|
-
*/
|
|
463
|
-
background_color: string;
|
|
464
452
|
/**
|
|
465
453
|
* - Title for submit button
|
|
466
454
|
*/
|
|
@@ -469,85 +457,97 @@ type SubmitButton = {
|
|
|
469
457
|
* - Title color submit button
|
|
470
458
|
*/
|
|
471
459
|
title_color: string;
|
|
460
|
+
/**
|
|
461
|
+
* - Color for submit button
|
|
462
|
+
*/
|
|
463
|
+
background_color: string;
|
|
472
464
|
};
|
|
473
|
-
/** @returns {
|
|
474
|
-
declare function
|
|
475
|
-
type
|
|
465
|
+
/** @returns {PollForAssignment} */
|
|
466
|
+
declare function PollForAssignment(): PollForAssignment;
|
|
467
|
+
type PollForAssignment = {
|
|
476
468
|
/**
|
|
477
|
-
* -
|
|
469
|
+
* - Duration for polling of staff
|
|
470
|
+
*/
|
|
471
|
+
duration: number;
|
|
472
|
+
/**
|
|
473
|
+
* - Message for polling
|
|
478
474
|
*/
|
|
479
475
|
message: string;
|
|
480
|
-
ticket?: Ticket;
|
|
481
|
-
};
|
|
482
|
-
/** @returns {Ticket} */
|
|
483
|
-
declare function Ticket(): Ticket;
|
|
484
|
-
type Ticket = {
|
|
485
476
|
/**
|
|
486
|
-
* -
|
|
477
|
+
* - Message for successful polling
|
|
487
478
|
*/
|
|
488
|
-
|
|
479
|
+
success_message: string;
|
|
489
480
|
/**
|
|
490
|
-
* -
|
|
481
|
+
* - Message if polling failed
|
|
491
482
|
*/
|
|
492
|
-
|
|
483
|
+
failure_message: string;
|
|
484
|
+
};
|
|
485
|
+
/** @returns {CustomForm} */
|
|
486
|
+
declare function CustomForm(): CustomForm;
|
|
487
|
+
type CustomForm = {
|
|
493
488
|
/**
|
|
494
|
-
* -
|
|
489
|
+
* - Application ID for form
|
|
495
490
|
*/
|
|
496
|
-
|
|
497
|
-
category: TicketCategory;
|
|
498
|
-
content?: TicketContent;
|
|
499
|
-
context?: TicketContext;
|
|
491
|
+
application_id: string;
|
|
500
492
|
/**
|
|
501
|
-
* -
|
|
493
|
+
* - Slug for the form, which is to be used for accessing the form
|
|
502
494
|
*/
|
|
503
|
-
|
|
495
|
+
slug: string;
|
|
504
496
|
/**
|
|
505
|
-
* -
|
|
497
|
+
* - Form header image that will be shown to the user
|
|
506
498
|
*/
|
|
507
|
-
|
|
508
|
-
created_on?: CreatedOn;
|
|
499
|
+
header_image?: string;
|
|
509
500
|
/**
|
|
510
|
-
* -
|
|
501
|
+
* - Form title that will be shown to the user
|
|
511
502
|
*/
|
|
512
|
-
|
|
503
|
+
title: string;
|
|
513
504
|
/**
|
|
514
|
-
* -
|
|
515
|
-
* pending for the ticket
|
|
505
|
+
* - Form description that will be shown to the user
|
|
516
506
|
*/
|
|
517
|
-
|
|
507
|
+
description?: string;
|
|
518
508
|
priority: Priority;
|
|
519
509
|
/**
|
|
520
|
-
* -
|
|
521
|
-
*
|
|
510
|
+
* - Denotes if login is required to make a
|
|
511
|
+
* form response submission
|
|
522
512
|
*/
|
|
523
|
-
|
|
524
|
-
source: TicketSourceEnum;
|
|
525
|
-
status: Status;
|
|
513
|
+
login_required: boolean;
|
|
526
514
|
/**
|
|
527
|
-
* -
|
|
515
|
+
* - Denotes if new response submission for
|
|
516
|
+
* the form should be notified to the assignees
|
|
528
517
|
*/
|
|
529
|
-
|
|
518
|
+
should_notify: boolean;
|
|
530
519
|
/**
|
|
531
|
-
* -
|
|
520
|
+
* - Message that is to be shown on
|
|
521
|
+
* succesfull form response submission
|
|
532
522
|
*/
|
|
533
|
-
|
|
523
|
+
success_message?: string;
|
|
524
|
+
submit_button?: SubmitButton;
|
|
534
525
|
/**
|
|
535
|
-
* -
|
|
526
|
+
* - List of all the form fields
|
|
536
527
|
*/
|
|
537
|
-
|
|
528
|
+
inputs: any[];
|
|
529
|
+
created_on?: CreatedOn;
|
|
530
|
+
poll_for_assignment?: PollForAssignment;
|
|
531
|
+
/**
|
|
532
|
+
* - Unique identifier for the form
|
|
533
|
+
*/
|
|
534
|
+
_id: string;
|
|
538
535
|
};
|
|
539
|
-
/** @returns {
|
|
540
|
-
declare function
|
|
541
|
-
type
|
|
536
|
+
/** @returns {FeedbackForm} */
|
|
537
|
+
declare function FeedbackForm(): FeedbackForm;
|
|
538
|
+
type FeedbackForm = {
|
|
542
539
|
/**
|
|
543
|
-
* -
|
|
540
|
+
* - Input details for the feed back form
|
|
544
541
|
*/
|
|
545
|
-
|
|
546
|
-
type: TicketAssetTypeEnum;
|
|
542
|
+
inputs?: any;
|
|
547
543
|
/**
|
|
548
|
-
* -
|
|
544
|
+
* - Title for the feed back form
|
|
549
545
|
*/
|
|
550
|
-
|
|
546
|
+
title?: string;
|
|
547
|
+
/**
|
|
548
|
+
* - Gives details of category releted data
|
|
549
|
+
*/
|
|
550
|
+
timestamps?: any;
|
|
551
551
|
};
|
|
552
552
|
/** @returns {TicketCategory} */
|
|
553
553
|
declare function TicketCategory(): TicketCategory;
|
|
@@ -556,114 +556,107 @@ type TicketCategory = {
|
|
|
556
556
|
* - Category display value identifier
|
|
557
557
|
*/
|
|
558
558
|
display: string;
|
|
559
|
-
feedback_form?: FeedbackForm;
|
|
560
|
-
/**
|
|
561
|
-
* - Group id of category releted data
|
|
562
|
-
*/
|
|
563
|
-
group_id?: number;
|
|
564
559
|
/**
|
|
565
560
|
* - Category key value identifier
|
|
566
561
|
*/
|
|
567
562
|
key: string;
|
|
568
563
|
sub_categories?: TicketCategory;
|
|
569
|
-
};
|
|
570
|
-
/** @returns {TicketContent} */
|
|
571
|
-
declare function TicketContent(): TicketContent;
|
|
572
|
-
type TicketContent = {
|
|
573
564
|
/**
|
|
574
|
-
* -
|
|
565
|
+
* - Group id of category releted data
|
|
575
566
|
*/
|
|
576
|
-
|
|
567
|
+
group_id?: number;
|
|
568
|
+
feedback_form?: FeedbackForm;
|
|
569
|
+
};
|
|
570
|
+
/** @returns {TicketHistory} */
|
|
571
|
+
declare function TicketHistory(): TicketHistory;
|
|
572
|
+
type TicketHistory = {
|
|
577
573
|
/**
|
|
578
|
-
* -
|
|
574
|
+
* - Type of the history event
|
|
579
575
|
*/
|
|
580
|
-
|
|
576
|
+
type: string;
|
|
581
577
|
/**
|
|
582
|
-
* -
|
|
578
|
+
* - Data of the history event
|
|
583
579
|
*/
|
|
584
|
-
|
|
585
|
-
};
|
|
586
|
-
/** @returns {TicketContext} */
|
|
587
|
-
declare function TicketContext(): TicketContext;
|
|
588
|
-
type TicketContext = {
|
|
580
|
+
value: any;
|
|
589
581
|
/**
|
|
590
|
-
* -
|
|
582
|
+
* - Readable ticket number
|
|
591
583
|
*/
|
|
592
|
-
|
|
584
|
+
ticket_id: string;
|
|
585
|
+
created_on?: CreatedOn;
|
|
593
586
|
/**
|
|
594
|
-
* -
|
|
587
|
+
* - User who created the history event
|
|
595
588
|
*/
|
|
596
|
-
|
|
597
|
-
};
|
|
598
|
-
/** @returns {TicketHistory} */
|
|
599
|
-
declare function TicketHistory(): TicketHistory;
|
|
600
|
-
type TicketHistory = {
|
|
589
|
+
created_by?: any;
|
|
601
590
|
/**
|
|
602
591
|
* - Unique identifier of the history event
|
|
603
592
|
*/
|
|
604
593
|
_id: string;
|
|
594
|
+
/**
|
|
595
|
+
* - Time of last update of the history event
|
|
596
|
+
*/
|
|
597
|
+
updated_at?: string;
|
|
605
598
|
/**
|
|
606
599
|
* - Time of creation of the history event
|
|
607
600
|
*/
|
|
608
601
|
created_at?: string;
|
|
602
|
+
};
|
|
603
|
+
/** @returns {Ticket} */
|
|
604
|
+
declare function Ticket(): Ticket;
|
|
605
|
+
type Ticket = {
|
|
606
|
+
context?: TicketContext;
|
|
607
|
+
created_on?: CreatedOn;
|
|
609
608
|
/**
|
|
610
|
-
* -
|
|
609
|
+
* - Details of company and application
|
|
610
|
+
* realated to the ticket
|
|
611
|
+
*/
|
|
612
|
+
response_id?: string;
|
|
613
|
+
content?: TicketContent;
|
|
614
|
+
category: TicketCategory;
|
|
615
|
+
/**
|
|
616
|
+
* - Sub-category assigned to the ticket
|
|
617
|
+
*/
|
|
618
|
+
sub_category?: string;
|
|
619
|
+
source: TicketSourceEnum;
|
|
620
|
+
status: Status;
|
|
621
|
+
priority: Priority;
|
|
622
|
+
/**
|
|
623
|
+
* - User details of ticket creator
|
|
611
624
|
*/
|
|
612
625
|
created_by?: any;
|
|
613
|
-
created_on?: CreatedOn;
|
|
614
626
|
/**
|
|
615
|
-
* -
|
|
627
|
+
* - Details of support staff to whom ticket is assigned
|
|
616
628
|
*/
|
|
617
|
-
|
|
629
|
+
assigned_to?: any;
|
|
618
630
|
/**
|
|
619
|
-
* -
|
|
631
|
+
* - Tags relevant to ticket
|
|
620
632
|
*/
|
|
621
|
-
|
|
633
|
+
tags?: string[];
|
|
622
634
|
/**
|
|
623
|
-
* -
|
|
635
|
+
* - Custom json relevant to the ticket
|
|
624
636
|
*/
|
|
625
|
-
|
|
637
|
+
_custom_json?: any;
|
|
626
638
|
/**
|
|
627
|
-
* -
|
|
639
|
+
* - Denotes if feedback submission is
|
|
640
|
+
* pending for the ticket
|
|
628
641
|
*/
|
|
629
|
-
|
|
630
|
-
};
|
|
631
|
-
/** @returns {TicketHistoryPayload} */
|
|
632
|
-
declare function TicketHistoryPayload(): TicketHistoryPayload;
|
|
633
|
-
type TicketHistoryPayload = {
|
|
634
|
-
type: HistoryTypeEnum;
|
|
642
|
+
is_feedback_pending?: boolean;
|
|
635
643
|
/**
|
|
636
|
-
* -
|
|
644
|
+
* - Integration type and its details of the ticket
|
|
645
|
+
*/
|
|
646
|
+
integration?: any;
|
|
647
|
+
/**
|
|
648
|
+
* - Unique identifier for the ticket
|
|
649
|
+
*/
|
|
650
|
+
_id: string;
|
|
651
|
+
/**
|
|
652
|
+
* - Time when the ticket was last updated
|
|
637
653
|
*/
|
|
638
|
-
value: any;
|
|
639
|
-
};
|
|
640
|
-
/** @returns {UserSchema} */
|
|
641
|
-
declare function UserSchema(): UserSchema;
|
|
642
|
-
type UserSchema = {
|
|
643
|
-
_id?: string;
|
|
644
|
-
account_type?: string;
|
|
645
|
-
active?: boolean;
|
|
646
|
-
application_id?: string;
|
|
647
|
-
created_at?: string;
|
|
648
|
-
dob?: string;
|
|
649
|
-
emails?: Email[];
|
|
650
|
-
first_name?: string;
|
|
651
|
-
gender?: string;
|
|
652
|
-
last_name?: string;
|
|
653
|
-
meta?: any;
|
|
654
|
-
phone_numbers?: PhoneNumber[];
|
|
655
|
-
profile_pic_url?: string;
|
|
656
654
|
updated_at?: string;
|
|
657
|
-
|
|
658
|
-
|
|
655
|
+
/**
|
|
656
|
+
* - Time when the ticket was created
|
|
657
|
+
*/
|
|
658
|
+
created_at?: string;
|
|
659
659
|
};
|
|
660
|
-
/**
|
|
661
|
-
* Enum: HistoryTypeEnum Used By: Lead
|
|
662
|
-
*
|
|
663
|
-
* @returns {HistoryTypeEnum}
|
|
664
|
-
*/
|
|
665
|
-
declare function HistoryTypeEnum(): HistoryTypeEnum;
|
|
666
|
-
type HistoryTypeEnum = "rating" | "log" | "comment" | "thread";
|
|
667
660
|
/**
|
|
668
661
|
* Enum: PriorityEnum Used By: Lead
|
|
669
662
|
*
|
|
@@ -671,6 +664,13 @@ type HistoryTypeEnum = "rating" | "log" | "comment" | "thread";
|
|
|
671
664
|
*/
|
|
672
665
|
declare function PriorityEnum(): PriorityEnum;
|
|
673
666
|
type PriorityEnum = "low" | "medium" | "high" | "urgent";
|
|
667
|
+
/**
|
|
668
|
+
* Enum: HistoryTypeEnum Used By: Lead
|
|
669
|
+
*
|
|
670
|
+
* @returns {HistoryTypeEnum}
|
|
671
|
+
*/
|
|
672
|
+
declare function HistoryTypeEnum(): HistoryTypeEnum;
|
|
673
|
+
type HistoryTypeEnum = "rating" | "log" | "comment" | "thread";
|
|
674
674
|
/**
|
|
675
675
|
* Enum: TicketAssetTypeEnum Used By: Lead
|
|
676
676
|
*
|