@simpleapps-com/augur-api 0.5.1 → 0.6.0

package/dist/cjs/services/smarty-streets/client.d.ts

@@ -1,6 +1,6 @@
 import { BaseServiceClient } from '../../core/base-client';
 import type { HTTPClient } from '../../core/client';
-import { HealthCheckParams, HealthCheckResponse, HealthCheckData, PingParams, PingResponse, PingData, UsLookupParams, UsLookupResponse, UsLookupData } from './schemas';
+import { type HealthCheckResource, type HealthCheckDataResource, type PingResource, type PingDataResource, type UsResource, type UsDataResource } from './resources';
 /**
  * SmartyStreets Address Validation Service Client
  *
@@ -10,252 +10,41 @@ import { HealthCheckParams, HealthCheckResponse, HealthCheckData, PingParams, Pi
  *
  * @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 {
-    constructor(http: HTTPClient, baseUrl?: string);
-    protected getServiceDescription(): string;
+    readonly healthCheck: HealthCheckResource;
+    readonly ping: PingResource;
+    readonly us: UsResource;
+    readonly healthCheckData: HealthCheckDataResource;
+    readonly pingData: PingDataResource;
+    readonly usData: UsDataResource;
     /**
-     * Health check operations for /health-check endpoint
-     * Following OpenAPI Path Mirroring Pattern
+     * 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)
      */
