@blue-impact-engine/blue-impact-engine-client
Version:
Blue Impact Engine API Client
40 lines • 1.54 kB
TypeScript
/**
* Project service for handling project-related operations
* @packageDocumentation
*/
import { HttpClient } from '../../core/http-client';
import ProjectEntity from './Project';
import { ApiResponse, PaginatedResponse, QueryParams, RequestOptions } from '../../core/types';
import ProjectStatus from './ProjectStatus';
/**
* Project Service
* Handles all project-related API operations and business logic
*/
export declare class ProjectService {
private httpClient;
private baseEndpoint;
constructor(httpClient: HttpClient);
/**
* Get all projects with optional filtering and pagination
* @param params - Query parameters for filtering, sorting, and pagination
* @param options - Request options
* @returns Promise<PaginatedResponse<Project>>
*/
getAll(params?: QueryParams, options?: RequestOptions): Promise<PaginatedResponse<ProjectEntity>>;
/**
* Get a project by ID
* @param id - Project ID
* @param options - Request options
* @returns Promise<ApiResponse<Project>>
*/
getById(id: string, options?: RequestOptions): Promise<ApiResponse<ProjectEntity>>;
/**
* Get projects by status
* @param status - Project status
* @param params - Query parameters
* @param options - Request options
* @returns Promise<PaginatedResponse<Project>>
*/
getByStatus(status: ProjectStatus, params?: QueryParams, options?: RequestOptions): Promise<PaginatedResponse<ProjectEntity>>;
}
//# sourceMappingURL=project.service.d.ts.map