@atlassian/bitbucket-server/src/index.d.ts

Bitbucket Server API client for Browser and Node.js

/**
 * This declaration file requires TypeScript 2.1 or above.
 */

declare namespace BitbucketServer {
  export type Any = any;
  export type AnyObject = object;

  export type Headers = {
    [header: string]: any
  };

  export interface Options {
    baseUrl?: string;
    headers?: Headers;
    options?: AnyObject;
  }

  interface AuthBasic {
    type: "basic";
    username: string;
    password: string;
  }

  interface AuthAppPassword {
    type: "apppassword";
    username: string;
    password: string;
  }

  interface AuthToken {
    type: "token";
    token: string;
  }

  export type Auth =
    | AuthBasic
    | AuthAppPassword
    | AuthToken;

  export type ResponseHeaders = {
    [header: string]: any;
  };

  export type ResponseError =
    | BitbucketServer.Schema.Any;

  export interface Callback<T> {
    (error: ResponseError, response: T): void;
  }

  export interface Response<T> {
    data: T;
    headers: ResponseHeaders;
  }

  namespace Schema {
    export type Any = BitbucketServer.Any;
    export type AnyObject = BitbucketServer.AnyObject;

    export interface CreateCommentRequest {
      [k: string]: any;
    }
    export interface CreateRequest {
      [k: string]: any;
    }
    export interface PaginatedPullRequestActivities {
      [k: string]: any;
    }
    export interface PaginatedPullRequests {
      [k: string]: any;
    }
    export interface PaginatedUsers {
      isLastPage?: boolean;
      limit?: number;
      size?: number;
      start?: number;
      values?: User[];
      [k: string]: any;
    }
    export interface User {
      displayName?: string;
      emailAddress?: string;
      id?: number;
      links?: {
        self?: {
          href?: string;
          [k: string]: any;
        };
        [k: string]: any;
      };
      name?: string;
      slug?: string;
      [k: string]: any;
    }
    export interface PreviewRequest {
      [k: string]: any;
    }
    export interface UpdateCommentRequest {
      [k: string]: any;
    }
    export interface UpdateRequest {
      [k: string]: any;
    }
    export interface UpdateStatusRequest {
      [k: string]: any;
    }
  }

  namespace Params {
    export type Empty = {};

