@simpleapps-com/augur-api 0.1.0

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

@@ -0,0 +1,966 @@
+import { BaseServiceClient } from '../../core/base-client';
+import type { HTTPClient } from '../../core/client';
+import { CustomerLookupParams, ContactCreateParams, ContactListParams, ContactCustomersParams, AddressListParams, ShipToAddressListParams, ShipToAddressCreateParams, OrderListParams, InvoiceListParams, QuoteListParams, PurchasedItemListParams } from './schemas';
+/**
+ * Customers API Client
+ * @description Client for interacting with Customers microservice API endpoints
+ * @example
+ * ```typescript
+ * import { HTTPClient } from '@augur/api-client/core';
+ * import { CustomersClient } from '@augur/api-client/services/customers';
+ *
+ * const http = new HTTPClient('customers', { siteId: 'your-site-id', bearerToken: 'your-token' });
+ * const customers = new CustomersClient(http);
+ *
+ * // List customers
+ * const customerList = await customers.customer.list({ limit: 10 });
+ *
+ * // Get customer by ID
+ * const customer = await customers.customer.get(123);
+ *
+ * // Search customers
+ * const searchResults = await customers.customer.lookup({ q: 'Acme Corp' });
+ * ```
+ */
+export declare class CustomersClient extends BaseServiceClient {
+    /**
+     * Create a new CustomersClient instance
+     * @param http Configured HTTPClient instance
+     * @param baseUrl Base URL for the Customers API (default: https://customers.augur-api.com)
+     */
+    constructor(http: HTTPClient, baseUrl?: string);
+    /**
+     * Customer management endpoints
+     * @description Methods for customer CRUD operations and lookups
+     */
+    customer: {
+        /**
+         * Retrieve a paginated list of customer documents
+         * @description Returns customers with optional filtering by class5Id and search query
+         * @param params Optional filtering and pagination parameters
+         * @returns Array of customer documents
+         * @throws ValidationError When parameters are invalid or response is malformed
+         * @example
+         * ```typescript
+         * // Get all customers
+         * const customers = await client.customer.list();
+         *
+         * // Get filtered customers
+         * const filtered = await client.customer.list({
+         *   class5Id: 'GOLD',
+         *   limit: 50,
+         *   q: 'Acme'
+         * });
+         * ```
+         */
+        list: (params?: {
+            edgeCache?: 3 | 2 | 4 | 1 | 5 | 8 | undefined;
+            limit?: number | undefined;
+            offset?: number | undefined;
+            q?: string | undefined;
+            orderBy?: string | undefined;
+            class5Id?: string | undefined;
+        } | undefined) => Promise<{
+            data: {
+                customerId: number;
+                dateCreated: string;
+                dateLastModified: string;
+                companyId: string;
+                customerName: string;
+                salesrepId: string;
+                deleteFlag: string;
+                updateCd?: number | undefined;
+                customerUid?: number | undefined;
+                class1Id?: string | undefined;
+                class2Id?: string | undefined;
+                class3Id?: string | undefined;
+                class4Id?: string | undefined;
+                class5Id?: string | undefined;
+                sicCode?: number | undefined;
+                poNoRequired?: string | undefined;
+                defaultBranchId?: string | undefined;
+                webEnabledFlag?: string | undefined;
+                useLastMarginPricingFlag?: string | undefined;
+                sourcePriceCd?: number | undefined;
+                jobPricing?: string | undefined;
+                alwaysUseJobPrice?: string | undefined;
+                allowNonJobItem?: string | undefined;
+                jobNumberRequiredFlag?: string | undefined;
+                creditLimit?: number | undefined;
+                paymentTerms?: string | undefined;
+                taxExemptFlag?: string | undefined;
+                addresses?: unknown[] | undefined;
+                contacts?: unknown[] | undefined;
+                shipToAddresses?: unknown[] | undefined;
+            }[];
+            status: number;
+            options?: Record<string, unknown>[] | undefined;
+            message?: string | undefined;
+            totalResults?: number | undefined;
+            count?: number | undefined;
+        }>;
+        /**
+         * Get complete customer document by ID
+         * @description Returns full customer document including addresses, contacts, and ship-to addresses
+         * @param customerId Customer ID
+         * @returns Complete customer document
+         * @throws ValidationError When response is malformed
+         * @example
+         * ```typescript
+         * const customer = await client.customer.get(12345);
+         * console.log(customer.data.customerName, customer.data.addresses);
+         * ```
+         */
+        get: (id: string | number, params?: import("../../core/base-client").CacheParams | undefined) => Promise<{
+            data: {
+                customerId: number;
+                dateCreated: string;
+                dateLastModified: string;
+                companyId: string;
+                customerName: string;
+                salesrepId: string;
+                deleteFlag: string;
+                updateCd?: number | undefined;
+                customerUid?: number | undefined;
+                class1Id?: string | undefined;
+                class2Id?: string | undefined;
+                class3Id?: string | undefined;
+                class4Id?: string | undefined;
+                class5Id?: string | undefined;
+                sicCode?: number | undefined;
+                poNoRequired?: string | undefined;
+                defaultBranchId?: string | undefined;
+                webEnabledFlag?: string | undefined;
+                useLastMarginPricingFlag?: string | undefined;
+                sourcePriceCd?: number | undefined;
+                jobPricing?: string | undefined;
+                alwaysUseJobPrice?: string | undefined;
+                allowNonJobItem?: string | undefined;
+                jobNumberRequiredFlag?: string | undefined;
+                creditLimit?: number | undefined;
+                paymentTerms?: string | undefined;
+                taxExemptFlag?: string | undefined;
+                addresses?: unknown[] | undefined;
+                contacts?: unknown[] | undefined;
+                shipToAddresses?: unknown[] | undefined;
+            };
+            status: number;
+            options?: Record<string, unknown>[] | undefined;
+            message?: string | undefined;
+            totalResults?: number | undefined;
+            count?: number | undefined;
+        }>;
+        /**
+         * Search for customers by name or ID with summary information
+         * @description Returns customer ID and name for lookup purposes
+         * @param params Search parameters with required query string
+         * @returns Array of customer lookup results
+         * @throws ValidationError When parameters are invalid or response is malformed
+         * @example
+         * ```typescript
+         * const results = await client.customer.lookup({ q: 'Acme Corporation' });
+         * ```
+         */
+        lookup: (params: CustomerLookupParams) => Promise<{
+            data: {
+                customerId: number;
+                customerName: string;
+            }[];
+            status: number;
+            options?: Record<string, unknown>[] | undefined;
+            message?: string | undefined;
+            totalResults?: number | undefined;
+            count?: number | undefined;
+        }>;
+        /**
+         * Customer address management
+         * @description Methods for looking up customer addresses
+         */
+        addresses: {
+            /**
+             * Lookup customer addresses with search functionality
+             * @description Returns customer addresses matching search query
+             * @param customerId Customer ID
+             * @param params Search parameters with required query string
+             * @returns Array of customer addresses
+             * @throws ValidationError When parameters are invalid or response is malformed
+             * @example
+             * ```typescript
+             * const addresses = await client.customer.addresses.list(12345, { q: 'Main' });
+             * ```
+             */
+            list: (customerId: number, params: AddressListParams) => Promise<{
+                data: {
+                    state: string;
+                    customerId: number;
+                    city: string;
+                    addressId: number;
+                    addressName: string;
+                    address1: string;
+                    zipCode: string;
+                    country: string;
+                    phoneNumber?: string | undefined;
+                    isPrimary?: boolean | undefined;
+                    address2?: string | undefined;
+                    faxNumber?: string | undefined;
+                }[];
+                status: number;
+                options?: Record<string, unknown>[] | undefined;
+                message?: string | undefined;
+                totalResults?: number | undefined;
+                count?: number | undefined;
+            }>;
+        };
+        /**
+         * Customer contact management
+         * @description Methods for managing customer contacts
+         */
+        contacts: {
+            /**
+             * Lookup contacts associated with a customer
+             * @description Returns contacts matching search query for the specified customer
+             * @param customerId Customer ID
+             * @param params Search parameters with required query string
+             * @returns Array of customer contacts
+             * @throws ValidationError When parameters are invalid or response is malformed
+             * @example
+             * ```typescript
+             * const contacts = await client.customer.contacts.list(12345, { q: 'John' });
+             * ```
+             */
+            list: (customerId: number, params: ContactListParams) => Promise<{
+                data: {
+                    email: string;
+                    customerId: number;
+                    contactId: number;
+                    firstName: string;
+                    lastName: string;
+                    title?: string | undefined;
+                    role?: string | undefined;
+                    dateCreated?: string | undefined;
+                    dateLastModified?: string | undefined;
+                    phoneNumber?: string | undefined;
+                    isPrimary?: boolean | undefined;
+                    webEnabled?: boolean | undefined;
+                    loginCredentials?: {
+                        username?: string | undefined;
+                        lastLogin?: string | undefined;
+                    } | undefined;
+                    permissions?: {
+                        canViewPricing?: boolean | undefined;
+                        canPlaceOrders?: boolean | undefined;
+                        canViewInvoices?: boolean | undefined;
+                    } | undefined;
+                }[];
+                status: number;
+                options?: Record<string, unknown>[] | undefined;
+                message?: string | undefined;
+                totalResults?: number | undefined;
+                count?: number | undefined;
+            }>;
+            /**
+             * Create a new contact for a customer
+             * @description Creates a new contact with permissions and role information
+             * @param customerId Customer ID
+             * @param data Contact creation parameters
+             * @returns Created contact details
+             * @throws ValidationError When data is invalid or response is malformed
+             * @example
+             * ```typescript
+             * const newContact = await client.customer.contacts.create(12345, {
+             *   firstName: 'Jane',
+             *   lastName: 'Doe',
+             *   email: 'jane.doe@acme.com',
+             *   title: 'Procurement Specialist',
+             *   role: 'BUYER'
+             * });
+             * ```
+             */
+            create: (customerId: number, data: ContactCreateParams) => Promise<{
+                data: {
+                    email: string;
+                    customerId: number;
+                    contactId: number;
+                    firstName: string;
+                    lastName: string;
+                    title?: string | undefined;
+                    role?: string | undefined;
+                    dateCreated?: string | undefined;
+                    dateLastModified?: string | undefined;
+                    phoneNumber?: string | undefined;
+                    isPrimary?: boolean | undefined;
+                    webEnabled?: boolean | undefined;
+                    loginCredentials?: {
+                        username?: string | undefined;
+                        lastLogin?: string | undefined;
+                    } | undefined;
+                    permissions?: {
+                        canViewPricing?: boolean | undefined;
+                        canPlaceOrders?: boolean | undefined;
+                        canViewInvoices?: boolean | undefined;
+                    } | undefined;
+                };
+                status: number;
+                options?: Record<string, unknown>[] | undefined;
+                message?: string | undefined;
+                totalResults?: number | undefined;
+                count?: number | undefined;
+            }>;
+        };
+        /**
+         * Customer ship-to address management
+         * @description Methods for managing customer ship-to addresses
+         */
+        shipTo: {
+            /**
+             * List customer ship-to addresses
+             * @description Returns ship-to addresses with optional search filtering
+             * @param customerId Customer ID
+             * @param params Optional search and pagination parameters
+             * @returns Array of ship-to addresses
+             * @throws ValidationError When parameters are invalid or response is malformed
+             * @example
+             * ```typescript
+             * // Get all ship-to addresses
+             * const shipToAddresses = await client.customer.shipTo.list(12345, {});
+             *
+             * // Search ship-to addresses
+             * const filtered = await client.customer.shipTo.list(12345, { q: 'warehouse' });
+             * ```
+             */
+            list: (customerId: number, params?: ShipToAddressListParams) => Promise<{
+                data: {
+                    state: string;
+                    customerId: number;
+                    city: string;
+                    shipToName: string;
+                    shipToId: number;
+                    address1: string;
+                    zipCode: string;
+                    country: string;
+                    dateCreated?: string | undefined;
+                    phoneNumber?: string | undefined;
+                    address2?: string | undefined;
+                    contactName?: string | undefined;
+                    deliveryInstructions?: string | undefined;
+                    isDefault?: boolean | undefined;
+                }[];
+                status: number;
+                options?: Record<string, unknown>[] | undefined;
+                message?: string | undefined;
+                totalResults?: number | undefined;
+                count?: number | undefined;
+            }>;
+            /**
+             * Create a new ship-to address for a customer
+             * @description Creates a new shipping destination address
+             * @param customerId Customer ID
+             * @param data Ship-to address creation parameters
+             * @returns Created ship-to address details
+             * @throws ValidationError When data is invalid or response is malformed
+             * @example
+             * ```typescript
+             * const newShipTo = await client.customer.shipTo.create(12345, {
+             *   shipToName: 'New Warehouse',
+             *   address1: '789 Commerce Drive',
+             *   city: 'Atlanta',
+             *   state: 'GA',
+             *   zipCode: '30309',
+             *   country: 'USA'
+             * });
+             * ```
+             */
+            create: (customerId: number, data: ShipToAddressCreateParams) => Promise<{
+                data: {
+                    state: string;
+                    customerId: number;
+                    city: string;
+                    shipToName: string;
+                    shipToId: number;
+                    address1: string;
+                    zipCode: string;
+                    country: string;
+                    dateCreated?: string | undefined;
+                    phoneNumber?: string | undefined;
+                    address2?: string | undefined;
+                    contactName?: string | undefined;
+                    deliveryInstructions?: string | undefined;
+                    isDefault?: boolean | undefined;
+                };
+                status: number;
+                options?: Record<string, unknown>[] | undefined;
+                message?: string | undefined;
+                totalResults?: number | undefined;
+                count?: number | undefined;
+            }>;
+        };
+        /**
+         * Customer order management
+         * @description Methods for viewing customer orders
+         */
+        orders: {
+            /**
+             * List customer orders
+             * @description Returns customer orders with optional summary or full document mode
+             * @param customerId Customer ID
+             * @param params Optional filtering and pagination parameters
+             * @returns Array of customer orders
+             * @throws ValidationError When parameters are invalid or response is malformed
+             * @example
+             * ```typescript
+             * // Get order summaries
+             * const orders = await client.customer.orders.list(12345, { fullDocument: false });
+             *
+             * // Get full order documents
+             * const fullOrders = await client.customer.orders.list(12345, { fullDocument: true });
+             * ```
+             */
+            list: (customerId: number, params?: OrderListParams) => Promise<{
+                data: {
+                    customerId: number;
+                    orderNo: number;
+                    orderDate: string;
+                    orderStatus: string;
+                    totalAmount: number;
+                    shipping?: {
+                        method?: string | undefined;
+                        cost?: number | undefined;
+                        trackingNumber?: string | undefined;
+                        shipDate?: string | undefined;
+                    } | undefined;
+                    shipToId?: number | undefined;
+                    salesRepId?: string | undefined;
+                    poNumber?: string | undefined;
+                    orderLines?: {
+                        lineNo: number;
+                        quantity: number;
+                        unitPrice: number;
+                        itemId: string;
+                        description: string;
+                        extendedPrice: number;
+                        shipQuantity?: number | undefined;
+                        backorderQuantity?: number | undefined;
+                    }[] | undefined;
+                    billing?: {
+                        total?: number | undefined;
+                        shipping?: number | undefined;
+                        subtotal?: number | undefined;
+                        tax?: number | undefined;
+                    } | undefined;
+                }[];
+                status: number;
+                options?: Record<string, unknown>[] | undefined;
+                message?: string | undefined;
+                totalResults?: number | undefined;
+                count?: number | undefined;
+            }>;
+            /**
+             * Get specific customer order details
+             * @description Returns complete order information including line items and shipping
+             * @param customerId Customer ID
+             * @param orderNo Order number
+             * @returns Complete order details
+             * @throws ValidationError When response is malformed
+             * @example
+             * ```typescript
+             * const order = await client.customer.orders.get(12345, 123456);
+             * ```
+             */
+            get: (customerId: number, orderNo: number) => Promise<{
+                data: {
+                    customerId: number;
+                    orderNo: number;
+                    orderDate: string;
+                    orderStatus: string;
+                    totalAmount: number;
+                    shipping?: {
+                        method?: string | undefined;
+                        cost?: number | undefined;
+                        trackingNumber?: string | undefined;
+                        shipDate?: string | undefined;
+                    } | undefined;
+                    shipToId?: number | undefined;
+                    salesRepId?: string | undefined;
+                    poNumber?: string | undefined;
+                    orderLines?: {
+                        lineNo: number;
+                        quantity: number;
+                        unitPrice: number;
+                        itemId: string;
+                        description: string;
+                        extendedPrice: number;
+                        shipQuantity?: number | undefined;
+                        backorderQuantity?: number | undefined;
+                    }[] | undefined;
+                    billing?: {
+                        total?: number | undefined;
+                        shipping?: number | undefined;
+                        subtotal?: number | undefined;
+                        tax?: number | undefined;
+                    } | undefined;
+                };
+                status: number;
+                options?: Record<string, unknown>[] | undefined;
+                message?: string | undefined;
+                totalResults?: number | undefined;
+                count?: number | undefined;
+            }>;
+        };
+        /**
+         * Customer invoice management
+         * @description Methods for viewing customer invoices
+         */
+        invoices: {
+            /**
+             * List customer invoices
+             * @description Returns customer invoices with required search query
+             * @param customerId Customer ID
+             * @param params Search parameters with required query string and optional shipToId filter
+             * @returns Array of customer invoices
+             * @throws ValidationError When parameters are invalid or response is malformed
+             * @example
+             * ```typescript
+             * const invoices = await client.customer.invoices.list(12345, { q: '2023' });
+             * ```
+             */
+            list: (customerId: number, params: InvoiceListParams) => Promise<{
+                data: {
+                    status: string;
+                    customerId: number;
+                    totalAmount: number;
+                    invoiceNo: number;
+                    invoiceDate: string;
+                    dueDate: string;
+                    balanceAmount: number;
+                    shipToId?: number | undefined;
+                    orderNo?: number | undefined;
+                    invoiceLines?: {
+                        lineNo: number;
+                        quantity: number;
+                        unitPrice: number;
+                        itemId: string;
+                        description: string;
+                        extendedPrice: number;
+                    }[] | undefined;
+                    payments?: {
+                        method: string;
+                        paymentDate: string;
+                        amount: number;
+                        reference: string;
+                    }[] | undefined;
+                }[];
+                status: number;
+                options?: Record<string, unknown>[] | undefined;
+                message?: string | undefined;
+                totalResults?: number | undefined;
+                count?: number | undefined;
+            }>;
+            /**
+             * Get specific customer invoice details
+             * @description Returns complete invoice information including line items and payments
+             * @param customerId Customer ID
+             * @param invoiceNo Invoice number
+             * @returns Complete invoice details
+             * @throws ValidationError When response is malformed
+             * @example
+             * ```typescript
+             * const invoice = await client.customer.invoices.get(12345, 789123);
+             * ```
+             */
+            get: (customerId: number, invoiceNo: number) => Promise<{
+                data: {
+                    status: string;
+                    customerId: number;
+                    totalAmount: number;
+                    invoiceNo: number;
+                    invoiceDate: string;
+                    dueDate: string;
+                    balanceAmount: number;
+                    shipToId?: number | undefined;
+                    orderNo?: number | undefined;
+                    invoiceLines?: {
+                        lineNo: number;
+                        quantity: number;
+                        unitPrice: number;
+                        itemId: string;
+                        description: string;
+                        extendedPrice: number;
+                    }[] | undefined;
+                    payments?: {
+                        method: string;
+                        paymentDate: string;
+                        amount: number;
+                        reference: string;
+                    }[] | undefined;
+                };
+                status: number;
+                options?: Record<string, unknown>[] | undefined;
+                message?: string | undefined;
+                totalResults?: number | undefined;
+                count?: number | undefined;
+            }>;
+        };
+        /**
+         * Customer quote management
+         * @description Methods for viewing customer quotes
+         */
+        quotes: {
+            /**
+             * List customer quotes
+             * @description Returns customer quotes with pagination and ordering
+             * @param customerId Customer ID
+             * @param params Optional pagination and ordering parameters
+             * @returns Array of customer quotes
+             * @throws ValidationError When parameters are invalid or response is malformed
+             * @example
+             * ```typescript
+             * const quotes = await client.customer.quotes.list(12345);
+             * ```
+             */
+            list: (customerId: number, params?: QuoteListParams) => Promise<{
+                data: {
+                    status: string;
+                    customerId: number;
+                    expirationDate: string;
+                    salesRepId: string;
+                    totalAmount: number;
+                    quoteNo: number;
+                    quoteDate: string;
+                    notes?: string | undefined;
+                    quoteLines?: {
+                        lineNo: number;
+                        quantity: number;
+                        unitPrice: number;
+                        itemId: string;
+                        description: string;
+                        extendedPrice: number;
+                        margin?: number | undefined;
+                    }[] | undefined;
+                    terms?: string | undefined;
+                    validUntil?: string | undefined;
+                }[];
+                status: number;
+                options?: Record<string, unknown>[] | undefined;
+                message?: string | undefined;
+                totalResults?: number | undefined;
+                count?: number | undefined;
+            }>;
+            /**
+             * Get specific customer quote details
+             * @description Returns complete quote information including line items and terms
+             * @param customerId Customer ID
+             * @param quoteNo Quote number
+             * @returns Complete quote details
+             * @throws ValidationError When response is malformed
+             * @example
+             * ```typescript
+             * const quote = await client.customer.quotes.get(12345, 456789);
+             * ```
+             */
+            get: (customerId: number, quoteNo: number) => Promise<{
+                data: {
+                    status: string;
+                    customerId: number;
+                    expirationDate: string;
+                    salesRepId: string;
+                    totalAmount: number;
+                    quoteNo: number;
+                    quoteDate: string;
+                    notes?: string | undefined;
+                    quoteLines?: {
+                        lineNo: number;
+                        quantity: number;
+                        unitPrice: number;
+                        itemId: string;
+                        description: string;
+                        extendedPrice: number;
+                        margin?: number | undefined;
+                    }[] | undefined;
+                    terms?: string | undefined;
+                    validUntil?: string | undefined;
+                };
+                status: number;
+                options?: Record<string, unknown>[] | undefined;
+                message?: string | undefined;
+                totalResults?: number | undefined;
+                count?: number | undefined;
+            }>;
+        };
+        /**
+         * Customer purchase history
+         * @description Methods for viewing customer purchase history
+         */
+        purchaseHistory: {
+            /**
+             * List customer purchase history
+             * @description Returns items purchased by customer with frequency and pricing information
+             * @param customerId Customer ID
+             * @param params Optional pagination and ordering parameters
+             * @returns Array of purchased items with history
+             * @throws ValidationError When parameters are invalid or response is malformed
+             * @example
+             * ```typescript
+             * const history = await client.customer.purchaseHistory.list(12345, {
+             *   orderBy: 'date_last_purchased|DESC'
+             * });
+             * ```
+             */
+            list: (customerId: number, params?: PurchasedItemListParams) => Promise<{
+                data: {
+                    itemId: string;
+                    itemDescription: string;
+                    lastPurchaseDate: string;
+                    lastPurchasePrice: number;
+                    totalQuantityPurchased: number;
+                    totalAmountPurchased: number;
+                    firstPurchaseDate: string;
+                    lastOrderNo: number;
+                    averagePrice: number;
+                    purchaseFrequency: string;
+                }[];
+                status: number;
+                options?: Record<string, unknown>[] | undefined;
+                message?: string | undefined;
+                totalResults?: number | undefined;
+                count?: number | undefined;
+            }>;
+        };
+    };
+    /**
+     * Contact management endpoints
+     * @description Methods for individual contact operations
+     */
+    contacts: {
+        /**
+         * Get complete contact document by ID
+         * @description Returns full contact details including login credentials and permissions
+         * @param contactId Contact ID
+         * @returns Complete contact document
+         * @throws ValidationError When response is malformed
+         * @example
+         * ```typescript
+         * const contact = await client.contacts.get(12345);
+         * console.log(contact.data.firstName, contact.data.permissions);
+         * ```
+         */
+        get: (id: string | number, params?: import("../../core/base-client").CacheParams | undefined) => Promise<{
+            data: {
+                email: string;
+                customerId: number;
+                contactId: number;
+                firstName: string;
+                lastName: string;
+                title?: string | undefined;
+                role?: string | undefined;
+                dateCreated?: string | undefined;
+                dateLastModified?: string | undefined;
+                phoneNumber?: string | undefined;
+                isPrimary?: boolean | undefined;
+                webEnabled?: boolean | undefined;
+                loginCredentials?: {
+                    username?: string | undefined;
+                    lastLogin?: string | undefined;
+                } | undefined;
+                permissions?: {
+                    canViewPricing?: boolean | undefined;
+                    canPlaceOrders?: boolean | undefined;
+                    canViewInvoices?: boolean | undefined;
+                } | undefined;
+            };
+            status: number;
+            options?: Record<string, unknown>[] | undefined;
+            message?: string | undefined;
+            totalResults?: number | undefined;
+            count?: number | undefined;
+        }>;
+        /**
+         * Get web allowance information for a contact (USCCO specific)
+         * @description Returns web allowance details including current usage and remaining balance
+         * @param contactId Contact ID
+         * @returns Web allowance information
+         * @throws ValidationError When response is malformed
+         * @example
+         * ```typescript
+         * const allowance = await client.contacts.getWebAllowance(12345);
+         * console.log(allowance.data.remainingAllowance);
+         * ```
+         */
+        getWebAllowance: (contactId: number) => Promise<{
+            data: {
+                id: string;
+                customerId: number;
+                webAllowance: number;
+                orderStartDate: string;
+                currentUsage: number;
+                remainingAllowance: number;
+                lastUpdated: string;
+            };
+            status: number;
+            options?: Record<string, unknown>[] | undefined;
+            message?: string | undefined;
+            totalResults?: number | undefined;
+            count?: number | undefined;
+        }>;
+        /**
+         * List customers associated with a sales representative contact
+         * @description Returns customers managed by the specified sales rep contact
+         * @param contactId Contact ID (sales rep)
+         * @param params Optional filtering and pagination parameters
+         * @returns Array of customers managed by the sales rep
+         * @throws ValidationError When parameters are invalid or response is malformed
+         * @example
+         * ```typescript
+         * const customers = await client.contacts.getCustomers(12345, {
+         *   class5Id: 'GOLD',
+         *   q: 'Acme'
+         * });
+         * ```
+         */
+        getCustomers: (contactId: number, params?: ContactCustomersParams) => Promise<{
+            data: {
+                customerId: number;
+                customerName: string;
+                class5Id?: string | undefined;
+                salesRepId?: string | undefined;
+                territoryId?: string | undefined;
+                lastOrderDate?: string | undefined;
+            }[];
+            status: number;
+            options?: Record<string, unknown>[] | undefined;
+            message?: string | undefined;
+            totalResults?: number | undefined;
+            count?: number | undefined;
+        }>;
+        /**
+         * List user-defined fields for a contact
+         * @description Returns custom fields configured for the contact
+         * @param contactId Contact ID
+         * @returns Contact user-defined fields
+         * @throws ValidationError When response is malformed
+         * @example
+         * ```typescript
+         * const customFields = await client.contacts.getUserDefinedFields(12345);
+         * ```
+         */
+        getUserDefinedFields: (contactId: number) => Promise<{
+            data: {
+                contactId: number;
+                lastUpdated: string;
+                customFields: {
+                    fieldName: string;
+                    fieldValue: string;
+                    fieldType: string;
+                }[];
+            };
+            status: number;
+            options?: Record<string, unknown>[] | undefined;
+            message?: string | undefined;
+            totalResults?: number | undefined;
+            count?: number | undefined;
+        }>;
+        /**
+         * Trigger contact data refresh from Prophet 21
+         * @description Initiates synchronization of contact data from the ERP system
+         * @returns Refresh operation status
+         * @throws ValidationError When response is malformed
+         * @example
+         * ```typescript
+         * const refresh = await client.contacts.refresh();
+         * console.log(refresh.data.jobId);
+         * ```
+         */
+        refresh: () => Promise<{
+            data: {
+                message: string;
+                timestamp: string;
+                jobId: string;
+            };
+            status: number;
+            options?: Record<string, unknown>[] | undefined;
+            message?: string | undefined;
+            totalResults?: number | undefined;
+            count?: number | undefined;
+        }>;
+    };
+    /**
+     * Ship-to address refresh endpoints
+     * @description Methods for triggering data refresh operations
+     */
+    shipToRefresh: {
+        /**
+         * Trigger ship-to address data refresh from Prophet 21
+         * @description Initiates synchronization of ship-to address data from the ERP system
+         * @returns Refresh operation status
+         * @throws ValidationError When response is malformed
+         * @example
+         * ```typescript
+         * const refresh = await client.shipToRefresh.refresh();
+         * console.log(refresh.data.jobId);
+         * ```
+         */
+        refresh: () => Promise<{
+            data: {
+                message: string;
+                timestamp: string;
+                jobId: string;
+            };
+            status: number;
+            options?: Record<string, unknown>[] | undefined;
+            message?: string | undefined;
+            totalResults?: number | undefined;
+            count?: number | undefined;
+        }>;
+    };
+    /**
+     * Order entry contacts customer refresh endpoints
+     * @description Methods for triggering OE contacts customer data refresh
+     */
+    oeContactsCustomerRefresh: {
+        /**
+         * Trigger order entry contacts customer data refresh
+         * @description Initiates synchronization of OE contacts customer data
+         * @returns Refresh operation status
+         * @throws ValidationError When response is malformed
+         * @example
+         * ```typescript
+         * const refresh = await client.oeContactsCustomerRefresh.refresh();
+         * console.log(refresh.data.jobId);
+         * ```
+         */
+        refresh: () => Promise<{
+            data: {
+                message: string;
+                timestamp: string;
+                jobId: string;
+            };
+            status: number;
+            options?: Record<string, unknown>[] | undefined;
+            message?: string | undefined;
+            totalResults?: number | undefined;
+            count?: number | undefined;
+        }>;
+    };
+    /**
+     * Health check endpoint
+     * @description Monitor service health and connectivity
+     * @returns Service health status including site information
+     * @throws ValidationError When response is malformed
+     * @example
+     * ```typescript
+     * const health = await client.getHealthCheck();
+     * console.log(health.data.siteId, health.data.siteHash);
+     * ```
+     */
+    getHealthCheck: () => Promise<{
+        data: {
+            siteHash: string;
+            siteId: string;
+        };
+        status: number;
+        options?: Record<string, unknown>[] | undefined;
+        message?: string | undefined;
+        totalResults?: number | undefined;
+        count?: number | undefined;
+    }>;
+}
+//# sourceMappingURL=client.d.ts.map