@simpleapps-com/augur-api 2026.10.30 → 2026.11.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +84 -33
- package/SKILL.md +25 -24
- package/dist/client.d.ts +334 -0
- package/dist/client.d.ts.map +1 -0
- package/dist/core/base-client.d.ts +179 -0
- package/dist/core/base-client.d.ts.map +1 -0
- package/dist/core/call-rules.d.ts +73 -0
- package/dist/core/call-rules.d.ts.map +1 -0
- package/dist/core/call.d.ts +48 -0
- package/dist/core/call.d.ts.map +1 -0
- package/dist/core/client.d.ts +112 -0
- package/dist/core/client.d.ts.map +1 -0
- package/dist/core/common-schemas.d.ts +522 -0
- package/dist/core/common-schemas.d.ts.map +1 -0
- package/dist/core/config.d.ts +72 -0
- package/dist/core/config.d.ts.map +1 -0
- package/dist/core/encoded-segment.d.ts +23 -0
- package/dist/core/encoded-segment.d.ts.map +1 -0
- package/dist/core/errors.d.ts +91 -0
- package/dist/core/errors.d.ts.map +1 -0
- package/dist/core/http-rules.d.ts +64 -0
- package/dist/core/http-rules.d.ts.map +1 -0
- package/dist/core/path-validation.d.ts +28 -0
- package/dist/core/path-validation.d.ts.map +1 -0
- package/dist/core/proxy-rules.d.ts +21 -0
- package/dist/core/proxy-rules.d.ts.map +1 -0
- package/dist/core/registry-rules.d.ts +15 -0
- package/dist/core/registry-rules.d.ts.map +1 -0
- package/dist/core/registry-tables.d.ts +3 -0
- package/dist/core/registry-tables.d.ts.map +1 -0
- package/dist/core/registry.d.ts +54 -0
- package/dist/core/registry.d.ts.map +1 -0
- package/dist/core/response-rules.d.ts +19 -0
- package/dist/core/response-rules.d.ts.map +1 -0
- package/dist/core/schemas.d.ts +70 -0
- package/dist/core/schemas.d.ts.map +1 -0
- package/dist/core/service-proxy.d.ts +81 -0
- package/dist/core/service-proxy.d.ts.map +1 -0
- package/dist/core/site-id-check.d.ts +6 -0
- package/dist/core/site-id-check.d.ts.map +1 -0
- package/dist/core/site-id.d.ts +15 -0
- package/dist/core/site-id.d.ts.map +1 -0
- package/dist/index.d.ts +71 -236
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +19860 -18427
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +19859 -18427
- package/dist/index.mjs.map +1 -1
- package/dist/services/agr-info/client.d.ts +71 -0
- package/dist/services/agr-info/client.d.ts.map +1 -0
- package/dist/services/agr-info/generated/endpoints.d.ts +41 -0
- package/dist/services/agr-info/generated/endpoints.d.ts.map +1 -0
- package/dist/services/agr-info/generated/schemas.d.ts +297 -0
- package/dist/services/agr-info/generated/schemas.d.ts.map +1 -0
- package/dist/services/agr-info/generated/types.d.ts +1093 -0
- package/dist/services/agr-info/generated/types.d.ts.map +1 -0
- package/dist/services/agr-info/index.d.ts +2 -0
- package/dist/services/agr-info/index.d.ts.map +1 -0
- package/dist/services/agr-int/client.d.ts +100 -0
- package/dist/services/agr-int/client.d.ts.map +1 -0
- package/dist/services/agr-int/generated/endpoints.d.ts +42 -0
- package/dist/services/agr-int/generated/endpoints.d.ts.map +1 -0
- package/dist/services/agr-int/generated/schemas.d.ts +595 -0
- package/dist/services/agr-int/generated/schemas.d.ts.map +1 -0
- package/dist/services/agr-int/generated/types.d.ts +1984 -0
- package/dist/services/agr-int/generated/types.d.ts.map +1 -0
- package/dist/services/agr-int/index.d.ts +2 -0
- package/dist/services/agr-int/index.d.ts.map +1 -0
- package/dist/services/agr-site/client.d.ts +112 -0
- package/dist/services/agr-site/client.d.ts.map +1 -0
- package/dist/services/agr-site/generated/endpoints.d.ts +42 -0
- package/dist/services/agr-site/generated/endpoints.d.ts.map +1 -0
- package/dist/services/agr-site/generated/schemas.d.ts +537 -0
- package/dist/services/agr-site/generated/schemas.d.ts.map +1 -0
- package/dist/services/agr-site/generated/types.d.ts +1732 -0
- package/dist/services/agr-site/generated/types.d.ts.map +1 -0
- package/dist/services/agr-site/index.d.ts +2 -0
- package/dist/services/agr-site/index.d.ts.map +1 -0
- package/dist/services/agr-work/client.d.ts +23 -0
- package/dist/services/agr-work/client.d.ts.map +1 -0
- package/dist/services/agr-work/generated/endpoints.d.ts +41 -0
- package/dist/services/agr-work/generated/endpoints.d.ts.map +1 -0
- package/dist/services/agr-work/generated/schemas.d.ts +21 -0
- package/dist/services/agr-work/generated/schemas.d.ts.map +1 -0
- package/dist/services/agr-work/generated/types.d.ts +19 -0
- package/dist/services/agr-work/generated/types.d.ts.map +1 -0
- package/dist/services/agr-work/index.d.ts +2 -0
- package/dist/services/agr-work/index.d.ts.map +1 -0
- package/dist/services/avalara/client.d.ts +33 -0
- package/dist/services/avalara/client.d.ts.map +1 -0
- package/dist/services/avalara/generated/endpoints.d.ts +41 -0
- package/dist/services/avalara/generated/endpoints.d.ts.map +1 -0
- package/dist/services/avalara/generated/schemas.d.ts +22 -0
- package/dist/services/avalara/generated/schemas.d.ts.map +1 -0
- package/dist/services/avalara/generated/types.d.ts +103 -0
- package/dist/services/avalara/generated/types.d.ts.map +1 -0
- package/dist/services/avalara/index.d.ts +2 -0
- package/dist/services/avalara/index.d.ts.map +1 -0
- package/dist/services/basecamp2/client.d.ts +92 -0
- package/dist/services/basecamp2/client.d.ts.map +1 -0
- package/dist/services/basecamp2/generated/endpoints.d.ts +42 -0
- package/dist/services/basecamp2/generated/endpoints.d.ts.map +1 -0
- package/dist/services/basecamp2/generated/schemas.d.ts +845 -0
- package/dist/services/basecamp2/generated/schemas.d.ts.map +1 -0
- package/dist/services/basecamp2/generated/types.d.ts +1587 -0
- package/dist/services/basecamp2/generated/types.d.ts.map +1 -0
- package/dist/services/basecamp2/index.d.ts +2 -0
- package/dist/services/basecamp2/index.d.ts.map +1 -0
- package/dist/services/brand-folder/client.d.ts +37 -0
- package/dist/services/brand-folder/client.d.ts.map +1 -0
- package/dist/services/brand-folder/generated/endpoints.d.ts +41 -0
- package/dist/services/brand-folder/generated/endpoints.d.ts.map +1 -0
- package/dist/services/brand-folder/generated/schemas.d.ts +81 -0
- package/dist/services/brand-folder/generated/schemas.d.ts.map +1 -0
- package/dist/services/brand-folder/generated/types.d.ts +195 -0
- package/dist/services/brand-folder/generated/types.d.ts.map +1 -0
- package/dist/services/brand-folder/index.d.ts +2 -0
- package/dist/services/brand-folder/index.d.ts.map +1 -0
- package/dist/services/commerce/client.d.ts +57 -0
- package/dist/services/commerce/client.d.ts.map +1 -0
- package/dist/services/commerce/generated/endpoints.d.ts +42 -0
- package/dist/services/commerce/generated/endpoints.d.ts.map +1 -0
- package/dist/services/commerce/generated/schemas.d.ts +319 -0
- package/dist/services/commerce/generated/schemas.d.ts.map +1 -0
- package/dist/services/commerce/generated/types.d.ts +1134 -0
- package/dist/services/commerce/generated/types.d.ts.map +1 -0
- package/dist/services/commerce/index.d.ts +2 -0
- package/dist/services/commerce/index.d.ts.map +1 -0
- package/dist/services/customers/client.d.ts +162 -0
- package/dist/services/customers/client.d.ts.map +1 -0
- package/dist/services/customers/generated/endpoints.d.ts +42 -0
- package/dist/services/customers/generated/endpoints.d.ts.map +1 -0
- package/dist/services/customers/generated/schemas.d.ts +1970 -0
- package/dist/services/customers/generated/schemas.d.ts.map +1 -0
- package/dist/services/customers/generated/types.d.ts +3849 -0
- package/dist/services/customers/generated/types.d.ts.map +1 -0
- package/dist/services/customers/index.d.ts +2 -0
- package/dist/services/customers/index.d.ts.map +1 -0
- package/dist/services/goog-mc/client.d.ts +44 -0
- package/dist/services/goog-mc/client.d.ts.map +1 -0
- package/dist/services/goog-mc/generated/endpoints.d.ts +42 -0
- package/dist/services/goog-mc/generated/endpoints.d.ts.map +1 -0
- package/dist/services/goog-mc/generated/schemas.d.ts +175 -0
- package/dist/services/goog-mc/generated/schemas.d.ts.map +1 -0
- package/dist/services/goog-mc/generated/types.d.ts +361 -0
- package/dist/services/goog-mc/generated/types.d.ts.map +1 -0
- package/dist/services/goog-mc/index.d.ts +2 -0
- package/dist/services/goog-mc/index.d.ts.map +1 -0
- package/dist/services/gregorovich/client.d.ts +34 -0
- package/dist/services/gregorovich/client.d.ts.map +1 -0
- package/dist/services/gregorovich/generated/endpoints.d.ts +42 -0
- package/dist/services/gregorovich/generated/endpoints.d.ts.map +1 -0
- package/dist/services/gregorovich/generated/schemas.d.ts +35 -0
- package/dist/services/gregorovich/generated/schemas.d.ts.map +1 -0
- package/dist/services/gregorovich/generated/types.d.ts +70 -0
- package/dist/services/gregorovich/generated/types.d.ts.map +1 -0
- package/dist/services/gregorovich/index.d.ts +2 -0
- package/dist/services/gregorovich/index.d.ts.map +1 -0
- package/dist/services/items/client.d.ts +453 -0
- package/dist/services/items/client.d.ts.map +1 -0
- package/dist/services/items/generated/endpoints.d.ts +42 -0
- package/dist/services/items/generated/endpoints.d.ts.map +1 -0
- package/dist/services/items/generated/schemas.d.ts +4636 -0
- package/dist/services/items/generated/schemas.d.ts.map +1 -0
- package/dist/services/items/generated/types.d.ts +10513 -0
- package/dist/services/items/generated/types.d.ts.map +1 -0
- package/dist/services/items/index.d.ts +2 -0
- package/dist/services/items/index.d.ts.map +1 -0
- package/dist/services/joomla/client.d.ts +74 -0
- package/dist/services/joomla/client.d.ts.map +1 -0
- package/dist/services/joomla/generated/endpoints.d.ts +41 -0
- package/dist/services/joomla/generated/endpoints.d.ts.map +1 -0
- package/dist/services/joomla/generated/schemas.d.ts +546 -0
- package/dist/services/joomla/generated/schemas.d.ts.map +1 -0
- package/dist/services/joomla/generated/types.d.ts +1489 -0
- package/dist/services/joomla/generated/types.d.ts.map +1 -0
- package/dist/services/joomla/index.d.ts +2 -0
- package/dist/services/joomla/index.d.ts.map +1 -0
- package/dist/services/legacy/client.d.ts +75 -0
- package/dist/services/legacy/client.d.ts.map +1 -0
- package/dist/services/legacy/generated/endpoints.d.ts +41 -0
- package/dist/services/legacy/generated/endpoints.d.ts.map +1 -0
- package/dist/services/legacy/generated/schemas.d.ts +567 -0
- package/dist/services/legacy/generated/schemas.d.ts.map +1 -0
- package/dist/services/legacy/generated/types.d.ts +1454 -0
- package/dist/services/legacy/generated/types.d.ts.map +1 -0
- package/dist/services/legacy/index.d.ts +2 -0
- package/dist/services/legacy/index.d.ts.map +1 -0
- package/dist/services/logistics/client.d.ts +64 -0
- package/dist/services/logistics/client.d.ts.map +1 -0
- package/dist/services/logistics/generated/endpoints.d.ts +41 -0
- package/dist/services/logistics/generated/endpoints.d.ts.map +1 -0
- package/dist/services/logistics/generated/schemas.d.ts +375 -0
- package/dist/services/logistics/generated/schemas.d.ts.map +1 -0
- package/dist/services/logistics/generated/types.d.ts +925 -0
- package/dist/services/logistics/generated/types.d.ts.map +1 -0
- package/dist/services/logistics/index.d.ts +2 -0
- package/dist/services/logistics/index.d.ts.map +1 -0
- package/dist/services/markets/client.d.ts +47 -0
- package/dist/services/markets/client.d.ts.map +1 -0
- package/dist/services/markets/generated/endpoints.d.ts +41 -0
- package/dist/services/markets/generated/endpoints.d.ts.map +1 -0
- package/dist/services/markets/generated/schemas.d.ts +180 -0
- package/dist/services/markets/generated/schemas.d.ts.map +1 -0
- package/dist/services/markets/generated/types.d.ts +405 -0
- package/dist/services/markets/generated/types.d.ts.map +1 -0
- package/dist/services/markets/index.d.ts +2 -0
- package/dist/services/markets/index.d.ts.map +1 -0
- package/dist/services/notifications/client.d.ts +58 -0
- package/dist/services/notifications/client.d.ts.map +1 -0
- package/dist/services/notifications/generated/endpoints.d.ts +41 -0
- package/dist/services/notifications/generated/endpoints.d.ts.map +1 -0
- package/dist/services/notifications/generated/schemas.d.ts +247 -0
- package/dist/services/notifications/generated/schemas.d.ts.map +1 -0
- package/dist/services/notifications/generated/types.d.ts +666 -0
- package/dist/services/notifications/generated/types.d.ts.map +1 -0
- package/dist/services/notifications/index.d.ts +2 -0
- package/dist/services/notifications/index.d.ts.map +1 -0
- package/dist/services/open-search/client.d.ts +69 -0
- package/dist/services/open-search/client.d.ts.map +1 -0
- package/dist/services/open-search/generated/endpoints.d.ts +42 -0
- package/dist/services/open-search/generated/endpoints.d.ts.map +1 -0
- package/dist/services/open-search/generated/schemas.d.ts +363 -0
- package/dist/services/open-search/generated/schemas.d.ts.map +1 -0
- package/dist/services/open-search/generated/types.d.ts +983 -0
- package/dist/services/open-search/generated/types.d.ts.map +1 -0
- package/dist/services/open-search/index.d.ts +2 -0
- package/dist/services/open-search/index.d.ts.map +1 -0
- package/dist/services/orders/client.d.ts +180 -0
- package/dist/services/orders/client.d.ts.map +1 -0
- package/dist/services/orders/generated/endpoints.d.ts +42 -0
- package/dist/services/orders/generated/endpoints.d.ts.map +1 -0
- package/dist/services/orders/generated/schemas.d.ts +2479 -0
- package/dist/services/orders/generated/schemas.d.ts.map +1 -0
- package/dist/services/orders/generated/types.d.ts +4717 -0
- package/dist/services/orders/generated/types.d.ts.map +1 -0
- package/dist/services/orders/index.d.ts +2 -0
- package/dist/services/orders/index.d.ts.map +1 -0
- package/dist/services/p21-apis/client.d.ts +59 -0
- package/dist/services/p21-apis/client.d.ts.map +1 -0
- package/dist/services/p21-apis/generated/endpoints.d.ts +41 -0
- package/dist/services/p21-apis/generated/endpoints.d.ts.map +1 -0
- package/dist/services/p21-apis/generated/schemas.d.ts +46 -0
- package/dist/services/p21-apis/generated/schemas.d.ts.map +1 -0
- package/dist/services/p21-apis/generated/types.d.ts +246 -0
- package/dist/services/p21-apis/generated/types.d.ts.map +1 -0
- package/dist/services/p21-apis/index.d.ts +2 -0
- package/dist/services/p21-apis/index.d.ts.map +1 -0
- package/dist/services/p21-core/client.d.ts +131 -0
- package/dist/services/p21-core/client.d.ts.map +1 -0
- package/dist/services/p21-core/generated/endpoints.d.ts +42 -0
- package/dist/services/p21-core/generated/endpoints.d.ts.map +1 -0
- package/dist/services/p21-core/generated/schemas.d.ts +1478 -0
- package/dist/services/p21-core/generated/schemas.d.ts.map +1 -0
- package/dist/services/p21-core/generated/types.d.ts +2718 -0
- package/dist/services/p21-core/generated/types.d.ts.map +1 -0
- package/dist/services/p21-core/index.d.ts +2 -0
- package/dist/services/p21-core/index.d.ts.map +1 -0
- package/dist/services/p21-pim/client.d.ts +75 -0
- package/dist/services/p21-pim/client.d.ts.map +1 -0
- package/dist/services/p21-pim/generated/endpoints.d.ts +41 -0
- package/dist/services/p21-pim/generated/endpoints.d.ts.map +1 -0
- package/dist/services/p21-pim/generated/schemas.d.ts +383 -0
- package/dist/services/p21-pim/generated/schemas.d.ts.map +1 -0
- package/dist/services/p21-pim/generated/types.d.ts +933 -0
- package/dist/services/p21-pim/generated/types.d.ts.map +1 -0
- package/dist/services/p21-pim/index.d.ts +2 -0
- package/dist/services/p21-pim/index.d.ts.map +1 -0
- package/dist/services/p21-sism/client.d.ts +432 -0
- package/dist/services/p21-sism/client.d.ts.map +1 -0
- package/dist/services/p21-sism/generated/endpoints.d.ts +42 -0
- package/dist/services/p21-sism/generated/endpoints.d.ts.map +1 -0
- package/dist/services/p21-sism/generated/schemas.d.ts +2844 -0
- package/dist/services/p21-sism/generated/schemas.d.ts.map +1 -0
- package/dist/services/p21-sism/generated/types.d.ts +6977 -0
- package/dist/services/p21-sism/generated/types.d.ts.map +1 -0
- package/dist/services/p21-sism/index.d.ts +37 -0
- package/dist/services/p21-sism/index.d.ts.map +1 -0
- package/dist/services/payments/client.d.ts +77 -0
- package/dist/services/payments/client.d.ts.map +1 -0
- package/dist/services/payments/generated/endpoints.d.ts +42 -0
- package/dist/services/payments/generated/endpoints.d.ts.map +1 -0
- package/dist/services/payments/generated/schemas.d.ts +1015 -0
- package/dist/services/payments/generated/schemas.d.ts.map +1 -0
- package/dist/services/payments/generated/types.d.ts +1432 -0
- package/dist/services/payments/generated/types.d.ts.map +1 -0
- package/dist/services/payments/index.d.ts +2 -0
- package/dist/services/payments/index.d.ts.map +1 -0
- package/dist/services/pricing/client.d.ts +216 -0
- package/dist/services/pricing/client.d.ts.map +1 -0
- package/dist/services/pricing/generated/endpoints.d.ts +42 -0
- package/dist/services/pricing/generated/endpoints.d.ts.map +1 -0
- package/dist/services/pricing/generated/schemas.d.ts +2048 -0
- package/dist/services/pricing/generated/schemas.d.ts.map +1 -0
- package/dist/services/pricing/generated/types.d.ts +4257 -0
- package/dist/services/pricing/generated/types.d.ts.map +1 -0
- package/dist/services/pricing/index.d.ts +2 -0
- package/dist/services/pricing/index.d.ts.map +1 -0
- package/dist/services/shipping/client.d.ts +33 -0
- package/dist/services/shipping/client.d.ts.map +1 -0
- package/dist/services/shipping/generated/endpoints.d.ts +41 -0
- package/dist/services/shipping/generated/endpoints.d.ts.map +1 -0
- package/dist/services/shipping/generated/schemas.d.ts +29 -0
- package/dist/services/shipping/generated/schemas.d.ts.map +1 -0
- package/dist/services/shipping/generated/types.d.ts +116 -0
- package/dist/services/shipping/generated/types.d.ts.map +1 -0
- package/dist/services/shipping/index.d.ts +2 -0
- package/dist/services/shipping/index.d.ts.map +1 -0
- package/dist/services/smarty-streets/client.d.ts +33 -0
- package/dist/services/smarty-streets/client.d.ts.map +1 -0
- package/dist/services/smarty-streets/generated/endpoints.d.ts +41 -0
- package/dist/services/smarty-streets/generated/endpoints.d.ts.map +1 -0
- package/dist/services/smarty-streets/generated/schemas.d.ts +72 -0
- package/dist/services/smarty-streets/generated/schemas.d.ts.map +1 -0
- package/dist/services/smarty-streets/generated/types.d.ts +145 -0
- package/dist/services/smarty-streets/generated/types.d.ts.map +1 -0
- package/dist/services/smarty-streets/index.d.ts +2 -0
- package/dist/services/smarty-streets/index.d.ts.map +1 -0
- package/dist/services/ups/client.d.ts +32 -0
- package/dist/services/ups/client.d.ts.map +1 -0
- package/dist/services/ups/generated/endpoints.d.ts +40 -0
- package/dist/services/ups/generated/endpoints.d.ts.map +1 -0
- package/dist/services/ups/generated/schemas.d.ts +51 -0
- package/dist/services/ups/generated/schemas.d.ts.map +1 -0
- package/dist/services/ups/generated/types.d.ts +98 -0
- package/dist/services/ups/generated/types.d.ts.map +1 -0
- package/dist/services/ups/index.d.ts +2 -0
- package/dist/services/ups/index.d.ts.map +1 -0
- package/dist/services/vendors/client.d.ts +38 -0
- package/dist/services/vendors/client.d.ts.map +1 -0
- package/dist/services/vendors/generated/endpoints.d.ts +41 -0
- package/dist/services/vendors/generated/endpoints.d.ts.map +1 -0
- package/dist/services/vendors/generated/schemas.d.ts +350 -0
- package/dist/services/vendors/generated/schemas.d.ts.map +1 -0
- package/dist/services/vendors/generated/types.d.ts +470 -0
- package/dist/services/vendors/generated/types.d.ts.map +1 -0
- package/dist/services/vendors/index.d.ts +2 -0
- package/dist/services/vendors/index.d.ts.map +1 -0
- package/dist/services/vmi/client.d.ts +129 -0
- package/dist/services/vmi/client.d.ts.map +1 -0
- package/dist/services/vmi/generated/endpoints.d.ts +41 -0
- package/dist/services/vmi/generated/endpoints.d.ts.map +1 -0
- package/dist/services/vmi/generated/schemas.d.ts +723 -0
- package/dist/services/vmi/generated/schemas.d.ts.map +1 -0
- package/dist/services/vmi/generated/types.d.ts +2620 -0
- package/dist/services/vmi/generated/types.d.ts.map +1 -0
- package/dist/services/vmi/index.d.ts +2 -0
- package/dist/services/vmi/index.d.ts.map +1 -0
- package/dist/testing.d.ts +9 -13
- package/dist/testing.d.ts.map +1 -0
- package/dist/testing.js +7 -17
- package/dist/testing.js.map +1 -1
- package/dist/testing.mjs +7 -17
- package/dist/testing.mjs.map +1 -1
- package/dist/utils/cross-site-auth.d.ts +88 -0
- package/dist/utils/cross-site-auth.d.ts.map +1 -0
- package/package.json +34 -47
- package/dist/client-DRpPuvl5.d.mts +0 -58476
- package/dist/client-DRpPuvl5.d.ts +0 -58476
- package/dist/index.d.mts +0 -236
- package/dist/testing.d.mts +0 -83
|
@@ -0,0 +1,1093 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated types for the agr-info service.
|
|
3
|
+
* Knowledge management and contextual information aggregation from Basecamp, Joomla, and AI sources
|
|
4
|
+
*
|
|
5
|
+
* Public specs (the source of truth for every shape below):
|
|
6
|
+
* https://agr-info.augur-api.com/endpoints.jsonl: one JSON line per endpoint: method, path, path
|
|
7
|
+
* params and query params, each with type and required flag. Grep it for a path; for a GET
|
|
8
|
+
* that line is all you need. Bodies are not in it.
|
|
9
|
+
* https://agr-info.augur-api.com/openapi.json: the full contract: request and response bodies
|
|
10
|
+
* field by field, descriptions, formats and documented errors.
|
|
11
|
+
* https://agr-info.augur-api.com/llms.txt: the plain-text endpoint list and the other Augur
|
|
12
|
+
* services.
|
|
13
|
+
*
|
|
14
|
+
* Source: shared/specs/agr-info.json
|
|
15
|
+
*
|
|
16
|
+
* DO NOT EDIT — regenerate with: pnpm -C tools/augur-api-generator generate ts
|
|
17
|
+
*/
|
|
18
|
+
import type { EdgeCacheParams } from "../../../core/common-schemas";
|
|
19
|
+
import type { BaseResponse } from "../../../core/schemas";
|
|
20
|
+
/** Params for GET /context/{siteId} */
|
|
21
|
+
export type ContextGetParams = EdgeCacheParams;
|
|
22
|
+
/** Params for GET /microservices */
|
|
23
|
+
export interface MicroservicesListParams extends EdgeCacheParams {
|
|
24
|
+
/** Limit number of results (Default: 10) */
|
|
25
|
+
limit?: number;
|
|
26
|
+
/** Starting offset results (Default: 0) */
|
|
27
|
+
offset?: number;
|
|
28
|
+
/** Order By (Default: microservices_uid|ASC) */
|
|
29
|
+
orderBy?: string;
|
|
30
|
+
/**
|
|
31
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
32
|
+
* (704,705); -1 for every status. Default: every status
|
|
33
|
+
*/
|
|
34
|
+
statusCd?: number | number[];
|
|
35
|
+
}
|
|
36
|
+
/** Params for GET /microservices/{microservicesUid} */
|
|
37
|
+
export type MicroservicesGetParams = EdgeCacheParams;
|
|
38
|
+
/** Params for GET /rubrics */
|
|
39
|
+
export interface RubricsListParams extends EdgeCacheParams {
|
|
40
|
+
/** Filter to the rubric with this id (slug) */
|
|
41
|
+
id?: string;
|
|
42
|
+
/** Limit number of results (Default: 10) */
|
|
43
|
+
limit?: number;
|
|
44
|
+
/** Starting offset results (Default: 0) */
|
|
45
|
+
offset?: number;
|
|
46
|
+
/** Order By (Default: rubrics_uid|ASC) */
|
|
47
|
+
orderBy?: string;
|
|
48
|
+
/**
|
|
49
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
50
|
+
* (704,705); -1 for every status. Default: every status
|
|
51
|
+
*/
|
|
52
|
+
statusCd?: number | number[];
|
|
53
|
+
}
|
|
54
|
+
/** Params for GET /rubrics/{rubricsUid} */
|
|
55
|
+
export type RubricsGetParams = EdgeCacheParams;
|
|
56
|
+
/** Params for GET /sites */
|
|
57
|
+
export interface SitesListParams extends EdgeCacheParams {
|
|
58
|
+
/**
|
|
59
|
+
* Active code mirrored from sites_table.active (704=active, 705=inactive), sent comma-joined
|
|
60
|
+
* (704,705); -1 for every site. Default: 704
|
|
61
|
+
*/
|
|
62
|
+
legacyActiveCd?: number | number[];
|
|
63
|
+
/** Limit number of results (Default: 10) */
|
|
64
|
+
limit?: number;
|
|
65
|
+
/** Starting offset results (Default: 0) */
|
|
66
|
+
offset?: number;
|
|
67
|
+
/** Order By (Default: sites_uid|ASC) */
|
|
68
|
+
orderBy?: string;
|
|
69
|
+
/**
|
|
70
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
71
|
+
* (704,705); -1 for every status. Default: 704
|
|
72
|
+
*/
|
|
73
|
+
statusCd?: number | number[];
|
|
74
|
+
}
|
|
75
|
+
/** Params for GET /workflows */
|
|
76
|
+
export interface WorkflowsListParams extends EdgeCacheParams {
|
|
77
|
+
/** Limit number of results (Default: 10) */
|
|
78
|
+
limit?: number;
|
|
79
|
+
/** Starting offset results (Default: 0) */
|
|
80
|
+
offset?: number;
|
|
81
|
+
/** Order By (Default: workflows_uid|ASC) */
|
|
82
|
+
orderBy?: string;
|
|
83
|
+
/** Text to match in the workflow title */
|
|
84
|
+
q?: string;
|
|
85
|
+
/**
|
|
86
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
87
|
+
* (704,705); -1 for every status. Default: 704
|
|
88
|
+
*/
|
|
89
|
+
statusCd?: number | number[];
|
|
90
|
+
}
|
|
91
|
+
/** Params for GET /workflows/{workflowsUid} */
|
|
92
|
+
export type WorkflowsGetParams = EdgeCacheParams;
|
|
93
|
+
/**
|
|
94
|
+
* Generate Response from akasha
|
|
95
|
+
* Response data for POST /akasha/generate — MINIMUM fields, extras pass through
|
|
96
|
+
*
|
|
97
|
+
* Returned by: api.agrInfo.akasha.generate.create(data)
|
|
98
|
+
*/
|
|
99
|
+
export type AkashaGenerateCreateData = string;
|
|
100
|
+
/**
|
|
101
|
+
* Generate Response from akasha
|
|
102
|
+
* Request body for POST /akasha/generate — MINIMUM fields, extras pass through
|
|
103
|
+
*
|
|
104
|
+
* Request body of: api.agrInfo.akasha.generate.create(data)
|
|
105
|
+
* Request body of: api.agrInfo.joomla.generate.create(data)
|
|
106
|
+
*/
|
|
107
|
+
export interface AkashaGenerateCreateBody {
|
|
108
|
+
/** The question; defaults to a usage question about the endpoint */
|
|
109
|
+
content?: string | null;
|
|
110
|
+
/** Embedding model used to find matching records; defaults to nomic-embed-text */
|
|
111
|
+
embedModel?: string | null;
|
|
112
|
+
/** Model that writes the answer; defaults to gemma2:27b */
|
|
113
|
+
genModel?: string | null;
|
|
114
|
+
/** Number of matching records to use as context; defaults to 10 */
|
|
115
|
+
limit?: number | null;
|
|
116
|
+
/** Records to skip before the first one used; defaults to 0 */
|
|
117
|
+
offset?: number | null;
|
|
118
|
+
[key: string]: unknown;
|
|
119
|
+
}
|
|
120
|
+
/**
|
|
121
|
+
* Shape of `services` (MINIMUM fields; reused wherever the same shape appears)
|
|
122
|
+
* Services the site is configured for, each with its config
|
|
123
|
+
*
|
|
124
|
+
* Field `services` of ContextGetDataOption1
|
|
125
|
+
*/
|
|
126
|
+
export interface ContextGetDataOption1ServicesItem {
|
|
127
|
+
/** Service name (the config file name) */
|
|
128
|
+
name: string;
|
|
129
|
+
/** Table prefix for the site in this service; absent when the config sets none */
|
|
130
|
+
prefix?: string | null;
|
|
131
|
+
[key: string]: unknown;
|
|
132
|
+
}
|
|
133
|
+
/**
|
|
134
|
+
* Get a site configuration context
|
|
135
|
+
* Response data for GET /context/{siteId} — MINIMUM fields, extras pass through
|
|
136
|
+
*
|
|
137
|
+
* Returned by: api.agrInfo.context.get(siteId)
|
|
138
|
+
*/
|
|
139
|
+
export interface ContextGetDataOption1 {
|
|
140
|
+
/** Site described */
|
|
141
|
+
siteId: string;
|
|
142
|
+
/** Site domain; null when the site is not provisioned */
|
|
143
|
+
domain: string | null;
|
|
144
|
+
/** Site row in sites_table (dev port = 3000 + uid); 0 when the site is unknown */
|
|
145
|
+
uid: number;
|
|
146
|
+
/** Services the site is configured for, each with its config */
|
|
147
|
+
services: ContextGetDataOption1ServicesItem[];
|
|
148
|
+
/** Number of configured services */
|
|
149
|
+
serviceCount: number;
|
|
150
|
+
/** Services the site is not configured for */
|
|
151
|
+
inactiveServices: string[];
|
|
152
|
+
[key: string]: unknown;
|
|
153
|
+
}
|
|
154
|
+
/**
|
|
155
|
+
* Get a site configuration context
|
|
156
|
+
* Response data for GET /context/{siteId} — MINIMUM fields, extras pass through
|
|
157
|
+
*
|
|
158
|
+
* Returned by: api.agrInfo.context.get(siteId)
|
|
159
|
+
*/
|
|
160
|
+
export type ContextGetData = ContextGetDataOption1;
|
|
161
|
+
/**
|
|
162
|
+
* Generate Response from joomla
|
|
163
|
+
* Response data for POST /joomla/generate — MINIMUM fields, extras pass through
|
|
164
|
+
*
|
|
165
|
+
* Returned by: api.agrInfo.joomla.generate.create(data)
|
|
166
|
+
*/
|
|
167
|
+
export type JoomlaGenerateCreateData = string;
|
|
168
|
+
/**
|
|
169
|
+
* Generate Response from joomla
|
|
170
|
+
* Request body for POST /joomla/generate — MINIMUM fields, extras pass through
|
|
171
|
+
*
|
|
172
|
+
* Request body of: api.agrInfo.joomla.generate.create(data)
|
|
173
|
+
*/
|
|
174
|
+
export type JoomlaGenerateCreateBody = AkashaGenerateCreateBody;
|
|
175
|
+
/**
|
|
176
|
+
* List Microservices
|
|
177
|
+
* Response data for GET /microservices — MINIMUM fields, extras pass through
|
|
178
|
+
*
|
|
179
|
+
* Returned by: api.agrInfo.microservices.list(params) (array items)
|
|
180
|
+
* Returned by: api.agrInfo.microservices.create(data)
|
|
181
|
+
* Returned by: api.agrInfo.microservices.get(microservicesUid)
|
|
182
|
+
* Returned by: api.agrInfo.microservices.update(microservicesUid, data)
|
|
183
|
+
* Returned by: api.agrInfo.microservices.delete(microservicesUid)
|
|
184
|
+
*/
|
|
185
|
+
export interface MicroservicesListItem {
|
|
186
|
+
/** Microservice ID */
|
|
187
|
+
microservicesUid: number;
|
|
188
|
+
/** Microservice name (max 255 chars) */
|
|
189
|
+
name: string | null;
|
|
190
|
+
/** Microservice id (slug derived from the name) (max 255 chars) */
|
|
191
|
+
id: string | null;
|
|
192
|
+
/** Update code (1185 = Import Complete) */
|
|
193
|
+
updateCd: number;
|
|
194
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
195
|
+
statusCd: number;
|
|
196
|
+
/** Process code (704 = Active, 1185 = Import Complete) */
|
|
197
|
+
processCd: number;
|
|
198
|
+
/** When the record was created (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
199
|
+
dateCreated: string;
|
|
200
|
+
/** When the record last changed (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
201
|
+
dateLastModified: string;
|
|
202
|
+
[key: string]: unknown;
|
|
203
|
+
}
|
|
204
|
+
/** Returned by: api.agrInfo.microservices.list(params) */
|
|
205
|
+
export type MicroservicesListData = MicroservicesListItem[];
|
|
206
|
+
/**
|
|
207
|
+
* Create Microservice
|
|
208
|
+
* Response data for POST /microservices — MINIMUM fields, extras pass through
|
|
209
|
+
*
|
|
210
|
+
* Returned by: api.agrInfo.microservices.create(data)
|
|
211
|
+
*/
|
|
212
|
+
export type MicroservicesCreateData = MicroservicesListItem;
|
|
213
|
+
/**
|
|
214
|
+
* Create Microservice
|
|
215
|
+
* Request body for POST /microservices — MINIMUM fields, extras pass through
|
|
216
|
+
*
|
|
217
|
+
* Request body of: api.agrInfo.microservices.create(data)
|
|
218
|
+
*/
|
|
219
|
+
export interface MicroservicesCreateBody {
|
|
220
|
+
/** Microservice name; required, the id slug is derived from it */
|
|
221
|
+
name: string | null;
|
|
222
|
+
[key: string]: unknown;
|
|
223
|
+
}
|
|
224
|
+
/**
|
|
225
|
+
* Get Microservice Details
|
|
226
|
+
* Response data for GET /microservices/{microservicesUid} — MINIMUM fields, extras pass through
|
|
227
|
+
*
|
|
228
|
+
* Returned by: api.agrInfo.microservices.get(microservicesUid)
|
|
229
|
+
*/
|
|
230
|
+
export type MicroservicesGetData = MicroservicesListItem;
|
|
231
|
+
/**
|
|
232
|
+
* Update Microservice
|
|
233
|
+
* Response data for PUT /microservices/{microservicesUid} — MINIMUM fields, extras pass through
|
|
234
|
+
*
|
|
235
|
+
* Returned by: api.agrInfo.microservices.update(microservicesUid, data)
|
|
236
|
+
*/
|
|
237
|
+
export type MicroservicesUpdateData = MicroservicesListItem;
|
|
238
|
+
/**
|
|
239
|
+
* Update Microservice
|
|
240
|
+
* Request body for PUT /microservices/{microservicesUid} — MINIMUM fields, extras pass through
|
|
241
|
+
*
|
|
242
|
+
* Request body of: api.agrInfo.microservices.update(microservicesUid, data)
|
|
243
|
+
*/
|
|
244
|
+
export interface MicroservicesUpdateBody {
|
|
245
|
+
/** Update code (1185 = Import Complete) */
|
|
246
|
+
updateCd?: number | null;
|
|
247
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
248
|
+
statusCd?: number | null;
|
|
249
|
+
/** Process code (704 = Active, 1185 = Import Complete) */
|
|
250
|
+
processCd?: number | null;
|
|
251
|
+
[key: string]: unknown;
|
|
252
|
+
}
|
|
253
|
+
/**
|
|
254
|
+
* DELETE Microservice
|
|
255
|
+
* Response data for DELETE /microservices/{microservicesUid} — MINIMUM fields, extras pass through
|
|
256
|
+
*
|
|
257
|
+
* Returned by: api.agrInfo.microservices.delete(microservicesUid)
|
|
258
|
+
*/
|
|
259
|
+
export type MicroservicesDeleteData = MicroservicesListItem;
|
|
260
|
+
/**
|
|
261
|
+
* List Rubrics
|
|
262
|
+
* Response data for GET /rubrics — MINIMUM fields, extras pass through
|
|
263
|
+
*
|
|
264
|
+
* Returned by: api.agrInfo.rubrics.list(params) (array items)
|
|
265
|
+
* Returned by: api.agrInfo.rubrics.create(data)
|
|
266
|
+
* Returned by: api.agrInfo.rubrics.get(rubricsUid)
|
|
267
|
+
* Returned by: api.agrInfo.rubrics.update(rubricsUid, data)
|
|
268
|
+
* Returned by: api.agrInfo.rubrics.delete(rubricsUid)
|
|
269
|
+
*/
|
|
270
|
+
export interface RubricsListItem {
|
|
271
|
+
/** Rubric ID */
|
|
272
|
+
rubricsUid: number;
|
|
273
|
+
/** Rubric title (max 255 chars) */
|
|
274
|
+
title: string | null;
|
|
275
|
+
/** Rubric id (slug) callers look the rubric up by (max 255 chars) */
|
|
276
|
+
id: string | null;
|
|
277
|
+
/** Prompt template text */
|
|
278
|
+
content: string | null;
|
|
279
|
+
/** Update code (1185 = Import Complete) */
|
|
280
|
+
updateCd: number;
|
|
281
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
282
|
+
statusCd: number;
|
|
283
|
+
/** Process code (704 = Active, 1185 = Import Complete) */
|
|
284
|
+
processCd: number;
|
|
285
|
+
/** When the record was created (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
286
|
+
dateCreated: string;
|
|
287
|
+
/** When the record last changed (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
288
|
+
dateLastModified: string;
|
|
289
|
+
[key: string]: unknown;
|
|
290
|
+
}
|
|
291
|
+
/** Returned by: api.agrInfo.rubrics.list(params) */
|
|
292
|
+
export type RubricsListData = RubricsListItem[];
|
|
293
|
+
/**
|
|
294
|
+
* Create Rubric
|
|
295
|
+
* Response data for POST /rubrics — MINIMUM fields, extras pass through
|
|
296
|
+
*
|
|
297
|
+
* Returned by: api.agrInfo.rubrics.create(data)
|
|
298
|
+
*/
|
|
299
|
+
export type RubricsCreateData = RubricsListItem;
|
|
300
|
+
/**
|
|
301
|
+
* Create Rubric
|
|
302
|
+
* Request body for POST /rubrics — MINIMUM fields, extras pass through
|
|
303
|
+
*
|
|
304
|
+
* Request body of: api.agrInfo.rubrics.create(data)
|
|
305
|
+
*/
|
|
306
|
+
export interface RubricsCreateBody {
|
|
307
|
+
/** Rubric title */
|
|
308
|
+
title: string;
|
|
309
|
+
/** Rubric id (slug) callers look the rubric up by */
|
|
310
|
+
id: string;
|
|
311
|
+
/** Prompt template text */
|
|
312
|
+
content: string;
|
|
313
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted); defaults to 704 */
|
|
314
|
+
statusCd?: number | null;
|
|
315
|
+
/** Process code; defaults to 704 (Active) */
|
|
316
|
+
processCd?: number | null;
|
|
317
|
+
/** Update code; defaults to 1185 (Import Complete) */
|
|
318
|
+
updateCd?: number | null;
|
|
319
|
+
[key: string]: unknown;
|
|
320
|
+
}
|
|
321
|
+
/**
|
|
322
|
+
* Get Rubric Details
|
|
323
|
+
* Response data for GET /rubrics/{rubricsUid} — MINIMUM fields, extras pass through
|
|
324
|
+
*
|
|
325
|
+
* Returned by: api.agrInfo.rubrics.get(rubricsUid)
|
|
326
|
+
*/
|
|
327
|
+
export type RubricsGetData = RubricsListItem;
|
|
328
|
+
/**
|
|
329
|
+
* Update Rubric
|
|
330
|
+
* Response data for PUT /rubrics/{rubricsUid} — MINIMUM fields, extras pass through
|
|
331
|
+
*
|
|
332
|
+
* Returned by: api.agrInfo.rubrics.update(rubricsUid, data)
|
|
333
|
+
*/
|
|
334
|
+
export type RubricsUpdateData = RubricsListItem;
|
|
335
|
+
/**
|
|
336
|
+
* Update Rubric
|
|
337
|
+
* Request body for PUT /rubrics/{rubricsUid} — MINIMUM fields, extras pass through
|
|
338
|
+
*
|
|
339
|
+
* Request body of: api.agrInfo.rubrics.update(rubricsUid, data)
|
|
340
|
+
*/
|
|
341
|
+
export interface RubricsUpdateBody {
|
|
342
|
+
/** Rubric title */
|
|
343
|
+
title?: string | null;
|
|
344
|
+
/** Rubric id (slug) callers look the rubric up by */
|
|
345
|
+
id?: string | null;
|
|
346
|
+
/** Prompt template text */
|
|
347
|
+
content?: string | null;
|
|
348
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
349
|
+
statusCd?: number | null;
|
|
350
|
+
/** Process code */
|
|
351
|
+
processCd?: number | null;
|
|
352
|
+
[key: string]: unknown;
|
|
353
|
+
}
|
|
354
|
+
/**
|
|
355
|
+
* Delete Rubric
|
|
356
|
+
* Response data for DELETE /rubrics/{rubricsUid} — MINIMUM fields, extras pass through
|
|
357
|
+
*
|
|
358
|
+
* Returned by: api.agrInfo.rubrics.delete(rubricsUid)
|
|
359
|
+
*/
|
|
360
|
+
export type RubricsDeleteData = RubricsListItem;
|
|
361
|
+
/**
|
|
362
|
+
* List sites
|
|
363
|
+
* Response data for GET /sites — MINIMUM fields, extras pass through
|
|
364
|
+
*
|
|
365
|
+
* Returned by: api.agrInfo.sites.list(params) (array items)
|
|
366
|
+
*/
|
|
367
|
+
export interface SitesListItem {
|
|
368
|
+
/** agr_info sites row ID */
|
|
369
|
+
sitesUid: number;
|
|
370
|
+
/** Site ID */
|
|
371
|
+
siteId: string;
|
|
372
|
+
/** Row status (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
373
|
+
statusCd: number;
|
|
374
|
+
/** 704 when sites_table.active is 1, else 705 */
|
|
375
|
+
legacyActiveCd: number;
|
|
376
|
+
/** Services configured for the site (a config file with a non-empty prefix), sorted by name */
|
|
377
|
+
services: string[];
|
|
378
|
+
/** Prophet 21 version last reported by the site */
|
|
379
|
+
prophet21Version: string | null;
|
|
380
|
+
/** SQL Server version last reported by the site */
|
|
381
|
+
sqlserverVersion: string | null;
|
|
382
|
+
/** Where the site's Prophet 21 is hosted */
|
|
383
|
+
prophet21Hosting: string;
|
|
384
|
+
/** Last successful connection to the site's Prophet 21 */
|
|
385
|
+
dateLastConnect: string;
|
|
386
|
+
[key: string]: unknown;
|
|
387
|
+
}
|
|
388
|
+
/** Returned by: api.agrInfo.sites.list(params) */
|
|
389
|
+
export type SitesListData = SitesListItem[];
|
|
390
|
+
/**
|
|
391
|
+
* Shape of `user` (MINIMUM fields; reused wherever the same shape appears)
|
|
392
|
+
* The token's user; null for a site token or a refused caller
|
|
393
|
+
*
|
|
394
|
+
* Field `user` of SitesP21ApiCreateData
|
|
395
|
+
* Field `user` of SitesValidateCreateData
|
|
396
|
+
*/
|
|
397
|
+
export interface SitesValidateCreateDataUser {
|
|
398
|
+
/** User ID (a Joomla user, or an agr_int user for agr-int-user and client tokens) */
|
|
399
|
+
userId: number;
|
|
400
|
+
/** Username */
|
|
401
|
+
username: string;
|
|
402
|
+
/** Email address; empty for a client credential */
|
|
403
|
+
email: string;
|
|
404
|
+
/** Display name; empty for a client credential */
|
|
405
|
+
name: string;
|
|
406
|
+
/** Roles granted to the user ("Super User" for a Joomla super user) */
|
|
407
|
+
roles: string[];
|
|
408
|
+
[key: string]: unknown;
|
|
409
|
+
}
|
|
410
|
+
/**
|
|
411
|
+
* Shape of `p21` (MINIMUM fields; reused wherever the same shape appears)
|
|
412
|
+
* The site's P21 API credentials; null when the caller is refused or the site has no P21 API
|
|
413
|
+
* configured
|
|
414
|
+
*
|
|
415
|
+
* Field `p21` of SitesP21ApiCreateData
|
|
416
|
+
*/
|
|
417
|
+
export interface SitesP21ApiCreateDataP21 {
|
|
418
|
+
/**
|
|
419
|
+
* P21 API base URL (https://{host}:{port}); token endpoint is POST
|
|
420
|
+
* {baseUrl}/api/security/token/v2
|
|
421
|
+
*/
|
|
422
|
+
baseUrl: string;
|
|
423
|
+
/** P21 API user name, sent to the token endpoint with the password */
|
|
424
|
+
username: string;
|
|
425
|
+
/** P21 API password */
|
|
426
|
+
password: string;
|
|
427
|
+
/** P21 consumer key for the token endpoint; null while sites use user credentials */
|
|
428
|
+
clientSecret: string | null;
|
|
429
|
+
/**
|
|
430
|
+
* True when the site allows write-back through the P21 API: always true here, since this block
|
|
431
|
+
* exists only when the site has P21 API credentials; the P21 user's permissions decide what a
|
|
432
|
+
* write may do
|
|
433
|
+
*/
|
|
434
|
+
writable: boolean;
|
|
435
|
+
[key: string]: unknown;
|
|
436
|
+
}
|
|
437
|
+
/**
|
|
438
|
+
* P21 API credentials
|
|
439
|
+
* Response data for POST /sites/p21-api — MINIMUM fields, extras pass through
|
|
440
|
+
*
|
|
441
|
+
* Returned by: api.agrInfo.sites.p21Api.create(data)
|
|
442
|
+
*/
|
|
443
|
+
export interface SitesP21ApiCreateData {
|
|
444
|
+
/** True when the caller is accepted for the site (validated exactly as POST /sites/validate) */
|
|
445
|
+
valid: boolean;
|
|
446
|
+
/** Site the caller was validated against */
|
|
447
|
+
siteId: string;
|
|
448
|
+
/** Why the caller was refused, or why p21 is null; empty otherwise */
|
|
449
|
+
error: string;
|
|
450
|
+
/** site, user, agr-int-user or client; null when the token did not validate */
|
|
451
|
+
tokenType: string | null;
|
|
452
|
+
/** True for a Joomla super user token */
|
|
453
|
+
isAdmin: boolean;
|
|
454
|
+
/** The token's user; null for a site token or a refused caller */
|
|
455
|
+
user: SitesValidateCreateDataUser | null;
|
|
456
|
+
/**
|
|
457
|
+
* The site's P21 API credentials; null when the caller is refused or the site has no P21 API
|
|
458
|
+
* configured
|
|
459
|
+
*/
|
|
460
|
+
p21: SitesP21ApiCreateDataP21 | null;
|
|
461
|
+
[key: string]: unknown;
|
|
462
|
+
}
|
|
463
|
+
/**
|
|
464
|
+
* P21 API credentials
|
|
465
|
+
* Request body for POST /sites/p21-api — MINIMUM fields, extras pass through
|
|
466
|
+
*
|
|
467
|
+
* Request body of: api.agrInfo.sites.p21Api.create(data)
|
|
468
|
+
* Request body of: api.agrInfo.sites.validate.create(data)
|
|
469
|
+
*/
|
|
470
|
+
export interface SitesValidateCreateBody {
|
|
471
|
+
/** Site the token was issued for */
|
|
472
|
+
siteId: string;
|
|
473
|
+
/** JWT, or an agr_int client credential (agrc_...) */
|
|
474
|
+
token: string;
|
|
475
|
+
[key: string]: unknown;
|
|
476
|
+
}
|
|
477
|
+
/**
|
|
478
|
+
* P21 API credentials
|
|
479
|
+
* Request body for POST /sites/p21-api — MINIMUM fields, extras pass through
|
|
480
|
+
*
|
|
481
|
+
* Request body of: api.agrInfo.sites.p21Api.create(data)
|
|
482
|
+
*/
|
|
483
|
+
export type SitesP21ApiCreateBody = SitesValidateCreateBody;
|
|
484
|
+
/**
|
|
485
|
+
* Staff token for a target site
|
|
486
|
+
* Response data for POST /sites/staff-token — MINIMUM fields, extras pass through
|
|
487
|
+
*
|
|
488
|
+
* Returned by: api.agrInfo.sites.staffToken.create(data)
|
|
489
|
+
*/
|
|
490
|
+
export interface SitesStaffTokenCreateData {
|
|
491
|
+
/** User-scope JWT for the mirror account on the target site */
|
|
492
|
+
token: string;
|
|
493
|
+
/** Target site the token is bound to */
|
|
494
|
+
siteId: string;
|
|
495
|
+
/** Mirror account username on the target site */
|
|
496
|
+
username: string;
|
|
497
|
+
[key: string]: unknown;
|
|
498
|
+
}
|
|
499
|
+
/**
|
|
500
|
+
* Staff token for a target site
|
|
501
|
+
* Request body for POST /sites/staff-token — MINIMUM fields, extras pass through
|
|
502
|
+
*
|
|
503
|
+
* Request body of: api.agrInfo.sites.staffToken.create(data)
|
|
504
|
+
*/
|
|
505
|
+
export interface SitesStaffTokenCreateBody {
|
|
506
|
+
/** Target site to issue the token for */
|
|
507
|
+
siteId: string;
|
|
508
|
+
[key: string]: unknown;
|
|
509
|
+
}
|
|
510
|
+
/**
|
|
511
|
+
* Shape of `connection` (MINIMUM fields; reused wherever the same shape appears)
|
|
512
|
+
* The site's P21 database connection
|
|
513
|
+
*
|
|
514
|
+
* Field `connection` of SitesValidateCreateData
|
|
515
|
+
*/
|
|
516
|
+
export interface SitesValidateCreateDataConnection {
|
|
517
|
+
/** Database host */
|
|
518
|
+
host: string | null;
|
|
519
|
+
/** Database port (1433 when not configured) */
|
|
520
|
+
port: number | null;
|
|
521
|
+
/** Database name */
|
|
522
|
+
database: string | null;
|
|
523
|
+
/** Database username */
|
|
524
|
+
username: string | null;
|
|
525
|
+
/** Database password */
|
|
526
|
+
password: string | null;
|
|
527
|
+
[key: string]: unknown;
|
|
528
|
+
}
|
|
529
|
+
/**
|
|
530
|
+
* Validate credentials
|
|
531
|
+
* Response data for POST /sites/validate — MINIMUM fields, extras pass through
|
|
532
|
+
*
|
|
533
|
+
* Returned by: api.agrInfo.sites.validate.create(data)
|
|
534
|
+
*/
|
|
535
|
+
export interface SitesValidateCreateData {
|
|
536
|
+
/** True when the credential is valid and the site has a P21 connection */
|
|
537
|
+
valid: boolean;
|
|
538
|
+
/** Site the credential was validated against */
|
|
539
|
+
siteId: string;
|
|
540
|
+
/** Why validation failed; empty when valid */
|
|
541
|
+
error: string;
|
|
542
|
+
/** site, user, agr-int-user or client; null when the token did not validate */
|
|
543
|
+
tokenType: string | null;
|
|
544
|
+
/** True for a Joomla super user token */
|
|
545
|
+
isAdmin: boolean;
|
|
546
|
+
/** The token's user; null for a site token or a failed validation */
|
|
547
|
+
user: SitesValidateCreateDataUser | null;
|
|
548
|
+
/** The site's P21 database connection */
|
|
549
|
+
connection: SitesValidateCreateDataConnection;
|
|
550
|
+
[key: string]: unknown;
|
|
551
|
+
}
|
|
552
|
+
/**
|
|
553
|
+
* List Workflows
|
|
554
|
+
* Response data for GET /workflows — MINIMUM fields, extras pass through
|
|
555
|
+
*
|
|
556
|
+
* Returned by: api.agrInfo.workflows.list(params) (array items)
|
|
557
|
+
* Returned by: api.agrInfo.workflows.create(data)
|
|
558
|
+
* Returned by: api.agrInfo.workflows.get(workflowsUid)
|
|
559
|
+
* Returned by: api.agrInfo.workflows.update(workflowsUid, data)
|
|
560
|
+
* Returned by: api.agrInfo.workflows.delete(workflowsUid)
|
|
561
|
+
*/
|
|
562
|
+
export interface WorkflowsListItem {
|
|
563
|
+
/** Workflow ID */
|
|
564
|
+
workflowsUid: number;
|
|
565
|
+
/** Workflow id (slug) (max 100 chars) */
|
|
566
|
+
workflowsId: string;
|
|
567
|
+
/** Workflow title (max 255 chars) */
|
|
568
|
+
title: string;
|
|
569
|
+
/** Workflow description */
|
|
570
|
+
description: string | null;
|
|
571
|
+
/** Services the workflow covers (max 255 chars) */
|
|
572
|
+
services: string;
|
|
573
|
+
/** Workflow content */
|
|
574
|
+
workflow: string;
|
|
575
|
+
/** When the record was created (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
576
|
+
dateCreated: string;
|
|
577
|
+
/** When the record last changed (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
578
|
+
dateLastModified: string;
|
|
579
|
+
/** Update code (1185 = Import Complete) */
|
|
580
|
+
updateCd: number;
|
|
581
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
582
|
+
statusCd: number;
|
|
583
|
+
/** Process code (704 = Active, 1185 = Import Complete) */
|
|
584
|
+
processCd: number;
|
|
585
|
+
[key: string]: unknown;
|
|
586
|
+
}
|
|
587
|
+
/** Returned by: api.agrInfo.workflows.list(params) */
|
|
588
|
+
export type WorkflowsListData = WorkflowsListItem[];
|
|
589
|
+
/**
|
|
590
|
+
* Create Workflow
|
|
591
|
+
* Response data for POST /workflows — MINIMUM fields, extras pass through
|
|
592
|
+
*
|
|
593
|
+
* Returned by: api.agrInfo.workflows.create(data)
|
|
594
|
+
*/
|
|
595
|
+
export type WorkflowsCreateData = WorkflowsListItem;
|
|
596
|
+
/**
|
|
597
|
+
* Create Workflow
|
|
598
|
+
* Request body for POST /workflows — MINIMUM fields, extras pass through
|
|
599
|
+
*
|
|
600
|
+
* Request body of: api.agrInfo.workflows.create(data)
|
|
601
|
+
*/
|
|
602
|
+
export interface WorkflowsCreateBody {
|
|
603
|
+
/** Workflow title */
|
|
604
|
+
title: string;
|
|
605
|
+
/** Workflow content */
|
|
606
|
+
workflow: string;
|
|
607
|
+
/** Workflow id (slug); derived from the title when absent */
|
|
608
|
+
workflowsId?: string | null;
|
|
609
|
+
/** Workflow description */
|
|
610
|
+
description?: string | null;
|
|
611
|
+
/** Services the workflow covers; defaults to empty */
|
|
612
|
+
services?: string | null;
|
|
613
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted); defaults to 704 */
|
|
614
|
+
statusCd?: number | null;
|
|
615
|
+
/** Process code; defaults to 704 (Active) */
|
|
616
|
+
processCd?: number | null;
|
|
617
|
+
/** Update code; defaults to 1185 (Import Complete) */
|
|
618
|
+
updateCd?: number | null;
|
|
619
|
+
[key: string]: unknown;
|
|
620
|
+
}
|
|
621
|
+
/**
|
|
622
|
+
* Get Workflow Details
|
|
623
|
+
* Response data for GET /workflows/{workflowsUid} — MINIMUM fields, extras pass through
|
|
624
|
+
*
|
|
625
|
+
* Returned by: api.agrInfo.workflows.get(workflowsUid)
|
|
626
|
+
*/
|
|
627
|
+
export type WorkflowsGetData = WorkflowsListItem;
|
|
628
|
+
/**
|
|
629
|
+
* Update Workflow
|
|
630
|
+
* Response data for PUT /workflows/{workflowsUid} — MINIMUM fields, extras pass through
|
|
631
|
+
*
|
|
632
|
+
* Returned by: api.agrInfo.workflows.update(workflowsUid, data)
|
|
633
|
+
*/
|
|
634
|
+
export type WorkflowsUpdateData = WorkflowsListItem;
|
|
635
|
+
/**
|
|
636
|
+
* Update Workflow
|
|
637
|
+
* Request body for PUT /workflows/{workflowsUid} — MINIMUM fields, extras pass through
|
|
638
|
+
*
|
|
639
|
+
* Request body of: api.agrInfo.workflows.update(workflowsUid, data)
|
|
640
|
+
*/
|
|
641
|
+
export interface WorkflowsUpdateBody {
|
|
642
|
+
/** Workflow id (slug) */
|
|
643
|
+
workflowsId?: string | null;
|
|
644
|
+
/** Workflow title */
|
|
645
|
+
title?: string | null;
|
|
646
|
+
/** Workflow description */
|
|
647
|
+
description?: string | null;
|
|
648
|
+
/** Services the workflow covers */
|
|
649
|
+
services?: string | null;
|
|
650
|
+
/** Workflow content */
|
|
651
|
+
workflow?: string | null;
|
|
652
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
653
|
+
statusCd?: number | null;
|
|
654
|
+
/** Process code */
|
|
655
|
+
processCd?: number | null;
|
|
656
|
+
/** Update code */
|
|
657
|
+
updateCd?: number | null;
|
|
658
|
+
[key: string]: unknown;
|
|
659
|
+
}
|
|
660
|
+
/**
|
|
661
|
+
* Delete Workflow
|
|
662
|
+
* Response data for DELETE /workflows/{workflowsUid} — MINIMUM fields, extras pass through
|
|
663
|
+
*
|
|
664
|
+
* Returned by: api.agrInfo.workflows.delete(workflowsUid)
|
|
665
|
+
*/
|
|
666
|
+
export type WorkflowsDeleteData = WorkflowsListItem;
|
|
667
|
+
export interface AgrInfoClientSpec {
|
|
668
|
+
akasha: {
|
|
669
|
+
generate: {
|
|
670
|
+
/**
|
|
671
|
+
* Generate Response from akasha
|
|
672
|
+
* Call: api.agrInfo.akasha.generate.create(data)
|
|
673
|
+
*
|
|
674
|
+
* Request body: Ask a question answered by an LLM over the matching knowledge records (Akasha
|
|
675
|
+
* or Joomla)
|
|
676
|
+
*
|
|
677
|
+
* Errors:
|
|
678
|
+
* 400: The body is missing or not a JSON object.
|
|
679
|
+
* 403: x-site-id is not augur_info: agr_info serves only the augur_info site.
|
|
680
|
+
*
|
|
681
|
+
* POST https://agr-info.augur-api.com/akasha/generate
|
|
682
|
+
* Contract: https://agr-info.augur-api.com/openapi.json#/paths/~1akasha~1generate/post
|
|
683
|
+
*
|
|
684
|
+
* @param data AkashaGenerateCreateBody (request body)
|
|
685
|
+
* @returns BaseResponse whose `data` is AkashaGenerateCreateData
|
|
686
|
+
*/
|
|
687
|
+
create: (data: AkashaGenerateCreateBody) => Promise<BaseResponse<AkashaGenerateCreateData>>;
|
|
688
|
+
};
|
|
689
|
+
};
|
|
690
|
+
context: {
|
|
691
|
+
/**
|
|
692
|
+
* Get a site configuration context
|
|
693
|
+
* Call: api.agrInfo.context.get(siteId)
|
|
694
|
+
*
|
|
695
|
+
* get the context for a site
|
|
696
|
+
*
|
|
697
|
+
* Response data: A site's configuration as the admin site (augur_info) sees it: every service
|
|
698
|
+
* with its full config
|
|
699
|
+
*
|
|
700
|
+
* Auth: bearer token; spec scopes: none listed (most endpoints list `public`)
|
|
701
|
+
*
|
|
702
|
+
* Errors:
|
|
703
|
+
* 403: x-site-id is not augur_info: agr_info serves only the augur_info site.
|
|
704
|
+
* 404: The path siteId has no domain configured: the site is unknown.
|
|
705
|
+
*
|
|
706
|
+
* GET https://agr-info.augur-api.com/context/{siteId}
|
|
707
|
+
* Contract: https://agr-info.augur-api.com/openapi.json#/paths/~1context~1{siteId}/get
|
|
708
|
+
*
|
|
709
|
+
* @param siteId target site ID to get context for
|
|
710
|
+
* @param params ContextGetParams (query string)
|
|
711
|
+
* @returns BaseResponse whose `data` is ContextGetData
|
|
712
|
+
*/
|
|
713
|
+
get: (siteId: string, params?: ContextGetParams) => Promise<BaseResponse<ContextGetData>>;
|
|
714
|
+
};
|
|
715
|
+
joomla: {
|
|
716
|
+
generate: {
|
|
717
|
+
/**
|
|
718
|
+
* Generate Response from joomla
|
|
719
|
+
* Call: api.agrInfo.joomla.generate.create(data)
|
|
720
|
+
*
|
|
721
|
+
* Request body: Ask a question answered by an LLM over the matching knowledge records (Akasha
|
|
722
|
+
* or Joomla)
|
|
723
|
+
*
|
|
724
|
+
* Errors:
|
|
725
|
+
* 400: The body is missing or not a JSON object.
|
|
726
|
+
* 403: x-site-id is not augur_info: agr_info serves only the augur_info site.
|
|
727
|
+
*
|
|
728
|
+
* POST https://agr-info.augur-api.com/joomla/generate
|
|
729
|
+
* Contract: https://agr-info.augur-api.com/openapi.json#/paths/~1joomla~1generate/post
|
|
730
|
+
*
|
|
731
|
+
* @param data JoomlaGenerateCreateBody (request body)
|
|
732
|
+
* @returns BaseResponse whose `data` is JoomlaGenerateCreateData
|
|
733
|
+
*/
|
|
734
|
+
create: (data: JoomlaGenerateCreateBody) => Promise<BaseResponse<JoomlaGenerateCreateData>>;
|
|
735
|
+
};
|
|
736
|
+
};
|
|
737
|
+
microservices: {
|
|
738
|
+
/**
|
|
739
|
+
* List Microservices
|
|
740
|
+
* Call: api.agrInfo.microservices.list(params)
|
|
741
|
+
*
|
|
742
|
+
* Errors:
|
|
743
|
+
* 400: orderBy is not column|ASC or column|DESC on a microservices column.
|
|
744
|
+
* 403: x-site-id is not augur_info: agr_info serves only the augur_info site.
|
|
745
|
+
*
|
|
746
|
+
* GET https://agr-info.augur-api.com/microservices
|
|
747
|
+
* Contract: https://agr-info.augur-api.com/openapi.json#/paths/~1microservices/get
|
|
748
|
+
*
|
|
749
|
+
* @param params MicroservicesListParams (query string)
|
|
750
|
+
* @returns BaseResponse whose `data` is MicroservicesListData
|
|
751
|
+
*/
|
|
752
|
+
list: (params?: MicroservicesListParams) => Promise<BaseResponse<MicroservicesListData>>;
|
|
753
|
+
/**
|
|
754
|
+
* Create Microservice
|
|
755
|
+
* Call: api.agrInfo.microservices.create(data)
|
|
756
|
+
*
|
|
757
|
+
* Request body: Register a microservice, or return the existing one whose id the name derives
|
|
758
|
+
*
|
|
759
|
+
* Errors:
|
|
760
|
+
* 400: The body is missing or not a JSON object. Or name is missing.
|
|
761
|
+
* 403: x-site-id is not augur_info: agr_info serves only the augur_info site.
|
|
762
|
+
*
|
|
763
|
+
* POST https://agr-info.augur-api.com/microservices
|
|
764
|
+
* Contract: https://agr-info.augur-api.com/openapi.json#/paths/~1microservices/post
|
|
765
|
+
*
|
|
766
|
+
* @param data MicroservicesCreateBody (request body)
|
|
767
|
+
* @returns BaseResponse whose `data` is MicroservicesCreateData
|
|
768
|
+
*/
|
|
769
|
+
create: (data: MicroservicesCreateBody) => Promise<BaseResponse<MicroservicesCreateData>>;
|
|
770
|
+
/**
|
|
771
|
+
* Get Microservice Details
|
|
772
|
+
* Call: api.agrInfo.microservices.get(microservicesUid)
|
|
773
|
+
*
|
|
774
|
+
* Errors:
|
|
775
|
+
* 403: x-site-id is not augur_info: agr_info serves only the augur_info site.
|
|
776
|
+
* 404: No microservice with this ID.
|
|
777
|
+
*
|
|
778
|
+
* GET https://agr-info.augur-api.com/microservices/{microservicesUid}
|
|
779
|
+
* Contract:
|
|
780
|
+
* https://agr-info.augur-api.com/openapi.json#/paths/~1microservices~1{microservicesUid}/get
|
|
781
|
+
*
|
|
782
|
+
* @param microservicesUid Microservice ID
|
|
783
|
+
* @param params MicroservicesGetParams (query string)
|
|
784
|
+
* @returns BaseResponse whose `data` is MicroservicesGetData
|
|
785
|
+
*/
|
|
786
|
+
get: (microservicesUid: number, params?: MicroservicesGetParams) => Promise<BaseResponse<MicroservicesGetData>>;
|
|
787
|
+
/**
|
|
788
|
+
* Update Microservice
|
|
789
|
+
* Call: api.agrInfo.microservices.update(microservicesUid, data)
|
|
790
|
+
*
|
|
791
|
+
* Request body: Partial update of a microservice's codes; an absent field keeps its current
|
|
792
|
+
* value
|
|
793
|
+
*
|
|
794
|
+
* Errors:
|
|
795
|
+
* 400: The body is missing or not a JSON object.
|
|
796
|
+
* 403: x-site-id is not augur_info: agr_info serves only the augur_info site.
|
|
797
|
+
* 404: No microservice with this ID.
|
|
798
|
+
*
|
|
799
|
+
* PUT https://agr-info.augur-api.com/microservices/{microservicesUid}
|
|
800
|
+
* Contract:
|
|
801
|
+
* https://agr-info.augur-api.com/openapi.json#/paths/~1microservices~1{microservicesUid}/put
|
|
802
|
+
*
|
|
803
|
+
* @param microservicesUid Microservice ID
|
|
804
|
+
* @param data MicroservicesUpdateBody (request body)
|
|
805
|
+
* @returns BaseResponse whose `data` is MicroservicesUpdateData
|
|
806
|
+
*/
|
|
807
|
+
update: (microservicesUid: number, data: MicroservicesUpdateBody) => Promise<BaseResponse<MicroservicesUpdateData>>;
|
|
808
|
+
/**
|
|
809
|
+
* DELETE Microservice
|
|
810
|
+
* Call: api.agrInfo.microservices.delete(microservicesUid)
|
|
811
|
+
*
|
|
812
|
+
* Errors:
|
|
813
|
+
* 403: x-site-id is not augur_info: agr_info serves only the augur_info site.
|
|
814
|
+
* 404: No microservice with this ID.
|
|
815
|
+
*
|
|
816
|
+
* DELETE https://agr-info.augur-api.com/microservices/{microservicesUid}
|
|
817
|
+
* Contract:
|
|
818
|
+
* https://agr-info.augur-api.com/openapi.json#/paths/~1microservices~1{microservicesUid}/delete
|
|
819
|
+
*
|
|
820
|
+
* @param microservicesUid Microservice ID
|
|
821
|
+
* @returns BaseResponse whose `data` is MicroservicesDeleteData
|
|
822
|
+
*/
|
|
823
|
+
delete: (microservicesUid: number) => Promise<BaseResponse<MicroservicesDeleteData>>;
|
|
824
|
+
};
|
|
825
|
+
rubrics: {
|
|
826
|
+
/**
|
|
827
|
+
* List Rubrics
|
|
828
|
+
* Call: api.agrInfo.rubrics.list(params)
|
|
829
|
+
*
|
|
830
|
+
* Errors:
|
|
831
|
+
* 400: orderBy is not column|ASC or column|DESC on a rubrics column.
|
|
832
|
+
* 403: x-site-id is not augur_info: agr_info serves only the augur_info site.
|
|
833
|
+
*
|
|
834
|
+
* GET https://agr-info.augur-api.com/rubrics
|
|
835
|
+
* Contract: https://agr-info.augur-api.com/openapi.json#/paths/~1rubrics/get
|
|
836
|
+
*
|
|
837
|
+
* @param params RubricsListParams (query string)
|
|
838
|
+
* @returns BaseResponse whose `data` is RubricsListData
|
|
839
|
+
*/
|
|
840
|
+
list: (params?: RubricsListParams) => Promise<BaseResponse<RubricsListData>>;
|
|
841
|
+
/**
|
|
842
|
+
* Create Rubric
|
|
843
|
+
* Call: api.agrInfo.rubrics.create(data)
|
|
844
|
+
*
|
|
845
|
+
* Request body: Create a rubric (an LLM prompt template), or keep the existing one with the
|
|
846
|
+
* same id
|
|
847
|
+
*
|
|
848
|
+
* Errors:
|
|
849
|
+
* 400: The body is missing or not a JSON object. Or title, id or content is missing.
|
|
850
|
+
* 403: x-site-id is not augur_info: agr_info serves only the augur_info site.
|
|
851
|
+
*
|
|
852
|
+
* POST https://agr-info.augur-api.com/rubrics
|
|
853
|
+
* Contract: https://agr-info.augur-api.com/openapi.json#/paths/~1rubrics/post
|
|
854
|
+
*
|
|
855
|
+
* @param data RubricsCreateBody (request body)
|
|
856
|
+
* @returns BaseResponse whose `data` is RubricsCreateData
|
|
857
|
+
*/
|
|
858
|
+
create: (data: RubricsCreateBody) => Promise<BaseResponse<RubricsCreateData>>;
|
|
859
|
+
/**
|
|
860
|
+
* Get Rubric Details
|
|
861
|
+
* Call: api.agrInfo.rubrics.get(rubricsUid)
|
|
862
|
+
*
|
|
863
|
+
* Errors:
|
|
864
|
+
* 403: x-site-id is not augur_info: agr_info serves only the augur_info site.
|
|
865
|
+
* 404: No rubric with this ID.
|
|
866
|
+
*
|
|
867
|
+
* GET https://agr-info.augur-api.com/rubrics/{rubricsUid}
|
|
868
|
+
* Contract: https://agr-info.augur-api.com/openapi.json#/paths/~1rubrics~1{rubricsUid}/get
|
|
869
|
+
*
|
|
870
|
+
* @param rubricsUid Rubric ID
|
|
871
|
+
* @param params RubricsGetParams (query string)
|
|
872
|
+
* @returns BaseResponse whose `data` is RubricsGetData
|
|
873
|
+
*/
|
|
874
|
+
get: (rubricsUid: number, params?: RubricsGetParams) => Promise<BaseResponse<RubricsGetData>>;
|
|
875
|
+
/**
|
|
876
|
+
* Update Rubric
|
|
877
|
+
* Call: api.agrInfo.rubrics.update(rubricsUid, data)
|
|
878
|
+
*
|
|
879
|
+
* Request body: Partial update of a rubric; an absent field keeps its current value
|
|
880
|
+
*
|
|
881
|
+
* Errors:
|
|
882
|
+
* 400: The body is missing or not a JSON object.
|
|
883
|
+
* 403: x-site-id is not augur_info: agr_info serves only the augur_info site.
|
|
884
|
+
* 404: No rubric with this ID.
|
|
885
|
+
*
|
|
886
|
+
* PUT https://agr-info.augur-api.com/rubrics/{rubricsUid}
|
|
887
|
+
* Contract: https://agr-info.augur-api.com/openapi.json#/paths/~1rubrics~1{rubricsUid}/put
|
|
888
|
+
*
|
|
889
|
+
* @param rubricsUid Rubric ID
|
|
890
|
+
* @param data RubricsUpdateBody (request body)
|
|
891
|
+
* @returns BaseResponse whose `data` is RubricsUpdateData
|
|
892
|
+
*/
|
|
893
|
+
update: (rubricsUid: number, data: RubricsUpdateBody) => Promise<BaseResponse<RubricsUpdateData>>;
|
|
894
|
+
/**
|
|
895
|
+
* Delete Rubric
|
|
896
|
+
* Call: api.agrInfo.rubrics.delete(rubricsUid)
|
|
897
|
+
*
|
|
898
|
+
* Errors:
|
|
899
|
+
* 403: x-site-id is not augur_info: agr_info serves only the augur_info site.
|
|
900
|
+
* 404: No rubric with this ID.
|
|
901
|
+
*
|
|
902
|
+
* DELETE https://agr-info.augur-api.com/rubrics/{rubricsUid}
|
|
903
|
+
* Contract: https://agr-info.augur-api.com/openapi.json#/paths/~1rubrics~1{rubricsUid}/delete
|
|
904
|
+
*
|
|
905
|
+
* @param rubricsUid Rubric ID
|
|
906
|
+
* @returns BaseResponse whose `data` is RubricsDeleteData
|
|
907
|
+
*/
|
|
908
|
+
delete: (rubricsUid: number) => Promise<BaseResponse<RubricsDeleteData>>;
|
|
909
|
+
};
|
|
910
|
+
sites: {
|
|
911
|
+
/**
|
|
912
|
+
* List sites
|
|
913
|
+
* Call: api.agrInfo.sites.list(params)
|
|
914
|
+
*
|
|
915
|
+
* List sites with the services each is configured for (a per-site service config file with a
|
|
916
|
+
* non-empty prefix). Active means sites_table.active. augur_info only
|
|
917
|
+
*
|
|
918
|
+
* Response data, each item: One site with the services it is configured for
|
|
919
|
+
* (SitesHelper::generateDoc)
|
|
920
|
+
*
|
|
921
|
+
* Errors:
|
|
922
|
+
* 400: orderBy is not column|ASC or column|DESC on a sites column.
|
|
923
|
+
* 403: x-site-id is not augur_info: agr_info serves only the augur_info site.
|
|
924
|
+
*
|
|
925
|
+
* GET https://agr-info.augur-api.com/sites
|
|
926
|
+
* Contract: https://agr-info.augur-api.com/openapi.json#/paths/~1sites/get
|
|
927
|
+
*
|
|
928
|
+
* @param params SitesListParams (query string)
|
|
929
|
+
* @returns BaseResponse whose `data` is SitesListData
|
|
930
|
+
*/
|
|
931
|
+
list: (params?: SitesListParams) => Promise<BaseResponse<SitesListData>>;
|
|
932
|
+
p21Api: {
|
|
933
|
+
/**
|
|
934
|
+
* P21 API credentials
|
|
935
|
+
* Call: api.agrInfo.sites.p21Api.create(data)
|
|
936
|
+
*
|
|
937
|
+
* Validate a caller for a site exactly as POST /sites/validate does, and return the site's
|
|
938
|
+
* Prophet 21 API (middleware) credentials instead of the SQL connection. An accepted caller
|
|
939
|
+
* is valid even when the site has no P21 API configured (p21 null). Sent with Cache-Control:
|
|
940
|
+
* private, no-store
|
|
941
|
+
*
|
|
942
|
+
* Request body: Validate a site's token or client credential
|
|
943
|
+
* Response data: Result of validating a caller for a site, with the site's Prophet 21 API
|
|
944
|
+
* (middleware) credentials; never the SQL connection
|
|
945
|
+
*
|
|
946
|
+
* Errors:
|
|
947
|
+
* 400: The body is missing or not a JSON object. Or siteId or token is missing.
|
|
948
|
+
* 403: x-site-id is not augur_info: agr_info serves only the augur_info site.
|
|
949
|
+
*
|
|
950
|
+
* POST https://agr-info.augur-api.com/sites/p21-api
|
|
951
|
+
* Contract: https://agr-info.augur-api.com/openapi.json#/paths/~1sites~1p21-api/post
|
|
952
|
+
*
|
|
953
|
+
* @param data SitesP21ApiCreateBody (request body)
|
|
954
|
+
* @returns BaseResponse whose `data` is SitesP21ApiCreateData
|
|
955
|
+
*/
|
|
956
|
+
create: (data: SitesP21ApiCreateBody) => Promise<BaseResponse<SitesP21ApiCreateData>>;
|
|
957
|
+
};
|
|
958
|
+
staffToken: {
|
|
959
|
+
/**
|
|
960
|
+
* Staff token for a target site
|
|
961
|
+
* Call: api.agrInfo.sites.staffToken.create(data)
|
|
962
|
+
*
|
|
963
|
+
* Exchange a staff user token for a user token on a target site
|
|
964
|
+
*
|
|
965
|
+
* Request body: Exchange an augur_info staff token for a token on a target site
|
|
966
|
+
* Response data: A user token on the target site, issued to an augur_info staff member as
|
|
967
|
+
* that site's mirror account
|
|
968
|
+
*
|
|
969
|
+
* Errors:
|
|
970
|
+
* 400: The body is not JSON or has no siteId.
|
|
971
|
+
* 403: The caller cannot get a token for the target site.
|
|
972
|
+
* 404: The target siteId is not a known site.
|
|
973
|
+
* 503: A dependency did not respond. Retryable.
|
|
974
|
+
*
|
|
975
|
+
* POST https://agr-info.augur-api.com/sites/staff-token
|
|
976
|
+
* Contract: https://agr-info.augur-api.com/openapi.json#/paths/~1sites~1staff-token/post
|
|
977
|
+
*
|
|
978
|
+
* @param data SitesStaffTokenCreateBody (request body)
|
|
979
|
+
* @returns BaseResponse whose `data` is SitesStaffTokenCreateData
|
|
980
|
+
*/
|
|
981
|
+
create: (data: SitesStaffTokenCreateBody) => Promise<BaseResponse<SitesStaffTokenCreateData>>;
|
|
982
|
+
};
|
|
983
|
+
validate: {
|
|
984
|
+
/**
|
|
985
|
+
* Validate credentials
|
|
986
|
+
* Call: api.agrInfo.sites.validate.create(data)
|
|
987
|
+
*
|
|
988
|
+
* Validate credentials and return P21 connection details
|
|
989
|
+
*
|
|
990
|
+
* Request body: Validate a site's token or client credential
|
|
991
|
+
* Response data: Result of validating a site's token or client credential, with the site's
|
|
992
|
+
* Prophet 21 connection when valid
|
|
993
|
+
*
|
|
994
|
+
* Errors:
|
|
995
|
+
* 400: The body is missing or not a JSON object. Or siteId or token is missing.
|
|
996
|
+
* 403: x-site-id is not augur_info: agr_info serves only the augur_info site.
|
|
997
|
+
*
|
|
998
|
+
* POST https://agr-info.augur-api.com/sites/validate
|
|
999
|
+
* Contract: https://agr-info.augur-api.com/openapi.json#/paths/~1sites~1validate/post
|
|
1000
|
+
*
|
|
1001
|
+
* @param data SitesValidateCreateBody (request body)
|
|
1002
|
+
* @returns BaseResponse whose `data` is SitesValidateCreateData
|
|
1003
|
+
*/
|
|
1004
|
+
create: (data: SitesValidateCreateBody) => Promise<BaseResponse<SitesValidateCreateData>>;
|
|
1005
|
+
};
|
|
1006
|
+
};
|
|
1007
|
+
workflows: {
|
|
1008
|
+
/**
|
|
1009
|
+
* List Workflows
|
|
1010
|
+
* Call: api.agrInfo.workflows.list(params)
|
|
1011
|
+
*
|
|
1012
|
+
* Errors:
|
|
1013
|
+
* 400: orderBy is not column|ASC or column|DESC on a workflows column.
|
|
1014
|
+
* 403: x-site-id is not augur_info: agr_info serves only the augur_info site.
|
|
1015
|
+
*
|
|
1016
|
+
* GET https://agr-info.augur-api.com/workflows
|
|
1017
|
+
* Contract: https://agr-info.augur-api.com/openapi.json#/paths/~1workflows/get
|
|
1018
|
+
*
|
|
1019
|
+
* @param params WorkflowsListParams (query string)
|
|
1020
|
+
* @returns BaseResponse whose `data` is WorkflowsListData
|
|
1021
|
+
*/
|
|
1022
|
+
list: (params?: WorkflowsListParams) => Promise<BaseResponse<WorkflowsListData>>;
|
|
1023
|
+
/**
|
|
1024
|
+
* Create Workflow
|
|
1025
|
+
* Call: api.agrInfo.workflows.create(data)
|
|
1026
|
+
*
|
|
1027
|
+
* Request body: Create a workflow, or return the existing one with the same workflowsId
|
|
1028
|
+
*
|
|
1029
|
+
* Errors:
|
|
1030
|
+
* 400: The body is missing or not a JSON object. Or title or workflow is missing.
|
|
1031
|
+
* 403: x-site-id is not augur_info: agr_info serves only the augur_info site.
|
|
1032
|
+
*
|
|
1033
|
+
* POST https://agr-info.augur-api.com/workflows
|
|
1034
|
+
* Contract: https://agr-info.augur-api.com/openapi.json#/paths/~1workflows/post
|
|
1035
|
+
*
|
|
1036
|
+
* @param data WorkflowsCreateBody (request body)
|
|
1037
|
+
* @returns BaseResponse whose `data` is WorkflowsCreateData
|
|
1038
|
+
*/
|
|
1039
|
+
create: (data: WorkflowsCreateBody) => Promise<BaseResponse<WorkflowsCreateData>>;
|
|
1040
|
+
/**
|
|
1041
|
+
* Get Workflow Details
|
|
1042
|
+
* Call: api.agrInfo.workflows.get(workflowsUid)
|
|
1043
|
+
*
|
|
1044
|
+
* Errors:
|
|
1045
|
+
* 403: x-site-id is not augur_info: agr_info serves only the augur_info site.
|
|
1046
|
+
* 404: No workflow with this ID.
|
|
1047
|
+
*
|
|
1048
|
+
* GET https://agr-info.augur-api.com/workflows/{workflowsUid}
|
|
1049
|
+
* Contract: https://agr-info.augur-api.com/openapi.json#/paths/~1workflows~1{workflowsUid}/get
|
|
1050
|
+
*
|
|
1051
|
+
* @param workflowsUid Workflow ID
|
|
1052
|
+
* @param params WorkflowsGetParams (query string)
|
|
1053
|
+
* @returns BaseResponse whose `data` is WorkflowsGetData
|
|
1054
|
+
*/
|
|
1055
|
+
get: (workflowsUid: number, params?: WorkflowsGetParams) => Promise<BaseResponse<WorkflowsGetData>>;
|
|
1056
|
+
/**
|
|
1057
|
+
* Update Workflow
|
|
1058
|
+
* Call: api.agrInfo.workflows.update(workflowsUid, data)
|
|
1059
|
+
*
|
|
1060
|
+
* Request body: Partial update of a workflow; an absent field keeps its current value
|
|
1061
|
+
*
|
|
1062
|
+
* Errors:
|
|
1063
|
+
* 400: The body is missing or not a JSON object.
|
|
1064
|
+
* 403: x-site-id is not augur_info: agr_info serves only the augur_info site.
|
|
1065
|
+
* 404: No workflow with this ID.
|
|
1066
|
+
*
|
|
1067
|
+
* PUT https://agr-info.augur-api.com/workflows/{workflowsUid}
|
|
1068
|
+
* Contract: https://agr-info.augur-api.com/openapi.json#/paths/~1workflows~1{workflowsUid}/put
|
|
1069
|
+
*
|
|
1070
|
+
* @param workflowsUid Workflow ID
|
|
1071
|
+
* @param data WorkflowsUpdateBody (request body)
|
|
1072
|
+
* @returns BaseResponse whose `data` is WorkflowsUpdateData
|
|
1073
|
+
*/
|
|
1074
|
+
update: (workflowsUid: number, data: WorkflowsUpdateBody) => Promise<BaseResponse<WorkflowsUpdateData>>;
|
|
1075
|
+
/**
|
|
1076
|
+
* Delete Workflow
|
|
1077
|
+
* Call: api.agrInfo.workflows.delete(workflowsUid)
|
|
1078
|
+
*
|
|
1079
|
+
* Errors:
|
|
1080
|
+
* 403: x-site-id is not augur_info: agr_info serves only the augur_info site.
|
|
1081
|
+
* 404: No workflow with this ID.
|
|
1082
|
+
*
|
|
1083
|
+
* DELETE https://agr-info.augur-api.com/workflows/{workflowsUid}
|
|
1084
|
+
* Contract:
|
|
1085
|
+
* https://agr-info.augur-api.com/openapi.json#/paths/~1workflows~1{workflowsUid}/delete
|
|
1086
|
+
*
|
|
1087
|
+
* @param workflowsUid Workflow ID
|
|
1088
|
+
* @returns BaseResponse whose `data` is WorkflowsDeleteData
|
|
1089
|
+
*/
|
|
1090
|
+
delete: (workflowsUid: number) => Promise<BaseResponse<WorkflowsDeleteData>>;
|
|
1091
|
+
};
|
|
1092
|
+
}
|
|
1093
|
+
//# sourceMappingURL=types.d.ts.map
|