@gofynd/fdk-client-javascript 3.1.0-beta.1 → 3.2.0
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 +2 -2
- package/sdk/application/ApplicationClient.d.ts +2 -0
- package/sdk/application/ApplicationClient.js +2 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +81 -101
- package/sdk/application/Cart/CartApplicationClient.js +173 -511
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +110 -110
- package/sdk/application/Catalog/CatalogApplicationClient.js +214 -447
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +4 -19
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -43
- package/sdk/application/Communication/CommunicationApplicationClient.js +4 -214
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +41 -54
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +39 -192
- package/sdk/application/Content/ContentApplicationClient.d.ts +61 -61
- package/sdk/application/Content/ContentApplicationClient.js +183 -366
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +2 -2
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +11 -30
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +111 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +6 -6
- package/sdk/application/Lead/LeadApplicationClient.js +24 -55
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +28 -117
- package/sdk/application/Logistic/LogisticApplicationClient.js +99 -492
- package/sdk/application/Order/OrderApplicationClient.d.ts +31 -51
- package/sdk/application/Order/OrderApplicationClient.js +89 -293
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +108 -218
- package/sdk/application/Payment/PaymentApplicationClient.js +100 -1081
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +14 -14
- package/sdk/application/Rewards/RewardsApplicationClient.js +13 -66
- package/sdk/application/Share/ShareApplicationClient.d.ts +11 -11
- package/sdk/application/Share/ShareApplicationClient.js +35 -89
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +5 -25
- package/sdk/application/Theme/ThemeApplicationClient.js +24 -150
- package/sdk/application/User/UserApplicationClient.d.ts +23 -13
- package/sdk/application/User/UserApplicationClient.js +49 -407
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +4 -11
- package/sdk/common/Utility.d.ts +1 -1
- package/sdk/common/Utility.js +10 -7
- package/sdk/common/Validator.d.ts +1 -0
- package/sdk/common/Validator.js +20 -0
- package/sdk/common/utils.d.ts +0 -1
- package/sdk/common/utils.js +0 -14
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +10 -54
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +32 -364
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +54 -1
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +43 -0
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +1 -5
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -35
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerClient.js +4 -4
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +52 -98
- package/sdk/partner/Lead/LeadPartnerModel.js +76 -100
- package/sdk/partner/Lead/LeadPartnerValidator.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +172 -41
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +1222 -85
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1921 -297
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +973 -258
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +13 -1
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +148 -16
- package/sdk/partner/PartnerClient.d.ts +0 -6
- package/sdk/partner/PartnerClient.js +0 -9
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +21 -63
- package/sdk/partner/Theme/ThemePartnerClient.js +67 -392
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +72 -104
- package/sdk/partner/Theme/ThemePartnerModel.js +75 -101
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +1 -5
- package/sdk/partner/Theme/ThemePartnerValidator.js +12 -42
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +673 -189
- package/sdk/partner/Webhook/WebhookPartnerModel.js +270 -159
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -3
- package/sdk/partner/index.d.ts +0 -3
- package/sdk/partner/index.js +0 -6
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +4 -1
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +3 -3
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +3 -3
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +2 -32
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -243
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +49 -145
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +20 -171
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
- package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
- package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +172 -251
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +577 -648
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +270 -165
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +192 -108
- package/sdk/platform/Cart/CartPlatformModel.d.ts +4554 -3154
- package/sdk/platform/Cart/CartPlatformModel.js +1935 -2854
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +380 -976
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +2004 -6464
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +161 -1082
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +80 -884
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +568 -325
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1560 -1162
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +9772 -7871
- package/sdk/platform/Catalog/CatalogPlatformModel.js +6978 -9516
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +231 -240
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +180 -188
- package/sdk/platform/Common/CommonPlatformClient.d.ts +6 -5
- package/sdk/platform/Common/CommonPlatformClient.js +6 -5
- package/sdk/platform/Common/CommonPlatformModel.d.ts +19 -25
- package/sdk/platform/Common/CommonPlatformModel.js +11 -14
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +240 -376
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +589 -874
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +139 -170
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +126 -145
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +3 -56
- package/sdk/platform/Communication/CommunicationPlatformClient.js +4 -307
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +330 -502
- package/sdk/platform/Communication/CommunicationPlatformModel.js +376 -610
- package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +3 -62
- package/sdk/platform/Communication/CommunicationPlatformValidator.js +2 -48
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +72 -100
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +88 -146
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +270 -241
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +248 -226
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +20 -31
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +20 -25
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +117 -332
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +409 -1470
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +55 -158
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +41 -163
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +65 -142
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +103 -568
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +562 -1289
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +368 -1037
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +34 -80
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +24 -79
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +302 -248
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1292 -773
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +330 -218
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +325 -208
- package/sdk/platform/Content/ContentPlatformClient.d.ts +279 -118
- package/sdk/platform/Content/ContentPlatformClient.js +1617 -492
- package/sdk/platform/Content/ContentPlatformModel.d.ts +2391 -924
- package/sdk/platform/Content/ContentPlatformModel.js +1314 -970
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +272 -134
- package/sdk/platform/Content/ContentPlatformValidator.js +295 -118
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +53 -43
- package/sdk/platform/Discount/DiscountPlatformClient.js +53 -43
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +383 -110
- package/sdk/platform/Discount/DiscountPlatformModel.js +117 -108
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +56 -36
- package/sdk/platform/Discount/DiscountPlatformValidator.js +29 -19
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +4 -163
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +4 -1078
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +5 -141
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -177
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +30 -1123
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +24 -1135
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- 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 +24 -4
- package/sdk/platform/Lead/LeadPlatformClient.js +160 -4
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +60 -140
- package/sdk/platform/Lead/LeadPlatformModel.js +81 -162
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +29 -3
- package/sdk/platform/Lead/LeadPlatformValidator.js +28 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +19 -98
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +27 -662
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +91 -118
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +32 -127
- package/sdk/platform/Order/OrderPlatformClient.d.ts +406 -403
- package/sdk/platform/Order/OrderPlatformClient.js +1200 -1343
- package/sdk/platform/Order/OrderPlatformModel.d.ts +8665 -4505
- package/sdk/platform/Order/OrderPlatformModel.js +4088 -3601
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +666 -442
- package/sdk/platform/Order/OrderPlatformValidator.js +353 -312
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +9 -7
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +67 -19
- package/sdk/platform/Partner/PartnerPlatformModel.js +26 -17
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +135 -382
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +937 -2452
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +100 -306
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +74 -305
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +56 -66
- package/sdk/platform/Payment/PaymentPlatformClient.js +124 -269
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +1307 -3536
- package/sdk/platform/Payment/PaymentPlatformModel.js +1389 -3692
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +35 -64
- package/sdk/platform/Payment/PaymentPlatformValidator.js +34 -60
- package/sdk/platform/PlatformClient.d.ts +0 -2
- package/sdk/platform/PlatformClient.js +0 -4
- 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 +12 -12
- package/sdk/platform/Rewards/RewardsPlatformModel.js +10 -10
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +64 -136
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +111 -521
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +75 -117
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +50 -105
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +160 -149
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +766 -545
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +6196 -3978
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +3181 -3895
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +294 -220
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +205 -149
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +16 -4
- package/sdk/platform/Share/SharePlatformApplicationClient.js +86 -8
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +23 -6
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +16 -3
- package/sdk/platform/Share/SharePlatformModel.d.ts +53 -9
- package/sdk/platform/Share/SharePlatformModel.js +45 -5
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +17 -37
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +66 -204
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +25 -26
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +20 -31
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +8 -18
- package/sdk/platform/Theme/ThemePlatformClient.js +8 -85
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +17 -425
- package/sdk/platform/Theme/ThemePlatformModel.js +23 -329
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +3 -7
- package/sdk/platform/Theme/ThemePlatformValidator.js +2 -9
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +81 -18
- package/sdk/platform/User/UserPlatformApplicationClient.js +491 -27
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +126 -10
- package/sdk/platform/User/UserPlatformApplicationValidator.js +92 -7
- package/sdk/platform/User/UserPlatformModel.d.ts +317 -218
- package/sdk/platform/User/UserPlatformModel.js +253 -210
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +25 -78
- package/sdk/platform/Webhook/WebhookPlatformClient.js +75 -470
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +813 -426
- package/sdk/platform/Webhook/WebhookPlatformModel.js +446 -395
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
- package/sdk/platform/index.d.ts +0 -1
- package/sdk/platform/index.js +0 -2
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +22 -0
- package/sdk/public/Catalog/CatalogPublicClient.js +133 -0
- package/sdk/public/Catalog/CatalogPublicModel.d.ts +158 -0
- package/sdk/public/Catalog/CatalogPublicModel.js +116 -0
- package/sdk/public/Catalog/CatalogPublicValidator.d.ts +55 -0
- package/sdk/public/Catalog/CatalogPublicValidator.js +35 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +4 -14
- package/sdk/public/Configuration/ConfigurationPublicClient.js +10 -113
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +46 -114
- package/sdk/public/Configuration/ConfigurationPublicModel.js +32 -117
- package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +1 -11
- package/sdk/public/Configuration/ConfigurationPublicValidator.js +0 -12
- package/sdk/public/Content/ContentPublicClient.d.ts +36 -25
- package/sdk/public/Content/ContentPublicClient.js +254 -280
- package/sdk/public/Content/ContentPublicModel.d.ts +151 -38
- package/sdk/public/Content/ContentPublicModel.js +98 -44
- package/sdk/public/Content/ContentPublicValidator.d.ts +18 -17
- package/sdk/public/Content/ContentPublicValidator.js +26 -19
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +6 -11
- package/sdk/public/Partner/PartnerPublicModel.d.ts +248 -72
- package/sdk/public/Partner/PartnerPublicModel.js +81 -71
- package/sdk/public/Partner/PartnerPublicValidator.d.ts +2 -2
- package/sdk/public/Partner/PartnerPublicValidator.js +1 -1
- package/sdk/public/PublicClient.d.ts +2 -0
- package/sdk/public/PublicClient.js +4 -0
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +9 -48
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +215 -67
- package/sdk/public/Webhook/WebhookPublicModel.js +66 -61
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/public/index.d.ts +1 -0
- package/sdk/public/index.js +2 -0
- package/sdk/partner/Authorization/AuthorizationPartnerClient.d.ts +0 -66
- package/sdk/partner/Authorization/AuthorizationPartnerClient.js +0 -431
- package/sdk/partner/Authorization/AuthorizationPartnerModel.d.ts +0 -231
- package/sdk/partner/Authorization/AuthorizationPartnerModel.js +0 -152
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.d.ts +0 -8
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.js +0 -39
- package/sdk/partner/Catalog/CatalogPartnerClient.d.ts +0 -26
- package/sdk/partner/Catalog/CatalogPartnerClient.js +0 -173
- package/sdk/partner/Catalog/CatalogPartnerModel.d.ts +0 -238
- package/sdk/partner/Catalog/CatalogPartnerModel.js +0 -248
- package/sdk/partner/Catalog/CatalogPartnerValidator.d.ts +0 -5
- package/sdk/partner/Catalog/CatalogPartnerValidator.js +0 -19
- package/sdk/partner/Payment/PaymentPartnerClient.d.ts +0 -116
- package/sdk/partner/Payment/PaymentPartnerClient.js +0 -857
- package/sdk/partner/Payment/PaymentPartnerModel.d.ts +0 -388
- package/sdk/partner/Payment/PaymentPartnerModel.js +0 -442
- package/sdk/partner/Payment/PaymentPartnerValidator.d.ts +0 -14
- package/sdk/partner/Payment/PaymentPartnerValidator.js +0 -74
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
- package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2895
- package/sdk/platform/Finance/FinancePlatformModel.js +0 -2150
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
- package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
|
@@ -1,133 +1,10 @@
|
|
|
1
1
|
export = CommunicationPlatformModel;
|
|
2
2
|
/**
|
|
3
|
-
* @typedef
|
|
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
|
|
3
|
+
* @typedef EventSubscriptionsBulkUpdatePayload
|
|
127
4
|
* @property {SubscriptionsObject[]} [subscriptions]
|
|
128
5
|
*/
|
|
129
6
|
/**
|
|
130
|
-
* @typedef
|
|
7
|
+
* @typedef EventSubscriptionsBulkUpdateResult
|
|
131
8
|
* @property {EventSubscriptionTemplate} [template]
|
|
132
9
|
* @property {string} [_id]
|
|
133
10
|
* @property {string} [application]
|
|
@@ -138,17 +15,9 @@ export = CommunicationPlatformModel;
|
|
|
138
15
|
* @property {string} [updated_at]
|
|
139
16
|
* @property {number} [__v]
|
|
140
17
|
*/
|
|
141
|
-
/**
|
|
142
|
-
* @typedef SubscriptionsObjectRequest
|
|
143
|
-
* @property {string} [event]
|
|
144
|
-
* @property {string} [slug]
|
|
145
|
-
* @property {TemplateObject} [template]
|
|
146
|
-
*/
|
|
147
18
|
/**
|
|
148
19
|
* @typedef SubscriptionsObject
|
|
149
20
|
* @property {string} [_id] - Subscription ID
|
|
150
|
-
* @property {string} [event]
|
|
151
|
-
* @property {string} [slug]
|
|
152
21
|
* @property {TemplateObject} [template]
|
|
153
22
|
*/
|
|
154
23
|
/**
|
|
@@ -229,8 +98,8 @@ export = CommunicationPlatformModel;
|
|
|
229
98
|
/**
|
|
230
99
|
* @typedef Stats
|
|
231
100
|
* @property {string} [_id]
|
|
232
|
-
* @property {
|
|
233
|
-
* @property {
|
|
101
|
+
* @property {Object} [imported]
|
|
102
|
+
* @property {Object} [processed]
|
|
234
103
|
*/
|
|
235
104
|
/**
|
|
236
105
|
* @typedef GetStats
|
|
@@ -238,9 +107,6 @@ export = CommunicationPlatformModel;
|
|
|
238
107
|
*/
|
|
239
108
|
/**
|
|
240
109
|
* @typedef CampaignReq
|
|
241
|
-
* @property {RecipientHeaders} [recipient_headers]
|
|
242
|
-
* @property {CampaignEmail} [email]
|
|
243
|
-
* @property {string} [datasource]
|
|
244
110
|
* @property {string} [description]
|
|
245
111
|
* @property {string[]} [tags]
|
|
246
112
|
* @property {string[]} [headers]
|
|
@@ -276,7 +142,7 @@ export = CommunicationPlatformModel;
|
|
|
276
142
|
* @property {RecipientHeaders} [recipient_headers]
|
|
277
143
|
* @property {CampaignEmail} [email]
|
|
278
144
|
* @property {string} [description]
|
|
279
|
-
* @property {
|
|
145
|
+
* @property {Object[]} [tags]
|
|
280
146
|
* @property {boolean} [is_active]
|
|
281
147
|
* @property {string} [_id]
|
|
282
148
|
* @property {string} [datasource]
|
|
@@ -293,6 +159,15 @@ export = CommunicationPlatformModel;
|
|
|
293
159
|
* @property {Campaign[]} [items]
|
|
294
160
|
* @property {Page} [page]
|
|
295
161
|
*/
|
|
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
|
+
*/
|
|
296
171
|
/**
|
|
297
172
|
* @typedef AudienceReq
|
|
298
173
|
* @property {string} [name]
|
|
@@ -430,12 +305,6 @@ export = CommunicationPlatformModel;
|
|
|
430
305
|
* @property {string} [template_type]
|
|
431
306
|
* @property {string} [template]
|
|
432
307
|
*/
|
|
433
|
-
/**
|
|
434
|
-
* @typedef TemplateKeys
|
|
435
|
-
* @property {string} [to]
|
|
436
|
-
* @property {string} [cc]
|
|
437
|
-
* @property {string} [bcc]
|
|
438
|
-
*/
|
|
439
308
|
/**
|
|
440
309
|
* @typedef EmailTemplate
|
|
441
310
|
* @property {string} [application]
|
|
@@ -451,7 +320,6 @@ export = CommunicationPlatformModel;
|
|
|
451
320
|
* @property {string} [reply_to]
|
|
452
321
|
* @property {string[]} [tags]
|
|
453
322
|
* @property {TemplateAndType} [subject]
|
|
454
|
-
* @property {TemplateKeys} [keys]
|
|
455
323
|
* @property {TemplateAndType} [html]
|
|
456
324
|
* @property {EnabledObj} [url_shorten]
|
|
457
325
|
* @property {string} [priority]
|
|
@@ -500,32 +368,74 @@ export = CommunicationPlatformModel;
|
|
|
500
368
|
* @property {Page} [page]
|
|
501
369
|
*/
|
|
502
370
|
/**
|
|
503
|
-
* @typedef
|
|
504
|
-
* @property {
|
|
371
|
+
* @typedef SystemEmailTemplates
|
|
372
|
+
* @property {SystemEmailTemplate[]} [items]
|
|
505
373
|
*/
|
|
506
374
|
/**
|
|
507
|
-
* @typedef
|
|
508
|
-
* @property {
|
|
375
|
+
* @typedef PayloadEmailTemplateStructure
|
|
376
|
+
* @property {string} [key]
|
|
377
|
+
* @property {Object} [value]
|
|
509
378
|
*/
|
|
510
379
|
/**
|
|
511
|
-
* @typedef
|
|
512
|
-
* @property {
|
|
513
|
-
* @property {string} [template]
|
|
380
|
+
* @typedef PayloadEmailProviderStructure
|
|
381
|
+
* @property {string} [_id]
|
|
514
382
|
*/
|
|
515
383
|
/**
|
|
516
|
-
* @typedef
|
|
384
|
+
* @typedef PayloadEmailStructure
|
|
385
|
+
* @property {PayloadEmailTemplateStructure} [template]
|
|
386
|
+
* @property {PayloadEmailProviderStructure} [provider]
|
|
387
|
+
*/
|
|
388
|
+
/**
|
|
389
|
+
* @typedef PayloadSmsTemplateStructure
|
|
390
|
+
* @property {string} [key]
|
|
391
|
+
* @property {Object} [value]
|
|
392
|
+
*/
|
|
393
|
+
/**
|
|
394
|
+
* @typedef PayloadSmsProviderStructure
|
|
395
|
+
* @property {string} [_id]
|
|
396
|
+
*/
|
|
397
|
+
/**
|
|
398
|
+
* @typedef PayloadSmsStructure
|
|
399
|
+
* @property {PayloadSmsTemplateStructure} [template]
|
|
400
|
+
* @property {PayloadSmsProviderStructure} [provider]
|
|
401
|
+
*/
|
|
402
|
+
/**
|
|
403
|
+
* @typedef PayloadStructure
|
|
404
|
+
* @property {Object[]} [data]
|
|
405
|
+
* @property {PayloadEmailStructure} [email]
|
|
406
|
+
* @property {PayloadSmsStructure} [sms]
|
|
407
|
+
* @property {string} [application]
|
|
408
|
+
*/
|
|
409
|
+
/**
|
|
410
|
+
* @typedef MetaStructure
|
|
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
|
|
517
427
|
* @property {boolean} [subscribed]
|
|
518
|
-
* @property {
|
|
428
|
+
* @property {SmsTemplate} [template]
|
|
519
429
|
*/
|
|
520
430
|
/**
|
|
521
|
-
* @typedef
|
|
431
|
+
* @typedef EventSubscriptionTemplateEmail
|
|
522
432
|
* @property {boolean} [subscribed]
|
|
433
|
+
* @property {EmailTemplate} [template]
|
|
523
434
|
*/
|
|
524
435
|
/**
|
|
525
436
|
* @typedef EventSubscriptionTemplate
|
|
526
437
|
* @property {EventSubscriptionTemplateSms} [sms]
|
|
527
438
|
* @property {EventSubscriptionTemplateEmail} [email]
|
|
528
|
-
* @property {EventSubscriptionTemplatePushnotification} [pushnotification]
|
|
529
439
|
*/
|
|
530
440
|
/**
|
|
531
441
|
* @typedef EventSubscription
|
|
@@ -533,62 +443,51 @@ export = CommunicationPlatformModel;
|
|
|
533
443
|
* @property {boolean} [is_default]
|
|
534
444
|
* @property {string} [_id]
|
|
535
445
|
* @property {string} [application]
|
|
536
|
-
* @property {
|
|
537
|
-
* @property {Object} [event]
|
|
446
|
+
* @property {EventSubscriptionEvents} [event]
|
|
538
447
|
* @property {string} [slug]
|
|
539
448
|
* @property {string} [created_at]
|
|
540
449
|
* @property {string} [updated_at]
|
|
541
450
|
* @property {number} [__v]
|
|
542
451
|
*/
|
|
543
452
|
/**
|
|
544
|
-
* @typedef
|
|
545
|
-
* @property {
|
|
546
|
-
* @property {
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
* @
|
|
550
|
-
* @property {boolean} [subscribed]
|
|
551
|
-
* @property {string} [template]
|
|
453
|
+
* @typedef EventSubscriptionEvents
|
|
454
|
+
* @property {string} [category]
|
|
455
|
+
* @property {string} [event_name]
|
|
456
|
+
* @property {string} [group]
|
|
457
|
+
* @property {string} [slug]
|
|
458
|
+
* @property {EventTemplate} [template]
|
|
552
459
|
*/
|
|
553
460
|
/**
|
|
554
|
-
* @typedef
|
|
555
|
-
* @property {
|
|
556
|
-
* @property {
|
|
557
|
-
* @property {
|
|
461
|
+
* @typedef EventTemplate
|
|
462
|
+
* @property {EventProviderTemplates} [email]
|
|
463
|
+
* @property {EventProviderTemplates} [pushnotification]
|
|
464
|
+
* @property {EventProviderTemplates} [sms]
|
|
558
465
|
*/
|
|
559
466
|
/**
|
|
560
|
-
* @typedef
|
|
561
|
-
* @property {
|
|
562
|
-
* @property {
|
|
563
|
-
* @property {string} [_id]
|
|
564
|
-
* @property {string} [application]
|
|
565
|
-
* @property {string} [category]
|
|
566
|
-
* @property {Object} [event]
|
|
567
|
-
* @property {string} [slug]
|
|
568
|
-
* @property {string} [created_at]
|
|
569
|
-
* @property {string} [updated_at]
|
|
570
|
-
* @property {number} [__v]
|
|
467
|
+
* @typedef EventProviderTemplates
|
|
468
|
+
* @property {string} [provider_type] - Provider type for the event template
|
|
469
|
+
* @property {string} [template] - This is the unique id of the template
|
|
571
470
|
*/
|
|
572
471
|
/**
|
|
573
472
|
* @typedef EventSubscriptions
|
|
574
|
-
* @property {
|
|
473
|
+
* @property {EventSubscription[]} [items]
|
|
575
474
|
* @property {Page} [page]
|
|
576
475
|
*/
|
|
577
476
|
/**
|
|
578
|
-
* @typedef
|
|
477
|
+
* @typedef TriggerJobResult
|
|
579
478
|
* @property {number} [status]
|
|
580
479
|
*/
|
|
581
480
|
/**
|
|
582
|
-
* @typedef
|
|
481
|
+
* @typedef TriggerJobPayload
|
|
583
482
|
* @property {string} [job_id]
|
|
584
483
|
*/
|
|
585
484
|
/**
|
|
586
|
-
* @typedef
|
|
485
|
+
* @typedef GetGlobalVariablesResult
|
|
587
486
|
* @property {Object} [read_only]
|
|
588
487
|
* @property {Object} [editable]
|
|
589
488
|
*/
|
|
590
489
|
/**
|
|
591
|
-
* @typedef
|
|
490
|
+
* @typedef CreateGlobalVariablesResult
|
|
592
491
|
* @property {string} [_id]
|
|
593
492
|
* @property {string} [category]
|
|
594
493
|
* @property {string} [application]
|
|
@@ -632,8 +531,8 @@ export = CommunicationPlatformModel;
|
|
|
632
531
|
*/
|
|
633
532
|
/**
|
|
634
533
|
* @typedef JobLog
|
|
635
|
-
* @property {
|
|
636
|
-
* @property {
|
|
534
|
+
* @property {Object} [imported]
|
|
535
|
+
* @property {Object} [processed]
|
|
637
536
|
* @property {string} [_id]
|
|
638
537
|
* @property {string} [job]
|
|
639
538
|
* @property {string} [campaign]
|
|
@@ -649,15 +548,6 @@ export = CommunicationPlatformModel;
|
|
|
649
548
|
/**
|
|
650
549
|
* @typedef LogEmail
|
|
651
550
|
* @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]
|
|
661
551
|
*/
|
|
662
552
|
/**
|
|
663
553
|
* @typedef LogPushnotification
|
|
@@ -665,10 +555,8 @@ export = CommunicationPlatformModel;
|
|
|
665
555
|
*/
|
|
666
556
|
/**
|
|
667
557
|
* @typedef LogMeta
|
|
668
|
-
* @property {string} [identifier]
|
|
669
558
|
* @property {string} [type]
|
|
670
|
-
* @property {string} [
|
|
671
|
-
* @property {string} [campaign]
|
|
559
|
+
* @property {string} [identifier]
|
|
672
560
|
* @property {string} [key]
|
|
673
561
|
* @property {string} [offset]
|
|
674
562
|
* @property {string} [partition]
|
|
@@ -677,24 +565,27 @@ export = CommunicationPlatformModel;
|
|
|
677
565
|
/**
|
|
678
566
|
* @typedef Log
|
|
679
567
|
* @property {LogEmail} [email]
|
|
680
|
-
* @property {LogSms} [sms]
|
|
681
568
|
* @property {LogPushnotification} [pushnotification]
|
|
569
|
+
* @property {LogMeta} [meta]
|
|
682
570
|
* @property {string} [_id]
|
|
683
|
-
* @property {string} [
|
|
571
|
+
* @property {string} [application]
|
|
684
572
|
* @property {string} [service]
|
|
685
573
|
* @property {string} [step]
|
|
686
|
-
* @property {string} [source]
|
|
687
574
|
* @property {string} [status]
|
|
575
|
+
* @property {Object} [data]
|
|
688
576
|
* @property {string} [expire_at]
|
|
689
577
|
* @property {string} [created_at]
|
|
690
|
-
* @property {LogMeta} [meta]
|
|
691
|
-
* @property {string} [application]
|
|
692
578
|
*/
|
|
693
579
|
/**
|
|
694
580
|
* @typedef Logs
|
|
695
581
|
* @property {Log[]} [items]
|
|
696
582
|
* @property {Page} [page]
|
|
697
583
|
*/
|
|
584
|
+
/**
|
|
585
|
+
* @typedef SendOtpSmsCommsTemplate
|
|
586
|
+
* @property {string} [key]
|
|
587
|
+
* @property {Object} [value]
|
|
588
|
+
*/
|
|
698
589
|
/**
|
|
699
590
|
* @typedef SendOtpSmsCommsProvider
|
|
700
591
|
* @property {string} [slug]
|
|
@@ -721,7 +612,7 @@ export = CommunicationPlatformModel;
|
|
|
721
612
|
* @typedef SendOtpCommsReqSms
|
|
722
613
|
* @property {number} [otp_length]
|
|
723
614
|
* @property {number} [expiry]
|
|
724
|
-
* @property {
|
|
615
|
+
* @property {SendOtpSmsCommsTemplate} [template]
|
|
725
616
|
* @property {SendOtpSmsCommsProvider} [provider]
|
|
726
617
|
*/
|
|
727
618
|
/**
|
|
@@ -772,9 +663,15 @@ export = CommunicationPlatformModel;
|
|
|
772
663
|
* @property {string} [message]
|
|
773
664
|
* @property {string} [email]
|
|
774
665
|
*/
|
|
666
|
+
/**
|
|
667
|
+
* @typedef VerifyOtpCommsErrorRes
|
|
668
|
+
* @property {boolean} [success]
|
|
669
|
+
* @property {string} [message]
|
|
670
|
+
*/
|
|
775
671
|
/**
|
|
776
672
|
* @typedef SmsProviderReq
|
|
777
673
|
* @property {string} [name]
|
|
674
|
+
* @property {string} [token]
|
|
778
675
|
* @property {string} [description]
|
|
779
676
|
* @property {string} [sender]
|
|
780
677
|
* @property {string} [username]
|
|
@@ -793,9 +690,15 @@ export = CommunicationPlatformModel;
|
|
|
793
690
|
* @property {number} [version_id] - The version ID for the test.
|
|
794
691
|
* @property {string} [sender_id] - The sender ID for the test.
|
|
795
692
|
* @property {string} [api_key] - The api_key for the test.
|
|
693
|
+
* @property {string} [tenant_name_1] - First part of jiocx url.
|
|
694
|
+
* @property {string} [tenant_name_2] - Second part of jiocx url.
|
|
796
695
|
*/
|
|
797
696
|
/**
|
|
798
697
|
* @typedef SmsProvider
|
|
698
|
+
* @property {string} [token]
|
|
699
|
+
* @property {string} [sender_id]
|
|
700
|
+
* @property {string} [api_key]
|
|
701
|
+
* @property {number} [expiry_date]
|
|
799
702
|
* @property {number} [rpt]
|
|
800
703
|
* @property {string} [type]
|
|
801
704
|
* @property {string} [provider]
|
|
@@ -805,7 +708,6 @@ export = CommunicationPlatformModel;
|
|
|
805
708
|
* @property {string} [sender]
|
|
806
709
|
* @property {string} [username]
|
|
807
710
|
* @property {string} [authkey]
|
|
808
|
-
* @property {string} [entity_id]
|
|
809
711
|
* @property {string} [application]
|
|
810
712
|
* @property {string} [created_at]
|
|
811
713
|
* @property {string} [updated_at]
|
|
@@ -857,6 +759,10 @@ export = CommunicationPlatformModel;
|
|
|
857
759
|
*/
|
|
858
760
|
/**
|
|
859
761
|
* @typedef SystemSmsTemplates
|
|
762
|
+
* @property {SystemSmsTemplate[]} [items] - An array of system SMS templates
|
|
763
|
+
*/
|
|
764
|
+
/**
|
|
765
|
+
* @typedef SystemSmsTemplate
|
|
860
766
|
* @property {EnabledObj} [url_shorten]
|
|
861
767
|
* @property {string} [_id]
|
|
862
768
|
* @property {boolean} [is_system]
|
|
@@ -901,12 +807,6 @@ export = CommunicationPlatformModel;
|
|
|
901
807
|
* @property {string} [deeplink]
|
|
902
808
|
* @property {string} [click_action]
|
|
903
809
|
*/
|
|
904
|
-
/**
|
|
905
|
-
* @typedef SystemNotificationSetting
|
|
906
|
-
* @property {boolean} [sound]
|
|
907
|
-
* @property {string} [priority]
|
|
908
|
-
* @property {string} [time_to_live]
|
|
909
|
-
*/
|
|
910
810
|
/**
|
|
911
811
|
* @typedef SystemNotificationUser
|
|
912
812
|
* @property {string} [type]
|
|
@@ -916,7 +816,7 @@ export = CommunicationPlatformModel;
|
|
|
916
816
|
* @typedef SystemNotification
|
|
917
817
|
* @property {Notification} [notification]
|
|
918
818
|
* @property {SystemNotificationUser} [user]
|
|
919
|
-
* @property {
|
|
819
|
+
* @property {SystemNotificationUser} [settings]
|
|
920
820
|
* @property {string} [_id]
|
|
921
821
|
* @property {string} [group]
|
|
922
822
|
* @property {string} [created_at]
|
|
@@ -936,12 +836,26 @@ export = CommunicationPlatformModel;
|
|
|
936
836
|
* @property {number} [current] - The current page number.
|
|
937
837
|
* @property {string} type - The type of the page, such as 'PageType'.
|
|
938
838
|
* @property {number} [size] - The number of items per page.
|
|
939
|
-
* @property {number} [
|
|
839
|
+
* @property {number} [page_size] - The number of items per page.
|
|
940
840
|
*/
|
|
941
841
|
/**
|
|
942
|
-
* @typedef
|
|
842
|
+
* @typedef GenericError
|
|
843
|
+
* @property {Message} [message]
|
|
844
|
+
* @property {string} [sentry]
|
|
845
|
+
*/
|
|
846
|
+
/**
|
|
847
|
+
* @typedef GenericDelete
|
|
848
|
+
* @property {string} [message]
|
|
943
849
|
* @property {boolean} [acknowledged]
|
|
944
|
-
* @property {number} [
|
|
850
|
+
* @property {number} [affected]
|
|
851
|
+
* @property {string} [operation]
|
|
852
|
+
*/
|
|
853
|
+
/**
|
|
854
|
+
* @typedef Message
|
|
855
|
+
* @property {string} [message]
|
|
856
|
+
* @property {boolean} [success]
|
|
857
|
+
* @property {string} [info]
|
|
858
|
+
* @property {string} [operation]
|
|
945
859
|
*/
|
|
946
860
|
/**
|
|
947
861
|
* @typedef EnabledObj
|
|
@@ -957,177 +871,27 @@ export = CommunicationPlatformModel;
|
|
|
957
871
|
* @property {OtpConfigurationExpiryDuration} duration
|
|
958
872
|
* @property {string} type
|
|
959
873
|
*/
|
|
960
|
-
/**
|
|
961
|
-
* @typedef OtpConfigRateLimit
|
|
962
|
-
* @property {number} [duration]
|
|
963
|
-
* @property {number} [limit]
|
|
964
|
-
*/
|
|
965
874
|
/**
|
|
966
875
|
* @typedef OtpConfiguration
|
|
967
876
|
* @property {number} otp_length
|
|
968
877
|
* @property {string} type
|
|
969
878
|
* @property {OtpConfigurationExpiry} expiry
|
|
970
|
-
* @property {OtpConfigRateLimit} rate_limit
|
|
971
879
|
* @property {string} [application_id]
|
|
972
880
|
* @property {string} [company_id]
|
|
973
881
|
*/
|
|
974
882
|
declare class CommunicationPlatformModel {
|
|
975
883
|
}
|
|
976
884
|
declare namespace CommunicationPlatformModel {
|
|
977
|
-
export {
|
|
885
|
+
export { EventSubscriptionsBulkUpdatePayload, EventSubscriptionsBulkUpdateResult, SubscriptionsObject, TemplateObject, CommunicationTemplate, 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, EnginePayload, EngineResult, EventSubscriptionTemplateSms, EventSubscriptionTemplateEmail, EventSubscriptionTemplate, EventSubscription, EventSubscriptionEvents, EventTemplate, EventProviderTemplates, EventSubscriptions, TriggerJobResult, TriggerJobPayload, GetGlobalVariablesResult, CreateGlobalVariablesResult, GlobalVariablesReq, Job, Jobs, CreateJobsRes, CreateJobsReq, 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, SystemSmsTemplate, metaObj, SmsTemplateReq, Notification, SystemNotificationUser, SystemNotification, SystemNotifications, Page, GenericError, GenericDelete, Message, EnabledObj, OtpConfigurationExpiryDuration, OtpConfigurationExpiry, OtpConfiguration };
|
|
978
886
|
}
|
|
979
|
-
/** @returns {
|
|
980
|
-
declare function
|
|
981
|
-
type
|
|
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 = {
|
|
887
|
+
/** @returns {EventSubscriptionsBulkUpdatePayload} */
|
|
888
|
+
declare function EventSubscriptionsBulkUpdatePayload(): EventSubscriptionsBulkUpdatePayload;
|
|
889
|
+
type EventSubscriptionsBulkUpdatePayload = {
|
|
1126
890
|
subscriptions?: SubscriptionsObject[];
|
|
1127
891
|
};
|
|
1128
|
-
/** @returns {
|
|
1129
|
-
declare function
|
|
1130
|
-
type
|
|
892
|
+
/** @returns {EventSubscriptionsBulkUpdateResult} */
|
|
893
|
+
declare function EventSubscriptionsBulkUpdateResult(): EventSubscriptionsBulkUpdateResult;
|
|
894
|
+
type EventSubscriptionsBulkUpdateResult = {
|
|
1131
895
|
template?: EventSubscriptionTemplate;
|
|
1132
896
|
_id?: string;
|
|
1133
897
|
application?: string;
|
|
@@ -1138,13 +902,6 @@ type EventSubscriptionsBulkUpdateResponse = {
|
|
|
1138
902
|
updated_at?: string;
|
|
1139
903
|
__v?: number;
|
|
1140
904
|
};
|
|
1141
|
-
/** @returns {SubscriptionsObjectRequest} */
|
|
1142
|
-
declare function SubscriptionsObjectRequest(): SubscriptionsObjectRequest;
|
|
1143
|
-
type SubscriptionsObjectRequest = {
|
|
1144
|
-
event?: string;
|
|
1145
|
-
slug?: string;
|
|
1146
|
-
template?: TemplateObject;
|
|
1147
|
-
};
|
|
1148
905
|
/** @returns {SubscriptionsObject} */
|
|
1149
906
|
declare function SubscriptionsObject(): SubscriptionsObject;
|
|
1150
907
|
type SubscriptionsObject = {
|
|
@@ -1152,8 +909,6 @@ type SubscriptionsObject = {
|
|
|
1152
909
|
* - Subscription ID
|
|
1153
910
|
*/
|
|
1154
911
|
_id?: string;
|
|
1155
|
-
event?: string;
|
|
1156
|
-
slug?: string;
|
|
1157
912
|
template?: TemplateObject;
|
|
1158
913
|
};
|
|
1159
914
|
/** @returns {TemplateObject} */
|
|
@@ -1254,8 +1009,8 @@ type StatsProcessed = {
|
|
|
1254
1009
|
declare function Stats(): Stats;
|
|
1255
1010
|
type Stats = {
|
|
1256
1011
|
_id?: string;
|
|
1257
|
-
imported?:
|
|
1258
|
-
processed?:
|
|
1012
|
+
imported?: any;
|
|
1013
|
+
processed?: any;
|
|
1259
1014
|
};
|
|
1260
1015
|
/** @returns {GetStats} */
|
|
1261
1016
|
declare function GetStats(): GetStats;
|
|
@@ -1265,9 +1020,6 @@ type GetStats = {
|
|
|
1265
1020
|
/** @returns {CampaignReq} */
|
|
1266
1021
|
declare function CampaignReq(): CampaignReq;
|
|
1267
1022
|
type CampaignReq = {
|
|
1268
|
-
recipient_headers?: RecipientHeaders;
|
|
1269
|
-
email?: CampaignEmail;
|
|
1270
|
-
datasource?: string;
|
|
1271
1023
|
description?: string;
|
|
1272
1024
|
tags?: string[];
|
|
1273
1025
|
headers?: string[];
|
|
@@ -1308,7 +1060,7 @@ type Campaign = {
|
|
|
1308
1060
|
recipient_headers?: RecipientHeaders;
|
|
1309
1061
|
email?: CampaignEmail;
|
|
1310
1062
|
description?: string;
|
|
1311
|
-
tags?:
|
|
1063
|
+
tags?: any[];
|
|
1312
1064
|
is_active?: boolean;
|
|
1313
1065
|
_id?: string;
|
|
1314
1066
|
datasource?: string;
|
|
@@ -1326,6 +1078,26 @@ type Campaigns = {
|
|
|
1326
1078
|
items?: Campaign[];
|
|
1327
1079
|
page?: Page;
|
|
1328
1080
|
};
|
|
1081
|
+
/** @returns {BadRequestSchema} */
|
|
1082
|
+
declare function BadRequestSchema(): BadRequestSchema;
|
|
1083
|
+
type BadRequestSchema = {
|
|
1084
|
+
/**
|
|
1085
|
+
* - Response status.
|
|
1086
|
+
*/
|
|
1087
|
+
status?: string;
|
|
1088
|
+
/**
|
|
1089
|
+
* - Failure message.
|
|
1090
|
+
*/
|
|
1091
|
+
message?: string;
|
|
1092
|
+
};
|
|
1093
|
+
/** @returns {NotFound} */
|
|
1094
|
+
declare function NotFound(): NotFound;
|
|
1095
|
+
type NotFound = {
|
|
1096
|
+
/**
|
|
1097
|
+
* - Failure message.
|
|
1098
|
+
*/
|
|
1099
|
+
message?: string;
|
|
1100
|
+
};
|
|
1329
1101
|
/** @returns {AudienceReq} */
|
|
1330
1102
|
declare function AudienceReq(): AudienceReq;
|
|
1331
1103
|
type AudienceReq = {
|
|
@@ -1480,13 +1252,6 @@ type TemplateAndType = {
|
|
|
1480
1252
|
template_type?: string;
|
|
1481
1253
|
template?: string;
|
|
1482
1254
|
};
|
|
1483
|
-
/** @returns {TemplateKeys} */
|
|
1484
|
-
declare function TemplateKeys(): TemplateKeys;
|
|
1485
|
-
type TemplateKeys = {
|
|
1486
|
-
to?: string;
|
|
1487
|
-
cc?: string;
|
|
1488
|
-
bcc?: string;
|
|
1489
|
-
};
|
|
1490
1255
|
/** @returns {EmailTemplate} */
|
|
1491
1256
|
declare function EmailTemplate(): EmailTemplate;
|
|
1492
1257
|
type EmailTemplate = {
|
|
@@ -1503,7 +1268,6 @@ type EmailTemplate = {
|
|
|
1503
1268
|
reply_to?: string;
|
|
1504
1269
|
tags?: string[];
|
|
1505
1270
|
subject?: TemplateAndType;
|
|
1506
|
-
keys?: TemplateKeys;
|
|
1507
1271
|
html?: TemplateAndType;
|
|
1508
1272
|
url_shorten?: EnabledObj;
|
|
1509
1273
|
priority?: string;
|
|
@@ -1553,39 +1317,89 @@ type EmailTemplates = {
|
|
|
1553
1317
|
items?: EmailTemplate[];
|
|
1554
1318
|
page?: Page;
|
|
1555
1319
|
};
|
|
1556
|
-
/** @returns {
|
|
1557
|
-
declare function
|
|
1558
|
-
type
|
|
1559
|
-
items?:
|
|
1320
|
+
/** @returns {SystemEmailTemplates} */
|
|
1321
|
+
declare function SystemEmailTemplates(): SystemEmailTemplates;
|
|
1322
|
+
type SystemEmailTemplates = {
|
|
1323
|
+
items?: SystemEmailTemplate[];
|
|
1560
1324
|
};
|
|
1561
|
-
/** @returns {
|
|
1562
|
-
declare function
|
|
1563
|
-
type
|
|
1564
|
-
|
|
1325
|
+
/** @returns {PayloadEmailTemplateStructure} */
|
|
1326
|
+
declare function PayloadEmailTemplateStructure(): PayloadEmailTemplateStructure;
|
|
1327
|
+
type PayloadEmailTemplateStructure = {
|
|
1328
|
+
key?: string;
|
|
1329
|
+
value?: any;
|
|
1330
|
+
};
|
|
1331
|
+
/** @returns {PayloadEmailProviderStructure} */
|
|
1332
|
+
declare function PayloadEmailProviderStructure(): PayloadEmailProviderStructure;
|
|
1333
|
+
type PayloadEmailProviderStructure = {
|
|
1334
|
+
_id?: string;
|
|
1335
|
+
};
|
|
1336
|
+
/** @returns {PayloadEmailStructure} */
|
|
1337
|
+
declare function PayloadEmailStructure(): PayloadEmailStructure;
|
|
1338
|
+
type PayloadEmailStructure = {
|
|
1339
|
+
template?: PayloadEmailTemplateStructure;
|
|
1340
|
+
provider?: PayloadEmailProviderStructure;
|
|
1341
|
+
};
|
|
1342
|
+
/** @returns {PayloadSmsTemplateStructure} */
|
|
1343
|
+
declare function PayloadSmsTemplateStructure(): PayloadSmsTemplateStructure;
|
|
1344
|
+
type PayloadSmsTemplateStructure = {
|
|
1345
|
+
key?: string;
|
|
1346
|
+
value?: any;
|
|
1347
|
+
};
|
|
1348
|
+
/** @returns {PayloadSmsProviderStructure} */
|
|
1349
|
+
declare function PayloadSmsProviderStructure(): PayloadSmsProviderStructure;
|
|
1350
|
+
type PayloadSmsProviderStructure = {
|
|
1351
|
+
_id?: string;
|
|
1352
|
+
};
|
|
1353
|
+
/** @returns {PayloadSmsStructure} */
|
|
1354
|
+
declare function PayloadSmsStructure(): PayloadSmsStructure;
|
|
1355
|
+
type PayloadSmsStructure = {
|
|
1356
|
+
template?: PayloadSmsTemplateStructure;
|
|
1357
|
+
provider?: PayloadSmsProviderStructure;
|
|
1358
|
+
};
|
|
1359
|
+
/** @returns {PayloadStructure} */
|
|
1360
|
+
declare function PayloadStructure(): PayloadStructure;
|
|
1361
|
+
type PayloadStructure = {
|
|
1362
|
+
data?: any[];
|
|
1363
|
+
email?: PayloadEmailStructure;
|
|
1364
|
+
sms?: PayloadSmsStructure;
|
|
1365
|
+
application?: string;
|
|
1366
|
+
};
|
|
1367
|
+
/** @returns {MetaStructure} */
|
|
1368
|
+
declare function MetaStructure(): MetaStructure;
|
|
1369
|
+
type MetaStructure = {
|
|
1370
|
+
job_type?: string;
|
|
1371
|
+
action?: string;
|
|
1372
|
+
trace?: string;
|
|
1373
|
+
timestamp?: string;
|
|
1374
|
+
};
|
|
1375
|
+
/** @returns {EnginePayload} */
|
|
1376
|
+
declare function EnginePayload(): EnginePayload;
|
|
1377
|
+
type EnginePayload = {
|
|
1378
|
+
payload?: PayloadStructure;
|
|
1379
|
+
meta?: MetaStructure;
|
|
1380
|
+
};
|
|
1381
|
+
/** @returns {EngineResult} */
|
|
1382
|
+
declare function EngineResult(): EngineResult;
|
|
1383
|
+
type EngineResult = {
|
|
1384
|
+
success?: boolean;
|
|
1565
1385
|
};
|
|
1566
1386
|
/** @returns {EventSubscriptionTemplateSms} */
|
|
1567
1387
|
declare function EventSubscriptionTemplateSms(): EventSubscriptionTemplateSms;
|
|
1568
1388
|
type EventSubscriptionTemplateSms = {
|
|
1569
1389
|
subscribed?: boolean;
|
|
1570
|
-
template?:
|
|
1390
|
+
template?: SmsTemplate;
|
|
1571
1391
|
};
|
|
1572
1392
|
/** @returns {EventSubscriptionTemplateEmail} */
|
|
1573
1393
|
declare function EventSubscriptionTemplateEmail(): EventSubscriptionTemplateEmail;
|
|
1574
1394
|
type EventSubscriptionTemplateEmail = {
|
|
1575
1395
|
subscribed?: boolean;
|
|
1576
|
-
template?:
|
|
1577
|
-
};
|
|
1578
|
-
/** @returns {EventSubscriptionTemplatePushnotification} */
|
|
1579
|
-
declare function EventSubscriptionTemplatePushnotification(): EventSubscriptionTemplatePushnotification;
|
|
1580
|
-
type EventSubscriptionTemplatePushnotification = {
|
|
1581
|
-
subscribed?: boolean;
|
|
1396
|
+
template?: EmailTemplate;
|
|
1582
1397
|
};
|
|
1583
1398
|
/** @returns {EventSubscriptionTemplate} */
|
|
1584
1399
|
declare function EventSubscriptionTemplate(): EventSubscriptionTemplate;
|
|
1585
1400
|
type EventSubscriptionTemplate = {
|
|
1586
1401
|
sms?: EventSubscriptionTemplateSms;
|
|
1587
1402
|
email?: EventSubscriptionTemplateEmail;
|
|
1588
|
-
pushnotification?: EventSubscriptionTemplatePushnotification;
|
|
1589
1403
|
};
|
|
1590
1404
|
/** @returns {EventSubscription} */
|
|
1591
1405
|
declare function EventSubscription(): EventSubscription;
|
|
@@ -1594,71 +1408,65 @@ type EventSubscription = {
|
|
|
1594
1408
|
is_default?: boolean;
|
|
1595
1409
|
_id?: string;
|
|
1596
1410
|
application?: string;
|
|
1597
|
-
|
|
1598
|
-
event?: any;
|
|
1411
|
+
event?: EventSubscriptionEvents;
|
|
1599
1412
|
slug?: string;
|
|
1600
1413
|
created_at?: string;
|
|
1601
1414
|
updated_at?: string;
|
|
1602
1415
|
__v?: number;
|
|
1603
1416
|
};
|
|
1604
|
-
/** @returns {
|
|
1605
|
-
declare function
|
|
1606
|
-
type
|
|
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;
|
|
1417
|
+
/** @returns {EventSubscriptionEvents} */
|
|
1418
|
+
declare function EventSubscriptionEvents(): EventSubscriptionEvents;
|
|
1419
|
+
type EventSubscriptionEvents = {
|
|
1630
1420
|
category?: string;
|
|
1631
|
-
|
|
1421
|
+
event_name?: string;
|
|
1422
|
+
group?: string;
|
|
1632
1423
|
slug?: string;
|
|
1633
|
-
|
|
1634
|
-
|
|
1635
|
-
|
|
1424
|
+
template?: EventTemplate;
|
|
1425
|
+
};
|
|
1426
|
+
/** @returns {EventTemplate} */
|
|
1427
|
+
declare function EventTemplate(): EventTemplate;
|
|
1428
|
+
type EventTemplate = {
|
|
1429
|
+
email?: EventProviderTemplates;
|
|
1430
|
+
pushnotification?: EventProviderTemplates;
|
|
1431
|
+
sms?: EventProviderTemplates;
|
|
1432
|
+
};
|
|
1433
|
+
/** @returns {EventProviderTemplates} */
|
|
1434
|
+
declare function EventProviderTemplates(): EventProviderTemplates;
|
|
1435
|
+
type EventProviderTemplates = {
|
|
1436
|
+
/**
|
|
1437
|
+
* - Provider type for the event template
|
|
1438
|
+
*/
|
|
1439
|
+
provider_type?: string;
|
|
1440
|
+
/**
|
|
1441
|
+
* - This is the unique id of the template
|
|
1442
|
+
*/
|
|
1443
|
+
template?: string;
|
|
1636
1444
|
};
|
|
1637
1445
|
/** @returns {EventSubscriptions} */
|
|
1638
1446
|
declare function EventSubscriptions(): EventSubscriptions;
|
|
1639
1447
|
type EventSubscriptions = {
|
|
1640
|
-
items?:
|
|
1448
|
+
items?: EventSubscription[];
|
|
1641
1449
|
page?: Page;
|
|
1642
1450
|
};
|
|
1643
|
-
/** @returns {
|
|
1644
|
-
declare function
|
|
1645
|
-
type
|
|
1451
|
+
/** @returns {TriggerJobResult} */
|
|
1452
|
+
declare function TriggerJobResult(): TriggerJobResult;
|
|
1453
|
+
type TriggerJobResult = {
|
|
1646
1454
|
status?: number;
|
|
1647
1455
|
};
|
|
1648
|
-
/** @returns {
|
|
1649
|
-
declare function
|
|
1650
|
-
type
|
|
1456
|
+
/** @returns {TriggerJobPayload} */
|
|
1457
|
+
declare function TriggerJobPayload(): TriggerJobPayload;
|
|
1458
|
+
type TriggerJobPayload = {
|
|
1651
1459
|
job_id?: string;
|
|
1652
1460
|
};
|
|
1653
|
-
/** @returns {
|
|
1654
|
-
declare function
|
|
1655
|
-
type
|
|
1461
|
+
/** @returns {GetGlobalVariablesResult} */
|
|
1462
|
+
declare function GetGlobalVariablesResult(): GetGlobalVariablesResult;
|
|
1463
|
+
type GetGlobalVariablesResult = {
|
|
1656
1464
|
read_only?: any;
|
|
1657
1465
|
editable?: any;
|
|
1658
1466
|
};
|
|
1659
|
-
/** @returns {
|
|
1660
|
-
declare function
|
|
1661
|
-
type
|
|
1467
|
+
/** @returns {CreateGlobalVariablesResult} */
|
|
1468
|
+
declare function CreateGlobalVariablesResult(): CreateGlobalVariablesResult;
|
|
1469
|
+
type CreateGlobalVariablesResult = {
|
|
1662
1470
|
_id?: string;
|
|
1663
1471
|
category?: string;
|
|
1664
1472
|
application?: string;
|
|
@@ -1708,8 +1516,8 @@ type CreateJobsReq = {
|
|
|
1708
1516
|
/** @returns {JobLog} */
|
|
1709
1517
|
declare function JobLog(): JobLog;
|
|
1710
1518
|
type JobLog = {
|
|
1711
|
-
imported?:
|
|
1712
|
-
processed?:
|
|
1519
|
+
imported?: any;
|
|
1520
|
+
processed?: any;
|
|
1713
1521
|
_id?: string;
|
|
1714
1522
|
job?: string;
|
|
1715
1523
|
campaign?: string;
|
|
@@ -1727,16 +1535,6 @@ type JobLogs = {
|
|
|
1727
1535
|
declare function LogEmail(): LogEmail;
|
|
1728
1536
|
type LogEmail = {
|
|
1729
1537
|
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;
|
|
1740
1538
|
};
|
|
1741
1539
|
/** @returns {LogPushnotification} */
|
|
1742
1540
|
declare function LogPushnotification(): LogPushnotification;
|
|
@@ -1746,10 +1544,8 @@ type LogPushnotification = {
|
|
|
1746
1544
|
/** @returns {LogMeta} */
|
|
1747
1545
|
declare function LogMeta(): LogMeta;
|
|
1748
1546
|
type LogMeta = {
|
|
1749
|
-
identifier?: string;
|
|
1750
1547
|
type?: string;
|
|
1751
|
-
|
|
1752
|
-
campaign?: string;
|
|
1548
|
+
identifier?: string;
|
|
1753
1549
|
key?: string;
|
|
1754
1550
|
offset?: string;
|
|
1755
1551
|
partition?: string;
|
|
@@ -1759,18 +1555,16 @@ type LogMeta = {
|
|
|
1759
1555
|
declare function Log(): Log;
|
|
1760
1556
|
type Log = {
|
|
1761
1557
|
email?: LogEmail;
|
|
1762
|
-
sms?: LogSms;
|
|
1763
1558
|
pushnotification?: LogPushnotification;
|
|
1559
|
+
meta?: LogMeta;
|
|
1764
1560
|
_id?: string;
|
|
1765
|
-
|
|
1561
|
+
application?: string;
|
|
1766
1562
|
service?: string;
|
|
1767
1563
|
step?: string;
|
|
1768
|
-
source?: string;
|
|
1769
1564
|
status?: string;
|
|
1565
|
+
data?: any;
|
|
1770
1566
|
expire_at?: string;
|
|
1771
1567
|
created_at?: string;
|
|
1772
|
-
meta?: LogMeta;
|
|
1773
|
-
application?: string;
|
|
1774
1568
|
};
|
|
1775
1569
|
/** @returns {Logs} */
|
|
1776
1570
|
declare function Logs(): Logs;
|
|
@@ -1778,6 +1572,12 @@ type Logs = {
|
|
|
1778
1572
|
items?: Log[];
|
|
1779
1573
|
page?: Page;
|
|
1780
1574
|
};
|
|
1575
|
+
/** @returns {SendOtpSmsCommsTemplate} */
|
|
1576
|
+
declare function SendOtpSmsCommsTemplate(): SendOtpSmsCommsTemplate;
|
|
1577
|
+
type SendOtpSmsCommsTemplate = {
|
|
1578
|
+
key?: string;
|
|
1579
|
+
value?: any;
|
|
1580
|
+
};
|
|
1781
1581
|
/** @returns {SendOtpSmsCommsProvider} */
|
|
1782
1582
|
declare function SendOtpSmsCommsProvider(): SendOtpSmsCommsProvider;
|
|
1783
1583
|
type SendOtpSmsCommsProvider = {
|
|
@@ -1809,7 +1609,7 @@ declare function SendOtpCommsReqSms(): SendOtpCommsReqSms;
|
|
|
1809
1609
|
type SendOtpCommsReqSms = {
|
|
1810
1610
|
otp_length?: number;
|
|
1811
1611
|
expiry?: number;
|
|
1812
|
-
template?:
|
|
1612
|
+
template?: SendOtpSmsCommsTemplate;
|
|
1813
1613
|
provider?: SendOtpSmsCommsProvider;
|
|
1814
1614
|
};
|
|
1815
1615
|
/** @returns {SendOtpCommsReqEmail} */
|
|
@@ -1867,10 +1667,17 @@ type VerifyOtpCommsSuccessRes = {
|
|
|
1867
1667
|
message?: string;
|
|
1868
1668
|
email?: string;
|
|
1869
1669
|
};
|
|
1670
|
+
/** @returns {VerifyOtpCommsErrorRes} */
|
|
1671
|
+
declare function VerifyOtpCommsErrorRes(): VerifyOtpCommsErrorRes;
|
|
1672
|
+
type VerifyOtpCommsErrorRes = {
|
|
1673
|
+
success?: boolean;
|
|
1674
|
+
message?: string;
|
|
1675
|
+
};
|
|
1870
1676
|
/** @returns {SmsProviderReq} */
|
|
1871
1677
|
declare function SmsProviderReq(): SmsProviderReq;
|
|
1872
1678
|
type SmsProviderReq = {
|
|
1873
1679
|
name?: string;
|
|
1680
|
+
token?: string;
|
|
1874
1681
|
description?: string;
|
|
1875
1682
|
sender?: string;
|
|
1876
1683
|
username?: string;
|
|
@@ -1925,10 +1732,22 @@ type SmsProviderReq = {
|
|
|
1925
1732
|
* - The api_key for the test.
|
|
1926
1733
|
*/
|
|
1927
1734
|
api_key?: string;
|
|
1735
|
+
/**
|
|
1736
|
+
* - First part of jiocx url.
|
|
1737
|
+
*/
|
|
1738
|
+
tenant_name_1?: string;
|
|
1739
|
+
/**
|
|
1740
|
+
* - Second part of jiocx url.
|
|
1741
|
+
*/
|
|
1742
|
+
tenant_name_2?: string;
|
|
1928
1743
|
};
|
|
1929
1744
|
/** @returns {SmsProvider} */
|
|
1930
1745
|
declare function SmsProvider(): SmsProvider;
|
|
1931
1746
|
type SmsProvider = {
|
|
1747
|
+
token?: string;
|
|
1748
|
+
sender_id?: string;
|
|
1749
|
+
api_key?: string;
|
|
1750
|
+
expiry_date?: number;
|
|
1932
1751
|
rpt?: number;
|
|
1933
1752
|
type?: string;
|
|
1934
1753
|
provider?: string;
|
|
@@ -1938,7 +1757,6 @@ type SmsProvider = {
|
|
|
1938
1757
|
sender?: string;
|
|
1939
1758
|
username?: string;
|
|
1940
1759
|
authkey?: string;
|
|
1941
|
-
entity_id?: string;
|
|
1942
1760
|
application?: string;
|
|
1943
1761
|
created_at?: string;
|
|
1944
1762
|
updated_at?: string;
|
|
@@ -1996,6 +1814,14 @@ type SmsTemplate = {
|
|
|
1996
1814
|
/** @returns {SystemSmsTemplates} */
|
|
1997
1815
|
declare function SystemSmsTemplates(): SystemSmsTemplates;
|
|
1998
1816
|
type SystemSmsTemplates = {
|
|
1817
|
+
/**
|
|
1818
|
+
* - An array of system SMS templates
|
|
1819
|
+
*/
|
|
1820
|
+
items?: SystemSmsTemplate[];
|
|
1821
|
+
};
|
|
1822
|
+
/** @returns {SystemSmsTemplate} */
|
|
1823
|
+
declare function SystemSmsTemplate(): SystemSmsTemplate;
|
|
1824
|
+
type SystemSmsTemplate = {
|
|
1999
1825
|
url_shorten?: EnabledObj;
|
|
2000
1826
|
_id?: string;
|
|
2001
1827
|
is_system?: boolean;
|
|
@@ -2043,13 +1869,6 @@ type Notification = {
|
|
|
2043
1869
|
deeplink?: string;
|
|
2044
1870
|
click_action?: string;
|
|
2045
1871
|
};
|
|
2046
|
-
/** @returns {SystemNotificationSetting} */
|
|
2047
|
-
declare function SystemNotificationSetting(): SystemNotificationSetting;
|
|
2048
|
-
type SystemNotificationSetting = {
|
|
2049
|
-
sound?: boolean;
|
|
2050
|
-
priority?: string;
|
|
2051
|
-
time_to_live?: string;
|
|
2052
|
-
};
|
|
2053
1872
|
/** @returns {SystemNotificationUser} */
|
|
2054
1873
|
declare function SystemNotificationUser(): SystemNotificationUser;
|
|
2055
1874
|
type SystemNotificationUser = {
|
|
@@ -2061,7 +1880,7 @@ declare function SystemNotification(): SystemNotification;
|
|
|
2061
1880
|
type SystemNotification = {
|
|
2062
1881
|
notification?: Notification;
|
|
2063
1882
|
user?: SystemNotificationUser;
|
|
2064
|
-
settings?:
|
|
1883
|
+
settings?: SystemNotificationUser;
|
|
2065
1884
|
_id?: string;
|
|
2066
1885
|
group?: string;
|
|
2067
1886
|
created_at?: string;
|
|
@@ -2105,15 +1924,31 @@ type Page = {
|
|
|
2105
1924
|
*/
|
|
2106
1925
|
size?: number;
|
|
2107
1926
|
/**
|
|
2108
|
-
* -
|
|
1927
|
+
* - The number of items per page.
|
|
2109
1928
|
*/
|
|
2110
|
-
|
|
1929
|
+
page_size?: number;
|
|
2111
1930
|
};
|
|
2112
|
-
/** @returns {
|
|
2113
|
-
declare function
|
|
2114
|
-
type
|
|
1931
|
+
/** @returns {GenericError} */
|
|
1932
|
+
declare function GenericError(): GenericError;
|
|
1933
|
+
type GenericError = {
|
|
1934
|
+
message?: Message;
|
|
1935
|
+
sentry?: string;
|
|
1936
|
+
};
|
|
1937
|
+
/** @returns {GenericDelete} */
|
|
1938
|
+
declare function GenericDelete(): GenericDelete;
|
|
1939
|
+
type GenericDelete = {
|
|
1940
|
+
message?: string;
|
|
2115
1941
|
acknowledged?: boolean;
|
|
2116
|
-
|
|
1942
|
+
affected?: number;
|
|
1943
|
+
operation?: string;
|
|
1944
|
+
};
|
|
1945
|
+
/** @returns {Message} */
|
|
1946
|
+
declare function Message(): Message;
|
|
1947
|
+
type Message = {
|
|
1948
|
+
message?: string;
|
|
1949
|
+
success?: boolean;
|
|
1950
|
+
info?: string;
|
|
1951
|
+
operation?: string;
|
|
2117
1952
|
};
|
|
2118
1953
|
/** @returns {EnabledObj} */
|
|
2119
1954
|
declare function EnabledObj(): EnabledObj;
|
|
@@ -2132,19 +1967,12 @@ type OtpConfigurationExpiry = {
|
|
|
2132
1967
|
duration: OtpConfigurationExpiryDuration;
|
|
2133
1968
|
type: string;
|
|
2134
1969
|
};
|
|
2135
|
-
/** @returns {OtpConfigRateLimit} */
|
|
2136
|
-
declare function OtpConfigRateLimit(): OtpConfigRateLimit;
|
|
2137
|
-
type OtpConfigRateLimit = {
|
|
2138
|
-
duration?: number;
|
|
2139
|
-
limit?: number;
|
|
2140
|
-
};
|
|
2141
1970
|
/** @returns {OtpConfiguration} */
|
|
2142
1971
|
declare function OtpConfiguration(): OtpConfiguration;
|
|
2143
1972
|
type OtpConfiguration = {
|
|
2144
1973
|
otp_length: number;
|
|
2145
1974
|
type: string;
|
|
2146
1975
|
expiry: OtpConfigurationExpiry;
|
|
2147
|
-
rate_limit: OtpConfigRateLimit;
|
|
2148
1976
|
application_id?: string;
|
|
2149
1977
|
company_id?: string;
|
|
2150
1978
|
};
|