@gofynd/fdk-client-javascript 1.4.1 → 1.4.2-beta.10

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.
Files changed (265) hide show
  1. package/README.md +1 -1
  2. package/package.json +3 -2
  3. package/sdk/application/ApplicationClient.js +20 -0
  4. package/sdk/application/Cart/CartApplicationClient.d.ts +1 -1
  5. package/sdk/application/Cart/CartApplicationClient.js +3 -5
  6. package/sdk/application/Cart/CartApplicationModel.d.ts +1634 -1742
  7. package/sdk/application/Cart/CartApplicationModel.js +1388 -1464
  8. package/sdk/application/Cart/CartApplicationValidator.d.ts +0 -4
  9. package/sdk/application/Cart/CartApplicationValidator.js +0 -4
  10. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +6 -3
  11. package/sdk/application/Catalog/CatalogApplicationClient.js +20 -7
  12. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +1917 -1917
  13. package/sdk/application/Catalog/CatalogApplicationModel.js +1613 -1613
  14. package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +14 -0
  15. package/sdk/application/Catalog/CatalogApplicationValidator.js +6 -0
  16. package/sdk/application/Common/CommonApplicationModel.d.ts +235 -235
  17. package/sdk/application/Common/CommonApplicationModel.js +172 -172
  18. package/sdk/application/Communication/CommunicationApplicationModel.d.ts +72 -72
  19. package/sdk/application/Communication/CommunicationApplicationModel.js +64 -64
  20. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +1492 -1626
  21. package/sdk/application/Configuration/ConfigurationApplicationModel.js +1038 -1180
  22. package/sdk/application/Content/ContentApplicationClient.d.ts +0 -36
  23. package/sdk/application/Content/ContentApplicationClient.js +0 -246
  24. package/sdk/application/Content/ContentApplicationModel.d.ts +546 -753
  25. package/sdk/application/Content/ContentApplicationModel.js +565 -817
  26. package/sdk/application/Content/ContentApplicationValidator.d.ts +1 -40
  27. package/sdk/application/Content/ContentApplicationValidator.js +0 -41
  28. package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +79 -79
  29. package/sdk/application/FileStorage/FileStorageApplicationModel.js +84 -84
  30. package/sdk/application/Lead/LeadApplicationModel.d.ts +417 -417
  31. package/sdk/application/Lead/LeadApplicationModel.js +301 -301
  32. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +0 -67
  33. package/sdk/application/Logistic/LogisticApplicationClient.js +0 -547
  34. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +257 -712
  35. package/sdk/application/Logistic/LogisticApplicationModel.js +267 -755
  36. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +1 -211
  37. package/sdk/application/Logistic/LogisticApplicationValidator.js +0 -131
  38. package/sdk/application/Order/OrderApplicationClient.d.ts +3 -3
  39. package/sdk/application/Order/OrderApplicationClient.js +8 -32
  40. package/sdk/application/Order/OrderApplicationModel.d.ts +845 -853
  41. package/sdk/application/Order/OrderApplicationModel.js +816 -824
  42. package/sdk/application/Order/OrderApplicationValidator.d.ts +0 -20
  43. package/sdk/application/Order/OrderApplicationValidator.js +0 -8
  44. package/sdk/application/Payment/PaymentApplicationClient.d.ts +2 -46
  45. package/sdk/application/Payment/PaymentApplicationClient.js +10 -341
  46. package/sdk/application/Payment/PaymentApplicationModel.d.ts +1892 -2199
  47. package/sdk/application/Payment/PaymentApplicationModel.js +1235 -1506
  48. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +14 -59
  49. package/sdk/application/Payment/PaymentApplicationValidator.js +10 -64
  50. package/sdk/application/PosCart/PosCartApplicationModel.d.ts +1396 -1429
  51. package/sdk/application/PosCart/PosCartApplicationModel.js +1233 -1257
  52. package/sdk/application/Rewards/RewardsApplicationModel.d.ts +214 -214
  53. package/sdk/application/Rewards/RewardsApplicationModel.js +211 -211
  54. package/sdk/application/Share/ShareApplicationModel.d.ts +114 -114
  55. package/sdk/application/Share/ShareApplicationModel.js +121 -121
  56. package/sdk/application/Theme/ThemeApplicationClient.d.ts +1 -1
  57. package/sdk/application/Theme/ThemeApplicationClient.js +3 -7
  58. package/sdk/application/Theme/ThemeApplicationModel.d.ts +783 -969
  59. package/sdk/application/Theme/ThemeApplicationModel.js +571 -867
  60. package/sdk/application/Theme/ThemeApplicationValidator.d.ts +0 -10
  61. package/sdk/application/Theme/ThemeApplicationValidator.js +0 -4
  62. package/sdk/application/User/UserApplicationClient.d.ts +0 -33
  63. package/sdk/application/User/UserApplicationClient.js +0 -239
  64. package/sdk/application/User/UserApplicationModel.d.ts +753 -768
  65. package/sdk/application/User/UserApplicationModel.js +731 -755
  66. package/sdk/application/User/UserApplicationValidator.d.ts +1 -34
  67. package/sdk/application/User/UserApplicationValidator.js +0 -36
  68. package/sdk/common/Clickstream.d.ts +1 -0
  69. package/sdk/common/Clickstream.js +254 -0
  70. package/sdk/common/Utility.js +1 -4
  71. package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +72 -60
  72. package/sdk/partner/FileStorage/FileStoragePartnerModel.js +70 -58
  73. package/sdk/partner/PartnerClient.d.ts +0 -6
  74. package/sdk/partner/PartnerClient.js +0 -9
  75. package/sdk/partner/Theme/ThemePartnerClient.d.ts +0 -10
  76. package/sdk/partner/Theme/ThemePartnerClient.js +0 -80
  77. package/sdk/partner/Theme/ThemePartnerModel.d.ts +1178 -1153
  78. package/sdk/partner/Theme/ThemePartnerModel.js +830 -974
  79. package/sdk/partner/Theme/ThemePartnerValidator.d.ts +0 -1
  80. package/sdk/partner/Theme/ThemePartnerValidator.js +0 -9
  81. package/sdk/partner/index.d.ts +0 -3
  82. package/sdk/partner/index.js +0 -6
  83. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +2 -2
  84. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +123 -123
  85. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +109 -109
  86. package/sdk/platform/Billing/BillingPlatformClient.d.ts +1 -11
  87. package/sdk/platform/Billing/BillingPlatformClient.js +3 -110
  88. package/sdk/platform/Billing/BillingPlatformModel.d.ts +734 -800
  89. package/sdk/platform/Billing/BillingPlatformModel.js +732 -810
  90. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +4 -43
  91. package/sdk/platform/Billing/BillingPlatformValidator.js +2 -29
  92. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +11 -1
  93. package/sdk/platform/Cart/CartPlatformApplicationClient.js +81 -7
  94. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +13 -5
  95. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +12 -4
  96. package/sdk/platform/Cart/CartPlatformModel.d.ts +3223 -3328
  97. package/sdk/platform/Cart/CartPlatformModel.js +2875 -2946
  98. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +11 -15
  99. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +21 -52
  100. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +0 -27
  101. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +0 -11
  102. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +15 -27
  103. package/sdk/platform/Catalog/CatalogPlatformClient.js +93 -189
  104. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +617 -920
  105. package/sdk/platform/Catalog/CatalogPlatformModel.js +584 -919
  106. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +27 -41
  107. package/sdk/platform/Catalog/CatalogPlatformValidator.js +19 -31
  108. package/sdk/platform/Common/CommonPlatformModel.d.ts +255 -255
  109. package/sdk/platform/Common/CommonPlatformModel.js +187 -187
  110. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +37 -139
  111. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +52 -737
  112. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +3 -133
  113. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +1 -113
  114. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +1079 -1228
  115. package/sdk/platform/Communication/CommunicationPlatformModel.js +1090 -1262
  116. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +2 -8
  117. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +4 -32
  118. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +629 -658
  119. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +641 -675
  120. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +0 -14
  121. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +0 -6
  122. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +8 -8
  123. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +4 -4
  124. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +2992 -3231
  125. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +2092 -2303
  126. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +2 -2
  127. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +2 -2
  128. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +0 -391
  129. package/sdk/platform/Content/ContentPlatformApplicationClient.js +1074 -3656
  130. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +1 -351
  131. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +0 -410
  132. package/sdk/platform/Content/ContentPlatformModel.d.ts +972 -2071
  133. package/sdk/platform/Content/ContentPlatformModel.js +1039 -2355
  134. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +2 -2
  135. package/sdk/platform/Discount/DiscountPlatformClient.js +2 -2
  136. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +174 -259
  137. package/sdk/platform/Discount/DiscountPlatformModel.js +163 -257
  138. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +6 -16
  139. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +8 -117
  140. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +4 -55
  141. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +2 -39
  142. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +821 -892
  143. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +833 -901
  144. package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -33
  145. package/sdk/platform/Finance/FinancePlatformClient.js +0 -240
  146. package/sdk/platform/Finance/FinancePlatformModel.d.ts +910 -1056
  147. package/sdk/platform/Finance/FinancePlatformModel.js +884 -1070
  148. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +1 -38
  149. package/sdk/platform/Finance/FinancePlatformValidator.js +0 -38
  150. package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +942 -942
  151. package/sdk/platform/Inventory/InventoryPlatformModel.js +1003 -1003
  152. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +28 -38
  153. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +56 -137
  154. package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +29 -41
  155. package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +21 -33
  156. package/sdk/platform/Lead/LeadPlatformModel.d.ts +601 -610
  157. package/sdk/platform/Lead/LeadPlatformModel.js +457 -471
  158. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +1 -11
  159. package/sdk/platform/Order/OrderPlatformApplicationClient.js +1 -93
  160. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +1 -28
  161. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +0 -18
  162. package/sdk/platform/Order/OrderPlatformClient.d.ts +22 -143
  163. package/sdk/platform/Order/OrderPlatformClient.js +160 -1190
  164. package/sdk/platform/Order/OrderPlatformModel.d.ts +4451 -5275
  165. package/sdk/platform/Order/OrderPlatformModel.js +4039 -4994
  166. package/sdk/platform/Order/OrderPlatformValidator.d.ts +21 -257
  167. package/sdk/platform/Order/OrderPlatformValidator.js +15 -216
  168. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +22 -22
  169. package/sdk/platform/Partner/PartnerPlatformModel.js +22 -22
  170. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +13 -119
  171. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +40 -750
  172. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +7 -143
  173. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +6 -133
  174. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +1 -1
  175. package/sdk/platform/Payment/PaymentPlatformClient.js +1 -1
  176. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +2067 -2929
  177. package/sdk/platform/Payment/PaymentPlatformModel.js +1427 -2090
  178. package/sdk/platform/PlatformApplicationClient.d.ts +2 -2
  179. package/sdk/platform/PlatformApplicationClient.js +4 -4
  180. package/sdk/platform/PlatformClient.d.ts +2 -4
  181. package/sdk/platform/PlatformClient.js +4 -8
  182. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +204 -204
  183. package/sdk/platform/Rewards/RewardsPlatformModel.js +199 -199
  184. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +66 -142
  185. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +147 -645
  186. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +63 -131
  187. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +47 -126
  188. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +105 -217
  189. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +349 -1138
  190. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +990 -1589
  191. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +986 -1702
  192. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +133 -382
  193. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +102 -266
  194. package/sdk/platform/Share/SharePlatformModel.d.ts +147 -147
  195. package/sdk/platform/Share/SharePlatformModel.js +139 -139
  196. package/sdk/platform/Theme/ThemePlatformClient.d.ts +1 -11
  197. package/sdk/platform/Theme/ThemePlatformClient.js +3 -87
  198. package/sdk/platform/Theme/ThemePlatformModel.d.ts +765 -1133
  199. package/sdk/platform/Theme/ThemePlatformModel.js +561 -1009
  200. package/sdk/platform/Theme/ThemePlatformValidator.d.ts +4 -28
  201. package/sdk/platform/Theme/ThemePlatformValidator.js +2 -21
  202. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +1 -116
  203. package/sdk/platform/User/UserPlatformApplicationClient.js +86 -932
  204. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +7 -224
  205. package/sdk/platform/User/UserPlatformApplicationValidator.js +5 -173
  206. package/sdk/platform/User/UserPlatformModel.d.ts +428 -765
  207. package/sdk/platform/User/UserPlatformModel.js +428 -679
  208. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +37 -45
  209. package/sdk/platform/Webhook/WebhookPlatformClient.js +57 -61
  210. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +403 -448
  211. package/sdk/platform/Webhook/WebhookPlatformModel.js +309 -369
  212. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -7
  213. package/sdk/platform/Webhook/WebhookPlatformValidator.js +6 -6
  214. package/sdk/platform/index.d.ts +1 -1
  215. package/sdk/platform/index.js +2 -2
  216. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +237 -237
  217. package/sdk/public/Configuration/ConfigurationPublicModel.js +174 -174
  218. package/sdk/public/Inventory/InventoryPublicModel.d.ts +237 -237
  219. package/sdk/public/Inventory/InventoryPublicModel.js +257 -257
  220. package/sdk/public/Partner/PartnerPublicModel.d.ts +104 -104
  221. package/sdk/public/Partner/PartnerPublicModel.js +113 -113
  222. package/sdk/public/PublicClient.d.ts +0 -4
  223. package/sdk/public/PublicClient.js +0 -8
  224. package/sdk/public/Webhook/WebhookPublicClient.d.ts +0 -33
  225. package/sdk/public/Webhook/WebhookPublicClient.js +0 -242
  226. package/sdk/public/Webhook/WebhookPublicModel.d.ts +15 -161
  227. package/sdk/public/Webhook/WebhookPublicModel.js +13 -189
  228. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +1 -23
  229. package/sdk/public/Webhook/WebhookPublicValidator.js +0 -31
  230. package/sdk/public/index.d.ts +0 -2
  231. package/sdk/public/index.js +0 -4
  232. package/sdk/partner/Lead/LeadPartnerClient.d.ts +0 -125
  233. package/sdk/partner/Lead/LeadPartnerClient.js +0 -785
  234. package/sdk/partner/Lead/LeadPartnerModel.d.ts +0 -1127
  235. package/sdk/partner/Lead/LeadPartnerModel.js +0 -896
  236. package/sdk/partner/Lead/LeadPartnerValidator.d.ts +0 -12
  237. package/sdk/partner/Lead/LeadPartnerValidator.js +0 -67
  238. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +0 -155
  239. package/sdk/partner/Logistics/LogisticsPartnerClient.js +0 -1195
  240. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +0 -372
  241. package/sdk/partner/Logistics/LogisticsPartnerModel.js +0 -442
  242. package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +0 -16
  243. package/sdk/partner/Logistics/LogisticsPartnerValidator.js +0 -123
  244. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +0 -99
  245. package/sdk/partner/Webhook/WebhookPartnerClient.js +0 -753
  246. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +0 -566
  247. package/sdk/partner/Webhook/WebhookPartnerModel.js +0 -583
  248. package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +0 -12
  249. package/sdk/partner/Webhook/WebhookPartnerValidator.js +0 -74
  250. package/sdk/platform/Content/ContentPlatformClient.d.ts +0 -277
  251. package/sdk/platform/Content/ContentPlatformClient.js +0 -2011
  252. package/sdk/platform/Content/ContentPlatformValidator.d.ts +0 -247
  253. package/sdk/platform/Content/ContentPlatformValidator.js +0 -319
  254. package/sdk/public/Billing/BillingPublicClient.d.ts +0 -23
  255. package/sdk/public/Billing/BillingPublicClient.js +0 -116
  256. package/sdk/public/Billing/BillingPublicModel.d.ts +0 -92
  257. package/sdk/public/Billing/BillingPublicModel.js +0 -96
  258. package/sdk/public/Billing/BillingPublicValidator.d.ts +0 -18
  259. package/sdk/public/Billing/BillingPublicValidator.js +0 -19
  260. package/sdk/public/Content/ContentPublicClient.d.ts +0 -22
  261. package/sdk/public/Content/ContentPublicClient.js +0 -114
  262. package/sdk/public/Content/ContentPublicModel.d.ts +0 -53
  263. package/sdk/public/Content/ContentPublicModel.js +0 -60
  264. package/sdk/public/Content/ContentPublicValidator.d.ts +0 -18
  265. package/sdk/public/Content/ContentPublicValidator.js +0 -19
