Deploy Production Code for Commit 7598e9b3fc 🚀

This commit is contained in:
James Ives 2022-04-04 13:27:01 +00:00
parent 7598e9b3fc
commit cf0ab8fab5
284 changed files with 151125 additions and 36987 deletions

5
lib/constants.d.ts vendored
View File

@ -3,7 +3,8 @@ export declare enum TestFlag {
HAS_CHANGED_FILES = 2, HAS_CHANGED_FILES = 2,
HAS_REMOTE_BRANCH = 4, HAS_REMOTE_BRANCH = 4,
UNABLE_TO_REMOVE_ORIGIN = 8, UNABLE_TO_REMOVE_ORIGIN = 8,
UNABLE_TO_UNSET_GIT_CONFIG = 16 UNABLE_TO_UNSET_GIT_CONFIG = 16,
HAS_REJECTED_COMMIT = 32
} }
export interface ActionInterface { export interface ActionInterface {
/** The branch that the action should deploy to. */ /** The branch that the action should deploy to. */
@ -24,6 +25,8 @@ export interface ActionInterface {
folder: string; folder: string;
/** The auto generated folder path. */ /** The auto generated folder path. */
folderPath?: string; folderPath?: string;
/** Whether to force-push or attempt to merge existing changes. */
force?: boolean;
/** Determines test scenarios the action is running in. */ /** Determines test scenarios the action is running in. */
isTest: TestFlag; isTest: TestFlag;
/** The git config name. */ /** The git config name. */

View File

@ -1,7 +1,11 @@
"use strict"; "use strict";
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) { var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k; if (k2 === undefined) k2 = k;
Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } }); var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) { }) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k; if (k2 === undefined) k2 = k;
o[k2] = m[k]; o[k2] = m[k];
@ -31,7 +35,8 @@ var TestFlag;
TestFlag[TestFlag["HAS_CHANGED_FILES"] = 2] = "HAS_CHANGED_FILES"; TestFlag[TestFlag["HAS_CHANGED_FILES"] = 2] = "HAS_CHANGED_FILES";
TestFlag[TestFlag["HAS_REMOTE_BRANCH"] = 4] = "HAS_REMOTE_BRANCH"; TestFlag[TestFlag["HAS_REMOTE_BRANCH"] = 4] = "HAS_REMOTE_BRANCH";
TestFlag[TestFlag["UNABLE_TO_REMOVE_ORIGIN"] = 8] = "UNABLE_TO_REMOVE_ORIGIN"; TestFlag[TestFlag["UNABLE_TO_REMOVE_ORIGIN"] = 8] = "UNABLE_TO_REMOVE_ORIGIN";
TestFlag[TestFlag["UNABLE_TO_UNSET_GIT_CONFIG"] = 16] = "UNABLE_TO_UNSET_GIT_CONFIG"; // Assume we can't remove previously set git configs. TestFlag[TestFlag["UNABLE_TO_UNSET_GIT_CONFIG"] = 16] = "UNABLE_TO_UNSET_GIT_CONFIG";
TestFlag[TestFlag["HAS_REJECTED_COMMIT"] = 32] = "HAS_REJECTED_COMMIT"; // Assume commit rejection.
})(TestFlag = exports.TestFlag || (exports.TestFlag = {})); })(TestFlag = exports.TestFlag || (exports.TestFlag = {}));
/* Required action data that gets initialized when running within the GitHub Actions environment. */ /* Required action data that gets initialized when running within the GitHub Actions environment. */
exports.action = { exports.action = {
@ -41,6 +46,9 @@ exports.action = {
dryRun: !(0, util_1.isNullOrUndefined)((0, core_1.getInput)('dry-run')) dryRun: !(0, util_1.isNullOrUndefined)((0, core_1.getInput)('dry-run'))
? (0, core_1.getInput)('dry-run').toLowerCase() === 'true' ? (0, core_1.getInput)('dry-run').toLowerCase() === 'true'
: false, : false,
force: !(0, util_1.isNullOrUndefined)((0, core_1.getInput)('force'))
? (0, core_1.getInput)('force').toLowerCase() === 'true'
: true,
clean: !(0, util_1.isNullOrUndefined)((0, core_1.getInput)('clean')) clean: !(0, util_1.isNullOrUndefined)((0, core_1.getInput)('clean'))
? (0, core_1.getInput)('clean').toLowerCase() === 'true' ? (0, core_1.getInput)('clean').toLowerCase() === 'true'
: false, : false,

10
lib/execute.d.ts vendored
View File

@ -1,10 +1,18 @@
/// <reference types="node" /> /// <reference types="node" />
declare type ExecuteOutput = {
stdout: string;
stderr: string;
};
/** Wrapper around the GitHub toolkit exec command which returns the output. /** Wrapper around the GitHub toolkit exec command which returns the output.
* Also allows you to easily toggle the current working directory. * Also allows you to easily toggle the current working directory.
* *
* @param {string} cmd - The command to execute. * @param {string} cmd - The command to execute.
* @param {string} cwd - The current working directory. * @param {string} cwd - The current working directory.
* @param {boolean} silent - Determines if the in/out should be silenced or not. * @param {boolean} silent - Determines if the in/out should be silenced or not.
* @param {boolean} ignoreReturnCode - Determines whether to throw an error
* on a non-zero exit status or to leave implementation up to the caller.
*/ */
export declare function execute(cmd: string, cwd: string, silent: boolean): Promise<string>; export declare function execute(cmd: string, cwd: string, silent: boolean, ignoreReturnCode?: boolean): Promise<ExecuteOutput>;
export declare function stdout(data: Buffer | string): void; export declare function stdout(data: Buffer | string): void;
export declare function stderr(data: Buffer | string): void;
export {};

View File

@ -12,27 +12,29 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod }; return (mod && mod.__esModule) ? mod : { "default": mod };
}; };
Object.defineProperty(exports, "__esModule", { value: true }); Object.defineProperty(exports, "__esModule", { value: true });
exports.stdout = exports.execute = void 0; exports.stderr = exports.stdout = exports.execute = void 0;
const exec_1 = require("@actions/exec"); const exec_1 = require("@actions/exec");
const buffer_1 = __importDefault(require("buffer")); const buffer_1 = __importDefault(require("buffer"));
let output = ''; const output = { stdout: '', stderr: '' };
/** Wrapper around the GitHub toolkit exec command which returns the output. /** Wrapper around the GitHub toolkit exec command which returns the output.
* Also allows you to easily toggle the current working directory. * Also allows you to easily toggle the current working directory.
* *
* @param {string} cmd - The command to execute. * @param {string} cmd - The command to execute.
* @param {string} cwd - The current working directory. * @param {string} cwd - The current working directory.
* @param {boolean} silent - Determines if the in/out should be silenced or not. * @param {boolean} silent - Determines if the in/out should be silenced or not.
* @param {boolean} ignoreReturnCode - Determines whether to throw an error
* on a non-zero exit status or to leave implementation up to the caller.
*/ */
function execute(cmd, cwd, silent) { function execute(cmd, cwd, silent, ignoreReturnCode = false) {
return __awaiter(this, void 0, void 0, function* () { return __awaiter(this, void 0, void 0, function* () {
output = ''; output.stdout = '';
output.stderr = '';
yield (0, exec_1.exec)(cmd, [], { yield (0, exec_1.exec)(cmd, [], {
// Silences the input unless the INPUT_DEBUG flag is set. // Silences the input unless the INPUT_DEBUG flag is set.
silent, silent,
cwd, cwd,
listeners: { listeners: { stdout, stderr },
stdout ignoreReturnCode
}
}); });
return Promise.resolve(output); return Promise.resolve(output);
}); });
@ -40,8 +42,17 @@ function execute(cmd, cwd, silent) {
exports.execute = execute; exports.execute = execute;
function stdout(data) { function stdout(data) {
const dataString = data.toString().trim(); const dataString = data.toString().trim();
if (output.length + dataString.length < buffer_1.default.constants.MAX_STRING_LENGTH) { if (output.stdout.length + dataString.length <
output += dataString; buffer_1.default.constants.MAX_STRING_LENGTH) {
output.stdout += dataString;
} }
} }
exports.stdout = stdout; exports.stdout = stdout;
function stderr(data) {
const dataString = data.toString().trim();
if (output.stderr.length + dataString.length <
buffer_1.default.constants.MAX_STRING_LENGTH) {
output.stderr += dataString;
}
}
exports.stderr = stderr;

View File

@ -77,7 +77,7 @@ function deploy(action) {
: ''} 🚀`; : ''} 🚀`;
// Checks to see if the remote exists prior to deploying. // Checks to see if the remote exists prior to deploying.
const branchExists = action.isTest & constants_1.TestFlag.HAS_REMOTE_BRANCH || const branchExists = action.isTest & constants_1.TestFlag.HAS_REMOTE_BRANCH ||
(yield (0, execute_1.execute)(`git ls-remote --heads ${action.repositoryPath} refs/heads/${action.branch}`, action.workspace, action.silent)); Boolean((yield (0, execute_1.execute)(`git ls-remote --heads ${action.repositoryPath} refs/heads/${action.branch}`, action.workspace, action.silent)).stdout);
yield (0, worktree_1.generateWorktree)(action, temporaryDeploymentDirectory, branchExists); yield (0, worktree_1.generateWorktree)(action, temporaryDeploymentDirectory, branchExists);
// Ensures that items that need to be excluded from the clean job get parsed. // Ensures that items that need to be excluded from the clean job get parsed.
let excludes = ''; let excludes = '';
@ -117,8 +117,8 @@ function deploy(action) {
: `git status --porcelain`; : `git status --porcelain`;
(0, core_1.info)(`Checking if there are files to commit…`); (0, core_1.info)(`Checking if there are files to commit…`);
const hasFilesToCommit = action.isTest & constants_1.TestFlag.HAS_CHANGED_FILES || const hasFilesToCommit = action.isTest & constants_1.TestFlag.HAS_CHANGED_FILES ||
(yield (0, execute_1.execute)(checkGitStatus, `${action.workspace}/${temporaryDeploymentDirectory}`, true // This output is always silenced due to the large output it creates. Boolean((yield (0, execute_1.execute)(checkGitStatus, `${action.workspace}/${temporaryDeploymentDirectory}`, true // This output is always silenced due to the large output it creates.
)); )).stdout);
if ((!action.singleCommit && !hasFilesToCommit) || if ((!action.singleCommit && !hasFilesToCommit) ||
// Ignores the case where single commit is true with a target folder to prevent incorrect early exiting. // Ignores the case where single commit is true with a target folder to prevent incorrect early exiting.
(action.singleCommit && !action.targetFolder && !hasFilesToCommit)) { (action.singleCommit && !action.targetFolder && !hasFilesToCommit)) {
@ -128,9 +128,51 @@ function deploy(action) {
yield (0, execute_1.execute)(`git add --all .`, `${action.workspace}/${temporaryDeploymentDirectory}`, action.silent); yield (0, execute_1.execute)(`git add --all .`, `${action.workspace}/${temporaryDeploymentDirectory}`, action.silent);
yield (0, execute_1.execute)(`git checkout -b ${temporaryDeploymentBranch}`, `${action.workspace}/${temporaryDeploymentDirectory}`, action.silent); yield (0, execute_1.execute)(`git checkout -b ${temporaryDeploymentBranch}`, `${action.workspace}/${temporaryDeploymentDirectory}`, action.silent);
yield (0, execute_1.execute)(`git commit -m "${commitMessage}" --quiet --no-verify`, `${action.workspace}/${temporaryDeploymentDirectory}`, action.silent); yield (0, execute_1.execute)(`git commit -m "${commitMessage}" --quiet --no-verify`, `${action.workspace}/${temporaryDeploymentDirectory}`, action.silent);
if (!action.dryRun) { if (action.dryRun) {
(0, core_1.info)(`Dry run complete`);
return constants_1.Status.SUCCESS;
}
if (action.force) {
// Force-push our changes, overwriting any changes that were added in
// the meantime
(0, core_1.info)(`Force-pushing changes...`);
yield (0, execute_1.execute)(`git push --force ${action.repositoryPath} ${temporaryDeploymentBranch}:${action.branch}`, `${action.workspace}/${temporaryDeploymentDirectory}`, action.silent); yield (0, execute_1.execute)(`git push --force ${action.repositoryPath} ${temporaryDeploymentBranch}:${action.branch}`, `${action.workspace}/${temporaryDeploymentDirectory}`, action.silent);
} }
else {
const ATTEMPT_LIMIT = 3;
// Attempt to push our changes, but fetch + rebase if there were
// other changes added in the meantime
let attempt = 0;
// Keep track of whether the most recent attempt was rejected
let rejected = false;
do {
attempt++;
if (attempt > ATTEMPT_LIMIT)
throw new Error(`Attempt limit exceeded`);
// Handle rejection for the previous attempt first such that, on
// the final attempt, time is not wasted rebasing it when it will
// not be pushed
if (rejected) {
(0, core_1.info)(`Fetching upstream ${action.branch}`);
yield (0, execute_1.execute)(`git fetch ${action.repositoryPath} ${action.branch}:${action.branch}`, `${action.workspace}/${temporaryDeploymentDirectory}`, action.silent);
(0, core_1.info)(`Rebasing this deployment onto ${action.branch}`);
yield (0, execute_1.execute)(`git rebase ${action.branch} ${temporaryDeploymentBranch}`, `${action.workspace}/${temporaryDeploymentDirectory}`, action.silent);
}
(0, core_1.info)(`Pushing changes… (attempt ${attempt} of ${ATTEMPT_LIMIT})`);
const pushResult = yield (0, execute_1.execute)(`git push --porcelain ${action.repositoryPath} ${temporaryDeploymentBranch}:${action.branch}`, `${action.workspace}/${temporaryDeploymentDirectory}`, action.silent, true // Ignore non-zero exit status
);
rejected =
Boolean(action.isTest) ||
pushResult.stdout.includes(`[rejected]`) ||
pushResult.stdout.includes(`[remote rejected]`);
if (rejected)
(0, core_1.info)('Updates were rejected');
// If the push failed for any reason other than being rejected,
// there is a problem
if (!rejected && pushResult.stderr)
throw new Error(pushResult.stderr);
} while (rejected);
}
(0, core_1.info)(`Changes committed to the ${action.branch} branch… 📦`); (0, core_1.info)(`Changes committed to the ${action.branch} branch… 📦`);
return constants_1.Status.SUCCESS; return constants_1.Status.SUCCESS;
} }

View File

@ -1,6 +1,6 @@
{ {
"name": "@actions/exec", "name": "@actions/exec",
"version": "1.1.0", "version": "1.1.1",
"description": "Actions exec lib", "description": "Actions exec lib",
"keywords": [ "keywords": [
"github", "github",

View File

@ -59,18 +59,19 @@ const newIssue = await octokit.rest.issues.create({
## Webhook payload typescript definitions ## Webhook payload typescript definitions
The npm module `@octokit/webhooks` provides type definitions for the response payloads. You can cast the payload to these types for better type information. The npm module `@octokit/webhooks-definitions` provides type definitions for the response payloads. You can cast the payload to these types for better type information.
First, install the npm module `npm install @octokit/webhooks` First, install the npm module `npm install @octokit/webhooks-definitions`
Then, assert the type based on the eventName Then, assert the type based on the eventName
```ts ```ts
import * as core from '@actions/core' import * as core from '@actions/core'
import * as github from '@actions/github' import * as github from '@actions/github'
import * as Webhooks from '@octokit/webhooks' import {PushEvent} from '@octokit/webhooks-definitions/schema'
if (github.context.eventName === 'push') { if (github.context.eventName === 'push') {
const pushPayload = github.context.payload as Webhooks.WebhookPayloadPush const pushPayload = github.context.payload as PushEvent
core.info(`The head commit is: ${pushPayload.head}`) core.info(`The head commit is: ${pushPayload.head_commit}`)
} }
``` ```

View File

@ -1,6 +1,6 @@
{ {
"name": "@actions/github", "name": "@actions/github",
"version": "5.0.0", "version": "5.0.1",
"description": "Actions github lib", "description": "Actions github lib",
"keywords": [ "keywords": [
"github", "github",
@ -39,12 +39,11 @@
}, },
"dependencies": { "dependencies": {
"@actions/http-client": "^1.0.11", "@actions/http-client": "^1.0.11",
"@octokit/core": "^3.4.0", "@octokit/core": "^3.6.0",
"@octokit/plugin-paginate-rest": "^2.13.3", "@octokit/plugin-paginate-rest": "^2.17.0",
"@octokit/plugin-rest-endpoint-methods": "^5.1.1" "@octokit/plugin-rest-endpoint-methods": "^5.13.0"
}, },
"devDependencies": { "devDependencies": {
"jest": "^26.6.3",
"proxy": "^1.0.2" "proxy": "^1.0.2"
} }
} }

View File

@ -1,6 +1,6 @@
{ {
"name": "@actions/io", "name": "@actions/io",
"version": "1.1.1", "version": "1.1.2",
"description": "Actions io lib", "description": "Actions io lib",
"keywords": [ "keywords": [
"github", "github",

18
node_modules/@octokit/core/README.md generated vendored
View File

@ -360,7 +360,7 @@ octokit.hook.after("request", async (response, options) => {
}); });
octokit.hook.error("request", async (error, options) => { octokit.hook.error("request", async (error, options) => {
if (error.status === 304) { if (error.status === 304) {
return findInCache(error.headers.etag); return findInCache(error.response.headers.etag);
} }
throw error; throw error;
@ -423,11 +423,19 @@ You can build your own Octokit class with preset default options and plugins. In
```js ```js
const { Octokit } = require("@octokit/core"); const { Octokit } = require("@octokit/core");
const MyActionOctokit = Octokit.plugin( const MyActionOctokit = Octokit.plugin(
require("@octokit/plugin-paginate-rest"), require("@octokit/plugin-paginate-rest").paginateRest,
require("@octokit/plugin-throttling"), require("@octokit/plugin-throttling").throttling,
require("@octokit/plugin-retry") require("@octokit/plugin-retry").retry
).defaults({ ).defaults({
authStrategy: require("@octokit/auth-action"), throttle: {
onAbuseLimit: (retryAfter, options) => {
/* ... */
},
onRateLimit: (retryAfter, options) => {
/* ... */
},
},
authStrategy: require("@octokit/auth-action").createActionAuth,
userAgent: `my-octokit-action/v1.2.3`, userAgent: `my-octokit-action/v1.2.3`,
}); });

View File

@ -44,8 +44,9 @@ function _objectWithoutProperties(source, excluded) {
return target; return target;
} }
const VERSION = "3.4.0"; const VERSION = "3.6.0";
const _excluded = ["authStrategy"];
class Octokit { class Octokit {
constructor(options = {}) { constructor(options = {}) {
const hook = new beforeAfterHook.Collection(); const hook = new beforeAfterHook.Collection();
@ -107,7 +108,7 @@ class Octokit {
const { const {
authStrategy authStrategy
} = options, } = options,
otherOptions = _objectWithoutProperties(options, ["authStrategy"]); otherOptions = _objectWithoutProperties(options, _excluded);
const auth = authStrategy(Object.assign({ const auth = authStrategy(Object.assign({
request: this.request, request: this.request,

File diff suppressed because one or more lines are too long

View File

@ -1 +1 @@
export const VERSION = "3.4.0"; export const VERSION = "3.6.0";

View File

@ -2,7 +2,7 @@ import * as OctokitTypes from "@octokit/types";
import { RequestError } from "@octokit/request-error"; import { RequestError } from "@octokit/request-error";
import { Octokit } from "."; import { Octokit } from ".";
export declare type RequestParameters = OctokitTypes.RequestParameters; export declare type RequestParameters = OctokitTypes.RequestParameters;
export declare type OctokitOptions = { export interface OctokitOptions {
authStrategy?: any; authStrategy?: any;
auth?: any; auth?: any;
userAgent?: string; userAgent?: string;
@ -17,9 +17,9 @@ export declare type OctokitOptions = {
request?: OctokitTypes.RequestRequestOptions; request?: OctokitTypes.RequestRequestOptions;
timeZone?: string; timeZone?: string;
[option: string]: any; [option: string]: any;
}; }
export declare type Constructor<T> = new (...args: any[]) => T; export declare type Constructor<T> = new (...args: any[]) => T;
export declare type ReturnTypeOf<T extends AnyFunction | AnyFunction[]> = T extends AnyFunction ? ReturnType<T> : T extends AnyFunction[] ? UnionToIntersection<ReturnType<T[number]>> : never; export declare type ReturnTypeOf<T extends AnyFunction | AnyFunction[]> = T extends AnyFunction ? ReturnType<T> : T extends AnyFunction[] ? UnionToIntersection<Exclude<ReturnType<T[number]>, void>> : never;
/** /**
* @author https://stackoverflow.com/users/2887218/jcalz * @author https://stackoverflow.com/users/2887218/jcalz
* @see https://stackoverflow.com/a/50375286/10325032 * @see https://stackoverflow.com/a/50375286/10325032

View File

@ -1 +1 @@
export declare const VERSION = "3.4.0"; export declare const VERSION = "3.6.0";

View File

@ -4,7 +4,7 @@ import { request } from '@octokit/request';
import { withCustomRequest } from '@octokit/graphql'; import { withCustomRequest } from '@octokit/graphql';
import { createTokenAuth } from '@octokit/auth-token'; import { createTokenAuth } from '@octokit/auth-token';
const VERSION = "3.4.0"; const VERSION = "3.6.0";
class Octokit { class Octokit {
constructor(options = {}) { constructor(options = {}) {

File diff suppressed because one or more lines are too long

View File

@ -1,7 +1,7 @@
{ {
"name": "@octokit/core", "name": "@octokit/core",
"description": "Extendable client for GitHub's REST & GraphQL APIs", "description": "Extendable client for GitHub's REST & GraphQL APIs",
"version": "3.4.0", "version": "3.6.0",
"license": "MIT", "license": "MIT",
"files": [ "files": [
"dist-*/", "dist-*/",
@ -20,7 +20,7 @@
"dependencies": { "dependencies": {
"@octokit/auth-token": "^2.4.4", "@octokit/auth-token": "^2.4.4",
"@octokit/graphql": "^4.5.8", "@octokit/graphql": "^4.5.8",
"@octokit/request": "^5.4.12", "@octokit/request": "^5.6.3",
"@octokit/request-error": "^2.0.5", "@octokit/request-error": "^2.0.5",
"@octokit/types": "^6.0.3", "@octokit/types": "^6.0.3",
"before-after-hook": "^2.2.0", "before-after-hook": "^2.2.0",
@ -33,19 +33,18 @@
"@pika/plugin-build-web": "^0.9.0", "@pika/plugin-build-web": "^0.9.0",
"@pika/plugin-ts-standard-pkg": "^0.9.0", "@pika/plugin-ts-standard-pkg": "^0.9.0",
"@types/fetch-mock": "^7.3.1", "@types/fetch-mock": "^7.3.1",
"@types/jest": "^26.0.0", "@types/jest": "^27.0.0",
"@types/lolex": "^5.1.0", "@types/lolex": "^5.1.0",
"@types/node": "^14.0.4", "@types/node": "^14.0.4",
"@types/node-fetch": "^2.5.0",
"fetch-mock": "^9.0.0", "fetch-mock": "^9.0.0",
"http-proxy-agent": "^4.0.1", "http-proxy-agent": "^5.0.0",
"jest": "^26.1.0", "jest": "^27.0.0",
"lolex": "^6.0.0", "lolex": "^6.0.0",
"prettier": "^2.0.4", "prettier": "2.4.1",
"proxy": "^1.0.1", "proxy": "^1.0.1",
"semantic-release": "^17.0.0", "semantic-release": "^18.0.0",
"semantic-release-plugin-update-version-in-files": "^1.0.0", "semantic-release-plugin-update-version-in-files": "^1.0.0",
"ts-jest": "^26.1.3", "ts-jest": "^27.0.0",
"typescript": "^4.0.2" "typescript": "^4.0.2"
}, },
"publishConfig": { "publishConfig": {

View File

@ -117,7 +117,7 @@ const issues = await octokit.paginate(
Alternatively you can pass a `request` method as first argument. This is great when using in combination with [`@octokit/plugin-rest-endpoint-methods`](https://github.com/octokit/plugin-rest-endpoint-methods.js/): Alternatively you can pass a `request` method as first argument. This is great when using in combination with [`@octokit/plugin-rest-endpoint-methods`](https://github.com/octokit/plugin-rest-endpoint-methods.js/):
```js ```js
const issues = await octokit.paginate(octokit.issues.listForRepo, { const issues = await octokit.paginate(octokit.rest.issues.listForRepo, {
owner: "octocat", owner: "octocat",
repo: "hello-world", repo: "hello-world",
since: "2010-10-01", since: "2010-10-01",
@ -156,7 +156,7 @@ const parameters = {
per_page: 100, per_page: 100,
}; };
for await (const response of octokit.paginate.iterator( for await (const response of octokit.paginate.iterator(
octokit.issues.listForRepo, octokit.rest.issues.listForRepo,
parameters parameters
)) { )) {
// do whatever you want with each response, break out of the loop, etc. // do whatever you want with each response, break out of the loop, etc.
@ -192,7 +192,6 @@ The plugin also exposes some types and runtime type guards for TypeScript projec
<table> <table>
<tbody valign=top align=left> <tbody valign=top align=left>
<tr><th> <tr><th>
<tr><th>
Types Types
</th><td> </th><td>

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@ -1,4 +1,5 @@
export const paginatingEndpoints = [ export const paginatingEndpoints = [
"GET /app/hook/deliveries",
"GET /app/installations", "GET /app/installations",
"GET /applications/grants", "GET /applications/grants",
"GET /authorizations", "GET /authorizations",
@ -37,6 +38,7 @@ export const paginatingEndpoints = [
"GET /orgs/{org}/events", "GET /orgs/{org}/events",
"GET /orgs/{org}/failed_invitations", "GET /orgs/{org}/failed_invitations",
"GET /orgs/{org}/hooks", "GET /orgs/{org}/hooks",
"GET /orgs/{org}/hooks/{hook_id}/deliveries",
"GET /orgs/{org}/installations", "GET /orgs/{org}/installations",
"GET /orgs/{org}/invitations", "GET /orgs/{org}/invitations",
"GET /orgs/{org}/invitations/{invitation_id}/teams", "GET /orgs/{org}/invitations/{invitation_id}/teams",
@ -45,9 +47,11 @@ export const paginatingEndpoints = [
"GET /orgs/{org}/migrations", "GET /orgs/{org}/migrations",
"GET /orgs/{org}/migrations/{migration_id}/repositories", "GET /orgs/{org}/migrations/{migration_id}/repositories",
"GET /orgs/{org}/outside_collaborators", "GET /orgs/{org}/outside_collaborators",
"GET /orgs/{org}/packages",
"GET /orgs/{org}/projects", "GET /orgs/{org}/projects",
"GET /orgs/{org}/public_members", "GET /orgs/{org}/public_members",
"GET /orgs/{org}/repos", "GET /orgs/{org}/repos",
"GET /orgs/{org}/secret-scanning/alerts",
"GET /orgs/{org}/team-sync/groups", "GET /orgs/{org}/team-sync/groups",
"GET /orgs/{org}/teams", "GET /orgs/{org}/teams",
"GET /orgs/{org}/teams/{team_slug}/discussions", "GET /orgs/{org}/teams/{team_slug}/discussions",
@ -68,11 +72,13 @@ export const paginatingEndpoints = [
"GET /repos/{owner}/{repo}/actions/runners/downloads", "GET /repos/{owner}/{repo}/actions/runners/downloads",
"GET /repos/{owner}/{repo}/actions/runs", "GET /repos/{owner}/{repo}/actions/runs",
"GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts", "GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts",
"GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs",
"GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs", "GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs",
"GET /repos/{owner}/{repo}/actions/secrets", "GET /repos/{owner}/{repo}/actions/secrets",
"GET /repos/{owner}/{repo}/actions/workflows", "GET /repos/{owner}/{repo}/actions/workflows",
"GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs", "GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs",
"GET /repos/{owner}/{repo}/assignees", "GET /repos/{owner}/{repo}/assignees",
"GET /repos/{owner}/{repo}/autolinks",
"GET /repos/{owner}/{repo}/branches", "GET /repos/{owner}/{repo}/branches",
"GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations", "GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations",
"GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs", "GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs",
@ -96,6 +102,7 @@ export const paginatingEndpoints = [
"GET /repos/{owner}/{repo}/forks", "GET /repos/{owner}/{repo}/forks",
"GET /repos/{owner}/{repo}/git/matching-refs/{ref}", "GET /repos/{owner}/{repo}/git/matching-refs/{ref}",
"GET /repos/{owner}/{repo}/hooks", "GET /repos/{owner}/{repo}/hooks",
"GET /repos/{owner}/{repo}/hooks/{hook_id}/deliveries",
"GET /repos/{owner}/{repo}/invitations", "GET /repos/{owner}/{repo}/invitations",
"GET /repos/{owner}/{repo}/issues", "GET /repos/{owner}/{repo}/issues",
"GET /repos/{owner}/{repo}/issues/comments", "GET /repos/{owner}/{repo}/issues/comments",
@ -166,6 +173,7 @@ export const paginatingEndpoints = [
"GET /user/migrations", "GET /user/migrations",
"GET /user/migrations/{migration_id}/repositories", "GET /user/migrations/{migration_id}/repositories",
"GET /user/orgs", "GET /user/orgs",
"GET /user/packages",
"GET /user/public_emails", "GET /user/public_emails",
"GET /user/repos", "GET /user/repos",
"GET /user/repository_invitations", "GET /user/repository_invitations",
@ -182,6 +190,7 @@ export const paginatingEndpoints = [
"GET /users/{username}/gpg_keys", "GET /users/{username}/gpg_keys",
"GET /users/{username}/keys", "GET /users/{username}/keys",
"GET /users/{username}/orgs", "GET /users/{username}/orgs",
"GET /users/{username}/packages",
"GET /users/{username}/projects", "GET /users/{username}/projects",
"GET /users/{username}/received_events", "GET /users/{username}/received_events",
"GET /users/{username}/received_events/public", "GET /users/{username}/received_events/public",

View File

@ -12,6 +12,7 @@ export function iterator(octokit, route, parameters) {
async next() { async next() {
if (!url) if (!url)
return { done: true }; return { done: true };
try {
const response = await requestMethod({ method, url, headers }); const response = await requestMethod({ method, url, headers });
const normalizedResponse = normalizePaginatedListResponse(response); const normalizedResponse = normalizePaginatedListResponse(response);
// `response.headers.link` format: // `response.headers.link` format:
@ -19,6 +20,19 @@ export function iterator(octokit, route, parameters) {
// sets `url` to undefined if "next" URL is not present or `link` header is not set // sets `url` to undefined if "next" URL is not present or `link` header is not set
url = ((normalizedResponse.headers.link || "").match(/<([^>]+)>;\s*rel="next"/) || [])[1]; url = ((normalizedResponse.headers.link || "").match(/<([^>]+)>;\s*rel="next"/) || [])[1];
return { value: normalizedResponse }; return { value: normalizedResponse };
}
catch (error) {
if (error.status !== 409)
throw error;
url = "";
return {
value: {
status: 200,
headers: {},
data: [],
},
};
}
}, },
}), }),
}; };

View File

@ -15,6 +15,13 @@
* otherwise match: https://developer.github.com/v3/repos/statuses/#get-the-combined-status-for-a-specific-ref * otherwise match: https://developer.github.com/v3/repos/statuses/#get-the-combined-status-for-a-specific-ref
*/ */
export function normalizePaginatedListResponse(response) { export function normalizePaginatedListResponse(response) {
// endpoints can respond with 204 if repository is empty
if (!response.data) {
return {
...response,
data: [],
};
}
const responseNeedsNormalization = "total_count" in response.data && !("url" in response.data); const responseNeedsNormalization = "total_count" in response.data && !("url" in response.data);
if (!responseNeedsNormalization) if (!responseNeedsNormalization)
return response; return response;

View File

@ -1 +1 @@
export const VERSION = "2.13.3"; export const VERSION = "2.17.0";

View File

@ -1,7 +1,14 @@
import { Endpoints } from "@octokit/types"; import { Endpoints } from "@octokit/types";
export interface PaginatingEndpoints { export interface PaginatingEndpoints {
/** /**
* @see https://docs.github.com/rest/reference/apps/#list-installations-for-the-authenticated-app * @see https://docs.github.com/rest/reference/apps#list-deliveries-for-an-app-webhook
*/
"GET /app/hook/deliveries": {
parameters: Endpoints["GET /app/hook/deliveries"]["parameters"];
response: Endpoints["GET /app/hook/deliveries"]["response"];
};
/**
* @see https://docs.github.com/rest/reference/apps#list-installations-for-the-authenticated-app
*/ */
"GET /app/installations": { "GET /app/installations": {
parameters: Endpoints["GET /app/installations"]["parameters"]; parameters: Endpoints["GET /app/installations"]["parameters"];
@ -81,21 +88,21 @@ export interface PaginatingEndpoints {
response: Endpoints["GET /events"]["response"]; response: Endpoints["GET /events"]["response"];
}; };
/** /**
* @see https://docs.github.com/rest/reference/gists/#list-gists-for-the-authenticated-user * @see https://docs.github.com/rest/reference/gists#list-gists-for-the-authenticated-user
*/ */
"GET /gists": { "GET /gists": {
parameters: Endpoints["GET /gists"]["parameters"]; parameters: Endpoints["GET /gists"]["parameters"];
response: Endpoints["GET /gists"]["response"]; response: Endpoints["GET /gists"]["response"];
}; };
/** /**
* @see https://docs.github.com/rest/reference/gists/#list-public-gists * @see https://docs.github.com/rest/reference/gists#list-public-gists
*/ */
"GET /gists/public": { "GET /gists/public": {
parameters: Endpoints["GET /gists/public"]["parameters"]; parameters: Endpoints["GET /gists/public"]["parameters"];
response: Endpoints["GET /gists/public"]["response"]; response: Endpoints["GET /gists/public"]["response"];
}; };
/** /**
* @see https://docs.github.com/rest/reference/gists/#list-starred-gists * @see https://docs.github.com/rest/reference/gists#list-starred-gists
*/ */
"GET /gists/starred": { "GET /gists/starred": {
parameters: Endpoints["GET /gists/starred"]["parameters"]; parameters: Endpoints["GET /gists/starred"]["parameters"];
@ -109,14 +116,14 @@ export interface PaginatingEndpoints {
response: Endpoints["GET /gists/{gist_id}/comments"]["response"]; response: Endpoints["GET /gists/{gist_id}/comments"]["response"];
}; };
/** /**
* @see https://docs.github.com/rest/reference/gists/#list-gist-commits * @see https://docs.github.com/rest/reference/gists#list-gist-commits
*/ */
"GET /gists/{gist_id}/commits": { "GET /gists/{gist_id}/commits": {
parameters: Endpoints["GET /gists/{gist_id}/commits"]["parameters"]; parameters: Endpoints["GET /gists/{gist_id}/commits"]["parameters"];
response: Endpoints["GET /gists/{gist_id}/commits"]["response"]; response: Endpoints["GET /gists/{gist_id}/commits"]["response"];
}; };
/** /**
* @see https://docs.github.com/rest/reference/gists/#list-gist-forks * @see https://docs.github.com/rest/reference/gists#list-gist-forks
*/ */
"GET /gists/{gist_id}/forks": { "GET /gists/{gist_id}/forks": {
parameters: Endpoints["GET /gists/{gist_id}/forks"]["parameters"]; parameters: Endpoints["GET /gists/{gist_id}/forks"]["parameters"];
@ -132,7 +139,7 @@ export interface PaginatingEndpoints {
}; };
}; };
/** /**
* @see https://docs.github.com/rest/reference/issues/#list-issues-assigned-to-the-authenticated-user * @see https://docs.github.com/rest/reference/issues#list-issues-assigned-to-the-authenticated-user
*/ */
"GET /issues": { "GET /issues": {
parameters: Endpoints["GET /issues"]["parameters"]; parameters: Endpoints["GET /issues"]["parameters"];
@ -181,7 +188,7 @@ export interface PaginatingEndpoints {
response: Endpoints["GET /notifications"]["response"]; response: Endpoints["GET /notifications"]["response"];
}; };
/** /**
* @see https://docs.github.com/rest/reference/orgs/#list-organizations * @see https://docs.github.com/rest/reference/orgs#list-organizations
*/ */
"GET /organizations": { "GET /organizations": {
parameters: Endpoints["GET /organizations"]["parameters"]; parameters: Endpoints["GET /organizations"]["parameters"];
@ -265,7 +272,7 @@ export interface PaginatingEndpoints {
response: Endpoints["GET /orgs/{org}/blocks"]["response"]; response: Endpoints["GET /orgs/{org}/blocks"]["response"];
}; };
/** /**
* @see https://docs.github.com/rest/reference/orgs/#list-saml-sso-authorizations-for-an-organization * @see https://docs.github.com/rest/reference/orgs#list-saml-sso-authorizations-for-an-organization
*/ */
"GET /orgs/{org}/credential-authorizations": { "GET /orgs/{org}/credential-authorizations": {
parameters: Endpoints["GET /orgs/{org}/credential-authorizations"]["parameters"]; parameters: Endpoints["GET /orgs/{org}/credential-authorizations"]["parameters"];
@ -293,7 +300,14 @@ export interface PaginatingEndpoints {
response: Endpoints["GET /orgs/{org}/hooks"]["response"]; response: Endpoints["GET /orgs/{org}/hooks"]["response"];
}; };
/** /**
* @see https://docs.github.com/rest/reference/orgs/#list-app-installations-for-an-organization * @see https://docs.github.com/rest/reference/orgs#list-deliveries-for-an-organization-webhook
*/
"GET /orgs/{org}/hooks/{hook_id}/deliveries": {
parameters: Endpoints["GET /orgs/{org}/hooks/{hook_id}/deliveries"]["parameters"];
response: Endpoints["GET /orgs/{org}/hooks/{hook_id}/deliveries"]["response"];
};
/**
* @see https://docs.github.com/rest/reference/orgs#list-app-installations-for-an-organization
*/ */
"GET /orgs/{org}/installations": { "GET /orgs/{org}/installations": {
parameters: Endpoints["GET /orgs/{org}/installations"]["parameters"]; parameters: Endpoints["GET /orgs/{org}/installations"]["parameters"];
@ -316,7 +330,7 @@ export interface PaginatingEndpoints {
response: Endpoints["GET /orgs/{org}/invitations/{invitation_id}/teams"]["response"]; response: Endpoints["GET /orgs/{org}/invitations/{invitation_id}/teams"]["response"];
}; };
/** /**
* @see https://docs.github.com/rest/reference/issues/#list-organization-issues-assigned-to-the-authenticated-user * @see https://docs.github.com/rest/reference/issues#list-organization-issues-assigned-to-the-authenticated-user
*/ */
"GET /orgs/{org}/issues": { "GET /orgs/{org}/issues": {
parameters: Endpoints["GET /orgs/{org}/issues"]["parameters"]; parameters: Endpoints["GET /orgs/{org}/issues"]["parameters"];
@ -351,7 +365,14 @@ export interface PaginatingEndpoints {
response: Endpoints["GET /orgs/{org}/outside_collaborators"]["response"]; response: Endpoints["GET /orgs/{org}/outside_collaborators"]["response"];
}; };
/** /**
* @see https://docs.github.com/rest/reference/projects/#list-organization-projects * @see https://docs.github.com/rest/reference/packages#list-packages-for-an-organization
*/
"GET /orgs/{org}/packages": {
parameters: Endpoints["GET /orgs/{org}/packages"]["parameters"];
response: Endpoints["GET /orgs/{org}/packages"]["response"];
};
/**
* @see https://docs.github.com/rest/reference/projects#list-organization-projects
*/ */
"GET /orgs/{org}/projects": { "GET /orgs/{org}/projects": {
parameters: Endpoints["GET /orgs/{org}/projects"]["parameters"]; parameters: Endpoints["GET /orgs/{org}/projects"]["parameters"];
@ -365,12 +386,19 @@ export interface PaginatingEndpoints {
response: Endpoints["GET /orgs/{org}/public_members"]["response"]; response: Endpoints["GET /orgs/{org}/public_members"]["response"];
}; };
/** /**
* @see https://docs.github.com/rest/reference/repos/#list-organization-repositories * @see https://docs.github.com/rest/reference/repos#list-organization-repositories
*/ */
"GET /orgs/{org}/repos": { "GET /orgs/{org}/repos": {
parameters: Endpoints["GET /orgs/{org}/repos"]["parameters"]; parameters: Endpoints["GET /orgs/{org}/repos"]["parameters"];
response: Endpoints["GET /orgs/{org}/repos"]["response"]; response: Endpoints["GET /orgs/{org}/repos"]["response"];
}; };
/**
* @see https://docs.github.com/rest/reference/secret-scanning#list-secret-scanning-alerts-by-organization
*/
"GET /orgs/{org}/secret-scanning/alerts": {
parameters: Endpoints["GET /orgs/{org}/secret-scanning/alerts"]["parameters"];
response: Endpoints["GET /orgs/{org}/secret-scanning/alerts"]["response"];
};
/** /**
* @see https://docs.github.com/rest/reference/teams#list-idp-groups-for-an-organization * @see https://docs.github.com/rest/reference/teams#list-idp-groups-for-an-organization
*/ */
@ -381,7 +409,7 @@ export interface PaginatingEndpoints {
}; };
}; };
/** /**
* @see https://docs.github.com/rest/reference/teams/#list-teams * @see https://docs.github.com/rest/reference/teams#list-teams
*/ */
"GET /orgs/{org}/teams": { "GET /orgs/{org}/teams": {
parameters: Endpoints["GET /orgs/{org}/teams"]["parameters"]; parameters: Endpoints["GET /orgs/{org}/teams"]["parameters"];
@ -402,14 +430,14 @@ export interface PaginatingEndpoints {
response: Endpoints["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments"]["response"]; response: Endpoints["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments"]["response"];
}; };
/** /**
* @see https://docs.github.com/rest/reference/reactions/#list-reactions-for-a-team-discussion-comment * @see https://docs.github.com/rest/reference/reactions#list-reactions-for-a-team-discussion-comment
*/ */
"GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": { "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": {
parameters: Endpoints["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions"]["parameters"]; parameters: Endpoints["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions"]["parameters"];
response: Endpoints["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions"]["response"]; response: Endpoints["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions"]["response"];
}; };
/** /**
* @see https://docs.github.com/rest/reference/reactions/#list-reactions-for-a-team-discussion * @see https://docs.github.com/rest/reference/reactions#list-reactions-for-a-team-discussion
*/ */
"GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": { "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": {
parameters: Endpoints["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions"]["parameters"]; parameters: Endpoints["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions"]["parameters"];
@ -430,14 +458,14 @@ export interface PaginatingEndpoints {
response: Endpoints["GET /orgs/{org}/teams/{team_slug}/members"]["response"]; response: Endpoints["GET /orgs/{org}/teams/{team_slug}/members"]["response"];
}; };
/** /**
* @see https://docs.github.com/rest/reference/teams/#list-team-projects * @see https://docs.github.com/rest/reference/teams#list-team-projects
*/ */
"GET /orgs/{org}/teams/{team_slug}/projects": { "GET /orgs/{org}/teams/{team_slug}/projects": {
parameters: Endpoints["GET /orgs/{org}/teams/{team_slug}/projects"]["parameters"]; parameters: Endpoints["GET /orgs/{org}/teams/{team_slug}/projects"]["parameters"];
response: Endpoints["GET /orgs/{org}/teams/{team_slug}/projects"]["response"]; response: Endpoints["GET /orgs/{org}/teams/{team_slug}/projects"]["response"];
}; };
/** /**
* @see https://docs.github.com/rest/reference/teams/#list-team-repositories * @see https://docs.github.com/rest/reference/teams#list-team-repositories
*/ */
"GET /orgs/{org}/teams/{team_slug}/repos": { "GET /orgs/{org}/teams/{team_slug}/repos": {
parameters: Endpoints["GET /orgs/{org}/teams/{team_slug}/repos"]["parameters"]; parameters: Endpoints["GET /orgs/{org}/teams/{team_slug}/repos"]["parameters"];
@ -453,7 +481,7 @@ export interface PaginatingEndpoints {
}; };
}; };
/** /**
* @see https://docs.github.com/rest/reference/teams/#list-child-teams * @see https://docs.github.com/rest/reference/teams#list-child-teams
*/ */
"GET /orgs/{org}/teams/{team_slug}/teams": { "GET /orgs/{org}/teams/{team_slug}/teams": {
parameters: Endpoints["GET /orgs/{org}/teams/{team_slug}/teams"]["parameters"]; parameters: Endpoints["GET /orgs/{org}/teams/{team_slug}/teams"]["parameters"];
@ -523,6 +551,15 @@ export interface PaginatingEndpoints {
data: Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts"]["response"]["data"]["artifacts"]; data: Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts"]["response"]["data"]["artifacts"];
}; };
}; };
/**
* @see https://docs.github.com/rest/reference/actions#list-jobs-for-a-workflow-run-attempt
*/
"GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs": {
parameters: Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs"]["parameters"];
response: Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs"]["response"] & {
data: Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs"]["response"]["data"]["jobs"];
};
};
/** /**
* @see https://docs.github.com/rest/reference/actions#list-jobs-for-a-workflow-run * @see https://docs.github.com/rest/reference/actions#list-jobs-for-a-workflow-run
*/ */
@ -566,6 +603,13 @@ export interface PaginatingEndpoints {
parameters: Endpoints["GET /repos/{owner}/{repo}/assignees"]["parameters"]; parameters: Endpoints["GET /repos/{owner}/{repo}/assignees"]["parameters"];
response: Endpoints["GET /repos/{owner}/{repo}/assignees"]["response"]; response: Endpoints["GET /repos/{owner}/{repo}/assignees"]["response"];
}; };
/**
* @see https://docs.github.com/v3/repos#list-autolinks
*/
"GET /repos/{owner}/{repo}/autolinks": {
parameters: Endpoints["GET /repos/{owner}/{repo}/autolinks"]["parameters"];
response: Endpoints["GET /repos/{owner}/{repo}/autolinks"]["response"];
};
/** /**
* @see https://docs.github.com/rest/reference/repos#list-branches * @see https://docs.github.com/rest/reference/repos#list-branches
*/ */
@ -625,7 +669,7 @@ export interface PaginatingEndpoints {
response: Endpoints["GET /repos/{owner}/{repo}/comments"]["response"]; response: Endpoints["GET /repos/{owner}/{repo}/comments"]["response"];
}; };
/** /**
* @see https://docs.github.com/rest/reference/reactions/#list-reactions-for-a-commit-comment * @see https://docs.github.com/rest/reference/reactions#list-reactions-for-a-commit-comment
*/ */
"GET /repos/{owner}/{repo}/comments/{comment_id}/reactions": { "GET /repos/{owner}/{repo}/comments/{comment_id}/reactions": {
parameters: Endpoints["GET /repos/{owner}/{repo}/comments/{comment_id}/reactions"]["parameters"]; parameters: Endpoints["GET /repos/{owner}/{repo}/comments/{comment_id}/reactions"]["parameters"];
@ -685,7 +729,7 @@ export interface PaginatingEndpoints {
response: Endpoints["GET /repos/{owner}/{repo}/commits/{ref}/statuses"]["response"]; response: Endpoints["GET /repos/{owner}/{repo}/commits/{ref}/statuses"]["response"];
}; };
/** /**
* @see https://docs.github.com/rest/reference/repos/#list-repository-contributors * @see https://docs.github.com/rest/reference/repos#list-repository-contributors
*/ */
"GET /repos/{owner}/{repo}/contributors": { "GET /repos/{owner}/{repo}/contributors": {
parameters: Endpoints["GET /repos/{owner}/{repo}/contributors"]["parameters"]; parameters: Endpoints["GET /repos/{owner}/{repo}/contributors"]["parameters"];
@ -733,6 +777,13 @@ export interface PaginatingEndpoints {
parameters: Endpoints["GET /repos/{owner}/{repo}/hooks"]["parameters"]; parameters: Endpoints["GET /repos/{owner}/{repo}/hooks"]["parameters"];
response: Endpoints["GET /repos/{owner}/{repo}/hooks"]["response"]; response: Endpoints["GET /repos/{owner}/{repo}/hooks"]["response"];
}; };
/**
* @see https://docs.github.com/rest/reference/repos#list-deliveries-for-a-repository-webhook
*/
"GET /repos/{owner}/{repo}/hooks/{hook_id}/deliveries": {
parameters: Endpoints["GET /repos/{owner}/{repo}/hooks/{hook_id}/deliveries"]["parameters"];
response: Endpoints["GET /repos/{owner}/{repo}/hooks/{hook_id}/deliveries"]["response"];
};
/** /**
* @see https://docs.github.com/rest/reference/repos#list-repository-invitations * @see https://docs.github.com/rest/reference/repos#list-repository-invitations
*/ */
@ -741,7 +792,7 @@ export interface PaginatingEndpoints {
response: Endpoints["GET /repos/{owner}/{repo}/invitations"]["response"]; response: Endpoints["GET /repos/{owner}/{repo}/invitations"]["response"];
}; };
/** /**
* @see https://docs.github.com/rest/reference/issues/#list-repository-issues * @see https://docs.github.com/rest/reference/issues#list-repository-issues
*/ */
"GET /repos/{owner}/{repo}/issues": { "GET /repos/{owner}/{repo}/issues": {
parameters: Endpoints["GET /repos/{owner}/{repo}/issues"]["parameters"]; parameters: Endpoints["GET /repos/{owner}/{repo}/issues"]["parameters"];
@ -755,7 +806,7 @@ export interface PaginatingEndpoints {
response: Endpoints["GET /repos/{owner}/{repo}/issues/comments"]["response"]; response: Endpoints["GET /repos/{owner}/{repo}/issues/comments"]["response"];
}; };
/** /**
* @see https://docs.github.com/rest/reference/reactions/#list-reactions-for-an-issue-comment * @see https://docs.github.com/rest/reference/reactions#list-reactions-for-an-issue-comment
*/ */
"GET /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions": { "GET /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions": {
parameters: Endpoints["GET /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions"]["parameters"]; parameters: Endpoints["GET /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions"]["parameters"];
@ -790,7 +841,7 @@ export interface PaginatingEndpoints {
response: Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}/labels"]["response"]; response: Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}/labels"]["response"];
}; };
/** /**
* @see https://docs.github.com/rest/reference/reactions/#list-reactions-for-an-issue * @see https://docs.github.com/rest/reference/reactions#list-reactions-for-an-issue
*/ */
"GET /repos/{owner}/{repo}/issues/{issue_number}/reactions": { "GET /repos/{owner}/{repo}/issues/{issue_number}/reactions": {
parameters: Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}/reactions"]["parameters"]; parameters: Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}/reactions"]["parameters"];
@ -846,14 +897,14 @@ export interface PaginatingEndpoints {
response: Endpoints["GET /repos/{owner}/{repo}/pages/builds"]["response"]; response: Endpoints["GET /repos/{owner}/{repo}/pages/builds"]["response"];
}; };
/** /**
* @see https://docs.github.com/rest/reference/projects/#list-repository-projects * @see https://docs.github.com/rest/reference/projects#list-repository-projects
*/ */
"GET /repos/{owner}/{repo}/projects": { "GET /repos/{owner}/{repo}/projects": {
parameters: Endpoints["GET /repos/{owner}/{repo}/projects"]["parameters"]; parameters: Endpoints["GET /repos/{owner}/{repo}/projects"]["parameters"];
response: Endpoints["GET /repos/{owner}/{repo}/projects"]["response"]; response: Endpoints["GET /repos/{owner}/{repo}/projects"]["response"];
}; };
/** /**
* @see https://docs.github.com/rest/reference/pulls/#list-pull-requests * @see https://docs.github.com/rest/reference/pulls#list-pull-requests
*/ */
"GET /repos/{owner}/{repo}/pulls": { "GET /repos/{owner}/{repo}/pulls": {
parameters: Endpoints["GET /repos/{owner}/{repo}/pulls"]["parameters"]; parameters: Endpoints["GET /repos/{owner}/{repo}/pulls"]["parameters"];
@ -867,7 +918,7 @@ export interface PaginatingEndpoints {
response: Endpoints["GET /repos/{owner}/{repo}/pulls/comments"]["response"]; response: Endpoints["GET /repos/{owner}/{repo}/pulls/comments"]["response"];
}; };
/** /**
* @see https://docs.github.com/rest/reference/reactions/#list-reactions-for-a-pull-request-review-comment * @see https://docs.github.com/rest/reference/reactions#list-reactions-for-a-pull-request-review-comment
*/ */
"GET /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": { "GET /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": {
parameters: Endpoints["GET /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions"]["parameters"]; parameters: Endpoints["GET /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions"]["parameters"];
@ -881,14 +932,14 @@ export interface PaginatingEndpoints {
response: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/comments"]["response"]; response: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/comments"]["response"];
}; };
/** /**
* @see https://docs.github.com/rest/reference/pulls/#list-commits-on-a-pull-request * @see https://docs.github.com/rest/reference/pulls#list-commits-on-a-pull-request
*/ */
"GET /repos/{owner}/{repo}/pulls/{pull_number}/commits": { "GET /repos/{owner}/{repo}/pulls/{pull_number}/commits": {
parameters: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/commits"]["parameters"]; parameters: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/commits"]["parameters"];
response: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/commits"]["response"]; response: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/commits"]["response"];
}; };
/** /**
* @see https://docs.github.com/rest/reference/pulls/#list-pull-requests-files * @see https://docs.github.com/rest/reference/pulls#list-pull-requests-files
*/ */
"GET /repos/{owner}/{repo}/pulls/{pull_number}/files": { "GET /repos/{owner}/{repo}/pulls/{pull_number}/files": {
parameters: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/files"]["parameters"]; parameters: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/files"]["parameters"];
@ -953,21 +1004,21 @@ export interface PaginatingEndpoints {
response: Endpoints["GET /repos/{owner}/{repo}/subscribers"]["response"]; response: Endpoints["GET /repos/{owner}/{repo}/subscribers"]["response"];
}; };
/** /**
* @see https://docs.github.com/rest/reference/repos/#list-repository-tags * @see https://docs.github.com/rest/reference/repos#list-repository-tags
*/ */
"GET /repos/{owner}/{repo}/tags": { "GET /repos/{owner}/{repo}/tags": {
parameters: Endpoints["GET /repos/{owner}/{repo}/tags"]["parameters"]; parameters: Endpoints["GET /repos/{owner}/{repo}/tags"]["parameters"];
response: Endpoints["GET /repos/{owner}/{repo}/tags"]["response"]; response: Endpoints["GET /repos/{owner}/{repo}/tags"]["response"];
}; };
/** /**
* @see https://docs.github.com/rest/reference/repos/#list-repository-teams * @see https://docs.github.com/rest/reference/repos#list-repository-teams
*/ */
"GET /repos/{owner}/{repo}/teams": { "GET /repos/{owner}/{repo}/teams": {
parameters: Endpoints["GET /repos/{owner}/{repo}/teams"]["parameters"]; parameters: Endpoints["GET /repos/{owner}/{repo}/teams"]["parameters"];
response: Endpoints["GET /repos/{owner}/{repo}/teams"]["response"]; response: Endpoints["GET /repos/{owner}/{repo}/teams"]["response"];
}; };
/** /**
* @see https://docs.github.com/rest/reference/repos/#list-public-repositories * @see https://docs.github.com/rest/reference/repos#list-public-repositories
*/ */
"GET /repositories": { "GET /repositories": {
parameters: Endpoints["GET /repositories"]["parameters"]; parameters: Endpoints["GET /repositories"]["parameters"];
@ -1001,7 +1052,7 @@ export interface PaginatingEndpoints {
}; };
}; };
/** /**
* @see https://docs.github.com/rest/reference/scim/#list-scim-provisioned-identities * @see https://docs.github.com/rest/reference/scim#list-scim-provisioned-identities
*/ */
"GET /scim/v2/organizations/{org}/Users": { "GET /scim/v2/organizations/{org}/Users": {
parameters: Endpoints["GET /scim/v2/organizations/{org}/Users"]["parameters"]; parameters: Endpoints["GET /scim/v2/organizations/{org}/Users"]["parameters"];
@ -1010,7 +1061,7 @@ export interface PaginatingEndpoints {
}; };
}; };
/** /**
* @see https://docs.github.com/rest/reference/search/#search-code * @see https://docs.github.com/rest/reference/search#search-code
*/ */
"GET /search/code": { "GET /search/code": {
parameters: Endpoints["GET /search/code"]["parameters"]; parameters: Endpoints["GET /search/code"]["parameters"];
@ -1019,7 +1070,7 @@ export interface PaginatingEndpoints {
}; };
}; };
/** /**
* @see https://docs.github.com/rest/reference/search/#search-commits * @see https://docs.github.com/rest/reference/search#search-commits
*/ */
"GET /search/commits": { "GET /search/commits": {
parameters: Endpoints["GET /search/commits"]["parameters"]; parameters: Endpoints["GET /search/commits"]["parameters"];
@ -1028,7 +1079,7 @@ export interface PaginatingEndpoints {
}; };
}; };
/** /**
* @see https://docs.github.com/rest/reference/search/#search-issues-and-pull-requests * @see https://docs.github.com/rest/reference/search#search-issues-and-pull-requests
*/ */
"GET /search/issues": { "GET /search/issues": {
parameters: Endpoints["GET /search/issues"]["parameters"]; parameters: Endpoints["GET /search/issues"]["parameters"];
@ -1037,7 +1088,7 @@ export interface PaginatingEndpoints {
}; };
}; };
/** /**
* @see https://docs.github.com/rest/reference/search/#search-labels * @see https://docs.github.com/rest/reference/search#search-labels
*/ */
"GET /search/labels": { "GET /search/labels": {
parameters: Endpoints["GET /search/labels"]["parameters"]; parameters: Endpoints["GET /search/labels"]["parameters"];
@ -1046,7 +1097,7 @@ export interface PaginatingEndpoints {
}; };
}; };
/** /**
* @see https://docs.github.com/rest/reference/search/#search-repositories * @see https://docs.github.com/rest/reference/search#search-repositories
*/ */
"GET /search/repositories": { "GET /search/repositories": {
parameters: Endpoints["GET /search/repositories"]["parameters"]; parameters: Endpoints["GET /search/repositories"]["parameters"];
@ -1055,7 +1106,7 @@ export interface PaginatingEndpoints {
}; };
}; };
/** /**
* @see https://docs.github.com/rest/reference/search/#search-topics * @see https://docs.github.com/rest/reference/search#search-topics
*/ */
"GET /search/topics": { "GET /search/topics": {
parameters: Endpoints["GET /search/topics"]["parameters"]; parameters: Endpoints["GET /search/topics"]["parameters"];
@ -1064,7 +1115,7 @@ export interface PaginatingEndpoints {
}; };
}; };
/** /**
* @see https://docs.github.com/rest/reference/search/#search-users * @see https://docs.github.com/rest/reference/search#search-users
*/ */
"GET /search/users": { "GET /search/users": {
parameters: Endpoints["GET /search/users"]["parameters"]; parameters: Endpoints["GET /search/users"]["parameters"];
@ -1198,7 +1249,7 @@ export interface PaginatingEndpoints {
}; };
}; };
/** /**
* @see https://docs.github.com/rest/reference/issues/#list-user-account-issues-assigned-to-the-authenticated-user * @see https://docs.github.com/rest/reference/issues#list-user-account-issues-assigned-to-the-authenticated-user
*/ */
"GET /user/issues": { "GET /user/issues": {
parameters: Endpoints["GET /user/issues"]["parameters"]; parameters: Endpoints["GET /user/issues"]["parameters"];
@ -1247,12 +1298,19 @@ export interface PaginatingEndpoints {
response: Endpoints["GET /user/migrations/{migration_id}/repositories"]["response"]; response: Endpoints["GET /user/migrations/{migration_id}/repositories"]["response"];
}; };
/** /**
* @see https://docs.github.com/rest/reference/orgs/#list-organizations-for-the-authenticated-user * @see https://docs.github.com/rest/reference/orgs#list-organizations-for-the-authenticated-user
*/ */
"GET /user/orgs": { "GET /user/orgs": {
parameters: Endpoints["GET /user/orgs"]["parameters"]; parameters: Endpoints["GET /user/orgs"]["parameters"];
response: Endpoints["GET /user/orgs"]["response"]; response: Endpoints["GET /user/orgs"]["response"];
}; };
/**
* @see https://docs.github.com/rest/reference/packages#list-packages-for-the-authenticated-user
*/
"GET /user/packages": {
parameters: Endpoints["GET /user/packages"]["parameters"];
response: Endpoints["GET /user/packages"]["response"];
};
/** /**
* @see https://docs.github.com/rest/reference/users#list-public-email-addresses-for-the-authenticated-user * @see https://docs.github.com/rest/reference/users#list-public-email-addresses-for-the-authenticated-user
*/ */
@ -1261,7 +1319,7 @@ export interface PaginatingEndpoints {
response: Endpoints["GET /user/public_emails"]["response"]; response: Endpoints["GET /user/public_emails"]["response"];
}; };
/** /**
* @see https://docs.github.com/rest/reference/repos/#list-repositories-for-the-authenticated-user * @see https://docs.github.com/rest/reference/repos#list-repositories-for-the-authenticated-user
*/ */
"GET /user/repos": { "GET /user/repos": {
parameters: Endpoints["GET /user/repos"]["parameters"]; parameters: Endpoints["GET /user/repos"]["parameters"];
@ -1289,14 +1347,14 @@ export interface PaginatingEndpoints {
response: Endpoints["GET /user/subscriptions"]["response"]; response: Endpoints["GET /user/subscriptions"]["response"];
}; };
/** /**
* @see https://docs.github.com/rest/reference/teams/#list-teams-for-the-authenticated-user * @see https://docs.github.com/rest/reference/teams#list-teams-for-the-authenticated-user
*/ */
"GET /user/teams": { "GET /user/teams": {
parameters: Endpoints["GET /user/teams"]["parameters"]; parameters: Endpoints["GET /user/teams"]["parameters"];
response: Endpoints["GET /user/teams"]["response"]; response: Endpoints["GET /user/teams"]["response"];
}; };
/** /**
* @see https://docs.github.com/rest/reference/users/#list-users * @see https://docs.github.com/rest/reference/users#list-users
*/ */
"GET /users": { "GET /users": {
parameters: Endpoints["GET /users"]["parameters"]; parameters: Endpoints["GET /users"]["parameters"];
@ -1338,7 +1396,7 @@ export interface PaginatingEndpoints {
response: Endpoints["GET /users/{username}/following"]["response"]; response: Endpoints["GET /users/{username}/following"]["response"];
}; };
/** /**
* @see https://docs.github.com/rest/reference/gists/#list-gists-for-a-user * @see https://docs.github.com/rest/reference/gists#list-gists-for-a-user
*/ */
"GET /users/{username}/gists": { "GET /users/{username}/gists": {
parameters: Endpoints["GET /users/{username}/gists"]["parameters"]; parameters: Endpoints["GET /users/{username}/gists"]["parameters"];
@ -1359,14 +1417,21 @@ export interface PaginatingEndpoints {
response: Endpoints["GET /users/{username}/keys"]["response"]; response: Endpoints["GET /users/{username}/keys"]["response"];
}; };
/** /**
* @see https://docs.github.com/rest/reference/orgs/#list-organizations-for-a-user * @see https://docs.github.com/rest/reference/orgs#list-organizations-for-a-user
*/ */
"GET /users/{username}/orgs": { "GET /users/{username}/orgs": {
parameters: Endpoints["GET /users/{username}/orgs"]["parameters"]; parameters: Endpoints["GET /users/{username}/orgs"]["parameters"];
response: Endpoints["GET /users/{username}/orgs"]["response"]; response: Endpoints["GET /users/{username}/orgs"]["response"];
}; };
/** /**
* @see https://docs.github.com/rest/reference/projects/#list-user-projects * @see https://docs.github.com/rest/reference/packages#list-packages-for-user
*/
"GET /users/{username}/packages": {
parameters: Endpoints["GET /users/{username}/packages"]["parameters"];
response: Endpoints["GET /users/{username}/packages"]["response"];
};
/**
* @see https://docs.github.com/rest/reference/projects#list-user-projects
*/ */
"GET /users/{username}/projects": { "GET /users/{username}/projects": {
parameters: Endpoints["GET /users/{username}/projects"]["parameters"]; parameters: Endpoints["GET /users/{username}/projects"]["parameters"];
@ -1387,7 +1452,7 @@ export interface PaginatingEndpoints {
response: Endpoints["GET /users/{username}/received_events/public"]["response"]; response: Endpoints["GET /users/{username}/received_events/public"]["response"];
}; };
/** /**
* @see https://docs.github.com/rest/reference/repos/#list-repositories-for-a-user * @see https://docs.github.com/rest/reference/repos#list-repositories-for-a-user
*/ */
"GET /users/{username}/repos": { "GET /users/{username}/repos": {
parameters: Endpoints["GET /users/{username}/repos"]["parameters"]; parameters: Endpoints["GET /users/{username}/repos"]["parameters"];

View File

@ -8,6 +8,13 @@ export declare function iterator(octokit: Octokit, route: Route | RequestInterfa
} | { } | {
value: import("@octokit/types/dist-types/OctokitResponse").OctokitResponse<any, number>; value: import("@octokit/types/dist-types/OctokitResponse").OctokitResponse<any, number>;
done?: undefined; done?: undefined;
} | {
value: {
status: number;
headers: {};
data: never[];
};
done?: undefined;
}>; }>;
}; };
}; };

View File

@ -21,8 +21,8 @@ declare type NormalizeResponse<T> = T & {
data: GetResultsType<T>; data: GetResultsType<T>;
}; };
declare type DataType<T> = "data" extends keyof T ? T["data"] : unknown; declare type DataType<T> = "data" extends keyof T ? T["data"] : unknown;
export interface MapFunction<T = OctokitTypes.OctokitResponse<PaginationResults<unknown>>, R = unknown[]> { export interface MapFunction<T = OctokitTypes.OctokitResponse<PaginationResults<unknown>>, M = unknown[]> {
(response: T, done: () => void): R; (response: T, done: () => void): M;
} }
export declare type PaginationResults<T = unknown> = T[]; export declare type PaginationResults<T = unknown> = T[];
export interface PaginateInterface { export interface PaginateInterface {
@ -32,7 +32,7 @@ export interface PaginateInterface {
* @param {object} options Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. * @param {object} options Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`.
* @param {function} mapFn Optional method to map each response to a custom array * @param {function} mapFn Optional method to map each response to a custom array
*/ */
<T, R>(options: OctokitTypes.EndpointOptions, mapFn: MapFunction<OctokitTypes.OctokitResponse<PaginationResults<T>>, R[]>): Promise<PaginationResults<R>>; <T, M>(options: OctokitTypes.EndpointOptions, mapFn: MapFunction<OctokitTypes.OctokitResponse<PaginationResults<T>>, M[]>): Promise<PaginationResults<M>>;
/** /**
* Paginate a request using endpoint options * Paginate a request using endpoint options
* *
@ -45,7 +45,7 @@ export interface PaginateInterface {
* @param {string} route Request method + URL. Example: `'GET /orgs/{org}'` * @param {string} route Request method + URL. Example: `'GET /orgs/{org}'`
* @param {function} mapFn Optional method to map each response to a custom array * @param {function} mapFn Optional method to map each response to a custom array
*/ */
<R extends keyof PaginatingEndpoints, MR extends unknown[]>(route: R, mapFn: MapFunction<PaginatingEndpoints[R]["response"], MR>): Promise<MR>; <R extends keyof PaginatingEndpoints, M extends unknown[]>(route: R, mapFn: MapFunction<PaginatingEndpoints[R]["response"], M>): Promise<M>;
/** /**
* Paginate a request using a known endpoint route string and parameters, and map each response to a custom array * Paginate a request using a known endpoint route string and parameters, and map each response to a custom array
* *
@ -53,7 +53,7 @@ export interface PaginateInterface {
* @param {object} parameters URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. * @param {object} parameters URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`.
* @param {function} mapFn Optional method to map each response to a custom array * @param {function} mapFn Optional method to map each response to a custom array
*/ */
<R extends keyof PaginatingEndpoints, MR extends unknown[]>(route: R, parameters: PaginatingEndpoints[R]["parameters"], mapFn: MapFunction<PaginatingEndpoints[R]["response"], MR>): Promise<MR>; <R extends keyof PaginatingEndpoints, M extends unknown[]>(route: R, parameters: PaginatingEndpoints[R]["parameters"], mapFn: MapFunction<PaginatingEndpoints[R]["response"], M>): Promise<M>;
/** /**
* Paginate a request using an known endpoint route string * Paginate a request using an known endpoint route string
* *
@ -74,7 +74,7 @@ export interface PaginateInterface {
* @param {string} request Request method (`octokit.request` or `@octokit/request`) * @param {string} request Request method (`octokit.request` or `@octokit/request`)
* @param {function} mapFn? Optional method to map each response to a custom array * @param {function} mapFn? Optional method to map each response to a custom array
*/ */
<R extends OctokitTypes.RequestInterface, MR extends unknown[]>(request: R, mapFn: MapFunction<NormalizeResponse<OctokitTypes.GetResponseTypeFromEndpointMethod<R>>, MR>): Promise<MR>; <R extends OctokitTypes.RequestInterface, M extends unknown[]>(request: R, mapFn: MapFunction<NormalizeResponse<OctokitTypes.GetResponseTypeFromEndpointMethod<R>>, M>): Promise<M>;
/** /**
* Paginate a request using an endpoint method, parameters, and a map function * Paginate a request using an endpoint method, parameters, and a map function
* *
@ -82,7 +82,7 @@ export interface PaginateInterface {
* @param {object} parameters URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. * @param {object} parameters URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`.
* @param {function} mapFn? Optional method to map each response to a custom array * @param {function} mapFn? Optional method to map each response to a custom array
*/ */
<R extends OctokitTypes.RequestInterface, MR extends unknown[]>(request: R, parameters: Parameters<R>[0], mapFn: MapFunction<NormalizeResponse<OctokitTypes.GetResponseTypeFromEndpointMethod<R>>, MR>): Promise<MR>; <R extends OctokitTypes.RequestInterface, M extends unknown[]>(request: R, parameters: Parameters<R>[0], mapFn: MapFunction<NormalizeResponse<OctokitTypes.GetResponseTypeFromEndpointMethod<R>>, M>): Promise<M>;
/** /**
* Paginate a request using an endpoint method and parameters * Paginate a request using an endpoint method and parameters
* *
@ -132,7 +132,7 @@ export interface ComposePaginateInterface {
* @param {object} options Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. * @param {object} options Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`.
* @param {function} mapFn Optional method to map each response to a custom array * @param {function} mapFn Optional method to map each response to a custom array
*/ */
<T, R>(octokit: Octokit, options: OctokitTypes.EndpointOptions, mapFn: MapFunction<OctokitTypes.OctokitResponse<PaginationResults<T>>, R[]>): Promise<PaginationResults<R>>; <T, M>(octokit: Octokit, options: OctokitTypes.EndpointOptions, mapFn: MapFunction<OctokitTypes.OctokitResponse<PaginationResults<T>>, M[]>): Promise<PaginationResults<M>>;
/** /**
* Paginate a request using endpoint options * Paginate a request using endpoint options
* *
@ -147,7 +147,7 @@ export interface ComposePaginateInterface {
* @param {string} route Request method + URL. Example: `'GET /orgs/{org}'` * @param {string} route Request method + URL. Example: `'GET /orgs/{org}'`
* @param {function} mapFn Optional method to map each response to a custom array * @param {function} mapFn Optional method to map each response to a custom array
*/ */
<R extends keyof PaginatingEndpoints, MR extends unknown[]>(octokit: Octokit, route: R, mapFn: MapFunction<PaginatingEndpoints[R]["response"], MR>): Promise<MR>; <R extends keyof PaginatingEndpoints, M extends unknown[]>(octokit: Octokit, route: R, mapFn: MapFunction<PaginatingEndpoints[R]["response"], M>): Promise<M>;
/** /**
* Paginate a request using a known endpoint route string and parameters, and map each response to a custom array * Paginate a request using a known endpoint route string and parameters, and map each response to a custom array
* *
@ -156,7 +156,7 @@ export interface ComposePaginateInterface {
* @param {object} parameters URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. * @param {object} parameters URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`.
* @param {function} mapFn Optional method to map each response to a custom array * @param {function} mapFn Optional method to map each response to a custom array
*/ */
<R extends keyof PaginatingEndpoints, MR extends unknown[]>(octokit: Octokit, route: R, parameters: PaginatingEndpoints[R]["parameters"], mapFn: MapFunction<PaginatingEndpoints[R]["response"], MR>): Promise<MR>; <R extends keyof PaginatingEndpoints, M extends unknown[]>(octokit: Octokit, route: R, parameters: PaginatingEndpoints[R]["parameters"], mapFn: MapFunction<PaginatingEndpoints[R]["response"], M>): Promise<M>;
/** /**
* Paginate a request using an known endpoint route string * Paginate a request using an known endpoint route string
* *
@ -180,7 +180,7 @@ export interface ComposePaginateInterface {
* @param {string} request Request method (`octokit.request` or `@octokit/request`) * @param {string} request Request method (`octokit.request` or `@octokit/request`)
* @param {function} mapFn? Optional method to map each response to a custom array * @param {function} mapFn? Optional method to map each response to a custom array
*/ */
<R extends OctokitTypes.RequestInterface, MR extends unknown[]>(octokit: Octokit, request: R, mapFn: MapFunction<NormalizeResponse<OctokitTypes.GetResponseTypeFromEndpointMethod<R>>, MR>): Promise<MR>; <R extends OctokitTypes.RequestInterface, M extends unknown[]>(octokit: Octokit, request: R, mapFn: MapFunction<NormalizeResponse<OctokitTypes.GetResponseTypeFromEndpointMethod<R>>, M>): Promise<M>;
/** /**
* Paginate a request using an endpoint method, parameters, and a map function * Paginate a request using an endpoint method, parameters, and a map function
* *
@ -189,7 +189,7 @@ export interface ComposePaginateInterface {
* @param {object} parameters URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. * @param {object} parameters URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`.
* @param {function} mapFn? Optional method to map each response to a custom array * @param {function} mapFn? Optional method to map each response to a custom array
*/ */
<R extends OctokitTypes.RequestInterface, MR extends unknown[]>(octokit: Octokit, request: R, parameters: Parameters<R>[0], mapFn: MapFunction<NormalizeResponse<OctokitTypes.GetResponseTypeFromEndpointMethod<R>>, MR>): Promise<MR>; <R extends OctokitTypes.RequestInterface, M extends unknown[]>(octokit: Octokit, request: R, parameters: Parameters<R>[0], mapFn: MapFunction<NormalizeResponse<OctokitTypes.GetResponseTypeFromEndpointMethod<R>>, M>): Promise<M>;
/** /**
* Paginate a request using an endpoint method and parameters * Paginate a request using an endpoint method and parameters
* *

View File

@ -1 +1 @@
export declare const VERSION = "2.13.3"; export declare const VERSION = "2.17.0";

View File

@ -1,4 +1,4 @@
const VERSION = "2.13.3"; const VERSION = "2.17.0";
/** /**
* Some list response that can be paginated have a different response structure * Some list response that can be paginated have a different response structure
@ -17,6 +17,13 @@ const VERSION = "2.13.3";
* otherwise match: https://developer.github.com/v3/repos/statuses/#get-the-combined-status-for-a-specific-ref * otherwise match: https://developer.github.com/v3/repos/statuses/#get-the-combined-status-for-a-specific-ref
*/ */
function normalizePaginatedListResponse(response) { function normalizePaginatedListResponse(response) {
// endpoints can respond with 204 if repository is empty
if (!response.data) {
return {
...response,
data: [],
};
}
const responseNeedsNormalization = "total_count" in response.data && !("url" in response.data); const responseNeedsNormalization = "total_count" in response.data && !("url" in response.data);
if (!responseNeedsNormalization) if (!responseNeedsNormalization)
return response; return response;
@ -54,6 +61,7 @@ function iterator(octokit, route, parameters) {
async next() { async next() {
if (!url) if (!url)
return { done: true }; return { done: true };
try {
const response = await requestMethod({ method, url, headers }); const response = await requestMethod({ method, url, headers });
const normalizedResponse = normalizePaginatedListResponse(response); const normalizedResponse = normalizePaginatedListResponse(response);
// `response.headers.link` format: // `response.headers.link` format:
@ -61,6 +69,19 @@ function iterator(octokit, route, parameters) {
// sets `url` to undefined if "next" URL is not present or `link` header is not set // sets `url` to undefined if "next" URL is not present or `link` header is not set
url = ((normalizedResponse.headers.link || "").match(/<([^>]+)>;\s*rel="next"/) || [])[1]; url = ((normalizedResponse.headers.link || "").match(/<([^>]+)>;\s*rel="next"/) || [])[1];
return { value: normalizedResponse }; return { value: normalizedResponse };
}
catch (error) {
if (error.status !== 409)
throw error;
url = "";
return {
value: {
status: 200,
headers: {},
data: [],
},
};
}
}, },
}), }),
}; };
@ -95,6 +116,7 @@ const composePaginateRest = Object.assign(paginate, {
}); });
const paginatingEndpoints = [ const paginatingEndpoints = [
"GET /app/hook/deliveries",
"GET /app/installations", "GET /app/installations",
"GET /applications/grants", "GET /applications/grants",
"GET /authorizations", "GET /authorizations",
@ -133,6 +155,7 @@ const paginatingEndpoints = [
"GET /orgs/{org}/events", "GET /orgs/{org}/events",
"GET /orgs/{org}/failed_invitations", "GET /orgs/{org}/failed_invitations",
"GET /orgs/{org}/hooks", "GET /orgs/{org}/hooks",
"GET /orgs/{org}/hooks/{hook_id}/deliveries",
"GET /orgs/{org}/installations", "GET /orgs/{org}/installations",
"GET /orgs/{org}/invitations", "GET /orgs/{org}/invitations",
"GET /orgs/{org}/invitations/{invitation_id}/teams", "GET /orgs/{org}/invitations/{invitation_id}/teams",
@ -141,9 +164,11 @@ const paginatingEndpoints = [
"GET /orgs/{org}/migrations", "GET /orgs/{org}/migrations",
"GET /orgs/{org}/migrations/{migration_id}/repositories", "GET /orgs/{org}/migrations/{migration_id}/repositories",
"GET /orgs/{org}/outside_collaborators", "GET /orgs/{org}/outside_collaborators",
"GET /orgs/{org}/packages",
"GET /orgs/{org}/projects", "GET /orgs/{org}/projects",
"GET /orgs/{org}/public_members", "GET /orgs/{org}/public_members",
"GET /orgs/{org}/repos", "GET /orgs/{org}/repos",
"GET /orgs/{org}/secret-scanning/alerts",
"GET /orgs/{org}/team-sync/groups", "GET /orgs/{org}/team-sync/groups",
"GET /orgs/{org}/teams", "GET /orgs/{org}/teams",
"GET /orgs/{org}/teams/{team_slug}/discussions", "GET /orgs/{org}/teams/{team_slug}/discussions",
@ -164,11 +189,13 @@ const paginatingEndpoints = [
"GET /repos/{owner}/{repo}/actions/runners/downloads", "GET /repos/{owner}/{repo}/actions/runners/downloads",
"GET /repos/{owner}/{repo}/actions/runs", "GET /repos/{owner}/{repo}/actions/runs",
"GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts", "GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts",
"GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs",
"GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs", "GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs",
"GET /repos/{owner}/{repo}/actions/secrets", "GET /repos/{owner}/{repo}/actions/secrets",
"GET /repos/{owner}/{repo}/actions/workflows", "GET /repos/{owner}/{repo}/actions/workflows",
"GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs", "GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs",
"GET /repos/{owner}/{repo}/assignees", "GET /repos/{owner}/{repo}/assignees",
"GET /repos/{owner}/{repo}/autolinks",
"GET /repos/{owner}/{repo}/branches", "GET /repos/{owner}/{repo}/branches",
"GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations", "GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations",
"GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs", "GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs",
@ -192,6 +219,7 @@ const paginatingEndpoints = [
"GET /repos/{owner}/{repo}/forks", "GET /repos/{owner}/{repo}/forks",
"GET /repos/{owner}/{repo}/git/matching-refs/{ref}", "GET /repos/{owner}/{repo}/git/matching-refs/{ref}",
"GET /repos/{owner}/{repo}/hooks", "GET /repos/{owner}/{repo}/hooks",
"GET /repos/{owner}/{repo}/hooks/{hook_id}/deliveries",
"GET /repos/{owner}/{repo}/invitations", "GET /repos/{owner}/{repo}/invitations",
"GET /repos/{owner}/{repo}/issues", "GET /repos/{owner}/{repo}/issues",
"GET /repos/{owner}/{repo}/issues/comments", "GET /repos/{owner}/{repo}/issues/comments",
@ -262,6 +290,7 @@ const paginatingEndpoints = [
"GET /user/migrations", "GET /user/migrations",
"GET /user/migrations/{migration_id}/repositories", "GET /user/migrations/{migration_id}/repositories",
"GET /user/orgs", "GET /user/orgs",
"GET /user/packages",
"GET /user/public_emails", "GET /user/public_emails",
"GET /user/repos", "GET /user/repos",
"GET /user/repository_invitations", "GET /user/repository_invitations",
@ -278,6 +307,7 @@ const paginatingEndpoints = [
"GET /users/{username}/gpg_keys", "GET /users/{username}/gpg_keys",
"GET /users/{username}/keys", "GET /users/{username}/keys",
"GET /users/{username}/orgs", "GET /users/{username}/orgs",
"GET /users/{username}/packages",
"GET /users/{username}/projects", "GET /users/{username}/projects",
"GET /users/{username}/received_events", "GET /users/{username}/received_events",
"GET /users/{username}/received_events/public", "GET /users/{username}/received_events/public",

File diff suppressed because one or more lines are too long

View File

@ -0,0 +1,7 @@
Copyright 2020 Gregor Martynus
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

View File

@ -0,0 +1,17 @@
# @octokit/openapi-types
> Generated TypeScript definitions based on GitHub's OpenAPI spec
This package is continously updated based on [GitHub's OpenAPI specification](https://github.com/github/rest-api-description/)
## Usage
```ts
import { components } from "@octokit/openapi-types";
type Repository = components["schemas"]["full-repository"];
```
## License
[MIT](LICENSE)

View File

@ -0,0 +1,20 @@
{
"name": "@octokit/openapi-types",
"description": "Generated TypeScript definitions based on GitHub's OpenAPI spec for api.github.com",
"repository": {
"type": "git",
"url": "https://github.com/octokit/openapi-types.ts.git",
"directory": "packages/openapi-types"
},
"publishConfig": {
"access": "public"
},
"version": "11.2.0",
"main": "",
"types": "types.d.ts",
"author": "Gregor Martynus (https://twitter.com/gr2m)",
"license": "MIT",
"octokit": {
"openapi-version": "5.9.0"
}
}

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,7 @@
MIT License Copyright (c) 2019 Octokit contributors
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

View File

@ -0,0 +1,65 @@
# types.ts
> Shared TypeScript definitions for Octokit projects
[![@latest](https://img.shields.io/npm/v/@octokit/types.svg)](https://www.npmjs.com/package/@octokit/types)
[![Build Status](https://github.com/octokit/types.ts/workflows/Test/badge.svg)](https://github.com/octokit/types.ts/actions?workflow=Test)
<!-- toc -->
- [Usage](#usage)
- [Examples](#examples)
- [Get parameter and response data types for a REST API endpoint](#get-parameter-and-response-data-types-for-a-rest-api-endpoint)
- [Get response types from endpoint methods](#get-response-types-from-endpoint-methods)
- [Contributing](#contributing)
- [License](#license)
<!-- tocstop -->
## Usage
See all exported types at https://octokit.github.io/types.ts
## Examples
### Get parameter and response data types for a REST API endpoint
```ts
import { Endpoints } from "@octokit/types";
type listUserReposParameters =
Endpoints["GET /repos/{owner}/{repo}"]["parameters"];
type listUserReposResponse = Endpoints["GET /repos/{owner}/{repo}"]["response"];
async function listRepos(
options: listUserReposParameters
): listUserReposResponse["data"] {
// ...
}
```
### Get response types from endpoint methods
```ts
import {
GetResponseTypeFromEndpointMethod,
GetResponseDataTypeFromEndpointMethod,
} from "@octokit/types";
import { Octokit } from "@octokit/rest";
const octokit = new Octokit();
type CreateLabelResponseType = GetResponseTypeFromEndpointMethod<
typeof octokit.issues.createLabel
>;
type CreateLabelResponseDataType = GetResponseDataTypeFromEndpointMethod<
typeof octokit.issues.createLabel
>;
```
## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md)
## License
[MIT](LICENSE)

View File

@ -0,0 +1,8 @@
'use strict';
Object.defineProperty(exports, '__esModule', { value: true });
const VERSION = "6.34.0";
exports.VERSION = VERSION;
//# sourceMappingURL=index.js.map

View File

@ -0,0 +1 @@
{"version":3,"file":"index.js","sources":["../dist-src/VERSION.js"],"sourcesContent":["export const VERSION = \"0.0.0-development\";\n"],"names":["VERSION"],"mappings":";;;;MAAaA,OAAO,GAAG;;;;"}

View File

@ -0,0 +1 @@
export {};

View File

@ -0,0 +1 @@
export {};

View File

@ -0,0 +1 @@
export {};

View File

@ -0,0 +1 @@
export {};

View File

@ -0,0 +1 @@
export {};

View File

@ -0,0 +1 @@
export {};

View File

@ -0,0 +1 @@
export {};

View File

@ -0,0 +1 @@
export {};

View File

@ -0,0 +1 @@
export {};

View File

@ -0,0 +1 @@
export {};

View File

@ -0,0 +1 @@
export {};

View File

@ -0,0 +1 @@
export {};

View File

@ -0,0 +1 @@
export {};

View File

@ -0,0 +1 @@
export {};

View File

@ -0,0 +1 @@
export {};

View File

@ -0,0 +1 @@
export {};

View File

@ -0,0 +1 @@
export {};

View File

@ -0,0 +1 @@
export {};

View File

@ -0,0 +1 @@
export const VERSION = "6.34.0";

View File

@ -0,0 +1 @@
export {};

View File

@ -0,0 +1,21 @@
export * from "./AuthInterface";
export * from "./EndpointDefaults";
export * from "./EndpointInterface";
export * from "./EndpointOptions";
export * from "./Fetch";
export * from "./OctokitResponse";
export * from "./RequestError";
export * from "./RequestHeaders";
export * from "./RequestInterface";
export * from "./RequestMethod";
export * from "./RequestOptions";
export * from "./RequestParameters";
export * from "./RequestRequestOptions";
export * from "./ResponseHeaders";
export * from "./Route";
export * from "./Signal";
export * from "./StrategyInterface";
export * from "./Url";
export * from "./VERSION";
export * from "./GetResponseTypeFromEndpointMethod";
export * from "./generated/Endpoints";

View File

@ -0,0 +1,31 @@
import { EndpointOptions } from "./EndpointOptions";
import { OctokitResponse } from "./OctokitResponse";
import { RequestInterface } from "./RequestInterface";
import { RequestParameters } from "./RequestParameters";
import { Route } from "./Route";
/**
* Interface to implement complex authentication strategies for Octokit.
* An object Implementing the AuthInterface can directly be passed as the
* `auth` option in the Octokit constructor.
*
* For the official implementations of the most common authentication
* strategies, see https://github.com/octokit/auth.js
*/
export interface AuthInterface<AuthOptions extends any[], Authentication extends any> {
(...args: AuthOptions): Promise<Authentication>;
hook: {
/**
* Sends a request using the passed `request` instance
*
* @param {object} endpoint Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`.
*/
<T = any>(request: RequestInterface, options: EndpointOptions): Promise<OctokitResponse<T>>;
/**
* Sends a request using the passed `request` instance
*
* @param {string} route Request method + URL. Example: `'GET /orgs/{org}'`
* @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`.
*/
<T = any>(request: RequestInterface, route: Route, parameters?: RequestParameters): Promise<OctokitResponse<T>>;
};
}

View File

@ -0,0 +1,21 @@
import { RequestHeaders } from "./RequestHeaders";
import { RequestMethod } from "./RequestMethod";
import { RequestParameters } from "./RequestParameters";
import { Url } from "./Url";
/**
* The `.endpoint()` method is guaranteed to set all keys defined by RequestParameters
* as well as the method property.
*/
export declare type EndpointDefaults = RequestParameters & {
baseUrl: Url;
method: RequestMethod;
url?: Url;
headers: RequestHeaders & {
accept: string;
"user-agent": string;
};
mediaType: {
format: string;
previews: string[];
};
};

View File

@ -0,0 +1,65 @@
import { EndpointDefaults } from "./EndpointDefaults";
import { RequestOptions } from "./RequestOptions";
import { RequestParameters } from "./RequestParameters";
import { Route } from "./Route";
import { Endpoints } from "./generated/Endpoints";
export interface EndpointInterface<D extends object = object> {
/**
* Transforms a GitHub REST API endpoint into generic request options
*
* @param {object} endpoint Must set `url` unless it's set defaults. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`.
*/
<O extends RequestParameters = RequestParameters>(options: O & {
method?: string;
} & ("url" extends keyof D ? {
url?: string;
} : {
url: string;
})): RequestOptions & Pick<D & O, keyof RequestOptions>;
/**
* Transforms a GitHub REST API endpoint into generic request options
*
* @param {string} route Request method + URL. Example: `'GET /orgs/{org}'`
* @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`.
*/
<R extends Route, P extends RequestParameters = R extends keyof Endpoints ? Endpoints[R]["parameters"] & RequestParameters : RequestParameters>(route: keyof Endpoints | R, parameters?: P): (R extends keyof Endpoints ? Endpoints[R]["request"] : RequestOptions) & Pick<P, keyof RequestOptions>;
/**
* Object with current default route and parameters
*/
DEFAULTS: D & EndpointDefaults;
/**
* Returns a new `endpoint` interface with new defaults
*/
defaults: <O extends RequestParameters = RequestParameters>(newDefaults: O) => EndpointInterface<D & O>;
merge: {
/**
* Merges current endpoint defaults with passed route and parameters,
* without transforming them into request options.
*
* @param {string} route Request method + URL. Example: `'GET /orgs/{org}'`
* @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`.
*
*/
<R extends Route, P extends RequestParameters = R extends keyof Endpoints ? Endpoints[R]["parameters"] & RequestParameters : RequestParameters>(route: keyof Endpoints | R, parameters?: P): D & (R extends keyof Endpoints ? Endpoints[R]["request"] & Endpoints[R]["parameters"] : EndpointDefaults) & P;
/**
* Merges current endpoint defaults with passed route and parameters,
* without transforming them into request options.
*
* @param {object} endpoint Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`.
*/
<P extends RequestParameters = RequestParameters>(options: P): EndpointDefaults & D & P;
/**
* Returns current default options.
*
* @deprecated use endpoint.DEFAULTS instead
*/
(): D & EndpointDefaults;
};
/**
* Stateless method to turn endpoint options into request options.
* Calling `endpoint(options)` is the same as calling `endpoint.parse(endpoint.merge(options))`.
*
* @param {object} options `method`, `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`.
*/
parse: <O extends EndpointDefaults = EndpointDefaults>(options: O) => RequestOptions & Pick<O, keyof RequestOptions>;
}

View File

@ -0,0 +1,7 @@
import { RequestMethod } from "./RequestMethod";
import { Url } from "./Url";
import { RequestParameters } from "./RequestParameters";
export declare type EndpointOptions = RequestParameters & {
method: RequestMethod;
url: Url;
};

View File

@ -0,0 +1,4 @@
/**
* Browser's fetch method (or compatible such as fetch-mock)
*/
export declare type Fetch = any;

View File

@ -0,0 +1,5 @@
declare type Unwrap<T> = T extends Promise<infer U> ? U : T;
declare type AnyFunction = (...args: any[]) => any;
export declare type GetResponseTypeFromEndpointMethod<T extends AnyFunction> = Unwrap<ReturnType<T>>;
export declare type GetResponseDataTypeFromEndpointMethod<T extends AnyFunction> = Unwrap<ReturnType<T>>["data"];
export {};

View File

@ -0,0 +1,17 @@
import { ResponseHeaders } from "./ResponseHeaders";
import { Url } from "./Url";
export declare type OctokitResponse<T, S extends number = number> = {
headers: ResponseHeaders;
/**
* http response code
*/
status: S;
/**
* URL of response after all redirects
*/
url: Url;
/**
* Response data as documented in the REST API reference documentation at https://docs.github.com/rest/reference
*/
data: T;
};

View File

@ -0,0 +1,11 @@
export declare type RequestError = {
name: string;
status: number;
documentation_url: string;
errors?: Array<{
resource: string;
code: string;
field: string;
message?: string;
}>;
};

View File

@ -0,0 +1,15 @@
export declare type RequestHeaders = {
/**
* Avoid setting `headers.accept`, use `mediaType.{format|previews}` option instead.
*/
accept?: string;
/**
* Use `authorization` to send authenticated request, remember `token ` / `bearer ` prefixes. Example: `token 1234567890abcdef1234567890abcdef12345678`
*/
authorization?: string;
/**
* `user-agent` is set do a default and can be overwritten as needed.
*/
"user-agent"?: string;
[header: string]: string | number | undefined;
};

View File

@ -0,0 +1,34 @@
import { EndpointInterface } from "./EndpointInterface";
import { OctokitResponse } from "./OctokitResponse";
import { RequestParameters } from "./RequestParameters";
import { Route } from "./Route";
import { Endpoints } from "./generated/Endpoints";
export interface RequestInterface<D extends object = object> {
/**
* Sends a request based on endpoint options
*
* @param {object} endpoint Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`.
*/
<T = any, O extends RequestParameters = RequestParameters>(options: O & {
method?: string;
} & ("url" extends keyof D ? {
url?: string;
} : {
url: string;
})): Promise<OctokitResponse<T>>;
/**
* Sends a request based on endpoint options
*
* @param {string} route Request method + URL. Example: `'GET /orgs/{org}'`
* @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`.
*/
<R extends Route>(route: keyof Endpoints | R, options?: R extends keyof Endpoints ? Endpoints[R]["parameters"] & RequestParameters : RequestParameters): R extends keyof Endpoints ? Promise<Endpoints[R]["response"]> : Promise<OctokitResponse<any>>;
/**
* Returns a new `request` with updated route and parameters
*/
defaults: <O extends RequestParameters = RequestParameters>(newDefaults: O) => RequestInterface<D & O>;
/**
* Octokit endpoint API, see {@link https://github.com/octokit/endpoint.js|@octokit/endpoint}
*/
endpoint: EndpointInterface<D>;
}

View File

@ -0,0 +1,4 @@
/**
* HTTP Verb supported by GitHub's REST API
*/
export declare type RequestMethod = "DELETE" | "GET" | "HEAD" | "PATCH" | "POST" | "PUT";

View File

@ -0,0 +1,14 @@
import { RequestHeaders } from "./RequestHeaders";
import { RequestMethod } from "./RequestMethod";
import { RequestRequestOptions } from "./RequestRequestOptions";
import { Url } from "./Url";
/**
* Generic request options as they are returned by the `endpoint()` method
*/
export declare type RequestOptions = {
method: RequestMethod;
url: Url;
headers: RequestHeaders;
body?: any;
request?: RequestRequestOptions;
};

View File

@ -0,0 +1,45 @@
import { RequestRequestOptions } from "./RequestRequestOptions";
import { RequestHeaders } from "./RequestHeaders";
import { Url } from "./Url";
/**
* Parameters that can be passed into `request(route, parameters)` or `endpoint(route, parameters)` methods
*/
export declare type RequestParameters = {
/**
* Base URL to be used when a relative URL is passed, such as `/orgs/{org}`.
* If `baseUrl` is `https://enterprise.acme-inc.com/api/v3`, then the request
* will be sent to `https://enterprise.acme-inc.com/api/v3/orgs/{org}`.
*/
baseUrl?: Url;
/**
* HTTP headers. Use lowercase keys.
*/
headers?: RequestHeaders;
/**
* Media type options, see {@link https://developer.github.com/v3/media/|GitHub Developer Guide}
*/
mediaType?: {
/**
* `json` by default. Can be `raw`, `text`, `html`, `full`, `diff`, `patch`, `sha`, `base64`. Depending on endpoint
*/
format?: string;
/**
* Custom media type names of {@link https://developer.github.com/v3/media/|API Previews} without the `-preview` suffix.
* Example for single preview: `['squirrel-girl']`.
* Example for multiple previews: `['squirrel-girl', 'mister-fantastic']`.
*/
previews?: string[];
};
/**
* Pass custom meta information for the request. The `request` object will be returned as is.
*/
request?: RequestRequestOptions;
/**
* Any additional parameter will be passed as follows
* 1. URL parameter if `':parameter'` or `{parameter}` is part of `url`
* 2. Query parameter if `method` is `'GET'` or `'HEAD'`
* 3. Request body if `parameter` is `'data'`
* 4. JSON in the request body in the form of `body[parameter]` unless `parameter` key is `'data'`
*/
[parameter: string]: unknown;
};

View File

@ -0,0 +1,26 @@
import { Fetch } from "./Fetch";
import { Signal } from "./Signal";
/**
* Octokit-specific request options which are ignored for the actual request, but can be used by Octokit or plugins to manipulate how the request is sent or how a response is handled
*/
export declare type RequestRequestOptions = {
/**
* Node only. Useful for custom proxy, certificate, or dns lookup.
*
* @see https://nodejs.org/api/http.html#http_class_http_agent
*/
agent?: unknown;
/**
* Custom replacement for built-in fetch method. Useful for testing or request hooks.
*/
fetch?: Fetch;
/**
* Use an `AbortController` instance to cancel a request. In node you can only cancel streamed requests.
*/
signal?: Signal;
/**
* Node only. Request/response timeout in ms, it resets on redirect. 0 to disable (OS limit applies). `options.request.signal` is recommended instead.
*/
timeout?: number;
[option: string]: any;
};

View File

@ -0,0 +1,20 @@
export declare type ResponseHeaders = {
"cache-control"?: string;
"content-length"?: number;
"content-type"?: string;
date?: string;
etag?: string;
"last-modified"?: string;
link?: string;
location?: string;
server?: string;
status?: string;
vary?: string;
"x-github-mediatype"?: string;
"x-github-request-id"?: string;
"x-oauth-scopes"?: string;
"x-ratelimit-limit"?: string;
"x-ratelimit-remaining"?: string;
"x-ratelimit-reset"?: string;
[header: string]: string | number | undefined;
};

View File

@ -0,0 +1,4 @@
/**
* String consisting of an optional HTTP method and relative path or absolute URL. Examples: `'/orgs/{org}'`, `'PUT /orgs/{org}'`, `GET https://example.com/foo/bar`
*/
export declare type Route = string;

View File

@ -0,0 +1,6 @@
/**
* Abort signal
*
* @see https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal
*/
export declare type Signal = any;

View File

@ -0,0 +1,4 @@
import { AuthInterface } from "./AuthInterface";
export interface StrategyInterface<StrategyOptions extends any[], AuthOptions extends any[], Authentication extends object> {
(...args: StrategyOptions): AuthInterface<AuthOptions, Authentication>;
}

View File

@ -0,0 +1,4 @@
/**
* Relative or absolute URL. Examples: `'/orgs/{org}'`, `https://example.com/foo/bar`
*/
export declare type Url = string;

View File

@ -0,0 +1 @@
export declare const VERSION = "6.34.0";

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,21 @@
export * from "./AuthInterface";
export * from "./EndpointDefaults";
export * from "./EndpointInterface";
export * from "./EndpointOptions";
export * from "./Fetch";
export * from "./OctokitResponse";
export * from "./RequestError";
export * from "./RequestHeaders";
export * from "./RequestInterface";
export * from "./RequestMethod";
export * from "./RequestOptions";
export * from "./RequestParameters";
export * from "./RequestRequestOptions";
export * from "./ResponseHeaders";
export * from "./Route";
export * from "./Signal";
export * from "./StrategyInterface";
export * from "./Url";
export * from "./VERSION";
export * from "./GetResponseTypeFromEndpointMethod";
export * from "./generated/Endpoints";

View File

@ -0,0 +1,4 @@
const VERSION = "6.34.0";
export { VERSION };
//# sourceMappingURL=index.js.map

View File

@ -0,0 +1 @@
{"version":3,"file":"index.js","sources":["../dist-src/VERSION.js"],"sourcesContent":["export const VERSION = \"0.0.0-development\";\n"],"names":[],"mappings":"AAAY,MAAC,OAAO,GAAG;;;;"}

View File

@ -0,0 +1,54 @@
{
"name": "@octokit/types",
"description": "Shared TypeScript definitions for Octokit projects",
"version": "6.34.0",
"license": "MIT",
"files": [
"dist-*/",
"bin/"
],
"pika": true,
"sideEffects": false,
"keywords": [
"github",
"api",
"sdk",
"toolkit",
"typescript"
],
"repository": "github:octokit/types.ts",
"dependencies": {
"@octokit/openapi-types": "^11.2.0"
},
"devDependencies": {
"@pika/pack": "^0.5.0",
"@pika/plugin-build-node": "^0.9.0",
"@pika/plugin-build-web": "^0.9.0",
"@pika/plugin-ts-standard-pkg": "^0.9.0",
"@types/node": ">= 8",
"github-openapi-graphql-query": "^1.0.5",
"handlebars": "^4.7.6",
"json-schema-to-typescript": "^10.0.0",
"lodash.set": "^4.3.2",
"npm-run-all": "^4.1.5",
"pascal-case": "^3.1.1",
"pika-plugin-merge-properties": "^1.0.6",
"prettier": "^2.0.0",
"semantic-release": "^18.0.0",
"semantic-release-plugin-update-version-in-files": "^1.0.0",
"sort-keys": "^4.2.0",
"string-to-jsdoc-comment": "^1.0.0",
"typedoc": "^0.21.0",
"typescript": "^4.0.2"
},
"publishConfig": {
"access": "public"
},
"source": "dist-src/index.js",
"types": "dist-types/index.d.ts",
"octokit": {
"openapi-version": "5.9.0"
},
"main": "dist-node/index.js",
"module": "dist-web/index.js"
}

View File

@ -1,7 +1,7 @@
{ {
"name": "@octokit/plugin-paginate-rest", "name": "@octokit/plugin-paginate-rest",
"description": "Octokit plugin to paginate REST API endpoint responses", "description": "Octokit plugin to paginate REST API endpoint responses",
"version": "2.13.3", "version": "2.17.0",
"license": "MIT", "license": "MIT",
"files": [ "files": [
"dist-*/", "dist-*/",
@ -17,28 +17,29 @@
], ],
"repository": "github:octokit/plugin-paginate-rest.js", "repository": "github:octokit/plugin-paginate-rest.js",
"dependencies": { "dependencies": {
"@octokit/types": "^6.11.0" "@octokit/types": "^6.34.0"
}, },
"peerDependencies": { "peerDependencies": {
"@octokit/core": ">=2" "@octokit/core": ">=2"
}, },
"devDependencies": { "devDependencies": {
"@octokit/core": "^3.0.0", "@octokit/core": "^3.0.0",
"@octokit/plugin-rest-endpoint-methods": "^4.0.0", "@octokit/plugin-rest-endpoint-methods": "^5.0.0",
"@pika/pack": "^0.5.0", "@pika/pack": "^0.5.0",
"@pika/plugin-build-node": "^0.9.0", "@pika/plugin-build-node": "^0.9.0",
"@pika/plugin-build-web": "^0.9.0", "@pika/plugin-build-web": "^0.9.0",
"@pika/plugin-ts-standard-pkg": "^0.9.0", "@pika/plugin-ts-standard-pkg": "^0.9.0",
"@types/fetch-mock": "^7.3.1", "@types/fetch-mock": "^7.3.1",
"@types/jest": "^26.0.0", "@types/jest": "^27.0.0",
"@types/node": "^14.0.4", "@types/node": "^14.0.4",
"fetch-mock": "^9.0.0", "fetch-mock": "^9.0.0",
"jest": "^26.0.1", "github-openapi-graphql-query": "^1.0.4",
"jest": "^27.0.0",
"npm-run-all": "^4.1.5", "npm-run-all": "^4.1.5",
"prettier": "^2.0.4", "prettier": "2.4.1",
"semantic-release": "^17.0.0", "semantic-release": "^18.0.0",
"semantic-release-plugin-update-version-in-files": "^1.0.0", "semantic-release-plugin-update-version-in-files": "^1.0.0",
"ts-jest": "^26.0.0", "ts-jest": "^27.0.0-next.12",
"typescript": "^4.0.2" "typescript": "^4.0.2"
}, },
"publishConfig": { "publishConfig": {

View File

@ -80,6 +80,7 @@ const Endpoints = {
disableWorkflow: ["PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable"], disableWorkflow: ["PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable"],
downloadArtifact: ["GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}"], downloadArtifact: ["GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}"],
downloadJobLogsForWorkflowRun: ["GET /repos/{owner}/{repo}/actions/jobs/{job_id}/logs"], downloadJobLogsForWorkflowRun: ["GET /repos/{owner}/{repo}/actions/jobs/{job_id}/logs"],
downloadWorkflowRunAttemptLogs: ["GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs"],
downloadWorkflowRunLogs: ["GET /repos/{owner}/{repo}/actions/runs/{run_id}/logs"], downloadWorkflowRunLogs: ["GET /repos/{owner}/{repo}/actions/runs/{run_id}/logs"],
enableSelectedRepositoryGithubActionsOrganization: ["PUT /orgs/{org}/actions/permissions/repositories/{repository_id}"], enableSelectedRepositoryGithubActionsOrganization: ["PUT /orgs/{org}/actions/permissions/repositories/{repository_id}"],
enableWorkflow: ["PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable"], enableWorkflow: ["PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable"],
@ -104,11 +105,13 @@ const Endpoints = {
getSelfHostedRunnerForRepo: ["GET /repos/{owner}/{repo}/actions/runners/{runner_id}"], getSelfHostedRunnerForRepo: ["GET /repos/{owner}/{repo}/actions/runners/{runner_id}"],
getWorkflow: ["GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}"], getWorkflow: ["GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}"],
getWorkflowRun: ["GET /repos/{owner}/{repo}/actions/runs/{run_id}"], getWorkflowRun: ["GET /repos/{owner}/{repo}/actions/runs/{run_id}"],
getWorkflowRunAttempt: ["GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}"],
getWorkflowRunUsage: ["GET /repos/{owner}/{repo}/actions/runs/{run_id}/timing"], getWorkflowRunUsage: ["GET /repos/{owner}/{repo}/actions/runs/{run_id}/timing"],
getWorkflowUsage: ["GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing"], getWorkflowUsage: ["GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing"],
listArtifactsForRepo: ["GET /repos/{owner}/{repo}/actions/artifacts"], listArtifactsForRepo: ["GET /repos/{owner}/{repo}/actions/artifacts"],
listEnvironmentSecrets: ["GET /repositories/{repository_id}/environments/{environment_name}/secrets"], listEnvironmentSecrets: ["GET /repositories/{repository_id}/environments/{environment_name}/secrets"],
listJobsForWorkflowRun: ["GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs"], listJobsForWorkflowRun: ["GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs"],
listJobsForWorkflowRunAttempt: ["GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs"],
listOrgSecrets: ["GET /orgs/{org}/actions/secrets"], listOrgSecrets: ["GET /orgs/{org}/actions/secrets"],
listRepoSecrets: ["GET /repos/{owner}/{repo}/actions/secrets"], listRepoSecrets: ["GET /repos/{owner}/{repo}/actions/secrets"],
listRepoWorkflows: ["GET /repos/{owner}/{repo}/actions/workflows"], listRepoWorkflows: ["GET /repos/{owner}/{repo}/actions/workflows"],
@ -121,7 +124,6 @@ const Endpoints = {
listWorkflowRunArtifacts: ["GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts"], listWorkflowRunArtifacts: ["GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts"],
listWorkflowRuns: ["GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs"], listWorkflowRuns: ["GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs"],
listWorkflowRunsForRepo: ["GET /repos/{owner}/{repo}/actions/runs"], listWorkflowRunsForRepo: ["GET /repos/{owner}/{repo}/actions/runs"],
reRunWorkflow: ["POST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun"],
removeSelectedRepoFromOrgSecret: ["DELETE /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}"], removeSelectedRepoFromOrgSecret: ["DELETE /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}"],
reviewPendingDeploymentsForRun: ["POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments"], reviewPendingDeploymentsForRun: ["POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments"],
setAllowedActionsOrganization: ["PUT /orgs/{org}/actions/permissions/selected-actions"], setAllowedActionsOrganization: ["PUT /orgs/{org}/actions/permissions/selected-actions"],
@ -165,7 +167,10 @@ const Endpoints = {
unstarRepoForAuthenticatedUser: ["DELETE /user/starred/{owner}/{repo}"] unstarRepoForAuthenticatedUser: ["DELETE /user/starred/{owner}/{repo}"]
}, },
apps: { apps: {
addRepoToInstallation: ["PUT /user/installations/{installation_id}/repositories/{repository_id}"], addRepoToInstallation: ["PUT /user/installations/{installation_id}/repositories/{repository_id}", {}, {
renamed: ["apps", "addRepoToInstallationForAuthenticatedUser"]
}],
addRepoToInstallationForAuthenticatedUser: ["PUT /user/installations/{installation_id}/repositories/{repository_id}"],
checkToken: ["POST /applications/{client_id}/token"], checkToken: ["POST /applications/{client_id}/token"],
createContentAttachment: ["POST /content_references/{content_reference_id}/attachments", { createContentAttachment: ["POST /content_references/{content_reference_id}/attachments", {
mediaType: { mediaType: {
@ -191,6 +196,7 @@ const Endpoints = {
getSubscriptionPlanForAccountStubbed: ["GET /marketplace_listing/stubbed/accounts/{account_id}"], getSubscriptionPlanForAccountStubbed: ["GET /marketplace_listing/stubbed/accounts/{account_id}"],
getUserInstallation: ["GET /users/{username}/installation"], getUserInstallation: ["GET /users/{username}/installation"],
getWebhookConfigForApp: ["GET /app/hook/config"], getWebhookConfigForApp: ["GET /app/hook/config"],
getWebhookDelivery: ["GET /app/hook/deliveries/{delivery_id}"],
listAccountsForPlan: ["GET /marketplace_listing/plans/{plan_id}/accounts"], listAccountsForPlan: ["GET /marketplace_listing/plans/{plan_id}/accounts"],
listAccountsForPlanStubbed: ["GET /marketplace_listing/stubbed/plans/{plan_id}/accounts"], listAccountsForPlanStubbed: ["GET /marketplace_listing/stubbed/plans/{plan_id}/accounts"],
listInstallationReposForAuthenticatedUser: ["GET /user/installations/{installation_id}/repositories"], listInstallationReposForAuthenticatedUser: ["GET /user/installations/{installation_id}/repositories"],
@ -201,7 +207,12 @@ const Endpoints = {
listReposAccessibleToInstallation: ["GET /installation/repositories"], listReposAccessibleToInstallation: ["GET /installation/repositories"],
listSubscriptionsForAuthenticatedUser: ["GET /user/marketplace_purchases"], listSubscriptionsForAuthenticatedUser: ["GET /user/marketplace_purchases"],
listSubscriptionsForAuthenticatedUserStubbed: ["GET /user/marketplace_purchases/stubbed"], listSubscriptionsForAuthenticatedUserStubbed: ["GET /user/marketplace_purchases/stubbed"],
removeRepoFromInstallation: ["DELETE /user/installations/{installation_id}/repositories/{repository_id}"], listWebhookDeliveries: ["GET /app/hook/deliveries"],
redeliverWebhookDelivery: ["POST /app/hook/deliveries/{delivery_id}/attempts"],
removeRepoFromInstallation: ["DELETE /user/installations/{installation_id}/repositories/{repository_id}", {}, {
renamed: ["apps", "removeRepoFromInstallationForAuthenticatedUser"]
}],
removeRepoFromInstallationForAuthenticatedUser: ["DELETE /user/installations/{installation_id}/repositories/{repository_id}"],
resetToken: ["PATCH /applications/{client_id}/token"], resetToken: ["PATCH /applications/{client_id}/token"],
revokeInstallationAccessToken: ["DELETE /installation/token"], revokeInstallationAccessToken: ["DELETE /installation/token"],
scopeToken: ["POST /applications/{client_id}/token/scoped"], scopeToken: ["POST /applications/{client_id}/token/scoped"],
@ -226,6 +237,7 @@ const Endpoints = {
listForRef: ["GET /repos/{owner}/{repo}/commits/{ref}/check-runs"], listForRef: ["GET /repos/{owner}/{repo}/commits/{ref}/check-runs"],
listForSuite: ["GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs"], listForSuite: ["GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs"],
listSuitesForRef: ["GET /repos/{owner}/{repo}/commits/{ref}/check-suites"], listSuitesForRef: ["GET /repos/{owner}/{repo}/commits/{ref}/check-suites"],
rerequestRun: ["POST /repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest"],
rerequestSuite: ["POST /repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest"], rerequestSuite: ["POST /repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest"],
setSuitesPreferences: ["PATCH /repos/{owner}/{repo}/check-suites/preferences"], setSuitesPreferences: ["PATCH /repos/{owner}/{repo}/check-suites/preferences"],
update: ["PATCH /repos/{owner}/{repo}/check-runs/{check_run_id}"] update: ["PATCH /repos/{owner}/{repo}/check-runs/{check_run_id}"]
@ -249,21 +261,8 @@ const Endpoints = {
uploadSarif: ["POST /repos/{owner}/{repo}/code-scanning/sarifs"] uploadSarif: ["POST /repos/{owner}/{repo}/code-scanning/sarifs"]
}, },
codesOfConduct: { codesOfConduct: {
getAllCodesOfConduct: ["GET /codes_of_conduct", { getAllCodesOfConduct: ["GET /codes_of_conduct"],
mediaType: { getConductCode: ["GET /codes_of_conduct/{key}"]
previews: ["scarlet-witch"]
}
}],
getConductCode: ["GET /codes_of_conduct/{key}", {
mediaType: {
previews: ["scarlet-witch"]
}
}],
getForRepo: ["GET /repos/{owner}/{repo}/community/code_of_conduct", {
mediaType: {
previews: ["scarlet-witch"]
}
}]
}, },
emojis: { emojis: {
get: ["GET /emojis"] get: ["GET /emojis"]
@ -361,11 +360,7 @@ const Endpoints = {
listCommentsForRepo: ["GET /repos/{owner}/{repo}/issues/comments"], listCommentsForRepo: ["GET /repos/{owner}/{repo}/issues/comments"],
listEvents: ["GET /repos/{owner}/{repo}/issues/{issue_number}/events"], listEvents: ["GET /repos/{owner}/{repo}/issues/{issue_number}/events"],
listEventsForRepo: ["GET /repos/{owner}/{repo}/issues/events"], listEventsForRepo: ["GET /repos/{owner}/{repo}/issues/events"],
listEventsForTimeline: ["GET /repos/{owner}/{repo}/issues/{issue_number}/timeline", { listEventsForTimeline: ["GET /repos/{owner}/{repo}/issues/{issue_number}/timeline"],
mediaType: {
previews: ["mockingbird"]
}
}],
listForAuthenticatedUser: ["GET /user/issues"], listForAuthenticatedUser: ["GET /user/issues"],
listForOrg: ["GET /orgs/{org}/issues"], listForOrg: ["GET /orgs/{org}/issues"],
listForRepo: ["GET /repos/{owner}/{repo}/issues"], listForRepo: ["GET /repos/{owner}/{repo}/issues"],
@ -405,74 +400,29 @@ const Endpoints = {
}, },
migrations: { migrations: {
cancelImport: ["DELETE /repos/{owner}/{repo}/import"], cancelImport: ["DELETE /repos/{owner}/{repo}/import"],
deleteArchiveForAuthenticatedUser: ["DELETE /user/migrations/{migration_id}/archive", { deleteArchiveForAuthenticatedUser: ["DELETE /user/migrations/{migration_id}/archive"],
mediaType: { deleteArchiveForOrg: ["DELETE /orgs/{org}/migrations/{migration_id}/archive"],
previews: ["wyandotte"] downloadArchiveForOrg: ["GET /orgs/{org}/migrations/{migration_id}/archive"],
} getArchiveForAuthenticatedUser: ["GET /user/migrations/{migration_id}/archive"],
}],
deleteArchiveForOrg: ["DELETE /orgs/{org}/migrations/{migration_id}/archive", {
mediaType: {
previews: ["wyandotte"]
}
}],
downloadArchiveForOrg: ["GET /orgs/{org}/migrations/{migration_id}/archive", {
mediaType: {
previews: ["wyandotte"]
}
}],
getArchiveForAuthenticatedUser: ["GET /user/migrations/{migration_id}/archive", {
mediaType: {
previews: ["wyandotte"]
}
}],
getCommitAuthors: ["GET /repos/{owner}/{repo}/import/authors"], getCommitAuthors: ["GET /repos/{owner}/{repo}/import/authors"],
getImportStatus: ["GET /repos/{owner}/{repo}/import"], getImportStatus: ["GET /repos/{owner}/{repo}/import"],
getLargeFiles: ["GET /repos/{owner}/{repo}/import/large_files"], getLargeFiles: ["GET /repos/{owner}/{repo}/import/large_files"],
getStatusForAuthenticatedUser: ["GET /user/migrations/{migration_id}", { getStatusForAuthenticatedUser: ["GET /user/migrations/{migration_id}"],
mediaType: { getStatusForOrg: ["GET /orgs/{org}/migrations/{migration_id}"],
previews: ["wyandotte"] listForAuthenticatedUser: ["GET /user/migrations"],
} listForOrg: ["GET /orgs/{org}/migrations"],
}], listReposForAuthenticatedUser: ["GET /user/migrations/{migration_id}/repositories"],
getStatusForOrg: ["GET /orgs/{org}/migrations/{migration_id}", { listReposForOrg: ["GET /orgs/{org}/migrations/{migration_id}/repositories"],
mediaType: { listReposForUser: ["GET /user/migrations/{migration_id}/repositories", {}, {
previews: ["wyandotte"] renamed: ["migrations", "listReposForAuthenticatedUser"]
}
}],
listForAuthenticatedUser: ["GET /user/migrations", {
mediaType: {
previews: ["wyandotte"]
}
}],
listForOrg: ["GET /orgs/{org}/migrations", {
mediaType: {
previews: ["wyandotte"]
}
}],
listReposForOrg: ["GET /orgs/{org}/migrations/{migration_id}/repositories", {
mediaType: {
previews: ["wyandotte"]
}
}],
listReposForUser: ["GET /user/migrations/{migration_id}/repositories", {
mediaType: {
previews: ["wyandotte"]
}
}], }],
mapCommitAuthor: ["PATCH /repos/{owner}/{repo}/import/authors/{author_id}"], mapCommitAuthor: ["PATCH /repos/{owner}/{repo}/import/authors/{author_id}"],
setLfsPreference: ["PATCH /repos/{owner}/{repo}/import/lfs"], setLfsPreference: ["PATCH /repos/{owner}/{repo}/import/lfs"],
startForAuthenticatedUser: ["POST /user/migrations"], startForAuthenticatedUser: ["POST /user/migrations"],
startForOrg: ["POST /orgs/{org}/migrations"], startForOrg: ["POST /orgs/{org}/migrations"],
startImport: ["PUT /repos/{owner}/{repo}/import"], startImport: ["PUT /repos/{owner}/{repo}/import"],
unlockRepoForAuthenticatedUser: ["DELETE /user/migrations/{migration_id}/repos/{repo_name}/lock", { unlockRepoForAuthenticatedUser: ["DELETE /user/migrations/{migration_id}/repos/{repo_name}/lock"],
mediaType: { unlockRepoForOrg: ["DELETE /orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock"],
previews: ["wyandotte"]
}
}],
unlockRepoForOrg: ["DELETE /orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock", {
mediaType: {
previews: ["wyandotte"]
}
}],
updateImport: ["PATCH /repos/{owner}/{repo}/import"] updateImport: ["PATCH /repos/{owner}/{repo}/import"]
}, },
orgs: { orgs: {
@ -490,6 +440,7 @@ const Endpoints = {
getMembershipForUser: ["GET /orgs/{org}/memberships/{username}"], getMembershipForUser: ["GET /orgs/{org}/memberships/{username}"],
getWebhook: ["GET /orgs/{org}/hooks/{hook_id}"], getWebhook: ["GET /orgs/{org}/hooks/{hook_id}"],
getWebhookConfigForOrg: ["GET /orgs/{org}/hooks/{hook_id}/config"], getWebhookConfigForOrg: ["GET /orgs/{org}/hooks/{hook_id}/config"],
getWebhookDelivery: ["GET /orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}"],
list: ["GET /organizations"], list: ["GET /organizations"],
listAppInstallations: ["GET /orgs/{org}/installations"], listAppInstallations: ["GET /orgs/{org}/installations"],
listBlockedUsers: ["GET /orgs/{org}/blocks"], listBlockedUsers: ["GET /orgs/{org}/blocks"],
@ -502,8 +453,10 @@ const Endpoints = {
listOutsideCollaborators: ["GET /orgs/{org}/outside_collaborators"], listOutsideCollaborators: ["GET /orgs/{org}/outside_collaborators"],
listPendingInvitations: ["GET /orgs/{org}/invitations"], listPendingInvitations: ["GET /orgs/{org}/invitations"],
listPublicMembers: ["GET /orgs/{org}/public_members"], listPublicMembers: ["GET /orgs/{org}/public_members"],
listWebhookDeliveries: ["GET /orgs/{org}/hooks/{hook_id}/deliveries"],
listWebhooks: ["GET /orgs/{org}/hooks"], listWebhooks: ["GET /orgs/{org}/hooks"],
pingWebhook: ["POST /orgs/{org}/hooks/{hook_id}/pings"], pingWebhook: ["POST /orgs/{org}/hooks/{hook_id}/pings"],
redeliverWebhookDelivery: ["POST /orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts"],
removeMember: ["DELETE /orgs/{org}/members/{username}"], removeMember: ["DELETE /orgs/{org}/members/{username}"],
removeMembershipForUser: ["DELETE /orgs/{org}/memberships/{username}"], removeMembershipForUser: ["DELETE /orgs/{org}/memberships/{username}"],
removeOutsideCollaborator: ["DELETE /orgs/{org}/outside_collaborators/{username}"], removeOutsideCollaborator: ["DELETE /orgs/{org}/outside_collaborators/{username}"],
@ -519,8 +472,10 @@ const Endpoints = {
packages: { packages: {
deletePackageForAuthenticatedUser: ["DELETE /user/packages/{package_type}/{package_name}"], deletePackageForAuthenticatedUser: ["DELETE /user/packages/{package_type}/{package_name}"],
deletePackageForOrg: ["DELETE /orgs/{org}/packages/{package_type}/{package_name}"], deletePackageForOrg: ["DELETE /orgs/{org}/packages/{package_type}/{package_name}"],
deletePackageForUser: ["DELETE /users/{username}/packages/{package_type}/{package_name}"],
deletePackageVersionForAuthenticatedUser: ["DELETE /user/packages/{package_type}/{package_name}/versions/{package_version_id}"], deletePackageVersionForAuthenticatedUser: ["DELETE /user/packages/{package_type}/{package_name}/versions/{package_version_id}"],
deletePackageVersionForOrg: ["DELETE /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}"], deletePackageVersionForOrg: ["DELETE /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}"],
deletePackageVersionForUser: ["DELETE /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}"],
getAllPackageVersionsForAPackageOwnedByAnOrg: ["GET /orgs/{org}/packages/{package_type}/{package_name}/versions", {}, { getAllPackageVersionsForAPackageOwnedByAnOrg: ["GET /orgs/{org}/packages/{package_type}/{package_name}/versions", {}, {
renamed: ["packages", "getAllPackageVersionsForPackageOwnedByOrg"] renamed: ["packages", "getAllPackageVersionsForPackageOwnedByOrg"]
}], }],
@ -536,137 +491,42 @@ const Endpoints = {
getPackageVersionForAuthenticatedUser: ["GET /user/packages/{package_type}/{package_name}/versions/{package_version_id}"], getPackageVersionForAuthenticatedUser: ["GET /user/packages/{package_type}/{package_name}/versions/{package_version_id}"],
getPackageVersionForOrganization: ["GET /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}"], getPackageVersionForOrganization: ["GET /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}"],
getPackageVersionForUser: ["GET /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}"], getPackageVersionForUser: ["GET /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}"],
listPackagesForAuthenticatedUser: ["GET /user/packages"],
listPackagesForOrganization: ["GET /orgs/{org}/packages"],
listPackagesForUser: ["GET /users/{username}/packages"],
restorePackageForAuthenticatedUser: ["POST /user/packages/{package_type}/{package_name}/restore{?token}"], restorePackageForAuthenticatedUser: ["POST /user/packages/{package_type}/{package_name}/restore{?token}"],
restorePackageForOrg: ["POST /orgs/{org}/packages/{package_type}/{package_name}/restore{?token}"], restorePackageForOrg: ["POST /orgs/{org}/packages/{package_type}/{package_name}/restore{?token}"],
restorePackageForUser: ["POST /users/{username}/packages/{package_type}/{package_name}/restore{?token}"],
restorePackageVersionForAuthenticatedUser: ["POST /user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore"], restorePackageVersionForAuthenticatedUser: ["POST /user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore"],
restorePackageVersionForOrg: ["POST /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore"] restorePackageVersionForOrg: ["POST /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore"],
restorePackageVersionForUser: ["POST /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore"]
}, },
projects: { projects: {
addCollaborator: ["PUT /projects/{project_id}/collaborators/{username}", { addCollaborator: ["PUT /projects/{project_id}/collaborators/{username}"],
mediaType: { createCard: ["POST /projects/columns/{column_id}/cards"],
previews: ["inertia"] createColumn: ["POST /projects/{project_id}/columns"],
} createForAuthenticatedUser: ["POST /user/projects"],
}], createForOrg: ["POST /orgs/{org}/projects"],
createCard: ["POST /projects/columns/{column_id}/cards", { createForRepo: ["POST /repos/{owner}/{repo}/projects"],
mediaType: { delete: ["DELETE /projects/{project_id}"],
previews: ["inertia"] deleteCard: ["DELETE /projects/columns/cards/{card_id}"],
} deleteColumn: ["DELETE /projects/columns/{column_id}"],
}], get: ["GET /projects/{project_id}"],
createColumn: ["POST /projects/{project_id}/columns", { getCard: ["GET /projects/columns/cards/{card_id}"],
mediaType: { getColumn: ["GET /projects/columns/{column_id}"],
previews: ["inertia"] getPermissionForUser: ["GET /projects/{project_id}/collaborators/{username}/permission"],
} listCards: ["GET /projects/columns/{column_id}/cards"],
}], listCollaborators: ["GET /projects/{project_id}/collaborators"],
createForAuthenticatedUser: ["POST /user/projects", { listColumns: ["GET /projects/{project_id}/columns"],
mediaType: { listForOrg: ["GET /orgs/{org}/projects"],
previews: ["inertia"] listForRepo: ["GET /repos/{owner}/{repo}/projects"],
} listForUser: ["GET /users/{username}/projects"],
}], moveCard: ["POST /projects/columns/cards/{card_id}/moves"],
createForOrg: ["POST /orgs/{org}/projects", { moveColumn: ["POST /projects/columns/{column_id}/moves"],
mediaType: { removeCollaborator: ["DELETE /projects/{project_id}/collaborators/{username}"],
previews: ["inertia"] update: ["PATCH /projects/{project_id}"],
} updateCard: ["PATCH /projects/columns/cards/{card_id}"],
}], updateColumn: ["PATCH /projects/columns/{column_id}"]
createForRepo: ["POST /repos/{owner}/{repo}/projects", {
mediaType: {
previews: ["inertia"]
}
}],
delete: ["DELETE /projects/{project_id}", {
mediaType: {
previews: ["inertia"]
}
}],
deleteCard: ["DELETE /projects/columns/cards/{card_id}", {
mediaType: {
previews: ["inertia"]
}
}],
deleteColumn: ["DELETE /projects/columns/{column_id}", {
mediaType: {
previews: ["inertia"]
}
}],
get: ["GET /projects/{project_id}", {
mediaType: {
previews: ["inertia"]
}
}],
getCard: ["GET /projects/columns/cards/{card_id}", {
mediaType: {
previews: ["inertia"]
}
}],
getColumn: ["GET /projects/columns/{column_id}", {
mediaType: {
previews: ["inertia"]
}
}],
getPermissionForUser: ["GET /projects/{project_id}/collaborators/{username}/permission", {
mediaType: {
previews: ["inertia"]
}
}],
listCards: ["GET /projects/columns/{column_id}/cards", {
mediaType: {
previews: ["inertia"]
}
}],
listCollaborators: ["GET /projects/{project_id}/collaborators", {
mediaType: {
previews: ["inertia"]
}
}],
listColumns: ["GET /projects/{project_id}/columns", {
mediaType: {
previews: ["inertia"]
}
}],
listForOrg: ["GET /orgs/{org}/projects", {
mediaType: {
previews: ["inertia"]
}
}],
listForRepo: ["GET /repos/{owner}/{repo}/projects", {
mediaType: {
previews: ["inertia"]
}
}],
listForUser: ["GET /users/{username}/projects", {
mediaType: {
previews: ["inertia"]
}
}],
moveCard: ["POST /projects/columns/cards/{card_id}/moves", {
mediaType: {
previews: ["inertia"]
}
}],
moveColumn: ["POST /projects/columns/{column_id}/moves", {
mediaType: {
previews: ["inertia"]
}
}],
removeCollaborator: ["DELETE /projects/{project_id}/collaborators/{username}", {
mediaType: {
previews: ["inertia"]
}
}],
update: ["PATCH /projects/{project_id}", {
mediaType: {
previews: ["inertia"]
}
}],
updateCard: ["PATCH /projects/columns/cards/{card_id}", {
mediaType: {
previews: ["inertia"]
}
}],
updateColumn: ["PATCH /projects/columns/{column_id}", {
mediaType: {
previews: ["inertia"]
}
}]
}, },
pulls: { pulls: {
checkIfMerged: ["GET /repos/{owner}/{repo}/pulls/{pull_number}/merge"], checkIfMerged: ["GET /repos/{owner}/{repo}/pulls/{pull_number}/merge"],
@ -693,11 +553,7 @@ const Endpoints = {
requestReviewers: ["POST /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers"], requestReviewers: ["POST /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers"],
submitReview: ["POST /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events"], submitReview: ["POST /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events"],
update: ["PATCH /repos/{owner}/{repo}/pulls/{pull_number}"], update: ["PATCH /repos/{owner}/{repo}/pulls/{pull_number}"],
updateBranch: ["PUT /repos/{owner}/{repo}/pulls/{pull_number}/update-branch", { updateBranch: ["PUT /repos/{owner}/{repo}/pulls/{pull_number}/update-branch"],
mediaType: {
previews: ["lydian"]
}
}],
updateReview: ["PUT /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}"], updateReview: ["PUT /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}"],
updateReviewComment: ["PATCH /repos/{owner}/{repo}/pulls/comments/{comment_id}"] updateReviewComment: ["PATCH /repos/{owner}/{repo}/pulls/comments/{comment_id}"]
}, },
@ -705,111 +561,31 @@ const Endpoints = {
get: ["GET /rate_limit"] get: ["GET /rate_limit"]
}, },
reactions: { reactions: {
createForCommitComment: ["POST /repos/{owner}/{repo}/comments/{comment_id}/reactions", { createForCommitComment: ["POST /repos/{owner}/{repo}/comments/{comment_id}/reactions"],
mediaType: { createForIssue: ["POST /repos/{owner}/{repo}/issues/{issue_number}/reactions"],
previews: ["squirrel-girl"] createForIssueComment: ["POST /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions"],
} createForPullRequestReviewComment: ["POST /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions"],
}], createForRelease: ["POST /repos/{owner}/{repo}/releases/{release_id}/reactions"],
createForIssue: ["POST /repos/{owner}/{repo}/issues/{issue_number}/reactions", { createForTeamDiscussionCommentInOrg: ["POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions"],
mediaType: { createForTeamDiscussionInOrg: ["POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions"],
previews: ["squirrel-girl"] deleteForCommitComment: ["DELETE /repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}"],
} deleteForIssue: ["DELETE /repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}"],
}], deleteForIssueComment: ["DELETE /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}"],
createForIssueComment: ["POST /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", { deleteForPullRequestComment: ["DELETE /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}"],
mediaType: { deleteForTeamDiscussion: ["DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}"],
previews: ["squirrel-girl"] deleteForTeamDiscussionComment: ["DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}"],
} listForCommitComment: ["GET /repos/{owner}/{repo}/comments/{comment_id}/reactions"],
}], listForIssue: ["GET /repos/{owner}/{repo}/issues/{issue_number}/reactions"],
createForPullRequestReviewComment: ["POST /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", { listForIssueComment: ["GET /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions"],
mediaType: { listForPullRequestReviewComment: ["GET /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions"],
previews: ["squirrel-girl"] listForTeamDiscussionCommentInOrg: ["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions"],
} listForTeamDiscussionInOrg: ["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions"]
}],
createForRelease: ["POST /repos/{owner}/{repo}/releases/{release_id}/reactions", {
mediaType: {
previews: ["squirrel-girl"]
}
}],
createForTeamDiscussionCommentInOrg: ["POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", {
mediaType: {
previews: ["squirrel-girl"]
}
}],
createForTeamDiscussionInOrg: ["POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", {
mediaType: {
previews: ["squirrel-girl"]
}
}],
deleteForCommitComment: ["DELETE /repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}", {
mediaType: {
previews: ["squirrel-girl"]
}
}],
deleteForIssue: ["DELETE /repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}", {
mediaType: {
previews: ["squirrel-girl"]
}
}],
deleteForIssueComment: ["DELETE /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}", {
mediaType: {
previews: ["squirrel-girl"]
}
}],
deleteForPullRequestComment: ["DELETE /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}", {
mediaType: {
previews: ["squirrel-girl"]
}
}],
deleteForTeamDiscussion: ["DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}", {
mediaType: {
previews: ["squirrel-girl"]
}
}],
deleteForTeamDiscussionComment: ["DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}", {
mediaType: {
previews: ["squirrel-girl"]
}
}],
deleteLegacy: ["DELETE /reactions/{reaction_id}", {
mediaType: {
previews: ["squirrel-girl"]
}
}, {
deprecated: "octokit.rest.reactions.deleteLegacy() is deprecated, see https://docs.github.com/rest/reference/reactions/#delete-a-reaction-legacy"
}],
listForCommitComment: ["GET /repos/{owner}/{repo}/comments/{comment_id}/reactions", {
mediaType: {
previews: ["squirrel-girl"]
}
}],
listForIssue: ["GET /repos/{owner}/{repo}/issues/{issue_number}/reactions", {
mediaType: {
previews: ["squirrel-girl"]
}
}],
listForIssueComment: ["GET /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", {
mediaType: {
previews: ["squirrel-girl"]
}
}],
listForPullRequestReviewComment: ["GET /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", {
mediaType: {
previews: ["squirrel-girl"]
}
}],
listForTeamDiscussionCommentInOrg: ["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", {
mediaType: {
previews: ["squirrel-girl"]
}
}],
listForTeamDiscussionInOrg: ["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", {
mediaType: {
previews: ["squirrel-girl"]
}
}]
}, },
repos: { repos: {
acceptInvitation: ["PATCH /user/repository_invitations/{invitation_id}"], acceptInvitation: ["PATCH /user/repository_invitations/{invitation_id}", {}, {
renamed: ["repos", "acceptInvitationForAuthenticatedUser"]
}],
acceptInvitationForAuthenticatedUser: ["PATCH /user/repository_invitations/{invitation_id}"],
addAppAccessRestrictions: ["POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", {}, { addAppAccessRestrictions: ["POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", {}, {
mapToData: "apps" mapToData: "apps"
}], }],
@ -824,19 +600,12 @@ const Endpoints = {
mapToData: "users" mapToData: "users"
}], }],
checkCollaborator: ["GET /repos/{owner}/{repo}/collaborators/{username}"], checkCollaborator: ["GET /repos/{owner}/{repo}/collaborators/{username}"],
checkVulnerabilityAlerts: ["GET /repos/{owner}/{repo}/vulnerability-alerts", { checkVulnerabilityAlerts: ["GET /repos/{owner}/{repo}/vulnerability-alerts"],
mediaType: {
previews: ["dorian"]
}
}],
compareCommits: ["GET /repos/{owner}/{repo}/compare/{base}...{head}"], compareCommits: ["GET /repos/{owner}/{repo}/compare/{base}...{head}"],
compareCommitsWithBasehead: ["GET /repos/{owner}/{repo}/compare/{basehead}"], compareCommitsWithBasehead: ["GET /repos/{owner}/{repo}/compare/{basehead}"],
createAutolink: ["POST /repos/{owner}/{repo}/autolinks"],
createCommitComment: ["POST /repos/{owner}/{repo}/commits/{commit_sha}/comments"], createCommitComment: ["POST /repos/{owner}/{repo}/commits/{commit_sha}/comments"],
createCommitSignatureProtection: ["POST /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", { createCommitSignatureProtection: ["POST /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures"],
mediaType: {
previews: ["zzzax"]
}
}],
createCommitStatus: ["POST /repos/{owner}/{repo}/statuses/{sha}"], createCommitStatus: ["POST /repos/{owner}/{repo}/statuses/{sha}"],
createDeployKey: ["POST /repos/{owner}/{repo}/keys"], createDeployKey: ["POST /repos/{owner}/{repo}/keys"],
createDeployment: ["POST /repos/{owner}/{repo}/deployments"], createDeployment: ["POST /repos/{owner}/{repo}/deployments"],
@ -847,68 +616,43 @@ const Endpoints = {
createInOrg: ["POST /orgs/{org}/repos"], createInOrg: ["POST /orgs/{org}/repos"],
createOrUpdateEnvironment: ["PUT /repos/{owner}/{repo}/environments/{environment_name}"], createOrUpdateEnvironment: ["PUT /repos/{owner}/{repo}/environments/{environment_name}"],
createOrUpdateFileContents: ["PUT /repos/{owner}/{repo}/contents/{path}"], createOrUpdateFileContents: ["PUT /repos/{owner}/{repo}/contents/{path}"],
createPagesSite: ["POST /repos/{owner}/{repo}/pages", { createPagesSite: ["POST /repos/{owner}/{repo}/pages"],
mediaType: {
previews: ["switcheroo"]
}
}],
createRelease: ["POST /repos/{owner}/{repo}/releases"], createRelease: ["POST /repos/{owner}/{repo}/releases"],
createUsingTemplate: ["POST /repos/{template_owner}/{template_repo}/generate", { createUsingTemplate: ["POST /repos/{template_owner}/{template_repo}/generate"],
mediaType: {
previews: ["baptiste"]
}
}],
createWebhook: ["POST /repos/{owner}/{repo}/hooks"], createWebhook: ["POST /repos/{owner}/{repo}/hooks"],
declineInvitation: ["DELETE /user/repository_invitations/{invitation_id}"], declineInvitation: ["DELETE /user/repository_invitations/{invitation_id}", {}, {
renamed: ["repos", "declineInvitationForAuthenticatedUser"]
}],
declineInvitationForAuthenticatedUser: ["DELETE /user/repository_invitations/{invitation_id}"],
delete: ["DELETE /repos/{owner}/{repo}"], delete: ["DELETE /repos/{owner}/{repo}"],
deleteAccessRestrictions: ["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions"], deleteAccessRestrictions: ["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions"],
deleteAdminBranchProtection: ["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins"], deleteAdminBranchProtection: ["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins"],
deleteAnEnvironment: ["DELETE /repos/{owner}/{repo}/environments/{environment_name}"], deleteAnEnvironment: ["DELETE /repos/{owner}/{repo}/environments/{environment_name}"],
deleteAutolink: ["DELETE /repos/{owner}/{repo}/autolinks/{autolink_id}"],
deleteBranchProtection: ["DELETE /repos/{owner}/{repo}/branches/{branch}/protection"], deleteBranchProtection: ["DELETE /repos/{owner}/{repo}/branches/{branch}/protection"],
deleteCommitComment: ["DELETE /repos/{owner}/{repo}/comments/{comment_id}"], deleteCommitComment: ["DELETE /repos/{owner}/{repo}/comments/{comment_id}"],
deleteCommitSignatureProtection: ["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", { deleteCommitSignatureProtection: ["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures"],
mediaType: {
previews: ["zzzax"]
}
}],
deleteDeployKey: ["DELETE /repos/{owner}/{repo}/keys/{key_id}"], deleteDeployKey: ["DELETE /repos/{owner}/{repo}/keys/{key_id}"],
deleteDeployment: ["DELETE /repos/{owner}/{repo}/deployments/{deployment_id}"], deleteDeployment: ["DELETE /repos/{owner}/{repo}/deployments/{deployment_id}"],
deleteFile: ["DELETE /repos/{owner}/{repo}/contents/{path}"], deleteFile: ["DELETE /repos/{owner}/{repo}/contents/{path}"],
deleteInvitation: ["DELETE /repos/{owner}/{repo}/invitations/{invitation_id}"], deleteInvitation: ["DELETE /repos/{owner}/{repo}/invitations/{invitation_id}"],
deletePagesSite: ["DELETE /repos/{owner}/{repo}/pages", { deletePagesSite: ["DELETE /repos/{owner}/{repo}/pages"],
mediaType: {
previews: ["switcheroo"]
}
}],
deletePullRequestReviewProtection: ["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews"], deletePullRequestReviewProtection: ["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews"],
deleteRelease: ["DELETE /repos/{owner}/{repo}/releases/{release_id}"], deleteRelease: ["DELETE /repos/{owner}/{repo}/releases/{release_id}"],
deleteReleaseAsset: ["DELETE /repos/{owner}/{repo}/releases/assets/{asset_id}"], deleteReleaseAsset: ["DELETE /repos/{owner}/{repo}/releases/assets/{asset_id}"],
deleteWebhook: ["DELETE /repos/{owner}/{repo}/hooks/{hook_id}"], deleteWebhook: ["DELETE /repos/{owner}/{repo}/hooks/{hook_id}"],
disableAutomatedSecurityFixes: ["DELETE /repos/{owner}/{repo}/automated-security-fixes", { disableAutomatedSecurityFixes: ["DELETE /repos/{owner}/{repo}/automated-security-fixes"],
mediaType: { disableLfsForRepo: ["DELETE /repos/{owner}/{repo}/lfs"],
previews: ["london"] disableVulnerabilityAlerts: ["DELETE /repos/{owner}/{repo}/vulnerability-alerts"],
}
}],
disableVulnerabilityAlerts: ["DELETE /repos/{owner}/{repo}/vulnerability-alerts", {
mediaType: {
previews: ["dorian"]
}
}],
downloadArchive: ["GET /repos/{owner}/{repo}/zipball/{ref}", {}, { downloadArchive: ["GET /repos/{owner}/{repo}/zipball/{ref}", {}, {
renamed: ["repos", "downloadZipballArchive"] renamed: ["repos", "downloadZipballArchive"]
}], }],
downloadTarballArchive: ["GET /repos/{owner}/{repo}/tarball/{ref}"], downloadTarballArchive: ["GET /repos/{owner}/{repo}/tarball/{ref}"],
downloadZipballArchive: ["GET /repos/{owner}/{repo}/zipball/{ref}"], downloadZipballArchive: ["GET /repos/{owner}/{repo}/zipball/{ref}"],
enableAutomatedSecurityFixes: ["PUT /repos/{owner}/{repo}/automated-security-fixes", { enableAutomatedSecurityFixes: ["PUT /repos/{owner}/{repo}/automated-security-fixes"],
mediaType: { enableLfsForRepo: ["PUT /repos/{owner}/{repo}/lfs"],
previews: ["london"] enableVulnerabilityAlerts: ["PUT /repos/{owner}/{repo}/vulnerability-alerts"],
} generateReleaseNotes: ["POST /repos/{owner}/{repo}/releases/generate-notes"],
}],
enableVulnerabilityAlerts: ["PUT /repos/{owner}/{repo}/vulnerability-alerts", {
mediaType: {
previews: ["dorian"]
}
}],
get: ["GET /repos/{owner}/{repo}"], get: ["GET /repos/{owner}/{repo}"],
getAccessRestrictions: ["GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions"], getAccessRestrictions: ["GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions"],
getAdminBranchProtection: ["GET /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins"], getAdminBranchProtection: ["GET /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins"],
@ -920,6 +664,7 @@ const Endpoints = {
} }
}], }],
getAppsWithAccessToProtectedBranch: ["GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps"], getAppsWithAccessToProtectedBranch: ["GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps"],
getAutolink: ["GET /repos/{owner}/{repo}/autolinks/{autolink_id}"],
getBranch: ["GET /repos/{owner}/{repo}/branches/{branch}"], getBranch: ["GET /repos/{owner}/{repo}/branches/{branch}"],
getBranchProtection: ["GET /repos/{owner}/{repo}/branches/{branch}/protection"], getBranchProtection: ["GET /repos/{owner}/{repo}/branches/{branch}/protection"],
getClones: ["GET /repos/{owner}/{repo}/traffic/clones"], getClones: ["GET /repos/{owner}/{repo}/traffic/clones"],
@ -929,11 +674,7 @@ const Endpoints = {
getCommit: ["GET /repos/{owner}/{repo}/commits/{ref}"], getCommit: ["GET /repos/{owner}/{repo}/commits/{ref}"],
getCommitActivityStats: ["GET /repos/{owner}/{repo}/stats/commit_activity"], getCommitActivityStats: ["GET /repos/{owner}/{repo}/stats/commit_activity"],
getCommitComment: ["GET /repos/{owner}/{repo}/comments/{comment_id}"], getCommitComment: ["GET /repos/{owner}/{repo}/comments/{comment_id}"],
getCommitSignatureProtection: ["GET /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", { getCommitSignatureProtection: ["GET /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures"],
mediaType: {
previews: ["zzzax"]
}
}],
getCommunityProfileMetrics: ["GET /repos/{owner}/{repo}/community/profile"], getCommunityProfileMetrics: ["GET /repos/{owner}/{repo}/community/profile"],
getContent: ["GET /repos/{owner}/{repo}/contents/{path}"], getContent: ["GET /repos/{owner}/{repo}/contents/{path}"],
getContributorsStats: ["GET /repos/{owner}/{repo}/stats/contributors"], getContributorsStats: ["GET /repos/{owner}/{repo}/stats/contributors"],
@ -962,12 +703,10 @@ const Endpoints = {
getViews: ["GET /repos/{owner}/{repo}/traffic/views"], getViews: ["GET /repos/{owner}/{repo}/traffic/views"],
getWebhook: ["GET /repos/{owner}/{repo}/hooks/{hook_id}"], getWebhook: ["GET /repos/{owner}/{repo}/hooks/{hook_id}"],
getWebhookConfigForRepo: ["GET /repos/{owner}/{repo}/hooks/{hook_id}/config"], getWebhookConfigForRepo: ["GET /repos/{owner}/{repo}/hooks/{hook_id}/config"],
getWebhookDelivery: ["GET /repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}"],
listAutolinks: ["GET /repos/{owner}/{repo}/autolinks"],
listBranches: ["GET /repos/{owner}/{repo}/branches"], listBranches: ["GET /repos/{owner}/{repo}/branches"],
listBranchesForHeadCommit: ["GET /repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head", { listBranchesForHeadCommit: ["GET /repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head"],
mediaType: {
previews: ["groot"]
}
}],
listCollaborators: ["GET /repos/{owner}/{repo}/collaborators"], listCollaborators: ["GET /repos/{owner}/{repo}/collaborators"],
listCommentsForCommit: ["GET /repos/{owner}/{repo}/commits/{commit_sha}/comments"], listCommentsForCommit: ["GET /repos/{owner}/{repo}/commits/{commit_sha}/comments"],
listCommitCommentsForRepo: ["GET /repos/{owner}/{repo}/comments"], listCommitCommentsForRepo: ["GET /repos/{owner}/{repo}/comments"],
@ -986,18 +725,17 @@ const Endpoints = {
listLanguages: ["GET /repos/{owner}/{repo}/languages"], listLanguages: ["GET /repos/{owner}/{repo}/languages"],
listPagesBuilds: ["GET /repos/{owner}/{repo}/pages/builds"], listPagesBuilds: ["GET /repos/{owner}/{repo}/pages/builds"],
listPublic: ["GET /repositories"], listPublic: ["GET /repositories"],
listPullRequestsAssociatedWithCommit: ["GET /repos/{owner}/{repo}/commits/{commit_sha}/pulls", { listPullRequestsAssociatedWithCommit: ["GET /repos/{owner}/{repo}/commits/{commit_sha}/pulls"],
mediaType: {
previews: ["groot"]
}
}],
listReleaseAssets: ["GET /repos/{owner}/{repo}/releases/{release_id}/assets"], listReleaseAssets: ["GET /repos/{owner}/{repo}/releases/{release_id}/assets"],
listReleases: ["GET /repos/{owner}/{repo}/releases"], listReleases: ["GET /repos/{owner}/{repo}/releases"],
listTags: ["GET /repos/{owner}/{repo}/tags"], listTags: ["GET /repos/{owner}/{repo}/tags"],
listTeams: ["GET /repos/{owner}/{repo}/teams"], listTeams: ["GET /repos/{owner}/{repo}/teams"],
listWebhookDeliveries: ["GET /repos/{owner}/{repo}/hooks/{hook_id}/deliveries"],
listWebhooks: ["GET /repos/{owner}/{repo}/hooks"], listWebhooks: ["GET /repos/{owner}/{repo}/hooks"],
merge: ["POST /repos/{owner}/{repo}/merges"], merge: ["POST /repos/{owner}/{repo}/merges"],
mergeUpstream: ["POST /repos/{owner}/{repo}/merge-upstream"],
pingWebhook: ["POST /repos/{owner}/{repo}/hooks/{hook_id}/pings"], pingWebhook: ["POST /repos/{owner}/{repo}/hooks/{hook_id}/pings"],
redeliverWebhookDelivery: ["POST /repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts"],
removeAppAccessRestrictions: ["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", {}, { removeAppAccessRestrictions: ["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", {}, {
mapToData: "apps" mapToData: "apps"
}], }],
@ -1054,11 +792,7 @@ const Endpoints = {
}, },
search: { search: {
code: ["GET /search/code"], code: ["GET /search/code"],
commits: ["GET /search/commits", { commits: ["GET /search/commits"],
mediaType: {
previews: ["cloak"]
}
}],
issuesAndPullRequests: ["GET /search/issues"], issuesAndPullRequests: ["GET /search/issues"],
labels: ["GET /search/labels"], labels: ["GET /search/labels"],
repos: ["GET /search/repositories"], repos: ["GET /search/repositories"],
@ -1071,22 +805,15 @@ const Endpoints = {
}, },
secretScanning: { secretScanning: {
getAlert: ["GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}"], getAlert: ["GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}"],
listAlertsForOrg: ["GET /orgs/{org}/secret-scanning/alerts"],
listAlertsForRepo: ["GET /repos/{owner}/{repo}/secret-scanning/alerts"], listAlertsForRepo: ["GET /repos/{owner}/{repo}/secret-scanning/alerts"],
updateAlert: ["PATCH /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}"] updateAlert: ["PATCH /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}"]
}, },
teams: { teams: {
addOrUpdateMembershipForUserInOrg: ["PUT /orgs/{org}/teams/{team_slug}/memberships/{username}"], addOrUpdateMembershipForUserInOrg: ["PUT /orgs/{org}/teams/{team_slug}/memberships/{username}"],
addOrUpdateProjectPermissionsInOrg: ["PUT /orgs/{org}/teams/{team_slug}/projects/{project_id}", { addOrUpdateProjectPermissionsInOrg: ["PUT /orgs/{org}/teams/{team_slug}/projects/{project_id}"],
mediaType: {
previews: ["inertia"]
}
}],
addOrUpdateRepoPermissionsInOrg: ["PUT /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}"], addOrUpdateRepoPermissionsInOrg: ["PUT /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}"],
checkPermissionsForProjectInOrg: ["GET /orgs/{org}/teams/{team_slug}/projects/{project_id}", { checkPermissionsForProjectInOrg: ["GET /orgs/{org}/teams/{team_slug}/projects/{project_id}"],
mediaType: {
previews: ["inertia"]
}
}],
checkPermissionsForRepoInOrg: ["GET /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}"], checkPermissionsForRepoInOrg: ["GET /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}"],
create: ["POST /orgs/{org}/teams"], create: ["POST /orgs/{org}/teams"],
createDiscussionCommentInOrg: ["POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments"], createDiscussionCommentInOrg: ["POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments"],
@ -1105,11 +832,7 @@ const Endpoints = {
listForAuthenticatedUser: ["GET /user/teams"], listForAuthenticatedUser: ["GET /user/teams"],
listMembersInOrg: ["GET /orgs/{org}/teams/{team_slug}/members"], listMembersInOrg: ["GET /orgs/{org}/teams/{team_slug}/members"],
listPendingInvitationsInOrg: ["GET /orgs/{org}/teams/{team_slug}/invitations"], listPendingInvitationsInOrg: ["GET /orgs/{org}/teams/{team_slug}/invitations"],
listProjectsInOrg: ["GET /orgs/{org}/teams/{team_slug}/projects", { listProjectsInOrg: ["GET /orgs/{org}/teams/{team_slug}/projects"],
mediaType: {
previews: ["inertia"]
}
}],
listReposInOrg: ["GET /orgs/{org}/teams/{team_slug}/repos"], listReposInOrg: ["GET /orgs/{org}/teams/{team_slug}/repos"],
removeMembershipForUserInOrg: ["DELETE /orgs/{org}/teams/{team_slug}/memberships/{username}"], removeMembershipForUserInOrg: ["DELETE /orgs/{org}/teams/{team_slug}/memberships/{username}"],
removeProjectInOrg: ["DELETE /orgs/{org}/teams/{team_slug}/projects/{project_id}"], removeProjectInOrg: ["DELETE /orgs/{org}/teams/{team_slug}/projects/{project_id}"],
@ -1119,42 +842,87 @@ const Endpoints = {
updateInOrg: ["PATCH /orgs/{org}/teams/{team_slug}"] updateInOrg: ["PATCH /orgs/{org}/teams/{team_slug}"]
}, },
users: { users: {
addEmailForAuthenticated: ["POST /user/emails"], addEmailForAuthenticated: ["POST /user/emails", {}, {
renamed: ["users", "addEmailForAuthenticatedUser"]
}],
addEmailForAuthenticatedUser: ["POST /user/emails"],
block: ["PUT /user/blocks/{username}"], block: ["PUT /user/blocks/{username}"],
checkBlocked: ["GET /user/blocks/{username}"], checkBlocked: ["GET /user/blocks/{username}"],
checkFollowingForUser: ["GET /users/{username}/following/{target_user}"], checkFollowingForUser: ["GET /users/{username}/following/{target_user}"],
checkPersonIsFollowedByAuthenticated: ["GET /user/following/{username}"], checkPersonIsFollowedByAuthenticated: ["GET /user/following/{username}"],
createGpgKeyForAuthenticated: ["POST /user/gpg_keys"], createGpgKeyForAuthenticated: ["POST /user/gpg_keys", {}, {
createPublicSshKeyForAuthenticated: ["POST /user/keys"], renamed: ["users", "createGpgKeyForAuthenticatedUser"]
deleteEmailForAuthenticated: ["DELETE /user/emails"], }],
deleteGpgKeyForAuthenticated: ["DELETE /user/gpg_keys/{gpg_key_id}"], createGpgKeyForAuthenticatedUser: ["POST /user/gpg_keys"],
deletePublicSshKeyForAuthenticated: ["DELETE /user/keys/{key_id}"], createPublicSshKeyForAuthenticated: ["POST /user/keys", {}, {
renamed: ["users", "createPublicSshKeyForAuthenticatedUser"]
}],
createPublicSshKeyForAuthenticatedUser: ["POST /user/keys"],
deleteEmailForAuthenticated: ["DELETE /user/emails", {}, {
renamed: ["users", "deleteEmailForAuthenticatedUser"]
}],
deleteEmailForAuthenticatedUser: ["DELETE /user/emails"],
deleteGpgKeyForAuthenticated: ["DELETE /user/gpg_keys/{gpg_key_id}", {}, {
renamed: ["users", "deleteGpgKeyForAuthenticatedUser"]
}],
deleteGpgKeyForAuthenticatedUser: ["DELETE /user/gpg_keys/{gpg_key_id}"],
deletePublicSshKeyForAuthenticated: ["DELETE /user/keys/{key_id}", {}, {
renamed: ["users", "deletePublicSshKeyForAuthenticatedUser"]
}],
deletePublicSshKeyForAuthenticatedUser: ["DELETE /user/keys/{key_id}"],
follow: ["PUT /user/following/{username}"], follow: ["PUT /user/following/{username}"],
getAuthenticated: ["GET /user"], getAuthenticated: ["GET /user"],
getByUsername: ["GET /users/{username}"], getByUsername: ["GET /users/{username}"],
getContextForUser: ["GET /users/{username}/hovercard"], getContextForUser: ["GET /users/{username}/hovercard"],
getGpgKeyForAuthenticated: ["GET /user/gpg_keys/{gpg_key_id}"], getGpgKeyForAuthenticated: ["GET /user/gpg_keys/{gpg_key_id}", {}, {
getPublicSshKeyForAuthenticated: ["GET /user/keys/{key_id}"], renamed: ["users", "getGpgKeyForAuthenticatedUser"]
}],
getGpgKeyForAuthenticatedUser: ["GET /user/gpg_keys/{gpg_key_id}"],
getPublicSshKeyForAuthenticated: ["GET /user/keys/{key_id}", {}, {
renamed: ["users", "getPublicSshKeyForAuthenticatedUser"]
}],
getPublicSshKeyForAuthenticatedUser: ["GET /user/keys/{key_id}"],
list: ["GET /users"], list: ["GET /users"],
listBlockedByAuthenticated: ["GET /user/blocks"], listBlockedByAuthenticated: ["GET /user/blocks", {}, {
listEmailsForAuthenticated: ["GET /user/emails"], renamed: ["users", "listBlockedByAuthenticatedUser"]
listFollowedByAuthenticated: ["GET /user/following"], }],
listBlockedByAuthenticatedUser: ["GET /user/blocks"],
listEmailsForAuthenticated: ["GET /user/emails", {}, {
renamed: ["users", "listEmailsForAuthenticatedUser"]
}],
listEmailsForAuthenticatedUser: ["GET /user/emails"],
listFollowedByAuthenticated: ["GET /user/following", {}, {
renamed: ["users", "listFollowedByAuthenticatedUser"]
}],
listFollowedByAuthenticatedUser: ["GET /user/following"],
listFollowersForAuthenticatedUser: ["GET /user/followers"], listFollowersForAuthenticatedUser: ["GET /user/followers"],
listFollowersForUser: ["GET /users/{username}/followers"], listFollowersForUser: ["GET /users/{username}/followers"],
listFollowingForUser: ["GET /users/{username}/following"], listFollowingForUser: ["GET /users/{username}/following"],
listGpgKeysForAuthenticated: ["GET /user/gpg_keys"], listGpgKeysForAuthenticated: ["GET /user/gpg_keys", {}, {
renamed: ["users", "listGpgKeysForAuthenticatedUser"]
}],
listGpgKeysForAuthenticatedUser: ["GET /user/gpg_keys"],
listGpgKeysForUser: ["GET /users/{username}/gpg_keys"], listGpgKeysForUser: ["GET /users/{username}/gpg_keys"],
listPublicEmailsForAuthenticated: ["GET /user/public_emails"], listPublicEmailsForAuthenticated: ["GET /user/public_emails", {}, {
renamed: ["users", "listPublicEmailsForAuthenticatedUser"]
}],
listPublicEmailsForAuthenticatedUser: ["GET /user/public_emails"],
listPublicKeysForUser: ["GET /users/{username}/keys"], listPublicKeysForUser: ["GET /users/{username}/keys"],
listPublicSshKeysForAuthenticated: ["GET /user/keys"], listPublicSshKeysForAuthenticated: ["GET /user/keys", {}, {
setPrimaryEmailVisibilityForAuthenticated: ["PATCH /user/email/visibility"], renamed: ["users", "listPublicSshKeysForAuthenticatedUser"]
}],
listPublicSshKeysForAuthenticatedUser: ["GET /user/keys"],
setPrimaryEmailVisibilityForAuthenticated: ["PATCH /user/email/visibility", {}, {
renamed: ["users", "setPrimaryEmailVisibilityForAuthenticatedUser"]
}],
setPrimaryEmailVisibilityForAuthenticatedUser: ["PATCH /user/email/visibility"],
unblock: ["DELETE /user/blocks/{username}"], unblock: ["DELETE /user/blocks/{username}"],
unfollow: ["DELETE /user/following/{username}"], unfollow: ["DELETE /user/following/{username}"],
updateAuthenticated: ["PATCH /user"] updateAuthenticated: ["PATCH /user"]
} }
}; };
const VERSION = "5.3.0"; const VERSION = "5.13.0";
function endpointsToMethods(octokit, endpointsMap) { function endpointsToMethods(octokit, endpointsMap) {
const newMethods = {}; const newMethods = {};

File diff suppressed because one or more lines are too long

View File

@ -61,6 +61,9 @@ const Endpoints = {
downloadJobLogsForWorkflowRun: [ downloadJobLogsForWorkflowRun: [
"GET /repos/{owner}/{repo}/actions/jobs/{job_id}/logs", "GET /repos/{owner}/{repo}/actions/jobs/{job_id}/logs",
], ],
downloadWorkflowRunAttemptLogs: [
"GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs",
],
downloadWorkflowRunLogs: [ downloadWorkflowRunLogs: [
"GET /repos/{owner}/{repo}/actions/runs/{run_id}/logs", "GET /repos/{owner}/{repo}/actions/runs/{run_id}/logs",
], ],
@ -111,6 +114,9 @@ const Endpoints = {
], ],
getWorkflow: ["GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}"], getWorkflow: ["GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}"],
getWorkflowRun: ["GET /repos/{owner}/{repo}/actions/runs/{run_id}"], getWorkflowRun: ["GET /repos/{owner}/{repo}/actions/runs/{run_id}"],
getWorkflowRunAttempt: [
"GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}",
],
getWorkflowRunUsage: [ getWorkflowRunUsage: [
"GET /repos/{owner}/{repo}/actions/runs/{run_id}/timing", "GET /repos/{owner}/{repo}/actions/runs/{run_id}/timing",
], ],
@ -124,6 +130,9 @@ const Endpoints = {
listJobsForWorkflowRun: [ listJobsForWorkflowRun: [
"GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs", "GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs",
], ],
listJobsForWorkflowRunAttempt: [
"GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs",
],
listOrgSecrets: ["GET /orgs/{org}/actions/secrets"], listOrgSecrets: ["GET /orgs/{org}/actions/secrets"],
listRepoSecrets: ["GET /repos/{owner}/{repo}/actions/secrets"], listRepoSecrets: ["GET /repos/{owner}/{repo}/actions/secrets"],
listRepoWorkflows: ["GET /repos/{owner}/{repo}/actions/workflows"], listRepoWorkflows: ["GET /repos/{owner}/{repo}/actions/workflows"],
@ -146,7 +155,6 @@ const Endpoints = {
"GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs", "GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs",
], ],
listWorkflowRunsForRepo: ["GET /repos/{owner}/{repo}/actions/runs"], listWorkflowRunsForRepo: ["GET /repos/{owner}/{repo}/actions/runs"],
reRunWorkflow: ["POST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun"],
removeSelectedRepoFromOrgSecret: [ removeSelectedRepoFromOrgSecret: [
"DELETE /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", "DELETE /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}",
], ],
@ -220,6 +228,11 @@ const Endpoints = {
apps: { apps: {
addRepoToInstallation: [ addRepoToInstallation: [
"PUT /user/installations/{installation_id}/repositories/{repository_id}", "PUT /user/installations/{installation_id}/repositories/{repository_id}",
{},
{ renamed: ["apps", "addRepoToInstallationForAuthenticatedUser"] },
],
addRepoToInstallationForAuthenticatedUser: [
"PUT /user/installations/{installation_id}/repositories/{repository_id}",
], ],
checkToken: ["POST /applications/{client_id}/token"], checkToken: ["POST /applications/{client_id}/token"],
createContentAttachment: [ createContentAttachment: [
@ -250,6 +263,7 @@ const Endpoints = {
], ],
getUserInstallation: ["GET /users/{username}/installation"], getUserInstallation: ["GET /users/{username}/installation"],
getWebhookConfigForApp: ["GET /app/hook/config"], getWebhookConfigForApp: ["GET /app/hook/config"],
getWebhookDelivery: ["GET /app/hook/deliveries/{delivery_id}"],
listAccountsForPlan: ["GET /marketplace_listing/plans/{plan_id}/accounts"], listAccountsForPlan: ["GET /marketplace_listing/plans/{plan_id}/accounts"],
listAccountsForPlanStubbed: [ listAccountsForPlanStubbed: [
"GET /marketplace_listing/stubbed/plans/{plan_id}/accounts", "GET /marketplace_listing/stubbed/plans/{plan_id}/accounts",
@ -266,8 +280,17 @@ const Endpoints = {
listSubscriptionsForAuthenticatedUserStubbed: [ listSubscriptionsForAuthenticatedUserStubbed: [
"GET /user/marketplace_purchases/stubbed", "GET /user/marketplace_purchases/stubbed",
], ],
listWebhookDeliveries: ["GET /app/hook/deliveries"],
redeliverWebhookDelivery: [
"POST /app/hook/deliveries/{delivery_id}/attempts",
],
removeRepoFromInstallation: [ removeRepoFromInstallation: [
"DELETE /user/installations/{installation_id}/repositories/{repository_id}", "DELETE /user/installations/{installation_id}/repositories/{repository_id}",
{},
{ renamed: ["apps", "removeRepoFromInstallationForAuthenticatedUser"] },
],
removeRepoFromInstallationForAuthenticatedUser: [
"DELETE /user/installations/{installation_id}/repositories/{repository_id}",
], ],
resetToken: ["PATCH /applications/{client_id}/token"], resetToken: ["PATCH /applications/{client_id}/token"],
revokeInstallationAccessToken: ["DELETE /installation/token"], revokeInstallationAccessToken: ["DELETE /installation/token"],
@ -307,6 +330,9 @@ const Endpoints = {
"GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs", "GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs",
], ],
listSuitesForRef: ["GET /repos/{owner}/{repo}/commits/{ref}/check-suites"], listSuitesForRef: ["GET /repos/{owner}/{repo}/commits/{ref}/check-suites"],
rerequestRun: [
"POST /repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest",
],
rerequestSuite: [ rerequestSuite: [
"POST /repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest", "POST /repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest",
], ],
@ -344,18 +370,8 @@ const Endpoints = {
uploadSarif: ["POST /repos/{owner}/{repo}/code-scanning/sarifs"], uploadSarif: ["POST /repos/{owner}/{repo}/code-scanning/sarifs"],
}, },
codesOfConduct: { codesOfConduct: {
getAllCodesOfConduct: [ getAllCodesOfConduct: ["GET /codes_of_conduct"],
"GET /codes_of_conduct", getConductCode: ["GET /codes_of_conduct/{key}"],
{ mediaType: { previews: ["scarlet-witch"] } },
],
getConductCode: [
"GET /codes_of_conduct/{key}",
{ mediaType: { previews: ["scarlet-witch"] } },
],
getForRepo: [
"GET /repos/{owner}/{repo}/community/code_of_conduct",
{ mediaType: { previews: ["scarlet-witch"] } },
],
}, },
emojis: { get: ["GET /emojis"] }, emojis: { get: ["GET /emojis"] },
enterpriseAdmin: { enterpriseAdmin: {
@ -485,7 +501,6 @@ const Endpoints = {
listEventsForRepo: ["GET /repos/{owner}/{repo}/issues/events"], listEventsForRepo: ["GET /repos/{owner}/{repo}/issues/events"],
listEventsForTimeline: [ listEventsForTimeline: [
"GET /repos/{owner}/{repo}/issues/{issue_number}/timeline", "GET /repos/{owner}/{repo}/issues/{issue_number}/timeline",
{ mediaType: { previews: ["mockingbird"] } },
], ],
listForAuthenticatedUser: ["GET /user/issues"], listForAuthenticatedUser: ["GET /user/issues"],
listForOrg: ["GET /orgs/{org}/issues"], listForOrg: ["GET /orgs/{org}/issues"],
@ -539,46 +554,31 @@ const Endpoints = {
cancelImport: ["DELETE /repos/{owner}/{repo}/import"], cancelImport: ["DELETE /repos/{owner}/{repo}/import"],
deleteArchiveForAuthenticatedUser: [ deleteArchiveForAuthenticatedUser: [
"DELETE /user/migrations/{migration_id}/archive", "DELETE /user/migrations/{migration_id}/archive",
{ mediaType: { previews: ["wyandotte"] } },
], ],
deleteArchiveForOrg: [ deleteArchiveForOrg: [
"DELETE /orgs/{org}/migrations/{migration_id}/archive", "DELETE /orgs/{org}/migrations/{migration_id}/archive",
{ mediaType: { previews: ["wyandotte"] } },
], ],
downloadArchiveForOrg: [ downloadArchiveForOrg: [
"GET /orgs/{org}/migrations/{migration_id}/archive", "GET /orgs/{org}/migrations/{migration_id}/archive",
{ mediaType: { previews: ["wyandotte"] } },
], ],
getArchiveForAuthenticatedUser: [ getArchiveForAuthenticatedUser: [
"GET /user/migrations/{migration_id}/archive", "GET /user/migrations/{migration_id}/archive",
{ mediaType: { previews: ["wyandotte"] } },
], ],
getCommitAuthors: ["GET /repos/{owner}/{repo}/import/authors"], getCommitAuthors: ["GET /repos/{owner}/{repo}/import/authors"],
getImportStatus: ["GET /repos/{owner}/{repo}/import"], getImportStatus: ["GET /repos/{owner}/{repo}/import"],
getLargeFiles: ["GET /repos/{owner}/{repo}/import/large_files"], getLargeFiles: ["GET /repos/{owner}/{repo}/import/large_files"],
getStatusForAuthenticatedUser: [ getStatusForAuthenticatedUser: ["GET /user/migrations/{migration_id}"],
"GET /user/migrations/{migration_id}", getStatusForOrg: ["GET /orgs/{org}/migrations/{migration_id}"],
{ mediaType: { previews: ["wyandotte"] } }, listForAuthenticatedUser: ["GET /user/migrations"],
], listForOrg: ["GET /orgs/{org}/migrations"],
getStatusForOrg: [ listReposForAuthenticatedUser: [
"GET /orgs/{org}/migrations/{migration_id}", "GET /user/migrations/{migration_id}/repositories",
{ mediaType: { previews: ["wyandotte"] } },
],
listForAuthenticatedUser: [
"GET /user/migrations",
{ mediaType: { previews: ["wyandotte"] } },
],
listForOrg: [
"GET /orgs/{org}/migrations",
{ mediaType: { previews: ["wyandotte"] } },
],
listReposForOrg: [
"GET /orgs/{org}/migrations/{migration_id}/repositories",
{ mediaType: { previews: ["wyandotte"] } },
], ],
listReposForOrg: ["GET /orgs/{org}/migrations/{migration_id}/repositories"],
listReposForUser: [ listReposForUser: [
"GET /user/migrations/{migration_id}/repositories", "GET /user/migrations/{migration_id}/repositories",
{ mediaType: { previews: ["wyandotte"] } }, {},
{ renamed: ["migrations", "listReposForAuthenticatedUser"] },
], ],
mapCommitAuthor: ["PATCH /repos/{owner}/{repo}/import/authors/{author_id}"], mapCommitAuthor: ["PATCH /repos/{owner}/{repo}/import/authors/{author_id}"],
setLfsPreference: ["PATCH /repos/{owner}/{repo}/import/lfs"], setLfsPreference: ["PATCH /repos/{owner}/{repo}/import/lfs"],
@ -587,11 +587,9 @@ const Endpoints = {
startImport: ["PUT /repos/{owner}/{repo}/import"], startImport: ["PUT /repos/{owner}/{repo}/import"],
unlockRepoForAuthenticatedUser: [ unlockRepoForAuthenticatedUser: [
"DELETE /user/migrations/{migration_id}/repos/{repo_name}/lock", "DELETE /user/migrations/{migration_id}/repos/{repo_name}/lock",
{ mediaType: { previews: ["wyandotte"] } },
], ],
unlockRepoForOrg: [ unlockRepoForOrg: [
"DELETE /orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock", "DELETE /orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock",
{ mediaType: { previews: ["wyandotte"] } },
], ],
updateImport: ["PATCH /repos/{owner}/{repo}/import"], updateImport: ["PATCH /repos/{owner}/{repo}/import"],
}, },
@ -612,6 +610,9 @@ const Endpoints = {
getMembershipForUser: ["GET /orgs/{org}/memberships/{username}"], getMembershipForUser: ["GET /orgs/{org}/memberships/{username}"],
getWebhook: ["GET /orgs/{org}/hooks/{hook_id}"], getWebhook: ["GET /orgs/{org}/hooks/{hook_id}"],
getWebhookConfigForOrg: ["GET /orgs/{org}/hooks/{hook_id}/config"], getWebhookConfigForOrg: ["GET /orgs/{org}/hooks/{hook_id}/config"],
getWebhookDelivery: [
"GET /orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}",
],
list: ["GET /organizations"], list: ["GET /organizations"],
listAppInstallations: ["GET /orgs/{org}/installations"], listAppInstallations: ["GET /orgs/{org}/installations"],
listBlockedUsers: ["GET /orgs/{org}/blocks"], listBlockedUsers: ["GET /orgs/{org}/blocks"],
@ -624,8 +625,12 @@ const Endpoints = {
listOutsideCollaborators: ["GET /orgs/{org}/outside_collaborators"], listOutsideCollaborators: ["GET /orgs/{org}/outside_collaborators"],
listPendingInvitations: ["GET /orgs/{org}/invitations"], listPendingInvitations: ["GET /orgs/{org}/invitations"],
listPublicMembers: ["GET /orgs/{org}/public_members"], listPublicMembers: ["GET /orgs/{org}/public_members"],
listWebhookDeliveries: ["GET /orgs/{org}/hooks/{hook_id}/deliveries"],
listWebhooks: ["GET /orgs/{org}/hooks"], listWebhooks: ["GET /orgs/{org}/hooks"],
pingWebhook: ["POST /orgs/{org}/hooks/{hook_id}/pings"], pingWebhook: ["POST /orgs/{org}/hooks/{hook_id}/pings"],
redeliverWebhookDelivery: [
"POST /orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts",
],
removeMember: ["DELETE /orgs/{org}/members/{username}"], removeMember: ["DELETE /orgs/{org}/members/{username}"],
removeMembershipForUser: ["DELETE /orgs/{org}/memberships/{username}"], removeMembershipForUser: ["DELETE /orgs/{org}/memberships/{username}"],
removeOutsideCollaborator: [ removeOutsideCollaborator: [
@ -653,12 +658,18 @@ const Endpoints = {
deletePackageForOrg: [ deletePackageForOrg: [
"DELETE /orgs/{org}/packages/{package_type}/{package_name}", "DELETE /orgs/{org}/packages/{package_type}/{package_name}",
], ],
deletePackageForUser: [
"DELETE /users/{username}/packages/{package_type}/{package_name}",
],
deletePackageVersionForAuthenticatedUser: [ deletePackageVersionForAuthenticatedUser: [
"DELETE /user/packages/{package_type}/{package_name}/versions/{package_version_id}", "DELETE /user/packages/{package_type}/{package_name}/versions/{package_version_id}",
], ],
deletePackageVersionForOrg: [ deletePackageVersionForOrg: [
"DELETE /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}", "DELETE /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}",
], ],
deletePackageVersionForUser: [
"DELETE /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}",
],
getAllPackageVersionsForAPackageOwnedByAnOrg: [ getAllPackageVersionsForAPackageOwnedByAnOrg: [
"GET /orgs/{org}/packages/{package_type}/{package_name}/versions", "GET /orgs/{org}/packages/{package_type}/{package_name}/versions",
{}, {},
@ -701,120 +712,58 @@ const Endpoints = {
getPackageVersionForUser: [ getPackageVersionForUser: [
"GET /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}", "GET /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}",
], ],
listPackagesForAuthenticatedUser: ["GET /user/packages"],
listPackagesForOrganization: ["GET /orgs/{org}/packages"],
listPackagesForUser: ["GET /users/{username}/packages"],
restorePackageForAuthenticatedUser: [ restorePackageForAuthenticatedUser: [
"POST /user/packages/{package_type}/{package_name}/restore{?token}", "POST /user/packages/{package_type}/{package_name}/restore{?token}",
], ],
restorePackageForOrg: [ restorePackageForOrg: [
"POST /orgs/{org}/packages/{package_type}/{package_name}/restore{?token}", "POST /orgs/{org}/packages/{package_type}/{package_name}/restore{?token}",
], ],
restorePackageForUser: [
"POST /users/{username}/packages/{package_type}/{package_name}/restore{?token}",
],
restorePackageVersionForAuthenticatedUser: [ restorePackageVersionForAuthenticatedUser: [
"POST /user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore", "POST /user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore",
], ],
restorePackageVersionForOrg: [ restorePackageVersionForOrg: [
"POST /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore", "POST /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore",
], ],
restorePackageVersionForUser: [
"POST /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore",
],
}, },
projects: { projects: {
addCollaborator: [ addCollaborator: ["PUT /projects/{project_id}/collaborators/{username}"],
"PUT /projects/{project_id}/collaborators/{username}", createCard: ["POST /projects/columns/{column_id}/cards"],
{ mediaType: { previews: ["inertia"] } }, createColumn: ["POST /projects/{project_id}/columns"],
], createForAuthenticatedUser: ["POST /user/projects"],
createCard: [ createForOrg: ["POST /orgs/{org}/projects"],
"POST /projects/columns/{column_id}/cards", createForRepo: ["POST /repos/{owner}/{repo}/projects"],
{ mediaType: { previews: ["inertia"] } }, delete: ["DELETE /projects/{project_id}"],
], deleteCard: ["DELETE /projects/columns/cards/{card_id}"],
createColumn: [ deleteColumn: ["DELETE /projects/columns/{column_id}"],
"POST /projects/{project_id}/columns", get: ["GET /projects/{project_id}"],
{ mediaType: { previews: ["inertia"] } }, getCard: ["GET /projects/columns/cards/{card_id}"],
], getColumn: ["GET /projects/columns/{column_id}"],
createForAuthenticatedUser: [
"POST /user/projects",
{ mediaType: { previews: ["inertia"] } },
],
createForOrg: [
"POST /orgs/{org}/projects",
{ mediaType: { previews: ["inertia"] } },
],
createForRepo: [
"POST /repos/{owner}/{repo}/projects",
{ mediaType: { previews: ["inertia"] } },
],
delete: [
"DELETE /projects/{project_id}",
{ mediaType: { previews: ["inertia"] } },
],
deleteCard: [
"DELETE /projects/columns/cards/{card_id}",
{ mediaType: { previews: ["inertia"] } },
],
deleteColumn: [
"DELETE /projects/columns/{column_id}",
{ mediaType: { previews: ["inertia"] } },
],
get: [
"GET /projects/{project_id}",
{ mediaType: { previews: ["inertia"] } },
],
getCard: [
"GET /projects/columns/cards/{card_id}",
{ mediaType: { previews: ["inertia"] } },
],
getColumn: [
"GET /projects/columns/{column_id}",
{ mediaType: { previews: ["inertia"] } },
],
getPermissionForUser: [ getPermissionForUser: [
"GET /projects/{project_id}/collaborators/{username}/permission", "GET /projects/{project_id}/collaborators/{username}/permission",
{ mediaType: { previews: ["inertia"] } },
],
listCards: [
"GET /projects/columns/{column_id}/cards",
{ mediaType: { previews: ["inertia"] } },
],
listCollaborators: [
"GET /projects/{project_id}/collaborators",
{ mediaType: { previews: ["inertia"] } },
],
listColumns: [
"GET /projects/{project_id}/columns",
{ mediaType: { previews: ["inertia"] } },
],
listForOrg: [
"GET /orgs/{org}/projects",
{ mediaType: { previews: ["inertia"] } },
],
listForRepo: [
"GET /repos/{owner}/{repo}/projects",
{ mediaType: { previews: ["inertia"] } },
],
listForUser: [
"GET /users/{username}/projects",
{ mediaType: { previews: ["inertia"] } },
],
moveCard: [
"POST /projects/columns/cards/{card_id}/moves",
{ mediaType: { previews: ["inertia"] } },
],
moveColumn: [
"POST /projects/columns/{column_id}/moves",
{ mediaType: { previews: ["inertia"] } },
], ],
listCards: ["GET /projects/columns/{column_id}/cards"],
listCollaborators: ["GET /projects/{project_id}/collaborators"],
listColumns: ["GET /projects/{project_id}/columns"],
listForOrg: ["GET /orgs/{org}/projects"],
listForRepo: ["GET /repos/{owner}/{repo}/projects"],
listForUser: ["GET /users/{username}/projects"],
moveCard: ["POST /projects/columns/cards/{card_id}/moves"],
moveColumn: ["POST /projects/columns/{column_id}/moves"],
removeCollaborator: [ removeCollaborator: [
"DELETE /projects/{project_id}/collaborators/{username}", "DELETE /projects/{project_id}/collaborators/{username}",
{ mediaType: { previews: ["inertia"] } },
],
update: [
"PATCH /projects/{project_id}",
{ mediaType: { previews: ["inertia"] } },
],
updateCard: [
"PATCH /projects/columns/cards/{card_id}",
{ mediaType: { previews: ["inertia"] } },
],
updateColumn: [
"PATCH /projects/columns/{column_id}",
{ mediaType: { previews: ["inertia"] } },
], ],
update: ["PATCH /projects/{project_id}"],
updateCard: ["PATCH /projects/columns/cards/{card_id}"],
updateColumn: ["PATCH /projects/columns/{column_id}"],
}, },
pulls: { pulls: {
checkIfMerged: ["GET /repos/{owner}/{repo}/pulls/{pull_number}/merge"], checkIfMerged: ["GET /repos/{owner}/{repo}/pulls/{pull_number}/merge"],
@ -867,7 +816,6 @@ const Endpoints = {
update: ["PATCH /repos/{owner}/{repo}/pulls/{pull_number}"], update: ["PATCH /repos/{owner}/{repo}/pulls/{pull_number}"],
updateBranch: [ updateBranch: [
"PUT /repos/{owner}/{repo}/pulls/{pull_number}/update-branch", "PUT /repos/{owner}/{repo}/pulls/{pull_number}/update-branch",
{ mediaType: { previews: ["lydian"] } },
], ],
updateReview: [ updateReview: [
"PUT /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", "PUT /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}",
@ -880,90 +828,69 @@ const Endpoints = {
reactions: { reactions: {
createForCommitComment: [ createForCommitComment: [
"POST /repos/{owner}/{repo}/comments/{comment_id}/reactions", "POST /repos/{owner}/{repo}/comments/{comment_id}/reactions",
{ mediaType: { previews: ["squirrel-girl"] } },
], ],
createForIssue: [ createForIssue: [
"POST /repos/{owner}/{repo}/issues/{issue_number}/reactions", "POST /repos/{owner}/{repo}/issues/{issue_number}/reactions",
{ mediaType: { previews: ["squirrel-girl"] } },
], ],
createForIssueComment: [ createForIssueComment: [
"POST /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", "POST /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions",
{ mediaType: { previews: ["squirrel-girl"] } },
], ],
createForPullRequestReviewComment: [ createForPullRequestReviewComment: [
"POST /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", "POST /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions",
{ mediaType: { previews: ["squirrel-girl"] } },
], ],
createForRelease: [ createForRelease: [
"POST /repos/{owner}/{repo}/releases/{release_id}/reactions", "POST /repos/{owner}/{repo}/releases/{release_id}/reactions",
{ mediaType: { previews: ["squirrel-girl"] } },
], ],
createForTeamDiscussionCommentInOrg: [ createForTeamDiscussionCommentInOrg: [
"POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", "POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions",
{ mediaType: { previews: ["squirrel-girl"] } },
], ],
createForTeamDiscussionInOrg: [ createForTeamDiscussionInOrg: [
"POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", "POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions",
{ mediaType: { previews: ["squirrel-girl"] } },
], ],
deleteForCommitComment: [ deleteForCommitComment: [
"DELETE /repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}", "DELETE /repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}",
{ mediaType: { previews: ["squirrel-girl"] } },
], ],
deleteForIssue: [ deleteForIssue: [
"DELETE /repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}", "DELETE /repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}",
{ mediaType: { previews: ["squirrel-girl"] } },
], ],
deleteForIssueComment: [ deleteForIssueComment: [
"DELETE /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}", "DELETE /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}",
{ mediaType: { previews: ["squirrel-girl"] } },
], ],
deleteForPullRequestComment: [ deleteForPullRequestComment: [
"DELETE /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}", "DELETE /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}",
{ mediaType: { previews: ["squirrel-girl"] } },
], ],
deleteForTeamDiscussion: [ deleteForTeamDiscussion: [
"DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}", "DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}",
{ mediaType: { previews: ["squirrel-girl"] } },
], ],
deleteForTeamDiscussionComment: [ deleteForTeamDiscussionComment: [
"DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}", "DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}",
{ mediaType: { previews: ["squirrel-girl"] } },
],
deleteLegacy: [
"DELETE /reactions/{reaction_id}",
{ mediaType: { previews: ["squirrel-girl"] } },
{
deprecated: "octokit.rest.reactions.deleteLegacy() is deprecated, see https://docs.github.com/rest/reference/reactions/#delete-a-reaction-legacy",
},
], ],
listForCommitComment: [ listForCommitComment: [
"GET /repos/{owner}/{repo}/comments/{comment_id}/reactions", "GET /repos/{owner}/{repo}/comments/{comment_id}/reactions",
{ mediaType: { previews: ["squirrel-girl"] } },
],
listForIssue: [
"GET /repos/{owner}/{repo}/issues/{issue_number}/reactions",
{ mediaType: { previews: ["squirrel-girl"] } },
], ],
listForIssue: ["GET /repos/{owner}/{repo}/issues/{issue_number}/reactions"],
listForIssueComment: [ listForIssueComment: [
"GET /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", "GET /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions",
{ mediaType: { previews: ["squirrel-girl"] } },
], ],
listForPullRequestReviewComment: [ listForPullRequestReviewComment: [
"GET /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", "GET /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions",
{ mediaType: { previews: ["squirrel-girl"] } },
], ],
listForTeamDiscussionCommentInOrg: [ listForTeamDiscussionCommentInOrg: [
"GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions",
{ mediaType: { previews: ["squirrel-girl"] } },
], ],
listForTeamDiscussionInOrg: [ listForTeamDiscussionInOrg: [
"GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions",
{ mediaType: { previews: ["squirrel-girl"] } },
], ],
}, },
repos: { repos: {
acceptInvitation: ["PATCH /user/repository_invitations/{invitation_id}"], acceptInvitation: [
"PATCH /user/repository_invitations/{invitation_id}",
{},
{ renamed: ["repos", "acceptInvitationForAuthenticatedUser"] },
],
acceptInvitationForAuthenticatedUser: [
"PATCH /user/repository_invitations/{invitation_id}",
],
addAppAccessRestrictions: [ addAppAccessRestrictions: [
"POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", "POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps",
{}, {},
@ -988,18 +915,17 @@ const Endpoints = {
checkCollaborator: ["GET /repos/{owner}/{repo}/collaborators/{username}"], checkCollaborator: ["GET /repos/{owner}/{repo}/collaborators/{username}"],
checkVulnerabilityAlerts: [ checkVulnerabilityAlerts: [
"GET /repos/{owner}/{repo}/vulnerability-alerts", "GET /repos/{owner}/{repo}/vulnerability-alerts",
{ mediaType: { previews: ["dorian"] } },
], ],
compareCommits: ["GET /repos/{owner}/{repo}/compare/{base}...{head}"], compareCommits: ["GET /repos/{owner}/{repo}/compare/{base}...{head}"],
compareCommitsWithBasehead: [ compareCommitsWithBasehead: [
"GET /repos/{owner}/{repo}/compare/{basehead}", "GET /repos/{owner}/{repo}/compare/{basehead}",
], ],
createAutolink: ["POST /repos/{owner}/{repo}/autolinks"],
createCommitComment: [ createCommitComment: [
"POST /repos/{owner}/{repo}/commits/{commit_sha}/comments", "POST /repos/{owner}/{repo}/commits/{commit_sha}/comments",
], ],
createCommitSignatureProtection: [ createCommitSignatureProtection: [
"POST /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", "POST /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures",
{ mediaType: { previews: ["zzzax"] } },
], ],
createCommitStatus: ["POST /repos/{owner}/{repo}/statuses/{sha}"], createCommitStatus: ["POST /repos/{owner}/{repo}/statuses/{sha}"],
createDeployKey: ["POST /repos/{owner}/{repo}/keys"], createDeployKey: ["POST /repos/{owner}/{repo}/keys"],
@ -1015,17 +941,20 @@ const Endpoints = {
"PUT /repos/{owner}/{repo}/environments/{environment_name}", "PUT /repos/{owner}/{repo}/environments/{environment_name}",
], ],
createOrUpdateFileContents: ["PUT /repos/{owner}/{repo}/contents/{path}"], createOrUpdateFileContents: ["PUT /repos/{owner}/{repo}/contents/{path}"],
createPagesSite: [ createPagesSite: ["POST /repos/{owner}/{repo}/pages"],
"POST /repos/{owner}/{repo}/pages",
{ mediaType: { previews: ["switcheroo"] } },
],
createRelease: ["POST /repos/{owner}/{repo}/releases"], createRelease: ["POST /repos/{owner}/{repo}/releases"],
createUsingTemplate: [ createUsingTemplate: [
"POST /repos/{template_owner}/{template_repo}/generate", "POST /repos/{template_owner}/{template_repo}/generate",
{ mediaType: { previews: ["baptiste"] } },
], ],
createWebhook: ["POST /repos/{owner}/{repo}/hooks"], createWebhook: ["POST /repos/{owner}/{repo}/hooks"],
declineInvitation: ["DELETE /user/repository_invitations/{invitation_id}"], declineInvitation: [
"DELETE /user/repository_invitations/{invitation_id}",
{},
{ renamed: ["repos", "declineInvitationForAuthenticatedUser"] },
],
declineInvitationForAuthenticatedUser: [
"DELETE /user/repository_invitations/{invitation_id}",
],
delete: ["DELETE /repos/{owner}/{repo}"], delete: ["DELETE /repos/{owner}/{repo}"],
deleteAccessRestrictions: [ deleteAccessRestrictions: [
"DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions", "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions",
@ -1036,13 +965,13 @@ const Endpoints = {
deleteAnEnvironment: [ deleteAnEnvironment: [
"DELETE /repos/{owner}/{repo}/environments/{environment_name}", "DELETE /repos/{owner}/{repo}/environments/{environment_name}",
], ],
deleteAutolink: ["DELETE /repos/{owner}/{repo}/autolinks/{autolink_id}"],
deleteBranchProtection: [ deleteBranchProtection: [
"DELETE /repos/{owner}/{repo}/branches/{branch}/protection", "DELETE /repos/{owner}/{repo}/branches/{branch}/protection",
], ],
deleteCommitComment: ["DELETE /repos/{owner}/{repo}/comments/{comment_id}"], deleteCommitComment: ["DELETE /repos/{owner}/{repo}/comments/{comment_id}"],
deleteCommitSignatureProtection: [ deleteCommitSignatureProtection: [
"DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures",
{ mediaType: { previews: ["zzzax"] } },
], ],
deleteDeployKey: ["DELETE /repos/{owner}/{repo}/keys/{key_id}"], deleteDeployKey: ["DELETE /repos/{owner}/{repo}/keys/{key_id}"],
deleteDeployment: [ deleteDeployment: [
@ -1052,10 +981,7 @@ const Endpoints = {
deleteInvitation: [ deleteInvitation: [
"DELETE /repos/{owner}/{repo}/invitations/{invitation_id}", "DELETE /repos/{owner}/{repo}/invitations/{invitation_id}",
], ],
deletePagesSite: [ deletePagesSite: ["DELETE /repos/{owner}/{repo}/pages"],
"DELETE /repos/{owner}/{repo}/pages",
{ mediaType: { previews: ["switcheroo"] } },
],
deletePullRequestReviewProtection: [ deletePullRequestReviewProtection: [
"DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews",
], ],
@ -1066,11 +992,10 @@ const Endpoints = {
deleteWebhook: ["DELETE /repos/{owner}/{repo}/hooks/{hook_id}"], deleteWebhook: ["DELETE /repos/{owner}/{repo}/hooks/{hook_id}"],
disableAutomatedSecurityFixes: [ disableAutomatedSecurityFixes: [
"DELETE /repos/{owner}/{repo}/automated-security-fixes", "DELETE /repos/{owner}/{repo}/automated-security-fixes",
{ mediaType: { previews: ["london"] } },
], ],
disableLfsForRepo: ["DELETE /repos/{owner}/{repo}/lfs"],
disableVulnerabilityAlerts: [ disableVulnerabilityAlerts: [
"DELETE /repos/{owner}/{repo}/vulnerability-alerts", "DELETE /repos/{owner}/{repo}/vulnerability-alerts",
{ mediaType: { previews: ["dorian"] } },
], ],
downloadArchive: [ downloadArchive: [
"GET /repos/{owner}/{repo}/zipball/{ref}", "GET /repos/{owner}/{repo}/zipball/{ref}",
@ -1081,11 +1006,13 @@ const Endpoints = {
downloadZipballArchive: ["GET /repos/{owner}/{repo}/zipball/{ref}"], downloadZipballArchive: ["GET /repos/{owner}/{repo}/zipball/{ref}"],
enableAutomatedSecurityFixes: [ enableAutomatedSecurityFixes: [
"PUT /repos/{owner}/{repo}/automated-security-fixes", "PUT /repos/{owner}/{repo}/automated-security-fixes",
{ mediaType: { previews: ["london"] } },
], ],
enableLfsForRepo: ["PUT /repos/{owner}/{repo}/lfs"],
enableVulnerabilityAlerts: [ enableVulnerabilityAlerts: [
"PUT /repos/{owner}/{repo}/vulnerability-alerts", "PUT /repos/{owner}/{repo}/vulnerability-alerts",
{ mediaType: { previews: ["dorian"] } }, ],
generateReleaseNotes: [
"POST /repos/{owner}/{repo}/releases/generate-notes",
], ],
get: ["GET /repos/{owner}/{repo}"], get: ["GET /repos/{owner}/{repo}"],
getAccessRestrictions: [ getAccessRestrictions: [
@ -1105,6 +1032,7 @@ const Endpoints = {
getAppsWithAccessToProtectedBranch: [ getAppsWithAccessToProtectedBranch: [
"GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", "GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps",
], ],
getAutolink: ["GET /repos/{owner}/{repo}/autolinks/{autolink_id}"],
getBranch: ["GET /repos/{owner}/{repo}/branches/{branch}"], getBranch: ["GET /repos/{owner}/{repo}/branches/{branch}"],
getBranchProtection: [ getBranchProtection: [
"GET /repos/{owner}/{repo}/branches/{branch}/protection", "GET /repos/{owner}/{repo}/branches/{branch}/protection",
@ -1120,7 +1048,6 @@ const Endpoints = {
getCommitComment: ["GET /repos/{owner}/{repo}/comments/{comment_id}"], getCommitComment: ["GET /repos/{owner}/{repo}/comments/{comment_id}"],
getCommitSignatureProtection: [ getCommitSignatureProtection: [
"GET /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", "GET /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures",
{ mediaType: { previews: ["zzzax"] } },
], ],
getCommunityProfileMetrics: ["GET /repos/{owner}/{repo}/community/profile"], getCommunityProfileMetrics: ["GET /repos/{owner}/{repo}/community/profile"],
getContent: ["GET /repos/{owner}/{repo}/contents/{path}"], getContent: ["GET /repos/{owner}/{repo}/contents/{path}"],
@ -1164,10 +1091,13 @@ const Endpoints = {
getWebhookConfigForRepo: [ getWebhookConfigForRepo: [
"GET /repos/{owner}/{repo}/hooks/{hook_id}/config", "GET /repos/{owner}/{repo}/hooks/{hook_id}/config",
], ],
getWebhookDelivery: [
"GET /repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}",
],
listAutolinks: ["GET /repos/{owner}/{repo}/autolinks"],
listBranches: ["GET /repos/{owner}/{repo}/branches"], listBranches: ["GET /repos/{owner}/{repo}/branches"],
listBranchesForHeadCommit: [ listBranchesForHeadCommit: [
"GET /repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head", "GET /repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head",
{ mediaType: { previews: ["groot"] } },
], ],
listCollaborators: ["GET /repos/{owner}/{repo}/collaborators"], listCollaborators: ["GET /repos/{owner}/{repo}/collaborators"],
listCommentsForCommit: [ listCommentsForCommit: [
@ -1195,7 +1125,6 @@ const Endpoints = {
listPublic: ["GET /repositories"], listPublic: ["GET /repositories"],
listPullRequestsAssociatedWithCommit: [ listPullRequestsAssociatedWithCommit: [
"GET /repos/{owner}/{repo}/commits/{commit_sha}/pulls", "GET /repos/{owner}/{repo}/commits/{commit_sha}/pulls",
{ mediaType: { previews: ["groot"] } },
], ],
listReleaseAssets: [ listReleaseAssets: [
"GET /repos/{owner}/{repo}/releases/{release_id}/assets", "GET /repos/{owner}/{repo}/releases/{release_id}/assets",
@ -1203,9 +1132,16 @@ const Endpoints = {
listReleases: ["GET /repos/{owner}/{repo}/releases"], listReleases: ["GET /repos/{owner}/{repo}/releases"],
listTags: ["GET /repos/{owner}/{repo}/tags"], listTags: ["GET /repos/{owner}/{repo}/tags"],
listTeams: ["GET /repos/{owner}/{repo}/teams"], listTeams: ["GET /repos/{owner}/{repo}/teams"],
listWebhookDeliveries: [
"GET /repos/{owner}/{repo}/hooks/{hook_id}/deliveries",
],
listWebhooks: ["GET /repos/{owner}/{repo}/hooks"], listWebhooks: ["GET /repos/{owner}/{repo}/hooks"],
merge: ["POST /repos/{owner}/{repo}/merges"], merge: ["POST /repos/{owner}/{repo}/merges"],
mergeUpstream: ["POST /repos/{owner}/{repo}/merge-upstream"],
pingWebhook: ["POST /repos/{owner}/{repo}/hooks/{hook_id}/pings"], pingWebhook: ["POST /repos/{owner}/{repo}/hooks/{hook_id}/pings"],
redeliverWebhookDelivery: [
"POST /repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts",
],
removeAppAccessRestrictions: [ removeAppAccessRestrictions: [
"DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps",
{}, {},
@ -1298,7 +1234,7 @@ const Endpoints = {
}, },
search: { search: {
code: ["GET /search/code"], code: ["GET /search/code"],
commits: ["GET /search/commits", { mediaType: { previews: ["cloak"] } }], commits: ["GET /search/commits"],
issuesAndPullRequests: ["GET /search/issues"], issuesAndPullRequests: ["GET /search/issues"],
labels: ["GET /search/labels"], labels: ["GET /search/labels"],
repos: ["GET /search/repositories"], repos: ["GET /search/repositories"],
@ -1309,6 +1245,7 @@ const Endpoints = {
getAlert: [ getAlert: [
"GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}", "GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}",
], ],
listAlertsForOrg: ["GET /orgs/{org}/secret-scanning/alerts"],
listAlertsForRepo: ["GET /repos/{owner}/{repo}/secret-scanning/alerts"], listAlertsForRepo: ["GET /repos/{owner}/{repo}/secret-scanning/alerts"],
updateAlert: [ updateAlert: [
"PATCH /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}", "PATCH /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}",
@ -1320,14 +1257,12 @@ const Endpoints = {
], ],
addOrUpdateProjectPermissionsInOrg: [ addOrUpdateProjectPermissionsInOrg: [
"PUT /orgs/{org}/teams/{team_slug}/projects/{project_id}", "PUT /orgs/{org}/teams/{team_slug}/projects/{project_id}",
{ mediaType: { previews: ["inertia"] } },
], ],
addOrUpdateRepoPermissionsInOrg: [ addOrUpdateRepoPermissionsInOrg: [
"PUT /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", "PUT /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}",
], ],
checkPermissionsForProjectInOrg: [ checkPermissionsForProjectInOrg: [
"GET /orgs/{org}/teams/{team_slug}/projects/{project_id}", "GET /orgs/{org}/teams/{team_slug}/projects/{project_id}",
{ mediaType: { previews: ["inertia"] } },
], ],
checkPermissionsForRepoInOrg: [ checkPermissionsForRepoInOrg: [
"GET /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", "GET /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}",
@ -1365,10 +1300,7 @@ const Endpoints = {
listPendingInvitationsInOrg: [ listPendingInvitationsInOrg: [
"GET /orgs/{org}/teams/{team_slug}/invitations", "GET /orgs/{org}/teams/{team_slug}/invitations",
], ],
listProjectsInOrg: [ listProjectsInOrg: ["GET /orgs/{org}/teams/{team_slug}/projects"],
"GET /orgs/{org}/teams/{team_slug}/projects",
{ mediaType: { previews: ["inertia"] } },
],
listReposInOrg: ["GET /orgs/{org}/teams/{team_slug}/repos"], listReposInOrg: ["GET /orgs/{org}/teams/{team_slug}/repos"],
removeMembershipForUserInOrg: [ removeMembershipForUserInOrg: [
"DELETE /orgs/{org}/teams/{team_slug}/memberships/{username}", "DELETE /orgs/{org}/teams/{team_slug}/memberships/{username}",
@ -1388,35 +1320,112 @@ const Endpoints = {
updateInOrg: ["PATCH /orgs/{org}/teams/{team_slug}"], updateInOrg: ["PATCH /orgs/{org}/teams/{team_slug}"],
}, },
users: { users: {
addEmailForAuthenticated: ["POST /user/emails"], addEmailForAuthenticated: [
"POST /user/emails",
{},
{ renamed: ["users", "addEmailForAuthenticatedUser"] },
],
addEmailForAuthenticatedUser: ["POST /user/emails"],
block: ["PUT /user/blocks/{username}"], block: ["PUT /user/blocks/{username}"],
checkBlocked: ["GET /user/blocks/{username}"], checkBlocked: ["GET /user/blocks/{username}"],
checkFollowingForUser: ["GET /users/{username}/following/{target_user}"], checkFollowingForUser: ["GET /users/{username}/following/{target_user}"],
checkPersonIsFollowedByAuthenticated: ["GET /user/following/{username}"], checkPersonIsFollowedByAuthenticated: ["GET /user/following/{username}"],
createGpgKeyForAuthenticated: ["POST /user/gpg_keys"], createGpgKeyForAuthenticated: [
createPublicSshKeyForAuthenticated: ["POST /user/keys"], "POST /user/gpg_keys",
deleteEmailForAuthenticated: ["DELETE /user/emails"], {},
deleteGpgKeyForAuthenticated: ["DELETE /user/gpg_keys/{gpg_key_id}"], { renamed: ["users", "createGpgKeyForAuthenticatedUser"] },
deletePublicSshKeyForAuthenticated: ["DELETE /user/keys/{key_id}"], ],
createGpgKeyForAuthenticatedUser: ["POST /user/gpg_keys"],
createPublicSshKeyForAuthenticated: [
"POST /user/keys",
{},
{ renamed: ["users", "createPublicSshKeyForAuthenticatedUser"] },
],
createPublicSshKeyForAuthenticatedUser: ["POST /user/keys"],
deleteEmailForAuthenticated: [
"DELETE /user/emails",
{},
{ renamed: ["users", "deleteEmailForAuthenticatedUser"] },
],
deleteEmailForAuthenticatedUser: ["DELETE /user/emails"],
deleteGpgKeyForAuthenticated: [
"DELETE /user/gpg_keys/{gpg_key_id}",
{},
{ renamed: ["users", "deleteGpgKeyForAuthenticatedUser"] },
],
deleteGpgKeyForAuthenticatedUser: ["DELETE /user/gpg_keys/{gpg_key_id}"],
deletePublicSshKeyForAuthenticated: [
"DELETE /user/keys/{key_id}",
{},
{ renamed: ["users", "deletePublicSshKeyForAuthenticatedUser"] },
],
deletePublicSshKeyForAuthenticatedUser: ["DELETE /user/keys/{key_id}"],
follow: ["PUT /user/following/{username}"], follow: ["PUT /user/following/{username}"],
getAuthenticated: ["GET /user"], getAuthenticated: ["GET /user"],
getByUsername: ["GET /users/{username}"], getByUsername: ["GET /users/{username}"],
getContextForUser: ["GET /users/{username}/hovercard"], getContextForUser: ["GET /users/{username}/hovercard"],
getGpgKeyForAuthenticated: ["GET /user/gpg_keys/{gpg_key_id}"], getGpgKeyForAuthenticated: [
getPublicSshKeyForAuthenticated: ["GET /user/keys/{key_id}"], "GET /user/gpg_keys/{gpg_key_id}",
{},
{ renamed: ["users", "getGpgKeyForAuthenticatedUser"] },
],
getGpgKeyForAuthenticatedUser: ["GET /user/gpg_keys/{gpg_key_id}"],
getPublicSshKeyForAuthenticated: [
"GET /user/keys/{key_id}",
{},
{ renamed: ["users", "getPublicSshKeyForAuthenticatedUser"] },
],
getPublicSshKeyForAuthenticatedUser: ["GET /user/keys/{key_id}"],
list: ["GET /users"], list: ["GET /users"],
listBlockedByAuthenticated: ["GET /user/blocks"], listBlockedByAuthenticated: [
listEmailsForAuthenticated: ["GET /user/emails"], "GET /user/blocks",
listFollowedByAuthenticated: ["GET /user/following"], {},
{ renamed: ["users", "listBlockedByAuthenticatedUser"] },
],
listBlockedByAuthenticatedUser: ["GET /user/blocks"],
listEmailsForAuthenticated: [
"GET /user/emails",
{},
{ renamed: ["users", "listEmailsForAuthenticatedUser"] },
],
listEmailsForAuthenticatedUser: ["GET /user/emails"],
listFollowedByAuthenticated: [
"GET /user/following",
{},
{ renamed: ["users", "listFollowedByAuthenticatedUser"] },
],
listFollowedByAuthenticatedUser: ["GET /user/following"],
listFollowersForAuthenticatedUser: ["GET /user/followers"], listFollowersForAuthenticatedUser: ["GET /user/followers"],
listFollowersForUser: ["GET /users/{username}/followers"], listFollowersForUser: ["GET /users/{username}/followers"],
listFollowingForUser: ["GET /users/{username}/following"], listFollowingForUser: ["GET /users/{username}/following"],
listGpgKeysForAuthenticated: ["GET /user/gpg_keys"], listGpgKeysForAuthenticated: [
"GET /user/gpg_keys",
{},
{ renamed: ["users", "listGpgKeysForAuthenticatedUser"] },
],
listGpgKeysForAuthenticatedUser: ["GET /user/gpg_keys"],
listGpgKeysForUser: ["GET /users/{username}/gpg_keys"], listGpgKeysForUser: ["GET /users/{username}/gpg_keys"],
listPublicEmailsForAuthenticated: ["GET /user/public_emails"], listPublicEmailsForAuthenticated: [
"GET /user/public_emails",
{},
{ renamed: ["users", "listPublicEmailsForAuthenticatedUser"] },
],
listPublicEmailsForAuthenticatedUser: ["GET /user/public_emails"],
listPublicKeysForUser: ["GET /users/{username}/keys"], listPublicKeysForUser: ["GET /users/{username}/keys"],
listPublicSshKeysForAuthenticated: ["GET /user/keys"], listPublicSshKeysForAuthenticated: [
setPrimaryEmailVisibilityForAuthenticated: ["PATCH /user/email/visibility"], "GET /user/keys",
{},
{ renamed: ["users", "listPublicSshKeysForAuthenticatedUser"] },
],
listPublicSshKeysForAuthenticatedUser: ["GET /user/keys"],
setPrimaryEmailVisibilityForAuthenticated: [
"PATCH /user/email/visibility",
{},
{ renamed: ["users", "setPrimaryEmailVisibilityForAuthenticatedUser"] },
],
setPrimaryEmailVisibilityForAuthenticatedUser: [
"PATCH /user/email/visibility",
],
unblock: ["DELETE /user/blocks/{username}"], unblock: ["DELETE /user/blocks/{username}"],
unfollow: ["DELETE /user/following/{username}"], unfollow: ["DELETE /user/following/{username}"],
updateAuthenticated: ["PATCH /user"], updateAuthenticated: ["PATCH /user"],

View File

@ -1 +1 @@
export const VERSION = "5.3.0"; export const VERSION = "5.13.0";

File diff suppressed because it is too large Load Diff

View File

@ -93,6 +93,10 @@ export declare type RestEndpointMethodTypes = {
parameters: RequestParameters & Omit<Endpoints["GET /repos/{owner}/{repo}/actions/jobs/{job_id}/logs"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["GET /repos/{owner}/{repo}/actions/jobs/{job_id}/logs"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /repos/{owner}/{repo}/actions/jobs/{job_id}/logs"]["response"]; response: Endpoints["GET /repos/{owner}/{repo}/actions/jobs/{job_id}/logs"]["response"];
}; };
downloadWorkflowRunAttemptLogs: {
parameters: RequestParameters & Omit<Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs"]["response"];
};
downloadWorkflowRunLogs: { downloadWorkflowRunLogs: {
parameters: RequestParameters & Omit<Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/logs"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/logs"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/logs"]["response"]; response: Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/logs"]["response"];
@ -181,6 +185,10 @@ export declare type RestEndpointMethodTypes = {
parameters: RequestParameters & Omit<Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}"]["response"]; response: Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}"]["response"];
}; };
getWorkflowRunAttempt: {
parameters: RequestParameters & Omit<Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}"]["response"];
};
getWorkflowRunUsage: { getWorkflowRunUsage: {
parameters: RequestParameters & Omit<Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/timing"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/timing"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/timing"]["response"]; response: Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/timing"]["response"];
@ -201,6 +209,10 @@ export declare type RestEndpointMethodTypes = {
parameters: RequestParameters & Omit<Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs"]["response"]; response: Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs"]["response"];
}; };
listJobsForWorkflowRunAttempt: {
parameters: RequestParameters & Omit<Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs"]["response"];
};
listOrgSecrets: { listOrgSecrets: {
parameters: RequestParameters & Omit<Endpoints["GET /orgs/{org}/actions/secrets"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["GET /orgs/{org}/actions/secrets"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /orgs/{org}/actions/secrets"]["response"]; response: Endpoints["GET /orgs/{org}/actions/secrets"]["response"];
@ -249,10 +261,6 @@ export declare type RestEndpointMethodTypes = {
parameters: RequestParameters & Omit<Endpoints["GET /repos/{owner}/{repo}/actions/runs"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["GET /repos/{owner}/{repo}/actions/runs"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /repos/{owner}/{repo}/actions/runs"]["response"]; response: Endpoints["GET /repos/{owner}/{repo}/actions/runs"]["response"];
}; };
reRunWorkflow: {
parameters: RequestParameters & Omit<Endpoints["POST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["POST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun"]["response"];
};
removeSelectedRepoFromOrgSecret: { removeSelectedRepoFromOrgSecret: {
parameters: RequestParameters & Omit<Endpoints["DELETE /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["DELETE /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["DELETE /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}"]["response"]; response: Endpoints["DELETE /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}"]["response"];
@ -417,6 +425,10 @@ export declare type RestEndpointMethodTypes = {
parameters: RequestParameters & Omit<Endpoints["PUT /user/installations/{installation_id}/repositories/{repository_id}"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["PUT /user/installations/{installation_id}/repositories/{repository_id}"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["PUT /user/installations/{installation_id}/repositories/{repository_id}"]["response"]; response: Endpoints["PUT /user/installations/{installation_id}/repositories/{repository_id}"]["response"];
}; };
addRepoToInstallationForAuthenticatedUser: {
parameters: RequestParameters & Omit<Endpoints["PUT /user/installations/{installation_id}/repositories/{repository_id}"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["PUT /user/installations/{installation_id}/repositories/{repository_id}"]["response"];
};
checkToken: { checkToken: {
parameters: RequestParameters & Omit<Endpoints["POST /applications/{client_id}/token"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["POST /applications/{client_id}/token"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["POST /applications/{client_id}/token"]["response"]; response: Endpoints["POST /applications/{client_id}/token"]["response"];
@ -485,6 +497,10 @@ export declare type RestEndpointMethodTypes = {
parameters: RequestParameters & Omit<Endpoints["GET /app/hook/config"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["GET /app/hook/config"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /app/hook/config"]["response"]; response: Endpoints["GET /app/hook/config"]["response"];
}; };
getWebhookDelivery: {
parameters: RequestParameters & Omit<Endpoints["GET /app/hook/deliveries/{delivery_id}"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /app/hook/deliveries/{delivery_id}"]["response"];
};
listAccountsForPlan: { listAccountsForPlan: {
parameters: RequestParameters & Omit<Endpoints["GET /marketplace_listing/plans/{plan_id}/accounts"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["GET /marketplace_listing/plans/{plan_id}/accounts"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /marketplace_listing/plans/{plan_id}/accounts"]["response"]; response: Endpoints["GET /marketplace_listing/plans/{plan_id}/accounts"]["response"];
@ -525,10 +541,22 @@ export declare type RestEndpointMethodTypes = {
parameters: RequestParameters & Omit<Endpoints["GET /user/marketplace_purchases/stubbed"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["GET /user/marketplace_purchases/stubbed"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /user/marketplace_purchases/stubbed"]["response"]; response: Endpoints["GET /user/marketplace_purchases/stubbed"]["response"];
}; };
listWebhookDeliveries: {
parameters: RequestParameters & Omit<Endpoints["GET /app/hook/deliveries"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /app/hook/deliveries"]["response"];
};
redeliverWebhookDelivery: {
parameters: RequestParameters & Omit<Endpoints["POST /app/hook/deliveries/{delivery_id}/attempts"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["POST /app/hook/deliveries/{delivery_id}/attempts"]["response"];
};
removeRepoFromInstallation: { removeRepoFromInstallation: {
parameters: RequestParameters & Omit<Endpoints["DELETE /user/installations/{installation_id}/repositories/{repository_id}"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["DELETE /user/installations/{installation_id}/repositories/{repository_id}"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["DELETE /user/installations/{installation_id}/repositories/{repository_id}"]["response"]; response: Endpoints["DELETE /user/installations/{installation_id}/repositories/{repository_id}"]["response"];
}; };
removeRepoFromInstallationForAuthenticatedUser: {
parameters: RequestParameters & Omit<Endpoints["DELETE /user/installations/{installation_id}/repositories/{repository_id}"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["DELETE /user/installations/{installation_id}/repositories/{repository_id}"]["response"];
};
resetToken: { resetToken: {
parameters: RequestParameters & Omit<Endpoints["PATCH /applications/{client_id}/token"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["PATCH /applications/{client_id}/token"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["PATCH /applications/{client_id}/token"]["response"]; response: Endpoints["PATCH /applications/{client_id}/token"]["response"];
@ -613,6 +641,10 @@ export declare type RestEndpointMethodTypes = {
parameters: RequestParameters & Omit<Endpoints["GET /repos/{owner}/{repo}/commits/{ref}/check-suites"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["GET /repos/{owner}/{repo}/commits/{ref}/check-suites"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /repos/{owner}/{repo}/commits/{ref}/check-suites"]["response"]; response: Endpoints["GET /repos/{owner}/{repo}/commits/{ref}/check-suites"]["response"];
}; };
rerequestRun: {
parameters: RequestParameters & Omit<Endpoints["POST /repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["POST /repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest"]["response"];
};
rerequestSuite: { rerequestSuite: {
parameters: RequestParameters & Omit<Endpoints["POST /repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["POST /repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["POST /repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest"]["response"]; response: Endpoints["POST /repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest"]["response"];
@ -677,10 +709,6 @@ export declare type RestEndpointMethodTypes = {
parameters: RequestParameters & Omit<Endpoints["GET /codes_of_conduct/{key}"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["GET /codes_of_conduct/{key}"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /codes_of_conduct/{key}"]["response"]; response: Endpoints["GET /codes_of_conduct/{key}"]["response"];
}; };
getForRepo: {
parameters: RequestParameters & Omit<Endpoints["GET /repos/{owner}/{repo}/community/code_of_conduct"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /repos/{owner}/{repo}/community/code_of_conduct"]["response"];
};
}; };
emojis: { emojis: {
get: { get: {
@ -1167,6 +1195,10 @@ export declare type RestEndpointMethodTypes = {
parameters: RequestParameters & Omit<Endpoints["GET /orgs/{org}/migrations"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["GET /orgs/{org}/migrations"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /orgs/{org}/migrations"]["response"]; response: Endpoints["GET /orgs/{org}/migrations"]["response"];
}; };
listReposForAuthenticatedUser: {
parameters: RequestParameters & Omit<Endpoints["GET /user/migrations/{migration_id}/repositories"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /user/migrations/{migration_id}/repositories"]["response"];
};
listReposForOrg: { listReposForOrg: {
parameters: RequestParameters & Omit<Endpoints["GET /orgs/{org}/migrations/{migration_id}/repositories"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["GET /orgs/{org}/migrations/{migration_id}/repositories"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /orgs/{org}/migrations/{migration_id}/repositories"]["response"]; response: Endpoints["GET /orgs/{org}/migrations/{migration_id}/repositories"]["response"];
@ -1265,6 +1297,10 @@ export declare type RestEndpointMethodTypes = {
parameters: RequestParameters & Omit<Endpoints["GET /orgs/{org}/hooks/{hook_id}/config"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["GET /orgs/{org}/hooks/{hook_id}/config"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /orgs/{org}/hooks/{hook_id}/config"]["response"]; response: Endpoints["GET /orgs/{org}/hooks/{hook_id}/config"]["response"];
}; };
getWebhookDelivery: {
parameters: RequestParameters & Omit<Endpoints["GET /orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}"]["response"];
};
list: { list: {
parameters: RequestParameters & Omit<Endpoints["GET /organizations"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["GET /organizations"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /organizations"]["response"]; response: Endpoints["GET /organizations"]["response"];
@ -1313,6 +1349,10 @@ export declare type RestEndpointMethodTypes = {
parameters: RequestParameters & Omit<Endpoints["GET /orgs/{org}/public_members"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["GET /orgs/{org}/public_members"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /orgs/{org}/public_members"]["response"]; response: Endpoints["GET /orgs/{org}/public_members"]["response"];
}; };
listWebhookDeliveries: {
parameters: RequestParameters & Omit<Endpoints["GET /orgs/{org}/hooks/{hook_id}/deliveries"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /orgs/{org}/hooks/{hook_id}/deliveries"]["response"];
};
listWebhooks: { listWebhooks: {
parameters: RequestParameters & Omit<Endpoints["GET /orgs/{org}/hooks"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["GET /orgs/{org}/hooks"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /orgs/{org}/hooks"]["response"]; response: Endpoints["GET /orgs/{org}/hooks"]["response"];
@ -1321,6 +1361,10 @@ export declare type RestEndpointMethodTypes = {
parameters: RequestParameters & Omit<Endpoints["POST /orgs/{org}/hooks/{hook_id}/pings"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["POST /orgs/{org}/hooks/{hook_id}/pings"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["POST /orgs/{org}/hooks/{hook_id}/pings"]["response"]; response: Endpoints["POST /orgs/{org}/hooks/{hook_id}/pings"]["response"];
}; };
redeliverWebhookDelivery: {
parameters: RequestParameters & Omit<Endpoints["POST /orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["POST /orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts"]["response"];
};
removeMember: { removeMember: {
parameters: RequestParameters & Omit<Endpoints["DELETE /orgs/{org}/members/{username}"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["DELETE /orgs/{org}/members/{username}"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["DELETE /orgs/{org}/members/{username}"]["response"]; response: Endpoints["DELETE /orgs/{org}/members/{username}"]["response"];
@ -1375,6 +1419,10 @@ export declare type RestEndpointMethodTypes = {
parameters: RequestParameters & Omit<Endpoints["DELETE /orgs/{org}/packages/{package_type}/{package_name}"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["DELETE /orgs/{org}/packages/{package_type}/{package_name}"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["DELETE /orgs/{org}/packages/{package_type}/{package_name}"]["response"]; response: Endpoints["DELETE /orgs/{org}/packages/{package_type}/{package_name}"]["response"];
}; };
deletePackageForUser: {
parameters: RequestParameters & Omit<Endpoints["DELETE /users/{username}/packages/{package_type}/{package_name}"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["DELETE /users/{username}/packages/{package_type}/{package_name}"]["response"];
};
deletePackageVersionForAuthenticatedUser: { deletePackageVersionForAuthenticatedUser: {
parameters: RequestParameters & Omit<Endpoints["DELETE /user/packages/{package_type}/{package_name}/versions/{package_version_id}"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["DELETE /user/packages/{package_type}/{package_name}/versions/{package_version_id}"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["DELETE /user/packages/{package_type}/{package_name}/versions/{package_version_id}"]["response"]; response: Endpoints["DELETE /user/packages/{package_type}/{package_name}/versions/{package_version_id}"]["response"];
@ -1383,6 +1431,10 @@ export declare type RestEndpointMethodTypes = {
parameters: RequestParameters & Omit<Endpoints["DELETE /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["DELETE /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["DELETE /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}"]["response"]; response: Endpoints["DELETE /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}"]["response"];
}; };
deletePackageVersionForUser: {
parameters: RequestParameters & Omit<Endpoints["DELETE /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["DELETE /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}"]["response"];
};
getAllPackageVersionsForAPackageOwnedByAnOrg: { getAllPackageVersionsForAPackageOwnedByAnOrg: {
parameters: RequestParameters & Omit<Endpoints["GET /orgs/{org}/packages/{package_type}/{package_name}/versions"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["GET /orgs/{org}/packages/{package_type}/{package_name}/versions"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /orgs/{org}/packages/{package_type}/{package_name}/versions"]["response"]; response: Endpoints["GET /orgs/{org}/packages/{package_type}/{package_name}/versions"]["response"];
@ -1427,6 +1479,18 @@ export declare type RestEndpointMethodTypes = {
parameters: RequestParameters & Omit<Endpoints["GET /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["GET /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}"]["response"]; response: Endpoints["GET /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}"]["response"];
}; };
listPackagesForAuthenticatedUser: {
parameters: RequestParameters & Omit<Endpoints["GET /user/packages"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /user/packages"]["response"];
};
listPackagesForOrganization: {
parameters: RequestParameters & Omit<Endpoints["GET /orgs/{org}/packages"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /orgs/{org}/packages"]["response"];
};
listPackagesForUser: {
parameters: RequestParameters & Omit<Endpoints["GET /users/{username}/packages"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /users/{username}/packages"]["response"];
};
restorePackageForAuthenticatedUser: { restorePackageForAuthenticatedUser: {
parameters: RequestParameters & Omit<Endpoints["POST /user/packages/{package_type}/{package_name}/restore{?token}"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["POST /user/packages/{package_type}/{package_name}/restore{?token}"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["POST /user/packages/{package_type}/{package_name}/restore{?token}"]["response"]; response: Endpoints["POST /user/packages/{package_type}/{package_name}/restore{?token}"]["response"];
@ -1435,6 +1499,10 @@ export declare type RestEndpointMethodTypes = {
parameters: RequestParameters & Omit<Endpoints["POST /orgs/{org}/packages/{package_type}/{package_name}/restore{?token}"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["POST /orgs/{org}/packages/{package_type}/{package_name}/restore{?token}"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["POST /orgs/{org}/packages/{package_type}/{package_name}/restore{?token}"]["response"]; response: Endpoints["POST /orgs/{org}/packages/{package_type}/{package_name}/restore{?token}"]["response"];
}; };
restorePackageForUser: {
parameters: RequestParameters & Omit<Endpoints["POST /users/{username}/packages/{package_type}/{package_name}/restore{?token}"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["POST /users/{username}/packages/{package_type}/{package_name}/restore{?token}"]["response"];
};
restorePackageVersionForAuthenticatedUser: { restorePackageVersionForAuthenticatedUser: {
parameters: RequestParameters & Omit<Endpoints["POST /user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["POST /user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["POST /user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore"]["response"]; response: Endpoints["POST /user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore"]["response"];
@ -1443,6 +1511,10 @@ export declare type RestEndpointMethodTypes = {
parameters: RequestParameters & Omit<Endpoints["POST /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["POST /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["POST /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore"]["response"]; response: Endpoints["POST /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore"]["response"];
}; };
restorePackageVersionForUser: {
parameters: RequestParameters & Omit<Endpoints["POST /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["POST /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore"]["response"];
};
}; };
projects: { projects: {
addCollaborator: { addCollaborator: {
@ -1715,10 +1787,6 @@ export declare type RestEndpointMethodTypes = {
parameters: RequestParameters & Omit<Endpoints["DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}"]["response"]; response: Endpoints["DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}"]["response"];
}; };
deleteLegacy: {
parameters: RequestParameters & Omit<Endpoints["DELETE /reactions/{reaction_id}"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["DELETE /reactions/{reaction_id}"]["response"];
};
listForCommitComment: { listForCommitComment: {
parameters: RequestParameters & Omit<Endpoints["GET /repos/{owner}/{repo}/comments/{comment_id}/reactions"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["GET /repos/{owner}/{repo}/comments/{comment_id}/reactions"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /repos/{owner}/{repo}/comments/{comment_id}/reactions"]["response"]; response: Endpoints["GET /repos/{owner}/{repo}/comments/{comment_id}/reactions"]["response"];
@ -1749,6 +1817,10 @@ export declare type RestEndpointMethodTypes = {
parameters: RequestParameters & Omit<Endpoints["PATCH /user/repository_invitations/{invitation_id}"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["PATCH /user/repository_invitations/{invitation_id}"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["PATCH /user/repository_invitations/{invitation_id}"]["response"]; response: Endpoints["PATCH /user/repository_invitations/{invitation_id}"]["response"];
}; };
acceptInvitationForAuthenticatedUser: {
parameters: RequestParameters & Omit<Endpoints["PATCH /user/repository_invitations/{invitation_id}"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["PATCH /user/repository_invitations/{invitation_id}"]["response"];
};
addAppAccessRestrictions: { addAppAccessRestrictions: {
parameters: RequestParameters & Omit<Endpoints["POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps"]["response"]; response: Endpoints["POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps"]["response"];
@ -1785,6 +1857,10 @@ export declare type RestEndpointMethodTypes = {
parameters: RequestParameters & Omit<Endpoints["GET /repos/{owner}/{repo}/compare/{basehead}"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["GET /repos/{owner}/{repo}/compare/{basehead}"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /repos/{owner}/{repo}/compare/{basehead}"]["response"]; response: Endpoints["GET /repos/{owner}/{repo}/compare/{basehead}"]["response"];
}; };
createAutolink: {
parameters: RequestParameters & Omit<Endpoints["POST /repos/{owner}/{repo}/autolinks"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["POST /repos/{owner}/{repo}/autolinks"]["response"];
};
createCommitComment: { createCommitComment: {
parameters: RequestParameters & Omit<Endpoints["POST /repos/{owner}/{repo}/commits/{commit_sha}/comments"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["POST /repos/{owner}/{repo}/commits/{commit_sha}/comments"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["POST /repos/{owner}/{repo}/commits/{commit_sha}/comments"]["response"]; response: Endpoints["POST /repos/{owner}/{repo}/commits/{commit_sha}/comments"]["response"];
@ -1853,6 +1929,10 @@ export declare type RestEndpointMethodTypes = {
parameters: RequestParameters & Omit<Endpoints["DELETE /user/repository_invitations/{invitation_id}"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["DELETE /user/repository_invitations/{invitation_id}"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["DELETE /user/repository_invitations/{invitation_id}"]["response"]; response: Endpoints["DELETE /user/repository_invitations/{invitation_id}"]["response"];
}; };
declineInvitationForAuthenticatedUser: {
parameters: RequestParameters & Omit<Endpoints["DELETE /user/repository_invitations/{invitation_id}"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["DELETE /user/repository_invitations/{invitation_id}"]["response"];
};
delete: { delete: {
parameters: RequestParameters & Omit<Endpoints["DELETE /repos/{owner}/{repo}"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["DELETE /repos/{owner}/{repo}"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["DELETE /repos/{owner}/{repo}"]["response"]; response: Endpoints["DELETE /repos/{owner}/{repo}"]["response"];
@ -1869,6 +1949,10 @@ export declare type RestEndpointMethodTypes = {
parameters: RequestParameters & Omit<Endpoints["DELETE /repos/{owner}/{repo}/environments/{environment_name}"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["DELETE /repos/{owner}/{repo}/environments/{environment_name}"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["DELETE /repos/{owner}/{repo}/environments/{environment_name}"]["response"]; response: Endpoints["DELETE /repos/{owner}/{repo}/environments/{environment_name}"]["response"];
}; };
deleteAutolink: {
parameters: RequestParameters & Omit<Endpoints["DELETE /repos/{owner}/{repo}/autolinks/{autolink_id}"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["DELETE /repos/{owner}/{repo}/autolinks/{autolink_id}"]["response"];
};
deleteBranchProtection: { deleteBranchProtection: {
parameters: RequestParameters & Omit<Endpoints["DELETE /repos/{owner}/{repo}/branches/{branch}/protection"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["DELETE /repos/{owner}/{repo}/branches/{branch}/protection"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["DELETE /repos/{owner}/{repo}/branches/{branch}/protection"]["response"]; response: Endpoints["DELETE /repos/{owner}/{repo}/branches/{branch}/protection"]["response"];
@ -1921,6 +2005,10 @@ export declare type RestEndpointMethodTypes = {
parameters: RequestParameters & Omit<Endpoints["DELETE /repos/{owner}/{repo}/automated-security-fixes"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["DELETE /repos/{owner}/{repo}/automated-security-fixes"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["DELETE /repos/{owner}/{repo}/automated-security-fixes"]["response"]; response: Endpoints["DELETE /repos/{owner}/{repo}/automated-security-fixes"]["response"];
}; };
disableLfsForRepo: {
parameters: RequestParameters & Omit<Endpoints["DELETE /repos/{owner}/{repo}/lfs"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["DELETE /repos/{owner}/{repo}/lfs"]["response"];
};
disableVulnerabilityAlerts: { disableVulnerabilityAlerts: {
parameters: RequestParameters & Omit<Endpoints["DELETE /repos/{owner}/{repo}/vulnerability-alerts"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["DELETE /repos/{owner}/{repo}/vulnerability-alerts"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["DELETE /repos/{owner}/{repo}/vulnerability-alerts"]["response"]; response: Endpoints["DELETE /repos/{owner}/{repo}/vulnerability-alerts"]["response"];
@ -1941,10 +2029,18 @@ export declare type RestEndpointMethodTypes = {
parameters: RequestParameters & Omit<Endpoints["PUT /repos/{owner}/{repo}/automated-security-fixes"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["PUT /repos/{owner}/{repo}/automated-security-fixes"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["PUT /repos/{owner}/{repo}/automated-security-fixes"]["response"]; response: Endpoints["PUT /repos/{owner}/{repo}/automated-security-fixes"]["response"];
}; };
enableLfsForRepo: {
parameters: RequestParameters & Omit<Endpoints["PUT /repos/{owner}/{repo}/lfs"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["PUT /repos/{owner}/{repo}/lfs"]["response"];
};
enableVulnerabilityAlerts: { enableVulnerabilityAlerts: {
parameters: RequestParameters & Omit<Endpoints["PUT /repos/{owner}/{repo}/vulnerability-alerts"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["PUT /repos/{owner}/{repo}/vulnerability-alerts"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["PUT /repos/{owner}/{repo}/vulnerability-alerts"]["response"]; response: Endpoints["PUT /repos/{owner}/{repo}/vulnerability-alerts"]["response"];
}; };
generateReleaseNotes: {
parameters: RequestParameters & Omit<Endpoints["POST /repos/{owner}/{repo}/releases/generate-notes"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["POST /repos/{owner}/{repo}/releases/generate-notes"]["response"];
};
get: { get: {
parameters: RequestParameters & Omit<Endpoints["GET /repos/{owner}/{repo}"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["GET /repos/{owner}/{repo}"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /repos/{owner}/{repo}"]["response"]; response: Endpoints["GET /repos/{owner}/{repo}"]["response"];
@ -1973,6 +2069,10 @@ export declare type RestEndpointMethodTypes = {
parameters: RequestParameters & Omit<Endpoints["GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps"]["response"]; response: Endpoints["GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps"]["response"];
}; };
getAutolink: {
parameters: RequestParameters & Omit<Endpoints["GET /repos/{owner}/{repo}/autolinks/{autolink_id}"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /repos/{owner}/{repo}/autolinks/{autolink_id}"]["response"];
};
getBranch: { getBranch: {
parameters: RequestParameters & Omit<Endpoints["GET /repos/{owner}/{repo}/branches/{branch}"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["GET /repos/{owner}/{repo}/branches/{branch}"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /repos/{owner}/{repo}/branches/{branch}"]["response"]; response: Endpoints["GET /repos/{owner}/{repo}/branches/{branch}"]["response"];
@ -2125,6 +2225,14 @@ export declare type RestEndpointMethodTypes = {
parameters: RequestParameters & Omit<Endpoints["GET /repos/{owner}/{repo}/hooks/{hook_id}/config"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["GET /repos/{owner}/{repo}/hooks/{hook_id}/config"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /repos/{owner}/{repo}/hooks/{hook_id}/config"]["response"]; response: Endpoints["GET /repos/{owner}/{repo}/hooks/{hook_id}/config"]["response"];
}; };
getWebhookDelivery: {
parameters: RequestParameters & Omit<Endpoints["GET /repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}"]["response"];
};
listAutolinks: {
parameters: RequestParameters & Omit<Endpoints["GET /repos/{owner}/{repo}/autolinks"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /repos/{owner}/{repo}/autolinks"]["response"];
};
listBranches: { listBranches: {
parameters: RequestParameters & Omit<Endpoints["GET /repos/{owner}/{repo}/branches"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["GET /repos/{owner}/{repo}/branches"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /repos/{owner}/{repo}/branches"]["response"]; response: Endpoints["GET /repos/{owner}/{repo}/branches"]["response"];
@ -2225,6 +2333,10 @@ export declare type RestEndpointMethodTypes = {
parameters: RequestParameters & Omit<Endpoints["GET /repos/{owner}/{repo}/teams"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["GET /repos/{owner}/{repo}/teams"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /repos/{owner}/{repo}/teams"]["response"]; response: Endpoints["GET /repos/{owner}/{repo}/teams"]["response"];
}; };
listWebhookDeliveries: {
parameters: RequestParameters & Omit<Endpoints["GET /repos/{owner}/{repo}/hooks/{hook_id}/deliveries"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /repos/{owner}/{repo}/hooks/{hook_id}/deliveries"]["response"];
};
listWebhooks: { listWebhooks: {
parameters: RequestParameters & Omit<Endpoints["GET /repos/{owner}/{repo}/hooks"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["GET /repos/{owner}/{repo}/hooks"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /repos/{owner}/{repo}/hooks"]["response"]; response: Endpoints["GET /repos/{owner}/{repo}/hooks"]["response"];
@ -2233,10 +2345,18 @@ export declare type RestEndpointMethodTypes = {
parameters: RequestParameters & Omit<Endpoints["POST /repos/{owner}/{repo}/merges"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["POST /repos/{owner}/{repo}/merges"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["POST /repos/{owner}/{repo}/merges"]["response"]; response: Endpoints["POST /repos/{owner}/{repo}/merges"]["response"];
}; };
mergeUpstream: {
parameters: RequestParameters & Omit<Endpoints["POST /repos/{owner}/{repo}/merge-upstream"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["POST /repos/{owner}/{repo}/merge-upstream"]["response"];
};
pingWebhook: { pingWebhook: {
parameters: RequestParameters & Omit<Endpoints["POST /repos/{owner}/{repo}/hooks/{hook_id}/pings"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["POST /repos/{owner}/{repo}/hooks/{hook_id}/pings"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["POST /repos/{owner}/{repo}/hooks/{hook_id}/pings"]["response"]; response: Endpoints["POST /repos/{owner}/{repo}/hooks/{hook_id}/pings"]["response"];
}; };
redeliverWebhookDelivery: {
parameters: RequestParameters & Omit<Endpoints["POST /repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["POST /repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts"]["response"];
};
removeAppAccessRestrictions: { removeAppAccessRestrictions: {
parameters: RequestParameters & Omit<Endpoints["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps"]["response"]; response: Endpoints["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps"]["response"];
@ -2389,6 +2509,10 @@ export declare type RestEndpointMethodTypes = {
parameters: RequestParameters & Omit<Endpoints["GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}"]["response"]; response: Endpoints["GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}"]["response"];
}; };
listAlertsForOrg: {
parameters: RequestParameters & Omit<Endpoints["GET /orgs/{org}/secret-scanning/alerts"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /orgs/{org}/secret-scanning/alerts"]["response"];
};
listAlertsForRepo: { listAlertsForRepo: {
parameters: RequestParameters & Omit<Endpoints["GET /repos/{owner}/{repo}/secret-scanning/alerts"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["GET /repos/{owner}/{repo}/secret-scanning/alerts"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /repos/{owner}/{repo}/secret-scanning/alerts"]["response"]; response: Endpoints["GET /repos/{owner}/{repo}/secret-scanning/alerts"]["response"];
@ -2525,6 +2649,10 @@ export declare type RestEndpointMethodTypes = {
parameters: RequestParameters & Omit<Endpoints["POST /user/emails"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["POST /user/emails"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["POST /user/emails"]["response"]; response: Endpoints["POST /user/emails"]["response"];
}; };
addEmailForAuthenticatedUser: {
parameters: RequestParameters & Omit<Endpoints["POST /user/emails"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["POST /user/emails"]["response"];
};
block: { block: {
parameters: RequestParameters & Omit<Endpoints["PUT /user/blocks/{username}"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["PUT /user/blocks/{username}"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["PUT /user/blocks/{username}"]["response"]; response: Endpoints["PUT /user/blocks/{username}"]["response"];
@ -2545,22 +2673,42 @@ export declare type RestEndpointMethodTypes = {
parameters: RequestParameters & Omit<Endpoints["POST /user/gpg_keys"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["POST /user/gpg_keys"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["POST /user/gpg_keys"]["response"]; response: Endpoints["POST /user/gpg_keys"]["response"];
}; };
createGpgKeyForAuthenticatedUser: {
parameters: RequestParameters & Omit<Endpoints["POST /user/gpg_keys"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["POST /user/gpg_keys"]["response"];
};
createPublicSshKeyForAuthenticated: { createPublicSshKeyForAuthenticated: {
parameters: RequestParameters & Omit<Endpoints["POST /user/keys"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["POST /user/keys"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["POST /user/keys"]["response"]; response: Endpoints["POST /user/keys"]["response"];
}; };
createPublicSshKeyForAuthenticatedUser: {
parameters: RequestParameters & Omit<Endpoints["POST /user/keys"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["POST /user/keys"]["response"];
};
deleteEmailForAuthenticated: { deleteEmailForAuthenticated: {
parameters: RequestParameters & Omit<Endpoints["DELETE /user/emails"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["DELETE /user/emails"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["DELETE /user/emails"]["response"]; response: Endpoints["DELETE /user/emails"]["response"];
}; };
deleteEmailForAuthenticatedUser: {
parameters: RequestParameters & Omit<Endpoints["DELETE /user/emails"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["DELETE /user/emails"]["response"];
};
deleteGpgKeyForAuthenticated: { deleteGpgKeyForAuthenticated: {
parameters: RequestParameters & Omit<Endpoints["DELETE /user/gpg_keys/{gpg_key_id}"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["DELETE /user/gpg_keys/{gpg_key_id}"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["DELETE /user/gpg_keys/{gpg_key_id}"]["response"]; response: Endpoints["DELETE /user/gpg_keys/{gpg_key_id}"]["response"];
}; };
deleteGpgKeyForAuthenticatedUser: {
parameters: RequestParameters & Omit<Endpoints["DELETE /user/gpg_keys/{gpg_key_id}"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["DELETE /user/gpg_keys/{gpg_key_id}"]["response"];
};
deletePublicSshKeyForAuthenticated: { deletePublicSshKeyForAuthenticated: {
parameters: RequestParameters & Omit<Endpoints["DELETE /user/keys/{key_id}"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["DELETE /user/keys/{key_id}"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["DELETE /user/keys/{key_id}"]["response"]; response: Endpoints["DELETE /user/keys/{key_id}"]["response"];
}; };
deletePublicSshKeyForAuthenticatedUser: {
parameters: RequestParameters & Omit<Endpoints["DELETE /user/keys/{key_id}"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["DELETE /user/keys/{key_id}"]["response"];
};
follow: { follow: {
parameters: RequestParameters & Omit<Endpoints["PUT /user/following/{username}"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["PUT /user/following/{username}"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["PUT /user/following/{username}"]["response"]; response: Endpoints["PUT /user/following/{username}"]["response"];
@ -2581,10 +2729,18 @@ export declare type RestEndpointMethodTypes = {
parameters: RequestParameters & Omit<Endpoints["GET /user/gpg_keys/{gpg_key_id}"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["GET /user/gpg_keys/{gpg_key_id}"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /user/gpg_keys/{gpg_key_id}"]["response"]; response: Endpoints["GET /user/gpg_keys/{gpg_key_id}"]["response"];
}; };
getGpgKeyForAuthenticatedUser: {
parameters: RequestParameters & Omit<Endpoints["GET /user/gpg_keys/{gpg_key_id}"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /user/gpg_keys/{gpg_key_id}"]["response"];
};
getPublicSshKeyForAuthenticated: { getPublicSshKeyForAuthenticated: {
parameters: RequestParameters & Omit<Endpoints["GET /user/keys/{key_id}"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["GET /user/keys/{key_id}"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /user/keys/{key_id}"]["response"]; response: Endpoints["GET /user/keys/{key_id}"]["response"];
}; };
getPublicSshKeyForAuthenticatedUser: {
parameters: RequestParameters & Omit<Endpoints["GET /user/keys/{key_id}"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /user/keys/{key_id}"]["response"];
};
list: { list: {
parameters: RequestParameters & Omit<Endpoints["GET /users"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["GET /users"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /users"]["response"]; response: Endpoints["GET /users"]["response"];
@ -2593,14 +2749,26 @@ export declare type RestEndpointMethodTypes = {
parameters: RequestParameters & Omit<Endpoints["GET /user/blocks"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["GET /user/blocks"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /user/blocks"]["response"]; response: Endpoints["GET /user/blocks"]["response"];
}; };
listBlockedByAuthenticatedUser: {
parameters: RequestParameters & Omit<Endpoints["GET /user/blocks"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /user/blocks"]["response"];
};
listEmailsForAuthenticated: { listEmailsForAuthenticated: {
parameters: RequestParameters & Omit<Endpoints["GET /user/emails"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["GET /user/emails"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /user/emails"]["response"]; response: Endpoints["GET /user/emails"]["response"];
}; };
listEmailsForAuthenticatedUser: {
parameters: RequestParameters & Omit<Endpoints["GET /user/emails"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /user/emails"]["response"];
};
listFollowedByAuthenticated: { listFollowedByAuthenticated: {
parameters: RequestParameters & Omit<Endpoints["GET /user/following"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["GET /user/following"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /user/following"]["response"]; response: Endpoints["GET /user/following"]["response"];
}; };
listFollowedByAuthenticatedUser: {
parameters: RequestParameters & Omit<Endpoints["GET /user/following"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /user/following"]["response"];
};
listFollowersForAuthenticatedUser: { listFollowersForAuthenticatedUser: {
parameters: RequestParameters & Omit<Endpoints["GET /user/followers"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["GET /user/followers"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /user/followers"]["response"]; response: Endpoints["GET /user/followers"]["response"];
@ -2617,6 +2785,10 @@ export declare type RestEndpointMethodTypes = {
parameters: RequestParameters & Omit<Endpoints["GET /user/gpg_keys"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["GET /user/gpg_keys"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /user/gpg_keys"]["response"]; response: Endpoints["GET /user/gpg_keys"]["response"];
}; };
listGpgKeysForAuthenticatedUser: {
parameters: RequestParameters & Omit<Endpoints["GET /user/gpg_keys"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /user/gpg_keys"]["response"];
};
listGpgKeysForUser: { listGpgKeysForUser: {
parameters: RequestParameters & Omit<Endpoints["GET /users/{username}/gpg_keys"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["GET /users/{username}/gpg_keys"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /users/{username}/gpg_keys"]["response"]; response: Endpoints["GET /users/{username}/gpg_keys"]["response"];
@ -2625,6 +2797,10 @@ export declare type RestEndpointMethodTypes = {
parameters: RequestParameters & Omit<Endpoints["GET /user/public_emails"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["GET /user/public_emails"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /user/public_emails"]["response"]; response: Endpoints["GET /user/public_emails"]["response"];
}; };
listPublicEmailsForAuthenticatedUser: {
parameters: RequestParameters & Omit<Endpoints["GET /user/public_emails"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /user/public_emails"]["response"];
};
listPublicKeysForUser: { listPublicKeysForUser: {
parameters: RequestParameters & Omit<Endpoints["GET /users/{username}/keys"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["GET /users/{username}/keys"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /users/{username}/keys"]["response"]; response: Endpoints["GET /users/{username}/keys"]["response"];
@ -2633,10 +2809,18 @@ export declare type RestEndpointMethodTypes = {
parameters: RequestParameters & Omit<Endpoints["GET /user/keys"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["GET /user/keys"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /user/keys"]["response"]; response: Endpoints["GET /user/keys"]["response"];
}; };
listPublicSshKeysForAuthenticatedUser: {
parameters: RequestParameters & Omit<Endpoints["GET /user/keys"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["GET /user/keys"]["response"];
};
setPrimaryEmailVisibilityForAuthenticated: { setPrimaryEmailVisibilityForAuthenticated: {
parameters: RequestParameters & Omit<Endpoints["PATCH /user/email/visibility"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["PATCH /user/email/visibility"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["PATCH /user/email/visibility"]["response"]; response: Endpoints["PATCH /user/email/visibility"]["response"];
}; };
setPrimaryEmailVisibilityForAuthenticatedUser: {
parameters: RequestParameters & Omit<Endpoints["PATCH /user/email/visibility"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["PATCH /user/email/visibility"]["response"];
};
unblock: { unblock: {
parameters: RequestParameters & Omit<Endpoints["DELETE /user/blocks/{username}"]["parameters"], "baseUrl" | "headers" | "mediaType">; parameters: RequestParameters & Omit<Endpoints["DELETE /user/blocks/{username}"]["parameters"], "baseUrl" | "headers" | "mediaType">;
response: Endpoints["DELETE /user/blocks/{username}"]["response"]; response: Endpoints["DELETE /user/blocks/{username}"]["response"];

View File

@ -1 +1 @@
export declare const VERSION = "5.3.0"; export declare const VERSION = "5.13.0";

View File

@ -61,6 +61,9 @@ const Endpoints = {
downloadJobLogsForWorkflowRun: [ downloadJobLogsForWorkflowRun: [
"GET /repos/{owner}/{repo}/actions/jobs/{job_id}/logs", "GET /repos/{owner}/{repo}/actions/jobs/{job_id}/logs",
], ],
downloadWorkflowRunAttemptLogs: [
"GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs",
],
downloadWorkflowRunLogs: [ downloadWorkflowRunLogs: [
"GET /repos/{owner}/{repo}/actions/runs/{run_id}/logs", "GET /repos/{owner}/{repo}/actions/runs/{run_id}/logs",
], ],
@ -111,6 +114,9 @@ const Endpoints = {
], ],
getWorkflow: ["GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}"], getWorkflow: ["GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}"],
getWorkflowRun: ["GET /repos/{owner}/{repo}/actions/runs/{run_id}"], getWorkflowRun: ["GET /repos/{owner}/{repo}/actions/runs/{run_id}"],
getWorkflowRunAttempt: [
"GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}",
],
getWorkflowRunUsage: [ getWorkflowRunUsage: [
"GET /repos/{owner}/{repo}/actions/runs/{run_id}/timing", "GET /repos/{owner}/{repo}/actions/runs/{run_id}/timing",
], ],
@ -124,6 +130,9 @@ const Endpoints = {
listJobsForWorkflowRun: [ listJobsForWorkflowRun: [
"GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs", "GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs",
], ],
listJobsForWorkflowRunAttempt: [
"GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs",
],
listOrgSecrets: ["GET /orgs/{org}/actions/secrets"], listOrgSecrets: ["GET /orgs/{org}/actions/secrets"],
listRepoSecrets: ["GET /repos/{owner}/{repo}/actions/secrets"], listRepoSecrets: ["GET /repos/{owner}/{repo}/actions/secrets"],
listRepoWorkflows: ["GET /repos/{owner}/{repo}/actions/workflows"], listRepoWorkflows: ["GET /repos/{owner}/{repo}/actions/workflows"],
@ -146,7 +155,6 @@ const Endpoints = {
"GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs", "GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs",
], ],
listWorkflowRunsForRepo: ["GET /repos/{owner}/{repo}/actions/runs"], listWorkflowRunsForRepo: ["GET /repos/{owner}/{repo}/actions/runs"],
reRunWorkflow: ["POST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun"],
removeSelectedRepoFromOrgSecret: [ removeSelectedRepoFromOrgSecret: [
"DELETE /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", "DELETE /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}",
], ],
@ -220,6 +228,11 @@ const Endpoints = {
apps: { apps: {
addRepoToInstallation: [ addRepoToInstallation: [
"PUT /user/installations/{installation_id}/repositories/{repository_id}", "PUT /user/installations/{installation_id}/repositories/{repository_id}",
{},
{ renamed: ["apps", "addRepoToInstallationForAuthenticatedUser"] },
],
addRepoToInstallationForAuthenticatedUser: [
"PUT /user/installations/{installation_id}/repositories/{repository_id}",
], ],
checkToken: ["POST /applications/{client_id}/token"], checkToken: ["POST /applications/{client_id}/token"],
createContentAttachment: [ createContentAttachment: [
@ -250,6 +263,7 @@ const Endpoints = {
], ],
getUserInstallation: ["GET /users/{username}/installation"], getUserInstallation: ["GET /users/{username}/installation"],
getWebhookConfigForApp: ["GET /app/hook/config"], getWebhookConfigForApp: ["GET /app/hook/config"],
getWebhookDelivery: ["GET /app/hook/deliveries/{delivery_id}"],
listAccountsForPlan: ["GET /marketplace_listing/plans/{plan_id}/accounts"], listAccountsForPlan: ["GET /marketplace_listing/plans/{plan_id}/accounts"],
listAccountsForPlanStubbed: [ listAccountsForPlanStubbed: [
"GET /marketplace_listing/stubbed/plans/{plan_id}/accounts", "GET /marketplace_listing/stubbed/plans/{plan_id}/accounts",
@ -266,8 +280,17 @@ const Endpoints = {
listSubscriptionsForAuthenticatedUserStubbed: [ listSubscriptionsForAuthenticatedUserStubbed: [
"GET /user/marketplace_purchases/stubbed", "GET /user/marketplace_purchases/stubbed",
], ],
listWebhookDeliveries: ["GET /app/hook/deliveries"],
redeliverWebhookDelivery: [
"POST /app/hook/deliveries/{delivery_id}/attempts",
],
removeRepoFromInstallation: [ removeRepoFromInstallation: [
"DELETE /user/installations/{installation_id}/repositories/{repository_id}", "DELETE /user/installations/{installation_id}/repositories/{repository_id}",
{},
{ renamed: ["apps", "removeRepoFromInstallationForAuthenticatedUser"] },
],
removeRepoFromInstallationForAuthenticatedUser: [
"DELETE /user/installations/{installation_id}/repositories/{repository_id}",
], ],
resetToken: ["PATCH /applications/{client_id}/token"], resetToken: ["PATCH /applications/{client_id}/token"],
revokeInstallationAccessToken: ["DELETE /installation/token"], revokeInstallationAccessToken: ["DELETE /installation/token"],
@ -307,6 +330,9 @@ const Endpoints = {
"GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs", "GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs",
], ],
listSuitesForRef: ["GET /repos/{owner}/{repo}/commits/{ref}/check-suites"], listSuitesForRef: ["GET /repos/{owner}/{repo}/commits/{ref}/check-suites"],
rerequestRun: [
"POST /repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest",
],
rerequestSuite: [ rerequestSuite: [
"POST /repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest", "POST /repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest",
], ],
@ -344,18 +370,8 @@ const Endpoints = {
uploadSarif: ["POST /repos/{owner}/{repo}/code-scanning/sarifs"], uploadSarif: ["POST /repos/{owner}/{repo}/code-scanning/sarifs"],
}, },
codesOfConduct: { codesOfConduct: {
getAllCodesOfConduct: [ getAllCodesOfConduct: ["GET /codes_of_conduct"],
"GET /codes_of_conduct", getConductCode: ["GET /codes_of_conduct/{key}"],
{ mediaType: { previews: ["scarlet-witch"] } },
],
getConductCode: [
"GET /codes_of_conduct/{key}",
{ mediaType: { previews: ["scarlet-witch"] } },
],
getForRepo: [
"GET /repos/{owner}/{repo}/community/code_of_conduct",
{ mediaType: { previews: ["scarlet-witch"] } },
],
}, },
emojis: { get: ["GET /emojis"] }, emojis: { get: ["GET /emojis"] },
enterpriseAdmin: { enterpriseAdmin: {
@ -485,7 +501,6 @@ const Endpoints = {
listEventsForRepo: ["GET /repos/{owner}/{repo}/issues/events"], listEventsForRepo: ["GET /repos/{owner}/{repo}/issues/events"],
listEventsForTimeline: [ listEventsForTimeline: [
"GET /repos/{owner}/{repo}/issues/{issue_number}/timeline", "GET /repos/{owner}/{repo}/issues/{issue_number}/timeline",
{ mediaType: { previews: ["mockingbird"] } },
], ],
listForAuthenticatedUser: ["GET /user/issues"], listForAuthenticatedUser: ["GET /user/issues"],
listForOrg: ["GET /orgs/{org}/issues"], listForOrg: ["GET /orgs/{org}/issues"],
@ -539,46 +554,31 @@ const Endpoints = {
cancelImport: ["DELETE /repos/{owner}/{repo}/import"], cancelImport: ["DELETE /repos/{owner}/{repo}/import"],
deleteArchiveForAuthenticatedUser: [ deleteArchiveForAuthenticatedUser: [
"DELETE /user/migrations/{migration_id}/archive", "DELETE /user/migrations/{migration_id}/archive",
{ mediaType: { previews: ["wyandotte"] } },
], ],
deleteArchiveForOrg: [ deleteArchiveForOrg: [
"DELETE /orgs/{org}/migrations/{migration_id}/archive", "DELETE /orgs/{org}/migrations/{migration_id}/archive",
{ mediaType: { previews: ["wyandotte"] } },
], ],
downloadArchiveForOrg: [ downloadArchiveForOrg: [
"GET /orgs/{org}/migrations/{migration_id}/archive", "GET /orgs/{org}/migrations/{migration_id}/archive",
{ mediaType: { previews: ["wyandotte"] } },
], ],
getArchiveForAuthenticatedUser: [ getArchiveForAuthenticatedUser: [
"GET /user/migrations/{migration_id}/archive", "GET /user/migrations/{migration_id}/archive",
{ mediaType: { previews: ["wyandotte"] } },
], ],
getCommitAuthors: ["GET /repos/{owner}/{repo}/import/authors"], getCommitAuthors: ["GET /repos/{owner}/{repo}/import/authors"],
getImportStatus: ["GET /repos/{owner}/{repo}/import"], getImportStatus: ["GET /repos/{owner}/{repo}/import"],
getLargeFiles: ["GET /repos/{owner}/{repo}/import/large_files"], getLargeFiles: ["GET /repos/{owner}/{repo}/import/large_files"],
getStatusForAuthenticatedUser: [ getStatusForAuthenticatedUser: ["GET /user/migrations/{migration_id}"],
"GET /user/migrations/{migration_id}", getStatusForOrg: ["GET /orgs/{org}/migrations/{migration_id}"],
{ mediaType: { previews: ["wyandotte"] } }, listForAuthenticatedUser: ["GET /user/migrations"],
], listForOrg: ["GET /orgs/{org}/migrations"],
getStatusForOrg: [ listReposForAuthenticatedUser: [
"GET /orgs/{org}/migrations/{migration_id}", "GET /user/migrations/{migration_id}/repositories",
{ mediaType: { previews: ["wyandotte"] } },
],
listForAuthenticatedUser: [
"GET /user/migrations",
{ mediaType: { previews: ["wyandotte"] } },
],
listForOrg: [
"GET /orgs/{org}/migrations",
{ mediaType: { previews: ["wyandotte"] } },
],
listReposForOrg: [
"GET /orgs/{org}/migrations/{migration_id}/repositories",
{ mediaType: { previews: ["wyandotte"] } },
], ],
listReposForOrg: ["GET /orgs/{org}/migrations/{migration_id}/repositories"],
listReposForUser: [ listReposForUser: [
"GET /user/migrations/{migration_id}/repositories", "GET /user/migrations/{migration_id}/repositories",
{ mediaType: { previews: ["wyandotte"] } }, {},
{ renamed: ["migrations", "listReposForAuthenticatedUser"] },
], ],
mapCommitAuthor: ["PATCH /repos/{owner}/{repo}/import/authors/{author_id}"], mapCommitAuthor: ["PATCH /repos/{owner}/{repo}/import/authors/{author_id}"],
setLfsPreference: ["PATCH /repos/{owner}/{repo}/import/lfs"], setLfsPreference: ["PATCH /repos/{owner}/{repo}/import/lfs"],
@ -587,11 +587,9 @@ const Endpoints = {
startImport: ["PUT /repos/{owner}/{repo}/import"], startImport: ["PUT /repos/{owner}/{repo}/import"],
unlockRepoForAuthenticatedUser: [ unlockRepoForAuthenticatedUser: [
"DELETE /user/migrations/{migration_id}/repos/{repo_name}/lock", "DELETE /user/migrations/{migration_id}/repos/{repo_name}/lock",
{ mediaType: { previews: ["wyandotte"] } },
], ],
unlockRepoForOrg: [ unlockRepoForOrg: [
"DELETE /orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock", "DELETE /orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock",
{ mediaType: { previews: ["wyandotte"] } },
], ],
updateImport: ["PATCH /repos/{owner}/{repo}/import"], updateImport: ["PATCH /repos/{owner}/{repo}/import"],
}, },
@ -612,6 +610,9 @@ const Endpoints = {
getMembershipForUser: ["GET /orgs/{org}/memberships/{username}"], getMembershipForUser: ["GET /orgs/{org}/memberships/{username}"],
getWebhook: ["GET /orgs/{org}/hooks/{hook_id}"], getWebhook: ["GET /orgs/{org}/hooks/{hook_id}"],
getWebhookConfigForOrg: ["GET /orgs/{org}/hooks/{hook_id}/config"], getWebhookConfigForOrg: ["GET /orgs/{org}/hooks/{hook_id}/config"],
getWebhookDelivery: [
"GET /orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}",
],
list: ["GET /organizations"], list: ["GET /organizations"],
listAppInstallations: ["GET /orgs/{org}/installations"], listAppInstallations: ["GET /orgs/{org}/installations"],
listBlockedUsers: ["GET /orgs/{org}/blocks"], listBlockedUsers: ["GET /orgs/{org}/blocks"],
@ -624,8 +625,12 @@ const Endpoints = {
listOutsideCollaborators: ["GET /orgs/{org}/outside_collaborators"], listOutsideCollaborators: ["GET /orgs/{org}/outside_collaborators"],
listPendingInvitations: ["GET /orgs/{org}/invitations"], listPendingInvitations: ["GET /orgs/{org}/invitations"],
listPublicMembers: ["GET /orgs/{org}/public_members"], listPublicMembers: ["GET /orgs/{org}/public_members"],
listWebhookDeliveries: ["GET /orgs/{org}/hooks/{hook_id}/deliveries"],
listWebhooks: ["GET /orgs/{org}/hooks"], listWebhooks: ["GET /orgs/{org}/hooks"],
pingWebhook: ["POST /orgs/{org}/hooks/{hook_id}/pings"], pingWebhook: ["POST /orgs/{org}/hooks/{hook_id}/pings"],
redeliverWebhookDelivery: [
"POST /orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts",
],
removeMember: ["DELETE /orgs/{org}/members/{username}"], removeMember: ["DELETE /orgs/{org}/members/{username}"],
removeMembershipForUser: ["DELETE /orgs/{org}/memberships/{username}"], removeMembershipForUser: ["DELETE /orgs/{org}/memberships/{username}"],
removeOutsideCollaborator: [ removeOutsideCollaborator: [
@ -653,12 +658,18 @@ const Endpoints = {
deletePackageForOrg: [ deletePackageForOrg: [
"DELETE /orgs/{org}/packages/{package_type}/{package_name}", "DELETE /orgs/{org}/packages/{package_type}/{package_name}",
], ],
deletePackageForUser: [
"DELETE /users/{username}/packages/{package_type}/{package_name}",
],
deletePackageVersionForAuthenticatedUser: [ deletePackageVersionForAuthenticatedUser: [
"DELETE /user/packages/{package_type}/{package_name}/versions/{package_version_id}", "DELETE /user/packages/{package_type}/{package_name}/versions/{package_version_id}",
], ],
deletePackageVersionForOrg: [ deletePackageVersionForOrg: [
"DELETE /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}", "DELETE /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}",
], ],
deletePackageVersionForUser: [
"DELETE /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}",
],
getAllPackageVersionsForAPackageOwnedByAnOrg: [ getAllPackageVersionsForAPackageOwnedByAnOrg: [
"GET /orgs/{org}/packages/{package_type}/{package_name}/versions", "GET /orgs/{org}/packages/{package_type}/{package_name}/versions",
{}, {},
@ -701,120 +712,58 @@ const Endpoints = {
getPackageVersionForUser: [ getPackageVersionForUser: [
"GET /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}", "GET /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}",
], ],
listPackagesForAuthenticatedUser: ["GET /user/packages"],
listPackagesForOrganization: ["GET /orgs/{org}/packages"],
listPackagesForUser: ["GET /users/{username}/packages"],
restorePackageForAuthenticatedUser: [ restorePackageForAuthenticatedUser: [
"POST /user/packages/{package_type}/{package_name}/restore{?token}", "POST /user/packages/{package_type}/{package_name}/restore{?token}",
], ],
restorePackageForOrg: [ restorePackageForOrg: [
"POST /orgs/{org}/packages/{package_type}/{package_name}/restore{?token}", "POST /orgs/{org}/packages/{package_type}/{package_name}/restore{?token}",
], ],
restorePackageForUser: [
"POST /users/{username}/packages/{package_type}/{package_name}/restore{?token}",
],
restorePackageVersionForAuthenticatedUser: [ restorePackageVersionForAuthenticatedUser: [
"POST /user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore", "POST /user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore",
], ],
restorePackageVersionForOrg: [ restorePackageVersionForOrg: [
"POST /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore", "POST /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore",
], ],
restorePackageVersionForUser: [
"POST /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore",
],
}, },
projects: { projects: {
addCollaborator: [ addCollaborator: ["PUT /projects/{project_id}/collaborators/{username}"],
"PUT /projects/{project_id}/collaborators/{username}", createCard: ["POST /projects/columns/{column_id}/cards"],
{ mediaType: { previews: ["inertia"] } }, createColumn: ["POST /projects/{project_id}/columns"],
], createForAuthenticatedUser: ["POST /user/projects"],
createCard: [ createForOrg: ["POST /orgs/{org}/projects"],
"POST /projects/columns/{column_id}/cards", createForRepo: ["POST /repos/{owner}/{repo}/projects"],
{ mediaType: { previews: ["inertia"] } }, delete: ["DELETE /projects/{project_id}"],
], deleteCard: ["DELETE /projects/columns/cards/{card_id}"],
createColumn: [ deleteColumn: ["DELETE /projects/columns/{column_id}"],
"POST /projects/{project_id}/columns", get: ["GET /projects/{project_id}"],
{ mediaType: { previews: ["inertia"] } }, getCard: ["GET /projects/columns/cards/{card_id}"],
], getColumn: ["GET /projects/columns/{column_id}"],
createForAuthenticatedUser: [
"POST /user/projects",
{ mediaType: { previews: ["inertia"] } },
],
createForOrg: [
"POST /orgs/{org}/projects",
{ mediaType: { previews: ["inertia"] } },
],
createForRepo: [
"POST /repos/{owner}/{repo}/projects",
{ mediaType: { previews: ["inertia"] } },
],
delete: [
"DELETE /projects/{project_id}",
{ mediaType: { previews: ["inertia"] } },
],
deleteCard: [
"DELETE /projects/columns/cards/{card_id}",
{ mediaType: { previews: ["inertia"] } },
],
deleteColumn: [
"DELETE /projects/columns/{column_id}",
{ mediaType: { previews: ["inertia"] } },
],
get: [
"GET /projects/{project_id}",
{ mediaType: { previews: ["inertia"] } },
],
getCard: [
"GET /projects/columns/cards/{card_id}",
{ mediaType: { previews: ["inertia"] } },
],
getColumn: [
"GET /projects/columns/{column_id}",
{ mediaType: { previews: ["inertia"] } },
],
getPermissionForUser: [ getPermissionForUser: [
"GET /projects/{project_id}/collaborators/{username}/permission", "GET /projects/{project_id}/collaborators/{username}/permission",
{ mediaType: { previews: ["inertia"] } },
],
listCards: [
"GET /projects/columns/{column_id}/cards",
{ mediaType: { previews: ["inertia"] } },
],
listCollaborators: [
"GET /projects/{project_id}/collaborators",
{ mediaType: { previews: ["inertia"] } },
],
listColumns: [
"GET /projects/{project_id}/columns",
{ mediaType: { previews: ["inertia"] } },
],
listForOrg: [
"GET /orgs/{org}/projects",
{ mediaType: { previews: ["inertia"] } },
],
listForRepo: [
"GET /repos/{owner}/{repo}/projects",
{ mediaType: { previews: ["inertia"] } },
],
listForUser: [
"GET /users/{username}/projects",
{ mediaType: { previews: ["inertia"] } },
],
moveCard: [
"POST /projects/columns/cards/{card_id}/moves",
{ mediaType: { previews: ["inertia"] } },
],
moveColumn: [
"POST /projects/columns/{column_id}/moves",
{ mediaType: { previews: ["inertia"] } },
], ],
listCards: ["GET /projects/columns/{column_id}/cards"],
listCollaborators: ["GET /projects/{project_id}/collaborators"],
listColumns: ["GET /projects/{project_id}/columns"],
listForOrg: ["GET /orgs/{org}/projects"],
listForRepo: ["GET /repos/{owner}/{repo}/projects"],
listForUser: ["GET /users/{username}/projects"],
moveCard: ["POST /projects/columns/cards/{card_id}/moves"],
moveColumn: ["POST /projects/columns/{column_id}/moves"],
removeCollaborator: [ removeCollaborator: [
"DELETE /projects/{project_id}/collaborators/{username}", "DELETE /projects/{project_id}/collaborators/{username}",
{ mediaType: { previews: ["inertia"] } },
],
update: [
"PATCH /projects/{project_id}",
{ mediaType: { previews: ["inertia"] } },
],
updateCard: [
"PATCH /projects/columns/cards/{card_id}",
{ mediaType: { previews: ["inertia"] } },
],
updateColumn: [
"PATCH /projects/columns/{column_id}",
{ mediaType: { previews: ["inertia"] } },
], ],
update: ["PATCH /projects/{project_id}"],
updateCard: ["PATCH /projects/columns/cards/{card_id}"],
updateColumn: ["PATCH /projects/columns/{column_id}"],
}, },
pulls: { pulls: {
checkIfMerged: ["GET /repos/{owner}/{repo}/pulls/{pull_number}/merge"], checkIfMerged: ["GET /repos/{owner}/{repo}/pulls/{pull_number}/merge"],
@ -867,7 +816,6 @@ const Endpoints = {
update: ["PATCH /repos/{owner}/{repo}/pulls/{pull_number}"], update: ["PATCH /repos/{owner}/{repo}/pulls/{pull_number}"],
updateBranch: [ updateBranch: [
"PUT /repos/{owner}/{repo}/pulls/{pull_number}/update-branch", "PUT /repos/{owner}/{repo}/pulls/{pull_number}/update-branch",
{ mediaType: { previews: ["lydian"] } },
], ],
updateReview: [ updateReview: [
"PUT /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", "PUT /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}",
@ -880,90 +828,69 @@ const Endpoints = {
reactions: { reactions: {
createForCommitComment: [ createForCommitComment: [
"POST /repos/{owner}/{repo}/comments/{comment_id}/reactions", "POST /repos/{owner}/{repo}/comments/{comment_id}/reactions",
{ mediaType: { previews: ["squirrel-girl"] } },
], ],
createForIssue: [ createForIssue: [
"POST /repos/{owner}/{repo}/issues/{issue_number}/reactions", "POST /repos/{owner}/{repo}/issues/{issue_number}/reactions",
{ mediaType: { previews: ["squirrel-girl"] } },
], ],
createForIssueComment: [ createForIssueComment: [
"POST /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", "POST /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions",
{ mediaType: { previews: ["squirrel-girl"] } },
], ],
createForPullRequestReviewComment: [ createForPullRequestReviewComment: [
"POST /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", "POST /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions",
{ mediaType: { previews: ["squirrel-girl"] } },
], ],
createForRelease: [ createForRelease: [
"POST /repos/{owner}/{repo}/releases/{release_id}/reactions", "POST /repos/{owner}/{repo}/releases/{release_id}/reactions",
{ mediaType: { previews: ["squirrel-girl"] } },
], ],
createForTeamDiscussionCommentInOrg: [ createForTeamDiscussionCommentInOrg: [
"POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", "POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions",
{ mediaType: { previews: ["squirrel-girl"] } },
], ],
createForTeamDiscussionInOrg: [ createForTeamDiscussionInOrg: [
"POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", "POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions",
{ mediaType: { previews: ["squirrel-girl"] } },
], ],
deleteForCommitComment: [ deleteForCommitComment: [
"DELETE /repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}", "DELETE /repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}",
{ mediaType: { previews: ["squirrel-girl"] } },
], ],
deleteForIssue: [ deleteForIssue: [
"DELETE /repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}", "DELETE /repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}",
{ mediaType: { previews: ["squirrel-girl"] } },
], ],
deleteForIssueComment: [ deleteForIssueComment: [
"DELETE /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}", "DELETE /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}",
{ mediaType: { previews: ["squirrel-girl"] } },
], ],
deleteForPullRequestComment: [ deleteForPullRequestComment: [
"DELETE /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}", "DELETE /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}",
{ mediaType: { previews: ["squirrel-girl"] } },
], ],
deleteForTeamDiscussion: [ deleteForTeamDiscussion: [
"DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}", "DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}",
{ mediaType: { previews: ["squirrel-girl"] } },
], ],
deleteForTeamDiscussionComment: [ deleteForTeamDiscussionComment: [
"DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}", "DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}",
{ mediaType: { previews: ["squirrel-girl"] } },
],
deleteLegacy: [
"DELETE /reactions/{reaction_id}",
{ mediaType: { previews: ["squirrel-girl"] } },
{
deprecated: "octokit.rest.reactions.deleteLegacy() is deprecated, see https://docs.github.com/rest/reference/reactions/#delete-a-reaction-legacy",
},
], ],
listForCommitComment: [ listForCommitComment: [
"GET /repos/{owner}/{repo}/comments/{comment_id}/reactions", "GET /repos/{owner}/{repo}/comments/{comment_id}/reactions",
{ mediaType: { previews: ["squirrel-girl"] } },
],
listForIssue: [
"GET /repos/{owner}/{repo}/issues/{issue_number}/reactions",
{ mediaType: { previews: ["squirrel-girl"] } },
], ],
listForIssue: ["GET /repos/{owner}/{repo}/issues/{issue_number}/reactions"],
listForIssueComment: [ listForIssueComment: [
"GET /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", "GET /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions",
{ mediaType: { previews: ["squirrel-girl"] } },
], ],
listForPullRequestReviewComment: [ listForPullRequestReviewComment: [
"GET /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", "GET /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions",
{ mediaType: { previews: ["squirrel-girl"] } },
], ],
listForTeamDiscussionCommentInOrg: [ listForTeamDiscussionCommentInOrg: [
"GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions",
{ mediaType: { previews: ["squirrel-girl"] } },
], ],
listForTeamDiscussionInOrg: [ listForTeamDiscussionInOrg: [
"GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions",
{ mediaType: { previews: ["squirrel-girl"] } },
], ],
}, },
repos: { repos: {
acceptInvitation: ["PATCH /user/repository_invitations/{invitation_id}"], acceptInvitation: [
"PATCH /user/repository_invitations/{invitation_id}",
{},
{ renamed: ["repos", "acceptInvitationForAuthenticatedUser"] },
],
acceptInvitationForAuthenticatedUser: [
"PATCH /user/repository_invitations/{invitation_id}",
],
addAppAccessRestrictions: [ addAppAccessRestrictions: [
"POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", "POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps",
{}, {},
@ -988,18 +915,17 @@ const Endpoints = {
checkCollaborator: ["GET /repos/{owner}/{repo}/collaborators/{username}"], checkCollaborator: ["GET /repos/{owner}/{repo}/collaborators/{username}"],
checkVulnerabilityAlerts: [ checkVulnerabilityAlerts: [
"GET /repos/{owner}/{repo}/vulnerability-alerts", "GET /repos/{owner}/{repo}/vulnerability-alerts",
{ mediaType: { previews: ["dorian"] } },
], ],
compareCommits: ["GET /repos/{owner}/{repo}/compare/{base}...{head}"], compareCommits: ["GET /repos/{owner}/{repo}/compare/{base}...{head}"],
compareCommitsWithBasehead: [ compareCommitsWithBasehead: [
"GET /repos/{owner}/{repo}/compare/{basehead}", "GET /repos/{owner}/{repo}/compare/{basehead}",
], ],
createAutolink: ["POST /repos/{owner}/{repo}/autolinks"],
createCommitComment: [ createCommitComment: [
"POST /repos/{owner}/{repo}/commits/{commit_sha}/comments", "POST /repos/{owner}/{repo}/commits/{commit_sha}/comments",
], ],
createCommitSignatureProtection: [ createCommitSignatureProtection: [
"POST /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", "POST /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures",
{ mediaType: { previews: ["zzzax"] } },
], ],
createCommitStatus: ["POST /repos/{owner}/{repo}/statuses/{sha}"], createCommitStatus: ["POST /repos/{owner}/{repo}/statuses/{sha}"],
createDeployKey: ["POST /repos/{owner}/{repo}/keys"], createDeployKey: ["POST /repos/{owner}/{repo}/keys"],
@ -1015,17 +941,20 @@ const Endpoints = {
"PUT /repos/{owner}/{repo}/environments/{environment_name}", "PUT /repos/{owner}/{repo}/environments/{environment_name}",
], ],
createOrUpdateFileContents: ["PUT /repos/{owner}/{repo}/contents/{path}"], createOrUpdateFileContents: ["PUT /repos/{owner}/{repo}/contents/{path}"],
createPagesSite: [ createPagesSite: ["POST /repos/{owner}/{repo}/pages"],
"POST /repos/{owner}/{repo}/pages",
{ mediaType: { previews: ["switcheroo"] } },
],
createRelease: ["POST /repos/{owner}/{repo}/releases"], createRelease: ["POST /repos/{owner}/{repo}/releases"],
createUsingTemplate: [ createUsingTemplate: [
"POST /repos/{template_owner}/{template_repo}/generate", "POST /repos/{template_owner}/{template_repo}/generate",
{ mediaType: { previews: ["baptiste"] } },
], ],
createWebhook: ["POST /repos/{owner}/{repo}/hooks"], createWebhook: ["POST /repos/{owner}/{repo}/hooks"],
declineInvitation: ["DELETE /user/repository_invitations/{invitation_id}"], declineInvitation: [
"DELETE /user/repository_invitations/{invitation_id}",
{},
{ renamed: ["repos", "declineInvitationForAuthenticatedUser"] },
],
declineInvitationForAuthenticatedUser: [
"DELETE /user/repository_invitations/{invitation_id}",
],
delete: ["DELETE /repos/{owner}/{repo}"], delete: ["DELETE /repos/{owner}/{repo}"],
deleteAccessRestrictions: [ deleteAccessRestrictions: [
"DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions", "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions",
@ -1036,13 +965,13 @@ const Endpoints = {
deleteAnEnvironment: [ deleteAnEnvironment: [
"DELETE /repos/{owner}/{repo}/environments/{environment_name}", "DELETE /repos/{owner}/{repo}/environments/{environment_name}",
], ],
deleteAutolink: ["DELETE /repos/{owner}/{repo}/autolinks/{autolink_id}"],
deleteBranchProtection: [ deleteBranchProtection: [
"DELETE /repos/{owner}/{repo}/branches/{branch}/protection", "DELETE /repos/{owner}/{repo}/branches/{branch}/protection",
], ],
deleteCommitComment: ["DELETE /repos/{owner}/{repo}/comments/{comment_id}"], deleteCommitComment: ["DELETE /repos/{owner}/{repo}/comments/{comment_id}"],
deleteCommitSignatureProtection: [ deleteCommitSignatureProtection: [
"DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures",
{ mediaType: { previews: ["zzzax"] } },
], ],
deleteDeployKey: ["DELETE /repos/{owner}/{repo}/keys/{key_id}"], deleteDeployKey: ["DELETE /repos/{owner}/{repo}/keys/{key_id}"],
deleteDeployment: [ deleteDeployment: [
@ -1052,10 +981,7 @@ const Endpoints = {
deleteInvitation: [ deleteInvitation: [
"DELETE /repos/{owner}/{repo}/invitations/{invitation_id}", "DELETE /repos/{owner}/{repo}/invitations/{invitation_id}",
], ],
deletePagesSite: [ deletePagesSite: ["DELETE /repos/{owner}/{repo}/pages"],
"DELETE /repos/{owner}/{repo}/pages",
{ mediaType: { previews: ["switcheroo"] } },
],
deletePullRequestReviewProtection: [ deletePullRequestReviewProtection: [
"DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews",
], ],
@ -1066,11 +992,10 @@ const Endpoints = {
deleteWebhook: ["DELETE /repos/{owner}/{repo}/hooks/{hook_id}"], deleteWebhook: ["DELETE /repos/{owner}/{repo}/hooks/{hook_id}"],
disableAutomatedSecurityFixes: [ disableAutomatedSecurityFixes: [
"DELETE /repos/{owner}/{repo}/automated-security-fixes", "DELETE /repos/{owner}/{repo}/automated-security-fixes",
{ mediaType: { previews: ["london"] } },
], ],
disableLfsForRepo: ["DELETE /repos/{owner}/{repo}/lfs"],
disableVulnerabilityAlerts: [ disableVulnerabilityAlerts: [
"DELETE /repos/{owner}/{repo}/vulnerability-alerts", "DELETE /repos/{owner}/{repo}/vulnerability-alerts",
{ mediaType: { previews: ["dorian"] } },
], ],
downloadArchive: [ downloadArchive: [
"GET /repos/{owner}/{repo}/zipball/{ref}", "GET /repos/{owner}/{repo}/zipball/{ref}",
@ -1081,11 +1006,13 @@ const Endpoints = {
downloadZipballArchive: ["GET /repos/{owner}/{repo}/zipball/{ref}"], downloadZipballArchive: ["GET /repos/{owner}/{repo}/zipball/{ref}"],
enableAutomatedSecurityFixes: [ enableAutomatedSecurityFixes: [
"PUT /repos/{owner}/{repo}/automated-security-fixes", "PUT /repos/{owner}/{repo}/automated-security-fixes",
{ mediaType: { previews: ["london"] } },
], ],
enableLfsForRepo: ["PUT /repos/{owner}/{repo}/lfs"],
enableVulnerabilityAlerts: [ enableVulnerabilityAlerts: [
"PUT /repos/{owner}/{repo}/vulnerability-alerts", "PUT /repos/{owner}/{repo}/vulnerability-alerts",
{ mediaType: { previews: ["dorian"] } }, ],
generateReleaseNotes: [
"POST /repos/{owner}/{repo}/releases/generate-notes",
], ],
get: ["GET /repos/{owner}/{repo}"], get: ["GET /repos/{owner}/{repo}"],
getAccessRestrictions: [ getAccessRestrictions: [
@ -1105,6 +1032,7 @@ const Endpoints = {
getAppsWithAccessToProtectedBranch: [ getAppsWithAccessToProtectedBranch: [
"GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", "GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps",
], ],
getAutolink: ["GET /repos/{owner}/{repo}/autolinks/{autolink_id}"],
getBranch: ["GET /repos/{owner}/{repo}/branches/{branch}"], getBranch: ["GET /repos/{owner}/{repo}/branches/{branch}"],
getBranchProtection: [ getBranchProtection: [
"GET /repos/{owner}/{repo}/branches/{branch}/protection", "GET /repos/{owner}/{repo}/branches/{branch}/protection",
@ -1120,7 +1048,6 @@ const Endpoints = {
getCommitComment: ["GET /repos/{owner}/{repo}/comments/{comment_id}"], getCommitComment: ["GET /repos/{owner}/{repo}/comments/{comment_id}"],
getCommitSignatureProtection: [ getCommitSignatureProtection: [
"GET /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", "GET /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures",
{ mediaType: { previews: ["zzzax"] } },
], ],
getCommunityProfileMetrics: ["GET /repos/{owner}/{repo}/community/profile"], getCommunityProfileMetrics: ["GET /repos/{owner}/{repo}/community/profile"],
getContent: ["GET /repos/{owner}/{repo}/contents/{path}"], getContent: ["GET /repos/{owner}/{repo}/contents/{path}"],
@ -1164,10 +1091,13 @@ const Endpoints = {
getWebhookConfigForRepo: [ getWebhookConfigForRepo: [
"GET /repos/{owner}/{repo}/hooks/{hook_id}/config", "GET /repos/{owner}/{repo}/hooks/{hook_id}/config",
], ],
getWebhookDelivery: [
"GET /repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}",
],
listAutolinks: ["GET /repos/{owner}/{repo}/autolinks"],
listBranches: ["GET /repos/{owner}/{repo}/branches"], listBranches: ["GET /repos/{owner}/{repo}/branches"],
listBranchesForHeadCommit: [ listBranchesForHeadCommit: [
"GET /repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head", "GET /repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head",
{ mediaType: { previews: ["groot"] } },
], ],
listCollaborators: ["GET /repos/{owner}/{repo}/collaborators"], listCollaborators: ["GET /repos/{owner}/{repo}/collaborators"],
listCommentsForCommit: [ listCommentsForCommit: [
@ -1195,7 +1125,6 @@ const Endpoints = {
listPublic: ["GET /repositories"], listPublic: ["GET /repositories"],
listPullRequestsAssociatedWithCommit: [ listPullRequestsAssociatedWithCommit: [
"GET /repos/{owner}/{repo}/commits/{commit_sha}/pulls", "GET /repos/{owner}/{repo}/commits/{commit_sha}/pulls",
{ mediaType: { previews: ["groot"] } },
], ],
listReleaseAssets: [ listReleaseAssets: [
"GET /repos/{owner}/{repo}/releases/{release_id}/assets", "GET /repos/{owner}/{repo}/releases/{release_id}/assets",
@ -1203,9 +1132,16 @@ const Endpoints = {
listReleases: ["GET /repos/{owner}/{repo}/releases"], listReleases: ["GET /repos/{owner}/{repo}/releases"],
listTags: ["GET /repos/{owner}/{repo}/tags"], listTags: ["GET /repos/{owner}/{repo}/tags"],
listTeams: ["GET /repos/{owner}/{repo}/teams"], listTeams: ["GET /repos/{owner}/{repo}/teams"],
listWebhookDeliveries: [
"GET /repos/{owner}/{repo}/hooks/{hook_id}/deliveries",
],
listWebhooks: ["GET /repos/{owner}/{repo}/hooks"], listWebhooks: ["GET /repos/{owner}/{repo}/hooks"],
merge: ["POST /repos/{owner}/{repo}/merges"], merge: ["POST /repos/{owner}/{repo}/merges"],
mergeUpstream: ["POST /repos/{owner}/{repo}/merge-upstream"],
pingWebhook: ["POST /repos/{owner}/{repo}/hooks/{hook_id}/pings"], pingWebhook: ["POST /repos/{owner}/{repo}/hooks/{hook_id}/pings"],
redeliverWebhookDelivery: [
"POST /repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts",
],
removeAppAccessRestrictions: [ removeAppAccessRestrictions: [
"DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps",
{}, {},
@ -1298,7 +1234,7 @@ const Endpoints = {
}, },
search: { search: {
code: ["GET /search/code"], code: ["GET /search/code"],
commits: ["GET /search/commits", { mediaType: { previews: ["cloak"] } }], commits: ["GET /search/commits"],
issuesAndPullRequests: ["GET /search/issues"], issuesAndPullRequests: ["GET /search/issues"],
labels: ["GET /search/labels"], labels: ["GET /search/labels"],
repos: ["GET /search/repositories"], repos: ["GET /search/repositories"],
@ -1309,6 +1245,7 @@ const Endpoints = {
getAlert: [ getAlert: [
"GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}", "GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}",
], ],
listAlertsForOrg: ["GET /orgs/{org}/secret-scanning/alerts"],
listAlertsForRepo: ["GET /repos/{owner}/{repo}/secret-scanning/alerts"], listAlertsForRepo: ["GET /repos/{owner}/{repo}/secret-scanning/alerts"],
updateAlert: [ updateAlert: [
"PATCH /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}", "PATCH /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}",
@ -1320,14 +1257,12 @@ const Endpoints = {
], ],
addOrUpdateProjectPermissionsInOrg: [ addOrUpdateProjectPermissionsInOrg: [
"PUT /orgs/{org}/teams/{team_slug}/projects/{project_id}", "PUT /orgs/{org}/teams/{team_slug}/projects/{project_id}",
{ mediaType: { previews: ["inertia"] } },
], ],
addOrUpdateRepoPermissionsInOrg: [ addOrUpdateRepoPermissionsInOrg: [
"PUT /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", "PUT /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}",
], ],
checkPermissionsForProjectInOrg: [ checkPermissionsForProjectInOrg: [
"GET /orgs/{org}/teams/{team_slug}/projects/{project_id}", "GET /orgs/{org}/teams/{team_slug}/projects/{project_id}",
{ mediaType: { previews: ["inertia"] } },
], ],
checkPermissionsForRepoInOrg: [ checkPermissionsForRepoInOrg: [
"GET /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", "GET /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}",
@ -1365,10 +1300,7 @@ const Endpoints = {
listPendingInvitationsInOrg: [ listPendingInvitationsInOrg: [
"GET /orgs/{org}/teams/{team_slug}/invitations", "GET /orgs/{org}/teams/{team_slug}/invitations",
], ],
listProjectsInOrg: [ listProjectsInOrg: ["GET /orgs/{org}/teams/{team_slug}/projects"],
"GET /orgs/{org}/teams/{team_slug}/projects",
{ mediaType: { previews: ["inertia"] } },
],
listReposInOrg: ["GET /orgs/{org}/teams/{team_slug}/repos"], listReposInOrg: ["GET /orgs/{org}/teams/{team_slug}/repos"],
removeMembershipForUserInOrg: [ removeMembershipForUserInOrg: [
"DELETE /orgs/{org}/teams/{team_slug}/memberships/{username}", "DELETE /orgs/{org}/teams/{team_slug}/memberships/{username}",
@ -1388,42 +1320,119 @@ const Endpoints = {
updateInOrg: ["PATCH /orgs/{org}/teams/{team_slug}"], updateInOrg: ["PATCH /orgs/{org}/teams/{team_slug}"],
}, },
users: { users: {
addEmailForAuthenticated: ["POST /user/emails"], addEmailForAuthenticated: [
"POST /user/emails",
{},
{ renamed: ["users", "addEmailForAuthenticatedUser"] },
],
addEmailForAuthenticatedUser: ["POST /user/emails"],
block: ["PUT /user/blocks/{username}"], block: ["PUT /user/blocks/{username}"],
checkBlocked: ["GET /user/blocks/{username}"], checkBlocked: ["GET /user/blocks/{username}"],
checkFollowingForUser: ["GET /users/{username}/following/{target_user}"], checkFollowingForUser: ["GET /users/{username}/following/{target_user}"],
checkPersonIsFollowedByAuthenticated: ["GET /user/following/{username}"], checkPersonIsFollowedByAuthenticated: ["GET /user/following/{username}"],
createGpgKeyForAuthenticated: ["POST /user/gpg_keys"], createGpgKeyForAuthenticated: [
createPublicSshKeyForAuthenticated: ["POST /user/keys"], "POST /user/gpg_keys",
deleteEmailForAuthenticated: ["DELETE /user/emails"], {},
deleteGpgKeyForAuthenticated: ["DELETE /user/gpg_keys/{gpg_key_id}"], { renamed: ["users", "createGpgKeyForAuthenticatedUser"] },
deletePublicSshKeyForAuthenticated: ["DELETE /user/keys/{key_id}"], ],
createGpgKeyForAuthenticatedUser: ["POST /user/gpg_keys"],
createPublicSshKeyForAuthenticated: [
"POST /user/keys",
{},
{ renamed: ["users", "createPublicSshKeyForAuthenticatedUser"] },
],
createPublicSshKeyForAuthenticatedUser: ["POST /user/keys"],
deleteEmailForAuthenticated: [
"DELETE /user/emails",
{},
{ renamed: ["users", "deleteEmailForAuthenticatedUser"] },
],
deleteEmailForAuthenticatedUser: ["DELETE /user/emails"],
deleteGpgKeyForAuthenticated: [
"DELETE /user/gpg_keys/{gpg_key_id}",
{},
{ renamed: ["users", "deleteGpgKeyForAuthenticatedUser"] },
],
deleteGpgKeyForAuthenticatedUser: ["DELETE /user/gpg_keys/{gpg_key_id}"],
deletePublicSshKeyForAuthenticated: [
"DELETE /user/keys/{key_id}",
{},
{ renamed: ["users", "deletePublicSshKeyForAuthenticatedUser"] },
],
deletePublicSshKeyForAuthenticatedUser: ["DELETE /user/keys/{key_id}"],
follow: ["PUT /user/following/{username}"], follow: ["PUT /user/following/{username}"],
getAuthenticated: ["GET /user"], getAuthenticated: ["GET /user"],
getByUsername: ["GET /users/{username}"], getByUsername: ["GET /users/{username}"],
getContextForUser: ["GET /users/{username}/hovercard"], getContextForUser: ["GET /users/{username}/hovercard"],
getGpgKeyForAuthenticated: ["GET /user/gpg_keys/{gpg_key_id}"], getGpgKeyForAuthenticated: [
getPublicSshKeyForAuthenticated: ["GET /user/keys/{key_id}"], "GET /user/gpg_keys/{gpg_key_id}",
{},
{ renamed: ["users", "getGpgKeyForAuthenticatedUser"] },
],
getGpgKeyForAuthenticatedUser: ["GET /user/gpg_keys/{gpg_key_id}"],
getPublicSshKeyForAuthenticated: [
"GET /user/keys/{key_id}",
{},
{ renamed: ["users", "getPublicSshKeyForAuthenticatedUser"] },
],
getPublicSshKeyForAuthenticatedUser: ["GET /user/keys/{key_id}"],
list: ["GET /users"], list: ["GET /users"],
listBlockedByAuthenticated: ["GET /user/blocks"], listBlockedByAuthenticated: [
listEmailsForAuthenticated: ["GET /user/emails"], "GET /user/blocks",
listFollowedByAuthenticated: ["GET /user/following"], {},
{ renamed: ["users", "listBlockedByAuthenticatedUser"] },
],
listBlockedByAuthenticatedUser: ["GET /user/blocks"],
listEmailsForAuthenticated: [
"GET /user/emails",
{},
{ renamed: ["users", "listEmailsForAuthenticatedUser"] },
],
listEmailsForAuthenticatedUser: ["GET /user/emails"],
listFollowedByAuthenticated: [
"GET /user/following",
{},
{ renamed: ["users", "listFollowedByAuthenticatedUser"] },
],
listFollowedByAuthenticatedUser: ["GET /user/following"],
listFollowersForAuthenticatedUser: ["GET /user/followers"], listFollowersForAuthenticatedUser: ["GET /user/followers"],
listFollowersForUser: ["GET /users/{username}/followers"], listFollowersForUser: ["GET /users/{username}/followers"],
listFollowingForUser: ["GET /users/{username}/following"], listFollowingForUser: ["GET /users/{username}/following"],
listGpgKeysForAuthenticated: ["GET /user/gpg_keys"], listGpgKeysForAuthenticated: [
"GET /user/gpg_keys",
{},
{ renamed: ["users", "listGpgKeysForAuthenticatedUser"] },
],
listGpgKeysForAuthenticatedUser: ["GET /user/gpg_keys"],
listGpgKeysForUser: ["GET /users/{username}/gpg_keys"], listGpgKeysForUser: ["GET /users/{username}/gpg_keys"],
listPublicEmailsForAuthenticated: ["GET /user/public_emails"], listPublicEmailsForAuthenticated: [
"GET /user/public_emails",
{},
{ renamed: ["users", "listPublicEmailsForAuthenticatedUser"] },
],
listPublicEmailsForAuthenticatedUser: ["GET /user/public_emails"],
listPublicKeysForUser: ["GET /users/{username}/keys"], listPublicKeysForUser: ["GET /users/{username}/keys"],
listPublicSshKeysForAuthenticated: ["GET /user/keys"], listPublicSshKeysForAuthenticated: [
setPrimaryEmailVisibilityForAuthenticated: ["PATCH /user/email/visibility"], "GET /user/keys",
{},
{ renamed: ["users", "listPublicSshKeysForAuthenticatedUser"] },
],
listPublicSshKeysForAuthenticatedUser: ["GET /user/keys"],
setPrimaryEmailVisibilityForAuthenticated: [
"PATCH /user/email/visibility",
{},
{ renamed: ["users", "setPrimaryEmailVisibilityForAuthenticatedUser"] },
],
setPrimaryEmailVisibilityForAuthenticatedUser: [
"PATCH /user/email/visibility",
],
unblock: ["DELETE /user/blocks/{username}"], unblock: ["DELETE /user/blocks/{username}"],
unfollow: ["DELETE /user/following/{username}"], unfollow: ["DELETE /user/following/{username}"],
updateAuthenticated: ["PATCH /user"], updateAuthenticated: ["PATCH /user"],
}, },
}; };
const VERSION = "5.3.0"; const VERSION = "5.13.0";
function endpointsToMethods(octokit, endpointsMap) { function endpointsToMethods(octokit, endpointsMap) {
const newMethods = {}; const newMethods = {};

File diff suppressed because one or more lines are too long

View File

@ -0,0 +1,7 @@
Copyright 2020 Gregor Martynus
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

View File

@ -0,0 +1,17 @@
# @octokit/openapi-types
> Generated TypeScript definitions based on GitHub's OpenAPI spec
This package is continously updated based on [GitHub's OpenAPI specification](https://github.com/github/rest-api-description/)
## Usage
```ts
import { components } from "@octokit/openapi-types";
type Repository = components["schemas"]["full-repository"];
```
## License
[MIT](LICENSE)

View File

@ -0,0 +1,20 @@
{
"name": "@octokit/openapi-types",
"description": "Generated TypeScript definitions based on GitHub's OpenAPI spec for api.github.com",
"repository": {
"type": "git",
"url": "https://github.com/octokit/openapi-types.ts.git",
"directory": "packages/openapi-types"
},
"publishConfig": {
"access": "public"
},
"version": "11.2.0",
"main": "",
"types": "types.d.ts",
"author": "Gregor Martynus (https://twitter.com/gr2m)",
"license": "MIT",
"octokit": {
"openapi-version": "5.9.0"
}
}

File diff suppressed because it is too large Load Diff

Some files were not shown because too many files have changed in this diff Show More