Skip to content

Latest commit

 

History

History
2057 lines (1637 loc) · 200 KB

modules.md

File metadata and controls

2057 lines (1637 loc) · 200 KB

dcs-js / Exports

dcs-js

Table of contents

Classes

Interfaces

Type Aliases

Variables

Functions

Type Aliases

CreateHookOptionTypeEnum

Ƭ CreateHookOptionTypeEnum: typeof CreateHookOptionTypeEnum[keyof typeof CreateHookOptionTypeEnum]

Defined in

models/create-hook-option.ts:67


CreateMilestoneOptionStateEnum

Ƭ CreateMilestoneOptionStateEnum: typeof CreateMilestoneOptionStateEnum[keyof typeof CreateMilestoneOptionStateEnum]

Defined in

models/create-milestone-option.ts:54


CreateOrgOptionVisibilityEnum

Ƭ CreateOrgOptionVisibilityEnum: typeof CreateOrgOptionVisibilityEnum[keyof typeof CreateOrgOptionVisibilityEnum]

Defined in

models/create-org-option.ts:73


CreateRepoOptionTrustModelEnum

Ƭ CreateRepoOptionTrustModelEnum: typeof CreateRepoOptionTrustModelEnum[keyof typeof CreateRepoOptionTrustModelEnum]

Defined in

models/create-repo-option.ts:98


CreateTeamOptionPermissionEnum

Ƭ CreateTeamOptionPermissionEnum: typeof CreateTeamOptionPermissionEnum[keyof typeof CreateTeamOptionPermissionEnum]

Defined in

models/create-team-option.ts:73


EditOrgOptionVisibilityEnum

Ƭ EditOrgOptionVisibilityEnum: typeof EditOrgOptionVisibilityEnum[keyof typeof EditOrgOptionVisibilityEnum]

Defined in

models/edit-org-option.ts:67


EditTeamOptionPermissionEnum

Ƭ EditTeamOptionPermissionEnum: typeof EditTeamOptionPermissionEnum[keyof typeof EditTeamOptionPermissionEnum]

Defined in

models/edit-team-option.ts:73


MergePullRequestOptionDoEnum

Ƭ MergePullRequestOptionDoEnum: typeof MergePullRequestOptionDoEnum[keyof typeof MergePullRequestOptionDoEnum]

Defined in

models/merge-pull-request-option.ts:75


MigrateRepoOptionsServiceEnum

Ƭ MigrateRepoOptionsServiceEnum: typeof MigrateRepoOptionsServiceEnum[keyof typeof MigrateRepoOptionsServiceEnum]

Defined in

models/migrate-repo-options.ts:152


TeamPermissionEnum

Ƭ TeamPermissionEnum: typeof TeamPermissionEnum[keyof typeof TeamPermissionEnum]

Defined in

models/team.ts:90

Variables

CreateHookOptionTypeEnum

Const CreateHookOptionTypeEnum: Object

Type declaration

Name Type
Dingtalk "dingtalk"
Discord "discord"
Feishu "feishu"
Gitea "gitea"
Gogs "gogs"
Msteams "msteams"
Slack "slack"
Telegram "telegram"
Wechatwork "wechatwork"

Defined in

models/create-hook-option.ts:55


CreateMilestoneOptionStateEnum

Const CreateMilestoneOptionStateEnum: Object

Type declaration

Name Type
Closed "closed"
Open "open"

Defined in

models/create-milestone-option.ts:49


CreateOrgOptionVisibilityEnum

Const CreateOrgOptionVisibilityEnum: Object

Type declaration

Name Type
Limited "limited"
Private "private"
Public "public"

Defined in

models/create-org-option.ts:67


CreateRepoOptionTrustModelEnum

Const CreateRepoOptionTrustModelEnum: Object

Type declaration

Name Type
Collaborator "collaborator"
Collaboratorcommitter "collaboratorcommitter"
Committer "committer"
Default "default"

Defined in

models/create-repo-option.ts:91


CreateTeamOptionPermissionEnum

Const CreateTeamOptionPermissionEnum: Object

Type declaration

Name Type
Admin "admin"
Read "read"
Write "write"

Defined in

models/create-team-option.ts:67


EditOrgOptionVisibilityEnum

Const EditOrgOptionVisibilityEnum: Object

Type declaration

Name Type
Limited "limited"
Private "private"
Public "public"

Defined in

models/edit-org-option.ts:61


EditTeamOptionPermissionEnum

Const EditTeamOptionPermissionEnum: Object

Type declaration

Name Type
Admin "admin"
Read "read"
Write "write"

Defined in

models/edit-team-option.ts:67


MergePullRequestOptionDoEnum

Const MergePullRequestOptionDoEnum: Object

Type declaration

Name Type
ManuallyMerged "manually-merged"
Merge "merge"
Rebase "rebase"
RebaseMerge "rebase-merge"
Squash "squash"

Defined in

models/merge-pull-request-option.ts:67


MigrateRepoOptionsServiceEnum

Const MigrateRepoOptionsServiceEnum: Object

Type declaration

Name Type
Git "git"
Gitea "gitea"
Github "github"
Gitlab "gitlab"

Defined in

models/migrate-repo-options.ts:145


TeamPermissionEnum

Const TeamPermissionEnum: Object

Type declaration

Name Type
Admin "admin"
None "none"
Owner "owner"
Read "read"
Write "write"

Defined in

models/team.ts:82

Functions

AdminApiAxiosParamCreator

AdminApiAxiosParamCreator(configuration?): Object

AdminApi - axios parameter creator

export

Parameters

Name Type
configuration? Configuration

Returns

Object

Name Type
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>

Defined in

apis/admin-api.ts:47


AdminApiFactory

AdminApiFactory(configuration?, basePath?, axios?): Object

AdminApi - factory interface

export

Parameters

Name Type
configuration? Configuration
basePath? string
axios? AxiosInstance

Returns

Object

Name Type
adminAdoptRepository (owner: string, repo: string, options?: any) => AxiosPromise<void>
adminCreateOrg (username: string, organization: CreateOrgOption, options?: any) => AxiosPromise<Organization>
adminCreatePublicKey (username: string, key?: CreateKeyOption, options?: any) => AxiosPromise<PublicKey>
adminCreateRepo (username: string, repository: CreateRepoOption, options?: any) => AxiosPromise<Repository>
adminCreateUser (body?: CreateUserOption, options?: any) => AxiosPromise<User>
adminCronList (page?: number, limit?: number, options?: any) => AxiosPromise<Cron[]>
adminCronRun (task: string, options?: any) => AxiosPromise<void>
adminDeleteUnadoptedRepository (owner: string, repo: string, options?: any) => AxiosPromise<void>
adminDeleteUser (username: string, options?: any) => AxiosPromise<void>
adminDeleteUserPublicKey (username: string, id: number, options?: any) => AxiosPromise<void>
adminEditUser (username: string, body?: EditUserOption, options?: any) => AxiosPromise<User>
adminGetAllOrgs (lang?: string, page?: number, limit?: number, options?: any) => AxiosPromise<Organization[]>
adminGetAllUsers (lang?: string, page?: number, limit?: number, options?: any) => AxiosPromise<User[]>
adminUnadoptedList (page?: number, limit?: number, pattern?: string, options?: any) => AxiosPromise<string[]>

Defined in

apis/admin-api.ts:1089


AdminApiFp

AdminApiFp(configuration?): Object

AdminApi - functional programming interface

export

Parameters

Name Type
configuration? Configuration

Returns

Object

