@rbaileysr/zephyr-managed-api 1.0.0

package/dist/types.d.ts

@@ -0,0 +1,1353 @@
+/**
+ * Zephyr Cloud API Type Definitions
+ *
+ * Complete TypeScript type definitions extracted from Zephyr Cloud REST API v2 OpenAPI specification.
+ * All types are based on the official API schema.
+ */
+/**
+ * Entity ID - minimum value 1
+ */
+export type EntityId = number;
+/**
+ * Entity name - non-empty string
+ */
+export type EntityName = string;
+/**
+ * Resource ID with self link
+ */
+export interface ResourceId {
+    id: EntityId;
+}
+/**
+ * Link to resource endpoint
+ */
+export interface Link {
+    self: string;
+}
+/**
+ * Project link (ID and self link)
+ */
+export interface ProjectLink extends ResourceId, Link {
+}
+/**
+ * Created resource response
+ */
+export interface CreatedResource {
+    id: EntityId;
+    self: string;
+}
+/**
+ * Created resource with key
+ */
+export interface KeyedCreatedResource extends CreatedResource {
+    key: string;
+}
+/**
+ * Created on timestamp (read-only, ISO 8601 format)
+ */
+export type CreatedOn = string;
+/**
+ * Objective description
+ */
+export type Objective = string | null;
+/**
+ * Precondition description
+ */
+export type Precondition = string | null;
+/**
+ * Entity description
+ */
+export type EntityDescription = string | null;
+/**
+ * Labels array
+ */
+export type Labels = string[];
+/**
+ * Index value (minimum 0)
+ */
+export type Index = number;
+/**
+ * Entity color (hexadecimal format)
+ */
+export type EntityColor = string;
+/**
+ * Project key pattern: ([A-Z][A-Z_0-9]+)
+ */
+export type ProjectKey = string;
+/**
+ * Priority name (1-255 characters)
+ */
+export type PriorityName = string;
+/**
+ * Status name (1-255 characters)
+ */
+export type StatusName = string;
+/**
+ * Priority description (1-255 characters)
+ */
+export type PriorityDescription = string;
+/**
+ * Status description (1-255 characters)
+ */
+export type StatusDescription = string;
+/**
+ * Environment name (1-255 characters)
+ */
+export type EnvironmentName = string;
+/**
+ * Environment description (1-255 characters)
+ */
+export type EnvironmentDescription = string;
+/**
+ * Jira user account ID
+ */
+export type JiraUserAccountId = string | null;
+/**
+ * Jira component (ID and self link)
+ */
+export interface JiraComponent extends ResourceId, Link {
+}
+/**
+ * Jira user link
+ */
+export interface JiraUserLink {
+    accountId: JiraUserAccountId;
+    self: string;
+}
+/**
+ * Jira project version (ID and self link)
+ */
+export interface JiraProjectVersion extends ResourceId, Link {
+}
+/**
+ * Jira project version ID (minimum 1)
+ */
+export type JiraProjectVersionId = number;
+/**
+ * Custom fields - flexible key-value pairs
+ * Multi-line text fields support HTML with <br> tags
+ * Dates should be in format 'yyyy-MM-dd'
+ * Users should have values of Jira User Account IDs
+ */
+export type CustomFields = Record<string, unknown>;
+/**
+ * Paginated list base structure
+ */
+export interface PagedList {
+    next: string | null;
+    startAt: number;
+    maxResults: number;
+    total: number;
+    isLast: boolean;
+}
+/**
+ * Cursor-paginated list base structure
+ */
+export interface CursorPagedList {
+    next: string | null;
+    nextStartAtId: number | null;
+    limit: number;
+}
+/**
+ * Pagination options for list operations
+ */
+export interface PaginationOptions {
+    maxResults?: number;
+    startAt?: number;
+    limit?: number;
+    startAtId?: number;
+}
+/**
+ * Standard error response
+ */
+export interface Error {
+    errorCode: number;
+    message: string;
+}
+/**
+ * Test result not found or user access error
+ */
+export interface TestResultNotFoundOrUserAccessError {
+    errorCode: number;
+    message: string;
+}
+/**
+ * Test execution immutable error
+ */
+export interface TestExecutionImmutableError {
+    errorCode: number;
+    message: string;
+}
+/**
+ * Test step number mismatch error
+ */
+export interface TestStepNumberMismatchUnprocessableError {
+    errorCode: number;
+    message: string;
+}
+/**
+ * Test step test data unprocessable error
+ */
+export interface TestStepTestDataUnprocessableError {
+    errorCode: number;
+    message: string;
+}
+/**
+ * Priority not found or user access error
+ */
+export interface PriorityNotFoundOrUserAccessError {
+    errorCode: number;
+    message: string;
+}
+/**
+ * Status not found or user access error
+ */
+export interface StatusNotFoundOrUserAccessError {
+    errorCode: number;
+    message: string;
+}
+/**
+ * Environment not found or user access error
+ */
+export interface EnvironmentNotFoundOrUserAccessError {
+    errorCode: number;
+    message: string;
+}
+/**
+ * Duplicated name error
+ */
+export interface DuplicatedNameError {
+    errorCode: number;
+    message: string;
+}
+/**
+ * Empty name error
+ */
+export interface EmptyNameError {
+    errorCode: number;
+    message: string;
+}
+/**
+ * User access error
+ */
+export interface UserAccessError {
+    errorCode: number;
+    message: string;
+}
+/**
+ * Project key mismatch error
+ */
+export interface ProjectKeyMismatchError {
+    errorCode: number;
+    message: string;
+}
+/**
+ * Index value error
+ */
+export interface IndexValueError {
+    errorCode: number;
+    message: string;
+}
+/**
+ * Link type enum
+ */
+export type LinkType = 'COVERAGE' | 'BLOCKS' | 'RELATED';
+/**
+ * Issue link input
+ */
+export interface IssueLinkInput {
+    issueId: number;
+}
+/**
+ * Issue link
+ */
+export interface IssueLink extends IssueLinkInput {
+    self: string;
+    id: EntityId;
+    target: string;
+    type: LinkType;
+}
+/**
+ * Issue link list
+ */
+export type IssueLinkList = IssueLink[];
+/**
+ * Web link input
+ */
+export interface WebLinkInput {
+    url: string;
+    description?: string;
+}
+/**
+ * Web link input with mandatory description
+ */
+export interface WebLinkInputWithMandatoryDescription extends WebLinkInput {
+    description: string;
+    url: string;
+}
+/**
+ * Web link
+ */
+export interface WebLink extends WebLinkInput {
+    self: string;
+    id: EntityId;
+    type: LinkType;
+}
+/**
+ * Web link list
+ */
+export type WebLinkList = WebLink[];
+/**
+ * Priority link
+ */
+export interface PriorityLink extends ResourceId, Link {
+}
+/**
+ * Status link
+ */
+export interface StatusLink extends ResourceId, Link {
+}
+/**
+ * Folder link
+ */
+export interface FolderLink extends ResourceId, Link {
+}
+/**
+ * Test case test script link
+ */
+export interface TestCaseTestScriptLink extends Link {
+}
+/**
+ * Test case link list
+ */
+export interface TestCaseLinkList extends Link {
+    issues: IssueLinkList;
+    webLinks: WebLinkList;
+}
+/**
+ * Test case
+ */
+export interface TestCase {
+    id: EntityId;
+    key: string;
+    name: EntityName;
+    project: ProjectLink;
+    priority: PriorityLink;
+    status: StatusLink;
+    createdOn?: CreatedOn;
+    objective?: Objective;
+    precondition?: Precondition;
+    estimatedTime?: number | null;
+    labels?: Labels;
+    component?: JiraComponent;
+    folder?: FolderLink;
+    owner?: JiraUserLink;
+    testScript?: TestCaseTestScriptLink;
+    customFields?: CustomFields;
+    links?: TestCaseLinkList;
+}
+/**
+ * Test case list (paginated)
+ */
+export interface TestCaseList extends PagedList {
+    values: TestCase[];
+}
+/**
+ * Cursor-paginated test case list
+ */
+export interface CursorPagedTestCaseList extends CursorPagedList {
+    values: TestCase[];
+}
+/**
+ * Test case input (create)
+ */
+export interface TestCaseInput {
+    projectKey: ProjectKey;
+    name: EntityName;
+    objective?: Objective;
+    precondition?: Precondition;
+    estimatedTime?: number;
+    componentId?: number;
+    priorityName?: PriorityName;
+    statusName?: StatusName;
+    folderId?: number;
+    ownerId?: JiraUserAccountId;
+    labels?: Labels;
+    customFields?: CustomFields;
+}
+/**
+ * Test case version link
+ */
+export interface TestCaseVersionLink extends Link {
+    id: EntityId;
+}
+/**
+ * Test case version link list (paginated)
+ */
+export interface TestCaseVersionLinkList extends PagedList {
+    values: TestCaseVersionLink[];
+}
+/**
+ * Test script type
+ */
+export type TestScriptType = 'plain' | 'bdd';
+/**
+ * Test script input
+ */
+export interface TestScriptInput {
+    type: TestScriptType;
+    text: string;
+}
+/**
+ * Test script
+ */
+export interface TestScript extends TestScriptInput {
+    id: EntityId;
+}
+/**
+ * Test step inline definition
+ */
+export interface TestStepInline {
+    description: string;
+    testData?: string;
+    expectedResult: string;
+    customFields?: CustomFields;
+    reflectRef?: string;
+}
+/**
+ * Test step test case parameters
+ */
+export interface TestStepTestCaseParameters {
+    name: string;
+    type: 'MANUAL_INPUT' | 'DEFAULT_VALUE';
+    value: string;
+}
+/**
+ * Test step test case
+ */
+export interface TestStepTestCase extends Link {
+    testCaseKey: string;
+    parameters?: TestStepTestCaseParameters[];
+}
+/**
+ * Test step (inline or test case)
+ */
+export interface TestStep {
+    inline?: TestStepInline;
+    testCase?: TestStepTestCase;
+}
+/**
+ * Test steps input mode
+ */
+export type TestStepsInputMode = 'APPEND' | 'OVERWRITE';
+/**
+ * Test steps input
+ */
+export interface TestStepsInput {
+    mode: TestStepsInputMode;
+    items: TestStep[];
+}
+/**
+ * Test steps list (paginated)
+ */
+export interface TestStepsList extends PagedList {
+    values: TestStep[];
+}
+/**
+ * Test case key and version
+ */
+export interface TestCaseKeyAndVersion extends Link {
+    key: string;
+    version: number;
+}
+/**
+ * Test case key and version list
+ */
+export type TestCaseKeyAndVersionList = TestCaseKeyAndVersion[];
+/**
+ * Key and version
+ */
+export interface KeyAndVersion {
+    key: string;
+    version: number;
+}
+/**
+ * Test cycle update planned start date
+ */
+export type TestCycleUpdatePlannedStartDate = string | null;
+/**
+ * Test cycle update planned end date
+ */
+export type TestCycleUpdatePlannedEndDate = string | null;
+/**
+ * Planned start date
+ */
+export type PlannedStartDate = string;
+/**
+ * Planned end date
+ */
+export type PlannedEndDate = string;
+/**
+ * Test cycle test plan link
+ */
+export interface TestCycleTestPlanLink {
+    id: EntityId;
+    self: string;
+    testPlanId: number;
+    type: LinkType;
+    target: string;
+}
+/**
+ * Test cycle test plan link list
+ */
+export type TestCycleTestPlanLinkList = TestCycleTestPlanLink[];
+/**
+ * Test cycle link list
+ */
+export interface TestCycleLinkList extends Link {
+    issues: IssueLinkList;
+    webLinks: WebLinkList;
+    testPlans?: TestCycleTestPlanLinkList;
+}
+/**
+ * Test cycle
+ */
+export interface TestCycle {
+    id: EntityId;
+    key: string;
+    name: EntityName;
+    project: ProjectLink;
+    status: StatusLink;
+    jiraProjectVersion?: JiraProjectVersion;
+    folder?: FolderLink;
+    description?: EntityDescription;
+    plannedStartDate?: TestCycleUpdatePlannedStartDate;
+    plannedEndDate?: TestCycleUpdatePlannedEndDate;
+    owner?: JiraUserLink;
+    customFields?: CustomFields;
+    links?: TestCycleLinkList;
+}
+/**
+ * Test cycle list (paginated)
+ */
+export interface TestCycleList extends PagedList {
+    values: TestCycle[];
+}
+/**
+ * Test cycle input (create)
+ */
+export interface TestCycleInput {
+    projectKey: ProjectKey;
+    name: EntityName;
+    description?: EntityDescription;
+    plannedStartDate?: PlannedStartDate;
+    plannedEndDate?: PlannedEndDate;
+    jiraProjectVersion?: JiraProjectVersionId;
+    statusName?: StatusName;
+    folderId?: number;
+    ownerId?: JiraUserAccountId;
+    customFields?: CustomFields;
+}
+/**
+ * Test cycle link
+ */
+export interface TestCycleLink extends Link {
+    id: EntityId;
+}
+/**
+ * Test cycle ID
+ */
+export interface TestCycleId extends ResourceId, Link {
+}
+/**
+ * Test cycle ID list
+ */
+export type TestCycleIdList = TestCycleId[];
+/**
+ * Test plan test cycle link
+ */
+export interface TestPlanTestCycleLink extends ResourceId, Link {
+    testCycleId: EntityId;
+    type: LinkType;
+    target: string;
+}
+/**
+ * Test plan cycle link list
+ */
+export type TestPlanCycleLinkList = TestPlanTestCycleLink[];
+/**
+ * Test plan link structure
+ */
+export interface TestPlanLinks {
+    webLinks: WebLinkList;
+    issues: IssueLinkList;
+    testCycles: TestPlanCycleLinkList;
+}
+/**
+ * Test plan
+ */
+export interface TestPlan {
+    id: EntityId;
+    key: string;
+    name: EntityName;
+    project: ProjectLink;
+    status: StatusLink;
+    objective?: Objective;
+    folder?: FolderLink;
+    owner?: JiraUserLink;
+    customFields?: CustomFields;
+    labels?: Labels;
+    links?: TestPlanLinks;
+}
+/**
+ * Test plan list (paginated)
+ */
+export interface TestPlanList extends PagedList {
+    values: TestPlan[];
+}
+/**
+ * Test plan input (create)
+ */
+export interface TestPlanInput {
+    projectKey: ProjectKey;
+    name: EntityName;
+    objective?: Objective;
+    folderId?: number;
+    statusName?: StatusName;
+    ownerId?: JiraUserAccountId;
+    labels?: Labels;
+    customFields?: CustomFields;
+}
+/**
+ * Test plan test cycle link input
+ */
+export interface TestPlanTestCycleLinkInput {
+    testCycleIdOrKey: string;
+}
+/**
+ * Test plan ID
+ */
+export interface TestPlanId extends ResourceId, Link {
+}
+/**
+ * Test plan ID list
+ */
+export type TestPlanIdList = TestPlanId[];
+/**
+ * Actual end date
+ */
+export type ActualEndDate = string | null;
+/**
+ * Comment
+ */
+export type Comment = string | null;
+/**
+ * Test execution link list
+ */
+export interface TestExecutionLinkList extends Link {
+    issues: IssueLinkList;
+}
+/**
+ * Test execution
+ */
+export interface TestExecution {
+    id: EntityId;
+    key?: string;
+    project: ProjectLink;
+    testCase: TestCaseVersionLink;
+    testExecutionStatus: StatusLink;
+    environment?: EnvironmentLink;
+    jiraProjectVersion?: JiraProjectVersion;
+    actualEndDate?: ActualEndDate;
+    estimatedTime?: number | null;
+    executionTime?: number | null;
+    executedById?: JiraUserAccountId;
+    assignedToId?: JiraUserAccountId;
+    comment?: Comment;
+    automated?: boolean;
+    testCycle?: TestCycleLink;
+    customFields?: CustomFields;
+    links?: TestExecutionLinkList;
+}
+/**
+ * Test execution list (paginated)
+ */
+export interface TestExecutionList extends PagedList {
+    values: TestExecution[];
+}
+/**
+ * Cursor-paginated test execution list
+ */
+export interface CursorPagedTestExecutionList extends CursorPagedList {
+    values: TestExecution[];
+}
+/**
+ * Test execution input (create)
+ */
+export interface TestExecutionInput {
+    projectKey: ProjectKey;
+    testCaseKey: string;
+    testCycleKey: string;
+    statusName: StatusName;
+    testScriptResults?: TestScriptResultInput[];
+    environmentName?: string;
+    actualEndDate?: ActualEndDate;
+    executionTime?: number;
+    executedById?: JiraUserAccountId;
+    assignedToId?: JiraUserAccountId;
+    comment?: Comment;
+    customFields?: CustomFields;
+}
+/**
+ * Test script result input
+ */
+export interface TestScriptResultInput {
+    statusName: StatusName;
+    actualEndDate?: ActualEndDate;
+    actualResult?: string;
+}
+/**
+ * Test execution update
+ */
+export interface TestExecutionUpdate {
+    statusName?: StatusName;
+    environmentName?: string;
+    actualEndDate?: ActualEndDate;
+    executionTime?: number;
+    executedById?: JiraUserAccountId;
+    assignedToId?: JiraUserAccountId;
+    comment?: Comment;
+}
+/**
+ * Test execution step inline
+ */
+export interface TestExecutionStepInline {
+    description: string;
+    testData?: string;
+    expectedResult: string;
+    actualResult?: string;
+    testDataRowNumber?: number;
+    reflectRef?: string;
+    status?: StatusLink;
+}
+/**
+ * Test execution step
+ */
+export interface TestExecutionStep {
+    inline?: TestExecutionStepInline;
+}
+/**
+ * Test execution test steps list (paginated)
+ */
+export interface TestExecutionTestStepsList extends PagedList {
+    values: TestExecutionStep[];
+}
+/**
+ * Actual result
+ */
+export type ActualResult = string;
+/**
+ * Test step update
+ */
+export interface TestStepUpdate {
+    actualResult?: ActualResult;
+    statusName?: StatusName;
+}
+/**
+ * Test steps update
+ */
+export interface TestStepsUpdate {
+    steps: TestStepUpdate[];
+}
+/**
+ * Test execution ID
+ */
+export interface TestExecutionId extends ResourceId, Link {
+}
+/**
+ * Test execution ID list
+ */
+export type TestExecutionIdList = TestExecutionId[];
+/**
+ * Project
+ */
+export interface Project {
+    id: number;
+    jiraProjectId: number;
+    key: string;
+    enabled: boolean;
+}
+/**
+ * Project list (paginated)
+ */
+export interface ProjectList extends PagedList {
+    values: Project[];
+}
+/**
+ * Folder type
+ */
+export type FolderType = 'TEST_CASE' | 'TEST_PLAN' | 'TEST_CYCLE';
+/**
+ * Folder
+ */
+export interface Folder {
+    id: EntityId;
+    parentId: EntityId;
+    name: EntityName;
+    index: Index;
+    folderType: FolderType;
+    project: ProjectLink;
+}
+/**
+ * Folder list (paginated)
+ */
+export interface FolderList extends PagedList {
+    values: Folder[];
+}
+/**
+ * Folder input (create)
+ */
+export interface FolderInput {
+    projectKey: ProjectKey;
+    name: string;
+    folderType: FolderType;
+    parentId?: number | null;
+}
+/**
+ * Option value base
+ */
+export interface OptionValue {
+    id: EntityId;
+    project: ProjectLink;
+    name: EntityName;
+    description?: EntityDescription;
+    index: Index;
+}
+/**
+ * Priority
+ */
+export interface Priority extends OptionValue {
+    color?: EntityColor;
+    default: boolean;
+}
+/**
+ * Priority list (paginated)
+ */
+export interface PriorityList extends PagedList {
+    values: Priority[];
+}
+/**
+ * Create priority input
+ */
+export interface CreatePriorityInput {
+    projectKey: ProjectKey;
+    name: PriorityName;
+    description?: PriorityDescription;
+    color?: EntityColor;
+}
+/**
+ * Update priority input
+ */
+export interface UpdatePriorityInput {
+    id: EntityId;
+    project: ProjectLink;
+    name: PriorityName;
+    description?: PriorityDescription;
+    index: Index;
+    default: boolean;
+    color?: EntityColor;
+}
+/**
+ * Status type
+ */
+export type StatusType = 'TEST_CASE' | 'TEST_PLAN' | 'TEST_CYCLE' | 'TEST_EXECUTION';
+/**
+ * Status
+ */
+export interface Status extends OptionValue {
+    color?: string;
+    archived: boolean;
+    default: boolean;
+}
+/**
+ * Status list (paginated)
+ */
+export interface StatusList extends PagedList {
+    values: Status[];
+}
+/**
+ * Create status input
+ */
+export interface CreateStatusInput {
+    projectKey: ProjectKey;
+    name: StatusName;
+    type: StatusType;
+    description?: StatusDescription;
+    color?: EntityColor;
+}
+/**
+ * Update status input
+ */
+export interface UpdateStatusInput {
+    id: EntityId;
+    project: ProjectLink;
+    name: StatusName;
+    description?: StatusDescription;
+    index: Index;
+    archived: boolean;
+    default: boolean;
+    color?: EntityColor;
+}
+/**
+ * Environment link
+ */
+export interface EnvironmentLink extends ResourceId, Link {
+}
+/**
+ * Environment
+ */
+export interface Environment extends OptionValue {
+    archived: boolean;
+}
+/**
+ * Environment list (paginated)
+ */
+export interface EnvironmentList extends PagedList {
+    values: Environment[];
+}
+/**
+ * Create environment input
+ */
+export interface CreateEnvironmentInput {
+    projectKey: ProjectKey;
+    name: EnvironmentName;
+    description?: EnvironmentDescription;
+}
+/**
+ * Update environment input
+ */
+export interface UpdateEnvironmentInput {
+    id: EntityId;
+    project: ProjectLink;
+    name: EnvironmentName;
+    description?: EnvironmentDescription;
+    index: Index;
+}
+/**
+ * Automation test cycle input
+ */
+export interface AutomationTestCycleInput {
+    name?: EntityName;
+    description?: EntityDescription;
+    jiraProjectVersion?: JiraProjectVersionId;
+    folderId?: number;
+    customFields?: CustomFields;
+}
+/**
+ * Automation test cycle
+ */
+export interface AutomationTestCycle {
+    id: number;
+    url: string;
+    key: string;
+}
+/**
+ * Automation result
+ */
+export interface AutomationResult {
+    testCycle: AutomationTestCycle;
+}
+/**
+ * List test cases options
+ */
+export interface ListTestCasesOptions extends PaginationOptions {
+    projectKey?: ProjectKey;
+    folderId?: number;
+}
+/**
+ * Get test case options
+ */
+export interface GetTestCaseOptions {
+    testCaseKey: string;
+}
+/**
+ * Create test case request
+ */
+export interface CreateTestCaseRequest {
+    body: TestCaseInput;
+}
+/**
+ * Update test case request
+ */
+export interface UpdateTestCaseRequest {
+    testCaseKey: string;
+    body: TestCase;
+}
+/**
+ * List test case versions options
+ */
+export interface ListTestCaseVersionsOptions extends PaginationOptions {
+    testCaseKey: string;
+}
+/**
+ * Get test case version options
+ */
+export interface GetTestCaseVersionOptions {
+    testCaseKey: string;
+    version: number;
+}
+/**
+ * Create test case test script request
+ */
+export interface CreateTestCaseTestScriptRequest {
+    testCaseKey: string;
+    body: TestScriptInput;
+}
+/**
+ * Create test case test steps request
+ */
+export interface CreateTestCaseTestStepsRequest {
+    testCaseKey: string;
+    body: TestStepsInput;
+}
+/**
+ * Create test case issue link request
+ */
+export interface CreateTestCaseIssueLinkRequest {
+    testCaseKey: string;
+    body: IssueLinkInput;
+}
+/**
+ * Create test case web link request
+ */
+export interface CreateTestCaseWebLinkRequest {
+    testCaseKey: string;
+    body: WebLinkInput;
+}
+/**
+ * List test cycles options
+ */
+export interface ListTestCyclesOptions extends PaginationOptions {
+    projectKey?: ProjectKey;
+    folderId?: number;
+    jiraProjectVersionId?: number;
+}
+/**
+ * Get test cycle options
+ */
+export interface GetTestCycleOptions {
+    testCycleIdOrKey: string | number;
+}
+/**
+ * Create test cycle request
+ */
+export interface CreateTestCycleRequest {
+    body: TestCycleInput;
+}
+/**
+ * Update test cycle request
+ */
+export interface UpdateTestCycleRequest {
+    testCycleIdOrKey: string | number;
+    body: TestCycle;
+}
+/**
+ * Create test cycle issue link request
+ */
+export interface CreateTestCycleIssueLinkRequest {
+    testCycleIdOrKey: string | number;
+    body: IssueLinkInput;
+}
+/**
+ * Create test cycle web link request
+ */
+export interface CreateTestCycleWebLinkRequest {
+    testCycleIdOrKey: string | number;
+    body: WebLinkInput;
+}
+/**
+ * List test plans options
+ */
+export interface ListTestPlansOptions extends PaginationOptions {
+    projectKey?: ProjectKey;
+    folderId?: number;
+}
+/**
+ * Get test plan options
+ */
+export interface GetTestPlanOptions {
+    testPlanIdOrKey: string | number;
+}
+/**
+ * Create test plan request
+ */
+export interface CreateTestPlanRequest {
+    body: TestPlanInput;
+}
+/**
+ * Create test plan issue link request
+ */
+export interface CreateTestPlanIssueLinkRequest {
+    testPlanIdOrKey: string | number;
+    body: IssueLinkInput;
+}
+/**
+ * Create test plan web link request
+ */
+export interface CreateTestPlanWebLinkRequest {
+    testPlanIdOrKey: string | number;
+    body: WebLinkInputWithMandatoryDescription;
+}
+/**
+ * Create test plan test cycle link request
+ */
+export interface CreateTestPlanTestCycleLinkRequest {
+    testPlanIdOrKey: string | number;
+    body: TestPlanTestCycleLinkInput;
+}
+/**
+ * List test executions options
+ */
+export interface ListTestExecutionsOptions extends PaginationOptions {
+    projectKey?: ProjectKey;
+    testCase?: string;
+    testCycle?: string;
+    actualEndDateAfter?: string;
+    actualEndDateBefore?: string;
+    includeStepLinks?: boolean;
+    jiraProjectVersionId?: number;
+    onlyLastExecutions?: boolean;
+    statusName?: StatusName;
+    assignedToId?: JiraUserAccountId;
+    executedById?: JiraUserAccountId;
+}
+/**
+ * List test executions nextgen options
+ */
+export interface ListTestExecutionsNextgenOptions {
+    projectKey?: ProjectKey;
+    testCase?: string;
+    testCycle?: string;
+    actualEndDateAfter?: string;
+    actualEndDateBefore?: string;
+    includeStepLinks?: boolean;
+    jiraProjectVersionId?: number;
+    onlyLastExecutions?: boolean;
+    limit?: number;
+    startAtId?: number;
+}
+/**
+ * Get test execution options
+ */
+export interface GetTestExecutionOptions {
+    testExecutionIdOrKey: string | number;
+    includeStepLinks?: boolean;
+}
+/**
+ * Create test execution request
+ */
+export interface CreateTestExecutionRequest {
+    body: TestExecutionInput;
+}
+/**
+ * Update test execution request
+ */
+export interface UpdateTestExecutionRequest {
+    testExecutionIdOrKey: string | number;
+    body: TestExecutionUpdate;
+}
+/**
+ * Get test execution test steps options
+ */
+export interface GetTestExecutionTestStepsOptions extends PaginationOptions {
+    testExecutionIdOrKey: string | number;
+    testDataRowNumber?: number;
+}
+/**
+ * Put test execution test steps request
+ */
+export interface PutTestExecutionTestStepsRequest {
+    testExecutionIdOrKey: string | number;
+    body: TestStepsUpdate;
+}
+/**
+ * Sync test execution script request
+ */
+export interface SyncTestExecutionScriptRequest {
+    testExecutionIdOrKey: string | number;
+}
+/**
+ * Create test execution issue link request
+ */
+export interface CreateTestExecutionIssueLinkRequest {
+    testExecutionIdOrKey: string | number;
+    body: IssueLinkInput;
+}
+/**
+ * List projects options
+ */
+export interface ListProjectsOptions extends PaginationOptions {
+}
+/**
+ * Get project options
+ */
+export interface GetProjectOptions {
+    projectIdOrKey: string | number;
+}
+/**
+ * List folders options
+ */
+export interface ListFoldersOptions extends PaginationOptions {
+    projectKey: ProjectKey;
+    folderType: FolderType;
+    parentId?: number;
+}
+/**
+ * Get folder options
+ */
+export interface GetFolderOptions {
+    folderId: number;
+}
+/**
+ * Create folder request
+ */
+export interface CreateFolderRequest {
+    body: FolderInput;
+}
+/**
+ * List priorities options
+ */
+export interface ListPrioritiesOptions extends PaginationOptions {
+    projectKey: ProjectKey;
+}
+/**
+ * Get priority options
+ */
+export interface GetPriorityOptions {
+    priorityId: number;
+}
+/**
+ * Create priority request
+ */
+export interface CreatePriorityRequest {
+    body: CreatePriorityInput;
+}
+/**
+ * Update priority request
+ */
+export interface UpdatePriorityRequest {
+    priorityId: number;
+    body: UpdatePriorityInput;
+}
+/**
+ * List statuses options
+ */
+export interface ListStatusesOptions extends PaginationOptions {
+    projectKey: ProjectKey;
+    type?: StatusType;
+}
+/**
+ * Get status options
+ */
+export interface GetStatusOptions {
+    statusId: number;
+}
+/**
+ * Create status request
+ */
+export interface CreateStatusRequest {
+    body: CreateStatusInput;
+}
+/**
+ * Update status request
+ */
+export interface UpdateStatusRequest {
+    statusId: number;
+    body: UpdateStatusInput;
+}
+/**
+ * List environments options
+ */
+export interface ListEnvironmentsOptions extends PaginationOptions {
+    projectKey: ProjectKey;
+}
+/**
+ * Get environment options
+ */
+export interface GetEnvironmentOptions {
+    environmentId: number;
+}
+/**
+ * Create environment request
+ */
+export interface CreateEnvironmentRequest {
+    body: CreateEnvironmentInput;
+}
+/**
+ * Update environment request
+ */
+export interface UpdateEnvironmentRequest {
+    environmentId: number;
+    body: UpdateEnvironmentInput;
+}
+/**
+ * Delete link options
+ */
+export interface DeleteLinkOptions {
+    linkId: number;
+}
+/**
+ * Get issue link test cases options
+ */
+export interface GetIssueLinkTestCasesOptions {
+    issueKey: string;
+}
+/**
+ * Get issue link test cycles options
+ */
+export interface GetIssueLinkTestCyclesOptions {
+    issueKey: string;
+}
+/**
+ * Get issue link test plans options
+ */
+export interface GetIssueLinkTestPlansOptions {
+    issueKey: string;
+}
+/**
+ * Get issue link executions options
+ */
+export interface GetIssueLinkExecutionsOptions {
+    issueKey: string;
+}
+/**
+ * Create automation execution custom request
+ */
+export interface CreateAutomationExecutionCustomRequest {
+    projectKey: ProjectKey;
+    body: FormData;
+    autoCreateTestCases?: boolean;
+}
+/**
+ * Create automation execution cucumber request
+ */
+export interface CreateAutomationExecutionCucumberRequest {
+    projectKey: ProjectKey;
+    body: FormData;
+    autoCreateTestCases?: boolean;
+}
+/**
+ * Create automation execution junit request
+ */
+export interface CreateAutomationExecutionJunitRequest {
+    projectKey: ProjectKey;
+    body: FormData;
+    autoCreateTestCases?: boolean;
+}
+/**
+ * Retrieve BDD test cases options
+ */
+export interface RetrieveBDDTestCasesOptions {
+    projectKey: ProjectKey;
+}
+//# sourceMappingURL=types.d.ts.map