@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,713 @@
1
+ import { BatchPublishMessagesRequestSchema, BatchPublishResponseSchema, ConsumeMessagesResponseSchema, CreateDestinationRequestSchema, CreateQueueRequestSchema, GetQueueHeadResponseSchema, GetQueueTailResponseSchema, ListDeliveryLogsResponseSchema, ListDestinationsResponseSchema, ListDlqMessagesResponseSchema, ListMessagesResponseSchema, ListQueuesResponseSchema, PublishMessageRequestSchema, ReceiveMessageResponseSchema, UpdateQueueRequestSchema, } from "./types.js";
2
+ const service = {
3
+ name: 'Message Queues',
4
+ slug: 'queues',
5
+ description: 'Publish, consume, and manage messages with worker and pub/sub queues',
6
+ endpoints: [
7
+ {
8
+ id: 'create-queue',
9
+ title: 'Create Queue',
10
+ sectionTitle: 'Queue Management',
11
+ method: 'POST',
12
+ path: '/queue/create',
13
+ description: 'Create a queue. If `name` is omitted, a name is auto-generated.',
14
+ pathParams: [],
15
+ queryParams: [],
16
+ requestBody: {
17
+ description: 'Queue creation payload.',
18
+ fields: { schema: CreateQueueRequestSchema },
19
+ },
20
+ responseDescription: 'Queue object including settings, stats, and timestamps.',
21
+ statuses: [
22
+ { code: 200, description: 'Queue created' },
23
+ { code: 401, description: 'Unauthorized' },
24
+ { code: 402, description: 'Payment required' },
25
+ ],
26
+ examplePath: '/queue/create',
27
+ exampleBody: {
28
+ name: 'order-processing',
29
+ queue_type: 'worker',
30
+ description: 'Processes customer orders',
31
+ settings: { default_max_retries: 3, default_visibility_timeout_seconds: 60 },
32
+ },
33
+ },
34
+ {
35
+ id: 'get-queue',
36
+ title: 'Get Queue',
37
+ sectionTitle: 'Queue Management',
38
+ method: 'GET',
39
+ path: '/queue/get/{name}',
40
+ description: 'Get a queue by name.',
41
+ pathParams: [{ name: 'name', type: 'string', description: 'Queue name' }],
42
+ queryParams: [],
43
+ requestBody: null,
44
+ responseDescription: 'Queue object.',
45
+ statuses: [
46
+ { code: 200, description: 'Queue returned' },
47
+ { code: 401, description: 'Unauthorized' },
48
+ { code: 404, description: 'Queue not found' },
49
+ ],
50
+ examplePath: '/queue/get/order-processing',
51
+ },
52
+ {
53
+ id: 'list-queues',
54
+ title: 'List Queues',
55
+ sectionTitle: 'Queue Management',
56
+ method: 'GET',
57
+ path: '/queue/list',
58
+ description: 'List queues with filtering and pagination.',
59
+ pathParams: [],
60
+ queryParams: [
61
+ {
62
+ name: 'limit',
63
+ type: 'number',
64
+ description: 'Maximum queues to return',
65
+ required: false,
66
+ },
67
+ {
68
+ name: 'offset',
69
+ type: 'number',
70
+ description: 'Offset for pagination',
71
+ required: false,
72
+ },
73
+ { name: 'name', type: 'string', description: 'Filter by queue name', required: false },
74
+ {
75
+ name: 'queue_type',
76
+ type: 'string',
77
+ description: '`worker` or `pubsub`',
78
+ required: false,
79
+ },
80
+ {
81
+ name: 'status',
82
+ type: 'string',
83
+ description: '`active` or `paused`',
84
+ required: false,
85
+ },
86
+ { name: 'sort', type: 'string', description: 'Sort field', required: false },
87
+ { name: 'direction', type: 'string', description: '`asc` or `desc`', required: false },
88
+ ],
89
+ requestBody: null,
90
+ responseDescription: 'Response with queue array and optional total count.',
91
+ responseFields: { schema: ListQueuesResponseSchema },
92
+ statuses: [
93
+ { code: 200, description: 'Queues returned' },
94
+ { code: 401, description: 'Unauthorized' },
95
+ ],
96
+ examplePath: '/queue/list?limit=10&queue_type=worker',
97
+ },
98
+ {
99
+ id: 'update-queue',
100
+ title: 'Update Queue',
101
+ sectionTitle: 'Queue Management',
102
+ method: 'PATCH',
103
+ path: '/queue/update/{name}',
104
+ description: 'Partially update queue description/settings.',
105
+ pathParams: [{ name: 'name', type: 'string', description: 'Queue name' }],
106
+ queryParams: [],
107
+ requestBody: {
108
+ description: 'Partial queue update payload.',
109
+ fields: { schema: UpdateQueueRequestSchema },
110
+ },
111
+ responseDescription: 'Updated queue object.',
112
+ statuses: [
113
+ { code: 200, description: 'Queue updated' },
114
+ { code: 401, description: 'Unauthorized' },
115
+ { code: 404, description: 'Queue not found' },
116
+ ],
117
+ examplePath: '/queue/update/order-processing',
118
+ exampleBody: { description: 'Updated', settings: { default_max_retries: 5 } },
119
+ },
120
+ {
121
+ id: 'delete-queue',
122
+ title: 'Delete Queue',
123
+ sectionTitle: 'Queue Management',
124
+ method: 'DELETE',
125
+ path: '/queue/delete/{name}',
126
+ description: 'Delete a queue and associated resources.',
127
+ pathParams: [{ name: 'name', type: 'string', description: 'Queue name' }],
128
+ queryParams: [],
129
+ requestBody: null,
130
+ responseDescription: 'Empty response on success.',
131
+ statuses: [
132
+ { code: 200, description: 'Queue deleted' },
133
+ { code: 401, description: 'Unauthorized' },
134
+ { code: 404, description: 'Queue not found' },
135
+ ],
136
+ examplePath: '/queue/delete/order-processing',
137
+ },
138
+ {
139
+ id: 'pause-queue',
140
+ title: 'Pause Queue',
141
+ sectionTitle: 'Queue Management',
142
+ method: 'POST',
143
+ path: '/queue/pause/{name}',
144
+ description: 'Pause queue processing.',
145
+ pathParams: [{ name: 'name', type: 'string', description: 'Queue name' }],
146
+ queryParams: [],
147
+ requestBody: { description: 'Empty JSON object is required.' },
148
+ responseDescription: 'Queue object with `paused_at` set.',
149
+ statuses: [
150
+ { code: 200, description: 'Queue paused' },
151
+ { code: 401, description: 'Unauthorized' },
152
+ { code: 404, description: 'Queue not found' },
153
+ ],
154
+ examplePath: '/queue/pause/order-processing',
155
+ exampleBody: {},
156
+ },
157
+ {
158
+ id: 'resume-queue',
159
+ title: 'Resume Queue',
160
+ sectionTitle: 'Queue Management',
161
+ method: 'POST',
162
+ path: '/queue/resume/{name}',
163
+ description: 'Resume queue processing.',
164
+ pathParams: [{ name: 'name', type: 'string', description: 'Queue name' }],
165
+ queryParams: [],
166
+ requestBody: { description: 'Empty JSON object is required.' },
167
+ responseDescription: 'Queue object with `paused_at` cleared.',
168
+ statuses: [
169
+ { code: 200, description: 'Queue resumed' },
170
+ { code: 401, description: 'Unauthorized' },
171
+ { code: 404, description: 'Queue not found' },
172
+ ],
173
+ examplePath: '/queue/resume/order-processing',
174
+ exampleBody: {},
175
+ },
176
+ {
177
+ id: 'publish-message',
178
+ title: 'Publish Message',
179
+ sectionTitle: 'Message Operations',
180
+ method: 'POST',
181
+ path: '/queue/messages/publish/{name}',
182
+ description: 'Publish a single message to a queue.',
183
+ pathParams: [{ name: 'name', type: 'string', description: 'Queue name' }],
184
+ queryParams: [
185
+ {
186
+ name: 'sync',
187
+ type: 'boolean',
188
+ description: 'Set `true` for synchronous publish',
189
+ required: false,
190
+ },
191
+ ],
192
+ requestBody: {
193
+ description: 'Message payload and optional delivery controls.',
194
+ fields: { schema: PublishMessageRequestSchema },
195
+ },
196
+ responseDescription: 'Published message object.',
197
+ statuses: [
198
+ { code: 200, description: 'Message published' },
199
+ { code: 401, description: 'Unauthorized' },
200
+ { code: 404, description: 'Queue not found' },
201
+ ],
202
+ examplePath: '/queue/messages/publish/order-processing',
203
+ exampleBody: {
204
+ payload: { orderId: 123, action: 'process' },
205
+ metadata: { priority: 'high' },
206
+ },
207
+ },
208
+ {
209
+ id: 'batch-publish',
210
+ title: 'Batch Publish',
211
+ sectionTitle: 'Message Operations',
212
+ method: 'POST',
213
+ path: '/queue/messages/batch/{name}',
214
+ description: 'Publish up to 1000 messages in one request.',
215
+ pathParams: [{ name: 'name', type: 'string', description: 'Queue name' }],
216
+ queryParams: [],
217
+ requestBody: {
218
+ description: 'Batch publish payload.',
219
+ fields: { schema: BatchPublishMessagesRequestSchema },
220
+ },
221
+ responseDescription: 'Batch publish response with created messages and optional failed indexes.',
222
+ responseFields: { schema: BatchPublishResponseSchema },
223
+ statuses: [
224
+ { code: 200, description: 'Batch publish completed' },
225
+ { code: 401, description: 'Unauthorized' },
226
+ { code: 404, description: 'Queue not found' },
227
+ ],
228
+ examplePath: '/queue/messages/batch/order-processing',
229
+ exampleBody: { messages: [{ payload: { orderId: 1 } }, { payload: { orderId: 2 } }] },
230
+ },
231
+ {
232
+ id: 'get-message',
233
+ title: 'Get Message',
234
+ sectionTitle: 'Message Operations',
235
+ method: 'GET',
236
+ path: '/queue/messages/get/{name}/{messageId}',
237
+ description: 'Get a message by message ID (`msg_...`).',
238
+ pathParams: [
239
+ { name: 'name', type: 'string', description: 'Queue name' },
240
+ { name: 'messageId', type: 'string', description: 'Message ID (`msg_...`)' },
241
+ ],
242
+ queryParams: [],
243
+ requestBody: null,
244
+ responseDescription: 'Message object.',
245
+ statuses: [
246
+ { code: 200, description: 'Message returned' },
247
+ { code: 401, description: 'Unauthorized' },
248
+ { code: 404, description: 'Message or queue not found' },
249
+ ],
250
+ examplePath: '/queue/messages/get/order-processing/msg_abc123',
251
+ },
252
+ {
253
+ id: 'get-message-by-offset',
254
+ title: 'Get Message by Offset',
255
+ sectionTitle: 'Message Operations',
256
+ method: 'GET',
257
+ path: '/queue/messages/offset/{name}/{offset}',
258
+ description: 'Get a message by numeric offset.',
259
+ pathParams: [
260
+ { name: 'name', type: 'string', description: 'Queue name' },
261
+ { name: 'offset', type: 'number', description: 'Message offset' },
262
+ ],
263
+ queryParams: [],
264
+ requestBody: null,
265
+ responseDescription: 'Message object.',
266
+ statuses: [
267
+ { code: 200, description: 'Message returned' },
268
+ { code: 401, description: 'Unauthorized' },
269
+ { code: 404, description: 'Message or queue not found' },
270
+ ],
271
+ examplePath: '/queue/messages/offset/order-processing/42',
272
+ },
273
+ {
274
+ id: 'list-messages',
275
+ title: 'List Messages',
276
+ sectionTitle: 'Message Operations',
277
+ method: 'GET',
278
+ path: '/queue/messages/list/{name}',
279
+ description: 'List messages with pagination and optional state filter.',
280
+ pathParams: [{ name: 'name', type: 'string', description: 'Queue name' }],
281
+ queryParams: [
282
+ {
283
+ name: 'limit',
284
+ type: 'number',
285
+ description: 'Maximum messages to return',
286
+ required: false,
287
+ },
288
+ {
289
+ name: 'offset',
290
+ type: 'number',
291
+ description: 'Offset for pagination',
292
+ required: false,
293
+ },
294
+ {
295
+ name: 'state',
296
+ type: 'string',
297
+ description: '`pending`, `processing`, `completed`, `failed`, or `dead`',
298
+ required: false,
299
+ },
300
+ ],
301
+ requestBody: null,
302
+ responseDescription: 'Response with message list and optional total count.',
303
+ responseFields: { schema: ListMessagesResponseSchema },
304
+ statuses: [
305
+ { code: 200, description: 'Messages returned' },
306
+ { code: 401, description: 'Unauthorized' },
307
+ { code: 404, description: 'Queue not found' },
308
+ ],
309
+ examplePath: '/queue/messages/list/order-processing?limit=20&state=pending',
310
+ },
311
+ {
312
+ id: 'delete-message',
313
+ title: 'Delete Message',
314
+ sectionTitle: 'Message Operations',
315
+ method: 'DELETE',
316
+ path: '/queue/messages/delete/{name}/{messageId}',
317
+ description: 'Delete a message by ID.',
318
+ pathParams: [
319
+ { name: 'name', type: 'string', description: 'Queue name' },
320
+ { name: 'messageId', type: 'string', description: 'Message ID' },
321
+ ],
322
+ queryParams: [],
323
+ requestBody: null,
324
+ responseDescription: 'Empty response on success.',
325
+ statuses: [
326
+ { code: 200, description: 'Message deleted' },
327
+ { code: 401, description: 'Unauthorized' },
328
+ { code: 404, description: 'Message or queue not found' },
329
+ ],
330
+ examplePath: '/queue/messages/delete/order-processing/msg_abc123',
331
+ },
332
+ {
333
+ id: 'replay-message',
334
+ title: 'Replay Message',
335
+ sectionTitle: 'Message Operations',
336
+ method: 'POST',
337
+ path: '/queue/messages/replay/{name}/{messageId}',
338
+ description: 'Replay a message back into the queue flow.',
339
+ pathParams: [
340
+ { name: 'name', type: 'string', description: 'Queue name' },
341
+ { name: 'messageId', type: 'string', description: 'Message ID' },
342
+ ],
343
+ queryParams: [],
344
+ requestBody: null,
345
+ responseDescription: 'Replayed message object.',
346
+ statuses: [
347
+ { code: 200, description: 'Message replayed' },
348
+ { code: 401, description: 'Unauthorized' },
349
+ { code: 404, description: 'Message or queue not found' },
350
+ ],
351
+ examplePath: '/queue/messages/replay/order-processing/msg_abc123',
352
+ },
353
+ {
354
+ id: 'consume-messages',
355
+ title: 'Consume Messages',
356
+ sectionTitle: 'Message Operations',
357
+ method: 'GET',
358
+ path: '/queue/consume/{name}',
359
+ description: 'Log-style consumption starting from offset. Does not mark messages as processing.',
360
+ pathParams: [{ name: 'name', type: 'string', description: 'Queue name' }],
361
+ queryParams: [
362
+ { name: 'offset', type: 'number', description: 'Starting offset', required: true },
363
+ {
364
+ name: 'limit',
365
+ type: 'number',
366
+ description: 'Maximum messages to return',
367
+ required: false,
368
+ },
369
+ ],
370
+ requestBody: null,
371
+ responseDescription: 'Response containing consumed messages.',
372
+ responseFields: { schema: ConsumeMessagesResponseSchema },
373
+ statuses: [
374
+ { code: 200, description: 'Messages consumed' },
375
+ { code: 401, description: 'Unauthorized' },
376
+ { code: 404, description: 'Queue not found' },
377
+ ],
378
+ examplePath: '/queue/consume/order-processing?offset=0&limit=10',
379
+ },
380
+ {
381
+ id: 'receive-message',
382
+ title: 'Receive Message',
383
+ sectionTitle: 'Message Operations',
384
+ method: 'GET',
385
+ path: '/queue/receive/{name}',
386
+ description: 'Atomically receive and lock the next pending message. Must ack/nack when done.',
387
+ pathParams: [{ name: 'name', type: 'string', description: 'Queue name' }],
388
+ queryParams: [
389
+ {
390
+ name: 'timeout',
391
+ type: 'number',
392
+ description: 'Long-poll timeout in seconds (0–30)',
393
+ required: false,
394
+ },
395
+ ],
396
+ requestBody: null,
397
+ responseDescription: 'Response containing a message or `null` when none available.',
398
+ responseFields: { schema: ReceiveMessageResponseSchema },
399
+ statuses: [
400
+ { code: 200, description: 'Receive operation completed' },
401
+ { code: 401, description: 'Unauthorized' },
402
+ { code: 404, description: 'Queue not found' },
403
+ ],
404
+ examplePath: '/queue/receive/order-processing?timeout=10',
405
+ },
406
+ {
407
+ id: 'ack-message',
408
+ title: 'Acknowledge Message',
409
+ sectionTitle: 'Message Operations',
410
+ method: 'POST',
411
+ path: '/queue/ack/{name}/{messageId}',
412
+ description: 'Mark message as successfully processed (completed).',
413
+ pathParams: [
414
+ { name: 'name', type: 'string', description: 'Queue name' },
415
+ { name: 'messageId', type: 'string', description: 'Message ID' },
416
+ ],
417
+ queryParams: [],
418
+ requestBody: null,
419
+ responseDescription: 'Empty response on success.',
420
+ statuses: [
421
+ { code: 200, description: 'Message acknowledged' },
422
+ { code: 401, description: 'Unauthorized' },
423
+ { code: 404, description: 'Message or queue not found' },
424
+ ],
425
+ examplePath: '/queue/ack/order-processing/msg_abc123',
426
+ },
427
+ {
428
+ id: 'nack-message',
429
+ title: 'Negative Acknowledge',
430
+ sectionTitle: 'Message Operations',
431
+ method: 'POST',
432
+ path: '/queue/nack/{name}/{messageId}',
433
+ description: 'Return message for retry. After max retries, moves to DLQ.',
434
+ pathParams: [
435
+ { name: 'name', type: 'string', description: 'Queue name' },
436
+ { name: 'messageId', type: 'string', description: 'Message ID' },
437
+ ],
438
+ queryParams: [],
439
+ requestBody: null,
440
+ responseDescription: 'Empty response on success.',
441
+ statuses: [
442
+ { code: 200, description: 'Message negatively acknowledged' },
443
+ { code: 401, description: 'Unauthorized' },
444
+ { code: 404, description: 'Message or queue not found' },
445
+ ],
446
+ examplePath: '/queue/nack/order-processing/msg_abc123',
447
+ },
448
+ {
449
+ id: 'get-queue-head',
450
+ title: 'Get Queue Head',
451
+ sectionTitle: 'Message Operations',
452
+ method: 'GET',
453
+ path: '/queue/head/{name}',
454
+ description: 'Get offset of the oldest message.',
455
+ pathParams: [{ name: 'name', type: 'string', description: 'Queue name' }],
456
+ queryParams: [],
457
+ requestBody: null,
458
+ responseDescription: 'JSON object containing the head offset.',
459
+ responseFields: { schema: GetQueueHeadResponseSchema },
460
+ statuses: [
461
+ { code: 200, description: 'Queue head returned' },
462
+ { code: 401, description: 'Unauthorized' },
463
+ { code: 404, description: 'Queue not found' },
464
+ ],
465
+ examplePath: '/queue/head/order-processing',
466
+ },
467
+ {
468
+ id: 'get-queue-tail',
469
+ title: 'Get Queue Tail',
470
+ sectionTitle: 'Message Operations',
471
+ method: 'GET',
472
+ path: '/queue/tail/{name}',
473
+ description: 'Get offset of the newest message.',
474
+ pathParams: [{ name: 'name', type: 'string', description: 'Queue name' }],
475
+ queryParams: [],
476
+ requestBody: null,
477
+ responseDescription: 'JSON object containing the tail offset.',
478
+ responseFields: { schema: GetQueueTailResponseSchema },
479
+ statuses: [
480
+ { code: 200, description: 'Queue tail returned' },
481
+ { code: 401, description: 'Unauthorized' },
482
+ { code: 404, description: 'Queue not found' },
483
+ ],
484
+ examplePath: '/queue/tail/order-processing',
485
+ },
486
+ {
487
+ id: 'create-destination',
488
+ title: 'Create Destination',
489
+ sectionTitle: 'Destinations',
490
+ method: 'POST',
491
+ path: '/queue/destinations/create/{name}',
492
+ description: 'Create an HTTP destination for queue deliveries.',
493
+ pathParams: [{ name: 'name', type: 'string', description: 'Queue name' }],
494
+ queryParams: [],
495
+ requestBody: {
496
+ description: 'Destination creation payload.',
497
+ fields: { schema: CreateDestinationRequestSchema },
498
+ },
499
+ responseDescription: 'Created destination object.',
500
+ statuses: [
501
+ { code: 200, description: 'Destination created' },
502
+ { code: 401, description: 'Unauthorized' },
503
+ { code: 404, description: 'Queue not found' },
504
+ ],
505
+ examplePath: '/queue/destinations/create/order-processing',
506
+ exampleBody: {
507
+ name: 'my-webhook',
508
+ destination_type: 'http',
509
+ config: { url: 'https://example.com/webhook' },
510
+ enabled: true,
511
+ },
512
+ },
513
+ {
514
+ id: 'list-destinations',
515
+ title: 'List Destinations',
516
+ sectionTitle: 'Destinations',
517
+ method: 'GET',
518
+ path: '/queue/destinations/list/{name}',
519
+ description: 'List queue destinations.',
520
+ pathParams: [{ name: 'name', type: 'string', description: 'Queue name' }],
521
+ queryParams: [],
522
+ requestBody: null,
523
+ responseDescription: 'Response containing destination list.',
524
+ responseFields: { schema: ListDestinationsResponseSchema },
525
+ statuses: [
526
+ { code: 200, description: 'Destinations returned' },
527
+ { code: 401, description: 'Unauthorized' },
528
+ { code: 404, description: 'Queue not found' },
529
+ ],
530
+ examplePath: '/queue/destinations/list/order-processing',
531
+ },
532
+ {
533
+ id: 'update-destination',
534
+ title: 'Update Destination',
535
+ sectionTitle: 'Destinations',
536
+ method: 'PATCH',
537
+ path: '/queue/destinations/update/{name}/{destinationId}',
538
+ description: 'Partially update destination fields.',
539
+ pathParams: [
540
+ { name: 'name', type: 'string', description: 'Queue name' },
541
+ { name: 'destinationId', type: 'string', description: 'Destination ID' },
542
+ ],
543
+ queryParams: [],
544
+ requestBody: {
545
+ description: 'Partial destination update payload.',
546
+ },
547
+ responseDescription: 'Updated destination object.',
548
+ statuses: [
549
+ { code: 200, description: 'Destination updated' },
550
+ { code: 401, description: 'Unauthorized' },
551
+ { code: 404, description: 'Queue or destination not found' },
552
+ ],
553
+ examplePath: '/queue/destinations/update/order-processing/dst_abc123',
554
+ exampleBody: { timeout_seconds: 20 },
555
+ },
556
+ {
557
+ id: 'delete-destination',
558
+ title: 'Delete Destination',
559
+ sectionTitle: 'Destinations',
560
+ method: 'DELETE',
561
+ path: '/queue/destinations/delete/{name}/{destinationId}',
562
+ description: 'Delete a queue destination.',
563
+ pathParams: [
564
+ { name: 'name', type: 'string', description: 'Queue name' },
565
+ { name: 'destinationId', type: 'string', description: 'Destination ID' },
566
+ ],
567
+ queryParams: [],
568
+ requestBody: null,
569
+ responseDescription: 'Empty response on success.',
570
+ statuses: [
571
+ { code: 200, description: 'Destination deleted' },
572
+ { code: 401, description: 'Unauthorized' },
573
+ { code: 404, description: 'Queue or destination not found' },
574
+ ],
575
+ examplePath: '/queue/destinations/delete/order-processing/dst_abc123',
576
+ },
577
+ {
578
+ id: 'list-delivery-logs',
579
+ title: 'List Delivery Logs',
580
+ sectionTitle: 'Destinations',
581
+ method: 'GET',
582
+ path: '/queue/destinations/deliveries/{name}/{destinationId}',
583
+ description: 'List destination delivery logs with optional status filter.',
584
+ pathParams: [
585
+ { name: 'name', type: 'string', description: 'Queue name' },
586
+ { name: 'destinationId', type: 'string', description: 'Destination ID' },
587
+ ],
588
+ queryParams: [
589
+ {
590
+ name: 'limit',
591
+ type: 'number',
592
+ description: 'Maximum logs to return',
593
+ required: false,
594
+ },
595
+ {
596
+ name: 'offset',
597
+ type: 'number',
598
+ description: 'Offset for pagination',
599
+ required: false,
600
+ },
601
+ {
602
+ name: 'status',
603
+ type: 'string',
604
+ description: 'Delivery status filter',
605
+ required: false,
606
+ },
607
+ ],
608
+ requestBody: null,
609
+ responseDescription: 'Response containing delivery log entries.',
610
+ responseFields: { schema: ListDeliveryLogsResponseSchema },
611
+ statuses: [
612
+ { code: 200, description: 'Delivery logs returned' },
613
+ { code: 401, description: 'Unauthorized' },
614
+ { code: 404, description: 'Queue or destination not found' },
615
+ ],
616
+ examplePath: '/queue/destinations/deliveries/order-processing/dst_abc123?limit=20',
617
+ },
618
+ {
619
+ id: 'list-dlq-messages',
620
+ title: 'List DLQ Messages',
621
+ sectionTitle: 'Dead Letter Queue',
622
+ method: 'GET',
623
+ path: '/queue/dlq/list/{name}',
624
+ description: 'List dead-letter queue messages.',
625
+ pathParams: [{ name: 'name', type: 'string', description: 'Queue name' }],
626
+ queryParams: [
627
+ {
628
+ name: 'limit',
629
+ type: 'number',
630
+ description: 'Maximum messages to return',
631
+ required: false,
632
+ },
633
+ {
634
+ name: 'offset',
635
+ type: 'number',
636
+ description: 'Offset for pagination',
637
+ required: false,
638
+ },
639
+ ],
640
+ requestBody: null,
641
+ responseDescription: 'Response containing DLQ messages and optional total.',
642
+ responseFields: { schema: ListDlqMessagesResponseSchema },
643
+ statuses: [
644
+ { code: 200, description: 'DLQ messages returned' },
645
+ { code: 401, description: 'Unauthorized' },
646
+ { code: 404, description: 'Queue not found' },
647
+ ],
648
+ examplePath: '/queue/dlq/list/order-processing?limit=20',
649
+ },
650
+ {
651
+ id: 'replay-dlq-message',
652
+ title: 'Replay DLQ Message',
653
+ sectionTitle: 'Dead Letter Queue',
654
+ method: 'POST',
655
+ path: '/queue/dlq/replay/{name}/{messageId}',
656
+ description: 'Replay a DLQ message back to the queue.',
657
+ pathParams: [
658
+ { name: 'name', type: 'string', description: 'Queue name' },
659
+ { name: 'messageId', type: 'string', description: 'DLQ message ID' },
660
+ ],
661
+ queryParams: [],
662
+ requestBody: null,
663
+ responseDescription: 'Replayed message object.',
664
+ statuses: [
665
+ { code: 200, description: 'DLQ message replayed' },
666
+ { code: 401, description: 'Unauthorized' },
667
+ { code: 404, description: 'Queue or message not found' },
668
+ ],
669
+ examplePath: '/queue/dlq/replay/order-processing/msg_abc123',
670
+ },
671
+ {
672
+ id: 'purge-dlq',
673
+ title: 'Purge DLQ',
674
+ sectionTitle: 'Dead Letter Queue',
675
+ method: 'DELETE',
676
+ path: '/queue/dlq/purge/{name}',
677
+ description: 'Delete all messages in the dead-letter queue.',
678
+ pathParams: [{ name: 'name', type: 'string', description: 'Queue name' }],
679
+ queryParams: [],
680
+ requestBody: null,
681
+ responseDescription: 'Empty response on success.',
682
+ statuses: [
683
+ { code: 200, description: 'DLQ purged' },
684
+ { code: 401, description: 'Unauthorized' },
685
+ { code: 404, description: 'Queue not found' },
686
+ ],
687
+ examplePath: '/queue/dlq/purge/order-processing',
688
+ },
689
+ {
690
+ id: 'delete-dlq-message',
691
+ title: 'Delete DLQ Message',
692
+ sectionTitle: 'Dead Letter Queue',
693
+ method: 'DELETE',
694
+ path: '/queue/dlq/delete/{name}/{messageId}',
695
+ description: 'Delete a specific message from the dead-letter queue.',
696
+ pathParams: [
697
+ { name: 'name', type: 'string', description: 'Queue name' },
698
+ { name: 'messageId', type: 'string', description: 'DLQ message ID' },
699
+ ],
700
+ queryParams: [],
701
+ requestBody: null,
702
+ responseDescription: 'Empty response on success.',
703
+ statuses: [
704
+ { code: 200, description: 'DLQ message deleted' },
705
+ { code: 401, description: 'Unauthorized' },
706
+ { code: 404, description: 'Queue or message not found' },
707
+ ],
708
+ examplePath: '/queue/dlq/delete/order-processing/msg_abc123',
709
+ },
710
+ ],
711
+ };
712
+ export default service;
713
+ //# sourceMappingURL=api-reference.js.map