@getpaidhq/sdk
Version:
TypeScript SDK for GetPaidHQ API - Comprehensive subscription billing platform
90 lines (87 loc) • 2.99 kB
text/typescript
import { H as HttpClient, C as CustomersResource, P as ProductsResource, V as VariantsResource, a as PricesResource, S as SubscriptionsResource, U as UsageResource, O as OrganizationsResource, M as MetersResource, b as OrdersResource, c as PaymentsResource, I as InvoicesResource, D as DunningResource, W as WebhooksResource, R as ReportsResource, d as SettingsResource, G as GatewaysResource, e as SessionsResource, f as DiscountsResource, g as PaymentLinksResource, h as CartsResource, i as PublicPaymentsResource } from './index-T2IwVEkS.cjs';
import 'axios';
import './common-DxOEZ2Dn.cjs';
import './types/index.cjs';
interface GetPaidHQClientConfig {
/**
* API key for authentication (starts with 'sk_')
*/
apiKey?: string;
/**
* Async function that returns bearer token for OAuth authentication
*/
getToken?: () => Promise<string | null>;
/**
* Bearer token for OAuth authentication
*/
bearerToken?: string;
/**
* Token for public payment endpoints (used as query parameter)
*/
token?: string;
/**
* Base URL for the API
* @default https://api.getpaidhq.co
*/
baseURL?: string;
/**
* Request timeout in milliseconds
* @default 30000 (30 seconds)
*/
timeout?: number;
/**
* Number of retry attempts for failed requests
* @default 3
*/
retries?: number;
/**
* Delay between retries in milliseconds
* @default 1000 (1 second)
*/
retryDelay?: number;
/**
* Custom user agent string
*/
userAgent?: string;
}
declare class GetPaidHQClient {
private authManager;
readonly httpClient: HttpClient;
readonly customers: CustomersResource;
readonly products: ProductsResource;
readonly variants: VariantsResource;
readonly prices: PricesResource;
readonly subscriptions: SubscriptionsResource;
readonly usage: UsageResource;
readonly organizations: OrganizationsResource;
readonly meters: MetersResource;
readonly orders: OrdersResource;
readonly payments: PaymentsResource;
readonly invoices: InvoicesResource;
readonly dunning: DunningResource;
readonly webhooks: WebhooksResource;
readonly reports: ReportsResource;
readonly settings: SettingsResource;
readonly gateways: GatewaysResource;
readonly sessions: SessionsResource;
readonly discounts: DiscountsResource;
readonly paymentLinks: PaymentLinksResource;
readonly carts: CartsResource;
readonly publicPayments: PublicPaymentsResource;
constructor(config: GetPaidHQClientConfig);
/**
* Update API key for authentication
*/
updateApiKey(apiKey: string): void;
/**
* Update bearer token for authentication
*/
updateBearerToken(_bearerToken: string): void;
/**
* Check API health
*/
healthCheck(): Promise<{
status: string;
}>;
}
export { GetPaidHQClient, type GetPaidHQClientConfig, HttpClient };