@simpleapps-com/augur-api 0.3.0 → 0.3.2

package/dist/esm/services/slack/schemas.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schemas.d.ts","sourceRoot":"","sources":["../../../../src/services/slack/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAKxB;;GAEG;AACH,eAAO,MAAM,uBAAuB;;;;;;EAElC,CAAC;AAEH;;;GAGG;AACH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA0ErC,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,0BAA0B;;;;;;;;;EAGrC,CAAC;AAIH;;GAEG;AACH,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;EASoB,CAAC;AAEvD;;GAEG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAeiD,CAAC;AAEhF;;GAEG;AACH,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;EAWqC,CAAC;AAI3E;;GAEG;AACH,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAA4C,CAAC;AAEnF;;GAEG;AACH,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAAwC,CAAC;AAE3E;;GAEG;AACH,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAA+C,CAAC;AAIzF,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AACxE,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAC9E,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAE9E,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AACpE,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAC5D,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAE1E,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAC5E,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AACpE,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAC"}

package/dist/esm/services/slack/schemas.js

@@ -0,0 +1,145 @@
+import { z } from 'zod';
+import { BaseResponseSchema } from '../../core/schemas';
+// Slack Service Parameter Schemas
+/**
+ * Health check parameters - slack service health verification
+ */
+export const HealthCheckParamsSchema = z.object({
+    'x-site-id': z.string().describe('Site ID provided by SimpleApps'),
+});
+/**
+ * Web hook request parameters for Slack integration
+ * Supports webhook registration, updates, and notification handling
+ */
+export const WebHookRequestParamsSchema = z.object({
+    // Webhook configuration
+    url: z.string().url('Valid webhook URL is required').optional(),
+    channel: z.string().min(1, 'Slack channel is required').optional(),
+    username: z.string().optional(),
+    icon_emoji: z.string().optional(),
+    icon_url: z.string().url().optional(),
+    // Message content
+    text: z.string().optional(),
+    attachments: z
+        .array(z.object({
+        fallback: z.string().optional(),
+        color: z.string().optional(),
+        pretext: z.string().optional(),
+        author_name: z.string().optional(),
+        author_link: z.string().url().optional(),
+        author_icon: z.string().url().optional(),
+        title: z.string().optional(),
+        title_link: z.string().url().optional(),
+        text: z.string().optional(),
+        fields: z
+            .array(z.object({
+            title: z.string(),
+            value: z.string(),
+            short: z.boolean().optional(),
+        }))
+            .optional(),
+        image_url: z.string().url().optional(),
+        thumb_url: z.string().url().optional(),
+        footer: z.string().optional(),
+        footer_icon: z.string().url().optional(),
+        ts: z.number().optional(),
+    }))
+        .optional(),
+    // Slack blocks (modern message formatting)
+    blocks: z
+        .array(z.object({
+        type: z.enum(['section', 'divider', 'image', 'actions', 'context', 'header']),
+        text: z
+            .object({
+            type: z.enum(['plain_text', 'mrkdwn']),
+            text: z.string(),
+            emoji: z.boolean().optional(),
+        })
+            .optional(),
+        block_id: z.string().optional(),
+        fields: z
+            .array(z.object({
+            type: z.enum(['plain_text', 'mrkdwn']),
+            text: z.string(),
+        }))
+            .optional(),
+        accessory: z.any().optional(),
+        elements: z.array(z.any()).optional(),
+    }))
+        .optional(),
+    // Webhook settings
+    webhook_type: z.enum(['incoming', 'slash_command', 'interactive', 'event']).optional(),
+    event_type: z.string().optional(),
+    trigger_word: z.string().optional(),
+    // Headers (will be passed automatically)
+    'x-site-id': z.string().describe('Site ID provided by SimpleApps'),
+});
+/**
+ * Web hook refresh parameters
+ */
+export const WebHookRefreshParamsSchema = z.object({
+    'x-site-id': z.string().describe('Site ID provided by SimpleApps'),
+    force: z.boolean().optional().describe('Force refresh of webhook configuration'),
+});
+// Data Schemas (flexible for API responses without detailed schemas)
+/**
+ * Health check response data
+ */
+export const HealthCheckDataSchema = z
+    .object({
+    status: z.string(),
+    service: z.string(),
+    timestamp: z.string().optional(),
+    version: z.string().optional(),
+    slack_connectivity: z.boolean().optional(),
+    webhook_status: z.string().optional(),
+})
+    .describe('Slack service health status information');
+/**
+ * Webhook response data - result of webhook operations
+ */
+export const WebHookDataSchema = z
+    .object({
+    webhook_id: z.string().optional(),
+    url: z.string().url().optional(),
+    channel: z.string().optional(),
+    status: z.enum(['active', 'inactive', 'pending', 'error']),
+    message: z.string(),
+    timestamp: z.string().optional(),
+    delivery_status: z.enum(['sent', 'delivered', 'failed', 'pending']).optional(),
+    response_code: z.number().optional(),
+    error_message: z.string().optional(),
+    retry_count: z.number().optional(),
+    last_attempt: z.string().optional(),
+    next_retry: z.string().optional(),
+})
+    .describe('Slack webhook operation result with delivery status and metadata');
+/**
+ * Webhook refresh response data
+ */
+export const WebHookRefreshDataSchema = z
+    .object({
+    refreshed: z.boolean(),
+    webhook_count: z.number(),
+    active_webhooks: z.number(),
+    inactive_webhooks: z.number(),
+    errors: z.array(z.string()).optional(),
+    refresh_timestamp: z.string(),
+    configuration_status: z.enum(['valid', 'invalid', 'partial']),
+    channels: z.array(z.string()).optional(),
+})
+    .describe('Webhook refresh operation results with configuration status');
+// Response Schemas using BaseResponseSchema
+/**
+ * Health check response
+ */
+export const HealthCheckResponseSchema = BaseResponseSchema(HealthCheckDataSchema);
+/**
+ * Web hook response
+ */
+export const WebHookResponseSchema = BaseResponseSchema(WebHookDataSchema);
+/**
+ * Web hook refresh response
+ */
+export const WebHookRefreshResponseSchema = BaseResponseSchema(WebHookRefreshDataSchema);
+//# sourceMappingURL=schemas.js.map

