@simpleapps-com/augur-api 0.1.6 → 0.1.8

package/dist/types/core/errors.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../../src/core/errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,MAAM,WAAW,aAAc,SAAQ,KAAK;IAC1C,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gBAAgB,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;CACzC;AAED,qBAAa,UAAW,SAAQ,KAAM,YAAW,aAAa;IACrD,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gBAAgB,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;gBAEnC,MAAM,EAAE;QAClB,OAAO,EAAE,MAAM,CAAC;QAChB,IAAI,EAAE,MAAM,CAAC;QACb,UAAU,EAAE,MAAM,CAAC;QACnB,OAAO,EAAE,MAAM,CAAC;QAChB,QAAQ,EAAE,MAAM,CAAC;QACjB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,gBAAgB,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;KACzC;CAeF;AAED,qBAAa,eAAgB,SAAQ,UAAU;gBACjC,MAAM,EAAE;QAClB,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,MAAM,CAAC;QAChB,QAAQ,EAAE,MAAM,CAAC;QACjB,gBAAgB,EAAE,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;KACxC;CAOF;AAED,qBAAa,mBAAoB,SAAQ,UAAU;gBACrC,MAAM,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE;CAO3E;AAED,qBAAa,aAAc,SAAQ,UAAU;gBAC/B,MAAM,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE;CAO3E;AAED,qBAAa,cAAe,SAAQ,UAAU;gBAChC,MAAM,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE;CAO3E"}
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../../src/core/errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,MAAM,WAAW,aAAc,SAAQ,KAAK;IAC1C,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gBAAgB,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;CACzC;AAED,qBAAa,UAAW,SAAQ,KAAM,YAAW,aAAa;IACrD,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gBAAgB,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;gBAEnC,MAAM,EAAE;QAClB,OAAO,EAAE,MAAM,CAAC;QAChB,IAAI,EAAE,MAAM,CAAC;QACb,UAAU,EAAE,MAAM,CAAC;QACnB,OAAO,EAAE,MAAM,CAAC;QAChB,QAAQ,EAAE,MAAM,CAAC;QACjB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,gBAAgB,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;KACzC;CAeF;AAED,qBAAa,eAAgB,SAAQ,UAAU;gBACjC,MAAM,EAAE;QAClB,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,MAAM,CAAC;QAChB,QAAQ,EAAE,MAAM,CAAC;QACjB,gBAAgB,EAAE,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;KACxC;IAQD;;;OAGG;IACH,kBAAkB,IAAI,MAAM,EAAE;IAW9B;;;OAGG;IACH,iBAAiB,IAAI,KAAK,CAAC;QACzB,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;QAChB,IAAI,EAAE,MAAM,CAAC;QACb,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;KACpB,CAAC;IAcF;;;OAGG;IACH,QAAQ,IAAI,MAAM;CAUnB;AAED,qBAAa,mBAAoB,SAAQ,UAAU;gBACrC,MAAM,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE;CAO3E;AAED,qBAAa,aAAc,SAAQ,UAAU;gBAC/B,MAAM,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE;CAO3E;AAED,qBAAa,cAAe,SAAQ,UAAU;gBAChC,MAAM,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE;CAO3E"}

package/dist/types/services/customers/client.d.ts

