@gofynd/fdk-client-javascript 1.3.11-beta.7 → 1.4.0-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +1 -1
- package/sdk/application/Cart/CartApplicationClient.js +5 -3
- package/sdk/application/Cart/CartApplicationModel.d.ts +107 -1
- package/sdk/application/Cart/CartApplicationModel.js +74 -0
- package/sdk/application/Cart/CartApplicationValidator.d.ts +4 -0
- package/sdk/application/Cart/CartApplicationValidator.js +4 -0
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +3 -6
- package/sdk/application/Catalog/CatalogApplicationClient.js +7 -20
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +2 -2
- package/sdk/application/Catalog/CatalogApplicationModel.js +2 -2
- package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +0 -14
- package/sdk/application/Catalog/CatalogApplicationValidator.js +0 -6
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +183 -49
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +173 -31
- package/sdk/application/Content/ContentApplicationClient.d.ts +36 -0
- package/sdk/application/Content/ContentApplicationClient.js +246 -0
- package/sdk/application/Content/ContentApplicationModel.d.ts +208 -1
- package/sdk/application/Content/ContentApplicationModel.js +252 -0
- package/sdk/application/Content/ContentApplicationValidator.d.ts +40 -1
- package/sdk/application/Content/ContentApplicationValidator.js +41 -0
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +67 -0
- package/sdk/application/Logistic/LogisticApplicationClient.js +547 -0
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +456 -1
- package/sdk/application/Logistic/LogisticApplicationModel.js +488 -0
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +211 -1
- package/sdk/application/Logistic/LogisticApplicationValidator.js +131 -0
- package/sdk/application/Order/OrderApplicationClient.d.ts +3 -3
- package/sdk/application/Order/OrderApplicationClient.js +32 -8
- package/sdk/application/Order/OrderApplicationModel.d.ts +6 -0
- package/sdk/application/Order/OrderApplicationModel.js +6 -0
- package/sdk/application/Order/OrderApplicationValidator.d.ts +20 -0
- package/sdk/application/Order/OrderApplicationValidator.js +8 -0
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +46 -2
- package/sdk/application/Payment/PaymentApplicationClient.js +341 -10
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +493 -186
- package/sdk/application/Payment/PaymentApplicationModel.js +341 -70
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +59 -14
- package/sdk/application/Payment/PaymentApplicationValidator.js +64 -10
- package/sdk/application/PosCart/PosCartApplicationModel.d.ts +34 -1
- package/sdk/application/PosCart/PosCartApplicationModel.js +24 -0
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +1 -1
- package/sdk/application/Theme/ThemeApplicationClient.js +7 -3
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +222 -36
- package/sdk/application/Theme/ThemeApplicationModel.js +322 -26
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +10 -0
- package/sdk/application/Theme/ThemeApplicationValidator.js +4 -0
- package/sdk/application/User/UserApplicationClient.d.ts +33 -0
- package/sdk/application/User/UserApplicationClient.js +239 -0
- package/sdk/application/User/UserApplicationModel.d.ts +28 -13
- package/sdk/application/User/UserApplicationModel.js +36 -12
- package/sdk/application/User/UserApplicationValidator.d.ts +34 -1
- package/sdk/application/User/UserApplicationValidator.js +36 -0
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +3 -15
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +2 -14
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +125 -0
- package/sdk/partner/Lead/LeadPartnerClient.js +785 -0
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +1127 -0
- package/sdk/partner/Lead/LeadPartnerModel.js +896 -0
- package/sdk/partner/Lead/LeadPartnerValidator.d.ts +12 -0
- package/sdk/partner/Lead/LeadPartnerValidator.js +67 -0
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +155 -0
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +1195 -0
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +372 -0
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +442 -0
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +16 -0
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +123 -0
- package/sdk/partner/PartnerClient.d.ts +6 -0
- package/sdk/partner/PartnerClient.js +9 -0
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +10 -0
- package/sdk/partner/Theme/ThemePartnerClient.js +80 -0
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +100 -43
- package/sdk/partner/Theme/ThemePartnerModel.js +74 -30
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +1 -0
- package/sdk/partner/Theme/ThemePartnerValidator.js +9 -0
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +99 -0
- package/sdk/partner/Webhook/WebhookPartnerClient.js +753 -0
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +566 -0
- package/sdk/partner/Webhook/WebhookPartnerModel.js +583 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +12 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +74 -0
- package/sdk/partner/index.d.ts +3 -0
- package/sdk/partner/index.js +6 -0
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +2 -2
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +11 -1
- package/sdk/platform/Billing/BillingPlatformClient.js +110 -3
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +67 -1
- package/sdk/platform/Billing/BillingPlatformModel.js +78 -0
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +43 -4
- package/sdk/platform/Billing/BillingPlatformValidator.js +29 -2
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +7 -1
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +4 -0
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +4 -0
- package/sdk/platform/Cart/CartPlatformModel.d.ts +100 -5
- package/sdk/platform/Cart/CartPlatformModel.js +71 -4
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +15 -11
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +52 -21
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +27 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +11 -0
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +26 -4
- package/sdk/platform/Catalog/CatalogPlatformClient.js +173 -7
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +304 -1
- package/sdk/platform/Catalog/CatalogPlatformModel.js +335 -0
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +31 -3
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +27 -2
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +138 -36
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +739 -57
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +128 -3
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +111 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +150 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.js +172 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +8 -2
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +32 -4
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +38 -9
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +42 -8
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +14 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +6 -0
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +8 -8
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +4 -4
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +371 -132
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +288 -77
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +2 -2
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +2 -2
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +391 -0
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +3641 -1059
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +351 -1
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +410 -0
- package/sdk/platform/Content/ContentPlatformClient.d.ts +277 -0
- package/sdk/platform/Content/ContentPlatformClient.js +2011 -0
- package/sdk/platform/Content/ContentPlatformModel.d.ts +1100 -1
- package/sdk/platform/Content/ContentPlatformModel.js +1362 -46
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +247 -0
- package/sdk/platform/Content/ContentPlatformValidator.js +319 -0
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformClient.js +2 -2
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +96 -13
- package/sdk/platform/Discount/DiscountPlatformModel.js +104 -12
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +16 -6
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +117 -8
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +55 -4
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +39 -2
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +18 -19
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +20 -18
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +33 -0
- package/sdk/platform/Finance/FinancePlatformClient.js +240 -0
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +151 -5
- package/sdk/platform/Finance/FinancePlatformModel.js +190 -4
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +38 -1
- package/sdk/platform/Finance/FinancePlatformValidator.js +38 -0
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +38 -28
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +137 -56
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +41 -29
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +33 -21
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +12 -3
- package/sdk/platform/Lead/LeadPlatformModel.js +16 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +23 -1
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +178 -1
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +39 -1
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +32 -0
- package/sdk/platform/Order/OrderPlatformClient.d.ts +202 -31
- package/sdk/platform/Order/OrderPlatformClient.js +2010 -586
- package/sdk/platform/Order/OrderPlatformModel.d.ts +1032 -470
- package/sdk/platform/Order/OrderPlatformModel.js +1187 -534
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +318 -35
- package/sdk/platform/Order/OrderPlatformValidator.js +292 -29
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +119 -13
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +749 -39
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +143 -7
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +133 -6
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +1 -1
- package/sdk/platform/Payment/PaymentPlatformClient.js +1 -1
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +996 -134
- package/sdk/platform/Payment/PaymentPlatformModel.js +721 -58
- package/sdk/platform/PlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/PlatformApplicationClient.js +4 -4
- package/sdk/platform/PlatformClient.d.ts +4 -2
- package/sdk/platform/PlatformClient.js +8 -4
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +142 -66
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +645 -147
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +131 -63
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +126 -47
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +217 -105
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +1136 -347
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +912 -313
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1071 -355
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +382 -133
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +266 -102
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +11 -1
- package/sdk/platform/Theme/ThemePlatformClient.js +87 -3
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +333 -47
- package/sdk/platform/Theme/ThemePlatformModel.js +395 -35
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +28 -4
- package/sdk/platform/Theme/ThemePlatformValidator.js +21 -2
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +116 -1
- package/sdk/platform/User/UserPlatformApplicationClient.js +931 -85
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +224 -7
- package/sdk/platform/User/UserPlatformApplicationValidator.js +173 -5
- package/sdk/platform/User/UserPlatformModel.d.ts +344 -7
- package/sdk/platform/User/UserPlatformModel.js +256 -5
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +47 -39
- package/sdk/platform/Webhook/WebhookPlatformClient.js +63 -61
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +264 -156
- package/sdk/platform/Webhook/WebhookPlatformModel.js +276 -153
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +7 -10
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +6 -6
- package/sdk/platform/index.d.ts +1 -1
- package/sdk/platform/index.js +2 -2
- package/sdk/public/Billing/BillingPublicClient.d.ts +23 -0
- package/sdk/public/Billing/BillingPublicClient.js +116 -0
- package/sdk/public/Billing/BillingPublicModel.d.ts +92 -0
- package/sdk/public/Billing/BillingPublicModel.js +96 -0
- package/sdk/public/Billing/BillingPublicValidator.d.ts +18 -0
- package/sdk/public/Billing/BillingPublicValidator.js +19 -0
- package/sdk/public/Content/ContentPublicClient.d.ts +22 -0
- package/sdk/public/Content/ContentPublicClient.js +114 -0
- package/sdk/public/Content/ContentPublicModel.d.ts +53 -0
- package/sdk/public/Content/ContentPublicModel.js +60 -0
- package/sdk/public/Content/ContentPublicValidator.d.ts +18 -0
- package/sdk/public/Content/ContentPublicValidator.js +19 -0
- package/sdk/public/PublicClient.d.ts +4 -0
- package/sdk/public/PublicClient.js +8 -0
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +33 -0
- package/sdk/public/Webhook/WebhookPublicClient.js +242 -0
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +147 -1
- package/sdk/public/Webhook/WebhookPublicModel.js +177 -1
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +23 -1
- package/sdk/public/Webhook/WebhookPublicValidator.js +31 -0
- package/sdk/public/index.d.ts +2 -0
- package/sdk/public/index.js +4 -0
|
@@ -18,6 +18,18 @@ export = CommunicationPlatformApplicationValidator;
|
|
|
18
18
|
* @typedef CreateEmailTemplateParam
|
|
19
19
|
* @property {CommunicationPlatformModel.EmailTemplateReq} body
|
|
20
20
|
*/
|
|
21
|
+
/**
|
|
22
|
+
* @typedef CreateEventSubscriptionsParam
|
|
23
|
+
* @property {CommunicationPlatformModel.SubscriptionsObject} body
|
|
24
|
+
*/
|
|
25
|
+
/**
|
|
26
|
+
* @typedef CreateEventSubscriptionsByBulkParam
|
|
27
|
+
* @property {CommunicationPlatformModel.EventSubscriptionsBulkUpdateRequest} body
|
|
28
|
+
*/
|
|
29
|
+
/**
|
|
30
|
+
* @typedef CreateJobsParam
|
|
31
|
+
* @property {CommunicationPlatformModel.CreateJobsReq} body
|
|
32
|
+
*/
|
|
21
33
|
/**
|
|
22
34
|
* @typedef CreateSmsProviderParam
|
|
23
35
|
* @property {CommunicationPlatformModel.SmsProviderReq} body
|
|
@@ -29,6 +41,7 @@ export = CommunicationPlatformApplicationValidator;
|
|
|
29
41
|
/**
|
|
30
42
|
* @typedef DeleteAudienceByIdParam
|
|
31
43
|
* @property {string} id - Audience id
|
|
44
|
+
* @property {CommunicationPlatformModel.AudienceReq} body
|
|
32
45
|
*/
|
|
33
46
|
/**
|
|
34
47
|
* @typedef DeleteEmailProviderByIdParam
|
|
@@ -38,6 +51,10 @@ export = CommunicationPlatformApplicationValidator;
|
|
|
38
51
|
* @typedef DeleteEmailTemplateByIdParam
|
|
39
52
|
* @property {string} id - Email template id
|
|
40
53
|
*/
|
|
54
|
+
/**
|
|
55
|
+
* @typedef DeleteEventSubscriptionsByIdParam
|
|
56
|
+
* @property {string} id - Event subscription id
|
|
57
|
+
*/
|
|
41
58
|
/**
|
|
42
59
|
* @typedef DeleteSmsProviderByIdParam
|
|
43
60
|
* @property {string} id - Sms provider id
|
|
@@ -46,6 +63,11 @@ export = CommunicationPlatformApplicationValidator;
|
|
|
46
63
|
* @typedef DeleteSmsTemplateByIdParam
|
|
47
64
|
* @property {string} id - Sms template id
|
|
48
65
|
*/
|
|
66
|
+
/**
|
|
67
|
+
* @typedef EditEventSubscriptionsParam
|
|
68
|
+
* @property {string} id - Event subscription id
|
|
69
|
+
* @property {CommunicationPlatformModel.SubscriptionsObject} body
|
|
70
|
+
*/
|
|
49
71
|
/** @typedef GetAppProvidersParam */
|
|
50
72
|
/**
|
|
51
73
|
* @typedef GetAudienceByIdParam
|
|
@@ -56,6 +78,7 @@ export = CommunicationPlatformApplicationValidator;
|
|
|
56
78
|
* @property {number} [pageNo] - Current page no
|
|
57
79
|
* @property {number} [pageSize] - Current request items count
|
|
58
80
|
* @property {Object} [sort] - To sort based on created_at
|
|
81
|
+
* @property {Object} [query] - To search based on plain text
|
|
59
82
|
*/
|
|
60
83
|
/**
|
|
61
84
|
* @typedef GetBigQueryHeadersByIdParam
|
|
@@ -71,6 +94,7 @@ export = CommunicationPlatformApplicationValidator;
|
|
|
71
94
|
*/
|
|
72
95
|
/**
|
|
73
96
|
* @typedef GetCampaignsParam
|
|
97
|
+
* @property {Object} [query] - To search based on plain text
|
|
74
98
|
* @property {number} [pageNo] - Current page no
|
|
75
99
|
* @property {number} [pageSize] - Current request items count
|
|
76
100
|
* @property {Object} [sort] - To sort based on created_at
|
|
@@ -97,6 +121,7 @@ export = CommunicationPlatformApplicationValidator;
|
|
|
97
121
|
* @property {number} [pageNo] - Current page no
|
|
98
122
|
* @property {number} [pageSize] - Current request items count
|
|
99
123
|
* @property {Object} [sort] - To sort based on created_at
|
|
124
|
+
* @property {Object} [query] - To search based on plain text
|
|
100
125
|
*/
|
|
101
126
|
/**
|
|
102
127
|
* @typedef GetEmailTemplateByIdParam
|
|
@@ -107,12 +132,18 @@ export = CommunicationPlatformApplicationValidator;
|
|
|
107
132
|
* @property {number} [pageNo] - Current page no
|
|
108
133
|
* @property {number} [pageSize] - Current request items count
|
|
109
134
|
* @property {Object} [sort] - To sort based on created_at
|
|
135
|
+
* @property {Object} [query] - To search based on plain text
|
|
110
136
|
*/
|
|
111
137
|
/**
|
|
112
138
|
* @typedef GetEventSubscriptionsParam
|
|
113
139
|
* @property {number} [pageNo] - Current page no
|
|
114
140
|
* @property {number} [pageSize] - Current request items count
|
|
115
|
-
* @property {string} [populate] - Populate
|
|
141
|
+
* @property {string} [populate] - Populate Fields
|
|
142
|
+
*/
|
|
143
|
+
/**
|
|
144
|
+
* @typedef GetEventSubscriptionsByIdParam
|
|
145
|
+
* @property {string} id - Event subscription id
|
|
146
|
+
* @property {string} [populate] - Populate Fields
|
|
116
147
|
*/
|
|
117
148
|
/** @typedef GetGlobalProvidersParam */
|
|
118
149
|
/** @typedef GetGlobalVariablesParam */
|
|
@@ -121,18 +152,21 @@ export = CommunicationPlatformApplicationValidator;
|
|
|
121
152
|
* @property {number} [pageNo] - Current page no
|
|
122
153
|
* @property {number} [pageSize] - Current request items count
|
|
123
154
|
* @property {Object} [sort] - To sort based on created_at
|
|
155
|
+
* @property {Object} [query] - To search based on plain text
|
|
124
156
|
*/
|
|
125
157
|
/**
|
|
126
158
|
* @typedef GetJobsParam
|
|
127
159
|
* @property {number} [pageNo] - Current page no
|
|
128
160
|
* @property {number} [pageSize] - Current request items count
|
|
129
161
|
* @property {Object} [sort] - To sort based on created_at
|
|
162
|
+
* @property {Object} [query] - To search based on plain text
|
|
130
163
|
*/
|
|
131
164
|
/**
|
|
132
165
|
* @typedef GetNSampleRecordsFromCsvParam
|
|
133
166
|
* @property {CommunicationPlatformModel.GetNRecordsCsvReq} body
|
|
134
167
|
*/
|
|
135
168
|
/** @typedef GetNSampleRecordsFromCsvByGetParam */
|
|
169
|
+
/** @typedef GetOtpConfigurationParam */
|
|
136
170
|
/**
|
|
137
171
|
* @typedef GetSmsProviderByIdParam
|
|
138
172
|
* @property {string} id - Sms provider id
|
|
@@ -152,6 +186,7 @@ export = CommunicationPlatformApplicationValidator;
|
|
|
152
186
|
* @property {number} [pageNo] - Current page no
|
|
153
187
|
* @property {number} [pageSize] - Current request items count
|
|
154
188
|
* @property {Object} [sort] - To sort based on created_at
|
|
189
|
+
* @property {Object} [query] - To search based on plain text
|
|
155
190
|
*/
|
|
156
191
|
/**
|
|
157
192
|
* @typedef GetStatsOfCampaignByIdParam
|
|
@@ -161,11 +196,13 @@ export = CommunicationPlatformApplicationValidator;
|
|
|
161
196
|
* @typedef GetSubscribedEmailTemplatesParam
|
|
162
197
|
* @property {number} [pageNo] - Current page no
|
|
163
198
|
* @property {number} [pageSize] - Current request items count
|
|
199
|
+
* @property {Object} [query] - To search based on plain text
|
|
164
200
|
*/
|
|
165
201
|
/**
|
|
166
202
|
* @typedef GetSubscribedSmsTemplatesParam
|
|
167
203
|
* @property {number} [pageNo] - Current page no
|
|
168
204
|
* @property {number} [pageSize] - Current request items count
|
|
205
|
+
* @property {Object} [query] - To search based on plain text
|
|
169
206
|
*/
|
|
170
207
|
/** @typedef GetSystemAudiencesParam */
|
|
171
208
|
/** @typedef GetSystemEmailTemplatesParam */
|
|
@@ -214,6 +251,7 @@ export = CommunicationPlatformApplicationValidator;
|
|
|
214
251
|
* @property {string} id - Email template id
|
|
215
252
|
* @property {CommunicationPlatformModel.EmailTemplateReq} body
|
|
216
253
|
*/
|
|
254
|
+
/** @typedef UpdateOtpConfigurationParam */
|
|
217
255
|
/**
|
|
218
256
|
* @typedef UpdateSmsProviderByIdParam
|
|
219
257
|
* @property {string} id - Sms provider id
|
|
@@ -243,6 +281,12 @@ declare class CommunicationPlatformApplicationValidator {
|
|
|
243
281
|
static createEmailProvider(): CreateEmailProviderParam;
|
|
244
282
|
/** @returns {CreateEmailTemplateParam} */
|
|
245
283
|
static createEmailTemplate(): CreateEmailTemplateParam;
|
|
284
|
+
/** @returns {CreateEventSubscriptionsParam} */
|
|
285
|
+
static createEventSubscriptions(): CreateEventSubscriptionsParam;
|
|
286
|
+
/** @returns {CreateEventSubscriptionsByBulkParam} */
|
|
287
|
+
static createEventSubscriptionsByBulk(): CreateEventSubscriptionsByBulkParam;
|
|
288
|
+
/** @returns {CreateJobsParam} */
|
|
289
|
+
static createJobs(): CreateJobsParam;
|
|
246
290
|
/** @returns {CreateSmsProviderParam} */
|
|
247
291
|
static createSmsProvider(): CreateSmsProviderParam;
|
|
248
292
|
/** @returns {CreateSmsTemplateParam} */
|
|
@@ -253,10 +297,14 @@ declare class CommunicationPlatformApplicationValidator {
|
|
|
253
297
|
static deleteEmailProviderById(): DeleteEmailProviderByIdParam;
|
|
254
298
|
/** @returns {DeleteEmailTemplateByIdParam} */
|
|
255
299
|
static deleteEmailTemplateById(): DeleteEmailTemplateByIdParam;
|
|
300
|
+
/** @returns {DeleteEventSubscriptionsByIdParam} */
|
|
301
|
+
static deleteEventSubscriptionsById(): DeleteEventSubscriptionsByIdParam;
|
|
256
302
|
/** @returns {DeleteSmsProviderByIdParam} */
|
|
257
303
|
static deleteSmsProviderById(): DeleteSmsProviderByIdParam;
|
|
258
304
|
/** @returns {DeleteSmsTemplateByIdParam} */
|
|
259
305
|
static deleteSmsTemplateById(): DeleteSmsTemplateByIdParam;
|
|
306
|
+
/** @returns {EditEventSubscriptionsParam} */
|
|
307
|
+
static editEventSubscriptions(): EditEventSubscriptionsParam;
|
|
260
308
|
/** @returns {GetAppProvidersParam} */
|
|
261
309
|
static getAppProviders(): any;
|
|
262
310
|
/** @returns {GetAudienceByIdParam} */
|
|
@@ -289,6 +337,8 @@ declare class CommunicationPlatformApplicationValidator {
|
|
|
289
337
|
static getEmailTemplates(): GetEmailTemplatesParam;
|
|
290
338
|
/** @returns {GetEventSubscriptionsParam} */
|
|
291
339
|
static getEventSubscriptions(): GetEventSubscriptionsParam;
|
|
340
|
+
/** @returns {GetEventSubscriptionsByIdParam} */
|
|
341
|
+
static getEventSubscriptionsById(): GetEventSubscriptionsByIdParam;
|
|
292
342
|
/** @returns {GetGlobalProvidersParam} */
|
|
293
343
|
static getGlobalProviders(): any;
|
|
294
344
|
/** @returns {GetGlobalVariablesParam} */
|
|
@@ -301,6 +351,8 @@ declare class CommunicationPlatformApplicationValidator {
|
|
|
301
351
|
static getNSampleRecordsFromCsv(): GetNSampleRecordsFromCsvParam;
|
|
302
352
|
/** @returns {GetNSampleRecordsFromCsvByGetParam} */
|
|
303
353
|
static getNSampleRecordsFromCsvByGet(): any;
|
|
354
|
+
/** @returns {GetOtpConfigurationParam} */
|
|
355
|
+
static getOtpConfiguration(): any;
|
|
304
356
|
/** @returns {GetSmsProviderByIdParam} */
|
|
305
357
|
static getSmsProviderById(): GetSmsProviderByIdParam;
|
|
306
358
|
/** @returns {GetSmsProvidersParam} */
|
|
@@ -341,6 +393,8 @@ declare class CommunicationPlatformApplicationValidator {
|
|
|
341
393
|
static updateEmailProviderById(): UpdateEmailProviderByIdParam;
|
|
342
394
|
/** @returns {UpdateEmailTemplateByIdParam} */
|
|
343
395
|
static updateEmailTemplateById(): UpdateEmailTemplateByIdParam;
|
|
396
|
+
/** @returns {UpdateOtpConfigurationParam} */
|
|
397
|
+
static updateOtpConfiguration(): any;
|
|
344
398
|
/** @returns {UpdateSmsProviderByIdParam} */
|
|
345
399
|
static updateSmsProviderById(): UpdateSmsProviderByIdParam;
|
|
346
400
|
/** @returns {UpdateSmsTemplateByIdParam} */
|
|
@@ -349,7 +403,7 @@ declare class CommunicationPlatformApplicationValidator {
|
|
|
349
403
|
static verfiyOtp(): VerfiyOtpParam;
|
|
350
404
|
}
|
|
351
405
|
declare namespace CommunicationPlatformApplicationValidator {
|
|
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 };
|
|
406
|
+
export { CreateAudienceParam, CreateBigQueryHeadersParam, CreateBigQueryNCountParam, CreateBigQueryRowCountParam, CreateCampaignParam, CreateEmailProviderParam, CreateEmailTemplateParam, CreateEventSubscriptionsParam, CreateEventSubscriptionsByBulkParam, CreateJobsParam, CreateSmsProviderParam, CreateSmsTemplateParam, DeleteAudienceByIdParam, DeleteEmailProviderByIdParam, DeleteEmailTemplateByIdParam, DeleteEventSubscriptionsByIdParam, DeleteSmsProviderByIdParam, DeleteSmsTemplateByIdParam, EditEventSubscriptionsParam, GetAppProvidersParam, GetAudienceByIdParam, GetAudiencesParam, GetBigQueryHeadersByIdParam, GetBigQueryRowCountByIdParam, GetCampaignByIdParam, GetCampaignsParam, GetCommunicationLogsParam, GetDefaultSmsProvidersParam, GetDummyDatasourcesParam, GetDummyDatasourcesMetaParam, GetEmailProviderByIdParam, GetEmailProvidersParam, GetEmailTemplateByIdParam, GetEmailTemplatesParam, GetEventSubscriptionsParam, GetEventSubscriptionsByIdParam, GetGlobalProvidersParam, GetGlobalVariablesParam, GetJobLogsParam, GetJobsParam, GetNSampleRecordsFromCsvParam, GetNSampleRecordsFromCsvByGetParam, GetOtpConfigurationParam, GetSmsProviderByIdParam, GetSmsProvidersParam, GetSmsTemplateByIdParam, GetSmsTemplatesParam, GetStatsOfCampaignByIdParam, GetSubscribedEmailTemplatesParam, GetSubscribedSmsTemplatesParam, GetSystemAudiencesParam, GetSystemEmailTemplatesParam, GetSystemSmsTemplatesParam, PostGlobalVariablesParam, SendCommunicationAsynchronouslyParam, SendCommunicationSynchronouslyParam, SendOtpParam, TriggerCampaignJobParam, UpdateAppProvidersParam, UpdateAudienceByIdParam, UpdateCampaignByIdParam, UpdateEmailProviderByIdParam, UpdateEmailTemplateByIdParam, UpdateOtpConfigurationParam, UpdateSmsProviderByIdParam, UpdateSmsTemplateByIdParam, VerfiyOtpParam };
|
|
353
407
|
}
|
|
354
408
|
type CreateAudienceParam = {
|
|
355
409
|
body: CommunicationPlatformModel.AudienceReq;
|
|
@@ -363,6 +417,15 @@ type CreateEmailProviderParam = {
|
|
|
363
417
|
type CreateEmailTemplateParam = {
|
|
364
418
|
body: CommunicationPlatformModel.EmailTemplateReq;
|
|
365
419
|
};
|
|
420
|
+
type CreateEventSubscriptionsParam = {
|
|
421
|
+
body: CommunicationPlatformModel.SubscriptionsObject;
|
|
422
|
+
};
|
|
423
|
+
type CreateEventSubscriptionsByBulkParam = {
|
|
424
|
+
body: CommunicationPlatformModel.EventSubscriptionsBulkUpdateRequest;
|
|
425
|
+
};
|
|
426
|
+
type CreateJobsParam = {
|
|
427
|
+
body: CommunicationPlatformModel.CreateJobsReq;
|
|
428
|
+
};
|
|
366
429
|
type CreateSmsProviderParam = {
|
|
367
430
|
body: CommunicationPlatformModel.SmsProviderReq;
|
|
368
431
|
};
|
|
@@ -374,6 +437,7 @@ type DeleteAudienceByIdParam = {
|
|
|
374
437
|
* - Audience id
|
|
375
438
|
*/
|
|
376
439
|
id: string;
|
|
440
|
+
body: CommunicationPlatformModel.AudienceReq;
|
|
377
441
|
};
|
|
378
442
|
type DeleteEmailProviderByIdParam = {
|
|
379
443
|
/**
|
|
@@ -387,6 +451,12 @@ type DeleteEmailTemplateByIdParam = {
|
|
|
387
451
|
*/
|
|
388
452
|
id: string;
|
|
389
453
|
};
|
|
454
|
+
type DeleteEventSubscriptionsByIdParam = {
|
|
455
|
+
/**
|
|
456
|
+
* - Event subscription id
|
|
457
|
+
*/
|
|
458
|
+
id: string;
|
|
459
|
+
};
|
|
390
460
|
type DeleteSmsProviderByIdParam = {
|
|
391
461
|
/**
|
|
392
462
|
* - Sms provider id
|
|
@@ -399,6 +469,13 @@ type DeleteSmsTemplateByIdParam = {
|
|
|
399
469
|
*/
|
|
400
470
|
id: string;
|
|
401
471
|
};
|
|
472
|
+
type EditEventSubscriptionsParam = {
|
|
473
|
+
/**
|
|
474
|
+
* - Event subscription id
|
|
475
|
+
*/
|
|
476
|
+
id: string;
|
|
477
|
+
body: CommunicationPlatformModel.SubscriptionsObject;
|
|
478
|
+
};
|
|
402
479
|
type GetAudienceByIdParam = {
|
|
403
480
|
/**
|
|
404
481
|
* - Audience id
|
|
@@ -418,6 +495,10 @@ type GetAudiencesParam = {
|
|
|
418
495
|
* - To sort based on created_at
|
|
419
496
|
*/
|
|
420
497
|
sort?: any;
|
|
498
|
+
/**
|
|
499
|
+
* - To search based on plain text
|
|
500
|
+
*/
|
|
501
|
+
query?: any;
|
|
421
502
|
};
|
|
422
503
|
type GetBigQueryHeadersByIdParam = {
|
|
423
504
|
/**
|
|
@@ -438,6 +519,10 @@ type GetCampaignByIdParam = {
|
|
|
438
519
|
id: string;
|
|
439
520
|
};
|
|
440
521
|
type GetCampaignsParam = {
|
|
522
|
+
/**
|
|
523
|
+
* - To search based on plain text
|
|
524
|
+
*/
|
|
525
|
+
query?: any;
|
|
441
526
|
/**
|
|
442
527
|
* - Current page no
|
|
443
528
|
*/
|
|
@@ -491,6 +576,10 @@ type GetEmailProvidersParam = {
|
|
|
491
576
|
* - To sort based on created_at
|
|
492
577
|
*/
|
|
493
578
|
sort?: any;
|
|
579
|
+
/**
|
|
580
|
+
* - To search based on plain text
|
|
581
|
+
*/
|
|
582
|
+
query?: any;
|
|
494
583
|
};
|
|
495
584
|
type GetEmailTemplateByIdParam = {
|
|
496
585
|
/**
|
|
@@ -511,6 +600,10 @@ type GetEmailTemplatesParam = {
|
|
|
511
600
|
* - To sort based on created_at
|
|
512
601
|
*/
|
|
513
602
|
sort?: any;
|
|
603
|
+
/**
|
|
604
|
+
* - To search based on plain text
|
|
605
|
+
*/
|
|
606
|
+
query?: any;
|
|
514
607
|
};
|
|
515
608
|
type GetEventSubscriptionsParam = {
|
|
516
609
|
/**
|
|
@@ -522,7 +615,17 @@ type GetEventSubscriptionsParam = {
|
|
|
522
615
|
*/
|
|
523
616
|
pageSize?: number;
|
|
524
617
|
/**
|
|
525
|
-
* - Populate
|
|
618
|
+
* - Populate Fields
|
|
619
|
+
*/
|
|
620
|
+
populate?: string;
|
|
621
|
+
};
|
|
622
|
+
type GetEventSubscriptionsByIdParam = {
|
|
623
|
+
/**
|
|
624
|
+
* - Event subscription id
|
|
625
|
+
*/
|
|
626
|
+
id: string;
|
|
627
|
+
/**
|
|
628
|
+
* - Populate Fields
|
|
526
629
|
*/
|
|
527
630
|
populate?: string;
|
|
528
631
|
};
|
|
@@ -539,6 +642,10 @@ type GetJobLogsParam = {
|
|
|
539
642
|
* - To sort based on created_at
|
|
540
643
|
*/
|
|
541
644
|
sort?: any;
|
|
645
|
+
/**
|
|
646
|
+
* - To search based on plain text
|
|
647
|
+
*/
|
|
648
|
+
query?: any;
|
|
542
649
|
};
|
|
543
650
|
type GetJobsParam = {
|
|
544
651
|
/**
|
|
@@ -553,6 +660,10 @@ type GetJobsParam = {
|
|
|
553
660
|
* - To sort based on created_at
|
|
554
661
|
*/
|
|
555
662
|
sort?: any;
|
|
663
|
+
/**
|
|
664
|
+
* - To search based on plain text
|
|
665
|
+
*/
|
|
666
|
+
query?: any;
|
|
556
667
|
};
|
|
557
668
|
type GetNSampleRecordsFromCsvParam = {
|
|
558
669
|
body: CommunicationPlatformModel.GetNRecordsCsvReq;
|
|
@@ -596,6 +707,10 @@ type GetSmsTemplatesParam = {
|
|
|
596
707
|
* - To sort based on created_at
|
|
597
708
|
*/
|
|
598
709
|
sort?: any;
|
|
710
|
+
/**
|
|
711
|
+
* - To search based on plain text
|
|
712
|
+
*/
|
|
713
|
+
query?: any;
|
|
599
714
|
};
|
|
600
715
|
type GetStatsOfCampaignByIdParam = {
|
|
601
716
|
/**
|
|
@@ -612,6 +727,10 @@ type GetSubscribedEmailTemplatesParam = {
|
|
|
612
727
|
* - Current request items count
|
|
613
728
|
*/
|
|
614
729
|
pageSize?: number;
|
|
730
|
+
/**
|
|
731
|
+
* - To search based on plain text
|
|
732
|
+
*/
|
|
733
|
+
query?: any;
|
|
615
734
|
};
|
|
616
735
|
type GetSubscribedSmsTemplatesParam = {
|
|
617
736
|
/**
|
|
@@ -622,6 +741,10 @@ type GetSubscribedSmsTemplatesParam = {
|
|
|
622
741
|
* - Current request items count
|
|
623
742
|
*/
|
|
624
743
|
pageSize?: number;
|
|
744
|
+
/**
|
|
745
|
+
* - To search based on plain text
|
|
746
|
+
*/
|
|
747
|
+
query?: any;
|
|
625
748
|
};
|
|
626
749
|
type PostGlobalVariablesParam = {
|
|
627
750
|
body: CommunicationPlatformModel.GlobalVariablesReq;
|
|
@@ -695,7 +818,9 @@ type GetDummyDatasourcesParam = any;
|
|
|
695
818
|
type GetGlobalProvidersParam = any;
|
|
696
819
|
type GetGlobalVariablesParam = any;
|
|
697
820
|
type GetNSampleRecordsFromCsvByGetParam = any;
|
|
821
|
+
type GetOtpConfigurationParam = any;
|
|
698
822
|
type GetSystemAudiencesParam = any;
|
|
699
823
|
type GetSystemEmailTemplatesParam = any;
|
|
700
824
|
type GetSystemSmsTemplatesParam = any;
|
|
825
|
+
type UpdateOtpConfigurationParam = any;
|
|
701
826
|
import CommunicationPlatformModel = require("./CommunicationPlatformModel");
|
|
@@ -28,6 +28,21 @@ const CommunicationPlatformModel = require("./CommunicationPlatformModel");
|
|
|
28
28
|
* @property {CommunicationPlatformModel.EmailTemplateReq} body
|
|
29
29
|
*/
|
|
30
30
|
|
|
31
|
+
/**
|
|
32
|
+
* @typedef CreateEventSubscriptionsParam
|
|
33
|
+
* @property {CommunicationPlatformModel.SubscriptionsObject} body
|
|
34
|
+
*/
|
|
35
|
+
|
|
36
|
+
/**
|
|
37
|
+
* @typedef CreateEventSubscriptionsByBulkParam
|
|
38
|
+
* @property {CommunicationPlatformModel.EventSubscriptionsBulkUpdateRequest} body
|
|
39
|
+
*/
|
|
40
|
+
|
|
41
|
+
/**
|
|
42
|
+
* @typedef CreateJobsParam
|
|
43
|
+
* @property {CommunicationPlatformModel.CreateJobsReq} body
|
|
44
|
+
*/
|
|
45
|
+
|
|
31
46
|
/**
|
|
32
47
|
* @typedef CreateSmsProviderParam
|
|
33
48
|
* @property {CommunicationPlatformModel.SmsProviderReq} body
|
|
@@ -41,6 +56,7 @@ const CommunicationPlatformModel = require("./CommunicationPlatformModel");
|
|
|
41
56
|
/**
|
|
42
57
|
* @typedef DeleteAudienceByIdParam
|
|
43
58
|
* @property {string} id - Audience id
|
|
59
|
+
* @property {CommunicationPlatformModel.AudienceReq} body
|
|
44
60
|
*/
|
|
45
61
|
|
|
46
62
|
/**
|
|
@@ -53,6 +69,11 @@ const CommunicationPlatformModel = require("./CommunicationPlatformModel");
|
|
|
53
69
|
* @property {string} id - Email template id
|
|
54
70
|
*/
|
|
55
71
|
|
|
72
|
+
/**
|
|
73
|
+
* @typedef DeleteEventSubscriptionsByIdParam
|
|
74
|
+
* @property {string} id - Event subscription id
|
|
75
|
+
*/
|
|
76
|
+
|
|
56
77
|
/**
|
|
57
78
|
* @typedef DeleteSmsProviderByIdParam
|
|
58
79
|
* @property {string} id - Sms provider id
|
|
@@ -63,6 +84,12 @@ const CommunicationPlatformModel = require("./CommunicationPlatformModel");
|
|
|
63
84
|
* @property {string} id - Sms template id
|
|
64
85
|
*/
|
|
65
86
|
|
|
87
|
+
/**
|
|
88
|
+
* @typedef EditEventSubscriptionsParam
|
|
89
|
+
* @property {string} id - Event subscription id
|
|
90
|
+
* @property {CommunicationPlatformModel.SubscriptionsObject} body
|
|
91
|
+
*/
|
|
92
|
+
|
|
66
93
|
/** @typedef GetAppProvidersParam */
|
|
67
94
|
|
|
68
95
|
/**
|
|
@@ -75,6 +102,7 @@ const CommunicationPlatformModel = require("./CommunicationPlatformModel");
|
|
|
75
102
|
* @property {number} [pageNo] - Current page no
|
|
76
103
|
* @property {number} [pageSize] - Current request items count
|
|
77
104
|
* @property {Object} [sort] - To sort based on created_at
|
|
105
|
+
* @property {Object} [query] - To search based on plain text
|
|
78
106
|
*/
|
|
79
107
|
|
|
80
108
|
/**
|
|
@@ -94,6 +122,7 @@ const CommunicationPlatformModel = require("./CommunicationPlatformModel");
|
|
|
94
122
|
|
|
95
123
|
/**
|
|
96
124
|
* @typedef GetCampaignsParam
|
|
125
|
+
* @property {Object} [query] - To search based on plain text
|
|
97
126
|
* @property {number} [pageNo] - Current page no
|
|
98
127
|
* @property {number} [pageSize] - Current request items count
|
|
99
128
|
* @property {Object} [sort] - To sort based on created_at
|
|
@@ -126,6 +155,7 @@ const CommunicationPlatformModel = require("./CommunicationPlatformModel");
|
|
|
126
155
|
* @property {number} [pageNo] - Current page no
|
|
127
156
|
* @property {number} [pageSize] - Current request items count
|
|
128
157
|
* @property {Object} [sort] - To sort based on created_at
|
|
158
|
+
* @property {Object} [query] - To search based on plain text
|
|
129
159
|
*/
|
|
130
160
|
|
|
131
161
|
/**
|
|
@@ -138,13 +168,20 @@ const CommunicationPlatformModel = require("./CommunicationPlatformModel");
|
|
|
138
168
|
* @property {number} [pageNo] - Current page no
|
|
139
169
|
* @property {number} [pageSize] - Current request items count
|
|
140
170
|
* @property {Object} [sort] - To sort based on created_at
|
|
171
|
+
* @property {Object} [query] - To search based on plain text
|
|
141
172
|
*/
|
|
142
173
|
|
|
143
174
|
/**
|
|
144
175
|
* @typedef GetEventSubscriptionsParam
|
|
145
176
|
* @property {number} [pageNo] - Current page no
|
|
146
177
|
* @property {number} [pageSize] - Current request items count
|
|
147
|
-
* @property {string} [populate] - Populate
|
|
178
|
+
* @property {string} [populate] - Populate Fields
|
|
179
|
+
*/
|
|
180
|
+
|
|
181
|
+
/**
|
|
182
|
+
* @typedef GetEventSubscriptionsByIdParam
|
|
183
|
+
* @property {string} id - Event subscription id
|
|
184
|
+
* @property {string} [populate] - Populate Fields
|
|
148
185
|
*/
|
|
149
186
|
|
|
150
187
|
/** @typedef GetGlobalProvidersParam */
|
|
@@ -156,6 +193,7 @@ const CommunicationPlatformModel = require("./CommunicationPlatformModel");
|
|
|
156
193
|
* @property {number} [pageNo] - Current page no
|
|
157
194
|
* @property {number} [pageSize] - Current request items count
|
|
158
195
|
* @property {Object} [sort] - To sort based on created_at
|
|
196
|
+
* @property {Object} [query] - To search based on plain text
|
|
159
197
|
*/
|
|
160
198
|
|
|
161
199
|
/**
|
|
@@ -163,6 +201,7 @@ const CommunicationPlatformModel = require("./CommunicationPlatformModel");
|
|
|
163
201
|
* @property {number} [pageNo] - Current page no
|
|
164
202
|
* @property {number} [pageSize] - Current request items count
|
|
165
203
|
* @property {Object} [sort] - To sort based on created_at
|
|
204
|
+
* @property {Object} [query] - To search based on plain text
|
|
166
205
|
*/
|
|
167
206
|
|
|
168
207
|
/**
|
|
@@ -172,6 +211,8 @@ const CommunicationPlatformModel = require("./CommunicationPlatformModel");
|
|
|
172
211
|
|
|
173
212
|
/** @typedef GetNSampleRecordsFromCsvByGetParam */
|
|
174
213
|
|
|
214
|
+
/** @typedef GetOtpConfigurationParam */
|
|
215
|
+
|
|
175
216
|
/**
|
|
176
217
|
* @typedef GetSmsProviderByIdParam
|
|
177
218
|
* @property {string} id - Sms provider id
|
|
@@ -194,6 +235,7 @@ const CommunicationPlatformModel = require("./CommunicationPlatformModel");
|
|
|
194
235
|
* @property {number} [pageNo] - Current page no
|
|
195
236
|
* @property {number} [pageSize] - Current request items count
|
|
196
237
|
* @property {Object} [sort] - To sort based on created_at
|
|
238
|
+
* @property {Object} [query] - To search based on plain text
|
|
197
239
|
*/
|
|
198
240
|
|
|
199
241
|
/**
|
|
@@ -205,12 +247,14 @@ const CommunicationPlatformModel = require("./CommunicationPlatformModel");
|
|
|
205
247
|
* @typedef GetSubscribedEmailTemplatesParam
|
|
206
248
|
* @property {number} [pageNo] - Current page no
|
|
207
249
|
* @property {number} [pageSize] - Current request items count
|
|
250
|
+
* @property {Object} [query] - To search based on plain text
|
|
208
251
|
*/
|
|
209
252
|
|
|
210
253
|
/**
|
|
211
254
|
* @typedef GetSubscribedSmsTemplatesParam
|
|
212
255
|
* @property {number} [pageNo] - Current page no
|
|
213
256
|
* @property {number} [pageSize] - Current request items count
|
|
257
|
+
* @property {Object} [query] - To search based on plain text
|
|
214
258
|
*/
|
|
215
259
|
|
|
216
260
|
/** @typedef GetSystemAudiencesParam */
|
|
@@ -273,6 +317,8 @@ const CommunicationPlatformModel = require("./CommunicationPlatformModel");
|
|
|
273
317
|
* @property {CommunicationPlatformModel.EmailTemplateReq} body
|
|
274
318
|
*/
|
|
275
319
|
|
|
320
|
+
/** @typedef UpdateOtpConfigurationParam */
|
|
321
|
+
|
|
276
322
|
/**
|
|
277
323
|
* @typedef UpdateSmsProviderByIdParam
|
|
278
324
|
* @property {string} id - Sms provider id
|
|
@@ -334,6 +380,27 @@ class CommunicationPlatformApplicationValidator {
|
|
|
334
380
|
}).required();
|
|
335
381
|
}
|
|
336
382
|
|
|
383
|
+
/** @returns {CreateEventSubscriptionsParam} */
|
|
384
|
+
static createEventSubscriptions() {
|
|
385
|
+
return Joi.object({
|
|
386
|
+
body: CommunicationPlatformModel.SubscriptionsObject().required(),
|
|
387
|
+
}).required();
|
|
388
|
+
}
|
|
389
|
+
|
|
390
|
+
/** @returns {CreateEventSubscriptionsByBulkParam} */
|
|
391
|
+
static createEventSubscriptionsByBulk() {
|
|
392
|
+
return Joi.object({
|
|
393
|
+
body: CommunicationPlatformModel.EventSubscriptionsBulkUpdateRequest().required(),
|
|
394
|
+
}).required();
|
|
395
|
+
}
|
|
396
|
+
|
|
397
|
+
/** @returns {CreateJobsParam} */
|
|
398
|
+
static createJobs() {
|
|
399
|
+
return Joi.object({
|
|
400
|
+
body: CommunicationPlatformModel.CreateJobsReq().required(),
|
|
401
|
+
}).required();
|
|
402
|
+
}
|
|
403
|
+
|
|
337
404
|
/** @returns {CreateSmsProviderParam} */
|
|
338
405
|
static createSmsProvider() {
|
|
339
406
|
return Joi.object({
|
|
@@ -352,6 +419,7 @@ class CommunicationPlatformApplicationValidator {
|
|
|
352
419
|
static deleteAudienceById() {
|
|
353
420
|
return Joi.object({
|
|
354
421
|
id: Joi.string().allow("").required(),
|
|
422
|
+
body: CommunicationPlatformModel.AudienceReq().required(),
|
|
355
423
|
}).required();
|
|
356
424
|
}
|
|
357
425
|
|
|
@@ -369,6 +437,13 @@ class CommunicationPlatformApplicationValidator {
|
|
|
369
437
|
}).required();
|
|
370
438
|
}
|
|
371
439
|
|
|
440
|
+
/** @returns {DeleteEventSubscriptionsByIdParam} */
|
|
441
|
+
static deleteEventSubscriptionsById() {
|
|
442
|
+
return Joi.object({
|
|
443
|
+
id: Joi.string().allow("").required(),
|
|
444
|
+
}).required();
|
|
445
|
+
}
|
|
446
|
+
|
|
372
447
|
/** @returns {DeleteSmsProviderByIdParam} */
|
|
373
448
|
static deleteSmsProviderById() {
|
|
374
449
|
return Joi.object({
|
|
@@ -383,6 +458,14 @@ class CommunicationPlatformApplicationValidator {
|
|
|
383
458
|
}).required();
|
|
384
459
|
}
|
|
385
460
|
|
|
461
|
+
/** @returns {EditEventSubscriptionsParam} */
|
|
462
|
+
static editEventSubscriptions() {
|
|
463
|
+
return Joi.object({
|
|
464
|
+
id: Joi.string().allow("").required(),
|
|
465
|
+
body: CommunicationPlatformModel.SubscriptionsObject().required(),
|
|
466
|
+
}).required();
|
|
467
|
+
}
|
|
468
|
+
|
|
386
469
|
/** @returns {GetAppProvidersParam} */
|
|
387
470
|
static getAppProviders() {
|
|
388
471
|
return Joi.object({}).required();
|
|
@@ -401,6 +484,7 @@ class CommunicationPlatformApplicationValidator {
|
|
|
401
484
|
pageNo: Joi.number(),
|
|
402
485
|
pageSize: Joi.number(),
|
|
403
486
|
sort: Joi.any(),
|
|
487
|
+
query: Joi.any(),
|
|
404
488
|
}).required();
|
|
405
489
|
}
|
|
406
490
|
|
|
@@ -428,6 +512,7 @@ class CommunicationPlatformApplicationValidator {
|
|
|
428
512
|
/** @returns {GetCampaignsParam} */
|
|
429
513
|
static getCampaigns() {
|
|
430
514
|
return Joi.object({
|
|
515
|
+
query: Joi.any(),
|
|
431
516
|
pageNo: Joi.number(),
|
|
432
517
|
pageSize: Joi.number(),
|
|
433
518
|
sort: Joi.any(),
|
|
@@ -474,6 +559,7 @@ class CommunicationPlatformApplicationValidator {
|
|
|
474
559
|
pageNo: Joi.number(),
|
|
475
560
|
pageSize: Joi.number(),
|
|
476
561
|
sort: Joi.any(),
|
|
562
|
+
query: Joi.any(),
|
|
477
563
|
}).required();
|
|
478
564
|
}
|
|
479
565
|
|
|
@@ -490,6 +576,7 @@ class CommunicationPlatformApplicationValidator {
|
|
|
490
576
|
pageNo: Joi.number(),
|
|
491
577
|
pageSize: Joi.number(),
|
|
492
578
|
sort: Joi.any(),
|
|
579
|
+
query: Joi.any(),
|
|
493
580
|
}).required();
|
|
494
581
|
}
|
|
495
582
|
|
|
@@ -502,6 +589,14 @@ class CommunicationPlatformApplicationValidator {
|
|
|
502
589
|
}).required();
|
|
503
590
|
}
|
|
504
591
|
|
|
592
|
+
/** @returns {GetEventSubscriptionsByIdParam} */
|
|
593
|
+
static getEventSubscriptionsById() {
|
|
594
|
+
return Joi.object({
|
|
595
|
+
id: Joi.string().allow("").required(),
|
|
596
|
+
populate: Joi.string().allow(""),
|
|
597
|
+
}).required();
|
|
598
|
+
}
|
|
599
|
+
|
|
505
600
|
/** @returns {GetGlobalProvidersParam} */
|
|
506
601
|
static getGlobalProviders() {
|
|
507
602
|
return Joi.object({}).required();
|
|
@@ -518,6 +613,7 @@ class CommunicationPlatformApplicationValidator {
|
|
|
518
613
|
pageNo: Joi.number(),
|
|
519
614
|
pageSize: Joi.number(),
|
|
520
615
|
sort: Joi.any(),
|
|
616
|
+
query: Joi.any(),
|
|
521
617
|
}).required();
|
|
522
618
|
}
|
|
523
619
|
|
|
@@ -527,6 +623,7 @@ class CommunicationPlatformApplicationValidator {
|
|
|
527
623
|
pageNo: Joi.number(),
|
|
528
624
|
pageSize: Joi.number(),
|
|
529
625
|
sort: Joi.any(),
|
|
626
|
+
query: Joi.any(),
|
|
530
627
|
}).required();
|
|
531
628
|
}
|
|
532
629
|
|
|
@@ -542,6 +639,11 @@ class CommunicationPlatformApplicationValidator {
|
|
|
542
639
|
return Joi.object({}).required();
|
|
543
640
|
}
|
|
544
641
|
|
|
642
|
+
/** @returns {GetOtpConfigurationParam} */
|
|
643
|
+
static getOtpConfiguration() {
|
|
644
|
+
return Joi.object({}).required();
|
|
645
|
+
}
|
|
646
|
+
|
|
545
647
|
/** @returns {GetSmsProviderByIdParam} */
|
|
546
648
|
static getSmsProviderById() {
|
|
547
649
|
return Joi.object({
|
|
@@ -571,6 +673,7 @@ class CommunicationPlatformApplicationValidator {
|
|
|
571
673
|
pageNo: Joi.number(),
|
|
572
674
|
pageSize: Joi.number(),
|
|
573
675
|
sort: Joi.any(),
|
|
676
|
+
query: Joi.any(),
|
|
574
677
|
}).required();
|
|
575
678
|
}
|
|
576
679
|
|
|
@@ -586,6 +689,7 @@ class CommunicationPlatformApplicationValidator {
|
|
|
586
689
|
return Joi.object({
|
|
587
690
|
pageNo: Joi.number(),
|
|
588
691
|
pageSize: Joi.number(),
|
|
692
|
+
query: Joi.any(),
|
|
589
693
|
}).required();
|
|
590
694
|
}
|
|
591
695
|
|
|
@@ -594,6 +698,7 @@ class CommunicationPlatformApplicationValidator {
|
|
|
594
698
|
return Joi.object({
|
|
595
699
|
pageNo: Joi.number(),
|
|
596
700
|
pageSize: Joi.number(),
|
|
701
|
+
query: Joi.any(),
|
|
597
702
|
}).required();
|
|
598
703
|
}
|
|
599
704
|
|
|
@@ -686,6 +791,11 @@ class CommunicationPlatformApplicationValidator {
|
|
|
686
791
|
}).required();
|
|
687
792
|
}
|
|
688
793
|
|
|
794
|
+
/** @returns {UpdateOtpConfigurationParam} */
|
|
795
|
+
static updateOtpConfiguration() {
|
|
796
|
+
return Joi.object({}).required();
|
|
797
|
+
}
|
|
798
|
+
|
|
689
799
|
/** @returns {UpdateSmsProviderByIdParam} */
|
|
690
800
|
static updateSmsProviderById() {
|
|
691
801
|
return Joi.object({
|