UNPKG

@simpleapps-com/augur-api

Version:

TypeScript client library for Augur microservices API endpoints

66 lines 3.04 kB
import { BaseServiceClient } from '../../core/base-client'; import type { HTTPClient } from '../../core/client'; import { type HealthCheckResource, type HealthCheckDataResource, type PriceEngineResource, type PriceEngineDataResource, type TaxEngineResource, type TaxEngineDataResource, type JobPriceHdrResource, type JobPriceHdrDataResource, type PingResource, type PingDataResource } from './resources'; /** * Pricing API Client * @description Client for interacting with Pricing microservice API endpoints for pricing calculations, tax computation, and job-based pricing management * @service pricing * @domain pricing-management * @discoverable true * @searchTerms ["pricing", "tax", "job pricing", "price engine", "tax engine", "price calculation", "tax calculation"] * @example * ```typescript * import { HTTPClient } from '@augur/api-client/core'; * import { PricingClient } from '@augur/api-client/services/pricing'; * * const http = new HTTPClient('pricing', { siteId: 'your-site-id', bearerToken: 'your-token' }); * const pricing = new PricingClient(http); * * // Get item price * const price = await pricing.priceEngine.get({ customerId: 12345, itemId: 'ABC123', quantity: 10 }); * * // Calculate tax * const tax = await pricing.taxEngine.create({ * customer_id: 12345, * postal_code: '12345', * items: [{ item_id: 'ABC123', quantity: 2, unit_price: 25.99, extended_amount: 51.98 }], * ship_to_address: { street: '123 Main St', city: 'Anytown', state: 'NY', postal_code: '12345' } * }); * * // List job price headers * const jobHeaders = await pricing.jobPriceHdr.list({ limit: 25, q: 'contract' }); * * // Get specific job price line * const jobLine = await pricing.jobPriceHdr.lines.get(12345, 67890); * ``` */ export declare class PricingClient extends BaseServiceClient { /** Health check resource */ readonly healthCheck: HealthCheckResource; /** Health check data resource (data-only) */ readonly healthCheckData: HealthCheckDataResource; /** Price engine resource */ readonly priceEngine: PriceEngineResource; /** Price engine data resource (data-only) */ readonly priceEngineData: PriceEngineDataResource; /** Tax engine resource */ readonly taxEngine: TaxEngineResource; /** Tax engine data resource (data-only) */ readonly taxEngineData: TaxEngineDataResource; /** Job price header resource */ readonly jobPriceHdr: JobPriceHdrResource; /** Job price header data resource (data-only) */ readonly jobPriceHdrData: JobPriceHdrDataResource; /** Ping resource */ readonly ping: PingResource; /** Ping data resource (data-only) */ readonly pingData: PingDataResource; /** * Create a new PricingClient instance * @param http Configured HTTPClient instance * @param baseUrl Base URL for the Pricing API (default: https://pricing.augur-api.com) */ constructor(http: HTTPClient, baseUrl?: string); protected getServiceDescription(): string; } //# sourceMappingURL=client.d.ts.map