@simpleapps-com/augur-api/dist/cjs/services/agr-site/resources/meta-files.d.ts

TypeScript client library for Augur microservices API endpoints

import type { BaseResponse } from '../../../core/base-client';
import type { AgrSiteClient } from '../client';
type ExecuteRequest = AgrSiteClient['executeRequest'];
/**
 * Creates the metaFiles resource methods
 * OpenAPI Path: /meta-files → metaFiles.*
 * @description Site metadata and SEO file management for agricultural content discovery
 */
export declare function createMetaFilesResource(executeRequest: ExecuteRequest): {
    /**
     * Robots.txt file operations
     */
    robots: {
        /**
         * Get robots.txt configuration for search engine crawling
         * @description Retrieves the robots.txt file configuration for controlling search engine access to agricultural content
         * @fullPath api.agrSite.metaFiles.robots.get
         * @service agr-site
         * @domain seo-management
         * @dataMethod metaFilesData.robots.get - returns only the robots.txt content without metadata
         * @discoverable true
         * @searchTerms ["robots.txt", "SEO", "search engine optimization", "crawler configuration", "site meta", "web crawling"]
         * @relatedEndpoints ["api.agrSite.settings.list", "api.agrSite.fyxerTranscript.list"]
         * @commonPatterns ["Get SEO configuration", "Retrieve crawler rules", "Access robots.txt", "Site metadata management"]
         * @workflow ["seo-management", "site-configuration", "search-optimization"]
         * @prerequisites ["Valid authentication token", "Meta files access permissions"]
         * @nextSteps ["Configure SEO settings", "Update crawler permissions"]
         * @businessRules ["Controls agricultural content visibility", "Respects SEO best practices", "Configurable per site"]
         * @functionalArea "site-content-and-ai-processing"
         * @caching "Cache for 1 hour, invalidate on SEO configuration changes"
         * @performance "Static file retrieval, very fast response"
         * @returns Promise<BaseResponse<unknown>> Complete response with robots.txt content and configuration
         * @example
         * ```typescript
         * const robotsConfig = await client.metaFiles.robots.get();
         * const robotsData = await client.metaFilesData.robots.get();
         * ```
         */
        get: () => Promise<BaseResponse<unknown>>;
    };
};
/**
 * Creates the metaFilesData resource methods (data-only versions)
 */
export declare function createMetaFilesDataResource(metaFiles: ReturnType<typeof createMetaFilesResource>): {
    robots: {
        /**
         * Get robots.txt data without response metadata
         * @returns Promise<unknown> Robots.txt content directly
         */
        get: () => Promise<unknown>;
    };
};
export type MetaFilesResource = ReturnType<typeof createMetaFilesResource>;
export type MetaFilesDataResource = ReturnType<typeof createMetaFilesDataResource>;
export {};
//# sourceMappingURL=meta-files.d.ts.map