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

A modern TypeScript client for TestRail API

import { AddSection, MoveSection, Section, UpdateSection } from '../models/sections';
import { BaseService } from './base';
/**
 * Service for managing TestRail sections.
 */
export declare class SectionService extends BaseService {
    /**
     * Returns a list of sections for a project and test suite.
     * @param projectId - The ID of the project
     * @param suiteId - The ID of the test suite (optional if the project is operating in single suite mode)
     * @param offset - Where to start counting the sections from (the offset)
     * @param limit - The number of sections the response should return (max 250)
     * @returns A list of sections
     * @throws {Error} 400 - Invalid or unknown project or test suite
     * @throws {Error} 403 - No access to the project
     * @throws {Error} 429 - Too many requests (TestRail Cloud only)
     */
    list(projectId: number, suiteId?: number, offset?: number, limit?: number): Promise<Section[]>;
    /**
     * Returns an existing section.
     * @param sectionId - The ID of the section
     * @returns The section
     * @throws {Error} 400 - Invalid or unknown section
     * @throws {Error} 403 - No access to the project
     * @throws {Error} 429 - Too many requests (TestRail Cloud only)
     */
    get(sectionId: number): Promise<Section>;
    /**
     * Creates a new section.
     * @param projectId - The ID of the project
     * @param section - The section data to add
     * @returns The created section
     * @throws {Error} 400 - Invalid or unknown project or test suite
     * @throws {Error} 403 - No permissions to add sections or no access to the project
     * @throws {Error} 429 - Too many requests (TestRail Cloud only)
     */
    add(projectId: number, section: AddSection): Promise<Section>;
    /**
     * Updates an existing section (partial updates are supported).
     * @param sectionId - The ID of the section
     * @param section - The section data to update
     * @returns The updated section
     * @throws {Error} 400 - Invalid or unknown section
     * @throws {Error} 403 - No permissions to modify sections or no access to the project
     * @throws {Error} 429 - Too many requests (TestRail Cloud only)
     */
    update(sectionId: number, section: UpdateSection): Promise<Section>;
    /**
     * Moves a section to another suite or section.
     * @param sectionId - The ID of the section
     * @param moveData - The move operation data
     * @returns The moved section
     * @throws {Error} 400 - Invalid or unknown section_id, parent_id, or after_id
     * @throws {Error} 403 - No permissions to add sections or no access to the project
     * @throws {Error} 429 - Too many requests (TestRail Cloud only)
     * @since TestRail 6.5.2
     */
    move(sectionId: number, moveData: MoveSection): Promise<Section>;
    /**
     * Deletes an existing section.
     * Note: Deleting a section cannot be undone and also deletes all related test cases as well as active tests & results.
     * @param sectionId - The ID of the section
     * @param soft - If true, only returns data about affected items without actually deleting
     * @throws {Error} 400 - Invalid or unknown section
     * @throws {Error} 403 - No permissions to delete sections or test cases or no access to the project
     * @throws {Error} 429 - Too many requests (TestRail Cloud only)
     */
    delete(sectionId: number, soft?: boolean): Promise<void>;
}