Name Type
adminAdoptRepository (owner: string, repo: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
adminCreateOrg (username: string, organization: CreateOrgOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Organization>>
adminCreatePublicKey (username: string, key?: CreateKeyOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicKey>>
adminCreateRepo (username: string, repository: CreateRepoOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository>>
adminCreateUser (body?: CreateUserOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<User>>
adminCronList (page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Cron[]>>
adminCronRun (task: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
adminDeleteUnadoptedRepository (owner: string, repo: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
adminDeleteUser (username: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
adminDeleteUserPublicKey (username: string, id: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
adminEditUser (username: string, body?: EditUserOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<User>>
adminGetAllOrgs (lang?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Organization[]>>
adminGetAllUsers (lang?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<User[]>>
adminUnadoptedList (page?: number, limit?: number, pattern?: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string[]>>

Defined in

apis/admin-api.ts:911


IssueApiAxiosParamCreator

IssueApiAxiosParamCreator(configuration?): Object

IssueApi - axios parameter creator

export

Parameters

Name Type
configuration? Configuration

Returns

Object

Name Type
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>
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>

Defined in

apis/issue-api.ts:71


IssueApiFactory

IssueApiFactory(configuration?, basePath?, axios?): Object

IssueApi - factory interface

export

Parameters

Name Type
configuration? Configuration
basePath? string
axios? AxiosInstance

Returns

Object

Name Type
issueAddLabel (owner: string, repo: string, index: number, body?: IssueLabelsOption, options?: any) => AxiosPromise<Label[]>
issueAddSubscription (owner: string, repo: string, index: number, user: string, options?: any) => AxiosPromise<void>
issueAddTime (owner: string, repo: string, index: number, body?: AddTimeOption, options?: any) => AxiosPromise<TrackedTime>
issueCheckSubscription (owner: string, repo: string, index: number, options?: any) => AxiosPromise<WatchInfo>
issueClearLabels (owner: string, repo: string, index: number, options?: any) => AxiosPromise<void>
issueCreateComment (owner: string, repo: string, index: number, body?: CreateIssueCommentOption, options?: any) => AxiosPromise<Comment>
issueCreateIssue (owner: string, repo: string, body?: CreateIssueOption, options?: any) => AxiosPromise<Issue>
issueCreateLabel (owner: string, repo: string, body?: CreateLabelOption, options?: any) => AxiosPromise<Label>
issueCreateMilestone (owner: string, repo: string, body?: CreateMilestoneOption, options?: any) => AxiosPromise<Milestone>
issueDeleteComment (owner: string, repo: string, id: number, options?: any) => AxiosPromise<void>
issueDeleteCommentDeprecated (owner: string, repo: string, index: number, id: number, options?: any) => AxiosPromise<void>
issueDeleteCommentReaction (owner: string, repo: string, id: number, content?: EditReactionOption, options?: any) => AxiosPromise<void>
issueDeleteIssueReaction (owner: string, repo: string, index: number, content?: EditReactionOption, options?: any) => AxiosPromise<void>
issueDeleteLabel (owner: string, repo: string, id: number, options?: any) => AxiosPromise<void>
issueDeleteMilestone (owner: string, repo: string, id: string, options?: any) => AxiosPromise<void>
issueDeleteStopWatch (owner: string, repo: string, index: number, options?: any) => AxiosPromise<void>
issueDeleteSubscription (owner: string, repo: string, index: number, user: string, options?: any) => AxiosPromise<void>
issueDeleteTime (owner: string, repo: string, index: number, id: number, options?: any) => AxiosPromise<void>
issueEditComment (owner: string, repo: string, id: number, body?: EditIssueCommentOption, options?: any) => AxiosPromise<Comment>
issueEditCommentDeprecated (owner: string, repo: string, index: number, id: number, body?: EditIssueCommentOption, options?: any) => AxiosPromise<Comment>
issueEditIssue (owner: string, repo: string, index: number, body?: EditIssueOption, options?: any) => AxiosPromise<Issue>
issueEditIssueDeadline (owner: string, repo: string, index: number, body?: EditDeadlineOption, options?: any) => AxiosPromise<IssueDeadline>
issueEditLabel (owner: string, repo: string, id: number, body?: EditLabelOption, options?: any) => AxiosPromise<Label>
issueEditMilestone (owner: string, repo: string, id: string, body?: EditMilestoneOption, options?: any) => AxiosPromise<Milestone>
issueGetComment (owner: string, repo: string, id: number, options?: any) => AxiosPromise<Comment>
issueGetCommentReactions (owner: string, repo: string, id: number, options?: any) => AxiosPromise<Reaction[]>
issueGetComments (owner: string, repo: string, index: number, since?: string, before?: string, options?: any) => AxiosPromise<Comment[]>
issueGetCommentsAndTimeline (owner: string, repo: string, index: number, since?: string, page?: number, limit?: number, before?: string, options?: any) => AxiosPromise<TimelineComment[]>
issueGetIssue (owner: string, repo: string, index: number, options?: any) => AxiosPromise<Issue>
issueGetIssueReactions (owner: string, repo: string, index: number, page?: number, limit?: number, options?: any) => AxiosPromise<Reaction[]>
issueGetLabel (owner: string, repo: string, id: number, options?: any) => AxiosPromise<Label>
issueGetLabels (owner: string, repo: string, index: number, options?: any) => AxiosPromise<Label[]>
issueGetMilestone (owner: string, repo: string, id: string, options?: any) => AxiosPromise<Milestone>
issueGetMilestonesList (owner: string, repo: string, state?: string, name?: string, page?: number, limit?: number, options?: any) => AxiosPromise<Milestone[]>
issueGetRepoComments (owner: string, repo: string, since?: string, before?: string, page?: number, limit?: number, options?: any) => AxiosPromise<Comment[]>
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[]>
issueListLabels (owner: string, repo: string, page?: number, limit?: number, options?: any) => AxiosPromise<Label[]>
issuePostCommentReaction (owner: string, repo: string, id: number, content?: EditReactionOption, options?: any) => AxiosPromise<Reaction>
issuePostIssueReaction (owner: string, repo: string, index: number, content?: EditReactionOption, options?: any) => AxiosPromise<Reaction>
issueRemoveLabel (owner: string, repo: string, index: number, id: number, options?: any) => AxiosPromise<void>
issueReplaceLabels (owner: string, repo: string, index: number, body?: IssueLabelsOption, options?: any) => AxiosPromise<Label[]>
issueResetTime (owner: string, repo: string, index: number, options?: any) => AxiosPromise<void>
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[]>
issueStartStopWatch (owner: string, repo: string, index: number, options?: any) => AxiosPromise<void>
issueStopStopWatch (owner: string, repo: string, index: number, options?: any) => AxiosPromise<void>
issueSubscriptions (owner: string, repo: string, index: number, page?: number, limit?: number, options?: any) => AxiosPromise<User[]>
issueTrackedTimes (owner: string, repo: string, index: number, user?: string, since?: string, before?: string, page?: number, limit?: number, options?: any) => AxiosPromise<TrackedTime[]>

Defined in

apis/issue-api.ts:4120


IssueApiFp

IssueApiFp(configuration?): Object

IssueApi - functional programming interface

export

Parameters

Name Type
configuration? Configuration

Returns

Object

Name Type
issueAddLabel (owner: string, repo: string, index: number, body?: IssueLabelsOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Label[]>>
issueAddSubscription (owner: string, repo: string, index: number, user: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
issueAddTime (owner: string, repo: string, index: number, body?: AddTimeOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TrackedTime>>
issueCheckSubscription (owner: string, repo: string, index: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WatchInfo>>
issueClearLabels (owner: string, repo: string, index: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
issueCreateComment (owner: string, repo: string, index: number, body?: CreateIssueCommentOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Comment>>
issueCreateIssue (owner: string, repo: string, body?: CreateIssueOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Issue>>
issueCreateLabel (owner: string, repo: string, body?: CreateLabelOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Label>>
issueCreateMilestone (owner: string, repo: string, body?: CreateMilestoneOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Milestone>>
issueDeleteComment (owner: string, repo: string, id: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
issueDeleteCommentDeprecated (owner: string, repo: string, index: number, id: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
issueDeleteCommentReaction (owner: string, repo: string, id: number, content?: EditReactionOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
issueDeleteIssueReaction (owner: string, repo: string, index: number, content?: EditReactionOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
issueDeleteLabel (owner: string, repo: string, id: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
issueDeleteMilestone (owner: string, repo: string, id: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
issueDeleteStopWatch (owner: string, repo: string, index: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
issueDeleteSubscription (owner: string, repo: string, index: number, user: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
issueDeleteTime (owner: string, repo: string, index: number, id: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
issueEditComment (owner: string, repo: string, id: number, body?: EditIssueCommentOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Comment>>
issueEditCommentDeprecated (owner: string, repo: string, index: number, id: number, body?: EditIssueCommentOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Comment>>
issueEditIssue (owner: string, repo: string, index: number, body?: EditIssueOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Issue>>
issueEditIssueDeadline (owner: string, repo: string, index: number, body?: EditDeadlineOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IssueDeadline>>
issueEditLabel (owner: string, repo: string, id: number, body?: EditLabelOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Label>>
issueEditMilestone (owner: string, repo: string, id: string, body?: EditMilestoneOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Milestone>>
issueGetComment (owner: string, repo: string, id: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Comment>>
issueGetCommentReactions (owner: string, repo: string, id: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Reaction[]>>
issueGetComments (owner: string, repo: string, index: number, since?: string, before?: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Comment[]>>
issueGetCommentsAndTimeline (owner: string, repo: string, index: number, since?: string, page?: number, limit?: number, before?: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TimelineComment[]>>
issueGetIssue (owner: string, repo: string, index: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Issue>>
issueGetIssueReactions (owner: string, repo: string, index: number, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Reaction[]>>
issueGetLabel (owner: string, repo: string, id: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Label>>
issueGetLabels (owner: string, repo: string, index: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Label[]>>
issueGetMilestone (owner: string, repo: string, id: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Milestone>>
issueGetMilestonesList (owner: string, repo: string, state?: string, name?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Milestone[]>>
issueGetRepoComments (owner: string, repo: string, since?: string, before?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Comment[]>>
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[]>>
issueListLabels (owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Label[]>>
issuePostCommentReaction (owner: string, repo: string, id: number, content?: EditReactionOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Reaction>>
issuePostIssueReaction (owner: string, repo: string, index: number, content?: EditReactionOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Reaction>>
issueRemoveLabel (owner: string, repo: string, index: number, id: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
issueReplaceLabels (owner: string, repo: string, index: number, body?: IssueLabelsOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Label[]>>
issueResetTime (owner: string, repo: string, index: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
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[]>>
issueStartStopWatch (owner: string, repo: string, index: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
issueStopStopWatch (owner: string, repo: string, index: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
issueSubscriptions (owner: string, repo: string, index: number, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<User[]>>
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[]>>

Defined in

apis/issue-api.ts:3431


MiscellaneousApiAxiosParamCreator

MiscellaneousApiAxiosParamCreator(configuration?): Object

MiscellaneousApi - axios parameter creator

export

Parameters

Name Type
configuration? Configuration

Returns

Object

Name Type
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>

Defined in

apis/miscellaneous-api.ts:33


MiscellaneousApiFactory

MiscellaneousApiFactory(configuration?, basePath?, axios?): Object

MiscellaneousApi - factory interface

export

Parameters

Name Type
configuration? Configuration
basePath? string
axios? AxiosInstance

Returns

Object

Name Type
getNodeInfo (options?: any) => AxiosPromise<NodeInfo>
getSigningKey (options?: any) => AxiosPromise<string>
getVersion (options?: any) => AxiosPromise<ServerVersion>
renderMarkdown (body?: MarkdownOption, options?: any) => AxiosPromise<string>
renderMarkdownRaw (body: string, options?: any) => AxiosPromise<string>

Defined in

apis/miscellaneous-api.ts:374


MiscellaneousApiFp

MiscellaneousApiFp(configuration?): Object

MiscellaneousApi - functional programming interface

export

Parameters

Name Type
configuration? Configuration

Returns

Object

Name Type
getNodeInfo (options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NodeInfo>>
getSigningKey (options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>
getVersion (options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ServerVersion>>
renderMarkdown (body?: MarkdownOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>
renderMarkdownRaw (body: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>

Defined in

apis/miscellaneous-api.ts:312


NotificationApiAxiosParamCreator

NotificationApiAxiosParamCreator(configuration?): Object

NotificationApi - axios parameter creator

export

Parameters

Name Type
configuration? Configuration

Returns

Object

Name Type
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>

Defined in

apis/notification-api.ts:31


NotificationApiFactory

NotificationApiFactory(configuration?, basePath?, axios?): Object

NotificationApi - factory interface

export

Parameters

Name Type
configuration? Configuration
basePath? string
axios? AxiosInstance

Returns

Object

Name Type
notifyGetList (all?: boolean, statusTypes?: string[], subjectType?: ("repository" | "issue" | "pull" | "commit")[], since?: string, before?: string, page?: number, limit?: number, options?: any) => AxiosPromise<NotificationThread[]>
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[]>
notifyGetThread (id: string, options?: any) => AxiosPromise<NotificationThread>
notifyNewAvailable (options?: any) => AxiosPromise<NotificationCount>
notifyReadList (lastReadAt?: string, all?: string, statusTypes?: string[], toStatus?: string, options?: any) => AxiosPromise<NotificationThread[]>
notifyReadRepoList (owner: string, repo: string, all?: string, statusTypes?: string[], toStatus?: string, lastReadAt?: string, options?: any) => AxiosPromise<NotificationThread[]>
notifyReadThread (id: string, toStatus?: string, options?: any) => AxiosPromise<NotificationThread>

Defined in

apis/notification-api.ts:664


NotificationApiFp

NotificationApiFp(configuration?): Object

NotificationApi - functional programming interface

export

Parameters

Name Type
configuration? Configuration

Returns

Object

Name Type
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[]>>
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[]>>
notifyGetThread (id: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NotificationThread>>
notifyNewAvailable (options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NotificationCount>>
notifyReadList (lastReadAt?: string, all?: string, statusTypes?: string[], toStatus?: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NotificationThread[]>>
notifyReadRepoList (owner: string, repo: string, all?: string, statusTypes?: string[], toStatus?: string, lastReadAt?: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NotificationThread[]>>
notifyReadThread (id: string, toStatus?: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NotificationThread>>

Defined in

apis/notification-api.ts:555


OrganizationApiAxiosParamCreator

OrganizationApiAxiosParamCreator(configuration?): Object

OrganizationApi - axios parameter creator

export

Parameters

Name Type
configuration? Configuration

Returns

Object

Name Type
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>
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>

Defined in

apis/organization-api.ts:61


OrganizationApiFactory

OrganizationApiFactory(configuration?, basePath?, axios?): Object

OrganizationApi - factory interface

export

Parameters

Name Type
configuration? Configuration
basePath? string
axios? AxiosInstance

Returns

Object

Name Type
createOrgRepo (org: string, body?: CreateRepoOption, options?: any) => AxiosPromise<Repository>
createOrgRepoDeprecated (org: string, body?: CreateRepoOption, options?: any) => AxiosPromise<Repository>
orgAddTeamMember (id: number, username: string, options?: any) => AxiosPromise<void>
orgAddTeamRepository (id: number, org: string, repo: string, options?: any) => AxiosPromise<void>
orgConcealMember (org: string, username: string, options?: any) => AxiosPromise<void>
orgCreate (organization: CreateOrgOption, options?: any) => AxiosPromise<Organization>
orgCreateHook (org: string, body: CreateHookOption, options?: any) => AxiosPromise<Hook>
orgCreateLabel (org: string, body?: CreateLabelOption, options?: any) => AxiosPromise<Label>
orgCreateTeam (org: string, body?: CreateTeamOption, options?: any) => AxiosPromise<Team>
orgDelete (org: string, options?: any) => AxiosPromise<void>
orgDeleteHook (org: string, id: number, options?: any) => AxiosPromise<void>
orgDeleteLabel (org: string, id: number, options?: any) => AxiosPromise<void>
orgDeleteMember (org: string, username: string, options?: any) => AxiosPromise<void>
orgDeleteTeam (id: number, options?: any) => AxiosPromise<void>
orgEdit (org: string, body: EditOrgOption, options?: any) => AxiosPromise<Organization>
orgEditHook (org: string, id: number, body?: EditHookOption, options?: any) => AxiosPromise<Hook>
orgEditLabel (org: string, id: number, body?: EditLabelOption, options?: any) => AxiosPromise<Label>
orgEditTeam (id: number, body?: EditTeamOption, options?: any) => AxiosPromise<Team>
orgGet (org: string, options?: any) => AxiosPromise<Organization>
orgGetAll (lang?: string, page?: number, limit?: number, options?: any) => AxiosPromise<Organization[]>
orgGetHook (org: string, id: number, options?: any) => AxiosPromise<Hook>
orgGetLabel (org: string, id: number, options?: any) => AxiosPromise<Label>
orgGetTeam (id: number, options?: any) => AxiosPromise<Team>
orgGetUserPermissions (username: string, org: string, options?: any) => AxiosPromise<OrganizationPermissions>
orgIsMember (org: string, username: string, options?: any) => AxiosPromise<void>
orgIsPublicMember (org: string, username: string, options?: any) => AxiosPromise<void>
orgListCurrentUserOrgs (page?: number, limit?: number, options?: any) => AxiosPromise<Organization[]>
orgListHooks (org: string, page?: number, limit?: number, options?: any) => AxiosPromise<Hook[]>
orgListLabels (org: string, page?: number, limit?: number, options?: any) => AxiosPromise<Label[]>
orgListMembers (org: string, page?: number, limit?: number, options?: any) => AxiosPromise<User[]>
orgListPublicMembers (org: string, page?: number, limit?: number, options?: any) => AxiosPromise<User[]>
orgListRepos (org: string, page?: number, limit?: number, options?: any) => AxiosPromise<Repository[]>
orgListTeamMember (id: number, username: string, options?: any) => AxiosPromise<User>
orgListTeamMembers (id: number, page?: number, limit?: number, options?: any) => AxiosPromise<User[]>
orgListTeamRepos (id: number, page?: number, limit?: number, options?: any) => AxiosPromise<Repository[]>
orgListTeams (org: string, page?: number, limit?: number, options?: any) => AxiosPromise<Team[]>
orgListUserOrgs (username: string, page?: number, limit?: number, options?: any) => AxiosPromise<Organization[]>
orgPublicizeMember (org: string, username: string, options?: any) => AxiosPromise<void>
orgRemoveTeamMember (id: number, username: string, options?: any) => AxiosPromise<void>
orgRemoveTeamRepository (id: number, org: string, repo: string, options?: any) => AxiosPromise<void>
teamSearch (org: string, q?: string, includeDesc?: boolean, page?: number, limit?: number, options?: any) => AxiosPromise<TeamSearch200Response>

Defined in

apis/organization-api.ts:3127


OrganizationApiFp

OrganizationApiFp(configuration?): Object

OrganizationApi - functional programming interface

export

Parameters

Name Type
configuration? Configuration

Returns

Object

Name Type
createOrgRepo (org: string, body?: CreateRepoOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository>>
createOrgRepoDeprecated (org: string, body?: CreateRepoOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository>>
orgAddTeamMember (id: number, username: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
orgAddTeamRepository (id: number, org: string, repo: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
orgConcealMember (org: string, username: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
orgCreate (organization: CreateOrgOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Organization>>
orgCreateHook (org: string, body: CreateHookOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Hook>>
orgCreateLabel (org: string, body?: CreateLabelOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Label>>
orgCreateTeam (org: string, body?: CreateTeamOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Team>>
orgDelete (org: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
orgDeleteHook (org: string, id: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
orgDeleteLabel (org: string, id: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
orgDeleteMember (org: string, username: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
orgDeleteTeam (id: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
orgEdit (org: string, body: EditOrgOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Organization>>
orgEditHook (org: string, id: number, body?: EditHookOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Hook>>
orgEditLabel (org: string, id: number, body?: EditLabelOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Label>>
orgEditTeam (id: number, body?: EditTeamOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Team>>
orgGet (org: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Organization>>
orgGetAll (lang?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Organization[]>>
orgGetHook (org: string, id: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Hook>>
orgGetLabel (org: string, id: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Label>>
orgGetTeam (id: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Team>>
orgGetUserPermissions (username: string, org: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrganizationPermissions>>
orgIsMember (org: string, username: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
orgIsPublicMember (org: string, username: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
orgListCurrentUserOrgs (page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Organization[]>>
orgListHooks (org: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Hook[]>>
orgListLabels (org: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Label[]>>
orgListMembers (org: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<User[]>>
orgListPublicMembers (org: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<User[]>>
orgListRepos (org: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository[]>>
orgListTeamMember (id: number, username: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<User>>
orgListTeamMembers (id: number, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<User[]>>
orgListTeamRepos (id: number, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository[]>>
orgListTeams (org: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Team[]>>
orgListUserOrgs (username: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Organization[]>>
orgPublicizeMember (org: string, username: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
orgRemoveTeamMember (id: number, username: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
orgRemoveTeamRepository (id: number, org: string, repo: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
teamSearch (org: string, q?: string, includeDesc?: boolean, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TeamSearch200Response>>

Defined in

apis/organization-api.ts:2612


RepositoryApiAxiosParamCreator

RepositoryApiAxiosParamCreator(configuration?): Object

RepositoryApi - axios parameter creator

export

Parameters

Name Type
configuration? Configuration

Returns

Object

Name Type
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>
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>
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>
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, 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>
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>
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, 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>
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>

Defined in

apis/repository-api.ts:159


RepositoryApiFactory

RepositoryApiFactory(configuration?, basePath?, axios?): Object

RepositoryApi - factory interface

export

Parameters

Name Type
configuration? Configuration
basePath? string
axios? AxiosInstance

Returns

Object

Name Type
acceptRepoTransfer (owner: string, repo: string, options?: any) => AxiosPromise<Repository>
createCurrentUserRepo (body?: CreateRepoOption, options?: any) => AxiosPromise<Repository>
createFork (owner: string, repo: string, body?: CreateForkOption, options?: any) => AxiosPromise<Repository>
generateRepo (templateOwner: string, templateRepo: string, body?: GenerateRepoOption, options?: any) => AxiosPromise<Repository>
getAnnotatedTag (owner: string, repo: string, sha: string, options?: any) => AxiosPromise<AnnotatedTag>
getBlob (owner: string, repo: string, sha: string, options?: any) => AxiosPromise<GitBlobResponse>
getTree (owner: string, repo: string, sha: string, recursive?: boolean, page?: number, perPage?: number, options?: any) => AxiosPromise<GitTreeResponse>
listForks (owner: string, repo: string, page?: number, limit?: number, options?: any) => AxiosPromise<Repository[]>
rejectRepoTransfer (owner: string, repo: string, options?: any) => AxiosPromise<Repository>
repoAddCollaborator (owner: string, repo: string, collaborator: string, body?: AddCollaboratorOption, options?: any) => AxiosPromise<void>
repoAddTeam (owner: string, repo: string, team: string, options?: any) => AxiosPromise<void>
repoAddTopic (owner: string, repo: string, topic: string, options?: any) => AxiosPromise<void>
repoCheckCollaborator (owner: string, repo: string, collaborator: string, options?: any) => AxiosPromise<void>
repoCheckTeam (owner: string, repo: string, team: string, options?: any) => AxiosPromise<Team>
repoCreateBranch (owner: string, repo: string, body?: CreateBranchRepoOption, options?: any) => AxiosPromise<Branch>
repoCreateBranchProtection (owner: string, repo: string, body?: CreateBranchProtectionOption, options?: any) => AxiosPromise<BranchProtection>
repoCreateFile (owner: string, repo: string, filepath: string, body: CreateFileOptions, options?: any) => AxiosPromise<FileResponse>
repoCreateHook (owner: string, repo: string, body?: CreateHookOption, options?: any) => AxiosPromise<Hook>
repoCreateKey (owner: string, repo: string, body?: CreateKeyOption, options?: any) => AxiosPromise<DeployKey>
repoCreatePullRequest (owner: string, repo: string, body?: CreatePullRequestOption, options?: any) => AxiosPromise<PullRequest>
repoCreatePullReview (owner: string, repo: string, index: number, body: CreatePullReviewOptions, options?: any) => AxiosPromise<PullReview>
repoCreatePullReviewRequests (owner: string, repo: string, index: number, body: PullReviewRequestOptions, options?: any) => AxiosPromise<PullReview[]>
repoCreateRelease (owner: string, repo: string, body?: CreateReleaseOption, options?: any) => AxiosPromise<Release>
repoCreateReleaseAttachment (owner: string, repo: string, id: number, attachment: File, name?: string, options?: any) => AxiosPromise<Attachment>
repoCreateStatus (owner: string, repo: string, sha: string, body?: CreateStatusOption, options?: any) => AxiosPromise<CommitStatus>
repoCreateTag (owner: string, repo: string, body?: CreateTagOption, options?: any) => AxiosPromise<Tag>
repoCreateWikiPage (owner: string, repo: string, body?: CreateWikiPageOptions, options?: any) => AxiosPromise<WikiPage>
repoDelete (owner: string, repo: string, options?: any) => AxiosPromise<void>
repoDeleteBranch (owner: string, repo: string, branch: string, options?: any) => AxiosPromise<void>
repoDeleteBranchProtection (owner: string, repo: string, name: string, options?: any) => AxiosPromise<void>
repoDeleteCollaborator (owner: string, repo: string, collaborator: string, options?: any) => AxiosPromise<void>
repoDeleteFile (owner: string, repo: string, filepath: string, body: DeleteFileOptions, options?: any) => AxiosPromise<FileDeleteResponse>
repoDeleteGitHook (owner: string, repo: string, id: string, options?: any) => AxiosPromise<void>
repoDeleteHook (owner: string, repo: string, id: number, options?: any) => AxiosPromise<void>
repoDeleteKey (owner: string, repo: string, id: number, options?: any) => AxiosPromise<void>
repoDeletePullReview (owner: string, repo: string, index: number, id: number, options?: any) => AxiosPromise<void>
repoDeletePullReviewRequests (owner: string, repo: string, index: number, body: PullReviewRequestOptions, options?: any) => AxiosPromise<void>
repoDeleteRelease (owner: string, repo: string, id: number, options?: any) => AxiosPromise<void>
repoDeleteReleaseAttachment (owner: string, repo: string, id: number, attachmentId: number, options?: any) => AxiosPromise<void>
repoDeleteReleaseByTag (owner: string, repo: string, tag: string, options?: any) => AxiosPromise<void>
repoDeleteTag (owner: string, repo: string, tag: string, options?: any) => AxiosPromise<void>
repoDeleteTeam (owner: string, repo: string, team: string, options?: any) => AxiosPromise<void>
repoDeleteTopic (owner: string, repo: string, topic: string, options?: any) => AxiosPromise<void>
repoDeleteWikiPage (owner: string, repo: string, pageName: string, options?: any) => AxiosPromise<void>
repoDismissPullReview (owner: string, repo: string, index: number, id: number, body: DismissPullReviewOptions, options?: any) => AxiosPromise<PullReview>
repoDownloadCommitDiffOrPatch (owner: string, repo: string, sha: string, diffType: "patch" | "diff", options?: any) => AxiosPromise<string>
repoDownloadPullDiffOrPatch (owner: string, repo: string, index: number, diffType: "patch" | "diff", binary?: boolean, options?: any) => AxiosPromise<string>
repoEdit (owner: string, repo: string, body?: EditRepoOption, options?: any) => AxiosPromise<Repository>
repoEditBranchProtection (owner: string, repo: string, name: string, body?: EditBranchProtectionOption, options?: any) => AxiosPromise<BranchProtection>
repoEditGitHook (owner: string, repo: string, id: string, body?: EditGitHookOption, options?: any) => AxiosPromise<GitHook>
repoEditHook (owner: string, repo: string, id: number, body?: EditHookOption, options?: any) => AxiosPromise<Hook>
repoEditPullRequest (owner: string, repo: string, index: number, body?: EditPullRequestOption, options?: any) => AxiosPromise<PullRequest>
repoEditRelease (owner: string, repo: string, id: number, body?: EditReleaseOption, options?: any) => AxiosPromise<Release>
repoEditReleaseAttachment (owner: string, repo: string, id: number, attachmentId: number, body?: EditAttachmentOptions, options?: any) => AxiosPromise<Attachment>
repoEditWikiPage (owner: string, repo: string, pageName: string, body?: CreateWikiPageOptions, options?: any) => AxiosPromise<WikiPage>
repoGet (owner: string, repo: string, options?: any) => AxiosPromise<Repository>
repoGetAllCommits (owner: string, repo: string, sha?: string, path?: string, page?: number, limit?: number, options?: any) => AxiosPromise<Commit[]>
repoGetArchive (owner: string, repo: string, archive: string, options?: any) => AxiosPromise<void>
repoGetAssignees (owner: string, repo: string, options?: any) => AxiosPromise<User[]>
repoGetBranch (owner: string, repo: string, branch: string, options?: any) => AxiosPromise<Branch>
repoGetBranchProtection (owner: string, repo: string, name: string, options?: any) => AxiosPromise<BranchProtection>
repoGetByID (id: number, options?: any) => AxiosPromise<Repository>
repoGetCombinedStatusByRef (owner: string, repo: string, ref: string, page?: number, limit?: number, options?: any) => AxiosPromise<CombinedStatus>
repoGetContents (owner: string, repo: string, filepath: string, ref?: string, options?: any) => AxiosPromise<ContentsResponse>
repoGetContentsList (owner: string, repo: string, ref?: string, options?: any) => AxiosPromise<ContentsResponse[]>
repoGetEditorConfig (owner: string, repo: string, filepath: string, options?: any) => AxiosPromise<void>
repoGetGitHook (owner: string, repo: string, id: string, options?: any) => AxiosPromise<GitHook>
repoGetHook (owner: string, repo: string, id: number, options?: any) => AxiosPromise<Hook>
repoGetIssueTemplates (owner: string, repo: string, options?: any) => AxiosPromise<IssueTemplate[]>
repoGetKey (owner: string, repo: string, id: number, options?: any) => AxiosPromise<DeployKey>
repoGetLanguages (owner: string, repo: string, options?: any) => AxiosPromise<{ [key: string]: number; }>
repoGetNote (owner: string, repo: string, sha: string, options?: any) => AxiosPromise<Note>
repoGetPullRequest (owner: string, repo: string, index: number, options?: any) => AxiosPromise<PullRequest>
repoGetPullRequestCommits (owner: string, repo: string, index: number, page?: number, limit?: number, options?: any) => AxiosPromise<Commit[]>
repoGetPullReview (owner: string, repo: string, index: number, id: number, options?: any) => AxiosPromise<PullReview>
repoGetPullReviewComments (owner: string, repo: string, index: number, id: number, options?: any) => AxiosPromise<PullReviewComment[]>
repoGetRawFile (owner: string, repo: string, filepath: string, ref?: string, options?: any) => AxiosPromise<void>
repoGetRelease (owner: string, repo: string, id: number, options?: any) => AxiosPromise<Release>
repoGetReleaseAttachment (owner: string, repo: string, id: number, attachmentId: number, options?: any) => AxiosPromise<Attachment>
repoGetReleaseByTag (owner: string, repo: string, tag: string, options?: any) => AxiosPromise<Release>
repoGetReviewers (owner: string, repo: string, options?: any) => AxiosPromise<User[]>
repoGetSingleCommit (owner: string, repo: string, sha: string, options?: any) => AxiosPromise<Commit>
repoGetTag (owner: string, repo: string, tag: string, options?: any) => AxiosPromise<Tag>
repoGetWikiPage (owner: string, repo: string, pageName: string, options?: any) => AxiosPromise<WikiPage>
repoGetWikiPageRevisions (owner: string, repo: string, pageName: string, page?: number, options?: any) => AxiosPromise<WikiCommitList>
repoGetWikiPages (owner: string, repo: string, page?: number, limit?: number, options?: any) => AxiosPromise<WikiPageMetaData[]>
repoListAllGitRefs (owner: string, repo: string, options?: any) => AxiosPromise<Reference[]>
repoListBranchProtection (owner: string, repo: string, options?: any) => AxiosPromise<BranchProtection[]>
repoListBranches (owner: string, repo: string, page?: number, limit?: number, options?: any) => AxiosPromise<Branch[]>
repoListCollaborators (owner: string, repo: string, page?: number, limit?: number, options?: any) => AxiosPromise<User[]>
repoListGitHooks (owner: string, repo: string, options?: any) => AxiosPromise<GitHook[]>
repoListGitRefs (owner: string, repo: string, ref: string, options?: any) => AxiosPromise<Reference[]>
repoListHooks (owner: string, repo: string, page?: number, limit?: number, options?: any) => AxiosPromise<Hook[]>
repoListKeys (owner: string, repo: string, keyId?: number, fingerprint?: string, page?: number, limit?: number, options?: any) => AxiosPromise<DeployKey[]>
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[]>
repoListPullReviews (owner: string, repo: string, index: number, page?: number, limit?: number, options?: any) => AxiosPromise<PullReview[]>
repoListReleaseAttachments (owner: string, repo: string, id: number, options?: any) => AxiosPromise<Attachment[]>
repoListReleases (owner: string, repo: string, draft?: boolean, preRelease?: boolean, perPage?: number, page?: number, limit?: number, options?: any) => AxiosPromise<Release[]>
repoListStargazers (owner: string, repo: string, page?: number, limit?: number, options?: any) => AxiosPromise<User[]>
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[]>
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[]>
repoListSubscribers (owner: string, repo: string, page?: number, limit?: number, options?: any) => AxiosPromise<User[]>
repoListTags (owner: string, repo: string, page?: number, limit?: number, options?: any) => AxiosPromise<Tag[]>
repoListTeams (owner: string, repo: string, options?: any) => AxiosPromise<Team[]>
repoListTopics (owner: string, repo: string, page?: number, limit?: number, options?: any) => AxiosPromise<TopicName>
repoMergePullRequest (owner: string, repo: string, index: number, body?: MergePullRequestOption, options?: any) => AxiosPromise<void>
repoMigrate (body?: MigrateRepoOptions, options?: any) => AxiosPromise<Repository>
repoMirrorSync (owner: string, repo: string, options?: any) => AxiosPromise<void>
repoPullRequestIsMerged (owner: string, repo: string, index: number, options?: any) => AxiosPromise<void>
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>
repoSigningKey (owner: string, repo: string, options?: any) => AxiosPromise<string>
repoSubmitPullReview (owner: string, repo: string, index: number, id: number, body: SubmitPullReviewOptions, options?: any) => AxiosPromise<PullReview>
repoTestHook (owner: string, repo: string, id: number, options?: any) => AxiosPromise<void>
repoTrackedTimes (owner: string, repo: string, user?: string, since?: string, before?: string, page?: number, limit?: number, options?: any) => AxiosPromise<TrackedTime[]>
repoTransfer (owner: string, repo: string, body: TransferRepoOption, options?: any) => AxiosPromise<Repository>
repoUnDismissPullReview (owner: string, repo: string, index: number, id: number, options?: any) => AxiosPromise<PullReview>
repoUpdateFile (owner: string, repo: string, filepath: string, body: UpdateFileOptions, options?: any) => AxiosPromise<FileResponse>
repoUpdatePullRequest (owner: string, repo: string, index: number, style?: "merge" | "rebase", options?: any) => AxiosPromise<void>
repoUpdateTopics (owner: string, repo: string, body?: RepoTopicOptions, options?: any) => AxiosPromise<void>
topicSearch (q: string, page?: number, limit?: number, options?: any) => AxiosPromise<TopicResponse[]>
userCurrentCheckSubscription (owner: string, repo: string, options?: any) => AxiosPromise<WatchInfo>
userCurrentDeleteSubscription (owner: string, repo: string, options?: any) => AxiosPromise<void>
userCurrentPutSubscription (owner: string, repo: string, options?: any) => AxiosPromise<WatchInfo>
userTrackedTimes (owner: string, repo: string, user: string, options?: any) => AxiosPromise<TrackedTime[]>

Defined in

apis/repository-api.ts:10241


RepositoryApiFp

RepositoryApiFp(configuration?): Object

RepositoryApi - functional programming interface

export

Parameters

Name Type
configuration? Configuration

Returns

Object

Name Type
acceptRepoTransfer (owner: string, repo: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository>>
createCurrentUserRepo (body?: CreateRepoOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository>>
createFork (owner: string, repo: string, body?: CreateForkOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository>>
generateRepo (templateOwner: string, templateRepo: string, body?: GenerateRepoOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository>>
getAnnotatedTag (owner: string, repo: string, sha: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AnnotatedTag>>
getBlob (owner: string, repo: string, sha: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GitBlobResponse>>
getTree (owner: string, repo: string, sha: string, recursive?: boolean, page?: number, perPage?: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GitTreeResponse>>
listForks (owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository[]>>
rejectRepoTransfer (owner: string, repo: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository>>
repoAddCollaborator (owner: string, repo: string, collaborator: string, body?: AddCollaboratorOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
repoAddTeam (owner: string, repo: string, team: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
repoAddTopic (owner: string, repo: string, topic: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
repoCheckCollaborator (owner: string, repo: string, collaborator: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
repoCheckTeam (owner: string, repo: string, team: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Team>>
repoCreateBranch (owner: string, repo: string, body?: CreateBranchRepoOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Branch>>
repoCreateBranchProtection (owner: string, repo: string, body?: CreateBranchProtectionOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BranchProtection>>
repoCreateFile (owner: string, repo: string, filepath: string, body: CreateFileOptions, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileResponse>>
repoCreateHook (owner: string, repo: string, body?: CreateHookOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Hook>>
repoCreateKey (owner: string, repo: string, body?: CreateKeyOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeployKey>>
repoCreatePullRequest (owner: string, repo: string, body?: CreatePullRequestOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PullRequest>>
repoCreatePullReview (owner: string, repo: string, index: number, body: CreatePullReviewOptions, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PullReview>>
repoCreatePullReviewRequests (owner: string, repo: string, index: number, body: PullReviewRequestOptions, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PullReview[]>>
repoCreateRelease (owner: string, repo: string, body?: CreateReleaseOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Release>>
repoCreateReleaseAttachment (owner: string, repo: string, id: number, attachment: File, name?: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Attachment>>
repoCreateStatus (owner: string, repo: string, sha: string, body?: CreateStatusOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommitStatus>>
repoCreateTag (owner: string, repo: string, body?: CreateTagOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Tag>>
repoCreateWikiPage (owner: string, repo: string, body?: CreateWikiPageOptions, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WikiPage>>
repoDelete (owner: string, repo: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
repoDeleteBranch (owner: string, repo: string, branch: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
repoDeleteBranchProtection (owner: string, repo: string, name: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
repoDeleteCollaborator (owner: string, repo: string, collaborator: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
repoDeleteFile (owner: string, repo: string, filepath: string, body: DeleteFileOptions, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileDeleteResponse>>
repoDeleteGitHook (owner: string, repo: string, id: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
repoDeleteHook (owner: string, repo: string, id: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
repoDeleteKey (owner: string, repo: string, id: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
repoDeletePullReview (owner: string, repo: string, index: number, id: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
repoDeletePullReviewRequests (owner: string, repo: string, index: number, body: PullReviewRequestOptions, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
repoDeleteRelease (owner: string, repo: string, id: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
repoDeleteReleaseAttachment (owner: string, repo: string, id: number, attachmentId: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
repoDeleteReleaseByTag (owner: string, repo: string, tag: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
repoDeleteTag (owner: string, repo: string, tag: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
repoDeleteTeam (owner: string, repo: string, team: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
repoDeleteTopic (owner: string, repo: string, topic: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
repoDeleteWikiPage (owner: string, repo: string, pageName: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
repoDismissPullReview (owner: string, repo: string, index: number, id: number, body: DismissPullReviewOptions, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PullReview>>
repoDownloadCommitDiffOrPatch (owner: string, repo: string, sha: string, diffType: "patch" | "diff", options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>
repoDownloadPullDiffOrPatch (owner: string, repo: string, index: number, diffType: "patch" | "diff", binary?: boolean, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>
repoEdit (owner: string, repo: string, body?: EditRepoOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository>>
repoEditBranchProtection (owner: string, repo: string, name: string, body?: EditBranchProtectionOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BranchProtection>>
repoEditGitHook (owner: string, repo: string, id: string, body?: EditGitHookOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GitHook>>
repoEditHook (owner: string, repo: string, id: number, body?: EditHookOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Hook>>
repoEditPullRequest (owner: string, repo: string, index: number, body?: EditPullRequestOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PullRequest>>
repoEditRelease (owner: string, repo: string, id: number, body?: EditReleaseOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Release>>
repoEditReleaseAttachment (owner: string, repo: string, id: number, attachmentId: number, body?: EditAttachmentOptions, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Attachment>>
repoEditWikiPage (owner: string, repo: string, pageName: string, body?: CreateWikiPageOptions, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WikiPage>>
repoGet (owner: string, repo: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository>>
repoGetAllCommits (owner: string, repo: string, sha?: string, path?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Commit[]>>
repoGetArchive (owner: string, repo: string, archive: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
repoGetAssignees (owner: string, repo: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<User[]>>
repoGetBranch (owner: string, repo: string, branch: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Branch>>
repoGetBranchProtection (owner: string, repo: string, name: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BranchProtection>>
repoGetByID (id: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository>>
repoGetCombinedStatusByRef (owner: string, repo: string, ref: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CombinedStatus>>
repoGetContents (owner: string, repo: string, filepath: string, ref?: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ContentsResponse>>
repoGetContentsList (owner: string, repo: string, ref?: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ContentsResponse[]>>
repoGetEditorConfig (owner: string, repo: string, filepath: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
repoGetGitHook (owner: string, repo: string, id: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GitHook>>
repoGetHook (owner: string, repo: string, id: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Hook>>
repoGetIssueTemplates (owner: string, repo: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IssueTemplate[]>>
repoGetKey (owner: string, repo: string, id: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeployKey>>
repoGetLanguages (owner: string, repo: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{ [key: string]: number; }>>
repoGetNote (owner: string, repo: string, sha: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Note>>
repoGetPullRequest (owner: string, repo: string, index: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PullRequest>>
repoGetPullRequestCommits (owner: string, repo: string, index: number, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Commit[]>>
repoGetPullReview (owner: string, repo: string, index: number, id: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PullReview>>
repoGetPullReviewComments (owner: string, repo: string, index: number, id: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PullReviewComment[]>>
repoGetRawFile (owner: string, repo: string, filepath: string, ref?: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
repoGetRelease (owner: string, repo: string, id: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Release>>
repoGetReleaseAttachment (owner: string, repo: string, id: number, attachmentId: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Attachment>>
repoGetReleaseByTag (owner: string, repo: string, tag: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Release>>
repoGetReviewers (owner: string, repo: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<User[]>>
repoGetSingleCommit (owner: string, repo: string, sha: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Commit>>
repoGetTag (owner: string, repo: string, tag: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Tag>>
repoGetWikiPage (owner: string, repo: string, pageName: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WikiPage>>
repoGetWikiPageRevisions (owner: string, repo: string, pageName: string, page?: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WikiCommitList>>
repoGetWikiPages (owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WikiPageMetaData[]>>
repoListAllGitRefs (owner: string, repo: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Reference[]>>
repoListBranchProtection (owner: string, repo: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BranchProtection[]>>
repoListBranches (owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Branch[]>>
repoListCollaborators (owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<User[]>>
repoListGitHooks (owner: string, repo: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GitHook[]>>
repoListGitRefs (owner: string, repo: string, ref: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Reference[]>>
repoListHooks (owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Hook[]>>
repoListKeys (owner: string, repo: string, keyId?: number, fingerprint?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeployKey[]>>
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[]>>
repoListPullReviews (owner: string, repo: string, index: number, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PullReview[]>>
repoListReleaseAttachments (owner: string, repo: string, id: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Attachment[]>>
repoListReleases (owner: string, repo: string, draft?: boolean, preRelease?: boolean, perPage?: number, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Release[]>>
repoListStargazers (owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<User[]>>
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[]>>
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[]>>
repoListSubscribers (owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<User[]>>
repoListTags (owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Tag[]>>
repoListTeams (owner: string, repo: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Team[]>>
repoListTopics (owner: string, repo: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TopicName>>
repoMergePullRequest (owner: string, repo: string, index: number, body?: MergePullRequestOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
repoMigrate (body?: MigrateRepoOptions, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository>>
repoMirrorSync (owner: string, repo: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
repoPullRequestIsMerged (owner: string, repo: string, index: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
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>>
repoSigningKey (owner: string, repo: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>
repoSubmitPullReview (owner: string, repo: string, index: number, id: number, body: SubmitPullReviewOptions, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PullReview>>
repoTestHook (owner: string, repo: string, id: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
repoTrackedTimes (owner: string, repo: string, user?: string, since?: string, before?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TrackedTime[]>>
repoTransfer (owner: string, repo: string, body: TransferRepoOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository>>
repoUnDismissPullReview (owner: string, repo: string, index: number, id: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PullReview>>
repoUpdateFile (owner: string, repo: string, filepath: string, body: UpdateFileOptions, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileResponse>>
repoUpdatePullRequest (owner: string, repo: string, index: number, style?: "merge" | "rebase", options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
repoUpdateTopics (owner: string, repo: string, body?: RepoTopicOptions, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
topicSearch (q: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TopicResponse[]>>
userCurrentCheckSubscription (owner: string, repo: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WatchInfo>>
userCurrentDeleteSubscription (owner: string, repo: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
userCurrentPutSubscription (owner: string, repo: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WatchInfo>>
userTrackedTimes (owner: string, repo: string, user: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TrackedTime[]>>

Defined in

apis/repository-api.ts:8540


SettingsApiAxiosParamCreator

SettingsApiAxiosParamCreator(configuration?): Object

SettingsApi - axios parameter creator

export

Parameters

Name Type
configuration? Configuration

Returns

Object

Name Type
getGeneralAPISettings (options: AxiosRequestConfig) => Promise<RequestArgs>
getGeneralAttachmentSettings (options: AxiosRequestConfig) => Promise<RequestArgs>
getGeneralRepositorySettings (options: AxiosRequestConfig) => Promise<RequestArgs>
getGeneralUISettings (options: AxiosRequestConfig) => Promise<RequestArgs>

Defined in

apis/settings-api.ts:35


SettingsApiFactory

SettingsApiFactory(configuration?, basePath?, axios?): Object

SettingsApi - factory interface

export

Parameters

Name Type
configuration? Configuration
basePath? string
axios? AxiosInstance

Returns

Object

Name Type
getGeneralAPISettings (options?: any) => AxiosPromise<GeneralAPISettings>
getGeneralAttachmentSettings (options?: any) => AxiosPromise<GeneralAttachmentSettings>
getGeneralRepositorySettings (options?: any) => AxiosPromise<GeneralRepoSettings>
getGeneralUISettings (options?: any) => AxiosPromise<GeneralUISettings>

Defined in

apis/settings-api.ts:302


SettingsApiFp

SettingsApiFp(configuration?): Object

SettingsApi - functional programming interface

export

Parameters

Name Type
configuration? Configuration

Returns

Object

Name Type
getGeneralAPISettings (options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GeneralAPISettings>>
getGeneralAttachmentSettings (options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GeneralAttachmentSettings>>
getGeneralRepositorySettings (options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GeneralRepoSettings>>
getGeneralUISettings (options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GeneralUISettings>>

Defined in

apis/settings-api.ts:252


UserApiAxiosParamCreator

UserApiAxiosParamCreator(configuration?): Object

UserApi - axios parameter creator

export

Parameters

Name Type
configuration? Configuration

Returns

Object

Name Type
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 (follower: string, followee: 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 (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>

Defined in

apis/user-api.ts:69


UserApiFactory

UserApiFactory(configuration?, basePath?, axios?): Object

UserApi - factory interface

export

Parameters

Name Type
configuration? Configuration
basePath? string
axios? AxiosInstance

Returns

Object

Name Type
createCurrentUserRepo (body?: CreateRepoOption, options?: any) => AxiosPromise<Repository>
getUserSettings (options?: any) => AxiosPromise<UserSettings[]>
getVerificationToken (options?: any) => AxiosPromise<string>
updateUserSettings (body?: UserSettingsOptions, options?: any) => AxiosPromise<UserSettings[]>
userAddEmail (body?: CreateEmailOption, options?: any) => AxiosPromise<Email[]>
userCheckFollowing (follower: string, followee: string, options?: any) => AxiosPromise<void>
userCreateOAuth2Application (body: CreateOAuth2ApplicationOptions, options?: any) => AxiosPromise<OAuth2Application>
userCreateToken (username: string, userCreateToken?: CreateAccessTokenOption, options?: any) => AxiosPromise<AccessToken>
userCurrentCheckFollowing (username: string, options?: any) => AxiosPromise<void>
userCurrentCheckStarring (owner: string, repo: string, options?: any) => AxiosPromise<void>
userCurrentDeleteFollow (username: string, options?: any) => AxiosPromise<void>
userCurrentDeleteGPGKey (id: number, options?: any) => AxiosPromise<void>
userCurrentDeleteKey (id: number, options?: any) => AxiosPromise<void>
userCurrentDeleteStar (owner: string, repo: string, options?: any) => AxiosPromise<void>
userCurrentGetGPGKey (id: number, options?: any) => AxiosPromise<GPGKey>
userCurrentGetKey (id: number, options?: any) => AxiosPromise<PublicKey>
userCurrentListFollowers (page?: number, limit?: number, options?: any) => AxiosPromise<User[]>
userCurrentListFollowing (page?: number, limit?: number, options?: any) => AxiosPromise<User[]>
userCurrentListGPGKeys (page?: number, limit?: number, options?: any) => AxiosPromise<GPGKey[]>
userCurrentListKeys (fingerprint?: string, page?: number, limit?: number, options?: any) => AxiosPromise<PublicKey[]>
userCurrentListRepos (page?: number, limit?: number, options?: any) => AxiosPromise<Repository[]>
userCurrentListStarred (page?: number, limit?: number, options?: any) => AxiosPromise<Repository[]>
userCurrentListSubscriptions (page?: number, limit?: number, options?: any) => AxiosPromise<Repository[]>
userCurrentPostGPGKey (form?: CreateGPGKeyOption, options?: any) => AxiosPromise<GPGKey>
userCurrentPostKey (body?: CreateKeyOption, options?: any) => AxiosPromise<PublicKey>
userCurrentPutFollow (username: string, options?: any) => AxiosPromise<void>
userCurrentPutStar (owner: string, repo: string, options?: any) => AxiosPromise<void>
userCurrentTrackedTimes (since?: string, before?: string, options?: any) => AxiosPromise<TrackedTime[]>
userDeleteAccessToken (username: string, token: string, options?: any) => AxiosPromise<void>
userDeleteEmail (body?: DeleteEmailOption, options?: any) => AxiosPromise<void>
userDeleteOAuth2Application (id: number, options?: any) => AxiosPromise<void>
userGet (username: string, options?: any) => AxiosPromise<User>
userGetCurrent (options?: any) => AxiosPromise<User>
userGetHeatmapData (username: string, options?: any) => AxiosPromise<UserHeatmapData[]>
userGetOAuth2Application (id: number, options?: any) => AxiosPromise<OAuth2Application>
userGetOauth2Application (page?: number, limit?: number, options?: any) => AxiosPromise<OAuth2Application[]>
userGetStopWatches (page?: number, limit?: number, options?: any) => AxiosPromise<StopWatch[]>
userGetTokens (username: string, page?: number, limit?: number, options?: any) => AxiosPromise<AccessToken[]>
userListEmails (options?: any) => AxiosPromise<Email[]>
userListFollowers (username: string, page?: number, limit?: number, options?: any) => AxiosPromise<User[]>
userListFollowing (username: string, page?: number, limit?: number, options?: any) => AxiosPromise<User[]>
userListGPGKeys (username: string, page?: number, limit?: number, options?: any) => AxiosPromise<GPGKey[]>
userListKeys (username: string, fingerprint?: string, page?: number, limit?: number, options?: any) => AxiosPromise<PublicKey[]>
userListRepos (username: string, page?: number, limit?: number, options?: any) => AxiosPromise<Repository[]>
userListStarred (username: string, page?: number, limit?: number, options?: any) => AxiosPromise<Repository[]>
userListSubscriptions (username: string, page?: number, limit?: number, options?: any) => AxiosPromise<Repository[]>
userListTeams (page?: number, limit?: number, options?: any) => AxiosPromise<Team[]>
userSearch (q?: string, uid?: number, lang?: string, page?: number, limit?: number, options?: any) => AxiosPromise<UserSearch200Response>
userUpdateOAuth2Application (id: number, body: CreateOAuth2ApplicationOptions, options?: any) => AxiosPromise<OAuth2Application>
userVerifyGPGKey (options?: any) => AxiosPromise<GPGKey>

Defined in

apis/user-api.ts:3666


UserApiFp

UserApiFp(configuration?): Object

UserApi - functional programming interface

export

Parameters

Name Type
configuration? Configuration

Returns

Object

Name Type
createCurrentUserRepo (body?: CreateRepoOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository>>
getUserSettings (options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserSettings[]>>
getVerificationToken (options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>
updateUserSettings (body?: UserSettingsOptions, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserSettings[]>>
userAddEmail (body?: CreateEmailOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Email[]>>
userCheckFollowing (follower: string, followee: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
userCreateOAuth2Application (body: CreateOAuth2ApplicationOptions, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OAuth2Application>>
userCreateToken (username: string, userCreateToken?: CreateAccessTokenOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccessToken>>
userCurrentCheckFollowing (username: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
userCurrentCheckStarring (owner: string, repo: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
userCurrentDeleteFollow (username: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
userCurrentDeleteGPGKey (id: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
userCurrentDeleteKey (id: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
userCurrentDeleteStar (owner: string, repo: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
userCurrentGetGPGKey (id: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GPGKey>>
userCurrentGetKey (id: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicKey>>
userCurrentListFollowers (page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<User[]>>
userCurrentListFollowing (page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<User[]>>
userCurrentListGPGKeys (page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GPGKey[]>>
userCurrentListKeys (fingerprint?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicKey[]>>
userCurrentListRepos (page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository[]>>
userCurrentListStarred (page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository[]>>
userCurrentListSubscriptions (page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository[]>>
userCurrentPostGPGKey (form?: CreateGPGKeyOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GPGKey>>
userCurrentPostKey (body?: CreateKeyOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicKey>>
userCurrentPutFollow (username: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
userCurrentPutStar (owner: string, repo: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
userCurrentTrackedTimes (since?: string, before?: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TrackedTime[]>>
userDeleteAccessToken (username: string, token: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
userDeleteEmail (body?: DeleteEmailOption, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
userDeleteOAuth2Application (id: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
userGet (username: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<User>>
userGetCurrent (options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<User>>
userGetHeatmapData (username: string, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserHeatmapData[]>>
userGetOAuth2Application (id: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OAuth2Application>>
userGetOauth2Application (page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OAuth2Application[]>>
userGetStopWatches (page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StopWatch[]>>
userGetTokens (username: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccessToken[]>>
userListEmails (options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Email[]>>
userListFollowers (username: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<User[]>>
userListFollowing (username: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<User[]>>
userListGPGKeys (username: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GPGKey[]>>
userListKeys (username: string, fingerprint?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicKey[]>>
userListRepos (username: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository[]>>
userListStarred (username: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository[]>>
userListSubscriptions (username: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Repository[]>>
userListTeams (page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Team[]>>
userSearch (q?: string, uid?: number, lang?: string, page?: number, limit?: number, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserSearch200Response>>
userUpdateOAuth2Application (id: number, body: CreateOAuth2ApplicationOptions, options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OAuth2Application>>
userVerifyGPGKey (options?: AxiosRequestConfig) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GPGKey>>

Defined in

apis/user-api.ts:3071