@gofynd/fdk-client-javascript 1.4.2-beta.2 → 1.4.2-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 +1 -1
- package/package.json +1 -1
- package/sdk/application/Cart/CartApplicationModel.d.ts +1742 -1726
- package/sdk/application/Cart/CartApplicationModel.js +1497 -1481
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +1917 -1917
- package/sdk/application/Catalog/CatalogApplicationModel.js +1611 -1611
- package/sdk/application/Common/CommonApplicationModel.d.ts +235 -235
- package/sdk/application/Common/CommonApplicationModel.js +172 -172
- package/sdk/application/Communication/CommunicationApplicationModel.d.ts +72 -72
- package/sdk/application/Communication/CommunicationApplicationModel.js +64 -64
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +1614 -1614
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +1151 -1151
- package/sdk/application/Content/ContentApplicationModel.d.ts +797 -797
- package/sdk/application/Content/ContentApplicationModel.js +757 -757
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +79 -79
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +84 -84
- package/sdk/application/Lead/LeadApplicationModel.d.ts +417 -417
- package/sdk/application/Lead/LeadApplicationModel.js +301 -301
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +666 -666
- package/sdk/application/Logistic/LogisticApplicationModel.js +601 -601
- package/sdk/application/Order/OrderApplicationModel.d.ts +846 -846
- package/sdk/application/Order/OrderApplicationModel.js +822 -822
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +5 -5
- package/sdk/application/Payment/PaymentApplicationClient.js +10 -10
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +2155 -2150
- package/sdk/application/Payment/PaymentApplicationModel.js +1460 -1458
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +5 -5
- package/sdk/application/Payment/PaymentApplicationValidator.js +3 -3
- package/sdk/application/PosCart/PosCartApplicationModel.d.ts +1462 -1462
- package/sdk/application/PosCart/PosCartApplicationModel.js +1260 -1260
- package/sdk/application/Rewards/RewardsApplicationModel.d.ts +214 -214
- package/sdk/application/Rewards/RewardsApplicationModel.js +211 -211
- package/sdk/application/Share/ShareApplicationModel.d.ts +114 -114
- package/sdk/application/Share/ShareApplicationModel.js +121 -121
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +895 -895
- package/sdk/application/Theme/ThemeApplicationModel.js +684 -684
- package/sdk/application/User/UserApplicationModel.d.ts +762 -762
- package/sdk/application/User/UserApplicationModel.js +738 -738
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +63 -63
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +65 -65
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +661 -661
- package/sdk/partner/Lead/LeadPartnerModel.js +491 -491
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +223 -223
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +235 -235
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +1087 -1087
- package/sdk/partner/Theme/ThemePartnerModel.js +819 -819
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +386 -386
- package/sdk/partner/Webhook/WebhookPartnerModel.js +342 -342
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +123 -123
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +109 -109
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +801 -801
- package/sdk/platform/Billing/BillingPlatformModel.js +783 -783
- package/sdk/platform/Cart/CartPlatformModel.d.ts +3333 -3317
- package/sdk/platform/Cart/CartPlatformModel.js +2936 -2920
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1013 -1013
- package/sdk/platform/Catalog/CatalogPlatformModel.js +923 -923
- package/sdk/platform/Common/CommonPlatformModel.d.ts +255 -255
- package/sdk/platform/Common/CommonPlatformModel.js +187 -187
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +1238 -1238
- package/sdk/platform/Communication/CommunicationPlatformModel.js +1273 -1273
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +661 -661
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +692 -692
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +3198 -3198
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +2247 -2247
- package/sdk/platform/Content/ContentPlatformModel.d.ts +1833 -1833
- package/sdk/platform/Content/ContentPlatformModel.js +1837 -1837
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +245 -245
- package/sdk/platform/Discount/DiscountPlatformModel.js +248 -248
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +865 -865
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +877 -877
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +1044 -1044
- package/sdk/platform/Finance/FinancePlatformModel.js +974 -974
- package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +942 -942
- package/sdk/platform/Inventory/InventoryPlatformModel.js +1003 -1003
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +608 -608
- package/sdk/platform/Lead/LeadPlatformModel.js +465 -465
- package/sdk/platform/Order/OrderPlatformModel.d.ts +5180 -5176
- package/sdk/platform/Order/OrderPlatformModel.js +4740 -4736
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +22 -22
- package/sdk/platform/Partner/PartnerPlatformModel.js +22 -22
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +2670 -2660
- package/sdk/platform/Payment/PaymentPlatformModel.js +1831 -1827
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +204 -204
- package/sdk/platform/Rewards/RewardsPlatformModel.js +199 -199
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1505 -1507
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1532 -1536
- package/sdk/platform/Share/SharePlatformModel.d.ts +147 -147
- package/sdk/platform/Share/SharePlatformModel.js +139 -139
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +1046 -1046
- package/sdk/platform/Theme/ThemePlatformModel.js +789 -789
- package/sdk/platform/User/UserPlatformModel.d.ts +758 -758
- package/sdk/platform/User/UserPlatformModel.js +643 -643
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +439 -439
- package/sdk/platform/Webhook/WebhookPlatformModel.js +364 -364
- package/sdk/public/Billing/BillingPublicModel.d.ts +55 -55
- package/sdk/public/Billing/BillingPublicModel.js +51 -51
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +237 -237
- package/sdk/public/Configuration/ConfigurationPublicModel.js +174 -174
- package/sdk/public/Content/ContentPublicModel.d.ts +26 -26
- package/sdk/public/Content/ContentPublicModel.js +28 -28
- package/sdk/public/Inventory/InventoryPublicModel.d.ts +237 -237
- package/sdk/public/Inventory/InventoryPublicModel.js +257 -257
- package/sdk/public/Partner/PartnerPublicModel.d.ts +104 -104
- package/sdk/public/Partner/PartnerPublicModel.js +113 -113
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +87 -87
- package/sdk/public/Webhook/WebhookPublicModel.js +93 -93
|
@@ -1,395 +1,356 @@
|
|
|
1
1
|
export = WebhookPartnerModel;
|
|
2
|
+
/**
|
|
3
|
+
* @typedef UpdateSubscriberResponse
|
|
4
|
+
* @property {string} [message]
|
|
5
|
+
*/
|
|
6
|
+
/**
|
|
7
|
+
* @typedef UpdateSubscriberRequest
|
|
8
|
+
* @property {string} [status]
|
|
9
|
+
*/
|
|
2
10
|
/**
|
|
3
11
|
* @typedef Association
|
|
4
|
-
* @property {string[]} [application_id]
|
|
5
12
|
* @property {number} [company_id]
|
|
6
|
-
* @property {string} [
|
|
13
|
+
* @property {string[]} [application_id]
|
|
7
14
|
* @property {string} [extension_id]
|
|
15
|
+
* @property {string} [criteria]
|
|
8
16
|
*/
|
|
9
17
|
/**
|
|
10
18
|
* @typedef AuthMeta
|
|
11
|
-
* @property {string} [secret]
|
|
12
19
|
* @property {string} [type]
|
|
20
|
+
* @property {string} [secret]
|
|
13
21
|
*/
|
|
14
22
|
/**
|
|
15
|
-
* @typedef
|
|
16
|
-
* @property {
|
|
17
|
-
* @property {
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
* @typedef CdnObject
|
|
21
|
-
* @property {Url[]} [urls]
|
|
23
|
+
* @typedef SubscriberEventMapping
|
|
24
|
+
* @property {number} [id]
|
|
25
|
+
* @property {number} [event_id]
|
|
26
|
+
* @property {number} [subscriber_id]
|
|
27
|
+
* @property {string} [created_on]
|
|
22
28
|
*/
|
|
23
29
|
/**
|
|
24
|
-
* @typedef
|
|
25
|
-
* @property {
|
|
26
|
-
* @property {string} [
|
|
27
|
-
* @property {
|
|
28
|
-
* @property {
|
|
29
|
-
* @property {
|
|
30
|
-
* @property {string} [
|
|
31
|
-
* @property {string} [
|
|
30
|
+
* @typedef EventConfigResponse
|
|
31
|
+
* @property {number} [id]
|
|
32
|
+
* @property {string} [event_name]
|
|
33
|
+
* @property {string} [event_type]
|
|
34
|
+
* @property {string} [event_category]
|
|
35
|
+
* @property {Object} [event_schema]
|
|
36
|
+
* @property {string} [version]
|
|
37
|
+
* @property {string} [display_name]
|
|
38
|
+
* @property {string} [description]
|
|
39
|
+
* @property {string} [created_on]
|
|
40
|
+
* @property {string} [updated_on]
|
|
41
|
+
* @property {SubscriberEventMapping} [subscriber_event_mapping]
|
|
32
42
|
*/
|
|
33
43
|
/**
|
|
34
|
-
* @typedef
|
|
44
|
+
* @typedef SubscriberConfigResponse
|
|
45
|
+
* @property {ItemSchema[]} [items]
|
|
35
46
|
* @property {Page} [page]
|
|
36
|
-
* @property {EventProcessReportObject[]} [rows]
|
|
37
|
-
*/
|
|
38
|
-
/**
|
|
39
|
-
* @typedef DeliveryEventLevelSchema
|
|
40
|
-
* @property {string} [event]
|
|
41
|
-
* @property {number} [failed]
|
|
42
|
-
* @property {number} [failed_percentage]
|
|
43
|
-
* @property {number} [removed_webhooks]
|
|
44
|
-
* @property {number} [response_time]
|
|
45
|
-
* @property {number} [success]
|
|
46
|
-
* @property {number} [total]
|
|
47
|
-
*/
|
|
48
|
-
/**
|
|
49
|
-
* @typedef DeliverySummaryResponse
|
|
50
|
-
* @property {DeliveryEventLevelSchema[]} [delivery_event_level]
|
|
51
|
-
* @property {DeliverySummarySchema} [delivery_summary]
|
|
52
|
-
*/
|
|
53
|
-
/**
|
|
54
|
-
* @typedef DeliverySummarySchema
|
|
55
|
-
* @property {number} [failed_percentage]
|
|
56
|
-
* @property {number} [removed_webhooks]
|
|
57
|
-
* @property {number} [response_time]
|
|
58
|
-
* @property {number} [success]
|
|
59
47
|
*/
|
|
60
48
|
/**
|
|
61
|
-
* @typedef
|
|
62
|
-
* @property {
|
|
49
|
+
* @typedef InvalidEventsRequest
|
|
50
|
+
* @property {string} [event_name]
|
|
51
|
+
* @property {string} [version]
|
|
52
|
+
* @property {string} [category]
|
|
53
|
+
* @property {string} [start_date]
|
|
54
|
+
* @property {string} [end_date]
|
|
63
55
|
*/
|
|
64
56
|
/**
|
|
65
|
-
* @typedef
|
|
66
|
-
* @property {
|
|
67
|
-
* @property {
|
|
68
|
-
* @property {
|
|
69
|
-
* @property {string} [
|
|
57
|
+
* @typedef InvalidEventsResponse
|
|
58
|
+
* @property {string} [event_name]
|
|
59
|
+
* @property {string} [event_type]
|
|
60
|
+
* @property {string} [version]
|
|
61
|
+
* @property {string} [category]
|
|
62
|
+
* @property {number} [count]
|
|
70
63
|
*/
|
|
71
64
|
/**
|
|
72
65
|
* @typedef DownloadReponse
|
|
73
66
|
* @property {string} [file_name]
|
|
74
67
|
*/
|
|
75
68
|
/**
|
|
76
|
-
* @typedef
|
|
77
|
-
* @property {string} [
|
|
78
|
-
* @property {string} [
|
|
79
|
-
* @property {string} [
|
|
80
|
-
* @property {string} [
|
|
81
|
-
* @property {string} [
|
|
82
|
-
* @property {
|
|
83
|
-
*
|
|
84
|
-
* @property {number} [id]
|
|
85
|
-
* @property {SubscriberEventMapping} [subscriber_event_mapping]
|
|
86
|
-
* @property {string} [updated_on]
|
|
87
|
-
* @property {string} [version]
|
|
69
|
+
* @typedef HistoryFilters
|
|
70
|
+
* @property {string[]} [events]
|
|
71
|
+
* @property {string} [search_text]
|
|
72
|
+
* @property {string} [status] - The status of the history report (e.g., "FAILED").
|
|
73
|
+
* @property {string} [end_date] - The end date and time of the history report.
|
|
74
|
+
* @property {string} [start_date] - The start date and time of the history report.
|
|
75
|
+
* @property {number[]} [subscribers] - An array of subscriber IDs associated
|
|
76
|
+
* with the history report.
|
|
88
77
|
*/
|
|
89
78
|
/**
|
|
90
|
-
* @typedef
|
|
91
|
-
* @property {string} [
|
|
92
|
-
* @property {string} [
|
|
93
|
-
* @property {string} [event_type]
|
|
94
|
-
* @property {string} [version]
|
|
79
|
+
* @typedef Url
|
|
80
|
+
* @property {string} [url] - The URL of the uploaded report file.
|
|
81
|
+
* @property {string} [name] - The name of the uploaded report file.
|
|
95
82
|
*/
|
|
96
83
|
/**
|
|
97
|
-
* @typedef
|
|
98
|
-
* @property {
|
|
99
|
-
* @property {Object} [data] - The data associated with the event.
|
|
100
|
-
* @property {string} [event_name] - The name of the processed event.
|
|
101
|
-
* @property {string} [event_trace_id]
|
|
102
|
-
* @property {number} [last_attempted_on] - The timestamp of the last attempted event.
|
|
103
|
-
* @property {string} [message_id]
|
|
104
|
-
* @property {string} [name] - The name of the event.
|
|
105
|
-
* @property {number} [response_code] - The response code of the event.
|
|
106
|
-
* @property {string} [response_message] - The response message of the event.
|
|
107
|
-
* @property {number} [response_time] - The response time of the event.
|
|
108
|
-
* @property {string} [status] - The status of the event (e.g., "FAILED").
|
|
109
|
-
* @property {string} [webhook_url] - The webhook URL associated with the event.
|
|
84
|
+
* @typedef CdnObject
|
|
85
|
+
* @property {Url[]} [urls]
|
|
110
86
|
*/
|
|
111
87
|
/**
|
|
112
|
-
* @typedef
|
|
113
|
-
* @property {
|
|
114
|
-
* @property {Object[]} [values]
|
|
88
|
+
* @typedef UploadServiceObject
|
|
89
|
+
* @property {CdnObject} [cdn]
|
|
115
90
|
*/
|
|
116
91
|
/**
|
|
117
92
|
* @typedef HistoryAssociation
|
|
118
93
|
* @property {number} [company_id]
|
|
119
94
|
* @property {number[]} [subscriber_ids]
|
|
120
95
|
*/
|
|
121
|
-
/**
|
|
122
|
-
* @typedef HistoryFilters
|
|
123
|
-
* @property {string} [end_date] - The end date and time of the history report.
|
|
124
|
-
* @property {string[]} [events]
|
|
125
|
-
* @property {string} [search_text]
|
|
126
|
-
* @property {string} [start_date] - The start date and time of the history report.
|
|
127
|
-
* @property {string} [status] - The status of the history report (e.g., "FAILED").
|
|
128
|
-
* @property {number[]} [subscribers] - An array of subscriber IDs associated
|
|
129
|
-
* with the history report.
|
|
130
|
-
*/
|
|
131
96
|
/**
|
|
132
97
|
* @typedef HistoryItems
|
|
98
|
+
* @property {number} [id] - The ID of the history report.
|
|
133
99
|
* @property {HistoryAssociation} [association]
|
|
134
|
-
* @property {string} [created_on] - The date and time when the history report
|
|
135
|
-
* was created.
|
|
136
|
-
* @property {string} [filename] - The filename of the history report.
|
|
137
100
|
* @property {HistoryFilters} [filters]
|
|
138
|
-
* @property {
|
|
139
|
-
* @property {string} [message] - A message related to the history report.
|
|
101
|
+
* @property {string} [filename] - The filename of the history report.
|
|
140
102
|
* @property {string} [status] - The status of the history report (e.g., "COMPLETED").
|
|
103
|
+
* @property {UploadServiceObject} [upload_service_response]
|
|
104
|
+
* @property {string} [created_on] - The date and time when the history report
|
|
105
|
+
* was created.
|
|
141
106
|
* @property {string} [updated_on] - The date and time when the history report
|
|
142
107
|
* was last updated.
|
|
143
|
-
* @property {
|
|
108
|
+
* @property {string} [message] - A message related to the history report.
|
|
109
|
+
*/
|
|
110
|
+
/**
|
|
111
|
+
* @typedef HistoryResponse
|
|
112
|
+
* @property {HistoryItems[]} [items]
|
|
113
|
+
* @property {Page} [page]
|
|
144
114
|
*/
|
|
145
115
|
/**
|
|
146
116
|
* @typedef HistoryPayload
|
|
147
117
|
* @property {number} [company_id]
|
|
118
|
+
* @property {string} [type] - The type of history report (e.g., "platform").
|
|
148
119
|
* @property {number} [page_no] - The page number of the history report.
|
|
149
120
|
* @property {number} [page_size] - The number of records per page.
|
|
150
|
-
* @property {string} [type] - The type of history report (e.g., "platform").
|
|
151
121
|
*/
|
|
152
122
|
/**
|
|
153
|
-
* @typedef
|
|
154
|
-
* @property {
|
|
155
|
-
* @property {
|
|
123
|
+
* @typedef CancelDownloadResponse
|
|
124
|
+
* @property {string} [message]
|
|
125
|
+
* @property {string} [result]
|
|
156
126
|
*/
|
|
157
127
|
/**
|
|
158
|
-
* @typedef
|
|
159
|
-
* @property {string} [
|
|
160
|
-
* @property {
|
|
161
|
-
|
|
128
|
+
* @typedef FilterReportResponse
|
|
129
|
+
* @property {string} [filter_name]
|
|
130
|
+
* @property {Object[]} [values]
|
|
131
|
+
*/
|
|
132
|
+
/**
|
|
133
|
+
* @typedef DeliveryTsResponse
|
|
134
|
+
* @property {DeliveryTsSchema[]} [delivery_ts]
|
|
135
|
+
*/
|
|
136
|
+
/**
|
|
137
|
+
* @typedef DeliveryTsSchema
|
|
138
|
+
* @property {string} [timestamp]
|
|
139
|
+
* @property {number} [failed]
|
|
140
|
+
* @property {number} [removed_webhooks]
|
|
141
|
+
* @property {number} [success]
|
|
142
|
+
*/
|
|
143
|
+
/**
|
|
144
|
+
* @typedef DeliveryDetailsRequest
|
|
145
|
+
* @property {string} [company_id]
|
|
146
|
+
* @property {number} [page_no]
|
|
147
|
+
* @property {number} [page_size]
|
|
162
148
|
* @property {string} [start_date]
|
|
163
|
-
* @property {string} [
|
|
149
|
+
* @property {string} [end_date]
|
|
150
|
+
* @property {EventDeliveryDetailSchema[]} [event]
|
|
151
|
+
* @property {string} [status]
|
|
164
152
|
*/
|
|
165
153
|
/**
|
|
166
|
-
* @typedef
|
|
167
|
-
* @property {string} [category]
|
|
168
|
-
* @property {number} [count]
|
|
154
|
+
* @typedef EventDeliveryDetailSchema
|
|
169
155
|
* @property {string} [event_name]
|
|
170
156
|
* @property {string} [event_type]
|
|
157
|
+
* @property {string} [event_category]
|
|
171
158
|
* @property {string} [version]
|
|
172
159
|
*/
|
|
173
160
|
/**
|
|
174
|
-
* @typedef
|
|
175
|
-
* @property {
|
|
176
|
-
* @property {
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
* @
|
|
180
|
-
* @property {
|
|
181
|
-
* @property {number
|
|
182
|
-
* @property {
|
|
183
|
-
* @property {
|
|
184
|
-
* @property {
|
|
185
|
-
* @property {
|
|
186
|
-
* @property {string} [
|
|
187
|
-
* @property {string} [
|
|
188
|
-
* @property {string} [webhook_url]
|
|
161
|
+
* @typedef DeliveryDetailsResponse
|
|
162
|
+
* @property {EventProcessReportObject[]} [rows]
|
|
163
|
+
* @property {Page} [page]
|
|
164
|
+
*/
|
|
165
|
+
/**
|
|
166
|
+
* @typedef EventProcessReportObject
|
|
167
|
+
* @property {string} [event_name] - The name of the processed event.
|
|
168
|
+
* @property {number} [response_code] - The response code of the event.
|
|
169
|
+
* @property {string} [response_message] - The response message of the event.
|
|
170
|
+
* @property {Object} [data] - The data associated with the event.
|
|
171
|
+
* @property {number} [attempt] - The attempt number of the event.
|
|
172
|
+
* @property {number} [last_attempted_on] - The timestamp of the last attempted event.
|
|
173
|
+
* @property {string} [status] - The status of the event (e.g., "FAILED").
|
|
174
|
+
* @property {string} [name] - The name of the event.
|
|
175
|
+
* @property {string} [webhook_url] - The webhook URL associated with the event.
|
|
176
|
+
* @property {number} [response_time] - The response time of the event.
|
|
177
|
+
* @property {string} [message_id]
|
|
178
|
+
* @property {string} [event_trace_id]
|
|
189
179
|
*/
|
|
190
180
|
/**
|
|
191
181
|
* @typedef Page
|
|
192
|
-
* @property {number} [current]
|
|
193
|
-
* @property {boolean} [has_next]
|
|
194
|
-
* @property {boolean} [has_previous]
|
|
195
182
|
* @property {number} [item_total]
|
|
196
183
|
* @property {string} [next_id]
|
|
197
|
-
* @property {
|
|
184
|
+
* @property {boolean} [has_previous]
|
|
185
|
+
* @property {boolean} [has_next]
|
|
186
|
+
* @property {number} [current]
|
|
198
187
|
* @property {string} type
|
|
188
|
+
* @property {number} [size]
|
|
199
189
|
*/
|
|
200
190
|
/**
|
|
201
|
-
* @typedef
|
|
202
|
-
* @property {
|
|
203
|
-
* @property {
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
* @
|
|
207
|
-
* @property {
|
|
208
|
-
* @property {number} [
|
|
209
|
-
* @property {number} [id]
|
|
210
|
-
* @property {number} [subscriber_id]
|
|
211
|
-
*/
|
|
212
|
-
/**
|
|
213
|
-
* @typedef UpdateSubscriberRequest
|
|
214
|
-
* @property {string} [status]
|
|
191
|
+
* @typedef DeliveryEventLevelSchema
|
|
192
|
+
* @property {string} [event]
|
|
193
|
+
* @property {number} [success]
|
|
194
|
+
* @property {number} [failed]
|
|
195
|
+
* @property {number} [failed_percentage]
|
|
196
|
+
* @property {number} [removed_webhooks]
|
|
197
|
+
* @property {number} [total]
|
|
198
|
+
* @property {number} [response_time]
|
|
215
199
|
*/
|
|
216
200
|
/**
|
|
217
|
-
* @typedef
|
|
218
|
-
* @property {
|
|
201
|
+
* @typedef DeliverySummaryResponse
|
|
202
|
+
* @property {DeliveryEventLevelSchema[]} [delivery_event_level]
|
|
203
|
+
* @property {DeliverySummarySchema} [delivery_summary]
|
|
219
204
|
*/
|
|
220
205
|
/**
|
|
221
|
-
* @typedef
|
|
222
|
-
* @property {
|
|
206
|
+
* @typedef DeliverySummarySchema
|
|
207
|
+
* @property {number} [success]
|
|
208
|
+
* @property {number} [response_time]
|
|
209
|
+
* @property {number} [failed_percentage]
|
|
210
|
+
* @property {number} [removed_webhooks]
|
|
223
211
|
*/
|
|
224
212
|
/**
|
|
225
|
-
* @typedef
|
|
226
|
-
* @property {
|
|
227
|
-
* @property {string} [
|
|
213
|
+
* @typedef ItemSchema
|
|
214
|
+
* @property {number} [id]
|
|
215
|
+
* @property {string} [modified_by]
|
|
216
|
+
* @property {string} [name]
|
|
217
|
+
* @property {string} [webhook_url]
|
|
218
|
+
* @property {Association} [association]
|
|
219
|
+
* @property {Object} [custom_headers]
|
|
220
|
+
* @property {string} [status]
|
|
221
|
+
* @property {string} [email_id]
|
|
222
|
+
* @property {string} [updated_on]
|
|
223
|
+
* @property {string} [created_on]
|
|
224
|
+
* @property {string} [type]
|
|
225
|
+
* @property {AuthMeta} [auth_meta]
|
|
226
|
+
* @property {EventConfigResponse[]} [event_configs]
|
|
227
|
+
* @property {number[]} [event_id]
|
|
228
228
|
*/
|
|
229
229
|
declare class WebhookPartnerModel {
|
|
230
230
|
}
|
|
231
231
|
declare namespace WebhookPartnerModel {
|
|
232
|
-
export {
|
|
232
|
+
export { UpdateSubscriberResponse, UpdateSubscriberRequest, Association, AuthMeta, SubscriberEventMapping, EventConfigResponse, SubscriberConfigResponse, InvalidEventsRequest, InvalidEventsResponse, DownloadReponse, HistoryFilters, Url, CdnObject, UploadServiceObject, HistoryAssociation, HistoryItems, HistoryResponse, HistoryPayload, CancelDownloadResponse, FilterReportResponse, DeliveryTsResponse, DeliveryTsSchema, DeliveryDetailsRequest, EventDeliveryDetailSchema, DeliveryDetailsResponse, EventProcessReportObject, Page, DeliveryEventLevelSchema, DeliverySummaryResponse, DeliverySummarySchema, ItemSchema };
|
|
233
233
|
}
|
|
234
|
+
/** @returns {UpdateSubscriberResponse} */
|
|
235
|
+
declare function UpdateSubscriberResponse(): UpdateSubscriberResponse;
|
|
236
|
+
type UpdateSubscriberResponse = {
|
|
237
|
+
message?: string;
|
|
238
|
+
};
|
|
239
|
+
/** @returns {UpdateSubscriberRequest} */
|
|
240
|
+
declare function UpdateSubscriberRequest(): UpdateSubscriberRequest;
|
|
241
|
+
type UpdateSubscriberRequest = {
|
|
242
|
+
status?: string;
|
|
243
|
+
};
|
|
234
244
|
/** @returns {Association} */
|
|
235
245
|
declare function Association(): Association;
|
|
236
246
|
type Association = {
|
|
237
|
-
application_id?: string[];
|
|
238
247
|
company_id?: number;
|
|
239
|
-
|
|
248
|
+
application_id?: string[];
|
|
240
249
|
extension_id?: string;
|
|
250
|
+
criteria?: string;
|
|
241
251
|
};
|
|
242
252
|
/** @returns {AuthMeta} */
|
|
243
253
|
declare function AuthMeta(): AuthMeta;
|
|
244
254
|
type AuthMeta = {
|
|
245
|
-
secret?: string;
|
|
246
255
|
type?: string;
|
|
256
|
+
secret?: string;
|
|
247
257
|
};
|
|
248
|
-
/** @returns {
|
|
249
|
-
declare function
|
|
250
|
-
type
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
declare function CdnObject(): CdnObject;
|
|
256
|
-
type CdnObject = {
|
|
257
|
-
urls?: Url[];
|
|
258
|
-
};
|
|
259
|
-
/** @returns {DeliveryDetailsRequest} */
|
|
260
|
-
declare function DeliveryDetailsRequest(): DeliveryDetailsRequest;
|
|
261
|
-
type DeliveryDetailsRequest = {
|
|
262
|
-
company_id?: string;
|
|
263
|
-
end_date?: string;
|
|
264
|
-
event?: EventDeliveryDetailSchema[];
|
|
265
|
-
page_no?: number;
|
|
266
|
-
page_size?: number;
|
|
267
|
-
start_date?: string;
|
|
268
|
-
status?: string;
|
|
269
|
-
};
|
|
270
|
-
/** @returns {DeliveryDetailsResponse} */
|
|
271
|
-
declare function DeliveryDetailsResponse(): DeliveryDetailsResponse;
|
|
272
|
-
type DeliveryDetailsResponse = {
|
|
273
|
-
page?: Page;
|
|
274
|
-
rows?: EventProcessReportObject[];
|
|
275
|
-
};
|
|
276
|
-
/** @returns {DeliveryEventLevelSchema} */
|
|
277
|
-
declare function DeliveryEventLevelSchema(): DeliveryEventLevelSchema;
|
|
278
|
-
type DeliveryEventLevelSchema = {
|
|
279
|
-
event?: string;
|
|
280
|
-
failed?: number;
|
|
281
|
-
failed_percentage?: number;
|
|
282
|
-
removed_webhooks?: number;
|
|
283
|
-
response_time?: number;
|
|
284
|
-
success?: number;
|
|
285
|
-
total?: number;
|
|
286
|
-
};
|
|
287
|
-
/** @returns {DeliverySummaryResponse} */
|
|
288
|
-
declare function DeliverySummaryResponse(): DeliverySummaryResponse;
|
|
289
|
-
type DeliverySummaryResponse = {
|
|
290
|
-
delivery_event_level?: DeliveryEventLevelSchema[];
|
|
291
|
-
delivery_summary?: DeliverySummarySchema;
|
|
292
|
-
};
|
|
293
|
-
/** @returns {DeliverySummarySchema} */
|
|
294
|
-
declare function DeliverySummarySchema(): DeliverySummarySchema;
|
|
295
|
-
type DeliverySummarySchema = {
|
|
296
|
-
failed_percentage?: number;
|
|
297
|
-
removed_webhooks?: number;
|
|
298
|
-
response_time?: number;
|
|
299
|
-
success?: number;
|
|
300
|
-
};
|
|
301
|
-
/** @returns {DeliveryTsResponse} */
|
|
302
|
-
declare function DeliveryTsResponse(): DeliveryTsResponse;
|
|
303
|
-
type DeliveryTsResponse = {
|
|
304
|
-
delivery_ts?: DeliveryTsSchema[];
|
|
305
|
-
};
|
|
306
|
-
/** @returns {DeliveryTsSchema} */
|
|
307
|
-
declare function DeliveryTsSchema(): DeliveryTsSchema;
|
|
308
|
-
type DeliveryTsSchema = {
|
|
309
|
-
failed?: number;
|
|
310
|
-
removed_webhooks?: number;
|
|
311
|
-
success?: number;
|
|
312
|
-
timestamp?: string;
|
|
313
|
-
};
|
|
314
|
-
/** @returns {DownloadReponse} */
|
|
315
|
-
declare function DownloadReponse(): DownloadReponse;
|
|
316
|
-
type DownloadReponse = {
|
|
317
|
-
file_name?: string;
|
|
258
|
+
/** @returns {SubscriberEventMapping} */
|
|
259
|
+
declare function SubscriberEventMapping(): SubscriberEventMapping;
|
|
260
|
+
type SubscriberEventMapping = {
|
|
261
|
+
id?: number;
|
|
262
|
+
event_id?: number;
|
|
263
|
+
subscriber_id?: number;
|
|
264
|
+
created_on?: string;
|
|
318
265
|
};
|
|
319
266
|
/** @returns {EventConfigResponse} */
|
|
320
267
|
declare function EventConfigResponse(): EventConfigResponse;
|
|
321
268
|
type EventConfigResponse = {
|
|
322
|
-
|
|
323
|
-
description?: string;
|
|
324
|
-
display_name?: string;
|
|
325
|
-
event_category?: string;
|
|
269
|
+
id?: number;
|
|
326
270
|
event_name?: string;
|
|
327
|
-
event_schema?: any;
|
|
328
271
|
event_type?: string;
|
|
329
|
-
|
|
330
|
-
|
|
272
|
+
event_category?: string;
|
|
273
|
+
event_schema?: any;
|
|
274
|
+
version?: string;
|
|
275
|
+
display_name?: string;
|
|
276
|
+
description?: string;
|
|
277
|
+
created_on?: string;
|
|
331
278
|
updated_on?: string;
|
|
279
|
+
subscriber_event_mapping?: SubscriberEventMapping;
|
|
280
|
+
};
|
|
281
|
+
/** @returns {SubscriberConfigResponse} */
|
|
282
|
+
declare function SubscriberConfigResponse(): SubscriberConfigResponse;
|
|
283
|
+
type SubscriberConfigResponse = {
|
|
284
|
+
items?: ItemSchema[];
|
|
285
|
+
page?: Page;
|
|
286
|
+
};
|
|
287
|
+
/** @returns {InvalidEventsRequest} */
|
|
288
|
+
declare function InvalidEventsRequest(): InvalidEventsRequest;
|
|
289
|
+
type InvalidEventsRequest = {
|
|
290
|
+
event_name?: string;
|
|
332
291
|
version?: string;
|
|
292
|
+
category?: string;
|
|
293
|
+
start_date?: string;
|
|
294
|
+
end_date?: string;
|
|
333
295
|
};
|
|
334
|
-
/** @returns {
|
|
335
|
-
declare function
|
|
336
|
-
type
|
|
337
|
-
event_category?: string;
|
|
296
|
+
/** @returns {InvalidEventsResponse} */
|
|
297
|
+
declare function InvalidEventsResponse(): InvalidEventsResponse;
|
|
298
|
+
type InvalidEventsResponse = {
|
|
338
299
|
event_name?: string;
|
|
339
300
|
event_type?: string;
|
|
340
301
|
version?: string;
|
|
302
|
+
category?: string;
|
|
303
|
+
count?: number;
|
|
341
304
|
};
|
|
342
|
-
/** @returns {
|
|
343
|
-
declare function
|
|
344
|
-
type
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
data?: any;
|
|
353
|
-
/**
|
|
354
|
-
* - The name of the processed event.
|
|
355
|
-
*/
|
|
356
|
-
event_name?: string;
|
|
357
|
-
event_trace_id?: string;
|
|
358
|
-
/**
|
|
359
|
-
* - The timestamp of the last attempted event.
|
|
360
|
-
*/
|
|
361
|
-
last_attempted_on?: number;
|
|
362
|
-
message_id?: string;
|
|
305
|
+
/** @returns {DownloadReponse} */
|
|
306
|
+
declare function DownloadReponse(): DownloadReponse;
|
|
307
|
+
type DownloadReponse = {
|
|
308
|
+
file_name?: string;
|
|
309
|
+
};
|
|
310
|
+
/** @returns {HistoryFilters} */
|
|
311
|
+
declare function HistoryFilters(): HistoryFilters;
|
|
312
|
+
type HistoryFilters = {
|
|
313
|
+
events?: string[];
|
|
314
|
+
search_text?: string;
|
|
363
315
|
/**
|
|
364
|
-
* - The
|
|
316
|
+
* - The status of the history report (e.g., "FAILED").
|
|
365
317
|
*/
|
|
366
|
-
|
|
318
|
+
status?: string;
|
|
367
319
|
/**
|
|
368
|
-
* - The
|
|
320
|
+
* - The end date and time of the history report.
|
|
369
321
|
*/
|
|
370
|
-
|
|
322
|
+
end_date?: string;
|
|
371
323
|
/**
|
|
372
|
-
* - The
|
|
324
|
+
* - The start date and time of the history report.
|
|
373
325
|
*/
|
|
374
|
-
|
|
326
|
+
start_date?: string;
|
|
375
327
|
/**
|
|
376
|
-
* -
|
|
328
|
+
* - An array of subscriber IDs associated
|
|
329
|
+
* with the history report.
|
|
377
330
|
*/
|
|
378
|
-
|
|
331
|
+
subscribers?: number[];
|
|
332
|
+
};
|
|
333
|
+
/** @returns {Url} */
|
|
334
|
+
declare function Url(): Url;
|
|
335
|
+
type Url = {
|
|
379
336
|
/**
|
|
380
|
-
* - The
|
|
337
|
+
* - The URL of the uploaded report file.
|
|
381
338
|
*/
|
|
382
|
-
|
|
339
|
+
url?: string;
|
|
383
340
|
/**
|
|
384
|
-
* - The
|
|
341
|
+
* - The name of the uploaded report file.
|
|
385
342
|
*/
|
|
386
|
-
|
|
343
|
+
name?: string;
|
|
387
344
|
};
|
|
388
|
-
/** @returns {
|
|
389
|
-
declare function
|
|
390
|
-
type
|
|
391
|
-
|
|
392
|
-
|
|
345
|
+
/** @returns {CdnObject} */
|
|
346
|
+
declare function CdnObject(): CdnObject;
|
|
347
|
+
type CdnObject = {
|
|
348
|
+
urls?: Url[];
|
|
349
|
+
};
|
|
350
|
+
/** @returns {UploadServiceObject} */
|
|
351
|
+
declare function UploadServiceObject(): UploadServiceObject;
|
|
352
|
+
type UploadServiceObject = {
|
|
353
|
+
cdn?: CdnObject;
|
|
393
354
|
};
|
|
394
355
|
/** @returns {HistoryAssociation} */
|
|
395
356
|
declare function HistoryAssociation(): HistoryAssociation;
|
|
@@ -397,66 +358,53 @@ type HistoryAssociation = {
|
|
|
397
358
|
company_id?: number;
|
|
398
359
|
subscriber_ids?: number[];
|
|
399
360
|
};
|
|
400
|
-
/** @returns {
|
|
401
|
-
declare function
|
|
402
|
-
type
|
|
361
|
+
/** @returns {HistoryItems} */
|
|
362
|
+
declare function HistoryItems(): HistoryItems;
|
|
363
|
+
type HistoryItems = {
|
|
403
364
|
/**
|
|
404
|
-
* - The
|
|
365
|
+
* - The ID of the history report.
|
|
405
366
|
*/
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
367
|
+
id?: number;
|
|
368
|
+
association?: HistoryAssociation;
|
|
369
|
+
filters?: HistoryFilters;
|
|
409
370
|
/**
|
|
410
|
-
* - The
|
|
371
|
+
* - The filename of the history report.
|
|
411
372
|
*/
|
|
412
|
-
|
|
373
|
+
filename?: string;
|
|
413
374
|
/**
|
|
414
|
-
* - The status of the history report (e.g., "
|
|
375
|
+
* - The status of the history report (e.g., "COMPLETED").
|
|
415
376
|
*/
|
|
416
377
|
status?: string;
|
|
417
|
-
|
|
418
|
-
* - An array of subscriber IDs associated
|
|
419
|
-
* with the history report.
|
|
420
|
-
*/
|
|
421
|
-
subscribers?: number[];
|
|
422
|
-
};
|
|
423
|
-
/** @returns {HistoryItems} */
|
|
424
|
-
declare function HistoryItems(): HistoryItems;
|
|
425
|
-
type HistoryItems = {
|
|
426
|
-
association?: HistoryAssociation;
|
|
378
|
+
upload_service_response?: UploadServiceObject;
|
|
427
379
|
/**
|
|
428
380
|
* - The date and time when the history report
|
|
429
381
|
* was created.
|
|
430
382
|
*/
|
|
431
383
|
created_on?: string;
|
|
432
384
|
/**
|
|
433
|
-
* - The
|
|
434
|
-
|
|
435
|
-
filename?: string;
|
|
436
|
-
filters?: HistoryFilters;
|
|
437
|
-
/**
|
|
438
|
-
* - The ID of the history report.
|
|
385
|
+
* - The date and time when the history report
|
|
386
|
+
* was last updated.
|
|
439
387
|
*/
|
|
440
|
-
|
|
388
|
+
updated_on?: string;
|
|
441
389
|
/**
|
|
442
390
|
* - A message related to the history report.
|
|
443
391
|
*/
|
|
444
392
|
message?: string;
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
|
|
451
|
-
* was last updated.
|
|
452
|
-
*/
|
|
453
|
-
updated_on?: string;
|
|
454
|
-
upload_service_response?: UploadServiceObject;
|
|
393
|
+
};
|
|
394
|
+
/** @returns {HistoryResponse} */
|
|
395
|
+
declare function HistoryResponse(): HistoryResponse;
|
|
396
|
+
type HistoryResponse = {
|
|
397
|
+
items?: HistoryItems[];
|
|
398
|
+
page?: Page;
|
|
455
399
|
};
|
|
456
400
|
/** @returns {HistoryPayload} */
|
|
457
401
|
declare function HistoryPayload(): HistoryPayload;
|
|
458
402
|
type HistoryPayload = {
|
|
459
403
|
company_id?: number;
|
|
404
|
+
/**
|
|
405
|
+
* - The type of history report (e.g., "platform").
|
|
406
|
+
*/
|
|
407
|
+
type?: string;
|
|
460
408
|
/**
|
|
461
409
|
* - The page number of the history report.
|
|
462
410
|
*/
|
|
@@ -465,102 +413,154 @@ type HistoryPayload = {
|
|
|
465
413
|
* - The number of records per page.
|
|
466
414
|
*/
|
|
467
415
|
page_size?: number;
|
|
468
|
-
/**
|
|
469
|
-
* - The type of history report (e.g., "platform").
|
|
470
|
-
*/
|
|
471
|
-
type?: string;
|
|
472
416
|
};
|
|
473
|
-
/** @returns {
|
|
474
|
-
declare function
|
|
475
|
-
type
|
|
476
|
-
|
|
477
|
-
|
|
417
|
+
/** @returns {CancelDownloadResponse} */
|
|
418
|
+
declare function CancelDownloadResponse(): CancelDownloadResponse;
|
|
419
|
+
type CancelDownloadResponse = {
|
|
420
|
+
message?: string;
|
|
421
|
+
result?: string;
|
|
478
422
|
};
|
|
479
|
-
/** @returns {
|
|
480
|
-
declare function
|
|
481
|
-
type
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
423
|
+
/** @returns {FilterReportResponse} */
|
|
424
|
+
declare function FilterReportResponse(): FilterReportResponse;
|
|
425
|
+
type FilterReportResponse = {
|
|
426
|
+
filter_name?: string;
|
|
427
|
+
values?: any[];
|
|
428
|
+
};
|
|
429
|
+
/** @returns {DeliveryTsResponse} */
|
|
430
|
+
declare function DeliveryTsResponse(): DeliveryTsResponse;
|
|
431
|
+
type DeliveryTsResponse = {
|
|
432
|
+
delivery_ts?: DeliveryTsSchema[];
|
|
433
|
+
};
|
|
434
|
+
/** @returns {DeliveryTsSchema} */
|
|
435
|
+
declare function DeliveryTsSchema(): DeliveryTsSchema;
|
|
436
|
+
type DeliveryTsSchema = {
|
|
437
|
+
timestamp?: string;
|
|
438
|
+
failed?: number;
|
|
439
|
+
removed_webhooks?: number;
|
|
440
|
+
success?: number;
|
|
441
|
+
};
|
|
442
|
+
/** @returns {DeliveryDetailsRequest} */
|
|
443
|
+
declare function DeliveryDetailsRequest(): DeliveryDetailsRequest;
|
|
444
|
+
type DeliveryDetailsRequest = {
|
|
445
|
+
company_id?: string;
|
|
446
|
+
page_no?: number;
|
|
447
|
+
page_size?: number;
|
|
485
448
|
start_date?: string;
|
|
486
|
-
|
|
449
|
+
end_date?: string;
|
|
450
|
+
event?: EventDeliveryDetailSchema[];
|
|
451
|
+
status?: string;
|
|
487
452
|
};
|
|
488
|
-
/** @returns {
|
|
489
|
-
declare function
|
|
490
|
-
type
|
|
491
|
-
category?: string;
|
|
492
|
-
count?: number;
|
|
453
|
+
/** @returns {EventDeliveryDetailSchema} */
|
|
454
|
+
declare function EventDeliveryDetailSchema(): EventDeliveryDetailSchema;
|
|
455
|
+
type EventDeliveryDetailSchema = {
|
|
493
456
|
event_name?: string;
|
|
494
457
|
event_type?: string;
|
|
458
|
+
event_category?: string;
|
|
495
459
|
version?: string;
|
|
496
460
|
};
|
|
497
|
-
/** @returns {
|
|
498
|
-
declare function
|
|
499
|
-
type
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
|
|
509
|
-
|
|
461
|
+
/** @returns {DeliveryDetailsResponse} */
|
|
462
|
+
declare function DeliveryDetailsResponse(): DeliveryDetailsResponse;
|
|
463
|
+
type DeliveryDetailsResponse = {
|
|
464
|
+
rows?: EventProcessReportObject[];
|
|
465
|
+
page?: Page;
|
|
466
|
+
};
|
|
467
|
+
/** @returns {EventProcessReportObject} */
|
|
468
|
+
declare function EventProcessReportObject(): EventProcessReportObject;
|
|
469
|
+
type EventProcessReportObject = {
|
|
470
|
+
/**
|
|
471
|
+
* - The name of the processed event.
|
|
472
|
+
*/
|
|
473
|
+
event_name?: string;
|
|
474
|
+
/**
|
|
475
|
+
* - The response code of the event.
|
|
476
|
+
*/
|
|
477
|
+
response_code?: number;
|
|
478
|
+
/**
|
|
479
|
+
* - The response message of the event.
|
|
480
|
+
*/
|
|
481
|
+
response_message?: string;
|
|
482
|
+
/**
|
|
483
|
+
* - The data associated with the event.
|
|
484
|
+
*/
|
|
485
|
+
data?: any;
|
|
486
|
+
/**
|
|
487
|
+
* - The attempt number of the event.
|
|
488
|
+
*/
|
|
489
|
+
attempt?: number;
|
|
490
|
+
/**
|
|
491
|
+
* - The timestamp of the last attempted event.
|
|
492
|
+
*/
|
|
493
|
+
last_attempted_on?: number;
|
|
494
|
+
/**
|
|
495
|
+
* - The status of the event (e.g., "FAILED").
|
|
496
|
+
*/
|
|
510
497
|
status?: string;
|
|
511
|
-
|
|
512
|
-
|
|
498
|
+
/**
|
|
499
|
+
* - The name of the event.
|
|
500
|
+
*/
|
|
501
|
+
name?: string;
|
|
502
|
+
/**
|
|
503
|
+
* - The webhook URL associated with the event.
|
|
504
|
+
*/
|
|
513
505
|
webhook_url?: string;
|
|
506
|
+
/**
|
|
507
|
+
* - The response time of the event.
|
|
508
|
+
*/
|
|
509
|
+
response_time?: number;
|
|
510
|
+
message_id?: string;
|
|
511
|
+
event_trace_id?: string;
|
|
514
512
|
};
|
|
515
513
|
/** @returns {Page} */
|
|
516
514
|
declare function Page(): Page;
|
|
517
515
|
type Page = {
|
|
518
|
-
current?: number;
|
|
519
|
-
has_next?: boolean;
|
|
520
|
-
has_previous?: boolean;
|
|
521
516
|
item_total?: number;
|
|
522
517
|
next_id?: string;
|
|
523
|
-
|
|
518
|
+
has_previous?: boolean;
|
|
519
|
+
has_next?: boolean;
|
|
520
|
+
current?: number;
|
|
524
521
|
type: string;
|
|
522
|
+
size?: number;
|
|
525
523
|
};
|
|
526
|
-
/** @returns {
|
|
527
|
-
declare function
|
|
528
|
-
type
|
|
529
|
-
|
|
530
|
-
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
event_id?: number;
|
|
537
|
-
id?: number;
|
|
538
|
-
subscriber_id?: number;
|
|
539
|
-
};
|
|
540
|
-
/** @returns {UpdateSubscriberRequest} */
|
|
541
|
-
declare function UpdateSubscriberRequest(): UpdateSubscriberRequest;
|
|
542
|
-
type UpdateSubscriberRequest = {
|
|
543
|
-
status?: string;
|
|
524
|
+
/** @returns {DeliveryEventLevelSchema} */
|
|
525
|
+
declare function DeliveryEventLevelSchema(): DeliveryEventLevelSchema;
|
|
526
|
+
type DeliveryEventLevelSchema = {
|
|
527
|
+
event?: string;
|
|
528
|
+
success?: number;
|
|
529
|
+
failed?: number;
|
|
530
|
+
failed_percentage?: number;
|
|
531
|
+
removed_webhooks?: number;
|
|
532
|
+
total?: number;
|
|
533
|
+
response_time?: number;
|
|
544
534
|
};
|
|
545
|
-
/** @returns {
|
|
546
|
-
declare function
|
|
547
|
-
type
|
|
548
|
-
|
|
535
|
+
/** @returns {DeliverySummaryResponse} */
|
|
536
|
+
declare function DeliverySummaryResponse(): DeliverySummaryResponse;
|
|
537
|
+
type DeliverySummaryResponse = {
|
|
538
|
+
delivery_event_level?: DeliveryEventLevelSchema[];
|
|
539
|
+
delivery_summary?: DeliverySummarySchema;
|
|
549
540
|
};
|
|
550
|
-
/** @returns {
|
|
551
|
-
declare function
|
|
552
|
-
type
|
|
553
|
-
|
|
541
|
+
/** @returns {DeliverySummarySchema} */
|
|
542
|
+
declare function DeliverySummarySchema(): DeliverySummarySchema;
|
|
543
|
+
type DeliverySummarySchema = {
|
|
544
|
+
success?: number;
|
|
545
|
+
response_time?: number;
|
|
546
|
+
failed_percentage?: number;
|
|
547
|
+
removed_webhooks?: number;
|
|
554
548
|
};
|
|
555
|
-
/** @returns {
|
|
556
|
-
declare function
|
|
557
|
-
type
|
|
558
|
-
|
|
559
|
-
|
|
560
|
-
*/
|
|
549
|
+
/** @returns {ItemSchema} */
|
|
550
|
+
declare function ItemSchema(): ItemSchema;
|
|
551
|
+
type ItemSchema = {
|
|
552
|
+
id?: number;
|
|
553
|
+
modified_by?: string;
|
|
561
554
|
name?: string;
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
|
|
555
|
+
webhook_url?: string;
|
|
556
|
+
association?: Association;
|
|
557
|
+
custom_headers?: any;
|
|
558
|
+
status?: string;
|
|
559
|
+
email_id?: string;
|
|
560
|
+
updated_on?: string;
|
|
561
|
+
created_on?: string;
|
|
562
|
+
type?: string;
|
|
563
|
+
auth_meta?: AuthMeta;
|
|
564
|
+
event_configs?: EventConfigResponse[];
|
|
565
|
+
event_id?: number[];
|
|
566
566
|
};
|