@simpleapps-com/augur-api 2026.10.31 → 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 +19875 -18513
  46. package/dist/index.js.map +1 -1
  47. package/dist/index.mjs +19874 -18513
  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-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,1732 @@
1
+ /**
2
+ * Generated types for the agr-site service.
3
+ * Central site configuration hub managing settings, notifications, and cross-service integrations
4
+ * per client
5
+ *
6
+ * Public specs (the source of truth for every shape below):
7
+ * https://agr-site.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-site.augur-api.com/openapi.json: the full contract: request and response bodies
11
+ * field by field, descriptions, formats and documented errors.
12
+ * https://agr-site.augur-api.com/llms.txt: the plain-text endpoint list and the other Augur
13
+ * services.
14
+ *
15
+ * Source: shared/specs/agr-site.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 /configs */
22
+ export interface ConfigsListParams extends EdgeCacheParams {
23
+ /** Limit number of results (Default: 10) */
24
+ limit?: number;
25
+ /** Starting offset results (Default: 0) */
26
+ offset?: number;
27
+ }
28
+ /** Params for GET /configs/{serviceName} */
29
+ export type ConfigsGetParams = EdgeCacheParams;
30
+ /** Params for GET /context/{siteId} */
31
+ export type ContextGetParams = EdgeCacheParams;
32
+ /** Params for GET /datafiles */
33
+ export interface DatafilesListParams extends EdgeCacheParams {
34
+ /** Entries per page (default 10, max 1000) */
35
+ limit?: number;
36
+ /** public (www) or private (datafiles) */
37
+ location: string;
38
+ /** Entries to skip (default 0) */
39
+ offset?: number;
40
+ /** Folder path relative to the location root, e.g. media/catalogs/ */
41
+ path: string;
42
+ /** true to include each file's sha256 */
43
+ withSha256?: string;
44
+ }
45
+ /** Params for DELETE /datafiles */
46
+ export interface DatafilesDeleteParams {
47
+ /** public (www) or private (datafiles) */
48
+ location: string;
49
+ /** File path relative to the location root */
50
+ path: string;
51
+ }
52
+ /** Params for GET /fyxer-transcript */
53
+ export interface FyxerTranscriptListParams extends EdgeCacheParams {
54
+ /** Limit number of results (Default: 10) */
55
+ limit?: number;
56
+ /** Starting offset results (Default: 0) */
57
+ offset?: number;
58
+ /** Order By (Default: fyxer_transcript_hdr_uid|ASC) */
59
+ orderBy?: string;
60
+ /** Search Query */
61
+ q?: string;
62
+ /**
63
+ * Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
64
+ * (704,705); -1 for every status. Default: 704
65
+ */
66
+ statusCd?: number | number[];
67
+ /** Max characters of each transcript returned; -1 returns the full transcript (Default: 255) */
68
+ transcriptLength?: number;
69
+ }
70
+ /** Params for GET /fyxer-transcript/{fyxerTranscriptHdrUid} */
71
+ export type FyxerTranscriptGetParams = EdgeCacheParams;
72
+ /** Params for GET /geo-codes-postal-codes */
73
+ export interface GeoCodesPostalCodesListParams extends EdgeCacheParams {
74
+ /** Limit number of results (Default: 10) */
75
+ limit?: number;
76
+ /** Starting offset results (Default: 0) */
77
+ offset?: number;
78
+ /** Order By (Default: geo_codes_postal_codes_uid|ASC) */
79
+ orderBy?: string;
80
+ /**
81
+ * Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
82
+ * (704,705); -1 for every status. Default: every status
83
+ */
84
+ statusCd?: number | number[];
85
+ }
86
+ /** Params for GET /geo-codes-postal-codes/{geoCodesPostalCodesUid} */
87
+ export type GeoCodesPostalCodesGetParams = EdgeCacheParams;
88
+ /** Params for GET /linked-sites */
89
+ export type LinkedSitesListParams = EdgeCacheParams;
90
+ /** Params for GET /meta-files/robots */
91
+ export type MetaFilesRobotsListParams = EdgeCacheParams;
92
+ /** Params for GET /notifications */
93
+ export interface NotificationsListParams extends EdgeCacheParams {
94
+ /** Datatype the notification is about (checkout, import, ...) */
95
+ dataTypeName?: string;
96
+ /** ID of the record the notification is about (checkout uid, import uid, ...) */
97
+ dataTypeUid?: number;
98
+ /** Limit number of results (Default: 10) */
99
+ limit?: number;
100
+ /** Starting offset results (Default: 0) */
101
+ offset?: number;
102
+ /** Order By, one field|ASC or field|DESC (Default: notifications_uid|ASC) */
103
+ orderBy?: string;
104
+ /** Send state: 704 = queued, 2556 = sending, 1185 = sent, 700 = removed */
105
+ processCd?: number;
106
+ /** Service the notification is about (commerce, p21_sism, ...) */
107
+ serviceName?: string;
108
+ /**
109
+ * Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
110
+ * (704,705); -1 for every status. Default: 704
111
+ */
112
+ statusCd?: number | number[];
113
+ /** Notification type (created, imported_joomla, ...) */
114
+ type?: string;
115
+ }
116
+ /** Params for GET /notifications/{notificationsUid} */
117
+ export type NotificationsGetParams = EdgeCacheParams;
118
+ /** Params for GET /open-search/embedding */
119
+ export interface OpenSearchEmbeddingListParams extends EdgeCacheParams {
120
+ /** search query */
121
+ q: string;
122
+ }
123
+ /** Params for GET /postal-codes-x-shiptos */
124
+ export interface PostalCodesXShiptosListParams extends EdgeCacheParams {
125
+ /** Limit number of results (Default: 10) */
126
+ limit?: number;
127
+ /** Starting offset results (Default: 0) */
128
+ offset?: number;
129
+ /** Order By (Default: postal_codes_x_shiptos_uid|ASC) */
130
+ orderBy?: string;
131
+ /** Search by postal code */
132
+ q?: string;
133
+ /**
134
+ * Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
135
+ * (704,705); -1 for every status. Default: 704
136
+ */
137
+ statusCd?: number | number[];
138
+ }
139
+ /** Params for GET /postal-codes-x-shiptos/{postalCodesXShiptosUid} */
140
+ export type PostalCodesXShiptosGetParams = EdgeCacheParams;
141
+ /** Params for GET /settings */
142
+ export interface SettingsListParams extends EdgeCacheParams {
143
+ /** Limit number of results (Default: 10) */
144
+ limit?: number;
145
+ /** Starting offset results (Default: 0) */
146
+ offset?: number;
147
+ /** Order By (Default: settings_uid|ASC) */
148
+ orderBy?: string;
149
+ /** Only settings for this service */
150
+ serviceName: 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: every status
154
+ */
155
+ statusCd?: number | number[];
156
+ }
157
+ /** Params for GET /settings/{settingsUid} */
158
+ export type SettingsGetParams = EdgeCacheParams;
159
+ /** Params for GET /users/{userId}/addresses */
160
+ export interface UsersAddressesListParams extends EdgeCacheParams {
161
+ /** Filter by email_address */
162
+ emailAddress?: string;
163
+ /** Limit number of results (Default: 10) */
164
+ limit?: number;
165
+ /** Starting offset results (Default: 0) */
166
+ offset?: number;
167
+ /** Order By (Default: user_address_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/{userId}/addresses/{userAddressUid} */
176
+ export type UsersAddressesGetParams = EdgeCacheParams;
177
+ /**
178
+ * List service configs
179
+ * Response data for GET /configs — MINIMUM fields, extras pass through
180
+ *
181
+ * Returned by: api.agrSite.configs.list(params) (array items)
182
+ */
183
+ export interface ConfigsListItem {
184
+ /** Service name, taken from the config file name (snake_case, e.g. p21_sism) */
185
+ serviceName: string;
186
+ /** True when the file sets a prefix, which marks the service active for the site */
187
+ isActive: boolean;
188
+ [key: string]: unknown;
189
+ }
190
+ /** Returned by: api.agrSite.configs.list(params) */
191
+ export type ConfigsListData = ConfigsListItem[];
192
+ /**
193
+ * Shape of `configs` (MINIMUM fields; reused wherever the same shape appears)
194
+ * Every app.config key of the service, in definition order
195
+ *
196
+ * Field `configs` of ConfigsGetData
197
+ */
198
+ export interface ConfigsGetDataConfigsItem {
199
+ /** Key name from the service definition's app.config (snake_case) */
200
+ configName: string;
201
+ /**
202
+ * Value in the site's config file, or the default when the key is not set; null when neither
203
+ * exists
204
+ */
205
+ value: string | number | boolean | null;
206
+ /** Default from the service definition; null when the definition has none */
207
+ default: string | number | boolean | null;
208
+ /** Declared type: string, int, or float */
209
+ type: string;
210
+ /** Values the key accepts; empty when any value of the type is accepted */
211
+ allowedValues: string[];
212
+ /** True when the key is present in the site's config file */
213
+ isSet: boolean;
214
+ [key: string]: unknown;
215
+ }
216
+ /**
217
+ * Get a service config
218
+ * Response data for GET /configs/{serviceName} — MINIMUM fields, extras pass through
219
+ *
220
+ * Returned by: api.agrSite.configs.get(serviceName)
221
+ * Returned by: api.agrSite.configs.update(serviceName, data)
222
+ */
223
+ export interface ConfigsGetData {
224
+ /** Service the config belongs to (snake_case, e.g. p21_sism) */
225
+ serviceName: string;
226
+ /** True when the site has a config file for the service */
227
+ fileExists: boolean;
228
+ /** Every app.config key of the service, in definition order */
229
+ configs: ConfigsGetDataConfigsItem[];
230
+ [key: string]: unknown;
231
+ }
232
+ /**
233
+ * Update a service config
234
+ * Response data for PUT /configs/{serviceName} — MINIMUM fields, extras pass through
235
+ *
236
+ * Returned by: api.agrSite.configs.update(serviceName, data)
237
+ */
238
+ export type ConfigsUpdateData = ConfigsGetData;
239
+ /**
240
+ * Update a service config
241
+ * Request body for PUT /configs/{serviceName} — MINIMUM fields, extras pass through
242
+ *
243
+ * Request body of: api.agrSite.configs.update(serviceName, data)
244
+ */
245
+ export interface ConfigsUpdateBody {
246
+ /**
247
+ * Config keys to set, keyed by the snake_case name from the service definition's app.config; a
248
+ * JSON number is accepted and read as its string form, then cast to the key's declared type and
249
+ * checked against its allowed values
250
+ */
251
+ values: Record<string, string>;
252
+ [key: string]: unknown;
253
+ }
254
+ /**
255
+ * Shape of `services` (MINIMUM fields; reused wherever the same shape appears)
256
+ * Services the site is configured for, each with its config
257
+ *
258
+ * Field `services` of ContextGetDataOption1
259
+ */
260
+ export interface ContextGetDataOption1ServicesItem {
261
+ /** Service name (the config file name) */
262
+ name: string;
263
+ /** Table prefix for the site in this service; absent when the config sets none */
264
+ prefix?: string | null;
265
+ [key: string]: unknown;
266
+ }
267
+ /**
268
+ * Shape of data nested in ContextGetData (MINIMUM fields; reused wherever the same shape appears)
269
+ *
270
+ * Nested in ContextGetData
271
+ */
272
+ export interface ContextGetDataOption1 {
273
+ /** Site described */
274
+ siteId: string;
275
+ /** Site domain; null when the site is not provisioned */
276
+ domain: string | null;
277
+ /** Site row in sites_table (dev port = 3000 + uid); 0 when the site is unknown */
278
+ uid: number;
279
+ /** Services the site is configured for, each with its config */
280
+ services: ContextGetDataOption1ServicesItem[];
281
+ /** Number of configured services */
282
+ serviceCount: number;
283
+ /** Services the site is not configured for */
284
+ inactiveServices: string[];
285
+ [key: string]: unknown;
286
+ }
287
+ /**
288
+ * Shape of data nested in ContextGetData (MINIMUM fields; reused wherever the same shape appears)
289
+ *
290
+ * Nested in ContextGetData
291
+ */
292
+ export interface ContextGetDataOption2 {
293
+ /** Site described */
294
+ siteId: string;
295
+ /** Site domain; null when the site is not provisioned */
296
+ domain: string | null;
297
+ /** Site row in sites_table (dev port = 3000 + uid); 0 when the site is unknown */
298
+ uid: number;
299
+ /** Services the site is configured for */
300
+ services: string[];
301
+ /** Number of configured services */
302
+ serviceCount: number;
303
+ /** Services the site is not configured for */
304
+ inactiveServices: string[];
305
+ [key: string]: unknown;
306
+ }
307
+ /**
308
+ * Get site context
309
+ * Response data for GET /context/{siteId} — MINIMUM fields, extras pass through
310
+ *
311
+ * Returned by: api.agrSite.context.get(siteId)
312
+ */
313
+ export type ContextGetData = ContextGetDataOption1 | ContextGetDataOption2;
314
+ /**
315
+ * List a site web folder
316
+ * Response data for GET /datafiles — MINIMUM fields, extras pass through
317
+ *
318
+ * Returned by: api.agrSite.datafiles.list(params) (array items)
319
+ */
320
+ export interface DatafilesListItem {
321
+ /** Path relative to the location root */
322
+ path: string;
323
+ /** file or dir */
324
+ type: string;
325
+ /** Size in bytes; 0 for a folder */
326
+ size: number;
327
+ /** Last modified time, ISO 8601 UTC */
328
+ modified: string;
329
+ /**
330
+ * Lowercase hex sha256 of a file; the key is absent unless withSha256=true was sent, and for
331
+ * folders
332
+ */
333
+ sha256?: string | null;
334
+ [key: string]: unknown;
335
+ }
336
+ /** Returned by: api.agrSite.datafiles.list(params) */
337
+ export type DatafilesListData = DatafilesListItem[];
338
+ /**
339
+ * Write a file to a site web folder
340
+ * Response data for POST /datafiles — MINIMUM fields, extras pass through
341
+ *
342
+ * Returned by: api.agrSite.datafiles.create(data)
343
+ */
344
+ export interface DatafilesCreateData {
345
+ /** Stored location and path, as "{location}/{path}" */
346
+ path: string;
347
+ /** File size in bytes */
348
+ size: number;
349
+ /** Lowercase hex sha256 of the stored file */
350
+ sha256: string;
351
+ /** True when an existing file at the path was replaced */
352
+ overwritten: boolean;
353
+ /** True when the file already matched the sent sha256 and nothing was written */
354
+ unchanged: boolean;
355
+ [key: string]: unknown;
356
+ }
357
+ /**
358
+ * Write a file to a site web folder
359
+ * Request body for POST /datafiles — MINIMUM fields, extras pass through
360
+ *
361
+ * Request body of: api.agrSite.datafiles.create(data)
362
+ */
363
+ export interface DatafilesCreateBody {
364
+ /** public (www) or private (datafiles); anything else is rejected */
365
+ location: string;
366
+ /**
367
+ * Relative file path; MUST NOT be empty, absolute, or contain .. segments, and MUST end in an
368
+ * allowed extension
369
+ */
370
+ path: string;
371
+ /** File content, base64-encoded; send this or sourceUrl, not both */
372
+ content?: string;
373
+ /** Public https URL the file is copied from; send this or content, not both */
374
+ sourceUrl?: string | null;
375
+ /**
376
+ * Expected lowercase hex sha256 of the file; when the stored file already matches, nothing is
377
+ * written, and a written file that does not match is discarded
378
+ */
379
+ sha256?: string | null;
380
+ [key: string]: unknown;
381
+ }
382
+ /**
383
+ * Delete a file
384
+ * Response data for DELETE /datafiles — MINIMUM fields, extras pass through
385
+ *
386
+ * Returned by: api.agrSite.datafiles.delete(params)
387
+ */
388
+ export interface DatafilesDeleteData {
389
+ /** Removed location and path, as "{location}/{path}" */
390
+ path: string;
391
+ /** Size in bytes of the removed file */
392
+ size: number;
393
+ /** Lowercase hex sha256 of the removed file */
394
+ sha256: string;
395
+ [key: string]: unknown;
396
+ }
397
+ /**
398
+ * List Fyxer Transcripts
399
+ * Response data for GET /fyxer-transcript — MINIMUM fields, extras pass through
400
+ *
401
+ * Returned by: api.agrSite.fyxerTranscript.list(params) (array items)
402
+ * Returned by: api.agrSite.fyxerTranscript.create(data)
403
+ * Returned by: api.agrSite.fyxerTranscript.get(fyxerTranscriptHdrUid)
404
+ * Returned by: api.agrSite.fyxerTranscript.update(fyxerTranscriptHdrUid, data)
405
+ * Returned by: api.agrSite.fyxerTranscript.delete(fyxerTranscriptHdrUid)
406
+ */
407
+ export interface FyxerTranscriptListItem {
408
+ /** Fyxer transcript ID */
409
+ fyxerTranscriptHdrUid: number;
410
+ /** Recording link (max 255 chars) */
411
+ link: string;
412
+ /** Meeting summary */
413
+ summary: string | null;
414
+ /** Full transcript text */
415
+ transcript: string | null;
416
+ /** MySQL datetime format: YYYY-MM-DD HH:mm:ss (mysql-datetime, e.g. 2025-07-30 15:50:49) */
417
+ dateRecorded: string;
418
+ /** MySQL datetime format: YYYY-MM-DD HH:mm:ss (mysql-datetime, e.g. 2025-07-30 15:50:49) */
419
+ dateCreated: string;
420
+ /** MySQL datetime format: YYYY-MM-DD HH:mm:ss (mysql-datetime, e.g. 2025-07-30 15:50:49) */
421
+ dateLastModified: string;
422
+ /** Update code (1185 = Import Complete) */
423
+ updateCd: number;
424
+ /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
425
+ statusCd: number;
426
+ /** Process code (704 = Active, 1185 = Import Complete) */
427
+ processCd: number;
428
+ /** Meeting title (max 255 chars) */
429
+ title: string | null;
430
+ [key: string]: unknown;
431
+ }
432
+ /** Returned by: api.agrSite.fyxerTranscript.list(params) */
433
+ export type FyxerTranscriptListData = FyxerTranscriptListItem[];
434
+ /**
435
+ * Create Fyxer Transcript
436
+ * Response data for POST /fyxer-transcript — MINIMUM fields, extras pass through
437
+ *
438
+ * Returned by: api.agrSite.fyxerTranscript.create(data)
439
+ */
440
+ export type FyxerTranscriptCreateData = FyxerTranscriptListItem;
441
+ /**
442
+ * Create Fyxer Transcript
443
+ * Request body for POST /fyxer-transcript — MINIMUM fields, extras pass through
444
+ *
445
+ * Request body of: api.agrSite.fyxerTranscript.create(data)
446
+ */
447
+ export interface FyxerTranscriptCreateBody {
448
+ /** Meeting title */
449
+ title: string | null;
450
+ /** Recording link; an existing transcript with this link is returned unchanged */
451
+ link?: string | null;
452
+ /** Full transcript text */
453
+ transcript?: string | null;
454
+ /** Meeting summary */
455
+ summary?: string | null;
456
+ /** When the meeting was recorded (any date-time PHP can parse) */
457
+ dateRecorded?: string | null;
458
+ [key: string]: unknown;
459
+ }
460
+ /**
461
+ * Get Fyxer Transcript Details
462
+ * Response data for GET /fyxer-transcript/{fyxerTranscriptHdrUid} — MINIMUM fields, extras pass
463
+ * through
464
+ *
465
+ * Returned by: api.agrSite.fyxerTranscript.get(fyxerTranscriptHdrUid)
466
+ */
467
+ export type FyxerTranscriptGetData = FyxerTranscriptListItem;
468
+ /**
469
+ * Update Fyxer Transcript
470
+ * Response data for PUT /fyxer-transcript/{fyxerTranscriptHdrUid} — MINIMUM fields, extras pass
471
+ * through
472
+ *
473
+ * Returned by: api.agrSite.fyxerTranscript.update(fyxerTranscriptHdrUid, data)
474
+ */
475
+ export type FyxerTranscriptUpdateData = FyxerTranscriptListItem;
476
+ /**
477
+ * Update Fyxer Transcript
478
+ * Request body for PUT /fyxer-transcript/{fyxerTranscriptHdrUid} — MINIMUM fields, extras pass
479
+ * through
480
+ *
481
+ * Request body of: api.agrSite.fyxerTranscript.update(fyxerTranscriptHdrUid, data)
482
+ */
483
+ export interface FyxerTranscriptUpdateBody {
484
+ /** Recording link */
485
+ link?: string | null;
486
+ /** Meeting summary */
487
+ summary?: string | null;
488
+ /** Full transcript text */
489
+ transcript?: string | null;
490
+ /** Meeting title */
491
+ title?: string | null;
492
+ /** When the meeting was recorded (any date-time PHP can parse) */
493
+ dateRecorded?: string | null;
494
+ /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
495
+ statusCd?: number | null;
496
+ /** Process code (704 = Active, 1185 = Import Complete) */
497
+ processCd?: number | null;
498
+ [key: string]: unknown;
499
+ }
500
+ /**
501
+ * DELETE Fyxer Transcript
502
+ * Response data for DELETE /fyxer-transcript/{fyxerTranscriptHdrUid} — MINIMUM fields, extras pass
503
+ * through
504
+ *
505
+ * Returned by: api.agrSite.fyxerTranscript.delete(fyxerTranscriptHdrUid)
506
+ */
507
+ export type FyxerTranscriptDeleteData = FyxerTranscriptListItem;
508
+ /**
509
+ * List Postal Codes
510
+ * Response data for GET /geo-codes-postal-codes — MINIMUM fields, extras pass through
511
+ *
512
+ * Returned by: api.agrSite.geoCodesPostalCodes.list(params) (array items)
513
+ * Returned by: api.agrSite.geoCodesPostalCodes.get(geoCodesPostalCodesUid)
514
+ */
515
+ export interface GeoCodesPostalCodesListItem {
516
+ /** Postal code geo record ID */
517
+ geoCodesPostalCodesUid: number;
518
+ /** ISO country code (max 2 chars) */
519
+ countryCode: string;
520
+ /** Postal code (max 20 chars) */
521
+ postalCode: string;
522
+ /** Place name (max 180 chars) */
523
+ placeName: string;
524
+ /** First-level region name (state) (max 100 chars) */
525
+ adminName1: string;
526
+ /** First-level region code (state) (max 20 chars) */
527
+ adminCode1: string;
528
+ /** Second-level region name (county) (max 100 chars) */
529
+ adminName2: string | null;
530
+ /** Second-level region code (county) (max 20 chars) */
531
+ adminCode2: string | null;
532
+ /** Third-level region name (max 100 chars) */
533
+ adminName3: string | null;
534
+ /** Third-level region code (max 20 chars) */
535
+ adminCode3: string | null;
536
+ /** Latitude */
537
+ latitude: number;
538
+ /** Longitude */
539
+ longitude: number;
540
+ /** Accuracy of the coordinates (1 = estimated, 6 = centroid) */
541
+ accuracy: number | null;
542
+ /** MySQL datetime format: YYYY-MM-DD HH:mm:ss (mysql-datetime, e.g. 2025-07-30 15:50:49) */
543
+ dateCreated: string;
544
+ /** MySQL datetime format: YYYY-MM-DD HH:mm:ss (mysql-datetime, e.g. 2025-07-30 15:50:49) */
545
+ dateLastModified: string;
546
+ /** Update code (1185 = Import Complete) */
547
+ updateCd: number;
548
+ /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
549
+ statusCd: number;
550
+ /** Process code (704 = Active, 1185 = Import Complete) */
551
+ processCd: number;
552
+ [key: string]: unknown;
553
+ }
554
+ /** Returned by: api.agrSite.geoCodesPostalCodes.list(params) */
555
+ export type GeoCodesPostalCodesListData = GeoCodesPostalCodesListItem[];
556
+ /**
557
+ * Get Postal Code Details
558
+ * Response data for GET /geo-codes-postal-codes/{geoCodesPostalCodesUid} — MINIMUM fields, extras
559
+ * pass through
560
+ *
561
+ * Returned by: api.agrSite.geoCodesPostalCodes.get(geoCodesPostalCodesUid)
562
+ */
563
+ export type GeoCodesPostalCodesGetData = GeoCodesPostalCodesListItem;
564
+ /**
565
+ * Sites the caller can switch to
566
+ * Response data for GET /linked-sites — MINIMUM fields, extras pass through
567
+ *
568
+ * Returned by: api.agrSite.linkedSites.list() (array items)
569
+ */
570
+ export interface LinkedSitesListItem {
571
+ /** Linked site's siteId */
572
+ siteId: string;
573
+ /** Linked site's domain name; empty when the site has none on file */
574
+ domain: string;
575
+ /** The user's id on the linked site */
576
+ userId: number;
577
+ [key: string]: unknown;
578
+ }
579
+ /** Returned by: api.agrSite.linkedSites.list() */
580
+ export type LinkedSitesListData = LinkedSitesListItem[];
581
+ /**
582
+ * Token for a linked site
583
+ * Response data for POST /linked-sites/token — MINIMUM fields, extras pass through
584
+ *
585
+ * Returned by: api.agrSite.linkedSites.token.create(data)
586
+ */
587
+ export interface LinkedSitesTokenCreateData {
588
+ /** User-scope JWT bound to the linked site; short-lived (see its exp claim) */
589
+ token: string;
590
+ /** Linked site the token is bound to */
591
+ siteId: string;
592
+ /** The user's id on the linked site */
593
+ userId: number;
594
+ /** The user's username on the linked site */
595
+ username: string;
596
+ [key: string]: unknown;
597
+ }
598
+ /**
599
+ * Token for a linked site
600
+ * Request body for POST /linked-sites/token — MINIMUM fields, extras pass through
601
+ *
602
+ * Request body of: api.agrSite.linkedSites.token.create(data)
603
+ */
604
+ export interface LinkedSitesTokenCreateBody {
605
+ /** Linked site to issue the token for */
606
+ siteId: string;
607
+ [key: string]: unknown;
608
+ }
609
+ /**
610
+ * Get Robots.txt
611
+ * Response data for GET /meta-files/robots — MINIMUM fields, extras pass through
612
+ *
613
+ * Returned by: api.agrSite.metaFiles.robots.list()
614
+ */
615
+ export interface MetaFilesRobotsListData {
616
+ /** robots.txt body */
617
+ content: string;
618
+ /** Always text/plain */
619
+ contentType: string;
620
+ [key: string]: unknown;
621
+ }
622
+ /**
623
+ * List Notifications
624
+ * Response data for GET /notifications — MINIMUM fields, extras pass through
625
+ *
626
+ * Returned by: api.agrSite.notifications.list(params) (array items)
627
+ * Returned by: api.agrSite.notifications.create(data)
628
+ * Returned by: api.agrSite.notifications.get(notificationsUid)
629
+ */
630
+ export interface NotificationsCreateData {
631
+ /** Notification ID */
632
+ notificationsUid: number;
633
+ /** Service the notification is about (max 100 chars) */
634
+ serviceName: string | null;
635
+ /** Datatype the notification is about (max 100 chars) */
636
+ dataTypeName: string | null;
637
+ /** Notification type (max 100 chars) */
638
+ type: string | null;
639
+ /** ID of the record the notification is about */
640
+ dataTypeUid: number;
641
+ /** MySQL datetime format: YYYY-MM-DD HH:mm:ss (mysql-datetime, e.g. 2025-07-30 15:50:49) */
642
+ dateCreated: string;
643
+ /** MySQL datetime format: YYYY-MM-DD HH:mm:ss (mysql-datetime, e.g. 2025-07-30 15:50:49) */
644
+ dateLastModified: string;
645
+ /** Update code (1185 = Import Complete) */
646
+ updateCd: number;
647
+ /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
648
+ statusCd: number;
649
+ /** Process code (704 = Active, 1185 = Import Complete) */
650
+ processCd: number;
651
+ [key: string]: unknown;
652
+ }
653
+ /**
654
+ * List Notifications
655
+ * Response data for GET /notifications — MINIMUM fields, extras pass through
656
+ *
657
+ * Returned by: api.agrSite.notifications.list(params) (array items)
658
+ */
659
+ export type NotificationsListItem = NotificationsCreateData;
660
+ /** Returned by: api.agrSite.notifications.list(params) */
661
+ export type NotificationsListData = NotificationsListItem[];
662
+ /**
663
+ * Create Notification
664
+ * Request body for POST /notifications — MINIMUM fields, extras pass through
665
+ *
666
+ * Request body of: api.agrSite.notifications.create(data)
667
+ */
668
+ export interface NotificationsCreateBody {
669
+ /** Service the notification is about; nothing is stored when missing */
670
+ serviceName: string | null;
671
+ /** Datatype the notification is about; nothing is stored when missing */
672
+ dataTypeName: string | null;
673
+ /** Notification type; nothing is stored when missing */
674
+ type: string | null;
675
+ /** ID of the record the notification is about (Default: 0) */
676
+ dataTypeUid?: number | null;
677
+ [key: string]: unknown;
678
+ }
679
+ /**
680
+ * Get Notification
681
+ * Response data for GET /notifications/{notificationsUid} — MINIMUM fields, extras pass through
682
+ *
683
+ * Returned by: api.agrSite.notifications.get(notificationsUid)
684
+ */
685
+ export type NotificationsGetData = NotificationsCreateData;
686
+ /**
687
+ * Get Query String Embedding
688
+ * Response data for GET /open-search/embedding — MINIMUM fields, extras pass through
689
+ *
690
+ * Returned by: api.agrSite.openSearch.embedding.list(params)
691
+ */
692
+ export interface OpenSearchEmbeddingListData {
693
+ /** Query string as sent (trimmed) */
694
+ queryString: string;
695
+ /** Query string after cleaning, as stored */
696
+ queryStringCleaned: string | null;
697
+ /** Hash of the cleaned query string */
698
+ queryStringHash: string | null;
699
+ /** 768-dimension embedding; empty when none could be produced */
700
+ vector: number[];
701
+ [key: string]: unknown;
702
+ }
703
+ /**
704
+ * List Postal Codes X Ship Tos
705
+ * Response data for GET /postal-codes-x-shiptos — MINIMUM fields, extras pass through
706
+ *
707
+ * Returned by: api.agrSite.postalCodesXShiptos.list(params) (array items)
708
+ * Returned by: api.agrSite.postalCodesXShiptos.create(data)
709
+ * Returned by: api.agrSite.postalCodesXShiptos.get(postalCodesXShiptosUid)
710
+ * Returned by: api.agrSite.postalCodesXShiptos.update(postalCodesXShiptosUid, data)
711
+ * Returned by: api.agrSite.postalCodesXShiptos.delete(postalCodesXShiptosUid)
712
+ */
713
+ export interface PostalCodesXShiptosListItem {
714
+ /** Postal code to ship-to link ID */
715
+ postalCodesXShiptosUid: number;
716
+ /** Postal code (max 20 chars) */
717
+ postalCode: string;
718
+ /** Prophet 21 ship-to ID */
719
+ shipToId: number;
720
+ /** MySQL datetime format: YYYY-MM-DD HH:mm:ss (mysql-datetime, e.g. 2025-07-30 15:50:49) */
721
+ dateCreated: string;
722
+ /** MySQL datetime format: YYYY-MM-DD HH:mm:ss (mysql-datetime, e.g. 2025-07-30 15:50:49) */
723
+ dateLastModified: string;
724
+ /** Update code (1185 = Import Complete) */
725
+ updateCd: number;
726
+ /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
727
+ statusCd: number;
728
+ /** Process code (704 = Active, 1185 = Import Complete) */
729
+ processCd: number;
730
+ [key: string]: unknown;
731
+ }
732
+ /** Returned by: api.agrSite.postalCodesXShiptos.list(params) */
733
+ export type PostalCodesXShiptosListData = PostalCodesXShiptosListItem[];
734
+ /**
735
+ * Create Postal Code X Ship To
736
+ * Response data for POST /postal-codes-x-shiptos — MINIMUM fields, extras pass through
737
+ *
738
+ * Returned by: api.agrSite.postalCodesXShiptos.create(data)
739
+ */
740
+ export type PostalCodesXShiptosCreateData = PostalCodesXShiptosListItem;
741
+ /**
742
+ * Create Postal Code X Ship To
743
+ * Request body for POST /postal-codes-x-shiptos — MINIMUM fields, extras pass through
744
+ *
745
+ * Request body of: api.agrSite.postalCodesXShiptos.create(data)
746
+ */
747
+ export interface PostalCodesXShiptosCreateBody {
748
+ /** Postal code (max 20 chars) */
749
+ postalCode?: string | null;
750
+ /** Prophet 21 ship-to ID */
751
+ shipToId?: number | null;
752
+ [key: string]: unknown;
753
+ }
754
+ /**
755
+ * Get Postal Code X Ship To Details
756
+ * Response data for GET /postal-codes-x-shiptos/{postalCodesXShiptosUid} — MINIMUM fields, extras
757
+ * pass through
758
+ *
759
+ * Returned by: api.agrSite.postalCodesXShiptos.get(postalCodesXShiptosUid)
760
+ */
761
+ export type PostalCodesXShiptosGetData = PostalCodesXShiptosListItem;
762
+ /**
763
+ * Update Postal Code X Ship To
764
+ * Response data for PUT /postal-codes-x-shiptos/{postalCodesXShiptosUid} — MINIMUM fields, extras
765
+ * pass through
766
+ *
767
+ * Returned by: api.agrSite.postalCodesXShiptos.update(postalCodesXShiptosUid, data)
768
+ */
769
+ export type PostalCodesXShiptosUpdateData = PostalCodesXShiptosListItem;
770
+ /**
771
+ * Update Postal Code X Ship To
772
+ * Request body for PUT /postal-codes-x-shiptos/{postalCodesXShiptosUid} — MINIMUM fields, extras
773
+ * pass through
774
+ *
775
+ * Request body of: api.agrSite.postalCodesXShiptos.update(postalCodesXShiptosUid, data)
776
+ */
777
+ export interface PostalCodesXShiptosUpdateBody {
778
+ /** Postal code (max 20 chars) */
779
+ postalCode?: string | null;
780
+ /** Prophet 21 ship-to ID */
781
+ shipToId?: number | null;
782
+ /** Status code (704 = Active, 705 = Inactive, 700 = Deleted); other values are ignored */
783
+ statusCd?: number | null;
784
+ /** Process code (704 = Active, 1185 = Import Complete); other values are ignored */
785
+ processCd?: number | null;
786
+ /** Update code (1185 = Import Complete); other values are ignored */
787
+ updateCd?: number | null;
788
+ [key: string]: unknown;
789
+ }
790
+ /**
791
+ * Soft Delete Postal Code X Ship To
792
+ * Response data for DELETE /postal-codes-x-shiptos/{postalCodesXShiptosUid} — MINIMUM fields,
793
+ * extras pass through
794
+ *
795
+ * Returned by: api.agrSite.postalCodesXShiptos.delete(postalCodesXShiptosUid)
796
+ */
797
+ export type PostalCodesXShiptosDeleteData = PostalCodesXShiptosListItem;
798
+ /**
799
+ * List Settings
800
+ * Response data for GET /settings — MINIMUM fields, extras pass through
801
+ *
802
+ * Returned by: api.agrSite.settings.list(params) (array items)
803
+ * Returned by: api.agrSite.settings.create(data)
804
+ * Returned by: api.agrSite.settings.get(settingsUid)
805
+ * Returned by: api.agrSite.settings.update(settingsUid, data)
806
+ * Returned by: api.agrSite.settings.delete(settingsUid)
807
+ */
808
+ export interface SettingsListItem {
809
+ /** Setting ID */
810
+ settingsUid: number;
811
+ /** Service the setting belongs to (max 100 chars) */
812
+ serviceName: string;
813
+ /** Setting name (max 100 chars) */
814
+ name: string;
815
+ /** Setting value (max 255 chars) */
816
+ value: string | null;
817
+ /** MySQL datetime format: YYYY-MM-DD HH:mm:ss (mysql-datetime, e.g. 2025-07-30 15:50:49) */
818
+ dateCreated: string;
819
+ /** MySQL datetime format: YYYY-MM-DD HH:mm:ss (mysql-datetime, e.g. 2025-07-30 15:50:49) */
820
+ dateLastModified: string;
821
+ /** Update code (1185 = Import Complete) */
822
+ updateCd: number;
823
+ /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
824
+ statusCd: number;
825
+ /** Process code (704 = Active, 1185 = Import Complete) */
826
+ processCd: number;
827
+ [key: string]: unknown;
828
+ }
829
+ /** Returned by: api.agrSite.settings.list(params) */
830
+ export type SettingsListData = SettingsListItem[];
831
+ /**
832
+ * Create Settings
833
+ * Response data for POST /settings — MINIMUM fields, extras pass through
834
+ *
835
+ * Returned by: api.agrSite.settings.create(data)
836
+ */
837
+ export type SettingsCreateData = SettingsListItem;
838
+ /**
839
+ * Create Settings
840
+ * Request body for POST /settings — MINIMUM fields, extras pass through
841
+ *
842
+ * Request body of: api.agrSite.settings.create(data)
843
+ */
844
+ export interface SettingsCreateBody {
845
+ /** Service the setting belongs to; nothing is stored when missing */
846
+ serviceName: string | null;
847
+ /** Setting name; nothing is stored when missing */
848
+ name: string | null;
849
+ /** Setting value */
850
+ value?: string | null;
851
+ [key: string]: unknown;
852
+ }
853
+ /**
854
+ * Get Settings Details
855
+ * Response data for GET /settings/{settingsUid} — MINIMUM fields, extras pass through
856
+ *
857
+ * Returned by: api.agrSite.settings.get(settingsUid)
858
+ */
859
+ export type SettingsGetData = SettingsListItem;
860
+ /**
861
+ * Update Settings
862
+ * Response data for PUT /settings/{settingsUid} — MINIMUM fields, extras pass through
863
+ *
864
+ * Returned by: api.agrSite.settings.update(settingsUid, data)
865
+ */
866
+ export type SettingsUpdateData = SettingsListItem;
867
+ /**
868
+ * Update Settings
869
+ * Request body for PUT /settings/{settingsUid} — MINIMUM fields, extras pass through
870
+ *
871
+ * Request body of: api.agrSite.settings.update(settingsUid, data)
872
+ */
873
+ export interface SettingsUpdateBody {
874
+ /** Service the setting belongs to */
875
+ serviceName?: string | null;
876
+ /** Setting name */
877
+ name?: string | null;
878
+ /** Setting value */
879
+ value?: string | null;
880
+ /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
881
+ statusCd?: number | null;
882
+ /** Update code (1185 = Import Complete) */
883
+ updateCd?: number | null;
884
+ /** Process code (704 = Active, 1185 = Import Complete) */
885
+ processCd?: number | null;
886
+ [key: string]: unknown;
887
+ }
888
+ /**
889
+ * DELETE Settings
890
+ * Response data for DELETE /settings/{settingsUid} — MINIMUM fields, extras pass through
891
+ *
892
+ * Returned by: api.agrSite.settings.delete(settingsUid)
893
+ */
894
+ export type SettingsDeleteData = SettingsListItem;
895
+ /**
896
+ * List user addresses
897
+ * Response data for GET /users/{userId}/addresses — MINIMUM fields, extras pass through
898
+ *
899
+ * Returned by: api.agrSite.users.addresses.list(userId, params) (array items)
900
+ * Returned by: api.agrSite.users.addresses.create(userId, data)
901
+ * Returned by: api.agrSite.users.addresses.get(userId, userAddressUid)
902
+ * Returned by: api.agrSite.users.addresses.update(userId, userAddressUid, data)
903
+ * Returned by: api.agrSite.users.addresses.delete(userId, userAddressUid)
904
+ */
905
+ export interface UsersAddressesListItem {
906
+ /** User address ID */
907
+ userAddressUid: number;
908
+ /** Joomla user the address belongs to */
909
+ userId: number;
910
+ /** Address line 1 (max 50 chars) */
911
+ address1: string | null;
912
+ /** Address line 2 (max 50 chars) */
913
+ address2: string | null;
914
+ /** Address line 3 (max 50 chars) */
915
+ address3: string | null;
916
+ /** City (max 50 chars) */
917
+ city: string | null;
918
+ /** State or province (max 50 chars) */
919
+ state: string | null;
920
+ /** Postal code (max 10 chars) */
921
+ postalCode: string | null;
922
+ /** Country (max 50 chars) */
923
+ country: string | null;
924
+ /** Email address (max 255 chars) */
925
+ emailAddress: string | null;
926
+ /** Name on the address (max 255 chars) */
927
+ name: string | null;
928
+ /** Main phone number (max 20 chars) */
929
+ phoneNumberMain: string | null;
930
+ /** Mobile phone number (max 20 chars) */
931
+ phoneNumberMobile: string | null;
932
+ /** MySQL datetime format: YYYY-MM-DD HH:mm:ss (mysql-datetime, e.g. 2025-07-30 15:50:49) */
933
+ dateCreated: string;
934
+ /** MySQL datetime format: YYYY-MM-DD HH:mm:ss (mysql-datetime, e.g. 2025-07-30 15:50:49) */
935
+ dateLastModified: string;
936
+ /** Update code (1185 = Import Complete) */
937
+ updateCd: number;
938
+ /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
939
+ statusCd: number;
940
+ /** Process code (704 = Active, 1185 = Import Complete) */
941
+ processCd: number;
942
+ [key: string]: unknown;
943
+ }
944
+ /** Returned by: api.agrSite.users.addresses.list(userId, params) */
945
+ export type UsersAddressesListData = UsersAddressesListItem[];
946
+ /**
947
+ * Create a new user_address row
948
+ * Response data for POST /users/{userId}/addresses — MINIMUM fields, extras pass through
949
+ *
950
+ * Returned by: api.agrSite.users.addresses.create(userId, data)
951
+ */
952
+ export type UsersAddressesCreateData = UsersAddressesListItem;
953
+ /**
954
+ * Create a new user_address row
955
+ * Request body for POST /users/{userId}/addresses — MINIMUM fields, extras pass through
956
+ *
957
+ * Request body of: api.agrSite.users.addresses.create(userId, data)
958
+ */
959
+ export interface UsersAddressesCreateBody {
960
+ /** Address line 1 */
961
+ address1?: string | null;
962
+ /** Address line 2 */
963
+ address2?: string | null;
964
+ /** Address line 3 */
965
+ address3?: string | null;
966
+ /** City */
967
+ city?: string | null;
968
+ /** State or province */
969
+ state?: string | null;
970
+ /** Postal code */
971
+ postalCode?: string | null;
972
+ /** Country */
973
+ country?: string | null;
974
+ /** Email address */
975
+ emailAddress?: string | null;
976
+ /** Name on the address */
977
+ name?: string | null;
978
+ /** Main phone number */
979
+ phoneNumberMain?: string | null;
980
+ /** Mobile phone number */
981
+ phoneNumberMobile?: string | null;
982
+ /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) (Default: 704) */
983
+ statusCd?: number | null;
984
+ /** Process code (704 = Active, 1185 = Import Complete) (Default: 704) */
985
+ processCd?: number | null;
986
+ /** Update code (1185 = Import Complete) (Default: 1185) */
987
+ updateCd?: number | null;
988
+ [key: string]: unknown;
989
+ }
990
+ /**
991
+ * Get a user_address
992
+ * Response data for GET /users/{userId}/addresses/{userAddressUid} — MINIMUM fields, extras pass
993
+ * through
994
+ *
995
+ * Returned by: api.agrSite.users.addresses.get(userId, userAddressUid)
996
+ */
997
+ export type UsersAddressesGetData = UsersAddressesListItem;
998
+ /**
999
+ * Update a user_address row
1000
+ * Response data for PUT /users/{userId}/addresses/{userAddressUid} — MINIMUM fields, extras pass
1001
+ * through
1002
+ *
1003
+ * Returned by: api.agrSite.users.addresses.update(userId, userAddressUid, data)
1004
+ */
1005
+ export type UsersAddressesUpdateData = UsersAddressesListItem;
1006
+ /**
1007
+ * Update a user_address row
1008
+ * Request body for PUT /users/{userId}/addresses/{userAddressUid} — MINIMUM fields, extras pass
1009
+ * through
1010
+ *
1011
+ * Request body of: api.agrSite.users.addresses.update(userId, userAddressUid, data)
1012
+ */
1013
+ export interface UsersAddressesUpdateBody {
1014
+ /** Address line 1 */
1015
+ address1?: string | null;
1016
+ /** Address line 2 */
1017
+ address2?: string | null;
1018
+ /** Address line 3 */
1019
+ address3?: string | null;
1020
+ /** City */
1021
+ city?: string | null;
1022
+ /** State or province */
1023
+ state?: string | null;
1024
+ /** Postal code */
1025
+ postalCode?: string | null;
1026
+ /** Country */
1027
+ country?: string | null;
1028
+ /** Email address */
1029
+ emailAddress?: string | null;
1030
+ /** Name on the address */
1031
+ name?: string | null;
1032
+ /** Main phone number */
1033
+ phoneNumberMain?: string | null;
1034
+ /** Mobile phone number */
1035
+ phoneNumberMobile?: string | null;
1036
+ /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
1037
+ statusCd?: number | null;
1038
+ /** Process code (704 = Active, 1185 = Import Complete) */
1039
+ processCd?: number | null;
1040
+ [key: string]: unknown;
1041
+ }
1042
+ /**
1043
+ * Soft-delete a user_address row
1044
+ * Response data for DELETE /users/{userId}/addresses/{userAddressUid} — MINIMUM fields, extras pass
1045
+ * through
1046
+ *
1047
+ * Returned by: api.agrSite.users.addresses.delete(userId, userAddressUid)
1048
+ */
1049
+ export type UsersAddressesDeleteData = UsersAddressesListItem;
1050
+ export interface AgrSiteClientSpec {
1051
+ configs: {
1052
+ /**
1053
+ * List service configs
1054
+ * Call: api.agrSite.configs.list(params)
1055
+ *
1056
+ * Services that have a config file for the site
1057
+ *
1058
+ * Response data, each item: A service that has a config file for the site
1059
+ *
1060
+ * GET https://agr-site.augur-api.com/configs
1061
+ * Contract: https://agr-site.augur-api.com/openapi.json#/paths/~1configs/get
1062
+ *
1063
+ * @param params ConfigsListParams (query string)
1064
+ * @returns BaseResponse whose `data` is ConfigsListData
1065
+ */
1066
+ list: (params?: ConfigsListParams) => Promise<BaseResponse<ConfigsListData>>;
1067
+ /**
1068
+ * Get a service config
1069
+ * Call: api.agrSite.configs.get(serviceName)
1070
+ *
1071
+ * Every app.config key of one service for the site: value, default, type, allowed values, and
1072
+ * whether the site config file sets it
1073
+ *
1074
+ * Response data: A site's config for one service: every key the service definition declares,
1075
+ * set or not
1076
+ *
1077
+ * Errors:
1078
+ * 404: The site has no domain, or no service definition with an app.config block exists for
1079
+ * serviceName.
1080
+ *
1081
+ * GET https://agr-site.augur-api.com/configs/{serviceName}
1082
+ * Contract: https://agr-site.augur-api.com/openapi.json#/paths/~1configs~1{serviceName}/get
1083
+ *
1084
+ * @param serviceName Service name, snake_case (e.g. p21_sism)
1085
+ * @param params ConfigsGetParams (query string)
1086
+ * @returns BaseResponse whose `data` is ConfigsGetData
1087
+ */
1088
+ get: (serviceName: string, params?: ConfigsGetParams) => Promise<BaseResponse<ConfigsGetData>>;
1089
+ /**
1090
+ * Update a service config
1091
+ * Call: api.agrSite.configs.update(serviceName, data)
1092
+ *
1093
+ * Set one or more app.config keys in the site config file for one service; keys not sent are
1094
+ * left unchanged. Body: {"values": {"default_scheduled_import_master_uid": "12"}}. GET
1095
+ * /configs/{serviceName} lists every settable key with its type and allowed values. A value
1096
+ * MUST be a string or number and is stored as the key's declared type (int, float, string), so
1097
+ * "12" and 12 both store 12 for an int key. A body that is not JSON or has no values returns
1098
+ * 400; a boolean, null, or nested value, an unknown key, prefix, a wrong type, or a value
1099
+ * outside allowed_values returns 422 naming every bad key and the valid options, and nothing is
1100
+ * written
1101
+ *
1102
+ * Request body: Set one or more keys in a site's config file for one service; keys not sent are
1103
+ * left unchanged
1104
+ * Response data: A site's config for one service: every key the service definition declares,
1105
+ * set or not
1106
+ *
1107
+ * Errors:
1108
+ * 400: Bad request: the body is missing, or values is missing, empty, or not an object of
1109
+ * scalars; message says which.
1110
+ * 404: The site has no domain, or no service definition with an app.config block exists for
1111
+ * serviceName.
1112
+ * 422: A value is not a string or number, a key is unknown or protected (prefix), a value
1113
+ * does not parse as the key's type, or a value is outside allowed_values; message lists
1114
+ * the errors and the valid options. Nothing is written.
1115
+ *
1116
+ * PUT https://agr-site.augur-api.com/configs/{serviceName}
1117
+ * Contract: https://agr-site.augur-api.com/openapi.json#/paths/~1configs~1{serviceName}/put
1118
+ *
1119
+ * @param serviceName Service name, snake_case (e.g. p21_sism)
1120
+ * @param data ConfigsUpdateBody (request body)
1121
+ * @returns BaseResponse whose `data` is ConfigsUpdateData
1122
+ */
1123
+ update: (serviceName: string, data: ConfigsUpdateBody) => Promise<BaseResponse<ConfigsUpdateData>>;
1124
+ };
1125
+ context: {
1126
+ /**
1127
+ * Get site context
1128
+ * Call: api.agrSite.context.get(siteId)
1129
+ *
1130
+ * get the context for a site
1131
+ *
1132
+ * Auth: bearer token; spec scopes: none listed (most endpoints list `public`)
1133
+ *
1134
+ * Errors:
1135
+ * 403: The siteId in the path does not match x-site-id.
1136
+ * 404: The site has no domain configured.
1137
+ *
1138
+ * GET https://agr-site.augur-api.com/context/{siteId}
1139
+ * Contract: https://agr-site.augur-api.com/openapi.json#/paths/~1context~1{siteId}/get
1140
+ *
1141
+ * @param siteId target site ID to get context for
1142
+ * @param params ContextGetParams (query string)
1143
+ * @returns BaseResponse whose `data` is ContextGetData
1144
+ */
1145
+ get: (siteId: string, params?: ContextGetParams) => Promise<BaseResponse<ContextGetData>>;
1146
+ };
1147
+ datafiles: {
1148
+ /**
1149
+ * List a site web folder
1150
+ * Call: api.agrSite.datafiles.list(params)
1151
+ *
1152
+ * List one folder of a site web folder, sorted by name
1153
+ *
1154
+ * Response data, each item: One file or folder inside a listed folder
1155
+ *
1156
+ * Errors:
1157
+ * 400: Request rejected: location or path is missing or invalid, or path names a file.
1158
+ * 403: Request rejected: a public path does not start with images/, media/ or phocadownload/.
1159
+ * 404: The folder does not exist.
1160
+ *
1161
+ * GET https://agr-site.augur-api.com/datafiles
1162
+ * Contract: https://agr-site.augur-api.com/openapi.json#/paths/~1datafiles/get
1163
+ *
1164
+ * @param params DatafilesListParams (query string)
1165
+ * @returns BaseResponse whose `data` is DatafilesListData
1166
+ */
1167
+ list: (params?: DatafilesListParams) => Promise<BaseResponse<DatafilesListData>>;
1168
+ /**
1169
+ * Write a file to a site web folder
1170
+ * Call: api.agrSite.datafiles.create(data)
1171
+ *
1172
+ * Write a file to a site web folder from base64 content or an https URL
1173
+ *
1174
+ * Request body: Write one file into the calling site's public (www) or private (datafiles)
1175
+ * folder, from base64 content or an https URL
1176
+ * Response data: The file now stored at the requested path
1177
+ *
1178
+ * Success status: 201 (not 200)
1179
+ *
1180
+ * Errors:
1181
+ * 400: Request rejected: location, path, content, sourceUrl or sha256 is missing or invalid,
1182
+ * or both content and sourceUrl were sent.
1183
+ * 403: Request rejected: a public path does not start with images/, media/ or phocadownload/,
1184
+ * the file extension is not allowed, or the content contains a PHP open tag.
1185
+ * 422: The written file did not match the sent sha256; it was discarded and any existing file
1186
+ * is unchanged.
1187
+ * 502: The sourceUrl could not be fetched; nothing was written.
1188
+ *
1189
+ * POST https://agr-site.augur-api.com/datafiles
1190
+ * Contract: https://agr-site.augur-api.com/openapi.json#/paths/~1datafiles/post
1191
+ *
1192
+ * @param data DatafilesCreateBody (request body)
1193
+ * @returns BaseResponse whose `data` is DatafilesCreateData
1194
+ */
1195
+ create: (data: DatafilesCreateBody) => Promise<BaseResponse<DatafilesCreateData>>;
1196
+ /**
1197
+ * Delete a file
1198
+ * Call: api.agrSite.datafiles.delete(params)
1199
+ *
1200
+ * Delete one file from a site web folder
1201
+ *
1202
+ * Response data: The file that was removed
1203
+ *
1204
+ * Errors:
1205
+ * 400: Request rejected: location or path is missing or invalid, or path names a folder or
1206
+ * carries a wildcard; nothing was removed.
1207
+ * 403: Request rejected: a public path does not start with images/, media/ or phocadownload/,
1208
+ * or the file extension is not allowed.
1209
+ * 404: The file does not exist.
1210
+ *
1211
+ * DELETE https://agr-site.augur-api.com/datafiles
1212
+ * Contract: https://agr-site.augur-api.com/openapi.json#/paths/~1datafiles/delete
1213
+ *
1214
+ * @param params DatafilesDeleteParams (query string)
1215
+ * @returns BaseResponse whose `data` is DatafilesDeleteData
1216
+ */
1217
+ delete: (params?: DatafilesDeleteParams) => Promise<BaseResponse<DatafilesDeleteData>>;
1218
+ };
1219
+ fyxerTranscript: {
1220
+ /**
1221
+ * List Fyxer Transcripts
1222
+ * Call: api.agrSite.fyxerTranscript.list(params)
1223
+ *
1224
+ * Errors:
1225
+ * 400: orderBy is not column|ASC or column|DESC on a fyxer_transcript_hdr column.
1226
+ *
1227
+ * GET https://agr-site.augur-api.com/fyxer-transcript
1228
+ * Contract: https://agr-site.augur-api.com/openapi.json#/paths/~1fyxer-transcript/get
1229
+ *
1230
+ * @param params FyxerTranscriptListParams (query string)
1231
+ * @returns BaseResponse whose `data` is FyxerTranscriptListData
1232
+ */
1233
+ list: (params?: FyxerTranscriptListParams) => Promise<BaseResponse<FyxerTranscriptListData>>;
1234
+ /**
1235
+ * Create Fyxer Transcript
1236
+ * Call: api.agrSite.fyxerTranscript.create(data)
1237
+ *
1238
+ * Request body: Create a Fyxer meeting transcript, or return the existing one with the same
1239
+ * link
1240
+ *
1241
+ * Errors:
1242
+ * 400: The body is missing or not a JSON object.
1243
+ *
1244
+ * POST https://agr-site.augur-api.com/fyxer-transcript
1245
+ * Contract: https://agr-site.augur-api.com/openapi.json#/paths/~1fyxer-transcript/post
1246
+ *
1247
+ * @param data FyxerTranscriptCreateBody (request body)
1248
+ * @returns BaseResponse whose `data` is FyxerTranscriptCreateData
1249
+ */
1250
+ create: (data: FyxerTranscriptCreateBody) => Promise<BaseResponse<FyxerTranscriptCreateData>>;
1251
+ /**
1252
+ * Get Fyxer Transcript Details
1253
+ * Call: api.agrSite.fyxerTranscript.get(fyxerTranscriptHdrUid)
1254
+ *
1255
+ * Errors:
1256
+ * 404: No transcript with this ID.
1257
+ *
1258
+ * GET https://agr-site.augur-api.com/fyxer-transcript/{fyxerTranscriptHdrUid}
1259
+ * Contract:
1260
+ * https://agr-site.augur-api.com/openapi.json#/paths/~1fyxer-transcript~1{fyxerTranscriptHdrUid}/get
1261
+ *
1262
+ * @param fyxerTranscriptHdrUid Fyxer transcript ID
1263
+ * @param params FyxerTranscriptGetParams (query string)
1264
+ * @returns BaseResponse whose `data` is FyxerTranscriptGetData
1265
+ */
1266
+ get: (fyxerTranscriptHdrUid: number, params?: FyxerTranscriptGetParams) => Promise<BaseResponse<FyxerTranscriptGetData>>;
1267
+ /**
1268
+ * Update Fyxer Transcript
1269
+ * Call: api.agrSite.fyxerTranscript.update(fyxerTranscriptHdrUid, data)
1270
+ *
1271
+ * Request body: Partial update of a Fyxer meeting transcript; an absent field keeps its current
1272
+ * value
1273
+ *
1274
+ * Errors:
1275
+ * 400: The body is missing or not a JSON object.
1276
+ * 404: No transcript with this ID.
1277
+ *
1278
+ * PUT https://agr-site.augur-api.com/fyxer-transcript/{fyxerTranscriptHdrUid}
1279
+ * Contract:
1280
+ * https://agr-site.augur-api.com/openapi.json#/paths/~1fyxer-transcript~1{fyxerTranscriptHdrUid}/put
1281
+ *
1282
+ * @param fyxerTranscriptHdrUid Fyxer transcript ID
1283
+ * @param data FyxerTranscriptUpdateBody (request body)
1284
+ * @returns BaseResponse whose `data` is FyxerTranscriptUpdateData
1285
+ */
1286
+ update: (fyxerTranscriptHdrUid: number, data: FyxerTranscriptUpdateBody) => Promise<BaseResponse<FyxerTranscriptUpdateData>>;
1287
+ /**
1288
+ * DELETE Fyxer Transcript
1289
+ * Call: api.agrSite.fyxerTranscript.delete(fyxerTranscriptHdrUid)
1290
+ *
1291
+ * Errors:
1292
+ * 404: No transcript with this ID.
1293
+ *
1294
+ * DELETE https://agr-site.augur-api.com/fyxer-transcript/{fyxerTranscriptHdrUid}
1295
+ * Contract:
1296
+ * https://agr-site.augur-api.com/openapi.json#/paths/~1fyxer-transcript~1{fyxerTranscriptHdrUid}/delete
1297
+ *
1298
+ * @param fyxerTranscriptHdrUid Fyxer transcript ID
1299
+ * @returns BaseResponse whose `data` is FyxerTranscriptDeleteData
1300
+ */
1301
+ delete: (fyxerTranscriptHdrUid: number) => Promise<BaseResponse<FyxerTranscriptDeleteData>>;
1302
+ };
1303
+ geoCodesPostalCodes: {
1304
+ /**
1305
+ * List Postal Codes
1306
+ * Call: api.agrSite.geoCodesPostalCodes.list(params)
1307
+ *
1308
+ * Errors:
1309
+ * 400: orderBy is not column|ASC or column|DESC on a geo_codes_postal_codes column.
1310
+ *
1311
+ * GET https://agr-site.augur-api.com/geo-codes-postal-codes
1312
+ * Contract: https://agr-site.augur-api.com/openapi.json#/paths/~1geo-codes-postal-codes/get
1313
+ *
1314
+ * @param params GeoCodesPostalCodesListParams (query string)
1315
+ * @returns BaseResponse whose `data` is GeoCodesPostalCodesListData
1316
+ */
1317
+ list: (params?: GeoCodesPostalCodesListParams) => Promise<BaseResponse<GeoCodesPostalCodesListData>>;
1318
+ /**
1319
+ * Get Postal Code Details
1320
+ * Call: api.agrSite.geoCodesPostalCodes.get(geoCodesPostalCodesUid)
1321
+ *
1322
+ * Errors:
1323
+ * 404: No postal code geo record with this ID.
1324
+ *
1325
+ * GET https://agr-site.augur-api.com/geo-codes-postal-codes/{geoCodesPostalCodesUid}
1326
+ * Contract:
1327
+ * https://agr-site.augur-api.com/openapi.json#/paths/~1geo-codes-postal-codes~1{geoCodesPostalCodesUid}/get
1328
+ *
1329
+ * @param geoCodesPostalCodesUid Postal Code UID
1330
+ * @param params GeoCodesPostalCodesGetParams (query string)
1331
+ * @returns BaseResponse whose `data` is GeoCodesPostalCodesGetData
1332
+ */
1333
+ get: (geoCodesPostalCodesUid: number, params?: GeoCodesPostalCodesGetParams) => Promise<BaseResponse<GeoCodesPostalCodesGetData>>;
1334
+ };
1335
+ linkedSites: {
1336
+ /**
1337
+ * Sites the caller can switch to
1338
+ * Call: api.agrSite.linkedSites.list()
1339
+ *
1340
+ * List the other sites the signed-in user can switch to
1341
+ *
1342
+ * Response data, each item: Another site the signed-in user can switch to
1343
+ *
1344
+ * Errors:
1345
+ * 403: The signed-in user cannot switch sites.
1346
+ * 503: A dependency did not respond. Retryable.
1347
+ *
1348
+ * GET https://agr-site.augur-api.com/linked-sites
1349
+ * Contract: https://agr-site.augur-api.com/openapi.json#/paths/~1linked-sites/get
1350
+ *
1351
+ * @param params LinkedSitesListParams (query string)
1352
+ * @returns BaseResponse whose `data` is LinkedSitesListData
1353
+ */
1354
+ list: (params?: LinkedSitesListParams) => Promise<BaseResponse<LinkedSitesListData>>;
1355
+ token: {
1356
+ /**
1357
+ * Token for a linked site
1358
+ * Call: api.agrSite.linkedSites.token.create(data)
1359
+ *
1360
+ * Exchange the signed-in user's token for a user token on another site they can switch to
1361
+ *
1362
+ * Request body: Exchange a user token on this site for a token on a linked site
1363
+ * Response data: A user token on another site the signed-in user can switch to
1364
+ *
1365
+ * Errors:
1366
+ * 400: The body is not JSON or has no siteId.
1367
+ * 403: The signed-in user cannot switch to the requested site. No token is issued.
1368
+ * 404: The target siteId is not a known site.
1369
+ * 503: A dependency did not respond. Retryable.
1370
+ *
1371
+ * POST https://agr-site.augur-api.com/linked-sites/token
1372
+ * Contract: https://agr-site.augur-api.com/openapi.json#/paths/~1linked-sites~1token/post
1373
+ *
1374
+ * @param data LinkedSitesTokenCreateBody (request body)
1375
+ * @returns BaseResponse whose `data` is LinkedSitesTokenCreateData
1376
+ */
1377
+ create: (data: LinkedSitesTokenCreateBody) => Promise<BaseResponse<LinkedSitesTokenCreateData>>;
1378
+ };
1379
+ };
1380
+ metaFiles: {
1381
+ robots: {
1382
+ /**
1383
+ * Get Robots.txt
1384
+ * Call: api.agrSite.metaFiles.robots.list()
1385
+ *
1386
+ * Get robots.txt
1387
+ *
1388
+ * Response data: The site's generated robots.txt
1389
+ *
1390
+ * GET https://agr-site.augur-api.com/meta-files/robots
1391
+ * Contract: https://agr-site.augur-api.com/openapi.json#/paths/~1meta-files~1robots/get
1392
+ *
1393
+ * @param params MetaFilesRobotsListParams (query string)
1394
+ * @returns BaseResponse whose `data` is MetaFilesRobotsListData
1395
+ */
1396
+ list: (params?: MetaFilesRobotsListParams) => Promise<BaseResponse<MetaFilesRobotsListData>>;
1397
+ };
1398
+ };
1399
+ notifications: {
1400
+ /**
1401
+ * List Notifications
1402
+ * Call: api.agrSite.notifications.list(params)
1403
+ *
1404
+ * List notifications, filtered by the record they are about and their send state
1405
+ *
1406
+ * Errors:
1407
+ * 400: Invalid orderBy: not one notifications column with |ASC or |DESC.
1408
+ *
1409
+ * GET https://agr-site.augur-api.com/notifications
1410
+ * Contract: https://agr-site.augur-api.com/openapi.json#/paths/~1notifications/get
1411
+ *
1412
+ * @param params NotificationsListParams (query string)
1413
+ * @returns BaseResponse whose `data` is NotificationsListData
1414
+ */
1415
+ list: (params?: NotificationsListParams) => Promise<BaseResponse<NotificationsListData>>;
1416
+ /**
1417
+ * Create Notification
1418
+ * Call: api.agrSite.notifications.create(data)
1419
+ *
1420
+ * Request body: Record a notification, or return the existing one with the same key
1421
+ *
1422
+ * Errors:
1423
+ * 400: The body is missing or not valid JSON.
1424
+ *
1425
+ * POST https://agr-site.augur-api.com/notifications
1426
+ * Contract: https://agr-site.augur-api.com/openapi.json#/paths/~1notifications/post
1427
+ *
1428
+ * @param data NotificationsCreateBody (request body)
1429
+ * @returns BaseResponse whose `data` is NotificationsCreateData
1430
+ */
1431
+ create: (data: NotificationsCreateBody) => Promise<BaseResponse<NotificationsCreateData>>;
1432
+ /**
1433
+ * Get Notification
1434
+ * Call: api.agrSite.notifications.get(notificationsUid)
1435
+ *
1436
+ * Get one notification with its send state (process_cd) and dates
1437
+ *
1438
+ * Errors:
1439
+ * 404: No notification with this ID.
1440
+ *
1441
+ * GET https://agr-site.augur-api.com/notifications/{notificationsUid}
1442
+ * Contract:
1443
+ * https://agr-site.augur-api.com/openapi.json#/paths/~1notifications~1{notificationsUid}/get
1444
+ *
1445
+ * @param notificationsUid notifications.notifications_uid
1446
+ * @param params NotificationsGetParams (query string)
1447
+ * @returns BaseResponse whose `data` is NotificationsGetData
1448
+ */
1449
+ get: (notificationsUid: number, params?: NotificationsGetParams) => Promise<BaseResponse<NotificationsGetData>>;
1450
+ };
1451
+ openSearch: {
1452
+ embedding: {
1453
+ /**
1454
+ * Get Query String Embedding
1455
+ * Call: api.agrSite.openSearch.embedding.list(params)
1456
+ *
1457
+ * Response data: The embedding vector for a search query string, stored for reuse
1458
+ *
1459
+ * GET https://agr-site.augur-api.com/open-search/embedding
1460
+ * Contract: https://agr-site.augur-api.com/openapi.json#/paths/~1open-search~1embedding/get
1461
+ *
1462
+ * @param params OpenSearchEmbeddingListParams (query string)
1463
+ * @returns BaseResponse whose `data` is OpenSearchEmbeddingListData
1464
+ */
1465
+ list: (params?: OpenSearchEmbeddingListParams) => Promise<BaseResponse<OpenSearchEmbeddingListData>>;
1466
+ };
1467
+ };
1468
+ postalCodesXShiptos: {
1469
+ /**
1470
+ * List Postal Codes X Ship Tos
1471
+ * Call: api.agrSite.postalCodesXShiptos.list(params)
1472
+ *
1473
+ * Errors:
1474
+ * 400: orderBy is not column|ASC or column|DESC on a postal_codes_x_shiptos column.
1475
+ *
1476
+ * GET https://agr-site.augur-api.com/postal-codes-x-shiptos
1477
+ * Contract: https://agr-site.augur-api.com/openapi.json#/paths/~1postal-codes-x-shiptos/get
1478
+ *
1479
+ * @param params PostalCodesXShiptosListParams (query string)
1480
+ * @returns BaseResponse whose `data` is PostalCodesXShiptosListData
1481
+ */
1482
+ list: (params?: PostalCodesXShiptosListParams) => Promise<BaseResponse<PostalCodesXShiptosListData>>;
1483
+ /**
1484
+ * Create Postal Code X Ship To
1485
+ * Call: api.agrSite.postalCodesXShiptos.create(data)
1486
+ *
1487
+ * Request body: Link a postal code to a Prophet 21 ship-to
1488
+ *
1489
+ * Success status: 201 (not 200)
1490
+ *
1491
+ * Errors:
1492
+ * 400: The body is missing or not a JSON object.
1493
+ *
1494
+ * POST https://agr-site.augur-api.com/postal-codes-x-shiptos
1495
+ * Contract: https://agr-site.augur-api.com/openapi.json#/paths/~1postal-codes-x-shiptos/post
1496
+ *
1497
+ * @param data PostalCodesXShiptosCreateBody (request body)
1498
+ * @returns BaseResponse whose `data` is PostalCodesXShiptosCreateData
1499
+ */
1500
+ create: (data: PostalCodesXShiptosCreateBody) => Promise<BaseResponse<PostalCodesXShiptosCreateData>>;
1501
+ /**
1502
+ * Get Postal Code X Ship To Details
1503
+ * Call: api.agrSite.postalCodesXShiptos.get(postalCodesXShiptosUid)
1504
+ *
1505
+ * Errors:
1506
+ * 404: No postal code ship-to link with this ID.
1507
+ *
1508
+ * GET https://agr-site.augur-api.com/postal-codes-x-shiptos/{postalCodesXShiptosUid}
1509
+ * Contract:
1510
+ * https://agr-site.augur-api.com/openapi.json#/paths/~1postal-codes-x-shiptos~1{postalCodesXShiptosUid}/get
1511
+ *
1512
+ * @param postalCodesXShiptosUid Postal code to ship-to link ID
1513
+ * @param params PostalCodesXShiptosGetParams (query string)
1514
+ * @returns BaseResponse whose `data` is PostalCodesXShiptosGetData
1515
+ */
1516
+ get: (postalCodesXShiptosUid: number, params?: PostalCodesXShiptosGetParams) => Promise<BaseResponse<PostalCodesXShiptosGetData>>;
1517
+ /**
1518
+ * Update Postal Code X Ship To
1519
+ * Call: api.agrSite.postalCodesXShiptos.update(postalCodesXShiptosUid, data)
1520
+ *
1521
+ * Request body: Partial update of a postal code to ship-to link; an absent or empty field keeps
1522
+ * its current value
1523
+ *
1524
+ * Errors:
1525
+ * 400: The body is missing or not a JSON object.
1526
+ * 404: No postal code ship-to link with this ID.
1527
+ *
1528
+ * PUT https://agr-site.augur-api.com/postal-codes-x-shiptos/{postalCodesXShiptosUid}
1529
+ * Contract:
1530
+ * https://agr-site.augur-api.com/openapi.json#/paths/~1postal-codes-x-shiptos~1{postalCodesXShiptosUid}/put
1531
+ *
1532
+ * @param postalCodesXShiptosUid Postal code to ship-to link ID
1533
+ * @param data PostalCodesXShiptosUpdateBody (request body)
1534
+ * @returns BaseResponse whose `data` is PostalCodesXShiptosUpdateData
1535
+ */
1536
+ update: (postalCodesXShiptosUid: number, data: PostalCodesXShiptosUpdateBody) => Promise<BaseResponse<PostalCodesXShiptosUpdateData>>;
1537
+ /**
1538
+ * Soft Delete Postal Code X Ship To
1539
+ * Call: api.agrSite.postalCodesXShiptos.delete(postalCodesXShiptosUid)
1540
+ *
1541
+ * Errors:
1542
+ * 404: No postal code ship-to link with this ID.
1543
+ *
1544
+ * DELETE https://agr-site.augur-api.com/postal-codes-x-shiptos/{postalCodesXShiptosUid}
1545
+ * Contract:
1546
+ * https://agr-site.augur-api.com/openapi.json#/paths/~1postal-codes-x-shiptos~1{postalCodesXShiptosUid}/delete
1547
+ *
1548
+ * @param postalCodesXShiptosUid Postal code to ship-to link ID
1549
+ * @returns BaseResponse whose `data` is PostalCodesXShiptosDeleteData
1550
+ */
1551
+ delete: (postalCodesXShiptosUid: number) => Promise<BaseResponse<PostalCodesXShiptosDeleteData>>;
1552
+ };
1553
+ settings: {
1554
+ /**
1555
+ * List Settings
1556
+ * Call: api.agrSite.settings.list(params)
1557
+ *
1558
+ * Errors:
1559
+ * 400: orderBy is not column|ASC or column|DESC on a settings column.
1560
+ *
1561
+ * GET https://agr-site.augur-api.com/settings
1562
+ * Contract: https://agr-site.augur-api.com/openapi.json#/paths/~1settings/get
1563
+ *
1564
+ * @param params SettingsListParams (query string)
1565
+ * @returns BaseResponse whose `data` is SettingsListData
1566
+ */
1567
+ list: (params?: SettingsListParams) => Promise<BaseResponse<SettingsListData>>;
1568
+ /**
1569
+ * Create Settings
1570
+ * Call: api.agrSite.settings.create(data)
1571
+ *
1572
+ * Request body: Create a setting, or return the existing one with the same service and name
1573
+ *
1574
+ * Errors:
1575
+ * 400: The body is missing or not a JSON object.
1576
+ *
1577
+ * POST https://agr-site.augur-api.com/settings
1578
+ * Contract: https://agr-site.augur-api.com/openapi.json#/paths/~1settings/post
1579
+ *
1580
+ * @param data SettingsCreateBody (request body)
1581
+ * @returns BaseResponse whose `data` is SettingsCreateData
1582
+ */
1583
+ create: (data: SettingsCreateBody) => Promise<BaseResponse<SettingsCreateData>>;
1584
+ /**
1585
+ * Get Settings Details
1586
+ * Call: api.agrSite.settings.get(settingsUid)
1587
+ *
1588
+ * Errors:
1589
+ * 404: No setting with this ID.
1590
+ *
1591
+ * GET https://agr-site.augur-api.com/settings/{settingsUid}
1592
+ * Contract: https://agr-site.augur-api.com/openapi.json#/paths/~1settings~1{settingsUid}/get
1593
+ *
1594
+ * @param settingsUid Setting ID
1595
+ * @param params SettingsGetParams (query string)
1596
+ * @returns BaseResponse whose `data` is SettingsGetData
1597
+ */
1598
+ get: (settingsUid: number, params?: SettingsGetParams) => Promise<BaseResponse<SettingsGetData>>;
1599
+ /**
1600
+ * Update Settings
1601
+ * Call: api.agrSite.settings.update(settingsUid, data)
1602
+ *
1603
+ * Request body: Partial update of a setting; an absent field keeps its current value
1604
+ *
1605
+ * Errors:
1606
+ * 400: The body is missing or not a JSON object.
1607
+ * 404: No setting with this ID.
1608
+ *
1609
+ * PUT https://agr-site.augur-api.com/settings/{settingsUid}
1610
+ * Contract: https://agr-site.augur-api.com/openapi.json#/paths/~1settings~1{settingsUid}/put
1611
+ *
1612
+ * @param settingsUid Setting ID
1613
+ * @param data SettingsUpdateBody (request body)
1614
+ * @returns BaseResponse whose `data` is SettingsUpdateData
1615
+ */
1616
+ update: (settingsUid: number, data: SettingsUpdateBody) => Promise<BaseResponse<SettingsUpdateData>>;
1617
+ /**
1618
+ * DELETE Settings
1619
+ * Call: api.agrSite.settings.delete(settingsUid)
1620
+ *
1621
+ * Errors:
1622
+ * 404: No setting with this ID.
1623
+ *
1624
+ * DELETE https://agr-site.augur-api.com/settings/{settingsUid}
1625
+ * Contract: https://agr-site.augur-api.com/openapi.json#/paths/~1settings~1{settingsUid}/delete
1626
+ *
1627
+ * @param settingsUid Setting ID
1628
+ * @returns BaseResponse whose `data` is SettingsDeleteData
1629
+ */
1630
+ delete: (settingsUid: number) => Promise<BaseResponse<SettingsDeleteData>>;
1631
+ };
1632
+ users: {
1633
+ addresses: {
1634
+ /**
1635
+ * List user addresses
1636
+ * Call: api.agrSite.users.addresses.list(userId, params)
1637
+ *
1638
+ * List a user's saved addresses
1639
+ *
1640
+ * Errors:
1641
+ * 400: orderBy is not column|ASC or column|DESC on a user_address column.
1642
+ * 404: No Joomla user with this userId.
1643
+ *
1644
+ * GET https://agr-site.augur-api.com/users/{userId}/addresses
1645
+ * Contract:
1646
+ * https://agr-site.augur-api.com/openapi.json#/paths/~1users~1{userId}~1addresses/get
1647
+ *
1648
+ * @param userId Joomla user the addresses belong to
1649
+ * @param params UsersAddressesListParams (query string)
1650
+ * @returns BaseResponse whose `data` is UsersAddressesListData
1651
+ */
1652
+ list: (userId: number, params?: UsersAddressesListParams) => Promise<BaseResponse<UsersAddressesListData>>;
1653
+ /**
1654
+ * Create a new user_address row
1655
+ * Call: api.agrSite.users.addresses.create(userId, data)
1656
+ *
1657
+ * Request body: Add an address for the user in the path
1658
+ *
1659
+ * Errors:
1660
+ * 400: userId is 0 or negative.
1661
+ * 404: No Joomla user with this userId.
1662
+ *
1663
+ * POST https://agr-site.augur-api.com/users/{userId}/addresses
1664
+ * Contract:
1665
+ * https://agr-site.augur-api.com/openapi.json#/paths/~1users~1{userId}~1addresses/post
1666
+ *
1667
+ * @param userId Joomla user the addresses belong to
1668
+ * @param data UsersAddressesCreateBody (request body)
1669
+ * @returns BaseResponse whose `data` is UsersAddressesCreateData
1670
+ */
1671
+ create: (userId: number, data: UsersAddressesCreateBody) => Promise<BaseResponse<UsersAddressesCreateData>>;
1672
+ /**
1673
+ * Get a user_address
1674
+ * Call: api.agrSite.users.addresses.get(userId, userAddressUid)
1675
+ *
1676
+ * Get a user_address row by UID
1677
+ *
1678
+ * Errors:
1679
+ * 400: userId or userAddressUid is 0 or negative.
1680
+ * 404: No user address with this ID.
1681
+ *
1682
+ * GET https://agr-site.augur-api.com/users/{userId}/addresses/{userAddressUid}
1683
+ * Contract:
1684
+ * https://agr-site.augur-api.com/openapi.json#/paths/~1users~1{userId}~1addresses~1{userAddressUid}/get
1685
+ *
1686
+ * @param userId Joomla user the addresses belong to
1687
+ * @param userAddressUid User address ID
1688
+ * @param params UsersAddressesGetParams (query string)
1689
+ * @returns BaseResponse whose `data` is UsersAddressesGetData
1690
+ */
1691
+ get: (userId: number, userAddressUid: number, params?: UsersAddressesGetParams) => Promise<BaseResponse<UsersAddressesGetData>>;
1692
+ /**
1693
+ * Update a user_address row
1694
+ * Call: api.agrSite.users.addresses.update(userId, userAddressUid, data)
1695
+ *
1696
+ * Request body: Partial update of a user address; an absent field keeps its current value
1697
+ *
1698
+ * Errors:
1699
+ * 400: userId or userAddressUid is 0 or negative.
1700
+ * 404: No user address with this ID.
1701
+ *
1702
+ * PUT https://agr-site.augur-api.com/users/{userId}/addresses/{userAddressUid}
1703
+ * Contract:
1704
+ * https://agr-site.augur-api.com/openapi.json#/paths/~1users~1{userId}~1addresses~1{userAddressUid}/put
1705
+ *
1706
+ * @param userId Joomla user the addresses belong to
1707
+ * @param userAddressUid User address ID
1708
+ * @param data UsersAddressesUpdateBody (request body)
1709
+ * @returns BaseResponse whose `data` is UsersAddressesUpdateData
1710
+ */
1711
+ update: (userId: number, userAddressUid: number, data: UsersAddressesUpdateBody) => Promise<BaseResponse<UsersAddressesUpdateData>>;
1712
+ /**
1713
+ * Soft-delete a user_address row
1714
+ * Call: api.agrSite.users.addresses.delete(userId, userAddressUid)
1715
+ *
1716
+ * Errors:
1717
+ * 400: userId or userAddressUid is 0 or negative.
1718
+ * 404: No user address with this ID.
1719
+ *
1720
+ * DELETE https://agr-site.augur-api.com/users/{userId}/addresses/{userAddressUid}
1721
+ * Contract:
1722
+ * https://agr-site.augur-api.com/openapi.json#/paths/~1users~1{userId}~1addresses~1{userAddressUid}/delete
1723
+ *
1724
+ * @param userId Joomla user the addresses belong to
1725
+ * @param userAddressUid User address ID
1726
+ * @returns BaseResponse whose `data` is UsersAddressesDeleteData
1727
+ */
1728
+ delete: (userId: number, userAddressUid: number) => Promise<BaseResponse<UsersAddressesDeleteData>>;
1729
+ };
1730
+ };
1731
+ }
1732
+ //# sourceMappingURL=types.d.ts.map