@agentuity/core 1.0.40 → 1.0.42

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 (254) hide show
  1. package/dist/services/api-reference.d.ts +68 -0
  2. package/dist/services/api-reference.d.ts.map +1 -0
  3. package/dist/services/api-reference.js +91 -0
  4. package/dist/services/api-reference.js.map +1 -0
  5. package/dist/services/apikey/api-reference.d.ts +4 -0
  6. package/dist/services/apikey/api-reference.d.ts.map +1 -0
  7. package/dist/services/apikey/api-reference.js +96 -0
  8. package/dist/services/apikey/api-reference.js.map +1 -0
  9. package/dist/services/db/api-reference.d.ts +4 -0
  10. package/dist/services/db/api-reference.d.ts.map +1 -0
  11. package/dist/services/db/api-reference.js +149 -0
  12. package/dist/services/db/api-reference.js.map +1 -0
  13. package/dist/services/db/types.d.ts +7 -0
  14. package/dist/services/db/types.d.ts.map +1 -0
  15. package/dist/services/db/types.js +9 -0
  16. package/dist/services/db/types.js.map +1 -0
  17. package/dist/services/email/api-reference.d.ts +4 -0
  18. package/dist/services/email/api-reference.d.ts.map +1 -0
  19. package/dist/services/email/api-reference.js +342 -0
  20. package/dist/services/email/api-reference.js.map +1 -0
  21. package/dist/services/email/service.d.ts.map +1 -1
  22. package/dist/services/email/service.js +1 -2
  23. package/dist/services/email/service.js.map +1 -1
  24. package/dist/services/email/types.d.ts +13 -0
  25. package/dist/services/email/types.d.ts.map +1 -0
  26. package/dist/services/email/types.js +11 -0
  27. package/dist/services/email/types.js.map +1 -0
  28. package/dist/services/eval/api-reference.d.ts +4 -0
  29. package/dist/services/eval/api-reference.d.ts.map +1 -0
  30. package/dist/services/eval/api-reference.js +121 -0
  31. package/dist/services/eval/api-reference.js.map +1 -0
  32. package/dist/services/index.d.ts +2 -0
  33. package/dist/services/index.d.ts.map +1 -1
  34. package/dist/services/index.js +2 -0
  35. package/dist/services/index.js.map +1 -1
  36. package/dist/services/keyvalue/api-reference.d.ts +4 -0
  37. package/dist/services/keyvalue/api-reference.d.ts.map +1 -0
  38. package/dist/services/keyvalue/api-reference.js +270 -0
  39. package/dist/services/keyvalue/api-reference.js.map +1 -0
  40. package/dist/services/keyvalue/types.d.ts +18 -0
  41. package/dist/services/keyvalue/types.d.ts.map +1 -0
  42. package/dist/services/keyvalue/types.js +19 -0
  43. package/dist/services/keyvalue/types.js.map +1 -0
  44. package/dist/services/machine/api-reference.d.ts +4 -0
  45. package/dist/services/machine/api-reference.d.ts.map +1 -0
  46. package/dist/services/machine/api-reference.js +152 -0
  47. package/dist/services/machine/api-reference.js.map +1 -0
  48. package/dist/services/machine/types.d.ts +18 -0
  49. package/dist/services/machine/types.d.ts.map +1 -0
  50. package/dist/services/machine/types.js +15 -0
  51. package/dist/services/machine/types.js.map +1 -0
  52. package/dist/services/monitoring/index.d.ts +3 -0
  53. package/dist/services/monitoring/index.d.ts.map +1 -0
  54. package/dist/services/monitoring/index.js +3 -0
  55. package/dist/services/monitoring/index.js.map +1 -0
  56. package/dist/services/monitoring/service.d.ts +55 -0
  57. package/dist/services/monitoring/service.d.ts.map +1 -0
  58. package/dist/services/monitoring/service.js +503 -0
  59. package/dist/services/monitoring/service.js.map +1 -0
  60. package/dist/services/monitoring/types.d.ts +173 -0
  61. package/dist/services/monitoring/types.d.ts.map +1 -0
  62. package/dist/services/monitoring/types.js +2 -0
  63. package/dist/services/monitoring/types.js.map +1 -0
  64. package/dist/services/oauth/activity.d.ts +5 -0
  65. package/dist/services/oauth/activity.d.ts.map +1 -0
  66. package/dist/services/oauth/activity.js +17 -0
  67. package/dist/services/oauth/activity.js.map +1 -0
  68. package/dist/services/oauth/api-reference.d.ts +4 -0
  69. package/dist/services/oauth/api-reference.d.ts.map +1 -0
  70. package/dist/services/oauth/api-reference.js +344 -0
  71. package/dist/services/oauth/api-reference.js.map +1 -0
  72. package/dist/services/oauth/clients.d.ts +18 -0
  73. package/dist/services/oauth/clients.d.ts.map +1 -0
  74. package/dist/services/oauth/clients.js +66 -0
  75. package/dist/services/oauth/clients.js.map +1 -0
  76. package/dist/services/oauth/consent.d.ts +7 -0
  77. package/dist/services/oauth/consent.d.ts.map +1 -0
  78. package/dist/services/oauth/consent.js +17 -0
  79. package/dist/services/oauth/consent.js.map +1 -0
  80. package/dist/services/oauth/index.d.ts +9 -0
  81. package/dist/services/oauth/index.d.ts.map +1 -0
  82. package/dist/services/oauth/index.js +9 -0
  83. package/dist/services/oauth/index.js.map +1 -0
  84. package/dist/services/oauth/keys.d.ts +5 -0
  85. package/dist/services/oauth/keys.d.ts.map +1 -0
  86. package/dist/services/oauth/keys.js +10 -0
  87. package/dist/services/oauth/keys.js.map +1 -0
  88. package/dist/services/oauth/members.d.ts +4 -0
  89. package/dist/services/oauth/members.d.ts.map +1 -0
  90. package/dist/services/oauth/members.js +10 -0
  91. package/dist/services/oauth/members.js.map +1 -0
  92. package/dist/services/oauth/scopes.d.ts +4 -0
  93. package/dist/services/oauth/scopes.d.ts.map +1 -0
  94. package/dist/services/oauth/scopes.js +10 -0
  95. package/dist/services/oauth/scopes.js.map +1 -0
  96. package/dist/services/oauth/types.d.ts +587 -0
  97. package/dist/services/oauth/types.d.ts.map +1 -0
  98. package/dist/services/oauth/types.js +160 -0
  99. package/dist/services/oauth/types.js.map +1 -0
  100. package/dist/services/oauth/util.d.ts +23 -0
  101. package/dist/services/oauth/util.d.ts.map +1 -0
  102. package/dist/services/oauth/util.js +3 -0
  103. package/dist/services/oauth/util.js.map +1 -0
  104. package/dist/services/org/api-reference.d.ts +4 -0
  105. package/dist/services/org/api-reference.d.ts.map +1 -0
  106. package/dist/services/org/api-reference.js +145 -0
  107. package/dist/services/org/api-reference.js.map +1 -0
  108. package/dist/services/org/types.d.ts +8 -0
  109. package/dist/services/org/types.d.ts.map +1 -0
  110. package/dist/services/org/types.js +7 -0
  111. package/dist/services/org/types.js.map +1 -0
  112. package/dist/services/project/api-reference.d.ts +4 -0
  113. package/dist/services/project/api-reference.d.ts.map +1 -0
  114. package/dist/services/project/api-reference.js +618 -0
  115. package/dist/services/project/api-reference.js.map +1 -0
  116. package/dist/services/project/types.d.ts +29 -0
  117. package/dist/services/project/types.d.ts.map +1 -0
  118. package/dist/services/project/types.js +40 -0
  119. package/dist/services/project/types.js.map +1 -0
  120. package/dist/services/queue/api-reference.d.ts +4 -0
  121. package/dist/services/queue/api-reference.d.ts.map +1 -0
  122. package/dist/services/queue/api-reference.js +713 -0
  123. package/dist/services/queue/api-reference.js.map +1 -0
  124. package/dist/services/queue/types.d.ts +281 -0
  125. package/dist/services/queue/types.d.ts.map +1 -1
  126. package/dist/services/queue/types.js +81 -0
  127. package/dist/services/queue/types.js.map +1 -1
  128. package/dist/services/region/api-reference.d.ts +4 -0
  129. package/dist/services/region/api-reference.d.ts.map +1 -0
  130. package/dist/services/region/api-reference.js +98 -0
  131. package/dist/services/region/api-reference.js.map +1 -0
  132. package/dist/services/region/types.d.ts +18 -0
  133. package/dist/services/region/types.d.ts.map +1 -0
  134. package/dist/services/region/types.js +18 -0
  135. package/dist/services/region/types.js.map +1 -0
  136. package/dist/services/sandbox/api-reference.d.ts +4 -0
  137. package/dist/services/sandbox/api-reference.d.ts.map +1 -0
  138. package/dist/services/sandbox/api-reference.js +1006 -0
  139. package/dist/services/sandbox/api-reference.js.map +1 -0
  140. package/dist/services/sandbox/run.d.ts +1 -1
  141. package/dist/services/sandbox/types.d.ts +64 -1
  142. package/dist/services/sandbox/types.d.ts.map +1 -1
  143. package/dist/services/sandbox/types.js +87 -0
  144. package/dist/services/sandbox/types.js.map +1 -1
  145. package/dist/services/schedule/api-reference.d.ts +4 -0
  146. package/dist/services/schedule/api-reference.d.ts.map +1 -0
  147. package/dist/services/schedule/api-reference.js +216 -0
  148. package/dist/services/schedule/api-reference.js.map +1 -0
  149. package/dist/services/schedule/types.d.ts +36 -0
  150. package/dist/services/schedule/types.d.ts.map +1 -0
  151. package/dist/services/schedule/types.js +20 -0
  152. package/dist/services/schedule/types.js.map +1 -0
  153. package/dist/services/session/api-reference.d.ts +4 -0
  154. package/dist/services/session/api-reference.d.ts.map +1 -0
  155. package/dist/services/session/api-reference.js +154 -0
  156. package/dist/services/session/api-reference.js.map +1 -0
  157. package/dist/services/storage/api-reference.d.ts +4 -0
  158. package/dist/services/storage/api-reference.d.ts.map +1 -0
  159. package/dist/services/storage/api-reference.js +196 -0
  160. package/dist/services/storage/api-reference.js.map +1 -0
  161. package/dist/services/storage/types.d.ts.map +1 -1
  162. package/dist/services/storage/types.js +9 -3
  163. package/dist/services/storage/types.js.map +1 -1
  164. package/dist/services/stream/api-reference.d.ts +4 -0
  165. package/dist/services/stream/api-reference.d.ts.map +1 -0
  166. package/dist/services/stream/api-reference.js +153 -0
  167. package/dist/services/stream/api-reference.js.map +1 -0
  168. package/dist/services/stream/types.d.ts +49 -0
  169. package/dist/services/stream/types.d.ts.map +1 -0
  170. package/dist/services/stream/types.js +49 -0
  171. package/dist/services/stream/types.js.map +1 -0
  172. package/dist/services/task/api-reference.d.ts +4 -0
  173. package/dist/services/task/api-reference.d.ts.map +1 -0
  174. package/dist/services/task/api-reference.js +802 -0
  175. package/dist/services/task/api-reference.js.map +1 -0
  176. package/dist/services/task/service.d.ts.map +1 -1
  177. package/dist/services/task/service.js +35 -39
  178. package/dist/services/task/service.js.map +1 -1
  179. package/dist/services/task/types.d.ts +48 -0
  180. package/dist/services/task/types.d.ts.map +1 -0
  181. package/dist/services/task/types.js +55 -0
  182. package/dist/services/task/types.js.map +1 -0
  183. package/dist/services/thread/api-reference.d.ts +4 -0
  184. package/dist/services/thread/api-reference.d.ts.map +1 -0
  185. package/dist/services/thread/api-reference.js +89 -0
  186. package/dist/services/thread/api-reference.js.map +1 -0
  187. package/dist/services/user/api-reference.d.ts +4 -0
  188. package/dist/services/user/api-reference.d.ts.map +1 -0
  189. package/dist/services/user/api-reference.js +27 -0
  190. package/dist/services/user/api-reference.js.map +1 -0
  191. package/dist/services/vector/api-reference.d.ts +4 -0
  192. package/dist/services/vector/api-reference.d.ts.map +1 -0
  193. package/dist/services/vector/api-reference.js +213 -0
  194. package/dist/services/vector/api-reference.js.map +1 -0
  195. package/dist/services/vector/types.d.ts +63 -0
  196. package/dist/services/vector/types.d.ts.map +1 -0
  197. package/dist/services/vector/types.js +90 -0
  198. package/dist/services/vector/types.js.map +1 -0
  199. package/dist/services/webhook/api-reference.d.ts +4 -0
  200. package/dist/services/webhook/api-reference.d.ts.map +1 -0
  201. package/dist/services/webhook/api-reference.js +388 -0
  202. package/dist/services/webhook/api-reference.js.map +1 -0
  203. package/package.json +2 -2
  204. package/src/services/api-reference.ts +198 -0
  205. package/src/services/apikey/api-reference.ts +99 -0
  206. package/src/services/db/api-reference.ts +152 -0
  207. package/src/services/db/types.ts +12 -0
  208. package/src/services/email/api-reference.ts +349 -0
  209. package/src/services/email/service.ts +1 -6
  210. package/src/services/email/types.ts +15 -0
  211. package/src/services/eval/api-reference.ts +124 -0
  212. package/src/services/index.ts +2 -0
  213. package/src/services/keyvalue/api-reference.ts +280 -0
  214. package/src/services/keyvalue/types.ts +25 -0
  215. package/src/services/machine/api-reference.ts +158 -0
  216. package/src/services/machine/types.ts +21 -0
  217. package/src/services/monitoring/index.ts +2 -0
  218. package/src/services/monitoring/service.ts +639 -0
  219. package/src/services/monitoring/types.ts +209 -0
  220. package/src/services/oauth/activity.ts +41 -0
  221. package/src/services/oauth/api-reference.ts +380 -0
  222. package/src/services/oauth/clients.ts +161 -0
  223. package/src/services/oauth/consent.ts +33 -0
  224. package/src/services/oauth/index.ts +8 -0
  225. package/src/services/oauth/keys.ts +13 -0
  226. package/src/services/oauth/members.ts +13 -0
  227. package/src/services/oauth/scopes.ts +13 -0
  228. package/src/services/oauth/types.ts +240 -0
  229. package/src/services/oauth/util.ts +3 -0
  230. package/src/services/org/api-reference.ts +148 -0
  231. package/src/services/org/types.ts +9 -0
  232. package/src/services/project/api-reference.ts +636 -0
  233. package/src/services/project/types.ts +47 -0
  234. package/src/services/queue/api-reference.ts +734 -0
  235. package/src/services/queue/types.ts +112 -0
  236. package/src/services/region/api-reference.ts +105 -0
  237. package/src/services/region/types.ts +27 -0
  238. package/src/services/sandbox/api-reference.ts +1042 -0
  239. package/src/services/sandbox/types.ts +100 -0
  240. package/src/services/schedule/api-reference.ts +228 -0
  241. package/src/services/schedule/types.ts +26 -0
  242. package/src/services/session/api-reference.ts +160 -0
  243. package/src/services/storage/api-reference.ts +207 -0
  244. package/src/services/storage/types.ts +9 -3
  245. package/src/services/stream/api-reference.ts +163 -0
  246. package/src/services/stream/types.ts +64 -0
  247. package/src/services/task/api-reference.ts +830 -0
  248. package/src/services/task/service.ts +35 -93
  249. package/src/services/task/types.ts +73 -0
  250. package/src/services/thread/api-reference.ts +91 -0
  251. package/src/services/user/api-reference.ts +31 -0
  252. package/src/services/vector/api-reference.ts +231 -0
  253. package/src/services/vector/types.ts +112 -0
  254. package/src/services/webhook/api-reference.ts +403 -0
