Interface IBuildApi

interface IBuildApi {
    baseUrl: string;
    http: HttpClient;
    rest: RestClient;
    userAgent: string;
    vsoClient: VsoClient;
    addBuildTag(
        project: string,
        buildId: number,
        tag: string,
    ): Promise<string[]>;
    addBuildTags(
        tags: string[],
        project: string,
        buildId: number,
    ): Promise<string[]>;
    addDefinitionTag(
        project: string,
        definitionId: number,
        tag: string,
    ): Promise<string[]>;
    addDefinitionTags(
        tags: string[],
        project: string,
        definitionId: number,
    ): Promise<string[]>;
    addRetentionLeases(
        newLeases: NewRetentionLease[],
        project: string,
    ): Promise<RetentionLease[]>;
    authorizeDefinitionResources(
        resources: DefinitionResourceReference[],
        project: string,
        definitionId: number,
    ): Promise<DefinitionResourceReference[]>;
    authorizeProjectResources(
        resources: DefinitionResourceReference[],
        project: string,
    ): Promise<DefinitionResourceReference[]>;
    createAcceptHeader(type: string, apiVersion?: string): string;
    createArtifact(
        artifact: BuildArtifact,
        project: string,
        buildId: number,
    ): Promise<BuildArtifact>;
    createDefinition(
        definition: BuildDefinition,
        project: string,
        definitionToCloneId?: number,
        definitionToCloneRevision?: number,
    ): Promise<BuildDefinition>;
    createFolder(
        folder: Folder,
        project: string,
        path: string,
    ): Promise<Folder>;
    createRequestOptions(type: string, apiVersion?: string): IRequestOptions;
    deleteBuild(project: string, buildId: number): Promise<void>;
    deleteBuildTag(
        project: string,
        buildId: number,
        tag: string,
    ): Promise<string[]>;
    deleteDefinition(project: string, definitionId: number): Promise<void>;
    deleteDefinitionTag(
        project: string,
        definitionId: number,
        tag: string,
    ): Promise<string[]>;
    deleteFolder(project: string, path: string): Promise<void>;
    deleteRetentionLeasesById(project: string, ids: number[]): Promise<void>;
    deleteTag(project: string, tag: string): Promise<string[]>;
    deleteTemplate(project: string, templateId: string): Promise<void>;
    formatResponse(
        data: any,
        responseTypeMetadata: any,
        isCollection: boolean,
    ): any;
    getArtifact(
        project: string,
        buildId: number,
        artifactName: string,
    ): Promise<BuildArtifact>;
    getArtifactContentZip(
        project: string,
        buildId: number,
        artifactName: string,
    ): Promise<ReadableStream>;
    getArtifacts(project: string, buildId: number): Promise<BuildArtifact[]>;
    getAttachment(
        project: string,
        buildId: number,
        timelineId: string,
        recordId: string,
        type: string,
        name: string,
    ): Promise<ReadableStream>;
    getAttachments(
        project: string,
        buildId: number,
        type: string,
    ): Promise<Attachment[]>;
    getBadge(
        project: string,
        definitionId: number,
        branchName?: string,
    ): Promise<string>;
    getBuild(
        project: string,
        buildId: number,
        propertyFilters?: string,
    ): Promise<Build>;
    getBuildBadge(
        project: string,
        repoType: string,
        repoId?: string,
        branchName?: string,
    ): Promise<BuildBadge>;
    getBuildBadgeData(
        project: string,
        repoType: string,
        repoId?: string,
        branchName?: string,
    ): Promise<string>;
    getBuildChanges(
        project: string,
        buildId: number,
        continuationToken?: string,
        top?: number,
        includeSourceChange?: boolean,
    ): Promise<PagedList<Change>>;
    getBuildController(controllerId: number): Promise<BuildController>;
    getBuildControllers(name?: string): Promise<BuildController[]>;
    getBuildGeneralSettings(project: string): Promise<PipelineGeneralSettings>;
    getBuildLog(
        project: string,
        buildId: number,
        logId: number,
        startLine?: number,
        endLine?: number,
    ): Promise<ReadableStream>;
    getBuildLogLines(
        project: string,
        buildId: number,
        logId: number,
        startLine?: number,
        endLine?: number,
    ): Promise<string[]>;
    getBuildLogs(project: string, buildId: number): Promise<BuildLog[]>;
    getBuildLogsZip(project: string, buildId: number): Promise<ReadableStream>;
    getBuildLogZip(
        project: string,
        buildId: number,
        logId: number,
        startLine?: number,
        endLine?: number,
    ): Promise<ReadableStream>;
    getBuildOptionDefinitions(
        project?: string,
    ): Promise<BuildOptionDefinition[]>;
    getBuildProperties(
        project: string,
        buildId: number,
        filter?: string[],
    ): Promise<any>;
    getBuildReport(
        project: string,
        buildId: number,
        type?: string,
    ): Promise<BuildReportMetadata>;
    getBuildReportHtmlContent(
        project: string,
        buildId: number,
        type?: string,
    ): Promise<ReadableStream>;
    getBuilds(
        project: string,
        definitions?: number[],
        queues?: number[],
        buildNumber?: string,
        minTime?: Date,
        maxTime?: Date,
        requestedFor?: string,
        reasonFilter?: BuildReason,
        statusFilter?: BuildStatus,
        resultFilter?: BuildResult,
        tagFilters?: string[],
        properties?: string[],
        top?: number,
        continuationToken?: string,
        maxBuildsPerDefinition?: number,
        deletedFilter?: QueryDeletedOption,
        queryOrder?: BuildQueryOrder,
        branchName?: string,
        buildIds?: number[],
        repositoryId?: string,
        repositoryType?: string,
    ): Promise<PagedList<Build>>;
    getBuildSettings(project?: string): Promise<BuildSettings>;
    getBuildTags(project: string, buildId: number): Promise<string[]>;
    getBuildTimeline(
        project: string,
        buildId: number,
        timelineId?: string,
        changeId?: number,
        planId?: string,
    ): Promise<Timeline>;
    getBuildWorkItemsRefs(
        project: string,
        buildId: number,
        top?: number,
    ): Promise<ResourceRef[]>;
    getBuildWorkItemsRefsFromCommits(
        commitIds: string[],
        project: string,
        buildId: number,
        top?: number,
    ): Promise<ResourceRef[]>;
    getChangesBetweenBuilds(
        project: string,
        fromBuildId?: number,
        toBuildId?: number,
        top?: number,
    ): Promise<Change[]>;
    getDefinition(
        project: string,
        definitionId: number,
        revision?: number,
        minMetricsTime?: Date,
        propertyFilters?: string[],
        includeLatestBuilds?: boolean,
    ): Promise<BuildDefinition>;
    getDefinitionMetrics(
        project: string,
        definitionId: number,
        minMetricsTime?: Date,
    ): Promise<BuildMetric[]>;
    getDefinitionProperties(
        project: string,
        definitionId: number,
        filter?: string[],
    ): Promise<any>;
    getDefinitionResources(
        project: string,
        definitionId: number,
    ): Promise<DefinitionResourceReference[]>;
    getDefinitionRevisions(
        project: string,
        definitionId: number,
    ): Promise<BuildDefinitionRevision[]>;
    getDefinitions(
        project: string,
        name?: string,
        repositoryId?: string,
        repositoryType?: string,
        queryOrder?: DefinitionQueryOrder,
        top?: number,
        continuationToken?: string,
        minMetricsTime?: Date,
        definitionIds?: number[],
        path?: string,
        builtAfter?: Date,
        notBuiltAfter?: Date,
        includeAllProperties?: boolean,
        includeLatestBuilds?: boolean,
        taskIdFilter?: string,
        processType?: number,
        yamlFilename?: string,
    ): Promise<PagedList<BuildDefinitionReference>>;
    getDefinitionTags(
        project: string,
        definitionId: number,
        revision?: number,
    ): Promise<string[]>;
    getDefinitionYaml(
        project: string,
        definitionId: number,
        revision?: number,
        minMetricsTime?: Date,
        propertyFilters?: string[],
        includeLatestBuilds?: boolean,
    ): Promise<YamlBuild>;
    getFile(
        project: string,
        buildId: number,
        artifactName: string,
        fileId: string,
        fileName: string,
    ): Promise<ReadableStream>;
    getFileContents(
        project: string,
        providerName: string,
        serviceEndpointId?: string,
        repository?: string,
        commitOrBranch?: string,
        path?: string,
    ): Promise<ReadableStream>;
    getFolders(
        project: string,
        path?: string,
        queryOrder?: FolderQueryOrder,
    ): Promise<Folder[]>;
    getLatestBuild(
        project: string,
        definition: string,
        branchName?: string,
    ): Promise<Build>;
    getPathContents(
        project: string,
        providerName: string,
        serviceEndpointId?: string,
        repository?: string,
        commitOrBranch?: string,
        path?: string,
    ): Promise<SourceRepositoryItem[]>;
    getProjectMetrics(
        project: string,
        metricAggregationType?: string,
        minMetricsTime?: Date,
    ): Promise<BuildMetric[]>;
    getProjectResources(
        project: string,
        type?: string,
        id?: string,
    ): Promise<DefinitionResourceReference[]>;
    getPullRequest(
        project: string,
        providerName: string,
        pullRequestId: string,
        repositoryId?: string,
        serviceEndpointId?: string,
    ): Promise<PullRequest>;
    getResourceUsage(): Promise<BuildResourceUsage>;
    getRetentionHistory(
        daysToLookback?: number,
    ): Promise<BuildRetentionHistory>;
    getRetentionLease(
        project: string,
        leaseId: number,
    ): Promise<RetentionLease>;
    getRetentionLeasesByMinimalRetentionLeases(
        project: string,
        leasesToFetch: MinimalRetentionLease[],
    ): Promise<RetentionLease[]>;
    getRetentionLeasesByOwnerId(
        project: string,
        ownerId?: string,
        definitionId?: number,
        runId?: number,
    ): Promise<RetentionLease[]>;
    getRetentionLeasesByUserId(
        project: string,
        userOwnerId: string,
        definitionId?: number,
        runId?: number,
    ): Promise<RetentionLease[]>;
    getRetentionLeasesForBuild(
        project: string,
        buildId: number,
    ): Promise<RetentionLease[]>;
    getRetentionSettings(project: string): Promise<ProjectRetentionSetting>;
    getStatusBadge(
        project: string,
        definition: string,
        branchName?: string,
        stageName?: string,
        jobName?: string,
        configuration?: string,
        label?: string,
    ): Promise<string>;
    getTags(project: string): Promise<string[]>;
    getTemplate(
        project: string,
        templateId: string,
    ): Promise<BuildDefinitionTemplate>;
    getTemplates(project: string): Promise<BuildDefinitionTemplate[]>;
    getWorkItemsBetweenBuilds(
        project: string,
        fromBuildId: number,
        toBuildId: number,
        top?: number,
    ): Promise<ResourceRef[]>;
    listBranches(
        project: string,
        providerName: string,
        serviceEndpointId?: string,
        repository?: string,
        branchName?: string,
    ): Promise<string[]>;
    listRepositories(
        project: string,
        providerName: string,
        serviceEndpointId?: string,
        repository?: string,
        resultSet?: ResultSet,
        pageResults?: boolean,
        continuationToken?: string,
    ): Promise<SourceRepositories>;
    listSourceProviders(project: string): Promise<SourceProviderAttributes[]>;
    listWebhooks(
        project: string,
        providerName: string,
        serviceEndpointId?: string,
        repository?: string,
    ): Promise<RepositoryWebhook[]>;
    queueBuild(
        build: Build,
        project: string,
        ignoreWarnings?: boolean,
        checkInTicket?: string,
        sourceBuildId?: number,
        definitionId?: number,
    ): Promise<Build>;
    restoreDefinition(
        project: string,
        definitionId: number,
        deleted: boolean,
    ): Promise<BuildDefinition>;
    restoreWebhooks(
        triggerTypes: DefinitionTriggerType[],
        project: string,
        providerName: string,
        serviceEndpointId?: string,
        repository?: string,
    ): Promise<void>;
    saveTemplate(
        template: BuildDefinitionTemplate,
        project: string,
        templateId: string,
    ): Promise<BuildDefinitionTemplate>;
    updateBuild(
        build: Build,
        project: string,
        buildId: number,
        retry?: boolean,
    ): Promise<Build>;
    updateBuildGeneralSettings(
        newSettings: PipelineGeneralSettings,
        project: string,
    ): Promise<PipelineGeneralSettings>;
    updateBuildProperties(
        customHeaders: any,
        document: JsonPatchDocument,
        project: string,
        buildId: number,
    ): Promise<any>;
    updateBuilds(builds: Build[], project: string): Promise<Build[]>;
    updateBuildSettings(
        settings: BuildSettings,
        project?: string,
    ): Promise<BuildSettings>;
    updateBuildTags(
        updateParameters: UpdateTagParameters,
        project: string,
        buildId: number,
    ): Promise<string[]>;
    updateDefinition(
        definition: BuildDefinition,
        project: string,
        definitionId: number,
        secretsSourceDefinitionId?: number,
        secretsSourceDefinitionRevision?: number,
    ): Promise<BuildDefinition>;
    updateDefinitionProperties(
        customHeaders: any,
        document: JsonPatchDocument,
        project: string,
        definitionId: number,
    ): Promise<any>;
    updateDefinitionTags(
        updateParameters: UpdateTagParameters,
        project: string,
        definitionId: number,
    ): Promise<string[]>;
    updateFolder(
        folder: Folder,
        project: string,
        path: string,
    ): Promise<Folder>;
    updateRetentionLease(
        leaseUpdate: RetentionLeaseUpdate,
        project: string,
        leaseId: number,
    ): Promise<RetentionLease>;
    updateRetentionSettings(
        updateModel: UpdateProjectRetentionSettingModel,
        project: string,
    ): Promise<ProjectRetentionSetting>;
    updateStage(
        updateParameters: UpdateStageParameters,
        buildId: number,
        stageRefName: string,
        project?: string,
    ): Promise<void>;
}