Repository files navigation

@dlenroc/testrail · NPM Version

Installation

npm install @dlenroc/testrail --save

Example

import{TestRail}from'@dlenroc/testrail';constapi=newTestRail({host: 'https://{organization}.testrail.net',username: '{username}',password: '{token/password}',});constprojects=awaitapi.getProjects();console.log(projects);

APIs

Attachments

addAttachmentToCase(caseId: number,payload: AddAttachment): Promise<CreatedAttachment>
addAttachmentToPlan(planId: number,payload: AddAttachment): Promise<CreatedAttachment>
addAttachmentToPlanEntry(planId: number,entryId: string,payload: AddAttachment): Promise<CreatedAttachment>
addAttachmentToResult(resultId: number,payload: AddAttachment): Promise<CreatedAttachment>
addAttachmentToRun(runId: number,payload: AddAttachment): Promise<CreatedAttachment>
getAttachmentsForCase(caseId: number,filters?: Pagination): Promise<AttachmentForCase[]>
getAttachmentsForPlan(planId: number,filters?: Pagination): Promise<AttachmentForPlan[]>
getAttachmentsForPlanEntry(planId: number,entryId: string): Promise<AttachmentForPlanEntry[]>
getAttachmentsForRun(runId: number,filters?: Pagination): Promise<AttachmentForRun[]>
getAttachmentsForTest(testId: number): Promise<AttachmentForTest[]>
getAttachment(attachmentId: string): Promise<Blob>
deleteAttachment(attachmentId: string): Promise<void>

BDDs

getBdd(caseId: number): Promise<Blob>
addBdd(sectionId: number,payload: AddAttachment): Promise<Case>

Cases

getCase(caseId: number): Promise<Case>
getCases(projectId: number,filters?: CaseFilters): Promise<Case[]>
getHistoryForCase(caseId: number,filters?: Pagination): Promise<CaseHistory[]>
addCase(sectionId: number,payload: AddCase): Promise<Case>
copyCasesToSection(sectionId: number,payload: CopyCasesToSection): Promise<void>
updateCase(caseId: number,payload: UpdateCase): Promise<Case>
updateCases(suiteId: number,payload: UpdateCases): Promise<void>
moveCasesToSection(sectionId: number,payload: MoveCasesToSection): Promise<void>
deleteCase(caseId: number): Promise<void>
deleteCases(suiteId: number,payload: DeleteCases): Promise<void>

Case Fields

getCaseFields(): Promise<CaseField[]>
addCaseField(payload: AddCaseField): Promise<CaseField>

Case Types

getCaseTypes(): Promise<CaseType[]>

Configurations

getConfigs(projectId: number): Promise<Config[]>
addConfigGroup(projectId: number,payload: AddConfigGroup): Promise<Config>
addConfig(configGroupId: number,payload: AddConfig): Promise<ConfigItem>
updateConfigGroup(configGroupId: number,payload: UpdateConfigGroup): Promise<Config>
updateConfig(configId: number,payload: UpdateConfig): Promise<ConfigItem>
deleteConfigGroup(configGroupId: number): Promise<void>
deleteConfig(configId: number): Promise<void>

Datasets

getDataset(datasetId: number): Promise<Dataset>
getDatasets(projectId: number,filters?: Pagination): Promise<Dataset[]>
addDataset(projectId: number,payload: AddDataset): Promise<Group>
updateDataset(datasetId: number,payload: AddDataset): Promise<Group>
deleteDataset(datasetId: number): Promise<void>

Groups

getGroup(groupId: number): Promise<Group>
getGroups(filters?: Pagination): Promise<Group[]>
addGroup(payload: AddGroup): Promise<Group>
updateGroup(groupId: number, payload: AddGroup): Promise<Group>
deleteGroup(groupId: number): Promise<void>

Milestones

getMilestone(milestoneId: number): Promise<Milestone>
getMilestones(projectId: number,filters?: MilestoneFilters): Promise<Milestone[]>
addMilestone(projectId: number,payload: AddMilestone): Promise<Milestone>
updateMilestone(milestoneId: number,payload: UpdateMilestone): Promise<Milestone>
deleteMilestone(milestoneId: number): Promise<void>

Roles

getRoles(filters?: Pagination): Promise<Role[]>

Plans

getPlan(planId: number): Promise<Plan>
getPlans(projectId: number,filters?: PlanFilters): Promise<PlanItem[]>
addPlan(projectId: number,payload: AddPlan): Promise<Plan>
addPlanEntry(planId: number,payload: AddPlanEntry): Promise<PlanEntry>
addRunToPlanEntry(planId: number,entryId: string,payload: AddRunToPlanEntry): Promise<PlanEntry>
updatePlan(planId: number,payload: UpdatePlan): Promise<Plan>
updatePlanEntry(planId: number,entryId: string,payload: UpdatePlanEntry): Promise<PlanEntry>
updateRunInPlanEntry(runId: number,payload: UpdateRunInPlanEntry): Promise<PlanEntry>
closePlan(planId: number): Promise<Plan>
deletePlan(planId: number): Promise<void>
deletePlanEntry(planId: number,entryId: string): Promise<void>
deleteRunFromPlanEntry(runId: number): Promise<void>

Priorities

getPriorities(): Promise<Priority[]>

Projects

getProject(projectId: number): Promise<Project>
getProjects(filters?: ProjectFilters): Promise<Project[]>
addProject(payload: AddProject): Promise<Project>
updateProject(projectId: number,payload: UpdateProject): Promise<Project>
deleteProject(projectId: number): Promise<void>

Reports

getReports(projectId: number): Promise<Report[]>
runReport(reportTemplateId: number): Promise<ReportUrls>

Results

getResults(testId: number,filters?: ResultFilters): Promise<Result[]>
getResultsForCase(runId: number,caseId: number,filters?: ResultFilters): Promise<Result[]>
getResultsForRun(runId: number,filters?: ResultForRunFilters): Promise<Result[]>
addResult(testId: number,payload: AddResult): Promise<Result>
addResultForCase(runId: number,caseId: number,payload: AddResult): Promise<Result>
addResults(runId: number,payload: AddResults): Promise<Result[]>
addResultsForCases(runId: number,payload: AddResultsForCases): Promise<Result[]>

Result Fields

getResultFields(): Promise<ResultField[]>

Runs

getRun(runId: number): Promise<Run>
getRuns(projectId: number,filters?: RunFilters): Promise<Run[]>
addRun(projectId: number,payload: AddRun): Promise<Run>
updateRun(runId: number,payload: UpdateRun): Promise<Run>
closeRun(runId: number): Promise<Run>
deleteRun(runId: number): Promise<void>

Sections

getSection(sectionId: number): Promise<Section>
getSections(projectId: number,filters?: SectionFilters): Promise<Section[]>
addSection(projectId: number,payload: AddSection): Promise<Section>
moveSection(sectionId: number,payload: MoveSection): Promise<Section>
updateSection(sectionId: number,payload: UpdateSection): Promise<Section>
deleteSection(sectionId: number): Promise<void>

Shared steps

