bitbucket/lib/bitbucket.d.ts

Bitbucket API client for Browser and Node.js

import {
  APIClient as BareAPIClient,
  Options as BareOptions,
  Plugin,
} from '../src/client/types'
import { Routes } from '../src/plugins/register-endpoints/types'
import { PaginatedResponseData, Response } from '../src/request/types'
import { AuthOptions } from '../src/plugins/auth/types'

interface Options extends BareOptions {
  auth?: AuthOptions
  notice?: boolean
}

type AsyncResponse<T> = Promise<Response<T>>

export interface APIClient extends BareAPIClient {
  hasNextPage(data: PaginatedResponseData<any>): boolean
  getNextPage<T>(data: PaginatedResponseData<T>): Response<T>
  hasPreviousPage(data: PaginatedResponseData<any>): boolean
  getPreviousPage<T>(data: PaginatedResponseData<T>): Response<T>

  registerEndpoints(routes: Routes): void
}

export interface APIClientFactory<APIClient> {
  new (options?: Options): APIClient
  (options?: Options): APIClient

  plugins(plugins: Plugin[]): APIClientFactory<APIClient>
}

export namespace Schema {
  export type Any = any
  export type AnyObject = { [key: string]: any }

  export type APullrequestCommentTask = APullRequestTask & {
    comment?: Comment
  }
  export type APullRequestTask = Task & {
    links?: {
      html?: {
        href?: string
        name?: string
      }
      self?: {
        href?: string
        name?: string
      }
    }
  }
  export type Account = Object & {
    created_on?: string
    display_name?: string
    links?: AccountLinks
    uuid?: string
    [k: string]: unknown
  }
  export type Comment = Object & {
    content?: {
      html?: string
      markup?: 'markdown' | 'creole' | 'plaintext'
      raw?: string
    }
    created_on?: string
    deleted?: boolean
    id?: number
    inline?: {
      from?: number
      path: string
      to?: number
    }
    links?: {
      code?: {
        href?: string
        name?: string
      }
      html?: {
        href?: string
        name?: string
      }
      self?: {
        href?: string
        name?: string
      }
    }
    parent?: Comment
    updated_on?: string
    user?: Account
    [k: string]: unknown
  }
  export type Branch = Ref & {
    default_merge_strategy?: string
    merge_strategies?: ('merge_commit' | 'squash' | 'fast_forward')[]
    [k: string]: unknown
  }
  export type Commit = BaseCommit & {
    participants?: Participant[]
    repository?: Repository
    [k: string]: unknown
  }
  export type BaseCommit = Object & {
    author?: Author
    date?: string
    hash?: string
    message?: string
    parents?: BaseCommit[]
    summary?: {
      html?: string
      markup?: 'markdown' | 'creole' | 'plaintext'
      raw?: string
    }
    [k: string]: unknown
  }
  export type Author = Object & {
    raw?: string
    user?: Account
    [k: string]: unknown
  }
  export type Participant = Object & {
    approved?: boolean
    participated_on?: string
    role?: 'PARTICIPANT' | 'REVIEWER'
    state?: 'approved' | 'changes_requested' | null
    user?: Account
    [k: string]: unknown
  }
  export type Repository = Object & {
    created_on?: string
    description?: string
    fork_policy?: 'allow_forks' | 'no_public_forks' | 'no_forks'
    full_name?: string
    has_issues?: boolean
    has_wiki?: boolean
    is_private?: boolean
    language?: string
    links?: {
      avatar?: {
        href?: string
        name?: string
      }
      clone?: {
        href?: string
        name?: string
      }[]
      commits?: {
        href?: string
        name?: string
      }
      downloads?: {
        href?: string
        name?: string
      }
      forks?: {
        href?: string
        name?: string
      }
      hooks?: {
        href?: string
        name?: string
      }
      html?: {
        href?: string
        name?: string
      }
      pullrequests?: {
        href?: string
        name?: string
      }
      self?: {
        href?: string
        name?: string
      }
      watchers?: {
        href?: string
        name?: string
      }
    }
    mainbranch?: Branch
    name?: string
    owner?: Account
    parent?: Repository
    project?: Project
    scm?: 'git'
    size?: number
    updated_on?: string
    uuid?: string
    [k: string]: unknown
  }
  export type Project = Object & {
    created_on?: string
    description?: string
    has_publicly_visible_repos?: boolean
    is_private?: boolean
    key?: string
    links?: {
      avatar?: {
        href?: string
        name?: string
      }
      html?: {
        href?: string
        name?: string
      }
    }
    name?: string
    owner?: Team
    updated_on?: string
    uuid?: string
    [k: string]: unknown
  }
  export type Team = Account & {
    links?: TeamLinks
    [k: string]: unknown
  }
  export type TeamLinks = AccountLinks & {
    html?: Link
    members?: Link
    projects?: Link
    repositories?: Link
    self?: Link
    [k: string]: unknown
  }
  export type BranchingModel = Object & {
    branch_types?:
      | []
      | [
          {
            kind: 'feature' | 'bugfix' | 'release' | 'hotfix'
            prefix: string
          }
        ]
      | [
          {
            kind: 'feature' | 'bugfix' | 'release' | 'hotfix'
            prefix: string
          },
          {
            kind: 'feature' | 'bugfix' | 'release' | 'hotfix'
            prefix: string
          }
        ]
      | [
          {
            kind: 'feature' | 'bugfix' | 'release' | 'hotfix'
            prefix: string
          },
          {
            kind: 'feature' | 'bugfix' | 'release' | 'hotfix'
            prefix: string
          },
          {
            kind: 'feature' | 'bugfix' | 'release' | 'hotfix'
            prefix: string
          }
        ]
      | [
          {
            kind: 'feature' | 'bugfix' | 'release' | 'hotfix'
            prefix: string
          },
          {
            kind: 'feature' | 'bugfix' | 'release' | 'hotfix'
            prefix: string
          },
          {
            kind: 'feature' | 'bugfix' | 'release' | 'hotfix'
            prefix: string
          },
          {
            kind: 'feature' | 'bugfix' | 'release' | 'hotfix'
            prefix: string
          }
        ]
    development?: {
      branch?: Branch
      name: string
      use_mainbranch: boolean
    }
    production?: {
      branch?: Branch
      name: string
      use_mainbranch: boolean
    }
    [k: string]: unknown
  }
  export type BranchingModelSettings = Object & {
    branch_types?:
      | []
      | [
          {
            enabled?: boolean
            kind: 'feature' | 'bugfix' | 'release' | 'hotfix'
            prefix?: string
          }
        ]
      | [
          {
            enabled?: boolean
            kind: 'feature' | 'bugfix' | 'release' | 'hotfix'
            prefix?: string
          },
          {
            enabled?: boolean
            kind: 'feature' | 'bugfix' | 'release' | 'hotfix'
            prefix?: string
          }
        ]
      | [
          {
            enabled?: boolean
            kind: 'feature' | 'bugfix' | 'release' | 'hotfix'
            prefix?: string
          },
          {
            enabled?: boolean
            kind: 'feature' | 'bugfix' | 'release' | 'hotfix'
            prefix?: string
          },
          {
            enabled?: boolean
            kind: 'feature' | 'bugfix' | 'release' | 'hotfix'
            prefix?: string
          }
        ]
      | [
          {
            enabled?: boolean
            kind: 'feature' | 'bugfix' | 'release' | 'hotfix'
            prefix?: string
          },
          {
            enabled?: boolean
            kind: 'feature' | 'bugfix' | 'release' | 'hotfix'
            prefix?: string
          },
          {
            enabled?: boolean
            kind: 'feature' | 'bugfix' | 'release' | 'hotfix'
            prefix?: string
          },
          {
            enabled?: boolean
            kind: 'feature' | 'bugfix' | 'release' | 'hotfix'
            prefix?: string
          }
        ]
    development?: {
      is_valid?: boolean
      name?: string
      use_mainbranch?: boolean
    }
    links?: {
      self?: {
        href?: string
        name?: string
      }
    }
    production?: {
      enabled?: boolean
      is_valid?: boolean
      name?: string
      use_mainbranch?: boolean
    }
    [k: string]: unknown
  }
  export type Branchrestriction = Object & {
    groups?: Group[]
    users?: Account[]
    [k: string]: unknown
  }
  export type Group = Object & {
    full_slug?: string
    links?: {
      html?: {
        href?: string
        name?: string
      }
      self?: {
        href?: string
        name?: string
      }
    }
    name?: string
    owner?: Account
    slug?: string
    workspace?: Workspace
    [k: string]: unknown
  }
  export type Workspace = Object & {
    created_on?: string
    is_private?: boolean
    links?: {
      avatar?: {
        href?: string
        name?: string
      }
      html?: {
        href?: string
        name?: string
      }
      members?: {
        href?: string
        name?: string
      }
      owners?: {
        href?: string
        name?: string
      }
      projects?: {
        href?: string
        name?: string
      }
      repositories?: {
        href?: string
        name?: string
      }
      self?: {
        href?: string
        name?: string
      }
      snippets?: {
        href?: string
        name?: string
      }
    }
    name?: string
    slug?: string
    updated_on?: string
    uuid?: string
    [k: string]: unknown
  }
  export type CommitComment = Comment & {
    commit?: Commit
    [k: string]: unknown
  }
  export type Commitstatus = Object & {
    created_on?: string
    description?: string
    key?: string
    links?: {
      commit?: {
        href?: string
        name?: string
      }
      self?: {
        href?: string
        name?: string
      }
    }
    name?: string
    refname?: string
    state?: 'SUCCESSFUL' | 'STOPPED' | 'INPROGRESS' | 'FAILED'
    updated_on?: string
    url?: string
    uuid?: string
    [k: string]: unknown
  }
  export type Component = Object & {
    id?: number
    links?: {
      self?: {
        href?: string
        name?: string
      }
    }
    name?: string
    [k: string]: unknown
  }
  export type DeployKey = Object & {
    added_on?: string
    comment?: string
    key?: string
    label?: string
    last_used?: string
    links?: {
      self?: {
        href?: string
        name?: string
      }
    }
    owner?: Account
    repository?: Repository
    [k: string]: unknown
  }
  export type Deployment = Object & {
    environment?: DeploymentEnvironment
    release?: DeploymentRelease
    state?: DeploymentState
    uuid?: string
    [k: string]: unknown
  }
  export type DeploymentEnvironment = Object & {
    name?: string
    uuid?: string
    [k: string]: unknown
  }
  export type DeploymentRelease = Object & {
    commit?: Commit
    created_on?: string
    name?: string
    url?: string
    uuid?: string
    [k: string]: unknown
  }
  export type DeploymentState = Object & {
    [k: string]: unknown
  }
  export type DeploymentVariable = Object & {
    key?: string
    secured?: boolean
    uuid?: string
    value?: string
    [k: string]: unknown
  }
  export type EffectiveRepoBranchingModel = Object & {
    branch_types?:
      | []
      | [
          {
            kind: 'feature' | 'bugfix' | 'release' | 'hotfix'
            prefix: string
          }
        ]
      | [
          {
            kind: 'feature' | 'bugfix' | 'release' | 'hotfix'
            prefix: string
          },
          {
            kind: 'feature' | 'bugfix' | 'release' | 'hotfix'
            prefix: string
          }
        ]
      | [
          {
            kind: 'feature' | 'bugfix' | 'release' | 'hotfix'
            prefix: string
          },
          {
            kind: 'feature' | 'bugfix' | 'release' | 'hotfix'
            prefix: string
          },
          {
            kind: 'feature' | 'bugfix' | 'release' | 'hotfix'
            prefix: string
          }
        ]
      | [
          {
            kind: 'feature' | 'bugfix' | 'release' | 'hotfix'
            prefix: string
          },
          {
            kind: 'feature' | 'bugfix' | 'release' | 'hotfix'
            prefix: string
          },
          {
            kind: 'feature' | 'bugfix' | 'release' | 'hotfix'
            prefix: string
          },
          {
            kind: 'feature' | 'bugfix' | 'release' | 'hotfix'
            prefix: string
          }
        ]
    development?: {
      branch?: Branch
      name: string
      use_mainbranch: boolean
    }
    production?: {
      branch?: Branch
      name: string
      use_mainbranch: boolean
    }
    [k: string]: unknown
  }
  export type Issue = Object & {
    assignee?: Account
    component?: Component
    content?: {
      html?: string
      markup?: 'markdown' | 'creole' | 'plaintext'
      raw?: string
    }
    created_on?: string
    edited_on?: string
    id?: number
    kind?: 'bug' | 'enhancement' | 'proposal' | 'task'
    links?: {
      attachments?: {
        href?: string
        name?: string
      }
      comments?: {
        href?: string
        name?: string
      }
      html?: {
        href?: string
        name?: string
      }
      self?: {
        href?: string
        name?: string
      }
      vote?: {
        href?: string
        name?: string
      }
      watch?: {
        href?: string
        name?: string
      }
    }
    milestone?: Milestone
    priority?: 'trivial' | 'minor' | 'major' | 'critical' | 'blocker'
    reporter?: Account
    repository?: Repository
    state?:
      | 'submitted'
      | 'new'
      | 'open'
      | 'resolved'
      | 'on hold'
      | 'invalid'
      | 'duplicate'
      | 'wontfix'
      | 'closed'
    title?: string
    updated_on?: string
    version?: Version
    votes?: number
    [k: string]: unknown
  }
  export type Milestone = Object & {
    id?: number
    links?: {
      self?: {
        href?: string
        name?: string
      }
    }
    name?: string
    [k: string]: unknown
  }
  export type Version = Object & {
    id?: number
    links?: {
      self?: {
        href?: string
        name?: string
      }
    }
    name?: string
    [k: string]: unknown
  }
  export type IssueComment = Comment & {
    issue?: Issue
    [k: string]: unknown
  }
  export type ReportAnnotation = Object & {
    annotation_type?: 'VULNERABILITY' | 'CODE_SMELL' | 'BUG'
    created_on?: string
    details?: string
    external_id?: string
    line?: number
    link?: string
    path?: string
    result?: 'PASSED' | 'FAILED' | 'SKIPPED' | 'IGNORED'
    severity?: 'CRITICAL' | 'HIGH' | 'MEDIUM' | 'LOW'
    summary?: string
    updated_on?: string
    uuid?: string
    [k: string]: unknown
  }
  export type User = Account & {
    account_id?: string
    account_status?: string
    has_2fa_enabled?: boolean
    is_staff?: boolean
    links?: UserLinks
    nickname?: string
    [k: string]: unknown
  }
  export type UserLinks = AccountLinks & {
    html?: Link
    repositories?: Link
    self?: Link
    [k: string]: unknown
  }
  export type IssueAttachment = Object & {
    links?: {
      self?: {
        href?: string
        name?: string
      }
    }
    name?: string
    [k: string]: unknown
  }
  export type PipelineCache = Object & {
    created_on?: string
    file_size_bytes?: number
    key_hash?: string
    name?: string
    path?: string
    pipeline_uuid?: string
    step_uuid?: string
    uuid?: string
    [k: string]: unknown
  }
  export type PipelineKnownHost = Object & {
    hostname?: string
    public_key?: PipelineSshPublicKey
    uuid?: string
    [k: string]: unknown
  }
  export type PipelineSshPublicKey = Object & {
    key?: string
    key_type?: string
    md5_fingerprint?: string
    sha256_fingerprint?: string
    [k: string]: unknown
  }
  export type PipelineScheduleExecution = Object & {
    [k: string]: unknown
  }
  export type PipelineSchedule = Object & {
    created_on?: string
    cron_pattern?: string
    enabled?: boolean
    target?: PipelineRefTarget
    updated_on?: string
    uuid?: string
    [k: string]: unknown
  }
  export type PipelineRefTarget = PipelineTarget & {
    commit?: Commit
    ref_name?: string
    ref_type?: 'branch' | 'tag' | 'named_branch' | 'bookmark'
    selector?: PipelineSelector
    [k: string]: unknown
  }
  export type PipelineTarget = Object & {
    [k: string]: unknown
  }
  export type PipelineSelector = Object & {
    pattern?: string
    type?: 'branches' | 'tags' | 'bookmarks' | 'default' | 'custom'
    [k: string]: unknown
  }
  export type PipelineStep = Object & {
    completed_on?: string
    image?: PipelineImage
    script_commands?: PipelineCommand[]
    setup_commands?: PipelineCommand[]
    started_on?: string
    state?: PipelineStepState
    uuid?: string
    [k: string]: unknown
  }
  export type PipelineStepState = Object & {
    [k: string]: unknown
  }
  export type PipelineVariable = Object & {
    key?: string
    secured?: boolean
    uuid?: string
    value?: string
    [k: string]: unknown
  }
  export type Pipeline = Object & {
    build_number?: number
    build_seconds_used?: number
    completed_on?: string
    configuration_sources?: PipelineConfigurationSource[]
    created_on?: string
    creator?: Account
    links?: PipelinesPipelineLinks
    repository?: Repository
    state?: PipelineState
    target?: PipelineTarget
    trigger?: PipelineTrigger
    uuid?: string
    variables?: PipelineVariable[]
    [k: string]: unknown
  }
  export type PipelinesPipelineLinks = Object & {
    self?: PipelinesLinksSectionHref
    steps?: PipelinesLinksSectionHref
    [k: string]: unknown
  }
  export type PipelinesLinksSectionHref = Object & {
    href?: string
    [k: string]: unknown
  }
  export type PipelineState = Object & {
    [k: string]: unknown
  }
  export type PipelineTrigger = Object & {
    [k: string]: unknown
  }
  export type ProjectDeployKey = Object & {
    added_on?: string
    comment?: string
    created_by?: Account
    key?: string
    label?: string
    last_used?: string
    links?: {
      self?: {
        href?: string
        name?: string
      }
    }
    project?: Project
    [k: string]: unknown
  }
  export type PullrequestComment = Comment & {
    pending?: boolean
    pullrequest?: Pullrequest
    resolution?: CommentResolution
    [k: string]: unknown
  }
  export type Pullrequest = Object & {
    author?: Account
    close_source_branch?: boolean
    closed_by?: Account
    comment_count?: number
    created_on?: string
    destination?: PullrequestEndpoint
    id?: number
    links?: {
      activity?: {
        href?: string
        name?: string
      }
      approve?: {
        href?: string
        name?: string
      }
      comments?: {
        href?: string
        name?: string
      }
      commits?: {
        href?: string
        name?: string
      }
      decline?: {
        href?: string
        name?: string
      }
      diff?: {
        href?: string
        name?: string
      }
      diffstat?: {
        href?: string
        name?: string
      }
      html?: {
        href?: string
        name?: string
      }
      merge?: {
        href?: string
        name?: string
      }
      self?: {
        href?: string
        name?: string
      }
    }
    merge_commit?: {
      hash?: string
    }
    participants?: Participant[]
    reason?: string
    rendered?: {
      description?: {
        html?: string
        markup?: 'markdown' | 'creole' | 'plaintext'
        raw?: string
      }
      reason?: {
        html?: string
        markup?: 'markdown' | 'creole' | 'plaintext'
        raw?: string
      }
      title?: {
        html?: string
        markup?: 'markdown' | 'creole' | 'plaintext'
        raw?: string
      }
    }
    reviewers?: Account[]
    source?: PullrequestEndpoint
    state?: 'OPEN' | 'MERGED' | 'DECLINED' | 'SUPERSEDED'
    summary?: {
      html?: string
      markup?: 'markdown' | 'creole' | 'plaintext'
      raw?: string
    }
    task_count?: number
    title?: string
    updated_on?: string
    [k: string]: unknown
  }
  export type Report = Object & {
    created_on?: string
    data?: ReportData[]
    details?: string
    external_id?: string
    link?: string
    logo_url?: string
    remote_link_enabled?: boolean
    report_type?: 'SECURITY' | 'COVERAGE' | 'TEST' | 'BUG'
    reporter?: string
    result?: 'PASSED' | 'FAILED' | 'PENDING'
    title?: string
    updated_on?: string
    uuid?: string
    [k: string]: unknown
  }
  export type SnippetComment = Object & {
    links?: {
      html?: {
        href?: string
        name?: string
      }
      self?: {
        href?: string
        name?: string
      }
    }
    snippet?: Snippet
    [k: string]: unknown
  }
  export type Snippet = Object & {
    created_on?: string
    creator?: Account
    id?: number
    is_private?: boolean
    owner?: Account
    scm?: 'git'
    title?: string
    updated_on?: string
    [k: string]: unknown
  }
  export type SnippetCommit = BaseCommit & {
    links?: {
      diff?: {
        href?: string
        name?: string
      }
      html?: {
        href?: string
        name?: string
      }
      self?: {
        href?: string
        name?: string
      }
    }
    snippet?: Snippet
    [k: string]: unknown
  }
  export type SshAccountKey = SshKey & {
    owner?: Account
    [k: string]: unknown
  }
  export type SshKey = Object & {
    comment?: string
    created_on?: string
    key?: string
    label?: string
    last_used?: string
    links?: {
      self?: {
        href?: string
        name?: string
      }
    }
    uuid?: string
    [k: string]: unknown
  }
  export type Tag = Ref & {
    date?: string
    message?: string
    tagger?: Author
    [k: string]: unknown
  }
  export type WebhookSubscription = Object & {
    active?: boolean
    created_at?: string
    description?: string
    events?: (
      | 'pullrequest:comment_resolved'
      | 'issue:created'
      | 'pullrequest:comment_deleted'
      | 'pullrequest:changes_request_created'
      | 'issue:comment_created'
      | 'pullrequest:updated'
      | 'issue:updated'
      | 'repo:commit_status_updated'
      | 'repo:updated'
      | 'pullrequest:comment_updated'
      | 'repo:commit_status_created'
      | 'pullrequest:unapproved'
      | 'pullrequest:rejected'
      | 'pullrequest:changes_request_removed'
      | 'pullrequest:created'
      | 'project:updated'
      | 'repo:deleted'
      | 'pullrequest:comment_reopened'
      | 'pullrequest:fulfilled'
      | 'repo:imported'
      | 'repo:push'
      | 'repo:fork'
      | 'repo:created'
      | 'repo:transfer'
      | 'pullrequest:approved'
      | 'repo:commit_comment_created'
      | 'pullrequest:comment_created'
    )[]
    secret?: string
    secret_set?: boolean
    subject?: Object
    subject_type?: 'repository' | 'workspace'
    url?: string
    uuid?: string
    [k: string]: unknown
  }
  export type WorkspaceMembership = Object & {
    links?: {
      self?: {
        href?: string
        name?: string
      }
    }
    user?: Account
    workspace?: Workspace
    [k: string]: unknown
  }
  export type PipelineBuildNumber = Object & {
    next?: number
    [k: string]: unknown
  }
  export type PipelineSchedulePostRequestBody = Object & {
    cron_pattern: string
    enabled?: boolean
    target: {
      ref_name: string
      ref_type: 'branch'
      selector: PipelineSelector
      [k: string]: unknown
    }
    [k: string]: unknown
  }
  export type PipelineSchedulePutRequestBody = Object & {
    enabled?: boolean
    [k: string]: unknown
  }
  export type PipelineSshKeyPair = Object & {
    private_key?: string
    public_key?: string
    [k: string]: unknown
  }
  export type PipelinesConfig = Object & {
    enabled?: boolean
    repository?: Repository
    [k: string]: unknown
  }
  export type ProjectBranchingModel = Object & {
    branch_types?:
      | []
      | [
          {
            kind: 'feature' | 'bugfix' | 'release' | 'hotfix'
            prefix: string
          }
        ]
      | [
          {
            kind: 'feature' | 'bugfix' | 'release' | 'hotfix'
            prefix: string
          },
          {
            kind: 'feature' | 'bugfix' | 'release' | 'hotfix'
            prefix: string
          }
        ]
      | [
          {
            kind: 'feature' | 'bugfix' | 'release' | 'hotfix'
            prefix: string
          },
          {
            kind: 'feature' | 'bugfix' | 'release' | 'hotfix'
            prefix: string
          },
          {
            kind: 'feature' | 'bugfix' | 'release' | 'hotfix'
            prefix: string
          }
        ]
      | [
          {
            kind: 'feature' | 'bugfix' | 'release' | 'hotfix'
            prefix: string
          },
          {
            kind: 'feature' | 'bugfix' | 'release' | 'hotfix'
            prefix: string
          },
          {
            kind: 'feature' | 'bugfix' | 'release' | 'hotfix'
            prefix: string
          },
          {
            kind: 'feature' | 'bugfix' | 'release' | 'hotfix'
            prefix: string
          }
        ]
    development?: {
      name: string
      use_mainbranch: boolean
    }
    production?: {
      name: string
      use_mainbranch: boolean
    }
    [k: string]: unknown
  }
  export interface Task {
    content: {
      html?: string
      markup?: 'markdown' | 'creole' | 'plaintext'
      raw?: string
    }
    created_on: string
    creator: Account
    id?: number
    pending?: boolean
    resolved_by?: Account
    resolved_on?: string
    state: 'RESOLVED' | 'UNRESOLVED'
    updated_on: string
  }
  export interface Object {
    type: string
    [k: string]: unknown
  }
  export interface AccountLinks {
    avatar?: Link
    [k: string]: unknown
  }
  export interface Link {
    href?: string
    name?: string
  }
  export interface APullrequestTaskCreate {
    comment?: Comment
    content: {
      raw: string
    }
    pending?: boolean
  }
  export interface APullrequestTaskUpdate {
    content?: {
      raw: string
    }
    state?: 'RESOLVED' | 'UNRESOLVED'
  }
  export interface ApplicationProperty {
    _attributes?: ('public' | 'read_only')[]
    [k: string]: unknown
  }
  export interface BitbucketAppsPermissionsSerializersProjectPermissionUpdateSchema {
    permission: 'read' | 'write' | 'create-repo' | 'admin'
  }
  export interface BitbucketAppsPermissionsSerializersRepoPermissionUpdateSchema {
    permission: 'read' | 'write' | 'admin'
  }
  export interface Ref {
    links?: {
      commits?: {
        href?: string
        name?: string
      }
      html?: {
        href?: string
        name?: string
      }
      self?: {
        href?: string
        name?: string
      }
    }
    name?: string
    target?: Commit
    type: string
    [k: string]: unknown
  }
  export interface CommentResolution {
    created_on?: string
    type: string
    user?: Account
    [k: string]: unknown
  }
  export interface Error {
    error?: {
      data?: {
        [k: string]: unknown
      }
      detail?: string
      message: string
    }
    type: string
    [k: string]: unknown
  }
  export interface ExportOptions {
    include_attachments?: boolean
    project_key?: string
    project_name?: string
    send_email?: boolean
    type: string
    [k: string]: unknown
  }
  export interface IssueChange {
    changes?: {
      assignee?: {
        new?: string
        old?: string
      }
      component?: {
        new?: string
        old?: string
      }
      content?: {
        new?: string
        old?: string
      }
      kind?: {
        new?: string
        old?: string
      }
      milestone?: {
        new?: string
        old?: string
      }
      priority?: {
        new?: string
        old?: string
      }
      state?: {
        new?: string
        old?: string
      }
      title?: {
        new?: string
        old?: string
      }
      version?: {
        new?: string
        old?: string
      }
    }
    created_on?: string
    issue?: Issue
    links?: {
      issue?: {
        href?: string
        name?: string
      }
      self?: {
        href?: string
        name?: string
      }
    }
    message?: {
      html?: string
      markup?: 'markdown' | 'creole' | 'plaintext'
      raw?: string
    }
    name?: string
    type: string
    user?: Account
    [k: string]: unknown
  }
  export interface IssueJobStatus {
    count?: number
    pct?: number
    phase?: string
    status?: 'ACCEPTED' | 'STARTED' | 'RUNNING' | 'FAILURE'
    total?: number
    type?: string
  }
  export interface PaginatedAccounts {
    next?: string
    page?: number
    pagelen?: number
    previous?: string
    size?: number
    values?: Account[]
  }
  export interface PaginatedAnnotations {
    next?: string
    page?: number
    pagelen?: number
    previous?: string
    size?: number
    values?: ReportAnnotation[]
    [k: string]: unknown
  }
  export interface PaginatedBranches {
    next?: string
    page?: number
    pagelen?: number
    previous?: string
    size?: number
    values?: Branch[]
  }
  export interface PaginatedBranchrestrictions {
    next?: string
    page?: number
    pagelen?: number
    previous?: string
    size?: number
    values?: Branchrestriction[]
  }
  export interface PaginatedChangeset {
    next?: string
    page?: number
    pagelen?: number
    previous?: string
    size?: number
    values?: BaseCommit[]
  }
  export interface PaginatedCommitComments {
    next?: string
    page?: number
    pagelen?: number
    previous?: string
    size?: number
    values?: CommitComment[]
  }
  export interface PaginatedCommitstatuses {
    next?: string
    page?: number
    pagelen?: number
    previous?: string
    size?: number
    values?: Commitstatus[]
  }
  export interface PaginatedComponents {
    next?: string
    page?: number
    pagelen?: number
    previous?: string
    size?: number
    values?: Component[]
  }
  export interface PaginatedDefaultReviewerAndType {
    next?: string
    page?: number
    pagelen?: number
    previous?: string
    size?: number
    values?: DefaultReviewerAndType[]
  }
  export interface DefaultReviewerAndType {
    reviewer_type?: string
    type: string
    user?: User
    [k: string]: unknown
  }
  export interface PaginatedDeployKeys {
    next?: string
    page?: number
    pagelen?: number
    previous?: string
    size?: number
    values?: DeployKey[]
  }
  export interface PaginatedDeploymentVariable {
    next?: string
    page?: number
    pagelen?: number
    previous?: string
    size?: number
    values?: DeploymentVariable[]
    [k: string]: unknown
  }
  export interface PaginatedDeployments {
    next?: string
    page?: number
    pagelen?: number
    previous?: string
    size?: number
    values?: Deployment[]
    [k: string]: unknown
  }
  export interface PaginatedDiffstats {
    next?: string
    page?: number
    pagelen?: number
    previous?: string
    size?: number
    values?: Diffstat[]
  }
  export interface Diffstat {
    lines_added?: number
    lines_removed?: number
    new?: CommitFile
    old?: CommitFile
    status?: 'added' | 'removed' | 'modified' | 'renamed'
    type: string
    [k: string]: unknown
  }
  export interface CommitFile {
    attributes?: 'link' | 'executable' | 'subrepository' | 'binary' | 'lfs'
    commit?: Commit
    escaped_path?: string
    path?: string
    type: string
    [k: string]: unknown
  }
  export interface PaginatedEnvironments {
    next?: string
    page?: number
    pagelen?: number
    previous?: string
    size?: number
    values?: DeploymentEnvironment[]
    [k: string]: unknown
  }
  export interface PaginatedFiles {
    next?: string
    page?: number
    pagelen?: number
    previous?: string
    size?: number
    values?: CommitFile[]
  }
  export interface PaginatedHookEvents {
    next?: string
    page?: number
    pagelen?: number
    previous?: string
    size?: number
    values?: HookEvent[]
  }
  export interface HookEvent {
    category?: string
    description?: string
    event?:
      | 'pullrequest:comment_resolved'
      | 'issue:created'
      | 'pullrequest:comment_deleted'
      | 'pullrequest:changes_request_created'
      | 'issue:comment_created'
      | 'pullrequest:updated'
      | 'issue:updated'
      | 'repo:commit_status_updated'
      | 'repo:updated'
      | 'pullrequest:comment_updated'
      | 'repo:commit_status_created'
      | 'pullrequest:unapproved'
      | 'pullrequest:rejected'
      | 'pullrequest:changes_request_removed'
      | 'pullrequest:created'
      | 'project:updated'
      | 'repo:deleted'
      | 'pullrequest:comment_reopened'
      | 'pullrequest:fulfilled'
      | 'repo:imported'
      | 'repo:push'
      | 'repo:fork'
      | 'repo:created'
      | 'repo:transfer'
      | 'pullrequest:approved'
      | 'repo:commit_comment_created'
      | 'pullrequest:comment_created'
    label?: string
  }
  export interface PaginatedIssueAttachments {
    next?: string
    page?: number
    pagelen?: number
    previous?: string
    size?: number
    values?: IssueAttachment[]
  }
  export interface PaginatedIssueComments {
    next?: string
    page?: number
    pagelen?: number
    previous?: string
    size?: number
    values?: IssueComment[]
  }
  export interface PaginatedIssues {
    next?: string
    page?: number
    pagelen?: number
    previous?: string
    size?: number
    values?: Issue[]
  }
  export interface PaginatedLogEntries {
    next?: string
    page?: number
    pagelen?: number
    previous?: string
    size?: number
    values?: IssueChange[]
  }
  export interface PaginatedMilestones {
    next?: string
    page?: number
    pagelen?: number
    previous?: string
    size?: number
    values?: Milestone[]
  }
  export interface PaginatedPipelineCaches {
    next?: string
    page?: number
    pagelen?: number
    previous?: string
    size?: number
    values?: PipelineCache[]
    [k: string]: unknown
  }
  export interface PaginatedPipelineKnownHosts {
    next?: string
    page?: number
    pagelen?: number
    previous?: string
    size?: number
    values?: PipelineKnownHost[]
    [k: string]: unknown
  }
  export interface PaginatedPipelineScheduleExecutions {
    next?: string
    page?: number
    pagelen?: number
    previous?: string
    size?: number
    values?: PipelineScheduleExecution[]
    [k: string]: unknown
  }
  export interface PaginatedPipelineSchedules {
    next?: string
    page?: number
    pagelen?: number
    previous?: string
    size?: number
    values?: PipelineSchedule[]
    [k: string]: unknown
  }
  export interface PaginatedPipelineSteps {
    next?: string
    page?: number
    pagelen?: number
    previous?: string
    size?: number
    values?: PipelineStep[]
    [k: string]: unknown
  }
  export interface PipelineImage {
    email?: string
    name?: string
    password?: string
    username?: string
    [k: string]: unknown
  }
  export interface PipelineCommand {
    command?: string
    name?: string
    [k: string]: unknown
  }
  export interface PaginatedPipelineVariables {
    next?: string
    page?: number
    pagelen?: number
    previous?: string
    size?: number
    values?: PipelineVariable[]
    [k: string]: unknown
  }
  export interface PaginatedPipelines {
    next?: string
    page?: number
    pagelen?: number
    previous?: string
    size?: number
    values?: Pipeline[]
    [k: string]: unknown
  }
  export interface PipelineConfigurationSource {
    source: string
    uri: string
    [k: string]: unknown
  }
  export interface PaginatedProjectDeployKeys {
    next?: string
    page?: number
    pagelen?: number
    previous?: string
    size?: number
    values?: ProjectDeployKey[]
  }
  export interface PaginatedProjectGroupPermissions {
    next?: string
    page?: number
    pagelen?: number
    previous?: string
    size?: number
    values?: ProjectGroupPermission[]
  }
  export interface ProjectGroupPermission {
    group?: Group
    links?: {
      self?: {
        href?: string
        name?: string
      }
    }
    permission?: 'read' | 'write' | 'create-repo' | 'admin' | 'none'
    project?: Project
    type: string
    [k: string]: unknown
  }
  export interface PaginatedProjectUserPermissions {
    next?: string
    page?: number
    pagelen?: number
    previous?: string
    size?: number
    values?: ProjectUserPermission[]
  }
  export interface ProjectUserPermission {
    links?: {
      self?: {
        href?: string
        name?: string
      }
    }
    permission?: 'read' | 'write' | 'create-repo' | 'admin' | 'none'
    project?: Project
    type: string
    user?: User
    [k: string]: unknown
  }
  export interface PaginatedProjects {
    next?: string
    page?: number
    pagelen?: number
    previous?: string
    size?: number
    values?: Project[]
  }
  export interface PaginatedPullrequestComments {
    next?: string
    page?: number
    pagelen?: number
    previous?: string
    size?: number
    values?: PullrequestComment[]
  }
  export interface PullrequestEndpoint {
    branch?: {
      default_merge_strategy?: string
      merge_strategies?: ('merge_commit' | 'squash' | 'fast_forward')[]
      name?: string
    }
    commit?: {
      hash?: string
    }
    repository?: Repository
  }
  export interface PaginatedPullrequests {
    next?: string
    page?: number
    pagelen?: number
    previous?: string
    size?: number
    values?: Pullrequest[]
  }
  export interface PaginatedRefs {
    next?: string
    page?: number
    pagelen?: number
    previous?: string
    size?: number
    values?: Ref[]
  }
  export interface PaginatedReports {
    next?: string
    page?: number
    pagelen?: number
    previous?: string
    size?: number
    values?: Report[]
    [k: string]: unknown
  }
  export interface ReportData {
    title?: string
    type?:
      | 'BOOLEAN'
      | 'DATE'
      | 'DURATION'
      | 'LINK'
      | 'NUMBER'
      | 'PERCENTAGE'
      | 'TEXT'
    value?: {
      [k: string]: unknown
    }
    [k: string]: unknown
  }
  export interface PaginatedRepositories {
    next?: string
    page?: number
    pagelen?: number
    previous?: string
    size?: number
    values?: Repository[]
  }
  export interface PaginatedRepositoryGroupPermissions {
    next?: string
    page?: number
    pagelen?: number
    previous?: string
    size?: number
    values?: RepositoryGroupPermission[]
  }
  export interface RepositoryGroupPermission {
    group?: Group
    links?: {
      self?: {
        href?: string
        name?: string
      }
    }
    permission?: 'read' | 'write' | 'admin' | 'none'
    repository?: Repository
    type: string
    [k: string]: unknown
  }
  export interface PaginatedRepositoryPermissions {
    next?: string
    page?: number
    pagelen?: number
    previous?: string
    size?: number
    values?: RepositoryPermission[]
  }
  export interface RepositoryPermission {
    permission?: 'read' | 'write' | 'admin' | 'none'
    repository?: Repository
    type: string
    user?: User
    [k: string]: unknown
  }
  export interface PaginatedRepositoryUserPermissions {
    next?: string
    page?: number
    pagelen?: number
    previous?: string
    size?: number
    values?: RepositoryUserPermission[]
  }
  export interface RepositoryUserPermission {
    links?: {
      self?: {
        href?: string
        name?: string
      }
    }
    permission?: 'read' | 'write' | 'admin' | 'none'
    repository?: Repository
    type: string
    user?: User
    [k: string]: unknown
  }
  export interface PaginatedSnippetComments {
    next?: string
    page?: number
    pagelen?: number
    previous?: string
    size?: number
    values?: SnippetComment[]
  }
  export interface PaginatedSnippetCommit {
    next?: string
    page?: number
    pagelen?: number
    previous?: string
    size?: number
    values?: SnippetCommit[]
  }
  export interface PaginatedSnippets {
    next?: string
    page?: number
    pagelen?: number
    previous?: string
    size?: number
    values?: Snippet[]
  }
  export interface PaginatedSshUserKeys {
    next?: string
    page?: number
    pagelen?: number
    previous?: string
    size?: number
    values?: SshAccountKey[]
  }
  export interface PaginatedTags {
    next?: string
    page?: number
    pagelen?: number
    previous?: string
    size?: number
    values?: Tag[]
  }
  export interface PaginatedTasks {
    next?: string
    page?: number
    pagelen?: number
    previous?: string
    size?: number
    values?: APullrequestCommentTask[]
  }
  export interface PaginatedTreeentries {
    next?: string
    page?: number
    pagelen?: number
    previous?: string
    size?: number
    values?: Treeentry[]
  }
  export interface Treeentry {
    commit?: Commit
    path?: string
    type: string
    [k: string]: unknown
  }
  export interface PaginatedVersions {
    next?: string
    page?: number
    pagelen?: number
    previous?: string
    size?: number
    values?: Version[]
  }
  export interface PaginatedWebhookSubscriptions {
    next?: string
    page?: number
    pagelen?: number
    previous?: string
    size?: number
    values?: WebhookSubscription[]
  }
  export interface PaginatedWorkspaceMemberships {
    next?: string
    page?: number
    pagelen?: number
    previous?: string
    size?: number
    values?: WorkspaceMembership[]
  }
  export interface PaginatedWorkspaces {
    next?: string
    page?: number
    pagelen?: number
    previous?: string
    size?: number
    values?: Workspace[]
  }
  export interface PipelineCacheContentUri {
    uri?: string
    [k: string]: unknown
  }
  export interface PullrequestMergeParameters {
    close_source_branch?: boolean
    merge_strategy?: 'merge_commit' | 'squash' | 'fast_forward'
    message?: string
    type: string
    [k: string]: unknown
  }
  export interface RepositoryInheritanceState {
    override_settings?: {
      [k: string]: unknown
    }
    type: string
    [k: string]: unknown
  }
  export interface SearchResultPage {
    next?: string
    page?: number
    pagelen?: number
    previous?: string
    query_substituted?: boolean
    size?: number
    values?: SearchCodeSearchResult[]
    [k: string]: unknown
  }
  export interface SearchCodeSearchResult {
    content_match_count?: number
    content_matches?: SearchContentMatch[]
    file?: CommitFile
    path_matches?: SearchSegment[]
    type?: string
    [k: string]: unknown
  }
  export interface SearchContentMatch {
    lines?: SearchLine[]
    [k: string]: unknown
  }
  export interface SearchLine {
    line?: number
    segments?: SearchSegment[]
    [k: string]: unknown
  }
  export interface SearchSegment {
    match?: boolean
    text?: string
    [k: string]: unknown
  }
  export interface SubjectTypes {
    repository?: {
      events?: {
        href?: string
        name?: string
      }
    }
    workspace?: {
      events?: {
        href?: string
        name?: string
      }
    }
  }
}

