Options
All
  • Public
  • Public/Protected
  • All
Menu

dcs-js

Index

Classes

Interfaces

Type Aliases

Variables

Functions

Type Aliases

CreateHookOptionTypeEnum

CreateHookOptionTypeEnum: typeof CreateHookOptionTypeEnum[keyof typeof CreateHookOptionTypeEnum]

CreateMilestoneOptionStateEnum

CreateMilestoneOptionStateEnum: typeof CreateMilestoneOptionStateEnum[keyof typeof CreateMilestoneOptionStateEnum]

CreateOrgOptionVisibilityEnum

CreateOrgOptionVisibilityEnum: typeof CreateOrgOptionVisibilityEnum[keyof typeof CreateOrgOptionVisibilityEnum]

CreateRepoOptionTrustModelEnum

CreateRepoOptionTrustModelEnum: typeof CreateRepoOptionTrustModelEnum[keyof typeof CreateRepoOptionTrustModelEnum]

CreateTeamOptionPermissionEnum

CreateTeamOptionPermissionEnum: typeof CreateTeamOptionPermissionEnum[keyof typeof CreateTeamOptionPermissionEnum]

EditOrgOptionVisibilityEnum

EditOrgOptionVisibilityEnum: typeof EditOrgOptionVisibilityEnum[keyof typeof EditOrgOptionVisibilityEnum]

EditTeamOptionPermissionEnum

EditTeamOptionPermissionEnum: typeof EditTeamOptionPermissionEnum[keyof typeof EditTeamOptionPermissionEnum]

MergePullRequestOptionDoEnum

MergePullRequestOptionDoEnum: typeof MergePullRequestOptionDoEnum[keyof typeof MergePullRequestOptionDoEnum]

MigrateRepoOptionsServiceEnum

MigrateRepoOptionsServiceEnum: typeof MigrateRepoOptionsServiceEnum[keyof typeof MigrateRepoOptionsServiceEnum]

TeamPermissionEnum

TeamPermissionEnum: typeof TeamPermissionEnum[keyof typeof TeamPermissionEnum]

Variables

Const CreateHookOptionTypeEnum

CreateHookOptionTypeEnum: { Dingtalk: "dingtalk"; Discord: "discord"; Feishu: "feishu"; Gitea: "gitea"; Gogs: "gogs"; Msteams: "msteams"; Packagist: "packagist"; Slack: "slack"; Telegram: "telegram"; Wechatwork: "wechatwork" } = ...

Type declaration

  • Dingtalk: "dingtalk"
  • Discord: "discord"
  • Feishu: "feishu"
  • Gitea: "gitea"
  • Gogs: "gogs"
  • Msteams: "msteams"
  • Packagist: "packagist"
  • Slack: "slack"
  • Telegram: "telegram"
  • Wechatwork: "wechatwork"

Const CreateMilestoneOptionStateEnum

CreateMilestoneOptionStateEnum: { Closed: "closed"; Open: "open" } = ...

Type declaration

  • Closed: "closed"
  • Open: "open"

Const CreateOrgOptionVisibilityEnum

CreateOrgOptionVisibilityEnum: { Limited: "limited"; Private: "private"; Public: "public" } = ...

Type declaration

  • Limited: "limited"
  • Private: "private"
  • Public: "public"

Const CreateRepoOptionTrustModelEnum

CreateRepoOptionTrustModelEnum: { Collaborator: "collaborator"; Collaboratorcommitter: "collaboratorcommitter"; Committer: "committer"; Default: "default" } = ...

Type declaration

  • Collaborator: "collaborator"
  • Collaboratorcommitter: "collaboratorcommitter"
  • Committer: "committer"
  • Default: "default"

Const CreateTeamOptionPermissionEnum

CreateTeamOptionPermissionEnum: { Admin: "admin"; Read: "read"; Write: "write" } = ...

Type declaration

  • Admin: "admin"
  • Read: "read"
  • Write: "write"

Const EditOrgOptionVisibilityEnum

EditOrgOptionVisibilityEnum: { Limited: "limited"; Private: "private"; Public: "public" } = ...

Type declaration

  • Limited: "limited"
  • Private: "private"
  • Public: "public"

Const EditTeamOptionPermissionEnum

EditTeamOptionPermissionEnum: { Admin: "admin"; Read: "read"; Write: "write" } = ...

Type declaration

  • Admin: "admin"
  • Read: "read"
  • Write: "write"

Const MergePullRequestOptionDoEnum

MergePullRequestOptionDoEnum: { ManuallyMerged: "manually-merged"; Merge: "merge"; Rebase: "rebase"; RebaseMerge: "rebase-merge"; Squash: "squash" } = ...

Type declaration

  • ManuallyMerged: "manually-merged"
  • Merge: "merge"
  • Rebase: "rebase"
  • RebaseMerge: "rebase-merge"
  • Squash: "squash"

Const MigrateRepoOptionsServiceEnum

MigrateRepoOptionsServiceEnum: { Git: "git"; Gitea: "gitea"; Github: "github"; Gitlab: "gitlab" } = ...

Type declaration

  • Git: "git"
  • Gitea: "gitea"
  • Github: "github"
  • Gitlab: "gitlab"

Const TeamPermissionEnum

TeamPermissionEnum: { Admin: "admin"; None: "none"; Owner: "owner"; Read: "read"; Write: "write" } = ...

Type declaration

  • Admin: "admin"
  • None: "none"
  • Owner: "owner"
  • Read: "read"
  • Write: "write"

Functions

