@simpleapps-com/augur-api 0.3.2 → 0.4.0
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 +2 -2
- package/API-SERVICES.md +227 -0
- package/QUICKSTART.md +2 -2
- package/README.md +144 -10
- package/dist/cjs/client.d.ts +78 -0
- package/dist/cjs/client.d.ts.map +1 -1
- package/dist/cjs/client.js +182 -0
- package/dist/cjs/client.js.map +1 -1
- package/dist/cjs/index.d.ts +1 -1
- package/dist/cjs/index.js +1 -1
- package/dist/cjs/services/agr-info/client.d.ts +579 -545
- package/dist/cjs/services/agr-info/client.d.ts.map +1 -1
- package/dist/cjs/services/agr-info/client.js +440 -407
- package/dist/cjs/services/agr-info/client.js.map +1 -1
- package/dist/cjs/services/agr-site/client.d.ts +156 -85
- package/dist/cjs/services/agr-site/client.d.ts.map +1 -1
- package/dist/cjs/services/agr-site/client.js +179 -106
- package/dist/cjs/services/agr-site/client.js.map +1 -1
- package/dist/cjs/services/agr-work/client.d.ts +152 -96
- package/dist/cjs/services/agr-work/client.d.ts.map +1 -1
- package/dist/cjs/services/agr-work/client.js +155 -81
- package/dist/cjs/services/agr-work/client.js.map +1 -1
- package/dist/cjs/services/avalara/client.d.ts +260 -316
- package/dist/cjs/services/avalara/client.d.ts.map +1 -1
- package/dist/cjs/services/avalara/client.js +194 -136
- package/dist/cjs/services/avalara/client.js.map +1 -1
- package/dist/cjs/services/brand-folder/client.d.ts +200 -170
- package/dist/cjs/services/brand-folder/client.d.ts.map +1 -1
- package/dist/cjs/services/brand-folder/client.js +181 -124
- package/dist/cjs/services/brand-folder/client.js.map +1 -1
- package/dist/cjs/services/brand-folder/schemas.d.ts +8 -8
- package/dist/cjs/services/commerce/client.d.ts +821 -877
- package/dist/cjs/services/commerce/client.d.ts.map +1 -1
- package/dist/cjs/services/commerce/client.js +843 -487
- package/dist/cjs/services/commerce/client.js.map +1 -1
- package/dist/cjs/services/customers/client.d.ts +310 -565
- package/dist/cjs/services/customers/client.d.ts.map +1 -1
- package/dist/cjs/services/customers/client.js +224 -452
- package/dist/cjs/services/customers/client.js.map +1 -1
- package/dist/cjs/services/gregorovich/client.d.ts +347 -311
- package/dist/cjs/services/gregorovich/client.d.ts.map +1 -1
- package/dist/cjs/services/gregorovich/client.js +292 -254
- package/dist/cjs/services/gregorovich/client.js.map +1 -1
- package/dist/cjs/services/gregorovich/index.d.ts +1 -1
- package/dist/cjs/services/gregorovich/index.d.ts.map +1 -1
- package/dist/cjs/services/gregorovich/schemas/chatGptAsk.d.ts +371 -0
- package/dist/cjs/services/gregorovich/schemas/chatGptAsk.d.ts.map +1 -0
- package/dist/cjs/services/gregorovich/schemas/chatGptAsk.js +71 -0
- package/dist/cjs/services/gregorovich/schemas/chatGptAsk.js.map +1 -0
- package/dist/cjs/services/gregorovich/schemas/documents.d.ts +398 -0
- package/dist/cjs/services/gregorovich/schemas/documents.d.ts.map +1 -0
- package/dist/cjs/services/gregorovich/schemas/documents.js +61 -0
- package/dist/cjs/services/gregorovich/schemas/documents.js.map +1 -0
- package/dist/cjs/services/gregorovich/schemas/healthCheck.d.ts +53 -0
- package/dist/cjs/services/gregorovich/schemas/healthCheck.d.ts.map +1 -0
- package/dist/cjs/services/gregorovich/schemas/healthCheck.js +11 -0
- package/dist/cjs/services/gregorovich/schemas/healthCheck.js.map +1 -0
- package/dist/cjs/services/gregorovich/schemas/index.d.ts +5 -0
- package/dist/cjs/services/gregorovich/schemas/index.d.ts.map +1 -0
- package/dist/cjs/services/gregorovich/schemas/index.js +21 -0
- package/dist/cjs/services/gregorovich/schemas/index.js.map +1 -0
- package/dist/cjs/services/gregorovich/schemas/ollamaGenerate.d.ts +433 -0
- package/dist/cjs/services/gregorovich/schemas/ollamaGenerate.d.ts.map +1 -0
- package/dist/cjs/services/gregorovich/schemas/ollamaGenerate.js +100 -0
- package/dist/cjs/services/gregorovich/schemas/ollamaGenerate.js.map +1 -0
- package/dist/cjs/services/gregorovich/schemas.d.ts +1 -1217
- package/dist/cjs/services/gregorovich/schemas.d.ts.map +1 -1
- package/dist/cjs/services/gregorovich/schemas.js +16 -198
- package/dist/cjs/services/gregorovich/schemas.js.map +1 -1
- package/dist/cjs/services/items/client.d.ts +1865 -1724
- package/dist/cjs/services/items/client.d.ts.map +1 -1
- package/dist/cjs/services/items/client.js +1726 -1171
- package/dist/cjs/services/items/client.js.map +1 -1
- package/dist/cjs/services/items/schemas/attributes.d.ts +2 -2
- package/dist/cjs/services/items/schemas/brandsItems.d.ts +304 -0
- package/dist/cjs/services/items/schemas/brandsItems.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/brandsItems.js +44 -0
- package/dist/cjs/services/items/schemas/brandsItems.js.map +1 -0
- package/dist/cjs/services/items/schemas/categoriesImages.d.ts +127 -0
- package/dist/cjs/services/items/schemas/categoriesImages.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/categoriesImages.js +24 -0
- package/dist/cjs/services/items/schemas/categoriesImages.js.map +1 -0
- package/dist/cjs/services/items/schemas/index.d.ts +12 -0
- package/dist/cjs/services/items/schemas/index.d.ts.map +1 -1
- package/dist/cjs/services/items/schemas/index.js +12 -0
- package/dist/cjs/services/items/schemas/index.js.map +1 -1
- package/dist/cjs/services/items/schemas/internalPdf.d.ts +212 -0
- package/dist/cjs/services/items/schemas/internalPdf.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/internalPdf.js +44 -0
- package/dist/cjs/services/items/schemas/internalPdf.js.map +1 -0
- package/dist/cjs/services/items/schemas/invMastAccessory.d.ts +127 -0
- package/dist/cjs/services/items/schemas/invMastAccessory.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/invMastAccessory.js +21 -0
- package/dist/cjs/services/items/schemas/invMastAccessory.js.map +1 -0
- package/dist/cjs/services/items/schemas/invMastAlternateCode.d.ts +147 -0
- package/dist/cjs/services/items/schemas/invMastAlternateCode.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/invMastAlternateCode.js +26 -0
- package/dist/cjs/services/items/schemas/invMastAlternateCode.js.map +1 -0
- package/dist/cjs/services/items/schemas/invMastAttributes.d.ts +177 -0
- package/dist/cjs/services/items/schemas/invMastAttributes.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/invMastAttributes.js +35 -0
- package/dist/cjs/services/items/schemas/invMastAttributes.js.map +1 -0
- package/dist/cjs/services/items/schemas/invMastAttributesValues.d.ts +333 -0
- package/dist/cjs/services/items/schemas/invMastAttributesValues.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/invMastAttributesValues.js +49 -0
- package/dist/cjs/services/items/schemas/invMastAttributesValues.js.map +1 -0
- package/dist/cjs/services/items/schemas/invMastDoc.d.ts +137 -0
- package/dist/cjs/services/items/schemas/invMastDoc.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/invMastDoc.js +22 -0
- package/dist/cjs/services/items/schemas/invMastDoc.js.map +1 -0
- package/dist/cjs/services/items/schemas/invMastLinks.d.ts +147 -0
- package/dist/cjs/services/items/schemas/invMastLinks.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/invMastLinks.js +10 -0
- package/dist/cjs/services/items/schemas/invMastLinks.js.map +1 -0
- package/dist/cjs/services/items/schemas/invMastSimilar.d.ts +127 -0
- package/dist/cjs/services/items/schemas/invMastSimilar.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/invMastSimilar.js +21 -0
- package/dist/cjs/services/items/schemas/invMastSimilar.js.map +1 -0
- package/dist/cjs/services/items/schemas/invMastSub.d.ts +127 -0
- package/dist/cjs/services/items/schemas/invMastSub.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/invMastSub.js +21 -0
- package/dist/cjs/services/items/schemas/invMastSub.js.map +1 -0
- package/dist/cjs/services/items/schemas/invMastSubParts.d.ts +187 -0
- package/dist/cjs/services/items/schemas/invMastSubParts.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/invMastSubParts.js +14 -0
- package/dist/cjs/services/items/schemas/invMastSubParts.js.map +1 -0
- package/dist/cjs/services/items/schemas/itemFavorites.d.ts +236 -0
- package/dist/cjs/services/items/schemas/itemFavorites.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/itemFavorites.js +11 -0
- package/dist/cjs/services/items/schemas/itemFavorites.js.map +1 -0
- package/dist/cjs/services/items/schemas/locationsBins.d.ts +381 -0
- package/dist/cjs/services/items/schemas/locationsBins.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/locationsBins.js +35 -0
- package/dist/cjs/services/items/schemas/locationsBins.js.map +1 -0
- package/dist/cjs/services/legacy/client.d.ts +522 -280
- package/dist/cjs/services/legacy/client.d.ts.map +1 -1
- package/dist/cjs/services/legacy/client.js +388 -146
- package/dist/cjs/services/legacy/client.js.map +1 -1
- package/dist/cjs/services/nexus/client.d.ts +169 -156
- package/dist/cjs/services/nexus/client.d.ts.map +1 -1
- package/dist/cjs/services/nexus/client.js +158 -145
- package/dist/cjs/services/nexus/client.js.map +1 -1
- package/dist/cjs/services/open-search/client.d.ts +434 -162
- package/dist/cjs/services/open-search/client.d.ts.map +1 -1
- package/dist/cjs/services/open-search/client.js +248 -115
- package/dist/cjs/services/open-search/client.js.map +1 -1
- package/dist/cjs/services/{pricing/schemas/health.d.ts → open-search/schemas/healthCheck.d.ts} +19 -49
- package/dist/cjs/services/open-search/schemas/healthCheck.d.ts.map +1 -0
- package/dist/cjs/services/open-search/schemas/healthCheck.js +17 -0
- package/dist/cjs/services/open-search/schemas/healthCheck.js.map +1 -0
- package/dist/cjs/services/open-search/schemas/index.d.ts +5 -0
- package/dist/cjs/services/open-search/schemas/index.d.ts.map +1 -1
- package/dist/cjs/services/open-search/schemas/index.js +27 -0
- package/dist/cjs/services/open-search/schemas/index.js.map +1 -1
- package/dist/cjs/services/open-search/schemas/itemSearch.d.ts +394 -0
- package/dist/cjs/services/open-search/schemas/itemSearch.d.ts.map +1 -0
- package/dist/cjs/services/open-search/schemas/itemSearch.js +74 -0
- package/dist/cjs/services/open-search/schemas/itemSearch.js.map +1 -0
- package/dist/cjs/services/open-search/schemas/itemSearchAttributes.d.ts +359 -0
- package/dist/cjs/services/open-search/schemas/itemSearchAttributes.d.ts.map +1 -0
- package/dist/cjs/services/open-search/schemas/itemSearchAttributes.js +47 -0
- package/dist/cjs/services/open-search/schemas/itemSearchAttributes.js.map +1 -0
- package/dist/cjs/services/open-search/schemas/itemsRefresh.d.ts +512 -0
- package/dist/cjs/services/open-search/schemas/itemsRefresh.d.ts.map +1 -0
- package/dist/cjs/services/open-search/schemas/itemsRefresh.js +62 -0
- package/dist/cjs/services/open-search/schemas/itemsRefresh.js.map +1 -0
- package/dist/cjs/services/open-search/schemas/ping.d.ts +57 -0
- package/dist/cjs/services/open-search/schemas/ping.d.ts.map +1 -0
- package/dist/cjs/services/open-search/schemas/ping.js +14 -0
- package/dist/cjs/services/open-search/schemas/ping.js.map +1 -0
- package/dist/cjs/services/orders/client.d.ts +496 -646
- package/dist/cjs/services/orders/client.d.ts.map +1 -1
- package/dist/cjs/services/orders/client.js +311 -476
- package/dist/cjs/services/orders/client.js.map +1 -1
- package/dist/cjs/services/orders/schemas/invoices.d.ts +10 -10
- package/dist/cjs/services/orders/schemas/invoices.js +1 -1
- package/dist/cjs/services/p21-apis/client.d.ts +311 -534
- package/dist/cjs/services/p21-apis/client.d.ts.map +1 -1
- package/dist/cjs/services/p21-apis/client.js +303 -636
- package/dist/cjs/services/p21-apis/client.js.map +1 -1
- package/dist/cjs/services/p21-apis/schemas.d.ts +9 -78
- package/dist/cjs/services/p21-apis/schemas.d.ts.map +1 -1
- package/dist/cjs/services/p21-apis/schemas.js +9 -32
- package/dist/cjs/services/p21-apis/schemas.js.map +1 -1
- package/dist/cjs/services/p21-core/client.d.ts +111 -75
- package/dist/cjs/services/p21-core/client.d.ts.map +1 -1
- package/dist/cjs/services/p21-core/client.js +146 -106
- package/dist/cjs/services/p21-core/client.js.map +1 -1
- package/dist/cjs/services/p21-pim/client.d.ts +163 -37
- package/dist/cjs/services/p21-pim/client.d.ts.map +1 -1
- package/dist/cjs/services/p21-pim/client.js +163 -37
- package/dist/cjs/services/p21-pim/client.js.map +1 -1
- package/dist/cjs/services/p21-pim/schemas/ai-suggestions.d.ts +6 -6
- package/dist/cjs/services/p21-pim/schemas/ai-suggestions.d.ts.map +1 -1
- package/dist/cjs/services/p21-pim/schemas/ai-suggestions.js +1 -1
- package/dist/cjs/services/p21-pim/schemas/ai-suggestions.js.map +1 -1
- package/dist/cjs/services/p21-pim/schemas/inventory.d.ts +32 -32
- package/dist/cjs/services/p21-sism/client.d.ts +315 -261
- package/dist/cjs/services/p21-sism/client.d.ts.map +1 -1
- package/dist/cjs/services/p21-sism/client.js +371 -313
- package/dist/cjs/services/p21-sism/client.js.map +1 -1
- package/dist/cjs/services/pricing/client.d.ts +289 -59
- package/dist/cjs/services/pricing/client.d.ts.map +1 -1
- package/dist/cjs/services/pricing/client.js +318 -70
- package/dist/cjs/services/pricing/client.js.map +1 -1
- package/dist/cjs/services/pricing/schemas/healthCheck.d.ts +70 -0
- package/dist/cjs/services/pricing/schemas/healthCheck.d.ts.map +1 -0
- package/dist/cjs/services/pricing/schemas/{health.js → healthCheck.js} +2 -3
- package/dist/cjs/services/pricing/schemas/healthCheck.js.map +1 -0
- package/dist/cjs/services/pricing/schemas/index.d.ts +6 -4
- package/dist/cjs/services/pricing/schemas/index.d.ts.map +1 -1
- package/dist/cjs/services/pricing/schemas/index.js +9 -5
- package/dist/cjs/services/pricing/schemas/index.js.map +1 -1
- package/dist/cjs/services/pricing/schemas/jobPriceHdr.d.ts +391 -0
- package/dist/cjs/services/pricing/schemas/jobPriceHdr.d.ts.map +1 -0
- package/dist/cjs/services/pricing/schemas/jobPriceHdr.js +34 -0
- package/dist/cjs/services/pricing/schemas/jobPriceHdr.js.map +1 -0
- package/dist/cjs/services/pricing/schemas/{job-pricing.d.ts → jobPriceHdrLines.d.ts} +1 -390
- package/dist/cjs/services/pricing/schemas/jobPriceHdrLines.d.ts.map +1 -0
- package/dist/cjs/services/pricing/schemas/{job-pricing.js → jobPriceHdrLines.js} +5 -29
- package/dist/cjs/services/pricing/schemas/jobPriceHdrLines.js.map +1 -0
- package/dist/cjs/services/pricing/schemas/ping.d.ts +49 -0
- package/dist/cjs/services/pricing/schemas/ping.d.ts.map +1 -0
- package/dist/cjs/services/pricing/schemas/ping.js +6 -0
- package/dist/cjs/services/pricing/schemas/ping.js.map +1 -0
- package/dist/cjs/services/pricing/schemas/{pricing.d.ts → priceEngine.d.ts} +1 -1
- package/dist/cjs/services/pricing/schemas/priceEngine.d.ts.map +1 -0
- package/dist/cjs/services/pricing/schemas/{pricing.js → priceEngine.js} +4 -2
- package/dist/cjs/services/pricing/schemas/priceEngine.js.map +1 -0
- package/dist/{types/services/pricing/schemas/tax.d.ts → cjs/services/pricing/schemas/taxEngine.d.ts} +1 -1
- package/dist/cjs/services/pricing/schemas/taxEngine.d.ts.map +1 -0
- package/dist/cjs/services/pricing/schemas/{tax.js → taxEngine.js} +7 -2
- package/dist/cjs/services/pricing/schemas/taxEngine.js.map +1 -0
- package/dist/cjs/services/shipping/client.d.ts +47 -110
- package/dist/cjs/services/shipping/client.d.ts.map +1 -1
- package/dist/cjs/services/shipping/client.js +62 -115
- package/dist/cjs/services/shipping/client.js.map +1 -1
- package/dist/cjs/services/shipping/index.d.ts +2 -2
- package/dist/cjs/services/shipping/index.d.ts.map +1 -1
- package/dist/cjs/services/shipping/index.js +3 -3
- package/dist/cjs/services/shipping/index.js.map +1 -1
- package/dist/cjs/services/shipping/schemas/healthCheck.d.ts +118 -0
- package/dist/cjs/services/shipping/schemas/healthCheck.d.ts.map +1 -0
- package/dist/cjs/services/shipping/schemas/healthCheck.js +27 -0
- package/dist/cjs/services/shipping/schemas/healthCheck.js.map +1 -0
- package/dist/cjs/services/shipping/schemas/index.d.ts +5 -0
- package/dist/cjs/services/shipping/schemas/index.d.ts.map +1 -0
- package/dist/cjs/services/shipping/schemas/index.js +18 -0
- package/dist/cjs/services/shipping/schemas/index.js.map +1 -0
- package/dist/cjs/services/shipping/{schemas.d.ts → schemas/rates.d.ts} +1 -117
- package/dist/cjs/services/shipping/{schemas.d.ts.map → schemas/rates.d.ts.map} +1 -1
- package/dist/cjs/services/shipping/{schemas.js → schemas/rates.js} +3 -27
- package/dist/cjs/services/shipping/schemas/rates.js.map +1 -0
- package/dist/cjs/services/slack/client.d.ts +289 -260
- package/dist/cjs/services/slack/client.d.ts.map +1 -1
- package/dist/cjs/services/slack/client.js +322 -279
- package/dist/cjs/services/slack/client.js.map +1 -1
- package/dist/cjs/services/slack/index.d.ts +2 -2
- package/dist/cjs/services/slack/index.d.ts.map +1 -1
- package/dist/cjs/services/slack/index.js +5 -5
- package/dist/cjs/services/slack/index.js.map +1 -1
- package/dist/cjs/services/slack/schemas/healthCheck.d.ts +138 -0
- package/dist/cjs/services/slack/schemas/healthCheck.d.ts.map +1 -0
- package/dist/cjs/services/slack/schemas/healthCheck.js +29 -0
- package/dist/cjs/services/slack/schemas/healthCheck.js.map +1 -0
- package/dist/cjs/services/slack/schemas/index.d.ts +4 -0
- package/dist/cjs/services/slack/schemas/index.d.ts.map +1 -0
- package/dist/cjs/services/slack/schemas/index.js +19 -0
- package/dist/cjs/services/slack/schemas/index.js.map +1 -0
- package/dist/{types/services/slack/schemas.d.ts → cjs/services/slack/schemas/webHook.d.ts} +3 -298
- package/dist/cjs/services/slack/schemas/webHook.d.ts.map +1 -0
- package/dist/cjs/services/slack/{schemas.js → schemas/webHook.js} +4 -56
- package/dist/cjs/services/slack/schemas/webHook.js.map +1 -0
- package/dist/cjs/services/slack/schemas/webHookRefresh.d.ts +161 -0
- package/dist/cjs/services/slack/schemas/webHookRefresh.d.ts.map +1 -0
- package/dist/cjs/services/slack/schemas/webHookRefresh.js +32 -0
- package/dist/cjs/services/slack/schemas/webHookRefresh.js.map +1 -0
- package/dist/cjs/services/smarty-streets/client.d.ts +238 -214
- package/dist/cjs/services/smarty-streets/client.d.ts.map +1 -1
- package/dist/cjs/services/smarty-streets/client.js +273 -250
- package/dist/cjs/services/smarty-streets/client.js.map +1 -1
- package/dist/cjs/services/smarty-streets/index.d.ts +2 -2
- package/dist/cjs/services/smarty-streets/index.d.ts.map +1 -1
- package/dist/cjs/services/smarty-streets/index.js +9 -9
- package/dist/cjs/services/smarty-streets/index.js.map +1 -1
- package/dist/cjs/services/smarty-streets/schemas/healthCheck.d.ts +140 -0
- package/dist/cjs/services/smarty-streets/schemas/healthCheck.d.ts.map +1 -0
- package/dist/cjs/services/smarty-streets/schemas/healthCheck.js +31 -0
- package/dist/cjs/services/smarty-streets/schemas/healthCheck.js.map +1 -0
- package/dist/cjs/services/smarty-streets/schemas/index.d.ts +7 -0
- package/dist/cjs/services/smarty-streets/schemas/index.d.ts.map +1 -0
- package/dist/cjs/services/smarty-streets/schemas/index.js +25 -0
- package/dist/cjs/services/smarty-streets/schemas/index.js.map +1 -0
- package/dist/cjs/services/smarty-streets/schemas/ping.d.ts +120 -0
- package/dist/cjs/services/smarty-streets/schemas/ping.d.ts.map +1 -0
- package/dist/cjs/services/smarty-streets/schemas/ping.js +29 -0
- package/dist/cjs/services/smarty-streets/schemas/ping.js.map +1 -0
- package/dist/cjs/services/smarty-streets/{schemas.d.ts → schemas/usLookup.d.ts} +11 -262
- package/dist/cjs/services/smarty-streets/schemas/usLookup.d.ts.map +1 -0
- package/dist/cjs/services/smarty-streets/{schemas.js → schemas/usLookup.js} +9 -55
- package/dist/cjs/services/smarty-streets/schemas/usLookup.js.map +1 -0
- package/dist/cjs/services/ups/client.d.ts +65 -95
- package/dist/cjs/services/ups/client.d.ts.map +1 -1
- package/dist/cjs/services/ups/client.js +76 -105
- package/dist/cjs/services/ups/client.js.map +1 -1
- package/dist/cjs/services/ups/schemas/healthCheck.d.ts +138 -0
- package/dist/cjs/services/ups/schemas/healthCheck.d.ts.map +1 -0
- package/dist/cjs/services/ups/schemas/healthCheck.js +29 -0
- package/dist/cjs/services/ups/schemas/healthCheck.js.map +1 -0
- package/dist/cjs/services/ups/schemas/index.d.ts +5 -0
- package/dist/cjs/services/ups/schemas/index.d.ts.map +1 -0
- package/dist/cjs/services/ups/schemas/index.js +18 -0
- package/dist/cjs/services/ups/schemas/index.js.map +1 -0
- package/dist/cjs/services/ups/schemas/ratesShop.d.ts +1751 -0
- package/dist/cjs/services/ups/schemas/ratesShop.d.ts.map +1 -0
- package/dist/cjs/services/ups/schemas/ratesShop.js +175 -0
- package/dist/cjs/services/ups/schemas/ratesShop.js.map +1 -0
- package/dist/cjs/services/ups/schemas.d.ts +4 -1886
- package/dist/cjs/services/ups/schemas.d.ts.map +1 -1
- package/dist/cjs/services/ups/schemas.js +15 -198
- package/dist/cjs/services/ups/schemas.js.map +1 -1
- package/dist/cjs/services/vmi/client.d.ts +605 -550
- package/dist/cjs/services/vmi/client.d.ts.map +1 -1
- package/dist/cjs/services/vmi/client.js +604 -558
- package/dist/cjs/services/vmi/client.js.map +1 -1
- package/dist/esm/client.d.ts +78 -0
- package/dist/esm/client.d.ts.map +1 -1
- package/dist/esm/client.js +182 -0
- package/dist/esm/client.js.map +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/esm/services/agr-info/client.d.ts +579 -545
- package/dist/esm/services/agr-info/client.d.ts.map +1 -1
- package/dist/esm/services/agr-info/client.js +440 -407
- package/dist/esm/services/agr-info/client.js.map +1 -1
- package/dist/esm/services/agr-site/client.d.ts +156 -85
- package/dist/esm/services/agr-site/client.d.ts.map +1 -1
- package/dist/esm/services/agr-site/client.js +179 -106
- package/dist/esm/services/agr-site/client.js.map +1 -1
- package/dist/esm/services/agr-work/client.d.ts +152 -96
- package/dist/esm/services/agr-work/client.d.ts.map +1 -1
- package/dist/esm/services/agr-work/client.js +155 -81
- package/dist/esm/services/agr-work/client.js.map +1 -1
- package/dist/esm/services/avalara/client.d.ts +260 -316
- package/dist/esm/services/avalara/client.d.ts.map +1 -1
- package/dist/esm/services/avalara/client.js +195 -137
- package/dist/esm/services/avalara/client.js.map +1 -1
- package/dist/esm/services/brand-folder/client.d.ts +200 -170
- package/dist/esm/services/brand-folder/client.d.ts.map +1 -1
- package/dist/esm/services/brand-folder/client.js +182 -125
- package/dist/esm/services/brand-folder/client.js.map +1 -1
- package/dist/esm/services/brand-folder/schemas.d.ts +8 -8
- package/dist/esm/services/commerce/client.d.ts +821 -877
- package/dist/esm/services/commerce/client.d.ts.map +1 -1
- package/dist/esm/services/commerce/client.js +844 -488
- package/dist/esm/services/commerce/client.js.map +1 -1
- package/dist/esm/services/customers/client.d.ts +310 -565
- package/dist/esm/services/customers/client.d.ts.map +1 -1
- package/dist/esm/services/customers/client.js +224 -452
- package/dist/esm/services/customers/client.js.map +1 -1
- package/dist/esm/services/gregorovich/client.d.ts +347 -311
- package/dist/esm/services/gregorovich/client.d.ts.map +1 -1
- package/dist/esm/services/gregorovich/client.js +292 -254
- package/dist/esm/services/gregorovich/client.js.map +1 -1
- package/dist/esm/services/gregorovich/index.d.ts +1 -1
- package/dist/esm/services/gregorovich/index.d.ts.map +1 -1
- package/dist/esm/services/gregorovich/schemas/chatGptAsk.d.ts +371 -0
- package/dist/esm/services/gregorovich/schemas/chatGptAsk.d.ts.map +1 -0
- package/dist/esm/services/gregorovich/schemas/chatGptAsk.js +68 -0
- package/dist/esm/services/gregorovich/schemas/chatGptAsk.js.map +1 -0
- package/dist/esm/services/gregorovich/schemas/documents.d.ts +398 -0
- package/dist/esm/services/gregorovich/schemas/documents.d.ts.map +1 -0
- package/dist/esm/services/gregorovich/schemas/documents.js +58 -0
- package/dist/esm/services/gregorovich/schemas/documents.js.map +1 -0
- package/dist/esm/services/gregorovich/schemas/healthCheck.d.ts +53 -0
- package/dist/esm/services/gregorovich/schemas/healthCheck.d.ts.map +1 -0
- package/dist/esm/services/gregorovich/schemas/healthCheck.js +8 -0
- package/dist/esm/services/gregorovich/schemas/healthCheck.js.map +1 -0
- package/dist/esm/services/gregorovich/schemas/index.d.ts +5 -0
- package/dist/esm/services/gregorovich/schemas/index.d.ts.map +1 -0
- package/dist/esm/services/gregorovich/schemas/index.js +9 -0
- package/dist/esm/services/gregorovich/schemas/index.js.map +1 -0
- package/dist/esm/services/gregorovich/schemas/ollamaGenerate.d.ts +433 -0
- package/dist/esm/services/gregorovich/schemas/ollamaGenerate.d.ts.map +1 -0
- package/dist/esm/services/gregorovich/schemas/ollamaGenerate.js +97 -0
- package/dist/esm/services/gregorovich/schemas/ollamaGenerate.js.map +1 -0
- package/dist/esm/services/gregorovich/schemas.d.ts +1 -1217
- package/dist/esm/services/gregorovich/schemas.d.ts.map +1 -1
- package/dist/esm/services/gregorovich/schemas.js +2 -197
- package/dist/esm/services/gregorovich/schemas.js.map +1 -1
- package/dist/esm/services/items/client.d.ts +1865 -1724
- package/dist/esm/services/items/client.d.ts.map +1 -1
- package/dist/esm/services/items/client.js +1738 -1176
- package/dist/esm/services/items/client.js.map +1 -1
- package/dist/esm/services/items/schemas/attributes.d.ts +2 -2
- package/dist/esm/services/items/schemas/brandsItems.d.ts +304 -0
- package/dist/esm/services/items/schemas/brandsItems.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/brandsItems.js +41 -0
- package/dist/esm/services/items/schemas/brandsItems.js.map +1 -0
- package/dist/esm/services/items/schemas/categoriesImages.d.ts +127 -0
- package/dist/esm/services/items/schemas/categoriesImages.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/categoriesImages.js +21 -0
- package/dist/esm/services/items/schemas/categoriesImages.js.map +1 -0
- package/dist/esm/services/items/schemas/index.d.ts +12 -0
- package/dist/esm/services/items/schemas/index.d.ts.map +1 -1
- package/dist/esm/services/items/schemas/index.js +12 -0
- package/dist/esm/services/items/schemas/index.js.map +1 -1
- package/dist/esm/services/items/schemas/internalPdf.d.ts +212 -0
- package/dist/esm/services/items/schemas/internalPdf.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/internalPdf.js +41 -0
- package/dist/esm/services/items/schemas/internalPdf.js.map +1 -0
- package/dist/esm/services/items/schemas/invMastAccessory.d.ts +127 -0
- package/dist/esm/services/items/schemas/invMastAccessory.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/invMastAccessory.js +18 -0
- package/dist/esm/services/items/schemas/invMastAccessory.js.map +1 -0
- package/dist/esm/services/items/schemas/invMastAlternateCode.d.ts +147 -0
- package/dist/esm/services/items/schemas/invMastAlternateCode.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/invMastAlternateCode.js +23 -0
- package/dist/esm/services/items/schemas/invMastAlternateCode.js.map +1 -0
- package/dist/esm/services/items/schemas/invMastAttributes.d.ts +177 -0
- package/dist/esm/services/items/schemas/invMastAttributes.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/invMastAttributes.js +32 -0
- package/dist/esm/services/items/schemas/invMastAttributes.js.map +1 -0
- package/dist/esm/services/items/schemas/invMastAttributesValues.d.ts +333 -0
- package/dist/esm/services/items/schemas/invMastAttributesValues.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/invMastAttributesValues.js +46 -0
- package/dist/esm/services/items/schemas/invMastAttributesValues.js.map +1 -0
- package/dist/esm/services/items/schemas/invMastDoc.d.ts +137 -0
- package/dist/esm/services/items/schemas/invMastDoc.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/invMastDoc.js +19 -0
- package/dist/esm/services/items/schemas/invMastDoc.js.map +1 -0
- package/dist/esm/services/items/schemas/invMastLinks.d.ts +147 -0
- package/dist/esm/services/items/schemas/invMastLinks.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/invMastLinks.js +7 -0
- package/dist/esm/services/items/schemas/invMastLinks.js.map +1 -0
- package/dist/esm/services/items/schemas/invMastSimilar.d.ts +127 -0
- package/dist/esm/services/items/schemas/invMastSimilar.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/invMastSimilar.js +18 -0
- package/dist/esm/services/items/schemas/invMastSimilar.js.map +1 -0
- package/dist/esm/services/items/schemas/invMastSub.d.ts +127 -0
- package/dist/esm/services/items/schemas/invMastSub.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/invMastSub.js +18 -0
- package/dist/esm/services/items/schemas/invMastSub.js.map +1 -0
- package/dist/esm/services/items/schemas/invMastSubParts.d.ts +187 -0
- package/dist/esm/services/items/schemas/invMastSubParts.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/invMastSubParts.js +11 -0
- package/dist/esm/services/items/schemas/invMastSubParts.js.map +1 -0
- package/dist/esm/services/items/schemas/itemFavorites.d.ts +236 -0
- package/dist/esm/services/items/schemas/itemFavorites.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/itemFavorites.js +8 -0
- package/dist/esm/services/items/schemas/itemFavorites.js.map +1 -0
- package/dist/esm/services/items/schemas/locationsBins.d.ts +381 -0
- package/dist/esm/services/items/schemas/locationsBins.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/locationsBins.js +32 -0
- package/dist/esm/services/items/schemas/locationsBins.js.map +1 -0
- package/dist/esm/services/legacy/client.d.ts +522 -280
- package/dist/esm/services/legacy/client.d.ts.map +1 -1
- package/dist/esm/services/legacy/client.js +388 -146
- package/dist/esm/services/legacy/client.js.map +1 -1
- package/dist/esm/services/nexus/client.d.ts +169 -156
- package/dist/esm/services/nexus/client.d.ts.map +1 -1
- package/dist/esm/services/nexus/client.js +158 -145
- package/dist/esm/services/nexus/client.js.map +1 -1
- package/dist/esm/services/open-search/client.d.ts +434 -162
- package/dist/esm/services/open-search/client.d.ts.map +1 -1
- package/dist/esm/services/open-search/client.js +253 -116
- package/dist/esm/services/open-search/client.js.map +1 -1
- package/dist/esm/services/{pricing/schemas/health.d.ts → open-search/schemas/healthCheck.d.ts} +19 -49
- package/dist/esm/services/open-search/schemas/healthCheck.d.ts.map +1 -0
- package/dist/esm/services/open-search/schemas/healthCheck.js +14 -0
- package/dist/esm/services/open-search/schemas/healthCheck.js.map +1 -0
- package/dist/esm/services/open-search/schemas/index.d.ts +5 -0
- package/dist/esm/services/open-search/schemas/index.d.ts.map +1 -1
- package/dist/esm/services/open-search/schemas/index.js +6 -0
- package/dist/esm/services/open-search/schemas/index.js.map +1 -1
- package/dist/esm/services/open-search/schemas/itemSearch.d.ts +394 -0
- package/dist/esm/services/open-search/schemas/itemSearch.d.ts.map +1 -0
- package/dist/esm/services/open-search/schemas/itemSearch.js +71 -0
- package/dist/esm/services/open-search/schemas/itemSearch.js.map +1 -0
- package/dist/esm/services/open-search/schemas/itemSearchAttributes.d.ts +359 -0
- package/dist/esm/services/open-search/schemas/itemSearchAttributes.d.ts.map +1 -0
- package/dist/esm/services/open-search/schemas/itemSearchAttributes.js +44 -0
- package/dist/esm/services/open-search/schemas/itemSearchAttributes.js.map +1 -0
- package/dist/esm/services/open-search/schemas/itemsRefresh.d.ts +512 -0
- package/dist/esm/services/open-search/schemas/itemsRefresh.d.ts.map +1 -0
- package/dist/esm/services/open-search/schemas/itemsRefresh.js +59 -0
- package/dist/esm/services/open-search/schemas/itemsRefresh.js.map +1 -0
- package/dist/esm/services/open-search/schemas/ping.d.ts +57 -0
- package/dist/esm/services/open-search/schemas/ping.d.ts.map +1 -0
- package/dist/esm/services/open-search/schemas/ping.js +11 -0
- package/dist/esm/services/open-search/schemas/ping.js.map +1 -0
- package/dist/esm/services/orders/client.d.ts +496 -646
- package/dist/esm/services/orders/client.d.ts.map +1 -1
- package/dist/esm/services/orders/client.js +311 -476
- package/dist/esm/services/orders/client.js.map +1 -1
- package/dist/esm/services/orders/schemas/invoices.d.ts +10 -10
- package/dist/esm/services/orders/schemas/invoices.js +1 -1
- package/dist/esm/services/p21-apis/client.d.ts +311 -534
- package/dist/esm/services/p21-apis/client.d.ts.map +1 -1
- package/dist/esm/services/p21-apis/client.js +304 -637
- package/dist/esm/services/p21-apis/client.js.map +1 -1
- package/dist/esm/services/p21-apis/schemas.d.ts +9 -78
- package/dist/esm/services/p21-apis/schemas.d.ts.map +1 -1
- package/dist/esm/services/p21-apis/schemas.js +9 -32
- package/dist/esm/services/p21-apis/schemas.js.map +1 -1
- package/dist/esm/services/p21-core/client.d.ts +111 -75
- package/dist/esm/services/p21-core/client.d.ts.map +1 -1
- package/dist/esm/services/p21-core/client.js +146 -106
- package/dist/esm/services/p21-core/client.js.map +1 -1
- package/dist/esm/services/p21-pim/client.d.ts +163 -37
- package/dist/esm/services/p21-pim/client.d.ts.map +1 -1
- package/dist/esm/services/p21-pim/client.js +163 -37
- package/dist/esm/services/p21-pim/client.js.map +1 -1
- package/dist/esm/services/p21-pim/schemas/ai-suggestions.d.ts +6 -6
- package/dist/esm/services/p21-pim/schemas/ai-suggestions.d.ts.map +1 -1
- package/dist/esm/services/p21-pim/schemas/ai-suggestions.js +1 -1
- package/dist/esm/services/p21-pim/schemas/ai-suggestions.js.map +1 -1
- package/dist/esm/services/p21-pim/schemas/inventory.d.ts +32 -32
- package/dist/esm/services/p21-sism/client.d.ts +315 -261
- package/dist/esm/services/p21-sism/client.d.ts.map +1 -1
- package/dist/esm/services/p21-sism/client.js +371 -313
- package/dist/esm/services/p21-sism/client.js.map +1 -1
- package/dist/esm/services/pricing/client.d.ts +289 -59
- package/dist/esm/services/pricing/client.d.ts.map +1 -1
- package/dist/esm/services/pricing/client.js +318 -70
- package/dist/esm/services/pricing/client.js.map +1 -1
- package/dist/esm/services/pricing/schemas/healthCheck.d.ts +70 -0
- package/dist/esm/services/pricing/schemas/healthCheck.d.ts.map +1 -0
- package/dist/esm/services/pricing/schemas/healthCheck.js +3 -0
- package/dist/esm/services/pricing/schemas/healthCheck.js.map +1 -0
- package/dist/esm/services/pricing/schemas/index.d.ts +6 -4
- package/dist/esm/services/pricing/schemas/index.d.ts.map +1 -1
- package/dist/esm/services/pricing/schemas/index.js +9 -5
- package/dist/esm/services/pricing/schemas/index.js.map +1 -1
- package/dist/esm/services/pricing/schemas/jobPriceHdr.d.ts +391 -0
- package/dist/esm/services/pricing/schemas/jobPriceHdr.d.ts.map +1 -0
- package/dist/esm/services/pricing/schemas/jobPriceHdr.js +31 -0
- package/dist/esm/services/pricing/schemas/jobPriceHdr.js.map +1 -0
- package/dist/{types/services/pricing/schemas/job-pricing.d.ts → esm/services/pricing/schemas/jobPriceHdrLines.d.ts} +1 -390
- package/dist/esm/services/pricing/schemas/jobPriceHdrLines.d.ts.map +1 -0
- package/dist/esm/services/pricing/schemas/{job-pricing.js → jobPriceHdrLines.js} +4 -28
- package/dist/esm/services/pricing/schemas/jobPriceHdrLines.js.map +1 -0
- package/dist/esm/services/pricing/schemas/ping.d.ts +49 -0
- package/dist/esm/services/pricing/schemas/ping.d.ts.map +1 -0
- package/dist/esm/services/pricing/schemas/ping.js +3 -0
- package/dist/esm/services/pricing/schemas/ping.js.map +1 -0
- package/dist/{types/services/pricing/schemas/pricing.d.ts → esm/services/pricing/schemas/priceEngine.d.ts} +1 -1
- package/dist/esm/services/pricing/schemas/priceEngine.d.ts.map +1 -0
- package/dist/esm/services/pricing/schemas/{pricing.js → priceEngine.js} +4 -2
- package/dist/esm/services/pricing/schemas/priceEngine.js.map +1 -0
- package/dist/{cjs/services/pricing/schemas/tax.d.ts → esm/services/pricing/schemas/taxEngine.d.ts} +1 -1
- package/dist/esm/services/pricing/schemas/taxEngine.d.ts.map +1 -0
- package/dist/esm/services/pricing/schemas/{tax.js → taxEngine.js} +7 -2
- package/dist/esm/services/pricing/schemas/taxEngine.js.map +1 -0
- package/dist/esm/services/shipping/client.d.ts +47 -110
- package/dist/esm/services/shipping/client.d.ts.map +1 -1
- package/dist/esm/services/shipping/client.js +62 -115
- package/dist/esm/services/shipping/client.js.map +1 -1
- package/dist/esm/services/shipping/index.d.ts +2 -2
- package/dist/esm/services/shipping/index.d.ts.map +1 -1
- package/dist/esm/services/shipping/index.js +1 -1
- package/dist/esm/services/shipping/index.js.map +1 -1
- package/dist/esm/services/shipping/schemas/healthCheck.d.ts +118 -0
- package/dist/esm/services/shipping/schemas/healthCheck.d.ts.map +1 -0
- package/dist/esm/services/shipping/schemas/healthCheck.js +24 -0
- package/dist/esm/services/shipping/schemas/healthCheck.js.map +1 -0
- package/dist/esm/services/shipping/schemas/index.d.ts +5 -0
- package/dist/esm/services/shipping/schemas/index.d.ts.map +1 -0
- package/dist/esm/services/shipping/schemas/index.js +5 -0
- package/dist/esm/services/shipping/schemas/index.js.map +1 -0
- package/dist/esm/services/shipping/{schemas.d.ts → schemas/rates.d.ts} +1 -117
- package/dist/{types/services/shipping/schemas.d.ts.map → esm/services/shipping/schemas/rates.d.ts.map} +1 -1
- package/dist/esm/services/shipping/{schemas.js → schemas/rates.js} +2 -26
- package/dist/esm/services/shipping/schemas/rates.js.map +1 -0
- package/dist/esm/services/slack/client.d.ts +289 -260
- package/dist/esm/services/slack/client.d.ts.map +1 -1
- package/dist/esm/services/slack/client.js +323 -280
- package/dist/esm/services/slack/client.js.map +1 -1
- package/dist/esm/services/slack/index.d.ts +2 -2
- package/dist/esm/services/slack/index.d.ts.map +1 -1
- package/dist/esm/services/slack/index.js +1 -1
- package/dist/esm/services/slack/index.js.map +1 -1
- package/dist/esm/services/slack/schemas/healthCheck.d.ts +138 -0
- package/dist/esm/services/slack/schemas/healthCheck.d.ts.map +1 -0
- package/dist/esm/services/slack/schemas/healthCheck.js +26 -0
- package/dist/esm/services/slack/schemas/healthCheck.js.map +1 -0
- package/dist/esm/services/slack/schemas/index.d.ts +4 -0
- package/dist/esm/services/slack/schemas/index.d.ts.map +1 -0
- package/dist/esm/services/slack/schemas/index.js +7 -0
- package/dist/esm/services/slack/schemas/index.js.map +1 -0
- package/dist/esm/services/slack/{schemas.d.ts → schemas/webHook.d.ts} +3 -298
- package/dist/esm/services/slack/schemas/webHook.d.ts.map +1 -0
- package/dist/esm/services/slack/{schemas.js → schemas/webHook.js} +3 -55
- package/dist/esm/services/slack/schemas/webHook.js.map +1 -0
- package/dist/esm/services/slack/schemas/webHookRefresh.d.ts +161 -0
- package/dist/esm/services/slack/schemas/webHookRefresh.d.ts.map +1 -0
- package/dist/esm/services/slack/schemas/webHookRefresh.js +29 -0
- package/dist/esm/services/slack/schemas/webHookRefresh.js.map +1 -0
- package/dist/esm/services/smarty-streets/client.d.ts +238 -214
- package/dist/esm/services/smarty-streets/client.d.ts.map +1 -1
- package/dist/esm/services/smarty-streets/client.js +274 -251
- package/dist/esm/services/smarty-streets/client.js.map +1 -1
- package/dist/esm/services/smarty-streets/index.d.ts +2 -2
- package/dist/esm/services/smarty-streets/index.d.ts.map +1 -1
- package/dist/esm/services/smarty-streets/index.js +2 -2
- package/dist/esm/services/smarty-streets/index.js.map +1 -1
- package/dist/esm/services/smarty-streets/schemas/healthCheck.d.ts +140 -0
- package/dist/esm/services/smarty-streets/schemas/healthCheck.d.ts.map +1 -0
- package/dist/esm/services/smarty-streets/schemas/healthCheck.js +28 -0
- package/dist/esm/services/smarty-streets/schemas/healthCheck.js.map +1 -0
- package/dist/esm/services/smarty-streets/schemas/index.d.ts +7 -0
- package/dist/esm/services/smarty-streets/schemas/index.d.ts.map +1 -0
- package/dist/esm/services/smarty-streets/schemas/index.js +8 -0
- package/dist/esm/services/smarty-streets/schemas/index.js.map +1 -0
- package/dist/esm/services/smarty-streets/schemas/ping.d.ts +120 -0
- package/dist/esm/services/smarty-streets/schemas/ping.d.ts.map +1 -0
- package/dist/esm/services/smarty-streets/schemas/ping.js +26 -0
- package/dist/esm/services/smarty-streets/schemas/ping.js.map +1 -0
- package/dist/esm/services/smarty-streets/{schemas.d.ts → schemas/usLookup.d.ts} +11 -262
- package/dist/esm/services/smarty-streets/schemas/usLookup.d.ts.map +1 -0
- package/dist/esm/services/smarty-streets/{schemas.js → schemas/usLookup.js} +8 -54
- package/dist/esm/services/smarty-streets/schemas/usLookup.js.map +1 -0
- package/dist/esm/services/ups/client.d.ts +65 -95
- package/dist/esm/services/ups/client.d.ts.map +1 -1
- package/dist/esm/services/ups/client.js +76 -105
- package/dist/esm/services/ups/client.js.map +1 -1
- package/dist/esm/services/ups/schemas/healthCheck.d.ts +138 -0
- package/dist/esm/services/ups/schemas/healthCheck.d.ts.map +1 -0
- package/dist/esm/services/ups/schemas/healthCheck.js +26 -0
- package/dist/esm/services/ups/schemas/healthCheck.js.map +1 -0
- package/dist/esm/services/ups/schemas/index.d.ts +5 -0
- package/dist/esm/services/ups/schemas/index.d.ts.map +1 -0
- package/dist/esm/services/ups/schemas/index.js +5 -0
- package/dist/esm/services/ups/schemas/index.js.map +1 -0
- package/dist/esm/services/ups/schemas/ratesShop.d.ts +1751 -0
- package/dist/esm/services/ups/schemas/ratesShop.d.ts.map +1 -0
- package/dist/esm/services/ups/schemas/ratesShop.js +172 -0
- package/dist/esm/services/ups/schemas/ratesShop.js.map +1 -0
- package/dist/esm/services/ups/schemas.d.ts +4 -1886
- package/dist/esm/services/ups/schemas.d.ts.map +1 -1
- package/dist/esm/services/ups/schemas.js +4 -197
- package/dist/esm/services/ups/schemas.js.map +1 -1
- package/dist/esm/services/vmi/client.d.ts +605 -550
- package/dist/esm/services/vmi/client.d.ts.map +1 -1
- package/dist/esm/services/vmi/client.js +604 -558
- package/dist/esm/services/vmi/client.js.map +1 -1
- package/dist/types/client.d.ts +78 -0
- package/dist/types/client.d.ts.map +1 -1
- package/dist/types/index.d.ts +1 -1
- package/dist/types/services/agr-info/client.d.ts +579 -545
- package/dist/types/services/agr-info/client.d.ts.map +1 -1
- package/dist/types/services/agr-site/client.d.ts +156 -85
- package/dist/types/services/agr-site/client.d.ts.map +1 -1
- package/dist/types/services/agr-work/client.d.ts +152 -96
- package/dist/types/services/agr-work/client.d.ts.map +1 -1
- package/dist/types/services/avalara/client.d.ts +260 -316
- package/dist/types/services/avalara/client.d.ts.map +1 -1
- package/dist/types/services/brand-folder/client.d.ts +200 -170
- package/dist/types/services/brand-folder/client.d.ts.map +1 -1
- package/dist/types/services/brand-folder/schemas.d.ts +8 -8
- package/dist/types/services/commerce/client.d.ts +821 -877
- package/dist/types/services/commerce/client.d.ts.map +1 -1
- package/dist/types/services/customers/client.d.ts +310 -565
- package/dist/types/services/customers/client.d.ts.map +1 -1
- package/dist/types/services/gregorovich/client.d.ts +347 -311
- package/dist/types/services/gregorovich/client.d.ts.map +1 -1
- package/dist/types/services/gregorovich/index.d.ts +1 -1
- package/dist/types/services/gregorovich/index.d.ts.map +1 -1
- package/dist/types/services/gregorovich/schemas/chatGptAsk.d.ts +371 -0
- package/dist/types/services/gregorovich/schemas/chatGptAsk.d.ts.map +1 -0
- package/dist/types/services/gregorovich/schemas/documents.d.ts +398 -0
- package/dist/types/services/gregorovich/schemas/documents.d.ts.map +1 -0
- package/dist/types/services/gregorovich/schemas/healthCheck.d.ts +53 -0
- package/dist/types/services/gregorovich/schemas/healthCheck.d.ts.map +1 -0
- package/dist/types/services/gregorovich/schemas/index.d.ts +5 -0
- package/dist/types/services/gregorovich/schemas/index.d.ts.map +1 -0
- package/dist/types/services/gregorovich/schemas/ollamaGenerate.d.ts +433 -0
- package/dist/types/services/gregorovich/schemas/ollamaGenerate.d.ts.map +1 -0
- package/dist/types/services/gregorovich/schemas.d.ts +1 -1217
- package/dist/types/services/gregorovich/schemas.d.ts.map +1 -1
- package/dist/types/services/items/client.d.ts +1865 -1724
- package/dist/types/services/items/client.d.ts.map +1 -1
- package/dist/types/services/items/schemas/attributes.d.ts +2 -2
- package/dist/types/services/items/schemas/brandsItems.d.ts +304 -0
- package/dist/types/services/items/schemas/brandsItems.d.ts.map +1 -0
- package/dist/types/services/items/schemas/categoriesImages.d.ts +127 -0
- package/dist/types/services/items/schemas/categoriesImages.d.ts.map +1 -0
- package/dist/types/services/items/schemas/index.d.ts +12 -0
- package/dist/types/services/items/schemas/index.d.ts.map +1 -1
- package/dist/types/services/items/schemas/internalPdf.d.ts +212 -0
- package/dist/types/services/items/schemas/internalPdf.d.ts.map +1 -0
- package/dist/types/services/items/schemas/invMastAccessory.d.ts +127 -0
- package/dist/types/services/items/schemas/invMastAccessory.d.ts.map +1 -0
- package/dist/types/services/items/schemas/invMastAlternateCode.d.ts +147 -0
- package/dist/types/services/items/schemas/invMastAlternateCode.d.ts.map +1 -0
- package/dist/types/services/items/schemas/invMastAttributes.d.ts +177 -0
- package/dist/types/services/items/schemas/invMastAttributes.d.ts.map +1 -0
- package/dist/types/services/items/schemas/invMastAttributesValues.d.ts +333 -0
- package/dist/types/services/items/schemas/invMastAttributesValues.d.ts.map +1 -0
- package/dist/types/services/items/schemas/invMastDoc.d.ts +137 -0
- package/dist/types/services/items/schemas/invMastDoc.d.ts.map +1 -0
- package/dist/types/services/items/schemas/invMastLinks.d.ts +147 -0
- package/dist/types/services/items/schemas/invMastLinks.d.ts.map +1 -0
- package/dist/types/services/items/schemas/invMastSimilar.d.ts +127 -0
- package/dist/types/services/items/schemas/invMastSimilar.d.ts.map +1 -0
- package/dist/types/services/items/schemas/invMastSub.d.ts +127 -0
- package/dist/types/services/items/schemas/invMastSub.d.ts.map +1 -0
- package/dist/types/services/items/schemas/invMastSubParts.d.ts +187 -0
- package/dist/types/services/items/schemas/invMastSubParts.d.ts.map +1 -0
- package/dist/types/services/items/schemas/itemFavorites.d.ts +236 -0
- package/dist/types/services/items/schemas/itemFavorites.d.ts.map +1 -0
- package/dist/types/services/items/schemas/locationsBins.d.ts +381 -0
- package/dist/types/services/items/schemas/locationsBins.d.ts.map +1 -0
- package/dist/types/services/legacy/client.d.ts +522 -280
- package/dist/types/services/legacy/client.d.ts.map +1 -1
- package/dist/types/services/nexus/client.d.ts +169 -156
- package/dist/types/services/nexus/client.d.ts.map +1 -1
- package/dist/types/services/open-search/client.d.ts +434 -162
- package/dist/types/services/open-search/client.d.ts.map +1 -1
- package/dist/types/services/{pricing/schemas/health.d.ts → open-search/schemas/healthCheck.d.ts} +19 -49
- package/dist/types/services/open-search/schemas/healthCheck.d.ts.map +1 -0
- package/dist/types/services/open-search/schemas/index.d.ts +5 -0
- package/dist/types/services/open-search/schemas/index.d.ts.map +1 -1
- package/dist/types/services/open-search/schemas/itemSearch.d.ts +394 -0
- package/dist/types/services/open-search/schemas/itemSearch.d.ts.map +1 -0
- package/dist/types/services/open-search/schemas/itemSearchAttributes.d.ts +359 -0
- package/dist/types/services/open-search/schemas/itemSearchAttributes.d.ts.map +1 -0
- package/dist/types/services/open-search/schemas/itemsRefresh.d.ts +512 -0
- package/dist/types/services/open-search/schemas/itemsRefresh.d.ts.map +1 -0
- package/dist/types/services/open-search/schemas/ping.d.ts +57 -0
- package/dist/types/services/open-search/schemas/ping.d.ts.map +1 -0
- package/dist/types/services/orders/client.d.ts +496 -646
- package/dist/types/services/orders/client.d.ts.map +1 -1
- package/dist/types/services/orders/schemas/invoices.d.ts +10 -10
- package/dist/types/services/p21-apis/client.d.ts +311 -534
- package/dist/types/services/p21-apis/client.d.ts.map +1 -1
- package/dist/types/services/p21-apis/schemas.d.ts +9 -78
- package/dist/types/services/p21-apis/schemas.d.ts.map +1 -1
- package/dist/types/services/p21-core/client.d.ts +111 -75
- package/dist/types/services/p21-core/client.d.ts.map +1 -1
- package/dist/types/services/p21-pim/client.d.ts +163 -37
- package/dist/types/services/p21-pim/client.d.ts.map +1 -1
- package/dist/types/services/p21-pim/schemas/ai-suggestions.d.ts +6 -6
- package/dist/types/services/p21-pim/schemas/ai-suggestions.d.ts.map +1 -1
- package/dist/types/services/p21-pim/schemas/inventory.d.ts +32 -32
- package/dist/types/services/p21-sism/client.d.ts +315 -261
- package/dist/types/services/p21-sism/client.d.ts.map +1 -1
- package/dist/types/services/pricing/client.d.ts +289 -59
- package/dist/types/services/pricing/client.d.ts.map +1 -1
- package/dist/types/services/pricing/schemas/healthCheck.d.ts +70 -0
- package/dist/types/services/pricing/schemas/healthCheck.d.ts.map +1 -0
- package/dist/types/services/pricing/schemas/index.d.ts +6 -4
- package/dist/types/services/pricing/schemas/index.d.ts.map +1 -1
- package/dist/types/services/pricing/schemas/jobPriceHdr.d.ts +391 -0
- package/dist/types/services/pricing/schemas/jobPriceHdr.d.ts.map +1 -0
- package/dist/{esm/services/pricing/schemas/job-pricing.d.ts → types/services/pricing/schemas/jobPriceHdrLines.d.ts} +1 -390
- package/dist/types/services/pricing/schemas/jobPriceHdrLines.d.ts.map +1 -0
- package/dist/types/services/pricing/schemas/ping.d.ts +49 -0
- package/dist/types/services/pricing/schemas/ping.d.ts.map +1 -0
- package/dist/{esm/services/pricing/schemas/pricing.d.ts → types/services/pricing/schemas/priceEngine.d.ts} +1 -1
- package/dist/types/services/pricing/schemas/priceEngine.d.ts.map +1 -0
- package/dist/{esm/services/pricing/schemas/tax.d.ts → types/services/pricing/schemas/taxEngine.d.ts} +1 -1
- package/dist/types/services/pricing/schemas/taxEngine.d.ts.map +1 -0
- package/dist/types/services/shipping/client.d.ts +47 -110
- package/dist/types/services/shipping/client.d.ts.map +1 -1
- package/dist/types/services/shipping/index.d.ts +2 -2
- package/dist/types/services/shipping/index.d.ts.map +1 -1
- package/dist/types/services/shipping/schemas/healthCheck.d.ts +118 -0
- package/dist/types/services/shipping/schemas/healthCheck.d.ts.map +1 -0
- package/dist/types/services/shipping/schemas/index.d.ts +5 -0
- package/dist/types/services/shipping/schemas/index.d.ts.map +1 -0
- package/dist/types/services/shipping/{schemas.d.ts → schemas/rates.d.ts} +1 -117
- package/dist/{esm/services/shipping/schemas.d.ts.map → types/services/shipping/schemas/rates.d.ts.map} +1 -1
- package/dist/types/services/slack/client.d.ts +289 -260
- package/dist/types/services/slack/client.d.ts.map +1 -1
- package/dist/types/services/slack/index.d.ts +2 -2
- package/dist/types/services/slack/index.d.ts.map +1 -1
- package/dist/types/services/slack/schemas/healthCheck.d.ts +138 -0
- package/dist/types/services/slack/schemas/healthCheck.d.ts.map +1 -0
- package/dist/types/services/slack/schemas/index.d.ts +4 -0
- package/dist/types/services/slack/schemas/index.d.ts.map +1 -0
- package/dist/{cjs/services/slack/schemas.d.ts → types/services/slack/schemas/webHook.d.ts} +3 -298
- package/dist/types/services/slack/schemas/webHook.d.ts.map +1 -0
- package/dist/types/services/slack/schemas/webHookRefresh.d.ts +161 -0
- package/dist/types/services/slack/schemas/webHookRefresh.d.ts.map +1 -0
- package/dist/types/services/smarty-streets/client.d.ts +238 -214
- package/dist/types/services/smarty-streets/client.d.ts.map +1 -1
- package/dist/types/services/smarty-streets/index.d.ts +2 -2
- package/dist/types/services/smarty-streets/index.d.ts.map +1 -1
- package/dist/types/services/smarty-streets/schemas/healthCheck.d.ts +140 -0
- package/dist/types/services/smarty-streets/schemas/healthCheck.d.ts.map +1 -0
- package/dist/types/services/smarty-streets/schemas/index.d.ts +7 -0
- package/dist/types/services/smarty-streets/schemas/index.d.ts.map +1 -0
- package/dist/types/services/smarty-streets/schemas/ping.d.ts +120 -0
- package/dist/types/services/smarty-streets/schemas/ping.d.ts.map +1 -0
- package/dist/types/services/smarty-streets/{schemas.d.ts → schemas/usLookup.d.ts} +11 -262
- package/dist/types/services/smarty-streets/schemas/usLookup.d.ts.map +1 -0
- package/dist/types/services/ups/client.d.ts +65 -95
- package/dist/types/services/ups/client.d.ts.map +1 -1
- package/dist/types/services/ups/schemas/healthCheck.d.ts +138 -0
- package/dist/types/services/ups/schemas/healthCheck.d.ts.map +1 -0
- package/dist/types/services/ups/schemas/index.d.ts +5 -0
- package/dist/types/services/ups/schemas/index.d.ts.map +1 -0
- package/dist/types/services/ups/schemas/ratesShop.d.ts +1751 -0
- package/dist/types/services/ups/schemas/ratesShop.d.ts.map +1 -0
- package/dist/types/services/ups/schemas.d.ts +4 -1886
- package/dist/types/services/ups/schemas.d.ts.map +1 -1
- package/dist/types/services/vmi/client.d.ts +605 -550
- package/dist/types/services/vmi/client.d.ts.map +1 -1
- package/package.json +3 -1
- package/dist/cjs/services/pricing/schemas/health.d.ts.map +0 -1
- package/dist/cjs/services/pricing/schemas/health.js.map +0 -1
- package/dist/cjs/services/pricing/schemas/job-pricing.d.ts.map +0 -1
- package/dist/cjs/services/pricing/schemas/job-pricing.js.map +0 -1
- package/dist/cjs/services/pricing/schemas/pricing.d.ts.map +0 -1
- package/dist/cjs/services/pricing/schemas/pricing.js.map +0 -1
- package/dist/cjs/services/pricing/schemas/tax.d.ts.map +0 -1
- package/dist/cjs/services/pricing/schemas/tax.js.map +0 -1
- package/dist/cjs/services/shipping/schemas.js.map +0 -1
- package/dist/cjs/services/slack/schemas.d.ts.map +0 -1
- package/dist/cjs/services/slack/schemas.js.map +0 -1
- package/dist/cjs/services/smarty-streets/schemas.d.ts.map +0 -1
- package/dist/cjs/services/smarty-streets/schemas.js.map +0 -1
- package/dist/esm/services/pricing/schemas/health.d.ts.map +0 -1
- package/dist/esm/services/pricing/schemas/health.js +0 -4
- package/dist/esm/services/pricing/schemas/health.js.map +0 -1
- package/dist/esm/services/pricing/schemas/job-pricing.d.ts.map +0 -1
- package/dist/esm/services/pricing/schemas/job-pricing.js.map +0 -1
- package/dist/esm/services/pricing/schemas/pricing.d.ts.map +0 -1
- package/dist/esm/services/pricing/schemas/pricing.js.map +0 -1
- package/dist/esm/services/pricing/schemas/tax.d.ts.map +0 -1
- package/dist/esm/services/pricing/schemas/tax.js.map +0 -1
- package/dist/esm/services/shipping/schemas.js.map +0 -1
- package/dist/esm/services/slack/schemas.d.ts.map +0 -1
- package/dist/esm/services/slack/schemas.js.map +0 -1
- package/dist/esm/services/smarty-streets/schemas.d.ts.map +0 -1
- package/dist/esm/services/smarty-streets/schemas.js.map +0 -1
- package/dist/types/services/pricing/schemas/health.d.ts.map +0 -1
- package/dist/types/services/pricing/schemas/job-pricing.d.ts.map +0 -1
- package/dist/types/services/pricing/schemas/pricing.d.ts.map +0 -1
- package/dist/types/services/pricing/schemas/tax.d.ts.map +0 -1
- package/dist/types/services/slack/schemas.d.ts.map +0 -1
- package/dist/types/services/smarty-streets/schemas.d.ts.map +0 -1
|
@@ -4,8 +4,8 @@ exports.OrdersClient = void 0;
|
|
|
4
4
|
const base_client_1 = require("../../core/base-client");
|
|
5
5
|
const schemas_1 = require("./schemas");
|
|
6
6
|
/**
|
|
7
|
-
* Orders Service Client
|
|
8
|
-
* @description Comprehensive order management functionality for the Augur platform covering the complete order lifecycle from creation through fulfillment, including order processing, invoicing, purchase orders, and sales representative management.
|
|
7
|
+
* Orders Service Client - OpenAPI Path Mirroring Implementation
|
|
8
|
+
* @description Comprehensive order management functionality for the Augur platform covering the complete order lifecycle from creation through fulfillment, including order processing, invoicing, purchase orders, and sales representative management. Follows strict OpenAPI path mirroring pattern.
|
|
9
9
|
*
|
|
10
10
|
* @fullPath api.orders
|
|
11
11
|
* @service orders
|
|
@@ -23,20 +23,19 @@ const schemas_1 = require("./schemas");
|
|
|
23
23
|
* ```typescript
|
|
24
24
|
* const api = new AugurAPI({ bearerToken: 'token', siteId: 'site' });
|
|
25
25
|
*
|
|
26
|
-
* //
|
|
27
|
-
*
|
|
26
|
+
* // OpenAPI Path Mirroring Examples:
|
|
27
|
+
* // /oe-hdr/lookup → api.orders.oeHdr.lookup.list()
|
|
28
|
+
* const ordersResponse = await api.orders.oeHdr.lookup.list({ limit: 10, q: '12345' });
|
|
28
29
|
* console.log(`Found ${ordersResponse.total} orders`);
|
|
29
30
|
*
|
|
30
|
-
* //
|
|
31
|
-
* const
|
|
32
|
-
* orders.forEach(order => console.log(order.orderNo, order.customerName));
|
|
31
|
+
* // /oe-hdr/{orderNo}/doc → api.orders.oeHdr.doc.get(orderNo)
|
|
32
|
+
* const orderDoc = await api.orders.oeHdr.doc.get(12345678, { postalCode: '12345' });
|
|
33
33
|
*
|
|
34
|
-
* //
|
|
35
|
-
* const
|
|
34
|
+
* // /oe-hdr-salesrep/{salesrepId}/oe-hdr → api.orders.oeHdrSalesrep.oeHdr.list(salesrepId)
|
|
35
|
+
* const repOrders = await api.orders.oeHdrSalesrep.oeHdr.list(12345);
|
|
36
36
|
*
|
|
37
|
-
* //
|
|
38
|
-
* const
|
|
39
|
-
* const poDoc = await api.orders.poHdr.getDocument(pos[0].poNo);
|
|
37
|
+
* // /po-hdr/scan → api.orders.poHdr.scan.create(params)
|
|
38
|
+
* const similarPOs = await api.orders.poHdr.scan.create({ vendorId: 'VENDOR001' });
|
|
40
39
|
* ```
|
|
41
40
|
*/
|
|
42
41
|
class OrdersClient extends base_client_1.BaseServiceClient {
|
|
@@ -48,257 +47,255 @@ class OrdersClient extends base_client_1.BaseServiceClient {
|
|
|
48
47
|
constructor(http, baseUrl = 'https://orders.augur-api.com') {
|
|
49
48
|
super('orders', http, baseUrl);
|
|
50
49
|
/**
|
|
51
|
-
*
|
|
52
|
-
* @description
|
|
50
|
+
* Health check endpoint
|
|
51
|
+
* @description Service health and status monitoring endpoint for system diagnostics and uptime verification
|
|
52
|
+
*
|
|
53
|
+
* @fullPath api.orders.healthCheck.get
|
|
54
|
+
* @service orders
|
|
55
|
+
* @domain system-monitoring
|
|
56
|
+
* @dataMethod getData - returns only the health check data without metadata
|
|
57
|
+
* @discoverable true
|
|
58
|
+
* @searchTerms ["health check", "service status", "orders health", "system status"]
|
|
59
|
+
* @relatedEndpoints ["api.joomla.healthCheck.get", "api.nexus.healthCheck.get", "api.items.healthCheck.get"]
|
|
60
|
+
* @commonPatterns ["Check service health", "System monitoring", "Service status"]
|
|
61
|
+
* @workflow ["system-monitoring", "health-diagnostics"]
|
|
62
|
+
* @functionalArea "system-operations"
|
|
63
|
+
* @performance "Lightweight endpoint for monitoring - minimal response time"
|
|
53
64
|
*/
|
|
54
|
-
this.
|
|
55
|
-
|
|
56
|
-
* Search and list order headers with flexible filtering options
|
|
57
|
-
* @description Returns paginated order headers with comprehensive filtering by customer, date, status, sales rep, and search terms. Supports edge caching for improved performance.
|
|
58
|
-
*
|
|
59
|
-
* @fullPath api.orders.oeHdr.lookup
|
|
60
|
-
* @service orders
|
|
61
|
-
* @domain order-management
|
|
62
|
-
* @dataMethod lookupData - returns only the order headers array without metadata
|
|
63
|
-
* @discoverable true
|
|
64
|
-
* @searchTerms ["order lookup", "search orders", "order list", "find orders", "order search", "sales orders"]
|
|
65
|
-
* @relatedEndpoints ["api.orders.oeHdr.getDocument", "api.customers.customer.list", "api.orders.oeHdrSalesrep.getOrders"]
|
|
66
|
-
* @commonPatterns ["Search orders by customer", "Find orders by order number", "List incomplete orders", "Filter by date range"]
|
|
67
|
-
* @workflow ["order-discovery", "order-status-tracking", "customer-order-history"]
|
|
68
|
-
* @prerequisites ["Valid authentication token", "Order access permissions"]
|
|
69
|
-
* @nextSteps ["api.orders.oeHdr.getDocument for full details", "api.customers.customer.get for customer info"]
|
|
70
|
-
* @businessRules ["Returns only orders accessible to current user/sales rep", "Completed orders may have restricted access", "Search supports partial matches"]
|
|
71
|
-
* @functionalArea "order-and-fulfillment-management"
|
|
72
|
-
* @caching "Supports edgeCache parameter (1-8 hours) for frequently accessed order lists"
|
|
73
|
-
* @performance "Use pagination for large result sets. Filter by specific criteria to improve performance."
|
|
74
|
-
*
|
|
75
|
-
* @param params Optional filtering and pagination parameters
|
|
76
|
-
* @param params.q Search query for order number, customer name, or PO number
|
|
77
|
-
* @param params.completed Filter by completion status ('Y' for completed, 'N' for incomplete)
|
|
78
|
-
* @param params.salesrepId Filter orders by specific sales representative ID
|
|
79
|
-
* @param params.class1Id Filter by customer class/category
|
|
80
|
-
* @param params.dateOrderCompleted Filter by order completion date (YYYY-MM-DD format)
|
|
81
|
-
* @param params.limit Maximum number of orders to return (default: 20, max: 100)
|
|
82
|
-
* @param params.offset Number of items to skip for pagination
|
|
83
|
-
* @param params.edgeCache Cache duration in hours (1-8) for improved performance
|
|
84
|
-
* @returns Promise<BaseResponse<OrderHeader[]>> Complete response with order headers and metadata
|
|
85
|
-
*
|
|
86
|
-
* @example
|
|
87
|
-
* ```typescript
|
|
88
|
-
* // Search orders with full response metadata
|
|
89
|
-
* const response = await api.orders.oeHdr.lookup({
|
|
90
|
-
* q: '12345',
|
|
91
|
-
* completed: 'N',
|
|
92
|
-
* limit: 10
|
|
93
|
-
* });
|
|
94
|
-
* console.log(`Found ${response.total} orders`);
|
|
95
|
-
*
|
|
96
|
-
* // Get just the order data
|
|
97
|
-
* const orders = await api.orders.oeHdr.lookupData({
|
|
98
|
-
* salesrepId: 'REP001',
|
|
99
|
-
* limit: 50
|
|
100
|
-
* });
|
|
101
|
-
*
|
|
102
|
-
* // Filter by completion status with caching
|
|
103
|
-
* const incompleteOrders = await api.orders.oeHdr.lookup({
|
|
104
|
-
* completed: 'N',
|
|
105
|
-
* edgeCache: 2, // Cache for 2 hours
|
|
106
|
-
* orderBy: 'orderDate DESC'
|
|
107
|
-
* });
|
|
108
|
-
* ```
|
|
109
|
-
*/
|
|
110
|
-
lookup: this.createListMethod('/oe-hdr/lookup', schemas_1.OrderLookupParamsSchema, schemas_1.OrderHeaderResponseSchema),
|
|
111
|
-
/**
|
|
112
|
-
* Get only order headers data without response metadata
|
|
113
|
-
* @description Data-only version of lookup() method - returns the order headers array directly
|
|
114
|
-
*
|
|
115
|
-
* @param params Same parameters as lookup() method
|
|
116
|
-
* @returns Promise<OrderHeader[]> Direct array of order headers
|
|
117
|
-
*/
|
|
118
|
-
lookupData: async (params) => {
|
|
119
|
-
const response = await this.oeHdr.lookup(params);
|
|
120
|
-
return response.data;
|
|
121
|
-
},
|
|
122
|
-
/**
|
|
123
|
-
* Retrieve complete order document with all related information
|
|
124
|
-
* @description Returns comprehensive order details including customer info, shipping address, line items, and totals. Includes optional postal code validation for security.
|
|
125
|
-
*
|
|
126
|
-
* @fullPath api.orders.oeHdr.getDocument
|
|
127
|
-
* @service orders
|
|
128
|
-
* @domain order-management
|
|
129
|
-
* @dataMethod getDocumentData - returns only the order document without metadata
|
|
130
|
-
* @discoverable true
|
|
131
|
-
* @searchTerms ["order document", "order details", "full order", "order with lines", "complete order"]
|
|
132
|
-
* @relatedEndpoints ["api.orders.oeHdr.lookup", "api.customers.customer.get", "api.items.products.get"]
|
|
133
|
-
* @commonPatterns ["Get order details", "View complete order", "Order with line items", "Full order document"]
|
|
134
|
-
* @workflow ["order-review", "order-fulfillment", "customer-service"]
|
|
135
|
-
* @prerequisites ["Valid order number", "Order access permissions", "Optional postal code for validation"]
|
|
136
|
-
* @nextSteps ["Process order fulfillment", "Update order status", "Generate invoice"]
|
|
137
|
-
* @businessRules ["Postal code validation optional but recommended for security", "Access restricted by sales rep permissions", "Includes all order line items and totals"]
|
|
138
|
-
* @functionalArea "order-and-fulfillment-management"
|
|
139
|
-
* @performance "Single document retrieval - no pagination needed. Consider caching for frequently accessed orders."
|
|
140
|
-
*
|
|
141
|
-
* @param orderNo Order number to retrieve
|
|
142
|
-
* @param params Optional parameters including postal code validation
|
|
143
|
-
* @param params.postalCode Optional postal code for additional security validation
|
|
144
|
-
* @returns Promise<BaseResponse<OrderDocument>> Complete response with full order document
|
|
145
|
-
*
|
|
146
|
-
* @example
|
|
147
|
-
* ```typescript
|
|
148
|
-
* // Get order document with validation
|
|
149
|
-
* const response = await api.orders.oeHdr.getDocument(12345678, {
|
|
150
|
-
* postalCode: '12345'
|
|
151
|
-
* });
|
|
152
|
-
* console.log(`Order ${response.data.orderNo} for ${response.data.customerName}`);
|
|
153
|
-
*
|
|
154
|
-
* // Get just the document data
|
|
155
|
-
* const order = await api.orders.oeHdr.getDocumentData(12345678);
|
|
156
|
-
* order.lines.forEach(line => {
|
|
157
|
-
* console.log(`${line.itemId}: ${line.qtyOrdered} @ $${line.unitPrice}`);
|
|
158
|
-
* });
|
|
159
|
-
*
|
|
160
|
-
* // Without postal code validation
|
|
161
|
-
* const orderDoc = await api.orders.oeHdr.getDocument(12345678);
|
|
162
|
-
* ```
|
|
163
|
-
*/
|
|
164
|
-
getDocument: async (orderNo, params) => {
|
|
165
|
-
return this.executeRequest({
|
|
166
|
-
method: 'GET',
|
|
167
|
-
path: `/oe-hdr/${orderNo}/doc`,
|
|
168
|
-
paramsSchema: schemas_1.OrderDocumentParamsSchema,
|
|
169
|
-
responseSchema: schemas_1.OrderDocumentResponseSchema,
|
|
170
|
-
}, params);
|
|
171
|
-
},
|
|
65
|
+
this.healthCheck = {
|
|
66
|
+
get: this.createHealthCheckMethod(schemas_1.HealthCheckResponseSchema),
|
|
172
67
|
/**
|
|
173
|
-
* Get only
|
|
174
|
-
* @
|
|
175
|
-
*
|
|
176
|
-
* @param orderNo Order number to retrieve
|
|
177
|
-
* @param params Optional parameters including postal code validation
|
|
178
|
-
* @returns Promise<OrderDocument> Direct order document object
|
|
68
|
+
* Get only health check data without response metadata
|
|
69
|
+
* @returns Promise<HealthCheckData> Direct health check data object
|
|
179
70
|
*/
|
|
180
|
-
|
|
181
|
-
const response = await this.
|
|
71
|
+
getData: async () => {
|
|
72
|
+
const response = await this.healthCheck.get();
|
|
182
73
|
return response.data;
|
|
183
74
|
},
|
|
184
75
|
};
|
|
185
76
|
/**
|
|
186
|
-
*
|
|
187
|
-
* @description
|
|
77
|
+
* Invoice Header Operations - OpenAPI Path: /invoice-hdr
|
|
78
|
+
* @description Invoice processing and document management with Prophet 21 integration for billing and accounting workflows following OpenAPI path mirroring pattern
|
|
188
79
|
*/
|
|
189
|
-
this.
|
|
80
|
+
this.invoiceHdr = {
|
|
190
81
|
/**
|
|
191
|
-
*
|
|
192
|
-
* @description Returns all orders associated with a specific sales representative, filtered by territory and permissions. Essential for sales performance tracking and customer relationship management.
|
|
193
|
-
*
|
|
194
|
-
* @fullPath api.orders.oeHdrSalesrep.getOrders
|
|
195
|
-
* @service orders
|
|
196
|
-
* @domain sales-management
|
|
197
|
-
* @dataMethod getOrdersData - returns only the orders array without metadata
|
|
198
|
-
* @discoverable true
|
|
199
|
-
* @searchTerms ["sales rep orders", "representative orders", "territory orders", "sales orders by rep", "rep performance"]
|
|
200
|
-
* @relatedEndpoints ["api.orders.oeHdrSalesrep.getOrderDocument", "api.orders.oeHdr.lookup", "api.customers.customer.list"]
|
|
201
|
-
* @commonPatterns ["Sales rep performance", "Territory management", "Rep order history", "Sales tracking"]
|
|
202
|
-
* @workflow ["sales-performance-tracking", "territory-management", "commission-calculation"]
|
|
203
|
-
* @prerequisites ["Valid sales representative ID", "Sales rep access permissions"]
|
|
204
|
-
* @nextSteps ["api.orders.oeHdrSalesrep.getOrderDocument for details", "Calculate commission totals", "Territory analysis"]
|
|
205
|
-
* @businessRules ["Returns only orders within rep's territory", "Respects sales hierarchy permissions", "May include completed and pending orders"]
|
|
206
|
-
* @functionalArea "sales-and-territory-management"
|
|
207
|
-
* @performance "Territory-filtered results - typically smaller datasets than global order lists"
|
|
208
|
-
*
|
|
209
|
-
* @param salesrepId Sales representative ID to retrieve orders for
|
|
210
|
-
* @returns Promise<BaseResponse<SalesRepOrder[]>> Complete response with rep's orders and metadata
|
|
211
|
-
*
|
|
212
|
-
* @example
|
|
213
|
-
* ```typescript
|
|
214
|
-
* // Get all orders for a sales rep
|
|
215
|
-
* const response = await api.orders.oeHdrSalesrep.getOrders(12345);
|
|
216
|
-
* console.log(`Rep has ${response.data.length} orders`);
|
|
217
|
-
*
|
|
218
|
-
* // Get just the orders data
|
|
219
|
-
* const repOrders = await api.orders.oeHdrSalesrep.getOrdersData(12345);
|
|
220
|
-
* const totalValue = repOrders.reduce((sum, order) => sum + order.orderTotal, 0);
|
|
221
|
-
* ```
|
|
82
|
+
* Invoice reprint operations - OpenAPI Path: /invoice-hdr/{invoiceNo}/reprint
|
|
222
83
|
*/
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
84
|
+
reprint: {
|
|
85
|
+
/**
|
|
86
|
+
* Reprint an existing invoice through Prophet 21 integration
|
|
87
|
+
* @description Generates a reprint of an existing invoice through Prophet 21 system integration. Returns invoice document data and reprint status for billing and customer service workflows.
|
|
88
|
+
*
|
|
89
|
+
* @fullPath api.orders.invoiceHdr.reprint.get
|
|
90
|
+
* @service orders
|
|
91
|
+
* @domain invoice-management
|
|
92
|
+
* @dataMethod getData - returns only the reprint result without metadata
|
|
93
|
+
* @discoverable true
|
|
94
|
+
* @searchTerms ["invoice reprint", "reprint invoice", "invoice copy", "duplicate invoice", "invoice document"]
|
|
95
|
+
* @relatedEndpoints ["api.orders.oeHdr.doc.get", "api.customers.customer.get", "api.p21-core.company.get"]
|
|
96
|
+
* @commonPatterns ["Reprint invoice", "Customer invoice copy", "Billing document", "Invoice duplicate"]
|
|
97
|
+
* @workflow ["invoice-management", "customer-service", "billing-workflow"]
|
|
98
|
+
* @prerequisites ["Valid invoice number", "Invoice exists in Prophet 21", "Reprint permissions"]
|
|
99
|
+
* @nextSteps ["Deliver invoice to customer", "Update billing records", "Customer service follow-up"]
|
|
100
|
+
* @businessRules ["Invoice must exist in Prophet 21", "Reprint creates audit trail", "Formatting matches original invoice"]
|
|
101
|
+
* @functionalArea "billing-and-invoicing"
|
|
102
|
+
* @performance "Integrates with Prophet 21 - response time depends on P21 system load"
|
|
103
|
+
*/
|
|
104
|
+
get: async (invoiceNo) => {
|
|
105
|
+
return this.executeRequest({
|
|
106
|
+
method: 'GET',
|
|
107
|
+
path: `/invoice-hdr/${invoiceNo}/reprint`,
|
|
108
|
+
responseSchema: schemas_1.InvoiceReprintApiResponseSchema,
|
|
109
|
+
}, {});
|
|
110
|
+
},
|
|
111
|
+
/**
|
|
112
|
+
* Get only invoice reprint data without response metadata
|
|
113
|
+
* @param invoiceNo Invoice number to reprint
|
|
114
|
+
* @returns Promise<InvoiceReprintResult> Direct reprint result object
|
|
115
|
+
*/
|
|
116
|
+
getData: async (invoiceNo) => {
|
|
117
|
+
const response = await this.invoiceHdr.reprint.get(invoiceNo);
|
|
118
|
+
return response.data;
|
|
119
|
+
},
|
|
229
120
|
},
|
|
121
|
+
};
|
|
122
|
+
/**
|
|
123
|
+
* Order Header Operations - OpenAPI Path: /oe-hdr
|
|
124
|
+
* @description Core order management functionality for searching, tracking, and retrieving sales orders following OpenAPI path mirroring pattern
|
|
125
|
+
*/
|
|
126
|
+
this.oeHdr = {
|
|
230
127
|
/**
|
|
231
|
-
*
|
|
232
|
-
* @description Data-only version of getOrders() method - returns the orders array directly
|
|
233
|
-
*
|
|
234
|
-
* @param salesrepId Sales representative ID
|
|
235
|
-
* @returns Promise<SalesRepOrder[]> Direct array of sales rep orders
|
|
128
|
+
* Order lookup operations - OpenAPI Path: /oe-hdr/lookup
|
|
236
129
|
*/
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
130
|
+
lookup: {
|
|
131
|
+
/**
|
|
132
|
+
* Search and list order headers with flexible filtering options
|
|
133
|
+
* @description Returns paginated order headers with comprehensive filtering by customer, date, status, sales rep, and search terms. Supports edge caching for improved performance.
|
|
134
|
+
*
|
|
135
|
+
* @fullPath api.orders.oeHdr.lookup.list
|
|
136
|
+
* @service orders
|
|
137
|
+
* @domain order-management
|
|
138
|
+
* @dataMethod listData - returns only the order headers array without metadata
|
|
139
|
+
* @discoverable true
|
|
140
|
+
* @searchTerms ["order lookup", "search orders", "order list", "find orders", "order search", "sales orders"]
|
|
141
|
+
* @relatedEndpoints ["api.orders.oeHdr.doc.get", "api.customers.customer.list", "api.orders.oeHdrSalesrep.oeHdr.list"]
|
|
142
|
+
* @commonPatterns ["Search orders by customer", "Find orders by order number", "List incomplete orders", "Filter by date range"]
|
|
143
|
+
* @workflow ["order-discovery", "order-status-tracking", "customer-order-history"]
|
|
144
|
+
* @prerequisites ["Valid authentication token", "Order access permissions"]
|
|
145
|
+
* @nextSteps ["api.orders.oeHdr.doc.get for full details", "api.customers.customer.get for customer info"]
|
|
146
|
+
* @businessRules ["Returns only orders accessible to current user/sales rep", "Completed orders may have restricted access", "Search supports partial matches"]
|
|
147
|
+
* @functionalArea "order-and-fulfillment-management"
|
|
148
|
+
* @caching "Supports edgeCache parameter (1-8 hours) for frequently accessed order lists"
|
|
149
|
+
* @performance "Use pagination for large result sets. Filter by specific criteria to improve performance."
|
|
150
|
+
*/
|
|
151
|
+
list: this.createListMethod('/oe-hdr/lookup', schemas_1.OrderLookupParamsSchema, schemas_1.OrderHeaderResponseSchema),
|
|
152
|
+
/**
|
|
153
|
+
* Get only order headers data without response metadata
|
|
154
|
+
* @param params Same parameters as list() method
|
|
155
|
+
* @returns Promise<OrderHeader[]> Direct array of order headers
|
|
156
|
+
*/
|
|
157
|
+
listData: async (params) => {
|
|
158
|
+
const response = await this.oeHdr.lookup.list(params);
|
|
159
|
+
return response.data;
|
|
160
|
+
},
|
|
240
161
|
},
|
|
241
162
|
/**
|
|
242
|
-
*
|
|
243
|
-
* @description Returns complete order document with sales rep context, including commission details and territory-specific information. Validates that the order belongs to the specified sales representative.
|
|
244
|
-
*
|
|
245
|
-
* @fullPath api.orders.oeHdrSalesrep.getOrderDocument
|
|
246
|
-
* @service orders
|
|
247
|
-
* @domain sales-management
|
|
248
|
-
* @dataMethod getOrderDocumentData - returns only the order document without metadata
|
|
249
|
-
* @discoverable true
|
|
250
|
-
* @searchTerms ["sales rep order document", "rep order details", "territory order document", "rep order with lines"]
|
|
251
|
-
* @relatedEndpoints ["api.orders.oeHdrSalesrep.getOrders", "api.orders.oeHdr.getDocument", "api.customers.customer.get"]
|
|
252
|
-
* @commonPatterns ["Rep order details", "Commission calculation", "Territory order review", "Sales order analysis"]
|
|
253
|
-
* @workflow ["sales-order-review", "commission-processing", "territory-analysis"]
|
|
254
|
-
* @prerequisites ["Valid sales rep ID", "Valid order number", "Order must belong to specified rep"]
|
|
255
|
-
* @nextSteps ["Calculate commission", "Update order status", "Customer follow-up"]
|
|
256
|
-
* @businessRules ["Order must belong to specified sales rep", "Includes commission and territory data", "Access controlled by sales hierarchy"]
|
|
257
|
-
* @functionalArea "sales-and-territory-management"
|
|
258
|
-
* @performance "Single document retrieval with rep validation - efficient for territory-specific access"
|
|
259
|
-
*
|
|
260
|
-
* @param salesrepId Sales representative ID
|
|
261
|
-
* @param orderNo Order number to retrieve
|
|
262
|
-
* @returns Promise<BaseResponse<SalesRepOrderDocument>> Complete response with rep-specific order document
|
|
263
|
-
*
|
|
264
|
-
* @example
|
|
265
|
-
* ```typescript
|
|
266
|
-
* // Get order document for specific sales rep
|
|
267
|
-
* const response = await api.orders.oeHdrSalesrep.getOrderDocument(12345, 987654);
|
|
268
|
-
* console.log(`Order ${response.data.orderNo} - Commission: $${response.data.commissionAmount}`);
|
|
269
|
-
*
|
|
270
|
-
* // Get just the document data
|
|
271
|
-
* const repOrder = await api.orders.oeHdrSalesrep.getOrderDocumentData(12345, 987654);
|
|
272
|
-
* console.log(`Territory: ${repOrder.territoryCode}`);
|
|
273
|
-
* ```
|
|
163
|
+
* Order document operations - OpenAPI Path: /oe-hdr/{orderNo}/doc
|
|
274
164
|
*/
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
165
|
+
doc: {
|
|
166
|
+
/**
|
|
167
|
+
* Retrieve complete order document with all related information
|
|
168
|
+
* @description Returns comprehensive order details including customer info, shipping address, line items, and totals. Includes optional postal code validation for security.
|
|
169
|
+
*
|
|
170
|
+
* @fullPath api.orders.oeHdr.doc.get
|
|
171
|
+
* @service orders
|
|
172
|
+
* @domain order-management
|
|
173
|
+
* @dataMethod getData - returns only the order document without metadata
|
|
174
|
+
* @discoverable true
|
|
175
|
+
* @searchTerms ["order document", "order details", "full order", "order with lines", "complete order"]
|
|
176
|
+
* @relatedEndpoints ["api.orders.oeHdr.lookup.list", "api.customers.customer.get", "api.items.products.get"]
|
|
177
|
+
* @commonPatterns ["Get order details", "View complete order", "Order with line items", "Full order document"]
|
|
178
|
+
* @workflow ["order-review", "order-fulfillment", "customer-service"]
|
|
179
|
+
* @prerequisites ["Valid order number", "Order access permissions", "Optional postal code for validation"]
|
|
180
|
+
* @nextSteps ["Process order fulfillment", "Update order status", "Generate invoice"]
|
|
181
|
+
* @businessRules ["Postal code validation optional but recommended for security", "Access restricted by sales rep permissions", "Includes all order line items and totals"]
|
|
182
|
+
* @functionalArea "order-and-fulfillment-management"
|
|
183
|
+
* @performance "Single document retrieval - no pagination needed. Consider caching for frequently accessed orders."
|
|
184
|
+
*/
|
|
185
|
+
get: async (orderNo, params) => {
|
|
186
|
+
return this.executeRequest({
|
|
187
|
+
method: 'GET',
|
|
188
|
+
path: `/oe-hdr/${orderNo}/doc`,
|
|
189
|
+
paramsSchema: schemas_1.OrderDocumentParamsSchema,
|
|
190
|
+
responseSchema: schemas_1.OrderDocumentResponseSchema,
|
|
191
|
+
}, params);
|
|
192
|
+
},
|
|
193
|
+
/**
|
|
194
|
+
* Get only order document data without response metadata
|
|
195
|
+
* @param orderNo Order number to retrieve
|
|
196
|
+
* @param params Optional parameters including postal code validation
|
|
197
|
+
* @returns Promise<OrderDocument> Direct order document object
|
|
198
|
+
*/
|
|
199
|
+
getData: async (orderNo, params) => {
|
|
200
|
+
const response = await this.oeHdr.doc.get(orderNo, params);
|
|
201
|
+
return response.data;
|
|
202
|
+
},
|
|
281
203
|
},
|
|
204
|
+
};
|
|
205
|
+
/**
|
|
206
|
+
* Sales Representative Order Header Operations - OpenAPI Path: /oe-hdr-salesrep
|
|
207
|
+
* @description Order management functionality specific to sales representatives including territory-based order access and rep-specific reporting following OpenAPI path mirroring pattern
|
|
208
|
+
*/
|
|
209
|
+
this.oeHdrSalesrep = {
|
|
282
210
|
/**
|
|
283
|
-
*
|
|
284
|
-
* @description Data-only version of getOrderDocument() method - returns the order document directly
|
|
285
|
-
*
|
|
286
|
-
* @param salesrepId Sales representative ID
|
|
287
|
-
* @param orderNo Order number to retrieve
|
|
288
|
-
* @returns Promise<SalesRepOrderDocument> Direct sales rep order document object
|
|
211
|
+
* Sales representative order operations - OpenAPI Path: /oe-hdr-salesrep/{salesrepId}/oe-hdr
|
|
289
212
|
*/
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
213
|
+
oeHdr: {
|
|
214
|
+
/**
|
|
215
|
+
* Get order list for a specific sales representative
|
|
216
|
+
* @description Returns all orders associated with a specific sales representative, filtered by territory and permissions. Essential for sales performance tracking and customer relationship management.
|
|
217
|
+
*
|
|
218
|
+
* @fullPath api.orders.oeHdrSalesrep.oeHdr.list
|
|
219
|
+
* @service orders
|
|
220
|
+
* @domain sales-management
|
|
221
|
+
* @dataMethod listData - returns only the orders array without metadata
|
|
222
|
+
* @discoverable true
|
|
223
|
+
* @searchTerms ["sales rep orders", "representative orders", "territory orders", "sales orders by rep", "rep performance"]
|
|
224
|
+
* @relatedEndpoints ["api.orders.oeHdrSalesrep.oeHdr.doc.get", "api.orders.oeHdr.lookup.list", "api.customers.customer.list"]
|
|
225
|
+
* @commonPatterns ["Sales rep performance", "Territory management", "Rep order history", "Sales tracking"]
|
|
226
|
+
* @workflow ["sales-performance-tracking", "territory-management", "commission-calculation"]
|
|
227
|
+
* @prerequisites ["Valid sales representative ID", "Sales rep access permissions"]
|
|
228
|
+
* @nextSteps ["api.orders.oeHdrSalesrep.oeHdr.doc.get for details", "Calculate commission totals", "Territory analysis"]
|
|
229
|
+
* @businessRules ["Returns only orders within rep's territory", "Respects sales hierarchy permissions", "May include completed and pending orders"]
|
|
230
|
+
* @functionalArea "sales-and-territory-management"
|
|
231
|
+
* @performance "Territory-filtered results - typically smaller datasets than global order lists"
|
|
232
|
+
*/
|
|
233
|
+
list: async (salesrepId) => {
|
|
234
|
+
return this.executeRequest({
|
|
235
|
+
method: 'GET',
|
|
236
|
+
path: `/oe-hdr-salesrep/${salesrepId}/oe-hdr`,
|
|
237
|
+
responseSchema: schemas_1.SalesRepOrderListResponseSchema,
|
|
238
|
+
}, {});
|
|
239
|
+
},
|
|
240
|
+
/**
|
|
241
|
+
* Get only sales rep orders data without response metadata
|
|
242
|
+
* @param salesrepId Sales representative ID
|
|
243
|
+
* @returns Promise<SalesRepOrder[]> Direct array of sales rep orders
|
|
244
|
+
*/
|
|
245
|
+
listData: async (salesrepId) => {
|
|
246
|
+
const response = await this.oeHdrSalesrep.oeHdr.list(salesrepId);
|
|
247
|
+
return response.data;
|
|
248
|
+
},
|
|
249
|
+
/**
|
|
250
|
+
* Sales rep order document operations - OpenAPI Path: /oe-hdr-salesrep/{salesrepId}/oe-hdr/{orderNo}/doc
|
|
251
|
+
*/
|
|
252
|
+
doc: {
|
|
253
|
+
/**
|
|
254
|
+
* Get specific order document for a sales representative
|
|
255
|
+
* @description Returns complete order document with sales rep context, including commission details and territory-specific information. Validates that the order belongs to the specified sales representative.
|
|
256
|
+
*
|
|
257
|
+
* @fullPath api.orders.oeHdrSalesrep.oeHdr.doc.get
|
|
258
|
+
* @service orders
|
|
259
|
+
* @domain sales-management
|
|
260
|
+
* @dataMethod getData - returns only the order document without metadata
|
|
261
|
+
* @discoverable true
|
|
262
|
+
* @searchTerms ["sales rep order document", "rep order details", "territory order document", "rep order with lines"]
|
|
263
|
+
* @relatedEndpoints ["api.orders.oeHdrSalesrep.oeHdr.list", "api.orders.oeHdr.doc.get", "api.customers.customer.get"]
|
|
264
|
+
* @commonPatterns ["Rep order details", "Commission calculation", "Territory order review", "Sales order analysis"]
|
|
265
|
+
* @workflow ["sales-order-review", "commission-processing", "territory-analysis"]
|
|
266
|
+
* @prerequisites ["Valid sales rep ID", "Valid order number", "Order must belong to specified rep"]
|
|
267
|
+
* @nextSteps ["Calculate commission", "Update order status", "Customer follow-up"]
|
|
268
|
+
* @businessRules ["Order must belong to specified sales rep", "Includes commission and territory data", "Access controlled by sales hierarchy"]
|
|
269
|
+
* @functionalArea "sales-and-territory-management"
|
|
270
|
+
* @performance "Single document retrieval with rep validation - efficient for territory-specific access"
|
|
271
|
+
*/
|
|
272
|
+
get: async (salesrepId, orderNo) => {
|
|
273
|
+
return this.executeRequest({
|
|
274
|
+
method: 'GET',
|
|
275
|
+
path: `/oe-hdr-salesrep/${salesrepId}/oe-hdr/${orderNo}/doc`,
|
|
276
|
+
responseSchema: schemas_1.SalesRepOrderDocumentResponseSchema,
|
|
277
|
+
}, {});
|
|
278
|
+
},
|
|
279
|
+
/**
|
|
280
|
+
* Get only sales rep order document data without response metadata
|
|
281
|
+
* @param salesrepId Sales representative ID
|
|
282
|
+
* @param orderNo Order number to retrieve
|
|
283
|
+
* @returns Promise<SalesRepOrderDocument> Direct sales rep order document object
|
|
284
|
+
*/
|
|
285
|
+
getData: async (salesrepId, orderNo) => {
|
|
286
|
+
const response = await this.oeHdrSalesrep.oeHdr.doc.get(salesrepId, orderNo);
|
|
287
|
+
return response.data;
|
|
288
|
+
},
|
|
289
|
+
},
|
|
293
290
|
},
|
|
294
291
|
};
|
|
295
292
|
/**
|
|
296
|
-
* Purchase Order Operations
|
|
297
|
-
* @description Comprehensive purchase order management including creation, tracking, receiving, and document generation for procurement workflows
|
|
293
|
+
* Purchase Order Header Operations - OpenAPI Path: /po-hdr
|
|
294
|
+
* @description Comprehensive purchase order management including creation, tracking, receiving, and document generation for procurement workflows following OpenAPI path mirroring pattern
|
|
298
295
|
*/
|
|
299
296
|
this.poHdr = {
|
|
300
297
|
/**
|
|
301
|
-
* List purchase orders with filtering and pagination
|
|
298
|
+
* List purchase orders with filtering and pagination - OpenAPI Path: /po-hdr
|
|
302
299
|
* @description Returns paginated purchase orders with comprehensive filtering by status, vendor, date ranges, and completion status. Essential for procurement management and receiving workflows.
|
|
303
300
|
*
|
|
304
301
|
* @fullPath api.orders.poHdr.list
|
|
@@ -307,7 +304,7 @@ class OrdersClient extends base_client_1.BaseServiceClient {
|
|
|
307
304
|
* @dataMethod listData - returns only the purchase orders array without metadata
|
|
308
305
|
* @discoverable true
|
|
309
306
|
* @searchTerms ["purchase orders", "PO list", "procurement", "vendor orders", "purchase order management", "receiving"]
|
|
310
|
-
* @relatedEndpoints ["api.orders.poHdr.get", "api.orders.poHdr.
|
|
307
|
+
* @relatedEndpoints ["api.orders.poHdr.get", "api.orders.poHdr.doc.get", "api.orders.poHdr.scan.create", "api.nexus.receiving.list"]
|
|
311
308
|
* @commonPatterns ["List open POs", "Find POs by vendor", "Track receiving status", "Procurement dashboard"]
|
|
312
309
|
* @workflow ["procurement-workflow", "purchase-order-lifecycle", "receiving-management"]
|
|
313
310
|
* @prerequisites ["Valid authentication", "Purchase order access permissions"]
|
|
@@ -315,37 +312,10 @@ class OrdersClient extends base_client_1.BaseServiceClient {
|
|
|
315
312
|
* @businessRules ["Filters by completion status", "Supports vendor and date filtering", "Pagination required for large datasets"]
|
|
316
313
|
* @functionalArea "procurement-and-purchasing"
|
|
317
314
|
* @performance "Use filtering to reduce result sets. Consider pagination for better performance."
|
|
318
|
-
*
|
|
319
|
-
* @param params Optional filtering and pagination parameters
|
|
320
|
-
* @param params.complete Filter by completion status ('Y' for complete, 'N' for incomplete)
|
|
321
|
-
* @param params.vendorId Filter by specific vendor ID
|
|
322
|
-
* @param params.dateFrom Filter POs created from this date (YYYY-MM-DD)
|
|
323
|
-
* @param params.dateTo Filter POs created to this date (YYYY-MM-DD)
|
|
324
|
-
* @param params.limit Maximum number of POs to return (default: 20, max: 100)
|
|
325
|
-
* @param params.offset Number of items to skip for pagination
|
|
326
|
-
* @returns Promise<BaseResponse<PurchaseOrder[]>> Complete response with purchase orders and metadata
|
|
327
|
-
*
|
|
328
|
-
* @example
|
|
329
|
-
* ```typescript
|
|
330
|
-
* // List incomplete purchase orders
|
|
331
|
-
* const response = await api.orders.poHdr.list({
|
|
332
|
-
* complete: 'N',
|
|
333
|
-
* limit: 50
|
|
334
|
-
* });
|
|
335
|
-
* console.log(`${response.total} open purchase orders`);
|
|
336
|
-
*
|
|
337
|
-
* // Get just the PO data
|
|
338
|
-
* const openPOs = await api.orders.poHdr.listData({
|
|
339
|
-
* complete: 'N',
|
|
340
|
-
* vendorId: 'VENDOR001'
|
|
341
|
-
* });
|
|
342
|
-
* ```
|
|
343
315
|
*/
|
|
344
316
|
list: this.createListMethod('/po-hdr', schemas_1.PurchaseOrderListParamsSchema, schemas_1.PurchaseOrderListResponseSchema),
|
|
345
317
|
/**
|
|
346
318
|
* Get only purchase orders data without response metadata
|
|
347
|
-
* @description Data-only version of list() method - returns the purchase orders array directly
|
|
348
|
-
*
|
|
349
319
|
* @param params Same parameters as list() method
|
|
350
320
|
* @returns Promise<PurchaseOrder[]> Direct array of purchase orders
|
|
351
321
|
*/
|
|
@@ -354,7 +324,7 @@ class OrdersClient extends base_client_1.BaseServiceClient {
|
|
|
354
324
|
return response.data;
|
|
355
325
|
},
|
|
356
326
|
/**
|
|
357
|
-
* Get detailed purchase order information
|
|
327
|
+
* Get detailed purchase order information - OpenAPI Path: /po-hdr/{poNo}
|
|
358
328
|
* @description Returns comprehensive purchase order details including header information, vendor details, status, and summary totals. Used for PO management and tracking.
|
|
359
329
|
*
|
|
360
330
|
* @fullPath api.orders.poHdr.get
|
|
@@ -363,33 +333,18 @@ class OrdersClient extends base_client_1.BaseServiceClient {
|
|
|
363
333
|
* @dataMethod getData - returns only the purchase order detail without metadata
|
|
364
334
|
* @discoverable true
|
|
365
335
|
* @searchTerms ["purchase order details", "PO details", "purchase order info", "PO header"]
|
|
366
|
-
* @relatedEndpoints ["api.orders.poHdr.list", "api.orders.poHdr.
|
|
336
|
+
* @relatedEndpoints ["api.orders.poHdr.list", "api.orders.poHdr.doc.get", "api.nexus.receiving.list"]
|
|
367
337
|
* @commonPatterns ["Get PO details", "View purchase order", "PO status check", "Vendor order info"]
|
|
368
338
|
* @workflow ["purchase-order-review", "receiving-preparation", "vendor-management"]
|
|
369
339
|
* @prerequisites ["Valid purchase order number", "PO access permissions"]
|
|
370
|
-
* @nextSteps ["api.orders.poHdr.
|
|
340
|
+
* @nextSteps ["api.orders.poHdr.doc.get for full details", "Create receiving record", "Update PO status"]
|
|
371
341
|
* @businessRules ["Returns header-level information only", "Access controlled by permissions", "Status reflects current receiving state"]
|
|
372
342
|
* @functionalArea "procurement-and-purchasing"
|
|
373
343
|
* @performance "Single PO retrieval - efficient for header information"
|
|
374
|
-
*
|
|
375
|
-
* @param id Purchase order number to retrieve
|
|
376
|
-
* @returns Promise<BaseResponse<PurchaseOrderDetail>> Complete response with PO details
|
|
377
|
-
*
|
|
378
|
-
* @example
|
|
379
|
-
* ```typescript
|
|
380
|
-
* // Get PO details
|
|
381
|
-
* const response = await api.orders.poHdr.get(12345);
|
|
382
|
-
* console.log(`PO ${response.data.poNo} - Status: ${response.data.status}`);
|
|
383
|
-
*
|
|
384
|
-
* // Get just the PO data
|
|
385
|
-
* const poDetail = await api.orders.poHdr.getData(12345);
|
|
386
|
-
* ```
|
|
387
344
|
*/
|
|
388
345
|
get: this.createGetMethod('/po-hdr/{poNo}', schemas_1.PurchaseOrderDetailResponseSchema),
|
|
389
346
|
/**
|
|
390
347
|
* Get only purchase order detail data without response metadata
|
|
391
|
-
* @description Data-only version of get() method - returns the purchase order detail directly
|
|
392
|
-
*
|
|
393
348
|
* @param id Purchase order number to retrieve
|
|
394
349
|
* @returns Promise<PurchaseOrderDetail> Direct purchase order detail object
|
|
395
350
|
*/
|
|
@@ -398,206 +353,86 @@ class OrdersClient extends base_client_1.BaseServiceClient {
|
|
|
398
353
|
return response.data;
|
|
399
354
|
},
|
|
400
355
|
/**
|
|
401
|
-
*
|
|
402
|
-
* @description Returns comprehensive purchase order document including header, line items, vendor information, shipping details, and totals. Complete document for receiving and fulfillment processes.
|
|
403
|
-
*
|
|
404
|
-
* @fullPath api.orders.poHdr.getDocument
|
|
405
|
-
* @service orders
|
|
406
|
-
* @domain procurement-management
|
|
407
|
-
* @dataMethod getDocumentData - returns only the purchase order document without metadata
|
|
408
|
-
* @discoverable true
|
|
409
|
-
* @searchTerms ["purchase order document", "complete PO", "PO with lines", "full purchase order", "PO document"]
|
|
410
|
-
* @relatedEndpoints ["api.orders.poHdr.get", "api.orders.poHdr.list", "api.nexus.receiving.create"]
|
|
411
|
-
* @commonPatterns ["Complete PO details", "PO for receiving", "Full purchase order", "PO with line items"]
|
|
412
|
-
* @workflow ["purchase-order-fulfillment", "receiving-workflow", "vendor-management"]
|
|
413
|
-
* @prerequisites ["Valid purchase order number", "Document access permissions"]
|
|
414
|
-
* @nextSteps ["Process receiving", "Create receiving records", "Update line item status"]
|
|
415
|
-
* @businessRules ["Includes all line items and quantities", "Shows receiving status per line", "Contains vendor and shipping details"]
|
|
416
|
-
* @functionalArea "procurement-and-purchasing"
|
|
417
|
-
* @performance "Complete document retrieval - includes all related data in single call"
|
|
418
|
-
*
|
|
419
|
-
* @param poNo Purchase order number to retrieve
|
|
420
|
-
* @returns Promise<BaseResponse<PurchaseOrderDocument>> Complete response with full PO document
|
|
421
|
-
*
|
|
422
|
-
* @example
|
|
423
|
-
* ```typescript
|
|
424
|
-
* // Get complete PO document
|
|
425
|
-
* const response = await api.orders.poHdr.getDocument(12345);
|
|
426
|
-
* console.log(`PO ${response.data.poNo} has ${response.data.lines.length} line items`);
|
|
427
|
-
*
|
|
428
|
-
* // Get just the document data
|
|
429
|
-
* const poDoc = await api.orders.poHdr.getDocumentData(12345);
|
|
430
|
-
* poDoc.lines.forEach(line => {
|
|
431
|
-
* console.log(`${line.itemId}: ${line.qtyOrdered} (${line.qtyReceived} received)`);
|
|
432
|
-
* });
|
|
433
|
-
* ```
|
|
356
|
+
* Purchase order document operations - OpenAPI Path: /po-hdr/{poNo}/doc
|
|
434
357
|
*/
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
358
|
+
doc: {
|
|
359
|
+
/**
|
|
360
|
+
* Get complete purchase order document with all related information
|
|
361
|
+
* @description Returns comprehensive purchase order document including header, line items, vendor information, shipping details, and totals. Complete document for receiving and fulfillment processes.
|
|
362
|
+
*
|
|
363
|
+
* @fullPath api.orders.poHdr.doc.get
|
|
364
|
+
* @service orders
|
|
365
|
+
* @domain procurement-management
|
|
366
|
+
* @dataMethod getData - returns only the purchase order document without metadata
|
|
367
|
+
* @discoverable true
|
|
368
|
+
* @searchTerms ["purchase order document", "complete PO", "PO with lines", "full purchase order", "PO document"]
|
|
369
|
+
* @relatedEndpoints ["api.orders.poHdr.get", "api.orders.poHdr.list", "api.nexus.receiving.create"]
|
|
370
|
+
* @commonPatterns ["Complete PO details", "PO for receiving", "Full purchase order", "PO with line items"]
|
|
371
|
+
* @workflow ["purchase-order-fulfillment", "receiving-workflow", "vendor-management"]
|
|
372
|
+
* @prerequisites ["Valid purchase order number", "Document access permissions"]
|
|
373
|
+
* @nextSteps ["Process receiving", "Create receiving records", "Update line item status"]
|
|
374
|
+
* @businessRules ["Includes all line items and quantities", "Shows receiving status per line", "Contains vendor and shipping details"]
|
|
375
|
+
* @functionalArea "procurement-and-purchasing"
|
|
376
|
+
* @performance "Complete document retrieval - includes all related data in single call"
|
|
377
|
+
*/
|
|
378
|
+
get: async (poNo) => {
|
|
379
|
+
return this.executeRequest({
|
|
380
|
+
method: 'GET',
|
|
381
|
+
path: `/po-hdr/${poNo}/doc`,
|
|
382
|
+
responseSchema: schemas_1.PurchaseOrderDocumentResponseSchema,
|
|
383
|
+
}, {});
|
|
384
|
+
},
|
|
385
|
+
/**
|
|
386
|
+
* Get only purchase order document data without response metadata
|
|
387
|
+
* @param poNo Purchase order number to retrieve
|
|
388
|
+
* @returns Promise<PurchaseOrderDocument> Direct purchase order document object
|
|
389
|
+
*/
|
|
390
|
+
getData: async (poNo) => {
|
|
391
|
+
const response = await this.poHdr.doc.get(poNo);
|
|
392
|
+
return response.data;
|
|
393
|
+
},
|
|
441
394
|
},
|
|
442
395
|
/**
|
|
443
|
-
*
|
|
444
|
-
* @description Data-only version of getDocument() method - returns the purchase order document directly
|
|
445
|
-
*
|
|
446
|
-
* @param poNo Purchase order number to retrieve
|
|
447
|
-
* @returns Promise<PurchaseOrderDocument> Direct purchase order document object
|
|
396
|
+
* Purchase order scan operations - OpenAPI Path: /po-hdr/scan
|
|
448
397
|
*/
|
|
449
|
-
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
*
|
|
480
|
-
* @example
|
|
481
|
-
* ```typescript
|
|
482
|
-
* // Scan for similar POs by items
|
|
483
|
-
* const response = await api.orders.poHdr.scan({
|
|
484
|
-
* itemIds: ['ITEM001', 'ITEM002'],
|
|
485
|
-
* similarityThreshold: 70
|
|
486
|
-
* });
|
|
487
|
-
*
|
|
488
|
-
* // Get just the scan results
|
|
489
|
-
* const similarPOs = await api.orders.poHdr.scanData({
|
|
490
|
-
* vendorId: 'VENDOR001',
|
|
491
|
-
* dateFrom: '2024-01-01'
|
|
492
|
-
* });
|
|
493
|
-
* ```
|
|
494
|
-
*/
|
|
495
|
-
scan: this.createCreateMethod('/po-hdr/scan', schemas_1.PurchaseOrderScanParamsSchema, schemas_1.PurchaseOrderScanResponseSchema),
|
|
496
|
-
/**
|
|
497
|
-
* Get only purchase order scan results data without response metadata
|
|
498
|
-
* @description Data-only version of scan() method - returns the scan results directly
|
|
499
|
-
*
|
|
500
|
-
* @param params Same parameters as scan() method
|
|
501
|
-
* @returns Promise<PurchaseOrderScanResult[]> Direct array of scan results
|
|
502
|
-
*/
|
|
503
|
-
scanData: async (params) => {
|
|
504
|
-
const response = await this.poHdr.scan(params || {});
|
|
505
|
-
return response.data;
|
|
398
|
+
scan: {
|
|
399
|
+
/**
|
|
400
|
+
* Scan for similar purchase orders based on provided criteria
|
|
401
|
+
* @description Intelligent purchase order discovery that finds similar POs based on items, vendors, or other criteria. Useful for reordering, vendor analysis, and procurement optimization.
|
|
402
|
+
*
|
|
403
|
+
* @fullPath api.orders.poHdr.scan.create
|
|
404
|
+
* @service orders
|
|
405
|
+
* @domain procurement-management
|
|
406
|
+
* @dataMethod createData - returns only the scan results without metadata
|
|
407
|
+
* @discoverable true
|
|
408
|
+
* @searchTerms ["PO scan", "similar purchase orders", "find similar POs", "PO search", "procurement patterns"]
|
|
409
|
+
* @relatedEndpoints ["api.orders.poHdr.list", "api.orders.poHdr.doc.get", "api.items.products.list"]
|
|
410
|
+
* @commonPatterns ["Find similar orders", "Reorder analysis", "Vendor pattern analysis", "Procurement optimization"]
|
|
411
|
+
* @workflow ["procurement-optimization", "reorder-analysis", "vendor-comparison"]
|
|
412
|
+
* @prerequisites ["Scan criteria parameters", "PO access permissions"]
|
|
413
|
+
* @nextSteps ["Analyze results for reordering", "Compare vendor patterns", "Optimize procurement"]
|
|
414
|
+
* @businessRules ["Matches based on provided criteria", "Returns similarity scores", "Filters by date ranges and status"]
|
|
415
|
+
* @functionalArea "procurement-and-purchasing"
|
|
416
|
+
* @performance "Advanced search operation - may take longer for complex criteria"
|
|
417
|
+
*/
|
|
418
|
+
create: this.createCreateMethod('/po-hdr/scan', schemas_1.PurchaseOrderScanParamsSchema, schemas_1.PurchaseOrderScanResponseSchema),
|
|
419
|
+
/**
|
|
420
|
+
* Get only purchase order scan results data without response metadata
|
|
421
|
+
* @param params Same parameters as create() method
|
|
422
|
+
* @returns Promise<PurchaseOrderScanResult[]> Direct array of scan results
|
|
423
|
+
*/
|
|
424
|
+
createData: async (params) => {
|
|
425
|
+
const response = await this.poHdr.scan.create(params || {});
|
|
426
|
+
return response.data;
|
|
427
|
+
},
|
|
506
428
|
},
|
|
507
429
|
};
|
|
508
430
|
/**
|
|
509
|
-
*
|
|
510
|
-
* @
|
|
431
|
+
* Legacy method support for backward compatibility
|
|
432
|
+
* @deprecated Use the new OpenAPI path mirroring structure instead
|
|
511
433
|
*/
|
|
512
|
-
this.
|
|
513
|
-
|
|
514
|
-
* Reprint an existing invoice through Prophet 21 integration
|
|
515
|
-
* @description Generates a reprint of an existing invoice through Prophet 21 system integration. Returns invoice document data and reprint status for billing and customer service workflows.
|
|
516
|
-
*
|
|
517
|
-
* @fullPath api.orders.invoiceHdr.reprint
|
|
518
|
-
* @service orders
|
|
519
|
-
* @domain invoice-management
|
|
520
|
-
* @dataMethod reprintData - returns only the reprint result without metadata
|
|
521
|
-
* @discoverable true
|
|
522
|
-
* @searchTerms ["invoice reprint", "reprint invoice", "invoice copy", "duplicate invoice", "invoice document"]
|
|
523
|
-
* @relatedEndpoints ["api.orders.oeHdr.getDocument", "api.customers.customer.get", "api.p21-core.company.get"]
|
|
524
|
-
* @commonPatterns ["Reprint invoice", "Customer invoice copy", "Billing document", "Invoice duplicate"]
|
|
525
|
-
* @workflow ["invoice-management", "customer-service", "billing-workflow"]
|
|
526
|
-
* @prerequisites ["Valid invoice number", "Invoice exists in Prophet 21", "Reprint permissions"]
|
|
527
|
-
* @nextSteps ["Deliver invoice to customer", "Update billing records", "Customer service follow-up"]
|
|
528
|
-
* @businessRules ["Invoice must exist in Prophet 21", "Reprint creates audit trail", "Formatting matches original invoice"]
|
|
529
|
-
* @functionalArea "billing-and-invoicing"
|
|
530
|
-
* @performance "Integrates with Prophet 21 - response time depends on P21 system load"
|
|
531
|
-
*
|
|
532
|
-
* @param invoiceNo Invoice number to reprint (string format)
|
|
533
|
-
* @returns Promise<BaseResponse<InvoiceReprintResult>> Complete response with reprint status and document data
|
|
534
|
-
*
|
|
535
|
-
* @example
|
|
536
|
-
* ```typescript
|
|
537
|
-
* // Reprint an invoice
|
|
538
|
-
* const response = await api.orders.invoiceHdr.reprint('INV-12345');
|
|
539
|
-
* console.log(`Invoice reprint status: ${response.data.status}`);
|
|
540
|
-
*
|
|
541
|
-
* // Get just the reprint data
|
|
542
|
-
* const reprintResult = await api.orders.invoiceHdr.reprintData('INV-12345');
|
|
543
|
-
* if (reprintResult.success) {
|
|
544
|
-
* console.log(`Reprint generated: ${reprintResult.documentUrl}`);
|
|
545
|
-
* }
|
|
546
|
-
* ```
|
|
547
|
-
*/
|
|
548
|
-
reprint: async (invoiceNo) => {
|
|
549
|
-
return this.executeRequest({
|
|
550
|
-
method: 'GET',
|
|
551
|
-
path: `/invoice-hdr/${invoiceNo}/reprint`,
|
|
552
|
-
responseSchema: schemas_1.InvoiceReprintApiResponseSchema,
|
|
553
|
-
}, {});
|
|
554
|
-
},
|
|
555
|
-
/**
|
|
556
|
-
* Get only invoice reprint data without response metadata
|
|
557
|
-
* @description Data-only version of reprint() method - returns the reprint result directly
|
|
558
|
-
*
|
|
559
|
-
* @param invoiceNo Invoice number to reprint
|
|
560
|
-
* @returns Promise<InvoiceReprintResult> Direct reprint result object
|
|
561
|
-
*/
|
|
562
|
-
reprintData: async (invoiceNo) => {
|
|
563
|
-
const response = await this.invoiceHdr.reprint(invoiceNo);
|
|
564
|
-
return response.data;
|
|
565
|
-
},
|
|
566
|
-
};
|
|
567
|
-
/**
|
|
568
|
-
* Health check endpoint
|
|
569
|
-
* @description Service health and status monitoring endpoint for system diagnostics and uptime verification
|
|
570
|
-
*
|
|
571
|
-
* @fullPath api.orders.getHealthCheck
|
|
572
|
-
* @service orders
|
|
573
|
-
* @domain system-monitoring
|
|
574
|
-
* @dataMethod getHealthCheckData - returns only the health check data without metadata
|
|
575
|
-
* @discoverable true
|
|
576
|
-
* @searchTerms ["health check", "service status", "orders health", "system status"]
|
|
577
|
-
* @relatedEndpoints ["api.joomla.getHealthCheck", "api.nexus.getHealthCheck", "api.items.getHealthCheck"]
|
|
578
|
-
* @commonPatterns ["Check service health", "System monitoring", "Service status"]
|
|
579
|
-
* @workflow ["system-monitoring", "health-diagnostics"]
|
|
580
|
-
* @functionalArea "system-operations"
|
|
581
|
-
* @performance "Lightweight endpoint for monitoring - minimal response time"
|
|
582
|
-
*/
|
|
583
|
-
this.getHealthCheck = this.createHealthCheckMethod(schemas_1.HealthCheckResponseSchema);
|
|
584
|
-
/**
|
|
585
|
-
* Get only health check data without response metadata
|
|
586
|
-
* @description Data-only version of getHealthCheck() method - returns the health check data directly
|
|
587
|
-
*
|
|
588
|
-
* @returns Promise<HealthCheckData> Direct health check data object
|
|
589
|
-
*
|
|
590
|
-
* @example
|
|
591
|
-
* ```typescript
|
|
592
|
-
* // Get just the health check data
|
|
593
|
-
* const healthData = await api.orders.getHealthCheckData();
|
|
594
|
-
* console.log(`Site: ${healthData.siteId} - Hash: ${healthData.siteHash}`);
|
|
595
|
-
* ```
|
|
596
|
-
*/
|
|
597
|
-
this.getHealthCheckData = async () => {
|
|
598
|
-
const response = await this.getHealthCheck();
|
|
599
|
-
return response.data;
|
|
600
|
-
};
|
|
434
|
+
this.getHealthCheck = this.healthCheck.get;
|
|
435
|
+
this.getHealthCheckData = this.healthCheck.getData;
|
|
601
436
|
}
|
|
602
437
|
}
|
|
603
438
|
exports.OrdersClient = OrdersClient;
|