export namespace Params {
  export type Empty = {}

  export type BranchingModelGet = {
    repo_slug: string
    workspace: string
    fields?: string
  }
  export type BranchingModelGetForProject = {
    project_key: string
    workspace: string
    fields?: string
  }
  export type BranchingModelGetSettings = {
    repo_slug: string
    workspace: string
    fields?: string
  }
  export type BranchingModelGetSettingsForProject = {
    project_key: string
    workspace: string
    fields?: string
  }
  export type BranchingModelUpdateSettings = {
    _body?: Schema.BranchingModelSettings
    repo_slug: string
    workspace: string
  }
  export type BranchingModelUpdateSettingsForProject = {
    project_key: string
    workspace: string
  }
  export type BranchrestrictionsCreate = {
    _body: Schema.Branchrestriction
    repo_slug: string
    workspace: string
  }
  export type BranchrestrictionsDelete = {
    id: string
    repo_slug: string
    workspace: string
  }
  export type BranchrestrictionsGet = {
    id: string
    repo_slug: string
    workspace: string
    fields?: string
  }
  export type BranchrestrictionsList = {
    kind?: string
    pattern?: string
    repo_slug: string
    workspace: string
    page?: string
    pagelen?: number
    q?: string
    sort?: string
    fields?: string
  }
  export type BranchrestrictionsUpdate = {
    _body: Schema.Branchrestriction
    id: string
    repo_slug: string
    workspace: string
  }
  export type CommitsBulkCreateOrUpdateAnnotations = {
    _body: any
    commit: string
    repo_slug: string
    reportId: string
    workspace: string
  }
  export type CommitsCreateApproval = {
    commit: string
    repo_slug: string
    workspace: string
  }
  export type CommitsCreateComment = {
    _body: Schema.CommitComment
    commit: string
    repo_slug: string
    workspace: string
  }
  export type CommitsCreateOrUpdateAnnotation = {
    _body: Schema.ReportAnnotation
    annotationId: string
    commit: string
    repo_slug: string
    reportId: string
    workspace: string
  }
  export type CommitsCreateOrUpdateReport = {
    _body: Schema.Report
    commit: string
    repo_slug: string
    reportId: string
    workspace: string
  }
  export type CommitsDeleteAnnotation = {
    annotationId: string
    commit: string
    repo_slug: string
    reportId: string
    workspace: string
  }
  export type CommitsDeleteApproval = {
    commit: string
    repo_slug: string
    workspace: string
  }
  export type CommitsDeleteComment = {
    comment_id: number
    commit: string
    repo_slug: string
    workspace: string
  }
  export type CommitsDeleteReport = {
    commit: string
    repo_slug: string
    reportId: string
    workspace: string
  }
  export type CommitsGet = {
    commit: string
    repo_slug: string
    workspace: string
    fields?: string
  }
  export type CommitsGetAnnotation = {
    annotationId: string
    commit: string
    repo_slug: string
    reportId: string
    workspace: string
    fields?: string
  }
  export type CommitsGetAnnotationsForReport = {
    commit: string
    repo_slug: string
    reportId: string
    workspace: string
    page?: string
    pagelen?: number
    q?: string
    sort?: string
    fields?: string
  }
  export type CommitsGetComment = {
    comment_id: number
    commit: string
    repo_slug: string
    workspace: string
    fields?: string
  }
  export type CommitsGetDiff = {
    binary?: boolean
    context?: number
    ignore_whitespace?: boolean
    merge?: boolean
    path?: string
    renames?: boolean
    repo_slug: string
    spec: string
    topic?: boolean
    workspace: string
    fields?: string
  }
  export type CommitsGetPatch = {
    repo_slug: string
    spec: string
    workspace: string
    fields?: string
  }
  export type CommitsGetReport = {
    commit: string
    repo_slug: string
    reportId: string
    workspace: string
    fields?: string
  }
  export type CommitsGetReportsForCommit = {
    commit: string
    repo_slug: string
    workspace: string
    page?: string
    pagelen?: number
    q?: string
    sort?: string
    fields?: string
  }
  export type CommitsList = {
    exclude?: string
    include?: string
    repo_slug: string
    workspace: string
    page?: string
    pagelen?: number
    q?: string
    sort?: string
    fields?: string
  }
  export type CommitsListAlt = {
    exclude?: string
    include?: string
    repo_slug: string
    workspace: string
    page?: string
    pagelen?: number
    q?: string
    sort?: string
  }
  export type CommitsListAt = {
    exclude?: string
    include?: string
    repo_slug: string
    revision: string
    workspace: string
    page?: string
    pagelen?: number
    q?: string
    sort?: string
    fields?: string
  }
  export type CommitsListAtAlt = {
    exclude?: string
    include?: string
    repo_slug: string
    revision: string
    workspace: string
    page?: string
    pagelen?: number
    q?: string
    sort?: string
  }
  export type CommitsListComments = {
    commit: string
    repo_slug: string
    workspace: string
    page?: string
    pagelen?: number
    q?: string
    sort?: string
    fields?: string
  }
  export type CommitsUpdateComment = {
    _body: Schema.CommitComment
    comment_id: number
    commit: string
    repo_slug: string
    workspace: string
  }
  export type CommitstatusesCreateBuildStatus = {
    _body?: Schema.Commitstatus
    commit: string
    repo_slug: string
    workspace: string
  }
  export type CommitstatusesGetBuildStatus = {
    commit: string
    key: string
    repo_slug: string
    workspace: string
    fields?: string
  }
  export type CommitstatusesList = {
    commit: string
    repo_slug: string
    workspace: string
    page?: string
    pagelen?: number
    q?: string
    sort?: string
    fields?: string
  }
  export type CommitstatusesListPullRequestStatuses = {
    pull_request_id: number
    repo_slug: string
    workspace: string
    page?: string
    pagelen?: number
    q?: string
    sort?: string
    fields?: string
  }
  export type CommitstatusesUpdateBuildStatus = {
    _body?: Schema.Commitstatus
    commit: string
    key: string
    repo_slug: string
    workspace: string
  }
  export type DeployCreateKey = {
    key: string
    label: string
    repo_slug: string
    workspace: string
  }
  export type DeployDeleteKey = {
    key_id: string
    repo_slug: string
    workspace: string
  }
  export type DeployGetKey = {
    key_id: string
    repo_slug: string
    workspace: string
    fields?: string
  }
  export type DeployListKeys = {
    repo_slug: string
    workspace: string
    page?: string