getSharedStep(stepId: number): Promise<SharedStep>
getSharedSteps(projectId: number,filters?: SharedStepFilters): Promise<SharedStep[]>
getSharedStepHistory(stepId: number,filters?: Pagination): Promise<SharedStepHistory[]>{
addSharedStep(projectId: number,payload: AddSharedStep): Promise<SharedStep>
updateSharedStep(stepId: number,payload: UpdateSharedStep): Promise<SharedStep>
deleteSharedStep(stepId: number,payload?: DeleteSharedStep): Promise<void>

Statuses

getStatuses(): Promise<Status[]>
getCaseStatuses(filters?: Pagination): Promise<CaseStatus[]>

Suites

getSuite(suiteId: number): Promise<Suite>
getSuites(projectId: number): Promise<Suite[]>
addSuite(projectId: number,payload: AddSuite): Promise<Suite>
updateSuite(suiteId: number,payload: UpdateSuite): Promise<Suite>
deleteSuite(suiteId: number): Promise<void>

Templates

getTemplates(projectId: number): Promise<Template[]>

Tests

getTest(testId: number): Promise<Test>
getTests(runId: number,filters?: TestFilters): Promise<Test[]>

Users

getUser(userId: number): Promise<User>
getCurrentUser(): Promise<User>
getUserByEmail(email: string): Promise<User>
getUsers(filters?: UserFilters): Promise<User[]>
addUser(payload: AddUser): Promise<User>
updateUser(userId: number,payload: AddUser): Promise<User>

Variables

getVariables(projectId: number,filters?: Pagination): Promise<Variable[]>
addVariable(projectId: number,payload: AddVariable): Promise<Variable>
updateVariable(variableId: number,payload: AddVariable): Promise<Variable>
deleteVariable(variableId: number): Promise<void>

About

An API wrapper for TestRail with error handling and typing.

Topics

Resources

Stars

3 stars

Watchers

1 watching

Forks

Releases

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

Repository files navigation

@dlenroc/testrail · NPM Version

Installation

npm install @dlenroc/testrail --save

Example

import{TestRail}from'@dlenroc/testrail';constapi=newTestRail({host: 'https://{organization}.testrail.net',username: '{username}',password: '{token/password}',});constprojects=awaitapi.getProjects();console.log(projects);

APIs

Attachments

addAttachmentToCase(caseId: number,payload: AddAttachment): Promise<CreatedAttachment>
addAttachmentToPlan(planId: number,payload: AddAttachment): Promise<CreatedAttachment>
addAttachmentToPlanEntry(planId: number,entryId: string,payload: AddAttachment): Promise<CreatedAttachment>
addAttachmentToResult(resultId: number,payload: AddAttachment): Promise<CreatedAttachment>
addAttachmentToRun(runId: number,payload: AddAttachment): Promise<CreatedAttachment>
getAttachmentsForCase(caseId: number,filters?: Pagination): Promise<AttachmentForCase[]>
getAttachmentsForPlan(planId: number,filters?: Pagination): Promise<AttachmentForPlan[]>
getAttachmentsForPlanEntry(planId: number,entryId: string): Promise<AttachmentForPlanEntry[]>
getAttachmentsForRun(runId: number,filters?: Pagination): Promise<AttachmentForRun[]>
getAttachmentsForTest(testId: number): Promise<AttachmentForTest[]>
getAttachment(attachmentId: string): Promise<Blob>
deleteAttachment(attachmentId: string): Promise<void>

BDDs

getBdd(caseId: number): Promise<Blob>
addBdd(sectionId: number,payload: AddAttachment): Promise<Case>

Cases

getCase(caseId: number): Promise<Case>
getCases(projectId: number,filters?: CaseFilters): Promise<Case[]>
getHistoryForCase(caseId: number,filters?: Pagination): Promise<CaseHistory[]>
addCase(sectionId: number,payload: AddCase): Promise<Case>
copyCasesToSection(sectionId: number,payload: CopyCasesToSection): Promise<void>
updateCase(caseId: number,payload: UpdateCase): Promise<Case>
updateCases(suiteId: number,payload: UpdateCases): Promise<void>
moveCasesToSection(sectionId: number,payload: MoveCasesToSection): Promise<void>
deleteCase(caseId: number): Promise<void>
deleteCases(suiteId: number,payload: DeleteCases): Promise<void>

Case Fields

getCaseFields(): Promise<CaseField[]>
addCaseField(payload: AddCaseField): Promise<CaseField>

Case Types

getCaseTypes(): Promise<CaseType[]>

Configurations

getConfigs(projectId: number): Promise<Config[]>
addConfigGroup(projectId: number,payload: AddConfigGroup): Promise<Config>
addConfig(configGroupId: number,payload: AddConfig): Promise<ConfigItem>
updateConfigGroup(configGroupId: number,payload: UpdateConfigGroup): Promise<Config>
updateConfig(configId: number,payload: UpdateConfig): Promise<ConfigItem>
deleteConfigGroup(configGroupId: number): Promise<void>
deleteConfig(configId: number): Promise<void>

Datasets

getDataset(datasetId: number): Promise<Dataset>
getDatasets(projectId: number,filters?: Pagination): Promise<Dataset[]>
addDataset(projectId: number,payload: AddDataset): Promise<Group>
updateDataset(datasetId: number,payload: AddDataset): Promise<Group>
deleteDataset(datasetId: number): Promise<void>

Groups

getGroup(groupId: number): Promise<Group>
getGroups(filters?: Pagination): Promise<Group[]>
addGroup(payload: AddGroup): Promise<Group>
updateGroup(groupId: number, payload: AddGroup): Promise<Group>
deleteGroup(groupId: number): Promise<void>

Milestones

getMilestone(milestoneId: number): Promise<Milestone>
getMilestones(projectId: number,filters?: MilestoneFilters): Promise<Milestone[]>
addMilestone(projectId: number,payload: AddMilestone): Promise<Milestone>
updateMilestone(milestoneId: number,payload: UpdateMilestone): Promise<Milestone>
deleteMilestone(milestoneId: number): Promise<void>

Roles

getRoles(filters?: Pagination): Promise<Role[]>

Plans

getPlan(planId: number): Promise<Plan>
getPlans(projectId: number,filters?: PlanFilters): Promise<PlanItem[]>
addPlan(projectId: number,payload: AddPlan): Promise<Plan>
addPlanEntry(planId: number,payload: AddPlanEntry): Promise<PlanEntry>
addRunToPlanEntry(planId: number,entryId: string,payload: AddRunToPlanEntry): Promise<PlanEntry>
updatePlan(planId: number,payload: UpdatePlan): Promise<Plan>
updatePlanEntry(planId: number,entryId: string,payload: UpdatePlanEntry): Promise<PlanEntry>
updateRunInPlanEntry(runId: number,payload: UpdateRunInPlanEntry): Promise<PlanEntry>
closePlan(planId: number): Promise<Plan>
deletePlan(planId: number): Promise<void>
deletePlanEntry(planId: number,entryId: string): Promise<void>
deleteRunFromPlanEntry(runId: number): Promise<void>

Priorities

getPriorities(): Promise<Priority[]>

Projects

getProject(projectId: number): Promise<Project>
getProjects(filters?: ProjectFilters): Promise<Project[]>
addProject(payload: AddProject): Promise<Project>
updateProject(projectId: number,payload: UpdateProject): Promise<Project>
deleteProject(projectId: number): Promise<void>

Reports

getReports(projectId: number): Promise<Report[]>
runReport(reportTemplateId: number): Promise<ReportUrls>

Results

getResults(testId: number,filters?: ResultFilters): Promise<Result[]>
getResultsForCase(runId: number,caseId: number,filters?: ResultFilters): Promise<Result[]>
getResultsForRun(runId: number,filters?: ResultForRunFilters): Promise<Result[]>
addResult(testId: number,payload: AddResult): Promise<Result>
addResultForCase(runId: number,caseId: number,payload: AddResult): Promise<Result>
addResults(runId: number,payload: AddResults): Promise<Result[]>
addResultsForCases(runId: number,payload: AddResultsForCases): Promise<Result[]>

Result Fields

getResultFields(): Promise<ResultField[]>

Runs

getRun(runId: number): Promise<Run>
getRuns(projectId: number,filters?: RunFilters): Promise<Run[]>
addRun(projectId: number,payload: AddRun): Promise<Run>
updateRun(runId: number,payload: UpdateRun): Promise<Run>
closeRun(runId: number): Promise<Run>
deleteRun(runId: number): Promise<void>

Sections

getSection(sectionId: number): Promise<Section>
getSections(projectId: number,filters?: SectionFilters): Promise<Section[]>
addSection(projectId: number,payload: AddSection): Promise<Section>
moveSection(sectionId: number,payload: MoveSection): Promise<Section>
updateSection(sectionId: number,payload: UpdateSection): Promise<Section>
deleteSection(sectionId: number): Promise<void>

Shared steps

getSharedStep(stepId: number): Promise<SharedStep>
getSharedSteps(projectId: number,filters?: SharedStepFilters): Promise<SharedStep[]>
getSharedStepHistory(stepId: number,filters?: Pagination): Promise<SharedStepHistory[]>{
addSharedStep(projectId: number,payload: AddSharedStep): Promise<SharedStep>
updateSharedStep(stepId: number,payload: UpdateSharedStep): Promise<SharedStep>
deleteSharedStep(stepId: number,payload?: DeleteSharedStep): Promise<void>

Statuses

getStatuses(): Promise<Status[]>
getCaseStatuses(filters?: Pagination): Promise<CaseStatus[]>

Suites

getSuite(suiteId: number): Promise<Suite>
getSuites(projectId: number): Promise<Suite[]>
addSuite(projectId: number,payload: AddSuite): Promise<Suite>
updateSuite(suiteId: number,payload: UpdateSuite): Promise<Suite>
deleteSuite(suiteId: number): Promise<void>

Templates

getTemplates(projectId: number): Promise<Template[]>

Tests

getTest(testId: number): Promise<Test>
getTests(runId: number,filters?: TestFilters): Promise<Test[]>

Users

getUser(userId: number): Promise<User>
getCurrentUser(): Promise<User>
getUserByEmail(email: string): Promise<User>
getUsers(filters?: UserFilters): Promise<User[]>
addUser(payload: AddUser): Promise<User>
updateUser(userId: number,payload: AddUser): Promise<User>

Variables

getVariables(projectId: number,filters?: Pagination): Promise<Variable[]>
addVariable(projectId: number,payload: AddVariable): Promise<Variable>
updateVariable(variableId: number,payload: AddVariable): Promise<Variable>
deleteVariable(variableId: number): Promise<void>

About

An API wrapper for TestRail with error handling and typing.

Topics

Resources

Stars

3 stars

Watchers

1 watching

Forks

Releases

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Repository files navigation

@dlenroc/testrail · NPM Version

Installation

npm install @dlenroc/testrail --save

Example

import{TestRail}from'@dlenroc/testrail';constapi=newTestRail({host: 'https://{organization}.testrail.net',username: '{username}',password: '{token/password}',});constprojects=awaitapi.getProjects();console.log(projects);

APIs

Attachments

addAttachmentToCase(caseId: number,payload: AddAttachment): Promise<CreatedAttachment>
addAttachmentToPlan(planId: number,payload: AddAttachment): Promise<CreatedAttachment>
addAttachmentToPlanEntry(planId: number,entryId: string,payload: AddAttachment): Promise<CreatedAttachment>
addAttachmentToResult(resultId: number,payload: AddAttachment): Promise<CreatedAttachment>
addAttachmentToRun(runId: number,payload: AddAttachment): Promise<CreatedAttachment>
getAttachmentsForCase(caseId: number,filters?: Pagination): Promise<AttachmentForCase[]>
getAttachmentsForPlan(planId: number,filters?: Pagination): Promise<AttachmentForPlan[]>
getAttachmentsForPlanEntry(planId: number,entryId: string): Promise<AttachmentForPlanEntry[]>
getAttachmentsForRun(runId: number,filters?: Pagination): Promise<AttachmentForRun[]>
getAttachmentsForTest(testId: number): Promise<AttachmentForTest[]>
getAttachment(attachmentId: string): Promise<Blob>
deleteAttachment(attachmentId: string): Promise<void>

BDDs

getBdd(caseId: number): Promise<Blob>
addBdd(sectionId: number,payload: AddAttachment): Promise<Case>

Cases

getCase(caseId: number): Promise<Case>
getCases(projectId: number,filters?: CaseFilters): Promise<Case[]>
getHistoryForCase(caseId: number,filters?: Pagination): Promise<CaseHistory[]>
addCase(sectionId: number,payload: AddCase): Promise<Case>
copyCasesToSection(sectionId: number,payload: CopyCasesToSection): Promise<void>
updateCase(caseId: number,payload: UpdateCase): Promise<Case>
updateCases(suiteId: number,payload: UpdateCases): Promise<void>
moveCasesToSection(sectionId: number,payload: MoveCasesToSection): Promise<void>
deleteCase(caseId: number): Promise<void>
deleteCases(suiteId: number,payload: DeleteCases): Promise<void>

Case Fields

getCaseFields(): Promise<CaseField[]>
addCaseField(payload: AddCaseField): Promise<CaseField>

Case Types

getCaseTypes(): Promise<CaseType[]>

Configurations

getConfigs(projectId: number): Promise<Config[]>
addConfigGroup(projectId: number,payload: AddConfigGroup): Promise<Config>
addConfig(configGroupId: number,payload: AddConfig): Promise<ConfigItem>
updateConfigGroup(configGroupId: number,payload: UpdateConfigGroup): Promise<Config>
updateConfig(configId: number,payload: UpdateConfig): Promise<ConfigItem>
deleteConfigGroup(configGroupId: number): Promise<void>
deleteConfig(configId: number): Promise<void>

Datasets

getDataset(datasetId: number): Promise<Dataset>
getDatasets(projectId: number,filters?: Pagination): Promise<Dataset[]>
addDataset(projectId: number,payload: AddDataset): Promise<Group>
updateDataset(datasetId: number,payload: AddDataset): Promise<Group>
deleteDataset(datasetId: number): Promise<void>

Groups

getGroup(groupId: number): Promise<Group>
getGroups(filters?: Pagination): Promise<Group[]>
addGroup(payload: AddGroup): Promise<Group>
updateGroup(groupId: number, payload: AddGroup): Promise<Group>
deleteGroup(groupId: number): Promise<void>

Milestones

getMilestone(milestoneId: number): Promise<Milestone>
getMilestones(projectId: number,filters?: MilestoneFilters): Promise<Milestone[]>
addMilestone(projectId: number,payload: AddMilestone): Promise<Milestone>
updateMilestone(milestoneId: number,payload: UpdateMilestone): Promise<Milestone>
deleteMilestone(milestoneId: number): Promise<void>

Roles

getRoles(filters?: Pagination): Promise<Role[]>

Plans

getPlan(planId: number): Promise<Plan>
getPlans(projectId: number,filters?: PlanFilters): Promise<PlanItem[]>
addPlan(projectId: number,payload: AddPlan): Promise<Plan>
addPlanEntry(planId: number,payload: AddPlanEntry): Promise<PlanEntry>
addRunToPlanEntry(planId: number,entryId: string,payload: AddRunToPlanEntry): Promise<PlanEntry>
updatePlan(planId: number,payload: UpdatePlan): Promise<Plan>
updatePlanEntry(planId: number,entryId: string,payload: UpdatePlanEntry): Promise<PlanEntry>
updateRunInPlanEntry(runId: number,payload: UpdateRunInPlanEntry): Promise<PlanEntry>
closePlan(planId: number): Promise<Plan>
deletePlan(planId: number): Promise<void>
deletePlanEntry(planId: number,entryId: string): Promise<void>
deleteRunFromPlanEntry(runId: number): Promise<void>

Priorities

getPriorities(): Promise<Priority[]>

Projects

getProject(projectId: number): Promise<Project>
getProjects(filters?: ProjectFilters): Promise<Project[]>
addProject(payload: AddProject): Promise<Project>
updateProject(projectId: number,payload: UpdateProject): Promise<Project>
deleteProject(projectId: number): Promise<void>

Reports

getReports(projectId: number): Promise<Report[]>
runReport(reportTemplateId: number): Promise<ReportUrls>

Results

getResults(testId: number,filters?: ResultFilters): Promise<Result[]>
getResultsForCase(runId: number,caseId: number,filters?: ResultFilters): Promise<Result[]>
getResultsForRun(runId: number,filters?: ResultForRunFilters): Promise<Result[]>
addResult(testId: number,payload: AddResult): Promise<Result>
addResultForCase(runId: number,caseId: number,payload: AddResult): Promise<Result>
addResults(runId: number,payload: AddResults): Promise<Result[]>
addResultsForCases(runId: number,payload: AddResultsForCases): Promise<Result[]>

Result Fields

getResultFields(): Promise<ResultField[]>

Runs

getRun(runId: number): Promise<Run>
getRuns(projectId: number,filters?: RunFilters): Promise<Run[]>
addRun(projectId: number,payload: AddRun): Promise<Run>
updateRun(runId: number,payload: UpdateRun): Promise<Run>
closeRun(runId: number): Promise<Run>
deleteRun(runId: number): Promise<void>

Sections

getSection(sectionId: number): Promise<Section>
getSections(projectId: number,filters?: SectionFilters): Promise<Section[]>
addSection(projectId: number,payload: AddSection): Promise<Section>
moveSection(sectionId: number,payload: MoveSection): Promise<Section>
updateSection(sectionId: number,payload: UpdateSection): Promise<Section>
deleteSection(sectionId: number): Promise<void>

Shared steps

getSharedStep(stepId: number): Promise<SharedStep>
getSharedSteps(projectId: number,filters?: SharedStepFilters): Promise<SharedStep[]>
getSharedStepHistory(stepId: number,filters?: Pagination): Promise<SharedStepHistory[]>{
addSharedStep(projectId: number,payload: AddSharedStep): Promise<SharedStep>
updateSharedStep(stepId: number,payload: UpdateSharedStep): Promise<SharedStep>
deleteSharedStep(stepId: number,payload?: DeleteSharedStep): Promise<void>

Statuses

getStatuses(): Promise<Status[]>
getCaseStatuses(filters?: Pagination): Promise<CaseStatus[]>

Suites

getSuite(suiteId: number): Promise<Suite>
getSuites(projectId: number): Promise<Suite[]>
addSuite(projectId: number,payload: AddSuite): Promise<Suite>
updateSuite(suiteId: number,payload: UpdateSuite): Promise<Suite>
deleteSuite(suiteId: number): Promise<void>

Templates

getTemplates(projectId: number): Promise<Template[]>

Tests

getTest(testId: number): Promise<Test>
getTests(runId: number,filters?: TestFilters): Promise<Test[]>

Users

getUser(userId: number): Promise<User>
getCurrentUser(): Promise<User>
getUserByEmail(email: string): Promise<User>
getUsers(filters?: UserFilters): Promise<User[]>
addUser(payload: AddUser): Promise<User>
updateUser(userId: number,payload: AddUser): Promise<User>

Variables

getVariables(projectId: number,filters?: Pagination): Promise<Variable[]>
addVariable(projectId: number,payload: AddVariable): Promise<Variable>
updateVariable(variableId: number,payload: AddVariable): Promise<Variable>
deleteVariable(variableId: number): Promise<void>

About

An API wrapper for TestRail with error handling and typing.

Topics

Resources

Stars

3 stars

Watchers

1 watching

Forks

Releases

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Repository files navigation

@dlenroc/testrail · NPM Version

Installation

npm install @dlenroc/testrail --save

Example

import{TestRail}from'@dlenroc/testrail';constapi=newTestRail({host: 'https://{organization}.testrail.net',username: '{username}',password: '{token/password}',});constprojects=awaitapi.getProjects();console.log(projects);

APIs

Attachments

addAttachmentToCase(caseId: number,payload: AddAttachment): Promise<CreatedAttachment>
addAttachmentToPlan(planId: number,payload: AddAttachment): Promise<CreatedAttachment>
addAttachmentToPlanEntry(planId: number,entryId: string,payload: AddAttachment): Promise<CreatedAttachment>
addAttachmentToResult(resultId: number,payload: AddAttachment): Promise<CreatedAttachment>
addAttachmentToRun(runId: number,payload: AddAttachment): Promise<CreatedAttachment>
getAttachmentsForCase(caseId: number,filters?: Pagination): Promise<AttachmentForCase[]>
getAttachmentsForPlan(planId: number,filters?: Pagination): Promise<AttachmentForPlan[]>
getAttachmentsForPlanEntry(planId: number,entryId: string): Promise<AttachmentForPlanEntry[]>
getAttachmentsForRun(runId: number,filters?: Pagination): Promise<AttachmentForRun[]>
getAttachmentsForTest(testId: number): Promise<AttachmentForTest[]>
getAttachment(attachmentId: string): Promise<Blob>
deleteAttachment(attachmentId: string): Promise<void>

BDDs

getBdd(caseId: number): Promise<Blob>
addBdd(sectionId: number,payload: AddAttachment): Promise<Case>

Cases

getCase(caseId: number): Promise<Case>
getCases(projectId: number,filters?: CaseFilters): Promise<Case[]>
getHistoryForCase(caseId: number,filters?: Pagination): Promise<CaseHistory[]>
addCase(sectionId: number,payload: AddCase): Promise<Case>
copyCasesToSection(sectionId: number,payload: CopyCasesToSection): Promise<void>
updateCase(caseId: number,payload: UpdateCase): Promise<Case>
updateCases(suiteId: number,payload: UpdateCases): Promise<void>
moveCasesToSection(sectionId: number,payload: MoveCasesToSection): Promise<void>
deleteCase(caseId: number): Promise<void>
deleteCases(suiteId: number,payload: DeleteCases): Promise<void>

Case Fields

getCaseFields(): Promise<CaseField[]>
addCaseField(payload: AddCaseField): Promise<CaseField>

Case Types

getCaseTypes(): Promise<CaseType[]>

Configurations

getConfigs(projectId: number): Promise<Config[]>
addConfigGroup(projectId: number,payload: AddConfigGroup): Promise<Config>
addConfig(configGroupId: number,payload: AddConfig): Promise<ConfigItem>
updateConfigGroup(configGroupId: number,payload: UpdateConfigGroup): Promise<Config>
updateConfig(configId: number,payload: UpdateConfig): Promise<ConfigItem>
deleteConfigGroup(configGroupId: number): Promise<void>
deleteConfig(configId: number): Promise<void>

Datasets

getDataset(datasetId: number): Promise<Dataset>
getDatasets(projectId: number,filters?: Pagination): Promise<Dataset[]>
addDataset(projectId: number,payload: AddDataset): Promise<Group>
updateDataset(datasetId: number,payload: AddDataset): Promise<Group>
deleteDataset(datasetId: number): Promise<void>

Groups

getGroup(groupId: number): Promise<Group>
getGroups(filters?: Pagination): Promise<Group[]>
addGroup(payload: AddGroup): Promise<Group>
updateGroup(groupId: number, payload: AddGroup): Promise<Group>
deleteGroup(groupId: number): Promise<void>

Milestones

getMilestone(milestoneId: number): Promise<Milestone>
getMilestones(projectId: number,filters?: MilestoneFilters): Promise<Milestone[]>
addMilestone(projectId: number,payload: AddMilestone): Promise<Milestone>
updateMilestone(milestoneId: number,payload: UpdateMilestone): Promise<Milestone>
deleteMilestone(milestoneId: number): Promise<void>

Roles

getRoles(filters?: Pagination): Promise<Role[]>

Plans

getPlan(planId: number): Promise<Plan>
getPlans(projectId: number,filters?: PlanFilters): Promise<PlanItem[]>
addPlan(projectId: number,payload: AddPlan): Promise<Plan>
addPlanEntry(planId: number,payload: AddPlanEntry): Promise<PlanEntry>
addRunToPlanEntry(planId: number,entryId: string,payload: AddRunToPlanEntry): Promise<PlanEntry>
updatePlan(planId: number,payload: UpdatePlan): Promise<Plan>
updatePlanEntry(planId: number,entryId: string,payload: UpdatePlanEntry): Promise<PlanEntry>
updateRunInPlanEntry(runId: number,payload: UpdateRunInPlanEntry): Promise<PlanEntry>
closePlan(planId: number): Promise<Plan>
deletePlan(planId: number): Promise<void>
deletePlanEntry(planId: number,entryId: string): Promise<void>
deleteRunFromPlanEntry(runId: number): Promise<void>

Priorities

getPriorities(): Promise<Priority[]>

Projects

getProject(projectId: number): Promise<Project>
getProjects(filters?: ProjectFilters): Promise<Project[]>
addProject(payload: AddProject): Promise<Project>
updateProject(projectId: number,payload: UpdateProject): Promise<Project>
deleteProject(projectId: number): Promise<void>

Reports

getReports(projectId: number): Promise<Report[]>
runReport(reportTemplateId: number): Promise<ReportUrls>

Results

getResults(testId: number,filters?: ResultFilters): Promise<Result[]>
getResultsForCase(runId: number,caseId: number,filters?: ResultFilters): Promise<Result[]>
getResultsForRun(runId: number,filters?: ResultForRunFilters): Promise<Result[]>
addResult(testId: number,payload: AddResult): Promise<Result>
addResultForCase(runId: number,caseId: number,payload: AddResult): Promise<Result>
addResults(runId: number,payload: AddResults): Promise<Result[]>
addResultsForCases(runId: number,payload: AddResultsForCases): Promise<Result[]>

Result Fields

getResultFields(): Promise<ResultField[]>

Runs

getRun(runId: number): Promise<Run>
getRuns(projectId: number,filters?: RunFilters): Promise<Run[]>
addRun(projectId: number,payload: AddRun): Promise<Run>
updateRun(runId: number,payload: UpdateRun): Promise<Run>
closeRun(runId: number): Promise<Run>
deleteRun(runId: number): Promise<void>

Sections

getSection(sectionId: number): Promise<Section>
getSections(projectId: number,filters?: SectionFilters): Promise<Section[]>
addSection(projectId: number,payload: AddSection): Promise<Section>
moveSection(sectionId: number,payload: MoveSection): Promise<Section>
updateSection(sectionId: number,payload: UpdateSection): Promise<Section>
deleteSection(sectionId: number): Promise<void>

Shared steps

getSharedStep(stepId: number): Promise<SharedStep>
getSharedSteps(projectId: number,filters?: SharedStepFilters): Promise<SharedStep[]>
getSharedStepHistory(stepId: number,filters?: Pagination): Promise<SharedStepHistory[]>{
addSharedStep(projectId: number,payload: AddSharedStep): Promise<SharedStep>
updateSharedStep(stepId: number,payload: UpdateSharedStep): Promise<SharedStep>
deleteSharedStep(stepId: number,payload?: DeleteSharedStep): Promise<void>

Statuses

getStatuses(): Promise<Status[]>
getCaseStatuses(filters?: Pagination): Promise<CaseStatus[]>

Suites

getSuite(suiteId: number): Promise<Suite>
getSuites(projectId: number): Promise<Suite[]>
addSuite(projectId: number,payload: AddSuite): Promise<Suite>
updateSuite(suiteId: number,payload: UpdateSuite): Promise<Suite>
deleteSuite(suiteId: number): Promise<void>

Templates

getTemplates(projectId: number): Promise<Template[]>

Tests

getTest(testId: number): Promise<Test>
getTests(runId: number,filters?: TestFilters): Promise<Test[]>

Users

getUser(userId: number): Promise<User>
getCurrentUser(): Promise<User>
getUserByEmail(email: string): Promise<User>
getUsers(filters?: UserFilters): Promise<User[]>
addUser(payload: AddUser): Promise<User>
updateUser(userId: number,payload: AddUser): Promise<User>

Variables

getVariables(projectId: number,filters?: Pagination): Promise<Variable[]>
addVariable(projectId: number,payload: AddVariable): Promise<Variable>
updateVariable(variableId: number,payload: AddVariable): Promise<Variable>
deleteVariable(variableId: number): Promise<void>

About

An API wrapper for TestRail with error handling and typing.

Topics

Resources

Stars

3 stars

Watchers

1 watching

Forks

Releases

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

Repository files navigation

@dlenroc/testrail · NPM Version

Installation

npm install @dlenroc/testrail --save

Example

import{TestRail}from'@dlenroc/testrail';constapi=newTestRail({host: 'https://{organization}.testrail.net',username: '{username}',password: '{token/password}',});constprojects=awaitapi.getProjects();console.log(projects);

APIs

Attachments

addAttachmentToCase(caseId: number,payload: AddAttachment): Promise<CreatedAttachment>
addAttachmentToPlan(planId: number,payload: AddAttachment): Promise<CreatedAttachment>
addAttachmentToPlanEntry(planId: number,entryId: string,payload: AddAttachment): Promise<CreatedAttachment>
addAttachmentToResult(resultId: number,payload: AddAttachment): Promise<CreatedAttachment>
addAttachmentToRun(runId: number,payload: AddAttachment): Promise<CreatedAttachment>
getAttachmentsForCase(caseId: number,filters?: Pagination): Promise<AttachmentForCase[]>
getAttachmentsForPlan(planId: number,filters?: Pagination): Promise<AttachmentForPlan[]>
getAttachmentsForPlanEntry(planId: number,entryId: string): Promise<AttachmentForPlanEntry[]>
getAttachmentsForRun(runId: number,filters?: Pagination): Promise<AttachmentForRun[]>
getAttachmentsForTest(testId: number): Promise<AttachmentForTest[]>
getAttachment(attachmentId: string): Promise<Blob>
deleteAttachment(attachmentId: string): Promise<void>

BDDs

getBdd(caseId: number): Promise<Blob>
addBdd(sectionId: number,payload: AddAttachment): Promise<Case>

Cases

getCase(caseId: number): Promise<Case>
getCases(projectId: number,filters?: CaseFilters): Promise<Case[]>
getHistoryForCase(caseId: number,filters?: Pagination): Promise<CaseHistory[]>
addCase(sectionId: number,payload: AddCase): Promise<Case>
copyCasesToSection(sectionId: number,payload: CopyCasesToSection): Promise<void>
updateCase(caseId: number,payload: UpdateCase): Promise<Case>
updateCases(suiteId: number,payload: UpdateCases): Promise<void>
moveCasesToSection(sectionId: number,payload: MoveCasesToSection): Promise<void>
deleteCase(caseId: number): Promise<void>
deleteCases(suiteId: number,payload: DeleteCases): Promise<void>

Case Fields

getCaseFields(): Promise<CaseField[]>
addCaseField(payload: AddCaseField): Promise<CaseField>

Case Types

getCaseTypes(): Promise<CaseType[]>

Configurations

getConfigs(projectId: number): Promise<Config[]>
addConfigGroup(projectId: number,payload: AddConfigGroup): Promise<Config>
addConfig(configGroupId: number,payload: AddConfig): Promise<ConfigItem>
updateConfigGroup(configGroupId: number,payload: UpdateConfigGroup): Promise<Config>
updateConfig(configId: number,payload: UpdateConfig): Promise<ConfigItem>
deleteConfigGroup(configGroupId: number): Promise<void>
deleteConfig(configId: number): Promise<void>

Datasets

getDataset(datasetId: number): Promise<Dataset>
getDatasets(projectId: number,filters?: Pagination): Promise<Dataset[]>
addDataset(projectId: number,payload: AddDataset): Promise<Group>
updateDataset(datasetId: number,payload: AddDataset): Promise<Group>
deleteDataset(datasetId: number): Promise<void>

Groups

getGroup(groupId: number): Promise<Group>
getGroups(filters?: Pagination): Promise<Group[]>
addGroup(payload: AddGroup): Promise<Group>
updateGroup(groupId: number, payload: AddGroup): Promise<Group>
deleteGroup(groupId: number): Promise<void>

Milestones

getMilestone(milestoneId: number): Promise<Milestone>
getMilestones(projectId: number,filters?: MilestoneFilters): Promise<Milestone[]>
addMilestone(projectId: number,payload: AddMilestone): Promise<Milestone>
updateMilestone(milestoneId: number,payload: UpdateMilestone): Promise<Milestone>
deleteMilestone(milestoneId: number): Promise<void>

Roles

getRoles(filters?: Pagination): Promise<Role[]>

Plans

getPlan(planId: number): Promise<Plan>
getPlans(projectId: number,filters?: PlanFilters): Promise<PlanItem[]>
addPlan(projectId: number,payload: AddPlan): Promise<Plan>
addPlanEntry(planId: number,payload: AddPlanEntry): Promise<PlanEntry>
addRunToPlanEntry(planId: number,entryId: string,payload: AddRunToPlanEntry): Promise<PlanEntry>
updatePlan(planId: number,payload: UpdatePlan): Promise<Plan>
updatePlanEntry(planId: number,entryId: string,payload: UpdatePlanEntry): Promise<PlanEntry>
updateRunInPlanEntry(runId: number,payload: UpdateRunInPlanEntry): Promise<PlanEntry>
closePlan(planId: number): Promise<Plan>
deletePlan(planId: number): Promise<void>
deletePlanEntry(planId: number,entryId: string): Promise<void>
deleteRunFromPlanEntry(runId: number): Promise<void>

Priorities

getPriorities(): Promise<Priority[]>

Projects

getProject(projectId: number): Promise<Project>
getProjects(filters?: ProjectFilters): Promise<Project[]>
addProject(payload: AddProject): Promise<Project>
updateProject(projectId: number,payload: UpdateProject): Promise<Project>
deleteProject(projectId: number): Promise<void>

Reports

getReports(projectId: number): Promise<Report[]>
runReport(reportTemplateId: number): Promise<ReportUrls>

Results

getResults(testId: number,filters?: ResultFilters): Promise<Result[]>
getResultsForCase(runId: number,caseId: number,filters?: ResultFilters): Promise<Result[]>
getResultsForRun(runId: number,filters?: ResultForRunFilters): Promise<Result[]>
addResult(testId: number,payload: AddResult): Promise<Result>
addResultForCase(runId: number,caseId: number,payload: AddResult): Promise<Result>
addResults(runId: number,payload: AddResults): Promise<Result[]>
addResultsForCases(runId: number,payload: AddResultsForCases): Promise<Result[]>

Result Fields

getResultFields(): Promise<ResultField[]>

Runs

getRun(runId: number): Promise<Run>
getRuns(projectId: number,filters?: RunFilters): Promise<Run[]>
addRun(projectId: number,payload: AddRun): Promise<Run>
updateRun(runId: number,payload: UpdateRun): Promise<Run>
closeRun(runId: number): Promise<Run>
deleteRun(runId: number): Promise<void>

Sections

getSection(sectionId: number): Promise<Section>
getSections(projectId: number,filters?: SectionFilters): Promise<Section[]>
addSection(projectId: number,payload: AddSection): Promise<Section>
moveSection(sectionId: number,payload: MoveSection): Promise<Section>
updateSection(sectionId: number,payload: UpdateSection): Promise<Section>
deleteSection(sectionId: number): Promise<void>

Shared steps

getSharedStep(stepId: number): Promise<SharedStep>
getSharedSteps(projectId: number,filters?: SharedStepFilters): Promise<SharedStep[]>
getSharedStepHistory(stepId: number,filters?: Pagination): Promise<SharedStepHistory[]>{
addSharedStep(projectId: number,payload: AddSharedStep): Promise<SharedStep>
updateSharedStep(stepId: number,payload: UpdateSharedStep): Promise<SharedStep>
deleteSharedStep(stepId: number,payload?: DeleteSharedStep): Promise<void>

Statuses

getStatuses(): Promise<Status[]>
getCaseStatuses(filters?: Pagination): Promise<CaseStatus[]>

Suites

getSuite(suiteId: number): Promise<Suite>
getSuites(projectId: number): Promise<Suite[]>
addSuite(projectId: number,payload: AddSuite): Promise<Suite>
updateSuite(suiteId: number,payload: UpdateSuite): Promise<Suite>
deleteSuite(suiteId: number): Promise<void>

Templates

getTemplates(projectId: number): Promise<Template[]>

Tests

getTest(testId: number): Promise<Test>
getTests(runId: number,filters?: TestFilters): Promise<Test[]>

Users

getUser(userId: number): Promise<User>
getCurrentUser(): Promise<User>
getUserByEmail(email: string): Promise<User>
getUsers(filters?: UserFilters): Promise<User[]>
addUser(payload: AddUser): Promise<User>
updateUser(userId: number,payload: AddUser): Promise<User>

Variables

getVariables(projectId: number,filters?: Pagination): Promise<Variable[]>
addVariable(projectId: number,payload: AddVariable): Promise<Variable>
updateVariable(variableId: number,payload: AddVariable): Promise<Variable>
deleteVariable(variableId: number): Promise<void>

About

An API wrapper for TestRail with error handling and typing.

Topics

Resources

Stars

3 stars

Watchers

1 watching

Forks

Releases

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Repository files navigation

@dlenroc/testrail · NPM Version

Installation

npm install @dlenroc/testrail --save

Example

import{TestRail}from'@dlenroc/testrail';constapi=newTestRail({host: 'https://{organization}.testrail.net',username: '{username}',password: '{token/password}',});constprojects=awaitapi.getProjects();console.log(projects);

APIs

Attachments

addAttachmentToCase(caseId: number,payload: AddAttachment): Promise<CreatedAttachment>
addAttachmentToPlan(planId: number,payload: AddAttachment): Promise<CreatedAttachment>
addAttachmentToPlanEntry(planId: number,entryId: string,payload: AddAttachment): Promise<CreatedAttachment>
addAttachmentToResult(resultId: number,payload: AddAttachment): Promise<CreatedAttachment>
addAttachmentToRun(runId: number,payload: AddAttachment): Promise<CreatedAttachment>
getAttachmentsForCase(caseId: number,filters?: Pagination): Promise<AttachmentForCase[]>
getAttachmentsForPlan(planId: number,filters?: Pagination): Promise<AttachmentForPlan[]>
getAttachmentsForPlanEntry(planId: number,entryId: string): Promise<AttachmentForPlanEntry[]>
getAttachmentsForRun(runId: number,filters?: Pagination): Promise<AttachmentForRun[]>
getAttachmentsForTest(testId: number): Promise<AttachmentForTest[]>
getAttachment(attachmentId: string): Promise<Blob>
deleteAttachment(attachmentId: string): Promise<void>

BDDs

getBdd(caseId: number): Promise<Blob>
addBdd(sectionId: number,payload: AddAttachment): Promise<Case>

Cases

getCase(caseId: number): Promise<Case>
getCases(projectId: number,filters?: CaseFilters): Promise<Case[]>
getHistoryForCase(caseId: number,filters?: Pagination): Promise<CaseHistory[]>
addCase(sectionId: number,payload: AddCase): Promise<Case>
copyCasesToSection(sectionId: number,payload: CopyCasesToSection): Promise<void>
updateCase(caseId: number,payload: UpdateCase): Promise<Case>
updateCases(suiteId: number,payload: UpdateCases): Promise<void>
moveCasesToSection(sectionId: number,payload: MoveCasesToSection): Promise<void>
deleteCase(caseId: number): Promise<void>
deleteCases(suiteId: number,payload: DeleteCases): Promise<void>

Case Fields

getCaseFields(): Promise<CaseField[]>
addCaseField(payload: AddCaseField): Promise<CaseField>

Case Types

getCaseTypes(): Promise<CaseType[]>

Configurations

getConfigs(projectId: number): Promise<Config[]>
addConfigGroup(projectId: number,payload: AddConfigGroup): Promise<Config>
addConfig(configGroupId: number,payload: AddConfig): Promise<ConfigItem>
updateConfigGroup(configGroupId: number,payload: UpdateConfigGroup): Promise<Config>
updateConfig(configId: number,payload: UpdateConfig): Promise<ConfigItem>
deleteConfigGroup(configGroupId: number): Promise<void>
deleteConfig(configId: number): Promise<void>

Datasets

getDataset(datasetId: number): Promise<Dataset>
getDatasets(projectId: number,filters?: Pagination): Promise<Dataset[]>
addDataset(projectId: number,payload: AddDataset): Promise<Group>
updateDataset(datasetId: number,payload: AddDataset): Promise<Group>
deleteDataset(datasetId: number): Promise<void>

Groups

getGroup(groupId: number): Promise<Group>
getGroups(filters?: Pagination): Promise<Group[]>
addGroup(payload: AddGroup): Promise<Group>
updateGroup(groupId: number, payload: AddGroup): Promise<Group>
deleteGroup(groupId: number): Promise<void>

Milestones

getMilestone(milestoneId: number): Promise<Milestone>
getMilestones(projectId: number,filters?: MilestoneFilters): Promise<Milestone[]>
addMilestone(projectId: number,payload: AddMilestone): Promise<Milestone>
updateMilestone(milestoneId: number,payload: UpdateMilestone): Promise<Milestone>
deleteMilestone(milestoneId: number): Promise<void>

Roles

getRoles(filters?: Pagination): Promise<Role[]>

Plans

getPlan(planId: number): Promise<Plan>
getPlans(projectId: number,filters?: PlanFilters): Promise<PlanItem[]>
addPlan(projectId: number,payload: AddPlan): Promise<Plan>
addPlanEntry(planId: number,payload: AddPlanEntry): Promise<PlanEntry>
addRunToPlanEntry(planId: number,entryId: string,payload: AddRunToPlanEntry): Promise<PlanEntry>
updatePlan(planId: number,payload: UpdatePlan): Promise<Plan>
updatePlanEntry(planId: number,entryId: string,payload: UpdatePlanEntry): Promise<PlanEntry>
updateRunInPlanEntry(runId: number,payload: UpdateRunInPlanEntry): Promise<PlanEntry>
closePlan(planId: number): Promise<Plan>
deletePlan(planId: number): Promise<void>
deletePlanEntry(planId: number,entryId: string): Promise<void>
deleteRunFromPlanEntry(runId: number): Promise<void>

Priorities

getPriorities(): Promise<Priority[]>

Projects

getProject(projectId: number): Promise<Project>
getProjects(filters?: ProjectFilters): Promise<Project[]>
addProject(payload: AddProject): Promise<Project>
updateProject(projectId: number,payload: UpdateProject): Promise<Project>
deleteProject(projectId: number): Promise<void>

Reports

getReports(projectId: number): Promise<Report[]>
runReport(reportTemplateId: number): Promise<ReportUrls>

Results

getResults(testId: number,filters?: ResultFilters): Promise<Result[]>
getResultsForCase(runId: number,caseId: number,filters?: ResultFilters): Promise<Result[]>
getResultsForRun(runId: number,filters?: ResultForRunFilters): Promise<Result[]>
addResult(testId: number,payload: AddResult): Promise<Result>
addResultForCase(runId: number,caseId: number,payload: AddResult): Promise<Result>
addResults(runId: number,payload: AddResults): Promise<Result[]>
addResultsForCases(runId: number,payload: AddResultsForCases): Promise<Result[]>

Result Fields

getResultFields(): Promise<ResultField[]>

Runs

getRun(runId: number): Promise<Run>
getRuns(projectId: number,filters?: RunFilters): Promise<Run[]>
addRun(projectId: number,payload: AddRun): Promise<Run>
updateRun(runId: number,payload: UpdateRun): Promise<Run>
closeRun(runId: number): Promise<Run>
deleteRun(runId: number): Promise<void>

Sections

getSection(sectionId: number): Promise<Section>
getSections(projectId: number,filters?: SectionFilters): Promise<Section[]>
addSection(projectId: number,payload: AddSection): Promise<Section>
moveSection(sectionId: number,payload: MoveSection): Promise<Section>
updateSection(sectionId: number,payload: UpdateSection): Promise<Section>
deleteSection(sectionId: number): Promise<void>

Shared steps

getSharedStep(stepId: number): Promise<SharedStep>
getSharedSteps(projectId: number,filters?: SharedStepFilters): Promise<SharedStep[]>
getSharedStepHistory(stepId: number,filters?: Pagination): Promise<SharedStepHistory[]>{
addSharedStep(projectId: number,payload: AddSharedStep): Promise<SharedStep>
updateSharedStep(stepId: number,payload: UpdateSharedStep): Promise<SharedStep>
deleteSharedStep(stepId: number,payload?: DeleteSharedStep): Promise<void>

Statuses

getStatuses(): Promise<Status[]>
getCaseStatuses(filters?: Pagination): Promise<CaseStatus[]>

Suites

getSuite(suiteId: number): Promise<Suite>
getSuites(projectId: number): Promise<Suite[]>
addSuite(projectId: number,payload: AddSuite): Promise<Suite>
updateSuite(suiteId: number,payload: UpdateSuite): Promise<Suite>
deleteSuite(suiteId: number): Promise<void>

Templates

getTemplates(projectId: number): Promise<Template[]>

Tests

getTest(testId: number): Promise<Test>
getTests(runId: number,filters?: TestFilters): Promise<Test[]>

Users

getUser(userId: number): Promise<User>
getCurrentUser(): Promise<User>
getUserByEmail(email: string): Promise<User>
getUsers(filters?: UserFilters): Promise<User[]>
addUser(payload: AddUser): Promise<User>
updateUser(userId: number,payload: AddUser): Promise<User>

Variables

getVariables(projectId: number,filters?: Pagination): Promise<Variable[]>
addVariable(projectId: number,payload: AddVariable): Promise<Variable>
updateVariable(variableId: number,payload: AddVariable): Promise<Variable>
deleteVariable(variableId: number): Promise<void>

About

An API wrapper for TestRail with error handling and typing.

Topics

Resources

Stars

3 stars

Watchers

1 watching

Forks

Releases

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Repository files navigation

@dlenroc/testrail · NPM Version

Installation

npm install @dlenroc/testrail --save

Example

import{TestRail}from'@dlenroc/testrail';constapi=newTestRail({host: 'https://{organization}.testrail.net',username: '{username}',password: '{token/password}',});constprojects=awaitapi.getProjects();console.log(projects);

APIs

Attachments

addAttachmentToCase(caseId: number,payload: AddAttachment): Promise<CreatedAttachment>
addAttachmentToPlan(planId: number,payload: AddAttachment): Promise<CreatedAttachment>
addAttachmentToPlanEntry(planId: number,entryId: string,payload: AddAttachment): Promise<CreatedAttachment>
addAttachmentToResult(resultId: number,payload: AddAttachment): Promise<CreatedAttachment>
addAttachmentToRun(runId: number,payload: AddAttachment): Promise<CreatedAttachment>
getAttachmentsForCase(caseId: number,filters?: Pagination): Promise<AttachmentForCase[]>
getAttachmentsForPlan(planId: number,filters?: Pagination): Promise<AttachmentForPlan[]>
getAttachmentsForPlanEntry(planId: number,entryId: string): Promise<AttachmentForPlanEntry[]>
getAttachmentsForRun(runId: number,filters?: Pagination): Promise<AttachmentForRun[]>
getAttachmentsForTest(testId: number): Promise<AttachmentForTest[]>
getAttachment(attachmentId: string): Promise<Blob>
deleteAttachment(attachmentId: string): Promise<void>

BDDs

getBdd(caseId: number): Promise<Blob>
addBdd(sectionId: number,payload: AddAttachment): Promise<Case>

Cases

getCase(caseId: number): Promise<Case>
getCases(projectId: number,filters?: CaseFilters): Promise<Case[]>
getHistoryForCase(caseId: number,filters?: Pagination): Promise<CaseHistory[]>
addCase(sectionId: number,payload: AddCase): Promise<Case>
copyCasesToSection(sectionId: number,payload: CopyCasesToSection): Promise<void>
updateCase(caseId: number,payload: UpdateCase): Promise<Case>
updateCases(suiteId: number,payload: UpdateCases): Promise<void>
moveCasesToSection(sectionId: number,payload: MoveCasesToSection): Promise<void>
deleteCase(caseId: number): Promise<void>
deleteCases(suiteId: number,payload: DeleteCases): Promise<void>

Case Fields

getCaseFields(): Promise<CaseField[]>
addCaseField(payload: AddCaseField): Promise<CaseField>

Case Types

getCaseTypes(): Promise<CaseType[]>

Configurations

getConfigs(projectId: number): Promise<Config[]>
addConfigGroup(projectId: number,payload: AddConfigGroup): Promise<Config>
addConfig(configGroupId: number,payload: AddConfig): Promise<ConfigItem>
updateConfigGroup(configGroupId: number,payload: UpdateConfigGroup): Promise<Config>
updateConfig(configId: number,payload: UpdateConfig): Promise<ConfigItem>
deleteConfigGroup(configGroupId: number): Promise<void>
deleteConfig(configId: number): Promise<void>

Datasets

getDataset(datasetId: number): Promise<Dataset>
getDatasets(projectId: number,filters?: Pagination): Promise<Dataset[]>
addDataset(projectId: number,payload: AddDataset): Promise<Group>
updateDataset(datasetId: number,payload: AddDataset): Promise<Group>
deleteDataset(datasetId: number): Promise<void>

Groups

getGroup(groupId: number): Promise<Group>
getGroups(filters?: Pagination): Promise<Group[]>
addGroup(payload: AddGroup): Promise<Group>
updateGroup(groupId: number, payload: AddGroup): Promise<Group>
deleteGroup(groupId: number): Promise<void>

Milestones

getMilestone(milestoneId: number): Promise<Milestone>
getMilestones(projectId: number,filters?: MilestoneFilters): Promise<Milestone[]>
addMilestone(projectId: number,payload: AddMilestone): Promise<Milestone>
updateMilestone(milestoneId: number,payload: UpdateMilestone): Promise<Milestone>
deleteMilestone(milestoneId: number): Promise<void>

Roles

getRoles(filters?: Pagination): Promise<Role[]>

Plans

getPlan(planId: number): Promise<Plan>
getPlans(projectId: number,filters?: PlanFilters): Promise<PlanItem[]>
addPlan(projectId: number,payload: AddPlan): Promise<Plan>
addPlanEntry(planId: number,payload: AddPlanEntry): Promise<PlanEntry>
addRunToPlanEntry(planId: number,entryId: string,payload: AddRunToPlanEntry): Promise<PlanEntry>
updatePlan(planId: number,payload: UpdatePlan): Promise<Plan>
updatePlanEntry(planId: number,entryId: string,payload: UpdatePlanEntry): Promise<PlanEntry>
updateRunInPlanEntry(runId: number,payload: UpdateRunInPlanEntry): Promise<PlanEntry>
closePlan(planId: number): Promise<Plan>
deletePlan(planId: number): Promise<void>
deletePlanEntry(planId: number,entryId: string): Promise<void>
deleteRunFromPlanEntry(runId: number): Promise<void>

Priorities

getPriorities(): Promise<Priority[]>

Projects

getProject(projectId: number): Promise<Project>
getProjects(filters?: ProjectFilters): Promise<Project[]>
addProject(payload: AddProject): Promise<Project>
updateProject(projectId: number,payload: UpdateProject): Promise<Project>
deleteProject(projectId: number): Promise<void>

Reports

getReports(projectId: number): Promise<Report[]>
runReport(reportTemplateId: number): Promise<ReportUrls>

Results

getResults(testId: number,filters?: ResultFilters): Promise<Result[]>
getResultsForCase(runId: number,caseId: number,filters?: ResultFilters): Promise<Result[]>
getResultsForRun(runId: number,filters?: ResultForRunFilters): Promise<Result[]>
addResult(testId: number,payload: AddResult): Promise<Result>
addResultForCase(runId: number,caseId: number,payload: AddResult): Promise<Result>
addResults(runId: number,payload: AddResults): Promise<Result[]>
addResultsForCases(runId: number,payload: AddResultsForCases): Promise<Result[]>

Result Fields

getResultFields(): Promise<ResultField[]>

Runs

getRun(runId: number): Promise<Run>
getRuns(projectId: number,filters?: RunFilters): Promise<Run[]>
addRun(projectId: number,payload: AddRun): Promise<Run>
updateRun(runId: number,payload: UpdateRun): Promise<Run>
closeRun(runId: number): Promise<Run>
deleteRun(runId: number): Promise<void>

Sections

getSection(sectionId: number): Promise<Section>
getSections(projectId: number,filters?: SectionFilters): Promise<Section[]>
addSection(projectId: number,payload: AddSection): Promise<Section>
moveSection(sectionId: number,payload: MoveSection): Promise<Section>
updateSection(sectionId: number,payload: UpdateSection): Promise<Section>
deleteSection(sectionId: number): Promise<void>

Shared steps

getSharedStep(stepId: number): Promise<SharedStep>
getSharedSteps(projectId: number,filters?: SharedStepFilters): Promise<SharedStep[]>
getSharedStepHistory(stepId: number,filters?: Pagination): Promise<SharedStepHistory[]>{
addSharedStep(projectId: number,payload: AddSharedStep): Promise<SharedStep>
updateSharedStep(stepId: number,payload: UpdateSharedStep): Promise<SharedStep>
deleteSharedStep(stepId: number,payload?: DeleteSharedStep): Promise<void>

Statuses

getStatuses(): Promise<Status[]>
getCaseStatuses(filters?: Pagination): Promise<CaseStatus[]>

Suites

getSuite(suiteId: number): Promise<Suite>
getSuites(projectId: number): Promise<Suite[]>
addSuite(projectId: number,payload: AddSuite): Promise<Suite>
updateSuite(suiteId: number,payload: UpdateSuite): Promise<Suite>
deleteSuite(suiteId: number): Promise<void>

Templates

getTemplates(projectId: number): Promise<Template[]>

Tests

getTest(testId: number): Promise<Test>
getTests(runId: number,filters?: TestFilters): Promise<Test[]>

Users

getUser(userId: number): Promise<User>
getCurrentUser(): Promise<User>
getUserByEmail(email: string): Promise<User>
getUsers(filters?: UserFilters): Promise<User[]>
addUser(payload: AddUser): Promise<User>
updateUser(userId: number,payload: AddUser): Promise<User>

Variables

getVariables(projectId: number,filters?: Pagination): Promise<Variable[]>
addVariable(projectId: number,payload: AddVariable): Promise<Variable>
updateVariable(variableId: number,payload: AddVariable): Promise<Variable>
deleteVariable(variableId: number): Promise<void>

About

An API wrapper for TestRail with error handling and typing.

Topics

Resources

Stars

3 stars

Watchers

1 watching

Forks

Releases

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

Repository files navigation

@dlenroc/testrail · NPM Version

Installation

npm install @dlenroc/testrail --save

Example

import{TestRail}from'@dlenroc/testrail';constapi=newTestRail({host: 'https://{organization}.testrail.net',username: '{username}',password: '{token/password}',});constprojects=awaitapi.getProjects();console.log(projects);

APIs

Attachments

addAttachmentToCase(caseId: number,payload: AddAttachment): Promise<CreatedAttachment>
addAttachmentToPlan(planId: number,payload: AddAttachment): Promise<CreatedAttachment>
addAttachmentToPlanEntry(planId: number,entryId: string,payload: AddAttachment): Promise<CreatedAttachment>
addAttachmentToResult(resultId: number,payload: AddAttachment): Promise<CreatedAttachment>
addAttachmentToRun(runId: number,payload: AddAttachment): Promise<CreatedAttachment>
getAttachmentsForCase(caseId: number,filters?: Pagination): Promise<AttachmentForCase[]>
getAttachmentsForPlan(planId: number,filters?: Pagination): Promise<AttachmentForPlan[]>
getAttachmentsForPlanEntry(planId: number,entryId: string): Promise<AttachmentForPlanEntry[]>
getAttachmentsForRun(runId: number,filters?: Pagination): Promise<AttachmentForRun[]>
getAttachmentsForTest(testId: number): Promise<AttachmentForTest[]>
getAttachment(attachmentId: string): Promise<Blob>
deleteAttachment(attachmentId: string): Promise<void>

BDDs

getBdd(caseId: number): Promise<Blob>
addBdd(sectionId: number,payload: AddAttachment): Promise<Case>

Cases

getCase(caseId: number): Promise<Case>
getCases(projectId: number,filters?: CaseFilters): Promise<Case[]>
getHistoryForCase(caseId: number,filters?: Pagination): Promise<CaseHistory[]>
addCase(sectionId: number,payload: AddCase): Promise<Case>
copyCasesToSection(sectionId: number,payload: CopyCasesToSection): Promise<void>
updateCase(caseId: number,payload: UpdateCase): Promise<Case>
updateCases(suiteId: number,payload: UpdateCases): Promise<void>
moveCasesToSection(sectionId: number,payload: MoveCasesToSection): Promise<void>
deleteCase(caseId: number): Promise<void>
deleteCases(suiteId: number,payload: DeleteCases): Promise<void>

Case Fields

getCaseFields(): Promise<CaseField[]>
addCaseField(payload: AddCaseField): Promise<CaseField>

Case Types

getCaseTypes(): Promise<CaseType[]>

Configurations

getConfigs(projectId: number): Promise<Config[]>
addConfigGroup(projectId: number,payload: AddConfigGroup): Promise<Config>
addConfig(configGroupId: number,payload: AddConfig): Promise<ConfigItem>
updateConfigGroup(configGroupId: number,payload: UpdateConfigGroup): Promise<Config>
updateConfig(configId: number,payload: UpdateConfig): Promise<ConfigItem>
deleteConfigGroup(configGroupId: number): Promise<void>
deleteConfig(configId: number): Promise<void>

Datasets

getDataset(datasetId: number): Promise<Dataset>
getDatasets(projectId: number,filters?: Pagination): Promise<Dataset[]>
addDataset(projectId: number,payload: AddDataset): Promise<Group>
updateDataset(datasetId: number,payload: AddDataset): Promise<Group>
deleteDataset(datasetId: number): Promise<void>

Groups

getGroup(groupId: number): Promise<Group>
getGroups(filters?: Pagination): Promise<Group[]>
addGroup(payload: AddGroup): Promise<Group>
updateGroup(groupId: number, payload: AddGroup): Promise<Group>
deleteGroup(groupId: number): Promise<void>

Milestones

getMilestone(milestoneId: number): Promise<Milestone>
getMilestones(projectId: number,filters?: MilestoneFilters): Promise<Milestone[]>
addMilestone(projectId: number,payload: AddMilestone): Promise<Milestone>
updateMilestone(milestoneId: number,payload: UpdateMilestone): Promise<Milestone>
deleteMilestone(milestoneId: number): Promise<void>

Roles

getRoles(filters?: Pagination): Promise<Role[]>

Plans

getPlan(planId: number): Promise<Plan>
getPlans(projectId: number,filters?: PlanFilters): Promise<PlanItem[]>
addPlan(projectId: number,payload: AddPlan): Promise<Plan>
addPlanEntry(planId: number,payload: AddPlanEntry): Promise<PlanEntry>
addRunToPlanEntry(planId: number,entryId: string,payload: AddRunToPlanEntry): Promise<PlanEntry>
updatePlan(planId: number,payload: UpdatePlan): Promise<Plan>
updatePlanEntry(planId: number,entryId: string,payload: UpdatePlanEntry): Promise<PlanEntry>
updateRunInPlanEntry(runId: number,payload: UpdateRunInPlanEntry): Promise<PlanEntry>
closePlan(planId: number): Promise<Plan>
deletePlan(planId: number): Promise<void>
deletePlanEntry(planId: number,entryId: string): Promise<void>
deleteRunFromPlanEntry(runId: number): Promise<void>

Priorities

getPriorities(): Promise<Priority[]>

Projects

getProject(projectId: number): Promise<Project>
getProjects(filters?: ProjectFilters): Promise<Project[]>
addProject(payload: AddProject): Promise<Project>
updateProject(projectId: number,payload: UpdateProject): Promise<Project>
deleteProject(projectId: number): Promise<void>

Reports

getReports(projectId: number): Promise<Report[]>
runReport(reportTemplateId: number): Promise<ReportUrls>

Results

getResults(testId: number,filters?: ResultFilters): Promise<Result[]>
getResultsForCase(runId: number,caseId: number,filters?: ResultFilters): Promise<Result[]>
getResultsForRun(runId: number,filters?: ResultForRunFilters): Promise<Result[]>
addResult(testId: number,payload: AddResult): Promise<Result>
addResultForCase(runId: number,caseId: number,payload: AddResult): Promise<Result>
addResults(runId: number,payload: AddResults): Promise<Result[]>
addResultsForCases(runId: number,payload: AddResultsForCases): Promise<Result[]>

Result Fields

getResultFields(): Promise<ResultField[]>

Runs

getRun(runId: number): Promise<Run>
getRuns(projectId: number,filters?: RunFilters): Promise<Run[]>
addRun(projectId: number,payload: AddRun): Promise<Run>
updateRun(runId: number,payload: UpdateRun): Promise<Run>
closeRun(runId: number): Promise<Run>
deleteRun(runId: number): Promise<void>

Sections

getSection(sectionId: number): Promise<Section>
getSections(projectId: number,filters?: SectionFilters): Promise<Section[]>
addSection(projectId: number,payload: AddSection): Promise<Section>
moveSection(sectionId: number,payload: MoveSection): Promise<Section>
updateSection(sectionId: number,payload: UpdateSection): Promise<Section>
deleteSection(sectionId: number): Promise<void>

Shared steps

getSharedStep(stepId: number): Promise<SharedStep>
getSharedSteps(projectId: number,filters?: SharedStepFilters): Promise<SharedStep[]>
getSharedStepHistory(stepId: number,filters?: Pagination): Promise<SharedStepHistory[]>{
addSharedStep(projectId: number,payload: AddSharedStep): Promise<SharedStep>
updateSharedStep(stepId: number,payload: UpdateSharedStep): Promise<SharedStep>
deleteSharedStep(stepId: number,payload?: DeleteSharedStep): Promise<void>

Statuses

getStatuses(): Promise<Status[]>
getCaseStatuses(filters?: Pagination): Promise<CaseStatus[]>

Suites

getSuite(suiteId: number): Promise<Suite>
getSuites(projectId: number): Promise<Suite[]>
addSuite(projectId: number,payload: AddSuite): Promise<Suite>
updateSuite(suiteId: number,payload: UpdateSuite): Promise<Suite>
deleteSuite(suiteId: number): Promise<void>

Templates

getTemplates(projectId: number): Promise<Template[]>

Tests

getTest(testId: number): Promise<Test>
getTests(runId: number,filters?: TestFilters): Promise<Test[]>

Users

getUser(userId: number): Promise<User>
getCurrentUser(): Promise<User>
getUserByEmail(email: string): Promise<User>
getUsers(filters?: UserFilters): Promise<User[]>
addUser(payload: AddUser): Promise<User>
updateUser(userId: number,payload: AddUser): Promise<User>

Variables

getVariables(projectId: number,filters?: Pagination): Promise<Variable[]>
addVariable(projectId: number,payload: AddVariable): Promise<Variable>
updateVariable(variableId: number,payload: AddVariable): Promise<Variable>
deleteVariable(variableId: number): Promise<void>

About

An API wrapper for TestRail with error handling and typing.

Topics

Resources

Stars

3 stars

Watchers

1 watching

Forks

Releases

Contributors

Languages