Interface IReleaseApi

interface IReleaseApi {
    baseUrl: string;
    http: HttpClient;
    rest: RestClient;
    userAgent: string;
    vsoClient: VsoClient;
    addDefinitionTag(
        project: string,
        releaseDefinitionId: number,
        tag: string,
    ): Promise<string[]>;
    addDefinitionTags(
        tags: string[],
        project: string,
        releaseDefinitionId: number,
    ): Promise<string[]>;
    addReleaseTag(
        project: string,
        releaseId: number,
        tag: string,
    ): Promise<string[]>;
    addReleaseTags(
        tags: string[],
        project: string,
        releaseId: number,
    ): Promise<string[]>;
    createAcceptHeader(type: string, apiVersion?: string): string;
    createDefinitionEnvironmentTemplate(
        template: ReleaseDefinitionEnvironmentTemplate,
        project: string,
    ): Promise<ReleaseDefinitionEnvironmentTemplate>;
    createFavorites(
        favoriteItems: FavoriteItem[],
        project: string,
        scope: string,
        identityId?: string,
    ): Promise<FavoriteItem[]>;
    createFolder(
        folder: Folder,
        project: string,
        path?: string,
    ): Promise<Folder>;
    createRelease(
        releaseStartMetadata: ReleaseStartMetadata,
        project: string,
    ): Promise<Release>;
    createReleaseDefinition(
        releaseDefinition: ReleaseDefinition,
        project: string,
    ): Promise<ReleaseDefinition>;
    createRequestOptions(type: string, apiVersion?: string): IRequestOptions;
    deleteDefinitionEnvironmentTemplate(
        project: string,
        templateId: string,
    ): Promise<void>;
    deleteDefinitionTag(
        project: string,
        releaseDefinitionId: number,
        tag: string,
    ): Promise<string[]>;
    deleteFavorites(
        project: string,
        scope: string,
        identityId?: string,
        favoriteItemIds?: string,
    ): Promise<void>;
    deleteFolder(project: string, path: string): Promise<void>;
    deleteRelease(
        project: string,
        releaseId: number,
        comment?: string,
    ): Promise<void>;
    deleteReleaseDefinition(
        project: string,
        definitionId: number,
        comment?: string,
        forceDelete?: boolean,
    ): Promise<void>;
    deleteReleaseTag(
        project: string,
        releaseId: number,
        tag: string,
    ): Promise<string[]>;
    formatResponse(
        data: any,
        responseTypeMetadata: any,
        isCollection: boolean,
    ): any;
    getAgentArtifactDefinitions(
        project: string,
        releaseId: number,
    ): Promise<AgentArtifactDefinition[]>;
    getApproval(
        project: string,
        approvalId: number,
        includeHistory?: boolean,
    ): Promise<ReleaseApproval>;
    getApprovalHistory(
        project: string,
        approvalStepId: number,
    ): Promise<ReleaseApproval>;
    getApprovals(
        project: string,
        assignedToFilter?: string,
        statusFilter?: ApprovalStatus,
        releaseIdsFilter?: number[],
        typeFilter?: ApprovalType,
        top?: number,
        continuationToken?: number,
        queryOrder?: ReleaseQueryOrder,
        includeMyGroupApprovals?: boolean,
    ): Promise<PagedList<ReleaseApproval>>;
    getArtifactTypeDefinitions(
        project: string,
    ): Promise<ArtifactTypeDefinition[]>;
    getArtifactVersions(
        project: string,
        releaseDefinitionId: number,
    ): Promise<ArtifactVersionQueryResult>;
    getArtifactVersionsForSources(
        artifacts: Artifact[],
        project: string,
    ): Promise<ArtifactVersionQueryResult>;
    getAutoTriggerIssues(
        artifactType: string,
        sourceId: string,
        artifactVersionId: string,
        project?: string,
    ): Promise<AutoTriggerIssue[]>;
    getDefinitionEnvironments(
        project: string,
        taskGroupId?: string,
        propertyFilters?: string[],
    ): Promise<DefinitionEnvironmentReference[]>;
    getDefinitionEnvironmentTemplate(
        project: string,
        templateId: string,
    ): Promise<ReleaseDefinitionEnvironmentTemplate>;
    getDefinitionRevision(
        project: string,
        definitionId: number,
        revision: number,
    ): Promise<ReadableStream>;
    getDefinitionTags(
        project: string,
        releaseDefinitionId: number,
    ): Promise<string[]>;
    getDeploymentBadge(
        projectId: string,
        releaseDefinitionId: number,
        environmentId: number,
        branchName?: string,
    ): Promise<string>;
    getDeployments(
        project: string,
        definitionId?: number,
        definitionEnvironmentId?: number,
        createdBy?: string,
        minModifiedTime?: Date,
        maxModifiedTime?: Date,
        deploymentStatus?: DeploymentStatus,
        operationStatus?: DeploymentOperationStatus,
        latestAttemptsOnly?: boolean,
        queryOrder?: ReleaseQueryOrder,
        top?: number,
        continuationToken?: number,
        createdFor?: string,
        minStartedTime?: Date,
        maxStartedTime?: Date,
        sourceBranch?: string,
    ): Promise<PagedList<Deployment>>;
    getDeploymentsForMultipleEnvironments(
        queryParameters: DeploymentQueryParameters,
        project: string,
    ): Promise<Deployment[]>;
    getFavorites(
        project: string,
        scope: string,
        identityId?: string,
    ): Promise<FavoriteItem[]>;
    getFlightAssignments(flightName?: string): Promise<string[]>;
    getFolders(
        project: string,
        path?: string,
        queryOrder?: FolderPathQueryOrder,
    ): Promise<Folder[]>;
    getGateLog(
        project: string,
        releaseId: number,
        environmentId: number,
        gateId: number,
        taskId: number,
    ): Promise<ReadableStream>;
    getInputValues(
        query: InputValuesQuery,
        project: string,
    ): Promise<InputValuesQuery>;
    getIssues(
        project: string,
        buildId: number,
        sourceId?: string,
    ): Promise<AutoTriggerIssue[]>;
    getLog(
        project: string,
        releaseId: number,
        environmentId: number,
        taskId: number,
        attemptId?: number,
    ): Promise<ReadableStream>;
    getLogs(project: string, releaseId: number): Promise<ReadableStream>;
    getManualIntervention(
        project: string,
        releaseId: number,
        manualInterventionId: number,
    ): Promise<ManualIntervention>;
    getManualInterventions(
        project: string,
        releaseId: number,
    ): Promise<ManualIntervention[]>;
    getMetrics(project: string, minMetricsTime?: Date): Promise<Metric[]>;
    getOrgPipelineReleaseSettings(): Promise<OrgPipelineReleaseSettings>;
    getPipelineReleaseSettings(
        project: string,
    ): Promise<ProjectPipelineReleaseSettings>;
    getRelease(
        project: string,
        releaseId: number,
        approvalFilters?: ApprovalFilters,
        propertyFilters?: string[],
        expand?: SingleReleaseExpands,
        topGateRecords?: number,
    ): Promise<Release>;
    getReleaseChanges(
        project: string,
        releaseId: number,
        baseReleaseId?: number,
        top?: number,
        artifactAlias?: string,
    ): Promise<Change[]>;
    getReleaseDefinition(
        project: string,
        definitionId: number,
        propertyFilters?: string[],
    ): Promise<ReleaseDefinition>;
    getReleaseDefinitionHistory(
        project: string,
        definitionId: number,
    ): Promise<ReleaseDefinitionRevision[]>;
    getReleaseDefinitionRevision(
        project: string,
        definitionId: number,
        revision: number,
    ): Promise<ReadableStream>;
    getReleaseDefinitions(
        project: string,
        searchText?: string,
        expand?: ReleaseDefinitionExpands,
        artifactType?: string,
        artifactSourceId?: string,
        top?: number,
        continuationToken?: string,
        queryOrder?: ReleaseDefinitionQueryOrder,
        path?: string,
        isExactNameMatch?: boolean,
        tagFilter?: string[],
        propertyFilters?: string[],
        definitionIdFilter?: string[],
        isDeleted?: boolean,
        searchTextContainsFolderName?: boolean,
    ): Promise<PagedList<ReleaseDefinition>>;
    getReleaseDefinitionSummary(
        project: string,
        definitionId: number,
        releaseCount: number,
        includeArtifact?: boolean,
        definitionEnvironmentIdsFilter?: number[],
    ): Promise<ReleaseDefinitionSummary>;
    getReleaseEnvironment(
        project: string,
        releaseId: number,
        environmentId: number,
        expand?: ReleaseEnvironmentExpands,
    ): Promise<ReleaseEnvironment>;
    getReleaseHistory(
        project: string,
        releaseId: number,
    ): Promise<ReleaseRevision[]>;
    getReleaseProjects(
        artifactType: string,
        artifactSourceId: string,
    ): Promise<ProjectReference[]>;
    getReleaseRevision(
        project: string,
        releaseId: number,
        definitionSnapshotRevision: number,
    ): Promise<ReadableStream>;
    getReleases(
        project?: string,
        definitionId?: number,
        definitionEnvironmentId?: number,
        searchText?: string,
        createdBy?: string,
        statusFilter?: ReleaseStatus,
        environmentStatusFilter?: number,
        minCreatedTime?: Date,
        maxCreatedTime?: Date,
        queryOrder?: ReleaseQueryOrder,
        top?: number,
        continuationToken?: number,
        expand?: ReleaseExpands,
        artifactTypeId?: string,
        sourceId?: string,
        artifactVersionId?: string,
        sourceBranchFilter?: string,
        isDeleted?: boolean,
        tagFilter?: string[],
        propertyFilters?: string[],
        releaseIdFilter?: number[],
        path?: string,
    ): Promise<PagedList<Release>>;
    getReleaseSettings(project: string): Promise<ReleaseSettings>;
    getReleaseTags(project: string, releaseId: number): Promise<string[]>;
    getReleaseTaskAttachmentContent(
        project: string,
        releaseId: number,
        environmentId: number,
        attemptId: number,
        planId: string,
        timelineId: string,
        recordId: string,
        type: string,
        name: string,
    ): Promise<ReadableStream>;
    getReleaseTaskAttachments(
        project: string,
        releaseId: number,
        environmentId: number,
        attemptId: number,
        planId: string,
        type: string,
    ): Promise<ReleaseTaskAttachment[]>;
    getReleaseWorkItemsRefs(
        project: string,
        releaseId: number,
        baseReleaseId?: number,
        top?: number,
        artifactAlias?: string,
    ): Promise<ReleaseWorkItemRef[]>;
    getSourceBranches(project: string, definitionId: number): Promise<string[]>;
    getSummaryMailSections(
        project: string,
        releaseId: number,
    ): Promise<SummaryMailSection[]>;
    getTags(project: string): Promise<string[]>;
    getTaskAttachmentContent(
        project: string,
        releaseId: number,
        environmentId: number,
        attemptId: number,
        timelineId: string,
        recordId: string,
        type: string,
        name: string,
    ): Promise<ReadableStream>;
    getTaskAttachments(
        project: string,
        releaseId: number,
        environmentId: number,
        attemptId: number,
        timelineId: string,
        type: string,
    ): Promise<ReleaseTaskAttachment[]>;
    getTaskLog(
        project: string,
        releaseId: number,
        environmentId: number,
        releaseDeployPhaseId: number,
        taskId: number,
        startLine?: number,
        endLine?: number,
    ): Promise<ReadableStream>;
    getTaskLog2(
        project: string,
        releaseId: number,
        environmentId: number,
        attemptId: number,
        timelineId: string,
        taskId: number,
        startLine?: number,
        endLine?: number,
    ): Promise<ReadableStream>;
    getTasks(
        project: string,
        releaseId: number,
        environmentId: number,
        attemptId?: number,
    ): Promise<ReleaseTask[]>;
    getTasks2(
        project: string,
        releaseId: number,
        environmentId: number,
        attemptId: number,
        timelineId: string,
    ): Promise<ReleaseTask[]>;
    getTasksForTaskGroup(
        project: string,
        releaseId: number,
        environmentId: number,
        releaseDeployPhaseId: number,
    ): Promise<ReleaseTask[]>;
    listDefinitionEnvironmentTemplates(
        project: string,
        isDeleted?: boolean,
    ): Promise<ReleaseDefinitionEnvironmentTemplate[]>;
    sendSummaryMail(
        mailMessage: MailMessage,
        project: string,
        releaseId: number,
    ): Promise<void>;
    undeleteRelease(
        project: string,
        releaseId: number,
        comment: string,
    ): Promise<void>;
    undeleteReleaseDefinition(
        releaseDefinitionUndeleteParameter: ReleaseDefinitionUndeleteParameter,
        project: string,
        definitionId: number,
    ): Promise<ReleaseDefinition>;
    undeleteReleaseDefinitionEnvironmentTemplate(
        project: string,
        templateId: string,
    ): Promise<ReleaseDefinitionEnvironmentTemplate>;
    updateFolder(
        folder: Folder,
        project: string,
        path: string,
    ): Promise<Folder>;
    updateGates(
        gateUpdateMetadata: GateUpdateMetadata,
        project: string,
        gateStepId: number,
    ): Promise<ReleaseGates>;
    updateManualIntervention(
        manualInterventionUpdateMetadata: ManualInterventionUpdateMetadata,
        project: string,
        releaseId: number,
        manualInterventionId: number,
    ): Promise<ManualIntervention>;
    updateOrgPipelineReleaseSettings(
        newSettings: OrgPipelineReleaseSettingsUpdateParameters,
    ): Promise<OrgPipelineReleaseSettings>;
    updatePipelineReleaseSettings(
        newSettings: ProjectPipelineReleaseSettingsUpdateParameters,
        project: string,
    ): Promise<ProjectPipelineReleaseSettings>;
    updateRelease(
        release: Release,
        project: string,
        releaseId: number,
    ): Promise<Release>;
    updateReleaseApproval(
        approval: ReleaseApproval,
        project: string,
        approvalId: number,
    ): Promise<ReleaseApproval>;
    updateReleaseApprovals(
        approvals: ReleaseApproval[],
        project: string,
    ): Promise<ReleaseApproval[]>;
    updateReleaseDefinition(
        releaseDefinition: ReleaseDefinition,
        project: string,
    ): Promise<ReleaseDefinition>;
    updateReleaseEnvironment(
        environmentUpdateData: ReleaseEnvironmentUpdateMetadata,
        project: string,
        releaseId: number,
        environmentId: number,
    ): Promise<ReleaseEnvironment>;
    updateReleaseResource(
        releaseUpdateMetadata: ReleaseUpdateMetadata,
        project: string,
        releaseId: number,
    ): Promise<Release>;
    updateReleaseSettings(
        releaseSettings: ReleaseSettings,
        project: string,
    ): Promise<ReleaseSettings>;
}