@simpleapps-com/augur-api
Version:
TypeScript client library for Augur microservices API endpoints
56 lines • 2.25 kB
TypeScript
import type { JoomlaClient } from '../client';
import type { ContentParams, ContentResponse, ContentIdParams, ContentIdResponse, ContentIdDocParams, ContentIdDocResponse } from '../schemas';
type ExecuteRequest = JoomlaClient['executeRequest'];
/**
* Creates the content resource methods
* OpenAPI Path: /content → content.*
* @description Content management operations
*/
export declare function createContentResource(executeRequest: ExecuteRequest): {
/**
* List content items - /content GET
* @fullPath api.joomla.content.list
* @service joomla
* @domain content-management
* @dataMethod contentData.list
* @discoverable true
*/
list: (params?: ContentParams) => Promise<ContentResponse>;
/**
* Get content by ID - /content/{id} GET
* @fullPath api.joomla.content.get
* @service joomla
* @domain content-management
* @dataMethod contentData.get
* @discoverable true
*/
get: (contentId: number | string, params?: ContentIdParams) => Promise<ContentIdResponse>;
/**
* Content document endpoints - /content/{id}/doc
*/
doc: {
/**
* Get content document - /content/{id}/doc GET
* @fullPath api.joomla.content.doc.get
* @service joomla
* @domain content-management
* @dataMethod contentData.doc.get
* @discoverable true
*/
get: (contentId: number | string, params?: ContentIdDocParams) => Promise<ContentIdDocResponse>;
};
};
/**
* Creates the contentData resource methods (data-only versions)
*/
export declare function createContentDataResource(content: ReturnType<typeof createContentResource>): {
list: (params?: ContentParams) => Promise<import("zod").objectOutputType<{}, import("zod").ZodTypeAny, "passthrough">[]>;
get: (contentId: number | string, params?: ContentIdParams) => Promise<Record<string, unknown>>;
doc: {
get: (contentId: number | string, params?: ContentIdDocParams) => Promise<Record<string, unknown>>;
};
};
export type ContentResource = ReturnType<typeof createContentResource>;
export type ContentDataResource = ReturnType<typeof createContentDataResource>;
export {};
//# sourceMappingURL=content.d.ts.map