@@ -1,362 +1,334 @@
1
1
  export = WebhookPlatformModel;
2
2
  /**
3
- * @typedef Association
4
- * @property {string[]} [application_id]
5
- * @property {number} [company_id]
6
- * @property {string} [criteria]
7
- * @property {string} [extension_id]
3
+ * @typedef CancelResponse
4
+ * @property {number} [code] - The HTTP status code of the response (e.g., 200).
8
5
  */
9
6
  /**
10
- * @typedef AuthMeta
11
- * @property {string} [secret]
12
- * @property {string} [type]
7
+ * @typedef EventProcessRequest
8
+ * @property {string} [search_text]
9
+ * @property {string} [end_date]
10
+ * @property {string} [start_date]
11
+ * @property {number[]} [subscriber_ids]
12
+ * @property {Event[]} [event]
13
13
  */
14
14
  /**
15
- * @typedef CancelResponse
16
- * @property {string} [message] - The HTTP status code of the response (e.g., 200).
15
+ * @typedef Event
16
+ * @property {string} [event_name]
17
+ * @property {string} [event_type]
18
+ * @property {string} [event_category]
19
+ * @property {string} [version]
17
20
  */
18
21
  /**
19
- * @typedef CdnObject
20
- * @property {Url[]} [urls]
22
+ * @typedef ManualRetryFailedResponse
23
+ * @property {boolean} [success]
24
+ * @property {string} [message]
25
+ * @property {string} [request_id]
26
+ * @property {Object} [meta]
27
+ * @property {string} [stack_trace]
21
28
  */
