@gofynd/fdk-client-javascript 1.6.3 → 3.0.0-beta.1

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