    export type ApiGetApplicationProperties =
      {
        "q"?: object;
      };
    export type ApiGetUser =
      {
        "q"?: object;
        "userSlug": string;
      };
    export type ApiGetUsers =
      {
        "limit"?: number;
        "q"?: any;
        "start"?: number;
      };
    export type ApiPreview =
      {
        "body": BitbucketServer.Schema.PreviewRequest;
        "q"?: object;
      };
    export type CommentsGetComment =
      {
        "commentId": number;
        "projectKey": string;
        "pullRequestId": string;
        "q"?: object;
        "repositorySlug": string;
      };
    export type CommentsUpdateComment =
      {
        "body": BitbucketServer.Schema.UpdateCommentRequest;
        "commentId": number;
        "projectKey": string;
        "pullRequestId": string;
        "q"?: object;
        "repositorySlug": string;
      };
    export type CommitsGetPullRequests =
      {
        "commitId": string;
        "projectKey": string;
        "q"?: object;
        "repositorySlug": string;
      };
    export type ParticipantsUpdateStatus =
      {
        "body": BitbucketServer.Schema.UpdateStatusRequest;
        "projectKey": string;
        "pullRequestId": number;
        "q"?: object;
        "repositorySlug": string;
        "userSlug": string;
      };
    export type PullRequestsApprove =
      {
        "projectKey": string;
        "pullRequestId": number;
        "q"?: object;
        "repositorySlug": string;
      };
    export type PullRequestsCanMerge =
      {
        "projectKey": string;
        "pullRequestId": number;
        "q"?: object;
        "repositorySlug": string;
      };
    export type PullRequestsCreateComment =
      {
        "body": BitbucketServer.Schema.CreateCommentRequest;
        "projectKey": string;
        "pullRequestId": string;
        "q"?: object;
        "repositorySlug": string;
      };
    export type PullRequestsDecline =
      {
        "projectKey": string;
        "pullRequestId": number;
        "q"?: object;
        "repositorySlug": string;
        "version"?: number;
      };
    export type PullRequestsGet =
      {
        "projectKey": string;
        "pullRequestId": number;
        "q"?: object;
        "repositorySlug": string;
      };
    export type PullRequestsGetActivities =
      {
        "fromId"?: number;
        "fromType"?: string;
        "limit"?: number;
        "projectKey": string;
        "pullRequestId": number;
        "q"?: any;
        "repositorySlug": string;
        "start"?: number;
      };
    export type PullRequestsGetComments =
      {
        "anchorState"?: string;
        "diffType"?: string;
        "fromHash"?: string;
        "path"?: string;
        "projectKey": string;
        "pullRequestId": string;
        "q"?: object;
        "repositorySlug": string;
        "toHash"?: string;
      };
    export type PullRequestsGetCommits =
      {
        "projectKey": string;
        "pullRequestId": number;
        "q"?: object;
        "repositorySlug": string;
        "withCounts"?: boolean;
      };
    export type PullRequestsGetPullRequestSettings =
      {
        "projectKey": string;
        "q"?: object;
        "scmId": string;
      };
    export type PullRequestsGetTaskCount =
      {
        "projectKey": string;
        "pullRequestId": string;
        "q"?: object;
        "repositorySlug": string;
      };
    export type PullRequestsListParticipants =
      {
        "limit"?: number;
        "projectKey": string;
        "pullRequestId": number;
        "q"?: any;
        "repositorySlug": string;
        "start"?: number;
      };
    export type PullRequestsMerge =
      {
        "projectKey": string;
        "pullRequestId": number;
        "q"?: object;
        "repositorySlug": string;
        "version"?: number;
      };
    export type PullRequestsReopen =
      {
        "projectKey": string;
        "pullRequestId": number;
        "q"?: object;
        "repositorySlug": string;
        "version"?: number;
      };
    export type PullRequestsStreamChanges =
      {
        "changeScope"?: string;
        "projectKey": string;
        "pullRequestId": string;
        "q"?: object;
        "repositorySlug": string;
        "sinceId"?: string;
        "untilId"?: string;
        "withComments"?: boolean;
      };
    export type PullRequestsUpdate =
      {
        "body": BitbucketServer.Schema.UpdateRequest;
        "projectKey": string;
        "pullRequestId": number;
        "q"?: object;
        "repositorySlug": string;
      };
    export type ReposCreatePullRequest =
      {
        "body": BitbucketServer.Schema.CreateRequest;
        "projectKey": string;
        "q"?: object;
        "repositorySlug": string;
      };
    export type ReposGetBranches =
      {
        "base"?: string;
        "details"?: boolean;
        "filterText"?: string;
        "orderBy"?: string;
        "projectKey": string;
        "q"?: object;
        "repositorySlug": string;
      };
    export type ReposGetBranchModel =
      {
        "projectKey": string;
        "q"?: object;
        "repositorySlug": string;
      };
    export type ReposGetCommits =
      {
        "followRenames"?: boolean;
        "ignoreMissing"?: boolean;
        "merges"?: string;
        "path"?: string;
        "projectKey": string;
        "q"?: object;
        "repositorySlug": string;
        "since"?: string;
        "until"?: string;
        "withCounts"?: boolean;
      };
    export type ReposGetDefaultBranch =
      {
        "projectKey": string;
        "q"?: object;
        "repositorySlug": string;
      };
    export type ReposGetDefaultReviewers =
      {
        "limit"?: number;
        "projectKey": string;
        "q"?: any;
        "repositorySlug": string;
        "sourceRefId": string;
        "sourceRepoId": number;
        "start"?: number;
        "targetRefId": string;
        "targetRepoId": number;
      };
    export type ReposGetPullRequests =
      {
        "at"?: string;
        "direction"?: string;
        "limit"?: number;
        "order"?: string;
        "projectKey": string;
        "q"?: any;
        "repositorySlug": string;
        "start"?: number;
        "state"?: string;
        "withAttributes"?: boolean;
        "withProperties"?: boolean;
      };
    export type ReposGetRepository =
      {
        "projectKey": string;
        "q"?: object;
        "repositorySlug": string;
      };
    export type ReposSearch =
      {
        "direction"?: string;
        "filter"?: string;
        "projectKey": string;
        "q"?: object;
        "repositorySlug": string;
        "role"?: string;
      };
  }
}

declare class BitbucketServer {
  constructor(options?: BitbucketServer.Options);

  authenticate(auth: BitbucketServer.Auth): void;
  
