testrail-modern-client/dist/client.d.ts

A modern TypeScript client for TestRail API

import { TestRailConfig } from './models/common';
import { AttachmentService } from './services/attachments';
import { BDDService } from './services/bdd';
import { CaseFieldService } from './services/case-fields';
import { CaseTypeService } from './services/case-types';
import { CaseService } from './services/cases';
import { ConfigurationService } from './services/configurations';
import { DatasetService } from './services/datasets';
import { GroupService } from './services/groups';
import { MilestoneService } from './services/milestones';
import { PlanService } from './services/plans';
import { PrioritiesService } from './services/priorities';
import { ProjectService } from './services/projects';
import { ReportService } from './services/reports';
import { ResultFieldService } from './services/result-fields';
import { ResultService } from './services/results';
import { RoleService } from './services/roles';
import { RunService } from './services/runs';
import { SectionService } from './services/sections';
import { SharedStepService } from './services/shared-steps';
import { StatusService } from './services/statuses';
import { SuiteService } from './services/suites';
import { TemplateService } from './services/templates';
import { TestService } from './services/tests';
import { UserService } from './services/users';
import { VariableService } from './services/variables';
export declare class TestRailError extends Error {
    constructor(message: string);
}
export declare class TestRailAPIError extends TestRailError {
    status: number;
    data?: Record<string, unknown>;
    constructor(message: string, status: number, data?: Record<string, unknown>);
}
export declare class TestRailRateLimitError extends TestRailError {
    retryAfter: number;
    constructor(retryAfter: number);
}
export declare class TestRailEnterpriseError extends TestRailError {
    constructor();
}
export declare class TestRailMaintenanceError extends TestRailError {
    constructor();
}
export declare class TestRailClient {
    private client;
    readonly projects: ProjectService;
    readonly cases: CaseService;
    readonly suites: SuiteService;
    readonly sections: SectionService;
    readonly runs: RunService;
    readonly results: ResultService;
    readonly resultFields: ResultFieldService;
    readonly roles: RoleService;
    readonly milestones: MilestoneService;
    readonly attachments: AttachmentService;
    readonly bdd: BDDService;
    readonly configurations: ConfigurationService;
    readonly datasets: DatasetService;
    readonly groups: GroupService;
    readonly priorities: PrioritiesService;
    readonly reports: ReportService;
    readonly sharedSteps: SharedStepService;
    readonly statuses: StatusService;
    readonly templates: TemplateService;
    readonly tests: TestService;
    readonly users: UserService;
    readonly variables: VariableService;
    readonly plans: PlanService;
    readonly caseFields: CaseFieldService;
    readonly caseTypes: CaseTypeService;
    constructor(config: TestRailConfig);
}