@gofynd/fdk-client-javascript 1.6.4 → 3.1.0-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/ApplicationClient.d.ts +0 -2
- package/sdk/application/ApplicationClient.js +0 -2
- package/sdk/application/Cart/CartApplicationClient.d.ts +100 -80
- package/sdk/application/Cart/CartApplicationClient.js +257 -126
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +110 -110
- package/sdk/application/Catalog/CatalogApplicationClient.js +122 -138
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +43 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +190 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +71 -36
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +103 -29
- package/sdk/application/Content/ContentApplicationClient.d.ts +61 -21
- package/sdk/application/Content/ContentApplicationClient.js +250 -36
- package/sdk/application/Lead/LeadApplicationClient.d.ts +3 -3
- package/sdk/application/Lead/LeadApplicationClient.js +3 -3
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +106 -57
- package/sdk/application/Logistic/LogisticApplicationClient.js +326 -208
- package/sdk/application/Order/OrderApplicationClient.d.ts +44 -24
- package/sdk/application/Order/OrderApplicationClient.js +140 -21
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +211 -111
- package/sdk/application/Payment/PaymentApplicationClient.js +610 -109
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +14 -14
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +23 -3
- package/sdk/application/Theme/ThemeApplicationClient.js +103 -5
- package/sdk/application/User/UserApplicationClient.d.ts +13 -23
- package/sdk/application/User/UserApplicationClient.js +9 -57
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +3 -3
- package/sdk/partner/Authorization/AuthorizationPartnerClient.d.ts +66 -0
- package/sdk/partner/Authorization/AuthorizationPartnerClient.js +431 -0
- package/sdk/partner/Authorization/AuthorizationPartnerModel.d.ts +231 -0
- package/sdk/partner/Authorization/AuthorizationPartnerModel.js +152 -0
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.d.ts +8 -0
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.js +39 -0
- package/sdk/partner/Catalog/CatalogPartnerClient.d.ts +26 -0
- package/sdk/partner/Catalog/CatalogPartnerClient.js +173 -0
- package/sdk/partner/Catalog/CatalogPartnerModel.d.ts +238 -0
- package/sdk/partner/Catalog/CatalogPartnerModel.js +248 -0
- package/sdk/partner/Catalog/CatalogPartnerValidator.d.ts +5 -0
- package/sdk/partner/Catalog/CatalogPartnerValidator.js +19 -0
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +0 -10
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +0 -75
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +1 -54
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +0 -43
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +0 -1
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +0 -6
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerClient.js +4 -4
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +100 -49
- package/sdk/partner/Lead/LeadPartnerModel.js +100 -74
- package/sdk/partner/Lead/LeadPartnerValidator.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +33 -160
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +66 -1180
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +288 -1685
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +226 -824
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +1 -13
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +14 -141
- package/sdk/partner/PartnerClient.d.ts +6 -0
- package/sdk/partner/PartnerClient.js +9 -0
- package/sdk/partner/Payment/PaymentPartnerClient.d.ts +116 -0
- package/sdk/partner/Payment/PaymentPartnerClient.js +857 -0
- package/sdk/partner/Payment/PaymentPartnerModel.d.ts +388 -0
- package/sdk/partner/Payment/PaymentPartnerModel.js +442 -0
- package/sdk/partner/Payment/PaymentPartnerValidator.d.ts +14 -0
- package/sdk/partner/Payment/PaymentPartnerValidator.js +74 -0
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +63 -21
- package/sdk/partner/Theme/ThemePartnerClient.js +396 -71
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +104 -72
- package/sdk/partner/Theme/ThemePartnerModel.js +101 -75
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +5 -1
- package/sdk/partner/Theme/ThemePartnerValidator.js +42 -12
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +191 -670
- package/sdk/partner/Webhook/WebhookPartnerModel.js +159 -268
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -3
- package/sdk/partner/index.d.ts +3 -0
- package/sdk/partner/index.js +6 -0
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +1 -4
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +5 -0
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +3 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +32 -2
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +243 -3
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +145 -49
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +171 -20
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +39 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +35 -0
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +388 -443
- package/sdk/platform/Billing/BillingPlatformModel.js +263 -280
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +18 -16
- package/sdk/platform/Billing/BillingPlatformValidator.js +9 -8
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +251 -172
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +639 -521
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +165 -165
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +108 -132
- package/sdk/platform/Cart/CartPlatformModel.d.ts +3150 -4468
- package/sdk/platform/Cart/CartPlatformModel.js +2858 -1867
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +976 -380
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +6475 -2015
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1083 -162
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +884 -80
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +325 -568
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1162 -1562
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6008 -7688
- package/sdk/platform/Catalog/CatalogPlatformModel.js +9522 -6892
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +234 -227
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +183 -177
- package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -6
- package/sdk/platform/Common/CommonPlatformClient.js +5 -6
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +374 -238
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +876 -588
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +170 -139
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +145 -126
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +56 -3
- package/sdk/platform/Communication/CommunicationPlatformClient.js +307 -4
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +506 -270
- package/sdk/platform/Communication/CommunicationPlatformModel.js +611 -313
- package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +62 -3
- package/sdk/platform/Communication/CommunicationPlatformValidator.js +48 -2
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +78 -77
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +97 -91
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +238 -256
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +222 -244
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +31 -20
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +25 -20
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +333 -118
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +1470 -409
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +158 -55
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +163 -41
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +151 -61
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +595 -101
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +1206 -459
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +1011 -320
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +80 -34
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +79 -24
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +255 -140
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1095 -464
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +221 -178
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +220 -157
- package/sdk/platform/Content/ContentPlatformClient.d.ts +124 -123
- package/sdk/platform/Content/ContentPlatformClient.js +459 -379
- package/sdk/platform/Content/ContentPlatformModel.d.ts +871 -1315
- package/sdk/platform/Content/ContentPlatformModel.js +940 -599
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +140 -150
- package/sdk/platform/Content/ContentPlatformValidator.js +131 -135
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +60 -36
- package/sdk/platform/Discount/DiscountPlatformClient.js +85 -36
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +46 -47
- package/sdk/platform/Discount/DiscountPlatformModel.js +42 -46
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +18 -15
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +24 -22
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +75 -86
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +60 -74
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +320 -0
- package/sdk/platform/Finance/FinancePlatformClient.js +2333 -0
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +2895 -0
- package/sdk/platform/Finance/FinancePlatformModel.js +2150 -0
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +284 -0
- package/sdk/platform/Finance/FinancePlatformValidator.js +354 -0
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +17 -17
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +33 -33
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +19 -19
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +14 -14
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +4 -24
- package/sdk/platform/Lead/LeadPlatformClient.js +4 -160
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +142 -57
- package/sdk/platform/Lead/LeadPlatformModel.js +162 -79
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +3 -29
- package/sdk/platform/Lead/LeadPlatformValidator.js +2 -28
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +94 -25
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +600 -57
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +115 -115
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +120 -43
- package/sdk/platform/Order/OrderPlatformClient.d.ts +486 -277
- package/sdk/platform/Order/OrderPlatformClient.js +1491 -938
- package/sdk/platform/Order/OrderPlatformModel.d.ts +4560 -8636
- package/sdk/platform/Order/OrderPlatformModel.js +3604 -4056
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +445 -612
- package/sdk/platform/Order/OrderPlatformValidator.js +316 -326
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +7 -9
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
- package/sdk/platform/Partner/PartnerPlatformModel.js +7 -7
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +382 -135
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +2453 -935
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +306 -93
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +305 -70
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +66 -56
- package/sdk/platform/Payment/PaymentPlatformClient.js +269 -124
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +3531 -1292
- package/sdk/platform/Payment/PaymentPlatformModel.js +3813 -1504
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +64 -35
- package/sdk/platform/Payment/PaymentPlatformValidator.js +60 -34
- package/sdk/platform/PlatformClient.d.ts +2 -0
- package/sdk/platform/PlatformClient.js +4 -0
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +14 -9
- package/sdk/platform/Rewards/RewardsPlatformModel.js +10 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +344 -56
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +2188 -302
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +394 -54
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +342 -37
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +150 -212
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +589 -1238
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +3581 -2960
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +3730 -1779
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +230 -382
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +164 -287
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +4 -16
- package/sdk/platform/Share/SharePlatformApplicationClient.js +8 -86
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +6 -23
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +3 -16
- package/sdk/platform/Share/SharePlatformModel.d.ts +11 -50
- package/sdk/platform/Share/SharePlatformModel.js +5 -43
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +36 -16
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +201 -58
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +28 -17
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +33 -16
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +18 -8
- package/sdk/platform/Theme/ThemePlatformClient.js +85 -8
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +425 -17
- package/sdk/platform/Theme/ThemePlatformModel.js +329 -23
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +7 -3
- package/sdk/platform/Theme/ThemePlatformValidator.js +9 -2
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +18 -71
- package/sdk/platform/User/UserPlatformApplicationClient.js +27 -412
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +10 -114
- package/sdk/platform/User/UserPlatformApplicationValidator.js +7 -80
- package/sdk/platform/User/UserPlatformModel.d.ts +216 -264
- package/sdk/platform/User/UserPlatformModel.js +209 -216
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +78 -25
- package/sdk/platform/Webhook/WebhookPlatformClient.js +470 -75
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +428 -810
- package/sdk/platform/Webhook/WebhookPlatformModel.js +395 -444
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +55 -10
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +72 -12
- package/sdk/platform/index.d.ts +1 -0
- package/sdk/platform/index.js +2 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +14 -4
- package/sdk/public/Configuration/ConfigurationPublicClient.js +97 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +102 -40
- package/sdk/public/Configuration/ConfigurationPublicModel.js +111 -29
- package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +11 -1
- package/sdk/public/Configuration/ConfigurationPublicValidator.js +12 -0
- package/sdk/public/Content/ContentPublicClient.d.ts +22 -0
- package/sdk/public/Content/ContentPublicClient.js +183 -0
- package/sdk/public/Content/ContentPublicModel.d.ts +38 -1
- package/sdk/public/Content/ContentPublicModel.js +47 -1
- package/sdk/public/Content/ContentPublicValidator.d.ts +17 -1
- package/sdk/public/Content/ContentPublicValidator.js +19 -0
- package/sdk/public/PublicClient.d.ts +0 -2
- package/sdk/public/PublicClient.js +0 -4
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +67 -215
- package/sdk/public/Webhook/WebhookPublicModel.js +61 -66
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/public/index.d.ts +0 -1
- package/sdk/public/index.js +0 -2
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +0 -29
- package/sdk/application/Finance/FinanceApplicationClient.js +0 -126
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +0 -22
- package/sdk/public/Catalog/CatalogPublicClient.js +0 -138
- package/sdk/public/Catalog/CatalogPublicModel.d.ts +0 -155
- package/sdk/public/Catalog/CatalogPublicModel.js +0 -116
- package/sdk/public/Catalog/CatalogPublicValidator.d.ts +0 -55
- package/sdk/public/Catalog/CatalogPublicValidator.js +0 -35
|
@@ -1,351 +1,370 @@
|
|
|
1
1
|
const Joi = require("joi");
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
|
-
* @typedef
|
|
5
|
-
* @property {
|
|
6
|
-
* @property {string} [
|
|
7
|
-
* @property {
|
|
8
|
-
* @property {
|
|
9
|
-
* @property {number} [current] - The current page number.
|
|
10
|
-
* @property {string} type - The type of the page, such as 'PageType'.
|
|
11
|
-
* @property {number} [size] - The number of items per page.
|
|
4
|
+
* @typedef Event
|
|
5
|
+
* @property {string} [event_name]
|
|
6
|
+
* @property {string} [event_type]
|
|
7
|
+
* @property {string} [event_category]
|
|
8
|
+
* @property {string} [version]
|
|
12
9
|
*/
|
|
13
10
|
|
|
14
11
|
/**
|
|
15
|
-
* @typedef
|
|
16
|
-
* @property {string} [
|
|
17
|
-
* @property {string}
|
|
18
|
-
* @property {string}
|
|
19
|
-
*
|
|
20
|
-
* @property {string} [
|
|
21
|
-
*
|
|
22
|
-
* @property {string} [account_id] - The account ID associated with the broadcaster.
|
|
23
|
-
* @property {string} [detail_type] - The type of detail for the broadcaster
|
|
24
|
-
* configuration.
|
|
12
|
+
* @typedef EventProcessRequest
|
|
13
|
+
* @property {string} [search_text]
|
|
14
|
+
* @property {string} end_date
|
|
15
|
+
* @property {string} start_date
|
|
16
|
+
* @property {number[]} [subscriber_ids]
|
|
17
|
+
* @property {string} [status]
|
|
18
|
+
* @property {Event[]} [event]
|
|
25
19
|
*/
|
|
26
20
|
|
|
27
21
|
/**
|
|
28
|
-
* @typedef
|
|
29
|
-
* @property {
|
|
30
|
-
* @property {number} [event_id] - The ID of the event associated with the subscriber.
|
|
31
|
-
* @property {number} [subscriber_id] - The ID of the subscriber.
|
|
32
|
-
* @property {FilterSchema} [filters]
|
|
33
|
-
* @property {Object} [reducer] - The reducer property allows users to customize
|
|
34
|
-
* the JSON structure of the webhook payload using JSONPath queries. They can
|
|
35
|
-
* also create new properties by mapping existing ones. Note that it overrides
|
|
36
|
-
* the entire JSON structure of the webhook payload sent via the webhook. See
|
|
37
|
-
* the partner documentation's filter and reducer section for details.
|
|
38
|
-
* @property {BroadcasterConfig} [broadcaster_config]
|
|
39
|
-
* @property {string} [created_on] - The date and time when the subscriber event
|
|
40
|
-
* mapping was created.
|
|
41
|
-
*/
|
|
42
|
-
|
|
43
|
-
/**
|
|
44
|
-
* @typedef FilterSchema
|
|
45
|
-
* @property {string} [query] - JSONPath expression that specifies the property
|
|
46
|
-
* in the webhook payload to filter on. This enables targeting specific data
|
|
47
|
-
* within the payload.
|
|
48
|
-
* @property {string} [condition] - JavaScript function used to evaluate the
|
|
49
|
-
* specified property in the webhook payload against a condition. This
|
|
50
|
-
* function determines whether the filter passes based on its return value.
|
|
51
|
-
* @property {string} [logic] - Logical operator used to combine multiple
|
|
52
|
-
* conditions in the `conditions` array. Supported values are `AND` and `OR`.
|
|
53
|
-
* @property {Object[]} [conditions] - An array of filter objects to be
|
|
54
|
-
* evaluated using the specified logical operator. This array will contain
|
|
55
|
-
* more filters including a combination of single condition mode and logical
|
|
56
|
-
* group mode filters.
|
|
22
|
+
* @typedef DownloadReportResponse
|
|
23
|
+
* @property {string} [file_name]
|
|
57
24
|
*/
|
|
58
25
|
|
|
59
26
|
/**
|
|
60
|
-
* @typedef
|
|
61
|
-
* @property {
|
|
62
|
-
* @property {
|
|
63
|
-
* @property {string} [event_name] - The name of the event.
|
|
64
|
-
* @property {string} [event_type] - The type of the event.
|
|
65
|
-
* @property {string} [event_category] - The category of the event.
|
|
66
|
-
* @property {string} [modified_by] - The identifier of the user who last
|
|
67
|
-
* modified the event configuration.
|
|
68
|
-
* @property {SubscriberEventMapping} [subscriber_event_mapping]
|
|
69
|
-
* @property {Object} [event_schema] - The schema for the event, allowing for
|
|
70
|
-
* additional properties and may be null.
|
|
71
|
-
* @property {string} [group] - The group associated with the event
|
|
72
|
-
* configuration, which may be null.
|
|
73
|
-
* @property {string} [version] - The version of the event configuration.
|
|
74
|
-
* @property {string} [display_name] - The display name of the event configuration.
|
|
75
|
-
* @property {string} [description] - A description of the event configuration,
|
|
76
|
-
* which may be null.
|
|
77
|
-
* @property {string} [created_on] - The date and time when the event
|
|
78
|
-
* configuration was created.
|
|
79
|
-
* @property {string} [updated_on] - The date and time when the event
|
|
80
|
-
* configuration was last updated.
|
|
27
|
+
* @typedef EventProcessReports
|
|
28
|
+
* @property {EventProcessReportObject[]} [rows]
|
|
29
|
+
* @property {Page} [page]
|
|
81
30
|
*/
|
|
82
31
|
|
|
83
32
|
/**
|
|
84
|
-
* @typedef
|
|
85
|
-
* @property {
|
|
33
|
+
* @typedef EventProcessReportObject
|
|
34
|
+
* @property {string} [event_name] - The name of the processed event.
|
|
35
|
+
* @property {number} [response_code] - The response code of the event.
|
|
36
|
+
* @property {string} [response_message] - The response message of the event.
|
|
37
|
+
* @property {string} [data] - The data associated with the event.
|
|
38
|
+
* @property {number} [attempt] - The attempt number of the event.
|
|
39
|
+
* @property {number} [last_attempted_on] - The timestamp of the last attempted event.
|
|
40
|
+
* @property {string} [status] - The status of the event (e.g., "FAILED").
|
|
41
|
+
* @property {string} [name] - The name of the event.
|
|
42
|
+
* @property {string} [webhook_url] - The webhook URL associated with the event.
|
|
43
|
+
* @property {number} [response_time] - The response time of the event.
|
|
44
|
+
* @property {string} [message_id]
|
|
45
|
+
* @property {string} [event_trace_id]
|
|
86
46
|
*/
|
|
87
47
|
|
|
88
48
|
/**
|
|
89
|
-
* @typedef
|
|
90
|
-
* @property {
|
|
91
|
-
*
|
|
92
|
-
* @property {
|
|
93
|
-
* @property {
|
|
94
|
-
*
|
|
49
|
+
* @typedef Page
|
|
50
|
+
* @property {number} [item_total] - The total number of items on the page.
|
|
51
|
+
* @property {string} [next_id] - The identifier for the next page.
|
|
52
|
+
* @property {boolean} [has_previous] - Indicates whether there is a previous page.
|
|
53
|
+
* @property {boolean} [has_next] - Indicates whether there is a next page.
|
|
54
|
+
* @property {number} [current] - The current page number.
|
|
55
|
+
* @property {string} type - The type of the page, such as 'PageType'.
|
|
56
|
+
* @property {number} [size] - The number of items per page.
|
|
57
|
+
* @property {number} [total] - Total number of items.
|
|
95
58
|
*/
|
|
96
59
|
|
|
97
60
|
/**
|
|
98
|
-
* @typedef
|
|
99
|
-
* @property {
|
|
100
|
-
* @property {
|
|
101
|
-
*
|
|
102
|
-
* @property {
|
|
103
|
-
* @property {string} [criteria] - The criteria for the response, such as "ALL",
|
|
104
|
-
* "EMPTY", or "SPECIFIC-EVENTS".
|
|
61
|
+
* @typedef PingWebhook
|
|
62
|
+
* @property {string} webhook_url - The URL of the subscriber's webhook to ping.
|
|
63
|
+
* @property {Object} [auth_meta] - Authentication metadata (if required by the
|
|
64
|
+
* subscriber).
|
|
65
|
+
* @property {Object} [custom_headers] - Custom headers to include in the ping request.
|
|
105
66
|
*/
|
|
106
67
|
|
|
107
68
|
/**
|
|
108
|
-
* @typedef
|
|
109
|
-
* @property {string} [
|
|
110
|
-
* @property {string} [
|
|
69
|
+
* @typedef PingWebhookResponse
|
|
70
|
+
* @property {string} [status] - The status of the ping (e.g., "SUCCESS").
|
|
71
|
+
* @property {string} [message] - An optional message related to the ping.
|
|
72
|
+
* @property {number} [code] - The HTTP status code of the ping response (e.g., 200).
|
|
111
73
|
*/
|
|
112
74
|
|
|
113
75
|
/**
|
|
114
|
-
* @typedef
|
|
115
|
-
* @property {number} [id]
|
|
116
|
-
* @property {
|
|
117
|
-
*
|
|
118
|
-
* @property {string} [
|
|
119
|
-
* @property {string} [
|
|
120
|
-
* @property {string} [webhook_url] - The URL for the subscriber's webhook.
|
|
121
|
-
* @property {AssociationResp} [association]
|
|
122
|
-
* @property {Object} [custom_headers] - Custom headers for the subscriber.
|
|
123
|
-
* @property {SubscriberStatus} [status]
|
|
124
|
-
* @property {string} [email_id] - The email ID associated with the subscriber.
|
|
125
|
-
* @property {string} [updated_on] - The date and time when the subscriber
|
|
126
|
-
* details were last updated.
|
|
127
|
-
* @property {string} [created_on] - The date and time when the subscriber was created.
|
|
128
|
-
* @property {string} [type] - The type of subscriber, which can either be passed as null.
|
|
129
|
-
* @property {AuthMeta} [auth_meta]
|
|
130
|
-
* @property {EventConfig[]} [event_configs] - List of event configurations.
|
|
76
|
+
* @typedef SubscriberEventMapping
|
|
77
|
+
* @property {number} [id]
|
|
78
|
+
* @property {number} [event_id]
|
|
79
|
+
* @property {number} [subscriber_id]
|
|
80
|
+
* @property {string} [topic]
|
|
81
|
+
* @property {string} [created_on]
|
|
131
82
|
*/
|
|
132
83
|
|
|
133
84
|
/**
|
|
134
|
-
* @typedef
|
|
135
|
-
* @property {
|
|
136
|
-
* @property {string} [
|
|
137
|
-
* @property {string} [
|
|
138
|
-
*
|
|
139
|
-
* @property {
|
|
140
|
-
*
|
|
141
|
-
* @property {string} [
|
|
142
|
-
*
|
|
143
|
-
* @property {string} [
|
|
85
|
+
* @typedef EventConfig
|
|
86
|
+
* @property {number} [id]
|
|
87
|
+
* @property {string} [event_name]
|
|
88
|
+
* @property {string} [event_type]
|
|
89
|
+
* @property {string} [event_category]
|
|
90
|
+
* @property {SubscriberEventMapping} [subscriber_event_mapping]
|
|
91
|
+
* @property {Object} [event_schema]
|
|
92
|
+
* @property {string} [group]
|
|
93
|
+
* @property {string} [version]
|
|
94
|
+
* @property {string} [display_name]
|
|
95
|
+
* @property {string} [description]
|
|
96
|
+
* @property {string} [created_on]
|
|
97
|
+
* @property {string} [updated_on]
|
|
144
98
|
*/
|
|
145
99
|
|
|
146
100
|
/**
|
|
147
|
-
* @typedef
|
|
148
|
-
* @property {
|
|
149
|
-
* @property {string} [type] - The type of the subscriber, which may be null.
|
|
150
|
-
* @property {string} [webhook_url] - The URL for the subscriber's webhook.
|
|
151
|
-
* @property {string} provider - The provider of the subscriber.
|
|
152
|
-
* @property {Association} association
|
|
153
|
-
* @property {Object} [custom_headers] - Custom headers for the subscriber.
|
|
154
|
-
* @property {SubscriberStatus} status
|
|
155
|
-
* @property {string} email_id - The email ID associated with the subscriber.
|
|
156
|
-
* @property {AuthMeta} [auth_meta]
|
|
157
|
-
* @property {Events[]} events - The list of events associated with the subscriber.
|
|
101
|
+
* @typedef EventConfigResponse
|
|
102
|
+
* @property {EventConfig[]} [event_configs]
|
|
158
103
|
*/
|
|
159
104
|
|
|
160
105
|
/**
|
|
161
|
-
* @typedef
|
|
162
|
-
* @property {number}
|
|
163
|
-
*
|
|
164
|
-
* @property {string} [type] - The type of the subscriber, which may be null.
|
|
165
|
-
* @property {string} [webhook_url] - The URL for the subscriber's webhook.
|
|
166
|
-
* @property {string} provider - The provider of the subscriber.
|
|
167
|
-
* @property {Association} [association]
|
|
168
|
-
* @property {Object} [custom_headers] - Custom headers for the subscriber.
|
|
169
|
-
* @property {SubscriberStatus} status
|
|
170
|
-
* @property {string} [email_id] - The email ID associated with the subscriber.
|
|
171
|
-
* @property {AuthMeta} [auth_meta]
|
|
172
|
-
* @property {Events[]} [events] - The list of events associated with the subscriber.
|
|
106
|
+
* @typedef ReportFiltersPayload
|
|
107
|
+
* @property {number[]} subscriber_ids - An array of subscriber IDs for
|
|
108
|
+
* filtering filters (optional).
|
|
173
109
|
*/
|
|
174
110
|
|
|
175
111
|
/**
|
|
176
|
-
* @typedef
|
|
177
|
-
* @property {string}
|
|
178
|
-
* @property {
|
|
179
|
-
* @property {string} webhook_url - The URL for the subscriber's webhook.
|
|
180
|
-
* @property {Association} association
|
|
181
|
-
* @property {Object} [custom_headers] - Custom headers for the subscriber.
|
|
182
|
-
* @property {SubscriberStatus} status
|
|
183
|
-
* @property {string} email_id - The email ID associated with the subscriber.
|
|
184
|
-
* @property {AuthMeta} [auth_meta]
|
|
185
|
-
* @property {number[]} event_id - The list of event IDs associated with the subscriber.
|
|
112
|
+
* @typedef ReportFilterResponse
|
|
113
|
+
* @property {string} [filter_name] - The name of the filter.
|
|
114
|
+
* @property {Object[]} [values]
|
|
186
115
|
*/
|
|
187
116
|
|
|
188
117
|
/**
|
|
189
|
-
* @typedef
|
|
190
|
-
* @property {
|
|
191
|
-
* @property {
|
|
192
|
-
* @property {
|
|
193
|
-
* @property {string} [webhook_url] - The URL for the subscriber's webhook.
|
|
194
|
-
* @property {Association} [association]
|
|
195
|
-
* @property {Object} [custom_headers] - Custom headers for the subscriber.
|
|
196
|
-
* @property {SubscriberStatus} [status]
|
|
197
|
-
* @property {string} [email_id] - The email ID associated with the subscriber.
|
|
198
|
-
* @property {AuthMeta} [auth_meta]
|
|
199
|
-
* @property {number[]} event_id - The list of event IDs associated with the subscriber.
|
|
118
|
+
* @typedef HistoryPayload
|
|
119
|
+
* @property {string} type - The type of history report (e.g., "platform").
|
|
120
|
+
* @property {number} [page_no] - The page number of the history report.
|
|
121
|
+
* @property {number} [page_size] - The number of records per page.
|
|
200
122
|
*/
|
|
201
123
|
|
|
202
124
|
/**
|
|
203
|
-
* @typedef
|
|
204
|
-
* @property {
|
|
205
|
-
* @property {string} [
|
|
206
|
-
*
|
|
207
|
-
* @property {string} [
|
|
208
|
-
* @property {string} [
|
|
209
|
-
* @property {
|
|
210
|
-
*
|
|
211
|
-
* @property {
|
|
212
|
-
*
|
|
213
|
-
* @property {string} [email_id] - The email ID associated with the subscriber.
|
|
214
|
-
* @property {string} [updated_on] - The date and time when the subscriber was
|
|
215
|
-
* last updated.
|
|
216
|
-
* @property {string} [created_on] - The date and time when the subscriber was created.
|
|
217
|
-
* @property {string} [type] - The type of the subscriber, which can be null.
|
|
218
|
-
* @property {AuthMeta} [auth_meta]
|
|
219
|
-
* @property {number[]} [event_id] - The list of event IDs associated with the subscriber.
|
|
125
|
+
* @typedef HistoryFilters
|
|
126
|
+
* @property {string[]} [events]
|
|
127
|
+
* @property {string} [search_text]
|
|
128
|
+
* @property {string} [status] - The status of the history report (e.g., "FAILED").
|
|
129
|
+
* @property {string} [end_date] - The end date and time of the history report.
|
|
130
|
+
* @property {string} [start_date] - The start date and time of the history report.
|
|
131
|
+
* @property {number[]} [subscribers] - An array of subscriber IDs associated
|
|
132
|
+
* with the history report.
|
|
133
|
+
* @property {string[]} [webhook_type] - An array of webhook type to identify
|
|
134
|
+
* thetype of subscriber i.e (KAFKA or REST).
|
|
220
135
|
*/
|
|
221
136
|
|
|
222
137
|
/**
|
|
223
|
-
* @typedef
|
|
224
|
-
* @property {
|
|
225
|
-
* @property {
|
|
138
|
+
* @typedef Url
|
|
139
|
+
* @property {string} [url] - The URL of the uploaded report file.
|
|
140
|
+
* @property {string} [name] - The name of the uploaded report file.
|
|
226
141
|
*/
|
|
227
142
|
|
|
228
143
|
/**
|
|
229
|
-
* @typedef
|
|
230
|
-
* @property {
|
|
231
|
-
* @property {string} event_name - The name of the event.
|
|
232
|
-
* @property {string} event_type - The type of the event.
|
|
233
|
-
* @property {number} version - The version number of the event.
|
|
144
|
+
* @typedef CdnObject
|
|
145
|
+
* @property {Url[]} [urls]
|
|
234
146
|
*/
|
|
235
147
|
|
|
236
148
|
/**
|
|
237
|
-
* @typedef
|
|
238
|
-
* @property {
|
|
239
|
-
* @property {string} type - The type of the configuration.
|
|
240
|
-
* @property {Object} [custom_headers] - Custom headers for the configuration.
|
|
241
|
-
* @property {AuthMeta} [auth_meta]
|
|
242
|
-
* @property {RestEventData[]} events - List of event data for configuration.
|
|
149
|
+
* @typedef UploadServiceObject
|
|
150
|
+
* @property {CdnObject} [cdn]
|
|
243
151
|
*/
|
|
244
152
|
|
|
245
153
|
/**
|
|
246
|
-
* @typedef
|
|
247
|
-
* @property {
|
|
248
|
-
* @property {
|
|
249
|
-
* @property {string} event_type - The type of the event.
|
|
250
|
-
* @property {number} version - The version number of the event.
|
|
251
|
-
* @property {string} topic - The topic associated with the event.
|
|
154
|
+
* @typedef HistoryAssociation
|
|
155
|
+
* @property {number} [company_id]
|
|
156
|
+
* @property {number[]} [subscriber_ids]
|
|
252
157
|
*/
|
|
253
158
|
|
|
254
159
|
/**
|
|
255
|
-
* @typedef
|
|
256
|
-
* @property {
|
|
257
|
-
* @property {
|
|
160
|
+
* @typedef HistoryItems
|
|
161
|
+
* @property {number} [id] - The ID of the history report.
|
|
162
|
+
* @property {HistoryAssociation} [association]
|
|
163
|
+
* @property {HistoryFilters} [filters]
|
|
164
|
+
* @property {string} [filename] - The filename of the history report.
|
|
165
|
+
* @property {string} [status] - The status of the history report (e.g., "COMPLETED").
|
|
166
|
+
* @property {UploadServiceObject} [upload_service_response]
|
|
167
|
+
* @property {string} [created_on] - The date and time when the history report
|
|
168
|
+
* was created.
|
|
169
|
+
* @property {string} [updated_on] - The date and time when the history report
|
|
170
|
+
* was last updated.
|
|
171
|
+
* @property {string} [message] - A message related to the history report.
|
|
258
172
|
*/
|
|
259
173
|
|
|
260
174
|
/**
|
|
261
|
-
* @typedef
|
|
262
|
-
* @property {
|
|
263
|
-
* @property {
|
|
175
|
+
* @typedef HistoryResponse
|
|
176
|
+
* @property {HistoryItems[]} [items]
|
|
177
|
+
* @property {Page} [page]
|
|
264
178
|
*/
|
|
265
179
|
|
|
266
180
|
/**
|
|
267
|
-
* @typedef
|
|
268
|
-
* @property {string}
|
|
269
|
-
* @property {string} event_name - The name of the event.
|
|
270
|
-
* @property {string} event_type - The type of the event.
|
|
271
|
-
* @property {number} version - The version number of the event.
|
|
272
|
-
* @property {string} [queue] - The queue associated with the event.
|
|
273
|
-
* @property {string} [workflow_name] - The workflow name related to the event.
|
|
181
|
+
* @typedef CancelResponse
|
|
182
|
+
* @property {string} [message] - The HTTP status code of the response (e.g., 200).
|
|
274
183
|
*/
|
|
275
184
|
|
|
276
185
|
/**
|
|
277
|
-
* @typedef
|
|
278
|
-
* @property {string} [
|
|
279
|
-
* @property {
|
|
186
|
+
* @typedef Association
|
|
187
|
+
* @property {string[]} [application_id]
|
|
188
|
+
* @property {string} [extension_id]
|
|
189
|
+
* @property {string} [criteria]
|
|
280
190
|
*/
|
|
281
191
|
|
|
282
192
|
/**
|
|
283
|
-
* @typedef
|
|
284
|
-
* @property {
|
|
285
|
-
* @property {string}
|
|
286
|
-
* @property {string}
|
|
287
|
-
* @property {
|
|
288
|
-
* @property {string} [queue] - The queue name associated with the event in SQS.
|
|
193
|
+
* @typedef AssociationResp
|
|
194
|
+
* @property {number} [company_id]
|
|
195
|
+
* @property {string[]} [application_id]
|
|
196
|
+
* @property {string} [extension_id]
|
|
197
|
+
* @property {string} [criteria]
|
|
289
198
|
*/
|
|
290
199
|
|
|
291
200
|
/**
|
|
292
|
-
* @typedef
|
|
293
|
-
* @property {string} [type]
|
|
294
|
-
* @property {
|
|
201
|
+
* @typedef AuthMeta
|
|
202
|
+
* @property {string} [type]
|
|
203
|
+
* @property {string} [secret]
|
|
295
204
|
*/
|
|
296
205
|
|
|
297
206
|
/**
|
|
298
|
-
* @typedef
|
|
299
|
-
* @property {
|
|
300
|
-
* @property {string}
|
|
301
|
-
* @property {string}
|
|
302
|
-
* @property {
|
|
303
|
-
* @property {string} [
|
|
304
|
-
*
|
|
207
|
+
* @typedef SubscriberResponse
|
|
208
|
+
* @property {number} [id]
|
|
209
|
+
* @property {string} [modified_by]
|
|
210
|
+
* @property {string} [name]
|
|
211
|
+
* @property {string} [provider]
|
|
212
|
+
* @property {string} [webhook_url]
|
|
213
|
+
* @property {AssociationResp} [association]
|
|
214
|
+
* @property {Object} [custom_headers]
|
|
215
|
+
* @property {SubscriberStatus} [status]
|
|
216
|
+
* @property {string} [email_id]
|
|
217
|
+
* @property {string} [updated_on]
|
|
218
|
+
* @property {string} [created_on]
|
|
219
|
+
* @property {string} [type]
|
|
220
|
+
* @property {AuthMeta} [auth_meta]
|
|
221
|
+
* @property {EventConfig[]} [event_configs]
|
|
305
222
|
*/
|
|
306
223
|
|
|
307
224
|
/**
|
|
308
|
-
* @typedef
|
|
309
|
-
* @property {string} [
|
|
310
|
-
* @property {
|
|
311
|
-
* configuration.
|
|
225
|
+
* @typedef Events
|
|
226
|
+
* @property {string} [slug]
|
|
227
|
+
* @property {string} [topic]
|
|
312
228
|
*/
|
|
313
229
|
|
|
314
230
|
/**
|
|
315
|
-
* @typedef
|
|
316
|
-
* @property {
|
|
317
|
-
* @property {
|
|
318
|
-
* @property {
|
|
319
|
-
* @property {
|
|
320
|
-
* @property {
|
|
321
|
-
* @property {
|
|
231
|
+
* @typedef SubscriberConfigPostRequestV2
|
|
232
|
+
* @property {string} name
|
|
233
|
+
* @property {string} [type]
|
|
234
|
+
* @property {string} [webhook_url]
|
|
235
|
+
* @property {string} provider
|
|
236
|
+
* @property {Association} association
|
|
237
|
+
* @property {Object} [custom_headers]
|
|
238
|
+
* @property {SubscriberStatus} status
|
|
239
|
+
* @property {string} email_id
|
|
240
|
+
* @property {AuthMeta} [auth_meta]
|
|
241
|
+
* @property {Events[]} events
|
|
322
242
|
*/
|
|
323
243
|
|
|
324
244
|
/**
|
|
325
|
-
* @typedef
|
|
326
|
-
* @property {
|
|
327
|
-
* @property {string} [name]
|
|
328
|
-
* @property {string} [
|
|
245
|
+
* @typedef SubscriberConfigUpdateRequestV2
|
|
246
|
+
* @property {number} id
|
|
247
|
+
* @property {string} [name]
|
|
248
|
+
* @property {string} [type]
|
|
249
|
+
* @property {string} [webhook_url]
|
|
250
|
+
* @property {string} provider
|
|
329
251
|
* @property {Association} [association]
|
|
330
|
-
* @property {
|
|
252
|
+
* @property {Object} [custom_headers]
|
|
253
|
+
* @property {SubscriberStatus} status
|
|
254
|
+
* @property {string} [email_id]
|
|
255
|
+
* @property {AuthMeta} [auth_meta]
|
|
256
|
+
* @property {Events[]} [events]
|
|
257
|
+
*/
|
|
258
|
+
|
|
259
|
+
/**
|
|
260
|
+
* @typedef SubscriberConfigPost
|
|
261
|
+
* @property {string} name
|
|
262
|
+
* @property {string} [type]
|
|
263
|
+
* @property {string} webhook_url
|
|
264
|
+
* @property {Association} association
|
|
265
|
+
* @property {Object} [custom_headers]
|
|
266
|
+
* @property {SubscriberStatus} status
|
|
267
|
+
* @property {string} email_id
|
|
268
|
+
* @property {AuthMeta} [auth_meta]
|
|
269
|
+
* @property {number[]} event_id
|
|
270
|
+
*/
|
|
271
|
+
|
|
272
|
+
/**
|
|
273
|
+
* @typedef SubscriberConfigUpdate
|
|
274
|
+
* @property {number} id
|
|
275
|
+
* @property {string} [name]
|
|
276
|
+
* @property {string} [type]
|
|
277
|
+
* @property {string} [webhook_url]
|
|
278
|
+
* @property {Association} [association]
|
|
279
|
+
* @property {Object} [custom_headers]
|
|
280
|
+
* @property {SubscriberStatus} [status]
|
|
281
|
+
* @property {string} [email_id]
|
|
282
|
+
* @property {AuthMeta} [auth_meta]
|
|
283
|
+
* @property {number[]} event_id
|
|
331
284
|
*/
|
|
332
285
|
|
|
333
286
|
/**
|
|
334
|
-
* @typedef
|
|
335
|
-
* @property {
|
|
287
|
+
* @typedef SubscriberConfigResponse
|
|
288
|
+
* @property {number} [id]
|
|
289
|
+
* @property {string} [modified_by]
|
|
290
|
+
* @property {string} [name]
|
|
291
|
+
* @property {string} [webhook_url]
|
|
292
|
+
* @property {string} [provider]
|
|
293
|
+
* @property {AssociationResp} [association]
|
|
294
|
+
* @property {Object} [custom_headers]
|
|
295
|
+
* @property {SubscriberStatus} [status]
|
|
296
|
+
* @property {string} [email_id]
|
|
297
|
+
* @property {string} [updated_on]
|
|
298
|
+
* @property {string} [created_on]
|
|
299
|
+
* @property {string} [type]
|
|
300
|
+
* @property {AuthMeta} [auth_meta]
|
|
301
|
+
* @property {number[]} [event_id]
|
|
336
302
|
*/
|
|
337
303
|
|
|
338
304
|
/**
|
|
339
|
-
* @typedef
|
|
340
|
-
* @property {
|
|
341
|
-
*
|
|
342
|
-
* @property {string} [message] - A message providing details about the upsert
|
|
343
|
-
* operation result.
|
|
305
|
+
* @typedef SubscriberConfigList
|
|
306
|
+
* @property {SubscriberResponse[]} [items]
|
|
307
|
+
* @property {Page} [page]
|
|
344
308
|
*/
|
|
345
309
|
|
|
346
310
|
/** @typedef {"active" | "inactive"} SubscriberStatus */
|
|
347
311
|
|
|
348
312
|
class WebhookPlatformModel {
|
|
313
|
+
/** @returns {Event} */
|
|
314
|
+
static Event() {
|
|
315
|
+
return Joi.object({
|
|
316
|
+
event_name: Joi.string().allow(""),
|
|
317
|
+
event_type: Joi.string().allow(""),
|
|
318
|
+
event_category: Joi.string().allow(""),
|
|
319
|
+
version: Joi.string().allow(""),
|
|
320
|
+
});
|
|
321
|
+
}
|
|
322
|
+
|
|
323
|
+
/** @returns {EventProcessRequest} */
|
|
324
|
+
static EventProcessRequest() {
|
|
325
|
+
return Joi.object({
|
|
326
|
+
search_text: Joi.string().allow(""),
|
|
327
|
+
end_date: Joi.string().allow("").required(),
|
|
328
|
+
start_date: Joi.string().allow("").required(),
|
|
329
|
+
subscriber_ids: Joi.array().items(Joi.number()),
|
|
330
|
+
status: Joi.string().allow(""),
|
|
331
|
+
event: Joi.array().items(WebhookPlatformModel.Event()),
|
|
332
|
+
});
|
|
333
|
+
}
|
|
334
|
+
|
|
335
|
+
/** @returns {DownloadReportResponse} */
|
|
336
|
+
static DownloadReportResponse() {
|
|
337
|
+
return Joi.object({
|
|
338
|
+
file_name: Joi.string().allow(""),
|
|
339
|
+
});
|
|
340
|
+
}
|
|
341
|
+
|
|
342
|
+
/** @returns {EventProcessReports} */
|
|
343
|
+
static EventProcessReports() {
|
|
344
|
+
return Joi.object({
|
|
345
|
+
rows: Joi.array().items(WebhookPlatformModel.EventProcessReportObject()),
|
|
346
|
+
page: WebhookPlatformModel.Page(),
|
|
347
|
+
});
|
|
348
|
+
}
|
|
349
|
+
|
|
350
|
+
/** @returns {EventProcessReportObject} */
|
|
351
|
+
static EventProcessReportObject() {
|
|
352
|
+
return Joi.object({
|
|
353
|
+
event_name: Joi.string().allow(""),
|
|
354
|
+
response_code: Joi.number(),
|
|
355
|
+
response_message: Joi.string().allow(""),
|
|
356
|
+
data: Joi.string().allow(""),
|
|
357
|
+
attempt: Joi.number(),
|
|
358
|
+
last_attempted_on: Joi.number(),
|
|
359
|
+
status: Joi.string().allow(""),
|
|
360
|
+
name: Joi.string().allow(""),
|
|
361
|
+
webhook_url: Joi.string().allow(""),
|
|
362
|
+
response_time: Joi.number(),
|
|
363
|
+
message_id: Joi.string().allow(""),
|
|
364
|
+
event_trace_id: Joi.string().allow(""),
|
|
365
|
+
});
|
|
366
|
+
}
|
|
367
|
+
|
|
349
368
|
/** @returns {Page} */
|
|
350
369
|
static Page() {
|
|
351
370
|
return Joi.object({
|
|
@@ -356,19 +375,26 @@ class WebhookPlatformModel {
|
|
|
356
375
|
current: Joi.number(),
|
|
357
376
|
type: Joi.string().allow("").required(),
|
|
358
377
|
size: Joi.number(),
|
|
378
|
+
total: Joi.number(),
|
|
359
379
|
});
|
|
360
380
|
}
|
|
361
381
|
|
|
362
|
-
/** @returns {
|
|
363
|
-
static
|
|
382
|
+
/** @returns {PingWebhook} */
|
|
383
|
+
static PingWebhook() {
|
|
364
384
|
return Joi.object({
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
385
|
+
webhook_url: Joi.string().allow("").required(),
|
|
386
|
+
auth_meta: Joi.any(),
|
|
387
|
+
custom_headers: Joi.any(),
|
|
388
|
+
});
|
|
389
|
+
}
|
|
390
|
+
|
|
391
|
+
/** @returns {PingWebhookResponse} */
|
|
392
|
+
static PingWebhookResponse() {
|
|
393
|
+
return Joi.object({
|
|
394
|
+
status: Joi.string().allow(""),
|
|
395
|
+
message: Joi.string().allow(""),
|
|
396
|
+
code: Joi.number(),
|
|
397
|
+
});
|
|
372
398
|
}
|
|
373
399
|
|
|
374
400
|
/** @returns {SubscriberEventMapping} */
|
|
@@ -377,32 +403,18 @@ class WebhookPlatformModel {
|
|
|
377
403
|
id: Joi.number(),
|
|
378
404
|
event_id: Joi.number(),
|
|
379
405
|
subscriber_id: Joi.number(),
|
|
380
|
-
|
|
381
|
-
reducer: Joi.object().pattern(/\S/, Joi.any()).allow(null, ""),
|
|
382
|
-
broadcaster_config: WebhookPlatformModel.BroadcasterConfig(),
|
|
406
|
+
topic: Joi.string().allow("").allow(null),
|
|
383
407
|
created_on: Joi.string().allow(""),
|
|
384
408
|
});
|
|
385
409
|
}
|
|
386
410
|
|
|
387
|
-
/** @returns {FilterSchema} */
|
|
388
|
-
static FilterSchema() {
|
|
389
|
-
return Joi.object({
|
|
390
|
-
query: Joi.string().allow(""),
|
|
391
|
-
condition: Joi.string().allow(""),
|
|
392
|
-
logic: Joi.string().allow(""),
|
|
393
|
-
conditions: Joi.array().items(Joi.object().pattern(/\S/, Joi.any())),
|
|
394
|
-
}).allow(null);
|
|
395
|
-
}
|
|
396
|
-
|
|
397
411
|
/** @returns {EventConfig} */
|
|
398
412
|
static EventConfig() {
|
|
399
413
|
return Joi.object({
|
|
400
414
|
id: Joi.number(),
|
|
401
|
-
type: Joi.string().allow("").allow(null),
|
|
402
415
|
event_name: Joi.string().allow(""),
|
|
403
416
|
event_type: Joi.string().allow(""),
|
|
404
417
|
event_category: Joi.string().allow(""),
|
|
405
|
-
modified_by: Joi.string().allow(""),
|
|
406
418
|
subscriber_event_mapping: WebhookPlatformModel.SubscriberEventMapping(),
|
|
407
419
|
event_schema: Joi.object().pattern(/\S/, Joi.any()).allow(null, ""),
|
|
408
420
|
group: Joi.string().allow("").allow(null),
|
|
@@ -414,13 +426,110 @@ class WebhookPlatformModel {
|
|
|
414
426
|
});
|
|
415
427
|
}
|
|
416
428
|
|
|
417
|
-
/** @returns {
|
|
418
|
-
static
|
|
429
|
+
/** @returns {EventConfigResponse} */
|
|
430
|
+
static EventConfigResponse() {
|
|
419
431
|
return Joi.object({
|
|
420
432
|
event_configs: Joi.array().items(WebhookPlatformModel.EventConfig()),
|
|
421
433
|
});
|
|
422
434
|
}
|
|
423
435
|
|
|
436
|
+
/** @returns {ReportFiltersPayload} */
|
|
437
|
+
static ReportFiltersPayload() {
|
|
438
|
+
return Joi.object({
|
|
439
|
+
subscriber_ids: Joi.array().items(Joi.number()).required(),
|
|
440
|
+
});
|
|
441
|
+
}
|
|
442
|
+
|
|
443
|
+
/** @returns {ReportFilterResponse} */
|
|
444
|
+
static ReportFilterResponse() {
|
|
445
|
+
return Joi.object({
|
|
446
|
+
filter_name: Joi.string().allow(""),
|
|
447
|
+
values: Joi.array().items(Joi.object().pattern(/\S/, Joi.any())),
|
|
448
|
+
});
|
|
449
|
+
}
|
|
450
|
+
|
|
451
|
+
/** @returns {HistoryPayload} */
|
|
452
|
+
static HistoryPayload() {
|
|
453
|
+
return Joi.object({
|
|
454
|
+
type: Joi.string().allow("").required(),
|
|
455
|
+
page_no: Joi.number(),
|
|
456
|
+
page_size: Joi.number(),
|
|
457
|
+
});
|
|
458
|
+
}
|
|
459
|
+
|
|
460
|
+
/** @returns {HistoryFilters} */
|
|
461
|
+
static HistoryFilters() {
|
|
462
|
+
return Joi.object({
|
|
463
|
+
events: Joi.array().items(Joi.string().allow("")),
|
|
464
|
+
search_text: Joi.string().allow(""),
|
|
465
|
+
status: Joi.string().allow(""),
|
|
466
|
+
end_date: Joi.string().allow(""),
|
|
467
|
+
start_date: Joi.string().allow(""),
|
|
468
|
+
subscribers: Joi.array().items(Joi.number()),
|
|
469
|
+
webhook_type: Joi.array().items(Joi.string().allow("")),
|
|
470
|
+
});
|
|
471
|
+
}
|
|
472
|
+
|
|
473
|
+
/** @returns {Url} */
|
|
474
|
+
static Url() {
|
|
475
|
+
return Joi.object({
|
|
476
|
+
url: Joi.string().allow(""),
|
|
477
|
+
name: Joi.string().allow(""),
|
|
478
|
+
});
|
|
479
|
+
}
|
|
480
|
+
|
|
481
|
+
/** @returns {CdnObject} */
|
|
482
|
+
static CdnObject() {
|
|
483
|
+
return Joi.object({
|
|
484
|
+
urls: Joi.array().items(WebhookPlatformModel.Url()),
|
|
485
|
+
});
|
|
486
|
+
}
|
|
487
|
+
|
|
488
|
+
/** @returns {UploadServiceObject} */
|
|
489
|
+
static UploadServiceObject() {
|
|
490
|
+
return Joi.object({
|
|
491
|
+
cdn: WebhookPlatformModel.CdnObject(),
|
|
492
|
+
}).allow(null);
|
|
493
|
+
}
|
|
494
|
+
|
|
495
|
+
/** @returns {HistoryAssociation} */
|
|
496
|
+
static HistoryAssociation() {
|
|
497
|
+
return Joi.object({
|
|
498
|
+
company_id: Joi.number(),
|
|
499
|
+
subscriber_ids: Joi.array().items(Joi.number()),
|
|
500
|
+
});
|
|
501
|
+
}
|
|
502
|
+
|
|
503
|
+
/** @returns {HistoryItems} */
|
|
504
|
+
static HistoryItems() {
|
|
505
|
+
return Joi.object({
|
|
506
|
+
id: Joi.number(),
|
|
507
|
+
association: WebhookPlatformModel.HistoryAssociation(),
|
|
508
|
+
filters: WebhookPlatformModel.HistoryFilters(),
|
|
509
|
+
filename: Joi.string().allow(""),
|
|
510
|
+
status: Joi.string().allow(""),
|
|
511
|
+
upload_service_response: WebhookPlatformModel.UploadServiceObject(),
|
|
512
|
+
created_on: Joi.string().allow(""),
|
|
513
|
+
updated_on: Joi.string().allow("").allow(null),
|
|
514
|
+
message: Joi.string().allow(""),
|
|
515
|
+
});
|
|
516
|
+
}
|
|
517
|
+
|
|
518
|
+
/** @returns {HistoryResponse} */
|
|
519
|
+
static HistoryResponse() {
|
|
520
|
+
return Joi.object({
|
|
521
|
+
items: Joi.array().items(WebhookPlatformModel.HistoryItems()),
|
|
522
|
+
page: WebhookPlatformModel.Page(),
|
|
523
|
+
});
|
|
524
|
+
}
|
|
525
|
+
|
|
526
|
+
/** @returns {CancelResponse} */
|
|
527
|
+
static CancelResponse() {
|
|
528
|
+
return Joi.object({
|
|
529
|
+
message: Joi.string().allow(""),
|
|
530
|
+
});
|
|
531
|
+
}
|
|
532
|
+
|
|
424
533
|
/** @returns {Association} */
|
|
425
534
|
static Association() {
|
|
426
535
|
return Joi.object({
|
|
@@ -448,8 +557,8 @@ class WebhookPlatformModel {
|
|
|
448
557
|
});
|
|
449
558
|
}
|
|
450
559
|
|
|
451
|
-
/** @returns {
|
|
452
|
-
static
|
|
560
|
+
/** @returns {SubscriberResponse} */
|
|
561
|
+
static SubscriberResponse() {
|
|
453
562
|
return Joi.object({
|
|
454
563
|
id: Joi.number(),
|
|
455
564
|
modified_by: Joi.string().allow(""),
|
|
@@ -457,7 +566,7 @@ class WebhookPlatformModel {
|
|
|
457
566
|
provider: Joi.string().allow(""),
|
|
458
567
|
webhook_url: Joi.string().allow(""),
|
|
459
568
|
association: WebhookPlatformModel.AssociationResp(),
|
|
460
|
-
custom_headers: Joi.
|
|
569
|
+
custom_headers: Joi.any(),
|
|
461
570
|
status: WebhookPlatformModel.SubscriberStatus(),
|
|
462
571
|
email_id: Joi.string().allow(""),
|
|
463
572
|
updated_on: Joi.string().allow(""),
|
|
@@ -473,10 +582,6 @@ class WebhookPlatformModel {
|
|
|
473
582
|
return Joi.object({
|
|
474
583
|
slug: Joi.string().allow(""),
|
|
475
584
|
topic: Joi.string().allow(""),
|
|
476
|
-
queue: Joi.string().allow(""),
|
|
477
|
-
event_bridge_name: Joi.string().allow(""),
|
|
478
|
-
workflow_name: Joi.string().allow(""),
|
|
479
|
-
detail_type: Joi.string().allow(""),
|
|
480
585
|
});
|
|
481
586
|
}
|
|
482
587
|
|
|
@@ -488,7 +593,7 @@ class WebhookPlatformModel {
|
|
|
488
593
|
webhook_url: Joi.string().allow(""),
|
|
489
594
|
provider: Joi.string().allow("").required(),
|
|
490
595
|
association: WebhookPlatformModel.Association().required(),
|
|
491
|
-
custom_headers: Joi.
|
|
596
|
+
custom_headers: Joi.any(),
|
|
492
597
|
status: WebhookPlatformModel.SubscriberStatus().required(),
|
|
493
598
|
email_id: Joi.string().allow("").required(),
|
|
494
599
|
auth_meta: WebhookPlatformModel.AuthMeta(),
|
|
@@ -505,7 +610,7 @@ class WebhookPlatformModel {
|
|
|
505
610
|
webhook_url: Joi.string().allow(""),
|
|
506
611
|
provider: Joi.string().allow("").required(),
|
|
507
612
|
association: WebhookPlatformModel.Association(),
|
|
508
|
-
custom_headers: Joi.
|
|
613
|
+
custom_headers: Joi.any(),
|
|
509
614
|
status: WebhookPlatformModel.SubscriberStatus().required(),
|
|
510
615
|
email_id: Joi.string().allow(""),
|
|
511
616
|
auth_meta: WebhookPlatformModel.AuthMeta(),
|
|
@@ -520,7 +625,7 @@ class WebhookPlatformModel {
|
|
|
520
625
|
type: Joi.string().allow("").allow(null),
|
|
521
626
|
webhook_url: Joi.string().allow("").required(),
|
|
522
627
|
association: WebhookPlatformModel.Association().required(),
|
|
523
|
-
custom_headers: Joi.
|
|
628
|
+
custom_headers: Joi.any(),
|
|
524
629
|
status: WebhookPlatformModel.SubscriberStatus().required(),
|
|
525
630
|
email_id: Joi.string().allow("").required(),
|
|
526
631
|
auth_meta: WebhookPlatformModel.AuthMeta(),
|
|
@@ -536,7 +641,7 @@ class WebhookPlatformModel {
|
|
|
536
641
|
type: Joi.string().allow("").allow(null),
|
|
537
642
|
webhook_url: Joi.string().allow(""),
|
|
538
643
|
association: WebhookPlatformModel.Association(),
|
|
539
|
-
custom_headers: Joi.
|
|
644
|
+
custom_headers: Joi.any(),
|
|
540
645
|
status: WebhookPlatformModel.SubscriberStatus(),
|
|
541
646
|
email_id: Joi.string().allow(""),
|
|
542
647
|
auth_meta: WebhookPlatformModel.AuthMeta(),
|
|
@@ -544,8 +649,8 @@ class WebhookPlatformModel {
|
|
|
544
649
|
});
|
|
545
650
|
}
|
|
546
651
|
|
|
547
|
-
/** @returns {
|
|
548
|
-
static
|
|
652
|
+
/** @returns {SubscriberConfigResponse} */
|
|
653
|
+
static SubscriberConfigResponse() {
|
|
549
654
|
return Joi.object({
|
|
550
655
|
id: Joi.number(),
|
|
551
656
|
modified_by: Joi.string().allow(""),
|
|
@@ -553,7 +658,7 @@ class WebhookPlatformModel {
|
|
|
553
658
|
webhook_url: Joi.string().allow(""),
|
|
554
659
|
provider: Joi.string().allow(""),
|
|
555
660
|
association: WebhookPlatformModel.AssociationResp(),
|
|
556
|
-
custom_headers: Joi.
|
|
661
|
+
custom_headers: Joi.any(),
|
|
557
662
|
status: WebhookPlatformModel.SubscriberStatus(),
|
|
558
663
|
email_id: Joi.string().allow(""),
|
|
559
664
|
updated_on: Joi.string().allow(""),
|
|
@@ -567,165 +672,11 @@ class WebhookPlatformModel {
|
|
|
567
672
|
/** @returns {SubscriberConfigList} */
|
|
568
673
|
static SubscriberConfigList() {
|
|
569
674
|
return Joi.object({
|
|
570
|
-
items: Joi.array().items(WebhookPlatformModel.
|
|
675
|
+
items: Joi.array().items(WebhookPlatformModel.SubscriberResponse()),
|
|
571
676
|
page: WebhookPlatformModel.Page(),
|
|
572
677
|
});
|
|
573
678
|
}
|
|
574
679
|
|
|
575
|
-
/** @returns {RestEventData} */
|
|
576
|
-
static RestEventData() {
|
|
577
|
-
return Joi.object({
|
|
578
|
-
event_category: Joi.string().allow("").required(),
|
|
579
|
-
event_name: Joi.string().allow("").required(),
|
|
580
|
-
event_type: Joi.string().allow("").required(),
|
|
581
|
-
version: Joi.number().required(),
|
|
582
|
-
});
|
|
583
|
-
}
|
|
584
|
-
|
|
585
|
-
/** @returns {RestConfig} */
|
|
586
|
-
static RestConfig() {
|
|
587
|
-
return Joi.object({
|
|
588
|
-
webhook_url: Joi.string().allow("").required(),
|
|
589
|
-
type: Joi.string().allow("").required(),
|
|
590
|
-
custom_headers: Joi.object().pattern(/\S/, Joi.any()),
|
|
591
|
-
auth_meta: WebhookPlatformModel.AuthMeta(),
|
|
592
|
-
events: Joi.array()
|
|
593
|
-
.items(WebhookPlatformModel.RestEventData())
|
|
594
|
-
.required(),
|
|
595
|
-
});
|
|
596
|
-
}
|
|
597
|
-
|
|
598
|
-
/** @returns {QueueEventData} */
|
|
599
|
-
static QueueEventData() {
|
|
600
|
-
return Joi.object({
|
|
601
|
-
event_category: Joi.string().allow("").required(),
|
|
602
|
-
event_name: Joi.string().allow("").required(),
|
|
603
|
-
event_type: Joi.string().allow("").required(),
|
|
604
|
-
version: Joi.number().required(),
|
|
605
|
-
topic: Joi.string().allow("").required(),
|
|
606
|
-
});
|
|
607
|
-
}
|
|
608
|
-
|
|
609
|
-
/** @returns {KafkaConfig} */
|
|
610
|
-
static KafkaConfig() {
|
|
611
|
-
return Joi.object({
|
|
612
|
-
type: Joi.string().allow("").allow(null),
|
|
613
|
-
events: Joi.array()
|
|
614
|
-
.items(WebhookPlatformModel.QueueEventData())
|
|
615
|
-
.required(),
|
|
616
|
-
});
|
|
617
|
-
}
|
|
618
|
-
|
|
619
|
-
/** @returns {PubSubConfig} */
|
|
620
|
-
static PubSubConfig() {
|
|
621
|
-
return Joi.object({
|
|
622
|
-
type: Joi.string().allow("").allow(null),
|
|
623
|
-
events: Joi.array()
|
|
624
|
-
.items(WebhookPlatformModel.QueueEventData())
|
|
625
|
-
.required(),
|
|
626
|
-
});
|
|
627
|
-
}
|
|
628
|
-
|
|
629
|
-
/** @returns {TemporalEventData} */
|
|
630
|
-
static TemporalEventData() {
|
|
631
|
-
return Joi.object({
|
|
632
|
-
event_category: Joi.string().allow("").required(),
|
|
633
|
-
event_name: Joi.string().allow("").required(),
|
|
634
|
-
event_type: Joi.string().allow("").required(),
|
|
635
|
-
version: Joi.number().required(),
|
|
636
|
-
queue: Joi.string().allow(""),
|
|
637
|
-
workflow_name: Joi.string().allow(""),
|
|
638
|
-
});
|
|
639
|
-
}
|
|
640
|
-
|
|
641
|
-
/** @returns {TemporalConfig} */
|
|
642
|
-
static TemporalConfig() {
|
|
643
|
-
return Joi.object({
|
|
644
|
-
type: Joi.string().allow("").allow(null),
|
|
645
|
-
events: Joi.array()
|
|
646
|
-
.items(WebhookPlatformModel.TemporalEventData())
|
|
647
|
-
.required(),
|
|
648
|
-
});
|
|
649
|
-
}
|
|
650
|
-
|
|
651
|
-
/** @returns {SqsEventData} */
|
|
652
|
-
static SqsEventData() {
|
|
653
|
-
return Joi.object({
|
|
654
|
-
event_category: Joi.string().allow("").required(),
|
|
655
|
-
event_name: Joi.string().allow("").required(),
|
|
656
|
-
event_type: Joi.string().allow("").required(),
|
|
657
|
-
version: Joi.number().required(),
|
|
658
|
-
queue: Joi.string().allow(""),
|
|
659
|
-
});
|
|
660
|
-
}
|
|
661
|
-
|
|
662
|
-
/** @returns {SqsConfig} */
|
|
663
|
-
static SqsConfig() {
|
|
664
|
-
return Joi.object({
|
|
665
|
-
type: Joi.string().allow("").allow(null),
|
|
666
|
-
events: Joi.array().items(WebhookPlatformModel.SqsEventData()).required(),
|
|
667
|
-
});
|
|
668
|
-
}
|
|
669
|
-
|
|
670
|
-
/** @returns {EventBridgeData} */
|
|
671
|
-
static EventBridgeData() {
|
|
672
|
-
return Joi.object({
|
|
673
|
-
event_category: Joi.string().allow("").required(),
|
|
674
|
-
event_name: Joi.string().allow("").required(),
|
|
675
|
-
event_type: Joi.string().allow("").required(),
|
|
676
|
-
version: Joi.number().required(),
|
|
677
|
-
event_bridge_name: Joi.string().allow(""),
|
|
678
|
-
});
|
|
679
|
-
}
|
|
680
|
-
|
|
681
|
-
/** @returns {EventBridgeConfig} */
|
|
682
|
-
static EventBridgeConfig() {
|
|
683
|
-
return Joi.object({
|
|
684
|
-
type: Joi.string().allow("").allow(null),
|
|
685
|
-
events: Joi.array()
|
|
686
|
-
.items(WebhookPlatformModel.EventBridgeData())
|
|
687
|
-
.required(),
|
|
688
|
-
});
|
|
689
|
-
}
|
|
690
|
-
|
|
691
|
-
/** @returns {EventMapBody} */
|
|
692
|
-
static EventMapBody() {
|
|
693
|
-
return Joi.object({
|
|
694
|
-
rest: WebhookPlatformModel.RestConfig(),
|
|
695
|
-
kafka: WebhookPlatformModel.KafkaConfig(),
|
|
696
|
-
pub_sub: WebhookPlatformModel.PubSubConfig(),
|
|
697
|
-
temporal: WebhookPlatformModel.TemporalConfig(),
|
|
698
|
-
sqs: WebhookPlatformModel.SqsConfig(),
|
|
699
|
-
event_bridge: WebhookPlatformModel.EventBridgeConfig(),
|
|
700
|
-
});
|
|
701
|
-
}
|
|
702
|
-
|
|
703
|
-
/** @returns {WebhookConfig} */
|
|
704
|
-
static WebhookConfig() {
|
|
705
|
-
return Joi.object({
|
|
706
|
-
notification_email: Joi.string().allow(""),
|
|
707
|
-
name: Joi.string().allow(""),
|
|
708
|
-
status: Joi.string().allow(""),
|
|
709
|
-
association: WebhookPlatformModel.Association(),
|
|
710
|
-
event_map: WebhookPlatformModel.EventMapBody(),
|
|
711
|
-
});
|
|
712
|
-
}
|
|
713
|
-
|
|
714
|
-
/** @returns {UpsertSubscriberConfig} */
|
|
715
|
-
static UpsertSubscriberConfig() {
|
|
716
|
-
return Joi.object({
|
|
717
|
-
webhook_config: WebhookPlatformModel.WebhookConfig().required(),
|
|
718
|
-
});
|
|
719
|
-
}
|
|
720
|
-
|
|
721
|
-
/** @returns {UpsertSubscriberConfigResult} */
|
|
722
|
-
static UpsertSubscriberConfigResult() {
|
|
723
|
-
return Joi.object({
|
|
724
|
-
status: Joi.boolean(),
|
|
725
|
-
message: Joi.string().allow(""),
|
|
726
|
-
});
|
|
727
|
-
}
|
|
728
|
-
|
|
729
680
|
/**
|
|
730
681
|
* Enum: SubscriberStatus Used By: Webhook
|
|
731
682
|
*
|