22
29
  /**
23
- * @typedef DownloadReportResponse
24
- * @property {string} [file_name]
30
+ * @typedef FailedEventsCountSuccessResponse
31
+ * @property {EventCountItem[]} [items]
25
32
  */
26
33
  /**
27
- * @typedef Err
28
- * @property {string} [location]
29
- * @property {string} [msg]
30
- * @property {string} [param]
34
+ * @typedef EventCountItem
35
+ * @property {string} [status] - The status of the event (e.g., "FAILED").
36
+ * @property {number} [count] - The count of events with the specified status
31
37
  */
32
38
  /**
33
- * @typedef Error
34
- * @property {string} [error] - Error message describing the reason for the failure.
39
+ * @typedef RetryStatusResponse
40
+ * @property {number} [total_event] - The total number of events that require retry.
41
+ * @property {number} [success_count] - The count of successfully retried events.
42
+ * @property {number} [failure_count] - The count of failed retry attempts.
43
+ * @property {string} [status] - The overall status of the retry process (e.g.,
44
+ * "completed").
35
45
  */
36
46
  /**
37
- * @typedef Event
38
- * @property {string} [event_category]
39
- * @property {string} [event_name]
40
- * @property {string} [event_type]
41
- * @property {string} [version]
47
+ * @typedef EventSuccessResponse
48
+ * @property {boolean} [success]
49
+ * @property {string} [message]
42
50
  */
43
51
  /**
44
- * @typedef EventConfig
45
- * @property {string} [created_on]
46
- * @property {string} [description]
47
- * @property {string} [display_name]
48
- * @property {string} [event_category]
49
- * @property {string} [event_name]
50
- * @property {Object} [event_schema]
51
- * @property {string} [event_type]
52
- * @property {number} [id]
53
- * @property {string} [updated_on]
54
- * @property {string} [version]
52
+ * @typedef EventProcessedSuccessResponse
53
+ * @property {boolean} [success]
54
+ * @property {string} [message]
55
55
  */
