@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,94 +1,93 @@
|
|
|
1
1
|
export = CommunicationPlatformModel;
|
|
2
2
|
/**
|
|
3
3
|
* @typedef AppProvider
|
|
4
|
-
* @property {
|
|
4
|
+
* @property {AppProviderRes} [email]
|
|
5
|
+
* @property {AppProviderRes} [sms]
|
|
6
|
+
* @property {AppProviderResVoice} [voice]
|
|
5
7
|
* @property {string} [_id]
|
|
6
8
|
* @property {string} [application]
|
|
7
9
|
* @property {string} [created_at]
|
|
8
|
-
* @property {AppProviderRes} [email]
|
|
9
|
-
* @property {AppProviderRes} [sms]
|
|
10
10
|
* @property {string} [updated_at]
|
|
11
|
-
* @property {
|
|
12
|
-
*/
|
|
13
|
-
/**
|
|
14
|
-
* @typedef AppProviderReq
|
|
15
|
-
* @property {AppProviderRes} [email]
|
|
16
|
-
* @property {AppProviderRes} [sms]
|
|
17
|
-
* @property {AppProviderResVoice} [voice]
|
|
11
|
+
* @property {number} [__v]
|
|
18
12
|
*/
|
|
19
13
|
/**
|
|
20
14
|
* @typedef AppProviderRes
|
|
21
|
-
* @property {AppProviderResObj} [
|
|
15
|
+
* @property {AppProviderResObj} [transaction]
|
|
22
16
|
* @property {AppProviderResObj} [promotional]
|
|
17
|
+
* @property {AppProviderResObj} [otp]
|
|
18
|
+
*/
|
|
19
|
+
/**
|
|
20
|
+
* @typedef AppProviderResVoice
|
|
23
21
|
* @property {AppProviderResObj} [transaction]
|
|
22
|
+
* @property {AppProviderResObj} [otp]
|
|
24
23
|
*/
|
|
25
24
|
/**
|
|
26
25
|
* @typedef AppProviderResObj
|
|
27
26
|
* @property {string} [provider]
|
|
28
27
|
*/
|
|
29
28
|
/**
|
|
30
|
-
* @typedef
|
|
31
|
-
* @property {
|
|
32
|
-
* @property {
|
|
29
|
+
* @typedef GlobalProviders
|
|
30
|
+
* @property {GlobalProvidersResObj[]} [email]
|
|
31
|
+
* @property {GlobalProvidersResObj[]} [sms]
|
|
32
|
+
* @property {GlobalProvidersResObj[]} [voice]
|
|
33
33
|
*/
|
|
34
34
|
/**
|
|
35
|
-
* @typedef
|
|
36
|
-
* @property {number} [__v]
|
|
35
|
+
* @typedef GlobalProvidersResObj
|
|
37
36
|
* @property {string} [_id]
|
|
38
|
-
* @property {string} [application]
|
|
39
|
-
* @property {string} [created_at]
|
|
40
|
-
* @property {string} [description]
|
|
41
|
-
* @property {string} [file_url]
|
|
42
|
-
* @property {string[]} [headers]
|
|
43
|
-
* @property {boolean} [is_active]
|
|
44
37
|
* @property {string} [name]
|
|
45
|
-
* @property {number} [records_count]
|
|
46
|
-
* @property {string} [slug]
|
|
47
|
-
* @property {string[]} [tags]
|
|
48
|
-
* @property {string} [type]
|
|
49
|
-
* @property {string} [updated_at]
|
|
50
38
|
*/
|
|
51
39
|
/**
|
|
52
|
-
* @typedef
|
|
53
|
-
* @property {
|
|
54
|
-
* @property {
|
|
55
|
-
* @property {
|
|
56
|
-
* @property {string} [name]
|
|
57
|
-
* @property {number} [records_count]
|
|
58
|
-
* @property {string[]} [tags]
|
|
59
|
-
* @property {string} [type]
|
|
40
|
+
* @typedef AppProviderReq
|
|
41
|
+
* @property {AppProviderRes} [email]
|
|
42
|
+
* @property {AppProviderRes} [sms]
|
|
43
|
+
* @property {AppProviderResVoice} [voice]
|
|
60
44
|
*/
|
|
61
45
|
/**
|
|
62
|
-
* @typedef
|
|
63
|
-
* @property {
|
|
64
|
-
* @property {Page} [page]
|
|
46
|
+
* @typedef StatsImported
|
|
47
|
+
* @property {number} [count]
|
|
65
48
|
*/
|
|
66
49
|
/**
|
|
67
|
-
* @typedef
|
|
68
|
-
* @property {
|
|
69
|
-
* @property {
|
|
50
|
+
* @typedef StatsProcessedEmail
|
|
51
|
+
* @property {number} [success]
|
|
52
|
+
* @property {number} [failed]
|
|
53
|
+
* @property {number} [suppressed]
|
|
70
54
|
*/
|
|
71
55
|
/**
|
|
72
|
-
* @typedef
|
|
73
|
-
* @property {number} [
|
|
56
|
+
* @typedef StatsProcessedSms
|
|
57
|
+
* @property {number} [success]
|
|
58
|
+
* @property {number} [failed]
|
|
59
|
+
* @property {number} [suppressed]
|
|
60
|
+
*/
|
|
61
|
+
/**
|
|
62
|
+
* @typedef StatsProcessed
|
|
63
|
+
* @property {StatsProcessedEmail} [email]
|
|
64
|
+
* @property {StatsProcessedSms} [sms]
|
|
65
|
+
*/
|
|
66
|
+
/**
|
|
67
|
+
* @typedef Stats
|
|
74
68
|
* @property {string} [_id]
|
|
75
|
-
* @property {
|
|
76
|
-
* @property {
|
|
77
|
-
|
|
69
|
+
* @property {Object} [imported]
|
|
70
|
+
* @property {Object} [processed]
|
|
71
|
+
*/
|
|
72
|
+
/**
|
|
73
|
+
* @typedef GetStats
|
|
74
|
+
* @property {Stats[]} [items]
|
|
75
|
+
*/
|
|
76
|
+
/**
|
|
77
|
+
* @typedef CampaignReq
|
|
78
78
|
* @property {string} [description]
|
|
79
|
-
* @property {
|
|
79
|
+
* @property {string[]} [tags]
|
|
80
|
+
* @property {string[]} [headers]
|
|
80
81
|
* @property {boolean} [is_active]
|
|
81
82
|
* @property {string} [name]
|
|
82
|
-
* @property {
|
|
83
|
-
* @property {string} [slug]
|
|
84
|
-
* @property {Object[]} [tags]
|
|
83
|
+
* @property {string} [file_url]
|
|
85
84
|
* @property {string} [type]
|
|
86
|
-
* @property {
|
|
85
|
+
* @property {number} [records_count]
|
|
86
|
+
* @property {string} [application]
|
|
87
87
|
*/
|
|
88
88
|
/**
|
|
89
|
-
* @typedef
|
|
90
|
-
* @property {
|
|
91
|
-
* @property {CampaignEmailTemplate} [template]
|
|
89
|
+
* @typedef RecipientHeaders
|
|
90
|
+
* @property {string} [email]
|
|
92
91
|
*/
|
|
93
92
|
/**
|
|
94
93
|
* @typedef CampaignEmailTemplate
|
|
@@ -96,16 +95,32 @@ export = CommunicationPlatformModel;
|
|
|
96
95
|
* @property {string} [value]
|
|
97
96
|
*/
|
|
98
97
|
/**
|
|
99
|
-
* @typedef
|
|
100
|
-
* @property {string} [
|
|
98
|
+
* @typedef CampignEmailProvider
|
|
99
|
+
* @property {string} [_id]
|
|
100
|
+
* @property {string} [from_name]
|
|
101
|
+
* @property {string} [from_email]
|
|
102
|
+
*/
|
|
103
|
+
/**
|
|
104
|
+
* @typedef CampaignEmail
|
|
105
|
+
* @property {CampaignEmailTemplate} [template]
|
|
106
|
+
* @property {CampignEmailProvider} [provider]
|
|
107
|
+
*/
|
|
108
|
+
/**
|
|
109
|
+
* @typedef Campaign
|
|
110
|
+
* @property {RecipientHeaders} [recipient_headers]
|
|
111
|
+
* @property {CampaignEmail} [email]
|
|
101
112
|
* @property {string} [description]
|
|
102
|
-
* @property {
|
|
103
|
-
* @property {string[]} [headers]
|
|
113
|
+
* @property {Object[]} [tags]
|
|
104
114
|
* @property {boolean} [is_active]
|
|
105
|
-
* @property {string} [
|
|
106
|
-
* @property {
|
|
107
|
-
* @property {string[]} [tags]
|
|
115
|
+
* @property {string} [_id]
|
|
116
|
+
* @property {string} [datasource]
|
|
108
117
|
* @property {string} [type]
|
|
118
|
+
* @property {string} [name]
|
|
119
|
+
* @property {string} [application]
|
|
120
|
+
* @property {string} [created_at]
|
|
121
|
+
* @property {string} [updated_at]
|
|
122
|
+
* @property {string} [slug]
|
|
123
|
+
* @property {number} [__v]
|
|
109
124
|
*/
|
|
110
125
|
/**
|
|
111
126
|
* @typedef Campaigns
|
|
@@ -113,36 +128,63 @@ export = CommunicationPlatformModel;
|
|
|
113
128
|
* @property {Page} [page]
|
|
114
129
|
*/
|
|
115
130
|
/**
|
|
116
|
-
* @typedef
|
|
117
|
-
* @property {string} [
|
|
118
|
-
* @property {string} [
|
|
119
|
-
* @property {string} [from_name]
|
|
131
|
+
* @typedef BadRequestSchema
|
|
132
|
+
* @property {string} [status] - Response status.
|
|
133
|
+
* @property {string} [message] - Failure message.
|
|
120
134
|
*/
|
|
121
135
|
/**
|
|
122
|
-
* @typedef
|
|
123
|
-
* @property {
|
|
124
|
-
* @property {string} [template] - Template ID
|
|
136
|
+
* @typedef NotFound
|
|
137
|
+
* @property {string} [message] - Failure message.
|
|
125
138
|
*/
|
|
126
139
|
/**
|
|
127
|
-
* @typedef
|
|
128
|
-
* @property {string} [
|
|
140
|
+
* @typedef AudienceReq
|
|
141
|
+
* @property {string} [name]
|
|
142
|
+
* @property {string} [description]
|
|
143
|
+
* @property {string[]} [tags]
|
|
144
|
+
* @property {string} [file_url]
|
|
145
|
+
* @property {string} [type]
|
|
146
|
+
* @property {number} [records_count]
|
|
147
|
+
* @property {string[]} [headers]
|
|
129
148
|
*/
|
|
130
149
|
/**
|
|
131
|
-
* @typedef
|
|
132
|
-
* @property {number} [__v]
|
|
150
|
+
* @typedef Audience
|
|
133
151
|
* @property {string} [_id]
|
|
134
152
|
* @property {string} [application]
|
|
135
|
-
* @property {string} [
|
|
136
|
-
* @property {
|
|
137
|
-
* @property {
|
|
153
|
+
* @property {string} [name]
|
|
154
|
+
* @property {string} [description]
|
|
155
|
+
* @property {number} [records_count]
|
|
156
|
+
* @property {string} [type]
|
|
157
|
+
* @property {string[]} [tags]
|
|
158
|
+
* @property {string[]} [headers]
|
|
159
|
+
* @property {string} [file_url]
|
|
138
160
|
* @property {boolean} [is_active]
|
|
161
|
+
* @property {string} [created_at]
|
|
139
162
|
* @property {string} [updated_at]
|
|
163
|
+
* @property {string} [slug]
|
|
164
|
+
* @property {number} [__v]
|
|
140
165
|
*/
|
|
141
166
|
/**
|
|
142
|
-
* @typedef
|
|
143
|
-
* @property {
|
|
144
|
-
* @property {
|
|
145
|
-
|
|
167
|
+
* @typedef Audiences
|
|
168
|
+
* @property {Audience[]} [items]
|
|
169
|
+
* @property {Page} [page]
|
|
170
|
+
*/
|
|
171
|
+
/**
|
|
172
|
+
* @typedef GetNRecordsCsvReq
|
|
173
|
+
* @property {string} [url]
|
|
174
|
+
* @property {boolean} [header]
|
|
175
|
+
* @property {number} [count]
|
|
176
|
+
*/
|
|
177
|
+
/**
|
|
178
|
+
* @typedef GetNRecordsCsvResItems
|
|
179
|
+
* @property {string} [phone_number]
|
|
180
|
+
* @property {string} [email]
|
|
181
|
+
* @property {string} [firstname]
|
|
182
|
+
* @property {string} [lastname]
|
|
183
|
+
* @property {string} [orderid]
|
|
184
|
+
*/
|
|
185
|
+
/**
|
|
186
|
+
* @typedef GetNRecordsCsvRes
|
|
187
|
+
* @property {GetNRecordsCsvResItems[]} [items]
|
|
146
188
|
*/
|
|
147
189
|
/**
|
|
148
190
|
* @typedef DummyDatasources
|
|
@@ -151,42 +193,42 @@ export = CommunicationPlatformModel;
|
|
|
151
193
|
*/
|
|
152
194
|
/**
|
|
153
195
|
* @typedef DummyDatasourcesMeta
|
|
154
|
-
* @property {DummyDatasourcesMetaObj} [data]
|
|
155
196
|
* @property {number} [id]
|
|
197
|
+
* @property {DummyDatasourcesMetaObj} [data]
|
|
156
198
|
*/
|
|
157
199
|
/**
|
|
158
200
|
* @typedef DummyDatasourcesMetaObj
|
|
159
201
|
* @property {number} [b]
|
|
160
202
|
*/
|
|
161
203
|
/**
|
|
162
|
-
* @typedef
|
|
163
|
-
* @property {number} [__v]
|
|
164
|
-
* @property {string} [_id]
|
|
165
|
-
* @property {string} [api_key]
|
|
166
|
-
* @property {string} [application]
|
|
167
|
-
* @property {string} [created_at]
|
|
168
|
-
* @property {string} [description]
|
|
169
|
-
* @property {EmailProviderReqFrom[]} [from_address]
|
|
204
|
+
* @typedef EmailProviderReqFrom
|
|
170
205
|
* @property {string} [name]
|
|
171
|
-
* @property {string} [
|
|
172
|
-
* @property {
|
|
173
|
-
* @property {string} [type]
|
|
174
|
-
* @property {string} [updated_at]
|
|
206
|
+
* @property {string} [email]
|
|
207
|
+
* @property {boolean} [is_default]
|
|
175
208
|
*/
|
|
176
209
|
/**
|
|
177
210
|
* @typedef EmailProviderReq
|
|
178
|
-
* @property {string} [api_key]
|
|
179
|
-
* @property {string} [description]
|
|
180
|
-
* @property {EmailProviderReqFrom[]} [from_address]
|
|
181
211
|
* @property {string} [name]
|
|
182
|
-
* @property {string} [
|
|
212
|
+
* @property {string} [description]
|
|
213
|
+
* @property {string} [api_key]
|
|
183
214
|
* @property {string} [type]
|
|
215
|
+
* @property {string} [provider]
|
|
216
|
+
* @property {EmailProviderReqFrom[]} [from_address]
|
|
184
217
|
*/
|
|
185
218
|
/**
|
|
186
|
-
* @typedef
|
|
187
|
-
* @property {string} [
|
|
188
|
-
* @property {
|
|
219
|
+
* @typedef EmailProvider
|
|
220
|
+
* @property {string} [type]
|
|
221
|
+
* @property {string} [provider]
|
|
222
|
+
* @property {EmailProviderReqFrom[]} [from_address]
|
|
223
|
+
* @property {string} [_id]
|
|
189
224
|
* @property {string} [name]
|
|
225
|
+
* @property {string} [description]
|
|
226
|
+
* @property {string} [api_key]
|
|
227
|
+
* @property {string} [application]
|
|
228
|
+
* @property {string} [created_at]
|
|
229
|
+
* @property {string} [updated_at]
|
|
230
|
+
* @property {string} [slug]
|
|
231
|
+
* @property {number} [__v]
|
|
190
232
|
*/
|
|
191
233
|
/**
|
|
192
234
|
* @typedef EmailProviders
|
|
@@ -194,67 +236,98 @@ export = CommunicationPlatformModel;
|
|
|
194
236
|
* @property {Page} [page]
|
|
195
237
|
*/
|
|
196
238
|
/**
|
|
197
|
-
* @typedef
|
|
198
|
-
* @property {
|
|
199
|
-
* @property {string} [
|
|
200
|
-
* @property {string} [
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
* @
|
|
239
|
+
* @typedef EmailTemplateKeys
|
|
240
|
+
* @property {string} [to]
|
|
241
|
+
* @property {string} [cc]
|
|
242
|
+
* @property {string} [bcc]
|
|
243
|
+
*/
|
|
244
|
+
/**
|
|
245
|
+
* @typedef EmailTemplateHeaders
|
|
246
|
+
* @property {string} [key]
|
|
247
|
+
* @property {string} [value]
|
|
248
|
+
*/
|
|
249
|
+
/**
|
|
250
|
+
* @typedef EmailTemplateReq
|
|
251
|
+
* @property {string} name
|
|
204
252
|
* @property {string} [description]
|
|
205
|
-
* @property {string} [editor_meta]
|
|
206
|
-
* @property {string} [editor_type]
|
|
207
253
|
* @property {string} [from_name]
|
|
208
|
-
* @property {EmailTemplateHeaders[]} [headers]
|
|
209
|
-
* @property {TemplateAndType} [html]
|
|
210
|
-
* @property {boolean} [is_internal]
|
|
211
|
-
* @property {boolean} [is_system]
|
|
212
|
-
* @property {string} [name]
|
|
213
|
-
* @property {string} [priority]
|
|
214
|
-
* @property {boolean} [published]
|
|
215
|
-
* @property {string} [reply_to]
|
|
216
|
-
* @property {string} [slug]
|
|
217
|
-
* @property {string[]} [static_bcc]
|
|
218
|
-
* @property {string[]} [static_cc]
|
|
219
254
|
* @property {string[]} [static_to]
|
|
220
|
-
* @property {
|
|
255
|
+
* @property {string[]} [static_cc]
|
|
256
|
+
* @property {string[]} [static_bcc]
|
|
257
|
+
* @property {string} [reply_to]
|
|
258
|
+
* @property {string} [priority]
|
|
221
259
|
* @property {string[]} [tags]
|
|
222
260
|
* @property {Object} [template_variables]
|
|
261
|
+
* @property {boolean} [published]
|
|
262
|
+
* @property {TemplateAndType} [subject]
|
|
263
|
+
* @property {TemplateAndType} [html]
|
|
264
|
+
* @property {string} [editor_type]
|
|
265
|
+
* @property {string} [editor_meta]
|
|
266
|
+
* @property {number[]} [attachments]
|
|
267
|
+
* @property {EmailTemplateHeaders[]} [headers]
|
|
268
|
+
* @property {EmailTemplateKeys} [keys]
|
|
223
269
|
* @property {TemplateAndType} [text]
|
|
224
|
-
* @property {string} [updated_at]
|
|
225
|
-
* @property {EnabledObj} [url_shorten]
|
|
226
|
-
*/
|
|
227
|
-
/**
|
|
228
|
-
* @typedef EmailTemplateHeaders
|
|
229
|
-
* @property {string} [key]
|
|
230
|
-
* @property {string} [value]
|
|
231
270
|
*/
|
|
232
271
|
/**
|
|
233
|
-
* @typedef
|
|
234
|
-
* @property {string} [
|
|
235
|
-
* @property {string} [
|
|
236
|
-
* @property {string} [to]
|
|
272
|
+
* @typedef TemplateAndType
|
|
273
|
+
* @property {string} [template_type]
|
|
274
|
+
* @property {string} [template]
|
|
237
275
|
*/
|
|
238
276
|
/**
|
|
239
|
-
* @typedef
|
|
240
|
-
* @property {
|
|
277
|
+
* @typedef EmailTemplate
|
|
278
|
+
* @property {string} [application]
|
|
279
|
+
* @property {boolean} [is_system]
|
|
280
|
+
* @property {boolean} [is_internal]
|
|
281
|
+
* @property {string} [name]
|
|
241
282
|
* @property {string} [description]
|
|
242
|
-
* @property {string} [editor_meta]
|
|
243
283
|
* @property {string} [editor_type]
|
|
244
|
-
* @property {string} [
|
|
245
|
-
* @property {
|
|
284
|
+
* @property {string} [editor_meta]
|
|
285
|
+
* @property {string[]} [static_to]
|
|
286
|
+
* @property {string[]} [static_cc]
|
|
287
|
+
* @property {string[]} [static_bcc]
|
|
288
|
+
* @property {string} [reply_to]
|
|
289
|
+
* @property {string[]} [tags]
|
|
290
|
+
* @property {TemplateAndType} [subject]
|
|
246
291
|
* @property {TemplateAndType} [html]
|
|
247
|
-
* @property {
|
|
248
|
-
* @property {string} name
|
|
292
|
+
* @property {EnabledObj} [url_shorten]
|
|
249
293
|
* @property {string} [priority]
|
|
294
|
+
* @property {Object} [template_variables]
|
|
250
295
|
* @property {boolean} [published]
|
|
251
|
-
* @property {string} [
|
|
252
|
-
* @property {string
|
|
253
|
-
* @property {
|
|
296
|
+
* @property {string} [category]
|
|
297
|
+
* @property {string} [_id]
|
|
298
|
+
* @property {EmailTemplateHeaders[]} [headers]
|
|
299
|
+
* @property {number[]} [attachments]
|
|
300
|
+
* @property {string} [created_at]
|
|
301
|
+
* @property {string} [updated_at]
|
|
302
|
+
* @property {string} [slug]
|
|
303
|
+
* @property {number} [__v]
|
|
304
|
+
* @property {string} [from_name]
|
|
305
|
+
* @property {TemplateAndType} [text]
|
|
306
|
+
*/
|
|
307
|
+
/**
|
|
308
|
+
* @typedef SystemEmailTemplate
|
|
309
|
+
* @property {boolean} [is_system]
|
|
310
|
+
* @property {boolean} [is_internal]
|
|
311
|
+
* @property {string} [name]
|
|
312
|
+
* @property {string} [description]
|
|
254
313
|
* @property {string[]} [static_to]
|
|
255
|
-
* @property {
|
|
314
|
+
* @property {string[]} [static_cc]
|
|
315
|
+
* @property {string[]} [static_bcc]
|
|
256
316
|
* @property {string[]} [tags]
|
|
317
|
+
* @property {TemplateAndType} [subject]
|
|
318
|
+
* @property {TemplateAndType} [html]
|
|
319
|
+
* @property {EnabledObj} [url_shorten]
|
|
320
|
+
* @property {string} [priority]
|
|
257
321
|
* @property {Object} [template_variables]
|
|
322
|
+
* @property {boolean} [published]
|
|
323
|
+
* @property {string} [category]
|
|
324
|
+
* @property {string} [_id]
|
|
325
|
+
* @property {EmailTemplateHeaders[]} [headers]
|
|
326
|
+
* @property {number[]} [attachments]
|
|
327
|
+
* @property {string} [created_at]
|
|
328
|
+
* @property {string} [updated_at]
|
|
329
|
+
* @property {string} [slug]
|
|
330
|
+
* @property {number} [__v]
|
|
258
331
|
* @property {TemplateAndType} [text]
|
|
259
332
|
*/
|
|
260
333
|
/**
|
|
@@ -263,123 +336,112 @@ export = CommunicationPlatformModel;
|
|
|
263
336
|
* @property {Page} [page]
|
|
264
337
|
*/
|
|
265
338
|
/**
|
|
266
|
-
* @typedef
|
|
267
|
-
* @property {
|
|
268
|
-
*/
|
|
269
|
-
/**
|
|
270
|
-
* @typedef EngineRequest
|
|
271
|
-
* @property {MetaStructure} [meta]
|
|
272
|
-
* @property {PayloadStructure} [payload]
|
|
339
|
+
* @typedef SystemEmailTemplates
|
|
340
|
+
* @property {SystemEmailTemplate[]} [items]
|
|
273
341
|
*/
|
|
274
342
|
/**
|
|
275
|
-
* @typedef
|
|
276
|
-
* @property {
|
|
343
|
+
* @typedef PayloadEmailTemplateStructure
|
|
344
|
+
* @property {string} [key]
|
|
345
|
+
* @property {Object} [value]
|
|
277
346
|
*/
|
|
278
347
|
/**
|
|
279
|
-
* @typedef
|
|
280
|
-
* @property {number} [__v]
|
|
348
|
+
* @typedef PayloadEmailProviderStructure
|
|
281
349
|
* @property {string} [_id]
|
|
282
|
-
* @property {string} [application]
|
|
283
|
-
* @property {string} [created_at]
|
|
284
|
-
* @property {string} [event]
|
|
285
|
-
* @property {boolean} [is_default]
|
|
286
|
-
* @property {string} [slug]
|
|
287
|
-
* @property {EventSubscriptionTemplate} [template]
|
|
288
|
-
* @property {string} [updated_at]
|
|
289
350
|
*/
|
|
290
351
|
/**
|
|
291
|
-
* @typedef
|
|
292
|
-
* @property {
|
|
293
|
-
* @property {
|
|
352
|
+
* @typedef PayloadEmailStructure
|
|
353
|
+
* @property {PayloadEmailTemplateStructure} [template]
|
|
354
|
+
* @property {PayloadEmailProviderStructure} [provider]
|
|
294
355
|
*/
|
|
295
356
|
/**
|
|
296
|
-
* @typedef
|
|
297
|
-
* @property {
|
|
357
|
+
* @typedef PayloadSmsTemplateStructure
|
|
358
|
+
* @property {string} [key]
|
|
359
|
+
* @property {Object} [value]
|
|
298
360
|
*/
|
|
299
361
|
/**
|
|
300
|
-
* @typedef
|
|
301
|
-
* @property {number} [__v]
|
|
362
|
+
* @typedef PayloadSmsProviderStructure
|
|
302
363
|
* @property {string} [_id]
|
|
303
|
-
* @property {string} [application]
|
|
304
|
-
* @property {string} [category]
|
|
305
|
-
* @property {string} [created_at]
|
|
306
|
-
* @property {string} [event]
|
|
307
|
-
* @property {string} [slug]
|
|
308
|
-
* @property {EventSubscriptionTemplate} [template]
|
|
309
|
-
* @property {string} [updated_at]
|
|
310
364
|
*/
|
|
311
365
|
/**
|
|
312
|
-
* @typedef
|
|
313
|
-
* @property {
|
|
314
|
-
* @property {
|
|
366
|
+
* @typedef PayloadSmsStructure
|
|
367
|
+
* @property {PayloadSmsTemplateStructure} [template]
|
|
368
|
+
* @property {PayloadSmsProviderStructure} [provider]
|
|
315
369
|
*/
|
|
316
370
|
/**
|
|
317
|
-
* @typedef
|
|
318
|
-
* @property {
|
|
319
|
-
* @property {
|
|
371
|
+
* @typedef PayloadStructure
|
|
372
|
+
* @property {Object[]} [data]
|
|
373
|
+
* @property {PayloadEmailStructure} [email]
|
|
374
|
+
* @property {PayloadSmsStructure} [sms]
|
|
375
|
+
* @property {string} [application]
|
|
320
376
|
*/
|
|
321
377
|
/**
|
|
322
|
-
* @typedef
|
|
323
|
-
* @property {
|
|
324
|
-
* @property {string} [
|
|
378
|
+
* @typedef MetaStructure
|
|
379
|
+
* @property {string} [job_type]
|
|
380
|
+
* @property {string} [action]
|
|
381
|
+
* @property {string} [trace]
|
|
382
|
+
* @property {string} [timestamp]
|
|
325
383
|
*/
|
|
326
384
|
/**
|
|
327
|
-
* @typedef
|
|
328
|
-
* @property {
|
|
329
|
-
* @property {
|
|
330
|
-
* @property {string} [message]
|
|
331
|
-
* @property {string} [operation]
|
|
385
|
+
* @typedef EngineRequest
|
|
386
|
+
* @property {PayloadStructure} [payload]
|
|
387
|
+
* @property {MetaStructure} [meta]
|
|
332
388
|
*/
|
|
333
389
|
/**
|
|
334
|
-
* @typedef
|
|
335
|
-
* @property {
|
|
336
|
-
* @property {string} [sentry]
|
|
390
|
+
* @typedef EngineResponse
|
|
391
|
+
* @property {boolean} [success]
|
|
337
392
|
*/
|
|
338
393
|
/**
|
|
339
|
-
* @typedef
|
|
340
|
-
* @property {
|
|
341
|
-
* @property {
|
|
342
|
-
* @property {string} [url]
|
|
394
|
+
* @typedef EventSubscriptionTemplateSms
|
|
395
|
+
* @property {boolean} [subscribed]
|
|
396
|
+
* @property {string} [template]
|
|
343
397
|
*/
|
|
344
398
|
/**
|
|
345
|
-
* @typedef
|
|
346
|
-
* @property {
|
|
399
|
+
* @typedef EventSubscriptionTemplateEmail
|
|
400
|
+
* @property {boolean} [subscribed]
|
|
401
|
+
* @property {string} [template]
|
|
347
402
|
*/
|
|
348
403
|
/**
|
|
349
|
-
* @typedef
|
|
350
|
-
* @property {
|
|
351
|
-
* @property {
|
|
352
|
-
* @property {string} [lastname]
|
|
353
|
-
* @property {string} [orderid]
|
|
354
|
-
* @property {string} [phone_number]
|
|
404
|
+
* @typedef EventSubscriptionTemplate
|
|
405
|
+
* @property {EventSubscriptionTemplateSms} [sms]
|
|
406
|
+
* @property {EventSubscriptionTemplateEmail} [email]
|
|
355
407
|
*/
|
|
356
408
|
/**
|
|
357
|
-
* @typedef
|
|
358
|
-
* @property {
|
|
409
|
+
* @typedef EventSubscription
|
|
410
|
+
* @property {EventSubscriptionTemplate} [template]
|
|
411
|
+
* @property {boolean} [is_default]
|
|
412
|
+
* @property {string} [_id]
|
|
413
|
+
* @property {string} [application]
|
|
414
|
+
* @property {string} [event]
|
|
415
|
+
* @property {string} [slug]
|
|
416
|
+
* @property {string} [created_at]
|
|
417
|
+
* @property {string} [updated_at]
|
|
418
|
+
* @property {number} [__v]
|
|
359
419
|
*/
|
|
360
420
|
/**
|
|
361
|
-
* @typedef
|
|
362
|
-
* @property {
|
|
363
|
-
* @property {
|
|
364
|
-
* @property {GlobalProvidersResObj[]} [voice]
|
|
421
|
+
* @typedef EventSubscriptions
|
|
422
|
+
* @property {EventSubscription[]} [items]
|
|
423
|
+
* @property {Page} [page]
|
|
365
424
|
*/
|
|
366
425
|
/**
|
|
367
|
-
* @typedef
|
|
368
|
-
* @property {
|
|
369
|
-
|
|
426
|
+
* @typedef TriggerJobResponse
|
|
427
|
+
* @property {number} [status]
|
|
428
|
+
*/
|
|
429
|
+
/**
|
|
430
|
+
* @typedef TriggerJobRequest
|
|
431
|
+
* @property {string} [job_id]
|
|
370
432
|
*/
|
|
371
433
|
/**
|
|
372
434
|
* @typedef GlobalVariablesGetResponse
|
|
373
|
-
* @property {Object} [editable]
|
|
374
435
|
* @property {Object} [read_only]
|
|
436
|
+
* @property {Object} [editable]
|
|
375
437
|
*/
|
|
376
438
|
/**
|
|
377
439
|
* @typedef GlobalVariablesPostResponse
|
|
378
440
|
* @property {string} [_id]
|
|
379
|
-
* @property {string} [application]
|
|
380
441
|
* @property {string} [category]
|
|
381
|
-
* @property {string} [
|
|
442
|
+
* @property {string} [application]
|
|
382
443
|
* @property {Object} [global_variables]
|
|
444
|
+
* @property {string} [created_at]
|
|
383
445
|
*/
|
|
384
446
|
/**
|
|
385
447
|
* @typedef GlobalVariablesReq
|
|
@@ -387,25 +449,30 @@ export = CommunicationPlatformModel;
|
|
|
387
449
|
*/
|
|
388
450
|
/**
|
|
389
451
|
* @typedef Job
|
|
390
|
-
* @property {
|
|
452
|
+
* @property {boolean} [completed]
|
|
453
|
+
* @property {boolean} [is_active]
|
|
391
454
|
* @property {string} [_id]
|
|
392
|
-
* @property {string} [application]
|
|
393
455
|
* @property {string} [campaign]
|
|
394
|
-
* @property {
|
|
456
|
+
* @property {string} [application]
|
|
395
457
|
* @property {string} [created_at]
|
|
396
|
-
* @property {boolean} [is_active]
|
|
397
458
|
* @property {string} [updated_at]
|
|
459
|
+
* @property {number} [__v]
|
|
460
|
+
*/
|
|
461
|
+
/**
|
|
462
|
+
* @typedef Jobs
|
|
463
|
+
* @property {Job[]} [items]
|
|
464
|
+
* @property {Page} [page]
|
|
398
465
|
*/
|
|
399
466
|
/**
|
|
400
467
|
* @typedef JobLog
|
|
401
|
-
* @property {
|
|
468
|
+
* @property {Object} [imported]
|
|
469
|
+
* @property {Object} [processed]
|
|
402
470
|
* @property {string} [_id]
|
|
471
|
+
* @property {string} [job]
|
|
403
472
|
* @property {string} [campaign]
|
|
404
473
|
* @property {string} [created_at]
|
|
405
|
-
* @property {Object} [imported]
|
|
406
|
-
* @property {string} [job]
|
|
407
|
-
* @property {Object} [processed]
|
|
408
474
|
* @property {string} [updated_at]
|
|
475
|
+
* @property {number} [__v]
|
|
409
476
|
*/
|
|
410
477
|
/**
|
|
411
478
|
* @typedef JobLogs
|
|
@@ -413,40 +480,35 @@ export = CommunicationPlatformModel;
|
|
|
413
480
|
* @property {Page} [page]
|
|
414
481
|
*/
|
|
415
482
|
/**
|
|
416
|
-
* @typedef
|
|
417
|
-
* @property {
|
|
418
|
-
* @property {Page} [page]
|
|
483
|
+
* @typedef LogEmail
|
|
484
|
+
* @property {string} [template]
|
|
419
485
|
*/
|
|
420
486
|
/**
|
|
421
|
-
* @typedef
|
|
422
|
-
* @property {string} [
|
|
423
|
-
* @property {string} [application]
|
|
424
|
-
* @property {string} [created_at]
|
|
425
|
-
* @property {Object} [data]
|
|
426
|
-
* @property {LogEmail} [email]
|
|
427
|
-
* @property {string} [expire_at]
|
|
428
|
-
* @property {LogMeta} [meta]
|
|
429
|
-
* @property {LogPushnotification} [pushnotification]
|
|
430
|
-
* @property {string} [service]
|
|
431
|
-
* @property {string} [status]
|
|
432
|
-
* @property {string} [step]
|
|
433
|
-
*/
|
|
434
|
-
/**
|
|
435
|
-
* @typedef LogEmail
|
|
436
|
-
* @property {string} [template]
|
|
487
|
+
* @typedef LogPushnotification
|
|
488
|
+
* @property {string[]} [pushtokens]
|
|
437
489
|
*/
|
|
438
490
|
/**
|
|
439
491
|
* @typedef LogMeta
|
|
492
|
+
* @property {string} [type]
|
|
440
493
|
* @property {string} [identifier]
|
|
441
494
|
* @property {string} [key]
|
|
442
495
|
* @property {string} [offset]
|
|
443
496
|
* @property {string} [partition]
|
|
444
497
|
* @property {string} [topic]
|
|
445
|
-
* @property {string} [type]
|
|
446
498
|
*/
|
|
447
499
|
/**
|
|
448
|
-
* @typedef
|
|
449
|
-
* @property {
|
|
500
|
+
* @typedef Log
|
|
501
|
+
* @property {LogEmail} [email]
|
|
502
|
+
* @property {LogPushnotification} [pushnotification]
|
|
503
|
+
* @property {LogMeta} [meta]
|
|
504
|
+
* @property {string} [_id]
|
|
505
|
+
* @property {string} [application]
|
|
506
|
+
* @property {string} [service]
|
|
507
|
+
* @property {string} [step]
|
|
508
|
+
* @property {string} [status]
|
|
509
|
+
* @property {Object} [data]
|
|
510
|
+
* @property {string} [expire_at]
|
|
511
|
+
* @property {string} [created_at]
|
|
450
512
|
*/
|
|
451
513
|
/**
|
|
452
514
|
* @typedef Logs
|
|
@@ -454,212 +516,129 @@ export = CommunicationPlatformModel;
|
|
|
454
516
|
* @property {Page} [page]
|
|
455
517
|
*/
|
|
456
518
|
/**
|
|
457
|
-
* @typedef
|
|
458
|
-
* @property {string} [info]
|
|
459
|
-
* @property {string} [message]
|
|
460
|
-
* @property {string} [operation]
|
|
461
|
-
* @property {boolean} [success]
|
|
462
|
-
*/
|
|
463
|
-
/**
|
|
464
|
-
* @typedef metaObj
|
|
465
|
-
* @property {boolean} [is_system]
|
|
466
|
-
* @property {string} [template]
|
|
467
|
-
* @property {string} [type]
|
|
468
|
-
*/
|
|
469
|
-
/**
|
|
470
|
-
* @typedef MetaStructure
|
|
471
|
-
* @property {string} [action]
|
|
472
|
-
* @property {string} [job_type]
|
|
473
|
-
* @property {string} [timestamp]
|
|
474
|
-
* @property {string} [trace]
|
|
475
|
-
*/
|
|
476
|
-
/**
|
|
477
|
-
* @typedef NotFound
|
|
478
|
-
* @property {string} [message] - Failure message.
|
|
479
|
-
*/
|
|
480
|
-
/**
|
|
481
|
-
* @typedef Notification
|
|
482
|
-
* @property {string} [body]
|
|
483
|
-
* @property {string} [click_action]
|
|
484
|
-
* @property {string} [deeplink]
|
|
485
|
-
* @property {string} [icon]
|
|
486
|
-
* @property {string} [subtitle]
|
|
487
|
-
* @property {string} [title]
|
|
488
|
-
*/
|
|
489
|
-
/**
|
|
490
|
-
* @typedef OtpConfiguration
|
|
491
|
-
* @property {string} [application_id]
|
|
492
|
-
* @property {string} [company_id]
|
|
493
|
-
* @property {OtpConfigurationExpiry} expiry
|
|
494
|
-
* @property {number} otp_length
|
|
495
|
-
* @property {string} type
|
|
496
|
-
*/
|
|
497
|
-
/**
|
|
498
|
-
* @typedef OtpConfigurationExpiry
|
|
499
|
-
* @property {OtpConfigurationExpiryDuration} duration
|
|
500
|
-
* @property {string} type
|
|
501
|
-
*/
|
|
502
|
-
/**
|
|
503
|
-
* @typedef OtpConfigurationExpiryDuration
|
|
504
|
-
* @property {string} denomination
|
|
505
|
-
* @property {number} time
|
|
506
|
-
*/
|
|
507
|
-
/**
|
|
508
|
-
* @typedef Page
|
|
509
|
-
* @property {number} [current]
|
|
510
|
-
* @property {boolean} [has_next]
|
|
511
|
-
* @property {boolean} [has_previous]
|
|
512
|
-
* @property {number} [item_total]
|
|
513
|
-
* @property {string} [next_id]
|
|
514
|
-
* @property {number} [size]
|
|
515
|
-
* @property {string} type
|
|
516
|
-
*/
|
|
517
|
-
/**
|
|
518
|
-
* @typedef PayloadEmailProviderStructure
|
|
519
|
-
* @property {string} [_id]
|
|
520
|
-
*/
|
|
521
|
-
/**
|
|
522
|
-
* @typedef PayloadEmailStructure
|
|
523
|
-
* @property {PayloadEmailProviderStructure} [provider]
|
|
524
|
-
* @property {PayloadEmailTemplateStructure} [template]
|
|
525
|
-
*/
|
|
526
|
-
/**
|
|
527
|
-
* @typedef PayloadEmailTemplateStructure
|
|
519
|
+
* @typedef SendOtpSmsCommsTemplate
|
|
528
520
|
* @property {string} [key]
|
|
529
521
|
* @property {Object} [value]
|
|
530
522
|
*/
|
|
531
523
|
/**
|
|
532
|
-
* @typedef
|
|
524
|
+
* @typedef SendOtpSmsCommsProvider
|
|
525
|
+
* @property {string} [slug]
|
|
533
526
|
* @property {string} [_id]
|
|
534
527
|
*/
|
|
535
528
|
/**
|
|
536
|
-
* @typedef
|
|
537
|
-
* @property {
|
|
538
|
-
* @property {
|
|
529
|
+
* @typedef SendOtpEmailCommsProvider
|
|
530
|
+
* @property {string} [slug]
|
|
531
|
+
* @property {string} [_id]
|
|
539
532
|
*/
|
|
540
533
|
/**
|
|
541
|
-
* @typedef
|
|
534
|
+
* @typedef SendOtpEmailCommsTemplate
|
|
542
535
|
* @property {string} [key]
|
|
543
536
|
* @property {Object} [value]
|
|
544
537
|
*/
|
|
545
|
-
/**
|
|
546
|
-
* @typedef PayloadStructure
|
|
547
|
-
* @property {string} [application]
|
|
548
|
-
* @property {Object[]} [data]
|
|
549
|
-
* @property {PayloadEmailStructure} [email]
|
|
550
|
-
* @property {PayloadSmsStructure} [sms]
|
|
551
|
-
*/
|
|
552
|
-
/**
|
|
553
|
-
* @typedef RecipientHeaders
|
|
554
|
-
* @property {string} [email]
|
|
555
|
-
*/
|
|
556
|
-
/**
|
|
557
|
-
* @typedef SendOtpCommsReq
|
|
558
|
-
* @property {SendOtpCommsReqData} [data]
|
|
559
|
-
* @property {SendOtpCommsReqEmail} [email]
|
|
560
|
-
* @property {SendOtpCommsReqSms} [sms]
|
|
561
|
-
*/
|
|
562
538
|
/**
|
|
563
539
|
* @typedef SendOtpCommsReqData
|
|
564
|
-
* @property {string} [country_code]
|
|
565
|
-
* @property {string} [mobile]
|
|
566
540
|
* @property {boolean} [send_same_otp_to_channel]
|
|
541
|
+
* @property {string} [mobile]
|
|
542
|
+
* @property {string} [country_code]
|
|
567
543
|
* @property {string} [to]
|
|
568
544
|
*/
|
|
569
|
-
/**
|
|
570
|
-
* @typedef SendOtpCommsReqEmail
|
|
571
|
-
* @property {number} [expiry]
|
|
572
|
-
* @property {number} [otp_length]
|
|
573
|
-
* @property {SendOtpEmailCommsProvider} [provider]
|
|
574
|
-
* @property {SendOtpEmailCommsTemplate} [template]
|
|
575
|
-
*/
|
|
576
545
|
/**
|
|
577
546
|
* @typedef SendOtpCommsReqSms
|
|
578
|
-
* @property {number} [expiry]
|
|
579
547
|
* @property {number} [otp_length]
|
|
580
|
-
* @property {
|
|
548
|
+
* @property {number} [expiry]
|
|
581
549
|
* @property {SendOtpSmsCommsTemplate} [template]
|
|
550
|
+
* @property {SendOtpSmsCommsProvider} [provider]
|
|
582
551
|
*/
|
|
583
552
|
/**
|
|
584
|
-
* @typedef
|
|
585
|
-
* @property {
|
|
586
|
-
* @property {
|
|
553
|
+
* @typedef SendOtpCommsReqEmail
|
|
554
|
+
* @property {number} [otp_length]
|
|
555
|
+
* @property {number} [expiry]
|
|
556
|
+
* @property {SendOtpEmailCommsTemplate} [template]
|
|
557
|
+
* @property {SendOtpEmailCommsProvider} [provider]
|
|
587
558
|
*/
|
|
588
559
|
/**
|
|
589
|
-
* @typedef
|
|
590
|
-
* @property {
|
|
560
|
+
* @typedef SendOtpCommsResSms
|
|
561
|
+
* @property {boolean} [success]
|
|
591
562
|
* @property {string} [request_id]
|
|
563
|
+
* @property {string} [message]
|
|
564
|
+
* @property {string} [mobile]
|
|
565
|
+
* @property {string} [country_code]
|
|
592
566
|
* @property {number} [resend_timer]
|
|
593
|
-
* @property {boolean} [success]
|
|
594
|
-
* @property {string} [to]
|
|
595
567
|
*/
|
|
596
568
|
/**
|
|
597
|
-
* @typedef
|
|
598
|
-
* @property {
|
|
599
|
-
* @property {string} [message]
|
|
600
|
-
* @property {string} [mobile]
|
|
569
|
+
* @typedef SendOtpCommsResEmail
|
|
570
|
+
* @property {boolean} [success]
|
|
601
571
|
* @property {string} [request_id]
|
|
572
|
+
* @property {string} [message]
|
|
573
|
+
* @property {string} [to]
|
|
602
574
|
* @property {number} [resend_timer]
|
|
603
|
-
* @property {boolean} [success]
|
|
604
575
|
*/
|
|
605
576
|
/**
|
|
606
|
-
* @typedef
|
|
607
|
-
* @property {
|
|
608
|
-
* @property {
|
|
577
|
+
* @typedef SendOtpCommsReq
|
|
578
|
+
* @property {SendOtpCommsReqData} [data]
|
|
579
|
+
* @property {SendOtpCommsReqSms} [sms]
|
|
580
|
+
* @property {SendOtpCommsReqEmail} [email]
|
|
609
581
|
*/
|
|
610
582
|
/**
|
|
611
|
-
* @typedef
|
|
612
|
-
* @property {
|
|
613
|
-
* @property {
|
|
583
|
+
* @typedef SendOtpCommsRes
|
|
584
|
+
* @property {SendOtpCommsResSms} [sms]
|
|
585
|
+
* @property {SendOtpCommsResEmail} [email]
|
|
614
586
|
*/
|
|
615
587
|
/**
|
|
616
|
-
* @typedef
|
|
617
|
-
* @property {string} [
|
|
618
|
-
* @property {string} [
|
|
588
|
+
* @typedef VerifyOtpCommsReq
|
|
589
|
+
* @property {string} [request_id]
|
|
590
|
+
* @property {string} [otp]
|
|
619
591
|
*/
|
|
620
592
|
/**
|
|
621
|
-
* @typedef
|
|
622
|
-
* @property {
|
|
623
|
-
* @property {
|
|
593
|
+
* @typedef VerifyOtpCommsSuccessRes
|
|
594
|
+
* @property {boolean} [success]
|
|
595
|
+
* @property {string} [mobile]
|
|
596
|
+
* @property {string} [country_code]
|
|
597
|
+
* @property {string} [message]
|
|
624
598
|
*/
|
|
625
599
|
/**
|
|
626
|
-
* @typedef
|
|
627
|
-
* @property {
|
|
628
|
-
* @property {string} [
|
|
629
|
-
* @property {string} [application]
|
|
630
|
-
* @property {string} [authkey]
|
|
631
|
-
* @property {string} [created_at]
|
|
632
|
-
* @property {string} [description]
|
|
633
|
-
* @property {string} [name]
|
|
634
|
-
* @property {string} [provider]
|
|
635
|
-
* @property {number} [rpt]
|
|
636
|
-
* @property {string} [sender]
|
|
637
|
-
* @property {string} [slug]
|
|
638
|
-
* @property {string} [type]
|
|
639
|
-
* @property {string} [updated_at]
|
|
640
|
-
* @property {string} [username]
|
|
600
|
+
* @typedef VerifyOtpCommsErrorRes
|
|
601
|
+
* @property {boolean} [success]
|
|
602
|
+
* @property {string} [message]
|
|
641
603
|
*/
|
|
642
604
|
/**
|
|
643
605
|
* @typedef SmsProviderReq
|
|
644
|
-
* @property {string} [
|
|
645
|
-
* @property {string} [apikey] - The apikey for the test.
|
|
646
|
-
* @property {string} [authkey]
|
|
606
|
+
* @property {string} [name]
|
|
647
607
|
* @property {string} [description]
|
|
648
|
-
* @property {string} [
|
|
649
|
-
* @property {string} [
|
|
608
|
+
* @property {string} [sender]
|
|
609
|
+
* @property {string} [username]
|
|
610
|
+
* @property {string} [authkey]
|
|
611
|
+
* @property {string} [type]
|
|
612
|
+
* @property {string} [provider]
|
|
613
|
+
* @property {string} [password] - The password for the test.
|
|
614
|
+
* @property {string} [senderid] - The sender ID for the test.
|
|
650
615
|
* @property {string} [feedid] - The feed ID for the test.
|
|
651
|
-
* @property {string} [
|
|
652
|
-
* @property {string} [name]
|
|
616
|
+
* @property {string} [entityid] - The entity ID for the test.
|
|
653
617
|
* @property {boolean} [override_dnd] - Whether to override Do Not Disturb.
|
|
654
|
-
* @property {string} [
|
|
618
|
+
* @property {string} [host] - The host for the test.
|
|
655
619
|
* @property {number} [port] - The port for the test.
|
|
656
|
-
* @property {string} [
|
|
657
|
-
* @property {string} [
|
|
620
|
+
* @property {string} [entity_id] - The entity ID for the test.
|
|
621
|
+
* @property {string} [apikey] - The apikey for the test.
|
|
622
|
+
* @property {number} [version_id] - The version ID for the test.
|
|
658
623
|
* @property {string} [sender_id] - The sender ID for the test.
|
|
659
|
-
* @property {string} [
|
|
624
|
+
* @property {string} [api_key] - The api_key for the test.
|
|
625
|
+
*/
|
|
626
|
+
/**
|
|
627
|
+
* @typedef SmsProvider
|
|
628
|
+
* @property {number} [rpt]
|
|
660
629
|
* @property {string} [type]
|
|
630
|
+
* @property {string} [provider]
|
|
631
|
+
* @property {string} [_id]
|
|
632
|
+
* @property {string} [name]
|
|
633
|
+
* @property {string} [description]
|
|
634
|
+
* @property {string} [sender]
|
|
661
635
|
* @property {string} [username]
|
|
662
|
-
* @property {
|
|
636
|
+
* @property {string} [authkey]
|
|
637
|
+
* @property {string} [application]
|
|
638
|
+
* @property {string} [created_at]
|
|
639
|
+
* @property {string} [updated_at]
|
|
640
|
+
* @property {string} [slug]
|
|
641
|
+
* @property {number} [__v]
|
|
663
642
|
*/
|
|
664
643
|
/**
|
|
665
644
|
* @typedef SmsProviders
|
|
@@ -667,42 +646,15 @@ export = CommunicationPlatformModel;
|
|
|
667
646
|
* @property {Page} [page]
|
|
668
647
|
*/
|
|
669
648
|
/**
|
|
670
|
-
* @typedef
|
|
671
|
-
* @property {number} [__v]
|
|
649
|
+
* @typedef DefaultSmsProviders
|
|
672
650
|
* @property {string} [_id]
|
|
673
|
-
* @property {string} [application]
|
|
674
|
-
* @property {string} [category]
|
|
675
|
-
* @property {string} [created_at]
|
|
676
|
-
* @property {string} [description]
|
|
677
|
-
* @property {boolean} [is_internal]
|
|
678
|
-
* @property {boolean} [is_system]
|
|
679
|
-
* @property {SmsTemplateMessage} [message]
|
|
680
|
-
* @property {metaObj} [meta]
|
|
681
651
|
* @property {string} [name]
|
|
682
|
-
* @property {
|
|
683
|
-
* @property {boolean} [published]
|
|
684
|
-
* @property {string} [slug]
|
|
685
|
-
* @property {string[]} [tags]
|
|
686
|
-
* @property {string} [template_id]
|
|
687
|
-
* @property {Object} [template_variables]
|
|
688
|
-
* @property {string} [updated_at]
|
|
689
|
-
* @property {EnabledObj} [url_shorten]
|
|
652
|
+
* @property {boolean} [is_default]
|
|
690
653
|
*/
|
|
691
654
|
/**
|
|
692
655
|
* @typedef SmsTemplateMessage
|
|
693
|
-
* @property {string} [template]
|
|
694
656
|
* @property {string} [template_type]
|
|
695
|
-
|
|
696
|
-
/**
|
|
697
|
-
* @typedef SmsTemplateReq
|
|
698
|
-
* @property {string} [description]
|
|
699
|
-
* @property {SmsTemplateMessage} [message]
|
|
700
|
-
* @property {metaObj} [meta]
|
|
701
|
-
* @property {string} name
|
|
702
|
-
* @property {string} [priority]
|
|
703
|
-
* @property {boolean} [published]
|
|
704
|
-
* @property {string} [template_id]
|
|
705
|
-
* @property {Object} [template_variables]
|
|
657
|
+
* @property {string} [template]
|
|
706
658
|
*/
|
|
707
659
|
/**
|
|
708
660
|
* @typedef SmsTemplates
|
|
@@ -710,81 +662,72 @@ export = CommunicationPlatformModel;
|
|
|
710
662
|
* @property {Page} [page]
|
|
711
663
|
*/
|
|
712
664
|
/**
|
|
713
|
-
* @typedef
|
|
665
|
+
* @typedef SmsTemplate
|
|
666
|
+
* @property {EnabledObj} [url_shorten]
|
|
714
667
|
* @property {string} [_id]
|
|
715
|
-
* @property {
|
|
716
|
-
* @property {
|
|
717
|
-
|
|
718
|
-
|
|
719
|
-
* @
|
|
720
|
-
* @property {
|
|
721
|
-
|
|
722
|
-
|
|
723
|
-
* @
|
|
724
|
-
* @property {
|
|
725
|
-
* @property {
|
|
726
|
-
|
|
727
|
-
|
|
728
|
-
* @
|
|
729
|
-
* @property {
|
|
730
|
-
* @property {
|
|
731
|
-
* @property {number} [
|
|
732
|
-
*/
|
|
733
|
-
/**
|
|
734
|
-
* @typedef StatsProcessedSms
|
|
735
|
-
* @property {number} [failed]
|
|
736
|
-
* @property {number} [success]
|
|
737
|
-
* @property {number} [suppressed]
|
|
738
|
-
*/
|
|
739
|
-
/**
|
|
740
|
-
* @typedef SubscriptionsObject
|
|
741
|
-
* @property {string} [_id] - Subscription ID
|
|
742
|
-
* @property {TemplateObject} [template]
|
|
668
|
+
* @property {string} [application]
|
|
669
|
+
* @property {boolean} [is_system]
|
|
670
|
+
* @property {boolean} [is_internal]
|
|
671
|
+
* @property {metaObj} [meta]
|
|
672
|
+
* @property {string} [name]
|
|
673
|
+
* @property {string} [description]
|
|
674
|
+
* @property {SmsTemplateMessage} [message]
|
|
675
|
+
* @property {string} [priority]
|
|
676
|
+
* @property {string[]} [tags]
|
|
677
|
+
* @property {Object} [template_variables]
|
|
678
|
+
* @property {string} [template_id]
|
|
679
|
+
* @property {boolean} [published]
|
|
680
|
+
* @property {string} [category]
|
|
681
|
+
* @property {string} [created_at]
|
|
682
|
+
* @property {string} [updated_at]
|
|
683
|
+
* @property {string} [slug]
|
|
684
|
+
* @property {number} [__v]
|
|
743
685
|
*/
|
|
744
686
|
/**
|
|
745
|
-
* @typedef
|
|
746
|
-
* @property {
|
|
687
|
+
* @typedef SystemSmsTemplates
|
|
688
|
+
* @property {EnabledObj} [url_shorten]
|
|
747
689
|
* @property {string} [_id]
|
|
748
|
-
* @property {number[]} [attachments]
|
|
749
|
-
* @property {string} [category]
|
|
750
|
-
* @property {string} [created_at]
|
|
751
|
-
* @property {string} [description]
|
|
752
|
-
* @property {EmailTemplateHeaders[]} [headers]
|
|
753
|
-
* @property {TemplateAndType} [html]
|
|
754
|
-
* @property {boolean} [is_internal]
|
|
755
690
|
* @property {boolean} [is_system]
|
|
691
|
+
* @property {boolean} [is_internal]
|
|
756
692
|
* @property {string} [name]
|
|
693
|
+
* @property {string} [description]
|
|
694
|
+
* @property {SmsTemplateMessage} [message]
|
|
757
695
|
* @property {string} [priority]
|
|
758
|
-
* @property {boolean} [published]
|
|
759
|
-
* @property {string} [slug]
|
|
760
|
-
* @property {string[]} [static_bcc]
|
|
761
|
-
* @property {string[]} [static_cc]
|
|
762
|
-
* @property {string[]} [static_to]
|
|
763
|
-
* @property {TemplateAndType} [subject]
|
|
764
696
|
* @property {string[]} [tags]
|
|
765
697
|
* @property {Object} [template_variables]
|
|
766
|
-
* @property {
|
|
698
|
+
* @property {string} [template_id]
|
|
699
|
+
* @property {boolean} [published]
|
|
700
|
+
* @property {string} [category]
|
|
701
|
+
* @property {string} [created_at]
|
|
767
702
|
* @property {string} [updated_at]
|
|
768
|
-
* @property {
|
|
703
|
+
* @property {string} [slug]
|
|
704
|
+
* @property {number} [__v]
|
|
769
705
|
*/
|
|
770
706
|
/**
|
|
771
|
-
* @typedef
|
|
772
|
-
* @property {
|
|
707
|
+
* @typedef metaObj
|
|
708
|
+
* @property {string} [type]
|
|
709
|
+
* @property {boolean} [is_system]
|
|
710
|
+
* @property {string} [template]
|
|
773
711
|
*/
|
|
774
712
|
/**
|
|
775
|
-
* @typedef
|
|
776
|
-
* @property {string}
|
|
777
|
-
* @property {string} [
|
|
778
|
-
* @property {string} [
|
|
779
|
-
* @property {
|
|
780
|
-
* @property {
|
|
781
|
-
* @property {
|
|
713
|
+
* @typedef SmsTemplateReq
|
|
714
|
+
* @property {string} name
|
|
715
|
+
* @property {string} [description]
|
|
716
|
+
* @property {string} [priority]
|
|
717
|
+
* @property {string} [template_id]
|
|
718
|
+
* @property {metaObj} [meta]
|
|
719
|
+
* @property {Object} [template_variables]
|
|
720
|
+
* @property {boolean} [published]
|
|
721
|
+
* @property {SmsTemplateMessage} [message]
|
|
782
722
|
*/
|
|
783
723
|
/**
|
|
784
|
-
* @typedef
|
|
785
|
-
* @property {
|
|
786
|
-
* @property {
|
|
787
|
-
* @property {
|
|
724
|
+
* @typedef Notification
|
|
725
|
+
* @property {string} [title]
|
|
726
|
+
* @property {string} [body]
|
|
727
|
+
* @property {string} [subtitle]
|
|
728
|
+
* @property {string} [icon]
|
|
729
|
+
* @property {string} [deeplink]
|
|
730
|
+
* @property {string} [click_action]
|
|
788
731
|
*/
|
|
789
732
|
/**
|
|
790
733
|
* @typedef SystemNotificationUser
|
|
@@ -792,173 +735,162 @@ export = CommunicationPlatformModel;
|
|
|
792
735
|
* @property {string} [value]
|
|
793
736
|
*/
|
|
794
737
|
/**
|
|
795
|
-
* @typedef
|
|
796
|
-
* @property {
|
|
738
|
+
* @typedef SystemNotification
|
|
739
|
+
* @property {Notification} [notification]
|
|
740
|
+
* @property {SystemNotificationUser} [user]
|
|
741
|
+
* @property {SystemNotificationUser} [settings]
|
|
797
742
|
* @property {string} [_id]
|
|
798
|
-
* @property {string} [
|
|
743
|
+
* @property {string} [group]
|
|
799
744
|
* @property {string} [created_at]
|
|
800
|
-
* @property {string} [description]
|
|
801
|
-
* @property {boolean} [is_internal]
|
|
802
|
-
* @property {boolean} [is_system]
|
|
803
|
-
* @property {SmsTemplateMessage} [message]
|
|
804
|
-
* @property {string} [name]
|
|
805
|
-
* @property {string} [priority]
|
|
806
|
-
* @property {boolean} [published]
|
|
807
|
-
* @property {string} [slug]
|
|
808
|
-
* @property {string[]} [tags]
|
|
809
|
-
* @property {string} [template_id]
|
|
810
|
-
* @property {Object} [template_variables]
|
|
811
|
-
* @property {string} [updated_at]
|
|
812
|
-
* @property {EnabledObj} [url_shorten]
|
|
813
745
|
*/
|
|
814
746
|
/**
|
|
815
|
-
* @typedef
|
|
816
|
-
* @property {
|
|
817
|
-
* @property {
|
|
747
|
+
* @typedef SystemNotifications
|
|
748
|
+
* @property {SystemNotification[]} [items]
|
|
749
|
+
* @property {number} [last_read_anchor]
|
|
750
|
+
* @property {Page} [page]
|
|
818
751
|
*/
|
|
819
752
|
/**
|
|
820
|
-
* @typedef
|
|
821
|
-
* @property {
|
|
822
|
-
* @property {
|
|
823
|
-
* @property {
|
|
753
|
+
* @typedef Page
|
|
754
|
+
* @property {number} [item_total]
|
|
755
|
+
* @property {string} [next_id]
|
|
756
|
+
* @property {boolean} [has_previous]
|
|
757
|
+
* @property {boolean} [has_next]
|
|
758
|
+
* @property {number} [current]
|
|
759
|
+
* @property {string} type
|
|
760
|
+
* @property {number} [size]
|
|
824
761
|
*/
|
|
825
762
|
/**
|
|
826
|
-
* @typedef
|
|
827
|
-
* @property {
|
|
763
|
+
* @typedef GenericError
|
|
764
|
+
* @property {Message} [message]
|
|
765
|
+
* @property {string} [sentry]
|
|
828
766
|
*/
|
|
829
767
|
/**
|
|
830
|
-
* @typedef
|
|
831
|
-
* @property {
|
|
768
|
+
* @typedef GenericDelete
|
|
769
|
+
* @property {string} [message]
|
|
770
|
+
* @property {boolean} [acknowledged]
|
|
771
|
+
* @property {number} [affected]
|
|
772
|
+
* @property {string} [operation]
|
|
832
773
|
*/
|
|
833
774
|
/**
|
|
834
|
-
* @typedef
|
|
775
|
+
* @typedef Message
|
|
835
776
|
* @property {string} [message]
|
|
836
777
|
* @property {boolean} [success]
|
|
778
|
+
* @property {string} [info]
|
|
779
|
+
* @property {string} [operation]
|
|
837
780
|
*/
|
|
838
781
|
/**
|
|
839
|
-
* @typedef
|
|
840
|
-
* @property {
|
|
841
|
-
* @property {string} [request_id]
|
|
842
|
-
*/
|
|
843
|
-
/**
|
|
844
|
-
* @typedef VerifyOtpCommsSuccessRes
|
|
845
|
-
* @property {string} [country_code]
|
|
846
|
-
* @property {string} [message]
|
|
847
|
-
* @property {string} [mobile]
|
|
848
|
-
* @property {boolean} [success]
|
|
782
|
+
* @typedef EnabledObj
|
|
783
|
+
* @property {boolean} [enabled]
|
|
849
784
|
*/
|
|
850
785
|
declare class CommunicationPlatformModel {
|
|
851
786
|
}
|
|
852
787
|
declare namespace CommunicationPlatformModel {
|
|
853
|
-
export { AppProvider,
|
|
788
|
+
export { AppProvider, AppProviderRes, AppProviderResVoice, AppProviderResObj, GlobalProviders, GlobalProvidersResObj, AppProviderReq, StatsImported, StatsProcessedEmail, StatsProcessedSms, StatsProcessed, Stats, GetStats, CampaignReq, RecipientHeaders, CampaignEmailTemplate, CampignEmailProvider, CampaignEmail, Campaign, Campaigns, BadRequestSchema, NotFound, AudienceReq, Audience, Audiences, GetNRecordsCsvReq, GetNRecordsCsvResItems, GetNRecordsCsvRes, DummyDatasources, DummyDatasourcesMeta, DummyDatasourcesMetaObj, EmailProviderReqFrom, EmailProviderReq, EmailProvider, EmailProviders, EmailTemplateKeys, EmailTemplateHeaders, EmailTemplateReq, TemplateAndType, EmailTemplate, SystemEmailTemplate, EmailTemplates, SystemEmailTemplates, PayloadEmailTemplateStructure, PayloadEmailProviderStructure, PayloadEmailStructure, PayloadSmsTemplateStructure, PayloadSmsProviderStructure, PayloadSmsStructure, PayloadStructure, MetaStructure, EngineRequest, EngineResponse, EventSubscriptionTemplateSms, EventSubscriptionTemplateEmail, EventSubscriptionTemplate, EventSubscription, EventSubscriptions, TriggerJobResponse, TriggerJobRequest, GlobalVariablesGetResponse, GlobalVariablesPostResponse, GlobalVariablesReq, Job, Jobs, JobLog, JobLogs, LogEmail, LogPushnotification, LogMeta, Log, Logs, SendOtpSmsCommsTemplate, SendOtpSmsCommsProvider, SendOtpEmailCommsProvider, SendOtpEmailCommsTemplate, SendOtpCommsReqData, SendOtpCommsReqSms, SendOtpCommsReqEmail, SendOtpCommsResSms, SendOtpCommsResEmail, SendOtpCommsReq, SendOtpCommsRes, VerifyOtpCommsReq, VerifyOtpCommsSuccessRes, VerifyOtpCommsErrorRes, SmsProviderReq, SmsProvider, SmsProviders, DefaultSmsProviders, SmsTemplateMessage, SmsTemplates, SmsTemplate, SystemSmsTemplates, metaObj, SmsTemplateReq, Notification, SystemNotificationUser, SystemNotification, SystemNotifications, Page, GenericError, GenericDelete, Message, EnabledObj };
|
|
854
789
|
}
|
|
855
790
|
/** @returns {AppProvider} */
|
|
856
791
|
declare function AppProvider(): AppProvider;
|
|
857
792
|
type AppProvider = {
|
|
858
|
-
|
|
793
|
+
email?: AppProviderRes;
|
|
794
|
+
sms?: AppProviderRes;
|
|
795
|
+
voice?: AppProviderResVoice;
|
|
859
796
|
_id?: string;
|
|
860
797
|
application?: string;
|
|
861
798
|
created_at?: string;
|
|
862
|
-
email?: AppProviderRes;
|
|
863
|
-
sms?: AppProviderRes;
|
|
864
799
|
updated_at?: string;
|
|
865
|
-
|
|
866
|
-
};
|
|
867
|
-
/** @returns {AppProviderReq} */
|
|
868
|
-
declare function AppProviderReq(): AppProviderReq;
|
|
869
|
-
type AppProviderReq = {
|
|
870
|
-
email?: AppProviderRes;
|
|
871
|
-
sms?: AppProviderRes;
|
|
872
|
-
voice?: AppProviderResVoice;
|
|
800
|
+
__v?: number;
|
|
873
801
|
};
|
|
874
802
|
/** @returns {AppProviderRes} */
|
|
875
803
|
declare function AppProviderRes(): AppProviderRes;
|
|
876
804
|
type AppProviderRes = {
|
|
877
|
-
|
|
805
|
+
transaction?: AppProviderResObj;
|
|
878
806
|
promotional?: AppProviderResObj;
|
|
807
|
+
otp?: AppProviderResObj;
|
|
808
|
+
};
|
|
809
|
+
/** @returns {AppProviderResVoice} */
|
|
810
|
+
declare function AppProviderResVoice(): AppProviderResVoice;
|
|
811
|
+
type AppProviderResVoice = {
|
|
879
812
|
transaction?: AppProviderResObj;
|
|
813
|
+
otp?: AppProviderResObj;
|
|
880
814
|
};
|
|
881
815
|
/** @returns {AppProviderResObj} */
|
|
882
816
|
declare function AppProviderResObj(): AppProviderResObj;
|
|
883
817
|
type AppProviderResObj = {
|
|
884
818
|
provider?: string;
|
|
885
819
|
};
|
|
886
|
-
/** @returns {
|
|
887
|
-
declare function
|
|
888
|
-
type
|
|
889
|
-
|
|
890
|
-
|
|
820
|
+
/** @returns {GlobalProviders} */
|
|
821
|
+
declare function GlobalProviders(): GlobalProviders;
|
|
822
|
+
type GlobalProviders = {
|
|
823
|
+
email?: GlobalProvidersResObj[];
|
|
824
|
+
sms?: GlobalProvidersResObj[];
|
|
825
|
+
voice?: GlobalProvidersResObj[];
|
|
891
826
|
};
|
|
892
|
-
/** @returns {
|
|
893
|
-
declare function
|
|
894
|
-
type
|
|
895
|
-
__v?: number;
|
|
827
|
+
/** @returns {GlobalProvidersResObj} */
|
|
828
|
+
declare function GlobalProvidersResObj(): GlobalProvidersResObj;
|
|
829
|
+
type GlobalProvidersResObj = {
|
|
896
830
|
_id?: string;
|
|
897
|
-
application?: string;
|
|
898
|
-
created_at?: string;
|
|
899
|
-
description?: string;
|
|
900
|
-
file_url?: string;
|
|
901
|
-
headers?: string[];
|
|
902
|
-
is_active?: boolean;
|
|
903
831
|
name?: string;
|
|
904
|
-
records_count?: number;
|
|
905
|
-
slug?: string;
|
|
906
|
-
tags?: string[];
|
|
907
|
-
type?: string;
|
|
908
|
-
updated_at?: string;
|
|
909
832
|
};
|
|
910
|
-
/** @returns {
|
|
911
|
-
declare function
|
|
912
|
-
type
|
|
913
|
-
|
|
914
|
-
|
|
915
|
-
|
|
916
|
-
name?: string;
|
|
917
|
-
records_count?: number;
|
|
918
|
-
tags?: string[];
|
|
919
|
-
type?: string;
|
|
833
|
+
/** @returns {AppProviderReq} */
|
|
834
|
+
declare function AppProviderReq(): AppProviderReq;
|
|
835
|
+
type AppProviderReq = {
|
|
836
|
+
email?: AppProviderRes;
|
|
837
|
+
sms?: AppProviderRes;
|
|
838
|
+
voice?: AppProviderResVoice;
|
|
920
839
|
};
|
|
921
|
-
/** @returns {
|
|
922
|
-
declare function
|
|
923
|
-
type
|
|
924
|
-
|
|
925
|
-
page?: Page;
|
|
840
|
+
/** @returns {StatsImported} */
|
|
841
|
+
declare function StatsImported(): StatsImported;
|
|
842
|
+
type StatsImported = {
|
|
843
|
+
count?: number;
|
|
926
844
|
};
|
|
927
|
-
/** @returns {
|
|
928
|
-
declare function
|
|
929
|
-
type
|
|
930
|
-
|
|
931
|
-
|
|
932
|
-
|
|
933
|
-
message?: string;
|
|
934
|
-
/**
|
|
935
|
-
* - Response status.
|
|
936
|
-
*/
|
|
937
|
-
status?: string;
|
|
845
|
+
/** @returns {StatsProcessedEmail} */
|
|
846
|
+
declare function StatsProcessedEmail(): StatsProcessedEmail;
|
|
847
|
+
type StatsProcessedEmail = {
|
|
848
|
+
success?: number;
|
|
849
|
+
failed?: number;
|
|
850
|
+
suppressed?: number;
|
|
938
851
|
};
|
|
939
|
-
/** @returns {
|
|
940
|
-
declare function
|
|
941
|
-
type
|
|
942
|
-
|
|
852
|
+
/** @returns {StatsProcessedSms} */
|
|
853
|
+
declare function StatsProcessedSms(): StatsProcessedSms;
|
|
854
|
+
type StatsProcessedSms = {
|
|
855
|
+
success?: number;
|
|
856
|
+
failed?: number;
|
|
857
|
+
suppressed?: number;
|
|
858
|
+
};
|
|
859
|
+
/** @returns {StatsProcessed} */
|
|
860
|
+
declare function StatsProcessed(): StatsProcessed;
|
|
861
|
+
type StatsProcessed = {
|
|
862
|
+
email?: StatsProcessedEmail;
|
|
863
|
+
sms?: StatsProcessedSms;
|
|
864
|
+
};
|
|
865
|
+
/** @returns {Stats} */
|
|
866
|
+
declare function Stats(): Stats;
|
|
867
|
+
type Stats = {
|
|
943
868
|
_id?: string;
|
|
944
|
-
|
|
945
|
-
|
|
946
|
-
|
|
869
|
+
imported?: any;
|
|
870
|
+
processed?: any;
|
|
871
|
+
};
|
|
872
|
+
/** @returns {GetStats} */
|
|
873
|
+
declare function GetStats(): GetStats;
|
|
874
|
+
type GetStats = {
|
|
875
|
+
items?: Stats[];
|
|
876
|
+
};
|
|
877
|
+
/** @returns {CampaignReq} */
|
|
878
|
+
declare function CampaignReq(): CampaignReq;
|
|
879
|
+
type CampaignReq = {
|
|
947
880
|
description?: string;
|
|
948
|
-
|
|
881
|
+
tags?: string[];
|
|
882
|
+
headers?: string[];
|
|
949
883
|
is_active?: boolean;
|
|
950
884
|
name?: string;
|
|
951
|
-
|
|
952
|
-
slug?: string;
|
|
953
|
-
tags?: any[];
|
|
885
|
+
file_url?: string;
|
|
954
886
|
type?: string;
|
|
955
|
-
|
|
887
|
+
records_count?: number;
|
|
888
|
+
application?: string;
|
|
956
889
|
};
|
|
957
|
-
/** @returns {
|
|
958
|
-
declare function
|
|
959
|
-
type
|
|
960
|
-
|
|
961
|
-
template?: CampaignEmailTemplate;
|
|
890
|
+
/** @returns {RecipientHeaders} */
|
|
891
|
+
declare function RecipientHeaders(): RecipientHeaders;
|
|
892
|
+
type RecipientHeaders = {
|
|
893
|
+
email?: string;
|
|
962
894
|
};
|
|
963
895
|
/** @returns {CampaignEmailTemplate} */
|
|
964
896
|
declare function CampaignEmailTemplate(): CampaignEmailTemplate;
|
|
@@ -966,18 +898,36 @@ type CampaignEmailTemplate = {
|
|
|
966
898
|
key?: string;
|
|
967
899
|
value?: string;
|
|
968
900
|
};
|
|
969
|
-
/** @returns {
|
|
970
|
-
declare function
|
|
971
|
-
type
|
|
972
|
-
|
|
901
|
+
/** @returns {CampignEmailProvider} */
|
|
902
|
+
declare function CampignEmailProvider(): CampignEmailProvider;
|
|
903
|
+
type CampignEmailProvider = {
|
|
904
|
+
_id?: string;
|
|
905
|
+
from_name?: string;
|
|
906
|
+
from_email?: string;
|
|
907
|
+
};
|
|
908
|
+
/** @returns {CampaignEmail} */
|
|
909
|
+
declare function CampaignEmail(): CampaignEmail;
|
|
910
|
+
type CampaignEmail = {
|
|
911
|
+
template?: CampaignEmailTemplate;
|
|
912
|
+
provider?: CampignEmailProvider;
|
|
913
|
+
};
|
|
914
|
+
/** @returns {Campaign} */
|
|
915
|
+
declare function Campaign(): Campaign;
|
|
916
|
+
type Campaign = {
|
|
917
|
+
recipient_headers?: RecipientHeaders;
|
|
918
|
+
email?: CampaignEmail;
|
|
973
919
|
description?: string;
|
|
974
|
-
|
|
975
|
-
headers?: string[];
|
|
920
|
+
tags?: any[];
|
|
976
921
|
is_active?: boolean;
|
|
977
|
-
|
|
978
|
-
|
|
979
|
-
tags?: string[];
|
|
922
|
+
_id?: string;
|
|
923
|
+
datasource?: string;
|
|
980
924
|
type?: string;
|
|
925
|
+
name?: string;
|
|
926
|
+
application?: string;
|
|
927
|
+
created_at?: string;
|
|
928
|
+
updated_at?: string;
|
|
929
|
+
slug?: string;
|
|
930
|
+
__v?: number;
|
|
981
931
|
};
|
|
982
932
|
/** @returns {Campaigns} */
|
|
983
933
|
declare function Campaigns(): Campaigns;
|
|
@@ -985,48 +935,81 @@ type Campaigns = {
|
|
|
985
935
|
items?: Campaign[];
|
|
986
936
|
page?: Page;
|
|
987
937
|
};
|
|
988
|
-
/** @returns {
|
|
989
|
-
declare function
|
|
990
|
-
type
|
|
991
|
-
_id?: string;
|
|
992
|
-
from_email?: string;
|
|
993
|
-
from_name?: string;
|
|
994
|
-
};
|
|
995
|
-
/** @returns {CommunicationTemplate} */
|
|
996
|
-
declare function CommunicationTemplate(): CommunicationTemplate;
|
|
997
|
-
type CommunicationTemplate = {
|
|
938
|
+
/** @returns {BadRequestSchema} */
|
|
939
|
+
declare function BadRequestSchema(): BadRequestSchema;
|
|
940
|
+
type BadRequestSchema = {
|
|
998
941
|
/**
|
|
999
|
-
* -
|
|
942
|
+
* - Response status.
|
|
1000
943
|
*/
|
|
1001
|
-
|
|
944
|
+
status?: string;
|
|
1002
945
|
/**
|
|
1003
|
-
* -
|
|
946
|
+
* - Failure message.
|
|
1004
947
|
*/
|
|
1005
|
-
|
|
948
|
+
message?: string;
|
|
1006
949
|
};
|
|
1007
|
-
/** @returns {
|
|
1008
|
-
declare function
|
|
1009
|
-
type
|
|
1010
|
-
|
|
950
|
+
/** @returns {NotFound} */
|
|
951
|
+
declare function NotFound(): NotFound;
|
|
952
|
+
type NotFound = {
|
|
953
|
+
/**
|
|
954
|
+
* - Failure message.
|
|
955
|
+
*/
|
|
956
|
+
message?: string;
|
|
1011
957
|
};
|
|
1012
|
-
/** @returns {
|
|
1013
|
-
declare function
|
|
1014
|
-
type
|
|
1015
|
-
|
|
958
|
+
/** @returns {AudienceReq} */
|
|
959
|
+
declare function AudienceReq(): AudienceReq;
|
|
960
|
+
type AudienceReq = {
|
|
961
|
+
name?: string;
|
|
962
|
+
description?: string;
|
|
963
|
+
tags?: string[];
|
|
964
|
+
file_url?: string;
|
|
965
|
+
type?: string;
|
|
966
|
+
records_count?: number;
|
|
967
|
+
headers?: string[];
|
|
968
|
+
};
|
|
969
|
+
/** @returns {Audience} */
|
|
970
|
+
declare function Audience(): Audience;
|
|
971
|
+
type Audience = {
|
|
1016
972
|
_id?: string;
|
|
1017
973
|
application?: string;
|
|
1018
|
-
|
|
1019
|
-
|
|
1020
|
-
|
|
974
|
+
name?: string;
|
|
975
|
+
description?: string;
|
|
976
|
+
records_count?: number;
|
|
977
|
+
type?: string;
|
|
978
|
+
tags?: string[];
|
|
979
|
+
headers?: string[];
|
|
980
|
+
file_url?: string;
|
|
1021
981
|
is_active?: boolean;
|
|
982
|
+
created_at?: string;
|
|
1022
983
|
updated_at?: string;
|
|
984
|
+
slug?: string;
|
|
985
|
+
__v?: number;
|
|
1023
986
|
};
|
|
1024
|
-
/** @returns {
|
|
1025
|
-
declare function
|
|
1026
|
-
type
|
|
1027
|
-
|
|
1028
|
-
|
|
1029
|
-
|
|
987
|
+
/** @returns {Audiences} */
|
|
988
|
+
declare function Audiences(): Audiences;
|
|
989
|
+
type Audiences = {
|
|
990
|
+
items?: Audience[];
|
|
991
|
+
page?: Page;
|
|
992
|
+
};
|
|
993
|
+
/** @returns {GetNRecordsCsvReq} */
|
|
994
|
+
declare function GetNRecordsCsvReq(): GetNRecordsCsvReq;
|
|
995
|
+
type GetNRecordsCsvReq = {
|
|
996
|
+
url?: string;
|
|
997
|
+
header?: boolean;
|
|
998
|
+
count?: number;
|
|
999
|
+
};
|
|
1000
|
+
/** @returns {GetNRecordsCsvResItems} */
|
|
1001
|
+
declare function GetNRecordsCsvResItems(): GetNRecordsCsvResItems;
|
|
1002
|
+
type GetNRecordsCsvResItems = {
|
|
1003
|
+
phone_number?: string;
|
|
1004
|
+
email?: string;
|
|
1005
|
+
firstname?: string;
|
|
1006
|
+
lastname?: string;
|
|
1007
|
+
orderid?: string;
|
|
1008
|
+
};
|
|
1009
|
+
/** @returns {GetNRecordsCsvRes} */
|
|
1010
|
+
declare function GetNRecordsCsvRes(): GetNRecordsCsvRes;
|
|
1011
|
+
type GetNRecordsCsvRes = {
|
|
1012
|
+
items?: GetNRecordsCsvResItems[];
|
|
1030
1013
|
};
|
|
1031
1014
|
/** @returns {DummyDatasources} */
|
|
1032
1015
|
declare function DummyDatasources(): DummyDatasources;
|
|
@@ -1037,46 +1020,46 @@ type DummyDatasources = {
|
|
|
1037
1020
|
/** @returns {DummyDatasourcesMeta} */
|
|
1038
1021
|
declare function DummyDatasourcesMeta(): DummyDatasourcesMeta;
|
|
1039
1022
|
type DummyDatasourcesMeta = {
|
|
1040
|
-
data?: DummyDatasourcesMetaObj;
|
|
1041
1023
|
id?: number;
|
|
1024
|
+
data?: DummyDatasourcesMetaObj;
|
|
1042
1025
|
};
|
|
1043
1026
|
/** @returns {DummyDatasourcesMetaObj} */
|
|
1044
1027
|
declare function DummyDatasourcesMetaObj(): DummyDatasourcesMetaObj;
|
|
1045
1028
|
type DummyDatasourcesMetaObj = {
|
|
1046
1029
|
b?: number;
|
|
1047
1030
|
};
|
|
1048
|
-
/** @returns {
|
|
1049
|
-
declare function
|
|
1050
|
-
type
|
|
1051
|
-
__v?: number;
|
|
1052
|
-
_id?: string;
|
|
1053
|
-
api_key?: string;
|
|
1054
|
-
application?: string;
|
|
1055
|
-
created_at?: string;
|
|
1056
|
-
description?: string;
|
|
1057
|
-
from_address?: EmailProviderReqFrom[];
|
|
1031
|
+
/** @returns {EmailProviderReqFrom} */
|
|
1032
|
+
declare function EmailProviderReqFrom(): EmailProviderReqFrom;
|
|
1033
|
+
type EmailProviderReqFrom = {
|
|
1058
1034
|
name?: string;
|
|
1059
|
-
|
|
1060
|
-
|
|
1061
|
-
type?: string;
|
|
1062
|
-
updated_at?: string;
|
|
1035
|
+
email?: string;
|
|
1036
|
+
is_default?: boolean;
|
|
1063
1037
|
};
|
|
1064
1038
|
/** @returns {EmailProviderReq} */
|
|
1065
1039
|
declare function EmailProviderReq(): EmailProviderReq;
|
|
1066
1040
|
type EmailProviderReq = {
|
|
1067
|
-
api_key?: string;
|
|
1068
|
-
description?: string;
|
|
1069
|
-
from_address?: EmailProviderReqFrom[];
|
|
1070
1041
|
name?: string;
|
|
1071
|
-
|
|
1042
|
+
description?: string;
|
|
1043
|
+
api_key?: string;
|
|
1072
1044
|
type?: string;
|
|
1045
|
+
provider?: string;
|
|
1046
|
+
from_address?: EmailProviderReqFrom[];
|
|
1073
1047
|
};
|
|
1074
|
-
/** @returns {
|
|
1075
|
-
declare function
|
|
1076
|
-
type
|
|
1077
|
-
|
|
1078
|
-
|
|
1048
|
+
/** @returns {EmailProvider} */
|
|
1049
|
+
declare function EmailProvider(): EmailProvider;
|
|
1050
|
+
type EmailProvider = {
|
|
1051
|
+
type?: string;
|
|
1052
|
+
provider?: string;
|
|
1053
|
+
from_address?: EmailProviderReqFrom[];
|
|
1054
|
+
_id?: string;
|
|
1079
1055
|
name?: string;
|
|
1056
|
+
description?: string;
|
|
1057
|
+
api_key?: string;
|
|
1058
|
+
application?: string;
|
|
1059
|
+
created_at?: string;
|
|
1060
|
+
updated_at?: string;
|
|
1061
|
+
slug?: string;
|
|
1062
|
+
__v?: number;
|
|
1080
1063
|
};
|
|
1081
1064
|
/** @returns {EmailProviders} */
|
|
1082
1065
|
declare function EmailProviders(): EmailProviders;
|
|
@@ -1084,37 +1067,12 @@ type EmailProviders = {
|
|
|
1084
1067
|
items?: EmailProvider[];
|
|
1085
1068
|
page?: Page;
|
|
1086
1069
|
};
|
|
1087
|
-
/** @returns {
|
|
1088
|
-
declare function
|
|
1089
|
-
type
|
|
1090
|
-
|
|
1091
|
-
|
|
1092
|
-
|
|
1093
|
-
attachments?: number[];
|
|
1094
|
-
category?: string;
|
|
1095
|
-
created_at?: string;
|
|
1096
|
-
description?: string;
|
|
1097
|
-
editor_meta?: string;
|
|
1098
|
-
editor_type?: string;
|
|
1099
|
-
from_name?: string;
|
|
1100
|
-
headers?: EmailTemplateHeaders[];
|
|
1101
|
-
html?: TemplateAndType;
|
|
1102
|
-
is_internal?: boolean;
|
|
1103
|
-
is_system?: boolean;
|
|
1104
|
-
name?: string;
|
|
1105
|
-
priority?: string;
|
|
1106
|
-
published?: boolean;
|
|
1107
|
-
reply_to?: string;
|
|
1108
|
-
slug?: string;
|
|
1109
|
-
static_bcc?: string[];
|
|
1110
|
-
static_cc?: string[];
|
|
1111
|
-
static_to?: string[];
|
|
1112
|
-
subject?: TemplateAndType;
|
|
1113
|
-
tags?: string[];
|
|
1114
|
-
template_variables?: any;
|
|
1115
|
-
text?: TemplateAndType;
|
|
1116
|
-
updated_at?: string;
|
|
1117
|
-
url_shorten?: EnabledObj;
|
|
1070
|
+
/** @returns {EmailTemplateKeys} */
|
|
1071
|
+
declare function EmailTemplateKeys(): EmailTemplateKeys;
|
|
1072
|
+
type EmailTemplateKeys = {
|
|
1073
|
+
to?: string;
|
|
1074
|
+
cc?: string;
|
|
1075
|
+
bcc?: string;
|
|
1118
1076
|
};
|
|
1119
1077
|
/** @returns {EmailTemplateHeaders} */
|
|
1120
1078
|
declare function EmailTemplateHeaders(): EmailTemplateHeaders;
|
|
@@ -1122,34 +1080,92 @@ type EmailTemplateHeaders = {
|
|
|
1122
1080
|
key?: string;
|
|
1123
1081
|
value?: string;
|
|
1124
1082
|
};
|
|
1125
|
-
/** @returns {EmailTemplateKeys} */
|
|
1126
|
-
declare function EmailTemplateKeys(): EmailTemplateKeys;
|
|
1127
|
-
type EmailTemplateKeys = {
|
|
1128
|
-
bcc?: string;
|
|
1129
|
-
cc?: string;
|
|
1130
|
-
to?: string;
|
|
1131
|
-
};
|
|
1132
1083
|
/** @returns {EmailTemplateReq} */
|
|
1133
1084
|
declare function EmailTemplateReq(): EmailTemplateReq;
|
|
1134
1085
|
type EmailTemplateReq = {
|
|
1135
|
-
|
|
1086
|
+
name: string;
|
|
1136
1087
|
description?: string;
|
|
1137
|
-
editor_meta?: string;
|
|
1138
|
-
editor_type?: string;
|
|
1139
1088
|
from_name?: string;
|
|
1140
|
-
|
|
1089
|
+
static_to?: string[];
|
|
1090
|
+
static_cc?: string[];
|
|
1091
|
+
static_bcc?: string[];
|
|
1092
|
+
reply_to?: string;
|
|
1093
|
+
priority?: string;
|
|
1094
|
+
tags?: string[];
|
|
1095
|
+
template_variables?: any;
|
|
1096
|
+
published?: boolean;
|
|
1097
|
+
subject?: TemplateAndType;
|
|
1141
1098
|
html?: TemplateAndType;
|
|
1099
|
+
editor_type?: string;
|
|
1100
|
+
editor_meta?: string;
|
|
1101
|
+
attachments?: number[];
|
|
1102
|
+
headers?: EmailTemplateHeaders[];
|
|
1142
1103
|
keys?: EmailTemplateKeys;
|
|
1143
|
-
|
|
1104
|
+
text?: TemplateAndType;
|
|
1105
|
+
};
|
|
1106
|
+
/** @returns {TemplateAndType} */
|
|
1107
|
+
declare function TemplateAndType(): TemplateAndType;
|
|
1108
|
+
type TemplateAndType = {
|
|
1109
|
+
template_type?: string;
|
|
1110
|
+
template?: string;
|
|
1111
|
+
};
|
|
1112
|
+
/** @returns {EmailTemplate} */
|
|
1113
|
+
declare function EmailTemplate(): EmailTemplate;
|
|
1114
|
+
type EmailTemplate = {
|
|
1115
|
+
application?: string;
|
|
1116
|
+
is_system?: boolean;
|
|
1117
|
+
is_internal?: boolean;
|
|
1118
|
+
name?: string;
|
|
1119
|
+
description?: string;
|
|
1120
|
+
editor_type?: string;
|
|
1121
|
+
editor_meta?: string;
|
|
1122
|
+
static_to?: string[];
|
|
1123
|
+
static_cc?: string[];
|
|
1124
|
+
static_bcc?: string[];
|
|
1125
|
+
reply_to?: string;
|
|
1126
|
+
tags?: string[];
|
|
1127
|
+
subject?: TemplateAndType;
|
|
1128
|
+
html?: TemplateAndType;
|
|
1129
|
+
url_shorten?: EnabledObj;
|
|
1144
1130
|
priority?: string;
|
|
1131
|
+
template_variables?: any;
|
|
1145
1132
|
published?: boolean;
|
|
1146
|
-
|
|
1147
|
-
|
|
1148
|
-
|
|
1133
|
+
category?: string;
|
|
1134
|
+
_id?: string;
|
|
1135
|
+
headers?: EmailTemplateHeaders[];
|
|
1136
|
+
attachments?: number[];
|
|
1137
|
+
created_at?: string;
|
|
1138
|
+
updated_at?: string;
|
|
1139
|
+
slug?: string;
|
|
1140
|
+
__v?: number;
|
|
1141
|
+
from_name?: string;
|
|
1142
|
+
text?: TemplateAndType;
|
|
1143
|
+
};
|
|
1144
|
+
/** @returns {SystemEmailTemplate} */
|
|
1145
|
+
declare function SystemEmailTemplate(): SystemEmailTemplate;
|
|
1146
|
+
type SystemEmailTemplate = {
|
|
1147
|
+
is_system?: boolean;
|
|
1148
|
+
is_internal?: boolean;
|
|
1149
|
+
name?: string;
|
|
1150
|
+
description?: string;
|
|
1149
1151
|
static_to?: string[];
|
|
1150
|
-
|
|
1152
|
+
static_cc?: string[];
|
|
1153
|
+
static_bcc?: string[];
|
|
1151
1154
|
tags?: string[];
|
|
1155
|
+
subject?: TemplateAndType;
|
|
1156
|
+
html?: TemplateAndType;
|
|
1157
|
+
url_shorten?: EnabledObj;
|
|
1158
|
+
priority?: string;
|
|
1152
1159
|
template_variables?: any;
|
|
1160
|
+
published?: boolean;
|
|
1161
|
+
category?: string;
|
|
1162
|
+
_id?: string;
|
|
1163
|
+
headers?: EmailTemplateHeaders[];
|
|
1164
|
+
attachments?: number[];
|
|
1165
|
+
created_at?: string;
|
|
1166
|
+
updated_at?: string;
|
|
1167
|
+
slug?: string;
|
|
1168
|
+
__v?: number;
|
|
1153
1169
|
text?: TemplateAndType;
|
|
1154
1170
|
};
|
|
1155
1171
|
/** @returns {EmailTemplates} */
|
|
@@ -1158,34 +1174,102 @@ type EmailTemplates = {
|
|
|
1158
1174
|
items?: EmailTemplate[];
|
|
1159
1175
|
page?: Page;
|
|
1160
1176
|
};
|
|
1161
|
-
/** @returns {
|
|
1162
|
-
declare function
|
|
1163
|
-
type
|
|
1164
|
-
|
|
1177
|
+
/** @returns {SystemEmailTemplates} */
|
|
1178
|
+
declare function SystemEmailTemplates(): SystemEmailTemplates;
|
|
1179
|
+
type SystemEmailTemplates = {
|
|
1180
|
+
items?: SystemEmailTemplate[];
|
|
1181
|
+
};
|
|
1182
|
+
/** @returns {PayloadEmailTemplateStructure} */
|
|
1183
|
+
declare function PayloadEmailTemplateStructure(): PayloadEmailTemplateStructure;
|
|
1184
|
+
type PayloadEmailTemplateStructure = {
|
|
1185
|
+
key?: string;
|
|
1186
|
+
value?: any;
|
|
1187
|
+
};
|
|
1188
|
+
/** @returns {PayloadEmailProviderStructure} */
|
|
1189
|
+
declare function PayloadEmailProviderStructure(): PayloadEmailProviderStructure;
|
|
1190
|
+
type PayloadEmailProviderStructure = {
|
|
1191
|
+
_id?: string;
|
|
1192
|
+
};
|
|
1193
|
+
/** @returns {PayloadEmailStructure} */
|
|
1194
|
+
declare function PayloadEmailStructure(): PayloadEmailStructure;
|
|
1195
|
+
type PayloadEmailStructure = {
|
|
1196
|
+
template?: PayloadEmailTemplateStructure;
|
|
1197
|
+
provider?: PayloadEmailProviderStructure;
|
|
1198
|
+
};
|
|
1199
|
+
/** @returns {PayloadSmsTemplateStructure} */
|
|
1200
|
+
declare function PayloadSmsTemplateStructure(): PayloadSmsTemplateStructure;
|
|
1201
|
+
type PayloadSmsTemplateStructure = {
|
|
1202
|
+
key?: string;
|
|
1203
|
+
value?: any;
|
|
1204
|
+
};
|
|
1205
|
+
/** @returns {PayloadSmsProviderStructure} */
|
|
1206
|
+
declare function PayloadSmsProviderStructure(): PayloadSmsProviderStructure;
|
|
1207
|
+
type PayloadSmsProviderStructure = {
|
|
1208
|
+
_id?: string;
|
|
1209
|
+
};
|
|
1210
|
+
/** @returns {PayloadSmsStructure} */
|
|
1211
|
+
declare function PayloadSmsStructure(): PayloadSmsStructure;
|
|
1212
|
+
type PayloadSmsStructure = {
|
|
1213
|
+
template?: PayloadSmsTemplateStructure;
|
|
1214
|
+
provider?: PayloadSmsProviderStructure;
|
|
1215
|
+
};
|
|
1216
|
+
/** @returns {PayloadStructure} */
|
|
1217
|
+
declare function PayloadStructure(): PayloadStructure;
|
|
1218
|
+
type PayloadStructure = {
|
|
1219
|
+
data?: any[];
|
|
1220
|
+
email?: PayloadEmailStructure;
|
|
1221
|
+
sms?: PayloadSmsStructure;
|
|
1222
|
+
application?: string;
|
|
1223
|
+
};
|
|
1224
|
+
/** @returns {MetaStructure} */
|
|
1225
|
+
declare function MetaStructure(): MetaStructure;
|
|
1226
|
+
type MetaStructure = {
|
|
1227
|
+
job_type?: string;
|
|
1228
|
+
action?: string;
|
|
1229
|
+
trace?: string;
|
|
1230
|
+
timestamp?: string;
|
|
1165
1231
|
};
|
|
1166
1232
|
/** @returns {EngineRequest} */
|
|
1167
1233
|
declare function EngineRequest(): EngineRequest;
|
|
1168
1234
|
type EngineRequest = {
|
|
1169
|
-
meta?: MetaStructure;
|
|
1170
1235
|
payload?: PayloadStructure;
|
|
1236
|
+
meta?: MetaStructure;
|
|
1171
1237
|
};
|
|
1172
1238
|
/** @returns {EngineResponse} */
|
|
1173
1239
|
declare function EngineResponse(): EngineResponse;
|
|
1174
1240
|
type EngineResponse = {
|
|
1175
1241
|
success?: boolean;
|
|
1176
1242
|
};
|
|
1243
|
+
/** @returns {EventSubscriptionTemplateSms} */
|
|
1244
|
+
declare function EventSubscriptionTemplateSms(): EventSubscriptionTemplateSms;
|
|
1245
|
+
type EventSubscriptionTemplateSms = {
|
|
1246
|
+
subscribed?: boolean;
|
|
1247
|
+
template?: string;
|
|
1248
|
+
};
|
|
1249
|
+
/** @returns {EventSubscriptionTemplateEmail} */
|
|
1250
|
+
declare function EventSubscriptionTemplateEmail(): EventSubscriptionTemplateEmail;
|
|
1251
|
+
type EventSubscriptionTemplateEmail = {
|
|
1252
|
+
subscribed?: boolean;
|
|
1253
|
+
template?: string;
|
|
1254
|
+
};
|
|
1255
|
+
/** @returns {EventSubscriptionTemplate} */
|
|
1256
|
+
declare function EventSubscriptionTemplate(): EventSubscriptionTemplate;
|
|
1257
|
+
type EventSubscriptionTemplate = {
|
|
1258
|
+
sms?: EventSubscriptionTemplateSms;
|
|
1259
|
+
email?: EventSubscriptionTemplateEmail;
|
|
1260
|
+
};
|
|
1177
1261
|
/** @returns {EventSubscription} */
|
|
1178
1262
|
declare function EventSubscription(): EventSubscription;
|
|
1179
1263
|
type EventSubscription = {
|
|
1180
|
-
|
|
1264
|
+
template?: EventSubscriptionTemplate;
|
|
1265
|
+
is_default?: boolean;
|
|
1181
1266
|
_id?: string;
|
|
1182
1267
|
application?: string;
|
|
1183
|
-
created_at?: string;
|
|
1184
1268
|
event?: string;
|
|
1185
|
-
is_default?: boolean;
|
|
1186
1269
|
slug?: string;
|
|
1187
|
-
|
|
1270
|
+
created_at?: string;
|
|
1188
1271
|
updated_at?: string;
|
|
1272
|
+
__v?: number;
|
|
1189
1273
|
};
|
|
1190
1274
|
/** @returns {EventSubscriptions} */
|
|
1191
1275
|
declare function EventSubscriptions(): EventSubscriptions;
|
|
@@ -1193,138 +1277,65 @@ type EventSubscriptions = {
|
|
|
1193
1277
|
items?: EventSubscription[];
|
|
1194
1278
|
page?: Page;
|
|
1195
1279
|
};
|
|
1196
|
-
/** @returns {
|
|
1197
|
-
declare function
|
|
1198
|
-
type
|
|
1199
|
-
|
|
1280
|
+
/** @returns {TriggerJobResponse} */
|
|
1281
|
+
declare function TriggerJobResponse(): TriggerJobResponse;
|
|
1282
|
+
type TriggerJobResponse = {
|
|
1283
|
+
status?: number;
|
|
1284
|
+
};
|
|
1285
|
+
/** @returns {TriggerJobRequest} */
|
|
1286
|
+
declare function TriggerJobRequest(): TriggerJobRequest;
|
|
1287
|
+
type TriggerJobRequest = {
|
|
1288
|
+
job_id?: string;
|
|
1200
1289
|
};
|
|
1201
|
-
/** @returns {
|
|
1202
|
-
declare function
|
|
1203
|
-
type
|
|
1204
|
-
|
|
1290
|
+
/** @returns {GlobalVariablesGetResponse} */
|
|
1291
|
+
declare function GlobalVariablesGetResponse(): GlobalVariablesGetResponse;
|
|
1292
|
+
type GlobalVariablesGetResponse = {
|
|
1293
|
+
read_only?: any;
|
|
1294
|
+
editable?: any;
|
|
1295
|
+
};
|
|
1296
|
+
/** @returns {GlobalVariablesPostResponse} */
|
|
1297
|
+
declare function GlobalVariablesPostResponse(): GlobalVariablesPostResponse;
|
|
1298
|
+
type GlobalVariablesPostResponse = {
|
|
1205
1299
|
_id?: string;
|
|
1206
|
-
application?: string;
|
|
1207
1300
|
category?: string;
|
|
1301
|
+
application?: string;
|
|
1302
|
+
global_variables?: any;
|
|
1208
1303
|
created_at?: string;
|
|
1209
|
-
event?: string;
|
|
1210
|
-
slug?: string;
|
|
1211
|
-
template?: EventSubscriptionTemplate;
|
|
1212
|
-
updated_at?: string;
|
|
1213
|
-
};
|
|
1214
|
-
/** @returns {EventSubscriptionTemplate} */
|
|
1215
|
-
declare function EventSubscriptionTemplate(): EventSubscriptionTemplate;
|
|
1216
|
-
type EventSubscriptionTemplate = {
|
|
1217
|
-
email?: EventSubscriptionTemplateEmail;
|
|
1218
|
-
sms?: EventSubscriptionTemplateSms;
|
|
1219
1304
|
};
|
|
1220
|
-
/** @returns {
|
|
1221
|
-
declare function
|
|
1222
|
-
type
|
|
1223
|
-
|
|
1224
|
-
template?: string;
|
|
1225
|
-
};
|
|
1226
|
-
/** @returns {EventSubscriptionTemplateSms} */
|
|
1227
|
-
declare function EventSubscriptionTemplateSms(): EventSubscriptionTemplateSms;
|
|
1228
|
-
type EventSubscriptionTemplateSms = {
|
|
1229
|
-
subscribed?: boolean;
|
|
1230
|
-
template?: string;
|
|
1231
|
-
};
|
|
1232
|
-
/** @returns {GenericDelete} */
|
|
1233
|
-
declare function GenericDelete(): GenericDelete;
|
|
1234
|
-
type GenericDelete = {
|
|
1235
|
-
acknowledged?: boolean;
|
|
1236
|
-
affected?: number;
|
|
1237
|
-
message?: string;
|
|
1238
|
-
operation?: string;
|
|
1239
|
-
};
|
|
1240
|
-
/** @returns {GenericError} */
|
|
1241
|
-
declare function GenericError(): GenericError;
|
|
1242
|
-
type GenericError = {
|
|
1243
|
-
message?: Message;
|
|
1244
|
-
sentry?: string;
|
|
1245
|
-
};
|
|
1246
|
-
/** @returns {GetNRecordsCsvReq} */
|
|
1247
|
-
declare function GetNRecordsCsvReq(): GetNRecordsCsvReq;
|
|
1248
|
-
type GetNRecordsCsvReq = {
|
|
1249
|
-
count?: number;
|
|
1250
|
-
header?: boolean;
|
|
1251
|
-
url?: string;
|
|
1252
|
-
};
|
|
1253
|
-
/** @returns {GetNRecordsCsvRes} */
|
|
1254
|
-
declare function GetNRecordsCsvRes(): GetNRecordsCsvRes;
|
|
1255
|
-
type GetNRecordsCsvRes = {
|
|
1256
|
-
items?: GetNRecordsCsvResItems[];
|
|
1257
|
-
};
|
|
1258
|
-
/** @returns {GetNRecordsCsvResItems} */
|
|
1259
|
-
declare function GetNRecordsCsvResItems(): GetNRecordsCsvResItems;
|
|
1260
|
-
type GetNRecordsCsvResItems = {
|
|
1261
|
-
email?: string;
|
|
1262
|
-
firstname?: string;
|
|
1263
|
-
lastname?: string;
|
|
1264
|
-
orderid?: string;
|
|
1265
|
-
phone_number?: string;
|
|
1266
|
-
};
|
|
1267
|
-
/** @returns {GetStats} */
|
|
1268
|
-
declare function GetStats(): GetStats;
|
|
1269
|
-
type GetStats = {
|
|
1270
|
-
items?: Stats[];
|
|
1271
|
-
};
|
|
1272
|
-
/** @returns {GlobalProviders} */
|
|
1273
|
-
declare function GlobalProviders(): GlobalProviders;
|
|
1274
|
-
type GlobalProviders = {
|
|
1275
|
-
email?: GlobalProvidersResObj[];
|
|
1276
|
-
sms?: GlobalProvidersResObj[];
|
|
1277
|
-
voice?: GlobalProvidersResObj[];
|
|
1278
|
-
};
|
|
1279
|
-
/** @returns {GlobalProvidersResObj} */
|
|
1280
|
-
declare function GlobalProvidersResObj(): GlobalProvidersResObj;
|
|
1281
|
-
type GlobalProvidersResObj = {
|
|
1282
|
-
_id?: string;
|
|
1283
|
-
name?: string;
|
|
1284
|
-
};
|
|
1285
|
-
/** @returns {GlobalVariablesGetResponse} */
|
|
1286
|
-
declare function GlobalVariablesGetResponse(): GlobalVariablesGetResponse;
|
|
1287
|
-
type GlobalVariablesGetResponse = {
|
|
1288
|
-
editable?: any;
|
|
1289
|
-
read_only?: any;
|
|
1290
|
-
};
|
|
1291
|
-
/** @returns {GlobalVariablesPostResponse} */
|
|
1292
|
-
declare function GlobalVariablesPostResponse(): GlobalVariablesPostResponse;
|
|
1293
|
-
type GlobalVariablesPostResponse = {
|
|
1294
|
-
_id?: string;
|
|
1295
|
-
application?: string;
|
|
1296
|
-
category?: string;
|
|
1297
|
-
created_at?: string;
|
|
1298
|
-
global_variables?: any;
|
|
1299
|
-
};
|
|
1300
|
-
/** @returns {GlobalVariablesReq} */
|
|
1301
|
-
declare function GlobalVariablesReq(): GlobalVariablesReq;
|
|
1302
|
-
type GlobalVariablesReq = {
|
|
1303
|
-
global_variables?: any;
|
|
1305
|
+
/** @returns {GlobalVariablesReq} */
|
|
1306
|
+
declare function GlobalVariablesReq(): GlobalVariablesReq;
|
|
1307
|
+
type GlobalVariablesReq = {
|
|
1308
|
+
global_variables?: any;
|
|
1304
1309
|
};
|
|
1305
1310
|
/** @returns {Job} */
|
|
1306
1311
|
declare function Job(): Job;
|
|
1307
1312
|
type Job = {
|
|
1308
|
-
|
|
1313
|
+
completed?: boolean;
|
|
1314
|
+
is_active?: boolean;
|
|
1309
1315
|
_id?: string;
|
|
1310
|
-
application?: string;
|
|
1311
1316
|
campaign?: string;
|
|
1312
|
-
|
|
1317
|
+
application?: string;
|
|
1313
1318
|
created_at?: string;
|
|
1314
|
-
is_active?: boolean;
|
|
1315
1319
|
updated_at?: string;
|
|
1320
|
+
__v?: number;
|
|
1321
|
+
};
|
|
1322
|
+
/** @returns {Jobs} */
|
|
1323
|
+
declare function Jobs(): Jobs;
|
|
1324
|
+
type Jobs = {
|
|
1325
|
+
items?: Job[];
|
|
1326
|
+
page?: Page;
|
|
1316
1327
|
};
|
|
1317
1328
|
/** @returns {JobLog} */
|
|
1318
1329
|
declare function JobLog(): JobLog;
|
|
1319
1330
|
type JobLog = {
|
|
1320
|
-
|
|
1331
|
+
imported?: any;
|
|
1332
|
+
processed?: any;
|
|
1321
1333
|
_id?: string;
|
|
1334
|
+
job?: string;
|
|
1322
1335
|
campaign?: string;
|
|
1323
1336
|
created_at?: string;
|
|
1324
|
-
imported?: any;
|
|
1325
|
-
job?: string;
|
|
1326
|
-
processed?: any;
|
|
1327
1337
|
updated_at?: string;
|
|
1338
|
+
__v?: number;
|
|
1328
1339
|
};
|
|
1329
1340
|
/** @returns {JobLogs} */
|
|
1330
1341
|
declare function JobLogs(): JobLogs;
|
|
@@ -1332,46 +1343,40 @@ type JobLogs = {
|
|
|
1332
1343
|
items?: JobLog[];
|
|
1333
1344
|
page?: Page;
|
|
1334
1345
|
};
|
|
1335
|
-
/** @returns {Jobs} */
|
|
1336
|
-
declare function Jobs(): Jobs;
|
|
1337
|
-
type Jobs = {
|
|
1338
|
-
items?: Job[];
|
|
1339
|
-
page?: Page;
|
|
1340
|
-
};
|
|
1341
|
-
/** @returns {Log} */
|
|
1342
|
-
declare function Log(): Log;
|
|
1343
|
-
type Log = {
|
|
1344
|
-
_id?: string;
|
|
1345
|
-
application?: string;
|
|
1346
|
-
created_at?: string;
|
|
1347
|
-
data?: any;
|
|
1348
|
-
email?: LogEmail;
|
|
1349
|
-
expire_at?: string;
|
|
1350
|
-
meta?: LogMeta;
|
|
1351
|
-
pushnotification?: LogPushnotification;
|
|
1352
|
-
service?: string;
|
|
1353
|
-
status?: string;
|
|
1354
|
-
step?: string;
|
|
1355
|
-
};
|
|
1356
1346
|
/** @returns {LogEmail} */
|
|
1357
1347
|
declare function LogEmail(): LogEmail;
|
|
1358
1348
|
type LogEmail = {
|
|
1359
1349
|
template?: string;
|
|
1360
1350
|
};
|
|
1351
|
+
/** @returns {LogPushnotification} */
|
|
1352
|
+
declare function LogPushnotification(): LogPushnotification;
|
|
1353
|
+
type LogPushnotification = {
|
|
1354
|
+
pushtokens?: string[];
|
|
1355
|
+
};
|
|
1361
1356
|
/** @returns {LogMeta} */
|
|
1362
1357
|
declare function LogMeta(): LogMeta;
|
|
1363
1358
|
type LogMeta = {
|
|
1359
|
+
type?: string;
|
|
1364
1360
|
identifier?: string;
|
|
1365
1361
|
key?: string;
|
|
1366
1362
|
offset?: string;
|
|
1367
1363
|
partition?: string;
|
|
1368
1364
|
topic?: string;
|
|
1369
|
-
type?: string;
|
|
1370
1365
|
};
|
|
1371
|
-
/** @returns {
|
|
1372
|
-
declare function
|
|
1373
|
-
type
|
|
1374
|
-
|
|
1366
|
+
/** @returns {Log} */
|
|
1367
|
+
declare function Log(): Log;
|
|
1368
|
+
type Log = {
|
|
1369
|
+
email?: LogEmail;
|
|
1370
|
+
pushnotification?: LogPushnotification;
|
|
1371
|
+
meta?: LogMeta;
|
|
1372
|
+
_id?: string;
|
|
1373
|
+
application?: string;
|
|
1374
|
+
service?: string;
|
|
1375
|
+
step?: string;
|
|
1376
|
+
status?: string;
|
|
1377
|
+
data?: any;
|
|
1378
|
+
expire_at?: string;
|
|
1379
|
+
created_at?: string;
|
|
1375
1380
|
};
|
|
1376
1381
|
/** @returns {Logs} */
|
|
1377
1382
|
declare function Logs(): Logs;
|
|
@@ -1379,282 +1384,182 @@ type Logs = {
|
|
|
1379
1384
|
items?: Log[];
|
|
1380
1385
|
page?: Page;
|
|
1381
1386
|
};
|
|
1382
|
-
/** @returns {
|
|
1383
|
-
declare function
|
|
1384
|
-
type
|
|
1385
|
-
info?: string;
|
|
1386
|
-
message?: string;
|
|
1387
|
-
operation?: string;
|
|
1388
|
-
success?: boolean;
|
|
1389
|
-
};
|
|
1390
|
-
/** @returns {metaObj} */
|
|
1391
|
-
declare function metaObj(): metaObj;
|
|
1392
|
-
type metaObj = {
|
|
1393
|
-
is_system?: boolean;
|
|
1394
|
-
template?: string;
|
|
1395
|
-
type?: string;
|
|
1396
|
-
};
|
|
1397
|
-
/** @returns {MetaStructure} */
|
|
1398
|
-
declare function MetaStructure(): MetaStructure;
|
|
1399
|
-
type MetaStructure = {
|
|
1400
|
-
action?: string;
|
|
1401
|
-
job_type?: string;
|
|
1402
|
-
timestamp?: string;
|
|
1403
|
-
trace?: string;
|
|
1404
|
-
};
|
|
1405
|
-
/** @returns {NotFound} */
|
|
1406
|
-
declare function NotFound(): NotFound;
|
|
1407
|
-
type NotFound = {
|
|
1408
|
-
/**
|
|
1409
|
-
* - Failure message.
|
|
1410
|
-
*/
|
|
1411
|
-
message?: string;
|
|
1412
|
-
};
|
|
1413
|
-
/** @returns {Notification} */
|
|
1414
|
-
declare function Notification(): Notification;
|
|
1415
|
-
type Notification = {
|
|
1416
|
-
body?: string;
|
|
1417
|
-
click_action?: string;
|
|
1418
|
-
deeplink?: string;
|
|
1419
|
-
icon?: string;
|
|
1420
|
-
subtitle?: string;
|
|
1421
|
-
title?: string;
|
|
1422
|
-
};
|
|
1423
|
-
/** @returns {OtpConfiguration} */
|
|
1424
|
-
declare function OtpConfiguration(): OtpConfiguration;
|
|
1425
|
-
type OtpConfiguration = {
|
|
1426
|
-
application_id?: string;
|
|
1427
|
-
company_id?: string;
|
|
1428
|
-
expiry: OtpConfigurationExpiry;
|
|
1429
|
-
otp_length: number;
|
|
1430
|
-
type: string;
|
|
1431
|
-
};
|
|
1432
|
-
/** @returns {OtpConfigurationExpiry} */
|
|
1433
|
-
declare function OtpConfigurationExpiry(): OtpConfigurationExpiry;
|
|
1434
|
-
type OtpConfigurationExpiry = {
|
|
1435
|
-
duration: OtpConfigurationExpiryDuration;
|
|
1436
|
-
type: string;
|
|
1437
|
-
};
|
|
1438
|
-
/** @returns {OtpConfigurationExpiryDuration} */
|
|
1439
|
-
declare function OtpConfigurationExpiryDuration(): OtpConfigurationExpiryDuration;
|
|
1440
|
-
type OtpConfigurationExpiryDuration = {
|
|
1441
|
-
denomination: string;
|
|
1442
|
-
time: number;
|
|
1443
|
-
};
|
|
1444
|
-
/** @returns {Page} */
|
|
1445
|
-
declare function Page(): Page;
|
|
1446
|
-
type Page = {
|
|
1447
|
-
current?: number;
|
|
1448
|
-
has_next?: boolean;
|
|
1449
|
-
has_previous?: boolean;
|
|
1450
|
-
item_total?: number;
|
|
1451
|
-
next_id?: string;
|
|
1452
|
-
size?: number;
|
|
1453
|
-
type: string;
|
|
1454
|
-
};
|
|
1455
|
-
/** @returns {PayloadEmailProviderStructure} */
|
|
1456
|
-
declare function PayloadEmailProviderStructure(): PayloadEmailProviderStructure;
|
|
1457
|
-
type PayloadEmailProviderStructure = {
|
|
1458
|
-
_id?: string;
|
|
1459
|
-
};
|
|
1460
|
-
/** @returns {PayloadEmailStructure} */
|
|
1461
|
-
declare function PayloadEmailStructure(): PayloadEmailStructure;
|
|
1462
|
-
type PayloadEmailStructure = {
|
|
1463
|
-
provider?: PayloadEmailProviderStructure;
|
|
1464
|
-
template?: PayloadEmailTemplateStructure;
|
|
1465
|
-
};
|
|
1466
|
-
/** @returns {PayloadEmailTemplateStructure} */
|
|
1467
|
-
declare function PayloadEmailTemplateStructure(): PayloadEmailTemplateStructure;
|
|
1468
|
-
type PayloadEmailTemplateStructure = {
|
|
1387
|
+
/** @returns {SendOtpSmsCommsTemplate} */
|
|
1388
|
+
declare function SendOtpSmsCommsTemplate(): SendOtpSmsCommsTemplate;
|
|
1389
|
+
type SendOtpSmsCommsTemplate = {
|
|
1469
1390
|
key?: string;
|
|
1470
1391
|
value?: any;
|
|
1471
1392
|
};
|
|
1472
|
-
/** @returns {
|
|
1473
|
-
declare function
|
|
1474
|
-
type
|
|
1393
|
+
/** @returns {SendOtpSmsCommsProvider} */
|
|
1394
|
+
declare function SendOtpSmsCommsProvider(): SendOtpSmsCommsProvider;
|
|
1395
|
+
type SendOtpSmsCommsProvider = {
|
|
1396
|
+
slug?: string;
|
|
1475
1397
|
_id?: string;
|
|
1476
1398
|
};
|
|
1477
|
-
/** @returns {
|
|
1478
|
-
declare function
|
|
1479
|
-
type
|
|
1480
|
-
|
|
1481
|
-
|
|
1399
|
+
/** @returns {SendOtpEmailCommsProvider} */
|
|
1400
|
+
declare function SendOtpEmailCommsProvider(): SendOtpEmailCommsProvider;
|
|
1401
|
+
type SendOtpEmailCommsProvider = {
|
|
1402
|
+
slug?: string;
|
|
1403
|
+
_id?: string;
|
|
1482
1404
|
};
|
|
1483
|
-
/** @returns {
|
|
1484
|
-
declare function
|
|
1485
|
-
type
|
|
1405
|
+
/** @returns {SendOtpEmailCommsTemplate} */
|
|
1406
|
+
declare function SendOtpEmailCommsTemplate(): SendOtpEmailCommsTemplate;
|
|
1407
|
+
type SendOtpEmailCommsTemplate = {
|
|
1486
1408
|
key?: string;
|
|
1487
1409
|
value?: any;
|
|
1488
1410
|
};
|
|
1489
|
-
/** @returns {PayloadStructure} */
|
|
1490
|
-
declare function PayloadStructure(): PayloadStructure;
|
|
1491
|
-
type PayloadStructure = {
|
|
1492
|
-
application?: string;
|
|
1493
|
-
data?: any[];
|
|
1494
|
-
email?: PayloadEmailStructure;
|
|
1495
|
-
sms?: PayloadSmsStructure;
|
|
1496
|
-
};
|
|
1497
|
-
/** @returns {RecipientHeaders} */
|
|
1498
|
-
declare function RecipientHeaders(): RecipientHeaders;
|
|
1499
|
-
type RecipientHeaders = {
|
|
1500
|
-
email?: string;
|
|
1501
|
-
};
|
|
1502
|
-
/** @returns {SendOtpCommsReq} */
|
|
1503
|
-
declare function SendOtpCommsReq(): SendOtpCommsReq;
|
|
1504
|
-
type SendOtpCommsReq = {
|
|
1505
|
-
data?: SendOtpCommsReqData;
|
|
1506
|
-
email?: SendOtpCommsReqEmail;
|
|
1507
|
-
sms?: SendOtpCommsReqSms;
|
|
1508
|
-
};
|
|
1509
1411
|
/** @returns {SendOtpCommsReqData} */
|
|
1510
1412
|
declare function SendOtpCommsReqData(): SendOtpCommsReqData;
|
|
1511
1413
|
type SendOtpCommsReqData = {
|
|
1512
|
-
country_code?: string;
|
|
1513
|
-
mobile?: string;
|
|
1514
1414
|
send_same_otp_to_channel?: boolean;
|
|
1415
|
+
mobile?: string;
|
|
1416
|
+
country_code?: string;
|
|
1515
1417
|
to?: string;
|
|
1516
1418
|
};
|
|
1517
|
-
/** @returns {SendOtpCommsReqEmail} */
|
|
1518
|
-
declare function SendOtpCommsReqEmail(): SendOtpCommsReqEmail;
|
|
1519
|
-
type SendOtpCommsReqEmail = {
|
|
1520
|
-
expiry?: number;
|
|
1521
|
-
otp_length?: number;
|
|
1522
|
-
provider?: SendOtpEmailCommsProvider;
|
|
1523
|
-
template?: SendOtpEmailCommsTemplate;
|
|
1524
|
-
};
|
|
1525
1419
|
/** @returns {SendOtpCommsReqSms} */
|
|
1526
1420
|
declare function SendOtpCommsReqSms(): SendOtpCommsReqSms;
|
|
1527
1421
|
type SendOtpCommsReqSms = {
|
|
1528
|
-
expiry?: number;
|
|
1529
1422
|
otp_length?: number;
|
|
1530
|
-
|
|
1423
|
+
expiry?: number;
|
|
1531
1424
|
template?: SendOtpSmsCommsTemplate;
|
|
1425
|
+
provider?: SendOtpSmsCommsProvider;
|
|
1532
1426
|
};
|
|
1533
|
-
/** @returns {
|
|
1534
|
-
declare function
|
|
1535
|
-
type
|
|
1536
|
-
|
|
1537
|
-
|
|
1538
|
-
|
|
1539
|
-
|
|
1540
|
-
declare function SendOtpCommsResEmail(): SendOtpCommsResEmail;
|
|
1541
|
-
type SendOtpCommsResEmail = {
|
|
1542
|
-
message?: string;
|
|
1543
|
-
request_id?: string;
|
|
1544
|
-
resend_timer?: number;
|
|
1545
|
-
success?: boolean;
|
|
1546
|
-
to?: string;
|
|
1427
|
+
/** @returns {SendOtpCommsReqEmail} */
|
|
1428
|
+
declare function SendOtpCommsReqEmail(): SendOtpCommsReqEmail;
|
|
1429
|
+
type SendOtpCommsReqEmail = {
|
|
1430
|
+
otp_length?: number;
|
|
1431
|
+
expiry?: number;
|
|
1432
|
+
template?: SendOtpEmailCommsTemplate;
|
|
1433
|
+
provider?: SendOtpEmailCommsProvider;
|
|
1547
1434
|
};
|
|
1548
1435
|
/** @returns {SendOtpCommsResSms} */
|
|
1549
1436
|
declare function SendOtpCommsResSms(): SendOtpCommsResSms;
|
|
1550
1437
|
type SendOtpCommsResSms = {
|
|
1551
|
-
|
|
1438
|
+
success?: boolean;
|
|
1439
|
+
request_id?: string;
|
|
1552
1440
|
message?: string;
|
|
1553
1441
|
mobile?: string;
|
|
1554
|
-
|
|
1442
|
+
country_code?: string;
|
|
1555
1443
|
resend_timer?: number;
|
|
1444
|
+
};
|
|
1445
|
+
/** @returns {SendOtpCommsResEmail} */
|
|
1446
|
+
declare function SendOtpCommsResEmail(): SendOtpCommsResEmail;
|
|
1447
|
+
type SendOtpCommsResEmail = {
|
|
1556
1448
|
success?: boolean;
|
|
1449
|
+
request_id?: string;
|
|
1450
|
+
message?: string;
|
|
1451
|
+
to?: string;
|
|
1452
|
+
resend_timer?: number;
|
|
1557
1453
|
};
|
|
1558
|
-
/** @returns {
|
|
1559
|
-
declare function
|
|
1560
|
-
type
|
|
1561
|
-
|
|
1562
|
-
|
|
1454
|
+
/** @returns {SendOtpCommsReq} */
|
|
1455
|
+
declare function SendOtpCommsReq(): SendOtpCommsReq;
|
|
1456
|
+
type SendOtpCommsReq = {
|
|
1457
|
+
data?: SendOtpCommsReqData;
|
|
1458
|
+
sms?: SendOtpCommsReqSms;
|
|
1459
|
+
email?: SendOtpCommsReqEmail;
|
|
1563
1460
|
};
|
|
1564
|
-
/** @returns {
|
|
1565
|
-
declare function
|
|
1566
|
-
type
|
|
1567
|
-
|
|
1568
|
-
|
|
1461
|
+
/** @returns {SendOtpCommsRes} */
|
|
1462
|
+
declare function SendOtpCommsRes(): SendOtpCommsRes;
|
|
1463
|
+
type SendOtpCommsRes = {
|
|
1464
|
+
sms?: SendOtpCommsResSms;
|
|
1465
|
+
email?: SendOtpCommsResEmail;
|
|
1569
1466
|
};
|
|
1570
|
-
/** @returns {
|
|
1571
|
-
declare function
|
|
1572
|
-
type
|
|
1573
|
-
|
|
1574
|
-
|
|
1467
|
+
/** @returns {VerifyOtpCommsReq} */
|
|
1468
|
+
declare function VerifyOtpCommsReq(): VerifyOtpCommsReq;
|
|
1469
|
+
type VerifyOtpCommsReq = {
|
|
1470
|
+
request_id?: string;
|
|
1471
|
+
otp?: string;
|
|
1575
1472
|
};
|
|
1576
|
-
/** @returns {
|
|
1577
|
-
declare function
|
|
1578
|
-
type
|
|
1579
|
-
|
|
1580
|
-
|
|
1473
|
+
/** @returns {VerifyOtpCommsSuccessRes} */
|
|
1474
|
+
declare function VerifyOtpCommsSuccessRes(): VerifyOtpCommsSuccessRes;
|
|
1475
|
+
type VerifyOtpCommsSuccessRes = {
|
|
1476
|
+
success?: boolean;
|
|
1477
|
+
mobile?: string;
|
|
1478
|
+
country_code?: string;
|
|
1479
|
+
message?: string;
|
|
1581
1480
|
};
|
|
1582
|
-
/** @returns {
|
|
1583
|
-
declare function
|
|
1584
|
-
type
|
|
1585
|
-
|
|
1586
|
-
|
|
1587
|
-
application?: string;
|
|
1588
|
-
authkey?: string;
|
|
1589
|
-
created_at?: string;
|
|
1590
|
-
description?: string;
|
|
1591
|
-
name?: string;
|
|
1592
|
-
provider?: string;
|
|
1593
|
-
rpt?: number;
|
|
1594
|
-
sender?: string;
|
|
1595
|
-
slug?: string;
|
|
1596
|
-
type?: string;
|
|
1597
|
-
updated_at?: string;
|
|
1598
|
-
username?: string;
|
|
1481
|
+
/** @returns {VerifyOtpCommsErrorRes} */
|
|
1482
|
+
declare function VerifyOtpCommsErrorRes(): VerifyOtpCommsErrorRes;
|
|
1483
|
+
type VerifyOtpCommsErrorRes = {
|
|
1484
|
+
success?: boolean;
|
|
1485
|
+
message?: string;
|
|
1599
1486
|
};
|
|
1600
1487
|
/** @returns {SmsProviderReq} */
|
|
1601
1488
|
declare function SmsProviderReq(): SmsProviderReq;
|
|
1602
1489
|
type SmsProviderReq = {
|
|
1490
|
+
name?: string;
|
|
1491
|
+
description?: string;
|
|
1492
|
+
sender?: string;
|
|
1493
|
+
username?: string;
|
|
1494
|
+
authkey?: string;
|
|
1495
|
+
type?: string;
|
|
1496
|
+
provider?: string;
|
|
1603
1497
|
/**
|
|
1604
|
-
* - The
|
|
1498
|
+
* - The password for the test.
|
|
1605
1499
|
*/
|
|
1606
|
-
|
|
1500
|
+
password?: string;
|
|
1607
1501
|
/**
|
|
1608
|
-
* - The
|
|
1502
|
+
* - The sender ID for the test.
|
|
1609
1503
|
*/
|
|
1610
|
-
|
|
1611
|
-
authkey?: string;
|
|
1612
|
-
description?: string;
|
|
1504
|
+
senderid?: string;
|
|
1613
1505
|
/**
|
|
1614
|
-
* - The
|
|
1506
|
+
* - The feed ID for the test.
|
|
1615
1507
|
*/
|
|
1616
|
-
|
|
1508
|
+
feedid?: string;
|
|
1617
1509
|
/**
|
|
1618
1510
|
* - The entity ID for the test.
|
|
1619
1511
|
*/
|
|
1620
1512
|
entityid?: string;
|
|
1621
1513
|
/**
|
|
1622
|
-
* -
|
|
1514
|
+
* - Whether to override Do Not Disturb.
|
|
1623
1515
|
*/
|
|
1624
|
-
|
|
1516
|
+
override_dnd?: boolean;
|
|
1625
1517
|
/**
|
|
1626
1518
|
* - The host for the test.
|
|
1627
1519
|
*/
|
|
1628
1520
|
host?: string;
|
|
1629
|
-
name?: string;
|
|
1630
1521
|
/**
|
|
1631
|
-
* -
|
|
1522
|
+
* - The port for the test.
|
|
1632
1523
|
*/
|
|
1633
|
-
|
|
1524
|
+
port?: number;
|
|
1634
1525
|
/**
|
|
1635
|
-
* - The
|
|
1526
|
+
* - The entity ID for the test.
|
|
1636
1527
|
*/
|
|
1637
|
-
|
|
1528
|
+
entity_id?: string;
|
|
1638
1529
|
/**
|
|
1639
|
-
* - The
|
|
1530
|
+
* - The apikey for the test.
|
|
1640
1531
|
*/
|
|
1641
|
-
|
|
1642
|
-
|
|
1643
|
-
|
|
1532
|
+
apikey?: string;
|
|
1533
|
+
/**
|
|
1534
|
+
* - The version ID for the test.
|
|
1535
|
+
*/
|
|
1536
|
+
version_id?: number;
|
|
1644
1537
|
/**
|
|
1645
1538
|
* - The sender ID for the test.
|
|
1646
1539
|
*/
|
|
1647
1540
|
sender_id?: string;
|
|
1648
1541
|
/**
|
|
1649
|
-
* - The
|
|
1542
|
+
* - The api_key for the test.
|
|
1650
1543
|
*/
|
|
1651
|
-
|
|
1544
|
+
api_key?: string;
|
|
1545
|
+
};
|
|
1546
|
+
/** @returns {SmsProvider} */
|
|
1547
|
+
declare function SmsProvider(): SmsProvider;
|
|
1548
|
+
type SmsProvider = {
|
|
1549
|
+
rpt?: number;
|
|
1652
1550
|
type?: string;
|
|
1551
|
+
provider?: string;
|
|
1552
|
+
_id?: string;
|
|
1553
|
+
name?: string;
|
|
1554
|
+
description?: string;
|
|
1555
|
+
sender?: string;
|
|
1653
1556
|
username?: string;
|
|
1654
|
-
|
|
1655
|
-
|
|
1656
|
-
|
|
1657
|
-
|
|
1557
|
+
authkey?: string;
|
|
1558
|
+
application?: string;
|
|
1559
|
+
created_at?: string;
|
|
1560
|
+
updated_at?: string;
|
|
1561
|
+
slug?: string;
|
|
1562
|
+
__v?: number;
|
|
1658
1563
|
};
|
|
1659
1564
|
/** @returns {SmsProviders} */
|
|
1660
1565
|
declare function SmsProviders(): SmsProviders;
|
|
@@ -1662,135 +1567,113 @@ type SmsProviders = {
|
|
|
1662
1567
|
items?: SmsProvider[];
|
|
1663
1568
|
page?: Page;
|
|
1664
1569
|
};
|
|
1570
|
+
/** @returns {DefaultSmsProviders} */
|
|
1571
|
+
declare function DefaultSmsProviders(): DefaultSmsProviders;
|
|
1572
|
+
type DefaultSmsProviders = {
|
|
1573
|
+
_id?: string;
|
|
1574
|
+
name?: string;
|
|
1575
|
+
is_default?: boolean;
|
|
1576
|
+
};
|
|
1577
|
+
/** @returns {SmsTemplateMessage} */
|
|
1578
|
+
declare function SmsTemplateMessage(): SmsTemplateMessage;
|
|
1579
|
+
type SmsTemplateMessage = {
|
|
1580
|
+
template_type?: string;
|
|
1581
|
+
template?: string;
|
|
1582
|
+
};
|
|
1583
|
+
/** @returns {SmsTemplates} */
|
|
1584
|
+
declare function SmsTemplates(): SmsTemplates;
|
|
1585
|
+
type SmsTemplates = {
|
|
1586
|
+
items?: SmsTemplate[];
|
|
1587
|
+
page?: Page;
|
|
1588
|
+
};
|
|
1665
1589
|
/** @returns {SmsTemplate} */
|
|
1666
1590
|
declare function SmsTemplate(): SmsTemplate;
|
|
1667
1591
|
type SmsTemplate = {
|
|
1668
|
-
|
|
1592
|
+
url_shorten?: EnabledObj;
|
|
1669
1593
|
_id?: string;
|
|
1670
1594
|
application?: string;
|
|
1671
|
-
category?: string;
|
|
1672
|
-
created_at?: string;
|
|
1673
|
-
description?: string;
|
|
1674
|
-
is_internal?: boolean;
|
|
1675
1595
|
is_system?: boolean;
|
|
1676
|
-
|
|
1596
|
+
is_internal?: boolean;
|
|
1677
1597
|
meta?: metaObj;
|
|
1678
1598
|
name?: string;
|
|
1599
|
+
description?: string;
|
|
1600
|
+
message?: SmsTemplateMessage;
|
|
1679
1601
|
priority?: string;
|
|
1602
|
+
tags?: string[];
|
|
1603
|
+
template_variables?: any;
|
|
1604
|
+
template_id?: string;
|
|
1680
1605
|
published?: boolean;
|
|
1606
|
+
category?: string;
|
|
1607
|
+
created_at?: string;
|
|
1608
|
+
updated_at?: string;
|
|
1681
1609
|
slug?: string;
|
|
1610
|
+
__v?: number;
|
|
1611
|
+
};
|
|
1612
|
+
/** @returns {SystemSmsTemplates} */
|
|
1613
|
+
declare function SystemSmsTemplates(): SystemSmsTemplates;
|
|
1614
|
+
type SystemSmsTemplates = {
|
|
1615
|
+
url_shorten?: EnabledObj;
|
|
1616
|
+
_id?: string;
|
|
1617
|
+
is_system?: boolean;
|
|
1618
|
+
is_internal?: boolean;
|
|
1619
|
+
name?: string;
|
|
1620
|
+
description?: string;
|
|
1621
|
+
message?: SmsTemplateMessage;
|
|
1622
|
+
priority?: string;
|
|
1682
1623
|
tags?: string[];
|
|
1683
|
-
template_id?: string;
|
|
1684
1624
|
template_variables?: any;
|
|
1625
|
+
template_id?: string;
|
|
1626
|
+
published?: boolean;
|
|
1627
|
+
category?: string;
|
|
1628
|
+
created_at?: string;
|
|
1685
1629
|
updated_at?: string;
|
|
1686
|
-
|
|
1630
|
+
slug?: string;
|
|
1631
|
+
__v?: number;
|
|
1687
1632
|
};
|
|
1688
|
-
/** @returns {
|
|
1689
|
-
declare function
|
|
1690
|
-
type
|
|
1633
|
+
/** @returns {metaObj} */
|
|
1634
|
+
declare function metaObj(): metaObj;
|
|
1635
|
+
type metaObj = {
|
|
1636
|
+
type?: string;
|
|
1637
|
+
is_system?: boolean;
|
|
1691
1638
|
template?: string;
|
|
1692
|
-
template_type?: string;
|
|
1693
1639
|
};
|
|
1694
1640
|
/** @returns {SmsTemplateReq} */
|
|
1695
1641
|
declare function SmsTemplateReq(): SmsTemplateReq;
|
|
1696
1642
|
type SmsTemplateReq = {
|
|
1697
|
-
description?: string;
|
|
1698
|
-
message?: SmsTemplateMessage;
|
|
1699
|
-
meta?: metaObj;
|
|
1700
1643
|
name: string;
|
|
1644
|
+
description?: string;
|
|
1701
1645
|
priority?: string;
|
|
1702
|
-
published?: boolean;
|
|
1703
1646
|
template_id?: string;
|
|
1647
|
+
meta?: metaObj;
|
|
1704
1648
|
template_variables?: any;
|
|
1705
|
-
};
|
|
1706
|
-
/** @returns {SmsTemplates} */
|
|
1707
|
-
declare function SmsTemplates(): SmsTemplates;
|
|
1708
|
-
type SmsTemplates = {
|
|
1709
|
-
items?: SmsTemplate[];
|
|
1710
|
-
page?: Page;
|
|
1711
|
-
};
|
|
1712
|
-
/** @returns {Stats} */
|
|
1713
|
-
declare function Stats(): Stats;
|
|
1714
|
-
type Stats = {
|
|
1715
|
-
_id?: string;
|
|
1716
|
-
imported?: any;
|
|
1717
|
-
processed?: any;
|
|
1718
|
-
};
|
|
1719
|
-
/** @returns {StatsImported} */
|
|
1720
|
-
declare function StatsImported(): StatsImported;
|
|
1721
|
-
type StatsImported = {
|
|
1722
|
-
count?: number;
|
|
1723
|
-
};
|
|
1724
|
-
/** @returns {StatsProcessed} */
|
|
1725
|
-
declare function StatsProcessed(): StatsProcessed;
|
|
1726
|
-
type StatsProcessed = {
|
|
1727
|
-
email?: StatsProcessedEmail;
|
|
1728
|
-
sms?: StatsProcessedSms;
|
|
1729
|
-
};
|
|
1730
|
-
/** @returns {StatsProcessedEmail} */
|
|
1731
|
-
declare function StatsProcessedEmail(): StatsProcessedEmail;
|
|
1732
|
-
type StatsProcessedEmail = {
|
|
1733
|
-
failed?: number;
|
|
1734
|
-
success?: number;
|
|
1735
|
-
suppressed?: number;
|
|
1736
|
-
};
|
|
1737
|
-
/** @returns {StatsProcessedSms} */
|
|
1738
|
-
declare function StatsProcessedSms(): StatsProcessedSms;
|
|
1739
|
-
type StatsProcessedSms = {
|
|
1740
|
-
failed?: number;
|
|
1741
|
-
success?: number;
|
|
1742
|
-
suppressed?: number;
|
|
1743
|
-
};
|
|
1744
|
-
/** @returns {SubscriptionsObject} */
|
|
1745
|
-
declare function SubscriptionsObject(): SubscriptionsObject;
|
|
1746
|
-
type SubscriptionsObject = {
|
|
1747
|
-
/**
|
|
1748
|
-
* - Subscription ID
|
|
1749
|
-
*/
|
|
1750
|
-
_id?: string;
|
|
1751
|
-
template?: TemplateObject;
|
|
1752
|
-
};
|
|
1753
|
-
/** @returns {SystemEmailTemplate} */
|
|
1754
|
-
declare function SystemEmailTemplate(): SystemEmailTemplate;
|
|
1755
|
-
type SystemEmailTemplate = {
|
|
1756
|
-
__v?: number;
|
|
1757
|
-
_id?: string;
|
|
1758
|
-
attachments?: number[];
|
|
1759
|
-
category?: string;
|
|
1760
|
-
created_at?: string;
|
|
1761
|
-
description?: string;
|
|
1762
|
-
headers?: EmailTemplateHeaders[];
|
|
1763
|
-
html?: TemplateAndType;
|
|
1764
|
-
is_internal?: boolean;
|
|
1765
|
-
is_system?: boolean;
|
|
1766
|
-
name?: string;
|
|
1767
|
-
priority?: string;
|
|
1768
1649
|
published?: boolean;
|
|
1769
|
-
|
|
1770
|
-
static_bcc?: string[];
|
|
1771
|
-
static_cc?: string[];
|
|
1772
|
-
static_to?: string[];
|
|
1773
|
-
subject?: TemplateAndType;
|
|
1774
|
-
tags?: string[];
|
|
1775
|
-
template_variables?: any;
|
|
1776
|
-
text?: TemplateAndType;
|
|
1777
|
-
updated_at?: string;
|
|
1778
|
-
url_shorten?: EnabledObj;
|
|
1650
|
+
message?: SmsTemplateMessage;
|
|
1779
1651
|
};
|
|
1780
|
-
/** @returns {
|
|
1781
|
-
declare function
|
|
1782
|
-
type
|
|
1783
|
-
|
|
1652
|
+
/** @returns {Notification} */
|
|
1653
|
+
declare function Notification(): Notification;
|
|
1654
|
+
type Notification = {
|
|
1655
|
+
title?: string;
|
|
1656
|
+
body?: string;
|
|
1657
|
+
subtitle?: string;
|
|
1658
|
+
icon?: string;
|
|
1659
|
+
deeplink?: string;
|
|
1660
|
+
click_action?: string;
|
|
1661
|
+
};
|
|
1662
|
+
/** @returns {SystemNotificationUser} */
|
|
1663
|
+
declare function SystemNotificationUser(): SystemNotificationUser;
|
|
1664
|
+
type SystemNotificationUser = {
|
|
1665
|
+
type?: string;
|
|
1666
|
+
value?: string;
|
|
1784
1667
|
};
|
|
1785
1668
|
/** @returns {SystemNotification} */
|
|
1786
1669
|
declare function SystemNotification(): SystemNotification;
|
|
1787
1670
|
type SystemNotification = {
|
|
1788
|
-
_id?: string;
|
|
1789
|
-
created_at?: string;
|
|
1790
|
-
group?: string;
|
|
1791
1671
|
notification?: Notification;
|
|
1792
|
-
settings?: SystemNotificationUser;
|
|
1793
1672
|
user?: SystemNotificationUser;
|
|
1673
|
+
settings?: SystemNotificationUser;
|
|
1674
|
+
_id?: string;
|
|
1675
|
+
group?: string;
|
|
1676
|
+
created_at?: string;
|
|
1794
1677
|
};
|
|
1795
1678
|
/** @returns {SystemNotifications} */
|
|
1796
1679
|
declare function SystemNotifications(): SystemNotifications;
|
|
@@ -1799,73 +1682,41 @@ type SystemNotifications = {
|
|
|
1799
1682
|
last_read_anchor?: number;
|
|
1800
1683
|
page?: Page;
|
|
1801
1684
|
};
|
|
1802
|
-
/** @returns {
|
|
1803
|
-
declare function
|
|
1804
|
-
type
|
|
1805
|
-
|
|
1806
|
-
|
|
1807
|
-
|
|
1808
|
-
|
|
1809
|
-
|
|
1810
|
-
type
|
|
1811
|
-
|
|
1812
|
-
_id?: string;
|
|
1813
|
-
category?: string;
|
|
1814
|
-
created_at?: string;
|
|
1815
|
-
description?: string;
|
|
1816
|
-
is_internal?: boolean;
|
|
1817
|
-
is_system?: boolean;
|
|
1818
|
-
message?: SmsTemplateMessage;
|
|
1819
|
-
name?: string;
|
|
1820
|
-
priority?: string;
|
|
1821
|
-
published?: boolean;
|
|
1822
|
-
slug?: string;
|
|
1823
|
-
tags?: string[];
|
|
1824
|
-
template_id?: string;
|
|
1825
|
-
template_variables?: any;
|
|
1826
|
-
updated_at?: string;
|
|
1827
|
-
url_shorten?: EnabledObj;
|
|
1828
|
-
};
|
|
1829
|
-
/** @returns {TemplateAndType} */
|
|
1830
|
-
declare function TemplateAndType(): TemplateAndType;
|
|
1831
|
-
type TemplateAndType = {
|
|
1832
|
-
template?: string;
|
|
1833
|
-
template_type?: string;
|
|
1834
|
-
};
|
|
1835
|
-
/** @returns {TemplateObject} */
|
|
1836
|
-
declare function TemplateObject(): TemplateObject;
|
|
1837
|
-
type TemplateObject = {
|
|
1838
|
-
email?: CommunicationTemplate;
|
|
1839
|
-
pushnotification?: CommunicationTemplate;
|
|
1840
|
-
sms?: CommunicationTemplate;
|
|
1841
|
-
};
|
|
1842
|
-
/** @returns {TriggerJobRequest} */
|
|
1843
|
-
declare function TriggerJobRequest(): TriggerJobRequest;
|
|
1844
|
-
type TriggerJobRequest = {
|
|
1845
|
-
job_id?: string;
|
|
1685
|
+
/** @returns {Page} */
|
|
1686
|
+
declare function Page(): Page;
|
|
1687
|
+
type Page = {
|
|
1688
|
+
item_total?: number;
|
|
1689
|
+
next_id?: string;
|
|
1690
|
+
has_previous?: boolean;
|
|
1691
|
+
has_next?: boolean;
|
|
1692
|
+
current?: number;
|
|
1693
|
+
type: string;
|
|
1694
|
+
size?: number;
|
|
1846
1695
|
};
|
|
1847
|
-
/** @returns {
|
|
1848
|
-
declare function
|
|
1849
|
-
type
|
|
1850
|
-
|
|
1696
|
+
/** @returns {GenericError} */
|
|
1697
|
+
declare function GenericError(): GenericError;
|
|
1698
|
+
type GenericError = {
|
|
1699
|
+
message?: Message;
|
|
1700
|
+
sentry?: string;
|
|
1851
1701
|
};
|
|
1852
|
-
/** @returns {
|
|
1853
|
-
declare function
|
|
1854
|
-
type
|
|
1702
|
+
/** @returns {GenericDelete} */
|
|
1703
|
+
declare function GenericDelete(): GenericDelete;
|
|
1704
|
+
type GenericDelete = {
|
|
1855
1705
|
message?: string;
|
|
1856
|
-
|
|
1857
|
-
|
|
1858
|
-
|
|
1859
|
-
declare function VerifyOtpCommsReq(): VerifyOtpCommsReq;
|
|
1860
|
-
type VerifyOtpCommsReq = {
|
|
1861
|
-
otp?: string;
|
|
1862
|
-
request_id?: string;
|
|
1706
|
+
acknowledged?: boolean;
|
|
1707
|
+
affected?: number;
|
|
1708
|
+
operation?: string;
|
|
1863
1709
|
};
|
|
1864
|
-
/** @returns {
|
|
1865
|
-
declare function
|
|
1866
|
-
type
|
|
1867
|
-
country_code?: string;
|
|
1710
|
+
/** @returns {Message} */
|
|
1711
|
+
declare function Message(): Message;
|
|
1712
|
+
type Message = {
|
|
1868
1713
|
message?: string;
|
|
1869
|
-
mobile?: string;
|
|
1870
1714
|
success?: boolean;
|
|
1715
|
+
info?: string;
|
|
1716
|
+
operation?: string;
|
|
1717
|
+
};
|
|
1718
|
+
/** @returns {EnabledObj} */
|
|
1719
|
+
declare function EnabledObj(): EnabledObj;
|
|
1720
|
+
type EnabledObj = {
|
|
1721
|
+
enabled?: boolean;
|
|
1871
1722
|
};
|