@simpleapps-com/augur-api 0.2.13 → 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 +55 -55
- 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 +26 -26
- package/dist/cjs/services/orders/schemas/purchase-orders.js +1 -1
- 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 +55 -55
- 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 +26 -26
- package/dist/esm/services/orders/schemas/purchase-orders.js +1 -1
- 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 +55 -55
- package/dist/types/services/orders/client.d.ts.map +1 -1
- package/dist/types/services/orders/schemas/purchase-orders.d.ts +26 -26
- 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
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"wishlists.d.ts","sourceRoot":"","sources":["../../../../../src/services/items/schemas/wishlists.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAKxB,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAWnC,CAAC;AAGH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAajC,CAAC;AAGH,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAEnC,CAAC;AAGH,eAAO,MAAM,qCAAqC;;;;;;;;;;;;EAIhD,CAAC;AAGH,eAAO,MAAM,qCAAqC;;;;;;;;;;;;EAIhD,CAAC;AAGH,eAAO,MAAM,mCAAmC;;;;;;;;;;;;;;;EAK9C,CAAC;AAGH,eAAO,MAAM,mCAAmC;;;;;;;;;;;;EAI9C,CAAC;AAGH,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;EAIvC,CAAC;AAGH,eAAO,MAAM,gCAAgC;;;;;;;;;;;;;;;;;;;;EAG3C,CAAC;AAGH,eAAO,MAAM,gCAAgC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAA+C,CAAC;AAC7F,eAAO,MAAM,oCAAoC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAEhD,CAAC;AACF,eAAO,MAAM,8BAA8B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAA6C,CAAC;AACzF,eAAO,MAAM,kCAAkC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAE9C,CAAC;AACF,eAAO,MAAM,gCAAgC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAA+C,CAAC;AAG7F,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAC1E,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AACtE,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAC1E,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qCAAqC,CAAC,CAAC;AACpG,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qCAAqC,CAAC,CAAC;AACpG,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mCAAmC,CAAC,CAAC;AAChG,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mCAAmC,CAAC,CAAC;AAChG,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAC;AAClF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gCAAgC,CAAC,CAAC;AAC1F,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gCAAgC,CAAC,CAAC;AAC1F,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oCAAoC,CAAC,CAAC;AAClG,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,8BAA8B,CAAC,CAAC;AACtF,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kCAAkC,CAAC,CAAC;AAC9F,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gCAAgC,CAAC,CAAC"}
|
|
@@ -16,7 +16,7 @@ import { CreateInvMastTagRequest, UpdateInvMastTagRequest, CreateInvMastWebDescR
|
|
|
16
16
|
* const states = await legacy.states.list({ limit: 25, twoLetterCode: 'CA' });
|
|
17
17
|
*
|
|
18
18
|
* // Get inventory tags
|
|
19
|
-
* const tags = await legacy.
|
|
19
|
+
* const tags = await legacy.invMast.tags.list(12345);
|
|
20
20
|
*
|
|
21
21
|
* // Reset order
|
|
22
22
|
* const resetResult = await legacy.orders.reset(67890);
|
|
@@ -291,7 +291,7 @@ export declare class LegacyClient extends BaseServiceClient {
|
|
|
291
291
|
* Inventory master operations
|
|
292
292
|
* @description Operations for inventory items including also-bought analysis, tagging, and web descriptions
|
|
293
293
|
*/
|
|
294
|
-
|
|
294
|
+
invMast: {
|
|
295
295
|
/**
|
|
296
296
|
* Get products frequently bought with a specific item
|
|
297
297
|
* @description Retrieve products commonly purchased together for recommendation systems
|
|
@@ -300,7 +300,7 @@ export declare class LegacyClient extends BaseServiceClient {
|
|
|
300
300
|
* @throws ValidationError When response is malformed
|
|
301
301
|
* @example
|
|
302
302
|
* ```typescript
|
|
303
|
-
* const alsoBought = await client.
|
|
303
|
+
* const alsoBought = await client.invMast.getAlsoBought(12345);
|
|
304
304
|
* alsoBought.forEach(product => {
|
|
305
305
|
* console.log(`${product.item_desc} - Frequency: ${product.frequency}`);
|
|
306
306
|
* });
|
|
@@ -320,7 +320,7 @@ export declare class LegacyClient extends BaseServiceClient {
|
|
|
320
320
|
* @throws ValidationError When response is malformed
|
|
321
321
|
* @example
|
|
322
322
|
* ```typescript
|
|
323
|
-
* const tags = await client.
|
|
323
|
+
* const tags = await client.invMast.tags.list(12345);
|
|
324
324
|
* tags.forEach(tag => {
|
|
325
325
|
* console.log(`${tag.tag_name}: ${tag.tag_value}`);
|
|
326
326
|
* });
|
|
@@ -336,7 +336,7 @@ export declare class LegacyClient extends BaseServiceClient {
|
|
|
336
336
|
* @throws ValidationError When response is malformed
|
|
337
337
|
* @example
|
|
338
338
|
* ```typescript
|
|
339
|
-
* const tag = await client.
|
|
339
|
+
* const tag = await client.invMast.tags.get(12345, 67890);
|
|
340
340
|
* console.log(`Tag: ${tag.tag_name} = ${tag.tag_value}`);
|
|
341
341
|
* ```
|
|
342
342
|
*/
|
|
@@ -350,7 +350,7 @@ export declare class LegacyClient extends BaseServiceClient {
|
|
|
350
350
|
* @throws ValidationError When tag data is invalid or response is malformed
|
|
351
351
|
* @example
|
|
352
352
|
* ```typescript
|
|
353
|
-
* const newTag = await client.
|
|
353
|
+
* const newTag = await client.invMast.tags.create(12345, {
|
|
354
354
|
* tag_name: 'Featured Product',
|
|
355
355
|
* tag_value: 'true',
|
|
356
356
|
* active: 1
|
|
@@ -368,7 +368,7 @@ export declare class LegacyClient extends BaseServiceClient {
|
|
|
368
368
|
* @throws ValidationError When tag data is invalid or response is malformed
|
|
369
369
|
* @example
|
|
370
370
|
* ```typescript
|
|
371
|
-
* const updatedTag = await client.
|
|
371
|
+
* const updatedTag = await client.invMast.tags.update(12345, 67890, {
|
|
372
372
|
* tag_name: 'Premium Product',
|
|
373
373
|
* tag_value: 'true'
|
|
374
374
|
* });
|
|
@@ -384,7 +384,7 @@ export declare class LegacyClient extends BaseServiceClient {
|
|
|
384
384
|
* @throws ValidationError When response is malformed
|
|
385
385
|
* @example
|
|
386
386
|
* ```typescript
|
|
387
|
-
* const result = await client.
|
|
387
|
+
* const result = await client.invMast.tags.delete(12345, 67890);
|
|
388
388
|
* console.log('Tag deleted:', result.deleted);
|
|
389
389
|
* ```
|
|
390
390
|
*/
|
|
@@ -403,7 +403,7 @@ export declare class LegacyClient extends BaseServiceClient {
|
|
|
403
403
|
* @throws ValidationError When response is malformed
|
|
404
404
|
* @example
|
|
405
405
|
* ```typescript
|
|
406
|
-
* const descriptions = await client.
|
|
406
|
+
* const descriptions = await client.invMast.webDescriptions.list(12345);
|
|
407
407
|
* descriptions.forEach(desc => {
|
|
408
408
|
* console.log(`${desc.description_type}: ${desc.description_text}`);
|
|
409
409
|
* });
|
|
@@ -419,7 +419,7 @@ export declare class LegacyClient extends BaseServiceClient {
|
|
|
419
419
|
* @throws ValidationError When response is malformed
|
|
420
420
|
* @example
|
|
421
421
|
* ```typescript
|
|
422
|
-
* const desc = await client.
|
|
422
|
+
* const desc = await client.invMast.webDescriptions.get(12345, 67890);
|
|
423
423
|
* console.log(desc.description_type, desc.description_text);
|
|
424
424
|
* ```
|
|
425
425
|
*/
|
|
@@ -433,7 +433,7 @@ export declare class LegacyClient extends BaseServiceClient {
|
|
|
433
433
|
* @throws ValidationError When description data is invalid or response is malformed
|
|
434
434
|
* @example
|
|
435
435
|
* ```typescript
|
|
436
|
-
* const newDesc = await client.
|
|
436
|
+
* const newDesc = await client.invMast.webDescriptions.create(12345, {
|
|
437
437
|
* description_type: 'long',
|
|
438
438
|
* description_text: 'Detailed product description for web display',
|
|
439
439
|
* display_order: 1
|
|
@@ -451,7 +451,7 @@ export declare class LegacyClient extends BaseServiceClient {
|
|
|
451
451
|
* @throws ValidationError When description data is invalid or response is malformed
|
|
452
452
|
* @example
|
|
453
453
|
* ```typescript
|
|
454
|
-
* const updatedDesc = await client.
|
|
454
|
+
* const updatedDesc = await client.invMast.webDescriptions.update(12345, 67890, {
|
|
455
455
|
* description_text: 'Updated detailed product description',
|
|
456
456
|
* display_order: 2
|
|
457
457
|
* });
|
|
@@ -467,7 +467,7 @@ export declare class LegacyClient extends BaseServiceClient {
|
|
|
467
467
|
* @throws ValidationError When response is malformed
|
|
468
468
|
* @example
|
|
469
469
|
* ```typescript
|
|
470
|
-
* const result = await client.
|
|
470
|
+
* const result = await client.invMast.webDescriptions.delete(12345, 67890);
|
|
471
471
|
* console.log('Description deleted:', result.deleted);
|
|
472
472
|
* ```
|
|
473
473
|
*/
|
|
@@ -478,7 +478,7 @@ export declare class LegacyClient extends BaseServiceClient {
|
|
|
478
478
|
* Item category operations
|
|
479
479
|
* @description Operations for hierarchical item categorization
|
|
480
480
|
*/
|
|
481
|
-
|
|
481
|
+
itemCategory: {
|
|
482
482
|
/**
|
|
483
483
|
* Get item category details
|
|
484
484
|
* @description Retrieve complete details for a specific item category including hierarchical information
|
|
@@ -487,7 +487,7 @@ export declare class LegacyClient extends BaseServiceClient {
|
|
|
487
487
|
* @throws ValidationError When response is malformed
|
|
488
488
|
* @example
|
|
489
489
|
* ```typescript
|
|
490
|
-
* const category = await client.
|
|
490
|
+
* const category = await client.itemCategory.get(12345);
|
|
491
491
|
* console.log(category.item_category_desc, category.path, category.level);
|
|
492
492
|
* ```
|
|
493
493
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../../src/services/legacy/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EA+BL,uBAAuB,EACvB,uBAAuB,EACvB,2BAA2B,EAC3B,2BAA2B,EAG3B,sBAAsB,EACtB,sBAAsB,EACtB,kBAAkB,EAClB,0BAA0B,EAC1B,sBAAsB,EACtB,oBAAoB,EACpB,qBAAqB,EACrB,cAAc,EACf,MAAM,WAAW,CAAC;AAEnB;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,YAAa,SAAQ,iBAAiB;IACjD;;;;OAIG;gBACS,IAAI,EAAE,UAAU,EAAE,OAAO,GAAE,MAAuC;IAI9E;;;OAGG;IACH,cAAc;;;;;;;;;;;;OAA2D;IAEzE;;;OAGG;IACH,MAAM;QACJ;;;;;;;;;;;;;;;;;;;;;;;WAuBG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAGH;;;;;;;;;;;;;;;;WAgBG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAGH;;;;;;;;;;;;;;;;;;WAkBG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAGH;;;;;;;;;;;;;;;WAeG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAOH;;;;;;;;;;;WAWG;;;;;;;;;;;;;;MAEH;IAEF;;;OAGG;IACH,
|
|
1
|
+
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../../src/services/legacy/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EA+BL,uBAAuB,EACvB,uBAAuB,EACvB,2BAA2B,EAC3B,2BAA2B,EAG3B,sBAAsB,EACtB,sBAAsB,EACtB,kBAAkB,EAClB,0BAA0B,EAC1B,sBAAsB,EACtB,oBAAoB,EACpB,qBAAqB,EACrB,cAAc,EACf,MAAM,WAAW,CAAC;AAEnB;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,YAAa,SAAQ,iBAAiB;IACjD;;;;OAIG;gBACS,IAAI,EAAE,UAAU,EAAE,OAAO,GAAE,MAAuC;IAI9E;;;OAGG;IACH,cAAc;;;;;;;;;;;;OAA2D;IAEzE;;;OAGG;IACH,MAAM;QACJ;;;;;;;;;;;;;;;;;;;;;;;WAuBG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAGH;;;;;;;;;;;;;;;;WAgBG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAGH;;;;;;;;;;;;;;;;;;WAkBG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAGH;;;;;;;;;;;;;;;WAeG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAOH;;;;;;;;;;;WAWG;;;;;;;;;;;;;;MAEH;IAEF;;;OAGG;IACH,OAAO;QACL;;;;;;;;;;;;;WAaG;oCAC+B,MAAM,KAAG,OAAO,CAAC,sBAAsB,CAAC;QAY1E;;;WAGG;;YAED;;;;;;;;;;;;;eAaG;+BACsB,MAAM,KAAG,OAAO,CAAC,sBAAsB,CAAC;YAYjE;;;;;;;;;;;;eAYG;8BACqB,MAAM,kBAAkB,MAAM,KAAG,OAAO,CAAC,kBAAkB,CAAC;YAepF;;;;;;;;;;;;;;;eAeG;iCAEW,MAAM,WACT,uBAAuB,KAC/B,OAAO,CAAC,kBAAkB,CAAC;YAa9B;;;;;;;;;;;;;;;eAeG;iCAEW,MAAM,kBACF,MAAM,WACb,uBAAuB,KAC/B,OAAO,CAAC,kBAAkB,CAAC;YAgB9B;;;;;;;;;;;;eAYG;iCACwB,MAAM,kBAAkB,MAAM,KAAG,OAAO,CAAC,cAAc,CAAC;;QAgBrF;;;WAGG;;YAED;;;;;;;;;;;;;eAaG;+BACsB,MAAM,KAAG,OAAO,CAAC,0BAA0B,CAAC;YAYrE;;;;;;;;;;;;eAYG;8BAEW,MAAM,qBACC,MAAM,KACxB,OAAO,CAAC,sBAAsB,CAAC;YAelC;;;;;;;;;;;;;;;eAeG;iCAEW,MAAM,YACR,2BAA2B,KACpC,OAAO,CAAC,sBAAsB,CAAC;YAalC;;;;;;;;;;;;;;;eAeG;iCAEW,MAAM,qBACC,MAAM,YACf,2BAA2B,KACpC,OAAO,CAAC,sBAAsB,CAAC;YAgBlC;;;;;;;;;;;;eAYG;iCACwB,MAAM,qBAAqB,MAAM,KAAG,OAAO,CAAC,cAAc,CAAC;;MAexF;IAEF;;;OAGG;IACH,YAAY;QACV;;;;;;;;;;;WAWG;+BAC0B,MAAM,KAAG,OAAO,CAAC,oBAAoB,CAAC;MAWnE;IAEF;;;OAGG;IACH,MAAM;QACJ;;;;;;;;;;;WAWG;yBACoB,MAAM,KAAG,OAAO,CAAC,qBAAqB,CAAC;MAW9D;CACH"}
|
|
@@ -22,19 +22,19 @@ import { type OrderDocumentParams, type OrderLookupParams, type PurchaseOrderLis
|
|
|
22
22
|
* const api = new AugurAPI({ bearerToken: 'token', siteId: 'site' });
|
|
23
23
|
*
|
|
24
24
|
* // Standard methods (full BaseResponse)
|
|
25
|
-
* const ordersResponse = await api.orders.
|
|
25
|
+
* const ordersResponse = await api.orders.oeHdr.lookup({ limit: 10, q: '12345' });
|
|
26
26
|
* console.log(`Found ${ordersResponse.total} orders`);
|
|
27
27
|
*
|
|
28
28
|
* // Data methods (data only)
|
|
29
|
-
* const orders = await api.orders.
|
|
29
|
+
* const orders = await api.orders.oeHdr.lookupData({ limit: 10, q: '12345' });
|
|
30
30
|
* orders.forEach(order => console.log(order.orderNo, order.customerName));
|
|
31
31
|
*
|
|
32
32
|
* // Get order document with validation
|
|
33
|
-
* const orderDoc = await api.orders.
|
|
33
|
+
* const orderDoc = await api.orders.oeHdr.getDocument(12345678, { postalCode: '12345' });
|
|
34
34
|
*
|
|
35
35
|
* // Purchase order workflow
|
|
36
|
-
* const pos = await api.orders.
|
|
37
|
-
* const poDoc = await api.orders.
|
|
36
|
+
* const pos = await api.orders.poHdr.listData({ complete: 'N', limit: 20 });
|
|
37
|
+
* const poDoc = await api.orders.poHdr.getDocument(pos[0].poNo);
|
|
38
38
|
* ```
|
|
39
39
|
*/
|
|
40
40
|
export declare class OrdersClient extends BaseServiceClient {
|
|
@@ -48,22 +48,22 @@ export declare class OrdersClient extends BaseServiceClient {
|
|
|
48
48
|
* Order Management Operations (oe-hdr endpoints)
|
|
49
49
|
* @description Core order management functionality for searching, tracking, and retrieving sales orders
|
|
50
50
|
*/
|
|
51
|
-
|
|
51
|
+
oeHdr: {
|
|
52
52
|
/**
|
|
53
53
|
* Search and list order headers with flexible filtering options
|
|
54
54
|
* @description Returns paginated order headers with comprehensive filtering by customer, date, status, sales rep, and search terms. Supports edge caching for improved performance.
|
|
55
55
|
*
|
|
56
|
-
* @fullPath api.orders.
|
|
56
|
+
* @fullPath api.orders.oeHdr.lookup
|
|
57
57
|
* @service orders
|
|
58
58
|
* @domain order-management
|
|
59
59
|
* @dataMethod lookupData - returns only the order headers array without metadata
|
|
60
60
|
* @discoverable true
|
|
61
61
|
* @searchTerms ["order lookup", "search orders", "order list", "find orders", "order search", "sales orders"]
|
|
62
|
-
* @relatedEndpoints ["api.orders.
|
|
62
|
+
* @relatedEndpoints ["api.orders.oeHdr.getDocument", "api.customers.customer.list", "api.orders.oeHdrSalesrep.getOrders"]
|
|
63
63
|
* @commonPatterns ["Search orders by customer", "Find orders by order number", "List incomplete orders", "Filter by date range"]
|
|
64
64
|
* @workflow ["order-discovery", "order-status-tracking", "customer-order-history"]
|
|
65
65
|
* @prerequisites ["Valid authentication token", "Order access permissions"]
|
|
66
|
-
* @nextSteps ["api.orders.
|
|
66
|
+
* @nextSteps ["api.orders.oeHdr.getDocument for full details", "api.customers.customer.get for customer info"]
|
|
67
67
|
* @businessRules ["Returns only orders accessible to current user/sales rep", "Completed orders may have restricted access", "Search supports partial matches"]
|
|
68
68
|
* @functionalArea "order-and-fulfillment-management"
|
|
69
69
|
* @caching "Supports edgeCache parameter (1-8 hours) for frequently accessed order lists"
|
|
@@ -83,7 +83,7 @@ export declare class OrdersClient extends BaseServiceClient {
|
|
|
83
83
|
* @example
|
|
84
84
|
* ```typescript
|
|
85
85
|
* // Search orders with full response metadata
|
|
86
|
-
* const response = await api.orders.
|
|
86
|
+
* const response = await api.orders.oeHdr.lookup({
|
|
87
87
|
* q: '12345',
|
|
88
88
|
* completed: 'N',
|
|
89
89
|
* limit: 10
|
|
@@ -91,13 +91,13 @@ export declare class OrdersClient extends BaseServiceClient {
|
|
|
91
91
|
* console.log(`Found ${response.total} orders`);
|
|
92
92
|
*
|
|
93
93
|
* // Get just the order data
|
|
94
|
-
* const orders = await api.orders.
|
|
94
|
+
* const orders = await api.orders.oeHdr.lookupData({
|
|
95
95
|
* salesrepId: 'REP001',
|
|
96
96
|
* limit: 50
|
|
97
97
|
* });
|
|
98
98
|
*
|
|
99
99
|
* // Filter by completion status with caching
|
|
100
|
-
* const incompleteOrders = await api.orders.
|
|
100
|
+
* const incompleteOrders = await api.orders.oeHdr.lookup({
|
|
101
101
|
* completed: 'N',
|
|
102
102
|
* edgeCache: 2, // Cache for 2 hours
|
|
103
103
|
* orderBy: 'orderDate DESC'
|
|
@@ -158,13 +158,13 @@ export declare class OrdersClient extends BaseServiceClient {
|
|
|
158
158
|
* Retrieve complete order document with all related information
|
|
159
159
|
* @description Returns comprehensive order details including customer info, shipping address, line items, and totals. Includes optional postal code validation for security.
|
|
160
160
|
*
|
|
161
|
-
* @fullPath api.orders.
|
|
161
|
+
* @fullPath api.orders.oeHdr.getDocument
|
|
162
162
|
* @service orders
|
|
163
163
|
* @domain order-management
|
|
164
164
|
* @dataMethod getDocumentData - returns only the order document without metadata
|
|
165
165
|
* @discoverable true
|
|
166
166
|
* @searchTerms ["order document", "order details", "full order", "order with lines", "complete order"]
|
|
167
|
-
* @relatedEndpoints ["api.orders.
|
|
167
|
+
* @relatedEndpoints ["api.orders.oeHdr.lookup", "api.customers.customer.get", "api.items.products.get"]
|
|
168
168
|
* @commonPatterns ["Get order details", "View complete order", "Order with line items", "Full order document"]
|
|
169
169
|
* @workflow ["order-review", "order-fulfillment", "customer-service"]
|
|
170
170
|
* @prerequisites ["Valid order number", "Order access permissions", "Optional postal code for validation"]
|
|
@@ -181,19 +181,19 @@ export declare class OrdersClient extends BaseServiceClient {
|
|
|
181
181
|
* @example
|
|
182
182
|
* ```typescript
|
|
183
183
|
* // Get order document with validation
|
|
184
|
-
* const response = await api.orders.
|
|
184
|
+
* const response = await api.orders.oeHdr.getDocument(12345678, {
|
|
185
185
|
* postalCode: '12345'
|
|
186
186
|
* });
|
|
187
187
|
* console.log(`Order ${response.data.orderNo} for ${response.data.customerName}`);
|
|
188
188
|
*
|
|
189
189
|
* // Get just the document data
|
|
190
|
-
* const order = await api.orders.
|
|
190
|
+
* const order = await api.orders.oeHdr.getDocumentData(12345678);
|
|
191
191
|
* order.lines.forEach(line => {
|
|
192
192
|
* console.log(`${line.itemId}: ${line.qtyOrdered} @ $${line.unitPrice}`);
|
|
193
193
|
* });
|
|
194
194
|
*
|
|
195
195
|
* // Without postal code validation
|
|
196
|
-
* const orderDoc = await api.orders.
|
|
196
|
+
* const orderDoc = await api.orders.oeHdr.getDocument(12345678);
|
|
197
197
|
* ```
|
|
198
198
|
*/
|
|
199
199
|
getDocument: (orderNo: number, params?: OrderDocumentParams) => Promise<{
|
|
@@ -272,22 +272,22 @@ export declare class OrdersClient extends BaseServiceClient {
|
|
|
272
272
|
* Sales Representative Order Operations
|
|
273
273
|
* @description Order management functionality specific to sales representatives including territory-based order access and rep-specific reporting
|
|
274
274
|
*/
|
|
275
|
-
|
|
275
|
+
oeHdrSalesrep: {
|
|
276
276
|
/**
|
|
277
277
|
* Get order list for a specific sales representative
|
|
278
278
|
* @description Returns all orders associated with a specific sales representative, filtered by territory and permissions. Essential for sales performance tracking and customer relationship management.
|
|
279
279
|
*
|
|
280
|
-
* @fullPath api.orders.
|
|
280
|
+
* @fullPath api.orders.oeHdrSalesrep.getOrders
|
|
281
281
|
* @service orders
|
|
282
282
|
* @domain sales-management
|
|
283
283
|
* @dataMethod getOrdersData - returns only the orders array without metadata
|
|
284
284
|
* @discoverable true
|
|
285
285
|
* @searchTerms ["sales rep orders", "representative orders", "territory orders", "sales orders by rep", "rep performance"]
|
|
286
|
-
* @relatedEndpoints ["api.orders.
|
|
286
|
+
* @relatedEndpoints ["api.orders.oeHdrSalesrep.getOrderDocument", "api.orders.oeHdr.lookup", "api.customers.customer.list"]
|
|
287
287
|
* @commonPatterns ["Sales rep performance", "Territory management", "Rep order history", "Sales tracking"]
|
|
288
288
|
* @workflow ["sales-performance-tracking", "territory-management", "commission-calculation"]
|
|
289
289
|
* @prerequisites ["Valid sales representative ID", "Sales rep access permissions"]
|
|
290
|
-
* @nextSteps ["api.orders.
|
|
290
|
+
* @nextSteps ["api.orders.oeHdrSalesrep.getOrderDocument for details", "Calculate commission totals", "Territory analysis"]
|
|
291
291
|
* @businessRules ["Returns only orders within rep's territory", "Respects sales hierarchy permissions", "May include completed and pending orders"]
|
|
292
292
|
* @functionalArea "sales-and-territory-management"
|
|
293
293
|
* @performance "Territory-filtered results - typically smaller datasets than global order lists"
|
|
@@ -298,11 +298,11 @@ export declare class OrdersClient extends BaseServiceClient {
|
|
|
298
298
|
* @example
|
|
299
299
|
* ```typescript
|
|
300
300
|
* // Get all orders for a sales rep
|
|
301
|
-
* const response = await api.orders.
|
|
301
|
+
* const response = await api.orders.oeHdrSalesrep.getOrders(12345);
|
|
302
302
|
* console.log(`Rep has ${response.data.length} orders`);
|
|
303
303
|
*
|
|
304
304
|
* // Get just the orders data
|
|
305
|
-
* const repOrders = await api.orders.
|
|
305
|
+
* const repOrders = await api.orders.oeHdrSalesrep.getOrdersData(12345);
|
|
306
306
|
* const totalValue = repOrders.reduce((sum, order) => sum + order.orderTotal, 0);
|
|
307
307
|
* ```
|
|
308
308
|
*/
|
|
@@ -346,13 +346,13 @@ export declare class OrdersClient extends BaseServiceClient {
|
|
|
346
346
|
* Get specific order document for a sales representative
|
|
347
347
|
* @description Returns complete order document with sales rep context, including commission details and territory-specific information. Validates that the order belongs to the specified sales representative.
|
|
348
348
|
*
|
|
349
|
-
* @fullPath api.orders.
|
|
349
|
+
* @fullPath api.orders.oeHdrSalesrep.getOrderDocument
|
|
350
350
|
* @service orders
|
|
351
351
|
* @domain sales-management
|
|
352
352
|
* @dataMethod getOrderDocumentData - returns only the order document without metadata
|
|
353
353
|
* @discoverable true
|
|
354
354
|
* @searchTerms ["sales rep order document", "rep order details", "territory order document", "rep order with lines"]
|
|
355
|
-
* @relatedEndpoints ["api.orders.
|
|
355
|
+
* @relatedEndpoints ["api.orders.oeHdrSalesrep.getOrders", "api.orders.oeHdr.getDocument", "api.customers.customer.get"]
|
|
356
356
|
* @commonPatterns ["Rep order details", "Commission calculation", "Territory order review", "Sales order analysis"]
|
|
357
357
|
* @workflow ["sales-order-review", "commission-processing", "territory-analysis"]
|
|
358
358
|
* @prerequisites ["Valid sales rep ID", "Valid order number", "Order must belong to specified rep"]
|
|
@@ -368,11 +368,11 @@ export declare class OrdersClient extends BaseServiceClient {
|
|
|
368
368
|
* @example
|
|
369
369
|
* ```typescript
|
|
370
370
|
* // Get order document for specific sales rep
|
|
371
|
-
* const response = await api.orders.
|
|
371
|
+
* const response = await api.orders.oeHdrSalesrep.getOrderDocument(12345, 987654);
|
|
372
372
|
* console.log(`Order ${response.data.orderNo} - Commission: $${response.data.commissionAmount}`);
|
|
373
373
|
*
|
|
374
374
|
* // Get just the document data
|
|
375
|
-
* const repOrder = await api.orders.
|
|
375
|
+
* const repOrder = await api.orders.oeHdrSalesrep.getOrderDocumentData(12345, 987654);
|
|
376
376
|
* console.log(`Territory: ${repOrder.territoryCode}`);
|
|
377
377
|
* ```
|
|
378
378
|
*/
|
|
@@ -422,22 +422,22 @@ export declare class OrdersClient extends BaseServiceClient {
|
|
|
422
422
|
* Purchase Order Operations
|
|
423
423
|
* @description Comprehensive purchase order management including creation, tracking, receiving, and document generation for procurement workflows
|
|
424
424
|
*/
|
|
425
|
-
|
|
425
|
+
poHdr: {
|
|
426
426
|
/**
|
|
427
427
|
* List purchase orders with filtering and pagination
|
|
428
428
|
* @description Returns paginated purchase orders with comprehensive filtering by status, vendor, date ranges, and completion status. Essential for procurement management and receiving workflows.
|
|
429
429
|
*
|
|
430
|
-
* @fullPath api.orders.
|
|
430
|
+
* @fullPath api.orders.poHdr.list
|
|
431
431
|
* @service orders
|
|
432
432
|
* @domain procurement-management
|
|
433
433
|
* @dataMethod listData - returns only the purchase orders array without metadata
|
|
434
434
|
* @discoverable true
|
|
435
435
|
* @searchTerms ["purchase orders", "PO list", "procurement", "vendor orders", "purchase order management", "receiving"]
|
|
436
|
-
* @relatedEndpoints ["api.orders.
|
|
436
|
+
* @relatedEndpoints ["api.orders.poHdr.get", "api.orders.poHdr.getDocument", "api.orders.poHdr.scan", "api.nexus.receiving.list"]
|
|
437
437
|
* @commonPatterns ["List open POs", "Find POs by vendor", "Track receiving status", "Procurement dashboard"]
|
|
438
438
|
* @workflow ["procurement-workflow", "purchase-order-lifecycle", "receiving-management"]
|
|
439
439
|
* @prerequisites ["Valid authentication", "Purchase order access permissions"]
|
|
440
|
-
* @nextSteps ["api.orders.
|
|
440
|
+
* @nextSteps ["api.orders.poHdr.get for details", "api.nexus.receiving.create for receiving", "Update PO status"]
|
|
441
441
|
* @businessRules ["Filters by completion status", "Supports vendor and date filtering", "Pagination required for large datasets"]
|
|
442
442
|
* @functionalArea "procurement-and-purchasing"
|
|
443
443
|
* @performance "Use filtering to reduce result sets. Consider pagination for better performance."
|
|
@@ -454,14 +454,14 @@ export declare class OrdersClient extends BaseServiceClient {
|
|
|
454
454
|
* @example
|
|
455
455
|
* ```typescript
|
|
456
456
|
* // List incomplete purchase orders
|
|
457
|
-
* const response = await api.orders.
|
|
457
|
+
* const response = await api.orders.poHdr.list({
|
|
458
458
|
* complete: 'N',
|
|
459
459
|
* limit: 50
|
|
460
460
|
* });
|
|
461
461
|
* console.log(`${response.total} open purchase orders`);
|
|
462
462
|
*
|
|
463
463
|
* // Get just the PO data
|
|
464
|
-
* const openPOs = await api.orders.
|
|
464
|
+
* const openPOs = await api.orders.poHdr.listData({
|
|
465
465
|
* complete: 'N',
|
|
466
466
|
* vendorId: 'VENDOR001'
|
|
467
467
|
* });
|
|
@@ -539,17 +539,17 @@ export declare class OrdersClient extends BaseServiceClient {
|
|
|
539
539
|
* Get detailed purchase order information
|
|
540
540
|
* @description Returns comprehensive purchase order details including header information, vendor details, status, and summary totals. Used for PO management and tracking.
|
|
541
541
|
*
|
|
542
|
-
* @fullPath api.orders.
|
|
542
|
+
* @fullPath api.orders.poHdr.get
|
|
543
543
|
* @service orders
|
|
544
544
|
* @domain procurement-management
|
|
545
545
|
* @dataMethod getData - returns only the purchase order detail without metadata
|
|
546
546
|
* @discoverable true
|
|
547
547
|
* @searchTerms ["purchase order details", "PO details", "purchase order info", "PO header"]
|
|
548
|
-
* @relatedEndpoints ["api.orders.
|
|
548
|
+
* @relatedEndpoints ["api.orders.poHdr.list", "api.orders.poHdr.getDocument", "api.nexus.receiving.list"]
|
|
549
549
|
* @commonPatterns ["Get PO details", "View purchase order", "PO status check", "Vendor order info"]
|
|
550
550
|
* @workflow ["purchase-order-review", "receiving-preparation", "vendor-management"]
|
|
551
551
|
* @prerequisites ["Valid purchase order number", "PO access permissions"]
|
|
552
|
-
* @nextSteps ["api.orders.
|
|
552
|
+
* @nextSteps ["api.orders.poHdr.getDocument for full details", "Create receiving record", "Update PO status"]
|
|
553
553
|
* @businessRules ["Returns header-level information only", "Access controlled by permissions", "Status reflects current receiving state"]
|
|
554
554
|
* @functionalArea "procurement-and-purchasing"
|
|
555
555
|
* @performance "Single PO retrieval - efficient for header information"
|
|
@@ -560,11 +560,11 @@ export declare class OrdersClient extends BaseServiceClient {
|
|
|
560
560
|
* @example
|
|
561
561
|
* ```typescript
|
|
562
562
|
* // Get PO details
|
|
563
|
-
* const response = await api.orders.
|
|
563
|
+
* const response = await api.orders.poHdr.get(12345);
|
|
564
564
|
* console.log(`PO ${response.data.poNo} - Status: ${response.data.status}`);
|
|
565
565
|
*
|
|
566
566
|
* // Get just the PO data
|
|
567
|
-
* const poDetail = await api.orders.
|
|
567
|
+
* const poDetail = await api.orders.poHdr.getData(12345);
|
|
568
568
|
* ```
|
|
569
569
|
*/
|
|
570
570
|
get: (id: string | number, params?: import("../../core/base-client").CacheParams | undefined) => Promise<{
|
|
@@ -581,8 +581,8 @@ export declare class OrdersClient extends BaseServiceClient {
|
|
|
581
581
|
itemDesc?: string | undefined;
|
|
582
582
|
serialized?: string | undefined;
|
|
583
583
|
primaryBin?: string | undefined;
|
|
584
|
-
qtyOutstanding?: number | undefined;
|
|
585
584
|
unitCost?: number | undefined;
|
|
585
|
+
qtyOutstanding?: number | undefined;
|
|
586
586
|
extendedCost?: number | undefined;
|
|
587
587
|
trackBins?: string | undefined;
|
|
588
588
|
lotAssignmentRequired?: string | undefined;
|
|
@@ -627,8 +627,8 @@ export declare class OrdersClient extends BaseServiceClient {
|
|
|
627
627
|
itemDesc?: string | undefined;
|
|
628
628
|
serialized?: string | undefined;
|
|
629
629
|
primaryBin?: string | undefined;
|
|
630
|
-
qtyOutstanding?: number | undefined;
|
|
631
630
|
unitCost?: number | undefined;
|
|
631
|
+
qtyOutstanding?: number | undefined;
|
|
632
632
|
extendedCost?: number | undefined;
|
|
633
633
|
trackBins?: string | undefined;
|
|
634
634
|
lotAssignmentRequired?: string | undefined;
|
|
@@ -651,13 +651,13 @@ export declare class OrdersClient extends BaseServiceClient {
|
|
|
651
651
|
* Get complete purchase order document with all related information
|
|
652
652
|
* @description Returns comprehensive purchase order document including header, line items, vendor information, shipping details, and totals. Complete document for receiving and fulfillment processes.
|
|
653
653
|
*
|
|
654
|
-
* @fullPath api.orders.
|
|
654
|
+
* @fullPath api.orders.poHdr.getDocument
|
|
655
655
|
* @service orders
|
|
656
656
|
* @domain procurement-management
|
|
657
657
|
* @dataMethod getDocumentData - returns only the purchase order document without metadata
|
|
658
658
|
* @discoverable true
|
|
659
659
|
* @searchTerms ["purchase order document", "complete PO", "PO with lines", "full purchase order", "PO document"]
|
|
660
|
-
* @relatedEndpoints ["api.orders.
|
|
660
|
+
* @relatedEndpoints ["api.orders.poHdr.get", "api.orders.poHdr.list", "api.nexus.receiving.create"]
|
|
661
661
|
* @commonPatterns ["Complete PO details", "PO for receiving", "Full purchase order", "PO with line items"]
|
|
662
662
|
* @workflow ["purchase-order-fulfillment", "receiving-workflow", "vendor-management"]
|
|
663
663
|
* @prerequisites ["Valid purchase order number", "Document access permissions"]
|
|
@@ -672,11 +672,11 @@ export declare class OrdersClient extends BaseServiceClient {
|
|
|
672
672
|
* @example
|
|
673
673
|
* ```typescript
|
|
674
674
|
* // Get complete PO document
|
|
675
|
-
* const response = await api.orders.
|
|
675
|
+
* const response = await api.orders.poHdr.getDocument(12345);
|
|
676
676
|
* console.log(`PO ${response.data.poNo} has ${response.data.lines.length} line items`);
|
|
677
677
|
*
|
|
678
678
|
* // Get just the document data
|
|
679
|
-
* const poDoc = await api.orders.
|
|
679
|
+
* const poDoc = await api.orders.poHdr.getDocumentData(12345);
|
|
680
680
|
* poDoc.lines.forEach(line => {
|
|
681
681
|
* console.log(`${line.itemId}: ${line.qtyOrdered} (${line.qtyReceived} received)`);
|
|
682
682
|
* });
|
|
@@ -696,8 +696,8 @@ export declare class OrdersClient extends BaseServiceClient {
|
|
|
696
696
|
itemDesc?: string | undefined;
|
|
697
697
|
serialized?: string | undefined;
|
|
698
698
|
primaryBin?: string | undefined;
|
|
699
|
-
qtyOutstanding?: number | undefined;
|
|
700
699
|
unitCost?: number | undefined;
|
|
700
|
+
qtyOutstanding?: number | undefined;
|
|
701
701
|
extendedCost?: number | undefined;
|
|
702
702
|
trackBins?: string | undefined;
|
|
703
703
|
lotAssignmentRequired?: string | undefined;
|
|
@@ -745,8 +745,8 @@ export declare class OrdersClient extends BaseServiceClient {
|
|
|
745
745
|
itemDesc?: string | undefined;
|
|
746
746
|
serialized?: string | undefined;
|
|
747
747
|
primaryBin?: string | undefined;
|
|
748
|
-
qtyOutstanding?: number | undefined;
|
|
749
748
|
unitCost?: number | undefined;
|
|
749
|
+
qtyOutstanding?: number | undefined;
|
|
750
750
|
extendedCost?: number | undefined;
|
|
751
751
|
trackBins?: string | undefined;
|
|
752
752
|
lotAssignmentRequired?: string | undefined;
|
|
@@ -772,13 +772,13 @@ export declare class OrdersClient extends BaseServiceClient {
|
|
|
772
772
|
* Scan for similar purchase orders based on provided criteria
|
|
773
773
|
* @description Intelligent purchase order discovery that finds similar POs based on items, vendors, or other criteria. Useful for reordering, vendor analysis, and procurement optimization.
|
|
774
774
|
*
|
|
775
|
-
* @fullPath api.orders.
|
|
775
|
+
* @fullPath api.orders.poHdr.scan
|
|
776
776
|
* @service orders
|
|
777
777
|
* @domain procurement-management
|
|
778
778
|
* @dataMethod scanData - returns only the scan results without metadata
|
|
779
779
|
* @discoverable true
|
|
780
780
|
* @searchTerms ["PO scan", "similar purchase orders", "find similar POs", "PO search", "procurement patterns"]
|
|
781
|
-
* @relatedEndpoints ["api.orders.
|
|
781
|
+
* @relatedEndpoints ["api.orders.poHdr.list", "api.orders.poHdr.getDocument", "api.items.products.list"]
|
|
782
782
|
* @commonPatterns ["Find similar orders", "Reorder analysis", "Vendor pattern analysis", "Procurement optimization"]
|
|
783
783
|
* @workflow ["procurement-optimization", "reorder-analysis", "vendor-comparison"]
|
|
784
784
|
* @prerequisites ["Scan criteria parameters", "PO access permissions"]
|
|
@@ -798,13 +798,13 @@ export declare class OrdersClient extends BaseServiceClient {
|
|
|
798
798
|
* @example
|
|
799
799
|
* ```typescript
|
|
800
800
|
* // Scan for similar POs by items
|
|
801
|
-
* const response = await api.orders.
|
|
801
|
+
* const response = await api.orders.poHdr.scan({
|
|
802
802
|
* itemIds: ['ITEM001', 'ITEM002'],
|
|
803
803
|
* similarityThreshold: 70
|
|
804
804
|
* });
|
|
805
805
|
*
|
|
806
806
|
* // Get just the scan results
|
|
807
|
-
* const similarPOs = await api.orders.
|
|
807
|
+
* const similarPOs = await api.orders.poHdr.scanData({
|
|
808
808
|
* vendorId: 'VENDOR001',
|
|
809
809
|
* dateFrom: '2024-01-01'
|
|
810
810
|
* });
|
|
@@ -860,18 +860,18 @@ export declare class OrdersClient extends BaseServiceClient {
|
|
|
860
860
|
* Invoice Management Operations
|
|
861
861
|
* @description Invoice processing and document management with Prophet 21 integration for billing and accounting workflows
|
|
862
862
|
*/
|
|
863
|
-
|
|
863
|
+
invoiceHdr: {
|
|
864
864
|
/**
|
|
865
865
|
* Reprint an existing invoice through Prophet 21 integration
|
|
866
866
|
* @description Generates a reprint of an existing invoice through Prophet 21 system integration. Returns invoice document data and reprint status for billing and customer service workflows.
|
|
867
867
|
*
|
|
868
|
-
* @fullPath api.orders.
|
|
868
|
+
* @fullPath api.orders.invoiceHdr.reprint
|
|
869
869
|
* @service orders
|
|
870
870
|
* @domain invoice-management
|
|
871
871
|
* @dataMethod reprintData - returns only the reprint result without metadata
|
|
872
872
|
* @discoverable true
|
|
873
873
|
* @searchTerms ["invoice reprint", "reprint invoice", "invoice copy", "duplicate invoice", "invoice document"]
|
|
874
|
-
* @relatedEndpoints ["api.orders.
|
|
874
|
+
* @relatedEndpoints ["api.orders.oeHdr.getDocument", "api.customers.customer.get", "api.p21-core.company.get"]
|
|
875
875
|
* @commonPatterns ["Reprint invoice", "Customer invoice copy", "Billing document", "Invoice duplicate"]
|
|
876
876
|
* @workflow ["invoice-management", "customer-service", "billing-workflow"]
|
|
877
877
|
* @prerequisites ["Valid invoice number", "Invoice exists in Prophet 21", "Reprint permissions"]
|
|
@@ -886,11 +886,11 @@ export declare class OrdersClient extends BaseServiceClient {
|
|
|
886
886
|
* @example
|
|
887
887
|
* ```typescript
|
|
888
888
|
* // Reprint an invoice
|
|
889
|
-
* const response = await api.orders.
|
|
889
|
+
* const response = await api.orders.invoiceHdr.reprint('INV-12345');
|
|
890
890
|
* console.log(`Invoice reprint status: ${response.data.status}`);
|
|
891
891
|
*
|
|
892
892
|
* // Get just the reprint data
|
|
893
|
-
* const reprintResult = await api.orders.
|
|
893
|
+
* const reprintResult = await api.orders.invoiceHdr.reprintData('INV-12345');
|
|
894
894
|
* if (reprintResult.success) {
|
|
895
895
|
* console.log(`Reprint generated: ${reprintResult.documentUrl}`);
|
|
896
896
|
* }
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../../src/services/orders/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAeL,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC7B,MAAM,WAAW,CAAC;AAEnB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,qBAAa,YAAa,SAAQ,iBAAiB;IACjD;;;;OAIG;gBACS,IAAI,EAAE,UAAU,EAAE,OAAO,GAAE,MAAuC;IAI9E;;;OAGG;IACH,
|
|
1
|
+
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../../src/services/orders/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAeL,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC7B,MAAM,WAAW,CAAC;AAEnB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,qBAAa,YAAa,SAAQ,iBAAiB;IACjD;;;;OAIG;gBACS,IAAI,EAAE,UAAU,EAAE,OAAO,GAAE,MAAuC;IAI9E;;;OAGG;IACH,KAAK;QACH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAsDG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAOH;;;;;;WAMG;8BACyB,iBAAiB;;;;;;;;;;;QAK7C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAyCG;+BAC0B,MAAM,WAAW,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAYjE;;;;;;;WAOG;mCAC8B,MAAM,WAAW,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;MAIrE;IAEF;;;OAGG;IACH,aAAa;QACX;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAgCG;gCAC2B,MAAM;;;;;;;;;;;;;;;;;;;QAWpC;;;;;;WAMG;oCAC+B,MAAM;;;;;;;;;;QAKxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAiCG;uCACkC,MAAM,WAAW,MAAM;;;;;;;;;;;;;;;;;;;;;QAW5D;;;;;;;WAOG;2CACsC,MAAM,WAAW,MAAM;;;;;;;;;;;;MAIhE;IAEF;;;OAGG;IACH,KAAK;QACH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA2CG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAOH;;;;;;WAMG;4BACuB,uBAAuB;;;;;;;;;;;;;;;;;;;;;;QAKjD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA+BG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAGH;;;;;;WAMG;sBACiB,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAK1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAkCG;4BACuB,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAWhC;;;;;;WAMG;gCAC2B,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAKpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAyCG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAOH;;;;;;WAMG;4BACuB,uBAAuB;;;;;;;;;MAIjD;IAEF;;;OAGG;IACH,UAAU;QACR;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAkCG;6BACwB,MAAM;;;;;;;;;;;;;;;;;;;QAWjC;;;;;;WAMG;iCAC4B,MAAM;;;;;;;;;;MAIrC;IAEF;;;;;;;;;;;;;;;OAeG;IACH,cAAc;;;;;;;;;;;;OAA2D;IAEzE;;;;;;;;;;;;OAYG;IACH,kBAAkB;;;OAGhB;CACH"}
|