@@ -0,0 +1,403 @@
1
+ import type { Service } from '../api-reference.ts';
2
+ import {
3
+ CreateWebhookDestinationRequestSchema,
4
+ CreateWebhookRequestSchema,
5
+ UpdateWebhookDestinationRequestSchema,
6
+ UpdateWebhookRequestSchema,
7
+ WebhookReceiptSchema,
8
+ WebhookSchema,
9
+ } from './types.ts';
10
+
11
+ const service: Service = {
12
+ name: 'Webhooks',
13
+ slug: 'webhooks',
14
+ description: 'Manage webhook endpoints, destinations, receipts, deliveries, and analytics',
15
+ endpoints: [
16
+ {
17
+ id: 'create-webhook',
18
+ title: 'Create Webhook',
19
+ sectionTitle: 'Webhook Management',
20
+ method: 'POST',
21
+ path: '/webhook/create',
22
+ description: 'Create a new webhook endpoint.',
23
+ pathParams: [],
24
+ queryParams: [],
25
+ requestBody: {
26
+ description: 'Webhook creation payload.',
27
+ fields: { schema: CreateWebhookRequestSchema },
28
+ },
29
+ responseDescription:
30
+ 'Returns the created webhook. The ingest URL is only returned at creation.',
31
+ responseFields: { schema: WebhookSchema },
32
+ statuses: [
33
+ { code: 201, description: 'Webhook created' },
34
+ { code: 401, description: 'Unauthorized — invalid or missing Bearer token' },
35
+ ],
36
+ examplePath: '/webhook/create',
37
+ exampleBody: { name: 'Payment Events' },
38
+ },
39
+ {
40
+ id: 'get-webhook',
41
+ title: 'Get Webhook',
42
+ sectionTitle: 'Webhook Management',
43
+ method: 'GET',
44
+ path: '/webhook/get/{webhookId}',
45
+ description: 'Get a specific webhook by ID.',
46
+ pathParams: [
47
+ {
48
+ name: 'webhookId',
49
+ type: 'string',
50
+ description: 'Webhook ID (wh_ prefix)',
51
+ required: true,
52
+ },
53
+ ],
54
+ queryParams: [],
55
+ requestBody: null,
56
+ responseDescription: 'Returns the webhook object.',
57
+ statuses: [
58
+ { code: 200, description: 'Webhook returned' },
59
+ { code: 401, description: 'Unauthorized — invalid or missing Bearer token' },
60
+ { code: 404, description: 'Webhook not found' },
61
+ ],
62
+ examplePath: '/webhook/get/wh_abc123',
63
+ },
64
+ {
65
+ id: 'list-webhooks',
66
+ title: 'List Webhooks',
67
+ sectionTitle: 'Webhook Management',
68
+ method: 'GET',
69
+ path: '/webhook/list',
70
+ description: 'List all webhooks with optional pagination.',
71
+ pathParams: [],
72
+ queryParams: [
73
+ {
74
+ name: 'limit',
75
+ type: 'number',
76
+ description: 'Maximum results to return',
77
+ required: false,
78
+ },
79
+ { name: 'offset', type: 'number', description: 'Pagination offset', required: false },
80
+ ],
81
+ requestBody: null,
82
+ responseDescription: 'Returns paginated list of webhooks.',
83
+ statuses: [
84
+ { code: 200, description: 'Webhooks returned' },
85
+ { code: 401, description: 'Unauthorized — invalid or missing Bearer token' },
86
+ ],
87
+ examplePath: '/webhook/list',
88
+ },
89
+ {
90
+ id: 'update-webhook',
91
+ title: 'Update Webhook',
92
+ sectionTitle: 'Webhook Management',
93
+ method: 'PUT',
94
+ path: '/webhook/update/{webhookId}',
95
+ description: "Update a webhook's name or description.",
96
+ pathParams: [
97
+ { name: 'webhookId', type: 'string', description: 'Webhook ID', required: true },
98
+ ],
99
+ queryParams: [],
100
+ requestBody: {
101
+ description: 'Webhook update payload.',
102
+ fields: { schema: UpdateWebhookRequestSchema },
103
+ },
104
+ responseDescription: 'Returns the updated webhook.',
105
+ statuses: [
106
+ { code: 200, description: 'Webhook updated' },
107
+ { code: 401, description: 'Unauthorized — invalid or missing Bearer token' },
108
+ { code: 404, description: 'Webhook not found' },
109
+ ],
110
+ examplePath: '/webhook/update/wh_abc123',
111
+ exampleBody: { name: 'Updated Webhook' },
112
+ },
113
+ {
114
+ id: 'delete-webhook',
115
+ title: 'Delete Webhook',
116
+ sectionTitle: 'Webhook Management',
117
+ method: 'DELETE',
118
+ path: '/webhook/delete/{webhookId}',
119
+ description: 'Delete a webhook and all associated destinations, receipts, and deliveries.',
120
+ pathParams: [
121
+ { name: 'webhookId', type: 'string', description: 'Webhook ID', required: true },
122
+ ],
123
+ queryParams: [],
124
+ requestBody: null,
125
+ responseDescription:
126
+ 'Deletes the webhook and all associated destinations, receipts, and deliveries.',
127
+ statuses: [
128
+ { code: 204, description: 'Webhook deleted' },
129
+ { code: 401, description: 'Unauthorized — invalid or missing Bearer token' },
130
+ { code: 404, description: 'Webhook not found' },
131
+ ],
132
+ examplePath: '/webhook/delete/wh_abc123',
133
+ },
134
+ {
135
+ id: 'create-webhook-destination',
136
+ title: 'Create Destination',
137
+ sectionTitle: 'Destinations',
138
+ method: 'POST',
139
+ path: '/webhook/destination-create/{webhookId}',
140
+ description: 'Add a destination to a webhook.',
141
+ pathParams: [
142
+ { name: 'webhookId', type: 'string', description: 'Webhook ID', required: true },
143
+ ],
144
+ queryParams: [],
145
+ requestBody: {
146
+ description: 'Destination creation payload.',
147
+ fields: { schema: CreateWebhookDestinationRequestSchema },
148
+ },
149
+ responseDescription: 'Returns the created destination.',
150
+ statuses: [
151
+ { code: 201, description: 'Destination created' },
152
+ { code: 401, description: 'Unauthorized — invalid or missing Bearer token' },
153
+ { code: 404, description: 'Webhook not found' },
154
+ ],
155
+ examplePath: '/webhook/destination-create/wh_abc123',
156
+ exampleBody: { type: 'url', config: { url: 'https://example.com/handler' } },
157
+ },
158
+ {
159
+ id: 'list-webhook-destinations',
160
+ title: 'List Destinations',
161
+ sectionTitle: 'Destinations',
162
+ method: 'GET',
163
+ path: '/webhook/destination-list/{webhookId}',
164
+ description: 'List all destinations for a webhook.',
165
+ pathParams: [
166
+ { name: 'webhookId', type: 'string', description: 'Webhook ID', required: true },
167
+ ],
168
+ queryParams: [],
169
+ requestBody: null,
170
+ responseDescription: 'Returns list of destinations.',
171
+ statuses: [
172
+ { code: 200, description: 'Destinations returned' },
173
+ { code: 401, description: 'Unauthorized — invalid or missing Bearer token' },
174
+ { code: 404, description: 'Webhook not found' },
175
+ ],
176
+ examplePath: '/webhook/destination-list/wh_abc123',
177
+ },
178
+ {
179
+ id: 'update-webhook-destination',
180
+ title: 'Update Destination',
181
+ sectionTitle: 'Destinations',
182
+ method: 'PUT',
183
+ path: '/webhook/destination-update/{webhookId}/{destinationId}',
184
+ description: "Update a destination's configuration.",
185
+ pathParams: [
186
+ { name: 'webhookId', type: 'string', description: 'Webhook ID', required: true },
187
+ {
188
+ name: 'destinationId',
189
+ type: 'string',
190
+ description: 'Destination ID (whds_ prefix)',
191
+ required: true,
192
+ },
193
+ ],
194
+ queryParams: [],
195
+ requestBody: {
196
+ description: 'Destination update payload.',
197
+ fields: { schema: UpdateWebhookDestinationRequestSchema },
198
+ },
199
+ responseDescription: 'Returns the updated destination.',
200
+ statuses: [
201
+ { code: 200, description: 'Destination updated' },
202
+ { code: 401, description: 'Unauthorized — invalid or missing Bearer token' },
203
+ { code: 404, description: 'Webhook or destination not found' },
204
+ ],
205
+ examplePath: '/webhook/destination-update/wh_abc123/whds_def456',
206
+ exampleBody: { config: { url: 'https://example.com/new-handler' } },
207
+ },
208
+ {
209
+ id: 'delete-webhook-destination',
210
+ title: 'Delete Destination',
211
+ sectionTitle: 'Destinations',
212
+ method: 'DELETE',
213
+ path: '/webhook/destination-delete/{webhookId}/{destinationId}',
214
+ description: 'Delete a destination from a webhook.',
215
+ pathParams: [
216
+ { name: 'webhookId', type: 'string', description: 'Webhook ID', required: true },
217
+ {
218
+ name: 'destinationId',
219
+ type: 'string',
220
+ description: 'Destination ID',
221
+ required: true,
222
+ },
223
+ ],
224
+ queryParams: [],
225
+ requestBody: null,
226
+ responseDescription: 'Empty response on success.',
227
+ statuses: [
228
+ { code: 204, description: 'Destination deleted' },
229
+ { code: 401, description: 'Unauthorized — invalid or missing Bearer token' },
230
+ { code: 404, description: 'Webhook or destination not found' },
231
+ ],
232
+ examplePath: '/webhook/destination-delete/wh_abc123/whds_def456',
233
+ },
234
+ {
235
+ id: 'list-webhook-receipts',
236
+ title: 'List Receipts',
237
+ sectionTitle: 'Receipts',
238
+ method: 'GET',
239
+ path: '/webhook/receipt-list/{webhookId}',
240
+ description: 'List incoming request records (receipts) for a webhook.',
241
+ pathParams: [
242
+ { name: 'webhookId', type: 'string', description: 'Webhook ID', required: true },
243
+ ],
244
+ queryParams: [
245
+ {
246
+ name: 'limit',
247
+ type: 'number',
248
+ description: 'Maximum results to return',
249
+ required: false,
250
+ },
251
+ { name: 'offset', type: 'number', description: 'Pagination offset', required: false },
252
+ ],
253
+ requestBody: null,
254
+ responseDescription: 'Returns incoming request records (receipts) for a webhook.',
255
+ statuses: [
256
+ { code: 200, description: 'Receipts returned' },
257
+ { code: 401, description: 'Unauthorized — invalid or missing Bearer token' },
258
+ { code: 404, description: 'Webhook not found' },
259
+ ],
260
+ examplePath: '/webhook/receipt-list/wh_abc123',
261
+ },
262
+ {
263
+ id: 'get-webhook-receipt',
264
+ title: 'Get Receipt',
265
+ sectionTitle: 'Receipts',
266
+ method: 'GET',
267
+ path: '/webhook/receipt-get/{webhookId}/{receiptId}',
268
+ description: 'Get a specific receipt by ID.',
269
+ pathParams: [
270
+ { name: 'webhookId', type: 'string', description: 'Webhook ID', required: true },
271
+ {
272
+ name: 'receiptId',
273
+ type: 'string',
274
+ description: 'Receipt ID (whrc_ prefix)',
275
+ required: true,
276
+ },
277
+ ],
278
+ queryParams: [],
279
+ requestBody: null,
280
+ responseDescription: 'Returns the receipt with headers and payload.',
281
+ responseFields: { schema: WebhookReceiptSchema },
282
+ statuses: [
283
+ { code: 200, description: 'Receipt returned' },
284
+ { code: 401, description: 'Unauthorized — invalid or missing Bearer token' },
285
+ { code: 404, description: 'Webhook or receipt not found' },
286
+ ],
287
+ examplePath: '/webhook/receipt-get/wh_abc123/whrc_def456',
288
+ },
289
+ {
290
+ id: 'list-webhook-deliveries',
291
+ title: 'List Deliveries',
292
+ sectionTitle: 'Deliveries',
293
+ method: 'GET',
294
+ path: '/webhook/delivery-list/{webhookId}',
295
+ description: 'List delivery attempts for a webhook.',
296
+ pathParams: [
297
+ { name: 'webhookId', type: 'string', description: 'Webhook ID', required: true },
298
+ ],
299
+ queryParams: [
300
+ {
301
+ name: 'limit',
302
+ type: 'number',
303
+ description: 'Maximum results to return',
304
+ required: false,
305
+ },
306
+ { name: 'offset', type: 'number', description: 'Pagination offset', required: false },
307
+ ],
308
+ requestBody: null,
309
+ responseDescription: 'Returns list of delivery attempts.',
310
+ statuses: [
311
+ { code: 200, description: 'Deliveries returned' },
312
+ { code: 401, description: 'Unauthorized — invalid or missing Bearer token' },
313
+ { code: 404, description: 'Webhook not found' },
314
+ ],
315
+ examplePath: '/webhook/delivery-list/wh_abc123',
316
+ },
317
+ {
318
+ id: 'retry-webhook-delivery',
319
+ title: 'Retry Delivery',
320
+ sectionTitle: 'Deliveries',
321
+ method: 'POST',
322
+ path: '/webhook/delivery-retry/{webhookId}/{deliveryId}',
323
+ description:
324
+ "Retry a failed delivery. Only deliveries with 'failed' status can be retried.",
325
+ pathParams: [
326
+ { name: 'webhookId', type: 'string', description: 'Webhook ID', required: true },
327
+ {
328
+ name: 'deliveryId',
329
+ type: 'string',
330
+ description: 'Delivery ID (whdv_ prefix)',
331
+ required: true,
332
+ },
333
+ ],
334
+ queryParams: [],
335
+ requestBody: null,
336
+ responseDescription:
337
+ "Retries a failed delivery. Only deliveries with 'failed' status can be retried.",
338
+ statuses: [
339
+ { code: 200, description: 'Delivery retried' },
340
+ { code: 401, description: 'Unauthorized — invalid or missing Bearer token' },
341
+ { code: 404, description: 'Webhook or delivery not found' },
342
+ ],
343
+ examplePath: '/webhook/delivery-retry/wh_abc123/whdv_def456',
344
+ exampleBody: {},
345
+ },
346
+ {
347
+ id: 'get-webhook-org-analytics',
348
+ title: 'Get Org Analytics',
349
+ sectionTitle: 'Analytics',
350
+ method: 'GET',
351
+ path: '/webhook/analytics/org',
352
+ description: 'Get aggregate webhook analytics for the organization.',
353
+ pathParams: [],
354
+ queryParams: [
355
+ { name: 'start', type: 'string', description: 'ISO 8601 start date', required: false },
356
+ { name: 'end', type: 'string', description: 'ISO 8601 end date', required: false },
357
+ {
358
+ name: 'granularity',
359
+ type: 'string',
360
+ description: "'minute', 'hour', or 'day'",
361
+ required: false,
362
+ },
363
+ ],
364
+ requestBody: null,
365
+ responseDescription:
366
+ 'Returns aggregate analytics including total received, delivered, and failed counts.',
367
+ statuses: [
368
+ { code: 200, description: 'Analytics returned' },
369
+ { code: 401, description: 'Unauthorized — invalid or missing Bearer token' },
370
+ ],
371
+ examplePath: '/webhook/analytics/org',
372
+ },
373
+ {
374
+ id: 'get-webhook-org-timeseries',
375
+ title: 'Get Analytics Time Series',
376
+ sectionTitle: 'Analytics',
377
+ method: 'GET',
378
+ path: '/webhook/analytics/org/timeseries',
379
+ description: 'Get time series webhook analytics for the organization.',
380
+ pathParams: [],
381
+ queryParams: [
382
+ { name: 'start', type: 'string', description: 'ISO 8601 start date', required: false },
383
+ { name: 'end', type: 'string', description: 'ISO 8601 end date', required: false },
384
+ {
385
+ name: 'granularity',
386
+ type: 'string',
387
+ description: "'minute', 'hour', or 'day'",
388
+ required: false,
389
+ },
390
+ ],
391
+ requestBody: null,
392
+ responseDescription:
393
+ 'Returns time series data with received, delivered, and failed counts per time bucket.',
394
+ statuses: [
395
+ { code: 200, description: 'Time series data returned' },
396
+ { code: 401, description: 'Unauthorized — invalid or missing Bearer token' },
397
+ ],
398
+ examplePath: '/webhook/analytics/org/timeseries',
399
+ },
400
+ ],
401
+ };
402
+
403
+ export default service;