package/dist/esm/services/slack/schemas.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../../../src/services/slack/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAExD,kCAAkC;AAElC;;GAEG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9C,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,gCAAgC,CAAC;CACnE,CAAC,CAAC;AAEH;;;GAGG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,CAAC,MAAM,CAAC;IACjD,wBAAwB;IACxB,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,+BAA+B,CAAC,CAAC,QAAQ,EAAE;IAC/D,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,2BAA2B,CAAC,CAAC,QAAQ,EAAE;IAClE,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IAErC,kBAAkB;IAClB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,WAAW,EAAE,CAAC;SACX,KAAK,CACJ,CAAC,CAAC,MAAM,CAAC;QACP,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC/B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC5B,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC9B,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAClC,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;QACxC,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;QACxC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC5B,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;QACvC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC3B,MAAM,EAAE,CAAC;aACN,KAAK,CACJ,CAAC,CAAC,MAAM,CAAC;YACP,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;YACjB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;YACjB,KAAK,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;SAC9B,CAAC,CACH;aACA,QAAQ,EAAE;QACb,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;QACtC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;QACtC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC7B,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;QACxC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;KAC1B,CAAC,CACH;SACA,QAAQ,EAAE;IAEb,2CAA2C;IAC3C,MAAM,EAAE,CAAC;SACN,KAAK,CACJ,CAAC,CAAC,MAAM,CAAC;QACP,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;QAC7E,IAAI,EAAE,CAAC;aACJ,MAAM,CAAC;YACN,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;YACtC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;YAChB,KAAK,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;SAC9B,CAAC;aACD,QAAQ,EAAE;QACb,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC/B,MAAM,EAAE,CAAC;aACN,KAAK,CACJ,CAAC,CAAC,MAAM,CAAC;YACP,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;YACtC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;SACjB,CAAC,CACH;aACA,QAAQ,EAAE;QACb,SAAS,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;QAC7B,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,QAAQ,EAAE;KACtC,CAAC,CACH;SACA,QAAQ,EAAE;IAEb,mBAAmB;IACnB,YAAY,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,eAAe,EAAE,aAAa,EAAE,OAAO,CAAC,CAAC,CAAC,QAAQ,EAAE;IACtF,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAEnC,yCAAyC;IACzC,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,gCAAgC,CAAC;CACnE,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,CAAC,MAAM,CAAC;IACjD,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,gCAAgC,CAAC;IAClE,KAAK,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,wCAAwC,CAAC;CACjF,CAAC,CAAC;AAEH,qEAAqE;AAErE;;GAEG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC;KACnC,MAAM,CAAC;IACN,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,kBAAkB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC1C,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACtC,CAAC;KACD,QAAQ,CAAC,yCAAyC,CAAC,CAAC;AAEvD;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC;KAC/B,MAAM,CAAC;IACN,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IAChC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,UAAU,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IAC1D,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,eAAe,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC,QAAQ,EAAE;IAC9E,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACpC,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACpC,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACnC,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAClC,CAAC;KACD,QAAQ,CAAC,kEAAkE,CAAC,CAAC;AAEhF;;GAEG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC;KACtC,MAAM,CAAC;IACN,SAAS,EAAE,CAAC,CAAC,OAAO,EAAE;IACtB,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE;IACzB,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE;IAC3B,iBAAiB,EAAE,CAAC,CAAC,MAAM,EAAE;IAC7B,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IACtC,iBAAiB,EAAE,CAAC,CAAC,MAAM,EAAE;IAC7B,oBAAoB,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;IAC7D,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;CACzC,CAAC;KACD,QAAQ,CAAC,6DAA6D,CAAC,CAAC;AAE3E,4CAA4C;AAE5C;;GAEG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,kBAAkB,CAAC,qBAAqB,CAAC,CAAC;AAEnF;;GAEG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,kBAAkB,CAAC,iBAAiB,CAAC,CAAC;AAE3E;;GAEG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,kBAAkB,CAAC,wBAAwB,CAAC,CAAC"}

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