  api: {
    getApplicationProperties(params: BitbucketServer.Params.ApiGetApplicationProperties, callback?: BitbucketServer.Callback<BitbucketServer.Response<BitbucketServer.Schema.Any>>): Promise<BitbucketServer.Response<BitbucketServer.Schema.Any>>;
    getUser(params: BitbucketServer.Params.ApiGetUser, callback?: BitbucketServer.Callback<BitbucketServer.Response<BitbucketServer.Schema.User>>): Promise<BitbucketServer.Response<BitbucketServer.Schema.User>>;
    getUsers(params: BitbucketServer.Params.ApiGetUsers, callback?: BitbucketServer.Callback<BitbucketServer.Response<BitbucketServer.Schema.PaginatedUsers>>): Promise<BitbucketServer.Response<BitbucketServer.Schema.PaginatedUsers>>;
    preview(params: BitbucketServer.Params.ApiPreview, callback?: BitbucketServer.Callback<BitbucketServer.Response<BitbucketServer.Schema.Any>>): Promise<BitbucketServer.Response<BitbucketServer.Schema.Any>>;
  };
  comments: {
    getComment(params: BitbucketServer.Params.CommentsGetComment, callback?: BitbucketServer.Callback<BitbucketServer.Response<BitbucketServer.Schema.Any>>): Promise<BitbucketServer.Response<BitbucketServer.Schema.Any>>;
    updateComment(params: BitbucketServer.Params.CommentsUpdateComment, callback?: BitbucketServer.Callback<BitbucketServer.Response<BitbucketServer.Schema.Any>>): Promise<BitbucketServer.Response<BitbucketServer.Schema.Any>>;
  };
  commits: {
    getPullRequests(params: BitbucketServer.Params.CommitsGetPullRequests, callback?: BitbucketServer.Callback<BitbucketServer.Response<BitbucketServer.Schema.Any>>): Promise<BitbucketServer.Response<BitbucketServer.Schema.Any>>;
  };
  participants: {
    updateStatus(params: BitbucketServer.Params.ParticipantsUpdateStatus, callback?: BitbucketServer.Callback<BitbucketServer.Response<BitbucketServer.Schema.Any>>): Promise<BitbucketServer.Response<BitbucketServer.Schema.Any>>;
  };
  pullRequests: {
    approve(params: BitbucketServer.Params.PullRequestsApprove, callback?: BitbucketServer.Callback<BitbucketServer.Response<BitbucketServer.Schema.Any>>): Promise<BitbucketServer.Response<BitbucketServer.Schema.Any>>;
    canMerge(params: BitbucketServer.Params.PullRequestsCanMerge, callback?: BitbucketServer.Callback<BitbucketServer.Response<BitbucketServer.Schema.Any>>): Promise<BitbucketServer.Response<BitbucketServer.Schema.Any>>;
    createComment(params: BitbucketServer.Params.PullRequestsCreateComment, callback?: BitbucketServer.Callback<BitbucketServer.Response<BitbucketServer.Schema.Any>>): Promise<BitbucketServer.Response<BitbucketServer.Schema.Any>>;
    decline(params: BitbucketServer.Params.PullRequestsDecline, callback?: BitbucketServer.Callback<BitbucketServer.Response<BitbucketServer.Schema.Any>>): Promise<BitbucketServer.Response<BitbucketServer.Schema.Any>>;
    get(params: BitbucketServer.Params.PullRequestsGet, callback?: BitbucketServer.Callback<BitbucketServer.Response<BitbucketServer.Schema.Any>>): Promise<BitbucketServer.Response<BitbucketServer.Schema.Any>>;
    getActivities(params: BitbucketServer.Params.PullRequestsGetActivities, callback?: BitbucketServer.Callback<BitbucketServer.Response<BitbucketServer.Schema.PaginatedPullRequestActivities>>): Promise<BitbucketServer.Response<BitbucketServer.Schema.PaginatedPullRequestActivities>>;
    getComments(params: BitbucketServer.Params.PullRequestsGetComments, callback?: BitbucketServer.Callback<BitbucketServer.Response<BitbucketServer.Schema.Any>>): Promise<BitbucketServer.Response<BitbucketServer.Schema.Any>>;
    getCommits(params: BitbucketServer.Params.PullRequestsGetCommits, callback?: BitbucketServer.Callback<BitbucketServer.Response<BitbucketServer.Schema.Any>>): Promise<BitbucketServer.Response<BitbucketServer.Schema.Any>>;
    getPullRequestSettings(params: BitbucketServer.Params.PullRequestsGetPullRequestSettings, callback?: BitbucketServer.Callback<BitbucketServer.Response<BitbucketServer.Schema.Any>>): Promise<BitbucketServer.Response<BitbucketServer.Schema.Any>>;
    getTaskCount(params: BitbucketServer.Params.PullRequestsGetTaskCount, callback?: BitbucketServer.Callback<BitbucketServer.Response<BitbucketServer.Schema.Any>>): Promise<BitbucketServer.Response<BitbucketServer.Schema.Any>>;
    listParticipants(params: BitbucketServer.Params.PullRequestsListParticipants, callback?: BitbucketServer.Callback<BitbucketServer.Response<BitbucketServer.Schema.Any>>): Promise<BitbucketServer.Response<BitbucketServer.Schema.Any>>;
    merge(params: BitbucketServer.Params.PullRequestsMerge, callback?: BitbucketServer.Callback<BitbucketServer.Response<BitbucketServer.Schema.Any>>): Promise<BitbucketServer.Response<BitbucketServer.Schema.Any>>;
    reopen(params: BitbucketServer.Params.PullRequestsReopen, callback?: BitbucketServer.Callback<BitbucketServer.Response<BitbucketServer.Schema.Any>>): Promise<BitbucketServer.Response<BitbucketServer.Schema.Any>>;
    streamChanges(params: BitbucketServer.Params.PullRequestsStreamChanges, callback?: BitbucketServer.Callback<BitbucketServer.Response<BitbucketServer.Schema.Any>>): Promise<BitbucketServer.Response<BitbucketServer.Schema.Any>>;
    update(params: BitbucketServer.Params.PullRequestsUpdate, callback?: BitbucketServer.Callback<BitbucketServer.Response<BitbucketServer.Schema.Any>>): Promise<BitbucketServer.Response<BitbucketServer.Schema.Any>>;
  };
  repos: {
    createPullRequest(params: BitbucketServer.Params.ReposCreatePullRequest, callback?: BitbucketServer.Callback<BitbucketServer.Response<BitbucketServer.Schema.Any>>): Promise<BitbucketServer.Response<BitbucketServer.Schema.Any>>;
    getBranches(params: BitbucketServer.Params.ReposGetBranches, callback?: BitbucketServer.Callback<BitbucketServer.Response<BitbucketServer.Schema.Any>>): Promise<BitbucketServer.Response<BitbucketServer.Schema.Any>>;
    getBranchModel(params: BitbucketServer.Params.ReposGetBranchModel, callback?: BitbucketServer.Callback<BitbucketServer.Response<BitbucketServer.Schema.Any>>): Promise<BitbucketServer.Response<BitbucketServer.Schema.Any>>;
    getCommits(params: BitbucketServer.Params.ReposGetCommits, callback?: BitbucketServer.Callback<BitbucketServer.Response<BitbucketServer.Schema.Any>>): Promise<BitbucketServer.Response<BitbucketServer.Schema.Any>>;
    getDefaultBranch(params: BitbucketServer.Params.ReposGetDefaultBranch, callback?: BitbucketServer.Callback<BitbucketServer.Response<BitbucketServer.Schema.Any>>): Promise<BitbucketServer.Response<BitbucketServer.Schema.Any>>;
    getDefaultReviewers(params: BitbucketServer.Params.ReposGetDefaultReviewers, callback?: BitbucketServer.Callback<BitbucketServer.Response<BitbucketServer.Schema.PaginatedUsers>>): Promise<BitbucketServer.Response<BitbucketServer.Schema.PaginatedUsers>>;
    getPullRequests(params: BitbucketServer.Params.ReposGetPullRequests, callback?: BitbucketServer.Callback<BitbucketServer.Response<BitbucketServer.Schema.PaginatedPullRequests>>): Promise<BitbucketServer.Response<BitbucketServer.Schema.PaginatedPullRequests>>;
    getRepository(params: BitbucketServer.Params.ReposGetRepository, callback?: BitbucketServer.Callback<BitbucketServer.Response<BitbucketServer.Schema.Any>>): Promise<BitbucketServer.Response<BitbucketServer.Schema.Any>>;
    search(params: BitbucketServer.Params.ReposSearch, callback?: BitbucketServer.Callback<BitbucketServer.Response<BitbucketServer.Schema.Any>>): Promise<BitbucketServer.Response<BitbucketServer.Schema.Any>>;
  };
}

export = BitbucketServer;

export as namespace BitbucketServer;