@simpleapps-com/augur-api 0.2.13 → 0.3.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/API-DISCOVERY.md +8 -8
- package/PERFORMANCE.md +7 -7
- package/QUICKSTART.md +4 -4
- package/README.md +84 -18
- package/dist/cjs/index.d.ts +12 -1
- package/dist/cjs/index.d.ts.map +1 -1
- package/dist/cjs/index.js +24 -2
- package/dist/cjs/index.js.map +1 -1
- package/dist/cjs/services/agr-info/client.d.ts +613 -0
- package/dist/cjs/services/agr-info/client.d.ts.map +1 -0
- package/dist/cjs/services/agr-info/client.js +472 -0
- package/dist/cjs/services/agr-info/client.js.map +1 -0
- package/dist/cjs/services/agr-info/index.d.ts +3 -0
- package/dist/cjs/services/agr-info/index.d.ts.map +1 -0
- package/dist/cjs/services/agr-info/index.js +6 -0
- package/dist/cjs/services/agr-info/index.js.map +1 -0
- package/dist/cjs/services/agr-info/schemas.d.ts +728 -0
- package/dist/cjs/services/agr-info/schemas.d.ts.map +1 -0
- package/dist/cjs/services/agr-info/schemas.js +84 -0
- package/dist/cjs/services/agr-info/schemas.js.map +1 -0
- package/dist/cjs/services/agr-work/client.d.ts +122 -0
- package/dist/cjs/services/agr-work/client.d.ts.map +1 -0
- package/dist/cjs/services/agr-work/client.js +119 -0
- package/dist/cjs/services/agr-work/client.js.map +1 -0
- package/dist/cjs/services/agr-work/index.d.ts +3 -0
- package/dist/cjs/services/agr-work/index.d.ts.map +1 -0
- package/dist/cjs/services/agr-work/index.js +6 -0
- package/dist/cjs/services/agr-work/index.js.map +1 -0
- package/dist/cjs/services/agr-work/schemas.d.ts +96 -0
- package/dist/cjs/services/agr-work/schemas.d.ts.map +1 -0
- package/dist/cjs/services/agr-work/schemas.js +10 -0
- package/dist/cjs/services/agr-work/schemas.js.map +1 -0
- package/dist/cjs/services/avalara/client.d.ts +337 -0
- package/dist/cjs/services/avalara/client.d.ts.map +1 -0
- package/dist/cjs/services/avalara/client.js +162 -0
- package/dist/cjs/services/avalara/client.js.map +1 -0
- package/dist/cjs/services/avalara/index.d.ts +3 -0
- package/dist/cjs/services/avalara/index.d.ts.map +1 -0
- package/dist/cjs/services/avalara/index.js +6 -0
- package/dist/cjs/services/avalara/index.js.map +1 -0
- package/dist/cjs/services/avalara/schemas.d.ts +1838 -0
- package/dist/cjs/services/avalara/schemas.d.ts.map +1 -0
- package/dist/cjs/services/avalara/schemas.js +121 -0
- package/dist/cjs/services/avalara/schemas.js.map +1 -0
- package/dist/cjs/services/brand-folder/client.d.ts +188 -0
- package/dist/cjs/services/brand-folder/client.d.ts.map +1 -0
- package/dist/cjs/services/brand-folder/client.js +150 -0
- package/dist/cjs/services/brand-folder/client.js.map +1 -0
- package/dist/cjs/services/brand-folder/index.d.ts +3 -0
- package/dist/cjs/services/brand-folder/index.d.ts.map +1 -0
- package/dist/cjs/services/brand-folder/index.js +6 -0
- package/dist/cjs/services/brand-folder/index.js.map +1 -0
- package/dist/cjs/services/brand-folder/schemas.d.ts +316 -0
- package/dist/cjs/services/brand-folder/schemas.d.ts.map +1 -0
- package/dist/cjs/services/brand-folder/schemas.js +55 -0
- package/dist/cjs/services/brand-folder/schemas.js.map +1 -0
- package/dist/cjs/services/customers/client.d.ts +4 -4
- package/dist/cjs/services/customers/schemas/addresses.d.ts +10 -10
- package/dist/cjs/services/customers/schemas/contacts.d.ts +16 -16
- package/dist/cjs/services/gregorovich/client.d.ts +336 -0
- package/dist/cjs/services/gregorovich/client.d.ts.map +1 -0
- package/dist/cjs/services/gregorovich/client.js +289 -0
- package/dist/cjs/services/gregorovich/client.js.map +1 -0
- package/dist/cjs/services/gregorovich/index.d.ts +3 -0
- package/dist/cjs/services/gregorovich/index.d.ts.map +1 -0
- package/dist/cjs/services/gregorovich/index.js +6 -0
- package/dist/cjs/services/gregorovich/index.js.map +1 -0
- package/dist/cjs/services/gregorovich/schemas.d.ts +1218 -0
- package/dist/cjs/services/gregorovich/schemas.d.ts.map +1 -0
- package/dist/cjs/services/gregorovich/schemas.js +201 -0
- package/dist/cjs/services/gregorovich/schemas.js.map +1 -0
- package/dist/cjs/services/items/client.d.ts +5191 -1327
- package/dist/cjs/services/items/client.d.ts.map +1 -1
- package/dist/cjs/services/items/client.js +2983 -334
- package/dist/cjs/services/items/client.js.map +1 -1
- package/dist/cjs/services/items/schemas/bins.d.ts +855 -0
- package/dist/cjs/services/items/schemas/bins.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/bins.js +85 -0
- package/dist/cjs/services/items/schemas/bins.js.map +1 -0
- package/dist/cjs/services/items/schemas/brandItems.d.ts +401 -0
- package/dist/cjs/services/items/schemas/brandItems.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/brandItems.js +48 -0
- package/dist/cjs/services/items/schemas/brandItems.js.map +1 -0
- package/dist/cjs/services/items/schemas/faq.d.ts +438 -0
- package/dist/cjs/services/items/schemas/faq.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/faq.js +57 -0
- package/dist/cjs/services/items/schemas/faq.js.map +1 -0
- package/dist/cjs/services/items/schemas/favorites.d.ts +315 -0
- package/dist/cjs/services/items/schemas/favorites.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/favorites.js +38 -0
- package/dist/cjs/services/items/schemas/favorites.js.map +1 -0
- package/dist/cjs/services/items/schemas/index.d.ts +8 -0
- package/dist/cjs/services/items/schemas/index.d.ts.map +1 -1
- package/dist/cjs/services/items/schemas/index.js +8 -0
- package/dist/cjs/services/items/schemas/index.js.map +1 -1
- package/dist/cjs/services/items/schemas/productLinks.d.ts +398 -0
- package/dist/cjs/services/items/schemas/productLinks.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/productLinks.js +47 -0
- package/dist/cjs/services/items/schemas/productLinks.js.map +1 -0
- package/dist/cjs/services/items/schemas/subparts.d.ts +461 -0
- package/dist/cjs/services/items/schemas/subparts.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/subparts.js +54 -0
- package/dist/cjs/services/items/schemas/subparts.js.map +1 -0
- package/dist/cjs/services/items/schemas/variants.d.ts +1255 -0
- package/dist/cjs/services/items/schemas/variants.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/variants.js +96 -0
- package/dist/cjs/services/items/schemas/variants.js.map +1 -0
- package/dist/cjs/services/items/schemas/wishlists.d.ts +1061 -0
- package/dist/cjs/services/items/schemas/wishlists.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/wishlists.js +81 -0
- package/dist/cjs/services/items/schemas/wishlists.js.map +1 -0
- package/dist/cjs/services/legacy/client.d.ts +15 -15
- package/dist/cjs/services/legacy/client.d.ts.map +1 -1
- package/dist/cjs/services/legacy/client.js +15 -15
- package/dist/cjs/services/legacy/client.js.map +1 -1
- package/dist/cjs/services/logistics/client.d.ts +239 -0
- package/dist/cjs/services/logistics/client.d.ts.map +1 -0
- package/dist/cjs/services/logistics/client.js +245 -0
- package/dist/cjs/services/logistics/client.js.map +1 -0
- package/dist/cjs/services/logistics/index.d.ts +4 -0
- package/dist/cjs/services/logistics/index.d.ts.map +1 -0
- package/dist/cjs/services/logistics/index.js +16 -0
- package/dist/cjs/services/logistics/index.js.map +1 -0
- package/dist/cjs/services/logistics/schemas.d.ts +28310 -0
- package/dist/cjs/services/logistics/schemas.d.ts.map +1 -0
- package/dist/cjs/services/logistics/schemas.js +198 -0
- package/dist/cjs/services/logistics/schemas.js.map +1 -0
- package/dist/cjs/services/orders/client.d.ts +55 -55
- package/dist/cjs/services/orders/client.d.ts.map +1 -1
- package/dist/cjs/services/orders/client.js +61 -61
- package/dist/cjs/services/orders/client.js.map +1 -1
- package/dist/cjs/services/orders/schemas/purchase-orders.d.ts +26 -26
- package/dist/cjs/services/orders/schemas/purchase-orders.js +1 -1
- package/dist/cjs/services/orders/schemas/purchase-orders.js.map +1 -1
- package/dist/cjs/services/p21-apis/client.d.ts +897 -0
- package/dist/cjs/services/p21-apis/client.d.ts.map +1 -0
- package/dist/cjs/services/p21-apis/client.js +957 -0
- package/dist/cjs/services/p21-apis/client.js.map +1 -0
- package/dist/cjs/services/p21-apis/index.d.ts +4 -0
- package/dist/cjs/services/p21-apis/index.d.ts.map +1 -0
- package/dist/cjs/services/p21-apis/index.js +41 -0
- package/dist/cjs/services/p21-apis/index.js.map +1 -0
- package/dist/cjs/services/p21-apis/schemas.d.ts +728 -0
- package/dist/cjs/services/p21-apis/schemas.d.ts.map +1 -0
- package/dist/cjs/services/p21-apis/schemas.js +184 -0
- package/dist/cjs/services/p21-apis/schemas.js.map +1 -0
- package/dist/cjs/services/p21-pim/client.d.ts +2 -2
- package/dist/cjs/services/p21-pim/client.d.ts.map +1 -1
- package/dist/cjs/services/p21-pim/client.js +2 -2
- package/dist/cjs/services/p21-pim/client.js.map +1 -1
- package/dist/cjs/services/p21-sism/client.d.ts +3 -3
- package/dist/cjs/services/p21-sism/client.d.ts.map +1 -1
- package/dist/cjs/services/p21-sism/client.js +4 -4
- package/dist/cjs/services/p21-sism/client.js.map +1 -1
- package/dist/cjs/services/pricing/client.d.ts +69 -57
- package/dist/cjs/services/pricing/client.d.ts.map +1 -1
- package/dist/cjs/services/pricing/client.js +87 -75
- package/dist/cjs/services/pricing/client.js.map +1 -1
- package/dist/cjs/services/shipping/client.d.ts +201 -0
- package/dist/cjs/services/shipping/client.d.ts.map +1 -0
- package/dist/cjs/services/shipping/client.js +224 -0
- package/dist/cjs/services/shipping/client.js.map +1 -0
- package/dist/cjs/services/shipping/index.d.ts +4 -0
- package/dist/cjs/services/shipping/index.d.ts.map +1 -0
- package/dist/cjs/services/shipping/index.js +18 -0
- package/dist/cjs/services/shipping/index.js.map +1 -0
- package/dist/cjs/services/shipping/schemas.d.ts +6732 -0
- package/dist/cjs/services/shipping/schemas.d.ts.map +1 -0
- package/dist/cjs/services/shipping/schemas.js +189 -0
- package/dist/cjs/services/shipping/schemas.js.map +1 -0
- package/dist/cjs/services/slack/client.d.ts +285 -0
- package/dist/cjs/services/slack/client.d.ts.map +1 -0
- package/dist/cjs/services/slack/client.js +316 -0
- package/dist/cjs/services/slack/client.js.map +1 -0
- package/dist/cjs/services/slack/index.d.ts +4 -0
- package/dist/cjs/services/slack/index.d.ts.map +1 -0
- package/dist/cjs/services/slack/index.js +18 -0
- package/dist/cjs/services/slack/index.js.map +1 -0
- package/dist/cjs/services/slack/schemas.d.ts +719 -0
- package/dist/cjs/services/slack/schemas.d.ts.map +1 -0
- package/dist/cjs/services/slack/schemas.js +148 -0
- package/dist/cjs/services/slack/schemas.js.map +1 -0
- package/dist/cjs/services/smarty-streets/client.d.ts +237 -0
- package/dist/cjs/services/smarty-streets/client.d.ts.map +1 -0
- package/dist/cjs/services/smarty-streets/client.js +275 -0
- package/dist/cjs/services/smarty-streets/client.js.map +1 -0
- package/dist/cjs/services/smarty-streets/index.d.ts +4 -0
- package/dist/cjs/services/smarty-streets/index.d.ts.map +1 -0
- package/dist/cjs/services/smarty-streets/index.js +22 -0
- package/dist/cjs/services/smarty-streets/index.js.map +1 -0
- package/dist/cjs/services/smarty-streets/schemas.d.ts +2229 -0
- package/dist/cjs/services/smarty-streets/schemas.d.ts.map +1 -0
- package/dist/cjs/services/smarty-streets/schemas.js +183 -0
- package/dist/cjs/services/smarty-streets/schemas.js.map +1 -0
- package/dist/cjs/services/ups/client.d.ts +215 -0
- package/dist/cjs/services/ups/client.d.ts.map +1 -0
- package/dist/cjs/services/ups/client.js +243 -0
- package/dist/cjs/services/ups/client.js.map +1 -0
- package/dist/cjs/services/ups/index.d.ts +4 -0
- package/dist/cjs/services/ups/index.d.ts.map +1 -0
- package/dist/cjs/services/ups/index.js +18 -0
- package/dist/cjs/services/ups/index.js.map +1 -0
- package/dist/cjs/services/ups/schemas.d.ts +1887 -0
- package/dist/cjs/services/ups/schemas.d.ts.map +1 -0
- package/dist/cjs/services/ups/schemas.js +201 -0
- package/dist/cjs/services/ups/schemas.js.map +1 -0
- package/dist/cjs/services/vmi/client.d.ts +17 -17
- package/dist/cjs/services/vmi/client.d.ts.map +1 -1
- package/dist/cjs/services/vmi/client.js +29 -29
- package/dist/cjs/services/vmi/client.js.map +1 -1
- package/dist/esm/index.d.ts +12 -1
- package/dist/esm/index.d.ts.map +1 -1
- package/dist/esm/index.js +12 -1
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/services/agr-info/client.d.ts +613 -0
- package/dist/esm/services/agr-info/client.d.ts.map +1 -0
- package/dist/esm/services/agr-info/client.js +478 -0
- package/dist/esm/services/agr-info/client.js.map +1 -0
- package/dist/esm/services/agr-info/index.d.ts +3 -0
- package/dist/esm/services/agr-info/index.d.ts.map +1 -0
- package/dist/esm/services/agr-info/index.js +2 -0
- package/dist/esm/services/agr-info/index.js.map +1 -0
- package/dist/esm/services/agr-info/schemas.d.ts +728 -0
- package/dist/esm/services/agr-info/schemas.d.ts.map +1 -0
- package/dist/esm/services/agr-info/schemas.js +81 -0
- package/dist/esm/services/agr-info/schemas.js.map +1 -0
- package/dist/esm/services/agr-work/client.d.ts +122 -0
- package/dist/esm/services/agr-work/client.d.ts.map +1 -0
- package/dist/esm/services/agr-work/client.js +115 -0
- package/dist/esm/services/agr-work/client.js.map +1 -0
- package/dist/esm/services/agr-work/index.d.ts +3 -0
- package/dist/esm/services/agr-work/index.d.ts.map +1 -0
- package/dist/esm/services/agr-work/index.js +2 -0
- package/dist/esm/services/agr-work/index.js.map +1 -0
- package/dist/esm/services/agr-work/schemas.d.ts +96 -0
- package/dist/esm/services/agr-work/schemas.d.ts.map +1 -0
- package/dist/esm/services/agr-work/schemas.js +7 -0
- package/dist/esm/services/agr-work/schemas.js.map +1 -0
- package/dist/esm/services/avalara/client.d.ts +337 -0
- package/dist/esm/services/avalara/client.d.ts.map +1 -0
- package/dist/esm/services/avalara/client.js +158 -0
- package/dist/esm/services/avalara/client.js.map +1 -0
- package/dist/esm/services/avalara/index.d.ts +3 -0
- package/dist/esm/services/avalara/index.d.ts.map +1 -0
- package/dist/esm/services/avalara/index.js +2 -0
- package/dist/esm/services/avalara/index.js.map +1 -0
- package/dist/esm/services/avalara/schemas.d.ts +1838 -0
- package/dist/esm/services/avalara/schemas.d.ts.map +1 -0
- package/dist/esm/services/avalara/schemas.js +118 -0
- package/dist/esm/services/avalara/schemas.js.map +1 -0
- package/dist/esm/services/brand-folder/client.d.ts +188 -0
- package/dist/esm/services/brand-folder/client.d.ts.map +1 -0
- package/dist/esm/services/brand-folder/client.js +146 -0
- package/dist/esm/services/brand-folder/client.js.map +1 -0
- package/dist/esm/services/brand-folder/index.d.ts +3 -0
- package/dist/esm/services/brand-folder/index.d.ts.map +1 -0
- package/dist/esm/services/brand-folder/index.js +2 -0
- package/dist/esm/services/brand-folder/index.js.map +1 -0
- package/dist/esm/services/brand-folder/schemas.d.ts +316 -0
- package/dist/esm/services/brand-folder/schemas.d.ts.map +1 -0
- package/dist/esm/services/brand-folder/schemas.js +52 -0
- package/dist/esm/services/brand-folder/schemas.js.map +1 -0
- package/dist/esm/services/customers/client.d.ts +4 -4
- package/dist/esm/services/customers/schemas/addresses.d.ts +10 -10
- package/dist/esm/services/customers/schemas/contacts.d.ts +16 -16
- package/dist/esm/services/gregorovich/client.d.ts +336 -0
- package/dist/esm/services/gregorovich/client.d.ts.map +1 -0
- package/dist/esm/services/gregorovich/client.js +285 -0
- package/dist/esm/services/gregorovich/client.js.map +1 -0
- package/dist/esm/services/gregorovich/index.d.ts +3 -0
- package/dist/esm/services/gregorovich/index.d.ts.map +1 -0
- package/dist/esm/services/gregorovich/index.js +2 -0
- package/dist/esm/services/gregorovich/index.js.map +1 -0
- package/dist/esm/services/gregorovich/schemas.d.ts +1218 -0
- package/dist/esm/services/gregorovich/schemas.d.ts.map +1 -0
- package/dist/esm/services/gregorovich/schemas.js +198 -0
- package/dist/esm/services/gregorovich/schemas.js.map +1 -0
- package/dist/esm/services/items/client.d.ts +5191 -1327
- package/dist/esm/services/items/client.d.ts.map +1 -1
- package/dist/esm/services/items/client.js +3001 -337
- package/dist/esm/services/items/client.js.map +1 -1
- package/dist/esm/services/items/schemas/bins.d.ts +855 -0
- package/dist/esm/services/items/schemas/bins.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/bins.js +82 -0
- package/dist/esm/services/items/schemas/bins.js.map +1 -0
- package/dist/esm/services/items/schemas/brandItems.d.ts +401 -0
- package/dist/esm/services/items/schemas/brandItems.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/brandItems.js +45 -0
- package/dist/esm/services/items/schemas/brandItems.js.map +1 -0
- package/dist/esm/services/items/schemas/faq.d.ts +438 -0
- package/dist/esm/services/items/schemas/faq.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/faq.js +54 -0
- package/dist/esm/services/items/schemas/faq.js.map +1 -0
- package/dist/esm/services/items/schemas/favorites.d.ts +315 -0
- package/dist/esm/services/items/schemas/favorites.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/favorites.js +35 -0
- package/dist/esm/services/items/schemas/favorites.js.map +1 -0
- package/dist/esm/services/items/schemas/index.d.ts +8 -0
- package/dist/esm/services/items/schemas/index.d.ts.map +1 -1
- package/dist/esm/services/items/schemas/index.js +8 -0
- package/dist/esm/services/items/schemas/index.js.map +1 -1
- package/dist/esm/services/items/schemas/productLinks.d.ts +398 -0
- package/dist/esm/services/items/schemas/productLinks.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/productLinks.js +44 -0
- package/dist/esm/services/items/schemas/productLinks.js.map +1 -0
- package/dist/esm/services/items/schemas/subparts.d.ts +461 -0
- package/dist/esm/services/items/schemas/subparts.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/subparts.js +51 -0
- package/dist/esm/services/items/schemas/subparts.js.map +1 -0
- package/dist/esm/services/items/schemas/variants.d.ts +1255 -0
- package/dist/esm/services/items/schemas/variants.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/variants.js +93 -0
- package/dist/esm/services/items/schemas/variants.js.map +1 -0
- package/dist/esm/services/items/schemas/wishlists.d.ts +1061 -0
- package/dist/esm/services/items/schemas/wishlists.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/wishlists.js +78 -0
- package/dist/esm/services/items/schemas/wishlists.js.map +1 -0
- package/dist/esm/services/legacy/client.d.ts +15 -15
- package/dist/esm/services/legacy/client.d.ts.map +1 -1
- package/dist/esm/services/legacy/client.js +15 -15
- package/dist/esm/services/legacy/client.js.map +1 -1
- package/dist/esm/services/logistics/client.d.ts +239 -0
- package/dist/esm/services/logistics/client.d.ts.map +1 -0
- package/dist/esm/services/logistics/client.js +241 -0
- package/dist/esm/services/logistics/client.js.map +1 -0
- package/dist/esm/services/logistics/index.d.ts +4 -0
- package/dist/esm/services/logistics/index.d.ts.map +1 -0
- package/dist/esm/services/logistics/index.js +4 -0
- package/dist/esm/services/logistics/index.js.map +1 -0
- package/dist/esm/services/logistics/schemas.d.ts +28310 -0
- package/dist/esm/services/logistics/schemas.d.ts.map +1 -0
- package/dist/esm/services/logistics/schemas.js +195 -0
- package/dist/esm/services/logistics/schemas.js.map +1 -0
- package/dist/esm/services/orders/client.d.ts +55 -55
- package/dist/esm/services/orders/client.d.ts.map +1 -1
- package/dist/esm/services/orders/client.js +61 -61
- package/dist/esm/services/orders/client.js.map +1 -1
- package/dist/esm/services/orders/schemas/purchase-orders.d.ts +26 -26
- package/dist/esm/services/orders/schemas/purchase-orders.js +1 -1
- package/dist/esm/services/orders/schemas/purchase-orders.js.map +1 -1
- package/dist/esm/services/p21-apis/client.d.ts +897 -0
- package/dist/esm/services/p21-apis/client.d.ts.map +1 -0
- package/dist/esm/services/p21-apis/client.js +953 -0
- package/dist/esm/services/p21-apis/client.js.map +1 -0
- package/dist/esm/services/p21-apis/index.d.ts +4 -0
- package/dist/esm/services/p21-apis/index.d.ts.map +1 -0
- package/dist/esm/services/p21-apis/index.js +4 -0
- package/dist/esm/services/p21-apis/index.js.map +1 -0
- package/dist/esm/services/p21-apis/schemas.d.ts +728 -0
- package/dist/esm/services/p21-apis/schemas.d.ts.map +1 -0
- package/dist/esm/services/p21-apis/schemas.js +181 -0
- package/dist/esm/services/p21-apis/schemas.js.map +1 -0
- package/dist/esm/services/p21-pim/client.d.ts +2 -2
- package/dist/esm/services/p21-pim/client.d.ts.map +1 -1
- package/dist/esm/services/p21-pim/client.js +2 -2
- package/dist/esm/services/p21-pim/client.js.map +1 -1
- package/dist/esm/services/p21-sism/client.d.ts +3 -3
- package/dist/esm/services/p21-sism/client.d.ts.map +1 -1
- package/dist/esm/services/p21-sism/client.js +4 -4
- package/dist/esm/services/p21-sism/client.js.map +1 -1
- package/dist/esm/services/pricing/client.d.ts +69 -57
- package/dist/esm/services/pricing/client.d.ts.map +1 -1
- package/dist/esm/services/pricing/client.js +87 -75
- package/dist/esm/services/pricing/client.js.map +1 -1
- package/dist/esm/services/shipping/client.d.ts +201 -0
- package/dist/esm/services/shipping/client.d.ts.map +1 -0
- package/dist/esm/services/shipping/client.js +220 -0
- package/dist/esm/services/shipping/client.js.map +1 -0
- package/dist/esm/services/shipping/index.d.ts +4 -0
- package/dist/esm/services/shipping/index.d.ts.map +1 -0
- package/dist/esm/services/shipping/index.js +4 -0
- package/dist/esm/services/shipping/index.js.map +1 -0
- package/dist/esm/services/shipping/schemas.d.ts +6732 -0
- package/dist/esm/services/shipping/schemas.d.ts.map +1 -0
- package/dist/esm/services/shipping/schemas.js +186 -0
- package/dist/esm/services/shipping/schemas.js.map +1 -0
- package/dist/esm/services/slack/client.d.ts +285 -0
- package/dist/esm/services/slack/client.d.ts.map +1 -0
- package/dist/esm/services/slack/client.js +312 -0
- package/dist/esm/services/slack/client.js.map +1 -0
- package/dist/esm/services/slack/index.d.ts +4 -0
- package/dist/esm/services/slack/index.d.ts.map +1 -0
- package/dist/esm/services/slack/index.js +5 -0
- package/dist/esm/services/slack/index.js.map +1 -0
- package/dist/esm/services/slack/schemas.d.ts +719 -0
- package/dist/esm/services/slack/schemas.d.ts.map +1 -0
- package/dist/esm/services/slack/schemas.js +145 -0
- package/dist/esm/services/slack/schemas.js.map +1 -0
- package/dist/esm/services/smarty-streets/client.d.ts +237 -0
- package/dist/esm/services/smarty-streets/client.d.ts.map +1 -0
- package/dist/esm/services/smarty-streets/client.js +271 -0
- package/dist/esm/services/smarty-streets/client.js.map +1 -0
- package/dist/esm/services/smarty-streets/index.d.ts +4 -0
- package/dist/esm/services/smarty-streets/index.d.ts.map +1 -0
- package/dist/esm/services/smarty-streets/index.js +4 -0
- package/dist/esm/services/smarty-streets/index.js.map +1 -0
- package/dist/esm/services/smarty-streets/schemas.d.ts +2229 -0
- package/dist/esm/services/smarty-streets/schemas.d.ts.map +1 -0
- package/dist/esm/services/smarty-streets/schemas.js +180 -0
- package/dist/esm/services/smarty-streets/schemas.js.map +1 -0
- package/dist/esm/services/ups/client.d.ts +215 -0
- package/dist/esm/services/ups/client.d.ts.map +1 -0
- package/dist/esm/services/ups/client.js +239 -0
- package/dist/esm/services/ups/client.js.map +1 -0
- package/dist/esm/services/ups/index.d.ts +4 -0
- package/dist/esm/services/ups/index.d.ts.map +1 -0
- package/dist/esm/services/ups/index.js +4 -0
- package/dist/esm/services/ups/index.js.map +1 -0
- package/dist/esm/services/ups/schemas.d.ts +1887 -0
- package/dist/esm/services/ups/schemas.d.ts.map +1 -0
- package/dist/esm/services/ups/schemas.js +198 -0
- package/dist/esm/services/ups/schemas.js.map +1 -0
- package/dist/esm/services/vmi/client.d.ts +17 -17
- package/dist/esm/services/vmi/client.d.ts.map +1 -1
- package/dist/esm/services/vmi/client.js +29 -29
- package/dist/esm/services/vmi/client.js.map +1 -1
- package/dist/types/index.d.ts +12 -1
- package/dist/types/index.d.ts.map +1 -1
- package/dist/types/services/agr-info/client.d.ts +613 -0
- package/dist/types/services/agr-info/client.d.ts.map +1 -0
- package/dist/types/services/agr-info/index.d.ts +3 -0
- package/dist/types/services/agr-info/index.d.ts.map +1 -0
- package/dist/types/services/agr-info/schemas.d.ts +728 -0
- package/dist/types/services/agr-info/schemas.d.ts.map +1 -0
- package/dist/types/services/agr-work/client.d.ts +122 -0
- package/dist/types/services/agr-work/client.d.ts.map +1 -0
- package/dist/types/services/agr-work/index.d.ts +3 -0
- package/dist/types/services/agr-work/index.d.ts.map +1 -0
- package/dist/types/services/agr-work/schemas.d.ts +96 -0
- package/dist/types/services/agr-work/schemas.d.ts.map +1 -0
- package/dist/types/services/avalara/client.d.ts +337 -0
- package/dist/types/services/avalara/client.d.ts.map +1 -0
- package/dist/types/services/avalara/index.d.ts +3 -0
- package/dist/types/services/avalara/index.d.ts.map +1 -0
- package/dist/types/services/avalara/schemas.d.ts +1838 -0
- package/dist/types/services/avalara/schemas.d.ts.map +1 -0
- package/dist/types/services/brand-folder/client.d.ts +188 -0
- package/dist/types/services/brand-folder/client.d.ts.map +1 -0
- package/dist/types/services/brand-folder/index.d.ts +3 -0
- package/dist/types/services/brand-folder/index.d.ts.map +1 -0
- package/dist/types/services/brand-folder/schemas.d.ts +316 -0
- package/dist/types/services/brand-folder/schemas.d.ts.map +1 -0
- package/dist/types/services/customers/client.d.ts +4 -4
- package/dist/types/services/customers/schemas/addresses.d.ts +10 -10
- package/dist/types/services/customers/schemas/contacts.d.ts +16 -16
- package/dist/types/services/gregorovich/client.d.ts +336 -0
- package/dist/types/services/gregorovich/client.d.ts.map +1 -0
- package/dist/types/services/gregorovich/index.d.ts +3 -0
- package/dist/types/services/gregorovich/index.d.ts.map +1 -0
- package/dist/types/services/gregorovich/schemas.d.ts +1218 -0
- package/dist/types/services/gregorovich/schemas.d.ts.map +1 -0
- package/dist/types/services/items/client.d.ts +5191 -1327
- package/dist/types/services/items/client.d.ts.map +1 -1
- package/dist/types/services/items/schemas/bins.d.ts +855 -0
- package/dist/types/services/items/schemas/bins.d.ts.map +1 -0
- package/dist/types/services/items/schemas/brandItems.d.ts +401 -0
- package/dist/types/services/items/schemas/brandItems.d.ts.map +1 -0
- package/dist/types/services/items/schemas/faq.d.ts +438 -0
- package/dist/types/services/items/schemas/faq.d.ts.map +1 -0
- package/dist/types/services/items/schemas/favorites.d.ts +315 -0
- package/dist/types/services/items/schemas/favorites.d.ts.map +1 -0
- package/dist/types/services/items/schemas/index.d.ts +8 -0
- package/dist/types/services/items/schemas/index.d.ts.map +1 -1
- package/dist/types/services/items/schemas/productLinks.d.ts +398 -0
- package/dist/types/services/items/schemas/productLinks.d.ts.map +1 -0
- package/dist/types/services/items/schemas/subparts.d.ts +461 -0
- package/dist/types/services/items/schemas/subparts.d.ts.map +1 -0
- package/dist/types/services/items/schemas/variants.d.ts +1255 -0
- package/dist/types/services/items/schemas/variants.d.ts.map +1 -0
- package/dist/types/services/items/schemas/wishlists.d.ts +1061 -0
- package/dist/types/services/items/schemas/wishlists.d.ts.map +1 -0
- package/dist/types/services/legacy/client.d.ts +15 -15
- package/dist/types/services/legacy/client.d.ts.map +1 -1
- package/dist/types/services/logistics/client.d.ts +239 -0
- package/dist/types/services/logistics/client.d.ts.map +1 -0
- package/dist/types/services/logistics/index.d.ts +4 -0
- package/dist/types/services/logistics/index.d.ts.map +1 -0
- package/dist/types/services/logistics/schemas.d.ts +28310 -0
- package/dist/types/services/logistics/schemas.d.ts.map +1 -0
- package/dist/types/services/orders/client.d.ts +55 -55
- package/dist/types/services/orders/client.d.ts.map +1 -1
- package/dist/types/services/orders/schemas/purchase-orders.d.ts +26 -26
- package/dist/types/services/p21-apis/client.d.ts +897 -0
- package/dist/types/services/p21-apis/client.d.ts.map +1 -0
- package/dist/types/services/p21-apis/index.d.ts +4 -0
- package/dist/types/services/p21-apis/index.d.ts.map +1 -0
- package/dist/types/services/p21-apis/schemas.d.ts +728 -0
- package/dist/types/services/p21-apis/schemas.d.ts.map +1 -0
- package/dist/types/services/p21-pim/client.d.ts +2 -2
- package/dist/types/services/p21-pim/client.d.ts.map +1 -1
- package/dist/types/services/p21-sism/client.d.ts +3 -3
- package/dist/types/services/p21-sism/client.d.ts.map +1 -1
- package/dist/types/services/pricing/client.d.ts +69 -57
- package/dist/types/services/pricing/client.d.ts.map +1 -1
- package/dist/types/services/shipping/client.d.ts +201 -0
- package/dist/types/services/shipping/client.d.ts.map +1 -0
- package/dist/types/services/shipping/index.d.ts +4 -0
- package/dist/types/services/shipping/index.d.ts.map +1 -0
- package/dist/types/services/shipping/schemas.d.ts +6732 -0
- package/dist/types/services/shipping/schemas.d.ts.map +1 -0
- package/dist/types/services/slack/client.d.ts +285 -0
- package/dist/types/services/slack/client.d.ts.map +1 -0
- package/dist/types/services/slack/index.d.ts +4 -0
- package/dist/types/services/slack/index.d.ts.map +1 -0
- package/dist/types/services/slack/schemas.d.ts +719 -0
- package/dist/types/services/slack/schemas.d.ts.map +1 -0
- package/dist/types/services/smarty-streets/client.d.ts +237 -0
- package/dist/types/services/smarty-streets/client.d.ts.map +1 -0
- package/dist/types/services/smarty-streets/index.d.ts +4 -0
- package/dist/types/services/smarty-streets/index.d.ts.map +1 -0
- package/dist/types/services/smarty-streets/schemas.d.ts +2229 -0
- package/dist/types/services/smarty-streets/schemas.d.ts.map +1 -0
- package/dist/types/services/ups/client.d.ts +215 -0
- package/dist/types/services/ups/client.d.ts.map +1 -0
- package/dist/types/services/ups/index.d.ts +4 -0
- package/dist/types/services/ups/index.d.ts.map +1 -0
- package/dist/types/services/ups/schemas.d.ts +1887 -0
- package/dist/types/services/ups/schemas.d.ts.map +1 -0
- package/dist/types/services/vmi/client.d.ts +17 -17
- package/dist/types/services/vmi/client.d.ts.map +1 -1
- package/package.json +1 -1
|
@@ -12,10 +12,10 @@ import { PriceEngineParamsSchema, PriceEngineResponseSchema, TaxEngineRequestSch
|
|
|
12
12
|
* const pricing = new PricingClient(http);
|
|
13
13
|
*
|
|
14
14
|
* // Get item price
|
|
15
|
-
* const price = await pricing.
|
|
15
|
+
* const price = await pricing.priceEngine.calculate({ customerId: 12345, itemId: 'ABC123', quantity: 10 });
|
|
16
16
|
*
|
|
17
17
|
* // Calculate tax
|
|
18
|
-
* const tax = await pricing.
|
|
18
|
+
* const tax = await pricing.taxEngine.calculate({
|
|
19
19
|
* customer_id: 12345,
|
|
20
20
|
* postal_code: '12345',
|
|
21
21
|
* items: [{ item_id: 'ABC123', quantity: 2, unit_price: 25.99, extended_amount: 51.98 }],
|
|
@@ -23,7 +23,7 @@ import { PriceEngineParamsSchema, PriceEngineResponseSchema, TaxEngineRequestSch
|
|
|
23
23
|
* });
|
|
24
24
|
*
|
|
25
25
|
* // List job price headers
|
|
26
|
-
* const jobHeaders = await pricing.
|
|
26
|
+
* const jobHeaders = await pricing.jobPriceHdr.list({ limit: 25, q: 'contract' });
|
|
27
27
|
* ```
|
|
28
28
|
*/
|
|
29
29
|
export class PricingClient extends BaseServiceClient {
|
|
@@ -34,11 +34,94 @@ export class PricingClient extends BaseServiceClient {
|
|
|
34
34
|
*/
|
|
35
35
|
constructor(http, baseUrl = 'https://pricing.augur-api.com') {
|
|
36
36
|
super('pricing', http, baseUrl);
|
|
37
|
+
/**
|
|
38
|
+
* Price engine operations
|
|
39
|
+
* @description Pricing calculations and price determination
|
|
40
|
+
*/
|
|
41
|
+
this.priceEngine = {
|
|
42
|
+
/**
|
|
43
|
+
* Calculate item price using the price engine
|
|
44
|
+
* @description Primary pricing endpoint for calculating item prices with sophisticated caching and compression
|
|
45
|
+
* @param params Pricing parameters including customer ID, item ID, quantity, and other options
|
|
46
|
+
* @returns Detailed pricing information including base price, unit price, discounts, and calculation details
|
|
47
|
+
* @throws ValidationError When parameters are invalid or response is malformed
|
|
48
|
+
* @example
|
|
49
|
+
* ```typescript
|
|
50
|
+
* const price = await client.priceEngine.calculate({
|
|
51
|
+
* customerId: 12345,
|
|
52
|
+
* itemId: 'ABC123',
|
|
53
|
+
* quantity: 10,
|
|
54
|
+
* unitOfMeasure: 'EA',
|
|
55
|
+
* shipToId: 456
|
|
56
|
+
* });
|
|
57
|
+
*
|
|
58
|
+
* console.log('Unit Price:', price.unit_price);
|
|
59
|
+
* console.log('Discount:', price.discount_percent);
|
|
60
|
+
* console.log('Price Source:', price.price_source);
|
|
61
|
+
* ```
|
|
62
|
+
*/
|
|
63
|
+
calculate: async (params) => {
|
|
64
|
+
return this.executeRequest({
|
|
65
|
+
method: 'GET',
|
|
66
|
+
path: '/price-engine',
|
|
67
|
+
paramsSchema: PriceEngineParamsSchema,
|
|
68
|
+
responseSchema: PriceEngineResponseSchema,
|
|
69
|
+
}, params);
|
|
70
|
+
},
|
|
71
|
+
};
|
|
72
|
+
/**
|
|
73
|
+
* Tax engine operations
|
|
74
|
+
* @description Tax calculations and jurisdiction-based tax determination
|
|
75
|
+
*/
|
|
76
|
+
this.taxEngine = {
|
|
77
|
+
/**
|
|
78
|
+
* Calculate tax using the tax engine
|
|
79
|
+
* @description Tax calculation endpoint with postal code-based rate lookups and jurisdiction breakdowns
|
|
80
|
+
* @param request Tax calculation request with customer, items, and shipping address information
|
|
81
|
+
* @returns Detailed tax calculation with total tax, rates, and jurisdiction-specific breakdowns
|
|
82
|
+
* @throws ValidationError When request is invalid or response is malformed
|
|
83
|
+
* @example
|
|
84
|
+
* ```typescript
|
|
85
|
+
* const tax = await client.taxEngine.calculate({
|
|
86
|
+
* customer_id: 12345,
|
|
87
|
+
* postal_code: '12345',
|
|
88
|
+
* items: [
|
|
89
|
+
* {
|
|
90
|
+
* item_id: 'ABC123',
|
|
91
|
+
* quantity: 2,
|
|
92
|
+
* unit_price: 25.99,
|
|
93
|
+
* extended_amount: 51.98
|
|
94
|
+
* }
|
|
95
|
+
* ],
|
|
96
|
+
* ship_to_address: {
|
|
97
|
+
* street: '123 Main St',
|
|
98
|
+
* city: 'Anytown',
|
|
99
|
+
* state: 'NY',
|
|
100
|
+
* postal_code: '12345'
|
|
101
|
+
* }
|
|
102
|
+
* });
|
|
103
|
+
*
|
|
104
|
+
* console.log('Total Tax:', tax.total_tax);
|
|
105
|
+
* console.log('Tax Rate:', tax.tax_rate);
|
|
106
|
+
* tax.jurisdictions.forEach(j => {
|
|
107
|
+
* console.log(`${j.jurisdiction_name}: ${j.tax_rate}% = $${j.tax_amount}`);
|
|
108
|
+
* });
|
|
109
|
+
* ```
|
|
110
|
+
*/
|
|
111
|
+
calculate: async (request) => {
|
|
112
|
+
return this.executeRequest({
|
|
113
|
+
method: 'POST',
|
|
114
|
+
path: '/tax-engine',
|
|
115
|
+
paramsSchema: TaxEngineRequestSchema,
|
|
116
|
+
responseSchema: TaxEngineResponseSchema,
|
|
117
|
+
}, request);
|
|
118
|
+
},
|
|
119
|
+
};
|
|
37
120
|
/**
|
|
38
121
|
* Job Price Header endpoints
|
|
39
122
|
* @description Methods for managing job-based pricing contracts and agreements
|
|
40
123
|
*/
|
|
41
|
-
this.
|
|
124
|
+
this.jobPriceHdr = {
|
|
42
125
|
/**
|
|
43
126
|
* List job price headers with filtering and pagination
|
|
44
127
|
* @description Retrieves job price headers with optional search, filtering, and pagination
|
|
@@ -179,76 +262,5 @@ export class PricingClient extends BaseServiceClient {
|
|
|
179
262
|
},
|
|
180
263
|
};
|
|
181
264
|
}
|
|
182
|
-
/**
|
|
183
|
-
* Calculate item price using the price engine
|
|
184
|
-
* @description Primary pricing endpoint for calculating item prices with sophisticated caching and compression
|
|
185
|
-
* @param params Pricing parameters including customer ID, item ID, quantity, and other options
|
|
186
|
-
* @returns Detailed pricing information including base price, unit price, discounts, and calculation details
|
|
187
|
-
* @throws ValidationError When parameters are invalid or response is malformed
|
|
188
|
-
* @example
|
|
189
|
-
* ```typescript
|
|
190
|
-
* const price = await client.getPrice({
|
|
191
|
-
* customerId: 12345,
|
|
192
|
-
* itemId: 'ABC123',
|
|
193
|
-
* quantity: 10,
|
|
194
|
-
* unitOfMeasure: 'EA',
|
|
195
|
-
* shipToId: 456
|
|
196
|
-
* });
|
|
197
|
-
*
|
|
198
|
-
* console.log('Unit Price:', price.unit_price);
|
|
199
|
-
* console.log('Discount:', price.discount_percent);
|
|
200
|
-
* console.log('Price Source:', price.price_source);
|
|
201
|
-
* ```
|
|
202
|
-
*/
|
|
203
|
-
async getPrice(params) {
|
|
204
|
-
return this.executeRequest({
|
|
205
|
-
method: 'GET',
|
|
206
|
-
path: '/price-engine',
|
|
207
|
-
paramsSchema: PriceEngineParamsSchema,
|
|
208
|
-
responseSchema: PriceEngineResponseSchema,
|
|
209
|
-
}, params);
|
|
210
|
-
}
|
|
211
|
-
/**
|
|
212
|
-
* Calculate tax using the tax engine
|
|
213
|
-
* @description Tax calculation endpoint with postal code-based rate lookups and jurisdiction breakdowns
|
|
214
|
-
* @param request Tax calculation request with customer, items, and shipping address information
|
|
215
|
-
* @returns Detailed tax calculation with total tax, rates, and jurisdiction-specific breakdowns
|
|
216
|
-
* @throws ValidationError When request is invalid or response is malformed
|
|
217
|
-
* @example
|
|
218
|
-
* ```typescript
|
|
219
|
-
* const tax = await client.calculateTax({
|
|
220
|
-
* customer_id: 12345,
|
|
221
|
-
* postal_code: '12345',
|
|
222
|
-
* items: [
|
|
223
|
-
* {
|
|
224
|
-
* item_id: 'ABC123',
|
|
225
|
-
* quantity: 2,
|
|
226
|
-
* unit_price: 25.99,
|
|
227
|
-
* extended_amount: 51.98
|
|
228
|
-
* }
|
|
229
|
-
* ],
|
|
230
|
-
* ship_to_address: {
|
|
231
|
-
* street: '123 Main St',
|
|
232
|
-
* city: 'Anytown',
|
|
233
|
-
* state: 'NY',
|
|
234
|
-
* postal_code: '12345'
|
|
235
|
-
* }
|
|
236
|
-
* });
|
|
237
|
-
*
|
|
238
|
-
* console.log('Total Tax:', tax.total_tax);
|
|
239
|
-
* console.log('Tax Rate:', tax.tax_rate);
|
|
240
|
-
* tax.jurisdictions.forEach(j => {
|
|
241
|
-
* console.log(`${j.jurisdiction_name}: ${j.tax_rate}% = $${j.tax_amount}`);
|
|
242
|
-
* });
|
|
243
|
-
* ```
|
|
244
|
-
*/
|
|
245
|
-
async calculateTax(request) {
|
|
246
|
-
return this.executeRequest({
|
|
247
|
-
method: 'POST',
|
|
248
|
-
path: '/tax-engine',
|
|
249
|
-
paramsSchema: TaxEngineRequestSchema,
|
|
250
|
-
responseSchema: TaxEngineResponseSchema,
|
|
251
|
-
}, request);
|
|
252
|
-
}
|
|
253
265
|
}
|
|
254
266
|
//# sourceMappingURL=client.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../../src/services/pricing/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAG3D,OAAO,EAEL,uBAAuB,EAEvB,yBAAyB,EAEzB,sBAAsB,EAEtB,uBAAuB,EACvB,2BAA2B,EAC3B,6BAA6B,EAC7B,4BAA4B,EAE5B,4BAA4B,EAE5B,8BAA8B,EAC9B,6BAA6B,EAC7B,yBAAyB,EACzB,kBAAkB,GACnB,MAAM,WAAW,CAAC;AAEnB;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,OAAO,aAAc,SAAQ,iBAAiB;IAClD;;;;OAIG;IACH,YAAY,IAAgB,EAAE,UAAkB,+BAA+B;QAC7E,KAAK,CAAC,SAAS,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;
|
|
1
|
+
{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../../src/services/pricing/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAG3D,OAAO,EAEL,uBAAuB,EAEvB,yBAAyB,EAEzB,sBAAsB,EAEtB,uBAAuB,EACvB,2BAA2B,EAC3B,6BAA6B,EAC7B,4BAA4B,EAE5B,4BAA4B,EAE5B,8BAA8B,EAC9B,6BAA6B,EAC7B,yBAAyB,EACzB,kBAAkB,GACnB,MAAM,WAAW,CAAC;AAEnB;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,OAAO,aAAc,SAAQ,iBAAiB;IAClD;;;;OAIG;IACH,YAAY,IAAgB,EAAE,UAAkB,+BAA+B;QAC7E,KAAK,CAAC,SAAS,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QAGlC;;;WAGG;QACH,gBAAW,GAAG;YACZ;;;;;;;;;;;;;;;;;;;;eAoBG;YACH,SAAS,EAAE,KAAK,EAAE,MAAyB,EAA0C,EAAE;gBACrF,OAAO,IAAI,CAAC,cAAc,CACxB;oBACE,MAAM,EAAE,KAAK;oBACb,IAAI,EAAE,eAAe;oBACrB,YAAY,EAAE,uBAAuB;oBACrC,cAAc,EAAE,yBAAyB;iBAC1C,EACD,MAAM,CACP,CAAC;YACJ,CAAC;SACF,CAAC;QAEF;;;WAGG;QACH,cAAS,GAAG;YACV;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;eAiCG;YACH,SAAS,EAAE,KAAK,EAAE,OAAyB,EAAwC,EAAE;gBACnF,OAAO,IAAI,CAAC,cAAc,CACxB;oBACE,MAAM,EAAE,MAAM;oBACd,IAAI,EAAE,aAAa;oBACnB,YAAY,EAAE,sBAAsB;oBACpC,cAAc,EAAE,uBAAuB;iBACxC,EACD,OAAO,CACR,CAAC;YACJ,CAAC;SACF,CAAC;QAEF;;;WAGG;QACH,gBAAW,GAAG;YACZ;;;;;;;;;;;;;;;;;;;;;;;eAuBG;YACH,IAAI,EAAE,IAAI,CAAC,gBAAgB,CACzB,gBAAgB,EAChB,2BAA2B,EAC3B,6BAA6B,CAC9B;YAED;;;;;;;;;;;;;;eAcG;YACH,GAAG,EAAE,IAAI,CAAC,eAAe,CAAC,qBAAqB,EAAE,4BAA4B,CAAC;SAC/E,CAAC;QAEF;;;WAGG;QACH,kBAAa,GAAG;YACd;;;;;;;;;;;;;;;;;;;;;;;;eAwBG;YACH,IAAI,EAAE,KAAK,EACT,cAAsB,EACtB,MAA+B,EACQ,EAAE;gBACzC,OAAO,IAAI,CAAC,cAAc,CACxB;oBACE,MAAM,EAAE,KAAK;oBACb,IAAI,EAAE,2BAA2B;oBACjC,YAAY,EAAE,4BAA4B;oBAC1C,cAAc,EAAE,8BAA8B;iBAC/C,EACD,MAAM,EACN,EAAE,EAAE,EAAE,MAAM,CAAC,cAAc,CAAC,EAAE,CAC/B,CAAC;YACJ,CAAC;YAED;;;;;;;;;;;;;;;eAeG;YACH,GAAG,EAAE,KAAK,EACR,cAAsB,EACtB,eAAuB,EACc,EAAE;gBACvC,OAAO,IAAI,CAAC,cAAc,CACxB;oBACE,MAAM,EAAE,KAAK;oBACb,IAAI,EAAE,uCAAuC;oBAC7C,cAAc,EAAE,6BAA6B;iBAC9C,EACD,SAAS,EACT,EAAE,KAAK,EAAE,MAAM,CAAC,cAAc,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,eAAe,CAAC,EAAE,CACnE,CAAC;YACJ,CAAC;SACF,CAAC;QAEF;;;;;;;;;;WAUG;QACH,SAAI,GAAG,IAAI,CAAC,gBAAgB,CAAC,kBAAkB,CAAC,CAAC;QAEjD,mBAAc,GAAG,IAAI,CAAC,uBAAuB,CAAC,yBAAyB,CAAC,CAAC;QAEzE;;;WAGG;QACH,eAAU,GAAG;YACX;;;eAGG;YACH,KAAK,EAAE,KAAK,IAAI,EAAE;gBAChB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;gBAC7C,OAAO,QAAQ,CAAC,IAAI,CAAC;YACvB,CAAC;YAED;;;eAGG;YACH,IAAI,EAAE,KAAK,IAAI,EAAE;gBACf,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;gBACnC,OAAO,QAAQ,CAAC,IAAI,CAAC;YACvB,CAAC;SACF,CAAC;IArQF,CAAC;CAsQF"}
|
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
import { BaseServiceClient } from '../../core/base-client';
|
|
2
|
+
import type { HTTPClient } from '../../core/client';
|
|
3
|
+
import { HealthCheckParams, HealthCheckResponse, RatesRequestParams, RatesResponse, RatesData } from './schemas';
|
|
4
|
+
/**
|
|
5
|
+
* Shipping Service Client
|
|
6
|
+
*
|
|
7
|
+
* Provides access to comprehensive shipping rate calculation, carrier comparison,
|
|
8
|
+
* and shipping cost optimization across multiple carriers and service types.
|
|
9
|
+
* Supports domestic and international shipping with detailed rate analysis.
|
|
10
|
+
*
|
|
11
|
+
* @service shipping
|
|
12
|
+
* @domain shipping-and-logistics
|
|
13
|
+
*/
|
|
14
|
+
export declare class ShippingClient extends BaseServiceClient {
|
|
15
|
+
constructor(http: HTTPClient, baseUrl?: string);
|
|
16
|
+
protected getServiceDescription(): string;
|
|
17
|
+
/**
|
|
18
|
+
* Check shipping service health and availability
|
|
19
|
+
*
|
|
20
|
+
* @fullPath api.shipping.healthCheck.get
|
|
21
|
+
* @service shipping
|
|
22
|
+
* @domain system-health
|
|
23
|
+
* @dataMethod healthCheckData
|
|
24
|
+
* @discoverable true
|
|
25
|
+
* @searchTerms ["health", "status", "availability", "ping", "check", "shipping service", "carriers", "rates"]
|
|
26
|
+
* @relatedEndpoints ["api.shipping.rates.calculate", "api.logistics.healthCheck.get", "api.commerce.healthCheck.get", "api.orders.healthCheck.get"]
|
|
27
|
+
* @commonPatterns ["Health check", "Service status", "Shipping service availability", "System monitoring", "Carrier connectivity"]
|
|
28
|
+
* @workflow ["system-monitoring", "health-checks", "service-discovery", "shipping-service-verification", "carrier-status-check"]
|
|
29
|
+
* @prerequisites ["Service is running", "Valid authentication token", "x-site-id header", "Carrier API connections"]
|
|
30
|
+
* @nextSteps ["Use shipping rate endpoints if healthy", "Verify carrier API connectivity", "Monitor shipping service metrics"]
|
|
31
|
+
* @businessRules ["Returns service and carrier status", "Requires standard authentication", "Standard health check format"]
|
|
32
|
+
* @functionalArea "system-monitoring"
|
|
33
|
+
* @caching "No caching - real-time status required"
|
|
34
|
+
* @performance "Fast response, minimal processing, use for shipping service monitoring"
|
|
35
|
+
*
|
|
36
|
+
* @param params Health check parameters with site ID
|
|
37
|
+
* @returns Promise<HealthCheckResponse> Service health status with carrier availability
|
|
38
|
+
*
|
|
39
|
+
* @example
|
|
40
|
+
* ```typescript
|
|
41
|
+
* // Check if shipping service is healthy
|
|
42
|
+
* const response = await client.healthCheck({ 'x-site-id': 'SITE123' });
|
|
43
|
+
* console.log(response.data.status); // 'healthy'
|
|
44
|
+
* console.log(response.data.service); // 'shipping'
|
|
45
|
+
* console.log(response.status); // HTTP status code
|
|
46
|
+
*
|
|
47
|
+
* // Get just the health status
|
|
48
|
+
* const status = await client.healthCheckData({ 'x-site-id': 'SITE123' });
|
|
49
|
+
* console.log(status); // Health data object
|
|
50
|
+
* ```
|
|
51
|
+
*/
|
|
52
|
+
healthCheck(params: HealthCheckParams): Promise<HealthCheckResponse>;
|
|
53
|
+
/**
|
|
54
|
+
* Get comprehensive shipping rates from multiple carriers
|
|
55
|
+
*
|
|
56
|
+
* @fullPath api.shipping.rates.calculate
|
|
57
|
+
* @service shipping
|
|
58
|
+
* @domain shipping-and-logistics
|
|
59
|
+
* @dataMethod ratesData
|
|
60
|
+
* @discoverable true
|
|
61
|
+
* @searchTerms ["shipping rates", "calculate cost", "carrier comparison", "freight quotes", "delivery cost", "ups", "fedex", "usps", "dhl", "shipping options"]
|
|
62
|
+
* @relatedEndpoints ["api.logistics.speedship.freight.get", "api.commerce.cart.shipping.calculate", "api.orders.shipping.estimate", "api.customers.addresses.validate"]
|
|
63
|
+
* @commonPatterns ["Calculate shipping cost", "Compare carrier rates", "Get delivery options", "Estimate shipping", "Find cheapest option", "Get fastest delivery"]
|
|
64
|
+
* @workflow ["e-commerce-checkout", "order-fulfillment", "shipping-estimation", "cost-analysis", "carrier-selection", "delivery-planning"]
|
|
65
|
+
* @prerequisites ["Valid shipping addresses", "Package dimensions and weight", "Valid authentication token", "x-site-id header", "Carrier API access"]
|
|
66
|
+
* @nextSteps ["Select shipping option", "Create shipping label", "Track shipment", "Update order with shipping cost", "Process payment with shipping"]
|
|
67
|
+
* @businessRules ["Requires complete address information", "Package weight/dimensions mandatory", "Supports multiple packages", "Returns carrier-specific rates", "Includes all fees and surcharges"]
|
|
68
|
+
* @functionalArea "shipping-and-logistics"
|
|
69
|
+
* @crossSite "Supports multi-site shipping configurations and carrier accounts"
|
|
70
|
+
* @caching "Cache rates for 15 minutes, invalidate on address or package changes"
|
|
71
|
+
* @performance "Parallel carrier API calls, use response format to optimize data size, supports pagination for large results"
|
|
72
|
+
*
|
|
73
|
+
* @param params Comprehensive shipping rate request with origin, destination, and package details
|
|
74
|
+
* @returns Promise<RatesResponse> Complete shipping rates from multiple carriers with detailed analysis
|
|
75
|
+
*
|
|
76
|
+
* @example
|
|
77
|
+
* ```typescript
|
|
78
|
+
* // Calculate shipping rates for e-commerce order
|
|
79
|
+
* const rateRequest = {
|
|
80
|
+
* // Origin address (warehouse/fulfillment center)
|
|
81
|
+
* fromAddressLine: '123 Warehouse Blvd',
|
|
82
|
+
* fromCity: 'Los Angeles',
|
|
83
|
+
* fromState: 'CA',
|
|
84
|
+
* fromPostalCode: '90210',
|
|
85
|
+
* fromCountryCode: 'US',
|
|
86
|
+
* fromCompanyName: 'E-Commerce Fulfillment',
|
|
87
|
+
*
|
|
88
|
+
* // Customer delivery address
|
|
89
|
+
* toAddressLine: '456 Customer St',
|
|
90
|
+
* toCity: 'New York',
|
|
91
|
+
* toState: 'NY',
|
|
92
|
+
* toPostalCode: '10001',
|
|
93
|
+
* toCountryCode: 'US',
|
|
94
|
+
* toCompanyName: 'Customer Corp',
|
|
95
|
+
*
|
|
96
|
+
* // Package information
|
|
97
|
+
* packages: [{
|
|
98
|
+
* length: 12,
|
|
99
|
+
* width: 8,
|
|
100
|
+
* height: 6,
|
|
101
|
+
* weight: 2.5,
|
|
102
|
+
* dimensionUnit: 'in',
|
|
103
|
+
* weightUnit: 'lb',
|
|
104
|
+
* value: 150.00,
|
|
105
|
+
* description: 'Electronics order'
|
|
106
|
+
* }],
|
|
107
|
+
*
|
|
108
|
+
* // Shipping preferences
|
|
109
|
+
* serviceType: 'ground',
|
|
110
|
+
* carriers: ['ups', 'fedex', 'usps'],
|
|
111
|
+
* responseFormat: 'detailed',
|
|
112
|
+
* 'x-site-id': 'SITE123'
|
|
113
|
+
* };
|
|
114
|
+
*
|
|
115
|
+
* const response = await client.rates(rateRequest);
|
|
116
|
+
* console.log(response.data.rates); // Array of shipping rates
|
|
117
|
+
* console.log(response.data.comparison.cheapest); // Cheapest option
|
|
118
|
+
* console.log(response.data.comparison.fastest); // Fastest option
|
|
119
|
+
*
|
|
120
|
+
* // Get just the rates data
|
|
121
|
+
* const rates = await client.ratesData(rateRequest);
|
|
122
|
+
* console.log(rates); // Direct rates data access
|
|
123
|
+
*
|
|
124
|
+
* // Find cheapest ground shipping
|
|
125
|
+
* const cheapestGround = await client.rates({
|
|
126
|
+
* ...rateRequest,
|
|
127
|
+
* serviceType: 'ground',
|
|
128
|
+
* responseFormat: 'cheapest'
|
|
129
|
+
* });
|
|
130
|
+
*
|
|
131
|
+
* // Compare overnight options
|
|
132
|
+
* const overnightOptions = await client.rates({
|
|
133
|
+
* ...rateRequest,
|
|
134
|
+
* serviceType: 'overnight',
|
|
135
|
+
* responseFormat: 'all'
|
|
136
|
+
* });
|
|
137
|
+
*
|
|
138
|
+
* // International shipping with insurance
|
|
139
|
+
* const internationalRates = await client.rates({
|
|
140
|
+
* ...rateRequest,
|
|
141
|
+
* toCountryCode: 'CA', // Canada
|
|
142
|
+
* serviceType: 'international',
|
|
143
|
+
* insuranceValue: 500.00,
|
|
144
|
+
* signatureRequired: true
|
|
145
|
+
* });
|
|
146
|
+
* ```
|
|
147
|
+
*/
|
|
148
|
+
rates(params: RatesRequestParams): Promise<RatesResponse>;
|
|
149
|
+
/**
|
|
150
|
+
* Get shipping service health data without full response metadata
|
|
151
|
+
*
|
|
152
|
+
* @fullPath api.shipping.healthCheckData.get
|
|
153
|
+
* @service shipping
|
|
154
|
+
* @domain system-health
|
|
155
|
+
* @dataMethod healthCheckData
|
|
156
|
+
* @discoverable true
|
|
157
|
+
* @searchTerms ["health data", "service status", "shipping availability", "carrier status"]
|
|
158
|
+
* @relatedEndpoints ["api.shipping.healthCheck.get", "api.shipping.rates.calculate"]
|
|
159
|
+
* @commonPatterns ["Get health status", "Check carrier availability", "Service monitoring"]
|
|
160
|
+
* @workflow ["system-monitoring", "health-checks", "service-verification"]
|
|
161
|
+
* @prerequisites ["Valid authentication token", "x-site-id header"]
|
|
162
|
+
* @nextSteps ["Use shipping endpoints if healthy", "Monitor service metrics"]
|
|
163
|
+
* @businessRules ["Returns only health data object", "No response metadata included"]
|
|
164
|
+
* @functionalArea "system-monitoring"
|
|
165
|
+
* @caching "No caching - real-time status required"
|
|
166
|
+
* @performance "Direct data access, faster for simple health checks"
|
|
167
|
+
*
|
|
168
|
+
* @param params Health check parameters with site ID
|
|
169
|
+
* @returns Promise<HealthCheckData> Direct health status data object
|
|
170
|
+
*/
|
|
171
|
+
healthCheckData(params: HealthCheckParams): Promise<{
|
|
172
|
+
status: string;
|
|
173
|
+
service: string;
|
|
174
|
+
timestamp?: string | undefined;
|
|
175
|
+
version?: string | undefined;
|
|
176
|
+
}>;
|
|
177
|
+
/**
|
|
178
|
+
* Get shipping rates data without full response metadata
|
|
179
|
+
*
|
|
180
|
+
* @fullPath api.shipping.ratesData.calculate
|
|
181
|
+
* @service shipping
|
|
182
|
+
* @domain shipping-and-logistics
|
|
183
|
+
* @dataMethod ratesData
|
|
184
|
+
* @discoverable true
|
|
185
|
+
* @searchTerms ["rates data", "shipping cost", "carrier quotes", "delivery prices", "freight data"]
|
|
186
|
+
* @relatedEndpoints ["api.shipping.rates.calculate", "api.logistics.speedship.freight.get"]
|
|
187
|
+
* @commonPatterns ["Get rates data", "Calculate shipping cost", "Compare carrier options"]
|
|
188
|
+
* @workflow ["e-commerce-checkout", "order-fulfillment", "shipping-estimation"]
|
|
189
|
+
* @prerequisites ["Valid shipping addresses", "Package details", "Valid authentication token"]
|
|
190
|
+
* @nextSteps ["Select shipping option", "Create shipping label", "Process payment"]
|
|
191
|
+
* @businessRules ["Returns only rates data", "No response metadata included", "Direct access to rate comparison"]
|
|
192
|
+
* @functionalArea "shipping-and-logistics"
|
|
193
|
+
* @caching "Cache rates for 15 minutes"
|
|
194
|
+
* @performance "Direct data access, optimal for rate comparisons and integrations"
|
|
195
|
+
*
|
|
196
|
+
* @param params Comprehensive shipping rate request parameters
|
|
197
|
+
* @returns Promise<RatesData> Direct shipping rates data without response wrapper
|
|
198
|
+
*/
|
|
199
|
+
ratesData(params: RatesRequestParams): Promise<RatesData>;
|
|
200
|
+
}
|
|
201
|
+
//# sourceMappingURL=client.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../../src/services/shipping/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAEL,iBAAiB,EAEjB,mBAAmB,EAEnB,kBAAkB,EAElB,aAAa,EACb,SAAS,EACV,MAAM,WAAW,CAAC;AAEnB;;;;;;;;;GASG;AACH,qBAAa,cAAe,SAAQ,iBAAiB;gBACvC,IAAI,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,MAAM;IAI9C,SAAS,CAAC,qBAAqB,IAAI,MAAM;IAIzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACG,WAAW,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAY1E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8FG;IACG,KAAK,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,aAAa,CAAC;IAc/D;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,eAAe,CAAC,MAAM,EAAE,iBAAiB;;;;;;IAK/C;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,SAAS,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,SAAS,CAAC;CAIhE"}
|
|
@@ -0,0 +1,220 @@
|
|
|
1
|
+
import { BaseServiceClient } from '../../core/base-client';
|
|
2
|
+
import { HealthCheckParamsSchema, HealthCheckResponseSchema, RatesRequestParamsSchema, RatesResponseSchema, } from './schemas';
|
|
3
|
+
/**
|
|
4
|
+
* Shipping Service Client
|
|
5
|
+
*
|
|
6
|
+
* Provides access to comprehensive shipping rate calculation, carrier comparison,
|
|
7
|
+
* and shipping cost optimization across multiple carriers and service types.
|
|
8
|
+
* Supports domestic and international shipping with detailed rate analysis.
|
|
9
|
+
*
|
|
10
|
+
* @service shipping
|
|
11
|
+
* @domain shipping-and-logistics
|
|
12
|
+
*/
|
|
13
|
+
export class ShippingClient extends BaseServiceClient {
|
|
14
|
+
constructor(http, baseUrl) {
|
|
15
|
+
super('shipping', http, baseUrl || 'https://shipping.augur-api.com');
|
|
16
|
+
}
|
|
17
|
+
getServiceDescription() {
|
|
18
|
+
return 'Comprehensive shipping rate calculation and carrier comparison service';
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* Check shipping service health and availability
|
|
22
|
+
*
|
|
23
|
+
* @fullPath api.shipping.healthCheck.get
|
|
24
|
+
* @service shipping
|
|
25
|
+
* @domain system-health
|
|
26
|
+
* @dataMethod healthCheckData
|
|
27
|
+
* @discoverable true
|
|
28
|
+
* @searchTerms ["health", "status", "availability", "ping", "check", "shipping service", "carriers", "rates"]
|
|
29
|
+
* @relatedEndpoints ["api.shipping.rates.calculate", "api.logistics.healthCheck.get", "api.commerce.healthCheck.get", "api.orders.healthCheck.get"]
|
|
30
|
+
* @commonPatterns ["Health check", "Service status", "Shipping service availability", "System monitoring", "Carrier connectivity"]
|
|
31
|
+
* @workflow ["system-monitoring", "health-checks", "service-discovery", "shipping-service-verification", "carrier-status-check"]
|
|
32
|
+
* @prerequisites ["Service is running", "Valid authentication token", "x-site-id header", "Carrier API connections"]
|
|
33
|
+
* @nextSteps ["Use shipping rate endpoints if healthy", "Verify carrier API connectivity", "Monitor shipping service metrics"]
|
|
34
|
+
* @businessRules ["Returns service and carrier status", "Requires standard authentication", "Standard health check format"]
|
|
35
|
+
* @functionalArea "system-monitoring"
|
|
36
|
+
* @caching "No caching - real-time status required"
|
|
37
|
+
* @performance "Fast response, minimal processing, use for shipping service monitoring"
|
|
38
|
+
*
|
|
39
|
+
* @param params Health check parameters with site ID
|
|
40
|
+
* @returns Promise<HealthCheckResponse> Service health status with carrier availability
|
|
41
|
+
*
|
|
42
|
+
* @example
|
|
43
|
+
* ```typescript
|
|
44
|
+
* // Check if shipping service is healthy
|
|
45
|
+
* const response = await client.healthCheck({ 'x-site-id': 'SITE123' });
|
|
46
|
+
* console.log(response.data.status); // 'healthy'
|
|
47
|
+
* console.log(response.data.service); // 'shipping'
|
|
48
|
+
* console.log(response.status); // HTTP status code
|
|
49
|
+
*
|
|
50
|
+
* // Get just the health status
|
|
51
|
+
* const status = await client.healthCheckData({ 'x-site-id': 'SITE123' });
|
|
52
|
+
* console.log(status); // Health data object
|
|
53
|
+
* ```
|
|
54
|
+
*/
|
|
55
|
+
async healthCheck(params) {
|
|
56
|
+
return this.executeRequest({
|
|
57
|
+
method: 'GET',
|
|
58
|
+
path: '/health-check',
|
|
59
|
+
paramsSchema: HealthCheckParamsSchema,
|
|
60
|
+
responseSchema: HealthCheckResponseSchema,
|
|
61
|
+
}, params);
|
|
62
|
+
}
|
|
63
|
+
/**
|
|
64
|
+
* Get comprehensive shipping rates from multiple carriers
|
|
65
|
+
*
|
|
66
|
+
* @fullPath api.shipping.rates.calculate
|
|
67
|
+
* @service shipping
|
|
68
|
+
* @domain shipping-and-logistics
|
|
69
|
+
* @dataMethod ratesData
|
|
70
|
+
* @discoverable true
|
|
71
|
+
* @searchTerms ["shipping rates", "calculate cost", "carrier comparison", "freight quotes", "delivery cost", "ups", "fedex", "usps", "dhl", "shipping options"]
|
|
72
|
+
* @relatedEndpoints ["api.logistics.speedship.freight.get", "api.commerce.cart.shipping.calculate", "api.orders.shipping.estimate", "api.customers.addresses.validate"]
|
|
73
|
+
* @commonPatterns ["Calculate shipping cost", "Compare carrier rates", "Get delivery options", "Estimate shipping", "Find cheapest option", "Get fastest delivery"]
|
|
74
|
+
* @workflow ["e-commerce-checkout", "order-fulfillment", "shipping-estimation", "cost-analysis", "carrier-selection", "delivery-planning"]
|
|
75
|
+
* @prerequisites ["Valid shipping addresses", "Package dimensions and weight", "Valid authentication token", "x-site-id header", "Carrier API access"]
|
|
76
|
+
* @nextSteps ["Select shipping option", "Create shipping label", "Track shipment", "Update order with shipping cost", "Process payment with shipping"]
|
|
77
|
+
* @businessRules ["Requires complete address information", "Package weight/dimensions mandatory", "Supports multiple packages", "Returns carrier-specific rates", "Includes all fees and surcharges"]
|
|
78
|
+
* @functionalArea "shipping-and-logistics"
|
|
79
|
+
* @crossSite "Supports multi-site shipping configurations and carrier accounts"
|
|
80
|
+
* @caching "Cache rates for 15 minutes, invalidate on address or package changes"
|
|
81
|
+
* @performance "Parallel carrier API calls, use response format to optimize data size, supports pagination for large results"
|
|
82
|
+
*
|
|
83
|
+
* @param params Comprehensive shipping rate request with origin, destination, and package details
|
|
84
|
+
* @returns Promise<RatesResponse> Complete shipping rates from multiple carriers with detailed analysis
|
|
85
|
+
*
|
|
86
|
+
* @example
|
|
87
|
+
* ```typescript
|
|
88
|
+
* // Calculate shipping rates for e-commerce order
|
|
89
|
+
* const rateRequest = {
|
|
90
|
+
* // Origin address (warehouse/fulfillment center)
|
|
91
|
+
* fromAddressLine: '123 Warehouse Blvd',
|
|
92
|
+
* fromCity: 'Los Angeles',
|
|
93
|
+
* fromState: 'CA',
|
|
94
|
+
* fromPostalCode: '90210',
|
|
95
|
+
* fromCountryCode: 'US',
|
|
96
|
+
* fromCompanyName: 'E-Commerce Fulfillment',
|
|
97
|
+
*
|
|
98
|
+
* // Customer delivery address
|
|
99
|
+
* toAddressLine: '456 Customer St',
|
|
100
|
+
* toCity: 'New York',
|
|
101
|
+
* toState: 'NY',
|
|
102
|
+
* toPostalCode: '10001',
|
|
103
|
+
* toCountryCode: 'US',
|
|
104
|
+
* toCompanyName: 'Customer Corp',
|
|
105
|
+
*
|
|
106
|
+
* // Package information
|
|
107
|
+
* packages: [{
|
|
108
|
+
* length: 12,
|
|
109
|
+
* width: 8,
|
|
110
|
+
* height: 6,
|
|
111
|
+
* weight: 2.5,
|
|
112
|
+
* dimensionUnit: 'in',
|
|
113
|
+
* weightUnit: 'lb',
|
|
114
|
+
* value: 150.00,
|
|
115
|
+
* description: 'Electronics order'
|
|
116
|
+
* }],
|
|
117
|
+
*
|
|
118
|
+
* // Shipping preferences
|
|
119
|
+
* serviceType: 'ground',
|
|
120
|
+
* carriers: ['ups', 'fedex', 'usps'],
|
|
121
|
+
* responseFormat: 'detailed',
|
|
122
|
+
* 'x-site-id': 'SITE123'
|
|
123
|
+
* };
|
|
124
|
+
*
|
|
125
|
+
* const response = await client.rates(rateRequest);
|
|
126
|
+
* console.log(response.data.rates); // Array of shipping rates
|
|
127
|
+
* console.log(response.data.comparison.cheapest); // Cheapest option
|
|
128
|
+
* console.log(response.data.comparison.fastest); // Fastest option
|
|
129
|
+
*
|
|
130
|
+
* // Get just the rates data
|
|
131
|
+
* const rates = await client.ratesData(rateRequest);
|
|
132
|
+
* console.log(rates); // Direct rates data access
|
|
133
|
+
*
|
|
134
|
+
* // Find cheapest ground shipping
|
|
135
|
+
* const cheapestGround = await client.rates({
|
|
136
|
+
* ...rateRequest,
|
|
137
|
+
* serviceType: 'ground',
|
|
138
|
+
* responseFormat: 'cheapest'
|
|
139
|
+
* });
|
|
140
|
+
*
|
|
141
|
+
* // Compare overnight options
|
|
142
|
+
* const overnightOptions = await client.rates({
|
|
143
|
+
* ...rateRequest,
|
|
144
|
+
* serviceType: 'overnight',
|
|
145
|
+
* responseFormat: 'all'
|
|
146
|
+
* });
|
|
147
|
+
*
|
|
148
|
+
* // International shipping with insurance
|
|
149
|
+
* const internationalRates = await client.rates({
|
|
150
|
+
* ...rateRequest,
|
|
151
|
+
* toCountryCode: 'CA', // Canada
|
|
152
|
+
* serviceType: 'international',
|
|
153
|
+
* insuranceValue: 500.00,
|
|
154
|
+
* signatureRequired: true
|
|
155
|
+
* });
|
|
156
|
+
* ```
|
|
157
|
+
*/
|
|
158
|
+
async rates(params) {
|
|
159
|
+
return this.executeRequest({
|
|
160
|
+
method: 'POST',
|
|
161
|
+
path: '/rates',
|
|
162
|
+
paramsSchema: RatesRequestParamsSchema,
|
|
163
|
+
responseSchema: RatesResponseSchema,
|
|
164
|
+
}, params);
|
|
165
|
+
}
|
|
166
|
+
// Data methods - return data portion only for convenience
|
|
167
|
+
/**
|
|
168
|
+
* Get shipping service health data without full response metadata
|
|
169
|
+
*
|
|
170
|
+
* @fullPath api.shipping.healthCheckData.get
|
|
171
|
+
* @service shipping
|
|
172
|
+
* @domain system-health
|
|
173
|
+
* @dataMethod healthCheckData
|
|
174
|
+
* @discoverable true
|
|
175
|
+
* @searchTerms ["health data", "service status", "shipping availability", "carrier status"]
|
|
176
|
+
* @relatedEndpoints ["api.shipping.healthCheck.get", "api.shipping.rates.calculate"]
|
|
177
|
+
* @commonPatterns ["Get health status", "Check carrier availability", "Service monitoring"]
|
|
178
|
+
* @workflow ["system-monitoring", "health-checks", "service-verification"]
|
|
179
|
+
* @prerequisites ["Valid authentication token", "x-site-id header"]
|
|
180
|
+
* @nextSteps ["Use shipping endpoints if healthy", "Monitor service metrics"]
|
|
181
|
+
* @businessRules ["Returns only health data object", "No response metadata included"]
|
|
182
|
+
* @functionalArea "system-monitoring"
|
|
183
|
+
* @caching "No caching - real-time status required"
|
|
184
|
+
* @performance "Direct data access, faster for simple health checks"
|
|
185
|
+
*
|
|
186
|
+
* @param params Health check parameters with site ID
|
|
187
|
+
* @returns Promise<HealthCheckData> Direct health status data object
|
|
188
|
+
*/
|
|
189
|
+
async healthCheckData(params) {
|
|
190
|
+
const response = await this.healthCheck(params);
|
|
191
|
+
return response.data;
|
|
192
|
+
}
|
|
193
|
+
/**
|
|
194
|
+
* Get shipping rates data without full response metadata
|
|
195
|
+
*
|
|
196
|
+
* @fullPath api.shipping.ratesData.calculate
|
|
197
|
+
* @service shipping
|
|
198
|
+
* @domain shipping-and-logistics
|
|
199
|
+
* @dataMethod ratesData
|
|
200
|
+
* @discoverable true
|
|
201
|
+
* @searchTerms ["rates data", "shipping cost", "carrier quotes", "delivery prices", "freight data"]
|
|
202
|
+
* @relatedEndpoints ["api.shipping.rates.calculate", "api.logistics.speedship.freight.get"]
|
|
203
|
+
* @commonPatterns ["Get rates data", "Calculate shipping cost", "Compare carrier options"]
|
|
204
|
+
* @workflow ["e-commerce-checkout", "order-fulfillment", "shipping-estimation"]
|
|
205
|
+
* @prerequisites ["Valid shipping addresses", "Package details", "Valid authentication token"]
|
|
206
|
+
* @nextSteps ["Select shipping option", "Create shipping label", "Process payment"]
|
|
207
|
+
* @businessRules ["Returns only rates data", "No response metadata included", "Direct access to rate comparison"]
|
|
208
|
+
* @functionalArea "shipping-and-logistics"
|
|
209
|
+
* @caching "Cache rates for 15 minutes"
|
|
210
|
+
* @performance "Direct data access, optimal for rate comparisons and integrations"
|
|
211
|
+
*
|
|
212
|
+
* @param params Comprehensive shipping rate request parameters
|
|
213
|
+
* @returns Promise<RatesData> Direct shipping rates data without response wrapper
|
|
214
|
+
*/
|
|
215
|
+
async ratesData(params) {
|
|
216
|
+
const response = await this.rates(params);
|
|
217
|
+
return response.data;
|
|
218
|
+
}
|
|
219
|
+
}
|
|
220
|
+
//# sourceMappingURL=client.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../../src/services/shipping/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAE3D,OAAO,EACL,uBAAuB,EAEvB,yBAAyB,EAEzB,wBAAwB,EAExB,mBAAmB,GAGpB,MAAM,WAAW,CAAC;AAEnB;;;;;;;;;GASG;AACH,MAAM,OAAO,cAAe,SAAQ,iBAAiB;IACnD,YAAY,IAAgB,EAAE,OAAgB;QAC5C,KAAK,CAAC,UAAU,EAAE,IAAI,EAAE,OAAO,IAAI,gCAAgC,CAAC,CAAC;IACvE,CAAC;IAES,qBAAqB;QAC7B,OAAO,wEAAwE,CAAC;IAClF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,KAAK,CAAC,WAAW,CAAC,MAAyB;QACzC,OAAO,IAAI,CAAC,cAAc,CACxB;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,eAAe;YACrB,YAAY,EAAE,uBAAuB;YACrC,cAAc,EAAE,yBAAyB;SAC1C,EACD,MAAM,CACP,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8FG;IACH,KAAK,CAAC,KAAK,CAAC,MAA0B;QACpC,OAAO,IAAI,CAAC,cAAc,CACxB;YACE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,QAAQ;YACd,YAAY,EAAE,wBAAwB;YACtC,cAAc,EAAE,mBAAmB;SACpC,EACD,MAAM,CACP,CAAC;IACJ,CAAC;IAED,0DAA0D;IAE1D;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,KAAK,CAAC,eAAe,CAAC,MAAyB;QAC7C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QAChD,OAAO,QAAQ,CAAC,IAAI,CAAC;IACvB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,KAAK,CAAC,SAAS,CAAC,MAA0B;QACxC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC1C,OAAO,QAAQ,CAAC,IAAI,CAAC;IACvB,CAAC;CACF"}
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
export { ShippingClient } from './client';
|
|
2
|
+
export type { HealthCheckParams, RatesRequestParams, HealthCheckData, ShippingRate, ShippingRatesSummary, ShippingRatesDetailed, ShippingRatesResult, RatesData, HealthCheckResponse, RatesResponse, } from './schemas';
|
|
3
|
+
export { HealthCheckParamsSchema, RatesRequestParamsSchema, HealthCheckDataSchema, ShippingRateSchema, ShippingRatesSummarySchema, ShippingRatesDetailedSchema, ShippingRatesResultSchema, RatesDataSchema, HealthCheckResponseSchema, RatesResponseSchema, } from './schemas';
|
|
4
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/shipping/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAC1C,YAAY,EACV,iBAAiB,EACjB,kBAAkB,EAClB,eAAe,EACf,YAAY,EACZ,oBAAoB,EACpB,qBAAqB,EACrB,mBAAmB,EACnB,SAAS,EACT,mBAAmB,EACnB,aAAa,GACd,MAAM,WAAW,CAAC;AACnB,OAAO,EACL,uBAAuB,EACvB,wBAAwB,EACxB,qBAAqB,EACrB,kBAAkB,EAClB,0BAA0B,EAC1B,2BAA2B,EAC3B,yBAAyB,EACzB,eAAe,EACf,yBAAyB,EACzB,mBAAmB,GACpB,MAAM,WAAW,CAAC"}
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
// Shipping Service Exports
|
|
2
|
+
export { ShippingClient } from './client';
|
|
3
|
+
export { HealthCheckParamsSchema, RatesRequestParamsSchema, HealthCheckDataSchema, ShippingRateSchema, ShippingRatesSummarySchema, ShippingRatesDetailedSchema, ShippingRatesResultSchema, RatesDataSchema, HealthCheckResponseSchema, RatesResponseSchema, } from './schemas';
|
|
4
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/services/shipping/index.ts"],"names":[],"mappings":"AAAA,2BAA2B;AAC3B,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAa1C,OAAO,EACL,uBAAuB,EACvB,wBAAwB,EACxB,qBAAqB,EACrB,kBAAkB,EAClB,0BAA0B,EAC1B,2BAA2B,EAC3B,yBAAyB,EACzB,eAAe,EACf,yBAAyB,EACzB,mBAAmB,GACpB,MAAM,WAAW,CAAC"}
|