@simpleapps-com/augur-api 0.3.3 → 0.4.0

package/dist/types/services/agr-work/client.d.ts

@@ -2,119 +2,175 @@ import { BaseServiceClient } from '../../core/base-client';
 import type { HTTPClient } from '../../core/client';
 /**
  * AGR Work Service Client
- *
- * Provides access to AGR work service endpoints for system health monitoring
- * and basic connectivity testing.
- *
+ * @description Client for interacting with AGR Work microservice API endpoints for system health monitoring and basic connectivity testing
+ * @fullPath api.agrWork
  * @service agr-work
  * @domain system-monitoring
+ * @discoverable true
+ * @searchTerms ["agr-work", "health monitoring", "connectivity testing", "system health", "ping pong", "service monitoring", "uptime"]
+ * @relatedEndpoints ["api.agrWork.healthCheck.get", "api.agrWork.ping.get", "api.agrInfo.healthCheck.get"]
+ * @commonPatterns ["System health monitoring", "Basic connectivity testing", "Service availability checks"]
+ * @workflow ["health-monitoring", "connectivity-testing", "system-diagnostics"]
+ * @functionalArea "system-monitoring"
+ * @businessRules ["Requires valid site authentication", "Minimal processing for fast responses", "Used for monitoring and alerting systems"]
+ * @performance "Ultra-fast responses designed for monitoring scripts and health checks"
+ * @example
+ * ```typescript
+ * import { HTTPClient } from '@augur/api-client/core';
+ * import { AgrWorkClient } from '@augur/api-client/services/agr-work';
+ *
+ * const http = new HTTPClient('agr-work', { siteId: 'your-site-id', bearerToken: 'your-token' });
+ * const agrWork = new AgrWorkClient(http);
+ *
+ * // Check service health
+ * const health = await agrWork.healthCheck.get();
+ * const healthData = await agrWork.healthCheck.getData();
+ *
+ * // Test basic connectivity
+ * const ping = await agrWork.ping.get();
+ * const pongData = await agrWork.ping.getData();
+ *
+ * // Use in monitoring loop
+ * setInterval(async () => {
+ *   try {
+ *     await agrWork.ping.get();
+ *     console.log('AGR Work service is alive');
+ *   } catch (error) {
+ *     console.error('AGR Work service unreachable:', error);
+ *   }
+ * }, 30000);
+ * ```
  */
 export declare class AgrWorkClient extends BaseServiceClient {
     constructor(http: HTTPClient, baseUrl?: string);
     protected getServiceDescription(): string;
     /**
-     * Check service health and availability
-     *
-     * @fullPath api.agrWork.healthCheck.get
-     * @service agr-work
-     * @domain system-health
-     * @dataMethod healthCheckData
-     * @discoverable true
-     * @searchTerms ["health", "status", "availability", "ping", "check", "monitoring"]
-     * @relatedEndpoints ["api.agrWork.ping.get", "api.agrInfo.healthCheck.get", "api.customers.healthCheck.get", "api.commerce.healthCheck.get", "api.items.healthCheck.get"]
-     * @commonPatterns ["Health check", "Service status", "API availability", "System monitoring"]
-     * @workflow ["system-monitoring", "health-checks", "service-discovery", "uptime-monitoring"]
-     * @prerequisites ["Service is running", "Valid authentication token", "x-site-id header"]
-     * @nextSteps ["Use other endpoints if healthy", "Check ping for basic connectivity", "Monitor service metrics"]
-     * @businessRules ["Returns service status and basic info", "Requires authentication", "Standard health check format"]
-     * @functionalArea "system-monitoring"
-     * @caching "No caching - real-time status required"
-     * @performance "Fast response, minimal processing, use for health monitoring"
-     *
-     * @returns Promise<HealthCheckResponse> Service health status
-     *
-     * @example
-     * ```typescript
-     * // Check if service is healthy
-     * const response = await client.healthCheck();
-     * console.log(response.data); // Health status string
-     * console.log(response.status); // HTTP status code
-     *
-     * // Get just the health status
-     * const status = await client.healthCheckData();
-     * console.log(status); // Direct string access
-     * ```
+     * Health Check Operations
+     * @description System health monitoring and availability verification for AGR work service
      */
-    readonly healthCheck: () => Promise<{
-        params: Record<string, unknown> | unknown[];
-        data: string;
-        options: Record<string, unknown> | unknown[];
-        status: number;
-        message: string;
-        count: number;
-        total: number;
-        totalResults: number;
-    }>;
+    healthCheck: {
+        /**
+         * Check service health and availability
+         *
+         * @fullPath api.agrWork.healthCheck.get
+         * @service agr-work
+         * @domain system-health
+         * @dataMethod healthCheck.getData - returns only the health status data without metadata
+         * @discoverable true
+         * @searchTerms ["health", "status", "availability", "ping", "check", "monitoring"]
+         * @relatedEndpoints ["api.agrWork.ping.get", "api.agrInfo.healthCheck.get", "api.customers.healthCheck.get", "api.commerce.healthCheck.get", "api.items.healthCheck.get"]
+         * @commonPatterns ["Health check", "Service status", "API availability", "System monitoring"]
+         * @workflow ["system-monitoring", "health-checks", "service-discovery", "uptime-monitoring"]
+         * @prerequisites ["Service is running", "Valid authentication token", "x-site-id header"]
+         * @nextSteps ["Use other endpoints if healthy", "Check ping for basic connectivity", "Monitor service metrics"]
+         * @businessRules ["Returns service status and basic info", "Requires authentication", "Standard health check format"]
+         * @functionalArea "system-monitoring"
+         * @caching "No caching - real-time status required"
+         * @performance "Fast response, minimal processing, use for health monitoring"
+         *
+         * @returns Promise<HealthCheckResponse> Service health status
+         *
+         * @example
+         * ```typescript
+         * // Check if service is healthy
+         * const response = await client.healthCheck.get();
+         * console.log(response.data); // Health status string
+         * console.log(response.status); // HTTP status code
+         *
+         * // Get just the health status
+         * const status = await client.healthCheck.getData();
+         * console.log(status); // Direct string access
+         * ```
+         */
+        get: () => Promise<{
+            params: Record<string, unknown> | unknown[];
+            data: string;
+            options: Record<string, unknown> | unknown[];
+            status: number;
+            message: string;
+            count: number;
+            total: number;
+            totalResults: number;
+        }>;
+        /**
+         * Get health check status data only
+         * @returns Promise<string> Health status string
+         */
+        getData: () => Promise<string>;
+    };
     /**
-     * Send ping request to verify basic connectivity
-     *
-     * @fullPath api.agrWork.ping.get
-     * @service agr-work
-     * @domain system-connectivity
-     * @dataMethod pingData
-     * @discoverable true
-     * @searchTerms ["ping", "pong", "connectivity", "test", "alive", "echo", "network"]
-     * @relatedEndpoints ["api.agrWork.healthCheck.get", "api.agrInfo.healthCheck.get"]
-     * @commonPatterns ["Ping service", "Test connectivity", "Network check", "Basic alive test"]
-     * @workflow ["connectivity-testing", "network-diagnostics", "basic-monitoring", "service-verification"]
-     * @prerequisites ["Service is reachable", "Valid authentication token", "x-site-id header", "Network connectivity"]
-     * @nextSteps ["Use health check for detailed status", "Implement monitoring dashboards", "Set up alerting"]
-     * @businessRules ["Returns 'pong' response", "Minimal processing for speed", "Used for basic connectivity verification"]
-     * @functionalArea "system-monitoring"
-     * @caching "No caching - real-time connectivity test"
-     * @performance "Ultra-fast response, minimal payload, ideal for monitoring scripts"
-     *
-     * @returns Promise<PingResponse> Ping response (typically 'pong')
-     *
-     * @example
-     * ```typescript
-     * // Basic connectivity test
-     * const response = await client.ping();
-     * console.log(response.data); // Should be 'pong' or similar
-     * console.log(response.message); // Success message
-     *
-     * // Get just the ping response
-     * const pong = await client.pingData();
-     * console.log(pong); // Direct response string
-     *
-     * // Use in monitoring loop
-     * setInterval(async () => {
-     *   try {
-     *     await client.ping();
-     *     console.log('Service is alive');
-     *   } catch (error) {
-     *     console.error('Service unreachable:', error);
-     *   }
-     * }, 30000); // Check every 30 seconds
-     * ```
+     * Ping Connectivity Operations
+     * @description Basic connectivity testing and network verification for AGR work service
      */
-    readonly ping: () => Promise<{
-        params: Record<string, unknown> | unknown[];
-        data: string;
-        options: Record<string, unknown> | unknown[];
-        status: number;
-        message: string;
-        count: number;
-        total: number;
-        totalResults: number;
-    }>;
+    ping: {
+        /**
+         * Send ping request to verify basic connectivity
+         *
+         * @fullPath api.agrWork.ping.get
+         * @service agr-work
+         * @domain system-connectivity
+         * @dataMethod ping.getData - returns only the ping response data without metadata
+         * @discoverable true
+         * @searchTerms ["ping", "pong", "connectivity", "test", "alive", "echo", "network"]
+         * @relatedEndpoints ["api.agrWork.healthCheck.get", "api.agrInfo.healthCheck.get"]
+         * @commonPatterns ["Ping service", "Test connectivity", "Network check", "Basic alive test"]
+         * @workflow ["connectivity-testing", "network-diagnostics", "basic-monitoring", "service-verification"]
+         * @prerequisites ["Service is reachable", "Valid authentication token", "x-site-id header", "Network connectivity"]
+         * @nextSteps ["Use health check for detailed status", "Implement monitoring dashboards", "Set up alerting"]
+         * @businessRules ["Returns 'pong' response", "Minimal processing for speed", "Used for basic connectivity verification"]
+         * @functionalArea "system-monitoring"
+         * @caching "No caching - real-time connectivity test"
+         * @performance "Ultra-fast response, minimal payload, ideal for monitoring scripts"
+         *
+         * @returns Promise<PingResponse> Ping response (typically 'pong')
+         *
+         * @example
+         * ```typescript
+         * // Basic connectivity test
+         * const response = await client.ping.get();
+         * console.log(response.data); // Should be 'pong' or similar
+         * console.log(response.message); // Success message
+         *
+         * // Get just the ping response
+         * const pong = await client.ping.getData();
+         * console.log(pong); // Direct response string
+         *
+         * // Use in monitoring loop
+         * setInterval(async () => {
+         *   try {
+         *     await client.ping.get();
+         *     console.log('Service is alive');
+         *   } catch (error) {
+         *     console.error('Service unreachable:', error);
+         *   }
+         * }, 30000); // Check every 30 seconds
+         * ```
+         */
+        get: () => Promise<{
+            params: Record<string, unknown> | unknown[];
+            data: string;
+            options: Record<string, unknown> | unknown[];
+            status: number;
+            message: string;
+            count: number;
+            total: number;
+            totalResults: number;
+        }>;
+        /**
+         * Get ping response data only
+         * @returns Promise<string> Ping response string (typically 'pong')
+         */
+        getData: () => Promise<string>;
+    };
     /**
      * Get health check status data only
+     * @deprecated Use healthCheck.getData() instead
      * @returns Promise<string> Health status string
      */
     readonly healthCheckData: () => Promise<string>;
     /**
      * Get ping response data only
+     * @deprecated Use ping.getData() instead
      * @returns Promise<string> Ping response string (typically 'pong')
      */
     readonly pingData: () => Promise<string>;

package/dist/types/services/agr-work/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../../src/services/agr-work/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAGpD;;;;;;;;GAQG;AACH,qBAAa,aAAc,SAAQ,iBAAiB;gBACtC,IAAI,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,MAAM;IAI9C,SAAS,CAAC,qBAAqB,IAAI,MAAM;IAIzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,QAAQ,CAAC,WAAW;;;;;;;;;OAA2D;IAE/E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACH,QAAQ,CAAC,IAAI;;;;;;;;;OAA6C;IAI1D;;;OAGG;IACH,QAAQ,CAAC,eAAe,QAAa,OAAO,CAAC,MAAM,CAAC,CAGlD;IAEF;;;OAGG;IACH,QAAQ,CAAC,QAAQ,QAAa,OAAO,CAAC,MAAM,CAAC,CAG3C;CACH"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../../src/services/agr-work/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAGpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,qBAAa,aAAc,SAAQ,iBAAiB;gBACtC,IAAI,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,MAAM;IAI9C,SAAS,CAAC,qBAAqB,IAAI,MAAM;IAIzC;;;OAGG;IACH,WAAW;QACT;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAgCG;;;;;;;;;;;QAYH;;;WAGG;uBACgB,OAAO,CAAC,MAAM,CAAC;MAIlC;IAEF;;;OAGG;IACH,IAAI;QACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA0CG;;;;;;;;;;;QAYH;;;WAGG;uBACgB,OAAO,CAAC,MAAM,CAAC;MAIlC;IAIF;;;;OAIG;IACH,QAAQ,CAAC,eAAe,QAAa,OAAO,CAAC,MAAM,CAAC,CAGlD;IAEF;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,QAAa,OAAO,CAAC,MAAM,CAAC,CAG3C;CACH"}