package
0.3.0
Repository: https://github.com/davidji99/bitbucket-go.git
Documentation: pkg.go.dev

# Functions

BaseURL allows overriding of the default base API URL.
CustomHTTPHeaders sets additional HTTPHeaders.
No description provided by the author
New creates a new client using username and an app password, essentially basic authentication.
OAuth with oauth.
OAuthBearerToken sets the oauth grant.
OAuthClientCredentials uses the Client Credentials Grant oauth2 flow to authenticate to Bitbucket.
OAuthToken sets the oauth grant.
OAuthWithCode does the OAuth handshake with a given code.
UserAgent allows overriding of the default User Agent.

# Constants

ApprovalActivity represents an update activity to a pull request.
DefaultAPIBaseURL for the base API URL.
DefaultPageLength represents the default page length returned from API calls.
DefaultUserAgent for the API calls.
UpdateActivity represents an update activity to a pull request.

# Structs

AcceptedError occurs when Bitbucket returns 202 Accepted response with an empty body, which means a job was scheduled on the Bitbucket side to process the information needed and cache it.
Artifact represents a file on Bitbucket.
ArtifactFileLinks represents the "links" object in a Bitbucket artifact.
Artifacts represents a collection of artifacts (or files).
BMBranch represents the git branches you want the model to be applied to.
BMBranchType represents the branch prefix configurations for new branches.
BMBranchUpdateOpts represents the fields available when updating the development/production branches.
BMLinks represents the "links" object in a Bitbucket branching model.
BMRequest represents a request to update an existing branching model.
Branch represents a branch.
BranchingModel represents the brancing model for a repository.
BranchRestriction represents a Bitbucket repository branch restriction.
BranchRestrictionListOpts represents the query parameters available to listing all branch restrictions.
BranchRestrictions represent a collection of branch restrictions.
BRLinks represents the "links" object in a Bitbucket branch restriction.
BRRequest represents a request to create/update a branch restriction.
CCLinks represents the "links" object in a Bitbucket commit comment.
A Client manages communication with the Bitbucket API.
CodeFile represents the information regarding the file that matched a search query.
CodeSearchQueryParams represents the query parameters available when searching for code.
Comment represents a generic comment on a Bitbucket pull request or issue.
CommentLinks represents the "links" object in a Bitbucket comment.
Commit represents a git commit in a Bitbucket repository.
CommitComment represents a commit comment.
CommitCommentRequest represents a new commit comment.
CommitComments represent a collection of a commit's comments.
CommitLinks represents the "links" object in a Bitbucket commit.
CommitMessageContent represents the commit's message.
Commits represent a collection of commits.
CommitStatus represents a commit status.
CommitStatuses represent a collection of a commit's statuses.
CommitStatusRequest represents a new commit status.
Component represents a Bitbucket repository component.
ComponentLinks represents the "links" object in a Bitbucket component.
ComponentRequest represents an existing component to be added to an issue or pull request.
Components represent a collection of components.
Content represents content found in a Bitbucket resource.
CSLinks represents the "links" object in a Bitbucket commit status.
DeployKey represents a deploy key aka access key on a repository.
DeployKeyLinks represents the "links" object in a Bitbucket deploy key.
DeployKeyRequest represents a request to create/update a deploy/access key.
DeployKeys represents a collection of deploy keys.
Diff represents a code diff on Bitbucket.
DiffGetOpts represents the query parameters available when getting the raw of a diff.
Diffs represents a collection of diffs.
FileHistory represents the history of a file.
FileHistoryLinks represents the "links" object in a Bitbucket file history.
FileHistoryListOpts represents the unique query parameters for file history.
FilterSortOpts represents the querying and sorting mechanism available to certain Bitbucket API resources that return multiple results in a response.
ForkRequest represents a request to a create a new fork.
GenericOpts represents all of the available generic query parameters Bitbucket has to offer.
HookEvent represents a hook event.
HookEvents represents a collection of hook events.
HookEventTypes represents hook events.
HookEventTypesLinks represents the "links" object in a Bitbucket hook event type.
Issue represents a Bitbucket issue on a repository.
IssueChange represents the individual change.
IssueChangeLinks represents the "links" object in a Bitbucket issue change.
IssueChangeRequest represents a request to create change on an issue.
IssueChanges represents a collection of changes on an issue,.
IssueComment represents a comment on an issue.
IssueCommentLinks represents the "links" object in a Bitbucket issue comment.
IssueCommentRequest represents a request to create/update an issue comment.
IssueComments represents a collection of issue comments.
IssueContent represents the Description box in the Bitbucket issue UI.
IssueLinks represents the "links" object in a Bitbucket issue.
IssueRequest represents a request to create/update an issue.
IssueRequestAssigneeOpts represents the Bitbucket user to be assigned when creating/updating a new issue.
IssueRequestContentOpts represents the Description box when creating/updating a new issue.
Issues represent a collection of issues.
Link represents a single link object from Bitbucket object links.
ListOpts specifies the optional parameters to various List methods that support pagination.
MergePrRequest represents a request to merge a pull request.
Milestone represents a Bitbucket repository milestone.
MilestoneLinks represents the "links" object in a Bitbucket milestone.
MilestoneRequest represents an existing milestone to be added to an issue or pull request.
Milestones represent a collection of milestones.
PaginationInfo represents the pagination data returned on most LIST functions.
PartialRespOpts represents the URL parameter to request a partial response and to add or remove specific fields from a response.
Participant represents a user that interacted with a Bitbucket resource.
PRActivities represents a collection of of pull request activity.
PRActivity represents a pull request activity.
PRApprovalActivity represents a pull request approval activity.
PRComment represents a pull request comment.
PRCommentRequest represents a request to create or update a pull request comment.
PRComments represents a collection of a PR's comments.
PRRequest represents a request to create/update a pull request.
PRRequestDestinationOpts represents the destination branch for the pull request.
PRRequestReviewerOpts represent a reviewer for a pull request specified by the user's UUID.
PRRequestSourceOpts represents the source branch for the pull request.
PRUpdateActivity represents a pull request update activity.
PullRequest represents a Bitbucket pull request on a repository.
PullRequestBody represents the body of a Bitbucket pull request.
PullRequestBranch represents a branch associated with the pull request.
PullRequestLinks represents the "links" object in a Bitbucket pull request.
PullRequestListOpts represents the filters and query parameters available when listing pull requests.
PullRequestMergeCommit represents the "merge_commit" object in a Bitbucket pull request.
PullRequests represents a collection of pull requests.
Ref represents the branches and tags in a repository.
RefLinks represents the "links" object in a ref.
RefRequest represents a request to create a new branch.
Refs represents a collection of refs.
Repositories represent a collection of repositories.
Repository represents a Bitbucket repository.
RepositoryDeleteQueryParam represents the query parameter available when deleting a repository.
RepositoryHook represents a repository hook.
RepositoryHookRequest represents a request to create/update a hook.
RepositoryHooks represents a collection of repository hooks.
RepositoryLinks represents the "links" object in a Bitbucket repository.
RepositoryListQueryParams represents the filters and query parameters available when listing repositories.
RepositoryMainBranch represents the primary branch set for a repository.
RepositoryRequest represents a request to create/update a repository.
SearchCodeFileLinks represents the "links" object in a Bitbucket search code result file.
SearchCodeResult represents the individual search query result.
SearchCodeResults represents the results from a search query.
SearchContentMatch represents the content code lines that match a search result.
SearchContentMatchLine represents the specific line(s) that match a content result.
SearchMatch represents the content of a search result code line.
SRCGetOpts represents the query parameters available to SRC#Get requests.
SRCMetadata represents a Bitbucket file/folder's metadata on a repository.
SSHKeyAddRequest represents a request to add a SSH key.
Team represents a Bitbucket team.
TeamLinks represents the "links" object in a Bitbucket team.
TeamListOpts represents the query parameters available to getting all Teams.
TeamPermission represents a team permission.
TeamPermissions represents a collection of team permissions.
TeamProject represents a team project in Bitbucket.
TeamProjectLinks represents the "links" object in a Bitbucket team project.
TeamProjectRequest represents a request to create/update a team project.
TeamProjects represents a collection of team projects.
TeamRepoPermission represents a team repository permission.
TeamRepoPermissions represents a collection of team repository permissions.
Teams represents a collection of teams.
User represents a Bitbucket user.
UserEmail represents an individual user's email address.
UserEmailLinks represents the "links" object in a Bitbucket user email.
UserEmails represents a collection of user emails.
UserHook represents a user hook.
UserHooks represent a user's hooks.
UserLinks represents the "links" object in a Bitbucket user.
UserRepositoriesPermission represents a user's repository permission.
UserRepositoriesPermissions represents a collection of a user's permissions on repositories.
Users represents a collection of users.
UsersSSHKey represents a user ssh key added to Bitbucket.
UsersSSHKeyLinks represents the "links" object in a Bitbucket user ssh key.
UsersSSHKeys represents a collection of user ssh keys.
UserTeamsPermission represents a user's team permission.
UserTeamsPermissions represents a collection of a user's permissions on repositories.
Version represents a Bitbucket repository version.
VersionLinks represents the "links" object in a Bitbucket version.
VersionRequest represents an EXISTING version to be added to an issue or pull request.
Versions represents a collection of versions.

