@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,983 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated types for the open-search service.
|
|
3
|
+
* Product search engine powered by OpenSearch with autocomplete, faceted filtering, and query
|
|
4
|
+
* analytics
|
|
5
|
+
*
|
|
6
|
+
* Public specs (the source of truth for every shape below):
|
|
7
|
+
* https://open-search.augur-api.com/endpoints.jsonl: one JSON line per endpoint: method, path,
|
|
8
|
+
* path params and query params, each with type and required flag. Grep it for a path; for a
|
|
9
|
+
* GET that line is all you need. Bodies are not in it.
|
|
10
|
+
* https://open-search.augur-api.com/openapi.json: the full contract: request and response bodies
|
|
11
|
+
* field by field, descriptions, formats and documented errors.
|
|
12
|
+
* https://open-search.augur-api.com/llms.txt: the plain-text endpoint list and the other Augur
|
|
13
|
+
* services.
|
|
14
|
+
*
|
|
15
|
+
* Source: shared/specs/open-search.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 /item-search */
|
|
22
|
+
export interface ItemSearchListParams extends EdgeCacheParams {
|
|
23
|
+
/** list of inv_mast.class_id5 values to exclude (CSV) */
|
|
24
|
+
classId5ExcludeList?: string;
|
|
25
|
+
/** list of inv_mast.class_id5 values (CSV) */
|
|
26
|
+
classId5List?: string;
|
|
27
|
+
/** Filter by discontinued status [Y|N] */
|
|
28
|
+
discontinuedAny?: string;
|
|
29
|
+
/** list of fields to query (CSV) */
|
|
30
|
+
fields?: string;
|
|
31
|
+
/** A JSON representation of the filters [{attributeUid:attributeValueUid}] */
|
|
32
|
+
filters?: string;
|
|
33
|
+
/** return results starting FROM this index */
|
|
34
|
+
from?: number;
|
|
35
|
+
/** CSV is itemCategoryUids to limit search results */
|
|
36
|
+
itemCategoryUidList?: string;
|
|
37
|
+
/** A CSV of job numbers to filter */
|
|
38
|
+
jobNumbers?: string;
|
|
39
|
+
/** search operator [AND|OR] (Default: OR) */
|
|
40
|
+
operator?: string;
|
|
41
|
+
/** item_category_uid as parent with all children included */
|
|
42
|
+
parentCategoryUid?: number;
|
|
43
|
+
/** search query */
|
|
44
|
+
q: string;
|
|
45
|
+
/** Type of search: [similarity|query] (Default: query) */
|
|
46
|
+
searchType: string;
|
|
47
|
+
/** size of search results */
|
|
48
|
+
size?: number;
|
|
49
|
+
/**
|
|
50
|
+
* Comma-separated items index field|direction, snake_case (e.g., price1|asc,
|
|
51
|
+
* item_desc_keyword|asc, item_id|asc). Field MUST be a keyword or numeric field; text fields such
|
|
52
|
+
* as item_desc return 400. Empty or relevance sorts by relevance
|
|
53
|
+
*/
|
|
54
|
+
sort?: string;
|
|
55
|
+
/** list of source_fields to return (CSV) */
|
|
56
|
+
sourceFieldsList?: string;
|
|
57
|
+
/** Filter by stock status [in_stock|out_of_stock] */
|
|
58
|
+
stockStatus?: string;
|
|
59
|
+
/** A CSV of tags to filter */
|
|
60
|
+
tags?: string;
|
|
61
|
+
/** Y adds each item's Brand Folder document as brandFolder [Y|N] (Default: N) */
|
|
62
|
+
useBrandFolderDoc?: string;
|
|
63
|
+
/** Filter variants [primary_only] (Default: blank) */
|
|
64
|
+
variantFilter?: string;
|
|
65
|
+
}
|
|
66
|
+
/** Params for GET /item-search-facets */
|
|
67
|
+
export interface ItemSearchFacetsListParams extends EdgeCacheParams {
|
|
68
|
+
/** list of inv_mast.class_id5 values to exclude (CSV) */
|
|
69
|
+
classId5ExcludeList?: string;
|
|
70
|
+
/** list of inv_mast.class_id5 values (CSV) */
|
|
71
|
+
classId5List?: string;
|
|
72
|
+
/** Filter by discontinued status [Y|N] */
|
|
73
|
+
discontinuedAny?: string;
|
|
74
|
+
/** list of fields to query (CSV) */
|
|
75
|
+
fields?: string;
|
|
76
|
+
/** A JSON representation of the filters [[attributeUid,attributeValueUid]] */
|
|
77
|
+
filters?: string;
|
|
78
|
+
/** return results starting FROM this index (bounded by the facet window, see size) */
|
|
79
|
+
from?: number;
|
|
80
|
+
/** CSV of itemCategoryUids to limit search results */
|
|
81
|
+
itemCategoryUidList?: string;
|
|
82
|
+
/** A CSV of job numbers to filter */
|
|
83
|
+
jobNumbers?: string;
|
|
84
|
+
/** search operator [AND|OR] (Default: AND) */
|
|
85
|
+
operator?: string;
|
|
86
|
+
/** item_category_uid as parent with all children included */
|
|
87
|
+
parentCategoryUid?: number;
|
|
88
|
+
/** search query */
|
|
89
|
+
q: string;
|
|
90
|
+
/** Type of search: [similarity|query] (Default: query) */
|
|
91
|
+
searchType?: string;
|
|
92
|
+
/** page size, bounded by the facet window (RESULT_WINDOW = 200) */
|
|
93
|
+
size?: number;
|
|
94
|
+
/**
|
|
95
|
+
* Comma-separated items index field|direction, snake_case (e.g., price1|asc,
|
|
96
|
+
* item_desc_keyword|asc, item_id|asc); does not affect facet selection. Field MUST be a keyword
|
|
97
|
+
* or numeric field; text fields such as item_desc return 400. Empty or relevance sorts by
|
|
98
|
+
* relevance
|
|
99
|
+
*/
|
|
100
|
+
sort?: string;
|
|
101
|
+
/** unused: every item is already hydrated to the full inv_mast doc */
|
|
102
|
+
sourceFieldsList?: string;
|
|
103
|
+
/** Filter by stock status [in_stock|out_of_stock] */
|
|
104
|
+
stockStatus?: string;
|
|
105
|
+
/** A CSV of tags to filter */
|
|
106
|
+
tags?: string;
|
|
107
|
+
/** Include brand folder doc: [Y|N] (Default: N) */
|
|
108
|
+
useBrandFolderDoc?: string;
|
|
109
|
+
/** Filter variants [primary_only] (Default: blank) */
|
|
110
|
+
variantFilter?: string;
|
|
111
|
+
}
|
|
112
|
+
/** Params for GET /item-search/attributes */
|
|
113
|
+
export interface ItemSearchAttributesListParams extends EdgeCacheParams {
|
|
114
|
+
/** list of inv_mast.class_id5 values (CSV) */
|
|
115
|
+
classId5List?: string;
|
|
116
|
+
/** list of fields to query (CSV) */
|
|
117
|
+
fields?: string;
|
|
118
|
+
/** A JSON representation of the filters [{attributeUid:attributeValueUid}] */
|
|
119
|
+
filters?: string;
|
|
120
|
+
/** return results starting FROM this index */
|
|
121
|
+
from?: number;
|
|
122
|
+
/** search operator [AND|OR] (Default: OR) */
|
|
123
|
+
operator?: string;
|
|
124
|
+
/** search query */
|
|
125
|
+
q: string;
|
|
126
|
+
/** Type of search: [similarity|query] (Default: query) */
|
|
127
|
+
searchType: string;
|
|
128
|
+
/** size of search results */
|
|
129
|
+
size?: number;
|
|
130
|
+
/**
|
|
131
|
+
* Comma-separated items index field|direction, snake_case (e.g., price1|asc, item_id|asc). Empty
|
|
132
|
+
* or relevance sorts by relevance
|
|
133
|
+
*/
|
|
134
|
+
sort?: string;
|
|
135
|
+
/** list of source_fields to return (CSV) */
|
|
136
|
+
sourceFieldsList?: string;
|
|
137
|
+
}
|
|
138
|
+
/** Params for GET /items */
|
|
139
|
+
export interface ItemsListParams extends EdgeCacheParams {
|
|
140
|
+
/** Item ID prefix */
|
|
141
|
+
itemId?: string;
|
|
142
|
+
/** Limit number of results (Default: 10) */
|
|
143
|
+
limit?: number;
|
|
144
|
+
/** Starting offset results (Default: 0) */
|
|
145
|
+
offset?: number;
|
|
146
|
+
/** Online status [Y|N] */
|
|
147
|
+
online?: string;
|
|
148
|
+
/** Order By (Default: inv_mast_uid|ASC) */
|
|
149
|
+
orderBy?: string;
|
|
150
|
+
/**
|
|
151
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
152
|
+
* (704,705); -1 for every status. Default: every status
|
|
153
|
+
*/
|
|
154
|
+
statusCd?: number | number[];
|
|
155
|
+
}
|
|
156
|
+
/** Params for GET /items/{invMastUid} */
|
|
157
|
+
export type ItemsGetParams = EdgeCacheParams;
|
|
158
|
+
/** Params for GET /items/{invMastUid}/refresh */
|
|
159
|
+
export type ItemsRefreshGetParams = EdgeCacheParams;
|
|
160
|
+
/** Params for GET /query-string-redirect */
|
|
161
|
+
export interface QueryStringRedirectListParams extends EdgeCacheParams {
|
|
162
|
+
/** Limit number of results (Default: 10) */
|
|
163
|
+
limit?: number;
|
|
164
|
+
/** Starting offset results (Default: 0) */
|
|
165
|
+
offset?: number;
|
|
166
|
+
/** Order By (Default: query_string_redirect_uid|ASC) */
|
|
167
|
+
orderBy?: string;
|
|
168
|
+
/**
|
|
169
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
170
|
+
* (704,705); -1 for every status. Default: every status
|
|
171
|
+
*/
|
|
172
|
+
statusCd?: number | number[];
|
|
173
|
+
}
|
|
174
|
+
/** Params for GET /query-string-redirect/{queryStringRedirectUid} */
|
|
175
|
+
export type QueryStringRedirectGetParams = EdgeCacheParams;
|
|
176
|
+
/** Params for GET /suggestions */
|
|
177
|
+
export interface SuggestionsListParams extends EdgeCacheParams {
|
|
178
|
+
/** Limit number of results (Default: 10) */
|
|
179
|
+
limit?: number;
|
|
180
|
+
/** Starting offset results (Default: 0) */
|
|
181
|
+
offset?: number;
|
|
182
|
+
/** Order By (Default: suggestions_uid|ASC) */
|
|
183
|
+
orderBy?: string;
|
|
184
|
+
/** Process Code filter */
|
|
185
|
+
processCd?: number;
|
|
186
|
+
/** Search query string */
|
|
187
|
+
query?: string;
|
|
188
|
+
/** Query String UID filter */
|
|
189
|
+
queryStringUid?: number;
|
|
190
|
+
/**
|
|
191
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
192
|
+
* (704,705); -1 for every status. Default: every status
|
|
193
|
+
*/
|
|
194
|
+
statusCd?: number | number[];
|
|
195
|
+
}
|
|
196
|
+
/** Params for GET /suggestions/suggest */
|
|
197
|
+
export interface SuggestionsSuggestListParams extends EdgeCacheParams {
|
|
198
|
+
/** Limit number of results (Default: 10) */
|
|
199
|
+
limit?: number;
|
|
200
|
+
/** Starting offset results (Default: 0) */
|
|
201
|
+
offset?: number;
|
|
202
|
+
/** Search query string for autocomplete */
|
|
203
|
+
q?: string;
|
|
204
|
+
/**
|
|
205
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
206
|
+
* (704,705); -1 for every status. Default: every status
|
|
207
|
+
*/
|
|
208
|
+
statusCd?: number | number[];
|
|
209
|
+
}
|
|
210
|
+
/** Params for GET /suggestions/{suggestionsUid} */
|
|
211
|
+
export type SuggestionsGetParams = EdgeCacheParams;
|
|
212
|
+
/**
|
|
213
|
+
* Shape of `assets` (MINIMUM fields; reused wherever the same shape appears)
|
|
214
|
+
* Active assets linked to the item; the key is absent when the lookup failed
|
|
215
|
+
*
|
|
216
|
+
* Field `assets` of ItemSearchListDataItemsItemBrandFolder
|
|
217
|
+
*/
|
|
218
|
+
export interface ItemSearchListDataItemsItemBrandFolderAssetsItem {
|
|
219
|
+
/** Brandfolder asset ID */
|
|
220
|
+
id: string;
|
|
221
|
+
/** Asset name */
|
|
222
|
+
name: string | null;
|
|
223
|
+
/** First attachment's file name */
|
|
224
|
+
attachmentName: string | null;
|
|
225
|
+
/** CDN URL of the asset */
|
|
226
|
+
cdnLink: string;
|
|
227
|
+
/** Attachment layout (square when unknown) */
|
|
228
|
+
layout: string;
|
|
229
|
+
[key: string]: unknown;
|
|
230
|
+
}
|
|
231
|
+
/**
|
|
232
|
+
* Shape of `brandFolder` (MINIMUM fields; reused wherever the same shape appears)
|
|
233
|
+
* Brandfolder assets; the key is present only when useBrandFolderDoc=Y
|
|
234
|
+
*
|
|
235
|
+
* Field `brandFolder` of ItemSearchListDataItemsItem
|
|
236
|
+
* Field `brandFolder` of ItemSearchFacetsListDataItemsItem
|
|
237
|
+
*/
|
|
238
|
+
export interface ItemSearchListDataItemsItemBrandFolder {
|
|
239
|
+
/** Active assets linked to the item; the key is absent when the lookup failed */
|
|
240
|
+
assets?: ItemSearchListDataItemsItemBrandFolderAssetsItem[] | null;
|
|
241
|
+
[key: string]: unknown;
|
|
242
|
+
}
|
|
243
|
+
/**
|
|
244
|
+
* Shape of `items` (MINIMUM fields; reused wherever the same shape appears)
|
|
245
|
+
* Matching items for the requested page
|
|
246
|
+
*
|
|
247
|
+
* Field `items` of ItemSearchListData
|
|
248
|
+
*/
|
|
249
|
+
export interface ItemSearchListDataItemsItem {
|
|
250
|
+
/** Item (inv_mast) ID */
|
|
251
|
+
invMastUid: number;
|
|
252
|
+
/** Item ID */
|
|
253
|
+
itemId: string | null;
|
|
254
|
+
/** Item description */
|
|
255
|
+
itemDesc: string | null;
|
|
256
|
+
/** OpenSearch relevance score */
|
|
257
|
+
score: number | null;
|
|
258
|
+
/**
|
|
259
|
+
* Index source fields requested through sourceFieldsList, keyed by field name; null when the item
|
|
260
|
+
* has none
|
|
261
|
+
*/
|
|
262
|
+
sourceFields: Record<string, unknown> | null;
|
|
263
|
+
/** Relevance score truncated to an integer */
|
|
264
|
+
scoreInt: number;
|
|
265
|
+
/** Brandfolder assets; the key is present only when useBrandFolderDoc=Y */
|
|
266
|
+
brandFolder?: ItemSearchListDataItemsItemBrandFolder | null;
|
|
267
|
+
[key: string]: unknown;
|
|
268
|
+
}
|
|
269
|
+
/**
|
|
270
|
+
* Search items
|
|
271
|
+
* Response data for GET /item-search — MINIMUM fields, extras pass through
|
|
272
|
+
*
|
|
273
|
+
* Returned by: api.openSearch.itemSearch.list(params)
|
|
274
|
+
*/
|
|
275
|
+
export interface ItemSearchListData {
|
|
276
|
+
/** Matching items for the requested page */
|
|
277
|
+
items: ItemSearchListDataItemsItem[];
|
|
278
|
+
/** Total hits for the query */
|
|
279
|
+
totalResults: number;
|
|
280
|
+
/** Highest relevance score among the hits (0 when the search returned no metadata) */
|
|
281
|
+
maxScore: number | null;
|
|
282
|
+
/** OpenSearch query time in milliseconds */
|
|
283
|
+
took: number;
|
|
284
|
+
/** query_string row recorded for this search text (0 when not recorded) */
|
|
285
|
+
queryStringUid: number;
|
|
286
|
+
/** Redirect link configured for this search text, or null when none */
|
|
287
|
+
queryStringRedirectLink: string | null;
|
|
288
|
+
[key: string]: unknown;
|
|
289
|
+
}
|
|
290
|
+
/**
|
|
291
|
+
* Shape of `meta` (MINIMUM fields; reused wherever the same shape appears)
|
|
292
|
+
* Query time and hit totals
|
|
293
|
+
*
|
|
294
|
+
* Field `meta` of ItemSearchFacetsListData
|
|
295
|
+
*/
|
|
296
|
+
export interface ItemSearchFacetsListDataMeta {
|
|
297
|
+
/** OpenSearch query time in milliseconds */
|
|
298
|
+
took: number;
|
|
299
|
+
/** Total hits for the query, unfiltered by paging */
|
|
300
|
+
total: number;
|
|
301
|
+
/** Hits reachable through from/size (total capped at the result window) */
|
|
302
|
+
pageableTotal: number;
|
|
303
|
+
/** Highest relevance score, or null when the search was sorted */
|
|
304
|
+
maxScore: number | null;
|
|
305
|
+
[key: string]: unknown;
|
|
306
|
+
}
|
|
307
|
+
/**
|
|
308
|
+
* Shape of `items` (MINIMUM fields; reused wherever the same shape appears)
|
|
309
|
+
* Matching items for the requested page
|
|
310
|
+
*
|
|
311
|
+
* Field `items` of ItemSearchFacetsListData
|
|
312
|
+
*/
|
|
313
|
+
export interface ItemSearchFacetsListDataItemsItem {
|
|
314
|
+
/** OpenSearch relevance score, or null when the search was sorted */
|
|
315
|
+
score: number | null;
|
|
316
|
+
/** Brandfolder assets; the key is present only when useBrandFolderDoc=Y */
|
|
317
|
+
brandFolder?: ItemSearchListDataItemsItemBrandFolder | null;
|
|
318
|
+
[key: string]: unknown;
|
|
319
|
+
}
|
|
320
|
+
/**
|
|
321
|
+
* Shape of `values` (MINIMUM fields; reused wherever the same shape appears)
|
|
322
|
+
* Values with counts, highest count first
|
|
323
|
+
*
|
|
324
|
+
* Field `values` of ItemSearchFacetsListDataFacetsItem
|
|
325
|
+
*/
|
|
326
|
+
export interface ItemSearchFacetsListDataFacetsItemValuesItem {
|
|
327
|
+
/** attribute_value_uid to pass back in filters */
|
|
328
|
+
valueUid: number;
|
|
329
|
+
/** Attribute value text (empty when the value row is missing) */
|
|
330
|
+
label: string;
|
|
331
|
+
/** Value display sequence (0 when the value row is missing) */
|
|
332
|
+
sequence: number;
|
|
333
|
+
/** Items in the result set carrying this value */
|
|
334
|
+
count: number;
|
|
335
|
+
[key: string]: unknown;
|
|
336
|
+
}
|
|
337
|
+
/**
|
|
338
|
+
* Shape of `facets` (MINIMUM fields; reused wherever the same shape appears)
|
|
339
|
+
* Attribute facets, in attribute sequence order
|
|
340
|
+
*
|
|
341
|
+
* Field `facets` of ItemSearchFacetsListData
|
|
342
|
+
*/
|
|
343
|
+
export interface ItemSearchFacetsListDataFacetsItem {
|
|
344
|
+
/** attribute_uid of the facet */
|
|
345
|
+
attributeUid: number;
|
|
346
|
+
/** Attribute ID */
|
|
347
|
+
attributeId: string;
|
|
348
|
+
/** Attribute description shown as the facet heading */
|
|
349
|
+
label: string;
|
|
350
|
+
/** Facet display order: lowest attribute-group sequence (9999 when none) */
|
|
351
|
+
sequence: number;
|
|
352
|
+
/** Percent of the sampled top hits carrying this attribute, one decimal */
|
|
353
|
+
headCoveragePct: number;
|
|
354
|
+
/** Values with counts, highest count first */
|
|
355
|
+
values: ItemSearchFacetsListDataFacetsItemValuesItem[];
|
|
356
|
+
[key: string]: unknown;
|
|
357
|
+
}
|
|
358
|
+
/**
|
|
359
|
+
* Search items with self-filtering, result-set-derived facets
|
|
360
|
+
* Response data for GET /item-search-facets — MINIMUM fields, extras pass through
|
|
361
|
+
*
|
|
362
|
+
* Returned by: api.openSearch.itemSearchFacets.list(params)
|
|
363
|
+
*/
|
|
364
|
+
export interface ItemSearchFacetsListData {
|
|
365
|
+
/** Query time and hit totals */
|
|
366
|
+
meta: ItemSearchFacetsListDataMeta;
|
|
367
|
+
/** Matching items for the requested page */
|
|
368
|
+
items: ItemSearchFacetsListDataItemsItem[];
|
|
369
|
+
/** Attribute facets, in attribute sequence order */
|
|
370
|
+
facets: ItemSearchFacetsListDataFacetsItem[];
|
|
371
|
+
[key: string]: unknown;
|
|
372
|
+
}
|
|
373
|
+
/**
|
|
374
|
+
* Shape of `values` (MINIMUM fields; reused wherever the same shape appears)
|
|
375
|
+
* Values available in the result categories
|
|
376
|
+
*
|
|
377
|
+
* Field `values` of ItemSearchAttributesListDataAttributesItem
|
|
378
|
+
*/
|
|
379
|
+
export interface ItemSearchAttributesListDataAttributesItemValuesItem {
|
|
380
|
+
/** attribute_value row UID; pass it in the search filters param */
|
|
381
|
+
attributeValueUid: number;
|
|
382
|
+
/** Display text of the value */
|
|
383
|
+
attributeValue: string;
|
|
384
|
+
/** Display order within the attribute */
|
|
385
|
+
sequenceNo: number;
|
|
386
|
+
[key: string]: unknown;
|
|
387
|
+
}
|
|
388
|
+
/**
|
|
389
|
+
* Shape of `attributes` (MINIMUM fields; reused wherever the same shape appears)
|
|
390
|
+
* Filterable attributes, each with its values
|
|
391
|
+
*
|
|
392
|
+
* Field `attributes` of ItemSearchAttributesListData
|
|
393
|
+
*/
|
|
394
|
+
export interface ItemSearchAttributesListDataAttributesItem {
|
|
395
|
+
/** attribute row UID; pass it in the search filters param */
|
|
396
|
+
attributeUid: number;
|
|
397
|
+
/** P21 attribute ID */
|
|
398
|
+
attributeId: string;
|
|
399
|
+
/** Display name of the attribute */
|
|
400
|
+
attributeDesc: string | null;
|
|
401
|
+
/** Display order among the attributes; null when the attribute group sets none */
|
|
402
|
+
sequenceNo: number | null;
|
|
403
|
+
/** Values available in the result categories */
|
|
404
|
+
values: ItemSearchAttributesListDataAttributesItemValuesItem[];
|
|
405
|
+
/** Number of values */
|
|
406
|
+
valueCount: number;
|
|
407
|
+
[key: string]: unknown;
|
|
408
|
+
}
|
|
409
|
+
/**
|
|
410
|
+
* Get Attributes from Item Search
|
|
411
|
+
* Response data for GET /item-search/attributes — MINIMUM fields, extras pass through
|
|
412
|
+
*
|
|
413
|
+
* Returned by: api.openSearch.itemSearch.attributes.list(params)
|
|
414
|
+
*/
|
|
415
|
+
export interface ItemSearchAttributesListData {
|
|
416
|
+
/** Filterable attributes, each with its values */
|
|
417
|
+
attributes: ItemSearchAttributesListDataAttributesItem[];
|
|
418
|
+
[key: string]: unknown;
|
|
419
|
+
}
|
|
420
|
+
/**
|
|
421
|
+
* List items
|
|
422
|
+
* Response data for GET /items — MINIMUM fields, extras pass through
|
|
423
|
+
*
|
|
424
|
+
* Returned by: api.openSearch.items.list(params) (array items)
|
|
425
|
+
* Returned by: api.openSearch.items.get(invMastUid)
|
|
426
|
+
* Returned by: api.openSearch.items.update(invMastUid, data)
|
|
427
|
+
* Returned by: api.openSearch.items.refresh.get(invMastUid)
|
|
428
|
+
*/
|
|
429
|
+
export interface ItemsListItem {
|
|
430
|
+
/** P21 inv_mast row UID of the item */
|
|
431
|
+
invMastUid: number;
|
|
432
|
+
/** P21 item ID (inv_mast.item_id) (max 40 chars) */
|
|
433
|
+
itemId: string | null;
|
|
434
|
+
/** Y when the item is sold online and kept in the openSearch index [Y|N] (max 1 chars) */
|
|
435
|
+
online: string;
|
|
436
|
+
/** Marked items to have the search document (doc) rebuilt */
|
|
437
|
+
updateCd: number;
|
|
438
|
+
/**
|
|
439
|
+
* Search document JSON written to openSearch; over 500 bytes it is stored on EFS and this holds
|
|
440
|
+
* efs:{path}
|
|
441
|
+
*/
|
|
442
|
+
doc: string | null;
|
|
443
|
+
/** Marked items to have the index updated in openSearch */
|
|
444
|
+
indexCd: number;
|
|
445
|
+
/** Mapped to inv_mast.online_cd */
|
|
446
|
+
statusCd: number;
|
|
447
|
+
/** Mapped to inv_mast.status_cd, not really used */
|
|
448
|
+
processCd: number;
|
|
449
|
+
/** Check status of item in the openSearch index */
|
|
450
|
+
indexStatusCd: number;
|
|
451
|
+
/** MySQL datetime format: YYYY-MM-DD HH:mm:ss (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
452
|
+
dateCreated: string;
|
|
453
|
+
/** MySQL datetime format: YYYY-MM-DD HH:mm:ss (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
454
|
+
dateLastModified: string;
|
|
455
|
+
/** P21 inv_mast.class_id5 of the item (max 8 chars) */
|
|
456
|
+
classId5: string | null;
|
|
457
|
+
/** MySQL datetime format: YYYY-MM-DD HH:mm:ss (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
458
|
+
dateLastChecked: string;
|
|
459
|
+
/** Process the document to get the embedding */
|
|
460
|
+
embeddingCd: number;
|
|
461
|
+
/** Hash of the last built doc; null for deleted or inactive items (max 64 chars) */
|
|
462
|
+
docHash: string | null;
|
|
463
|
+
/** Hash of the doc last written to openSearch; null when not indexed (max 64 chars) */
|
|
464
|
+
indexHash: string | null;
|
|
465
|
+
/** Where doc is stored [rds|efs] (max 65 chars) */
|
|
466
|
+
location: string | null;
|
|
467
|
+
/** Stable ID assigned on first write, used to name the EFS doc file (max 36 chars) */
|
|
468
|
+
uuid: string | null;
|
|
469
|
+
[key: string]: unknown;
|
|
470
|
+
}
|
|
471
|
+
/** Returned by: api.openSearch.items.list(params) */
|
|
472
|
+
export type ItemsListData = ItemsListItem[];
|
|
473
|
+
/**
|
|
474
|
+
* refresh items
|
|
475
|
+
* Response data for PUT /items/refresh — MINIMUM fields, extras pass through
|
|
476
|
+
*
|
|
477
|
+
* Returned by: api.openSearch.items.refresh.update(data)
|
|
478
|
+
*/
|
|
479
|
+
export type ItemsRefreshUpdateData = boolean;
|
|
480
|
+
/**
|
|
481
|
+
* refresh items
|
|
482
|
+
* Request body for PUT /items/refresh — MINIMUM fields, extras pass through
|
|
483
|
+
*
|
|
484
|
+
* Request body of: api.openSearch.items.refresh.update(data)
|
|
485
|
+
*/
|
|
486
|
+
export interface ItemsRefreshUpdateBody {
|
|
487
|
+
/** Re-mark update_cd so each item's search document is rebuilt */
|
|
488
|
+
updateCd?: boolean;
|
|
489
|
+
/** Re-mark index_cd so each item is rewritten to the OpenSearch index */
|
|
490
|
+
indexCd?: boolean;
|
|
491
|
+
/** Re-mark process_cd so each item's status is reprocessed */
|
|
492
|
+
processCd?: boolean;
|
|
493
|
+
[key: string]: unknown;
|
|
494
|
+
}
|
|
495
|
+
/**
|
|
496
|
+
* get the item document
|
|
497
|
+
* Response data for GET /items/{invMastUid} — MINIMUM fields, extras pass through
|
|
498
|
+
*
|
|
499
|
+
* Returned by: api.openSearch.items.get(invMastUid)
|
|
500
|
+
*/
|
|
501
|
+
export type ItemsGetData = ItemsListItem;
|
|
502
|
+
/**
|
|
503
|
+
* update the item document
|
|
504
|
+
* Response data for PUT /items/{invMastUid} — MINIMUM fields, extras pass through
|
|
505
|
+
*
|
|
506
|
+
* Returned by: api.openSearch.items.update(invMastUid, data)
|
|
507
|
+
*/
|
|
508
|
+
export type ItemsUpdateData = ItemsListItem;
|
|
509
|
+
/**
|
|
510
|
+
* update the item document
|
|
511
|
+
* Request body for PUT /items/{invMastUid} — MINIMUM fields, extras pass through
|
|
512
|
+
*
|
|
513
|
+
* Request body of: api.openSearch.items.update(invMastUid, data)
|
|
514
|
+
*/
|
|
515
|
+
export interface ItemsUpdateBody {
|
|
516
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
517
|
+
statusCd?: number | null;
|
|
518
|
+
/** Process code; 704 queues the item for status reprocessing */
|
|
519
|
+
processCd?: number | null;
|
|
520
|
+
[key: string]: unknown;
|
|
521
|
+
}
|
|
522
|
+
/**
|
|
523
|
+
* refresh the item document
|
|
524
|
+
* Response data for GET /items/{invMastUid}/refresh — MINIMUM fields, extras pass through
|
|
525
|
+
*
|
|
526
|
+
* Returned by: api.openSearch.items.refresh.get(invMastUid)
|
|
527
|
+
*/
|
|
528
|
+
export type ItemsRefreshGetData = ItemsListItem;
|
|
529
|
+
/**
|
|
530
|
+
* List Query String Redirects
|
|
531
|
+
* Response data for GET /query-string-redirect — MINIMUM fields, extras pass through
|
|
532
|
+
*
|
|
533
|
+
* Returned by: api.openSearch.queryStringRedirect.list(params) (array items)
|
|
534
|
+
* Returned by: api.openSearch.queryStringRedirect.create(data)
|
|
535
|
+
* Returned by: api.openSearch.queryStringRedirect.get(queryStringRedirectUid)
|
|
536
|
+
* Returned by: api.openSearch.queryStringRedirect.update(queryStringRedirectUid, data)
|
|
537
|
+
* Returned by: api.openSearch.queryStringRedirect.delete(queryStringRedirectUid)
|
|
538
|
+
*/
|
|
539
|
+
export interface QueryStringRedirectListItem {
|
|
540
|
+
/** query_string_redirect row UID */
|
|
541
|
+
queryStringRedirectUid: number;
|
|
542
|
+
/** query_string row whose searches redirect */
|
|
543
|
+
queryStringUid: number;
|
|
544
|
+
/**
|
|
545
|
+
* Link returned to the storefront as queryStringRedirectLink when a search matches query_string
|
|
546
|
+
* (max 255 chars)
|
|
547
|
+
*/
|
|
548
|
+
queryStringRedirectLink: string;
|
|
549
|
+
/** MySQL datetime format: YYYY-MM-DD HH:mm:ss (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
550
|
+
dateCreated: string;
|
|
551
|
+
/** MySQL datetime format: YYYY-MM-DD HH:mm:ss (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
552
|
+
dateLastModified: string;
|
|
553
|
+
/** Update code: 1185 = Import Complete, 704 = needs processing */
|
|
554
|
+
updateCd: number;
|
|
555
|
+
/** Status code: 704 = Active, 705 = Inactive, 700 = Deleted */
|
|
556
|
+
statusCd: number;
|
|
557
|
+
/** Process code: 704 = Active, 705 = Inactive, 700 = Deleted, 1185 = Import Complete */
|
|
558
|
+
processCd: number;
|
|
559
|
+
/** Cleaned search text that triggers the redirect */
|
|
560
|
+
queryString: string | null;
|
|
561
|
+
[key: string]: unknown;
|
|
562
|
+
}
|
|
563
|
+
/** Returned by: api.openSearch.queryStringRedirect.list(params) */
|
|
564
|
+
export type QueryStringRedirectListData = QueryStringRedirectListItem[];
|
|
565
|
+
/**
|
|
566
|
+
* Create Query String Redirect
|
|
567
|
+
* Response data for POST /query-string-redirect — MINIMUM fields, extras pass through
|
|
568
|
+
*
|
|
569
|
+
* Returned by: api.openSearch.queryStringRedirect.create(data)
|
|
570
|
+
*/
|
|
571
|
+
export type QueryStringRedirectCreateData = QueryStringRedirectListItem;
|
|
572
|
+
/**
|
|
573
|
+
* Create Query String Redirect
|
|
574
|
+
* Request body for POST /query-string-redirect — MINIMUM fields, extras pass through
|
|
575
|
+
*
|
|
576
|
+
* Request body of: api.openSearch.queryStringRedirect.create(data)
|
|
577
|
+
*/
|
|
578
|
+
export interface QueryStringRedirectCreateBody {
|
|
579
|
+
/**
|
|
580
|
+
* Search text to redirect; registered as a query_string when new, and wins over queryStringUid
|
|
581
|
+
*/
|
|
582
|
+
queryString?: string | null;
|
|
583
|
+
/** Existing query_string_uid to redirect, used when queryString is absent */
|
|
584
|
+
queryStringUid?: number | null;
|
|
585
|
+
/** Link the search redirects to */
|
|
586
|
+
queryStringRedirectLink?: string | null;
|
|
587
|
+
[key: string]: unknown;
|
|
588
|
+
}
|
|
589
|
+
/**
|
|
590
|
+
* Get Query String Redirect Details
|
|
591
|
+
* Response data for GET /query-string-redirect/{queryStringRedirectUid} — MINIMUM fields, extras
|
|
592
|
+
* pass through
|
|
593
|
+
*
|
|
594
|
+
* Returned by: api.openSearch.queryStringRedirect.get(queryStringRedirectUid)
|
|
595
|
+
*/
|
|
596
|
+
export type QueryStringRedirectGetData = QueryStringRedirectListItem;
|
|
597
|
+
/**
|
|
598
|
+
* Update Query String Redirect
|
|
599
|
+
* Response data for PUT /query-string-redirect/{queryStringRedirectUid} — MINIMUM fields, extras
|
|
600
|
+
* pass through
|
|
601
|
+
*
|
|
602
|
+
* Returned by: api.openSearch.queryStringRedirect.update(queryStringRedirectUid, data)
|
|
603
|
+
*/
|
|
604
|
+
export type QueryStringRedirectUpdateData = QueryStringRedirectListItem;
|
|
605
|
+
/**
|
|
606
|
+
* Update Query String Redirect
|
|
607
|
+
* Request body for PUT /query-string-redirect/{queryStringRedirectUid} — MINIMUM fields, extras
|
|
608
|
+
* pass through
|
|
609
|
+
*
|
|
610
|
+
* Request body of: api.openSearch.queryStringRedirect.update(queryStringRedirectUid, data)
|
|
611
|
+
*/
|
|
612
|
+
export interface QueryStringRedirectUpdateBody {
|
|
613
|
+
/** New search text; registered as a query_string when new, and wins over queryStringUid */
|
|
614
|
+
queryString?: string | null;
|
|
615
|
+
/** Existing query_string_uid to redirect, used when queryString is absent */
|
|
616
|
+
queryStringUid?: number | null;
|
|
617
|
+
/** New link the search redirects to */
|
|
618
|
+
queryStringRedirectLink?: string | null;
|
|
619
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
620
|
+
statusCd?: number | null;
|
|
621
|
+
/** Process code */
|
|
622
|
+
processCd?: number | null;
|
|
623
|
+
/** Update code */
|
|
624
|
+
updateCd?: number | null;
|
|
625
|
+
[key: string]: unknown;
|
|
626
|
+
}
|
|
627
|
+
/**
|
|
628
|
+
* Soft Delete Query String Redirect
|
|
629
|
+
* Response data for DELETE /query-string-redirect/{queryStringRedirectUid} — MINIMUM fields, extras
|
|
630
|
+
* pass through
|
|
631
|
+
*
|
|
632
|
+
* Returned by: api.openSearch.queryStringRedirect.delete(queryStringRedirectUid)
|
|
633
|
+
*/
|
|
634
|
+
export type QueryStringRedirectDeleteData = QueryStringRedirectListItem;
|
|
635
|
+
/**
|
|
636
|
+
* List Suggestions
|
|
637
|
+
* Response data for GET /suggestions — MINIMUM fields, extras pass through
|
|
638
|
+
*
|
|
639
|
+
* Returned by: api.openSearch.suggestions.list(params) (array items)
|
|
640
|
+
* Returned by: api.openSearch.suggestions.get(suggestionsUid)
|
|
641
|
+
*/
|
|
642
|
+
export interface SuggestionsListItem {
|
|
643
|
+
/** suggestions row UID */
|
|
644
|
+
suggestionsUid: number;
|
|
645
|
+
/** query_string row this suggestion was built from */
|
|
646
|
+
queryStringUid: number;
|
|
647
|
+
/** Suggested search text (max 255 chars) */
|
|
648
|
+
suggestionsString: string;
|
|
649
|
+
/** Metaphone key per word, used for sound-alike matching (max 255 chars) */
|
|
650
|
+
suggestionsMetaphone: string | null;
|
|
651
|
+
/** Average openSearch hit count for this text */
|
|
652
|
+
avgTotalResults: number;
|
|
653
|
+
/** MySQL datetime format: YYYY-MM-DD HH:mm:ss (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
654
|
+
dateCreated: string;
|
|
655
|
+
/** MySQL datetime format: YYYY-MM-DD HH:mm:ss (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
656
|
+
dateLastModified: string;
|
|
657
|
+
/** Update code: 1185 = Import Complete, 704 = needs processing */
|
|
658
|
+
updateCd: number;
|
|
659
|
+
/** Status code: 704 = Active, 705 = Inactive, 700 = Deleted */
|
|
660
|
+
statusCd: number;
|
|
661
|
+
/** Process code: 704 = Active, 705 = Inactive, 700 = Deleted, 1185 = Import Complete */
|
|
662
|
+
processCd: number;
|
|
663
|
+
[key: string]: unknown;
|
|
664
|
+
}
|
|
665
|
+
/** Returned by: api.openSearch.suggestions.list(params) */
|
|
666
|
+
export type SuggestionsListData = SuggestionsListItem[];
|
|
667
|
+
/**
|
|
668
|
+
* Get search suggestions for autocomplete
|
|
669
|
+
* Response data for GET /suggestions/suggest — MINIMUM fields, extras pass through
|
|
670
|
+
*
|
|
671
|
+
* Returned by: api.openSearch.suggestions.suggest.list(params) (array items)
|
|
672
|
+
*/
|
|
673
|
+
export interface SuggestionsSuggestListItem {
|
|
674
|
+
/** Suggestion row UID */
|
|
675
|
+
suggestionsUid: number;
|
|
676
|
+
/** query_string row this suggestion was built from */
|
|
677
|
+
queryStringUid: number;
|
|
678
|
+
/** Suggested search text; underscores shown as dashes */
|
|
679
|
+
suggestionsString: string;
|
|
680
|
+
/** Metaphone key per word, used for sound-alike matching */
|
|
681
|
+
suggestionsMetaphone: string | null;
|
|
682
|
+
/** Average OpenSearch hit count for this text; one suggestion is kept per value */
|
|
683
|
+
avgTotalResults: number;
|
|
684
|
+
/** When the suggestion was created (YYYY-MM-DD HH:mm:ss) */
|
|
685
|
+
dateCreated: string;
|
|
686
|
+
/** When the suggestion last changed (YYYY-MM-DD HH:mm:ss) */
|
|
687
|
+
dateLastModified: string;
|
|
688
|
+
/** Update code */
|
|
689
|
+
updateCd: number;
|
|
690
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
691
|
+
statusCd: number;
|
|
692
|
+
/** Process code */
|
|
693
|
+
processCd: number;
|
|
694
|
+
/** Rank: prefix, exact-word and metaphone matches, plus avgTotalResults; highest first */
|
|
695
|
+
score: number;
|
|
696
|
+
[key: string]: unknown;
|
|
697
|
+
}
|
|
698
|
+
/** Returned by: api.openSearch.suggestions.suggest.list(params) */
|
|
699
|
+
export type SuggestionsSuggestListData = SuggestionsSuggestListItem[];
|
|
700
|
+
/**
|
|
701
|
+
* Get Suggestion Details
|
|
702
|
+
* Response data for GET /suggestions/{suggestionsUid} — MINIMUM fields, extras pass through
|
|
703
|
+
*
|
|
704
|
+
* Returned by: api.openSearch.suggestions.get(suggestionsUid)
|
|
705
|
+
*/
|
|
706
|
+
export type SuggestionsGetData = SuggestionsListItem;
|
|
707
|
+
export interface OpenSearchClientSpec {
|
|
708
|
+
itemSearch: {
|
|
709
|
+
/**
|
|
710
|
+
* Search items
|
|
711
|
+
* Call: api.openSearch.itemSearch.list(params)
|
|
712
|
+
*
|
|
713
|
+
* Search the items index by text or similarity, with attribute, category and stock filters,
|
|
714
|
+
* sorting and paging; returns the matching items and hit totals
|
|
715
|
+
*
|
|
716
|
+
* Response data: Item search results with hit totals and the query string's redirect (GET
|
|
717
|
+
* /api/item-search)
|
|
718
|
+
*
|
|
719
|
+
* Errors:
|
|
720
|
+
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
721
|
+
*
|
|
722
|
+
* GET https://open-search.augur-api.com/item-search
|
|
723
|
+
* Contract: https://open-search.augur-api.com/openapi.json#/paths/~1item-search/get
|
|
724
|
+
*
|
|
725
|
+
* @param params ItemSearchListParams (query string)
|
|
726
|
+
* @returns BaseResponse whose `data` is ItemSearchListData
|
|
727
|
+
*/
|
|
728
|
+
list: (params?: ItemSearchListParams) => Promise<BaseResponse<ItemSearchListData>>;
|
|
729
|
+
attributes: {
|
|
730
|
+
/**
|
|
731
|
+
* Get Attributes from Item Search
|
|
732
|
+
* Call: api.openSearch.itemSearch.attributes.list(params)
|
|
733
|
+
*
|
|
734
|
+
* Response data: Attributes available to filter a search, from the categories its results
|
|
735
|
+
* fall in (GET /api/item-search/attributes)
|
|
736
|
+
*
|
|
737
|
+
* GET https://open-search.augur-api.com/item-search/attributes
|
|
738
|
+
* Contract:
|
|
739
|
+
* https://open-search.augur-api.com/openapi.json#/paths/~1item-search~1attributes/get
|
|
740
|
+
*
|
|
741
|
+
* @param params ItemSearchAttributesListParams (query string)
|
|
742
|
+
* @returns BaseResponse whose `data` is ItemSearchAttributesListData
|
|
743
|
+
*/
|
|
744
|
+
list: (params?: ItemSearchAttributesListParams) => Promise<BaseResponse<ItemSearchAttributesListData>>;
|
|
745
|
+
};
|
|
746
|
+
};
|
|
747
|
+
itemSearchFacets: {
|
|
748
|
+
/**
|
|
749
|
+
* Search items with self-filtering, result-set-derived facets
|
|
750
|
+
* Call: api.openSearch.itemSearchFacets.list(params)
|
|
751
|
+
*
|
|
752
|
+
* Response data: Faceted item search: the page of hydrated items, hit metadata, and attribute
|
|
753
|
+
* facets (GET /api/item-search-facets)
|
|
754
|
+
*
|
|
755
|
+
* Errors:
|
|
756
|
+
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
757
|
+
*
|
|
758
|
+
* GET https://open-search.augur-api.com/item-search-facets
|
|
759
|
+
* Contract: https://open-search.augur-api.com/openapi.json#/paths/~1item-search-facets/get
|
|
760
|
+
*
|
|
761
|
+
* @param params ItemSearchFacetsListParams (query string)
|
|
762
|
+
* @returns BaseResponse whose `data` is ItemSearchFacetsListData
|
|
763
|
+
*/
|
|
764
|
+
list: (params?: ItemSearchFacetsListParams) => Promise<BaseResponse<ItemSearchFacetsListData>>;
|
|
765
|
+
};
|
|
766
|
+
items: {
|
|
767
|
+
/**
|
|
768
|
+
* List items
|
|
769
|
+
* Call: api.openSearch.items.list(params)
|
|
770
|
+
*
|
|
771
|
+
* Errors:
|
|
772
|
+
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
773
|
+
*
|
|
774
|
+
* GET https://open-search.augur-api.com/items
|
|
775
|
+
* Contract: https://open-search.augur-api.com/openapi.json#/paths/~1items/get
|
|
776
|
+
*
|
|
777
|
+
* @param params ItemsListParams (query string)
|
|
778
|
+
* @returns BaseResponse whose `data` is ItemsListData
|
|
779
|
+
*/
|
|
780
|
+
list: (params?: ItemsListParams) => Promise<BaseResponse<ItemsListData>>;
|
|
781
|
+
/**
|
|
782
|
+
* get the item document
|
|
783
|
+
* Call: api.openSearch.items.get(invMastUid)
|
|
784
|
+
*
|
|
785
|
+
* Errors:
|
|
786
|
+
* 404: No items row exists with this inv_mast_uid.
|
|
787
|
+
*
|
|
788
|
+
* GET https://open-search.augur-api.com/items/{invMastUid}
|
|
789
|
+
* Contract: https://open-search.augur-api.com/openapi.json#/paths/~1items~1{invMastUid}/get
|
|
790
|
+
*
|
|
791
|
+
* @param invMastUid inv_mast.inv_mast_uid
|
|
792
|
+
* @param params ItemsGetParams (query string)
|
|
793
|
+
* @returns BaseResponse whose `data` is ItemsGetData
|
|
794
|
+
*/
|
|
795
|
+
get: (invMastUid: number, params?: ItemsGetParams) => Promise<BaseResponse<ItemsGetData>>;
|
|
796
|
+
/**
|
|
797
|
+
* update the item document
|
|
798
|
+
* Call: api.openSearch.items.update(invMastUid, data)
|
|
799
|
+
*
|
|
800
|
+
* Request body: Partial update of an items row; only the status and process codes are writable,
|
|
801
|
+
* an absent field keeps its value
|
|
802
|
+
*
|
|
803
|
+
* Errors:
|
|
804
|
+
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
805
|
+
* 404: No row exists with this UID.
|
|
806
|
+
*
|
|
807
|
+
* PUT https://open-search.augur-api.com/items/{invMastUid}
|
|
808
|
+
* Contract: https://open-search.augur-api.com/openapi.json#/paths/~1items~1{invMastUid}/put
|
|
809
|
+
*
|
|
810
|
+
* @param invMastUid inv_mast.inv_mast_uid
|
|
811
|
+
* @param data ItemsUpdateBody (request body)
|
|
812
|
+
* @returns BaseResponse whose `data` is ItemsUpdateData
|
|
813
|
+
*/
|
|
814
|
+
update: (invMastUid: number, data: ItemsUpdateBody) => Promise<BaseResponse<ItemsUpdateData>>;
|
|
815
|
+
refresh: {
|
|
816
|
+
/**
|
|
817
|
+
* refresh items
|
|
818
|
+
* Call: api.openSearch.items.refresh.update(data)
|
|
819
|
+
*
|
|
820
|
+
* Request body: Choose which item queues to re-mark for reprocessing; every flag defaults to
|
|
821
|
+
* true and is skipped only when sent as false
|
|
822
|
+
*
|
|
823
|
+
* PUT https://open-search.augur-api.com/items/refresh
|
|
824
|
+
* Contract: https://open-search.augur-api.com/openapi.json#/paths/~1items~1refresh/put
|
|
825
|
+
*
|
|
826
|
+
* @param data ItemsRefreshUpdateBody (request body)
|
|
827
|
+
* @returns BaseResponse whose `data` is ItemsRefreshUpdateData
|
|
828
|
+
*/
|
|
829
|
+
update: (data: ItemsRefreshUpdateBody) => Promise<BaseResponse<ItemsRefreshUpdateData>>;
|
|
830
|
+
/**
|
|
831
|
+
* refresh the item document
|
|
832
|
+
* Call: api.openSearch.items.refresh.get(invMastUid)
|
|
833
|
+
*
|
|
834
|
+
* Errors:
|
|
835
|
+
* 404: No items row exists with this inv_mast_uid.
|
|
836
|
+
*
|
|
837
|
+
* GET https://open-search.augur-api.com/items/{invMastUid}/refresh
|
|
838
|
+
* Contract:
|
|
839
|
+
* https://open-search.augur-api.com/openapi.json#/paths/~1items~1{invMastUid}~1refresh/get
|
|
840
|
+
*
|
|
841
|
+
* @param invMastUid inv_mast.inv_mast_uid
|
|
842
|
+
* @param params ItemsRefreshGetParams (query string)
|
|
843
|
+
* @returns BaseResponse whose `data` is ItemsRefreshGetData
|
|
844
|
+
*/
|
|
845
|
+
get: (invMastUid: number, params?: ItemsRefreshGetParams) => Promise<BaseResponse<ItemsRefreshGetData>>;
|
|
846
|
+
};
|
|
847
|
+
};
|
|
848
|
+
queryStringRedirect: {
|
|
849
|
+
/**
|
|
850
|
+
* List Query String Redirects
|
|
851
|
+
* Call: api.openSearch.queryStringRedirect.list(params)
|
|
852
|
+
*
|
|
853
|
+
* Errors:
|
|
854
|
+
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
855
|
+
*
|
|
856
|
+
* GET https://open-search.augur-api.com/query-string-redirect
|
|
857
|
+
* Contract: https://open-search.augur-api.com/openapi.json#/paths/~1query-string-redirect/get
|
|
858
|
+
*
|
|
859
|
+
* @param params QueryStringRedirectListParams (query string)
|
|
860
|
+
* @returns BaseResponse whose `data` is QueryStringRedirectListData
|
|
861
|
+
*/
|
|
862
|
+
list: (params?: QueryStringRedirectListParams) => Promise<BaseResponse<QueryStringRedirectListData>>;
|
|
863
|
+
/**
|
|
864
|
+
* Create Query String Redirect
|
|
865
|
+
* Call: api.openSearch.queryStringRedirect.create(data)
|
|
866
|
+
*
|
|
867
|
+
* Request body: Create a redirect from a search query string to a page; an absent field takes
|
|
868
|
+
* the helper's default
|
|
869
|
+
*
|
|
870
|
+
* Success status: 201 (not 200)
|
|
871
|
+
*
|
|
872
|
+
* Errors:
|
|
873
|
+
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
874
|
+
*
|
|
875
|
+
* POST https://open-search.augur-api.com/query-string-redirect
|
|
876
|
+
* Contract: https://open-search.augur-api.com/openapi.json#/paths/~1query-string-redirect/post
|
|
877
|
+
*
|
|
878
|
+
* @param data QueryStringRedirectCreateBody (request body)
|
|
879
|
+
* @returns BaseResponse whose `data` is QueryStringRedirectCreateData
|
|
880
|
+
*/
|
|
881
|
+
create: (data: QueryStringRedirectCreateBody) => Promise<BaseResponse<QueryStringRedirectCreateData>>;
|
|
882
|
+
/**
|
|
883
|
+
* Get Query String Redirect Details
|
|
884
|
+
* Call: api.openSearch.queryStringRedirect.get(queryStringRedirectUid)
|
|
885
|
+
*
|
|
886
|
+
* Errors:
|
|
887
|
+
* 404: No query_string_redirect row with this queryStringRedirectUid.
|
|
888
|
+
*
|
|
889
|
+
* GET https://open-search.augur-api.com/query-string-redirect/{queryStringRedirectUid}
|
|
890
|
+
* Contract:
|
|
891
|
+
* https://open-search.augur-api.com/openapi.json#/paths/~1query-string-redirect~1{queryStringRedirectUid}/get
|
|
892
|
+
*
|
|
893
|
+
* @param queryStringRedirectUid query_string_redirect row UID
|
|
894
|
+
* @param params QueryStringRedirectGetParams (query string)
|
|
895
|
+
* @returns BaseResponse whose `data` is QueryStringRedirectGetData
|
|
896
|
+
*/
|
|
897
|
+
get: (queryStringRedirectUid: number, params?: QueryStringRedirectGetParams) => Promise<BaseResponse<QueryStringRedirectGetData>>;
|
|
898
|
+
/**
|
|
899
|
+
* Update Query String Redirect
|
|
900
|
+
* Call: api.openSearch.queryStringRedirect.update(queryStringRedirectUid, data)
|
|
901
|
+
*
|
|
902
|
+
* Request body: Partial update of a query string redirect; an absent field keeps its current
|
|
903
|
+
* value
|
|
904
|
+
*
|
|
905
|
+
* Errors:
|
|
906
|
+
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
907
|
+
* 404: No row exists with this UID.
|
|
908
|
+
*
|
|
909
|
+
* PUT https://open-search.augur-api.com/query-string-redirect/{queryStringRedirectUid}
|
|
910
|
+
* Contract:
|
|
911
|
+
* https://open-search.augur-api.com/openapi.json#/paths/~1query-string-redirect~1{queryStringRedirectUid}/put
|
|
912
|
+
*
|
|
913
|
+
* @param queryStringRedirectUid query_string_redirect row UID
|
|
914
|
+
* @param data QueryStringRedirectUpdateBody (request body)
|
|
915
|
+
* @returns BaseResponse whose `data` is QueryStringRedirectUpdateData
|
|
916
|
+
*/
|
|
917
|
+
update: (queryStringRedirectUid: number, data: QueryStringRedirectUpdateBody) => Promise<BaseResponse<QueryStringRedirectUpdateData>>;
|
|
918
|
+
/**
|
|
919
|
+
* Soft Delete Query String Redirect
|
|
920
|
+
* Call: api.openSearch.queryStringRedirect.delete(queryStringRedirectUid)
|
|
921
|
+
*
|
|
922
|
+
* Errors:
|
|
923
|
+
* 404: No row exists with this UID.
|
|
924
|
+
*
|
|
925
|
+
* DELETE https://open-search.augur-api.com/query-string-redirect/{queryStringRedirectUid}
|
|
926
|
+
* Contract:
|
|
927
|
+
* https://open-search.augur-api.com/openapi.json#/paths/~1query-string-redirect~1{queryStringRedirectUid}/delete
|
|
928
|
+
*
|
|
929
|
+
* @param queryStringRedirectUid query_string_redirect row UID
|
|
930
|
+
* @returns BaseResponse whose `data` is QueryStringRedirectDeleteData
|
|
931
|
+
*/
|
|
932
|
+
delete: (queryStringRedirectUid: number) => Promise<BaseResponse<QueryStringRedirectDeleteData>>;
|
|
933
|
+
};
|
|
934
|
+
suggestions: {
|
|
935
|
+
/**
|
|
936
|
+
* List Suggestions
|
|
937
|
+
* Call: api.openSearch.suggestions.list(params)
|
|
938
|
+
*
|
|
939
|
+
* Errors:
|
|
940
|
+
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
941
|
+
*
|
|
942
|
+
* GET https://open-search.augur-api.com/suggestions
|
|
943
|
+
* Contract: https://open-search.augur-api.com/openapi.json#/paths/~1suggestions/get
|
|
944
|
+
*
|
|
945
|
+
* @param params SuggestionsListParams (query string)
|
|
946
|
+
* @returns BaseResponse whose `data` is SuggestionsListData
|
|
947
|
+
*/
|
|
948
|
+
list: (params?: SuggestionsListParams) => Promise<BaseResponse<SuggestionsListData>>;
|
|
949
|
+
/**
|
|
950
|
+
* Get Suggestion Details
|
|
951
|
+
* Call: api.openSearch.suggestions.get(suggestionsUid)
|
|
952
|
+
*
|
|
953
|
+
* Errors:
|
|
954
|
+
* 404: No row exists with this UID.
|
|
955
|
+
*
|
|
956
|
+
* GET https://open-search.augur-api.com/suggestions/{suggestionsUid}
|
|
957
|
+
* Contract:
|
|
958
|
+
* https://open-search.augur-api.com/openapi.json#/paths/~1suggestions~1{suggestionsUid}/get
|
|
959
|
+
*
|
|
960
|
+
* @param suggestionsUid suggestions row UID
|
|
961
|
+
* @param params SuggestionsGetParams (query string)
|
|
962
|
+
* @returns BaseResponse whose `data` is SuggestionsGetData
|
|
963
|
+
*/
|
|
964
|
+
get: (suggestionsUid: number, params?: SuggestionsGetParams) => Promise<BaseResponse<SuggestionsGetData>>;
|
|
965
|
+
suggest: {
|
|
966
|
+
/**
|
|
967
|
+
* Get search suggestions for autocomplete
|
|
968
|
+
* Call: api.openSearch.suggestions.suggest.list(params)
|
|
969
|
+
*
|
|
970
|
+
* Response data, each item: One search-term suggestion from GET /api/suggestions/suggest,
|
|
971
|
+
* ranked by how well it matches the typed query
|
|
972
|
+
*
|
|
973
|
+
* GET https://open-search.augur-api.com/suggestions/suggest
|
|
974
|
+
* Contract: https://open-search.augur-api.com/openapi.json#/paths/~1suggestions~1suggest/get
|
|
975
|
+
*
|
|
976
|
+
* @param params SuggestionsSuggestListParams (query string)
|
|
977
|
+
* @returns BaseResponse whose `data` is SuggestionsSuggestListData
|
|
978
|
+
*/
|
|
979
|
+
list: (params?: SuggestionsSuggestListParams) => Promise<BaseResponse<SuggestionsSuggestListData>>;
|
|
980
|
+
};
|
|
981
|
+
};
|
|
982
|
+
}
|
|
983
|
+
//# sourceMappingURL=types.d.ts.map
|