@simpleapps-com/augur-api/dist/types/services/customers/client.d.ts

TypeScript client library for Augur microservices API endpoints

import { BaseServiceClient } from '../../core/base-client';
import type { HTTPClient } from '../../core/client';
import { type HealthCheckResource, type HealthCheckDataResource, type CustomerListResource, type CustomerListDataResource, type CustomerLookupResource, type CustomerLookupDataResource, type CustomerResource, type CustomerDataResource, type ContactsResource, type ContactsDataResource, type ContactsUdResource, type ContactsUdDataResource, type ShipToResource, type ShipToDataResource, type OeContactsCustomerResource, type OeContactsCustomerDataResource } from './resources';
/**
 * Customers API Client - OpenAPI Path Mirroring Pattern Implementation
 * @description Client for interacting with Customers microservice API endpoints
 * @fullPath api.customers
 * @service customers
 * @domain customer-management
 * @discoverable true
 * @searchTerms ["customers", "contacts", "orders", "invoices", "quotes", "addresses", "ship-to"]
 * @commonPatterns ["customer lookup", "contact management", "order history", "invoice tracking"]
 *
 * @example OpenAPI Path Mirroring Pattern
 * ```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 client = new CustomersClient(http);
 *
 * // OpenAPI Path: /customer → client.customerList.list()
 * const customerList = await client.customerList.list({ limit: 10 });
 *
 * // OpenAPI Path: /customer/{customerId}/doc → client.customer(123).doc.get()
 * const customer = await client.customer(123).doc.get();
 *
 * // OpenAPI Path: /contacts/{id}/customers → client.contacts(456).customers.list()
 * const salesRepCustomers = await client.contacts(456).customers.list();
 *
 * // OpenAPI Path: /customer/{customerId}/orders/{orderNo} → client.customer(123).orders(789).get()
 * const order = await client.customer(123).orders(789).get();
 * ```
 */
export declare class CustomersClient extends BaseServiceClient {
    /** Health check resource */
    readonly healthCheck: HealthCheckResource;
    /** Health check data resource (data-only) */
    readonly healthCheckData: HealthCheckDataResource;
    /** Customer list resource */
    readonly customerList: CustomerListResource;
    /** Customer list data resource (data-only) */
    readonly customerListData: CustomerListDataResource;
    /** Customer lookup resource */
    readonly customerLookup: CustomerLookupResource;
    /** Customer lookup data resource (data-only) */
    readonly customerLookupData: CustomerLookupDataResource;
    /** Customer resource factory */
    readonly customer: CustomerResource;
    /** Customer data resource factory (data-only) */
    readonly customerData: CustomerDataResource;
    /** Contacts resource factory */
    readonly contacts: ContactsResource;
    /** Contacts data resource factory (data-only) */
    readonly contactsData: ContactsDataResource;
    /** Contacts UD resource factory */
    readonly contactsUd: ContactsUdResource;
    /** Contacts UD data resource factory (data-only) */
    readonly contactsUdData: ContactsUdDataResource;
    /** Ship-to resource */
    readonly shipTo: ShipToResource;
    /** Ship-to data resource (data-only) */
    readonly shipToData: ShipToDataResource;
    /** OE Contacts Customer resource */
    readonly oeContactsCustomer: OeContactsCustomerResource;
    /** OE Contacts Customer data resource (data-only) */
    readonly oeContactsCustomerData: OeContactsCustomerDataResource;
    /**
     * 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);
}
//# sourceMappingURL=client.d.ts.map