@simpleapps-com/augur-api 0.3.0 → 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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/package.json +1 -1
|
@@ -0,0 +1,337 @@
|
|
|
1
|
+
import { BaseServiceClient } from '../../core/base-client';
|
|
2
|
+
import type { HTTPClient } from '../../core/client';
|
|
3
|
+
import { RatesRequestParams, TaxCalculationResult } from './schemas';
|
|
4
|
+
/**
|
|
5
|
+
* Avalara Tax Service Client
|
|
6
|
+
*
|
|
7
|
+
* Provides access to Avalara tax calculation endpoints for real-time tax rate
|
|
8
|
+
* computation and compliance.
|
|
9
|
+
*
|
|
10
|
+
* @service avalara
|
|
11
|
+
* @domain tax-calculation
|
|
12
|
+
*/
|
|
13
|
+
export declare class AvalaraClient extends BaseServiceClient {
|
|
14
|
+
constructor(http: HTTPClient, baseUrl?: string);
|
|
15
|
+
protected getServiceDescription(): string;
|
|
16
|
+
/**
|
|
17
|
+
* Check service health and availability
|
|
18
|
+
*
|
|
19
|
+
* @fullPath api.avalara.healthCheck.get
|
|
20
|
+
* @service avalara
|
|
21
|
+
* @domain system-health
|
|
22
|
+
* @dataMethod healthCheckData
|
|
23
|
+
* @discoverable true
|
|
24
|
+
* @searchTerms ["health", "status", "availability", "ping", "check", "tax service"]
|
|
25
|
+
* @relatedEndpoints ["api.avalara.rates.calculate", "api.agrWork.healthCheck.get", "api.agrInfo.healthCheck.get", "api.commerce.healthCheck.get"]
|
|
26
|
+
* @commonPatterns ["Health check", "Service status", "Tax service availability", "System monitoring"]
|
|
27
|
+
* @workflow ["system-monitoring", "health-checks", "service-discovery", "tax-service-verification"]
|
|
28
|
+
* @prerequisites ["Service is running", "Valid authentication token", "x-site-id header"]
|
|
29
|
+
* @nextSteps ["Use tax calculation endpoints if healthy", "Verify tax service connectivity", "Monitor service metrics"]
|
|
30
|
+
* @businessRules ["Returns service status and basic info", "Requires standard authentication", "Standard health check format"]
|
|
31
|
+
* @functionalArea "system-monitoring"
|
|
32
|
+
* @caching "No caching - real-time status required"
|
|
33
|
+
* @performance "Fast response, minimal processing, use for tax service monitoring"
|
|
34
|
+
*
|
|
35
|
+
* @returns Promise<HealthCheckResponse> Service health status
|
|
36
|
+
*
|
|
37
|
+
* @example
|
|
38
|
+
* ```typescript
|
|
39
|
+
* // Check if tax service is healthy
|
|
40
|
+
* const response = await client.healthCheck();
|
|
41
|
+
* console.log(response.data); // Health status string
|
|
42
|
+
* console.log(response.status); // HTTP status code
|
|
43
|
+
*
|
|
44
|
+
* // Get just the health status
|
|
45
|
+
* const status = await client.healthCheckData();
|
|
46
|
+
* console.log(status); // Direct string access
|
|
47
|
+
* ```
|
|
48
|
+
*/
|
|
49
|
+
readonly healthCheck: () => Promise<{
|
|
50
|
+
params: Record<string, unknown> | unknown[];
|
|
51
|
+
data: string;
|
|
52
|
+
options: Record<string, unknown> | unknown[];
|
|
53
|
+
status: number;
|
|
54
|
+
message: string;
|
|
55
|
+
count: number;
|
|
56
|
+
total: number;
|
|
57
|
+
totalResults: number;
|
|
58
|
+
}>;
|
|
59
|
+
/**
|
|
60
|
+
* Calculate tax rates for transaction lines
|
|
61
|
+
*
|
|
62
|
+
* @fullPath api.avalara.rates.calculate
|
|
63
|
+
* @service avalara
|
|
64
|
+
* @domain tax-calculation
|
|
65
|
+
* @dataMethod ratesCalculateData
|
|
66
|
+
* @discoverable true
|
|
67
|
+
* @searchTerms ["tax", "rates", "calculate", "avalara", "sales tax", "vat", "compliance", "transaction"]
|
|
68
|
+
* @relatedEndpoints ["api.commerce.orders.create", "api.commerce.cartHeaders.checkout", "api.items.pricing.calculate", "api.customers.addresses.validate"]
|
|
69
|
+
* @commonPatterns ["Calculate sales tax", "Get tax rates", "Tax compliance", "E-commerce tax calculation", "Multi-jurisdiction tax"]
|
|
70
|
+
* @workflow ["e-commerce-checkout", "order-processing", "tax-compliance", "invoice-generation", "financial-reporting"]
|
|
71
|
+
* @prerequisites ["Valid transaction data", "Public bearer token", "x-site-id header", "Valid addresses", "Product/service lines"]
|
|
72
|
+
* @nextSteps ["Apply calculated tax to order", "Store tax calculation results", "Generate compliant invoice", "Submit tax returns"]
|
|
73
|
+
* @businessRules ["Requires valid addresses", "Supports multiple tax jurisdictions", "Real-time calculation", "Compliance with local tax laws", "Handles exemptions and special rates"]
|
|
74
|
+
* @functionalArea "tax-and-compliance"
|
|
75
|
+
* @crossSite "Multi-site tax calculation support"
|
|
76
|
+
* @caching "Cache for 1 hour for identical requests, tax rates change infrequently"
|
|
77
|
+
* @performance "Optimize by batching multiple line items, use address validation for accuracy"
|
|
78
|
+
*
|
|
79
|
+
* @param params Tax calculation request parameters including lines, addresses, and transaction details
|
|
80
|
+
* @returns Promise<RatesResponse> Complete tax calculation results with rates, amounts, and jurisdiction details
|
|
81
|
+
*
|
|
82
|
+
* @example
|
|
83
|
+
* ```typescript
|
|
84
|
+
* // Calculate tax for a simple sale
|
|
85
|
+
* const taxRequest = {
|
|
86
|
+
* lines: [{
|
|
87
|
+
* amount: 100.00,
|
|
88
|
+
* description: 'Widget',
|
|
89
|
+
* quantity: 1
|
|
90
|
+
* }],
|
|
91
|
+
* addresses: {
|
|
92
|
+
* shipTo: {
|
|
93
|
+
* line1: '123 Main St',
|
|
94
|
+
* city: 'Irvine',
|
|
95
|
+
* region: 'CA',
|
|
96
|
+
* country: 'US',
|
|
97
|
+
* postalCode: '92602'
|
|
98
|
+
* }
|
|
99
|
+
* },
|
|
100
|
+
* type: 'SalesOrder',
|
|
101
|
+
* date: '2024-01-15',
|
|
102
|
+
* companyCode: 'DEFAULT'
|
|
103
|
+
* };
|
|
104
|
+
*
|
|
105
|
+
* const response = await client.ratesCalculate(taxRequest);
|
|
106
|
+
* console.log(response.data.totalTax); // Total tax amount
|
|
107
|
+
* console.log(response.data.lines); // Tax details per line
|
|
108
|
+
*
|
|
109
|
+
* // Get just the calculation result
|
|
110
|
+
* const taxResult = await client.ratesCalculateData(taxRequest);
|
|
111
|
+
* console.log(taxResult.totalTax); // Direct access to tax amount
|
|
112
|
+
*
|
|
113
|
+
* // Multi-line transaction with shipping
|
|
114
|
+
* const complexRequest = {
|
|
115
|
+
* lines: [
|
|
116
|
+
* { amount: 50.00, description: 'Product A', taxCode: 'P0000000' },
|
|
117
|
+
* { amount: 30.00, description: 'Product B', taxCode: 'P0000000' },
|
|
118
|
+
* { amount: 10.00, description: 'Shipping', taxCode: 'FR010000' }
|
|
119
|
+
* ],
|
|
120
|
+
* addresses: {
|
|
121
|
+
* shipFrom: {
|
|
122
|
+
* line1: '100 Warehouse Blvd',
|
|
123
|
+
* city: 'Los Angeles',
|
|
124
|
+
* region: 'CA',
|
|
125
|
+
* country: 'US',
|
|
126
|
+
* postalCode: '90210'
|
|
127
|
+
* },
|
|
128
|
+
* shipTo: {
|
|
129
|
+
* line1: '456 Customer Ave',
|
|
130
|
+
* city: 'New York',
|
|
131
|
+
* region: 'NY',
|
|
132
|
+
* country: 'US',
|
|
133
|
+
* postalCode: '10001'
|
|
134
|
+
* }
|
|
135
|
+
* },
|
|
136
|
+
* type: 'SalesInvoice',
|
|
137
|
+
* customerCode: 'CUST001',
|
|
138
|
+
* commit: true
|
|
139
|
+
* };
|
|
140
|
+
*
|
|
141
|
+
* const complexResult = await client.ratesCalculateData(complexRequest);
|
|
142
|
+
* ```
|
|
143
|
+
*/
|
|
144
|
+
readonly ratesCalculate: (data: import("zod").objectInputType<{
|
|
145
|
+
lines: import("zod").ZodArray<import("zod").ZodObject<{
|
|
146
|
+
amount: import("zod").ZodNumber;
|
|
147
|
+
description: import("zod").ZodOptional<import("zod").ZodString>;
|
|
148
|
+
taxCode: import("zod").ZodOptional<import("zod").ZodString>;
|
|
149
|
+
customerUsageType: import("zod").ZodOptional<import("zod").ZodString>;
|
|
150
|
+
itemCode: import("zod").ZodOptional<import("zod").ZodString>;
|
|
151
|
+
quantity: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
152
|
+
discount: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
153
|
+
}, "strip", import("zod").ZodTypeAny, {
|
|
154
|
+
amount: number;
|
|
155
|
+
description?: string | undefined;
|
|
156
|
+
quantity?: number | undefined;
|
|
157
|
+
taxCode?: string | undefined;
|
|
158
|
+
customerUsageType?: string | undefined;
|
|
159
|
+
itemCode?: string | undefined;
|
|
160
|
+
discount?: number | undefined;
|
|
161
|
+
}, {
|
|
162
|
+
amount: number;
|
|
163
|
+
description?: string | undefined;
|
|
164
|
+
quantity?: number | undefined;
|
|
165
|
+
taxCode?: string | undefined;
|
|
166
|
+
customerUsageType?: string | undefined;
|
|
167
|
+
itemCode?: string | undefined;
|
|
168
|
+
discount?: number | undefined;
|
|
169
|
+
}>, "many">;
|
|
170
|
+
addresses: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
171
|
+
shipFrom: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
172
|
+
line1: import("zod").ZodOptional<import("zod").ZodString>;
|
|
173
|
+
city: import("zod").ZodOptional<import("zod").ZodString>;
|
|
174
|
+
region: import("zod").ZodOptional<import("zod").ZodString>;
|
|
175
|
+
country: import("zod").ZodOptional<import("zod").ZodString>;
|
|
176
|
+
postalCode: import("zod").ZodOptional<import("zod").ZodString>;
|
|
177
|
+
}, "strip", import("zod").ZodTypeAny, {
|
|
178
|
+
city?: string | undefined;
|
|
179
|
+
country?: string | undefined;
|
|
180
|
+
postalCode?: string | undefined;
|
|
181
|
+
line1?: string | undefined;
|
|
182
|
+
region?: string | undefined;
|
|
183
|
+
}, {
|
|
184
|
+
city?: string | undefined;
|
|
185
|
+
country?: string | undefined;
|
|
186
|
+
postalCode?: string | undefined;
|
|
187
|
+
line1?: string | undefined;
|
|
188
|
+
region?: string | undefined;
|
|
189
|
+
}>>;
|
|
190
|
+
shipTo: import("zod").ZodObject<{
|
|
191
|
+
line1: import("zod").ZodOptional<import("zod").ZodString>;
|
|
192
|
+
city: import("zod").ZodOptional<import("zod").ZodString>;
|
|
193
|
+
region: import("zod").ZodOptional<import("zod").ZodString>;
|
|
194
|
+
country: import("zod").ZodOptional<import("zod").ZodString>;
|
|
195
|
+
postalCode: import("zod").ZodOptional<import("zod").ZodString>;
|
|
196
|
+
}, "strip", import("zod").ZodTypeAny, {
|
|
197
|
+
city?: string | undefined;
|
|
198
|
+
country?: string | undefined;
|
|
199
|
+
postalCode?: string | undefined;
|
|
200
|
+
line1?: string | undefined;
|
|
201
|
+
region?: string | undefined;
|
|
202
|
+
}, {
|
|
203
|
+
city?: string | undefined;
|
|
204
|
+
country?: string | undefined;
|
|
205
|
+
postalCode?: string | undefined;
|
|
206
|
+
line1?: string | undefined;
|
|
207
|
+
region?: string | undefined;
|
|
208
|
+
}>;
|
|
209
|
+
}, "strip", import("zod").ZodTypeAny, {
|
|
210
|
+
shipTo: {
|
|
211
|
+
city?: string | undefined;
|
|
212
|
+
country?: string | undefined;
|
|
213
|
+
postalCode?: string | undefined;
|
|
214
|
+
line1?: string | undefined;
|
|
215
|
+
region?: string | undefined;
|
|
216
|
+
};
|
|
217
|
+
shipFrom?: {
|
|
218
|
+
city?: string | undefined;
|
|
219
|
+
country?: string | undefined;
|
|
220
|
+
postalCode?: string | undefined;
|
|
221
|
+
line1?: string | undefined;
|
|
222
|
+
region?: string | undefined;
|
|
223
|
+
} | undefined;
|
|
224
|
+
}, {
|
|
225
|
+
shipTo: {
|
|
226
|
+
city?: string | undefined;
|
|
227
|
+
country?: string | undefined;
|
|
228
|
+
postalCode?: string | undefined;
|
|
229
|
+
line1?: string | undefined;
|
|
230
|
+
region?: string | undefined;
|
|
231
|
+
};
|
|
232
|
+
shipFrom?: {
|
|
233
|
+
city?: string | undefined;
|
|
234
|
+
country?: string | undefined;
|
|
235
|
+
postalCode?: string | undefined;
|
|
236
|
+
line1?: string | undefined;
|
|
237
|
+
region?: string | undefined;
|
|
238
|
+
} | undefined;
|
|
239
|
+
}>>;
|
|
240
|
+
date: import("zod").ZodOptional<import("zod").ZodString>;
|
|
241
|
+
type: import("zod").ZodOptional<import("zod").ZodEnum<["SalesOrder", "SalesInvoice", "ReturnInvoice", "InventoryTransferOrder"]>>;
|
|
242
|
+
companyCode: import("zod").ZodOptional<import("zod").ZodString>;
|
|
243
|
+
customerCode: import("zod").ZodOptional<import("zod").ZodString>;
|
|
244
|
+
businessIdentificationNo: import("zod").ZodOptional<import("zod").ZodString>;
|
|
245
|
+
commit: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
246
|
+
currencyCode: import("zod").ZodOptional<import("zod").ZodString>;
|
|
247
|
+
}, import("zod").ZodTypeAny, "passthrough">) => Promise<{
|
|
248
|
+
params: Record<string, unknown> | unknown[];
|
|
249
|
+
data: {
|
|
250
|
+
lines?: import("zod").objectInputType<{
|
|
251
|
+
lineNumber: import("zod").ZodOptional<import("zod").ZodString>;
|
|
252
|
+
taxableAmount: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
253
|
+
tax: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
254
|
+
taxCalculated: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
255
|
+
rate: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
256
|
+
exemptAmount: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
257
|
+
details: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
|
|
258
|
+
jurisdictionName: import("zod").ZodOptional<import("zod").ZodString>;
|
|
259
|
+
rate: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
260
|
+
tax: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
261
|
+
taxableAmount: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
262
|
+
taxType: import("zod").ZodOptional<import("zod").ZodString>;
|
|
263
|
+
jurisdictionType: import("zod").ZodOptional<import("zod").ZodString>;
|
|
264
|
+
}, "strip", import("zod").ZodTypeAny, {
|
|
265
|
+
taxableAmount?: number | undefined;
|
|
266
|
+
tax?: number | undefined;
|
|
267
|
+
rate?: number | undefined;
|
|
268
|
+
jurisdictionName?: string | undefined;
|
|
269
|
+
taxType?: string | undefined;
|
|
270
|
+
jurisdictionType?: string | undefined;
|
|
271
|
+
}, {
|
|
272
|
+
taxableAmount?: number | undefined;
|
|
273
|
+
tax?: number | undefined;
|
|
274
|
+
rate?: number | undefined;
|
|
275
|
+
jurisdictionName?: string | undefined;
|
|
276
|
+
taxType?: string | undefined;
|
|
277
|
+
jurisdictionType?: string | undefined;
|
|
278
|
+
}>, "many">>;
|
|
279
|
+
}, import("zod").ZodTypeAny, "passthrough">[] | undefined;
|
|
280
|
+
summary?: {
|
|
281
|
+
country?: string | undefined;
|
|
282
|
+
region?: string | undefined;
|
|
283
|
+
tax?: number | undefined;
|
|
284
|
+
taxCalculated?: number | undefined;
|
|
285
|
+
rate?: number | undefined;
|
|
286
|
+
taxType?: string | undefined;
|
|
287
|
+
jurisType?: string | undefined;
|
|
288
|
+
jurisCode?: string | undefined;
|
|
289
|
+
jurisName?: string | undefined;
|
|
290
|
+
taxAuthorityType?: number | undefined;
|
|
291
|
+
stateAssignedNo?: string | undefined;
|
|
292
|
+
taxName?: string | undefined;
|
|
293
|
+
taxGroup?: string | undefined;
|
|
294
|
+
rateType?: string | undefined;
|
|
295
|
+
taxable?: number | undefined;
|
|
296
|
+
nonTaxable?: number | undefined;
|
|
297
|
+
exemption?: number | undefined;
|
|
298
|
+
}[] | undefined;
|
|
299
|
+
totalAmount?: number | undefined;
|
|
300
|
+
addresses?: {
|
|
301
|
+
city?: string | undefined;
|
|
302
|
+
country?: string | undefined;
|
|
303
|
+
postalCode?: string | undefined;
|
|
304
|
+
line1?: string | undefined;
|
|
305
|
+
region?: string | undefined;
|
|
306
|
+
addressType?: string | undefined;
|
|
307
|
+
latitude?: number | undefined;
|
|
308
|
+
longitude?: number | undefined;
|
|
309
|
+
}[] | undefined;
|
|
310
|
+
totalExempt?: number | undefined;
|
|
311
|
+
totalTaxable?: number | undefined;
|
|
312
|
+
totalTax?: number | undefined;
|
|
313
|
+
totalTaxCalculated?: number | undefined;
|
|
314
|
+
taxDate?: string | undefined;
|
|
315
|
+
} & {
|
|
316
|
+
[k: string]: unknown;
|
|
317
|
+
};
|
|
318
|
+
options: Record<string, unknown> | unknown[];
|
|
319
|
+
status: number;
|
|
320
|
+
message: string;
|
|
321
|
+
count: number;
|
|
322
|
+
total: number;
|
|
323
|
+
totalResults: number;
|
|
324
|
+
}>;
|
|
325
|
+
/**
|
|
326
|
+
* Get health check status data only
|
|
327
|
+
* @returns Promise<string> Health status string
|
|
328
|
+
*/
|
|
329
|
+
readonly healthCheckData: () => Promise<string>;
|
|
330
|
+
/**
|
|
331
|
+
* Calculate tax rates and return calculation result data only
|
|
332
|
+
* @param params Tax calculation request parameters
|
|
333
|
+
* @returns Promise<TaxCalculationResult> Tax calculation result with rates and amounts
|
|
334
|
+
*/
|
|
335
|
+
readonly ratesCalculateData: (params: RatesRequestParams) => Promise<TaxCalculationResult>;
|
|
336
|
+
}
|
|
337
|
+
//# sourceMappingURL=client.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../../src/services/avalara/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAGL,kBAAkB,EAElB,oBAAoB,EACrB,MAAM,WAAW,CAAC;AAEnB;;;;;;;;GAQG;AACH,qBAAa,aAAc,SAAQ,iBAAiB;gBACtC,IAAI,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,MAAM;IAI9C,SAAS,CAAC,qBAAqB,IAAI,MAAM;IAIzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,QAAQ,CAAC,WAAW;;;;;;;;;OAA2D;IAE/E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoFG;IACH,QAAQ,CAAC,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAIrB;IAIF;;;OAGG;IACH,QAAQ,CAAC,eAAe,QAAa,OAAO,CAAC,MAAM,CAAC,CAGlD;IAEF;;;;OAIG;IACH,QAAQ,CAAC,kBAAkB,GACzB,QAAQ,kBAAkB,KACzB,OAAO,CAAC,oBAAoB,CAAC,CAG9B;CACH"}
|
|
@@ -0,0 +1,162 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.AvalaraClient = void 0;
|
|
4
|
+
const base_client_1 = require("../../core/base-client");
|
|
5
|
+
const schemas_1 = require("./schemas");
|
|
6
|
+
/**
|
|
7
|
+
* Avalara Tax Service Client
|
|
8
|
+
*
|
|
9
|
+
* Provides access to Avalara tax calculation endpoints for real-time tax rate
|
|
10
|
+
* computation and compliance.
|
|
11
|
+
*
|
|
12
|
+
* @service avalara
|
|
13
|
+
* @domain tax-calculation
|
|
14
|
+
*/
|
|
15
|
+
class AvalaraClient extends base_client_1.BaseServiceClient {
|
|
16
|
+
constructor(http, baseUrl) {
|
|
17
|
+
super('avalara', http, baseUrl || 'https://avalara.augur-api.com');
|
|
18
|
+
/**
|
|
19
|
+
* Check service health and availability
|
|
20
|
+
*
|
|
21
|
+
* @fullPath api.avalara.healthCheck.get
|
|
22
|
+
* @service avalara
|
|
23
|
+
* @domain system-health
|
|
24
|
+
* @dataMethod healthCheckData
|
|
25
|
+
* @discoverable true
|
|
26
|
+
* @searchTerms ["health", "status", "availability", "ping", "check", "tax service"]
|
|
27
|
+
* @relatedEndpoints ["api.avalara.rates.calculate", "api.agrWork.healthCheck.get", "api.agrInfo.healthCheck.get", "api.commerce.healthCheck.get"]
|
|
28
|
+
* @commonPatterns ["Health check", "Service status", "Tax service availability", "System monitoring"]
|
|
29
|
+
* @workflow ["system-monitoring", "health-checks", "service-discovery", "tax-service-verification"]
|
|
30
|
+
* @prerequisites ["Service is running", "Valid authentication token", "x-site-id header"]
|
|
31
|
+
* @nextSteps ["Use tax calculation endpoints if healthy", "Verify tax service connectivity", "Monitor service metrics"]
|
|
32
|
+
* @businessRules ["Returns service status and basic info", "Requires standard authentication", "Standard health check format"]
|
|
33
|
+
* @functionalArea "system-monitoring"
|
|
34
|
+
* @caching "No caching - real-time status required"
|
|
35
|
+
* @performance "Fast response, minimal processing, use for tax service monitoring"
|
|
36
|
+
*
|
|
37
|
+
* @returns Promise<HealthCheckResponse> Service health status
|
|
38
|
+
*
|
|
39
|
+
* @example
|
|
40
|
+
* ```typescript
|
|
41
|
+
* // Check if tax service is healthy
|
|
42
|
+
* const response = await client.healthCheck();
|
|
43
|
+
* console.log(response.data); // Health status string
|
|
44
|
+
* console.log(response.status); // HTTP status code
|
|
45
|
+
*
|
|
46
|
+
* // Get just the health status
|
|
47
|
+
* const status = await client.healthCheckData();
|
|
48
|
+
* console.log(status); // Direct string access
|
|
49
|
+
* ```
|
|
50
|
+
*/
|
|
51
|
+
this.healthCheck = this.createHealthCheckMethod(schemas_1.HealthCheckResponseSchema);
|
|
52
|
+
/**
|
|
53
|
+
* Calculate tax rates for transaction lines
|
|
54
|
+
*
|
|
55
|
+
* @fullPath api.avalara.rates.calculate
|
|
56
|
+
* @service avalara
|
|
57
|
+
* @domain tax-calculation
|
|
58
|
+
* @dataMethod ratesCalculateData
|
|
59
|
+
* @discoverable true
|
|
60
|
+
* @searchTerms ["tax", "rates", "calculate", "avalara", "sales tax", "vat", "compliance", "transaction"]
|
|
61
|
+
* @relatedEndpoints ["api.commerce.orders.create", "api.commerce.cartHeaders.checkout", "api.items.pricing.calculate", "api.customers.addresses.validate"]
|
|
62
|
+
* @commonPatterns ["Calculate sales tax", "Get tax rates", "Tax compliance", "E-commerce tax calculation", "Multi-jurisdiction tax"]
|
|
63
|
+
* @workflow ["e-commerce-checkout", "order-processing", "tax-compliance", "invoice-generation", "financial-reporting"]
|
|
64
|
+
* @prerequisites ["Valid transaction data", "Public bearer token", "x-site-id header", "Valid addresses", "Product/service lines"]
|
|
65
|
+
* @nextSteps ["Apply calculated tax to order", "Store tax calculation results", "Generate compliant invoice", "Submit tax returns"]
|
|
66
|
+
* @businessRules ["Requires valid addresses", "Supports multiple tax jurisdictions", "Real-time calculation", "Compliance with local tax laws", "Handles exemptions and special rates"]
|
|
67
|
+
* @functionalArea "tax-and-compliance"
|
|
68
|
+
* @crossSite "Multi-site tax calculation support"
|
|
69
|
+
* @caching "Cache for 1 hour for identical requests, tax rates change infrequently"
|
|
70
|
+
* @performance "Optimize by batching multiple line items, use address validation for accuracy"
|
|
71
|
+
*
|
|
72
|
+
* @param params Tax calculation request parameters including lines, addresses, and transaction details
|
|
73
|
+
* @returns Promise<RatesResponse> Complete tax calculation results with rates, amounts, and jurisdiction details
|
|
74
|
+
*
|
|
75
|
+
* @example
|
|
76
|
+
* ```typescript
|
|
77
|
+
* // Calculate tax for a simple sale
|
|
78
|
+
* const taxRequest = {
|
|
79
|
+
* lines: [{
|
|
80
|
+
* amount: 100.00,
|
|
81
|
+
* description: 'Widget',
|
|
82
|
+
* quantity: 1
|
|
83
|
+
* }],
|
|
84
|
+
* addresses: {
|
|
85
|
+
* shipTo: {
|
|
86
|
+
* line1: '123 Main St',
|
|
87
|
+
* city: 'Irvine',
|
|
88
|
+
* region: 'CA',
|
|
89
|
+
* country: 'US',
|
|
90
|
+
* postalCode: '92602'
|
|
91
|
+
* }
|
|
92
|
+
* },
|
|
93
|
+
* type: 'SalesOrder',
|
|
94
|
+
* date: '2024-01-15',
|
|
95
|
+
* companyCode: 'DEFAULT'
|
|
96
|
+
* };
|
|
97
|
+
*
|
|
98
|
+
* const response = await client.ratesCalculate(taxRequest);
|
|
99
|
+
* console.log(response.data.totalTax); // Total tax amount
|
|
100
|
+
* console.log(response.data.lines); // Tax details per line
|
|
101
|
+
*
|
|
102
|
+
* // Get just the calculation result
|
|
103
|
+
* const taxResult = await client.ratesCalculateData(taxRequest);
|
|
104
|
+
* console.log(taxResult.totalTax); // Direct access to tax amount
|
|
105
|
+
*
|
|
106
|
+
* // Multi-line transaction with shipping
|
|
107
|
+
* const complexRequest = {
|
|
108
|
+
* lines: [
|
|
109
|
+
* { amount: 50.00, description: 'Product A', taxCode: 'P0000000' },
|
|
110
|
+
* { amount: 30.00, description: 'Product B', taxCode: 'P0000000' },
|
|
111
|
+
* { amount: 10.00, description: 'Shipping', taxCode: 'FR010000' }
|
|
112
|
+
* ],
|
|
113
|
+
* addresses: {
|
|
114
|
+
* shipFrom: {
|
|
115
|
+
* line1: '100 Warehouse Blvd',
|
|
116
|
+
* city: 'Los Angeles',
|
|
117
|
+
* region: 'CA',
|
|
118
|
+
* country: 'US',
|
|
119
|
+
* postalCode: '90210'
|
|
120
|
+
* },
|
|
121
|
+
* shipTo: {
|
|
122
|
+
* line1: '456 Customer Ave',
|
|
123
|
+
* city: 'New York',
|
|
124
|
+
* region: 'NY',
|
|
125
|
+
* country: 'US',
|
|
126
|
+
* postalCode: '10001'
|
|
127
|
+
* }
|
|
128
|
+
* },
|
|
129
|
+
* type: 'SalesInvoice',
|
|
130
|
+
* customerCode: 'CUST001',
|
|
131
|
+
* commit: true
|
|
132
|
+
* };
|
|
133
|
+
*
|
|
134
|
+
* const complexResult = await client.ratesCalculateData(complexRequest);
|
|
135
|
+
* ```
|
|
136
|
+
*/
|
|
137
|
+
this.ratesCalculate = this.createCreateMethod('/rates', schemas_1.RatesRequestParamsSchema, schemas_1.RatesResponseSchema);
|
|
138
|
+
// Data-only methods for direct access to response data
|
|
139
|
+
/**
|
|
140
|
+
* Get health check status data only
|
|
141
|
+
* @returns Promise<string> Health status string
|
|
142
|
+
*/
|
|
143
|
+
this.healthCheckData = async () => {
|
|
144
|
+
const response = await this.healthCheck();
|
|
145
|
+
return response.data;
|
|
146
|
+
};
|
|
147
|
+
/**
|
|
148
|
+
* Calculate tax rates and return calculation result data only
|
|
149
|
+
* @param params Tax calculation request parameters
|
|
150
|
+
* @returns Promise<TaxCalculationResult> Tax calculation result with rates and amounts
|
|
151
|
+
*/
|
|
152
|
+
this.ratesCalculateData = async (params) => {
|
|
153
|
+
const response = await this.ratesCalculate(params);
|
|
154
|
+
return response.data;
|
|
155
|
+
};
|
|
156
|
+
}
|
|
157
|
+
getServiceDescription() {
|
|
158
|
+
return 'Avalara tax calculation service for real-time tax rate computation and compliance';
|
|
159
|
+
}
|
|
160
|
+
}
|
|
161
|
+
exports.AvalaraClient = AvalaraClient;
|
|
162
|
+
//# sourceMappingURL=client.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../../src/services/avalara/client.ts"],"names":[],"mappings":";;;AAAA,wDAA2D;AAE3D,uCAMmB;AAEnB;;;;;;;;GAQG;AACH,MAAa,aAAc,SAAQ,+BAAiB;IAClD,YAAY,IAAgB,EAAE,OAAgB;QAC5C,KAAK,CAAC,SAAS,EAAE,IAAI,EAAE,OAAO,IAAI,+BAA+B,CAAC,CAAC;QAOrE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAgCG;QACM,gBAAW,GAAG,IAAI,CAAC,uBAAuB,CAAC,mCAAyB,CAAC,CAAC;QAE/E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAoFG;QACM,mBAAc,GAAG,IAAI,CAAC,kBAAkB,CAC/C,QAAQ,EACR,kCAAwB,EACxB,6BAAmB,CACpB,CAAC;QAEF,uDAAuD;QAEvD;;;WAGG;QACM,oBAAe,GAAG,KAAK,IAAqB,EAAE;YACrD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;YAC1C,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC,CAAC;QAEF;;;;WAIG;QACM,uBAAkB,GAAG,KAAK,EACjC,MAA0B,EACK,EAAE;YACjC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;YACnD,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC,CAAC;IAzJF,CAAC;IAES,qBAAqB;QAC7B,OAAO,mFAAmF,CAAC;IAC7F,CAAC;CAsJF;AA7JD,sCA6JC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/avalara/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,YAAY,EAEV,mBAAmB,EAEnB,kBAAkB,EAClB,aAAa,EACb,oBAAoB,EACpB,OAAO,GACR,MAAM,WAAW,CAAC"}
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.AvalaraClient = void 0;
|
|
4
|
+
var client_1 = require("./client");
|
|
5
|
+
Object.defineProperty(exports, "AvalaraClient", { enumerable: true, get: function () { return client_1.AvalaraClient; } });
|
|
6
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/services/avalara/index.ts"],"names":[],"mappings":";;;AAAA,mCAAyC;AAAhC,uGAAA,aAAa,OAAA"}
|