@testmonitor/ts-reporter-client
Version:
A convenient TypeScript wrapper for the TestMonitor reporter API endpoints. It can be used in both TypeScript and JavaScript.
242 lines (241 loc) • 6.05 kB
TypeScript
/**
*
* @export
* @interface TestRun
*/
export interface TestRun {
/**
* The resource identifier. Defaults to integer.
* @type {number}
* @memberof TestRun
*/
id: number;
/**
* A resource string.
* @type {string}
* @memberof TestRun
*/
name?: string;
/**
* The test run code.
* @type {string}
* @memberof TestRun
*/
code: string;
/**
* Denotes if this test run has a high priority.
* @type {boolean}
* @memberof TestRun
*/
priority?: boolean;
/**
* A resource datetime string.
* @type {string}
* @memberof TestRun
*/
starts_at?: string;
/**
* A resource datetime string.
* @type {string}
* @memberof TestRun
*/
ends_at?: string;
/**
* A resource datetime string.
* @type {string}
* @memberof TestRun
*/
completed_at?: string;
/**
* The resource identifier. Defaults to integer.
* @type {number}
* @memberof TestRun
*/
milestone_id?: number;
/**
* The milestone where this test run belongs to.
* @type {object}
* @memberof TestRun
*/
milestone?: object | null;
/**
* The issues created for this test run.
* @type {Array<any>}
* @memberof TestRun
*/
issues?: Array<any> | null;
/**
* The total number of issues created for this test run.
* @type {number}
* @memberof TestRun
*/
issues_count?: number | null;
/**
* The total number of issues with status \'open\' related to this test run.
* @type {number}
* @memberof TestRun
*/
issues_open_count?: number | null;
/**
* The total number of issues with status \'in progress\' related to this test run.
* @type {number}
* @memberof TestRun
*/
issues_in_progress_count?: number | null;
/**
* The total number of issues with status \'resolved\' related to this test run.
* @type {number}
* @memberof TestRun
*/
issues_resolved_count?: number | null;
/**
* The total number of issues with status \'retest\' related to this test run.
* @type {number}
* @memberof TestRun
*/
issues_retest_count?: number | null;
/**
* The total number of issues with status \'closed\' related to this test run.
* @type {number}
* @memberof TestRun
*/
issues_closed_count?: number | null;
/**
* The total number of issues with a custom status related to this test run.
* @type {number}
* @memberof TestRun
*/
issues_other_count?: number | null;
/**
* The most severe outcome calculated for this test run.
* @type {object}
* @memberof TestRun
*/
outcome?: object | null;
/**
* The resource identifier. Defaults to integer.
* @type {number}
* @memberof TestRun
*/
test_environment_id?: number;
/**
* The environment where this test run belongs to.
* @type {object}
* @memberof TestRun
*/
test_environment?: object | null;
/**
* The test cases for this test run.
* @type {Array<any>}
* @memberof TestRun
*/
test_cases?: Array<any> | null;
/**
* The number of test cases for this test run.
* @type {number}
* @memberof TestRun
*/
test_cases_count?: number | null;
/**
* The test results created for this test run.
* @type {Array<any>}
* @memberof TestRun
*/
test_results?: Array<any> | null;
/**
* The total number of test results created for this test run.
* @type {number}
* @memberof TestRun
*/
test_results_count?: number | null;
/**
* The total number of test results that are marked as viewed for this test run.
* @type {number}
* @memberof TestRun
*/
test_results_viewed_count?: number | null;
/**
* The total number of test results that not is marked as draft.
* @type {number}
* @memberof TestRun
*/
valid_test_results_count?: number | null;
/**
* The total number of test results that is created by the logged in user.
* @type {number}
* @memberof TestRun
*/
my_test_results_count?: number | null;
/**
* The users (testers) assigned to this test run.
* @type {Array<any>}
* @memberof TestRun
*/
users?: Array<any> | null;
/**
* The total number of users (testers) assigned to this test run.
* @type {number}
* @memberof TestRun
*/
users_count?: number | null;
/**
* The tags assigned to this test run.
* @type {Array<string>}
* @memberof TestRun
*/
tags?: Array<string>;
/**
* The total sum of all durations of the assigned test cases.
* @type {number}
* @memberof TestRun
*/
duration?: number | null;
/**
* All available API endpoints for this record.
* @type {object}
* @memberof TestRun
*/
endpoints?: object;
/**
* All available application url\'s for this record.
* @type {object}
* @memberof TestRun
*/
links?: object;
/**
* Read-only timestamp, automatically assigned on back-end.
* @type {string}
* @memberof TestRun
*/
created_at?: string;
/**
* Read-only timestamp, automatically assigned on back-end.
* @type {string}
* @memberof TestRun
*/
updated_at?: string;
/**
* Read-only timestamp, automatically assigned on back-end.
* @type {string}
* @memberof TestRun
*/
deleted_at?: string | null;
/**
* User who created this test run.
* @type {object}
* @memberof TestRun
*/
created_by?: object | null;
/**
* User who last updated this test run.
* @type {object}
* @memberof TestRun
*/
updated_by?: object | null;
/**
* User who deleted this test run.
* @type {object}
* @memberof TestRun
*/
deleted_by?: object | null;
}