56
56
  /**
57
- * @typedef EventConfigResponse
58
- * @property {EventConfig[]} [event_configs]
57
+ * @typedef Error
58
+ * @property {string} [error] - Error message describing the reason for the failure.
59
59
  */
60
60
  /**
61
61
  * @typedef EventProcessReportObject
62
- * @property {number} [attempt] - The attempt number of the event.
63
- * @property {Object} [data] - The data associated with the event.
64
62
  * @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
63
  * @property {number} [response_code] - The response code of the event.
70
64
  * @property {string} [response_message] - The response message of the event.
71
- * @property {number} [response_time] - The response time of the event.
65
+ * @property {string} [data] - The data associated with the event.
66
+ * @property {number} [attempt] - The attempt number of the event.
67
+ * @property {number} [last_attempted_on] - The timestamp of the last attempted event.
72
68
  * @property {string} [status] - The status of the event (e.g., "FAILED").
69
+ * @property {string} [name] - The name of the event.
73
70
  * @property {string} [webhook_url] - The webhook URL associated with the event.
71
+ * @property {number} [response_time] - The response time of the event.
74
72
  */
75
73
  /**
76
74
  * @typedef EventProcessReports
77
- * @property {Page} [page]
78
75
  * @property {EventProcessReportObject[]} [rows]
76
+ * @property {Page} [page]
79
77
  */
80
78
  /**
81
- * @typedef EventProcessRequest
82
- * @property {string} [end_date]
83
- * @property {Event[]} [event]
84
- * @property {string} [search_text]
85
- * @property {string} [start_date]
86
- * @property {string} [status]
87
- * @property {number[]} [subscriber_ids]
79
+ * @typedef PingWebhook
80
+ * @property {string} [webhook_url] - The URL of the subscriber's webhook to ping.
81
+ * @property {Object} [auth_meta] - Authentication metadata (if required by the
82
+ * subscriber).
83
+ * @property {Object} [custom_headers] - Custom headers to include in the ping request.
88
84
  */
89
85
  /**
90
- * @typedef HistoryAssociation
91
- * @property {number} [company_id]
92
- * @property {number[]} [subscriber_ids]
86
+ * @typedef PingWebhookResponse
87
+ * @property {string} [status] - The status of the ping (e.g., "SUCCESS").
88
+ * @property {string} [message] - An optional message related to the ping.
89
+ * @property {number} [code] - The HTTP status code of the ping response (e.g., 200).
93
90
  */
94
91
  /**
95
- * @typedef HistoryFilters
96
- * @property {string} [end_date] - The end date and time of the history report.
97
- * @property {string[]} [events]
98
- * @property {string} [search_text]
99
- * @property {string} [start_date] - The start date and time of the history report.
100
- * @property {string} [status] - The status of the history report (e.g., "FAILED").
101
- * @property {number[]} [subscribers] - An array of subscriber IDs associated
102
- * with the history report.
92
+ * @typedef ReportFiltersPayload
93
+ * @property {number[]} [subscriber_ids] - An array of subscriber IDs for
94
+ * filtering filters (optional).
103
95
  */
104
96
  /**
105
- * @typedef HistoryItems
106
- * @property {HistoryAssociation} [association]
107
- * @property {string} [created_on] - The date and time when the history report
108
- * was created.
109
- * @property {string} [filename] - The filename of the history report.
110
- * @property {HistoryFilters} [filters]
111
- * @property {number} [id] - The ID of the history report.
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]
97
+ * @typedef FilterValues
98
+ * @property {string} [text] - The display text for the filter value.
99
+ * @property {Object} [value] - The value associated with the filter value.
117
100
  */
118
101
  /**
119
- * @typedef HistoryPayload
120
- * @property {number} [page_no] - The page number of the history report.
121
- * @property {number} [page_size] - The number of records per page.
122
- * @property {string} [type] - The type of history report (e.g., "platform").
102
+ * @typedef FilterResponseObject
103
+ * @property {string} [filter_name] - The name of the filter.
104
+ * @property {FilterValues[]} [values]
123
105
  */
124
106
  /**
125
- * @typedef HistoryResponse
126
- * @property {HistoryItems[]} [items]
127
- * @property {Page} [page]
107
+ * @typedef EventConfigResponse
108
+ * @property {EventConfig[]} [event_configs]
128
109
  */
129
110
  /**
130
- * @typedef Item
131
- * @property {number} [count]
132
- * @property {string} [status]
111
+ * @typedef EventConfig
112
+ * @property {number} [id]
113
+ * @property {string} [event_name]
114
+ * @property {string} [event_type]
115
+ * @property {string} [event_category]
116
+ * @property {string} [version]
117
+ * @property {string} [display_name]
118
+ * @property {string} [description]
119
+ * @property {string} [created_on]
133
120
  */
134
121
  /**
135
- * @typedef Page
136
- * @property {number} [current]
137
- * @property {boolean} [has_next]
138
- * @property {boolean} [has_previous]
139
- * @property {number} [item_total]
140
- * @property {string} [next_id]
141
- * @property {number} [size]
142
- * @property {string} type
122
+ * @typedef ReportFilterResponse
123
+ * @property {FilterResponseObject[]} [items]
143
124
  */
144
125
  /**
145
- * @typedef PingWebhook
146
- * @property {Object} [auth_meta] - Authentication metadata (if required by the
147
- * subscriber).
148
- * @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.
126
+ * @typedef HistoryPayload
127
+ * @property {string} [type] - The type of history report (e.g., "platform").
128
+ * @property {number} [page_no] - The page number of the history report.
129
+ * @property {number} [page_size] - The number of records per page.
150
130
  */
151
131
  /**
152
- * @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
- * @property {string} [status] - The status of the ping (e.g., "SUCCESS").
132
+ * @typedef HistoryFilters
133
+ * @property {string} [status] - The status of the history report (e.g., "FAILED").
134
+ * @property {string} [end_date] - The end date and time of the history report.
135
+ * @property {string} [start_date] - The start date and time of the history report.
136
+ * @property {number[]} [subscribers] - An array of subscriber IDs associated
137
+ * with the history report.
156
138
  */
157
139
  /**
158
- * @typedef ReportFilterResponse
159
- * @property {string} [filter_name] - The name of the filter.
160
- * @property {Object[]} [values]
140
+ * @typedef Url
141
+ * @property {string} [url] - The URL of the uploaded report file.
142
+ * @property {string} [name] - The name of the uploaded report file.
161
143
  */
162
144
  /**
163
- * @typedef ReportFiltersPayload
164
- * @property {number[]} [subscriber_ids] - An array of subscriber IDs for
165
- * filtering filters (optional).
145
+ * @typedef CdnObject
146
+ * @property {Url[]} [urls]
166
147
  */
