@simpleapps-com/augur-api
Version:
TypeScript client library for Augur microservices API endpoints
42 lines • 1.69 kB
TypeScript
import type { CustomersClient } from '../client';
import type { CustomerListParams } from '../schemas';
type ExecuteRequest = CustomersClient['executeRequest'];
/**
* Creates the customerList resource methods
* OpenAPI Path: /customer → customerList.*
* @description Customer listing operations
*/
export declare function createCustomerListResource(executeRequest: ExecuteRequest): {
/**
* List customers with pagination and filtering
* @fullPath api.customers.customerList.list
* @service customers
* @domain customer-management
* @dataMethod customerListData.list
* @discoverable true
*/
list: (params?: CustomerListParams) => Promise<{
params: Record<string, unknown> | unknown[];
data: import("zod").objectInputType<{
customerId: import("zod").ZodNumber;
}, import("zod").ZodTypeAny, "passthrough">[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
}>;
};
/**
* Creates the customerListData resource methods (data-only versions)
*/
export declare function createCustomerListDataResource(customerList: ReturnType<typeof createCustomerListResource>): {
list: (params?: CustomerListParams) => Promise<import("zod").objectInputType<{
customerId: import("zod").ZodNumber;
}, import("zod").ZodTypeAny, "passthrough">[]>;
};
export type CustomerListResource = ReturnType<typeof createCustomerListResource>;
export type CustomerListDataResource = ReturnType<typeof createCustomerListDataResource>;
export {};
//# sourceMappingURL=customer-list.d.ts.map