quickbooks-api/src/packages/api/customer/services/raw-customer-query.ts

A modular TypeScript SDK for seamless integration with Intuit QuickBooks APIs. Provides robust authentication handling and future-ready foundation for accounting, payments, and commerce operations.

// Import the Query Builder
import { CustomerAPI } from '../customer-api';
import type { CustomerQueryBuilder } from '../customer-query-builder';
import { Customer, type SearchResponse } from '../../../../types/types';
import { plainToClass } from 'class-transformer';

/**
 * Executes a custom customer query using the specified query builder.
 *
 * This function builds a query URL from the provided query builder, sends a GET request via the API client,
 * formats the response into customer data, and returns a SearchResponse object. The response includes both
 * the list of customers and a flag indicating whether additional pages of results are available.
 *
 * @param queryBuilder - The query builder used to generate the request URL.
 * @returns A promise that resolves to a SearchResponse containing customer data and pagination information.
 */
export async function rawCustomerQuery(this: CustomerAPI, queryBuilder: CustomerQueryBuilder): Promise<SearchResponse<Customer>> {
	// Build the URL
	const url = queryBuilder.build();

	// Execute the custom query
	const { responseData, intuitTID } = await this.apiClient.runRequest(url, { method: 'GET' });

	// Format the Response
	const customers = await this.formatResponse(responseData);

	// Map the Customers to Classes
	const mappedCustomers = customers.map((customer) => plainToClass(Customer, customer));

	// Setup the Search Response
	const searchResponse: SearchResponse<Customer> = {
		results: mappedCustomers,
		hasNextPage: await this.hasNextPage(queryBuilder),
		intuitTID,
	};

	// Return the Customers
	return searchResponse;
}