@simpleapps-com/augur-api 0.2.12 → 0.3.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 +8 -8
- package/PERFORMANCE.md +7 -7
- package/QUICKSTART.md +4 -4
- package/README.md +84 -18
- package/dist/cjs/index.d.ts +1 -1
- package/dist/cjs/index.d.ts.map +1 -1
- package/dist/cjs/index.js +1 -1
- package/dist/cjs/index.js.map +1 -1
- package/dist/cjs/services/customers/client.d.ts +4 -4
- package/dist/cjs/services/customers/schemas/addresses.d.ts +10 -10
- package/dist/cjs/services/customers/schemas/contacts.d.ts +16 -16
- package/dist/cjs/services/items/client.d.ts +5191 -1327
- package/dist/cjs/services/items/client.d.ts.map +1 -1
- package/dist/cjs/services/items/client.js +2983 -334
- package/dist/cjs/services/items/client.js.map +1 -1
- package/dist/cjs/services/items/schemas/bins.d.ts +855 -0
- package/dist/cjs/services/items/schemas/bins.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/bins.js +85 -0
- package/dist/cjs/services/items/schemas/bins.js.map +1 -0
- package/dist/cjs/services/items/schemas/brandItems.d.ts +401 -0
- package/dist/cjs/services/items/schemas/brandItems.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/brandItems.js +48 -0
- package/dist/cjs/services/items/schemas/brandItems.js.map +1 -0
- package/dist/cjs/services/items/schemas/faq.d.ts +438 -0
- package/dist/cjs/services/items/schemas/faq.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/faq.js +57 -0
- package/dist/cjs/services/items/schemas/faq.js.map +1 -0
- package/dist/cjs/services/items/schemas/favorites.d.ts +315 -0
- package/dist/cjs/services/items/schemas/favorites.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/favorites.js +38 -0
- package/dist/cjs/services/items/schemas/favorites.js.map +1 -0
- package/dist/cjs/services/items/schemas/index.d.ts +8 -0
- package/dist/cjs/services/items/schemas/index.d.ts.map +1 -1
- package/dist/cjs/services/items/schemas/index.js +8 -0
- package/dist/cjs/services/items/schemas/index.js.map +1 -1
- package/dist/cjs/services/items/schemas/productLinks.d.ts +398 -0
- package/dist/cjs/services/items/schemas/productLinks.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/productLinks.js +47 -0
- package/dist/cjs/services/items/schemas/productLinks.js.map +1 -0
- package/dist/cjs/services/items/schemas/subparts.d.ts +461 -0
- package/dist/cjs/services/items/schemas/subparts.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/subparts.js +54 -0
- package/dist/cjs/services/items/schemas/subparts.js.map +1 -0
- package/dist/cjs/services/items/schemas/variants.d.ts +1255 -0
- package/dist/cjs/services/items/schemas/variants.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/variants.js +96 -0
- package/dist/cjs/services/items/schemas/variants.js.map +1 -0
- package/dist/cjs/services/items/schemas/wishlists.d.ts +1061 -0
- package/dist/cjs/services/items/schemas/wishlists.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/wishlists.js +81 -0
- package/dist/cjs/services/items/schemas/wishlists.js.map +1 -0
- package/dist/cjs/services/legacy/client.d.ts +15 -15
- package/dist/cjs/services/legacy/client.d.ts.map +1 -1
- package/dist/cjs/services/legacy/client.js +15 -15
- package/dist/cjs/services/legacy/client.js.map +1 -1
- package/dist/cjs/services/orders/client.d.ts +150 -98
- package/dist/cjs/services/orders/client.d.ts.map +1 -1
- package/dist/cjs/services/orders/client.js +61 -61
- package/dist/cjs/services/orders/client.js.map +1 -1
- package/dist/cjs/services/orders/schemas/purchase-orders.d.ts +603 -277
- package/dist/cjs/services/orders/schemas/purchase-orders.d.ts.map +1 -1
- package/dist/cjs/services/orders/schemas/purchase-orders.js +40 -20
- package/dist/cjs/services/orders/schemas/purchase-orders.js.map +1 -1
- package/dist/cjs/services/p21-pim/client.d.ts +2 -2
- package/dist/cjs/services/p21-pim/client.d.ts.map +1 -1
- package/dist/cjs/services/p21-pim/client.js +2 -2
- package/dist/cjs/services/p21-pim/client.js.map +1 -1
- package/dist/cjs/services/p21-sism/client.d.ts +3 -3
- package/dist/cjs/services/p21-sism/client.d.ts.map +1 -1
- package/dist/cjs/services/p21-sism/client.js +4 -4
- package/dist/cjs/services/p21-sism/client.js.map +1 -1
- package/dist/cjs/services/pricing/client.d.ts +69 -57
- package/dist/cjs/services/pricing/client.d.ts.map +1 -1
- package/dist/cjs/services/pricing/client.js +87 -75
- package/dist/cjs/services/pricing/client.js.map +1 -1
- package/dist/cjs/services/vmi/client.d.ts +17 -17
- package/dist/cjs/services/vmi/client.d.ts.map +1 -1
- package/dist/cjs/services/vmi/client.js +29 -29
- package/dist/cjs/services/vmi/client.js.map +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.d.ts.map +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/services/customers/client.d.ts +4 -4
- package/dist/esm/services/customers/schemas/addresses.d.ts +10 -10
- package/dist/esm/services/customers/schemas/contacts.d.ts +16 -16
- package/dist/esm/services/items/client.d.ts +5191 -1327
- package/dist/esm/services/items/client.d.ts.map +1 -1
- package/dist/esm/services/items/client.js +3001 -337
- package/dist/esm/services/items/client.js.map +1 -1
- package/dist/esm/services/items/schemas/bins.d.ts +855 -0
- package/dist/esm/services/items/schemas/bins.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/bins.js +82 -0
- package/dist/esm/services/items/schemas/bins.js.map +1 -0
- package/dist/esm/services/items/schemas/brandItems.d.ts +401 -0
- package/dist/esm/services/items/schemas/brandItems.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/brandItems.js +45 -0
- package/dist/esm/services/items/schemas/brandItems.js.map +1 -0
- package/dist/esm/services/items/schemas/faq.d.ts +438 -0
- package/dist/esm/services/items/schemas/faq.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/faq.js +54 -0
- package/dist/esm/services/items/schemas/faq.js.map +1 -0
- package/dist/esm/services/items/schemas/favorites.d.ts +315 -0
- package/dist/esm/services/items/schemas/favorites.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/favorites.js +35 -0
- package/dist/esm/services/items/schemas/favorites.js.map +1 -0
- package/dist/esm/services/items/schemas/index.d.ts +8 -0
- package/dist/esm/services/items/schemas/index.d.ts.map +1 -1
- package/dist/esm/services/items/schemas/index.js +8 -0
- package/dist/esm/services/items/schemas/index.js.map +1 -1
- package/dist/esm/services/items/schemas/productLinks.d.ts +398 -0
- package/dist/esm/services/items/schemas/productLinks.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/productLinks.js +44 -0
- package/dist/esm/services/items/schemas/productLinks.js.map +1 -0
- package/dist/esm/services/items/schemas/subparts.d.ts +461 -0
- package/dist/esm/services/items/schemas/subparts.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/subparts.js +51 -0
- package/dist/esm/services/items/schemas/subparts.js.map +1 -0
- package/dist/esm/services/items/schemas/variants.d.ts +1255 -0
- package/dist/esm/services/items/schemas/variants.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/variants.js +93 -0
- package/dist/esm/services/items/schemas/variants.js.map +1 -0
- package/dist/esm/services/items/schemas/wishlists.d.ts +1061 -0
- package/dist/esm/services/items/schemas/wishlists.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/wishlists.js +78 -0
- package/dist/esm/services/items/schemas/wishlists.js.map +1 -0
- package/dist/esm/services/legacy/client.d.ts +15 -15
- package/dist/esm/services/legacy/client.d.ts.map +1 -1
- package/dist/esm/services/legacy/client.js +15 -15
- package/dist/esm/services/legacy/client.js.map +1 -1
- package/dist/esm/services/orders/client.d.ts +150 -98
- package/dist/esm/services/orders/client.d.ts.map +1 -1
- package/dist/esm/services/orders/client.js +61 -61
- package/dist/esm/services/orders/client.js.map +1 -1
- package/dist/esm/services/orders/schemas/purchase-orders.d.ts +603 -277
- package/dist/esm/services/orders/schemas/purchase-orders.d.ts.map +1 -1
- package/dist/esm/services/orders/schemas/purchase-orders.js +40 -20
- package/dist/esm/services/orders/schemas/purchase-orders.js.map +1 -1
- package/dist/esm/services/p21-pim/client.d.ts +2 -2
- package/dist/esm/services/p21-pim/client.d.ts.map +1 -1
- package/dist/esm/services/p21-pim/client.js +2 -2
- package/dist/esm/services/p21-pim/client.js.map +1 -1
- package/dist/esm/services/p21-sism/client.d.ts +3 -3
- package/dist/esm/services/p21-sism/client.d.ts.map +1 -1
- package/dist/esm/services/p21-sism/client.js +4 -4
- package/dist/esm/services/p21-sism/client.js.map +1 -1
- package/dist/esm/services/pricing/client.d.ts +69 -57
- package/dist/esm/services/pricing/client.d.ts.map +1 -1
- package/dist/esm/services/pricing/client.js +87 -75
- package/dist/esm/services/pricing/client.js.map +1 -1
- package/dist/esm/services/vmi/client.d.ts +17 -17
- package/dist/esm/services/vmi/client.d.ts.map +1 -1
- package/dist/esm/services/vmi/client.js +29 -29
- package/dist/esm/services/vmi/client.js.map +1 -1
- package/dist/types/index.d.ts +1 -1
- package/dist/types/index.d.ts.map +1 -1
- package/dist/types/services/customers/client.d.ts +4 -4
- package/dist/types/services/customers/schemas/addresses.d.ts +10 -10
- package/dist/types/services/customers/schemas/contacts.d.ts +16 -16
- package/dist/types/services/items/client.d.ts +5191 -1327
- package/dist/types/services/items/client.d.ts.map +1 -1
- package/dist/types/services/items/schemas/bins.d.ts +855 -0
- package/dist/types/services/items/schemas/bins.d.ts.map +1 -0
- package/dist/types/services/items/schemas/brandItems.d.ts +401 -0
- package/dist/types/services/items/schemas/brandItems.d.ts.map +1 -0
- package/dist/types/services/items/schemas/faq.d.ts +438 -0
- package/dist/types/services/items/schemas/faq.d.ts.map +1 -0
- package/dist/types/services/items/schemas/favorites.d.ts +315 -0
- package/dist/types/services/items/schemas/favorites.d.ts.map +1 -0
- package/dist/types/services/items/schemas/index.d.ts +8 -0
- package/dist/types/services/items/schemas/index.d.ts.map +1 -1
- package/dist/types/services/items/schemas/productLinks.d.ts +398 -0
- package/dist/types/services/items/schemas/productLinks.d.ts.map +1 -0
- package/dist/types/services/items/schemas/subparts.d.ts +461 -0
- package/dist/types/services/items/schemas/subparts.d.ts.map +1 -0
- package/dist/types/services/items/schemas/variants.d.ts +1255 -0
- package/dist/types/services/items/schemas/variants.d.ts.map +1 -0
- package/dist/types/services/items/schemas/wishlists.d.ts +1061 -0
- package/dist/types/services/items/schemas/wishlists.d.ts.map +1 -0
- package/dist/types/services/legacy/client.d.ts +15 -15
- package/dist/types/services/legacy/client.d.ts.map +1 -1
- package/dist/types/services/orders/client.d.ts +150 -98
- package/dist/types/services/orders/client.d.ts.map +1 -1
- package/dist/types/services/orders/schemas/purchase-orders.d.ts +603 -277
- package/dist/types/services/orders/schemas/purchase-orders.d.ts.map +1 -1
- package/dist/types/services/p21-pim/client.d.ts +2 -2
- package/dist/types/services/p21-pim/client.d.ts.map +1 -1
- package/dist/types/services/p21-sism/client.d.ts +3 -3
- package/dist/types/services/p21-sism/client.d.ts.map +1 -1
- package/dist/types/services/pricing/client.d.ts +69 -57
- package/dist/types/services/pricing/client.d.ts.map +1 -1
- package/dist/types/services/vmi/client.d.ts +17 -17
- package/dist/types/services/vmi/client.d.ts.map +1 -1
- package/package.json +1 -1
package/API-DISCOVERY.md
CHANGED
|
@@ -32,12 +32,12 @@ The discovery system doesn't just match keywords - it understands business proce
|
|
|
32
32
|
const results = await api.findEndpoint('customer satisfaction analytics');
|
|
33
33
|
// Intelligently maps to:
|
|
34
34
|
// - api.customers.customer.get (customer profiles)
|
|
35
|
-
// - api.orders.
|
|
35
|
+
// - api.orders.oeHdr.lookup (purchase history)
|
|
36
36
|
// - api.p21Pim.items.suggestWebDescription (product experience)
|
|
37
37
|
|
|
38
38
|
const qualityControl = await api.findEndpoint('inventory quality assurance');
|
|
39
39
|
// Discovers:
|
|
40
|
-
// - api.vmi.
|
|
40
|
+
// - api.vmi.invProfileHdr.checkAvailability (stock validation)
|
|
41
41
|
// - api.vmi.warehouses.list (distribution quality)
|
|
42
42
|
// - api.nexus.binTransfers.list (movement tracking)
|
|
43
43
|
```
|
|
@@ -53,15 +53,15 @@ const userWorkflow = await api.findEndpoint('user account management');
|
|
|
53
53
|
// 1. Authentication: api.joomla.users.verifyPassword
|
|
54
54
|
// 2. Profile creation: api.customers.customer.create
|
|
55
55
|
// 3. Permission setup: api.joomla.userGroups.list
|
|
56
|
-
// 4. Order access: api.orders.
|
|
56
|
+
// 4. Order access: api.orders.oeHdrSalesrep.getOrders
|
|
57
57
|
|
|
58
58
|
// Inventory management reveals pricing connections
|
|
59
59
|
const inventoryOps = await api.findEndpoint('warehouse operations');
|
|
60
60
|
// Platform intelligence connects:
|
|
61
|
-
// 1. Stock levels: api.vmi.
|
|
61
|
+
// 1. Stock levels: api.vmi.invProfileHdr.checkAvailability
|
|
62
62
|
// 2. Pricing context: api.pricing.getPrice
|
|
63
63
|
// 3. Product details: api.items.products.get
|
|
64
|
-
// 4. Replenishment: api.vmi.
|
|
64
|
+
// 4. Replenishment: api.vmi.invProfileHdr.replenish
|
|
65
65
|
```
|
|
66
66
|
|
|
67
67
|
## Advanced Discovery Capabilities
|
|
@@ -111,7 +111,7 @@ Every endpoint includes comprehensive semantic metadata for AI agents:
|
|
|
111
111
|
|
|
112
112
|
```typescript
|
|
113
113
|
/**
|
|
114
|
-
* @fullPath api.vmi.
|
|
114
|
+
* @fullPath api.vmi.invProfileHdr.checkAvailability
|
|
115
115
|
* @service vmi
|
|
116
116
|
* @domain inventory-management
|
|
117
117
|
* @searchTerms ["inventory", "stock levels", "availability", "warehouse"]
|
|
@@ -164,9 +164,9 @@ const customerAcquisition = await api.findEndpoint('new customer onboarding');
|
|
|
164
164
|
// Supply chain workflow intelligence
|
|
165
165
|
const supplyChain = await api.findEndpoint('inventory replenishment automation');
|
|
166
166
|
// Cross-service workflow mapping:
|
|
167
|
-
// Monitor: api.vmi.
|
|
167
|
+
// Monitor: api.vmi.invProfileHdr.checkAvailability
|
|
168
168
|
// Calculate: api.pricing.getPrice (reorder costs)
|
|
169
|
-
// Execute: api.vmi.
|
|
169
|
+
// Execute: api.vmi.invProfileHdr.replenish
|
|
170
170
|
// Track: api.nexus.binTransfers.list
|
|
171
171
|
// Verify: api.vmi.warehouses.list (distribution status)
|
|
172
172
|
```
|
package/PERFORMANCE.md
CHANGED
|
@@ -58,7 +58,7 @@ const cart = await api.commerce.cartHeaders.list({
|
|
|
58
58
|
edgeCache: 1 // Cart contents change frequently
|
|
59
59
|
});
|
|
60
60
|
|
|
61
|
-
const inventory = await api.vmi.
|
|
61
|
+
const inventory = await api.vmi.invProfileHdr.checkAvailability(warehouseId, {
|
|
62
62
|
edgeCache: 1 // Inventory levels change constantly
|
|
63
63
|
});
|
|
64
64
|
|
|
@@ -307,7 +307,7 @@ class CommerceBatchOperations {
|
|
|
307
307
|
)),
|
|
308
308
|
|
|
309
309
|
// Inventory availability
|
|
310
|
-
api.vmi.
|
|
310
|
+
api.vmi.invProfileHdr.checkAvailability(123, {
|
|
311
311
|
q: 'featured',
|
|
312
312
|
edgeCache: 2
|
|
313
313
|
})
|
|
@@ -329,7 +329,7 @@ class VMIBatchOperations {
|
|
|
329
329
|
|
|
330
330
|
// Inventory levels for all warehouses
|
|
331
331
|
Promise.all(warehouseIds.map(id =>
|
|
332
|
-
api.vmi.
|
|
332
|
+
api.vmi.invProfileHdr.checkAvailability(id, { edgeCache: 2 })
|
|
333
333
|
)),
|
|
334
334
|
|
|
335
335
|
// Distributor information
|
|
@@ -350,8 +350,8 @@ class VMIBatchOperations {
|
|
|
350
350
|
static async loadReplenishmentPlan(warehouseId: number) {
|
|
351
351
|
// Replenishment analysis batch
|
|
352
352
|
const [availability, replenishmentInfo, distributors] = await Promise.allSettled([
|
|
353
|
-
api.vmi.
|
|
354
|
-
api.vmi.
|
|
353
|
+
api.vmi.invProfileHdr.checkAvailability(warehouseId, { edgeCache: 1 }),
|
|
354
|
+
api.vmi.invProfileHdr.getReplenishmentInfo(warehouseId, {
|
|
355
355
|
distributorsUid: 1,
|
|
356
356
|
edgeCache: 3
|
|
357
357
|
}),
|
|
@@ -573,7 +573,7 @@ class InventoryPagination extends SmartPagination {
|
|
|
573
573
|
const pageSize = 100; // Large batches for processing
|
|
574
574
|
|
|
575
575
|
while (true) {
|
|
576
|
-
const result = await api.vmi.
|
|
576
|
+
const result = await api.vmi.invProfileHdr.checkAvailability(warehouseId, {
|
|
577
577
|
offset: page * pageSize,
|
|
578
578
|
limit: pageSize,
|
|
579
579
|
edgeCache: 1 // Short cache for inventory data
|
|
@@ -797,7 +797,7 @@ const api = monitor.createMonitoredAPI({
|
|
|
797
797
|
// Use API normally, monitoring happens automatically
|
|
798
798
|
await api.joomla.users.list({ limit: 50, edgeCache: 2 });
|
|
799
799
|
await api.pricing.getPrice({ customerId: 12345, itemId: 'ITEM-1' });
|
|
800
|
-
await api.vmi.
|
|
800
|
+
await api.vmi.invProfileHdr.checkAvailability(123);
|
|
801
801
|
|
|
802
802
|
// Get performance insights
|
|
803
803
|
setTimeout(() => {
|
package/QUICKSTART.md
CHANGED
|
@@ -33,7 +33,7 @@ const pricing = await api.findEndpoint('product pricing');
|
|
|
33
33
|
|
|
34
34
|
// Code that reads like business requirements
|
|
35
35
|
const users = await api.joomla.users.list({ limit: 10, edgeCache: 2 });
|
|
36
|
-
const availability = await api.vmi.
|
|
36
|
+
const availability = await api.vmi.invProfileHdr.checkAvailability(warehouse);
|
|
37
37
|
const price = await api.pricing.getPrice({ customerId, itemId, quantity });
|
|
38
38
|
```
|
|
39
39
|
|
|
@@ -139,12 +139,12 @@ const warehouses = await api.vmi.warehouses.list({
|
|
|
139
139
|
edgeCache: 4 // Reference data cached longer
|
|
140
140
|
});
|
|
141
141
|
|
|
142
|
-
const availability = await api.vmi.
|
|
142
|
+
const availability = await api.vmi.invProfileHdr.checkAvailability(warehouses.data[0].warehouse_uid, {
|
|
143
143
|
q: 'electrical' // Smart search within inventory
|
|
144
144
|
});
|
|
145
145
|
|
|
146
146
|
// Context-aware replenishment
|
|
147
|
-
await api.vmi.
|
|
147
|
+
await api.vmi.invProfileHdr.replenish(warehouse.warehouse_uid, {
|
|
148
148
|
distributor_uid: 789,
|
|
149
149
|
restock_items: [
|
|
150
150
|
{ inv_mast_uid: 456, qty_to_order: 100.0 }
|
|
@@ -218,7 +218,7 @@ The platform connects you to comprehensive business operations across 13 microse
|
|
|
218
218
|
|-----------------|-------------------|-------------------|
|
|
219
219
|
| **User & Identity** | `joomla.users`, `customers.customer` | Cross-service user correlation |
|
|
220
220
|
| **E-commerce** | `commerce.cartHeaders`, `opensearch.itemSearch`, `pricing.getPrice` | Complete shopping workflows |
|
|
221
|
-
| **Inventory** | `vmi.warehouses`, `vmi.
|
|
221
|
+
| **Inventory** | `vmi.warehouses`, `vmi.invProfileHdr`, `items.products` | Supply chain intelligence |
|
|
222
222
|
| **Orders & Fulfillment** | `orders.orders`, `payments.unified`, `nexus.binTransfers` | End-to-end order processing |
|
|
223
223
|
| **Content & AI** | `agrSite.settings`, `p21Pim.items.suggestWebDescription` | AI-enhanced content management |
|
|
224
224
|
|
package/README.md
CHANGED
|
@@ -20,7 +20,7 @@ const pricing = await api.findEndpoint('product pricing');
|
|
|
20
20
|
|
|
21
21
|
// Code that understands your business domain
|
|
22
22
|
const users = await api.joomla.users.list({ limit: 10, edgeCache: 2 });
|
|
23
|
-
const availability = await api.vmi.
|
|
23
|
+
const availability = await api.vmi.invProfileHdr.checkAvailability(warehouse);
|
|
24
24
|
const price = await api.pricing.getPrice({ customerId, itemId, quantity });
|
|
25
25
|
```
|
|
26
26
|
|
|
@@ -32,6 +32,7 @@ const price = await api.pricing.getPrice({ customerId, itemId, quantity });
|
|
|
32
32
|
- [📖 API Discovery Guide](./API-DISCOVERY.md) - Natural language API navigation
|
|
33
33
|
- [Developer Experience Revolution](#developer-experience-revolution)
|
|
34
34
|
- [Context-Aware Architecture](#context-aware-architecture)
|
|
35
|
+
- [Prophet 21 Data Source Integration](#prophet-21-data-source-integration) - **ERP naming conventions and business context**
|
|
35
36
|
- [Installation & First Steps](#installation--first-steps)
|
|
36
37
|
- [Intelligent Discovery Examples](#intelligent-discovery-examples)
|
|
37
38
|
- [Cross-Service Intelligence](#cross-service-intelligence)
|
|
@@ -63,10 +64,10 @@ const api = AugurAPI.fromContext(context);
|
|
|
63
64
|
```typescript
|
|
64
65
|
// No documentation hunting, no API reference browsing
|
|
65
66
|
const results = await api.findEndpoint('inventory management');
|
|
66
|
-
// Instantly find: api.vmi.warehouses.list, api.vmi.
|
|
67
|
+
// Instantly find: api.vmi.warehouses.list, api.vmi.invProfileHdr.checkAvailability
|
|
67
68
|
|
|
68
69
|
// Your IDE becomes clairvoyant with comprehensive semantic JSDoc
|
|
69
|
-
api.vmi.
|
|
70
|
+
api.vmi.invProfileHdr. // ← Auto-complete shows exactly what you need
|
|
70
71
|
```
|
|
71
72
|
|
|
72
73
|
### Improvement of Daily Work 🔄
|
|
@@ -162,8 +163,8 @@ Every method includes rich semantic metadata for AI assistants:
|
|
|
162
163
|
// Ask your AI assistant: "Help me manage warehouse inventory"
|
|
163
164
|
// It instantly finds and suggests:
|
|
164
165
|
await api.vmi.warehouses.list({ customerId: 12345 });
|
|
165
|
-
await api.vmi.
|
|
166
|
-
await api.vmi.
|
|
166
|
+
await api.vmi.invProfileHdr.checkAvailability(warehouseId);
|
|
167
|
+
await api.vmi.invProfileHdr.replenish(warehouseId, { items });
|
|
167
168
|
```
|
|
168
169
|
|
|
169
170
|
### Factory Pattern Excellence
|
|
@@ -223,8 +224,8 @@ const userOps = await api.findEndpoint('customer account management');
|
|
|
223
224
|
|
|
224
225
|
const inventoryOps = await api.findEndpoint('stock replenishment');
|
|
225
226
|
// Returns:
|
|
226
|
-
// - api.vmi.
|
|
227
|
-
// - api.vmi.
|
|
227
|
+
// - api.vmi.invProfileHdr.checkAvailability (current levels)
|
|
228
|
+
// - api.vmi.invProfileHdr.replenish (automated ordering)
|
|
228
229
|
// - api.pricing.getPrice (cost calculations)
|
|
229
230
|
```
|
|
230
231
|
|
|
@@ -374,6 +375,71 @@ const users = await api.joomla.users.listData({ limit: 10 });
|
|
|
374
375
|
console.log(users); // Direct array access, no wrapper
|
|
375
376
|
```
|
|
376
377
|
|
|
378
|
+
## Prophet 21 Data Source Integration
|
|
379
|
+
|
|
380
|
+
Many API endpoints reflect Prophet 21 ERP system naming conventions and table structures. This provides direct mapping from your business processes to API operations.
|
|
381
|
+
|
|
382
|
+
### Understanding Prophet 21 Naming Patterns
|
|
383
|
+
|
|
384
|
+
The Path-Function Alignment Pattern preserves Prophet 21 table naming for user recognition:
|
|
385
|
+
|
|
386
|
+
```typescript
|
|
387
|
+
// Prophet 21 Table → API Endpoint → Client Structure
|
|
388
|
+
// inv_mast table → /inv-mast → api.items.invMast
|
|
389
|
+
// oe_hdr table → /oe-hdr → api.orders.oeHdr
|
|
390
|
+
// job_price_hdr table → /job-price-hdr → api.pricing.jobPriceHdr
|
|
391
|
+
// restock_hdr table → /restock-hdr → api.vmi.restockHdr
|
|
392
|
+
// inv_profile_hdr table → /inv-profile-hdr → api.vmi.invProfileHdr
|
|
393
|
+
|
|
394
|
+
// Examples with Prophet 21 context:
|
|
395
|
+
const inventory = await api.items.invMast.get(12345); // Inventory master record
|
|
396
|
+
const order = await api.orders.oeHdr.get(67890); // Order entry header
|
|
397
|
+
const pricing = await api.pricing.jobPriceHdr.get(111); // Job pricing header
|
|
398
|
+
const restock = await api.vmi.restockHdr.get(222); // Restocking header
|
|
399
|
+
const profile = await api.vmi.invProfileHdr.get(333); // Inventory profile header
|
|
400
|
+
```
|
|
401
|
+
|
|
402
|
+
### Prophet 21 Business Context
|
|
403
|
+
|
|
404
|
+
Understanding the ERP context helps predict API behavior:
|
|
405
|
+
|
|
406
|
+
```typescript
|
|
407
|
+
// Inventory Management (Prophet 21 inv_mast context)
|
|
408
|
+
const itemDetails = await api.items.invMast.get(itemId);
|
|
409
|
+
const locations = await api.items.invMast.locations.list(itemId); // Physical locations
|
|
410
|
+
const alternates = await api.items.invMast.alternateCode.list(itemId); // Alternate part numbers
|
|
411
|
+
|
|
412
|
+
// Order Processing (Prophet 21 oe_hdr context)
|
|
413
|
+
const orderHeader = await api.orders.oeHdr.get(orderId);
|
|
414
|
+
const salesRep = await api.orders.oeHdrSalesrep.get(orderId); // Sales representative info
|
|
415
|
+
const lineItems = await api.orders.oeHdr.lines.list(orderId); // Order line details
|
|
416
|
+
|
|
417
|
+
// VMI Operations (Prophet 21 inventory management context)
|
|
418
|
+
const profileHeader = await api.vmi.invProfileHdr.get(profileId); // VMI profile setup
|
|
419
|
+
const restockInfo = await api.vmi.restockHdr.get(restockId); // Restocking instructions
|
|
420
|
+
const warehouseData = await api.vmi.warehouse.get(warehouseId); // Warehouse details
|
|
421
|
+
```
|
|
422
|
+
|
|
423
|
+
### Migration from Legacy Naming
|
|
424
|
+
|
|
425
|
+
If you're familiar with conceptual API naming, here's the Prophet 21 mapping:
|
|
426
|
+
|
|
427
|
+
```typescript
|
|
428
|
+
// Legacy Conceptual → Prophet 21 Aligned
|
|
429
|
+
client.inventory → client.invMast // Inventory master
|
|
430
|
+
client.categories → client.itemCategory // Item categories
|
|
431
|
+
client.orders → client.oeHdr // Order entry header
|
|
432
|
+
client.salesRep → client.oeHdrSalesrep // Order header sales rep
|
|
433
|
+
client.purchaseOrders → client.poHdr // Purchase order header
|
|
434
|
+
client.invoices → client.invoiceHdr // Invoice header
|
|
435
|
+
client.inventoryProfiles → client.invProfileHdr // Inventory profile header
|
|
436
|
+
client.restocking → client.restockHdr // Restock header
|
|
437
|
+
client.calculateTax → client.taxEngine.calculate // Tax calculation engine
|
|
438
|
+
client.jobPriceHeaders → client.jobPriceHdr // Job price header
|
|
439
|
+
```
|
|
440
|
+
|
|
441
|
+
This alignment ensures that developers familiar with Prophet 21 can immediately understand the API structure and predict endpoint behavior based on their ERP knowledge.
|
|
442
|
+
|
|
377
443
|
### Sophisticated Caching Architecture
|
|
378
444
|
|
|
379
445
|
Intelligent edge caching with business-aware TTL policies:
|
|
@@ -1121,12 +1187,12 @@ await api.vmi.warehouses.enable(123, { status_cd: 704 }); // Enable
|
|
|
1121
1187
|
await api.vmi.warehouses.enable(123, { status_cd: 705 }); // Disable
|
|
1122
1188
|
|
|
1123
1189
|
// Inventory Operations
|
|
1124
|
-
const availability = await api.vmi.
|
|
1190
|
+
const availability = await api.vmi.invProfileHdr.checkAvailability(123, {
|
|
1125
1191
|
q: 'wire' // Search for items containing 'wire'
|
|
1126
1192
|
});
|
|
1127
1193
|
|
|
1128
1194
|
// Adjust inventory (sets absolute values)
|
|
1129
|
-
await api.vmi.
|
|
1195
|
+
await api.vmi.invProfileHdr.adjust(123, {
|
|
1130
1196
|
adjustments: [
|
|
1131
1197
|
{
|
|
1132
1198
|
inv_mast_uid: 456,
|
|
@@ -1137,7 +1203,7 @@ await api.vmi.inventory.adjust(123, {
|
|
|
1137
1203
|
});
|
|
1138
1204
|
|
|
1139
1205
|
// Receive inventory
|
|
1140
|
-
await api.vmi.
|
|
1206
|
+
await api.vmi.invProfileHdr.receive(123, {
|
|
1141
1207
|
receipts: [
|
|
1142
1208
|
{
|
|
1143
1209
|
inv_mast_uid: 456,
|
|
@@ -1149,13 +1215,13 @@ await api.vmi.inventory.receive(123, {
|
|
|
1149
1215
|
});
|
|
1150
1216
|
|
|
1151
1217
|
// Get replenishment information
|
|
1152
|
-
const replenishment = await api.vmi.
|
|
1218
|
+
const replenishment = await api.vmi.invProfileHdr.getReplenishmentInfo(123, {
|
|
1153
1219
|
distributorsUid: 789,
|
|
1154
1220
|
edgeCache: 2 // Cache replenishment info for 2 hours
|
|
1155
1221
|
});
|
|
1156
1222
|
|
|
1157
1223
|
// Execute replenishment
|
|
1158
|
-
await api.vmi.
|
|
1224
|
+
await api.vmi.invProfileHdr.replenish(123, {
|
|
1159
1225
|
distributor_uid: 789,
|
|
1160
1226
|
restock_items: [
|
|
1161
1227
|
{ inv_mast_uid: 456, qty_to_order: 100.0 }
|
|
@@ -1163,7 +1229,7 @@ await api.vmi.inventory.replenish(123, {
|
|
|
1163
1229
|
});
|
|
1164
1230
|
|
|
1165
1231
|
// Transfer inventory between warehouses
|
|
1166
|
-
await api.vmi.
|
|
1232
|
+
await api.vmi.invProfileHdr.transfer(123, {
|
|
1167
1233
|
to_warehouse_uid: 124,
|
|
1168
1234
|
transfers: [
|
|
1169
1235
|
{
|
|
@@ -1175,7 +1241,7 @@ await api.vmi.inventory.transfer(123, {
|
|
|
1175
1241
|
});
|
|
1176
1242
|
|
|
1177
1243
|
// Record inventory usage (with warranty tracking)
|
|
1178
|
-
await api.vmi.
|
|
1244
|
+
await api.vmi.invProfileHdr.recordUsage(123, {
|
|
1179
1245
|
job_description: 'Office Renovation - Building A',
|
|
1180
1246
|
department: 'Facilities',
|
|
1181
1247
|
usage_items: [
|
|
@@ -1441,7 +1507,7 @@ const auth = await api.joomla.users.verifyPassword({
|
|
|
1441
1507
|
});
|
|
1442
1508
|
|
|
1443
1509
|
// ❌ Bad: Don't cache user-specific data too long
|
|
1444
|
-
const userSpecificData = await api.vmi.
|
|
1510
|
+
const userSpecificData = await api.vmi.invProfileHdr.checkAvailability(warehouseId, {
|
|
1445
1511
|
q: 'search',
|
|
1446
1512
|
edgeCache: 8 // Too long for inventory data
|
|
1447
1513
|
});
|
|
@@ -1864,7 +1930,7 @@ export class AugurService {
|
|
|
1864
1930
|
|
|
1865
1931
|
// Inventory management
|
|
1866
1932
|
async getWarehouseInventory(warehouseId: number, searchTerm?: string) {
|
|
1867
|
-
return this.api.vmi.
|
|
1933
|
+
return this.api.vmi.invProfileHdr.checkAvailability(warehouseId, {
|
|
1868
1934
|
q: searchTerm
|
|
1869
1935
|
});
|
|
1870
1936
|
}
|
|
@@ -1873,7 +1939,7 @@ export class AugurService {
|
|
|
1873
1939
|
inv_mast_uid: number;
|
|
1874
1940
|
qty_to_order: number;
|
|
1875
1941
|
}>) {
|
|
1876
|
-
return this.api.vmi.
|
|
1942
|
+
return this.api.vmi.invProfileHdr.replenish(warehouseId, {
|
|
1877
1943
|
distributor_uid: 1, // Default distributor
|
|
1878
1944
|
restock_items: items
|
|
1879
1945
|
});
|
|
@@ -2500,7 +2566,7 @@ managedAPI.updateConfig({
|
|
|
2500
2566
|
// ⚡ Edge caching with Cloudflare CDN
|
|
2501
2567
|
const categories = await api.items.categories.list({ edgeCache: 8 }); // Static data: 8 hours
|
|
2502
2568
|
const pricing = await api.pricing.getPrice({ customerId: 123, edgeCache: 3 }); // Dynamic: 3 hours
|
|
2503
|
-
const inventory = await api.vmi.
|
|
2569
|
+
const inventory = await api.vmi.invProfileHdr.checkAvailability(123, { edgeCache: 1 }); // Volatile: 1 hour
|
|
2504
2570
|
|
|
2505
2571
|
// 🚀 Batch operations for multiple requests
|
|
2506
2572
|
const [users, groups, content] = await Promise.allSettled([
|
package/dist/cjs/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export declare const VERSION = "0.
|
|
1
|
+
export declare const VERSION = "0.3.0";
|
|
2
2
|
export { AugurAPI } from './client';
|
|
3
3
|
export { authenticateUserForSite, createCrossSiteAuthenticator, type CrossSiteAuthParams, type CrossSiteAuthResult, } from './utils/cross-site-auth';
|
|
4
4
|
export { AugurAPIConfig, RequestConfig, type AugurContext, ContextCreationError, } from './core/config';
|
package/dist/cjs/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC;AAG/B,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAGpC,OAAO,EACL,uBAAuB,EACvB,4BAA4B,EAC5B,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,GACzB,MAAM,yBAAyB,CAAC;AAGjC,OAAO,EACL,cAAc,EACd,aAAa,EACb,KAAK,YAAY,EACjB,oBAAoB,GACrB,MAAM,eAAe,CAAC;AACvB,OAAO,EACL,aAAa,EACb,UAAU,EACV,eAAe,EACf,mBAAmB,EACnB,aAAa,EACb,cAAc,GACf,MAAM,eAAe,CAAC;AACvB,OAAO,EACL,kBAAkB,EAClB,qBAAqB,EACrB,sBAAsB,EACtB,KAAK,YAAY,EACjB,KAAK,eAAe,GACrB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,KAAK,UAAU,EAAE,KAAK,iBAAiB,EAAE,KAAK,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAG9F,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAGpD,YAAY,EACV,OAAO,EACP,iBAAiB,EACjB,gBAAgB,EAChB,mBAAmB,EACnB,IAAI,EACJ,cAAc,EACd,gBAAgB,EAChB,SAAS,EACT,mBAAmB,EACnB,qBAAqB,EACrB,GAAG,EACH,aAAa,EACb,eAAe,EACf,uBAAuB,GACxB,MAAM,mBAAmB,CAAC;AAG3B,YAAY,EACV,OAAO,EACP,iBAAiB,EACjB,mBAAmB,EACnB,QAAQ,EACR,kBAAkB,EAClB,qBAAqB,EACrB,gBAAgB,EAChB,cAAc,EACd,kBAAkB,EAClB,gBAAgB,EAChB,eAAe,EACf,gBAAgB,EAChB,gBAAgB,EAChB,qBAAqB,EACrB,oBAAoB,EACpB,QAAQ,EACR,wBAAwB,EACxB,wBAAwB,GACzB,MAAM,qBAAqB,CAAC;AAG7B,YAAY,EACV,iBAAiB,EACjB,eAAe,EACf,gBAAgB,EAChB,aAAa,EACb,gBAAgB,EAChB,eAAe,EACf,aAAa,EACb,qBAAqB,EACrB,WAAW,EACX,sBAAsB,EACtB,YAAY,GACb,MAAM,oBAAoB,CAAC;AAG5B,YAAY,EACV,SAAS,EACT,mBAAmB,EACnB,sBAAsB,EACtB,sBAAsB,EACtB,sBAAsB,EACtB,qBAAqB,EACrB,2BAA2B,EAC3B,sBAAsB,EACtB,uBAAuB,EACvB,iBAAiB,EACjB,mBAAmB,EACnB,gBAAgB,EAChB,eAAe,EACf,YAAY,EACZ,WAAW,EACX,qBAAqB,EACrB,wBAAwB,EACxB,wBAAwB,EACxB,wBAAwB,EACxB,OAAO,EACP,eAAe,EACf,iBAAiB,EACjB,iBAAiB,EACjB,oBAAoB,EACpB,oBAAoB,EACpB,oBAAoB,EACpB,aAAa,EACb,cAAc,EACd,uBAAuB,EACvB,wBAAwB,EACxB,0BAA0B,EAC1B,0BAA0B,EAC1B,2BAA2B,EAC3B,2BAA2B,EAC3B,UAAU,EACV,oBAAoB,EACpB,uBAAuB,EACvB,uBAAuB,EACvB,OAAO,EACP,iBAAiB,EACjB,oBAAoB,EACpB,oBAAoB,EACpB,oBAAoB,EACpB,uBAAuB,EACvB,0BAA0B,EAC1B,yBAAyB,GAC1B,MAAM,gBAAgB,CAAC;AAGxB,YAAY,EACV,UAAU,EACV,QAAQ,EACR,YAAY,EACZ,gBAAgB,EAChB,UAAU,EACV,cAAc,EACd,kBAAkB,EAClB,sBAAsB,EACtB,cAAc,EACd,SAAS,EACT,oBAAoB,EACpB,wBAAwB,EACxB,eAAe,EACf,YAAY,EACZ,aAAa,EACb,iBAAiB,EACjB,UAAU,EACV,kBAAkB,EAClB,iBAAiB,EACjB,qBAAqB,EACrB,mBAAmB,GACpB,MAAM,wBAAwB,CAAC;AAGhC,YAAY,EACV,mBAAmB,IAAI,wBAAwB,EAC/C,YAAY,IAAI,iBAAiB,EACjC,OAAO,IAAI,YAAY,EACvB,mBAAmB,IAAI,wBAAwB,EAC/C,iBAAiB,IAAI,sBAAsB,EAC3C,aAAa,EACb,SAAS,EACT,OAAO,EACP,QAAQ,EACR,qBAAqB,EACrB,mBAAmB,EACnB,YAAY,EACZ,iBAAiB,EACjB,cAAc,EACd,aAAa,EACb,SAAS,IAAI,cAAc,EAC3B,sBAAsB,EACtB,sBAAsB,EACtB,cAAc,EACd,cAAc,IAAI,mBAAmB,EACrC,aAAa,EACb,YAAY,EACZ,YAAY,EACZ,KAAK,EACL,kBAAkB,EAClB,kBAAkB,EAClB,kBAAkB,EAClB,+BAA+B,GAChC,MAAM,kBAAkB,CAAC;AAG1B,YAAY,EACV,eAAe,EACf,eAAe,EACf,WAAW,EACX,qBAAqB,EACrB,wBAAwB,EACxB,wBAAwB,EACxB,SAAS,EACT,mBAAmB,EACnB,sBAAsB,EACtB,sBAAsB,EACtB,QAAQ,EACR,kBAAkB,EAClB,qBAAqB,EACrB,qBAAqB,EACrB,oBAAoB,EACpB,8BAA8B,EAC9B,iCAAiC,EACjC,iCAAiC,EACjC,eAAe,EACf,yBAAyB,EACzB,4BAA4B,EAC5B,4BAA4B,EAC5B,gBAAgB,EAChB,0BAA0B,EAC1B,6BAA6B,EAC7B,6BAA6B,EAC7B,mBAAmB,IAAI,wBAAwB,EAC/C,YAAY,IAAI,iBAAiB,GAClC,MAAM,kBAAkB,CAAC;AAG1B,YAAY,EACV,OAAO,EACP,iBAAiB,EACjB,mBAAmB,EACnB,mBAAmB,EACnB,eAAe,EACf,yBAAyB,EACzB,2BAA2B,EAC3B,2BAA2B,EAC3B,YAAY,EACZ,wBAAwB,EACxB,mBAAmB,EACnB,yBAAyB,EACzB,mBAAmB,IAAI,0BAA0B,GAClD,MAAM,qBAAqB,CAAC;AAG7B,YAAY,EACV,QAAQ,EACR,kBAAkB,EAClB,oBAAoB,EACpB,cAAc,EACd,oBAAoB,EACpB,gBAAgB,EAChB,sBAAsB,EACtB,OAAO,EACP,mBAAmB,EACnB,iBAAiB,EACjB,sBAAsB,EACtB,mBAAmB,EACnB,eAAe,EACf,wBAAwB,EACxB,YAAY,EACZ,oBAAoB,EACpB,OAAO,EACP,iBAAiB,EACjB,mBAAmB,EACnB,aAAa,EACb,yBAAyB,EACzB,uBAAuB,EACvB,yBAAyB,EACzB,qBAAqB,EACrB,eAAe,EACf,uBAAuB,EACvB,yBAAyB,EACzB,OAAO,EACP,iBAAiB,EACjB,mBAAmB,EACnB,eAAe,EACf,KAAK,EACL,eAAe,EACf,iBAAiB,EACjB,aAAa,EACb,aAAa,EACb,uBAAuB,EACvB,yBAAyB,EACzB,wBAAwB,EACxB,gCAAgC,EAChC,mBAAmB,EACnB,2BAA2B,EAC3B,mBAAmB,IAAI,4BAA4B,GACpD,MAAM,sBAAsB,CAAC;AAG9B,YAAY,EACV,SAAS,EACT,WAAW,EACX,aAAa,EACb,iBAAiB,EACjB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACrB,aAAa,EACb,qBAAqB,EACrB,yBAAyB,EACzB,6BAA6B,EAC7B,iBAAiB,EACjB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACrB,uBAAuB,EACvB,uBAAuB,EACvB,uBAAuB,EACvB,yBAAyB,EACzB,2BAA2B,EAC3B,6BAA6B,EAC7B,yBAAyB,EACzB,sBAAsB,EACtB,yBAAyB,EACzB,mBAAmB,IAAI,yBAAyB,GACjD,MAAM,mBAAmB,CAAC;AAG3B,YAAY,EACV,wBAAwB,EACxB,kCAAkC,EAClC,oCAAoC,EACpC,oCAAoC,EACpC,gCAAgC,EAChC,oCAAoC,EACpC,YAAY,EACZ,kBAAkB,EAClB,qBAAqB,EACrB,OAAO,EACP,iBAAiB,EACjB,mBAAmB,EACnB,mBAAmB,EACnB,eAAe,EACf,mBAAmB,EACnB,mBAAmB,IAAI,yBAAyB,GACjD,MAAM,oBAAoB,CAAC;AAG5B,YAAY,EACV,sBAAsB,EACtB,oBAAoB,EACpB,wBAAwB,EACxB,kBAAkB,EAClB,gBAAgB,EAChB,oBAAoB,EACpB,mBAAmB,EACnB,qBAAqB,EACrB,cAAc,EACd,YAAY,EACZ,gBAAgB,EAChB,eAAe,EACf,aAAa,EACb,iBAAiB,EACjB,cAAc,EACd,gBAAgB,EAChB,oBAAoB,EACpB,sBAAsB,EACtB,mBAAmB,IAAI,2BAA2B,EAClD,YAAY,IAAI,oBAAoB,GACrC,MAAM,qBAAqB,CAAC;AAG7B,YAAY,EACV,mBAAmB,IAAI,0BAA0B,EACjD,MAAM,EACN,gBAAgB,EAChB,kBAAkB,EAClB,iBAAiB,EACjB,kBAAkB,EAClB,cAAc,EACd,kBAAkB,EAClB,sBAAsB,EACtB,8BAA8B,EAC9B,yBAAyB,EACzB,cAAc,EACd,wBAAwB,EACxB,yBAAyB,EACzB,YAAY,EACZ,oBAAoB,GACrB,MAAM,qBAAqB,CAAC"}
|
package/dist/cjs/index.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.P21SismClient = exports.PaymentsClient = exports.P21PimClient = exports.OrdersClient = exports.CustomersClient = exports.AgrSiteClient = exports.LegacyClient = exports.NexusClient = exports.ItemsClient = exports.OpenSearchClient = exports.VMIClient = exports.PricingClient = exports.CommerceClient = exports.JoomlaClient = exports.PaginationParamsSchema = exports.HealthCheckDataSchema = exports.BaseResponseSchema = exports.RateLimitError = exports.NotFoundError = exports.AuthenticationError = exports.ValidationError = exports.AugurError = exports.ContextCreationError = exports.createCrossSiteAuthenticator = exports.authenticateUserForSite = exports.AugurAPI = exports.VERSION = void 0;
|
|
4
|
-
exports.VERSION = '0.
|
|
4
|
+
exports.VERSION = '0.3.0';
|
|
5
5
|
// Main client
|
|
6
6
|
var client_1 = require("./client");
|
|
7
7
|
Object.defineProperty(exports, "AugurAPI", { enumerable: true, get: function () { return client_1.AugurAPI; } });
|
package/dist/cjs/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,OAAO,CAAC;AAE/B,cAAc;AACd,mCAAoC;AAA3B,kGAAA,QAAQ,OAAA;AAEjB,YAAY;AACZ,2DAKiC;AAJ/B,0HAAA,uBAAuB,OAAA;AACvB,+HAAA,4BAA4B,OAAA;AAK9B,eAAe;AACf,wCAKuB;AADrB,8GAAA,oBAAoB,OAAA;AAEtB,wCAOuB;AALrB,oGAAA,UAAU,OAAA;AACV,yGAAA,eAAe,OAAA;AACf,6GAAA,mBAAmB,OAAA;AACnB,uGAAA,aAAa,OAAA;AACb,wGAAA,cAAc,OAAA;AAEhB,0CAMwB;AALtB,6GAAA,kBAAkB,OAAA;AAClB,gHAAA,qBAAqB,OAAA;AACrB,iHAAA,sBAAsB,OAAA;AAMxB,kBAAkB;AAClB,4CAAiD;AAAxC,sGAAA,YAAY,OAAA;AACrB,gDAAqD;AAA5C,0GAAA,cAAc,OAAA;AACvB,8CAAmD;AAA1C,wGAAA,aAAa,OAAA;AACtB,sCAA2C;AAAlC,gGAAA,SAAS,OAAA;AAClB,sDAA0D;AAAjD,+GAAA,gBAAgB,OAAA;AACzB,0CAA+C;AAAtC,oGAAA,WAAW,OAAA;AACpB,0CAA+C;AAAtC,oGAAA,WAAW,OAAA;AACpB,4CAAiD;AAAxC,sGAAA,YAAY,OAAA;AACrB,gDAAoD;AAA3C,yGAAA,aAAa,OAAA;AACtB,kDAAuD;AAA9C,4GAAA,eAAe,OAAA;AACxB,4CAAiD;AAAxC,sGAAA,YAAY,OAAA;AACrB,8CAAkD;AAAzC,uGAAA,YAAY,OAAA;AACrB,gDAAqD;AAA5C,0GAAA,cAAc,OAAA;AACvB,gDAAoD;AAA3C,yGAAA,aAAa,OAAA"}
|
|
@@ -182,8 +182,8 @@ export declare class CustomersClient extends BaseServiceClient {
|
|
|
182
182
|
addressId: number;
|
|
183
183
|
addressName: string;
|
|
184
184
|
address1: string;
|
|
185
|
-
phoneNumber?: string | undefined;
|
|
186
185
|
isPrimary?: boolean | undefined;
|
|
186
|
+
phoneNumber?: string | undefined;
|
|
187
187
|
address2?: string | undefined;
|
|
188
188
|
faxNumber?: string | undefined;
|
|
189
189
|
}[];
|
|
@@ -229,8 +229,8 @@ export declare class CustomersClient extends BaseServiceClient {
|
|
|
229
229
|
canPlaceOrders?: boolean | undefined;
|
|
230
230
|
canViewInvoices?: boolean | undefined;
|
|
231
231
|
} | undefined;
|
|
232
|
-
phoneNumber?: string | undefined;
|
|
233
232
|
isPrimary?: boolean | undefined;
|
|
233
|
+
phoneNumber?: string | undefined;
|
|
234
234
|
webEnabled?: boolean | undefined;
|
|
235
235
|
loginCredentials?: {
|
|
236
236
|
username?: string | undefined;
|
|
@@ -279,8 +279,8 @@ export declare class CustomersClient extends BaseServiceClient {
|
|
|
279
279
|
canPlaceOrders?: boolean | undefined;
|
|
280
280
|
canViewInvoices?: boolean | undefined;
|
|
281
281
|
} | undefined;
|
|
282
|
-
phoneNumber?: string | undefined;
|
|
283
282
|
isPrimary?: boolean | undefined;
|
|
283
|
+
phoneNumber?: string | undefined;
|
|
284
284
|
webEnabled?: boolean | undefined;
|
|
285
285
|
loginCredentials?: {
|
|
286
286
|
username?: string | undefined;
|
|
@@ -912,8 +912,8 @@ export declare class CustomersClient extends BaseServiceClient {
|
|
|
912
912
|
canPlaceOrders?: boolean | undefined;
|
|
913
913
|
canViewInvoices?: boolean | undefined;
|
|
914
914
|
} | undefined;
|
|
915
|
-
phoneNumber?: string | undefined;
|
|
916
915
|
isPrimary?: boolean | undefined;
|
|
916
|
+
phoneNumber?: string | undefined;
|
|
917
917
|
webEnabled?: boolean | undefined;
|
|
918
918
|
loginCredentials?: {
|
|
919
919
|
username?: string | undefined;
|
|
@@ -21,8 +21,8 @@ export declare const AddressSchema: z.ZodObject<{
|
|
|
21
21
|
addressId: number;
|
|
22
22
|
addressName: string;
|
|
23
23
|
address1: string;
|
|
24
|
-
phoneNumber?: string | undefined;
|
|
25
24
|
isPrimary?: boolean | undefined;
|
|
25
|
+
phoneNumber?: string | undefined;
|
|
26
26
|
address2?: string | undefined;
|
|
27
27
|
faxNumber?: string | undefined;
|
|
28
28
|
}, {
|
|
@@ -34,8 +34,8 @@ export declare const AddressSchema: z.ZodObject<{
|
|
|
34
34
|
addressId: number;
|
|
35
35
|
addressName: string;
|
|
36
36
|
address1: string;
|
|
37
|
-
phoneNumber?: string | undefined;
|
|
38
37
|
isPrimary?: boolean | undefined;
|
|
38
|
+
phoneNumber?: string | undefined;
|
|
39
39
|
address2?: string | undefined;
|
|
40
40
|
faxNumber?: string | undefined;
|
|
41
41
|
}>;
|
|
@@ -218,11 +218,11 @@ export declare const ShipToAddressCreateParamsSchema: z.ZodObject<{
|
|
|
218
218
|
zipCode: string;
|
|
219
219
|
country: string;
|
|
220
220
|
address1: string;
|
|
221
|
+
isDefault?: boolean | undefined;
|
|
221
222
|
phoneNumber?: string | undefined;
|
|
222
223
|
address2?: string | undefined;
|
|
223
224
|
contactName?: string | undefined;
|
|
224
225
|
deliveryInstructions?: string | undefined;
|
|
225
|
-
isDefault?: boolean | undefined;
|
|
226
226
|
}, {
|
|
227
227
|
state: string;
|
|
228
228
|
shipToName: string;
|
|
@@ -230,11 +230,11 @@ export declare const ShipToAddressCreateParamsSchema: z.ZodObject<{
|
|
|
230
230
|
zipCode: string;
|
|
231
231
|
country: string;
|
|
232
232
|
address1: string;
|
|
233
|
+
isDefault?: boolean | undefined;
|
|
233
234
|
phoneNumber?: string | undefined;
|
|
234
235
|
address2?: string | undefined;
|
|
235
236
|
contactName?: string | undefined;
|
|
236
237
|
deliveryInstructions?: string | undefined;
|
|
237
|
-
isDefault?: boolean | undefined;
|
|
238
238
|
}>;
|
|
239
239
|
export declare const ShipToAddressListParamsSchema: z.ZodObject<{
|
|
240
240
|
edgeCache: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodLiteral<1>, z.ZodLiteral<2>, z.ZodLiteral<3>, z.ZodLiteral<4>, z.ZodLiteral<5>, z.ZodLiteral<8>, z.ZodLiteral<"1">, z.ZodLiteral<"2">, z.ZodLiteral<"3">, z.ZodLiteral<"4">, z.ZodLiteral<"5">, z.ZodLiteral<"8">]>, 3 | 2 | 4 | 1 | 5 | 8, 3 | 2 | 4 | 1 | "1" | 5 | 8 | "2" | "3" | "4" | "5" | "8">>;
|
|
@@ -277,8 +277,8 @@ export declare const AddressListResponseSchema: z.ZodEffects<z.ZodObject<{
|
|
|
277
277
|
addressId: number;
|
|
278
278
|
addressName: string;
|
|
279
279
|
address1: string;
|
|
280
|
-
phoneNumber?: string | undefined;
|
|
281
280
|
isPrimary?: boolean | undefined;
|
|
281
|
+
phoneNumber?: string | undefined;
|
|
282
282
|
address2?: string | undefined;
|
|
283
283
|
faxNumber?: string | undefined;
|
|
284
284
|
}, {
|
|
@@ -290,8 +290,8 @@ export declare const AddressListResponseSchema: z.ZodEffects<z.ZodObject<{
|
|
|
290
290
|
addressId: number;
|
|
291
291
|
addressName: string;
|
|
292
292
|
address1: string;
|
|
293
|
-
phoneNumber?: string | undefined;
|
|
294
293
|
isPrimary?: boolean | undefined;
|
|
294
|
+
phoneNumber?: string | undefined;
|
|
295
295
|
address2?: string | undefined;
|
|
296
296
|
faxNumber?: string | undefined;
|
|
297
297
|
}>, "many">;
|
|
@@ -312,8 +312,8 @@ export declare const AddressListResponseSchema: z.ZodEffects<z.ZodObject<{
|
|
|
312
312
|
addressId: number;
|
|
313
313
|
addressName: string;
|
|
314
314
|
address1: string;
|
|
315
|
-
phoneNumber?: string | undefined;
|
|
316
315
|
isPrimary?: boolean | undefined;
|
|
316
|
+
phoneNumber?: string | undefined;
|
|
317
317
|
address2?: string | undefined;
|
|
318
318
|
faxNumber?: string | undefined;
|
|
319
319
|
}[];
|
|
@@ -334,8 +334,8 @@ export declare const AddressListResponseSchema: z.ZodEffects<z.ZodObject<{
|
|
|
334
334
|
addressId: number;
|
|
335
335
|
addressName: string;
|
|
336
336
|
address1: string;
|
|
337
|
-
phoneNumber?: string | undefined;
|
|
338
337
|
isPrimary?: boolean | undefined;
|
|
338
|
+
phoneNumber?: string | undefined;
|
|
339
339
|
address2?: string | undefined;
|
|
340
340
|
faxNumber?: string | undefined;
|
|
341
341
|
}[];
|
|
@@ -356,8 +356,8 @@ export declare const AddressListResponseSchema: z.ZodEffects<z.ZodObject<{
|
|
|
356
356
|
addressId: number;
|
|
357
357
|
addressName: string;
|
|
358
358
|
address1: string;
|
|
359
|
-
phoneNumber?: string | undefined;
|
|
360
359
|
isPrimary?: boolean | undefined;
|
|
360
|
+
phoneNumber?: string | undefined;
|
|
361
361
|
address2?: string | undefined;
|
|
362
362
|
faxNumber?: string | undefined;
|
|
363
363
|
}[];
|
|
@@ -378,8 +378,8 @@ export declare const AddressListResponseSchema: z.ZodEffects<z.ZodObject<{
|
|
|
378
378
|
addressId: number;
|
|
379
379
|
addressName: string;
|
|
380
380
|
address1: string;
|
|
381
|
-
phoneNumber?: string | undefined;
|
|
382
381
|
isPrimary?: boolean | undefined;
|
|
382
|
+
phoneNumber?: string | undefined;
|
|
383
383
|
address2?: string | undefined;
|
|
384
384
|
faxNumber?: string | undefined;
|
|
385
385
|
}[];
|