@gofynd/fdk-client-javascript 1.4.2-beta.2 → 1.4.2-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/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 +852 -846
- package/sdk/application/Order/OrderApplicationModel.js +828 -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 +2176 -2145
- package/sdk/application/Payment/PaymentApplicationModel.js +1474 -1453
- 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/UserApplicationClient.d.ts +2 -2
- package/sdk/application/User/UserApplicationClient.js +4 -7
- package/sdk/application/User/UserApplicationModel.d.ts +769 -764
- package/sdk/application/User/UserApplicationModel.js +731 -741
- 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/CatalogPlatformApplicationClient.d.ts +26 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +182 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +70 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +44 -0
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1013 -980
- package/sdk/platform/Catalog/CatalogPlatformModel.js +977 -933
- 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 +1842 -1825
- package/sdk/platform/Content/ContentPlatformModel.js +1868 -1848
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +245 -245
- package/sdk/platform/Discount/DiscountPlatformModel.js +248 -248
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +4 -1
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +2 -0
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +2 -0
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +7 -4
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +882 -869
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +894 -878
- 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 +5192 -5176
- package/sdk/platform/Order/OrderPlatformModel.js +4752 -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 +2693 -2657
- package/sdk/platform/Payment/PaymentPlatformModel.js +1842 -1819
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +204 -204
- package/sdk/platform/Rewards/RewardsPlatformModel.js +199 -199
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +7 -6
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +11 -10
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1674 -1539
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1663 -1534
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +4 -4
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +4 -4
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Share/SharePlatformApplicationClient.js +19 -6
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +13 -3
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +6 -2
- 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 +823 -753
- package/sdk/platform/User/UserPlatformModel.js +731 -661
- 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,163 +1,128 @@
|
|
|
1
1
|
export = WebhookPlatformModel;
|
|
2
|
-
/**
|
|
3
|
-
* @typedef Association
|
|
4
|
-
* @property {string[]} [application_id]
|
|
5
|
-
* @property {number} [company_id]
|
|
6
|
-
* @property {string} [criteria]
|
|
7
|
-
* @property {string} [extension_id]
|
|
8
|
-
*/
|
|
9
|
-
/**
|
|
10
|
-
* @typedef AuthMeta
|
|
11
|
-
* @property {string} [secret]
|
|
12
|
-
* @property {string} [type]
|
|
13
|
-
*/
|
|
14
|
-
/**
|
|
15
|
-
* @typedef CancelResponse
|
|
16
|
-
* @property {string} [message] - The HTTP status code of the response (e.g., 200).
|
|
17
|
-
*/
|
|
18
|
-
/**
|
|
19
|
-
* @typedef CdnObject
|
|
20
|
-
* @property {Url[]} [urls]
|
|
21
|
-
*/
|
|
22
|
-
/**
|
|
23
|
-
* @typedef DownloadReportResponse
|
|
24
|
-
* @property {string} [file_name]
|
|
25
|
-
*/
|
|
26
|
-
/**
|
|
27
|
-
* @typedef Err
|
|
28
|
-
* @property {string} [location]
|
|
29
|
-
* @property {string} [msg]
|
|
30
|
-
* @property {string} [param]
|
|
31
|
-
*/
|
|
32
2
|
/**
|
|
33
3
|
* @typedef Error
|
|
34
4
|
* @property {string} [error] - Error message describing the reason for the failure.
|
|
35
5
|
*/
|
|
36
6
|
/**
|
|
37
7
|
* @typedef Event
|
|
38
|
-
* @property {string} [event_category]
|
|
39
8
|
* @property {string} [event_name]
|
|
40
9
|
* @property {string} [event_type]
|
|
10
|
+
* @property {string} [event_category]
|
|
41
11
|
* @property {string} [version]
|
|
42
12
|
*/
|
|
43
13
|
/**
|
|
44
|
-
* @typedef
|
|
45
|
-
* @property {string} [
|
|
46
|
-
* @property {string} [
|
|
47
|
-
* @property {string} [
|
|
48
|
-
* @property {
|
|
49
|
-
* @property {
|
|
50
|
-
* @property {
|
|
51
|
-
* @property {string} [event_type]
|
|
52
|
-
* @property {number} [id]
|
|
53
|
-
* @property {string} [updated_on]
|
|
54
|
-
* @property {string} [version]
|
|
14
|
+
* @typedef RetryEventRequest
|
|
15
|
+
* @property {string} [search_text]
|
|
16
|
+
* @property {string} [end_date]
|
|
17
|
+
* @property {string} [start_date]
|
|
18
|
+
* @property {number[]} [subscriber_ids]
|
|
19
|
+
* @property {Event[]} [event]
|
|
20
|
+
* @property {string} [status]
|
|
55
21
|
*/
|
|
56
22
|
/**
|
|
57
|
-
* @typedef
|
|
58
|
-
* @property {
|
|
23
|
+
* @typedef Item
|
|
24
|
+
* @property {string} [status]
|
|
25
|
+
* @property {number} [count]
|
|
59
26
|
*/
|
|
60
27
|
/**
|
|
61
|
-
* @typedef
|
|
62
|
-
* @property {
|
|
63
|
-
* @property {Object} [data] - The data associated with the event.
|
|
64
|
-
* @property {string} [event_name] - The name of the processed event.
|
|
65
|
-
* @property {string} [event_trace_id]
|
|
66
|
-
* @property {number} [last_attempted_on] - The timestamp of the last attempted event.
|
|
67
|
-
* @property {string} [message_id]
|
|
68
|
-
* @property {string} [name] - The name of the event.
|
|
69
|
-
* @property {number} [response_code] - The response code of the event.
|
|
70
|
-
* @property {string} [response_message] - The response message of the event.
|
|
71
|
-
* @property {number} [response_time] - The response time of the event.
|
|
72
|
-
* @property {string} [status] - The status of the event (e.g., "FAILED").
|
|
73
|
-
* @property {string} [webhook_url] - The webhook URL associated with the event.
|
|
28
|
+
* @typedef RetryCountResponse
|
|
29
|
+
* @property {Item[]} [items]
|
|
74
30
|
*/
|
|
75
31
|
/**
|
|
76
|
-
* @typedef
|
|
77
|
-
* @property {
|
|
78
|
-
* @property {
|
|
32
|
+
* @typedef RetrySuccessResponse
|
|
33
|
+
* @property {boolean} [success]
|
|
34
|
+
* @property {string} [message]
|
|
79
35
|
*/
|
|
80
36
|
/**
|
|
81
|
-
* @typedef
|
|
82
|
-
* @property {string} [
|
|
83
|
-
* @property {
|
|
84
|
-
* @property {string} [
|
|
85
|
-
* @property {string} [start_date]
|
|
86
|
-
* @property {string} [status]
|
|
87
|
-
* @property {number[]} [subscriber_ids]
|
|
37
|
+
* @typedef Err
|
|
38
|
+
* @property {string} [msg]
|
|
39
|
+
* @property {string} [param]
|
|
40
|
+
* @property {string} [location]
|
|
88
41
|
*/
|
|
89
42
|
/**
|
|
90
|
-
* @typedef
|
|
91
|
-
* @property {
|
|
92
|
-
* @property {number[]} [subscriber_ids]
|
|
43
|
+
* @typedef RetryFailureResponse
|
|
44
|
+
* @property {Err[]} [err]
|
|
93
45
|
*/
|
|
94
46
|
/**
|
|
95
|
-
* @typedef
|
|
96
|
-
* @property {
|
|
97
|
-
* @property {
|
|
98
|
-
* @property {
|
|
99
|
-
* @property {string} [
|
|
100
|
-
*
|
|
101
|
-
* @property {number[]} [subscribers] - An array of subscriber IDs associated
|
|
102
|
-
* with the history report.
|
|
47
|
+
* @typedef RetryStatusResponse
|
|
48
|
+
* @property {number} [total_event] - The total number of events that require retry.
|
|
49
|
+
* @property {number} [success_count] - The count of successfully retried events.
|
|
50
|
+
* @property {number} [failure_count] - The count of failed retry attempts.
|
|
51
|
+
* @property {string} [status] - The overall status of the retry process (e.g.,
|
|
52
|
+
* "completed").
|
|
103
53
|
*/
|
|
104
54
|
/**
|
|
105
|
-
* @typedef
|
|
106
|
-
* @property {
|
|
107
|
-
* @property {string} [
|
|
108
|
-
*
|
|
109
|
-
* @property {
|
|
110
|
-
* @property {
|
|
111
|
-
* @property {
|
|
112
|
-
* @property {string} [message] - A message related to the history report.
|
|
113
|
-
* @property {string} [status] - The status of the history report (e.g., "COMPLETED").
|
|
114
|
-
* @property {string} [updated_on] - The date and time when the history report
|
|
115
|
-
* was last updated.
|
|
116
|
-
* @property {UploadServiceObject} [upload_service_response]
|
|
55
|
+
* @typedef EventProcessRequest
|
|
56
|
+
* @property {string} [search_text]
|
|
57
|
+
* @property {string} [end_date]
|
|
58
|
+
* @property {string} [start_date]
|
|
59
|
+
* @property {number[]} [subscriber_ids]
|
|
60
|
+
* @property {string} [status]
|
|
61
|
+
* @property {Event[]} [event]
|
|
117
62
|
*/
|
|
118
63
|
/**
|
|
119
|
-
* @typedef
|
|
120
|
-
* @property {
|
|
121
|
-
* @property {number} [page_size] - The number of records per page.
|
|
122
|
-
* @property {string} [type] - The type of history report (e.g., "platform").
|
|
64
|
+
* @typedef DownloadReportResponse
|
|
65
|
+
* @property {string} [file_name]
|
|
123
66
|
*/
|
|
124
67
|
/**
|
|
125
|
-
* @typedef
|
|
126
|
-
* @property {
|
|
68
|
+
* @typedef EventProcessReports
|
|
69
|
+
* @property {EventProcessReportObject[]} [rows]
|
|
127
70
|
* @property {Page} [page]
|
|
128
71
|
*/
|
|
129
72
|
/**
|
|
130
|
-
* @typedef
|
|
131
|
-
* @property {
|
|
132
|
-
* @property {
|
|
73
|
+
* @typedef EventProcessReportObject
|
|
74
|
+
* @property {string} [event_name] - The name of the processed event.
|
|
75
|
+
* @property {number} [response_code] - The response code of the event.
|
|
76
|
+
* @property {string} [response_message] - The response message of the event.
|
|
77
|
+
* @property {Object} [data] - The data associated with the event.
|
|
78
|
+
* @property {number} [attempt] - The attempt number of the event.
|
|
79
|
+
* @property {number} [last_attempted_on] - The timestamp of the last attempted event.
|
|
80
|
+
* @property {string} [status] - The status of the event (e.g., "FAILED").
|
|
81
|
+
* @property {string} [name] - The name of the event.
|
|
82
|
+
* @property {string} [webhook_url] - The webhook URL associated with the event.
|
|
83
|
+
* @property {number} [response_time] - The response time of the event.
|
|
84
|
+
* @property {string} [message_id]
|
|
85
|
+
* @property {string} [event_trace_id]
|
|
133
86
|
*/
|
|
134
87
|
/**
|
|
135
88
|
* @typedef Page
|
|
136
|
-
* @property {number} [current]
|
|
137
|
-
* @property {boolean} [has_next]
|
|
138
|
-
* @property {boolean} [has_previous]
|
|
139
89
|
* @property {number} [item_total]
|
|
140
90
|
* @property {string} [next_id]
|
|
141
|
-
* @property {
|
|
91
|
+
* @property {boolean} [has_previous]
|
|
92
|
+
* @property {boolean} [has_next]
|
|
93
|
+
* @property {number} [current]
|
|
142
94
|
* @property {string} type
|
|
95
|
+
* @property {number} [size]
|
|
143
96
|
*/
|
|
144
97
|
/**
|
|
145
98
|
* @typedef PingWebhook
|
|
99
|
+
* @property {string} [webhook_url] - The URL of the subscriber's webhook to ping.
|
|
146
100
|
* @property {Object} [auth_meta] - Authentication metadata (if required by the
|
|
147
101
|
* subscriber).
|
|
148
102
|
* @property {Object} [custom_headers] - Custom headers to include in the ping request.
|
|
149
|
-
* @property {string} [webhook_url] - The URL of the subscriber's webhook to ping.
|
|
150
103
|
*/
|
|
151
104
|
/**
|
|
152
105
|
* @typedef PingWebhookResponse
|
|
153
|
-
* @property {number} [code] - The HTTP status code of the ping response (e.g., 200).
|
|
154
|
-
* @property {string} [message] - An optional message related to the ping.
|
|
155
106
|
* @property {string} [status] - The status of the ping (e.g., "SUCCESS").
|
|
107
|
+
* @property {string} [message] - An optional message related to the ping.
|
|
108
|
+
* @property {number} [code] - The HTTP status code of the ping response (e.g., 200).
|
|
156
109
|
*/
|
|
157
110
|
/**
|
|
158
|
-
* @typedef
|
|
159
|
-
* @property {
|
|
160
|
-
* @property {
|
|
111
|
+
* @typedef EventConfig
|
|
112
|
+
* @property {number} [id]
|
|
113
|
+
* @property {string} [event_name]
|
|
114
|
+
* @property {string} [event_type]
|
|
115
|
+
* @property {string} [event_category]
|
|
116
|
+
* @property {Object} [event_schema]
|
|
117
|
+
* @property {string} [version]
|
|
118
|
+
* @property {string} [display_name]
|
|
119
|
+
* @property {string} [description]
|
|
120
|
+
* @property {string} [created_on]
|
|
121
|
+
* @property {string} [updated_on]
|
|
122
|
+
*/
|
|
123
|
+
/**
|
|
124
|
+
* @typedef EventConfigResponse
|
|
125
|
+
* @property {EventConfig[]} [event_configs]
|
|
161
126
|
*/
|
|
162
127
|
/**
|
|
163
128
|
* @typedef ReportFiltersPayload
|
|
@@ -165,138 +130,134 @@ export = WebhookPlatformModel;
|
|
|
165
130
|
* filtering filters (optional).
|
|
166
131
|
*/
|
|
167
132
|
/**
|
|
168
|
-
* @typedef
|
|
169
|
-
* @property {
|
|
133
|
+
* @typedef ReportFilterResponse
|
|
134
|
+
* @property {string} [filter_name] - The name of the filter.
|
|
135
|
+
* @property {Object[]} [values]
|
|
170
136
|
*/
|
|
171
137
|
/**
|
|
172
|
-
* @typedef
|
|
173
|
-
* @property {string} [
|
|
174
|
-
* @property {
|
|
138
|
+
* @typedef HistoryPayload
|
|
139
|
+
* @property {string} [type] - The type of history report (e.g., "platform").
|
|
140
|
+
* @property {number} [page_no] - The page number of the history report.
|
|
141
|
+
* @property {number} [page_size] - The number of records per page.
|
|
142
|
+
*/
|
|
143
|
+
/**
|
|
144
|
+
* @typedef HistoryFilters
|
|
145
|
+
* @property {string[]} [events]
|
|
175
146
|
* @property {string} [search_text]
|
|
176
|
-
* @property {string} [
|
|
177
|
-
* @property {string} [
|
|
178
|
-
* @property {
|
|
147
|
+
* @property {string} [status] - The status of the history report (e.g., "FAILED").
|
|
148
|
+
* @property {string} [end_date] - The end date and time of the history report.
|
|
149
|
+
* @property {string} [start_date] - The start date and time of the history report.
|
|
150
|
+
* @property {number[]} [subscribers] - An array of subscriber IDs associated
|
|
151
|
+
* with the history report.
|
|
179
152
|
*/
|
|
180
153
|
/**
|
|
181
|
-
* @typedef
|
|
182
|
-
* @property {
|
|
154
|
+
* @typedef Url
|
|
155
|
+
* @property {string} [url] - The URL of the uploaded report file.
|
|
156
|
+
* @property {string} [name] - The name of the uploaded report file.
|
|
183
157
|
*/
|
|
184
158
|
/**
|
|
185
|
-
* @typedef
|
|
186
|
-
* @property {
|
|
187
|
-
* @property {string} [status] - The overall status of the retry process (e.g.,
|
|
188
|
-
* "completed").
|
|
189
|
-
* @property {number} [success_count] - The count of successfully retried events.
|
|
190
|
-
* @property {number} [total_event] - The total number of events that require retry.
|
|
159
|
+
* @typedef CdnObject
|
|
160
|
+
* @property {Url[]} [urls]
|
|
191
161
|
*/
|
|
192
162
|
/**
|
|
193
|
-
* @typedef
|
|
194
|
-
* @property {
|
|
195
|
-
* @property {boolean} [success]
|
|
163
|
+
* @typedef UploadServiceObject
|
|
164
|
+
* @property {CdnObject} [cdn]
|
|
196
165
|
*/
|
|
197
166
|
/**
|
|
198
|
-
* @typedef
|
|
199
|
-
* @property {
|
|
200
|
-
* @property {
|
|
201
|
-
* @property {Object} [custom_headers]
|
|
202
|
-
* @property {string} [email_id]
|
|
203
|
-
* @property {number[]} [event_id]
|
|
204
|
-
* @property {number} [id]
|
|
205
|
-
* @property {string} [name]
|
|
206
|
-
* @property {SubscriberStatus} [status]
|
|
207
|
-
* @property {string} [webhook_url]
|
|
167
|
+
* @typedef HistoryAssociation
|
|
168
|
+
* @property {number} [company_id]
|
|
169
|
+
* @property {number[]} [subscriber_ids]
|
|
208
170
|
*/
|
|
209
171
|
/**
|
|
210
|
-
* @typedef
|
|
211
|
-
* @property {
|
|
172
|
+
* @typedef HistoryItems
|
|
173
|
+
* @property {number} [id] - The ID of the history report.
|
|
174
|
+
* @property {HistoryAssociation} [association]
|
|
175
|
+
* @property {HistoryFilters} [filters]
|
|
176
|
+
* @property {string} [filename] - The filename of the history report.
|
|
177
|
+
* @property {string} [status] - The status of the history report (e.g., "COMPLETED").
|
|
178
|
+
* @property {UploadServiceObject} [upload_service_response]
|
|
179
|
+
* @property {string} [created_on] - The date and time when the history report
|
|
180
|
+
* was created.
|
|
181
|
+
* @property {string} [updated_on] - The date and time when the history report
|
|
182
|
+
* was last updated.
|
|
183
|
+
* @property {string} [message] - A message related to the history report.
|
|
184
|
+
*/
|
|
185
|
+
/**
|
|
186
|
+
* @typedef HistoryResponse
|
|
187
|
+
* @property {HistoryItems[]} [items]
|
|
212
188
|
* @property {Page} [page]
|
|
213
189
|
*/
|
|
214
190
|
/**
|
|
215
|
-
* @typedef
|
|
216
|
-
* @property {
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
* @
|
|
220
|
-
* @property {
|
|
221
|
-
* @property {
|
|
191
|
+
* @typedef CancelResponse
|
|
192
|
+
* @property {string} [message] - The HTTP status code of the response (e.g., 200).
|
|
193
|
+
*/
|
|
194
|
+
/**
|
|
195
|
+
* @typedef Association
|
|
196
|
+
* @property {number} [company_id]
|
|
197
|
+
* @property {string[]} [application_id]
|
|
198
|
+
* @property {string} [extension_id]
|
|
199
|
+
* @property {string} [criteria]
|
|
200
|
+
*/
|
|
201
|
+
/**
|
|
202
|
+
* @typedef AuthMeta
|
|
203
|
+
* @property {string} [type]
|
|
204
|
+
* @property {string} [secret]
|
|
205
|
+
*/
|
|
206
|
+
/**
|
|
207
|
+
* @typedef SubscriberResponse
|
|
222
208
|
* @property {number} [id]
|
|
223
209
|
* @property {string} [modified_by]
|
|
224
210
|
* @property {string} [name]
|
|
211
|
+
* @property {string} [webhook_url]
|
|
212
|
+
* @property {Association} [association]
|
|
213
|
+
* @property {Object} [custom_headers]
|
|
225
214
|
* @property {SubscriberStatus} [status]
|
|
226
|
-
* @property {string} [
|
|
215
|
+
* @property {string} [email_id]
|
|
227
216
|
* @property {string} [updated_on]
|
|
228
|
-
* @property {string} [
|
|
217
|
+
* @property {string} [created_on]
|
|
218
|
+
* @property {string} [type]
|
|
219
|
+
* @property {AuthMeta} [auth_meta]
|
|
220
|
+
* @property {EventConfig[]} [event_configs]
|
|
229
221
|
*/
|
|
230
222
|
/**
|
|
231
|
-
* @typedef
|
|
223
|
+
* @typedef SubscriberConfig
|
|
224
|
+
* @property {number} [id]
|
|
225
|
+
* @property {string} [name]
|
|
226
|
+
* @property {string} [webhook_url]
|
|
232
227
|
* @property {Association} [association]
|
|
233
|
-
* @property {AuthMeta} [auth_meta]
|
|
234
|
-
* @property {string} [created_on]
|
|
235
228
|
* @property {Object} [custom_headers]
|
|
229
|
+
* @property {SubscriberStatus} [status]
|
|
236
230
|
* @property {string} [email_id]
|
|
237
|
-
* @property {
|
|
231
|
+
* @property {AuthMeta} [auth_meta]
|
|
232
|
+
* @property {number[]} [event_id]
|
|
233
|
+
*/
|
|
234
|
+
/**
|
|
235
|
+
* @typedef SubscriberConfigResponse
|
|
238
236
|
* @property {number} [id]
|
|
239
237
|
* @property {string} [modified_by]
|
|
240
238
|
* @property {string} [name]
|
|
239
|
+
* @property {string} [webhook_url]
|
|
240
|
+
* @property {Association} [association]
|
|
241
|
+
* @property {Object} [custom_headers]
|
|
241
242
|
* @property {SubscriberStatus} [status]
|
|
242
|
-
* @property {string} [
|
|
243
|
+
* @property {string} [email_id]
|
|
243
244
|
* @property {string} [updated_on]
|
|
244
|
-
* @property {string} [
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
* @
|
|
248
|
-
* @property {CdnObject} [cdn]
|
|
245
|
+
* @property {string} [created_on]
|
|
246
|
+
* @property {string} [type]
|
|
247
|
+
* @property {AuthMeta} [auth_meta]
|
|
248
|
+
* @property {number[]} [event_id]
|
|
249
249
|
*/
|
|
250
250
|
/**
|
|
251
|
-
* @typedef
|
|
252
|
-
* @property {
|
|
253
|
-
* @property {
|
|
251
|
+
* @typedef SubscriberConfigList
|
|
252
|
+
* @property {SubscriberResponse[]} [items]
|
|
253
|
+
* @property {Page} [page]
|
|
254
254
|
*/
|
|
255
255
|
/** @typedef {"active" | "inactive" | "blocked"} SubscriberStatus */
|
|
256
256
|
declare class WebhookPlatformModel {
|
|
257
257
|
}
|
|
258
258
|
declare namespace WebhookPlatformModel {
|
|
259
|
-
export {
|
|
259
|
+
export { Error, Event, RetryEventRequest, Item, RetryCountResponse, RetrySuccessResponse, Err, RetryFailureResponse, RetryStatusResponse, EventProcessRequest, DownloadReportResponse, EventProcessReports, EventProcessReportObject, Page, PingWebhook, PingWebhookResponse, EventConfig, EventConfigResponse, ReportFiltersPayload, ReportFilterResponse, HistoryPayload, HistoryFilters, Url, CdnObject, UploadServiceObject, HistoryAssociation, HistoryItems, HistoryResponse, CancelResponse, Association, AuthMeta, SubscriberResponse, SubscriberConfig, SubscriberConfigResponse, SubscriberConfigList, SubscriberStatus };
|
|
260
260
|
}
|
|
261
|
-
/** @returns {Association} */
|
|
262
|
-
declare function Association(): Association;
|
|
263
|
-
type Association = {
|
|
264
|
-
application_id?: string[];
|
|
265
|
-
company_id?: number;
|
|
266
|
-
criteria?: string;
|
|
267
|
-
extension_id?: string;
|
|
268
|
-
};
|
|
269
|
-
/** @returns {AuthMeta} */
|
|
270
|
-
declare function AuthMeta(): AuthMeta;
|
|
271
|
-
type AuthMeta = {
|
|
272
|
-
secret?: string;
|
|
273
|
-
type?: string;
|
|
274
|
-
};
|
|
275
|
-
/** @returns {CancelResponse} */
|
|
276
|
-
declare function CancelResponse(): CancelResponse;
|
|
277
|
-
type CancelResponse = {
|
|
278
|
-
/**
|
|
279
|
-
* - The HTTP status code of the response (e.g., 200).
|
|
280
|
-
*/
|
|
281
|
-
message?: string;
|
|
282
|
-
};
|
|
283
|
-
/** @returns {CdnObject} */
|
|
284
|
-
declare function CdnObject(): CdnObject;
|
|
285
|
-
type CdnObject = {
|
|
286
|
-
urls?: Url[];
|
|
287
|
-
};
|
|
288
|
-
/** @returns {DownloadReportResponse} */
|
|
289
|
-
declare function DownloadReportResponse(): DownloadReportResponse;
|
|
290
|
-
type DownloadReportResponse = {
|
|
291
|
-
file_name?: string;
|
|
292
|
-
};
|
|
293
|
-
/** @returns {Err} */
|
|
294
|
-
declare function Err(): Err;
|
|
295
|
-
type Err = {
|
|
296
|
-
location?: string;
|
|
297
|
-
msg?: string;
|
|
298
|
-
param?: string;
|
|
299
|
-
};
|
|
300
261
|
/** @returns {Error} */
|
|
301
262
|
declare function Error(): Error;
|
|
302
263
|
type Error = {
|
|
@@ -308,55 +269,99 @@ type Error = {
|
|
|
308
269
|
/** @returns {Event} */
|
|
309
270
|
declare function Event(): Event;
|
|
310
271
|
type Event = {
|
|
311
|
-
event_category?: string;
|
|
312
272
|
event_name?: string;
|
|
313
273
|
event_type?: string;
|
|
314
|
-
version?: string;
|
|
315
|
-
};
|
|
316
|
-
/** @returns {EventConfig} */
|
|
317
|
-
declare function EventConfig(): EventConfig;
|
|
318
|
-
type EventConfig = {
|
|
319
|
-
created_on?: string;
|
|
320
|
-
description?: string;
|
|
321
|
-
display_name?: string;
|
|
322
274
|
event_category?: string;
|
|
323
|
-
event_name?: string;
|
|
324
|
-
event_schema?: any;
|
|
325
|
-
event_type?: string;
|
|
326
|
-
id?: number;
|
|
327
|
-
updated_on?: string;
|
|
328
275
|
version?: string;
|
|
329
276
|
};
|
|
330
|
-
/** @returns {
|
|
331
|
-
declare function
|
|
332
|
-
type
|
|
333
|
-
|
|
277
|
+
/** @returns {RetryEventRequest} */
|
|
278
|
+
declare function RetryEventRequest(): RetryEventRequest;
|
|
279
|
+
type RetryEventRequest = {
|
|
280
|
+
search_text?: string;
|
|
281
|
+
end_date?: string;
|
|
282
|
+
start_date?: string;
|
|
283
|
+
subscriber_ids?: number[];
|
|
284
|
+
event?: Event[];
|
|
285
|
+
status?: string;
|
|
334
286
|
};
|
|
335
|
-
/** @returns {
|
|
336
|
-
declare function
|
|
337
|
-
type
|
|
287
|
+
/** @returns {Item} */
|
|
288
|
+
declare function Item(): Item;
|
|
289
|
+
type Item = {
|
|
290
|
+
status?: string;
|
|
291
|
+
count?: number;
|
|
292
|
+
};
|
|
293
|
+
/** @returns {RetryCountResponse} */
|
|
294
|
+
declare function RetryCountResponse(): RetryCountResponse;
|
|
295
|
+
type RetryCountResponse = {
|
|
296
|
+
items?: Item[];
|
|
297
|
+
};
|
|
298
|
+
/** @returns {RetrySuccessResponse} */
|
|
299
|
+
declare function RetrySuccessResponse(): RetrySuccessResponse;
|
|
300
|
+
type RetrySuccessResponse = {
|
|
301
|
+
success?: boolean;
|
|
302
|
+
message?: string;
|
|
303
|
+
};
|
|
304
|
+
/** @returns {Err} */
|
|
305
|
+
declare function Err(): Err;
|
|
306
|
+
type Err = {
|
|
307
|
+
msg?: string;
|
|
308
|
+
param?: string;
|
|
309
|
+
location?: string;
|
|
310
|
+
};
|
|
311
|
+
/** @returns {RetryFailureResponse} */
|
|
312
|
+
declare function RetryFailureResponse(): RetryFailureResponse;
|
|
313
|
+
type RetryFailureResponse = {
|
|
314
|
+
err?: Err[];
|
|
315
|
+
};
|
|
316
|
+
/** @returns {RetryStatusResponse} */
|
|
317
|
+
declare function RetryStatusResponse(): RetryStatusResponse;
|
|
318
|
+
type RetryStatusResponse = {
|
|
338
319
|
/**
|
|
339
|
-
* - The
|
|
320
|
+
* - The total number of events that require retry.
|
|
340
321
|
*/
|
|
341
|
-
|
|
322
|
+
total_event?: number;
|
|
342
323
|
/**
|
|
343
|
-
* - The
|
|
324
|
+
* - The count of successfully retried events.
|
|
344
325
|
*/
|
|
345
|
-
|
|
326
|
+
success_count?: number;
|
|
346
327
|
/**
|
|
347
|
-
* - The
|
|
328
|
+
* - The count of failed retry attempts.
|
|
348
329
|
*/
|
|
349
|
-
|
|
350
|
-
event_trace_id?: string;
|
|
330
|
+
failure_count?: number;
|
|
351
331
|
/**
|
|
352
|
-
* - The
|
|
332
|
+
* - The overall status of the retry process (e.g.,
|
|
333
|
+
* "completed").
|
|
353
334
|
*/
|
|
354
|
-
|
|
355
|
-
|
|
335
|
+
status?: string;
|
|
336
|
+
};
|
|
337
|
+
/** @returns {EventProcessRequest} */
|
|
338
|
+
declare function EventProcessRequest(): EventProcessRequest;
|
|
339
|
+
type EventProcessRequest = {
|
|
340
|
+
search_text?: string;
|
|
341
|
+
end_date?: string;
|
|
342
|
+
start_date?: string;
|
|
343
|
+
subscriber_ids?: number[];
|
|
344
|
+
status?: string;
|
|
345
|
+
event?: Event[];
|
|
346
|
+
};
|
|
347
|
+
/** @returns {DownloadReportResponse} */
|
|
348
|
+
declare function DownloadReportResponse(): DownloadReportResponse;
|
|
349
|
+
type DownloadReportResponse = {
|
|
350
|
+
file_name?: string;
|
|
351
|
+
};
|
|
352
|
+
/** @returns {EventProcessReports} */
|
|
353
|
+
declare function EventProcessReports(): EventProcessReports;
|
|
354
|
+
type EventProcessReports = {
|
|
355
|
+
rows?: EventProcessReportObject[];
|
|
356
|
+
page?: Page;
|
|
357
|
+
};
|
|
358
|
+
/** @returns {EventProcessReportObject} */
|
|
359
|
+
declare function EventProcessReportObject(): EventProcessReportObject;
|
|
360
|
+
type EventProcessReportObject = {
|
|
356
361
|
/**
|
|
357
|
-
* - The name of the event.
|
|
362
|
+
* - The name of the processed event.
|
|
358
363
|
*/
|
|
359
|
-
|
|
364
|
+
event_name?: string;
|
|
360
365
|
/**
|
|
361
366
|
* - The response code of the event.
|
|
362
367
|
*/
|
|
@@ -366,99 +371,124 @@ type EventProcessReportObject = {
|
|
|
366
371
|
*/
|
|
367
372
|
response_message?: string;
|
|
368
373
|
/**
|
|
369
|
-
* - The
|
|
374
|
+
* - The data associated with the event.
|
|
370
375
|
*/
|
|
371
|
-
|
|
376
|
+
data?: any;
|
|
377
|
+
/**
|
|
378
|
+
* - The attempt number of the event.
|
|
379
|
+
*/
|
|
380
|
+
attempt?: number;
|
|
381
|
+
/**
|
|
382
|
+
* - The timestamp of the last attempted event.
|
|
383
|
+
*/
|
|
384
|
+
last_attempted_on?: number;
|
|
372
385
|
/**
|
|
373
386
|
* - The status of the event (e.g., "FAILED").
|
|
374
387
|
*/
|
|
375
388
|
status?: string;
|
|
389
|
+
/**
|
|
390
|
+
* - The name of the event.
|
|
391
|
+
*/
|
|
392
|
+
name?: string;
|
|
376
393
|
/**
|
|
377
394
|
* - The webhook URL associated with the event.
|
|
378
395
|
*/
|
|
379
396
|
webhook_url?: string;
|
|
397
|
+
/**
|
|
398
|
+
* - The response time of the event.
|
|
399
|
+
*/
|
|
400
|
+
response_time?: number;
|
|
401
|
+
message_id?: string;
|
|
402
|
+
event_trace_id?: string;
|
|
380
403
|
};
|
|
381
|
-
/** @returns {
|
|
382
|
-
declare function
|
|
383
|
-
type
|
|
384
|
-
|
|
385
|
-
|
|
404
|
+
/** @returns {Page} */
|
|
405
|
+
declare function Page(): Page;
|
|
406
|
+
type Page = {
|
|
407
|
+
item_total?: number;
|
|
408
|
+
next_id?: string;
|
|
409
|
+
has_previous?: boolean;
|
|
410
|
+
has_next?: boolean;
|
|
411
|
+
current?: number;
|
|
412
|
+
type: string;
|
|
413
|
+
size?: number;
|
|
386
414
|
};
|
|
387
|
-
/** @returns {
|
|
388
|
-
declare function
|
|
389
|
-
type
|
|
390
|
-
end_date?: string;
|
|
391
|
-
event?: Event[];
|
|
392
|
-
search_text?: string;
|
|
393
|
-
start_date?: string;
|
|
394
|
-
status?: string;
|
|
395
|
-
subscriber_ids?: number[];
|
|
396
|
-
};
|
|
397
|
-
/** @returns {HistoryAssociation} */
|
|
398
|
-
declare function HistoryAssociation(): HistoryAssociation;
|
|
399
|
-
type HistoryAssociation = {
|
|
400
|
-
company_id?: number;
|
|
401
|
-
subscriber_ids?: number[];
|
|
402
|
-
};
|
|
403
|
-
/** @returns {HistoryFilters} */
|
|
404
|
-
declare function HistoryFilters(): HistoryFilters;
|
|
405
|
-
type HistoryFilters = {
|
|
406
|
-
/**
|
|
407
|
-
* - The end date and time of the history report.
|
|
408
|
-
*/
|
|
409
|
-
end_date?: string;
|
|
410
|
-
events?: string[];
|
|
411
|
-
search_text?: string;
|
|
415
|
+
/** @returns {PingWebhook} */
|
|
416
|
+
declare function PingWebhook(): PingWebhook;
|
|
417
|
+
type PingWebhook = {
|
|
412
418
|
/**
|
|
413
|
-
* - The
|
|
419
|
+
* - The URL of the subscriber's webhook to ping.
|
|
414
420
|
*/
|
|
415
|
-
|
|
421
|
+
webhook_url?: string;
|
|
416
422
|
/**
|
|
417
|
-
* -
|
|
423
|
+
* - Authentication metadata (if required by the
|
|
424
|
+
* subscriber).
|
|
418
425
|
*/
|
|
419
|
-
|
|
426
|
+
auth_meta?: any;
|
|
420
427
|
/**
|
|
421
|
-
* -
|
|
422
|
-
* with the history report.
|
|
428
|
+
* - Custom headers to include in the ping request.
|
|
423
429
|
*/
|
|
424
|
-
|
|
430
|
+
custom_headers?: any;
|
|
425
431
|
};
|
|
426
|
-
/** @returns {
|
|
427
|
-
declare function
|
|
428
|
-
type
|
|
429
|
-
association?: HistoryAssociation;
|
|
432
|
+
/** @returns {PingWebhookResponse} */
|
|
433
|
+
declare function PingWebhookResponse(): PingWebhookResponse;
|
|
434
|
+
type PingWebhookResponse = {
|
|
430
435
|
/**
|
|
431
|
-
* - The
|
|
432
|
-
* was created.
|
|
436
|
+
* - The status of the ping (e.g., "SUCCESS").
|
|
433
437
|
*/
|
|
434
|
-
|
|
438
|
+
status?: string;
|
|
435
439
|
/**
|
|
436
|
-
* -
|
|
440
|
+
* - An optional message related to the ping.
|
|
437
441
|
*/
|
|
438
|
-
|
|
439
|
-
filters?: HistoryFilters;
|
|
442
|
+
message?: string;
|
|
440
443
|
/**
|
|
441
|
-
* - The
|
|
444
|
+
* - The HTTP status code of the ping response (e.g., 200).
|
|
442
445
|
*/
|
|
446
|
+
code?: number;
|
|
447
|
+
};
|
|
448
|
+
/** @returns {EventConfig} */
|
|
449
|
+
declare function EventConfig(): EventConfig;
|
|
450
|
+
type EventConfig = {
|
|
443
451
|
id?: number;
|
|
452
|
+
event_name?: string;
|
|
453
|
+
event_type?: string;
|
|
454
|
+
event_category?: string;
|
|
455
|
+
event_schema?: any;
|
|
456
|
+
version?: string;
|
|
457
|
+
display_name?: string;
|
|
458
|
+
description?: string;
|
|
459
|
+
created_on?: string;
|
|
460
|
+
updated_on?: string;
|
|
461
|
+
};
|
|
462
|
+
/** @returns {EventConfigResponse} */
|
|
463
|
+
declare function EventConfigResponse(): EventConfigResponse;
|
|
464
|
+
type EventConfigResponse = {
|
|
465
|
+
event_configs?: EventConfig[];
|
|
466
|
+
};
|
|
467
|
+
/** @returns {ReportFiltersPayload} */
|
|
468
|
+
declare function ReportFiltersPayload(): ReportFiltersPayload;
|
|
469
|
+
type ReportFiltersPayload = {
|
|
444
470
|
/**
|
|
445
|
-
* -
|
|
446
|
-
|
|
447
|
-
message?: string;
|
|
448
|
-
/**
|
|
449
|
-
* - The status of the history report (e.g., "COMPLETED").
|
|
471
|
+
* - An array of subscriber IDs for
|
|
472
|
+
* filtering filters (optional).
|
|
450
473
|
*/
|
|
451
|
-
|
|
474
|
+
subscriber_ids?: number[];
|
|
475
|
+
};
|
|
476
|
+
/** @returns {ReportFilterResponse} */
|
|
477
|
+
declare function ReportFilterResponse(): ReportFilterResponse;
|
|
478
|
+
type ReportFilterResponse = {
|
|
452
479
|
/**
|
|
453
|
-
* - The
|
|
454
|
-
* was last updated.
|
|
480
|
+
* - The name of the filter.
|
|
455
481
|
*/
|
|
456
|
-
|
|
457
|
-
|
|
482
|
+
filter_name?: string;
|
|
483
|
+
values?: any[];
|
|
458
484
|
};
|
|
459
485
|
/** @returns {HistoryPayload} */
|
|
460
486
|
declare function HistoryPayload(): HistoryPayload;
|
|
461
487
|
type HistoryPayload = {
|
|
488
|
+
/**
|
|
489
|
+
* - The type of history report (e.g., "platform").
|
|
490
|
+
*/
|
|
491
|
+
type?: string;
|
|
462
492
|
/**
|
|
463
493
|
* - The page number of the history report.
|
|
464
494
|
*/
|
|
@@ -467,201 +497,171 @@ type HistoryPayload = {
|
|
|
467
497
|
* - The number of records per page.
|
|
468
498
|
*/
|
|
469
499
|
page_size?: number;
|
|
500
|
+
};
|
|
501
|
+
/** @returns {HistoryFilters} */
|
|
502
|
+
declare function HistoryFilters(): HistoryFilters;
|
|
503
|
+
type HistoryFilters = {
|
|
504
|
+
events?: string[];
|
|
505
|
+
search_text?: string;
|
|
470
506
|
/**
|
|
471
|
-
* - The
|
|
507
|
+
* - The status of the history report (e.g., "FAILED").
|
|
472
508
|
*/
|
|
473
|
-
type?: string;
|
|
474
|
-
};
|
|
475
|
-
/** @returns {HistoryResponse} */
|
|
476
|
-
declare function HistoryResponse(): HistoryResponse;
|
|
477
|
-
type HistoryResponse = {
|
|
478
|
-
items?: HistoryItems[];
|
|
479
|
-
page?: Page;
|
|
480
|
-
};
|
|
481
|
-
/** @returns {Item} */
|
|
482
|
-
declare function Item(): Item;
|
|
483
|
-
type Item = {
|
|
484
|
-
count?: number;
|
|
485
509
|
status?: string;
|
|
486
|
-
};
|
|
487
|
-
/** @returns {Page} */
|
|
488
|
-
declare function Page(): Page;
|
|
489
|
-
type Page = {
|
|
490
|
-
current?: number;
|
|
491
|
-
has_next?: boolean;
|
|
492
|
-
has_previous?: boolean;
|
|
493
|
-
item_total?: number;
|
|
494
|
-
next_id?: string;
|
|
495
|
-
size?: number;
|
|
496
|
-
type: string;
|
|
497
|
-
};
|
|
498
|
-
/** @returns {PingWebhook} */
|
|
499
|
-
declare function PingWebhook(): PingWebhook;
|
|
500
|
-
type PingWebhook = {
|
|
501
510
|
/**
|
|
502
|
-
* -
|
|
503
|
-
* subscriber).
|
|
511
|
+
* - The end date and time of the history report.
|
|
504
512
|
*/
|
|
505
|
-
|
|
513
|
+
end_date?: string;
|
|
506
514
|
/**
|
|
507
|
-
* -
|
|
515
|
+
* - The start date and time of the history report.
|
|
508
516
|
*/
|
|
509
|
-
|
|
517
|
+
start_date?: string;
|
|
510
518
|
/**
|
|
511
|
-
* -
|
|
519
|
+
* - An array of subscriber IDs associated
|
|
520
|
+
* with the history report.
|
|
512
521
|
*/
|
|
513
|
-
|
|
522
|
+
subscribers?: number[];
|
|
514
523
|
};
|
|
515
|
-
/** @returns {
|
|
516
|
-
declare function
|
|
517
|
-
type
|
|
518
|
-
/**
|
|
519
|
-
* - The HTTP status code of the ping response (e.g., 200).
|
|
520
|
-
*/
|
|
521
|
-
code?: number;
|
|
522
|
-
/**
|
|
523
|
-
* - An optional message related to the ping.
|
|
524
|
-
*/
|
|
525
|
-
message?: string;
|
|
524
|
+
/** @returns {Url} */
|
|
525
|
+
declare function Url(): Url;
|
|
526
|
+
type Url = {
|
|
526
527
|
/**
|
|
527
|
-
* - The
|
|
528
|
+
* - The URL of the uploaded report file.
|
|
528
529
|
*/
|
|
529
|
-
|
|
530
|
-
};
|
|
531
|
-
/** @returns {ReportFilterResponse} */
|
|
532
|
-
declare function ReportFilterResponse(): ReportFilterResponse;
|
|
533
|
-
type ReportFilterResponse = {
|
|
530
|
+
url?: string;
|
|
534
531
|
/**
|
|
535
|
-
* - The name of the
|
|
532
|
+
* - The name of the uploaded report file.
|
|
536
533
|
*/
|
|
537
|
-
|
|
538
|
-
values?: any[];
|
|
534
|
+
name?: string;
|
|
539
535
|
};
|
|
540
|
-
/** @returns {
|
|
541
|
-
declare function
|
|
542
|
-
type
|
|
543
|
-
|
|
544
|
-
* - An array of subscriber IDs for
|
|
545
|
-
* filtering filters (optional).
|
|
546
|
-
*/
|
|
547
|
-
subscriber_ids?: number[];
|
|
536
|
+
/** @returns {CdnObject} */
|
|
537
|
+
declare function CdnObject(): CdnObject;
|
|
538
|
+
type CdnObject = {
|
|
539
|
+
urls?: Url[];
|
|
548
540
|
};
|
|
549
|
-
/** @returns {
|
|
550
|
-
declare function
|
|
551
|
-
type
|
|
552
|
-
|
|
541
|
+
/** @returns {UploadServiceObject} */
|
|
542
|
+
declare function UploadServiceObject(): UploadServiceObject;
|
|
543
|
+
type UploadServiceObject = {
|
|
544
|
+
cdn?: CdnObject;
|
|
553
545
|
};
|
|
554
|
-
/** @returns {
|
|
555
|
-
declare function
|
|
556
|
-
type
|
|
557
|
-
|
|
558
|
-
event?: Event[];
|
|
559
|
-
search_text?: string;
|
|
560
|
-
start_date?: string;
|
|
561
|
-
status?: string;
|
|
546
|
+
/** @returns {HistoryAssociation} */
|
|
547
|
+
declare function HistoryAssociation(): HistoryAssociation;
|
|
548
|
+
type HistoryAssociation = {
|
|
549
|
+
company_id?: number;
|
|
562
550
|
subscriber_ids?: number[];
|
|
563
551
|
};
|
|
564
|
-
/** @returns {
|
|
565
|
-
declare function
|
|
566
|
-
type
|
|
567
|
-
err?: Err[];
|
|
568
|
-
};
|
|
569
|
-
/** @returns {RetryStatusResponse} */
|
|
570
|
-
declare function RetryStatusResponse(): RetryStatusResponse;
|
|
571
|
-
type RetryStatusResponse = {
|
|
552
|
+
/** @returns {HistoryItems} */
|
|
553
|
+
declare function HistoryItems(): HistoryItems;
|
|
554
|
+
type HistoryItems = {
|
|
572
555
|
/**
|
|
573
|
-
* - The
|
|
556
|
+
* - The ID of the history report.
|
|
574
557
|
*/
|
|
575
|
-
|
|
558
|
+
id?: number;
|
|
559
|
+
association?: HistoryAssociation;
|
|
560
|
+
filters?: HistoryFilters;
|
|
576
561
|
/**
|
|
577
|
-
* - The
|
|
578
|
-
|
|
562
|
+
* - The filename of the history report.
|
|
563
|
+
*/
|
|
564
|
+
filename?: string;
|
|
565
|
+
/**
|
|
566
|
+
* - The status of the history report (e.g., "COMPLETED").
|
|
579
567
|
*/
|
|
580
568
|
status?: string;
|
|
569
|
+
upload_service_response?: UploadServiceObject;
|
|
581
570
|
/**
|
|
582
|
-
* - The
|
|
571
|
+
* - The date and time when the history report
|
|
572
|
+
* was created.
|
|
583
573
|
*/
|
|
584
|
-
|
|
574
|
+
created_on?: string;
|
|
585
575
|
/**
|
|
586
|
-
* - The
|
|
576
|
+
* - The date and time when the history report
|
|
577
|
+
* was last updated.
|
|
587
578
|
*/
|
|
588
|
-
|
|
579
|
+
updated_on?: string;
|
|
580
|
+
/**
|
|
581
|
+
* - A message related to the history report.
|
|
582
|
+
*/
|
|
583
|
+
message?: string;
|
|
589
584
|
};
|
|
590
|
-
/** @returns {
|
|
591
|
-
declare function
|
|
592
|
-
type
|
|
585
|
+
/** @returns {HistoryResponse} */
|
|
586
|
+
declare function HistoryResponse(): HistoryResponse;
|
|
587
|
+
type HistoryResponse = {
|
|
588
|
+
items?: HistoryItems[];
|
|
589
|
+
page?: Page;
|
|
590
|
+
};
|
|
591
|
+
/** @returns {CancelResponse} */
|
|
592
|
+
declare function CancelResponse(): CancelResponse;
|
|
593
|
+
type CancelResponse = {
|
|
594
|
+
/**
|
|
595
|
+
* - The HTTP status code of the response (e.g., 200).
|
|
596
|
+
*/
|
|
593
597
|
message?: string;
|
|
594
|
-
|
|
598
|
+
};
|
|
599
|
+
/** @returns {Association} */
|
|
600
|
+
declare function Association(): Association;
|
|
601
|
+
type Association = {
|
|
602
|
+
company_id?: number;
|
|
603
|
+
application_id?: string[];
|
|
604
|
+
extension_id?: string;
|
|
605
|
+
criteria?: string;
|
|
606
|
+
};
|
|
607
|
+
/** @returns {AuthMeta} */
|
|
608
|
+
declare function AuthMeta(): AuthMeta;
|
|
609
|
+
type AuthMeta = {
|
|
610
|
+
type?: string;
|
|
611
|
+
secret?: string;
|
|
612
|
+
};
|
|
613
|
+
/** @returns {SubscriberResponse} */
|
|
614
|
+
declare function SubscriberResponse(): SubscriberResponse;
|
|
615
|
+
type SubscriberResponse = {
|
|
616
|
+
id?: number;
|
|
617
|
+
modified_by?: string;
|
|
618
|
+
name?: string;
|
|
619
|
+
webhook_url?: string;
|
|
620
|
+
association?: Association;
|
|
621
|
+
custom_headers?: any;
|
|
622
|
+
status?: SubscriberStatus;
|
|
623
|
+
email_id?: string;
|
|
624
|
+
updated_on?: string;
|
|
625
|
+
created_on?: string;
|
|
626
|
+
type?: string;
|
|
627
|
+
auth_meta?: AuthMeta;
|
|
628
|
+
event_configs?: EventConfig[];
|
|
595
629
|
};
|
|
596
630
|
/** @returns {SubscriberConfig} */
|
|
597
631
|
declare function SubscriberConfig(): SubscriberConfig;
|
|
598
632
|
type SubscriberConfig = {
|
|
633
|
+
id?: number;
|
|
634
|
+
name?: string;
|
|
635
|
+
webhook_url?: string;
|
|
599
636
|
association?: Association;
|
|
600
|
-
auth_meta?: AuthMeta;
|
|
601
637
|
custom_headers?: any;
|
|
638
|
+
status?: SubscriberStatus;
|
|
602
639
|
email_id?: string;
|
|
640
|
+
auth_meta?: AuthMeta;
|
|
603
641
|
event_id?: number[];
|
|
604
|
-
id?: number;
|
|
605
|
-
name?: string;
|
|
606
|
-
status?: SubscriberStatus;
|
|
607
|
-
webhook_url?: string;
|
|
608
|
-
};
|
|
609
|
-
/** @returns {SubscriberConfigList} */
|
|
610
|
-
declare function SubscriberConfigList(): SubscriberConfigList;
|
|
611
|
-
type SubscriberConfigList = {
|
|
612
|
-
items?: SubscriberResponse[];
|
|
613
|
-
page?: Page;
|
|
614
642
|
};
|
|
615
643
|
/** @returns {SubscriberConfigResponse} */
|
|
616
644
|
declare function SubscriberConfigResponse(): SubscriberConfigResponse;
|
|
617
645
|
type SubscriberConfigResponse = {
|
|
618
|
-
association?: Association;
|
|
619
|
-
auth_meta?: AuthMeta;
|
|
620
|
-
created_on?: string;
|
|
621
|
-
custom_headers?: any;
|
|
622
|
-
email_id?: string;
|
|
623
|
-
event_id?: number[];
|
|
624
646
|
id?: number;
|
|
625
647
|
modified_by?: string;
|
|
626
648
|
name?: string;
|
|
627
|
-
status?: SubscriberStatus;
|
|
628
|
-
type?: string;
|
|
629
|
-
updated_on?: string;
|
|
630
649
|
webhook_url?: string;
|
|
631
|
-
};
|
|
632
|
-
/** @returns {SubscriberResponse} */
|
|
633
|
-
declare function SubscriberResponse(): SubscriberResponse;
|
|
634
|
-
type SubscriberResponse = {
|
|
635
650
|
association?: Association;
|
|
636
|
-
auth_meta?: AuthMeta;
|
|
637
|
-
created_on?: string;
|
|
638
651
|
custom_headers?: any;
|
|
639
|
-
email_id?: string;
|
|
640
|
-
event_configs?: EventConfig[];
|
|
641
|
-
id?: number;
|
|
642
|
-
modified_by?: string;
|
|
643
|
-
name?: string;
|
|
644
652
|
status?: SubscriberStatus;
|
|
645
|
-
|
|
653
|
+
email_id?: string;
|
|
646
654
|
updated_on?: string;
|
|
647
|
-
|
|
648
|
-
|
|
649
|
-
|
|
650
|
-
|
|
651
|
-
type UploadServiceObject = {
|
|
652
|
-
cdn?: CdnObject;
|
|
655
|
+
created_on?: string;
|
|
656
|
+
type?: string;
|
|
657
|
+
auth_meta?: AuthMeta;
|
|
658
|
+
event_id?: number[];
|
|
653
659
|
};
|
|
654
|
-
/** @returns {
|
|
655
|
-
declare function
|
|
656
|
-
type
|
|
657
|
-
|
|
658
|
-
|
|
659
|
-
*/
|
|
660
|
-
name?: string;
|
|
661
|
-
/**
|
|
662
|
-
* - The URL of the uploaded report file.
|
|
663
|
-
*/
|
|
664
|
-
url?: string;
|
|
660
|
+
/** @returns {SubscriberConfigList} */
|
|
661
|
+
declare function SubscriberConfigList(): SubscriberConfigList;
|
|
662
|
+
type SubscriberConfigList = {
|
|
663
|
+
items?: SubscriberResponse[];
|
|
664
|
+
page?: Page;
|
|
665
665
|
};
|
|
666
666
|
/**
|
|
667
667
|
* Enum: SubscriberStatus Used By: Webhook
|