@simpleapps-com/augur-api/dist/types/services/agr-site/client.d.ts

TypeScript client library for Augur microservices API endpoints

import { BaseServiceClient } from '../../core/base-client';
import type { HTTPClient } from '../../core/client';
import { type HealthCheckResource, type HealthCheckDataResource, type SettingsResource, type SettingsDataResource, type FyxerTranscriptResource, type FyxerTranscriptDataResource, type OpenSearchResource, type OpenSearchDataResource, type MetaFilesResource, type MetaFilesDataResource, type NotificationsResource, type NotificationsDataResource, type GeoCodesPostalCodesResource, type GeoCodesPostalCodesDataResource, type TrainingResource, type TrainingDataResource } from './resources';
/**
 * AGR-Site API Client
 * @description Client for interacting with AGR-Site (Augur Site) microservice API endpoints for site content management, AI transcription processing, and search embedding functionality
 * @fullPath api.agrSite
 * @service agr-site
 * @domain site-content-management
 * @discoverable true
 * @searchTerms ["agr-site", "augur site", "site content", "settings management", "fyxer transcripts", "AI transcription", "opensearch embedding", "content management", "site data"]
 * @relatedEndpoints ["api.agrSite.settings", "api.agrSite.fyxerTranscript", "api.agrSite.openSearch.embedding", "api.agrSite.metaFiles.robots", "api.agrSite.notifications", "api.agrSite.healthCheck"]
 * @commonPatterns ["Site content management", "AI transcript processing", "Search embedding integration", "Site settings configuration"]
 * @workflow ["content-creation", "transcript-processing", "search-optimization", "site-data-management"]
 * @functionalArea "site-content-and-ai-processing"
 * @businessRules ["Requires valid site authentication", "Transcript processing for business content", "Settings changes affect site-wide behavior"]
 * @performance "Supports pagination for large datasets, embedding operations may have latency"
 * @example
 * ```typescript
 * import { HTTPClient } from '@augur/api-client/core';
 * import { AgrSiteClient } from '@augur/api-client/services/agr-site';
 *
 * const http = new HTTPClient('agr-site', { siteId: 'your-site-id', bearerToken: 'your-token' });
 * const agrSite = new AgrSiteClient(http);
 *
 * // Manage site settings
 * const settings = await agrSite.settings.list();
 * const settingsData = await agrSite.settingsData.list();
 *
 * // Process AI transcripts
 * const transcript = await agrSite.fyxerTranscript.create({
 *   title: 'Business Meeting Notes',
 *   content: 'Discussion about project roadmap and priorities...',
 *   metadata: { tags: ['business', 'planning'] }
 * });
 *
 * // Generate search embeddings
 * const embedding = await agrSite.openSearch.embedding.get({
 *   text: 'Business strategy discussion for Q1 planning'
 * });
 *
 * // Create notifications
 * const notification = await agrSite.notifications.create({
 *   title: 'Crop Alert',
 *   message: 'New agricultural data available'
 * });
 * ```
 */
export declare class AgrSiteClient extends BaseServiceClient {
    /** Health check resource */
    readonly healthCheck: HealthCheckResource;
    /** Health check data resource (data-only) */
    readonly healthCheckData: HealthCheckDataResource;
    /** Settings management resource */
    readonly settings: SettingsResource;
    /** Settings data resource (data-only) */
    readonly settingsData: SettingsDataResource;
    /** Fyxer transcript resource */
    readonly fyxerTranscript: FyxerTranscriptResource;
    /** Fyxer transcript data resource (data-only) */
    readonly fyxerTranscriptData: FyxerTranscriptDataResource;
    /** OpenSearch resource */
    readonly openSearch: OpenSearchResource;
    /** OpenSearch data resource (data-only) */
    readonly openSearchData: OpenSearchDataResource;
    /** Meta files resource */
    readonly metaFiles: MetaFilesResource;
    /** Meta files data resource (data-only) */
    readonly metaFilesData: MetaFilesDataResource;
    /** Notifications resource */
    readonly notifications: NotificationsResource;
    /** Notifications data resource (data-only) */
    readonly notificationsData: NotificationsDataResource;
    /** Geo codes postal codes resource */
    readonly geoCodesPostalCodes: GeoCodesPostalCodesResource;
    /** Geo codes postal codes data resource (data-only) */
    readonly geoCodesPostalCodesData: GeoCodesPostalCodesDataResource;
    /** Training resource */
    readonly training: TrainingResource;
    /** Training data resource (data-only) */
    readonly trainingData: TrainingDataResource;
    /**
     * Create a new AgrSiteClient instance
     * @param http Configured HTTPClient instance with authentication
     * @param baseUrl Base URL for the AGR-Site API (default: https://agr-site.augur-api.com)
     */
    constructor(http: HTTPClient, baseUrl?: string);
}
//# sourceMappingURL=client.d.ts.map