@simpleapps-com/augur-api 2026.10.31 → 2026.11.2

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 +85 -34
  2. package/SKILL.md +25 -24
  3. package/dist/client.d.ts +336 -0
  4. package/dist/client.d.ts.map +1 -0
  5. package/dist/core/base-client.d.ts +159 -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 +26 -0
  34. package/dist/core/response-rules.d.ts.map +1 -0
  35. package/dist/core/schemas.d.ts +71 -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 +19565 -18212
  46. package/dist/index.js.map +1 -1
  47. package/dist/index.mjs +19564 -18212
  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 +299 -0
  54. package/dist/services/agr-info/generated/schemas.d.ts.map +1 -0
  55. package/dist/services/agr-info/generated/types.d.ts +1111 -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 +550 -0
  174. package/dist/services/joomla/generated/schemas.d.ts.map +1 -0
  175. package/dist/services/joomla/generated/types.d.ts +1502 -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 +30 -47
  358. package/dist/client-TPJa269Y.d.mts +0 -58610
  359. package/dist/client-TPJa269Y.d.ts +0 -58610
  360. package/dist/index.d.mts +0 -236
  361. package/dist/testing.d.mts +0 -83
@@ -0,0 +1,1502 @@
1
+ /**
2
+ * Generated types for the joomla service.
3
+ * Joomla CMS integration syncing content, users, categories, menus, and extensions
4
+ *
5
+ * Public specs (the source of truth for every shape below):
6
+ * https://joomla.augur-api.com/endpoints.jsonl: one JSON line per endpoint: method, path, path
7
+ * params and query params, each with type and required flag. Grep it for a path; for a GET
8
+ * that line is all you need. Bodies are not in it.
9
+ * https://joomla.augur-api.com/openapi.json: the full contract: request and response bodies field
10
+ * by field, descriptions, formats and documented errors.
11
+ * https://joomla.augur-api.com/llms.txt: the plain-text endpoint list and the other Augur
12
+ * services.
13
+ *
14
+ * Source: shared/specs/joomla.json
15
+ *
16
+ * DO NOT EDIT — regenerate with: pnpm -C tools/augur-api-generator generate ts
17
+ */
18
+ import type { EdgeCacheParams } from "../../../core/common-schemas";
19
+ import type { BaseResponse } from "../../../core/schemas";
20
+ /** Params for GET /action-logs */
21
+ export interface ActionLogsListParams extends EdgeCacheParams {
22
+ /** Filter by Joomla extension (e.g. com_users) */
23
+ extension?: string;
24
+ /** Filter by affected item id */
25
+ itemId?: number;
26
+ /** Limit number of results (Default: 10) */
27
+ limit?: number;
28
+ /** Offset number of results (Default: 0) */
29
+ offset?: number;
30
+ /** Sort ordering (Default: id|DESC) */
31
+ orderBy?: string;
32
+ /** Filter by Joomla user id */
33
+ userId?: number;
34
+ }
35
+ /** Params for GET /action-logs/{id} */
36
+ export type ActionLogsGetParams = EdgeCacheParams;
37
+ /** Params for GET /categories */
38
+ export interface CategoriesListParams extends EdgeCacheParams {
39
+ /** Extension filter (e.g. com_content) */
40
+ extension?: string;
41
+ /** Limit number of results (Default: 10) */
42
+ limit?: number;
43
+ /** Offset number of results (Default: 0) */
44
+ offset?: number;
45
+ /** Sort ordering (Default: id|ASC) */
46
+ orderBy?: string;
47
+ /** Parent category ID */
48
+ parentId?: number;
49
+ /** Published state filter */
50
+ published?: number;
51
+ }
52
+ /** Params for GET /categories/{id} */
53
+ export type CategoriesGetParams = EdgeCacheParams;
54
+ /** Params for GET /content */
55
+ export interface ContentListParams extends EdgeCacheParams {
56
+ /** CSV List of category IDs */
57
+ categoryIdList?: string;
58
+ /** Limit number of results (Default: 10) */
59
+ limit?: number;
60
+ /** Offset number of results (Default: 0) */
61
+ offset?: number;
62
+ /** Sort ordering: default (ordering|ASC) */
63
+ orderBy?: string;
64
+ /** Query string */
65
+ q?: string;
66
+ /** CSV List of tags */
67
+ tagsList?: string;
68
+ }
69
+ /** Params for GET /content/{id} */
70
+ export interface ContentGetParams extends EdgeCacheParams {
71
+ /** content.alias */
72
+ alias?: string;
73
+ /** content.catid */
74
+ catid?: number;
75
+ }
76
+ /** Params for GET /content/{id}/doc */
77
+ export interface ContentDocListParams extends EdgeCacheParams {
78
+ /** content.alias */
79
+ alias?: string;
80
+ /** content.catid */
81
+ catid?: number;
82
+ }
83
+ /** Params for GET /menu */
84
+ export interface MenuListParams extends EdgeCacheParams {
85
+ /** Limit number of results (Default: 10) */
86
+ limit?: number;
87
+ /** Joomla menu type identifier */
88
+ menutype?: string;
89
+ /** Offset number of results (Default: 0) */
90
+ offset?: number;
91
+ /** Sort ordering (Default: lft|ASC) */
92
+ orderBy?: string;
93
+ /** Parent menu item ID */
94
+ parentId?: number;
95
+ /** Published state filter */
96
+ published?: number;
97
+ }
98
+ /** Params for GET /menu/{id}/doc */
99
+ export interface MenuDocListParams extends EdgeCacheParams {
100
+ /** Menu alias for lookup when id=0 */
101
+ alias?: string;
102
+ }
103
+ /** Params for GET /modules */
104
+ export interface ModulesListParams extends EdgeCacheParams {
105
+ /** Limit number of results (Default: 10) */
106
+ limit?: number;
107
+ /** Modules shown on this menu item (menu.id), per Joomla assignment rules */
108
+ menuId?: number;
109
+ /** Module type (e.g. mod_custom) */
110
+ module?: string;
111
+ /** Offset number of results (Default: 0) */
112
+ offset?: number;
113
+ /** Sort ordering (Default: id|ASC) */
114
+ orderBy?: string;
115
+ /** Template position */
116
+ position?: string;
117
+ /** 1 published (Default), 0 unpublished, -1 all */
118
+ published?: number;
119
+ /** Title contains */
120
+ q?: string;
121
+ }
122
+ /** Params for GET /modules/{id} */
123
+ export interface ModulesGetParams extends EdgeCacheParams {
124
+ /** Y decodes params from JSON and returns Joomla zero dates as null */
125
+ normalize?: string;
126
+ }
127
+ /** Params for GET /tags */
128
+ export interface TagsListParams extends EdgeCacheParams {
129
+ /** Category whose published articles are counted per tag (total) */
130
+ catId?: number;
131
+ /** Limit number of results (Default: 10) */
132
+ limit?: number;
133
+ /** Offset number of results (Default: 0) */
134
+ offset?: number;
135
+ /** Order By (Default: title|ASC) */
136
+ orderBy?: string;
137
+ /** Parent tag; only its direct published children are listed (Default: 0) */
138
+ parentId?: number;
139
+ /** Query string */
140
+ q?: string;
141
+ }
142
+ /** Params for GET /usergroups */
143
+ export interface UsergroupsListParams extends EdgeCacheParams {
144
+ /**
145
+ * Shape of each group [Y|N] (default N = the title string; Y = an object with id, title and
146
+ * parentId)
147
+ */
148
+ fullDocument?: string;
149
+ /** Select order of the groups Default: title|ASC */
150
+ orderBy?: string;
151
+ /** CSV List of parent ids (default:blank) */
152
+ parentIdList?: string;
153
+ }
154
+ /** Params for GET /users */
155
+ export interface UsersListParams extends EdgeCacheParams {
156
+ /** Access level group ID list filter */
157
+ accessLevelList?: string;
158
+ /** Filter by block status (0 active, 1 blocked, -1 all, default 0) */
159
+ blocked?: number;
160
+ /** Contact ID filter */
161
+ contactId?: string;
162
+ /** Customer ID filter */
163
+ customerId?: number;
164
+ /** Y = users with a contact ID; N = users with none (missing, empty or 0). Absent = no filter */
165
+ hasContactId?: string;
166
+ /** Y = users with a customer ID; N = users with none (missing, empty or 0). Absent = no filter */
167
+ hasCustomerId?: string;
168
+ /** Limit number of results (Default: 10) */
169
+ limit?: number;
170
+ /** Offset number of results (Default: 0) */
171
+ offset?: number;
172
+ /** Order by clause (e.g. id|ASC) */
173
+ orderBy?: string;
174
+ /** Username/name/email search query */
175
+ q?: string;
176
+ }
177
+ /** Params for GET /users/{id} */
178
+ export type UsersGetParams = EdgeCacheParams;
179
+ /** Params for DELETE /users/{id} */
180
+ export interface UsersDeleteParams {
181
+ /**
182
+ * Y = delete the user permanently instead of blocking. Cannot be undone. Absent or any other
183
+ * value = block
184
+ */
185
+ hardDelete?: string;
186
+ }
187
+ /** Params for GET /users/{id}/doc */
188
+ export interface UsersDocListParams extends EdgeCacheParams {
189
+ /** Include ship-to header data in response */
190
+ includeShipTo?: string;
191
+ }
192
+ /** Params for GET /users/{id}/groups */
193
+ export interface UsersGroupsListParams extends EdgeCacheParams {
194
+ /** Limit number of results (Default: 10) */
195
+ limit?: number;
196
+ /** Starting offset results (Default: 0) */
197
+ offset?: number;
198
+ /** Order By (Default: group_id|ASC) */
199
+ orderBy?: string;
200
+ }
201
+ /** Params for GET /users/{id}/groups/{groupId} */
202
+ export type UsersGroupsGetParams = EdgeCacheParams;
203
+ /** Params for GET /users/{id}/trinity */
204
+ export type UsersTrinityListParams = EdgeCacheParams;
205
+ /**
206
+ * List Action Logs
207
+ * Response data for GET /action-logs — MINIMUM fields, extras pass through
208
+ *
209
+ * Returned by: api.joomla.actionLogs.list(params) (array items)
210
+ * Returned by: api.joomla.actionLogs.get(id)
211
+ */
212
+ export interface ActionLogsListItem {
213
+ /** Action log ID */
214
+ id: number;
215
+ /** Joomla language key of the log message (max 255 chars) */
216
+ messageLanguageKey: string;
217
+ /** Log message data (JSON) */
218
+ message: string;
219
+ /** When the action happened (mysql-datetime, e.g. 2025-07-30 15:50:49) */
220
+ logDate: string;
221
+ /** Extension that logged the action (e.g. com_users) (max 50 chars) */
222
+ extension: string;
223
+ /** Joomla user who acted */
224
+ userId: number;
225
+ /** ID of the item acted on */
226
+ itemId: number;
227
+ /** IP address of the request (max 40 chars) */
228
+ ipAddress: string;
229
+ [key: string]: unknown;
230
+ }
231
+ /** Returned by: api.joomla.actionLogs.list(params) */
232
+ export type ActionLogsListData = ActionLogsListItem[];
233
+ /**
234
+ * Get Action Log Doc
235
+ * Response data for GET /action-logs/{id} — MINIMUM fields, extras pass through
236
+ *
237
+ * Returned by: api.joomla.actionLogs.get(id)
238
+ */
239
+ export type ActionLogsGetData = ActionLogsListItem;
240
+ /**
241
+ * List Categories
242
+ * Response data for GET /categories — MINIMUM fields, extras pass through
243
+ *
244
+ * Returned by: api.joomla.categories.list(params) (array items)
245
+ * Returned by: api.joomla.categories.get(id)
246
+ */
247
+ export interface CategoriesListItem {
248
+ /** Category ID */
249
+ id: number;
250
+ /** Joomla asset (ACL) ID */
251
+ assetId: number;
252
+ /** Parent category ID */
253
+ parentId: number;
254
+ /** Nested-set left value */
255
+ lft: number;
256
+ /** Nested-set right value */
257
+ rgt: number;
258
+ /** Depth in the tree */
259
+ level: number;
260
+ /** Route path (max 400 chars) */
261
+ path: string;
262
+ /** Extension the category belongs to (e.g. com_content) (max 50 chars) */
263
+ extension: string;
264
+ /** Title (max 255 chars) */
265
+ title: string;
266
+ /** URL alias (max 400 chars) */
267
+ alias: string;
268
+ /** Admin note (max 255 chars) */
269
+ note: string;
270
+ /** Category description (HTML) */
271
+ description: string | null;
272
+ /** Publish state (1 = published, 0 = unpublished, -2 = trashed) */
273
+ published: number;
274
+ /** User who has the record checked out; 0 when none */
275
+ checkedOut: number;
276
+ /** When the record was checked out (mysql-datetime, e.g. 2025-07-30 15:50:49) */
277
+ checkedOutTime: string;
278
+ /** Access level ID */
279
+ access: number;
280
+ /** Joomla params JSON */
281
+ params: string | null;
282
+ /** Meta description (max 1024 chars) */
283
+ metadesc: string;
284
+ /** Meta keywords (max 1024 chars) */
285
+ metakey: string;
286
+ /** Metadata JSON (max 2048 chars) */
287
+ metadata: string;
288
+ /** User who created the category */
289
+ createdUserId: number;
290
+ /** When the category was created (mysql-datetime, e.g. 2025-07-30 15:50:49) */
291
+ createdTime: string;
292
+ /** User who last changed the category */
293
+ modifiedUserId: number;
294
+ /** When the category was last changed (mysql-datetime, e.g. 2025-07-30 15:50:49) */
295
+ modifiedTime: string;
296
+ /** Page views */
297
+ hits: number;
298
+ /** Language tag (* = all) (max 7 chars) */
299
+ language: string;
300
+ /** Version number */
301
+ version: number;
302
+ [key: string]: unknown;
303
+ }
304
+ /** Returned by: api.joomla.categories.list(params) */
305
+ export type CategoriesListData = CategoriesListItem[];
306
+ /**
307
+ * Get Category by ID
308
+ * Response data for GET /categories/{id} — MINIMUM fields, extras pass through
309
+ *
310
+ * Returned by: api.joomla.categories.get(id)
311
+ */
312
+ export type CategoriesGetData = CategoriesListItem;
313
+ /**
314
+ * Shape of `fields` (MINIMUM fields; reused wherever the same shape appears)
315
+ * Custom field values
316
+ *
317
+ * Field `fields` of ContentListItem
318
+ */
319
+ export interface ContentListItemFieldsItem {
320
+ /** Field value */
321
+ value: string;
322
+ /** Field title */
323
+ title: string;
324
+ /** Field name */
325
+ name: string;
326
+ /** Field label */
327
+ label: string;
328
+ [key: string]: unknown;
329
+ }
330
+ /**
331
+ * Get Content list
332
+ * Response data for GET /content — MINIMUM fields, extras pass through
333
+ *
334
+ * Returned by: api.joomla.content.list(params) (array items)
335
+ * Returned by: api.joomla.content.doc.list(id, params)
336
+ */
337
+ export interface ContentListItem {
338
+ /** Article ID */
339
+ id: number;
340
+ /** Title */
341
+ title: string;
342
+ /** URL alias */
343
+ alias: string;
344
+ /** Category ID */
345
+ catid: number;
346
+ /** Intro text (HTML) */
347
+ introtext: string | null;
348
+ /** Full text (HTML) */
349
+ fulltext: string | null;
350
+ /** Sort position within the category */
351
+ ordering: number;
352
+ /**
353
+ * Joomla images JSON (image_intro, image_fulltext and their attributes); [] when none ([] when
354
+ * empty)
355
+ */
356
+ images: Record<string, unknown> | [];
357
+ /** Custom field values */
358
+ fields: ContentListItemFieldsItem[];
359
+ [key: string]: unknown;
360
+ }
361
+ /** Returned by: api.joomla.content.list(params) */
362
+ export type ContentListData = ContentListItem[];
363
+ /**
364
+ * Get Content Detail
365
+ * Response data for GET /content/{id} — MINIMUM fields, extras pass through
366
+ *
367
+ * Returned by: api.joomla.content.get(id, params)
368
+ */
369
+ export interface ContentGetData {
370
+ /** Article ID */
371
+ id: number;
372
+ /** Title */
373
+ title: string;
374
+ /** URL alias */
375
+ alias: string;
376
+ /** Intro text (HTML) */
377
+ introtext: string | null;
378
+ /** Full text (HTML) */
379
+ fulltext: string | null;
380
+ /** Category ID */
381
+ catid: number;
382
+ [key: string]: unknown;
383
+ }
384
+ /**
385
+ * Get Content Doc
386
+ * Response data for GET /content/{id}/doc — MINIMUM fields, extras pass through
387
+ *
388
+ * Returned by: api.joomla.content.doc.list(id, params)
389
+ */
390
+ export type ContentDocListData = ContentListItem;
391
+ /**
392
+ * List Menu Items
393
+ * Response data for GET /menu — MINIMUM fields, extras pass through
394
+ *
395
+ * Returned by: api.joomla.menu.list(params) (array items)
396
+ */
397
+ export interface MenuListItem {
398
+ /** Menu item ID */
399
+ id: number;
400
+ /** Menu the item belongs to (max 24 chars) */
401
+ menutype: string;
402
+ /** Title (max 255 chars) */
403
+ title: string;
404
+ /** URL alias (max 400 chars) */
405
+ alias: string;
406
+ /** Admin note (max 255 chars) */
407
+ note: string;
408
+ /** Route path (max 1024 chars) */
409
+ path: string;
410
+ /** Joomla link (index.php?option=...) (max 1024 chars) */
411
+ link: string;
412
+ /** Item type (component, url, alias, separator, heading) (max 16 chars) */
413
+ type: string;
414
+ /** Publish state (1 = published, 0 = unpublished, -2 = trashed) */
415
+ published: number;
416
+ /** Depth in the tree */
417
+ level: number;
418
+ /** Component the item opens */
419
+ componentId: number;
420
+ /** User who has the record checked out; 0 when none */
421
+ checkedOut: number;
422
+ /** When the record was checked out (mysql-datetime, e.g. 2025-07-30 15:50:49) */
423
+ checkedOutTime: string;
424
+ /** Target window (0 = parent, 1 = new window, 2 = popup) */
425
+ browserNav: number;
426
+ /** Access level ID */
427
+ access: number;
428
+ /** Menu image (max 255 chars) */
429
+ img: string;
430
+ /** Template style; 0 for the default */
431
+ templateStyleId: number;
432
+ /** Joomla params JSON */
433
+ params: string;
434
+ /** Nested-set left value */
435
+ lft: number;
436
+ /** Nested-set right value */
437
+ rgt: number;
438
+ /** 1 when this is the home page */
439
+ home: number;
440
+ /** Language tag (* = all) (max 7 chars) */
441
+ language: string;
442
+ /** 0 = site, 1 = administrator */
443
+ clientId: number;
444
+ /** Parent menu item ID */
445
+ parentId: number;
446
+ [key: string]: unknown;
447
+ }
448
+ /** Returned by: api.joomla.menu.list(params) */
449
+ export type MenuListData = MenuListItem[];
450
+ /**
451
+ * Get Menu Doc
452
+ * Response data for GET /menu/{id}/doc — MINIMUM fields, extras pass through
453
+ *
454
+ * Returned by: api.joomla.menu.doc.list(id, params)
455
+ */
456
+ export interface MenuDocListData {
457
+ /** Menu item ID */
458
+ id: number;
459
+ /** Access level */
460
+ access: number;
461
+ /** URL alias */
462
+ alias: string;
463
+ /** Depth in the menu tree */
464
+ level: number;
465
+ /** Joomla link (index.php?option=...) */
466
+ link: string;
467
+ /** Menu the item belongs to */
468
+ menuType: string;
469
+ /** Parent menu item ID */
470
+ parentId: number;
471
+ /** Route path */
472
+ path: string;
473
+ /** 1 when published */
474
+ published: number;
475
+ /** Title */
476
+ title: string;
477
+ /** Item type (component, url, alias, separator, heading) */
478
+ type: string;
479
+ /** Child menu items */
480
+ children: unknown[];
481
+ [key: string]: unknown;
482
+ }
483
+ /**
484
+ * List Modules
485
+ * Response data for GET /modules — MINIMUM fields, extras pass through
486
+ *
487
+ * Returned by: api.joomla.modules.list(params) (array items)
488
+ * Returned by: api.joomla.modules.get(id, params)
489
+ */
490
+ export interface ModulesListItem {
491
+ /** Module ID */
492
+ id: number;
493
+ /** Joomla asset (ACL) ID */
494
+ assetId: number;
495
+ /** Title (max 100 chars) */
496
+ title: string;
497
+ /** Admin note (max 255 chars) */
498
+ note: string;
499
+ /** Custom module content (HTML) */
500
+ content: string | null;
501
+ /** Sort position within the position */
502
+ ordering: number;
503
+ /** Template position the module renders in (max 50 chars) */
504
+ position: string;
505
+ /** User who has the record checked out; 0 when none */
506
+ checkedOut: number;
507
+ /** When the record was checked out (mysql-datetime, e.g. 2025-07-30 15:50:49) */
508
+ checkedOutTime: string;
509
+ /** Start publishing (mysql-datetime, e.g. 2025-07-30 15:50:49) */
510
+ publishUp: string;
511
+ /** Finish publishing (mysql-datetime, e.g. 2025-07-30 15:50:49) */
512
+ publishDown: string;
513
+ /** Publish state (1 = published, 0 = unpublished, -2 = trashed) */
514
+ published: number;
515
+ /** Module type (e.g. mod_custom) (max 50 chars) */
516
+ module: string | null;
517
+ /** Access level ID */
518
+ access: number;
519
+ /** 1 when the title is shown */
520
+ showtitle: number;
521
+ /** Joomla params JSON */
522
+ params: string;
523
+ /** 0 = site, 1 = administrator */
524
+ clientId: number;
525
+ /** Language tag (* = all) (max 7 chars) */
526
+ language: string;
527
+ [key: string]: unknown;
528
+ }
529
+ /** Returned by: api.joomla.modules.list(params) */
530
+ export type ModulesListData = ModulesListItem[];
531
+ /**
532
+ * Get Module
533
+ * Response data for GET /modules/{id} — MINIMUM fields, extras pass through
534
+ *
535
+ * Returned by: api.joomla.modules.get(id, params)
536
+ */
537
+ export type ModulesGetData = ModulesListItem;
538
+ /**
539
+ * Get tag list
540
+ * Response data for GET /tags — MINIMUM fields, extras pass through
541
+ *
542
+ * Returned by: api.joomla.tags.list(params) (array items)
543
+ */
544
+ export interface TagsListItem {
545
+ /** Tag ID */
546
+ id: number | null;
547
+ /** Tag title */
548
+ tag: string;
549
+ /** Published articles in the requested category (catId) that carry the tag */
550
+ total: number;
551
+ [key: string]: unknown;
552
+ }
553
+ /** Returned by: api.joomla.tags.list(params) */
554
+ export type TagsListData = TagsListItem[];
555
+ /**
556
+ * Shape of data nested in UsergroupsListData (MINIMUM fields; reused wherever the same shape
557
+ * appears)
558
+ *
559
+ * Nested in UsergroupsListData
560
+ */
561
+ export interface UsergroupsListDataOption2Item {
562
+ /** User group ID, the id the user group write routes take */
563
+ id: number;
564
+ /** User group title */
565
+ title: string;
566
+ /** ID of the parent user group (0 for the root group) */
567
+ parentId: number;
568
+ [key: string]: unknown;
569
+ }
570
+ /**
571
+ * Get User Groups
572
+ * Response data for GET /usergroups — MINIMUM fields, extras pass through
573
+ *
574
+ * Returned by: api.joomla.usergroups.list(params)
575
+ */
576
+ export type UsergroupsListData = string[] | UsergroupsListDataOption2Item[];
577
+ /**
578
+ * Shape of `groups` (MINIMUM fields; reused wherever the same shape appears)
579
+ * User groups the user belongs to
580
+ *
581
+ * Field `groups` of UsersListItem
582
+ * Field `groups` of UsersTrinityListData
583
+ */
584
+ export interface UsersListItemGroupsItem {
585
+ /** User group ID */
586
+ id: number;
587
+ /** User group title */
588
+ title: string;
589
+ [key: string]: unknown;
590
+ }
591
+ /**
592
+ * Shape of `address` (MINIMUM fields; reused wherever the same shape appears)
593
+ * The ship-to's address; null when no address row matches
594
+ *
595
+ * Field `address` of UsersListItemShipToItem
596
+ */
597
+ export interface UsersListItemShipToItemAddress {
598
+ /** Prophet 21 address ID */
599
+ id: number;
600
+ /** Address name (max 50 chars) */
601
+ name: string;
602
+ /** Mailing address line 1 (max 50 chars) */
603
+ mailAddress1: string | null;
604
+ /** Mailing address line 2 (max 50 chars) */
605
+ mailAddress2: string | null;
606
+ /** Mailing address line 3 (max 50 chars) */
607
+ mailAddress3: string | null;
608
+ /** Mailing city (max 50 chars) */
609
+ mailCity: string | null;
610
+ /** Mailing state or province (max 50 chars) */
611
+ mailState: string | null;
612
+ /** Mailing postal code (max 10 chars) */
613
+ mailPostalCode: string | null;
614
+ /** Mailing country (max 50 chars) */
615
+ mailCountry: string | null;
616
+ /** Physical address line 1 (max 50 chars) */
617
+ physAddress1: string | null;
618
+ /** Physical address line 2 (max 50 chars) */
619
+ physAddress2: string | null;
620
+ /** Physical address line 3 (max 50 chars) */
621
+ physAddress3: string | null;
622
+ /** Physical city (max 50 chars) */
623
+ physCity: string | null;
624
+ /** Physical state or province (max 50 chars) */
625
+ physState: string | null;
626
+ /** Physical postal code (max 10 chars) */
627
+ physPostalCode: string | null;
628
+ /** Physical country (max 50 chars) */
629
+ physCountry: string | null;
630
+ /** Address class 5 (max 8 chars) */
631
+ class5Id: string | null;
632
+ /** Main phone number (max 20 chars) */
633
+ centralPhoneNumber: string | null;
634
+ /** UPS code for the address (max 40 chars) */
635
+ upsCode: string | null;
636
+ [key: string]: unknown;
637
+ }
638
+ /**
639
+ * Shape of `shipTo` (MINIMUM fields; reused wherever the same shape appears)
640
+ * The contact's ship-tos; present only with includeShipTo=Y
641
+ *
642
+ * Field `shipTo` of UsersListItem
643
+ */
644
+ export interface UsersListItemShipToItem {
645
+ /** Prophet 21 ship-to ID (also its address ID) */
646
+ shipToId: number;
647
+ /** Prophet 21 customer the ship-to belongs to */
648
+ customerId: number;
649
+ /** Prophet 21 company (max 8 chars) */
650
+ companyId: string;
651
+ /** Default branch for the ship-to (max 8 chars) */
652
+ defaultBranch: string;
653
+ /** Prophet 21 address ID of the default carrier */
654
+ defaultCarrierId: number | null;
655
+ /** Prophet 21 location the ship-to prefers to ship from */
656
+ preferredLocationId: number | null;
657
+ /** Delivery instructions for the carrier (max 255 chars) */
658
+ deliveryInstructions: string | null;
659
+ /** Shipping route assigned to the ship-to */
660
+ shippingRouteUid: number | null;
661
+ /** Shipping route code */
662
+ routeCode: string | null;
663
+ /** Shipping route description */
664
+ routeDescription: string | null;
665
+ /** The ship-to's address; null when no address row matches */
666
+ address: UsersListItemShipToItemAddress | null;
667
+ [key: string]: unknown;
668
+ }
669
+ /**
670
+ * Get User List
671
+ * Response data for GET /users — MINIMUM fields, extras pass through
672
+ *
673
+ * Returned by: api.joomla.users.list(params) (array items)
674
+ * Returned by: api.joomla.users.doc.list(id, params)
675
+ */
676
+ export interface UsersListItem {
677
+ /** Email address */
678
+ email: string;
679
+ /** Joomla user ID */
680
+ id: number;
681
+ /** Last password reset (Y-m-d H:i:s) */
682
+ lastResetTime: string;
683
+ /** Last visit (Y-m-d H:i:s) */
684
+ lastvisitDate: string;
685
+ /** Display name */
686
+ name: string;
687
+ /** Registration date (Y-m-d H:i:s) */
688
+ registerDate: string;
689
+ /** Username */
690
+ username: string;
691
+ /** 1 when the user is blocked */
692
+ block: number;
693
+ /** Profile values keyed by profile key; {} when the user has none */
694
+ profileValues: Record<string, string>;
695
+ /** Prophet 21 customer ID from the profile; empty when unset */
696
+ customerId: string;
697
+ /** Prophet 21 contact ID from the profile; empty when unset */
698
+ contactId: string;
699
+ /** Timezone (America/New_York when unset) */
700
+ timezone: string;
701
+ /** Language (en-US when unset) */
702
+ language: string;
703
+ /** User groups the user belongs to */
704
+ groups: UsersListItemGroupsItem[];
705
+ /** The contact's ship-tos; present only with includeShipTo=Y */
706
+ shipTo?: UsersListItemShipToItem[] | null;
707
+ [key: string]: unknown;
708
+ }
709
+ /** Returned by: api.joomla.users.list(params) */
710
+ export type UsersListData = UsersListItem[];
711
+ /**
712
+ * Create a user
713
+ * Response data for POST /users — MINIMUM fields, extras pass through
714
+ *
715
+ * Returned by: api.joomla.users.create(data)
716
+ */
717
+ export interface UsersCreateData {
718
+ /** Username */
719
+ username: string;
720
+ /** Joomla user ID */
721
+ id: number;
722
+ /** Email address */
723
+ email: string;
724
+ /** Display name */
725
+ name: string;
726
+ [key: string]: unknown;
727
+ }
728
+ /**
729
+ * Create a user
730
+ * Request body for POST /users — MINIMUM fields, extras pass through
731
+ *
732
+ * Request body of: api.joomla.users.create(data)
733
+ */
734
+ export interface UsersCreateBody {
735
+ /** Username; when it already exists the existing user is returned and nothing changes */
736
+ username: string;
737
+ /** Email address; required for a new user */
738
+ email?: string | null;
739
+ /** Display name */
740
+ name?: string | null;
741
+ /** Plain-text password, stored as a bcrypt hash */
742
+ password?: string | null;
743
+ /** User group IDs; Registered is always added */
744
+ groups?: number[] | null;
745
+ /**
746
+ * Profile values keyed by profile key (e.g. simpleweb_customer.simpleweb_customer_id) ([] when
747
+ * empty)
748
+ */
749
+ profileValues?: Record<string, unknown> | [] | null;
750
+ [key: string]: unknown;
751
+ }
752
+ /**
753
+ * Verify the password for a user
754
+ * Response data for POST /users/verify-password — MINIMUM fields, extras pass through
755
+ *
756
+ * Returned by: api.joomla.users.verifyPassword.create(data)
757
+ */
758
+ export interface UsersVerifyPasswordCreateData {
759
+ /** Joomla user ID; 0 when the password did not match */
760
+ id: number;
761
+ /** True when the password matched */
762
+ isVerified: boolean;
763
+ /** Username sent */
764
+ username: string;
765
+ /** User JWT; null when the password did not match */
766
+ token: string | null;
767
+ /** Email address; empty when the password did not match */
768
+ email: string;
769
+ /** True when the user's profile has a Prophet 21 customer ID */
770
+ hasCustomerId: boolean;
771
+ /** True when the user's profile has a Prophet 21 contact ID */
772
+ hasContactId: boolean;
773
+ /** True when the user's profile has a default ship-to */
774
+ hasShipToId: boolean;
775
+ [key: string]: unknown;
776
+ }
777
+ /**
778
+ * Verify the password for a user
779
+ * Request body for POST /users/verify-password — MINIMUM fields, extras pass through
780
+ *
781
+ * Request body of: api.joomla.users.verifyPassword.create(data)
782
+ */
783
+ export interface UsersVerifyPasswordCreateBody {
784
+ /** Username */
785
+ username?: string;
786
+ /** Plain-text password */
787
+ password?: string;
788
+ /** Site to check against; honoured only when the caller's site is augur_info */
789
+ siteId?: string | null;
790
+ [key: string]: unknown;
791
+ }
792
+ /**
793
+ * Get User Detail
794
+ * Response data for GET /users/{id} — MINIMUM fields, extras pass through
795
+ *
796
+ * Returned by: api.joomla.users.get(id)
797
+ */
798
+ export interface UsersGetData {
799
+ /** Activation code; empty once activated */
800
+ activation: string;
801
+ /** Email address */
802
+ email: string;
803
+ /** Joomla user ID */
804
+ id: number;
805
+ /** Last password reset (Y-m-d H:i:s) */
806
+ lastResetTime: string;
807
+ /** Last visit (Y-m-d H:i:s) */
808
+ lastvisitDate: string;
809
+ /** Display name */
810
+ name: string;
811
+ /** Registration date (Y-m-d H:i:s) */
812
+ registerDate: string;
813
+ /** Username */
814
+ username: string;
815
+ [key: string]: unknown;
816
+ }
817
+ /**
818
+ * Update user
819
+ * Response data for PUT /users/{id} — MINIMUM fields, extras pass through
820
+ *
821
+ * Returned by: api.joomla.users.update(id, data)
822
+ */
823
+ export type UsersUpdateData = boolean;
824
+ /**
825
+ * Update user
826
+ * Request body for PUT /users/{id} — MINIMUM fields, extras pass through
827
+ *
828
+ * Request body of: api.joomla.users.update(id, data)
829
+ */
830
+ export interface UsersUpdateBody {
831
+ /** Display name */
832
+ name?: string | null;
833
+ /** Email address */
834
+ email?: string | null;
835
+ /** Username */
836
+ username?: string | null;
837
+ /** Plain-text password, stored as a bcrypt hash; blank leaves it unchanged */
838
+ password?: string | null;
839
+ /** 1 to block the user, 0 to unblock; any other value is ignored */
840
+ block?: number | null;
841
+ /** User group IDs to add (existing memberships are kept) */
842
+ groups?: number[] | null;
843
+ /** Profile values to set, keyed by profile key ([] when empty) */
844
+ profileValues?: Record<string, unknown> | [] | null;
845
+ [key: string]: unknown;
846
+ }
847
+ /**
848
+ * Block a user, or delete it permanently
849
+ * Response data for DELETE /users/{id} — MINIMUM fields, extras pass through
850
+ *
851
+ * Returned by: api.joomla.users.delete(id, params)
852
+ */
853
+ export type UsersDeleteData = boolean;
854
+ /**
855
+ * Get User Doc
856
+ * Response data for GET /users/{id}/doc — MINIMUM fields, extras pass through
857
+ *
858
+ * Returned by: api.joomla.users.doc.list(id, params)
859
+ */
860
+ export type UsersDocListData = UsersListItem;
861
+ /**
862
+ * List User Groups
863
+ * Response data for GET /users/{id}/groups — MINIMUM fields, extras pass through
864
+ *
865
+ * Returned by: api.joomla.users.groups.list(id, params) (array items)
866
+ * Returned by: api.joomla.users.groups.create(id, data)
867
+ * Returned by: api.joomla.users.groups.get(id, groupId)
868
+ */
869
+ export interface UsersGroupsListItem {
870
+ /** Joomla user ID */
871
+ userId: number;
872
+ /** Username */
873
+ username: string;
874
+ /** User group ID */
875
+ groupId: number;
876
+ /** User group title */
877
+ title: string;
878
+ [key: string]: unknown;
879
+ }
880
+ /** Returned by: api.joomla.users.groups.list(id, params) */
881
+ export type UsersGroupsListData = UsersGroupsListItem[];
882
+ /**
883
+ * Create/update User Group Mapping
884
+ * Response data for POST /users/{id}/groups — MINIMUM fields, extras pass through
885
+ *
886
+ * Returned by: api.joomla.users.groups.create(id, data)
887
+ */
888
+ export type UsersGroupsCreateData = UsersGroupsListItem;
889
+ /**
890
+ * Create/update User Group Mapping
891
+ * Request body for POST /users/{id}/groups — MINIMUM fields, extras pass through
892
+ *
893
+ * Request body of: api.joomla.users.groups.create(id, data)
894
+ */
895
+ export interface UsersGroupsCreateBody {
896
+ /** User group ID to add the user to */
897
+ groupId: number;
898
+ [key: string]: unknown;
899
+ }
900
+ /**
901
+ * get User Group
902
+ * Response data for GET /users/{id}/groups/{groupId} — MINIMUM fields, extras pass through
903
+ *
904
+ * Returned by: api.joomla.users.groups.get(id, groupId)
905
+ */
906
+ export type UsersGroupsGetData = UsersGroupsListItem;
907
+ /**
908
+ * Remove User Group
909
+ * Response data for DELETE /users/{id}/groups/{groupId} — MINIMUM fields, extras pass through
910
+ *
911
+ * Returned by: api.joomla.users.groups.delete(id, groupId)
912
+ */
913
+ export type UsersGroupsDeleteData = boolean;
914
+ /**
915
+ * Shape of `profile` (MINIMUM fields; reused wherever the same shape appears)
916
+ * Account fields and profile values
917
+ *
918
+ * Field `profile` of UsersTrinityListData
919
+ */
920
+ export interface UsersTrinityListDataProfile {
921
+ /** Joomla user ID */
922
+ id: number;
923
+ /** Display name */
924
+ name: string;
925
+ /** Username */
926
+ username: string;
927
+ /** Email address */
928
+ email: string;
929
+ /** Last visit (Y-m-d H:i:s) */
930
+ lastvisitDate: string;
931
+ /** Registration date (Y-m-d H:i:s) */
932
+ registerDate: string;
933
+ /** 1 when the user is blocked */
934
+ block: number;
935
+ /** Prophet 21 contact ID; null when blank */
936
+ contactId?: number | null;
937
+ /** Prophet 21 customer ID; null when blank */
938
+ customerId?: number | null;
939
+ /** Default contract number, as stored */
940
+ contractNo?: string | null;
941
+ /** Default ship-to ID; null when blank */
942
+ shipTo?: string | null;
943
+ /** Phone; null when blank */
944
+ phone?: string | null;
945
+ /** Job title; null when blank */
946
+ title?: string | null;
947
+ /** Company name; null when blank */
948
+ companyName?: string | null;
949
+ /** 1 when the customer ID is approved; null when blank */
950
+ approved?: number | null;
951
+ [key: string]: unknown;
952
+ }
953
+ /**
954
+ * Shape of `address` (MINIMUM fields; reused wherever the same shape appears)
955
+ * The contact's address
956
+ *
957
+ * Field `address` of UsersTrinityListDataP21Role
958
+ */
959
+ export interface UsersTrinityListDataP21RoleAddress {
960
+ /** Prophet 21 address ID */
961
+ id: number;
962
+ /** Physical address line 1 (max 50 chars) */
963
+ physAddress1: string | null;
964
+ /** Physical address line 2 (max 50 chars) */
965
+ physAddress2: string | null;
966
+ /** Physical city (max 50 chars) */
967
+ physCity: string | null;
968
+ /** Physical state or province (max 50 chars) */
969
+ physState: string | null;
970
+ /** Physical postal code (max 10 chars) */
971
+ physPostalCode: string | null;
972
+ /** Physical country (max 50 chars) */
973
+ physCountry: string | null;
974
+ /** Mailing address line 1 (max 50 chars) */
975
+ mailAddress1: string | null;
976
+ /** Mailing address line 2 (max 50 chars) */
977
+ mailAddress2: string | null;
978
+ /** Mailing city (max 50 chars) */
979
+ mailCity: string | null;
980
+ /** Mailing state or province (max 50 chars) */
981
+ mailState: string | null;
982
+ /** Mailing postal code (max 10 chars) */
983
+ mailPostalCode: string | null;
984
+ /** Mailing country (max 50 chars) */
985
+ mailCountry: string | null;
986
+ [key: string]: unknown;
987
+ }
988
+ /**
989
+ * Shape of `p21Role` (MINIMUM fields; reused wherever the same shape appears)
990
+ * Prophet 21 contact role; the key is absent when the user has no contact ID
991
+ *
992
+ * Field `p21Role` of UsersTrinityListData
993
+ */
994
+ export interface UsersTrinityListDataP21Role {
995
+ /** Contact role ID from the Prophet 21 contact */
996
+ contactRoleUid: number | null;
997
+ /** Same value as contactRoleUid */
998
+ contactRoleId: number | null;
999
+ /** Contact role name */
1000
+ contactRoleName: string | null;
1001
+ /** Parent role name */
1002
+ parentName: string | null;
1003
+ /** Parent Joomla group ID */
1004
+ parentGroupId: number | null;
1005
+ /** Joomla group ID for the role */
1006
+ groupId: number | null;
1007
+ /** Contact role record ID */
1008
+ id: number;
1009
+ /** The contact's address */
1010
+ address: UsersTrinityListDataP21RoleAddress;
1011
+ [key: string]: unknown;
1012
+ }
1013
+ /**
1014
+ * Get Trinity User Doc
1015
+ * Response data for GET /users/{id}/trinity — MINIMUM fields, extras pass through
1016
+ *
1017
+ * Returned by: api.joomla.users.trinity.list(id)
1018
+ */
1019
+ export interface UsersTrinityListData {
1020
+ /** Account fields and profile values */
1021
+ profile: UsersTrinityListDataProfile;
1022
+ /** User groups the user belongs to */
1023
+ groups: UsersListItemGroupsItem[];
1024
+ /** trinitysurfaces, trinitytile, or empty when neither matches */
1025
+ territory: string;
1026
+ /** A&D, contractor, or empty */
1027
+ role: string;
1028
+ /** Prophet 21 contact role; the key is absent when the user has no contact ID */
1029
+ p21Role?: UsersTrinityListDataP21Role | null;
1030
+ [key: string]: unknown;
1031
+ }
1032
+ export interface JoomlaClientSpec {
1033
+ actionLogs: {
1034
+ /**
1035
+ * List Action Logs
1036
+ * Call: api.joomla.actionLogs.list(params)
1037
+ *
1038
+ * Errors:
1039
+ * 400: orderBy is not column|ASC or column|DESC on an action_logs column.
1040
+ *
1041
+ * GET https://joomla.augur-api.com/action-logs
1042
+ * Contract: https://joomla.augur-api.com/openapi.json#/paths/~1action-logs/get
1043
+ *
1044
+ * @param params ActionLogsListParams (query string)
1045
+ * @returns BaseResponse whose `data` is ActionLogsListData
1046
+ */
1047
+ list: (params?: ActionLogsListParams) => Promise<BaseResponse<ActionLogsListData>>;
1048
+ /**
1049
+ * Get Action Log Doc
1050
+ * Call: api.joomla.actionLogs.get(id)
1051
+ *
1052
+ * Errors:
1053
+ * 404: No action log with this ID.
1054
+ *
1055
+ * GET https://joomla.augur-api.com/action-logs/{id}
1056
+ * Contract: https://joomla.augur-api.com/openapi.json#/paths/~1action-logs~1{id}/get
1057
+ *
1058
+ * @param id action_logs.id
1059
+ * @param params ActionLogsGetParams (query string)
1060
+ * @returns BaseResponse whose `data` is ActionLogsGetData
1061
+ */
1062
+ get: (id: number, params?: ActionLogsGetParams) => Promise<BaseResponse<ActionLogsGetData>>;
1063
+ };
1064
+ categories: {
1065
+ /**
1066
+ * List Categories
1067
+ * Call: api.joomla.categories.list(params)
1068
+ *
1069
+ * Errors:
1070
+ * 400: orderBy is not column|ASC or column|DESC on a categories column.
1071
+ *
1072
+ * GET https://joomla.augur-api.com/categories
1073
+ * Contract: https://joomla.augur-api.com/openapi.json#/paths/~1categories/get
1074
+ *
1075
+ * @param params CategoriesListParams (query string)
1076
+ * @returns BaseResponse whose `data` is CategoriesListData
1077
+ */
1078
+ list: (params?: CategoriesListParams) => Promise<BaseResponse<CategoriesListData>>;
1079
+ /**
1080
+ * Get Category by ID
1081
+ * Call: api.joomla.categories.get(id)
1082
+ *
1083
+ * Errors:
1084
+ * 404: No category with this ID.
1085
+ *
1086
+ * GET https://joomla.augur-api.com/categories/{id}
1087
+ * Contract: https://joomla.augur-api.com/openapi.json#/paths/~1categories~1{id}/get
1088
+ *
1089
+ * @param id categories.id
1090
+ * @param params CategoriesGetParams (query string)
1091
+ * @returns BaseResponse whose `data` is CategoriesGetData
1092
+ */
1093
+ get: (id: number, params?: CategoriesGetParams) => Promise<BaseResponse<CategoriesGetData>>;
1094
+ };
1095
+ content: {
1096
+ /**
1097
+ * Get Content list
1098
+ * Call: api.joomla.content.list(params)
1099
+ *
1100
+ * Get Content List
1101
+ *
1102
+ * Response data, each item: A Joomla article with its images and custom fields
1103
+ * (ContentHelper::generateDocument)
1104
+ *
1105
+ * Errors:
1106
+ * 400: orderBy is not column|ASC or column|DESC on a content column.
1107
+ *
1108
+ * GET https://joomla.augur-api.com/content
1109
+ * Contract: https://joomla.augur-api.com/openapi.json#/paths/~1content/get
1110
+ *
1111
+ * @param params ContentListParams (query string)
1112
+ * @returns BaseResponse whose `data` is ContentListData
1113
+ */
1114
+ list: (params?: ContentListParams) => Promise<BaseResponse<ContentListData>>;
1115
+ /**
1116
+ * Get Content Detail
1117
+ * Call: api.joomla.content.get(id, params)
1118
+ *
1119
+ * Response data: A Joomla article's core fields, without images or custom fields
1120
+ *
1121
+ * Errors:
1122
+ * 400: id is 0 and alias or catid is missing.
1123
+ * 404: No article with this ID (or, for ID 0, with this alias and catid).
1124
+ *
1125
+ * GET https://joomla.augur-api.com/content/{id}
1126
+ * Contract: https://joomla.augur-api.com/openapi.json#/paths/~1content~1{id}/get
1127
+ *
1128
+ * @param id content.id
1129
+ * @param params ContentGetParams (query string)
1130
+ * @returns BaseResponse whose `data` is ContentGetData
1131
+ */
1132
+ get: (id: number, params?: ContentGetParams) => Promise<BaseResponse<ContentGetData>>;
1133
+ doc: {
1134
+ /**
1135
+ * Get Content Doc
1136
+ * Call: api.joomla.content.doc.list(id, params)
1137
+ *
1138
+ * Response data: A Joomla article with its images and custom fields
1139
+ * (ContentHelper::generateDocument)
1140
+ *
1141
+ * Errors:
1142
+ * 400: id is 0 and alias or catid is missing.
1143
+ * 404: No article with this ID (or, for ID 0, with this alias and catid).
1144
+ *
1145
+ * GET https://joomla.augur-api.com/content/{id}/doc
1146
+ * Contract: https://joomla.augur-api.com/openapi.json#/paths/~1content~1{id}~1doc/get
1147
+ *
1148
+ * @param id content.id
1149
+ * @param params ContentDocListParams (query string)
1150
+ * @returns BaseResponse whose `data` is ContentDocListData
1151
+ */
1152
+ list: (id: number, params?: ContentDocListParams) => Promise<BaseResponse<ContentDocListData>>;
1153
+ /** Alias for `list`: GET /content/{id}/doc. Call: api.joomla.content.doc.get(id, params) */
1154
+ get: (id: number, params?: ContentDocListParams) => Promise<BaseResponse<ContentDocListData>>;
1155
+ };
1156
+ };
1157
+ menu: {
1158
+ /**
1159
+ * List Menu Items
1160
+ * Call: api.joomla.menu.list(params)
1161
+ *
1162
+ * Errors:
1163
+ * 400: orderBy is not column|ASC or column|DESC on a menu column.
1164
+ *
1165
+ * GET https://joomla.augur-api.com/menu
1166
+ * Contract: https://joomla.augur-api.com/openapi.json#/paths/~1menu/get
1167
+ *
1168
+ * @param params MenuListParams (query string)
1169
+ * @returns BaseResponse whose `data` is MenuListData
1170
+ */
1171
+ list: (params?: MenuListParams) => Promise<BaseResponse<MenuListData>>;
1172
+ doc: {
1173
+ /**
1174
+ * Get Menu Doc
1175
+ * Call: api.joomla.menu.doc.list(id, params)
1176
+ *
1177
+ * Response data: A Joomla menu item with its child items, recursively
1178
+ * (MenuHelper::generateDocument)
1179
+ *
1180
+ * Errors:
1181
+ * 400: id is 0 and alias is missing.
1182
+ * 404: No menu item with this ID (or, for ID 0, with this alias).
1183
+ *
1184
+ * GET https://joomla.augur-api.com/menu/{id}/doc
1185
+ * Contract: https://joomla.augur-api.com/openapi.json#/paths/~1menu~1{id}~1doc/get
1186
+ *
1187
+ * @param id menu.id
1188
+ * @param params MenuDocListParams (query string)
1189
+ * @returns BaseResponse whose `data` is MenuDocListData
1190
+ */
1191
+ list: (id: number, params?: MenuDocListParams) => Promise<BaseResponse<MenuDocListData>>;
1192
+ /** Alias for `list`: GET /menu/{id}/doc. Call: api.joomla.menu.doc.get(id, params) */
1193
+ get: (id: number, params?: MenuDocListParams) => Promise<BaseResponse<MenuDocListData>>;
1194
+ };
1195
+ };
1196
+ modules: {
1197
+ /**
1198
+ * List Modules
1199
+ * Call: api.joomla.modules.list(params)
1200
+ *
1201
+ * List Joomla site modules (#__modules rows)
1202
+ *
1203
+ * Errors:
1204
+ * 400: orderBy is not column|ASC or column|DESC on a modules column. Or menuId is not 0 or a
1205
+ * menu item ID.
1206
+ *
1207
+ * GET https://joomla.augur-api.com/modules
1208
+ * Contract: https://joomla.augur-api.com/openapi.json#/paths/~1modules/get
1209
+ *
1210
+ * @param params ModulesListParams (query string)
1211
+ * @returns BaseResponse whose `data` is ModulesListData
1212
+ */
1213
+ list: (params?: ModulesListParams) => Promise<BaseResponse<ModulesListData>>;
1214
+ /**
1215
+ * Get Module
1216
+ * Call: api.joomla.modules.get(id, params)
1217
+ *
1218
+ * Get one Joomla site module (#__modules row)
1219
+ *
1220
+ * Errors:
1221
+ * 404: No site module with this ID.
1222
+ *
1223
+ * GET https://joomla.augur-api.com/modules/{id}
1224
+ * Contract: https://joomla.augur-api.com/openapi.json#/paths/~1modules~1{id}/get
1225
+ *
1226
+ * @param id modules.id
1227
+ * @param params ModulesGetParams (query string)
1228
+ * @returns BaseResponse whose `data` is ModulesGetData
1229
+ */
1230
+ get: (id: number, params?: ModulesGetParams) => Promise<BaseResponse<ModulesGetData>>;
1231
+ };
1232
+ tags: {
1233
+ /**
1234
+ * Get tag list
1235
+ * Call: api.joomla.tags.list(params)
1236
+ *
1237
+ * Get Tag List
1238
+ *
1239
+ * Response data, each item: A tag with the number of matching published articles that carry it
1240
+ * (TagsHelper::listAll)
1241
+ *
1242
+ * Errors:
1243
+ * 400: orderBy is not column|ASC or column|DESC on a tags column.
1244
+ *
1245
+ * GET https://joomla.augur-api.com/tags
1246
+ * Contract: https://joomla.augur-api.com/openapi.json#/paths/~1tags/get
1247
+ *
1248
+ * @param params TagsListParams (query string)
1249
+ * @returns BaseResponse whose `data` is TagsListData
1250
+ */
1251
+ list: (params?: TagsListParams) => Promise<BaseResponse<TagsListData>>;
1252
+ };
1253
+ usergroups: {
1254
+ /**
1255
+ * Get User Groups
1256
+ * Call: api.joomla.usergroups.list(params)
1257
+ *
1258
+ * Errors:
1259
+ * 400: orderBy is not column|ASC or column|DESC on a usergroups column.
1260
+ *
1261
+ * GET https://joomla.augur-api.com/usergroups
1262
+ * Contract: https://joomla.augur-api.com/openapi.json#/paths/~1usergroups/get
1263
+ *
1264
+ * @param params UsergroupsListParams (query string)
1265
+ * @returns BaseResponse whose `data` is UsergroupsListData
1266
+ */
1267
+ list: (params?: UsergroupsListParams) => Promise<BaseResponse<UsergroupsListData>>;
1268
+ };
1269
+ users: {
1270
+ /**
1271
+ * Get User List
1272
+ * Call: api.joomla.users.list(params)
1273
+ *
1274
+ * Response data, each item: A Joomla user with profile values and groups
1275
+ * (UsersHelper::generateDocument)
1276
+ *
1277
+ * Errors:
1278
+ * 400: orderBy is not column|ASC or column|DESC on a users column.
1279
+ *
1280
+ * GET https://joomla.augur-api.com/users
1281
+ * Contract: https://joomla.augur-api.com/openapi.json#/paths/~1users/get
1282
+ *
1283
+ * @param params UsersListParams (query string)
1284
+ * @returns BaseResponse whose `data` is UsersListData
1285
+ */
1286
+ list: (params?: UsersListParams) => Promise<BaseResponse<UsersListData>>;
1287
+ /**
1288
+ * Create a user
1289
+ * Call: api.joomla.users.create(data)
1290
+ *
1291
+ * Request body: Create a Joomla user, or return the existing user with this username unchanged
1292
+ * Response data: The user a create call resolved to: the new user, or the existing one with
1293
+ * that username
1294
+ *
1295
+ * Auth: bearer token; spec scopes: none listed (most endpoints list `public`)
1296
+ *
1297
+ * Errors:
1298
+ * 400: The body is missing or not a JSON object. Or username is missing, or email is missing
1299
+ * for a new user.
1300
+ *
1301
+ * POST https://joomla.augur-api.com/users
1302
+ * Contract: https://joomla.augur-api.com/openapi.json#/paths/~1users/post
1303
+ *
1304
+ * @param data UsersCreateBody (request body)
1305
+ * @returns BaseResponse whose `data` is UsersCreateData
1306
+ */
1307
+ create: (data: UsersCreateBody) => Promise<BaseResponse<UsersCreateData>>;
1308
+ /**
1309
+ * Get User Detail
1310
+ * Call: api.joomla.users.get(id)
1311
+ *
1312
+ * Response data: A Joomla user's account fields, without profile or groups
1313
+ *
1314
+ * Errors:
1315
+ * 404: No user with this ID.
1316
+ *
1317
+ * GET https://joomla.augur-api.com/users/{id}
1318
+ * Contract: https://joomla.augur-api.com/openapi.json#/paths/~1users~1{id}/get
1319
+ *
1320
+ * @param id users.id
1321
+ * @param params UsersGetParams (query string)
1322
+ * @returns BaseResponse whose `data` is UsersGetData
1323
+ */
1324
+ get: (id: number, params?: UsersGetParams) => Promise<BaseResponse<UsersGetData>>;
1325
+ /**
1326
+ * Update user
1327
+ * Call: api.joomla.users.update(id, data)
1328
+ *
1329
+ * Request body: Partial update of a Joomla user; an absent field keeps its current value
1330
+ *
1331
+ * Errors:
1332
+ * 400: The body is missing or not a JSON object.
1333
+ * 404: No user with this ID.
1334
+ *
1335
+ * PUT https://joomla.augur-api.com/users/{id}
1336
+ * Contract: https://joomla.augur-api.com/openapi.json#/paths/~1users~1{id}/put
1337
+ *
1338
+ * @param id users.id
1339
+ * @param data UsersUpdateBody (request body)
1340
+ * @returns BaseResponse whose `data` is UsersUpdateData
1341
+ */
1342
+ update: (id: number, data: UsersUpdateBody) => Promise<BaseResponse<UsersUpdateData>>;
1343
+ /**
1344
+ * Block a user, or delete it permanently
1345
+ * Call: api.joomla.users.delete(id, params)
1346
+ *
1347
+ * Blocks the user. With hardDelete=Y, deletes the user permanently instead, so the username and
1348
+ * email can be used for a new account. A permanent delete cannot be undone
1349
+ *
1350
+ * Errors:
1351
+ * 403: With hardDelete=Y: this user cannot be deleted permanently. Nothing was changed.
1352
+ * 404: No user with this ID.
1353
+ *
1354
+ * DELETE https://joomla.augur-api.com/users/{id}
1355
+ * Contract: https://joomla.augur-api.com/openapi.json#/paths/~1users~1{id}/delete
1356
+ *
1357
+ * @param id users.id
1358
+ * @param params UsersDeleteParams (query string)
1359
+ * @returns BaseResponse whose `data` is UsersDeleteData
1360
+ */
1361
+ delete: (id: number, params?: UsersDeleteParams) => Promise<BaseResponse<UsersDeleteData>>;
1362
+ doc: {
1363
+ /**
1364
+ * Get User Doc
1365
+ * Call: api.joomla.users.doc.list(id, params)
1366
+ *
1367
+ * Response data: A Joomla user with profile values and groups (UsersHelper::generateDocument)
1368
+ *
1369
+ * Errors:
1370
+ * 404: No user with this ID.
1371
+ *
1372
+ * GET https://joomla.augur-api.com/users/{id}/doc
1373
+ * Contract: https://joomla.augur-api.com/openapi.json#/paths/~1users~1{id}~1doc/get
1374
+ *
1375
+ * @param id users.id
1376
+ * @param params UsersDocListParams (query string)
1377
+ * @returns BaseResponse whose `data` is UsersDocListData
1378
+ */
1379
+ list: (id: number, params?: UsersDocListParams) => Promise<BaseResponse<UsersDocListData>>;
1380
+ /** Alias for `list`: GET /users/{id}/doc. Call: api.joomla.users.doc.get(id, params) */
1381
+ get: (id: number, params?: UsersDocListParams) => Promise<BaseResponse<UsersDocListData>>;
1382
+ };
1383
+ groups: {
1384
+ /**
1385
+ * List User Groups
1386
+ * Call: api.joomla.users.groups.list(id, params)
1387
+ *
1388
+ * Response data, each item: A user's membership in one group, with the user and group names
1389
+ * (UserGroupMapHelper::generateDocument)
1390
+ *
1391
+ * Errors:
1392
+ * 400: orderBy is not column|ASC or column|DESC on a user_group_map column.
1393
+ * 404: No user with this ID.
1394
+ *
1395
+ * GET https://joomla.augur-api.com/users/{id}/groups
1396
+ * Contract: https://joomla.augur-api.com/openapi.json#/paths/~1users~1{id}~1groups/get
1397
+ *
1398
+ * @param id users.id
1399
+ * @param params UsersGroupsListParams (query string)
1400
+ * @returns BaseResponse whose `data` is UsersGroupsListData
1401
+ */
1402
+ list: (id: number, params?: UsersGroupsListParams) => Promise<BaseResponse<UsersGroupsListData>>;
1403
+ /**
1404
+ * Create/update User Group Mapping
1405
+ * Call: api.joomla.users.groups.create(id, data)
1406
+ *
1407
+ * Request body: Add the user in the path to a user group
1408
+ * Response data: A user's membership in one group, with the user and group names
1409
+ * (UserGroupMapHelper::generateDocument)
1410
+ *
1411
+ * Errors:
1412
+ * 400: The body is missing or not a JSON object. Or groupId is missing.
1413
+ * 404: No user or group with these IDs.
1414
+ *
1415
+ * POST https://joomla.augur-api.com/users/{id}/groups
1416
+ * Contract: https://joomla.augur-api.com/openapi.json#/paths/~1users~1{id}~1groups/post
1417
+ *
1418
+ * @param id users.id
1419
+ * @param data UsersGroupsCreateBody (request body)
1420
+ * @returns BaseResponse whose `data` is UsersGroupsCreateData
1421
+ */
1422
+ create: (id: number, data: UsersGroupsCreateBody) => Promise<BaseResponse<UsersGroupsCreateData>>;
1423
+ /**
1424
+ * get User Group
1425
+ * Call: api.joomla.users.groups.get(id, groupId)
1426
+ *
1427
+ * Response data: A user's membership in one group, with the user and group names
1428
+ * (UserGroupMapHelper::generateDocument)
1429
+ *
1430
+ * Errors:
1431
+ * 404: The user is not in this group.
1432
+ *
1433
+ * GET https://joomla.augur-api.com/users/{id}/groups/{groupId}
1434
+ * Contract:
1435
+ * https://joomla.augur-api.com/openapi.json#/paths/~1users~1{id}~1groups~1{groupId}/get
1436
+ *
1437
+ * @param id users.id
1438
+ * @param groupId usergroups.id
1439
+ * @param params UsersGroupsGetParams (query string)
1440
+ * @returns BaseResponse whose `data` is UsersGroupsGetData
1441
+ */
1442
+ get: (id: number, groupId: number, params?: UsersGroupsGetParams) => Promise<BaseResponse<UsersGroupsGetData>>;
1443
+ /**
1444
+ * Remove User Group
1445
+ * Call: api.joomla.users.groups.delete(id, groupId)
1446
+ *
1447
+ * Remove a user from a group (hard delete of the user_usergroup_map row)
1448
+ *
1449
+ * Errors:
1450
+ * 404: The user is not in this group.
1451
+ *
1452
+ * DELETE https://joomla.augur-api.com/users/{id}/groups/{groupId}
1453
+ * Contract:
1454
+ * https://joomla.augur-api.com/openapi.json#/paths/~1users~1{id}~1groups~1{groupId}/delete
1455
+ *
1456
+ * @param id users.id
1457
+ * @param groupId usergroups.id
1458
+ * @returns BaseResponse whose `data` is UsersGroupsDeleteData
1459
+ */
1460
+ delete: (id: number, groupId: number) => Promise<BaseResponse<UsersGroupsDeleteData>>;
1461
+ };
1462
+ trinity: {
1463
+ /**
1464
+ * Get Trinity User Doc
1465
+ * Call: api.joomla.users.trinity.list(id)
1466
+ *
1467
+ * Response data: A Trinity user's profile, Prophet 21 role, groups, territory and role
1468
+ *
1469
+ * Errors:
1470
+ * 404: No user with this ID.
1471
+ *
1472
+ * GET https://joomla.augur-api.com/users/{id}/trinity
1473
+ * Contract: https://joomla.augur-api.com/openapi.json#/paths/~1users~1{id}~1trinity/get
1474
+ *
1475
+ * @param id users.id
1476
+ * @param params UsersTrinityListParams (query string)
1477
+ * @returns BaseResponse whose `data` is UsersTrinityListData
1478
+ */
1479
+ list: (id: number, params?: UsersTrinityListParams) => Promise<BaseResponse<UsersTrinityListData>>;
1480
+ };
1481
+ verifyPassword: {
1482
+ /**
1483
+ * Verify the password for a user
1484
+ * Call: api.joomla.users.verifyPassword.create(data)
1485
+ *
1486
+ * Request body: Check a username and password, and issue a user JWT when they match
1487
+ * Response data: The outcome of a username/password check, with a user JWT when it matched
1488
+ *
1489
+ * Errors:
1490
+ * 400: The body is missing or not a JSON object.
1491
+ *
1492
+ * POST https://joomla.augur-api.com/users/verify-password
1493
+ * Contract: https://joomla.augur-api.com/openapi.json#/paths/~1users~1verify-password/post
1494
+ *
1495
+ * @param data UsersVerifyPasswordCreateBody (request body)
1496
+ * @returns BaseResponse whose `data` is UsersVerifyPasswordCreateData
1497
+ */
1498
+ create: (data: UsersVerifyPasswordCreateBody) => Promise<BaseResponse<UsersVerifyPasswordCreateData>>;
1499
+ };
1500
+ };
1501
+ }
1502
+ //# sourceMappingURL=types.d.ts.map