@simpleapps-com/augur-api/dist/types/services/basecamp2/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 TodosResource, type TodosDataResource, type TodosSummaryResource, type TodosSummaryDataResource } from './resources';
/**
 * Basecamp2 Integration Service Client
 *
 * Provides access to Basecamp2 todos and todo summaries for project management
 * integration. Supports listing, filtering, and retrieving todo items and their
 * aggregated summaries.
 *
 * @service basecamp2
 * @domain project-management
 *
 * @example
 * ```typescript
 * const client = new Basecamp2Client(httpClient);
 *
 * // List todos with pagination
 * const todos = await client.todos.list({
 *   'x-site-id': 'SITE123',
 *   limit: 10,
 *   offset: 0
 * });
 *
 * // Get a specific todo
 * const todo = await client.todos.get(123, { 'x-site-id': 'SITE123' });
 *
 * // List todo summaries with filters
 * const summaries = await client.todosSummary.list({
 *   'x-site-id': 'SITE123',
 *   processCd: 1
 * });
 * ```
 */
export declare class Basecamp2Client extends BaseServiceClient {
    /** Health check resource */
    readonly healthCheck: HealthCheckResource;
    /** Health check data resource (data-only) */
    readonly healthCheckData: HealthCheckDataResource;
    /** Todos resource */
    readonly todos: TodosResource;
    /** Todos data resource (data-only) */
    readonly todosData: TodosDataResource;
    /** Todos summary resource */
    readonly todosSummary: TodosSummaryResource;
    /** Todos summary data resource (data-only) */
    readonly todosSummaryData: TodosSummaryDataResource;
    /**
     * Create a new Basecamp2Client instance
     * @param http Configured HTTPClient instance
     * @param baseUrl Base URL for the Basecamp2 API (default: https://basecamp2.augur-api.com)
     */
    constructor(http: HTTPClient, baseUrl?: string);
    protected getServiceDescription(): string;
}
//# sourceMappingURL=client.d.ts.map