quickbooks-api
Version:
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.
83 lines (80 loc) • 2.33 kB
TypeScript
import { AuthProvider } from '../auth/auth-provider.js';
import { Environment, IntuitErrorData } from '../../types/types.js';
import { InvoiceAPI } from './invoices/invoice-api.js';
import { EstimateAPI } from './estimates/estimate-api.js';
import { CustomerAPI } from './customer/customer-api.js';
import { PaymentAPI } from './payment/payment-api.js';
import { AccountAPI } from './account/account-api.js';
import { PreferenceAPI } from './preferences/preference-api.js';
import { CreditMemoAPI } from './credit-memo/credit-memo-api.js';
import { CompanyInfoAPI } from './company-info/company-info-api.js';
import { BillAPI } from './bill/bill-api.js';
/**
* API Client
*/
export declare class ApiClient {
readonly authProvider: AuthProvider;
readonly environment: Environment;
/**
* Customer API
*/
customers: CustomerAPI;
/**
* Invoices API
*/
invoices: InvoiceAPI;
/**
* Credit Memo API
*/
creditMemos: CreditMemoAPI;
/**
* Estimates API
*/
estimates: EstimateAPI;
/**
* Payments API
*/
payments: PaymentAPI;
/**
* Accounts API
*/
accounts: AccountAPI;
/**
* Preferences API
*/
preferences: PreferenceAPI;
/**
* Company Info API
*/
companyInfo: CompanyInfoAPI;
/**
* Bills API
*/
bills: BillAPI;
/**
* Automatically check for a next page (This creates an extra query to the API to check if there is a next page)
*/
autoCheckNextPage: boolean;
/**
* Constructor
* @param authProvider - The Auth Provider
*/
constructor(authProvider: AuthProvider, environment: Environment);
/**
* Runs a Request
* @param url - The URL to run the request on
* @param headers - The headers to run the request on
* @returns {AuthProvider} The Auth Provider
*/
runRequest(url: string, requestInit: RequestInit): Promise<{
response: Response;
responseData: any;
intuitTID: string;
}>;
/**
* Gets the Intuit error details from the response
* @param response The response to get the Intuit error details from
* @returns {IntuitErrorData} The Intuit error details
*/
static getIntuitErrorDetails(response: Response | null): Promise<IntuitErrorData>;
}