@atomist/cortex/PullRequest.ts

Atomist Cortex model TypeScript typings

/*
 * Copyright 2015-2017 Atomist Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import { TreeNode, GraphNode, FormatInfo, PathExpressionEngine } from "@atomist/rug/tree/PathExpression";
import { ProjectContext } from "@atomist/rug/operations/ProjectEditor";
import { Branch } from "./Branch";
import { Build } from "./Build";
import { Comment } from "./Comment";
import { Commit } from "./Commit";
import { GitHubId } from "./GitHubId";
import { Label } from "./Label";
import { Repo } from "./Repo";
import { Review } from "./Review";
export { PullRequest };

/**
 * Type PullRequest
 */
interface PullRequest extends GraphNode {

    /**
     * assignees - PullRequest -> GitHubId
     *
     * @property {GitHubId[]} assignees
     */
    readonly assignees: GitHubId[];

    /**
     * author - PullRequest -> GitHubId
     *
     * @property {GitHubId} author
     */
    readonly author: GitHubId;

    /**
     * base - PullRequest -> Commit
     *
     * @property {Commit} base
     */
    readonly base: Commit;

    /**
     * baseBranchName
     *
     * @property {string} baseBranchName
     */
    readonly baseBranchName: string;

    /**
     * body
     *
     * @property {string} body
     */
    readonly body: string;

    /**
     * branch - PullRequest -> Branch
     *
     * @property {Branch} branch
     */
    readonly branch: Branch;

    /**
     * branchName
     *
     * @property {string} branchName
     */
    readonly branchName: string;

    /**
     * builds - PullRequest -> Build
     *
     * @property {Build[]} builds
     */
    readonly builds: Build[];

    /**
     * closedAt
     *
     * @property {string} closedAt
     */
    readonly closedAt: string;

    /**
     * comments - PullRequest -> Comment
     *
     * @property {Comment[]} comments
     */
    readonly comments: Comment[];

    /**
     * commits - PullRequest -> Commit
     *
     * @property {Commit[]} commits
     */
    readonly commits: Commit[];

    /**
     * createdAt
     *
     * @property {string} createdAt
     */
    readonly createdAt: string;

    /**
     * head - PullRequest -> Commit
     *
     * @property {Commit} head
     */
    readonly head: Commit;

    /**
     * id
     *
     * @property {string} id
     */
    readonly id: string;

    /**
     * labels - PullRequest -> Label
     *
     * @property {Label[]} labels
     */
    readonly labels: Label[];

    /**
     * lastAssignedBy - PullRequest -> GitHubId
     *
     * @property {GitHubId} lastAssignedBy
     */
    readonly lastAssignedBy: GitHubId;

    /**
     * mergeCommit - PullRequest -> Commit
     *
     * @property {Commit} mergeCommit
     */
    readonly mergeCommit: Commit;

    /**
     * merged
     *
     * @property {boolean} merged
     */
    readonly merged: boolean;

    /**
     * mergedAt
     *
     * @property {string} mergedAt
     */
    readonly mergedAt: string;

    /**
     * merger - PullRequest -> GitHubId
     *
     * @property {GitHubId} merger
     */
    readonly merger: GitHubId;

    /**
     * name
     *
     * @property {string} name
     */
    readonly name: string;

    /**
     * number
     *
     * @property {number} number
     */
    readonly number: number;

    /**
     * repo - PullRequest -> Repo
     *
     * @property {Repo} repo
     */
    readonly repo: Repo;

    /**
     * reviewers - PullRequest -> GitHubId
     *
     * @property {GitHubId[]} reviewers
     */
    readonly reviewers: GitHubId[];

    /**
     * reviews - PullRequest -> Review
     *
     * @property {Review[]} reviews
     */
    readonly reviews: Review[];

    /**
     * state
     *
     * @property {string} state
     */
    readonly state: string;

    /**
     * timestamp
     *
     * @property {string} timestamp
     */
    readonly timestamp: string;

    /**
     * title
     *
     * @property {string} title
     */
    readonly title: string;

    /**
     * updatedAt
     *
     * @property {string} updatedAt
     */
    readonly updatedAt: string;

}