167
148
  /**
168
- * @typedef RetryCountResponse
169
- * @property {Item[]} [items]
149
+ * @typedef UploadServiceObject
150
+ * @property {CdnObject} [cdn]
170
151
  */
171
152
  /**
172
- * @typedef RetryEventRequest
173
- * @property {string} [end_date]
174
- * @property {Event[]} [event]
175
- * @property {string} [search_text]
176
- * @property {string} [start_date]
177
- * @property {string} [status]
178
- * @property {number[]} [subscriber_ids]
153
+ * @typedef HistoryResponseObject
154
+ * @property {number} [id] - The ID of the history report.
155
+ * @property {AssociationDetails} [association]
156
+ * @property {HistoryFilters} [filters]
157
+ * @property {string} [filename] - The filename of the history report.
158
+ * @property {string} [status] - The status of the history report (e.g., "COMPLETED").
159
+ * @property {UploadServiceObject} [upload_service_response]
160
+ * @property {string} [created_on] - The date and time when the history report
161
+ * was created.
162
+ * @property {string} [updated_on] - The date and time when the history report
163
+ * was last updated.
164
+ * @property {string} [message] - A message related to the history report.
179
165
  */
180
166
  /**
181
- * @typedef RetryFailureResponse
182
- * @property {Err[]} [err]
167
+ * @typedef HistoryResponse
168
+ * @property {HistoryResponseObject[]} [items]
183
169
  */
184
170
  /**
185
- * @typedef RetryStatusResponse
186
- * @property {number} [failure_count] - The count of failed retry attempts.
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.
171
+ * @typedef Page
172
+ * @property {number} [item_total]
173
+ * @property {string} [next_id]
174
+ * @property {boolean} [has_previous]
175
+ * @property {boolean} [has_next]
176
+ * @property {number} [current]
177
+ * @property {string} type
178
+ * @property {number} [size]
191
179
  */
192
180
  /**
193
- * @typedef RetrySuccessResponse
194
- * @property {string} [message]
195
- * @property {boolean} [success]
181
+ * @typedef AssociationDetails
182
+ * @property {number} [company_id]
196
183
  */
197
184
  /**
198
- * @typedef SubscriberConfig
185
+ * @typedef SubscriberResponse
186
+ * @property {number} [id]
187
+ * @property {string} [name]
188
+ * @property {string} [webhook_url]
199
189
  * @property {Association} [association]
200
- * @property {AuthMeta} [auth_meta]
201
190
  * @property {Object} [custom_headers]
202
191
  * @property {string} [email_id]
203
- * @property {number[]} [event_id]
204
- * @property {number} [id]
205
- * @property {string} [name]
206
192
  * @property {SubscriberStatus} [status]
207
- * @property {string} [webhook_url]
193
+ * @property {AuthMeta} [auth_meta]
194
+ * @property {string} [created_on]
195
+ * @property {string} [updated_on]
196
+ * @property {EventConfig[]} [event_configs]
208
197
  */
209
198
  /**
210
- * @typedef SubscriberConfigList
211
- * @property {SubscriberResponse[]} [items]
212
- * @property {Page} [page]
199
+ * @typedef AuthMeta
200
+ * @property {string} [type]
201
+ * @property {string} [secret]
213
202
  */
214
203
  /**
215
- * @typedef SubscriberConfigResponse
216
- * @property {Association} [association]
217
- * @property {AuthMeta} [auth_meta]
218
- * @property {string} [created_on]
219
- * @property {Object} [custom_headers]
220
- * @property {string} [email_id]
221
- * @property {number[]} [event_id]
204
+ * @typedef Association
205
+ * @property {number} [company_id]
206
+ * @property {string[]} [application_id]
207
+ * @property {string} [extension_id]
208
+ * @property {string} [criteria]
209
+ */
210
+ /**
211
+ * @typedef SubscriberConfig
222
212
  * @property {number} [id]
223
- * @property {string} [modified_by]
224
213
  * @property {string} [name]
225
- * @property {SubscriberStatus} [status]
226
- * @property {string} [type]
227
- * @property {string} [updated_on]
228
214
  * @property {string} [webhook_url]
229
- */
230
- /**
231
- * @typedef SubscriberResponse
232
215
  * @property {Association} [association]
233
- * @property {AuthMeta} [auth_meta]
234
- * @property {string} [created_on]
235
216
  * @property {Object} [custom_headers]
236
- * @property {string} [email_id]
237
- * @property {EventConfig[]} [event_configs]
238
- * @property {number} [id]
239
- * @property {string} [modified_by]
240
- * @property {string} [name]
241
217
  * @property {SubscriberStatus} [status]
242
- * @property {string} [type]
243
- * @property {string} [updated_on]
244
- * @property {string} [webhook_url]
218
+ * @property {string} [email_id]
219
+ * @property {AuthMeta} [auth_meta]
220
+ * @property {number[]} [event_id]
245
221
  */
246
222
  /**
247
- * @typedef UploadServiceObject
248
- * @property {CdnObject} [cdn]
249
- */
250
- /**
251
- * @typedef Url
252
- * @property {string} [name] - The name of the uploaded report file.
253
- * @property {string} [url] - The URL of the uploaded report file.
223
+ * @typedef SubscriberConfigList
224
+ * @property {SubscriberResponse[]} [items]
225
+ * @property {Page} [page]
254
226
  */
255
227
  /** @typedef {"active" | "inactive" | "blocked"} SubscriberStatus */
256
228
  declare class WebhookPlatformModel {
257
229
  }
258
230
  declare namespace WebhookPlatformModel {
259
- export { Association, AuthMeta, CancelResponse, CdnObject, DownloadReportResponse, Err, Error, Event, EventConfig, EventConfigResponse, EventProcessReportObject, EventProcessReports, EventProcessRequest, HistoryAssociation, HistoryFilters, HistoryItems, HistoryPayload, HistoryResponse, Item, Page, PingWebhook, PingWebhookResponse, ReportFilterResponse, ReportFiltersPayload, RetryCountResponse, RetryEventRequest, RetryFailureResponse, RetryStatusResponse, RetrySuccessResponse, SubscriberConfig, SubscriberConfigList, SubscriberConfigResponse, SubscriberResponse, UploadServiceObject, Url, SubscriberStatus };
231
+ export { CancelResponse, EventProcessRequest, Event, ManualRetryFailedResponse, FailedEventsCountSuccessResponse, EventCountItem, RetryStatusResponse, EventSuccessResponse, EventProcessedSuccessResponse, Error, EventProcessReportObject, EventProcessReports, PingWebhook, PingWebhookResponse, ReportFiltersPayload, FilterValues, FilterResponseObject, EventConfigResponse, EventConfig, ReportFilterResponse, HistoryPayload, HistoryFilters, Url, CdnObject, UploadServiceObject, HistoryResponseObject, HistoryResponse, Page, AssociationDetails, SubscriberResponse, AuthMeta, Association, SubscriberConfig, SubscriberConfigList, SubscriberStatus };
260
232
  }
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
233
  /** @returns {CancelResponse} */