-    readonly healthCheck: {
-        /**
-         * Check SmartyStreets service health and API connectivity
-         *
-         * @fullPath api.smartyStreets.healthCheck.get
-         * @service smarty-streets
-         * @domain system-health
-         * @dataMethod healthCheck.getData
-         * @discoverable true
-         * @searchTerms ["health", "status", "availability", "ping", "check", "address service", "smartystreets connectivity", "validation service"]
-         * @relatedEndpoints ["api.smartyStreets.ping.get", "api.smartyStreets.us.lookup.get", "api.customers.addresses.validate", "api.logistics.healthCheck.get", "api.shipping.healthCheck.get"]
-         * @commonPatterns ["Health check", "Service status", "Address service availability", "System monitoring", "API connectivity test"]
-         * @workflow ["system-monitoring", "health-checks", "service-discovery", "address-validation-setup", "api-status-verification"]
-         * @prerequisites ["Service is running", "Valid authentication token", "x-site-id header", "SmartyStreets API connectivity"]
-         * @nextSteps ["Use address validation endpoints if healthy", "Verify SmartyStreets API credits", "Monitor service metrics"]
-         * @businessRules ["Returns service and API status", "Requires standard authentication", "Standard health check format", "Reports API credit status"]
-         * @functionalArea "system-monitoring"
-         * @caching "No caching - real-time status required"
-         * @performance "Fast response, minimal processing, use for address service monitoring"
-         *
-         * @param params Health check parameters with site ID
-         * @returns Promise<HealthCheckResponse> Service health status with SmartyStreets API connectivity
-         *
-         * @example
-         * ```typescript
-         * // Check if SmartyStreets service is healthy
-         * const response = await client.healthCheck.get({ 'x-site-id': 'SITE123' });
-         * console.log(response.data.status); // 'healthy'
-         * console.log(response.data.service); // 'smarty-streets'
-         * console.log(response.data.smartystreets_connectivity); // true
-         * console.log(response.status); // HTTP status code
-         *
-         * // Get just the health status
-         * const status = await client.healthCheck.getData({ 'x-site-id': 'SITE123' });
-         * console.log(status); // Health data object
-         * ```
-         */
-        get: (params: HealthCheckParams) => Promise<HealthCheckResponse>;
-        /**
-         * Get SmartyStreets service health data without full response metadata
-         *
-         * @fullPath api.smartyStreets.healthCheck.getData
-         * @service smarty-streets
-         * @domain system-health
-         * @dataMethod healthCheck.getData
-         * @discoverable true
-         * @searchTerms ["health data", "service status", "smartystreets availability", "api connectivity"]
-         * @relatedEndpoints ["api.smartyStreets.healthCheck.get", "api.smartyStreets.us.lookup.get"]
-         * @commonPatterns ["Get health status", "Check API connectivity", "Service monitoring"]
-         * @workflow ["system-monitoring", "health-checks", "service-verification"]
-         * @prerequisites ["Valid authentication token", "x-site-id header"]
-         * @nextSteps ["Use address validation endpoints if healthy", "Monitor service metrics"]
-         * @businessRules ["Returns only health data object", "No response metadata included"]
-         * @functionalArea "system-monitoring"
-         * @caching "No caching - real-time status required"
-         * @performance "Direct data access, faster for simple health checks"
-         *
-         * @param params Health check parameters with site ID
-         * @returns Promise<HealthCheckData> Direct health status data object
-         */
-        getData: (params: HealthCheckParams) => Promise<HealthCheckData>;
-    };
-    /**
-     * Ping operations for /ping endpoint
-     * Following OpenAPI Path Mirroring Pattern
-     */
-    readonly ping: {
-        /**
-         * Ping SmartyStreets service for connectivity verification
-         *
-         * @fullPath api.smartyStreets.ping.get
-         * @service smarty-streets
-         * @domain system-health
-         * @dataMethod ping.getData
-         * @discoverable true
-         * @searchTerms ["ping", "connectivity", "response time", "pong", "test", "smartystreets ping", "service alive", "latency check"]
-         * @relatedEndpoints ["api.smartyStreets.healthCheck.get", "api.smartyStreets.us.lookup.get", "api.customers.addresses.ping", "api.logistics.ping.get"]
-         * @commonPatterns ["Ping test", "Connectivity check", "Response time test", "Service alive check", "Latency monitoring"]
-         * @workflow ["system-monitoring", "connectivity-tests", "performance-monitoring", "service-diagnostics", "latency-measurement"]
-         * @prerequisites ["Service is running", "Valid authentication token", "x-site-id header", "Network connectivity"]
-         * @nextSteps ["Use for latency monitoring", "Verify consistent response times", "Include in system health dashboards"]
-         * @businessRules ["Returns pong response", "Measures response time", "Requires standard authentication", "Simple connectivity test"]
-         * @functionalArea "system-monitoring"
-         * @caching "No caching - real-time ping test required"
-         * @performance "Ultra-fast response, use for latency monitoring and connectivity verification"
-         *
-         * @param params Ping parameters with site ID
-         * @returns Promise<PingResponse> Ping response with timing information
-         *
-         * @example
-         * ```typescript
-         * // Test service connectivity
-         * const response = await client.ping.get({ 'x-site-id': 'SITE123' });
-         * console.log(response.data.message); // 'pong'
-         * console.log(response.data.response_time_ms); // Response time
-         * console.log(response.status); // HTTP status code
-         *
-         * // Get just the ping data
-         * const pingData = await client.ping.getData({ 'x-site-id': 'SITE123' });
-         * console.log(pingData); // Ping data object
-         * ```
-         */
-        get: (params: PingParams) => Promise<PingResponse>;
-        /**
-         * Get SmartyStreets ping data without full response metadata
-         *
-         * @fullPath api.smartyStreets.ping.getData
-         * @service smarty-streets
-         * @domain system-health
-         * @dataMethod ping.getData
-         * @discoverable true
-         * @searchTerms ["ping data", "connectivity test", "response time", "service latency"]
-         * @relatedEndpoints ["api.smartyStreets.ping.get", "api.smartyStreets.healthCheck.get"]
-         * @commonPatterns ["Get ping response", "Check connectivity", "Measure latency"]
-         * @workflow ["system-monitoring", "connectivity-tests", "performance-monitoring"]
-         * @prerequisites ["Valid authentication token", "x-site-id header"]
-         * @nextSteps ["Use for latency monitoring", "Include in performance dashboards"]
-         * @businessRules ["Returns only ping data object", "No response metadata included"]
-         * @functionalArea "system-monitoring"
-         * @caching "No caching - real-time ping test required"
-         * @performance "Direct data access, optimal for latency monitoring"
-         *
-         * @param params Ping parameters with site ID
-         * @returns Promise<PingData> Direct ping response data object
-         */
-        getData: (params: PingParams) => Promise<PingData>;
-    };
-    /**
-     * US operations for /us/* endpoints
-     * Following OpenAPI Path Mirroring Pattern
-     */
-    readonly us: {
-        /**
-         * Lookup operations for /us/lookup endpoint
-         * Following OpenAPI Path Mirroring Pattern
-         */
-        lookup: {
-            /**
-             * Validate and standardize US addresses using SmartyStreets API
-             *
-             * @fullPath api.smartyStreets.us.lookup.get
-             * @service smarty-streets
-             * @domain address-validation-and-geocoding
-             * @dataMethod us.lookup.getData
-             * @discoverable true
-             * @searchTerms ["address validation", "us addresses", "standardize", "verify", "lookup", "postal", "zip code", "street address", "delivery", "dpv", "geocoding"]
-             * @relatedEndpoints ["api.customers.addresses.create", "api.customers.addresses.validate", "api.shipping.rates.calculate", "api.commerce.checkout.validateAddress", "api.logistics.addresses.verify"]
-             * @commonPatterns ["Validate customer address", "Standardize shipping address", "Verify delivery address", "Clean address data", "Geocode address", "Check address deliverability"]
-             * @workflow ["address-validation", "customer-onboarding", "checkout-process", "shipping-calculation", "data-quality", "address-standardization", "geocoding-workflow"]
-             * @prerequisites ["Valid US address components", "Valid authentication token", "x-site-id header", "SmartyStreets API access", "Sufficient API credits"]
-             * @nextSteps ["Use standardized address for shipping", "Store validated address", "Calculate shipping rates", "Update customer record", "Process geocoding data"]
-             * @businessRules ["US addresses only", "Requires complete address components", "Returns standardized USPS format", "Validates deliverability", "Provides geocoding data", "Consumes API credits"]
-             * @functionalArea "address-validation-and-geocoding"
-             * @crossSite "Supports multi-site address validation with different API configurations"
-             * @caching "Cache validated addresses for 30 days, invalidate on address changes"
-             * @performance "Batch requests for multiple addresses, implement retry logic for API limits, monitor credit usage"
-             *
-             * @param params Complete US address components for validation
-             * @returns Promise<UsLookupResponse> Standardized address with validation results and geocoding data
-             *
-             * @example
-             * ```typescript
-             * // Validate and standardize a customer address
-             * const addressRequest = {
-             *   address1: '1234 Example Street',
-             *   address2: 'Apt 5B',
-             *   city: 'Provo',
-             *   state: 'UT',
-             *   postalCode: '84606',
-             *   'x-site-id': 'SITE123'
-             * };
-             *
-             * const response = await client.us.lookup.get(addressRequest);
-             * console.log(response.data.candidates); // Array of standardized addresses
-             * console.log(response.data.valid_candidates); // Number of valid addresses
-             * console.log(response.status); // HTTP status code
-             *
-             * // Get just the validation data
-             * const validationResult = await client.us.lookup.getData(addressRequest);
-             * console.log(validationResult); // Direct validation results
-             *
-             * // Validate shipping address for e-commerce
-             * const shippingAddress = await client.us.lookup.get({
-             *   address1: '123 Main Street',
-             *   city: 'New York',
-             *   state: 'NY',
-             *   postalCode: '10001',
-             *   'x-site-id': 'ECOMMERCE-SITE'
-             * });
-             *
-             * // Check if address is deliverable
-             * const standardized = shippingAddress.data.candidates[0];
-             * if (standardized?.analysis?.dpv_match_y) {
-             *   console.log('Address is deliverable');
-             *   console.log('Standardized:', standardized.delivery_line_1);
-             *   console.log('ZIP+4:', standardized.zipcode + '-' + standardized.plus4_code);
-             * }
-             *
-             * // Extract geocoding data
-             * if (standardized?.metadata) {
-             *   console.log('County:', standardized.metadata.county_name);
-             *   console.log('Time Zone:', standardized.metadata.time_zone);
-             *   console.log('Carrier Route:', standardized.metadata.carrier_route);
-             * }
-             *
-             * // Handle validation errors
-             * if (shippingAddress.data.valid_candidates === 0) {
-             *   console.log('Invalid address - requires correction');
-             * } else if (shippingAddress.data.ambiguous_candidates > 0) {
-             *   console.log('Multiple matches found - user selection required');
-             * }
-             * ```
-             */
-            get: (params: UsLookupParams) => Promise<UsLookupResponse>;
-            /**
-             * Get US address validation data without full response metadata
-             *
-             * @fullPath api.smartyStreets.us.lookup.getData
-             * @service smarty-streets
-             * @domain address-validation-and-geocoding
-             * @dataMethod us.lookup.getData
-             * @discoverable true
-             * @searchTerms ["address data", "validation results", "standardized address", "geocoding data", "dpv results"]
-             * @relatedEndpoints ["api.smartyStreets.us.lookup.get", "api.customers.addresses.create", "api.shipping.rates.calculate"]
-             * @commonPatterns ["Get address validation results", "Extract standardized address", "Process geocoding data"]
-             * @workflow ["address-validation", "customer-onboarding", "checkout-process", "shipping-calculation"]
-             * @prerequisites ["Valid US address components", "Valid authentication token", "SmartyStreets API access"]
-             * @nextSteps ["Use standardized address", "Store validation results", "Calculate shipping rates"]
-             * @businessRules ["Returns only address validation data", "No response metadata included", "Direct access to candidates array"]
-             * @functionalArea "address-validation-and-geocoding"
-             * @caching "Cache validation results for 30 days"
-             * @performance "Direct data access, optimal for address processing and validation workflows"
-             *
-             * @param params Complete US address components for validation
-             * @returns Promise<UsLookupData> Direct address validation results without response wrapper
-             */
-            getData: (params: UsLookupParams) => Promise<UsLookupData>;
-        };
-    };
+    constructor(http: HTTPClient, baseUrl?: string);
+    protected getServiceDescription(): string;
 }
 //# sourceMappingURL=client.d.ts.map

