@managed-api/bitbucket-cloud-v2-sr-connect

ScriptRunner Connect Managed API for Bitbucket Cloud

Managed API for Bitbucket Cloud is an API Client for Bitbucket Cloud by Adaptavist. You can read more about Managed APIs here.

This is ScriptRunner Connect runtime specific version of the Managed API (with sr-connect suffix). If you want to use Managed API in any other runtime, have a look at the runtime agnostic version.

Supported API calls

• fetch
• Repository
  • createRepository
  • deleteRepository
  • getBranchesAndTags
  • getRepositories
  • getRepositoriesByWorkspace
  • getRepository
  • updateRepository
  • Branch
    • createBranch
    • deleteBranch
    • getBranch
    • getOpenBranches
    • Restriction
      • createRestriction
      • deleteRestriction
      • getRestriction
      • getRestrictions
      • updateRestriction
  • Commit
    • getCommit
    • getCommits
    • getCommitsByFile
    • Approval
      • approveCommit
      • redactApproval
    • Comment
      • getComment
      • getComments
    • Status
      • createStatus
      • getStatus
      • getStatuses
  • Deployment
    • getDeployment
    • getDeployments
  • Environment
    • createEnvironment
    • deleteEnvironment
    • getEnvironment
    • getEnvironments
    • Variable
      • createVariable
      • deleteVariable
      • getVariables
      • updateVariable
  • Fork
    • createFork
    • getForks
  • Pipeline
    • createAndInitiatePipeline
    • findPipelines
    • retrievePipeline
    • stopPipeline
    • Configuration
      • retrieveConfiguration
      • updateConfiguration
      • Build
        • updateBuildNumber
      • Schedule
        • createSchedule
        • deleteSchedule
        • retrieveSchedule
        • retrieveSchedules
        • updateSchedule
      • Variable
        • createVariable
        • deleteVariable
        • getVariable
        • getVariables
        • updateVariable
    • Step
      • findSteps
      • retrieveStep
  • Pullrequest
    • approvePullrequest
    • createPullrequest
    • declinePullrequest
    • getActivityLog
    • getPullrequest
    • getPullrequests
    • getPullrequestStatuses
    • mergePullrequest
    • mutatePullrequest
    • Comment
      • createComment
      • deleteComment
      • getComment
      • getComments
      • updateComment
    • Commit
      • getCommits
  • Reviewer
    • Default
      • addReviewer
      • getReviewer
      • getReviewers
      • removeReviewer
  • Tag
    • createTag
    • deleteTag
    • getTag
    • getTags
• User
  • getCurrentUser
  • getCurrentUserEmail
  • getCurrentUserEmails
  • getUser
  • Permission
    • getCurrentUserRepositoryPermissions
    • getCurrentUserWorkspaceMemberships
  • SSH
    • addKey
    • deleteKey
    • getKey
    • getKeys
    • updateKey
• Workspace
  • getWorkspace
  • getWorkspaces
  • Project
    • createProject
    • deleteProject
    • getProject
    • getProjects
    • Search
      • searchCodeInProjects
  • Variable
    • createVariable
    • deleteVariable
    • getVariable
    • getVariables
    • updateVariable

Constructing Managed API

In ScriptRunner Connect a Managed API is constructed for you, but if you need to construct it manually, here's how you can do it:

import { BitbucketCloudApi } from '@managed-api/bitbucket-cloud-v2-sr-connect';

export default async function() {
    const api = new BitbucketCloudApi('API_CONNECTION_ID');
}

Contact

Feel free to drop ideas, suggestions or improvements into our Slack community channel.

Changelog

2.1.0

• Changed response type for the following methods:

  • List commits on a pull request that can be used as Repository.Pullrequest.Commit.getCommits or All.getRepositoryPullrequestCommits.
  • List commits with include/exclude that can be used as Repository.Commit.getCommits or All.getRepositoryCommits.

2.0.1

• Fixed the following method to use the appropriate header:

  • List commits with include/exclude that can be used as Repository.Commit.getCommits or All.getRepositoryCommits.

2.0.0

• Breaking change: URL and query string parameters are now URL encoded, meaning if you encoded them explicitly before you have to remove your own encoding, otherwise they will get double encoded.

0.12.0

• Changed response type for following Repository methods:

  • List public repositories that can be used as Repository.getRepositories or All.getRepositories.

0.11.0

• Changed the name for following methods:

  • Repository.Branch.createRepositoryBranch to Repository.Branch.createBranch.
  • Repository.Commit.getRepositoryCommits to Repository.Commit.getCommits.

• Fixed the following methods:

  • Update variable for a workspace that can be used as Workspace.Variable.updateVariable or All.updateWorkspaceVariable.
  • Get a branch restriction rule that can be used as Repository.Branch.Restriction.getRestriction or All.getRepositoryBranchRestriction.
  • Delete a branch restriction rule that can be used as Repository.Branch.Restriction.deleteRestriction or All.deleteRepositoryBranchRestriction.
  • Get an email address for current user that can be used as User.getCurrentUserEmail or All.getCurrentUserEmail.
  • List email addresses for current user that can be used as User.getCurrentUserEmails or All.getCurrentUserEmails.
  • Get a default reviewer that can be used as Repository.Reviewer.Default.getReviewer or All.getRepositoryDefaultReviewer.
  • Add a user to the default reviewers that can be used as Repository.Reviewer.Default.addReviewer or All.addRepositoryDefaultReviewer.
  • List default reviewers that can be used as Repository.Reviewer.Default.getReviewers or All.getRepositoryDefaultReviewers.
  • List commits with include/exclude that can be used as Repository.Commit.getCommits or All.getRepositoryCommits.

Copyright Adaptavist 2024 (c) All rights reserved