@gofynd/fdk-client-javascript 1.6.4 → 3.1.0-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/ApplicationClient.d.ts +0 -2
- package/sdk/application/ApplicationClient.js +0 -2
- package/sdk/application/Cart/CartApplicationClient.d.ts +100 -80
- package/sdk/application/Cart/CartApplicationClient.js +257 -126
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +110 -110
- package/sdk/application/Catalog/CatalogApplicationClient.js +122 -138
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +43 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +190 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +71 -36
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +103 -29
- package/sdk/application/Content/ContentApplicationClient.d.ts +61 -21
- package/sdk/application/Content/ContentApplicationClient.js +250 -36
- package/sdk/application/Lead/LeadApplicationClient.d.ts +3 -3
- package/sdk/application/Lead/LeadApplicationClient.js +3 -3
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +106 -57
- package/sdk/application/Logistic/LogisticApplicationClient.js +326 -208
- package/sdk/application/Order/OrderApplicationClient.d.ts +44 -24
- package/sdk/application/Order/OrderApplicationClient.js +140 -21
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +211 -111
- package/sdk/application/Payment/PaymentApplicationClient.js +610 -109
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +14 -14
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +23 -3
- package/sdk/application/Theme/ThemeApplicationClient.js +103 -5
- package/sdk/application/User/UserApplicationClient.d.ts +13 -23
- package/sdk/application/User/UserApplicationClient.js +9 -57
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +3 -3
- package/sdk/partner/Authorization/AuthorizationPartnerClient.d.ts +66 -0
- package/sdk/partner/Authorization/AuthorizationPartnerClient.js +431 -0
- package/sdk/partner/Authorization/AuthorizationPartnerModel.d.ts +231 -0
- package/sdk/partner/Authorization/AuthorizationPartnerModel.js +152 -0
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.d.ts +8 -0
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.js +39 -0
- package/sdk/partner/Catalog/CatalogPartnerClient.d.ts +26 -0
- package/sdk/partner/Catalog/CatalogPartnerClient.js +173 -0
- package/sdk/partner/Catalog/CatalogPartnerModel.d.ts +238 -0
- package/sdk/partner/Catalog/CatalogPartnerModel.js +248 -0
- package/sdk/partner/Catalog/CatalogPartnerValidator.d.ts +5 -0
- package/sdk/partner/Catalog/CatalogPartnerValidator.js +19 -0
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +0 -10
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +0 -75
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +1 -54
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +0 -43
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +0 -1
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +0 -6
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerClient.js +4 -4
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +100 -49
- package/sdk/partner/Lead/LeadPartnerModel.js +100 -74
- package/sdk/partner/Lead/LeadPartnerValidator.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +33 -160
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +66 -1180
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +288 -1685
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +226 -824
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +1 -13
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +14 -141
- package/sdk/partner/PartnerClient.d.ts +6 -0
- package/sdk/partner/PartnerClient.js +9 -0
- package/sdk/partner/Payment/PaymentPartnerClient.d.ts +116 -0
- package/sdk/partner/Payment/PaymentPartnerClient.js +857 -0
- package/sdk/partner/Payment/PaymentPartnerModel.d.ts +388 -0
- package/sdk/partner/Payment/PaymentPartnerModel.js +442 -0
- package/sdk/partner/Payment/PaymentPartnerValidator.d.ts +14 -0
- package/sdk/partner/Payment/PaymentPartnerValidator.js +74 -0
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +63 -21
- package/sdk/partner/Theme/ThemePartnerClient.js +396 -71
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +104 -72
- package/sdk/partner/Theme/ThemePartnerModel.js +101 -75
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +5 -1
- package/sdk/partner/Theme/ThemePartnerValidator.js +42 -12
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +191 -670
- package/sdk/partner/Webhook/WebhookPartnerModel.js +159 -268
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -3
- package/sdk/partner/index.d.ts +3 -0
- package/sdk/partner/index.js +6 -0
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +1 -4
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +5 -0
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +3 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +32 -2
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +243 -3
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +145 -49
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +171 -20
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +39 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +35 -0
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +388 -443
- package/sdk/platform/Billing/BillingPlatformModel.js +263 -280
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +18 -16
- package/sdk/platform/Billing/BillingPlatformValidator.js +9 -8
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +251 -172
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +639 -521
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +165 -165
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +108 -132
- package/sdk/platform/Cart/CartPlatformModel.d.ts +3150 -4468
- package/sdk/platform/Cart/CartPlatformModel.js +2858 -1867
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +976 -380
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +6475 -2015
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1083 -162
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +884 -80
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +325 -568
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1162 -1562
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6008 -7688
- package/sdk/platform/Catalog/CatalogPlatformModel.js +9522 -6892
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +234 -227
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +183 -177
- package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -6
- package/sdk/platform/Common/CommonPlatformClient.js +5 -6
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +374 -238
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +876 -588
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +170 -139
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +145 -126
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +56 -3
- package/sdk/platform/Communication/CommunicationPlatformClient.js +307 -4
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +506 -270
- package/sdk/platform/Communication/CommunicationPlatformModel.js +611 -313
- package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +62 -3
- package/sdk/platform/Communication/CommunicationPlatformValidator.js +48 -2
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +78 -77
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +97 -91
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +238 -256
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +222 -244
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +31 -20
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +25 -20
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +333 -118
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +1470 -409
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +158 -55
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +163 -41
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +151 -61
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +595 -101
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +1206 -459
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +1011 -320
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +80 -34
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +79 -24
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +255 -140
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1095 -464
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +221 -178
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +220 -157
- package/sdk/platform/Content/ContentPlatformClient.d.ts +124 -123
- package/sdk/platform/Content/ContentPlatformClient.js +459 -379
- package/sdk/platform/Content/ContentPlatformModel.d.ts +871 -1315
- package/sdk/platform/Content/ContentPlatformModel.js +940 -599
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +140 -150
- package/sdk/platform/Content/ContentPlatformValidator.js +131 -135
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +60 -36
- package/sdk/platform/Discount/DiscountPlatformClient.js +85 -36
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +46 -47
- package/sdk/platform/Discount/DiscountPlatformModel.js +42 -46
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +18 -15
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +24 -22
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +75 -86
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +60 -74
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +320 -0
- package/sdk/platform/Finance/FinancePlatformClient.js +2333 -0
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +2895 -0
- package/sdk/platform/Finance/FinancePlatformModel.js +2150 -0
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +284 -0
- package/sdk/platform/Finance/FinancePlatformValidator.js +354 -0
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +17 -17
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +33 -33
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +19 -19
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +14 -14
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +4 -24
- package/sdk/platform/Lead/LeadPlatformClient.js +4 -160
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +142 -57
- package/sdk/platform/Lead/LeadPlatformModel.js +162 -79
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +3 -29
- package/sdk/platform/Lead/LeadPlatformValidator.js +2 -28
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +94 -25
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +600 -57
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +115 -115
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +120 -43
- package/sdk/platform/Order/OrderPlatformClient.d.ts +486 -277
- package/sdk/platform/Order/OrderPlatformClient.js +1491 -938
- package/sdk/platform/Order/OrderPlatformModel.d.ts +4560 -8636
- package/sdk/platform/Order/OrderPlatformModel.js +3604 -4056
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +445 -612
- package/sdk/platform/Order/OrderPlatformValidator.js +316 -326
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +7 -9
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
- package/sdk/platform/Partner/PartnerPlatformModel.js +7 -7
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +382 -135
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +2453 -935
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +306 -93
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +305 -70
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +66 -56
- package/sdk/platform/Payment/PaymentPlatformClient.js +269 -124
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +3531 -1292
- package/sdk/platform/Payment/PaymentPlatformModel.js +3813 -1504
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +64 -35
- package/sdk/platform/Payment/PaymentPlatformValidator.js +60 -34
- package/sdk/platform/PlatformClient.d.ts +2 -0
- package/sdk/platform/PlatformClient.js +4 -0
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +14 -9
- package/sdk/platform/Rewards/RewardsPlatformModel.js +10 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +344 -56
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +2188 -302
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +394 -54
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +342 -37
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +150 -212
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +589 -1238
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +3581 -2960
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +3730 -1779
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +230 -382
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +164 -287
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +4 -16
- package/sdk/platform/Share/SharePlatformApplicationClient.js +8 -86
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +6 -23
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +3 -16
- package/sdk/platform/Share/SharePlatformModel.d.ts +11 -50
- package/sdk/platform/Share/SharePlatformModel.js +5 -43
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +36 -16
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +201 -58
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +28 -17
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +33 -16
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +18 -8
- package/sdk/platform/Theme/ThemePlatformClient.js +85 -8
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +425 -17
- package/sdk/platform/Theme/ThemePlatformModel.js +329 -23
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +7 -3
- package/sdk/platform/Theme/ThemePlatformValidator.js +9 -2
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +18 -71
- package/sdk/platform/User/UserPlatformApplicationClient.js +27 -412
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +10 -114
- package/sdk/platform/User/UserPlatformApplicationValidator.js +7 -80
- package/sdk/platform/User/UserPlatformModel.d.ts +216 -264
- package/sdk/platform/User/UserPlatformModel.js +209 -216
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +78 -25
- package/sdk/platform/Webhook/WebhookPlatformClient.js +470 -75
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +428 -810
- package/sdk/platform/Webhook/WebhookPlatformModel.js +395 -444
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +55 -10
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +72 -12
- package/sdk/platform/index.d.ts +1 -0
- package/sdk/platform/index.js +2 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +14 -4
- package/sdk/public/Configuration/ConfigurationPublicClient.js +97 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +102 -40
- package/sdk/public/Configuration/ConfigurationPublicModel.js +111 -29
- package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +11 -1
- package/sdk/public/Configuration/ConfigurationPublicValidator.js +12 -0
- package/sdk/public/Content/ContentPublicClient.d.ts +22 -0
- package/sdk/public/Content/ContentPublicClient.js +183 -0
- package/sdk/public/Content/ContentPublicModel.d.ts +38 -1
- package/sdk/public/Content/ContentPublicModel.js +47 -1
- package/sdk/public/Content/ContentPublicValidator.d.ts +17 -1
- package/sdk/public/Content/ContentPublicValidator.js +19 -0
- package/sdk/public/PublicClient.d.ts +0 -2
- package/sdk/public/PublicClient.js +0 -4
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +67 -215
- package/sdk/public/Webhook/WebhookPublicModel.js +61 -66
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/public/index.d.ts +0 -1
- package/sdk/public/index.js +0 -2
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +0 -29
- package/sdk/application/Finance/FinanceApplicationClient.js +0 -126
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +0 -22
- package/sdk/public/Catalog/CatalogPublicClient.js +0 -138
- package/sdk/public/Catalog/CatalogPublicModel.d.ts +0 -155
- package/sdk/public/Catalog/CatalogPublicModel.js +0 -116
- package/sdk/public/Catalog/CatalogPublicValidator.d.ts +0 -55
- package/sdk/public/Catalog/CatalogPublicValidator.js +0 -35
|
@@ -1,10 +1,133 @@
|
|
|
1
1
|
export = CommunicationPlatformModel;
|
|
2
2
|
/**
|
|
3
|
-
* @typedef
|
|
3
|
+
* @typedef AppProvidersGlobalProviderRequestObjProvider
|
|
4
|
+
* @property {string} [provider]
|
|
5
|
+
*/
|
|
6
|
+
/**
|
|
7
|
+
* @typedef AppProvidersGlobalProviderRequestObj
|
|
8
|
+
* @property {AppProvidersGlobalProviderRequestObjProvider} [transaction]
|
|
9
|
+
* @property {AppProvidersGlobalProviderRequestObjProvider} [otp]
|
|
10
|
+
*/
|
|
11
|
+
/**
|
|
12
|
+
* @typedef AppProvidersGlobalProviderRequest
|
|
13
|
+
* @property {AppProvidersGlobalProviderRequestObj} [email]
|
|
14
|
+
* @property {AppProvidersGlobalProviderRequestObj} [sms]
|
|
15
|
+
*/
|
|
16
|
+
/**
|
|
17
|
+
* @typedef UpdateAppProvidersGlobalProviderResponseEmailSmsObj
|
|
18
|
+
* @property {string} [default_provider]
|
|
19
|
+
* @property {string} [otp_provider]
|
|
20
|
+
*/
|
|
21
|
+
/**
|
|
22
|
+
* @typedef UpdateAppProvidersGlobalProviderResponse
|
|
23
|
+
* @property {UpdateAppProvidersGlobalProviderResponseEmailSmsObj} [email]
|
|
24
|
+
* @property {UpdateAppProvidersGlobalProviderResponseEmailSmsObj} [sms]
|
|
25
|
+
* @property {string} [_id]
|
|
26
|
+
* @property {string} [slug]
|
|
27
|
+
*/
|
|
28
|
+
/**
|
|
29
|
+
* @typedef DefaultEmailProvidersFromAddresses
|
|
30
|
+
* @property {string} [name]
|
|
31
|
+
* @property {string} [email]
|
|
32
|
+
* @property {boolean} [is_default]
|
|
33
|
+
*/
|
|
34
|
+
/**
|
|
35
|
+
* @typedef DefaultEmailProviders
|
|
36
|
+
* @property {string} [_id]
|
|
37
|
+
* @property {DefaultEmailProvidersFromAddresses[]} [from_address]
|
|
38
|
+
* @property {string} [name]
|
|
39
|
+
* @property {boolean} [is_default]
|
|
40
|
+
*/
|
|
41
|
+
/**
|
|
42
|
+
* @typedef PushtokenReq
|
|
43
|
+
* @property {string} [action]
|
|
44
|
+
* @property {string} [bundle_identifier]
|
|
45
|
+
* @property {string} [push_token]
|
|
46
|
+
* @property {string} [unique_device_id]
|
|
47
|
+
* @property {string} [type]
|
|
48
|
+
*/
|
|
49
|
+
/**
|
|
50
|
+
* @typedef PushtokenRes
|
|
51
|
+
* @property {string} [_id]
|
|
52
|
+
* @property {string} [bundle_identifier]
|
|
53
|
+
* @property {string} [push_token]
|
|
54
|
+
* @property {string} [unique_device_id]
|
|
55
|
+
* @property {string} [type]
|
|
56
|
+
* @property {string} [platform]
|
|
57
|
+
* @property {string} [application_id]
|
|
58
|
+
* @property {string} [user_id]
|
|
59
|
+
* @property {string} [created_at]
|
|
60
|
+
* @property {string} [updated_at]
|
|
61
|
+
* @property {string} [expired_at]
|
|
62
|
+
*/
|
|
63
|
+
/**
|
|
64
|
+
* @typedef SendInstantResponse
|
|
65
|
+
* @property {boolean} [success]
|
|
66
|
+
* @property {string} [provider]
|
|
67
|
+
* @property {boolean} [response]
|
|
68
|
+
*/
|
|
69
|
+
/**
|
|
70
|
+
* @typedef MetaStructure
|
|
71
|
+
* @property {string} [job_type]
|
|
72
|
+
* @property {string} [action]
|
|
73
|
+
* @property {string} [trace]
|
|
74
|
+
* @property {string} [timestamp]
|
|
75
|
+
*/
|
|
76
|
+
/**
|
|
77
|
+
* @typedef PayloadSmsTemplateStructure
|
|
78
|
+
* @property {string} [key]
|
|
79
|
+
* @property {Object} [value]
|
|
80
|
+
*/
|
|
81
|
+
/**
|
|
82
|
+
* @typedef PayloadSmsProviderStructure
|
|
83
|
+
* @property {string} [slug]
|
|
84
|
+
*/
|
|
85
|
+
/**
|
|
86
|
+
* @typedef PayloadEmailTemplateStructure
|
|
87
|
+
* @property {string} [key]
|
|
88
|
+
* @property {Object} [value]
|
|
89
|
+
*/
|
|
90
|
+
/**
|
|
91
|
+
* @typedef PayloadEmailProviderStructure
|
|
92
|
+
* @property {string} [slug]
|
|
93
|
+
*/
|
|
94
|
+
/**
|
|
95
|
+
* @typedef PayloadEmailStructure
|
|
96
|
+
* @property {PayloadEmailTemplateStructure} [template]
|
|
97
|
+
* @property {PayloadEmailProviderStructure} [provider]
|
|
98
|
+
*/
|
|
99
|
+
/**
|
|
100
|
+
* @typedef PayloadSmsStructure
|
|
101
|
+
* @property {PayloadSmsTemplateStructure} [template]
|
|
102
|
+
* @property {PayloadSmsProviderStructure} [provider]
|
|
103
|
+
*/
|
|
104
|
+
/**
|
|
105
|
+
* @typedef SendSyncData
|
|
106
|
+
* @property {string} [phone_number]
|
|
107
|
+
* @property {string} [country_code]
|
|
108
|
+
* @property {string} [to]
|
|
109
|
+
*/
|
|
110
|
+
/**
|
|
111
|
+
* @typedef SendSyncRequest
|
|
112
|
+
* @property {SendSyncData[]} [data]
|
|
113
|
+
* @property {PayloadEmailStructure} [email]
|
|
114
|
+
* @property {PayloadSmsStructure} [sms]
|
|
115
|
+
*/
|
|
116
|
+
/**
|
|
117
|
+
* @typedef EngineRequest
|
|
118
|
+
* @property {SendSyncRequest} [payload]
|
|
119
|
+
* @property {MetaStructure} [meta]
|
|
120
|
+
*/
|
|
121
|
+
/**
|
|
122
|
+
* @typedef EngineResponse
|
|
123
|
+
* @property {boolean} [success]
|
|
124
|
+
*/
|
|
125
|
+
/**
|
|
126
|
+
* @typedef EventSubscriptionsBulkUpdateRequest
|
|
4
127
|
* @property {SubscriptionsObject[]} [subscriptions]
|
|
5
128
|
*/
|
|
6
129
|
/**
|
|
7
|
-
* @typedef
|
|
130
|
+
* @typedef EventSubscriptionsBulkUpdateResponse
|
|
8
131
|
* @property {EventSubscriptionTemplate} [template]
|
|
9
132
|
* @property {string} [_id]
|
|
10
133
|
* @property {string} [application]
|
|
@@ -15,9 +138,17 @@ export = CommunicationPlatformModel;
|
|
|
15
138
|
* @property {string} [updated_at]
|
|
16
139
|
* @property {number} [__v]
|
|
17
140
|
*/
|
|
141
|
+
/**
|
|
142
|
+
* @typedef SubscriptionsObjectRequest
|
|
143
|
+
* @property {string} [event]
|
|
144
|
+
* @property {string} [slug]
|
|
145
|
+
* @property {TemplateObject} [template]
|
|
146
|
+
*/
|
|
18
147
|
/**
|
|
19
148
|
* @typedef SubscriptionsObject
|
|
20
149
|
* @property {string} [_id] - Subscription ID
|
|
150
|
+
* @property {string} [event]
|
|
151
|
+
* @property {string} [slug]
|
|
21
152
|
* @property {TemplateObject} [template]
|
|
22
153
|
*/
|
|
23
154
|
/**
|
|
@@ -98,8 +229,8 @@ export = CommunicationPlatformModel;
|
|
|
98
229
|
/**
|
|
99
230
|
* @typedef Stats
|
|
100
231
|
* @property {string} [_id]
|
|
101
|
-
* @property {
|
|
102
|
-
* @property {
|
|
232
|
+
* @property {StatsImported} [imported]
|
|
233
|
+
* @property {StatsProcessed} [processed]
|
|
103
234
|
*/
|
|
104
235
|
/**
|
|
105
236
|
* @typedef GetStats
|
|
@@ -107,6 +238,9 @@ export = CommunicationPlatformModel;
|
|
|
107
238
|
*/
|
|
108
239
|
/**
|
|
109
240
|
* @typedef CampaignReq
|
|
241
|
+
* @property {RecipientHeaders} [recipient_headers]
|
|
242
|
+
* @property {CampaignEmail} [email]
|
|
243
|
+
* @property {string} [datasource]
|
|
110
244
|
* @property {string} [description]
|
|
111
245
|
* @property {string[]} [tags]
|
|
112
246
|
* @property {string[]} [headers]
|
|
@@ -142,7 +276,7 @@ export = CommunicationPlatformModel;
|
|
|
142
276
|
* @property {RecipientHeaders} [recipient_headers]
|
|
143
277
|
* @property {CampaignEmail} [email]
|
|
144
278
|
* @property {string} [description]
|
|
145
|
-
* @property {
|
|
279
|
+
* @property {string[]} [tags]
|
|
146
280
|
* @property {boolean} [is_active]
|
|
147
281
|
* @property {string} [_id]
|
|
148
282
|
* @property {string} [datasource]
|
|
@@ -159,15 +293,6 @@ export = CommunicationPlatformModel;
|
|
|
159
293
|
* @property {Campaign[]} [items]
|
|
160
294
|
* @property {Page} [page]
|
|
161
295
|
*/
|
|
162
|
-
/**
|
|
163
|
-
* @typedef BadRequestSchema
|
|
164
|
-
* @property {string} [status] - Response status.
|
|
165
|
-
* @property {string} [message] - Failure message.
|
|
166
|
-
*/
|
|
167
|
-
/**
|
|
168
|
-
* @typedef NotFound
|
|
169
|
-
* @property {string} [message] - Failure message.
|
|
170
|
-
*/
|
|
171
296
|
/**
|
|
172
297
|
* @typedef AudienceReq
|
|
173
298
|
* @property {string} [name]
|
|
@@ -305,6 +430,12 @@ export = CommunicationPlatformModel;
|
|
|
305
430
|
* @property {string} [template_type]
|
|
306
431
|
* @property {string} [template]
|
|
307
432
|
*/
|
|
433
|
+
/**
|
|
434
|
+
* @typedef TemplateKeys
|
|
435
|
+
* @property {string} [to]
|
|
436
|
+
* @property {string} [cc]
|
|
437
|
+
* @property {string} [bcc]
|
|
438
|
+
*/
|
|
308
439
|
/**
|
|
309
440
|
* @typedef EmailTemplate
|
|
310
441
|
* @property {string} [application]
|
|
@@ -320,6 +451,7 @@ export = CommunicationPlatformModel;
|
|
|
320
451
|
* @property {string} [reply_to]
|
|
321
452
|
* @property {string[]} [tags]
|
|
322
453
|
* @property {TemplateAndType} [subject]
|
|
454
|
+
* @property {TemplateKeys} [keys]
|
|
323
455
|
* @property {TemplateAndType} [html]
|
|
324
456
|
* @property {EnabledObj} [url_shorten]
|
|
325
457
|
* @property {string} [priority]
|
|
@@ -368,82 +500,70 @@ export = CommunicationPlatformModel;
|
|
|
368
500
|
* @property {Page} [page]
|
|
369
501
|
*/
|
|
370
502
|
/**
|
|
371
|
-
* @typedef
|
|
372
|
-
* @property {
|
|
503
|
+
* @typedef SubscribedSmsTemplates
|
|
504
|
+
* @property {SmsTemplates[]} [items]
|
|
373
505
|
*/
|
|
374
506
|
/**
|
|
375
|
-
* @typedef
|
|
376
|
-
* @property {
|
|
377
|
-
* @property {Object} [value]
|
|
378
|
-
*/
|
|
379
|
-
/**
|
|
380
|
-
* @typedef PayloadEmailProviderStructure
|
|
381
|
-
* @property {string} [_id]
|
|
507
|
+
* @typedef SubscribedEmailTemplates
|
|
508
|
+
* @property {EmailTemplate[]} [items]
|
|
382
509
|
*/
|
|
383
510
|
/**
|
|
384
|
-
* @typedef
|
|
385
|
-
* @property {
|
|
386
|
-
* @property {
|
|
511
|
+
* @typedef EventSubscriptionTemplateSms
|
|
512
|
+
* @property {boolean} [subscribed]
|
|
513
|
+
* @property {string} [template]
|
|
387
514
|
*/
|
|
388
515
|
/**
|
|
389
|
-
* @typedef
|
|
390
|
-
* @property {
|
|
391
|
-
* @property {
|
|
516
|
+
* @typedef EventSubscriptionTemplateEmail
|
|
517
|
+
* @property {boolean} [subscribed]
|
|
518
|
+
* @property {string} [template]
|
|
392
519
|
*/
|
|
393
520
|
/**
|
|
394
|
-
* @typedef
|
|
395
|
-
* @property {
|
|
521
|
+
* @typedef EventSubscriptionTemplatePushnotification
|
|
522
|
+
* @property {boolean} [subscribed]
|
|
396
523
|
*/
|
|
397
524
|
/**
|
|
398
|
-
* @typedef
|
|
399
|
-
* @property {
|
|
400
|
-
* @property {
|
|
525
|
+
* @typedef EventSubscriptionTemplate
|
|
526
|
+
* @property {EventSubscriptionTemplateSms} [sms]
|
|
527
|
+
* @property {EventSubscriptionTemplateEmail} [email]
|
|
528
|
+
* @property {EventSubscriptionTemplatePushnotification} [pushnotification]
|
|
401
529
|
*/
|
|
402
530
|
/**
|
|
403
|
-
* @typedef
|
|
404
|
-
* @property {
|
|
405
|
-
* @property {
|
|
406
|
-
* @property {
|
|
531
|
+
* @typedef EventSubscription
|
|
532
|
+
* @property {EventSubscriptionTemplate} [template]
|
|
533
|
+
* @property {boolean} [is_default]
|
|
534
|
+
* @property {string} [_id]
|
|
407
535
|
* @property {string} [application]
|
|
536
|
+
* @property {string} [category]
|
|
537
|
+
* @property {Object} [event]
|
|
538
|
+
* @property {string} [slug]
|
|
539
|
+
* @property {string} [created_at]
|
|
540
|
+
* @property {string} [updated_at]
|
|
541
|
+
* @property {number} [__v]
|
|
408
542
|
*/
|
|
409
543
|
/**
|
|
410
|
-
* @typedef
|
|
411
|
-
* @property {string} [job_type]
|
|
412
|
-
* @property {string} [action]
|
|
413
|
-
* @property {string} [trace]
|
|
414
|
-
* @property {string} [timestamp]
|
|
415
|
-
*/
|
|
416
|
-
/**
|
|
417
|
-
* @typedef EnginePayload
|
|
418
|
-
* @property {PayloadStructure} [payload]
|
|
419
|
-
* @property {MetaStructure} [meta]
|
|
420
|
-
*/
|
|
421
|
-
/**
|
|
422
|
-
* @typedef EngineResult
|
|
423
|
-
* @property {boolean} [success]
|
|
424
|
-
*/
|
|
425
|
-
/**
|
|
426
|
-
* @typedef EventSubscriptionTemplateSms
|
|
544
|
+
* @typedef EventSubscriptionTemplateSmsObj
|
|
427
545
|
* @property {boolean} [subscribed]
|
|
428
|
-
* @property {
|
|
546
|
+
* @property {Object} [template]
|
|
429
547
|
*/
|
|
430
548
|
/**
|
|
431
|
-
* @typedef
|
|
549
|
+
* @typedef EventSubscriptionTemplateEmailObj
|
|
432
550
|
* @property {boolean} [subscribed]
|
|
433
551
|
* @property {string} [template]
|
|
434
552
|
*/
|
|
435
553
|
/**
|
|
436
|
-
* @typedef
|
|
437
|
-
* @property {
|
|
438
|
-
* @property {
|
|
554
|
+
* @typedef EventSubscriptionTemplateObj
|
|
555
|
+
* @property {EventSubscriptionTemplateSmsObj} [sms]
|
|
556
|
+
* @property {EventSubscriptionTemplateEmailObj} [email]
|
|
557
|
+
* @property {EventSubscriptionTemplatePushnotification} [pushnotification]
|
|
439
558
|
*/
|
|
440
559
|
/**
|
|
441
|
-
* @typedef
|
|
442
|
-
* @property {
|
|
560
|
+
* @typedef EventSubscriptionObj
|
|
561
|
+
* @property {EventSubscriptionTemplateObj} [template]
|
|
443
562
|
* @property {boolean} [is_default]
|
|
444
563
|
* @property {string} [_id]
|
|
445
564
|
* @property {string} [application]
|
|
446
|
-
* @property {string} [
|
|
565
|
+
* @property {string} [category]
|
|
566
|
+
* @property {Object} [event]
|
|
447
567
|
* @property {string} [slug]
|
|
448
568
|
* @property {string} [created_at]
|
|
449
569
|
* @property {string} [updated_at]
|
|
@@ -451,24 +571,24 @@ export = CommunicationPlatformModel;
|
|
|
451
571
|
*/
|
|
452
572
|
/**
|
|
453
573
|
* @typedef EventSubscriptions
|
|
454
|
-
* @property {
|
|
574
|
+
* @property {EventSubscriptionObj[]} [items]
|
|
455
575
|
* @property {Page} [page]
|
|
456
576
|
*/
|
|
457
577
|
/**
|
|
458
|
-
* @typedef
|
|
578
|
+
* @typedef TriggerJobResponse
|
|
459
579
|
* @property {number} [status]
|
|
460
580
|
*/
|
|
461
581
|
/**
|
|
462
|
-
* @typedef
|
|
582
|
+
* @typedef TriggerJobRequest
|
|
463
583
|
* @property {string} [job_id]
|
|
464
584
|
*/
|
|
465
585
|
/**
|
|
466
|
-
* @typedef
|
|
586
|
+
* @typedef GlobalVariablesGetResponse
|
|
467
587
|
* @property {Object} [read_only]
|
|
468
588
|
* @property {Object} [editable]
|
|
469
589
|
*/
|
|
470
590
|
/**
|
|
471
|
-
* @typedef
|
|
591
|
+
* @typedef GlobalVariablesPostResponse
|
|
472
592
|
* @property {string} [_id]
|
|
473
593
|
* @property {string} [category]
|
|
474
594
|
* @property {string} [application]
|
|
@@ -512,8 +632,8 @@ export = CommunicationPlatformModel;
|
|
|
512
632
|
*/
|
|
513
633
|
/**
|
|
514
634
|
* @typedef JobLog
|
|
515
|
-
* @property {
|
|
516
|
-
* @property {
|
|
635
|
+
* @property {StatsImported} [imported]
|
|
636
|
+
* @property {StatsProcessed} [processed]
|
|
517
637
|
* @property {string} [_id]
|
|
518
638
|
* @property {string} [job]
|
|
519
639
|
* @property {string} [campaign]
|
|
@@ -529,6 +649,15 @@ export = CommunicationPlatformModel;
|
|
|
529
649
|
/**
|
|
530
650
|
* @typedef LogEmail
|
|
531
651
|
* @property {string} [template]
|
|
652
|
+
* @property {string} [provider]
|
|
653
|
+
* @property {string} [to]
|
|
654
|
+
*/
|
|
655
|
+
/**
|
|
656
|
+
* @typedef LogSms
|
|
657
|
+
* @property {string} [template]
|
|
658
|
+
* @property {string} [provider]
|
|
659
|
+
* @property {string} [phone_number]
|
|
660
|
+
* @property {string} [country_code]
|
|
532
661
|
*/
|
|
533
662
|
/**
|
|
534
663
|
* @typedef LogPushnotification
|
|
@@ -536,8 +665,10 @@ export = CommunicationPlatformModel;
|
|
|
536
665
|
*/
|
|
537
666
|
/**
|
|
538
667
|
* @typedef LogMeta
|
|
539
|
-
* @property {string} [type]
|
|
540
668
|
* @property {string} [identifier]
|
|
669
|
+
* @property {string} [type]
|
|
670
|
+
* @property {string} [job]
|
|
671
|
+
* @property {string} [campaign]
|
|
541
672
|
* @property {string} [key]
|
|
542
673
|
* @property {string} [offset]
|
|
543
674
|
* @property {string} [partition]
|
|
@@ -546,27 +677,24 @@ export = CommunicationPlatformModel;
|
|
|
546
677
|
/**
|
|
547
678
|
* @typedef Log
|
|
548
679
|
* @property {LogEmail} [email]
|
|
680
|
+
* @property {LogSms} [sms]
|
|
549
681
|
* @property {LogPushnotification} [pushnotification]
|
|
550
|
-
* @property {LogMeta} [meta]
|
|
551
682
|
* @property {string} [_id]
|
|
552
|
-
* @property {string} [
|
|
683
|
+
* @property {string} [pod]
|
|
553
684
|
* @property {string} [service]
|
|
554
685
|
* @property {string} [step]
|
|
686
|
+
* @property {string} [source]
|
|
555
687
|
* @property {string} [status]
|
|
556
|
-
* @property {Object} [data]
|
|
557
688
|
* @property {string} [expire_at]
|
|
558
689
|
* @property {string} [created_at]
|
|
690
|
+
* @property {LogMeta} [meta]
|
|
691
|
+
* @property {string} [application]
|
|
559
692
|
*/
|
|
560
693
|
/**
|
|
561
694
|
* @typedef Logs
|
|
562
695
|
* @property {Log[]} [items]
|
|
563
696
|
* @property {Page} [page]
|
|
564
697
|
*/
|
|
565
|
-
/**
|
|
566
|
-
* @typedef SendOtpSmsCommsTemplate
|
|
567
|
-
* @property {string} [key]
|
|
568
|
-
* @property {Object} [value]
|
|
569
|
-
*/
|
|
570
698
|
/**
|
|
571
699
|
* @typedef SendOtpSmsCommsProvider
|
|
572
700
|
* @property {string} [slug]
|
|
@@ -593,7 +721,7 @@ export = CommunicationPlatformModel;
|
|
|
593
721
|
* @typedef SendOtpCommsReqSms
|
|
594
722
|
* @property {number} [otp_length]
|
|
595
723
|
* @property {number} [expiry]
|
|
596
|
-
* @property {
|
|
724
|
+
* @property {Object} [template]
|
|
597
725
|
* @property {SendOtpSmsCommsProvider} [provider]
|
|
598
726
|
*/
|
|
599
727
|
/**
|
|
@@ -644,15 +772,9 @@ export = CommunicationPlatformModel;
|
|
|
644
772
|
* @property {string} [message]
|
|
645
773
|
* @property {string} [email]
|
|
646
774
|
*/
|
|
647
|
-
/**
|
|
648
|
-
* @typedef VerifyOtpCommsErrorRes
|
|
649
|
-
* @property {boolean} [success]
|
|
650
|
-
* @property {string} [message]
|
|
651
|
-
*/
|
|
652
775
|
/**
|
|
653
776
|
* @typedef SmsProviderReq
|
|
654
777
|
* @property {string} [name]
|
|
655
|
-
* @property {string} [token]
|
|
656
778
|
* @property {string} [description]
|
|
657
779
|
* @property {string} [sender]
|
|
658
780
|
* @property {string} [username]
|
|
@@ -671,15 +793,9 @@ export = CommunicationPlatformModel;
|
|
|
671
793
|
* @property {number} [version_id] - The version ID for the test.
|
|
672
794
|
* @property {string} [sender_id] - The sender ID for the test.
|
|
673
795
|
* @property {string} [api_key] - The api_key for the test.
|
|
674
|
-
* @property {string} [tenant_name_1] - First part of jiocx url.
|
|
675
|
-
* @property {string} [tenant_name_2] - Second part of jiocx url.
|
|
676
796
|
*/
|
|
677
797
|
/**
|
|
678
798
|
* @typedef SmsProvider
|
|
679
|
-
* @property {string} [token]
|
|
680
|
-
* @property {string} [sender_id]
|
|
681
|
-
* @property {string} [api_key]
|
|
682
|
-
* @property {number} [expiry_date]
|
|
683
799
|
* @property {number} [rpt]
|
|
684
800
|
* @property {string} [type]
|
|
685
801
|
* @property {string} [provider]
|
|
@@ -689,6 +805,7 @@ export = CommunicationPlatformModel;
|
|
|
689
805
|
* @property {string} [sender]
|
|
690
806
|
* @property {string} [username]
|
|
691
807
|
* @property {string} [authkey]
|
|
808
|
+
* @property {string} [entity_id]
|
|
692
809
|
* @property {string} [application]
|
|
693
810
|
* @property {string} [created_at]
|
|
694
811
|
* @property {string} [updated_at]
|
|
@@ -784,6 +901,12 @@ export = CommunicationPlatformModel;
|
|
|
784
901
|
* @property {string} [deeplink]
|
|
785
902
|
* @property {string} [click_action]
|
|
786
903
|
*/
|
|
904
|
+
/**
|
|
905
|
+
* @typedef SystemNotificationSetting
|
|
906
|
+
* @property {boolean} [sound]
|
|
907
|
+
* @property {string} [priority]
|
|
908
|
+
* @property {string} [time_to_live]
|
|
909
|
+
*/
|
|
787
910
|
/**
|
|
788
911
|
* @typedef SystemNotificationUser
|
|
789
912
|
* @property {string} [type]
|
|
@@ -793,7 +916,7 @@ export = CommunicationPlatformModel;
|
|
|
793
916
|
* @typedef SystemNotification
|
|
794
917
|
* @property {Notification} [notification]
|
|
795
918
|
* @property {SystemNotificationUser} [user]
|
|
796
|
-
* @property {
|
|
919
|
+
* @property {SystemNotificationSetting} [settings]
|
|
797
920
|
* @property {string} [_id]
|
|
798
921
|
* @property {string} [group]
|
|
799
922
|
* @property {string} [created_at]
|
|
@@ -813,25 +936,12 @@ export = CommunicationPlatformModel;
|
|
|
813
936
|
* @property {number} [current] - The current page number.
|
|
814
937
|
* @property {string} type - The type of the page, such as 'PageType'.
|
|
815
938
|
* @property {number} [size] - The number of items per page.
|
|
939
|
+
* @property {number} [total] - Total number of items.
|
|
816
940
|
*/
|
|
817
941
|
/**
|
|
818
|
-
* @typedef
|
|
819
|
-
* @property {Message} [message]
|
|
820
|
-
* @property {string} [sentry]
|
|
821
|
-
*/
|
|
822
|
-
/**
|
|
823
|
-
* @typedef GenericDelete
|
|
824
|
-
* @property {string} [message]
|
|
942
|
+
* @typedef BasicDelete
|
|
825
943
|
* @property {boolean} [acknowledged]
|
|
826
|
-
* @property {number} [
|
|
827
|
-
* @property {string} [operation]
|
|
828
|
-
*/
|
|
829
|
-
/**
|
|
830
|
-
* @typedef Message
|
|
831
|
-
* @property {string} [message]
|
|
832
|
-
* @property {boolean} [success]
|
|
833
|
-
* @property {string} [info]
|
|
834
|
-
* @property {string} [operation]
|
|
944
|
+
* @property {number} [deleted_count]
|
|
835
945
|
*/
|
|
836
946
|
/**
|
|
837
947
|
* @typedef EnabledObj
|
|
@@ -847,27 +957,177 @@ export = CommunicationPlatformModel;
|
|
|
847
957
|
* @property {OtpConfigurationExpiryDuration} duration
|
|
848
958
|
* @property {string} type
|
|
849
959
|
*/
|
|
960
|
+
/**
|
|
961
|
+
* @typedef OtpConfigRateLimit
|
|
962
|
+
* @property {number} [duration]
|
|
963
|
+
* @property {number} [limit]
|
|
964
|
+
*/
|
|
850
965
|
/**
|
|
851
966
|
* @typedef OtpConfiguration
|
|
852
967
|
* @property {number} otp_length
|
|
853
968
|
* @property {string} type
|
|
854
969
|
* @property {OtpConfigurationExpiry} expiry
|
|
970
|
+
* @property {OtpConfigRateLimit} rate_limit
|
|
855
971
|
* @property {string} [application_id]
|
|
856
972
|
* @property {string} [company_id]
|
|
857
973
|
*/
|
|
858
974
|
declare class CommunicationPlatformModel {
|
|
859
975
|
}
|
|
860
976
|
declare namespace CommunicationPlatformModel {
|
|
861
|
-
export {
|
|
977
|
+
export { AppProvidersGlobalProviderRequestObjProvider, AppProvidersGlobalProviderRequestObj, AppProvidersGlobalProviderRequest, UpdateAppProvidersGlobalProviderResponseEmailSmsObj, UpdateAppProvidersGlobalProviderResponse, DefaultEmailProvidersFromAddresses, DefaultEmailProviders, PushtokenReq, PushtokenRes, SendInstantResponse, MetaStructure, PayloadSmsTemplateStructure, PayloadSmsProviderStructure, PayloadEmailTemplateStructure, PayloadEmailProviderStructure, PayloadEmailStructure, PayloadSmsStructure, SendSyncData, SendSyncRequest, EngineRequest, EngineResponse, EventSubscriptionsBulkUpdateRequest, EventSubscriptionsBulkUpdateResponse, SubscriptionsObjectRequest, SubscriptionsObject, TemplateObject, CommunicationTemplate, AppProvider, AppProviderRes, AppProviderResVoice, AppProviderResObj, GlobalProviders, GlobalProvidersResObj, AppProviderReq, StatsImported, StatsProcessedEmail, StatsProcessedSms, StatsProcessed, Stats, GetStats, CampaignReq, RecipientHeaders, CampaignEmailTemplate, CampignEmailProvider, CampaignEmail, Campaign, Campaigns, AudienceReq, Audience, Audiences, GetNRecordsCsvReq, GetNRecordsCsvResItems, GetNRecordsCsvRes, DummyDatasources, DummyDatasourcesMeta, DummyDatasourcesMetaObj, EmailProviderReqFrom, EmailProviderReq, EmailProvider, EmailProviders, EmailTemplateKeys, EmailTemplateHeaders, EmailTemplateReq, TemplateAndType, TemplateKeys, EmailTemplate, SystemEmailTemplate, EmailTemplates, SubscribedSmsTemplates, SubscribedEmailTemplates, EventSubscriptionTemplateSms, EventSubscriptionTemplateEmail, EventSubscriptionTemplatePushnotification, EventSubscriptionTemplate, EventSubscription, EventSubscriptionTemplateSmsObj, EventSubscriptionTemplateEmailObj, EventSubscriptionTemplateObj, EventSubscriptionObj, EventSubscriptions, TriggerJobResponse, TriggerJobRequest, GlobalVariablesGetResponse, GlobalVariablesPostResponse, GlobalVariablesReq, Job, Jobs, CreateJobsRes, CreateJobsReq, JobLog, JobLogs, LogEmail, LogSms, LogPushnotification, LogMeta, Log, Logs, SendOtpSmsCommsProvider, SendOtpEmailCommsProvider, SendOtpEmailCommsTemplate, SendOtpCommsReqData, SendOtpCommsReqSms, SendOtpCommsReqEmail, SendOtpCommsResSms, SendOtpCommsResEmail, SendOtpCommsReq, SendOtpCommsRes, VerifyOtpCommsReq, VerifyOtpCommsSuccessRes, SmsProviderReq, SmsProvider, SmsProviders, DefaultSmsProviders, SmsTemplateMessage, SmsTemplates, SmsTemplate, SystemSmsTemplates, metaObj, SmsTemplateReq, Notification, SystemNotificationSetting, SystemNotificationUser, SystemNotification, SystemNotifications, Page, BasicDelete, EnabledObj, OtpConfigurationExpiryDuration, OtpConfigurationExpiry, OtpConfigRateLimit, OtpConfiguration };
|
|
862
978
|
}
|
|
863
|
-
/** @returns {
|
|
864
|
-
declare function
|
|
865
|
-
type
|
|
979
|
+
/** @returns {AppProvidersGlobalProviderRequestObjProvider} */
|
|
980
|
+
declare function AppProvidersGlobalProviderRequestObjProvider(): AppProvidersGlobalProviderRequestObjProvider;
|
|
981
|
+
type AppProvidersGlobalProviderRequestObjProvider = {
|
|
982
|
+
provider?: string;
|
|
983
|
+
};
|
|
984
|
+
/** @returns {AppProvidersGlobalProviderRequestObj} */
|
|
985
|
+
declare function AppProvidersGlobalProviderRequestObj(): AppProvidersGlobalProviderRequestObj;
|
|
986
|
+
type AppProvidersGlobalProviderRequestObj = {
|
|
987
|
+
transaction?: AppProvidersGlobalProviderRequestObjProvider;
|
|
988
|
+
otp?: AppProvidersGlobalProviderRequestObjProvider;
|
|
989
|
+
};
|
|
990
|
+
/** @returns {AppProvidersGlobalProviderRequest} */
|
|
991
|
+
declare function AppProvidersGlobalProviderRequest(): AppProvidersGlobalProviderRequest;
|
|
992
|
+
type AppProvidersGlobalProviderRequest = {
|
|
993
|
+
email?: AppProvidersGlobalProviderRequestObj;
|
|
994
|
+
sms?: AppProvidersGlobalProviderRequestObj;
|
|
995
|
+
};
|
|
996
|
+
/** @returns {UpdateAppProvidersGlobalProviderResponseEmailSmsObj} */
|
|
997
|
+
declare function UpdateAppProvidersGlobalProviderResponseEmailSmsObj(): UpdateAppProvidersGlobalProviderResponseEmailSmsObj;
|
|
998
|
+
type UpdateAppProvidersGlobalProviderResponseEmailSmsObj = {
|
|
999
|
+
default_provider?: string;
|
|
1000
|
+
otp_provider?: string;
|
|
1001
|
+
};
|
|
1002
|
+
/** @returns {UpdateAppProvidersGlobalProviderResponse} */
|
|
1003
|
+
declare function UpdateAppProvidersGlobalProviderResponse(): UpdateAppProvidersGlobalProviderResponse;
|
|
1004
|
+
type UpdateAppProvidersGlobalProviderResponse = {
|
|
1005
|
+
email?: UpdateAppProvidersGlobalProviderResponseEmailSmsObj;
|
|
1006
|
+
sms?: UpdateAppProvidersGlobalProviderResponseEmailSmsObj;
|
|
1007
|
+
_id?: string;
|
|
1008
|
+
slug?: string;
|
|
1009
|
+
};
|
|
1010
|
+
/** @returns {DefaultEmailProvidersFromAddresses} */
|
|
1011
|
+
declare function DefaultEmailProvidersFromAddresses(): DefaultEmailProvidersFromAddresses;
|
|
1012
|
+
type DefaultEmailProvidersFromAddresses = {
|
|
1013
|
+
name?: string;
|
|
1014
|
+
email?: string;
|
|
1015
|
+
is_default?: boolean;
|
|
1016
|
+
};
|
|
1017
|
+
/** @returns {DefaultEmailProviders} */
|
|
1018
|
+
declare function DefaultEmailProviders(): DefaultEmailProviders;
|
|
1019
|
+
type DefaultEmailProviders = {
|
|
1020
|
+
_id?: string;
|
|
1021
|
+
from_address?: DefaultEmailProvidersFromAddresses[];
|
|
1022
|
+
name?: string;
|
|
1023
|
+
is_default?: boolean;
|
|
1024
|
+
};
|
|
1025
|
+
/** @returns {PushtokenReq} */
|
|
1026
|
+
declare function PushtokenReq(): PushtokenReq;
|
|
1027
|
+
type PushtokenReq = {
|
|
1028
|
+
action?: string;
|
|
1029
|
+
bundle_identifier?: string;
|
|
1030
|
+
push_token?: string;
|
|
1031
|
+
unique_device_id?: string;
|
|
1032
|
+
type?: string;
|
|
1033
|
+
};
|
|
1034
|
+
/** @returns {PushtokenRes} */
|
|
1035
|
+
declare function PushtokenRes(): PushtokenRes;
|
|
1036
|
+
type PushtokenRes = {
|
|
1037
|
+
_id?: string;
|
|
1038
|
+
bundle_identifier?: string;
|
|
1039
|
+
push_token?: string;
|
|
1040
|
+
unique_device_id?: string;
|
|
1041
|
+
type?: string;
|
|
1042
|
+
platform?: string;
|
|
1043
|
+
application_id?: string;
|
|
1044
|
+
user_id?: string;
|
|
1045
|
+
created_at?: string;
|
|
1046
|
+
updated_at?: string;
|
|
1047
|
+
expired_at?: string;
|
|
1048
|
+
};
|
|
1049
|
+
/** @returns {SendInstantResponse} */
|
|
1050
|
+
declare function SendInstantResponse(): SendInstantResponse;
|
|
1051
|
+
type SendInstantResponse = {
|
|
1052
|
+
success?: boolean;
|
|
1053
|
+
provider?: string;
|
|
1054
|
+
response?: boolean;
|
|
1055
|
+
};
|
|
1056
|
+
/** @returns {MetaStructure} */
|
|
1057
|
+
declare function MetaStructure(): MetaStructure;
|
|
1058
|
+
type MetaStructure = {
|
|
1059
|
+
job_type?: string;
|
|
1060
|
+
action?: string;
|
|
1061
|
+
trace?: string;
|
|
1062
|
+
timestamp?: string;
|
|
1063
|
+
};
|
|
1064
|
+
/** @returns {PayloadSmsTemplateStructure} */
|
|
1065
|
+
declare function PayloadSmsTemplateStructure(): PayloadSmsTemplateStructure;
|
|
1066
|
+
type PayloadSmsTemplateStructure = {
|
|
1067
|
+
key?: string;
|
|
1068
|
+
value?: any;
|
|
1069
|
+
};
|
|
1070
|
+
/** @returns {PayloadSmsProviderStructure} */
|
|
1071
|
+
declare function PayloadSmsProviderStructure(): PayloadSmsProviderStructure;
|
|
1072
|
+
type PayloadSmsProviderStructure = {
|
|
1073
|
+
slug?: string;
|
|
1074
|
+
};
|
|
1075
|
+
/** @returns {PayloadEmailTemplateStructure} */
|
|
1076
|
+
declare function PayloadEmailTemplateStructure(): PayloadEmailTemplateStructure;
|
|
1077
|
+
type PayloadEmailTemplateStructure = {
|
|
1078
|
+
key?: string;
|
|
1079
|
+
value?: any;
|
|
1080
|
+
};
|
|
1081
|
+
/** @returns {PayloadEmailProviderStructure} */
|
|
1082
|
+
declare function PayloadEmailProviderStructure(): PayloadEmailProviderStructure;
|
|
1083
|
+
type PayloadEmailProviderStructure = {
|
|
1084
|
+
slug?: string;
|
|
1085
|
+
};
|
|
1086
|
+
/** @returns {PayloadEmailStructure} */
|
|
1087
|
+
declare function PayloadEmailStructure(): PayloadEmailStructure;
|
|
1088
|
+
type PayloadEmailStructure = {
|
|
1089
|
+
template?: PayloadEmailTemplateStructure;
|
|
1090
|
+
provider?: PayloadEmailProviderStructure;
|
|
1091
|
+
};
|
|
1092
|
+
/** @returns {PayloadSmsStructure} */
|
|
1093
|
+
declare function PayloadSmsStructure(): PayloadSmsStructure;
|
|
1094
|
+
type PayloadSmsStructure = {
|
|
1095
|
+
template?: PayloadSmsTemplateStructure;
|
|
1096
|
+
provider?: PayloadSmsProviderStructure;
|
|
1097
|
+
};
|
|
1098
|
+
/** @returns {SendSyncData} */
|
|
1099
|
+
declare function SendSyncData(): SendSyncData;
|
|
1100
|
+
type SendSyncData = {
|
|
1101
|
+
phone_number?: string;
|
|
1102
|
+
country_code?: string;
|
|
1103
|
+
to?: string;
|
|
1104
|
+
};
|
|
1105
|
+
/** @returns {SendSyncRequest} */
|
|
1106
|
+
declare function SendSyncRequest(): SendSyncRequest;
|
|
1107
|
+
type SendSyncRequest = {
|
|
1108
|
+
data?: SendSyncData[];
|
|
1109
|
+
email?: PayloadEmailStructure;
|
|
1110
|
+
sms?: PayloadSmsStructure;
|
|
1111
|
+
};
|
|
1112
|
+
/** @returns {EngineRequest} */
|
|
1113
|
+
declare function EngineRequest(): EngineRequest;
|
|
1114
|
+
type EngineRequest = {
|
|
1115
|
+
payload?: SendSyncRequest;
|
|
1116
|
+
meta?: MetaStructure;
|
|
1117
|
+
};
|
|
1118
|
+
/** @returns {EngineResponse} */
|
|
1119
|
+
declare function EngineResponse(): EngineResponse;
|
|
1120
|
+
type EngineResponse = {
|
|
1121
|
+
success?: boolean;
|
|
1122
|
+
};
|
|
1123
|
+
/** @returns {EventSubscriptionsBulkUpdateRequest} */
|
|
1124
|
+
declare function EventSubscriptionsBulkUpdateRequest(): EventSubscriptionsBulkUpdateRequest;
|
|
1125
|
+
type EventSubscriptionsBulkUpdateRequest = {
|
|
866
1126
|
subscriptions?: SubscriptionsObject[];
|
|
867
1127
|
};
|
|
868
|
-
/** @returns {
|
|
869
|
-
declare function
|
|
870
|
-
type
|
|
1128
|
+
/** @returns {EventSubscriptionsBulkUpdateResponse} */
|
|
1129
|
+
declare function EventSubscriptionsBulkUpdateResponse(): EventSubscriptionsBulkUpdateResponse;
|
|
1130
|
+
type EventSubscriptionsBulkUpdateResponse = {
|
|
871
1131
|
template?: EventSubscriptionTemplate;
|
|
872
1132
|
_id?: string;
|
|
873
1133
|
application?: string;
|
|
@@ -878,6 +1138,13 @@ type EventSubscriptionsBulkUpdateResult = {
|
|
|
878
1138
|
updated_at?: string;
|
|
879
1139
|
__v?: number;
|
|
880
1140
|
};
|
|
1141
|
+
/** @returns {SubscriptionsObjectRequest} */
|
|
1142
|
+
declare function SubscriptionsObjectRequest(): SubscriptionsObjectRequest;
|
|
1143
|
+
type SubscriptionsObjectRequest = {
|
|
1144
|
+
event?: string;
|
|
1145
|
+
slug?: string;
|
|
1146
|
+
template?: TemplateObject;
|
|
1147
|
+
};
|
|
881
1148
|
/** @returns {SubscriptionsObject} */
|
|
882
1149
|
declare function SubscriptionsObject(): SubscriptionsObject;
|
|
883
1150
|
type SubscriptionsObject = {
|
|
@@ -885,6 +1152,8 @@ type SubscriptionsObject = {
|
|
|
885
1152
|
* - Subscription ID
|
|
886
1153
|
*/
|
|
887
1154
|
_id?: string;
|
|
1155
|
+
event?: string;
|
|
1156
|
+
slug?: string;
|
|
888
1157
|
template?: TemplateObject;
|
|
889
1158
|
};
|
|
890
1159
|
/** @returns {TemplateObject} */
|
|
@@ -985,8 +1254,8 @@ type StatsProcessed = {
|
|
|
985
1254
|
declare function Stats(): Stats;
|
|
986
1255
|
type Stats = {
|
|
987
1256
|
_id?: string;
|
|
988
|
-
imported?:
|
|
989
|
-
processed?:
|
|
1257
|
+
imported?: StatsImported;
|
|
1258
|
+
processed?: StatsProcessed;
|
|
990
1259
|
};
|
|
991
1260
|
/** @returns {GetStats} */
|
|
992
1261
|
declare function GetStats(): GetStats;
|
|
@@ -996,6 +1265,9 @@ type GetStats = {
|
|
|
996
1265
|
/** @returns {CampaignReq} */
|
|
997
1266
|
declare function CampaignReq(): CampaignReq;
|
|
998
1267
|
type CampaignReq = {
|
|
1268
|
+
recipient_headers?: RecipientHeaders;
|
|
1269
|
+
email?: CampaignEmail;
|
|
1270
|
+
datasource?: string;
|
|
999
1271
|
description?: string;
|
|
1000
1272
|
tags?: string[];
|
|
1001
1273
|
headers?: string[];
|
|
@@ -1036,7 +1308,7 @@ type Campaign = {
|
|
|
1036
1308
|
recipient_headers?: RecipientHeaders;
|
|
1037
1309
|
email?: CampaignEmail;
|
|
1038
1310
|
description?: string;
|
|
1039
|
-
tags?:
|
|
1311
|
+
tags?: string[];
|
|
1040
1312
|
is_active?: boolean;
|
|
1041
1313
|
_id?: string;
|
|
1042
1314
|
datasource?: string;
|
|
@@ -1054,26 +1326,6 @@ type Campaigns = {
|
|
|
1054
1326
|
items?: Campaign[];
|
|
1055
1327
|
page?: Page;
|
|
1056
1328
|
};
|
|
1057
|
-
/** @returns {BadRequestSchema} */
|
|
1058
|
-
declare function BadRequestSchema(): BadRequestSchema;
|
|
1059
|
-
type BadRequestSchema = {
|
|
1060
|
-
/**
|
|
1061
|
-
* - Response status.
|
|
1062
|
-
*/
|
|
1063
|
-
status?: string;
|
|
1064
|
-
/**
|
|
1065
|
-
* - Failure message.
|
|
1066
|
-
*/
|
|
1067
|
-
message?: string;
|
|
1068
|
-
};
|
|
1069
|
-
/** @returns {NotFound} */
|
|
1070
|
-
declare function NotFound(): NotFound;
|
|
1071
|
-
type NotFound = {
|
|
1072
|
-
/**
|
|
1073
|
-
* - Failure message.
|
|
1074
|
-
*/
|
|
1075
|
-
message?: string;
|
|
1076
|
-
};
|
|
1077
1329
|
/** @returns {AudienceReq} */
|
|
1078
1330
|
declare function AudienceReq(): AudienceReq;
|
|
1079
1331
|
type AudienceReq = {
|
|
@@ -1228,6 +1480,13 @@ type TemplateAndType = {
|
|
|
1228
1480
|
template_type?: string;
|
|
1229
1481
|
template?: string;
|
|
1230
1482
|
};
|
|
1483
|
+
/** @returns {TemplateKeys} */
|
|
1484
|
+
declare function TemplateKeys(): TemplateKeys;
|
|
1485
|
+
type TemplateKeys = {
|
|
1486
|
+
to?: string;
|
|
1487
|
+
cc?: string;
|
|
1488
|
+
bcc?: string;
|
|
1489
|
+
};
|
|
1231
1490
|
/** @returns {EmailTemplate} */
|
|
1232
1491
|
declare function EmailTemplate(): EmailTemplate;
|
|
1233
1492
|
type EmailTemplate = {
|
|
@@ -1244,6 +1503,7 @@ type EmailTemplate = {
|
|
|
1244
1503
|
reply_to?: string;
|
|
1245
1504
|
tags?: string[];
|
|
1246
1505
|
subject?: TemplateAndType;
|
|
1506
|
+
keys?: TemplateKeys;
|
|
1247
1507
|
html?: TemplateAndType;
|
|
1248
1508
|
url_shorten?: EnabledObj;
|
|
1249
1509
|
priority?: string;
|
|
@@ -1293,71 +1553,15 @@ type EmailTemplates = {
|
|
|
1293
1553
|
items?: EmailTemplate[];
|
|
1294
1554
|
page?: Page;
|
|
1295
1555
|
};
|
|
1296
|
-
/** @returns {
|
|
1297
|
-
declare function
|
|
1298
|
-
type
|
|
1299
|
-
items?:
|
|
1300
|
-
};
|
|
1301
|
-
/** @returns {PayloadEmailTemplateStructure} */
|
|
1302
|
-
declare function PayloadEmailTemplateStructure(): PayloadEmailTemplateStructure;
|
|
1303
|
-
type PayloadEmailTemplateStructure = {
|
|
1304
|
-
key?: string;
|
|
1305
|
-
value?: any;
|
|
1306
|
-
};
|
|
1307
|
-
/** @returns {PayloadEmailProviderStructure} */
|
|
1308
|
-
declare function PayloadEmailProviderStructure(): PayloadEmailProviderStructure;
|
|
1309
|
-
type PayloadEmailProviderStructure = {
|
|
1310
|
-
_id?: string;
|
|
1311
|
-
};
|
|
1312
|
-
/** @returns {PayloadEmailStructure} */
|
|
1313
|
-
declare function PayloadEmailStructure(): PayloadEmailStructure;
|
|
1314
|
-
type PayloadEmailStructure = {
|
|
1315
|
-
template?: PayloadEmailTemplateStructure;
|
|
1316
|
-
provider?: PayloadEmailProviderStructure;
|
|
1317
|
-
};
|
|
1318
|
-
/** @returns {PayloadSmsTemplateStructure} */
|
|
1319
|
-
declare function PayloadSmsTemplateStructure(): PayloadSmsTemplateStructure;
|
|
1320
|
-
type PayloadSmsTemplateStructure = {
|
|
1321
|
-
key?: string;
|
|
1322
|
-
value?: any;
|
|
1323
|
-
};
|
|
1324
|
-
/** @returns {PayloadSmsProviderStructure} */
|
|
1325
|
-
declare function PayloadSmsProviderStructure(): PayloadSmsProviderStructure;
|
|
1326
|
-
type PayloadSmsProviderStructure = {
|
|
1327
|
-
_id?: string;
|
|
1328
|
-
};
|
|
1329
|
-
/** @returns {PayloadSmsStructure} */
|
|
1330
|
-
declare function PayloadSmsStructure(): PayloadSmsStructure;
|
|
1331
|
-
type PayloadSmsStructure = {
|
|
1332
|
-
template?: PayloadSmsTemplateStructure;
|
|
1333
|
-
provider?: PayloadSmsProviderStructure;
|
|
1334
|
-
};
|
|
1335
|
-
/** @returns {PayloadStructure} */
|
|
1336
|
-
declare function PayloadStructure(): PayloadStructure;
|
|
1337
|
-
type PayloadStructure = {
|
|
1338
|
-
data?: any[];
|
|
1339
|
-
email?: PayloadEmailStructure;
|
|
1340
|
-
sms?: PayloadSmsStructure;
|
|
1341
|
-
application?: string;
|
|
1342
|
-
};
|
|
1343
|
-
/** @returns {MetaStructure} */
|
|
1344
|
-
declare function MetaStructure(): MetaStructure;
|
|
1345
|
-
type MetaStructure = {
|
|
1346
|
-
job_type?: string;
|
|
1347
|
-
action?: string;
|
|
1348
|
-
trace?: string;
|
|
1349
|
-
timestamp?: string;
|
|
1350
|
-
};
|
|
1351
|
-
/** @returns {EnginePayload} */
|
|
1352
|
-
declare function EnginePayload(): EnginePayload;
|
|
1353
|
-
type EnginePayload = {
|
|
1354
|
-
payload?: PayloadStructure;
|
|
1355
|
-
meta?: MetaStructure;
|
|
1556
|
+
/** @returns {SubscribedSmsTemplates} */
|
|
1557
|
+
declare function SubscribedSmsTemplates(): SubscribedSmsTemplates;
|
|
1558
|
+
type SubscribedSmsTemplates = {
|
|
1559
|
+
items?: SmsTemplates[];
|
|
1356
1560
|
};
|
|
1357
|
-
/** @returns {
|
|
1358
|
-
declare function
|
|
1359
|
-
type
|
|
1360
|
-
|
|
1561
|
+
/** @returns {SubscribedEmailTemplates} */
|
|
1562
|
+
declare function SubscribedEmailTemplates(): SubscribedEmailTemplates;
|
|
1563
|
+
type SubscribedEmailTemplates = {
|
|
1564
|
+
items?: EmailTemplate[];
|
|
1361
1565
|
};
|
|
1362
1566
|
/** @returns {EventSubscriptionTemplateSms} */
|
|
1363
1567
|
declare function EventSubscriptionTemplateSms(): EventSubscriptionTemplateSms;
|
|
@@ -1371,11 +1575,17 @@ type EventSubscriptionTemplateEmail = {
|
|
|
1371
1575
|
subscribed?: boolean;
|
|
1372
1576
|
template?: string;
|
|
1373
1577
|
};
|
|
1578
|
+
/** @returns {EventSubscriptionTemplatePushnotification} */
|
|
1579
|
+
declare function EventSubscriptionTemplatePushnotification(): EventSubscriptionTemplatePushnotification;
|
|
1580
|
+
type EventSubscriptionTemplatePushnotification = {
|
|
1581
|
+
subscribed?: boolean;
|
|
1582
|
+
};
|
|
1374
1583
|
/** @returns {EventSubscriptionTemplate} */
|
|
1375
1584
|
declare function EventSubscriptionTemplate(): EventSubscriptionTemplate;
|
|
1376
1585
|
type EventSubscriptionTemplate = {
|
|
1377
1586
|
sms?: EventSubscriptionTemplateSms;
|
|
1378
1587
|
email?: EventSubscriptionTemplateEmail;
|
|
1588
|
+
pushnotification?: EventSubscriptionTemplatePushnotification;
|
|
1379
1589
|
};
|
|
1380
1590
|
/** @returns {EventSubscription} */
|
|
1381
1591
|
declare function EventSubscription(): EventSubscription;
|
|
@@ -1384,7 +1594,41 @@ type EventSubscription = {
|
|
|
1384
1594
|
is_default?: boolean;
|
|
1385
1595
|
_id?: string;
|
|
1386
1596
|
application?: string;
|
|
1387
|
-
|
|
1597
|
+
category?: string;
|
|
1598
|
+
event?: any;
|
|
1599
|
+
slug?: string;
|
|
1600
|
+
created_at?: string;
|
|
1601
|
+
updated_at?: string;
|
|
1602
|
+
__v?: number;
|
|
1603
|
+
};
|
|
1604
|
+
/** @returns {EventSubscriptionTemplateSmsObj} */
|
|
1605
|
+
declare function EventSubscriptionTemplateSmsObj(): EventSubscriptionTemplateSmsObj;
|
|
1606
|
+
type EventSubscriptionTemplateSmsObj = {
|
|
1607
|
+
subscribed?: boolean;
|
|
1608
|
+
template?: any;
|
|
1609
|
+
};
|
|
1610
|
+
/** @returns {EventSubscriptionTemplateEmailObj} */
|
|
1611
|
+
declare function EventSubscriptionTemplateEmailObj(): EventSubscriptionTemplateEmailObj;
|
|
1612
|
+
type EventSubscriptionTemplateEmailObj = {
|
|
1613
|
+
subscribed?: boolean;
|
|
1614
|
+
template?: string;
|
|
1615
|
+
};
|
|
1616
|
+
/** @returns {EventSubscriptionTemplateObj} */
|
|
1617
|
+
declare function EventSubscriptionTemplateObj(): EventSubscriptionTemplateObj;
|
|
1618
|
+
type EventSubscriptionTemplateObj = {
|
|
1619
|
+
sms?: EventSubscriptionTemplateSmsObj;
|
|
1620
|
+
email?: EventSubscriptionTemplateEmailObj;
|
|
1621
|
+
pushnotification?: EventSubscriptionTemplatePushnotification;
|
|
1622
|
+
};
|
|
1623
|
+
/** @returns {EventSubscriptionObj} */
|
|
1624
|
+
declare function EventSubscriptionObj(): EventSubscriptionObj;
|
|
1625
|
+
type EventSubscriptionObj = {
|
|
1626
|
+
template?: EventSubscriptionTemplateObj;
|
|
1627
|
+
is_default?: boolean;
|
|
1628
|
+
_id?: string;
|
|
1629
|
+
application?: string;
|
|
1630
|
+
category?: string;
|
|
1631
|
+
event?: any;
|
|
1388
1632
|
slug?: string;
|
|
1389
1633
|
created_at?: string;
|
|
1390
1634
|
updated_at?: string;
|
|
@@ -1393,28 +1637,28 @@ type EventSubscription = {
|
|
|
1393
1637
|
/** @returns {EventSubscriptions} */
|
|
1394
1638
|
declare function EventSubscriptions(): EventSubscriptions;
|
|
1395
1639
|
type EventSubscriptions = {
|
|
1396
|
-
items?:
|
|
1640
|
+
items?: EventSubscriptionObj[];
|
|
1397
1641
|
page?: Page;
|
|
1398
1642
|
};
|
|
1399
|
-
/** @returns {
|
|
1400
|
-
declare function
|
|
1401
|
-
type
|
|
1643
|
+
/** @returns {TriggerJobResponse} */
|
|
1644
|
+
declare function TriggerJobResponse(): TriggerJobResponse;
|
|
1645
|
+
type TriggerJobResponse = {
|
|
1402
1646
|
status?: number;
|
|
1403
1647
|
};
|
|
1404
|
-
/** @returns {
|
|
1405
|
-
declare function
|
|
1406
|
-
type
|
|
1648
|
+
/** @returns {TriggerJobRequest} */
|
|
1649
|
+
declare function TriggerJobRequest(): TriggerJobRequest;
|
|
1650
|
+
type TriggerJobRequest = {
|
|
1407
1651
|
job_id?: string;
|
|
1408
1652
|
};
|
|
1409
|
-
/** @returns {
|
|
1410
|
-
declare function
|
|
1411
|
-
type
|
|
1653
|
+
/** @returns {GlobalVariablesGetResponse} */
|
|
1654
|
+
declare function GlobalVariablesGetResponse(): GlobalVariablesGetResponse;
|
|
1655
|
+
type GlobalVariablesGetResponse = {
|
|
1412
1656
|
read_only?: any;
|
|
1413
1657
|
editable?: any;
|
|
1414
1658
|
};
|
|
1415
|
-
/** @returns {
|
|
1416
|
-
declare function
|
|
1417
|
-
type
|
|
1659
|
+
/** @returns {GlobalVariablesPostResponse} */
|
|
1660
|
+
declare function GlobalVariablesPostResponse(): GlobalVariablesPostResponse;
|
|
1661
|
+
type GlobalVariablesPostResponse = {
|
|
1418
1662
|
_id?: string;
|
|
1419
1663
|
category?: string;
|
|
1420
1664
|
application?: string;
|
|
@@ -1464,8 +1708,8 @@ type CreateJobsReq = {
|
|
|
1464
1708
|
/** @returns {JobLog} */
|
|
1465
1709
|
declare function JobLog(): JobLog;
|
|
1466
1710
|
type JobLog = {
|
|
1467
|
-
imported?:
|
|
1468
|
-
processed?:
|
|
1711
|
+
imported?: StatsImported;
|
|
1712
|
+
processed?: StatsProcessed;
|
|
1469
1713
|
_id?: string;
|
|
1470
1714
|
job?: string;
|
|
1471
1715
|
campaign?: string;
|
|
@@ -1483,6 +1727,16 @@ type JobLogs = {
|
|
|
1483
1727
|
declare function LogEmail(): LogEmail;
|
|
1484
1728
|
type LogEmail = {
|
|
1485
1729
|
template?: string;
|
|
1730
|
+
provider?: string;
|
|
1731
|
+
to?: string;
|
|
1732
|
+
};
|
|
1733
|
+
/** @returns {LogSms} */
|
|
1734
|
+
declare function LogSms(): LogSms;
|
|
1735
|
+
type LogSms = {
|
|
1736
|
+
template?: string;
|
|
1737
|
+
provider?: string;
|
|
1738
|
+
phone_number?: string;
|
|
1739
|
+
country_code?: string;
|
|
1486
1740
|
};
|
|
1487
1741
|
/** @returns {LogPushnotification} */
|
|
1488
1742
|
declare function LogPushnotification(): LogPushnotification;
|
|
@@ -1492,8 +1746,10 @@ type LogPushnotification = {
|
|
|
1492
1746
|
/** @returns {LogMeta} */
|
|
1493
1747
|
declare function LogMeta(): LogMeta;
|
|
1494
1748
|
type LogMeta = {
|
|
1495
|
-
type?: string;
|
|
1496
1749
|
identifier?: string;
|
|
1750
|
+
type?: string;
|
|
1751
|
+
job?: string;
|
|
1752
|
+
campaign?: string;
|
|
1497
1753
|
key?: string;
|
|
1498
1754
|
offset?: string;
|
|
1499
1755
|
partition?: string;
|
|
@@ -1503,16 +1759,18 @@ type LogMeta = {
|
|
|
1503
1759
|
declare function Log(): Log;
|
|
1504
1760
|
type Log = {
|
|
1505
1761
|
email?: LogEmail;
|
|
1762
|
+
sms?: LogSms;
|
|
1506
1763
|
pushnotification?: LogPushnotification;
|
|
1507
|
-
meta?: LogMeta;
|
|
1508
1764
|
_id?: string;
|
|
1509
|
-
|
|
1765
|
+
pod?: string;
|
|
1510
1766
|
service?: string;
|
|
1511
1767
|
step?: string;
|
|
1768
|
+
source?: string;
|
|
1512
1769
|
status?: string;
|
|
1513
|
-
data?: any;
|
|
1514
1770
|
expire_at?: string;
|
|
1515
1771
|
created_at?: string;
|
|
1772
|
+
meta?: LogMeta;
|
|
1773
|
+
application?: string;
|
|
1516
1774
|
};
|
|
1517
1775
|
/** @returns {Logs} */
|
|
1518
1776
|
declare function Logs(): Logs;
|
|
@@ -1520,12 +1778,6 @@ type Logs = {
|
|
|
1520
1778
|
items?: Log[];
|
|
1521
1779
|
page?: Page;
|
|
1522
1780
|
};
|
|
1523
|
-
/** @returns {SendOtpSmsCommsTemplate} */
|
|
1524
|
-
declare function SendOtpSmsCommsTemplate(): SendOtpSmsCommsTemplate;
|
|
1525
|
-
type SendOtpSmsCommsTemplate = {
|
|
1526
|
-
key?: string;
|
|
1527
|
-
value?: any;
|
|
1528
|
-
};
|
|
1529
1781
|
/** @returns {SendOtpSmsCommsProvider} */
|
|
1530
1782
|
declare function SendOtpSmsCommsProvider(): SendOtpSmsCommsProvider;
|
|
1531
1783
|
type SendOtpSmsCommsProvider = {
|
|
@@ -1557,7 +1809,7 @@ declare function SendOtpCommsReqSms(): SendOtpCommsReqSms;
|
|
|
1557
1809
|
type SendOtpCommsReqSms = {
|
|
1558
1810
|
otp_length?: number;
|
|
1559
1811
|
expiry?: number;
|
|
1560
|
-
template?:
|
|
1812
|
+
template?: any;
|
|
1561
1813
|
provider?: SendOtpSmsCommsProvider;
|
|
1562
1814
|
};
|
|
1563
1815
|
/** @returns {SendOtpCommsReqEmail} */
|
|
@@ -1615,17 +1867,10 @@ type VerifyOtpCommsSuccessRes = {
|
|
|
1615
1867
|
message?: string;
|
|
1616
1868
|
email?: string;
|
|
1617
1869
|
};
|
|
1618
|
-
/** @returns {VerifyOtpCommsErrorRes} */
|
|
1619
|
-
declare function VerifyOtpCommsErrorRes(): VerifyOtpCommsErrorRes;
|
|
1620
|
-
type VerifyOtpCommsErrorRes = {
|
|
1621
|
-
success?: boolean;
|
|
1622
|
-
message?: string;
|
|
1623
|
-
};
|
|
1624
1870
|
/** @returns {SmsProviderReq} */
|
|
1625
1871
|
declare function SmsProviderReq(): SmsProviderReq;
|
|
1626
1872
|
type SmsProviderReq = {
|
|
1627
1873
|
name?: string;
|
|
1628
|
-
token?: string;
|
|
1629
1874
|
description?: string;
|
|
1630
1875
|
sender?: string;
|
|
1631
1876
|
username?: string;
|
|
@@ -1680,22 +1925,10 @@ type SmsProviderReq = {
|
|
|
1680
1925
|
* - The api_key for the test.
|
|
1681
1926
|
*/
|
|
1682
1927
|
api_key?: string;
|
|
1683
|
-
/**
|
|
1684
|
-
* - First part of jiocx url.
|
|
1685
|
-
*/
|
|
1686
|
-
tenant_name_1?: string;
|
|
1687
|
-
/**
|
|
1688
|
-
* - Second part of jiocx url.
|
|
1689
|
-
*/
|
|
1690
|
-
tenant_name_2?: string;
|
|
1691
1928
|
};
|
|
1692
1929
|
/** @returns {SmsProvider} */
|
|
1693
1930
|
declare function SmsProvider(): SmsProvider;
|
|
1694
1931
|
type SmsProvider = {
|
|
1695
|
-
token?: string;
|
|
1696
|
-
sender_id?: string;
|
|
1697
|
-
api_key?: string;
|
|
1698
|
-
expiry_date?: number;
|
|
1699
1932
|
rpt?: number;
|
|
1700
1933
|
type?: string;
|
|
1701
1934
|
provider?: string;
|
|
@@ -1705,6 +1938,7 @@ type SmsProvider = {
|
|
|
1705
1938
|
sender?: string;
|
|
1706
1939
|
username?: string;
|
|
1707
1940
|
authkey?: string;
|
|
1941
|
+
entity_id?: string;
|
|
1708
1942
|
application?: string;
|
|
1709
1943
|
created_at?: string;
|
|
1710
1944
|
updated_at?: string;
|
|
@@ -1809,6 +2043,13 @@ type Notification = {
|
|
|
1809
2043
|
deeplink?: string;
|
|
1810
2044
|
click_action?: string;
|
|
1811
2045
|
};
|
|
2046
|
+
/** @returns {SystemNotificationSetting} */
|
|
2047
|
+
declare function SystemNotificationSetting(): SystemNotificationSetting;
|
|
2048
|
+
type SystemNotificationSetting = {
|
|
2049
|
+
sound?: boolean;
|
|
2050
|
+
priority?: string;
|
|
2051
|
+
time_to_live?: string;
|
|
2052
|
+
};
|
|
1812
2053
|
/** @returns {SystemNotificationUser} */
|
|
1813
2054
|
declare function SystemNotificationUser(): SystemNotificationUser;
|
|
1814
2055
|
type SystemNotificationUser = {
|
|
@@ -1820,7 +2061,7 @@ declare function SystemNotification(): SystemNotification;
|
|
|
1820
2061
|
type SystemNotification = {
|
|
1821
2062
|
notification?: Notification;
|
|
1822
2063
|
user?: SystemNotificationUser;
|
|
1823
|
-
settings?:
|
|
2064
|
+
settings?: SystemNotificationSetting;
|
|
1824
2065
|
_id?: string;
|
|
1825
2066
|
group?: string;
|
|
1826
2067
|
created_at?: string;
|
|
@@ -1863,28 +2104,16 @@ type Page = {
|
|
|
1863
2104
|
* - The number of items per page.
|
|
1864
2105
|
*/
|
|
1865
2106
|
size?: number;
|
|
2107
|
+
/**
|
|
2108
|
+
* - Total number of items.
|
|
2109
|
+
*/
|
|
2110
|
+
total?: number;
|
|
1866
2111
|
};
|
|
1867
|
-
/** @returns {
|
|
1868
|
-
declare function
|
|
1869
|
-
type
|
|
1870
|
-
message?: Message;
|
|
1871
|
-
sentry?: string;
|
|
1872
|
-
};
|
|
1873
|
-
/** @returns {GenericDelete} */
|
|
1874
|
-
declare function GenericDelete(): GenericDelete;
|
|
1875
|
-
type GenericDelete = {
|
|
1876
|
-
message?: string;
|
|
2112
|
+
/** @returns {BasicDelete} */
|
|
2113
|
+
declare function BasicDelete(): BasicDelete;
|
|
2114
|
+
type BasicDelete = {
|
|
1877
2115
|
acknowledged?: boolean;
|
|
1878
|
-
|
|
1879
|
-
operation?: string;
|
|
1880
|
-
};
|
|
1881
|
-
/** @returns {Message} */
|
|
1882
|
-
declare function Message(): Message;
|
|
1883
|
-
type Message = {
|
|
1884
|
-
message?: string;
|
|
1885
|
-
success?: boolean;
|
|
1886
|
-
info?: string;
|
|
1887
|
-
operation?: string;
|
|
2116
|
+
deleted_count?: number;
|
|
1888
2117
|
};
|
|
1889
2118
|
/** @returns {EnabledObj} */
|
|
1890
2119
|
declare function EnabledObj(): EnabledObj;
|
|
@@ -1903,12 +2132,19 @@ type OtpConfigurationExpiry = {
|
|
|
1903
2132
|
duration: OtpConfigurationExpiryDuration;
|
|
1904
2133
|
type: string;
|
|
1905
2134
|
};
|
|
2135
|
+
/** @returns {OtpConfigRateLimit} */
|
|
2136
|
+
declare function OtpConfigRateLimit(): OtpConfigRateLimit;
|
|
2137
|
+
type OtpConfigRateLimit = {
|
|
2138
|
+
duration?: number;
|
|
2139
|
+
limit?: number;
|
|
2140
|
+
};
|
|
1906
2141
|
/** @returns {OtpConfiguration} */
|
|
1907
2142
|
declare function OtpConfiguration(): OtpConfiguration;
|
|
1908
2143
|
type OtpConfiguration = {
|
|
1909
2144
|
otp_length: number;
|
|
1910
2145
|
type: string;
|
|
1911
2146
|
expiry: OtpConfigurationExpiry;
|
|
2147
|
+
rate_limit: OtpConfigRateLimit;
|
|
1912
2148
|
application_id?: string;
|
|
1913
2149
|
company_id?: string;
|
|
1914
2150
|
};
|