@simpleapps-com/augur-api
Version:
TypeScript client library for Augur microservices API endpoints
64 lines • 2.73 kB
TypeScript
import type { AgrInfoClient } from '../client';
import type { JoomlaGenerateParams } from '../schemas';
type ExecuteRequest = AgrInfoClient['executeRequest'];
/**
* Creates the joomla resource methods
* OpenAPI Path: /joomla → joomla.*
* @description Joomla AI generation endpoints
*/
export declare function createJoomlaResource(executeRequest: ExecuteRequest): {
/**
* Generate operations
*/
generate: {
/**
* Generate AI response using Joomla model
*
* @fullPath api.agrInfo.joomla.generate.create
* @service agr-info
* @domain ai-content-generation
* @dataMethod joomlaData.generate.create
* @discoverable true
* @searchTerms ["joomla", "generate", "ai", "content", "response", "model"]
* @relatedEndpoints ["api.agrInfo.akasha.generate.create", "api.agrInfo.ollama.tags.list", "api.joomla.content.list"]
* @commonPatterns ["Generate Joomla content", "AI content for CMS", "Joomla AI integration"]
* @workflow ["content-generation", "cms-integration", "ai-processing"]
* @prerequisites ["Valid authentication", "Joomla model availability"]
* @nextSteps ["Integrate with Joomla CMS", "Publish generated content"]
* @businessRules ["Requires public bearer token", "Content should be Joomla-compatible"]
* @functionalArea "ai-content-generation"
* @caching "No caching - dynamic AI responses"
* @performance "Variable response time based on AI processing"
*
* @param params Optional generation parameters
* @returns Promise<JoomlaGenerateResponse> Generated Joomla-compatible content
*/
create: (params?: JoomlaGenerateParams) => Promise<{
params: Record<string, unknown> | unknown[];
data: string;
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
}>;
};
};
/**
* Creates the joomlaData resource methods (data-only versions)
*/
export declare function createJoomlaDataResource(joomla: ReturnType<typeof createJoomlaResource>): {
generate: {
/**
* Get generated Joomla AI response data only
* @param params Optional generation parameters
* @returns Promise<string> Generated Joomla content
*/
create: (params?: JoomlaGenerateParams) => Promise<string>;
};
};
export type JoomlaResource = ReturnType<typeof createJoomlaResource>;
export type JoomlaDataResource = ReturnType<typeof createJoomlaDataResource>;
export {};
//# sourceMappingURL=joomla.d.ts.map