276
234
  declare function CancelResponse(): CancelResponse;
277
235
  type CancelResponse = {
278
236
  /**
279
237
  * - The HTTP status code of the response (e.g., 200).
280
238
  */
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;
239
+ code?: number;
299
240
  };
300
- /** @returns {Error} */
301
- declare function Error(): Error;
302
- type Error = {
303
- /**
304
- * - Error message describing the reason for the failure.
305
- */
306
- error?: string;
241
+ /** @returns {EventProcessRequest} */
242
+ declare function EventProcessRequest(): EventProcessRequest;
243
+ type EventProcessRequest = {
244
+ search_text?: string;
245
+ end_date?: string;
246
+ start_date?: string;
247
+ subscriber_ids?: number[];
248
+ event?: Event[];
307
249
  };
308
250
  /** @returns {Event} */
309
251
  declare function Event(): Event;
310
252
  type Event = {
311
- event_category?: string;
312
253
  event_name?: string;
313
254
  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
255
  event_category?: string;
323
- event_name?: string;
324
- event_schema?: any;
325
- event_type?: string;
326
- id?: number;
327
- updated_on?: string;
328
256
  version?: string;
329
257
  };
330
- /** @returns {EventConfigResponse} */
331
- declare function EventConfigResponse(): EventConfigResponse;
332
- type EventConfigResponse = {
333
- event_configs?: EventConfig[];
258
+ /** @returns {ManualRetryFailedResponse} */
259
+ declare function ManualRetryFailedResponse(): ManualRetryFailedResponse;
260
+ type ManualRetryFailedResponse = {
261
+ success?: boolean;
262
+ message?: string;
263
+ request_id?: string;
264
+ meta?: any;
265
+ stack_trace?: string;
334
266
  };
335
- /** @returns {EventProcessReportObject} */
336
- declare function EventProcessReportObject(): EventProcessReportObject;
337
- type EventProcessReportObject = {
267
+ /** @returns {FailedEventsCountSuccessResponse} */
268
+ declare function FailedEventsCountSuccessResponse(): FailedEventsCountSuccessResponse;
269
+ type FailedEventsCountSuccessResponse = {
270
+ items?: EventCountItem[];
271
+ };
272
+ /** @returns {EventCountItem} */
273
+ declare function EventCountItem(): EventCountItem;
274
+ type EventCountItem = {
338
275
  /**
339
- * - The attempt number of the event.
276
+ * - The status of the event (e.g., "FAILED").
340
277
  */
341
- attempt?: number;
278
+ status?: string;
342
279
  /**
343
- * - The data associated with the event.
280
+ * - The count of events with the specified status
344
281
  */
345
- data?: any;
282
+ count?: number;
283
+ };
284
+ /** @returns {RetryStatusResponse} */
285
+ declare function RetryStatusResponse(): RetryStatusResponse;
286
+ type RetryStatusResponse = {
346
287
  /**
347
- * - The name of the processed event.
288
+ * - The total number of events that require retry.
348
289
  */
349
- event_name?: string;
350
- event_trace_id?: string;
290
+ total_event?: number;
351
291
  /**
352
- * - The timestamp of the last attempted event.
292
+ * - The count of successfully retried events.
353
293
  */
354
- last_attempted_on?: number;
355
- message_id?: string;
294
+ success_count?: number;
356
295
  /**
357
- * - The name of the event.
296
+ * - The count of failed retry attempts.
358
297
  */
359
- name?: string;
298
+ failure_count?: number;
299
+ /**
300
+ * - The overall status of the retry process (e.g.,
301
+ * "completed").
302
+ */
303
+ status?: string;
304
+ };
305
+ /** @returns {EventSuccessResponse} */
306
+ declare function EventSuccessResponse(): EventSuccessResponse;
307
+ type EventSuccessResponse = {
308
+ success?: boolean;
309
+ message?: string;
310
+ };
311
+ /** @returns {EventProcessedSuccessResponse} */
312
+ declare function EventProcessedSuccessResponse(): EventProcessedSuccessResponse;
313
+ type EventProcessedSuccessResponse = {
314
+ success?: boolean;
315
+ message?: string;
316
+ };
317
+ /** @returns {Error} */
318
+ declare function Error(): Error;
319
+ type Error = {
320
+ /**
321
+ * - Error message describing the reason for the failure.
322
+ */
323
+ error?: string;
324
+ };
325
+ /** @returns {EventProcessReportObject} */
326
+ declare function EventProcessReportObject(): EventProcessReportObject;
327
+ type EventProcessReportObject = {
328
+ /**
329
+ * - The name of the processed event.
330
+ */
331
+ event_name?: string;
360
332
  /**
361
333
  * - The response code of the event.
362
334
  */
@@ -366,99 +338,132 @@ type EventProcessReportObject = {
366
338
  */
367
339
  response_message?: string;
368
340
  /**
369
- * - The response time of the event.
341
+ * - The data associated with the event.
370
342
  */
371
- response_time?: number;
343
+ data?: string;
344
+ /**
345
+ * - The attempt number of the event.
346
+ */
347
+ attempt?: number;
348
+ /**
349
+ * - The timestamp of the last attempted event.
350
+ */
351
+ last_attempted_on?: number;
372
352
  /**
373
353
  * - The status of the event (e.g., "FAILED").
374
354
  */
375
355
  status?: string;
356
+ /**
357
+ * - The name of the event.
358
+ */
359
+ name?: string;
376
360
  /**
377
361
  * - The webhook URL associated with the event.
378
362
  */
379
363
  webhook_url?: string;
364
+ /**
365
+ * - The response time of the event.
366
+ */
367
+ response_time?: number;
380
368
  };
381
369
  /** @returns {EventProcessReports} */
382
370
  declare function EventProcessReports(): EventProcessReports;
383
371
  type EventProcessReports = {
384
- page?: Page;
385
372
  rows?: EventProcessReportObject[];
373
+ page?: Page;
386
374
  };
387
- /** @returns {EventProcessRequest} */
388
- declare function EventProcessRequest(): EventProcessRequest;
389
- type EventProcessRequest = {
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 = {
375
+ /** @returns {PingWebhook} */
376
+ declare function PingWebhook(): PingWebhook;
377
+ type PingWebhook = {
406
378
  /**
407
- * - The end date and time of the history report.
379
+ * - The URL of the subscriber's webhook to ping.
408
380
  */
409
- end_date?: string;
410
- events?: string[];
411
- search_text?: string;
381
+ webhook_url?: string;
412
382
  /**
413
- * - The start date and time of the history report.
383
+ * - Authentication metadata (if required by the
384
+ * subscriber).
414
385
  */
415
- start_date?: string;
386
+ auth_meta?: any;
416
387
  /**
417
- * - The status of the history report (e.g., "FAILED").
388
+ * - Custom headers to include in the ping request.
418
389
  */
419
- status?: string;
390
+ custom_headers?: any;
391
+ };
392
+ /** @returns {PingWebhookResponse} */
393
+ declare function PingWebhookResponse(): PingWebhookResponse;
394
+ type PingWebhookResponse = {
420
395
  /**
421
- * - An array of subscriber IDs associated
422
- * with the history report.
396
+ * - The status of the ping (e.g., "SUCCESS").
423
397
  */
424
- subscribers?: number[];
425
- };
426
- /** @returns {HistoryItems} */
427
- declare function HistoryItems(): HistoryItems;
428
- type HistoryItems = {
429
- association?: HistoryAssociation;
398
+ status?: string;
430
399
  /**
431
- * - The date and time when the history report
432
- * was created.
400
+ * - An optional message related to the ping.
433
401
  */
434
- created_on?: string;
402
+ message?: string;
435
403
  /**
436
- * - The filename of the history report.
404
+ * - The HTTP status code of the ping response (e.g., 200).
437
405
  */
438
- filename?: string;
439
- filters?: HistoryFilters;
406
+ code?: number;
407
+ };
408
+ /** @returns {ReportFiltersPayload} */
409
+ declare function ReportFiltersPayload(): ReportFiltersPayload;
410
+ type ReportFiltersPayload = {
440
411
  /**
441
- * - The ID of the history report.
412
+ * - An array of subscriber IDs for
413
+ * filtering filters (optional).
442
414
  */
443
- id?: number;
415
+ subscriber_ids?: number[];
416
+ };
417
+ /** @returns {FilterValues} */
418
+ declare function FilterValues(): FilterValues;
419
+ type FilterValues = {
444
420
  /**
445
- * - A message related to the history report.
421
+ * - The display text for the filter value.
446
422
  */
447
- message?: string;
423
+ text?: string;
448
424
  /**
449
- * - The status of the history report (e.g., "COMPLETED").
425
+ * - The value associated with the filter value.
450
426
  */
451
- status?: string;
427
+ value?: any;
428
+ };
429
+ /** @returns {FilterResponseObject} */
430
+ declare function FilterResponseObject(): FilterResponseObject;
431
+ type FilterResponseObject = {
452
432
  /**
453
- * - The date and time when the history report
454
- * was last updated.
433
+ * - The name of the filter.
455
434
  */
456
- updated_on?: string;
457
- upload_service_response?: UploadServiceObject;
435
+ filter_name?: string;
436
+ values?: FilterValues[];
437
+ };
438
+ /** @returns {EventConfigResponse} */
439
+ declare function EventConfigResponse(): EventConfigResponse;
440
+ type EventConfigResponse = {
441
+ event_configs?: EventConfig[];
442
+ };
443
+ /** @returns {EventConfig} */
444
+ declare function EventConfig(): EventConfig;
445
+ type EventConfig = {
446
+ id?: number;
447
+ event_name?: string;
448
+ event_type?: string;
449
+ event_category?: string;
450
+ version?: string;
451
+ display_name?: string;
452
+ description?: string;
453
+ created_on?: string;
454
+ };
455
+ /** @returns {ReportFilterResponse} */
456
+ declare function ReportFilterResponse(): ReportFilterResponse;
457
+ type ReportFilterResponse = {
458
+ items?: FilterResponseObject[];
458
459
  };
459
460
  /** @returns {HistoryPayload} */
460
461
  declare function HistoryPayload(): HistoryPayload;
461
462
  type HistoryPayload = {
463
+ /**
464
+ * - The type of history report (e.g., "platform").
465
+ */
466
+ type?: string;
462
467
  /**
463
468
  * - The page number of the history report.
464
469
  */
@@ -467,201 +472,151 @@ type HistoryPayload = {
467
472
  * - The number of records per page.
468
473
  */
469
474
  page_size?: number;
475
+ };
476
+ /** @returns {HistoryFilters} */
477
+ declare function HistoryFilters(): HistoryFilters;
478
+ type HistoryFilters = {
470
479
  /**
471
- * - The type of history report (e.g., "platform").
480
+ * - The status of the history report (e.g., "FAILED").
472
481
  */
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
482
  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
483
  /**
502
- * - Authentication metadata (if required by the
503
- * subscriber).
484
+ * - The end date and time of the history report.
504
485
  */
505
- auth_meta?: any;
486
+ end_date?: string;
506
487
  /**
507
- * - Custom headers to include in the ping request.
488
+ * - The start date and time of the history report.
508
489
  */
509
- custom_headers?: any;
490
+ start_date?: string;
510
491
  /**
511
- * - The URL of the subscriber's webhook to ping.
492
+ * - An array of subscriber IDs associated
493
+ * with the history report.
512
494
  */
513
- webhook_url?: string;
495
+ subscribers?: number[];
514
496
  };
515
- /** @returns {PingWebhookResponse} */
516
- declare function PingWebhookResponse(): PingWebhookResponse;
517
- type PingWebhookResponse = {
518
- /**
519
- * - The HTTP status code of the ping response (e.g., 200).
520
- */
521
- code?: number;
497
+ /** @returns {Url} */
498
+ declare function Url(): Url;
499
+ type Url = {
522
500
  /**
523
- * - An optional message related to the ping.
501
+ * - The URL of the uploaded report file.
524
502
  */
525
- message?: string;
503
+ url?: string;
526
504
  /**
527
- * - The status of the ping (e.g., "SUCCESS").
505
+ * - The name of the uploaded report file.
528
506
  */
529
- status?: string;
507
+ name?: string;
530
508
  };
531
- /** @returns {ReportFilterResponse} */
532
- declare function ReportFilterResponse(): ReportFilterResponse;
533
- type ReportFilterResponse = {
534
- /**
535
- * - The name of the filter.
536
- */
537
- filter_name?: string;
538
- values?: any[];
509
+ /** @returns {CdnObject} */
510
+ declare function CdnObject(): CdnObject;
511
+ type CdnObject = {
512
+ urls?: Url[];
539
513
  };
540
- /** @returns {ReportFiltersPayload} */
541
- declare function ReportFiltersPayload(): ReportFiltersPayload;
542
- type ReportFiltersPayload = {
514
+ /** @returns {UploadServiceObject} */
515
+ declare function UploadServiceObject(): UploadServiceObject;
516
+ type UploadServiceObject = {
517
+ cdn?: CdnObject;
518
+ };
519
+ /** @returns {HistoryResponseObject} */
520
+ declare function HistoryResponseObject(): HistoryResponseObject;
521
+ type HistoryResponseObject = {
543
522
  /**
544
- * - An array of subscriber IDs for
545
- * filtering filters (optional).
523
+ * - The ID of the history report.
546
524
  */
547
- subscriber_ids?: number[];
548
- };
549
- /** @returns {RetryCountResponse} */
550
- declare function RetryCountResponse(): RetryCountResponse;
551
- type RetryCountResponse = {
552
- items?: Item[];
553
- };
554
- /** @returns {RetryEventRequest} */
555
- declare function RetryEventRequest(): RetryEventRequest;
556
- type RetryEventRequest = {
557
- end_date?: string;
558
- event?: Event[];
559
- search_text?: string;
560
- start_date?: string;
561
- status?: string;
562
- subscriber_ids?: number[];
563
- };
564
- /** @returns {RetryFailureResponse} */
565
- declare function RetryFailureResponse(): RetryFailureResponse;
566
- type RetryFailureResponse = {
567
- err?: Err[];
568
- };
569
- /** @returns {RetryStatusResponse} */
570
- declare function RetryStatusResponse(): RetryStatusResponse;
571
- type RetryStatusResponse = {
525
+ id?: number;
526
+ association?: AssociationDetails;
527
+ filters?: HistoryFilters;
572
528
  /**
573
- * - The count of failed retry attempts.
529
+ * - The filename of the history report.
574
530
  */
575
- failure_count?: number;
531
+ filename?: string;
576
532
  /**
577
- * - The overall status of the retry process (e.g.,
578
- * "completed").
533
+ * - The status of the history report (e.g., "COMPLETED").
579
534
  */
580
535
  status?: string;
536
+ upload_service_response?: UploadServiceObject;
581
537
  /**
582
- * - The count of successfully retried events.
538
+ * - The date and time when the history report
539
+ * was created.
583
540
  */
584
- success_count?: number;
541
+ created_on?: string;
585
542
  /**
586
- * - The total number of events that require retry.
543
+ * - The date and time when the history report
544
+ * was last updated.
545
+ */
546
+ updated_on?: string;
547
+ /**
548
+ * - A message related to the history report.
587
549
  */
588
- total_event?: number;
589
- };
590
- /** @returns {RetrySuccessResponse} */
591
- declare function RetrySuccessResponse(): RetrySuccessResponse;
592
- type RetrySuccessResponse = {
593
550
  message?: string;
594
- success?: boolean;
595
551
  };
596
- /** @returns {SubscriberConfig} */
597
- declare function SubscriberConfig(): SubscriberConfig;
598
- type SubscriberConfig = {
599
- association?: Association;
600
- auth_meta?: AuthMeta;
601
- custom_headers?: any;
602
- email_id?: string;
603
- event_id?: number[];
604
- id?: number;
605
- name?: string;
606
- status?: SubscriberStatus;
607
- webhook_url?: string;
552
+ /** @returns {HistoryResponse} */
553
+ declare function HistoryResponse(): HistoryResponse;
554
+ type HistoryResponse = {
555
+ items?: HistoryResponseObject[];
608
556
  };
609
- /** @returns {SubscriberConfigList} */
610
- declare function SubscriberConfigList(): SubscriberConfigList;
611
- type SubscriberConfigList = {
612
- items?: SubscriberResponse[];
613
- page?: Page;
557
+ /** @returns {Page} */
558
+ declare function Page(): Page;
559
+ type Page = {
560
+ item_total?: number;
561
+ next_id?: string;
562
+ has_previous?: boolean;
563
+ has_next?: boolean;
564
+ current?: number;
565
+ type: string;
566
+ size?: number;
614
567
  };
615
- /** @returns {SubscriberConfigResponse} */
616
- declare function SubscriberConfigResponse(): SubscriberConfigResponse;
617
- 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
- id?: number;
625
- modified_by?: string;
626
- name?: string;
627
- status?: SubscriberStatus;
628
- type?: string;
629
- updated_on?: string;
630
- webhook_url?: string;
568
+ /** @returns {AssociationDetails} */
569
+ declare function AssociationDetails(): AssociationDetails;
570
+ type AssociationDetails = {
571
+ company_id?: number;
631
572
  };
632
573
  /** @returns {SubscriberResponse} */
633
574
  declare function SubscriberResponse(): SubscriberResponse;
634
575
  type SubscriberResponse = {
576
+ id?: number;
577
+ name?: string;
578
+ webhook_url?: string;
635
579
  association?: Association;
636
- auth_meta?: AuthMeta;
637
- created_on?: string;
638
580
  custom_headers?: any;
639
581
  email_id?: string;
640
- event_configs?: EventConfig[];
641
- id?: number;
642
- modified_by?: string;
643
- name?: string;
644
582
  status?: SubscriberStatus;
645
- type?: string;
583
+ auth_meta?: AuthMeta;
584
+ created_on?: string;
646
585
  updated_on?: string;
647
- webhook_url?: string;
586
+ event_configs?: EventConfig[];
648
587
  };
649
- /** @returns {UploadServiceObject} */
650
- declare function UploadServiceObject(): UploadServiceObject;
651
- type UploadServiceObject = {
652
- cdn?: CdnObject;
588
+ /** @returns {AuthMeta} */
589
+ declare function AuthMeta(): AuthMeta;
590
+ type AuthMeta = {
591
+ type?: string;
592
+ secret?: string;
653
593
  };
654
- /** @returns {Url} */
655
- declare function Url(): Url;
656
- type Url = {
657
- /**
658
- * - The name of the uploaded report file.
659
- */
594
+ /** @returns {Association} */
595
+ declare function Association(): Association;
596
+ type Association = {
597
+ company_id?: number;
598
+ application_id?: string[];
599
+ extension_id?: string;
600
+ criteria?: string;
601
+ };
602
+ /** @returns {SubscriberConfig} */
603
+ declare function SubscriberConfig(): SubscriberConfig;
604
+ type SubscriberConfig = {
605
+ id?: number;
660
606
  name?: string;
661
- /**
662
- * - The URL of the uploaded report file.
663
- */
664
- url?: string;
607
+ webhook_url?: string;
608
+ association?: Association;
609
+ custom_headers?: any;
610
+ status?: SubscriberStatus;
611
+ email_id?: string;
612
+ auth_meta?: AuthMeta;
613
+ event_id?: number[];
614
+ };
615
+ /** @returns {SubscriberConfigList} */
616
+ declare function SubscriberConfigList(): SubscriberConfigList;
617
+ type SubscriberConfigList = {
618
+ items?: SubscriberResponse[];
619
+ page?: Page;
665
620
  };
666
621
  /**
667
622
  * Enum: SubscriberStatus Used By: Webhook