AdminApiAxiosParamCreator

  • AdminApiAxiosParamCreator(configuration?: Configuration): { adminAdoptRepository: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); adminCreateOrg: ((username: string, organization: CreateOrgOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); adminCreatePublicKey: ((username: string, key?: CreateKeyOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); adminCreateRepo: ((username: string, repository: CreateRepoOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); adminCreateUser: ((body?: CreateUserOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); adminCronList: ((page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); adminCronRun: ((task: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); adminDeleteUnadoptedRepository: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); adminDeleteUser: ((username: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); adminDeleteUserPublicKey: ((username: string, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); adminEditUser: ((username: string, body?: EditUserOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); adminGetAllOrgs: ((lang?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); adminGetAllUsers: ((lang?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); adminUnadoptedList: ((page?: number, limit?: number, pattern?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>) }

  • AdminApi - axios parameter creator

    export

    Parameters

    Returns { adminAdoptRepository: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); adminCreateOrg: ((username: string, organization: CreateOrgOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); adminCreatePublicKey: ((username: string, key?: CreateKeyOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); adminCreateRepo: ((username: string, repository: CreateRepoOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); adminCreateUser: ((body?: CreateUserOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); adminCronList: ((page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); adminCronRun: ((task: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); adminDeleteUnadoptedRepository: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); adminDeleteUser: ((username: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); adminDeleteUserPublicKey: ((username: string, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); adminEditUser: ((username: string, body?: EditUserOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); adminGetAllOrgs: ((lang?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); adminGetAllUsers: ((lang?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); adminUnadoptedList: ((page?: number, limit?: number, pattern?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>) }

    • adminAdoptRepository: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Adopt unadopted files as a repository

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • adminCreateOrg: ((username: string, organization: CreateOrgOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (username: string, organization: CreateOrgOption, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Create an organization

          throws

          {RequiredError}

          Parameters

          • username: string

            username of the user that will own the created organization

          • organization: CreateOrgOption
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • adminCreatePublicKey: ((username: string, key?: CreateKeyOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (username: string, key?: CreateKeyOption, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Add a public key on behalf of a user

          throws

          {RequiredError}

          Parameters

          • username: string

            username of the user

          • Optional key: CreateKeyOption
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • adminCreateRepo: ((username: string, repository: CreateRepoOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (username: string, repository: CreateRepoOption, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Create a repository on behalf of a user

          throws

          {RequiredError}

          Parameters

          • username: string

            username of the user. This user will own the created repository

          • repository: CreateRepoOption
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • adminCreateUser: ((body?: CreateUserOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • summary

          Create a user

          throws

          {RequiredError}

          Parameters

          Returns Promise<RequestArgs>

    • adminCronList: ((page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          List cron tasks

          throws

          {RequiredError}

          Parameters

          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • adminCronRun: ((task: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (task: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Run cron task

          throws

          {RequiredError}

          Parameters

          • task: string

            task to run

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • adminDeleteUnadoptedRepository: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Delete unadopted files

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • adminDeleteUser: ((username: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (username: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Delete a user

          throws

          {RequiredError}

          Parameters

          • username: string

            username of user to delete

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • adminDeleteUserPublicKey: ((username: string, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (username: string, id: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Delete a user's public key

          throws

          {RequiredError}

          Parameters

          • username: string

            username of user

          • id: number

            id of the key to delete

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • adminEditUser: ((username: string, body?: EditUserOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (username: string, body?: EditUserOption, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Edit an existing user

          throws

          {RequiredError}

          Parameters

          • username: string

            username of user to edit

          • Optional body: EditUserOption
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • adminGetAllOrgs: ((lang?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (lang?: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          List all organizations

          throws

          {RequiredError}

          Parameters

          • Optional lang: string
          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • adminGetAllUsers: ((lang?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (lang?: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          List all users

          throws

          {RequiredError}

          Parameters

          • Optional lang: string
          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • adminUnadoptedList: ((page?: number, limit?: number, pattern?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (page?: number, limit?: number, pattern?: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          List unadopted repositories

          throws

          {RequiredError}

          Parameters

          • Optional page: number
          • Optional limit: number
          • Optional pattern: string
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

AdminApiFactory

  • AdminApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { adminAdoptRepository: any; adminCreateOrg: any; adminCreatePublicKey: any; adminCreateRepo: any; adminCreateUser: any; adminCronList: any; adminCronRun: any; adminDeleteUnadoptedRepository: any; adminDeleteUser: any; adminDeleteUserPublicKey: any; adminEditUser: any; adminGetAllOrgs: any; adminGetAllUsers: any; adminUnadoptedList: any }

  • AdminApi - factory interface

    export

    Parameters

    • Optional configuration: Configuration
    • Optional basePath: string
    • Optional axios: AxiosInstance

    Returns { adminAdoptRepository: any; adminCreateOrg: any; adminCreatePublicKey: any; adminCreateRepo: any; adminCreateUser: any; adminCronList: any; adminCronRun: any; adminDeleteUnadoptedRepository: any; adminDeleteUser: any; adminDeleteUserPublicKey: any; adminEditUser: any; adminGetAllOrgs: any; adminGetAllUsers: any; adminUnadoptedList: any }

    • adminAdoptRepository:function
      • adminAdoptRepository(owner: string, repo: string, options?: any): AxiosPromise<void>
      • summary

        Adopt unadopted files as a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional options: any

        Returns AxiosPromise<void>

    • adminCreateOrg:function
      • summary

        Create an organization

        throws

        {RequiredError}

        Parameters

        • username: string

          username of the user that will own the created organization

        • organization: CreateOrgOption
        • Optional options: any

        Returns AxiosPromise<Organization>

    • adminCreatePublicKey:function
      • summary

        Add a public key on behalf of a user

        throws

        {RequiredError}

        Parameters

        • username: string

          username of the user

        • Optional key: CreateKeyOption
        • Optional options: any

        Returns AxiosPromise<PublicKey>

    • adminCreateRepo:function
      • summary

        Create a repository on behalf of a user

        throws

        {RequiredError}

        Parameters

        • username: string

          username of the user. This user will own the created repository

        • repository: CreateRepoOption
        • Optional options: any

        Returns AxiosPromise<Repository>

    • adminCreateUser:function
      • summary

        Create a user

        throws

        {RequiredError}

        Parameters

        Returns AxiosPromise<User>

    • adminCronList:function
      • adminCronList(page?: number, limit?: number, options?: any): AxiosPromise<Cron[]>
      • summary

        List cron tasks

        throws

        {RequiredError}

        Parameters

        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<Cron[]>

    • adminCronRun:function
      • adminCronRun(task: string, options?: any): AxiosPromise<void>
      • summary

        Run cron task

        throws

        {RequiredError}

        Parameters

        • task: string

          task to run

        • Optional options: any

        Returns AxiosPromise<void>

    • adminDeleteUnadoptedRepository:function
      • adminDeleteUnadoptedRepository(owner: string, repo: string, options?: any): AxiosPromise<void>
      • summary

        Delete unadopted files

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional options: any

        Returns AxiosPromise<void>

    • adminDeleteUser:function
      • adminDeleteUser(username: string, options?: any): AxiosPromise<void>
      • summary

        Delete a user

        throws

        {RequiredError}

        Parameters

        • username: string

          username of user to delete

        • Optional options: any

        Returns AxiosPromise<void>

    • adminDeleteUserPublicKey:function
      • adminDeleteUserPublicKey(username: string, id: number, options?: any): AxiosPromise<void>
      • summary

        Delete a user's public key

        throws

        {RequiredError}

        Parameters

        • username: string

          username of user

        • id: number

          id of the key to delete

        • Optional options: any

        Returns AxiosPromise<void>

    • adminEditUser:function
      • summary

        Edit an existing user

        throws

        {RequiredError}

        Parameters

        • username: string

          username of user to edit

        • Optional body: EditUserOption
        • Optional options: any

        Returns AxiosPromise<User>

    • adminGetAllOrgs:function
      • adminGetAllOrgs(lang?: string, page?: number, limit?: number, options?: any): AxiosPromise<Organization[]>
      • summary

        List all organizations

        throws

        {RequiredError}

        Parameters

        • Optional lang: string
        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<Organization[]>

    • adminGetAllUsers:function
      • adminGetAllUsers(lang?: string, page?: number, limit?: number, options?: any): AxiosPromise<User[]>
      • summary

        List all users

        throws

        {RequiredError}

        Parameters

        • Optional lang: string
        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<User[]>

    • adminUnadoptedList:function
      • adminUnadoptedList(page?: number, limit?: number, pattern?: string, options?: any): AxiosPromise<string[]>
      • summary

        List unadopted repositories

        throws

        {RequiredError}

        Parameters

        • Optional page: number
        • Optional limit: number
        • Optional pattern: string
        • Optional options: any

        Returns AxiosPromise<string[]>

AdminApiFp

  • AdminApiFp(configuration?: Configuration): { adminAdoptRepository: any; adminCreateOrg: any; adminCreatePublicKey: any; adminCreateRepo: any; adminCreateUser: any; adminCronList: any; adminCronRun: any; adminDeleteUnadoptedRepository: any; adminDeleteUser: any; adminDeleteUserPublicKey: any; adminEditUser: any; adminGetAllOrgs: any; adminGetAllUsers: any; adminUnadoptedList: any }

  • AdminApi - functional programming interface

    export

    Parameters

    Returns { adminAdoptRepository: any; adminCreateOrg: any; adminCreatePublicKey: any; adminCreateRepo: any; adminCreateUser: any; adminCronList: any; adminCronRun: any; adminDeleteUnadoptedRepository: any; adminDeleteUser: any; adminDeleteUserPublicKey: any; adminEditUser: any; adminGetAllOrgs: any; adminGetAllUsers: any; adminUnadoptedList: any }

    • adminAdoptRepository:function
      • adminAdoptRepository(owner: string, repo: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Adopt unadopted files as a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • adminCreateOrg:function
      • adminCreateOrg(username: string, organization: CreateOrgOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Organization>)>
      • summary

        Create an organization

        throws

        {RequiredError}

        Parameters

        • username: string

          username of the user that will own the created organization

        • organization: CreateOrgOption
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Organization>)>

    • adminCreatePublicKey:function
      • adminCreatePublicKey(username: string, key?: CreateKeyOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicKey>)>
      • summary

        Add a public key on behalf of a user

        throws

        {RequiredError}

        Parameters

        • username: string

          username of the user

        • Optional key: CreateKeyOption
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicKey>)>

    • adminCreateRepo:function
      • adminCreateRepo(username: string, repository: CreateRepoOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository>)>
      • summary

        Create a repository on behalf of a user

        throws

        {RequiredError}

        Parameters

        • username: string

          username of the user. This user will own the created repository

        • repository: CreateRepoOption
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository>)>

    • adminCreateUser:function
      • adminCreateUser(body?: CreateUserOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<User>)>
      • summary

        Create a user

        throws

        {RequiredError}

        Parameters

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<User>)>

    • adminCronList:function
      • adminCronList(page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Cron[]>)>
      • summary

        List cron tasks

        throws

        {RequiredError}

        Parameters

        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Cron[]>)>

    • adminCronRun:function
      • adminCronRun(task: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Run cron task

        throws

        {RequiredError}

        Parameters

        • task: string

          task to run

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • adminDeleteUnadoptedRepository:function
      • adminDeleteUnadoptedRepository(owner: string, repo: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Delete unadopted files

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • adminDeleteUser:function
      • adminDeleteUser(username: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Delete a user

        throws

        {RequiredError}

        Parameters

        • username: string

          username of user to delete

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • adminDeleteUserPublicKey:function
      • adminDeleteUserPublicKey(username: string, id: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Delete a user's public key

        throws

        {RequiredError}

        Parameters

        • username: string

          username of user

        • id: number

          id of the key to delete

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • adminEditUser:function
      • adminEditUser(username: string, body?: EditUserOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<User>)>
      • summary

        Edit an existing user

        throws

        {RequiredError}

        Parameters

        • username: string

          username of user to edit

        • Optional body: EditUserOption
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<User>)>

    • adminGetAllOrgs:function
      • adminGetAllOrgs(lang?: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Organization[]>)>
      • summary

        List all organizations

        throws

        {RequiredError}

        Parameters

        • Optional lang: string
        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Organization[]>)>

    • adminGetAllUsers:function
      • adminGetAllUsers(lang?: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<User[]>)>
      • summary

        List all users

        throws

        {RequiredError}

        Parameters

        • Optional lang: string
        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<User[]>)>

    • adminUnadoptedList:function
      • adminUnadoptedList(page?: number, limit?: number, pattern?: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<string[]>)>
      • summary

        List unadopted repositories

        throws

        {RequiredError}

        Parameters

        • Optional page: number
        • Optional limit: number
        • Optional pattern: string
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<string[]>)>

CatalogApiAxiosParamCreator

  • CatalogApiAxiosParamCreator(configuration?: Configuration): { catalogGetEntry: ((owner: string, repo: string, tag: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); catalogGetMetadata: ((owner: string, repo: string, tag: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); catalogSearch: ((q?: string, owner?: string, repo?: string, tag?: string, lang?: string, stage?: string, subject?: string, checkingLevel?: string, book?: string, partialMatch?: boolean, includeHistory?: boolean, includeMetadata?: boolean, showIngredients?: boolean, sort?: string, order?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); catalogSearchOwner: ((owner: string, q?: string, repo?: string, tag?: string, lang?: string, stage?: string, subject?: string, checkingLevel?: string, book?: string, partialMatch?: boolean, includeHistory?: boolean, includeMetadata?: boolean, showIngredients?: boolean, sort?: string, order?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); catalogSearchRepo: ((owner: string, repo: string, q?: string, owner2?: string, repo2?: string, tag?: string, lang?: string, stage?: string, subject?: string, checkingLevel?: string, book?: string, partialMatch?: boolean, includeHistory?: boolean, includeMetadata?: boolean, showIngredients?: boolean, sort?: string, order?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>) }

  • CatalogApi - axios parameter creator

    export

    Parameters

    Returns { catalogGetEntry: ((owner: string, repo: string, tag: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); catalogGetMetadata: ((owner: string, repo: string, tag: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); catalogSearch: ((q?: string, owner?: string, repo?: string, tag?: string, lang?: string, stage?: string, subject?: string, checkingLevel?: string, book?: string, partialMatch?: boolean, includeHistory?: boolean, includeMetadata?: boolean, showIngredients?: boolean, sort?: string, order?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); catalogSearchOwner: ((owner: string, q?: string, repo?: string, tag?: string, lang?: string, stage?: string, subject?: string, checkingLevel?: string, book?: string, partialMatch?: boolean, includeHistory?: boolean, includeMetadata?: boolean, showIngredients?: boolean, sort?: string, order?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); catalogSearchRepo: ((owner: string, repo: string, q?: string, owner2?: string, repo2?: string, tag?: string, lang?: string, stage?: string, subject?: string, checkingLevel?: string, book?: string, partialMatch?: boolean, includeHistory?: boolean, includeMetadata?: boolean, showIngredients?: boolean, sort?: string, order?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>) }

    • catalogGetEntry: ((owner: string, repo: string, tag: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, tag: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Catalog entry

          throws

          {RequiredError}

          Parameters

          • owner: string

            name of the owner

          • repo: string

            name of the repo

          • tag: string

            release tag or default branch

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • catalogGetMetadata: ((owner: string, repo: string, tag: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, tag: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Catalog entry metadata (manifest.yaml in JSON format)

          throws

          {RequiredError}

          Parameters

          • owner: string

            name of the owner

          • repo: string

            name of the repo

          • tag: string

            release tag or default branch

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • catalogSearch: ((q?: string, owner?: string, repo?: string, tag?: string, lang?: string, stage?: string, subject?: string, checkingLevel?: string, book?: string, partialMatch?: boolean, includeHistory?: boolean, includeMetadata?: boolean, showIngredients?: boolean, sort?: string, order?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (q?: string, owner?: string, repo?: string, tag?: string, lang?: string, stage?: string, subject?: string, checkingLevel?: string, book?: string, partialMatch?: boolean, includeHistory?: boolean, includeMetadata?: boolean, showIngredients?: boolean, sort?: string, order?: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Catalog search

          throws

          {RequiredError}

          Parameters

          • Optional q: string
          • Optional owner: string
          • Optional repo: string
          • Optional tag: string
          • Optional lang: string
          • Optional stage: string
          • Optional subject: string
          • Optional checkingLevel: string
          • Optional book: string
          • Optional partialMatch: boolean
          • Optional includeHistory: boolean
          • Optional includeMetadata: boolean
          • Optional showIngredients: boolean
          • Optional sort: string
          • Optional order: string
          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • catalogSearchOwner: ((owner: string, q?: string, repo?: string, tag?: string, lang?: string, stage?: string, subject?: string, checkingLevel?: string, book?: string, partialMatch?: boolean, includeHistory?: boolean, includeMetadata?: boolean, showIngredients?: boolean, sort?: string, order?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, q?: string, repo?: string, tag?: string, lang?: string, stage?: string, subject?: string, checkingLevel?: string, book?: string, partialMatch?: boolean, includeHistory?: boolean, includeMetadata?: boolean, showIngredients?: boolean, sort?: string, order?: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Catalog search by owner

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the returned entries

          • Optional q: string
          • Optional repo: string
          • Optional tag: string
          • Optional lang: string
          • Optional stage: string
          • Optional subject: string
          • Optional checkingLevel: string
          • Optional book: string
          • Optional partialMatch: boolean
          • Optional includeHistory: boolean
          • Optional includeMetadata: boolean
          • Optional showIngredients: boolean
          • Optional sort: string
          • Optional order: string
          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • catalogSearchRepo: ((owner: string, repo: string, q?: string, owner2?: string, repo2?: string, tag?: string, lang?: string, stage?: string, subject?: string, checkingLevel?: string, book?: string, partialMatch?: boolean, includeHistory?: boolean, includeMetadata?: boolean, showIngredients?: boolean, sort?: string, order?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, q?: string, owner2?: string, repo2?: string, tag?: string, lang?: string, stage?: string, subject?: string, checkingLevel?: string, book?: string, partialMatch?: boolean, includeHistory?: boolean, includeMetadata?: boolean, showIngredients?: boolean, sort?: string, order?: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Catalog search by repo

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the returned entries

          • repo: string

            name of the repo of the returned entries

          • Optional q: string
          • Optional owner2: string
          • Optional repo2: string
          • Optional tag: string
          • Optional lang: string
          • Optional stage: string
          • Optional subject: string
          • Optional checkingLevel: string
          • Optional book: string
          • Optional partialMatch: boolean
          • Optional includeHistory: boolean
          • Optional includeMetadata: boolean
          • Optional showIngredients: boolean
          • Optional sort: string
          • Optional order: string
          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

CatalogApiFactory

  • CatalogApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { catalogGetEntry: any; catalogGetMetadata: any; catalogSearch: any; catalogSearchOwner: any; catalogSearchRepo: any }

  • CatalogApi - factory interface

    export

    Parameters

    • Optional configuration: Configuration
    • Optional basePath: string
    • Optional axios: AxiosInstance

    Returns { catalogGetEntry: any; catalogGetMetadata: any; catalogSearch: any; catalogSearchOwner: any; catalogSearchRepo: any }

    • catalogGetEntry:function
      • catalogGetEntry(owner: string, repo: string, tag: string, options?: any): AxiosPromise<CatalogEntry>
      • summary

        Catalog entry

        throws

        {RequiredError}

        Parameters

        • owner: string

          name of the owner

        • repo: string

          name of the repo

        • tag: string

          release tag or default branch

        • Optional options: any

        Returns AxiosPromise<CatalogEntry>

    • catalogGetMetadata:function
      • catalogGetMetadata(owner: string, repo: string, tag: string, options?: any): AxiosPromise<{}>
      • summary

        Catalog entry metadata (manifest.yaml in JSON format)

        throws

        {RequiredError}

        Parameters

        • owner: string

          name of the owner

        • repo: string

          name of the repo

        • tag: string

          release tag or default branch

        • Optional options: any

        Returns AxiosPromise<{}>

    • catalogSearch:function
      • catalogSearch(q?: string, owner?: string, repo?: string, tag?: string, lang?: string, stage?: string, subject?: string, checkingLevel?: string, book?: string, partialMatch?: boolean, includeHistory?: boolean, includeMetadata?: boolean, showIngredients?: boolean, sort?: string, order?: string, page?: number, limit?: number, options?: any): AxiosPromise<CatalogSearchResults>
      • summary

        Catalog search

        throws

        {RequiredError}

        Parameters

        • Optional q: string
        • Optional owner: string
        • Optional repo: string
        • Optional tag: string
        • Optional lang: string
        • Optional stage: string
        • Optional subject: string
        • Optional checkingLevel: string
        • Optional book: string
        • Optional partialMatch: boolean
        • Optional includeHistory: boolean
        • Optional includeMetadata: boolean
        • Optional showIngredients: boolean
        • Optional sort: string
        • Optional order: string
        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<CatalogSearchResults>

    • catalogSearchOwner:function
      • catalogSearchOwner(owner: string, q?: string, repo?: string, tag?: string, lang?: string, stage?: string, subject?: string, checkingLevel?: string, book?: string, partialMatch?: boolean, includeHistory?: boolean, includeMetadata?: boolean, showIngredients?: boolean, sort?: string, order?: string, page?: number, limit?: number, options?: any): AxiosPromise<CatalogSearchResults>
      • summary

        Catalog search by owner

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the returned entries

        • Optional q: string
        • Optional repo: string
        • Optional tag: string
        • Optional lang: string
        • Optional stage: string
        • Optional subject: string
        • Optional checkingLevel: string
        • Optional book: string
        • Optional partialMatch: boolean
        • Optional includeHistory: boolean
        • Optional includeMetadata: boolean
        • Optional showIngredients: boolean
        • Optional sort: string
        • Optional order: string
        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<CatalogSearchResults>

    • catalogSearchRepo:function
      • catalogSearchRepo(owner: string, repo: string, q?: string, owner2?: string, repo2?: string, tag?: string, lang?: string, stage?: string, subject?: string, checkingLevel?: string, book?: string, partialMatch?: boolean, includeHistory?: boolean, includeMetadata?: boolean, showIngredients?: boolean, sort?: string, order?: string, page?: number, limit?: number, options?: any): AxiosPromise<CatalogSearchResults>
      • summary

        Catalog search by repo

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the returned entries

        • repo: string

          name of the repo of the returned entries

        • Optional q: string
        • Optional owner2: string
        • Optional repo2: string
        • Optional tag: string
        • Optional lang: string
        • Optional stage: string
        • Optional subject: string
        • Optional checkingLevel: string
        • Optional book: string
        • Optional partialMatch: boolean
        • Optional includeHistory: boolean
        • Optional includeMetadata: boolean
        • Optional showIngredients: boolean
        • Optional sort: string
        • Optional order: string
        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<CatalogSearchResults>

CatalogApiFp

  • CatalogApiFp(configuration?: Configuration): { catalogGetEntry: any; catalogGetMetadata: any; catalogSearch: any; catalogSearchOwner: any; catalogSearchRepo: any }

  • CatalogApi - functional programming interface

    export

    Parameters

    Returns { catalogGetEntry: any; catalogGetMetadata: any; catalogSearch: any; catalogSearchOwner: any; catalogSearchRepo: any }

    • catalogGetEntry:function
      • catalogGetEntry(owner: string, repo: string, tag: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<CatalogEntry>)>
      • summary

        Catalog entry

        throws

        {RequiredError}

        Parameters

        • owner: string

          name of the owner

        • repo: string

          name of the repo

        • tag: string

          release tag or default branch

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<CatalogEntry>)>

    • catalogGetMetadata:function
      • catalogGetMetadata(owner: string, repo: string, tag: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<{}>)>
      • summary

        Catalog entry metadata (manifest.yaml in JSON format)

        throws

        {RequiredError}

        Parameters

        • owner: string

          name of the owner

        • repo: string

          name of the repo

        • tag: string

          release tag or default branch

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<{}>)>

    • catalogSearch:function
      • catalogSearch(q?: string, owner?: string, repo?: string, tag?: string, lang?: string, stage?: string, subject?: string, checkingLevel?: string, book?: string, partialMatch?: boolean, includeHistory?: boolean, includeMetadata?: boolean, showIngredients?: boolean, sort?: string, order?: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<CatalogSearchResults>)>
      • summary

        Catalog search

        throws

        {RequiredError}

        Parameters

        • Optional q: string
        • Optional owner: string
        • Optional repo: string
        • Optional tag: string
        • Optional lang: string
        • Optional stage: string
        • Optional subject: string
        • Optional checkingLevel: string
        • Optional book: string
        • Optional partialMatch: boolean
        • Optional includeHistory: boolean
        • Optional includeMetadata: boolean
        • Optional showIngredients: boolean
        • Optional sort: string
        • Optional order: string
        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<CatalogSearchResults>)>

    • catalogSearchOwner:function
      • catalogSearchOwner(owner: string, q?: string, repo?: string, tag?: string, lang?: string, stage?: string, subject?: string, checkingLevel?: string, book?: string, partialMatch?: boolean, includeHistory?: boolean, includeMetadata?: boolean, showIngredients?: boolean, sort?: string, order?: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<CatalogSearchResults>)>
      • summary

        Catalog search by owner

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the returned entries

        • Optional q: string
        • Optional repo: string
        • Optional tag: string
        • Optional lang: string
        • Optional stage: string
        • Optional subject: string
        • Optional checkingLevel: string
        • Optional book: string
        • Optional partialMatch: boolean
        • Optional includeHistory: boolean
        • Optional includeMetadata: boolean
        • Optional showIngredients: boolean
        • Optional sort: string
        • Optional order: string
        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<CatalogSearchResults>)>

    • catalogSearchRepo:function
      • catalogSearchRepo(owner: string, repo: string, q?: string, owner2?: string, repo2?: string, tag?: string, lang?: string, stage?: string, subject?: string, checkingLevel?: string, book?: string, partialMatch?: boolean, includeHistory?: boolean, includeMetadata?: boolean, showIngredients?: boolean, sort?: string, order?: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<CatalogSearchResults>)>
      • summary

        Catalog search by repo

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the returned entries

        • repo: string

          name of the repo of the returned entries

        • Optional q: string
        • Optional owner2: string
        • Optional repo2: string
        • Optional tag: string
        • Optional lang: string
        • Optional stage: string
        • Optional subject: string
        • Optional checkingLevel: string
        • Optional book: string
        • Optional partialMatch: boolean
        • Optional includeHistory: boolean
        • Optional includeMetadata: boolean
        • Optional showIngredients: boolean
        • Optional sort: string
        • Optional order: string
        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<CatalogSearchResults>)>

IssueApiAxiosParamCreator

  • IssueApiAxiosParamCreator(configuration?: Configuration): { issueAddLabel: ((owner: string, repo: string, index: number, body?: IssueLabelsOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueAddSubscription: ((owner: string, repo: string, index: number, user: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueAddTime: ((owner: string, repo: string, index: number, body?: AddTimeOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueCheckSubscription: ((owner: string, repo: string, index: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueClearLabels: ((owner: string, repo: string, index: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueCreateComment: ((owner: string, repo: string, index: number, body?: CreateIssueCommentOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueCreateIssue: ((owner: string, repo: string, body?: CreateIssueOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueCreateLabel: ((owner: string, repo: string, body?: CreateLabelOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueCreateMilestone: ((owner: string, repo: string, body?: CreateMilestoneOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueDelete: ((owner: string, repo: string, index: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueDeleteComment: ((owner: string, repo: string, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueDeleteCommentDeprecated: ((owner: string, repo: string, index: number, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueDeleteCommentReaction: ((owner: string, repo: string, id: number, content?: EditReactionOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueDeleteIssueReaction: ((owner: string, repo: string, index: number, content?: EditReactionOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueDeleteLabel: ((owner: string, repo: string, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueDeleteMilestone: ((owner: string, repo: string, id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueDeleteStopWatch: ((owner: string, repo: string, index: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueDeleteSubscription: ((owner: string, repo: string, index: number, user: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueDeleteTime: ((owner: string, repo: string, index: number, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueEditComment: ((owner: string, repo: string, id: number, body?: EditIssueCommentOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueEditCommentDeprecated: ((owner: string, repo: string, index: number, id: number, body?: EditIssueCommentOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueEditIssue: ((owner: string, repo: string, index: number, body?: EditIssueOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueEditIssueDeadline: ((owner: string, repo: string, index: number, body?: EditDeadlineOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueEditLabel: ((owner: string, repo: string, id: number, body?: EditLabelOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueEditMilestone: ((owner: string, repo: string, id: string, body?: EditMilestoneOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueGetComment: ((owner: string, repo: string, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueGetCommentReactions: ((owner: string, repo: string, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueGetComments: ((owner: string, repo: string, index: number, since?: string, before?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueGetCommentsAndTimeline: ((owner: string, repo: string, index: number, since?: string, page?: number, limit?: number, before?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueGetIssue: ((owner: string, repo: string, index: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueGetIssueReactions: ((owner: string, repo: string, index: number, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueGetLabel: ((owner: string, repo: string, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueGetLabels: ((owner: string, repo: string, index: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueGetMilestone: ((owner: string, repo: string, id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueGetMilestonesList: ((owner: string, repo: string, state?: string, name?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueGetRepoComments: ((owner: string, repo: string, since?: string, before?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueListIssues: ((owner: string, repo: string, state?: "all" | "closed" | "open", labels?: string, q?: string, type?: "issues" | "pulls", milestones?: string, since?: string, before?: string, createdBy?: string, assignedBy?: string, mentionedBy?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueListLabels: ((owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); issuePostCommentReaction: ((owner: string, repo: string, id: number, content?: EditReactionOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); issuePostIssueReaction: ((owner: string, repo: string, index: number, content?: EditReactionOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueRemoveLabel: ((owner: string, repo: string, index: number, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueReplaceLabels: ((owner: string, repo: string, index: number, body?: IssueLabelsOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueResetTime: ((owner: string, repo: string, index: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueSearchIssues: ((state?: string, labels?: string, milestones?: string, q?: string, priorityRepoId?: number, type?: string, since?: string, before?: string, assigned?: boolean, created?: boolean, mentioned?: boolean, reviewRequested?: boolean, owner?: string, team?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueStartStopWatch: ((owner: string, repo: string, index: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueStopStopWatch: ((owner: string, repo: string, index: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueSubscriptions: ((owner: string, repo: string, index: number, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueTrackedTimes: ((owner: string, repo: string, index: number, user?: string, since?: string, before?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>) }

  • IssueApi - axios parameter creator

    export

    Parameters

    Returns { issueAddLabel: ((owner: string, repo: string, index: number, body?: IssueLabelsOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueAddSubscription: ((owner: string, repo: string, index: number, user: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueAddTime: ((owner: string, repo: string, index: number, body?: AddTimeOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueCheckSubscription: ((owner: string, repo: string, index: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueClearLabels: ((owner: string, repo: string, index: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueCreateComment: ((owner: string, repo: string, index: number, body?: CreateIssueCommentOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueCreateIssue: ((owner: string, repo: string, body?: CreateIssueOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueCreateLabel: ((owner: string, repo: string, body?: CreateLabelOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueCreateMilestone: ((owner: string, repo: string, body?: CreateMilestoneOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueDelete: ((owner: string, repo: string, index: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueDeleteComment: ((owner: string, repo: string, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueDeleteCommentDeprecated: ((owner: string, repo: string, index: number, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueDeleteCommentReaction: ((owner: string, repo: string, id: number, content?: EditReactionOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueDeleteIssueReaction: ((owner: string, repo: string, index: number, content?: EditReactionOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueDeleteLabel: ((owner: string, repo: string, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueDeleteMilestone: ((owner: string, repo: string, id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueDeleteStopWatch: ((owner: string, repo: string, index: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueDeleteSubscription: ((owner: string, repo: string, index: number, user: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueDeleteTime: ((owner: string, repo: string, index: number, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueEditComment: ((owner: string, repo: string, id: number, body?: EditIssueCommentOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueEditCommentDeprecated: ((owner: string, repo: string, index: number, id: number, body?: EditIssueCommentOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueEditIssue: ((owner: string, repo: string, index: number, body?: EditIssueOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueEditIssueDeadline: ((owner: string, repo: string, index: number, body?: EditDeadlineOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueEditLabel: ((owner: string, repo: string, id: number, body?: EditLabelOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueEditMilestone: ((owner: string, repo: string, id: string, body?: EditMilestoneOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueGetComment: ((owner: string, repo: string, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueGetCommentReactions: ((owner: string, repo: string, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueGetComments: ((owner: string, repo: string, index: number, since?: string, before?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueGetCommentsAndTimeline: ((owner: string, repo: string, index: number, since?: string, page?: number, limit?: number, before?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueGetIssue: ((owner: string, repo: string, index: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueGetIssueReactions: ((owner: string, repo: string, index: number, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueGetLabel: ((owner: string, repo: string, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueGetLabels: ((owner: string, repo: string, index: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueGetMilestone: ((owner: string, repo: string, id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueGetMilestonesList: ((owner: string, repo: string, state?: string, name?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueGetRepoComments: ((owner: string, repo: string, since?: string, before?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueListIssues: ((owner: string, repo: string, state?: "all" | "closed" | "open", labels?: string, q?: string, type?: "issues" | "pulls", milestones?: string, since?: string, before?: string, createdBy?: string, assignedBy?: string, mentionedBy?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueListLabels: ((owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); issuePostCommentReaction: ((owner: string, repo: string, id: number, content?: EditReactionOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); issuePostIssueReaction: ((owner: string, repo: string, index: number, content?: EditReactionOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueRemoveLabel: ((owner: string, repo: string, index: number, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueReplaceLabels: ((owner: string, repo: string, index: number, body?: IssueLabelsOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueResetTime: ((owner: string, repo: string, index: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueSearchIssues: ((state?: string, labels?: string, milestones?: string, q?: string, priorityRepoId?: number, type?: string, since?: string, before?: string, assigned?: boolean, created?: boolean, mentioned?: boolean, reviewRequested?: boolean, owner?: string, team?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueStartStopWatch: ((owner: string, repo: string, index: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueStopStopWatch: ((owner: string, repo: string, index: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueSubscriptions: ((owner: string, repo: string, index: number, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); issueTrackedTimes: ((owner: string, repo: string, index: number, user?: string, since?: string, before?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>) }

    • issueAddLabel: ((owner: string, repo: string, index: number, body?: IssueLabelsOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, index: number, body?: IssueLabelsOption, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Add a label to an issue

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • index: number

            index of the issue

          • Optional body: IssueLabelsOption
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • issueAddSubscription: ((owner: string, repo: string, index: number, user: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, index: number, user: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Subscribe user to issue

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • index: number

            index of the issue

          • user: string

            user to subscribe

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • issueAddTime: ((owner: string, repo: string, index: number, body?: AddTimeOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, index: number, body?: AddTimeOption, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Add tracked time to a issue

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • index: number

            index of the issue

          • Optional body: AddTimeOption
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • issueCheckSubscription: ((owner: string, repo: string, index: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, index: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Check if user is subscribed to an issue

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • index: number

            index of the issue

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • issueClearLabels: ((owner: string, repo: string, index: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, index: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Remove all labels from an issue

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • index: number

            index of the issue

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • issueCreateComment: ((owner: string, repo: string, index: number, body?: CreateIssueCommentOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, index: number, body?: CreateIssueCommentOption, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Add a comment to an issue

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • index: number

            index of the issue

          • Optional body: CreateIssueCommentOption
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • issueCreateIssue: ((owner: string, repo: string, body?: CreateIssueOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, body?: CreateIssueOption, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Create an issue. If using deadline only the date will be taken into account, and time of day ignored.

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • Optional body: CreateIssueOption
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • issueCreateLabel: ((owner: string, repo: string, body?: CreateLabelOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, body?: CreateLabelOption, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Create a label

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • Optional body: CreateLabelOption
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • issueCreateMilestone: ((owner: string, repo: string, body?: CreateMilestoneOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, body?: CreateMilestoneOption, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Create a milestone

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • Optional body: CreateMilestoneOption
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • issueDelete: ((owner: string, repo: string, index: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, index: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Delete an issue

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • index: number

            index of issue to delete

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • issueDeleteComment: ((owner: string, repo: string, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, id: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Delete a comment

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • id: number

            id of comment to delete

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • issueDeleteCommentDeprecated: ((owner: string, repo: string, index: number, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, index: number, id: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Delete a comment

          deprecated
          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • index: number

            this parameter is ignored

          • id: number

            id of comment to delete

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • issueDeleteCommentReaction: ((owner: string, repo: string, id: number, content?: EditReactionOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, id: number, content?: EditReactionOption, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Remove a reaction from a comment of an issue

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • id: number

            id of the comment to edit

          • Optional content: EditReactionOption
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • issueDeleteIssueReaction: ((owner: string, repo: string, index: number, content?: EditReactionOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, index: number, content?: EditReactionOption, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Remove a reaction from an issue

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • index: number

            index of the issue

          • Optional content: EditReactionOption
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • issueDeleteLabel: ((owner: string, repo: string, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, id: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Delete a label

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • id: number

            id of the label to delete

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • issueDeleteMilestone: ((owner: string, repo: string, id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, id: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Delete a milestone

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • id: string

            the milestone to delete, identified by ID and if not available by name

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • issueDeleteStopWatch: ((owner: string, repo: string, index: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, index: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Delete an issue's existing stopwatch.

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • index: number

            index of the issue to stop the stopwatch on

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • issueDeleteSubscription: ((owner: string, repo: string, index: number, user: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, index: number, user: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Unsubscribe user from issue

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • index: number

            index of the issue

          • user: string

            user witch unsubscribe

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • issueDeleteTime: ((owner: string, repo: string, index: number, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, index: number, id: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Delete specific tracked time

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • index: number

            index of the issue

          • id: number

            id of time to delete

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • issueEditComment: ((owner: string, repo: string, id: number, body?: EditIssueCommentOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, id: number, body?: EditIssueCommentOption, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Edit a comment

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • id: number

            id of the comment to edit

          • Optional body: EditIssueCommentOption
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • issueEditCommentDeprecated: ((owner: string, repo: string, index: number, id: number, body?: EditIssueCommentOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, index: number, id: number, body?: EditIssueCommentOption, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Edit a comment

          deprecated
          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • index: number

            this parameter is ignored

          • id: number

            id of the comment to edit

          • Optional body: EditIssueCommentOption
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • issueEditIssue: ((owner: string, repo: string, index: number, body?: EditIssueOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, index: number, body?: EditIssueOption, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Edit an issue. If using deadline only the date will be taken into account, and time of day ignored.

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • index: number

            index of the issue to edit

          • Optional body: EditIssueOption
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • issueEditIssueDeadline: ((owner: string, repo: string, index: number, body?: EditDeadlineOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, index: number, body?: EditDeadlineOption, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Set an issue deadline. If set to null, the deadline is deleted. If using deadline only the date will be taken into account, and time of day ignored.

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • index: number

            index of the issue to create or update a deadline on

          • Optional body: EditDeadlineOption
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • issueEditLabel: ((owner: string, repo: string, id: number, body?: EditLabelOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, id: number, body?: EditLabelOption, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Update a label

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • id: number

            id of the label to edit

          • Optional body: EditLabelOption
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • issueEditMilestone: ((owner: string, repo: string, id: string, body?: EditMilestoneOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, id: string, body?: EditMilestoneOption, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Update a milestone

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • id: string

            the milestone to edit, identified by ID and if not available by name

          • Optional body: EditMilestoneOption
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • issueGetComment: ((owner: string, repo: string, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, id: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get a comment

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • id: number

            id of the comment

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • issueGetCommentReactions: ((owner: string, repo: string, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, id: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get a list of reactions from a comment of an issue

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • id: number

            id of the comment to edit

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • issueGetComments: ((owner: string, repo: string, index: number, since?: string, before?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, index: number, since?: string, before?: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          List all comments on an issue

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • index: number

            index of the issue

          • Optional since: string
          • Optional before: string
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • issueGetCommentsAndTimeline: ((owner: string, repo: string, index: number, since?: string, page?: number, limit?: number, before?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, index: number, since?: string, page?: number, limit?: number, before?: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          List all comments and events on an issue

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • index: number

            index of the issue

          • Optional since: string
          • Optional page: number
          • Optional limit: number
          • Optional before: string
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • issueGetIssue: ((owner: string, repo: string, index: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, index: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get an issue

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • index: number

            index of the issue to get

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • issueGetIssueReactions: ((owner: string, repo: string, index: number, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, index: number, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get a list reactions of an issue

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • index: number

            index of the issue

          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • issueGetLabel: ((owner: string, repo: string, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, id: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get a single label

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • id: number

            id of the label to get

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • issueGetLabels: ((owner: string, repo: string, index: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, index: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get an issue's labels

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • index: number

            index of the issue

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • issueGetMilestone: ((owner: string, repo: string, id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, id: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get a milestone

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • id: string

            the milestone to get, identified by ID and if not available by name

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • issueGetMilestonesList: ((owner: string, repo: string, state?: string, name?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, state?: string, name?: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get all of a repository's opened milestones

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • Optional state: string
          • Optional name: string
          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • issueGetRepoComments: ((owner: string, repo: string, since?: string, before?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, since?: string, before?: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          List all comments in a repository

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • Optional since: string
          • Optional before: string
          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • issueListIssues: ((owner: string, repo: string, state?: "all" | "closed" | "open", labels?: string, q?: string, type?: "issues" | "pulls", milestones?: string, since?: string, before?: string, createdBy?: string, assignedBy?: string, mentionedBy?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, state?: "all" | "closed" | "open", labels?: string, q?: string, type?: "issues" | "pulls", milestones?: string, since?: string, before?: string, createdBy?: string, assignedBy?: string, mentionedBy?: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          List a repository's issues

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • Optional state: "all" | "closed" | "open"
          • Optional labels: string
          • Optional q: string
          • Optional type: "issues" | "pulls"
          • Optional milestones: string
          • Optional since: string
          • Optional before: string
          • Optional createdBy: string
          • Optional assignedBy: string
          • Optional mentionedBy: string
          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • issueListLabels: ((owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get all of a repository's labels

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • issuePostCommentReaction: ((owner: string, repo: string, id: number, content?: EditReactionOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, id: number, content?: EditReactionOption, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Add a reaction to a comment of an issue

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • id: number

            id of the comment to edit

          • Optional content: EditReactionOption
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • issuePostIssueReaction: ((owner: string, repo: string, index: number, content?: EditReactionOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, index: number, content?: EditReactionOption, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Add a reaction to an issue

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • index: number

            index of the issue

          • Optional content: EditReactionOption
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • issueRemoveLabel: ((owner: string, repo: string, index: number, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, index: number, id: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Remove a label from an issue

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • index: number

            index of the issue

          • id: number

            id of the label to remove

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • issueReplaceLabels: ((owner: string, repo: string, index: number, body?: IssueLabelsOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, index: number, body?: IssueLabelsOption, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Replace an issue's labels

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • index: number

            index of the issue

          • Optional body: IssueLabelsOption
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • issueResetTime: ((owner: string, repo: string, index: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, index: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Reset a tracked time of an issue

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • index: number

            index of the issue to add tracked time to

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • issueSearchIssues: ((state?: string, labels?: string, milestones?: string, q?: string, priorityRepoId?: number, type?: string, since?: string, before?: string, assigned?: boolean, created?: boolean, mentioned?: boolean, reviewRequested?: boolean, owner?: string, team?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (state?: string, labels?: string, milestones?: string, q?: string, priorityRepoId?: number, type?: string, since?: string, before?: string, assigned?: boolean, created?: boolean, mentioned?: boolean, reviewRequested?: boolean, owner?: string, team?: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Search for issues across the repositories that the user has access to

          throws

          {RequiredError}

          Parameters

          • Optional state: string
          • Optional labels: string
          • Optional milestones: string
          • Optional q: string
          • Optional priorityRepoId: number
          • Optional type: string
          • Optional since: string
          • Optional before: string
          • Optional assigned: boolean
          • Optional created: boolean
          • Optional mentioned: boolean
          • Optional reviewRequested: boolean
          • Optional owner: string
          • Optional team: string
          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • issueStartStopWatch: ((owner: string, repo: string, index: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, index: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Start stopwatch on an issue.

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • index: number

            index of the issue to create the stopwatch on

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • issueStopStopWatch: ((owner: string, repo: string, index: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, index: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Stop an issue's existing stopwatch.

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • index: number

            index of the issue to stop the stopwatch on

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • issueSubscriptions: ((owner: string, repo: string, index: number, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, index: number, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get users who subscribed on an issue.

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • index: number

            index of the issue

          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • issueTrackedTimes: ((owner: string, repo: string, index: number, user?: string, since?: string, before?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, index: number, user?: string, since?: string, before?: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          List an issue's tracked times

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • index: number

            index of the issue

          • Optional user: string
          • Optional since: string
          • Optional before: string
          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

IssueApiFactory

  • IssueApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { issueAddLabel: any; issueAddSubscription: any; issueAddTime: any; issueCheckSubscription: any; issueClearLabels: any; issueCreateComment: any; issueCreateIssue: any; issueCreateLabel: any; issueCreateMilestone: any; issueDelete: any; issueDeleteComment: any; issueDeleteCommentDeprecated: any; issueDeleteCommentReaction: any; issueDeleteIssueReaction: any; issueDeleteLabel: any; issueDeleteMilestone: any; issueDeleteStopWatch: any; issueDeleteSubscription: any; issueDeleteTime: any; issueEditComment: any; issueEditCommentDeprecated: any; issueEditIssue: any; issueEditIssueDeadline: any; issueEditLabel: any; issueEditMilestone: any; issueGetComment: any; issueGetCommentReactions: any; issueGetComments: any; issueGetCommentsAndTimeline: any; issueGetIssue: any; issueGetIssueReactions: any; issueGetLabel: any; issueGetLabels: any; issueGetMilestone: any; issueGetMilestonesList: any; issueGetRepoComments: any; issueListIssues: any; issueListLabels: any; issuePostCommentReaction: any; issuePostIssueReaction: any; issueRemoveLabel: any; issueReplaceLabels: any; issueResetTime: any; issueSearchIssues: any; issueStartStopWatch: any; issueStopStopWatch: any; issueSubscriptions: any; issueTrackedTimes: any }

  • IssueApi - factory interface

    export

    Parameters

    • Optional configuration: Configuration
    • Optional basePath: string
    • Optional axios: AxiosInstance

    Returns { issueAddLabel: any; issueAddSubscription: any; issueAddTime: any; issueCheckSubscription: any; issueClearLabels: any; issueCreateComment: any; issueCreateIssue: any; issueCreateLabel: any; issueCreateMilestone: any; issueDelete: any; issueDeleteComment: any; issueDeleteCommentDeprecated: any; issueDeleteCommentReaction: any; issueDeleteIssueReaction: any; issueDeleteLabel: any; issueDeleteMilestone: any; issueDeleteStopWatch: any; issueDeleteSubscription: any; issueDeleteTime: any; issueEditComment: any; issueEditCommentDeprecated: any; issueEditIssue: any; issueEditIssueDeadline: any; issueEditLabel: any; issueEditMilestone: any; issueGetComment: any; issueGetCommentReactions: any; issueGetComments: any; issueGetCommentsAndTimeline: any; issueGetIssue: any; issueGetIssueReactions: any; issueGetLabel: any; issueGetLabels: any; issueGetMilestone: any; issueGetMilestonesList: any; issueGetRepoComments: any; issueListIssues: any; issueListLabels: any; issuePostCommentReaction: any; issuePostIssueReaction: any; issueRemoveLabel: any; issueReplaceLabels: any; issueResetTime: any; issueSearchIssues: any; issueStartStopWatch: any; issueStopStopWatch: any; issueSubscriptions: any; issueTrackedTimes: any }

    • issueAddLabel:function
      • issueAddLabel(owner: string, repo: string, index: number, body?: IssueLabelsOption, options?: any): AxiosPromise<Label[]>
      • summary

        Add a label to an issue

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the issue

        • Optional body: IssueLabelsOption
        • Optional options: any

        Returns AxiosPromise<Label[]>

    • issueAddSubscription:function
      • issueAddSubscription(owner: string, repo: string, index: number, user: string, options?: any): AxiosPromise<void>
      • summary

        Subscribe user to issue

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the issue

        • user: string

          user to subscribe

        • Optional options: any

        Returns AxiosPromise<void>

    • issueAddTime:function
      • issueAddTime(owner: string, repo: string, index: number, body?: AddTimeOption, options?: any): AxiosPromise<TrackedTime>
      • summary

        Add tracked time to a issue

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the issue

        • Optional body: AddTimeOption
        • Optional options: any

        Returns AxiosPromise<TrackedTime>

    • issueCheckSubscription:function
      • issueCheckSubscription(owner: string, repo: string, index: number, options?: any): AxiosPromise<WatchInfo>
      • summary

        Check if user is subscribed to an issue

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the issue

        • Optional options: any

        Returns AxiosPromise<WatchInfo>

    • issueClearLabels:function
      • issueClearLabels(owner: string, repo: string, index: number, options?: any): AxiosPromise<void>
      • summary

        Remove all labels from an issue

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the issue

        • Optional options: any

        Returns AxiosPromise<void>

    • issueCreateComment:function
      • summary

        Add a comment to an issue

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the issue

        • Optional body: CreateIssueCommentOption
        • Optional options: any

        Returns AxiosPromise<Comment>

    • issueCreateIssue:function
      • summary

        Create an issue. If using deadline only the date will be taken into account, and time of day ignored.

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional body: CreateIssueOption
        • Optional options: any

        Returns AxiosPromise<Issue>

    • issueCreateLabel:function
      • summary

        Create a label

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional body: CreateLabelOption
        • Optional options: any

        Returns AxiosPromise<Label>

    • issueCreateMilestone:function
      • summary

        Create a milestone

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional body: CreateMilestoneOption
        • Optional options: any

        Returns AxiosPromise<Milestone>

    • issueDelete:function
      • issueDelete(owner: string, repo: string, index: number, options?: any): AxiosPromise<void>
      • summary

        Delete an issue

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of issue to delete

        • Optional options: any

        Returns AxiosPromise<void>

    • issueDeleteComment:function
      • issueDeleteComment(owner: string, repo: string, id: number, options?: any): AxiosPromise<void>
      • summary

        Delete a comment

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • id: number

          id of comment to delete

        • Optional options: any

        Returns AxiosPromise<void>

    • issueDeleteCommentDeprecated:function
      • issueDeleteCommentDeprecated(owner: string, repo: string, index: number, id: number, options?: any): AxiosPromise<void>
      • summary

        Delete a comment

        deprecated
        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          this parameter is ignored

        • id: number

          id of comment to delete

        • Optional options: any

        Returns AxiosPromise<void>

    • issueDeleteCommentReaction:function
      • issueDeleteCommentReaction(owner: string, repo: string, id: number, content?: EditReactionOption, options?: any): AxiosPromise<void>
      • summary

        Remove a reaction from a comment of an issue

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • id: number

          id of the comment to edit

        • Optional content: EditReactionOption
        • Optional options: any

        Returns AxiosPromise<void>

    • issueDeleteIssueReaction:function
      • issueDeleteIssueReaction(owner: string, repo: string, index: number, content?: EditReactionOption, options?: any): AxiosPromise<void>
      • summary

        Remove a reaction from an issue

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the issue

        • Optional content: EditReactionOption
        • Optional options: any

        Returns AxiosPromise<void>

    • issueDeleteLabel:function
      • issueDeleteLabel(owner: string, repo: string, id: number, options?: any): AxiosPromise<void>
      • summary

        Delete a label

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • id: number

          id of the label to delete

        • Optional options: any

        Returns AxiosPromise<void>

    • issueDeleteMilestone:function
      • issueDeleteMilestone(owner: string, repo: string, id: string, options?: any): AxiosPromise<void>
      • summary

        Delete a milestone

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • id: string

          the milestone to delete, identified by ID and if not available by name

        • Optional options: any

        Returns AxiosPromise<void>

    • issueDeleteStopWatch:function
      • issueDeleteStopWatch(owner: string, repo: string, index: number, options?: any): AxiosPromise<void>
      • summary

        Delete an issue's existing stopwatch.

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the issue to stop the stopwatch on

        • Optional options: any

        Returns AxiosPromise<void>

    • issueDeleteSubscription:function
      • issueDeleteSubscription(owner: string, repo: string, index: number, user: string, options?: any): AxiosPromise<void>
      • summary

        Unsubscribe user from issue

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the issue

        • user: string

          user witch unsubscribe

        • Optional options: any

        Returns AxiosPromise<void>

    • issueDeleteTime:function
      • issueDeleteTime(owner: string, repo: string, index: number, id: number, options?: any): AxiosPromise<void>
      • summary

        Delete specific tracked time

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the issue

        • id: number

          id of time to delete

        • Optional options: any

        Returns AxiosPromise<void>

    • issueEditComment:function
      • summary

        Edit a comment

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • id: number

          id of the comment to edit

        • Optional body: EditIssueCommentOption
        • Optional options: any

        Returns AxiosPromise<Comment>

    • issueEditCommentDeprecated:function
      • issueEditCommentDeprecated(owner: string, repo: string, index: number, id: number, body?: EditIssueCommentOption, options?: any): AxiosPromise<Comment>
      • summary

        Edit a comment

        deprecated
        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          this parameter is ignored

        • id: number

          id of the comment to edit

        • Optional body: EditIssueCommentOption
        • Optional options: any

        Returns AxiosPromise<Comment>

    • issueEditIssue:function
      • issueEditIssue(owner: string, repo: string, index: number, body?: EditIssueOption, options?: any): AxiosPromise<Issue>
      • summary

        Edit an issue. If using deadline only the date will be taken into account, and time of day ignored.

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the issue to edit

        • Optional body: EditIssueOption
        • Optional options: any

        Returns AxiosPromise<Issue>

    • issueEditIssueDeadline:function
      • summary

        Set an issue deadline. If set to null, the deadline is deleted. If using deadline only the date will be taken into account, and time of day ignored.

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the issue to create or update a deadline on

        • Optional body: EditDeadlineOption
        • Optional options: any

        Returns AxiosPromise<IssueDeadline>

    • issueEditLabel:function
      • issueEditLabel(owner: string, repo: string, id: number, body?: EditLabelOption, options?: any): AxiosPromise<Label>
      • summary

        Update a label

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • id: number

          id of the label to edit

        • Optional body: EditLabelOption
        • Optional options: any

        Returns AxiosPromise<Label>

    • issueEditMilestone:function
      • summary

        Update a milestone

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • id: string

          the milestone to edit, identified by ID and if not available by name

        • Optional body: EditMilestoneOption
        • Optional options: any

        Returns AxiosPromise<Milestone>

    • issueGetComment:function
      • issueGetComment(owner: string, repo: string, id: number, options?: any): AxiosPromise<Comment>
      • summary

        Get a comment

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • id: number

          id of the comment

        • Optional options: any

        Returns AxiosPromise<Comment>

    • issueGetCommentReactions:function
      • issueGetCommentReactions(owner: string, repo: string, id: number, options?: any): AxiosPromise<Reaction[]>
      • summary

        Get a list of reactions from a comment of an issue

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • id: number

          id of the comment to edit

        • Optional options: any

        Returns AxiosPromise<Reaction[]>

    • issueGetComments:function
      • issueGetComments(owner: string, repo: string, index: number, since?: string, before?: string, options?: any): AxiosPromise<Comment[]>
      • summary

        List all comments on an issue

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the issue

        • Optional since: string
        • Optional before: string
        • Optional options: any

        Returns AxiosPromise<Comment[]>

    • issueGetCommentsAndTimeline:function
      • issueGetCommentsAndTimeline(owner: string, repo: string, index: number, since?: string, page?: number, limit?: number, before?: string, options?: any): AxiosPromise<TimelineComment[]>
      • summary

        List all comments and events on an issue

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the issue

        • Optional since: string
        • Optional page: number
        • Optional limit: number
        • Optional before: string
        • Optional options: any

        Returns AxiosPromise<TimelineComment[]>

    • issueGetIssue:function
      • issueGetIssue(owner: string, repo: string, index: number, options?: any): AxiosPromise<Issue>
      • summary

        Get an issue

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the issue to get

        • Optional options: any

        Returns AxiosPromise<Issue>

    • issueGetIssueReactions:function
      • issueGetIssueReactions(owner: string, repo: string, index: number, page?: number, limit?: number, options?: any): AxiosPromise<Reaction[]>
      • summary

        Get a list reactions of an issue

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the issue

        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<Reaction[]>

    • issueGetLabel:function
      • issueGetLabel(owner: string, repo: string, id: number, options?: any): AxiosPromise<Label>
      • summary

        Get a single label

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • id: number

          id of the label to get

        • Optional options: any

        Returns AxiosPromise<Label>

    • issueGetLabels:function
      • issueGetLabels(owner: string, repo: string, index: number, options?: any): AxiosPromise<Label[]>
      • summary

        Get an issue's labels

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the issue

        • Optional options: any

        Returns AxiosPromise<Label[]>

    • issueGetMilestone:function
      • issueGetMilestone(owner: string, repo: string, id: string, options?: any): AxiosPromise<Milestone>
      • summary

        Get a milestone

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • id: string

          the milestone to get, identified by ID and if not available by name

        • Optional options: any

        Returns AxiosPromise<Milestone>

    • issueGetMilestonesList:function
      • issueGetMilestonesList(owner: string, repo: string, state?: string, name?: string, page?: number, limit?: number, options?: any): AxiosPromise<Milestone[]>
      • summary

        Get all of a repository's opened milestones

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional state: string
        • Optional name: string
        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<Milestone[]>

    • issueGetRepoComments:function
      • issueGetRepoComments(owner: string, repo: string, since?: string, before?: string, page?: number, limit?: number, options?: any): AxiosPromise<Comment[]>
      • summary

        List all comments in a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional since: string
        • Optional before: string
        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<Comment[]>

    • issueListIssues:function
      • issueListIssues(owner: string, repo: string, state?: "all" | "closed" | "open", labels?: string, q?: string, type?: "issues" | "pulls", milestones?: string, since?: string, before?: string, createdBy?: string, assignedBy?: string, mentionedBy?: string, page?: number, limit?: number, options?: any): AxiosPromise<Issue[]>
      • summary

        List a repository's issues

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional state: "all" | "closed" | "open"
        • Optional labels: string
        • Optional q: string
        • Optional type: "issues" | "pulls"
        • Optional milestones: string
        • Optional since: string
        • Optional before: string
        • Optional createdBy: string
        • Optional assignedBy: string
        • Optional mentionedBy: string
        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<Issue[]>

    • issueListLabels:function
      • issueListLabels(owner: string, repo: string, page?: number, limit?: number, options?: any): AxiosPromise<Label[]>
      • summary

        Get all of a repository's labels

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<Label[]>

    • issuePostCommentReaction:function
      • issuePostCommentReaction(owner: string, repo: string, id: number, content?: EditReactionOption, options?: any): AxiosPromise<Reaction>
      • summary

        Add a reaction to a comment of an issue

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • id: number

          id of the comment to edit

        • Optional content: EditReactionOption
        • Optional options: any

        Returns AxiosPromise<Reaction>

    • issuePostIssueReaction:function
      • issuePostIssueReaction(owner: string, repo: string, index: number, content?: EditReactionOption, options?: any): AxiosPromise<Reaction>
      • summary

        Add a reaction to an issue

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the issue

        • Optional content: EditReactionOption
        • Optional options: any

        Returns AxiosPromise<Reaction>

    • issueRemoveLabel:function
      • issueRemoveLabel(owner: string, repo: string, index: number, id: number, options?: any): AxiosPromise<void>
      • summary

        Remove a label from an issue

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the issue

        • id: number

          id of the label to remove

        • Optional options: any

        Returns AxiosPromise<void>

    • issueReplaceLabels:function
      • issueReplaceLabels(owner: string, repo: string, index: number, body?: IssueLabelsOption, options?: any): AxiosPromise<Label[]>
      • summary

        Replace an issue's labels

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the issue

        • Optional body: IssueLabelsOption
        • Optional options: any

        Returns AxiosPromise<Label[]>

    • issueResetTime:function
      • issueResetTime(owner: string, repo: string, index: number, options?: any): AxiosPromise<void>
      • summary

        Reset a tracked time of an issue

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the issue to add tracked time to

        • Optional options: any

        Returns AxiosPromise<void>

    • issueSearchIssues:function
      • issueSearchIssues(state?: string, labels?: string, milestones?: string, q?: string, priorityRepoId?: number, type?: string, since?: string, before?: string, assigned?: boolean, created?: boolean, mentioned?: boolean, reviewRequested?: boolean, owner?: string, team?: string, page?: number, limit?: number, options?: any): AxiosPromise<Issue[]>
      • summary

        Search for issues across the repositories that the user has access to

        throws

        {RequiredError}

        Parameters

        • Optional state: string
        • Optional labels: string
        • Optional milestones: string
        • Optional q: string
        • Optional priorityRepoId: number
        • Optional type: string
        • Optional since: string
        • Optional before: string
        • Optional assigned: boolean
        • Optional created: boolean
        • Optional mentioned: boolean
        • Optional reviewRequested: boolean
        • Optional owner: string
        • Optional team: string
        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<Issue[]>

    • issueStartStopWatch:function
      • issueStartStopWatch(owner: string, repo: string, index: number, options?: any): AxiosPromise<void>
      • summary

        Start stopwatch on an issue.

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the issue to create the stopwatch on

        • Optional options: any

        Returns AxiosPromise<void>

    • issueStopStopWatch:function
      • issueStopStopWatch(owner: string, repo: string, index: number, options?: any): AxiosPromise<void>
      • summary

        Stop an issue's existing stopwatch.

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the issue to stop the stopwatch on

        • Optional options: any

        Returns AxiosPromise<void>

    • issueSubscriptions:function
      • issueSubscriptions(owner: string, repo: string, index: number, page?: number, limit?: number, options?: any): AxiosPromise<User[]>
      • summary

        Get users who subscribed on an issue.

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the issue

        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<User[]>

    • issueTrackedTimes:function
      • issueTrackedTimes(owner: string, repo: string, index: number, user?: string, since?: string, before?: string, page?: number, limit?: number, options?: any): AxiosPromise<TrackedTime[]>
      • summary

        List an issue's tracked times

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the issue

        • Optional user: string
        • Optional since: string
        • Optional before: string
        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<TrackedTime[]>

IssueApiFp

  • IssueApiFp(configuration?: Configuration): { issueAddLabel: any; issueAddSubscription: any; issueAddTime: any; issueCheckSubscription: any; issueClearLabels: any; issueCreateComment: any; issueCreateIssue: any; issueCreateLabel: any; issueCreateMilestone: any; issueDelete: any; issueDeleteComment: any; issueDeleteCommentDeprecated: any; issueDeleteCommentReaction: any; issueDeleteIssueReaction: any; issueDeleteLabel: any; issueDeleteMilestone: any; issueDeleteStopWatch: any; issueDeleteSubscription: any; issueDeleteTime: any; issueEditComment: any; issueEditCommentDeprecated: any; issueEditIssue: any; issueEditIssueDeadline: any; issueEditLabel: any; issueEditMilestone: any; issueGetComment: any; issueGetCommentReactions: any; issueGetComments: any; issueGetCommentsAndTimeline: any; issueGetIssue: any; issueGetIssueReactions: any; issueGetLabel: any; issueGetLabels: any; issueGetMilestone: any; issueGetMilestonesList: any; issueGetRepoComments: any; issueListIssues: any; issueListLabels: any; issuePostCommentReaction: any; issuePostIssueReaction: any; issueRemoveLabel: any; issueReplaceLabels: any; issueResetTime: any; issueSearchIssues: any; issueStartStopWatch: any; issueStopStopWatch: any; issueSubscriptions: any; issueTrackedTimes: any }

  • IssueApi - functional programming interface

    export

    Parameters

    Returns { issueAddLabel: any; issueAddSubscription: any; issueAddTime: any; issueCheckSubscription: any; issueClearLabels: any; issueCreateComment: any; issueCreateIssue: any; issueCreateLabel: any; issueCreateMilestone: any; issueDelete: any; issueDeleteComment: any; issueDeleteCommentDeprecated: any; issueDeleteCommentReaction: any; issueDeleteIssueReaction: any; issueDeleteLabel: any; issueDeleteMilestone: any; issueDeleteStopWatch: any; issueDeleteSubscription: any; issueDeleteTime: any; issueEditComment: any; issueEditCommentDeprecated: any; issueEditIssue: any; issueEditIssueDeadline: any; issueEditLabel: any; issueEditMilestone: any; issueGetComment: any; issueGetCommentReactions: any; issueGetComments: any; issueGetCommentsAndTimeline: any; issueGetIssue: any; issueGetIssueReactions: any; issueGetLabel: any; issueGetLabels: any; issueGetMilestone: any; issueGetMilestonesList: any; issueGetRepoComments: any; issueListIssues: any; issueListLabels: any; issuePostCommentReaction: any; issuePostIssueReaction: any; issueRemoveLabel: any; issueReplaceLabels: any; issueResetTime: any; issueSearchIssues: any; issueStartStopWatch: any; issueStopStopWatch: any; issueSubscriptions: any; issueTrackedTimes: any }

    • issueAddLabel:function
      • issueAddLabel(owner: string, repo: string, index: number, body?: IssueLabelsOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Label[]>)>
      • summary

        Add a label to an issue

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the issue

        • Optional body: IssueLabelsOption
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Label[]>)>

    • issueAddSubscription:function
      • issueAddSubscription(owner: string, repo: string, index: number, user: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Subscribe user to issue

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the issue

        • user: string

          user to subscribe

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • issueAddTime:function
      • issueAddTime(owner: string, repo: string, index: number, body?: AddTimeOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<TrackedTime>)>
      • summary

        Add tracked time to a issue

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the issue

        • Optional body: AddTimeOption
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<TrackedTime>)>

    • issueCheckSubscription:function
      • issueCheckSubscription(owner: string, repo: string, index: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<WatchInfo>)>
      • summary

        Check if user is subscribed to an issue

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the issue

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<WatchInfo>)>

    • issueClearLabels:function
      • issueClearLabels(owner: string, repo: string, index: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Remove all labels from an issue

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the issue

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • issueCreateComment:function
      • issueCreateComment(owner: string, repo: string, index: number, body?: CreateIssueCommentOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Comment>)>
      • summary

        Add a comment to an issue

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the issue

        • Optional body: CreateIssueCommentOption
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Comment>)>

    • issueCreateIssue:function
      • issueCreateIssue(owner: string, repo: string, body?: CreateIssueOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Issue>)>
      • summary

        Create an issue. If using deadline only the date will be taken into account, and time of day ignored.

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional body: CreateIssueOption
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Issue>)>

    • issueCreateLabel:function
      • issueCreateLabel(owner: string, repo: string, body?: CreateLabelOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Label>)>
      • summary

        Create a label

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional body: CreateLabelOption
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Label>)>

    • issueCreateMilestone:function
      • issueCreateMilestone(owner: string, repo: string, body?: CreateMilestoneOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Milestone>)>
      • summary

        Create a milestone

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional body: CreateMilestoneOption
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Milestone>)>

    • issueDelete:function
      • issueDelete(owner: string, repo: string, index: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Delete an issue

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of issue to delete

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • issueDeleteComment:function
      • issueDeleteComment(owner: string, repo: string, id: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Delete a comment

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • id: number

          id of comment to delete

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • issueDeleteCommentDeprecated:function
      • issueDeleteCommentDeprecated(owner: string, repo: string, index: number, id: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Delete a comment

        deprecated
        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          this parameter is ignored

        • id: number

          id of comment to delete

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • issueDeleteCommentReaction:function
      • issueDeleteCommentReaction(owner: string, repo: string, id: number, content?: EditReactionOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Remove a reaction from a comment of an issue

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • id: number

          id of the comment to edit

        • Optional content: EditReactionOption
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • issueDeleteIssueReaction:function
      • issueDeleteIssueReaction(owner: string, repo: string, index: number, content?: EditReactionOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Remove a reaction from an issue

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the issue

        • Optional content: EditReactionOption
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • issueDeleteLabel:function
      • issueDeleteLabel(owner: string, repo: string, id: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Delete a label

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • id: number

          id of the label to delete

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • issueDeleteMilestone:function
      • issueDeleteMilestone(owner: string, repo: string, id: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Delete a milestone

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • id: string

          the milestone to delete, identified by ID and if not available by name

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • issueDeleteStopWatch:function
      • issueDeleteStopWatch(owner: string, repo: string, index: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Delete an issue's existing stopwatch.

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the issue to stop the stopwatch on

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • issueDeleteSubscription:function
      • issueDeleteSubscription(owner: string, repo: string, index: number, user: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Unsubscribe user from issue

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the issue

        • user: string

          user witch unsubscribe

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • issueDeleteTime:function
      • issueDeleteTime(owner: string, repo: string, index: number, id: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Delete specific tracked time

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the issue

        • id: number

          id of time to delete

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • issueEditComment:function
      • issueEditComment(owner: string, repo: string, id: number, body?: EditIssueCommentOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Comment>)>
      • summary

        Edit a comment

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • id: number

          id of the comment to edit

        • Optional body: EditIssueCommentOption
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Comment>)>

    • issueEditCommentDeprecated:function
      • issueEditCommentDeprecated(owner: string, repo: string, index: number, id: number, body?: EditIssueCommentOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Comment>)>
      • summary

        Edit a comment

        deprecated
        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          this parameter is ignored

        • id: number

          id of the comment to edit

        • Optional body: EditIssueCommentOption
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Comment>)>

    • issueEditIssue:function
      • issueEditIssue(owner: string, repo: string, index: number, body?: EditIssueOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Issue>)>
      • summary

        Edit an issue. If using deadline only the date will be taken into account, and time of day ignored.

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the issue to edit

        • Optional body: EditIssueOption
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Issue>)>

    • issueEditIssueDeadline:function
      • issueEditIssueDeadline(owner: string, repo: string, index: number, body?: EditDeadlineOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<IssueDeadline>)>
      • summary

        Set an issue deadline. If set to null, the deadline is deleted. If using deadline only the date will be taken into account, and time of day ignored.

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the issue to create or update a deadline on

        • Optional body: EditDeadlineOption
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<IssueDeadline>)>

    • issueEditLabel:function
      • issueEditLabel(owner: string, repo: string, id: number, body?: EditLabelOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Label>)>
      • summary

        Update a label

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • id: number

          id of the label to edit

        • Optional body: EditLabelOption
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Label>)>

    • issueEditMilestone:function
      • issueEditMilestone(owner: string, repo: string, id: string, body?: EditMilestoneOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Milestone>)>
      • summary

        Update a milestone

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • id: string

          the milestone to edit, identified by ID and if not available by name

        • Optional body: EditMilestoneOption
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Milestone>)>

    • issueGetComment:function
      • issueGetComment(owner: string, repo: string, id: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Comment>)>
      • summary

        Get a comment

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • id: number

          id of the comment

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Comment>)>

    • issueGetCommentReactions:function
      • issueGetCommentReactions(owner: string, repo: string, id: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Reaction[]>)>
      • summary

        Get a list of reactions from a comment of an issue

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • id: number

          id of the comment to edit

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Reaction[]>)>

    • issueGetComments:function
      • issueGetComments(owner: string, repo: string, index: number, since?: string, before?: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Comment[]>)>
      • summary

        List all comments on an issue

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the issue

        • Optional since: string
        • Optional before: string
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Comment[]>)>

    • issueGetCommentsAndTimeline:function
      • issueGetCommentsAndTimeline(owner: string, repo: string, index: number, since?: string, page?: number, limit?: number, before?: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<TimelineComment[]>)>
      • summary

        List all comments and events on an issue

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the issue

        • Optional since: string
        • Optional page: number
        • Optional limit: number
        • Optional before: string
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<TimelineComment[]>)>

    • issueGetIssue:function
      • issueGetIssue(owner: string, repo: string, index: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Issue>)>
      • summary

        Get an issue

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the issue to get

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Issue>)>

    • issueGetIssueReactions:function
      • issueGetIssueReactions(owner: string, repo: string, index: number, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Reaction[]>)>
      • summary

        Get a list reactions of an issue

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the issue

        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Reaction[]>)>

    • issueGetLabel:function
      • issueGetLabel(owner: string, repo: string, id: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Label>)>
      • summary

        Get a single label

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • id: number

          id of the label to get

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Label>)>

    • issueGetLabels:function
      • issueGetLabels(owner: string, repo: string, index: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Label[]>)>
      • summary

        Get an issue's labels

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the issue

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Label[]>)>

    • issueGetMilestone:function
      • issueGetMilestone(owner: string, repo: string, id: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Milestone>)>
      • summary

        Get a milestone

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • id: string

          the milestone to get, identified by ID and if not available by name

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Milestone>)>

    • issueGetMilestonesList:function
      • issueGetMilestonesList(owner: string, repo: string, state?: string, name?: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Milestone[]>)>
      • summary

        Get all of a repository's opened milestones

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional state: string
        • Optional name: string
        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Milestone[]>)>

    • issueGetRepoComments:function
      • issueGetRepoComments(owner: string, repo: string, since?: string, before?: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Comment[]>)>
      • summary

        List all comments in a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional since: string
        • Optional before: string
        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Comment[]>)>

    • issueListIssues:function
      • issueListIssues(owner: string, repo: string, state?: "all" | "closed" | "open", labels?: string, q?: string, type?: "issues" | "pulls", milestones?: string, since?: string, before?: string, createdBy?: string, assignedBy?: string, mentionedBy?: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Issue[]>)>
      • summary

        List a repository's issues

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional state: "all" | "closed" | "open"
        • Optional labels: string
        • Optional q: string
        • Optional type: "issues" | "pulls"
        • Optional milestones: string
        • Optional since: string
        • Optional before: string
        • Optional createdBy: string
        • Optional assignedBy: string
        • Optional mentionedBy: string
        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Issue[]>)>

    • issueListLabels:function
      • issueListLabels(owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Label[]>)>
      • summary

        Get all of a repository's labels

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Label[]>)>

    • issuePostCommentReaction:function
      • issuePostCommentReaction(owner: string, repo: string, id: number, content?: EditReactionOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Reaction>)>
      • summary

        Add a reaction to a comment of an issue

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • id: number

          id of the comment to edit

        • Optional content: EditReactionOption
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Reaction>)>

    • issuePostIssueReaction:function
      • issuePostIssueReaction(owner: string, repo: string, index: number, content?: EditReactionOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Reaction>)>
      • summary

        Add a reaction to an issue

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the issue

        • Optional content: EditReactionOption
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Reaction>)>

    • issueRemoveLabel:function
      • issueRemoveLabel(owner: string, repo: string, index: number, id: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Remove a label from an issue

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the issue

        • id: number

          id of the label to remove

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • issueReplaceLabels:function
      • issueReplaceLabels(owner: string, repo: string, index: number, body?: IssueLabelsOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Label[]>)>
      • summary

        Replace an issue's labels

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the issue

        • Optional body: IssueLabelsOption
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Label[]>)>

    • issueResetTime:function
      • issueResetTime(owner: string, repo: string, index: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Reset a tracked time of an issue

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the issue to add tracked time to

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • issueSearchIssues:function
      • issueSearchIssues(state?: string, labels?: string, milestones?: string, q?: string, priorityRepoId?: number, type?: string, since?: string, before?: string, assigned?: boolean, created?: boolean, mentioned?: boolean, reviewRequested?: boolean, owner?: string, team?: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Issue[]>)>
      • summary

        Search for issues across the repositories that the user has access to

        throws

        {RequiredError}

        Parameters

        • Optional state: string
        • Optional labels: string
        • Optional milestones: string
        • Optional q: string
        • Optional priorityRepoId: number
        • Optional type: string
        • Optional since: string
        • Optional before: string
        • Optional assigned: boolean
        • Optional created: boolean
        • Optional mentioned: boolean
        • Optional reviewRequested: boolean
        • Optional owner: string
        • Optional team: string
        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Issue[]>)>

    • issueStartStopWatch:function
      • issueStartStopWatch(owner: string, repo: string, index: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Start stopwatch on an issue.

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the issue to create the stopwatch on

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • issueStopStopWatch:function
      • issueStopStopWatch(owner: string, repo: string, index: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Stop an issue's existing stopwatch.

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the issue to stop the stopwatch on

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • issueSubscriptions:function
      • issueSubscriptions(owner: string, repo: string, index: number, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<User[]>)>
      • summary

        Get users who subscribed on an issue.

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the issue

        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<User[]>)>

    • issueTrackedTimes:function
      • issueTrackedTimes(owner: string, repo: string, index: number, user?: string, since?: string, before?: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<TrackedTime[]>)>
      • summary

        List an issue's tracked times

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the issue

        • Optional user: string
        • Optional since: string
        • Optional before: string
        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<TrackedTime[]>)>

MiscellaneousApiAxiosParamCreator

  • MiscellaneousApiAxiosParamCreator(configuration?: Configuration): { getNodeInfo: ((options?: AxiosRequestConfig) => Promise<RequestArgs>); getSigningKey: ((options?: AxiosRequestConfig) => Promise<RequestArgs>); getVersion: ((options?: AxiosRequestConfig) => Promise<RequestArgs>); renderMarkdown: ((body?: MarkdownOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); renderMarkdownRaw: ((body: string, options?: AxiosRequestConfig) => Promise<RequestArgs>) }

  • MiscellaneousApi - axios parameter creator

    export

    Parameters

    Returns { getNodeInfo: ((options?: AxiosRequestConfig) => Promise<RequestArgs>); getSigningKey: ((options?: AxiosRequestConfig) => Promise<RequestArgs>); getVersion: ((options?: AxiosRequestConfig) => Promise<RequestArgs>); renderMarkdown: ((body?: MarkdownOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); renderMarkdownRaw: ((body: string, options?: AxiosRequestConfig) => Promise<RequestArgs>) }

    • getNodeInfo: ((options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Returns the nodeinfo of the Gitea application

          throws

          {RequiredError}

          Parameters

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • getSigningKey: ((options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get default signing-key.gpg

          throws

          {RequiredError}

          Parameters

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • getVersion: ((options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Returns the version of the Gitea application

          throws

          {RequiredError}

          Parameters

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • renderMarkdown: ((body?: MarkdownOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (body?: MarkdownOption, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Render a markdown document as HTML

          throws

          {RequiredError}

          Parameters

          Returns Promise<RequestArgs>

    • renderMarkdownRaw: ((body: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (body: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Render raw markdown as HTML

          throws

          {RequiredError}

          Parameters

          • body: string

            Request body to render

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

MiscellaneousApiFactory

  • MiscellaneousApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getNodeInfo: any; getSigningKey: any; getVersion: any; renderMarkdown: any; renderMarkdownRaw: any }

  • MiscellaneousApi - factory interface

    export

    Parameters

    • Optional configuration: Configuration
    • Optional basePath: string
    • Optional axios: AxiosInstance

    Returns { getNodeInfo: any; getSigningKey: any; getVersion: any; renderMarkdown: any; renderMarkdownRaw: any }

    • getNodeInfo:function
      • getNodeInfo(options?: any): AxiosPromise<NodeInfo>
      • summary

        Returns the nodeinfo of the Gitea application

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<NodeInfo>

    • getSigningKey:function
      • getSigningKey(options?: any): AxiosPromise<string>
      • summary

        Get default signing-key.gpg

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<string>

    • getVersion:function
      • summary

        Returns the version of the Gitea application

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<ServerVersion>

    • renderMarkdown:function
      • renderMarkdown(body?: MarkdownOption, options?: any): AxiosPromise<string>
      • summary

        Render a markdown document as HTML

        throws

        {RequiredError}

        Parameters

        Returns AxiosPromise<string>

    • renderMarkdownRaw:function
      • renderMarkdownRaw(body: string, options?: any): AxiosPromise<string>
      • summary

        Render raw markdown as HTML

        throws

        {RequiredError}

        Parameters

        • body: string

          Request body to render

        • Optional options: any

        Returns AxiosPromise<string>

MiscellaneousApiFp

  • MiscellaneousApiFp(configuration?: Configuration): { getNodeInfo: any; getSigningKey: any; getVersion: any; renderMarkdown: any; renderMarkdownRaw: any }

  • MiscellaneousApi - functional programming interface

    export

    Parameters

    Returns { getNodeInfo: any; getSigningKey: any; getVersion: any; renderMarkdown: any; renderMarkdownRaw: any }

    • getNodeInfo:function
      • getNodeInfo(options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<NodeInfo>)>
      • summary

        Returns the nodeinfo of the Gitea application

        throws

        {RequiredError}

        Parameters

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<NodeInfo>)>

    • getSigningKey:function
      • getSigningKey(options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>)>
      • summary

        Get default signing-key.gpg

        throws

        {RequiredError}

        Parameters

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>)>

    • getVersion:function
      • getVersion(options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ServerVersion>)>
      • summary

        Returns the version of the Gitea application

        throws

        {RequiredError}

        Parameters

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ServerVersion>)>

    • renderMarkdown:function
      • renderMarkdown(body?: MarkdownOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>)>
      • summary

        Render a markdown document as HTML

        throws

        {RequiredError}

        Parameters

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>)>

    • renderMarkdownRaw:function
      • renderMarkdownRaw(body: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>)>
      • summary

        Render raw markdown as HTML

        throws

        {RequiredError}

        Parameters

        • body: string

          Request body to render

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>)>

NotificationApiAxiosParamCreator

  • NotificationApiAxiosParamCreator(configuration?: Configuration): { notifyGetList: ((all?: boolean, statusTypes?: string[], subjectType?: ("repository" | "issue" | "pull" | "commit")[], since?: string, before?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); notifyGetRepoList: ((owner: string, repo: string, all?: boolean, statusTypes?: string[], subjectType?: ("repository" | "issue" | "pull" | "commit")[], since?: string, before?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); notifyGetThread: ((id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); notifyNewAvailable: ((options?: AxiosRequestConfig) => Promise<RequestArgs>); notifyReadList: ((lastReadAt?: string, all?: string, statusTypes?: string[], toStatus?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); notifyReadRepoList: ((owner: string, repo: string, all?: string, statusTypes?: string[], toStatus?: string, lastReadAt?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); notifyReadThread: ((id: string, toStatus?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>) }

  • NotificationApi - axios parameter creator

    export

    Parameters

    Returns { notifyGetList: ((all?: boolean, statusTypes?: string[], subjectType?: ("repository" | "issue" | "pull" | "commit")[], since?: string, before?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); notifyGetRepoList: ((owner: string, repo: string, all?: boolean, statusTypes?: string[], subjectType?: ("repository" | "issue" | "pull" | "commit")[], since?: string, before?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); notifyGetThread: ((id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); notifyNewAvailable: ((options?: AxiosRequestConfig) => Promise<RequestArgs>); notifyReadList: ((lastReadAt?: string, all?: string, statusTypes?: string[], toStatus?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); notifyReadRepoList: ((owner: string, repo: string, all?: string, statusTypes?: string[], toStatus?: string, lastReadAt?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); notifyReadThread: ((id: string, toStatus?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>) }

    • notifyGetList: ((all?: boolean, statusTypes?: string[], subjectType?: ("repository" | "issue" | "pull" | "commit")[], since?: string, before?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (all?: boolean, statusTypes?: string[], subjectType?: ("repository" | "issue" | "pull" | "commit")[], since?: string, before?: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          List users's notification threads

          throws

          {RequiredError}

          Parameters

          • Optional all: boolean
          • Optional statusTypes: string[]
          • Optional subjectType: ("repository" | "issue" | "pull" | "commit")[]
          • Optional since: string
          • Optional before: string
          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • notifyGetRepoList: ((owner: string, repo: string, all?: boolean, statusTypes?: string[], subjectType?: ("repository" | "issue" | "pull" | "commit")[], since?: string, before?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, all?: boolean, statusTypes?: string[], subjectType?: ("repository" | "issue" | "pull" | "commit")[], since?: string, before?: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          List users's notification threads on a specific repo

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • Optional all: boolean
          • Optional statusTypes: string[]
          • Optional subjectType: ("repository" | "issue" | "pull" | "commit")[]
          • Optional since: string
          • Optional before: string
          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • notifyGetThread: ((id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (id: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get notification thread by ID

          throws

          {RequiredError}

          Parameters

          • id: string

            id of notification thread

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • notifyNewAvailable: ((options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Check if unread notifications exist

          throws

          {RequiredError}

          Parameters

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • notifyReadList: ((lastReadAt?: string, all?: string, statusTypes?: string[], toStatus?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (lastReadAt?: string, all?: string, statusTypes?: string[], toStatus?: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Mark notification threads as read, pinned or unread

          throws

          {RequiredError}

          Parameters

          • Optional lastReadAt: string
          • Optional all: string
          • Optional statusTypes: string[]
          • Optional toStatus: string
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • notifyReadRepoList: ((owner: string, repo: string, all?: string, statusTypes?: string[], toStatus?: string, lastReadAt?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, all?: string, statusTypes?: string[], toStatus?: string, lastReadAt?: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Mark notification threads as read, pinned or unread on a specific repo

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • Optional all: string
          • Optional statusTypes: string[]
          • Optional toStatus: string
          • Optional lastReadAt: string
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • notifyReadThread: ((id: string, toStatus?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (id: string, toStatus?: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Mark notification thread as read by ID

          throws

          {RequiredError}

          Parameters

          • id: string

            id of notification thread

          • Optional toStatus: string
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

NotificationApiFactory

  • NotificationApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { notifyGetList: any; notifyGetRepoList: any; notifyGetThread: any; notifyNewAvailable: any; notifyReadList: any; notifyReadRepoList: any; notifyReadThread: any }

  • NotificationApi - factory interface

    export

    Parameters

    • Optional configuration: Configuration
    • Optional basePath: string
    • Optional axios: AxiosInstance

    Returns { notifyGetList: any; notifyGetRepoList: any; notifyGetThread: any; notifyNewAvailable: any; notifyReadList: any; notifyReadRepoList: any; notifyReadThread: any }

    • notifyGetList:function
      • notifyGetList(all?: boolean, statusTypes?: string[], subjectType?: ("repository" | "issue" | "pull" | "commit")[], since?: string, before?: string, page?: number, limit?: number, options?: any): AxiosPromise<NotificationThread[]>
      • summary

        List users's notification threads

        throws

        {RequiredError}

        Parameters

        • Optional all: boolean
        • Optional statusTypes: string[]
        • Optional subjectType: ("repository" | "issue" | "pull" | "commit")[]
        • Optional since: string
        • Optional before: string
        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<NotificationThread[]>

    • notifyGetRepoList:function
      • notifyGetRepoList(owner: string, repo: string, all?: boolean, statusTypes?: string[], subjectType?: ("repository" | "issue" | "pull" | "commit")[], since?: string, before?: string, page?: number, limit?: number, options?: any): AxiosPromise<NotificationThread[]>
      • summary

        List users's notification threads on a specific repo

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional all: boolean
        • Optional statusTypes: string[]
        • Optional subjectType: ("repository" | "issue" | "pull" | "commit")[]
        • Optional since: string
        • Optional before: string
        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<NotificationThread[]>

    • notifyGetThread:function
      • summary

        Get notification thread by ID

        throws

        {RequiredError}

        Parameters

        • id: string

          id of notification thread

        • Optional options: any

        Returns AxiosPromise<NotificationThread>

    • notifyNewAvailable:function
      • summary

        Check if unread notifications exist

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<NotificationCount>

    • notifyReadList:function
      • notifyReadList(lastReadAt?: string, all?: string, statusTypes?: string[], toStatus?: string, options?: any): AxiosPromise<NotificationThread[]>
      • summary

        Mark notification threads as read, pinned or unread

        throws

        {RequiredError}

        Parameters

        • Optional lastReadAt: string
        • Optional all: string
        • Optional statusTypes: string[]
        • Optional toStatus: string
        • Optional options: any

        Returns AxiosPromise<NotificationThread[]>

    • notifyReadRepoList:function
      • notifyReadRepoList(owner: string, repo: string, all?: string, statusTypes?: string[], toStatus?: string, lastReadAt?: string, options?: any): AxiosPromise<NotificationThread[]>
      • summary

        Mark notification threads as read, pinned or unread on a specific repo

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional all: string
        • Optional statusTypes: string[]
        • Optional toStatus: string
        • Optional lastReadAt: string
        • Optional options: any

        Returns AxiosPromise<NotificationThread[]>

    • notifyReadThread:function
      • notifyReadThread(id: string, toStatus?: string, options?: any): AxiosPromise<NotificationThread>
      • summary

        Mark notification thread as read by ID

        throws

        {RequiredError}

        Parameters

        • id: string

          id of notification thread

        • Optional toStatus: string
        • Optional options: any

        Returns AxiosPromise<NotificationThread>

NotificationApiFp

  • NotificationApiFp(configuration?: Configuration): { notifyGetList: any; notifyGetRepoList: any; notifyGetThread: any; notifyNewAvailable: any; notifyReadList: any; notifyReadRepoList: any; notifyReadThread: any }

  • NotificationApi - functional programming interface

    export

    Parameters

    Returns { notifyGetList: any; notifyGetRepoList: any; notifyGetThread: any; notifyNewAvailable: any; notifyReadList: any; notifyReadRepoList: any; notifyReadThread: any }

    • notifyGetList:function
      • notifyGetList(all?: boolean, statusTypes?: string[], subjectType?: ("repository" | "issue" | "pull" | "commit")[], since?: string, before?: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<NotificationThread[]>)>
      • summary

        List users's notification threads

        throws

        {RequiredError}

        Parameters

        • Optional all: boolean
        • Optional statusTypes: string[]
        • Optional subjectType: ("repository" | "issue" | "pull" | "commit")[]
        • Optional since: string
        • Optional before: string
        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<NotificationThread[]>)>

    • notifyGetRepoList:function
      • notifyGetRepoList(owner: string, repo: string, all?: boolean, statusTypes?: string[], subjectType?: ("repository" | "issue" | "pull" | "commit")[], since?: string, before?: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<NotificationThread[]>)>
      • summary

        List users's notification threads on a specific repo

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional all: boolean
        • Optional statusTypes: string[]
        • Optional subjectType: ("repository" | "issue" | "pull" | "commit")[]
        • Optional since: string
        • Optional before: string
        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<NotificationThread[]>)>

    • notifyGetThread:function
      • notifyGetThread(id: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<NotificationThread>)>
      • summary

        Get notification thread by ID

        throws

        {RequiredError}

        Parameters

        • id: string

          id of notification thread

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<NotificationThread>)>

    • notifyNewAvailable:function
      • notifyNewAvailable(options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<NotificationCount>)>
      • summary

        Check if unread notifications exist

        throws

        {RequiredError}

        Parameters

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<NotificationCount>)>

    • notifyReadList:function
      • notifyReadList(lastReadAt?: string, all?: string, statusTypes?: string[], toStatus?: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<NotificationThread[]>)>
      • summary

        Mark notification threads as read, pinned or unread

        throws

        {RequiredError}

        Parameters

        • Optional lastReadAt: string
        • Optional all: string
        • Optional statusTypes: string[]
        • Optional toStatus: string
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<NotificationThread[]>)>

    • notifyReadRepoList:function
      • notifyReadRepoList(owner: string, repo: string, all?: string, statusTypes?: string[], toStatus?: string, lastReadAt?: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<NotificationThread[]>)>
      • summary

        Mark notification threads as read, pinned or unread on a specific repo

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional all: string
        • Optional statusTypes: string[]
        • Optional toStatus: string
        • Optional lastReadAt: string
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<NotificationThread[]>)>

    • notifyReadThread:function
      • notifyReadThread(id: string, toStatus?: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<NotificationThread>)>
      • summary

        Mark notification thread as read by ID

        throws

        {RequiredError}

        Parameters

        • id: string

          id of notification thread

        • Optional toStatus: string
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<NotificationThread>)>

OrganizationApiAxiosParamCreator

  • OrganizationApiAxiosParamCreator(configuration?: Configuration): { createOrgRepo: ((org: string, body?: CreateRepoOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); createOrgRepoDeprecated: ((org: string, body?: CreateRepoOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgAddTeamMember: ((id: number, username: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgAddTeamRepository: ((id: number, org: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgConcealMember: ((org: string, username: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgCreate: ((organization: CreateOrgOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgCreateHook: ((org: string, body: CreateHookOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgCreateLabel: ((org: string, body?: CreateLabelOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgCreateTeam: ((org: string, body?: CreateTeamOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgDelete: ((org: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgDeleteHook: ((org: string, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgDeleteLabel: ((org: string, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgDeleteMember: ((org: string, username: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgDeleteTeam: ((id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgEdit: ((org: string, body: EditOrgOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgEditHook: ((org: string, id: number, body?: EditHookOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgEditLabel: ((org: string, id: number, body?: EditLabelOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgEditTeam: ((id: number, body?: EditTeamOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgGet: ((org: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgGetAll: ((lang?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgGetHook: ((org: string, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgGetLabel: ((org: string, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgGetTeam: ((id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgGetUserPermissions: ((username: string, org: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgIsMember: ((org: string, username: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgIsPublicMember: ((org: string, username: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgListCurrentUserOrgs: ((page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgListHooks: ((org: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgListLabels: ((org: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgListMembers: ((org: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgListPublicMembers: ((org: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgListRepos: ((org: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgListTeamMember: ((id: number, username: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgListTeamMembers: ((id: number, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgListTeamRepo: ((id: number, org: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgListTeamRepos: ((id: number, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgListTeams: ((org: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgListUserOrgs: ((username: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgPublicizeMember: ((org: string, username: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgRemoveTeamMember: ((id: number, username: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgRemoveTeamRepository: ((id: number, org: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); teamSearch: ((org: string, q?: string, includeDesc?: boolean, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>) }

  • OrganizationApi - axios parameter creator

    export

    Parameters

    Returns { createOrgRepo: ((org: string, body?: CreateRepoOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); createOrgRepoDeprecated: ((org: string, body?: CreateRepoOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgAddTeamMember: ((id: number, username: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgAddTeamRepository: ((id: number, org: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgConcealMember: ((org: string, username: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgCreate: ((organization: CreateOrgOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgCreateHook: ((org: string, body: CreateHookOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgCreateLabel: ((org: string, body?: CreateLabelOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgCreateTeam: ((org: string, body?: CreateTeamOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgDelete: ((org: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgDeleteHook: ((org: string, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgDeleteLabel: ((org: string, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgDeleteMember: ((org: string, username: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgDeleteTeam: ((id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgEdit: ((org: string, body: EditOrgOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgEditHook: ((org: string, id: number, body?: EditHookOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgEditLabel: ((org: string, id: number, body?: EditLabelOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgEditTeam: ((id: number, body?: EditTeamOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgGet: ((org: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgGetAll: ((lang?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgGetHook: ((org: string, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgGetLabel: ((org: string, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgGetTeam: ((id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgGetUserPermissions: ((username: string, org: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgIsMember: ((org: string, username: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgIsPublicMember: ((org: string, username: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgListCurrentUserOrgs: ((page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgListHooks: ((org: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgListLabels: ((org: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgListMembers: ((org: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgListPublicMembers: ((org: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgListRepos: ((org: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgListTeamMember: ((id: number, username: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgListTeamMembers: ((id: number, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgListTeamRepo: ((id: number, org: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgListTeamRepos: ((id: number, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgListTeams: ((org: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgListUserOrgs: ((username: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgPublicizeMember: ((org: string, username: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgRemoveTeamMember: ((id: number, username: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); orgRemoveTeamRepository: ((id: number, org: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); teamSearch: ((org: string, q?: string, includeDesc?: boolean, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>) }

    • createOrgRepo: ((org: string, body?: CreateRepoOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (org: string, body?: CreateRepoOption, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Create a repository in an organization

          throws

          {RequiredError}

          Parameters

          • org: string

            name of organization

          • Optional body: CreateRepoOption
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • createOrgRepoDeprecated: ((org: string, body?: CreateRepoOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (org: string, body?: CreateRepoOption, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Create a repository in an organization

          deprecated
          throws

          {RequiredError}

          Parameters

          • org: string

            name of organization

          • Optional body: CreateRepoOption
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • orgAddTeamMember: ((id: number, username: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (id: number, username: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Add a team member

          throws

          {RequiredError}

          Parameters

          • id: number

            id of the team

          • username: string

            username of the user to add

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • orgAddTeamRepository: ((id: number, org: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (id: number, org: string, repo: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Add a repository to a team

          throws

          {RequiredError}

          Parameters

          • id: number

            id of the team

          • org: string

            organization that owns the repo to add

          • repo: string

            name of the repo to add

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • orgConcealMember: ((org: string, username: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (org: string, username: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Conceal a user's membership

          throws

          {RequiredError}

          Parameters

          • org: string

            name of the organization

          • username: string

            username of the user

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • orgCreate: ((organization: CreateOrgOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (organization: CreateOrgOption, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Create an organization

          throws

          {RequiredError}

          Parameters

          Returns Promise<RequestArgs>

    • orgCreateHook: ((org: string, body: CreateHookOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (org: string, body: CreateHookOption, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Create a hook

          throws

          {RequiredError}

          Parameters

          • org: string

            name of the organization

          • body: CreateHookOption
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • orgCreateLabel: ((org: string, body?: CreateLabelOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (org: string, body?: CreateLabelOption, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Create a label for an organization

          throws

          {RequiredError}

          Parameters

          • org: string

            name of the organization

          • Optional body: CreateLabelOption
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • orgCreateTeam: ((org: string, body?: CreateTeamOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (org: string, body?: CreateTeamOption, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Create a team

          throws

          {RequiredError}

          Parameters

          • org: string

            name of the organization

          • Optional body: CreateTeamOption
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • orgDelete: ((org: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (org: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Delete an organization

          throws

          {RequiredError}

          Parameters

          • org: string

            organization that is to be deleted

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • orgDeleteHook: ((org: string, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (org: string, id: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Delete a hook

          throws

          {RequiredError}

          Parameters

          • org: string

            name of the organization

          • id: number

            id of the hook to delete

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • orgDeleteLabel: ((org: string, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (org: string, id: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Delete a label

          throws

          {RequiredError}

          Parameters

          • org: string

            name of the organization

          • id: number

            id of the label to delete

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • orgDeleteMember: ((org: string, username: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (org: string, username: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Remove a member from an organization

          throws

          {RequiredError}

          Parameters

          • org: string

            name of the organization

          • username: string

            username of the user

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • orgDeleteTeam: ((id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (id: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Delete a team

          throws

          {RequiredError}

          Parameters

          • id: number

            id of the team to delete

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • orgEdit: ((org: string, body: EditOrgOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (org: string, body: EditOrgOption, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Edit an organization

          throws

          {RequiredError}

          Parameters

          • org: string

            name of the organization to edit

          • body: EditOrgOption
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • orgEditHook: ((org: string, id: number, body?: EditHookOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (org: string, id: number, body?: EditHookOption, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Update a hook

          throws

          {RequiredError}

          Parameters

          • org: string

            name of the organization

          • id: number

            id of the hook to update

          • Optional body: EditHookOption
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • orgEditLabel: ((org: string, id: number, body?: EditLabelOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (org: string, id: number, body?: EditLabelOption, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Update a label

          throws

          {RequiredError}

          Parameters

          • org: string

            name of the organization

          • id: number

            id of the label to edit

          • Optional body: EditLabelOption
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • orgEditTeam: ((id: number, body?: EditTeamOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (id: number, body?: EditTeamOption, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Edit a team

          throws

          {RequiredError}

          Parameters

          • id: number

            id of the team to edit

          • Optional body: EditTeamOption
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • orgGet: ((org: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (org: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get an organization

          throws

          {RequiredError}

          Parameters

          • org: string

            name of the organization to get

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • orgGetAll: ((lang?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (lang?: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get list of organizations

          throws

          {RequiredError}

          Parameters

          • Optional lang: string
          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • orgGetHook: ((org: string, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (org: string, id: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get a hook

          throws

          {RequiredError}

          Parameters

          • org: string

            name of the organization

          • id: number

            id of the hook to get

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • orgGetLabel: ((org: string, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (org: string, id: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get a single label

          throws

          {RequiredError}

          Parameters

          • org: string

            name of the organization

          • id: number

            id of the label to get

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • orgGetTeam: ((id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (id: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get a team

          throws

          {RequiredError}

          Parameters

          • id: number

            id of the team to get

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • orgGetUserPermissions: ((username: string, org: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (username: string, org: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get user permissions in organization

          throws

          {RequiredError}

          Parameters

          • username: string

            username of user

          • org: string

            name of the organization

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • orgIsMember: ((org: string, username: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (org: string, username: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Check if a user is a member of an organization

          throws

          {RequiredError}

          Parameters

          • org: string

            name of the organization

          • username: string

            username of the user

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • orgIsPublicMember: ((org: string, username: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (org: string, username: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Check if a user is a public member of an organization

          throws

          {RequiredError}

          Parameters

          • org: string

            name of the organization

          • username: string

            username of the user

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • orgListCurrentUserOrgs: ((page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          List the current user's organizations

          throws

          {RequiredError}

          Parameters

          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • orgListHooks: ((org: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (org: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          List an organization's webhooks

          throws

          {RequiredError}

          Parameters

          • org: string

            name of the organization

          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • orgListLabels: ((org: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (org: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          List an organization's labels

          throws

          {RequiredError}

          Parameters

          • org: string

            name of the organization

          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • orgListMembers: ((org: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (org: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          List an organization's members

          throws

          {RequiredError}

          Parameters

          • org: string

            name of the organization

          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • orgListPublicMembers: ((org: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (org: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          List an organization's public members

          throws

          {RequiredError}

          Parameters

          • org: string

            name of the organization

          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • orgListRepos: ((org: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (org: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          List an organization's repos

          throws

          {RequiredError}

          Parameters

          • org: string

            name of the organization

          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • orgListTeamMember: ((id: number, username: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (id: number, username: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          List a particular member of team

          throws

          {RequiredError}

          Parameters

          • id: number

            id of the team

          • username: string

            username of the member to list

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • orgListTeamMembers: ((id: number, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (id: number, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          List a team's members

          throws

          {RequiredError}

          Parameters

          • id: number

            id of the team

          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • orgListTeamRepo: ((id: number, org: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (id: number, org: string, repo: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          List a particular repo of team

          throws

          {RequiredError}

          Parameters

          • id: number

            id of the team

          • org: string

            organization that owns the repo to list

          • repo: string

            name of the repo to list

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • orgListTeamRepos: ((id: number, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (id: number, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          List a team's repos

          throws

          {RequiredError}

          Parameters

          • id: number

            id of the team

          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • orgListTeams: ((org: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (org: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          List an organization's teams

          throws

          {RequiredError}

          Parameters

          • org: string

            name of the organization

          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • orgListUserOrgs: ((username: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (username: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          List a user's organizations

          throws

          {RequiredError}

          Parameters

          • username: string

            username of user

          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • orgPublicizeMember: ((org: string, username: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (org: string, username: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Publicize a user's membership

          throws

          {RequiredError}

          Parameters

          • org: string

            name of the organization

          • username: string

            username of the user

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • orgRemoveTeamMember: ((id: number, username: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (id: number, username: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Remove a team member

          throws

          {RequiredError}

          Parameters

          • id: number

            id of the team

          • username: string

            username of the user to remove

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • orgRemoveTeamRepository: ((id: number, org: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (id: number, org: string, repo: string, options?: AxiosRequestConfig): Promise<RequestArgs>

        • This does not delete the repository, it only removes the repository from the team.

          summary

          Remove a repository from a team

          throws

          {RequiredError}

          Parameters

          • id: number

            id of the team

          • org: string

            organization that owns the repo to remove

          • repo: string

            name of the repo to remove

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • teamSearch: ((org: string, q?: string, includeDesc?: boolean, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (org: string, q?: string, includeDesc?: boolean, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Search for teams within an organization

          throws

          {RequiredError}

          Parameters

          • org: string

            name of the organization

          • Optional q: string
          • Optional includeDesc: boolean
          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

OrganizationApiFactory

  • OrganizationApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { createOrgRepo: any; createOrgRepoDeprecated: any; orgAddTeamMember: any; orgAddTeamRepository: any; orgConcealMember: any; orgCreate: any; orgCreateHook: any; orgCreateLabel: any; orgCreateTeam: any; orgDelete: any; orgDeleteHook: any; orgDeleteLabel: any; orgDeleteMember: any; orgDeleteTeam: any; orgEdit: any; orgEditHook: any; orgEditLabel: any; orgEditTeam: any; orgGet: any; orgGetAll: any; orgGetHook: any; orgGetLabel: any; orgGetTeam: any; orgGetUserPermissions: any; orgIsMember: any; orgIsPublicMember: any; orgListCurrentUserOrgs: any; orgListHooks: any; orgListLabels: any; orgListMembers: any; orgListPublicMembers: any; orgListRepos: any; orgListTeamMember: any; orgListTeamMembers: any; orgListTeamRepo: any; orgListTeamRepos: any; orgListTeams: any; orgListUserOrgs: any; orgPublicizeMember: any; orgRemoveTeamMember: any; orgRemoveTeamRepository: any; teamSearch: any }

  • OrganizationApi - factory interface

    export

    Parameters

    • Optional configuration: Configuration
    • Optional basePath: string
    • Optional axios: AxiosInstance

    Returns { createOrgRepo: any; createOrgRepoDeprecated: any; orgAddTeamMember: any; orgAddTeamRepository: any; orgConcealMember: any; orgCreate: any; orgCreateHook: any; orgCreateLabel: any; orgCreateTeam: any; orgDelete: any; orgDeleteHook: any; orgDeleteLabel: any; orgDeleteMember: any; orgDeleteTeam: any; orgEdit: any; orgEditHook: any; orgEditLabel: any; orgEditTeam: any; orgGet: any; orgGetAll: any; orgGetHook: any; orgGetLabel: any; orgGetTeam: any; orgGetUserPermissions: any; orgIsMember: any; orgIsPublicMember: any; orgListCurrentUserOrgs: any; orgListHooks: any; orgListLabels: any; orgListMembers: any; orgListPublicMembers: any; orgListRepos: any; orgListTeamMember: any; orgListTeamMembers: any; orgListTeamRepo: any; orgListTeamRepos: any; orgListTeams: any; orgListUserOrgs: any; orgPublicizeMember: any; orgRemoveTeamMember: any; orgRemoveTeamRepository: any; teamSearch: any }

    • createOrgRepo:function
      • summary

        Create a repository in an organization

        throws

        {RequiredError}

        Parameters

        • org: string

          name of organization

        • Optional body: CreateRepoOption
        • Optional options: any

        Returns AxiosPromise<Repository>

    • createOrgRepoDeprecated:function
      • summary

        Create a repository in an organization

        deprecated
        throws

        {RequiredError}

        Parameters

        • org: string

          name of organization

        • Optional body: CreateRepoOption
        • Optional options: any

        Returns AxiosPromise<Repository>

    • orgAddTeamMember:function
      • orgAddTeamMember(id: number, username: string, options?: any): AxiosPromise<void>
      • summary

        Add a team member

        throws

        {RequiredError}

        Parameters

        • id: number

          id of the team

        • username: string

          username of the user to add

        • Optional options: any

        Returns AxiosPromise<void>

    • orgAddTeamRepository:function
      • orgAddTeamRepository(id: number, org: string, repo: string, options?: any): AxiosPromise<void>
      • summary

        Add a repository to a team

        throws

        {RequiredError}

        Parameters

        • id: number

          id of the team

        • org: string

          organization that owns the repo to add

        • repo: string

          name of the repo to add

        • Optional options: any

        Returns AxiosPromise<void>

    • orgConcealMember:function
      • orgConcealMember(org: string, username: string, options?: any): AxiosPromise<void>
      • summary

        Conceal a user's membership

        throws

        {RequiredError}

        Parameters

        • org: string

          name of the organization

        • username: string

          username of the user

        • Optional options: any

        Returns AxiosPromise<void>

    • orgCreate:function
      • summary

        Create an organization

        throws

        {RequiredError}

        Parameters

        Returns AxiosPromise<Organization>

    • orgCreateHook:function
      • summary

        Create a hook

        throws

        {RequiredError}

        Parameters

        • org: string

          name of the organization

        • body: CreateHookOption
        • Optional options: any

        Returns AxiosPromise<Hook>

    • orgCreateLabel:function
      • summary

        Create a label for an organization

        throws

        {RequiredError}

        Parameters

        • org: string

          name of the organization

        • Optional body: CreateLabelOption
        • Optional options: any

        Returns AxiosPromise<Label>

    • orgCreateTeam:function
      • summary

        Create a team

        throws

        {RequiredError}

        Parameters

        • org: string

          name of the organization

        • Optional body: CreateTeamOption
        • Optional options: any

        Returns AxiosPromise<Team>

    • orgDelete:function
      • orgDelete(org: string, options?: any): AxiosPromise<void>
      • summary

        Delete an organization

        throws

        {RequiredError}

        Parameters

        • org: string

          organization that is to be deleted

        • Optional options: any

        Returns AxiosPromise<void>

    • orgDeleteHook:function
      • orgDeleteHook(org: string, id: number, options?: any): AxiosPromise<void>
      • summary

        Delete a hook

        throws

        {RequiredError}

        Parameters

        • org: string

          name of the organization

        • id: number

          id of the hook to delete

        • Optional options: any

        Returns AxiosPromise<void>

    • orgDeleteLabel:function
      • orgDeleteLabel(org: string, id: number, options?: any): AxiosPromise<void>
      • summary

        Delete a label

        throws

        {RequiredError}

        Parameters

        • org: string

          name of the organization

        • id: number

          id of the label to delete

        • Optional options: any

        Returns AxiosPromise<void>

    • orgDeleteMember:function
      • orgDeleteMember(org: string, username: string, options?: any): AxiosPromise<void>
      • summary

        Remove a member from an organization

        throws

        {RequiredError}

        Parameters

        • org: string

          name of the organization

        • username: string

          username of the user

        • Optional options: any

        Returns AxiosPromise<void>

    • orgDeleteTeam:function
      • orgDeleteTeam(id: number, options?: any): AxiosPromise<void>
      • summary

        Delete a team

        throws

        {RequiredError}

        Parameters

        • id: number

          id of the team to delete

        • Optional options: any

        Returns AxiosPromise<void>

    • orgEdit:function
      • summary

        Edit an organization

        throws

        {RequiredError}

        Parameters

        • org: string

          name of the organization to edit

        • body: EditOrgOption
        • Optional options: any

        Returns AxiosPromise<Organization>

    • orgEditHook:function
      • orgEditHook(org: string, id: number, body?: EditHookOption, options?: any): AxiosPromise<Hook>
      • summary

        Update a hook

        throws

        {RequiredError}

        Parameters

        • org: string

          name of the organization

        • id: number

          id of the hook to update

        • Optional body: EditHookOption
        • Optional options: any

        Returns AxiosPromise<Hook>

    • orgEditLabel:function
      • summary

        Update a label

        throws

        {RequiredError}

        Parameters

        • org: string

          name of the organization

        • id: number

          id of the label to edit

        • Optional body: EditLabelOption
        • Optional options: any

        Returns AxiosPromise<Label>

    • orgEditTeam:function
      • summary

        Edit a team

        throws

        {RequiredError}

        Parameters

        • id: number

          id of the team to edit

        • Optional body: EditTeamOption
        • Optional options: any

        Returns AxiosPromise<Team>

    • orgGet:function
      • orgGet(org: string, options?: any): AxiosPromise<Organization>
      • summary

        Get an organization

        throws

        {RequiredError}

        Parameters

        • org: string

          name of the organization to get

        • Optional options: any

        Returns AxiosPromise<Organization>

    • orgGetAll:function
      • orgGetAll(lang?: string, page?: number, limit?: number, options?: any): AxiosPromise<Organization[]>
      • summary

        Get list of organizations

        throws

        {RequiredError}

        Parameters

        • Optional lang: string
        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<Organization[]>

    • orgGetHook:function
      • orgGetHook(org: string, id: number, options?: any): AxiosPromise<Hook>
      • summary

        Get a hook

        throws

        {RequiredError}

        Parameters

        • org: string

          name of the organization

        • id: number

          id of the hook to get

        • Optional options: any

        Returns AxiosPromise<Hook>

    • orgGetLabel:function
      • orgGetLabel(org: string, id: number, options?: any): AxiosPromise<Label>
      • summary

        Get a single label

        throws

        {RequiredError}

        Parameters

        • org: string

          name of the organization

        • id: number

          id of the label to get

        • Optional options: any

        Returns AxiosPromise<Label>

    • orgGetTeam:function
      • orgGetTeam(id: number, options?: any): AxiosPromise<Team>
      • summary

        Get a team

        throws

        {RequiredError}

        Parameters

        • id: number

          id of the team to get

        • Optional options: any

        Returns AxiosPromise<Team>

    • orgGetUserPermissions:function
      • summary

        Get user permissions in organization

        throws

        {RequiredError}

        Parameters

        • username: string

          username of user

        • org: string

          name of the organization

        • Optional options: any

        Returns AxiosPromise<OrganizationPermissions>

    • orgIsMember:function
      • orgIsMember(org: string, username: string, options?: any): AxiosPromise<void>
      • summary

        Check if a user is a member of an organization

        throws

        {RequiredError}

        Parameters

        • org: string

          name of the organization

        • username: string

          username of the user

        • Optional options: any

        Returns AxiosPromise<void>

    • orgIsPublicMember:function
      • orgIsPublicMember(org: string, username: string, options?: any): AxiosPromise<void>
      • summary

        Check if a user is a public member of an organization

        throws

        {RequiredError}

        Parameters

        • org: string

          name of the organization

        • username: string

          username of the user

        • Optional options: any

        Returns AxiosPromise<void>

    • orgListCurrentUserOrgs:function
      • orgListCurrentUserOrgs(page?: number, limit?: number, options?: any): AxiosPromise<Organization[]>
      • summary

        List the current user's organizations

        throws

        {RequiredError}

        Parameters

        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<Organization[]>

    • orgListHooks:function
      • orgListHooks(org: string, page?: number, limit?: number, options?: any): AxiosPromise<Hook[]>
      • summary

        List an organization's webhooks

        throws

        {RequiredError}

        Parameters

        • org: string

          name of the organization

        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<Hook[]>

    • orgListLabels:function
      • orgListLabels(org: string, page?: number, limit?: number, options?: any): AxiosPromise<Label[]>
      • summary

        List an organization's labels

        throws

        {RequiredError}

        Parameters

        • org: string

          name of the organization

        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<Label[]>

    • orgListMembers:function
      • orgListMembers(org: string, page?: number, limit?: number, options?: any): AxiosPromise<User[]>
      • summary

        List an organization's members

        throws

        {RequiredError}

        Parameters

        • org: string

          name of the organization

        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<User[]>

    • orgListPublicMembers:function
      • orgListPublicMembers(org: string, page?: number, limit?: number, options?: any): AxiosPromise<User[]>
      • summary

        List an organization's public members

        throws

        {RequiredError}

        Parameters

        • org: string

          name of the organization

        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<User[]>

    • orgListRepos:function
      • orgListRepos(org: string, page?: number, limit?: number, options?: any): AxiosPromise<Repository[]>
      • summary

        List an organization's repos

        throws

        {RequiredError}

        Parameters

        • org: string

          name of the organization

        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<Repository[]>

    • orgListTeamMember:function
      • orgListTeamMember(id: number, username: string, options?: any): AxiosPromise<User>
      • summary

        List a particular member of team

        throws

        {RequiredError}

        Parameters

        • id: number

          id of the team

        • username: string

          username of the member to list

        • Optional options: any

        Returns AxiosPromise<User>

    • orgListTeamMembers:function
      • orgListTeamMembers(id: number, page?: number, limit?: number, options?: any): AxiosPromise<User[]>
      • summary

        List a team's members

        throws

        {RequiredError}

        Parameters

        • id: number

          id of the team

        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<User[]>

    • orgListTeamRepo:function
      • orgListTeamRepo(id: number, org: string, repo: string, options?: any): AxiosPromise<Repository>
      • summary

        List a particular repo of team

        throws

        {RequiredError}

        Parameters

        • id: number

          id of the team

        • org: string

          organization that owns the repo to list

        • repo: string

          name of the repo to list

        • Optional options: any

        Returns AxiosPromise<Repository>

    • orgListTeamRepos:function
      • orgListTeamRepos(id: number, page?: number, limit?: number, options?: any): AxiosPromise<Repository[]>
      • summary

        List a team's repos

        throws

        {RequiredError}

        Parameters

        • id: number

          id of the team

        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<Repository[]>

    • orgListTeams:function
      • orgListTeams(org: string, page?: number, limit?: number, options?: any): AxiosPromise<Team[]>
      • summary

        List an organization's teams

        throws

        {RequiredError}

        Parameters

        • org: string

          name of the organization

        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<Team[]>

    • orgListUserOrgs:function
      • orgListUserOrgs(username: string, page?: number, limit?: number, options?: any): AxiosPromise<Organization[]>
      • summary

        List a user's organizations

        throws

        {RequiredError}

        Parameters

        • username: string

          username of user

        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<Organization[]>

    • orgPublicizeMember:function
      • orgPublicizeMember(org: string, username: string, options?: any): AxiosPromise<void>
      • summary

        Publicize a user's membership

        throws

        {RequiredError}

        Parameters

        • org: string

          name of the organization

        • username: string

          username of the user

        • Optional options: any

        Returns AxiosPromise<void>

    • orgRemoveTeamMember:function
      • orgRemoveTeamMember(id: number, username: string, options?: any): AxiosPromise<void>
      • summary

        Remove a team member

        throws

        {RequiredError}

        Parameters

        • id: number

          id of the team

        • username: string

          username of the user to remove

        • Optional options: any

        Returns AxiosPromise<void>

    • orgRemoveTeamRepository:function
      • orgRemoveTeamRepository(id: number, org: string, repo: string, options?: any): AxiosPromise<void>

      • This does not delete the repository, it only removes the repository from the team.

        summary

        Remove a repository from a team

        throws

        {RequiredError}

        Parameters

        • id: number

          id of the team

        • org: string

          organization that owns the repo to remove

        • repo: string

          name of the repo to remove

        • Optional options: any

        Returns AxiosPromise<void>

    • teamSearch:function
      • teamSearch(org: string, q?: string, includeDesc?: boolean, page?: number, limit?: number, options?: any): AxiosPromise<TeamSearch200Response>
      • summary

        Search for teams within an organization

        throws

        {RequiredError}

        Parameters

        • org: string

          name of the organization

        • Optional q: string
        • Optional includeDesc: boolean
        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<TeamSearch200Response>

OrganizationApiFp

  • OrganizationApiFp(configuration?: Configuration): { createOrgRepo: any; createOrgRepoDeprecated: any; orgAddTeamMember: any; orgAddTeamRepository: any; orgConcealMember: any; orgCreate: any; orgCreateHook: any; orgCreateLabel: any; orgCreateTeam: any; orgDelete: any; orgDeleteHook: any; orgDeleteLabel: any; orgDeleteMember: any; orgDeleteTeam: any; orgEdit: any; orgEditHook: any; orgEditLabel: any; orgEditTeam: any; orgGet: any; orgGetAll: any; orgGetHook: any; orgGetLabel: any; orgGetTeam: any; orgGetUserPermissions: any; orgIsMember: any; orgIsPublicMember: any; orgListCurrentUserOrgs: any; orgListHooks: any; orgListLabels: any; orgListMembers: any; orgListPublicMembers: any; orgListRepos: any; orgListTeamMember: any; orgListTeamMembers: any; orgListTeamRepo: any; orgListTeamRepos: any; orgListTeams: any; orgListUserOrgs: any; orgPublicizeMember: any; orgRemoveTeamMember: any; orgRemoveTeamRepository: any; teamSearch: any }

  • OrganizationApi - functional programming interface

    export

    Parameters

    Returns { createOrgRepo: any; createOrgRepoDeprecated: any; orgAddTeamMember: any; orgAddTeamRepository: any; orgConcealMember: any; orgCreate: any; orgCreateHook: any; orgCreateLabel: any; orgCreateTeam: any; orgDelete: any; orgDeleteHook: any; orgDeleteLabel: any; orgDeleteMember: any; orgDeleteTeam: any; orgEdit: any; orgEditHook: any; orgEditLabel: any; orgEditTeam: any; orgGet: any; orgGetAll: any; orgGetHook: any; orgGetLabel: any; orgGetTeam: any; orgGetUserPermissions: any; orgIsMember: any; orgIsPublicMember: any; orgListCurrentUserOrgs: any; orgListHooks: any; orgListLabels: any; orgListMembers: any; orgListPublicMembers: any; orgListRepos: any; orgListTeamMember: any; orgListTeamMembers: any; orgListTeamRepo: any; orgListTeamRepos: any; orgListTeams: any; orgListUserOrgs: any; orgPublicizeMember: any; orgRemoveTeamMember: any; orgRemoveTeamRepository: any; teamSearch: any }

    • createOrgRepo:function
      • createOrgRepo(org: string, body?: CreateRepoOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository>)>
      • summary

        Create a repository in an organization

        throws

        {RequiredError}

        Parameters

        • org: string

          name of organization

        • Optional body: CreateRepoOption
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository>)>

    • createOrgRepoDeprecated:function
      • createOrgRepoDeprecated(org: string, body?: CreateRepoOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository>)>
      • summary

        Create a repository in an organization

        deprecated
        throws

        {RequiredError}

        Parameters

        • org: string

          name of organization

        • Optional body: CreateRepoOption
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository>)>

    • orgAddTeamMember:function
      • orgAddTeamMember(id: number, username: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Add a team member

        throws

        {RequiredError}

        Parameters

        • id: number

          id of the team

        • username: string

          username of the user to add

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • orgAddTeamRepository:function
      • orgAddTeamRepository(id: number, org: string, repo: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Add a repository to a team

        throws

        {RequiredError}

        Parameters

        • id: number

          id of the team

        • org: string

          organization that owns the repo to add

        • repo: string

          name of the repo to add

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • orgConcealMember:function
      • orgConcealMember(org: string, username: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Conceal a user's membership

        throws

        {RequiredError}

        Parameters

        • org: string

          name of the organization

        • username: string

          username of the user

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • orgCreate:function
      • orgCreate(organization: CreateOrgOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Organization>)>
      • summary

        Create an organization

        throws

        {RequiredError}

        Parameters

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Organization>)>

    • orgCreateHook:function
      • orgCreateHook(org: string, body: CreateHookOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Hook>)>
      • summary

        Create a hook

        throws

        {RequiredError}

        Parameters

        • org: string

          name of the organization

        • body: CreateHookOption
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Hook>)>

    • orgCreateLabel:function
      • orgCreateLabel(org: string, body?: CreateLabelOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Label>)>
      • summary

        Create a label for an organization

        throws

        {RequiredError}

        Parameters

        • org: string

          name of the organization

        • Optional body: CreateLabelOption
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Label>)>

    • orgCreateTeam:function
      • orgCreateTeam(org: string, body?: CreateTeamOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Team>)>
      • summary

        Create a team

        throws

        {RequiredError}

        Parameters

        • org: string

          name of the organization

        • Optional body: CreateTeamOption
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Team>)>

    • orgDelete:function
      • orgDelete(org: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Delete an organization

        throws

        {RequiredError}

        Parameters

        • org: string

          organization that is to be deleted

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • orgDeleteHook:function
      • orgDeleteHook(org: string, id: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Delete a hook

        throws

        {RequiredError}

        Parameters

        • org: string

          name of the organization

        • id: number

          id of the hook to delete

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • orgDeleteLabel:function
      • orgDeleteLabel(org: string, id: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Delete a label

        throws

        {RequiredError}

        Parameters

        • org: string

          name of the organization

        • id: number

          id of the label to delete

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • orgDeleteMember:function
      • orgDeleteMember(org: string, username: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Remove a member from an organization

        throws

        {RequiredError}

        Parameters

        • org: string

          name of the organization

        • username: string

          username of the user

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • orgDeleteTeam:function
      • orgDeleteTeam(id: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Delete a team

        throws

        {RequiredError}

        Parameters

        • id: number

          id of the team to delete

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • orgEdit:function
      • orgEdit(org: string, body: EditOrgOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Organization>)>
      • summary

        Edit an organization

        throws

        {RequiredError}

        Parameters

        • org: string

          name of the organization to edit

        • body: EditOrgOption
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Organization>)>

    • orgEditHook:function
      • orgEditHook(org: string, id: number, body?: EditHookOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Hook>)>
      • summary

        Update a hook

        throws

        {RequiredError}

        Parameters

        • org: string

          name of the organization

        • id: number

          id of the hook to update

        • Optional body: EditHookOption
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Hook>)>

    • orgEditLabel:function
      • orgEditLabel(org: string, id: number, body?: EditLabelOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Label>)>
      • summary

        Update a label

        throws

        {RequiredError}

        Parameters

        • org: string

          name of the organization

        • id: number

          id of the label to edit

        • Optional body: EditLabelOption
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Label>)>

    • orgEditTeam:function
      • orgEditTeam(id: number, body?: EditTeamOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Team>)>
      • summary

        Edit a team

        throws

        {RequiredError}

        Parameters

        • id: number

          id of the team to edit

        • Optional body: EditTeamOption
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Team>)>

    • orgGet:function
      • orgGet(org: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Organization>)>
      • summary

        Get an organization

        throws

        {RequiredError}

        Parameters

        • org: string

          name of the organization to get

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Organization>)>

    • orgGetAll:function
      • orgGetAll(lang?: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Organization[]>)>
      • summary

        Get list of organizations

        throws

        {RequiredError}

        Parameters

        • Optional lang: string
        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Organization[]>)>

    • orgGetHook:function
      • orgGetHook(org: string, id: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Hook>)>
      • summary

        Get a hook

        throws

        {RequiredError}

        Parameters

        • org: string

          name of the organization

        • id: number

          id of the hook to get

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Hook>)>

    • orgGetLabel:function
      • orgGetLabel(org: string, id: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Label>)>
      • summary

        Get a single label

        throws

        {RequiredError}

        Parameters

        • org: string

          name of the organization

        • id: number

          id of the label to get

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Label>)>

    • orgGetTeam:function
      • orgGetTeam(id: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Team>)>
      • summary

        Get a team

        throws

        {RequiredError}

        Parameters

        • id: number

          id of the team to get

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Team>)>

    • orgGetUserPermissions:function
      • orgGetUserPermissions(username: string, org: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrganizationPermissions>)>
      • summary

        Get user permissions in organization

        throws

        {RequiredError}

        Parameters

        • username: string

          username of user

        • org: string

          name of the organization

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrganizationPermissions>)>

    • orgIsMember:function
      • orgIsMember(org: string, username: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Check if a user is a member of an organization

        throws

        {RequiredError}

        Parameters

        • org: string

          name of the organization

        • username: string

          username of the user

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • orgIsPublicMember:function
      • orgIsPublicMember(org: string, username: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Check if a user is a public member of an organization

        throws

        {RequiredError}

        Parameters

        • org: string

          name of the organization

        • username: string

          username of the user

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • orgListCurrentUserOrgs:function
      • orgListCurrentUserOrgs(page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Organization[]>)>
      • summary

        List the current user's organizations

        throws

        {RequiredError}

        Parameters

        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Organization[]>)>

    • orgListHooks:function
      • orgListHooks(org: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Hook[]>)>
      • summary

        List an organization's webhooks

        throws

        {RequiredError}

        Parameters

        • org: string

          name of the organization

        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Hook[]>)>

    • orgListLabels:function
      • orgListLabels(org: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Label[]>)>
      • summary

        List an organization's labels

        throws

        {RequiredError}

        Parameters

        • org: string

          name of the organization

        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Label[]>)>

    • orgListMembers:function
      • orgListMembers(org: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<User[]>)>
      • summary

        List an organization's members

        throws

        {RequiredError}

        Parameters

        • org: string

          name of the organization

        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<User[]>)>

    • orgListPublicMembers:function
      • orgListPublicMembers(org: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<User[]>)>
      • summary

        List an organization's public members

        throws

        {RequiredError}

        Parameters

        • org: string

          name of the organization

        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<User[]>)>

    • orgListRepos:function
      • orgListRepos(org: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository[]>)>
      • summary

        List an organization's repos

        throws

        {RequiredError}

        Parameters

        • org: string

          name of the organization

        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository[]>)>

    • orgListTeamMember:function
      • orgListTeamMember(id: number, username: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<User>)>
      • summary

        List a particular member of team

        throws

        {RequiredError}

        Parameters

        • id: number

          id of the team

        • username: string

          username of the member to list

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<User>)>

    • orgListTeamMembers:function
      • orgListTeamMembers(id: number, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<User[]>)>
      • summary

        List a team's members

        throws

        {RequiredError}

        Parameters

        • id: number

          id of the team

        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<User[]>)>

    • orgListTeamRepo:function
      • orgListTeamRepo(id: number, org: string, repo: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository>)>
      • summary

        List a particular repo of team

        throws

        {RequiredError}

        Parameters

        • id: number

          id of the team

        • org: string

          organization that owns the repo to list

        • repo: string

          name of the repo to list

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository>)>

    • orgListTeamRepos:function
      • orgListTeamRepos(id: number, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository[]>)>
      • summary

        List a team's repos

        throws

        {RequiredError}

        Parameters

        • id: number

          id of the team

        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository[]>)>

    • orgListTeams:function
      • orgListTeams(org: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Team[]>)>
      • summary

        List an organization's teams

        throws

        {RequiredError}

        Parameters

        • org: string

          name of the organization

        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Team[]>)>

    • orgListUserOrgs:function
      • orgListUserOrgs(username: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Organization[]>)>
      • summary

        List a user's organizations

        throws

        {RequiredError}

        Parameters

        • username: string

          username of user

        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Organization[]>)>

    • orgPublicizeMember:function
      • orgPublicizeMember(org: string, username: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Publicize a user's membership

        throws

        {RequiredError}

        Parameters

        • org: string

          name of the organization

        • username: string

          username of the user

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • orgRemoveTeamMember:function
      • orgRemoveTeamMember(id: number, username: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Remove a team member

        throws

        {RequiredError}

        Parameters

        • id: number

          id of the team

        • username: string

          username of the user to remove

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • orgRemoveTeamRepository:function
      • orgRemoveTeamRepository(id: number, org: string, repo: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

      • This does not delete the repository, it only removes the repository from the team.

        summary

        Remove a repository from a team

        throws

        {RequiredError}

        Parameters

        • id: number

          id of the team

        • org: string

          organization that owns the repo to remove

        • repo: string

          name of the repo to remove

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • teamSearch:function
      • teamSearch(org: string, q?: string, includeDesc?: boolean, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<TeamSearch200Response>)>
      • summary

        Search for teams within an organization

        throws

        {RequiredError}

        Parameters

        • org: string

          name of the organization

        • Optional q: string
        • Optional includeDesc: boolean
        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<TeamSearch200Response>)>

PackageApiAxiosParamCreator

  • PackageApiAxiosParamCreator(configuration?: Configuration): { deletePackage: ((owner: string, type: string, name: string, version: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); getPackage: ((owner: string, type: string, name: string, version: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); listPackageFiles: ((owner: string, type: string, name: string, version: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); listPackages: ((owner: string, page?: number, limit?: number, type?: "composer" | "conan" | "container" | "generic" | "helm" | "maven" | "npm" | "nuget" | "pypi" | "rubygems", q?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>) }

  • PackageApi - axios parameter creator

    export

    Parameters

    Returns { deletePackage: ((owner: string, type: string, name: string, version: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); getPackage: ((owner: string, type: string, name: string, version: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); listPackageFiles: ((owner: string, type: string, name: string, version: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); listPackages: ((owner: string, page?: number, limit?: number, type?: "composer" | "conan" | "container" | "generic" | "helm" | "maven" | "npm" | "nuget" | "pypi" | "rubygems", q?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>) }

    • deletePackage: ((owner: string, type: string, name: string, version: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, type: string, name: string, version: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Delete a package

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the package

          • type: string

            type of the package

          • name: string

            name of the package

          • version: string

            version of the package

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • getPackage: ((owner: string, type: string, name: string, version: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, type: string, name: string, version: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Gets a package

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the package

          • type: string

            type of the package

          • name: string

            name of the package

          • version: string

            version of the package

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • listPackageFiles: ((owner: string, type: string, name: string, version: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, type: string, name: string, version: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Gets all files of a package

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the package

          • type: string

            type of the package

          • name: string

            name of the package

          • version: string

            version of the package

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • listPackages: ((owner: string, page?: number, limit?: number, type?: "composer" | "conan" | "container" | "generic" | "helm" | "maven" | "npm" | "nuget" | "pypi" | "rubygems", q?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, page?: number, limit?: number, type?: "composer" | "conan" | "container" | "generic" | "helm" | "maven" | "npm" | "nuget" | "pypi" | "rubygems", q?: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Gets all packages of an owner

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the packages

          • Optional page: number
          • Optional limit: number
          • Optional type: "composer" | "conan" | "container" | "generic" | "helm" | "maven" | "npm" | "nuget" | "pypi" | "rubygems"
          • Optional q: string
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

PackageApiFactory

  • PackageApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { deletePackage: any; getPackage: any; listPackageFiles: any; listPackages: any }

  • PackageApi - factory interface

    export

    Parameters

    • Optional configuration: Configuration
    • Optional basePath: string
    • Optional axios: AxiosInstance

    Returns { deletePackage: any; getPackage: any; listPackageFiles: any; listPackages: any }

    • deletePackage:function
      • deletePackage(owner: string, type: string, name: string, version: string, options?: any): AxiosPromise<void>
      • summary

        Delete a package

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the package

        • type: string

          type of the package

        • name: string

          name of the package

        • version: string

          version of the package

        • Optional options: any

        Returns AxiosPromise<void>

    • getPackage:function
      • getPackage(owner: string, type: string, name: string, version: string, options?: any): AxiosPromise<Package>
      • summary

        Gets a package

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the package

        • type: string

          type of the package

        • name: string

          name of the package

        • version: string

          version of the package

        • Optional options: any

        Returns AxiosPromise<Package>

    • listPackageFiles:function
      • listPackageFiles(owner: string, type: string, name: string, version: string, options?: any): AxiosPromise<PackageFile[]>
      • summary

        Gets all files of a package

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the package

        • type: string

          type of the package

        • name: string

          name of the package

        • version: string

          version of the package

        • Optional options: any

        Returns AxiosPromise<PackageFile[]>

    • listPackages:function
      • listPackages(owner: string, page?: number, limit?: number, type?: "composer" | "conan" | "container" | "generic" | "helm" | "maven" | "npm" | "nuget" | "pypi" | "rubygems", q?: string, options?: any): AxiosPromise<Package[]>
      • summary

        Gets all packages of an owner

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the packages

        • Optional page: number
        • Optional limit: number
        • Optional type: "composer" | "conan" | "container" | "generic" | "helm" | "maven" | "npm" | "nuget" | "pypi" | "rubygems"
        • Optional q: string
        • Optional options: any

        Returns AxiosPromise<Package[]>

PackageApiFp

  • PackageApiFp(configuration?: Configuration): { deletePackage: any; getPackage: any; listPackageFiles: any; listPackages: any }

  • PackageApi - functional programming interface

    export

    Parameters

    Returns { deletePackage: any; getPackage: any; listPackageFiles: any; listPackages: any }

    • deletePackage:function
      • deletePackage(owner: string, type: string, name: string, version: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Delete a package

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the package

        • type: string

          type of the package

        • name: string

          name of the package

        • version: string

          version of the package

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • getPackage:function
      • getPackage(owner: string, type: string, name: string, version: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Package>)>
      • summary

        Gets a package

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the package

        • type: string

          type of the package

        • name: string

          name of the package

        • version: string

          version of the package

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Package>)>

    • listPackageFiles:function
      • listPackageFiles(owner: string, type: string, name: string, version: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PackageFile[]>)>
      • summary

        Gets all files of a package

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the package

        • type: string

          type of the package

        • name: string

          name of the package

        • version: string

          version of the package

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PackageFile[]>)>

    • listPackages:function
      • listPackages(owner: string, page?: number, limit?: number, type?: "composer" | "conan" | "container" | "generic" | "helm" | "maven" | "npm" | "nuget" | "pypi" | "rubygems", q?: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Package[]>)>
      • summary

        Gets all packages of an owner

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the packages

        • Optional page: number
        • Optional limit: number
        • Optional type: "composer" | "conan" | "container" | "generic" | "helm" | "maven" | "npm" | "nuget" | "pypi" | "rubygems"
        • Optional q: string
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Package[]>)>

RepositoryApiAxiosParamCreator

  • RepositoryApiAxiosParamCreator(configuration?: Configuration): { acceptRepoTransfer: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); createCurrentUserRepo: ((body?: CreateRepoOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); createFork: ((owner: string, repo: string, body?: CreateForkOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); generateRepo: ((templateOwner: string, templateRepo: string, body?: GenerateRepoOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); getAnnotatedTag: ((owner: string, repo: string, sha: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); getBlob: ((owner: string, repo: string, sha: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); getTree: ((owner: string, repo: string, sha: string, recursive?: boolean, page?: number, perPage?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); listForks: ((owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); rejectRepoTransfer: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoAddCollaborator: ((owner: string, repo: string, collaborator: string, body?: AddCollaboratorOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoAddTeam: ((owner: string, repo: string, team: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoAddTopic: ((owner: string, repo: string, topic: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoApplyDiffPatch: ((owner: string, repo: string, body: UpdateFileOptions, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoCancelScheduledAutoMerge: ((owner: string, repo: string, index: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoCheckCollaborator: ((owner: string, repo: string, collaborator: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoCheckTeam: ((owner: string, repo: string, team: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoCreateBranch: ((owner: string, repo: string, body?: CreateBranchRepoOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoCreateBranchProtection: ((owner: string, repo: string, body?: CreateBranchProtectionOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoCreateFile: ((owner: string, repo: string, filepath: string, body: CreateFileOptions, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoCreateGitRef: ((owner: string, repo: string, body?: CreateGitRefOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoCreateHook: ((owner: string, repo: string, body?: CreateHookOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoCreateKey: ((owner: string, repo: string, body?: CreateKeyOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoCreatePullRequest: ((owner: string, repo: string, body?: CreatePullRequestOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoCreatePullReview: ((owner: string, repo: string, index: number, body: CreatePullReviewOptions, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoCreatePullReviewRequests: ((owner: string, repo: string, index: number, body: PullReviewRequestOptions, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoCreateRelease: ((owner: string, repo: string, body?: CreateReleaseOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoCreateReleaseAttachment: ((owner: string, repo: string, id: number, attachment: File, name?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoCreateStatus: ((owner: string, repo: string, sha: string, body?: CreateStatusOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoCreateTag: ((owner: string, repo: string, body?: CreateTagOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoCreateWikiPage: ((owner: string, repo: string, body?: CreateWikiPageOptions, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoDelete: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoDeleteBranch: ((owner: string, repo: string, branch: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoDeleteBranchProtection: ((owner: string, repo: string, name: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoDeleteCollaborator: ((owner: string, repo: string, collaborator: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoDeleteFile: ((owner: string, repo: string, filepath: string, body: DeleteFileOptions, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoDeleteGitHook: ((owner: string, repo: string, id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoDeleteGitRef: ((owner: string, repo: string, ref: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoDeleteHook: ((owner: string, repo: string, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoDeleteKey: ((owner: string, repo: string, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoDeletePullReview: ((owner: string, repo: string, index: number, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoDeletePullReviewRequests: ((owner: string, repo: string, index: number, body: PullReviewRequestOptions, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoDeleteRelease: ((owner: string, repo: string, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoDeleteReleaseAttachment: ((owner: string, repo: string, id: number, attachmentId: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoDeleteReleaseByTag: ((owner: string, repo: string, tag: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoDeleteTag: ((owner: string, repo: string, tag: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoDeleteTeam: ((owner: string, repo: string, team: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoDeleteTopic: ((owner: string, repo: string, topic: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoDeleteWikiPage: ((owner: string, repo: string, pageName: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoDismissPullReview: ((owner: string, repo: string, index: number, id: number, body: DismissPullReviewOptions, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoDownloadCommitDiffOrPatch: ((owner: string, repo: string, sha: string, diffType: "patch" | "diff", options?: AxiosRequestConfig) => Promise<RequestArgs>); repoDownloadPullDiffOrPatch: ((owner: string, repo: string, index: number, diffType: "patch" | "diff", binary?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoEdit: ((owner: string, repo: string, body?: EditRepoOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoEditBranchProtection: ((owner: string, repo: string, name: string, body?: EditBranchProtectionOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoEditGitHook: ((owner: string, repo: string, id: string, body?: EditGitHookOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoEditHook: ((owner: string, repo: string, id: number, body?: EditHookOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoEditPullRequest: ((owner: string, repo: string, index: number, body?: EditPullRequestOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoEditRelease: ((owner: string, repo: string, id: number, body?: EditReleaseOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoEditReleaseAttachment: ((owner: string, repo: string, id: number, attachmentId: number, body?: EditAttachmentOptions, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoEditWikiPage: ((owner: string, repo: string, pageName: string, body?: CreateWikiPageOptions, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGet: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetAllCommits: ((owner: string, repo: string, sha?: string, path?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetArchive: ((owner: string, repo: string, archive: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetAssignees: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetBranch: ((owner: string, repo: string, branch: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetBranchProtection: ((owner: string, repo: string, name: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetByID: ((id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetCombinedStatusByRef: ((owner: string, repo: string, ref: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetContents: ((owner: string, repo: string, filepath: string, ref?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetContentsList: ((owner: string, repo: string, ref?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetEditorConfig: ((owner: string, repo: string, filepath: string, ref?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetGitHook: ((owner: string, repo: string, id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetHook: ((owner: string, repo: string, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetIssueTemplates: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetKey: ((owner: string, repo: string, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetLanguages: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetNote: ((owner: string, repo: string, sha: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetPullRequest: ((owner: string, repo: string, index: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetPullRequestCommits: ((owner: string, repo: string, index: number, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetPullReview: ((owner: string, repo: string, index: number, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetPullReviewComments: ((owner: string, repo: string, index: number, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetRawFile: ((owner: string, repo: string, filepath: string, ref?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetRawFileOrLFS: ((owner: string, repo: string, filepath: string, ref?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetRelease: ((owner: string, repo: string, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetReleaseAttachment: ((owner: string, repo: string, id: number, attachmentId: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetReleaseByTag: ((owner: string, repo: string, tag: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetRepoPermissions: ((owner: string, repo: string, collaborator: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetReviewers: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetSingleCommit: ((owner: string, repo: string, sha: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetTag: ((owner: string, repo: string, tag: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetWikiPage: ((owner: string, repo: string, pageName: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetWikiPageRevisions: ((owner: string, repo: string, pageName: string, page?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetWikiPages: ((owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoListAllGitRefs: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoListBranchProtection: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoListBranches: ((owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoListCollaborators: ((owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoListGitHooks: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoListGitRefs: ((owner: string, repo: string, ref: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoListHooks: ((owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoListKeys: ((owner: string, repo: string, keyId?: number, fingerprint?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoListPullRequests: ((owner: string, repo: string, state?: "all" | "closed" | "open", sort?: "priority" | "oldest" | "recentupdate" | "leastupdate" | "mostcomment" | "leastcomment", milestone?: number, labels?: number[], page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoListPullReviews: ((owner: string, repo: string, index: number, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoListReleaseAttachments: ((owner: string, repo: string, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoListReleases: ((owner: string, repo: string, draft?: boolean, preRelease?: boolean, perPage?: number, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoListStargazers: ((owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoListStatuses: ((owner: string, repo: string, sha: string, sort?: "oldest" | "recentupdate" | "leastupdate" | "leastindex" | "highestindex", state?: "error" | "pending" | "success" | "failure" | "warning", page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoListStatusesByRef: ((owner: string, repo: string, ref: string, sort?: "oldest" | "recentupdate" | "leastupdate" | "leastindex" | "highestindex", state?: "error" | "pending" | "success" | "failure" | "warning", page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoListSubscribers: ((owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoListTags: ((owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoListTeams: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoListTopics: ((owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoMergePullRequest: ((owner: string, repo: string, index: number, body?: MergePullRequestOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoMigrate: ((body?: MigrateRepoOptions, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoMirrorSync: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoPullRequestIsMerged: ((owner: string, repo: string, index: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoSearch: ((q?: string, topic?: boolean, includeDesc?: boolean, uid?: number, priorityOwnerId?: number, teamId?: number, starredBy?: number, _private?: boolean, isPrivate?: boolean, template?: boolean, archived?: boolean, mode?: string, exclusive?: boolean, repo?: string, owner?: string, lang?: string, subject?: string, book?: string, includeMetadata?: boolean, sort?: string, order?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoSigningKey: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoSubmitPullReview: ((owner: string, repo: string, index: number, id: number, body: SubmitPullReviewOptions, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoTestHook: ((owner: string, repo: string, id: number, ref?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoTrackedTimes: ((owner: string, repo: string, user?: string, since?: string, before?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoTransfer: ((owner: string, repo: string, body: TransferRepoOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoUnDismissPullReview: ((owner: string, repo: string, index: number, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoUpdateFile: ((owner: string, repo: string, filepath: string, body: UpdateFileOptions, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoUpdateGitRef: ((owner: string, repo: string, ref: string, body?: UpdateGitRefOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoUpdatePullRequest: ((owner: string, repo: string, index: number, style?: "merge" | "rebase", options?: AxiosRequestConfig) => Promise<RequestArgs>); repoUpdateTopics: ((owner: string, repo: string, body?: RepoTopicOptions, options?: AxiosRequestConfig) => Promise<RequestArgs>); topicSearch: ((q: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); userCurrentCheckSubscription: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); userCurrentDeleteSubscription: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); userCurrentPutSubscription: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); userTrackedTimes: ((owner: string, repo: string, user: string, options?: AxiosRequestConfig) => Promise<RequestArgs>) }

  • RepositoryApi - axios parameter creator

    export

    Parameters

    Returns { acceptRepoTransfer: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); createCurrentUserRepo: ((body?: CreateRepoOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); createFork: ((owner: string, repo: string, body?: CreateForkOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); generateRepo: ((templateOwner: string, templateRepo: string, body?: GenerateRepoOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); getAnnotatedTag: ((owner: string, repo: string, sha: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); getBlob: ((owner: string, repo: string, sha: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); getTree: ((owner: string, repo: string, sha: string, recursive?: boolean, page?: number, perPage?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); listForks: ((owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); rejectRepoTransfer: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoAddCollaborator: ((owner: string, repo: string, collaborator: string, body?: AddCollaboratorOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoAddTeam: ((owner: string, repo: string, team: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoAddTopic: ((owner: string, repo: string, topic: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoApplyDiffPatch: ((owner: string, repo: string, body: UpdateFileOptions, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoCancelScheduledAutoMerge: ((owner: string, repo: string, index: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoCheckCollaborator: ((owner: string, repo: string, collaborator: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoCheckTeam: ((owner: string, repo: string, team: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoCreateBranch: ((owner: string, repo: string, body?: CreateBranchRepoOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoCreateBranchProtection: ((owner: string, repo: string, body?: CreateBranchProtectionOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoCreateFile: ((owner: string, repo: string, filepath: string, body: CreateFileOptions, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoCreateGitRef: ((owner: string, repo: string, body?: CreateGitRefOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoCreateHook: ((owner: string, repo: string, body?: CreateHookOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoCreateKey: ((owner: string, repo: string, body?: CreateKeyOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoCreatePullRequest: ((owner: string, repo: string, body?: CreatePullRequestOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoCreatePullReview: ((owner: string, repo: string, index: number, body: CreatePullReviewOptions, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoCreatePullReviewRequests: ((owner: string, repo: string, index: number, body: PullReviewRequestOptions, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoCreateRelease: ((owner: string, repo: string, body?: CreateReleaseOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoCreateReleaseAttachment: ((owner: string, repo: string, id: number, attachment: File, name?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoCreateStatus: ((owner: string, repo: string, sha: string, body?: CreateStatusOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoCreateTag: ((owner: string, repo: string, body?: CreateTagOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoCreateWikiPage: ((owner: string, repo: string, body?: CreateWikiPageOptions, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoDelete: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoDeleteBranch: ((owner: string, repo: string, branch: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoDeleteBranchProtection: ((owner: string, repo: string, name: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoDeleteCollaborator: ((owner: string, repo: string, collaborator: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoDeleteFile: ((owner: string, repo: string, filepath: string, body: DeleteFileOptions, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoDeleteGitHook: ((owner: string, repo: string, id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoDeleteGitRef: ((owner: string, repo: string, ref: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoDeleteHook: ((owner: string, repo: string, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoDeleteKey: ((owner: string, repo: string, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoDeletePullReview: ((owner: string, repo: string, index: number, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoDeletePullReviewRequests: ((owner: string, repo: string, index: number, body: PullReviewRequestOptions, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoDeleteRelease: ((owner: string, repo: string, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoDeleteReleaseAttachment: ((owner: string, repo: string, id: number, attachmentId: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoDeleteReleaseByTag: ((owner: string, repo: string, tag: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoDeleteTag: ((owner: string, repo: string, tag: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoDeleteTeam: ((owner: string, repo: string, team: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoDeleteTopic: ((owner: string, repo: string, topic: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoDeleteWikiPage: ((owner: string, repo: string, pageName: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoDismissPullReview: ((owner: string, repo: string, index: number, id: number, body: DismissPullReviewOptions, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoDownloadCommitDiffOrPatch: ((owner: string, repo: string, sha: string, diffType: "patch" | "diff", options?: AxiosRequestConfig) => Promise<RequestArgs>); repoDownloadPullDiffOrPatch: ((owner: string, repo: string, index: number, diffType: "patch" | "diff", binary?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoEdit: ((owner: string, repo: string, body?: EditRepoOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoEditBranchProtection: ((owner: string, repo: string, name: string, body?: EditBranchProtectionOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoEditGitHook: ((owner: string, repo: string, id: string, body?: EditGitHookOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoEditHook: ((owner: string, repo: string, id: number, body?: EditHookOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoEditPullRequest: ((owner: string, repo: string, index: number, body?: EditPullRequestOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoEditRelease: ((owner: string, repo: string, id: number, body?: EditReleaseOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoEditReleaseAttachment: ((owner: string, repo: string, id: number, attachmentId: number, body?: EditAttachmentOptions, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoEditWikiPage: ((owner: string, repo: string, pageName: string, body?: CreateWikiPageOptions, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGet: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetAllCommits: ((owner: string, repo: string, sha?: string, path?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetArchive: ((owner: string, repo: string, archive: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetAssignees: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetBranch: ((owner: string, repo: string, branch: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetBranchProtection: ((owner: string, repo: string, name: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetByID: ((id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetCombinedStatusByRef: ((owner: string, repo: string, ref: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetContents: ((owner: string, repo: string, filepath: string, ref?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetContentsList: ((owner: string, repo: string, ref?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetEditorConfig: ((owner: string, repo: string, filepath: string, ref?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetGitHook: ((owner: string, repo: string, id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetHook: ((owner: string, repo: string, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetIssueTemplates: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetKey: ((owner: string, repo: string, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetLanguages: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetNote: ((owner: string, repo: string, sha: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetPullRequest: ((owner: string, repo: string, index: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetPullRequestCommits: ((owner: string, repo: string, index: number, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetPullReview: ((owner: string, repo: string, index: number, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetPullReviewComments: ((owner: string, repo: string, index: number, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetRawFile: ((owner: string, repo: string, filepath: string, ref?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetRawFileOrLFS: ((owner: string, repo: string, filepath: string, ref?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetRelease: ((owner: string, repo: string, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetReleaseAttachment: ((owner: string, repo: string, id: number, attachmentId: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetReleaseByTag: ((owner: string, repo: string, tag: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetRepoPermissions: ((owner: string, repo: string, collaborator: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetReviewers: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetSingleCommit: ((owner: string, repo: string, sha: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetTag: ((owner: string, repo: string, tag: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetWikiPage: ((owner: string, repo: string, pageName: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetWikiPageRevisions: ((owner: string, repo: string, pageName: string, page?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoGetWikiPages: ((owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoListAllGitRefs: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoListBranchProtection: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoListBranches: ((owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoListCollaborators: ((owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoListGitHooks: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoListGitRefs: ((owner: string, repo: string, ref: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoListHooks: ((owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoListKeys: ((owner: string, repo: string, keyId?: number, fingerprint?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoListPullRequests: ((owner: string, repo: string, state?: "all" | "closed" | "open", sort?: "priority" | "oldest" | "recentupdate" | "leastupdate" | "mostcomment" | "leastcomment", milestone?: number, labels?: number[], page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoListPullReviews: ((owner: string, repo: string, index: number, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoListReleaseAttachments: ((owner: string, repo: string, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoListReleases: ((owner: string, repo: string, draft?: boolean, preRelease?: boolean, perPage?: number, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoListStargazers: ((owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoListStatuses: ((owner: string, repo: string, sha: string, sort?: "oldest" | "recentupdate" | "leastupdate" | "leastindex" | "highestindex", state?: "error" | "pending" | "success" | "failure" | "warning", page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoListStatusesByRef: ((owner: string, repo: string, ref: string, sort?: "oldest" | "recentupdate" | "leastupdate" | "leastindex" | "highestindex", state?: "error" | "pending" | "success" | "failure" | "warning", page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoListSubscribers: ((owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoListTags: ((owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoListTeams: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoListTopics: ((owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoMergePullRequest: ((owner: string, repo: string, index: number, body?: MergePullRequestOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoMigrate: ((body?: MigrateRepoOptions, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoMirrorSync: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoPullRequestIsMerged: ((owner: string, repo: string, index: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoSearch: ((q?: string, topic?: boolean, includeDesc?: boolean, uid?: number, priorityOwnerId?: number, teamId?: number, starredBy?: number, _private?: boolean, isPrivate?: boolean, template?: boolean, archived?: boolean, mode?: string, exclusive?: boolean, repo?: string, owner?: string, lang?: string, subject?: string, book?: string, includeMetadata?: boolean, sort?: string, order?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoSigningKey: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoSubmitPullReview: ((owner: string, repo: string, index: number, id: number, body: SubmitPullReviewOptions, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoTestHook: ((owner: string, repo: string, id: number, ref?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoTrackedTimes: ((owner: string, repo: string, user?: string, since?: string, before?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoTransfer: ((owner: string, repo: string, body: TransferRepoOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoUnDismissPullReview: ((owner: string, repo: string, index: number, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoUpdateFile: ((owner: string, repo: string, filepath: string, body: UpdateFileOptions, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoUpdateGitRef: ((owner: string, repo: string, ref: string, body?: UpdateGitRefOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); repoUpdatePullRequest: ((owner: string, repo: string, index: number, style?: "merge" | "rebase", options?: AxiosRequestConfig) => Promise<RequestArgs>); repoUpdateTopics: ((owner: string, repo: string, body?: RepoTopicOptions, options?: AxiosRequestConfig) => Promise<RequestArgs>); topicSearch: ((q: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); userCurrentCheckSubscription: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); userCurrentDeleteSubscription: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); userCurrentPutSubscription: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); userTrackedTimes: ((owner: string, repo: string, user: string, options?: AxiosRequestConfig) => Promise<RequestArgs>) }

    • acceptRepoTransfer: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Accept a repo transfer

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo to transfer

          • repo: string

            name of the repo to transfer

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • createCurrentUserRepo: ((body?: CreateRepoOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • summary

          Create a repository

          throws

          {RequiredError}

          Parameters

          Returns Promise<RequestArgs>

    • createFork: ((owner: string, repo: string, body?: CreateForkOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, body?: CreateForkOption, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Fork a repository

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo to fork

          • repo: string

            name of the repo to fork

          • Optional body: CreateForkOption
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • generateRepo: ((templateOwner: string, templateRepo: string, body?: GenerateRepoOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (templateOwner: string, templateRepo: string, body?: GenerateRepoOption, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Create a repository using a template

          throws

          {RequiredError}

          Parameters

          • templateOwner: string

            name of the template repository owner

          • templateRepo: string

            name of the template repository

          • Optional body: GenerateRepoOption
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • getAnnotatedTag: ((owner: string, repo: string, sha: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, sha: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Gets the tag object of an annotated tag (not lightweight tags)

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • sha: string

            sha of the tag. The Git tags API only supports annotated tag objects, not lightweight tags.

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • getBlob: ((owner: string, repo: string, sha: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, sha: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Gets the blob of a repository.

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • sha: string

            sha of the commit

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • getTree: ((owner: string, repo: string, sha: string, recursive?: boolean, page?: number, perPage?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, sha: string, recursive?: boolean, page?: number, perPage?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Gets the tree of a repository.

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • sha: string

            sha of the commit

          • Optional recursive: boolean
          • Optional page: number
          • Optional perPage: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • listForks: ((owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          List a repository's forks

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • rejectRepoTransfer: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Reject a repo transfer

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo to transfer

          • repo: string

            name of the repo to transfer

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoAddCollaborator: ((owner: string, repo: string, collaborator: string, body?: AddCollaboratorOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, collaborator: string, body?: AddCollaboratorOption, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Add a collaborator to a repository

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • collaborator: string

            username of the collaborator to add

          • Optional body: AddCollaboratorOption
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoAddTeam: ((owner: string, repo: string, team: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, team: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Add a team to a repository

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • team: string

            team name

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoAddTopic: ((owner: string, repo: string, topic: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, topic: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Add a topic to a repository

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • topic: string

            name of the topic to add

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoApplyDiffPatch: ((owner: string, repo: string, body: UpdateFileOptions, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, body: UpdateFileOptions, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Apply diff patch to repository

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • body: UpdateFileOptions
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoCancelScheduledAutoMerge: ((owner: string, repo: string, index: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, index: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Cancel the scheduled auto merge for the given pull request

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • index: number

            index of the pull request to merge

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoCheckCollaborator: ((owner: string, repo: string, collaborator: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, collaborator: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Check if a user is a collaborator of a repository

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • collaborator: string

            username of the collaborator

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoCheckTeam: ((owner: string, repo: string, team: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, team: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Check if a team is assigned to a repository

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • team: string

            team name

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoCreateBranch: ((owner: string, repo: string, body?: CreateBranchRepoOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, body?: CreateBranchRepoOption, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Create a branch

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • Optional body: CreateBranchRepoOption
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoCreateBranchProtection: ((owner: string, repo: string, body?: CreateBranchProtectionOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • summary

          Create a branch protections for a repository

          throws

          {RequiredError}

          Parameters

          Returns Promise<RequestArgs>

    • repoCreateFile: ((owner: string, repo: string, filepath: string, body: CreateFileOptions, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, filepath: string, body: CreateFileOptions, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Create a file in a repository

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • filepath: string

            path of the file to create

          • body: CreateFileOptions
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoCreateGitRef: ((owner: string, repo: string, body?: CreateGitRefOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, body?: CreateGitRefOption, options?: AxiosRequestConfig): Promise<RequestArgs>

        • Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches.

          summary

          Create a reference

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • Optional body: CreateGitRefOption
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoCreateHook: ((owner: string, repo: string, body?: CreateHookOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, body?: CreateHookOption, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Create a hook

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • Optional body: CreateHookOption
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoCreateKey: ((owner: string, repo: string, body?: CreateKeyOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, body?: CreateKeyOption, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Add a key to a repository

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • Optional body: CreateKeyOption
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoCreatePullRequest: ((owner: string, repo: string, body?: CreatePullRequestOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • summary

          Create a pull request

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • Optional body: CreatePullRequestOption
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoCreatePullReview: ((owner: string, repo: string, index: number, body: CreatePullReviewOptions, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, index: number, body: CreatePullReviewOptions, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Create a review to an pull request

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • index: number

            index of the pull request

          • body: CreatePullReviewOptions
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoCreatePullReviewRequests: ((owner: string, repo: string, index: number, body: PullReviewRequestOptions, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, index: number, body: PullReviewRequestOptions, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          create review requests for a pull request

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • index: number

            index of the pull request

          • body: PullReviewRequestOptions
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoCreateRelease: ((owner: string, repo: string, body?: CreateReleaseOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, body?: CreateReleaseOption, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Create a release

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • Optional body: CreateReleaseOption
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoCreateReleaseAttachment: ((owner: string, repo: string, id: number, attachment: File, name?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, id: number, attachment: File, name?: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Create a release attachment

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • id: number

            id of the release

          • attachment: File

            attachment to upload

          • Optional name: string
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoCreateStatus: ((owner: string, repo: string, sha: string, body?: CreateStatusOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, sha: string, body?: CreateStatusOption, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Create a commit status

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • sha: string

            sha of the commit

          • Optional body: CreateStatusOption
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoCreateTag: ((owner: string, repo: string, body?: CreateTagOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, body?: CreateTagOption, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Create a new git tag in a repository

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • Optional body: CreateTagOption
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoCreateWikiPage: ((owner: string, repo: string, body?: CreateWikiPageOptions, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, body?: CreateWikiPageOptions, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Create a wiki page

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • Optional body: CreateWikiPageOptions
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoDelete: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Delete a repository

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo to delete

          • repo: string

            name of the repo to delete

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoDeleteBranch: ((owner: string, repo: string, branch: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, branch: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Delete a specific branch from a repository

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • branch: string

            branch to delete

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoDeleteBranchProtection: ((owner: string, repo: string, name: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, name: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Delete a specific branch protection for the repository

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • name: string

            name of protected branch

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoDeleteCollaborator: ((owner: string, repo: string, collaborator: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, collaborator: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Delete a collaborator from a repository

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • collaborator: string

            username of the collaborator to delete

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoDeleteFile: ((owner: string, repo: string, filepath: string, body: DeleteFileOptions, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, filepath: string, body: DeleteFileOptions, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Delete a file in a repository

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • filepath: string

            path of the file to delete

          • body: DeleteFileOptions
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoDeleteGitHook: ((owner: string, repo: string, id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, id: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Delete a Git hook in a repository

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • id: string

            id of the hook to get

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoDeleteGitRef: ((owner: string, repo: string, ref: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, ref: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Delete a reference

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • ref: string

            name of the ref to be deleted

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoDeleteHook: ((owner: string, repo: string, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, id: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Delete a hook in a repository

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • id: number

            id of the hook to delete

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoDeleteKey: ((owner: string, repo: string, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, id: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Delete a key from a repository

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • id: number

            id of the key to delete

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoDeletePullReview: ((owner: string, repo: string, index: number, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, index: number, id: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Delete a specific review from a pull request

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • index: number

            index of the pull request

          • id: number

            id of the review

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoDeletePullReviewRequests: ((owner: string, repo: string, index: number, body: PullReviewRequestOptions, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, index: number, body: PullReviewRequestOptions, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          cancel review requests for a pull request

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • index: number

            index of the pull request

          • body: PullReviewRequestOptions
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoDeleteRelease: ((owner: string, repo: string, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, id: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Delete a release

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • id: number

            id of the release to delete

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoDeleteReleaseAttachment: ((owner: string, repo: string, id: number, attachmentId: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, id: number, attachmentId: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Delete a release attachment

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • id: number

            id of the release

          • attachmentId: number

            id of the attachment to delete

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoDeleteReleaseByTag: ((owner: string, repo: string, tag: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, tag: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Delete a release by tag name

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • tag: string

            tag name of the release to delete

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoDeleteTag: ((owner: string, repo: string, tag: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, tag: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Delete a repository's tag by name

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • tag: string

            name of tag to delete

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoDeleteTeam: ((owner: string, repo: string, team: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, team: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Delete a team from a repository

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • team: string

            team name

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoDeleteTopic: ((owner: string, repo: string, topic: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, topic: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Delete a topic from a repository

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • topic: string

            name of the topic to delete

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoDeleteWikiPage: ((owner: string, repo: string, pageName: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, pageName: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Delete a wiki page

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • pageName: string

            name of the page

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoDismissPullReview: ((owner: string, repo: string, index: number, id: number, body: DismissPullReviewOptions, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, index: number, id: number, body: DismissPullReviewOptions, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Dismiss a review for a pull request

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • index: number

            index of the pull request

          • id: number

            id of the review

          • body: DismissPullReviewOptions
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoDownloadCommitDiffOrPatch: ((owner: string, repo: string, sha: string, diffType: "patch" | "diff", options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, sha: string, diffType: "patch" | "diff", options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get a commit's diff or patch

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • sha: string

            SHA of the commit to get

          • diffType: "patch" | "diff"

            whether the output is diff or patch

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoDownloadPullDiffOrPatch: ((owner: string, repo: string, index: number, diffType: "patch" | "diff", binary?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, index: number, diffType: "patch" | "diff", binary?: boolean, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get a pull request diff or patch

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • index: number

            index of the pull request to get

          • diffType: "patch" | "diff"

            whether the output is diff or patch

          • Optional binary: boolean
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoEdit: ((owner: string, repo: string, body?: EditRepoOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, body?: EditRepoOption, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Edit a repository's properties. Only fields that are set will be changed.

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo to edit

          • repo: string

            name of the repo to edit

          • Optional body: EditRepoOption
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoEditBranchProtection: ((owner: string, repo: string, name: string, body?: EditBranchProtectionOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, name: string, body?: EditBranchProtectionOption, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Edit a branch protections for a repository. Only fields that are set will be changed

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • name: string

            name of protected branch

          • Optional body: EditBranchProtectionOption
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoEditGitHook: ((owner: string, repo: string, id: string, body?: EditGitHookOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, id: string, body?: EditGitHookOption, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Edit a Git hook in a repository

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • id: string

            id of the hook to get

          • Optional body: EditGitHookOption
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoEditHook: ((owner: string, repo: string, id: number, body?: EditHookOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, id: number, body?: EditHookOption, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Edit a hook in a repository

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • id: number

            index of the hook

          • Optional body: EditHookOption
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoEditPullRequest: ((owner: string, repo: string, index: number, body?: EditPullRequestOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, index: number, body?: EditPullRequestOption, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Update a pull request. If using deadline only the date will be taken into account, and time of day ignored.

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • index: number

            index of the pull request to edit

          • Optional body: EditPullRequestOption
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoEditRelease: ((owner: string, repo: string, id: number, body?: EditReleaseOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, id: number, body?: EditReleaseOption, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Update a release

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • id: number

            id of the release to edit

          • Optional body: EditReleaseOption
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoEditReleaseAttachment: ((owner: string, repo: string, id: number, attachmentId: number, body?: EditAttachmentOptions, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, id: number, attachmentId: number, body?: EditAttachmentOptions, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Edit a release attachment

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • id: number

            id of the release

          • attachmentId: number

            id of the attachment to edit

          • Optional body: EditAttachmentOptions
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoEditWikiPage: ((owner: string, repo: string, pageName: string, body?: CreateWikiPageOptions, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, pageName: string, body?: CreateWikiPageOptions, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Edit a wiki page

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • pageName: string

            name of the page

          • Optional body: CreateWikiPageOptions
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoGet: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get a repository

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoGetAllCommits: ((owner: string, repo: string, sha?: string, path?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, sha?: string, path?: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get a list of all commits from a repository

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • Optional sha: string
          • Optional path: string
          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoGetArchive: ((owner: string, repo: string, archive: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, archive: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get an archive of a repository

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • archive: string

            the git reference for download with attached archive format (e.g. master.zip)

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoGetAssignees: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Return all users that have write access and can be assigned to issues

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoGetBranch: ((owner: string, repo: string, branch: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, branch: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Retrieve a specific branch from a repository, including its effective branch protection

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • branch: string

            branch to get

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoGetBranchProtection: ((owner: string, repo: string, name: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, name: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get a specific branch protection for the repository

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • name: string

            name of protected branch

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoGetByID: ((id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (id: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get a repository by id

          throws

          {RequiredError}

          Parameters

          • id: number

            id of the repo to get

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoGetCombinedStatusByRef: ((owner: string, repo: string, ref: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, ref: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get a commit's combined status, by branch/tag/commit reference

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • ref: string

            name of branch/tag/commit

          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoGetContents: ((owner: string, repo: string, filepath: string, ref?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, filepath: string, ref?: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Gets the metadata and contents (if a file) of an entry in a repository, or a list of entries if a dir

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • filepath: string

            path of the dir, file, symlink or submodule in the repo

          • Optional ref: string
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoGetContentsList: ((owner: string, repo: string, ref?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, ref?: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Gets the metadata of all the entries of the root dir

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • Optional ref: string
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoGetEditorConfig: ((owner: string, repo: string, filepath: string, ref?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, filepath: string, ref?: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get the EditorConfig definitions of a file in a repository

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • filepath: string

            filepath of file to get

          • Optional ref: string
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoGetGitHook: ((owner: string, repo: string, id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, id: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get a Git hook

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • id: string

            id of the hook to get

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoGetHook: ((owner: string, repo: string, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, id: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get a hook

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • id: number

            id of the hook to get

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoGetIssueTemplates: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get available issue templates for a repository

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoGetKey: ((owner: string, repo: string, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, id: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get a repository's key by id

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • id: number

            id of the key to get

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoGetLanguages: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get languages and number of bytes of code written

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoGetNote: ((owner: string, repo: string, sha: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, sha: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get a note corresponding to a single commit from a repository

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • sha: string

            a git ref or commit sha

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoGetPullRequest: ((owner: string, repo: string, index: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, index: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get a pull request

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • index: number

            index of the pull request to get

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoGetPullRequestCommits: ((owner: string, repo: string, index: number, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, index: number, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get commits for a pull request

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • index: number

            index of the pull request to get

          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoGetPullReview: ((owner: string, repo: string, index: number, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, index: number, id: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get a specific review for a pull request

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • index: number

            index of the pull request

          • id: number

            id of the review

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoGetPullReviewComments: ((owner: string, repo: string, index: number, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, index: number, id: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get a specific review for a pull request

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • index: number

            index of the pull request

          • id: number

            id of the review

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoGetRawFile: ((owner: string, repo: string, filepath: string, ref?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, filepath: string, ref?: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get a file from a repository

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • filepath: string

            filepath of the file to get

          • Optional ref: string
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoGetRawFileOrLFS: ((owner: string, repo: string, filepath: string, ref?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, filepath: string, ref?: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get a file or it's LFS object from a repository

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • filepath: string

            filepath of the file to get

          • Optional ref: string
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoGetRelease: ((owner: string, repo: string, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, id: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get a release

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • id: number

            id of the release to get

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoGetReleaseAttachment: ((owner: string, repo: string, id: number, attachmentId: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, id: number, attachmentId: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get a release attachment

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • id: number

            id of the release

          • attachmentId: number

            id of the attachment to get

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoGetReleaseByTag: ((owner: string, repo: string, tag: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, tag: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get a release by tag name

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • tag: string

            tag name of the release to get

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoGetRepoPermissions: ((owner: string, repo: string, collaborator: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, collaborator: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get repository permissions for a user

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • collaborator: string

            username of the collaborator

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoGetReviewers: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Return all users that can be requested to review in this repo

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoGetSingleCommit: ((owner: string, repo: string, sha: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, sha: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get a single commit from a repository

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • sha: string

            a git ref or commit sha

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoGetTag: ((owner: string, repo: string, tag: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, tag: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get the tag of a repository by tag name

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • tag: string

            name of tag

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoGetWikiPage: ((owner: string, repo: string, pageName: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, pageName: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get a wiki page

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • pageName: string

            name of the page

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoGetWikiPageRevisions: ((owner: string, repo: string, pageName: string, page?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, pageName: string, page?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get revisions of a wiki page

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • pageName: string

            name of the page

          • Optional page: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoGetWikiPages: ((owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get all wiki pages

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoListAllGitRefs: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get specified ref or filtered repository's refs

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoListBranchProtection: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          List branch protections for a repository

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoListBranches: ((owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          List a repository's branches

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoListCollaborators: ((owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          List a repository's collaborators

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoListGitHooks: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          List the Git hooks in a repository

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoListGitRefs: ((owner: string, repo: string, ref: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, ref: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get specified ref or filtered repository's refs

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • ref: string

            part or full name of the ref

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoListHooks: ((owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          List the hooks in a repository

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoListKeys: ((owner: string, repo: string, keyId?: number, fingerprint?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, keyId?: number, fingerprint?: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          List a repository's keys

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • Optional keyId: number
          • Optional fingerprint: string
          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoListPullRequests: ((owner: string, repo: string, state?: "all" | "closed" | "open", sort?: "priority" | "oldest" | "recentupdate" | "leastupdate" | "mostcomment" | "leastcomment", milestone?: number, labels?: number[], page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, state?: "all" | "closed" | "open", sort?: "priority" | "oldest" | "recentupdate" | "leastupdate" | "mostcomment" | "leastcomment", milestone?: number, labels?: number[], page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          List a repo's pull requests

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • Optional state: "all" | "closed" | "open"
          • Optional sort: "priority" | "oldest" | "recentupdate" | "leastupdate" | "mostcomment" | "leastcomment"
          • Optional milestone: number
          • Optional labels: number[]
          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoListPullReviews: ((owner: string, repo: string, index: number, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, index: number, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          List all reviews for a pull request

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • index: number

            index of the pull request

          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoListReleaseAttachments: ((owner: string, repo: string, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, id: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          List release's attachments

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • id: number

            id of the release

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoListReleases: ((owner: string, repo: string, draft?: boolean, preRelease?: boolean, perPage?: number, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, draft?: boolean, preRelease?: boolean, perPage?: number, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          List a repo's releases

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • Optional draft: boolean
          • Optional preRelease: boolean
          • Optional perPage: number
          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoListStargazers: ((owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          List a repo's stargazers

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoListStatuses: ((owner: string, repo: string, sha: string, sort?: "oldest" | "recentupdate" | "leastupdate" | "leastindex" | "highestindex", state?: "error" | "pending" | "success" | "failure" | "warning", page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, sha: string, sort?: "oldest" | "recentupdate" | "leastupdate" | "leastindex" | "highestindex", state?: "error" | "pending" | "success" | "failure" | "warning", page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get a commit's statuses

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • sha: string

            sha of the commit

          • Optional sort: "oldest" | "recentupdate" | "leastupdate" | "leastindex" | "highestindex"
          • Optional state: "error" | "pending" | "success" | "failure" | "warning"
          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoListStatusesByRef: ((owner: string, repo: string, ref: string, sort?: "oldest" | "recentupdate" | "leastupdate" | "leastindex" | "highestindex", state?: "error" | "pending" | "success" | "failure" | "warning", page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, ref: string, sort?: "oldest" | "recentupdate" | "leastupdate" | "leastindex" | "highestindex", state?: "error" | "pending" | "success" | "failure" | "warning", page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get a commit's statuses, by branch/tag/commit reference

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • ref: string

            name of branch/tag/commit

          • Optional sort: "oldest" | "recentupdate" | "leastupdate" | "leastindex" | "highestindex"
          • Optional state: "error" | "pending" | "success" | "failure" | "warning"
          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoListSubscribers: ((owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          List a repo's watchers

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoListTags: ((owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          List a repository's tags

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoListTeams: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          List a repository's teams

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoListTopics: ((owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get list of topics that a repository has

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoMergePullRequest: ((owner: string, repo: string, index: number, body?: MergePullRequestOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, index: number, body?: MergePullRequestOption, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Merge a pull request

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • index: number

            index of the pull request to merge

          • Optional body: MergePullRequestOption
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoMigrate: ((body?: MigrateRepoOptions, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • summary

          Migrate a remote git repository

          throws

          {RequiredError}

          Parameters

          Returns Promise<RequestArgs>

    • repoMirrorSync: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Sync a mirrored repository

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo to sync

          • repo: string

            name of the repo to sync

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoPullRequestIsMerged: ((owner: string, repo: string, index: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, index: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Check if a pull request has been merged

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • index: number

            index of the pull request

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoSearch: ((q?: string, topic?: boolean, includeDesc?: boolean, uid?: number, priorityOwnerId?: number, teamId?: number, starredBy?: number, _private?: boolean, isPrivate?: boolean, template?: boolean, archived?: boolean, mode?: string, exclusive?: boolean, repo?: string, owner?: string, lang?: string, subject?: string, book?: string, includeMetadata?: boolean, sort?: string, order?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (q?: string, topic?: boolean, includeDesc?: boolean, uid?: number, priorityOwnerId?: number, teamId?: number, starredBy?: number, _private?: boolean, isPrivate?: boolean, template?: boolean, archived?: boolean, mode?: string, exclusive?: boolean, repo?: string, owner?: string, lang?: string, subject?: string, book?: string, includeMetadata?: boolean, sort?: string, order?: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Search for repositories

          throws

          {RequiredError}

          Parameters

          • Optional q: string
          • Optional topic: boolean
          • Optional includeDesc: boolean
          • Optional uid: number
          • Optional priorityOwnerId: number
          • Optional teamId: number
          • Optional starredBy: number
          • Optional _private: boolean
          • Optional isPrivate: boolean
          • Optional template: boolean
          • Optional archived: boolean
          • Optional mode: string
          • Optional exclusive: boolean
          • Optional repo: string
          • Optional owner: string
          • Optional lang: string
          • Optional subject: string
          • Optional book: string
          • Optional includeMetadata: boolean
          • Optional sort: string
          • Optional order: string
          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoSigningKey: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get signing-key.gpg for given repository

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoSubmitPullReview: ((owner: string, repo: string, index: number, id: number, body: SubmitPullReviewOptions, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, index: number, id: number, body: SubmitPullReviewOptions, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Submit a pending review to an pull request

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • index: number

            index of the pull request

          • id: number

            id of the review

          • body: SubmitPullReviewOptions
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoTestHook: ((owner: string, repo: string, id: number, ref?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, id: number, ref?: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Test a push webhook

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • id: number

            id of the hook to test

          • Optional ref: string
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoTrackedTimes: ((owner: string, repo: string, user?: string, since?: string, before?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, user?: string, since?: string, before?: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          List a repo's tracked times

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • Optional user: string
          • Optional since: string
          • Optional before: string
          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoTransfer: ((owner: string, repo: string, body: TransferRepoOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, body: TransferRepoOption, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Transfer a repo ownership

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo to transfer

          • repo: string

            name of the repo to transfer

          • body: TransferRepoOption

            Transfer Options

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoUnDismissPullReview: ((owner: string, repo: string, index: number, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, index: number, id: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Cancel to dismiss a review for a pull request

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • index: number

            index of the pull request

          • id: number

            id of the review

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoUpdateFile: ((owner: string, repo: string, filepath: string, body: UpdateFileOptions, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, filepath: string, body: UpdateFileOptions, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Update a file in a repository

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • filepath: string

            path of the file to update

          • body: UpdateFileOptions
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoUpdateGitRef: ((owner: string, repo: string, ref: string, body?: UpdateGitRefOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, ref: string, body?: UpdateGitRefOption, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Update a reference

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • ref: string

            name of the ref to update

          • Optional body: UpdateGitRefOption
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoUpdatePullRequest: ((owner: string, repo: string, index: number, style?: "merge" | "rebase", options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, index: number, style?: "merge" | "rebase", options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Merge PR's baseBranch into headBranch

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • index: number

            index of the pull request to get

          • Optional style: "merge" | "rebase"
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • repoUpdateTopics: ((owner: string, repo: string, body?: RepoTopicOptions, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, body?: RepoTopicOptions, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Replace list of topics for a repository

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • Optional body: RepoTopicOptions
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • topicSearch: ((q: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (q: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          search topics via keyword

          throws

          {RequiredError}

          Parameters

          • q: string

            keywords to search

          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • userCurrentCheckSubscription: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Check if the current user is watching a repo

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • userCurrentDeleteSubscription: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Unwatch a repo

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • userCurrentPutSubscription: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Watch a repo

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • userTrackedTimes: ((owner: string, repo: string, user: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, user: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          List a user's tracked times in a repo

          deprecated
          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • user: string

            username of user

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

RepositoryApiFactory

  • RepositoryApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { acceptRepoTransfer: any; createCurrentUserRepo: any; createFork: any; generateRepo: any; getAnnotatedTag: any; getBlob: any; getTree: any; listForks: any; rejectRepoTransfer: any; repoAddCollaborator: any; repoAddTeam: any; repoAddTopic: any; repoApplyDiffPatch: any; repoCancelScheduledAutoMerge: any; repoCheckCollaborator: any; repoCheckTeam: any; repoCreateBranch: any; repoCreateBranchProtection: any; repoCreateFile: any; repoCreateGitRef: any; repoCreateHook: any; repoCreateKey: any; repoCreatePullRequest: any; repoCreatePullReview: any; repoCreatePullReviewRequests: any; repoCreateRelease: any; repoCreateReleaseAttachment: any; repoCreateStatus: any; repoCreateTag: any; repoCreateWikiPage: any; repoDelete: any; repoDeleteBranch: any; repoDeleteBranchProtection: any; repoDeleteCollaborator: any; repoDeleteFile: any; repoDeleteGitHook: any; repoDeleteGitRef: any; repoDeleteHook: any; repoDeleteKey: any; repoDeletePullReview: any; repoDeletePullReviewRequests: any; repoDeleteRelease: any; repoDeleteReleaseAttachment: any; repoDeleteReleaseByTag: any; repoDeleteTag: any; repoDeleteTeam: any; repoDeleteTopic: any; repoDeleteWikiPage: any; repoDismissPullReview: any; repoDownloadCommitDiffOrPatch: any; repoDownloadPullDiffOrPatch: any; repoEdit: any; repoEditBranchProtection: any; repoEditGitHook: any; repoEditHook: any; repoEditPullRequest: any; repoEditRelease: any; repoEditReleaseAttachment: any; repoEditWikiPage: any; repoGet: any; repoGetAllCommits: any; repoGetArchive: any; repoGetAssignees: any; repoGetBranch: any; repoGetBranchProtection: any; repoGetByID: any; repoGetCombinedStatusByRef: any; repoGetContents: any; repoGetContentsList: any; repoGetEditorConfig: any; repoGetGitHook: any; repoGetHook: any; repoGetIssueTemplates: any; repoGetKey: any; repoGetLanguages: any; repoGetNote: any; repoGetPullRequest: any; repoGetPullRequestCommits: any; repoGetPullReview: any; repoGetPullReviewComments: any; repoGetRawFile: any; repoGetRawFileOrLFS: any; repoGetRelease: any; repoGetReleaseAttachment: any; repoGetReleaseByTag: any; repoGetRepoPermissions: any; repoGetReviewers: any; repoGetSingleCommit: any; repoGetTag: any; repoGetWikiPage: any; repoGetWikiPageRevisions: any; repoGetWikiPages: any; repoListAllGitRefs: any; repoListBranchProtection: any; repoListBranches: any; repoListCollaborators: any; repoListGitHooks: any; repoListGitRefs: any; repoListHooks: any; repoListKeys: any; repoListPullRequests: any; repoListPullReviews: any; repoListReleaseAttachments: any; repoListReleases: any; repoListStargazers: any; repoListStatuses: any; repoListStatusesByRef: any; repoListSubscribers: any; repoListTags: any; repoListTeams: any; repoListTopics: any; repoMergePullRequest: any; repoMigrate: any; repoMirrorSync: any; repoPullRequestIsMerged: any; repoSearch: any; repoSigningKey: any; repoSubmitPullReview: any; repoTestHook: any; repoTrackedTimes: any; repoTransfer: any; repoUnDismissPullReview: any; repoUpdateFile: any; repoUpdateGitRef: any; repoUpdatePullRequest: any; repoUpdateTopics: any; topicSearch: any; userCurrentCheckSubscription: any; userCurrentDeleteSubscription: any; userCurrentPutSubscription: any; userTrackedTimes: any }

  • RepositoryApi - factory interface

    export

    Parameters

    • Optional configuration: Configuration
    • Optional basePath: string
    • Optional axios: AxiosInstance

    Returns { acceptRepoTransfer: any; createCurrentUserRepo: any; createFork: any; generateRepo: any; getAnnotatedTag: any; getBlob: any; getTree: any; listForks: any; rejectRepoTransfer: any; repoAddCollaborator: any; repoAddTeam: any; repoAddTopic: any; repoApplyDiffPatch: any; repoCancelScheduledAutoMerge: any; repoCheckCollaborator: any; repoCheckTeam: any; repoCreateBranch: any; repoCreateBranchProtection: any; repoCreateFile: any; repoCreateGitRef: any; repoCreateHook: any; repoCreateKey: any; repoCreatePullRequest: any; repoCreatePullReview: any; repoCreatePullReviewRequests: any; repoCreateRelease: any; repoCreateReleaseAttachment: any; repoCreateStatus: any; repoCreateTag: any; repoCreateWikiPage: any; repoDelete: any; repoDeleteBranch: any; repoDeleteBranchProtection: any; repoDeleteCollaborator: any; repoDeleteFile: any; repoDeleteGitHook: any; repoDeleteGitRef: any; repoDeleteHook: any; repoDeleteKey: any; repoDeletePullReview: any; repoDeletePullReviewRequests: any; repoDeleteRelease: any; repoDeleteReleaseAttachment: any; repoDeleteReleaseByTag: any; repoDeleteTag: any; repoDeleteTeam: any; repoDeleteTopic: any; repoDeleteWikiPage: any; repoDismissPullReview: any; repoDownloadCommitDiffOrPatch: any; repoDownloadPullDiffOrPatch: any; repoEdit: any; repoEditBranchProtection: any; repoEditGitHook: any; repoEditHook: any; repoEditPullRequest: any; repoEditRelease: any; repoEditReleaseAttachment: any; repoEditWikiPage: any; repoGet: any; repoGetAllCommits: any; repoGetArchive: any; repoGetAssignees: any; repoGetBranch: any; repoGetBranchProtection: any; repoGetByID: any; repoGetCombinedStatusByRef: any; repoGetContents: any; repoGetContentsList: any; repoGetEditorConfig: any; repoGetGitHook: any; repoGetHook: any; repoGetIssueTemplates: any; repoGetKey: any; repoGetLanguages: any; repoGetNote: any; repoGetPullRequest: any; repoGetPullRequestCommits: any; repoGetPullReview: any; repoGetPullReviewComments: any; repoGetRawFile: any; repoGetRawFileOrLFS: any; repoGetRelease: any; repoGetReleaseAttachment: any; repoGetReleaseByTag: any; repoGetRepoPermissions: any; repoGetReviewers: any; repoGetSingleCommit: any; repoGetTag: any; repoGetWikiPage: any; repoGetWikiPageRevisions: any; repoGetWikiPages: any; repoListAllGitRefs: any; repoListBranchProtection: any; repoListBranches: any; repoListCollaborators: any; repoListGitHooks: any; repoListGitRefs: any; repoListHooks: any; repoListKeys: any; repoListPullRequests: any; repoListPullReviews: any; repoListReleaseAttachments: any; repoListReleases: any; repoListStargazers: any; repoListStatuses: any; repoListStatusesByRef: any; repoListSubscribers: any; repoListTags: any; repoListTeams: any; repoListTopics: any; repoMergePullRequest: any; repoMigrate: any; repoMirrorSync: any; repoPullRequestIsMerged: any; repoSearch: any; repoSigningKey: any; repoSubmitPullReview: any; repoTestHook: any; repoTrackedTimes: any; repoTransfer: any; repoUnDismissPullReview: any; repoUpdateFile: any; repoUpdateGitRef: any; repoUpdatePullRequest: any; repoUpdateTopics: any; topicSearch: any; userCurrentCheckSubscription: any; userCurrentDeleteSubscription: any; userCurrentPutSubscription: any; userTrackedTimes: any }

    • acceptRepoTransfer:function
      • acceptRepoTransfer(owner: string, repo: string, options?: any): AxiosPromise<Repository>
      • summary

        Accept a repo transfer

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo to transfer

        • repo: string

          name of the repo to transfer

        • Optional options: any

        Returns AxiosPromise<Repository>

    • createCurrentUserRepo:function
      • summary

        Create a repository

        throws

        {RequiredError}

        Parameters

        Returns AxiosPromise<Repository>

    • createFork:function
      • summary

        Fork a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo to fork

        • repo: string

          name of the repo to fork

        • Optional body: CreateForkOption
        • Optional options: any

        Returns AxiosPromise<Repository>

    • generateRepo:function
      • summary

        Create a repository using a template

        throws

        {RequiredError}

        Parameters

        • templateOwner: string

          name of the template repository owner

        • templateRepo: string

          name of the template repository

        • Optional body: GenerateRepoOption
        • Optional options: any

        Returns AxiosPromise<Repository>

    • getAnnotatedTag:function
      • getAnnotatedTag(owner: string, repo: string, sha: string, options?: any): AxiosPromise<AnnotatedTag>
      • summary

        Gets the tag object of an annotated tag (not lightweight tags)

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • sha: string

          sha of the tag. The Git tags API only supports annotated tag objects, not lightweight tags.

        • Optional options: any

        Returns AxiosPromise<AnnotatedTag>

    • getBlob:function
      • getBlob(owner: string, repo: string, sha: string, options?: any): AxiosPromise<GitBlobResponse>
      • summary

        Gets the blob of a repository.

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • sha: string

          sha of the commit

        • Optional options: any

        Returns AxiosPromise<GitBlobResponse>

    • getTree:function
      • getTree(owner: string, repo: string, sha: string, recursive?: boolean, page?: number, perPage?: number, options?: any): AxiosPromise<GitTreeResponse>
      • summary

        Gets the tree of a repository.

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • sha: string

          sha of the commit

        • Optional recursive: boolean
        • Optional page: number
        • Optional perPage: number
        • Optional options: any

        Returns AxiosPromise<GitTreeResponse>

    • listForks:function
      • listForks(owner: string, repo: string, page?: number, limit?: number, options?: any): AxiosPromise<Repository[]>
      • summary

        List a repository's forks

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<Repository[]>

    • rejectRepoTransfer:function
      • rejectRepoTransfer(owner: string, repo: string, options?: any): AxiosPromise<Repository>
      • summary

        Reject a repo transfer

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo to transfer

        • repo: string

          name of the repo to transfer

        • Optional options: any

        Returns AxiosPromise<Repository>

    • repoAddCollaborator:function
      • repoAddCollaborator(owner: string, repo: string, collaborator: string, body?: AddCollaboratorOption, options?: any): AxiosPromise<void>
      • summary

        Add a collaborator to a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • collaborator: string

          username of the collaborator to add

        • Optional body: AddCollaboratorOption
        • Optional options: any

        Returns AxiosPromise<void>

    • repoAddTeam:function
      • repoAddTeam(owner: string, repo: string, team: string, options?: any): AxiosPromise<void>
      • summary

        Add a team to a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • team: string

          team name

        • Optional options: any

        Returns AxiosPromise<void>

    • repoAddTopic:function
      • repoAddTopic(owner: string, repo: string, topic: string, options?: any): AxiosPromise<void>
      • summary

        Add a topic to a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • topic: string

          name of the topic to add

        • Optional options: any

        Returns AxiosPromise<void>

    • repoApplyDiffPatch:function
      • summary

        Apply diff patch to repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • body: UpdateFileOptions
        • Optional options: any

        Returns AxiosPromise<FileResponse>

    • repoCancelScheduledAutoMerge:function
      • repoCancelScheduledAutoMerge(owner: string, repo: string, index: number, options?: any): AxiosPromise<void>
      • summary

        Cancel the scheduled auto merge for the given pull request

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the pull request to merge

        • Optional options: any

        Returns AxiosPromise<void>

    • repoCheckCollaborator:function
      • repoCheckCollaborator(owner: string, repo: string, collaborator: string, options?: any): AxiosPromise<void>
      • summary

        Check if a user is a collaborator of a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • collaborator: string

          username of the collaborator

        • Optional options: any

        Returns AxiosPromise<void>

    • repoCheckTeam:function
      • repoCheckTeam(owner: string, repo: string, team: string, options?: any): AxiosPromise<Team>
      • summary

        Check if a team is assigned to a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • team: string

          team name

        • Optional options: any

        Returns AxiosPromise<Team>

    • repoCreateBranch:function
      • summary

        Create a branch

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional body: CreateBranchRepoOption
        • Optional options: any

        Returns AxiosPromise<Branch>

    • repoCreateBranchProtection:function
      • summary

        Create a branch protections for a repository

        throws

        {RequiredError}

        Parameters

        Returns AxiosPromise<BranchProtection>

    • repoCreateFile:function
      • summary

        Create a file in a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • filepath: string

          path of the file to create

        • body: CreateFileOptions
        • Optional options: any

        Returns AxiosPromise<FileResponse>

    • repoCreateGitRef:function

      • Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches.

        summary

        Create a reference

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional body: CreateGitRefOption
        • Optional options: any

        Returns AxiosPromise<Reference>

    • repoCreateHook:function
      • repoCreateHook(owner: string, repo: string, body?: CreateHookOption, options?: any): AxiosPromise<Hook>
      • summary

        Create a hook

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional body: CreateHookOption
        • Optional options: any

        Returns AxiosPromise<Hook>

    • repoCreateKey:function
      • summary

        Add a key to a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional body: CreateKeyOption
        • Optional options: any

        Returns AxiosPromise<DeployKey>

    • repoCreatePullRequest:function
      • summary

        Create a pull request

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional body: CreatePullRequestOption
        • Optional options: any

        Returns AxiosPromise<PullRequest>

    • repoCreatePullReview:function
      • summary

        Create a review to an pull request

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the pull request

        • body: CreatePullReviewOptions
        • Optional options: any

        Returns AxiosPromise<PullReview>

    • repoCreatePullReviewRequests:function
      • summary

        create review requests for a pull request

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the pull request

        • body: PullReviewRequestOptions
        • Optional options: any

        Returns AxiosPromise<PullReview[]>

    • repoCreateRelease:function
      • summary

        Create a release

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional body: CreateReleaseOption
        • Optional options: any

        Returns AxiosPromise<Release>

    • repoCreateReleaseAttachment:function
      • repoCreateReleaseAttachment(owner: string, repo: string, id: number, attachment: File, name?: string, options?: any): AxiosPromise<Attachment>
      • summary

        Create a release attachment

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • id: number

          id of the release

        • attachment: File

          attachment to upload

        • Optional name: string
        • Optional options: any

        Returns AxiosPromise<Attachment>

    • repoCreateStatus:function
      • summary

        Create a commit status

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • sha: string

          sha of the commit

        • Optional body: CreateStatusOption
        • Optional options: any

        Returns AxiosPromise<CommitStatus>

    • repoCreateTag:function
      • repoCreateTag(owner: string, repo: string, body?: CreateTagOption, options?: any): AxiosPromise<Tag>
      • summary

        Create a new git tag in a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional body: CreateTagOption
        • Optional options: any

        Returns AxiosPromise<Tag>

    • repoCreateWikiPage:function
      • summary

        Create a wiki page

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional body: CreateWikiPageOptions
        • Optional options: any

        Returns AxiosPromise<WikiPage>

    • repoDelete:function
      • repoDelete(owner: string, repo: string, options?: any): AxiosPromise<void>
      • summary

        Delete a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo to delete

        • repo: string

          name of the repo to delete

        • Optional options: any

        Returns AxiosPromise<void>

    • repoDeleteBranch:function
      • repoDeleteBranch(owner: string, repo: string, branch: string, options?: any): AxiosPromise<void>
      • summary

        Delete a specific branch from a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • branch: string

          branch to delete

        • Optional options: any

        Returns AxiosPromise<void>

    • repoDeleteBranchProtection:function
      • repoDeleteBranchProtection(owner: string, repo: string, name: string, options?: any): AxiosPromise<void>
      • summary

        Delete a specific branch protection for the repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • name: string

          name of protected branch

        • Optional options: any

        Returns AxiosPromise<void>

    • repoDeleteCollaborator:function
      • repoDeleteCollaborator(owner: string, repo: string, collaborator: string, options?: any): AxiosPromise<void>
      • summary

        Delete a collaborator from a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • collaborator: string

          username of the collaborator to delete

        • Optional options: any

        Returns AxiosPromise<void>

    • repoDeleteFile:function
      • summary

        Delete a file in a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • filepath: string

          path of the file to delete

        • body: DeleteFileOptions
        • Optional options: any

        Returns AxiosPromise<FileDeleteResponse>

    • repoDeleteGitHook:function
      • repoDeleteGitHook(owner: string, repo: string, id: string, options?: any): AxiosPromise<void>
      • summary

        Delete a Git hook in a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • id: string

          id of the hook to get

        • Optional options: any

        Returns AxiosPromise<void>

    • repoDeleteGitRef:function
      • repoDeleteGitRef(owner: string, repo: string, ref: string, options?: any): AxiosPromise<void>
      • summary

        Delete a reference

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • ref: string

          name of the ref to be deleted

        • Optional options: any

        Returns AxiosPromise<void>

    • repoDeleteHook:function
      • repoDeleteHook(owner: string, repo: string, id: number, options?: any): AxiosPromise<void>
      • summary

        Delete a hook in a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • id: number

          id of the hook to delete

        • Optional options: any

        Returns AxiosPromise<void>

    • repoDeleteKey:function
      • repoDeleteKey(owner: string, repo: string, id: number, options?: any): AxiosPromise<void>
      • summary

        Delete a key from a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • id: number

          id of the key to delete

        • Optional options: any

        Returns AxiosPromise<void>

    • repoDeletePullReview:function
      • repoDeletePullReview(owner: string, repo: string, index: number, id: number, options?: any): AxiosPromise<void>
      • summary

        Delete a specific review from a pull request

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the pull request

        • id: number

          id of the review

        • Optional options: any

        Returns AxiosPromise<void>

    • repoDeletePullReviewRequests:function
      • repoDeletePullReviewRequests(owner: string, repo: string, index: number, body: PullReviewRequestOptions, options?: any): AxiosPromise<void>
      • summary

        cancel review requests for a pull request

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the pull request

        • body: PullReviewRequestOptions
        • Optional options: any

        Returns AxiosPromise<void>

    • repoDeleteRelease:function
      • repoDeleteRelease(owner: string, repo: string, id: number, options?: any): AxiosPromise<void>
      • summary

        Delete a release

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • id: number

          id of the release to delete

        • Optional options: any

        Returns AxiosPromise<void>

    • repoDeleteReleaseAttachment:function
      • repoDeleteReleaseAttachment(owner: string, repo: string, id: number, attachmentId: number, options?: any): AxiosPromise<void>
      • summary

        Delete a release attachment

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • id: number

          id of the release

        • attachmentId: number

          id of the attachment to delete

        • Optional options: any

        Returns AxiosPromise<void>

    • repoDeleteReleaseByTag:function
      • repoDeleteReleaseByTag(owner: string, repo: string, tag: string, options?: any): AxiosPromise<void>
      • summary

        Delete a release by tag name

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • tag: string

          tag name of the release to delete

        • Optional options: any

        Returns AxiosPromise<void>

    • repoDeleteTag:function
      • repoDeleteTag(owner: string, repo: string, tag: string, options?: any): AxiosPromise<void>
      • summary

        Delete a repository's tag by name

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • tag: string

          name of tag to delete

        • Optional options: any

        Returns AxiosPromise<void>

    • repoDeleteTeam:function
      • repoDeleteTeam(owner: string, repo: string, team: string, options?: any): AxiosPromise<void>
      • summary

        Delete a team from a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • team: string

          team name

        • Optional options: any

        Returns AxiosPromise<void>

    • repoDeleteTopic:function
      • repoDeleteTopic(owner: string, repo: string, topic: string, options?: any): AxiosPromise<void>
      • summary

        Delete a topic from a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • topic: string

          name of the topic to delete

        • Optional options: any

        Returns AxiosPromise<void>

    • repoDeleteWikiPage:function
      • repoDeleteWikiPage(owner: string, repo: string, pageName: string, options?: any): AxiosPromise<void>
      • summary

        Delete a wiki page

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • pageName: string

          name of the page

        • Optional options: any

        Returns AxiosPromise<void>

    • repoDismissPullReview:function
      • summary

        Dismiss a review for a pull request

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the pull request

        • id: number

          id of the review

        • body: DismissPullReviewOptions
        • Optional options: any

        Returns AxiosPromise<PullReview>

    • repoDownloadCommitDiffOrPatch:function
      • repoDownloadCommitDiffOrPatch(owner: string, repo: string, sha: string, diffType: "patch" | "diff", options?: any): AxiosPromise<string>
      • summary

        Get a commit's diff or patch

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • sha: string

          SHA of the commit to get

        • diffType: "patch" | "diff"

          whether the output is diff or patch

        • Optional options: any

        Returns AxiosPromise<string>

    • repoDownloadPullDiffOrPatch:function
      • repoDownloadPullDiffOrPatch(owner: string, repo: string, index: number, diffType: "patch" | "diff", binary?: boolean, options?: any): AxiosPromise<string>
      • summary

        Get a pull request diff or patch

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the pull request to get

        • diffType: "patch" | "diff"

          whether the output is diff or patch

        • Optional binary: boolean
        • Optional options: any

        Returns AxiosPromise<string>

    • repoEdit:function
      • summary

        Edit a repository's properties. Only fields that are set will be changed.

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo to edit

        • repo: string

          name of the repo to edit

        • Optional body: EditRepoOption
        • Optional options: any

        Returns AxiosPromise<Repository>

    • repoEditBranchProtection:function
      • summary

        Edit a branch protections for a repository. Only fields that are set will be changed

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • name: string

          name of protected branch

        • Optional body: EditBranchProtectionOption
        • Optional options: any

        Returns AxiosPromise<BranchProtection>

    • repoEditGitHook:function
      • repoEditGitHook(owner: string, repo: string, id: string, body?: EditGitHookOption, options?: any): AxiosPromise<GitHook>
      • summary

        Edit a Git hook in a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • id: string

          id of the hook to get

        • Optional body: EditGitHookOption
        • Optional options: any

        Returns AxiosPromise<GitHook>

    • repoEditHook:function
      • repoEditHook(owner: string, repo: string, id: number, body?: EditHookOption, options?: any): AxiosPromise<Hook>
      • summary

        Edit a hook in a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • id: number

          index of the hook

        • Optional body: EditHookOption
        • Optional options: any

        Returns AxiosPromise<Hook>

    • repoEditPullRequest:function
      • summary

        Update a pull request. If using deadline only the date will be taken into account, and time of day ignored.

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the pull request to edit

        • Optional body: EditPullRequestOption
        • Optional options: any

        Returns AxiosPromise<PullRequest>

    • repoEditRelease:function
      • repoEditRelease(owner: string, repo: string, id: number, body?: EditReleaseOption, options?: any): AxiosPromise<Release>
      • summary

        Update a release

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • id: number

          id of the release to edit

        • Optional body: EditReleaseOption
        • Optional options: any

        Returns AxiosPromise<Release>

    • repoEditReleaseAttachment:function
      • repoEditReleaseAttachment(owner: string, repo: string, id: number, attachmentId: number, body?: EditAttachmentOptions, options?: any): AxiosPromise<Attachment>
      • summary

        Edit a release attachment

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • id: number

          id of the release

        • attachmentId: number

          id of the attachment to edit

        • Optional body: EditAttachmentOptions
        • Optional options: any

        Returns AxiosPromise<Attachment>

    • repoEditWikiPage:function
      • summary

        Edit a wiki page

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • pageName: string

          name of the page

        • Optional body: CreateWikiPageOptions
        • Optional options: any

        Returns AxiosPromise<WikiPage>

    • repoGet:function
      • repoGet(owner: string, repo: string, options?: any): AxiosPromise<Repository>
      • summary

        Get a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional options: any

        Returns AxiosPromise<Repository>

    • repoGetAllCommits:function
      • repoGetAllCommits(owner: string, repo: string, sha?: string, path?: string, page?: number, limit?: number, options?: any): AxiosPromise<Commit[]>
      • summary

        Get a list of all commits from a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional sha: string
        • Optional path: string
        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<Commit[]>

    • repoGetArchive:function
      • repoGetArchive(owner: string, repo: string, archive: string, options?: any): AxiosPromise<void>
      • summary

        Get an archive of a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • archive: string

          the git reference for download with attached archive format (e.g. master.zip)

        • Optional options: any

        Returns AxiosPromise<void>

    • repoGetAssignees:function
      • repoGetAssignees(owner: string, repo: string, options?: any): AxiosPromise<User[]>
      • summary

        Return all users that have write access and can be assigned to issues

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional options: any

        Returns AxiosPromise<User[]>

    • repoGetBranch:function
      • repoGetBranch(owner: string, repo: string, branch: string, options?: any): AxiosPromise<Branch>
      • summary

        Retrieve a specific branch from a repository, including its effective branch protection

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • branch: string

          branch to get

        • Optional options: any

        Returns AxiosPromise<Branch>

    • repoGetBranchProtection:function
      • repoGetBranchProtection(owner: string, repo: string, name: string, options?: any): AxiosPromise<BranchProtection>
      • summary

        Get a specific branch protection for the repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • name: string

          name of protected branch

        • Optional options: any

        Returns AxiosPromise<BranchProtection>

    • repoGetByID:function
      • repoGetByID(id: number, options?: any): AxiosPromise<Repository>
      • summary

        Get a repository by id

        throws

        {RequiredError}

        Parameters

        • id: number

          id of the repo to get

        • Optional options: any

        Returns AxiosPromise<Repository>

    • repoGetCombinedStatusByRef:function
      • repoGetCombinedStatusByRef(owner: string, repo: string, ref: string, page?: number, limit?: number, options?: any): AxiosPromise<CombinedStatus>
      • summary

        Get a commit's combined status, by branch/tag/commit reference

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • ref: string

          name of branch/tag/commit

        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<CombinedStatus>

    • repoGetContents:function
      • repoGetContents(owner: string, repo: string, filepath: string, ref?: string, options?: any): AxiosPromise<ContentsResponse>
      • summary

        Gets the metadata and contents (if a file) of an entry in a repository, or a list of entries if a dir

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • filepath: string

          path of the dir, file, symlink or submodule in the repo

        • Optional ref: string
        • Optional options: any

        Returns AxiosPromise<ContentsResponse>

    • repoGetContentsList:function
      • repoGetContentsList(owner: string, repo: string, ref?: string, options?: any): AxiosPromise<ContentsResponse[]>
      • summary

        Gets the metadata of all the entries of the root dir

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional ref: string
        • Optional options: any

        Returns AxiosPromise<ContentsResponse[]>

    • repoGetEditorConfig:function
      • repoGetEditorConfig(owner: string, repo: string, filepath: string, ref?: string, options?: any): AxiosPromise<void>
      • summary

        Get the EditorConfig definitions of a file in a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • filepath: string

          filepath of file to get

        • Optional ref: string
        • Optional options: any

        Returns AxiosPromise<void>

    • repoGetGitHook:function
      • repoGetGitHook(owner: string, repo: string, id: string, options?: any): AxiosPromise<GitHook>
      • summary

        Get a Git hook

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • id: string

          id of the hook to get

        • Optional options: any

        Returns AxiosPromise<GitHook>

    • repoGetHook:function
      • repoGetHook(owner: string, repo: string, id: number, options?: any): AxiosPromise<Hook>
      • summary

        Get a hook

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • id: number

          id of the hook to get

        • Optional options: any

        Returns AxiosPromise<Hook>

    • repoGetIssueTemplates:function
      • repoGetIssueTemplates(owner: string, repo: string, options?: any): AxiosPromise<IssueTemplate[]>
      • summary

        Get available issue templates for a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional options: any

        Returns AxiosPromise<IssueTemplate[]>

    • repoGetKey:function
      • repoGetKey(owner: string, repo: string, id: number, options?: any): AxiosPromise<DeployKey>
      • summary

        Get a repository's key by id

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • id: number

          id of the key to get

        • Optional options: any

        Returns AxiosPromise<DeployKey>

    • repoGetLanguages:function
      • repoGetLanguages(owner: string, repo: string, options?: any): AxiosPromise<{}>
      • summary

        Get languages and number of bytes of code written

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional options: any

        Returns AxiosPromise<{}>

    • repoGetNote:function
      • repoGetNote(owner: string, repo: string, sha: string, options?: any): AxiosPromise<Note>
      • summary

        Get a note corresponding to a single commit from a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • sha: string

          a git ref or commit sha

        • Optional options: any

        Returns AxiosPromise<Note>

    • repoGetPullRequest:function
      • repoGetPullRequest(owner: string, repo: string, index: number, options?: any): AxiosPromise<PullRequest>
      • summary

        Get a pull request

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the pull request to get

        • Optional options: any

        Returns AxiosPromise<PullRequest>

    • repoGetPullRequestCommits:function
      • repoGetPullRequestCommits(owner: string, repo: string, index: number, page?: number, limit?: number, options?: any): AxiosPromise<Commit[]>
      • summary

        Get commits for a pull request

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the pull request to get

        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<Commit[]>

    • repoGetPullReview:function
      • repoGetPullReview(owner: string, repo: string, index: number, id: number, options?: any): AxiosPromise<PullReview>
      • summary

        Get a specific review for a pull request

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the pull request

        • id: number

          id of the review

        • Optional options: any

        Returns AxiosPromise<PullReview>

    • repoGetPullReviewComments:function
      • repoGetPullReviewComments(owner: string, repo: string, index: number, id: number, options?: any): AxiosPromise<PullReviewComment[]>
      • summary

        Get a specific review for a pull request

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the pull request

        • id: number

          id of the review

        • Optional options: any

        Returns AxiosPromise<PullReviewComment[]>

    • repoGetRawFile:function
      • repoGetRawFile(owner: string, repo: string, filepath: string, ref?: string, options?: any): AxiosPromise<void>
      • summary

        Get a file from a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • filepath: string

          filepath of the file to get

        • Optional ref: string
        • Optional options: any

        Returns AxiosPromise<void>

    • repoGetRawFileOrLFS:function
      • repoGetRawFileOrLFS(owner: string, repo: string, filepath: string, ref?: string, options?: any): AxiosPromise<void>
      • summary

        Get a file or it's LFS object from a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • filepath: string

          filepath of the file to get

        • Optional ref: string
        • Optional options: any

        Returns AxiosPromise<void>

    • repoGetRelease:function
      • repoGetRelease(owner: string, repo: string, id: number, options?: any): AxiosPromise<Release>
      • summary

        Get a release

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • id: number

          id of the release to get

        • Optional options: any

        Returns AxiosPromise<Release>

    • repoGetReleaseAttachment:function
      • repoGetReleaseAttachment(owner: string, repo: string, id: number, attachmentId: number, options?: any): AxiosPromise<Attachment>
      • summary

        Get a release attachment

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • id: number

          id of the release

        • attachmentId: number

          id of the attachment to get

        • Optional options: any

        Returns AxiosPromise<Attachment>

    • repoGetReleaseByTag:function
      • repoGetReleaseByTag(owner: string, repo: string, tag: string, options?: any): AxiosPromise<Release>
      • summary

        Get a release by tag name

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • tag: string

          tag name of the release to get

        • Optional options: any

        Returns AxiosPromise<Release>

    • repoGetRepoPermissions:function
      • repoGetRepoPermissions(owner: string, repo: string, collaborator: string, options?: any): AxiosPromise<RepoCollaboratorPermission>
      • summary

        Get repository permissions for a user

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • collaborator: string

          username of the collaborator

        • Optional options: any

        Returns AxiosPromise<RepoCollaboratorPermission>

    • repoGetReviewers:function
      • repoGetReviewers(owner: string, repo: string, options?: any): AxiosPromise<User[]>
      • summary

        Return all users that can be requested to review in this repo

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional options: any

        Returns AxiosPromise<User[]>

    • repoGetSingleCommit:function
      • repoGetSingleCommit(owner: string, repo: string, sha: string, options?: any): AxiosPromise<Commit>
      • summary

        Get a single commit from a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • sha: string

          a git ref or commit sha

        • Optional options: any

        Returns AxiosPromise<Commit>

    • repoGetTag:function
      • repoGetTag(owner: string, repo: string, tag: string, options?: any): AxiosPromise<Tag>
      • summary

        Get the tag of a repository by tag name

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • tag: string

          name of tag

        • Optional options: any

        Returns AxiosPromise<Tag>

    • repoGetWikiPage:function
      • repoGetWikiPage(owner: string, repo: string, pageName: string, options?: any): AxiosPromise<WikiPage>
      • summary

        Get a wiki page

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • pageName: string

          name of the page

        • Optional options: any

        Returns AxiosPromise<WikiPage>

    • repoGetWikiPageRevisions:function
      • repoGetWikiPageRevisions(owner: string, repo: string, pageName: string, page?: number, options?: any): AxiosPromise<WikiCommitList>
      • summary

        Get revisions of a wiki page

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • pageName: string

          name of the page

        • Optional page: number
        • Optional options: any

        Returns AxiosPromise<WikiCommitList>

    • repoGetWikiPages:function
      • repoGetWikiPages(owner: string, repo: string, page?: number, limit?: number, options?: any): AxiosPromise<WikiPageMetaData[]>
      • summary

        Get all wiki pages

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<WikiPageMetaData[]>

    • repoListAllGitRefs:function
      • repoListAllGitRefs(owner: string, repo: string, options?: any): AxiosPromise<Reference[]>
      • summary

        Get specified ref or filtered repository's refs

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional options: any

        Returns AxiosPromise<Reference[]>

    • repoListBranchProtection:function
      • repoListBranchProtection(owner: string, repo: string, options?: any): AxiosPromise<BranchProtection[]>
      • summary

        List branch protections for a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional options: any

        Returns AxiosPromise<BranchProtection[]>

    • repoListBranches:function
      • repoListBranches(owner: string, repo: string, page?: number, limit?: number, options?: any): AxiosPromise<Branch[]>
      • summary

        List a repository's branches

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<Branch[]>

    • repoListCollaborators:function
      • repoListCollaborators(owner: string, repo: string, page?: number, limit?: number, options?: any): AxiosPromise<User[]>
      • summary

        List a repository's collaborators

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<User[]>

    • repoListGitHooks:function
      • repoListGitHooks(owner: string, repo: string, options?: any): AxiosPromise<GitHook[]>
      • summary

        List the Git hooks in a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional options: any

        Returns AxiosPromise<GitHook[]>

    • repoListGitRefs:function
      • repoListGitRefs(owner: string, repo: string, ref: string, options?: any): AxiosPromise<Reference[]>
      • summary

        Get specified ref or filtered repository's refs

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • ref: string

          part or full name of the ref

        • Optional options: any

        Returns AxiosPromise<Reference[]>

    • repoListHooks:function
      • repoListHooks(owner: string, repo: string, page?: number, limit?: number, options?: any): AxiosPromise<Hook[]>
      • summary

        List the hooks in a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<Hook[]>

    • repoListKeys:function
      • repoListKeys(owner: string, repo: string, keyId?: number, fingerprint?: string, page?: number, limit?: number, options?: any): AxiosPromise<DeployKey[]>
      • summary

        List a repository's keys

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional keyId: number
        • Optional fingerprint: string
        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<DeployKey[]>

    • repoListPullRequests:function
      • repoListPullRequests(owner: string, repo: string, state?: "all" | "closed" | "open", sort?: "priority" | "oldest" | "recentupdate" | "leastupdate" | "mostcomment" | "leastcomment", milestone?: number, labels?: number[], page?: number, limit?: number, options?: any): AxiosPromise<PullRequest[]>
      • summary

        List a repo's pull requests

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional state: "all" | "closed" | "open"
        • Optional sort: "priority" | "oldest" | "recentupdate" | "leastupdate" | "mostcomment" | "leastcomment"
        • Optional milestone: number
        • Optional labels: number[]
        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<PullRequest[]>

    • repoListPullReviews:function
      • repoListPullReviews(owner: string, repo: string, index: number, page?: number, limit?: number, options?: any): AxiosPromise<PullReview[]>
      • summary

        List all reviews for a pull request

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the pull request

        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<PullReview[]>

    • repoListReleaseAttachments:function
      • repoListReleaseAttachments(owner: string, repo: string, id: number, options?: any): AxiosPromise<Attachment[]>
      • summary

        List release's attachments

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • id: number

          id of the release

        • Optional options: any

        Returns AxiosPromise<Attachment[]>

    • repoListReleases:function
      • repoListReleases(owner: string, repo: string, draft?: boolean, preRelease?: boolean, perPage?: number, page?: number, limit?: number, options?: any): AxiosPromise<Release[]>
      • summary

        List a repo's releases

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional draft: boolean
        • Optional preRelease: boolean
        • Optional perPage: number
        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<Release[]>

    • repoListStargazers:function
      • repoListStargazers(owner: string, repo: string, page?: number, limit?: number, options?: any): AxiosPromise<User[]>
      • summary

        List a repo's stargazers

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<User[]>

    • repoListStatuses:function
      • repoListStatuses(owner: string, repo: string, sha: string, sort?: "oldest" | "recentupdate" | "leastupdate" | "leastindex" | "highestindex", state?: "error" | "pending" | "success" | "failure" | "warning", page?: number, limit?: number, options?: any): AxiosPromise<CommitStatus[]>
      • summary

        Get a commit's statuses

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • sha: string

          sha of the commit

        • Optional sort: "oldest" | "recentupdate" | "leastupdate" | "leastindex" | "highestindex"
        • Optional state: "error" | "pending" | "success" | "failure" | "warning"
        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<CommitStatus[]>

    • repoListStatusesByRef:function
      • repoListStatusesByRef(owner: string, repo: string, ref: string, sort?: "oldest" | "recentupdate" | "leastupdate" | "leastindex" | "highestindex", state?: "error" | "pending" | "success" | "failure" | "warning", page?: number, limit?: number, options?: any): AxiosPromise<CommitStatus[]>
      • summary

        Get a commit's statuses, by branch/tag/commit reference

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • ref: string

          name of branch/tag/commit

        • Optional sort: "oldest" | "recentupdate" | "leastupdate" | "leastindex" | "highestindex"
        • Optional state: "error" | "pending" | "success" | "failure" | "warning"
        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<CommitStatus[]>

    • repoListSubscribers:function
      • repoListSubscribers(owner: string, repo: string, page?: number, limit?: number, options?: any): AxiosPromise<User[]>
      • summary

        List a repo's watchers

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<User[]>

    • repoListTags:function
      • repoListTags(owner: string, repo: string, page?: number, limit?: number, options?: any): AxiosPromise<Tag[]>
      • summary

        List a repository's tags

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<Tag[]>

    • repoListTeams:function
      • repoListTeams(owner: string, repo: string, options?: any): AxiosPromise<Team[]>
      • summary

        List a repository's teams

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional options: any

        Returns AxiosPromise<Team[]>

    • repoListTopics:function
      • repoListTopics(owner: string, repo: string, page?: number, limit?: number, options?: any): AxiosPromise<TopicName>
      • summary

        Get list of topics that a repository has

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<TopicName>

    • repoMergePullRequest:function
      • repoMergePullRequest(owner: string, repo: string, index: number, body?: MergePullRequestOption, options?: any): AxiosPromise<void>
      • summary

        Merge a pull request

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the pull request to merge

        • Optional body: MergePullRequestOption
        • Optional options: any

        Returns AxiosPromise<void>

    • repoMigrate:function
      • summary

        Migrate a remote git repository

        throws

        {RequiredError}

        Parameters

        Returns AxiosPromise<Repository>

    • repoMirrorSync:function
      • repoMirrorSync(owner: string, repo: string, options?: any): AxiosPromise<void>
      • summary

        Sync a mirrored repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo to sync

        • repo: string

          name of the repo to sync

        • Optional options: any

        Returns AxiosPromise<void>

    • repoPullRequestIsMerged:function
      • repoPullRequestIsMerged(owner: string, repo: string, index: number, options?: any): AxiosPromise<void>
      • summary

        Check if a pull request has been merged

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the pull request

        • Optional options: any

        Returns AxiosPromise<void>

    • repoSearch:function
      • repoSearch(q?: string, topic?: boolean, includeDesc?: boolean, uid?: number, priorityOwnerId?: number, teamId?: number, starredBy?: number, _private?: boolean, isPrivate?: boolean, template?: boolean, archived?: boolean, mode?: string, exclusive?: boolean, repo?: string, owner?: string, lang?: string, subject?: string, book?: string, includeMetadata?: boolean, sort?: string, order?: string, page?: number, limit?: number, options?: any): AxiosPromise<SearchResults>
      • summary

        Search for repositories

        throws

        {RequiredError}

        Parameters

        • Optional q: string
        • Optional topic: boolean
        • Optional includeDesc: boolean
        • Optional uid: number
        • Optional priorityOwnerId: number
        • Optional teamId: number
        • Optional starredBy: number
        • Optional _private: boolean
        • Optional isPrivate: boolean
        • Optional template: boolean
        • Optional archived: boolean
        • Optional mode: string
        • Optional exclusive: boolean
        • Optional repo: string
        • Optional owner: string
        • Optional lang: string
        • Optional subject: string
        • Optional book: string
        • Optional includeMetadata: boolean
        • Optional sort: string
        • Optional order: string
        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<SearchResults>

    • repoSigningKey:function
      • repoSigningKey(owner: string, repo: string, options?: any): AxiosPromise<string>
      • summary

        Get signing-key.gpg for given repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional options: any

        Returns AxiosPromise<string>

    • repoSubmitPullReview:function
      • summary

        Submit a pending review to an pull request

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the pull request

        • id: number

          id of the review

        • body: SubmitPullReviewOptions
        • Optional options: any

        Returns AxiosPromise<PullReview>

    • repoTestHook:function
      • repoTestHook(owner: string, repo: string, id: number, ref?: string, options?: any): AxiosPromise<void>
      • summary

        Test a push webhook

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • id: number

          id of the hook to test

        • Optional ref: string
        • Optional options: any

        Returns AxiosPromise<void>

    • repoTrackedTimes:function
      • repoTrackedTimes(owner: string, repo: string, user?: string, since?: string, before?: string, page?: number, limit?: number, options?: any): AxiosPromise<TrackedTime[]>
      • summary

        List a repo's tracked times

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional user: string
        • Optional since: string
        • Optional before: string
        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<TrackedTime[]>

    • repoTransfer:function
      • summary

        Transfer a repo ownership

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo to transfer

        • repo: string

          name of the repo to transfer

        • body: TransferRepoOption

          Transfer Options

        • Optional options: any

        Returns AxiosPromise<Repository>

    • repoUnDismissPullReview:function
      • repoUnDismissPullReview(owner: string, repo: string, index: number, id: number, options?: any): AxiosPromise<PullReview>
      • summary

        Cancel to dismiss a review for a pull request

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the pull request

        • id: number

          id of the review

        • Optional options: any

        Returns AxiosPromise<PullReview>

    • repoUpdateFile:function
      • summary

        Update a file in a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • filepath: string

          path of the file to update

        • body: UpdateFileOptions
        • Optional options: any

        Returns AxiosPromise<FileResponse>

    • repoUpdateGitRef:function
      • summary

        Update a reference

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • ref: string

          name of the ref to update

        • Optional body: UpdateGitRefOption
        • Optional options: any

        Returns AxiosPromise<Reference>

    • repoUpdatePullRequest:function
      • repoUpdatePullRequest(owner: string, repo: string, index: number, style?: "merge" | "rebase", options?: any): AxiosPromise<void>
      • summary

        Merge PR's baseBranch into headBranch

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the pull request to get

        • Optional style: "merge" | "rebase"
        • Optional options: any

        Returns AxiosPromise<void>

    • repoUpdateTopics:function
      • repoUpdateTopics(owner: string, repo: string, body?: RepoTopicOptions, options?: any): AxiosPromise<void>
      • summary

        Replace list of topics for a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional body: RepoTopicOptions
        • Optional options: any

        Returns AxiosPromise<void>

    • topicSearch:function
      • topicSearch(q: string, page?: number, limit?: number, options?: any): AxiosPromise<TopicResponse[]>
      • summary

        search topics via keyword

        throws

        {RequiredError}

        Parameters

        • q: string

          keywords to search

        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<TopicResponse[]>

    • userCurrentCheckSubscription:function
      • userCurrentCheckSubscription(owner: string, repo: string, options?: any): AxiosPromise<WatchInfo>
      • summary

        Check if the current user is watching a repo

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional options: any

        Returns AxiosPromise<WatchInfo>

    • userCurrentDeleteSubscription:function
      • userCurrentDeleteSubscription(owner: string, repo: string, options?: any): AxiosPromise<void>
      • summary

        Unwatch a repo

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional options: any

        Returns AxiosPromise<void>

    • userCurrentPutSubscription:function
      • userCurrentPutSubscription(owner: string, repo: string, options?: any): AxiosPromise<WatchInfo>
      • summary

        Watch a repo

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional options: any

        Returns AxiosPromise<WatchInfo>

    • userTrackedTimes:function
      • userTrackedTimes(owner: string, repo: string, user: string, options?: any): AxiosPromise<TrackedTime[]>
      • summary

        List a user's tracked times in a repo

        deprecated
        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • user: string

          username of user

        • Optional options: any

        Returns AxiosPromise<TrackedTime[]>

RepositoryApiFp

  • RepositoryApiFp(configuration?: Configuration): { acceptRepoTransfer: any; createCurrentUserRepo: any; createFork: any; generateRepo: any; getAnnotatedTag: any; getBlob: any; getTree: any; listForks: any; rejectRepoTransfer: any; repoAddCollaborator: any; repoAddTeam: any; repoAddTopic: any; repoApplyDiffPatch: any; repoCancelScheduledAutoMerge: any; repoCheckCollaborator: any; repoCheckTeam: any; repoCreateBranch: any; repoCreateBranchProtection: any; repoCreateFile: any; repoCreateGitRef: any; repoCreateHook: any; repoCreateKey: any; repoCreatePullRequest: any; repoCreatePullReview: any; repoCreatePullReviewRequests: any; repoCreateRelease: any; repoCreateReleaseAttachment: any; repoCreateStatus: any; repoCreateTag: any; repoCreateWikiPage: any; repoDelete: any; repoDeleteBranch: any; repoDeleteBranchProtection: any; repoDeleteCollaborator: any; repoDeleteFile: any; repoDeleteGitHook: any; repoDeleteGitRef: any; repoDeleteHook: any; repoDeleteKey: any; repoDeletePullReview: any; repoDeletePullReviewRequests: any; repoDeleteRelease: any; repoDeleteReleaseAttachment: any; repoDeleteReleaseByTag: any; repoDeleteTag: any; repoDeleteTeam: any; repoDeleteTopic: any; repoDeleteWikiPage: any; repoDismissPullReview: any; repoDownloadCommitDiffOrPatch: any; repoDownloadPullDiffOrPatch: any; repoEdit: any; repoEditBranchProtection: any; repoEditGitHook: any; repoEditHook: any; repoEditPullRequest: any; repoEditRelease: any; repoEditReleaseAttachment: any; repoEditWikiPage: any; repoGet: any; repoGetAllCommits: any; repoGetArchive: any; repoGetAssignees: any; repoGetBranch: any; repoGetBranchProtection: any; repoGetByID: any; repoGetCombinedStatusByRef: any; repoGetContents: any; repoGetContentsList: any; repoGetEditorConfig: any; repoGetGitHook: any; repoGetHook: any; repoGetIssueTemplates: any; repoGetKey: any; repoGetLanguages: any; repoGetNote: any; repoGetPullRequest: any; repoGetPullRequestCommits: any; repoGetPullReview: any; repoGetPullReviewComments: any; repoGetRawFile: any; repoGetRawFileOrLFS: any; repoGetRelease: any; repoGetReleaseAttachment: any; repoGetReleaseByTag: any; repoGetRepoPermissions: any; repoGetReviewers: any; repoGetSingleCommit: any; repoGetTag: any; repoGetWikiPage: any; repoGetWikiPageRevisions: any; repoGetWikiPages: any; repoListAllGitRefs: any; repoListBranchProtection: any; repoListBranches: any; repoListCollaborators: any; repoListGitHooks: any; repoListGitRefs: any; repoListHooks: any; repoListKeys: any; repoListPullRequests: any; repoListPullReviews: any; repoListReleaseAttachments: any; repoListReleases: any; repoListStargazers: any; repoListStatuses: any; repoListStatusesByRef: any; repoListSubscribers: any; repoListTags: any; repoListTeams: any; repoListTopics: any; repoMergePullRequest: any; repoMigrate: any; repoMirrorSync: any; repoPullRequestIsMerged: any; repoSearch: any; repoSigningKey: any; repoSubmitPullReview: any; repoTestHook: any; repoTrackedTimes: any; repoTransfer: any; repoUnDismissPullReview: any; repoUpdateFile: any; repoUpdateGitRef: any; repoUpdatePullRequest: any; repoUpdateTopics: any; topicSearch: any; userCurrentCheckSubscription: any; userCurrentDeleteSubscription: any; userCurrentPutSubscription: any; userTrackedTimes: any }

  • RepositoryApi - functional programming interface

    export

    Parameters

    Returns { acceptRepoTransfer: any; createCurrentUserRepo: any; createFork: any; generateRepo: any; getAnnotatedTag: any; getBlob: any; getTree: any; listForks: any; rejectRepoTransfer: any; repoAddCollaborator: any; repoAddTeam: any; repoAddTopic: any; repoApplyDiffPatch: any; repoCancelScheduledAutoMerge: any; repoCheckCollaborator: any; repoCheckTeam: any; repoCreateBranch: any; repoCreateBranchProtection: any; repoCreateFile: any; repoCreateGitRef: any; repoCreateHook: any; repoCreateKey: any; repoCreatePullRequest: any; repoCreatePullReview: any; repoCreatePullReviewRequests: any; repoCreateRelease: any; repoCreateReleaseAttachment: any; repoCreateStatus: any; repoCreateTag: any; repoCreateWikiPage: any; repoDelete: any; repoDeleteBranch: any; repoDeleteBranchProtection: any; repoDeleteCollaborator: any; repoDeleteFile: any; repoDeleteGitHook: any; repoDeleteGitRef: any; repoDeleteHook: any; repoDeleteKey: any; repoDeletePullReview: any; repoDeletePullReviewRequests: any; repoDeleteRelease: any; repoDeleteReleaseAttachment: any; repoDeleteReleaseByTag: any; repoDeleteTag: any; repoDeleteTeam: any; repoDeleteTopic: any; repoDeleteWikiPage: any; repoDismissPullReview: any; repoDownloadCommitDiffOrPatch: any; repoDownloadPullDiffOrPatch: any; repoEdit: any; repoEditBranchProtection: any; repoEditGitHook: any; repoEditHook: any; repoEditPullRequest: any; repoEditRelease: any; repoEditReleaseAttachment: any; repoEditWikiPage: any; repoGet: any; repoGetAllCommits: any; repoGetArchive: any; repoGetAssignees: any; repoGetBranch: any; repoGetBranchProtection: any; repoGetByID: any; repoGetCombinedStatusByRef: any; repoGetContents: any; repoGetContentsList: any; repoGetEditorConfig: any; repoGetGitHook: any; repoGetHook: any; repoGetIssueTemplates: any; repoGetKey: any; repoGetLanguages: any; repoGetNote: any; repoGetPullRequest: any; repoGetPullRequestCommits: any; repoGetPullReview: any; repoGetPullReviewComments: any; repoGetRawFile: any; repoGetRawFileOrLFS: any; repoGetRelease: any; repoGetReleaseAttachment: any; repoGetReleaseByTag: any; repoGetRepoPermissions: any; repoGetReviewers: any; repoGetSingleCommit: any; repoGetTag: any; repoGetWikiPage: any; repoGetWikiPageRevisions: any; repoGetWikiPages: any; repoListAllGitRefs: any; repoListBranchProtection: any; repoListBranches: any; repoListCollaborators: any; repoListGitHooks: any; repoListGitRefs: any; repoListHooks: any; repoListKeys: any; repoListPullRequests: any; repoListPullReviews: any; repoListReleaseAttachments: any; repoListReleases: any; repoListStargazers: any; repoListStatuses: any; repoListStatusesByRef: any; repoListSubscribers: any; repoListTags: any; repoListTeams: any; repoListTopics: any; repoMergePullRequest: any; repoMigrate: any; repoMirrorSync: any; repoPullRequestIsMerged: any; repoSearch: any; repoSigningKey: any; repoSubmitPullReview: any; repoTestHook: any; repoTrackedTimes: any; repoTransfer: any; repoUnDismissPullReview: any; repoUpdateFile: any; repoUpdateGitRef: any; repoUpdatePullRequest: any; repoUpdateTopics: any; topicSearch: any; userCurrentCheckSubscription: any; userCurrentDeleteSubscription: any; userCurrentPutSubscription: any; userTrackedTimes: any }

    • acceptRepoTransfer:function
      • acceptRepoTransfer(owner: string, repo: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository>)>
      • summary

        Accept a repo transfer

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo to transfer

        • repo: string

          name of the repo to transfer

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository>)>

    • createCurrentUserRepo:function
      • createCurrentUserRepo(body?: CreateRepoOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository>)>
      • summary

        Create a repository

        throws

        {RequiredError}

        Parameters

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository>)>

    • createFork:function
      • createFork(owner: string, repo: string, body?: CreateForkOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository>)>
      • summary

        Fork a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo to fork

        • repo: string

          name of the repo to fork

        • Optional body: CreateForkOption
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository>)>

    • generateRepo:function
      • generateRepo(templateOwner: string, templateRepo: string, body?: GenerateRepoOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository>)>
      • summary

        Create a repository using a template

        throws

        {RequiredError}

        Parameters

        • templateOwner: string

          name of the template repository owner

        • templateRepo: string

          name of the template repository

        • Optional body: GenerateRepoOption
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository>)>

    • getAnnotatedTag:function
      • getAnnotatedTag(owner: string, repo: string, sha: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<AnnotatedTag>)>
      • summary

        Gets the tag object of an annotated tag (not lightweight tags)

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • sha: string

          sha of the tag. The Git tags API only supports annotated tag objects, not lightweight tags.

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<AnnotatedTag>)>

    • getBlob:function
      • getBlob(owner: string, repo: string, sha: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<GitBlobResponse>)>
      • summary

        Gets the blob of a repository.

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • sha: string

          sha of the commit

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<GitBlobResponse>)>

    • getTree:function
      • getTree(owner: string, repo: string, sha: string, recursive?: boolean, page?: number, perPage?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<GitTreeResponse>)>
      • summary

        Gets the tree of a repository.

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • sha: string

          sha of the commit

        • Optional recursive: boolean
        • Optional page: number
        • Optional perPage: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<GitTreeResponse>)>

    • listForks:function
      • listForks(owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository[]>)>
      • summary

        List a repository's forks

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository[]>)>

    • rejectRepoTransfer:function
      • rejectRepoTransfer(owner: string, repo: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository>)>
      • summary

        Reject a repo transfer

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo to transfer

        • repo: string

          name of the repo to transfer

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository>)>

    • repoAddCollaborator:function
      • repoAddCollaborator(owner: string, repo: string, collaborator: string, body?: AddCollaboratorOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Add a collaborator to a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • collaborator: string

          username of the collaborator to add

        • Optional body: AddCollaboratorOption
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • repoAddTeam:function
      • repoAddTeam(owner: string, repo: string, team: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Add a team to a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • team: string

          team name

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • repoAddTopic:function
      • repoAddTopic(owner: string, repo: string, topic: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Add a topic to a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • topic: string

          name of the topic to add

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • repoApplyDiffPatch:function
      • repoApplyDiffPatch(owner: string, repo: string, body: UpdateFileOptions, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileResponse>)>
      • summary

        Apply diff patch to repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • body: UpdateFileOptions
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileResponse>)>

    • repoCancelScheduledAutoMerge:function
      • repoCancelScheduledAutoMerge(owner: string, repo: string, index: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Cancel the scheduled auto merge for the given pull request

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the pull request to merge

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • repoCheckCollaborator:function
      • repoCheckCollaborator(owner: string, repo: string, collaborator: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Check if a user is a collaborator of a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • collaborator: string

          username of the collaborator

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • repoCheckTeam:function
      • repoCheckTeam(owner: string, repo: string, team: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Team>)>
      • summary

        Check if a team is assigned to a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • team: string

          team name

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Team>)>

    • repoCreateBranch:function
      • repoCreateBranch(owner: string, repo: string, body?: CreateBranchRepoOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Branch>)>
      • summary

        Create a branch

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional body: CreateBranchRepoOption
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Branch>)>

    • repoCreateBranchProtection:function
      • summary

        Create a branch protections for a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional body: CreateBranchProtectionOption
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BranchProtection>)>

    • repoCreateFile:function
      • repoCreateFile(owner: string, repo: string, filepath: string, body: CreateFileOptions, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileResponse>)>
      • summary

        Create a file in a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • filepath: string

          path of the file to create

        • body: CreateFileOptions
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileResponse>)>

    • repoCreateGitRef:function
      • repoCreateGitRef(owner: string, repo: string, body?: CreateGitRefOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Reference>)>

      • Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches.

        summary

        Create a reference

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional body: CreateGitRefOption
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Reference>)>

    • repoCreateHook:function
      • repoCreateHook(owner: string, repo: string, body?: CreateHookOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Hook>)>
      • summary

        Create a hook

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional body: CreateHookOption
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Hook>)>

    • repoCreateKey:function
      • repoCreateKey(owner: string, repo: string, body?: CreateKeyOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeployKey>)>
      • summary

        Add a key to a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional body: CreateKeyOption
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeployKey>)>

    • repoCreatePullRequest:function
      • repoCreatePullRequest(owner: string, repo: string, body?: CreatePullRequestOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PullRequest>)>
      • summary

        Create a pull request

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional body: CreatePullRequestOption
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PullRequest>)>

    • repoCreatePullReview:function
      • repoCreatePullReview(owner: string, repo: string, index: number, body: CreatePullReviewOptions, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PullReview>)>
      • summary

        Create a review to an pull request

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the pull request

        • body: CreatePullReviewOptions
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PullReview>)>

    • repoCreatePullReviewRequests:function
      • repoCreatePullReviewRequests(owner: string, repo: string, index: number, body: PullReviewRequestOptions, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PullReview[]>)>
      • summary

        create review requests for a pull request

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the pull request

        • body: PullReviewRequestOptions
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PullReview[]>)>

    • repoCreateRelease:function
      • repoCreateRelease(owner: string, repo: string, body?: CreateReleaseOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Release>)>
      • summary

        Create a release

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional body: CreateReleaseOption
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Release>)>

    • repoCreateReleaseAttachment:function
      • repoCreateReleaseAttachment(owner: string, repo: string, id: number, attachment: File, name?: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Attachment>)>
      • summary

        Create a release attachment

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • id: number

          id of the release

        • attachment: File

          attachment to upload

        • Optional name: string
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Attachment>)>

    • repoCreateStatus:function
      • repoCreateStatus(owner: string, repo: string, sha: string, body?: CreateStatusOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommitStatus>)>
      • summary

        Create a commit status

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • sha: string

          sha of the commit

        • Optional body: CreateStatusOption
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommitStatus>)>

    • repoCreateTag:function
      • repoCreateTag(owner: string, repo: string, body?: CreateTagOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Tag>)>
      • summary

        Create a new git tag in a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional body: CreateTagOption
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Tag>)>

    • repoCreateWikiPage:function
      • repoCreateWikiPage(owner: string, repo: string, body?: CreateWikiPageOptions, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<WikiPage>)>
      • summary

        Create a wiki page

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional body: CreateWikiPageOptions
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<WikiPage>)>

    • repoDelete:function
      • repoDelete(owner: string, repo: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Delete a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo to delete

        • repo: string

          name of the repo to delete

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • repoDeleteBranch:function
      • repoDeleteBranch(owner: string, repo: string, branch: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Delete a specific branch from a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • branch: string

          branch to delete

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • repoDeleteBranchProtection:function
      • repoDeleteBranchProtection(owner: string, repo: string, name: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Delete a specific branch protection for the repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • name: string

          name of protected branch

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • repoDeleteCollaborator:function
      • repoDeleteCollaborator(owner: string, repo: string, collaborator: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Delete a collaborator from a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • collaborator: string

          username of the collaborator to delete

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • repoDeleteFile:function
      • repoDeleteFile(owner: string, repo: string, filepath: string, body: DeleteFileOptions, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileDeleteResponse>)>
      • summary

        Delete a file in a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • filepath: string

          path of the file to delete

        • body: DeleteFileOptions
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileDeleteResponse>)>

    • repoDeleteGitHook:function
      • repoDeleteGitHook(owner: string, repo: string, id: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Delete a Git hook in a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • id: string

          id of the hook to get

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • repoDeleteGitRef:function
      • repoDeleteGitRef(owner: string, repo: string, ref: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Delete a reference

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • ref: string

          name of the ref to be deleted

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • repoDeleteHook:function
      • repoDeleteHook(owner: string, repo: string, id: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Delete a hook in a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • id: number

          id of the hook to delete

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • repoDeleteKey:function
      • repoDeleteKey(owner: string, repo: string, id: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Delete a key from a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • id: number

          id of the key to delete

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • repoDeletePullReview:function
      • repoDeletePullReview(owner: string, repo: string, index: number, id: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Delete a specific review from a pull request

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the pull request

        • id: number

          id of the review

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • repoDeletePullReviewRequests:function
      • repoDeletePullReviewRequests(owner: string, repo: string, index: number, body: PullReviewRequestOptions, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        cancel review requests for a pull request

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the pull request

        • body: PullReviewRequestOptions
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • repoDeleteRelease:function
      • repoDeleteRelease(owner: string, repo: string, id: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Delete a release

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • id: number

          id of the release to delete

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • repoDeleteReleaseAttachment:function
      • repoDeleteReleaseAttachment(owner: string, repo: string, id: number, attachmentId: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Delete a release attachment

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • id: number

          id of the release

        • attachmentId: number

          id of the attachment to delete

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • repoDeleteReleaseByTag:function
      • repoDeleteReleaseByTag(owner: string, repo: string, tag: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Delete a release by tag name

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • tag: string

          tag name of the release to delete

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • repoDeleteTag:function
      • repoDeleteTag(owner: string, repo: string, tag: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Delete a repository's tag by name

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • tag: string

          name of tag to delete

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • repoDeleteTeam:function
      • repoDeleteTeam(owner: string, repo: string, team: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Delete a team from a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • team: string

          team name

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • repoDeleteTopic:function
      • repoDeleteTopic(owner: string, repo: string, topic: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Delete a topic from a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • topic: string

          name of the topic to delete

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • repoDeleteWikiPage:function
      • repoDeleteWikiPage(owner: string, repo: string, pageName: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Delete a wiki page

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • pageName: string

          name of the page

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • repoDismissPullReview:function
      • repoDismissPullReview(owner: string, repo: string, index: number, id: number, body: DismissPullReviewOptions, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PullReview>)>
      • summary

        Dismiss a review for a pull request

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the pull request

        • id: number

          id of the review

        • body: DismissPullReviewOptions
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PullReview>)>

    • repoDownloadCommitDiffOrPatch:function
      • repoDownloadCommitDiffOrPatch(owner: string, repo: string, sha: string, diffType: "patch" | "diff", options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>)>
      • summary

        Get a commit's diff or patch

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • sha: string

          SHA of the commit to get

        • diffType: "patch" | "diff"

          whether the output is diff or patch

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>)>

    • repoDownloadPullDiffOrPatch:function
      • repoDownloadPullDiffOrPatch(owner: string, repo: string, index: number, diffType: "patch" | "diff", binary?: boolean, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>)>
      • summary

        Get a pull request diff or patch

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the pull request to get

        • diffType: "patch" | "diff"

          whether the output is diff or patch

        • Optional binary: boolean
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>)>

    • repoEdit:function
      • repoEdit(owner: string, repo: string, body?: EditRepoOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository>)>
      • summary

        Edit a repository's properties. Only fields that are set will be changed.

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo to edit

        • repo: string

          name of the repo to edit

        • Optional body: EditRepoOption
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository>)>

    • repoEditBranchProtection:function
      • repoEditBranchProtection(owner: string, repo: string, name: string, body?: EditBranchProtectionOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BranchProtection>)>
      • summary

        Edit a branch protections for a repository. Only fields that are set will be changed

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • name: string

          name of protected branch

        • Optional body: EditBranchProtectionOption
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BranchProtection>)>

    • repoEditGitHook:function
      • repoEditGitHook(owner: string, repo: string, id: string, body?: EditGitHookOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<GitHook>)>
      • summary

        Edit a Git hook in a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • id: string

          id of the hook to get

        • Optional body: EditGitHookOption
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<GitHook>)>

    • repoEditHook:function
      • repoEditHook(owner: string, repo: string, id: number, body?: EditHookOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Hook>)>
      • summary

        Edit a hook in a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • id: number

          index of the hook

        • Optional body: EditHookOption
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Hook>)>

    • repoEditPullRequest:function
      • repoEditPullRequest(owner: string, repo: string, index: number, body?: EditPullRequestOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PullRequest>)>
      • summary

        Update a pull request. If using deadline only the date will be taken into account, and time of day ignored.

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the pull request to edit

        • Optional body: EditPullRequestOption
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PullRequest>)>

    • repoEditRelease:function
      • repoEditRelease(owner: string, repo: string, id: number, body?: EditReleaseOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Release>)>
      • summary

        Update a release

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • id: number

          id of the release to edit

        • Optional body: EditReleaseOption
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Release>)>

    • repoEditReleaseAttachment:function
      • repoEditReleaseAttachment(owner: string, repo: string, id: number, attachmentId: number, body?: EditAttachmentOptions, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Attachment>)>
      • summary

        Edit a release attachment

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • id: number

          id of the release

        • attachmentId: number

          id of the attachment to edit

        • Optional body: EditAttachmentOptions
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Attachment>)>

    • repoEditWikiPage:function
      • repoEditWikiPage(owner: string, repo: string, pageName: string, body?: CreateWikiPageOptions, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<WikiPage>)>
      • summary

        Edit a wiki page

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • pageName: string

          name of the page

        • Optional body: CreateWikiPageOptions
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<WikiPage>)>

    • repoGet:function
      • repoGet(owner: string, repo: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository>)>
      • summary

        Get a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository>)>

    • repoGetAllCommits:function
      • repoGetAllCommits(owner: string, repo: string, sha?: string, path?: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Commit[]>)>
      • summary

        Get a list of all commits from a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional sha: string
        • Optional path: string
        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Commit[]>)>

    • repoGetArchive:function
      • repoGetArchive(owner: string, repo: string, archive: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Get an archive of a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • archive: string

          the git reference for download with attached archive format (e.g. master.zip)

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • repoGetAssignees:function
      • repoGetAssignees(owner: string, repo: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<User[]>)>
      • summary

        Return all users that have write access and can be assigned to issues

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<User[]>)>

    • repoGetBranch:function
      • repoGetBranch(owner: string, repo: string, branch: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Branch>)>
      • summary

        Retrieve a specific branch from a repository, including its effective branch protection

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • branch: string

          branch to get

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Branch>)>

    • repoGetBranchProtection:function
      • repoGetBranchProtection(owner: string, repo: string, name: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BranchProtection>)>
      • summary

        Get a specific branch protection for the repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • name: string

          name of protected branch

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BranchProtection>)>

    • repoGetByID:function
      • repoGetByID(id: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository>)>
      • summary

        Get a repository by id

        throws

        {RequiredError}

        Parameters

        • id: number

          id of the repo to get

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository>)>

    • repoGetCombinedStatusByRef:function
      • repoGetCombinedStatusByRef(owner: string, repo: string, ref: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<CombinedStatus>)>
      • summary

        Get a commit's combined status, by branch/tag/commit reference

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • ref: string

          name of branch/tag/commit

        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<CombinedStatus>)>

    • repoGetContents:function
      • repoGetContents(owner: string, repo: string, filepath: string, ref?: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ContentsResponse>)>
      • summary

        Gets the metadata and contents (if a file) of an entry in a repository, or a list of entries if a dir

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • filepath: string

          path of the dir, file, symlink or submodule in the repo

        • Optional ref: string
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ContentsResponse>)>

    • repoGetContentsList:function
      • repoGetContentsList(owner: string, repo: string, ref?: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ContentsResponse[]>)>
      • summary

        Gets the metadata of all the entries of the root dir

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional ref: string
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ContentsResponse[]>)>

    • repoGetEditorConfig:function
      • repoGetEditorConfig(owner: string, repo: string, filepath: string, ref?: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Get the EditorConfig definitions of a file in a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • filepath: string

          filepath of file to get

        • Optional ref: string
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • repoGetGitHook:function
      • repoGetGitHook(owner: string, repo: string, id: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<GitHook>)>
      • summary

        Get a Git hook

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • id: string

          id of the hook to get

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<GitHook>)>

    • repoGetHook:function
      • repoGetHook(owner: string, repo: string, id: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Hook>)>
      • summary

        Get a hook

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • id: number

          id of the hook to get

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Hook>)>

    • repoGetIssueTemplates:function
      • repoGetIssueTemplates(owner: string, repo: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<IssueTemplate[]>)>
      • summary

        Get available issue templates for a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<IssueTemplate[]>)>

    • repoGetKey:function
      • repoGetKey(owner: string, repo: string, id: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeployKey>)>
      • summary

        Get a repository's key by id

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • id: number

          id of the key to get

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeployKey>)>

    • repoGetLanguages:function
      • repoGetLanguages(owner: string, repo: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<{}>)>
      • summary

        Get languages and number of bytes of code written

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<{}>)>

    • repoGetNote:function
      • repoGetNote(owner: string, repo: string, sha: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Note>)>
      • summary

        Get a note corresponding to a single commit from a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • sha: string

          a git ref or commit sha

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Note>)>

    • repoGetPullRequest:function
      • repoGetPullRequest(owner: string, repo: string, index: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PullRequest>)>
      • summary

        Get a pull request

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the pull request to get

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PullRequest>)>

    • repoGetPullRequestCommits:function
      • repoGetPullRequestCommits(owner: string, repo: string, index: number, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Commit[]>)>
      • summary

        Get commits for a pull request

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the pull request to get

        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Commit[]>)>

    • repoGetPullReview:function
      • repoGetPullReview(owner: string, repo: string, index: number, id: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PullReview>)>
      • summary

        Get a specific review for a pull request

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the pull request

        • id: number

          id of the review

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PullReview>)>

    • repoGetPullReviewComments:function
      • repoGetPullReviewComments(owner: string, repo: string, index: number, id: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PullReviewComment[]>)>
      • summary

        Get a specific review for a pull request

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the pull request

        • id: number

          id of the review

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PullReviewComment[]>)>

    • repoGetRawFile:function
      • repoGetRawFile(owner: string, repo: string, filepath: string, ref?: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Get a file from a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • filepath: string

          filepath of the file to get

        • Optional ref: string
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • repoGetRawFileOrLFS:function
      • repoGetRawFileOrLFS(owner: string, repo: string, filepath: string, ref?: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Get a file or it's LFS object from a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • filepath: string

          filepath of the file to get

        • Optional ref: string
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • repoGetRelease:function
      • repoGetRelease(owner: string, repo: string, id: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Release>)>
      • summary

        Get a release

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • id: number

          id of the release to get

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Release>)>

    • repoGetReleaseAttachment:function
      • repoGetReleaseAttachment(owner: string, repo: string, id: number, attachmentId: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Attachment>)>
      • summary

        Get a release attachment

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • id: number

          id of the release

        • attachmentId: number

          id of the attachment to get

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Attachment>)>

    • repoGetReleaseByTag:function
      • repoGetReleaseByTag(owner: string, repo: string, tag: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Release>)>
      • summary

        Get a release by tag name

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • tag: string

          tag name of the release to get

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Release>)>

    • repoGetRepoPermissions:function
      • repoGetRepoPermissions(owner: string, repo: string, collaborator: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<RepoCollaboratorPermission>)>
      • summary

        Get repository permissions for a user

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • collaborator: string

          username of the collaborator

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<RepoCollaboratorPermission>)>

    • repoGetReviewers:function
      • repoGetReviewers(owner: string, repo: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<User[]>)>
      • summary

        Return all users that can be requested to review in this repo

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<User[]>)>

    • repoGetSingleCommit:function
      • repoGetSingleCommit(owner: string, repo: string, sha: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Commit>)>
      • summary

        Get a single commit from a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • sha: string

          a git ref or commit sha

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Commit>)>

    • repoGetTag:function
      • repoGetTag(owner: string, repo: string, tag: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Tag>)>
      • summary

        Get the tag of a repository by tag name

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • tag: string

          name of tag

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Tag>)>

    • repoGetWikiPage:function
      • repoGetWikiPage(owner: string, repo: string, pageName: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<WikiPage>)>
      • summary

        Get a wiki page

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • pageName: string

          name of the page

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<WikiPage>)>

    • repoGetWikiPageRevisions:function
      • repoGetWikiPageRevisions(owner: string, repo: string, pageName: string, page?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<WikiCommitList>)>
      • summary

        Get revisions of a wiki page

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • pageName: string

          name of the page

        • Optional page: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<WikiCommitList>)>

    • repoGetWikiPages:function
      • repoGetWikiPages(owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<WikiPageMetaData[]>)>
      • summary

        Get all wiki pages

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<WikiPageMetaData[]>)>

    • repoListAllGitRefs:function
      • repoListAllGitRefs(owner: string, repo: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Reference[]>)>
      • summary

        Get specified ref or filtered repository's refs

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Reference[]>)>

    • repoListBranchProtection:function
      • repoListBranchProtection(owner: string, repo: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BranchProtection[]>)>
      • summary

        List branch protections for a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BranchProtection[]>)>

    • repoListBranches:function
      • repoListBranches(owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Branch[]>)>
      • summary

        List a repository's branches

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Branch[]>)>

    • repoListCollaborators:function
      • repoListCollaborators(owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<User[]>)>
      • summary

        List a repository's collaborators

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<User[]>)>

    • repoListGitHooks:function
      • repoListGitHooks(owner: string, repo: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<GitHook[]>)>
      • summary

        List the Git hooks in a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<GitHook[]>)>

    • repoListGitRefs:function
      • repoListGitRefs(owner: string, repo: string, ref: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Reference[]>)>
      • summary

        Get specified ref or filtered repository's refs

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • ref: string

          part or full name of the ref

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Reference[]>)>

    • repoListHooks:function
      • repoListHooks(owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Hook[]>)>
      • summary

        List the hooks in a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Hook[]>)>

    • repoListKeys:function
      • repoListKeys(owner: string, repo: string, keyId?: number, fingerprint?: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeployKey[]>)>
      • summary

        List a repository's keys

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional keyId: number
        • Optional fingerprint: string
        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeployKey[]>)>

    • repoListPullRequests:function
      • repoListPullRequests(owner: string, repo: string, state?: "all" | "closed" | "open", sort?: "priority" | "oldest" | "recentupdate" | "leastupdate" | "mostcomment" | "leastcomment", milestone?: number, labels?: number[], page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PullRequest[]>)>
      • summary

        List a repo's pull requests

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional state: "all" | "closed" | "open"
        • Optional sort: "priority" | "oldest" | "recentupdate" | "leastupdate" | "mostcomment" | "leastcomment"
        • Optional milestone: number
        • Optional labels: number[]
        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PullRequest[]>)>

    • repoListPullReviews:function
      • repoListPullReviews(owner: string, repo: string, index: number, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PullReview[]>)>
      • summary

        List all reviews for a pull request

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the pull request

        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PullReview[]>)>

    • repoListReleaseAttachments:function
      • repoListReleaseAttachments(owner: string, repo: string, id: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Attachment[]>)>
      • summary

        List release's attachments

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • id: number

          id of the release

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Attachment[]>)>

    • repoListReleases:function
      • repoListReleases(owner: string, repo: string, draft?: boolean, preRelease?: boolean, perPage?: number, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Release[]>)>
      • summary

        List a repo's releases

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional draft: boolean
        • Optional preRelease: boolean
        • Optional perPage: number
        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Release[]>)>

    • repoListStargazers:function
      • repoListStargazers(owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<User[]>)>
      • summary

        List a repo's stargazers

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<User[]>)>

    • repoListStatuses:function
      • repoListStatuses(owner: string, repo: string, sha: string, sort?: "oldest" | "recentupdate" | "leastupdate" | "leastindex" | "highestindex", state?: "error" | "pending" | "success" | "failure" | "warning", page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommitStatus[]>)>
      • summary

        Get a commit's statuses

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • sha: string

          sha of the commit

        • Optional sort: "oldest" | "recentupdate" | "leastupdate" | "leastindex" | "highestindex"
        • Optional state: "error" | "pending" | "success" | "failure" | "warning"
        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommitStatus[]>)>

    • repoListStatusesByRef:function
      • repoListStatusesByRef(owner: string, repo: string, ref: string, sort?: "oldest" | "recentupdate" | "leastupdate" | "leastindex" | "highestindex", state?: "error" | "pending" | "success" | "failure" | "warning", page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommitStatus[]>)>
      • summary

        Get a commit's statuses, by branch/tag/commit reference

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • ref: string

          name of branch/tag/commit

        • Optional sort: "oldest" | "recentupdate" | "leastupdate" | "leastindex" | "highestindex"
        • Optional state: "error" | "pending" | "success" | "failure" | "warning"
        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommitStatus[]>)>

    • repoListSubscribers:function
      • repoListSubscribers(owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<User[]>)>
      • summary

        List a repo's watchers

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<User[]>)>

    • repoListTags:function
      • repoListTags(owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Tag[]>)>
      • summary

        List a repository's tags

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Tag[]>)>

    • repoListTeams:function
      • repoListTeams(owner: string, repo: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Team[]>)>
      • summary

        List a repository's teams

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Team[]>)>

    • repoListTopics:function
      • repoListTopics(owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<TopicName>)>
      • summary

        Get list of topics that a repository has

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<TopicName>)>

    • repoMergePullRequest:function
      • repoMergePullRequest(owner: string, repo: string, index: number, body?: MergePullRequestOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Merge a pull request

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the pull request to merge

        • Optional body: MergePullRequestOption
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • repoMigrate:function
      • repoMigrate(body?: MigrateRepoOptions, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository>)>
      • summary

        Migrate a remote git repository

        throws

        {RequiredError}

        Parameters

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository>)>

    • repoMirrorSync:function
      • repoMirrorSync(owner: string, repo: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Sync a mirrored repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo to sync

        • repo: string

          name of the repo to sync

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • repoPullRequestIsMerged:function
      • repoPullRequestIsMerged(owner: string, repo: string, index: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Check if a pull request has been merged

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the pull request

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • repoSearch:function
      • repoSearch(q?: string, topic?: boolean, includeDesc?: boolean, uid?: number, priorityOwnerId?: number, teamId?: number, starredBy?: number, _private?: boolean, isPrivate?: boolean, template?: boolean, archived?: boolean, mode?: string, exclusive?: boolean, repo?: string, owner?: string, lang?: string, subject?: string, book?: string, includeMetadata?: boolean, sort?: string, order?: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchResults>)>
      • summary

        Search for repositories

        throws

        {RequiredError}

        Parameters

        • Optional q: string
        • Optional topic: boolean
        • Optional includeDesc: boolean
        • Optional uid: number
        • Optional priorityOwnerId: number
        • Optional teamId: number
        • Optional starredBy: number
        • Optional _private: boolean
        • Optional isPrivate: boolean
        • Optional template: boolean
        • Optional archived: boolean
        • Optional mode: string
        • Optional exclusive: boolean
        • Optional repo: string
        • Optional owner: string
        • Optional lang: string
        • Optional subject: string
        • Optional book: string
        • Optional includeMetadata: boolean
        • Optional sort: string
        • Optional order: string
        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchResults>)>

    • repoSigningKey:function
      • repoSigningKey(owner: string, repo: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>)>
      • summary

        Get signing-key.gpg for given repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>)>

    • repoSubmitPullReview:function
      • repoSubmitPullReview(owner: string, repo: string, index: number, id: number, body: SubmitPullReviewOptions, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PullReview>)>
      • summary

        Submit a pending review to an pull request

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the pull request

        • id: number

          id of the review

        • body: SubmitPullReviewOptions
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PullReview>)>

    • repoTestHook:function
      • repoTestHook(owner: string, repo: string, id: number, ref?: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Test a push webhook

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • id: number

          id of the hook to test

        • Optional ref: string
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • repoTrackedTimes:function
      • repoTrackedTimes(owner: string, repo: string, user?: string, since?: string, before?: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<TrackedTime[]>)>
      • summary

        List a repo's tracked times

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional user: string
        • Optional since: string
        • Optional before: string
        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<TrackedTime[]>)>

    • repoTransfer:function
      • repoTransfer(owner: string, repo: string, body: TransferRepoOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository>)>
      • summary

        Transfer a repo ownership

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo to transfer

        • repo: string

          name of the repo to transfer

        • body: TransferRepoOption

          Transfer Options

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository>)>

    • repoUnDismissPullReview:function
      • repoUnDismissPullReview(owner: string, repo: string, index: number, id: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PullReview>)>
      • summary

        Cancel to dismiss a review for a pull request

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the pull request

        • id: number

          id of the review

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PullReview>)>

    • repoUpdateFile:function
      • repoUpdateFile(owner: string, repo: string, filepath: string, body: UpdateFileOptions, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileResponse>)>
      • summary

        Update a file in a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • filepath: string

          path of the file to update

        • body: UpdateFileOptions
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileResponse>)>

    • repoUpdateGitRef:function
      • repoUpdateGitRef(owner: string, repo: string, ref: string, body?: UpdateGitRefOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Reference>)>
      • summary

        Update a reference

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • ref: string

          name of the ref to update

        • Optional body: UpdateGitRefOption
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Reference>)>

    • repoUpdatePullRequest:function
      • repoUpdatePullRequest(owner: string, repo: string, index: number, style?: "merge" | "rebase", options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Merge PR's baseBranch into headBranch

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • index: number

          index of the pull request to get

        • Optional style: "merge" | "rebase"
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • repoUpdateTopics:function
      • repoUpdateTopics(owner: string, repo: string, body?: RepoTopicOptions, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Replace list of topics for a repository

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional body: RepoTopicOptions
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • topicSearch:function
      • topicSearch(q: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<TopicResponse[]>)>
      • summary

        search topics via keyword

        throws

        {RequiredError}

        Parameters

        • q: string

          keywords to search

        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<TopicResponse[]>)>

    • userCurrentCheckSubscription:function
      • userCurrentCheckSubscription(owner: string, repo: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<WatchInfo>)>
      • summary

        Check if the current user is watching a repo

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<WatchInfo>)>

    • userCurrentDeleteSubscription:function
      • userCurrentDeleteSubscription(owner: string, repo: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Unwatch a repo

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • userCurrentPutSubscription:function
      • userCurrentPutSubscription(owner: string, repo: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<WatchInfo>)>
      • summary

        Watch a repo

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<WatchInfo>)>

    • userTrackedTimes:function
      • userTrackedTimes(owner: string, repo: string, user: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<TrackedTime[]>)>
      • summary

        List a user's tracked times in a repo

        deprecated
        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • user: string

          username of user

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<TrackedTime[]>)>

SettingsApiAxiosParamCreator

  • SettingsApiAxiosParamCreator(configuration?: Configuration): { getGeneralAPISettings: ((options?: AxiosRequestConfig) => Promise<RequestArgs>); getGeneralAttachmentSettings: ((options?: AxiosRequestConfig) => Promise<RequestArgs>); getGeneralRepositorySettings: ((options?: AxiosRequestConfig) => Promise<RequestArgs>); getGeneralUISettings: ((options?: AxiosRequestConfig) => Promise<RequestArgs>) }

  • SettingsApi - axios parameter creator

    export

    Parameters

    Returns { getGeneralAPISettings: ((options?: AxiosRequestConfig) => Promise<RequestArgs>); getGeneralAttachmentSettings: ((options?: AxiosRequestConfig) => Promise<RequestArgs>); getGeneralRepositorySettings: ((options?: AxiosRequestConfig) => Promise<RequestArgs>); getGeneralUISettings: ((options?: AxiosRequestConfig) => Promise<RequestArgs>) }

    • getGeneralAPISettings: ((options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get instance's global settings for api

          throws

          {RequiredError}

          Parameters

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • getGeneralAttachmentSettings: ((options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get instance's global settings for Attachment

          throws

          {RequiredError}

          Parameters

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • getGeneralRepositorySettings: ((options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get instance's global settings for repositories

          throws

          {RequiredError}

          Parameters

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • getGeneralUISettings: ((options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get instance's global settings for ui

          throws

          {RequiredError}

          Parameters

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

SettingsApiFactory

  • SettingsApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getGeneralAPISettings: any; getGeneralAttachmentSettings: any; getGeneralRepositorySettings: any; getGeneralUISettings: any }

  • SettingsApi - factory interface

    export

    Parameters

    • Optional configuration: Configuration
    • Optional basePath: string
    • Optional axios: AxiosInstance

    Returns { getGeneralAPISettings: any; getGeneralAttachmentSettings: any; getGeneralRepositorySettings: any; getGeneralUISettings: any }

    • getGeneralAPISettings:function
      • summary

        Get instance's global settings for api

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<GeneralAPISettings>

    • getGeneralAttachmentSettings:function
      • summary

        Get instance's global settings for Attachment

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<GeneralAttachmentSettings>

    • getGeneralRepositorySettings:function
      • summary

        Get instance's global settings for repositories

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<GeneralRepoSettings>

    • getGeneralUISettings:function
      • summary

        Get instance's global settings for ui

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<GeneralUISettings>

SettingsApiFp

  • SettingsApiFp(configuration?: Configuration): { getGeneralAPISettings: any; getGeneralAttachmentSettings: any; getGeneralRepositorySettings: any; getGeneralUISettings: any }

  • SettingsApi - functional programming interface

    export

    Parameters

    Returns { getGeneralAPISettings: any; getGeneralAttachmentSettings: any; getGeneralRepositorySettings: any; getGeneralUISettings: any }

    • getGeneralAPISettings:function
      • getGeneralAPISettings(options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<GeneralAPISettings>)>
      • summary

        Get instance's global settings for api

        throws

        {RequiredError}

        Parameters

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<GeneralAPISettings>)>

    • getGeneralAttachmentSettings:function
      • getGeneralAttachmentSettings(options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<GeneralAttachmentSettings>)>
      • summary

        Get instance's global settings for Attachment

        throws

        {RequiredError}

        Parameters

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<GeneralAttachmentSettings>)>

    • getGeneralRepositorySettings:function
      • getGeneralRepositorySettings(options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<GeneralRepoSettings>)>
      • summary

        Get instance's global settings for repositories

        throws

        {RequiredError}

        Parameters

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<GeneralRepoSettings>)>

    • getGeneralUISettings:function
      • getGeneralUISettings(options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<GeneralUISettings>)>
      • summary

        Get instance's global settings for ui

        throws

        {RequiredError}

        Parameters

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<GeneralUISettings>)>

UserApiAxiosParamCreator

  • UserApiAxiosParamCreator(configuration?: Configuration): { createCurrentUserRepo: ((body?: CreateRepoOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); getUserSettings: ((options?: AxiosRequestConfig) => Promise<RequestArgs>); getVerificationToken: ((options?: AxiosRequestConfig) => Promise<RequestArgs>); updateUserSettings: ((body?: UserSettingsOptions, options?: AxiosRequestConfig) => Promise<RequestArgs>); userAddEmail: ((body?: CreateEmailOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); userCheckFollowing: ((username: string, target: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); userCreateOAuth2Application: ((body: CreateOAuth2ApplicationOptions, options?: AxiosRequestConfig) => Promise<RequestArgs>); userCreateToken: ((username: string, userCreateToken?: CreateAccessTokenOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); userCurrentCheckFollowing: ((username: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); userCurrentCheckStarring: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); userCurrentDeleteFollow: ((username: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); userCurrentDeleteGPGKey: ((id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); userCurrentDeleteKey: ((id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); userCurrentDeleteStar: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); userCurrentGetGPGKey: ((id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); userCurrentGetKey: ((id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); userCurrentListFollowers: ((page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); userCurrentListFollowing: ((page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); userCurrentListGPGKeys: ((page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); userCurrentListKeys: ((fingerprint?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); userCurrentListRepos: ((page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); userCurrentListStarred: ((page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); userCurrentListSubscriptions: ((page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); userCurrentPostGPGKey: ((form?: CreateGPGKeyOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); userCurrentPostKey: ((body?: CreateKeyOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); userCurrentPutFollow: ((username: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); userCurrentPutStar: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); userCurrentTrackedTimes: ((page?: number, limit?: number, since?: string, before?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); userDeleteAccessToken: ((username: string, token: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); userDeleteEmail: ((body?: DeleteEmailOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); userDeleteOAuth2Application: ((id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); userGet: ((username: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); userGetCurrent: ((options?: AxiosRequestConfig) => Promise<RequestArgs>); userGetHeatmapData: ((username: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); userGetOAuth2Application: ((id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); userGetOauth2Application: ((page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); userGetStopWatches: ((page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); userGetTokens: ((username: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); userListEmails: ((options?: AxiosRequestConfig) => Promise<RequestArgs>); userListFollowers: ((username: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); userListFollowing: ((username: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); userListGPGKeys: ((username: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); userListKeys: ((username: string, fingerprint?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); userListRepos: ((username: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); userListStarred: ((username: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); userListSubscriptions: ((username: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); userListTeams: ((page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); userSearch: ((q?: string, uid?: number, lang?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); userUpdateOAuth2Application: ((id: number, body: CreateOAuth2ApplicationOptions, options?: AxiosRequestConfig) => Promise<RequestArgs>); userVerifyGPGKey: ((options?: AxiosRequestConfig) => Promise<RequestArgs>) }

  • UserApi - axios parameter creator

    export

    Parameters

    Returns { createCurrentUserRepo: ((body?: CreateRepoOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); getUserSettings: ((options?: AxiosRequestConfig) => Promise<RequestArgs>); getVerificationToken: ((options?: AxiosRequestConfig) => Promise<RequestArgs>); updateUserSettings: ((body?: UserSettingsOptions, options?: AxiosRequestConfig) => Promise<RequestArgs>); userAddEmail: ((body?: CreateEmailOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); userCheckFollowing: ((username: string, target: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); userCreateOAuth2Application: ((body: CreateOAuth2ApplicationOptions, options?: AxiosRequestConfig) => Promise<RequestArgs>); userCreateToken: ((username: string, userCreateToken?: CreateAccessTokenOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); userCurrentCheckFollowing: ((username: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); userCurrentCheckStarring: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); userCurrentDeleteFollow: ((username: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); userCurrentDeleteGPGKey: ((id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); userCurrentDeleteKey: ((id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); userCurrentDeleteStar: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); userCurrentGetGPGKey: ((id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); userCurrentGetKey: ((id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); userCurrentListFollowers: ((page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); userCurrentListFollowing: ((page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); userCurrentListGPGKeys: ((page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); userCurrentListKeys: ((fingerprint?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); userCurrentListRepos: ((page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); userCurrentListStarred: ((page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); userCurrentListSubscriptions: ((page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); userCurrentPostGPGKey: ((form?: CreateGPGKeyOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); userCurrentPostKey: ((body?: CreateKeyOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); userCurrentPutFollow: ((username: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); userCurrentPutStar: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); userCurrentTrackedTimes: ((page?: number, limit?: number, since?: string, before?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); userDeleteAccessToken: ((username: string, token: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); userDeleteEmail: ((body?: DeleteEmailOption, options?: AxiosRequestConfig) => Promise<RequestArgs>); userDeleteOAuth2Application: ((id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); userGet: ((username: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); userGetCurrent: ((options?: AxiosRequestConfig) => Promise<RequestArgs>); userGetHeatmapData: ((username: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); userGetOAuth2Application: ((id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); userGetOauth2Application: ((page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); userGetStopWatches: ((page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); userGetTokens: ((username: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); userListEmails: ((options?: AxiosRequestConfig) => Promise<RequestArgs>); userListFollowers: ((username: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); userListFollowing: ((username: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); userListGPGKeys: ((username: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); userListKeys: ((username: string, fingerprint?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); userListRepos: ((username: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); userListStarred: ((username: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); userListSubscriptions: ((username: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); userListTeams: ((page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); userSearch: ((q?: string, uid?: number, lang?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>); userUpdateOAuth2Application: ((id: number, body: CreateOAuth2ApplicationOptions, options?: AxiosRequestConfig) => Promise<RequestArgs>); userVerifyGPGKey: ((options?: AxiosRequestConfig) => Promise<RequestArgs>) }

    • createCurrentUserRepo: ((body?: CreateRepoOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • summary

          Create a repository

          throws

          {RequiredError}

          Parameters

          Returns Promise<RequestArgs>

    • getUserSettings: ((options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get user settings

          throws

          {RequiredError}

          Parameters

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • getVerificationToken: ((options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get a Token to verify

          throws

          {RequiredError}

          Parameters

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • updateUserSettings: ((body?: UserSettingsOptions, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • summary

          Update user settings

          throws

          {RequiredError}

          Parameters

          Returns Promise<RequestArgs>

    • userAddEmail: ((body?: CreateEmailOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • summary

          Add email addresses

          throws

          {RequiredError}

          Parameters

          Returns Promise<RequestArgs>

    • userCheckFollowing: ((username: string, target: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (username: string, target: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Check if one user is following another user

          throws

          {RequiredError}

          Parameters

          • username: string

            username of following user

          • target: string

            username of followed user

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • userCreateOAuth2Application: ((body: CreateOAuth2ApplicationOptions, options?: AxiosRequestConfig) => Promise<RequestArgs>)
    • userCreateToken: ((username: string, userCreateToken?: CreateAccessTokenOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • summary

          Create an access token

          throws

          {RequiredError}

          Parameters

          • username: string

            username of user

          • Optional userCreateToken: CreateAccessTokenOption
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • userCurrentCheckFollowing: ((username: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (username: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Check whether a user is followed by the authenticated user

          throws

          {RequiredError}

          Parameters

          • username: string

            username of followed user

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • userCurrentCheckStarring: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Whether the authenticated is starring the repo

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo

          • repo: string

            name of the repo

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • userCurrentDeleteFollow: ((username: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (username: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Unfollow a user

          throws

          {RequiredError}

          Parameters

          • username: string

            username of user to unfollow

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • userCurrentDeleteGPGKey: ((id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (id: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Remove a GPG key

          throws

          {RequiredError}

          Parameters

          • id: number

            id of key to delete

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • userCurrentDeleteKey: ((id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (id: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Delete a public key

          throws

          {RequiredError}

          Parameters

          • id: number

            id of key to delete

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • userCurrentDeleteStar: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Unstar the given repo

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo to unstar

          • repo: string

            name of the repo to unstar

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • userCurrentGetGPGKey: ((id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (id: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get a GPG key

          throws

          {RequiredError}

          Parameters

          • id: number

            id of key to get

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • userCurrentGetKey: ((id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (id: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get a public key

          throws

          {RequiredError}

          Parameters

          • id: number

            id of key to get

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • userCurrentListFollowers: ((page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          List the authenticated user's followers

          throws

          {RequiredError}

          Parameters

          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • userCurrentListFollowing: ((page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          List the users that the authenticated user is following

          throws

          {RequiredError}

          Parameters

          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • userCurrentListGPGKeys: ((page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          List the authenticated user's GPG keys

          throws

          {RequiredError}

          Parameters

          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • userCurrentListKeys: ((fingerprint?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (fingerprint?: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          List the authenticated user's public keys

          throws

          {RequiredError}

          Parameters

          • Optional fingerprint: string
          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • userCurrentListRepos: ((page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          List the repos that the authenticated user owns

          throws

          {RequiredError}

          Parameters

          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • userCurrentListStarred: ((page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          The repos that the authenticated user has starred

          throws

          {RequiredError}

          Parameters

          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • userCurrentListSubscriptions: ((page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          List repositories watched by the authenticated user

          throws

          {RequiredError}

          Parameters

          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • userCurrentPostGPGKey: ((form?: CreateGPGKeyOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • summary

          Create a GPG key

          throws

          {RequiredError}

          Parameters

          Returns Promise<RequestArgs>

    • userCurrentPostKey: ((body?: CreateKeyOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (body?: CreateKeyOption, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Create a public key

          throws

          {RequiredError}

          Parameters

          Returns Promise<RequestArgs>

    • userCurrentPutFollow: ((username: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (username: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Follow a user

          throws

          {RequiredError}

          Parameters

          • username: string

            username of user to follow

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • userCurrentPutStar: ((owner: string, repo: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (owner: string, repo: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Star the given repo

          throws

          {RequiredError}

          Parameters

          • owner: string

            owner of the repo to star

          • repo: string

            name of the repo to star

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • userCurrentTrackedTimes: ((page?: number, limit?: number, since?: string, before?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (page?: number, limit?: number, since?: string, before?: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          List the current user's tracked times

          throws

          {RequiredError}

          Parameters

          • Optional page: number
          • Optional limit: number
          • Optional since: string
          • Optional before: string
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • userDeleteAccessToken: ((username: string, token: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (username: string, token: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          delete an access token

          throws

          {RequiredError}

          Parameters

          • username: string

            username of user

          • token: string

            token to be deleted, identified by ID and if not available by name

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • userDeleteEmail: ((body?: DeleteEmailOption, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • summary

          Delete email addresses

          throws

          {RequiredError}

          Parameters

          Returns Promise<RequestArgs>

    • userDeleteOAuth2Application: ((id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (id: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          delete an OAuth2 Application

          throws

          {RequiredError}

          Parameters

          • id: number

            token to be deleted

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • userGet: ((username: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (username: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get a user

          throws

          {RequiredError}

          Parameters

          • username: string

            username of user to get

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • userGetCurrent: ((options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get the authenticated user

          throws

          {RequiredError}

          Parameters

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • userGetHeatmapData: ((username: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (username: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get a user's heatmap

          throws

          {RequiredError}

          Parameters

          • username: string

            username of user to get

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • userGetOAuth2Application: ((id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (id: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          get an OAuth2 Application

          throws

          {RequiredError}

          Parameters

          • id: number

            Application ID to be found

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • userGetOauth2Application: ((page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          List the authenticated user's oauth2 applications

          throws

          {RequiredError}

          Parameters

          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • userGetStopWatches: ((page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Get list of all existing stopwatches

          throws

          {RequiredError}

          Parameters

          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • userGetTokens: ((username: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (username: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          List the authenticated user's access tokens

          throws

          {RequiredError}

          Parameters

          • username: string

            username of user

          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • userListEmails: ((options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          List the authenticated user's email addresses

          throws

          {RequiredError}

          Parameters

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • userListFollowers: ((username: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (username: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          List the given user's followers

          throws

          {RequiredError}

          Parameters

          • username: string

            username of user

          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • userListFollowing: ((username: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (username: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          List the users that the given user is following

          throws

          {RequiredError}

          Parameters

          • username: string

            username of user

          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • userListGPGKeys: ((username: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (username: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          List the given user's GPG keys

          throws

          {RequiredError}

          Parameters

          • username: string

            username of user

          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • userListKeys: ((username: string, fingerprint?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (username: string, fingerprint?: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          List the given user's public keys

          throws

          {RequiredError}

          Parameters

          • username: string

            username of user

          • Optional fingerprint: string
          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • userListRepos: ((username: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (username: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          List the repos owned by the given user

          throws

          {RequiredError}

          Parameters

          • username: string

            username of user

          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • userListStarred: ((username: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (username: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          The repos that the given user has starred

          throws

          {RequiredError}

          Parameters

          • username: string

            username of user

          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • userListSubscriptions: ((username: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (username: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          List the repositories watched by a user

          throws

          {RequiredError}

          Parameters

          • username: string

            username of the user

          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • userListTeams: ((page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          List all the teams a user belongs to

          throws

          {RequiredError}

          Parameters

          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • userSearch: ((q?: string, uid?: number, lang?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (q?: string, uid?: number, lang?: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Search for users

          throws

          {RequiredError}

          Parameters

          • Optional q: string
          • Optional uid: number
          • Optional lang: string
          • Optional page: number
          • Optional limit: number
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • userUpdateOAuth2Application: ((id: number, body: CreateOAuth2ApplicationOptions, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • summary

          update an OAuth2 Application, this includes regenerating the client secret

          throws

          {RequiredError}

          Parameters

          Returns Promise<RequestArgs>

    • userVerifyGPGKey: ((options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (options?: AxiosRequestConfig): Promise<RequestArgs>
        • summary

          Verify a GPG key

          throws

          {RequiredError}

          Parameters

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

UserApiFactory

  • UserApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { createCurrentUserRepo: any; getUserSettings: any; getVerificationToken: any; updateUserSettings: any; userAddEmail: any; userCheckFollowing: any; userCreateOAuth2Application: any; userCreateToken: any; userCurrentCheckFollowing: any; userCurrentCheckStarring: any; userCurrentDeleteFollow: any; userCurrentDeleteGPGKey: any; userCurrentDeleteKey: any; userCurrentDeleteStar: any; userCurrentGetGPGKey: any; userCurrentGetKey: any; userCurrentListFollowers: any; userCurrentListFollowing: any; userCurrentListGPGKeys: any; userCurrentListKeys: any; userCurrentListRepos: any; userCurrentListStarred: any; userCurrentListSubscriptions: any; userCurrentPostGPGKey: any; userCurrentPostKey: any; userCurrentPutFollow: any; userCurrentPutStar: any; userCurrentTrackedTimes: any; userDeleteAccessToken: any; userDeleteEmail: any; userDeleteOAuth2Application: any; userGet: any; userGetCurrent: any; userGetHeatmapData: any; userGetOAuth2Application: any; userGetOauth2Application: any; userGetStopWatches: any; userGetTokens: any; userListEmails: any; userListFollowers: any; userListFollowing: any; userListGPGKeys: any; userListKeys: any; userListRepos: any; userListStarred: any; userListSubscriptions: any; userListTeams: any; userSearch: any; userUpdateOAuth2Application: any; userVerifyGPGKey: any }

  • UserApi - factory interface

    export

    Parameters

    • Optional configuration: Configuration
    • Optional basePath: string
    • Optional axios: AxiosInstance

    Returns { createCurrentUserRepo: any; getUserSettings: any; getVerificationToken: any; updateUserSettings: any; userAddEmail: any; userCheckFollowing: any; userCreateOAuth2Application: any; userCreateToken: any; userCurrentCheckFollowing: any; userCurrentCheckStarring: any; userCurrentDeleteFollow: any; userCurrentDeleteGPGKey: any; userCurrentDeleteKey: any; userCurrentDeleteStar: any; userCurrentGetGPGKey: any; userCurrentGetKey: any; userCurrentListFollowers: any; userCurrentListFollowing: any; userCurrentListGPGKeys: any; userCurrentListKeys: any; userCurrentListRepos: any; userCurrentListStarred: any; userCurrentListSubscriptions: any; userCurrentPostGPGKey: any; userCurrentPostKey: any; userCurrentPutFollow: any; userCurrentPutStar: any; userCurrentTrackedTimes: any; userDeleteAccessToken: any; userDeleteEmail: any; userDeleteOAuth2Application: any; userGet: any; userGetCurrent: any; userGetHeatmapData: any; userGetOAuth2Application: any; userGetOauth2Application: any; userGetStopWatches: any; userGetTokens: any; userListEmails: any; userListFollowers: any; userListFollowing: any; userListGPGKeys: any; userListKeys: any; userListRepos: any; userListStarred: any; userListSubscriptions: any; userListTeams: any; userSearch: any; userUpdateOAuth2Application: any; userVerifyGPGKey: any }

    • createCurrentUserRepo:function
      • summary

        Create a repository

        throws

        {RequiredError}

        Parameters

        Returns AxiosPromise<Repository>

    • getUserSettings:function
      • getUserSettings(options?: any): AxiosPromise<UserSettings[]>
      • summary

        Get user settings

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<UserSettings[]>

    • getVerificationToken:function
      • getVerificationToken(options?: any): AxiosPromise<string>
      • summary

        Get a Token to verify

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<string>

    • updateUserSettings:function
      • summary

        Update user settings

        throws

        {RequiredError}

        Parameters

        Returns AxiosPromise<UserSettings[]>

    • userAddEmail:function
      • summary

        Add email addresses

        throws

        {RequiredError}

        Parameters

        Returns AxiosPromise<Email[]>

    • userCheckFollowing:function
      • userCheckFollowing(username: string, target: string, options?: any): AxiosPromise<void>
      • summary

        Check if one user is following another user

        throws

        {RequiredError}

        Parameters

        • username: string

          username of following user

        • target: string

          username of followed user

        • Optional options: any

        Returns AxiosPromise<void>

    • userCreateOAuth2Application:function
    • userCreateToken:function
      • summary

        Create an access token

        throws

        {RequiredError}

        Parameters

        Returns AxiosPromise<AccessToken>

    • userCurrentCheckFollowing:function
      • userCurrentCheckFollowing(username: string, options?: any): AxiosPromise<void>
      • summary

        Check whether a user is followed by the authenticated user

        throws

        {RequiredError}

        Parameters

        • username: string

          username of followed user

        • Optional options: any

        Returns AxiosPromise<void>

    • userCurrentCheckStarring:function
      • userCurrentCheckStarring(owner: string, repo: string, options?: any): AxiosPromise<void>
      • summary

        Whether the authenticated is starring the repo

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional options: any

        Returns AxiosPromise<void>

    • userCurrentDeleteFollow:function
      • userCurrentDeleteFollow(username: string, options?: any): AxiosPromise<void>
      • summary

        Unfollow a user

        throws

        {RequiredError}

        Parameters

        • username: string

          username of user to unfollow

        • Optional options: any

        Returns AxiosPromise<void>

    • userCurrentDeleteGPGKey:function
      • userCurrentDeleteGPGKey(id: number, options?: any): AxiosPromise<void>
      • summary

        Remove a GPG key

        throws

        {RequiredError}

        Parameters

        • id: number

          id of key to delete

        • Optional options: any

        Returns AxiosPromise<void>

    • userCurrentDeleteKey:function
      • userCurrentDeleteKey(id: number, options?: any): AxiosPromise<void>
      • summary

        Delete a public key

        throws

        {RequiredError}

        Parameters

        • id: number

          id of key to delete

        • Optional options: any

        Returns AxiosPromise<void>

    • userCurrentDeleteStar:function
      • userCurrentDeleteStar(owner: string, repo: string, options?: any): AxiosPromise<void>
      • summary

        Unstar the given repo

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo to unstar

        • repo: string

          name of the repo to unstar

        • Optional options: any

        Returns AxiosPromise<void>

    • userCurrentGetGPGKey:function
      • userCurrentGetGPGKey(id: number, options?: any): AxiosPromise<GPGKey>
      • summary

        Get a GPG key

        throws

        {RequiredError}

        Parameters

        • id: number

          id of key to get

        • Optional options: any

        Returns AxiosPromise<GPGKey>

    • userCurrentGetKey:function
      • userCurrentGetKey(id: number, options?: any): AxiosPromise<PublicKey>
      • summary

        Get a public key

        throws

        {RequiredError}

        Parameters

        • id: number

          id of key to get

        • Optional options: any

        Returns AxiosPromise<PublicKey>

    • userCurrentListFollowers:function
      • userCurrentListFollowers(page?: number, limit?: number, options?: any): AxiosPromise<User[]>
      • summary

        List the authenticated user's followers

        throws

        {RequiredError}

        Parameters

        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<User[]>

    • userCurrentListFollowing:function
      • userCurrentListFollowing(page?: number, limit?: number, options?: any): AxiosPromise<User[]>
      • summary

        List the users that the authenticated user is following

        throws

        {RequiredError}

        Parameters

        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<User[]>

    • userCurrentListGPGKeys:function
      • userCurrentListGPGKeys(page?: number, limit?: number, options?: any): AxiosPromise<GPGKey[]>
      • summary

        List the authenticated user's GPG keys

        throws

        {RequiredError}

        Parameters

        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<GPGKey[]>

    • userCurrentListKeys:function
      • userCurrentListKeys(fingerprint?: string, page?: number, limit?: number, options?: any): AxiosPromise<PublicKey[]>
      • summary

        List the authenticated user's public keys

        throws

        {RequiredError}

        Parameters

        • Optional fingerprint: string
        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<PublicKey[]>

    • userCurrentListRepos:function
      • userCurrentListRepos(page?: number, limit?: number, options?: any): AxiosPromise<Repository[]>
      • summary

        List the repos that the authenticated user owns

        throws

        {RequiredError}

        Parameters

        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<Repository[]>

    • userCurrentListStarred:function
      • userCurrentListStarred(page?: number, limit?: number, options?: any): AxiosPromise<Repository[]>
      • summary

        The repos that the authenticated user has starred

        throws

        {RequiredError}

        Parameters

        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<Repository[]>

    • userCurrentListSubscriptions:function
      • userCurrentListSubscriptions(page?: number, limit?: number, options?: any): AxiosPromise<Repository[]>
      • summary

        List repositories watched by the authenticated user

        throws

        {RequiredError}

        Parameters

        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<Repository[]>

    • userCurrentPostGPGKey:function
      • summary

        Create a GPG key

        throws

        {RequiredError}

        Parameters

        Returns AxiosPromise<GPGKey>

    • userCurrentPostKey:function
      • summary

        Create a public key

        throws

        {RequiredError}

        Parameters

        Returns AxiosPromise<PublicKey>

    • userCurrentPutFollow:function
      • userCurrentPutFollow(username: string, options?: any): AxiosPromise<void>
      • summary

        Follow a user

        throws

        {RequiredError}

        Parameters

        • username: string

          username of user to follow

        • Optional options: any

        Returns AxiosPromise<void>

    • userCurrentPutStar:function
      • userCurrentPutStar(owner: string, repo: string, options?: any): AxiosPromise<void>
      • summary

        Star the given repo

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo to star

        • repo: string

          name of the repo to star

        • Optional options: any

        Returns AxiosPromise<void>

    • userCurrentTrackedTimes:function
      • userCurrentTrackedTimes(page?: number, limit?: number, since?: string, before?: string, options?: any): AxiosPromise<TrackedTime[]>
      • summary

        List the current user's tracked times

        throws

        {RequiredError}

        Parameters

        • Optional page: number
        • Optional limit: number
        • Optional since: string
        • Optional before: string
        • Optional options: any

        Returns AxiosPromise<TrackedTime[]>

    • userDeleteAccessToken:function
      • userDeleteAccessToken(username: string, token: string, options?: any): AxiosPromise<void>
      • summary

        delete an access token

        throws

        {RequiredError}

        Parameters

        • username: string

          username of user

        • token: string

          token to be deleted, identified by ID and if not available by name

        • Optional options: any

        Returns AxiosPromise<void>

    • userDeleteEmail:function
      • summary

        Delete email addresses

        throws

        {RequiredError}

        Parameters

        Returns AxiosPromise<void>

    • userDeleteOAuth2Application:function
      • userDeleteOAuth2Application(id: number, options?: any): AxiosPromise<void>
      • summary

        delete an OAuth2 Application

        throws

        {RequiredError}

        Parameters

        • id: number

          token to be deleted

        • Optional options: any

        Returns AxiosPromise<void>

    • userGet:function
      • userGet(username: string, options?: any): AxiosPromise<User>
      • summary

        Get a user

        throws

        {RequiredError}

        Parameters

        • username: string

          username of user to get

        • Optional options: any

        Returns AxiosPromise<User>

    • userGetCurrent:function
      • userGetCurrent(options?: any): AxiosPromise<User>
      • summary

        Get the authenticated user

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<User>

    • userGetHeatmapData:function
      • userGetHeatmapData(username: string, options?: any): AxiosPromise<UserHeatmapData[]>
      • summary

        Get a user's heatmap

        throws

        {RequiredError}

        Parameters

        • username: string

          username of user to get

        • Optional options: any

        Returns AxiosPromise<UserHeatmapData[]>

    • userGetOAuth2Application:function
      • summary

        get an OAuth2 Application

        throws

        {RequiredError}

        Parameters

        • id: number

          Application ID to be found

        • Optional options: any

        Returns AxiosPromise<OAuth2Application>

    • userGetOauth2Application:function
      • userGetOauth2Application(page?: number, limit?: number, options?: any): AxiosPromise<OAuth2Application[]>
      • summary

        List the authenticated user's oauth2 applications

        throws

        {RequiredError}

        Parameters

        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<OAuth2Application[]>

    • userGetStopWatches:function
      • userGetStopWatches(page?: number, limit?: number, options?: any): AxiosPromise<StopWatch[]>
      • summary

        Get list of all existing stopwatches

        throws

        {RequiredError}

        Parameters

        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<StopWatch[]>

    • userGetTokens:function
      • userGetTokens(username: string, page?: number, limit?: number, options?: any): AxiosPromise<AccessToken[]>
      • summary

        List the authenticated user's access tokens

        throws

        {RequiredError}

        Parameters

        • username: string

          username of user

        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<AccessToken[]>

    • userListEmails:function
      • userListEmails(options?: any): AxiosPromise<Email[]>
      • summary

        List the authenticated user's email addresses

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<Email[]>

    • userListFollowers:function
      • userListFollowers(username: string, page?: number, limit?: number, options?: any): AxiosPromise<User[]>
      • summary

        List the given user's followers

        throws

        {RequiredError}

        Parameters

        • username: string

          username of user

        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<User[]>

    • userListFollowing:function
      • userListFollowing(username: string, page?: number, limit?: number, options?: any): AxiosPromise<User[]>
      • summary

        List the users that the given user is following

        throws

        {RequiredError}

        Parameters

        • username: string

          username of user

        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<User[]>

    • userListGPGKeys:function
      • userListGPGKeys(username: string, page?: number, limit?: number, options?: any): AxiosPromise<GPGKey[]>
      • summary

        List the given user's GPG keys

        throws

        {RequiredError}

        Parameters

        • username: string

          username of user

        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<GPGKey[]>

    • userListKeys:function
      • userListKeys(username: string, fingerprint?: string, page?: number, limit?: number, options?: any): AxiosPromise<PublicKey[]>
      • summary

        List the given user's public keys

        throws

        {RequiredError}

        Parameters

        • username: string

          username of user

        • Optional fingerprint: string
        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<PublicKey[]>

    • userListRepos:function
      • userListRepos(username: string, page?: number, limit?: number, options?: any): AxiosPromise<Repository[]>
      • summary

        List the repos owned by the given user

        throws

        {RequiredError}

        Parameters

        • username: string

          username of user

        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<Repository[]>

    • userListStarred:function
      • userListStarred(username: string, page?: number, limit?: number, options?: any): AxiosPromise<Repository[]>
      • summary

        The repos that the given user has starred

        throws

        {RequiredError}

        Parameters

        • username: string

          username of user

        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<Repository[]>

    • userListSubscriptions:function
      • userListSubscriptions(username: string, page?: number, limit?: number, options?: any): AxiosPromise<Repository[]>
      • summary

        List the repositories watched by a user

        throws

        {RequiredError}

        Parameters

        • username: string

          username of the user

        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<Repository[]>

    • userListTeams:function
      • userListTeams(page?: number, limit?: number, options?: any): AxiosPromise<Team[]>
      • summary

        List all the teams a user belongs to

        throws

        {RequiredError}

        Parameters

        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<Team[]>

    • userSearch:function
      • userSearch(q?: string, uid?: number, lang?: string, page?: number, limit?: number, options?: any): AxiosPromise<UserSearch200Response>
      • summary

        Search for users

        throws

        {RequiredError}

        Parameters

        • Optional q: string
        • Optional uid: number
        • Optional lang: string
        • Optional page: number
        • Optional limit: number
        • Optional options: any

        Returns AxiosPromise<UserSearch200Response>

    • userUpdateOAuth2Application:function
      • summary

        update an OAuth2 Application, this includes regenerating the client secret

        throws

        {RequiredError}

        Parameters

        Returns AxiosPromise<OAuth2Application>

    • userVerifyGPGKey:function
      • userVerifyGPGKey(options?: any): AxiosPromise<GPGKey>
      • summary

        Verify a GPG key

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<GPGKey>

UserApiFp

  • UserApiFp(configuration?: Configuration): { createCurrentUserRepo: any; getUserSettings: any; getVerificationToken: any; updateUserSettings: any; userAddEmail: any; userCheckFollowing: any; userCreateOAuth2Application: any; userCreateToken: any; userCurrentCheckFollowing: any; userCurrentCheckStarring: any; userCurrentDeleteFollow: any; userCurrentDeleteGPGKey: any; userCurrentDeleteKey: any; userCurrentDeleteStar: any; userCurrentGetGPGKey: any; userCurrentGetKey: any; userCurrentListFollowers: any; userCurrentListFollowing: any; userCurrentListGPGKeys: any; userCurrentListKeys: any; userCurrentListRepos: any; userCurrentListStarred: any; userCurrentListSubscriptions: any; userCurrentPostGPGKey: any; userCurrentPostKey: any; userCurrentPutFollow: any; userCurrentPutStar: any; userCurrentTrackedTimes: any; userDeleteAccessToken: any; userDeleteEmail: any; userDeleteOAuth2Application: any; userGet: any; userGetCurrent: any; userGetHeatmapData: any; userGetOAuth2Application: any; userGetOauth2Application: any; userGetStopWatches: any; userGetTokens: any; userListEmails: any; userListFollowers: any; userListFollowing: any; userListGPGKeys: any; userListKeys: any; userListRepos: any; userListStarred: any; userListSubscriptions: any; userListTeams: any; userSearch: any; userUpdateOAuth2Application: any; userVerifyGPGKey: any }

  • UserApi - functional programming interface

    export

    Parameters

    Returns { createCurrentUserRepo: any; getUserSettings: any; getVerificationToken: any; updateUserSettings: any; userAddEmail: any; userCheckFollowing: any; userCreateOAuth2Application: any; userCreateToken: any; userCurrentCheckFollowing: any; userCurrentCheckStarring: any; userCurrentDeleteFollow: any; userCurrentDeleteGPGKey: any; userCurrentDeleteKey: any; userCurrentDeleteStar: any; userCurrentGetGPGKey: any; userCurrentGetKey: any; userCurrentListFollowers: any; userCurrentListFollowing: any; userCurrentListGPGKeys: any; userCurrentListKeys: any; userCurrentListRepos: any; userCurrentListStarred: any; userCurrentListSubscriptions: any; userCurrentPostGPGKey: any; userCurrentPostKey: any; userCurrentPutFollow: any; userCurrentPutStar: any; userCurrentTrackedTimes: any; userDeleteAccessToken: any; userDeleteEmail: any; userDeleteOAuth2Application: any; userGet: any; userGetCurrent: any; userGetHeatmapData: any; userGetOAuth2Application: any; userGetOauth2Application: any; userGetStopWatches: any; userGetTokens: any; userListEmails: any; userListFollowers: any; userListFollowing: any; userListGPGKeys: any; userListKeys: any; userListRepos: any; userListStarred: any; userListSubscriptions: any; userListTeams: any; userSearch: any; userUpdateOAuth2Application: any; userVerifyGPGKey: any }

    • createCurrentUserRepo:function
      • createCurrentUserRepo(body?: CreateRepoOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository>)>
      • summary

        Create a repository

        throws

        {RequiredError}

        Parameters

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository>)>

    • getUserSettings:function
      • getUserSettings(options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserSettings[]>)>
      • summary

        Get user settings

        throws

        {RequiredError}

        Parameters

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserSettings[]>)>

    • getVerificationToken:function
      • getVerificationToken(options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>)>
      • summary

        Get a Token to verify

        throws

        {RequiredError}

        Parameters

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>)>

    • updateUserSettings:function
      • updateUserSettings(body?: UserSettingsOptions, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserSettings[]>)>
      • summary

        Update user settings

        throws

        {RequiredError}

        Parameters

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserSettings[]>)>

    • userAddEmail:function
      • userAddEmail(body?: CreateEmailOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Email[]>)>
      • summary

        Add email addresses

        throws

        {RequiredError}

        Parameters

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Email[]>)>

    • userCheckFollowing:function
      • userCheckFollowing(username: string, target: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Check if one user is following another user

        throws

        {RequiredError}

        Parameters

        • username: string

          username of following user

        • target: string

          username of followed user

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • userCreateOAuth2Application:function
      • summary

        creates a new OAuth2 application

        throws

        {RequiredError}

        Parameters

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<OAuth2Application>)>

    • userCreateToken:function
      • userCreateToken(username: string, userCreateToken?: CreateAccessTokenOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccessToken>)>
      • summary

        Create an access token

        throws

        {RequiredError}

        Parameters

        • username: string

          username of user

        • Optional userCreateToken: CreateAccessTokenOption
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccessToken>)>

    • userCurrentCheckFollowing:function
      • userCurrentCheckFollowing(username: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Check whether a user is followed by the authenticated user

        throws

        {RequiredError}

        Parameters

        • username: string

          username of followed user

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • userCurrentCheckStarring:function
      • userCurrentCheckStarring(owner: string, repo: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Whether the authenticated is starring the repo

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo

        • repo: string

          name of the repo

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • userCurrentDeleteFollow:function
      • userCurrentDeleteFollow(username: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Unfollow a user

        throws

        {RequiredError}

        Parameters

        • username: string

          username of user to unfollow

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • userCurrentDeleteGPGKey:function
      • userCurrentDeleteGPGKey(id: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Remove a GPG key

        throws

        {RequiredError}

        Parameters

        • id: number

          id of key to delete

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • userCurrentDeleteKey:function
      • userCurrentDeleteKey(id: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Delete a public key

        throws

        {RequiredError}

        Parameters

        • id: number

          id of key to delete

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • userCurrentDeleteStar:function
      • userCurrentDeleteStar(owner: string, repo: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Unstar the given repo

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo to unstar

        • repo: string

          name of the repo to unstar

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • userCurrentGetGPGKey:function
      • userCurrentGetGPGKey(id: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<GPGKey>)>
      • summary

        Get a GPG key

        throws

        {RequiredError}

        Parameters

        • id: number

          id of key to get

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<GPGKey>)>

    • userCurrentGetKey:function
      • userCurrentGetKey(id: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicKey>)>
      • summary

        Get a public key

        throws

        {RequiredError}

        Parameters

        • id: number

          id of key to get

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicKey>)>

    • userCurrentListFollowers:function
      • userCurrentListFollowers(page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<User[]>)>
      • summary

        List the authenticated user's followers

        throws

        {RequiredError}

        Parameters

        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<User[]>)>

    • userCurrentListFollowing:function
      • userCurrentListFollowing(page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<User[]>)>
      • summary

        List the users that the authenticated user is following

        throws

        {RequiredError}

        Parameters

        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<User[]>)>

    • userCurrentListGPGKeys:function
      • userCurrentListGPGKeys(page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<GPGKey[]>)>
      • summary

        List the authenticated user's GPG keys

        throws

        {RequiredError}

        Parameters

        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<GPGKey[]>)>

    • userCurrentListKeys:function
      • userCurrentListKeys(fingerprint?: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicKey[]>)>
      • summary

        List the authenticated user's public keys

        throws

        {RequiredError}

        Parameters

        • Optional fingerprint: string
        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicKey[]>)>

    • userCurrentListRepos:function
      • userCurrentListRepos(page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository[]>)>
      • summary

        List the repos that the authenticated user owns

        throws

        {RequiredError}

        Parameters

        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository[]>)>

    • userCurrentListStarred:function
      • userCurrentListStarred(page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository[]>)>
      • summary

        The repos that the authenticated user has starred

        throws

        {RequiredError}

        Parameters

        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository[]>)>

    • userCurrentListSubscriptions:function
      • userCurrentListSubscriptions(page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository[]>)>
      • summary

        List repositories watched by the authenticated user

        throws

        {RequiredError}

        Parameters

        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository[]>)>

    • userCurrentPostGPGKey:function
      • userCurrentPostGPGKey(form?: CreateGPGKeyOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<GPGKey>)>
      • summary

        Create a GPG key

        throws

        {RequiredError}

        Parameters

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<GPGKey>)>

    • userCurrentPostKey:function
      • userCurrentPostKey(body?: CreateKeyOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicKey>)>
      • summary

        Create a public key

        throws

        {RequiredError}

        Parameters

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicKey>)>

    • userCurrentPutFollow:function
      • userCurrentPutFollow(username: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Follow a user

        throws

        {RequiredError}

        Parameters

        • username: string

          username of user to follow

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • userCurrentPutStar:function
      • userCurrentPutStar(owner: string, repo: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Star the given repo

        throws

        {RequiredError}

        Parameters

        • owner: string

          owner of the repo to star

        • repo: string

          name of the repo to star

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • userCurrentTrackedTimes:function
      • userCurrentTrackedTimes(page?: number, limit?: number, since?: string, before?: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<TrackedTime[]>)>
      • summary

        List the current user's tracked times

        throws

        {RequiredError}

        Parameters

        • Optional page: number
        • Optional limit: number
        • Optional since: string
        • Optional before: string
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<TrackedTime[]>)>

    • userDeleteAccessToken:function
      • userDeleteAccessToken(username: string, token: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        delete an access token

        throws

        {RequiredError}

        Parameters

        • username: string

          username of user

        • token: string

          token to be deleted, identified by ID and if not available by name

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • userDeleteEmail:function
      • userDeleteEmail(body?: DeleteEmailOption, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        Delete email addresses

        throws

        {RequiredError}

        Parameters

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • userDeleteOAuth2Application:function
      • userDeleteOAuth2Application(id: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • summary

        delete an OAuth2 Application

        throws

        {RequiredError}

        Parameters

        • id: number

          token to be deleted

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • userGet:function
      • userGet(username: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<User>)>
      • summary

        Get a user

        throws

        {RequiredError}

        Parameters

        • username: string

          username of user to get

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<User>)>

    • userGetCurrent:function
      • userGetCurrent(options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<User>)>
      • summary

        Get the authenticated user

        throws

        {RequiredError}

        Parameters

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<User>)>

    • userGetHeatmapData:function
      • userGetHeatmapData(username: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserHeatmapData[]>)>
      • summary

        Get a user's heatmap

        throws

        {RequiredError}

        Parameters

        • username: string

          username of user to get

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserHeatmapData[]>)>

    • userGetOAuth2Application:function
      • userGetOAuth2Application(id: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<OAuth2Application>)>
      • summary

        get an OAuth2 Application

        throws

        {RequiredError}

        Parameters

        • id: number

          Application ID to be found

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<OAuth2Application>)>

    • userGetOauth2Application:function
      • userGetOauth2Application(page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<OAuth2Application[]>)>
      • summary

        List the authenticated user's oauth2 applications

        throws

        {RequiredError}

        Parameters

        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<OAuth2Application[]>)>

    • userGetStopWatches:function
      • userGetStopWatches(page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<StopWatch[]>)>
      • summary

        Get list of all existing stopwatches

        throws

        {RequiredError}

        Parameters

        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<StopWatch[]>)>

    • userGetTokens:function
      • userGetTokens(username: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccessToken[]>)>
      • summary

        List the authenticated user's access tokens

        throws

        {RequiredError}

        Parameters

        • username: string

          username of user

        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccessToken[]>)>

    • userListEmails:function
      • userListEmails(options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Email[]>)>
      • summary

        List the authenticated user's email addresses

        throws

        {RequiredError}

        Parameters

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Email[]>)>

    • userListFollowers:function
      • userListFollowers(username: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<User[]>)>
      • summary

        List the given user's followers

        throws

        {RequiredError}

        Parameters

        • username: string

          username of user

        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<User[]>)>

    • userListFollowing:function
      • userListFollowing(username: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<User[]>)>
      • summary

        List the users that the given user is following

        throws

        {RequiredError}

        Parameters

        • username: string

          username of user

        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<User[]>)>

    • userListGPGKeys:function
      • userListGPGKeys(username: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<GPGKey[]>)>
      • summary

        List the given user's GPG keys

        throws

        {RequiredError}

        Parameters

        • username: string

          username of user

        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<GPGKey[]>)>

    • userListKeys:function
      • userListKeys(username: string, fingerprint?: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicKey[]>)>
      • summary

        List the given user's public keys

        throws

        {RequiredError}

        Parameters

        • username: string

          username of user

        • Optional fingerprint: string
        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicKey[]>)>

    • userListRepos:function
      • userListRepos(username: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository[]>)>
      • summary

        List the repos owned by the given user

        throws

        {RequiredError}

        Parameters

        • username: string

          username of user

        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository[]>)>

    • userListStarred:function
      • userListStarred(username: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository[]>)>
      • summary

        The repos that the given user has starred

        throws

        {RequiredError}

        Parameters

        • username: string

          username of user

        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository[]>)>

    • userListSubscriptions:function
      • userListSubscriptions(username: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository[]>)>
      • summary

        List the repositories watched by a user

        throws

        {RequiredError}

        Parameters

        • username: string

          username of the user

        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository[]>)>

    • userListTeams:function
      • userListTeams(page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Team[]>)>
      • summary

        List all the teams a user belongs to

        throws

        {RequiredError}

        Parameters

        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Team[]>)>

    • userSearch:function
      • userSearch(q?: string, uid?: number, lang?: string, page?: number, limit?: number, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserSearch200Response>)>
      • summary

        Search for users

        throws

        {RequiredError}

        Parameters

        • Optional q: string
        • Optional uid: number
        • Optional lang: string
        • Optional page: number
        • Optional limit: number
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserSearch200Response>)>

    • userUpdateOAuth2Application:function
      • summary

        update an OAuth2 Application, this includes regenerating the client secret

        throws

        {RequiredError}

        Parameters

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<OAuth2Application>)>

    • userVerifyGPGKey:function
      • userVerifyGPGKey(options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<GPGKey>)>
      • summary

        Verify a GPG key

        throws

        {RequiredError}

        Parameters

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<GPGKey>)>

Generated using TypeDoc