@simpleapps-com/augur-api
Version:
TypeScript client library for Augur microservices API endpoints
53 lines • 2.48 kB
TypeScript
import { BaseServiceClient } from '../../core/base-client';
import type { HTTPClient } from '../../core/client';
import { type HealthCheckResource, type HealthCheckDataResource, type PingResource, type HealthDataResource, type ContentResource, type ContentDataResource, type MenuResource, type MenuDataResource, type TagsResource, type TagsDataResource, type UsersResource, type UsersDataResource, type UserGroupsResource, type UserGroupsDataResource } from './resources';
/**
* Joomla API Client - OpenAPI Compliant
* @description Fully compliant client following OpenAPI Path Mirroring Pattern
* @example
* ```typescript
* import { HTTPClient } from '@augur/api-client/core';
* import { JoomlaClient } from '@augur/api-client/services/joomla';
*
* const http = new HTTPClient('joomla', { siteId: 'your-site-id', bearerToken: 'your-token' });
* const joomla = new JoomlaClient(http);
*
* // OpenAPI Path Mirroring: /content GET -> client.content.list()
* const content = await joomla.content.list({ limit: 10 });
*
* // OpenAPI Path Mirroring: /users/verify-password POST -> client.users.verifyPassword.create()
* const auth = await joomla.users.verifyPassword.create({ username: 'user', password: 'pass' });
* ```
*/
export declare class JoomlaClient extends BaseServiceClient {
/** Health check resource */
readonly healthCheck: HealthCheckResource;
/** Health check data resource (data-only) */
readonly healthCheckData: HealthCheckDataResource;
/** Ping resource */
readonly ping: PingResource;
/** Health data resource */
readonly healthData: HealthDataResource;
/** Content resource */
readonly content: ContentResource;
/** Content data resource (data-only) */
readonly contentData: ContentDataResource;
/** Menu resource */
readonly menu: MenuResource;
/** Menu data resource (data-only) */
readonly menuData: MenuDataResource;
/** Tags resource */
readonly tags: TagsResource;
/** Tags data resource (data-only) */
readonly tagsData: TagsDataResource;
/** Users resource */
readonly users: UsersResource;
/** Users data resource (data-only) */
readonly usersData: UsersDataResource;
/** User groups resource */
readonly userGroups: UserGroupsResource;
/** User groups data resource (data-only) */
readonly userGroupsData: UserGroupsDataResource;
constructor(http: HTTPClient, baseUrl?: string);
}
//# sourceMappingURL=client.d.ts.map