@simpleapps-com/augur-api/dist/cjs/services/orders/client.d.ts

TypeScript client library for Augur microservices API endpoints

import { HTTPClient } from '../../core/client';
import { BaseServiceClient } from '../../core/base-client';
import { type HealthCheckResource, type HealthCheckDataResource, type InvoiceHdrResource, type InvoiceHdrDataResource, type OeHdrResource, type OeHdrDataResource, type OeHdrSalesrepResource, type OeHdrSalesrepDataResource, type PickTicketsResource, type PickTicketsDataResource, type PoHdrResource, type PoHdrDataResource } from './resources';
/**
 * Orders Service Client - OpenAPI Path Mirroring Implementation
 * @description Comprehensive order management functionality for the Augur platform covering the complete order lifecycle from creation through fulfillment, including order processing, invoicing, purchase orders, and sales representative management. Follows strict OpenAPI path mirroring pattern.
 *
 * @fullPath api.orders
 * @service orders
 * @domain order-management
 * @discoverable true
 * @searchTerms ["orders", "order management", "purchase orders", "invoices", "sales orders", "order processing", "fulfillment"]
 * @relatedEndpoints ["api.customers.customer.list", "api.items.products.list", "api.pricing.job-pricing.create", "api.commerce.checkout.process"]
 * @commonPatterns ["Order lookup", "Order tracking", "Purchase order management", "Invoice processing", "Sales rep orders"]
 * @functionalArea "order-and-fulfillment-management"
 * @workflow ["order-processing", "purchase-order-workflow", "invoice-management", "sales-order-lifecycle"]
 * @businessRules ["Orders require valid customer and items", "Purchase orders track receiving status", "Invoices integrate with Prophet 21", "Access filtered by sales rep permissions"]
 * @performance "Supports pagination and filtering. Use edgeCache for frequently accessed data."
 *
 * @example
 * ```typescript
 * const api = new AugurAPI({ bearerToken: 'token', siteId: 'site' });
 *
 * // OpenAPI Path Mirroring Examples:
 * // /oe-hdr/lookup → api.orders.oeHdr.lookup.list()
 * const ordersResponse = await api.orders.oeHdr.lookup.list({ limit: 10, q: '12345' });
 * console.log(`Found ${ordersResponse.total} orders`);
 *
 * // /oe-hdr/{orderNo}/doc → api.orders.oeHdr.doc.get(orderNo)
 * const orderDoc = await api.orders.oeHdr.doc.get(12345678, { postalCode: '12345' });
 *
 * // /oe-hdr-salesrep/{salesrepId}/oe-hdr → api.orders.oeHdrSalesrep.oeHdr.list(salesrepId)
 * const repOrders = await api.orders.oeHdrSalesrep.oeHdr.list(12345);
 *
 * // /po-hdr/scan → api.orders.poHdr.scan.create(params)
 * const similarPOs = await api.orders.poHdr.scan.create({ vendorId: 'VENDOR001' });
 * ```
 */
export declare class OrdersClient extends BaseServiceClient {
    /** Health check resource */
    readonly healthCheck: HealthCheckResource;
    /** Health check data resource (data-only) */
    readonly healthCheckData: HealthCheckDataResource;
    /** Invoice header resource */
    readonly invoiceHdr: InvoiceHdrResource;
    /** Invoice header data resource (data-only) */
    readonly invoiceHdrData: InvoiceHdrDataResource;
    /** Order header resource */
    readonly oeHdr: OeHdrResource;
    /** Order header data resource (data-only) */
    readonly oeHdrData: OeHdrDataResource;
    /** Sales representative order header resource */
    readonly oeHdrSalesrep: OeHdrSalesrepResource;
    /** Sales representative order header data resource (data-only) */
    readonly oeHdrSalesrepData: OeHdrSalesrepDataResource;
    /** Pick tickets resource */
    readonly pickTickets: PickTicketsResource;
    /** Pick tickets data resource (data-only) */
    readonly pickTicketsData: PickTicketsDataResource;
    /** Purchase order header resource */
    readonly poHdr: PoHdrResource;
    /** Purchase order header data resource (data-only) */
    readonly poHdrData: PoHdrDataResource;
    /**
     * Create a new OrdersClient instance
     * @param http Configured HTTPClient instance with authentication
     * @param baseUrl Base URL for the Orders API (default: https://orders.augur-api.com)
     */
    constructor(http: HTTPClient, baseUrl?: string);
}
//# sourceMappingURL=client.d.ts.map