@gofynd/fdk-client-javascript 3.0.0-beta.1 → 3.0.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 +1 -1
- package/sdk/application/ApplicationClient.d.ts +2 -0
- package/sdk/application/ApplicationClient.js +2 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +93 -113
- package/sdk/application/Cart/CartApplicationClient.js +157 -530
- 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 +65 -55
- package/sdk/application/Content/ContentApplicationClient.js +211 -341
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -6
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +14 -33
- 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 +32 -87
- package/sdk/application/Logistic/LogisticApplicationClient.js +126 -383
- 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 +18 -62
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +40 -372
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +99 -33
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +84 -25
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +1 -5
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +7 -38
- 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 +15 -406
- package/sdk/platform/Billing/BillingPlatformClient.js +76 -3214
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +459 -3798
- package/sdk/platform/Billing/BillingPlatformModel.js +338 -2573
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +24 -465
- package/sdk/platform/Billing/BillingPlatformValidator.js +14 -490
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +205 -284
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +554 -672
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +165 -165
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +132 -108
- package/sdk/platform/Cart/CartPlatformModel.d.ts +4865 -3148
- package/sdk/platform/Cart/CartPlatformModel.js +2071 -2854
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +419 -1015
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +2004 -6444
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +226 -1117
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +127 -919
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +574 -372
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1315 -1238
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +9334 -7634
- package/sdk/platform/Catalog/CatalogPlatformModel.js +6980 -9652
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +239 -294
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +186 -246
- 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 +236 -376
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +579 -868
- 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 +314 -422
- package/sdk/platform/Communication/CommunicationPlatformModel.js +382 -538
- 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 -68
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +88 -84
- 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 -20
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +20 -20
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +118 -333
- 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 +565 -1282
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +369 -1034
- 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 -246
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1297 -776
- 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 +2374 -877
- package/sdk/platform/Content/ContentPlatformModel.js +1304 -930
- 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 +421 -418
- package/sdk/platform/Order/OrderPlatformClient.js +1194 -1350
- package/sdk/platform/Order/OrderPlatformModel.d.ts +9145 -4107
- package/sdk/platform/Order/OrderPlatformModel.js +4257 -3197
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +641 -442
- package/sdk/platform/Order/OrderPlatformValidator.js +341 -311
- 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 +934 -2452
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +93 -306
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +70 -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 +1327 -3529
- package/sdk/platform/Payment/PaymentPlatformModel.js +1397 -3693
- 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 -513
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +75 -103
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +50 -99
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +162 -127
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +775 -435
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +6250 -3861
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +3178 -3798
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +295 -199
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +205 -133
- 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 -4
- package/sdk/platform/Share/SharePlatformModel.js +45 -3
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +4 -26
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +10 -157
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +10 -21
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +6 -23
- 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 -2
- package/sdk/public/PublicClient.js +2 -2
- 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 -1
- package/sdk/public/index.js +1 -1
- 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
- package/sdk/public/Billing/BillingPublicClient.d.ts +0 -56
- package/sdk/public/Billing/BillingPublicClient.js +0 -397
- package/sdk/public/Billing/BillingPublicModel.d.ts +0 -919
- package/sdk/public/Billing/BillingPublicModel.js +0 -560
- package/sdk/public/Billing/BillingPublicValidator.d.ts +0 -43
- package/sdk/public/Billing/BillingPublicValidator.js +0 -50
|
@@ -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
|
/**
|
|
@@ -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 {Object} [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,33 +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
|
*/
|
|
452
|
+
/**
|
|
453
|
+
* @typedef EventSubscriptionEvents
|
|
454
|
+
* @property {string} [category]
|
|
455
|
+
* @property {string} [event_name]
|
|
456
|
+
* @property {string} [group]
|
|
457
|
+
* @property {string} [slug]
|
|
458
|
+
* @property {EventTemplate} [template]
|
|
459
|
+
*/
|
|
460
|
+
/**
|
|
461
|
+
* @typedef EventTemplate
|
|
462
|
+
* @property {EventProviderTemplates} [email]
|
|
463
|
+
* @property {EventProviderTemplates} [pushnotification]
|
|
464
|
+
* @property {EventProviderTemplates} [sms]
|
|
465
|
+
*/
|
|
466
|
+
/**
|
|
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
|
|
470
|
+
*/
|
|
543
471
|
/**
|
|
544
472
|
* @typedef EventSubscriptions
|
|
545
473
|
* @property {EventSubscription[]} [items]
|
|
546
474
|
* @property {Page} [page]
|
|
547
475
|
*/
|
|
548
476
|
/**
|
|
549
|
-
* @typedef
|
|
477
|
+
* @typedef TriggerJobResult
|
|
550
478
|
* @property {number} [status]
|
|
551
479
|
*/
|
|
552
480
|
/**
|
|
553
|
-
* @typedef
|
|
481
|
+
* @typedef TriggerJobPayload
|
|
554
482
|
* @property {string} [job_id]
|
|
555
483
|
*/
|
|
556
484
|
/**
|
|
557
|
-
* @typedef
|
|
485
|
+
* @typedef GetGlobalVariablesResult
|
|
558
486
|
* @property {Object} [read_only]
|
|
559
487
|
* @property {Object} [editable]
|
|
560
488
|
*/
|
|
561
489
|
/**
|
|
562
|
-
* @typedef
|
|
490
|
+
* @typedef CreateGlobalVariablesResult
|
|
563
491
|
* @property {string} [_id]
|
|
564
492
|
* @property {string} [category]
|
|
565
493
|
* @property {string} [application]
|
|
@@ -620,15 +548,6 @@ export = CommunicationPlatformModel;
|
|
|
620
548
|
/**
|
|
621
549
|
* @typedef LogEmail
|
|
622
550
|
* @property {string} [template]
|
|
623
|
-
* @property {string} [provider]
|
|
624
|
-
* @property {string} [to]
|
|
625
|
-
*/
|
|
626
|
-
/**
|
|
627
|
-
* @typedef LogSms
|
|
628
|
-
* @property {string} [template]
|
|
629
|
-
* @property {string} [provider]
|
|
630
|
-
* @property {string} [phone_number]
|
|
631
|
-
* @property {string} [country_code]
|
|
632
551
|
*/
|
|
633
552
|
/**
|
|
634
553
|
* @typedef LogPushnotification
|
|
@@ -636,10 +555,8 @@ export = CommunicationPlatformModel;
|
|
|
636
555
|
*/
|
|
637
556
|
/**
|
|
638
557
|
* @typedef LogMeta
|
|
639
|
-
* @property {string} [identifier]
|
|
640
558
|
* @property {string} [type]
|
|
641
|
-
* @property {string} [
|
|
642
|
-
* @property {string} [campaign]
|
|
559
|
+
* @property {string} [identifier]
|
|
643
560
|
* @property {string} [key]
|
|
644
561
|
* @property {string} [offset]
|
|
645
562
|
* @property {string} [partition]
|
|
@@ -648,18 +565,16 @@ export = CommunicationPlatformModel;
|
|
|
648
565
|
/**
|
|
649
566
|
* @typedef Log
|
|
650
567
|
* @property {LogEmail} [email]
|
|
651
|
-
* @property {LogSms} [sms]
|
|
652
568
|
* @property {LogPushnotification} [pushnotification]
|
|
569
|
+
* @property {LogMeta} [meta]
|
|
653
570
|
* @property {string} [_id]
|
|
654
|
-
* @property {string} [
|
|
571
|
+
* @property {string} [application]
|
|
655
572
|
* @property {string} [service]
|
|
656
573
|
* @property {string} [step]
|
|
657
|
-
* @property {string} [source]
|
|
658
574
|
* @property {string} [status]
|
|
575
|
+
* @property {Object} [data]
|
|
659
576
|
* @property {string} [expire_at]
|
|
660
577
|
* @property {string} [created_at]
|
|
661
|
-
* @property {LogMeta} [meta]
|
|
662
|
-
* @property {string} [application]
|
|
663
578
|
*/
|
|
664
579
|
/**
|
|
665
580
|
* @typedef Logs
|
|
@@ -748,9 +663,15 @@ export = CommunicationPlatformModel;
|
|
|
748
663
|
* @property {string} [message]
|
|
749
664
|
* @property {string} [email]
|
|
750
665
|
*/
|
|
666
|
+
/**
|
|
667
|
+
* @typedef VerifyOtpCommsErrorRes
|
|
668
|
+
* @property {boolean} [success]
|
|
669
|
+
* @property {string} [message]
|
|
670
|
+
*/
|
|
751
671
|
/**
|
|
752
672
|
* @typedef SmsProviderReq
|
|
753
673
|
* @property {string} [name]
|
|
674
|
+
* @property {string} [token]
|
|
754
675
|
* @property {string} [description]
|
|
755
676
|
* @property {string} [sender]
|
|
756
677
|
* @property {string} [username]
|
|
@@ -769,9 +690,15 @@ export = CommunicationPlatformModel;
|
|
|
769
690
|
* @property {number} [version_id] - The version ID for the test.
|
|
770
691
|
* @property {string} [sender_id] - The sender ID for the test.
|
|
771
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.
|
|
772
695
|
*/
|
|
773
696
|
/**
|
|
774
697
|
* @typedef SmsProvider
|
|
698
|
+
* @property {string} [token]
|
|
699
|
+
* @property {string} [sender_id]
|
|
700
|
+
* @property {string} [api_key]
|
|
701
|
+
* @property {number} [expiry_date]
|
|
775
702
|
* @property {number} [rpt]
|
|
776
703
|
* @property {string} [type]
|
|
777
704
|
* @property {string} [provider]
|
|
@@ -781,7 +708,6 @@ export = CommunicationPlatformModel;
|
|
|
781
708
|
* @property {string} [sender]
|
|
782
709
|
* @property {string} [username]
|
|
783
710
|
* @property {string} [authkey]
|
|
784
|
-
* @property {string} [entity_id]
|
|
785
711
|
* @property {string} [application]
|
|
786
712
|
* @property {string} [created_at]
|
|
787
713
|
* @property {string} [updated_at]
|
|
@@ -833,6 +759,10 @@ export = CommunicationPlatformModel;
|
|
|
833
759
|
*/
|
|
834
760
|
/**
|
|
835
761
|
* @typedef SystemSmsTemplates
|
|
762
|
+
* @property {SystemSmsTemplate[]} [items] - An array of system SMS templates
|
|
763
|
+
*/
|
|
764
|
+
/**
|
|
765
|
+
* @typedef SystemSmsTemplate
|
|
836
766
|
* @property {EnabledObj} [url_shorten]
|
|
837
767
|
* @property {string} [_id]
|
|
838
768
|
* @property {boolean} [is_system]
|
|
@@ -906,12 +836,26 @@ export = CommunicationPlatformModel;
|
|
|
906
836
|
* @property {number} [current] - The current page number.
|
|
907
837
|
* @property {string} type - The type of the page, such as 'PageType'.
|
|
908
838
|
* @property {number} [size] - The number of items per page.
|
|
909
|
-
* @property {number} [
|
|
839
|
+
* @property {number} [page_size] - The number of items per page.
|
|
840
|
+
*/
|
|
841
|
+
/**
|
|
842
|
+
* @typedef GenericError
|
|
843
|
+
* @property {Message} [message]
|
|
844
|
+
* @property {string} [sentry]
|
|
910
845
|
*/
|
|
911
846
|
/**
|
|
912
|
-
* @typedef
|
|
847
|
+
* @typedef GenericDelete
|
|
848
|
+
* @property {string} [message]
|
|
913
849
|
* @property {boolean} [acknowledged]
|
|
914
|
-
* @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]
|
|
915
859
|
*/
|
|
916
860
|
/**
|
|
917
861
|
* @typedef EnabledObj
|
|
@@ -927,177 +871,27 @@ export = CommunicationPlatformModel;
|
|
|
927
871
|
* @property {OtpConfigurationExpiryDuration} duration
|
|
928
872
|
* @property {string} type
|
|
929
873
|
*/
|
|
930
|
-
/**
|
|
931
|
-
* @typedef OtpConfigRateLimit
|
|
932
|
-
* @property {number} [duration]
|
|
933
|
-
* @property {number} [limit]
|
|
934
|
-
*/
|
|
935
874
|
/**
|
|
936
875
|
* @typedef OtpConfiguration
|
|
937
876
|
* @property {number} otp_length
|
|
938
877
|
* @property {string} type
|
|
939
878
|
* @property {OtpConfigurationExpiry} expiry
|
|
940
|
-
* @property {OtpConfigRateLimit} rate_limit
|
|
941
879
|
* @property {string} [application_id]
|
|
942
880
|
* @property {string} [company_id]
|
|
943
881
|
*/
|
|
944
882
|
declare class CommunicationPlatformModel {
|
|
945
883
|
}
|
|
946
884
|
declare namespace CommunicationPlatformModel {
|
|
947
|
-
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 };
|
|
948
886
|
}
|
|
949
|
-
/** @returns {
|
|
950
|
-
declare function
|
|
951
|
-
type
|
|
952
|
-
provider?: string;
|
|
953
|
-
};
|
|
954
|
-
/** @returns {AppProvidersGlobalProviderRequestObj} */
|
|
955
|
-
declare function AppProvidersGlobalProviderRequestObj(): AppProvidersGlobalProviderRequestObj;
|
|
956
|
-
type AppProvidersGlobalProviderRequestObj = {
|
|
957
|
-
transaction?: AppProvidersGlobalProviderRequestObjProvider;
|
|
958
|
-
otp?: AppProvidersGlobalProviderRequestObjProvider;
|
|
959
|
-
};
|
|
960
|
-
/** @returns {AppProvidersGlobalProviderRequest} */
|
|
961
|
-
declare function AppProvidersGlobalProviderRequest(): AppProvidersGlobalProviderRequest;
|
|
962
|
-
type AppProvidersGlobalProviderRequest = {
|
|
963
|
-
email?: AppProvidersGlobalProviderRequestObj;
|
|
964
|
-
sms?: AppProvidersGlobalProviderRequestObj;
|
|
965
|
-
};
|
|
966
|
-
/** @returns {UpdateAppProvidersGlobalProviderResponseEmailSmsObj} */
|
|
967
|
-
declare function UpdateAppProvidersGlobalProviderResponseEmailSmsObj(): UpdateAppProvidersGlobalProviderResponseEmailSmsObj;
|
|
968
|
-
type UpdateAppProvidersGlobalProviderResponseEmailSmsObj = {
|
|
969
|
-
default_provider?: string;
|
|
970
|
-
otp_provider?: string;
|
|
971
|
-
};
|
|
972
|
-
/** @returns {UpdateAppProvidersGlobalProviderResponse} */
|
|
973
|
-
declare function UpdateAppProvidersGlobalProviderResponse(): UpdateAppProvidersGlobalProviderResponse;
|
|
974
|
-
type UpdateAppProvidersGlobalProviderResponse = {
|
|
975
|
-
email?: UpdateAppProvidersGlobalProviderResponseEmailSmsObj;
|
|
976
|
-
sms?: UpdateAppProvidersGlobalProviderResponseEmailSmsObj;
|
|
977
|
-
_id?: string;
|
|
978
|
-
slug?: string;
|
|
979
|
-
};
|
|
980
|
-
/** @returns {DefaultEmailProvidersFromAddresses} */
|
|
981
|
-
declare function DefaultEmailProvidersFromAddresses(): DefaultEmailProvidersFromAddresses;
|
|
982
|
-
type DefaultEmailProvidersFromAddresses = {
|
|
983
|
-
name?: string;
|
|
984
|
-
email?: string;
|
|
985
|
-
is_default?: boolean;
|
|
986
|
-
};
|
|
987
|
-
/** @returns {DefaultEmailProviders} */
|
|
988
|
-
declare function DefaultEmailProviders(): DefaultEmailProviders;
|
|
989
|
-
type DefaultEmailProviders = {
|
|
990
|
-
_id?: string;
|
|
991
|
-
from_address?: DefaultEmailProvidersFromAddresses[];
|
|
992
|
-
name?: string;
|
|
993
|
-
is_default?: boolean;
|
|
994
|
-
};
|
|
995
|
-
/** @returns {PushtokenReq} */
|
|
996
|
-
declare function PushtokenReq(): PushtokenReq;
|
|
997
|
-
type PushtokenReq = {
|
|
998
|
-
action?: string;
|
|
999
|
-
bundle_identifier?: string;
|
|
1000
|
-
push_token?: string;
|
|
1001
|
-
unique_device_id?: string;
|
|
1002
|
-
type?: string;
|
|
1003
|
-
};
|
|
1004
|
-
/** @returns {PushtokenRes} */
|
|
1005
|
-
declare function PushtokenRes(): PushtokenRes;
|
|
1006
|
-
type PushtokenRes = {
|
|
1007
|
-
_id?: string;
|
|
1008
|
-
bundle_identifier?: string;
|
|
1009
|
-
push_token?: string;
|
|
1010
|
-
unique_device_id?: string;
|
|
1011
|
-
type?: string;
|
|
1012
|
-
platform?: string;
|
|
1013
|
-
application_id?: string;
|
|
1014
|
-
user_id?: string;
|
|
1015
|
-
created_at?: string;
|
|
1016
|
-
updated_at?: string;
|
|
1017
|
-
expired_at?: string;
|
|
1018
|
-
};
|
|
1019
|
-
/** @returns {SendInstantResponse} */
|
|
1020
|
-
declare function SendInstantResponse(): SendInstantResponse;
|
|
1021
|
-
type SendInstantResponse = {
|
|
1022
|
-
success?: boolean;
|
|
1023
|
-
provider?: string;
|
|
1024
|
-
response?: boolean;
|
|
1025
|
-
};
|
|
1026
|
-
/** @returns {MetaStructure} */
|
|
1027
|
-
declare function MetaStructure(): MetaStructure;
|
|
1028
|
-
type MetaStructure = {
|
|
1029
|
-
job_type?: string;
|
|
1030
|
-
action?: string;
|
|
1031
|
-
trace?: string;
|
|
1032
|
-
timestamp?: string;
|
|
1033
|
-
};
|
|
1034
|
-
/** @returns {PayloadSmsTemplateStructure} */
|
|
1035
|
-
declare function PayloadSmsTemplateStructure(): PayloadSmsTemplateStructure;
|
|
1036
|
-
type PayloadSmsTemplateStructure = {
|
|
1037
|
-
key?: string;
|
|
1038
|
-
value?: any;
|
|
1039
|
-
};
|
|
1040
|
-
/** @returns {PayloadSmsProviderStructure} */
|
|
1041
|
-
declare function PayloadSmsProviderStructure(): PayloadSmsProviderStructure;
|
|
1042
|
-
type PayloadSmsProviderStructure = {
|
|
1043
|
-
slug?: string;
|
|
1044
|
-
};
|
|
1045
|
-
/** @returns {PayloadEmailTemplateStructure} */
|
|
1046
|
-
declare function PayloadEmailTemplateStructure(): PayloadEmailTemplateStructure;
|
|
1047
|
-
type PayloadEmailTemplateStructure = {
|
|
1048
|
-
key?: string;
|
|
1049
|
-
value?: any;
|
|
1050
|
-
};
|
|
1051
|
-
/** @returns {PayloadEmailProviderStructure} */
|
|
1052
|
-
declare function PayloadEmailProviderStructure(): PayloadEmailProviderStructure;
|
|
1053
|
-
type PayloadEmailProviderStructure = {
|
|
1054
|
-
slug?: string;
|
|
1055
|
-
};
|
|
1056
|
-
/** @returns {PayloadEmailStructure} */
|
|
1057
|
-
declare function PayloadEmailStructure(): PayloadEmailStructure;
|
|
1058
|
-
type PayloadEmailStructure = {
|
|
1059
|
-
template?: PayloadEmailTemplateStructure;
|
|
1060
|
-
provider?: PayloadEmailProviderStructure;
|
|
1061
|
-
};
|
|
1062
|
-
/** @returns {PayloadSmsStructure} */
|
|
1063
|
-
declare function PayloadSmsStructure(): PayloadSmsStructure;
|
|
1064
|
-
type PayloadSmsStructure = {
|
|
1065
|
-
template?: PayloadSmsTemplateStructure;
|
|
1066
|
-
provider?: PayloadSmsProviderStructure;
|
|
1067
|
-
};
|
|
1068
|
-
/** @returns {SendSyncData} */
|
|
1069
|
-
declare function SendSyncData(): SendSyncData;
|
|
1070
|
-
type SendSyncData = {
|
|
1071
|
-
phone_number?: string;
|
|
1072
|
-
country_code?: string;
|
|
1073
|
-
to?: string;
|
|
1074
|
-
};
|
|
1075
|
-
/** @returns {SendSyncRequest} */
|
|
1076
|
-
declare function SendSyncRequest(): SendSyncRequest;
|
|
1077
|
-
type SendSyncRequest = {
|
|
1078
|
-
data?: SendSyncData[];
|
|
1079
|
-
email?: PayloadEmailStructure;
|
|
1080
|
-
sms?: PayloadSmsStructure;
|
|
1081
|
-
};
|
|
1082
|
-
/** @returns {EngineRequest} */
|
|
1083
|
-
declare function EngineRequest(): EngineRequest;
|
|
1084
|
-
type EngineRequest = {
|
|
1085
|
-
payload?: SendSyncRequest;
|
|
1086
|
-
meta?: MetaStructure;
|
|
1087
|
-
};
|
|
1088
|
-
/** @returns {EngineResponse} */
|
|
1089
|
-
declare function EngineResponse(): EngineResponse;
|
|
1090
|
-
type EngineResponse = {
|
|
1091
|
-
success?: boolean;
|
|
1092
|
-
};
|
|
1093
|
-
/** @returns {EventSubscriptionsBulkUpdateRequest} */
|
|
1094
|
-
declare function EventSubscriptionsBulkUpdateRequest(): EventSubscriptionsBulkUpdateRequest;
|
|
1095
|
-
type EventSubscriptionsBulkUpdateRequest = {
|
|
887
|
+
/** @returns {EventSubscriptionsBulkUpdatePayload} */
|
|
888
|
+
declare function EventSubscriptionsBulkUpdatePayload(): EventSubscriptionsBulkUpdatePayload;
|
|
889
|
+
type EventSubscriptionsBulkUpdatePayload = {
|
|
1096
890
|
subscriptions?: SubscriptionsObject[];
|
|
1097
891
|
};
|
|
1098
|
-
/** @returns {
|
|
1099
|
-
declare function
|
|
1100
|
-
type
|
|
892
|
+
/** @returns {EventSubscriptionsBulkUpdateResult} */
|
|
893
|
+
declare function EventSubscriptionsBulkUpdateResult(): EventSubscriptionsBulkUpdateResult;
|
|
894
|
+
type EventSubscriptionsBulkUpdateResult = {
|
|
1101
895
|
template?: EventSubscriptionTemplate;
|
|
1102
896
|
_id?: string;
|
|
1103
897
|
application?: string;
|
|
@@ -1108,13 +902,6 @@ type EventSubscriptionsBulkUpdateResponse = {
|
|
|
1108
902
|
updated_at?: string;
|
|
1109
903
|
__v?: number;
|
|
1110
904
|
};
|
|
1111
|
-
/** @returns {SubscriptionsObjectRequest} */
|
|
1112
|
-
declare function SubscriptionsObjectRequest(): SubscriptionsObjectRequest;
|
|
1113
|
-
type SubscriptionsObjectRequest = {
|
|
1114
|
-
event?: string;
|
|
1115
|
-
slug?: string;
|
|
1116
|
-
template?: TemplateObject;
|
|
1117
|
-
};
|
|
1118
905
|
/** @returns {SubscriptionsObject} */
|
|
1119
906
|
declare function SubscriptionsObject(): SubscriptionsObject;
|
|
1120
907
|
type SubscriptionsObject = {
|
|
@@ -1122,8 +909,6 @@ type SubscriptionsObject = {
|
|
|
1122
909
|
* - Subscription ID
|
|
1123
910
|
*/
|
|
1124
911
|
_id?: string;
|
|
1125
|
-
event?: string;
|
|
1126
|
-
slug?: string;
|
|
1127
912
|
template?: TemplateObject;
|
|
1128
913
|
};
|
|
1129
914
|
/** @returns {TemplateObject} */
|
|
@@ -1235,9 +1020,6 @@ type GetStats = {
|
|
|
1235
1020
|
/** @returns {CampaignReq} */
|
|
1236
1021
|
declare function CampaignReq(): CampaignReq;
|
|
1237
1022
|
type CampaignReq = {
|
|
1238
|
-
recipient_headers?: RecipientHeaders;
|
|
1239
|
-
email?: CampaignEmail;
|
|
1240
|
-
datasource?: string;
|
|
1241
1023
|
description?: string;
|
|
1242
1024
|
tags?: string[];
|
|
1243
1025
|
headers?: string[];
|
|
@@ -1278,7 +1060,7 @@ type Campaign = {
|
|
|
1278
1060
|
recipient_headers?: RecipientHeaders;
|
|
1279
1061
|
email?: CampaignEmail;
|
|
1280
1062
|
description?: string;
|
|
1281
|
-
tags?:
|
|
1063
|
+
tags?: any[];
|
|
1282
1064
|
is_active?: boolean;
|
|
1283
1065
|
_id?: string;
|
|
1284
1066
|
datasource?: string;
|
|
@@ -1296,6 +1078,26 @@ type Campaigns = {
|
|
|
1296
1078
|
items?: Campaign[];
|
|
1297
1079
|
page?: Page;
|
|
1298
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
|
+
};
|
|
1299
1101
|
/** @returns {AudienceReq} */
|
|
1300
1102
|
declare function AudienceReq(): AudienceReq;
|
|
1301
1103
|
type AudienceReq = {
|
|
@@ -1450,13 +1252,6 @@ type TemplateAndType = {
|
|
|
1450
1252
|
template_type?: string;
|
|
1451
1253
|
template?: string;
|
|
1452
1254
|
};
|
|
1453
|
-
/** @returns {TemplateKeys} */
|
|
1454
|
-
declare function TemplateKeys(): TemplateKeys;
|
|
1455
|
-
type TemplateKeys = {
|
|
1456
|
-
to?: string;
|
|
1457
|
-
cc?: string;
|
|
1458
|
-
bcc?: string;
|
|
1459
|
-
};
|
|
1460
1255
|
/** @returns {EmailTemplate} */
|
|
1461
1256
|
declare function EmailTemplate(): EmailTemplate;
|
|
1462
1257
|
type EmailTemplate = {
|
|
@@ -1473,7 +1268,6 @@ type EmailTemplate = {
|
|
|
1473
1268
|
reply_to?: string;
|
|
1474
1269
|
tags?: string[];
|
|
1475
1270
|
subject?: TemplateAndType;
|
|
1476
|
-
keys?: TemplateKeys;
|
|
1477
1271
|
html?: TemplateAndType;
|
|
1478
1272
|
url_shorten?: EnabledObj;
|
|
1479
1273
|
priority?: string;
|
|
@@ -1523,39 +1317,89 @@ type EmailTemplates = {
|
|
|
1523
1317
|
items?: EmailTemplate[];
|
|
1524
1318
|
page?: Page;
|
|
1525
1319
|
};
|
|
1526
|
-
/** @returns {
|
|
1527
|
-
declare function
|
|
1528
|
-
type
|
|
1529
|
-
items?:
|
|
1320
|
+
/** @returns {SystemEmailTemplates} */
|
|
1321
|
+
declare function SystemEmailTemplates(): SystemEmailTemplates;
|
|
1322
|
+
type SystemEmailTemplates = {
|
|
1323
|
+
items?: SystemEmailTemplate[];
|
|
1530
1324
|
};
|
|
1531
|
-
/** @returns {
|
|
1532
|
-
declare function
|
|
1533
|
-
type
|
|
1534
|
-
|
|
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;
|
|
1535
1385
|
};
|
|
1536
1386
|
/** @returns {EventSubscriptionTemplateSms} */
|
|
1537
1387
|
declare function EventSubscriptionTemplateSms(): EventSubscriptionTemplateSms;
|
|
1538
1388
|
type EventSubscriptionTemplateSms = {
|
|
1539
1389
|
subscribed?: boolean;
|
|
1540
|
-
template?:
|
|
1390
|
+
template?: SmsTemplate;
|
|
1541
1391
|
};
|
|
1542
1392
|
/** @returns {EventSubscriptionTemplateEmail} */
|
|
1543
1393
|
declare function EventSubscriptionTemplateEmail(): EventSubscriptionTemplateEmail;
|
|
1544
1394
|
type EventSubscriptionTemplateEmail = {
|
|
1545
1395
|
subscribed?: boolean;
|
|
1546
|
-
template?:
|
|
1547
|
-
};
|
|
1548
|
-
/** @returns {EventSubscriptionTemplatePushnotification} */
|
|
1549
|
-
declare function EventSubscriptionTemplatePushnotification(): EventSubscriptionTemplatePushnotification;
|
|
1550
|
-
type EventSubscriptionTemplatePushnotification = {
|
|
1551
|
-
subscribed?: boolean;
|
|
1396
|
+
template?: EmailTemplate;
|
|
1552
1397
|
};
|
|
1553
1398
|
/** @returns {EventSubscriptionTemplate} */
|
|
1554
1399
|
declare function EventSubscriptionTemplate(): EventSubscriptionTemplate;
|
|
1555
1400
|
type EventSubscriptionTemplate = {
|
|
1556
1401
|
sms?: EventSubscriptionTemplateSms;
|
|
1557
1402
|
email?: EventSubscriptionTemplateEmail;
|
|
1558
|
-
pushnotification?: EventSubscriptionTemplatePushnotification;
|
|
1559
1403
|
};
|
|
1560
1404
|
/** @returns {EventSubscription} */
|
|
1561
1405
|
declare function EventSubscription(): EventSubscription;
|
|
@@ -1564,38 +1408,65 @@ type EventSubscription = {
|
|
|
1564
1408
|
is_default?: boolean;
|
|
1565
1409
|
_id?: string;
|
|
1566
1410
|
application?: string;
|
|
1567
|
-
|
|
1568
|
-
event?: any;
|
|
1411
|
+
event?: EventSubscriptionEvents;
|
|
1569
1412
|
slug?: string;
|
|
1570
1413
|
created_at?: string;
|
|
1571
1414
|
updated_at?: string;
|
|
1572
1415
|
__v?: number;
|
|
1573
1416
|
};
|
|
1417
|
+
/** @returns {EventSubscriptionEvents} */
|
|
1418
|
+
declare function EventSubscriptionEvents(): EventSubscriptionEvents;
|
|
1419
|
+
type EventSubscriptionEvents = {
|
|
1420
|
+
category?: string;
|
|
1421
|
+
event_name?: string;
|
|
1422
|
+
group?: string;
|
|
1423
|
+
slug?: string;
|
|
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;
|
|
1444
|
+
};
|
|
1574
1445
|
/** @returns {EventSubscriptions} */
|
|
1575
1446
|
declare function EventSubscriptions(): EventSubscriptions;
|
|
1576
1447
|
type EventSubscriptions = {
|
|
1577
1448
|
items?: EventSubscription[];
|
|
1578
1449
|
page?: Page;
|
|
1579
1450
|
};
|
|
1580
|
-
/** @returns {
|
|
1581
|
-
declare function
|
|
1582
|
-
type
|
|
1451
|
+
/** @returns {TriggerJobResult} */
|
|
1452
|
+
declare function TriggerJobResult(): TriggerJobResult;
|
|
1453
|
+
type TriggerJobResult = {
|
|
1583
1454
|
status?: number;
|
|
1584
1455
|
};
|
|
1585
|
-
/** @returns {
|
|
1586
|
-
declare function
|
|
1587
|
-
type
|
|
1456
|
+
/** @returns {TriggerJobPayload} */
|
|
1457
|
+
declare function TriggerJobPayload(): TriggerJobPayload;
|
|
1458
|
+
type TriggerJobPayload = {
|
|
1588
1459
|
job_id?: string;
|
|
1589
1460
|
};
|
|
1590
|
-
/** @returns {
|
|
1591
|
-
declare function
|
|
1592
|
-
type
|
|
1461
|
+
/** @returns {GetGlobalVariablesResult} */
|
|
1462
|
+
declare function GetGlobalVariablesResult(): GetGlobalVariablesResult;
|
|
1463
|
+
type GetGlobalVariablesResult = {
|
|
1593
1464
|
read_only?: any;
|
|
1594
1465
|
editable?: any;
|
|
1595
1466
|
};
|
|
1596
|
-
/** @returns {
|
|
1597
|
-
declare function
|
|
1598
|
-
type
|
|
1467
|
+
/** @returns {CreateGlobalVariablesResult} */
|
|
1468
|
+
declare function CreateGlobalVariablesResult(): CreateGlobalVariablesResult;
|
|
1469
|
+
type CreateGlobalVariablesResult = {
|
|
1599
1470
|
_id?: string;
|
|
1600
1471
|
category?: string;
|
|
1601
1472
|
application?: string;
|
|
@@ -1664,16 +1535,6 @@ type JobLogs = {
|
|
|
1664
1535
|
declare function LogEmail(): LogEmail;
|
|
1665
1536
|
type LogEmail = {
|
|
1666
1537
|
template?: string;
|
|
1667
|
-
provider?: string;
|
|
1668
|
-
to?: string;
|
|
1669
|
-
};
|
|
1670
|
-
/** @returns {LogSms} */
|
|
1671
|
-
declare function LogSms(): LogSms;
|
|
1672
|
-
type LogSms = {
|
|
1673
|
-
template?: string;
|
|
1674
|
-
provider?: string;
|
|
1675
|
-
phone_number?: string;
|
|
1676
|
-
country_code?: string;
|
|
1677
1538
|
};
|
|
1678
1539
|
/** @returns {LogPushnotification} */
|
|
1679
1540
|
declare function LogPushnotification(): LogPushnotification;
|
|
@@ -1683,10 +1544,8 @@ type LogPushnotification = {
|
|
|
1683
1544
|
/** @returns {LogMeta} */
|
|
1684
1545
|
declare function LogMeta(): LogMeta;
|
|
1685
1546
|
type LogMeta = {
|
|
1686
|
-
identifier?: string;
|
|
1687
1547
|
type?: string;
|
|
1688
|
-
|
|
1689
|
-
campaign?: string;
|
|
1548
|
+
identifier?: string;
|
|
1690
1549
|
key?: string;
|
|
1691
1550
|
offset?: string;
|
|
1692
1551
|
partition?: string;
|
|
@@ -1696,18 +1555,16 @@ type LogMeta = {
|
|
|
1696
1555
|
declare function Log(): Log;
|
|
1697
1556
|
type Log = {
|
|
1698
1557
|
email?: LogEmail;
|
|
1699
|
-
sms?: LogSms;
|
|
1700
1558
|
pushnotification?: LogPushnotification;
|
|
1559
|
+
meta?: LogMeta;
|
|
1701
1560
|
_id?: string;
|
|
1702
|
-
|
|
1561
|
+
application?: string;
|
|
1703
1562
|
service?: string;
|
|
1704
1563
|
step?: string;
|
|
1705
|
-
source?: string;
|
|
1706
1564
|
status?: string;
|
|
1565
|
+
data?: any;
|
|
1707
1566
|
expire_at?: string;
|
|
1708
1567
|
created_at?: string;
|
|
1709
|
-
meta?: LogMeta;
|
|
1710
|
-
application?: string;
|
|
1711
1568
|
};
|
|
1712
1569
|
/** @returns {Logs} */
|
|
1713
1570
|
declare function Logs(): Logs;
|
|
@@ -1810,10 +1667,17 @@ type VerifyOtpCommsSuccessRes = {
|
|
|
1810
1667
|
message?: string;
|
|
1811
1668
|
email?: string;
|
|
1812
1669
|
};
|
|
1670
|
+
/** @returns {VerifyOtpCommsErrorRes} */
|
|
1671
|
+
declare function VerifyOtpCommsErrorRes(): VerifyOtpCommsErrorRes;
|
|
1672
|
+
type VerifyOtpCommsErrorRes = {
|
|
1673
|
+
success?: boolean;
|
|
1674
|
+
message?: string;
|
|
1675
|
+
};
|
|
1813
1676
|
/** @returns {SmsProviderReq} */
|
|
1814
1677
|
declare function SmsProviderReq(): SmsProviderReq;
|
|
1815
1678
|
type SmsProviderReq = {
|
|
1816
1679
|
name?: string;
|
|
1680
|
+
token?: string;
|
|
1817
1681
|
description?: string;
|
|
1818
1682
|
sender?: string;
|
|
1819
1683
|
username?: string;
|
|
@@ -1868,10 +1732,22 @@ type SmsProviderReq = {
|
|
|
1868
1732
|
* - The api_key for the test.
|
|
1869
1733
|
*/
|
|
1870
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;
|
|
1871
1743
|
};
|
|
1872
1744
|
/** @returns {SmsProvider} */
|
|
1873
1745
|
declare function SmsProvider(): SmsProvider;
|
|
1874
1746
|
type SmsProvider = {
|
|
1747
|
+
token?: string;
|
|
1748
|
+
sender_id?: string;
|
|
1749
|
+
api_key?: string;
|
|
1750
|
+
expiry_date?: number;
|
|
1875
1751
|
rpt?: number;
|
|
1876
1752
|
type?: string;
|
|
1877
1753
|
provider?: string;
|
|
@@ -1881,7 +1757,6 @@ type SmsProvider = {
|
|
|
1881
1757
|
sender?: string;
|
|
1882
1758
|
username?: string;
|
|
1883
1759
|
authkey?: string;
|
|
1884
|
-
entity_id?: string;
|
|
1885
1760
|
application?: string;
|
|
1886
1761
|
created_at?: string;
|
|
1887
1762
|
updated_at?: string;
|
|
@@ -1939,6 +1814,14 @@ type SmsTemplate = {
|
|
|
1939
1814
|
/** @returns {SystemSmsTemplates} */
|
|
1940
1815
|
declare function SystemSmsTemplates(): SystemSmsTemplates;
|
|
1941
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 = {
|
|
1942
1825
|
url_shorten?: EnabledObj;
|
|
1943
1826
|
_id?: string;
|
|
1944
1827
|
is_system?: boolean;
|
|
@@ -2041,15 +1924,31 @@ type Page = {
|
|
|
2041
1924
|
*/
|
|
2042
1925
|
size?: number;
|
|
2043
1926
|
/**
|
|
2044
|
-
* -
|
|
1927
|
+
* - The number of items per page.
|
|
2045
1928
|
*/
|
|
2046
|
-
|
|
1929
|
+
page_size?: number;
|
|
2047
1930
|
};
|
|
2048
|
-
/** @returns {
|
|
2049
|
-
declare function
|
|
2050
|
-
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;
|
|
2051
1941
|
acknowledged?: boolean;
|
|
2052
|
-
|
|
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;
|
|
2053
1952
|
};
|
|
2054
1953
|
/** @returns {EnabledObj} */
|
|
2055
1954
|
declare function EnabledObj(): EnabledObj;
|
|
@@ -2068,19 +1967,12 @@ type OtpConfigurationExpiry = {
|
|
|
2068
1967
|
duration: OtpConfigurationExpiryDuration;
|
|
2069
1968
|
type: string;
|
|
2070
1969
|
};
|
|
2071
|
-
/** @returns {OtpConfigRateLimit} */
|
|
2072
|
-
declare function OtpConfigRateLimit(): OtpConfigRateLimit;
|
|
2073
|
-
type OtpConfigRateLimit = {
|
|
2074
|
-
duration?: number;
|
|
2075
|
-
limit?: number;
|
|
2076
|
-
};
|
|
2077
1970
|
/** @returns {OtpConfiguration} */
|
|
2078
1971
|
declare function OtpConfiguration(): OtpConfiguration;
|
|
2079
1972
|
type OtpConfiguration = {
|
|
2080
1973
|
otp_length: number;
|
|
2081
1974
|
type: string;
|
|
2082
1975
|
expiry: OtpConfigurationExpiry;
|
|
2083
|
-
rate_limit: OtpConfigRateLimit;
|
|
2084
1976
|
application_id?: string;
|
|
2085
1977
|
company_id?: string;
|
|
2086
1978
|
};
|