package/dist/cjs/services/smarty-streets/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../../src/services/smarty-streets/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAEL,iBAAiB,EAEjB,mBAAmB,EACnB,eAAe,EAEf,UAAU,EAEV,YAAY,EACZ,QAAQ,EAER,cAAc,EAEd,gBAAgB,EAChB,YAAY,EACb,MAAM,WAAW,CAAC;AAEnB;;;;;;;;;GASG;AACH,qBAAa,mBAAoB,SAAQ,iBAAiB;gBAC5C,IAAI,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,MAAM;IAI9C,SAAS,CAAC,qBAAqB,IAAI,MAAM;IAIzC;;;OAGG;IACH,SAAgB,WAAW;QACzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAmCG;sBACiB,iBAAiB,KAAG,OAAO,CAAC,mBAAmB,CAAC;QAYpE;;;;;;;;;;;;;;;;;;;;;WAqBG;0BACqB,iBAAiB,KAAG,OAAO,CAAC,eAAe,CAAC;MAIpE;IAEF;;;OAGG;IACH,SAAgB,IAAI;QAClB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAkCG;sBACiB,UAAU,KAAG,OAAO,CAAC,YAAY,CAAC;QAYtD;;;;;;;;;;;;;;;;;;;;;WAqBG;0BACqB,UAAU,KAAG,OAAO,CAAC,QAAQ,CAAC;MAItD;IAEF;;;OAGG;IACH,SAAgB,EAAE;QAChB;;;WAGG;;YAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;eA2EG;0BACiB,cAAc,KAAG,OAAO,CAAC,gBAAgB,CAAC;YAY9D;;;;;;;;;;;;;;;;;;;;;eAqBG;8BACqB,cAAc,KAAG,OAAO,CAAC,YAAY,CAAC;;MAKhE;CACH"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../../src/services/smarty-streets/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAkB,MAAM,wBAAwB,CAAC;AAC3E,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAOL,KAAK,mBAAmB,EACxB,KAAK,uBAAuB,EAC5B,KAAK,YAAY,EACjB,KAAK,gBAAgB,EACrB,KAAK,UAAU,EACf,KAAK,cAAc,EACpB,MAAM,aAAa,CAAC;AAErB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,qBAAa,mBAAoB,SAAQ,iBAAiB;IAExD,QAAQ,CAAC,WAAW,EAAE,mBAAmB,CAAC;IAC1C,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;IAC5B,QAAQ,CAAC,EAAE,EAAE,UAAU,CAAC;IAGxB,QAAQ,CAAC,eAAe,EAAE,uBAAuB,CAAC;IAClD,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,CAAC;IACpC,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAC;IAEhC;;;;OAIG;gBACS,IAAI,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,MAAM;IAyB9C,SAAS,CAAC,qBAAqB,IAAI,MAAM;CAG1C"}