@@ -0,0 +1,237 @@
+import { BaseServiceClient } from '../../core/base-client';
+import type { HTTPClient } from '../../core/client';
+import { HealthCheckParams, HealthCheckResponse, PingParams, PingResponse, USLookupParams, USLookupResponse, HealthCheckData, PingData, USLookupData } from './schemas';
+/**
+ * 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
+ */
+export declare class SmartyStreetsClient extends BaseServiceClient {
+    constructor(http: HTTPClient, baseUrl?: string);
+    protected getServiceDescription(): string;
+    /**
+     * Check SmartyStreets service health and API connectivity
+     *
+     * @fullPath api.smartyStreets.healthCheck.get
+     * @service smarty-streets
+     * @domain system-health
+     * @dataMethod healthCheckData
+     * @discoverable true
+     * @searchTerms ["health", "status", "availability", "ping", "check", "address service", "smartystreets connectivity", "validation service"]
+     * @relatedEndpoints ["api.smartyStreets.ping.get", "api.smartyStreets.us.lookup", "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({ '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.healthCheckData({ 'x-site-id': 'SITE123' });
+     * console.log(status); // Health data object
+     * ```
+     */
+    healthCheck(params: HealthCheckParams): Promise<HealthCheckResponse>;
+    /**
+     * Ping SmartyStreets service for connectivity verification
+     *
+     * @fullPath api.smartyStreets.ping.get
+     * @service smarty-streets
+     * @domain system-health
+     * @dataMethod pingData
+     * @discoverable true
+     * @searchTerms ["ping", "connectivity", "response time", "pong", "test", "smartystreets ping", "service alive", "latency check"]
+     * @relatedEndpoints ["api.smartyStreets.healthCheck.get", "api.smartyStreets.us.lookup", "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({ '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.pingData({ 'x-site-id': 'SITE123' });
+     * console.log(pingData); // Ping data object
+     * ```
+     */
+    ping(params: PingParams): Promise<PingResponse>;
+    /**
+     * Validate and standardize US addresses using SmartyStreets API
+     *
+     * @fullPath api.smartyStreets.us.lookup
+     * @service smarty-streets
+     * @domain address-validation-and-geocoding
+     * @dataMethod usLookupData
+     * @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.usLookup(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.usLookupData(addressRequest);
+     * console.log(validationResult); // Direct validation results
+     *
+     * // Validate shipping address for e-commerce
+     * const shippingAddress = await client.usLookup({
+     *   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');
+     * }
+     * ```
+     */
+    usLookup(params: USLookupParams): Promise<USLookupResponse>;
+    /**
+     * Get SmartyStreets service health data without full response metadata
+     *
+     * @fullPath api.smartyStreets.healthCheckData.get
+     * @service smarty-streets
+     * @domain system-health
+     * @dataMethod healthCheckData
+     * @discoverable true
+     * @searchTerms ["health data", "service status", "smartystreets availability", "api connectivity"]
+     * @relatedEndpoints ["api.smartyStreets.healthCheck.get", "api.smartyStreets.us.lookup"]
+     * @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
+     */
+    healthCheckData(params: HealthCheckParams): Promise<HealthCheckData>;
+    /**
+     * Get SmartyStreets ping data without full response metadata
+     *
+     * @fullPath api.smartyStreets.pingData.get
+     * @service smarty-streets
+     * @domain system-health
+     * @dataMethod pingData
+     * @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
+     */
+    pingData(params: PingParams): Promise<PingData>;
+    /**
+     * Get US address validation data without full response metadata
+     *
+     * @fullPath api.smartyStreets.usLookupData.get
+     * @service smarty-streets
+     * @domain address-validation-and-geocoding
+     * @dataMethod usLookupData
+     * @discoverable true
+     * @searchTerms ["address data", "validation results", "standardized address", "geocoding data", "dpv results"]
+     * @relatedEndpoints ["api.smartyStreets.us.lookup", "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
+     */
+    usLookupData(params: USLookupParams): Promise<USLookupData>;
+}
+//# sourceMappingURL=client.d.ts.map

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

@@ -0,0 +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,EAEnB,UAAU,EAEV,YAAY,EAEZ,cAAc,EAEd,gBAAgB,EAChB,eAAe,EACf,QAAQ,EACR,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACG,WAAW,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAY1E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACG,IAAI,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,YAAY,CAAC;IAYrD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2EG;IACG,QAAQ,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAcjE;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,eAAe,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,eAAe,CAAC;IAK1E;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,QAAQ,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,QAAQ,CAAC;IAKrD;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,YAAY,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC;CAIlE"}