@simpleapps-com/augur-api
Version:
TypeScript client library for Augur microservices API endpoints
51 lines • 2.23 kB
TypeScript
import { BaseServiceClient } from '../../core/base-client';
import type { HTTPClient } from '../../core/client';
import { type HealthCheckResource, type HealthCheckDataResource, type PingResource, type PingDataResource, type UnifiedResource, type UnifiedDataResource, type ElementResource, type ElementDataResource, type MonerisResource, type MonerisDataResource } from './resources';
/**
* Client for the Payments API service
*
* Provides access to payment processing operations through Element Express integration,
* including transaction setup, account management, and billing operations.
*
* @example
* ```typescript
* const api = new AugurAPI({ bearerToken: 'token', siteId: 'site' });
*
* // Create transaction setup
* const setup = await api.payments.unified.transactionSetup.get({ customerId: '123' });
*
* // Query account information
* const account = await api.payments.unified.accountQuery.get({
* customerId: '123',
* transactionSetupId: setup.data.transactionSetupId
* });
*
* // Data-only version
* const setupData = await api.payments.unifiedData.transactionSetup.get({ customerId: '123' });
* ```
*/
export declare class PaymentsClient extends BaseServiceClient {
/** Health check resource */
readonly healthCheck: HealthCheckResource;
/** Health check data resource (data-only) */
readonly healthCheckData: HealthCheckDataResource;
/** Ping resource */
readonly ping: PingResource;
/** Ping data resource (data-only) */
readonly pingData: PingDataResource;
/** Unified payment operations resource */
readonly unified: UnifiedResource;
/** Unified payment operations data resource (data-only) */
readonly unifiedData: UnifiedDataResource;
/** Element payment resource */
readonly element: ElementResource;
/** Element payment data resource (data-only) */
readonly elementData: ElementDataResource;
/** Moneris payment gateway resource */
readonly moneris: MonerisResource;
/** Moneris payment gateway data resource (data-only) */
readonly monerisData: MonerisDataResource;
constructor(http: HTTPClient, baseUrl?: string);
protected getServiceDescription(): string;
}
//# sourceMappingURL=client.d.ts.map