@gofynd/fdk-client-javascript 1.4.15-beta.3 → 1.4.15-beta.4
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 +48 -68
- package/sdk/application/Cart/CartApplicationClient.js +27 -114
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +58 -59
- package/sdk/application/Catalog/CatalogApplicationClient.js +29 -30
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +1 -1
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +20 -20
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +10 -10
- package/sdk/application/Content/ContentApplicationClient.d.ts +30 -19
- package/sdk/application/Content/ContentApplicationClient.js +54 -28
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +8 -8
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +7 -7
- package/sdk/application/Lead/LeadApplicationClient.d.ts +2 -2
- package/sdk/application/Lead/LeadApplicationClient.js +1 -1
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +15 -35
- package/sdk/application/Logistic/LogisticApplicationClient.js +8 -89
- package/sdk/application/Order/OrderApplicationClient.d.ts +12 -22
- package/sdk/application/Order/OrderApplicationClient.js +8 -47
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +87 -87
- package/sdk/application/Payment/PaymentApplicationClient.js +46 -46
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +2 -2
- package/sdk/application/Theme/ThemeApplicationClient.js +2 -4
- package/sdk/application/User/UserApplicationClient.d.ts +10 -10
- package/sdk/application/User/UserApplicationClient.js +6 -6
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +3 -3
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +12 -86
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +24 -582
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +19 -116
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +14 -121
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +1 -8
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -51
- 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 +20 -126
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +20 -970
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +167 -1200
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +160 -571
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +0 -10
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +7 -121
- package/sdk/partner/OAuthClient.js +1 -0
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +10 -8
- package/sdk/partner/Theme/ThemePartnerClient.js +16 -14
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +37 -96
- package/sdk/partner/Theme/ThemePartnerModel.js +36 -90
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -28
- package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -103
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +179 -612
- package/sdk/partner/Webhook/WebhookPartnerModel.js +150 -253
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +0 -1
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -11
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +4 -5
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +8 -14
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +9 -59
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +4 -40
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +32 -2
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +243 -3
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +130 -11
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +152 -12
- 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 +103 -134
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +115 -419
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +65 -118
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +44 -109
- package/sdk/platform/Cart/CartPlatformModel.d.ts +1298 -5037
- package/sdk/platform/Cart/CartPlatformModel.js +1217 -1976
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +183 -209
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +400 -457
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +142 -185
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +78 -96
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +117 -154
- package/sdk/platform/Catalog/CatalogPlatformClient.js +172 -292
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1647 -6385
- package/sdk/platform/Catalog/CatalogPlatformModel.js +1680 -3217
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +31 -72
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +24 -50
- package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -3
- package/sdk/platform/Common/CommonPlatformClient.js +2 -3
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +17 -16
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +17 -16
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +33 -43
- package/sdk/platform/Communication/CommunicationPlatformModel.js +34 -38
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +42 -46
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +43 -47
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +212 -210
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +33 -46
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +54 -67
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +24 -45
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +30 -134
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +131 -283
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +97 -219
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +9 -37
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +8 -27
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +141 -124
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +422 -449
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +141 -179
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +130 -168
- package/sdk/platform/Content/ContentPlatformClient.d.ts +106 -142
- package/sdk/platform/Content/ContentPlatformClient.js +336 -523
- package/sdk/platform/Content/ContentPlatformModel.d.ts +395 -1241
- package/sdk/platform/Content/ContentPlatformModel.js +390 -521
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +117 -168
- package/sdk/platform/Content/ContentPlatformValidator.js +108 -162
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +12 -14
- package/sdk/platform/Discount/DiscountPlatformClient.js +12 -14
- 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 +36 -94
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +60 -462
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +15 -62
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +13 -75
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +19 -19
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +21 -21
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +101 -370
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +84 -313
- 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 +2890 -0
- package/sdk/platform/Finance/FinancePlatformModel.js +2148 -0
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +284 -0
- package/sdk/platform/Finance/FinancePlatformValidator.js +354 -0
- 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 +6 -17
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +7 -85
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +24 -95
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +19 -39
- package/sdk/platform/Order/OrderPlatformClient.d.ts +96 -153
- package/sdk/platform/Order/OrderPlatformClient.js +198 -416
- package/sdk/platform/Order/OrderPlatformModel.d.ts +1286 -7619
- package/sdk/platform/Order/OrderPlatformModel.js +1265 -3922
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +109 -270
- package/sdk/platform/Order/OrderPlatformValidator.js +77 -135
- 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 +8 -8
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +105 -93
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +141 -129
- 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 +319 -333
- package/sdk/platform/Payment/PaymentPlatformModel.js +278 -288
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
- package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
- 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 +9 -9
- package/sdk/platform/Rewards/RewardsPlatformModel.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +36 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +41 -132
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +17 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +14 -34
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +46 -40
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +64 -58
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +612 -1845
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +554 -886
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +46 -42
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +28 -26
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.js +2 -2
- package/sdk/platform/Share/SharePlatformModel.d.ts +5 -36
- package/sdk/platform/Share/SharePlatformModel.js +4 -27
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +4 -8
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +0 -5
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +0 -2
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +11 -37
- package/sdk/platform/Theme/ThemePlatformModel.js +15 -33
- 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 +78 -25
- package/sdk/platform/Webhook/WebhookPlatformClient.js +470 -75
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +427 -720
- package/sdk/platform/Webhook/WebhookPlatformModel.js +386 -410
- 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 +2 -3
- package/sdk/public/Configuration/ConfigurationPublicClient.js +5 -6
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
- package/sdk/public/Content/ContentPublicClient.d.ts +2 -112
- package/sdk/public/Content/ContentPublicClient.js +5 -791
- package/sdk/public/Content/ContentPublicModel.d.ts +3 -549
- package/sdk/public/Content/ContentPublicModel.js +3 -649
- package/sdk/public/Content/ContentPublicValidator.d.ts +3 -69
- package/sdk/public/Content/ContentPublicValidator.js +2 -88
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
- 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/Finance/FinanceApplicationClient.d.ts +0 -29
- package/sdk/application/Finance/FinanceApplicationClient.js +0 -105
|
@@ -1,4 +1,44 @@
|
|
|
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
|
+
*/
|
|
2
42
|
/**
|
|
3
43
|
* @typedef Page
|
|
4
44
|
* @property {number} [item_total] - The total number of items on the page.
|
|
@@ -10,290 +50,305 @@ export = WebhookPlatformModel;
|
|
|
10
50
|
* @property {number} [size] - The number of items per page.
|
|
11
51
|
*/
|
|
12
52
|
/**
|
|
13
|
-
* @typedef
|
|
14
|
-
* @property {string}
|
|
15
|
-
* @property {
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
* @
|
|
21
|
-
* @property {string} [
|
|
22
|
-
*
|
|
53
|
+
* @typedef PingWebhook
|
|
54
|
+
* @property {string} webhook_url - The URL of the subscriber's webhook to ping.
|
|
55
|
+
* @property {Object} [auth_meta] - Authentication metadata (if required by the
|
|
56
|
+
* subscriber).
|
|
57
|
+
* @property {Object} [custom_headers] - Custom headers to include in the ping request.
|
|
58
|
+
*/
|
|
59
|
+
/**
|
|
60
|
+
* @typedef PingWebhookResponse
|
|
61
|
+
* @property {string} [status] - The status of the ping (e.g., "SUCCESS").
|
|
62
|
+
* @property {string} [message] - An optional message related to the ping.
|
|
63
|
+
* @property {number} [code] - The HTTP status code of the ping response (e.g., 200).
|
|
23
64
|
*/
|
|
24
65
|
/**
|
|
25
66
|
* @typedef SubscriberEventMapping
|
|
26
|
-
* @property {number} [id]
|
|
27
|
-
* @property {number} [event_id]
|
|
28
|
-
* @property {number} [subscriber_id]
|
|
29
|
-
* @property {
|
|
30
|
-
* @property {string} [created_on]
|
|
31
|
-
* mapping was created.
|
|
67
|
+
* @property {number} [id]
|
|
68
|
+
* @property {number} [event_id]
|
|
69
|
+
* @property {number} [subscriber_id]
|
|
70
|
+
* @property {string} [topic]
|
|
71
|
+
* @property {string} [created_on]
|
|
32
72
|
*/
|
|
33
73
|
/**
|
|
34
74
|
* @typedef EventConfig
|
|
35
|
-
* @property {number} [id]
|
|
36
|
-
* @property {string} [
|
|
37
|
-
* @property {string} [
|
|
38
|
-
* @property {string} [
|
|
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.
|
|
75
|
+
* @property {number} [id]
|
|
76
|
+
* @property {string} [event_name]
|
|
77
|
+
* @property {string} [event_type]
|
|
78
|
+
* @property {string} [event_category]
|
|
42
79
|
* @property {SubscriberEventMapping} [subscriber_event_mapping]
|
|
43
|
-
* @property {Object} [event_schema]
|
|
44
|
-
*
|
|
45
|
-
* @property {string} [
|
|
46
|
-
*
|
|
47
|
-
* @property {string} [
|
|
48
|
-
* @property {string} [
|
|
49
|
-
* @property {string} [
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
*
|
|
53
|
-
* @property {string} [updated_on] - The date and time when the event
|
|
54
|
-
* configuration was last updated.
|
|
55
|
-
*/
|
|
56
|
-
/**
|
|
57
|
-
* @typedef EventConfigResult
|
|
80
|
+
* @property {Object} [event_schema]
|
|
81
|
+
* @property {string} [group]
|
|
82
|
+
* @property {string} [version]
|
|
83
|
+
* @property {string} [display_name]
|
|
84
|
+
* @property {string} [description]
|
|
85
|
+
* @property {string} [created_on]
|
|
86
|
+
* @property {string} [updated_on]
|
|
87
|
+
*/
|
|
88
|
+
/**
|
|
89
|
+
* @typedef EventConfigResponse
|
|
58
90
|
* @property {EventConfig[]} [event_configs]
|
|
59
91
|
*/
|
|
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
|
+
*/
|
|
60
161
|
/**
|
|
61
162
|
* @typedef Association
|
|
62
|
-
* @property {string[]} [application_id]
|
|
63
|
-
*
|
|
64
|
-
* @property {string} [
|
|
65
|
-
* @property {string} [criteria] - The criteria for the association, such as
|
|
66
|
-
* "ALL", "EMPTY", or "SPECIFIC-EVENTS".
|
|
163
|
+
* @property {string[]} [application_id]
|
|
164
|
+
* @property {string} [extension_id]
|
|
165
|
+
* @property {string} [criteria]
|
|
67
166
|
*/
|
|
68
167
|
/**
|
|
69
168
|
* @typedef AssociationResp
|
|
70
|
-
* @property {number} [company_id]
|
|
71
|
-
* @property {string[]} [application_id]
|
|
72
|
-
*
|
|
73
|
-
* @property {string} [
|
|
74
|
-
* @property {string} [criteria] - The criteria for the response, such as "ALL",
|
|
75
|
-
* "EMPTY", or "SPECIFIC-EVENTS".
|
|
169
|
+
* @property {number} [company_id]
|
|
170
|
+
* @property {string[]} [application_id]
|
|
171
|
+
* @property {string} [extension_id]
|
|
172
|
+
* @property {string} [criteria]
|
|
76
173
|
*/
|
|
77
174
|
/**
|
|
78
175
|
* @typedef AuthMeta
|
|
79
|
-
* @property {string} [type]
|
|
80
|
-
* @property {string} [secret]
|
|
176
|
+
* @property {string} [type]
|
|
177
|
+
* @property {string} [secret]
|
|
81
178
|
*/
|
|
82
179
|
/**
|
|
83
|
-
* @typedef
|
|
84
|
-
* @property {number} [id]
|
|
85
|
-
* @property {string} [modified_by]
|
|
86
|
-
*
|
|
87
|
-
* @property {string} [
|
|
88
|
-
* @property {string} [
|
|
89
|
-
* @property {string} [webhook_url] - The URL for the subscriber's webhook.
|
|
180
|
+
* @typedef SubscriberResponse
|
|
181
|
+
* @property {number} [id]
|
|
182
|
+
* @property {string} [modified_by]
|
|
183
|
+
* @property {string} [name]
|
|
184
|
+
* @property {string} [provider]
|
|
185
|
+
* @property {string} [webhook_url]
|
|
90
186
|
* @property {AssociationResp} [association]
|
|
91
|
-
* @property {Object} [custom_headers]
|
|
187
|
+
* @property {Object} [custom_headers]
|
|
92
188
|
* @property {SubscriberStatus} [status]
|
|
93
|
-
* @property {string} [email_id]
|
|
94
|
-
* @property {string} [updated_on]
|
|
95
|
-
*
|
|
96
|
-
* @property {string} [
|
|
97
|
-
* @property {string} [type] - The type of subscriber, which can either be passed as null.
|
|
189
|
+
* @property {string} [email_id]
|
|
190
|
+
* @property {string} [updated_on]
|
|
191
|
+
* @property {string} [created_on]
|
|
192
|
+
* @property {string} [type]
|
|
98
193
|
* @property {AuthMeta} [auth_meta]
|
|
99
194
|
* @property {EventConfig[]} [event_configs]
|
|
100
195
|
*/
|
|
101
196
|
/**
|
|
102
197
|
* @typedef Events
|
|
103
|
-
* @property {string} [slug]
|
|
104
|
-
* @property {string} [topic]
|
|
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.
|
|
198
|
+
* @property {string} [slug]
|
|
199
|
+
* @property {string} [topic]
|
|
112
200
|
*/
|
|
113
201
|
/**
|
|
114
202
|
* @typedef SubscriberConfigPostRequestV2
|
|
115
|
-
* @property {string} name
|
|
116
|
-
* @property {string} [
|
|
117
|
-
* @property {string}
|
|
118
|
-
* @property {string} provider - The provider of the subscriber.
|
|
203
|
+
* @property {string} name
|
|
204
|
+
* @property {string} [webhook_url]
|
|
205
|
+
* @property {string} provider
|
|
119
206
|
* @property {Association} association
|
|
120
|
-
* @property {Object} [custom_headers]
|
|
207
|
+
* @property {Object} [custom_headers]
|
|
121
208
|
* @property {SubscriberStatus} status
|
|
122
|
-
* @property {string} email_id
|
|
209
|
+
* @property {string} email_id
|
|
123
210
|
* @property {AuthMeta} [auth_meta]
|
|
124
|
-
* @property {Events[]} events
|
|
211
|
+
* @property {Events[]} events
|
|
125
212
|
*/
|
|
126
213
|
/**
|
|
127
214
|
* @typedef SubscriberConfigUpdateRequestV2
|
|
128
|
-
* @property {number} id
|
|
129
|
-
* @property {string} [name]
|
|
130
|
-
* @property {string} [
|
|
131
|
-
* @property {string}
|
|
132
|
-
* @property {string} provider - The provider of the subscriber.
|
|
215
|
+
* @property {number} id
|
|
216
|
+
* @property {string} [name]
|
|
217
|
+
* @property {string} [webhook_url]
|
|
218
|
+
* @property {string} provider
|
|
133
219
|
* @property {Association} [association]
|
|
134
|
-
* @property {Object} [custom_headers]
|
|
220
|
+
* @property {Object} [custom_headers]
|
|
135
221
|
* @property {SubscriberStatus} status
|
|
136
|
-
* @property {string} [email_id]
|
|
222
|
+
* @property {string} [email_id]
|
|
137
223
|
* @property {AuthMeta} [auth_meta]
|
|
138
|
-
* @property {Events[]} [events]
|
|
224
|
+
* @property {Events[]} [events]
|
|
139
225
|
*/
|
|
140
226
|
/**
|
|
141
227
|
* @typedef SubscriberConfigPost
|
|
142
|
-
* @property {string} name
|
|
143
|
-
* @property {string}
|
|
144
|
-
* @property {string} webhook_url - The URL for the subscriber's webhook.
|
|
228
|
+
* @property {string} name
|
|
229
|
+
* @property {string} webhook_url
|
|
145
230
|
* @property {Association} association
|
|
146
|
-
* @property {Object} [custom_headers]
|
|
231
|
+
* @property {Object} [custom_headers]
|
|
147
232
|
* @property {SubscriberStatus} status
|
|
148
|
-
* @property {string} email_id
|
|
233
|
+
* @property {string} email_id
|
|
149
234
|
* @property {AuthMeta} [auth_meta]
|
|
150
|
-
* @property {number[]} event_id
|
|
235
|
+
* @property {number[]} event_id
|
|
151
236
|
*/
|
|
152
237
|
/**
|
|
153
238
|
* @typedef SubscriberConfigUpdate
|
|
154
|
-
* @property {number} id
|
|
155
|
-
* @property {string} [name]
|
|
156
|
-
* @property {string} [
|
|
157
|
-
* @property {string} [webhook_url] - The URL for the subscriber's webhook.
|
|
239
|
+
* @property {number} id
|
|
240
|
+
* @property {string} [name]
|
|
241
|
+
* @property {string} [webhook_url]
|
|
158
242
|
* @property {Association} [association]
|
|
159
|
-
* @property {Object} [custom_headers]
|
|
243
|
+
* @property {Object} [custom_headers]
|
|
160
244
|
* @property {SubscriberStatus} [status]
|
|
161
|
-
* @property {string} [email_id]
|
|
245
|
+
* @property {string} [email_id]
|
|
162
246
|
* @property {AuthMeta} [auth_meta]
|
|
163
|
-
* @property {number[]} event_id
|
|
247
|
+
* @property {number[]} event_id
|
|
164
248
|
*/
|
|
165
249
|
/**
|
|
166
|
-
* @typedef
|
|
167
|
-
* @property {number} [id]
|
|
168
|
-
* @property {string} [modified_by]
|
|
169
|
-
*
|
|
170
|
-
* @property {string} [
|
|
171
|
-
* @property {string} [
|
|
172
|
-
* @property {string} [provider] - The provider of the subscriber.
|
|
250
|
+
* @typedef SubscriberConfigResponse
|
|
251
|
+
* @property {number} [id]
|
|
252
|
+
* @property {string} [modified_by]
|
|
253
|
+
* @property {string} [name]
|
|
254
|
+
* @property {string} [webhook_url]
|
|
255
|
+
* @property {string} [provider]
|
|
173
256
|
* @property {AssociationResp} [association]
|
|
174
|
-
* @property {Object} [custom_headers]
|
|
257
|
+
* @property {Object} [custom_headers]
|
|
175
258
|
* @property {SubscriberStatus} [status]
|
|
176
|
-
* @property {string} [email_id]
|
|
177
|
-
* @property {string} [updated_on]
|
|
178
|
-
*
|
|
179
|
-
* @property {string} [
|
|
180
|
-
* @property {string} [type] - The type of the subscriber, which can be null.
|
|
259
|
+
* @property {string} [email_id]
|
|
260
|
+
* @property {string} [updated_on]
|
|
261
|
+
* @property {string} [created_on]
|
|
262
|
+
* @property {string} [type]
|
|
181
263
|
* @property {AuthMeta} [auth_meta]
|
|
182
|
-
* @property {number[]} [event_id]
|
|
264
|
+
* @property {number[]} [event_id]
|
|
183
265
|
*/
|
|
184
266
|
/**
|
|
185
267
|
* @typedef SubscriberConfigList
|
|
186
|
-
* @property {
|
|
268
|
+
* @property {SubscriberResponse[]} [items]
|
|
187
269
|
* @property {Page} [page]
|
|
188
270
|
*/
|
|
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
|
-
*/
|
|
291
271
|
/** @typedef {"active" | "inactive"} SubscriberStatus */
|
|
292
272
|
declare class WebhookPlatformModel {
|
|
293
273
|
}
|
|
294
274
|
declare namespace WebhookPlatformModel {
|
|
295
|
-
export {
|
|
275
|
+
export { Event, EventProcessRequest, DownloadReportResponse, EventProcessReports, EventProcessReportObject, Page, PingWebhook, PingWebhookResponse, SubscriberEventMapping, EventConfig, EventConfigResponse, ReportFiltersPayload, ReportFilterResponse, HistoryPayload, HistoryFilters, Url, CdnObject, UploadServiceObject, HistoryAssociation, HistoryItems, HistoryResponse, CancelResponse, Association, AssociationResp, AuthMeta, SubscriberResponse, Events, SubscriberConfigPostRequestV2, SubscriberConfigUpdateRequestV2, SubscriberConfigPost, SubscriberConfigUpdate, SubscriberConfigResponse, SubscriberConfigList, SubscriberStatus };
|
|
296
276
|
}
|
|
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
|
+
};
|
|
297
352
|
/** @returns {Page} */
|
|
298
353
|
declare function Page(): Page;
|
|
299
354
|
type Page = {
|
|
@@ -326,225 +381,241 @@ type Page = {
|
|
|
326
381
|
*/
|
|
327
382
|
size?: number;
|
|
328
383
|
};
|
|
329
|
-
/** @returns {
|
|
330
|
-
declare function
|
|
331
|
-
type
|
|
384
|
+
/** @returns {PingWebhook} */
|
|
385
|
+
declare function PingWebhook(): PingWebhook;
|
|
386
|
+
type PingWebhook = {
|
|
332
387
|
/**
|
|
333
|
-
* - The
|
|
388
|
+
* - The URL of the subscriber's webhook to ping.
|
|
334
389
|
*/
|
|
335
|
-
|
|
390
|
+
webhook_url: string;
|
|
336
391
|
/**
|
|
337
|
-
* -
|
|
392
|
+
* - Authentication metadata (if required by the
|
|
393
|
+
* subscriber).
|
|
338
394
|
*/
|
|
339
|
-
|
|
395
|
+
auth_meta?: any;
|
|
340
396
|
/**
|
|
341
|
-
* -
|
|
342
|
-
* associated with the broadcaster.
|
|
397
|
+
* - Custom headers to include in the ping request.
|
|
343
398
|
*/
|
|
344
|
-
|
|
399
|
+
custom_headers?: any;
|
|
400
|
+
};
|
|
401
|
+
/** @returns {PingWebhookResponse} */
|
|
402
|
+
declare function PingWebhookResponse(): PingWebhookResponse;
|
|
403
|
+
type PingWebhookResponse = {
|
|
345
404
|
/**
|
|
346
|
-
* - The
|
|
347
|
-
* broadcaster.
|
|
405
|
+
* - The status of the ping (e.g., "SUCCESS").
|
|
348
406
|
*/
|
|
349
|
-
|
|
407
|
+
status?: string;
|
|
350
408
|
/**
|
|
351
|
-
* -
|
|
409
|
+
* - An optional message related to the ping.
|
|
352
410
|
*/
|
|
353
|
-
|
|
411
|
+
message?: string;
|
|
354
412
|
/**
|
|
355
|
-
* - The
|
|
356
|
-
* configuration.
|
|
413
|
+
* - The HTTP status code of the ping response (e.g., 200).
|
|
357
414
|
*/
|
|
358
|
-
|
|
415
|
+
code?: number;
|
|
359
416
|
};
|
|
360
417
|
/** @returns {SubscriberEventMapping} */
|
|
361
418
|
declare function SubscriberEventMapping(): SubscriberEventMapping;
|
|
362
419
|
type SubscriberEventMapping = {
|
|
363
|
-
/**
|
|
364
|
-
* - The unique identifier for the subscriber event mapping.
|
|
365
|
-
*/
|
|
366
420
|
id?: number;
|
|
367
|
-
/**
|
|
368
|
-
* - The ID of the event associated with the subscriber.
|
|
369
|
-
*/
|
|
370
421
|
event_id?: number;
|
|
371
|
-
/**
|
|
372
|
-
* - The ID of the subscriber.
|
|
373
|
-
*/
|
|
374
422
|
subscriber_id?: number;
|
|
375
|
-
|
|
376
|
-
/**
|
|
377
|
-
* - The date and time when the subscriber event
|
|
378
|
-
* mapping was created.
|
|
379
|
-
*/
|
|
423
|
+
topic?: string;
|
|
380
424
|
created_on?: string;
|
|
381
425
|
};
|
|
382
426
|
/** @returns {EventConfig} */
|
|
383
427
|
declare function EventConfig(): EventConfig;
|
|
384
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 = {
|
|
385
450
|
/**
|
|
386
|
-
* -
|
|
451
|
+
* - An array of subscriber IDs for
|
|
452
|
+
* filtering filters (optional).
|
|
387
453
|
*/
|
|
388
|
-
|
|
454
|
+
subscriber_ids: number[];
|
|
455
|
+
};
|
|
456
|
+
/** @returns {ReportFilterResponse} */
|
|
457
|
+
declare function ReportFilterResponse(): ReportFilterResponse;
|
|
458
|
+
type ReportFilterResponse = {
|
|
389
459
|
/**
|
|
390
|
-
* - The
|
|
460
|
+
* - The name of the filter.
|
|
391
461
|
*/
|
|
392
|
-
|
|
462
|
+
filter_name?: string;
|
|
463
|
+
values?: any[];
|
|
464
|
+
};
|
|
465
|
+
/** @returns {HistoryPayload} */
|
|
466
|
+
declare function HistoryPayload(): HistoryPayload;
|
|
467
|
+
type HistoryPayload = {
|
|
393
468
|
/**
|
|
394
|
-
* - The
|
|
469
|
+
* - The type of history report (e.g., "platform").
|
|
395
470
|
*/
|
|
396
|
-
|
|
471
|
+
type: string;
|
|
397
472
|
/**
|
|
398
|
-
* - The
|
|
473
|
+
* - The page number of the history report.
|
|
399
474
|
*/
|
|
400
|
-
|
|
475
|
+
page_no?: number;
|
|
401
476
|
/**
|
|
402
|
-
* - The
|
|
477
|
+
* - The number of records per page.
|
|
403
478
|
*/
|
|
404
|
-
|
|
479
|
+
page_size?: number;
|
|
480
|
+
};
|
|
481
|
+
/** @returns {HistoryFilters} */
|
|
482
|
+
declare function HistoryFilters(): HistoryFilters;
|
|
483
|
+
type HistoryFilters = {
|
|
484
|
+
events?: string[];
|
|
485
|
+
search_text?: string;
|
|
405
486
|
/**
|
|
406
|
-
* - The
|
|
407
|
-
* modified the event configuration.
|
|
487
|
+
* - The status of the history report (e.g., "FAILED").
|
|
408
488
|
*/
|
|
409
|
-
|
|
410
|
-
subscriber_event_mapping?: SubscriberEventMapping;
|
|
489
|
+
status?: string;
|
|
411
490
|
/**
|
|
412
|
-
* - The
|
|
413
|
-
* additional properties and may be null.
|
|
491
|
+
* - The end date and time of the history report.
|
|
414
492
|
*/
|
|
415
|
-
|
|
493
|
+
end_date?: string;
|
|
416
494
|
/**
|
|
417
|
-
* - The
|
|
418
|
-
* configuration, which may be null.
|
|
495
|
+
* - The start date and time of the history report.
|
|
419
496
|
*/
|
|
420
|
-
|
|
497
|
+
start_date?: string;
|
|
421
498
|
/**
|
|
422
|
-
* -
|
|
499
|
+
* - An array of subscriber IDs associated
|
|
500
|
+
* with the history report.
|
|
423
501
|
*/
|
|
424
|
-
|
|
502
|
+
subscribers?: number[];
|
|
425
503
|
/**
|
|
426
|
-
* -
|
|
504
|
+
* - An array of webhook type to identify
|
|
505
|
+
* thetype of subscriber i.e (KAFKA or REST).
|
|
427
506
|
*/
|
|
428
|
-
|
|
507
|
+
webhook_type?: string[];
|
|
508
|
+
};
|
|
509
|
+
/** @returns {Url} */
|
|
510
|
+
declare function Url(): Url;
|
|
511
|
+
type Url = {
|
|
429
512
|
/**
|
|
430
|
-
* -
|
|
431
|
-
* which may be null.
|
|
513
|
+
* - The URL of the uploaded report file.
|
|
432
514
|
*/
|
|
433
|
-
|
|
515
|
+
url?: string;
|
|
516
|
+
/**
|
|
517
|
+
* - The name of the uploaded report file.
|
|
518
|
+
*/
|
|
519
|
+
name?: string;
|
|
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 = {
|
|
434
540
|
/**
|
|
435
|
-
* - The
|
|
436
|
-
|
|
541
|
+
* - The ID of the history report.
|
|
542
|
+
*/
|
|
543
|
+
id?: number;
|
|
544
|
+
association?: HistoryAssociation;
|
|
545
|
+
filters?: HistoryFilters;
|
|
546
|
+
/**
|
|
547
|
+
* - The filename of the history report.
|
|
548
|
+
*/
|
|
549
|
+
filename?: string;
|
|
550
|
+
/**
|
|
551
|
+
* - The status of the history report (e.g., "COMPLETED").
|
|
552
|
+
*/
|
|
553
|
+
status?: string;
|
|
554
|
+
upload_service_response?: UploadServiceObject;
|
|
555
|
+
/**
|
|
556
|
+
* - The date and time when the history report
|
|
557
|
+
* was created.
|
|
437
558
|
*/
|
|
438
559
|
created_on?: string;
|
|
439
560
|
/**
|
|
440
|
-
* - The date and time when the
|
|
441
|
-
*
|
|
561
|
+
* - The date and time when the history report
|
|
562
|
+
* was last updated.
|
|
442
563
|
*/
|
|
443
564
|
updated_on?: string;
|
|
565
|
+
/**
|
|
566
|
+
* - A message related to the history report.
|
|
567
|
+
*/
|
|
568
|
+
message?: string;
|
|
444
569
|
};
|
|
445
|
-
/** @returns {
|
|
446
|
-
declare function
|
|
447
|
-
type
|
|
448
|
-
|
|
570
|
+
/** @returns {HistoryResponse} */
|
|
571
|
+
declare function HistoryResponse(): HistoryResponse;
|
|
572
|
+
type HistoryResponse = {
|
|
573
|
+
items?: HistoryItems[];
|
|
574
|
+
page?: Page;
|
|
575
|
+
};
|
|
576
|
+
/** @returns {CancelResponse} */
|
|
577
|
+
declare function CancelResponse(): CancelResponse;
|
|
578
|
+
type CancelResponse = {
|
|
579
|
+
/**
|
|
580
|
+
* - The HTTP status code of the response (e.g., 200).
|
|
581
|
+
*/
|
|
582
|
+
message?: string;
|
|
449
583
|
};
|
|
450
584
|
/** @returns {Association} */
|
|
451
585
|
declare function Association(): Association;
|
|
452
586
|
type Association = {
|
|
453
|
-
/**
|
|
454
|
-
* - A list of application IDs associated
|
|
455
|
-
* with the association.
|
|
456
|
-
*/
|
|
457
587
|
application_id?: string[];
|
|
458
|
-
/**
|
|
459
|
-
* - The extension ID associated with the association.
|
|
460
|
-
*/
|
|
461
588
|
extension_id?: string;
|
|
462
|
-
/**
|
|
463
|
-
* - The criteria for the association, such as
|
|
464
|
-
* "ALL", "EMPTY", or "SPECIFIC-EVENTS".
|
|
465
|
-
*/
|
|
466
589
|
criteria?: string;
|
|
467
590
|
};
|
|
468
591
|
/** @returns {AssociationResp} */
|
|
469
592
|
declare function AssociationResp(): AssociationResp;
|
|
470
593
|
type AssociationResp = {
|
|
471
|
-
/**
|
|
472
|
-
* - The ID of the company associated with the response.
|
|
473
|
-
*/
|
|
474
594
|
company_id?: number;
|
|
475
|
-
/**
|
|
476
|
-
* - A list of application IDs associated
|
|
477
|
-
* with the response.
|
|
478
|
-
*/
|
|
479
595
|
application_id?: string[];
|
|
480
|
-
/**
|
|
481
|
-
* - The extension ID associated with the response.
|
|
482
|
-
*/
|
|
483
596
|
extension_id?: string;
|
|
484
|
-
/**
|
|
485
|
-
* - The criteria for the response, such as "ALL",
|
|
486
|
-
* "EMPTY", or "SPECIFIC-EVENTS".
|
|
487
|
-
*/
|
|
488
597
|
criteria?: string;
|
|
489
598
|
};
|
|
490
599
|
/** @returns {AuthMeta} */
|
|
491
600
|
declare function AuthMeta(): AuthMeta;
|
|
492
601
|
type AuthMeta = {
|
|
493
|
-
/**
|
|
494
|
-
* - The type of authentication method used.
|
|
495
|
-
*/
|
|
496
602
|
type?: string;
|
|
497
|
-
/**
|
|
498
|
-
* - The secret key or token used for authentication.
|
|
499
|
-
*/
|
|
500
603
|
secret?: string;
|
|
501
604
|
};
|
|
502
|
-
/** @returns {
|
|
503
|
-
declare function
|
|
504
|
-
type
|
|
505
|
-
/**
|
|
506
|
-
* - The unique identifier of the subscriber.
|
|
507
|
-
*/
|
|
605
|
+
/** @returns {SubscriberResponse} */
|
|
606
|
+
declare function SubscriberResponse(): SubscriberResponse;
|
|
607
|
+
type SubscriberResponse = {
|
|
508
608
|
id?: number;
|
|
509
|
-
/**
|
|
510
|
-
* - The identifier of the user who last
|
|
511
|
-
* modified the subscriber details.
|
|
512
|
-
*/
|
|
513
609
|
modified_by?: string;
|
|
514
|
-
/**
|
|
515
|
-
* - The name of the subscriber.
|
|
516
|
-
*/
|
|
517
610
|
name?: string;
|
|
518
|
-
/**
|
|
519
|
-
* - The provider of the subscriber.
|
|
520
|
-
*/
|
|
521
611
|
provider?: string;
|
|
522
|
-
/**
|
|
523
|
-
* - The URL for the subscriber's webhook.
|
|
524
|
-
*/
|
|
525
612
|
webhook_url?: string;
|
|
526
613
|
association?: AssociationResp;
|
|
527
|
-
/**
|
|
528
|
-
* - Custom headers for the subscriber.
|
|
529
|
-
*/
|
|
530
614
|
custom_headers?: any;
|
|
531
615
|
status?: SubscriberStatus;
|
|
532
|
-
/**
|
|
533
|
-
* - The email ID associated with the subscriber.
|
|
534
|
-
*/
|
|
535
616
|
email_id?: string;
|
|
536
|
-
/**
|
|
537
|
-
* - The date and time when the subscriber
|
|
538
|
-
* details were last updated.
|
|
539
|
-
*/
|
|
540
617
|
updated_on?: string;
|
|
541
|
-
/**
|
|
542
|
-
* - The date and time when the subscriber was created.
|
|
543
|
-
*/
|
|
544
618
|
created_on?: string;
|
|
545
|
-
/**
|
|
546
|
-
* - The type of subscriber, which can either be passed as null.
|
|
547
|
-
*/
|
|
548
619
|
type?: string;
|
|
549
620
|
auth_meta?: AuthMeta;
|
|
550
621
|
event_configs?: EventConfig[];
|
|
@@ -552,449 +623,85 @@ type SubscriberDetails = {
|
|
|
552
623
|
/** @returns {Events} */
|
|
553
624
|
declare function Events(): Events;
|
|
554
625
|
type Events = {
|
|
555
|
-
/**
|
|
556
|
-
* - The slug or identifier for the event.
|
|
557
|
-
*/
|
|
558
626
|
slug?: string;
|
|
559
|
-
/**
|
|
560
|
-
* - The topic associated with the event.
|
|
561
|
-
*/
|
|
562
627
|
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;
|
|
582
628
|
};
|
|
583
629
|
/** @returns {SubscriberConfigPostRequestV2} */
|
|
584
630
|
declare function SubscriberConfigPostRequestV2(): SubscriberConfigPostRequestV2;
|
|
585
631
|
type SubscriberConfigPostRequestV2 = {
|
|
586
|
-
/**
|
|
587
|
-
* - The name of the subscriber.
|
|
588
|
-
*/
|
|
589
632
|
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
|
-
*/
|
|
597
633
|
webhook_url?: string;
|
|
598
|
-
/**
|
|
599
|
-
* - The provider of the subscriber.
|
|
600
|
-
*/
|
|
601
634
|
provider: string;
|
|
602
635
|
association: Association;
|
|
603
|
-
/**
|
|
604
|
-
* - Custom headers for the subscriber.
|
|
605
|
-
*/
|
|
606
636
|
custom_headers?: any;
|
|
607
637
|
status: SubscriberStatus;
|
|
608
|
-
/**
|
|
609
|
-
* - The email ID associated with the subscriber.
|
|
610
|
-
*/
|
|
611
638
|
email_id: string;
|
|
612
639
|
auth_meta?: AuthMeta;
|
|
613
|
-
/**
|
|
614
|
-
* - The list of events associated with the subscriber.
|
|
615
|
-
*/
|
|
616
640
|
events: Events[];
|
|
617
641
|
};
|
|
618
642
|
/** @returns {SubscriberConfigUpdateRequestV2} */
|
|
619
643
|
declare function SubscriberConfigUpdateRequestV2(): SubscriberConfigUpdateRequestV2;
|
|
620
644
|
type SubscriberConfigUpdateRequestV2 = {
|
|
621
|
-
/**
|
|
622
|
-
* - The unique identifier of the subscriber to be updated.
|
|
623
|
-
*/
|
|
624
645
|
id: number;
|
|
625
|
-
/**
|
|
626
|
-
* - The name of the subscriber.
|
|
627
|
-
*/
|
|
628
646
|
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
|
-
*/
|
|
636
647
|
webhook_url?: string;
|
|
637
|
-
/**
|
|
638
|
-
* - The provider of the subscriber.
|
|
639
|
-
*/
|
|
640
648
|
provider: string;
|
|
641
649
|
association?: Association;
|
|
642
|
-
/**
|
|
643
|
-
* - Custom headers for the subscriber.
|
|
644
|
-
*/
|
|
645
650
|
custom_headers?: any;
|
|
646
651
|
status: SubscriberStatus;
|
|
647
|
-
/**
|
|
648
|
-
* - The email ID associated with the subscriber.
|
|
649
|
-
*/
|
|
650
652
|
email_id?: string;
|
|
651
653
|
auth_meta?: AuthMeta;
|
|
652
|
-
/**
|
|
653
|
-
* - The list of events associated with the subscriber.
|
|
654
|
-
*/
|
|
655
654
|
events?: Events[];
|
|
656
655
|
};
|
|
657
656
|
/** @returns {SubscriberConfigPost} */
|
|
658
657
|
declare function SubscriberConfigPost(): SubscriberConfigPost;
|
|
659
658
|
type SubscriberConfigPost = {
|
|
660
|
-
/**
|
|
661
|
-
* - The name of the subscriber.
|
|
662
|
-
*/
|
|
663
659
|
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
|
-
*/
|
|
671
660
|
webhook_url: string;
|
|
672
661
|
association: Association;
|
|
673
|
-
/**
|
|
674
|
-
* - Custom headers for the subscriber.
|
|
675
|
-
*/
|
|
676
662
|
custom_headers?: any;
|
|
677
663
|
status: SubscriberStatus;
|
|
678
|
-
/**
|
|
679
|
-
* - The email ID associated with the subscriber.
|
|
680
|
-
*/
|
|
681
664
|
email_id: string;
|
|
682
665
|
auth_meta?: AuthMeta;
|
|
683
|
-
/**
|
|
684
|
-
* - The list of event IDs associated with the subscriber.
|
|
685
|
-
*/
|
|
686
666
|
event_id: number[];
|
|
687
667
|
};
|
|
688
668
|
/** @returns {SubscriberConfigUpdate} */
|
|
689
669
|
declare function SubscriberConfigUpdate(): SubscriberConfigUpdate;
|
|
690
670
|
type SubscriberConfigUpdate = {
|
|
691
|
-
/**
|
|
692
|
-
* - The unique identifier of the subscriber to be updated.
|
|
693
|
-
*/
|
|
694
671
|
id: number;
|
|
695
|
-
/**
|
|
696
|
-
* - The name of the subscriber.
|
|
697
|
-
*/
|
|
698
672
|
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
|
-
*/
|
|
706
673
|
webhook_url?: string;
|
|
707
674
|
association?: Association;
|
|
708
|
-
/**
|
|
709
|
-
* - Custom headers for the subscriber.
|
|
710
|
-
*/
|
|
711
675
|
custom_headers?: any;
|
|
712
676
|
status?: SubscriberStatus;
|
|
713
|
-
/**
|
|
714
|
-
* - The email ID associated with the subscriber.
|
|
715
|
-
*/
|
|
716
677
|
email_id?: string;
|
|
717
678
|
auth_meta?: AuthMeta;
|
|
718
|
-
/**
|
|
719
|
-
* - The list of event IDs associated with the subscriber.
|
|
720
|
-
*/
|
|
721
679
|
event_id: number[];
|
|
722
680
|
};
|
|
723
|
-
/** @returns {
|
|
724
|
-
declare function
|
|
725
|
-
type
|
|
726
|
-
/**
|
|
727
|
-
* - The unique identifier of the subscriber configuration.
|
|
728
|
-
*/
|
|
681
|
+
/** @returns {SubscriberConfigResponse} */
|
|
682
|
+
declare function SubscriberConfigResponse(): SubscriberConfigResponse;
|
|
683
|
+
type SubscriberConfigResponse = {
|
|
729
684
|
id?: number;
|
|
730
|
-
/**
|
|
731
|
-
* - The identifier of the user who last
|
|
732
|
-
* modified the subscriber configuration.
|
|
733
|
-
*/
|
|
734
685
|
modified_by?: string;
|
|
735
|
-
/**
|
|
736
|
-
* - The name of the subscriber.
|
|
737
|
-
*/
|
|
738
686
|
name?: string;
|
|
739
|
-
/**
|
|
740
|
-
* - The URL for the subscriber's webhook.
|
|
741
|
-
*/
|
|
742
687
|
webhook_url?: string;
|
|
743
|
-
/**
|
|
744
|
-
* - The provider of the subscriber.
|
|
745
|
-
*/
|
|
746
688
|
provider?: string;
|
|
747
689
|
association?: AssociationResp;
|
|
748
|
-
/**
|
|
749
|
-
* - Custom headers for the subscriber.
|
|
750
|
-
*/
|
|
751
690
|
custom_headers?: any;
|
|
752
691
|
status?: SubscriberStatus;
|
|
753
|
-
/**
|
|
754
|
-
* - The email ID associated with the subscriber.
|
|
755
|
-
*/
|
|
756
692
|
email_id?: string;
|
|
757
|
-
/**
|
|
758
|
-
* - The date and time when the subscriber was
|
|
759
|
-
* last updated.
|
|
760
|
-
*/
|
|
761
693
|
updated_on?: string;
|
|
762
|
-
/**
|
|
763
|
-
* - The date and time when the subscriber was created.
|
|
764
|
-
*/
|
|
765
694
|
created_on?: string;
|
|
766
|
-
/**
|
|
767
|
-
* - The type of the subscriber, which can be null.
|
|
768
|
-
*/
|
|
769
695
|
type?: string;
|
|
770
696
|
auth_meta?: AuthMeta;
|
|
771
|
-
/**
|
|
772
|
-
* - The list of event IDs associated with the subscriber.
|
|
773
|
-
*/
|
|
774
697
|
event_id?: number[];
|
|
775
698
|
};
|
|
776
699
|
/** @returns {SubscriberConfigList} */
|
|
777
700
|
declare function SubscriberConfigList(): SubscriberConfigList;
|
|
778
701
|
type SubscriberConfigList = {
|
|
779
|
-
items?:
|
|
702
|
+
items?: SubscriberResponse[];
|
|
780
703
|
page?: Page;
|
|
781
704
|
};
|
|
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
|
-
};
|
|
998
705
|
/**
|
|
999
706
|
* Enum: SubscriberStatus Used By: Webhook
|
|
1000
707
|
*
|