Interface IWorkItemTrackingApi

interface IWorkItemTrackingApi {
    baseUrl: string;
    http: HttpClient;
    rest: RestClient;
    userAgent: string;
    vsoClient: VsoClient;
    addComment(
        request: CommentCreate,
        project: string,
        workItemId: number,
    ): Promise<Comment>;
    createAcceptHeader(type: string, apiVersion?: string): string;
    createAttachment(
        customHeaders: any,
        contentStream: ReadableStream,
        fileName?: string,
        uploadType?: string,
        project?: string,
        areaPath?: string,
    ): Promise<AttachmentReference>;
    createCommentReaction(
        project: string,
        workItemId: number,
        commentId: number,
        reactionType: CommentReactionType,
    ): Promise<CommentReaction>;
    createField(
        workItemField: WorkItemField,
        project?: string,
    ): Promise<WorkItemField>;
    createOrUpdateClassificationNode(
        postedNode: WorkItemClassificationNode,
        project: string,
        structureGroup: TreeStructureGroup,
        path?: string,
    ): Promise<WorkItemClassificationNode>;
    createQuery(
        postedQuery: QueryHierarchyItem,
        project: string,
        query: string,
        validateWiqlOnly?: boolean,
    ): Promise<QueryHierarchyItem>;
    createRequestOptions(type: string, apiVersion?: string): IRequestOptions;
    createTemplate(
        template: WorkItemTemplate,
        teamContext: TeamContext,
    ): Promise<WorkItemTemplate>;
    createWorkItem(
        customHeaders: any,
        document: JsonPatchDocument,
        project: string,
        type: string,
        validateOnly?: boolean,
        bypassRules?: boolean,
        suppressNotifications?: boolean,
        expand?: WorkItemExpand,
    ): Promise<WorkItem>;
    deleteClassificationNode(
        project: string,
        structureGroup: TreeStructureGroup,
        path?: string,
        reclassifyId?: number,
    ): Promise<void>;
    deleteComment(
        project: string,
        workItemId: number,
        commentId: number,
    ): Promise<void>;
    deleteCommentReaction(
        project: string,
        workItemId: number,
        commentId: number,
        reactionType: CommentReactionType,
    ): Promise<CommentReaction>;
    deleteField(fieldNameOrRefName: string, project?: string): Promise<void>;
    deleteQuery(project: string, query: string): Promise<void>;
    deleteTag(project: string, tagIdOrName: string): Promise<void>;
    deleteTemplate(teamContext: TeamContext, templateId: string): Promise<void>;
    deleteWorkItem(
        id: number,
        project?: string,
        destroy?: boolean,
    ): Promise<WorkItemDelete>;
    destroyWorkItem(id: number, project?: string): Promise<void>;
    exportWorkItemTypeDefinition(
        project?: string,
        type?: string,
        exportGlobalLists?: boolean,
    ): Promise<WorkItemTypeTemplate>;
    formatResponse(
        data: any,
        responseTypeMetadata: any,
        isCollection: boolean,
    ): any;
    getAccountMyWorkData(
        queryOption?: QueryOption,
    ): Promise<AccountMyWorkResult>;
    getAttachmentContent(
        id: string,
        fileName?: string,
        project?: string,
        download?: boolean,
    ): Promise<ReadableStream>;
    getAttachmentZip(
        id: string,
        fileName?: string,
        project?: string,
        download?: boolean,
    ): Promise<ReadableStream>;
    getClassificationNode(
        project: string,
        structureGroup: TreeStructureGroup,
        path?: string,
        depth?: number,
    ): Promise<WorkItemClassificationNode>;
    getClassificationNodes(
        project: string,
        ids: number[],
        depth?: number,
        errorPolicy?: ClassificationNodesErrorPolicy,
    ): Promise<WorkItemClassificationNode[]>;
    getComment(
        project: string,
        workItemId: number,
        commentId: number,
        includeDeleted?: boolean,
        expand?: CommentExpandOptions,
    ): Promise<Comment>;
    getCommentReactions(
        project: string,
        workItemId: number,
        commentId: number,
    ): Promise<CommentReaction[]>;
    getComments(
        project: string,
        workItemId: number,
        top?: number,
        continuationToken?: string,
        includeDeleted?: boolean,
        expand?: CommentExpandOptions,
        order?: CommentSortOrder,
    ): Promise<CommentList>;
    getCommentsBatch(
        project: string,
        workItemId: number,
        ids: number[],
        includeDeleted?: boolean,
        expand?: CommentExpandOptions,
    ): Promise<CommentList>;
    getCommentVersion(
        project: string,
        workItemId: number,
        commentId: number,
        version: number,
    ): Promise<CommentVersion>;
    getCommentVersions(
        project: string,
        workItemId: number,
        commentId: number,
    ): Promise<CommentVersion[]>;
    getDeletedWorkItem(id: number, project?: string): Promise<WorkItemDelete>;
    getDeletedWorkItems(
        ids: number[],
        project?: string,
    ): Promise<WorkItemDeleteReference[]>;
    getDeletedWorkItemShallowReferences(
        project?: string,
    ): Promise<WorkItemDeleteShallowReference[]>;
    getEngagedUsers(
        project: string,
        workItemId: number,
        commentId: number,
        reactionType: CommentReactionType,
        top?: number,
        skip?: number,
    ): Promise<IdentityRef[]>;
    getField(
        fieldNameOrRefName: string,
        project?: string,
    ): Promise<WorkItemField>;
    getFields(
        project?: string,
        expand?: GetFieldsExpand,
    ): Promise<WorkItemField[]>;
    getQueries(
        project: string,
        expand?: QueryExpand,
        depth?: number,
        includeDeleted?: boolean,
    ): Promise<QueryHierarchyItem[]>;
    getQueriesBatch(
        queryGetRequest: QueryBatchGetRequest,
        project: string,
    ): Promise<QueryHierarchyItem[]>;
    getQuery(
        project: string,
        query: string,
        expand?: QueryExpand,
        depth?: number,
        includeDeleted?: boolean,
        useIsoDateFormat?: boolean,
    ): Promise<QueryHierarchyItem>;
    getRecentActivityData(): Promise<AccountRecentActivityWorkItemModel2[]>;
    getRecentMentions(): Promise<AccountRecentMentionWorkItemModel[]>;
    getRelationType(relation: string): Promise<WorkItemRelationType>;
    getRelationTypes(): Promise<WorkItemRelationType[]>;
    getReportingLinksByLinkType(
        project?: string,
        linkTypes?: string[],
        types?: string[],
        continuationToken?: string,
        startDateTime?: Date,
    ): Promise<ReportingWorkItemLinksBatch>;
    getRevision(
        id: number,
        revisionNumber: number,
        expand?: WorkItemExpand,
        project?: string,
    ): Promise<WorkItem>;
    getRevisions(
        id: number,
        top?: number,
        skip?: number,
        expand?: WorkItemExpand,
        project?: string,
    ): Promise<WorkItem[]>;
    getRootNodes(
        project: string,
        depth?: number,
    ): Promise<WorkItemClassificationNode[]>;
    getTag(
        project: string,
        tagIdOrName: string,
    ): Promise<WorkItemTagDefinition>;
    getTags(project: string): Promise<WorkItemTagDefinition[]>;
    getTemplate(
        teamContext: TeamContext,
        templateId: string,
    ): Promise<WorkItemTemplate>;
    getTemplates(
        teamContext: TeamContext,
        workitemtypename?: string,
    ): Promise<WorkItemTemplateReference[]>;
    getUpdate(
        id: number,
        updateNumber: number,
        project?: string,
    ): Promise<WorkItemUpdate>;
    getUpdates(
        id: number,
        top?: number,
        skip?: number,
        project?: string,
    ): Promise<WorkItemUpdate[]>;
    getWorkArtifactLinkTypes(): Promise<WorkArtifactLink[]>;
    getWorkItem(
        id: number,
        fields?: string[],
        asOf?: Date,
        expand?: WorkItemExpand,
        project?: string,
    ): Promise<WorkItem>;
    getWorkItemIconJson(
        icon: string,
        color?: string,
        v?: number,
    ): Promise<WorkItemIcon>;
    getWorkItemIcons(): Promise<WorkItemIcon[]>;
    getWorkItemIconSvg(
        icon: string,
        color?: string,
        v?: number,
    ): Promise<ReadableStream>;
    getWorkItemIconXaml(
        icon: string,
        color?: string,
        v?: number,
    ): Promise<ReadableStream>;
    getWorkItemNextStatesOnCheckinAction(
        ids: number[],
        action?: string,
    ): Promise<WorkItemNextStateOnTransition[]>;
    getWorkItems(
        ids: number[],
        fields?: string[],
        asOf?: Date,
        expand?: WorkItemExpand,
        errorPolicy?: WorkItemErrorPolicy,
        project?: string,
    ): Promise<WorkItem[]>;
    getWorkItemsBatch(
        workItemGetRequest: WorkItemBatchGetRequest,
        project?: string,
    ): Promise<WorkItem[]>;
    getWorkItemStateColors(
        projectNames: string[],
    ): Promise<ProjectWorkItemStateColors[]>;
    getWorkItemTemplate(
        project: string,
        type: string,
        fields?: string,
        asOf?: Date,
        expand?: WorkItemExpand,
    ): Promise<WorkItem>;
    getWorkItemType(project: string, type: string): Promise<WorkItemType>;
    getWorkItemTypeCategories(project: string): Promise<WorkItemTypeCategory[]>;
    getWorkItemTypeCategory(
        project: string,
        category: string,
    ): Promise<WorkItemTypeCategory>;
    getWorkItemTypeColorAndIcons(
        projectNames: string[],
    ): Promise<{ key: string; value: WorkItemTypeColorAndIcon[] }[]>;
    getWorkItemTypeColors(
        projectNames: string[],
    ): Promise<{ key: string; value: WorkItemTypeColor[] }[]>;
    getWorkItemTypeFieldsWithReferences(
        project: string,
        type: string,
        expand?: WorkItemTypeFieldsExpandLevel,
    ): Promise<WorkItemTypeFieldWithReferences[]>;
    getWorkItemTypeFieldWithReferences(
        project: string,
        type: string,
        field: string,
        expand?: WorkItemTypeFieldsExpandLevel,
    ): Promise<WorkItemTypeFieldWithReferences>;
    getWorkItemTypes(project: string): Promise<WorkItemType[]>;
    getWorkItemTypeStates(
        project: string,
        type: string,
    ): Promise<WorkItemStateColor[]>;
    migrateProjectsProcess(
        newProcess: ProcessIdModel,
        project: string,
    ): Promise<ProcessMigrationResultModel>;
    queryById(
        id: string,
        teamContext?: TeamContext,
        timePrecision?: boolean,
        top?: number,
    ): Promise<WorkItemQueryResult>;
    queryByWiql(
        wiql: Wiql,
        teamContext?: TeamContext,
        timePrecision?: boolean,
        top?: number,
    ): Promise<WorkItemQueryResult>;
    queryWorkItemsForArtifactUris(
        artifactUriQuery: ArtifactUriQuery,
        project?: string,
    ): Promise<ArtifactUriQueryResult>;
    readReportingDiscussions(
        project?: string,
        continuationToken?: string,
        maxPageSize?: number,
    ): Promise<ReportingWorkItemRevisionsBatch>;
    readReportingRevisionsGet(
        project?: string,
        fields?: string[],
        types?: string[],
        continuationToken?: string,
        startDateTime?: Date,
        includeIdentityRef?: boolean,
        includeDeleted?: boolean,
        includeTagRef?: boolean,
        includeLatestOnly?: boolean,
        expand?: ReportingRevisionsExpand,
        includeDiscussionChangesOnly?: boolean,
        maxPageSize?: number,
    ): Promise<ReportingWorkItemRevisionsBatch>;
    readReportingRevisionsPost(
        filter: ReportingWorkItemRevisionsFilter,
        project?: string,
        continuationToken?: string,
        startDateTime?: Date,
        expand?: ReportingRevisionsExpand,
    ): Promise<ReportingWorkItemRevisionsBatch>;
    replaceTemplate(
        templateContent: WorkItemTemplate,
        teamContext: TeamContext,
        templateId: string,
    ): Promise<WorkItemTemplate>;
    restoreWorkItem(
        payload: WorkItemDeleteUpdate,
        id: number,
        project?: string,
    ): Promise<WorkItemDelete>;
    searchQueries(
        project: string,
        filter: string,
        top?: number,
        expand?: QueryExpand,
        includeDeleted?: boolean,
    ): Promise<QueryHierarchyItemsResult>;
    sendMail(body: SendMailBody, project?: string): Promise<void>;
    updateClassificationNode(
        postedNode: WorkItemClassificationNode,
        project: string,
        structureGroup: TreeStructureGroup,
        path?: string,
    ): Promise<WorkItemClassificationNode>;
    updateComment(
        request: CommentUpdate,
        project: string,
        workItemId: number,
        commentId: number,
    ): Promise<Comment>;
    updateField(
        payload: UpdateWorkItemField,
        fieldNameOrRefName: string,
        project?: string,
    ): Promise<WorkItemField>;
    updateQuery(
        queryUpdate: QueryHierarchyItem,
        project: string,
        query: string,
        undeleteDescendants?: boolean,
    ): Promise<QueryHierarchyItem>;
    updateTag(
        tagData: WorkItemTagDefinition,
        project: string,
        tagIdOrName: string,
    ): Promise<WorkItemTagDefinition>;
    updateWorkItem(
        customHeaders: any,
        document: JsonPatchDocument,
        id: number,
        project?: string,
        validateOnly?: boolean,
        bypassRules?: boolean,
        suppressNotifications?: boolean,
        expand?: WorkItemExpand,
    ): Promise<WorkItem>;
    updateWorkItemTypeDefinition(
        updateModel: WorkItemTypeTemplateUpdateModel,
        project?: string,
    ): Promise<ProvisioningResult>;
}