@simpleapps-com/augur-api/dist/esm/services/basecamp2/resources/todos-summary.d.ts

TypeScript client library for Augur microservices API endpoints

import { type TodoSummaryListParams, type TodoSummaryGetParams, type TodoSummaryResponse, type TodoSummaryListResponse } from '../schemas';
import type { Basecamp2Client } from '../client';
type ExecuteRequest = Basecamp2Client['executeRequest'];
/**
 * Creates the todosSummary resource methods
 * OpenAPI Path: /todos-summary → todosSummary.*
 * @description Methods for managing Basecamp2 todo summaries
 */
export declare function createTodosSummaryResource(executeRequest: ExecuteRequest): {
    /**
     * List all todo summaries with pagination and filtering
     *
     * @fullPath api.basecamp2.todosSummary.list
     * @service basecamp2
     * @domain project-management
     * @dataMethod todosSummaryData.list
     * @discoverable true
     * @searchTerms ["todos", "summary", "overview", "basecamp", "project stats"]
     *
     * @param params List parameters including pagination and filters
     * @returns Promise<TodoSummaryListResponse> Paginated list of todo summaries
     */
    list: (params: TodoSummaryListParams) => Promise<TodoSummaryListResponse>;
    /**
     * Get a specific todo summary by ID
     *
     * @fullPath api.basecamp2.todosSummary.get
     * @service basecamp2
     * @domain project-management
     * @dataMethod todosSummaryData.get
     * @discoverable true
     * @searchTerms ["todo", "summary", "get", "details", "basecamp"]
     *
     * @param id Todo Summary ID
     * @param params Request parameters with site ID
     * @returns Promise<TodoSummaryResponse> Todo summary details
     */
    get: (id: number, params: TodoSummaryGetParams) => Promise<TodoSummaryResponse>;
};
/**
 * Creates the todosSummaryData resource methods (data-only versions)
 */
export declare function createTodosSummaryDataResource(todosSummary: ReturnType<typeof createTodosSummaryResource>): {
    /**
     * List todo summaries data without full response metadata
     *
     * @fullPath api.basecamp2.todosSummaryData.list
     * @service basecamp2
     * @domain project-management
     * @discoverable true
     *
     * @param params List parameters
     * @returns Promise<TodoSummaryData[]> Array of todo summary data objects
     */
    list: (params: TodoSummaryListParams) => Promise<import("zod").objectOutputType<{
        id: import("zod").ZodNumber;
        title: import("zod").ZodOptional<import("zod").ZodString>;
        total_count: import("zod").ZodOptional<import("zod").ZodNumber>;
        completed_count: import("zod").ZodOptional<import("zod").ZodNumber>;
        pending_count: import("zod").ZodOptional<import("zod").ZodNumber>;
        akasha_cd: import("zod").ZodOptional<import("zod").ZodNumber>;
        process_cd: import("zod").ZodOptional<import("zod").ZodNumber>;
        created_at: import("zod").ZodOptional<import("zod").ZodString>;
        updated_at: import("zod").ZodOptional<import("zod").ZodString>;
    }, import("zod").ZodTypeAny, "passthrough">[]>;
    /**
     * Get todo summary data without full response metadata
     *
     * @fullPath api.basecamp2.todosSummaryData.get
     * @service basecamp2
     * @domain project-management
     * @discoverable true
     *
     * @param id Todo Summary ID
     * @param params Request parameters
     * @returns Promise<TodoSummaryData> Todo summary data object
     */
    get: (id: number, params: TodoSummaryGetParams) => Promise<{
        id: number;
        title?: string | undefined;
        created_at?: string | undefined;
        updated_at?: string | undefined;
        total_count?: number | undefined;
        completed_count?: number | undefined;
        pending_count?: number | undefined;
        akasha_cd?: number | undefined;
        process_cd?: number | undefined;
    } & {
        [k: string]: unknown;
    }>;
};
export type TodosSummaryResource = ReturnType<typeof createTodosSummaryResource>;
export type TodosSummaryDataResource = ReturnType<typeof createTodosSummaryDataResource>;
export {};
//# sourceMappingURL=todos-summary.d.ts.map