@simpleapps-com/augur-api 2026.10.31 → 2026.11.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- 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 +19875 -18513
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +19874 -18513
- 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-TPJa269Y.d.mts +0 -58610
- package/dist/client-TPJa269Y.d.ts +0 -58610
- package/dist/index.d.mts +0 -236
- package/dist/testing.d.mts +0 -83
|
@@ -0,0 +1,1454 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated types for the legacy service.
|
|
3
|
+
* Legacy Prophet 21 data mirror for inventory, customers, orders, pricing, and product attributes
|
|
4
|
+
*
|
|
5
|
+
* Public specs (the source of truth for every shape below):
|
|
6
|
+
* https://legacy.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://legacy.augur-api.com/openapi.json: the full contract: request and response bodies field
|
|
10
|
+
* by field, descriptions, formats and documented errors.
|
|
11
|
+
* https://legacy.augur-api.com/llms.txt: the plain-text endpoint list and the other Augur
|
|
12
|
+
* services.
|
|
13
|
+
*
|
|
14
|
+
* Source: shared/specs/legacy.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 /inv-mast/{invMastUid}/also-bought */
|
|
21
|
+
export interface InvMastAlsoBoughtListParams extends EdgeCacheParams {
|
|
22
|
+
/**
|
|
23
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
24
|
+
* (704,705); -1 for every status. Default: every status
|
|
25
|
+
*/
|
|
26
|
+
statusCd?: number | number[];
|
|
27
|
+
}
|
|
28
|
+
/** Params for GET /inv-mast/{invMastUid}/tags */
|
|
29
|
+
export interface InvMastTagsListParams extends EdgeCacheParams {
|
|
30
|
+
/** Maximum rows to return (Default: 10) */
|
|
31
|
+
limit?: number;
|
|
32
|
+
/** Starting offset results (Default: 0) */
|
|
33
|
+
offset?: number;
|
|
34
|
+
/** Order By (Default: inv_mast_tags_uid|ASC) */
|
|
35
|
+
orderBy?: string;
|
|
36
|
+
/**
|
|
37
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
38
|
+
* (704,705); -1 for every status. Default: every status
|
|
39
|
+
*/
|
|
40
|
+
statusCd?: number | number[];
|
|
41
|
+
}
|
|
42
|
+
/** Params for GET /inv-mast/{invMastUid}/tags/{invMastTagsUid} */
|
|
43
|
+
export type InvMastTagsGetParams = EdgeCacheParams;
|
|
44
|
+
/** Params for GET /inv-mast/{invMastUid}/web-desc */
|
|
45
|
+
export interface InvMastWebDescListParams extends EdgeCacheParams {
|
|
46
|
+
/** Limit number of results (Default: 10) */
|
|
47
|
+
limit?: number;
|
|
48
|
+
/** Starting offset results (Default: 0) */
|
|
49
|
+
offset?: number;
|
|
50
|
+
/** Order By (Default: inv_mast_web_desc_uid|ASC) */
|
|
51
|
+
orderBy?: string;
|
|
52
|
+
/** Text matched (LIKE) against any of the web description fields */
|
|
53
|
+
q?: string;
|
|
54
|
+
/**
|
|
55
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
56
|
+
* (704,705); -1 for every status. Default: 704
|
|
57
|
+
*/
|
|
58
|
+
statusCd?: number | number[];
|
|
59
|
+
}
|
|
60
|
+
/** Params for GET /inv-mast/{invMastUid}/web-desc/{invMastWebDescUid} */
|
|
61
|
+
export type InvMastWebDescGetParams = EdgeCacheParams;
|
|
62
|
+
/** Params for GET /item-category/{itemCategoryUid} */
|
|
63
|
+
export type ItemCategoryGetParams = EdgeCacheParams;
|
|
64
|
+
/** Params for GET /legacy/state */
|
|
65
|
+
export interface LegacyStateListParams extends EdgeCacheParams {
|
|
66
|
+
/** Filter by active flag (1 = active, 0 = inactive) */
|
|
67
|
+
active?: number;
|
|
68
|
+
/** Filter by country */
|
|
69
|
+
countryUid?: number;
|
|
70
|
+
/** Maximum rows to return (Default: 10) */
|
|
71
|
+
limit?: number;
|
|
72
|
+
/** Starting offset results (Default: 0) */
|
|
73
|
+
offset?: number;
|
|
74
|
+
/** Order By (Default: state_uid|ASC) */
|
|
75
|
+
orderBy?: string;
|
|
76
|
+
/**
|
|
77
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
78
|
+
* (704,705); -1 for every status. Default: every status
|
|
79
|
+
*/
|
|
80
|
+
statusCd?: number | number[];
|
|
81
|
+
/** State Abbreviation */
|
|
82
|
+
twoLetterCode?: string;
|
|
83
|
+
}
|
|
84
|
+
/** Params for GET /legacy/state/{stateUid} */
|
|
85
|
+
export interface LegacyStateGetParams extends EdgeCacheParams {
|
|
86
|
+
/** State Abbreviation */
|
|
87
|
+
twoLetterCode?: string;
|
|
88
|
+
}
|
|
89
|
+
/** Params for GET /saved-carts */
|
|
90
|
+
export interface SavedCartsListParams extends EdgeCacheParams {
|
|
91
|
+
/** Maximum rows to return (Default: 10) */
|
|
92
|
+
limit?: number;
|
|
93
|
+
/** Starting offset results (Default: 0) */
|
|
94
|
+
offset?: number;
|
|
95
|
+
/** Order By (Default: user_id|ASC) */
|
|
96
|
+
orderBy?: string;
|
|
97
|
+
/**
|
|
98
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
99
|
+
* (704,705); -1 for every status. Default: every status
|
|
100
|
+
*/
|
|
101
|
+
statusCd?: number | number[];
|
|
102
|
+
/** Joomla user ID (joomla.users.id) that owns the cart */
|
|
103
|
+
userId?: number;
|
|
104
|
+
}
|
|
105
|
+
/** Params for GET /saved-carts/{id} */
|
|
106
|
+
export type SavedCartsGetParams = EdgeCacheParams;
|
|
107
|
+
/** Params for GET /saved-carts/{id}/items */
|
|
108
|
+
export interface SavedCartsItemsListParams extends EdgeCacheParams {
|
|
109
|
+
/** Maximum rows to return (Default: 10) */
|
|
110
|
+
limit?: number;
|
|
111
|
+
/** Starting offset results (Default: 0) */
|
|
112
|
+
offset?: number;
|
|
113
|
+
/** Order By (Default: saved_carts_items_uid|ASC) */
|
|
114
|
+
orderBy?: string;
|
|
115
|
+
/**
|
|
116
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
117
|
+
* (704,705); -1 for every status. Default: every status
|
|
118
|
+
*/
|
|
119
|
+
statusCd?: number | number[];
|
|
120
|
+
}
|
|
121
|
+
/**
|
|
122
|
+
* Shape of `inventorySupplier` (MINIMUM fields; reused wherever the same shape appears)
|
|
123
|
+
* The item's suppliers (not deleted)
|
|
124
|
+
*
|
|
125
|
+
* Field `inventorySupplier` of InvMastAlsoBoughtListItem
|
|
126
|
+
*/
|
|
127
|
+
export interface InvMastAlsoBoughtListItemInventorySupplierItem {
|
|
128
|
+
/** Item supplier ID */
|
|
129
|
+
inventorySupplierUid: number;
|
|
130
|
+
/** Item (inv_mast) supplied */
|
|
131
|
+
invMastUid: number;
|
|
132
|
+
/** Supplier ID */
|
|
133
|
+
supplierId: number;
|
|
134
|
+
/** Supplier UPC code; empty when none (max 14 chars) */
|
|
135
|
+
upcCode: string;
|
|
136
|
+
/** UPC check digit (P21 decimal(1,0)); null when none */
|
|
137
|
+
checkDigit: number | null;
|
|
138
|
+
/** upcCode followed by checkDigit */
|
|
139
|
+
upc: string;
|
|
140
|
+
/** Supplier part number (max 40 chars) */
|
|
141
|
+
supplierPartNo: string | null;
|
|
142
|
+
/** Y when this is the item's primary supplier (max 1 chars) */
|
|
143
|
+
primarySupplierFlag: string | null;
|
|
144
|
+
/** Supplier list price */
|
|
145
|
+
listPrice: number | null;
|
|
146
|
+
[key: string]: unknown;
|
|
147
|
+
}
|
|
148
|
+
/**
|
|
149
|
+
* Shape of `itemUom` (MINIMUM fields; reused wherever the same shape appears)
|
|
150
|
+
* Units of measure (not deleted)
|
|
151
|
+
*
|
|
152
|
+
* Field `itemUom` of InvMastAlsoBoughtListItem
|
|
153
|
+
*/
|
|
154
|
+
export interface InvMastAlsoBoughtListItemItemUomItem {
|
|
155
|
+
/** Unit of measure code (max 8 chars) */
|
|
156
|
+
unitOfMeasure: string;
|
|
157
|
+
/** Base units per one of this unit */
|
|
158
|
+
unitSize: number;
|
|
159
|
+
[key: string]: unknown;
|
|
160
|
+
}
|
|
161
|
+
/**
|
|
162
|
+
* Shape of `itemOptionsHdr` (MINIMUM fields; reused wherever the same shape appears)
|
|
163
|
+
* The option group offered
|
|
164
|
+
*
|
|
165
|
+
* Field `itemOptionsHdr` of InvMastAlsoBoughtListItemLegacyPersonalizationItem
|
|
166
|
+
*/
|
|
167
|
+
export interface InvMastAlsoBoughtListItemLegacyPersonalizationItemItemOptionsHdr {
|
|
168
|
+
/** Option group ID */
|
|
169
|
+
itemOptionsHdrUid: number;
|
|
170
|
+
/** Option group name */
|
|
171
|
+
name: string | null;
|
|
172
|
+
/** Label shown to the customer */
|
|
173
|
+
label: string | null;
|
|
174
|
+
/** Option group description */
|
|
175
|
+
description: string | null;
|
|
176
|
+
/** Display mode */
|
|
177
|
+
display: number | null;
|
|
178
|
+
/** Size */
|
|
179
|
+
size: number | null;
|
|
180
|
+
/** Date the record was last changed */
|
|
181
|
+
dateLastModified: string | null;
|
|
182
|
+
/** Alias */
|
|
183
|
+
alias: string | null;
|
|
184
|
+
[key: string]: unknown;
|
|
185
|
+
}
|
|
186
|
+
/**
|
|
187
|
+
* Shape of `itemOptionsLine` (MINIMUM fields; reused wherever the same shape appears)
|
|
188
|
+
* The option offered
|
|
189
|
+
*
|
|
190
|
+
* Field `itemOptionsLine` of
|
|
191
|
+
* InvMastAlsoBoughtListItemLegacyPersonalizationItemItemPersonalizationLinesItem
|
|
192
|
+
*/
|
|
193
|
+
export interface InvMastAlsoBoughtListItemLegacyPersonalizationItemItemPersonalizationLinesItemItemOptionsLine {
|
|
194
|
+
/** Option ID */
|
|
195
|
+
itemOptionsLineUid: number;
|
|
196
|
+
/** Option group the option belongs to */
|
|
197
|
+
itemOptionsHdrUid: number;
|
|
198
|
+
/** Option name */
|
|
199
|
+
name: string | null;
|
|
200
|
+
/** Sort position */
|
|
201
|
+
ordering: number | null;
|
|
202
|
+
/** Size */
|
|
203
|
+
size: number | null;
|
|
204
|
+
/** Date the record was last changed */
|
|
205
|
+
dateLastModified: string | null;
|
|
206
|
+
[key: string]: unknown;
|
|
207
|
+
}
|
|
208
|
+
/**
|
|
209
|
+
* Shape of `itemPersonalizationLines` (MINIMUM fields; reused wherever the same shape appears)
|
|
210
|
+
* The options offered
|
|
211
|
+
*
|
|
212
|
+
* Field `itemPersonalizationLines` of InvMastAlsoBoughtListItemLegacyPersonalizationItem
|
|
213
|
+
*/
|
|
214
|
+
export interface InvMastAlsoBoughtListItemLegacyPersonalizationItemItemPersonalizationLinesItem {
|
|
215
|
+
/** Personalization line ID */
|
|
216
|
+
itemPersonalizationLineUid: number;
|
|
217
|
+
/** Personalization the line belongs to */
|
|
218
|
+
itemPersonalizationHdrUid: number;
|
|
219
|
+
/** Option offered */
|
|
220
|
+
itemOptionsLineUid: number;
|
|
221
|
+
/** 1 when the option is offered */
|
|
222
|
+
active: number | null;
|
|
223
|
+
/** 1 when the option is the default */
|
|
224
|
+
def: number | null;
|
|
225
|
+
/** Item (inv_mast) added to the order when the option is chosen */
|
|
226
|
+
adjustmentInvMastUid: number | null;
|
|
227
|
+
/** Date the record was last changed */
|
|
228
|
+
dateLastModified: string | null;
|
|
229
|
+
/** Date the record was created */
|
|
230
|
+
dateCreated: string | null;
|
|
231
|
+
/** Update code (1185 = Import Complete) */
|
|
232
|
+
updateCd: number;
|
|
233
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
234
|
+
statusCd: number;
|
|
235
|
+
/** Process code (704 = Active, 1185 = Import Complete) */
|
|
236
|
+
processCd: number;
|
|
237
|
+
/** The option offered */
|
|
238
|
+
itemOptionsLine: InvMastAlsoBoughtListItemLegacyPersonalizationItemItemPersonalizationLinesItemItemOptionsLine;
|
|
239
|
+
[key: string]: unknown;
|
|
240
|
+
}
|
|
241
|
+
/**
|
|
242
|
+
* Shape of `legacyPersonalization` (MINIMUM fields; reused wherever the same shape appears)
|
|
243
|
+
* Personalizations from the legacy service
|
|
244
|
+
*
|
|
245
|
+
* Field `legacyPersonalization` of InvMastAlsoBoughtListItem
|
|
246
|
+
*/
|
|
247
|
+
export interface InvMastAlsoBoughtListItemLegacyPersonalizationItem {
|
|
248
|
+
/** Personalization ID */
|
|
249
|
+
itemPersonalizationHdrUid: number;
|
|
250
|
+
/** Item (inv_mast) the personalization belongs to */
|
|
251
|
+
invMastUid: number;
|
|
252
|
+
/** Option group offered */
|
|
253
|
+
itemOptionsHdrUid: number;
|
|
254
|
+
/** Sort position */
|
|
255
|
+
ordering: number | null;
|
|
256
|
+
/** Option chosen by default */
|
|
257
|
+
defaultItemOptionsLineUid: number | null;
|
|
258
|
+
/** 1 when the customer must choose an option */
|
|
259
|
+
required: number | null;
|
|
260
|
+
/** Date the record was last changed */
|
|
261
|
+
dateLastModified: string | null;
|
|
262
|
+
/** Date the record was created */
|
|
263
|
+
dateCreated: string | null;
|
|
264
|
+
/** Update code (1185 = Import Complete) */
|
|
265
|
+
updateCd: number;
|
|
266
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
267
|
+
statusCd: number;
|
|
268
|
+
/** Process code (704 = Active, 1185 = Import Complete) */
|
|
269
|
+
processCd: number;
|
|
270
|
+
/** The option group offered */
|
|
271
|
+
itemOptionsHdr: InvMastAlsoBoughtListItemLegacyPersonalizationItemItemOptionsHdr;
|
|
272
|
+
/** The options offered */
|
|
273
|
+
itemPersonalizationLines: InvMastAlsoBoughtListItemLegacyPersonalizationItemItemPersonalizationLinesItem[];
|
|
274
|
+
[key: string]: unknown;
|
|
275
|
+
}
|
|
276
|
+
/**
|
|
277
|
+
* Shape of `attributes` (MINIMUM fields; reused wherever the same shape appears)
|
|
278
|
+
* Active attribute values, in attribute-group sequence order
|
|
279
|
+
*
|
|
280
|
+
* Field `attributes` of InvMastAlsoBoughtListItem
|
|
281
|
+
*/
|
|
282
|
+
export interface InvMastAlsoBoughtListItemAttributesItem {
|
|
283
|
+
/** Attribute description */
|
|
284
|
+
attributeName: string | null;
|
|
285
|
+
/** The item's value for the attribute */
|
|
286
|
+
attributeValue: string | null;
|
|
287
|
+
[key: string]: unknown;
|
|
288
|
+
}
|
|
289
|
+
/**
|
|
290
|
+
* Shape of `stockData` (MINIMUM fields; reused wherever the same shape appears)
|
|
291
|
+
* Stock at each location
|
|
292
|
+
*
|
|
293
|
+
* Field `stockData` of InvMastAlsoBoughtListItemStock
|
|
294
|
+
*/
|
|
295
|
+
export interface InvMastAlsoBoughtListItemStockStockDataItem {
|
|
296
|
+
/** Location ID */
|
|
297
|
+
locationId: number;
|
|
298
|
+
/** Company the location belongs to (max 8 chars) */
|
|
299
|
+
companyId: string;
|
|
300
|
+
/** Quantity on hand, in base units */
|
|
301
|
+
qtyOnHand: number;
|
|
302
|
+
/** Quantity allocated, in base units */
|
|
303
|
+
qtyAllocated: number;
|
|
304
|
+
/** Y when the item is stocked at the location (max 1 chars) */
|
|
305
|
+
stockable: string | null;
|
|
306
|
+
/** Y when the item is sold from the location (max 1 chars) */
|
|
307
|
+
sellable: string | null;
|
|
308
|
+
/** Y when the item is discontinued at the location (max 1 chars) */
|
|
309
|
+
discontinued: string;
|
|
310
|
+
/** Y when the location record is deleted in P21 (inv_loc.delete_flag) (max 1 chars) */
|
|
311
|
+
deleteFlag: string | null;
|
|
312
|
+
/** qtyOnHand minus qtyAllocated */
|
|
313
|
+
unallocated: number;
|
|
314
|
+
/** Date (Y-m-d) the next purchase order is due in */
|
|
315
|
+
nextDueInPoDate: string | null;
|
|
316
|
+
/** Quantity backordered */
|
|
317
|
+
qtyBackordered: number | null;
|
|
318
|
+
/** Primary bin (max 10 chars) */
|
|
319
|
+
primaryBin: string | null;
|
|
320
|
+
/** Quantity frozen */
|
|
321
|
+
qtyFrozen: number;
|
|
322
|
+
/** Quantity quarantined */
|
|
323
|
+
qtyQuarantined: number;
|
|
324
|
+
/** Quantity not pickable */
|
|
325
|
+
qtyNonPickable: number;
|
|
326
|
+
/** qtyOnHand less allocated, frozen, quarantined and non-pickable */
|
|
327
|
+
qtyAvailable: number;
|
|
328
|
+
/** Order quantity */
|
|
329
|
+
orderQuantity: number | null;
|
|
330
|
+
/** Product group at the location (max 8 chars) */
|
|
331
|
+
productGroupId: string | null;
|
|
332
|
+
/** Item base unit */
|
|
333
|
+
baseUnit: string;
|
|
334
|
+
/** Base unit size (1 when unset) */
|
|
335
|
+
baseUnitSize: number;
|
|
336
|
+
/** Item default selling unit (max 8 chars) */
|
|
337
|
+
defaultSellingUnit: string | null;
|
|
338
|
+
/** Default selling unit size */
|
|
339
|
+
defaultSellingUnitSize: number;
|
|
340
|
+
/** defaultSellingUnitSize divided by baseUnitSize */
|
|
341
|
+
divisor: number;
|
|
342
|
+
/** qtyOnHand in selling units */
|
|
343
|
+
calcQtyOnHand: number;
|
|
344
|
+
/** qtyAllocated in selling units */
|
|
345
|
+
calcQtyAllocated: number;
|
|
346
|
+
/** qtyAvailable in selling units */
|
|
347
|
+
calcQtyAvailable: number;
|
|
348
|
+
/** Location name, or "Location {locationId}" when it cannot be resolved */
|
|
349
|
+
locationName: string;
|
|
350
|
+
[key: string]: unknown;
|
|
351
|
+
}
|
|
352
|
+
/**
|
|
353
|
+
* Shape of `stock` (MINIMUM fields; reused wherever the same shape appears)
|
|
354
|
+
* Stock by location and per company
|
|
355
|
+
*
|
|
356
|
+
* Field `stock` of InvMastAlsoBoughtListItem
|
|
357
|
+
*/
|
|
358
|
+
export interface InvMastAlsoBoughtListItemStock {
|
|
359
|
+
/** Stock at each location */
|
|
360
|
+
stockData: InvMastAlsoBoughtListItemStockStockDataItem[];
|
|
361
|
+
/** Selling-unit quantity available per company ID, vendor stock included */
|
|
362
|
+
companySummary: Record<string, number>;
|
|
363
|
+
[key: string]: unknown;
|
|
364
|
+
}
|
|
365
|
+
/**
|
|
366
|
+
* Shape of `invMastText` (MINIMUM fields; reused wherever the same shape appears)
|
|
367
|
+
* Prophet 21 item text blocks (empty unless the site has a p21_pim config)
|
|
368
|
+
*
|
|
369
|
+
* Field `invMastText` of InvMastAlsoBoughtListItem
|
|
370
|
+
*/
|
|
371
|
+
export interface InvMastAlsoBoughtListItemInvMastTextItem {
|
|
372
|
+
/** Display order */
|
|
373
|
+
sequenceNo: number;
|
|
374
|
+
/** Y when the text displays on the web */
|
|
375
|
+
displayOnWebFlag: string;
|
|
376
|
+
/** Prophet 21 text type code */
|
|
377
|
+
textTypeCd: number;
|
|
378
|
+
/** Text type description; null when the code cannot be resolved */
|
|
379
|
+
textTypeDesc: string | null;
|
|
380
|
+
/** Web display type ID */
|
|
381
|
+
webDisplayTypeUid: number;
|
|
382
|
+
/** Web display type code */
|
|
383
|
+
webDisplayTypeId: string;
|
|
384
|
+
/** Web display type description */
|
|
385
|
+
webDisplayTypeDesc: string;
|
|
386
|
+
/** The text */
|
|
387
|
+
textValue: string;
|
|
388
|
+
[key: string]: unknown;
|
|
389
|
+
}
|
|
390
|
+
/**
|
|
391
|
+
* Shape of `languages` (MINIMUM fields; reused wherever the same shape appears)
|
|
392
|
+
* Descriptions in other languages
|
|
393
|
+
*
|
|
394
|
+
* Field `languages` of InvMastAlsoBoughtListItem
|
|
395
|
+
*/
|
|
396
|
+
export interface InvMastAlsoBoughtListItemLanguagesItem {
|
|
397
|
+
/** Item language ID */
|
|
398
|
+
invMastLanguageUid: number;
|
|
399
|
+
/** Item (inv_mast) the description belongs to */
|
|
400
|
+
invMastUid: number;
|
|
401
|
+
/** Language ID */
|
|
402
|
+
languageId: string | null;
|
|
403
|
+
/** Item description in the language */
|
|
404
|
+
languageItemDesc: string | null;
|
|
405
|
+
/** Y when the description is deleted */
|
|
406
|
+
itemDescDeleteFlag: string;
|
|
407
|
+
/** Date the record was created */
|
|
408
|
+
dateCreated: string;
|
|
409
|
+
/** User who created the record */
|
|
410
|
+
createdBy: string;
|
|
411
|
+
/** Date the record was last changed */
|
|
412
|
+
dateLastModified: string;
|
|
413
|
+
/** User who last changed the record */
|
|
414
|
+
lastMaintainedBy: string;
|
|
415
|
+
/** Extended description in the language */
|
|
416
|
+
languageExtendedDesc: string | null;
|
|
417
|
+
/** Update code (1185 = Import Complete) */
|
|
418
|
+
updateCd: number;
|
|
419
|
+
[key: string]: unknown;
|
|
420
|
+
}
|
|
421
|
+
/**
|
|
422
|
+
* Shape of `assets` (MINIMUM fields; reused wherever the same shape appears)
|
|
423
|
+
* Active assets linked to the item; the key is absent when the lookup failed
|
|
424
|
+
*
|
|
425
|
+
* Field `assets` of InvMastAlsoBoughtListItemBrandFolder
|
|
426
|
+
*/
|
|
427
|
+
export interface InvMastAlsoBoughtListItemBrandFolderAssetsItem {
|
|
428
|
+
/** Brandfolder asset ID */
|
|
429
|
+
id: string;
|
|
430
|
+
/** Asset name */
|
|
431
|
+
name: string | null;
|
|
432
|
+
/** First attachment's file name */
|
|
433
|
+
attachmentName: string | null;
|
|
434
|
+
/** CDN URL of the asset */
|
|
435
|
+
cdnLink: string;
|
|
436
|
+
/** Attachment layout (square when unknown) */
|
|
437
|
+
layout: string;
|
|
438
|
+
[key: string]: unknown;
|
|
439
|
+
}
|
|
440
|
+
/**
|
|
441
|
+
* Shape of `brandFolder` (MINIMUM fields; reused wherever the same shape appears)
|
|
442
|
+
* Brandfolder assets (trinitysurfaces only)
|
|
443
|
+
*
|
|
444
|
+
* Field `brandFolder` of InvMastAlsoBoughtListItem
|
|
445
|
+
*/
|
|
446
|
+
export interface InvMastAlsoBoughtListItemBrandFolder {
|
|
447
|
+
/** Active assets linked to the item; the key is absent when the lookup failed */
|
|
448
|
+
assets?: InvMastAlsoBoughtListItemBrandFolderAssetsItem[] | null;
|
|
449
|
+
[key: string]: unknown;
|
|
450
|
+
}
|
|
451
|
+
/**
|
|
452
|
+
* Shape of `fullSizedSamples` (MINIMUM fields; reused wherever the same shape appears)
|
|
453
|
+
* Full-sized sample item, or false (trinitysurfaces only)
|
|
454
|
+
*
|
|
455
|
+
* Field `fullSizedSamples` of InvMastAlsoBoughtListItem
|
|
456
|
+
* Field `swatchSample` of InvMastAlsoBoughtListItem
|
|
457
|
+
*/
|
|
458
|
+
export interface InvMastAlsoBoughtListItemFullSizedSamples {
|
|
459
|
+
/** Sample item ID */
|
|
460
|
+
itemId: string;
|
|
461
|
+
/** Sample item (inv_mast) ID */
|
|
462
|
+
invMastUid: number;
|
|
463
|
+
/** Sample item class 5 */
|
|
464
|
+
classId5: string | null;
|
|
465
|
+
/** True when the 4th character of classId5 is 1 */
|
|
466
|
+
samplesApp: boolean;
|
|
467
|
+
[key: string]: unknown;
|
|
468
|
+
}
|
|
469
|
+
/**
|
|
470
|
+
* List item Also Bought
|
|
471
|
+
* Response data for GET /inv-mast/{invMastUid}/also-bought — MINIMUM fields, extras pass through
|
|
472
|
+
*
|
|
473
|
+
* Returned by: api.legacy.invMast.alsoBought.list(invMastUid, params) (array items)
|
|
474
|
+
*/
|
|
475
|
+
export interface InvMastAlsoBoughtListItem {
|
|
476
|
+
/** Item (inv_mast) ID */
|
|
477
|
+
invMastUid: number;
|
|
478
|
+
/** Item ID (max 40 chars) */
|
|
479
|
+
itemId: string;
|
|
480
|
+
/** Item description (max 40 chars) */
|
|
481
|
+
itemDesc: string | null;
|
|
482
|
+
/** First web-displayed category description for the item */
|
|
483
|
+
displayDesc: string | null;
|
|
484
|
+
/** Extended description (max 255 chars) */
|
|
485
|
+
extendedDesc: string | null;
|
|
486
|
+
/** Short code (max 30 chars) */
|
|
487
|
+
shortCode: string | null;
|
|
488
|
+
/** Default selling unit (max 8 chars) */
|
|
489
|
+
defaultSellingUnit: string | null;
|
|
490
|
+
/** Default purchasing unit (max 8 chars) */
|
|
491
|
+
defaultPurchasingUnit: string | null;
|
|
492
|
+
/** Y when the item is deleted (max 1 chars) */
|
|
493
|
+
deleteFlag: string;
|
|
494
|
+
/** Online code (704 = online) */
|
|
495
|
+
onlineCd: number;
|
|
496
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
497
|
+
statusCd: number;
|
|
498
|
+
/** Base unit (max 8 chars) */
|
|
499
|
+
baseUnit: string;
|
|
500
|
+
/** Vendor stock quantity */
|
|
501
|
+
vndrStock: number | null;
|
|
502
|
+
/** Item class 1 (max 8 chars) */
|
|
503
|
+
classId1: string | null;
|
|
504
|
+
/** Item class 2 (max 8 chars) */
|
|
505
|
+
classId2: string | null;
|
|
506
|
+
/** Item class 3 (max 8 chars) */
|
|
507
|
+
classId3: string | null;
|
|
508
|
+
/** Item class 4 (max 8 chars) */
|
|
509
|
+
classId4: string | null;
|
|
510
|
+
/** Item class 5 (max 8 chars) */
|
|
511
|
+
classId5: string | null;
|
|
512
|
+
/** Y when the item is serialized (max 1 chars) */
|
|
513
|
+
serialized: string;
|
|
514
|
+
/** Y when the item is lot-tracked (max 1 chars) */
|
|
515
|
+
trackLots: string;
|
|
516
|
+
/** Tracking pattern derived from serialized and trackLots */
|
|
517
|
+
trackingPattern: string;
|
|
518
|
+
/** Default product group (max 8 chars) */
|
|
519
|
+
defaultProductGroup: string | null;
|
|
520
|
+
/** Default sales discount group (max 8 chars) */
|
|
521
|
+
defaultSalesDiscountGroup: string | null;
|
|
522
|
+
/** Default purchase discount group (max 8 chars) */
|
|
523
|
+
defaultPurchaseDiscGroup: string | null;
|
|
524
|
+
/** UPC or EAN code type (max 3 chars) */
|
|
525
|
+
upcOrEan: string | null;
|
|
526
|
+
/** UPC or EAN code (max 15 chars) */
|
|
527
|
+
upcOrEanId: string | null;
|
|
528
|
+
/** Weight */
|
|
529
|
+
weight: number | null;
|
|
530
|
+
/** Length */
|
|
531
|
+
length: number | null;
|
|
532
|
+
/** Width */
|
|
533
|
+
width: number | null;
|
|
534
|
+
/** Height */
|
|
535
|
+
height: number | null;
|
|
536
|
+
/** Parker product code (max 255 chars) */
|
|
537
|
+
parkerProductCd: string | null;
|
|
538
|
+
/** Brand name (max 255 chars) */
|
|
539
|
+
brandName: string | null;
|
|
540
|
+
/** Manufacturer name (max 255 chars) */
|
|
541
|
+
manufacturerName: string | null;
|
|
542
|
+
/** The item's suppliers (not deleted) */
|
|
543
|
+
inventorySupplier: InvMastAlsoBoughtListItemInventorySupplierItem[];
|
|
544
|
+
/** Most common primary supplier across the item's locations */
|
|
545
|
+
primarySupplierName: string | null;
|
|
546
|
+
/** Units of measure (not deleted) */
|
|
547
|
+
itemUom: InvMastAlsoBoughtListItemItemUomItem[];
|
|
548
|
+
/** Alternate codes */
|
|
549
|
+
alternateCodes: string[];
|
|
550
|
+
/** Tags from the legacy service */
|
|
551
|
+
legacyTags: string[];
|
|
552
|
+
/** Personalizations from the legacy service */
|
|
553
|
+
legacyPersonalization: InvMastAlsoBoughtListItemLegacyPersonalizationItem[];
|
|
554
|
+
/** Item category IDs the item is in, ancestors included */
|
|
555
|
+
categoryList: number[];
|
|
556
|
+
/** Active attribute values, in attribute-group sequence order */
|
|
557
|
+
attributes: InvMastAlsoBoughtListItemAttributesItem[];
|
|
558
|
+
/** Image URLs or paths */
|
|
559
|
+
images: string[];
|
|
560
|
+
/** Stock by location and per company */
|
|
561
|
+
stock: InvMastAlsoBoughtListItemStock;
|
|
562
|
+
/** Category display description per item category ID */
|
|
563
|
+
categoryDisplayDescriptions: Record<string, string>;
|
|
564
|
+
/** Non-empty user-defined field values, keyed by field name; {} when the item has none */
|
|
565
|
+
userDefined: Record<string, unknown>;
|
|
566
|
+
/** Prophet 21 item text blocks (empty unless the site has a p21_pim config) */
|
|
567
|
+
invMastText: InvMastAlsoBoughtListItemInvMastTextItem[];
|
|
568
|
+
/** Descriptions in other languages */
|
|
569
|
+
languages: InvMastAlsoBoughtListItemLanguagesItem[];
|
|
570
|
+
/** Brandfolder assets (trinitysurfaces only) */
|
|
571
|
+
brandFolder?: InvMastAlsoBoughtListItemBrandFolder | null;
|
|
572
|
+
/** Category trees for the item's non-root categories (trinitysurfaces only) */
|
|
573
|
+
docCatTrees?: Array<number[]> | null;
|
|
574
|
+
/** Product collection of the item's category under root 3 (trinitysurfaces only) */
|
|
575
|
+
productCollection?: string | null;
|
|
576
|
+
/** Leaf category under root 3, or false (trinitysurfaces only) */
|
|
577
|
+
tsItemCategoryUid?: number | null | false;
|
|
578
|
+
/** Leaf category under root 5, or false (trinitysurfaces only) */
|
|
579
|
+
ttItemCategoryUid?: number | null | false;
|
|
580
|
+
/** True when the trim user-defined field is Y (trinitysurfaces only) */
|
|
581
|
+
trim?: boolean | null;
|
|
582
|
+
/** Full-sized sample item, or false (trinitysurfaces only) */
|
|
583
|
+
fullSizedSamples?: InvMastAlsoBoughtListItemFullSizedSamples | null | false;
|
|
584
|
+
/** Swatch sample item, or false (trinitysurfaces only) */
|
|
585
|
+
swatchSample?: InvMastAlsoBoughtListItemFullSizedSamples | null | false;
|
|
586
|
+
/** Variant group the item belongs to */
|
|
587
|
+
itemVariantHdrUid?: number | null;
|
|
588
|
+
/** List price 1 (only with includePricing=Y) */
|
|
589
|
+
price1?: number | null;
|
|
590
|
+
/** List price 2 (only with includePricing=Y) */
|
|
591
|
+
price2?: number | null;
|
|
592
|
+
/** List price 3 (only with includePricing=Y) */
|
|
593
|
+
price3?: number | null;
|
|
594
|
+
/** List price 4 (only with includePricing=Y) */
|
|
595
|
+
price4?: number | null;
|
|
596
|
+
/** List price 5 (only with includePricing=Y) */
|
|
597
|
+
price5?: number | null;
|
|
598
|
+
/** List price 6 (only with includePricing=Y) */
|
|
599
|
+
price6?: number | null;
|
|
600
|
+
/** List price 7 (only with includePricing=Y) */
|
|
601
|
+
price7?: number | null;
|
|
602
|
+
/** List price 8 (only with includePricing=Y) */
|
|
603
|
+
price8?: number | null;
|
|
604
|
+
/** List price 9 (only with includePricing=Y) */
|
|
605
|
+
price9?: number | null;
|
|
606
|
+
/** List price 10 (only with includePricing=Y) */
|
|
607
|
+
price10?: number | null;
|
|
608
|
+
[key: string]: unknown;
|
|
609
|
+
}
|
|
610
|
+
/** Returned by: api.legacy.invMast.alsoBought.list(invMastUid, params) */
|
|
611
|
+
export type InvMastAlsoBoughtListData = InvMastAlsoBoughtListItem[];
|
|
612
|
+
/**
|
|
613
|
+
* List Inv Mast Tags
|
|
614
|
+
* Response data for GET /inv-mast/{invMastUid}/tags — MINIMUM fields, extras pass through
|
|
615
|
+
*
|
|
616
|
+
* Returned by: api.legacy.invMast.tags.list(invMastUid, params) (array items)
|
|
617
|
+
* Returned by: api.legacy.invMast.tags.create(invMastUid, data)
|
|
618
|
+
* Returned by: api.legacy.invMast.tags.get(invMastUid, invMastTagsUid)
|
|
619
|
+
* Returned by: api.legacy.invMast.tags.update(invMastUid, invMastTagsUid, data)
|
|
620
|
+
* Returned by: api.legacy.invMast.tags.delete(invMastUid, invMastTagsUid)
|
|
621
|
+
*/
|
|
622
|
+
export interface InvMastTagsListItem {
|
|
623
|
+
/** Unique identifier of the item tag */
|
|
624
|
+
invMastTagsUid: number;
|
|
625
|
+
/** Item (inv_mast) the tag belongs to */
|
|
626
|
+
invMastUid: number;
|
|
627
|
+
/** Tag text (max 255 chars) */
|
|
628
|
+
tag: string | null;
|
|
629
|
+
/** Update code (1185 = Import Complete) */
|
|
630
|
+
updateCd: number;
|
|
631
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
632
|
+
statusCd: number;
|
|
633
|
+
/** Process code (704 = Active, 1185 = Import Complete) */
|
|
634
|
+
processCd: number;
|
|
635
|
+
/** MySQL datetime format: YYYY-MM-DD HH:mm:ss (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
636
|
+
dateCreated: string;
|
|
637
|
+
/** MySQL datetime format: YYYY-MM-DD HH:mm:ss (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
638
|
+
dateLastModified: string;
|
|
639
|
+
[key: string]: unknown;
|
|
640
|
+
}
|
|
641
|
+
/** Returned by: api.legacy.invMast.tags.list(invMastUid, params) */
|
|
642
|
+
export type InvMastTagsListData = InvMastTagsListItem[];
|
|
643
|
+
/**
|
|
644
|
+
* Create Inv Mast Tag
|
|
645
|
+
* Response data for POST /inv-mast/{invMastUid}/tags — MINIMUM fields, extras pass through
|
|
646
|
+
*
|
|
647
|
+
* Returned by: api.legacy.invMast.tags.create(invMastUid, data)
|
|
648
|
+
*/
|
|
649
|
+
export type InvMastTagsCreateData = InvMastTagsListItem;
|
|
650
|
+
/**
|
|
651
|
+
* Create Inv Mast Tag
|
|
652
|
+
* Request body for POST /inv-mast/{invMastUid}/tags — MINIMUM fields, extras pass through
|
|
653
|
+
*
|
|
654
|
+
* Request body of: api.legacy.invMast.tags.create(invMastUid, data)
|
|
655
|
+
*/
|
|
656
|
+
export interface InvMastTagsCreateBody {
|
|
657
|
+
/** Tag text */
|
|
658
|
+
tag?: string | null;
|
|
659
|
+
[key: string]: unknown;
|
|
660
|
+
}
|
|
661
|
+
/**
|
|
662
|
+
* Get Inv Mast Tag Details
|
|
663
|
+
* Response data for GET /inv-mast/{invMastUid}/tags/{invMastTagsUid} — MINIMUM fields, extras pass
|
|
664
|
+
* through
|
|
665
|
+
*
|
|
666
|
+
* Returned by: api.legacy.invMast.tags.get(invMastUid, invMastTagsUid)
|
|
667
|
+
*/
|
|
668
|
+
export type InvMastTagsGetData = InvMastTagsListItem;
|
|
669
|
+
/**
|
|
670
|
+
* Update Inv Mast Tag
|
|
671
|
+
* Response data for PUT /inv-mast/{invMastUid}/tags/{invMastTagsUid} — MINIMUM fields, extras pass
|
|
672
|
+
* through
|
|
673
|
+
*
|
|
674
|
+
* Returned by: api.legacy.invMast.tags.update(invMastUid, invMastTagsUid, data)
|
|
675
|
+
*/
|
|
676
|
+
export type InvMastTagsUpdateData = InvMastTagsListItem;
|
|
677
|
+
/**
|
|
678
|
+
* Update Inv Mast Tag
|
|
679
|
+
* Request body for PUT /inv-mast/{invMastUid}/tags/{invMastTagsUid} — MINIMUM fields, extras pass
|
|
680
|
+
* through
|
|
681
|
+
*
|
|
682
|
+
* Request body of: api.legacy.invMast.tags.update(invMastUid, invMastTagsUid, data)
|
|
683
|
+
*/
|
|
684
|
+
export interface InvMastTagsUpdateBody {
|
|
685
|
+
/** Tag text */
|
|
686
|
+
tag?: string | null;
|
|
687
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
688
|
+
statusCd?: number | null;
|
|
689
|
+
/** Process code */
|
|
690
|
+
processCd?: number | null;
|
|
691
|
+
/** Update code */
|
|
692
|
+
updateCd?: number | null;
|
|
693
|
+
[key: string]: unknown;
|
|
694
|
+
}
|
|
695
|
+
/**
|
|
696
|
+
* Delete Inv Mast Tag
|
|
697
|
+
* Response data for DELETE /inv-mast/{invMastUid}/tags/{invMastTagsUid} — MINIMUM fields, extras
|
|
698
|
+
* pass through
|
|
699
|
+
*
|
|
700
|
+
* Returned by: api.legacy.invMast.tags.delete(invMastUid, invMastTagsUid)
|
|
701
|
+
*/
|
|
702
|
+
export type InvMastTagsDeleteData = InvMastTagsListItem;
|
|
703
|
+
/**
|
|
704
|
+
* List item Web Descriptions
|
|
705
|
+
* Response data for GET /inv-mast/{invMastUid}/web-desc — MINIMUM fields, extras pass through
|
|
706
|
+
*
|
|
707
|
+
* Returned by: api.legacy.invMast.webDesc.list(invMastUid, params) (array items)
|
|
708
|
+
* Returned by: api.legacy.invMast.webDesc.create(invMastUid, data)
|
|
709
|
+
* Returned by: api.legacy.invMast.webDesc.get(invMastUid, invMastWebDescUid)
|
|
710
|
+
* Returned by: api.legacy.invMast.webDesc.update(invMastUid, invMastWebDescUid, data)
|
|
711
|
+
* Returned by: api.legacy.invMast.webDesc.delete(invMastUid, invMastWebDescUid)
|
|
712
|
+
*/
|
|
713
|
+
export interface InvMastWebDescListItem {
|
|
714
|
+
/** Unique identifier of the item web description */
|
|
715
|
+
invMastWebDescUid: number;
|
|
716
|
+
/** Item (inv_mast) the web description belongs to */
|
|
717
|
+
invMastUid: number;
|
|
718
|
+
/** Web description 1 */
|
|
719
|
+
webDesc1: string | null;
|
|
720
|
+
/** Web description 2 */
|
|
721
|
+
webDesc2: string | null;
|
|
722
|
+
/** Web description 3 */
|
|
723
|
+
webDesc3: string | null;
|
|
724
|
+
/** Web description 4 */
|
|
725
|
+
webDesc4: string | null;
|
|
726
|
+
/** Full web description */
|
|
727
|
+
webDescFull: string | null;
|
|
728
|
+
/** MySQL datetime format: YYYY-MM-DD HH:mm:ss (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
729
|
+
dateCreated: string;
|
|
730
|
+
/** 1 when active */
|
|
731
|
+
active: number | null;
|
|
732
|
+
/** MySQL datetime format: YYYY-MM-DD HH:mm:ss (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
733
|
+
dateLastModified: string;
|
|
734
|
+
/** MySQL datetime format: YYYY-MM-DD HH:mm:ss (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
735
|
+
dateLastChecked: string;
|
|
736
|
+
/** Update code (1185 = Import Complete) */
|
|
737
|
+
updateCd: number;
|
|
738
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
739
|
+
statusCd: number;
|
|
740
|
+
[key: string]: unknown;
|
|
741
|
+
}
|
|
742
|
+
/** Returned by: api.legacy.invMast.webDesc.list(invMastUid, params) */
|
|
743
|
+
export type InvMastWebDescListData = InvMastWebDescListItem[];
|
|
744
|
+
/**
|
|
745
|
+
* Create Web Description for Item
|
|
746
|
+
* Response data for POST /inv-mast/{invMastUid}/web-desc — MINIMUM fields, extras pass through
|
|
747
|
+
*
|
|
748
|
+
* Returned by: api.legacy.invMast.webDesc.create(invMastUid, data)
|
|
749
|
+
*/
|
|
750
|
+
export type InvMastWebDescCreateData = InvMastWebDescListItem;
|
|
751
|
+
/**
|
|
752
|
+
* Create Web Description for Item
|
|
753
|
+
* Request body for POST /inv-mast/{invMastUid}/web-desc — MINIMUM fields, extras pass through
|
|
754
|
+
*
|
|
755
|
+
* Request body of: api.legacy.invMast.webDesc.create(invMastUid, data)
|
|
756
|
+
*/
|
|
757
|
+
export interface InvMastWebDescCreateBody {
|
|
758
|
+
/** Web description 1 */
|
|
759
|
+
webDesc1?: string | null;
|
|
760
|
+
/** Web description 2 */
|
|
761
|
+
webDesc2?: string | null;
|
|
762
|
+
/** Web description 3 */
|
|
763
|
+
webDesc3?: string | null;
|
|
764
|
+
/** Web description 4 */
|
|
765
|
+
webDesc4?: string | null;
|
|
766
|
+
/** Full web description */
|
|
767
|
+
webDescFull?: string | null;
|
|
768
|
+
/** 1 when active; defaults to 1 */
|
|
769
|
+
active?: number | null;
|
|
770
|
+
[key: string]: unknown;
|
|
771
|
+
}
|
|
772
|
+
/**
|
|
773
|
+
* Get Item Web Description
|
|
774
|
+
* Response data for GET /inv-mast/{invMastUid}/web-desc/{invMastWebDescUid} — MINIMUM fields,
|
|
775
|
+
* extras pass through
|
|
776
|
+
*
|
|
777
|
+
* Returned by: api.legacy.invMast.webDesc.get(invMastUid, invMastWebDescUid)
|
|
778
|
+
*/
|
|
779
|
+
export type InvMastWebDescGetData = InvMastWebDescListItem;
|
|
780
|
+
/**
|
|
781
|
+
* Update Item Web Description
|
|
782
|
+
* Response data for PUT /inv-mast/{invMastUid}/web-desc/{invMastWebDescUid} — MINIMUM fields,
|
|
783
|
+
* extras pass through
|
|
784
|
+
*
|
|
785
|
+
* Returned by: api.legacy.invMast.webDesc.update(invMastUid, invMastWebDescUid, data)
|
|
786
|
+
*/
|
|
787
|
+
export type InvMastWebDescUpdateData = InvMastWebDescListItem;
|
|
788
|
+
/**
|
|
789
|
+
* Update Item Web Description
|
|
790
|
+
* Request body for PUT /inv-mast/{invMastUid}/web-desc/{invMastWebDescUid} — MINIMUM fields, extras
|
|
791
|
+
* pass through
|
|
792
|
+
*
|
|
793
|
+
* Request body of: api.legacy.invMast.webDesc.update(invMastUid, invMastWebDescUid, data)
|
|
794
|
+
*/
|
|
795
|
+
export interface InvMastWebDescUpdateBody {
|
|
796
|
+
/** Web description 1 */
|
|
797
|
+
webDesc1?: string | null;
|
|
798
|
+
/** Web description 2 */
|
|
799
|
+
webDesc2?: string | null;
|
|
800
|
+
/** Web description 3 */
|
|
801
|
+
webDesc3?: string | null;
|
|
802
|
+
/** Web description 4 */
|
|
803
|
+
webDesc4?: string | null;
|
|
804
|
+
/** Full web description */
|
|
805
|
+
webDescFull?: string | null;
|
|
806
|
+
/** 1 when active */
|
|
807
|
+
active?: number | null;
|
|
808
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
809
|
+
statusCd?: number | null;
|
|
810
|
+
/** Update code */
|
|
811
|
+
updateCd?: number | null;
|
|
812
|
+
[key: string]: unknown;
|
|
813
|
+
}
|
|
814
|
+
/**
|
|
815
|
+
* Delete Item Web Description
|
|
816
|
+
* Response data for DELETE /inv-mast/{invMastUid}/web-desc/{invMastWebDescUid} — MINIMUM fields,
|
|
817
|
+
* extras pass through
|
|
818
|
+
*
|
|
819
|
+
* Returned by: api.legacy.invMast.webDesc.delete(invMastUid, invMastWebDescUid)
|
|
820
|
+
*/
|
|
821
|
+
export type InvMastWebDescDeleteData = InvMastWebDescListItem;
|
|
822
|
+
/**
|
|
823
|
+
* Get Item Category Details
|
|
824
|
+
* Response data for GET /item-category/{itemCategoryUid} — MINIMUM fields, extras pass through
|
|
825
|
+
*
|
|
826
|
+
* Returned by: api.legacy.itemCategory.get(itemCategoryUid)
|
|
827
|
+
*/
|
|
828
|
+
export interface ItemCategoryGetData {
|
|
829
|
+
/** Unique identifier of the item category */
|
|
830
|
+
itemCategoryUid: number;
|
|
831
|
+
/** Item category ID (max 255 chars) */
|
|
832
|
+
itemCategoryId: string;
|
|
833
|
+
/** Item category description (max 255 chars) */
|
|
834
|
+
itemCategoryDesc: string;
|
|
835
|
+
/** Category article text 1 */
|
|
836
|
+
article: string | null;
|
|
837
|
+
/** Box folder ID for the category (max 255 chars) */
|
|
838
|
+
boxFolderId: string | null;
|
|
839
|
+
/** Y when this is a master category (max 1 chars) */
|
|
840
|
+
masterCategoryFlag: string;
|
|
841
|
+
/** Y when this is a parent category (max 1 chars) */
|
|
842
|
+
parentCategoryFlag: string;
|
|
843
|
+
/** Y when the category displays on the web (max 1 chars) */
|
|
844
|
+
displayOnWebFlag: string;
|
|
845
|
+
/** Y when the category is deleted (max 1 chars) */
|
|
846
|
+
deleteFlag: string;
|
|
847
|
+
/** Customer approval flag (max 1 chars) */
|
|
848
|
+
customerApproval: string | null;
|
|
849
|
+
/** MySQL datetime format: YYYY-MM-DD HH:mm:ss (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
850
|
+
dateLastModified: string;
|
|
851
|
+
/** MySQL datetime format: YYYY-MM-DD HH:mm:ss (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
852
|
+
dateLastChecked: string;
|
|
853
|
+
/** Category article text 2 */
|
|
854
|
+
article2: string | null;
|
|
855
|
+
/** Category article text 3 */
|
|
856
|
+
article3: string | null;
|
|
857
|
+
/** Category article text 4 */
|
|
858
|
+
article4: string | null;
|
|
859
|
+
/** Category article text 5 */
|
|
860
|
+
article5: string | null;
|
|
861
|
+
/** Sample item ID shown for the category (max 255 chars) */
|
|
862
|
+
sampleItemId: string | null;
|
|
863
|
+
/** Meta description for the category page (max 255 chars) */
|
|
864
|
+
metaDesc: string | null;
|
|
865
|
+
/** Category page title (max 255 chars) */
|
|
866
|
+
title: string | null;
|
|
867
|
+
/** Update code (1185 = Import Complete) */
|
|
868
|
+
updateCd: number;
|
|
869
|
+
/** Sub-category image file (max 255 chars) */
|
|
870
|
+
subCategoryImageFile: string | null;
|
|
871
|
+
/** User who last changed the record (max 255 chars) */
|
|
872
|
+
lastMaintainedBy: string;
|
|
873
|
+
/** MySQL datetime format: YYYY-MM-DD HH:mm:ss (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
874
|
+
dateCreated: string;
|
|
875
|
+
/** User who created the record (max 255 chars) */
|
|
876
|
+
createdBy: string;
|
|
877
|
+
/** Catalog page (max 255 chars) */
|
|
878
|
+
catalogPage: string | null;
|
|
879
|
+
/** Y when the master product displays (max 1 chars) */
|
|
880
|
+
displayMasterProductFlag: string;
|
|
881
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
882
|
+
processCd: number;
|
|
883
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
884
|
+
statusCd: number;
|
|
885
|
+
[key: string]: unknown;
|
|
886
|
+
}
|
|
887
|
+
/**
|
|
888
|
+
* List States
|
|
889
|
+
* Response data for GET /legacy/state — MINIMUM fields, extras pass through
|
|
890
|
+
*
|
|
891
|
+
* Returned by: api.legacy.legacy.state.list(params) (array items)
|
|
892
|
+
* Returned by: api.legacy.legacy.state.create(data)
|
|
893
|
+
* Returned by: api.legacy.legacy.state.get(stateUid, params)
|
|
894
|
+
* Returned by: api.legacy.legacy.state.update(stateUid, data)
|
|
895
|
+
* Returned by: api.legacy.legacy.state.delete(stateUid)
|
|
896
|
+
*/
|
|
897
|
+
export interface LegacyStateListItem {
|
|
898
|
+
/** Unique identifier of the state */
|
|
899
|
+
stateUid: number;
|
|
900
|
+
/** Country the state belongs to */
|
|
901
|
+
countryUid: number | null;
|
|
902
|
+
/** Two-letter state code (max 2 chars) */
|
|
903
|
+
twoLetterCode: string | null;
|
|
904
|
+
/** State name (max 255 chars) */
|
|
905
|
+
stateName: string | null;
|
|
906
|
+
/** MySQL datetime format: YYYY-MM-DD HH:mm:ss (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
907
|
+
dateCreated: string | null;
|
|
908
|
+
/** User who created the record (max 255 chars) */
|
|
909
|
+
createdBy: string | null;
|
|
910
|
+
/** MySQL datetime format: YYYY-MM-DD HH:mm:ss (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
911
|
+
dateLastModified: string | null;
|
|
912
|
+
/** User who last changed the record (max 255 chars) */
|
|
913
|
+
lastMaintainedBy: string | null;
|
|
914
|
+
/** Combined Federal/State 1099 program number */
|
|
915
|
+
combinedFederalState1099No: number | null;
|
|
916
|
+
/** TeleCheck state code */
|
|
917
|
+
telecheckStateCode: number | null;
|
|
918
|
+
/** Update code (1185 = Import Complete) */
|
|
919
|
+
updateCd: number;
|
|
920
|
+
/** 1 when the state is active */
|
|
921
|
+
active: number | null;
|
|
922
|
+
/** Tax rate */
|
|
923
|
+
taxRate: number | null;
|
|
924
|
+
/** MySQL datetime format: YYYY-MM-DD HH:mm:ss (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
925
|
+
dateLastChecked: string | null;
|
|
926
|
+
/** 1 when shipping is taxed */
|
|
927
|
+
taxShipping: number | null;
|
|
928
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
929
|
+
statusCd: number;
|
|
930
|
+
/** Process code (704 = Active, 1185 = Import Complete) */
|
|
931
|
+
processCd: number;
|
|
932
|
+
[key: string]: unknown;
|
|
933
|
+
}
|
|
934
|
+
/** Returned by: api.legacy.legacy.state.list(params) */
|
|
935
|
+
export type LegacyStateListData = LegacyStateListItem[];
|
|
936
|
+
/**
|
|
937
|
+
* Create State
|
|
938
|
+
* Response data for POST /legacy/state — MINIMUM fields, extras pass through
|
|
939
|
+
*
|
|
940
|
+
* Returned by: api.legacy.legacy.state.create(data)
|
|
941
|
+
*/
|
|
942
|
+
export type LegacyStateCreateData = LegacyStateListItem;
|
|
943
|
+
/**
|
|
944
|
+
* Create State
|
|
945
|
+
* Request body for POST /legacy/state — MINIMUM fields, extras pass through
|
|
946
|
+
*
|
|
947
|
+
* Request body of: api.legacy.legacy.state.create(data)
|
|
948
|
+
*/
|
|
949
|
+
export interface LegacyStateCreateBody {
|
|
950
|
+
/** State name (max 255 chars) */
|
|
951
|
+
stateName: string;
|
|
952
|
+
/** Two-letter state code (max 2 chars) */
|
|
953
|
+
twoLetterCode: string;
|
|
954
|
+
/** Country the state belongs to */
|
|
955
|
+
countryUid?: number | null;
|
|
956
|
+
/** User who created the state; defaults to empty (max 255 chars) */
|
|
957
|
+
createdBy?: string | null;
|
|
958
|
+
/** Combined Federal/State 1099 program number */
|
|
959
|
+
combinedFederalState1099No?: number | null;
|
|
960
|
+
/** TeleCheck state code */
|
|
961
|
+
telecheckStateCode?: number | null;
|
|
962
|
+
/** 1 when the state is active; defaults to 0 */
|
|
963
|
+
active?: number | null;
|
|
964
|
+
/** Tax rate; defaults to 0 */
|
|
965
|
+
taxRate?: number | null;
|
|
966
|
+
/** 1 when shipping is taxed; defaults to 0 */
|
|
967
|
+
taxShipping?: number | null;
|
|
968
|
+
[key: string]: unknown;
|
|
969
|
+
}
|
|
970
|
+
/**
|
|
971
|
+
* Get State Details
|
|
972
|
+
* Response data for GET /legacy/state/{stateUid} — MINIMUM fields, extras pass through
|
|
973
|
+
*
|
|
974
|
+
* Returned by: api.legacy.legacy.state.get(stateUid, params)
|
|
975
|
+
*/
|
|
976
|
+
export type LegacyStateGetData = LegacyStateListItem;
|
|
977
|
+
/**
|
|
978
|
+
* Update State
|
|
979
|
+
* Response data for PUT /legacy/state/{stateUid} — MINIMUM fields, extras pass through
|
|
980
|
+
*
|
|
981
|
+
* Returned by: api.legacy.legacy.state.update(stateUid, data)
|
|
982
|
+
*/
|
|
983
|
+
export type LegacyStateUpdateData = LegacyStateListItem;
|
|
984
|
+
/**
|
|
985
|
+
* Update State
|
|
986
|
+
* Request body for PUT /legacy/state/{stateUid} — MINIMUM fields, extras pass through
|
|
987
|
+
*
|
|
988
|
+
* Request body of: api.legacy.legacy.state.update(stateUid, data)
|
|
989
|
+
*/
|
|
990
|
+
export interface LegacyStateUpdateBody {
|
|
991
|
+
/** 1 when the state is active */
|
|
992
|
+
active?: number | null;
|
|
993
|
+
/** Tax rate */
|
|
994
|
+
taxRate?: number | null;
|
|
995
|
+
/** 1 when shipping is taxed */
|
|
996
|
+
taxShipping?: number | null;
|
|
997
|
+
[key: string]: unknown;
|
|
998
|
+
}
|
|
999
|
+
/**
|
|
1000
|
+
* DELETE State
|
|
1001
|
+
* Response data for DELETE /legacy/state/{stateUid} — MINIMUM fields, extras pass through
|
|
1002
|
+
*
|
|
1003
|
+
* Returned by: api.legacy.legacy.state.delete(stateUid)
|
|
1004
|
+
*/
|
|
1005
|
+
export type LegacyStateDeleteData = LegacyStateListItem;
|
|
1006
|
+
/**
|
|
1007
|
+
* List Saved Carts
|
|
1008
|
+
* Response data for GET /saved-carts — MINIMUM fields, extras pass through
|
|
1009
|
+
*
|
|
1010
|
+
* Returned by: api.legacy.savedCarts.list(params) (array items)
|
|
1011
|
+
* Returned by: api.legacy.savedCarts.get(id)
|
|
1012
|
+
*/
|
|
1013
|
+
export interface SavedCartsListItem {
|
|
1014
|
+
/** Saved cart ID; the key used to address a cart */
|
|
1015
|
+
id: number;
|
|
1016
|
+
/** Joomla user ID (joomla.users.id) that owns the cart */
|
|
1017
|
+
userId: number;
|
|
1018
|
+
/** Cart ID from the previous saved-cart system */
|
|
1019
|
+
oldId: number | null;
|
|
1020
|
+
/** Cart name, unique per user (max 40 chars) */
|
|
1021
|
+
cartName: string;
|
|
1022
|
+
/** Serialized cart data from the old site */
|
|
1023
|
+
cartData: string | null;
|
|
1024
|
+
/** Serialized item list from the old site */
|
|
1025
|
+
itemList: string | null;
|
|
1026
|
+
/** Shared flag (1 = shared with other users, 0 = private) */
|
|
1027
|
+
shared: number | null;
|
|
1028
|
+
/** Date the cart was last modified (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1029
|
+
dateLastModified: string;
|
|
1030
|
+
/** Date the owner was last notified about the cart (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1031
|
+
dateLastNotify: string | null;
|
|
1032
|
+
/** Date the cart was created (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1033
|
+
dateCreated: string | null;
|
|
1034
|
+
/** Update code (1185 = Import Complete) */
|
|
1035
|
+
updateCd: number;
|
|
1036
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
1037
|
+
statusCd: number;
|
|
1038
|
+
/** Process code (704 = Active, 1185 = Import Complete) */
|
|
1039
|
+
processCd: number;
|
|
1040
|
+
[key: string]: unknown;
|
|
1041
|
+
}
|
|
1042
|
+
/** Returned by: api.legacy.savedCarts.list(params) */
|
|
1043
|
+
export type SavedCartsListData = SavedCartsListItem[];
|
|
1044
|
+
/**
|
|
1045
|
+
* Get Saved Cart
|
|
1046
|
+
* Response data for GET /saved-carts/{id} — MINIMUM fields, extras pass through
|
|
1047
|
+
*
|
|
1048
|
+
* Returned by: api.legacy.savedCarts.get(id)
|
|
1049
|
+
*/
|
|
1050
|
+
export type SavedCartsGetData = SavedCartsListItem;
|
|
1051
|
+
/**
|
|
1052
|
+
* List Saved Cart Lines
|
|
1053
|
+
* Response data for GET /saved-carts/{id}/items — MINIMUM fields, extras pass through
|
|
1054
|
+
*
|
|
1055
|
+
* Returned by: api.legacy.savedCarts.items.list(id, params) (array items)
|
|
1056
|
+
*/
|
|
1057
|
+
export interface SavedCartsItemsListItem {
|
|
1058
|
+
/** Saved cart (saved_carts.id) the line belongs to */
|
|
1059
|
+
savedCartsId: number;
|
|
1060
|
+
/** Line option key data from the old site (max 8000 chars) */
|
|
1061
|
+
keyData: string | null;
|
|
1062
|
+
/** Item (inv_mast) on the line */
|
|
1063
|
+
invMastUid: number | null;
|
|
1064
|
+
/** Quantity on the line */
|
|
1065
|
+
qty: number | null;
|
|
1066
|
+
/** Unit of measure for the quantity (max 8 chars) */
|
|
1067
|
+
uom: string | null;
|
|
1068
|
+
/** Serialized extra line data from the old site */
|
|
1069
|
+
otherData: string | null;
|
|
1070
|
+
/** Line option key names from the old site (max 8000 chars) */
|
|
1071
|
+
keyNames: string | null;
|
|
1072
|
+
/** Display order of the line in the cart */
|
|
1073
|
+
ordering: number | null;
|
|
1074
|
+
/** Saved cart line ID (32-character string) (max 32 chars) */
|
|
1075
|
+
savedCartsItemsUid: string;
|
|
1076
|
+
/** Update code (1185 = Import Complete) */
|
|
1077
|
+
updateCd: number;
|
|
1078
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
1079
|
+
statusCd: number;
|
|
1080
|
+
/** Process code (704 = Active, 1185 = Import Complete) */
|
|
1081
|
+
processCd: number;
|
|
1082
|
+
[key: string]: unknown;
|
|
1083
|
+
}
|
|
1084
|
+
/** Returned by: api.legacy.savedCarts.items.list(id, params) */
|
|
1085
|
+
export type SavedCartsItemsListData = SavedCartsItemsListItem[];
|
|
1086
|
+
export interface LegacyClientSpec {
|
|
1087
|
+
invMast: {
|
|
1088
|
+
alsoBought: {
|
|
1089
|
+
/**
|
|
1090
|
+
* List item Also Bought
|
|
1091
|
+
* Call: api.legacy.invMast.alsoBought.list(invMastUid, params)
|
|
1092
|
+
*
|
|
1093
|
+
* Response data, each item: The full item doc (InvMastHelper::generateDoc)
|
|
1094
|
+
*
|
|
1095
|
+
* Errors:
|
|
1096
|
+
* 404: No inv_mast row with this invMastUid.
|
|
1097
|
+
*
|
|
1098
|
+
* GET https://legacy.augur-api.com/inv-mast/{invMastUid}/also-bought
|
|
1099
|
+
* Contract:
|
|
1100
|
+
* https://legacy.augur-api.com/openapi.json#/paths/~1inv-mast~1{invMastUid}~1also-bought/get
|
|
1101
|
+
*
|
|
1102
|
+
* @param invMastUid Unique identifier of the item (inv_mast) whose also-bought items are
|
|
1103
|
+
* listed
|
|
1104
|
+
* @param params InvMastAlsoBoughtListParams (query string)
|
|
1105
|
+
* @returns BaseResponse whose `data` is InvMastAlsoBoughtListData
|
|
1106
|
+
*/
|
|
1107
|
+
list: (invMastUid: number, params?: InvMastAlsoBoughtListParams) => Promise<BaseResponse<InvMastAlsoBoughtListData>>;
|
|
1108
|
+
};
|
|
1109
|
+
tags: {
|
|
1110
|
+
/**
|
|
1111
|
+
* List Inv Mast Tags
|
|
1112
|
+
* Call: api.legacy.invMast.tags.list(invMastUid, params)
|
|
1113
|
+
*
|
|
1114
|
+
* Errors:
|
|
1115
|
+
* 400: invMastUid is below 1, or orderBy is not column|ASC or column|DESC on an
|
|
1116
|
+
* inv_mast_tags column.
|
|
1117
|
+
* 404: No item (inv_mast) with this invMastUid.
|
|
1118
|
+
*
|
|
1119
|
+
* GET https://legacy.augur-api.com/inv-mast/{invMastUid}/tags
|
|
1120
|
+
* Contract:
|
|
1121
|
+
* https://legacy.augur-api.com/openapi.json#/paths/~1inv-mast~1{invMastUid}~1tags/get
|
|
1122
|
+
*
|
|
1123
|
+
* @param invMastUid Unique identifier of the item (inv_mast) the tag belongs to
|
|
1124
|
+
* @param params InvMastTagsListParams (query string)
|
|
1125
|
+
* @returns BaseResponse whose `data` is InvMastTagsListData
|
|
1126
|
+
*/
|
|
1127
|
+
list: (invMastUid: number, params?: InvMastTagsListParams) => Promise<BaseResponse<InvMastTagsListData>>;
|
|
1128
|
+
/**
|
|
1129
|
+
* Create Inv Mast Tag
|
|
1130
|
+
* Call: api.legacy.invMast.tags.create(invMastUid, data)
|
|
1131
|
+
*
|
|
1132
|
+
* Request body: Add a tag to the item in the path
|
|
1133
|
+
*
|
|
1134
|
+
* Errors:
|
|
1135
|
+
* 400: invMastUid is below 1, or the body is missing or not a JSON object.
|
|
1136
|
+
* 404: No item (inv_mast) with this invMastUid.
|
|
1137
|
+
*
|
|
1138
|
+
* POST https://legacy.augur-api.com/inv-mast/{invMastUid}/tags
|
|
1139
|
+
* Contract:
|
|
1140
|
+
* https://legacy.augur-api.com/openapi.json#/paths/~1inv-mast~1{invMastUid}~1tags/post
|
|
1141
|
+
*
|
|
1142
|
+
* @param invMastUid Unique identifier of the item (inv_mast) the tag belongs to
|
|
1143
|
+
* @param data InvMastTagsCreateBody (request body)
|
|
1144
|
+
* @returns BaseResponse whose `data` is InvMastTagsCreateData
|
|
1145
|
+
*/
|
|
1146
|
+
create: (invMastUid: number, data: InvMastTagsCreateBody) => Promise<BaseResponse<InvMastTagsCreateData>>;
|
|
1147
|
+
/**
|
|
1148
|
+
* Get Inv Mast Tag Details
|
|
1149
|
+
* Call: api.legacy.invMast.tags.get(invMastUid, invMastTagsUid)
|
|
1150
|
+
*
|
|
1151
|
+
* Errors:
|
|
1152
|
+
* 404: No item (inv_mast) with this invMastUid, or no tag with this ID on that item.
|
|
1153
|
+
*
|
|
1154
|
+
* GET https://legacy.augur-api.com/inv-mast/{invMastUid}/tags/{invMastTagsUid}
|
|
1155
|
+
* Contract:
|
|
1156
|
+
* https://legacy.augur-api.com/openapi.json#/paths/~1inv-mast~1{invMastUid}~1tags~1{invMastTagsUid}/get
|
|
1157
|
+
*
|
|
1158
|
+
* @param invMastUid Unique identifier of the item (inv_mast) the tag belongs to
|
|
1159
|
+
* @param invMastTagsUid Unique identifier of the item tag
|
|
1160
|
+
* @param params InvMastTagsGetParams (query string)
|
|
1161
|
+
* @returns BaseResponse whose `data` is InvMastTagsGetData
|
|
1162
|
+
*/
|
|
1163
|
+
get: (invMastUid: number, invMastTagsUid: number, params?: InvMastTagsGetParams) => Promise<BaseResponse<InvMastTagsGetData>>;
|
|
1164
|
+
/**
|
|
1165
|
+
* Update Inv Mast Tag
|
|
1166
|
+
* Call: api.legacy.invMast.tags.update(invMastUid, invMastTagsUid, data)
|
|
1167
|
+
*
|
|
1168
|
+
* Request body: Partial update of an item tag; an absent field keeps its current value
|
|
1169
|
+
*
|
|
1170
|
+
* Errors:
|
|
1171
|
+
* 400: invMastUid is below 1, or the body is missing or not a JSON object.
|
|
1172
|
+
* 404: No item (inv_mast) with this invMastUid, or no tag with this ID on that item.
|
|
1173
|
+
*
|
|
1174
|
+
* PUT https://legacy.augur-api.com/inv-mast/{invMastUid}/tags/{invMastTagsUid}
|
|
1175
|
+
* Contract:
|
|
1176
|
+
* https://legacy.augur-api.com/openapi.json#/paths/~1inv-mast~1{invMastUid}~1tags~1{invMastTagsUid}/put
|
|
1177
|
+
*
|
|
1178
|
+
* @param invMastUid Unique identifier of the item (inv_mast) the tag belongs to
|
|
1179
|
+
* @param invMastTagsUid Unique identifier of the item tag
|
|
1180
|
+
* @param data InvMastTagsUpdateBody (request body)
|
|
1181
|
+
* @returns BaseResponse whose `data` is InvMastTagsUpdateData
|
|
1182
|
+
*/
|
|
1183
|
+
update: (invMastUid: number, invMastTagsUid: number, data: InvMastTagsUpdateBody) => Promise<BaseResponse<InvMastTagsUpdateData>>;
|
|
1184
|
+
/**
|
|
1185
|
+
* Delete Inv Mast Tag
|
|
1186
|
+
* Call: api.legacy.invMast.tags.delete(invMastUid, invMastTagsUid)
|
|
1187
|
+
*
|
|
1188
|
+
* Errors:
|
|
1189
|
+
* 404: No item (inv_mast) with this invMastUid, or no tag with this ID on that item.
|
|
1190
|
+
*
|
|
1191
|
+
* DELETE https://legacy.augur-api.com/inv-mast/{invMastUid}/tags/{invMastTagsUid}
|
|
1192
|
+
* Contract:
|
|
1193
|
+
* https://legacy.augur-api.com/openapi.json#/paths/~1inv-mast~1{invMastUid}~1tags~1{invMastTagsUid}/delete
|
|
1194
|
+
*
|
|
1195
|
+
* @param invMastUid Unique identifier of the item (inv_mast) the tag belongs to
|
|
1196
|
+
* @param invMastTagsUid Unique identifier of the item tag
|
|
1197
|
+
* @returns BaseResponse whose `data` is InvMastTagsDeleteData
|
|
1198
|
+
*/
|
|
1199
|
+
delete: (invMastUid: number, invMastTagsUid: number) => Promise<BaseResponse<InvMastTagsDeleteData>>;
|
|
1200
|
+
};
|
|
1201
|
+
webDesc: {
|
|
1202
|
+
/**
|
|
1203
|
+
* List item Web Descriptions
|
|
1204
|
+
* Call: api.legacy.invMast.webDesc.list(invMastUid, params)
|
|
1205
|
+
*
|
|
1206
|
+
* Errors:
|
|
1207
|
+
* 400: orderBy is not column|ASC or column|DESC on an inv_mast_web_desc column.
|
|
1208
|
+
* 404: No inv_mast row with this invMastUid.
|
|
1209
|
+
*
|
|
1210
|
+
* GET https://legacy.augur-api.com/inv-mast/{invMastUid}/web-desc
|
|
1211
|
+
* Contract:
|
|
1212
|
+
* https://legacy.augur-api.com/openapi.json#/paths/~1inv-mast~1{invMastUid}~1web-desc/get
|
|
1213
|
+
*
|
|
1214
|
+
* @param invMastUid Unique identifier of the item (inv_mast) the web description belongs to
|
|
1215
|
+
* @param params InvMastWebDescListParams (query string)
|
|
1216
|
+
* @returns BaseResponse whose `data` is InvMastWebDescListData
|
|
1217
|
+
*/
|
|
1218
|
+
list: (invMastUid: number, params?: InvMastWebDescListParams) => Promise<BaseResponse<InvMastWebDescListData>>;
|
|
1219
|
+
/**
|
|
1220
|
+
* Create Web Description for Item
|
|
1221
|
+
* Call: api.legacy.invMast.webDesc.create(invMastUid, data)
|
|
1222
|
+
*
|
|
1223
|
+
* Request body: Create the web descriptions for the item in the path, or return the existing
|
|
1224
|
+
* row
|
|
1225
|
+
*
|
|
1226
|
+
* Errors:
|
|
1227
|
+
* 400: The body is missing or not a JSON object.
|
|
1228
|
+
* 404: No inv_mast row with this invMastUid.
|
|
1229
|
+
*
|
|
1230
|
+
* POST https://legacy.augur-api.com/inv-mast/{invMastUid}/web-desc
|
|
1231
|
+
* Contract:
|
|
1232
|
+
* https://legacy.augur-api.com/openapi.json#/paths/~1inv-mast~1{invMastUid}~1web-desc/post
|
|
1233
|
+
*
|
|
1234
|
+
* @param invMastUid Unique identifier of the item (inv_mast) the web description belongs to
|
|
1235
|
+
* @param data InvMastWebDescCreateBody (request body)
|
|
1236
|
+
* @returns BaseResponse whose `data` is InvMastWebDescCreateData
|
|
1237
|
+
*/
|
|
1238
|
+
create: (invMastUid: number, data: InvMastWebDescCreateBody) => Promise<BaseResponse<InvMastWebDescCreateData>>;
|
|
1239
|
+
/**
|
|
1240
|
+
* Get Item Web Description
|
|
1241
|
+
* Call: api.legacy.invMast.webDesc.get(invMastUid, invMastWebDescUid)
|
|
1242
|
+
*
|
|
1243
|
+
* Errors:
|
|
1244
|
+
* 404: No item web description with this ID.
|
|
1245
|
+
*
|
|
1246
|
+
* GET https://legacy.augur-api.com/inv-mast/{invMastUid}/web-desc/{invMastWebDescUid}
|
|
1247
|
+
* Contract:
|
|
1248
|
+
* https://legacy.augur-api.com/openapi.json#/paths/~1inv-mast~1{invMastUid}~1web-desc~1{invMastWebDescUid}/get
|
|
1249
|
+
*
|
|
1250
|
+
* @param invMastUid Unique identifier of the item (inv_mast) the web description belongs to
|
|
1251
|
+
* @param invMastWebDescUid Unique identifier of the item web description
|
|
1252
|
+
* @param params InvMastWebDescGetParams (query string)
|
|
1253
|
+
* @returns BaseResponse whose `data` is InvMastWebDescGetData
|
|
1254
|
+
*/
|
|
1255
|
+
get: (invMastUid: number, invMastWebDescUid: number, params?: InvMastWebDescGetParams) => Promise<BaseResponse<InvMastWebDescGetData>>;
|
|
1256
|
+
/**
|
|
1257
|
+
* Update Item Web Description
|
|
1258
|
+
* Call: api.legacy.invMast.webDesc.update(invMastUid, invMastWebDescUid, data)
|
|
1259
|
+
*
|
|
1260
|
+
* Request body: Partial update of an item's web descriptions; an absent field keeps its
|
|
1261
|
+
* current value
|
|
1262
|
+
*
|
|
1263
|
+
* Errors:
|
|
1264
|
+
* 400: The body is missing or not a JSON object.
|
|
1265
|
+
* 404: No item web description with this ID.
|
|
1266
|
+
*
|
|
1267
|
+
* PUT https://legacy.augur-api.com/inv-mast/{invMastUid}/web-desc/{invMastWebDescUid}
|
|
1268
|
+
* Contract:
|
|
1269
|
+
* https://legacy.augur-api.com/openapi.json#/paths/~1inv-mast~1{invMastUid}~1web-desc~1{invMastWebDescUid}/put
|
|
1270
|
+
*
|
|
1271
|
+
* @param invMastUid Unique identifier of the item (inv_mast) the web description belongs to
|
|
1272
|
+
* @param invMastWebDescUid Unique identifier of the item web description
|
|
1273
|
+
* @param data InvMastWebDescUpdateBody (request body)
|
|
1274
|
+
* @returns BaseResponse whose `data` is InvMastWebDescUpdateData
|
|
1275
|
+
*/
|
|
1276
|
+
update: (invMastUid: number, invMastWebDescUid: number, data: InvMastWebDescUpdateBody) => Promise<BaseResponse<InvMastWebDescUpdateData>>;
|
|
1277
|
+
/**
|
|
1278
|
+
* Delete Item Web Description
|
|
1279
|
+
* Call: api.legacy.invMast.webDesc.delete(invMastUid, invMastWebDescUid)
|
|
1280
|
+
*
|
|
1281
|
+
* Errors:
|
|
1282
|
+
* 404: No item web description with this ID.
|
|
1283
|
+
*
|
|
1284
|
+
* DELETE https://legacy.augur-api.com/inv-mast/{invMastUid}/web-desc/{invMastWebDescUid}
|
|
1285
|
+
* Contract:
|
|
1286
|
+
* https://legacy.augur-api.com/openapi.json#/paths/~1inv-mast~1{invMastUid}~1web-desc~1{invMastWebDescUid}/delete
|
|
1287
|
+
*
|
|
1288
|
+
* @param invMastUid Unique identifier of the item (inv_mast) the web description belongs to
|
|
1289
|
+
* @param invMastWebDescUid Unique identifier of the item web description
|
|
1290
|
+
* @returns BaseResponse whose `data` is InvMastWebDescDeleteData
|
|
1291
|
+
*/
|
|
1292
|
+
delete: (invMastUid: number, invMastWebDescUid: number) => Promise<BaseResponse<InvMastWebDescDeleteData>>;
|
|
1293
|
+
};
|
|
1294
|
+
};
|
|
1295
|
+
itemCategory: {
|
|
1296
|
+
/**
|
|
1297
|
+
* Get Item Category Details
|
|
1298
|
+
* Call: api.legacy.itemCategory.get(itemCategoryUid)
|
|
1299
|
+
*
|
|
1300
|
+
* Errors:
|
|
1301
|
+
* 404: No item category with this ID.
|
|
1302
|
+
*
|
|
1303
|
+
* GET https://legacy.augur-api.com/item-category/{itemCategoryUid}
|
|
1304
|
+
* Contract:
|
|
1305
|
+
* https://legacy.augur-api.com/openapi.json#/paths/~1item-category~1{itemCategoryUid}/get
|
|
1306
|
+
*
|
|
1307
|
+
* @param itemCategoryUid Unique identifier of the item category
|
|
1308
|
+
* @param params ItemCategoryGetParams (query string)
|
|
1309
|
+
* @returns BaseResponse whose `data` is ItemCategoryGetData
|
|
1310
|
+
*/
|
|
1311
|
+
get: (itemCategoryUid: number, params?: ItemCategoryGetParams) => Promise<BaseResponse<ItemCategoryGetData>>;
|
|
1312
|
+
};
|
|
1313
|
+
legacy: {
|
|
1314
|
+
state: {
|
|
1315
|
+
/**
|
|
1316
|
+
* List States
|
|
1317
|
+
* Call: api.legacy.legacy.state.list(params)
|
|
1318
|
+
*
|
|
1319
|
+
* Errors:
|
|
1320
|
+
* 400: orderBy is not column|ASC or column|DESC on a state column.
|
|
1321
|
+
*
|
|
1322
|
+
* GET https://legacy.augur-api.com/legacy/state
|
|
1323
|
+
* Contract: https://legacy.augur-api.com/openapi.json#/paths/~1legacy~1state/get
|
|
1324
|
+
*
|
|
1325
|
+
* @param params LegacyStateListParams (query string)
|
|
1326
|
+
* @returns BaseResponse whose `data` is LegacyStateListData
|
|
1327
|
+
*/
|
|
1328
|
+
list: (params?: LegacyStateListParams) => Promise<BaseResponse<LegacyStateListData>>;
|
|
1329
|
+
/**
|
|
1330
|
+
* Create State
|
|
1331
|
+
* Call: api.legacy.legacy.state.create(data)
|
|
1332
|
+
*
|
|
1333
|
+
* Request body: Create a state, or return the existing one with the same two-letter code and
|
|
1334
|
+
* name
|
|
1335
|
+
*
|
|
1336
|
+
* Errors:
|
|
1337
|
+
* 400: The body is missing or not a JSON object. Or stateName or twoLetterCode is missing.
|
|
1338
|
+
*
|
|
1339
|
+
* POST https://legacy.augur-api.com/legacy/state
|
|
1340
|
+
* Contract: https://legacy.augur-api.com/openapi.json#/paths/~1legacy~1state/post
|
|
1341
|
+
*
|
|
1342
|
+
* @param data LegacyStateCreateBody (request body)
|
|
1343
|
+
* @returns BaseResponse whose `data` is LegacyStateCreateData
|
|
1344
|
+
*/
|
|
1345
|
+
create: (data: LegacyStateCreateBody) => Promise<BaseResponse<LegacyStateCreateData>>;
|
|
1346
|
+
/**
|
|
1347
|
+
* Get State Details
|
|
1348
|
+
* Call: api.legacy.legacy.state.get(stateUid, params)
|
|
1349
|
+
*
|
|
1350
|
+
* Errors:
|
|
1351
|
+
* 400: stateUid is 0 and no twoLetterCode was sent.
|
|
1352
|
+
* 404: No state with this ID (or, for ID 0, with this twoLetterCode).
|
|
1353
|
+
*
|
|
1354
|
+
* GET https://legacy.augur-api.com/legacy/state/{stateUid}
|
|
1355
|
+
* Contract: https://legacy.augur-api.com/openapi.json#/paths/~1legacy~1state~1{stateUid}/get
|
|
1356
|
+
*
|
|
1357
|
+
* @param stateUid Unique identifier of the state; 0 looks the state up by twoLetterCode
|
|
1358
|
+
* @param params LegacyStateGetParams (query string)
|
|
1359
|
+
* @returns BaseResponse whose `data` is LegacyStateGetData
|
|
1360
|
+
*/
|
|
1361
|
+
get: (stateUid: number, params?: LegacyStateGetParams) => Promise<BaseResponse<LegacyStateGetData>>;
|
|
1362
|
+
/**
|
|
1363
|
+
* Update State
|
|
1364
|
+
* Call: api.legacy.legacy.state.update(stateUid, data)
|
|
1365
|
+
*
|
|
1366
|
+
* Request body: Partial update of a state; an absent field keeps its current value
|
|
1367
|
+
*
|
|
1368
|
+
* Errors:
|
|
1369
|
+
* 400: The body is missing or not a JSON object.
|
|
1370
|
+
* 404: No state with this ID.
|
|
1371
|
+
*
|
|
1372
|
+
* PUT https://legacy.augur-api.com/legacy/state/{stateUid}
|
|
1373
|
+
* Contract: https://legacy.augur-api.com/openapi.json#/paths/~1legacy~1state~1{stateUid}/put
|
|
1374
|
+
*
|
|
1375
|
+
* @param stateUid Unique identifier of the state
|
|
1376
|
+
* @param data LegacyStateUpdateBody (request body)
|
|
1377
|
+
* @returns BaseResponse whose `data` is LegacyStateUpdateData
|
|
1378
|
+
*/
|
|
1379
|
+
update: (stateUid: number, data: LegacyStateUpdateBody) => Promise<BaseResponse<LegacyStateUpdateData>>;
|
|
1380
|
+
/**
|
|
1381
|
+
* DELETE State
|
|
1382
|
+
* Call: api.legacy.legacy.state.delete(stateUid)
|
|
1383
|
+
*
|
|
1384
|
+
* Errors:
|
|
1385
|
+
* 404: No state with this ID.
|
|
1386
|
+
*
|
|
1387
|
+
* DELETE https://legacy.augur-api.com/legacy/state/{stateUid}
|
|
1388
|
+
* Contract:
|
|
1389
|
+
* https://legacy.augur-api.com/openapi.json#/paths/~1legacy~1state~1{stateUid}/delete
|
|
1390
|
+
*
|
|
1391
|
+
* @param stateUid Unique identifier of the state
|
|
1392
|
+
* @returns BaseResponse whose `data` is LegacyStateDeleteData
|
|
1393
|
+
*/
|
|
1394
|
+
delete: (stateUid: number) => Promise<BaseResponse<LegacyStateDeleteData>>;
|
|
1395
|
+
};
|
|
1396
|
+
};
|
|
1397
|
+
savedCarts: {
|
|
1398
|
+
/**
|
|
1399
|
+
* List Saved Carts
|
|
1400
|
+
* Call: api.legacy.savedCarts.list(params)
|
|
1401
|
+
*
|
|
1402
|
+
* List saved carts from the old site
|
|
1403
|
+
*
|
|
1404
|
+
* Errors:
|
|
1405
|
+
* 400: userId is not a number, or orderBy is not one saved_carts column with ASC or DESC.
|
|
1406
|
+
*
|
|
1407
|
+
* GET https://legacy.augur-api.com/saved-carts
|
|
1408
|
+
* Contract: https://legacy.augur-api.com/openapi.json#/paths/~1saved-carts/get
|
|
1409
|
+
*
|
|
1410
|
+
* @param params SavedCartsListParams (query string)
|
|
1411
|
+
* @returns BaseResponse whose `data` is SavedCartsListData
|
|
1412
|
+
*/
|
|
1413
|
+
list: (params?: SavedCartsListParams) => Promise<BaseResponse<SavedCartsListData>>;
|
|
1414
|
+
/**
|
|
1415
|
+
* Get Saved Cart
|
|
1416
|
+
* Call: api.legacy.savedCarts.get(id)
|
|
1417
|
+
*
|
|
1418
|
+
* Get one saved cart from the old site
|
|
1419
|
+
*
|
|
1420
|
+
* Errors:
|
|
1421
|
+
* 400: id is below 1.
|
|
1422
|
+
* 404: No saved cart with this id.
|
|
1423
|
+
*
|
|
1424
|
+
* GET https://legacy.augur-api.com/saved-carts/{id}
|
|
1425
|
+
* Contract: https://legacy.augur-api.com/openapi.json#/paths/~1saved-carts~1{id}/get
|
|
1426
|
+
*
|
|
1427
|
+
* @param id Saved cart ID (saved_carts.id)
|
|
1428
|
+
* @param params SavedCartsGetParams (query string)
|
|
1429
|
+
* @returns BaseResponse whose `data` is SavedCartsGetData
|
|
1430
|
+
*/
|
|
1431
|
+
get: (id: number, params?: SavedCartsGetParams) => Promise<BaseResponse<SavedCartsGetData>>;
|
|
1432
|
+
items: {
|
|
1433
|
+
/**
|
|
1434
|
+
* List Saved Cart Lines
|
|
1435
|
+
* Call: api.legacy.savedCarts.items.list(id, params)
|
|
1436
|
+
*
|
|
1437
|
+
* List the lines of one saved cart from the old site
|
|
1438
|
+
*
|
|
1439
|
+
* Errors:
|
|
1440
|
+
* 400: id is below 1, or orderBy is not one saved_carts_items column with ASC or DESC.
|
|
1441
|
+
* 404: No saved cart with this id.
|
|
1442
|
+
*
|
|
1443
|
+
* GET https://legacy.augur-api.com/saved-carts/{id}/items
|
|
1444
|
+
* Contract: https://legacy.augur-api.com/openapi.json#/paths/~1saved-carts~1{id}~1items/get
|
|
1445
|
+
*
|
|
1446
|
+
* @param id Saved cart ID (saved_carts.id) whose lines to list
|
|
1447
|
+
* @param params SavedCartsItemsListParams (query string)
|
|
1448
|
+
* @returns BaseResponse whose `data` is SavedCartsItemsListData
|
|
1449
|
+
*/
|
|
1450
|
+
list: (id: number, params?: SavedCartsItemsListParams) => Promise<BaseResponse<SavedCartsItemsListData>>;
|
|
1451
|
+
};
|
|
1452
|
+
};
|
|
1453
|
+
}
|
|
1454
|
+
//# sourceMappingURL=types.d.ts.map
|