@gofynd/fdk-client-javascript 1.4.15-beta.1 → 1.4.15-beta.3
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 +2 -2
- package/application.d.ts +1 -2
- package/application.js +2 -3
- package/index.d.ts +1 -2
- package/index.js +7 -1
- package/package.json +2 -3
- package/sdk/application/ApplicationClient.d.ts +2 -0
- package/sdk/application/ApplicationClient.js +2 -18
- package/sdk/application/Cart/CartApplicationClient.d.ts +75 -90
- package/sdk/application/Cart/CartApplicationClient.js +111 -1200
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +81 -142
- package/sdk/application/Catalog/CatalogApplicationClient.js +41 -1344
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -8
- package/sdk/application/Common/CommonApplicationClient.js +2 -92
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -19
- package/sdk/application/Communication/CommunicationApplicationClient.js +3 -148
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -73
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +16 -727
- package/sdk/application/Content/ContentApplicationClient.d.ts +52 -95
- package/sdk/application/Content/ContentApplicationClient.js +46 -990
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +8 -13
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +8 -138
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +105 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +10 -18
- package/sdk/application/Lead/LeadApplicationClient.js +5 -217
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +42 -39
- package/sdk/application/Logistic/LogisticApplicationClient.js +89 -493
- package/sdk/application/Order/OrderApplicationClient.d.ts +36 -46
- package/sdk/application/Order/OrderApplicationClient.js +52 -507
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +93 -213
- package/sdk/application/Payment/PaymentApplicationClient.js +49 -2109
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +15 -29
- package/sdk/application/Rewards/RewardsApplicationClient.js +8 -312
- package/sdk/application/Share/ShareApplicationClient.d.ts +14 -24
- package/sdk/application/Share/ShareApplicationClient.js +7 -309
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -14
- package/sdk/application/Theme/ThemeApplicationClient.js +8 -176
- package/sdk/application/User/UserApplicationClient.d.ts +87 -138
- package/sdk/application/User/UserApplicationClient.js +44 -1820
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -7
- package/sdk/application/Webhook/WebhookApplicationClient.js +3 -52
- package/sdk/application/index.d.ts +0 -18
- package/sdk/application/index.js +0 -33
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +86 -12
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +582 -24
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +116 -19
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +121 -14
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +8 -1
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +51 -4
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
- package/sdk/partner/Lead/LeadPartnerClient.js +2 -2
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerModel.js +15 -15
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +126 -20
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +970 -20
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1200 -167
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +571 -160
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +10 -0
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +121 -7
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +8 -10
- package/sdk/partner/Theme/ThemePartnerClient.js +14 -16
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +96 -37
- package/sdk/partner/Theme/ThemePartnerModel.js +90 -36
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +28 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +103 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +612 -179
- package/sdk/partner/Webhook/WebhookPartnerModel.js +253 -150
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +1 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +11 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +5 -4
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +14 -8
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +59 -9
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +40 -4
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +2 -32
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -243
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +11 -130
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +12 -152
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
- package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
- package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +134 -103
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +419 -115
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +118 -65
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +109 -44
- package/sdk/platform/Cart/CartPlatformModel.d.ts +5067 -1300
- package/sdk/platform/Cart/CartPlatformModel.js +1988 -1217
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +209 -183
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +452 -395
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +185 -142
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +96 -78
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +154 -117
- package/sdk/platform/Catalog/CatalogPlatformClient.js +292 -172
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6506 -1775
- package/sdk/platform/Catalog/CatalogPlatformModel.js +3224 -1690
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +72 -31
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +50 -24
- package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -2
- package/sdk/platform/Common/CommonPlatformClient.js +3 -2
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +16 -17
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +16 -17
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +43 -33
- package/sdk/platform/Communication/CommunicationPlatformModel.js +38 -34
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +46 -42
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +47 -43
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +210 -212
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +46 -33
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +67 -54
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +45 -24
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +134 -30
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +283 -124
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +219 -94
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +124 -141
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +449 -422
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +179 -141
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +168 -130
- package/sdk/platform/Content/ContentPlatformClient.d.ts +142 -106
- package/sdk/platform/Content/ContentPlatformClient.js +523 -336
- package/sdk/platform/Content/ContentPlatformModel.d.ts +1241 -395
- package/sdk/platform/Content/ContentPlatformModel.js +521 -390
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +168 -117
- package/sdk/platform/Content/ContentPlatformValidator.js +162 -108
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +14 -12
- package/sdk/platform/Discount/DiscountPlatformClient.js +14 -12
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +13 -13
- package/sdk/platform/Discount/DiscountPlatformModel.js +12 -12
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +94 -36
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +462 -60
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +62 -15
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +75 -13
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +19 -19
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +21 -21
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +370 -101
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +313 -84
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +2 -2
- package/sdk/platform/Lead/LeadPlatformClient.js +2 -2
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -5
- package/sdk/platform/Lead/LeadPlatformModel.js +16 -16
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +17 -6
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +85 -7
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +95 -24
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +39 -19
- package/sdk/platform/Order/OrderPlatformClient.d.ts +153 -96
- package/sdk/platform/Order/OrderPlatformClient.js +416 -198
- package/sdk/platform/Order/OrderPlatformModel.d.ts +7602 -1269
- package/sdk/platform/Order/OrderPlatformModel.js +3926 -1269
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +270 -109
- package/sdk/platform/Order/OrderPlatformValidator.js +135 -77
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +9 -7
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
- package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +93 -105
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +129 -141
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +48 -48
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +48 -48
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
- package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +333 -319
- package/sdk/platform/Payment/PaymentPlatformModel.js +288 -278
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
- package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
- package/sdk/platform/PlatformClient.d.ts +0 -2
- package/sdk/platform/PlatformClient.js +0 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +9 -9
- package/sdk/platform/Rewards/RewardsPlatformModel.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +46 -36
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +132 -41
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +46 -17
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +34 -14
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +40 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +58 -64
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1893 -623
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +924 -568
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +42 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +26 -28
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.js +2 -2
- package/sdk/platform/Share/SharePlatformModel.d.ts +36 -5
- package/sdk/platform/Share/SharePlatformModel.js +27 -4
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +8 -4
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +5 -0
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +2 -0
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +37 -11
- package/sdk/platform/Theme/ThemePlatformModel.js +33 -15
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/User/UserPlatformApplicationClient.js +12 -12
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/User/UserPlatformApplicationValidator.js +2 -2
- package/sdk/platform/User/UserPlatformModel.d.ts +21 -21
- package/sdk/platform/User/UserPlatformModel.js +23 -23
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +25 -78
- package/sdk/platform/Webhook/WebhookPlatformClient.js +75 -470
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +720 -427
- package/sdk/platform/Webhook/WebhookPlatformModel.js +410 -386
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
- package/sdk/platform/index.d.ts +0 -1
- package/sdk/platform/index.js +0 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +3 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +10 -7
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
- package/sdk/public/Content/ContentPublicClient.d.ts +112 -2
- package/sdk/public/Content/ContentPublicClient.js +795 -7
- package/sdk/public/Content/ContentPublicModel.d.ts +549 -3
- package/sdk/public/Content/ContentPublicModel.js +649 -3
- package/sdk/public/Content/ContentPublicValidator.d.ts +69 -3
- package/sdk/public/Content/ContentPublicValidator.js +88 -2
- package/sdk/public/Partner/PartnerPublicClient.js +4 -2
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +12 -10
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +21 -21
- package/sdk/public/Webhook/WebhookPublicModel.js +15 -15
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/application/Cart/CartApplicationModel.d.ts +0 -3994
- package/sdk/application/Cart/CartApplicationModel.js +0 -2497
- package/sdk/application/Cart/CartApplicationValidator.d.ts +0 -769
- package/sdk/application/Cart/CartApplicationValidator.js +0 -530
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +0 -3857
- package/sdk/application/Catalog/CatalogApplicationModel.js +0 -2629
- package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +0 -791
- package/sdk/application/Catalog/CatalogApplicationValidator.js +0 -551
- package/sdk/application/Common/CommonApplicationModel.d.ts +0 -449
- package/sdk/application/Common/CommonApplicationModel.js +0 -308
- package/sdk/application/Common/CommonApplicationValidator.d.ts +0 -46
- package/sdk/application/Common/CommonApplicationValidator.js +0 -38
- package/sdk/application/Communication/CommunicationApplicationModel.d.ts +0 -293
- package/sdk/application/Communication/CommunicationApplicationModel.js +0 -201
- package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +0 -29
- package/sdk/application/Communication/CommunicationApplicationValidator.js +0 -38
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +0 -2556
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +0 -1887
- package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +0 -179
- package/sdk/application/Configuration/ConfigurationApplicationValidator.js +0 -176
- package/sdk/application/Content/ContentApplicationModel.d.ts +0 -2133
- package/sdk/application/Content/ContentApplicationModel.js +0 -1589
- package/sdk/application/Content/ContentApplicationValidator.d.ts +0 -284
- package/sdk/application/Content/ContentApplicationValidator.js +0 -264
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +0 -272
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +0 -190
- package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +0 -56
- package/sdk/application/FileStorage/FileStorageApplicationValidator.js +0 -53
- package/sdk/application/Lead/LeadApplicationModel.d.ts +0 -590
- package/sdk/application/Lead/LeadApplicationModel.js +0 -480
- package/sdk/application/Lead/LeadApplicationValidator.d.ts +0 -68
- package/sdk/application/Lead/LeadApplicationValidator.js +0 -71
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +0 -1675
- package/sdk/application/Logistic/LogisticApplicationModel.js +0 -1121
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +0 -254
- package/sdk/application/Logistic/LogisticApplicationValidator.js +0 -190
- package/sdk/application/Order/OrderApplicationModel.d.ts +0 -2296
- package/sdk/application/Order/OrderApplicationModel.js +0 -1471
- package/sdk/application/Order/OrderApplicationValidator.d.ts +0 -265
- package/sdk/application/Order/OrderApplicationValidator.js +0 -197
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +0 -4058
- package/sdk/application/Payment/PaymentApplicationModel.js +0 -2630
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +0 -576
- package/sdk/application/Payment/PaymentApplicationValidator.js +0 -594
- package/sdk/application/Rewards/RewardsApplicationModel.d.ts +0 -365
- package/sdk/application/Rewards/RewardsApplicationModel.js +0 -396
- package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +0 -73
- package/sdk/application/Rewards/RewardsApplicationValidator.js +0 -84
- package/sdk/application/Share/ShareApplicationModel.d.ts +0 -339
- package/sdk/application/Share/ShareApplicationModel.js +0 -234
- package/sdk/application/Share/ShareApplicationValidator.d.ts +0 -90
- package/sdk/application/Share/ShareApplicationValidator.js +0 -91
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +0 -1713
- package/sdk/application/Theme/ThemeApplicationModel.js +0 -1426
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +0 -66
- package/sdk/application/Theme/ThemeApplicationValidator.js +0 -58
- package/sdk/application/User/UserApplicationModel.d.ts +0 -1943
- package/sdk/application/User/UserApplicationModel.js +0 -1382
- package/sdk/application/User/UserApplicationValidator.d.ts +0 -560
- package/sdk/application/User/UserApplicationValidator.js +0 -573
- package/sdk/application/Webhook/WebhookApplicationModel.d.ts +0 -52
- package/sdk/application/Webhook/WebhookApplicationModel.js +0 -46
- package/sdk/application/Webhook/WebhookApplicationValidator.d.ts +0 -16
- package/sdk/application/Webhook/WebhookApplicationValidator.js +0 -19
- package/sdk/common/Clickstream.d.ts +0 -1
- package/sdk/common/Clickstream.js +0 -464
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
- package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2890
- package/sdk/platform/Finance/FinancePlatformModel.js +0 -2148
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
- package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
|
@@ -1,44 +1,4 @@
|
|
|
1
1
|
export = WebhookPlatformModel;
|
|
2
|
-
/**
|
|
3
|
-
* @typedef Event
|
|
4
|
-
* @property {string} [event_name]
|
|
5
|
-
* @property {string} [event_type]
|
|
6
|
-
* @property {string} [event_category]
|
|
7
|
-
* @property {string} [version]
|
|
8
|
-
*/
|
|
9
|
-
/**
|
|
10
|
-
* @typedef EventProcessRequest
|
|
11
|
-
* @property {string} [search_text]
|
|
12
|
-
* @property {string} end_date
|
|
13
|
-
* @property {string} start_date
|
|
14
|
-
* @property {number[]} [subscriber_ids]
|
|
15
|
-
* @property {string} [status]
|
|
16
|
-
* @property {Event[]} [event]
|
|
17
|
-
*/
|
|
18
|
-
/**
|
|
19
|
-
* @typedef DownloadReportResponse
|
|
20
|
-
* @property {string} [file_name]
|
|
21
|
-
*/
|
|
22
|
-
/**
|
|
23
|
-
* @typedef EventProcessReports
|
|
24
|
-
* @property {EventProcessReportObject[]} [rows]
|
|
25
|
-
* @property {Page} [page]
|
|
26
|
-
*/
|
|
27
|
-
/**
|
|
28
|
-
* @typedef EventProcessReportObject
|
|
29
|
-
* @property {string} [event_name] - The name of the processed event.
|
|
30
|
-
* @property {number} [response_code] - The response code of the event.
|
|
31
|
-
* @property {string} [response_message] - The response message of the event.
|
|
32
|
-
* @property {string} [data] - The data associated with the event.
|
|
33
|
-
* @property {number} [attempt] - The attempt number of the event.
|
|
34
|
-
* @property {number} [last_attempted_on] - The timestamp of the last attempted event.
|
|
35
|
-
* @property {string} [status] - The status of the event (e.g., "FAILED").
|
|
36
|
-
* @property {string} [name] - The name of the event.
|
|
37
|
-
* @property {string} [webhook_url] - The webhook URL associated with the event.
|
|
38
|
-
* @property {number} [response_time] - The response time of the event.
|
|
39
|
-
* @property {string} [message_id]
|
|
40
|
-
* @property {string} [event_trace_id]
|
|
41
|
-
*/
|
|
42
2
|
/**
|
|
43
3
|
* @typedef Page
|
|
44
4
|
* @property {number} [item_total] - The total number of items on the page.
|
|
@@ -50,305 +10,290 @@ export = WebhookPlatformModel;
|
|
|
50
10
|
* @property {number} [size] - The number of items per page.
|
|
51
11
|
*/
|
|
52
12
|
/**
|
|
53
|
-
* @typedef
|
|
54
|
-
* @property {string}
|
|
55
|
-
* @property {
|
|
56
|
-
*
|
|
57
|
-
*
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
* @
|
|
61
|
-
* @property {string} [
|
|
62
|
-
*
|
|
63
|
-
* @property {number} [code] - The HTTP status code of the ping response (e.g., 200).
|
|
13
|
+
* @typedef BroadcasterConfig
|
|
14
|
+
* @property {string} [topic] - The name of the topic for the broadcaster configuration.
|
|
15
|
+
* @property {string} [queue] - The name of the queue for the broadcaster configuration.
|
|
16
|
+
* @property {string} [event_bridge_name] - The name of the event bridge
|
|
17
|
+
* associated with the broadcaster.
|
|
18
|
+
* @property {string} [workflow_name] - The name of the workflow related to the
|
|
19
|
+
* broadcaster.
|
|
20
|
+
* @property {string} [account_id] - The account ID associated with the broadcaster.
|
|
21
|
+
* @property {string} [detail_type] - The type of detail for the broadcaster
|
|
22
|
+
* configuration.
|
|
64
23
|
*/
|
|
65
24
|
/**
|
|
66
25
|
* @typedef SubscriberEventMapping
|
|
67
|
-
* @property {number} [id]
|
|
68
|
-
* @property {number} [event_id]
|
|
69
|
-
* @property {number} [subscriber_id]
|
|
70
|
-
* @property {
|
|
71
|
-
* @property {string} [created_on]
|
|
26
|
+
* @property {number} [id] - The unique identifier for the subscriber event mapping.
|
|
27
|
+
* @property {number} [event_id] - The ID of the event associated with the subscriber.
|
|
28
|
+
* @property {number} [subscriber_id] - The ID of the subscriber.
|
|
29
|
+
* @property {BroadcasterConfig} [broadcaster_config]
|
|
30
|
+
* @property {string} [created_on] - The date and time when the subscriber event
|
|
31
|
+
* mapping was created.
|
|
72
32
|
*/
|
|
73
33
|
/**
|
|
74
34
|
* @typedef EventConfig
|
|
75
|
-
* @property {number} [id]
|
|
76
|
-
* @property {string} [
|
|
77
|
-
* @property {string} [
|
|
78
|
-
* @property {string} [
|
|
35
|
+
* @property {number} [id] - The unique identifier for the event configuration.
|
|
36
|
+
* @property {string} [type] - The type of event configuration, which may be null.
|
|
37
|
+
* @property {string} [event_name] - The name of the event.
|
|
38
|
+
* @property {string} [event_type] - The type of the event.
|
|
39
|
+
* @property {string} [event_category] - The category of the event.
|
|
40
|
+
* @property {string} [modified_by] - The identifier of the user who last
|
|
41
|
+
* modified the event configuration.
|
|
79
42
|
* @property {SubscriberEventMapping} [subscriber_event_mapping]
|
|
80
|
-
* @property {Object} [event_schema]
|
|
81
|
-
*
|
|
82
|
-
* @property {string} [
|
|
83
|
-
*
|
|
84
|
-
* @property {string} [
|
|
85
|
-
* @property {string} [
|
|
86
|
-
* @property {string} [
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
*
|
|
43
|
+
* @property {Object} [event_schema] - The schema for the event, allowing for
|
|
44
|
+
* additional properties and may be null.
|
|
45
|
+
* @property {string} [group] - The group associated with the event
|
|
46
|
+
* configuration, which may be null.
|
|
47
|
+
* @property {string} [version] - The version of the event configuration.
|
|
48
|
+
* @property {string} [display_name] - The display name of the event configuration.
|
|
49
|
+
* @property {string} [description] - A description of the event configuration,
|
|
50
|
+
* which may be null.
|
|
51
|
+
* @property {string} [created_on] - The date and time when the event
|
|
52
|
+
* configuration was created.
|
|
53
|
+
* @property {string} [updated_on] - The date and time when the event
|
|
54
|
+
* configuration was last updated.
|
|
55
|
+
*/
|
|
56
|
+
/**
|
|
57
|
+
* @typedef EventConfigResult
|
|
90
58
|
* @property {EventConfig[]} [event_configs]
|
|
91
59
|
*/
|
|
92
|
-
/**
|
|
93
|
-
* @typedef ReportFiltersPayload
|
|
94
|
-
* @property {number[]} subscriber_ids - An array of subscriber IDs for
|
|
95
|
-
* filtering filters (optional).
|
|
96
|
-
*/
|
|
97
|
-
/**
|
|
98
|
-
* @typedef ReportFilterResponse
|
|
99
|
-
* @property {string} [filter_name] - The name of the filter.
|
|
100
|
-
* @property {Object[]} [values]
|
|
101
|
-
*/
|
|
102
|
-
/**
|
|
103
|
-
* @typedef HistoryPayload
|
|
104
|
-
* @property {string} type - The type of history report (e.g., "platform").
|
|
105
|
-
* @property {number} [page_no] - The page number of the history report.
|
|
106
|
-
* @property {number} [page_size] - The number of records per page.
|
|
107
|
-
*/
|
|
108
|
-
/**
|
|
109
|
-
* @typedef HistoryFilters
|
|
110
|
-
* @property {string[]} [events]
|
|
111
|
-
* @property {string} [search_text]
|
|
112
|
-
* @property {string} [status] - The status of the history report (e.g., "FAILED").
|
|
113
|
-
* @property {string} [end_date] - The end date and time of the history report.
|
|
114
|
-
* @property {string} [start_date] - The start date and time of the history report.
|
|
115
|
-
* @property {number[]} [subscribers] - An array of subscriber IDs associated
|
|
116
|
-
* with the history report.
|
|
117
|
-
* @property {string[]} [webhook_type] - An array of webhook type to identify
|
|
118
|
-
* thetype of subscriber i.e (KAFKA or REST).
|
|
119
|
-
*/
|
|
120
|
-
/**
|
|
121
|
-
* @typedef Url
|
|
122
|
-
* @property {string} [url] - The URL of the uploaded report file.
|
|
123
|
-
* @property {string} [name] - The name of the uploaded report file.
|
|
124
|
-
*/
|
|
125
|
-
/**
|
|
126
|
-
* @typedef CdnObject
|
|
127
|
-
* @property {Url[]} [urls]
|
|
128
|
-
*/
|
|
129
|
-
/**
|
|
130
|
-
* @typedef UploadServiceObject
|
|
131
|
-
* @property {CdnObject} [cdn]
|
|
132
|
-
*/
|
|
133
|
-
/**
|
|
134
|
-
* @typedef HistoryAssociation
|
|
135
|
-
* @property {number} [company_id]
|
|
136
|
-
* @property {number[]} [subscriber_ids]
|
|
137
|
-
*/
|
|
138
|
-
/**
|
|
139
|
-
* @typedef HistoryItems
|
|
140
|
-
* @property {number} [id] - The ID of the history report.
|
|
141
|
-
* @property {HistoryAssociation} [association]
|
|
142
|
-
* @property {HistoryFilters} [filters]
|
|
143
|
-
* @property {string} [filename] - The filename of the history report.
|
|
144
|
-
* @property {string} [status] - The status of the history report (e.g., "COMPLETED").
|
|
145
|
-
* @property {UploadServiceObject} [upload_service_response]
|
|
146
|
-
* @property {string} [created_on] - The date and time when the history report
|
|
147
|
-
* was created.
|
|
148
|
-
* @property {string} [updated_on] - The date and time when the history report
|
|
149
|
-
* was last updated.
|
|
150
|
-
* @property {string} [message] - A message related to the history report.
|
|
151
|
-
*/
|
|
152
|
-
/**
|
|
153
|
-
* @typedef HistoryResponse
|
|
154
|
-
* @property {HistoryItems[]} [items]
|
|
155
|
-
* @property {Page} [page]
|
|
156
|
-
*/
|
|
157
|
-
/**
|
|
158
|
-
* @typedef CancelResponse
|
|
159
|
-
* @property {string} [message] - The HTTP status code of the response (e.g., 200).
|
|
160
|
-
*/
|
|
161
60
|
/**
|
|
162
61
|
* @typedef Association
|
|
163
|
-
* @property {string[]} [application_id]
|
|
164
|
-
*
|
|
165
|
-
* @property {string} [
|
|
62
|
+
* @property {string[]} [application_id] - A list of application IDs associated
|
|
63
|
+
* with the association.
|
|
64
|
+
* @property {string} [extension_id] - The extension ID associated with the association.
|
|
65
|
+
* @property {string} [criteria] - The criteria for the association, such as
|
|
66
|
+
* "ALL", "EMPTY", or "SPECIFIC-EVENTS".
|
|
166
67
|
*/
|
|
167
68
|
/**
|
|
168
69
|
* @typedef AssociationResp
|
|
169
|
-
* @property {number} [company_id]
|
|
170
|
-
* @property {string[]} [application_id]
|
|
171
|
-
*
|
|
172
|
-
* @property {string} [
|
|
70
|
+
* @property {number} [company_id] - The ID of the company associated with the response.
|
|
71
|
+
* @property {string[]} [application_id] - A list of application IDs associated
|
|
72
|
+
* with the response.
|
|
73
|
+
* @property {string} [extension_id] - The extension ID associated with the response.
|
|
74
|
+
* @property {string} [criteria] - The criteria for the response, such as "ALL",
|
|
75
|
+
* "EMPTY", or "SPECIFIC-EVENTS".
|
|
173
76
|
*/
|
|
174
77
|
/**
|
|
175
78
|
* @typedef AuthMeta
|
|
176
|
-
* @property {string} [type]
|
|
177
|
-
* @property {string} [secret]
|
|
79
|
+
* @property {string} [type] - The type of authentication method used.
|
|
80
|
+
* @property {string} [secret] - The secret key or token used for authentication.
|
|
178
81
|
*/
|
|
179
82
|
/**
|
|
180
|
-
* @typedef
|
|
181
|
-
* @property {number} [id]
|
|
182
|
-
* @property {string} [modified_by]
|
|
183
|
-
*
|
|
184
|
-
* @property {string} [
|
|
185
|
-
* @property {string} [
|
|
83
|
+
* @typedef SubscriberDetails
|
|
84
|
+
* @property {number} [id] - The unique identifier of the subscriber.
|
|
85
|
+
* @property {string} [modified_by] - The identifier of the user who last
|
|
86
|
+
* modified the subscriber details.
|
|
87
|
+
* @property {string} [name] - The name of the subscriber.
|
|
88
|
+
* @property {string} [provider] - The provider of the subscriber.
|
|
89
|
+
* @property {string} [webhook_url] - The URL for the subscriber's webhook.
|
|
186
90
|
* @property {AssociationResp} [association]
|
|
187
|
-
* @property {Object} [custom_headers]
|
|
91
|
+
* @property {Object} [custom_headers] - Custom headers for the subscriber.
|
|
188
92
|
* @property {SubscriberStatus} [status]
|
|
189
|
-
* @property {string} [email_id]
|
|
190
|
-
* @property {string} [updated_on]
|
|
191
|
-
*
|
|
192
|
-
* @property {string} [
|
|
93
|
+
* @property {string} [email_id] - The email ID associated with the subscriber.
|
|
94
|
+
* @property {string} [updated_on] - The date and time when the subscriber
|
|
95
|
+
* details were last updated.
|
|
96
|
+
* @property {string} [created_on] - The date and time when the subscriber was created.
|
|
97
|
+
* @property {string} [type] - The type of subscriber, which can either be passed as null.
|
|
193
98
|
* @property {AuthMeta} [auth_meta]
|
|
194
99
|
* @property {EventConfig[]} [event_configs]
|
|
195
100
|
*/
|
|
196
101
|
/**
|
|
197
102
|
* @typedef Events
|
|
198
|
-
* @property {string} [slug]
|
|
199
|
-
* @property {string} [topic]
|
|
103
|
+
* @property {string} [slug] - The slug or identifier for the event.
|
|
104
|
+
* @property {string} [topic] - The topic associated with the event.
|
|
105
|
+
* @property {string} [queue] - The queue associated with the event in case of
|
|
106
|
+
* provider as Pub/Sub.
|
|
107
|
+
* @property {string} [event_bridge_name] - The name of the event bridge
|
|
108
|
+
* associated with the event in case of provider as AWS event bridge.
|
|
109
|
+
* @property {string} [workflow_name] - The name of the workflow related to the
|
|
110
|
+
* event in case of provider as temporal.
|
|
111
|
+
* @property {string} [detail_type] - The type of detail for the event.
|
|
200
112
|
*/
|
|
201
113
|
/**
|
|
202
114
|
* @typedef SubscriberConfigPostRequestV2
|
|
203
|
-
* @property {string} name
|
|
204
|
-
* @property {string} [
|
|
205
|
-
* @property {string}
|
|
115
|
+
* @property {string} name - The name of the subscriber.
|
|
116
|
+
* @property {string} [type] - The type of the subscriber, which may be null.
|
|
117
|
+
* @property {string} [webhook_url] - The URL for the subscriber's webhook.
|
|
118
|
+
* @property {string} provider - The provider of the subscriber.
|
|
206
119
|
* @property {Association} association
|
|
207
|
-
* @property {Object} [custom_headers]
|
|
120
|
+
* @property {Object} [custom_headers] - Custom headers for the subscriber.
|
|
208
121
|
* @property {SubscriberStatus} status
|
|
209
|
-
* @property {string} email_id
|
|
122
|
+
* @property {string} email_id - The email ID associated with the subscriber.
|
|
210
123
|
* @property {AuthMeta} [auth_meta]
|
|
211
|
-
* @property {Events[]} events
|
|
124
|
+
* @property {Events[]} events - The list of events associated with the subscriber.
|
|
212
125
|
*/
|
|
213
126
|
/**
|
|
214
127
|
* @typedef SubscriberConfigUpdateRequestV2
|
|
215
|
-
* @property {number} id
|
|
216
|
-
* @property {string} [name]
|
|
217
|
-
* @property {string} [
|
|
218
|
-
* @property {string}
|
|
128
|
+
* @property {number} id - The unique identifier of the subscriber to be updated.
|
|
129
|
+
* @property {string} [name] - The name of the subscriber.
|
|
130
|
+
* @property {string} [type] - The type of the subscriber, which may be null.
|
|
131
|
+
* @property {string} [webhook_url] - The URL for the subscriber's webhook.
|
|
132
|
+
* @property {string} provider - The provider of the subscriber.
|
|
219
133
|
* @property {Association} [association]
|
|
220
|
-
* @property {Object} [custom_headers]
|
|
134
|
+
* @property {Object} [custom_headers] - Custom headers for the subscriber.
|
|
221
135
|
* @property {SubscriberStatus} status
|
|
222
|
-
* @property {string} [email_id]
|
|
136
|
+
* @property {string} [email_id] - The email ID associated with the subscriber.
|
|
223
137
|
* @property {AuthMeta} [auth_meta]
|
|
224
|
-
* @property {Events[]} [events]
|
|
138
|
+
* @property {Events[]} [events] - The list of events associated with the subscriber.
|
|
225
139
|
*/
|
|
226
140
|
/**
|
|
227
141
|
* @typedef SubscriberConfigPost
|
|
228
|
-
* @property {string} name
|
|
229
|
-
* @property {string}
|
|
142
|
+
* @property {string} name - The name of the subscriber.
|
|
143
|
+
* @property {string} [type] - The type of the subscriber, which can be null.
|
|
144
|
+
* @property {string} webhook_url - The URL for the subscriber's webhook.
|
|
230
145
|
* @property {Association} association
|
|
231
|
-
* @property {Object} [custom_headers]
|
|
146
|
+
* @property {Object} [custom_headers] - Custom headers for the subscriber.
|
|
232
147
|
* @property {SubscriberStatus} status
|
|
233
|
-
* @property {string} email_id
|
|
148
|
+
* @property {string} email_id - The email ID associated with the subscriber.
|
|
234
149
|
* @property {AuthMeta} [auth_meta]
|
|
235
|
-
* @property {number[]} event_id
|
|
150
|
+
* @property {number[]} event_id - The list of event IDs associated with the subscriber.
|
|
236
151
|
*/
|
|
237
152
|
/**
|
|
238
153
|
* @typedef SubscriberConfigUpdate
|
|
239
|
-
* @property {number} id
|
|
240
|
-
* @property {string} [name]
|
|
241
|
-
* @property {string} [
|
|
154
|
+
* @property {number} id - The unique identifier of the subscriber to be updated.
|
|
155
|
+
* @property {string} [name] - The name of the subscriber.
|
|
156
|
+
* @property {string} [type] - The type of the subscriber, which can be null.
|
|
157
|
+
* @property {string} [webhook_url] - The URL for the subscriber's webhook.
|
|
242
158
|
* @property {Association} [association]
|
|
243
|
-
* @property {Object} [custom_headers]
|
|
159
|
+
* @property {Object} [custom_headers] - Custom headers for the subscriber.
|
|
244
160
|
* @property {SubscriberStatus} [status]
|
|
245
|
-
* @property {string} [email_id]
|
|
161
|
+
* @property {string} [email_id] - The email ID associated with the subscriber.
|
|
246
162
|
* @property {AuthMeta} [auth_meta]
|
|
247
|
-
* @property {number[]} event_id
|
|
163
|
+
* @property {number[]} event_id - The list of event IDs associated with the subscriber.
|
|
248
164
|
*/
|
|
249
165
|
/**
|
|
250
|
-
* @typedef
|
|
251
|
-
* @property {number} [id]
|
|
252
|
-
* @property {string} [modified_by]
|
|
253
|
-
*
|
|
254
|
-
* @property {string} [
|
|
255
|
-
* @property {string} [
|
|
166
|
+
* @typedef SubscriberConfigResult
|
|
167
|
+
* @property {number} [id] - The unique identifier of the subscriber configuration.
|
|
168
|
+
* @property {string} [modified_by] - The identifier of the user who last
|
|
169
|
+
* modified the subscriber configuration.
|
|
170
|
+
* @property {string} [name] - The name of the subscriber.
|
|
171
|
+
* @property {string} [webhook_url] - The URL for the subscriber's webhook.
|
|
172
|
+
* @property {string} [provider] - The provider of the subscriber.
|
|
256
173
|
* @property {AssociationResp} [association]
|
|
257
|
-
* @property {Object} [custom_headers]
|
|
174
|
+
* @property {Object} [custom_headers] - Custom headers for the subscriber.
|
|
258
175
|
* @property {SubscriberStatus} [status]
|
|
259
|
-
* @property {string} [email_id]
|
|
260
|
-
* @property {string} [updated_on]
|
|
261
|
-
*
|
|
262
|
-
* @property {string} [
|
|
176
|
+
* @property {string} [email_id] - The email ID associated with the subscriber.
|
|
177
|
+
* @property {string} [updated_on] - The date and time when the subscriber was
|
|
178
|
+
* last updated.
|
|
179
|
+
* @property {string} [created_on] - The date and time when the subscriber was created.
|
|
180
|
+
* @property {string} [type] - The type of the subscriber, which can be null.
|
|
263
181
|
* @property {AuthMeta} [auth_meta]
|
|
264
|
-
* @property {number[]} [event_id]
|
|
182
|
+
* @property {number[]} [event_id] - The list of event IDs associated with the subscriber.
|
|
265
183
|
*/
|
|
266
184
|
/**
|
|
267
185
|
* @typedef SubscriberConfigList
|
|
268
|
-
* @property {
|
|
186
|
+
* @property {SubscriberDetails[]} [items]
|
|
269
187
|
* @property {Page} [page]
|
|
270
188
|
*/
|
|
189
|
+
/**
|
|
190
|
+
* @typedef RestEventData
|
|
191
|
+
* @property {string} event_category - The category of the event.
|
|
192
|
+
* @property {string} event_name - The name of the event.
|
|
193
|
+
* @property {string} event_type - The type of the event.
|
|
194
|
+
* @property {number} version - The version number of the event.
|
|
195
|
+
*/
|
|
196
|
+
/**
|
|
197
|
+
* @typedef RestConfig
|
|
198
|
+
* @property {string} webhook_url - The URL for the webhook.
|
|
199
|
+
* @property {string} type - The type of the configuration.
|
|
200
|
+
* @property {Object} [custom_headers] - Custom headers for the configuration.
|
|
201
|
+
* @property {AuthMeta} [auth_meta]
|
|
202
|
+
* @property {RestEventData[]} events
|
|
203
|
+
*/
|
|
204
|
+
/**
|
|
205
|
+
* @typedef QueueEventData
|
|
206
|
+
* @property {string} event_category - The category of the event.
|
|
207
|
+
* @property {string} event_name - The name of the event.
|
|
208
|
+
* @property {string} event_type - The type of the event.
|
|
209
|
+
* @property {number} version - The version number of the event.
|
|
210
|
+
* @property {string} topic - The topic associated with the event.
|
|
211
|
+
*/
|
|
212
|
+
/**
|
|
213
|
+
* @typedef KafkaConfig
|
|
214
|
+
* @property {string} [type]
|
|
215
|
+
* @property {QueueEventData[]} events
|
|
216
|
+
*/
|
|
217
|
+
/**
|
|
218
|
+
* @typedef PubSubConfig
|
|
219
|
+
* @property {string} [type]
|
|
220
|
+
* @property {QueueEventData[]} events
|
|
221
|
+
*/
|
|
222
|
+
/**
|
|
223
|
+
* @typedef TemporalEventData
|
|
224
|
+
* @property {string} event_category - The category of the event.
|
|
225
|
+
* @property {string} event_name - The name of the event.
|
|
226
|
+
* @property {string} event_type - The type of the event.
|
|
227
|
+
* @property {number} version - The version number of the event.
|
|
228
|
+
* @property {string} [queue] - The queue associated with the event.
|
|
229
|
+
* @property {string} [workflow_name] - The workflow name related to the event.
|
|
230
|
+
*/
|
|
231
|
+
/**
|
|
232
|
+
* @typedef TemporalConfig
|
|
233
|
+
* @property {string} [type]
|
|
234
|
+
* @property {TemporalEventData[]} events
|
|
235
|
+
*/
|
|
236
|
+
/**
|
|
237
|
+
* @typedef SqsEventData
|
|
238
|
+
* @property {string} event_category - The category of the event.
|
|
239
|
+
* @property {string} event_name - The name of the event.
|
|
240
|
+
* @property {string} event_type - The type of the event.
|
|
241
|
+
* @property {number} version - The version number of the event.
|
|
242
|
+
* @property {string} [queue] - The queue name associated with the event in SQS.
|
|
243
|
+
*/
|
|
244
|
+
/**
|
|
245
|
+
* @typedef SqsConfig
|
|
246
|
+
* @property {string} [type]
|
|
247
|
+
* @property {SqsEventData[]} events
|
|
248
|
+
*/
|
|
249
|
+
/**
|
|
250
|
+
* @typedef EventBridgeData
|
|
251
|
+
* @property {string} event_category - The category of the event.
|
|
252
|
+
* @property {string} event_name - The name of the event.
|
|
253
|
+
* @property {string} event_type - The type of the event.
|
|
254
|
+
* @property {number} version - The version number of the event.
|
|
255
|
+
* @property {string} [event_bridge_name] - The name of the event bridge related
|
|
256
|
+
* to the event.
|
|
257
|
+
*/
|
|
258
|
+
/**
|
|
259
|
+
* @typedef EventBridgeConfig
|
|
260
|
+
* @property {string} [type]
|
|
261
|
+
* @property {EventBridgeData[]} events
|
|
262
|
+
*/
|
|
263
|
+
/**
|
|
264
|
+
* @typedef EventMapBody
|
|
265
|
+
* @property {RestConfig} [rest]
|
|
266
|
+
* @property {KafkaConfig} [kafka]
|
|
267
|
+
* @property {PubSubConfig} [pub_sub]
|
|
268
|
+
* @property {TemporalConfig} [temporal]
|
|
269
|
+
* @property {SqsConfig} [sqs]
|
|
270
|
+
* @property {EventBridgeConfig} [event_bridge]
|
|
271
|
+
*/
|
|
272
|
+
/**
|
|
273
|
+
* @typedef WebhookConfig
|
|
274
|
+
* @property {string} [notification_email] - The email address for notifications.
|
|
275
|
+
* @property {string} [name] - The name of the webhook configuration.
|
|
276
|
+
* @property {string} [status] - The status of the webhook (e.g., active or inactive).
|
|
277
|
+
* @property {Association} [association]
|
|
278
|
+
* @property {EventMapBody} [event_map]
|
|
279
|
+
*/
|
|
280
|
+
/**
|
|
281
|
+
* @typedef UpsertSubscriberConfig
|
|
282
|
+
* @property {WebhookConfig} webhook_config
|
|
283
|
+
*/
|
|
284
|
+
/**
|
|
285
|
+
* @typedef UpsertSubscriberConfigResult
|
|
286
|
+
* @property {boolean} [status] - The status of the upsert operation (e.g.,
|
|
287
|
+
* success or failure).
|
|
288
|
+
* @property {string} [message] - A message providing details about the upsert
|
|
289
|
+
* operation result.
|
|
290
|
+
*/
|
|
271
291
|
/** @typedef {"active" | "inactive"} SubscriberStatus */
|
|
272
292
|
declare class WebhookPlatformModel {
|
|
273
293
|
}
|
|
274
294
|
declare namespace WebhookPlatformModel {
|
|
275
|
-
export {
|
|
295
|
+
export { Page, BroadcasterConfig, SubscriberEventMapping, EventConfig, EventConfigResult, Association, AssociationResp, AuthMeta, SubscriberDetails, Events, SubscriberConfigPostRequestV2, SubscriberConfigUpdateRequestV2, SubscriberConfigPost, SubscriberConfigUpdate, SubscriberConfigResult, SubscriberConfigList, RestEventData, RestConfig, QueueEventData, KafkaConfig, PubSubConfig, TemporalEventData, TemporalConfig, SqsEventData, SqsConfig, EventBridgeData, EventBridgeConfig, EventMapBody, WebhookConfig, UpsertSubscriberConfig, UpsertSubscriberConfigResult, SubscriberStatus };
|
|
276
296
|
}
|
|
277
|
-
/** @returns {Event} */
|
|
278
|
-
declare function Event(): Event;
|
|
279
|
-
type Event = {
|
|
280
|
-
event_name?: string;
|
|
281
|
-
event_type?: string;
|
|
282
|
-
event_category?: string;
|
|
283
|
-
version?: string;
|
|
284
|
-
};
|
|
285
|
-
/** @returns {EventProcessRequest} */
|
|
286
|
-
declare function EventProcessRequest(): EventProcessRequest;
|
|
287
|
-
type EventProcessRequest = {
|
|
288
|
-
search_text?: string;
|
|
289
|
-
end_date: string;
|
|
290
|
-
start_date: string;
|
|
291
|
-
subscriber_ids?: number[];
|
|
292
|
-
status?: string;
|
|
293
|
-
event?: Event[];
|
|
294
|
-
};
|
|
295
|
-
/** @returns {DownloadReportResponse} */
|
|
296
|
-
declare function DownloadReportResponse(): DownloadReportResponse;
|
|
297
|
-
type DownloadReportResponse = {
|
|
298
|
-
file_name?: string;
|
|
299
|
-
};
|
|
300
|
-
/** @returns {EventProcessReports} */
|
|
301
|
-
declare function EventProcessReports(): EventProcessReports;
|
|
302
|
-
type EventProcessReports = {
|
|
303
|
-
rows?: EventProcessReportObject[];
|
|
304
|
-
page?: Page;
|
|
305
|
-
};
|
|
306
|
-
/** @returns {EventProcessReportObject} */
|
|
307
|
-
declare function EventProcessReportObject(): EventProcessReportObject;
|
|
308
|
-
type EventProcessReportObject = {
|
|
309
|
-
/**
|
|
310
|
-
* - The name of the processed event.
|
|
311
|
-
*/
|
|
312
|
-
event_name?: string;
|
|
313
|
-
/**
|
|
314
|
-
* - The response code of the event.
|
|
315
|
-
*/
|
|
316
|
-
response_code?: number;
|
|
317
|
-
/**
|
|
318
|
-
* - The response message of the event.
|
|
319
|
-
*/
|
|
320
|
-
response_message?: string;
|
|
321
|
-
/**
|
|
322
|
-
* - The data associated with the event.
|
|
323
|
-
*/
|
|
324
|
-
data?: string;
|
|
325
|
-
/**
|
|
326
|
-
* - The attempt number of the event.
|
|
327
|
-
*/
|
|
328
|
-
attempt?: number;
|
|
329
|
-
/**
|
|
330
|
-
* - The timestamp of the last attempted event.
|
|
331
|
-
*/
|
|
332
|
-
last_attempted_on?: number;
|
|
333
|
-
/**
|
|
334
|
-
* - The status of the event (e.g., "FAILED").
|
|
335
|
-
*/
|
|
336
|
-
status?: string;
|
|
337
|
-
/**
|
|
338
|
-
* - The name of the event.
|
|
339
|
-
*/
|
|
340
|
-
name?: string;
|
|
341
|
-
/**
|
|
342
|
-
* - The webhook URL associated with the event.
|
|
343
|
-
*/
|
|
344
|
-
webhook_url?: string;
|
|
345
|
-
/**
|
|
346
|
-
* - The response time of the event.
|
|
347
|
-
*/
|
|
348
|
-
response_time?: number;
|
|
349
|
-
message_id?: string;
|
|
350
|
-
event_trace_id?: string;
|
|
351
|
-
};
|
|
352
297
|
/** @returns {Page} */
|
|
353
298
|
declare function Page(): Page;
|
|
354
299
|
type Page = {
|
|
@@ -381,241 +326,225 @@ type Page = {
|
|
|
381
326
|
*/
|
|
382
327
|
size?: number;
|
|
383
328
|
};
|
|
384
|
-
/** @returns {
|
|
385
|
-
declare function
|
|
386
|
-
type
|
|
329
|
+
/** @returns {BroadcasterConfig} */
|
|
330
|
+
declare function BroadcasterConfig(): BroadcasterConfig;
|
|
331
|
+
type BroadcasterConfig = {
|
|
387
332
|
/**
|
|
388
|
-
* - The
|
|
333
|
+
* - The name of the topic for the broadcaster configuration.
|
|
389
334
|
*/
|
|
390
|
-
|
|
335
|
+
topic?: string;
|
|
391
336
|
/**
|
|
392
|
-
* -
|
|
393
|
-
* subscriber).
|
|
337
|
+
* - The name of the queue for the broadcaster configuration.
|
|
394
338
|
*/
|
|
395
|
-
|
|
339
|
+
queue?: string;
|
|
396
340
|
/**
|
|
397
|
-
* -
|
|
341
|
+
* - The name of the event bridge
|
|
342
|
+
* associated with the broadcaster.
|
|
398
343
|
*/
|
|
399
|
-
|
|
400
|
-
};
|
|
401
|
-
/** @returns {PingWebhookResponse} */
|
|
402
|
-
declare function PingWebhookResponse(): PingWebhookResponse;
|
|
403
|
-
type PingWebhookResponse = {
|
|
344
|
+
event_bridge_name?: string;
|
|
404
345
|
/**
|
|
405
|
-
* - The
|
|
346
|
+
* - The name of the workflow related to the
|
|
347
|
+
* broadcaster.
|
|
406
348
|
*/
|
|
407
|
-
|
|
349
|
+
workflow_name?: string;
|
|
408
350
|
/**
|
|
409
|
-
* -
|
|
351
|
+
* - The account ID associated with the broadcaster.
|
|
410
352
|
*/
|
|
411
|
-
|
|
353
|
+
account_id?: string;
|
|
412
354
|
/**
|
|
413
|
-
* - The
|
|
355
|
+
* - The type of detail for the broadcaster
|
|
356
|
+
* configuration.
|
|
414
357
|
*/
|
|
415
|
-
|
|
358
|
+
detail_type?: string;
|
|
416
359
|
};
|
|
417
360
|
/** @returns {SubscriberEventMapping} */
|
|
418
361
|
declare function SubscriberEventMapping(): SubscriberEventMapping;
|
|
419
362
|
type SubscriberEventMapping = {
|
|
420
|
-
id?: number;
|
|
421
|
-
event_id?: number;
|
|
422
|
-
subscriber_id?: number;
|
|
423
|
-
topic?: string;
|
|
424
|
-
created_on?: string;
|
|
425
|
-
};
|
|
426
|
-
/** @returns {EventConfig} */
|
|
427
|
-
declare function EventConfig(): EventConfig;
|
|
428
|
-
type EventConfig = {
|
|
429
|
-
id?: number;
|
|
430
|
-
event_name?: string;
|
|
431
|
-
event_type?: string;
|
|
432
|
-
event_category?: string;
|
|
433
|
-
subscriber_event_mapping?: SubscriberEventMapping;
|
|
434
|
-
event_schema?: any;
|
|
435
|
-
group?: string;
|
|
436
|
-
version?: string;
|
|
437
|
-
display_name?: string;
|
|
438
|
-
description?: string;
|
|
439
|
-
created_on?: string;
|
|
440
|
-
updated_on?: string;
|
|
441
|
-
};
|
|
442
|
-
/** @returns {EventConfigResponse} */
|
|
443
|
-
declare function EventConfigResponse(): EventConfigResponse;
|
|
444
|
-
type EventConfigResponse = {
|
|
445
|
-
event_configs?: EventConfig[];
|
|
446
|
-
};
|
|
447
|
-
/** @returns {ReportFiltersPayload} */
|
|
448
|
-
declare function ReportFiltersPayload(): ReportFiltersPayload;
|
|
449
|
-
type ReportFiltersPayload = {
|
|
450
363
|
/**
|
|
451
|
-
* -
|
|
452
|
-
* filtering filters (optional).
|
|
364
|
+
* - The unique identifier for the subscriber event mapping.
|
|
453
365
|
*/
|
|
454
|
-
|
|
455
|
-
};
|
|
456
|
-
/** @returns {ReportFilterResponse} */
|
|
457
|
-
declare function ReportFilterResponse(): ReportFilterResponse;
|
|
458
|
-
type ReportFilterResponse = {
|
|
366
|
+
id?: number;
|
|
459
367
|
/**
|
|
460
|
-
* - The
|
|
368
|
+
* - The ID of the event associated with the subscriber.
|
|
461
369
|
*/
|
|
462
|
-
|
|
463
|
-
values?: any[];
|
|
464
|
-
};
|
|
465
|
-
/** @returns {HistoryPayload} */
|
|
466
|
-
declare function HistoryPayload(): HistoryPayload;
|
|
467
|
-
type HistoryPayload = {
|
|
370
|
+
event_id?: number;
|
|
468
371
|
/**
|
|
469
|
-
* - The
|
|
372
|
+
* - The ID of the subscriber.
|
|
470
373
|
*/
|
|
471
|
-
|
|
374
|
+
subscriber_id?: number;
|
|
375
|
+
broadcaster_config?: BroadcasterConfig;
|
|
472
376
|
/**
|
|
473
|
-
* - The
|
|
377
|
+
* - The date and time when the subscriber event
|
|
378
|
+
* mapping was created.
|
|
474
379
|
*/
|
|
475
|
-
|
|
380
|
+
created_on?: string;
|
|
381
|
+
};
|
|
382
|
+
/** @returns {EventConfig} */
|
|
383
|
+
declare function EventConfig(): EventConfig;
|
|
384
|
+
type EventConfig = {
|
|
476
385
|
/**
|
|
477
|
-
* - The
|
|
386
|
+
* - The unique identifier for the event configuration.
|
|
478
387
|
*/
|
|
479
|
-
|
|
480
|
-
};
|
|
481
|
-
/** @returns {HistoryFilters} */
|
|
482
|
-
declare function HistoryFilters(): HistoryFilters;
|
|
483
|
-
type HistoryFilters = {
|
|
484
|
-
events?: string[];
|
|
485
|
-
search_text?: string;
|
|
388
|
+
id?: number;
|
|
486
389
|
/**
|
|
487
|
-
* - The
|
|
390
|
+
* - The type of event configuration, which may be null.
|
|
488
391
|
*/
|
|
489
|
-
|
|
392
|
+
type?: string;
|
|
490
393
|
/**
|
|
491
|
-
* - The
|
|
394
|
+
* - The name of the event.
|
|
492
395
|
*/
|
|
493
|
-
|
|
396
|
+
event_name?: string;
|
|
494
397
|
/**
|
|
495
|
-
* - The
|
|
398
|
+
* - The type of the event.
|
|
496
399
|
*/
|
|
497
|
-
|
|
400
|
+
event_type?: string;
|
|
498
401
|
/**
|
|
499
|
-
* -
|
|
500
|
-
* with the history report.
|
|
402
|
+
* - The category of the event.
|
|
501
403
|
*/
|
|
502
|
-
|
|
404
|
+
event_category?: string;
|
|
503
405
|
/**
|
|
504
|
-
* -
|
|
505
|
-
*
|
|
406
|
+
* - The identifier of the user who last
|
|
407
|
+
* modified the event configuration.
|
|
506
408
|
*/
|
|
507
|
-
|
|
508
|
-
|
|
509
|
-
/** @returns {Url} */
|
|
510
|
-
declare function Url(): Url;
|
|
511
|
-
type Url = {
|
|
409
|
+
modified_by?: string;
|
|
410
|
+
subscriber_event_mapping?: SubscriberEventMapping;
|
|
512
411
|
/**
|
|
513
|
-
* - The
|
|
412
|
+
* - The schema for the event, allowing for
|
|
413
|
+
* additional properties and may be null.
|
|
514
414
|
*/
|
|
515
|
-
|
|
415
|
+
event_schema?: any;
|
|
516
416
|
/**
|
|
517
|
-
* - The
|
|
417
|
+
* - The group associated with the event
|
|
418
|
+
* configuration, which may be null.
|
|
518
419
|
*/
|
|
519
|
-
|
|
520
|
-
};
|
|
521
|
-
/** @returns {CdnObject} */
|
|
522
|
-
declare function CdnObject(): CdnObject;
|
|
523
|
-
type CdnObject = {
|
|
524
|
-
urls?: Url[];
|
|
525
|
-
};
|
|
526
|
-
/** @returns {UploadServiceObject} */
|
|
527
|
-
declare function UploadServiceObject(): UploadServiceObject;
|
|
528
|
-
type UploadServiceObject = {
|
|
529
|
-
cdn?: CdnObject;
|
|
530
|
-
};
|
|
531
|
-
/** @returns {HistoryAssociation} */
|
|
532
|
-
declare function HistoryAssociation(): HistoryAssociation;
|
|
533
|
-
type HistoryAssociation = {
|
|
534
|
-
company_id?: number;
|
|
535
|
-
subscriber_ids?: number[];
|
|
536
|
-
};
|
|
537
|
-
/** @returns {HistoryItems} */
|
|
538
|
-
declare function HistoryItems(): HistoryItems;
|
|
539
|
-
type HistoryItems = {
|
|
420
|
+
group?: string;
|
|
540
421
|
/**
|
|
541
|
-
* - The
|
|
422
|
+
* - The version of the event configuration.
|
|
542
423
|
*/
|
|
543
|
-
|
|
544
|
-
association?: HistoryAssociation;
|
|
545
|
-
filters?: HistoryFilters;
|
|
424
|
+
version?: string;
|
|
546
425
|
/**
|
|
547
|
-
* - The
|
|
426
|
+
* - The display name of the event configuration.
|
|
548
427
|
*/
|
|
549
|
-
|
|
428
|
+
display_name?: string;
|
|
550
429
|
/**
|
|
551
|
-
* -
|
|
430
|
+
* - A description of the event configuration,
|
|
431
|
+
* which may be null.
|
|
552
432
|
*/
|
|
553
|
-
|
|
554
|
-
upload_service_response?: UploadServiceObject;
|
|
433
|
+
description?: string;
|
|
555
434
|
/**
|
|
556
|
-
* - The date and time when the
|
|
557
|
-
* was created.
|
|
435
|
+
* - The date and time when the event
|
|
436
|
+
* configuration was created.
|
|
558
437
|
*/
|
|
559
438
|
created_on?: string;
|
|
560
439
|
/**
|
|
561
|
-
* - The date and time when the
|
|
562
|
-
* was last updated.
|
|
440
|
+
* - The date and time when the event
|
|
441
|
+
* configuration was last updated.
|
|
563
442
|
*/
|
|
564
443
|
updated_on?: string;
|
|
565
|
-
/**
|
|
566
|
-
* - A message related to the history report.
|
|
567
|
-
*/
|
|
568
|
-
message?: string;
|
|
569
|
-
};
|
|
570
|
-
/** @returns {HistoryResponse} */
|
|
571
|
-
declare function HistoryResponse(): HistoryResponse;
|
|
572
|
-
type HistoryResponse = {
|
|
573
|
-
items?: HistoryItems[];
|
|
574
|
-
page?: Page;
|
|
575
444
|
};
|
|
576
|
-
/** @returns {
|
|
577
|
-
declare function
|
|
578
|
-
type
|
|
579
|
-
|
|
580
|
-
* - The HTTP status code of the response (e.g., 200).
|
|
581
|
-
*/
|
|
582
|
-
message?: string;
|
|
445
|
+
/** @returns {EventConfigResult} */
|
|
446
|
+
declare function EventConfigResult(): EventConfigResult;
|
|
447
|
+
type EventConfigResult = {
|
|
448
|
+
event_configs?: EventConfig[];
|
|
583
449
|
};
|
|
584
450
|
/** @returns {Association} */
|
|
585
451
|
declare function Association(): Association;
|
|
586
452
|
type Association = {
|
|
453
|
+
/**
|
|
454
|
+
* - A list of application IDs associated
|
|
455
|
+
* with the association.
|
|
456
|
+
*/
|
|
587
457
|
application_id?: string[];
|
|
458
|
+
/**
|
|
459
|
+
* - The extension ID associated with the association.
|
|
460
|
+
*/
|
|
588
461
|
extension_id?: string;
|
|
462
|
+
/**
|
|
463
|
+
* - The criteria for the association, such as
|
|
464
|
+
* "ALL", "EMPTY", or "SPECIFIC-EVENTS".
|
|
465
|
+
*/
|
|
589
466
|
criteria?: string;
|
|
590
467
|
};
|
|
591
468
|
/** @returns {AssociationResp} */
|
|
592
469
|
declare function AssociationResp(): AssociationResp;
|
|
593
470
|
type AssociationResp = {
|
|
471
|
+
/**
|
|
472
|
+
* - The ID of the company associated with the response.
|
|
473
|
+
*/
|
|
594
474
|
company_id?: number;
|
|
475
|
+
/**
|
|
476
|
+
* - A list of application IDs associated
|
|
477
|
+
* with the response.
|
|
478
|
+
*/
|
|
595
479
|
application_id?: string[];
|
|
480
|
+
/**
|
|
481
|
+
* - The extension ID associated with the response.
|
|
482
|
+
*/
|
|
596
483
|
extension_id?: string;
|
|
484
|
+
/**
|
|
485
|
+
* - The criteria for the response, such as "ALL",
|
|
486
|
+
* "EMPTY", or "SPECIFIC-EVENTS".
|
|
487
|
+
*/
|
|
597
488
|
criteria?: string;
|
|
598
489
|
};
|
|
599
490
|
/** @returns {AuthMeta} */
|
|
600
491
|
declare function AuthMeta(): AuthMeta;
|
|
601
492
|
type AuthMeta = {
|
|
493
|
+
/**
|
|
494
|
+
* - The type of authentication method used.
|
|
495
|
+
*/
|
|
602
496
|
type?: string;
|
|
497
|
+
/**
|
|
498
|
+
* - The secret key or token used for authentication.
|
|
499
|
+
*/
|
|
603
500
|
secret?: string;
|
|
604
501
|
};
|
|
605
|
-
/** @returns {
|
|
606
|
-
declare function
|
|
607
|
-
type
|
|
502
|
+
/** @returns {SubscriberDetails} */
|
|
503
|
+
declare function SubscriberDetails(): SubscriberDetails;
|
|
504
|
+
type SubscriberDetails = {
|
|
505
|
+
/**
|
|
506
|
+
* - The unique identifier of the subscriber.
|
|
507
|
+
*/
|
|
608
508
|
id?: number;
|
|
509
|
+
/**
|
|
510
|
+
* - The identifier of the user who last
|
|
511
|
+
* modified the subscriber details.
|
|
512
|
+
*/
|
|
609
513
|
modified_by?: string;
|
|
514
|
+
/**
|
|
515
|
+
* - The name of the subscriber.
|
|
516
|
+
*/
|
|
610
517
|
name?: string;
|
|
518
|
+
/**
|
|
519
|
+
* - The provider of the subscriber.
|
|
520
|
+
*/
|
|
611
521
|
provider?: string;
|
|
522
|
+
/**
|
|
523
|
+
* - The URL for the subscriber's webhook.
|
|
524
|
+
*/
|
|
612
525
|
webhook_url?: string;
|
|
613
526
|
association?: AssociationResp;
|
|
527
|
+
/**
|
|
528
|
+
* - Custom headers for the subscriber.
|
|
529
|
+
*/
|
|
614
530
|
custom_headers?: any;
|
|
615
531
|
status?: SubscriberStatus;
|
|
532
|
+
/**
|
|
533
|
+
* - The email ID associated with the subscriber.
|
|
534
|
+
*/
|
|
616
535
|
email_id?: string;
|
|
536
|
+
/**
|
|
537
|
+
* - The date and time when the subscriber
|
|
538
|
+
* details were last updated.
|
|
539
|
+
*/
|
|
617
540
|
updated_on?: string;
|
|
541
|
+
/**
|
|
542
|
+
* - The date and time when the subscriber was created.
|
|
543
|
+
*/
|
|
618
544
|
created_on?: string;
|
|
545
|
+
/**
|
|
546
|
+
* - The type of subscriber, which can either be passed as null.
|
|
547
|
+
*/
|
|
619
548
|
type?: string;
|
|
620
549
|
auth_meta?: AuthMeta;
|
|
621
550
|
event_configs?: EventConfig[];
|
|
@@ -623,85 +552,449 @@ type SubscriberResponse = {
|
|
|
623
552
|
/** @returns {Events} */
|
|
624
553
|
declare function Events(): Events;
|
|
625
554
|
type Events = {
|
|
555
|
+
/**
|
|
556
|
+
* - The slug or identifier for the event.
|
|
557
|
+
*/
|
|
626
558
|
slug?: string;
|
|
559
|
+
/**
|
|
560
|
+
* - The topic associated with the event.
|
|
561
|
+
*/
|
|
627
562
|
topic?: string;
|
|
563
|
+
/**
|
|
564
|
+
* - The queue associated with the event in case of
|
|
565
|
+
* provider as Pub/Sub.
|
|
566
|
+
*/
|
|
567
|
+
queue?: string;
|
|
568
|
+
/**
|
|
569
|
+
* - The name of the event bridge
|
|
570
|
+
* associated with the event in case of provider as AWS event bridge.
|
|
571
|
+
*/
|
|
572
|
+
event_bridge_name?: string;
|
|
573
|
+
/**
|
|
574
|
+
* - The name of the workflow related to the
|
|
575
|
+
* event in case of provider as temporal.
|
|
576
|
+
*/
|
|
577
|
+
workflow_name?: string;
|
|
578
|
+
/**
|
|
579
|
+
* - The type of detail for the event.
|
|
580
|
+
*/
|
|
581
|
+
detail_type?: string;
|
|
628
582
|
};
|
|
629
583
|
/** @returns {SubscriberConfigPostRequestV2} */
|
|
630
584
|
declare function SubscriberConfigPostRequestV2(): SubscriberConfigPostRequestV2;
|
|
631
585
|
type SubscriberConfigPostRequestV2 = {
|
|
586
|
+
/**
|
|
587
|
+
* - The name of the subscriber.
|
|
588
|
+
*/
|
|
632
589
|
name: string;
|
|
590
|
+
/**
|
|
591
|
+
* - The type of the subscriber, which may be null.
|
|
592
|
+
*/
|
|
593
|
+
type?: string;
|
|
594
|
+
/**
|
|
595
|
+
* - The URL for the subscriber's webhook.
|
|
596
|
+
*/
|
|
633
597
|
webhook_url?: string;
|
|
598
|
+
/**
|
|
599
|
+
* - The provider of the subscriber.
|
|
600
|
+
*/
|
|
634
601
|
provider: string;
|
|
635
602
|
association: Association;
|
|
603
|
+
/**
|
|
604
|
+
* - Custom headers for the subscriber.
|
|
605
|
+
*/
|
|
636
606
|
custom_headers?: any;
|
|
637
607
|
status: SubscriberStatus;
|
|
608
|
+
/**
|
|
609
|
+
* - The email ID associated with the subscriber.
|
|
610
|
+
*/
|
|
638
611
|
email_id: string;
|
|
639
612
|
auth_meta?: AuthMeta;
|
|
613
|
+
/**
|
|
614
|
+
* - The list of events associated with the subscriber.
|
|
615
|
+
*/
|
|
640
616
|
events: Events[];
|
|
641
617
|
};
|
|
642
618
|
/** @returns {SubscriberConfigUpdateRequestV2} */
|
|
643
619
|
declare function SubscriberConfigUpdateRequestV2(): SubscriberConfigUpdateRequestV2;
|
|
644
620
|
type SubscriberConfigUpdateRequestV2 = {
|
|
621
|
+
/**
|
|
622
|
+
* - The unique identifier of the subscriber to be updated.
|
|
623
|
+
*/
|
|
645
624
|
id: number;
|
|
625
|
+
/**
|
|
626
|
+
* - The name of the subscriber.
|
|
627
|
+
*/
|
|
646
628
|
name?: string;
|
|
629
|
+
/**
|
|
630
|
+
* - The type of the subscriber, which may be null.
|
|
631
|
+
*/
|
|
632
|
+
type?: string;
|
|
633
|
+
/**
|
|
634
|
+
* - The URL for the subscriber's webhook.
|
|
635
|
+
*/
|
|
647
636
|
webhook_url?: string;
|
|
637
|
+
/**
|
|
638
|
+
* - The provider of the subscriber.
|
|
639
|
+
*/
|
|
648
640
|
provider: string;
|
|
649
641
|
association?: Association;
|
|
642
|
+
/**
|
|
643
|
+
* - Custom headers for the subscriber.
|
|
644
|
+
*/
|
|
650
645
|
custom_headers?: any;
|
|
651
646
|
status: SubscriberStatus;
|
|
647
|
+
/**
|
|
648
|
+
* - The email ID associated with the subscriber.
|
|
649
|
+
*/
|
|
652
650
|
email_id?: string;
|
|
653
651
|
auth_meta?: AuthMeta;
|
|
652
|
+
/**
|
|
653
|
+
* - The list of events associated with the subscriber.
|
|
654
|
+
*/
|
|
654
655
|
events?: Events[];
|
|
655
656
|
};
|
|
656
657
|
/** @returns {SubscriberConfigPost} */
|
|
657
658
|
declare function SubscriberConfigPost(): SubscriberConfigPost;
|
|
658
659
|
type SubscriberConfigPost = {
|
|
660
|
+
/**
|
|
661
|
+
* - The name of the subscriber.
|
|
662
|
+
*/
|
|
659
663
|
name: string;
|
|
664
|
+
/**
|
|
665
|
+
* - The type of the subscriber, which can be null.
|
|
666
|
+
*/
|
|
667
|
+
type?: string;
|
|
668
|
+
/**
|
|
669
|
+
* - The URL for the subscriber's webhook.
|
|
670
|
+
*/
|
|
660
671
|
webhook_url: string;
|
|
661
672
|
association: Association;
|
|
673
|
+
/**
|
|
674
|
+
* - Custom headers for the subscriber.
|
|
675
|
+
*/
|
|
662
676
|
custom_headers?: any;
|
|
663
677
|
status: SubscriberStatus;
|
|
678
|
+
/**
|
|
679
|
+
* - The email ID associated with the subscriber.
|
|
680
|
+
*/
|
|
664
681
|
email_id: string;
|
|
665
682
|
auth_meta?: AuthMeta;
|
|
683
|
+
/**
|
|
684
|
+
* - The list of event IDs associated with the subscriber.
|
|
685
|
+
*/
|
|
666
686
|
event_id: number[];
|
|
667
687
|
};
|
|
668
688
|
/** @returns {SubscriberConfigUpdate} */
|
|
669
689
|
declare function SubscriberConfigUpdate(): SubscriberConfigUpdate;
|
|
670
690
|
type SubscriberConfigUpdate = {
|
|
691
|
+
/**
|
|
692
|
+
* - The unique identifier of the subscriber to be updated.
|
|
693
|
+
*/
|
|
671
694
|
id: number;
|
|
695
|
+
/**
|
|
696
|
+
* - The name of the subscriber.
|
|
697
|
+
*/
|
|
672
698
|
name?: string;
|
|
699
|
+
/**
|
|
700
|
+
* - The type of the subscriber, which can be null.
|
|
701
|
+
*/
|
|
702
|
+
type?: string;
|
|
703
|
+
/**
|
|
704
|
+
* - The URL for the subscriber's webhook.
|
|
705
|
+
*/
|
|
673
706
|
webhook_url?: string;
|
|
674
707
|
association?: Association;
|
|
708
|
+
/**
|
|
709
|
+
* - Custom headers for the subscriber.
|
|
710
|
+
*/
|
|
675
711
|
custom_headers?: any;
|
|
676
712
|
status?: SubscriberStatus;
|
|
713
|
+
/**
|
|
714
|
+
* - The email ID associated with the subscriber.
|
|
715
|
+
*/
|
|
677
716
|
email_id?: string;
|
|
678
717
|
auth_meta?: AuthMeta;
|
|
718
|
+
/**
|
|
719
|
+
* - The list of event IDs associated with the subscriber.
|
|
720
|
+
*/
|
|
679
721
|
event_id: number[];
|
|
680
722
|
};
|
|
681
|
-
/** @returns {
|
|
682
|
-
declare function
|
|
683
|
-
type
|
|
723
|
+
/** @returns {SubscriberConfigResult} */
|
|
724
|
+
declare function SubscriberConfigResult(): SubscriberConfigResult;
|
|
725
|
+
type SubscriberConfigResult = {
|
|
726
|
+
/**
|
|
727
|
+
* - The unique identifier of the subscriber configuration.
|
|
728
|
+
*/
|
|
684
729
|
id?: number;
|
|
730
|
+
/**
|
|
731
|
+
* - The identifier of the user who last
|
|
732
|
+
* modified the subscriber configuration.
|
|
733
|
+
*/
|
|
685
734
|
modified_by?: string;
|
|
735
|
+
/**
|
|
736
|
+
* - The name of the subscriber.
|
|
737
|
+
*/
|
|
686
738
|
name?: string;
|
|
739
|
+
/**
|
|
740
|
+
* - The URL for the subscriber's webhook.
|
|
741
|
+
*/
|
|
687
742
|
webhook_url?: string;
|
|
743
|
+
/**
|
|
744
|
+
* - The provider of the subscriber.
|
|
745
|
+
*/
|
|
688
746
|
provider?: string;
|
|
689
747
|
association?: AssociationResp;
|
|
748
|
+
/**
|
|
749
|
+
* - Custom headers for the subscriber.
|
|
750
|
+
*/
|
|
690
751
|
custom_headers?: any;
|
|
691
752
|
status?: SubscriberStatus;
|
|
753
|
+
/**
|
|
754
|
+
* - The email ID associated with the subscriber.
|
|
755
|
+
*/
|
|
692
756
|
email_id?: string;
|
|
757
|
+
/**
|
|
758
|
+
* - The date and time when the subscriber was
|
|
759
|
+
* last updated.
|
|
760
|
+
*/
|
|
693
761
|
updated_on?: string;
|
|
762
|
+
/**
|
|
763
|
+
* - The date and time when the subscriber was created.
|
|
764
|
+
*/
|
|
694
765
|
created_on?: string;
|
|
766
|
+
/**
|
|
767
|
+
* - The type of the subscriber, which can be null.
|
|
768
|
+
*/
|
|
695
769
|
type?: string;
|
|
696
770
|
auth_meta?: AuthMeta;
|
|
771
|
+
/**
|
|
772
|
+
* - The list of event IDs associated with the subscriber.
|
|
773
|
+
*/
|
|
697
774
|
event_id?: number[];
|
|
698
775
|
};
|
|
699
776
|
/** @returns {SubscriberConfigList} */
|
|
700
777
|
declare function SubscriberConfigList(): SubscriberConfigList;
|
|
701
778
|
type SubscriberConfigList = {
|
|
702
|
-
items?:
|
|
779
|
+
items?: SubscriberDetails[];
|
|
703
780
|
page?: Page;
|
|
704
781
|
};
|
|
782
|
+
/** @returns {RestEventData} */
|
|
783
|
+
declare function RestEventData(): RestEventData;
|
|
784
|
+
type RestEventData = {
|
|
785
|
+
/**
|
|
786
|
+
* - The category of the event.
|
|
787
|
+
*/
|
|
788
|
+
event_category: string;
|
|
789
|
+
/**
|
|
790
|
+
* - The name of the event.
|
|
791
|
+
*/
|
|
792
|
+
event_name: string;
|
|
793
|
+
/**
|
|
794
|
+
* - The type of the event.
|
|
795
|
+
*/
|
|
796
|
+
event_type: string;
|
|
797
|
+
/**
|
|
798
|
+
* - The version number of the event.
|
|
799
|
+
*/
|
|
800
|
+
version: number;
|
|
801
|
+
};
|
|
802
|
+
/** @returns {RestConfig} */
|
|
803
|
+
declare function RestConfig(): RestConfig;
|
|
804
|
+
type RestConfig = {
|
|
805
|
+
/**
|
|
806
|
+
* - The URL for the webhook.
|
|
807
|
+
*/
|
|
808
|
+
webhook_url: string;
|
|
809
|
+
/**
|
|
810
|
+
* - The type of the configuration.
|
|
811
|
+
*/
|
|
812
|
+
type: string;
|
|
813
|
+
/**
|
|
814
|
+
* - Custom headers for the configuration.
|
|
815
|
+
*/
|
|
816
|
+
custom_headers?: any;
|
|
817
|
+
auth_meta?: AuthMeta;
|
|
818
|
+
events: RestEventData[];
|
|
819
|
+
};
|
|
820
|
+
/** @returns {QueueEventData} */
|
|
821
|
+
declare function QueueEventData(): QueueEventData;
|
|
822
|
+
type QueueEventData = {
|
|
823
|
+
/**
|
|
824
|
+
* - The category of the event.
|
|
825
|
+
*/
|
|
826
|
+
event_category: string;
|
|
827
|
+
/**
|
|
828
|
+
* - The name of the event.
|
|
829
|
+
*/
|
|
830
|
+
event_name: string;
|
|
831
|
+
/**
|
|
832
|
+
* - The type of the event.
|
|
833
|
+
*/
|
|
834
|
+
event_type: string;
|
|
835
|
+
/**
|
|
836
|
+
* - The version number of the event.
|
|
837
|
+
*/
|
|
838
|
+
version: number;
|
|
839
|
+
/**
|
|
840
|
+
* - The topic associated with the event.
|
|
841
|
+
*/
|
|
842
|
+
topic: string;
|
|
843
|
+
};
|
|
844
|
+
/** @returns {KafkaConfig} */
|
|
845
|
+
declare function KafkaConfig(): KafkaConfig;
|
|
846
|
+
type KafkaConfig = {
|
|
847
|
+
type?: string;
|
|
848
|
+
events: QueueEventData[];
|
|
849
|
+
};
|
|
850
|
+
/** @returns {PubSubConfig} */
|
|
851
|
+
declare function PubSubConfig(): PubSubConfig;
|
|
852
|
+
type PubSubConfig = {
|
|
853
|
+
type?: string;
|
|
854
|
+
events: QueueEventData[];
|
|
855
|
+
};
|
|
856
|
+
/** @returns {TemporalEventData} */
|
|
857
|
+
declare function TemporalEventData(): TemporalEventData;
|
|
858
|
+
type TemporalEventData = {
|
|
859
|
+
/**
|
|
860
|
+
* - The category of the event.
|
|
861
|
+
*/
|
|
862
|
+
event_category: string;
|
|
863
|
+
/**
|
|
864
|
+
* - The name of the event.
|
|
865
|
+
*/
|
|
866
|
+
event_name: string;
|
|
867
|
+
/**
|
|
868
|
+
* - The type of the event.
|
|
869
|
+
*/
|
|
870
|
+
event_type: string;
|
|
871
|
+
/**
|
|
872
|
+
* - The version number of the event.
|
|
873
|
+
*/
|
|
874
|
+
version: number;
|
|
875
|
+
/**
|
|
876
|
+
* - The queue associated with the event.
|
|
877
|
+
*/
|
|
878
|
+
queue?: string;
|
|
879
|
+
/**
|
|
880
|
+
* - The workflow name related to the event.
|
|
881
|
+
*/
|
|
882
|
+
workflow_name?: string;
|
|
883
|
+
};
|
|
884
|
+
/** @returns {TemporalConfig} */
|
|
885
|
+
declare function TemporalConfig(): TemporalConfig;
|
|
886
|
+
type TemporalConfig = {
|
|
887
|
+
type?: string;
|
|
888
|
+
events: TemporalEventData[];
|
|
889
|
+
};
|
|
890
|
+
/** @returns {SqsEventData} */
|
|
891
|
+
declare function SqsEventData(): SqsEventData;
|
|
892
|
+
type SqsEventData = {
|
|
893
|
+
/**
|
|
894
|
+
* - The category of the event.
|
|
895
|
+
*/
|
|
896
|
+
event_category: string;
|
|
897
|
+
/**
|
|
898
|
+
* - The name of the event.
|
|
899
|
+
*/
|
|
900
|
+
event_name: string;
|
|
901
|
+
/**
|
|
902
|
+
* - The type of the event.
|
|
903
|
+
*/
|
|
904
|
+
event_type: string;
|
|
905
|
+
/**
|
|
906
|
+
* - The version number of the event.
|
|
907
|
+
*/
|
|
908
|
+
version: number;
|
|
909
|
+
/**
|
|
910
|
+
* - The queue name associated with the event in SQS.
|
|
911
|
+
*/
|
|
912
|
+
queue?: string;
|
|
913
|
+
};
|
|
914
|
+
/** @returns {SqsConfig} */
|
|
915
|
+
declare function SqsConfig(): SqsConfig;
|
|
916
|
+
type SqsConfig = {
|
|
917
|
+
type?: string;
|
|
918
|
+
events: SqsEventData[];
|
|
919
|
+
};
|
|
920
|
+
/** @returns {EventBridgeData} */
|
|
921
|
+
declare function EventBridgeData(): EventBridgeData;
|
|
922
|
+
type EventBridgeData = {
|
|
923
|
+
/**
|
|
924
|
+
* - The category of the event.
|
|
925
|
+
*/
|
|
926
|
+
event_category: string;
|
|
927
|
+
/**
|
|
928
|
+
* - The name of the event.
|
|
929
|
+
*/
|
|
930
|
+
event_name: string;
|
|
931
|
+
/**
|
|
932
|
+
* - The type of the event.
|
|
933
|
+
*/
|
|
934
|
+
event_type: string;
|
|
935
|
+
/**
|
|
936
|
+
* - The version number of the event.
|
|
937
|
+
*/
|
|
938
|
+
version: number;
|
|
939
|
+
/**
|
|
940
|
+
* - The name of the event bridge related
|
|
941
|
+
* to the event.
|
|
942
|
+
*/
|
|
943
|
+
event_bridge_name?: string;
|
|
944
|
+
};
|
|
945
|
+
/** @returns {EventBridgeConfig} */
|
|
946
|
+
declare function EventBridgeConfig(): EventBridgeConfig;
|
|
947
|
+
type EventBridgeConfig = {
|
|
948
|
+
type?: string;
|
|
949
|
+
events: EventBridgeData[];
|
|
950
|
+
};
|
|
951
|
+
/** @returns {EventMapBody} */
|
|
952
|
+
declare function EventMapBody(): EventMapBody;
|
|
953
|
+
type EventMapBody = {
|
|
954
|
+
rest?: RestConfig;
|
|
955
|
+
kafka?: KafkaConfig;
|
|
956
|
+
pub_sub?: PubSubConfig;
|
|
957
|
+
temporal?: TemporalConfig;
|
|
958
|
+
sqs?: SqsConfig;
|
|
959
|
+
event_bridge?: EventBridgeConfig;
|
|
960
|
+
};
|
|
961
|
+
/** @returns {WebhookConfig} */
|
|
962
|
+
declare function WebhookConfig(): WebhookConfig;
|
|
963
|
+
type WebhookConfig = {
|
|
964
|
+
/**
|
|
965
|
+
* - The email address for notifications.
|
|
966
|
+
*/
|
|
967
|
+
notification_email?: string;
|
|
968
|
+
/**
|
|
969
|
+
* - The name of the webhook configuration.
|
|
970
|
+
*/
|
|
971
|
+
name?: string;
|
|
972
|
+
/**
|
|
973
|
+
* - The status of the webhook (e.g., active or inactive).
|
|
974
|
+
*/
|
|
975
|
+
status?: string;
|
|
976
|
+
association?: Association;
|
|
977
|
+
event_map?: EventMapBody;
|
|
978
|
+
};
|
|
979
|
+
/** @returns {UpsertSubscriberConfig} */
|
|
980
|
+
declare function UpsertSubscriberConfig(): UpsertSubscriberConfig;
|
|
981
|
+
type UpsertSubscriberConfig = {
|
|
982
|
+
webhook_config: WebhookConfig;
|
|
983
|
+
};
|
|
984
|
+
/** @returns {UpsertSubscriberConfigResult} */
|
|
985
|
+
declare function UpsertSubscriberConfigResult(): UpsertSubscriberConfigResult;
|
|
986
|
+
type UpsertSubscriberConfigResult = {
|
|
987
|
+
/**
|
|
988
|
+
* - The status of the upsert operation (e.g.,
|
|
989
|
+
* success or failure).
|
|
990
|
+
*/
|
|
991
|
+
status?: boolean;
|
|
992
|
+
/**
|
|
993
|
+
* - A message providing details about the upsert
|
|
994
|
+
* operation result.
|
|
995
|
+
*/
|
|
996
|
+
message?: string;
|
|
997
|
+
};
|
|
705
998
|
/**
|
|
706
999
|
* Enum: SubscriberStatus Used By: Webhook
|
|
707
1000
|
*
|