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