@simpleapps-com/augur-api
Version:
TypeScript client library for Augur microservices API endpoints
50 lines • 2.04 kB
TypeScript
import { BaseServiceClient } from '../../core/base-client';
import type { HTTPClient } from '../../core/client';
import { type HealthCheckResource, type HealthCheckDataResource, type PingResource, type PingDataResource, type UsResource, type UsDataResource } from './resources';
/**
* SmartyStreets Address Validation Service Client
*
* Provides comprehensive US address validation, standardization, and geocoding services
* powered by SmartyStreets API. Validates addresses for deliverability, standardizes formatting,
* and provides detailed address intelligence for e-commerce, logistics, and data quality.
*
* @service smarty-streets
* @domain address-validation-and-geocoding
*
* @example
* ```typescript
* import { HTTPClient } from '@augur/api-client/core';
* import { SmartyStreetsClient } from '@augur/api-client/services/smarty-streets';
*
* const http = new HTTPClient('smarty-streets', { siteId: 'your-site-id', bearerToken: 'your-token' });
* const smartyStreets = new SmartyStreetsClient(http);
*
* // Validate a US address
* const result = await smartyStreets.us.lookup.get({
* address1: '1234 Example Street',
* city: 'Provo',
* state: 'UT',
* postalCode: '84606',
* 'x-site-id': 'SITE123'
* });
*
* // Check service health
* const health = await smartyStreets.healthCheck.get({ 'x-site-id': 'SITE123' });
* ```
*/
export declare class SmartyStreetsClient extends BaseServiceClient {
readonly healthCheck: HealthCheckResource;
readonly ping: PingResource;
readonly us: UsResource;
readonly healthCheckData: HealthCheckDataResource;
readonly pingData: PingDataResource;
readonly usData: UsDataResource;
/**
* Create a new SmartyStreetsClient instance
* @param http Configured HTTPClient instance
* @param baseUrl Base URL for the SmartyStreets API (default: https://smarty-streets.augur-api.com)
*/
constructor(http: HTTPClient, baseUrl?: string);
protected getServiceDescription(): string;
}
//# sourceMappingURL=client.d.ts.map