> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corsair.dev/llms.txt
> Use this file to discover all available pages before exploring further.
# API
> API reference for Github: every `github.api.*` operation with input and output types.
Every `github.api.*` operation is listed below with parameter shapes and return types from the plugin Zod schemas.
**New to Corsair?** See [API access](/concepts/api), [authentication](/concepts/auth), and [error handling](/concepts/error-handling).
## Comments
### delete
`comments.delete`
Delete a comment
**Risk:** `write`
```ts theme={null}
await corsair.github.api.comments.delete({});
```
**Input**
| Name | Type | Required | Description |
| ----------- | -------- | -------- | ----------- |
| `owner` | `string` | Yes | — |
| `repo` | `string` | Yes | — |
| `commentId` | `number` | Yes | — |
**Output:** `void`
***
### get
`comments.get`
Get a specific comment
**Risk:** `read`
```ts theme={null}
await corsair.github.api.comments.get({});
```
**Input**
| Name | Type | Required | Description |
| ----------- | -------- | -------- | ----------- |
| `owner` | `string` | Yes | — |
| `repo` | `string` | Yes | — |
| `commentId` | `number` | Yes | — |
**Output**
| Name | Type | Required | Description |
| ------------------- | -------- | -------- | ----------- |
| `id` | `number` | Yes | — |
| `nodeId` | `string` | No | — |
| `url` | `string` | No | — |
| `htmlUrl` | `string` | No | — |
| `issueUrl` | `string` | No | — |
| `body` | `string` | No | — |
| `authorAssociation` | `string` | No | — |
| `createdAt` | `Date` | No | — |
| `updatedAt` | `Date` | No | — |
***
### list
`comments.list`
List all comments in a repository
**Risk:** `read`
```ts theme={null}
await corsair.github.api.comments.list({});
```
**Input**
| Name | Type | Required | Description |
| ----------- | -------------------- | -------- | ----------- |
| `owner` | `string` | Yes | — |
| `repo` | `string` | Yes | — |
| `sort` | `created \| updated` | No | — |
| `direction` | `asc \| desc` | No | — |
| `since` | `string` | No | — |
| `perPage` | `number` | No | — |
| `page` | `number` | No | — |
**Output:** `object[]`
```ts theme={null}
{
id: number,
nodeId?: string,
url?: string,
htmlUrl?: string,
issueUrl?: string,
body?: string,
authorAssociation?: string,
createdAt?: Date | null,
updatedAt?: Date | null
}[]
```
***
### listForIssue
`comments.listForIssue`
List comments on a specific issue or pull request
**Risk:** `read`
```ts theme={null}
await corsair.github.api.comments.listForIssue({});
```
**Input**
| Name | Type | Required | Description |
| ------------- | -------- | -------- | ----------- |
| `owner` | `string` | Yes | — |
| `repo` | `string` | Yes | — |
| `issueNumber` | `number` | Yes | — |
| `since` | `string` | No | — |
| `perPage` | `number` | No | — |
| `page` | `number` | No | — |
**Output:** `object[]`
```ts theme={null}
{
id: number,
nodeId?: string,
url?: string,
htmlUrl?: string,
issueUrl?: string,
body?: string,
authorAssociation?: string,
createdAt?: Date | null,
updatedAt?: Date | null
}[]
```
***
### update
`comments.update`
Update a comment
**Risk:** `write`
```ts theme={null}
await corsair.github.api.comments.update({});
```
**Input**
| Name | Type | Required | Description |
| ----------- | -------- | -------- | ----------- |
| `owner` | `string` | Yes | — |
| `repo` | `string` | Yes | — |
| `commentId` | `number` | Yes | — |
| `body` | `string` | Yes | — |
**Output**
| Name | Type | Required | Description |
| ------------------- | -------- | -------- | ----------- |
| `id` | `number` | Yes | — |
| `nodeId` | `string` | No | — |
| `url` | `string` | No | — |
| `htmlUrl` | `string` | No | — |
| `issueUrl` | `string` | No | — |
| `body` | `string` | No | — |
| `authorAssociation` | `string` | No | — |
| `createdAt` | `Date` | No | — |
| `updatedAt` | `Date` | No | — |
***
## Discussions
### get
`discussions.get`
Get a specific discussion
**Risk:** `read`
```ts theme={null}
await corsair.github.api.discussions.get({});
```
**Input**
| Name | Type | Required | Description |
| ------------------ | -------- | -------- | ----------- |
| `owner` | `string` | Yes | — |
| `repo` | `string` | Yes | — |
| `discussionNumber` | `number` | Yes | — |
**Output**
| Name | Type | Required | Description |
| ------------------- | --------- | -------- | ----------- |
| `id` | `number` | Yes | — |
| `nodeId` | `string` | No | — |
| `number` | `number` | Yes | — |
| `title` | `string` | Yes | — |
| `body` | `string` | No | — |
| `htmlUrl` | `string` | No | — |
| `repositoryUrl` | `string` | No | — |
| `state` | `string` | No | — |
| `locked` | `boolean` | No | — |
| `comments` | `number` | No | — |
| `authorAssociation` | `string` | No | — |
| `category` | `object` | No | — |
| `createdAt` | `Date` | No | — |
| `updatedAt` | `Date` | No | — |
| `answerChosenAt` | `Date` | No | — |
```ts theme={null}
{
id: number,
nodeId?: string,
repositoryId?: number,
emoji?: string,
name: string,
description?: string,
createdAt?: Date | null,
updatedAt?: Date | null,
slug?: string,
isAnswerable?: boolean
}
```
***
### list
`discussions.list`
List discussions in a repository
**Risk:** `read`
```ts theme={null}
await corsair.github.api.discussions.list({});
```
**Input**
| Name | Type | Required | Description |
| --------- | -------- | -------- | ----------- |
| `owner` | `string` | Yes | — |
| `repo` | `string` | Yes | — |
| `perPage` | `number` | No | — |
| `page` | `number` | No | — |
**Output:** `object[]`
```ts theme={null}
{
id: number,
nodeId?: string,
number: number,
title: string,
body?: string | null,
htmlUrl?: string,
repositoryUrl?: string,
state?: string,
locked?: boolean,
comments?: number,
authorAssociation?: string,
category?: {
id: number,
nodeId?: string,
repositoryId?: number,
emoji?: string,
name: string,
description?: string,
createdAt?: Date | null,
updatedAt?: Date | null,
slug?: string,
isAnswerable?: boolean
},
createdAt?: Date | null,
updatedAt?: Date | null,
answerChosenAt?: Date | null
}[]
```
***
## Events
### list
`events.list`
List public GitHub events
**Risk:** `read`
```ts theme={null}
await corsair.github.api.events.list({});
```
**Input**
| Name | Type | Required | Description |
| --------- | -------- | -------- | ----------- |
| `perPage` | `number` | No | — |
| `page` | `number` | No | — |
**Output:** `object[]`
```ts theme={null}
{
id: string,
type: string,
actor?: {
name?: string | null,
email?: string | null,
login: string,
id: number,
nodeId?: string,
avatarUrl?: string,
gravatarId?: string | null,
url?: string,
htmlUrl?: string,
followersUrl?: string,
followingUrl?: string,
gistsUrl?: string,
starredUrl?: string,
subscriptionsUrl?: string,
organizationsUrl?: string,
reposUrl?: string,
eventsUrl?: string,
receivedEventsUrl?: string,
type?: string,
siteAdmin?: boolean,
starredAt?: Date | null,
userViewType?: string
},
repo?: {
id: number,
name: string,
url?: string
},
org?: {
name?: string | null,
email?: string | null,
login: string,
id: number,
nodeId?: string,
avatarUrl?: string,
gravatarId?: string | null,
url?: string,
htmlUrl?: string,
followersUrl?: string,
followingUrl?: string,
gistsUrl?: string,
starredUrl?: string,
subscriptionsUrl?: string,
organizationsUrl?: string,
reposUrl?: string,
eventsUrl?: string,
receivedEventsUrl?: string,
type?: string,
siteAdmin?: boolean,
starredAt?: Date | null,
userViewType?: string
},
payload?: {
},
public?: boolean,
createdAt?: Date | null
}[]
```
***
### listForNetwork
`events.listForNetwork`
List public events for a repository network
**Risk:** `read`
```ts theme={null}
await corsair.github.api.events.listForNetwork({});
```
**Input**
| Name | Type | Required | Description |
| --------- | -------- | -------- | ----------- |
| `owner` | `string` | Yes | — |
| `repo` | `string` | Yes | — |
| `perPage` | `number` | No | — |
| `page` | `number` | No | — |
**Output:** `object[]`
```ts theme={null}
{
id: string,
type: string,
actor?: {
name?: string | null,
email?: string | null,
login: string,
id: number,
nodeId?: string,
avatarUrl?: string,
gravatarId?: string | null,
url?: string,
htmlUrl?: string,
followersUrl?: string,
followingUrl?: string,
gistsUrl?: string,
starredUrl?: string,
subscriptionsUrl?: string,
organizationsUrl?: string,
reposUrl?: string,
eventsUrl?: string,
receivedEventsUrl?: string,
type?: string,
siteAdmin?: boolean,
starredAt?: Date | null,
userViewType?: string
},
repo?: {
id: number,
name: string,
url?: string
},
org?: {
name?: string | null,
email?: string | null,
login: string,
id: number,
nodeId?: string,
avatarUrl?: string,
gravatarId?: string | null,
url?: string,
htmlUrl?: string,
followersUrl?: string,
followingUrl?: string,
gistsUrl?: string,
starredUrl?: string,
subscriptionsUrl?: string,
organizationsUrl?: string,
reposUrl?: string,
eventsUrl?: string,
receivedEventsUrl?: string,
type?: string,
siteAdmin?: boolean,
starredAt?: Date | null,
userViewType?: string
},
payload?: {
},
public?: boolean,
createdAt?: Date | null
}[]
```
***
### listForOrg
`events.listForOrg`
List public events for an organization
**Risk:** `read`
```ts theme={null}
await corsair.github.api.events.listForOrg({});
```
**Input**
| Name | Type | Required | Description |
| --------- | -------- | -------- | ----------- |
| `org` | `string` | Yes | — |
| `perPage` | `number` | No | — |
| `page` | `number` | No | — |
**Output:** `object[]`
```ts theme={null}
{
id: string,
type: string,
actor?: {
name?: string | null,
email?: string | null,
login: string,
id: number,
nodeId?: string,
avatarUrl?: string,
gravatarId?: string | null,
url?: string,
htmlUrl?: string,
followersUrl?: string,
followingUrl?: string,
gistsUrl?: string,
starredUrl?: string,
subscriptionsUrl?: string,
organizationsUrl?: string,
reposUrl?: string,
eventsUrl?: string,
receivedEventsUrl?: string,
type?: string,
siteAdmin?: boolean,
starredAt?: Date | null,
userViewType?: string
},
repo?: {
id: number,
name: string,
url?: string
},
org?: {
name?: string | null,
email?: string | null,
login: string,
id: number,
nodeId?: string,
avatarUrl?: string,
gravatarId?: string | null,
url?: string,
htmlUrl?: string,
followersUrl?: string,
followingUrl?: string,
gistsUrl?: string,
starredUrl?: string,
subscriptionsUrl?: string,
organizationsUrl?: string,
reposUrl?: string,
eventsUrl?: string,
receivedEventsUrl?: string,
type?: string,
siteAdmin?: boolean,
starredAt?: Date | null,
userViewType?: string
},
payload?: {
},
public?: boolean,
createdAt?: Date | null
}[]
```
***
### listForRepository
`events.listForRepository`
List events for a repository
**Risk:** `read`
```ts theme={null}
await corsair.github.api.events.listForRepository({});
```
**Input**
| Name | Type | Required | Description |
| --------- | -------- | -------- | ----------- |
| `owner` | `string` | Yes | — |
| `repo` | `string` | Yes | — |
| `perPage` | `number` | No | — |
| `page` | `number` | No | — |
**Output:** `object[]`
```ts theme={null}
{
id: string,
type: string,
actor?: {
name?: string | null,
email?: string | null,
login: string,
id: number,
nodeId?: string,
avatarUrl?: string,
gravatarId?: string | null,
url?: string,
htmlUrl?: string,
followersUrl?: string,
followingUrl?: string,
gistsUrl?: string,
starredUrl?: string,
subscriptionsUrl?: string,
organizationsUrl?: string,
reposUrl?: string,
eventsUrl?: string,
receivedEventsUrl?: string,
type?: string,
siteAdmin?: boolean,
starredAt?: Date | null,
userViewType?: string
},
repo?: {
id: number,
name: string,
url?: string
},
org?: {
name?: string | null,
email?: string | null,
login: string,
id: number,
nodeId?: string,
avatarUrl?: string,
gravatarId?: string | null,
url?: string,
htmlUrl?: string,
followersUrl?: string,
followingUrl?: string,
gistsUrl?: string,
starredUrl?: string,
subscriptionsUrl?: string,
organizationsUrl?: string,
reposUrl?: string,
eventsUrl?: string,
receivedEventsUrl?: string,
type?: string,
siteAdmin?: boolean,
starredAt?: Date | null,
userViewType?: string
},
payload?: {
},
public?: boolean,
createdAt?: Date | null
}[]
```
***
### listForUser
`events.listForUser`
List events for a user
**Risk:** `read`
```ts theme={null}
await corsair.github.api.events.listForUser({});
```
**Input**
| Name | Type | Required | Description |
| ---------- | -------- | -------- | ----------- |
| `username` | `string` | Yes | — |
| `perPage` | `number` | No | — |
| `page` | `number` | No | — |
**Output:** `object[]`
```ts theme={null}
{
id: string,
type: string,
actor?: {
name?: string | null,
email?: string | null,
login: string,
id: number,
nodeId?: string,
avatarUrl?: string,
gravatarId?: string | null,
url?: string,
htmlUrl?: string,
followersUrl?: string,
followingUrl?: string,
gistsUrl?: string,
starredUrl?: string,
subscriptionsUrl?: string,
organizationsUrl?: string,
reposUrl?: string,
eventsUrl?: string,
receivedEventsUrl?: string,
type?: string,
siteAdmin?: boolean,
starredAt?: Date | null,
userViewType?: string
},
repo?: {
id: number,
name: string,
url?: string
},
org?: {
name?: string | null,
email?: string | null,
login: string,
id: number,
nodeId?: string,
avatarUrl?: string,
gravatarId?: string | null,
url?: string,
htmlUrl?: string,
followersUrl?: string,
followingUrl?: string,
gistsUrl?: string,
starredUrl?: string,
subscriptionsUrl?: string,
organizationsUrl?: string,
reposUrl?: string,
eventsUrl?: string,
receivedEventsUrl?: string,
type?: string,
siteAdmin?: boolean,
starredAt?: Date | null,
userViewType?: string
},
payload?: {
},
public?: boolean,
createdAt?: Date | null
}[]
```
***
### listForUserOrg
`events.listForUserOrg`
List organization events for a user
**Risk:** `read`
```ts theme={null}
await corsair.github.api.events.listForUserOrg({});
```
**Input**
| Name | Type | Required | Description |
| ---------- | -------- | -------- | ----------- |
| `username` | `string` | Yes | — |
| `org` | `string` | Yes | — |
| `perPage` | `number` | No | — |
| `page` | `number` | No | — |
**Output:** `object[]`
```ts theme={null}
{
id: string,
type: string,
actor?: {
name?: string | null,
email?: string | null,
login: string,
id: number,
nodeId?: string,
avatarUrl?: string,
gravatarId?: string | null,
url?: string,
htmlUrl?: string,
followersUrl?: string,
followingUrl?: string,
gistsUrl?: string,
starredUrl?: string,
subscriptionsUrl?: string,
organizationsUrl?: string,
reposUrl?: string,
eventsUrl?: string,
receivedEventsUrl?: string,
type?: string,
siteAdmin?: boolean,
starredAt?: Date | null,
userViewType?: string
},
repo?: {
id: number,
name: string,
url?: string
},
org?: {
name?: string | null,
email?: string | null,
login: string,
id: number,
nodeId?: string,
avatarUrl?: string,
gravatarId?: string | null,
url?: string,
htmlUrl?: string,
followersUrl?: string,
followingUrl?: string,
gistsUrl?: string,
starredUrl?: string,
subscriptionsUrl?: string,
organizationsUrl?: string,
reposUrl?: string,
eventsUrl?: string,
receivedEventsUrl?: string,
type?: string,
siteAdmin?: boolean,
starredAt?: Date | null,
userViewType?: string
},
payload?: {
},
public?: boolean,
createdAt?: Date | null
}[]
```
***
### listPublicForUser
`events.listPublicForUser`
List public events for a user
**Risk:** `read`
```ts theme={null}
await corsair.github.api.events.listPublicForUser({});
```
**Input**
| Name | Type | Required | Description |
| ---------- | -------- | -------- | ----------- |
| `username` | `string` | Yes | — |
| `perPage` | `number` | No | — |
| `page` | `number` | No | — |
**Output:** `object[]`
```ts theme={null}
{
id: string,
type: string,
actor?: {
name?: string | null,
email?: string | null,
login: string,
id: number,
nodeId?: string,
avatarUrl?: string,
gravatarId?: string | null,
url?: string,
htmlUrl?: string,
followersUrl?: string,
followingUrl?: string,
gistsUrl?: string,
starredUrl?: string,
subscriptionsUrl?: string,
organizationsUrl?: string,
reposUrl?: string,
eventsUrl?: string,
receivedEventsUrl?: string,
type?: string,
siteAdmin?: boolean,
starredAt?: Date | null,
userViewType?: string
},
repo?: {
id: number,
name: string,
url?: string
},
org?: {
name?: string | null,
email?: string | null,
login: string,
id: number,
nodeId?: string,
avatarUrl?: string,
gravatarId?: string | null,
url?: string,
htmlUrl?: string,
followersUrl?: string,
followingUrl?: string,
gistsUrl?: string,
starredUrl?: string,
subscriptionsUrl?: string,
organizationsUrl?: string,
reposUrl?: string,
eventsUrl?: string,
receivedEventsUrl?: string,
type?: string,
siteAdmin?: boolean,
starredAt?: Date | null,
userViewType?: string
},
payload?: {
},
public?: boolean,
createdAt?: Date | null
}[]
```
***
### listPublicReceivedForUser
`events.listPublicReceivedForUser`
List public events received by a user
**Risk:** `read`
```ts theme={null}
await corsair.github.api.events.listPublicReceivedForUser({});
```
**Input**
| Name | Type | Required | Description |
| ---------- | -------- | -------- | ----------- |
| `username` | `string` | Yes | — |
| `perPage` | `number` | No | — |
| `page` | `number` | No | — |
**Output:** `object[]`
```ts theme={null}
{
id: string,
type: string,
actor?: {
name?: string | null,
email?: string | null,
login: string,
id: number,
nodeId?: string,
avatarUrl?: string,
gravatarId?: string | null,
url?: string,
htmlUrl?: string,
followersUrl?: string,
followingUrl?: string,
gistsUrl?: string,
starredUrl?: string,
subscriptionsUrl?: string,
organizationsUrl?: string,
reposUrl?: string,
eventsUrl?: string,
receivedEventsUrl?: string,
type?: string,
siteAdmin?: boolean,
starredAt?: Date | null,
userViewType?: string
},
repo?: {
id: number,
name: string,
url?: string
},
org?: {
name?: string | null,
email?: string | null,
login: string,
id: number,
nodeId?: string,
avatarUrl?: string,
gravatarId?: string | null,
url?: string,
htmlUrl?: string,
followersUrl?: string,
followingUrl?: string,
gistsUrl?: string,
starredUrl?: string,
subscriptionsUrl?: string,
organizationsUrl?: string,
reposUrl?: string,
eventsUrl?: string,
receivedEventsUrl?: string,
type?: string,
siteAdmin?: boolean,
starredAt?: Date | null,
userViewType?: string
},
payload?: {
},
public?: boolean,
createdAt?: Date | null
}[]
```
***
### listReceivedForUser
`events.listReceivedForUser`
List events received by a user
**Risk:** `read`
```ts theme={null}
await corsair.github.api.events.listReceivedForUser({});
```
**Input**
| Name | Type | Required | Description |
| ---------- | -------- | -------- | ----------- |
| `username` | `string` | Yes | — |
| `perPage` | `number` | No | — |
| `page` | `number` | No | — |
**Output:** `object[]`
```ts theme={null}
{
id: string,
type: string,
actor?: {
name?: string | null,
email?: string | null,
login: string,
id: number,
nodeId?: string,
avatarUrl?: string,
gravatarId?: string | null,
url?: string,
htmlUrl?: string,
followersUrl?: string,
followingUrl?: string,
gistsUrl?: string,
starredUrl?: string,
subscriptionsUrl?: string,
organizationsUrl?: string,
reposUrl?: string,
eventsUrl?: string,
receivedEventsUrl?: string,
type?: string,
siteAdmin?: boolean,
starredAt?: Date | null,
userViewType?: string
},
repo?: {
id: number,
name: string,
url?: string
},
org?: {
name?: string | null,
email?: string | null,
login: string,
id: number,
nodeId?: string,
avatarUrl?: string,
gravatarId?: string | null,
url?: string,
htmlUrl?: string,
followersUrl?: string,
followingUrl?: string,
gistsUrl?: string,
starredUrl?: string,
subscriptionsUrl?: string,
organizationsUrl?: string,
reposUrl?: string,
eventsUrl?: string,
receivedEventsUrl?: string,
type?: string,
siteAdmin?: boolean,
starredAt?: Date | null,
userViewType?: string
},
payload?: {
},
public?: boolean,
createdAt?: Date | null
}[]
```
***
## Forks
### list
`forks.list`
List forks of a repository
**Risk:** `read`
```ts theme={null}
await corsair.github.api.forks.list({});
```
**Input**
| Name | Type | Required | Description |
| --------- | -------------------------------------------- | -------- | ----------- |
| `owner` | `string` | Yes | — |
| `repo` | `string` | Yes | — |
| `sort` | `newest \| oldest \| stargazers \| watchers` | No | — |
| `perPage` | `number` | No | — |
| `page` | `number` | No | — |
**Output:** `object[]`
```ts theme={null}
{
id: number,
nodeId?: string,
name: string,
fullName?: string,
private?: boolean,
htmlUrl?: string,
description?: string | null,
fork?: boolean,
url?: string,
createdAt?: Date | null,
updatedAt?: Date | null,
pushedAt?: Date | null,
defaultBranch?: string,
language?: string | null,
stargazersCount?: number,
watchersCount?: number,
forksCount?: number,
openIssuesCount?: number,
archived?: boolean,
disabled?: boolean,
owner?: {
name?: string | null,
email?: string | null,
login: string,
id: number,
nodeId?: string,
avatarUrl?: string,
gravatarId?: string | null,
url?: string,
htmlUrl?: string,
followersUrl?: string,
followingUrl?: string,
gistsUrl?: string,
starredUrl?: string,
subscriptionsUrl?: string,
organizationsUrl?: string,
reposUrl?: string,
eventsUrl?: string,
receivedEventsUrl?: string,
type?: string,
siteAdmin?: boolean,
starredAt?: Date | null,
userViewType?: string
}
}[]
```
***
## Issues
### create
`issues.create`
Create a new issue
**Risk:** `write`
```ts theme={null}
await corsair.github.api.issues.create({});
```
**Input**
| Name | Type | Required | Description |
| ----------- | ------------------ | -------- | ----------- |
| `owner` | `string` | Yes | — |
| `repo` | `string` | Yes | — |
| `title` | `string \| number` | Yes | — |
| `body` | `string` | No | — |
| `assignee` | `string` | No | — |
| `milestone` | `string \| number` | No | — |
| `labels` | `object[]` | No | — |
| `assignees` | `string[]` | No | — |
```ts theme={null}
(
string | {
id?: number,
name?: string,
description?: string | null,
color?: string | null
}
)[]
```
**Output**
| Name | Type | Required | Description |
| --------------- | --------------------------------------------------- | -------- | ----------- |
| `id` | `number` | Yes | — |
| `nodeId` | `string` | No | — |
| `url` | `string` | No | — |
| `repositoryUrl` | `string` | No | — |
| `labelsUrl` | `string` | No | — |
| `commentsUrl` | `string` | No | — |
| `eventsUrl` | `string` | No | — |
| `htmlUrl` | `string` | No | — |
| `number` | `number` | Yes | — |
| `state` | `string` | Yes | — |
| `stateReason` | `completed \| reopened \| not_planned \| duplicate` | No | — |
| `title` | `string` | Yes | — |
| `body` | `string` | No | — |
| `user` | `object` | No | — |
| `labels` | `object[]` | No | — |
| `assignee` | `object` | No | — |
| `assignees` | `object[]` | No | — |
| `locked` | `boolean` | No | — |
| `comments` | `number` | No | — |
| `createdAt` | `Date` | No | — |
| `updatedAt` | `Date` | No | — |
| `closedAt` | `Date` | No | — |
```ts theme={null}
{
name?: string | null,
email?: string | null,
login: string,
id: number,
nodeId?: string,
avatarUrl?: string,
gravatarId?: string | null,
url?: string,
htmlUrl?: string,
followersUrl?: string,
followingUrl?: string,
gistsUrl?: string,
starredUrl?: string,
subscriptionsUrl?: string,
organizationsUrl?: string,
reposUrl?: string,
eventsUrl?: string,
receivedEventsUrl?: string,
type?: string,
siteAdmin?: boolean,
starredAt?: Date | null,
userViewType?: string
}
```
```ts theme={null}
(
string | {
id?: number,
nodeId?: string,
url?: string,
name?: string,
description?: string | null,
color?: string | null,
default?: boolean
}
)[]
```
```ts theme={null}
{
name?: string | null,
email?: string | null,
login: string,
id: number,
nodeId?: string,
avatarUrl?: string,
gravatarId?: string | null,
url?: string,
htmlUrl?: string,
followersUrl?: string,
followingUrl?: string,
gistsUrl?: string,
starredUrl?: string,
subscriptionsUrl?: string,
organizationsUrl?: string,
reposUrl?: string,
eventsUrl?: string,
receivedEventsUrl?: string,
type?: string,
siteAdmin?: boolean,
starredAt?: Date | null,
userViewType?: string
}
```
```ts theme={null}
{
name?: string | null,
email?: string | null,
login: string,
id: number,
nodeId?: string,
avatarUrl?: string,
gravatarId?: string | null,
url?: string,
htmlUrl?: string,
followersUrl?: string,
followingUrl?: string,
gistsUrl?: string,
starredUrl?: string,
subscriptionsUrl?: string,
organizationsUrl?: string,
reposUrl?: string,
eventsUrl?: string,
receivedEventsUrl?: string,
type?: string,
siteAdmin?: boolean,
starredAt?: Date | null,
userViewType?: string
}[]
```
***
### createComment
`issues.createComment`
Post a comment on an issue
**Risk:** `write`
```ts theme={null}
await corsair.github.api.issues.createComment({});
```
**Input**
| Name | Type | Required | Description |
| ------------- | -------- | -------- | ----------- |
| `owner` | `string` | Yes | — |
| `repo` | `string` | Yes | — |
| `issueNumber` | `number` | Yes | — |
| `body` | `string` | Yes | — |
**Output**
| Name | Type | Required | Description |
| ----------- | -------- | -------- | ----------- |
| `id` | `number` | Yes | — |
| `nodeId` | `string` | No | — |
| `url` | `string` | No | — |
| `body` | `string` | No | — |
| `bodyText` | `string` | No | — |
| `bodyHtml` | `string` | No | — |
| `htmlUrl` | `string` | No | — |
| `user` | `object` | No | — |
| `createdAt` | `Date` | No | — |
| `updatedAt` | `Date` | No | — |
| `issueUrl` | `string` | No | — |
```ts theme={null}
{
login: string,
id: number,
nodeId?: string,
avatarUrl?: string
}
```
***
### get
`issues.get`
Get a specific issue
**Risk:** `read`
```ts theme={null}
await corsair.github.api.issues.get({});
```
**Input**
| Name | Type | Required | Description |
| ------------- | -------- | -------- | ----------- |
| `owner` | `string` | Yes | — |
| `repo` | `string` | Yes | — |
| `issueNumber` | `number` | Yes | — |
**Output**
| Name | Type | Required | Description |
| --------------- | --------------------------------------------------- | -------- | ----------- |
| `id` | `number` | Yes | — |
| `nodeId` | `string` | No | — |
| `url` | `string` | No | — |
| `repositoryUrl` | `string` | No | — |
| `labelsUrl` | `string` | No | — |
| `commentsUrl` | `string` | No | — |
| `eventsUrl` | `string` | No | — |
| `htmlUrl` | `string` | No | — |
| `number` | `number` | Yes | — |
| `state` | `string` | Yes | — |
| `stateReason` | `completed \| reopened \| not_planned \| duplicate` | No | — |
| `title` | `string` | Yes | — |
| `body` | `string` | No | — |
| `user` | `object` | No | — |
| `labels` | `object[]` | No | — |
| `assignee` | `object` | No | — |
| `assignees` | `object[]` | No | — |
| `locked` | `boolean` | No | — |
| `comments` | `number` | No | — |
| `createdAt` | `Date` | No | — |
| `updatedAt` | `Date` | No | — |
| `closedAt` | `Date` | No | — |
```ts theme={null}
{
name?: string | null,
email?: string | null,
login: string,
id: number,
nodeId?: string,
avatarUrl?: string,
gravatarId?: string | null,
url?: string,
htmlUrl?: string,
followersUrl?: string,
followingUrl?: string,
gistsUrl?: string,
starredUrl?: string,
subscriptionsUrl?: string,
organizationsUrl?: string,
reposUrl?: string,
eventsUrl?: string,
receivedEventsUrl?: string,
type?: string,
siteAdmin?: boolean,
starredAt?: Date | null,
userViewType?: string
}
```
```ts theme={null}
(
string | {
id?: number,
nodeId?: string,
url?: string,
name?: string,
description?: string | null,
color?: string | null,
default?: boolean
}
)[]
```
```ts theme={null}
{
name?: string | null,
email?: string | null,
login: string,
id: number,
nodeId?: string,
avatarUrl?: string,
gravatarId?: string | null,
url?: string,
htmlUrl?: string,
followersUrl?: string,
followingUrl?: string,
gistsUrl?: string,
starredUrl?: string,
subscriptionsUrl?: string,
organizationsUrl?: string,
reposUrl?: string,
eventsUrl?: string,
receivedEventsUrl?: string,
type?: string,
siteAdmin?: boolean,
starredAt?: Date | null,
userViewType?: string
}
```
```ts theme={null}
{
name?: string | null,
email?: string | null,
login: string,
id: number,
nodeId?: string,
avatarUrl?: string,
gravatarId?: string | null,
url?: string,
htmlUrl?: string,
followersUrl?: string,
followingUrl?: string,
gistsUrl?: string,
starredUrl?: string,
subscriptionsUrl?: string,
organizationsUrl?: string,
reposUrl?: string,
eventsUrl?: string,
receivedEventsUrl?: string,
type?: string,
siteAdmin?: boolean,
starredAt?: Date | null,
userViewType?: string
}[]
```
***
### list
`issues.list`
List issues in a repository
**Risk:** `read`
```ts theme={null}
await corsair.github.api.issues.list({});
```
**Input**
| Name | Type | Required | Description |
| ----------- | -------------------------------- | -------- | ----------- |
| `owner` | `string` | Yes | — |
| `repo` | `string` | Yes | — |
| `milestone` | `string` | No | — |
| `state` | `open \| closed \| all` | No | — |
| `assignee` | `string` | No | — |
| `creator` | `string` | No | — |
| `mentioned` | `string` | No | — |
| `labels` | `string` | No | — |
| `sort` | `created \| updated \| comments` | No | — |
| `direction` | `asc \| desc` | No | — |
| `since` | `string` | No | — |
| `perPage` | `number` | No | — |
| `page` | `number` | No | — |
**Output:** `object[]`
```ts theme={null}
{
id: number,
nodeId?: string,
url?: string,
repositoryUrl?: string,
labelsUrl?: string,
commentsUrl?: string,
eventsUrl?: string,
htmlUrl?: string,
number: number,
state: string,
stateReason?: completed | reopened | not_planned | duplicate | null,
title: string,
body?: string | null,
user?: {
name?: string | null,
email?: string | null,
login: string,
id: number,
nodeId?: string,
avatarUrl?: string,
gravatarId?: string | null,
url?: string,
htmlUrl?: string,
followersUrl?: string,
followingUrl?: string,
gistsUrl?: string,
starredUrl?: string,
subscriptionsUrl?: string,
organizationsUrl?: string,
reposUrl?: string,
eventsUrl?: string,
receivedEventsUrl?: string,
type?: string,
siteAdmin?: boolean,
starredAt?: Date | null,
userViewType?: string
} | null,
labels?: (
string | {
id?: number,
nodeId?: string,
url?: string,
name?: string,
description?: string | null,
color?: string | null,
default?: boolean
}
)[],
assignee?: {
name?: string | null,
email?: string | null,
login: string,
id: number,
nodeId?: string,
avatarUrl?: string,
gravatarId?: string | null,
url?: string,
htmlUrl?: string,
followersUrl?: string,
followingUrl?: string,
gistsUrl?: string,
starredUrl?: string,
subscriptionsUrl?: string,
organizationsUrl?: string,
reposUrl?: string,
eventsUrl?: string,
receivedEventsUrl?: string,
type?: string,
siteAdmin?: boolean,
starredAt?: Date | null,
userViewType?: string
} | null,
assignees?: {
name?: string | null,
email?: string | null,
login: string,
id: number,
nodeId?: string,
avatarUrl?: string,
gravatarId?: string | null,
url?: string,
htmlUrl?: string,
followersUrl?: string,
followingUrl?: string,
gistsUrl?: string,
starredUrl?: string,
subscriptionsUrl?: string,
organizationsUrl?: string,
reposUrl?: string,
eventsUrl?: string,
receivedEventsUrl?: string,
type?: string,
siteAdmin?: boolean,
starredAt?: Date | null,
userViewType?: string
}[] | null,
locked?: boolean,
comments?: number,
createdAt?: Date | null,
updatedAt?: Date | null,
closedAt?: Date | null
}[]
```
***
### update
`issues.update`
Update an existing issue
**Risk:** `write`
```ts theme={null}
await corsair.github.api.issues.update({});
```
**Input**
| Name | Type | Required | Description |
| ------------- | --------------------------------------------------- | -------- | ----------- |
| `owner` | `string` | Yes | — |
| `repo` | `string` | Yes | — |
| `issueNumber` | `number` | Yes | — |
| `title` | `string \| number` | No | — |
| `body` | `string` | No | — |
| `assignee` | `string` | No | — |
| `state` | `open \| closed` | No | — |
| `stateReason` | `completed \| not_planned \| duplicate \| reopened` | No | — |
| `milestone` | `string \| number` | No | — |
| `labels` | `object[]` | No | — |
| `assignees` | `string[]` | No | — |
```ts theme={null}
(
string | {
id?: number,
name?: string,
description?: string | null,
color?: string | null
}
)[]
```
**Output**
| Name | Type | Required | Description |
| --------------- | --------------------------------------------------- | -------- | ----------- |
| `id` | `number` | Yes | — |
| `nodeId` | `string` | No | — |
| `url` | `string` | No | — |
| `repositoryUrl` | `string` | No | — |
| `labelsUrl` | `string` | No | — |
| `commentsUrl` | `string` | No | — |
| `eventsUrl` | `string` | No | — |
| `htmlUrl` | `string` | No | — |
| `number` | `number` | Yes | — |
| `state` | `string` | Yes | — |
| `stateReason` | `completed \| reopened \| not_planned \| duplicate` | No | — |
| `title` | `string` | Yes | — |
| `body` | `string` | No | — |
| `user` | `object` | No | — |
| `labels` | `object[]` | No | — |
| `assignee` | `object` | No | — |
| `assignees` | `object[]` | No | — |
| `locked` | `boolean` | No | — |
| `comments` | `number` | No | — |
| `createdAt` | `Date` | No | — |
| `updatedAt` | `Date` | No | — |
| `closedAt` | `Date` | No | — |
```ts theme={null}
{
name?: string | null,
email?: string | null,
login: string,
id: number,
nodeId?: string,
avatarUrl?: string,
gravatarId?: string | null,
url?: string,
htmlUrl?: string,
followersUrl?: string,
followingUrl?: string,
gistsUrl?: string,
starredUrl?: string,
subscriptionsUrl?: string,
organizationsUrl?: string,
reposUrl?: string,
eventsUrl?: string,
receivedEventsUrl?: string,
type?: string,
siteAdmin?: boolean,
starredAt?: Date | null,
userViewType?: string
}
```
```ts theme={null}
(
string | {
id?: number,
nodeId?: string,
url?: string,
name?: string,
description?: string | null,
color?: string | null,
default?: boolean
}
)[]
```
```ts theme={null}
{
name?: string | null,
email?: string | null,
login: string,
id: number,
nodeId?: string,
avatarUrl?: string,
gravatarId?: string | null,
url?: string,
htmlUrl?: string,
followersUrl?: string,
followingUrl?: string,
gistsUrl?: string,
starredUrl?: string,
subscriptionsUrl?: string,
organizationsUrl?: string,
reposUrl?: string,
eventsUrl?: string,
receivedEventsUrl?: string,
type?: string,
siteAdmin?: boolean,
starredAt?: Date | null,
userViewType?: string
}
```
```ts theme={null}
{
name?: string | null,
email?: string | null,
login: string,
id: number,
nodeId?: string,
avatarUrl?: string,
gravatarId?: string | null,
url?: string,
htmlUrl?: string,
followersUrl?: string,
followingUrl?: string,
gistsUrl?: string,
starredUrl?: string,
subscriptionsUrl?: string,
organizationsUrl?: string,
reposUrl?: string,
eventsUrl?: string,
receivedEventsUrl?: string,
type?: string,
siteAdmin?: boolean,
starredAt?: Date | null,
userViewType?: string
}[]
```
***
## Pull Requests
### createReview
`pullRequests.createReview`
Submit a pull request review
**Risk:** `write`
```ts theme={null}
await corsair.github.api.pullRequests.createReview({});
```
**Input**
| Name | Type | Required | Description |
| ------------ | --------------------------------------- | -------- | ----------- |
| `owner` | `string` | Yes | — |
| `repo` | `string` | Yes | — |
| `pullNumber` | `number` | Yes | — |
| `commitId` | `string` | No | — |
| `body` | `string` | No | — |
| `event` | `APPROVE \| REQUEST_CHANGES \| COMMENT` | No | — |
| `comments` | `object[]` | No | — |
```ts theme={null}
{
path: string,
position?: number,
body: string,
line?: number,
side?: string,
startLine?: number,
startSide?: string
}[]
```
**Output**
| Name | Type | Required | Description |
| ---------------- | -------- | -------- | ----------- |
| `id` | `number` | Yes | — |
| `nodeId` | `string` | No | — |
| `user` | `object` | No | — |
| `body` | `string` | No | — |
| `state` | `string` | No | — |
| `htmlUrl` | `string` | No | — |
| `pullRequestUrl` | `string` | No | — |
| `submittedAt` | `Date` | No | — |
| `commitId` | `string` | No | — |
```ts theme={null}
{
login: string,
id: number
}
```
***
### get
`pullRequests.get`
Get a specific pull request
**Risk:** `read`
```ts theme={null}
await corsair.github.api.pullRequests.get({});
```
**Input**
| Name | Type | Required | Description |
| ------------ | -------- | -------- | ----------- |
| `owner` | `string` | Yes | — |
| `repo` | `string` | Yes | — |
| `pullNumber` | `number` | Yes | — |
**Output**
| Name | Type | Required | Description |
| ------------------- | ---------------- | -------- | ----------- |
| `url` | `string` | Yes | — |
| `id` | `number` | Yes | — |
| `nodeId` | `string` | No | — |
| `htmlUrl` | `string` | No | — |
| `diffUrl` | `string` | No | — |
| `patchUrl` | `string` | No | — |
| `issueUrl` | `string` | No | — |
| `number` | `number` | Yes | — |
| `state` | `open \| closed` | Yes | — |
| `locked` | `boolean` | No | — |
| `title` | `string` | Yes | — |
| `user` | `object` | No | — |
| `body` | `string` | No | — |
| `createdAt` | `Date` | No | — |
| `updatedAt` | `Date` | No | — |
| `closedAt` | `Date` | No | — |
| `mergedAt` | `Date` | No | — |
| `mergeCommitSha` | `string` | No | — |
| `assignee` | `object` | No | — |
| `assignees` | `object[]` | No | — |
| `labels` | `object[]` | No | — |
| `milestone` | `object` | No | — |
| `commitsUrl` | `string` | No | — |
| `reviewCommentsUrl` | `string` | No | — |
| `reviewCommentUrl` | `string` | No | — |
| `commentsUrl` | `string` | No | — |
| `statusesUrl` | `string` | No | — |
| `head` | `object` | No | — |
| `base` | `object` | No | — |
| `authorAssociation` | `string` | No | — |
| `draft` | `boolean` | No | — |
| `merged` | `boolean` | No | — |
| `mergeable` | `boolean` | No | — |
| `comments` | `number` | No | — |
| `reviewComments` | `number` | No | — |
| `commits` | `number` | No | — |
| `additions` | `number` | No | — |
| `deletions` | `number` | No | — |
| `changedFiles` | `number` | No | — |
```ts theme={null}
{
name?: string | null,
email?: string | null,
login: string,
id: number,
nodeId?: string,
avatarUrl?: string,
gravatarId?: string | null,
url?: string,
htmlUrl?: string,
followersUrl?: string,
followingUrl?: string,
gistsUrl?: string,
starredUrl?: string,
subscriptionsUrl?: string,
organizationsUrl?: string,
reposUrl?: string,
eventsUrl?: string,
receivedEventsUrl?: string,
type?: string,
siteAdmin?: boolean,
starredAt?: Date | null,
userViewType?: string
}
```
```ts theme={null}
{
name?: string | null,
email?: string | null,
login: string,
id: number,
nodeId?: string,
avatarUrl?: string,
gravatarId?: string | null,
url?: string,
htmlUrl?: string,
followersUrl?: string,
followingUrl?: string,
gistsUrl?: string,
starredUrl?: string,
subscriptionsUrl?: string,
organizationsUrl?: string,
reposUrl?: string,
eventsUrl?: string,
receivedEventsUrl?: string,
type?: string,
siteAdmin?: boolean,
starredAt?: Date | null,
userViewType?: string
}
```
```ts theme={null}
{
name?: string | null,
email?: string | null,
login: string,
id: number,
nodeId?: string,
avatarUrl?: string,
gravatarId?: string | null,
url?: string,
htmlUrl?: string,
followersUrl?: string,
followingUrl?: string,
gistsUrl?: string,
starredUrl?: string,
subscriptionsUrl?: string,
organizationsUrl?: string,
reposUrl?: string,
eventsUrl?: string,
receivedEventsUrl?: string,
type?: string,
siteAdmin?: boolean,
starredAt?: Date | null,
userViewType?: string
}[]
```
```ts theme={null}
{
id?: number,
nodeId?: string,
url?: string,
name?: string,
description?: string | null,
color?: string | null,
default?: boolean
}[]
```
```ts theme={null}
{
url?: string,
htmlUrl?: string,
labelsUrl?: string,
id?: number,
nodeId?: string,
number?: number,
state?: open | closed,
title?: string,
description?: string | null,
creator?: {
name?: string | null,
email?: string | null,
login: string,
id: number,
nodeId?: string,
avatarUrl?: string,
gravatarId?: string | null,
url?: string,
htmlUrl?: string,
followersUrl?: string,
followingUrl?: string,
gistsUrl?: string,
starredUrl?: string,
subscriptionsUrl?: string,
organizationsUrl?: string,
reposUrl?: string,
eventsUrl?: string,
receivedEventsUrl?: string,
type?: string,
siteAdmin?: boolean,
starredAt?: Date | null,
userViewType?: string
},
openIssues?: number,
closedIssues?: number,
createdAt?: Date | null,
updatedAt?: Date | null,
closedAt?: Date | null,
dueOn?: Date | null
}
```
```ts theme={null}
{
label?: string,
ref?: string,
sha?: string,
user?: {
name?: string | null,
email?: string | null,
login: string,
id: number,
nodeId?: string,
avatarUrl?: string,
gravatarId?: string | null,
url?: string,
htmlUrl?: string,
followersUrl?: string,
followingUrl?: string,
gistsUrl?: string,
starredUrl?: string,
subscriptionsUrl?: string,
organizationsUrl?: string,
reposUrl?: string,
eventsUrl?: string,
receivedEventsUrl?: string,
type?: string,
siteAdmin?: boolean,
starredAt?: Date | null,
userViewType?: string
},
repo?: {
id: number,
nodeId?: string,
name: string,
fullName?: string,
private?: boolean,
htmlUrl?: string,
description?: string | null,
fork?: boolean,
url?: string,
createdAt?: Date | null,
updatedAt?: Date | null,
pushedAt?: Date | null,
defaultBranch?: string,
language?: string | null,
stargazersCount?: number,
watchersCount?: number,
forksCount?: number,
openIssuesCount?: number,
archived?: boolean,
disabled?: boolean,
owner?: {
name?: string | null,
email?: string | null,
login: string,
id: number,
nodeId?: string,
avatarUrl?: string,
gravatarId?: string | null,
url?: string,
htmlUrl?: string,
followersUrl?: string,
followingUrl?: string,
gistsUrl?: string,
starredUrl?: string,
subscriptionsUrl?: string,
organizationsUrl?: string,
reposUrl?: string,
eventsUrl?: string,
receivedEventsUrl?: string,
type?: string,
siteAdmin?: boolean,
starredAt?: Date | null,
userViewType?: string
}
} | null
}
```
```ts theme={null}
{
label?: string,
ref?: string,
sha?: string,
user?: {
name?: string | null,
email?: string | null,
login: string,
id: number,
nodeId?: string,
avatarUrl?: string,
gravatarId?: string | null,
url?: string,
htmlUrl?: string,
followersUrl?: string,
followingUrl?: string,
gistsUrl?: string,
starredUrl?: string,
subscriptionsUrl?: string,
organizationsUrl?: string,
reposUrl?: string,
eventsUrl?: string,
receivedEventsUrl?: string,
type?: string,
siteAdmin?: boolean,
starredAt?: Date | null,
userViewType?: string
},
repo?: {
id: number,
nodeId?: string,
name: string,
fullName?: string,
private?: boolean,
htmlUrl?: string,
description?: string | null,
fork?: boolean,
url?: string,
createdAt?: Date | null,
updatedAt?: Date | null,
pushedAt?: Date | null,
defaultBranch?: string,
language?: string | null,
stargazersCount?: number,
watchersCount?: number,
forksCount?: number,
openIssuesCount?: number,
archived?: boolean,
disabled?: boolean,
owner?: {
name?: string | null,
email?: string | null,
login: string,
id: number,
nodeId?: string,
avatarUrl?: string,
gravatarId?: string | null,
url?: string,
htmlUrl?: string,
followersUrl?: string,
followingUrl?: string,
gistsUrl?: string,
starredUrl?: string,
subscriptionsUrl?: string,
organizationsUrl?: string,
reposUrl?: string,
eventsUrl?: string,
receivedEventsUrl?: string,
type?: string,
siteAdmin?: boolean,
starredAt?: Date | null,
userViewType?: string
}
}
}
```
***
### list
`pullRequests.list`
List pull requests
**Risk:** `read`
```ts theme={null}
await corsair.github.api.pullRequests.list({});
```
**Input**
| Name | Type | Required | Description |
| ----------- | -------------------------------------------------- | -------- | ----------- |
| `owner` | `string` | Yes | — |
| `repo` | `string` | Yes | — |
| `state` | `open \| closed \| all` | No | — |
| `head` | `string` | No | — |
| `base` | `string` | No | — |
| `sort` | `created \| updated \| popularity \| long-running` | No | — |
| `direction` | `asc \| desc` | No | — |
| `perPage` | `number` | No | — |
| `page` | `number` | No | — |
**Output:** `object[]`
```ts theme={null}
{
url: string,
id: number,
nodeId?: string,
htmlUrl?: string,
diffUrl?: string,
patchUrl?: string,
issueUrl?: string,
number: number,
state: open | closed,
locked?: boolean,
title: string,
user?: {
name?: string | null,
email?: string | null,
login: string,
id: number,
nodeId?: string,
avatarUrl?: string,
gravatarId?: string | null,
url?: string,
htmlUrl?: string,
followersUrl?: string,
followingUrl?: string,
gistsUrl?: string,
starredUrl?: string,
subscriptionsUrl?: string,
organizationsUrl?: string,
reposUrl?: string,
eventsUrl?: string,
receivedEventsUrl?: string,
type?: string,
siteAdmin?: boolean,
starredAt?: Date | null,
userViewType?: string
},
body?: string | null,
createdAt?: Date | null,
updatedAt?: Date | null,
closedAt?: Date | null,
mergedAt?: Date | null,
mergeCommitSha?: string | null,
assignee?: {
name?: string | null,
email?: string | null,
login: string,
id: number,
nodeId?: string,
avatarUrl?: string,
gravatarId?: string | null,
url?: string,
htmlUrl?: string,
followersUrl?: string,
followingUrl?: string,
gistsUrl?: string,
starredUrl?: string,
subscriptionsUrl?: string,
organizationsUrl?: string,
reposUrl?: string,
eventsUrl?: string,
receivedEventsUrl?: string,
type?: string,
siteAdmin?: boolean,
starredAt?: Date | null,
userViewType?: string
} | null,
assignees?: {
name?: string | null,
email?: string | null,
login: string,
id: number,
nodeId?: string,
avatarUrl?: string,
gravatarId?: string | null,
url?: string,
htmlUrl?: string,
followersUrl?: string,
followingUrl?: string,
gistsUrl?: string,
starredUrl?: string,
subscriptionsUrl?: string,
organizationsUrl?: string,
reposUrl?: string,
eventsUrl?: string,
receivedEventsUrl?: string,
type?: string,
siteAdmin?: boolean,
starredAt?: Date | null,
userViewType?: string
}[] | null,
labels?: {
id?: number,
nodeId?: string,
url?: string,
name?: string,
description?: string | null,
color?: string | null,
default?: boolean
}[],
milestone?: {
url?: string,
htmlUrl?: string,
labelsUrl?: string,
id?: number,
nodeId?: string,
number?: number,
state?: open | closed,
title?: string,
description?: string | null,
creator?: {
name?: string | null,
email?: string | null,
login: string,
id: number,
nodeId?: string,
avatarUrl?: string,
gravatarId?: string | null,
url?: string,
htmlUrl?: string,
followersUrl?: string,
followingUrl?: string,
gistsUrl?: string,
starredUrl?: string,
subscriptionsUrl?: string,
organizationsUrl?: string,
reposUrl?: string,
eventsUrl?: string,
receivedEventsUrl?: string,
type?: string,
siteAdmin?: boolean,
starredAt?: Date | null,
userViewType?: string
},
openIssues?: number,
closedIssues?: number,
createdAt?: Date | null,
updatedAt?: Date | null,
closedAt?: Date | null,
dueOn?: Date | null
} | null,
commitsUrl?: string,
reviewCommentsUrl?: string,
reviewCommentUrl?: string,
commentsUrl?: string,
statusesUrl?: string,
head?: {
label?: string,
ref?: string,
sha?: string,
user?: {
name?: string | null,
email?: string | null,
login: string,
id: number,
nodeId?: string,
avatarUrl?: string,
gravatarId?: string | null,
url?: string,
htmlUrl?: string,
followersUrl?: string,
followingUrl?: string,
gistsUrl?: string,
starredUrl?: string,
subscriptionsUrl?: string,
organizationsUrl?: string,
reposUrl?: string,
eventsUrl?: string,
receivedEventsUrl?: string,
type?: string,
siteAdmin?: boolean,
starredAt?: Date | null,
userViewType?: string
},
repo?: {
id: number,
nodeId?: string,
name: string,
fullName?: string,
private?: boolean,
htmlUrl?: string,
description?: string | null,
fork?: boolean,
url?: string,
createdAt?: Date | null,
updatedAt?: Date | null,
pushedAt?: Date | null,
defaultBranch?: string,
language?: string | null,
stargazersCount?: number,
watchersCount?: number,
forksCount?: number,
openIssuesCount?: number,
archived?: boolean,
disabled?: boolean,
owner?: {
name?: string | null,
email?: string | null,
login: string,
id: number,
nodeId?: string,
avatarUrl?: string,
gravatarId?: string | null,
url?: string,
htmlUrl?: string,
followersUrl?: string,
followingUrl?: string,
gistsUrl?: string,
starredUrl?: string,
subscriptionsUrl?: string,
organizationsUrl?: string,
reposUrl?: string,
eventsUrl?: string,
receivedEventsUrl?: string,
type?: string,
siteAdmin?: boolean,
starredAt?: Date | null,
userViewType?: string
}
} | null
},
base?: {
label?: string,
ref?: string,
sha?: string,
user?: {
name?: string | null,
email?: string | null,
login: string,
id: number,
nodeId?: string,
avatarUrl?: string,
gravatarId?: string | null,
url?: string,
htmlUrl?: string,
followersUrl?: string,
followingUrl?: string,
gistsUrl?: string,
starredUrl?: string,
subscriptionsUrl?: string,
organizationsUrl?: string,
reposUrl?: string,
eventsUrl?: string,
receivedEventsUrl?: string,
type?: string,
siteAdmin?: boolean,
starredAt?: Date | null,
userViewType?: string
},
repo?: {
id: number,
nodeId?: string,
name: string,
fullName?: string,
private?: boolean,
htmlUrl?: string,
description?: string | null,
fork?: boolean,
url?: string,
createdAt?: Date | null,
updatedAt?: Date | null,
pushedAt?: Date | null,
defaultBranch?: string,
language?: string | null,
stargazersCount?: number,
watchersCount?: number,
forksCount?: number,
openIssuesCount?: number,
archived?: boolean,
disabled?: boolean,
owner?: {
name?: string | null,
email?: string | null,
login: string,
id: number,
nodeId?: string,
avatarUrl?: string,
gravatarId?: string | null,
url?: string,
htmlUrl?: string,
followersUrl?: string,
followingUrl?: string,
gistsUrl?: string,
starredUrl?: string,
subscriptionsUrl?: string,
organizationsUrl?: string,
reposUrl?: string,
eventsUrl?: string,
receivedEventsUrl?: string,
type?: string,
siteAdmin?: boolean,
starredAt?: Date | null,
userViewType?: string
}
}
},
authorAssociation?: string,
draft?: boolean,
merged?: boolean,
mergeable?: boolean | null,
comments?: number,
reviewComments?: number,
commits?: number,
additions?: number,
deletions?: number,
changedFiles?: number
}[]
```
***
### listReviews
`pullRequests.listReviews`
List reviews on a pull request
**Risk:** `read`
```ts theme={null}
await corsair.github.api.pullRequests.listReviews({});
```
**Input**
| Name | Type | Required | Description |
| ------------ | -------- | -------- | ----------- |
| `owner` | `string` | Yes | — |
| `repo` | `string` | Yes | — |
| `pullNumber` | `number` | Yes | — |
| `perPage` | `number` | No | — |
| `page` | `number` | No | — |
**Output:** `object[]`
```ts theme={null}
{
id: number,
nodeId?: string,
user?: {
login: string,
id: number
},
body?: string,
state?: string,
htmlUrl?: string,
pullRequestUrl?: string,
submittedAt?: Date | null,
commitId?: string | null
}[]
```
***
## Releases
### create
`releases.create`
Create a new release
**Risk:** `write`
```ts theme={null}
await corsair.github.api.releases.create({});
```
**Input**
| Name | Type | Required | Description |
| ---------------------- | --------- | -------- | ----------- |
| `owner` | `string` | Yes | — |
| `repo` | `string` | Yes | — |
| `tagName` | `string` | Yes | — |
| `targetCommitish` | `string` | No | — |
| `name` | `string` | No | — |
| `body` | `string` | No | — |
| `draft` | `boolean` | No | — |
| `prerelease` | `boolean` | No | — |
| `generateReleaseNotes` | `boolean` | No | — |
**Output**
| Name | Type | Required | Description |
| ----------------- | ---------- | -------- | ----------- |
| `url` | `string` | No | — |
| `htmlUrl` | `string` | No | — |
| `assetsUrl` | `string` | No | — |
| `uploadUrl` | `string` | No | — |
| `tarballUrl` | `string` | No | — |
| `zipballUrl` | `string` | No | — |
| `id` | `number` | Yes | — |
| `nodeId` | `string` | No | — |
| `tagName` | `string` | No | — |
| `targetCommitish` | `string` | No | — |
| `name` | `string` | No | — |
| `body` | `string` | No | — |
| `draft` | `boolean` | No | — |
| `prerelease` | `boolean` | No | — |
| `createdAt` | `Date` | No | — |
| `publishedAt` | `Date` | No | — |
| `author` | `object` | No | — |
| `assets` | `object[]` | No | — |
```ts theme={null}
{
name?: string | null,
email?: string | null,
login: string,
id: number,
nodeId?: string,
avatarUrl?: string,
gravatarId?: string | null,
url?: string,
htmlUrl?: string,
followersUrl?: string,
followingUrl?: string,
gistsUrl?: string,
starredUrl?: string,
subscriptionsUrl?: string,
organizationsUrl?: string,
reposUrl?: string,
eventsUrl?: string,
receivedEventsUrl?: string,
type?: string,
siteAdmin?: boolean,
starredAt?: Date | null,
userViewType?: string
}
```
```ts theme={null}
{
url: string,
browserDownloadUrl: string,
id: number,
nodeId: string,
name: string,
label?: string | null,
state: uploaded | open,
contentType: string,
size: number,
downloadCount: number,
createdAt?: Date | null,
updatedAt?: Date | null
}[]
```
***
### get
`releases.get`
Get a specific release
**Risk:** `read`
```ts theme={null}
await corsair.github.api.releases.get({});
```
**Input**
| Name | Type | Required | Description |
| ----------- | -------- | -------- | ----------- |
| `owner` | `string` | Yes | — |
| `repo` | `string` | Yes | — |
| `releaseId` | `number` | Yes | — |
**Output**
| Name | Type | Required | Description |
| ----------------- | ---------- | -------- | ----------- |
| `url` | `string` | No | — |
| `htmlUrl` | `string` | No | — |
| `assetsUrl` | `string` | No | — |
| `uploadUrl` | `string` | No | — |
| `tarballUrl` | `string` | No | — |
| `zipballUrl` | `string` | No | — |
| `id` | `number` | Yes | — |
| `nodeId` | `string` | No | — |
| `tagName` | `string` | No | — |
| `targetCommitish` | `string` | No | — |
| `name` | `string` | No | — |
| `body` | `string` | No | — |
| `draft` | `boolean` | No | — |
| `prerelease` | `boolean` | No | — |
| `createdAt` | `Date` | No | — |
| `publishedAt` | `Date` | No | — |
| `author` | `object` | No | — |
| `assets` | `object[]` | No | — |
```ts theme={null}
{
name?: string | null,
email?: string | null,
login: string,
id: number,
nodeId?: string,
avatarUrl?: string,
gravatarId?: string | null,
url?: string,
htmlUrl?: string,
followersUrl?: string,
followingUrl?: string,
gistsUrl?: string,
starredUrl?: string,
subscriptionsUrl?: string,
organizationsUrl?: string,
reposUrl?: string,
eventsUrl?: string,
receivedEventsUrl?: string,
type?: string,
siteAdmin?: boolean,
starredAt?: Date | null,
userViewType?: string
}
```
```ts theme={null}
{
url: string,
browserDownloadUrl: string,
id: number,
nodeId: string,
name: string,
label?: string | null,
state: uploaded | open,
contentType: string,
size: number,
downloadCount: number,
createdAt?: Date | null,
updatedAt?: Date | null
}[]
```
***
### list
`releases.list`
List releases in a repository
**Risk:** `read`
```ts theme={null}
await corsair.github.api.releases.list({});
```
**Input**
| Name | Type | Required | Description |
| --------- | -------- | -------- | ----------- |
| `owner` | `string` | Yes | — |
| `repo` | `string` | Yes | — |
| `perPage` | `number` | No | — |
| `page` | `number` | No | — |
**Output:** `object[]`
```ts theme={null}
{
url?: string,
htmlUrl?: string,
assetsUrl?: string,
uploadUrl?: string,
tarballUrl?: string | null,
zipballUrl?: string | null,
id: number,
nodeId?: string,
tagName?: string,
targetCommitish?: string,
name?: string | null,
body?: string | null,
draft?: boolean,
prerelease?: boolean,
createdAt?: Date | null,
publishedAt?: Date | null,
author?: {
name?: string | null,
email?: string | null,
login: string,
id: number,
nodeId?: string,
avatarUrl?: string,
gravatarId?: string | null,
url?: string,
htmlUrl?: string,
followersUrl?: string,
followingUrl?: string,
gistsUrl?: string,
starredUrl?: string,
subscriptionsUrl?: string,
organizationsUrl?: string,
reposUrl?: string,
eventsUrl?: string,
receivedEventsUrl?: string,
type?: string,
siteAdmin?: boolean,
starredAt?: Date | null,
userViewType?: string
},
assets?: {
url: string,
browserDownloadUrl: string,
id: number,
nodeId: string,
name: string,
label?: string | null,
state: uploaded | open,
contentType: string,
size: number,
downloadCount: number,
createdAt?: Date | null,
updatedAt?: Date | null
}[]
}[]
```
***
### update
`releases.update`
Update an existing release
**Risk:** `write`
```ts theme={null}
await corsair.github.api.releases.update({});
```
**Input**
| Name | Type | Required | Description |
| ----------------- | --------- | -------- | ----------- |
| `owner` | `string` | Yes | — |
| `repo` | `string` | Yes | — |
| `releaseId` | `number` | Yes | — |
| `tagName` | `string` | No | — |
| `targetCommitish` | `string` | No | — |
| `name` | `string` | No | — |
| `body` | `string` | No | — |
| `draft` | `boolean` | No | — |
| `prerelease` | `boolean` | No | — |
**Output**
| Name | Type | Required | Description |
| ----------------- | ---------- | -------- | ----------- |
| `url` | `string` | No | — |
| `htmlUrl` | `string` | No | — |
| `assetsUrl` | `string` | No | — |
| `uploadUrl` | `string` | No | — |
| `tarballUrl` | `string` | No | — |
| `zipballUrl` | `string` | No | — |
| `id` | `number` | Yes | — |
| `nodeId` | `string` | No | — |
| `tagName` | `string` | No | — |
| `targetCommitish` | `string` | No | — |
| `name` | `string` | No | — |
| `body` | `string` | No | — |
| `draft` | `boolean` | No | — |
| `prerelease` | `boolean` | No | — |
| `createdAt` | `Date` | No | — |
| `publishedAt` | `Date` | No | — |
| `author` | `object` | No | — |
| `assets` | `object[]` | No | — |
```ts theme={null}
{
name?: string | null,
email?: string | null,
login: string,
id: number,
nodeId?: string,
avatarUrl?: string,
gravatarId?: string | null,
url?: string,
htmlUrl?: string,
followersUrl?: string,
followingUrl?: string,
gistsUrl?: string,
starredUrl?: string,
subscriptionsUrl?: string,
organizationsUrl?: string,
reposUrl?: string,
eventsUrl?: string,
receivedEventsUrl?: string,
type?: string,
siteAdmin?: boolean,
starredAt?: Date | null,
userViewType?: string
}
```
```ts theme={null}
{
url: string,
browserDownloadUrl: string,
id: number,
nodeId: string,
name: string,
label?: string | null,
state: uploaded | open,
contentType: string,
size: number,
downloadCount: number,
createdAt?: Date | null,
updatedAt?: Date | null
}[]
```
***
## Repositories
### checkStarred
`repositories.checkStarred`
Check whether the authenticated user has starred a repository
**Risk:** `read`
```ts theme={null}
await corsair.github.api.repositories.checkStarred({});
```
**Input**
| Name | Type | Required | Description |
| ------- | -------- | -------- | ----------- |
| `owner` | `string` | Yes | — |
| `repo` | `string` | Yes | — |
**Output**
| Name | Type | Required | Description |
| --------- | --------- | -------- | ----------- |
| `starred` | `boolean` | Yes | — |
***
### get
`repositories.get`
Get a specific repository
**Risk:** `read`
```ts theme={null}
await corsair.github.api.repositories.get({});
```
**Input**
| Name | Type | Required | Description |
| ------- | -------- | -------- | ----------- |
| `owner` | `string` | Yes | — |
| `repo` | `string` | Yes | — |
**Output**
| Name | Type | Required | Description |
| ----------------- | --------- | -------- | ----------- |
| `id` | `number` | Yes | — |
| `nodeId` | `string` | No | — |
| `name` | `string` | Yes | — |
| `fullName` | `string` | No | — |
| `private` | `boolean` | No | — |
| `htmlUrl` | `string` | No | — |
| `description` | `string` | No | — |
| `fork` | `boolean` | No | — |
| `url` | `string` | No | — |
| `createdAt` | `Date` | No | — |
| `updatedAt` | `Date` | No | — |
| `pushedAt` | `Date` | No | — |
| `defaultBranch` | `string` | No | — |
| `language` | `string` | No | — |
| `stargazersCount` | `number` | No | — |
| `watchersCount` | `number` | No | — |
| `forksCount` | `number` | No | — |
| `openIssuesCount` | `number` | No | — |
| `archived` | `boolean` | No | — |
| `disabled` | `boolean` | No | — |
| `owner` | `object` | No | — |
```ts theme={null}
{
name?: string | null,
email?: string | null,
login: string,
id: number,
nodeId?: string,
avatarUrl?: string,
gravatarId?: string | null,
url?: string,
htmlUrl?: string,
followersUrl?: string,
followingUrl?: string,
gistsUrl?: string,
starredUrl?: string,
subscriptionsUrl?: string,
organizationsUrl?: string,
reposUrl?: string,
eventsUrl?: string,
receivedEventsUrl?: string,
type?: string,
siteAdmin?: boolean,
starredAt?: Date | null,
userViewType?: string
}
```
***
### getContent
`repositories.getContent`
Get file or directory content from a repository
**Risk:** `read`
```ts theme={null}
await corsair.github.api.repositories.getContent({});
```
**Input**
| Name | Type | Required | Description |
| ------- | -------- | -------- | ----------- |
| `owner` | `string` | Yes | — |
| `repo` | `string` | Yes | — |
| `path` | `string` | Yes | — |
| `ref` | `string` | No | — |
**Output:** `object[]`
```ts theme={null}
{
type: file,
encoding?: string,
size?: number,
name: string,
path?: string,
content?: string,
sha: string,
url?: string,
gitUrl?: string | null,
htmlUrl?: string | null,
downloadUrl?: string | null
} | {
type: dir,
name: string,
path?: string,
sha: string,
size?: number,
url?: string,
gitUrl?: string | null,
htmlUrl?: string | null,
downloadUrl?: string | null
} | {
type: file | dir | submodule | symlink,
size?: number,
name: string,
path?: string,
sha: string,
url?: string,
gitUrl?: string | null,
htmlUrl?: string | null,
downloadUrl?: string | null
}[]
```
***
### list
`repositories.list`
List repositories for the authenticated user
**Risk:** `read`
```ts theme={null}
await corsair.github.api.repositories.list({});
```
**Input**
| Name | Type | Required | Description |
| ----------- | --------------------------------------------- | -------- | ----------- |
| `owner` | `string` | No | — |
| `type` | `all \| owner \| public \| private \| member` | No | — |
| `sort` | `created \| updated \| pushed \| full_name` | No | — |
| `direction` | `asc \| desc` | No | — |
| `perPage` | `number` | No | — |
| `page` | `number` | No | — |
**Output:** `object[]`
```ts theme={null}
{
id: number,
nodeId?: string,
name: string,
fullName?: string,
private?: boolean,
htmlUrl?: string,
description?: string | null,
fork?: boolean,
url?: string,
createdAt?: Date | null,
updatedAt?: Date | null,
pushedAt?: Date | null,
defaultBranch?: string,
language?: string | null,
stargazersCount?: number,
watchersCount?: number,
forksCount?: number,
openIssuesCount?: number,
archived?: boolean,
disabled?: boolean,
owner?: {
name?: string | null,
email?: string | null,
login: string,
id: number,
nodeId?: string,
avatarUrl?: string,
gravatarId?: string | null,
url?: string,
htmlUrl?: string,
followersUrl?: string,
followingUrl?: string,
gistsUrl?: string,
starredUrl?: string,
subscriptionsUrl?: string,
organizationsUrl?: string,
reposUrl?: string,
eventsUrl?: string,
receivedEventsUrl?: string,
type?: string,
siteAdmin?: boolean,
starredAt?: Date | null,
userViewType?: string
}
}[]
```
***
### listBranches
`repositories.listBranches`
List branches in a repository
**Risk:** `read`
```ts theme={null}
await corsair.github.api.repositories.listBranches({});
```
**Input**
| Name | Type | Required | Description |
| ----------- | --------- | -------- | ----------- |
| `owner` | `string` | Yes | — |
| `repo` | `string` | Yes | — |
| `protected` | `boolean` | No | — |
| `perPage` | `number` | No | — |
| `page` | `number` | No | — |
**Output:** `object[]`
```ts theme={null}
{
name: string,
commit: {
sha: string,
url: string
},
protected: boolean
}[]
```
***
### listCommits
`repositories.listCommits`
List commits in a repository
**Risk:** `read`
```ts theme={null}
await corsair.github.api.repositories.listCommits({});
```
**Input**
| Name | Type | Required | Description |
| ----------- | -------- | -------- | ----------- |
| `owner` | `string` | Yes | — |
| `repo` | `string` | Yes | — |
| `sha` | `string` | No | — |
| `path` | `string` | No | — |
| `author` | `string` | No | — |
| `committer` | `string` | No | — |
| `since` | `string` | No | — |
| `until` | `string` | No | — |
| `perPage` | `number` | No | — |
| `page` | `number` | No | — |
**Output:** `object[]`
```ts theme={null}
{
url?: string,
sha: string,
nodeId?: string,
htmlUrl?: string,
commentsUrl?: string,
commit: {
url?: string,
author?: {
name: string,
email: string,
date?: Date | null
} | null,
committer?: {
name: string,
email: string,
date?: Date | null
} | null,
message: string,
commentCount?: number,
tree?: {
sha: string,
url?: string
}
},
author?: {
login: string,
id: number
} | null,
committer?: {
login: string,
id: number
} | null,
parents?: {
sha: string,
url?: string,
htmlUrl?: string
}[]
}[]
```
***
### listStarred
`repositories.listStarred`
List repositories starred by the authenticated user
**Risk:** `read`
```ts theme={null}
await corsair.github.api.repositories.listStarred({});
```
**Input**
| Name | Type | Required | Description |
| ----------- | -------------------- | -------- | ----------- |
| `sort` | `created \| updated` | No | — |
| `direction` | `asc \| desc` | No | — |
| `perPage` | `number` | No | — |
| `page` | `number` | No | — |
**Output:** `object[]`
```ts theme={null}
{
id: number,
nodeId?: string,
name: string,
fullName?: string,
private?: boolean,
htmlUrl?: string,
description?: string | null,
fork?: boolean,
url?: string,
createdAt?: Date | null,
updatedAt?: Date | null,
pushedAt?: Date | null,
defaultBranch?: string,
language?: string | null,
stargazersCount?: number,
watchersCount?: number,
forksCount?: number,
openIssuesCount?: number,
archived?: boolean,
disabled?: boolean,
owner?: {
name?: string | null,
email?: string | null,
login: string,
id: number,
nodeId?: string,
avatarUrl?: string,
gravatarId?: string | null,
url?: string,
htmlUrl?: string,
followersUrl?: string,
followingUrl?: string,
gistsUrl?: string,
starredUrl?: string,
subscriptionsUrl?: string,
organizationsUrl?: string,
reposUrl?: string,
eventsUrl?: string,
receivedEventsUrl?: string,
type?: string,
siteAdmin?: boolean,
starredAt?: Date | null,
userViewType?: string
}
}[]
```
***
### star
`repositories.star`
Star a repository for the authenticated user
**Risk:** `write`
```ts theme={null}
await corsair.github.api.repositories.star({});
```
**Input**
| Name | Type | Required | Description |
| ------- | -------- | -------- | ----------- |
| `owner` | `string` | Yes | — |
| `repo` | `string` | Yes | — |
**Output:** `boolean`
***
### unstar
`repositories.unstar`
Unstar a repository for the authenticated user
**Risk:** `write`
```ts theme={null}
await corsair.github.api.repositories.unstar({});
```
**Input**
| Name | Type | Required | Description |
| ------- | -------- | -------- | ----------- |
| `owner` | `string` | Yes | — |
| `repo` | `string` | Yes | — |
**Output:** `boolean`
***
## Users
### get
`users.get`
Get a user by username
**Risk:** `read`
```ts theme={null}
await corsair.github.api.users.get({});
```
**Input**
| Name | Type | Required | Description |
| ---------- | -------- | -------- | ----------- |
| `username` | `string` | Yes | — |
**Output**
| Name | Type | Required | Description |
| ------------------------- | --------- | -------- | ----------- |
| `name` | `string` | No | — |
| `email` | `string` | No | — |
| `login` | `string` | Yes | — |
| `id` | `number` | Yes | — |
| `nodeId` | `string` | No | — |
| `avatarUrl` | `string` | No | — |
| `gravatarId` | `string` | No | — |
| `url` | `string` | No | — |
| `htmlUrl` | `string` | No | — |
| `followersUrl` | `string` | No | — |
| `followingUrl` | `string` | No | — |
| `gistsUrl` | `string` | No | — |
| `starredUrl` | `string` | No | — |
| `subscriptionsUrl` | `string` | No | — |
| `organizationsUrl` | `string` | No | — |
| `reposUrl` | `string` | No | — |
| `eventsUrl` | `string` | No | — |
| `receivedEventsUrl` | `string` | No | — |
| `type` | `string` | No | — |
| `siteAdmin` | `boolean` | No | — |
| `starredAt` | `Date` | No | — |
| `userViewType` | `string` | No | — |
| `company` | `string` | No | — |
| `blog` | `string` | No | — |
| `location` | `string` | No | — |
| `notificationEmail` | `string` | No | — |
| `hireable` | `boolean` | No | — |
| `bio` | `string` | No | — |
| `twitterUsername` | `string` | No | — |
| `publicRepos` | `number` | No | — |
| `publicGists` | `number` | No | — |
| `followers` | `number` | No | — |
| `following` | `number` | No | — |
| `createdAt` | `Date` | No | — |
| `updatedAt` | `Date` | No | — |
| `privateGists` | `number` | No | — |
| `totalPrivateRepos` | `number` | No | — |
| `ownedPrivateRepos` | `number` | No | — |
| `diskUsage` | `number` | No | — |
| `collaborators` | `number` | No | — |
| `twoFactorAuthentication` | `boolean` | No | — |
| `plan` | `object` | No | — |
| `businessPlus` | `boolean` | No | — |
| `ldapDn` | `string` | No | — |
```ts theme={null}
{
collaborators?: number,
name?: string,
space?: number,
privateRepos?: number
}
```
***
### getAuthenticated
`users.getAuthenticated`
Get the authenticated user
**Risk:** `read`
```ts theme={null}
await corsair.github.api.users.getAuthenticated({});
```
**Input:** *empty object*
**Output**
| Name | Type | Required | Description |
| ------------------------- | --------- | -------- | ----------- |
| `name` | `string` | No | — |
| `email` | `string` | No | — |
| `login` | `string` | Yes | — |
| `id` | `number` | Yes | — |
| `nodeId` | `string` | No | — |
| `avatarUrl` | `string` | No | — |
| `gravatarId` | `string` | No | — |
| `url` | `string` | No | — |
| `htmlUrl` | `string` | No | — |
| `followersUrl` | `string` | No | — |
| `followingUrl` | `string` | No | — |
| `gistsUrl` | `string` | No | — |
| `starredUrl` | `string` | No | — |
| `subscriptionsUrl` | `string` | No | — |
| `organizationsUrl` | `string` | No | — |
| `reposUrl` | `string` | No | — |
| `eventsUrl` | `string` | No | — |
| `receivedEventsUrl` | `string` | No | — |
| `type` | `string` | No | — |
| `siteAdmin` | `boolean` | No | — |
| `starredAt` | `Date` | No | — |
| `userViewType` | `string` | No | — |
| `company` | `string` | No | — |
| `blog` | `string` | No | — |
| `location` | `string` | No | — |
| `notificationEmail` | `string` | No | — |
| `hireable` | `boolean` | No | — |
| `bio` | `string` | No | — |
| `twitterUsername` | `string` | No | — |
| `publicRepos` | `number` | No | — |
| `publicGists` | `number` | No | — |
| `followers` | `number` | No | — |
| `following` | `number` | No | — |
| `createdAt` | `Date` | No | — |
| `updatedAt` | `Date` | No | — |
| `privateGists` | `number` | No | — |
| `totalPrivateRepos` | `number` | No | — |
| `ownedPrivateRepos` | `number` | No | — |
| `diskUsage` | `number` | No | — |
| `collaborators` | `number` | No | — |
| `twoFactorAuthentication` | `boolean` | No | — |
| `plan` | `object` | No | — |
| `businessPlus` | `boolean` | No | — |
| `ldapDn` | `string` | No | — |
```ts theme={null}
{
collaborators?: number,
name?: string,
space?: number,
privateRepos?: number
}
```
***
### getById
`users.getById`
Get a user by account ID
**Risk:** `read`
```ts theme={null}
await corsair.github.api.users.getById({});
```
**Input**
| Name | Type | Required | Description |
| ----------- | -------- | -------- | ----------- |
| `accountId` | `number` | Yes | — |
**Output**
| Name | Type | Required | Description |
| ------------------------- | --------- | -------- | ----------- |
| `name` | `string` | No | — |
| `email` | `string` | No | — |
| `login` | `string` | Yes | — |
| `id` | `number` | Yes | — |
| `nodeId` | `string` | No | — |
| `avatarUrl` | `string` | No | — |
| `gravatarId` | `string` | No | — |
| `url` | `string` | No | — |
| `htmlUrl` | `string` | No | — |
| `followersUrl` | `string` | No | — |
| `followingUrl` | `string` | No | — |
| `gistsUrl` | `string` | No | — |
| `starredUrl` | `string` | No | — |
| `subscriptionsUrl` | `string` | No | — |
| `organizationsUrl` | `string` | No | — |
| `reposUrl` | `string` | No | — |
| `eventsUrl` | `string` | No | — |
| `receivedEventsUrl` | `string` | No | — |
| `type` | `string` | No | — |
| `siteAdmin` | `boolean` | No | — |
| `starredAt` | `Date` | No | — |
| `userViewType` | `string` | No | — |
| `company` | `string` | No | — |
| `blog` | `string` | No | — |
| `location` | `string` | No | — |
| `notificationEmail` | `string` | No | — |
| `hireable` | `boolean` | No | — |
| `bio` | `string` | No | — |
| `twitterUsername` | `string` | No | — |
| `publicRepos` | `number` | No | — |
| `publicGists` | `number` | No | — |
| `followers` | `number` | No | — |
| `following` | `number` | No | — |
| `createdAt` | `Date` | No | — |
| `updatedAt` | `Date` | No | — |
| `privateGists` | `number` | No | — |
| `totalPrivateRepos` | `number` | No | — |
| `ownedPrivateRepos` | `number` | No | — |
| `diskUsage` | `number` | No | — |
| `collaborators` | `number` | No | — |
| `twoFactorAuthentication` | `boolean` | No | — |
| `plan` | `object` | No | — |
| `businessPlus` | `boolean` | No | — |
| `ldapDn` | `string` | No | — |
```ts theme={null}
{
collaborators?: number,
name?: string,
space?: number,
privateRepos?: number
}
```
***
### getHovercard
`users.getHovercard`
Get contextual hovercard information for a user
**Risk:** `read`
```ts theme={null}
await corsair.github.api.users.getHovercard({});
```
**Input**
| Name | Type | Required | Description |
| ------------- | ----------------------------------------------------- | -------- | ----------- |
| `username` | `string` | Yes | — |
| `subjectType` | `organization \| repository \| issue \| pull_request` | No | — |
| `subjectId` | `string` | No | — |
**Output**
| Name | Type | Required | Description |
| ---------- | ---------- | -------- | ----------- |
| `contexts` | `object[]` | Yes | — |
```ts theme={null}
{
message: string,
octicon: string
}[]
```
***
### list
`users.list`
List all GitHub users
**Risk:** `read`
```ts theme={null}
await corsair.github.api.users.list({});
```
**Input**
| Name | Type | Required | Description |
| --------- | -------- | -------- | ----------- |
| `since` | `number` | No | — |
| `perPage` | `number` | No | — |
**Output:** `object[]`
```ts theme={null}
{
name?: string | null,
email?: string | null,
login: string,
id: number,
nodeId?: string,
avatarUrl?: string,
gravatarId?: string | null,
url?: string,
htmlUrl?: string,
followersUrl?: string,
followingUrl?: string,
gistsUrl?: string,
starredUrl?: string,
subscriptionsUrl?: string,
organizationsUrl?: string,
reposUrl?: string,
eventsUrl?: string,
receivedEventsUrl?: string,
type?: string,
siteAdmin?: boolean,
starredAt?: Date | null,
userViewType?: string
}[]
```
***
### update
`users.update`
Update the authenticated user profile
**Risk:** `write`
```ts theme={null}
await corsair.github.api.users.update({});
```
**Input**
| Name | Type | Required | Description |
| ----------------- | --------- | -------- | ----------- |
| `name` | `string` | No | — |
| `email` | `string` | No | — |
| `blog` | `string` | No | — |
| `twitterUsername` | `string` | No | — |
| `company` | `string` | No | — |
| `location` | `string` | No | — |
| `hireable` | `boolean` | No | — |
| `bio` | `string` | No | — |
**Output**
| Name | Type | Required | Description |
| ------------------------- | --------- | -------- | ----------- |
| `name` | `string` | No | — |
| `email` | `string` | No | — |
| `login` | `string` | Yes | — |
| `id` | `number` | Yes | — |
| `nodeId` | `string` | No | — |
| `avatarUrl` | `string` | No | — |
| `gravatarId` | `string` | No | — |
| `url` | `string` | No | — |
| `htmlUrl` | `string` | No | — |
| `followersUrl` | `string` | No | — |
| `followingUrl` | `string` | No | — |
| `gistsUrl` | `string` | No | — |
| `starredUrl` | `string` | No | — |
| `subscriptionsUrl` | `string` | No | — |
| `organizationsUrl` | `string` | No | — |
| `reposUrl` | `string` | No | — |
| `eventsUrl` | `string` | No | — |
| `receivedEventsUrl` | `string` | No | — |
| `type` | `string` | No | — |
| `siteAdmin` | `boolean` | No | — |
| `starredAt` | `Date` | No | — |
| `userViewType` | `string` | No | — |
| `company` | `string` | No | — |
| `blog` | `string` | No | — |
| `location` | `string` | No | — |
| `notificationEmail` | `string` | No | — |
| `hireable` | `boolean` | No | — |
| `bio` | `string` | No | — |
| `twitterUsername` | `string` | No | — |
| `publicRepos` | `number` | No | — |
| `publicGists` | `number` | No | — |
| `followers` | `number` | No | — |
| `following` | `number` | No | — |
| `createdAt` | `Date` | No | — |
| `updatedAt` | `Date` | No | — |
| `privateGists` | `number` | No | — |
| `totalPrivateRepos` | `number` | No | — |
| `ownedPrivateRepos` | `number` | No | — |
| `diskUsage` | `number` | No | — |
| `collaborators` | `number` | No | — |
| `twoFactorAuthentication` | `boolean` | No | — |
| `plan` | `object` | No | — |
| `businessPlus` | `boolean` | No | — |
| `ldapDn` | `string` | No | — |
```ts theme={null}
{
collaborators?: number,
name?: string,
space?: number,
privateRepos?: number
}
```
***
## Workflows
### get
`workflows.get`
Get a specific workflow
**Risk:** `read`
```ts theme={null}
await corsair.github.api.workflows.get({});
```
**Input**
| Name | Type | Required | Description |
| ------------ | ------------------ | -------- | ----------- |
| `owner` | `string` | Yes | — |
| `repo` | `string` | Yes | — |
| `workflowId` | `number \| string` | Yes | — |
**Output**
| Name | Type | Required | Description |
| ----------- | -------------------------------------------------------------------------------- | -------- | ----------- |
| `id` | `number` | Yes | — |
| `nodeId` | `string` | No | — |
| `name` | `string` | Yes | — |
| `path` | `string` | Yes | — |
| `state` | `active \| deleted \| disabled_fork \| disabled_inactivity \| disabled_manually` | Yes | — |
| `createdAt` | `Date` | No | — |
| `updatedAt` | `Date` | No | — |
| `url` | `string` | No | — |
| `htmlUrl` | `string` | No | — |
| `badgeUrl` | `string` | No | — |
| `deletedAt` | `Date` | No | — |
***
### list
`workflows.list`
List workflows in a repository
**Risk:** `read`
```ts theme={null}
await corsair.github.api.workflows.list({});
```
**Input**
| Name | Type | Required | Description |
| --------- | -------- | -------- | ----------- |
| `owner` | `string` | Yes | — |
| `repo` | `string` | Yes | — |
| `perPage` | `number` | No | — |
| `page` | `number` | No | — |
**Output**
| Name | Type | Required | Description |
| ------------- | ---------- | -------- | ----------- |
| `totalCount` | `number` | No | — |
| `total_count` | `number` | No | — |
| `workflows` | `object[]` | No | — |
```ts theme={null}
{
id: number,
nodeId?: string,
name: string,
path: string,
state: active | deleted | disabled_fork | disabled_inactivity | disabled_manually,
createdAt?: Date | null,
updatedAt?: Date | null,
url?: string,
htmlUrl?: string,
badgeUrl?: string,
deletedAt?: Date | null
}[]
```
***
### listRuns
`workflows.listRuns`
List workflow runs
**Risk:** `read`
```ts theme={null}
await corsair.github.api.workflows.listRuns({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ----------- |
| `owner` | `string` | Yes | — |
| `repo` | `string` | Yes | — |
| `actor` | `string` | No | — |
| `branch` | `string` | No | — |
| `event` | `string` | No | — |
| `status` | `completed \| action_required \| cancelled \| failure \| neutral \| skipped \| stale \| success \| timed_out \| in_progress \| queued \| requested \| waiting \| pending` | No | — |
| `perPage` | `number` | No | — |
| `page` | `number` | No | — |
| `created` | `string` | No | — |
| `excludePullRequests` | `boolean` | No | — |
| `checkSuiteId` | `number` | No | — |
| `headSha` | `string` | No | — |
**Output**
| Name | Type | Required | Description |
| --------------- | ---------- | -------- | ----------- |
| `totalCount` | `number` | No | — |
| `total_count` | `number` | No | — |
| `workflowRuns` | `object[]` | No | — |
| `workflow_runs` | `object[]` | No | — |
```ts theme={null}
{
id: number,
nodeId?: string,
name?: string | null,
headBranch?: string | null,
headSha?: string,
path?: string,
runNumber?: number,
runAttempt?: number,
event?: string,
status?: string | null,
conclusion?: string | null,
workflowId?: number,
url?: string,
htmlUrl?: string,
createdAt?: Date | null,
updatedAt?: Date | null,
displayTitle?: string
}[]
```
```ts theme={null}
{
id: number,
nodeId?: string,
name?: string | null,
headBranch?: string | null,
headSha?: string,
path?: string,
runNumber?: number,
runAttempt?: number,
event?: string,
status?: string | null,
conclusion?: string | null,
workflowId?: number,
url?: string,
htmlUrl?: string,
createdAt?: Date | null,
updatedAt?: Date | null,
displayTitle?: string
}[]
```
***