Class BitbucketCloudClient

Index

Methods

listBranchesByRepository listProjectsByWorkspace listRepositoriesByWorkspace listWorkspaces searchCode fromConfig

Methods

listBranchesByRepository

listBranchesByRepository(
    repository: string,
    workspace: string,
    options?: FilterAndSortOptions & PartialResponseOptions,
): WithPagination<PaginatedBranches, Branch>
Parameters
- repository: string
- workspace: string
- Optionaloptions: FilterAndSortOptions & PartialResponseOptions
Returns WithPagination<PaginatedBranches, Branch>
- Defined in plugins/bitbucket-cloud-common/src/BitbucketCloudClient.ts:103

listProjectsByWorkspace

listProjectsByWorkspace(
workspace: string,
options?: FilterAndSortOptions & PartialResponseOptions,
): WithPagination<PaginatedProjects, Project>
Parameters
- workspace: string
- Optionaloptions: FilterAndSortOptions & PartialResponseOptions
Returns WithPagination<PaginatedProjects, Project>
- Defined in plugins/bitbucket-cloud-common/src/BitbucketCloudClient.ts:77

listRepositoriesByWorkspace

listRepositoriesByWorkspace(
workspace: string,
options?: FilterAndSortOptions & PartialResponseOptions,
): WithPagination<PaginatedRepositories, Repository>
Parameters
- workspace: string
- Optionaloptions: FilterAndSortOptions & PartialResponseOptions
Returns WithPagination<PaginatedRepositories, Repository>
- Defined in plugins/bitbucket-cloud-common/src/BitbucketCloudClient.ts:61

listWorkspaces

listWorkspaces(
options?: FilterAndSortOptions & PartialResponseOptions,
): WithPagination<PaginatedWorkspaces, Workspace>
Parameters
- Optionaloptions: FilterAndSortOptions & PartialResponseOptions
Returns WithPagination<PaginatedWorkspaces, Workspace>
- Defined in plugins/bitbucket-cloud-common/src/BitbucketCloudClient.ts:93

searchCode

searchCode(
    workspace: string,
    query: string,
    options?: FilterAndSortOptions & PartialResponseOptions,
    pagelen?: number,
): WithPagination<SearchResultPage, SearchCodeSearchResult>
Parameters
- workspace: string
- query: string
- Optionaloptions: FilterAndSortOptions & PartialResponseOptions
- Optionalpagelen: number
Returns WithPagination<SearchResultPage, SearchCodeSearchResult>
- Defined in plugins/bitbucket-cloud-common/src/BitbucketCloudClient.ts:42

`Static`fromConfig

fromConfig(config: BitbucketCloudIntegrationConfig): BitbucketCloudClient
Parameters
- config: BitbucketCloudIntegrationConfig
Returns BitbucketCloudClient
- Defined in plugins/bitbucket-cloud-common/src/BitbucketCloudClient.ts:32