@gofynd/fdk-client-javascript 1.2.0 → 1.3.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 +44 -7
- package/package.json +1 -2
- package/sdk/application/ApplicationAPIClient.d.ts +3 -3
- package/sdk/application/ApplicationAPIClient.js +6 -4
- package/sdk/application/ApplicationClient.d.ts +2 -3
- package/sdk/application/ApplicationClient.js +1 -45
- package/sdk/application/ApplicationConfig.d.ts +46 -6
- package/sdk/application/ApplicationConfig.js +15 -16
- package/sdk/application/Cart/CartApplicationClient.d.ts +61 -33
- package/sdk/application/Cart/CartApplicationClient.js +225 -134
- package/sdk/application/Cart/CartApplicationModel.d.ts +4 -4
- package/sdk/application/Cart/CartApplicationModel.js +4 -4
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +61 -30
- package/sdk/application/Catalog/CatalogApplicationClient.js +234 -146
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +115 -13
- package/sdk/application/Catalog/CatalogApplicationModel.js +77 -12
- package/sdk/application/Common/CommonApplicationClient.d.ts +5 -3
- package/sdk/application/Common/CommonApplicationClient.js +13 -11
- package/sdk/application/Common/CommonApplicationModel.d.ts +3 -83
- package/sdk/application/Common/CommonApplicationModel.js +2 -58
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +9 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +25 -13
- package/sdk/application/Communication/CommunicationApplicationModel.d.ts +1 -34
- package/sdk/application/Communication/CommunicationApplicationModel.js +0 -36
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +46 -16
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +144 -68
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +1 -219
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +0 -226
- package/sdk/application/Content/ContentApplicationClient.d.ts +49 -21
- package/sdk/application/Content/ContentApplicationClient.js +159 -80
- package/sdk/application/Content/ContentApplicationModel.d.ts +5 -622
- package/sdk/application/Content/ContentApplicationModel.js +11 -763
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -3
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +20 -14
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +1 -152
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +0 -180
- package/sdk/application/Lead/LeadApplicationClient.d.ts +14 -7
- package/sdk/application/Lead/LeadApplicationClient.js +50 -31
- package/sdk/application/Lead/LeadApplicationModel.d.ts +22 -741
- package/sdk/application/Lead/LeadApplicationModel.js +21 -481
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +11 -5
- package/sdk/application/Logistic/LogisticApplicationClient.js +41 -20
- package/sdk/application/Order/OrderApplicationClient.d.ts +24 -12
- package/sdk/application/Order/OrderApplicationClient.js +88 -56
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +91 -42
- package/sdk/application/Payment/PaymentApplicationClient.js +293 -194
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +36 -36
- package/sdk/application/Payment/PaymentApplicationModel.js +36 -36
- package/sdk/application/PosCart/PosCartApplicationClient.d.ts +59 -32
- package/sdk/application/PosCart/PosCartApplicationClient.js +214 -130
- package/sdk/application/PosCart/PosCartApplicationModel.d.ts +2 -2
- package/sdk/application/PosCart/PosCartApplicationModel.js +2 -2
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +16 -7
- package/sdk/application/Rewards/RewardsApplicationClient.js +56 -29
- package/sdk/application/Share/ShareApplicationClient.d.ts +15 -7
- package/sdk/application/Share/ShareApplicationClient.js +51 -31
- package/sdk/application/Share/ShareApplicationModel.d.ts +1 -33
- package/sdk/application/Share/ShareApplicationModel.js +0 -38
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +9 -4
- package/sdk/application/Theme/ThemeApplicationClient.js +35 -18
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +982 -312
- package/sdk/application/Theme/ThemeApplicationModel.js +621 -284
- package/sdk/application/User/UserApplicationClient.d.ts +74 -35
- package/sdk/application/User/UserApplicationClient.js +252 -161
- package/sdk/application/User/UserApplicationModel.d.ts +3 -401
- package/sdk/application/User/UserApplicationModel.js +2 -490
- package/sdk/common/AxiosHelper.js +1 -2
- package/sdk/common/FDKError.d.ts +3 -0
- package/sdk/common/FDKError.js +8 -0
- package/sdk/common/utils.d.ts +3 -0
- package/sdk/common/utils.js +29 -0
- package/sdk/partner/PartnerAPIClient.d.ts +5 -4
- package/sdk/partner/PartnerAPIClient.js +7 -4
- package/sdk/partner/PartnerClient.d.ts +2 -0
- package/sdk/partner/PartnerClient.js +3 -0
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +299 -0
- package/sdk/partner/Theme/ThemePartnerClient.js +768 -0
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +1706 -0
- package/sdk/partner/Theme/ThemePartnerModel.js +1409 -0
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +22 -0
- package/sdk/partner/Theme/ThemePartnerValidator.js +157 -0
- package/sdk/partner/index.d.ts +3 -1
- package/sdk/partner/index.js +3 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +8 -4
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +38 -16
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +1 -13
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +0 -12
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +10 -0
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +4 -0
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +59 -14
- package/sdk/platform/Billing/BillingPlatformClient.js +315 -64
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +56 -196
- package/sdk/platform/Billing/BillingPlatformModel.js +63 -217
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +23 -1
- package/sdk/platform/Billing/BillingPlatformValidator.js +31 -0
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +124 -63
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +431 -265
- package/sdk/platform/Cart/CartPlatformModel.d.ts +253 -53
- package/sdk/platform/Cart/CartPlatformModel.js +104 -54
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +120 -53
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +398 -247
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +155 -78
- package/sdk/platform/Catalog/CatalogPlatformClient.js +561 -355
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +10 -12
- package/sdk/platform/Catalog/CatalogPlatformModel.js +10 -12
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +30 -0
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +13 -0
- package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -3
- package/sdk/platform/Common/CommonPlatformClient.js +13 -11
- package/sdk/platform/Common/CommonPlatformModel.d.ts +39 -64
- package/sdk/platform/Common/CommonPlatformModel.js +23 -57
- package/sdk/platform/Common/CommonPlatformValidator.d.ts +5 -10
- package/sdk/platform/Common/CommonPlatformValidator.js +3 -4
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +370 -120
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +2328 -888
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +143 -24
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +179 -15
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +2 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +6 -5
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +386 -308
- package/sdk/platform/Communication/CommunicationPlatformModel.js +415 -355
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +38 -13
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +171 -57
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +53 -1
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +54 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +5 -1
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +7 -0
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +96 -29
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +311 -126
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +5 -1
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +7 -0
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +36 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +121 -86
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +13 -180
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +5 -113
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +162 -70
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +528 -309
- package/sdk/platform/Content/ContentPlatformModel.d.ts +9 -198
- package/sdk/platform/Content/ContentPlatformModel.js +8 -231
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +48 -11
- package/sdk/platform/Discount/DiscountPlatformClient.js +142 -48
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +40 -1
- package/sdk/platform/Discount/DiscountPlatformModel.js +27 -0
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +84 -18
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +486 -53
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +71 -7
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +81 -5
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +13 -18
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +58 -65
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +198 -71
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +212 -64
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +18 -10
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +11 -6
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +177 -40
- package/sdk/platform/Finance/FinancePlatformClient.js +1028 -132
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +670 -22
- package/sdk/platform/Finance/FinancePlatformModel.js +809 -23
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +111 -1
- package/sdk/platform/Finance/FinancePlatformValidator.js +134 -0
- package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +24 -12
- package/sdk/platform/Inventory/InventoryPlatformClient.js +94 -52
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +27 -13
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +101 -55
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +50 -39
- package/sdk/platform/Lead/LeadPlatformClient.js +171 -112
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +32 -390
- package/sdk/platform/Lead/LeadPlatformModel.js +31 -214
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +33 -33
- package/sdk/platform/Lead/LeadPlatformValidator.js +23 -23
- package/sdk/platform/OAuthClient.js +6 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +4 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +12 -10
- package/sdk/platform/Order/OrderPlatformClient.d.ts +165 -71
- package/sdk/platform/Order/OrderPlatformClient.js +738 -205
- package/sdk/platform/Order/OrderPlatformModel.d.ts +261 -3
- package/sdk/platform/Order/OrderPlatformModel.js +225 -2
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +104 -3
- package/sdk/platform/Order/OrderPlatformValidator.js +85 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -22
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +12 -159
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +1 -30
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +0 -26
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +1 -690
- package/sdk/platform/Partner/PartnerPlatformModel.js +0 -809
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +167 -32
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +793 -145
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +91 -1
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +91 -0
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -10
- package/sdk/platform/Payment/PaymentPlatformClient.js +68 -47
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +549 -7
- package/sdk/platform/Payment/PaymentPlatformModel.js +305 -6
- package/sdk/platform/PlatformAPIClient.d.ts +3 -3
- package/sdk/platform/PlatformAPIClient.js +2 -2
- package/sdk/platform/PlatformClient.d.ts +2 -2
- package/sdk/platform/PlatformClient.js +4 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +28 -12
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +90 -53
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +1 -12
- package/sdk/platform/Rewards/RewardsPlatformModel.js +0 -14
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +62 -26
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +210 -93
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +20 -11
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +23 -11
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +36 -18
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +142 -78
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +12 -3
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +14 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +10 -26
- package/sdk/platform/Share/SharePlatformApplicationClient.js +36 -67
- package/sdk/platform/Share/SharePlatformModel.d.ts +4 -4
- package/sdk/platform/Share/SharePlatformModel.js +4 -4
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +127 -57
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +564 -189
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +63 -26
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +62 -22
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +37 -0
- package/sdk/platform/Theme/ThemePlatformClient.js +235 -0
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +1167 -261
- package/sdk/platform/Theme/ThemePlatformModel.js +801 -244
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +32 -0
- package/sdk/platform/Theme/ThemePlatformValidator.js +38 -0
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +35 -17
- package/sdk/platform/User/UserPlatformApplicationClient.js +132 -73
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +7 -0
- package/sdk/platform/User/UserPlatformApplicationValidator.js +3 -0
- package/sdk/platform/User/UserPlatformModel.d.ts +1 -738
- package/sdk/platform/User/UserPlatformModel.js +3 -899
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +120 -7
- package/sdk/platform/Webhook/WebhookPlatformClient.js +799 -41
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +476 -86
- package/sdk/platform/Webhook/WebhookPlatformModel.js +388 -89
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +96 -9
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +117 -5
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +5 -3
- package/sdk/public/Configuration/ConfigurationPublicClient.js +13 -11
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +3 -106
- package/sdk/public/Configuration/ConfigurationPublicModel.js +2 -59
- package/sdk/public/Inventory/InventoryPublicClient.d.ts +12 -6
- package/sdk/public/Inventory/InventoryPublicClient.js +42 -27
- package/sdk/public/Partner/PartnerPublicClient.d.ts +22 -0
- package/sdk/public/Partner/PartnerPublicClient.js +110 -0
- package/sdk/public/Partner/PartnerPublicModel.d.ts +240 -0
- package/sdk/public/Partner/PartnerPublicModel.js +280 -0
- package/sdk/public/Partner/PartnerPublicValidator.d.ts +18 -0
- package/sdk/public/Partner/PartnerPublicValidator.js +19 -0
- package/sdk/public/PublicAPIClient.d.ts +14 -1
- package/sdk/public/PublicAPIClient.js +7 -1
- package/sdk/public/PublicClient.d.ts +2 -0
- package/sdk/public/PublicClient.js +4 -0
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +5 -2
- package/sdk/public/Webhook/WebhookPublicClient.js +15 -9
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +1 -191
- package/sdk/public/Webhook/WebhookPublicModel.js +0 -229
- package/sdk/public/index.d.ts +1 -0
- package/sdk/public/index.js +2 -0
- package/sdk/application/ApplicationModels.d.ts +0 -48
- package/sdk/application/ApplicationModels.js +0 -38
- package/sdk/platform/Partner/PartnerPlatformClient.d.ts +0 -106
- package/sdk/platform/Partner/PartnerPlatformClient.js +0 -878
- package/sdk/platform/Partner/PartnerPlatformValidator.d.ts +0 -208
- package/sdk/platform/Partner/PartnerPlatformValidator.js +0 -169
|
@@ -3,6 +3,9 @@ export = CommunicationPlatformApplicationValidator;
|
|
|
3
3
|
* @typedef CreateAudienceParam
|
|
4
4
|
* @property {CommunicationPlatformModel.AudienceReq} body
|
|
5
5
|
*/
|
|
6
|
+
/** @typedef CreateBigQueryHeadersParam */
|
|
7
|
+
/** @typedef CreateBigQueryNCountParam */
|
|
8
|
+
/** @typedef CreateBigQueryRowCountParam */
|
|
6
9
|
/**
|
|
7
10
|
* @typedef CreateCampaignParam
|
|
8
11
|
* @property {CommunicationPlatformModel.CampaignReq} body
|
|
@@ -23,14 +26,27 @@ export = CommunicationPlatformApplicationValidator;
|
|
|
23
26
|
* @typedef CreateSmsTemplateParam
|
|
24
27
|
* @property {CommunicationPlatformModel.SmsTemplateReq} body
|
|
25
28
|
*/
|
|
29
|
+
/**
|
|
30
|
+
* @typedef DeleteAudienceByIdParam
|
|
31
|
+
* @property {string} id - Audience id
|
|
32
|
+
*/
|
|
33
|
+
/**
|
|
34
|
+
* @typedef DeleteEmailProviderByIdParam
|
|
35
|
+
* @property {string} id - Email provider id
|
|
36
|
+
*/
|
|
26
37
|
/**
|
|
27
38
|
* @typedef DeleteEmailTemplateByIdParam
|
|
28
39
|
* @property {string} id - Email template id
|
|
29
40
|
*/
|
|
41
|
+
/**
|
|
42
|
+
* @typedef DeleteSmsProviderByIdParam
|
|
43
|
+
* @property {string} id - Sms provider id
|
|
44
|
+
*/
|
|
30
45
|
/**
|
|
31
46
|
* @typedef DeleteSmsTemplateByIdParam
|
|
32
47
|
* @property {string} id - Sms template id
|
|
33
48
|
*/
|
|
49
|
+
/** @typedef GetAppProvidersParam */
|
|
34
50
|
/**
|
|
35
51
|
* @typedef GetAudienceByIdParam
|
|
36
52
|
* @property {string} id - Audience id
|
|
@@ -42,8 +58,12 @@ export = CommunicationPlatformApplicationValidator;
|
|
|
42
58
|
* @property {Object} [sort] - To sort based on created_at
|
|
43
59
|
*/
|
|
44
60
|
/**
|
|
45
|
-
* @typedef
|
|
46
|
-
* @property {
|
|
61
|
+
* @typedef GetBigQueryHeadersByIdParam
|
|
62
|
+
* @property {string} id - Audience id
|
|
63
|
+
*/
|
|
64
|
+
/**
|
|
65
|
+
* @typedef GetBigQueryRowCountByIdParam
|
|
66
|
+
* @property {string} id - Audience id
|
|
47
67
|
*/
|
|
48
68
|
/**
|
|
49
69
|
* @typedef GetCampaignByIdParam
|
|
@@ -62,6 +82,12 @@ export = CommunicationPlatformApplicationValidator;
|
|
|
62
82
|
* @property {Object} [sort] - To sort based on _id
|
|
63
83
|
* @property {Object} [query]
|
|
64
84
|
*/
|
|
85
|
+
/** @typedef GetDefaultSmsProvidersParam */
|
|
86
|
+
/** @typedef GetDummyDatasourcesParam */
|
|
87
|
+
/**
|
|
88
|
+
* @typedef GetDummyDatasourcesMetaParam
|
|
89
|
+
* @property {number} id - Dummy datasources meta ID
|
|
90
|
+
*/
|
|
65
91
|
/**
|
|
66
92
|
* @typedef GetEmailProviderByIdParam
|
|
67
93
|
* @property {string} id - Email provider id
|
|
@@ -88,6 +114,8 @@ export = CommunicationPlatformApplicationValidator;
|
|
|
88
114
|
* @property {number} [pageSize] - Current request items count
|
|
89
115
|
* @property {string} [populate] - Populate fields
|
|
90
116
|
*/
|
|
117
|
+
/** @typedef GetGlobalProvidersParam */
|
|
118
|
+
/** @typedef GetGlobalVariablesParam */
|
|
91
119
|
/**
|
|
92
120
|
* @typedef GetJobLogsParam
|
|
93
121
|
* @property {number} [pageNo] - Current page no
|
|
@@ -104,6 +132,7 @@ export = CommunicationPlatformApplicationValidator;
|
|
|
104
132
|
* @typedef GetNSampleRecordsFromCsvParam
|
|
105
133
|
* @property {CommunicationPlatformModel.GetNRecordsCsvReq} body
|
|
106
134
|
*/
|
|
135
|
+
/** @typedef GetNSampleRecordsFromCsvByGetParam */
|
|
107
136
|
/**
|
|
108
137
|
* @typedef GetSmsProviderByIdParam
|
|
109
138
|
* @property {string} id - Sms provider id
|
|
@@ -129,16 +158,21 @@ export = CommunicationPlatformApplicationValidator;
|
|
|
129
158
|
* @property {string} id - Campaign id
|
|
130
159
|
*/
|
|
131
160
|
/**
|
|
132
|
-
* @typedef
|
|
161
|
+
* @typedef GetSubscribedEmailTemplatesParam
|
|
133
162
|
* @property {number} [pageNo] - Current page no
|
|
134
163
|
* @property {number} [pageSize] - Current request items count
|
|
135
|
-
* @property {Object} [sort] - To sort based on created_at
|
|
136
164
|
*/
|
|
137
165
|
/**
|
|
138
|
-
* @typedef
|
|
166
|
+
* @typedef GetSubscribedSmsTemplatesParam
|
|
139
167
|
* @property {number} [pageNo] - Current page no
|
|
140
168
|
* @property {number} [pageSize] - Current request items count
|
|
141
|
-
|
|
169
|
+
*/
|
|
170
|
+
/** @typedef GetSystemAudiencesParam */
|
|
171
|
+
/** @typedef GetSystemEmailTemplatesParam */
|
|
172
|
+
/** @typedef GetSystemSmsTemplatesParam */
|
|
173
|
+
/**
|
|
174
|
+
* @typedef PostGlobalVariablesParam
|
|
175
|
+
* @property {CommunicationPlatformModel.GlobalVariablesReq} body
|
|
142
176
|
*/
|
|
143
177
|
/**
|
|
144
178
|
* @typedef SendCommunicationAsynchronouslyParam
|
|
@@ -156,6 +190,10 @@ export = CommunicationPlatformApplicationValidator;
|
|
|
156
190
|
* @typedef TriggerCampaignJobParam
|
|
157
191
|
* @property {CommunicationPlatformModel.TriggerJobRequest} body
|
|
158
192
|
*/
|
|
193
|
+
/**
|
|
194
|
+
* @typedef UpdateAppProvidersParam
|
|
195
|
+
* @property {CommunicationPlatformModel.AppProviderReq} body
|
|
196
|
+
*/
|
|
159
197
|
/**
|
|
160
198
|
* @typedef UpdateAudienceByIdParam
|
|
161
199
|
* @property {string} id - Audience id
|
|
@@ -193,6 +231,12 @@ export = CommunicationPlatformApplicationValidator;
|
|
|
193
231
|
declare class CommunicationPlatformApplicationValidator {
|
|
194
232
|
/** @returns {CreateAudienceParam} */
|
|
195
233
|
static createAudience(): CreateAudienceParam;
|
|
234
|
+
/** @returns {CreateBigQueryHeadersParam} */
|
|
235
|
+
static createBigQueryHeaders(): any;
|
|
236
|
+
/** @returns {CreateBigQueryNCountParam} */
|
|
237
|
+
static createBigQueryNCount(): any;
|
|
238
|
+
/** @returns {CreateBigQueryRowCountParam} */
|
|
239
|
+
static createBigQueryRowCount(): any;
|
|
196
240
|
/** @returns {CreateCampaignParam} */
|
|
197
241
|
static createCampaign(): CreateCampaignParam;
|
|
198
242
|
/** @returns {CreateEmailProviderParam} */
|
|
@@ -203,22 +247,38 @@ declare class CommunicationPlatformApplicationValidator {
|
|
|
203
247
|
static createSmsProvider(): CreateSmsProviderParam;
|
|
204
248
|
/** @returns {CreateSmsTemplateParam} */
|
|
205
249
|
static createSmsTemplate(): CreateSmsTemplateParam;
|
|
250
|
+
/** @returns {DeleteAudienceByIdParam} */
|
|
251
|
+
static deleteAudienceById(): DeleteAudienceByIdParam;
|
|
252
|
+
/** @returns {DeleteEmailProviderByIdParam} */
|
|
253
|
+
static deleteEmailProviderById(): DeleteEmailProviderByIdParam;
|
|
206
254
|
/** @returns {DeleteEmailTemplateByIdParam} */
|
|
207
255
|
static deleteEmailTemplateById(): DeleteEmailTemplateByIdParam;
|
|
256
|
+
/** @returns {DeleteSmsProviderByIdParam} */
|
|
257
|
+
static deleteSmsProviderById(): DeleteSmsProviderByIdParam;
|
|
208
258
|
/** @returns {DeleteSmsTemplateByIdParam} */
|
|
209
259
|
static deleteSmsTemplateById(): DeleteSmsTemplateByIdParam;
|
|
260
|
+
/** @returns {GetAppProvidersParam} */
|
|
261
|
+
static getAppProviders(): any;
|
|
210
262
|
/** @returns {GetAudienceByIdParam} */
|
|
211
263
|
static getAudienceById(): GetAudienceByIdParam;
|
|
212
264
|
/** @returns {GetAudiencesParam} */
|
|
213
265
|
static getAudiences(): GetAudiencesParam;
|
|
214
|
-
/** @returns {
|
|
215
|
-
static
|
|
266
|
+
/** @returns {GetBigQueryHeadersByIdParam} */
|
|
267
|
+
static getBigQueryHeadersById(): GetBigQueryHeadersByIdParam;
|
|
268
|
+
/** @returns {GetBigQueryRowCountByIdParam} */
|
|
269
|
+
static getBigQueryRowCountById(): GetBigQueryRowCountByIdParam;
|
|
216
270
|
/** @returns {GetCampaignByIdParam} */
|
|
217
271
|
static getCampaignById(): GetCampaignByIdParam;
|
|
218
272
|
/** @returns {GetCampaignsParam} */
|
|
219
273
|
static getCampaigns(): GetCampaignsParam;
|
|
220
274
|
/** @returns {GetCommunicationLogsParam} */
|
|
221
275
|
static getCommunicationLogs(): GetCommunicationLogsParam;
|
|
276
|
+
/** @returns {GetDefaultSmsProvidersParam} */
|
|
277
|
+
static getDefaultSmsProviders(): any;
|
|
278
|
+
/** @returns {GetDummyDatasourcesParam} */
|
|
279
|
+
static getDummyDatasources(): any;
|
|
280
|
+
/** @returns {GetDummyDatasourcesMetaParam} */
|
|
281
|
+
static getDummyDatasourcesMeta(): GetDummyDatasourcesMetaParam;
|
|
222
282
|
/** @returns {GetEmailProviderByIdParam} */
|
|
223
283
|
static getEmailProviderById(): GetEmailProviderByIdParam;
|
|
224
284
|
/** @returns {GetEmailProvidersParam} */
|
|
@@ -229,12 +289,18 @@ declare class CommunicationPlatformApplicationValidator {
|
|
|
229
289
|
static getEmailTemplates(): GetEmailTemplatesParam;
|
|
230
290
|
/** @returns {GetEventSubscriptionsParam} */
|
|
231
291
|
static getEventSubscriptions(): GetEventSubscriptionsParam;
|
|
292
|
+
/** @returns {GetGlobalProvidersParam} */
|
|
293
|
+
static getGlobalProviders(): any;
|
|
294
|
+
/** @returns {GetGlobalVariablesParam} */
|
|
295
|
+
static getGlobalVariables(): any;
|
|
232
296
|
/** @returns {GetJobLogsParam} */
|
|
233
297
|
static getJobLogs(): GetJobLogsParam;
|
|
234
298
|
/** @returns {GetJobsParam} */
|
|
235
299
|
static getJobs(): GetJobsParam;
|
|
236
300
|
/** @returns {GetNSampleRecordsFromCsvParam} */
|
|
237
301
|
static getNSampleRecordsFromCsv(): GetNSampleRecordsFromCsvParam;
|
|
302
|
+
/** @returns {GetNSampleRecordsFromCsvByGetParam} */
|
|
303
|
+
static getNSampleRecordsFromCsvByGet(): any;
|
|
238
304
|
/** @returns {GetSmsProviderByIdParam} */
|
|
239
305
|
static getSmsProviderById(): GetSmsProviderByIdParam;
|
|
240
306
|
/** @returns {GetSmsProvidersParam} */
|
|
@@ -245,10 +311,18 @@ declare class CommunicationPlatformApplicationValidator {
|
|
|
245
311
|
static getSmsTemplates(): GetSmsTemplatesParam;
|
|
246
312
|
/** @returns {GetStatsOfCampaignByIdParam} */
|
|
247
313
|
static getStatsOfCampaignById(): GetStatsOfCampaignByIdParam;
|
|
314
|
+
/** @returns {GetSubscribedEmailTemplatesParam} */
|
|
315
|
+
static getSubscribedEmailTemplates(): GetSubscribedEmailTemplatesParam;
|
|
316
|
+
/** @returns {GetSubscribedSmsTemplatesParam} */
|
|
317
|
+
static getSubscribedSmsTemplates(): GetSubscribedSmsTemplatesParam;
|
|
318
|
+
/** @returns {GetSystemAudiencesParam} */
|
|
319
|
+
static getSystemAudiences(): any;
|
|
248
320
|
/** @returns {GetSystemEmailTemplatesParam} */
|
|
249
|
-
static getSystemEmailTemplates():
|
|
250
|
-
/** @returns {
|
|
251
|
-
static
|
|
321
|
+
static getSystemEmailTemplates(): any;
|
|
322
|
+
/** @returns {GetSystemSmsTemplatesParam} */
|
|
323
|
+
static getSystemSmsTemplates(): any;
|
|
324
|
+
/** @returns {PostGlobalVariablesParam} */
|
|
325
|
+
static postGlobalVariables(): PostGlobalVariablesParam;
|
|
252
326
|
/** @returns {SendCommunicationAsynchronouslyParam} */
|
|
253
327
|
static sendCommunicationAsynchronously(): SendCommunicationAsynchronouslyParam;
|
|
254
328
|
/** @returns {SendCommunicationSynchronouslyParam} */
|
|
@@ -257,6 +331,8 @@ declare class CommunicationPlatformApplicationValidator {
|
|
|
257
331
|
static sendOtp(): SendOtpParam;
|
|
258
332
|
/** @returns {TriggerCampaignJobParam} */
|
|
259
333
|
static triggerCampaignJob(): TriggerCampaignJobParam;
|
|
334
|
+
/** @returns {UpdateAppProvidersParam} */
|
|
335
|
+
static updateAppProviders(): UpdateAppProvidersParam;
|
|
260
336
|
/** @returns {UpdateAudienceByIdParam} */
|
|
261
337
|
static updateAudienceById(): UpdateAudienceByIdParam;
|
|
262
338
|
/** @returns {UpdateCampaignByIdParam} */
|
|
@@ -273,7 +349,7 @@ declare class CommunicationPlatformApplicationValidator {
|
|
|
273
349
|
static verfiyOtp(): VerfiyOtpParam;
|
|
274
350
|
}
|
|
275
351
|
declare namespace CommunicationPlatformApplicationValidator {
|
|
276
|
-
export { CreateAudienceParam, CreateCampaignParam, CreateEmailProviderParam, CreateEmailTemplateParam, CreateSmsProviderParam, CreateSmsTemplateParam, DeleteEmailTemplateByIdParam, DeleteSmsTemplateByIdParam, GetAudienceByIdParam, GetAudiencesParam,
|
|
352
|
+
export { CreateAudienceParam, CreateBigQueryHeadersParam, CreateBigQueryNCountParam, CreateBigQueryRowCountParam, CreateCampaignParam, CreateEmailProviderParam, CreateEmailTemplateParam, CreateSmsProviderParam, CreateSmsTemplateParam, DeleteAudienceByIdParam, DeleteEmailProviderByIdParam, DeleteEmailTemplateByIdParam, DeleteSmsProviderByIdParam, DeleteSmsTemplateByIdParam, GetAppProvidersParam, GetAudienceByIdParam, GetAudiencesParam, GetBigQueryHeadersByIdParam, GetBigQueryRowCountByIdParam, GetCampaignByIdParam, GetCampaignsParam, GetCommunicationLogsParam, GetDefaultSmsProvidersParam, GetDummyDatasourcesParam, GetDummyDatasourcesMetaParam, GetEmailProviderByIdParam, GetEmailProvidersParam, GetEmailTemplateByIdParam, GetEmailTemplatesParam, GetEventSubscriptionsParam, GetGlobalProvidersParam, GetGlobalVariablesParam, GetJobLogsParam, GetJobsParam, GetNSampleRecordsFromCsvParam, GetNSampleRecordsFromCsvByGetParam, GetSmsProviderByIdParam, GetSmsProvidersParam, GetSmsTemplateByIdParam, GetSmsTemplatesParam, GetStatsOfCampaignByIdParam, GetSubscribedEmailTemplatesParam, GetSubscribedSmsTemplatesParam, GetSystemAudiencesParam, GetSystemEmailTemplatesParam, GetSystemSmsTemplatesParam, PostGlobalVariablesParam, SendCommunicationAsynchronouslyParam, SendCommunicationSynchronouslyParam, SendOtpParam, TriggerCampaignJobParam, UpdateAppProvidersParam, UpdateAudienceByIdParam, UpdateCampaignByIdParam, UpdateEmailProviderByIdParam, UpdateEmailTemplateByIdParam, UpdateSmsProviderByIdParam, UpdateSmsTemplateByIdParam, VerfiyOtpParam };
|
|
277
353
|
}
|
|
278
354
|
type CreateAudienceParam = {
|
|
279
355
|
body: CommunicationPlatformModel.AudienceReq;
|
|
@@ -293,12 +369,30 @@ type CreateSmsProviderParam = {
|
|
|
293
369
|
type CreateSmsTemplateParam = {
|
|
294
370
|
body: CommunicationPlatformModel.SmsTemplateReq;
|
|
295
371
|
};
|
|
372
|
+
type DeleteAudienceByIdParam = {
|
|
373
|
+
/**
|
|
374
|
+
* - Audience id
|
|
375
|
+
*/
|
|
376
|
+
id: string;
|
|
377
|
+
};
|
|
378
|
+
type DeleteEmailProviderByIdParam = {
|
|
379
|
+
/**
|
|
380
|
+
* - Email provider id
|
|
381
|
+
*/
|
|
382
|
+
id: string;
|
|
383
|
+
};
|
|
296
384
|
type DeleteEmailTemplateByIdParam = {
|
|
297
385
|
/**
|
|
298
386
|
* - Email template id
|
|
299
387
|
*/
|
|
300
388
|
id: string;
|
|
301
389
|
};
|
|
390
|
+
type DeleteSmsProviderByIdParam = {
|
|
391
|
+
/**
|
|
392
|
+
* - Sms provider id
|
|
393
|
+
*/
|
|
394
|
+
id: string;
|
|
395
|
+
};
|
|
302
396
|
type DeleteSmsTemplateByIdParam = {
|
|
303
397
|
/**
|
|
304
398
|
* - Sms template id
|
|
@@ -325,8 +419,17 @@ type GetAudiencesParam = {
|
|
|
325
419
|
*/
|
|
326
420
|
sort?: any;
|
|
327
421
|
};
|
|
328
|
-
type
|
|
329
|
-
|
|
422
|
+
type GetBigQueryHeadersByIdParam = {
|
|
423
|
+
/**
|
|
424
|
+
* - Audience id
|
|
425
|
+
*/
|
|
426
|
+
id: string;
|
|
427
|
+
};
|
|
428
|
+
type GetBigQueryRowCountByIdParam = {
|
|
429
|
+
/**
|
|
430
|
+
* - Audience id
|
|
431
|
+
*/
|
|
432
|
+
id: string;
|
|
330
433
|
};
|
|
331
434
|
type GetCampaignByIdParam = {
|
|
332
435
|
/**
|
|
@@ -363,6 +466,12 @@ type GetCommunicationLogsParam = {
|
|
|
363
466
|
sort?: any;
|
|
364
467
|
query?: any;
|
|
365
468
|
};
|
|
469
|
+
type GetDummyDatasourcesMetaParam = {
|
|
470
|
+
/**
|
|
471
|
+
* - Dummy datasources meta ID
|
|
472
|
+
*/
|
|
473
|
+
id: number;
|
|
474
|
+
};
|
|
366
475
|
type GetEmailProviderByIdParam = {
|
|
367
476
|
/**
|
|
368
477
|
* - Email provider id
|
|
@@ -494,7 +603,7 @@ type GetStatsOfCampaignByIdParam = {
|
|
|
494
603
|
*/
|
|
495
604
|
id: string;
|
|
496
605
|
};
|
|
497
|
-
type
|
|
606
|
+
type GetSubscribedEmailTemplatesParam = {
|
|
498
607
|
/**
|
|
499
608
|
* - Current page no
|
|
500
609
|
*/
|
|
@@ -503,12 +612,8 @@ type GetSystemEmailTemplatesParam = {
|
|
|
503
612
|
* - Current request items count
|
|
504
613
|
*/
|
|
505
614
|
pageSize?: number;
|
|
506
|
-
/**
|
|
507
|
-
* - To sort based on created_at
|
|
508
|
-
*/
|
|
509
|
-
sort?: any;
|
|
510
615
|
};
|
|
511
|
-
type
|
|
616
|
+
type GetSubscribedSmsTemplatesParam = {
|
|
512
617
|
/**
|
|
513
618
|
* - Current page no
|
|
514
619
|
*/
|
|
@@ -517,10 +622,9 @@ type GetSystemSystemTemplatesParam = {
|
|
|
517
622
|
* - Current request items count
|
|
518
623
|
*/
|
|
519
624
|
pageSize?: number;
|
|
520
|
-
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
sort?: any;
|
|
625
|
+
};
|
|
626
|
+
type PostGlobalVariablesParam = {
|
|
627
|
+
body: CommunicationPlatformModel.GlobalVariablesReq;
|
|
524
628
|
};
|
|
525
629
|
type SendCommunicationAsynchronouslyParam = {
|
|
526
630
|
body: CommunicationPlatformModel.EngineRequest;
|
|
@@ -534,6 +638,9 @@ type SendOtpParam = {
|
|
|
534
638
|
type TriggerCampaignJobParam = {
|
|
535
639
|
body: CommunicationPlatformModel.TriggerJobRequest;
|
|
536
640
|
};
|
|
641
|
+
type UpdateAppProvidersParam = {
|
|
642
|
+
body: CommunicationPlatformModel.AppProviderReq;
|
|
643
|
+
};
|
|
537
644
|
type UpdateAudienceByIdParam = {
|
|
538
645
|
/**
|
|
539
646
|
* - Audience id
|
|
@@ -579,4 +686,16 @@ type UpdateSmsTemplateByIdParam = {
|
|
|
579
686
|
type VerfiyOtpParam = {
|
|
580
687
|
body: CommunicationPlatformModel.VerifyOtpCommsReq;
|
|
581
688
|
};
|
|
689
|
+
type CreateBigQueryHeadersParam = any;
|
|
690
|
+
type CreateBigQueryNCountParam = any;
|
|
691
|
+
type CreateBigQueryRowCountParam = any;
|
|
692
|
+
type GetAppProvidersParam = any;
|
|
693
|
+
type GetDefaultSmsProvidersParam = any;
|
|
694
|
+
type GetDummyDatasourcesParam = any;
|
|
695
|
+
type GetGlobalProvidersParam = any;
|
|
696
|
+
type GetGlobalVariablesParam = any;
|
|
697
|
+
type GetNSampleRecordsFromCsvByGetParam = any;
|
|
698
|
+
type GetSystemAudiencesParam = any;
|
|
699
|
+
type GetSystemEmailTemplatesParam = any;
|
|
700
|
+
type GetSystemSmsTemplatesParam = any;
|
|
582
701
|
import CommunicationPlatformModel = require("./CommunicationPlatformModel");
|
|
@@ -7,6 +7,12 @@ const CommunicationPlatformModel = require("./CommunicationPlatformModel");
|
|
|
7
7
|
* @property {CommunicationPlatformModel.AudienceReq} body
|
|
8
8
|
*/
|
|
9
9
|
|
|
10
|
+
/** @typedef CreateBigQueryHeadersParam */
|
|
11
|
+
|
|
12
|
+
/** @typedef CreateBigQueryNCountParam */
|
|
13
|
+
|
|
14
|
+
/** @typedef CreateBigQueryRowCountParam */
|
|
15
|
+
|
|
10
16
|
/**
|
|
11
17
|
* @typedef CreateCampaignParam
|
|
12
18
|
* @property {CommunicationPlatformModel.CampaignReq} body
|
|
@@ -32,16 +38,33 @@ const CommunicationPlatformModel = require("./CommunicationPlatformModel");
|
|
|
32
38
|
* @property {CommunicationPlatformModel.SmsTemplateReq} body
|
|
33
39
|
*/
|
|
34
40
|
|
|
41
|
+
/**
|
|
42
|
+
* @typedef DeleteAudienceByIdParam
|
|
43
|
+
* @property {string} id - Audience id
|
|
44
|
+
*/
|
|
45
|
+
|
|
46
|
+
/**
|
|
47
|
+
* @typedef DeleteEmailProviderByIdParam
|
|
48
|
+
* @property {string} id - Email provider id
|
|
49
|
+
*/
|
|
50
|
+
|
|
35
51
|
/**
|
|
36
52
|
* @typedef DeleteEmailTemplateByIdParam
|
|
37
53
|
* @property {string} id - Email template id
|
|
38
54
|
*/
|
|
39
55
|
|
|
56
|
+
/**
|
|
57
|
+
* @typedef DeleteSmsProviderByIdParam
|
|
58
|
+
* @property {string} id - Sms provider id
|
|
59
|
+
*/
|
|
60
|
+
|
|
40
61
|
/**
|
|
41
62
|
* @typedef DeleteSmsTemplateByIdParam
|
|
42
63
|
* @property {string} id - Sms template id
|
|
43
64
|
*/
|
|
44
65
|
|
|
66
|
+
/** @typedef GetAppProvidersParam */
|
|
67
|
+
|
|
45
68
|
/**
|
|
46
69
|
* @typedef GetAudienceByIdParam
|
|
47
70
|
* @property {string} id - Audience id
|
|
@@ -55,8 +78,13 @@ const CommunicationPlatformModel = require("./CommunicationPlatformModel");
|
|
|
55
78
|
*/
|
|
56
79
|
|
|
57
80
|
/**
|
|
58
|
-
* @typedef
|
|
59
|
-
* @property {
|
|
81
|
+
* @typedef GetBigQueryHeadersByIdParam
|
|
82
|
+
* @property {string} id - Audience id
|
|
83
|
+
*/
|
|
84
|
+
|
|
85
|
+
/**
|
|
86
|
+
* @typedef GetBigQueryRowCountByIdParam
|
|
87
|
+
* @property {string} id - Audience id
|
|
60
88
|
*/
|
|
61
89
|
|
|
62
90
|
/**
|
|
@@ -79,6 +107,15 @@ const CommunicationPlatformModel = require("./CommunicationPlatformModel");
|
|
|
79
107
|
* @property {Object} [query]
|
|
80
108
|
*/
|
|
81
109
|
|
|
110
|
+
/** @typedef GetDefaultSmsProvidersParam */
|
|
111
|
+
|
|
112
|
+
/** @typedef GetDummyDatasourcesParam */
|
|
113
|
+
|
|
114
|
+
/**
|
|
115
|
+
* @typedef GetDummyDatasourcesMetaParam
|
|
116
|
+
* @property {number} id - Dummy datasources meta ID
|
|
117
|
+
*/
|
|
118
|
+
|
|
82
119
|
/**
|
|
83
120
|
* @typedef GetEmailProviderByIdParam
|
|
84
121
|
* @property {string} id - Email provider id
|
|
@@ -110,6 +147,10 @@ const CommunicationPlatformModel = require("./CommunicationPlatformModel");
|
|
|
110
147
|
* @property {string} [populate] - Populate fields
|
|
111
148
|
*/
|
|
112
149
|
|
|
150
|
+
/** @typedef GetGlobalProvidersParam */
|
|
151
|
+
|
|
152
|
+
/** @typedef GetGlobalVariablesParam */
|
|
153
|
+
|
|
113
154
|
/**
|
|
114
155
|
* @typedef GetJobLogsParam
|
|
115
156
|
* @property {number} [pageNo] - Current page no
|
|
@@ -129,6 +170,8 @@ const CommunicationPlatformModel = require("./CommunicationPlatformModel");
|
|
|
129
170
|
* @property {CommunicationPlatformModel.GetNRecordsCsvReq} body
|
|
130
171
|
*/
|
|
131
172
|
|
|
173
|
+
/** @typedef GetNSampleRecordsFromCsvByGetParam */
|
|
174
|
+
|
|
132
175
|
/**
|
|
133
176
|
* @typedef GetSmsProviderByIdParam
|
|
134
177
|
* @property {string} id - Sms provider id
|
|
@@ -159,17 +202,26 @@ const CommunicationPlatformModel = require("./CommunicationPlatformModel");
|
|
|
159
202
|
*/
|
|
160
203
|
|
|
161
204
|
/**
|
|
162
|
-
* @typedef
|
|
205
|
+
* @typedef GetSubscribedEmailTemplatesParam
|
|
163
206
|
* @property {number} [pageNo] - Current page no
|
|
164
207
|
* @property {number} [pageSize] - Current request items count
|
|
165
|
-
* @property {Object} [sort] - To sort based on created_at
|
|
166
208
|
*/
|
|
167
209
|
|
|
168
210
|
/**
|
|
169
|
-
* @typedef
|
|
211
|
+
* @typedef GetSubscribedSmsTemplatesParam
|
|
170
212
|
* @property {number} [pageNo] - Current page no
|
|
171
213
|
* @property {number} [pageSize] - Current request items count
|
|
172
|
-
|
|
214
|
+
*/
|
|
215
|
+
|
|
216
|
+
/** @typedef GetSystemAudiencesParam */
|
|
217
|
+
|
|
218
|
+
/** @typedef GetSystemEmailTemplatesParam */
|
|
219
|
+
|
|
220
|
+
/** @typedef GetSystemSmsTemplatesParam */
|
|
221
|
+
|
|
222
|
+
/**
|
|
223
|
+
* @typedef PostGlobalVariablesParam
|
|
224
|
+
* @property {CommunicationPlatformModel.GlobalVariablesReq} body
|
|
173
225
|
*/
|
|
174
226
|
|
|
175
227
|
/**
|
|
@@ -192,6 +244,11 @@ const CommunicationPlatformModel = require("./CommunicationPlatformModel");
|
|
|
192
244
|
* @property {CommunicationPlatformModel.TriggerJobRequest} body
|
|
193
245
|
*/
|
|
194
246
|
|
|
247
|
+
/**
|
|
248
|
+
* @typedef UpdateAppProvidersParam
|
|
249
|
+
* @property {CommunicationPlatformModel.AppProviderReq} body
|
|
250
|
+
*/
|
|
251
|
+
|
|
195
252
|
/**
|
|
196
253
|
* @typedef UpdateAudienceByIdParam
|
|
197
254
|
* @property {string} id - Audience id
|
|
@@ -241,6 +298,21 @@ class CommunicationPlatformApplicationValidator {
|
|
|
241
298
|
}).required();
|
|
242
299
|
}
|
|
243
300
|
|
|
301
|
+
/** @returns {CreateBigQueryHeadersParam} */
|
|
302
|
+
static createBigQueryHeaders() {
|
|
303
|
+
return Joi.object({}).required();
|
|
304
|
+
}
|
|
305
|
+
|
|
306
|
+
/** @returns {CreateBigQueryNCountParam} */
|
|
307
|
+
static createBigQueryNCount() {
|
|
308
|
+
return Joi.object({}).required();
|
|
309
|
+
}
|
|
310
|
+
|
|
311
|
+
/** @returns {CreateBigQueryRowCountParam} */
|
|
312
|
+
static createBigQueryRowCount() {
|
|
313
|
+
return Joi.object({}).required();
|
|
314
|
+
}
|
|
315
|
+
|
|
244
316
|
/** @returns {CreateCampaignParam} */
|
|
245
317
|
static createCampaign() {
|
|
246
318
|
return Joi.object({
|
|
@@ -276,6 +348,20 @@ class CommunicationPlatformApplicationValidator {
|
|
|
276
348
|
}).required();
|
|
277
349
|
}
|
|
278
350
|
|
|
351
|
+
/** @returns {DeleteAudienceByIdParam} */
|
|
352
|
+
static deleteAudienceById() {
|
|
353
|
+
return Joi.object({
|
|
354
|
+
id: Joi.string().allow("").required(),
|
|
355
|
+
}).required();
|
|
356
|
+
}
|
|
357
|
+
|
|
358
|
+
/** @returns {DeleteEmailProviderByIdParam} */
|
|
359
|
+
static deleteEmailProviderById() {
|
|
360
|
+
return Joi.object({
|
|
361
|
+
id: Joi.string().allow("").required(),
|
|
362
|
+
}).required();
|
|
363
|
+
}
|
|
364
|
+
|
|
279
365
|
/** @returns {DeleteEmailTemplateByIdParam} */
|
|
280
366
|
static deleteEmailTemplateById() {
|
|
281
367
|
return Joi.object({
|
|
@@ -283,6 +369,13 @@ class CommunicationPlatformApplicationValidator {
|
|
|
283
369
|
}).required();
|
|
284
370
|
}
|
|
285
371
|
|
|
372
|
+
/** @returns {DeleteSmsProviderByIdParam} */
|
|
373
|
+
static deleteSmsProviderById() {
|
|
374
|
+
return Joi.object({
|
|
375
|
+
id: Joi.string().allow("").required(),
|
|
376
|
+
}).required();
|
|
377
|
+
}
|
|
378
|
+
|
|
286
379
|
/** @returns {DeleteSmsTemplateByIdParam} */
|
|
287
380
|
static deleteSmsTemplateById() {
|
|
288
381
|
return Joi.object({
|
|
@@ -290,6 +383,11 @@ class CommunicationPlatformApplicationValidator {
|
|
|
290
383
|
}).required();
|
|
291
384
|
}
|
|
292
385
|
|
|
386
|
+
/** @returns {GetAppProvidersParam} */
|
|
387
|
+
static getAppProviders() {
|
|
388
|
+
return Joi.object({}).required();
|
|
389
|
+
}
|
|
390
|
+
|
|
293
391
|
/** @returns {GetAudienceByIdParam} */
|
|
294
392
|
static getAudienceById() {
|
|
295
393
|
return Joi.object({
|
|
@@ -306,10 +404,17 @@ class CommunicationPlatformApplicationValidator {
|
|
|
306
404
|
}).required();
|
|
307
405
|
}
|
|
308
406
|
|
|
309
|
-
/** @returns {
|
|
310
|
-
static
|
|
407
|
+
/** @returns {GetBigQueryHeadersByIdParam} */
|
|
408
|
+
static getBigQueryHeadersById() {
|
|
409
|
+
return Joi.object({
|
|
410
|
+
id: Joi.string().allow("").required(),
|
|
411
|
+
}).required();
|
|
412
|
+
}
|
|
413
|
+
|
|
414
|
+
/** @returns {GetBigQueryRowCountByIdParam} */
|
|
415
|
+
static getBigQueryRowCountById() {
|
|
311
416
|
return Joi.object({
|
|
312
|
-
|
|
417
|
+
id: Joi.string().allow("").required(),
|
|
313
418
|
}).required();
|
|
314
419
|
}
|
|
315
420
|
|
|
@@ -339,6 +444,23 @@ class CommunicationPlatformApplicationValidator {
|
|
|
339
444
|
}).required();
|
|
340
445
|
}
|
|
341
446
|
|
|
447
|
+
/** @returns {GetDefaultSmsProvidersParam} */
|
|
448
|
+
static getDefaultSmsProviders() {
|
|
449
|
+
return Joi.object({}).required();
|
|
450
|
+
}
|
|
451
|
+
|
|
452
|
+
/** @returns {GetDummyDatasourcesParam} */
|
|
453
|
+
static getDummyDatasources() {
|
|
454
|
+
return Joi.object({}).required();
|
|
455
|
+
}
|
|
456
|
+
|
|
457
|
+
/** @returns {GetDummyDatasourcesMetaParam} */
|
|
458
|
+
static getDummyDatasourcesMeta() {
|
|
459
|
+
return Joi.object({
|
|
460
|
+
id: Joi.number().required(),
|
|
461
|
+
}).required();
|
|
462
|
+
}
|
|
463
|
+
|
|
342
464
|
/** @returns {GetEmailProviderByIdParam} */
|
|
343
465
|
static getEmailProviderById() {
|
|
344
466
|
return Joi.object({
|
|
@@ -380,6 +502,16 @@ class CommunicationPlatformApplicationValidator {
|
|
|
380
502
|
}).required();
|
|
381
503
|
}
|
|
382
504
|
|
|
505
|
+
/** @returns {GetGlobalProvidersParam} */
|
|
506
|
+
static getGlobalProviders() {
|
|
507
|
+
return Joi.object({}).required();
|
|
508
|
+
}
|
|
509
|
+
|
|
510
|
+
/** @returns {GetGlobalVariablesParam} */
|
|
511
|
+
static getGlobalVariables() {
|
|
512
|
+
return Joi.object({}).required();
|
|
513
|
+
}
|
|
514
|
+
|
|
383
515
|
/** @returns {GetJobLogsParam} */
|
|
384
516
|
static getJobLogs() {
|
|
385
517
|
return Joi.object({
|
|
@@ -405,6 +537,11 @@ class CommunicationPlatformApplicationValidator {
|
|
|
405
537
|
}).required();
|
|
406
538
|
}
|
|
407
539
|
|
|
540
|
+
/** @returns {GetNSampleRecordsFromCsvByGetParam} */
|
|
541
|
+
static getNSampleRecordsFromCsvByGet() {
|
|
542
|
+
return Joi.object({}).required();
|
|
543
|
+
}
|
|
544
|
+
|
|
408
545
|
/** @returns {GetSmsProviderByIdParam} */
|
|
409
546
|
static getSmsProviderById() {
|
|
410
547
|
return Joi.object({
|
|
@@ -444,21 +581,41 @@ class CommunicationPlatformApplicationValidator {
|
|
|
444
581
|
}).required();
|
|
445
582
|
}
|
|
446
583
|
|
|
447
|
-
/** @returns {
|
|
448
|
-
static
|
|
584
|
+
/** @returns {GetSubscribedEmailTemplatesParam} */
|
|
585
|
+
static getSubscribedEmailTemplates() {
|
|
449
586
|
return Joi.object({
|
|
450
587
|
pageNo: Joi.number(),
|
|
451
588
|
pageSize: Joi.number(),
|
|
452
|
-
sort: Joi.any(),
|
|
453
589
|
}).required();
|
|
454
590
|
}
|
|
455
591
|
|
|
456
|
-
/** @returns {
|
|
457
|
-
static
|
|
592
|
+
/** @returns {GetSubscribedSmsTemplatesParam} */
|
|
593
|
+
static getSubscribedSmsTemplates() {
|
|
458
594
|
return Joi.object({
|
|
459
595
|
pageNo: Joi.number(),
|
|
460
596
|
pageSize: Joi.number(),
|
|
461
|
-
|
|
597
|
+
}).required();
|
|
598
|
+
}
|
|
599
|
+
|
|
600
|
+
/** @returns {GetSystemAudiencesParam} */
|
|
601
|
+
static getSystemAudiences() {
|
|
602
|
+
return Joi.object({}).required();
|
|
603
|
+
}
|
|
604
|
+
|
|
605
|
+
/** @returns {GetSystemEmailTemplatesParam} */
|
|
606
|
+
static getSystemEmailTemplates() {
|
|
607
|
+
return Joi.object({}).required();
|
|
608
|
+
}
|
|
609
|
+
|
|
610
|
+
/** @returns {GetSystemSmsTemplatesParam} */
|
|
611
|
+
static getSystemSmsTemplates() {
|
|
612
|
+
return Joi.object({}).required();
|
|
613
|
+
}
|
|
614
|
+
|
|
615
|
+
/** @returns {PostGlobalVariablesParam} */
|
|
616
|
+
static postGlobalVariables() {
|
|
617
|
+
return Joi.object({
|
|
618
|
+
body: CommunicationPlatformModel.GlobalVariablesReq().required(),
|
|
462
619
|
}).required();
|
|
463
620
|
}
|
|
464
621
|
|
|
@@ -490,6 +647,13 @@ class CommunicationPlatformApplicationValidator {
|
|
|
490
647
|
}).required();
|
|
491
648
|
}
|
|
492
649
|
|
|
650
|
+
/** @returns {UpdateAppProvidersParam} */
|
|
651
|
+
static updateAppProviders() {
|
|
652
|
+
return Joi.object({
|
|
653
|
+
body: CommunicationPlatformModel.AppProviderReq().required(),
|
|
654
|
+
}).required();
|
|
655
|
+
}
|
|
656
|
+
|
|
493
657
|
/** @returns {UpdateAudienceByIdParam} */
|
|
494
658
|
static updateAudienceById() {
|
|
495
659
|
return Joi.object({
|