package/dist/cjs/services/smarty-streets/client.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SmartyStreetsClient = void 0;
 const base_client_1 = require("../../core/base-client");
-const schemas_1 = require("./schemas");
+const resources_1 = require("./resources");
 /**
  * SmartyStreets Address Validation Service Client
  *
@@ -12,283 +12,50 @@ const schemas_1 = require("./schemas");
  *
  * @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' });
+ * ```
  */
 class SmartyStreetsClient extends base_client_1.BaseServiceClient {
+    /**
+     * 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, baseUrl) {
         super('smarty-streets', http, baseUrl || 'https://smarty-streets.augur-api.com');
-        /**
-         * Health check operations for /health-check endpoint
-         * Following OpenAPI Path Mirroring Pattern
-         */
-        this.healthCheck = {
-            /**
-             * Check SmartyStreets service health and API connectivity
-             *
-             * @fullPath api.smartyStreets.healthCheck.get
-             * @service smarty-streets
-             * @domain system-health
-             * @dataMethod healthCheck.getData
-             * @discoverable true
-             * @searchTerms ["health", "status", "availability", "ping", "check", "address service", "smartystreets connectivity", "validation service"]
-             * @relatedEndpoints ["api.smartyStreets.ping.get", "api.smartyStreets.us.lookup.get", "api.customers.addresses.validate", "api.logistics.healthCheck.get", "api.shipping.healthCheck.get"]
-             * @commonPatterns ["Health check", "Service status", "Address service availability", "System monitoring", "API connectivity test"]
-             * @workflow ["system-monitoring", "health-checks", "service-discovery", "address-validation-setup", "api-status-verification"]
-             * @prerequisites ["Service is running", "Valid authentication token", "x-site-id header", "SmartyStreets API connectivity"]
-             * @nextSteps ["Use address validation endpoints if healthy", "Verify SmartyStreets API credits", "Monitor service metrics"]
-             * @businessRules ["Returns service and API status", "Requires standard authentication", "Standard health check format", "Reports API credit status"]
-             * @functionalArea "system-monitoring"
-             * @caching "No caching - real-time status required"
-             * @performance "Fast response, minimal processing, use for address service monitoring"
-             *
-             * @param params Health check parameters with site ID
-             * @returns Promise<HealthCheckResponse> Service health status with SmartyStreets API connectivity
-             *
-             * @example
-             * ```typescript
-             * // Check if SmartyStreets service is healthy
-             * const response = await client.healthCheck.get({ 'x-site-id': 'SITE123' });
-             * console.log(response.data.status); // 'healthy'
-             * console.log(response.data.service); // 'smarty-streets'
-             * console.log(response.data.smartystreets_connectivity); // true
-             * console.log(response.status); // HTTP status code
-             *
-             * // Get just the health status
-             * const status = await client.healthCheck.getData({ 'x-site-id': 'SITE123' });
-             * console.log(status); // Health data object
-             * ```
-             */
-            get: async (params) => {
-                return this.executeRequest({
-                    method: 'GET',
-                    path: '/health-check',
-                    paramsSchema: schemas_1.HealthCheckParamsSchema,
-                    responseSchema: schemas_1.HealthCheckResponseSchema,
-                }, params);
-            },
-            /**
-             * Get SmartyStreets service health data without full response metadata
-             *
-             * @fullPath api.smartyStreets.healthCheck.getData
-             * @service smarty-streets
-             * @domain system-health
-             * @dataMethod healthCheck.getData
-             * @discoverable true
-             * @searchTerms ["health data", "service status", "smartystreets availability", "api connectivity"]
-             * @relatedEndpoints ["api.smartyStreets.healthCheck.get", "api.smartyStreets.us.lookup.get"]
-             * @commonPatterns ["Get health status", "Check API connectivity", "Service monitoring"]
-             * @workflow ["system-monitoring", "health-checks", "service-verification"]
-             * @prerequisites ["Valid authentication token", "x-site-id header"]
-             * @nextSteps ["Use address validation endpoints if healthy", "Monitor service metrics"]
-             * @businessRules ["Returns only health data object", "No response metadata included"]
-             * @functionalArea "system-monitoring"
-             * @caching "No caching - real-time status required"
-             * @performance "Direct data access, faster for simple health checks"
-             *
-             * @param params Health check parameters with site ID
-             * @returns Promise<HealthCheckData> Direct health status data object
-             */
-            getData: async (params) => {
-                const response = await this.healthCheck.get(params);
-                return response.data;
-            },
-        };
-        /**
-         * Ping operations for /ping endpoint
-         * Following OpenAPI Path Mirroring Pattern
-         */
-        this.ping = {
-            /**
-             * Ping SmartyStreets service for connectivity verification
-             *
-             * @fullPath api.smartyStreets.ping.get
-             * @service smarty-streets
-             * @domain system-health
-             * @dataMethod ping.getData
-             * @discoverable true
-             * @searchTerms ["ping", "connectivity", "response time", "pong", "test", "smartystreets ping", "service alive", "latency check"]
-             * @relatedEndpoints ["api.smartyStreets.healthCheck.get", "api.smartyStreets.us.lookup.get", "api.customers.addresses.ping", "api.logistics.ping.get"]
-             * @commonPatterns ["Ping test", "Connectivity check", "Response time test", "Service alive check", "Latency monitoring"]
-             * @workflow ["system-monitoring", "connectivity-tests", "performance-monitoring", "service-diagnostics", "latency-measurement"]
-             * @prerequisites ["Service is running", "Valid authentication token", "x-site-id header", "Network connectivity"]
-             * @nextSteps ["Use for latency monitoring", "Verify consistent response times", "Include in system health dashboards"]
-             * @businessRules ["Returns pong response", "Measures response time", "Requires standard authentication", "Simple connectivity test"]
-             * @functionalArea "system-monitoring"
-             * @caching "No caching - real-time ping test required"
-             * @performance "Ultra-fast response, use for latency monitoring and connectivity verification"
-             *
-             * @param params Ping parameters with site ID
-             * @returns Promise<PingResponse> Ping response with timing information
-             *
-             * @example
-             * ```typescript
-             * // Test service connectivity
-             * const response = await client.ping.get({ 'x-site-id': 'SITE123' });
-             * console.log(response.data.message); // 'pong'
-             * console.log(response.data.response_time_ms); // Response time
-             * console.log(response.status); // HTTP status code
-             *
-             * // Get just the ping data
-             * const pingData = await client.ping.getData({ 'x-site-id': 'SITE123' });
-             * console.log(pingData); // Ping data object
-             * ```
-             */
-            get: async (params) => {
-                return this.executeRequest({
-                    method: 'GET',
-                    path: '/ping',
-                    paramsSchema: schemas_1.PingParamsSchema,
-                    responseSchema: schemas_1.PingResponseSchema,
-                }, params);
-            },
-            /**
-             * Get SmartyStreets ping data without full response metadata
-             *
-             * @fullPath api.smartyStreets.ping.getData
-             * @service smarty-streets
-             * @domain system-health
-             * @dataMethod ping.getData
-             * @discoverable true
-             * @searchTerms ["ping data", "connectivity test", "response time", "service latency"]
-             * @relatedEndpoints ["api.smartyStreets.ping.get", "api.smartyStreets.healthCheck.get"]
-             * @commonPatterns ["Get ping response", "Check connectivity", "Measure latency"]
-             * @workflow ["system-monitoring", "connectivity-tests", "performance-monitoring"]
-             * @prerequisites ["Valid authentication token", "x-site-id header"]
-             * @nextSteps ["Use for latency monitoring", "Include in performance dashboards"]
-             * @businessRules ["Returns only ping data object", "No response metadata included"]
-             * @functionalArea "system-monitoring"
-             * @caching "No caching - real-time ping test required"
-             * @performance "Direct data access, optimal for latency monitoring"
-             *
-             * @param params Ping parameters with site ID
-             * @returns Promise<PingData> Direct ping response data object
-             */
-            getData: async (params) => {
-                const response = await this.ping.get(params);
-                return response.data;
-            },
-        };
-        /**
-         * US operations for /us/* endpoints
-         * Following OpenAPI Path Mirroring Pattern
-         */
-        this.us = {
-            /**
-             * Lookup operations for /us/lookup endpoint
-             * Following OpenAPI Path Mirroring Pattern
-             */
-            lookup: {
-                /**
-                 * Validate and standardize US addresses using SmartyStreets API
-                 *
-                 * @fullPath api.smartyStreets.us.lookup.get
-                 * @service smarty-streets
-                 * @domain address-validation-and-geocoding
-                 * @dataMethod us.lookup.getData
-                 * @discoverable true
-                 * @searchTerms ["address validation", "us addresses", "standardize", "verify", "lookup", "postal", "zip code", "street address", "delivery", "dpv", "geocoding"]
-                 * @relatedEndpoints ["api.customers.addresses.create", "api.customers.addresses.validate", "api.shipping.rates.calculate", "api.commerce.checkout.validateAddress", "api.logistics.addresses.verify"]
-                 * @commonPatterns ["Validate customer address", "Standardize shipping address", "Verify delivery address", "Clean address data", "Geocode address", "Check address deliverability"]
-                 * @workflow ["address-validation", "customer-onboarding", "checkout-process", "shipping-calculation", "data-quality", "address-standardization", "geocoding-workflow"]
-                 * @prerequisites ["Valid US address components", "Valid authentication token", "x-site-id header", "SmartyStreets API access", "Sufficient API credits"]
-                 * @nextSteps ["Use standardized address for shipping", "Store validated address", "Calculate shipping rates", "Update customer record", "Process geocoding data"]
-                 * @businessRules ["US addresses only", "Requires complete address components", "Returns standardized USPS format", "Validates deliverability", "Provides geocoding data", "Consumes API credits"]
-                 * @functionalArea "address-validation-and-geocoding"
-                 * @crossSite "Supports multi-site address validation with different API configurations"
-                 * @caching "Cache validated addresses for 30 days, invalidate on address changes"
-                 * @performance "Batch requests for multiple addresses, implement retry logic for API limits, monitor credit usage"
-                 *
-                 * @param params Complete US address components for validation
-                 * @returns Promise<UsLookupResponse> Standardized address with validation results and geocoding data
-                 *
-                 * @example
-                 * ```typescript
-                 * // Validate and standardize a customer address
-                 * const addressRequest = {
-                 *   address1: '1234 Example Street',
-                 *   address2: 'Apt 5B',
-                 *   city: 'Provo',
-                 *   state: 'UT',
-                 *   postalCode: '84606',
-                 *   'x-site-id': 'SITE123'
-                 * };
-                 *
-                 * const response = await client.us.lookup.get(addressRequest);
-                 * console.log(response.data.candidates); // Array of standardized addresses
-                 * console.log(response.data.valid_candidates); // Number of valid addresses
-                 * console.log(response.status); // HTTP status code
-                 *
-                 * // Get just the validation data
-                 * const validationResult = await client.us.lookup.getData(addressRequest);
-                 * console.log(validationResult); // Direct validation results
-                 *
-                 * // Validate shipping address for e-commerce
-                 * const shippingAddress = await client.us.lookup.get({
-                 *   address1: '123 Main Street',
-                 *   city: 'New York',
-                 *   state: 'NY',
-                 *   postalCode: '10001',
-                 *   'x-site-id': 'ECOMMERCE-SITE'
-                 * });
-                 *
-                 * // Check if address is deliverable
-                 * const standardized = shippingAddress.data.candidates[0];
-                 * if (standardized?.analysis?.dpv_match_y) {
-                 *   console.log('Address is deliverable');
-                 *   console.log('Standardized:', standardized.delivery_line_1);
-                 *   console.log('ZIP+4:', standardized.zipcode + '-' + standardized.plus4_code);
-                 * }
-                 *
-                 * // Extract geocoding data
-                 * if (standardized?.metadata) {
-                 *   console.log('County:', standardized.metadata.county_name);
-                 *   console.log('Time Zone:', standardized.metadata.time_zone);
-                 *   console.log('Carrier Route:', standardized.metadata.carrier_route);
-                 * }
-                 *
-                 * // Handle validation errors
-                 * if (shippingAddress.data.valid_candidates === 0) {
-                 *   console.log('Invalid address - requires correction');
-                 * } else if (shippingAddress.data.ambiguous_candidates > 0) {
-                 *   console.log('Multiple matches found - user selection required');
-                 * }
-                 * ```
-                 */
-                get: async (params) => {
-                    return this.executeRequest({
-                        method: 'GET',
-                        path: '/us/lookup',
-                        paramsSchema: schemas_1.UsLookupParamsSchema,
-                        responseSchema: schemas_1.UsLookupResponseSchema,
-                    }, params);
-                },
-                /**
-                 * Get US address validation data without full response metadata
-                 *
-                 * @fullPath api.smartyStreets.us.lookup.getData
-                 * @service smarty-streets
-                 * @domain address-validation-and-geocoding
-                 * @dataMethod us.lookup.getData
-                 * @discoverable true
-                 * @searchTerms ["address data", "validation results", "standardized address", "geocoding data", "dpv results"]
-                 * @relatedEndpoints ["api.smartyStreets.us.lookup.get", "api.customers.addresses.create", "api.shipping.rates.calculate"]
-                 * @commonPatterns ["Get address validation results", "Extract standardized address", "Process geocoding data"]
-                 * @workflow ["address-validation", "customer-onboarding", "checkout-process", "shipping-calculation"]
-                 * @prerequisites ["Valid US address components", "Valid authentication token", "SmartyStreets API access"]
-                 * @nextSteps ["Use standardized address", "Store validation results", "Calculate shipping rates"]
-                 * @businessRules ["Returns only address validation data", "No response metadata included", "Direct access to candidates array"]
-                 * @functionalArea "address-validation-and-geocoding"
-                 * @caching "Cache validation results for 30 days"
-                 * @performance "Direct data access, optimal for address processing and validation workflows"
-                 *
-                 * @param params Complete US address components for validation
-                 * @returns Promise<UsLookupData> Direct address validation results without response wrapper
-                 */
-                getData: async (params) => {
-                    const response = await this.us.lookup.get(params);
-                    return response.data;
-                },
-            },
+        // Create a wrapper function that calls executeRequest dynamically
+        // This allows tests to spy on executeRequest after construction
+        // Note: Resources build URLs directly, so pathParams is not used
+        const boundExecuteRequest = (config, params, pathParams) => {
+            return this.executeRequest(config, params, pathParams);
         };
+        // Initialize standard API resources
+        this.healthCheck = (0, resources_1.createHealthCheckResource)(boundExecuteRequest);
+        this.ping = (0, resources_1.createPingResource)(boundExecuteRequest);
+        this.us = (0, resources_1.createUsResource)(boundExecuteRequest);
+        // Initialize data-only API resources (dual API pattern)
+        this.healthCheckData = (0, resources_1.createHealthCheckDataResource)(this.healthCheck);
+        this.pingData = (0, resources_1.createPingDataResource)(this.ping);
+        this.usData = (0, resources_1.createUsDataResource)(this.us);
     }
     getServiceDescription() {
         return 'SmartyStreets address validation service for US address standardization and geocoding';

package/dist/cjs/services/smarty-streets/client.js.map

@@ -1 +1 @@
-{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../../src/services/smarty-streets/client.ts"],"names":[],"mappings":";;;AAAA,wDAA2D;AAE3D,uCAgBmB;AAEnB;;;;;;;;;GASG;AACH,MAAa,mBAAoB,SAAQ,+BAAiB;IACxD,YAAY,IAAgB,EAAE,OAAgB;QAC5C,KAAK,CAAC,gBAAgB,EAAE,IAAI,EAAE,OAAO,IAAI,sCAAsC,CAAC,CAAC;QAOnF;;;WAGG;QACa,gBAAW,GAAG;YAC5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;eAmCG;YACH,GAAG,EAAE,KAAK,EAAE,MAAyB,EAAgC,EAAE;gBACrE,OAAO,IAAI,CAAC,cAAc,CACxB;oBACE,MAAM,EAAE,KAAK;oBACb,IAAI,EAAE,eAAe;oBACrB,YAAY,EAAE,iCAAuB;oBACrC,cAAc,EAAE,mCAAyB;iBAC1C,EACD,MAAM,CACP,CAAC;YACJ,CAAC;YAED;;;;;;;;;;;;;;;;;;;;;eAqBG;YACH,OAAO,EAAE,KAAK,EAAE,MAAyB,EAA4B,EAAE;gBACrE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;gBACpD,OAAO,QAAQ,CAAC,IAAI,CAAC;YACvB,CAAC;SACF,CAAC;QAEF;;;WAGG;QACa,SAAI,GAAG;YACrB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;eAkCG;YACH,GAAG,EAAE,KAAK,EAAE,MAAkB,EAAyB,EAAE;gBACvD,OAAO,IAAI,CAAC,cAAc,CACxB;oBACE,MAAM,EAAE,KAAK;oBACb,IAAI,EAAE,OAAO;oBACb,YAAY,EAAE,0BAAgB;oBAC9B,cAAc,EAAE,4BAAkB;iBACnC,EACD,MAAM,CACP,CAAC;YACJ,CAAC;YAED;;;;;;;;;;;;;;;;;;;;;eAqBG;YACH,OAAO,EAAE,KAAK,EAAE,MAAkB,EAAqB,EAAE;gBACvD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;gBAC7C,OAAO,QAAQ,CAAC,IAAI,CAAC;YACvB,CAAC;SACF,CAAC;QAEF;;;WAGG;QACa,OAAE,GAAG;YACnB;;;eAGG;YACH,MAAM,EAAE;gBACN;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBA2EG;gBACH,GAAG,EAAE,KAAK,EAAE,MAAsB,EAA6B,EAAE;oBAC/D,OAAO,IAAI,CAAC,cAAc,CACxB;wBACE,MAAM,EAAE,KAAK;wBACb,IAAI,EAAE,YAAY;wBAClB,YAAY,EAAE,8BAAoB;wBAClC,cAAc,EAAE,gCAAsB;qBACvC,EACD,MAAM,CACP,CAAC;gBACJ,CAAC;gBAED;;;;;;;;;;;;;;;;;;;;;mBAqBG;gBACH,OAAO,EAAE,KAAK,EAAE,MAAsB,EAAyB,EAAE;oBAC/D,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;oBAClD,OAAO,QAAQ,CAAC,IAAI,CAAC;gBACvB,CAAC;aACF;SACF,CAAC;IApSF,CAAC;IAES,qBAAqB;QAC7B,OAAO,uFAAuF,CAAC;IACjG,CAAC;CAiSF;AAxSD,kDAwSC"}
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../../src/services/smarty-streets/client.ts"],"names":[],"mappings":";;;AAAA,wDAA2E;AAE3E,2CAaqB;AAErB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,MAAa,mBAAoB,SAAQ,+BAAiB;IAWxD;;;;OAIG;IACH,YAAY,IAAgB,EAAE,OAAgB;QAC5C,KAAK,CAAC,gBAAgB,EAAE,IAAI,EAAE,OAAO,IAAI,sCAAsC,CAAC,CAAC;QAEjF,kEAAkE;QAClE,gEAAgE;QAChE,iEAAiE;QACjE,MAAM,mBAAmB,GAAG,CAC1B,MAA0C,EAC1C,MAAgB,EAChB,UAAmC,EACf,EAAE;YACtB,OAAO,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;QACzD,CAAC,CAAC;QAEF,oCAAoC;QACpC,IAAI,CAAC,WAAW,GAAG,IAAA,qCAAyB,EAAC,mBAAmB,CAAC,CAAC;QAClE,IAAI,CAAC,IAAI,GAAG,IAAA,8BAAkB,EAAC,mBAAmB,CAAC,CAAC;QACpD,IAAI,CAAC,EAAE,GAAG,IAAA,4BAAgB,EAAC,mBAAmB,CAAC,CAAC;QAEhD,wDAAwD;QACxD,IAAI,CAAC,eAAe,GAAG,IAAA,yCAA6B,EAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACvE,IAAI,CAAC,QAAQ,GAAG,IAAA,kCAAsB,EAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAClD,IAAI,CAAC,MAAM,GAAG,IAAA,gCAAoB,EAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC9C,CAAC;IAES,qBAAqB;QAC7B,OAAO,uFAAuF,CAAC;IACjG,CAAC;CACF;AA5CD,kDA4CC"}