@dichovsky/testrail-api-client 1.0.0 → 2.1.0

package/dist/client.d.ts

@@ -1,5 +1,23 @@
-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 type { Case, Suite, Section, Project, Plan, Run, Test, Result, Milestone, User, Status, Priority, AddSuitePayload, UpdateSuitePayload, AddPlanPayload, UpdatePlanPayload, AddPlanEntryPayload, UpdatePlanEntryPayload, PlanEntry, 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 type { AddCasePayload, UpdateCasePayload, AddRunPayload, UpdateRunPayload, AddResultPayload, AddResultsForCasesPayload } from './schemas.js';
 import { TestRailClientCore } from './client-core.js';
+import { ProjectModule } from './modules/projects.js';
+import { SuiteModule } from './modules/suites.js';
+import { SectionModule } from './modules/sections.js';
+import { CaseModule } from './modules/cases.js';
+import { PlanModule } from './modules/plans.js';
+import { RunModule } from './modules/runs.js';
+import { TestModule } from './modules/tests.js';
+import { ResultModule } from './modules/results.js';
+import { MilestoneModule } from './modules/milestones.js';
+import { UsersModule } from './modules/users.js';
+import { MetadataModule } from './modules/metadata.js';
+import { ConfigurationModule } from './modules/configurations.js';
+import { AttachmentModule } from './modules/attachments.js';
+import { SharedStepModule } from './modules/sharedSteps.js';
+import { VariableModule } from './modules/variables.js';
+import { DatasetModule } from './modules/datasets.js';
+import { ReportModule } from './modules/reports.js';
 export { TestRailApiError, TestRailValidationError } from './errors.js';
 /**
  * TestRail API Client
@@ -9,6 +27,24 @@ export { TestRailApiError, TestRailValidationError } from './errors.js';
  * Extends {@link TestRailClientCore} for HTTP pipeline, caching, rate limiting, and retry.
  */
 export declare class TestRailClient extends TestRailClientCore {
+    readonly projects: ProjectModule;
+    readonly suites: SuiteModule;
+    readonly sections: SectionModule;
+    readonly cases: CaseModule;
+    readonly plans: PlanModule;
+    readonly runs: RunModule;
+    readonly tests: TestModule;
+    readonly results: ResultModule;
+    readonly milestones: MilestoneModule;
+    readonly users: UsersModule;
+    readonly metadata: MetadataModule;
+    readonly configurations: ConfigurationModule;
+    readonly attachments: AttachmentModule;
+    readonly sharedSteps: SharedStepModule;
+    readonly variables: VariableModule;
+    readonly datasets: DatasetModule;
+    readonly reports: ReportModule;
+    constructor(...args: ConstructorParameters<typeof TestRailClientCore>);
     /**
      * Get a project by ID.
      * @throws {TestRailValidationError} When projectId is invalid
@@ -310,49 +346,63 @@ export declare class TestRailClient extends TestRailClientCore {
      */
     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
+     * Get milestones.
+     *
+     * @param projectId - Project identifier.
+     * @param options - Optional filters and pagination settings.
+     * @throws {TestRailValidationError} When identifiers or request parameters are 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
+     * Add milestone.
+     *
+     * @param projectId - Project identifier.
+     * @param payload - Request payload for this operation.
+     * @throws {TestRailValidationError} When identifiers or request parameters are 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
+     * Update milestone.
+     *
+     * @param milestoneId - Milestone identifier.
+     * @param payload - Request payload for this operation.
+     * @throws {TestRailValidationError} When identifiers or request parameters are invalid
      * @throws {TestRailApiError} When the API request fails
      */
     updateMilestone(milestoneId: number, payload: UpdateMilestonePayload): Promise<Milestone>;
     /**
-     * Delete a milestone.
-     * @throws {TestRailValidationError} When milestoneId is invalid
+     * Delete milestone.
+     *
+     * @param milestoneId - Milestone identifier.
+     * @throws {TestRailValidationError} When identifiers or request parameters are invalid
      * @throws {TestRailApiError} When the API request fails
      */
     deleteMilestone(milestoneId: number): Promise<void>;
     /**
-     * Get a user by ID.
-     * @throws {TestRailValidationError} When userId is invalid
+     * Get user.
+     *
+     * @param userId - User identifier.
+     * @throws {TestRailValidationError} When identifiers or request parameters are invalid
      * @throws {TestRailApiError} When the API request fails
      */
     getUser(userId: number): Promise<User>;
     /**
-     * Get a user by email address.
+     * Get user by email.
+     *
+     * @param email - Email address to look up.
      * @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
+     * Get users.
+     *
+     * @param limit - Optional maximum number of results to return.
+     * @param offset - Optional number of results to skip before returning results.
+     * @param projectId - Optional project identifier to scope results when provided.
+     * @throws {TestRailValidationError} When identifiers or request parameters are invalid
      * @throws {TestRailApiError} When the API request fails
      */
     getUsers(limit?: number, offset?: number, projectId?: number): Promise<User[]>;
@@ -362,291 +412,397 @@ export declare class TestRailClient extends TestRailClientCore {
      */
     getCurrentUser(): Promise<User>;
     /**
-     * Get all test statuses.
+     * Add user.
+     *
+     * @param payload - Request payload for this operation.
+     * @throws {TestRailApiError} When the API request fails
+     */
+    addUser(payload: AddUserPayload): Promise<User>;
+    /**
+     * Update user.
+     *
+     * @param userId - User identifier.
+     * @param payload - Request payload for this operation.
+     * @throws {TestRailValidationError} When identifiers or request parameters are invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    updateUser(userId: number, payload: UpdateUserPayload): Promise<User>;
+    /**
+     * Get statuses.
      * @throws {TestRailApiError} When the API request fails
      */
     getStatuses(): Promise<Status[]>;
     /**
-     * Get all case priorities.
+     * Get priorities.
      * @throws {TestRailApiError} When the API request fails
      */
     getPriorities(): Promise<Priority[]>;
     /**
-     * Get all available custom result fields.
+     * Get result fields.
      * @throws {TestRailApiError} When the API request fails
      */
     getResultFields(): Promise<ResultField[]>;
     /**
-     * Get all available custom case fields.
+     * Get case fields.
      * @throws {TestRailApiError} When the API request fails
      */
     getCaseFields(): Promise<CaseField[]>;
     /**
-     * Get all available case types.
+     * Get 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
+     * Get templates.
+     *
+     * @param projectId - Project identifier.
+     * @throws {TestRailValidationError} When identifiers or request parameters are 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
+     * Get configurations.
+     *
+     * @param projectId - Project identifier.
+     * @throws {TestRailValidationError} When identifiers or request parameters are 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
+     * Add configuration group.
+     *
+     * @param projectId - Project identifier.
+     * @param payload - Request payload for this operation.
+     * @throws {TestRailValidationError} When identifiers or request parameters are 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
+     * Update configuration group.
+     *
+     * @param configGroupId - Config group identifier.
+     * @param payload - Request payload for this operation.
+     * @throws {TestRailValidationError} When identifiers or request parameters are 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
+     * Delete configuration group.
+     *
+     * @param configGroupId - Config group identifier.
+     * @throws {TestRailValidationError} When identifiers or request parameters are 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
+     * Add configuration.
+     *
+     * @param configGroupId - Config group identifier.
+     * @param payload - Request payload for this operation.
+     * @throws {TestRailValidationError} When identifiers or request parameters are 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
+     * Update configuration.
+     *
+     * @param configId - Config identifier.
+     * @param payload - Request payload for this operation.
+     * @throws {TestRailValidationError} When identifiers or request parameters are 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
+     * Delete configuration.
+     *
+     * @param configId - Config identifier.
+     * @throws {TestRailValidationError} When identifiers or request parameters are 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+).
+     * Get roles.
      * @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
+     * Get group.
+     *
+     * @param groupId - Group identifier.
+     * @throws {TestRailValidationError} When identifiers or request parameters are invalid
      * @throws {TestRailApiError} When the API request fails
      */
     getGroup(groupId: number): Promise<Group>;
     /**
-     * Get all groups (requires TestRail 7.5+).
+     * Get groups.
      * @throws {TestRailApiError} When the API request fails
      */
     getGroups(): Promise<Group[]>;
     /**
-     * Create a new group (requires TestRail 7.5+).
+     * Add group.
+     *
+     * @param payload - Request payload for this operation.
      * @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
+     * Update group.
+     *
+     * @param groupId - Group identifier.
+     * @param payload - Request payload for this operation.
+     * @throws {TestRailValidationError} When identifiers or request parameters are 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
+     * Delete group.
+     *
+     * @param groupId - Group identifier.
+     * @throws {TestRailValidationError} When identifiers or request parameters are 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
+     * Get attachments for case.
+     *
+     * @param caseId - Case identifier.
+     * @throws {TestRailValidationError} When identifiers or request parameters are 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
+     * Get attachments for run.
+     *
+     * @param runId - Run identifier.
+     * @throws {TestRailValidationError} When identifiers or request parameters are 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
+     * Get attachments for test.
+     *
+     * @param testId - Test identifier.
+     * @throws {TestRailValidationError} When identifiers or request parameters are 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
+     * Get attachments for plan.
+     *
+     * @param planId - Plan identifier.
+     * @throws {TestRailValidationError} When identifiers or request parameters are 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
+     * Get attachments for plan entry.
+     *
+     * @param planId - Plan identifier.
+     * @param entryId - Plan entry identifier.
+     * @throws {TestRailValidationError} When identifiers or request parameters are 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
+     * Download an attachment by ID.
+     *
+     * @param attachmentId - Attachment identifier.
+     * @throws {TestRailValidationError} When identifiers or request parameters are 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
+     * Add attachment to case.
+     *
+     * @param caseId - Case identifier.
+     * @param file - Attachment contents to upload.
+     * @param filename - Filename to send with the uploaded attachment.
+     * @throws {TestRailValidationError} When identifiers or request parameters are 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
+     * Add attachment to result.
+     *
+     * @param resultId - Result identifier.
+     * @param file - Attachment contents to upload.
+     * @param filename - Filename to send with the uploaded attachment.
+     * @throws {TestRailValidationError} When identifiers or request parameters are 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
+     * Add attachment to run.
+     *
+     * @param runId - Run identifier.
+     * @param file - Attachment contents to upload.
+     * @param filename - Filename to send with the uploaded attachment.
+     * @throws {TestRailValidationError} When identifiers or request parameters are 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
+     * Add attachment to plan.
+     *
+     * @param planId - Plan identifier.
+     * @param file - Attachment contents to upload.
+     * @param filename - Filename to send with the uploaded attachment.
+     * @throws {TestRailValidationError} When identifiers or request parameters are 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
+     * Add attachment to plan entry.
+     *
+     * @param planId - Plan identifier.
+     * @param entryId - Plan entry identifier.
+     * @param file - Attachment contents to upload.
+     * @param filename - Filename to send with the uploaded attachment.
+     * @throws {TestRailValidationError} When identifiers or request parameters are 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
+     * Delete attachment.
+     *
+     * @param attachmentId - Attachment identifier.
+     * @throws {TestRailValidationError} When identifiers or request parameters are 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
+     * Get shared step.
+     *
+     * @param sharedStepId - Shared step identifier.
+     * @throws {TestRailValidationError} When identifiers or request parameters are 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
+     * Get shared steps.
+     *
+     * @param projectId - Project identifier.
+     * @throws {TestRailValidationError} When identifiers or request parameters are 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
+     * Add shared step.
+     *
+     * @param projectId - Project identifier.
+     * @param payload - Request payload for this operation.
+     * @throws {TestRailValidationError} When identifiers or request parameters are 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
+     * Update shared step.
+     *
+     * @param sharedStepId - Shared step identifier.
+     * @param payload - Request payload for this operation.
+     * @throws {TestRailValidationError} When identifiers or request parameters are 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
+     * Delete shared step.
+     *
+     * @param sharedStepId - Shared step identifier.
+     * @throws {TestRailValidationError} When identifiers or request parameters are 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
+     * Get variables.
+     *
+     * @param projectId - Project identifier.
+     * @throws {TestRailValidationError} When identifiers or request parameters are 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
+     * Add variable.
+     *
+     * @param projectId - Project identifier.
+     * @param payload - Request payload for this operation.
+     * @throws {TestRailValidationError} When identifiers or request parameters are 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
+     * Update variable.
+     *
+     * @param variableId - Variable identifier.
+     * @param payload - Request payload for this operation.
+     * @throws {TestRailValidationError} When identifiers or request parameters are invalid
      * @throws {TestRailApiError} When the API request fails
      */
     updateVariable(variableId: number, payload: UpdateVariablePayload): Promise<Variable>;
     /**
-     * Delete a variable.
-     * @throws {TestRailValidationError} When variableId is invalid
+     * Delete variable.
+     *
+     * @param variableId - Variable identifier.
+     * @throws {TestRailValidationError} When identifiers or request parameters are 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
+     * Get dataset.
+     *
+     * @param datasetId - Dataset identifier.
+     * @throws {TestRailValidationError} When identifiers or request parameters are 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
+     * Get datasets.
+     *
+     * @param projectId - Project identifier.
+     * @throws {TestRailValidationError} When identifiers or request parameters are 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
+     * Add dataset.
+     *
+     * @param projectId - Project identifier.
+     * @param payload - Request payload for this operation.
+     * @throws {TestRailValidationError} When identifiers or request parameters are 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
+     * Update dataset.
+     *
+     * @param datasetId - Dataset identifier.
+     * @param payload - Request payload for this operation.
+     * @throws {TestRailValidationError} When identifiers or request parameters are invalid
      * @throws {TestRailApiError} When the API request fails
      */
     updateDataset(datasetId: number, payload: UpdateDatasetPayload): Promise<Dataset>;
     /**
-     * Delete a dataset.
-     * @throws {TestRailValidationError} When datasetId is invalid
+     * Delete dataset.
+     *
+     * @param datasetId - Dataset identifier.
+     * @throws {TestRailValidationError} When identifiers or request parameters are 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
+     * Get reports.
+     *
+     * @param projectId - Project identifier.
+     * @throws {TestRailValidationError} When identifiers or request parameters are 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
+     * Run report.
+     *
+     * @param reportTemplateId - Report template identifier.
+     * @throws {TestRailValidationError} When identifiers or request parameters are invalid
      * @throws {TestRailApiError} When the API request fails
      */
     runReport(reportTemplateId: number): Promise<ReportResult>;
-    private serializeIdList;
 }
 //# sourceMappingURL=client.d.ts.map