@dichovsky/testrail-api-client 1.0.0

package/dist/client.d.ts

@@ -0,0 +1,652 @@
+import type { Case, Suite, Section, Project, Plan, Run, Test, Result, Milestone, User, Status, Priority, AddCasePayload, UpdateCasePayload, AddSuitePayload, UpdateSuitePayload, AddPlanPayload, UpdatePlanPayload, AddPlanEntryPayload, UpdatePlanEntryPayload, PlanEntry, AddRunPayload, UpdateRunPayload, AddResultPayload, AddResultsForCasesPayload, AddSectionPayload, UpdateSectionPayload, AddMilestonePayload, UpdateMilestonePayload, AddProjectPayload, UpdateProjectPayload, GetPlansOptions, GetTestsOptions, GetResultsOptions, GetMilestonesOptions, GetRunsOptions, GetCasesOptions, ResultField, CaseField, CaseType, Template, ConfigurationGroup, Configuration, AddConfigurationGroupPayload, UpdateConfigurationGroupPayload, AddConfigurationPayload, UpdateConfigurationPayload, AddUserPayload, UpdateUserPayload, Role, Group, AddGroupPayload, UpdateGroupPayload, Attachment, SharedStep, AddSharedStepPayload, UpdateSharedStepPayload, Variable, AddVariablePayload, UpdateVariablePayload, Dataset, AddDatasetPayload, UpdateDatasetPayload, Report, ReportResult } from './types.js';
+import { TestRailClientCore } from './client-core.js';
+export { TestRailApiError, TestRailValidationError } from './errors.js';
+/**
+ * TestRail API Client
+ *
+ * Type-safe client covering Projects, Suites, Sections, Cases, Plans, Runs,
+ * Tests, Results, Milestones, Users, Statuses, and Priorities.
+ * Extends {@link TestRailClientCore} for HTTP pipeline, caching, rate limiting, and retry.
+ */
+export declare class TestRailClient extends TestRailClientCore {
+    /**
+     * Get a project by ID.
+     * @throws {TestRailValidationError} When projectId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    getProject(projectId: number): Promise<Project>;
+    /**
+     * Get all projects.
+     * @throws {TestRailValidationError} When limit or offset is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    getProjects(limit?: number, offset?: number): Promise<Project[]>;
+    /**
+     * Add a new project.
+     * @throws {TestRailApiError} When the API request fails
+     */
+    addProject(payload: AddProjectPayload): Promise<Project>;
+    /**
+     * Update an existing project.
+     * @throws {TestRailValidationError} When projectId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    updateProject(projectId: number, payload: UpdateProjectPayload): Promise<Project>;
+    /**
+     * Delete a project.
+     * @throws {TestRailValidationError} When projectId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    deleteProject(projectId: number): Promise<void>;
+    /**
+     * Get a suite by ID.
+     * @throws {TestRailValidationError} When suiteId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    getSuite(suiteId: number): Promise<Suite>;
+    /**
+     * Get all suites for a project.
+     * @throws {TestRailValidationError} When projectId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    getSuites(projectId: number): Promise<Suite[]>;
+    /**
+     * Add a suite to a project.
+     * @throws {TestRailValidationError} When projectId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    addSuite(projectId: number, payload: AddSuitePayload): Promise<Suite>;
+    /**
+     * Update a suite.
+     * @throws {TestRailValidationError} When suiteId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    updateSuite(suiteId: number, payload: UpdateSuitePayload): Promise<Suite>;
+    /**
+     * Delete a suite.
+     * @throws {TestRailValidationError} When suiteId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    deleteSuite(suiteId: number): Promise<void>;
+    /**
+     * Get a section by ID.
+     * @throws {TestRailValidationError} When sectionId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    getSection(sectionId: number): Promise<Section>;
+    /**
+     * Get all sections for a project, optionally filtered by suite.
+     * @param options.suiteId - Optional suite filter
+     * @param options.limit - Optional maximum number of results to return
+     * @param options.offset - Optional number of results to skip
+     * @throws {TestRailValidationError} When projectId or suiteId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    getSections(projectId: number, options?: {
+        suiteId?: number;
+        limit?: number;
+        offset?: number;
+    }): Promise<Section[]>;
+    /**
+     * Add a new section to a project.
+     * @throws {TestRailValidationError} When projectId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    addSection(projectId: number, payload: AddSectionPayload): Promise<Section>;
+    /**
+     * Update an existing section.
+     * @throws {TestRailValidationError} When sectionId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    updateSection(sectionId: number, payload: UpdateSectionPayload): Promise<Section>;
+    /**
+     * Delete a section.
+     * @throws {TestRailValidationError} When sectionId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    deleteSection(sectionId: number): Promise<void>;
+    /**
+     * Get a case by ID.
+     * @throws {TestRailValidationError} When caseId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    getCase(caseId: number): Promise<Case>;
+    /**
+     * Get all cases for a project with optional filters.
+     * @param options.suiteId - Return only cases in this suite
+     * @param options.sectionId - Return only cases in this section
+     * @param options.typeId - Return only cases of this type
+     * @param options.priorityId - Return only cases with this priority
+     * @param options.templateId - Return only cases using this template
+     * @param options.milestoneId - Return only cases linked to this milestone
+     * @param options.createdAfter - Return only cases created after this Unix timestamp
+     * @param options.createdBefore - Return only cases created before this Unix timestamp
+     * @param options.updatedAfter - Return only cases updated after this Unix timestamp
+     * @param options.updatedBefore - Return only cases updated before this Unix timestamp
+     * @param options.limit - Maximum number of cases to return
+     * @param options.offset - Pagination offset
+     * @throws {TestRailValidationError} When any provided ID is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    getCases(projectId: number, options?: GetCasesOptions): Promise<Case[]>;
+    /**
+     * Add a new case to a section.
+     * @throws {TestRailValidationError} When sectionId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    addCase(sectionId: number, payload: AddCasePayload): Promise<Case>;
+    /**
+     * Update an existing case.
+     * @throws {TestRailValidationError} When caseId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    updateCase(caseId: number, payload: UpdateCasePayload): Promise<Case>;
+    /**
+     * Delete a case.
+     * @throws {TestRailValidationError} When caseId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    deleteCase(caseId: number): Promise<void>;
+    /**
+     * Get a plan by ID.
+     * @throws {TestRailValidationError} When planId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    getPlan(planId: number): Promise<Plan>;
+    /**
+     * Get all plans for a project with optional filters.
+     * @param projectId - The project ID
+     * @param options - Optional filter parameters (created_after, created_before, created_by,
+     *   is_completed, milestone_id, limit, offset)
+     * @throws {TestRailValidationError} When projectId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    getPlans(projectId: number, options?: GetPlansOptions): Promise<Plan[]>;
+    /**
+     * Add a new plan to a project.
+     * @throws {TestRailValidationError} When projectId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    addPlan(projectId: number, payload: AddPlanPayload): Promise<Plan>;
+    /**
+     * Update a plan.
+     * @throws {TestRailValidationError} When planId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    updatePlan(planId: number, payload: UpdatePlanPayload): Promise<Plan>;
+    /**
+     * Close a plan.
+     * @throws {TestRailValidationError} When planId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    closePlan(planId: number): Promise<Plan>;
+    /**
+     * Delete a plan.
+     * @throws {TestRailValidationError} When planId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    deletePlan(planId: number): Promise<void>;
+    /**
+     * Add a plan entry (run) to a plan.
+     * @throws {TestRailValidationError} When planId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    addPlanEntry(planId: number, payload: AddPlanEntryPayload): Promise<PlanEntry>;
+    /**
+     * Update an existing plan entry.
+     * @throws {TestRailValidationError} When planId is invalid or entryId is not a non-empty string
+     * @throws {TestRailApiError} When the API request fails
+     */
+    updatePlanEntry(planId: number, entryId: string, payload: UpdatePlanEntryPayload): Promise<PlanEntry>;
+    /**
+     * Delete a plan entry.
+     * @throws {TestRailValidationError} When planId is invalid or entryId is not a non-empty string
+     * @throws {TestRailApiError} When the API request fails
+     */
+    deletePlanEntry(planId: number, entryId: string): Promise<void>;
+    /**
+     * Get a run by ID.
+     * @throws {TestRailValidationError} When runId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    getRun(runId: number): Promise<Run>;
+    /**
+     * Get all runs for a project, with optional filters.
+     * @param projectId - The project ID
+     * @param options - Optional filters: createdAfter, createdBefore, createdBy, isCompleted,
+     *   milestoneId, refsFilter, suiteId, limit, offset
+     * @throws {TestRailValidationError} When projectId or pagination params are invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    getRuns(projectId: number, options?: GetRunsOptions): Promise<Run[]>;
+    /**
+     * Add a new run to a project.
+     * @throws {TestRailValidationError} When projectId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    addRun(projectId: number, payload: AddRunPayload): Promise<Run>;
+    /**
+     * Update a run.
+     * @throws {TestRailValidationError} When runId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    updateRun(runId: number, payload: UpdateRunPayload): Promise<Run>;
+    /**
+     * Close a run.
+     * @throws {TestRailValidationError} When runId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    closeRun(runId: number): Promise<Run>;
+    /**
+     * Delete a run.
+     * @throws {TestRailValidationError} When runId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    deleteRun(runId: number): Promise<void>;
+    /**
+     * Get a test by ID.
+     * @throws {TestRailValidationError} When testId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    getTest(testId: number): Promise<Test>;
+    /**
+     * Get all tests for a run with optional filters.
+     * @param runId - The run ID
+     * @param options - Optional filter parameters (status_id, limit, offset)
+     * @throws {TestRailValidationError} When runId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    getTests(runId: number, options?: GetTestsOptions): Promise<Test[]>;
+    /**
+     * Get results for a test with optional filters.
+     * @param testId - The test ID
+     * @param options - Optional filter parameters (created_after, created_before, created_by,
+     *   status_id, limit, offset)
+     * @throws {TestRailValidationError} When testId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    getResults(testId: number, options?: GetResultsOptions): Promise<Result[]>;
+    /**
+     * Get results for a specific case within a run with optional filters.
+     * @param runId - The run ID
+     * @param caseId - The case ID
+     * @param options - Optional filter parameters (created_after, created_before, created_by,
+     *   status_id, limit, offset)
+     * @throws {TestRailValidationError} When runId or caseId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    getResultsForCase(runId: number, caseId: number, options?: GetResultsOptions): Promise<Result[]>;
+    /**
+     * Get all results for a run with optional filters.
+     * @param runId - The run ID
+     * @param options - Optional filter parameters (created_after, created_before, created_by,
+     *   status_id, limit, offset)
+     * @throws {TestRailValidationError} When runId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    getResultsForRun(runId: number, options?: GetResultsOptions): Promise<Result[]>;
+    /**
+     * Add a result for a test.
+     * @throws {TestRailValidationError} When testId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    addResult(testId: number, payload: AddResultPayload): Promise<Result>;
+    /**
+     * Add a result for a specific case within a run.
+     * @throws {TestRailValidationError} When runId or caseId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    addResultForCase(runId: number, caseId: number, payload: AddResultPayload): Promise<Result>;
+    /**
+     * Add multiple results for cases in a run.
+     * @throws {TestRailValidationError} When runId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    addResultsForCases(runId: number, payload: AddResultsForCasesPayload): Promise<Result[]>;
+    /**
+     * Get a milestone by ID.
+     * @throws {TestRailValidationError} When milestoneId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    getMilestone(milestoneId: number): Promise<Milestone>;
+    /**
+     * Get all milestones for a project with optional filters.
+     * @param projectId - The project ID
+     * @param options - Optional filter parameters (is_completed, limit, offset)
+     * @throws {TestRailValidationError} When projectId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    getMilestones(projectId: number, options?: GetMilestonesOptions): Promise<Milestone[]>;
+    /**
+     * Add a new milestone to a project.
+     * @throws {TestRailValidationError} When projectId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    addMilestone(projectId: number, payload: AddMilestonePayload): Promise<Milestone>;
+    /**
+     * Update an existing milestone.
+     * @throws {TestRailValidationError} When milestoneId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    updateMilestone(milestoneId: number, payload: UpdateMilestonePayload): Promise<Milestone>;
+    /**
+     * Delete a milestone.
+     * @throws {TestRailValidationError} When milestoneId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    deleteMilestone(milestoneId: number): Promise<void>;
+    /**
+     * Get a user by ID.
+     * @throws {TestRailValidationError} When userId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    getUser(userId: number): Promise<User>;
+    /**
+     * Get a user by email address.
+     * @throws {TestRailValidationError} When email format is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    getUserByEmail(email: string): Promise<User>;
+    /**
+     * Get all users, optionally scoped to a project.
+     * @param limit - Maximum number of users to return
+     * @param offset - Number of users to skip
+     * @param projectId - When provided, returns only users with access to the specified project
+     * @throws {TestRailValidationError} When pagination or projectId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    getUsers(limit?: number, offset?: number, projectId?: number): Promise<User[]>;
+    /**
+     * Get the currently authenticated user.
+     * @throws {TestRailApiError} When the API request fails
+     */
+    getCurrentUser(): Promise<User>;
+    /**
+     * Get all test statuses.
+     * @throws {TestRailApiError} When the API request fails
+     */
+    getStatuses(): Promise<Status[]>;
+    /**
+     * Get all case priorities.
+     * @throws {TestRailApiError} When the API request fails
+     */
+    getPriorities(): Promise<Priority[]>;
+    /**
+     * Get all available custom result fields.
+     * @throws {TestRailApiError} When the API request fails
+     */
+    getResultFields(): Promise<ResultField[]>;
+    /**
+     * Get all available custom case fields.
+     * @throws {TestRailApiError} When the API request fails
+     */
+    getCaseFields(): Promise<CaseField[]>;
+    /**
+     * Get all available case types.
+     * @throws {TestRailApiError} When the API request fails
+     */
+    getCaseTypes(): Promise<CaseType[]>;
+    /**
+     * Get all available case templates for a project (requires TestRail 5.2+).
+     * @throws {TestRailValidationError} When projectId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    getTemplates(projectId: number): Promise<Template[]>;
+    /**
+     * Get all configuration groups and their configurations for a project.
+     * @throws {TestRailValidationError} When projectId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    getConfigurations(projectId: number): Promise<ConfigurationGroup[]>;
+    /**
+     * Add a new configuration group to a project.
+     * @throws {TestRailValidationError} When projectId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    addConfigurationGroup(projectId: number, payload: AddConfigurationGroupPayload): Promise<ConfigurationGroup>;
+    /**
+     * Update an existing configuration group.
+     * @throws {TestRailValidationError} When configGroupId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    updateConfigurationGroup(configGroupId: number, payload: UpdateConfigurationGroupPayload): Promise<ConfigurationGroup>;
+    /**
+     * Delete an existing configuration group and all its configurations.
+     * @throws {TestRailValidationError} When configGroupId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    deleteConfigurationGroup(configGroupId: number): Promise<void>;
+    /**
+     * Add a new configuration to a configuration group.
+     * @throws {TestRailValidationError} When configGroupId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    addConfiguration(configGroupId: number, payload: AddConfigurationPayload): Promise<Configuration>;
+    /**
+     * Update an existing configuration.
+     * @throws {TestRailValidationError} When configId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    updateConfiguration(configId: number, payload: UpdateConfigurationPayload): Promise<Configuration>;
+    /**
+     * Delete an existing configuration.
+     * @throws {TestRailValidationError} When configId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    deleteConfiguration(configId: number): Promise<void>;
+    /**
+     * Create a new TestRail user (requires TestRail 7.3+).
+     * @throws {TestRailApiError} When the API request fails
+     */
+    addUser(payload: AddUserPayload): Promise<User>;
+    /**
+     * Update an existing TestRail user (requires TestRail 7.3+).
+     * @throws {TestRailValidationError} When userId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    updateUser(userId: number, payload: UpdateUserPayload): Promise<User>;
+    /**
+     * Get all available user roles (requires TestRail 7.3+).
+     * @throws {TestRailApiError} When the API request fails
+     */
+    getRoles(): Promise<Role[]>;
+    /**
+     * Get a single group by ID (requires TestRail 7.5+).
+     * @throws {TestRailValidationError} When groupId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    getGroup(groupId: number): Promise<Group>;
+    /**
+     * Get all groups (requires TestRail 7.5+).
+     * @throws {TestRailApiError} When the API request fails
+     */
+    getGroups(): Promise<Group[]>;
+    /**
+     * Create a new group (requires TestRail 7.5+).
+     * @throws {TestRailApiError} When the API request fails
+     */
+    addGroup(payload: AddGroupPayload): Promise<Group>;
+    /**
+     * Update an existing group (requires TestRail 7.5+).
+     * @throws {TestRailValidationError} When groupId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    updateGroup(groupId: number, payload: UpdateGroupPayload): Promise<Group>;
+    /**
+     * Delete a group (requires TestRail 7.5+).
+     * @throws {TestRailValidationError} When groupId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    deleteGroup(groupId: number): Promise<void>;
+    /**
+     * Get all attachments for a test case.
+     * @throws {TestRailValidationError} When caseId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    getAttachmentsForCase(caseId: number): Promise<Attachment[]>;
+    /**
+     * Get all attachments for a test run.
+     * @throws {TestRailValidationError} When runId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    getAttachmentsForRun(runId: number): Promise<Attachment[]>;
+    /**
+     * Get all attachments for a test.
+     * @throws {TestRailValidationError} When testId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    getAttachmentsForTest(testId: number): Promise<Attachment[]>;
+    /**
+     * Get all attachments for a test plan.
+     * @throws {TestRailValidationError} When planId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    getAttachmentsForPlan(planId: number): Promise<Attachment[]>;
+    /**
+     * Get all attachments for a specific plan entry.
+     * @throws {TestRailValidationError} When planId or entryId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    getAttachmentsForPlanEntry(planId: number, entryId: number): Promise<Attachment[]>;
+    /**
+     * Download the raw binary content of an attachment.
+     * @param attachmentId - The attachment ID (numeric)
+     * @throws {TestRailValidationError} When attachmentId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    getAttachment(attachmentId: number): Promise<ArrayBuffer>;
+    /**
+     * Upload a file attachment to a test case.
+     * @throws {TestRailValidationError} When caseId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    addAttachmentToCase(caseId: number, file: globalThis.Blob | Uint8Array | globalThis.File, filename: string): Promise<Attachment>;
+    /**
+     * Upload a file attachment to a test result.
+     * @throws {TestRailValidationError} When resultId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    addAttachmentToResult(resultId: number, file: globalThis.Blob | Uint8Array | globalThis.File, filename: string): Promise<Attachment>;
+    /**
+     * Upload a file attachment to a test run.
+     * @throws {TestRailValidationError} When runId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    addAttachmentToRun(runId: number, file: globalThis.Blob | Uint8Array | globalThis.File, filename: string): Promise<Attachment>;
+    /**
+     * Upload a file attachment to a test plan (requires TestRail 6.5.2+).
+     * @throws {TestRailValidationError} When planId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    addAttachmentToPlan(planId: number, file: globalThis.Blob | Uint8Array | globalThis.File, filename: string): Promise<Attachment>;
+    /**
+     * Upload a file attachment to a specific plan entry (requires TestRail 6.5.2+).
+     * @throws {TestRailValidationError} When planId or entryId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    addAttachmentToPlanEntry(planId: number, entryId: number, file: globalThis.Blob | Uint8Array | globalThis.File, filename: string): Promise<Attachment>;
+    /**
+     * Delete an attachment by ID.
+     * @throws {TestRailValidationError} When attachmentId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    deleteAttachment(attachmentId: number): Promise<void>;
+    /**
+     * Get a single shared step by ID (requires TestRail 7.0+).
+     * @throws {TestRailValidationError} When sharedStepId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    getSharedStep(sharedStepId: number): Promise<SharedStep>;
+    /**
+     * Get all shared steps for a project (requires TestRail 7.0+).
+     * @throws {TestRailValidationError} When projectId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    getSharedSteps(projectId: number): Promise<SharedStep[]>;
+    /**
+     * Create a new shared step in a project (requires TestRail 7.0+).
+     * @throws {TestRailValidationError} When projectId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    addSharedStep(projectId: number, payload: AddSharedStepPayload): Promise<SharedStep>;
+    /**
+     * Update an existing shared step (requires TestRail 7.0+).
+     * @throws {TestRailValidationError} When sharedStepId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    updateSharedStep(sharedStepId: number, payload: UpdateSharedStepPayload): Promise<SharedStep>;
+    /**
+     * Delete a shared step (requires TestRail 7.0+).
+     * @throws {TestRailValidationError} When sharedStepId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    deleteSharedStep(sharedStepId: number): Promise<void>;
+    /**
+     * Get all variables for a project.
+     * @throws {TestRailValidationError} When projectId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    getVariables(projectId: number): Promise<Variable[]>;
+    /**
+     * Create a new variable in a project.
+     * @throws {TestRailValidationError} When projectId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    addVariable(projectId: number, payload: AddVariablePayload): Promise<Variable>;
+    /**
+     * Update an existing variable.
+     * @throws {TestRailValidationError} When variableId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    updateVariable(variableId: number, payload: UpdateVariablePayload): Promise<Variable>;
+    /**
+     * Delete a variable.
+     * @throws {TestRailValidationError} When variableId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    deleteVariable(variableId: number): Promise<void>;
+    /**
+     * Get a single dataset by ID.
+     * @throws {TestRailValidationError} When datasetId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    getDataset(datasetId: number): Promise<Dataset>;
+    /**
+     * Get all datasets for a project.
+     * @throws {TestRailValidationError} When projectId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    getDatasets(projectId: number): Promise<Dataset[]>;
+    /**
+     * Create a new dataset in a project.
+     * @throws {TestRailValidationError} When projectId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    addDataset(projectId: number, payload: AddDatasetPayload): Promise<Dataset>;
+    /**
+     * Update an existing dataset.
+     * @throws {TestRailValidationError} When datasetId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    updateDataset(datasetId: number, payload: UpdateDatasetPayload): Promise<Dataset>;
+    /**
+     * Delete a dataset.
+     * @throws {TestRailValidationError} When datasetId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    deleteDataset(datasetId: number): Promise<void>;
+    /**
+     * Get all available report templates for a project.
+     * @throws {TestRailValidationError} When projectId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    getReports(projectId: number): Promise<Report[]>;
+    /**
+     * Execute a report template and return URLs to the generated output.
+     * @throws {TestRailValidationError} When reportTemplateId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    runReport(reportTemplateId: number): Promise<ReportResult>;
+    private serializeIdList;
+}
+//# sourceMappingURL=client.d.ts.map