# Type aliases

BranchingModelService handles communication with the branching model related methods of the Bitbucket API.
BranchRestrictionsService handles communication with the branch restrictions related methods of the Bitbucket API.
CommitService handles communication with the commit related methods of the Bitbucket API.
CommitsService handles communication with the commits related methods of the Bitbucket API.
ComponentsService handles communication with the user related methods of the Bitbucket API.
DefaultReviewersService handles communication with the default reviewers related methods of the Bitbucket API.
DeployKeysService handles communication with the deploy keys related methods of the Bitbucket API.
DiffService handles communication with the diff related methods of the Bitbucket API.
DownloadsService handles communication with the downloads related methods of the Bitbucket API.
FileHistoryService handles communication with the file history related methods of the Bitbucket API.
ForksService handles communication with the issue related methods of the Bitbucket API.
HookEventsService handles communication with the hook events related methods of the Bitbucket API.
IssuesService handles communication with the issue related methods of the Bitbucket API.
MilestonesService handles communication with the milestone related methods of the Bitbucket API.
Option is a functional option for configuring the API client.
PatchService handles communication with the patch related methods of the Bitbucket API.
PullRequestsService handles communication with the pull requests related methods of the Bitbucket API.
RefsService handles communication with the refs related methods of the Bitbucket API.
RepositoriesService handles communication with the repository related methods of the Bitbucket API.
SRCService handles communication with the src related methods of the Bitbucket API.
TeamsService handles communication with the teams related methods of the Bitbucket API.
UserService handles communication with the user related methods of the Bitbucket API.
UsersService handles communication with the users related methods of the Bitbucket API.
VersionsService handles communication with the version related methods of the Bitbucket API.
WatchersService handles communication with the watchers related methods of the Bitbucket API.