@simpleapps-com/augur-api 0.3.2 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/API-DISCOVERY.md +2 -2
- package/API-SERVICES.md +227 -0
- package/QUICKSTART.md +2 -2
- package/README.md +144 -10
- package/dist/cjs/client.d.ts +78 -0
- package/dist/cjs/client.d.ts.map +1 -1
- package/dist/cjs/client.js +182 -0
- package/dist/cjs/client.js.map +1 -1
- package/dist/cjs/index.d.ts +1 -1
- package/dist/cjs/index.js +1 -1
- package/dist/cjs/services/agr-info/client.d.ts +579 -545
- package/dist/cjs/services/agr-info/client.d.ts.map +1 -1
- package/dist/cjs/services/agr-info/client.js +440 -407
- package/dist/cjs/services/agr-info/client.js.map +1 -1
- package/dist/cjs/services/agr-site/client.d.ts +156 -85
- package/dist/cjs/services/agr-site/client.d.ts.map +1 -1
- package/dist/cjs/services/agr-site/client.js +179 -106
- package/dist/cjs/services/agr-site/client.js.map +1 -1
- package/dist/cjs/services/agr-work/client.d.ts +152 -96
- package/dist/cjs/services/agr-work/client.d.ts.map +1 -1
- package/dist/cjs/services/agr-work/client.js +155 -81
- package/dist/cjs/services/agr-work/client.js.map +1 -1
- package/dist/cjs/services/avalara/client.d.ts +260 -316
- package/dist/cjs/services/avalara/client.d.ts.map +1 -1
- package/dist/cjs/services/avalara/client.js +194 -136
- package/dist/cjs/services/avalara/client.js.map +1 -1
- package/dist/cjs/services/brand-folder/client.d.ts +200 -170
- package/dist/cjs/services/brand-folder/client.d.ts.map +1 -1
- package/dist/cjs/services/brand-folder/client.js +181 -124
- package/dist/cjs/services/brand-folder/client.js.map +1 -1
- package/dist/cjs/services/brand-folder/schemas.d.ts +8 -8
- package/dist/cjs/services/commerce/client.d.ts +821 -877
- package/dist/cjs/services/commerce/client.d.ts.map +1 -1
- package/dist/cjs/services/commerce/client.js +843 -487
- package/dist/cjs/services/commerce/client.js.map +1 -1
- package/dist/cjs/services/customers/client.d.ts +310 -565
- package/dist/cjs/services/customers/client.d.ts.map +1 -1
- package/dist/cjs/services/customers/client.js +224 -452
- package/dist/cjs/services/customers/client.js.map +1 -1
- package/dist/cjs/services/gregorovich/client.d.ts +347 -311
- package/dist/cjs/services/gregorovich/client.d.ts.map +1 -1
- package/dist/cjs/services/gregorovich/client.js +292 -254
- package/dist/cjs/services/gregorovich/client.js.map +1 -1
- package/dist/cjs/services/gregorovich/index.d.ts +1 -1
- package/dist/cjs/services/gregorovich/index.d.ts.map +1 -1
- package/dist/cjs/services/gregorovich/schemas/chatGptAsk.d.ts +371 -0
- package/dist/cjs/services/gregorovich/schemas/chatGptAsk.d.ts.map +1 -0
- package/dist/cjs/services/gregorovich/schemas/chatGptAsk.js +71 -0
- package/dist/cjs/services/gregorovich/schemas/chatGptAsk.js.map +1 -0
- package/dist/cjs/services/gregorovich/schemas/documents.d.ts +398 -0
- package/dist/cjs/services/gregorovich/schemas/documents.d.ts.map +1 -0
- package/dist/cjs/services/gregorovich/schemas/documents.js +61 -0
- package/dist/cjs/services/gregorovich/schemas/documents.js.map +1 -0
- package/dist/cjs/services/gregorovich/schemas/healthCheck.d.ts +53 -0
- package/dist/cjs/services/gregorovich/schemas/healthCheck.d.ts.map +1 -0
- package/dist/cjs/services/gregorovich/schemas/healthCheck.js +11 -0
- package/dist/cjs/services/gregorovich/schemas/healthCheck.js.map +1 -0
- package/dist/cjs/services/gregorovich/schemas/index.d.ts +5 -0
- package/dist/cjs/services/gregorovich/schemas/index.d.ts.map +1 -0
- package/dist/cjs/services/gregorovich/schemas/index.js +21 -0
- package/dist/cjs/services/gregorovich/schemas/index.js.map +1 -0
- package/dist/cjs/services/gregorovich/schemas/ollamaGenerate.d.ts +433 -0
- package/dist/cjs/services/gregorovich/schemas/ollamaGenerate.d.ts.map +1 -0
- package/dist/cjs/services/gregorovich/schemas/ollamaGenerate.js +100 -0
- package/dist/cjs/services/gregorovich/schemas/ollamaGenerate.js.map +1 -0
- package/dist/cjs/services/gregorovich/schemas.d.ts +1 -1217
- package/dist/cjs/services/gregorovich/schemas.d.ts.map +1 -1
- package/dist/cjs/services/gregorovich/schemas.js +16 -198
- package/dist/cjs/services/gregorovich/schemas.js.map +1 -1
- package/dist/cjs/services/items/client.d.ts +1865 -1724
- package/dist/cjs/services/items/client.d.ts.map +1 -1
- package/dist/cjs/services/items/client.js +1726 -1171
- package/dist/cjs/services/items/client.js.map +1 -1
- package/dist/cjs/services/items/schemas/attributes.d.ts +2 -2
- package/dist/cjs/services/items/schemas/brandsItems.d.ts +304 -0
- package/dist/cjs/services/items/schemas/brandsItems.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/brandsItems.js +44 -0
- package/dist/cjs/services/items/schemas/brandsItems.js.map +1 -0
- package/dist/cjs/services/items/schemas/categoriesImages.d.ts +127 -0
- package/dist/cjs/services/items/schemas/categoriesImages.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/categoriesImages.js +24 -0
- package/dist/cjs/services/items/schemas/categoriesImages.js.map +1 -0
- package/dist/cjs/services/items/schemas/index.d.ts +12 -0
- package/dist/cjs/services/items/schemas/index.d.ts.map +1 -1
- package/dist/cjs/services/items/schemas/index.js +12 -0
- package/dist/cjs/services/items/schemas/index.js.map +1 -1
- package/dist/cjs/services/items/schemas/internalPdf.d.ts +212 -0
- package/dist/cjs/services/items/schemas/internalPdf.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/internalPdf.js +44 -0
- package/dist/cjs/services/items/schemas/internalPdf.js.map +1 -0
- package/dist/cjs/services/items/schemas/invMastAccessory.d.ts +127 -0
- package/dist/cjs/services/items/schemas/invMastAccessory.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/invMastAccessory.js +21 -0
- package/dist/cjs/services/items/schemas/invMastAccessory.js.map +1 -0
- package/dist/cjs/services/items/schemas/invMastAlternateCode.d.ts +147 -0
- package/dist/cjs/services/items/schemas/invMastAlternateCode.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/invMastAlternateCode.js +26 -0
- package/dist/cjs/services/items/schemas/invMastAlternateCode.js.map +1 -0
- package/dist/cjs/services/items/schemas/invMastAttributes.d.ts +177 -0
- package/dist/cjs/services/items/schemas/invMastAttributes.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/invMastAttributes.js +35 -0
- package/dist/cjs/services/items/schemas/invMastAttributes.js.map +1 -0
- package/dist/cjs/services/items/schemas/invMastAttributesValues.d.ts +333 -0
- package/dist/cjs/services/items/schemas/invMastAttributesValues.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/invMastAttributesValues.js +49 -0
- package/dist/cjs/services/items/schemas/invMastAttributesValues.js.map +1 -0
- package/dist/cjs/services/items/schemas/invMastDoc.d.ts +137 -0
- package/dist/cjs/services/items/schemas/invMastDoc.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/invMastDoc.js +22 -0
- package/dist/cjs/services/items/schemas/invMastDoc.js.map +1 -0
- package/dist/cjs/services/items/schemas/invMastLinks.d.ts +147 -0
- package/dist/cjs/services/items/schemas/invMastLinks.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/invMastLinks.js +10 -0
- package/dist/cjs/services/items/schemas/invMastLinks.js.map +1 -0
- package/dist/cjs/services/items/schemas/invMastSimilar.d.ts +127 -0
- package/dist/cjs/services/items/schemas/invMastSimilar.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/invMastSimilar.js +21 -0
- package/dist/cjs/services/items/schemas/invMastSimilar.js.map +1 -0
- package/dist/cjs/services/items/schemas/invMastSub.d.ts +127 -0
- package/dist/cjs/services/items/schemas/invMastSub.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/invMastSub.js +21 -0
- package/dist/cjs/services/items/schemas/invMastSub.js.map +1 -0
- package/dist/cjs/services/items/schemas/invMastSubParts.d.ts +187 -0
- package/dist/cjs/services/items/schemas/invMastSubParts.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/invMastSubParts.js +14 -0
- package/dist/cjs/services/items/schemas/invMastSubParts.js.map +1 -0
- package/dist/cjs/services/items/schemas/itemFavorites.d.ts +236 -0
- package/dist/cjs/services/items/schemas/itemFavorites.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/itemFavorites.js +11 -0
- package/dist/cjs/services/items/schemas/itemFavorites.js.map +1 -0
- package/dist/cjs/services/items/schemas/locationsBins.d.ts +381 -0
- package/dist/cjs/services/items/schemas/locationsBins.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/locationsBins.js +35 -0
- package/dist/cjs/services/items/schemas/locationsBins.js.map +1 -0
- package/dist/cjs/services/legacy/client.d.ts +522 -280
- package/dist/cjs/services/legacy/client.d.ts.map +1 -1
- package/dist/cjs/services/legacy/client.js +388 -146
- package/dist/cjs/services/legacy/client.js.map +1 -1
- package/dist/cjs/services/nexus/client.d.ts +169 -156
- package/dist/cjs/services/nexus/client.d.ts.map +1 -1
- package/dist/cjs/services/nexus/client.js +158 -145
- package/dist/cjs/services/nexus/client.js.map +1 -1
- package/dist/cjs/services/open-search/client.d.ts +434 -162
- package/dist/cjs/services/open-search/client.d.ts.map +1 -1
- package/dist/cjs/services/open-search/client.js +248 -115
- package/dist/cjs/services/open-search/client.js.map +1 -1
- package/dist/cjs/services/{pricing/schemas/health.d.ts → open-search/schemas/healthCheck.d.ts} +19 -49
- package/dist/cjs/services/open-search/schemas/healthCheck.d.ts.map +1 -0
- package/dist/cjs/services/open-search/schemas/healthCheck.js +17 -0
- package/dist/cjs/services/open-search/schemas/healthCheck.js.map +1 -0
- package/dist/cjs/services/open-search/schemas/index.d.ts +5 -0
- package/dist/cjs/services/open-search/schemas/index.d.ts.map +1 -1
- package/dist/cjs/services/open-search/schemas/index.js +27 -0
- package/dist/cjs/services/open-search/schemas/index.js.map +1 -1
- package/dist/cjs/services/open-search/schemas/itemSearch.d.ts +394 -0
- package/dist/cjs/services/open-search/schemas/itemSearch.d.ts.map +1 -0
- package/dist/cjs/services/open-search/schemas/itemSearch.js +74 -0
- package/dist/cjs/services/open-search/schemas/itemSearch.js.map +1 -0
- package/dist/cjs/services/open-search/schemas/itemSearchAttributes.d.ts +359 -0
- package/dist/cjs/services/open-search/schemas/itemSearchAttributes.d.ts.map +1 -0
- package/dist/cjs/services/open-search/schemas/itemSearchAttributes.js +47 -0
- package/dist/cjs/services/open-search/schemas/itemSearchAttributes.js.map +1 -0
- package/dist/cjs/services/open-search/schemas/itemsRefresh.d.ts +512 -0
- package/dist/cjs/services/open-search/schemas/itemsRefresh.d.ts.map +1 -0
- package/dist/cjs/services/open-search/schemas/itemsRefresh.js +62 -0
- package/dist/cjs/services/open-search/schemas/itemsRefresh.js.map +1 -0
- package/dist/cjs/services/open-search/schemas/ping.d.ts +57 -0
- package/dist/cjs/services/open-search/schemas/ping.d.ts.map +1 -0
- package/dist/cjs/services/open-search/schemas/ping.js +14 -0
- package/dist/cjs/services/open-search/schemas/ping.js.map +1 -0
- package/dist/cjs/services/orders/client.d.ts +496 -646
- package/dist/cjs/services/orders/client.d.ts.map +1 -1
- package/dist/cjs/services/orders/client.js +311 -476
- package/dist/cjs/services/orders/client.js.map +1 -1
- package/dist/cjs/services/orders/schemas/invoices.d.ts +10 -10
- package/dist/cjs/services/orders/schemas/invoices.js +1 -1
- package/dist/cjs/services/p21-apis/client.d.ts +311 -534
- package/dist/cjs/services/p21-apis/client.d.ts.map +1 -1
- package/dist/cjs/services/p21-apis/client.js +303 -636
- package/dist/cjs/services/p21-apis/client.js.map +1 -1
- package/dist/cjs/services/p21-apis/schemas.d.ts +9 -78
- package/dist/cjs/services/p21-apis/schemas.d.ts.map +1 -1
- package/dist/cjs/services/p21-apis/schemas.js +9 -32
- package/dist/cjs/services/p21-apis/schemas.js.map +1 -1
- package/dist/cjs/services/p21-core/client.d.ts +111 -75
- package/dist/cjs/services/p21-core/client.d.ts.map +1 -1
- package/dist/cjs/services/p21-core/client.js +146 -106
- package/dist/cjs/services/p21-core/client.js.map +1 -1
- package/dist/cjs/services/p21-pim/client.d.ts +163 -37
- package/dist/cjs/services/p21-pim/client.d.ts.map +1 -1
- package/dist/cjs/services/p21-pim/client.js +163 -37
- package/dist/cjs/services/p21-pim/client.js.map +1 -1
- package/dist/cjs/services/p21-pim/schemas/ai-suggestions.d.ts +6 -6
- package/dist/cjs/services/p21-pim/schemas/ai-suggestions.d.ts.map +1 -1
- package/dist/cjs/services/p21-pim/schemas/ai-suggestions.js +1 -1
- package/dist/cjs/services/p21-pim/schemas/ai-suggestions.js.map +1 -1
- package/dist/cjs/services/p21-pim/schemas/inventory.d.ts +32 -32
- package/dist/cjs/services/p21-sism/client.d.ts +315 -261
- package/dist/cjs/services/p21-sism/client.d.ts.map +1 -1
- package/dist/cjs/services/p21-sism/client.js +371 -313
- package/dist/cjs/services/p21-sism/client.js.map +1 -1
- package/dist/cjs/services/pricing/client.d.ts +289 -59
- package/dist/cjs/services/pricing/client.d.ts.map +1 -1
- package/dist/cjs/services/pricing/client.js +318 -70
- package/dist/cjs/services/pricing/client.js.map +1 -1
- package/dist/cjs/services/pricing/schemas/healthCheck.d.ts +70 -0
- package/dist/cjs/services/pricing/schemas/healthCheck.d.ts.map +1 -0
- package/dist/cjs/services/pricing/schemas/{health.js → healthCheck.js} +2 -3
- package/dist/cjs/services/pricing/schemas/healthCheck.js.map +1 -0
- package/dist/cjs/services/pricing/schemas/index.d.ts +6 -4
- package/dist/cjs/services/pricing/schemas/index.d.ts.map +1 -1
- package/dist/cjs/services/pricing/schemas/index.js +9 -5
- package/dist/cjs/services/pricing/schemas/index.js.map +1 -1
- package/dist/cjs/services/pricing/schemas/jobPriceHdr.d.ts +391 -0
- package/dist/cjs/services/pricing/schemas/jobPriceHdr.d.ts.map +1 -0
- package/dist/cjs/services/pricing/schemas/jobPriceHdr.js +34 -0
- package/dist/cjs/services/pricing/schemas/jobPriceHdr.js.map +1 -0
- package/dist/cjs/services/pricing/schemas/{job-pricing.d.ts → jobPriceHdrLines.d.ts} +1 -390
- package/dist/cjs/services/pricing/schemas/jobPriceHdrLines.d.ts.map +1 -0
- package/dist/cjs/services/pricing/schemas/{job-pricing.js → jobPriceHdrLines.js} +5 -29
- package/dist/cjs/services/pricing/schemas/jobPriceHdrLines.js.map +1 -0
- package/dist/cjs/services/pricing/schemas/ping.d.ts +49 -0
- package/dist/cjs/services/pricing/schemas/ping.d.ts.map +1 -0
- package/dist/cjs/services/pricing/schemas/ping.js +6 -0
- package/dist/cjs/services/pricing/schemas/ping.js.map +1 -0
- package/dist/cjs/services/pricing/schemas/{pricing.d.ts → priceEngine.d.ts} +1 -1
- package/dist/cjs/services/pricing/schemas/priceEngine.d.ts.map +1 -0
- package/dist/cjs/services/pricing/schemas/{pricing.js → priceEngine.js} +4 -2
- package/dist/cjs/services/pricing/schemas/priceEngine.js.map +1 -0
- package/dist/{types/services/pricing/schemas/tax.d.ts → cjs/services/pricing/schemas/taxEngine.d.ts} +1 -1
- package/dist/cjs/services/pricing/schemas/taxEngine.d.ts.map +1 -0
- package/dist/cjs/services/pricing/schemas/{tax.js → taxEngine.js} +7 -2
- package/dist/cjs/services/pricing/schemas/taxEngine.js.map +1 -0
- package/dist/cjs/services/shipping/client.d.ts +47 -110
- package/dist/cjs/services/shipping/client.d.ts.map +1 -1
- package/dist/cjs/services/shipping/client.js +62 -115
- package/dist/cjs/services/shipping/client.js.map +1 -1
- package/dist/cjs/services/shipping/index.d.ts +2 -2
- package/dist/cjs/services/shipping/index.d.ts.map +1 -1
- package/dist/cjs/services/shipping/index.js +3 -3
- package/dist/cjs/services/shipping/index.js.map +1 -1
- package/dist/cjs/services/shipping/schemas/healthCheck.d.ts +118 -0
- package/dist/cjs/services/shipping/schemas/healthCheck.d.ts.map +1 -0
- package/dist/cjs/services/shipping/schemas/healthCheck.js +27 -0
- package/dist/cjs/services/shipping/schemas/healthCheck.js.map +1 -0
- package/dist/cjs/services/shipping/schemas/index.d.ts +5 -0
- package/dist/cjs/services/shipping/schemas/index.d.ts.map +1 -0
- package/dist/cjs/services/shipping/schemas/index.js +18 -0
- package/dist/cjs/services/shipping/schemas/index.js.map +1 -0
- package/dist/cjs/services/shipping/{schemas.d.ts → schemas/rates.d.ts} +1 -117
- package/dist/cjs/services/shipping/{schemas.d.ts.map → schemas/rates.d.ts.map} +1 -1
- package/dist/cjs/services/shipping/{schemas.js → schemas/rates.js} +3 -27
- package/dist/cjs/services/shipping/schemas/rates.js.map +1 -0
- package/dist/cjs/services/slack/client.d.ts +289 -260
- package/dist/cjs/services/slack/client.d.ts.map +1 -1
- package/dist/cjs/services/slack/client.js +322 -279
- package/dist/cjs/services/slack/client.js.map +1 -1
- package/dist/cjs/services/slack/index.d.ts +2 -2
- package/dist/cjs/services/slack/index.d.ts.map +1 -1
- package/dist/cjs/services/slack/index.js +5 -5
- package/dist/cjs/services/slack/index.js.map +1 -1
- package/dist/cjs/services/slack/schemas/healthCheck.d.ts +138 -0
- package/dist/cjs/services/slack/schemas/healthCheck.d.ts.map +1 -0
- package/dist/cjs/services/slack/schemas/healthCheck.js +29 -0
- package/dist/cjs/services/slack/schemas/healthCheck.js.map +1 -0
- package/dist/cjs/services/slack/schemas/index.d.ts +4 -0
- package/dist/cjs/services/slack/schemas/index.d.ts.map +1 -0
- package/dist/cjs/services/slack/schemas/index.js +19 -0
- package/dist/cjs/services/slack/schemas/index.js.map +1 -0
- package/dist/{types/services/slack/schemas.d.ts → cjs/services/slack/schemas/webHook.d.ts} +3 -298
- package/dist/cjs/services/slack/schemas/webHook.d.ts.map +1 -0
- package/dist/cjs/services/slack/{schemas.js → schemas/webHook.js} +4 -56
- package/dist/cjs/services/slack/schemas/webHook.js.map +1 -0
- package/dist/cjs/services/slack/schemas/webHookRefresh.d.ts +161 -0
- package/dist/cjs/services/slack/schemas/webHookRefresh.d.ts.map +1 -0
- package/dist/cjs/services/slack/schemas/webHookRefresh.js +32 -0
- package/dist/cjs/services/slack/schemas/webHookRefresh.js.map +1 -0
- package/dist/cjs/services/smarty-streets/client.d.ts +238 -214
- package/dist/cjs/services/smarty-streets/client.d.ts.map +1 -1
- package/dist/cjs/services/smarty-streets/client.js +273 -250
- package/dist/cjs/services/smarty-streets/client.js.map +1 -1
- package/dist/cjs/services/smarty-streets/index.d.ts +2 -2
- package/dist/cjs/services/smarty-streets/index.d.ts.map +1 -1
- package/dist/cjs/services/smarty-streets/index.js +9 -9
- package/dist/cjs/services/smarty-streets/index.js.map +1 -1
- package/dist/cjs/services/smarty-streets/schemas/healthCheck.d.ts +140 -0
- package/dist/cjs/services/smarty-streets/schemas/healthCheck.d.ts.map +1 -0
- package/dist/cjs/services/smarty-streets/schemas/healthCheck.js +31 -0
- package/dist/cjs/services/smarty-streets/schemas/healthCheck.js.map +1 -0
- package/dist/cjs/services/smarty-streets/schemas/index.d.ts +7 -0
- package/dist/cjs/services/smarty-streets/schemas/index.d.ts.map +1 -0
- package/dist/cjs/services/smarty-streets/schemas/index.js +25 -0
- package/dist/cjs/services/smarty-streets/schemas/index.js.map +1 -0
- package/dist/cjs/services/smarty-streets/schemas/ping.d.ts +120 -0
- package/dist/cjs/services/smarty-streets/schemas/ping.d.ts.map +1 -0
- package/dist/cjs/services/smarty-streets/schemas/ping.js +29 -0
- package/dist/cjs/services/smarty-streets/schemas/ping.js.map +1 -0
- package/dist/cjs/services/smarty-streets/{schemas.d.ts → schemas/usLookup.d.ts} +11 -262
- package/dist/cjs/services/smarty-streets/schemas/usLookup.d.ts.map +1 -0
- package/dist/cjs/services/smarty-streets/{schemas.js → schemas/usLookup.js} +9 -55
- package/dist/cjs/services/smarty-streets/schemas/usLookup.js.map +1 -0
- package/dist/cjs/services/ups/client.d.ts +65 -95
- package/dist/cjs/services/ups/client.d.ts.map +1 -1
- package/dist/cjs/services/ups/client.js +76 -105
- package/dist/cjs/services/ups/client.js.map +1 -1
- package/dist/cjs/services/ups/schemas/healthCheck.d.ts +138 -0
- package/dist/cjs/services/ups/schemas/healthCheck.d.ts.map +1 -0
- package/dist/cjs/services/ups/schemas/healthCheck.js +29 -0
- package/dist/cjs/services/ups/schemas/healthCheck.js.map +1 -0
- package/dist/cjs/services/ups/schemas/index.d.ts +5 -0
- package/dist/cjs/services/ups/schemas/index.d.ts.map +1 -0
- package/dist/cjs/services/ups/schemas/index.js +18 -0
- package/dist/cjs/services/ups/schemas/index.js.map +1 -0
- package/dist/cjs/services/ups/schemas/ratesShop.d.ts +1751 -0
- package/dist/cjs/services/ups/schemas/ratesShop.d.ts.map +1 -0
- package/dist/cjs/services/ups/schemas/ratesShop.js +175 -0
- package/dist/cjs/services/ups/schemas/ratesShop.js.map +1 -0
- package/dist/cjs/services/ups/schemas.d.ts +4 -1886
- package/dist/cjs/services/ups/schemas.d.ts.map +1 -1
- package/dist/cjs/services/ups/schemas.js +15 -198
- package/dist/cjs/services/ups/schemas.js.map +1 -1
- package/dist/cjs/services/vmi/client.d.ts +605 -550
- package/dist/cjs/services/vmi/client.d.ts.map +1 -1
- package/dist/cjs/services/vmi/client.js +604 -558
- package/dist/cjs/services/vmi/client.js.map +1 -1
- package/dist/esm/client.d.ts +78 -0
- package/dist/esm/client.d.ts.map +1 -1
- package/dist/esm/client.js +182 -0
- package/dist/esm/client.js.map +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/esm/services/agr-info/client.d.ts +579 -545
- package/dist/esm/services/agr-info/client.d.ts.map +1 -1
- package/dist/esm/services/agr-info/client.js +440 -407
- package/dist/esm/services/agr-info/client.js.map +1 -1
- package/dist/esm/services/agr-site/client.d.ts +156 -85
- package/dist/esm/services/agr-site/client.d.ts.map +1 -1
- package/dist/esm/services/agr-site/client.js +179 -106
- package/dist/esm/services/agr-site/client.js.map +1 -1
- package/dist/esm/services/agr-work/client.d.ts +152 -96
- package/dist/esm/services/agr-work/client.d.ts.map +1 -1
- package/dist/esm/services/agr-work/client.js +155 -81
- package/dist/esm/services/agr-work/client.js.map +1 -1
- package/dist/esm/services/avalara/client.d.ts +260 -316
- package/dist/esm/services/avalara/client.d.ts.map +1 -1
- package/dist/esm/services/avalara/client.js +195 -137
- package/dist/esm/services/avalara/client.js.map +1 -1
- package/dist/esm/services/brand-folder/client.d.ts +200 -170
- package/dist/esm/services/brand-folder/client.d.ts.map +1 -1
- package/dist/esm/services/brand-folder/client.js +182 -125
- package/dist/esm/services/brand-folder/client.js.map +1 -1
- package/dist/esm/services/brand-folder/schemas.d.ts +8 -8
- package/dist/esm/services/commerce/client.d.ts +821 -877
- package/dist/esm/services/commerce/client.d.ts.map +1 -1
- package/dist/esm/services/commerce/client.js +844 -488
- package/dist/esm/services/commerce/client.js.map +1 -1
- package/dist/esm/services/customers/client.d.ts +310 -565
- package/dist/esm/services/customers/client.d.ts.map +1 -1
- package/dist/esm/services/customers/client.js +224 -452
- package/dist/esm/services/customers/client.js.map +1 -1
- package/dist/esm/services/gregorovich/client.d.ts +347 -311
- package/dist/esm/services/gregorovich/client.d.ts.map +1 -1
- package/dist/esm/services/gregorovich/client.js +292 -254
- package/dist/esm/services/gregorovich/client.js.map +1 -1
- package/dist/esm/services/gregorovich/index.d.ts +1 -1
- package/dist/esm/services/gregorovich/index.d.ts.map +1 -1
- package/dist/esm/services/gregorovich/schemas/chatGptAsk.d.ts +371 -0
- package/dist/esm/services/gregorovich/schemas/chatGptAsk.d.ts.map +1 -0
- package/dist/esm/services/gregorovich/schemas/chatGptAsk.js +68 -0
- package/dist/esm/services/gregorovich/schemas/chatGptAsk.js.map +1 -0
- package/dist/esm/services/gregorovich/schemas/documents.d.ts +398 -0
- package/dist/esm/services/gregorovich/schemas/documents.d.ts.map +1 -0
- package/dist/esm/services/gregorovich/schemas/documents.js +58 -0
- package/dist/esm/services/gregorovich/schemas/documents.js.map +1 -0
- package/dist/esm/services/gregorovich/schemas/healthCheck.d.ts +53 -0
- package/dist/esm/services/gregorovich/schemas/healthCheck.d.ts.map +1 -0
- package/dist/esm/services/gregorovich/schemas/healthCheck.js +8 -0
- package/dist/esm/services/gregorovich/schemas/healthCheck.js.map +1 -0
- package/dist/esm/services/gregorovich/schemas/index.d.ts +5 -0
- package/dist/esm/services/gregorovich/schemas/index.d.ts.map +1 -0
- package/dist/esm/services/gregorovich/schemas/index.js +9 -0
- package/dist/esm/services/gregorovich/schemas/index.js.map +1 -0
- package/dist/esm/services/gregorovich/schemas/ollamaGenerate.d.ts +433 -0
- package/dist/esm/services/gregorovich/schemas/ollamaGenerate.d.ts.map +1 -0
- package/dist/esm/services/gregorovich/schemas/ollamaGenerate.js +97 -0
- package/dist/esm/services/gregorovich/schemas/ollamaGenerate.js.map +1 -0
- package/dist/esm/services/gregorovich/schemas.d.ts +1 -1217
- package/dist/esm/services/gregorovich/schemas.d.ts.map +1 -1
- package/dist/esm/services/gregorovich/schemas.js +2 -197
- package/dist/esm/services/gregorovich/schemas.js.map +1 -1
- package/dist/esm/services/items/client.d.ts +1865 -1724
- package/dist/esm/services/items/client.d.ts.map +1 -1
- package/dist/esm/services/items/client.js +1738 -1176
- package/dist/esm/services/items/client.js.map +1 -1
- package/dist/esm/services/items/schemas/attributes.d.ts +2 -2
- package/dist/esm/services/items/schemas/brandsItems.d.ts +304 -0
- package/dist/esm/services/items/schemas/brandsItems.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/brandsItems.js +41 -0
- package/dist/esm/services/items/schemas/brandsItems.js.map +1 -0
- package/dist/esm/services/items/schemas/categoriesImages.d.ts +127 -0
- package/dist/esm/services/items/schemas/categoriesImages.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/categoriesImages.js +21 -0
- package/dist/esm/services/items/schemas/categoriesImages.js.map +1 -0
- package/dist/esm/services/items/schemas/index.d.ts +12 -0
- package/dist/esm/services/items/schemas/index.d.ts.map +1 -1
- package/dist/esm/services/items/schemas/index.js +12 -0
- package/dist/esm/services/items/schemas/index.js.map +1 -1
- package/dist/esm/services/items/schemas/internalPdf.d.ts +212 -0
- package/dist/esm/services/items/schemas/internalPdf.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/internalPdf.js +41 -0
- package/dist/esm/services/items/schemas/internalPdf.js.map +1 -0
- package/dist/esm/services/items/schemas/invMastAccessory.d.ts +127 -0
- package/dist/esm/services/items/schemas/invMastAccessory.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/invMastAccessory.js +18 -0
- package/dist/esm/services/items/schemas/invMastAccessory.js.map +1 -0
- package/dist/esm/services/items/schemas/invMastAlternateCode.d.ts +147 -0
- package/dist/esm/services/items/schemas/invMastAlternateCode.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/invMastAlternateCode.js +23 -0
- package/dist/esm/services/items/schemas/invMastAlternateCode.js.map +1 -0
- package/dist/esm/services/items/schemas/invMastAttributes.d.ts +177 -0
- package/dist/esm/services/items/schemas/invMastAttributes.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/invMastAttributes.js +32 -0
- package/dist/esm/services/items/schemas/invMastAttributes.js.map +1 -0
- package/dist/esm/services/items/schemas/invMastAttributesValues.d.ts +333 -0
- package/dist/esm/services/items/schemas/invMastAttributesValues.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/invMastAttributesValues.js +46 -0
- package/dist/esm/services/items/schemas/invMastAttributesValues.js.map +1 -0
- package/dist/esm/services/items/schemas/invMastDoc.d.ts +137 -0
- package/dist/esm/services/items/schemas/invMastDoc.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/invMastDoc.js +19 -0
- package/dist/esm/services/items/schemas/invMastDoc.js.map +1 -0
- package/dist/esm/services/items/schemas/invMastLinks.d.ts +147 -0
- package/dist/esm/services/items/schemas/invMastLinks.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/invMastLinks.js +7 -0
- package/dist/esm/services/items/schemas/invMastLinks.js.map +1 -0
- package/dist/esm/services/items/schemas/invMastSimilar.d.ts +127 -0
- package/dist/esm/services/items/schemas/invMastSimilar.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/invMastSimilar.js +18 -0
- package/dist/esm/services/items/schemas/invMastSimilar.js.map +1 -0
- package/dist/esm/services/items/schemas/invMastSub.d.ts +127 -0
- package/dist/esm/services/items/schemas/invMastSub.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/invMastSub.js +18 -0
- package/dist/esm/services/items/schemas/invMastSub.js.map +1 -0
- package/dist/esm/services/items/schemas/invMastSubParts.d.ts +187 -0
- package/dist/esm/services/items/schemas/invMastSubParts.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/invMastSubParts.js +11 -0
- package/dist/esm/services/items/schemas/invMastSubParts.js.map +1 -0
- package/dist/esm/services/items/schemas/itemFavorites.d.ts +236 -0
- package/dist/esm/services/items/schemas/itemFavorites.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/itemFavorites.js +8 -0
- package/dist/esm/services/items/schemas/itemFavorites.js.map +1 -0
- package/dist/esm/services/items/schemas/locationsBins.d.ts +381 -0
- package/dist/esm/services/items/schemas/locationsBins.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/locationsBins.js +32 -0
- package/dist/esm/services/items/schemas/locationsBins.js.map +1 -0
- package/dist/esm/services/legacy/client.d.ts +522 -280
- package/dist/esm/services/legacy/client.d.ts.map +1 -1
- package/dist/esm/services/legacy/client.js +388 -146
- package/dist/esm/services/legacy/client.js.map +1 -1
- package/dist/esm/services/nexus/client.d.ts +169 -156
- package/dist/esm/services/nexus/client.d.ts.map +1 -1
- package/dist/esm/services/nexus/client.js +158 -145
- package/dist/esm/services/nexus/client.js.map +1 -1
- package/dist/esm/services/open-search/client.d.ts +434 -162
- package/dist/esm/services/open-search/client.d.ts.map +1 -1
- package/dist/esm/services/open-search/client.js +253 -116
- package/dist/esm/services/open-search/client.js.map +1 -1
- package/dist/esm/services/{pricing/schemas/health.d.ts → open-search/schemas/healthCheck.d.ts} +19 -49
- package/dist/esm/services/open-search/schemas/healthCheck.d.ts.map +1 -0
- package/dist/esm/services/open-search/schemas/healthCheck.js +14 -0
- package/dist/esm/services/open-search/schemas/healthCheck.js.map +1 -0
- package/dist/esm/services/open-search/schemas/index.d.ts +5 -0
- package/dist/esm/services/open-search/schemas/index.d.ts.map +1 -1
- package/dist/esm/services/open-search/schemas/index.js +6 -0
- package/dist/esm/services/open-search/schemas/index.js.map +1 -1
- package/dist/esm/services/open-search/schemas/itemSearch.d.ts +394 -0
- package/dist/esm/services/open-search/schemas/itemSearch.d.ts.map +1 -0
- package/dist/esm/services/open-search/schemas/itemSearch.js +71 -0
- package/dist/esm/services/open-search/schemas/itemSearch.js.map +1 -0
- package/dist/esm/services/open-search/schemas/itemSearchAttributes.d.ts +359 -0
- package/dist/esm/services/open-search/schemas/itemSearchAttributes.d.ts.map +1 -0
- package/dist/esm/services/open-search/schemas/itemSearchAttributes.js +44 -0
- package/dist/esm/services/open-search/schemas/itemSearchAttributes.js.map +1 -0
- package/dist/esm/services/open-search/schemas/itemsRefresh.d.ts +512 -0
- package/dist/esm/services/open-search/schemas/itemsRefresh.d.ts.map +1 -0
- package/dist/esm/services/open-search/schemas/itemsRefresh.js +59 -0
- package/dist/esm/services/open-search/schemas/itemsRefresh.js.map +1 -0
- package/dist/esm/services/open-search/schemas/ping.d.ts +57 -0
- package/dist/esm/services/open-search/schemas/ping.d.ts.map +1 -0
- package/dist/esm/services/open-search/schemas/ping.js +11 -0
- package/dist/esm/services/open-search/schemas/ping.js.map +1 -0
- package/dist/esm/services/orders/client.d.ts +496 -646
- package/dist/esm/services/orders/client.d.ts.map +1 -1
- package/dist/esm/services/orders/client.js +311 -476
- package/dist/esm/services/orders/client.js.map +1 -1
- package/dist/esm/services/orders/schemas/invoices.d.ts +10 -10
- package/dist/esm/services/orders/schemas/invoices.js +1 -1
- package/dist/esm/services/p21-apis/client.d.ts +311 -534
- package/dist/esm/services/p21-apis/client.d.ts.map +1 -1
- package/dist/esm/services/p21-apis/client.js +304 -637
- package/dist/esm/services/p21-apis/client.js.map +1 -1
- package/dist/esm/services/p21-apis/schemas.d.ts +9 -78
- package/dist/esm/services/p21-apis/schemas.d.ts.map +1 -1
- package/dist/esm/services/p21-apis/schemas.js +9 -32
- package/dist/esm/services/p21-apis/schemas.js.map +1 -1
- package/dist/esm/services/p21-core/client.d.ts +111 -75
- package/dist/esm/services/p21-core/client.d.ts.map +1 -1
- package/dist/esm/services/p21-core/client.js +146 -106
- package/dist/esm/services/p21-core/client.js.map +1 -1
- package/dist/esm/services/p21-pim/client.d.ts +163 -37
- package/dist/esm/services/p21-pim/client.d.ts.map +1 -1
- package/dist/esm/services/p21-pim/client.js +163 -37
- package/dist/esm/services/p21-pim/client.js.map +1 -1
- package/dist/esm/services/p21-pim/schemas/ai-suggestions.d.ts +6 -6
- package/dist/esm/services/p21-pim/schemas/ai-suggestions.d.ts.map +1 -1
- package/dist/esm/services/p21-pim/schemas/ai-suggestions.js +1 -1
- package/dist/esm/services/p21-pim/schemas/ai-suggestions.js.map +1 -1
- package/dist/esm/services/p21-pim/schemas/inventory.d.ts +32 -32
- package/dist/esm/services/p21-sism/client.d.ts +315 -261
- package/dist/esm/services/p21-sism/client.d.ts.map +1 -1
- package/dist/esm/services/p21-sism/client.js +371 -313
- package/dist/esm/services/p21-sism/client.js.map +1 -1
- package/dist/esm/services/pricing/client.d.ts +289 -59
- package/dist/esm/services/pricing/client.d.ts.map +1 -1
- package/dist/esm/services/pricing/client.js +318 -70
- package/dist/esm/services/pricing/client.js.map +1 -1
- package/dist/esm/services/pricing/schemas/healthCheck.d.ts +70 -0
- package/dist/esm/services/pricing/schemas/healthCheck.d.ts.map +1 -0
- package/dist/esm/services/pricing/schemas/healthCheck.js +3 -0
- package/dist/esm/services/pricing/schemas/healthCheck.js.map +1 -0
- package/dist/esm/services/pricing/schemas/index.d.ts +6 -4
- package/dist/esm/services/pricing/schemas/index.d.ts.map +1 -1
- package/dist/esm/services/pricing/schemas/index.js +9 -5
- package/dist/esm/services/pricing/schemas/index.js.map +1 -1
- package/dist/esm/services/pricing/schemas/jobPriceHdr.d.ts +391 -0
- package/dist/esm/services/pricing/schemas/jobPriceHdr.d.ts.map +1 -0
- package/dist/esm/services/pricing/schemas/jobPriceHdr.js +31 -0
- package/dist/esm/services/pricing/schemas/jobPriceHdr.js.map +1 -0
- package/dist/{types/services/pricing/schemas/job-pricing.d.ts → esm/services/pricing/schemas/jobPriceHdrLines.d.ts} +1 -390
- package/dist/esm/services/pricing/schemas/jobPriceHdrLines.d.ts.map +1 -0
- package/dist/esm/services/pricing/schemas/{job-pricing.js → jobPriceHdrLines.js} +4 -28
- package/dist/esm/services/pricing/schemas/jobPriceHdrLines.js.map +1 -0
- package/dist/esm/services/pricing/schemas/ping.d.ts +49 -0
- package/dist/esm/services/pricing/schemas/ping.d.ts.map +1 -0
- package/dist/esm/services/pricing/schemas/ping.js +3 -0
- package/dist/esm/services/pricing/schemas/ping.js.map +1 -0
- package/dist/{types/services/pricing/schemas/pricing.d.ts → esm/services/pricing/schemas/priceEngine.d.ts} +1 -1
- package/dist/esm/services/pricing/schemas/priceEngine.d.ts.map +1 -0
- package/dist/esm/services/pricing/schemas/{pricing.js → priceEngine.js} +4 -2
- package/dist/esm/services/pricing/schemas/priceEngine.js.map +1 -0
- package/dist/{cjs/services/pricing/schemas/tax.d.ts → esm/services/pricing/schemas/taxEngine.d.ts} +1 -1
- package/dist/esm/services/pricing/schemas/taxEngine.d.ts.map +1 -0
- package/dist/esm/services/pricing/schemas/{tax.js → taxEngine.js} +7 -2
- package/dist/esm/services/pricing/schemas/taxEngine.js.map +1 -0
- package/dist/esm/services/shipping/client.d.ts +47 -110
- package/dist/esm/services/shipping/client.d.ts.map +1 -1
- package/dist/esm/services/shipping/client.js +62 -115
- package/dist/esm/services/shipping/client.js.map +1 -1
- package/dist/esm/services/shipping/index.d.ts +2 -2
- package/dist/esm/services/shipping/index.d.ts.map +1 -1
- package/dist/esm/services/shipping/index.js +1 -1
- package/dist/esm/services/shipping/index.js.map +1 -1
- package/dist/esm/services/shipping/schemas/healthCheck.d.ts +118 -0
- package/dist/esm/services/shipping/schemas/healthCheck.d.ts.map +1 -0
- package/dist/esm/services/shipping/schemas/healthCheck.js +24 -0
- package/dist/esm/services/shipping/schemas/healthCheck.js.map +1 -0
- package/dist/esm/services/shipping/schemas/index.d.ts +5 -0
- package/dist/esm/services/shipping/schemas/index.d.ts.map +1 -0
- package/dist/esm/services/shipping/schemas/index.js +5 -0
- package/dist/esm/services/shipping/schemas/index.js.map +1 -0
- package/dist/esm/services/shipping/{schemas.d.ts → schemas/rates.d.ts} +1 -117
- package/dist/{types/services/shipping/schemas.d.ts.map → esm/services/shipping/schemas/rates.d.ts.map} +1 -1
- package/dist/esm/services/shipping/{schemas.js → schemas/rates.js} +2 -26
- package/dist/esm/services/shipping/schemas/rates.js.map +1 -0
- package/dist/esm/services/slack/client.d.ts +289 -260
- package/dist/esm/services/slack/client.d.ts.map +1 -1
- package/dist/esm/services/slack/client.js +323 -280
- package/dist/esm/services/slack/client.js.map +1 -1
- package/dist/esm/services/slack/index.d.ts +2 -2
- package/dist/esm/services/slack/index.d.ts.map +1 -1
- package/dist/esm/services/slack/index.js +1 -1
- package/dist/esm/services/slack/index.js.map +1 -1
- package/dist/esm/services/slack/schemas/healthCheck.d.ts +138 -0
- package/dist/esm/services/slack/schemas/healthCheck.d.ts.map +1 -0
- package/dist/esm/services/slack/schemas/healthCheck.js +26 -0
- package/dist/esm/services/slack/schemas/healthCheck.js.map +1 -0
- package/dist/esm/services/slack/schemas/index.d.ts +4 -0
- package/dist/esm/services/slack/schemas/index.d.ts.map +1 -0
- package/dist/esm/services/slack/schemas/index.js +7 -0
- package/dist/esm/services/slack/schemas/index.js.map +1 -0
- package/dist/esm/services/slack/{schemas.d.ts → schemas/webHook.d.ts} +3 -298
- package/dist/esm/services/slack/schemas/webHook.d.ts.map +1 -0
- package/dist/esm/services/slack/{schemas.js → schemas/webHook.js} +3 -55
- package/dist/esm/services/slack/schemas/webHook.js.map +1 -0
- package/dist/esm/services/slack/schemas/webHookRefresh.d.ts +161 -0
- package/dist/esm/services/slack/schemas/webHookRefresh.d.ts.map +1 -0
- package/dist/esm/services/slack/schemas/webHookRefresh.js +29 -0
- package/dist/esm/services/slack/schemas/webHookRefresh.js.map +1 -0
- package/dist/esm/services/smarty-streets/client.d.ts +238 -214
- package/dist/esm/services/smarty-streets/client.d.ts.map +1 -1
- package/dist/esm/services/smarty-streets/client.js +274 -251
- package/dist/esm/services/smarty-streets/client.js.map +1 -1
- package/dist/esm/services/smarty-streets/index.d.ts +2 -2
- package/dist/esm/services/smarty-streets/index.d.ts.map +1 -1
- package/dist/esm/services/smarty-streets/index.js +2 -2
- package/dist/esm/services/smarty-streets/index.js.map +1 -1
- package/dist/esm/services/smarty-streets/schemas/healthCheck.d.ts +140 -0
- package/dist/esm/services/smarty-streets/schemas/healthCheck.d.ts.map +1 -0
- package/dist/esm/services/smarty-streets/schemas/healthCheck.js +28 -0
- package/dist/esm/services/smarty-streets/schemas/healthCheck.js.map +1 -0
- package/dist/esm/services/smarty-streets/schemas/index.d.ts +7 -0
- package/dist/esm/services/smarty-streets/schemas/index.d.ts.map +1 -0
- package/dist/esm/services/smarty-streets/schemas/index.js +8 -0
- package/dist/esm/services/smarty-streets/schemas/index.js.map +1 -0
- package/dist/esm/services/smarty-streets/schemas/ping.d.ts +120 -0
- package/dist/esm/services/smarty-streets/schemas/ping.d.ts.map +1 -0
- package/dist/esm/services/smarty-streets/schemas/ping.js +26 -0
- package/dist/esm/services/smarty-streets/schemas/ping.js.map +1 -0
- package/dist/esm/services/smarty-streets/{schemas.d.ts → schemas/usLookup.d.ts} +11 -262
- package/dist/esm/services/smarty-streets/schemas/usLookup.d.ts.map +1 -0
- package/dist/esm/services/smarty-streets/{schemas.js → schemas/usLookup.js} +8 -54
- package/dist/esm/services/smarty-streets/schemas/usLookup.js.map +1 -0
- package/dist/esm/services/ups/client.d.ts +65 -95
- package/dist/esm/services/ups/client.d.ts.map +1 -1
- package/dist/esm/services/ups/client.js +76 -105
- package/dist/esm/services/ups/client.js.map +1 -1
- package/dist/esm/services/ups/schemas/healthCheck.d.ts +138 -0
- package/dist/esm/services/ups/schemas/healthCheck.d.ts.map +1 -0
- package/dist/esm/services/ups/schemas/healthCheck.js +26 -0
- package/dist/esm/services/ups/schemas/healthCheck.js.map +1 -0
- package/dist/esm/services/ups/schemas/index.d.ts +5 -0
- package/dist/esm/services/ups/schemas/index.d.ts.map +1 -0
- package/dist/esm/services/ups/schemas/index.js +5 -0
- package/dist/esm/services/ups/schemas/index.js.map +1 -0
- package/dist/esm/services/ups/schemas/ratesShop.d.ts +1751 -0
- package/dist/esm/services/ups/schemas/ratesShop.d.ts.map +1 -0
- package/dist/esm/services/ups/schemas/ratesShop.js +172 -0
- package/dist/esm/services/ups/schemas/ratesShop.js.map +1 -0
- package/dist/esm/services/ups/schemas.d.ts +4 -1886
- package/dist/esm/services/ups/schemas.d.ts.map +1 -1
- package/dist/esm/services/ups/schemas.js +4 -197
- package/dist/esm/services/ups/schemas.js.map +1 -1
- package/dist/esm/services/vmi/client.d.ts +605 -550
- package/dist/esm/services/vmi/client.d.ts.map +1 -1
- package/dist/esm/services/vmi/client.js +604 -558
- package/dist/esm/services/vmi/client.js.map +1 -1
- package/dist/types/client.d.ts +78 -0
- package/dist/types/client.d.ts.map +1 -1
- package/dist/types/index.d.ts +1 -1
- package/dist/types/services/agr-info/client.d.ts +579 -545
- package/dist/types/services/agr-info/client.d.ts.map +1 -1
- package/dist/types/services/agr-site/client.d.ts +156 -85
- package/dist/types/services/agr-site/client.d.ts.map +1 -1
- package/dist/types/services/agr-work/client.d.ts +152 -96
- package/dist/types/services/agr-work/client.d.ts.map +1 -1
- package/dist/types/services/avalara/client.d.ts +260 -316
- package/dist/types/services/avalara/client.d.ts.map +1 -1
- package/dist/types/services/brand-folder/client.d.ts +200 -170
- package/dist/types/services/brand-folder/client.d.ts.map +1 -1
- package/dist/types/services/brand-folder/schemas.d.ts +8 -8
- package/dist/types/services/commerce/client.d.ts +821 -877
- package/dist/types/services/commerce/client.d.ts.map +1 -1
- package/dist/types/services/customers/client.d.ts +310 -565
- package/dist/types/services/customers/client.d.ts.map +1 -1
- package/dist/types/services/gregorovich/client.d.ts +347 -311
- package/dist/types/services/gregorovich/client.d.ts.map +1 -1
- package/dist/types/services/gregorovich/index.d.ts +1 -1
- package/dist/types/services/gregorovich/index.d.ts.map +1 -1
- package/dist/types/services/gregorovich/schemas/chatGptAsk.d.ts +371 -0
- package/dist/types/services/gregorovich/schemas/chatGptAsk.d.ts.map +1 -0
- package/dist/types/services/gregorovich/schemas/documents.d.ts +398 -0
- package/dist/types/services/gregorovich/schemas/documents.d.ts.map +1 -0
- package/dist/types/services/gregorovich/schemas/healthCheck.d.ts +53 -0
- package/dist/types/services/gregorovich/schemas/healthCheck.d.ts.map +1 -0
- package/dist/types/services/gregorovich/schemas/index.d.ts +5 -0
- package/dist/types/services/gregorovich/schemas/index.d.ts.map +1 -0
- package/dist/types/services/gregorovich/schemas/ollamaGenerate.d.ts +433 -0
- package/dist/types/services/gregorovich/schemas/ollamaGenerate.d.ts.map +1 -0
- package/dist/types/services/gregorovich/schemas.d.ts +1 -1217
- package/dist/types/services/gregorovich/schemas.d.ts.map +1 -1
- package/dist/types/services/items/client.d.ts +1865 -1724
- package/dist/types/services/items/client.d.ts.map +1 -1
- package/dist/types/services/items/schemas/attributes.d.ts +2 -2
- package/dist/types/services/items/schemas/brandsItems.d.ts +304 -0
- package/dist/types/services/items/schemas/brandsItems.d.ts.map +1 -0
- package/dist/types/services/items/schemas/categoriesImages.d.ts +127 -0
- package/dist/types/services/items/schemas/categoriesImages.d.ts.map +1 -0
- package/dist/types/services/items/schemas/index.d.ts +12 -0
- package/dist/types/services/items/schemas/index.d.ts.map +1 -1
- package/dist/types/services/items/schemas/internalPdf.d.ts +212 -0
- package/dist/types/services/items/schemas/internalPdf.d.ts.map +1 -0
- package/dist/types/services/items/schemas/invMastAccessory.d.ts +127 -0
- package/dist/types/services/items/schemas/invMastAccessory.d.ts.map +1 -0
- package/dist/types/services/items/schemas/invMastAlternateCode.d.ts +147 -0
- package/dist/types/services/items/schemas/invMastAlternateCode.d.ts.map +1 -0
- package/dist/types/services/items/schemas/invMastAttributes.d.ts +177 -0
- package/dist/types/services/items/schemas/invMastAttributes.d.ts.map +1 -0
- package/dist/types/services/items/schemas/invMastAttributesValues.d.ts +333 -0
- package/dist/types/services/items/schemas/invMastAttributesValues.d.ts.map +1 -0
- package/dist/types/services/items/schemas/invMastDoc.d.ts +137 -0
- package/dist/types/services/items/schemas/invMastDoc.d.ts.map +1 -0
- package/dist/types/services/items/schemas/invMastLinks.d.ts +147 -0
- package/dist/types/services/items/schemas/invMastLinks.d.ts.map +1 -0
- package/dist/types/services/items/schemas/invMastSimilar.d.ts +127 -0
- package/dist/types/services/items/schemas/invMastSimilar.d.ts.map +1 -0
- package/dist/types/services/items/schemas/invMastSub.d.ts +127 -0
- package/dist/types/services/items/schemas/invMastSub.d.ts.map +1 -0
- package/dist/types/services/items/schemas/invMastSubParts.d.ts +187 -0
- package/dist/types/services/items/schemas/invMastSubParts.d.ts.map +1 -0
- package/dist/types/services/items/schemas/itemFavorites.d.ts +236 -0
- package/dist/types/services/items/schemas/itemFavorites.d.ts.map +1 -0
- package/dist/types/services/items/schemas/locationsBins.d.ts +381 -0
- package/dist/types/services/items/schemas/locationsBins.d.ts.map +1 -0
- package/dist/types/services/legacy/client.d.ts +522 -280
- package/dist/types/services/legacy/client.d.ts.map +1 -1
- package/dist/types/services/nexus/client.d.ts +169 -156
- package/dist/types/services/nexus/client.d.ts.map +1 -1
- package/dist/types/services/open-search/client.d.ts +434 -162
- package/dist/types/services/open-search/client.d.ts.map +1 -1
- package/dist/types/services/{pricing/schemas/health.d.ts → open-search/schemas/healthCheck.d.ts} +19 -49
- package/dist/types/services/open-search/schemas/healthCheck.d.ts.map +1 -0
- package/dist/types/services/open-search/schemas/index.d.ts +5 -0
- package/dist/types/services/open-search/schemas/index.d.ts.map +1 -1
- package/dist/types/services/open-search/schemas/itemSearch.d.ts +394 -0
- package/dist/types/services/open-search/schemas/itemSearch.d.ts.map +1 -0
- package/dist/types/services/open-search/schemas/itemSearchAttributes.d.ts +359 -0
- package/dist/types/services/open-search/schemas/itemSearchAttributes.d.ts.map +1 -0
- package/dist/types/services/open-search/schemas/itemsRefresh.d.ts +512 -0
- package/dist/types/services/open-search/schemas/itemsRefresh.d.ts.map +1 -0
- package/dist/types/services/open-search/schemas/ping.d.ts +57 -0
- package/dist/types/services/open-search/schemas/ping.d.ts.map +1 -0
- package/dist/types/services/orders/client.d.ts +496 -646
- package/dist/types/services/orders/client.d.ts.map +1 -1
- package/dist/types/services/orders/schemas/invoices.d.ts +10 -10
- package/dist/types/services/p21-apis/client.d.ts +311 -534
- package/dist/types/services/p21-apis/client.d.ts.map +1 -1
- package/dist/types/services/p21-apis/schemas.d.ts +9 -78
- package/dist/types/services/p21-apis/schemas.d.ts.map +1 -1
- package/dist/types/services/p21-core/client.d.ts +111 -75
- package/dist/types/services/p21-core/client.d.ts.map +1 -1
- package/dist/types/services/p21-pim/client.d.ts +163 -37
- package/dist/types/services/p21-pim/client.d.ts.map +1 -1
- package/dist/types/services/p21-pim/schemas/ai-suggestions.d.ts +6 -6
- package/dist/types/services/p21-pim/schemas/ai-suggestions.d.ts.map +1 -1
- package/dist/types/services/p21-pim/schemas/inventory.d.ts +32 -32
- package/dist/types/services/p21-sism/client.d.ts +315 -261
- package/dist/types/services/p21-sism/client.d.ts.map +1 -1
- package/dist/types/services/pricing/client.d.ts +289 -59
- package/dist/types/services/pricing/client.d.ts.map +1 -1
- package/dist/types/services/pricing/schemas/healthCheck.d.ts +70 -0
- package/dist/types/services/pricing/schemas/healthCheck.d.ts.map +1 -0
- package/dist/types/services/pricing/schemas/index.d.ts +6 -4
- package/dist/types/services/pricing/schemas/index.d.ts.map +1 -1
- package/dist/types/services/pricing/schemas/jobPriceHdr.d.ts +391 -0
- package/dist/types/services/pricing/schemas/jobPriceHdr.d.ts.map +1 -0
- package/dist/{esm/services/pricing/schemas/job-pricing.d.ts → types/services/pricing/schemas/jobPriceHdrLines.d.ts} +1 -390
- package/dist/types/services/pricing/schemas/jobPriceHdrLines.d.ts.map +1 -0
- package/dist/types/services/pricing/schemas/ping.d.ts +49 -0
- package/dist/types/services/pricing/schemas/ping.d.ts.map +1 -0
- package/dist/{esm/services/pricing/schemas/pricing.d.ts → types/services/pricing/schemas/priceEngine.d.ts} +1 -1
- package/dist/types/services/pricing/schemas/priceEngine.d.ts.map +1 -0
- package/dist/{esm/services/pricing/schemas/tax.d.ts → types/services/pricing/schemas/taxEngine.d.ts} +1 -1
- package/dist/types/services/pricing/schemas/taxEngine.d.ts.map +1 -0
- package/dist/types/services/shipping/client.d.ts +47 -110
- package/dist/types/services/shipping/client.d.ts.map +1 -1
- package/dist/types/services/shipping/index.d.ts +2 -2
- package/dist/types/services/shipping/index.d.ts.map +1 -1
- package/dist/types/services/shipping/schemas/healthCheck.d.ts +118 -0
- package/dist/types/services/shipping/schemas/healthCheck.d.ts.map +1 -0
- package/dist/types/services/shipping/schemas/index.d.ts +5 -0
- package/dist/types/services/shipping/schemas/index.d.ts.map +1 -0
- package/dist/types/services/shipping/{schemas.d.ts → schemas/rates.d.ts} +1 -117
- package/dist/{esm/services/shipping/schemas.d.ts.map → types/services/shipping/schemas/rates.d.ts.map} +1 -1
- package/dist/types/services/slack/client.d.ts +289 -260
- package/dist/types/services/slack/client.d.ts.map +1 -1
- package/dist/types/services/slack/index.d.ts +2 -2
- package/dist/types/services/slack/index.d.ts.map +1 -1
- package/dist/types/services/slack/schemas/healthCheck.d.ts +138 -0
- package/dist/types/services/slack/schemas/healthCheck.d.ts.map +1 -0
- package/dist/types/services/slack/schemas/index.d.ts +4 -0
- package/dist/types/services/slack/schemas/index.d.ts.map +1 -0
- package/dist/{cjs/services/slack/schemas.d.ts → types/services/slack/schemas/webHook.d.ts} +3 -298
- package/dist/types/services/slack/schemas/webHook.d.ts.map +1 -0
- package/dist/types/services/slack/schemas/webHookRefresh.d.ts +161 -0
- package/dist/types/services/slack/schemas/webHookRefresh.d.ts.map +1 -0
- package/dist/types/services/smarty-streets/client.d.ts +238 -214
- package/dist/types/services/smarty-streets/client.d.ts.map +1 -1
- package/dist/types/services/smarty-streets/index.d.ts +2 -2
- package/dist/types/services/smarty-streets/index.d.ts.map +1 -1
- package/dist/types/services/smarty-streets/schemas/healthCheck.d.ts +140 -0
- package/dist/types/services/smarty-streets/schemas/healthCheck.d.ts.map +1 -0
- package/dist/types/services/smarty-streets/schemas/index.d.ts +7 -0
- package/dist/types/services/smarty-streets/schemas/index.d.ts.map +1 -0
- package/dist/types/services/smarty-streets/schemas/ping.d.ts +120 -0
- package/dist/types/services/smarty-streets/schemas/ping.d.ts.map +1 -0
- package/dist/types/services/smarty-streets/{schemas.d.ts → schemas/usLookup.d.ts} +11 -262
- package/dist/types/services/smarty-streets/schemas/usLookup.d.ts.map +1 -0
- package/dist/types/services/ups/client.d.ts +65 -95
- package/dist/types/services/ups/client.d.ts.map +1 -1
- package/dist/types/services/ups/schemas/healthCheck.d.ts +138 -0
- package/dist/types/services/ups/schemas/healthCheck.d.ts.map +1 -0
- package/dist/types/services/ups/schemas/index.d.ts +5 -0
- package/dist/types/services/ups/schemas/index.d.ts.map +1 -0
- package/dist/types/services/ups/schemas/ratesShop.d.ts +1751 -0
- package/dist/types/services/ups/schemas/ratesShop.d.ts.map +1 -0
- package/dist/types/services/ups/schemas.d.ts +4 -1886
- package/dist/types/services/ups/schemas.d.ts.map +1 -1
- package/dist/types/services/vmi/client.d.ts +605 -550
- package/dist/types/services/vmi/client.d.ts.map +1 -1
- package/package.json +3 -1
- package/dist/cjs/services/pricing/schemas/health.d.ts.map +0 -1
- package/dist/cjs/services/pricing/schemas/health.js.map +0 -1
- package/dist/cjs/services/pricing/schemas/job-pricing.d.ts.map +0 -1
- package/dist/cjs/services/pricing/schemas/job-pricing.js.map +0 -1
- package/dist/cjs/services/pricing/schemas/pricing.d.ts.map +0 -1
- package/dist/cjs/services/pricing/schemas/pricing.js.map +0 -1
- package/dist/cjs/services/pricing/schemas/tax.d.ts.map +0 -1
- package/dist/cjs/services/pricing/schemas/tax.js.map +0 -1
- package/dist/cjs/services/shipping/schemas.js.map +0 -1
- package/dist/cjs/services/slack/schemas.d.ts.map +0 -1
- package/dist/cjs/services/slack/schemas.js.map +0 -1
- package/dist/cjs/services/smarty-streets/schemas.d.ts.map +0 -1
- package/dist/cjs/services/smarty-streets/schemas.js.map +0 -1
- package/dist/esm/services/pricing/schemas/health.d.ts.map +0 -1
- package/dist/esm/services/pricing/schemas/health.js +0 -4
- package/dist/esm/services/pricing/schemas/health.js.map +0 -1
- package/dist/esm/services/pricing/schemas/job-pricing.d.ts.map +0 -1
- package/dist/esm/services/pricing/schemas/job-pricing.js.map +0 -1
- package/dist/esm/services/pricing/schemas/pricing.d.ts.map +0 -1
- package/dist/esm/services/pricing/schemas/pricing.js.map +0 -1
- package/dist/esm/services/pricing/schemas/tax.d.ts.map +0 -1
- package/dist/esm/services/pricing/schemas/tax.js.map +0 -1
- package/dist/esm/services/shipping/schemas.js.map +0 -1
- package/dist/esm/services/slack/schemas.d.ts.map +0 -1
- package/dist/esm/services/slack/schemas.js.map +0 -1
- package/dist/esm/services/smarty-streets/schemas.d.ts.map +0 -1
- package/dist/esm/services/smarty-streets/schemas.js.map +0 -1
- package/dist/types/services/pricing/schemas/health.d.ts.map +0 -1
- package/dist/types/services/pricing/schemas/job-pricing.d.ts.map +0 -1
- package/dist/types/services/pricing/schemas/pricing.d.ts.map +0 -1
- package/dist/types/services/pricing/schemas/tax.d.ts.map +0 -1
- package/dist/types/services/slack/schemas.d.ts.map +0 -1
- package/dist/types/services/smarty-streets/schemas.d.ts.map +0 -1
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { BaseServiceClient } from '../../core/base-client';
|
|
2
2
|
import type { HTTPClient } from '../../core/client';
|
|
3
|
-
import { PingResponse, ProductSearchParams, ProductListParams, ProductLookupParams, CategoryDetailsParams, CategoryItemsParams, CategoryListParams, CategoryLookupParams, AttributeGroupListParams, BrandListParams, GetStockParams,
|
|
3
|
+
import { AlternateCodeListParams, PingResponse, ProductSearchParams, ProductListParams, ProductLookupParams, CategoryDetailsParams, CategoryItemsParams, CategoryListParams, CategoryLookupParams, AttributeGroupListParams, BrandListParams, GetStockParams, CreateItemWishlistHeaderRequest, ItemVariantListParams, ItemFaqListParams, ItemFaqVoteRequest, BrandItemListParams, ProductLinkListParams, SubPartListParams, CreateItemVariantLineRequest, UpdateItemVariantLineRequest, CreateItemFaqRequest, UpdateItemFaqRequest, CreateBrandItemRequest, UpdateBrandItemRequest, CreateProductLinkRequest, UpdateProductLinkRequest, CreateSubPartRequest, UpdateSubPartRequest, CreateBinRequest, UpdateBinRequest, InvMastSubPartsParams, InvMastLinksResponse, InvMastSubPartsResponse, ItemFavoritesListResponse, ItemFavoritesItemResponse, LocationsBinsParams } from './schemas';
|
|
4
4
|
type CreateAttributeValueRequest = {
|
|
5
5
|
value: string;
|
|
6
6
|
displayValue?: string;
|
|
@@ -65,7 +65,7 @@ type CreateProductAttributeRequest = {
|
|
|
65
65
|
*
|
|
66
66
|
* // Get category with items
|
|
67
67
|
* const category = await items.categories.get(100);
|
|
68
|
-
* const categoryItems = await items.categories.
|
|
68
|
+
* const categoryItems = await items.categories.item.list(100);
|
|
69
69
|
* ```
|
|
70
70
|
*/
|
|
71
71
|
export declare class ItemsClient extends BaseServiceClient {
|
|
@@ -80,19 +80,22 @@ export declare class ItemsClient extends BaseServiceClient {
|
|
|
80
80
|
* @description Methods for product management including search, details, alternate codes, and accessories
|
|
81
81
|
*/
|
|
82
82
|
/**
|
|
83
|
-
* Category management endpoints
|
|
84
|
-
* @description Methods for
|
|
83
|
+
* Item Category management endpoints
|
|
84
|
+
* @description Methods for /item-category/* paths following OpenAPI Path Mirroring Pattern
|
|
85
85
|
*/
|
|
86
|
-
|
|
86
|
+
itemCategory: {
|
|
87
87
|
/**
|
|
88
|
-
* List all categories with filtering and pagination
|
|
89
|
-
* @description Retrieve a paginated list of categories with filtering options
|
|
88
|
+
* List all item categories with filtering and pagination
|
|
89
|
+
* @description Retrieve a paginated list of item categories with filtering options
|
|
90
|
+
* @fullPath api.items.itemCategory.list
|
|
91
|
+
* @service items
|
|
92
|
+
* @domain inventory-management
|
|
90
93
|
* @param params Optional filtering and pagination parameters
|
|
91
|
-
* @returns Array of category entities
|
|
94
|
+
* @returns Array of item category entities
|
|
92
95
|
* @throws ValidationError When parameters are invalid or response is malformed
|
|
93
96
|
* @example
|
|
94
97
|
* ```typescript
|
|
95
|
-
* const categories = await client.
|
|
98
|
+
* const categories = await client.itemCategory.list({
|
|
96
99
|
* displayOnWebFlag: 'Y',
|
|
97
100
|
* limit: 50
|
|
98
101
|
* });
|
|
@@ -128,38 +131,42 @@ export declare class ItemsClient extends BaseServiceClient {
|
|
|
128
131
|
totalResults: number;
|
|
129
132
|
}>;
|
|
130
133
|
/**
|
|
131
|
-
*
|
|
132
|
-
* @description Retrieve
|
|
133
|
-
* @
|
|
134
|
-
* @
|
|
135
|
-
* @
|
|
134
|
+
* Get item category details by ID
|
|
135
|
+
* @description Retrieve comprehensive item category information
|
|
136
|
+
* @fullPath api.items.itemCategory.get
|
|
137
|
+
* @service items
|
|
138
|
+
* @domain inventory-management
|
|
139
|
+
* @param itemCategoryUid Item category unique identifier
|
|
140
|
+
* @returns Complete item category details
|
|
141
|
+
* @throws ValidationError When response is malformed
|
|
136
142
|
* @example
|
|
137
143
|
* ```typescript
|
|
138
|
-
* const
|
|
139
|
-
*
|
|
140
|
-
* includeSubCategories: true
|
|
141
|
-
* });
|
|
144
|
+
* const category = await client.itemCategory.get(100);
|
|
145
|
+
* console.log(category.data.itemCategoryDesc);
|
|
142
146
|
* ```
|
|
143
147
|
*/
|
|
144
|
-
|
|
148
|
+
get: (itemCategoryUid: number) => Promise<{
|
|
145
149
|
params: Record<string, unknown> | unknown[];
|
|
146
150
|
data: {
|
|
147
|
-
fullPath: string | null;
|
|
148
|
-
displayOnWebFlag: "Y" | "N";
|
|
149
|
-
deleteFlag: "Y" | "N";
|
|
150
151
|
itemCategoryUid: number;
|
|
151
|
-
itemCategoryId: string;
|
|
152
152
|
itemCategoryDesc: string;
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
deleteFlag: "Y" | "N";
|
|
153
|
+
path?: string;
|
|
154
|
+
parentItemCategoryUid?: number;
|
|
155
|
+
level?: number;
|
|
156
|
+
children?: Array<{
|
|
158
157
|
itemCategoryUid: number;
|
|
159
|
-
itemCategoryId: string;
|
|
160
158
|
itemCategoryDesc: string;
|
|
161
|
-
|
|
162
|
-
|
|
159
|
+
path?: string;
|
|
160
|
+
parentItemCategoryUid?: number;
|
|
161
|
+
level?: number;
|
|
162
|
+
children?: unknown;
|
|
163
|
+
attributes?: unknown[];
|
|
164
|
+
images?: unknown[];
|
|
165
|
+
itemCount?: number;
|
|
166
|
+
}>;
|
|
167
|
+
attributes?: unknown[];
|
|
168
|
+
images?: unknown[];
|
|
169
|
+
itemCount?: number;
|
|
163
170
|
};
|
|
164
171
|
options: Record<string, unknown> | unknown[];
|
|
165
172
|
status: number;
|
|
@@ -169,67 +176,121 @@ export declare class ItemsClient extends BaseServiceClient {
|
|
|
169
176
|
totalResults: number;
|
|
170
177
|
}>;
|
|
171
178
|
/**
|
|
172
|
-
*
|
|
173
|
-
* @description
|
|
174
|
-
* @param itemCategoryUid Category unique identifier
|
|
175
|
-
* @returns Boolean indicating if pre-cache was queued successfully
|
|
176
|
-
* @throws ValidationError When response is malformed
|
|
177
|
-
* @example
|
|
178
|
-
* ```typescript
|
|
179
|
-
* const cached = await client.categories.preCache(100);
|
|
180
|
-
* if (cached.data) {
|
|
181
|
-
* console.log('Category pre-cache queued successfully');
|
|
182
|
-
* }
|
|
183
|
-
* ```
|
|
179
|
+
* Item category lookup - Direct path mapping to /item-category/lookup
|
|
180
|
+
* @description OpenAPI Path Mirroring: /item-category/lookup → itemCategory.lookup.get()
|
|
184
181
|
*/
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
182
|
+
lookup: {
|
|
183
|
+
/**
|
|
184
|
+
* Lookup item category with hierarchical structure
|
|
185
|
+
* @description Retrieve item category with subcategories in hierarchical structure
|
|
186
|
+
* @fullPath api.items.itemCategory.lookup.get
|
|
187
|
+
* @service items
|
|
188
|
+
* @domain inventory-management
|
|
189
|
+
* @param params Lookup parameters
|
|
190
|
+
* @returns Item category with hierarchical structure
|
|
191
|
+
* @throws ValidationError When parameters are invalid or response is malformed
|
|
192
|
+
* @example
|
|
193
|
+
* ```typescript
|
|
194
|
+
* const categoryLookup = await client.itemCategory.lookup.get();
|
|
195
|
+
* ```
|
|
196
|
+
*/
|
|
197
|
+
get: (params?: CategoryLookupParams) => Promise<{
|
|
198
|
+
params: Record<string, unknown> | unknown[];
|
|
199
|
+
data: {
|
|
200
|
+
fullPath: string | null;
|
|
201
|
+
displayOnWebFlag: "Y" | "N";
|
|
202
|
+
deleteFlag: "Y" | "N";
|
|
203
|
+
itemCategoryUid: number;
|
|
204
|
+
itemCategoryId: string;
|
|
205
|
+
itemCategoryDesc: string;
|
|
206
|
+
itemCount: number;
|
|
207
|
+
subCategories: {
|
|
208
|
+
fullPath: string | null;
|
|
209
|
+
displayOnWebFlag: "Y" | "N";
|
|
210
|
+
deleteFlag: "Y" | "N";
|
|
211
|
+
itemCategoryUid: number;
|
|
212
|
+
itemCategoryId: string;
|
|
213
|
+
itemCategoryDesc: string;
|
|
214
|
+
itemCount: number;
|
|
215
|
+
}[];
|
|
216
|
+
};
|
|
217
|
+
options: Record<string, unknown> | unknown[];
|
|
218
|
+
status: number;
|
|
219
|
+
message: string;
|
|
220
|
+
count: number;
|
|
221
|
+
total: number;
|
|
222
|
+
totalResults: number;
|
|
223
|
+
}>;
|
|
224
|
+
};
|
|
225
|
+
/**
|
|
226
|
+
* Item category documentation - Direct path mapping to /item-category/{itemCategoryUid}/doc
|
|
227
|
+
* @description OpenAPI Path Mirroring: /item-category/{itemCategoryUid}/doc → itemCategory.doc.get()
|
|
228
|
+
*/
|
|
229
|
+
doc: {
|
|
230
|
+
/**
|
|
231
|
+
* Get item category documentation
|
|
232
|
+
* @description Retrieve documentation for a specific item category
|
|
233
|
+
* @fullPath api.items.itemCategory.doc.get
|
|
234
|
+
* @service items
|
|
235
|
+
* @domain inventory-management
|
|
236
|
+
* @param itemCategoryUid Item category unique identifier
|
|
237
|
+
* @returns Item category documentation
|
|
238
|
+
* @throws ValidationError When response is malformed
|
|
239
|
+
* @example
|
|
240
|
+
* ```typescript
|
|
241
|
+
* const docs = await client.itemCategory.doc.get(100);
|
|
242
|
+
* ```
|
|
243
|
+
*/
|
|
244
|
+
get: (itemCategoryUid: number) => Promise<{
|
|
245
|
+
params: Record<string, unknown> | unknown[];
|
|
246
|
+
data: {
|
|
247
|
+
itemCategoryUid: number;
|
|
248
|
+
itemCategoryDesc: string;
|
|
249
|
+
path?: string;
|
|
250
|
+
parentItemCategoryUid?: number;
|
|
251
|
+
level?: number;
|
|
252
|
+
children?: Array<{
|
|
253
|
+
itemCategoryUid: number;
|
|
254
|
+
itemCategoryDesc: string;
|
|
255
|
+
path?: string;
|
|
256
|
+
parentItemCategoryUid?: number;
|
|
257
|
+
level?: number;
|
|
258
|
+
children?: unknown;
|
|
259
|
+
attributes?: unknown[];
|
|
260
|
+
images?: unknown[];
|
|
261
|
+
itemCount?: number;
|
|
262
|
+
}>;
|
|
263
|
+
attributes?: unknown[];
|
|
264
|
+
images?: unknown[];
|
|
265
|
+
itemCount?: number;
|
|
266
|
+
};
|
|
267
|
+
options: Record<string, unknown> | unknown[];
|
|
268
|
+
status: number;
|
|
269
|
+
message: string;
|
|
270
|
+
count: number;
|
|
271
|
+
total: number;
|
|
272
|
+
totalResults: number;
|
|
273
|
+
}>;
|
|
274
|
+
};
|
|
275
|
+
};
|
|
276
|
+
/**
|
|
277
|
+
* Category management endpoints
|
|
278
|
+
* @description Methods for /categories/* paths following OpenAPI Path Mirroring Pattern
|
|
279
|
+
*/
|
|
280
|
+
categories: {
|
|
195
281
|
/**
|
|
196
|
-
* Get category details by ID
|
|
197
|
-
* @description Retrieve comprehensive category information
|
|
282
|
+
* Get category details by ID
|
|
283
|
+
* @description Retrieve comprehensive category information
|
|
198
284
|
* @fullPath api.items.categories.get
|
|
199
285
|
* @service items
|
|
200
286
|
* @domain inventory-management
|
|
201
|
-
* @
|
|
202
|
-
* @
|
|
203
|
-
* @
|
|
204
|
-
* @relatedEndpoints ["api.items.categories.getItems", "api.items.categories.list", "api.items.categories.getAttributes", "api.opensearch.categories"]
|
|
205
|
-
* @commonPatterns ["Category navigation", "Get category info", "Category detail page", "Hierarchical browsing"]
|
|
206
|
-
* @workflow ["category-navigation", "product-browsing", "taxonomy-management"]
|
|
207
|
-
* @prerequisites ["Valid category UID or path", "Category access permissions"]
|
|
208
|
-
* @nextSteps ["api.items.categories.getItems", "api.items.categories.getAttributes", "api.items.categories.getFilters"]
|
|
209
|
-
* @businessRules ["Returns category hierarchy", "Includes subcategories if requested", "Respects category visibility settings"]
|
|
210
|
-
* @functionalArea "category-and-taxonomy-management"
|
|
211
|
-
* @caching "Cache for 30 minutes, invalidate on category structure changes"
|
|
212
|
-
* @performance "Optimized for category navigation, supports path-based lookups"
|
|
213
|
-
* @param itemCategoryUid Category unique identifier (use 0 for path-based lookup)
|
|
214
|
-
* @param params Optional parameters for path lookup, filtering, and children pagination
|
|
215
|
-
* @returns Complete category details with children and attributes
|
|
216
|
-
* @throws ValidationError When parameters are invalid or response is malformed
|
|
287
|
+
* @param itemCategoryUid Category unique identifier
|
|
288
|
+
* @returns Complete category details
|
|
289
|
+
* @throws ValidationError When response is malformed
|
|
217
290
|
* @example
|
|
218
291
|
* ```typescript
|
|
219
|
-
* // Get category by ID
|
|
220
292
|
* const category = await client.categories.get(100);
|
|
221
|
-
* console.log(category.data.itemCategoryDesc
|
|
222
|
-
*
|
|
223
|
-
* // Get category by path
|
|
224
|
-
* const categoryByPath = await client.categories.get(0, {
|
|
225
|
-
* path: '/Electronics/Cables'
|
|
226
|
-
* });
|
|
227
|
-
*
|
|
228
|
-
* // Get category with filtered children
|
|
229
|
-
* const categoryWithChildren = await client.categories.get(100, {
|
|
230
|
-
* childrenLimit: 10,
|
|
231
|
-
* childrenFilter: 'audio'
|
|
232
|
-
* });
|
|
293
|
+
* console.log(category.data.itemCategoryDesc);
|
|
233
294
|
* ```
|
|
234
295
|
*/
|
|
235
296
|
get: (itemCategoryUid: number, params?: CategoryDetailsParams) => Promise<{
|
|
@@ -263,172 +324,184 @@ export declare class ItemsClient extends BaseServiceClient {
|
|
|
263
324
|
totalResults: number;
|
|
264
325
|
}>;
|
|
265
326
|
/**
|
|
266
|
-
*
|
|
267
|
-
* @description
|
|
268
|
-
* @param itemCategoryUid Category unique identifier
|
|
269
|
-
* @param params Optional filtering, sorting, and pagination parameters
|
|
270
|
-
* @returns Array of category items with optional stock information
|
|
271
|
-
* @throws ValidationError When parameters are invalid or response is malformed
|
|
272
|
-
* @example
|
|
273
|
-
* ```typescript
|
|
274
|
-
* // Get category items with basic pagination
|
|
275
|
-
* const items = await client.categories.getItems(100, { limit: 12 });
|
|
276
|
-
*
|
|
277
|
-
* // Get items with filtering and stock information
|
|
278
|
-
* const filteredItems = await client.categories.getItems(100, {
|
|
279
|
-
* limit: 20,
|
|
280
|
-
* sortBy: 'listPrice|ASC',
|
|
281
|
-
* includeStock: 'Y',
|
|
282
|
-
* displayOnWebFlag: 'Y',
|
|
283
|
-
* filters: JSON.stringify([
|
|
284
|
-
* { attributeId: 'color', values: ['red', 'blue'], operator: 'IN' }
|
|
285
|
-
* ])
|
|
286
|
-
* });
|
|
287
|
-
*
|
|
288
|
-
* // Search within category
|
|
289
|
-
* const searchResults = await client.categories.getItems(100, {
|
|
290
|
-
* q: 'wireless',
|
|
291
|
-
* limit: 10
|
|
292
|
-
* });
|
|
293
|
-
* ```
|
|
327
|
+
* Category lookup - Direct path mapping to /categories/lookup
|
|
328
|
+
* @description OpenAPI Path Mirroring: /categories/lookup → categories.lookup.get()
|
|
294
329
|
*/
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
330
|
+
lookup: {
|
|
331
|
+
/**
|
|
332
|
+
* Lookup category with hierarchical structure
|
|
333
|
+
* @description Retrieve category with subcategories in hierarchical structure
|
|
334
|
+
* @fullPath api.items.categories.lookup.get
|
|
335
|
+
* @service items
|
|
336
|
+
* @domain inventory-management
|
|
337
|
+
* @param params Lookup parameters
|
|
338
|
+
* @returns Category with subcategories
|
|
339
|
+
* @throws ValidationError When parameters are invalid or response is malformed
|
|
340
|
+
* @example
|
|
341
|
+
* ```typescript
|
|
342
|
+
* const categoryLookup = await client.categories.lookup.get();
|
|
343
|
+
* ```
|
|
344
|
+
*/
|
|
345
|
+
get: (params?: CategoryLookupParams) => Promise<{
|
|
346
|
+
params: Record<string, unknown> | unknown[];
|
|
347
|
+
data: {
|
|
348
|
+
fullPath: string | null;
|
|
349
|
+
displayOnWebFlag: "Y" | "N";
|
|
350
|
+
deleteFlag: "Y" | "N";
|
|
351
|
+
itemCategoryUid: number;
|
|
352
|
+
itemCategoryId: string;
|
|
353
|
+
itemCategoryDesc: string;
|
|
354
|
+
itemCount: number;
|
|
355
|
+
subCategories: {
|
|
356
|
+
fullPath: string | null;
|
|
357
|
+
displayOnWebFlag: "Y" | "N";
|
|
358
|
+
deleteFlag: "Y" | "N";
|
|
359
|
+
itemCategoryUid: number;
|
|
360
|
+
itemCategoryId: string;
|
|
361
|
+
itemCategoryDesc: string;
|
|
362
|
+
itemCount: number;
|
|
363
|
+
}[];
|
|
364
|
+
};
|
|
365
|
+
options: Record<string, unknown> | unknown[];
|
|
366
|
+
status: number;
|
|
367
|
+
message: string;
|
|
368
|
+
count: number;
|
|
369
|
+
total: number;
|
|
370
|
+
totalResults: number;
|
|
371
|
+
}>;
|
|
372
|
+
};
|
|
317
373
|
/**
|
|
318
|
-
*
|
|
319
|
-
* @description
|
|
320
|
-
* @param itemCategoryUid Category unique identifier
|
|
321
|
-
* @returns Array of category attributes with their available values
|
|
322
|
-
* @throws ValidationError When response is malformed
|
|
323
|
-
* @example
|
|
324
|
-
* ```typescript
|
|
325
|
-
* const attributes = await client.categories.getAttributes(100);
|
|
326
|
-
* attributes.data.forEach(attr => {
|
|
327
|
-
* console.log(`${attr.attributeDesc}: ${attr.values?.join(', ')}`);
|
|
328
|
-
* });
|
|
329
|
-
* ```
|
|
374
|
+
* Category items - Direct path mapping to /categories/{itemCategoryUid}/item
|
|
375
|
+
* @description OpenAPI Path Mirroring: /categories/{itemCategoryUid}/item → categories.item.list()
|
|
330
376
|
*/
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
377
|
+
item: {
|
|
378
|
+
/**
|
|
379
|
+
* List items within a category
|
|
380
|
+
* @description Retrieve items within a specific category
|
|
381
|
+
* @fullPath api.items.categories.item.list
|
|
382
|
+
* @service items
|
|
383
|
+
* @domain inventory-management
|
|
384
|
+
* @param itemCategoryUid Category unique identifier
|
|
385
|
+
* @returns Array of category items
|
|
386
|
+
* @throws ValidationError When response is malformed
|
|
387
|
+
* @example
|
|
388
|
+
* ```typescript
|
|
389
|
+
* const items = await client.categories.item.list(100);
|
|
390
|
+
* ```
|
|
391
|
+
*/
|
|
392
|
+
list: (itemCategoryUid: number) => Promise<{
|
|
393
|
+
params: Record<string, unknown> | unknown[];
|
|
394
|
+
data: {
|
|
395
|
+
invMastUid: number;
|
|
396
|
+
itemId: string;
|
|
397
|
+
itemDesc: string;
|
|
398
|
+
attributes?: unknown[] | undefined;
|
|
399
|
+
images?: unknown[] | undefined;
|
|
400
|
+
listPrice?: number | undefined;
|
|
401
|
+
stdPrice?: number | undefined;
|
|
402
|
+
stock?: {
|
|
403
|
+
qtyOnHand: number;
|
|
404
|
+
qtyAvailable: number;
|
|
405
|
+
} | undefined;
|
|
406
|
+
}[];
|
|
407
|
+
options: Record<string, unknown> | unknown[];
|
|
408
|
+
status: number;
|
|
409
|
+
message: string;
|
|
410
|
+
count: number;
|
|
411
|
+
total: number;
|
|
412
|
+
totalResults: number;
|
|
413
|
+
}>;
|
|
414
|
+
};
|
|
347
415
|
/**
|
|
348
|
-
*
|
|
349
|
-
* @description
|
|
350
|
-
* @param itemCategoryUid Category unique identifier
|
|
351
|
-
* @returns Array of filter options with values and counts
|
|
352
|
-
* @throws ValidationError When response is malformed
|
|
353
|
-
* @example
|
|
354
|
-
* ```typescript
|
|
355
|
-
* const filters = await client.categories.getFilters(100);
|
|
356
|
-
* filters.data.forEach(filter => {
|
|
357
|
-
* console.log(`${filter.attributeDesc}:`);
|
|
358
|
-
* filter.values.forEach(value => {
|
|
359
|
-
* console.log(` ${value.value} (${value.count})`);
|
|
360
|
-
* });
|
|
361
|
-
* });
|
|
362
|
-
* ```
|
|
416
|
+
* Category attributes - Direct path mapping to /categories/{itemCategoryUid}/attributes
|
|
417
|
+
* @description OpenAPI Path Mirroring: /categories/{itemCategoryUid}/attributes → categories.attributes.list()
|
|
363
418
|
*/
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
419
|
+
attributes: {
|
|
420
|
+
/**
|
|
421
|
+
* List attributes available for a category
|
|
422
|
+
* @description Retrieve attributes available for filtering within a category
|
|
423
|
+
* @fullPath api.items.categories.attributes.list
|
|
424
|
+
* @service items
|
|
425
|
+
* @domain inventory-management
|
|
426
|
+
* @param itemCategoryUid Category unique identifier
|
|
427
|
+
* @returns Array of category attributes with their available values
|
|
428
|
+
* @throws ValidationError When response is malformed
|
|
429
|
+
* @example
|
|
430
|
+
* ```typescript
|
|
431
|
+
* const attributes = await client.categories.attributes.list(100);
|
|
432
|
+
* attributes.data.forEach(attr => {
|
|
433
|
+
* console.log(`${attr.attributeDesc}: ${attr.values?.join(', ')}`);
|
|
434
|
+
* });
|
|
435
|
+
* ```
|
|
436
|
+
*/
|
|
437
|
+
list: (itemCategoryUid: number) => Promise<{
|
|
438
|
+
params: Record<string, unknown> | unknown[];
|
|
439
|
+
data: {
|
|
440
|
+
attributeUid: number;
|
|
441
|
+
attributeId: string;
|
|
442
|
+
attributeDesc: string;
|
|
443
|
+
dataType: string;
|
|
444
|
+
values?: string[] | undefined;
|
|
370
445
|
}[];
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
total: number;
|
|
380
|
-
totalResults: number;
|
|
381
|
-
}>;
|
|
446
|
+
options: Record<string, unknown> | unknown[];
|
|
447
|
+
status: number;
|
|
448
|
+
message: string;
|
|
449
|
+
count: number;
|
|
450
|
+
total: number;
|
|
451
|
+
totalResults: number;
|
|
452
|
+
}>;
|
|
453
|
+
};
|
|
382
454
|
/**
|
|
383
|
-
*
|
|
384
|
-
* @description
|
|
385
|
-
* @param itemCategoryUid Category unique identifier
|
|
386
|
-
* @returns Array of category images
|
|
387
|
-
* @throws ValidationError When response is malformed
|
|
388
|
-
* @example
|
|
389
|
-
* ```typescript
|
|
390
|
-
* const images = await client.categories.getImages(100);
|
|
391
|
-
* images.data.forEach(image => {
|
|
392
|
-
* console.log(`Image: ${image.imagePath} (${image.imageType})`);
|
|
393
|
-
* });
|
|
394
|
-
* ```
|
|
455
|
+
* Category images - Direct path mapping to /categories/{itemCategoryUid}/images
|
|
456
|
+
* @description OpenAPI Path Mirroring: /categories/{itemCategoryUid}/images → categories.images.list()
|
|
395
457
|
*/
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
458
|
+
images: {
|
|
459
|
+
/**
|
|
460
|
+
* List images for a category
|
|
461
|
+
* @description Retrieve images associated with a category
|
|
462
|
+
* @fullPath api.items.categories.images.list
|
|
463
|
+
* @service items
|
|
464
|
+
* @domain inventory-management
|
|
465
|
+
* @param itemCategoryUid Category unique identifier
|
|
466
|
+
* @returns Array of category images
|
|
467
|
+
* @throws ValidationError When response is malformed
|
|
468
|
+
* @example
|
|
469
|
+
* ```typescript
|
|
470
|
+
* const images = await client.categories.images.list(100);
|
|
471
|
+
* images.data.forEach(image => {
|
|
472
|
+
* console.log(`Image: ${image.imagePath} (${image.imageType})`);
|
|
473
|
+
* });
|
|
474
|
+
* ```
|
|
475
|
+
*/
|
|
476
|
+
list: (itemCategoryUid: number) => Promise<{
|
|
477
|
+
params: Record<string, unknown> | unknown[];
|
|
478
|
+
data: {
|
|
479
|
+
imageUid: number;
|
|
480
|
+
imagePath: string;
|
|
481
|
+
imageType: string;
|
|
482
|
+
altText?: string | undefined;
|
|
483
|
+
}[];
|
|
484
|
+
options: Record<string, unknown> | unknown[];
|
|
485
|
+
status: number;
|
|
486
|
+
message: string;
|
|
487
|
+
count: number;
|
|
488
|
+
total: number;
|
|
489
|
+
totalResults: number;
|
|
490
|
+
}>;
|
|
491
|
+
};
|
|
411
492
|
};
|
|
412
493
|
/**
|
|
413
|
-
* Category data-only endpoints
|
|
414
|
-
* @description Data-only methods that return just the data portion of category responses
|
|
494
|
+
* Item Category data-only endpoints
|
|
495
|
+
* @description Data-only methods that return just the data portion of item category responses
|
|
415
496
|
*/
|
|
416
|
-
|
|
497
|
+
itemCategoryData: {
|
|
417
498
|
/**
|
|
418
|
-
* Get category details data only
|
|
419
|
-
* @description Returns only the data portion of category details response
|
|
420
|
-
* @
|
|
421
|
-
* @
|
|
422
|
-
* @domain inventory-management
|
|
423
|
-
* @discoverable true
|
|
424
|
-
* @searchTerms ["category data", "category details data only"]
|
|
425
|
-
* @relatedEndpoints ["api.items.categories.get"]
|
|
426
|
-
* @commonPatterns ["Get category data without metadata"]
|
|
427
|
-
* @param itemCategoryUid Category unique identifier
|
|
428
|
-
* @param params Optional parameters
|
|
429
|
-
* @returns Category data only
|
|
499
|
+
* Get item category details data only
|
|
500
|
+
* @description Returns only the data portion of item category details response
|
|
501
|
+
* @param itemCategoryUid Item category unique identifier
|
|
502
|
+
* @returns Item category data only
|
|
430
503
|
*/
|
|
431
|
-
get: (itemCategoryUid: number
|
|
504
|
+
get: (itemCategoryUid: number) => Promise<{
|
|
432
505
|
itemCategoryUid: number;
|
|
433
506
|
itemCategoryDesc: string;
|
|
434
507
|
path?: string;
|
|
@@ -450,17 +523,10 @@ export declare class ItemsClient extends BaseServiceClient {
|
|
|
450
523
|
itemCount?: number;
|
|
451
524
|
}>;
|
|
452
525
|
/**
|
|
453
|
-
* List categories data only
|
|
454
|
-
* @description Returns only the data portion of category list response
|
|
455
|
-
* @fullPath api.items.categoriesData.list
|
|
456
|
-
* @service items
|
|
457
|
-
* @domain inventory-management
|
|
458
|
-
* @discoverable true
|
|
459
|
-
* @searchTerms ["category list data", "categories data only"]
|
|
460
|
-
* @relatedEndpoints ["api.items.categories.list"]
|
|
461
|
-
* @commonPatterns ["List categories without metadata"]
|
|
526
|
+
* List item categories data only
|
|
527
|
+
* @description Returns only the data portion of item category list response
|
|
462
528
|
* @param params Optional filtering parameters
|
|
463
|
-
* @returns
|
|
529
|
+
* @returns Item category list data only
|
|
464
530
|
*/
|
|
465
531
|
list: (params?: CategoryListParams) => Promise<{
|
|
466
532
|
dateCreated: string;
|
|
@@ -482,33 +548,40 @@ export declare class ItemsClient extends BaseServiceClient {
|
|
|
482
548
|
catalogPage?: string | null | undefined;
|
|
483
549
|
subCategoryImageFile?: string | null | undefined;
|
|
484
550
|
}[]>;
|
|
551
|
+
};
|
|
552
|
+
/**
|
|
553
|
+
* Category data-only endpoints
|
|
554
|
+
* @description Data-only methods that return just the data portion of category responses
|
|
555
|
+
*/
|
|
556
|
+
categoriesData: {
|
|
485
557
|
/**
|
|
486
|
-
* Get category
|
|
487
|
-
* @description Returns only the data portion of category
|
|
488
|
-
* @fullPath api.items.categoriesData.getItems
|
|
489
|
-
* @service items
|
|
490
|
-
* @domain inventory-management
|
|
491
|
-
* @discoverable true
|
|
492
|
-
* @searchTerms ["category items data", "items in category data only"]
|
|
493
|
-
* @relatedEndpoints ["api.items.categories.getItems"]
|
|
494
|
-
* @commonPatterns ["Get category items without metadata"]
|
|
558
|
+
* Get category details data only
|
|
559
|
+
* @description Returns only the data portion of category details response
|
|
495
560
|
* @param itemCategoryUid Category unique identifier
|
|
496
|
-
* @param params Optional
|
|
497
|
-
* @returns Category
|
|
561
|
+
* @param params Optional parameters
|
|
562
|
+
* @returns Category data only
|
|
498
563
|
*/
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
564
|
+
get: (itemCategoryUid: number, params?: CategoryDetailsParams) => Promise<{
|
|
565
|
+
itemCategoryUid: number;
|
|
566
|
+
itemCategoryDesc: string;
|
|
567
|
+
path?: string;
|
|
568
|
+
parentItemCategoryUid?: number;
|
|
569
|
+
level?: number;
|
|
570
|
+
children?: Array<{
|
|
571
|
+
itemCategoryUid: number;
|
|
572
|
+
itemCategoryDesc: string;
|
|
573
|
+
path?: string;
|
|
574
|
+
parentItemCategoryUid?: number;
|
|
575
|
+
level?: number;
|
|
576
|
+
children?: unknown;
|
|
577
|
+
attributes?: unknown[];
|
|
578
|
+
images?: unknown[];
|
|
579
|
+
itemCount?: number;
|
|
580
|
+
}>;
|
|
581
|
+
attributes?: unknown[];
|
|
582
|
+
images?: unknown[];
|
|
583
|
+
itemCount?: number;
|
|
584
|
+
}>;
|
|
512
585
|
};
|
|
513
586
|
/**
|
|
514
587
|
* Attribute management endpoints
|
|
@@ -638,10 +711,10 @@ export declare class ItemsClient extends BaseServiceClient {
|
|
|
638
711
|
*/
|
|
639
712
|
update: (id: string | number, data: {
|
|
640
713
|
sequenceNo?: number | undefined;
|
|
641
|
-
maxLength?: number | undefined;
|
|
642
714
|
attributeId?: string | undefined;
|
|
643
715
|
attributeDesc?: string | undefined;
|
|
644
716
|
dataType?: string | undefined;
|
|
717
|
+
maxLength?: number | undefined;
|
|
645
718
|
}) => Promise<{
|
|
646
719
|
params: Record<string, unknown> | unknown[];
|
|
647
720
|
data: {
|
|
@@ -675,68 +748,227 @@ export declare class ItemsClient extends BaseServiceClient {
|
|
|
675
748
|
* ```
|
|
676
749
|
*/
|
|
677
750
|
delete: (attributeUid: number) => Promise<boolean>;
|
|
678
|
-
};
|
|
679
|
-
/**
|
|
680
|
-
* Stock and location management endpoints
|
|
681
|
-
* @description Methods for inventory stock information across locations
|
|
682
|
-
*/
|
|
683
|
-
stock: {
|
|
684
751
|
/**
|
|
685
|
-
*
|
|
686
|
-
* @description
|
|
687
|
-
* @param invMastUid Inventory master unique identifier
|
|
688
|
-
* @param params Optional parameters for filtering and including additional data
|
|
689
|
-
* @returns Stock details with location breakdown and company summary
|
|
690
|
-
* @throws ValidationError When response is malformed
|
|
691
|
-
* @example
|
|
692
|
-
* ```typescript
|
|
693
|
-
* const stockInfo = await client.stock.getDetails(12345);
|
|
694
|
-
* console.log('Company Summary:', stockInfo.data.companySummary);
|
|
695
|
-
*
|
|
696
|
-
* stockInfo.data.stockData.forEach(location => {
|
|
697
|
-
* console.log(`Location ${location.locationName}: ${location.qtyOnHand} on hand, ${location.qtyAvailable} available`);
|
|
698
|
-
* console.log(` Calculated: ${location.calcQtyOnHand} (${location.defaultSellingUnit})`);
|
|
699
|
-
* });
|
|
700
|
-
* ```
|
|
752
|
+
* Attribute values - Direct path mapping to /attributes/{attributeUid}/values
|
|
753
|
+
* @description OpenAPI Path Mirroring: /attributes/{attributeUid}/values → attributes.values.*
|
|
701
754
|
*/
|
|
702
|
-
|
|
703
|
-
|
|
704
|
-
|
|
705
|
-
|
|
706
|
-
|
|
707
|
-
|
|
708
|
-
|
|
709
|
-
|
|
710
|
-
|
|
711
|
-
|
|
712
|
-
|
|
713
|
-
|
|
714
|
-
|
|
715
|
-
|
|
716
|
-
|
|
717
|
-
|
|
718
|
-
|
|
719
|
-
|
|
720
|
-
|
|
721
|
-
|
|
722
|
-
|
|
723
|
-
|
|
724
|
-
|
|
725
|
-
|
|
726
|
-
|
|
727
|
-
|
|
728
|
-
|
|
729
|
-
|
|
730
|
-
|
|
755
|
+
values: {
|
|
756
|
+
/**
|
|
757
|
+
* List attribute values for a specific attribute
|
|
758
|
+
* @description Retrieve all values for an attribute
|
|
759
|
+
* @fullPath api.items.attributes.values.list
|
|
760
|
+
* @service items
|
|
761
|
+
* @domain attribute-management
|
|
762
|
+
* @dataMethod attributesValuesData.list
|
|
763
|
+
* @discoverable true
|
|
764
|
+
* @searchTerms ["attribute values", "attribute options", "value list", "attribute choices"]
|
|
765
|
+
* @relatedEndpoints ["api.items.attributes.list", "api.items.attributeGroups.attributes.list"]
|
|
766
|
+
* @commonPatterns ["List available values for an attribute", "Manage attribute options"]
|
|
767
|
+
* @workflow ["attribute-management", "value-management"]
|
|
768
|
+
* @prerequisites ["Valid authentication token", "Attribute management permissions", "Attribute must exist"]
|
|
769
|
+
* @nextSteps ["Create new values", "Edit value details", "Associate with products"]
|
|
770
|
+
* @businessRules ["Values define available options for attributes", "Can be used across multiple products"]
|
|
771
|
+
* @functionalArea "attribute-and-value-management"
|
|
772
|
+
* @caching "Standard pagination caching"
|
|
773
|
+
* @performance "Use pagination for attributes with many values"
|
|
774
|
+
* @param attributeUid Attribute unique identifier
|
|
775
|
+
* @param params Optional pagination parameters
|
|
776
|
+
* @returns Array of attribute values
|
|
777
|
+
* @throws ValidationError When parameters are invalid or response is malformed
|
|
778
|
+
* @example
|
|
779
|
+
* ```typescript
|
|
780
|
+
* const values = await client.attributes.values.list(123);
|
|
781
|
+
* values.data.forEach(value => {
|
|
782
|
+
* console.log(`${value.attributeValueId}: ${value.value}`);
|
|
783
|
+
* });
|
|
784
|
+
* ```
|
|
785
|
+
*/
|
|
786
|
+
list: (attributeUid: number, params?: {
|
|
787
|
+
limit?: number;
|
|
788
|
+
offset?: number;
|
|
789
|
+
}) => Promise<{
|
|
790
|
+
params: Record<string, unknown> | unknown[];
|
|
791
|
+
data: {
|
|
792
|
+
attributeValueUid: number;
|
|
793
|
+
attributeValue: string;
|
|
794
|
+
attributeUid: number;
|
|
795
|
+
sequenceNo?: number | undefined;
|
|
796
|
+
displayValue?: string | undefined;
|
|
731
797
|
}[];
|
|
732
|
-
|
|
733
|
-
|
|
734
|
-
|
|
735
|
-
|
|
736
|
-
|
|
737
|
-
|
|
738
|
-
|
|
739
|
-
|
|
798
|
+
options: Record<string, unknown> | unknown[];
|
|
799
|
+
status: number;
|
|
800
|
+
message: string;
|
|
801
|
+
count: number;
|
|
802
|
+
total: number;
|
|
803
|
+
totalResults: number;
|
|
804
|
+
}>;
|
|
805
|
+
/**
|
|
806
|
+
* Get specific attribute value details
|
|
807
|
+
* @description Retrieve details for a specific attribute value
|
|
808
|
+
* @fullPath api.items.attributes.values.get
|
|
809
|
+
* @service items
|
|
810
|
+
* @domain attribute-management
|
|
811
|
+
* @dataMethod attributesValuesData.get
|
|
812
|
+
* @discoverable true
|
|
813
|
+
* @searchTerms ["attribute value details", "specific value", "value information"]
|
|
814
|
+
* @relatedEndpoints ["api.items.attributes.values.list", "api.items.attributes.get"]
|
|
815
|
+
* @commonPatterns ["Get value details", "View value information"]
|
|
816
|
+
* @workflow ["attribute-management", "value-details"]
|
|
817
|
+
* @prerequisites ["Valid authentication token", "Attribute management permissions", "Value must exist"]
|
|
818
|
+
* @nextSteps ["Update value", "Delete value", "Use in product associations"]
|
|
819
|
+
* @businessRules ["Value belongs to specific attribute", "Includes display and internal values"]
|
|
820
|
+
* @functionalArea "attribute-and-value-management"
|
|
821
|
+
* @caching "Standard detail caching"
|
|
822
|
+
* @performance "Direct lookup by ID"
|
|
823
|
+
* @param attributeUid Attribute unique identifier
|
|
824
|
+
* @param attributeValueUid Attribute value unique identifier
|
|
825
|
+
* @returns Attribute value details
|
|
826
|
+
* @throws ValidationError When response is malformed
|
|
827
|
+
* @example
|
|
828
|
+
* ```typescript
|
|
829
|
+
* const value = await client.attributes.values.get(123, 456);
|
|
830
|
+
* console.log(value.data.value, value.data.displayValue);
|
|
831
|
+
* ```
|
|
832
|
+
*/
|
|
833
|
+
get: (attributeUid: number, attributeValueUid: number) => Promise<{
|
|
834
|
+
data: {
|
|
835
|
+
value: string;
|
|
836
|
+
attributeValueUid: number;
|
|
837
|
+
attributeUid: number;
|
|
838
|
+
sequenceNo?: number | undefined;
|
|
839
|
+
displayValue?: string | undefined;
|
|
840
|
+
};
|
|
841
|
+
status: number;
|
|
842
|
+
message: string;
|
|
843
|
+
count: number;
|
|
844
|
+
total: number;
|
|
845
|
+
totalResults: number;
|
|
846
|
+
params?: any;
|
|
847
|
+
options?: any;
|
|
848
|
+
}>;
|
|
849
|
+
/**
|
|
850
|
+
* Create new attribute value
|
|
851
|
+
* @description Create a new value for an attribute
|
|
852
|
+
* @fullPath api.items.attributes.values.create
|
|
853
|
+
* @service items
|
|
854
|
+
* @domain attribute-management
|
|
855
|
+
* @dataMethod attributesValuesData.create
|
|
856
|
+
* @discoverable true
|
|
857
|
+
* @searchTerms ["create attribute value", "add value", "new attribute option"]
|
|
858
|
+
* @relatedEndpoints ["api.items.attributes.values.list", "api.items.attributes.get"]
|
|
859
|
+
* @commonPatterns ["Add new attribute option", "Expand attribute choices"]
|
|
860
|
+
* @workflow ["attribute-management", "value-creation"]
|
|
861
|
+
* @prerequisites ["Valid authentication token", "Attribute management permissions", "Attribute must exist"]
|
|
862
|
+
* @nextSteps ["List updated values", "Use in products"]
|
|
863
|
+
* @businessRules ["Value must be unique within attribute", "Display value enhances user experience"]
|
|
864
|
+
* @functionalArea "attribute-and-value-management"
|
|
865
|
+
* @caching "Invalidates attribute cache"
|
|
866
|
+
* @performance "Direct creation operation"
|
|
867
|
+
* @param attributeUid Attribute unique identifier
|
|
868
|
+
* @param request Attribute value data
|
|
869
|
+
* @returns Created attribute value information
|
|
870
|
+
* @throws ValidationError When request is invalid or response is malformed
|
|
871
|
+
* @example
|
|
872
|
+
* ```typescript
|
|
873
|
+
* const value = await client.attributes.values.create(123, {
|
|
874
|
+
* value: 'Blue',
|
|
875
|
+
* displayValue: 'Royal Blue',
|
|
876
|
+
* sequenceNo: 10
|
|
877
|
+
* });
|
|
878
|
+
* ```
|
|
879
|
+
*/
|
|
880
|
+
create: (attributeUid: number, request: CreateAttributeValueRequest) => Promise<{
|
|
881
|
+
data: {
|
|
882
|
+
value: string;
|
|
883
|
+
attributeValueUid: number;
|
|
884
|
+
attributeUid: number;
|
|
885
|
+
sequenceNo?: number | undefined;
|
|
886
|
+
displayValue?: string | undefined;
|
|
887
|
+
};
|
|
888
|
+
status: number;
|
|
889
|
+
message: string;
|
|
890
|
+
count: number;
|
|
891
|
+
total: number;
|
|
892
|
+
totalResults: number;
|
|
893
|
+
params?: any;
|
|
894
|
+
options?: any;
|
|
895
|
+
}>;
|
|
896
|
+
/**
|
|
897
|
+
* Update existing attribute value
|
|
898
|
+
* @description Update an existing attribute value
|
|
899
|
+
* @fullPath api.items.attributes.values.update
|
|
900
|
+
* @service items
|
|
901
|
+
* @domain attribute-management
|
|
902
|
+
* @dataMethod attributesValuesData.update
|
|
903
|
+
* @discoverable true
|
|
904
|
+
* @searchTerms ["update attribute value", "modify value", "edit attribute option"]
|
|
905
|
+
* @relatedEndpoints ["api.items.attributes.values.get", "api.items.attributes.values.list"]
|
|
906
|
+
* @commonPatterns ["Update value details", "Modify attribute options"]
|
|
907
|
+
* @workflow ["attribute-management", "value-maintenance"]
|
|
908
|
+
* @prerequisites ["Valid authentication token", "Attribute management permissions", "Value must exist"]
|
|
909
|
+
* @nextSteps ["Verify changes", "Update product associations if needed"]
|
|
910
|
+
* @businessRules ["Cannot change core value without affecting products", "Display value changes are safe"]
|
|
911
|
+
* @functionalArea "attribute-and-value-management"
|
|
912
|
+
* @caching "Invalidates attribute cache"
|
|
913
|
+
* @performance "Direct update operation"
|
|
914
|
+
* @param attributeUid Attribute unique identifier
|
|
915
|
+
* @param attributeValueUid Attribute value unique identifier
|
|
916
|
+
* @param request Update data
|
|
917
|
+
* @returns Updated attribute value information
|
|
918
|
+
* @throws ValidationError When request is invalid or response is malformed
|
|
919
|
+
* @example
|
|
920
|
+
* ```typescript
|
|
921
|
+
* const updated = await client.attributes.values.update(123, 456, {
|
|
922
|
+
* displayValue: 'Deep Royal Blue',
|
|
923
|
+
* sequenceNo: 15
|
|
924
|
+
* });
|
|
925
|
+
* ```
|
|
926
|
+
*/
|
|
927
|
+
update: (attributeUid: number, attributeValueUid: number, request: UpdateAttributeValueRequest) => Promise<{
|
|
928
|
+
data: {
|
|
929
|
+
value: string;
|
|
930
|
+
attributeValueUid: number;
|
|
931
|
+
attributeUid: number;
|
|
932
|
+
sequenceNo?: number | undefined;
|
|
933
|
+
displayValue?: string | undefined;
|
|
934
|
+
};
|
|
935
|
+
status: number;
|
|
936
|
+
message: string;
|
|
937
|
+
count: number;
|
|
938
|
+
total: number;
|
|
939
|
+
totalResults: number;
|
|
940
|
+
params?: any;
|
|
941
|
+
options?: any;
|
|
942
|
+
}>;
|
|
943
|
+
/**
|
|
944
|
+
* Delete attribute value
|
|
945
|
+
* @description Delete an attribute value
|
|
946
|
+
* @fullPath api.items.attributes.values.delete
|
|
947
|
+
* @service items
|
|
948
|
+
* @domain attribute-management
|
|
949
|
+
* @dataMethod attributesValuesData.delete
|
|
950
|
+
* @discoverable true
|
|
951
|
+
* @searchTerms ["delete attribute value", "remove value", "delete attribute option"]
|
|
952
|
+
* @relatedEndpoints ["api.items.attributes.values.list", "api.items.attributes.values.create"]
|
|
953
|
+
* @commonPatterns ["Remove attribute option", "Clean up unused values"]
|
|
954
|
+
* @workflow ["attribute-management", "value-cleanup"]
|
|
955
|
+
* @prerequisites ["Valid authentication token", "Attribute management permissions", "Value must exist", "Value not in use by products"]
|
|
956
|
+
* @nextSteps ["Verify removal", "List remaining values"]
|
|
957
|
+
* @businessRules ["Cannot delete values in use by products", "Deletion may affect product availability"]
|
|
958
|
+
* @functionalArea "attribute-and-value-management"
|
|
959
|
+
* @caching "Invalidates attribute cache"
|
|
960
|
+
* @performance "Direct deletion operation"
|
|
961
|
+
* @param attributeUid Attribute unique identifier
|
|
962
|
+
* @param attributeValueUid Attribute value unique identifier
|
|
963
|
+
* @returns Success status
|
|
964
|
+
* @throws ValidationError When response is malformed
|
|
965
|
+
* @example
|
|
966
|
+
* ```typescript
|
|
967
|
+
* await client.attributes.values.delete(123, 456);
|
|
968
|
+
* ```
|
|
969
|
+
*/
|
|
970
|
+
delete: (attributeUid: number, attributeValueUid: number) => Promise<boolean>;
|
|
971
|
+
};
|
|
740
972
|
};
|
|
741
973
|
/**
|
|
742
974
|
* Brand management endpoints
|
|
@@ -901,7 +1133,266 @@ export declare class ItemsClient extends BaseServiceClient {
|
|
|
901
1133
|
* ```
|
|
902
1134
|
*/
|
|
903
1135
|
delete: (brandsUid: number) => Promise<boolean>;
|
|
904
|
-
|
|
1136
|
+
/**
|
|
1137
|
+
* Brand items - Direct path mapping to /brands/{brandsUid}/items
|
|
1138
|
+
* @description OpenAPI Path Mirroring: /brands/{brandsUid}/items → brands.items.*
|
|
1139
|
+
*/
|
|
1140
|
+
items: {
|
|
1141
|
+
/**
|
|
1142
|
+
* List items associated with a brand
|
|
1143
|
+
* @description Retrieve all items associated with a specific brand
|
|
1144
|
+
* @fullPath api.items.brands.items.list
|
|
1145
|
+
* @service items
|
|
1146
|
+
* @domain product-catalog
|
|
1147
|
+
* @dataMethod brandsItemsData.list
|
|
1148
|
+
* @discoverable true
|
|
1149
|
+
* @searchTerms ["brand items", "brand products", "brand relationships", "manufacturer items", "brand catalog"]
|
|
1150
|
+
* @relatedEndpoints ["api.items.brands.list", "api.items.invMast.list"]
|
|
1151
|
+
* @commonPatterns ["List products from a manufacturer", "Browse brand catalog"]
|
|
1152
|
+
* @workflow ["product-catalog", "brand-management"]
|
|
1153
|
+
* @prerequisites ["Valid authentication token", "Product catalog permissions", "Brand must exist"]
|
|
1154
|
+
* @nextSteps ["Get item details", "Create brand associations"]
|
|
1155
|
+
* @businessRules ["Items can belong to multiple brands", "Primary brand relationships have priority"]
|
|
1156
|
+
* @functionalArea "product-catalog-and-brand-management"
|
|
1157
|
+
* @caching "Standard pagination caching"
|
|
1158
|
+
* @performance "Use pagination for brands with many items"
|
|
1159
|
+
* @param brandsUid Brand unique identifier
|
|
1160
|
+
* @param params Optional pagination parameters
|
|
1161
|
+
* @returns Array of items associated with the brand
|
|
1162
|
+
* @throws ValidationError When parameters are invalid or response is malformed
|
|
1163
|
+
* @example
|
|
1164
|
+
* ```typescript
|
|
1165
|
+
* const brandItems = await client.brands.items.list(123);
|
|
1166
|
+
* brandItems.data.forEach(item => {
|
|
1167
|
+
* console.log(`${item.itemId}: ${item.itemDesc}`);
|
|
1168
|
+
* });
|
|
1169
|
+
* ```
|
|
1170
|
+
*/
|
|
1171
|
+
list: (brandsUid: number, params?: BrandItemListParams) => Promise<{
|
|
1172
|
+
params: Record<string, unknown> | unknown[];
|
|
1173
|
+
data: {
|
|
1174
|
+
invMastUid: number;
|
|
1175
|
+
itemId: string;
|
|
1176
|
+
brandUid: number;
|
|
1177
|
+
brandItemUid: number;
|
|
1178
|
+
dateCreated?: string | undefined;
|
|
1179
|
+
dateLastModified?: string | undefined;
|
|
1180
|
+
itemDesc?: string | undefined;
|
|
1181
|
+
createdBy?: string | undefined;
|
|
1182
|
+
lastMaintainedBy?: string | undefined;
|
|
1183
|
+
isActive?: string | undefined;
|
|
1184
|
+
brandPartNumber?: string | undefined;
|
|
1185
|
+
brandItemDesc?: string | undefined;
|
|
1186
|
+
isPrimary?: string | undefined;
|
|
1187
|
+
}[];
|
|
1188
|
+
options: Record<string, unknown> | unknown[];
|
|
1189
|
+
status: number;
|
|
1190
|
+
message: string;
|
|
1191
|
+
count: number;
|
|
1192
|
+
total: number;
|
|
1193
|
+
totalResults: number;
|
|
1194
|
+
}>;
|
|
1195
|
+
/**
|
|
1196
|
+
* Get specific brand-item association
|
|
1197
|
+
* @description Retrieve details for a specific brand-item association
|
|
1198
|
+
* @fullPath api.items.brands.items.get
|
|
1199
|
+
* @service items
|
|
1200
|
+
* @domain product-catalog
|
|
1201
|
+
* @dataMethod brandsItemsData.get
|
|
1202
|
+
* @discoverable true
|
|
1203
|
+
* @searchTerms ["brand item association", "brand product details", "manufacturer item details"]
|
|
1204
|
+
* @relatedEndpoints ["api.items.brands.items.list", "api.items.invMast.get"]
|
|
1205
|
+
* @commonPatterns ["Get brand-item relationship details", "View manufacturer part information"]
|
|
1206
|
+
* @workflow ["product-catalog", "brand-relationship-details"]
|
|
1207
|
+
* @prerequisites ["Valid authentication token", "Product catalog permissions", "Association must exist"]
|
|
1208
|
+
* @nextSteps ["Update association", "Remove brand relationship"]
|
|
1209
|
+
* @businessRules ["Includes manufacturer part numbers", "Shows relationship priority"]
|
|
1210
|
+
* @functionalArea "product-catalog-and-brand-management"
|
|
1211
|
+
* @caching "Standard detail caching"
|
|
1212
|
+
* @performance "Direct lookup by ID"
|
|
1213
|
+
* @param brandsUid Brand unique identifier
|
|
1214
|
+
* @param brandsXItemsUid Brand-item association unique identifier
|
|
1215
|
+
* @returns Brand-item association details
|
|
1216
|
+
* @throws ValidationError When response is malformed
|
|
1217
|
+
* @example
|
|
1218
|
+
* ```typescript
|
|
1219
|
+
* const association = await client.brands.items.get(123, 789);
|
|
1220
|
+
* console.log(association.data.brandPartNumber, association.data.isPrimary);
|
|
1221
|
+
* ```
|
|
1222
|
+
*/
|
|
1223
|
+
get: (brandsUid: number, brandsXItemsUid: number) => Promise<{
|
|
1224
|
+
params: Record<string, unknown> | unknown[];
|
|
1225
|
+
data: {
|
|
1226
|
+
invMastUid: number;
|
|
1227
|
+
itemId: string;
|
|
1228
|
+
brandUid: number;
|
|
1229
|
+
brandItemUid: number;
|
|
1230
|
+
dateCreated?: string | undefined;
|
|
1231
|
+
dateLastModified?: string | undefined;
|
|
1232
|
+
itemDesc?: string | undefined;
|
|
1233
|
+
createdBy?: string | undefined;
|
|
1234
|
+
lastMaintainedBy?: string | undefined;
|
|
1235
|
+
isActive?: string | undefined;
|
|
1236
|
+
brandPartNumber?: string | undefined;
|
|
1237
|
+
brandItemDesc?: string | undefined;
|
|
1238
|
+
isPrimary?: string | undefined;
|
|
1239
|
+
};
|
|
1240
|
+
options: Record<string, unknown> | unknown[];
|
|
1241
|
+
status: number;
|
|
1242
|
+
message: string;
|
|
1243
|
+
count: number;
|
|
1244
|
+
total: number;
|
|
1245
|
+
totalResults: number;
|
|
1246
|
+
}>;
|
|
1247
|
+
/**
|
|
1248
|
+
* Create brand-item association
|
|
1249
|
+
* @description Create a new association between a brand and an item
|
|
1250
|
+
* @fullPath api.items.brands.items.create
|
|
1251
|
+
* @service items
|
|
1252
|
+
* @domain product-catalog
|
|
1253
|
+
* @dataMethod brandsItemsData.create
|
|
1254
|
+
* @discoverable true
|
|
1255
|
+
* @searchTerms ["create brand association", "add item to brand", "brand item relationship"]
|
|
1256
|
+
* @relatedEndpoints ["api.items.brands.items.list", "api.items.invMast.get"]
|
|
1257
|
+
* @commonPatterns ["Associate product with manufacturer", "Add brand to product"]
|
|
1258
|
+
* @workflow ["product-catalog", "brand-association"]
|
|
1259
|
+
* @prerequisites ["Valid authentication token", "Product catalog permissions", "Both brand and item must exist"]
|
|
1260
|
+
* @nextSteps ["List updated brand items", "Set as primary brand"]
|
|
1261
|
+
* @businessRules ["Item can have multiple brand associations", "Only one primary brand per item"]
|
|
1262
|
+
* @functionalArea "product-catalog-and-brand-management"
|
|
1263
|
+
* @caching "Invalidates brand catalog cache"
|
|
1264
|
+
* @performance "Direct creation operation"
|
|
1265
|
+
* @param brandsUid Brand unique identifier
|
|
1266
|
+
* @param request Brand-item association data
|
|
1267
|
+
* @returns Created association information
|
|
1268
|
+
* @throws ValidationError When request is invalid or response is malformed
|
|
1269
|
+
* @example
|
|
1270
|
+
* ```typescript
|
|
1271
|
+
* const association = await client.brands.items.create(123, {
|
|
1272
|
+
* invMastUid: 456,
|
|
1273
|
+
* brandPartNumber: 'ACME-12345',
|
|
1274
|
+
* isPrimary: 'Y'
|
|
1275
|
+
* });
|
|
1276
|
+
* ```
|
|
1277
|
+
*/
|
|
1278
|
+
create: (brandsUid: number, request: CreateBrandItemRequest) => Promise<{
|
|
1279
|
+
params: Record<string, unknown> | unknown[];
|
|
1280
|
+
data: {
|
|
1281
|
+
invMastUid: number;
|
|
1282
|
+
itemId: string;
|
|
1283
|
+
brandUid: number;
|
|
1284
|
+
brandItemUid: number;
|
|
1285
|
+
dateCreated?: string | undefined;
|
|
1286
|
+
dateLastModified?: string | undefined;
|
|
1287
|
+
itemDesc?: string | undefined;
|
|
1288
|
+
createdBy?: string | undefined;
|
|
1289
|
+
lastMaintainedBy?: string | undefined;
|
|
1290
|
+
isActive?: string | undefined;
|
|
1291
|
+
brandPartNumber?: string | undefined;
|
|
1292
|
+
brandItemDesc?: string | undefined;
|
|
1293
|
+
isPrimary?: string | undefined;
|
|
1294
|
+
};
|
|
1295
|
+
options: Record<string, unknown> | unknown[];
|
|
1296
|
+
status: number;
|
|
1297
|
+
message: string;
|
|
1298
|
+
count: number;
|
|
1299
|
+
total: number;
|
|
1300
|
+
totalResults: number;
|
|
1301
|
+
}>;
|
|
1302
|
+
/**
|
|
1303
|
+
* Update brand-item association
|
|
1304
|
+
* @description Update an existing brand-item association
|
|
1305
|
+
* @fullPath api.items.brands.items.update
|
|
1306
|
+
* @service items
|
|
1307
|
+
* @domain product-catalog
|
|
1308
|
+
* @dataMethod brandsItemsData.update
|
|
1309
|
+
* @discoverable true
|
|
1310
|
+
* @searchTerms ["update brand association", "modify brand relationship", "brand item update"]
|
|
1311
|
+
* @relatedEndpoints ["api.items.brands.items.get", "api.items.brands.items.list"]
|
|
1312
|
+
* @commonPatterns ["Update manufacturer part number", "Change primary brand status"]
|
|
1313
|
+
* @workflow ["product-catalog", "brand-maintenance"]
|
|
1314
|
+
* @prerequisites ["Valid authentication token", "Product catalog permissions", "Association must exist"]
|
|
1315
|
+
* @nextSteps ["Verify changes", "Update product information"]
|
|
1316
|
+
* @businessRules ["Cannot change core brand-item link", "Can update metadata like part numbers"]
|
|
1317
|
+
* @functionalArea "product-catalog-and-brand-management"
|
|
1318
|
+
* @caching "Invalidates brand catalog cache"
|
|
1319
|
+
* @performance "Direct update operation"
|
|
1320
|
+
* @param brandsUid Brand unique identifier
|
|
1321
|
+
* @param brandsXItemsUid Brand-item association unique identifier
|
|
1322
|
+
* @param request Update data
|
|
1323
|
+
* @returns Updated association information
|
|
1324
|
+
* @throws ValidationError When request is invalid or response is malformed
|
|
1325
|
+
* @example
|
|
1326
|
+
* ```typescript
|
|
1327
|
+
* const updated = await client.brands.items.update(123, 789, {
|
|
1328
|
+
* brandPartNumber: 'ACME-12345-V2',
|
|
1329
|
+
* isPrimary: 'N'
|
|
1330
|
+
* });
|
|
1331
|
+
* ```
|
|
1332
|
+
*/
|
|
1333
|
+
update: (brandsUid: number, brandsXItemsUid: number, request: UpdateBrandItemRequest) => Promise<{
|
|
1334
|
+
params: Record<string, unknown> | unknown[];
|
|
1335
|
+
data: {
|
|
1336
|
+
invMastUid: number;
|
|
1337
|
+
itemId: string;
|
|
1338
|
+
brandUid: number;
|
|
1339
|
+
brandItemUid: number;
|
|
1340
|
+
dateCreated?: string | undefined;
|
|
1341
|
+
dateLastModified?: string | undefined;
|
|
1342
|
+
itemDesc?: string | undefined;
|
|
1343
|
+
createdBy?: string | undefined;
|
|
1344
|
+
lastMaintainedBy?: string | undefined;
|
|
1345
|
+
isActive?: string | undefined;
|
|
1346
|
+
brandPartNumber?: string | undefined;
|
|
1347
|
+
brandItemDesc?: string | undefined;
|
|
1348
|
+
isPrimary?: string | undefined;
|
|
1349
|
+
};
|
|
1350
|
+
options: Record<string, unknown> | unknown[];
|
|
1351
|
+
status: number;
|
|
1352
|
+
message: string;
|
|
1353
|
+
count: number;
|
|
1354
|
+
total: number;
|
|
1355
|
+
totalResults: number;
|
|
1356
|
+
}>;
|
|
1357
|
+
/**
|
|
1358
|
+
* Delete brand-item association
|
|
1359
|
+
* @description Remove an item from a brand
|
|
1360
|
+
* @fullPath api.items.brands.items.delete
|
|
1361
|
+
* @service items
|
|
1362
|
+
* @domain product-catalog
|
|
1363
|
+
* @dataMethod brandsItemsData.delete
|
|
1364
|
+
* @discoverable true
|
|
1365
|
+
* @searchTerms ["remove brand association", "delete brand relationship", "brand item removal"]
|
|
1366
|
+
* @relatedEndpoints ["api.items.brands.items.list", "api.items.brands.items.create"]
|
|
1367
|
+
* @commonPatterns ["Remove product from brand", "Clean up brand associations"]
|
|
1368
|
+
* @workflow ["product-catalog", "brand-cleanup"]
|
|
1369
|
+
* @prerequisites ["Valid authentication token", "Product catalog permissions", "Association must exist"]
|
|
1370
|
+
* @nextSteps ["Verify removal", "Update product brand information"]
|
|
1371
|
+
* @businessRules ["Only removes association, not the item or brand", "May affect primary brand status"]
|
|
1372
|
+
* @functionalArea "product-catalog-and-brand-management"
|
|
1373
|
+
* @caching "Invalidates brand catalog cache"
|
|
1374
|
+
* @performance "Direct deletion operation"
|
|
1375
|
+
* @param brandsUid Brand unique identifier
|
|
1376
|
+
* @param brandsXItemsUid Brand-item association unique identifier
|
|
1377
|
+
* @returns Success status
|
|
1378
|
+
* @throws ValidationError When response is malformed
|
|
1379
|
+
* @example
|
|
1380
|
+
* ```typescript
|
|
1381
|
+
* await client.brands.items.delete(123, 789);
|
|
1382
|
+
* ```
|
|
1383
|
+
*/
|
|
1384
|
+
delete: (brandsUid: number, brandsXItemsUid: number) => Promise<{
|
|
1385
|
+
status: number;
|
|
1386
|
+
message: string;
|
|
1387
|
+
count: number;
|
|
1388
|
+
total: number;
|
|
1389
|
+
totalResults: number;
|
|
1390
|
+
params?: any;
|
|
1391
|
+
data?: any;
|
|
1392
|
+
options?: any;
|
|
1393
|
+
}>;
|
|
1394
|
+
};
|
|
1395
|
+
};
|
|
905
1396
|
/**
|
|
906
1397
|
* Attribute group management endpoints
|
|
907
1398
|
* @description Methods for managing attribute groups with comprehensive CRUD operations
|
|
@@ -1108,6 +1599,222 @@ export declare class ItemsClient extends BaseServiceClient {
|
|
|
1108
1599
|
total: number;
|
|
1109
1600
|
totalResults: number;
|
|
1110
1601
|
}>;
|
|
1602
|
+
/**
|
|
1603
|
+
* Attribute group attributes - Direct path mapping to /attribute-groups/{attributeGroupUid}/attributes
|
|
1604
|
+
* @description OpenAPI Path Mirroring: /attribute-groups/{attributeGroupUid}/attributes → attributeGroups.attributes.*
|
|
1605
|
+
*/
|
|
1606
|
+
attributes: {
|
|
1607
|
+
/**
|
|
1608
|
+
* List attributes in a group
|
|
1609
|
+
* @description Retrieve all attributes associated with an attribute group
|
|
1610
|
+
* @fullPath api.items.attributeGroups.attributes.list
|
|
1611
|
+
* @service items
|
|
1612
|
+
* @domain attribute-management
|
|
1613
|
+
* @dataMethod attributeGroupsAttributesData.list
|
|
1614
|
+
* @discoverable true
|
|
1615
|
+
* @searchTerms ["attribute group attributes", "group attributes", "attribute associations"]
|
|
1616
|
+
* @relatedEndpoints ["api.items.attributes.list", "api.items.attributeGroups.list"]
|
|
1617
|
+
* @commonPatterns ["List attributes in a group", "Manage attribute groups"]
|
|
1618
|
+
* @workflow ["attribute-management", "group-management"]
|
|
1619
|
+
* @prerequisites ["Valid authentication token", "Attribute management permissions"]
|
|
1620
|
+
* @nextSteps ["Create attribute associations", "Manage individual attributes"]
|
|
1621
|
+
* @businessRules ["Attributes can belong to multiple groups", "Group membership controls attribute display"]
|
|
1622
|
+
* @functionalArea "attribute-and-group-management"
|
|
1623
|
+
* @caching "Standard pagination caching"
|
|
1624
|
+
* @performance "Use pagination for large attribute groups"
|
|
1625
|
+
* @param attributeGroupUid Attribute group unique identifier
|
|
1626
|
+
* @param params Optional pagination parameters
|
|
1627
|
+
* @returns Array of attributes in the group
|
|
1628
|
+
* @throws ValidationError When parameters are invalid or response is malformed
|
|
1629
|
+
* @example
|
|
1630
|
+
* ```typescript
|
|
1631
|
+
* const groupAttrs = await client.attributeGroups.attributes.list(123);
|
|
1632
|
+
* groupAttrs.data.forEach(attr => {
|
|
1633
|
+
* console.log(`${attr.attributeId}: ${attr.attributeDesc}`);
|
|
1634
|
+
* });
|
|
1635
|
+
* ```
|
|
1636
|
+
*/
|
|
1637
|
+
list: (attributeGroupUid: number, params?: {
|
|
1638
|
+
limit?: number;
|
|
1639
|
+
offset?: number;
|
|
1640
|
+
}) => Promise<{
|
|
1641
|
+
params: Record<string, unknown> | unknown[];
|
|
1642
|
+
data: {
|
|
1643
|
+
attributeValueUid: number;
|
|
1644
|
+
attributeValue: string;
|
|
1645
|
+
attributeUid: number;
|
|
1646
|
+
sequenceNo?: number | undefined;
|
|
1647
|
+
displayValue?: string | undefined;
|
|
1648
|
+
}[];
|
|
1649
|
+
options: Record<string, unknown> | unknown[];
|
|
1650
|
+
status: number;
|
|
1651
|
+
message: string;
|
|
1652
|
+
count: number;
|
|
1653
|
+
total: number;
|
|
1654
|
+
totalResults: number;
|
|
1655
|
+
}>;
|
|
1656
|
+
/**
|
|
1657
|
+
* Get specific attribute association in a group
|
|
1658
|
+
* @description Retrieve details for a specific attribute-group association
|
|
1659
|
+
* @fullPath api.items.attributeGroups.attributes.get
|
|
1660
|
+
* @service items
|
|
1661
|
+
* @domain attribute-management
|
|
1662
|
+
* @dataMethod attributeGroupsAttributesData.get
|
|
1663
|
+
* @discoverable true
|
|
1664
|
+
* @searchTerms ["attribute group association", "group attribute details", "attribute association"]
|
|
1665
|
+
* @relatedEndpoints ["api.items.attributeGroups.attributes.list", "api.items.attributes.get"]
|
|
1666
|
+
* @commonPatterns ["Get attribute association details", "View group membership"]
|
|
1667
|
+
* @workflow ["attribute-management", "association-details"]
|
|
1668
|
+
* @prerequisites ["Valid authentication token", "Attribute management permissions"]
|
|
1669
|
+
* @nextSteps ["Update association", "Remove from group"]
|
|
1670
|
+
* @businessRules ["Association must exist", "Includes sequence information"]
|
|
1671
|
+
* @functionalArea "attribute-and-group-management"
|
|
1672
|
+
* @caching "Standard detail caching"
|
|
1673
|
+
* @performance "Direct lookup by ID"
|
|
1674
|
+
* @param attributeGroupUid Attribute group unique identifier
|
|
1675
|
+
* @param attributeXAttributeGroupUid Attribute association unique identifier
|
|
1676
|
+
* @returns Attribute association details
|
|
1677
|
+
* @throws ValidationError When response is malformed
|
|
1678
|
+
* @example
|
|
1679
|
+
* ```typescript
|
|
1680
|
+
* const association = await client.attributeGroups.attributes.get(123, 789);
|
|
1681
|
+
* console.log(association.data.attributeUid, association.data.sequenceNo);
|
|
1682
|
+
* ```
|
|
1683
|
+
*/
|
|
1684
|
+
get: (attributeGroupUid: number, attributeXAttributeGroupUid: number) => Promise<{
|
|
1685
|
+
data: {
|
|
1686
|
+
attributeUid: number;
|
|
1687
|
+
attributeGroupUid: number;
|
|
1688
|
+
attributeXAttributeGroupUid: number;
|
|
1689
|
+
sequenceNo?: number | undefined;
|
|
1690
|
+
};
|
|
1691
|
+
status: number;
|
|
1692
|
+
message: string;
|
|
1693
|
+
count: number;
|
|
1694
|
+
total: number;
|
|
1695
|
+
totalResults: number;
|
|
1696
|
+
params?: any;
|
|
1697
|
+
options?: any;
|
|
1698
|
+
}>;
|
|
1699
|
+
/**
|
|
1700
|
+
* Create attribute association in a group
|
|
1701
|
+
* @description Create an association between an attribute and an attribute group
|
|
1702
|
+
* @fullPath api.items.attributeGroups.attributes.create
|
|
1703
|
+
* @service items
|
|
1704
|
+
* @domain attribute-management
|
|
1705
|
+
* @dataMethod attributeGroupsAttributesData.create
|
|
1706
|
+
* @discoverable true
|
|
1707
|
+
* @searchTerms ["create attribute association", "add attribute to group", "attribute group membership"]
|
|
1708
|
+
* @relatedEndpoints ["api.items.attributeGroups.attributes.list", "api.items.attributes.list"]
|
|
1709
|
+
* @commonPatterns ["Add attribute to group", "Organize attributes"]
|
|
1710
|
+
* @workflow ["attribute-management", "group-organization"]
|
|
1711
|
+
* @prerequisites ["Valid authentication token", "Attribute management permissions", "Both attribute and group must exist"]
|
|
1712
|
+
* @nextSteps ["Update association sequence", "List group attributes"]
|
|
1713
|
+
* @businessRules ["Attribute can belong to multiple groups", "Sequence controls display order"]
|
|
1714
|
+
* @functionalArea "attribute-and-group-management"
|
|
1715
|
+
* @caching "Invalidates group cache"
|
|
1716
|
+
* @performance "Direct creation operation"
|
|
1717
|
+
* @param attributeGroupUid Attribute group unique identifier
|
|
1718
|
+
* @param request Attribute association data
|
|
1719
|
+
* @returns Created association information
|
|
1720
|
+
* @throws ValidationError When request is invalid or response is malformed
|
|
1721
|
+
* @example
|
|
1722
|
+
* ```typescript
|
|
1723
|
+
* const association = await client.attributeGroups.attributes.create(123, {
|
|
1724
|
+
* attributeUid: 456,
|
|
1725
|
+
* sequenceNo: 10
|
|
1726
|
+
* });
|
|
1727
|
+
* ```
|
|
1728
|
+
*/
|
|
1729
|
+
create: (attributeGroupUid: number, request: CreateAttributeGroupAttributeRequest) => Promise<{
|
|
1730
|
+
data: {
|
|
1731
|
+
attributeUid: number;
|
|
1732
|
+
attributeGroupUid: number;
|
|
1733
|
+
attributeXAttributeGroupUid: number;
|
|
1734
|
+
sequenceNo?: number | undefined;
|
|
1735
|
+
};
|
|
1736
|
+
status: number;
|
|
1737
|
+
message: string;
|
|
1738
|
+
count: number;
|
|
1739
|
+
total: number;
|
|
1740
|
+
totalResults: number;
|
|
1741
|
+
params?: any;
|
|
1742
|
+
options?: any;
|
|
1743
|
+
}>;
|
|
1744
|
+
/**
|
|
1745
|
+
* Update attribute association in a group
|
|
1746
|
+
* @description Update an existing attribute-group association
|
|
1747
|
+
* @fullPath api.items.attributeGroups.attributes.update
|
|
1748
|
+
* @service items
|
|
1749
|
+
* @domain attribute-management
|
|
1750
|
+
* @dataMethod attributeGroupsAttributesData.update
|
|
1751
|
+
* @discoverable true
|
|
1752
|
+
* @searchTerms ["update attribute association", "modify group membership", "attribute sequence"]
|
|
1753
|
+
* @relatedEndpoints ["api.items.attributeGroups.attributes.get", "api.items.attributeGroups.attributes.list"]
|
|
1754
|
+
* @commonPatterns ["Update display sequence", "Modify group organization"]
|
|
1755
|
+
* @workflow ["attribute-management", "group-organization"]
|
|
1756
|
+
* @prerequisites ["Valid authentication token", "Attribute management permissions", "Association must exist"]
|
|
1757
|
+
* @nextSteps ["List updated group attributes", "Verify changes"]
|
|
1758
|
+
* @businessRules ["Can only update sequence and other non-key fields", "Sequence controls display order"]
|
|
1759
|
+
* @functionalArea "attribute-and-group-management"
|
|
1760
|
+
* @caching "Invalidates group cache"
|
|
1761
|
+
* @performance "Direct update operation"
|
|
1762
|
+
* @param attributeGroupUid Attribute group unique identifier
|
|
1763
|
+
* @param attributeXAttributeGroupUid Attribute association unique identifier
|
|
1764
|
+
* @param request Update data
|
|
1765
|
+
* @returns Updated association information
|
|
1766
|
+
* @throws ValidationError When request is invalid or response is malformed
|
|
1767
|
+
* @example
|
|
1768
|
+
* ```typescript
|
|
1769
|
+
* const updated = await client.attributeGroups.attributes.update(123, 789, {
|
|
1770
|
+
* sequenceNo: 20
|
|
1771
|
+
* });
|
|
1772
|
+
* ```
|
|
1773
|
+
*/
|
|
1774
|
+
update: (attributeGroupUid: number, attributeXAttributeGroupUid: number, request: UpdateAttributeGroupAttributeRequest) => Promise<{
|
|
1775
|
+
data: {
|
|
1776
|
+
attributeUid: number;
|
|
1777
|
+
attributeGroupUid: number;
|
|
1778
|
+
attributeXAttributeGroupUid: number;
|
|
1779
|
+
sequenceNo?: number | undefined;
|
|
1780
|
+
};
|
|
1781
|
+
status: number;
|
|
1782
|
+
message: string;
|
|
1783
|
+
count: number;
|
|
1784
|
+
total: number;
|
|
1785
|
+
totalResults: number;
|
|
1786
|
+
params?: any;
|
|
1787
|
+
options?: any;
|
|
1788
|
+
}>;
|
|
1789
|
+
/**
|
|
1790
|
+
* Delete attribute association from a group
|
|
1791
|
+
* @description Remove an attribute from an attribute group
|
|
1792
|
+
* @fullPath api.items.attributeGroups.attributes.delete
|
|
1793
|
+
* @service items
|
|
1794
|
+
* @domain attribute-management
|
|
1795
|
+
* @dataMethod attributeGroupsAttributesData.delete
|
|
1796
|
+
* @discoverable true
|
|
1797
|
+
* @searchTerms ["remove attribute from group", "delete attribute association", "group membership removal"]
|
|
1798
|
+
* @relatedEndpoints ["api.items.attributeGroups.attributes.list", "api.items.attributeGroups.attributes.create"]
|
|
1799
|
+
* @commonPatterns ["Remove attribute from group", "Clean up attribute organization"]
|
|
1800
|
+
* @workflow ["attribute-management", "group-cleanup"]
|
|
1801
|
+
* @prerequisites ["Valid authentication token", "Attribute management permissions", "Association must exist"]
|
|
1802
|
+
* @nextSteps ["List remaining group attributes", "Verify removal"]
|
|
1803
|
+
* @businessRules ["Only removes association, not the attribute itself", "Does not affect other group memberships"]
|
|
1804
|
+
* @functionalArea "attribute-and-group-management"
|
|
1805
|
+
* @caching "Invalidates group cache"
|
|
1806
|
+
* @performance "Direct deletion operation"
|
|
1807
|
+
* @param attributeGroupUid Attribute group unique identifier
|
|
1808
|
+
* @param attributeXAttributeGroupUid Attribute association unique identifier
|
|
1809
|
+
* @returns Success status
|
|
1810
|
+
* @throws ValidationError When response is malformed
|
|
1811
|
+
* @example
|
|
1812
|
+
* ```typescript
|
|
1813
|
+
* await client.attributeGroups.attributes.delete(123, 789);
|
|
1814
|
+
* ```
|
|
1815
|
+
*/
|
|
1816
|
+
delete: (attributeGroupUid: number, attributeXAttributeGroupUid: number) => Promise<boolean>;
|
|
1817
|
+
};
|
|
1111
1818
|
};
|
|
1112
1819
|
/**
|
|
1113
1820
|
* Attribute value management endpoints
|
|
@@ -1147,25 +1854,6 @@ export declare class ItemsClient extends BaseServiceClient {
|
|
|
1147
1854
|
total: number;
|
|
1148
1855
|
totalResults: number;
|
|
1149
1856
|
}>;
|
|
1150
|
-
/**
|
|
1151
|
-
* Get attribute value details by ID
|
|
1152
|
-
* @description Retrieve details for a specific attribute value
|
|
1153
|
-
* @param attributeValueUid Attribute value unique identifier
|
|
1154
|
-
* @returns Attribute value details
|
|
1155
|
-
* @throws ValidationError When response is malformed
|
|
1156
|
-
* @example
|
|
1157
|
-
* ```typescript
|
|
1158
|
-
* const value = await client.attributeValues.get(123);
|
|
1159
|
-
* console.log(value.attributeValue, value.displayValue);
|
|
1160
|
-
* ```
|
|
1161
|
-
*/
|
|
1162
|
-
get: (attributeValueUid: number) => Promise<{
|
|
1163
|
-
attributeValueUid: number;
|
|
1164
|
-
attributeValue: string;
|
|
1165
|
-
attributeUid: number;
|
|
1166
|
-
sequenceNo?: number | undefined;
|
|
1167
|
-
displayValue?: string | undefined;
|
|
1168
|
-
}>;
|
|
1169
1857
|
};
|
|
1170
1858
|
/**
|
|
1171
1859
|
* Item attribute value management endpoints
|
|
@@ -1244,20 +1932,20 @@ export declare class ItemsClient extends BaseServiceClient {
|
|
|
1244
1932
|
}>;
|
|
1245
1933
|
};
|
|
1246
1934
|
/**
|
|
1247
|
-
* Health
|
|
1248
|
-
* @description
|
|
1935
|
+
* Health check endpoint - Direct path mapping to /health-check
|
|
1936
|
+
* @description OpenAPI Path Mirroring: /health-check → healthCheck.get()
|
|
1249
1937
|
*/
|
|
1250
|
-
|
|
1938
|
+
healthCheck: {
|
|
1251
1939
|
/**
|
|
1252
1940
|
* Service health check
|
|
1253
1941
|
* @description Verify service health and trigger seed jobs if needed
|
|
1254
|
-
* @fullPath api.items.
|
|
1942
|
+
* @fullPath api.items.healthCheck.get
|
|
1255
1943
|
* @service items
|
|
1256
1944
|
* @domain system-health
|
|
1257
|
-
* @dataMethod
|
|
1945
|
+
* @dataMethod healthCheckData.get
|
|
1258
1946
|
* @discoverable true
|
|
1259
1947
|
* @searchTerms ["health check", "service status", "system health", "service monitoring"]
|
|
1260
|
-
* @relatedEndpoints ["api.joomla.
|
|
1948
|
+
* @relatedEndpoints ["api.joomla.healthCheck.get", "api.nexus.healthCheck.get", "api.commerce.healthCheck.get"]
|
|
1261
1949
|
* @commonPatterns ["Check service health", "Monitor system status", "Verify connectivity"]
|
|
1262
1950
|
* @workflow ["service-monitoring", "health-verification", "system-diagnostics"]
|
|
1263
1951
|
* @prerequisites ["Valid authentication token", "System monitoring permissions"]
|
|
@@ -1270,12 +1958,12 @@ export declare class ItemsClient extends BaseServiceClient {
|
|
|
1270
1958
|
* @throws ValidationError When response is malformed
|
|
1271
1959
|
* @example
|
|
1272
1960
|
* ```typescript
|
|
1273
|
-
* const health = await client.
|
|
1961
|
+
* const health = await client.healthCheck.get();
|
|
1274
1962
|
* console.log('Site ID:', health.data.siteId);
|
|
1275
1963
|
* console.log('Site Hash:', health.data.siteHash);
|
|
1276
1964
|
* ```
|
|
1277
1965
|
*/
|
|
1278
|
-
|
|
1966
|
+
get: () => Promise<{
|
|
1279
1967
|
params: Record<string, unknown> | unknown[];
|
|
1280
1968
|
data: {
|
|
1281
1969
|
siteHash: string;
|
|
@@ -1288,20 +1976,26 @@ export declare class ItemsClient extends BaseServiceClient {
|
|
|
1288
1976
|
total: number;
|
|
1289
1977
|
totalResults: number;
|
|
1290
1978
|
}>;
|
|
1979
|
+
};
|
|
1980
|
+
/**
|
|
1981
|
+
* Ping endpoint - Direct path mapping to /ping
|
|
1982
|
+
* @description OpenAPI Path Mirroring: /ping → ping.get()
|
|
1983
|
+
*/
|
|
1984
|
+
ping: {
|
|
1291
1985
|
/**
|
|
1292
1986
|
* Simple connectivity test
|
|
1293
1987
|
* @description Simple connectivity test endpoint (no authentication required)
|
|
1294
|
-
* @fullPath api.items.
|
|
1988
|
+
* @fullPath api.items.ping.get
|
|
1295
1989
|
* @service items
|
|
1296
1990
|
* @domain system-health
|
|
1297
|
-
* @dataMethod
|
|
1991
|
+
* @dataMethod pingData.get
|
|
1298
1992
|
* @discoverable true
|
|
1299
1993
|
* @searchTerms ["ping", "connectivity test", "service alive", "basic health"]
|
|
1300
|
-
* @relatedEndpoints ["api.joomla.
|
|
1994
|
+
* @relatedEndpoints ["api.joomla.ping.get", "api.nexus.ping.get", "api.commerce.ping.get"]
|
|
1301
1995
|
* @commonPatterns ["Test connectivity", "Basic health check", "Service alive check"]
|
|
1302
1996
|
* @workflow ["connectivity-verification", "basic-monitoring"]
|
|
1303
1997
|
* @prerequisites ["Network connectivity"]
|
|
1304
|
-
* @nextSteps ["api.items.
|
|
1998
|
+
* @nextSteps ["api.items.healthCheck.get for full health verification"]
|
|
1305
1999
|
* @businessRules ["No authentication required", "Always returns 'pong'", "Minimal resource usage"]
|
|
1306
2000
|
* @functionalArea "basic-connectivity-testing"
|
|
1307
2001
|
* @caching "No caching, real-time response"
|
|
@@ -1310,264 +2004,152 @@ export declare class ItemsClient extends BaseServiceClient {
|
|
|
1310
2004
|
* @throws ValidationError When response is malformed
|
|
1311
2005
|
* @example
|
|
1312
2006
|
* ```typescript
|
|
1313
|
-
* const pong = await client.
|
|
2007
|
+
* const pong = await client.ping.get();
|
|
1314
2008
|
* console.log(pong.data); // "pong"
|
|
1315
2009
|
* ```
|
|
1316
2010
|
*/
|
|
1317
|
-
|
|
2011
|
+
get: () => Promise<PingResponse>;
|
|
1318
2012
|
};
|
|
1319
2013
|
/**
|
|
1320
|
-
* Health
|
|
1321
|
-
* @description Data-only methods that return just the data portion of health responses
|
|
2014
|
+
* Health check data-only endpoints
|
|
2015
|
+
* @description Data-only methods that return just the data portion of health check responses
|
|
1322
2016
|
*/
|
|
1323
|
-
|
|
2017
|
+
healthCheckData: {
|
|
1324
2018
|
/**
|
|
1325
2019
|
* Service health check data only
|
|
1326
2020
|
* @description Returns only the data portion of health check response
|
|
1327
|
-
* @fullPath api.items.
|
|
2021
|
+
* @fullPath api.items.healthCheckData.get
|
|
1328
2022
|
* @service items
|
|
1329
2023
|
* @domain system-health
|
|
1330
2024
|
* @discoverable true
|
|
1331
2025
|
* @searchTerms ["health data", "service status data", "health check data only"]
|
|
1332
|
-
* @relatedEndpoints ["api.items.
|
|
2026
|
+
* @relatedEndpoints ["api.items.healthCheck.get"]
|
|
1333
2027
|
* @commonPatterns ["Get health status without metadata"]
|
|
1334
2028
|
* @returns Health check data only
|
|
1335
2029
|
*/
|
|
1336
|
-
|
|
2030
|
+
get: () => Promise<{
|
|
1337
2031
|
siteHash: string;
|
|
1338
2032
|
siteId: string;
|
|
1339
2033
|
}>;
|
|
2034
|
+
};
|
|
2035
|
+
/**
|
|
2036
|
+
* Ping data-only endpoints
|
|
2037
|
+
* @description Data-only methods that return just the data portion of ping responses
|
|
2038
|
+
*/
|
|
2039
|
+
pingData: {
|
|
1340
2040
|
/**
|
|
1341
2041
|
* Simple connectivity test data only
|
|
1342
2042
|
* @description Returns only the data portion of ping response
|
|
1343
|
-
* @fullPath api.items.
|
|
2043
|
+
* @fullPath api.items.pingData.get
|
|
1344
2044
|
* @service items
|
|
1345
2045
|
* @domain system-health
|
|
1346
2046
|
* @discoverable true
|
|
1347
2047
|
* @searchTerms ["ping data", "connectivity data", "service alive data"]
|
|
1348
|
-
* @relatedEndpoints ["api.items.
|
|
2048
|
+
* @relatedEndpoints ["api.items.ping.get"]
|
|
1349
2049
|
* @commonPatterns ["Test connectivity without metadata"]
|
|
1350
2050
|
* @returns Ping data only
|
|
1351
2051
|
*/
|
|
1352
|
-
|
|
2052
|
+
get: () => Promise<"pong">;
|
|
1353
2053
|
};
|
|
1354
2054
|
/**
|
|
1355
|
-
*
|
|
1356
|
-
* @description
|
|
2055
|
+
* Internal endpoints - Direct path mapping to /internal/*
|
|
2056
|
+
* @description OpenAPI Path Mirroring: /internal/* → internal.*
|
|
1357
2057
|
*/
|
|
1358
|
-
|
|
2058
|
+
internal: {
|
|
1359
2059
|
/**
|
|
1360
|
-
*
|
|
1361
|
-
* @description
|
|
1362
|
-
* @fullPath api.items.itemFavorites.list
|
|
1363
|
-
* @service items
|
|
1364
|
-
* @domain user-preferences
|
|
1365
|
-
* @dataMethod itemFavoritesData.list
|
|
1366
|
-
* @discoverable true
|
|
1367
|
-
* @searchTerms ["favorites", "user favorites", "liked items", "bookmarked items", "favorite products"]
|
|
1368
|
-
* @relatedEndpoints ["api.items.itemWishlist.list", "api.customers.users.preferences"]
|
|
1369
|
-
* @commonPatterns ["Show user favorites", "Manage favorite items", "User preference management"]
|
|
1370
|
-
* @workflow ["user-preferences", "favorites-management"]
|
|
1371
|
-
* @prerequisites ["Valid authentication token", "User context"]
|
|
1372
|
-
* @nextSteps ["api.items.invMast.get for product details", "api.commerce.cartHeaders.addItem for adding to cart"]
|
|
1373
|
-
* @businessRules ["Shows only current user's favorites", "Respects product visibility", "Returns active favorites only"]
|
|
1374
|
-
* @functionalArea "user-preference-management"
|
|
1375
|
-
* @caching "Cache for 5 minutes, invalidate on favorites changes"
|
|
1376
|
-
* @performance "Paginated results for large favorite lists"
|
|
1377
|
-
* @param params Optional filtering and pagination parameters
|
|
1378
|
-
* @returns Array of user's favorite items
|
|
1379
|
-
* @throws ValidationError When parameters are invalid or response is malformed
|
|
1380
|
-
* @example
|
|
1381
|
-
* ```typescript
|
|
1382
|
-
* const favorites = await client.itemFavorites.list({ limit: 20 });
|
|
1383
|
-
* favorites.data.forEach(fav => {
|
|
1384
|
-
* console.log(`Favorite: ${fav.itemDesc} (${fav.itemId})`);
|
|
1385
|
-
* });
|
|
1386
|
-
* ```
|
|
1387
|
-
*/
|
|
1388
|
-
list: (params?: ItemFavoritesListParams) => Promise<{
|
|
1389
|
-
params: Record<string, unknown> | unknown[];
|
|
1390
|
-
data: {
|
|
1391
|
-
invMastUid: number;
|
|
1392
|
-
itemId: string;
|
|
1393
|
-
usersId: number;
|
|
1394
|
-
itemFavoritesUid: number;
|
|
1395
|
-
dateCreated?: string | undefined;
|
|
1396
|
-
dateLastModified?: string | undefined;
|
|
1397
|
-
itemDesc?: string | undefined;
|
|
1398
|
-
createdBy?: string | undefined;
|
|
1399
|
-
lastMaintainedBy?: string | undefined;
|
|
1400
|
-
}[];
|
|
1401
|
-
options: Record<string, unknown> | unknown[];
|
|
1402
|
-
status: number;
|
|
1403
|
-
message: string;
|
|
1404
|
-
count: number;
|
|
1405
|
-
total: number;
|
|
1406
|
-
totalResults: number;
|
|
1407
|
-
}>;
|
|
1408
|
-
/**
|
|
1409
|
-
* Add item to favorites
|
|
1410
|
-
* @description Add an item to the current user's favorites
|
|
1411
|
-
* @param request Favorite item creation data
|
|
1412
|
-
* @returns Created favorite item information
|
|
1413
|
-
* @throws ValidationError When request is invalid or response is malformed
|
|
1414
|
-
* @example
|
|
1415
|
-
* ```typescript
|
|
1416
|
-
* const favorite = await client.itemFavorites.create({
|
|
1417
|
-
* invMastUid: 12345,
|
|
1418
|
-
* itemNote: 'Great product for my projects'
|
|
1419
|
-
* });
|
|
1420
|
-
* ```
|
|
1421
|
-
*/
|
|
1422
|
-
create: (data: {
|
|
1423
|
-
invMastUid: number;
|
|
1424
|
-
itemNote?: string | undefined;
|
|
1425
|
-
}) => Promise<{
|
|
1426
|
-
params: Record<string, unknown> | unknown[];
|
|
1427
|
-
data: {
|
|
1428
|
-
invMastUid: number;
|
|
1429
|
-
itemId: string;
|
|
1430
|
-
usersId: number;
|
|
1431
|
-
itemFavoritesUid: number;
|
|
1432
|
-
dateCreated?: string | undefined;
|
|
1433
|
-
dateLastModified?: string | undefined;
|
|
1434
|
-
itemDesc?: string | undefined;
|
|
1435
|
-
createdBy?: string | undefined;
|
|
1436
|
-
lastMaintainedBy?: string | undefined;
|
|
1437
|
-
};
|
|
1438
|
-
options: Record<string, unknown> | unknown[];
|
|
1439
|
-
status: number;
|
|
1440
|
-
message: string;
|
|
1441
|
-
count: number;
|
|
1442
|
-
total: number;
|
|
1443
|
-
totalResults: number;
|
|
1444
|
-
}>;
|
|
1445
|
-
/**
|
|
1446
|
-
* Remove item from favorites
|
|
1447
|
-
* @description Remove an item from the current user's favorites
|
|
1448
|
-
* @param favoriteUid Favorite item unique identifier
|
|
1449
|
-
* @returns Success response
|
|
1450
|
-
* @throws ValidationError When response is malformed
|
|
1451
|
-
* @example
|
|
1452
|
-
* ```typescript
|
|
1453
|
-
* await client.itemFavorites.delete(123);
|
|
1454
|
-
* ```
|
|
1455
|
-
*/
|
|
1456
|
-
delete: (id: string | number) => Promise<{
|
|
1457
|
-
params: Record<string, unknown> | unknown[];
|
|
1458
|
-
data: {
|
|
1459
|
-
invMastUid: number;
|
|
1460
|
-
itemId: string;
|
|
1461
|
-
usersId: number;
|
|
1462
|
-
itemFavoritesUid: number;
|
|
1463
|
-
dateCreated?: string | undefined;
|
|
1464
|
-
dateLastModified?: string | undefined;
|
|
1465
|
-
itemDesc?: string | undefined;
|
|
1466
|
-
createdBy?: string | undefined;
|
|
1467
|
-
lastMaintainedBy?: string | undefined;
|
|
1468
|
-
};
|
|
1469
|
-
options: Record<string, unknown> | unknown[];
|
|
1470
|
-
status: number;
|
|
1471
|
-
message: string;
|
|
1472
|
-
count: number;
|
|
1473
|
-
total: number;
|
|
1474
|
-
totalResults: number;
|
|
1475
|
-
}>;
|
|
1476
|
-
/**
|
|
1477
|
-
* Update favorite item
|
|
1478
|
-
* @description Update a favorite item's information
|
|
1479
|
-
* @param favoriteUid Favorite item unique identifier
|
|
1480
|
-
* @param request Update data
|
|
1481
|
-
* @returns Updated favorite item information
|
|
1482
|
-
* @throws ValidationError When request is invalid or response is malformed
|
|
1483
|
-
* @example
|
|
1484
|
-
* ```typescript
|
|
1485
|
-
* const updated = await client.itemFavorites.update(123, {
|
|
1486
|
-
* itemNote: 'Updated note about this favorite item'
|
|
1487
|
-
* });
|
|
1488
|
-
* ```
|
|
2060
|
+
* PDF generation endpoints - Direct path mapping to /internal/pdf
|
|
2061
|
+
* @description OpenAPI Path Mirroring: /internal/pdf → internal.pdf.create()
|
|
1489
2062
|
*/
|
|
1490
|
-
|
|
1491
|
-
|
|
1492
|
-
|
|
1493
|
-
|
|
1494
|
-
|
|
1495
|
-
|
|
1496
|
-
|
|
1497
|
-
|
|
1498
|
-
|
|
1499
|
-
|
|
1500
|
-
|
|
1501
|
-
|
|
1502
|
-
|
|
1503
|
-
|
|
1504
|
-
|
|
1505
|
-
|
|
1506
|
-
|
|
1507
|
-
|
|
1508
|
-
|
|
1509
|
-
|
|
1510
|
-
|
|
1511
|
-
|
|
2063
|
+
pdf: {
|
|
2064
|
+
/**
|
|
2065
|
+
* Create internal PDF
|
|
2066
|
+
* @description Generate internal PDF documents
|
|
2067
|
+
* @fullPath api.items.internal.pdf.create
|
|
2068
|
+
* @service items
|
|
2069
|
+
* @domain document-generation
|
|
2070
|
+
* @dataMethod internalPdfData.create
|
|
2071
|
+
* @discoverable true
|
|
2072
|
+
* @searchTerms ["pdf generation", "internal pdf", "document creation", "pdf templates"]
|
|
2073
|
+
* @relatedEndpoints ["api.joomla.internal.pdf.create", "api.nexus.internal.pdf.create"]
|
|
2074
|
+
* @commonPatterns ["Generate PDF documents", "Create reports", "Export data to PDF"]
|
|
2075
|
+
* @workflow ["document-generation", "report-creation"]
|
|
2076
|
+
* @prerequisites ["Valid authentication token", "Document generation permissions"]
|
|
2077
|
+
* @nextSteps ["Download generated PDF", "Store PDF reference"]
|
|
2078
|
+
* @businessRules ["Template must exist", "Data structure must match template requirements"]
|
|
2079
|
+
* @functionalArea "document-and-report-generation"
|
|
2080
|
+
* @caching "No caching, dynamic generation"
|
|
2081
|
+
* @performance "PDF generation can take 1-5 seconds depending on complexity"
|
|
2082
|
+
* @param request PDF generation parameters
|
|
2083
|
+
* @returns PDF generation result
|
|
2084
|
+
* @throws ValidationError When request is invalid or response is malformed
|
|
2085
|
+
* @example
|
|
2086
|
+
* ```typescript
|
|
2087
|
+
* const pdf = await client.internal.pdf.create({
|
|
2088
|
+
* templateId: 'invoice',
|
|
2089
|
+
* data: { orderId: 12345 }
|
|
2090
|
+
* });
|
|
2091
|
+
* console.log('PDF URL:', pdf.data.pdfUrl);
|
|
2092
|
+
* ```
|
|
2093
|
+
*/
|
|
2094
|
+
create: (request: CreateInternalPdfRequest) => Promise<{
|
|
2095
|
+
params: Record<string, unknown> | unknown[];
|
|
2096
|
+
data: {
|
|
2097
|
+
documentType: string;
|
|
2098
|
+
pdfId: string;
|
|
2099
|
+
fileName: string;
|
|
2100
|
+
fileSize: number;
|
|
2101
|
+
downloadUrl: string;
|
|
2102
|
+
createdAt: string;
|
|
2103
|
+
expiresAt?: string | undefined;
|
|
2104
|
+
};
|
|
2105
|
+
options: Record<string, unknown> | unknown[];
|
|
2106
|
+
status: number;
|
|
2107
|
+
message: string;
|
|
2108
|
+
count: number;
|
|
2109
|
+
total: number;
|
|
2110
|
+
totalResults: number;
|
|
2111
|
+
}>;
|
|
2112
|
+
};
|
|
1512
2113
|
};
|
|
1513
2114
|
/**
|
|
1514
|
-
*
|
|
1515
|
-
* @
|
|
2115
|
+
* Legacy itemFavorites removed - now using OpenAPI Path Mirroring Pattern
|
|
2116
|
+
* @see itemFavorites implementation below that follows /item-favorites/{usersId} structure
|
|
1516
2117
|
*/
|
|
1517
|
-
itemFavoritesData: {
|
|
1518
|
-
/**
|
|
1519
|
-
* List user's favorite items data only
|
|
1520
|
-
* @description Returns only the data portion of favorites list response
|
|
1521
|
-
* @param params Optional filtering and pagination parameters
|
|
1522
|
-
* @returns Array of favorite items data
|
|
1523
|
-
*/
|
|
1524
|
-
list: (params?: ItemFavoritesListParams) => Promise<{
|
|
1525
|
-
invMastUid: number;
|
|
1526
|
-
itemId: string;
|
|
1527
|
-
usersId: number;
|
|
1528
|
-
itemFavoritesUid: number;
|
|
1529
|
-
dateCreated?: string | undefined;
|
|
1530
|
-
dateLastModified?: string | undefined;
|
|
1531
|
-
itemDesc?: string | undefined;
|
|
1532
|
-
createdBy?: string | undefined;
|
|
1533
|
-
lastMaintainedBy?: string | undefined;
|
|
1534
|
-
}[]>;
|
|
1535
|
-
};
|
|
1536
2118
|
/**
|
|
1537
2119
|
* Item wishlists management endpoints
|
|
1538
2120
|
* @description Methods for managing user wishlists and wishlist items
|
|
1539
2121
|
*/
|
|
1540
2122
|
itemWishlist: {
|
|
1541
2123
|
/**
|
|
1542
|
-
*
|
|
1543
|
-
* @description Retrieve
|
|
1544
|
-
* @fullPath api.items.itemWishlist.
|
|
2124
|
+
* Get user's wishlists
|
|
2125
|
+
* @description Retrieve wishlists for a specific user (OpenAPI: /item-wishlist/{usersId})
|
|
2126
|
+
* @fullPath api.items.itemWishlist.get
|
|
1545
2127
|
* @service items
|
|
1546
2128
|
* @domain user-preferences
|
|
1547
|
-
* @dataMethod itemWishlistData.
|
|
2129
|
+
* @dataMethod itemWishlistData.get
|
|
1548
2130
|
* @discoverable true
|
|
1549
|
-
* @searchTerms ["wishlists", "user wishlists", "shopping lists", "
|
|
1550
|
-
* @relatedEndpoints ["api.items.itemFavorites.list", "api.
|
|
1551
|
-
* @commonPatterns ["
|
|
2131
|
+
* @searchTerms ["wishlists", "user wishlists", "shopping lists", "user lists"]
|
|
2132
|
+
* @relatedEndpoints ["api.items.itemFavorites.list", "api.items.itemWishlist.hdr.get"]
|
|
2133
|
+
* @commonPatterns ["Get user wishlists", "Wishlist management by user"]
|
|
1552
2134
|
* @workflow ["user-preferences", "wishlist-management"]
|
|
1553
2135
|
* @prerequisites ["Valid authentication token", "User context"]
|
|
1554
|
-
* @nextSteps ["api.items.itemWishlist.
|
|
1555
|
-
* @businessRules ["Shows
|
|
2136
|
+
* @nextSteps ["api.items.itemWishlist.hdr.get for specific wishlist", "api.items.itemWishlist.hdr.line.get for line items"]
|
|
2137
|
+
* @businessRules ["Shows wishlists for specified user", "Includes accessible wishlists only"]
|
|
1556
2138
|
* @functionalArea "user-preference-management"
|
|
1557
2139
|
* @caching "Cache for 5 minutes, invalidate on wishlist changes"
|
|
1558
|
-
* @performance "
|
|
1559
|
-
* @param
|
|
2140
|
+
* @performance "Returns all wishlists for user"
|
|
2141
|
+
* @param usersId User unique identifier
|
|
1560
2142
|
* @returns Array of user's wishlists
|
|
1561
2143
|
* @throws ValidationError When parameters are invalid or response is malformed
|
|
1562
2144
|
* @example
|
|
1563
2145
|
* ```typescript
|
|
1564
|
-
* const wishlists = await client.itemWishlist.
|
|
2146
|
+
* const wishlists = await client.itemWishlist.get(12345);
|
|
1565
2147
|
* wishlists.data.forEach(list => {
|
|
1566
2148
|
* console.log(`Wishlist: ${list.wishlistName} (${list.wishlistDescription})`);
|
|
1567
2149
|
* });
|
|
1568
2150
|
* ```
|
|
1569
2151
|
*/
|
|
1570
|
-
|
|
2152
|
+
get: (usersId: number) => Promise<{
|
|
1571
2153
|
params: Record<string, unknown> | unknown[];
|
|
1572
2154
|
data: {
|
|
1573
2155
|
usersId: number;
|
|
@@ -1589,130 +2171,22 @@ export declare class ItemsClient extends BaseServiceClient {
|
|
|
1589
2171
|
totalResults: number;
|
|
1590
2172
|
}>;
|
|
1591
2173
|
/**
|
|
1592
|
-
*
|
|
1593
|
-
* @description
|
|
1594
|
-
* @param
|
|
1595
|
-
* @returns Wishlist details
|
|
1596
|
-
* @throws ValidationError When response is malformed
|
|
1597
|
-
* @example
|
|
1598
|
-
* ```typescript
|
|
1599
|
-
* const wishlist = await client.itemWishlist.get(123);
|
|
1600
|
-
* console.log(wishlist.data.wishlistName, wishlist.data.wishlistDescription);
|
|
1601
|
-
* ```
|
|
1602
|
-
*/
|
|
1603
|
-
get: (id: string | number, params?: import("../../core/base-client").CacheParams | undefined) => Promise<{
|
|
1604
|
-
params: Record<string, unknown> | unknown[];
|
|
1605
|
-
data: {
|
|
1606
|
-
usersId: number;
|
|
1607
|
-
itemWishlistHdrUid: number;
|
|
1608
|
-
wishlistName: string;
|
|
1609
|
-
dateCreated?: string | undefined;
|
|
1610
|
-
dateLastModified?: string | undefined;
|
|
1611
|
-
createdBy?: string | undefined;
|
|
1612
|
-
lastMaintainedBy?: string | undefined;
|
|
1613
|
-
wishlistDescription?: string | undefined;
|
|
1614
|
-
isPublic?: string | undefined;
|
|
1615
|
-
shareCode?: string | undefined;
|
|
1616
|
-
};
|
|
1617
|
-
options: Record<string, unknown> | unknown[];
|
|
1618
|
-
status: number;
|
|
1619
|
-
message: string;
|
|
1620
|
-
count: number;
|
|
1621
|
-
total: number;
|
|
1622
|
-
totalResults: number;
|
|
1623
|
-
}>;
|
|
1624
|
-
/**
|
|
1625
|
-
* Create new wishlist
|
|
1626
|
-
* @description Create a new wishlist for the current user
|
|
2174
|
+
* Create new wishlist for user
|
|
2175
|
+
* @description Create a new wishlist for a specific user (OpenAPI: /item-wishlist/{usersId})
|
|
2176
|
+
* @param usersId User unique identifier
|
|
1627
2177
|
* @param request Wishlist creation data
|
|
1628
2178
|
* @returns Created wishlist information
|
|
1629
2179
|
* @throws ValidationError When request is invalid or response is malformed
|
|
1630
2180
|
* @example
|
|
1631
2181
|
* ```typescript
|
|
1632
|
-
* const wishlist = await client.itemWishlist.create({
|
|
2182
|
+
* const wishlist = await client.itemWishlist.create(12345, {
|
|
1633
2183
|
* wishlistName: 'Home Office Setup',
|
|
1634
2184
|
* wishlistDescription: 'Items for my home office renovation',
|
|
1635
2185
|
* isPublic: 'N'
|
|
1636
2186
|
* });
|
|
1637
2187
|
* ```
|
|
1638
2188
|
*/
|
|
1639
|
-
create: (
|
|
1640
|
-
wishlistName: string;
|
|
1641
|
-
wishlistDescription?: string | undefined;
|
|
1642
|
-
isPublic?: string | undefined;
|
|
1643
|
-
}) => Promise<{
|
|
1644
|
-
params: Record<string, unknown> | unknown[];
|
|
1645
|
-
data: {
|
|
1646
|
-
usersId: number;
|
|
1647
|
-
itemWishlistHdrUid: number;
|
|
1648
|
-
wishlistName: string;
|
|
1649
|
-
dateCreated?: string | undefined;
|
|
1650
|
-
dateLastModified?: string | undefined;
|
|
1651
|
-
createdBy?: string | undefined;
|
|
1652
|
-
lastMaintainedBy?: string | undefined;
|
|
1653
|
-
wishlistDescription?: string | undefined;
|
|
1654
|
-
isPublic?: string | undefined;
|
|
1655
|
-
shareCode?: string | undefined;
|
|
1656
|
-
};
|
|
1657
|
-
options: Record<string, unknown> | unknown[];
|
|
1658
|
-
status: number;
|
|
1659
|
-
message: string;
|
|
1660
|
-
count: number;
|
|
1661
|
-
total: number;
|
|
1662
|
-
totalResults: number;
|
|
1663
|
-
}>;
|
|
1664
|
-
/**
|
|
1665
|
-
* Update wishlist
|
|
1666
|
-
* @description Update a wishlist's information
|
|
1667
|
-
* @param wishlistUid Wishlist unique identifier
|
|
1668
|
-
* @param request Update data
|
|
1669
|
-
* @returns Updated wishlist information
|
|
1670
|
-
* @throws ValidationError When request is invalid or response is malformed
|
|
1671
|
-
* @example
|
|
1672
|
-
* ```typescript
|
|
1673
|
-
* const updated = await client.itemWishlist.update(123, {
|
|
1674
|
-
* wishlistName: 'Updated Office Setup',
|
|
1675
|
-
* wishlistDescription: 'Updated description for my office items'
|
|
1676
|
-
* });
|
|
1677
|
-
* ```
|
|
1678
|
-
*/
|
|
1679
|
-
update: (id: string | number, data: {
|
|
1680
|
-
wishlistName?: string | undefined;
|
|
1681
|
-
wishlistDescription?: string | undefined;
|
|
1682
|
-
isPublic?: string | undefined;
|
|
1683
|
-
}) => Promise<{
|
|
1684
|
-
params: Record<string, unknown> | unknown[];
|
|
1685
|
-
data: {
|
|
1686
|
-
usersId: number;
|
|
1687
|
-
itemWishlistHdrUid: number;
|
|
1688
|
-
wishlistName: string;
|
|
1689
|
-
dateCreated?: string | undefined;
|
|
1690
|
-
dateLastModified?: string | undefined;
|
|
1691
|
-
createdBy?: string | undefined;
|
|
1692
|
-
lastMaintainedBy?: string | undefined;
|
|
1693
|
-
wishlistDescription?: string | undefined;
|
|
1694
|
-
isPublic?: string | undefined;
|
|
1695
|
-
shareCode?: string | undefined;
|
|
1696
|
-
};
|
|
1697
|
-
options: Record<string, unknown> | unknown[];
|
|
1698
|
-
status: number;
|
|
1699
|
-
message: string;
|
|
1700
|
-
count: number;
|
|
1701
|
-
total: number;
|
|
1702
|
-
totalResults: number;
|
|
1703
|
-
}>;
|
|
1704
|
-
/**
|
|
1705
|
-
* Delete wishlist
|
|
1706
|
-
* @description Delete a wishlist and all its items
|
|
1707
|
-
* @param wishlistUid Wishlist unique identifier
|
|
1708
|
-
* @returns Success response
|
|
1709
|
-
* @throws ValidationError When response is malformed
|
|
1710
|
-
* @example
|
|
1711
|
-
* ```typescript
|
|
1712
|
-
* await client.itemWishlist.delete(123);
|
|
1713
|
-
* ```
|
|
1714
|
-
*/
|
|
1715
|
-
delete: (id: string | number) => Promise<{
|
|
2189
|
+
create: (usersId: number, request: CreateItemWishlistHeaderRequest) => Promise<{
|
|
1716
2190
|
params: Record<string, unknown> | unknown[];
|
|
1717
2191
|
data: {
|
|
1718
2192
|
usersId: number;
|
|
@@ -1734,360 +2208,69 @@ export declare class ItemsClient extends BaseServiceClient {
|
|
|
1734
2208
|
totalResults: number;
|
|
1735
2209
|
}>;
|
|
1736
2210
|
/**
|
|
1737
|
-
*
|
|
1738
|
-
* @description
|
|
1739
|
-
* @param wishlistUid Wishlist unique identifier
|
|
1740
|
-
* @param params Optional filtering and pagination parameters
|
|
1741
|
-
* @returns Array of wishlist items
|
|
1742
|
-
* @throws ValidationError When parameters are invalid or response is malformed
|
|
1743
|
-
* @example
|
|
1744
|
-
* ```typescript
|
|
1745
|
-
* const items = await client.itemWishlist.getLines(123, { limit: 20 });
|
|
1746
|
-
* items.data.forEach(item => {
|
|
1747
|
-
* console.log(`${item.itemDesc} - Qty: ${item.qtyDesired}, Priority: ${item.priority}`);
|
|
1748
|
-
* });
|
|
1749
|
-
* ```
|
|
2211
|
+
* Wishlist header management endpoints
|
|
2212
|
+
* @description Methods for managing specific wishlist headers (OpenAPI: /item-wishlist/{usersId}/hdr/{itemWishlistHdrUid})
|
|
1750
2213
|
*/
|
|
1751
|
-
|
|
1752
|
-
|
|
1753
|
-
|
|
1754
|
-
|
|
1755
|
-
|
|
1756
|
-
|
|
1757
|
-
|
|
1758
|
-
|
|
1759
|
-
|
|
1760
|
-
|
|
1761
|
-
|
|
1762
|
-
|
|
1763
|
-
|
|
1764
|
-
|
|
1765
|
-
|
|
1766
|
-
|
|
1767
|
-
|
|
1768
|
-
|
|
1769
|
-
message: string;
|
|
1770
|
-
count: number;
|
|
1771
|
-
total: number;
|
|
1772
|
-
totalResults: number;
|
|
1773
|
-
}>;
|
|
1774
|
-
/**
|
|
1775
|
-
* Add item to wishlist
|
|
1776
|
-
* @description Add an item to a specific wishlist
|
|
1777
|
-
* @param wishlistUid Wishlist unique identifier
|
|
1778
|
-
* @param request Wishlist item creation data
|
|
1779
|
-
* @returns Created wishlist item information
|
|
1780
|
-
* @throws ValidationError When request is invalid or response is malformed
|
|
1781
|
-
* @example
|
|
1782
|
-
* ```typescript
|
|
1783
|
-
* const item = await client.itemWishlist.addLine(123, {
|
|
1784
|
-
* invMastUid: 12345,
|
|
1785
|
-
* qtyDesired: 2,
|
|
1786
|
-
* priority: 1,
|
|
1787
|
-
* notes: 'Need this for the new office setup'
|
|
1788
|
-
* });
|
|
1789
|
-
* ```
|
|
1790
|
-
*/
|
|
1791
|
-
addLine: (wishlistUid: number, request: CreateItemWishlistLineRequest) => Promise<{
|
|
1792
|
-
params: Record<string, unknown> | unknown[];
|
|
1793
|
-
data: {
|
|
1794
|
-
invMastUid: number;
|
|
1795
|
-
itemId: string;
|
|
1796
|
-
itemWishlistHdrUid: number;
|
|
1797
|
-
itemWishlistLineUid: number;
|
|
1798
|
-
dateCreated?: string | undefined;
|
|
1799
|
-
dateLastModified?: string | undefined;
|
|
1800
|
-
notes?: string | undefined;
|
|
1801
|
-
itemDesc?: string | undefined;
|
|
1802
|
-
createdBy?: string | undefined;
|
|
1803
|
-
lastMaintainedBy?: string | undefined;
|
|
1804
|
-
qtyDesired?: number | undefined;
|
|
1805
|
-
priority?: number | undefined;
|
|
1806
|
-
};
|
|
1807
|
-
options: Record<string, unknown> | unknown[];
|
|
1808
|
-
status: number;
|
|
1809
|
-
message: string;
|
|
1810
|
-
count: number;
|
|
1811
|
-
total: number;
|
|
1812
|
-
totalResults: number;
|
|
1813
|
-
}>;
|
|
1814
|
-
/**
|
|
1815
|
-
* Update wishlist item
|
|
1816
|
-
* @description Update an item in a wishlist
|
|
1817
|
-
* @param wishlistUid Wishlist unique identifier
|
|
1818
|
-
* @param lineUid Wishlist line unique identifier
|
|
1819
|
-
* @param request Update data
|
|
1820
|
-
* @returns Updated wishlist item information
|
|
1821
|
-
* @throws ValidationError When request is invalid or response is malformed
|
|
1822
|
-
* @example
|
|
1823
|
-
* ```typescript
|
|
1824
|
-
* const updated = await client.itemWishlist.updateLine(123, 456, {
|
|
1825
|
-
* qtyDesired: 3,
|
|
1826
|
-
* priority: 2,
|
|
1827
|
-
* notes: 'Updated quantity needed'
|
|
1828
|
-
* });
|
|
1829
|
-
* ```
|
|
1830
|
-
*/
|
|
1831
|
-
updateLine: (wishlistUid: number, lineUid: number, request: UpdateItemWishlistLineRequest) => Promise<{
|
|
1832
|
-
params: Record<string, unknown> | unknown[];
|
|
1833
|
-
data: {
|
|
1834
|
-
invMastUid: number;
|
|
1835
|
-
itemId: string;
|
|
1836
|
-
itemWishlistHdrUid: number;
|
|
1837
|
-
itemWishlistLineUid: number;
|
|
1838
|
-
dateCreated?: string | undefined;
|
|
1839
|
-
dateLastModified?: string | undefined;
|
|
1840
|
-
notes?: string | undefined;
|
|
1841
|
-
itemDesc?: string | undefined;
|
|
1842
|
-
createdBy?: string | undefined;
|
|
1843
|
-
lastMaintainedBy?: string | undefined;
|
|
1844
|
-
qtyDesired?: number | undefined;
|
|
1845
|
-
priority?: number | undefined;
|
|
1846
|
-
};
|
|
1847
|
-
options: Record<string, unknown> | unknown[];
|
|
1848
|
-
status: number;
|
|
1849
|
-
message: string;
|
|
1850
|
-
count: number;
|
|
1851
|
-
total: number;
|
|
1852
|
-
totalResults: number;
|
|
1853
|
-
}>;
|
|
1854
|
-
/**
|
|
1855
|
-
* Remove item from wishlist
|
|
1856
|
-
* @description Remove an item from a wishlist
|
|
1857
|
-
* @param wishlistUid Wishlist unique identifier
|
|
1858
|
-
* @param lineUid Wishlist line unique identifier
|
|
1859
|
-
* @returns Success response
|
|
1860
|
-
* @throws ValidationError When response is malformed
|
|
1861
|
-
* @example
|
|
1862
|
-
* ```typescript
|
|
1863
|
-
* await client.itemWishlist.deleteLine(123, 456);
|
|
1864
|
-
* ```
|
|
1865
|
-
*/
|
|
1866
|
-
deleteLine: (wishlistUid: number, lineUid: number) => Promise<{
|
|
1867
|
-
params: Record<string, unknown> | unknown[];
|
|
1868
|
-
data: {
|
|
1869
|
-
invMastUid: number;
|
|
1870
|
-
itemId: string;
|
|
1871
|
-
itemWishlistHdrUid: number;
|
|
1872
|
-
itemWishlistLineUid: number;
|
|
1873
|
-
dateCreated?: string | undefined;
|
|
1874
|
-
dateLastModified?: string | undefined;
|
|
1875
|
-
notes?: string | undefined;
|
|
1876
|
-
itemDesc?: string | undefined;
|
|
1877
|
-
createdBy?: string | undefined;
|
|
1878
|
-
lastMaintainedBy?: string | undefined;
|
|
1879
|
-
qtyDesired?: number | undefined;
|
|
1880
|
-
priority?: number | undefined;
|
|
1881
|
-
};
|
|
1882
|
-
options: Record<string, unknown> | unknown[];
|
|
1883
|
-
status: number;
|
|
1884
|
-
message: string;
|
|
1885
|
-
count: number;
|
|
1886
|
-
total: number;
|
|
1887
|
-
totalResults: number;
|
|
1888
|
-
}>;
|
|
1889
|
-
};
|
|
1890
|
-
/**
|
|
1891
|
-
* Item wishlists data-only endpoints
|
|
1892
|
-
* @description Data-only methods that return just the data portion of wishlists responses
|
|
1893
|
-
*/
|
|
1894
|
-
itemWishlistData: {
|
|
1895
|
-
/**
|
|
1896
|
-
* List user's wishlists data only
|
|
1897
|
-
* @description Returns only the data portion of wishlists list response
|
|
1898
|
-
* @param params Optional filtering and pagination parameters
|
|
1899
|
-
* @returns Array of wishlists data
|
|
1900
|
-
*/
|
|
1901
|
-
list: (params?: ItemWishlistListParams) => Promise<{
|
|
1902
|
-
usersId: number;
|
|
1903
|
-
itemWishlistHdrUid: number;
|
|
1904
|
-
wishlistName: string;
|
|
1905
|
-
dateCreated?: string | undefined;
|
|
1906
|
-
dateLastModified?: string | undefined;
|
|
1907
|
-
createdBy?: string | undefined;
|
|
1908
|
-
lastMaintainedBy?: string | undefined;
|
|
1909
|
-
wishlistDescription?: string | undefined;
|
|
1910
|
-
isPublic?: string | undefined;
|
|
1911
|
-
shareCode?: string | undefined;
|
|
1912
|
-
}[]>;
|
|
1913
|
-
/**
|
|
1914
|
-
* Get wishlist items data only
|
|
1915
|
-
* @description Returns only the data portion of wishlist items response
|
|
1916
|
-
* @param wishlistUid Wishlist unique identifier
|
|
1917
|
-
* @param params Optional filtering and pagination parameters
|
|
1918
|
-
* @returns Array of wishlist items data
|
|
1919
|
-
*/
|
|
1920
|
-
getLines: (wishlistUid: number, params?: ItemWishlistLineListParams) => Promise<{
|
|
1921
|
-
invMastUid: number;
|
|
1922
|
-
itemId: string;
|
|
1923
|
-
itemWishlistHdrUid: number;
|
|
1924
|
-
itemWishlistLineUid: number;
|
|
1925
|
-
dateCreated?: string | undefined;
|
|
1926
|
-
dateLastModified?: string | undefined;
|
|
1927
|
-
notes?: string | undefined;
|
|
1928
|
-
itemDesc?: string | undefined;
|
|
1929
|
-
createdBy?: string | undefined;
|
|
1930
|
-
lastMaintainedBy?: string | undefined;
|
|
1931
|
-
qtyDesired?: number | undefined;
|
|
1932
|
-
priority?: number | undefined;
|
|
1933
|
-
}[]>;
|
|
1934
|
-
};
|
|
1935
|
-
/**
|
|
1936
|
-
* Item category management endpoints
|
|
1937
|
-
* @description Methods for managing item categories following OpenAPI path mirroring pattern
|
|
1938
|
-
*/
|
|
1939
|
-
itemCategory: {
|
|
1940
|
-
/**
|
|
1941
|
-
* List item categories
|
|
1942
|
-
* @description Retrieve a list of item categories
|
|
1943
|
-
* @fullPath api.items.itemCategory.list
|
|
1944
|
-
* @service items
|
|
1945
|
-
* @domain product-catalog
|
|
1946
|
-
* @dataMethod itemCategoryData.list
|
|
1947
|
-
* @discoverable true
|
|
1948
|
-
* @searchTerms ["categories", "item categories", "product categories", "category management"]
|
|
1949
|
-
* @relatedEndpoints ["api.items.invMast.list", "api.items.attributes.list"]
|
|
1950
|
-
* @commonPatterns ["Show categories", "Manage category structure", "Category navigation"]
|
|
1951
|
-
* @workflow ["product-catalog-management", "category-management"]
|
|
1952
|
-
* @prerequisites ["Valid authentication token", "Catalog permissions"]
|
|
1953
|
-
* @nextSteps ["api.items.itemCategory.get for category details", "api.items.invMast.list for category products"]
|
|
1954
|
-
* @businessRules ["Shows active categories only", "Respects category hierarchy", "Returns visible categories"]
|
|
1955
|
-
* @functionalArea "product-catalog-management"
|
|
1956
|
-
* @caching "Cache for 30 minutes, invalidate on category changes"
|
|
1957
|
-
* @performance "Paginated results for large category trees"
|
|
1958
|
-
* @param params Optional filtering and pagination parameters
|
|
1959
|
-
* @returns Array of item categories
|
|
1960
|
-
* @throws ValidationError When parameters are invalid or response is malformed
|
|
1961
|
-
* @example
|
|
1962
|
-
* ```typescript
|
|
1963
|
-
* const categories = await client.itemCategory.list({ parentUid: 100 });
|
|
1964
|
-
* categories.data.forEach(cat => {
|
|
1965
|
-
* console.log(`Category: ${cat.itemCategoryDesc} (${cat.path})`);
|
|
1966
|
-
* });
|
|
1967
|
-
* ```
|
|
1968
|
-
*/
|
|
1969
|
-
list: (params?: CategoryListParams) => Promise<{
|
|
1970
|
-
params: Record<string, unknown> | unknown[];
|
|
1971
|
-
data: {
|
|
1972
|
-
dateCreated: string;
|
|
1973
|
-
dateLastModified: string;
|
|
1974
|
-
statusCd: number;
|
|
1975
|
-
updateCd: number;
|
|
1976
|
-
processCd: number;
|
|
1977
|
-
displayOnWebFlag: "Y" | "N";
|
|
1978
|
-
deleteFlag: "Y" | "N";
|
|
1979
|
-
createdBy: string;
|
|
1980
|
-
lastMaintainedBy: string;
|
|
1981
|
-
itemCategoryUid: number;
|
|
1982
|
-
itemCategoryId: string;
|
|
1983
|
-
itemCategoryDesc: string;
|
|
1984
|
-
masterCategoryFlag: string;
|
|
1985
|
-
parentCategoryFlag: string;
|
|
1986
|
-
displayMasterProductFlag: string;
|
|
1987
|
-
itemCount: number;
|
|
1988
|
-
catalogPage?: string | null | undefined;
|
|
1989
|
-
subCategoryImageFile?: string | null | undefined;
|
|
1990
|
-
}[];
|
|
1991
|
-
options: Record<string, unknown> | unknown[];
|
|
1992
|
-
status: number;
|
|
1993
|
-
message: string;
|
|
1994
|
-
count: number;
|
|
1995
|
-
total: number;
|
|
1996
|
-
totalResults: number;
|
|
1997
|
-
}>;
|
|
1998
|
-
/**
|
|
1999
|
-
* Get item category details
|
|
2000
|
-
* @description Retrieve detailed information about a specific item category
|
|
2001
|
-
* @fullPath api.items.itemCategory.get
|
|
2002
|
-
* @service items
|
|
2003
|
-
* @domain product-catalog
|
|
2004
|
-
* @dataMethod itemCategoryData.get
|
|
2005
|
-
* @discoverable true
|
|
2006
|
-
* @searchTerms ["category details", "category info", "category data"]
|
|
2007
|
-
* @relatedEndpoints ["api.items.itemCategory.list", "api.items.invMast.list"]
|
|
2008
|
-
* @commonPatterns ["Show category details", "Category information lookup"]
|
|
2009
|
-
* @param itemCategoryUid Category unique identifier
|
|
2010
|
-
* @param params Optional query parameters
|
|
2011
|
-
* @returns Category details
|
|
2012
|
-
* @throws ValidationError When response is malformed
|
|
2013
|
-
* @example
|
|
2014
|
-
* ```typescript
|
|
2015
|
-
* const category = await client.itemCategory.get(123);
|
|
2016
|
-
* console.log(category.data.itemCategoryDesc, category.data.path);
|
|
2017
|
-
* ```
|
|
2018
|
-
*/
|
|
2019
|
-
get: (id: string | number, params?: import("../../core/base-client").CacheParams | undefined) => Promise<{
|
|
2020
|
-
params: Record<string, unknown> | unknown[];
|
|
2021
|
-
data: {
|
|
2022
|
-
itemCategoryUid: number;
|
|
2023
|
-
itemCategoryDesc: string;
|
|
2024
|
-
path?: string;
|
|
2025
|
-
parentItemCategoryUid?: number;
|
|
2026
|
-
level?: number;
|
|
2027
|
-
children?: Array<{
|
|
2028
|
-
itemCategoryUid: number;
|
|
2029
|
-
itemCategoryDesc: string;
|
|
2030
|
-
path?: string;
|
|
2031
|
-
parentItemCategoryUid?: number;
|
|
2032
|
-
level?: number;
|
|
2033
|
-
children?: unknown;
|
|
2034
|
-
attributes?: unknown[];
|
|
2035
|
-
images?: unknown[];
|
|
2036
|
-
itemCount?: number;
|
|
2037
|
-
}>;
|
|
2038
|
-
attributes?: unknown[];
|
|
2039
|
-
images?: unknown[];
|
|
2040
|
-
itemCount?: number;
|
|
2041
|
-
};
|
|
2042
|
-
options: Record<string, unknown> | unknown[];
|
|
2043
|
-
status: number;
|
|
2044
|
-
message: string;
|
|
2045
|
-
count: number;
|
|
2046
|
-
total: number;
|
|
2047
|
-
totalResults: number;
|
|
2048
|
-
}>;
|
|
2049
|
-
/**
|
|
2050
|
-
* Get category documentation
|
|
2051
|
-
* @description Retrieve documentation for a specific item category
|
|
2052
|
-
* @fullPath api.items.itemCategory.doc.get
|
|
2053
|
-
* @service items
|
|
2054
|
-
* @domain product-catalog
|
|
2055
|
-
* @discoverable true
|
|
2056
|
-
* @searchTerms ["category documentation", "category docs", "category help"]
|
|
2057
|
-
* @relatedEndpoints ["api.items.itemCategory.get", "api.items.itemCategory.list"]
|
|
2058
|
-
* @commonPatterns ["Show category documentation", "Category help content"]
|
|
2059
|
-
* @param itemCategoryUid Category unique identifier
|
|
2060
|
-
* @returns Category documentation
|
|
2061
|
-
* @throws ValidationError When response is malformed
|
|
2062
|
-
* @example
|
|
2063
|
-
* ```typescript
|
|
2064
|
-
* const docs = await client.itemCategory.doc.get(123);
|
|
2065
|
-
* console.log(docs.data.documentationContent);
|
|
2066
|
-
* ```
|
|
2067
|
-
*/
|
|
2068
|
-
doc: {
|
|
2069
|
-
get: (itemCategoryUid: number) => Promise<{
|
|
2214
|
+
hdr: {
|
|
2215
|
+
/**
|
|
2216
|
+
* Get wishlist header details
|
|
2217
|
+
* @description Retrieve details for a specific wishlist header
|
|
2218
|
+
* @fullPath api.items.itemWishlist.hdr.get
|
|
2219
|
+
* @service items
|
|
2220
|
+
* @domain user-preferences
|
|
2221
|
+
* @param usersId User unique identifier
|
|
2222
|
+
* @param itemWishlistHdrUid Wishlist header unique identifier
|
|
2223
|
+
* @returns Wishlist header details
|
|
2224
|
+
* @throws ValidationError When response is malformed
|
|
2225
|
+
* @example
|
|
2226
|
+
* ```typescript
|
|
2227
|
+
* const wishlist = await client.itemWishlist.hdr.get(12345, 678);
|
|
2228
|
+
* console.log(wishlist.data.wishlistName);
|
|
2229
|
+
* ```
|
|
2230
|
+
*/
|
|
2231
|
+
get: (usersId: number, itemWishlistHdrUid: number) => Promise<{
|
|
2070
2232
|
params: Record<string, unknown> | unknown[];
|
|
2071
2233
|
data: {
|
|
2072
|
-
|
|
2073
|
-
|
|
2074
|
-
|
|
2075
|
-
|
|
2076
|
-
|
|
2077
|
-
|
|
2078
|
-
|
|
2079
|
-
|
|
2080
|
-
|
|
2081
|
-
|
|
2082
|
-
|
|
2083
|
-
|
|
2084
|
-
|
|
2085
|
-
|
|
2086
|
-
|
|
2087
|
-
|
|
2088
|
-
|
|
2089
|
-
|
|
2090
|
-
|
|
2234
|
+
usersId: number;
|
|
2235
|
+
itemWishlistHdrUid: number;
|
|
2236
|
+
wishlistName: string;
|
|
2237
|
+
dateCreated?: string | undefined;
|
|
2238
|
+
dateLastModified?: string | undefined;
|
|
2239
|
+
createdBy?: string | undefined;
|
|
2240
|
+
lastMaintainedBy?: string | undefined;
|
|
2241
|
+
wishlistDescription?: string | undefined;
|
|
2242
|
+
isPublic?: string | undefined;
|
|
2243
|
+
shareCode?: string | undefined;
|
|
2244
|
+
};
|
|
2245
|
+
options: Record<string, unknown> | unknown[];
|
|
2246
|
+
status: number;
|
|
2247
|
+
message: string;
|
|
2248
|
+
count: number;
|
|
2249
|
+
total: number;
|
|
2250
|
+
totalResults: number;
|
|
2251
|
+
}>;
|
|
2252
|
+
/**
|
|
2253
|
+
* Create wishlist header
|
|
2254
|
+
* @description Create a new wishlist header
|
|
2255
|
+
* @param usersId User unique identifier
|
|
2256
|
+
* @param itemWishlistHdrUid Wishlist header unique identifier
|
|
2257
|
+
* @param request Wishlist header creation data
|
|
2258
|
+
* @returns Created wishlist header information
|
|
2259
|
+
* @throws ValidationError When request is invalid or response is malformed
|
|
2260
|
+
*/
|
|
2261
|
+
create: (usersId: number, itemWishlistHdrUid: number, request: CreateItemWishlistHeaderRequest) => Promise<{
|
|
2262
|
+
params: Record<string, unknown> | unknown[];
|
|
2263
|
+
data: {
|
|
2264
|
+
usersId: number;
|
|
2265
|
+
itemWishlistHdrUid: number;
|
|
2266
|
+
wishlistName: string;
|
|
2267
|
+
dateCreated?: string | undefined;
|
|
2268
|
+
dateLastModified?: string | undefined;
|
|
2269
|
+
createdBy?: string | undefined;
|
|
2270
|
+
lastMaintainedBy?: string | undefined;
|
|
2271
|
+
wishlistDescription?: string | undefined;
|
|
2272
|
+
isPublic?: string | undefined;
|
|
2273
|
+
shareCode?: string | undefined;
|
|
2091
2274
|
};
|
|
2092
2275
|
options: Record<string, unknown> | unknown[];
|
|
2093
2276
|
status: number;
|
|
@@ -2096,116 +2279,115 @@ export declare class ItemsClient extends BaseServiceClient {
|
|
|
2096
2279
|
total: number;
|
|
2097
2280
|
totalResults: number;
|
|
2098
2281
|
}>;
|
|
2282
|
+
/**
|
|
2283
|
+
* Wishlist line management endpoints
|
|
2284
|
+
* @description Methods for managing specific wishlist line items
|
|
2285
|
+
*/
|
|
2286
|
+
line: {
|
|
2287
|
+
/**
|
|
2288
|
+
* Get wishlist line details
|
|
2289
|
+
* @description Retrieve details for a specific wishlist line item
|
|
2290
|
+
* @fullPath api.items.itemWishlist.hdr.line.get
|
|
2291
|
+
* @service items
|
|
2292
|
+
* @domain user-preferences
|
|
2293
|
+
* @param usersId User unique identifier
|
|
2294
|
+
* @param itemWishlistHdrUid Wishlist header unique identifier
|
|
2295
|
+
* @param itemWishlistLineUid Wishlist line unique identifier
|
|
2296
|
+
* @returns Wishlist line details
|
|
2297
|
+
* @throws ValidationError When response is malformed
|
|
2298
|
+
* @example
|
|
2299
|
+
* ```typescript
|
|
2300
|
+
* const line = await client.itemWishlist.hdr.line.get(12345, 678, 901);
|
|
2301
|
+
* console.log(`Item: ${line.data.itemDesc}, Qty: ${line.data.qtyDesired}`);
|
|
2302
|
+
* ```
|
|
2303
|
+
*/
|
|
2304
|
+
get: (usersId: number, itemWishlistHdrUid: number, itemWishlistLineUid: number) => Promise<{
|
|
2305
|
+
params: Record<string, unknown> | unknown[];
|
|
2306
|
+
data: {
|
|
2307
|
+
invMastUid: number;
|
|
2308
|
+
itemId: string;
|
|
2309
|
+
itemWishlistHdrUid: number;
|
|
2310
|
+
itemWishlistLineUid: number;
|
|
2311
|
+
dateCreated?: string | undefined;
|
|
2312
|
+
dateLastModified?: string | undefined;
|
|
2313
|
+
notes?: string | undefined;
|
|
2314
|
+
itemDesc?: string | undefined;
|
|
2315
|
+
createdBy?: string | undefined;
|
|
2316
|
+
lastMaintainedBy?: string | undefined;
|
|
2317
|
+
qtyDesired?: number | undefined;
|
|
2318
|
+
priority?: number | undefined;
|
|
2319
|
+
};
|
|
2320
|
+
options: Record<string, unknown> | unknown[];
|
|
2321
|
+
status: number;
|
|
2322
|
+
message: string;
|
|
2323
|
+
count: number;
|
|
2324
|
+
total: number;
|
|
2325
|
+
totalResults: number;
|
|
2326
|
+
}>;
|
|
2327
|
+
/**
|
|
2328
|
+
* Delete wishlist line item
|
|
2329
|
+
* @description Remove a specific item from a wishlist
|
|
2330
|
+
* @fullPath api.items.itemWishlist.hdr.line.delete
|
|
2331
|
+
* @service items
|
|
2332
|
+
* @domain user-preferences
|
|
2333
|
+
* @dataMethod itemWishlistData.hdr.line.delete
|
|
2334
|
+
* @discoverable true
|
|
2335
|
+
* @searchTerms ["delete wishlist item", "remove wishlist item", "wishlist line deletion"]
|
|
2336
|
+
* @relatedEndpoints ["api.items.itemWishlist.hdr.line.get", "api.items.itemWishlist.hdr.get"]
|
|
2337
|
+
* @commonPatterns ["Remove item from wishlist", "Clean up wishlist"]
|
|
2338
|
+
* @workflow ["user-preferences", "wishlist-maintenance"]
|
|
2339
|
+
* @prerequisites ["Valid authentication token", "User context", "Line item must exist"]
|
|
2340
|
+
* @nextSteps ["Verify deletion", "Update wishlist display"]
|
|
2341
|
+
* @businessRules ["Removes specific line item only", "Does not affect other wishlist items"]
|
|
2342
|
+
* @functionalArea "user-preference-management"
|
|
2343
|
+
* @caching "Invalidates wishlist cache"
|
|
2344
|
+
* @performance "Direct deletion operation"
|
|
2345
|
+
* @param usersId User unique identifier
|
|
2346
|
+
* @param itemWishlistHdrUid Wishlist header unique identifier
|
|
2347
|
+
* @param itemWishlistLineUid Wishlist line unique identifier
|
|
2348
|
+
* @returns Success status
|
|
2349
|
+
* @throws ValidationError When response is malformed
|
|
2350
|
+
* @example
|
|
2351
|
+
* ```typescript
|
|
2352
|
+
* await client.itemWishlist.hdr.line.delete(12345, 678, 901);
|
|
2353
|
+
* ```
|
|
2354
|
+
*/
|
|
2355
|
+
delete: (usersId: number, itemWishlistHdrUid: number, itemWishlistLineUid: number) => Promise<{
|
|
2356
|
+
status: number;
|
|
2357
|
+
message: string;
|
|
2358
|
+
count: number;
|
|
2359
|
+
total: number;
|
|
2360
|
+
totalResults: number;
|
|
2361
|
+
params?: any;
|
|
2362
|
+
data?: any;
|
|
2363
|
+
options?: any;
|
|
2364
|
+
}>;
|
|
2365
|
+
};
|
|
2099
2366
|
};
|
|
2100
|
-
/**
|
|
2101
|
-
* Category lookup
|
|
2102
|
-
* @description Lookup categories by various criteria
|
|
2103
|
-
* @fullPath api.items.itemCategory.lookup
|
|
2104
|
-
* @service items
|
|
2105
|
-
* @domain product-catalog
|
|
2106
|
-
* @discoverable true
|
|
2107
|
-
* @searchTerms ["category lookup", "find categories", "category search"]
|
|
2108
|
-
* @relatedEndpoints ["api.items.itemCategory.list", "api.items.itemCategory.get"]
|
|
2109
|
-
* @commonPatterns ["Find categories", "Category search", "Category filtering"]
|
|
2110
|
-
* @param params Lookup criteria
|
|
2111
|
-
* @returns Matching categories
|
|
2112
|
-
* @throws ValidationError When parameters are invalid or response is malformed
|
|
2113
|
-
* @example
|
|
2114
|
-
* ```typescript
|
|
2115
|
-
* const categories = await client.itemCategory.lookup({
|
|
2116
|
-
* categoryPath: '/Electronics/Components'
|
|
2117
|
-
* });
|
|
2118
|
-
* ```
|
|
2119
|
-
*/
|
|
2120
|
-
lookup: (params?: CategoryLookupParams) => Promise<{
|
|
2121
|
-
params: Record<string, unknown> | unknown[];
|
|
2122
|
-
data: {
|
|
2123
|
-
dateCreated: string;
|
|
2124
|
-
dateLastModified: string;
|
|
2125
|
-
statusCd: number;
|
|
2126
|
-
updateCd: number;
|
|
2127
|
-
processCd: number;
|
|
2128
|
-
displayOnWebFlag: "Y" | "N";
|
|
2129
|
-
deleteFlag: "Y" | "N";
|
|
2130
|
-
createdBy: string;
|
|
2131
|
-
lastMaintainedBy: string;
|
|
2132
|
-
itemCategoryUid: number;
|
|
2133
|
-
itemCategoryId: string;
|
|
2134
|
-
itemCategoryDesc: string;
|
|
2135
|
-
masterCategoryFlag: string;
|
|
2136
|
-
parentCategoryFlag: string;
|
|
2137
|
-
displayMasterProductFlag: string;
|
|
2138
|
-
itemCount: number;
|
|
2139
|
-
catalogPage?: string | null | undefined;
|
|
2140
|
-
subCategoryImageFile?: string | null | undefined;
|
|
2141
|
-
}[];
|
|
2142
|
-
options: Record<string, unknown> | unknown[];
|
|
2143
|
-
status: number;
|
|
2144
|
-
message: string;
|
|
2145
|
-
count: number;
|
|
2146
|
-
total: number;
|
|
2147
|
-
totalResults: number;
|
|
2148
|
-
}>;
|
|
2149
2367
|
};
|
|
2150
2368
|
/**
|
|
2151
|
-
* Item
|
|
2152
|
-
* @description Data-only methods that return just the data portion of
|
|
2369
|
+
* Item wishlists data-only endpoints
|
|
2370
|
+
* @description Data-only methods that return just the data portion of wishlists responses
|
|
2153
2371
|
*/
|
|
2154
|
-
|
|
2155
|
-
/**
|
|
2156
|
-
* List item categories data only
|
|
2157
|
-
* @description Returns only the data portion of categories list response
|
|
2158
|
-
* @param params Optional filtering and pagination parameters
|
|
2159
|
-
* @returns Array of category data
|
|
2160
|
-
*/
|
|
2161
|
-
list: (params?: CategoryListParams) => Promise<{
|
|
2162
|
-
dateCreated: string;
|
|
2163
|
-
dateLastModified: string;
|
|
2164
|
-
statusCd: number;
|
|
2165
|
-
updateCd: number;
|
|
2166
|
-
processCd: number;
|
|
2167
|
-
displayOnWebFlag: "Y" | "N";
|
|
2168
|
-
deleteFlag: "Y" | "N";
|
|
2169
|
-
createdBy: string;
|
|
2170
|
-
lastMaintainedBy: string;
|
|
2171
|
-
itemCategoryUid: number;
|
|
2172
|
-
itemCategoryId: string;
|
|
2173
|
-
itemCategoryDesc: string;
|
|
2174
|
-
masterCategoryFlag: string;
|
|
2175
|
-
parentCategoryFlag: string;
|
|
2176
|
-
displayMasterProductFlag: string;
|
|
2177
|
-
itemCount: number;
|
|
2178
|
-
catalogPage?: string | null | undefined;
|
|
2179
|
-
subCategoryImageFile?: string | null | undefined;
|
|
2180
|
-
}[]>;
|
|
2372
|
+
itemWishlistData: {
|
|
2181
2373
|
/**
|
|
2182
|
-
* Get
|
|
2183
|
-
* @description Returns only the data portion of
|
|
2184
|
-
* @param
|
|
2185
|
-
* @
|
|
2186
|
-
* @returns Category data
|
|
2374
|
+
* Get user's wishlists data only
|
|
2375
|
+
* @description Returns only the data portion of user wishlists response
|
|
2376
|
+
* @param usersId User unique identifier
|
|
2377
|
+
* @returns Array of wishlists data
|
|
2187
2378
|
*/
|
|
2188
|
-
get: (
|
|
2189
|
-
|
|
2190
|
-
|
|
2191
|
-
|
|
2192
|
-
|
|
2193
|
-
|
|
2194
|
-
|
|
2195
|
-
|
|
2196
|
-
|
|
2197
|
-
|
|
2198
|
-
|
|
2199
|
-
|
|
2200
|
-
children?: unknown;
|
|
2201
|
-
attributes?: unknown[];
|
|
2202
|
-
images?: unknown[];
|
|
2203
|
-
itemCount?: number;
|
|
2204
|
-
}>;
|
|
2205
|
-
attributes?: unknown[];
|
|
2206
|
-
images?: unknown[];
|
|
2207
|
-
itemCount?: number;
|
|
2208
|
-
}>;
|
|
2379
|
+
get: (usersId: number) => Promise<{
|
|
2380
|
+
usersId: number;
|
|
2381
|
+
itemWishlistHdrUid: number;
|
|
2382
|
+
wishlistName: string;
|
|
2383
|
+
dateCreated?: string | undefined;
|
|
2384
|
+
dateLastModified?: string | undefined;
|
|
2385
|
+
createdBy?: string | undefined;
|
|
2386
|
+
lastMaintainedBy?: string | undefined;
|
|
2387
|
+
wishlistDescription?: string | undefined;
|
|
2388
|
+
isPublic?: string | undefined;
|
|
2389
|
+
shareCode?: string | undefined;
|
|
2390
|
+
}[]>;
|
|
2209
2391
|
};
|
|
2210
2392
|
/**
|
|
2211
2393
|
* Product variants management endpoints
|
|
@@ -2931,248 +3113,6 @@ export declare class ItemsClient extends BaseServiceClient {
|
|
|
2931
3113
|
helpfulCount?: number | undefined;
|
|
2932
3114
|
}[]>;
|
|
2933
3115
|
};
|
|
2934
|
-
/**
|
|
2935
|
-
* Brand-item relationship management endpoints
|
|
2936
|
-
* @description Methods for managing relationships between brands and items
|
|
2937
|
-
*/
|
|
2938
|
-
brandItems: {
|
|
2939
|
-
/**
|
|
2940
|
-
* List brand-item relationships
|
|
2941
|
-
* @description Retrieve brand-item relationships for a specific brand
|
|
2942
|
-
* @fullPath api.items.brandItems.list
|
|
2943
|
-
* @service items
|
|
2944
|
-
* @domain product-catalog
|
|
2945
|
-
* @dataMethod brandItemsData.list
|
|
2946
|
-
* @discoverable true
|
|
2947
|
-
* @searchTerms ["brand items", "brand products", "brand relationships", "manufacturer items", "brand catalog"]
|
|
2948
|
-
* @relatedEndpoints ["api.items.brands.list", "api.items.products.get"]
|
|
2949
|
-
* @commonPatterns ["Show brand products", "Manage brand relationships", "Brand catalog management"]
|
|
2950
|
-
* @workflow ["product-catalog-management", "brand-management"]
|
|
2951
|
-
* @prerequisites ["Valid authentication token", "Brand management permissions"]
|
|
2952
|
-
* @nextSteps ["api.items.products.get for product details", "api.items.brands.get for brand details"]
|
|
2953
|
-
* @businessRules ["Shows active relationships only", "Respects product visibility", "Primary brand identification"]
|
|
2954
|
-
* @functionalArea "product-catalog-management"
|
|
2955
|
-
* @caching "Cache for 20 minutes, invalidate on relationship changes"
|
|
2956
|
-
* @performance "Paginated results for brands with many products"
|
|
2957
|
-
* @param brandUid Brand unique identifier
|
|
2958
|
-
* @param params Optional filtering and pagination parameters
|
|
2959
|
-
* @returns Array of brand-item relationships
|
|
2960
|
-
* @throws ValidationError When parameters are invalid or response is malformed
|
|
2961
|
-
* @example
|
|
2962
|
-
* ```typescript
|
|
2963
|
-
* const brandItems = await client.brandItems.list(123, { isPrimary: 'Y' });
|
|
2964
|
-
* brandItems.data.forEach(item => {
|
|
2965
|
-
* console.log(`${item.itemDesc} - Brand Part: ${item.brandPartNumber}`);
|
|
2966
|
-
* });
|
|
2967
|
-
* ```
|
|
2968
|
-
*/
|
|
2969
|
-
list: (brandUid: number, params?: BrandItemListParams) => Promise<{
|
|
2970
|
-
params: Record<string, unknown> | unknown[];
|
|
2971
|
-
data: {
|
|
2972
|
-
invMastUid: number;
|
|
2973
|
-
itemId: string;
|
|
2974
|
-
brandUid: number;
|
|
2975
|
-
brandItemUid: number;
|
|
2976
|
-
dateCreated?: string | undefined;
|
|
2977
|
-
dateLastModified?: string | undefined;
|
|
2978
|
-
itemDesc?: string | undefined;
|
|
2979
|
-
createdBy?: string | undefined;
|
|
2980
|
-
lastMaintainedBy?: string | undefined;
|
|
2981
|
-
isActive?: string | undefined;
|
|
2982
|
-
brandPartNumber?: string | undefined;
|
|
2983
|
-
brandItemDesc?: string | undefined;
|
|
2984
|
-
isPrimary?: string | undefined;
|
|
2985
|
-
}[];
|
|
2986
|
-
options: Record<string, unknown> | unknown[];
|
|
2987
|
-
status: number;
|
|
2988
|
-
message: string;
|
|
2989
|
-
count: number;
|
|
2990
|
-
total: number;
|
|
2991
|
-
totalResults: number;
|
|
2992
|
-
}>;
|
|
2993
|
-
/**
|
|
2994
|
-
* Get brand-item relationship details
|
|
2995
|
-
* @description Retrieve details for a specific brand-item relationship
|
|
2996
|
-
* @param brandUid Brand unique identifier
|
|
2997
|
-
* @param brandItemUid Brand-item relationship unique identifier
|
|
2998
|
-
* @returns Brand-item relationship details
|
|
2999
|
-
* @throws ValidationError When response is malformed
|
|
3000
|
-
* @example
|
|
3001
|
-
* ```typescript
|
|
3002
|
-
* const relationship = await client.brandItems.get(123, 456);
|
|
3003
|
-
* console.log(relationship.data.brandPartNumber, relationship.data.brandItemDesc);
|
|
3004
|
-
* ```
|
|
3005
|
-
*/
|
|
3006
|
-
get: (brandUid: number, brandItemUid: number) => Promise<{
|
|
3007
|
-
params: Record<string, unknown> | unknown[];
|
|
3008
|
-
data: {
|
|
3009
|
-
invMastUid: number;
|
|
3010
|
-
itemId: string;
|
|
3011
|
-
brandUid: number;
|
|
3012
|
-
brandItemUid: number;
|
|
3013
|
-
dateCreated?: string | undefined;
|
|
3014
|
-
dateLastModified?: string | undefined;
|
|
3015
|
-
itemDesc?: string | undefined;
|
|
3016
|
-
createdBy?: string | undefined;
|
|
3017
|
-
lastMaintainedBy?: string | undefined;
|
|
3018
|
-
isActive?: string | undefined;
|
|
3019
|
-
brandPartNumber?: string | undefined;
|
|
3020
|
-
brandItemDesc?: string | undefined;
|
|
3021
|
-
isPrimary?: string | undefined;
|
|
3022
|
-
};
|
|
3023
|
-
options: Record<string, unknown> | unknown[];
|
|
3024
|
-
status: number;
|
|
3025
|
-
message: string;
|
|
3026
|
-
count: number;
|
|
3027
|
-
total: number;
|
|
3028
|
-
totalResults: number;
|
|
3029
|
-
}>;
|
|
3030
|
-
/**
|
|
3031
|
-
* Create brand-item relationship
|
|
3032
|
-
* @description Create a new relationship between a brand and an item
|
|
3033
|
-
* @param brandUid Brand unique identifier
|
|
3034
|
-
* @param request Brand-item relationship creation data
|
|
3035
|
-
* @returns Created relationship information
|
|
3036
|
-
* @throws ValidationError When request is invalid or response is malformed
|
|
3037
|
-
* @example
|
|
3038
|
-
* ```typescript
|
|
3039
|
-
* const relationship = await client.brandItems.create(123, {
|
|
3040
|
-
* invMastUid: 12345,
|
|
3041
|
-
* brandPartNumber: 'BRD-001',
|
|
3042
|
-
* brandItemDesc: 'Brand-specific description',
|
|
3043
|
-
* isPrimary: 'Y'
|
|
3044
|
-
* });
|
|
3045
|
-
* ```
|
|
3046
|
-
*/
|
|
3047
|
-
create: (brandUid: number, request: CreateBrandItemRequest) => Promise<{
|
|
3048
|
-
params: Record<string, unknown> | unknown[];
|
|
3049
|
-
data: {
|
|
3050
|
-
invMastUid: number;
|
|
3051
|
-
itemId: string;
|
|
3052
|
-
brandUid: number;
|
|
3053
|
-
brandItemUid: number;
|
|
3054
|
-
dateCreated?: string | undefined;
|
|
3055
|
-
dateLastModified?: string | undefined;
|
|
3056
|
-
itemDesc?: string | undefined;
|
|
3057
|
-
createdBy?: string | undefined;
|
|
3058
|
-
lastMaintainedBy?: string | undefined;
|
|
3059
|
-
isActive?: string | undefined;
|
|
3060
|
-
brandPartNumber?: string | undefined;
|
|
3061
|
-
brandItemDesc?: string | undefined;
|
|
3062
|
-
isPrimary?: string | undefined;
|
|
3063
|
-
};
|
|
3064
|
-
options: Record<string, unknown> | unknown[];
|
|
3065
|
-
status: number;
|
|
3066
|
-
message: string;
|
|
3067
|
-
count: number;
|
|
3068
|
-
total: number;
|
|
3069
|
-
totalResults: number;
|
|
3070
|
-
}>;
|
|
3071
|
-
/**
|
|
3072
|
-
* Update brand-item relationship
|
|
3073
|
-
* @description Update an existing brand-item relationship
|
|
3074
|
-
* @param brandUid Brand unique identifier
|
|
3075
|
-
* @param brandItemUid Brand-item relationship unique identifier
|
|
3076
|
-
* @param request Update data
|
|
3077
|
-
* @returns Updated relationship information
|
|
3078
|
-
* @throws ValidationError When request is invalid or response is malformed
|
|
3079
|
-
* @example
|
|
3080
|
-
* ```typescript
|
|
3081
|
-
* const updated = await client.brandItems.update(123, 456, {
|
|
3082
|
-
* brandPartNumber: 'BRD-001-V2',
|
|
3083
|
-
* brandItemDesc: 'Updated brand-specific description'
|
|
3084
|
-
* });
|
|
3085
|
-
* ```
|
|
3086
|
-
*/
|
|
3087
|
-
update: (brandUid: number, brandItemUid: number, request: UpdateBrandItemRequest) => Promise<{
|
|
3088
|
-
params: Record<string, unknown> | unknown[];
|
|
3089
|
-
data: {
|
|
3090
|
-
invMastUid: number;
|
|
3091
|
-
itemId: string;
|
|
3092
|
-
brandUid: number;
|
|
3093
|
-
brandItemUid: number;
|
|
3094
|
-
dateCreated?: string | undefined;
|
|
3095
|
-
dateLastModified?: string | undefined;
|
|
3096
|
-
itemDesc?: string | undefined;
|
|
3097
|
-
createdBy?: string | undefined;
|
|
3098
|
-
lastMaintainedBy?: string | undefined;
|
|
3099
|
-
isActive?: string | undefined;
|
|
3100
|
-
brandPartNumber?: string | undefined;
|
|
3101
|
-
brandItemDesc?: string | undefined;
|
|
3102
|
-
isPrimary?: string | undefined;
|
|
3103
|
-
};
|
|
3104
|
-
options: Record<string, unknown> | unknown[];
|
|
3105
|
-
status: number;
|
|
3106
|
-
message: string;
|
|
3107
|
-
count: number;
|
|
3108
|
-
total: number;
|
|
3109
|
-
totalResults: number;
|
|
3110
|
-
}>;
|
|
3111
|
-
/**
|
|
3112
|
-
* Delete brand-item relationship
|
|
3113
|
-
* @description Remove a relationship between a brand and an item
|
|
3114
|
-
* @param brandUid Brand unique identifier
|
|
3115
|
-
* @param brandItemUid Brand-item relationship unique identifier
|
|
3116
|
-
* @returns Success response
|
|
3117
|
-
* @throws ValidationError When response is malformed
|
|
3118
|
-
* @example
|
|
3119
|
-
* ```typescript
|
|
3120
|
-
* await client.brandItems.delete(123, 456);
|
|
3121
|
-
* ```
|
|
3122
|
-
*/
|
|
3123
|
-
delete: (brandUid: number, brandItemUid: number) => Promise<{
|
|
3124
|
-
params: Record<string, unknown> | unknown[];
|
|
3125
|
-
data: {
|
|
3126
|
-
invMastUid: number;
|
|
3127
|
-
itemId: string;
|
|
3128
|
-
brandUid: number;
|
|
3129
|
-
brandItemUid: number;
|
|
3130
|
-
dateCreated?: string | undefined;
|
|
3131
|
-
dateLastModified?: string | undefined;
|
|
3132
|
-
itemDesc?: string | undefined;
|
|
3133
|
-
createdBy?: string | undefined;
|
|
3134
|
-
lastMaintainedBy?: string | undefined;
|
|
3135
|
-
isActive?: string | undefined;
|
|
3136
|
-
brandPartNumber?: string | undefined;
|
|
3137
|
-
brandItemDesc?: string | undefined;
|
|
3138
|
-
isPrimary?: string | undefined;
|
|
3139
|
-
};
|
|
3140
|
-
options: Record<string, unknown> | unknown[];
|
|
3141
|
-
status: number;
|
|
3142
|
-
message: string;
|
|
3143
|
-
count: number;
|
|
3144
|
-
total: number;
|
|
3145
|
-
totalResults: number;
|
|
3146
|
-
}>;
|
|
3147
|
-
};
|
|
3148
|
-
/**
|
|
3149
|
-
* Brand-item relationship data-only endpoints
|
|
3150
|
-
* @description Data-only methods that return just the data portion of brand-item responses
|
|
3151
|
-
*/
|
|
3152
|
-
brandItemsData: {
|
|
3153
|
-
/**
|
|
3154
|
-
* List brand-item relationships data only
|
|
3155
|
-
* @description Returns only the data portion of brand-item relationships response
|
|
3156
|
-
* @param brandUid Brand unique identifier
|
|
3157
|
-
* @param params Optional filtering and pagination parameters
|
|
3158
|
-
* @returns Array of brand-item relationships data
|
|
3159
|
-
*/
|
|
3160
|
-
list: (brandUid: number, params?: BrandItemListParams) => Promise<{
|
|
3161
|
-
invMastUid: number;
|
|
3162
|
-
itemId: string;
|
|
3163
|
-
brandUid: number;
|
|
3164
|
-
brandItemUid: number;
|
|
3165
|
-
dateCreated?: string | undefined;
|
|
3166
|
-
dateLastModified?: string | undefined;
|
|
3167
|
-
itemDesc?: string | undefined;
|
|
3168
|
-
createdBy?: string | undefined;
|
|
3169
|
-
lastMaintainedBy?: string | undefined;
|
|
3170
|
-
isActive?: string | undefined;
|
|
3171
|
-
brandPartNumber?: string | undefined;
|
|
3172
|
-
brandItemDesc?: string | undefined;
|
|
3173
|
-
isPrimary?: string | undefined;
|
|
3174
|
-
}[]>;
|
|
3175
|
-
};
|
|
3176
3116
|
/**
|
|
3177
3117
|
* Product links management endpoints
|
|
3178
3118
|
* @description Methods for managing relationships between products (accessories, related items, etc.)
|
|
@@ -3687,54 +3627,39 @@ export declare class ItemsClient extends BaseServiceClient {
|
|
|
3687
3627
|
*/
|
|
3688
3628
|
bins: {
|
|
3689
3629
|
/**
|
|
3690
|
-
* List
|
|
3691
|
-
* @description
|
|
3630
|
+
* List all items in bins at a location
|
|
3631
|
+
* @description OpenAPI: /locations/{locationId}/bins - "List all items in bins at a location"
|
|
3692
3632
|
* @fullPath api.items.locations.bins.list
|
|
3693
3633
|
* @service items
|
|
3694
3634
|
* @domain inventory-management
|
|
3695
|
-
* @dataMethod locationsData.bins.list
|
|
3696
|
-
* @discoverable true
|
|
3697
|
-
* @searchTerms ["bins", "warehouse bins", "location bins", "storage bins", "inventory locations"]
|
|
3698
|
-
* @relatedEndpoints ["api.nexus.inventory.locations", "api.items.stock.getDetails"]
|
|
3699
|
-
* @commonPatterns ["Warehouse management", "Inventory location tracking", "Bin organization"]
|
|
3700
|
-
* @workflow ["inventory-management", "warehouse-operations"]
|
|
3701
|
-
* @prerequisites ["Valid authentication token", "Warehouse access permissions"]
|
|
3702
|
-
* @nextSteps ["api.items.bins.getInventory for stock levels", "api.nexus.inventory.movements for movements"]
|
|
3703
|
-
* @businessRules ["Shows active bins only", "Location-specific access", "Capacity tracking"]
|
|
3704
|
-
* @functionalArea "warehouse-and-inventory-management"
|
|
3705
|
-
* @caching "Cache for 10 minutes, invalidate on bin changes"
|
|
3706
|
-
* @performance "Paginated results for locations with many bins"
|
|
3707
3635
|
* @param locationId Location unique identifier
|
|
3708
|
-
* @param params Optional filtering
|
|
3709
|
-
* @returns Array of
|
|
3710
|
-
* @throws ValidationError When parameters are invalid or response is malformed
|
|
3636
|
+
* @param params Optional filtering parameters (excludeZero, bin filter, pagination)
|
|
3637
|
+
* @returns Array of inventory items in bins at the location
|
|
3711
3638
|
* @example
|
|
3712
3639
|
* ```typescript
|
|
3713
|
-
* const
|
|
3714
|
-
*
|
|
3715
|
-
* console.log(`${
|
|
3640
|
+
* const items = await client.locations.bins.list(123);
|
|
3641
|
+
* items.data.forEach(item => {
|
|
3642
|
+
* console.log(`${item.bin}: ${item.itemId} (${item.qtyOnHand})`);
|
|
3716
3643
|
* });
|
|
3717
3644
|
* ```
|
|
3718
3645
|
*/
|
|
3719
|
-
list: (locationId: number, params?:
|
|
3646
|
+
list: (locationId: number, params?: LocationsBinsParams) => Promise<{
|
|
3720
3647
|
params: Record<string, unknown> | unknown[];
|
|
3721
3648
|
data: {
|
|
3649
|
+
invMastUid: number;
|
|
3650
|
+
itemId: string;
|
|
3722
3651
|
locationId: number;
|
|
3723
3652
|
bin: string;
|
|
3653
|
+
qtyOnHand: number;
|
|
3724
3654
|
binUid: number;
|
|
3655
|
+
invLocBinUid: number;
|
|
3725
3656
|
dateCreated?: string | undefined;
|
|
3726
3657
|
dateLastModified?: string | undefined;
|
|
3727
|
-
|
|
3728
|
-
|
|
3729
|
-
|
|
3730
|
-
|
|
3731
|
-
|
|
3732
|
-
maxCapacity?: number | undefined;
|
|
3733
|
-
currentCapacity?: number | undefined;
|
|
3734
|
-
zone?: string | undefined;
|
|
3735
|
-
aisle?: string | undefined;
|
|
3736
|
-
shelf?: string | undefined;
|
|
3737
|
-
position?: string | undefined;
|
|
3658
|
+
qtyAllocated?: number | undefined;
|
|
3659
|
+
qtyAvailable?: number | undefined;
|
|
3660
|
+
unitCost?: number | undefined;
|
|
3661
|
+
lastCountDate?: string | undefined;
|
|
3662
|
+
lastMovementDate?: string | undefined;
|
|
3738
3663
|
}[];
|
|
3739
3664
|
options: Record<string, unknown> | unknown[];
|
|
3740
3665
|
status: number;
|
|
@@ -3744,45 +3669,54 @@ export declare class ItemsClient extends BaseServiceClient {
|
|
|
3744
3669
|
totalResults: number;
|
|
3745
3670
|
}>;
|
|
3746
3671
|
/**
|
|
3747
|
-
*
|
|
3748
|
-
* @description
|
|
3749
|
-
* @param locationId Location unique identifier
|
|
3750
|
-
* @param bin Bin identifier
|
|
3751
|
-
* @returns Bin details
|
|
3752
|
-
* @throws ValidationError When response is malformed
|
|
3753
|
-
* @example
|
|
3754
|
-
* ```typescript
|
|
3755
|
-
* const binDetails = await client.bins.get(123, 'A01-B02-S03');
|
|
3756
|
-
* console.log(binDetails.data.binDesc, binDetails.data.maxCapacity);
|
|
3757
|
-
* ```
|
|
3672
|
+
* Specific bin endpoints
|
|
3673
|
+
* @description Methods for accessing specific bins by identifier
|
|
3758
3674
|
*/
|
|
3759
|
-
|
|
3760
|
-
|
|
3761
|
-
|
|
3762
|
-
|
|
3763
|
-
|
|
3764
|
-
|
|
3765
|
-
|
|
3766
|
-
|
|
3767
|
-
|
|
3768
|
-
|
|
3769
|
-
|
|
3770
|
-
|
|
3771
|
-
|
|
3772
|
-
|
|
3773
|
-
|
|
3774
|
-
|
|
3775
|
-
|
|
3776
|
-
|
|
3777
|
-
|
|
3778
|
-
|
|
3779
|
-
|
|
3780
|
-
|
|
3781
|
-
|
|
3782
|
-
|
|
3783
|
-
|
|
3784
|
-
|
|
3785
|
-
|
|
3675
|
+
bin: {
|
|
3676
|
+
/**
|
|
3677
|
+
* List all items in a specific bin
|
|
3678
|
+
* @description OpenAPI: /locations/{locationId}/bins/{bin} - "List all items in a specific bin"
|
|
3679
|
+
* @fullPath api.items.locations.bins.bin.get
|
|
3680
|
+
* @service items
|
|
3681
|
+
* @domain inventory-management
|
|
3682
|
+
* @param locationId Location unique identifier
|
|
3683
|
+
* @param bin Bin identifier
|
|
3684
|
+
* @param params Optional filtering parameters (excludeZero, pagination)
|
|
3685
|
+
* @returns Array of inventory items in the specific bin
|
|
3686
|
+
* @example
|
|
3687
|
+
* ```typescript
|
|
3688
|
+
* const items = await client.locations.bins.bin.get(123, 'A-01');
|
|
3689
|
+
* items.data.forEach(item => {
|
|
3690
|
+
* console.log(`${item.itemId}: ${item.qtyOnHand}`);
|
|
3691
|
+
* });
|
|
3692
|
+
* ```
|
|
3693
|
+
*/
|
|
3694
|
+
get: (locationId: number, bin: string, params?: LocationsBinsParams) => Promise<{
|
|
3695
|
+
params: Record<string, unknown> | unknown[];
|
|
3696
|
+
data: {
|
|
3697
|
+
invMastUid: number;
|
|
3698
|
+
itemId: string;
|
|
3699
|
+
locationId: number;
|
|
3700
|
+
bin: string;
|
|
3701
|
+
qtyOnHand: number;
|
|
3702
|
+
binUid: number;
|
|
3703
|
+
invLocBinUid: number;
|
|
3704
|
+
dateCreated?: string | undefined;
|
|
3705
|
+
dateLastModified?: string | undefined;
|
|
3706
|
+
qtyAllocated?: number | undefined;
|
|
3707
|
+
qtyAvailable?: number | undefined;
|
|
3708
|
+
unitCost?: number | undefined;
|
|
3709
|
+
lastCountDate?: string | undefined;
|
|
3710
|
+
lastMovementDate?: string | undefined;
|
|
3711
|
+
}[];
|
|
3712
|
+
options: Record<string, unknown> | unknown[];
|
|
3713
|
+
status: number;
|
|
3714
|
+
message: string;
|
|
3715
|
+
count: number;
|
|
3716
|
+
total: number;
|
|
3717
|
+
totalResults: number;
|
|
3718
|
+
}>;
|
|
3719
|
+
};
|
|
3786
3720
|
/**
|
|
3787
3721
|
* Create new bin
|
|
3788
3722
|
* @description Create a new bin in a location
|
|
@@ -3928,7 +3862,7 @@ export declare class ItemsClient extends BaseServiceClient {
|
|
|
3928
3862
|
* });
|
|
3929
3863
|
* ```
|
|
3930
3864
|
*/
|
|
3931
|
-
getInventory: (invMastUid: number, locationId: number, params?:
|
|
3865
|
+
getInventory: (invMastUid: number, locationId: number, params?: LocationsBinsParams) => Promise<{
|
|
3932
3866
|
params: Record<string, unknown> | unknown[];
|
|
3933
3867
|
data: {
|
|
3934
3868
|
invMastUid: number;
|
|
@@ -3972,23 +3906,21 @@ export declare class ItemsClient extends BaseServiceClient {
|
|
|
3972
3906
|
* @param params Optional filtering and pagination parameters
|
|
3973
3907
|
* @returns Array of bins data
|
|
3974
3908
|
*/
|
|
3975
|
-
list: (locationId: number, params?:
|
|
3909
|
+
list: (locationId: number, params?: LocationsBinsParams) => Promise<{
|
|
3910
|
+
invMastUid: number;
|
|
3911
|
+
itemId: string;
|
|
3976
3912
|
locationId: number;
|
|
3977
3913
|
bin: string;
|
|
3914
|
+
qtyOnHand: number;
|
|
3978
3915
|
binUid: number;
|
|
3916
|
+
invLocBinUid: number;
|
|
3979
3917
|
dateCreated?: string | undefined;
|
|
3980
3918
|
dateLastModified?: string | undefined;
|
|
3981
|
-
|
|
3982
|
-
|
|
3983
|
-
|
|
3984
|
-
|
|
3985
|
-
|
|
3986
|
-
maxCapacity?: number | undefined;
|
|
3987
|
-
currentCapacity?: number | undefined;
|
|
3988
|
-
zone?: string | undefined;
|
|
3989
|
-
aisle?: string | undefined;
|
|
3990
|
-
shelf?: string | undefined;
|
|
3991
|
-
position?: string | undefined;
|
|
3919
|
+
qtyAllocated?: number | undefined;
|
|
3920
|
+
qtyAvailable?: number | undefined;
|
|
3921
|
+
unitCost?: number | undefined;
|
|
3922
|
+
lastCountDate?: string | undefined;
|
|
3923
|
+
lastMovementDate?: string | undefined;
|
|
3992
3924
|
}[]>;
|
|
3993
3925
|
/**
|
|
3994
3926
|
* Get inventory in bins data only
|
|
@@ -3998,7 +3930,7 @@ export declare class ItemsClient extends BaseServiceClient {
|
|
|
3998
3930
|
* @param params Optional filtering and pagination parameters
|
|
3999
3931
|
* @returns Array of inventory location bin data
|
|
4000
3932
|
*/
|
|
4001
|
-
getInventory: (invMastUid: number, locationId: number, params?:
|
|
3933
|
+
getInventory: (invMastUid: number, locationId: number, params?: LocationsBinsParams) => Promise<{
|
|
4002
3934
|
invMastUid: number;
|
|
4003
3935
|
itemId: string;
|
|
4004
3936
|
locationId: number;
|
|
@@ -4014,6 +3946,52 @@ export declare class ItemsClient extends BaseServiceClient {
|
|
|
4014
3946
|
lastCountDate?: string | undefined;
|
|
4015
3947
|
lastMovementDate?: string | undefined;
|
|
4016
3948
|
}[]>;
|
|
3949
|
+
/**
|
|
3950
|
+
* Bin-specific data methods
|
|
3951
|
+
* @description Data-only methods for specific bin operations
|
|
3952
|
+
*/
|
|
3953
|
+
bin: {
|
|
3954
|
+
/**
|
|
3955
|
+
* Get items in specific bin data only
|
|
3956
|
+
* @description Returns only the data portion of items in a specific bin
|
|
3957
|
+
*
|
|
3958
|
+
* @fullPath api.items.locations.bins.bin.get
|
|
3959
|
+
* @service items
|
|
3960
|
+
* @domain inventory
|
|
3961
|
+
* @dataMethod true
|
|
3962
|
+
* @discoverable true
|
|
3963
|
+
* @searchTerms ["specific bin items", "bin contents", "single bin inventory"]
|
|
3964
|
+
* @relatedEndpoints ["locations.bins.list"]
|
|
3965
|
+
* @commonPatterns ["show items in bin A-01", "what's in bin B-02"]
|
|
3966
|
+
*
|
|
3967
|
+
* @param locationId Location unique identifier
|
|
3968
|
+
* @param bin Bin identifier
|
|
3969
|
+
* @param params Optional filtering parameters
|
|
3970
|
+
* @returns Array of items in the specified bin
|
|
3971
|
+
*
|
|
3972
|
+
* @example
|
|
3973
|
+
* ```typescript
|
|
3974
|
+
* // Get items in specific bin
|
|
3975
|
+
* const items = await client.locationsData.bins.bin.get(100, 'A-01');
|
|
3976
|
+
* ```
|
|
3977
|
+
*/
|
|
3978
|
+
get: (locationId: number, bin: string, params?: LocationsBinsParams) => Promise<{
|
|
3979
|
+
invMastUid: number;
|
|
3980
|
+
itemId: string;
|
|
3981
|
+
locationId: number;
|
|
3982
|
+
bin: string;
|
|
3983
|
+
qtyOnHand: number;
|
|
3984
|
+
binUid: number;
|
|
3985
|
+
invLocBinUid: number;
|
|
3986
|
+
dateCreated?: string | undefined;
|
|
3987
|
+
dateLastModified?: string | undefined;
|
|
3988
|
+
qtyAllocated?: number | undefined;
|
|
3989
|
+
qtyAvailable?: number | undefined;
|
|
3990
|
+
unitCost?: number | undefined;
|
|
3991
|
+
lastCountDate?: string | undefined;
|
|
3992
|
+
lastMovementDate?: string | undefined;
|
|
3993
|
+
}[]>;
|
|
3994
|
+
};
|
|
4017
3995
|
};
|
|
4018
3996
|
};
|
|
4019
3997
|
/**
|
|
@@ -4155,223 +4133,46 @@ export declare class ItemsClient extends BaseServiceClient {
|
|
|
4155
4133
|
* @param attributeValueUid Attribute value unique identifier
|
|
4156
4134
|
* @returns Success indication
|
|
4157
4135
|
* @throws ValidationError When response is malformed
|
|
4158
|
-
* @example
|
|
4159
|
-
* ```typescript
|
|
4160
|
-
* await client.attributeValues.delete(123, 456);
|
|
4161
|
-
* ```
|
|
4162
|
-
*/
|
|
4163
|
-
delete: (attributeUid: number, attributeValueUid: number) => Promise<boolean>;
|
|
4164
|
-
};
|
|
4165
|
-
/**
|
|
4166
|
-
* Attribute group attribute associations
|
|
4167
|
-
* @description Methods for managing attribute associations within attribute groups
|
|
4168
|
-
*/
|
|
4169
|
-
attributeGroupAttributes: {
|
|
4170
|
-
/**
|
|
4171
|
-
* List attributes in a group
|
|
4172
|
-
* @description Retrieve all attributes associated with an attribute group
|
|
4173
|
-
* @param attributeGroupUid Attribute group unique identifier
|
|
4174
|
-
* @param params Optional pagination parameters
|
|
4175
|
-
* @returns Array of attributes in the group
|
|
4176
|
-
* @throws ValidationError When parameters are invalid or response is malformed
|
|
4177
|
-
* @example
|
|
4178
|
-
* ```typescript
|
|
4179
|
-
* const groupAttrs = await client.attributeGroupAttributes.list(123);
|
|
4180
|
-
* groupAttrs.data.forEach(attr => {
|
|
4181
|
-
* console.log(`${attr.attributeId}: ${attr.attributeDesc}`);
|
|
4182
|
-
* });
|
|
4183
|
-
* ```
|
|
4184
|
-
*/
|
|
4185
|
-
list: (attributeGroupUid: number, params?: {
|
|
4186
|
-
limit?: number;
|
|
4187
|
-
offset?: number;
|
|
4188
|
-
}) => Promise<{
|
|
4189
|
-
params: Record<string, unknown> | unknown[];
|
|
4190
|
-
data: {
|
|
4191
|
-
statusCd: number;
|
|
4192
|
-
attributeUid: number;
|
|
4193
|
-
attributeId: string;
|
|
4194
|
-
attributeDesc: string;
|
|
4195
|
-
dataType: string;
|
|
4196
|
-
sequenceNo?: number | undefined;
|
|
4197
|
-
maxLength?: number | undefined;
|
|
4198
|
-
}[];
|
|
4199
|
-
options: Record<string, unknown> | unknown[];
|
|
4200
|
-
status: number;
|
|
4201
|
-
message: string;
|
|
4202
|
-
count: number;
|
|
4203
|
-
total: number;
|
|
4204
|
-
totalResults: number;
|
|
4205
|
-
}>;
|
|
4206
|
-
/**
|
|
4207
|
-
* Add attribute to group
|
|
4208
|
-
* @description Associate an attribute with an attribute group
|
|
4209
|
-
* @param attributeGroupUid Attribute group unique identifier
|
|
4210
|
-
* @param request Association data
|
|
4211
|
-
* @returns Created association
|
|
4212
|
-
* @throws ValidationError When request is invalid or response is malformed
|
|
4213
|
-
* @example
|
|
4214
|
-
* ```typescript
|
|
4215
|
-
* const association = await client.attributeGroupAttributes.create(123, {
|
|
4216
|
-
* attributeUid: 456,
|
|
4217
|
-
* sequenceNo: 10
|
|
4218
|
-
* });
|
|
4219
|
-
* ```
|
|
4220
|
-
*/
|
|
4221
|
-
create: (attributeGroupUid: number, request: CreateAttributeGroupAttributeRequest) => Promise<{
|
|
4222
|
-
data: {
|
|
4223
|
-
attributeUid: number;
|
|
4224
|
-
attributeGroupUid: number;
|
|
4225
|
-
attributeXAttributeGroupUid: number;
|
|
4226
|
-
sequenceNo?: number | undefined;
|
|
4227
|
-
};
|
|
4228
|
-
status: number;
|
|
4229
|
-
message: string;
|
|
4230
|
-
count: number;
|
|
4231
|
-
total: number;
|
|
4232
|
-
totalResults: number;
|
|
4233
|
-
params?: any;
|
|
4234
|
-
options?: any;
|
|
4235
|
-
}>;
|
|
4236
|
-
/**
|
|
4237
|
-
* Get specific attribute in group
|
|
4238
|
-
* @description Get details of a specific attribute association in a group
|
|
4239
|
-
* @param attributeGroupUid Attribute group unique identifier
|
|
4240
|
-
* @param attributeXAttributeGroupUid Association unique identifier
|
|
4241
|
-
* @returns Association details
|
|
4242
|
-
* @throws ValidationError When response is malformed
|
|
4243
|
-
* @example
|
|
4244
|
-
* ```typescript
|
|
4245
|
-
* const association = await client.attributeGroupAttributes.get(123, 789);
|
|
4246
|
-
* console.log(association.data.attributeUid, association.data.sequenceNo);
|
|
4247
|
-
* ```
|
|
4248
|
-
*/
|
|
4249
|
-
get: (attributeGroupUid: number, attributeXAttributeGroupUid: number) => Promise<{
|
|
4250
|
-
data: {
|
|
4251
|
-
attributeUid: number;
|
|
4252
|
-
attributeGroupUid: number;
|
|
4253
|
-
attributeXAttributeGroupUid: number;
|
|
4254
|
-
sequenceNo?: number | undefined;
|
|
4255
|
-
};
|
|
4256
|
-
status: number;
|
|
4257
|
-
message: string;
|
|
4258
|
-
count: number;
|
|
4259
|
-
total: number;
|
|
4260
|
-
totalResults: number;
|
|
4261
|
-
params?: any;
|
|
4262
|
-
options?: any;
|
|
4263
|
-
}>;
|
|
4264
|
-
/**
|
|
4265
|
-
* Update attribute in group
|
|
4266
|
-
* @description Update an attribute association in a group
|
|
4267
|
-
* @param attributeGroupUid Attribute group unique identifier
|
|
4268
|
-
* @param attributeXAttributeGroupUid Association unique identifier
|
|
4269
|
-
* @param request Update data
|
|
4270
|
-
* @returns Updated association
|
|
4271
|
-
* @throws ValidationError When request is invalid or response is malformed
|
|
4272
|
-
* @example
|
|
4273
|
-
* ```typescript
|
|
4274
|
-
* const updated = await client.attributeGroupAttributes.update(123, 789, {
|
|
4275
|
-
* sequenceNo: 20
|
|
4276
|
-
* });
|
|
4277
|
-
* ```
|
|
4278
|
-
*/
|
|
4279
|
-
update: (attributeGroupUid: number, attributeXAttributeGroupUid: number, request: UpdateAttributeGroupAttributeRequest) => Promise<{
|
|
4280
|
-
data: {
|
|
4281
|
-
attributeUid: number;
|
|
4282
|
-
attributeGroupUid: number;
|
|
4283
|
-
attributeXAttributeGroupUid: number;
|
|
4284
|
-
sequenceNo?: number | undefined;
|
|
4285
|
-
};
|
|
4286
|
-
status: number;
|
|
4287
|
-
message: string;
|
|
4288
|
-
count: number;
|
|
4289
|
-
total: number;
|
|
4290
|
-
totalResults: number;
|
|
4291
|
-
params?: any;
|
|
4292
|
-
options?: any;
|
|
4293
|
-
}>;
|
|
4294
|
-
/**
|
|
4295
|
-
* Remove attribute from group
|
|
4296
|
-
* @description Remove an attribute association from a group
|
|
4297
|
-
* @param attributeGroupUid Attribute group unique identifier
|
|
4298
|
-
* @param attributeXAttributeGroupUid Association unique identifier
|
|
4299
|
-
* @returns Success indication
|
|
4300
|
-
* @throws ValidationError When response is malformed
|
|
4301
|
-
* @example
|
|
4302
|
-
* ```typescript
|
|
4303
|
-
* await client.attributeGroupAttributes.delete(123, 789);
|
|
4304
|
-
* ```
|
|
4305
|
-
*/
|
|
4306
|
-
delete: (attributeGroupUid: number, attributeXAttributeGroupUid: number) => Promise<boolean>;
|
|
4307
|
-
};
|
|
4308
|
-
/**
|
|
4309
|
-
* Brand item associations
|
|
4310
|
-
* @description Methods for managing item associations within brands
|
|
4311
|
-
*/
|
|
4312
|
-
brandsItems: {
|
|
4313
|
-
/**
|
|
4314
|
-
* List items for a brand
|
|
4315
|
-
* @description Retrieve all items associated with a brand
|
|
4316
|
-
* @param brandsUid Brand unique identifier
|
|
4317
|
-
* @param params Optional pagination parameters
|
|
4318
|
-
* @returns Array of items for the brand
|
|
4319
|
-
* @throws ValidationError When parameters are invalid or response is malformed
|
|
4320
|
-
* @example
|
|
4321
|
-
* ```typescript
|
|
4322
|
-
* const brandItems = await client.brandsItems.list(123);
|
|
4323
|
-
* brandItems.data.forEach(item => {
|
|
4324
|
-
* console.log(`${item.itemId}: ${item.itemDesc}`);
|
|
4325
|
-
* });
|
|
4326
|
-
* ```
|
|
4327
|
-
*/
|
|
4328
|
-
list: (brandsUid: number, params?: {
|
|
4329
|
-
limit?: number;
|
|
4330
|
-
offset?: number;
|
|
4331
|
-
}) => Promise<{
|
|
4332
|
-
params: Record<string, unknown> | unknown[];
|
|
4333
|
-
data: {
|
|
4334
|
-
statusCd: number;
|
|
4335
|
-
invMastUid: number;
|
|
4336
|
-
itemId: string;
|
|
4337
|
-
itemDesc: string;
|
|
4338
|
-
length?: number | null | undefined;
|
|
4339
|
-
dateCreated?: string | undefined;
|
|
4340
|
-
dateLastModified?: string | undefined;
|
|
4341
|
-
updateCd?: number | undefined;
|
|
4342
|
-
processCd?: number | undefined;
|
|
4343
|
-
unitOfMeasure?: string | undefined;
|
|
4344
|
-
displayOnWebFlag?: string | undefined;
|
|
4345
|
-
deleteFlag?: string | undefined;
|
|
4346
|
-
weight?: number | null | undefined;
|
|
4347
|
-
width?: number | null | undefined;
|
|
4348
|
-
height?: number | null | undefined;
|
|
4349
|
-
attributes?: {
|
|
4350
|
-
value: string;
|
|
4351
|
-
attributeId: string;
|
|
4352
|
-
}[] | undefined;
|
|
4353
|
-
images?: {
|
|
4354
|
-
imageUid: number;
|
|
4355
|
-
imagePath: string;
|
|
4356
|
-
}[] | undefined;
|
|
4357
|
-
upc?: string | null | undefined;
|
|
4358
|
-
listPrice?: number | undefined;
|
|
4359
|
-
stdPrice?: number | undefined;
|
|
4360
|
-
onlineCd?: number | undefined;
|
|
4361
|
-
createdBy?: string | undefined;
|
|
4362
|
-
lastMaintainedBy?: string | undefined;
|
|
4363
|
-
typeCd?: number | undefined;
|
|
4364
|
-
brandName?: string | null | undefined;
|
|
4365
|
-
brandId?: string | null | undefined;
|
|
4366
|
-
brandsUid?: number | null | undefined;
|
|
4367
|
-
weightUnitOfMeasure?: string | null | undefined;
|
|
4368
|
-
dimensionUnitOfMeasure?: string | null | undefined;
|
|
4369
|
-
categories?: {
|
|
4370
|
-
categoryUid: number;
|
|
4371
|
-
categoryDesc: string;
|
|
4372
|
-
}[] | undefined;
|
|
4373
|
-
accessories?: unknown[] | undefined;
|
|
4374
|
-
alternateCode?: unknown[] | undefined;
|
|
4136
|
+
* @example
|
|
4137
|
+
* ```typescript
|
|
4138
|
+
* await client.attributeValues.delete(123, 456);
|
|
4139
|
+
* ```
|
|
4140
|
+
*/
|
|
4141
|
+
delete: (attributeUid: number, attributeValueUid: number) => Promise<boolean>;
|
|
4142
|
+
};
|
|
4143
|
+
/**
|
|
4144
|
+
* Attribute group attribute associations
|
|
4145
|
+
* @description Methods for managing attribute associations within attribute groups
|
|
4146
|
+
*/
|
|
4147
|
+
attributeGroupAttributes: {
|
|
4148
|
+
/**
|
|
4149
|
+
* List attributes in a group
|
|
4150
|
+
* @description Retrieve all attributes associated with an attribute group
|
|
4151
|
+
* @param attributeGroupUid Attribute group unique identifier
|
|
4152
|
+
* @param params Optional pagination parameters
|
|
4153
|
+
* @returns Array of attributes in the group
|
|
4154
|
+
* @throws ValidationError When parameters are invalid or response is malformed
|
|
4155
|
+
* @example
|
|
4156
|
+
* ```typescript
|
|
4157
|
+
* const groupAttrs = await client.attributeGroupAttributes.list(123);
|
|
4158
|
+
* groupAttrs.data.forEach(attr => {
|
|
4159
|
+
* console.log(`${attr.attributeId}: ${attr.attributeDesc}`);
|
|
4160
|
+
* });
|
|
4161
|
+
* ```
|
|
4162
|
+
*/
|
|
4163
|
+
list: (attributeGroupUid: number, params?: {
|
|
4164
|
+
limit?: number;
|
|
4165
|
+
offset?: number;
|
|
4166
|
+
}) => Promise<{
|
|
4167
|
+
params: Record<string, unknown> | unknown[];
|
|
4168
|
+
data: {
|
|
4169
|
+
statusCd: number;
|
|
4170
|
+
attributeUid: number;
|
|
4171
|
+
attributeId: string;
|
|
4172
|
+
attributeDesc: string;
|
|
4173
|
+
dataType: string;
|
|
4174
|
+
sequenceNo?: number | undefined;
|
|
4175
|
+
maxLength?: number | undefined;
|
|
4375
4176
|
}[];
|
|
4376
4177
|
options: Record<string, unknown> | unknown[];
|
|
4377
4178
|
status: number;
|
|
@@ -4381,24 +4182,26 @@ export declare class ItemsClient extends BaseServiceClient {
|
|
|
4381
4182
|
totalResults: number;
|
|
4382
4183
|
}>;
|
|
4383
4184
|
/**
|
|
4384
|
-
* Add
|
|
4385
|
-
* @description Associate an
|
|
4386
|
-
* @param
|
|
4185
|
+
* Add attribute to group
|
|
4186
|
+
* @description Associate an attribute with an attribute group
|
|
4187
|
+
* @param attributeGroupUid Attribute group unique identifier
|
|
4387
4188
|
* @param request Association data
|
|
4388
4189
|
* @returns Created association
|
|
4389
4190
|
* @throws ValidationError When request is invalid or response is malformed
|
|
4390
4191
|
* @example
|
|
4391
4192
|
* ```typescript
|
|
4392
|
-
* const association = await client.
|
|
4393
|
-
*
|
|
4193
|
+
* const association = await client.attributeGroupAttributes.create(123, {
|
|
4194
|
+
* attributeUid: 456,
|
|
4195
|
+
* sequenceNo: 10
|
|
4394
4196
|
* });
|
|
4395
4197
|
* ```
|
|
4396
4198
|
*/
|
|
4397
|
-
create: (
|
|
4199
|
+
create: (attributeGroupUid: number, request: CreateAttributeGroupAttributeRequest) => Promise<{
|
|
4398
4200
|
data: {
|
|
4399
|
-
|
|
4400
|
-
|
|
4401
|
-
|
|
4201
|
+
attributeUid: number;
|
|
4202
|
+
attributeGroupUid: number;
|
|
4203
|
+
attributeXAttributeGroupUid: number;
|
|
4204
|
+
sequenceNo?: number | undefined;
|
|
4402
4205
|
};
|
|
4403
4206
|
status: number;
|
|
4404
4207
|
message: string;
|
|
@@ -4409,23 +4212,24 @@ export declare class ItemsClient extends BaseServiceClient {
|
|
|
4409
4212
|
options?: any;
|
|
4410
4213
|
}>;
|
|
4411
4214
|
/**
|
|
4412
|
-
* Get specific
|
|
4413
|
-
* @description Get details of a specific
|
|
4414
|
-
* @param
|
|
4415
|
-
* @param
|
|
4215
|
+
* Get specific attribute in group
|
|
4216
|
+
* @description Get details of a specific attribute association in a group
|
|
4217
|
+
* @param attributeGroupUid Attribute group unique identifier
|
|
4218
|
+
* @param attributeXAttributeGroupUid Association unique identifier
|
|
4416
4219
|
* @returns Association details
|
|
4417
4220
|
* @throws ValidationError When response is malformed
|
|
4418
4221
|
* @example
|
|
4419
4222
|
* ```typescript
|
|
4420
|
-
* const association = await client.
|
|
4421
|
-
* console.log(association.data.
|
|
4223
|
+
* const association = await client.attributeGroupAttributes.get(123, 789);
|
|
4224
|
+
* console.log(association.data.attributeUid, association.data.sequenceNo);
|
|
4422
4225
|
* ```
|
|
4423
4226
|
*/
|
|
4424
|
-
get: (
|
|
4227
|
+
get: (attributeGroupUid: number, attributeXAttributeGroupUid: number) => Promise<{
|
|
4425
4228
|
data: {
|
|
4426
|
-
|
|
4427
|
-
|
|
4428
|
-
|
|
4229
|
+
attributeUid: number;
|
|
4230
|
+
attributeGroupUid: number;
|
|
4231
|
+
attributeXAttributeGroupUid: number;
|
|
4232
|
+
sequenceNo?: number | undefined;
|
|
4429
4233
|
};
|
|
4430
4234
|
status: number;
|
|
4431
4235
|
message: string;
|
|
@@ -4436,25 +4240,26 @@ export declare class ItemsClient extends BaseServiceClient {
|
|
|
4436
4240
|
options?: any;
|
|
4437
4241
|
}>;
|
|
4438
4242
|
/**
|
|
4439
|
-
* Update
|
|
4440
|
-
* @description Update
|
|
4441
|
-
* @param
|
|
4442
|
-
* @param
|
|
4243
|
+
* Update attribute in group
|
|
4244
|
+
* @description Update an attribute association in a group
|
|
4245
|
+
* @param attributeGroupUid Attribute group unique identifier
|
|
4246
|
+
* @param attributeXAttributeGroupUid Association unique identifier
|
|
4443
4247
|
* @param request Update data
|
|
4444
4248
|
* @returns Updated association
|
|
4445
4249
|
* @throws ValidationError When request is invalid or response is malformed
|
|
4446
4250
|
* @example
|
|
4447
4251
|
* ```typescript
|
|
4448
|
-
* const updated = await client.
|
|
4449
|
-
*
|
|
4252
|
+
* const updated = await client.attributeGroupAttributes.update(123, 789, {
|
|
4253
|
+
* sequenceNo: 20
|
|
4450
4254
|
* });
|
|
4451
4255
|
* ```
|
|
4452
4256
|
*/
|
|
4453
|
-
update: (
|
|
4257
|
+
update: (attributeGroupUid: number, attributeXAttributeGroupUid: number, request: UpdateAttributeGroupAttributeRequest) => Promise<{
|
|
4454
4258
|
data: {
|
|
4455
|
-
|
|
4456
|
-
|
|
4457
|
-
|
|
4259
|
+
attributeUid: number;
|
|
4260
|
+
attributeGroupUid: number;
|
|
4261
|
+
attributeXAttributeGroupUid: number;
|
|
4262
|
+
sequenceNo?: number | undefined;
|
|
4458
4263
|
};
|
|
4459
4264
|
status: number;
|
|
4460
4265
|
message: string;
|
|
@@ -4465,19 +4270,23 @@ export declare class ItemsClient extends BaseServiceClient {
|
|
|
4465
4270
|
options?: any;
|
|
4466
4271
|
}>;
|
|
4467
4272
|
/**
|
|
4468
|
-
* Remove
|
|
4469
|
-
* @description Remove an
|
|
4470
|
-
* @param
|
|
4471
|
-
* @param
|
|
4273
|
+
* Remove attribute from group
|
|
4274
|
+
* @description Remove an attribute association from a group
|
|
4275
|
+
* @param attributeGroupUid Attribute group unique identifier
|
|
4276
|
+
* @param attributeXAttributeGroupUid Association unique identifier
|
|
4472
4277
|
* @returns Success indication
|
|
4473
4278
|
* @throws ValidationError When response is malformed
|
|
4474
4279
|
* @example
|
|
4475
4280
|
* ```typescript
|
|
4476
|
-
* await client.
|
|
4281
|
+
* await client.attributeGroupAttributes.delete(123, 789);
|
|
4477
4282
|
* ```
|
|
4478
4283
|
*/
|
|
4479
|
-
delete: (
|
|
4284
|
+
delete: (attributeGroupUid: number, attributeXAttributeGroupUid: number) => Promise<boolean>;
|
|
4480
4285
|
};
|
|
4286
|
+
/**
|
|
4287
|
+
* Brand item associations
|
|
4288
|
+
* @description Methods for managing item associations within brands
|
|
4289
|
+
*/
|
|
4481
4290
|
/**
|
|
4482
4291
|
* Additional missing endpoints
|
|
4483
4292
|
* @description Methods for endpoints that were missing from the implementation
|
|
@@ -4627,8 +4436,8 @@ export declare class ItemsClient extends BaseServiceClient {
|
|
|
4627
4436
|
*/
|
|
4628
4437
|
createInternalPdf: (request: CreateInternalPdfRequest) => Promise<{
|
|
4629
4438
|
data: {
|
|
4630
|
-
pdfUrl: string;
|
|
4631
4439
|
pdfId: string;
|
|
4440
|
+
pdfUrl: string;
|
|
4632
4441
|
expiresAt?: string | undefined;
|
|
4633
4442
|
};
|
|
4634
4443
|
status: number;
|
|
@@ -5228,7 +5037,7 @@ export declare class ItemsClient extends BaseServiceClient {
|
|
|
5228
5037
|
/**
|
|
5229
5038
|
* Get similar inventory masters
|
|
5230
5039
|
* @description Retrieve similar inventory masters to the specified one
|
|
5231
|
-
* @fullPath api.items.invMast.similar.
|
|
5040
|
+
* @fullPath api.items.invMast.similar.list
|
|
5232
5041
|
* @service items
|
|
5233
5042
|
* @domain inventory-management
|
|
5234
5043
|
* @discoverable true
|
|
@@ -5238,11 +5047,11 @@ export declare class ItemsClient extends BaseServiceClient {
|
|
|
5238
5047
|
* @throws ValidationError When response is malformed
|
|
5239
5048
|
* @example
|
|
5240
5049
|
* ```typescript
|
|
5241
|
-
* const similar = await client.invMast.similar.
|
|
5050
|
+
* const similar = await client.invMast.similar.list(12345);
|
|
5242
5051
|
* ```
|
|
5243
5052
|
*/
|
|
5244
5053
|
similar: {
|
|
5245
|
-
|
|
5054
|
+
list: (invMastUid: number) => Promise<{
|
|
5246
5055
|
params: Record<string, unknown> | unknown[];
|
|
5247
5056
|
data: {
|
|
5248
5057
|
statusCd: number;
|
|
@@ -5298,7 +5107,7 @@ export declare class ItemsClient extends BaseServiceClient {
|
|
|
5298
5107
|
/**
|
|
5299
5108
|
* Get inventory master alternate codes
|
|
5300
5109
|
* @description Retrieve alternate codes for a specific inventory master
|
|
5301
|
-
* @fullPath api.items.invMast.alternateCode.
|
|
5110
|
+
* @fullPath api.items.invMast.alternateCode.list
|
|
5302
5111
|
* @service items
|
|
5303
5112
|
* @domain inventory-management
|
|
5304
5113
|
* @discoverable true
|
|
@@ -5308,28 +5117,35 @@ export declare class ItemsClient extends BaseServiceClient {
|
|
|
5308
5117
|
* @throws ValidationError When response is malformed
|
|
5309
5118
|
* @example
|
|
5310
5119
|
* ```typescript
|
|
5311
|
-
* const altCodes = await client.invMast.alternateCode.
|
|
5120
|
+
* const altCodes = await client.invMast.alternateCode.list(12345);
|
|
5312
5121
|
* ```
|
|
5313
5122
|
*/
|
|
5314
5123
|
alternateCode: {
|
|
5315
|
-
|
|
5124
|
+
list: (invMastUid: number, params?: AlternateCodeListParams) => Promise<{
|
|
5125
|
+
params: Record<string, unknown> | unknown[];
|
|
5316
5126
|
data: {
|
|
5127
|
+
dateCreated: string;
|
|
5128
|
+
dateLastModified: string;
|
|
5129
|
+
updateCd: number;
|
|
5130
|
+
invMastUid: number;
|
|
5317
5131
|
alternateCode: string;
|
|
5318
|
-
|
|
5132
|
+
alternateCodeUid: number;
|
|
5133
|
+
sourceTypeCd: number;
|
|
5134
|
+
deleteFlag?: string | null | undefined;
|
|
5135
|
+
alternateCodeDesc?: string | null | undefined;
|
|
5319
5136
|
}[];
|
|
5137
|
+
options: Record<string, unknown> | unknown[];
|
|
5320
5138
|
status: number;
|
|
5321
5139
|
message: string;
|
|
5322
5140
|
count: number;
|
|
5323
5141
|
total: number;
|
|
5324
5142
|
totalResults: number;
|
|
5325
|
-
params?: any;
|
|
5326
|
-
options?: any;
|
|
5327
5143
|
}>;
|
|
5328
5144
|
};
|
|
5329
5145
|
/**
|
|
5330
5146
|
* Get inventory master accessories
|
|
5331
5147
|
* @description Retrieve accessories for a specific inventory master
|
|
5332
|
-
* @fullPath api.items.invMast.invAccessory.
|
|
5148
|
+
* @fullPath api.items.invMast.invAccessory.list
|
|
5333
5149
|
* @service items
|
|
5334
5150
|
* @domain inventory-management
|
|
5335
5151
|
* @discoverable true
|
|
@@ -5339,11 +5155,11 @@ export declare class ItemsClient extends BaseServiceClient {
|
|
|
5339
5155
|
* @throws ValidationError When response is malformed
|
|
5340
5156
|
* @example
|
|
5341
5157
|
* ```typescript
|
|
5342
|
-
* const accessories = await client.invMast.invAccessory.
|
|
5158
|
+
* const accessories = await client.invMast.invAccessory.list(12345);
|
|
5343
5159
|
* ```
|
|
5344
5160
|
*/
|
|
5345
5161
|
invAccessory: {
|
|
5346
|
-
|
|
5162
|
+
list: (invMastUid: number) => Promise<{
|
|
5347
5163
|
params: Record<string, unknown> | unknown[];
|
|
5348
5164
|
data: {
|
|
5349
5165
|
invMastUid: number;
|
|
@@ -5365,7 +5181,7 @@ export declare class ItemsClient extends BaseServiceClient {
|
|
|
5365
5181
|
/**
|
|
5366
5182
|
* Get inventory master sub-items
|
|
5367
5183
|
* @description Retrieve sub-items for a specific inventory master
|
|
5368
|
-
* @fullPath api.items.invMast.invSub.
|
|
5184
|
+
* @fullPath api.items.invMast.invSub.list
|
|
5369
5185
|
* @service items
|
|
5370
5186
|
* @domain inventory-management
|
|
5371
5187
|
* @discoverable true
|
|
@@ -5375,11 +5191,11 @@ export declare class ItemsClient extends BaseServiceClient {
|
|
|
5375
5191
|
* @throws ValidationError When response is malformed
|
|
5376
5192
|
* @example
|
|
5377
5193
|
* ```typescript
|
|
5378
|
-
* const subItems = await client.invMast.invSub.
|
|
5194
|
+
* const subItems = await client.invMast.invSub.list(12345);
|
|
5379
5195
|
* ```
|
|
5380
5196
|
*/
|
|
5381
5197
|
invSub: {
|
|
5382
|
-
|
|
5198
|
+
list: (invMastUid: number) => Promise<{
|
|
5383
5199
|
params: Record<string, unknown> | unknown[];
|
|
5384
5200
|
data: {
|
|
5385
5201
|
statusCd: number;
|
|
@@ -5874,6 +5690,331 @@ export declare class ItemsClient extends BaseServiceClient {
|
|
|
5874
5690
|
};
|
|
5875
5691
|
};
|
|
5876
5692
|
};
|
|
5693
|
+
/**
|
|
5694
|
+
* Inventory Master Links - Direct OpenAPI Path Mirror
|
|
5695
|
+
* @description New OpenAPI endpoint for listing document links for an item
|
|
5696
|
+
*
|
|
5697
|
+
* **CRITICAL: This endpoint follows OpenAPI Path Mirroring Pattern**
|
|
5698
|
+
* OpenAPI Path: /inv-mast-links/{invMastUid} → api.items.invMastLinks.list()
|
|
5699
|
+
*/
|
|
5700
|
+
invMastLinks: {
|
|
5701
|
+
/**
|
|
5702
|
+
* List document links for an inventory master item
|
|
5703
|
+
*
|
|
5704
|
+
* @fullPath api.items.invMastLinks.list
|
|
5705
|
+
* @service items
|
|
5706
|
+
* @domain inventory-management
|
|
5707
|
+
* @dataMethod listData - returns only the links array without metadata
|
|
5708
|
+
* @discoverable true
|
|
5709
|
+
* @searchTerms ["inventory links", "item documents", "product links", "inv mast links", "document links"]
|
|
5710
|
+
* @relatedEndpoints ["api.items.productLinks.list", "api.items.invMast.get", "api.legacy.invMastTags.list"]
|
|
5711
|
+
* @commonPatterns ["Get item documentation links", "Find product documents", "Document management"]
|
|
5712
|
+
* @workflow ["inventory-management", "document-management", "product-information"]
|
|
5713
|
+
* @prerequisites ["Valid authentication token", "Inventory access permissions"]
|
|
5714
|
+
* @nextSteps ["api.items.invMast.get for item details", "api.legacy.invMastTags for additional metadata"]
|
|
5715
|
+
* @businessRules ["Returns active document links only", "Ordered by link type and display order"]
|
|
5716
|
+
* @functionalArea "inventory-master-management"
|
|
5717
|
+
* @caching "Cache for 10 minutes, invalidate on item changes"
|
|
5718
|
+
* @performance "Fast lookup by inventory master UID"
|
|
5719
|
+
*
|
|
5720
|
+
* @param invMastUid Inventory master unique identifier
|
|
5721
|
+
* @returns Promise<InvMastLinksResponse> Complete response with document links array and metadata
|
|
5722
|
+
*
|
|
5723
|
+
* @example
|
|
5724
|
+
* ```typescript
|
|
5725
|
+
* // Get all document links for an item
|
|
5726
|
+
* const response = await api.items.invMastLinks.list(12345);
|
|
5727
|
+
* console.log(response.data); // ProductLink[]
|
|
5728
|
+
*
|
|
5729
|
+
* // Get just the data
|
|
5730
|
+
* const links = await api.items.invMastLinks.listData(12345);
|
|
5731
|
+
* ```
|
|
5732
|
+
*/
|
|
5733
|
+
list: (invMastUid: number) => Promise<InvMastLinksResponse>;
|
|
5734
|
+
/**
|
|
5735
|
+
* List document links data only
|
|
5736
|
+
* @description Returns only the links array without BaseResponse wrapper
|
|
5737
|
+
* @param invMastUid Inventory master unique identifier
|
|
5738
|
+
* @returns Promise<ProductLink[]> Links array only
|
|
5739
|
+
*/
|
|
5740
|
+
listData: (invMastUid: number) => Promise<{
|
|
5741
|
+
productLinkUid: number;
|
|
5742
|
+
parentInvMastUid: number;
|
|
5743
|
+
childInvMastUid: number;
|
|
5744
|
+
parentItemId: string;
|
|
5745
|
+
childItemId: string;
|
|
5746
|
+
linkType: string;
|
|
5747
|
+
dateCreated?: string | undefined;
|
|
5748
|
+
dateLastModified?: string | undefined;
|
|
5749
|
+
createdBy?: string | undefined;
|
|
5750
|
+
lastMaintainedBy?: string | undefined;
|
|
5751
|
+
isActive?: string | undefined;
|
|
5752
|
+
displayOrder?: number | undefined;
|
|
5753
|
+
linkDescription?: string | undefined;
|
|
5754
|
+
}[]>;
|
|
5755
|
+
};
|
|
5756
|
+
/**
|
|
5757
|
+
* Inventory Master Sub Parts - Direct OpenAPI Path Mirror
|
|
5758
|
+
* @description New OpenAPI endpoint for listing sub parts for an item
|
|
5759
|
+
*
|
|
5760
|
+
* **CRITICAL: This endpoint follows OpenAPI Path Mirroring Pattern**
|
|
5761
|
+
* OpenAPI Path: /inv-mast-sub-parts/{invMastUid} → api.items.invMastSubParts.list()
|
|
5762
|
+
*/
|
|
5763
|
+
invMastSubParts: {
|
|
5764
|
+
/**
|
|
5765
|
+
* List sub parts for an inventory master item
|
|
5766
|
+
*
|
|
5767
|
+
* @fullPath api.items.invMastSubParts.list
|
|
5768
|
+
* @service items
|
|
5769
|
+
* @domain inventory-management
|
|
5770
|
+
* @dataMethod listData - returns only the sub parts array without metadata
|
|
5771
|
+
* @discoverable true
|
|
5772
|
+
* @searchTerms ["inventory sub parts", "item subparts", "product parts", "inv mast subparts", "component parts"]
|
|
5773
|
+
* @relatedEndpoints ["api.items.subparts.list", "api.items.invMast.get", "api.items.invMastLinks.list"]
|
|
5774
|
+
* @commonPatterns ["Get item sub parts", "Find product components", "Parts management"]
|
|
5775
|
+
* @workflow ["inventory-management", "parts-management", "product-assembly"]
|
|
5776
|
+
* @prerequisites ["Valid authentication token", "Inventory access permissions"]
|
|
5777
|
+
* @nextSteps ["api.items.invMast.get for part details", "api.items.subparts.get for specific subpart info"]
|
|
5778
|
+
* @businessRules ["Returns active sub parts only", "Optional filtering by links", "Ordered by display sequence"]
|
|
5779
|
+
* @functionalArea "inventory-master-management"
|
|
5780
|
+
* @caching "Cache for 15 minutes, invalidate on parts changes"
|
|
5781
|
+
* @performance "Supports optional filtering by inv mast links UID"
|
|
5782
|
+
*
|
|
5783
|
+
* @param invMastUid Inventory master unique identifier
|
|
5784
|
+
* @param params Optional filtering parameters
|
|
5785
|
+
* @returns Promise<InvMastSubPartsResponse> Complete response with sub parts array and metadata
|
|
5786
|
+
*
|
|
5787
|
+
* @example
|
|
5788
|
+
* ```typescript
|
|
5789
|
+
* // Get all sub parts for an item
|
|
5790
|
+
* const response = await api.items.invMastSubParts.list(12345);
|
|
5791
|
+
* console.log(response.data); // Subpart[]
|
|
5792
|
+
*
|
|
5793
|
+
* // Filter by specific link
|
|
5794
|
+
* const filtered = await api.items.invMastSubParts.list(12345, { invMastLinksUid: 67890 });
|
|
5795
|
+
*
|
|
5796
|
+
* // Get just the data
|
|
5797
|
+
* const parts = await api.items.invMastSubParts.listData(12345);
|
|
5798
|
+
* ```
|
|
5799
|
+
*/
|
|
5800
|
+
list: (invMastUid: number, params?: InvMastSubPartsParams) => Promise<InvMastSubPartsResponse>;
|
|
5801
|
+
/**
|
|
5802
|
+
* List sub parts data only
|
|
5803
|
+
* @description Returns only the sub parts array without BaseResponse wrapper
|
|
5804
|
+
* @param invMastUid Inventory master unique identifier
|
|
5805
|
+
* @param params Optional filtering parameters
|
|
5806
|
+
* @returns Promise<Subpart[]> Sub parts array only
|
|
5807
|
+
*/
|
|
5808
|
+
listData: (invMastUid: number, params?: InvMastSubPartsParams) => Promise<{
|
|
5809
|
+
parentInvMastUid: number;
|
|
5810
|
+
childInvMastUid: number;
|
|
5811
|
+
parentItemId: string;
|
|
5812
|
+
childItemId: string;
|
|
5813
|
+
subPartUid: number;
|
|
5814
|
+
qtyRequired: number;
|
|
5815
|
+
description?: string | undefined;
|
|
5816
|
+
dateCreated?: string | undefined;
|
|
5817
|
+
dateLastModified?: string | undefined;
|
|
5818
|
+
unitOfMeasure?: string | undefined;
|
|
5819
|
+
createdBy?: string | undefined;
|
|
5820
|
+
lastMaintainedBy?: string | undefined;
|
|
5821
|
+
isActive?: string | undefined;
|
|
5822
|
+
displayOrder?: number | undefined;
|
|
5823
|
+
childItemDesc?: string | undefined;
|
|
5824
|
+
isOptional?: string | undefined;
|
|
5825
|
+
}[]>;
|
|
5826
|
+
};
|
|
5827
|
+
/**
|
|
5828
|
+
* User Favorites (User-based) - Direct OpenAPI Path Mirror
|
|
5829
|
+
* @description New OpenAPI endpoints for user-specific item favorites
|
|
5830
|
+
*
|
|
5831
|
+
* **CRITICAL: This endpoint follows OpenAPI Path Mirroring Pattern**
|
|
5832
|
+
* OpenAPI Paths:
|
|
5833
|
+
* - /item-favorites/{usersId} → api.items.itemFavorites.list()
|
|
5834
|
+
* - /item-favorites/{usersId}/{invMastUid} → api.items.itemFavorites.get/create/delete()
|
|
5835
|
+
*/
|
|
5836
|
+
itemFavorites: {
|
|
5837
|
+
/**
|
|
5838
|
+
* List favorites for a specific user
|
|
5839
|
+
*
|
|
5840
|
+
* @fullPath api.items.itemFavorites.list
|
|
5841
|
+
* @service items
|
|
5842
|
+
* @domain user-management
|
|
5843
|
+
* @dataMethod listData - returns only the favorites array without metadata
|
|
5844
|
+
* @discoverable true
|
|
5845
|
+
* @searchTerms ["user favorites", "item favorites", "user wishlist", "favorite products", "bookmarked items"]
|
|
5846
|
+
* @relatedEndpoints ["api.items.favorites.list", "api.joomla.users.get", "api.items.itemWishlist.list"]
|
|
5847
|
+
* @commonPatterns ["Get user's favorite items", "User preference management", "Personalized catalogs"]
|
|
5848
|
+
* @workflow ["user-experience", "personalization", "catalog-management"]
|
|
5849
|
+
* @prerequisites ["Valid authentication token", "User access permissions"]
|
|
5850
|
+
* @nextSteps ["api.items.invMast.get for item details", "api.items.itemFavorites.create to add favorites"]
|
|
5851
|
+
* @businessRules ["User can only see their own favorites", "Returns active favorites only"]
|
|
5852
|
+
* @functionalArea "user-and-account-management"
|
|
5853
|
+
* @caching "Cache for 5 minutes per user, invalidate on user changes"
|
|
5854
|
+
* @performance "Indexed by user ID for fast retrieval"
|
|
5855
|
+
*
|
|
5856
|
+
* @param usersId User unique identifier
|
|
5857
|
+
* @returns Promise<ItemFavoritesListResponse> Complete response with user favorites array and metadata
|
|
5858
|
+
*
|
|
5859
|
+
* @example
|
|
5860
|
+
* ```typescript
|
|
5861
|
+
* // Get all favorites for a user
|
|
5862
|
+
* const response = await api.items.itemFavorites.list(123);
|
|
5863
|
+
* console.log(response.data); // ItemFavorite[]
|
|
5864
|
+
*
|
|
5865
|
+
* // Get just the data
|
|
5866
|
+
* const favorites = await api.items.itemFavorites.listData(123);
|
|
5867
|
+
* ```
|
|
5868
|
+
*/
|
|
5869
|
+
list: (usersId: number) => Promise<ItemFavoritesListResponse>;
|
|
5870
|
+
/**
|
|
5871
|
+
* Create a favorite item for a user
|
|
5872
|
+
*
|
|
5873
|
+
* @fullPath api.items.itemFavorites.create
|
|
5874
|
+
* @service items
|
|
5875
|
+
* @domain user-management
|
|
5876
|
+
* @dataMethod N/A - creation operation
|
|
5877
|
+
* @discoverable true
|
|
5878
|
+
* @searchTerms ["add favorite", "bookmark item", "save favorite", "user preferences"]
|
|
5879
|
+
* @relatedEndpoints ["api.items.itemFavorites.list", "api.items.itemFavorites.delete"]
|
|
5880
|
+
* @commonPatterns ["Add item to favorites", "Bookmark product", "User preference setting"]
|
|
5881
|
+
* @workflow ["user-experience", "personalization"]
|
|
5882
|
+
* @prerequisites ["Valid authentication token", "User must own the favorites"]
|
|
5883
|
+
* @nextSteps ["api.items.itemFavorites.list to view updated favorites"]
|
|
5884
|
+
* @businessRules ["Users can only manage their own favorites", "Prevents duplicate favorites"]
|
|
5885
|
+
* @functionalArea "user-and-account-management"
|
|
5886
|
+
* @performance "Fast creation with duplicate prevention"
|
|
5887
|
+
*
|
|
5888
|
+
* @param usersId User unique identifier
|
|
5889
|
+
* @returns Promise<ItemFavoritesItemResponse> Complete response with created favorite and metadata
|
|
5890
|
+
*
|
|
5891
|
+
* @example
|
|
5892
|
+
* ```typescript
|
|
5893
|
+
* // Add item to user's favorites
|
|
5894
|
+
* const response = await api.items.itemFavorites.create(123);
|
|
5895
|
+
* console.log(response.data); // ItemFavorite
|
|
5896
|
+
* ```
|
|
5897
|
+
*/
|
|
5898
|
+
create: (usersId: number) => Promise<ItemFavoritesItemResponse>;
|
|
5899
|
+
/**
|
|
5900
|
+
* Get specific favorite item for a user
|
|
5901
|
+
*
|
|
5902
|
+
* @fullPath api.items.itemFavorites.get
|
|
5903
|
+
* @service items
|
|
5904
|
+
* @domain user-management
|
|
5905
|
+
* @dataMethod getData - returns only the favorite data without metadata
|
|
5906
|
+
* @discoverable true
|
|
5907
|
+
* @searchTerms ["get favorite", "check favorite", "favorite status", "user item preference"]
|
|
5908
|
+
* @relatedEndpoints ["api.items.itemFavorites.list", "api.items.invMast.get"]
|
|
5909
|
+
* @commonPatterns ["Check if item is favorited", "Get favorite details"]
|
|
5910
|
+
* @workflow ["user-experience", "personalization"]
|
|
5911
|
+
* @prerequisites ["Valid authentication token", "User access permissions"]
|
|
5912
|
+
* @nextSteps ["api.items.invMast.get for full item details"]
|
|
5913
|
+
* @businessRules ["Users can only see their own favorites", "Returns 404 if not favorited"]
|
|
5914
|
+
* @functionalArea "user-and-account-management"
|
|
5915
|
+
* @performance "Direct lookup by user and item IDs"
|
|
5916
|
+
*
|
|
5917
|
+
* @param usersId User unique identifier
|
|
5918
|
+
* @param invMastUid Inventory master unique identifier
|
|
5919
|
+
* @returns Promise<ItemFavoritesItemResponse> Complete response with favorite details and metadata
|
|
5920
|
+
*
|
|
5921
|
+
* @example
|
|
5922
|
+
* ```typescript
|
|
5923
|
+
* // Check if user has favorited specific item
|
|
5924
|
+
* const response = await api.items.itemFavorites.get(123, 12345);
|
|
5925
|
+
* console.log(response.data); // ItemFavorite or null
|
|
5926
|
+
*
|
|
5927
|
+
* // Get just the data
|
|
5928
|
+
* const favorite = await api.items.itemFavorites.getData(123, 12345);
|
|
5929
|
+
* ```
|
|
5930
|
+
*/
|
|
5931
|
+
get: (usersId: number, invMastUid: number) => Promise<ItemFavoritesItemResponse>;
|
|
5932
|
+
/**
|
|
5933
|
+
* Delete specific favorite item for a user
|
|
5934
|
+
*
|
|
5935
|
+
* @fullPath api.items.itemFavorites.delete
|
|
5936
|
+
* @service items
|
|
5937
|
+
* @domain user-management
|
|
5938
|
+
* @dataMethod N/A - deletion operation
|
|
5939
|
+
* @discoverable true
|
|
5940
|
+
* @searchTerms ["remove favorite", "delete favorite", "unfavorite", "remove bookmark"]
|
|
5941
|
+
* @relatedEndpoints ["api.items.itemFavorites.list", "api.items.itemFavorites.create"]
|
|
5942
|
+
* @commonPatterns ["Remove from favorites", "Unfavorite item", "User preference removal"]
|
|
5943
|
+
* @workflow ["user-experience", "personalization"]
|
|
5944
|
+
* @prerequisites ["Valid authentication token", "User must own the favorite"]
|
|
5945
|
+
* @nextSteps ["api.items.itemFavorites.list to view updated favorites"]
|
|
5946
|
+
* @businessRules ["Users can only delete their own favorites", "Idempotent operation"]
|
|
5947
|
+
* @functionalArea "user-and-account-management"
|
|
5948
|
+
* @performance "Fast deletion with proper cleanup"
|
|
5949
|
+
*
|
|
5950
|
+
* @param usersId User unique identifier
|
|
5951
|
+
* @param invMastUid Inventory master unique identifier
|
|
5952
|
+
* @returns Promise<UserFavoriteResponse> Complete response confirming deletion
|
|
5953
|
+
*
|
|
5954
|
+
* @example
|
|
5955
|
+
* ```typescript
|
|
5956
|
+
* // Remove item from user's favorites
|
|
5957
|
+
* const response = await api.items.itemFavorites.delete(123, 12345);
|
|
5958
|
+
* console.log(response.success); // true
|
|
5959
|
+
* ```
|
|
5960
|
+
*/
|
|
5961
|
+
delete: (usersId: number, invMastUid: number) => Promise<ItemFavoritesItemResponse>;
|
|
5962
|
+
/**
|
|
5963
|
+
* Update specific favorite item for a user
|
|
5964
|
+
*
|
|
5965
|
+
* @fullPath api.items.itemFavorites.update
|
|
5966
|
+
* @service items
|
|
5967
|
+
* @domain user-management
|
|
5968
|
+
* @dataMethod N/A - update operation
|
|
5969
|
+
* @discoverable true
|
|
5970
|
+
* @searchTerms ["update favorite", "modify favorite", "favorite metadata", "user preference update"]
|
|
5971
|
+
* @relatedEndpoints ["api.items.itemFavorites.get", "api.items.itemFavorites.list"]
|
|
5972
|
+
* @commonPatterns ["Update favorite details", "Modify user preference"]
|
|
5973
|
+
* @workflow ["user-experience", "personalization"]
|
|
5974
|
+
* @prerequisites ["Valid authentication token", "User must own the favorite", "Favorite must exist"]
|
|
5975
|
+
* @nextSteps ["api.items.itemFavorites.get to verify changes"]
|
|
5976
|
+
* @businessRules ["Users can only update their own favorites", "Maintains favorite relationship"]
|
|
5977
|
+
* @functionalArea "user-and-account-management"
|
|
5978
|
+
* @performance "Direct update by user and item IDs"
|
|
5979
|
+
*
|
|
5980
|
+
* @param usersId User unique identifier
|
|
5981
|
+
* @param invMastUid Inventory master unique identifier
|
|
5982
|
+
* @returns Promise<ItemFavoritesItemResponse> Complete response with updated favorite and metadata
|
|
5983
|
+
*
|
|
5984
|
+
* @example
|
|
5985
|
+
* ```typescript
|
|
5986
|
+
* // Update user's favorite item metadata
|
|
5987
|
+
* const response = await api.items.itemFavorites.update(123, 12345);
|
|
5988
|
+
* console.log(response.data); // Updated ItemFavorite
|
|
5989
|
+
* ```
|
|
5990
|
+
*/
|
|
5991
|
+
update: (usersId: number, invMastUid: number) => Promise<ItemFavoritesItemResponse>;
|
|
5992
|
+
/**
|
|
5993
|
+
* Data-only methods for item favorites
|
|
5994
|
+
*/
|
|
5995
|
+
listData: (usersId: number) => Promise<{
|
|
5996
|
+
invMastUid: number;
|
|
5997
|
+
itemId: string;
|
|
5998
|
+
usersId: number;
|
|
5999
|
+
itemFavoritesUid: number;
|
|
6000
|
+
dateCreated?: string | undefined;
|
|
6001
|
+
dateLastModified?: string | undefined;
|
|
6002
|
+
itemDesc?: string | undefined;
|
|
6003
|
+
createdBy?: string | undefined;
|
|
6004
|
+
lastMaintainedBy?: string | undefined;
|
|
6005
|
+
}[]>;
|
|
6006
|
+
getData: (usersId: number, invMastUid: number) => Promise<{
|
|
6007
|
+
invMastUid: number;
|
|
6008
|
+
itemId: string;
|
|
6009
|
+
usersId: number;
|
|
6010
|
+
itemFavoritesUid: number;
|
|
6011
|
+
dateCreated?: string | undefined;
|
|
6012
|
+
dateLastModified?: string | undefined;
|
|
6013
|
+
itemDesc?: string | undefined;
|
|
6014
|
+
createdBy?: string | undefined;
|
|
6015
|
+
lastMaintainedBy?: string | undefined;
|
|
6016
|
+
}>;
|
|
6017
|
+
};
|
|
5877
6018
|
}
|
|
5878
6019
|
export {};
|
|
5879
6020
|
//# sourceMappingURL=client.d.ts.map
|