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

A modern TypeScript client for TestRail API

import { BDDTestCase } from '../models/bdd';
import { BaseService } from './base';
/**
 * Service for managing BDD scenarios in TestRail
 */
export declare class BDDService extends BaseService {
    /**
     * Exports a BDD scenario from a test case as a .feature file
     * @param caseId - The ID of the test case
     * @returns The feature file content
     * @throws {Error} 400 - Invalid or unknown test case
     * @throws {Error} 500 - An error occurred during export
     */
    get(caseId: number): Promise<string>;
    /**
     * Imports/uploads a BDD scenario from a test case as a .feature file
     * @param sectionId - The ID of the section to add the BDD scenario to
     * @param featureContent - The content of the feature file
     * @returns The created test case with BDD scenario
     * @throws {Error} 400 - Invalid or unknown section
     * @throws {Error} 403 - Insufficient permissions (cannot access project)
     * @throws {Error} 500 - An error occurred during import
     */
    add(sectionId: number, featureContent: string): Promise<BDDTestCase>;
}