interface IWorkApi {
    baseUrl: string;
    http: HttpClient;
    rest: RestClient;
    userAgent: string;
    vsoClient: VsoClient;
    createAcceptHeader(type: string, apiVersion?: string): string;
    createPlan(postedPlan: CreatePlan, project: string): Promise<Plan>;
    createRequestOptions(type: string, apiVersion?: string): IRequestOptions;
    deletePlan(project: string, id: string): Promise<void>;
    deleteTeamIteration(teamContext: TeamContext, id: string): Promise<void>;
    formatResponse(
        data: any,
        responseTypeMetadata: any,
        isCollection: boolean,
    ): any;
    getBacklog(
        teamContext: TeamContext,
        id: string,
    ): Promise<BacklogLevelConfiguration>;
    getBacklogConfigurations(
        teamContext: TeamContext,
    ): Promise<BacklogConfiguration>;
    getBacklogLevelWorkItems(
        teamContext: TeamContext,
        backlogId: string,
    ): Promise<BacklogLevelWorkItems>;
    getBacklogs(teamContext: TeamContext): Promise<BacklogLevelConfiguration[]>;
    getBoard(teamContext: TeamContext, id: string): Promise<Board>;
    getBoardBadge(
        teamContext: TeamContext,
        id: string,
        columnOptions?: BoardBadgeColumnOptions,
        columns?: string[],
    ): Promise<BoardBadge>;
    getBoardBadgeData(
        teamContext: TeamContext,
        id: string,
        columnOptions?: BoardBadgeColumnOptions,
        columns?: string[],
    ): Promise<string>;
    getBoardCardRuleSettings(
        teamContext: TeamContext,
        board: string,
    ): Promise<BoardCardRuleSettings>;
    getBoardCardSettings(
        teamContext: TeamContext,
        board: string,
    ): Promise<BoardCardSettings>;
    getBoardChart(
        teamContext: TeamContext,
        board: string,
        name: string,
    ): Promise<BoardChart>;
    getBoardCharts(
        teamContext: TeamContext,
        board: string,
    ): Promise<BoardChartReference[]>;
    getBoardColumns(
        teamContext: TeamContext,
        board: string,
    ): Promise<BoardColumn[]>;
    getBoardMappingParentItems(
        teamContext: TeamContext,
        childBacklogContextCategoryRefName: string,
        workitemIds: number[],
    ): Promise<ParentChildWIMap[]>;
    getBoardRows(teamContext: TeamContext, board: string): Promise<BoardRow[]>;
    getBoards(teamContext: TeamContext): Promise<BoardReference[]>;
    getBoardUserSettings(
        teamContext: TeamContext,
        board: string,
    ): Promise<BoardUserSettings>;
    getCapacitiesWithIdentityRefAndTotals(
        teamContext: TeamContext,
        iterationId: string,
    ): Promise<TeamCapacity>;
    getCapacityWithIdentityRef(
        teamContext: TeamContext,
        iterationId: string,
        teamMemberId: string,
    ): Promise<TeamMemberCapacityIdentityRef>;
    getColumns(teamContext: TeamContext): Promise<TaskboardColumns>;
    getColumnSuggestedValues(project?: string): Promise<BoardSuggestedValue[]>;
    getDeliveryTimelineData(
        project: string,
        id: string,
        revision?: number,
        startDate?: Date,
        endDate?: Date,
    ): Promise<DeliveryViewData>;
    getIterationWorkItems(
        teamContext: TeamContext,
        iterationId: string,
    ): Promise<IterationWorkItems>;
    getPlan(project: string, id: string): Promise<Plan>;
    getPlans(project: string): Promise<Plan[]>;
    getProcessConfiguration(project: string): Promise<ProcessConfiguration>;
    getRowSuggestedValues(project?: string): Promise<BoardSuggestedValue[]>;
    getTeamDaysOff(
        teamContext: TeamContext,
        iterationId: string,
    ): Promise<TeamSettingsDaysOff>;
    getTeamFieldValues(teamContext: TeamContext): Promise<TeamFieldValues>;
    getTeamIteration(
        teamContext: TeamContext,
        id: string,
    ): Promise<TeamSettingsIteration>;
    getTeamIterations(
        teamContext: TeamContext,
        timeframe?: string,
    ): Promise<TeamSettingsIteration[]>;
    getTeamSettings(teamContext: TeamContext): Promise<TeamSetting>;
    getTotalIterationCapacities(
        project: string,
        iterationId: string,
    ): Promise<IterationCapacity>;
    getWorkItemColumns(
        teamContext: TeamContext,
        iterationId: string,
    ): Promise<TaskboardWorkItemColumn[]>;
    postTeamIteration(
        iteration: TeamSettingsIteration,
        teamContext: TeamContext,
    ): Promise<TeamSettingsIteration>;
    reorderBacklogWorkItems(
        operation: ReorderOperation,
        teamContext: TeamContext,
    ): Promise<ReorderResult[]>;
    reorderIterationWorkItems(
        operation: ReorderOperation,
        teamContext: TeamContext,
        iterationId: string,
    ): Promise<ReorderResult[]>;
    replaceCapacitiesWithIdentityRef(
        capacities: TeamMemberCapacityIdentityRef[],
        teamContext: TeamContext,
        iterationId: string,
    ): Promise<TeamMemberCapacityIdentityRef[]>;
    setBoardOptions(
        options: { [key: string]: string },
        teamContext: TeamContext,
        id: string,
    ): Promise<{ [key: string]: string }>;
    updateAutomationRule(
        ruleRequestModel: TeamAutomationRulesSettingsRequestModel,
        teamContext: TeamContext,
    ): Promise<void>;
    updateBoardCardRuleSettings(
        boardCardRuleSettings: BoardCardRuleSettings,
        teamContext: TeamContext,
        board: string,
    ): Promise<BoardCardRuleSettings>;
    updateBoardCardSettings(
        boardCardSettingsToSave: BoardCardSettings,
        teamContext: TeamContext,
        board: string,
    ): Promise<BoardCardSettings>;
    updateBoardChart(
        chart: BoardChart,
        teamContext: TeamContext,
        board: string,
        name: string,
    ): Promise<BoardChart>;
    updateBoardColumns(
        boardColumns: BoardColumn[],
        teamContext: TeamContext,
        board: string,
    ): Promise<BoardColumn[]>;
    updateBoardRows(
        boardRows: BoardRow[],
        teamContext: TeamContext,
        board: string,
    ): Promise<BoardRow[]>;
    updateBoardUserSettings(
        boardUserSettings: { [key: string]: string },
        teamContext: TeamContext,
        board: string,
    ): Promise<BoardUserSettings>;
    updateCapacityWithIdentityRef(
        patch: CapacityPatch,
        teamContext: TeamContext,
        iterationId: string,
        teamMemberId: string,
    ): Promise<TeamMemberCapacityIdentityRef>;
    updateColumns(
        updateColumns: UpdateTaskboardColumn[],
        teamContext: TeamContext,
    ): Promise<TaskboardColumns>;
    updatePlan(
        updatedPlan: UpdatePlan,
        project: string,
        id: string,
    ): Promise<Plan>;
    updateTaskboardCardRuleSettings(
        boardCardRuleSettings: BoardCardRuleSettings,
        teamContext: TeamContext,
    ): Promise<void>;
    updateTaskboardCardSettings(
        boardCardSettingsToSave: BoardCardSettings,
        teamContext: TeamContext,
    ): Promise<void>;
    updateTeamDaysOff(
        daysOffPatch: TeamSettingsDaysOffPatch,
        teamContext: TeamContext,
        iterationId: string,
    ): Promise<TeamSettingsDaysOff>;
    updateTeamFieldValues(
        patch: TeamFieldValuesPatch,
        teamContext: TeamContext,
    ): Promise<TeamFieldValues>;
    updateTeamSettings(
        teamSettingsPatch: TeamSettingsPatch,
        teamContext: TeamContext,
    ): Promise<TeamSetting>;
    updateWorkItemColumn(
        updateColumn: UpdateTaskboardWorkItemColumn,
        teamContext: TeamContext,
        iterationId: string,
        workItemId: number,
    ): Promise<void>;
}

Hierarchy (View Summary)

Implemented by

Properties

baseUrl: string
http: HttpClient
rest: RestClient
userAgent: string
vsoClient: VsoClient

Methods