@simpleapps-com/augur-api 0.3.3 → 0.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/API-SERVICES.md +44 -2
- package/README.md +83 -2
- 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 +311 -566
- 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/customers/schemas/contacts.d.ts +8 -8
- 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 +2786 -5032
- package/dist/cjs/services/items/client.d.ts.map +1 -1
- package/dist/cjs/services/items/client.js +1566 -3436
- package/dist/cjs/services/items/client.js.map +1 -1
- package/dist/cjs/services/items/schemas/attributeGroupsAttributes.d.ts +250 -0
- package/dist/cjs/services/items/schemas/attributeGroupsAttributes.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/attributeGroupsAttributes.js +37 -0
- package/dist/cjs/services/items/schemas/attributeGroupsAttributes.js.map +1 -0
- package/dist/cjs/services/items/schemas/attributes.d.ts +2 -2
- package/dist/cjs/services/items/schemas/attributesValues.d.ts +276 -0
- package/dist/cjs/services/items/schemas/attributesValues.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/attributesValues.js +41 -0
- package/dist/cjs/services/items/schemas/attributesValues.js.map +1 -0
- 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 +18 -0
- package/dist/cjs/services/items/schemas/index.d.ts.map +1 -1
- package/dist/cjs/services/items/schemas/index.js +26 -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/invMastFaq.d.ts +356 -0
- package/dist/cjs/services/items/schemas/invMastFaq.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/invMastFaq.js +49 -0
- package/dist/cjs/services/items/schemas/invMastFaq.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/invMastLocationsBins.d.ts +242 -0
- package/dist/cjs/services/items/schemas/invMastLocationsBins.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/invMastLocationsBins.js +25 -0
- package/dist/cjs/services/items/schemas/invMastLocationsBins.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/itemWishlistHdr.d.ts +295 -0
- package/dist/cjs/services/items/schemas/itemWishlistHdr.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/itemWishlistHdr.js +35 -0
- package/dist/cjs/services/items/schemas/itemWishlistHdr.js.map +1 -0
- package/dist/cjs/services/items/schemas/itemWishlistLine.d.ts +148 -0
- package/dist/cjs/services/items/schemas/itemWishlistLine.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/itemWishlistLine.js +24 -0
- package/dist/cjs/services/items/schemas/itemWishlistLine.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/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 +311 -566
- 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/customers/schemas/contacts.d.ts +8 -8
- 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 +2786 -5032
- package/dist/esm/services/items/client.d.ts.map +1 -1
- package/dist/esm/services/items/client.js +1581 -3462
- package/dist/esm/services/items/client.js.map +1 -1
- package/dist/esm/services/items/schemas/attributeGroupsAttributes.d.ts +250 -0
- package/dist/esm/services/items/schemas/attributeGroupsAttributes.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/attributeGroupsAttributes.js +34 -0
- package/dist/esm/services/items/schemas/attributeGroupsAttributes.js.map +1 -0
- package/dist/esm/services/items/schemas/attributes.d.ts +2 -2
- package/dist/esm/services/items/schemas/attributesValues.d.ts +276 -0
- package/dist/esm/services/items/schemas/attributesValues.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/attributesValues.js +38 -0
- package/dist/esm/services/items/schemas/attributesValues.js.map +1 -0
- 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 +18 -0
- package/dist/esm/services/items/schemas/index.d.ts.map +1 -1
- package/dist/esm/services/items/schemas/index.js +20 -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/invMastFaq.d.ts +356 -0
- package/dist/esm/services/items/schemas/invMastFaq.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/invMastFaq.js +46 -0
- package/dist/esm/services/items/schemas/invMastFaq.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/invMastLocationsBins.d.ts +242 -0
- package/dist/esm/services/items/schemas/invMastLocationsBins.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/invMastLocationsBins.js +22 -0
- package/dist/esm/services/items/schemas/invMastLocationsBins.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/itemWishlistHdr.d.ts +295 -0
- package/dist/esm/services/items/schemas/itemWishlistHdr.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/itemWishlistHdr.js +32 -0
- package/dist/esm/services/items/schemas/itemWishlistHdr.js.map +1 -0
- package/dist/esm/services/items/schemas/itemWishlistLine.d.ts +148 -0
- package/dist/esm/services/items/schemas/itemWishlistLine.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/itemWishlistLine.js +21 -0
- package/dist/esm/services/items/schemas/itemWishlistLine.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/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 +311 -566
- package/dist/types/services/customers/client.d.ts.map +1 -1
- package/dist/types/services/customers/schemas/contacts.d.ts +8 -8
- 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 +2786 -5032
- package/dist/types/services/items/client.d.ts.map +1 -1
- package/dist/types/services/items/schemas/attributeGroupsAttributes.d.ts +250 -0
- package/dist/types/services/items/schemas/attributeGroupsAttributes.d.ts.map +1 -0
- package/dist/types/services/items/schemas/attributes.d.ts +2 -2
- package/dist/types/services/items/schemas/attributesValues.d.ts +276 -0
- package/dist/types/services/items/schemas/attributesValues.d.ts.map +1 -0
- 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 +18 -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/invMastFaq.d.ts +356 -0
- package/dist/types/services/items/schemas/invMastFaq.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/invMastLocationsBins.d.ts +242 -0
- package/dist/types/services/items/schemas/invMastLocationsBins.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/itemWishlistHdr.d.ts +295 -0
- package/dist/types/services/items/schemas/itemWishlistHdr.d.ts.map +1 -0
- package/dist/types/services/items/schemas/itemWishlistLine.d.ts +148 -0
- package/dist/types/services/items/schemas/itemWishlistLine.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 +2 -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
|
@@ -2,8 +2,19 @@ import { BaseServiceClient } from '../../core/base-client';
|
|
|
2
2
|
import type { HTTPClient } from '../../core/client';
|
|
3
3
|
import { CartHdrListParams, CartHdrLookupParams, CartHdrLookupResponse, CartLineAddRequest, CartLineUpdateRequest, CartLineModifyResponse, CartLineDeleteResponse, AlsoBoughtParams, AlsoBoughtResponse, CheckoutCreateRequest, CheckoutDocParams } from './schemas';
|
|
4
4
|
/**
|
|
5
|
-
* Commerce
|
|
6
|
-
* @description Client for interacting with Commerce
|
|
5
|
+
* Commerce Service Client
|
|
6
|
+
* @description Client for interacting with Commerce API endpoints for e-commerce cart and checkout operations
|
|
7
|
+
* @fullPath api.commerce
|
|
8
|
+
* @service commerce
|
|
9
|
+
* @domain e-commerce
|
|
10
|
+
* @discoverable true
|
|
11
|
+
* @searchTerms ["commerce", "e-commerce", "shopping cart", "checkout", "cart management", "online store"]
|
|
12
|
+
* @relatedEndpoints ["api.commerce.cartHdr.list.get", "api.commerce.cartLine.get", "api.commerce.checkout.create", "api.avalara.rates.create"]
|
|
13
|
+
* @commonPatterns ["Shopping cart management", "E-commerce checkout", "Cart operations", "Payment processing"]
|
|
14
|
+
* @workflow ["shopping-cart", "checkout-process", "e-commerce-operations", "payment-processing"]
|
|
15
|
+
* @functionalArea "e-commerce-and-cart-management"
|
|
16
|
+
* @businessRules ["Requires valid bearer authentication", "Shopping cart session management", "Checkout processing", "ERP integration"]
|
|
17
|
+
* @performance "Optimized for e-commerce workflows and cart operations"
|
|
7
18
|
* @example
|
|
8
19
|
* ```typescript
|
|
9
20
|
* import { HTTPClient } from '@augur/api-client/core';
|
|
@@ -12,85 +23,67 @@ import { CartHdrListParams, CartHdrLookupParams, CartHdrLookupResponse, CartLine
|
|
|
12
23
|
* const http = new HTTPClient('commerce', { siteId: 'your-site-id', bearerToken: 'your-token' });
|
|
13
24
|
* const commerce = new CommerceClient(http);
|
|
14
25
|
*
|
|
26
|
+
* // Check service health
|
|
27
|
+
* const health = await commerce.healthCheck.get();
|
|
28
|
+
* const healthData = await commerce.healthCheck.getData();
|
|
29
|
+
*
|
|
15
30
|
* // Create or lookup cart
|
|
16
|
-
* const cart = await commerce.
|
|
31
|
+
* const cart = await commerce.cartHdr.lookup.get({ userId: 12345, customerId: 456, contactId: 123 });
|
|
17
32
|
*
|
|
18
33
|
* // Add items to cart
|
|
19
|
-
* await commerce.
|
|
34
|
+
* await commerce.cartLine.add.create(cart.cartHdrUid, [{ invMastUid: 12345, quantity: 2, unitOfMeasure: 'EA' }]);
|
|
20
35
|
*
|
|
21
36
|
* // Create checkout
|
|
22
37
|
* const checkout = await commerce.checkout.create({ customer: {...}, payment: {...}, lineItems: [...] });
|
|
23
38
|
* ```
|
|
24
39
|
*/
|
|
25
40
|
export declare class CommerceClient extends BaseServiceClient {
|
|
26
|
-
/**
|
|
27
|
-
* Create a new CommerceClient instance
|
|
28
|
-
* @param http Configured HTTPClient instance
|
|
29
|
-
* @param baseUrl Base URL for the Commerce API (default: https://commerce.augur-api.com)
|
|
30
|
-
*/
|
|
31
41
|
constructor(http: HTTPClient, baseUrl?: string);
|
|
42
|
+
protected getServiceDescription(): string;
|
|
32
43
|
/**
|
|
33
|
-
*
|
|
34
|
-
* @description
|
|
44
|
+
* Health Check Operations
|
|
45
|
+
* @description System health monitoring and availability verification for Commerce service
|
|
35
46
|
*/
|
|
36
|
-
|
|
47
|
+
healthCheck: {
|
|
37
48
|
/**
|
|
38
|
-
*
|
|
49
|
+
* Check service health and availability
|
|
39
50
|
*
|
|
40
|
-
* @fullPath api.commerce.
|
|
51
|
+
* @fullPath api.commerce.healthCheck.get
|
|
41
52
|
* @service commerce
|
|
42
|
-
* @domain
|
|
43
|
-
* @dataMethod
|
|
53
|
+
* @domain system-health
|
|
54
|
+
* @dataMethod healthCheck.getData - returns only the health status data without metadata
|
|
44
55
|
* @discoverable true
|
|
45
|
-
* @searchTerms ["
|
|
46
|
-
* @relatedEndpoints ["api.commerce.
|
|
47
|
-
* @commonPatterns ["
|
|
48
|
-
* @workflow ["
|
|
49
|
-
* @prerequisites ["
|
|
50
|
-
* @nextSteps ["
|
|
51
|
-
* @businessRules ["Returns
|
|
52
|
-
* @functionalArea "
|
|
53
|
-
* @caching "
|
|
54
|
-
* @performance "
|
|
56
|
+
* @searchTerms ["health", "status", "availability", "ping", "check", "commerce service", "monitoring"]
|
|
57
|
+
* @relatedEndpoints ["api.commerce.cartHdr.list.get", "api.commerce.checkout.create", "api.avalara.healthCheck.get", "api.items.healthCheck.get"]
|
|
58
|
+
* @commonPatterns ["Health check", "Service status", "Commerce service availability", "System monitoring"]
|
|
59
|
+
* @workflow ["system-monitoring", "health-checks", "service-discovery", "commerce-service-verification"]
|
|
60
|
+
* @prerequisites ["Service is running", "Valid authentication token", "x-site-id header"]
|
|
61
|
+
* @nextSteps ["Use commerce endpoints if healthy", "Verify commerce service connectivity", "Monitor service metrics"]
|
|
62
|
+
* @businessRules ["Returns service status and site configuration", "Requires standard authentication", "Standard health check format"]
|
|
63
|
+
* @functionalArea "system-monitoring"
|
|
64
|
+
* @caching "No caching - real-time status required"
|
|
65
|
+
* @performance "Fast response, minimal processing, use for commerce service monitoring"
|
|
55
66
|
*
|
|
56
|
-
* @
|
|
57
|
-
* @param params User ID for filtering cart headers
|
|
58
|
-
* @returns Promise<BaseResponse<CartHdr[]>> Complete response with cart headers array and metadata
|
|
59
|
-
* @throws ValidationError When parameters are invalid or response is malformed
|
|
67
|
+
* @returns Promise<HealthCheckResponse> Service health status
|
|
60
68
|
*
|
|
61
69
|
* @example
|
|
62
70
|
* ```typescript
|
|
63
|
-
* //
|
|
64
|
-
* const response = await client.
|
|
65
|
-
* console.log(response.data); //
|
|
71
|
+
* // Check if commerce service is healthy
|
|
72
|
+
* const response = await client.healthCheck.get();
|
|
73
|
+
* console.log(response.data.siteId); // Site identifier
|
|
74
|
+
* console.log(response.status); // HTTP status code
|
|
66
75
|
*
|
|
67
|
-
* // Get just the
|
|
68
|
-
* const
|
|
69
|
-
*
|
|
76
|
+
* // Get just the health status
|
|
77
|
+
* const status = await client.healthCheck.getData();
|
|
78
|
+
* console.log(status); // Direct object access
|
|
70
79
|
* ```
|
|
71
80
|
*/
|
|
72
|
-
|
|
73
|
-
userId: number;
|
|
74
|
-
edgeCache?: 3 | 2 | 4 | 1 | "1" | 5 | 8 | "2" | "3" | "4" | "5" | "8" | undefined;
|
|
75
|
-
limit?: number | undefined;
|
|
76
|
-
offset?: number | undefined;
|
|
77
|
-
} | undefined) => Promise<{
|
|
81
|
+
get: () => Promise<{
|
|
78
82
|
params: Record<string, unknown> | unknown[];
|
|
79
83
|
data: {
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
userId: number;
|
|
84
|
-
userCartNo: number;
|
|
85
|
-
dateCreated?: string | undefined;
|
|
86
|
-
dateLastModified?: string | undefined;
|
|
87
|
-
statusCd?: number | undefined;
|
|
88
|
-
sessionId?: string | undefined;
|
|
89
|
-
emailAddress?: string | undefined;
|
|
90
|
-
cartToken?: string | null | undefined;
|
|
91
|
-
version?: number | undefined;
|
|
92
|
-
processCd?: number | undefined;
|
|
93
|
-
}[];
|
|
84
|
+
siteHash: string;
|
|
85
|
+
siteId: string;
|
|
86
|
+
};
|
|
94
87
|
options: Record<string, unknown> | unknown[];
|
|
95
88
|
status: number;
|
|
96
89
|
message: string;
|
|
@@ -99,202 +92,213 @@ export declare class CommerceClient extends BaseServiceClient {
|
|
|
99
92
|
totalResults: number;
|
|
100
93
|
}>;
|
|
101
94
|
/**
|
|
102
|
-
*
|
|
103
|
-
*
|
|
104
|
-
* @fullPath api.commerce.cartHeaders.lookup
|
|
105
|
-
* @service commerce
|
|
106
|
-
* @domain cart-management
|
|
107
|
-
* @dataMethod lookupData
|
|
108
|
-
* @discoverable true
|
|
109
|
-
* @searchTerms ["cart lookup", "find cart", "get cart", "cart token", "shopping cart", "user cart", "session cart"]
|
|
110
|
-
* @relatedEndpoints ["api.commerce.cartHeaders.list", "api.commerce.cartLines.get", "api.customers.customer.get", "api.joomla.users.get"]
|
|
111
|
-
* @commonPatterns ["Find user's active cart", "Get or create cart", "Resume shopping session", "Cart token validation"]
|
|
112
|
-
* @workflow ["cart-retrieval", "session-management", "cart-creation"]
|
|
113
|
-
* @prerequisites ["Valid authentication token", "Valid user, customer, and contact IDs"]
|
|
114
|
-
* @nextSteps ["api.commerce.cartLines.get for cart contents", "api.commerce.cartLines.add to add items"]
|
|
115
|
-
* @businessRules ["Creates new cart if none exists", "Returns existing cart if found", "Validates user permissions"]
|
|
116
|
-
* @functionalArea "cart-and-session-management"
|
|
117
|
-
* @caching "Cache for 5 minutes, invalidate on cart modifications"
|
|
118
|
-
* @performance "Fast lookup operation, includes cart creation logic"
|
|
119
|
-
*
|
|
120
|
-
* @description Looks up an existing cart or creates a new one for the specified user, customer, and contact
|
|
121
|
-
* @param params User, customer, and contact identifiers with optional cart token
|
|
122
|
-
* @returns Promise<BaseResponse<CartHdr>> Complete response with cart header details and metadata
|
|
123
|
-
* @throws ValidationError When parameters are invalid or response is malformed
|
|
124
|
-
*
|
|
125
|
-
* @example
|
|
126
|
-
* ```typescript
|
|
127
|
-
* // Lookup existing cart
|
|
128
|
-
* const response = await client.cartHeaders.lookup({
|
|
129
|
-
* userId: 12345,
|
|
130
|
-
* customerId: 456,
|
|
131
|
-
* contactId: 123,
|
|
132
|
-
* cartToken: 'abc123'
|
|
133
|
-
* });
|
|
134
|
-
* console.log(response.data.cartHdrUid);
|
|
135
|
-
*
|
|
136
|
-
* // Create new cart (data method)
|
|
137
|
-
* const cart = await client.cartHeaders.lookupData({
|
|
138
|
-
* userId: 12345,
|
|
139
|
-
* customerId: 456,
|
|
140
|
-
* contactId: 123
|
|
141
|
-
* });
|
|
142
|
-
* ```
|
|
95
|
+
* Get health check status data only
|
|
96
|
+
* @returns Promise<unknown> Health status data
|
|
143
97
|
*/
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
* @dataMethod getAlsoBoughtData
|
|
152
|
-
* @discoverable true
|
|
153
|
-
* @searchTerms ["recommendations", "also bought", "cross sell", "upsell", "related products", "suggestions", "shopping recommendations"]
|
|
154
|
-
* @relatedEndpoints ["api.commerce.cartLines.get", "api.items.products.list", "api.legacy.alsoBought.list"]
|
|
155
|
-
* @commonPatterns ["Get product recommendations", "Cross-sell products", "Increase cart value", "Related item suggestions"]
|
|
156
|
-
* @workflow ["recommendation-display", "cross-selling", "cart-enhancement"]
|
|
157
|
-
* @prerequisites ["Valid cart header UID", "Cart with existing items for best recommendations"]
|
|
158
|
-
* @nextSteps ["api.commerce.cartLines.add to add recommended items", "api.items.products.get for product details"]
|
|
159
|
-
* @businessRules ["Based on purchase history patterns", "Respects inventory availability", "Paginated results for performance"]
|
|
160
|
-
* @functionalArea "recommendation-and-cross-sell"
|
|
161
|
-
* @caching "Cache for 30 minutes, static recommendation data"
|
|
162
|
-
* @performance "Supports pagination with limit/offset, optimized for recommendation engine"
|
|
163
|
-
*
|
|
164
|
-
* @description Retrieves also-bought product recommendations based on items currently in the cart
|
|
165
|
-
* @param cartHdrUid Cart header unique identifier
|
|
166
|
-
* @param params Optional pagination parameters (limit, offset)
|
|
167
|
-
* @returns Promise<BaseResponse<AlsoBoughtItem[]>> Complete response with recommended products and pagination metadata
|
|
168
|
-
* @throws ValidationError When parameters are invalid or response is malformed
|
|
169
|
-
*
|
|
170
|
-
* @example
|
|
171
|
-
* ```typescript
|
|
172
|
-
* // Get recommendations with pagination
|
|
173
|
-
* const response = await client.cartHeaders.getAlsoBought(789, { limit: 5, offset: 0 });
|
|
174
|
-
* console.log(`Found ${response.total} recommendations, showing ${response.count}`);
|
|
175
|
-
* response.data.forEach(item => console.log(item.itemId, item.description, item.price));
|
|
176
|
-
*
|
|
177
|
-
* // Get just the data array
|
|
178
|
-
* const recommendations = await client.cartHeaders.getAlsoBoughtData(789, { limit: 10 });
|
|
179
|
-
* ```
|
|
180
|
-
*/
|
|
181
|
-
getAlsoBought: (cartHdrUid: number, params?: AlsoBoughtParams) => Promise<AlsoBoughtResponse>;
|
|
98
|
+
getData: () => Promise<unknown>;
|
|
99
|
+
};
|
|
100
|
+
/**
|
|
101
|
+
* Cart Header Operations
|
|
102
|
+
* @description Cart header management and session tracking functionality
|
|
103
|
+
*/
|
|
104
|
+
cartHdr: {
|
|
182
105
|
/**
|
|
183
|
-
*
|
|
184
|
-
* @description
|
|
185
|
-
* @param params User ID for filtering cart headers
|
|
186
|
-
* @returns Array of cart headers for the user
|
|
106
|
+
* List Operations
|
|
107
|
+
* @description Cart header list functionality for user cart retrieval
|
|
187
108
|
*/
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
109
|
+
list: {
|
|
110
|
+
/**
|
|
111
|
+
* Retrieve a list of cart headers for a specific user
|
|
112
|
+
*
|
|
113
|
+
* @fullPath api.commerce.cartHdr.list.get
|
|
114
|
+
* @service commerce
|
|
115
|
+
* @domain cart-management
|
|
116
|
+
* @dataMethod cartHdr.list.getData - returns only the cart headers data without metadata
|
|
117
|
+
* @discoverable true
|
|
118
|
+
* @searchTerms ["cart", "list", "shopping cart", "user carts", "cart headers", "session", "baskets"]
|
|
119
|
+
* @relatedEndpoints ["api.commerce.cartLine.get", "api.commerce.cartHdr.lookup.get", "api.customers.customer.list", "api.joomla.users.list"]
|
|
120
|
+
* @commonPatterns ["Get all user carts", "List shopping carts", "Find user sessions", "Shopping cart history"]
|
|
121
|
+
* @workflow ["cart-management", "session-tracking", "user-cart-retrieval"]
|
|
122
|
+
* @prerequisites ["Valid authentication token", "Valid user ID", "Cart management permissions"]
|
|
123
|
+
* @nextSteps ["api.commerce.cartLine.get for cart contents", "api.commerce.cartHdr.lookup.get for specific cart"]
|
|
124
|
+
* @businessRules ["Returns only carts accessible to current user", "Respects user permissions", "Includes abandoned carts"]
|
|
125
|
+
* @functionalArea "cart-and-session-management"
|
|
126
|
+
* @caching "Cache for 2 minutes, invalidate on cart changes"
|
|
127
|
+
* @performance "Lightweight operation, pagination not required for typical usage"
|
|
128
|
+
*
|
|
129
|
+
* @description Returns all cart headers associated with a user ID for session management and cart recovery
|
|
130
|
+
* @param params User ID for filtering cart headers
|
|
131
|
+
* @returns Promise<CartHdrListResponse> Complete response with cart headers array and metadata
|
|
132
|
+
* @throws ValidationError When parameters are invalid or response is malformed
|
|
133
|
+
*
|
|
134
|
+
* @example
|
|
135
|
+
* ```typescript
|
|
136
|
+
* // Get all carts for a user
|
|
137
|
+
* const response = await client.cartHdr.list.get({ userId: 12345 });
|
|
138
|
+
* console.log(response.data); // CartHdr[]
|
|
139
|
+
*
|
|
140
|
+
* // Get just the data array
|
|
141
|
+
* const carts = await client.cartHdr.list.getData({ userId: 12345 });
|
|
142
|
+
* carts.forEach(cart => console.log(cart.cartHdrUid, cart.cartToken));
|
|
143
|
+
* ```
|
|
144
|
+
*/
|
|
145
|
+
get: (params: CartHdrListParams) => Promise<{
|
|
146
|
+
params: Record<string, unknown> | unknown[];
|
|
147
|
+
data: {
|
|
148
|
+
cartHdrUid: number;
|
|
149
|
+
customerId: number;
|
|
150
|
+
contactId: number;
|
|
151
|
+
userId: number;
|
|
152
|
+
userCartNo: number;
|
|
153
|
+
dateCreated?: string | undefined;
|
|
154
|
+
dateLastModified?: string | undefined;
|
|
155
|
+
statusCd?: number | undefined;
|
|
156
|
+
sessionId?: string | undefined;
|
|
157
|
+
emailAddress?: string | undefined;
|
|
158
|
+
cartToken?: string | null | undefined;
|
|
159
|
+
version?: number | undefined;
|
|
160
|
+
processCd?: number | undefined;
|
|
161
|
+
}[];
|
|
162
|
+
options: Record<string, unknown> | unknown[];
|
|
163
|
+
status: number;
|
|
164
|
+
message: string;
|
|
165
|
+
count: number;
|
|
166
|
+
total: number;
|
|
167
|
+
totalResults: number;
|
|
168
|
+
}>;
|
|
169
|
+
/**
|
|
170
|
+
* Get list of cart headers data only
|
|
171
|
+
* @param params User ID for filtering cart headers
|
|
172
|
+
* @returns Promise<unknown[]> Array of cart headers for the user
|
|
173
|
+
*/
|
|
174
|
+
getData: (params: CartHdrListParams) => Promise<unknown[]>;
|
|
175
|
+
};
|
|
203
176
|
/**
|
|
204
|
-
* Lookup
|
|
205
|
-
* @description
|
|
206
|
-
* @param params User, customer, and contact identifiers with optional cart token
|
|
207
|
-
* @returns Cart header details
|
|
177
|
+
* Lookup Operations
|
|
178
|
+
* @description Cart header lookup functionality for cart retrieval or creation
|
|
208
179
|
*/
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
180
|
+
lookup: {
|
|
181
|
+
/**
|
|
182
|
+
* Lookup an existing cart or create a new one
|
|
183
|
+
*
|
|
184
|
+
* @fullPath api.commerce.cartHdr.lookup.get
|
|
185
|
+
* @service commerce
|
|
186
|
+
* @domain cart-management
|
|
187
|
+
* @dataMethod cartHdr.lookup.getData - returns only the cart header data without metadata
|
|
188
|
+
* @discoverable true
|
|
189
|
+
* @searchTerms ["cart lookup", "find cart", "get cart", "cart token", "shopping cart", "user cart", "session cart"]
|
|
190
|
+
* @relatedEndpoints ["api.commerce.cartHdr.list.get", "api.commerce.cartLine.get", "api.customers.customer.get", "api.joomla.users.get"]
|
|
191
|
+
* @commonPatterns ["Find user's active cart", "Get or create cart", "Resume shopping session", "Cart token validation"]
|
|
192
|
+
* @workflow ["cart-retrieval", "session-management", "cart-creation"]
|
|
193
|
+
* @prerequisites ["Valid authentication token", "Valid user, customer, and contact IDs"]
|
|
194
|
+
* @nextSteps ["api.commerce.cartLine.get for cart contents", "api.commerce.cartLine.add.create to add items"]
|
|
195
|
+
* @businessRules ["Creates new cart if none exists", "Returns existing cart if found", "Validates user permissions"]
|
|
196
|
+
* @functionalArea "cart-and-session-management"
|
|
197
|
+
* @caching "Cache for 5 minutes, invalidate on cart modifications"
|
|
198
|
+
* @performance "Fast lookup operation, includes cart creation logic"
|
|
199
|
+
*
|
|
200
|
+
* @description Looks up an existing cart or creates a new one for the specified user, customer, and contact
|
|
201
|
+
* @param params User, customer, and contact identifiers with optional cart token
|
|
202
|
+
* @returns Promise<CartHdrLookupResponse> Complete response with cart header details and metadata
|
|
203
|
+
* @throws ValidationError When parameters are invalid or response is malformed
|
|
204
|
+
*
|
|
205
|
+
* @example
|
|
206
|
+
* ```typescript
|
|
207
|
+
* // Lookup existing cart
|
|
208
|
+
* const response = await client.cartHdr.lookup.get({
|
|
209
|
+
* userId: 12345,
|
|
210
|
+
* customerId: 456,
|
|
211
|
+
* contactId: 123,
|
|
212
|
+
* cartToken: 'abc123'
|
|
213
|
+
* });
|
|
214
|
+
* console.log(response.data.cartHdrUid);
|
|
215
|
+
*
|
|
216
|
+
* // Create new cart (data method)
|
|
217
|
+
* const cart = await client.cartHdr.lookup.getData({
|
|
218
|
+
* userId: 12345,
|
|
219
|
+
* customerId: 456,
|
|
220
|
+
* contactId: 123
|
|
221
|
+
* });
|
|
222
|
+
* ```
|
|
223
|
+
*/
|
|
224
|
+
get: (params: CartHdrLookupParams) => Promise<CartHdrLookupResponse>;
|
|
225
|
+
/**
|
|
226
|
+
* Lookup cart header data only
|
|
227
|
+
* @param params User, customer, and contact identifiers with optional cart token
|
|
228
|
+
* @returns Promise<unknown> Cart header details
|
|
229
|
+
*/
|
|
230
|
+
getData: (params: CartHdrLookupParams) => Promise<unknown>;
|
|
231
|
+
};
|
|
224
232
|
/**
|
|
225
|
-
*
|
|
226
|
-
* @description
|
|
227
|
-
* @param cartHdrUid Cart header unique identifier
|
|
228
|
-
* @param params Optional pagination parameters
|
|
229
|
-
* @returns Array of recommended products
|
|
233
|
+
* Also Bought Operations
|
|
234
|
+
* @description Product recommendation functionality based on cart contents
|
|
230
235
|
*/
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
}[]>;
|
|
236
|
+
alsoBought: {
|
|
237
|
+
/**
|
|
238
|
+
* Get product recommendations based on cart contents
|
|
239
|
+
*
|
|
240
|
+
* @fullPath api.commerce.cartHdr.alsoBought.get
|
|
241
|
+
* @service commerce
|
|
242
|
+
* @domain recommendation-engine
|
|
243
|
+
* @dataMethod cartHdr.alsoBought.getData - returns only the recommendations data without metadata
|
|
244
|
+
* @discoverable true
|
|
245
|
+
* @searchTerms ["recommendations", "also bought", "cross sell", "upsell", "related products", "suggestions", "shopping recommendations"]
|
|
246
|
+
* @relatedEndpoints ["api.commerce.cartLine.get", "api.items.products.list", "api.legacy.alsoBought.list"]
|
|
247
|
+
* @commonPatterns ["Get product recommendations", "Cross-sell products", "Increase cart value", "Related item suggestions"]
|
|
248
|
+
* @workflow ["recommendation-display", "cross-selling", "cart-enhancement"]
|
|
249
|
+
* @prerequisites ["Valid cart header UID", "Cart with existing items for best recommendations"]
|
|
250
|
+
* @nextSteps ["api.commerce.cartLine.add.create to add recommended items", "api.items.products.get for product details"]
|
|
251
|
+
* @businessRules ["Based on purchase history patterns", "Respects inventory availability", "Paginated results for performance"]
|
|
252
|
+
* @functionalArea "recommendation-and-cross-sell"
|
|
253
|
+
* @caching "Cache for 30 minutes, static recommendation data"
|
|
254
|
+
* @performance "Supports pagination with limit/offset, optimized for recommendation engine"
|
|
255
|
+
*
|
|
256
|
+
* @description Retrieves also-bought product recommendations based on items currently in the cart
|
|
257
|
+
* @param cartHdrUid Cart header unique identifier
|
|
258
|
+
* @param params Optional pagination parameters (limit, offset)
|
|
259
|
+
* @returns Promise<AlsoBoughtResponse> Complete response with recommended products and pagination metadata
|
|
260
|
+
* @throws ValidationError When parameters are invalid or response is malformed
|
|
261
|
+
*
|
|
262
|
+
* @example
|
|
263
|
+
* ```typescript
|
|
264
|
+
* // Get recommendations with pagination
|
|
265
|
+
* const response = await client.cartHdr.alsoBought.get(789, { limit: 5, offset: 0 });
|
|
266
|
+
* console.log(`Found ${response.total} recommendations, showing ${response.count}`);
|
|
267
|
+
* response.data.forEach(item => console.log(item.itemId, item.description, item.price));
|
|
268
|
+
*
|
|
269
|
+
* // Get just the data array
|
|
270
|
+
* const recommendations = await client.cartHdr.alsoBought.getData(789, { limit: 10 });
|
|
271
|
+
* ```
|
|
272
|
+
*/
|
|
273
|
+
get: (cartHdrUid: number, params?: AlsoBoughtParams) => Promise<AlsoBoughtResponse>;
|
|
274
|
+
/**
|
|
275
|
+
* Get also bought recommendations data only
|
|
276
|
+
* @param cartHdrUid Cart header unique identifier
|
|
277
|
+
* @param params Optional pagination parameters
|
|
278
|
+
* @returns Promise<unknown[]> Array of recommended products
|
|
279
|
+
*/
|
|
280
|
+
getData: (cartHdrUid: number, params?: AlsoBoughtParams) => Promise<unknown[]>;
|
|
281
|
+
};
|
|
278
282
|
};
|
|
279
283
|
/**
|
|
280
|
-
* Cart Line
|
|
281
|
-
* @description
|
|
284
|
+
* Cart Line Operations
|
|
285
|
+
* @description Cart line management for individual items within shopping carts
|
|
282
286
|
*/
|
|
283
|
-
|
|
287
|
+
cartLine: {
|
|
284
288
|
/**
|
|
285
289
|
* Retrieve all line items for a specific cart
|
|
286
290
|
*
|
|
287
|
-
* @fullPath api.commerce.
|
|
291
|
+
* @fullPath api.commerce.cartLine.get
|
|
288
292
|
* @service commerce
|
|
289
293
|
* @domain cart-management
|
|
290
|
-
* @dataMethod getData
|
|
294
|
+
* @dataMethod cartLine.getData - returns only the cart line data without metadata
|
|
291
295
|
* @discoverable true
|
|
292
296
|
* @searchTerms ["cart lines", "cart items", "line items", "cart contents", "shopping cart items", "cart products"]
|
|
293
|
-
* @relatedEndpoints ["api.commerce.
|
|
297
|
+
* @relatedEndpoints ["api.commerce.cartHdr.lookup.get", "api.items.products.get", "api.commerce.cartLine.add.create", "api.commerce.cartLine.update.create"]
|
|
294
298
|
* @commonPatterns ["View cart contents", "Get cart line items", "Display shopping cart", "Cart item details"]
|
|
295
299
|
* @workflow ["cart-display", "cart-review", "checkout-preparation"]
|
|
296
300
|
* @prerequisites ["Valid cart header UID", "Cart must exist"]
|
|
297
|
-
* @nextSteps ["api.commerce.
|
|
301
|
+
* @nextSteps ["api.commerce.cartLine.update.create to modify items", "api.commerce.checkout.create to proceed to checkout"]
|
|
298
302
|
* @businessRules ["Returns all line items in cart", "Includes product details and pricing", "Ordered by line number"]
|
|
299
303
|
* @functionalArea "cart-and-session-management"
|
|
300
304
|
* @caching "Cache for 2 minutes, invalidate on cart modifications"
|
|
@@ -302,22 +306,22 @@ export declare class CommerceClient extends BaseServiceClient {
|
|
|
302
306
|
*
|
|
303
307
|
* @description Returns all line items in a cart with product details, quantities, and pricing
|
|
304
308
|
* @param cartHdrUid Cart header unique identifier
|
|
305
|
-
* @returns Promise<
|
|
309
|
+
* @returns Promise<CartLineListResponse> Complete response with cart line items and metadata
|
|
306
310
|
* @throws ValidationError When response is malformed
|
|
307
311
|
*
|
|
308
312
|
* @example
|
|
309
313
|
* ```typescript
|
|
310
314
|
* // Get cart line items
|
|
311
|
-
* const response = await client.
|
|
315
|
+
* const response = await client.cartLine.get(789);
|
|
312
316
|
* response.data.forEach(line => {
|
|
313
317
|
* console.log(`Line ${line.lineNo}: ${line.quantity} x ${line.itemId} @ $${line.unitPrice}`);
|
|
314
318
|
* });
|
|
315
319
|
*
|
|
316
320
|
* // Get just the data array
|
|
317
|
-
* const lines = await client.
|
|
321
|
+
* const lines = await client.cartLine.getData(789);
|
|
318
322
|
* ```
|
|
319
323
|
*/
|
|
320
|
-
get: (
|
|
324
|
+
get: (cartHdrUid: number) => Promise<{
|
|
321
325
|
params: Record<string, unknown> | unknown[];
|
|
322
326
|
data: {
|
|
323
327
|
lineNo: number;
|
|
@@ -342,191 +346,258 @@ export declare class CommerceClient extends BaseServiceClient {
|
|
|
342
346
|
totalResults: number;
|
|
343
347
|
}>;
|
|
344
348
|
/**
|
|
345
|
-
*
|
|
349
|
+
* Remove all line items from the cart
|
|
346
350
|
*
|
|
347
|
-
* @fullPath api.commerce.
|
|
351
|
+
* @fullPath api.commerce.cartLine.delete
|
|
348
352
|
* @service commerce
|
|
349
353
|
* @domain cart-management
|
|
350
|
-
* @dataMethod
|
|
354
|
+
* @dataMethod cartLine.deleteData - returns only the delete result data without metadata
|
|
351
355
|
* @discoverable true
|
|
352
|
-
* @searchTerms ["
|
|
353
|
-
* @relatedEndpoints ["api.commerce.
|
|
354
|
-
* @commonPatterns ["
|
|
355
|
-
* @workflow ["
|
|
356
|
-
* @prerequisites ["Valid cart header UID", "
|
|
357
|
-
* @nextSteps ["api.commerce.
|
|
358
|
-
* @businessRules ["
|
|
356
|
+
* @searchTerms ["clear cart", "delete cart lines", "remove all items", "empty cart", "cart clear"]
|
|
357
|
+
* @relatedEndpoints ["api.commerce.cartLine.get", "api.commerce.cartLine.lines.delete", "api.commerce.cartHdr.lookup.get"]
|
|
358
|
+
* @commonPatterns ["Clear cart contents", "Remove all items", "Empty shopping cart", "Reset cart"]
|
|
359
|
+
* @workflow ["cart-clearing", "cart-reset", "cart-management"]
|
|
360
|
+
* @prerequisites ["Valid cart header UID", "Cart must exist"]
|
|
361
|
+
* @nextSteps ["api.commerce.cartLine.add.create to add new items", "api.commerce.cartHdr.lookup.get to verify empty cart"]
|
|
362
|
+
* @businessRules ["Removes all line items from cart", "Preserves cart header", "Updates cart totals"]
|
|
359
363
|
* @functionalArea "cart-and-session-management"
|
|
360
364
|
* @caching "No caching, immediate cart modification"
|
|
361
|
-
* @performance "
|
|
362
|
-
*
|
|
363
|
-
* @description Adds line items to the shopping cart with automatic quantity aggregation for matching items
|
|
364
|
-
* @param cartHdrUid Cart header unique identifier
|
|
365
|
-
* @param items Array of cart line items to add
|
|
366
|
-
* @returns Promise<BaseResponse<boolean>> Complete response with success status and metadata
|
|
367
|
-
* @throws ValidationError When request is invalid or response is malformed
|
|
365
|
+
* @performance "Fast bulk delete operation"
|
|
368
366
|
*
|
|
369
|
-
* @example
|
|
370
|
-
* ```typescript
|
|
371
|
-
* // Add multiple items to cart
|
|
372
|
-
* const response = await client.cartLines.add(789, [
|
|
373
|
-
* {
|
|
374
|
-
* invMastUid: 12345,
|
|
375
|
-
* quantity: 2.0,
|
|
376
|
-
* unitOfMeasure: 'EA',
|
|
377
|
-
* lineNote: 'Rush order',
|
|
378
|
-
* unitPrice: 29.99
|
|
379
|
-
* },
|
|
380
|
-
* {
|
|
381
|
-
* invMastUid: 67890,
|
|
382
|
-
* quantity: 1.0,
|
|
383
|
-
* unitOfMeasure: 'LB'
|
|
384
|
-
* }
|
|
385
|
-
* ]);
|
|
386
|
-
*
|
|
387
|
-
* // Get just the success boolean
|
|
388
|
-
* const success = await client.cartLines.addData(789, items);
|
|
389
|
-
* ```
|
|
390
|
-
*/
|
|
391
|
-
add: (cartHdrUid: number, items: CartLineAddRequest) => Promise<CartLineModifyResponse>;
|
|
392
|
-
/**
|
|
393
|
-
* Update quantities or details for existing cart line items
|
|
394
|
-
* @description Updates existing line items in the cart with new quantities, notes, or other modifications
|
|
395
|
-
* @param cartHdrUid Cart header unique identifier
|
|
396
|
-
* @param items Array of cart line items to update (must specify lineNo or key for identification)
|
|
397
|
-
* @returns Boolean indicating successful update
|
|
398
|
-
* @throws ValidationError When request is invalid or response is malformed
|
|
399
|
-
* @example
|
|
400
|
-
* ```typescript
|
|
401
|
-
* const success = await client.cartLines.update(789, [
|
|
402
|
-
* {
|
|
403
|
-
* lineNo: 1,
|
|
404
|
-
* quantity: 5.0,
|
|
405
|
-
* lineNote: 'Updated quantity to 5'
|
|
406
|
-
* },
|
|
407
|
-
* {
|
|
408
|
-
* key: 'unique-key-123',
|
|
409
|
-
* quantity: 3.0
|
|
410
|
-
* }
|
|
411
|
-
* ]);
|
|
412
|
-
* ```
|
|
413
|
-
*/
|
|
414
|
-
update: (cartHdrUid: number, items: CartLineUpdateRequest) => Promise<CartLineModifyResponse>;
|
|
415
|
-
/**
|
|
416
|
-
* Remove all line items from the cart
|
|
417
367
|
* @description Clears all line items from the specified cart, leaving the cart header intact
|
|
418
368
|
* @param cartHdrUid Cart header unique identifier
|
|
419
|
-
* @returns
|
|
369
|
+
* @returns Promise<CartLineModifyResponse> Complete response with deletion status and metadata
|
|
420
370
|
* @throws ValidationError When response is malformed
|
|
371
|
+
*
|
|
421
372
|
* @example
|
|
422
373
|
* ```typescript
|
|
423
|
-
*
|
|
424
|
-
*
|
|
374
|
+
* // Clear all items from cart
|
|
375
|
+
* const response = await client.cartLine.delete(789);
|
|
376
|
+
* if (response.data.success) {
|
|
425
377
|
* console.log('Cart has been cleared of all items');
|
|
426
378
|
* }
|
|
379
|
+
*
|
|
380
|
+
* // Get just the result data
|
|
381
|
+
* const result = await client.cartLine.deleteData(789);
|
|
427
382
|
* ```
|
|
428
383
|
*/
|
|
429
|
-
|
|
430
|
-
params: Record<string, unknown> | unknown[];
|
|
431
|
-
data: boolean;
|
|
432
|
-
options: Record<string, unknown> | unknown[];
|
|
433
|
-
status: number;
|
|
434
|
-
message: string;
|
|
435
|
-
count: number;
|
|
436
|
-
total: number;
|
|
437
|
-
totalResults: number;
|
|
438
|
-
}>;
|
|
439
|
-
/**
|
|
440
|
-
* Remove a specific line item from the cart
|
|
441
|
-
* @description Removes a single line item from the cart by line number
|
|
442
|
-
* @param cartHdrUid Cart header unique identifier
|
|
443
|
-
* @param lineNo Line number to delete
|
|
444
|
-
* @returns Boolean indicating successful deletion
|
|
445
|
-
* @throws ValidationError When response is malformed
|
|
446
|
-
* @example
|
|
447
|
-
* ```typescript
|
|
448
|
-
* const success = await client.cartLines.deleteLine(789, 1);
|
|
449
|
-
* if (success) {
|
|
450
|
-
* console.log('Line item 1 has been removed from cart');
|
|
451
|
-
* }
|
|
452
|
-
* ```
|
|
453
|
-
*/
|
|
454
|
-
deleteLine: (cartHdrUid: number, lineNo: number) => Promise<CartLineDeleteResponse>;
|
|
384
|
+
delete: (cartHdrUid: number) => Promise<CartLineModifyResponse>;
|
|
455
385
|
/**
|
|
456
|
-
*
|
|
457
|
-
* @description
|
|
458
|
-
* @param cartHdrUid Cart header unique identifier
|
|
459
|
-
* @returns Array of cart line items (data only)
|
|
460
|
-
* @throws ValidationError When response is malformed
|
|
386
|
+
* Add Operations
|
|
387
|
+
* @description Cart line addition functionality for adding items to cart
|
|
461
388
|
*/
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
|
|
389
|
+
add: {
|
|
390
|
+
/**
|
|
391
|
+
* Add one or more items to the cart
|
|
392
|
+
*
|
|
393
|
+
* @fullPath api.commerce.cartLine.add.create
|
|
394
|
+
* @service commerce
|
|
395
|
+
* @domain cart-management
|
|
396
|
+
* @dataMethod cartLine.add.getData - returns only the addition result data without metadata
|
|
397
|
+
* @discoverable true
|
|
398
|
+
* @searchTerms ["add to cart", "cart add", "add items", "shopping cart add", "add products", "cart line add"]
|
|
399
|
+
* @relatedEndpoints ["api.commerce.cartLine.get", "api.commerce.cartLine.update.create", "api.items.products.get", "api.pricing.pricing.calculate"]
|
|
400
|
+
* @commonPatterns ["Add item to cart", "Add multiple items", "Bulk add to cart", "Shopping cart addition"]
|
|
401
|
+
* @workflow ["product-to-cart", "shopping-flow", "cart-building"]
|
|
402
|
+
* @prerequisites ["Valid cart header UID", "Valid product inventory UIDs", "Items must be available"]
|
|
403
|
+
* @nextSteps ["api.commerce.cartLine.get to view updated cart", "api.commerce.checkout.create to proceed to checkout"]
|
|
404
|
+
* @businessRules ["Aggregates quantities for duplicate items", "Validates inventory availability", "Applies pricing rules"]
|
|
405
|
+
* @functionalArea "cart-and-session-management"
|
|
406
|
+
* @caching "No caching, immediate cart modification"
|
|
407
|
+
* @performance "Batch operation for multiple items, validates inventory in bulk"
|
|
408
|
+
*
|
|
409
|
+
* @description Adds line items to the shopping cart with automatic quantity aggregation for matching items
|
|
410
|
+
* @param cartHdrUid Cart header unique identifier
|
|
411
|
+
* @param items Array of cart line items to add
|
|
412
|
+
* @returns Promise<CartLineModifyResponse> Complete response with addition status and metadata
|
|
413
|
+
* @throws ValidationError When request is invalid or response is malformed
|
|
414
|
+
*
|
|
415
|
+
* @example
|
|
416
|
+
* ```typescript
|
|
417
|
+
* // Add multiple items to cart
|
|
418
|
+
* const response = await client.cartLine.add.create(789, [
|
|
419
|
+
* {
|
|
420
|
+
* invMastUid: 12345,
|
|
421
|
+
* quantity: 2.0,
|
|
422
|
+
* unitOfMeasure: 'EA',
|
|
423
|
+
* lineNote: 'Rush order',
|
|
424
|
+
* unitPrice: 29.99
|
|
425
|
+
* },
|
|
426
|
+
* {
|
|
427
|
+
* invMastUid: 67890,
|
|
428
|
+
* quantity: 1.0,
|
|
429
|
+
* unitOfMeasure: 'LB'
|
|
430
|
+
* }
|
|
431
|
+
* ]);
|
|
432
|
+
*
|
|
433
|
+
* // Get just the success result
|
|
434
|
+
* const result = await client.cartLine.add.getData(789, items);
|
|
435
|
+
* ```
|
|
436
|
+
*/
|
|
437
|
+
create: (cartHdrUid: number, items: CartLineAddRequest) => Promise<CartLineModifyResponse>;
|
|
438
|
+
/**
|
|
439
|
+
* Add items to cart data only
|
|
440
|
+
* @param cartHdrUid Cart header unique identifier
|
|
441
|
+
* @param items Array of cart line items to add
|
|
442
|
+
* @returns Promise<unknown> Addition result data only
|
|
443
|
+
*/
|
|
444
|
+
getData: (cartHdrUid: number, items: CartLineAddRequest) => Promise<unknown>;
|
|
445
|
+
};
|
|
477
446
|
/**
|
|
478
|
-
*
|
|
479
|
-
* @description
|
|
480
|
-
* @param cartHdrUid Cart header unique identifier
|
|
481
|
-
* @param items Array of cart line items to add
|
|
482
|
-
* @returns Addition result (data only)
|
|
483
|
-
* @throws ValidationError When request is invalid or response is malformed
|
|
447
|
+
* Lines Operations
|
|
448
|
+
* @description Individual cart line management functionality
|
|
484
449
|
*/
|
|
485
|
-
|
|
450
|
+
lines: {
|
|
451
|
+
/**
|
|
452
|
+
* Remove a specific line item from the cart
|
|
453
|
+
*
|
|
454
|
+
* @fullPath api.commerce.cartLine.lines.delete
|
|
455
|
+
* @service commerce
|
|
456
|
+
* @domain cart-management
|
|
457
|
+
* @dataMethod cartLine.lines.deleteData - returns only the deletion result data without metadata
|
|
458
|
+
* @discoverable true
|
|
459
|
+
* @searchTerms ["remove line item", "delete cart line", "remove item", "cart item delete", "line delete"]
|
|
460
|
+
* @relatedEndpoints ["api.commerce.cartLine.get", "api.commerce.cartLine.delete", "api.commerce.cartLine.update.create"]
|
|
461
|
+
* @commonPatterns ["Remove specific item", "Delete cart line", "Remove line by number", "Item removal"]
|
|
462
|
+
* @workflow ["cart-modification", "item-removal", "cart-management"]
|
|
463
|
+
* @prerequisites ["Valid cart header UID", "Valid line number", "Line must exist"]
|
|
464
|
+
* @nextSteps ["api.commerce.cartLine.get to view updated cart", "api.commerce.cartLine.add.create to add replacement items"]
|
|
465
|
+
* @businessRules ["Removes single line item", "Updates cart totals", "Preserves other line items"]
|
|
466
|
+
* @functionalArea "cart-and-session-management"
|
|
467
|
+
* @caching "No caching, immediate cart modification"
|
|
468
|
+
* @performance "Fast single line deletion"
|
|
469
|
+
*
|
|
470
|
+
* @description Removes a single line item from the cart by line number
|
|
471
|
+
* @param cartHdrUid Cart header unique identifier
|
|
472
|
+
* @param lineNo Line number to delete
|
|
473
|
+
* @returns Promise<CartLineDeleteResponse> Complete response with deletion status and metadata
|
|
474
|
+
* @throws ValidationError When response is malformed
|
|
475
|
+
*
|
|
476
|
+
* @example
|
|
477
|
+
* ```typescript
|
|
478
|
+
* // Remove specific line item
|
|
479
|
+
* const response = await client.cartLine.lines.delete(789, 1);
|
|
480
|
+
* if (response.data.success) {
|
|
481
|
+
* console.log('Line item 1 has been removed from cart');
|
|
482
|
+
* }
|
|
483
|
+
*
|
|
484
|
+
* // Get just the result data
|
|
485
|
+
* const result = await client.cartLine.lines.deleteData(789, 1);
|
|
486
|
+
* ```
|
|
487
|
+
*/
|
|
488
|
+
delete: (cartHdrUid: number, lineNo: number) => Promise<CartLineDeleteResponse>;
|
|
489
|
+
/**
|
|
490
|
+
* Delete specific cart line item data only
|
|
491
|
+
* @param cartHdrUid Cart header unique identifier
|
|
492
|
+
* @param lineNo Line number to delete
|
|
493
|
+
* @returns Promise<unknown> Deletion result data only
|
|
494
|
+
*/
|
|
495
|
+
deleteData: (cartHdrUid: number, lineNo: number) => Promise<unknown>;
|
|
496
|
+
};
|
|
486
497
|
/**
|
|
487
|
-
* Update
|
|
488
|
-
* @description
|
|
489
|
-
* @param cartHdrUid Cart header unique identifier
|
|
490
|
-
* @param items Array of cart line items to update
|
|
491
|
-
* @returns Update result (data only)
|
|
492
|
-
* @throws ValidationError When request is invalid or response is malformed
|
|
498
|
+
* Update Operations
|
|
499
|
+
* @description Cart line update functionality for modifying existing items
|
|
493
500
|
*/
|
|
494
|
-
|
|
501
|
+
update: {
|
|
502
|
+
/**
|
|
503
|
+
* Update quantities or details for existing cart line items
|
|
504
|
+
*
|
|
505
|
+
* @fullPath api.commerce.cartLine.update.create
|
|
506
|
+
* @service commerce
|
|
507
|
+
* @domain cart-management
|
|
508
|
+
* @dataMethod cartLine.update.getData - returns only the update result data without metadata
|
|
509
|
+
* @discoverable true
|
|
510
|
+
* @searchTerms ["update cart line", "modify cart items", "change quantity", "update line items", "cart modification"]
|
|
511
|
+
* @relatedEndpoints ["api.commerce.cartLine.get", "api.commerce.cartLine.add.create", "api.commerce.cartLine.lines.delete"]
|
|
512
|
+
* @commonPatterns ["Update item quantity", "Modify cart items", "Change line details", "Cart item updates"]
|
|
513
|
+
* @workflow ["cart-modification", "quantity-updates", "cart-management"]
|
|
514
|
+
* @prerequisites ["Valid cart header UID", "Valid line identification", "Items must exist in cart"]
|
|
515
|
+
* @nextSteps ["api.commerce.cartLine.get to view updated cart", "api.commerce.checkout.create to proceed to checkout"]
|
|
516
|
+
* @businessRules ["Updates existing line items only", "Validates quantity changes", "Recalculates pricing"]
|
|
517
|
+
* @functionalArea "cart-and-session-management"
|
|
518
|
+
* @caching "No caching, immediate cart modification"
|
|
519
|
+
* @performance "Batch operation for multiple line updates"
|
|
520
|
+
*
|
|
521
|
+
* @description Updates existing line items in the cart with new quantities, notes, or other modifications
|
|
522
|
+
* @param cartHdrUid Cart header unique identifier
|
|
523
|
+
* @param items Array of cart line items to update (must specify lineNo or key for identification)
|
|
524
|
+
* @returns Promise<CartLineModifyResponse> Complete response with update status and metadata
|
|
525
|
+
* @throws ValidationError When request is invalid or response is malformed
|
|
526
|
+
*
|
|
527
|
+
* @example
|
|
528
|
+
* ```typescript
|
|
529
|
+
* // Update multiple line items
|
|
530
|
+
* const response = await client.cartLine.update.create(789, [
|
|
531
|
+
* {
|
|
532
|
+
* lineNo: 1,
|
|
533
|
+
* quantity: 5.0,
|
|
534
|
+
* lineNote: 'Updated quantity to 5'
|
|
535
|
+
* },
|
|
536
|
+
* {
|
|
537
|
+
* key: 'unique-key-123',
|
|
538
|
+
* quantity: 3.0
|
|
539
|
+
* }
|
|
540
|
+
* ]);
|
|
541
|
+
*
|
|
542
|
+
* // Get just the update result
|
|
543
|
+
* const result = await client.cartLine.update.getData(789, items);
|
|
544
|
+
* ```
|
|
545
|
+
*/
|
|
546
|
+
create: (cartHdrUid: number, items: CartLineUpdateRequest) => Promise<CartLineModifyResponse>;
|
|
547
|
+
/**
|
|
548
|
+
* Update cart line items data only
|
|
549
|
+
* @param cartHdrUid Cart header unique identifier
|
|
550
|
+
* @param items Array of cart line items to update
|
|
551
|
+
* @returns Promise<unknown> Update result data only
|
|
552
|
+
*/
|
|
553
|
+
getData: (cartHdrUid: number, items: CartLineUpdateRequest) => Promise<unknown>;
|
|
554
|
+
};
|
|
495
555
|
/**
|
|
496
|
-
*
|
|
497
|
-
* @description Returns only the data from cart clear response
|
|
556
|
+
* Get cart line items data only
|
|
498
557
|
* @param cartHdrUid Cart header unique identifier
|
|
499
|
-
* @returns
|
|
500
|
-
* @throws ValidationError When response is malformed
|
|
558
|
+
* @returns Promise<unknown[]> Array of cart line items data only
|
|
501
559
|
*/
|
|
502
|
-
|
|
560
|
+
getData: (cartHdrUid: number) => Promise<unknown[]>;
|
|
503
561
|
/**
|
|
504
|
-
*
|
|
505
|
-
* @description Returns only the data from cart line deletion response
|
|
562
|
+
* Clear all cart line items data only
|
|
506
563
|
* @param cartHdrUid Cart header unique identifier
|
|
507
|
-
* @
|
|
508
|
-
* @returns Deletion result (data only)
|
|
509
|
-
* @throws ValidationError When response is malformed
|
|
564
|
+
* @returns Promise<unknown> Clear result data only
|
|
510
565
|
*/
|
|
511
|
-
|
|
512
|
-
message: string;
|
|
513
|
-
success: boolean;
|
|
514
|
-
}>;
|
|
566
|
+
deleteData: (cartHdrUid: number) => Promise<unknown>;
|
|
515
567
|
};
|
|
516
568
|
/**
|
|
517
|
-
* Checkout
|
|
518
|
-
* @description
|
|
569
|
+
* Checkout Operations
|
|
570
|
+
* @description End-to-end checkout processing with Prophet21 ERP integration
|
|
519
571
|
*/
|
|
520
572
|
checkout: {
|
|
521
573
|
/**
|
|
522
574
|
* Create a new checkout session
|
|
575
|
+
*
|
|
576
|
+
* @fullPath api.commerce.checkout.create
|
|
577
|
+
* @service commerce
|
|
578
|
+
* @domain checkout-processing
|
|
579
|
+
* @dataMethod checkout.createData - returns only the checkout data without metadata
|
|
580
|
+
* @discoverable true
|
|
581
|
+
* @searchTerms ["checkout", "create checkout", "order", "payment", "purchase", "e-commerce", "checkout process"]
|
|
582
|
+
* @relatedEndpoints ["api.commerce.cartLine.get", "api.commerce.checkout.get", "api.avalara.rates.create", "api.customers.customer.get"]
|
|
583
|
+
* @commonPatterns ["Create checkout", "Process order", "E-commerce checkout", "Payment processing"]
|
|
584
|
+
* @workflow ["checkout-creation", "order-processing", "payment-processing", "erp-integration"]
|
|
585
|
+
* @prerequisites ["Valid cart data", "Customer information", "Payment details", "Line items"]
|
|
586
|
+
* @nextSteps ["api.commerce.checkout.validate.update to validate", "api.commerce.checkout.activate.update to process payment"]
|
|
587
|
+
* @businessRules ["Requires complete order data", "Validates customer and payment info", "Creates checkout session"]
|
|
588
|
+
* @functionalArea "checkout-and-payment-processing"
|
|
589
|
+
* @caching "No caching, immediate checkout creation"
|
|
590
|
+
* @performance "Creates checkout session for payment processing"
|
|
591
|
+
*
|
|
523
592
|
* @description Creates a new checkout with complete order data including customer, payment, and line items
|
|
524
593
|
* @param orderData Complete checkout data with customer information, payment details, and line items
|
|
525
|
-
* @returns Created checkout with unique identifiers and status
|
|
594
|
+
* @returns Promise<CheckoutCreateResponse> Created checkout with unique identifiers and status
|
|
526
595
|
* @throws ValidationError When request is invalid or response is malformed
|
|
596
|
+
*
|
|
527
597
|
* @example
|
|
528
598
|
* ```typescript
|
|
529
|
-
*
|
|
599
|
+
* // Create a new checkout
|
|
600
|
+
* const response = await client.checkout.create({
|
|
530
601
|
* customer: {
|
|
531
602
|
* customerId: 456,
|
|
532
603
|
* contactId: 123,
|
|
@@ -535,272 +606,24 @@ export declare class CommerceClient extends BaseServiceClient {
|
|
|
535
606
|
* billToCity: 'Anytown',
|
|
536
607
|
* billToState: 'CA',
|
|
537
608
|
* billToZip: '12345',
|
|
538
|
-
* billToCountry: 'US'
|
|
539
|
-
* shipToName: 'John Doe',
|
|
540
|
-
* shipToAddress1: '123 Main St',
|
|
541
|
-
* shipToCity: 'Anytown',
|
|
542
|
-
* shipToState: 'CA',
|
|
543
|
-
* shipToZip: '12345',
|
|
544
|
-
* shipToCountry: 'US'
|
|
609
|
+
* billToCountry: 'US'
|
|
545
610
|
* },
|
|
546
611
|
* payment: {
|
|
547
612
|
* paymentType: 'CC',
|
|
548
613
|
* cardNumber: '4111111111111111',
|
|
549
614
|
* expirationDate: '12/25',
|
|
550
|
-
* cvv: '123'
|
|
551
|
-
* cardHolderName: 'John Doe'
|
|
615
|
+
* cvv: '123'
|
|
552
616
|
* },
|
|
553
617
|
* lineItems: [
|
|
554
618
|
* { invMastUid: 12345, quantity: 2, unitOfMeasure: 'EA', unitPrice: 29.99 }
|
|
555
619
|
* ]
|
|
556
620
|
* });
|
|
621
|
+
*
|
|
622
|
+
* // Get just the checkout data
|
|
623
|
+
* const checkout = await client.checkout.createData(orderData);
|
|
557
624
|
* ```
|
|
558
625
|
*/
|
|
559
|
-
create: (
|
|
560
|
-
oeHdr?: {
|
|
561
|
-
customerId?: number | undefined;
|
|
562
|
-
userId?: string | number | undefined;
|
|
563
|
-
customer_id?: number | undefined;
|
|
564
|
-
shipToZipCode?: string | undefined;
|
|
565
|
-
ship_to_zip?: string | undefined;
|
|
566
|
-
ship_to_postal_code?: string | undefined;
|
|
567
|
-
shipToEmailAddress?: string | undefined;
|
|
568
|
-
ship_to_email?: string | undefined;
|
|
569
|
-
customerPoNo?: string | undefined;
|
|
570
|
-
customer_po_no?: string | undefined;
|
|
571
|
-
customer_po_number?: string | undefined;
|
|
572
|
-
class1?: string | null | undefined;
|
|
573
|
-
class_id1?: string | null | undefined;
|
|
574
|
-
class2?: string | null | undefined;
|
|
575
|
-
class_id2?: string | null | undefined;
|
|
576
|
-
class3?: string | null | undefined;
|
|
577
|
-
class_id3?: string | null | undefined;
|
|
578
|
-
class4?: string | null | undefined;
|
|
579
|
-
class_id4?: string | null | undefined;
|
|
580
|
-
class5?: string | null | undefined;
|
|
581
|
-
class_id5?: string | null | undefined;
|
|
582
|
-
taker?: string | undefined;
|
|
583
|
-
shippingEstimate?: number | undefined;
|
|
584
|
-
shipping_estimate?: number | undefined;
|
|
585
|
-
cartTax?: {
|
|
586
|
-
taxAmount?: number | undefined;
|
|
587
|
-
tax_amount?: number | undefined;
|
|
588
|
-
} | undefined;
|
|
589
|
-
cart_tax?: {
|
|
590
|
-
taxAmount?: number | undefined;
|
|
591
|
-
tax_amount?: number | undefined;
|
|
592
|
-
} | undefined;
|
|
593
|
-
userEmail?: string | undefined;
|
|
594
|
-
user_email?: string | undefined;
|
|
595
|
-
user_id?: string | number | undefined;
|
|
596
|
-
} | undefined;
|
|
597
|
-
oe_hdr?: {
|
|
598
|
-
customerId?: number | undefined;
|
|
599
|
-
userId?: string | number | undefined;
|
|
600
|
-
customer_id?: number | undefined;
|
|
601
|
-
shipToZipCode?: string | undefined;
|
|
602
|
-
ship_to_zip?: string | undefined;
|
|
603
|
-
ship_to_postal_code?: string | undefined;
|
|
604
|
-
shipToEmailAddress?: string | undefined;
|
|
605
|
-
ship_to_email?: string | undefined;
|
|
606
|
-
customerPoNo?: string | undefined;
|
|
607
|
-
customer_po_no?: string | undefined;
|
|
608
|
-
customer_po_number?: string | undefined;
|
|
609
|
-
class1?: string | null | undefined;
|
|
610
|
-
class_id1?: string | null | undefined;
|
|
611
|
-
class2?: string | null | undefined;
|
|
612
|
-
class_id2?: string | null | undefined;
|
|
613
|
-
class3?: string | null | undefined;
|
|
614
|
-
class_id3?: string | null | undefined;
|
|
615
|
-
class4?: string | null | undefined;
|
|
616
|
-
class_id4?: string | null | undefined;
|
|
617
|
-
class5?: string | null | undefined;
|
|
618
|
-
class_id5?: string | null | undefined;
|
|
619
|
-
taker?: string | undefined;
|
|
620
|
-
shippingEstimate?: number | undefined;
|
|
621
|
-
shipping_estimate?: number | undefined;
|
|
622
|
-
cartTax?: {
|
|
623
|
-
taxAmount?: number | undefined;
|
|
624
|
-
tax_amount?: number | undefined;
|
|
625
|
-
} | undefined;
|
|
626
|
-
cart_tax?: {
|
|
627
|
-
taxAmount?: number | undefined;
|
|
628
|
-
tax_amount?: number | undefined;
|
|
629
|
-
} | undefined;
|
|
630
|
-
userEmail?: string | undefined;
|
|
631
|
-
user_email?: string | undefined;
|
|
632
|
-
user_id?: string | number | undefined;
|
|
633
|
-
} | undefined;
|
|
634
|
-
header?: {
|
|
635
|
-
customerId?: number | undefined;
|
|
636
|
-
userId?: string | number | undefined;
|
|
637
|
-
customer_id?: number | undefined;
|
|
638
|
-
shipToZipCode?: string | undefined;
|
|
639
|
-
ship_to_zip?: string | undefined;
|
|
640
|
-
ship_to_postal_code?: string | undefined;
|
|
641
|
-
shipToEmailAddress?: string | undefined;
|
|
642
|
-
ship_to_email?: string | undefined;
|
|
643
|
-
customerPoNo?: string | undefined;
|
|
644
|
-
customer_po_no?: string | undefined;
|
|
645
|
-
customer_po_number?: string | undefined;
|
|
646
|
-
class1?: string | null | undefined;
|
|
647
|
-
class_id1?: string | null | undefined;
|
|
648
|
-
class2?: string | null | undefined;
|
|
649
|
-
class_id2?: string | null | undefined;
|
|
650
|
-
class3?: string | null | undefined;
|
|
651
|
-
class_id3?: string | null | undefined;
|
|
652
|
-
class4?: string | null | undefined;
|
|
653
|
-
class_id4?: string | null | undefined;
|
|
654
|
-
class5?: string | null | undefined;
|
|
655
|
-
class_id5?: string | null | undefined;
|
|
656
|
-
taker?: string | undefined;
|
|
657
|
-
shippingEstimate?: number | undefined;
|
|
658
|
-
shipping_estimate?: number | undefined;
|
|
659
|
-
cartTax?: {
|
|
660
|
-
taxAmount?: number | undefined;
|
|
661
|
-
tax_amount?: number | undefined;
|
|
662
|
-
} | undefined;
|
|
663
|
-
cart_tax?: {
|
|
664
|
-
taxAmount?: number | undefined;
|
|
665
|
-
tax_amount?: number | undefined;
|
|
666
|
-
} | undefined;
|
|
667
|
-
userEmail?: string | undefined;
|
|
668
|
-
user_email?: string | undefined;
|
|
669
|
-
user_id?: string | number | undefined;
|
|
670
|
-
} | undefined;
|
|
671
|
-
oeLine?: {
|
|
672
|
-
lineNo?: number | undefined;
|
|
673
|
-
invMastUid?: number | undefined;
|
|
674
|
-
unitOfMeasure?: string | undefined;
|
|
675
|
-
lineNote?: string | undefined;
|
|
676
|
-
unitPrice?: number | undefined;
|
|
677
|
-
itemId?: string | undefined;
|
|
678
|
-
unitQuantity?: number | undefined;
|
|
679
|
-
unit_quantity?: number | undefined;
|
|
680
|
-
qty?: number | undefined;
|
|
681
|
-
unit_price?: number | undefined;
|
|
682
|
-
unit_of_measure?: string | undefined;
|
|
683
|
-
uom?: string | undefined;
|
|
684
|
-
manualPriceOverride?: "Y" | "N" | undefined;
|
|
685
|
-
manual_price_override?: "Y" | "N" | undefined;
|
|
686
|
-
willCall?: "Y" | "N" | undefined;
|
|
687
|
-
will_call?: "Y" | "N" | undefined;
|
|
688
|
-
line_note?: string | undefined;
|
|
689
|
-
note?: string | undefined;
|
|
690
|
-
}[] | undefined;
|
|
691
|
-
oe_line?: {
|
|
692
|
-
lineNo?: number | undefined;
|
|
693
|
-
invMastUid?: number | undefined;
|
|
694
|
-
unitOfMeasure?: string | undefined;
|
|
695
|
-
lineNote?: string | undefined;
|
|
696
|
-
unitPrice?: number | undefined;
|
|
697
|
-
itemId?: string | undefined;
|
|
698
|
-
unitQuantity?: number | undefined;
|
|
699
|
-
unit_quantity?: number | undefined;
|
|
700
|
-
qty?: number | undefined;
|
|
701
|
-
unit_price?: number | undefined;
|
|
702
|
-
unit_of_measure?: string | undefined;
|
|
703
|
-
uom?: string | undefined;
|
|
704
|
-
manualPriceOverride?: "Y" | "N" | undefined;
|
|
705
|
-
manual_price_override?: "Y" | "N" | undefined;
|
|
706
|
-
willCall?: "Y" | "N" | undefined;
|
|
707
|
-
will_call?: "Y" | "N" | undefined;
|
|
708
|
-
line_note?: string | undefined;
|
|
709
|
-
note?: string | undefined;
|
|
710
|
-
}[] | undefined;
|
|
711
|
-
lines?: {
|
|
712
|
-
lineNo?: number | undefined;
|
|
713
|
-
invMastUid?: number | undefined;
|
|
714
|
-
unitOfMeasure?: string | undefined;
|
|
715
|
-
lineNote?: string | undefined;
|
|
716
|
-
unitPrice?: number | undefined;
|
|
717
|
-
itemId?: string | undefined;
|
|
718
|
-
unitQuantity?: number | undefined;
|
|
719
|
-
unit_quantity?: number | undefined;
|
|
720
|
-
qty?: number | undefined;
|
|
721
|
-
unit_price?: number | undefined;
|
|
722
|
-
unit_of_measure?: string | undefined;
|
|
723
|
-
uom?: string | undefined;
|
|
724
|
-
manualPriceOverride?: "Y" | "N" | undefined;
|
|
725
|
-
manual_price_override?: "Y" | "N" | undefined;
|
|
726
|
-
willCall?: "Y" | "N" | undefined;
|
|
727
|
-
will_call?: "Y" | "N" | undefined;
|
|
728
|
-
line_note?: string | undefined;
|
|
729
|
-
note?: string | undefined;
|
|
730
|
-
}[] | undefined;
|
|
731
|
-
notes?: {
|
|
732
|
-
note?: string | undefined;
|
|
733
|
-
topic?: string | undefined;
|
|
734
|
-
} | undefined;
|
|
735
|
-
payments?: {
|
|
736
|
-
paymentAccountId?: string | undefined;
|
|
737
|
-
payment_account_id?: string | undefined;
|
|
738
|
-
PaymentAccountID?: string | undefined;
|
|
739
|
-
processor?: string | undefined;
|
|
740
|
-
lastFour?: string | number | undefined;
|
|
741
|
-
last_four?: string | number | undefined;
|
|
742
|
-
LastFour?: string | number | undefined;
|
|
743
|
-
paymentBrand?: string | undefined;
|
|
744
|
-
payment_brand?: string | undefined;
|
|
745
|
-
PaymentBrand?: string | undefined;
|
|
746
|
-
expirationMonth?: string | number | undefined;
|
|
747
|
-
expiration_month?: string | number | undefined;
|
|
748
|
-
ExpirationMonth?: string | number | undefined;
|
|
749
|
-
expirationYear?: string | number | undefined;
|
|
750
|
-
expiration_year?: string | number | undefined;
|
|
751
|
-
ExpirationYear?: string | number | undefined;
|
|
752
|
-
firstName?: string | undefined;
|
|
753
|
-
first_name?: string | undefined;
|
|
754
|
-
lastName?: string | undefined;
|
|
755
|
-
last_name?: string | undefined;
|
|
756
|
-
streetAddress1?: string | undefined;
|
|
757
|
-
street_address1?: string | undefined;
|
|
758
|
-
streetAddress2?: string | undefined;
|
|
759
|
-
street_address2?: string | undefined;
|
|
760
|
-
city?: string | undefined;
|
|
761
|
-
state?: string | undefined;
|
|
762
|
-
zipCode?: string | undefined;
|
|
763
|
-
zip_code?: string | undefined;
|
|
764
|
-
country?: string | undefined;
|
|
765
|
-
} | undefined;
|
|
766
|
-
web?: {
|
|
767
|
-
webShopperEmail?: string | undefined;
|
|
768
|
-
webShopperId?: number | undefined;
|
|
769
|
-
} | undefined;
|
|
770
|
-
customer?: {
|
|
771
|
-
customerId: number;
|
|
772
|
-
contactId: number;
|
|
773
|
-
billToName: string;
|
|
774
|
-
billToAddress1: string;
|
|
775
|
-
billToCity: string;
|
|
776
|
-
billToState: string;
|
|
777
|
-
billToZip: string;
|
|
778
|
-
billToCountry: string;
|
|
779
|
-
shipToName: string;
|
|
780
|
-
shipToAddress1: string;
|
|
781
|
-
shipToCity: string;
|
|
782
|
-
shipToState: string;
|
|
783
|
-
shipToZip: string;
|
|
784
|
-
shipToCountry: string;
|
|
785
|
-
} | undefined;
|
|
786
|
-
payment?: {
|
|
787
|
-
paymentType: string;
|
|
788
|
-
cardNumber: string;
|
|
789
|
-
expirationDate: string;
|
|
790
|
-
cvv: string;
|
|
791
|
-
cardHolderName: string;
|
|
792
|
-
} | undefined;
|
|
793
|
-
shipping?: {
|
|
794
|
-
shippingMethod: string;
|
|
795
|
-
shippingInstructions?: string | undefined;
|
|
796
|
-
} | undefined;
|
|
797
|
-
lineItems?: {
|
|
798
|
-
invMastUid: number;
|
|
799
|
-
quantity: number;
|
|
800
|
-
unitOfMeasure: string;
|
|
801
|
-
unitPrice: number;
|
|
802
|
-
}[] | undefined;
|
|
803
|
-
}) => Promise<{
|
|
626
|
+
create: (orderData: CheckoutCreateRequest) => Promise<{
|
|
804
627
|
params: Record<string, unknown> | unknown[];
|
|
805
628
|
data: {
|
|
806
629
|
body: string | Record<string, unknown>;
|
|
@@ -817,18 +640,40 @@ export declare class CommerceClient extends BaseServiceClient {
|
|
|
817
640
|
}>;
|
|
818
641
|
/**
|
|
819
642
|
* Get checkout details by ID
|
|
643
|
+
*
|
|
644
|
+
* @fullPath api.commerce.checkout.get
|
|
645
|
+
* @service commerce
|
|
646
|
+
* @domain checkout-processing
|
|
647
|
+
* @dataMethod checkout.getData - returns only the checkout data without metadata
|
|
648
|
+
* @discoverable true
|
|
649
|
+
* @searchTerms ["checkout", "get checkout", "checkout details", "order details", "checkout status"]
|
|
650
|
+
* @relatedEndpoints ["api.commerce.checkout.create", "api.commerce.checkout.validate.update", "api.commerce.checkout.activate.update"]
|
|
651
|
+
* @commonPatterns ["Get checkout details", "View order", "Check checkout status", "Order information"]
|
|
652
|
+
* @workflow ["checkout-retrieval", "order-status-check", "checkout-management"]
|
|
653
|
+
* @prerequisites ["Valid checkout UID", "Checkout must exist"]
|
|
654
|
+
* @nextSteps ["api.commerce.checkout.validate.update", "api.commerce.checkout.doc.get for receipt"]
|
|
655
|
+
* @businessRules ["Returns complete checkout details", "Includes order and processing status", "Available to checkout owner"]
|
|
656
|
+
* @functionalArea "checkout-and-payment-processing"
|
|
657
|
+
* @caching "Cache for 5 minutes, invalidate on checkout updates"
|
|
658
|
+
* @performance "Fast retrieval with complete order data"
|
|
659
|
+
*
|
|
820
660
|
* @description Retrieves complete details for a specific checkout including all order data
|
|
821
661
|
* @param checkoutUid Checkout unique identifier
|
|
822
|
-
* @returns Complete checkout details with order data and processing status
|
|
662
|
+
* @returns Promise<CheckoutGetResponse> Complete checkout details with order data and processing status
|
|
823
663
|
* @throws ValidationError When response is malformed
|
|
664
|
+
*
|
|
824
665
|
* @example
|
|
825
666
|
* ```typescript
|
|
826
|
-
*
|
|
827
|
-
*
|
|
828
|
-
* console.log('
|
|
667
|
+
* // Get checkout details
|
|
668
|
+
* const response = await client.checkout.get(12345);
|
|
669
|
+
* console.log('Checkout:', response.data.checkoutUid, 'Status:', response.data.statusCd);
|
|
670
|
+
* console.log('Created:', response.data.dateCreated, 'Type:', response.data.checkoutType);
|
|
671
|
+
*
|
|
672
|
+
* // Get just the checkout data
|
|
673
|
+
* const checkout = await client.checkout.getData(12345);
|
|
829
674
|
* ```
|
|
830
675
|
*/
|
|
831
|
-
get: (
|
|
676
|
+
get: (checkoutUid: number) => Promise<{
|
|
832
677
|
params: Record<string, unknown> | unknown[];
|
|
833
678
|
data: {
|
|
834
679
|
dateCreated: string;
|
|
@@ -853,256 +698,355 @@ export declare class CommerceClient extends BaseServiceClient {
|
|
|
853
698
|
totalResults: number;
|
|
854
699
|
}>;
|
|
855
700
|
/**
|
|
856
|
-
*
|
|
857
|
-
* @description
|
|
858
|
-
* @param checkoutUid Checkout unique identifier
|
|
859
|
-
* @param params Optional parameters including associated cart header UID
|
|
860
|
-
* @returns Raw checkout document response
|
|
861
|
-
* @throws ValidationError When response is malformed
|
|
862
|
-
* @example
|
|
863
|
-
* ```typescript
|
|
864
|
-
* const doc = await client.checkout.getDoc(12345, { cartHdrUid: 789 });
|
|
865
|
-
* // Process or display the formatted document
|
|
866
|
-
* ```
|
|
701
|
+
* Activate Operations
|
|
702
|
+
* @description Checkout activation functionality for payment processing
|
|
867
703
|
*/
|
|
868
|
-
|
|
704
|
+
activate: {
|
|
705
|
+
/**
|
|
706
|
+
* Activate and process checkout
|
|
707
|
+
*
|
|
708
|
+
* @fullPath api.commerce.checkout.activate.update
|
|
709
|
+
* @service commerce
|
|
710
|
+
* @domain checkout-processing
|
|
711
|
+
* @dataMethod checkout.activate.getData - returns only the activation result data without metadata
|
|
712
|
+
* @discoverable true
|
|
713
|
+
* @searchTerms ["activate checkout", "process payment", "finalize order", "checkout activation", "payment processing"]
|
|
714
|
+
* @relatedEndpoints ["api.commerce.checkout.get", "api.commerce.checkout.validate.update", "api.avalara.rates.create"]
|
|
715
|
+
* @commonPatterns ["Activate checkout", "Process payment", "Finalize order", "Complete purchase"]
|
|
716
|
+
* @workflow ["payment-processing", "order-finalization", "erp-integration", "checkout-completion"]
|
|
717
|
+
* @prerequisites ["Valid checkout UID", "Checkout validation passed", "Payment information verified"]
|
|
718
|
+
* @nextSteps ["api.commerce.checkout.doc.get for receipt", "Order fulfillment processes"]
|
|
719
|
+
* @businessRules ["Processes payment", "Creates orders in Prophet21 ERP", "Updates checkout status"]
|
|
720
|
+
* @functionalArea "checkout-and-payment-processing"
|
|
721
|
+
* @caching "No caching, immediate payment processing"
|
|
722
|
+
* @performance "Payment processing with ERP integration"
|
|
723
|
+
*
|
|
724
|
+
* @description Activates the checkout, processes payment, and creates orders in Prophet21 ERP system
|
|
725
|
+
* @param checkoutUid Checkout unique identifier
|
|
726
|
+
* @returns Promise<CheckoutActivateResponse> Activated checkout details with updated status
|
|
727
|
+
* @throws ValidationError When response is malformed
|
|
728
|
+
*
|
|
729
|
+
* @example
|
|
730
|
+
* ```typescript
|
|
731
|
+
* // Activate checkout and process payment
|
|
732
|
+
* const response = await client.checkout.activate.update(12345);
|
|
733
|
+
* if (response.data.statusCd === 710) {
|
|
734
|
+
* console.log('Checkout successfully activated and processed');
|
|
735
|
+
* }
|
|
736
|
+
*
|
|
737
|
+
* // Get just the activation result
|
|
738
|
+
* const result = await client.checkout.activate.getData(12345);
|
|
739
|
+
* ```
|
|
740
|
+
*/
|
|
741
|
+
update: (checkoutUid: number) => Promise<{
|
|
742
|
+
params: Record<string, unknown> | unknown[];
|
|
743
|
+
data: {
|
|
744
|
+
statusCd: number;
|
|
745
|
+
checkoutUid: number;
|
|
746
|
+
checkoutUuid: string;
|
|
747
|
+
};
|
|
748
|
+
options: Record<string, unknown> | unknown[];
|
|
749
|
+
status: number;
|
|
750
|
+
message: string;
|
|
751
|
+
count: number;
|
|
752
|
+
total: number;
|
|
753
|
+
totalResults: number;
|
|
754
|
+
}>;
|
|
755
|
+
/**
|
|
756
|
+
* Activate checkout data only
|
|
757
|
+
* @param checkoutUid Checkout unique identifier
|
|
758
|
+
* @returns Promise<unknown> Activation results data only
|
|
759
|
+
*/
|
|
760
|
+
getData: (checkoutUid: number) => Promise<unknown>;
|
|
761
|
+
};
|
|
869
762
|
/**
|
|
870
|
-
*
|
|
871
|
-
* @description
|
|
872
|
-
* @param checkoutUid Checkout unique identifier
|
|
873
|
-
* @returns Validation results with status, errors, and warnings
|
|
874
|
-
* @throws ValidationError When response is malformed
|
|
875
|
-
* @example
|
|
876
|
-
* ```typescript
|
|
877
|
-
* const validation = await client.checkout.validate(12345);
|
|
878
|
-
* if (validation.data.validationResults?.isValid) {
|
|
879
|
-
* console.log('Checkout is valid and ready for activation');
|
|
880
|
-
* } else {
|
|
881
|
-
* console.log('Validation errors:', validation.data.validationResults?.errors);
|
|
882
|
-
* }
|
|
883
|
-
* ```
|
|
763
|
+
* Doc Operations
|
|
764
|
+
* @description Checkout document functionality for receipts and printing
|
|
884
765
|
*/
|
|
885
|
-
|
|
886
|
-
|
|
887
|
-
|
|
888
|
-
|
|
889
|
-
|
|
890
|
-
|
|
891
|
-
|
|
892
|
-
|
|
893
|
-
|
|
894
|
-
|
|
895
|
-
|
|
896
|
-
|
|
897
|
-
|
|
898
|
-
|
|
899
|
-
|
|
900
|
-
|
|
901
|
-
|
|
902
|
-
|
|
903
|
-
|
|
766
|
+
doc: {
|
|
767
|
+
/**
|
|
768
|
+
* Get formatted checkout document
|
|
769
|
+
*
|
|
770
|
+
* @fullPath api.commerce.checkout.doc.get
|
|
771
|
+
* @service commerce
|
|
772
|
+
* @domain checkout-processing
|
|
773
|
+
* @dataMethod checkout.doc.getData - returns the document data directly
|
|
774
|
+
* @discoverable true
|
|
775
|
+
* @searchTerms ["checkout document", "receipt", "checkout doc", "order receipt", "checkout receipt"]
|
|
776
|
+
* @relatedEndpoints ["api.commerce.checkout.get", "api.commerce.checkout.activate.update"]
|
|
777
|
+
* @commonPatterns ["Get checkout receipt", "Download order document", "Print checkout", "Order confirmation"]
|
|
778
|
+
* @workflow ["receipt-generation", "document-retrieval", "order-confirmation"]
|
|
779
|
+
* @prerequisites ["Valid checkout UID", "Checkout must exist", "Document must be available"]
|
|
780
|
+
* @nextSteps ["Display or print document", "Email to customer", "Store for records"]
|
|
781
|
+
* @businessRules ["Generates formatted receipt", "Includes all order details", "Available after checkout creation"]
|
|
782
|
+
* @functionalArea "checkout-and-payment-processing"
|
|
783
|
+
* @caching "Cache for 1 hour, document content is static"
|
|
784
|
+
* @performance "Fast document retrieval for display or printing"
|
|
785
|
+
*
|
|
786
|
+
* @description Retrieves the formatted checkout document/receipt for display or printing
|
|
787
|
+
* @param checkoutUid Checkout unique identifier
|
|
788
|
+
* @param params Optional parameters including associated cart header UID
|
|
789
|
+
* @returns Promise<unknown> Raw checkout document response
|
|
790
|
+
* @throws ValidationError When response is malformed
|
|
791
|
+
*
|
|
792
|
+
* @example
|
|
793
|
+
* ```typescript
|
|
794
|
+
* // Get checkout document
|
|
795
|
+
* const response = await client.checkout.doc.get(12345, { cartHdrUid: 789 });
|
|
796
|
+
* // Process or display the formatted document
|
|
797
|
+
*
|
|
798
|
+
* // Get document data directly
|
|
799
|
+
* const doc = await client.checkout.doc.getData(12345);
|
|
800
|
+
* ```
|
|
801
|
+
*/
|
|
802
|
+
get: (checkoutUid: number, params?: CheckoutDocParams) => Promise<{
|
|
803
|
+
params: Record<string, unknown> | unknown[];
|
|
804
|
+
data: {
|
|
805
|
+
dateCreated: string;
|
|
806
|
+
dateLastModified: string;
|
|
807
|
+
statusCd: number;
|
|
808
|
+
cartHdrUid: number;
|
|
809
|
+
checkoutUid: number;
|
|
810
|
+
checkoutUuid: string;
|
|
811
|
+
checkoutType?: string | null | undefined;
|
|
812
|
+
properties?: {} | null | undefined;
|
|
813
|
+
checkoutProcessor?: string | null | undefined;
|
|
814
|
+
jsonData?: string | null | undefined;
|
|
815
|
+
sourceName?: string | null | undefined;
|
|
816
|
+
sourceId?: string | null | undefined;
|
|
817
|
+
};
|
|
818
|
+
options: Record<string, unknown> | unknown[];
|
|
819
|
+
status: number;
|
|
820
|
+
message: string;
|
|
821
|
+
count: number;
|
|
822
|
+
total: number;
|
|
823
|
+
totalResults: number;
|
|
824
|
+
}>;
|
|
825
|
+
/**
|
|
826
|
+
* Get checkout document data only
|
|
827
|
+
* @param checkoutUid Checkout unique identifier
|
|
828
|
+
* @param params Optional parameters
|
|
829
|
+
* @returns Promise<unknown> Checkout document data only
|
|
830
|
+
*/
|
|
831
|
+
getData: (checkoutUid: number, params?: CheckoutDocParams) => Promise<unknown>;
|
|
832
|
+
};
|
|
904
833
|
/**
|
|
905
|
-
*
|
|
906
|
-
* @description
|
|
907
|
-
* @param checkoutUid Checkout unique identifier
|
|
908
|
-
* @returns Activated checkout details with updated status
|
|
909
|
-
* @throws ValidationError When response is malformed
|
|
910
|
-
* @example
|
|
911
|
-
* ```typescript
|
|
912
|
-
* const result = await client.checkout.activate(12345);
|
|
913
|
-
* if (result.data.statusCd === 710) {
|
|
914
|
-
* console.log('Checkout successfully activated and processed');
|
|
915
|
-
* }
|
|
916
|
-
* ```
|
|
834
|
+
* Validate Operations
|
|
835
|
+
* @description Checkout validation functionality for pre-processing verification
|
|
917
836
|
*/
|
|
918
|
-
|
|
919
|
-
|
|
920
|
-
|
|
921
|
-
|
|
922
|
-
|
|
923
|
-
|
|
924
|
-
|
|
925
|
-
|
|
926
|
-
|
|
927
|
-
|
|
928
|
-
|
|
929
|
-
|
|
930
|
-
|
|
931
|
-
|
|
837
|
+
validate: {
|
|
838
|
+
/**
|
|
839
|
+
* Validate checkout data
|
|
840
|
+
*
|
|
841
|
+
* @fullPath api.commerce.checkout.validate.update
|
|
842
|
+
* @service commerce
|
|
843
|
+
* @domain checkout-processing
|
|
844
|
+
* @dataMethod checkout.validate.getData - returns only the validation result data without metadata
|
|
845
|
+
* @discoverable true
|
|
846
|
+
* @searchTerms ["validate checkout", "checkout validation", "verify checkout", "pre-process validation"]
|
|
847
|
+
* @relatedEndpoints ["api.commerce.checkout.get", "api.commerce.checkout.activate.update", "api.avalara.rates.create"]
|
|
848
|
+
* @commonPatterns ["Validate checkout", "Pre-process verification", "Check checkout readiness", "Validation check"]
|
|
849
|
+
* @workflow ["checkout-validation", "pre-processing", "verification", "validation-checks"]
|
|
850
|
+
* @prerequisites ["Valid checkout UID", "Checkout must exist", "Complete checkout data"]
|
|
851
|
+
* @nextSteps ["api.commerce.checkout.activate.update if valid", "Fix validation errors if invalid"]
|
|
852
|
+
* @businessRules ["Validates without processing payment", "Checks data completeness", "Returns validation results"]
|
|
853
|
+
* @functionalArea "checkout-and-payment-processing"
|
|
854
|
+
* @caching "No caching, real-time validation required"
|
|
855
|
+
* @performance "Fast validation without payment processing"
|
|
856
|
+
*
|
|
857
|
+
* @description Validates checkout data without processing payment or creating orders in Prophet21
|
|
858
|
+
* @param checkoutUid Checkout unique identifier
|
|
859
|
+
* @returns Promise<CheckoutValidateResponse> Validation results with status, errors, and warnings
|
|
860
|
+
* @throws ValidationError When response is malformed
|
|
861
|
+
*
|
|
862
|
+
* @example
|
|
863
|
+
* ```typescript
|
|
864
|
+
* // Validate checkout
|
|
865
|
+
* const response = await client.checkout.validate.update(12345);
|
|
866
|
+
* if (response.data.validationResults?.isValid) {
|
|
867
|
+
* console.log('Checkout is valid and ready for activation');
|
|
868
|
+
* } else {
|
|
869
|
+
* console.log('Validation errors:', response.data.validationResults?.errors);
|
|
870
|
+
* }
|
|
871
|
+
*
|
|
872
|
+
* // Get just the validation results
|
|
873
|
+
* const validation = await client.checkout.validate.getData(12345);
|
|
874
|
+
* ```
|
|
875
|
+
*/
|
|
876
|
+
update: (checkoutUid: number) => Promise<{
|
|
877
|
+
params: Record<string, unknown> | unknown[];
|
|
878
|
+
data: {
|
|
879
|
+
statusCd: number;
|
|
880
|
+
checkoutUid: number;
|
|
881
|
+
checkoutUuid: string;
|
|
882
|
+
validationResults?: {
|
|
883
|
+
errors: string[];
|
|
884
|
+
isValid: boolean;
|
|
885
|
+
warnings: string[];
|
|
886
|
+
} | undefined;
|
|
887
|
+
};
|
|
888
|
+
options: Record<string, unknown> | unknown[];
|
|
889
|
+
status: number;
|
|
890
|
+
message: string;
|
|
891
|
+
count: number;
|
|
892
|
+
total: number;
|
|
893
|
+
totalResults: number;
|
|
894
|
+
}>;
|
|
895
|
+
/**
|
|
896
|
+
* Validate checkout data only
|
|
897
|
+
* @param checkoutUid Checkout unique identifier
|
|
898
|
+
* @returns Promise<unknown> Validation results data only
|
|
899
|
+
*/
|
|
900
|
+
getData: (checkoutUid: number) => Promise<unknown>;
|
|
901
|
+
};
|
|
932
902
|
/**
|
|
933
|
-
*
|
|
934
|
-
* @description
|
|
935
|
-
* @param checkoutUid Checkout unique identifier
|
|
936
|
-
* @returns Prophet21 header creation result
|
|
937
|
-
* @throws ValidationError When response is malformed
|
|
938
|
-
* @example
|
|
939
|
-
* ```typescript
|
|
940
|
-
* const p21Header = await client.checkout.createProphet21Hdr(12345);
|
|
941
|
-
* // Note: This endpoint is partially implemented
|
|
942
|
-
* ```
|
|
903
|
+
* Prophet21 Hdr Operations
|
|
904
|
+
* @description Prophet21 ERP integration functionality for checkout headers
|
|
943
905
|
*/
|
|
944
|
-
|
|
945
|
-
|
|
946
|
-
|
|
947
|
-
|
|
948
|
-
|
|
949
|
-
|
|
906
|
+
prophet21Hdr: {
|
|
907
|
+
/**
|
|
908
|
+
* Create Prophet21 checkout header
|
|
909
|
+
*
|
|
910
|
+
* @fullPath api.commerce.checkout.prophet21Hdr.create
|
|
911
|
+
* @service commerce
|
|
912
|
+
* @domain erp-integration
|
|
913
|
+
* @dataMethod checkout.prophet21Hdr.getData - returns only the Prophet21 header data without metadata
|
|
914
|
+
* @discoverable true
|
|
915
|
+
* @searchTerms ["prophet21", "erp integration", "checkout header", "p21 header", "erp checkout"]
|
|
916
|
+
* @relatedEndpoints ["api.commerce.checkout.get", "api.commerce.checkout.prophet21Hdr.prophet21Line.create"]
|
|
917
|
+
* @commonPatterns ["Create ERP header", "Prophet21 integration", "ERP checkout header", "P21 header creation"]
|
|
918
|
+
* @workflow ["erp-integration", "prophet21-processing", "checkout-erp-sync"]
|
|
919
|
+
* @prerequisites ["Valid checkout UID", "Checkout must exist", "ERP integration configured"]
|
|
920
|
+
* @nextSteps ["api.commerce.checkout.prophet21Hdr.prophet21Line.create to add lines"]
|
|
921
|
+
* @businessRules ["Creates Prophet21-specific header", "ERP integration endpoint", "Partially implemented"]
|
|
922
|
+
* @functionalArea "erp-integration"
|
|
923
|
+
* @caching "No caching, immediate ERP integration"
|
|
924
|
+
* @performance "ERP integration processing"
|
|
925
|
+
*
|
|
926
|
+
* @description Creates Prophet21-specific checkout header for ERP integration (partially implemented)
|
|
927
|
+
* @param checkoutUid Checkout unique identifier
|
|
928
|
+
* @returns Promise<CheckoutProphet21HdrResponse> Prophet21 header creation result
|
|
929
|
+
* @throws ValidationError When response is malformed
|
|
930
|
+
*
|
|
931
|
+
* @example
|
|
932
|
+
* ```typescript
|
|
933
|
+
* // Create Prophet21 header
|
|
934
|
+
* const response = await client.checkout.prophet21Hdr.create(12345);
|
|
935
|
+
* // Note: This endpoint is partially implemented
|
|
936
|
+
*
|
|
937
|
+
* // Get just the header data
|
|
938
|
+
* const p21Header = await client.checkout.prophet21Hdr.getData(12345);
|
|
939
|
+
* ```
|
|
940
|
+
*/
|
|
941
|
+
create: (checkoutUid: number) => Promise<{
|
|
942
|
+
params: Record<string, unknown> | unknown[];
|
|
943
|
+
data: {
|
|
944
|
+
checkoutUid: number;
|
|
945
|
+
} & {
|
|
946
|
+
[k: string]: unknown;
|
|
947
|
+
};
|
|
948
|
+
options: Record<string, unknown> | unknown[];
|
|
949
|
+
status: number;
|
|
950
|
+
message: string;
|
|
951
|
+
count: number;
|
|
952
|
+
total: number;
|
|
953
|
+
totalResults: number;
|
|
954
|
+
}>;
|
|
955
|
+
/**
|
|
956
|
+
* Prophet21 Line Operations
|
|
957
|
+
* @description Prophet21 ERP integration functionality for checkout line items
|
|
958
|
+
*/
|
|
959
|
+
prophet21Line: {
|
|
960
|
+
/**
|
|
961
|
+
* Add Prophet21 checkout lines
|
|
962
|
+
*
|
|
963
|
+
* @fullPath api.commerce.checkout.prophet21Hdr.prophet21Line.create
|
|
964
|
+
* @service commerce
|
|
965
|
+
* @domain erp-integration
|
|
966
|
+
* @dataMethod checkout.prophet21Hdr.prophet21Line.getData - returns the Prophet21 line data directly
|
|
967
|
+
* @discoverable true
|
|
968
|
+
* @searchTerms ["prophet21 lines", "erp line items", "p21 lines", "checkout lines", "erp integration"]
|
|
969
|
+
* @relatedEndpoints ["api.commerce.checkout.prophet21Hdr.create", "api.commerce.checkout.get"]
|
|
970
|
+
* @commonPatterns ["Add ERP line items", "Prophet21 line integration", "ERP checkout lines", "P21 line creation"]
|
|
971
|
+
* @workflow ["erp-integration", "prophet21-processing", "checkout-line-sync"]
|
|
972
|
+
* @prerequisites ["Valid checkout UID", "Valid Prophet21 header UID", "ERP integration configured"]
|
|
973
|
+
* @nextSteps ["Complete ERP integration process", "Finalize Prophet21 checkout"]
|
|
974
|
+
* @businessRules ["Adds line items to Prophet21 header", "ERP integration endpoint", "In early development"]
|
|
975
|
+
* @functionalArea "erp-integration"
|
|
976
|
+
* @caching "No caching, immediate ERP integration"
|
|
977
|
+
* @performance "ERP line item processing"
|
|
978
|
+
*
|
|
979
|
+
* @description Adds line items to Prophet21 checkout header (in early development)
|
|
980
|
+
* @param checkoutUid Checkout unique identifier
|
|
981
|
+
* @param prophet21HdrUid Prophet21 header unique identifier
|
|
982
|
+
* @returns Promise<CheckoutProphet21LineResponse> Prophet21 line creation result
|
|
983
|
+
* @throws ValidationError When response is malformed
|
|
984
|
+
*
|
|
985
|
+
* @example
|
|
986
|
+
* ```typescript
|
|
987
|
+
* // Add Prophet21 lines
|
|
988
|
+
* const response = await client.checkout.prophet21Hdr.prophet21Line.create(12345, 67890);
|
|
989
|
+
* // Note: This endpoint is in early development
|
|
990
|
+
*
|
|
991
|
+
* // Get just the line data
|
|
992
|
+
* const p21Lines = await client.checkout.prophet21Hdr.prophet21Line.getData(12345, 67890);
|
|
993
|
+
* ```
|
|
994
|
+
*/
|
|
995
|
+
create: (checkoutUid: number, prophet21HdrUid: number) => Promise<{
|
|
996
|
+
params: Record<string, unknown> | unknown[];
|
|
997
|
+
data: import("zod").objectInputType<{
|
|
998
|
+
lineNo: import("zod").ZodNumber;
|
|
999
|
+
itemId: import("zod").ZodString;
|
|
1000
|
+
unitQuantity: import("zod").ZodNumber;
|
|
1001
|
+
unitOfMeasure: import("zod").ZodString;
|
|
1002
|
+
}, import("zod").ZodTypeAny, "passthrough">[];
|
|
1003
|
+
options: Record<string, unknown> | unknown[];
|
|
1004
|
+
status: number;
|
|
1005
|
+
message: string;
|
|
1006
|
+
count: number;
|
|
1007
|
+
total: number;
|
|
1008
|
+
totalResults: number;
|
|
1009
|
+
}>;
|
|
1010
|
+
/**
|
|
1011
|
+
* Add Prophet21 lines data only
|
|
1012
|
+
* @param checkoutUid Checkout unique identifier
|
|
1013
|
+
* @param prophet21HdrUid Prophet21 header unique identifier
|
|
1014
|
+
* @returns Promise<unknown> Prophet21 lines addition result data only
|
|
1015
|
+
*/
|
|
1016
|
+
createData: (checkoutUid: number, prophet21HdrUid: number) => Promise<unknown>;
|
|
1017
|
+
/**
|
|
1018
|
+
* Get Prophet21 lines data only
|
|
1019
|
+
* @param checkoutUid Checkout unique identifier
|
|
1020
|
+
* @param prophet21HdrUid Prophet21 header unique identifier
|
|
1021
|
+
* @returns Promise<unknown> Prophet21 lines addition result data only
|
|
1022
|
+
*/
|
|
1023
|
+
getData: (checkoutUid: number, prophet21HdrUid: number) => Promise<unknown>;
|
|
950
1024
|
};
|
|
951
|
-
|
|
952
|
-
|
|
953
|
-
|
|
954
|
-
|
|
955
|
-
|
|
956
|
-
|
|
957
|
-
|
|
958
|
-
|
|
959
|
-
|
|
960
|
-
|
|
961
|
-
|
|
962
|
-
|
|
963
|
-
|
|
964
|
-
* @throws ValidationError When response is malformed
|
|
965
|
-
* @example
|
|
966
|
-
* ```typescript
|
|
967
|
-
* const p21Lines = await client.checkout.addProphet21Lines(12345, 67890);
|
|
968
|
-
* // Note: This endpoint is in early development
|
|
969
|
-
* ```
|
|
970
|
-
*/
|
|
971
|
-
addProphet21Lines: (checkoutUid: number, prophet21HdrUid: number) => Promise<unknown>;
|
|
1025
|
+
/**
|
|
1026
|
+
* Create Prophet21 header data only
|
|
1027
|
+
* @param checkoutUid Checkout unique identifier
|
|
1028
|
+
* @returns Promise<unknown> Prophet21 header creation result data only
|
|
1029
|
+
*/
|
|
1030
|
+
createData: (checkoutUid: number) => Promise<unknown>;
|
|
1031
|
+
/**
|
|
1032
|
+
* Get Prophet21 header data only
|
|
1033
|
+
* @param checkoutUid Checkout unique identifier
|
|
1034
|
+
* @returns Promise<unknown> Prophet21 header creation result data only
|
|
1035
|
+
*/
|
|
1036
|
+
getData: (checkoutUid: number) => Promise<unknown>;
|
|
1037
|
+
};
|
|
972
1038
|
/**
|
|
973
|
-
* Create checkout
|
|
974
|
-
* @description Returns only the data from checkout creation response
|
|
1039
|
+
* Create checkout data only
|
|
975
1040
|
* @param orderData Complete checkout data
|
|
976
|
-
* @returns Created checkout details
|
|
977
|
-
* @throws ValidationError When request is invalid or response is malformed
|
|
978
|
-
*/
|
|
979
|
-
createData: (orderData: CheckoutCreateRequest) => Promise<{
|
|
980
|
-
body: string | Record<string, unknown>;
|
|
981
|
-
checkoutUid: number;
|
|
982
|
-
checkoutUuid: string;
|
|
983
|
-
statusCd?: number | undefined;
|
|
984
|
-
}>;
|
|
985
|
-
/**
|
|
986
|
-
* Get checkout details (data only)
|
|
987
|
-
* @description Returns only the data from checkout details response
|
|
988
|
-
* @param checkoutUid Checkout unique identifier
|
|
989
|
-
* @returns Checkout details (data only)
|
|
990
|
-
* @throws ValidationError When response is malformed
|
|
991
|
-
*/
|
|
992
|
-
getData: (checkoutUid: number) => Promise<{
|
|
993
|
-
dateCreated: string;
|
|
994
|
-
dateLastModified: string;
|
|
995
|
-
statusCd: number;
|
|
996
|
-
cartHdrUid: number;
|
|
997
|
-
checkoutUid: number;
|
|
998
|
-
checkoutUuid: string;
|
|
999
|
-
body?: unknown;
|
|
1000
|
-
checkoutType?: string | undefined;
|
|
1001
|
-
properties?: string | undefined;
|
|
1002
|
-
checkoutProcessor?: string | undefined;
|
|
1003
|
-
jsonData?: string | undefined;
|
|
1004
|
-
sourceName?: string | undefined;
|
|
1005
|
-
sourceId?: string | undefined;
|
|
1006
|
-
}>;
|
|
1007
|
-
/**
|
|
1008
|
-
* Get checkout document (data only)
|
|
1009
|
-
* @description Returns the checkout document directly
|
|
1010
|
-
* @param checkoutUid Checkout unique identifier
|
|
1011
|
-
* @param params Optional parameters
|
|
1012
|
-
* @returns Checkout document (data only)
|
|
1013
|
-
* @throws ValidationError When response is malformed
|
|
1014
|
-
*/
|
|
1015
|
-
getDocData: (checkoutUid: number, params?: CheckoutDocParams) => Promise<unknown>;
|
|
1016
|
-
/**
|
|
1017
|
-
* Validate checkout (data only)
|
|
1018
|
-
* @description Returns only the data from checkout validation response
|
|
1019
|
-
* @param checkoutUid Checkout unique identifier
|
|
1020
|
-
* @returns Validation results (data only)
|
|
1021
|
-
* @throws ValidationError When response is malformed
|
|
1022
|
-
*/
|
|
1023
|
-
validateData: (checkoutUid: number) => Promise<{
|
|
1024
|
-
statusCd: number;
|
|
1025
|
-
checkoutUid: number;
|
|
1026
|
-
checkoutUuid: string;
|
|
1027
|
-
validationResults?: {
|
|
1028
|
-
errors: string[];
|
|
1029
|
-
isValid: boolean;
|
|
1030
|
-
warnings: string[];
|
|
1031
|
-
} | undefined;
|
|
1032
|
-
}>;
|
|
1033
|
-
/**
|
|
1034
|
-
* Activate checkout (data only)
|
|
1035
|
-
* @description Returns only the data from checkout activation response
|
|
1036
|
-
* @param checkoutUid Checkout unique identifier
|
|
1037
|
-
* @returns Activation results (data only)
|
|
1038
|
-
* @throws ValidationError When response is malformed
|
|
1041
|
+
* @returns Promise<unknown> Created checkout details data only
|
|
1039
1042
|
*/
|
|
1040
|
-
|
|
1041
|
-
statusCd: number;
|
|
1042
|
-
checkoutUid: number;
|
|
1043
|
-
checkoutUuid: string;
|
|
1044
|
-
}>;
|
|
1043
|
+
createData: (orderData: CheckoutCreateRequest) => Promise<unknown>;
|
|
1045
1044
|
/**
|
|
1046
|
-
*
|
|
1047
|
-
* @description Returns only the data from Prophet21 header creation response
|
|
1045
|
+
* Get checkout details data only
|
|
1048
1046
|
* @param checkoutUid Checkout unique identifier
|
|
1049
|
-
* @returns
|
|
1050
|
-
* @throws ValidationError When response is malformed
|
|
1047
|
+
* @returns Promise<unknown> Checkout details data only
|
|
1051
1048
|
*/
|
|
1052
|
-
|
|
1053
|
-
checkoutUid: number;
|
|
1054
|
-
} & {
|
|
1055
|
-
[k: string]: unknown;
|
|
1056
|
-
}>;
|
|
1057
|
-
/**
|
|
1058
|
-
* Add Prophet21 lines (data only)
|
|
1059
|
-
* @description Returns the Prophet21 lines addition result directly
|
|
1060
|
-
* @param checkoutUid Checkout unique identifier
|
|
1061
|
-
* @param prophet21HdrUid Prophet21 header unique identifier
|
|
1062
|
-
* @returns Prophet21 lines addition result (data only)
|
|
1063
|
-
* @throws ValidationError When response is malformed
|
|
1064
|
-
*/
|
|
1065
|
-
addProphet21LinesData: (checkoutUid: number, prophet21HdrUid: number) => Promise<unknown>;
|
|
1066
|
-
};
|
|
1067
|
-
/**
|
|
1068
|
-
* Check service health (no bearer token required)
|
|
1069
|
-
* @description Monitor service availability and site configuration without authentication overhead
|
|
1070
|
-
* @returns Health check response with site hash and ID for configuration verification
|
|
1071
|
-
* @throws ValidationError When response is malformed
|
|
1072
|
-
* @example
|
|
1073
|
-
* ```typescript
|
|
1074
|
-
* const health = await client.getHealthCheck();
|
|
1075
|
-
* console.log('Service health:', health.status);
|
|
1076
|
-
* console.log('Site ID:', health.data.siteId);
|
|
1077
|
-
* console.log('Site Hash:', health.data.siteHash);
|
|
1078
|
-
* ```
|
|
1079
|
-
*/
|
|
1080
|
-
getHealthCheck: () => Promise<{
|
|
1081
|
-
params: Record<string, unknown> | unknown[];
|
|
1082
|
-
data: {
|
|
1083
|
-
siteHash: string;
|
|
1084
|
-
siteId: string;
|
|
1085
|
-
};
|
|
1086
|
-
options: Record<string, unknown> | unknown[];
|
|
1087
|
-
status: number;
|
|
1088
|
-
message: string;
|
|
1089
|
-
count: number;
|
|
1090
|
-
total: number;
|
|
1091
|
-
totalResults: number;
|
|
1092
|
-
}>;
|
|
1093
|
-
/**
|
|
1094
|
-
* Health Data Operations
|
|
1095
|
-
* @description Direct access to health check data without response metadata
|
|
1096
|
-
*/
|
|
1097
|
-
healthData: {
|
|
1098
|
-
/**
|
|
1099
|
-
* Get health check data without response metadata
|
|
1100
|
-
* @returns Promise<unknown> Health status data directly
|
|
1101
|
-
*/
|
|
1102
|
-
check: () => Promise<{
|
|
1103
|
-
siteHash: string;
|
|
1104
|
-
siteId: string;
|
|
1105
|
-
}>;
|
|
1049
|
+
getData: (checkoutUid: number) => Promise<unknown>;
|
|
1106
1050
|
};
|
|
1107
1051
|
}
|
|
1108
1052
|
//# sourceMappingURL=client.d.ts.map
|