@simpleapps-com/augur-api 2026.10.30 → 2026.11.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 (361) hide show
  1. package/README.md +84 -33
  2. package/SKILL.md +25 -24
  3. package/dist/client.d.ts +334 -0
  4. package/dist/client.d.ts.map +1 -0
  5. package/dist/core/base-client.d.ts +179 -0
  6. package/dist/core/base-client.d.ts.map +1 -0
  7. package/dist/core/call-rules.d.ts +73 -0
  8. package/dist/core/call-rules.d.ts.map +1 -0
  9. package/dist/core/call.d.ts +48 -0
  10. package/dist/core/call.d.ts.map +1 -0
  11. package/dist/core/client.d.ts +112 -0
  12. package/dist/core/client.d.ts.map +1 -0
  13. package/dist/core/common-schemas.d.ts +522 -0
  14. package/dist/core/common-schemas.d.ts.map +1 -0
  15. package/dist/core/config.d.ts +72 -0
  16. package/dist/core/config.d.ts.map +1 -0
  17. package/dist/core/encoded-segment.d.ts +23 -0
  18. package/dist/core/encoded-segment.d.ts.map +1 -0
  19. package/dist/core/errors.d.ts +91 -0
  20. package/dist/core/errors.d.ts.map +1 -0
  21. package/dist/core/http-rules.d.ts +64 -0
  22. package/dist/core/http-rules.d.ts.map +1 -0
  23. package/dist/core/path-validation.d.ts +28 -0
  24. package/dist/core/path-validation.d.ts.map +1 -0
  25. package/dist/core/proxy-rules.d.ts +21 -0
  26. package/dist/core/proxy-rules.d.ts.map +1 -0
  27. package/dist/core/registry-rules.d.ts +15 -0
  28. package/dist/core/registry-rules.d.ts.map +1 -0
  29. package/dist/core/registry-tables.d.ts +3 -0
  30. package/dist/core/registry-tables.d.ts.map +1 -0
  31. package/dist/core/registry.d.ts +54 -0
  32. package/dist/core/registry.d.ts.map +1 -0
  33. package/dist/core/response-rules.d.ts +19 -0
  34. package/dist/core/response-rules.d.ts.map +1 -0
  35. package/dist/core/schemas.d.ts +70 -0
  36. package/dist/core/schemas.d.ts.map +1 -0
  37. package/dist/core/service-proxy.d.ts +81 -0
  38. package/dist/core/service-proxy.d.ts.map +1 -0
  39. package/dist/core/site-id-check.d.ts +6 -0
  40. package/dist/core/site-id-check.d.ts.map +1 -0
  41. package/dist/core/site-id.d.ts +15 -0
  42. package/dist/core/site-id.d.ts.map +1 -0
  43. package/dist/index.d.ts +71 -236
  44. package/dist/index.d.ts.map +1 -0
  45. package/dist/index.js +19860 -18427
  46. package/dist/index.js.map +1 -1
  47. package/dist/index.mjs +19859 -18427
  48. package/dist/index.mjs.map +1 -1
  49. package/dist/services/agr-info/client.d.ts +71 -0
  50. package/dist/services/agr-info/client.d.ts.map +1 -0
  51. package/dist/services/agr-info/generated/endpoints.d.ts +41 -0
  52. package/dist/services/agr-info/generated/endpoints.d.ts.map +1 -0
  53. package/dist/services/agr-info/generated/schemas.d.ts +297 -0
  54. package/dist/services/agr-info/generated/schemas.d.ts.map +1 -0
  55. package/dist/services/agr-info/generated/types.d.ts +1093 -0
  56. package/dist/services/agr-info/generated/types.d.ts.map +1 -0
  57. package/dist/services/agr-info/index.d.ts +2 -0
  58. package/dist/services/agr-info/index.d.ts.map +1 -0
  59. package/dist/services/agr-int/client.d.ts +100 -0
  60. package/dist/services/agr-int/client.d.ts.map +1 -0
  61. package/dist/services/agr-int/generated/endpoints.d.ts +42 -0
  62. package/dist/services/agr-int/generated/endpoints.d.ts.map +1 -0
  63. package/dist/services/agr-int/generated/schemas.d.ts +595 -0
  64. package/dist/services/agr-int/generated/schemas.d.ts.map +1 -0
  65. package/dist/services/agr-int/generated/types.d.ts +1984 -0
  66. package/dist/services/agr-int/generated/types.d.ts.map +1 -0
  67. package/dist/services/agr-int/index.d.ts +2 -0
  68. package/dist/services/agr-int/index.d.ts.map +1 -0
  69. package/dist/services/agr-site/client.d.ts +112 -0
  70. package/dist/services/agr-site/client.d.ts.map +1 -0
  71. package/dist/services/agr-site/generated/endpoints.d.ts +42 -0
  72. package/dist/services/agr-site/generated/endpoints.d.ts.map +1 -0
  73. package/dist/services/agr-site/generated/schemas.d.ts +537 -0
  74. package/dist/services/agr-site/generated/schemas.d.ts.map +1 -0
  75. package/dist/services/agr-site/generated/types.d.ts +1732 -0
  76. package/dist/services/agr-site/generated/types.d.ts.map +1 -0
  77. package/dist/services/agr-site/index.d.ts +2 -0
  78. package/dist/services/agr-site/index.d.ts.map +1 -0
  79. package/dist/services/agr-work/client.d.ts +23 -0
  80. package/dist/services/agr-work/client.d.ts.map +1 -0
  81. package/dist/services/agr-work/generated/endpoints.d.ts +41 -0
  82. package/dist/services/agr-work/generated/endpoints.d.ts.map +1 -0
  83. package/dist/services/agr-work/generated/schemas.d.ts +21 -0
  84. package/dist/services/agr-work/generated/schemas.d.ts.map +1 -0
  85. package/dist/services/agr-work/generated/types.d.ts +19 -0
  86. package/dist/services/agr-work/generated/types.d.ts.map +1 -0
  87. package/dist/services/agr-work/index.d.ts +2 -0
  88. package/dist/services/agr-work/index.d.ts.map +1 -0
  89. package/dist/services/avalara/client.d.ts +33 -0
  90. package/dist/services/avalara/client.d.ts.map +1 -0
  91. package/dist/services/avalara/generated/endpoints.d.ts +41 -0
  92. package/dist/services/avalara/generated/endpoints.d.ts.map +1 -0
  93. package/dist/services/avalara/generated/schemas.d.ts +22 -0
  94. package/dist/services/avalara/generated/schemas.d.ts.map +1 -0
  95. package/dist/services/avalara/generated/types.d.ts +103 -0
  96. package/dist/services/avalara/generated/types.d.ts.map +1 -0
  97. package/dist/services/avalara/index.d.ts +2 -0
  98. package/dist/services/avalara/index.d.ts.map +1 -0
  99. package/dist/services/basecamp2/client.d.ts +92 -0
  100. package/dist/services/basecamp2/client.d.ts.map +1 -0
  101. package/dist/services/basecamp2/generated/endpoints.d.ts +42 -0
  102. package/dist/services/basecamp2/generated/endpoints.d.ts.map +1 -0
  103. package/dist/services/basecamp2/generated/schemas.d.ts +845 -0
  104. package/dist/services/basecamp2/generated/schemas.d.ts.map +1 -0
  105. package/dist/services/basecamp2/generated/types.d.ts +1587 -0
  106. package/dist/services/basecamp2/generated/types.d.ts.map +1 -0
  107. package/dist/services/basecamp2/index.d.ts +2 -0
  108. package/dist/services/basecamp2/index.d.ts.map +1 -0
  109. package/dist/services/brand-folder/client.d.ts +37 -0
  110. package/dist/services/brand-folder/client.d.ts.map +1 -0
  111. package/dist/services/brand-folder/generated/endpoints.d.ts +41 -0
  112. package/dist/services/brand-folder/generated/endpoints.d.ts.map +1 -0
  113. package/dist/services/brand-folder/generated/schemas.d.ts +81 -0
  114. package/dist/services/brand-folder/generated/schemas.d.ts.map +1 -0
  115. package/dist/services/brand-folder/generated/types.d.ts +195 -0
  116. package/dist/services/brand-folder/generated/types.d.ts.map +1 -0
  117. package/dist/services/brand-folder/index.d.ts +2 -0
  118. package/dist/services/brand-folder/index.d.ts.map +1 -0
  119. package/dist/services/commerce/client.d.ts +57 -0
  120. package/dist/services/commerce/client.d.ts.map +1 -0
  121. package/dist/services/commerce/generated/endpoints.d.ts +42 -0
  122. package/dist/services/commerce/generated/endpoints.d.ts.map +1 -0
  123. package/dist/services/commerce/generated/schemas.d.ts +319 -0
  124. package/dist/services/commerce/generated/schemas.d.ts.map +1 -0
  125. package/dist/services/commerce/generated/types.d.ts +1134 -0
  126. package/dist/services/commerce/generated/types.d.ts.map +1 -0
  127. package/dist/services/commerce/index.d.ts +2 -0
  128. package/dist/services/commerce/index.d.ts.map +1 -0
  129. package/dist/services/customers/client.d.ts +162 -0
  130. package/dist/services/customers/client.d.ts.map +1 -0
  131. package/dist/services/customers/generated/endpoints.d.ts +42 -0
  132. package/dist/services/customers/generated/endpoints.d.ts.map +1 -0
  133. package/dist/services/customers/generated/schemas.d.ts +1970 -0
  134. package/dist/services/customers/generated/schemas.d.ts.map +1 -0
  135. package/dist/services/customers/generated/types.d.ts +3849 -0
  136. package/dist/services/customers/generated/types.d.ts.map +1 -0
  137. package/dist/services/customers/index.d.ts +2 -0
  138. package/dist/services/customers/index.d.ts.map +1 -0
  139. package/dist/services/goog-mc/client.d.ts +44 -0
  140. package/dist/services/goog-mc/client.d.ts.map +1 -0
  141. package/dist/services/goog-mc/generated/endpoints.d.ts +42 -0
  142. package/dist/services/goog-mc/generated/endpoints.d.ts.map +1 -0
  143. package/dist/services/goog-mc/generated/schemas.d.ts +175 -0
  144. package/dist/services/goog-mc/generated/schemas.d.ts.map +1 -0
  145. package/dist/services/goog-mc/generated/types.d.ts +361 -0
  146. package/dist/services/goog-mc/generated/types.d.ts.map +1 -0
  147. package/dist/services/goog-mc/index.d.ts +2 -0
  148. package/dist/services/goog-mc/index.d.ts.map +1 -0
  149. package/dist/services/gregorovich/client.d.ts +34 -0
  150. package/dist/services/gregorovich/client.d.ts.map +1 -0
  151. package/dist/services/gregorovich/generated/endpoints.d.ts +42 -0
  152. package/dist/services/gregorovich/generated/endpoints.d.ts.map +1 -0
  153. package/dist/services/gregorovich/generated/schemas.d.ts +35 -0
  154. package/dist/services/gregorovich/generated/schemas.d.ts.map +1 -0
  155. package/dist/services/gregorovich/generated/types.d.ts +70 -0
  156. package/dist/services/gregorovich/generated/types.d.ts.map +1 -0
  157. package/dist/services/gregorovich/index.d.ts +2 -0
  158. package/dist/services/gregorovich/index.d.ts.map +1 -0
  159. package/dist/services/items/client.d.ts +453 -0
  160. package/dist/services/items/client.d.ts.map +1 -0
  161. package/dist/services/items/generated/endpoints.d.ts +42 -0
  162. package/dist/services/items/generated/endpoints.d.ts.map +1 -0
  163. package/dist/services/items/generated/schemas.d.ts +4636 -0
  164. package/dist/services/items/generated/schemas.d.ts.map +1 -0
  165. package/dist/services/items/generated/types.d.ts +10513 -0
  166. package/dist/services/items/generated/types.d.ts.map +1 -0
  167. package/dist/services/items/index.d.ts +2 -0
  168. package/dist/services/items/index.d.ts.map +1 -0
  169. package/dist/services/joomla/client.d.ts +74 -0
  170. package/dist/services/joomla/client.d.ts.map +1 -0
  171. package/dist/services/joomla/generated/endpoints.d.ts +41 -0
  172. package/dist/services/joomla/generated/endpoints.d.ts.map +1 -0
  173. package/dist/services/joomla/generated/schemas.d.ts +546 -0
  174. package/dist/services/joomla/generated/schemas.d.ts.map +1 -0
  175. package/dist/services/joomla/generated/types.d.ts +1489 -0
  176. package/dist/services/joomla/generated/types.d.ts.map +1 -0
  177. package/dist/services/joomla/index.d.ts +2 -0
  178. package/dist/services/joomla/index.d.ts.map +1 -0
  179. package/dist/services/legacy/client.d.ts +75 -0
  180. package/dist/services/legacy/client.d.ts.map +1 -0
  181. package/dist/services/legacy/generated/endpoints.d.ts +41 -0
  182. package/dist/services/legacy/generated/endpoints.d.ts.map +1 -0
  183. package/dist/services/legacy/generated/schemas.d.ts +567 -0
  184. package/dist/services/legacy/generated/schemas.d.ts.map +1 -0
  185. package/dist/services/legacy/generated/types.d.ts +1454 -0
  186. package/dist/services/legacy/generated/types.d.ts.map +1 -0
  187. package/dist/services/legacy/index.d.ts +2 -0
  188. package/dist/services/legacy/index.d.ts.map +1 -0
  189. package/dist/services/logistics/client.d.ts +64 -0
  190. package/dist/services/logistics/client.d.ts.map +1 -0
  191. package/dist/services/logistics/generated/endpoints.d.ts +41 -0
  192. package/dist/services/logistics/generated/endpoints.d.ts.map +1 -0
  193. package/dist/services/logistics/generated/schemas.d.ts +375 -0
  194. package/dist/services/logistics/generated/schemas.d.ts.map +1 -0
  195. package/dist/services/logistics/generated/types.d.ts +925 -0
  196. package/dist/services/logistics/generated/types.d.ts.map +1 -0
  197. package/dist/services/logistics/index.d.ts +2 -0
  198. package/dist/services/logistics/index.d.ts.map +1 -0
  199. package/dist/services/markets/client.d.ts +47 -0
  200. package/dist/services/markets/client.d.ts.map +1 -0
  201. package/dist/services/markets/generated/endpoints.d.ts +41 -0
  202. package/dist/services/markets/generated/endpoints.d.ts.map +1 -0
  203. package/dist/services/markets/generated/schemas.d.ts +180 -0
  204. package/dist/services/markets/generated/schemas.d.ts.map +1 -0
  205. package/dist/services/markets/generated/types.d.ts +405 -0
  206. package/dist/services/markets/generated/types.d.ts.map +1 -0
  207. package/dist/services/markets/index.d.ts +2 -0
  208. package/dist/services/markets/index.d.ts.map +1 -0
  209. package/dist/services/notifications/client.d.ts +58 -0
  210. package/dist/services/notifications/client.d.ts.map +1 -0
  211. package/dist/services/notifications/generated/endpoints.d.ts +41 -0
  212. package/dist/services/notifications/generated/endpoints.d.ts.map +1 -0
  213. package/dist/services/notifications/generated/schemas.d.ts +247 -0
  214. package/dist/services/notifications/generated/schemas.d.ts.map +1 -0
  215. package/dist/services/notifications/generated/types.d.ts +666 -0
  216. package/dist/services/notifications/generated/types.d.ts.map +1 -0
  217. package/dist/services/notifications/index.d.ts +2 -0
  218. package/dist/services/notifications/index.d.ts.map +1 -0
  219. package/dist/services/open-search/client.d.ts +69 -0
  220. package/dist/services/open-search/client.d.ts.map +1 -0
  221. package/dist/services/open-search/generated/endpoints.d.ts +42 -0
  222. package/dist/services/open-search/generated/endpoints.d.ts.map +1 -0
  223. package/dist/services/open-search/generated/schemas.d.ts +363 -0
  224. package/dist/services/open-search/generated/schemas.d.ts.map +1 -0
  225. package/dist/services/open-search/generated/types.d.ts +983 -0
  226. package/dist/services/open-search/generated/types.d.ts.map +1 -0
  227. package/dist/services/open-search/index.d.ts +2 -0
  228. package/dist/services/open-search/index.d.ts.map +1 -0
  229. package/dist/services/orders/client.d.ts +180 -0
  230. package/dist/services/orders/client.d.ts.map +1 -0
  231. package/dist/services/orders/generated/endpoints.d.ts +42 -0
  232. package/dist/services/orders/generated/endpoints.d.ts.map +1 -0
  233. package/dist/services/orders/generated/schemas.d.ts +2479 -0
  234. package/dist/services/orders/generated/schemas.d.ts.map +1 -0
  235. package/dist/services/orders/generated/types.d.ts +4717 -0
  236. package/dist/services/orders/generated/types.d.ts.map +1 -0
  237. package/dist/services/orders/index.d.ts +2 -0
  238. package/dist/services/orders/index.d.ts.map +1 -0
  239. package/dist/services/p21-apis/client.d.ts +59 -0
  240. package/dist/services/p21-apis/client.d.ts.map +1 -0
  241. package/dist/services/p21-apis/generated/endpoints.d.ts +41 -0
  242. package/dist/services/p21-apis/generated/endpoints.d.ts.map +1 -0
  243. package/dist/services/p21-apis/generated/schemas.d.ts +46 -0
  244. package/dist/services/p21-apis/generated/schemas.d.ts.map +1 -0
  245. package/dist/services/p21-apis/generated/types.d.ts +246 -0
  246. package/dist/services/p21-apis/generated/types.d.ts.map +1 -0
  247. package/dist/services/p21-apis/index.d.ts +2 -0
  248. package/dist/services/p21-apis/index.d.ts.map +1 -0
  249. package/dist/services/p21-core/client.d.ts +131 -0
  250. package/dist/services/p21-core/client.d.ts.map +1 -0
  251. package/dist/services/p21-core/generated/endpoints.d.ts +42 -0
  252. package/dist/services/p21-core/generated/endpoints.d.ts.map +1 -0
  253. package/dist/services/p21-core/generated/schemas.d.ts +1478 -0
  254. package/dist/services/p21-core/generated/schemas.d.ts.map +1 -0
  255. package/dist/services/p21-core/generated/types.d.ts +2718 -0
  256. package/dist/services/p21-core/generated/types.d.ts.map +1 -0
  257. package/dist/services/p21-core/index.d.ts +2 -0
  258. package/dist/services/p21-core/index.d.ts.map +1 -0
  259. package/dist/services/p21-pim/client.d.ts +75 -0
  260. package/dist/services/p21-pim/client.d.ts.map +1 -0
  261. package/dist/services/p21-pim/generated/endpoints.d.ts +41 -0
  262. package/dist/services/p21-pim/generated/endpoints.d.ts.map +1 -0
  263. package/dist/services/p21-pim/generated/schemas.d.ts +383 -0
  264. package/dist/services/p21-pim/generated/schemas.d.ts.map +1 -0
  265. package/dist/services/p21-pim/generated/types.d.ts +933 -0
  266. package/dist/services/p21-pim/generated/types.d.ts.map +1 -0
  267. package/dist/services/p21-pim/index.d.ts +2 -0
  268. package/dist/services/p21-pim/index.d.ts.map +1 -0
  269. package/dist/services/p21-sism/client.d.ts +432 -0
  270. package/dist/services/p21-sism/client.d.ts.map +1 -0
  271. package/dist/services/p21-sism/generated/endpoints.d.ts +42 -0
  272. package/dist/services/p21-sism/generated/endpoints.d.ts.map +1 -0
  273. package/dist/services/p21-sism/generated/schemas.d.ts +2844 -0
  274. package/dist/services/p21-sism/generated/schemas.d.ts.map +1 -0
  275. package/dist/services/p21-sism/generated/types.d.ts +6977 -0
  276. package/dist/services/p21-sism/generated/types.d.ts.map +1 -0
  277. package/dist/services/p21-sism/index.d.ts +37 -0
  278. package/dist/services/p21-sism/index.d.ts.map +1 -0
  279. package/dist/services/payments/client.d.ts +77 -0
  280. package/dist/services/payments/client.d.ts.map +1 -0
  281. package/dist/services/payments/generated/endpoints.d.ts +42 -0
  282. package/dist/services/payments/generated/endpoints.d.ts.map +1 -0
  283. package/dist/services/payments/generated/schemas.d.ts +1015 -0
  284. package/dist/services/payments/generated/schemas.d.ts.map +1 -0
  285. package/dist/services/payments/generated/types.d.ts +1432 -0
  286. package/dist/services/payments/generated/types.d.ts.map +1 -0
  287. package/dist/services/payments/index.d.ts +2 -0
  288. package/dist/services/payments/index.d.ts.map +1 -0
  289. package/dist/services/pricing/client.d.ts +216 -0
  290. package/dist/services/pricing/client.d.ts.map +1 -0
  291. package/dist/services/pricing/generated/endpoints.d.ts +42 -0
  292. package/dist/services/pricing/generated/endpoints.d.ts.map +1 -0
  293. package/dist/services/pricing/generated/schemas.d.ts +2048 -0
  294. package/dist/services/pricing/generated/schemas.d.ts.map +1 -0
  295. package/dist/services/pricing/generated/types.d.ts +4257 -0
  296. package/dist/services/pricing/generated/types.d.ts.map +1 -0
  297. package/dist/services/pricing/index.d.ts +2 -0
  298. package/dist/services/pricing/index.d.ts.map +1 -0
  299. package/dist/services/shipping/client.d.ts +33 -0
  300. package/dist/services/shipping/client.d.ts.map +1 -0
  301. package/dist/services/shipping/generated/endpoints.d.ts +41 -0
  302. package/dist/services/shipping/generated/endpoints.d.ts.map +1 -0
  303. package/dist/services/shipping/generated/schemas.d.ts +29 -0
  304. package/dist/services/shipping/generated/schemas.d.ts.map +1 -0
  305. package/dist/services/shipping/generated/types.d.ts +116 -0
  306. package/dist/services/shipping/generated/types.d.ts.map +1 -0
  307. package/dist/services/shipping/index.d.ts +2 -0
  308. package/dist/services/shipping/index.d.ts.map +1 -0
  309. package/dist/services/smarty-streets/client.d.ts +33 -0
  310. package/dist/services/smarty-streets/client.d.ts.map +1 -0
  311. package/dist/services/smarty-streets/generated/endpoints.d.ts +41 -0
  312. package/dist/services/smarty-streets/generated/endpoints.d.ts.map +1 -0
  313. package/dist/services/smarty-streets/generated/schemas.d.ts +72 -0
  314. package/dist/services/smarty-streets/generated/schemas.d.ts.map +1 -0
  315. package/dist/services/smarty-streets/generated/types.d.ts +145 -0
  316. package/dist/services/smarty-streets/generated/types.d.ts.map +1 -0
  317. package/dist/services/smarty-streets/index.d.ts +2 -0
  318. package/dist/services/smarty-streets/index.d.ts.map +1 -0
  319. package/dist/services/ups/client.d.ts +32 -0
  320. package/dist/services/ups/client.d.ts.map +1 -0
  321. package/dist/services/ups/generated/endpoints.d.ts +40 -0
  322. package/dist/services/ups/generated/endpoints.d.ts.map +1 -0
  323. package/dist/services/ups/generated/schemas.d.ts +51 -0
  324. package/dist/services/ups/generated/schemas.d.ts.map +1 -0
  325. package/dist/services/ups/generated/types.d.ts +98 -0
  326. package/dist/services/ups/generated/types.d.ts.map +1 -0
  327. package/dist/services/ups/index.d.ts +2 -0
  328. package/dist/services/ups/index.d.ts.map +1 -0
  329. package/dist/services/vendors/client.d.ts +38 -0
  330. package/dist/services/vendors/client.d.ts.map +1 -0
  331. package/dist/services/vendors/generated/endpoints.d.ts +41 -0
  332. package/dist/services/vendors/generated/endpoints.d.ts.map +1 -0
  333. package/dist/services/vendors/generated/schemas.d.ts +350 -0
  334. package/dist/services/vendors/generated/schemas.d.ts.map +1 -0
  335. package/dist/services/vendors/generated/types.d.ts +470 -0
  336. package/dist/services/vendors/generated/types.d.ts.map +1 -0
  337. package/dist/services/vendors/index.d.ts +2 -0
  338. package/dist/services/vendors/index.d.ts.map +1 -0
  339. package/dist/services/vmi/client.d.ts +129 -0
  340. package/dist/services/vmi/client.d.ts.map +1 -0
  341. package/dist/services/vmi/generated/endpoints.d.ts +41 -0
  342. package/dist/services/vmi/generated/endpoints.d.ts.map +1 -0
  343. package/dist/services/vmi/generated/schemas.d.ts +723 -0
  344. package/dist/services/vmi/generated/schemas.d.ts.map +1 -0
  345. package/dist/services/vmi/generated/types.d.ts +2620 -0
  346. package/dist/services/vmi/generated/types.d.ts.map +1 -0
  347. package/dist/services/vmi/index.d.ts +2 -0
  348. package/dist/services/vmi/index.d.ts.map +1 -0
  349. package/dist/testing.d.ts +9 -13
  350. package/dist/testing.d.ts.map +1 -0
  351. package/dist/testing.js +7 -17
  352. package/dist/testing.js.map +1 -1
  353. package/dist/testing.mjs +7 -17
  354. package/dist/testing.mjs.map +1 -1
  355. package/dist/utils/cross-site-auth.d.ts +88 -0
  356. package/dist/utils/cross-site-auth.d.ts.map +1 -0
  357. package/package.json +34 -47
  358. package/dist/client-DRpPuvl5.d.mts +0 -58476
  359. package/dist/client-DRpPuvl5.d.ts +0 -58476
  360. package/dist/index.d.mts +0 -236
  361. package/dist/testing.d.mts +0 -83