@@ -401,27 +401,54 @@ export declare class CustomersClient extends BaseServiceClient {
             /**
              * List customer orders
              * @description Returns customer orders with different detail levels based on fullDocument parameter
-             * @param customerId Customer ID
+             * @param customerId Customer ID (number)
              * @param params Optional filtering and pagination parameters
-             * @param params.fullDocument Controls response detail level:
-             *   - 'N' (default): Returns order headers only (oeHdr) - summary information without line items
-             *   - 'Y': Returns complete order documents with orderLines array and shipping details
-             * @returns Array of customer orders (structure varies based on fullDocument parameter)
+             * @param params.addressId Filter by specific ship-to address ID (number, optional)
+             * @param params.fullDocument Controls response detail level (string, optional):
+             *   - 'Y' (default): Returns complete order documents with orderLines array and shipping details
+             *   - 'N': Returns order headers only - summary information without line items
+             * @param params.limit Maximum number of results to return (number, optional, default: 10)
+             * @param params.offset Number of results to skip for pagination (number, optional, default: 0)
+             * @param params.orderBy Sort ordering in format 'field|direction' (string, optional, default: 'date_created|DESC')
+             * @param params.q Search query string (string, optional)
+             * @returns Promise resolving to either OrderHeaderListResponse or OrderDocumentListResponse
              * @throws ValidationError When parameters are invalid or response is malformed
-             * @example
+             *
+             * @example Basic usage
              * ```typescript
-             * // Get order headers only (summary information)
-             * const orderHeaders = await client.customer.orders.list(12345, { fullDocument: 'N' });
-             * // Returns: OrderHeaderListResponse
+             * // Get complete order documents (default behavior)
+             * const fullOrders = await client.customer.orders.list(12345);
+             * // Returns: OrderDocumentListResponse
              *
+             * // Get order headers with pagination
+             * const paginatedHeaders = await client.customer.orders.list(12345, {
+             *   limit: 25,
+             *   offset: 50,
+             *   fullDocument: 'N'
+             * });
+             * ```
+             *
+             * @example Advanced usage
+             * ```typescript
              * // Get complete order documents with line items
-             * const fullOrders = await client.customer.orders.list(12345, { fullDocument: 'Y' });
+             * const fullOrders = await client.customer.orders.list(12345, {
+             *   fullDocument: 'Y',
+             *   orderBy: 'order_date|DESC',
+             *   q: 'PO-2023'
+             * });
              * // Returns: OrderDocumentListResponse
              *
-             * // Default behavior (same as fullDocument: 'N')
-             * const orders = await client.customer.orders.list(12345);
-             * // Returns: OrderHeaderListResponse
+             * // Filter by ship-to address
+             * const addressOrders = await client.customer.orders.list(12345, {
+             *   addressId: 67890,
+             *   fullDocument: 'N'
+             * });
              * ```
+             *
+             * @note Parameter Types
+             * - fullDocument must be exactly 'Y' or 'N' (strings, not boolean)
+             * - orderBy format: 'field_name|ASC' or 'field_name|DESC'
+             * - All parameters are optional; method works without any parameters
              */
             list: (customerId: number, params?: OrderListParams) => Promise<OrderHeaderListResponse | OrderDocumentListResponse>;
             /**

package/dist/types/services/customers/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../../src/services/customers/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EA8BL,uBAAuB,EACvB,yBAAyB,EACzB,qBAAqB,EAiBrB,oBAAoB,EACpB,mBAAmB,EACnB,iBAAiB,EACjB,sBAAsB,EACtB,iBAAiB,EACjB,uBAAuB,EACvB,yBAAyB,EACzB,eAAe,EACf,iBAAiB,EACjB,eAAe,EACf,uBAAuB,EACxB,MAAM,WAAW,CAAC;AAEnB;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,eAAgB,SAAQ,iBAAiB;IACpD;;;;OAIG;gBACS,IAAI,EAAE,UAAU,EAAE,OAAO,GAAE,MAA0C;IAIjF;;;OAGG;IACH,QAAQ;QACN;;;;;;;;;;;;;;;;;;WAkBG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAGH;;;;;;;;;;;WAWG;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAGH;;;;;;;;;;WAUG;yBACoB,oBAAoB;;;;;;;;;;;;;;;;;;;;;QAY3C;;;WAGG;;YAED;;;;;;;;;;;eAWG;+BACsB,MAAM,UAAU,iBAAiB;;;;;;;;;;;;;;;;;;;;;;QAc5D;;;WAGG;;YAED;;;;;;;;;;;eAWG;+BACsB,MAAM,UAAU,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAa1D;;;;;;;;;;;;;;;;;eAiBG;iCACwB,MAAM,QAAQ,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAc9D;;;WAGG;;YAED;;;;;;;;;;;;;;;eAeG;+BACsB,MAAM,WAAW,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAajE;;;;;;;;;;;;;;;;;;eAkBG;iCACwB,MAAM,QAAQ,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAcpE;;;WAGG;;YAED;;;;;;;;;;;;;;;;;;;;;;;;eAwBG;+BAEW,MAAM,WACT,eAAe,KACvB,OAAO,CAAC,uBAAuB,GAAG,yBAAyB,CAAC;YAmB/D;;;;;;;;;;;;eAYG;8BACqB,MAAM,WAAW,MAAM,KAAG,OAAO,CAAC,qBAAqB,CAAC;;QAalF;;;WAGG;;YAED;;;;;;;;;;;eAWG;+BACsB,MAAM,UAAU,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAa1D;;;;;;;;;;;eAWG;8BACqB,MAAM,aAAa,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAanD;;;WAGG;;YAED;;;;;;;;;;;eAWG;+BACsB,MAAM,WAAW,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAazD;;;;;;;;;;;eAWG;8BACqB,MAAM,WAAW,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAajD;;;WAGG;;YAED;;;;;;;;;;;;;eAaG;+BACsB,MAAM,WAAW,uBAAuB;;;;;;;;;;;;;;;;;;MAanE;IAEF;;;OAGG;IACH,QAAQ;QACN;;;;;;;;;;;WAWG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAGH;;;;;;;;;;;WAWG;qCACgC,MAAM;;;;;;;;;;;;;QAYzC;;;;;;;;;;;;;;WAcG;kCAC6B,MAAM,WAAW,sBAAsB;;;;;;;;;;;;;;;QAavE;;;;;;;;;;WAUG;0CACqC,MAAM;;;;;;;;;;;;;;;;QAY9C;;;;;;;;;;WAUG;;;;;;;;;;;;;MAQH;IAEF;;;OAGG;IACH,aAAa;QACX;;;;;;;;;;WAUG;;;;;;;;;;;;;MAQH;IAEF;;;OAGG;IACH,yBAAyB;QACvB;;;;;;;;;;WAUG;;;;;;;;;;;;;MAQH;IAEF;;;;;;;;;;OAUG;IACH,cAAc;;;;;;;;;;OAA2D;CAC1E"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../../src/services/customers/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EA8BL,uBAAuB,EACvB,yBAAyB,EACzB,qBAAqB,EAiBrB,oBAAoB,EACpB,mBAAmB,EACnB,iBAAiB,EACjB,sBAAsB,EACtB,iBAAiB,EACjB,uBAAuB,EACvB,yBAAyB,EACzB,eAAe,EACf,iBAAiB,EACjB,eAAe,EACf,uBAAuB,EACxB,MAAM,WAAW,CAAC;AAEnB;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,eAAgB,SAAQ,iBAAiB;IACpD;;;;OAIG;gBACS,IAAI,EAAE,UAAU,EAAE,OAAO,GAAE,MAA0C;IAIjF;;;OAGG;IACH,QAAQ;QACN;;;;;;;;;;;;;;;;;;WAkBG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAGH;;;;;;;;;;;WAWG;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAGH;;;;;;;;;;WAUG;yBACoB,oBAAoB;;;;;;;;;;;;;;;;;;;;;QAY3C;;;WAGG;;YAED;;;;;;;;;;;eAWG;+BACsB,MAAM,UAAU,iBAAiB;;;;;;;;;;;;;;;;;;;;;;QAc5D;;;WAGG;;YAED;;;;;;;;;;;eAWG;+BACsB,MAAM,UAAU,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAa1D;;;;;;;;;;;;;;;;;eAiBG;iCACwB,MAAM,QAAQ,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAc9D;;;WAGG;;YAED;;;;;;;;;;;;;;;eAeG;+BACsB,MAAM,WAAW,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAajE;;;;;;;;;;;;;;;;;;eAkBG;iCACwB,MAAM,QAAQ,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAcpE;;;WAGG;;YAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;eAmDG;+BAEW,MAAM,WACT,eAAe,KACvB,OAAO,CAAC,uBAAuB,GAAG,yBAAyB,CAAC;YAmB/D;;;;;;;;;;;;eAYG;8BACqB,MAAM,WAAW,MAAM,KAAG,OAAO,CAAC,qBAAqB,CAAC;;QAalF;;;WAGG;;YAED;;;;;;;;;;;eAWG;+BACsB,MAAM,UAAU,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAa1D;;;;;;;;;;;eAWG;8BACqB,MAAM,aAAa,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAanD;;;WAGG;;YAED;;;;;;;;;;;eAWG;+BACsB,MAAM,WAAW,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAazD;;;;;;;;;;;eAWG;8BACqB,MAAM,WAAW,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAajD;;;WAGG;;YAED;;;;;;;;;;;;;eAaG;+BACsB,MAAM,WAAW,uBAAuB;;;;;;;;;;;;;;;;;;MAanE;IAEF;;;OAGG;IACH,QAAQ;QACN;;;;;;;;;;;WAWG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAGH;;;;;;;;;;;WAWG;qCACgC,MAAM;;;;;;;;;;;;;QAYzC;;;;;;;;;;;;;;WAcG;kCAC6B,MAAM,WAAW,sBAAsB;;;;;;;;;;;;;;;QAavE;;;;;;;;;;WAUG;0CACqC,MAAM;;;;;;;;;;;;;;;;QAY9C;;;;;;;;;;WAUG;;;;;;;;;;;;;MAQH;IAEF;;;OAGG;IACH,aAAa;QACX;;;;;;;;;;WAUG;;;;;;;;;;;;;MAQH;IAEF;;;OAGG;IACH,yBAAyB;QACvB;;;;;;;;;;WAUG;;;;;;;;;;;;;MAQH;IAEF;;;;;;;;;;OAUG;IACH,cAAc;;;;;;;;;;OAA2D;CAC1E"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@simpleapps-com/augur-api",
-  "version": "0.1.6",
+  "version": "0.1.8",
   "description": "TypeScript client library for Augur microservices API endpoints",
   "keywords": [
     "augur",