@@ -0,0 +1,1984 @@
1
+ /**
2
+ * Generated types for the agr-int service.
3
+ * Access control for Augur API users and clients: users, roles, bundles, resources, per-user table
4
+ * access grants, and client credentials
5
+ *
6
+ * Public specs (the source of truth for every shape below):
7
+ * https://agr-int.augur-api.com/endpoints.jsonl: one JSON line per endpoint: method, path, path
8
+ * params and query params, each with type and required flag. Grep it for a path; for a GET
9
+ * that line is all you need. Bodies are not in it.
10
+ * https://agr-int.augur-api.com/openapi.json: the full contract: request and response bodies
11
+ * field by field, descriptions, formats and documented errors.
12
+ * https://agr-int.augur-api.com/llms.txt: the plain-text endpoint list and the other Augur
13
+ * services.
14
+ *
15
+ * Source: shared/specs/agr-int.json
16
+ *
17
+ * DO NOT EDIT — regenerate with: pnpm -C tools/augur-api-generator generate ts
18
+ */
19
+ import type { EdgeCacheParams } from "../../../core/common-schemas";
20
+ import type { BaseResponse } from "../../../core/schemas";
21
+ /** Params for GET /bundles */
22
+ export interface BundlesListParams extends EdgeCacheParams {
23
+ /** Filter by bundle_id slug */
24
+ bundleId?: string;
25
+ /** Filter by bundle_name */
26
+ bundleName?: string;
27
+ /** Limit number of results (Default: 10) */
28
+ limit?: number;
29
+ /** Starting offset for results (Default: 0) */
30
+ offset?: number;
31
+ /** Order By (Default: bundles_uid|ASC) */
32
+ orderBy?: string;
33
+ /**
34
+ * Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
35
+ * (704,705); -1 for every status. Default: 704
36
+ */
37
+ statusCd?: number | number[];
38
+ /** Filter by system_flag [Y|N] */
39
+ systemFlag?: string;
40
+ }
41
+ /** Params for GET /bundles/{bundlesUid} */
42
+ export type BundlesGetParams = EdgeCacheParams;
43
+ /** Params for GET /bundles/{bundlesUid}/resources */
44
+ export interface BundlesResourcesListParams extends EdgeCacheParams {
45
+ /** Limit number of results (Default: 10) */
46
+ limit?: number;
47
+ /** Starting offset for results (Default: 0) */
48
+ offset?: number;
49
+ /** Order By (Default: bundles_x_resources_uid|ASC) */
50
+ orderBy?: string;
51
+ /**
52
+ * Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
53
+ * (704,705); -1 for every status. Default: every status
54
+ */
55
+ statusCd?: number | number[];
56
+ }
57
+ /** Params for GET /bundles/{bundlesUid}/resources/{bundlesXResourcesUid} */
58
+ export type BundlesResourcesGetParams = EdgeCacheParams;
59
+ /** Params for GET /clients */
60
+ export interface ClientsListParams extends EdgeCacheParams {
61
+ /** Limit number of results (Default: 10) */
62
+ limit?: number;
63
+ /** Starting offset for results (Default: 0) */
64
+ offset?: number;
65
+ /** Order By (Default: clients_uid|ASC) */
66
+ orderBy?: string;
67
+ /**
68
+ * Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
69
+ * (704,705); -1 for every status. Default: 704
70
+ */
71
+ statusCd?: number | number[];
72
+ /** Filter by owning users_uid */
73
+ usersUid?: number;
74
+ }
75
+ /** Params for GET /clients/{clientsUid} */
76
+ export type ClientsGetParams = EdgeCacheParams;
77
+ /** Params for GET /resources */
78
+ export interface ResourcesListParams extends EdgeCacheParams {
79
+ /** Limit number of results (Default: 10) */
80
+ limit?: number;
81
+ /** Starting offset for results (Default: 0) */
82
+ offset?: number;
83
+ /** Order By (Default: resources_uid|ASC) */
84
+ orderBy?: string;
85
+ /** Filter by resource_id slug */
86
+ resourceId?: string;
87
+ /** Filter by resource_name */
88
+ resourceName?: string;
89
+ /** Filter by resource_path */
90
+ resourcePath?: string;
91
+ /** Filter by resource_type */
92
+ resourceType?: string;
93
+ /**
94
+ * Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
95
+ * (704,705); -1 for every status. Default: 704
96
+ */
97
+ statusCd?: number | number[];
98
+ }
99
+ /** Params for GET /resources/{resourcesUid} */
100
+ export type ResourcesGetParams = EdgeCacheParams;
101
+ /** Params for GET /roles */
102
+ export interface RolesListParams extends EdgeCacheParams {
103
+ /** Limit number of results (Default: 10) */
104
+ limit?: number;
105
+ /** Starting offset for results (Default: 0) */
106
+ offset?: number;
107
+ /** Order By (Default: roles_uid|ASC) */
108
+ orderBy?: string;
109
+ /** Filter by role_id slug */
110
+ roleId?: string;
111
+ /** Filter by role_name */
112
+ roleName?: string;
113
+ /**
114
+ * Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
115
+ * (704,705); -1 for every status. Default: 704
116
+ */
117
+ statusCd?: number | number[];
118
+ /** Filter by system_flag [Y|N] */
119
+ systemFlag?: string;
120
+ }
121
+ /** Params for GET /roles/{rolesUid} */
122
+ export type RolesGetParams = EdgeCacheParams;
123
+ /** Params for GET /roles/{rolesUid}/bundles */
124
+ export interface RolesBundlesListParams extends EdgeCacheParams {
125
+ /** Limit number of results (Default: 10) */
126
+ limit?: number;
127
+ /** Starting offset for results (Default: 0) */
128
+ offset?: number;
129
+ /** Order By (Default: roles_x_bundles_uid|ASC) */
130
+ orderBy?: string;
131
+ /**
132
+ * Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
133
+ * (704,705); -1 for every status. Default: every status
134
+ */
135
+ statusCd?: number | number[];
136
+ }
137
+ /** Params for GET /roles/{rolesUid}/bundles/{rolesXBundlesUid} */
138
+ export type RolesBundlesGetParams = EdgeCacheParams;
139
+ /** Params for GET /users */
140
+ export interface UsersListParams extends EdgeCacheParams {
141
+ /** Filter by email */
142
+ email?: string;
143
+ /** Limit number of results (Default: 10) */
144
+ limit?: number;
145
+ /** Starting offset for results (Default: 0) */
146
+ offset?: number;
147
+ /** Order By (Default: users_uid|ASC) */
148
+ orderBy?: string;
149
+ /** Filter by phone_number */
150
+ phoneNumber?: string;
151
+ /**
152
+ * Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
153
+ * (704,705); -1 for every status. Default: 704
154
+ */
155
+ statusCd?: number | number[];
156
+ /** Filter by username */
157
+ username?: string;
158
+ }
159
+ /** Params for GET /users/{usersUid} */
160
+ export type UsersGetParams = EdgeCacheParams;
161
+ /** Params for GET /users/{usersUid}/roles */
162
+ export interface UsersRolesListParams extends EdgeCacheParams {
163
+ /** Limit number of results (Default: 10) */
164
+ limit?: number;
165
+ /** Starting offset for results (Default: 0) */
166
+ offset?: number;
167
+ /** Order By (Default: users_x_roles_uid|ASC) */
168
+ orderBy?: string;
169
+ /**
170
+ * Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
171
+ * (704,705); -1 for every status. Default: every status
172
+ */
173
+ statusCd?: number | number[];
174
+ }
175
+ /** Params for GET /users/{usersUid}/roles/{usersXRolesUid} */
176
+ export type UsersRolesGetParams = EdgeCacheParams;
177
+ /**
178
+ * List bundles
179
+ * Response data for GET /bundles — MINIMUM fields, extras pass through
180
+ *
181
+ * Returned by: api.agrInt.bundles.list(params) (array items)
182
+ * Returned by: api.agrInt.bundles.create(data)
183
+ * Returned by: api.agrInt.bundles.get(bundlesUid)
184
+ * Returned by: api.agrInt.bundles.update(bundlesUid, data)
185
+ * Returned by: api.agrInt.bundles.delete(bundlesUid)
186
+ */
187
+ export interface BundlesListItem {
188
+ /** Bundle unique ID; 1-999 are system (manifest) bundles, custom bundles start at 1000 */
189
+ bundlesUid: number;
190
+ /**
191
+ * Bundle slug, derived from bundle_name (caps + snake_case) or the manifest id (max 255 chars)
192
+ */
193
+ bundleId: string;
194
+ /** Bundle display name (max 255 chars) */
195
+ bundleName: string;
196
+ /** Admin-facing description of the bundle (max 255 chars) */
197
+ description: string | null;
198
+ /**
199
+ * Y = system bundle seeded from the augur-graphql manifest (not editable through the API), N =
200
+ * custom bundle (max 1 chars)
201
+ */
202
+ systemFlag: string;
203
+ /** When the row was created (mysql-datetime, e.g. 2025-07-30 15:50:49) */
204
+ dateCreated: string;
205
+ /** When the row was last modified (mysql-datetime, e.g. 2025-07-30 15:50:49) */
206
+ dateLastModified: string;
207
+ /** Update code: 1185 = Import Complete, 704 = needs processing */
208
+ updateCd: number;
209
+ /** Status code: 704 = Active, 705 = Inactive, 700 = Deleted */
210
+ statusCd: number;
211
+ /** Process code: 704 = Active, 705 = Inactive, 700 = Deleted, 1185 = Import Complete */
212
+ processCd: number;
213
+ /** Menu group from the augur-graphql RBAC manifest; null when the bundle has none */
214
+ menuGroup: number | null;
215
+ [key: string]: unknown;
216
+ }
217
+ /** Returned by: api.agrInt.bundles.list(params) */
218
+ export type BundlesListData = BundlesListItem[];
219
+ /**
220
+ * Create a bundle
221
+ * Response data for POST /bundles — MINIMUM fields, extras pass through
222
+ *
223
+ * Returned by: api.agrInt.bundles.create(data)
224
+ */
225
+ export type BundlesCreateData = BundlesListItem;
226
+ /**
227
+ * Create a bundle
228
+ * Request body for POST /bundles — MINIMUM fields, extras pass through
229
+ *
230
+ * Request body of: api.agrInt.bundles.create(data)
231
+ */
232
+ export interface BundlesCreateBody {
233
+ /** Bundle name; the bundle_id slug is derived from it (caps + snake_case) */
234
+ bundleName: string;
235
+ /** Admin-facing description of the bundle */
236
+ description?: string | null;
237
+ /** Status code (704 = Active, 705 = Inactive, 700 = Deleted); defaults to 704 */
238
+ statusCd?: number | null;
239
+ /** Process code; defaults to 704 (Active) */
240
+ processCd?: number | null;
241
+ /** Update code; defaults to 1185 (Import Complete) */
242
+ updateCd?: number | null;
243
+ [key: string]: unknown;
244
+ }
245
+ /**
246
+ * Get a bundle
247
+ * Response data for GET /bundles/{bundlesUid} — MINIMUM fields, extras pass through
248
+ *
249
+ * Returned by: api.agrInt.bundles.get(bundlesUid)
250
+ */
251
+ export type BundlesGetData = BundlesListItem;
252
+ /**
253
+ * Update a bundle
254
+ * Response data for PUT /bundles/{bundlesUid} — MINIMUM fields, extras pass through
255
+ *
256
+ * Returned by: api.agrInt.bundles.update(bundlesUid, data)
257
+ */
258
+ export type BundlesUpdateData = BundlesListItem;
259
+ /**
260
+ * Update a bundle
261
+ * Request body for PUT /bundles/{bundlesUid} — MINIMUM fields, extras pass through
262
+ *
263
+ * Request body of: api.agrInt.bundles.update(bundlesUid, data)
264
+ */
265
+ export interface BundlesUpdateBody {
266
+ /** New bundle name; a non-blank value also re-derives bundle_id */
267
+ bundleName?: string | null;
268
+ /** New admin-facing description */
269
+ description?: string | null;
270
+ /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
271
+ statusCd?: number | null;
272
+ /** Process code */
273
+ processCd?: number | null;
274
+ /** Update code */
275
+ updateCd?: number | null;
276
+ [key: string]: unknown;
277
+ }
278
+ /**
279
+ * Soft-delete a bundle
280
+ * Response data for DELETE /bundles/{bundlesUid} — MINIMUM fields, extras pass through
281
+ *
282
+ * Returned by: api.agrInt.bundles.delete(bundlesUid)
283
+ */
284
+ export type BundlesDeleteData = BundlesListItem;
285
+ /**
286
+ * List bundle-resource grants
287
+ * Response data for GET /bundles/{bundlesUid}/resources — MINIMUM fields, extras pass through
288
+ *
289
+ * Returned by: api.agrInt.bundles.resources.list(bundlesUid, params) (array items)
290
+ * Returned by: api.agrInt.bundles.resources.create(bundlesUid, data)
291
+ * Returned by: api.agrInt.bundles.resources.get(bundlesUid, bundlesXResourcesUid)
292
+ * Returned by: api.agrInt.bundles.resources.update(bundlesUid, bundlesXResourcesUid, data)
293
+ * Returned by: api.agrInt.bundles.resources.delete(bundlesUid, bundlesXResourcesUid)
294
+ */
295
+ export interface BundlesResourcesListItem {
296
+ /** Bundle-resource grant unique ID */
297
+ bundlesXResourcesUid: number;
298
+ /** Bundle that holds the grant */
299
+ bundlesUid: number;
300
+ /** Resource the bundle is granted */
301
+ resourcesUid: number;
302
+ /** Read grant: 1390 = Allow All, 1391 = Allow None */
303
+ readCd: number;
304
+ /** Write grant: 1390 = Allow All, 1391 = Allow None */
305
+ writeCd: number;
306
+ /** Execute grant: 1390 = Allow All, 1391 = Allow None */
307
+ executeCd: number;
308
+ /** When the row was created (mysql-datetime, e.g. 2025-07-30 15:50:49) */
309
+ dateCreated: string;
310
+ /** When the row was last modified (mysql-datetime, e.g. 2025-07-30 15:50:49) */
311
+ dateLastModified: string;
312
+ /** Update code: 1185 = Import Complete, 704 = needs processing */
313
+ updateCd: number;
314
+ /** Status code: 704 = Active, 705 = Inactive, 700 = Deleted */
315
+ statusCd: number;
316
+ /** Process code: 704 = Active, 705 = Inactive, 700 = Deleted, 1185 = Import Complete */
317
+ processCd: number;
318
+ [key: string]: unknown;
319
+ }
320
+ /** Returned by: api.agrInt.bundles.resources.list(bundlesUid, params) */
321
+ export type BundlesResourcesListData = BundlesResourcesListItem[];
322
+ /**
323
+ * Grant or reactivate a bundle-resource grant
324
+ * Response data for POST /bundles/{bundlesUid}/resources — MINIMUM fields, extras pass through
325
+ *
326
+ * Returned by: api.agrInt.bundles.resources.create(bundlesUid, data)
327
+ */
328
+ export type BundlesResourcesCreateData = BundlesResourcesListItem;
329
+ /**
330
+ * Grant or reactivate a bundle-resource grant
331
+ * Request body for POST /bundles/{bundlesUid}/resources — MINIMUM fields, extras pass through
332
+ *
333
+ * Request body of: api.agrInt.bundles.resources.create(bundlesUid, data)
334
+ */
335
+ export interface BundlesResourcesCreateBody {
336
+ /** Resource to grant; the bundle comes from the path */
337
+ resourcesUid: number;
338
+ /** Read grant: 1390 = Allow All, 1391 = Allow None; anything else becomes 1391 */
339
+ readCd?: number | null;
340
+ /** Write grant: 1390 = Allow All, 1391 = Allow None; anything else becomes 1391 */
341
+ writeCd?: number | null;
342
+ /** Execute grant: 1390 = Allow All, 1391 = Allow None; anything else becomes 1391 */
343
+ executeCd?: number | null;
344
+ [key: string]: unknown;
345
+ }
346
+ /**
347
+ * Get a bundle-resource grant
348
+ * Response data for GET /bundles/{bundlesUid}/resources/{bundlesXResourcesUid} — MINIMUM fields,
349
+ * extras pass through
350
+ *
351
+ * Returned by: api.agrInt.bundles.resources.get(bundlesUid, bundlesXResourcesUid)
352
+ */
353
+ export type BundlesResourcesGetData = BundlesResourcesListItem;
354
+ /**
355
+ * Update a bundle-resource grant
356
+ * Response data for PUT /bundles/{bundlesUid}/resources/{bundlesXResourcesUid} — MINIMUM fields,
357
+ * extras pass through
358
+ *
359
+ * Returned by: api.agrInt.bundles.resources.update(bundlesUid, bundlesXResourcesUid, data)
360
+ */
361
+ export type BundlesResourcesUpdateData = BundlesResourcesListItem;
362
+ /**
363
+ * Update a bundle-resource grant
364
+ * Request body for PUT /bundles/{bundlesUid}/resources/{bundlesXResourcesUid} — MINIMUM fields,
365
+ * extras pass through
366
+ *
367
+ * Request body of: api.agrInt.bundles.resources.update(bundlesUid, bundlesXResourcesUid, data)
368
+ */
369
+ export interface BundlesResourcesUpdateBody {
370
+ /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
371
+ statusCd?: number | null;
372
+ /** Process code (704 = Active, 705 = Inactive, 700 = Deleted, 1185 = Import Complete) */
373
+ processCd?: number | null;
374
+ /** Read grant: 1390 = Allow All, 1391 = Allow None */
375
+ readCd?: number | null;
376
+ /** Write grant: 1390 = Allow All, 1391 = Allow None */
377
+ writeCd?: number | null;
378
+ /** Execute grant: 1390 = Allow All, 1391 = Allow None */
379
+ executeCd?: number | null;
380
+ [key: string]: unknown;
381
+ }
382
+ /**
383
+ * Revoke a bundle-resource grant
384
+ * Response data for DELETE /bundles/{bundlesUid}/resources/{bundlesXResourcesUid} — MINIMUM fields,
385
+ * extras pass through
386
+ *
387
+ * Returned by: api.agrInt.bundles.resources.delete(bundlesUid, bundlesXResourcesUid)
388
+ */
389
+ export type BundlesResourcesDeleteData = BundlesResourcesListItem;
390
+ /**
391
+ * List clients
392
+ * Response data for GET /clients — MINIMUM fields, extras pass through
393
+ *
394
+ * Returned by: api.agrInt.clients.list(params) (array items)
395
+ * Returned by: api.agrInt.clients.update(clientsUid, data)
396
+ * Returned by: api.agrInt.clients.delete(clientsUid)
397
+ */
398
+ export interface ClientsListItem {
399
+ /** Client credential unique ID */
400
+ clientsUid: number;
401
+ /**
402
+ * Public client identifier (agrc_ prefix), encrypted under the site secret key (max 255 chars)
403
+ */
404
+ clientId: string;
405
+ /** agr_int user the credential acts as; it gets exactly this user's resources */
406
+ usersUid: number;
407
+ /** Site secret key version the client_id was issued under; MUST match on verify */
408
+ keyVersion: number;
409
+ /** Admin-facing label, e.g. the connector name (max 255 chars) */
410
+ clientName: string;
411
+ /** Admin-facing notes (max 1000 chars) */
412
+ description: string | null;
413
+ /** ID of the admin whose bearer issued the credential; null when issued from the CLI */
414
+ issuedById: number | null;
415
+ /**
416
+ * Username of the admin who issued the credential; null when issued from the CLI (max 255 chars)
417
+ */
418
+ issuedByUsername: string | null;
419
+ /** ID of the admin who retired the credential; null while active or when retired from the CLI */
420
+ retiredById: number | null;
421
+ /**
422
+ * Username of the admin who retired the credential; null while active or when retired from the
423
+ * CLI (max 255 chars)
424
+ */
425
+ retiredByUsername: string | null;
426
+ /**
427
+ * When the credential last authenticated; null if never used (mysql-datetime, e.g. 2025-07-30
428
+ * 15:50:49)
429
+ */
430
+ dateLastUsed: string | null;
431
+ /** When the row was created (mysql-datetime, e.g. 2025-07-30 15:50:49) */
432
+ dateCreated: string;
433
+ /** When the row was last modified (mysql-datetime, e.g. 2025-07-30 15:50:49) */
434
+ dateLastModified: string;
435
+ /** Update code: 1185 = Import Complete, 704 = needs processing */
436
+ updateCd: number;
437
+ /** Status code: 704 = Active, 705 = Inactive, 700 = Deleted */
438
+ statusCd: number;
439
+ /** Process code: 704 = Active, 705 = Inactive, 700 = Deleted, 1185 = Import Complete */
440
+ processCd: number;
441
+ [key: string]: unknown;
442
+ }
443
+ /** Returned by: api.agrInt.clients.list(params) */
444
+ export type ClientsListData = ClientsListItem[];
445
+ /**
446
+ * Issue a client
447
+ * Response data for POST /clients — MINIMUM fields, extras pass through
448
+ *
449
+ * Returned by: api.agrInt.clients.create(data)
450
+ */
451
+ export interface ClientsCreateData {
452
+ /** Client credential unique ID; 0 when issuing failed */
453
+ clientsUid: number;
454
+ /** Public client identifier (agrc_ prefix) */
455
+ clientId: string;
456
+ /** agr_int user the credential acts as */
457
+ usersUid: number;
458
+ /** Site secret key version the client_id was issued under */
459
+ keyVersion: number;
460
+ /** Admin-facing label, e.g. the connector name */
461
+ clientName: string;
462
+ /** Admin-facing notes */
463
+ description: string | null;
464
+ /** ID of the admin who issued the credential; null when issued from the CLI */
465
+ issuedById: number | null;
466
+ /** Username of the admin who issued the credential */
467
+ issuedByUsername: string | null;
468
+ /** Status code: 704 = Active */
469
+ statusCd: number;
470
+ /** Full bearer string agrc_<clientId>.<secret><crc32> */
471
+ credential: string;
472
+ [key: string]: unknown;
473
+ }
474
+ /**
475
+ * Issue a client
476
+ * Request body for POST /clients — MINIMUM fields, extras pass through
477
+ *
478
+ * Request body of: api.agrInt.clients.create(data)
479
+ */
480
+ export interface ClientsCreateBody {
481
+ /**
482
+ * Owning agr_int user; MUST exist and be ACTIVE, and the credential gets exactly this user's
483
+ * resources
484
+ */
485
+ usersUid: number | null;
486
+ /** Admin-facing label, e.g. the connector name; MUST NOT be blank */
487
+ clientName: string | null;
488
+ /** Admin-facing notes */
489
+ description?: string | null;
490
+ [key: string]: unknown;
491
+ }
492
+ /**
493
+ * Validate a client credential
494
+ * Response data for POST /clients/validate — MINIMUM fields, extras pass through
495
+ *
496
+ * Returned by: api.agrInt.clients.validate.create(data)
497
+ */
498
+ export interface ClientsValidateCreateData {
499
+ /** True only when the credential decrypts, matches, and its client and user are ACTIVE */
500
+ valid: boolean;
501
+ /** Site decrypted from the client_id; consumers MUST scope the connection to it */
502
+ siteId: string;
503
+ /** Always "client" for a valid credential */
504
+ tokenUse: string;
505
+ /** Client credential unique ID */
506
+ clientUid: number;
507
+ /** Public client identifier (agrc_ prefix) */
508
+ clientId: string;
509
+ /** agr_int user the credential acts as */
510
+ usersUid: number;
511
+ /** Username of that user */
512
+ username: string;
513
+ /** Active role ids the owning user holds */
514
+ roles: string[];
515
+ /** Active bundle ids granted through those roles */
516
+ bundles: string[];
517
+ /** P21 table set (resources.resource_path) the credential may query */
518
+ resources: string[];
519
+ [key: string]: unknown;
520
+ }
521
+ /**
522
+ * Validate a client credential
523
+ * Request body for POST /clients/validate — MINIMUM fields, extras pass through
524
+ *
525
+ * Request body of: api.agrInt.clients.validate.create(data)
526
+ */
527
+ export interface ClientsValidateCreateBody {
528
+ /**
529
+ * Bearer form agrc_<clientId>.<secret><crc32>; when non-blank it wins over clientId and secret
530
+ */
531
+ credential?: string;
532
+ /** The client_id, with or without the agrc_ prefix */
533
+ clientId?: string;
534
+ /** The cleartext secret; MAY carry the trailing 8-hex checksum */
535
+ secret?: string;
536
+ [key: string]: unknown;
537
+ }
538
+ /**
539
+ * Get a client
540
+ * Response data for GET /clients/{clientsUid} — MINIMUM fields, extras pass through
541
+ *
542
+ * Returned by: api.agrInt.clients.get(clientsUid)
543
+ */
544
+ export interface ClientsGetData {
545
+ /** Client credential unique ID */
546
+ clientsUid: number;
547
+ /** Public client identifier (agrc_ prefix) */
548
+ clientId: string;
549
+ /** Re-derived 43-char client secret; '' when the credential is not revealable */
550
+ clientSecret: string;
551
+ /** agr_int user the credential acts as */
552
+ usersUid: number;
553
+ /** Site secret key version the client_id was issued under */
554
+ keyVersion: number;
555
+ /** Admin-facing label, e.g. the connector name */
556
+ clientName: string;
557
+ /** Admin-facing notes */
558
+ description: string | null;
559
+ /** ID of the admin who issued the credential; null when issued from the CLI */
560
+ issuedById: number | null;
561
+ /** Username of the admin who issued the credential */
562
+ issuedByUsername: string | null;
563
+ /** ID of the admin who retired the credential; null while active */
564
+ retiredById: number | null;
565
+ /** Username of the admin who retired the credential */
566
+ retiredByUsername: string | null;
567
+ /** When the credential last authenticated (Y-m-d H:i:s); null if never used */
568
+ dateLastUsed: string | null;
569
+ /** When the credential was issued (Y-m-d H:i:s) */
570
+ dateCreated: string;
571
+ /** When the credential was last modified (Y-m-d H:i:s) */
572
+ dateLastModified: string;
573
+ /** Update code (1185 = Import Complete) */
574
+ updateCd: number;
575
+ /** Status code: 704 = Active, 705 = Inactive, 700 = Retired */
576
+ statusCd: number;
577
+ /** Process code */
578
+ processCd: number;
579
+ /** Full bearer string agrc_<clientId>.<secret><crc32>; '' when not revealable */
580
+ credential: string;
581
+ [key: string]: unknown;
582
+ }
583
+ /**
584
+ * Update a client
585
+ * Response data for PUT /clients/{clientsUid} — MINIMUM fields, extras pass through
586
+ *
587
+ * Returned by: api.agrInt.clients.update(clientsUid, data)
588
+ */
589
+ export type ClientsUpdateData = ClientsListItem;
590
+ /**
591
+ * Update a client
592
+ * Request body for PUT /clients/{clientsUid} — MINIMUM fields, extras pass through
593
+ *
594
+ * Request body of: api.agrInt.clients.update(clientsUid, data)
595
+ */
596
+ export interface ClientsUpdateBody {
597
+ /** New admin-facing label; blank is ignored */
598
+ clientName?: string | null;
599
+ /** New admin-facing notes; blank clears it */
600
+ description?: string | null;
601
+ /**
602
+ * Status code: 704 = Active, 705 = Inactive, 700 = Retire (terminal); any other value refuses the
603
+ * update
604
+ */
605
+ statusCd?: number | null;
606
+ /**
607
+ * Process code (704 = Active, 705 = Inactive, 700 = Deleted, 1185 = Import Complete); any other
608
+ * value refuses the update
609
+ */
610
+ processCd?: number | null;
611
+ /**
612
+ * Update code (1185 = Import Complete, 704 = Active, 705 = Inactive, 700 = Deleted); any other
613
+ * value refuses the update
614
+ */
615
+ updateCd?: number | null;
616
+ [key: string]: unknown;
617
+ }
618
+ /**
619
+ * Retire a client
620
+ * Response data for DELETE /clients/{clientsUid} — MINIMUM fields, extras pass through
621
+ *
622
+ * Returned by: api.agrInt.clients.delete(clientsUid)
623
+ */
624
+ export type ClientsDeleteData = ClientsListItem;
625
+ /**
626
+ * List resources
627
+ * Response data for GET /resources — MINIMUM fields, extras pass through
628
+ *
629
+ * Returned by: api.agrInt.resources.list(params) (array items)
630
+ * Returned by: api.agrInt.resources.get(resourcesUid)
631
+ */
632
+ export interface ResourcesListItem {
633
+ /** Resource unique ID */
634
+ resourcesUid: number;
635
+ /** Resource slug (caps + snake_case), derived from the manifest table name (max 255 chars) */
636
+ resourceId: string;
637
+ /** Resource display name (max 255 chars) */
638
+ resourceName: string;
639
+ /** Kind of resource; currently always table (max 255 chars) */
640
+ resourceType: string;
641
+ /** What the resource grants access to; for a table, the P21 table name (max 255 chars) */
642
+ resourcePath: string;
643
+ /** Admin-facing description of the resource (max 255 chars) */
644
+ description: string | null;
645
+ /** When the row was created (mysql-datetime, e.g. 2025-07-30 15:50:49) */
646
+ dateCreated: string;
647
+ /** When the row was last modified (mysql-datetime, e.g. 2025-07-30 15:50:49) */
648
+ dateLastModified: string;
649
+ /** Update code: 1185 = Import Complete, 704 = needs processing */
650
+ updateCd: number;
651
+ /** Status code: 704 = Active, 705 = Inactive, 700 = Deleted */
652
+ statusCd: number;
653
+ /** Process code: 704 = Active, 705 = Inactive, 700 = Deleted, 1185 = Import Complete */
654
+ processCd: number;
655
+ [key: string]: unknown;
656
+ }
657
+ /** Returned by: api.agrInt.resources.list(params) */
658
+ export type ResourcesListData = ResourcesListItem[];
659
+ /**
660
+ * Get a resource
661
+ * Response data for GET /resources/{resourcesUid} — MINIMUM fields, extras pass through
662
+ *
663
+ * Returned by: api.agrInt.resources.get(resourcesUid)
664
+ */
665
+ export type ResourcesGetData = ResourcesListItem;
666
+ /**
667
+ * List roles
668
+ * Response data for GET /roles — MINIMUM fields, extras pass through
669
+ *
670
+ * Returned by: api.agrInt.roles.list(params) (array items)
671
+ * Returned by: api.agrInt.roles.create(data)
672
+ * Returned by: api.agrInt.roles.get(rolesUid)
673
+ * Returned by: api.agrInt.roles.update(rolesUid, data)
674
+ * Returned by: api.agrInt.roles.delete(rolesUid)
675
+ */
676
+ export interface RolesListItem {
677
+ /** Role unique ID; 1-999 are system roles (1 = Full Access), custom roles start at 1000 */
678
+ rolesUid: number;
679
+ /** Role slug, derived from role_name (caps + snake_case) (max 255 chars) */
680
+ roleId: string;
681
+ /** Role display name (max 255 chars) */
682
+ roleName: string;
683
+ /** Admin-facing description of the role (max 255 chars) */
684
+ description: string | null;
685
+ /** Y = system role (not editable through the API), N = custom role (max 1 chars) */
686
+ systemFlag: string;
687
+ /** When the row was created (mysql-datetime, e.g. 2025-07-30 15:50:49) */
688
+ dateCreated: string;
689
+ /** When the row was last modified (mysql-datetime, e.g. 2025-07-30 15:50:49) */
690
+ dateLastModified: string;
691
+ /** Update code: 1185 = Import Complete, 704 = needs processing */
692
+ updateCd: number;
693
+ /** Status code: 704 = Active, 705 = Inactive, 700 = Deleted */
694
+ statusCd: number;
695
+ /** Process code: 704 = Active, 705 = Inactive, 700 = Deleted, 1185 = Import Complete */
696
+ processCd: number;
697
+ [key: string]: unknown;
698
+ }
699
+ /** Returned by: api.agrInt.roles.list(params) */
700
+ export type RolesListData = RolesListItem[];
701
+ /**
702
+ * Create a role
703
+ * Response data for POST /roles — MINIMUM fields, extras pass through
704
+ *
705
+ * Returned by: api.agrInt.roles.create(data)
706
+ */
707
+ export type RolesCreateData = RolesListItem;
708
+ /**
709
+ * Create a role
710
+ * Request body for POST /roles — MINIMUM fields, extras pass through
711
+ *
712
+ * Request body of: api.agrInt.roles.create(data)
713
+ */
714
+ export interface RolesCreateBody {
715
+ /** Role name; the role_id slug is derived from it (caps + snake_case) */
716
+ roleName: string;
717
+ /** Admin-facing description of the role */
718
+ description?: string | null;
719
+ /** Status code (704 = Active, 705 = Inactive, 700 = Deleted); defaults to 704 */
720
+ statusCd?: number | null;
721
+ /** Process code; defaults to 704 (Active) */
722
+ processCd?: number | null;
723
+ /** Update code; defaults to 1185 (Import Complete) */
724
+ updateCd?: number | null;
725
+ [key: string]: unknown;
726
+ }
727
+ /**
728
+ * Get a role
729
+ * Response data for GET /roles/{rolesUid} — MINIMUM fields, extras pass through
730
+ *
731
+ * Returned by: api.agrInt.roles.get(rolesUid)
732
+ */
733
+ export type RolesGetData = RolesListItem;
734
+ /**
735
+ * Update a role
736
+ * Response data for PUT /roles/{rolesUid} — MINIMUM fields, extras pass through
737
+ *
738
+ * Returned by: api.agrInt.roles.update(rolesUid, data)
739
+ */
740
+ export type RolesUpdateData = RolesListItem;
741
+ /**
742
+ * Update a role
743
+ * Request body for PUT /roles/{rolesUid} — MINIMUM fields, extras pass through
744
+ *
745
+ * Request body of: api.agrInt.roles.update(rolesUid, data)
746
+ */
747
+ export interface RolesUpdateBody {
748
+ /** New role name; a non-blank value also re-derives role_id */
749
+ roleName?: string | null;
750
+ /** New admin-facing description */
751
+ description?: string | null;
752
+ /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
753
+ statusCd?: number | null;
754
+ /** Process code */
755
+ processCd?: number | null;
756
+ /** Update code */
757
+ updateCd?: number | null;
758
+ [key: string]: unknown;
759
+ }
760
+ /**
761
+ * Soft-delete a role
762
+ * Response data for DELETE /roles/{rolesUid} — MINIMUM fields, extras pass through
763
+ *
764
+ * Returned by: api.agrInt.roles.delete(rolesUid)
765
+ */
766
+ export type RolesDeleteData = RolesListItem;
767
+ /**
768
+ * List role-bundle memberships
769
+ * Response data for GET /roles/{rolesUid}/bundles — MINIMUM fields, extras pass through
770
+ *
771
+ * Returned by: api.agrInt.roles.bundles.list(rolesUid, params) (array items)
772
+ * Returned by: api.agrInt.roles.bundles.create(rolesUid, data)
773
+ * Returned by: api.agrInt.roles.bundles.get(rolesUid, rolesXBundlesUid)
774
+ * Returned by: api.agrInt.roles.bundles.update(rolesUid, rolesXBundlesUid, data)
775
+ * Returned by: api.agrInt.roles.bundles.delete(rolesUid, rolesXBundlesUid)
776
+ */
777
+ export interface RolesBundlesListItem {
778
+ /** Role-bundle membership unique ID */
779
+ rolesXBundlesUid: number;
780
+ /** Role that holds the bundle */
781
+ rolesUid: number;
782
+ /** Bundle assigned to the role */
783
+ bundlesUid: number;
784
+ /** When the row was created (mysql-datetime, e.g. 2025-07-30 15:50:49) */
785
+ dateCreated: string;
786
+ /** When the row was last modified (mysql-datetime, e.g. 2025-07-30 15:50:49) */
787
+ dateLastModified: string;
788
+ /** Update code: 1185 = Import Complete, 704 = needs processing */
789
+ updateCd: number;
790
+ /** Status code: 704 = Active, 705 = Inactive, 700 = Deleted */
791
+ statusCd: number;
792
+ /** Process code: 704 = Active, 705 = Inactive, 700 = Deleted, 1185 = Import Complete */
793
+ processCd: number;
794
+ [key: string]: unknown;
795
+ }
796
+ /** Returned by: api.agrInt.roles.bundles.list(rolesUid, params) */
797
+ export type RolesBundlesListData = RolesBundlesListItem[];
798
+ /**
799
+ * Assign or reactivate a role-bundle membership
800
+ * Response data for POST /roles/{rolesUid}/bundles — MINIMUM fields, extras pass through
801
+ *
802
+ * Returned by: api.agrInt.roles.bundles.create(rolesUid, data)
803
+ */
804
+ export type RolesBundlesCreateData = RolesBundlesListItem;
805
+ /**
806
+ * Assign or reactivate a role-bundle membership
807
+ * Request body for POST /roles/{rolesUid}/bundles — MINIMUM fields, extras pass through
808
+ *
809
+ * Request body of: api.agrInt.roles.bundles.create(rolesUid, data)
810
+ */
811
+ export interface RolesBundlesCreateBody {
812
+ /** Bundle to assign; the role comes from the path */
813
+ bundlesUid: number;
814
+ [key: string]: unknown;
815
+ }
816
+ /**
817
+ * Get a role-bundle membership
818
+ * Response data for GET /roles/{rolesUid}/bundles/{rolesXBundlesUid} — MINIMUM fields, extras pass
819
+ * through
820
+ *
821
+ * Returned by: api.agrInt.roles.bundles.get(rolesUid, rolesXBundlesUid)
822
+ */
823
+ export type RolesBundlesGetData = RolesBundlesListItem;
824
+ /**
825
+ * Update a role-bundle membership
826
+ * Response data for PUT /roles/{rolesUid}/bundles/{rolesXBundlesUid} — MINIMUM fields, extras pass
827
+ * through
828
+ *
829
+ * Returned by: api.agrInt.roles.bundles.update(rolesUid, rolesXBundlesUid, data)
830
+ */
831
+ export type RolesBundlesUpdateData = RolesBundlesListItem;
832
+ /**
833
+ * Update a role-bundle membership
834
+ * Request body for PUT /roles/{rolesUid}/bundles/{rolesXBundlesUid} — MINIMUM fields, extras pass
835
+ * through
836
+ *
837
+ * Request body of: api.agrInt.roles.bundles.update(rolesUid, rolesXBundlesUid, data)
838
+ * Request body of: api.agrInt.users.roles.update(usersUid, usersXRolesUid, data)
839
+ */
840
+ export interface RolesBundlesUpdateBody {
841
+ /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
842
+ statusCd?: number | null;
843
+ /** Process code (704 = Active, 705 = Inactive, 700 = Deleted, 1185 = Import Complete) */
844
+ processCd?: number | null;
845
+ [key: string]: unknown;
846
+ }
847
+ /**
848
+ * Revoke a role-bundle membership
849
+ * Response data for DELETE /roles/{rolesUid}/bundles/{rolesXBundlesUid} — MINIMUM fields, extras
850
+ * pass through
851
+ *
852
+ * Returned by: api.agrInt.roles.bundles.delete(rolesUid, rolesXBundlesUid)
853
+ */
854
+ export type RolesBundlesDeleteData = RolesBundlesListItem;
855
+ /**
856
+ * List users
857
+ * Response data for GET /users — MINIMUM fields, extras pass through
858
+ *
859
+ * Returned by: api.agrInt.users.list(params) (array items)
860
+ * Returned by: api.agrInt.users.create(data)
861
+ * Returned by: api.agrInt.users.get(usersUid)
862
+ * Returned by: api.agrInt.users.update(usersUid, data)
863
+ * Returned by: api.agrInt.users.delete(usersUid)
864
+ */
865
+ export interface UsersListItem {
866
+ /** User unique ID */
867
+ usersUid: number;
868
+ /** Login name, unique per site (max 255 chars) */
869
+ username: string;
870
+ /** Display name (max 255 chars) */
871
+ name: string | null;
872
+ /** Email address, unique per site (max 255 chars) */
873
+ email: string;
874
+ /** Contact phone number (max 20 chars) */
875
+ phoneNumber: string | null;
876
+ /** When the row was created (mysql-datetime, e.g. 2025-07-30 15:50:49) */
877
+ dateCreated: string;
878
+ /** When the row was last modified (mysql-datetime, e.g. 2025-07-30 15:50:49) */
879
+ dateLastModified: string;
880
+ /** Update code: 1185 = Import Complete, 704 = needs processing */
881
+ updateCd: number;
882
+ /** Status code: 704 = Active, 705 = Inactive, 700 = Deleted */
883
+ statusCd: number;
884
+ /** Process code: 704 = Active, 705 = Inactive, 700 = Deleted, 1185 = Import Complete */
885
+ processCd: number;
886
+ [key: string]: unknown;
887
+ }
888
+ /** Returned by: api.agrInt.users.list(params) */
889
+ export type UsersListData = UsersListItem[];
890
+ /**
891
+ * Create a user
892
+ * Response data for POST /users — MINIMUM fields, extras pass through
893
+ *
894
+ * Returned by: api.agrInt.users.create(data)
895
+ */
896
+ export type UsersCreateData = UsersListItem;
897
+ /**
898
+ * Create a user
899
+ * Request body for POST /users — MINIMUM fields, extras pass through
900
+ *
901
+ * Request body of: api.agrInt.users.create(data)
902
+ */
903
+ export interface UsersCreateBody {
904
+ /** Login name, unique per site */
905
+ username: string;
906
+ /** Plaintext password; hashed before it is stored */
907
+ password: string;
908
+ /** Email address, unique per site */
909
+ email: string;
910
+ /** Display name */
911
+ name?: string | null;
912
+ /** Contact phone number */
913
+ phoneNumber?: string | null;
914
+ /** Status code (704 = Active, 705 = Inactive, 700 = Deleted); defaults to 704 */
915
+ statusCd?: number | null;
916
+ /** Process code; defaults to 704 (Active) */
917
+ processCd?: number | null;
918
+ /** Update code; defaults to 1185 (Import Complete) */
919
+ updateCd?: number | null;
920
+ [key: string]: unknown;
921
+ }
922
+ /**
923
+ * Rotate a user token
924
+ * Response data for POST /users/rotate — MINIMUM fields, extras pass through
925
+ *
926
+ * Returned by: api.agrInt.users.rotate.create(data)
927
+ * Returned by: api.agrInt.users.verify.create(data)
928
+ */
929
+ export interface UsersRotateCreateData {
930
+ /** agr_int user unique ID; 0 means verification failed */
931
+ usersUid: number;
932
+ /** Username; '' on failure */
933
+ username: string;
934
+ /** Signed access JWT (scope agr-int-user) to present as a bearer; '' on failure */
935
+ token: string;
936
+ [key: string]: unknown;
937
+ }
938
+ /**
939
+ * Rotate a user token
940
+ * Request body for POST /users/rotate — MINIMUM fields, extras pass through
941
+ *
942
+ * Request body of: api.agrInt.users.rotate.create(data)
943
+ */
944
+ export interface UsersRotateCreateBody {
945
+ /**
946
+ * The current agr_int user JWT to exchange; its client_id claim selects the site, and a missing
947
+ * token is rejected as invalid
948
+ */
949
+ token?: string;
950
+ [key: string]: unknown;
951
+ }
952
+ /**
953
+ * Validate a user token
954
+ * Response data for POST /users/validate — MINIMUM fields, extras pass through
955
+ *
956
+ * Returned by: api.agrInt.users.validate.create(data)
957
+ */
958
+ export interface UsersValidateCreateData {
959
+ /** True only when the token verifies, has scope agr-int-user, and its user is ACTIVE */
960
+ valid: boolean;
961
+ /** Token scope; consumers MUST authorize on this, not on userId */
962
+ scope: string;
963
+ /** agr_int user unique ID (users_uid) */
964
+ userId: number;
965
+ /** Username, refreshed from the user row */
966
+ username: string;
967
+ /** Email address, refreshed from the user row */
968
+ email: string;
969
+ /** Display name, refreshed from the user row */
970
+ name: string;
971
+ /** Active role ids the user holds */
972
+ roles: string[];
973
+ /** Active bundle ids granted through those roles */
974
+ bundles: string[];
975
+ /** P21 table set (resources.resource_path) the user may query */
976
+ resources: string[];
977
+ [key: string]: unknown;
978
+ }
979
+ /**
980
+ * Validate a user token
981
+ * Request body for POST /users/validate — MINIMUM fields, extras pass through
982
+ *
983
+ * Request body of: api.agrInt.users.validate.create(data)
984
+ */
985
+ export interface UsersValidateCreateBody {
986
+ /** The agr_int user JWT to introspect; a missing token introspects as invalid */
987
+ token: string;
988
+ [key: string]: unknown;
989
+ }
990
+ /**
991
+ * Verify user credentials
992
+ * Response data for POST /users/verify — MINIMUM fields, extras pass through
993
+ *
994
+ * Returned by: api.agrInt.users.verify.create(data)
995
+ */
996
+ export type UsersVerifyCreateData = UsersRotateCreateData;
997
+ /**
998
+ * Verify user credentials
999
+ * Request body for POST /users/verify — MINIMUM fields, extras pass through
1000
+ *
1001
+ * Request body of: api.agrInt.users.verify.create(data)
1002
+ */
1003
+ export interface UsersVerifyCreateBody {
1004
+ /** Target site; blank or augur_info targets augur_info itself */
1005
+ siteId?: string;
1006
+ /** The user's username */
1007
+ username?: string;
1008
+ /**
1009
+ * The user's cleartext password, verified against the stored Argon2id hash; never logged, never
1010
+ * echoed back
1011
+ */
1012
+ password?: string;
1013
+ [key: string]: unknown;
1014
+ }
1015
+ /**
1016
+ * Get a user
1017
+ * Response data for GET /users/{usersUid} — MINIMUM fields, extras pass through
1018
+ *
1019
+ * Returned by: api.agrInt.users.get(usersUid)
1020
+ */
1021
+ export type UsersGetData = UsersListItem;
1022
+ /**
1023
+ * Update a user
1024
+ * Response data for PUT /users/{usersUid} — MINIMUM fields, extras pass through
1025
+ *
1026
+ * Returned by: api.agrInt.users.update(usersUid, data)
1027
+ */
1028
+ export type UsersUpdateData = UsersListItem;
1029
+ /**
1030
+ * Update a user
1031
+ * Request body for PUT /users/{usersUid} — MINIMUM fields, extras pass through
1032
+ *
1033
+ * Request body of: api.agrInt.users.update(usersUid, data)
1034
+ */
1035
+ export interface UsersUpdateBody {
1036
+ /** New login name; blank is ignored */
1037
+ username?: string | null;
1038
+ /** New plaintext password, re-hashed with Argon2id; blank is ignored */
1039
+ password?: string | null;
1040
+ /** New display name; blank clears it */
1041
+ name?: string | null;
1042
+ /** New email address; blank is ignored */
1043
+ email?: string | null;
1044
+ /** New phone number; blank clears it */
1045
+ phoneNumber?: string | null;
1046
+ /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
1047
+ statusCd?: number | null;
1048
+ /** Process code */
1049
+ processCd?: number | null;
1050
+ /** Update code */
1051
+ updateCd?: number | null;
1052
+ [key: string]: unknown;
1053
+ }
1054
+ /**
1055
+ * Soft-delete a user
1056
+ * Response data for DELETE /users/{usersUid} — MINIMUM fields, extras pass through
1057
+ *
1058
+ * Returned by: api.agrInt.users.delete(usersUid)
1059
+ */
1060
+ export type UsersDeleteData = UsersListItem;
1061
+ /**
1062
+ * List user-role memberships
1063
+ * Response data for GET /users/{usersUid}/roles — MINIMUM fields, extras pass through
1064
+ *
1065
+ * Returned by: api.agrInt.users.roles.list(usersUid, params) (array items)
1066
+ * Returned by: api.agrInt.users.roles.create(usersUid, data)
1067
+ * Returned by: api.agrInt.users.roles.get(usersUid, usersXRolesUid)
1068
+ * Returned by: api.agrInt.users.roles.update(usersUid, usersXRolesUid, data)
1069
+ * Returned by: api.agrInt.users.roles.delete(usersUid, usersXRolesUid)
1070
+ */
1071
+ export interface UsersRolesListItem {
1072
+ /** User-role membership unique ID */
1073
+ usersXRolesUid: number;
1074
+ /** User that holds the role */
1075
+ usersUid: number;
1076
+ /** Role assigned to the user */
1077
+ rolesUid: number;
1078
+ /** When the row was created (mysql-datetime, e.g. 2025-07-30 15:50:49) */
1079
+ dateCreated: string;
1080
+ /** When the row was last modified (mysql-datetime, e.g. 2025-07-30 15:50:49) */
1081
+ dateLastModified: string;
1082
+ /** Update code: 1185 = Import Complete, 704 = needs processing */
1083
+ updateCd: number;
1084
+ /** Status code: 704 = Active, 705 = Inactive, 700 = Deleted */
1085
+ statusCd: number;
1086
+ /** Process code: 704 = Active, 705 = Inactive, 700 = Deleted, 1185 = Import Complete */
1087
+ processCd: number;
1088
+ [key: string]: unknown;
1089
+ }
1090
+ /** Returned by: api.agrInt.users.roles.list(usersUid, params) */
1091
+ export type UsersRolesListData = UsersRolesListItem[];
1092
+ /**
1093
+ * Assign or reactivate a user-role membership
1094
+ * Response data for POST /users/{usersUid}/roles — MINIMUM fields, extras pass through
1095
+ *
1096
+ * Returned by: api.agrInt.users.roles.create(usersUid, data)
1097
+ */
1098
+ export type UsersRolesCreateData = UsersRolesListItem;
1099
+ /**
1100
+ * Assign or reactivate a user-role membership
1101
+ * Request body for POST /users/{usersUid}/roles — MINIMUM fields, extras pass through
1102
+ *
1103
+ * Request body of: api.agrInt.users.roles.create(usersUid, data)
1104
+ */
1105
+ export interface UsersRolesCreateBody {
1106
+ /** Role to assign; the user comes from the path */
1107
+ rolesUid: number;
1108
+ [key: string]: unknown;
1109
+ }
1110
+ /**
1111
+ * Get a user-role membership
1112
+ * Response data for GET /users/{usersUid}/roles/{usersXRolesUid} — MINIMUM fields, extras pass
1113
+ * through
1114
+ *
1115
+ * Returned by: api.agrInt.users.roles.get(usersUid, usersXRolesUid)
1116
+ */
1117
+ export type UsersRolesGetData = UsersRolesListItem;
1118
+ /**
1119
+ * Update a user-role membership
1120
+ * Response data for PUT /users/{usersUid}/roles/{usersXRolesUid} — MINIMUM fields, extras pass
1121
+ * through
1122
+ *
1123
+ * Returned by: api.agrInt.users.roles.update(usersUid, usersXRolesUid, data)
1124
+ */
1125
+ export type UsersRolesUpdateData = UsersRolesListItem;
1126
+ /**
1127
+ * Update a user-role membership
1128
+ * Request body for PUT /users/{usersUid}/roles/{usersXRolesUid} — MINIMUM fields, extras pass
1129
+ * through
1130
+ *
1131
+ * Request body of: api.agrInt.users.roles.update(usersUid, usersXRolesUid, data)
1132
+ */
1133
+ export type UsersRolesUpdateBody = RolesBundlesUpdateBody;
1134
+ /**
1135
+ * Revoke a user-role membership
1136
+ * Response data for DELETE /users/{usersUid}/roles/{usersXRolesUid} — MINIMUM fields, extras pass
1137
+ * through
1138
+ *
1139
+ * Returned by: api.agrInt.users.roles.delete(usersUid, usersXRolesUid)
1140
+ */
1141
+ export type UsersRolesDeleteData = UsersRolesListItem;
1142
+ export interface AgrIntClientSpec {
1143
+ bundles: {
1144
+ /**
1145
+ * List bundles
1146
+ * Call: api.agrInt.bundles.list(params)
1147
+ *
1148
+ * List bundles with pagination and filtering
1149
+ *
1150
+ * Errors:
1151
+ * 400: Bad request: the body is missing or a parameter is invalid; message says which.
1152
+ * 403: The bearer token does not belong to an admin user.
1153
+ *
1154
+ * GET https://agr-int.augur-api.com/bundles
1155
+ * Contract: https://agr-int.augur-api.com/openapi.json#/paths/~1bundles/get
1156
+ *
1157
+ * @param params BundlesListParams (query string)
1158
+ * @returns BaseResponse whose `data` is BundlesListData
1159
+ */
1160
+ list: (params?: BundlesListParams) => Promise<BaseResponse<BundlesListData>>;
1161
+ /**
1162
+ * Create a bundle
1163
+ * Call: api.agrInt.bundles.create(data)
1164
+ *
1165
+ * Create or upsert a bundle (system_flag forced to N)
1166
+ *
1167
+ * Request body: Create a custom bundle, or refresh the one whose derived bundle_id already
1168
+ * exists
1169
+ *
1170
+ * Errors:
1171
+ * 400: A required body field is missing or has the wrong type.
1172
+ * 403: The bearer token does not belong to an admin user.
1173
+ *
1174
+ * POST https://agr-int.augur-api.com/bundles
1175
+ * Contract: https://agr-int.augur-api.com/openapi.json#/paths/~1bundles/post
1176
+ *
1177
+ * @param data BundlesCreateBody (request body)
1178
+ * @returns BaseResponse whose `data` is BundlesCreateData
1179
+ */
1180
+ create: (data: BundlesCreateBody) => Promise<BaseResponse<BundlesCreateData>>;
1181
+ /**
1182
+ * Get a bundle
1183
+ * Call: api.agrInt.bundles.get(bundlesUid)
1184
+ *
1185
+ * Get a bundle by UID
1186
+ *
1187
+ * Errors:
1188
+ * 403: The bearer token does not belong to an admin user.
1189
+ * 404: No bundles row with this bundlesUid.
1190
+ *
1191
+ * GET https://agr-int.augur-api.com/bundles/{bundlesUid}
1192
+ * Contract: https://agr-int.augur-api.com/openapi.json#/paths/~1bundles~1{bundlesUid}/get
1193
+ *
1194
+ * @param bundlesUid Unique ID of the bundle
1195
+ * @param params BundlesGetParams (query string)
1196
+ * @returns BaseResponse whose `data` is BundlesGetData
1197
+ */
1198
+ get: (bundlesUid: number, params?: BundlesGetParams) => Promise<BaseResponse<BundlesGetData>>;
1199
+ /**
1200
+ * Update a bundle
1201
+ * Call: api.agrInt.bundles.update(bundlesUid, data)
1202
+ *
1203
+ * Update a bundle by UID with a partial JSON body
1204
+ *
1205
+ * Request body: Partial update of a custom bundle; an absent field keeps its current value
1206
+ *
1207
+ * Errors:
1208
+ * 403: The bearer token does not belong to an admin user. Or System bundles (system_flag=Y)
1209
+ * cannot be updated via this endpoint.
1210
+ * 404: No record with this ID.
1211
+ *
1212
+ * PUT https://agr-int.augur-api.com/bundles/{bundlesUid}
1213
+ * Contract: https://agr-int.augur-api.com/openapi.json#/paths/~1bundles~1{bundlesUid}/put
1214
+ *
1215
+ * @param bundlesUid Unique ID of the bundle
1216
+ * @param data BundlesUpdateBody (request body)
1217
+ * @returns BaseResponse whose `data` is BundlesUpdateData
1218
+ */
1219
+ update: (bundlesUid: number, data: BundlesUpdateBody) => Promise<BaseResponse<BundlesUpdateData>>;
1220
+ /**
1221
+ * Soft-delete a bundle
1222
+ * Call: api.agrInt.bundles.delete(bundlesUid)
1223
+ *
1224
+ * Soft-delete a bundle by UID
1225
+ *
1226
+ * Errors:
1227
+ * 403: The bearer token does not belong to an admin user. Or System bundles (system_flag=Y)
1228
+ * cannot be soft-deleted via this endpoint.
1229
+ * 404: No record with this ID.
1230
+ *
1231
+ * DELETE https://agr-int.augur-api.com/bundles/{bundlesUid}
1232
+ * Contract: https://agr-int.augur-api.com/openapi.json#/paths/~1bundles~1{bundlesUid}/delete
1233
+ *
1234
+ * @param bundlesUid Unique ID of the bundle
1235
+ * @returns BaseResponse whose `data` is BundlesDeleteData
1236
+ */
1237
+ delete: (bundlesUid: number) => Promise<BaseResponse<BundlesDeleteData>>;
1238
+ resources: {
1239
+ /**
1240
+ * List bundle-resource grants
1241
+ * Call: api.agrInt.bundles.resources.list(bundlesUid, params)
1242
+ *
1243
+ * List a bundle's resource grants with pagination and filtering
1244
+ *
1245
+ * Errors:
1246
+ * 400: Bad request: the body is missing or a parameter is invalid; message says which.
1247
+ * 403: The bearer token does not belong to an admin user.
1248
+ * 404: No bundles row with this bundlesUid.
1249
+ *
1250
+ * GET https://agr-int.augur-api.com/bundles/{bundlesUid}/resources
1251
+ * Contract:
1252
+ * https://agr-int.augur-api.com/openapi.json#/paths/~1bundles~1{bundlesUid}~1resources/get
1253
+ *
1254
+ * @param bundlesUid Unique ID of the bundle
1255
+ * @param params BundlesResourcesListParams (query string)
1256
+ * @returns BaseResponse whose `data` is BundlesResourcesListData
1257
+ */
1258
+ list: (bundlesUid: number, params?: BundlesResourcesListParams) => Promise<BaseResponse<BundlesResourcesListData>>;
1259
+ /**
1260
+ * Grant or reactivate a bundle-resource grant
1261
+ * Call: api.agrInt.bundles.resources.create(bundlesUid, data)
1262
+ *
1263
+ * Grant a resource to a bundle, or reactivate a previously revoked grant. Body MUST include
1264
+ * resourcesUid and MAY include readCd/writeCd/executeCd.
1265
+ *
1266
+ * Request body: Grant a resource to the bundle in the path, or re-activate and re-grant the
1267
+ * existing edge
1268
+ *
1269
+ * Errors:
1270
+ * 400: A required body field is missing or has the wrong type.
1271
+ * 403: The bearer token does not belong to an admin user.
1272
+ * 404: No bundles row with this bundlesUid.
1273
+ *
1274
+ * POST https://agr-int.augur-api.com/bundles/{bundlesUid}/resources
1275
+ * Contract:
1276
+ * https://agr-int.augur-api.com/openapi.json#/paths/~1bundles~1{bundlesUid}~1resources/post
1277
+ *
1278
+ * @param bundlesUid Unique ID of the bundle
1279
+ * @param data BundlesResourcesCreateBody (request body)
1280
+ * @returns BaseResponse whose `data` is BundlesResourcesCreateData
1281
+ */
1282
+ create: (bundlesUid: number, data: BundlesResourcesCreateBody) => Promise<BaseResponse<BundlesResourcesCreateData>>;
1283
+ /**
1284
+ * Get a bundle-resource grant
1285
+ * Call: api.agrInt.bundles.resources.get(bundlesUid, bundlesXResourcesUid)
1286
+ *
1287
+ * Get a bundle-resource grant by UID
1288
+ *
1289
+ * Errors:
1290
+ * 403: The bearer token does not belong to an admin user.
1291
+ * 404: Grant not found for this bundle.
1292
+ *
1293
+ * GET https://agr-int.augur-api.com/bundles/{bundlesUid}/resources/{bundlesXResourcesUid}
1294
+ * Contract:
1295
+ * https://agr-int.augur-api.com/openapi.json#/paths/~1bundles~1{bundlesUid}~1resources~1{bundlesXResourcesUid}/get
1296
+ *
1297
+ * @param bundlesUid Unique ID of the bundle
1298
+ * @param bundlesXResourcesUid Unique ID of the bundle-to-resource assignment
1299
+ * @param params BundlesResourcesGetParams (query string)
1300
+ * @returns BaseResponse whose `data` is BundlesResourcesGetData
1301
+ */
1302
+ get: (bundlesUid: number, bundlesXResourcesUid: number, params?: BundlesResourcesGetParams) => Promise<BaseResponse<BundlesResourcesGetData>>;
1303
+ /**
1304
+ * Update a bundle-resource grant
1305
+ * Call: api.agrInt.bundles.resources.update(bundlesUid, bundlesXResourcesUid, data)
1306
+ *
1307
+ * Update a bundle-resource grant (statusCd / processCd / readCd / writeCd / executeCd only)
1308
+ *
1309
+ * Request body: Partial update of a bundle-resource grant; an out-of-set code is dropped
1310
+ *
1311
+ * Errors:
1312
+ * 403: The bearer token does not belong to an admin user.
1313
+ * 404: No record with this ID. Or Grant not found for this bundle.
1314
+ *
1315
+ * PUT https://agr-int.augur-api.com/bundles/{bundlesUid}/resources/{bundlesXResourcesUid}
1316
+ * Contract:
1317
+ * https://agr-int.augur-api.com/openapi.json#/paths/~1bundles~1{bundlesUid}~1resources~1{bundlesXResourcesUid}/put
1318
+ *
1319
+ * @param bundlesUid Unique ID of the bundle
1320
+ * @param bundlesXResourcesUid Unique ID of the bundle-to-resource assignment
1321
+ * @param data BundlesResourcesUpdateBody (request body)
1322
+ * @returns BaseResponse whose `data` is BundlesResourcesUpdateData
1323
+ */
1324
+ update: (bundlesUid: number, bundlesXResourcesUid: number, data: BundlesResourcesUpdateBody) => Promise<BaseResponse<BundlesResourcesUpdateData>>;
1325
+ /**
1326
+ * Revoke a bundle-resource grant
1327
+ * Call: api.agrInt.bundles.resources.delete(bundlesUid, bundlesXResourcesUid)
1328
+ *
1329
+ * Soft-delete (revoke) a bundle-resource grant
1330
+ *
1331
+ * Errors:
1332
+ * 403: The bearer token does not belong to an admin user.
1333
+ * 404: No record with this ID. Or Grant not found for this bundle.
1334
+ *
1335
+ * DELETE https://agr-int.augur-api.com/bundles/{bundlesUid}/resources/{bundlesXResourcesUid}
1336
+ * Contract:
1337
+ * https://agr-int.augur-api.com/openapi.json#/paths/~1bundles~1{bundlesUid}~1resources~1{bundlesXResourcesUid}/delete
1338
+ *
1339
+ * @param bundlesUid Unique ID of the bundle
1340
+ * @param bundlesXResourcesUid Unique ID of the bundle-to-resource assignment
1341
+ * @returns BaseResponse whose `data` is BundlesResourcesDeleteData
1342
+ */
1343
+ delete: (bundlesUid: number, bundlesXResourcesUid: number) => Promise<BaseResponse<BundlesResourcesDeleteData>>;
1344
+ };
1345
+ };
1346
+ clients: {
1347
+ /**
1348
+ * List clients
1349
+ * Call: api.agrInt.clients.list(params)
1350
+ *
1351
+ * List client credentials with pagination and filtering. client_secret is never returned.
1352
+ *
1353
+ * Errors:
1354
+ * 400: Bad request: the body is missing or a parameter is invalid; message says which.
1355
+ * 403: The bearer token does not belong to an admin user.
1356
+ *
1357
+ * GET https://agr-int.augur-api.com/clients
1358
+ * Contract: https://agr-int.augur-api.com/openapi.json#/paths/~1clients/get
1359
+ *
1360
+ * @param params ClientsListParams (query string)
1361
+ * @returns BaseResponse whose `data` is ClientsListData
1362
+ */
1363
+ list: (params?: ClientsListParams) => Promise<BaseResponse<ClientsListData>>;
1364
+ /**
1365
+ * Issue a client
1366
+ * Call: api.agrInt.clients.create(data)
1367
+ *
1368
+ * Issue a client credential for an existing ACTIVE agr_int user. The response carries the
1369
+ * credential; GET /api/clients/{clientsUid} re-reads it while the client is active.
1370
+ *
1371
+ * Request body: Issue a client credential for an existing ACTIVE agr_int user; issuedById and
1372
+ * issuedByUsername come from the admin bearer, never the body
1373
+ * Response data: Result of issuing an agr_int client credential (GH#114).
1374
+ *
1375
+ * Errors:
1376
+ * 400: The body is missing or not a JSON object. Or The client could not be issued. A
1377
+ * non-empty "clientName" and an ACTIVE "usersUid" are required.
1378
+ * 403: The bearer token does not belong to an admin user.
1379
+ *
1380
+ * POST https://agr-int.augur-api.com/clients
1381
+ * Contract: https://agr-int.augur-api.com/openapi.json#/paths/~1clients/post
1382
+ *
1383
+ * @param data ClientsCreateBody (request body)
1384
+ * @returns BaseResponse whose `data` is ClientsCreateData
1385
+ */
1386
+ create: (data: ClientsCreateBody) => Promise<BaseResponse<ClientsCreateData>>;
1387
+ /**
1388
+ * Get a client
1389
+ * Call: api.agrInt.clients.get(clientsUid)
1390
+ *
1391
+ * Get a client credential by UID, including its secret and bearer credential while the client
1392
+ * and its user are active. The client_secret HMAC is never returned.
1393
+ *
1394
+ * Response data: A single agr_int client credential with its recoverable secret (GH#115).
1395
+ *
1396
+ * Errors:
1397
+ * 403: The bearer token does not belong to an admin user.
1398
+ * 404: Client not found.
1399
+ *
1400
+ * GET https://agr-int.augur-api.com/clients/{clientsUid}
1401
+ * Contract: https://agr-int.augur-api.com/openapi.json#/paths/~1clients~1{clientsUid}/get
1402
+ *
1403
+ * @param clientsUid Unique ID of the API client
1404
+ * @param params ClientsGetParams (query string)
1405
+ * @returns BaseResponse whose `data` is ClientsGetData
1406
+ */
1407
+ get: (clientsUid: number, params?: ClientsGetParams) => Promise<BaseResponse<ClientsGetData>>;
1408
+ /**
1409
+ * Update a client
1410
+ * Call: api.agrInt.clients.update(clientsUid, data)
1411
+ *
1412
+ * Update a client by UID. Only clientName, description, statusCd, processCd, updateCd are
1413
+ * writable. A retired (700) client refuses every update.
1414
+ *
1415
+ * Request body: Partial update of a client credential; usersUid, clientId, clientSecret and
1416
+ * keyVersion are immutable, and a retired (700) client refuses every update
1417
+ *
1418
+ * Errors:
1419
+ * 400: The body is missing or not a JSON object. Or The client could not be updated. It does
1420
+ * not exist, is retired (700, terminal), or a _cd value is invalid.
1421
+ * 403: The bearer token does not belong to an admin user.
1422
+ * 404: No record with this ID.
1423
+ *
1424
+ * PUT https://agr-int.augur-api.com/clients/{clientsUid}
1425
+ * Contract: https://agr-int.augur-api.com/openapi.json#/paths/~1clients~1{clientsUid}/put
1426
+ *
1427
+ * @param clientsUid Unique ID of the API client
1428
+ * @param data ClientsUpdateBody (request body)
1429
+ * @returns BaseResponse whose `data` is ClientsUpdateData
1430
+ */
1431
+ update: (clientsUid: number, data: ClientsUpdateBody) => Promise<BaseResponse<ClientsUpdateData>>;
1432
+ /**
1433
+ * Retire a client
1434
+ * Call: api.agrInt.clients.delete(clientsUid)
1435
+ *
1436
+ * Retire a client credential by UID (status_cd 700, terminal). Stamps retired_by from the admin
1437
+ * bearer.
1438
+ *
1439
+ * Errors:
1440
+ * 403: The bearer token does not belong to an admin user.
1441
+ * 404: No record with this ID. Or Client not found.
1442
+ *
1443
+ * DELETE https://agr-int.augur-api.com/clients/{clientsUid}
1444
+ * Contract: https://agr-int.augur-api.com/openapi.json#/paths/~1clients~1{clientsUid}/delete
1445
+ *
1446
+ * @param clientsUid Unique ID of the API client
1447
+ * @returns BaseResponse whose `data` is ClientsDeleteData
1448
+ */
1449
+ delete: (clientsUid: number) => Promise<BaseResponse<ClientsDeleteData>>;
1450
+ validate: {
1451
+ /**
1452
+ * Validate a client credential
1453
+ * Call: api.agrInt.clients.validate.create(data)
1454
+ *
1455
+ * Introspect a client credential. Reads {credential} or {clientId, secret} from the body.
1456
+ * Only the augur_info system bearer is accepted. Always 200; returns {valid, siteId,
1457
+ * tokenUse, clientUid, clientId, usersUid, username, roles, bundles, resources}.
1458
+ *
1459
+ * Request body: Introspect a client credential: send either credential (bearer form) or
1460
+ * clientId plus secret (Basic form)
1461
+ * Response data: Result of validating a presented agr_int client credential (GH#114).
1462
+ *
1463
+ * Errors:
1464
+ * 403: The bearer token is not a system token.
1465
+ *
1466
+ * POST https://agr-int.augur-api.com/clients/validate
1467
+ * Contract: https://agr-int.augur-api.com/openapi.json#/paths/~1clients~1validate/post
1468
+ *
1469
+ * @param data ClientsValidateCreateBody (request body)
1470
+ * @returns BaseResponse whose `data` is ClientsValidateCreateData
1471
+ */
1472
+ create: (data: ClientsValidateCreateBody) => Promise<BaseResponse<ClientsValidateCreateData>>;
1473
+ };
1474
+ };
1475
+ resources: {
1476
+ /**
1477
+ * List resources
1478
+ * Call: api.agrInt.resources.list(params)
1479
+ *
1480
+ * List resources with pagination and filtering
1481
+ *
1482
+ * Errors:
1483
+ * 400: Bad request: the body is missing or a parameter is invalid; message says which.
1484
+ * 403: The bearer token does not belong to an admin user.
1485
+ *
1486
+ * GET https://agr-int.augur-api.com/resources
1487
+ * Contract: https://agr-int.augur-api.com/openapi.json#/paths/~1resources/get
1488
+ *
1489
+ * @param params ResourcesListParams (query string)
1490
+ * @returns BaseResponse whose `data` is ResourcesListData
1491
+ */
1492
+ list: (params?: ResourcesListParams) => Promise<BaseResponse<ResourcesListData>>;
1493
+ /**
1494
+ * Get a resource
1495
+ * Call: api.agrInt.resources.get(resourcesUid)
1496
+ *
1497
+ * Get a resource by UID
1498
+ *
1499
+ * Errors:
1500
+ * 403: The bearer token does not belong to an admin user.
1501
+ * 404: No resources row with this resourcesUid.
1502
+ *
1503
+ * GET https://agr-int.augur-api.com/resources/{resourcesUid}
1504
+ * Contract: https://agr-int.augur-api.com/openapi.json#/paths/~1resources~1{resourcesUid}/get
1505
+ *
1506
+ * @param resourcesUid Unique ID of the resource
1507
+ * @param params ResourcesGetParams (query string)
1508
+ * @returns BaseResponse whose `data` is ResourcesGetData
1509
+ */
1510
+ get: (resourcesUid: number, params?: ResourcesGetParams) => Promise<BaseResponse<ResourcesGetData>>;
1511
+ };
1512
+ roles: {
1513
+ /**
1514
+ * List roles
1515
+ * Call: api.agrInt.roles.list(params)
1516
+ *
1517
+ * List roles with pagination and filtering
1518
+ *
1519
+ * Errors:
1520
+ * 400: Bad request: the body is missing or a parameter is invalid; message says which.
1521
+ * 403: The bearer token does not belong to an admin user.
1522
+ *
1523
+ * GET https://agr-int.augur-api.com/roles
1524
+ * Contract: https://agr-int.augur-api.com/openapi.json#/paths/~1roles/get
1525
+ *
1526
+ * @param params RolesListParams (query string)
1527
+ * @returns BaseResponse whose `data` is RolesListData
1528
+ */
1529
+ list: (params?: RolesListParams) => Promise<BaseResponse<RolesListData>>;
1530
+ /**
1531
+ * Create a role
1532
+ * Call: api.agrInt.roles.create(data)
1533
+ *
1534
+ * Create or upsert a role (system_flag forced to N)
1535
+ *
1536
+ * Request body: Create a custom role, or refresh the one whose derived role_id already exists
1537
+ *
1538
+ * Errors:
1539
+ * 400: A required body field is missing or has the wrong type.
1540
+ * 403: The bearer token does not belong to an admin user.
1541
+ *
1542
+ * POST https://agr-int.augur-api.com/roles
1543
+ * Contract: https://agr-int.augur-api.com/openapi.json#/paths/~1roles/post
1544
+ *
1545
+ * @param data RolesCreateBody (request body)
1546
+ * @returns BaseResponse whose `data` is RolesCreateData
1547
+ */
1548
+ create: (data: RolesCreateBody) => Promise<BaseResponse<RolesCreateData>>;
1549
+ /**
1550
+ * Get a role
1551
+ * Call: api.agrInt.roles.get(rolesUid)
1552
+ *
1553
+ * Get a role by UID
1554
+ *
1555
+ * Errors:
1556
+ * 403: The bearer token does not belong to an admin user.
1557
+ * 404: No roles row with this rolesUid.
1558
+ *
1559
+ * GET https://agr-int.augur-api.com/roles/{rolesUid}
1560
+ * Contract: https://agr-int.augur-api.com/openapi.json#/paths/~1roles~1{rolesUid}/get
1561
+ *
1562
+ * @param rolesUid Unique ID of the role
1563
+ * @param params RolesGetParams (query string)
1564
+ * @returns BaseResponse whose `data` is RolesGetData
1565
+ */
1566
+ get: (rolesUid: number, params?: RolesGetParams) => Promise<BaseResponse<RolesGetData>>;
1567
+ /**
1568
+ * Update a role
1569
+ * Call: api.agrInt.roles.update(rolesUid, data)
1570
+ *
1571
+ * Update a role by UID with a partial JSON body
1572
+ *
1573
+ * Request body: Partial update of a custom role; an absent field keeps its current value
1574
+ *
1575
+ * Errors:
1576
+ * 403: The bearer token does not belong to an admin user. Or System roles (system_flag=Y)
1577
+ * cannot be updated via this endpoint.
1578
+ * 404: No record with this ID.
1579
+ *
1580
+ * PUT https://agr-int.augur-api.com/roles/{rolesUid}
1581
+ * Contract: https://agr-int.augur-api.com/openapi.json#/paths/~1roles~1{rolesUid}/put
1582
+ *
1583
+ * @param rolesUid Unique ID of the role
1584
+ * @param data RolesUpdateBody (request body)
1585
+ * @returns BaseResponse whose `data` is RolesUpdateData
1586
+ */
1587
+ update: (rolesUid: number, data: RolesUpdateBody) => Promise<BaseResponse<RolesUpdateData>>;
1588
+ /**
1589
+ * Soft-delete a role
1590
+ * Call: api.agrInt.roles.delete(rolesUid)
1591
+ *
1592
+ * Soft-delete a role by UID
1593
+ *
1594
+ * Errors:
1595
+ * 403: The bearer token does not belong to an admin user. Or System roles (system_flag=Y)
1596
+ * cannot be soft-deleted via this endpoint.
1597
+ * 404: No record with this ID.
1598
+ *
1599
+ * DELETE https://agr-int.augur-api.com/roles/{rolesUid}
1600
+ * Contract: https://agr-int.augur-api.com/openapi.json#/paths/~1roles~1{rolesUid}/delete
1601
+ *
1602
+ * @param rolesUid Unique ID of the role
1603
+ * @returns BaseResponse whose `data` is RolesDeleteData
1604
+ */
1605
+ delete: (rolesUid: number) => Promise<BaseResponse<RolesDeleteData>>;
1606
+ bundles: {
1607
+ /**
1608
+ * List role-bundle memberships
1609
+ * Call: api.agrInt.roles.bundles.list(rolesUid, params)
1610
+ *
1611
+ * List a role's bundle memberships with pagination and filtering
1612
+ *
1613
+ * Errors:
1614
+ * 400: Bad request: the body is missing or a parameter is invalid; message says which.
1615
+ * 403: The bearer token does not belong to an admin user.
1616
+ * 404: No roles row with this rolesUid.
1617
+ *
1618
+ * GET https://agr-int.augur-api.com/roles/{rolesUid}/bundles
1619
+ * Contract:
1620
+ * https://agr-int.augur-api.com/openapi.json#/paths/~1roles~1{rolesUid}~1bundles/get
1621
+ *
1622
+ * @param rolesUid Unique ID of the role
1623
+ * @param params RolesBundlesListParams (query string)
1624
+ * @returns BaseResponse whose `data` is RolesBundlesListData
1625
+ */
1626
+ list: (rolesUid: number, params?: RolesBundlesListParams) => Promise<BaseResponse<RolesBundlesListData>>;
1627
+ /**
1628
+ * Assign or reactivate a role-bundle membership
1629
+ * Call: api.agrInt.roles.bundles.create(rolesUid, data)
1630
+ *
1631
+ * Assign a bundle to a role, or reactivate a previously revoked membership. Body MUST include
1632
+ * bundlesUid.
1633
+ *
1634
+ * Request body: Assign a bundle to the role in the path, or re-activate the existing
1635
+ * membership
1636
+ *
1637
+ * Errors:
1638
+ * 400: A required body field is missing or has the wrong type.
1639
+ * 403: The bearer token does not belong to an admin user.
1640
+ * 404: No roles row with this rolesUid.
1641
+ *
1642
+ * POST https://agr-int.augur-api.com/roles/{rolesUid}/bundles
1643
+ * Contract:
1644
+ * https://agr-int.augur-api.com/openapi.json#/paths/~1roles~1{rolesUid}~1bundles/post
1645
+ *
1646
+ * @param rolesUid Unique ID of the role
1647
+ * @param data RolesBundlesCreateBody (request body)
1648
+ * @returns BaseResponse whose `data` is RolesBundlesCreateData
1649
+ */
1650
+ create: (rolesUid: number, data: RolesBundlesCreateBody) => Promise<BaseResponse<RolesBundlesCreateData>>;
1651
+ /**
1652
+ * Get a role-bundle membership
1653
+ * Call: api.agrInt.roles.bundles.get(rolesUid, rolesXBundlesUid)
1654
+ *
1655
+ * Get a role-bundle membership by UID
1656
+ *
1657
+ * Errors:
1658
+ * 403: The bearer token does not belong to an admin user.
1659
+ * 404: Membership not found for this role.
1660
+ *
1661
+ * GET https://agr-int.augur-api.com/roles/{rolesUid}/bundles/{rolesXBundlesUid}
1662
+ * Contract:
1663
+ * https://agr-int.augur-api.com/openapi.json#/paths/~1roles~1{rolesUid}~1bundles~1{rolesXBundlesUid}/get
1664
+ *
1665
+ * @param rolesUid Unique ID of the role
1666
+ * @param rolesXBundlesUid Unique ID of the role-to-bundle assignment
1667
+ * @param params RolesBundlesGetParams (query string)
1668
+ * @returns BaseResponse whose `data` is RolesBundlesGetData
1669
+ */
1670
+ get: (rolesUid: number, rolesXBundlesUid: number, params?: RolesBundlesGetParams) => Promise<BaseResponse<RolesBundlesGetData>>;
1671
+ /**
1672
+ * Update a role-bundle membership
1673
+ * Call: api.agrInt.roles.bundles.update(rolesUid, rolesXBundlesUid, data)
1674
+ *
1675
+ * Update a role-bundle membership (statusCd / processCd only)
1676
+ *
1677
+ * Request body: Partial update of a role-bundle membership; a code outside the canonical set
1678
+ * is dropped
1679
+ *
1680
+ * Errors:
1681
+ * 403: The bearer token does not belong to an admin user.
1682
+ * 404: No record with this ID. Or Membership not found for this role.
1683
+ *
1684
+ * PUT https://agr-int.augur-api.com/roles/{rolesUid}/bundles/{rolesXBundlesUid}
1685
+ * Contract:
1686
+ * https://agr-int.augur-api.com/openapi.json#/paths/~1roles~1{rolesUid}~1bundles~1{rolesXBundlesUid}/put
1687
+ *
1688
+ * @param rolesUid Unique ID of the role
1689
+ * @param rolesXBundlesUid Unique ID of the role-to-bundle assignment
1690
+ * @param data RolesBundlesUpdateBody (request body)
1691
+ * @returns BaseResponse whose `data` is RolesBundlesUpdateData
1692
+ */
1693
+ update: (rolesUid: number, rolesXBundlesUid: number, data: RolesBundlesUpdateBody) => Promise<BaseResponse<RolesBundlesUpdateData>>;
1694
+ /**
1695
+ * Revoke a role-bundle membership
1696
+ * Call: api.agrInt.roles.bundles.delete(rolesUid, rolesXBundlesUid)
1697
+ *
1698
+ * Soft-delete (revoke) a role-bundle membership
1699
+ *
1700
+ * Errors:
1701
+ * 403: The bearer token does not belong to an admin user.
1702
+ * 404: No record with this ID. Or Membership not found for this role.
1703
+ *
1704
+ * DELETE https://agr-int.augur-api.com/roles/{rolesUid}/bundles/{rolesXBundlesUid}
1705
+ * Contract:
1706
+ * https://agr-int.augur-api.com/openapi.json#/paths/~1roles~1{rolesUid}~1bundles~1{rolesXBundlesUid}/delete
1707
+ *
1708
+ * @param rolesUid Unique ID of the role
1709
+ * @param rolesXBundlesUid Unique ID of the role-to-bundle assignment
1710
+ * @returns BaseResponse whose `data` is RolesBundlesDeleteData
1711
+ */
1712
+ delete: (rolesUid: number, rolesXBundlesUid: number) => Promise<BaseResponse<RolesBundlesDeleteData>>;
1713
+ };
1714
+ };
1715
+ users: {
1716
+ /**
1717
+ * List users
1718
+ * Call: api.agrInt.users.list(params)
1719
+ *
1720
+ * List users with pagination and filtering
1721
+ *
1722
+ * Errors:
1723
+ * 400: Bad request: the body is missing or a parameter is invalid; message says which.
1724
+ * 403: The bearer token does not belong to an admin user.
1725
+ *
1726
+ * GET https://agr-int.augur-api.com/users
1727
+ * Contract: https://agr-int.augur-api.com/openapi.json#/paths/~1users/get
1728
+ *
1729
+ * @param params UsersListParams (query string)
1730
+ * @returns BaseResponse whose `data` is UsersListData
1731
+ */
1732
+ list: (params?: UsersListParams) => Promise<BaseResponse<UsersListData>>;
1733
+ /**
1734
+ * Create a user
1735
+ * Call: api.agrInt.users.create(data)
1736
+ *
1737
+ * Create a new user. Hashes password with Argon2id.
1738
+ *
1739
+ * Request body: Create an agr_int user; the password is hashed with Argon2id and never returned
1740
+ *
1741
+ * Errors:
1742
+ * 400: A required body field is missing or has the wrong type. Or The user could not be
1743
+ * created. The username or email may already be in use.
1744
+ * 403: The bearer token does not belong to an admin user.
1745
+ *
1746
+ * POST https://agr-int.augur-api.com/users
1747
+ * Contract: https://agr-int.augur-api.com/openapi.json#/paths/~1users/post
1748
+ *
1749
+ * @param data UsersCreateBody (request body)
1750
+ * @returns BaseResponse whose `data` is UsersCreateData
1751
+ */
1752
+ create: (data: UsersCreateBody) => Promise<BaseResponse<UsersCreateData>>;
1753
+ /**
1754
+ * Get a user
1755
+ * Call: api.agrInt.users.get(usersUid)
1756
+ *
1757
+ * Get a user by UID
1758
+ *
1759
+ * Errors:
1760
+ * 403: The bearer token does not belong to an admin user.
1761
+ * 404: No users row with this usersUid.
1762
+ *
1763
+ * GET https://agr-int.augur-api.com/users/{usersUid}
1764
+ * Contract: https://agr-int.augur-api.com/openapi.json#/paths/~1users~1{usersUid}/get
1765
+ *
1766
+ * @param usersUid Unique ID of the user
1767
+ * @param params UsersGetParams (query string)
1768
+ * @returns BaseResponse whose `data` is UsersGetData
1769
+ */
1770
+ get: (usersUid: number, params?: UsersGetParams) => Promise<BaseResponse<UsersGetData>>;
1771
+ /**
1772
+ * Update a user
1773
+ * Call: api.agrInt.users.update(usersUid, data)
1774
+ *
1775
+ * Update a user by UID with a partial JSON body
1776
+ *
1777
+ * Request body: Partial update of an agr_int user; an absent field keeps its current value
1778
+ *
1779
+ * Errors:
1780
+ * 403: The bearer token does not belong to an admin user.
1781
+ * 404: No record with this ID.
1782
+ *
1783
+ * PUT https://agr-int.augur-api.com/users/{usersUid}
1784
+ * Contract: https://agr-int.augur-api.com/openapi.json#/paths/~1users~1{usersUid}/put
1785
+ *
1786
+ * @param usersUid Unique ID of the user
1787
+ * @param data UsersUpdateBody (request body)
1788
+ * @returns BaseResponse whose `data` is UsersUpdateData
1789
+ */
1790
+ update: (usersUid: number, data: UsersUpdateBody) => Promise<BaseResponse<UsersUpdateData>>;
1791
+ /**
1792
+ * Soft-delete a user
1793
+ * Call: api.agrInt.users.delete(usersUid)
1794
+ *
1795
+ * Soft-delete a user by UID
1796
+ *
1797
+ * Errors:
1798
+ * 403: The bearer token does not belong to an admin user.
1799
+ * 404: No record with this ID.
1800
+ *
1801
+ * DELETE https://agr-int.augur-api.com/users/{usersUid}
1802
+ * Contract: https://agr-int.augur-api.com/openapi.json#/paths/~1users~1{usersUid}/delete
1803
+ *
1804
+ * @param usersUid Unique ID of the user
1805
+ * @returns BaseResponse whose `data` is UsersDeleteData
1806
+ */
1807
+ delete: (usersUid: number) => Promise<BaseResponse<UsersDeleteData>>;
1808
+ roles: {
1809
+ /**
1810
+ * List user-role memberships
1811
+ * Call: api.agrInt.users.roles.list(usersUid, params)
1812
+ *
1813
+ * List a user's role memberships with pagination and filtering
1814
+ *
1815
+ * Errors:
1816
+ * 400: Bad request: the body is missing or a parameter is invalid; message says which.
1817
+ * 403: The bearer token does not belong to an admin user.
1818
+ * 404: No users row with this usersUid.
1819
+ *
1820
+ * GET https://agr-int.augur-api.com/users/{usersUid}/roles
1821
+ * Contract: https://agr-int.augur-api.com/openapi.json#/paths/~1users~1{usersUid}~1roles/get
1822
+ *
1823
+ * @param usersUid Unique ID of the user
1824
+ * @param params UsersRolesListParams (query string)
1825
+ * @returns BaseResponse whose `data` is UsersRolesListData
1826
+ */
1827
+ list: (usersUid: number, params?: UsersRolesListParams) => Promise<BaseResponse<UsersRolesListData>>;
1828
+ /**
1829
+ * Assign or reactivate a user-role membership
1830
+ * Call: api.agrInt.users.roles.create(usersUid, data)
1831
+ *
1832
+ * Assign a role to a user, or reactivate a previously revoked membership. Body MUST include
1833
+ * rolesUid.
1834
+ *
1835
+ * Request body: Assign a role to the user in the path, or re-activate the existing membership
1836
+ *
1837
+ * Errors:
1838
+ * 400: A required body field is missing or has the wrong type.
1839
+ * 403: The bearer token does not belong to an admin user.
1840
+ * 404: No users row with this usersUid.
1841
+ *
1842
+ * POST https://agr-int.augur-api.com/users/{usersUid}/roles
1843
+ * Contract: https://agr-int.augur-api.com/openapi.json#/paths/~1users~1{usersUid}~1roles/post
1844
+ *
1845
+ * @param usersUid Unique ID of the user
1846
+ * @param data UsersRolesCreateBody (request body)
1847
+ * @returns BaseResponse whose `data` is UsersRolesCreateData
1848
+ */
1849
+ create: (usersUid: number, data: UsersRolesCreateBody) => Promise<BaseResponse<UsersRolesCreateData>>;
1850
+ /**
1851
+ * Get a user-role membership
1852
+ * Call: api.agrInt.users.roles.get(usersUid, usersXRolesUid)
1853
+ *
1854
+ * Get a user-role membership by UID
1855
+ *
1856
+ * Errors:
1857
+ * 403: The bearer token does not belong to an admin user.
1858
+ * 404: Membership not found for this user.
1859
+ *
1860
+ * GET https://agr-int.augur-api.com/users/{usersUid}/roles/{usersXRolesUid}
1861
+ * Contract:
1862
+ * https://agr-int.augur-api.com/openapi.json#/paths/~1users~1{usersUid}~1roles~1{usersXRolesUid}/get
1863
+ *
1864
+ * @param usersUid Unique ID of the user
1865
+ * @param usersXRolesUid Unique ID of the user-to-role assignment
1866
+ * @param params UsersRolesGetParams (query string)
1867
+ * @returns BaseResponse whose `data` is UsersRolesGetData
1868
+ */
1869
+ get: (usersUid: number, usersXRolesUid: number, params?: UsersRolesGetParams) => Promise<BaseResponse<UsersRolesGetData>>;
1870
+ /**
1871
+ * Update a user-role membership
1872
+ * Call: api.agrInt.users.roles.update(usersUid, usersXRolesUid, data)
1873
+ *
1874
+ * Update a user-role membership (statusCd / processCd only)
1875
+ *
1876
+ * Request body: Partial update of a user-role membership; a code outside the canonical set is
1877
+ * dropped
1878
+ *
1879
+ * Errors:
1880
+ * 403: The bearer token does not belong to an admin user.
1881
+ * 404: No record with this ID. Or Membership not found for this user.
1882
+ *
1883
+ * PUT https://agr-int.augur-api.com/users/{usersUid}/roles/{usersXRolesUid}
1884
+ * Contract:
1885
+ * https://agr-int.augur-api.com/openapi.json#/paths/~1users~1{usersUid}~1roles~1{usersXRolesUid}/put
1886
+ *
1887
+ * @param usersUid Unique ID of the user
1888
+ * @param usersXRolesUid Unique ID of the user-to-role assignment
1889
+ * @param data UsersRolesUpdateBody (request body)
1890
+ * @returns BaseResponse whose `data` is UsersRolesUpdateData
1891
+ */
1892
+ update: (usersUid: number, usersXRolesUid: number, data: UsersRolesUpdateBody) => Promise<BaseResponse<UsersRolesUpdateData>>;
1893
+ /**
1894
+ * Revoke a user-role membership
1895
+ * Call: api.agrInt.users.roles.delete(usersUid, usersXRolesUid)
1896
+ *
1897
+ * Soft-delete (revoke) a user-role membership
1898
+ *
1899
+ * Errors:
1900
+ * 403: The bearer token does not belong to an admin user.
1901
+ * 404: No record with this ID. Or Membership not found for this user.
1902
+ *
1903
+ * DELETE https://agr-int.augur-api.com/users/{usersUid}/roles/{usersXRolesUid}
1904
+ * Contract:
1905
+ * https://agr-int.augur-api.com/openapi.json#/paths/~1users~1{usersUid}~1roles~1{usersXRolesUid}/delete
1906
+ *
1907
+ * @param usersUid Unique ID of the user
1908
+ * @param usersXRolesUid Unique ID of the user-to-role assignment
1909
+ * @returns BaseResponse whose `data` is UsersRolesDeleteData
1910
+ */
1911
+ delete: (usersUid: number, usersXRolesUid: number) => Promise<BaseResponse<UsersRolesDeleteData>>;
1912
+ };
1913
+ rotate: {
1914
+ /**
1915
+ * Rotate a user token
1916
+ * Call: api.agrInt.users.rotate.create(data)
1917
+ *
1918
+ * Exchange a current, still-valid agr_int user token for a fresh one. Reads {token} from the
1919
+ * body. Returns {usersUid, username, token} on success, 401 for an
1920
+ * invalid/expired/wrong-scope/revoked token.
1921
+ *
1922
+ * Request body: Exchange a current, still-valid agr_int user token for a fresh one
1923
+ * Response data: Minimal identity returned by POST /api/users/verify on a successful
1924
+ *
1925
+ * Errors:
1926
+ * 403: Only the augur_info site may call this endpoint.
1927
+ *
1928
+ * POST https://agr-int.augur-api.com/users/rotate
1929
+ * Contract: https://agr-int.augur-api.com/openapi.json#/paths/~1users~1rotate/post
1930
+ *
1931
+ * @param data UsersRotateCreateBody (request body)
1932
+ * @returns BaseResponse whose `data` is UsersRotateCreateData
1933
+ */
1934
+ create: (data: UsersRotateCreateBody) => Promise<BaseResponse<UsersRotateCreateData>>;
1935
+ };
1936
+ validate: {
1937
+ /**
1938
+ * Validate a user token
1939
+ * Call: api.agrInt.users.validate.create(data)
1940
+ *
1941
+ * Introspect a presented agr_int user token. Reads {token} from the body. Always 200; returns
1942
+ * {valid, scope, userId, username, email, name, roles, bundles, resources}. valid is false
1943
+ * for an invalid/expired/wrong-scope/revoked token. resources is the P21 table set the user
1944
+ * may query (roles/bundles are display/audit context).
1945
+ *
1946
+ * Request body: Introspect an agr_int user access token
1947
+ * Response data: Result of validating a presented agr_int user token.
1948
+ *
1949
+ * Errors:
1950
+ * 403: Only the augur_info site may call this endpoint.
1951
+ *
1952
+ * POST https://agr-int.augur-api.com/users/validate
1953
+ * Contract: https://agr-int.augur-api.com/openapi.json#/paths/~1users~1validate/post
1954
+ *
1955
+ * @param data UsersValidateCreateBody (request body)
1956
+ * @returns BaseResponse whose `data` is UsersValidateCreateData
1957
+ */
1958
+ create: (data: UsersValidateCreateBody) => Promise<BaseResponse<UsersValidateCreateData>>;
1959
+ };
1960
+ verify: {
1961
+ /**
1962
+ * Verify user credentials
1963
+ * Call: api.agrInt.users.verify.create(data)
1964
+ *
1965
+ * Verify a user's credentials against the stored Argon2id hash. Returns a minimal identity
1966
+ * object {usersUid, username} on match, 401 otherwise.
1967
+ *
1968
+ * Request body: Verify a user's username and password on a target site
1969
+ * Response data: Minimal identity returned by POST /api/users/verify on a successful
1970
+ *
1971
+ * Errors:
1972
+ * 403: Only the augur_info site may call this endpoint.
1973
+ *
1974
+ * POST https://agr-int.augur-api.com/users/verify
1975
+ * Contract: https://agr-int.augur-api.com/openapi.json#/paths/~1users~1verify/post
1976
+ *
1977
+ * @param data UsersVerifyCreateBody (request body)
1978
+ * @returns BaseResponse whose `data` is UsersVerifyCreateData
1979
+ */
1980
+ create: (data: UsersVerifyCreateBody) => Promise<BaseResponse<UsersVerifyCreateData>>;
1981
+ };
1982
+ };
1983
+ }
1984
+ //# sourceMappingURL=types.d.ts.map